#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2011       Robert Cheramy
#
# 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#

# $Id: _IsRelatedWith.py 18338 2011-10-16 20:21:22Z paul-franklin $

#-------------------------------------------------------------------------
#
# Standard Python modules
#
#-------------------------------------------------------------------------
from gen.ggettext import gettext as _

#-------------------------------------------------------------------------
#
# GRAMPS modules
#
#-------------------------------------------------------------------------
from Filters.Rules._Rule import Rule

#-------------------------------------------------------------------------
#
# RelatedWith
#
#-------------------------------------------------------------------------
class IsRelatedWith(Rule):
    """Rule that checks if a person is related to a specified person"""

    labels      = [ _('ID:') ]
    name        = _('People related to <Person>')
    category    = _("Relationship filters")
    description = _("Matches people related to a specified person")

    def prepare(self, db):
        """prepare so the rule can be executed efficiently
           we build the list of people related to <person> here,
           so that apply is only a check into this list
        """
        self.db = db

        self.relatives = []
        self.add_relative(db.get_person_from_gramps_id(self.list[0]))

    def reset(self):
        self.relatives = []
        
    def apply(self, db, person):
        return person.handle in self.relatives


    def add_relative(self, person):
        """Recursive function that scans relatives and add them to self.relatives"""
        if not(person) or person.handle in self.relatives:
            return

        # Add the relative to the list
        self.relatives.append(person.handle)
        
        for family_handle in person.get_parent_family_handle_list():
            family = self.db.get_family_from_handle(family_handle)
            if family:
        # Check Parents
                for parent_handle in (family.get_father_handle(), family.get_mother_handle()):
                    if parent_handle:
                        self.add_relative(self.db.get_person_from_handle(parent_handle))
        # Check Sibilings
                for child_ref in family.get_child_ref_list():
                    self.add_relative(self.db.get_person_from_handle(child_ref.ref))

        for family_handle in person.get_family_handle_list():
            family = self.db.get_family_from_handle(family_handle)
            if family:
        # Check Spouse
                for parent_handle in (family.get_father_handle(), family.get_mother_handle()):
                    if parent_handle:
                        self.add_relative(self.db.get_person_from_handle(parent_handle))
        # Check Children
                for child_ref in family.get_child_ref_list():
                    self.add_relative(self.db.get_person_from_handle(child_ref.ref))

        return
