matrilinealprogenitrix.py

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2020    Matthias Kemmer
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
"""Matches the earliest recorded matrilineal ancestor mother."""

# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from gramps.gen.filters.rules.person._hasidof import HasGrampsId
from gramps.gen.const import GRAMPS_LOCALE as glocale
try:
    _trans = glocale.get_addon_translator(__file__)
except ValueError:
    _trans = glocale.translation
_ = _trans.gettext


# -------------------------------------------------------------------------
#
# MatrilinealProgenitorix Filter Rule
#
# -------------------------------------------------------------------------
class MatrilinealProgenitrix(HasGrampsId):
    """Matches the earliest recorded matrilineal ancestor mother."""

    labels = [_('ID:')]
    name = _('Matrilineal progenitrix of <person>')
    category = _("Ancestral filters")
    description = _("Matches the earliest recorded matrilineal "
                    "ancestor mother.")

    def prepare(self, db, user):
        """Prepare a reference list for the filter."""
        self.db = db
        self.persons = set()
        self.run_search = True

        person = self.db.get_person_from_gramps_id(self.list[0])
        start_mother = self.get_mother(person)
        if start_mother:
            self.get_root_mother(start_mother)

    def get_mother(self, person):
        """
        Get the mother of a person.

        This function returns the mother of a person if the child relationship
        type to the mother is brith and only one mother exists.
        """
        family_list = person.get_parent_family_handle_list()
        mother_set = set()

        if not family_list:
            return False

        for family_handle in family_list:
            family = self.db.get_family_from_handle(family_handle)
            for child_ref in family.get_child_ref_list():
                if (person.get_handle() == child_ref.ref and
                        child_ref.get_mother_relation() == _("Birth")):
                    mother_handle = family.get_mother_handle()
                    mother_set.add(mother_handle)

        if len(mother_set) == 1 and None not in mother_set:
            mother = self.db.get_person_from_handle(mother_set.pop())
            return mother
        return False

    def get_root_mother(self, person):
        """Search recursively for the root mother of a person."""
        while self.run_search:
            mother = self.get_mother(person)
            if mother:
                self.get_root_mother(mother)
            else:
                self.run_search = False
                self.persons.add(person.get_handle())

    def apply(self, db, obj):
        """Check if the filter applies to a person."""
        return obj.get_handle() in self.persons