#
# 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, see <https://www.gnu.org/licenses/>.
#

# -------------------------------------------------------------------------
#
# Standard Python modules
#
# -------------------------------------------------------------------------
from __future__ import annotations
from ....const import GRAMPS_LOCALE as glocale

_ = glocale.translation.gettext

# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from .. import Rule

# -------------------------------------------------------------------------
#
# Typing modules
#
# -------------------------------------------------------------------------
from typing import List, Set
from ....lib import Person
from ....db import Database


# -------------------------------------------------------------------------
#
# 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: Database, user):
        """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.selected_handles: Set[str] = set()
        self.add_relative(db.get_person_from_gramps_id(self.list[0]))

    def reset(self):
        self.selected_handles.clear()

    def apply_to_one(self, db: Database, person: Person) -> bool:
        return person.handle in self.selected_handles

    def add_relative(self, start: Person | None):
        """Non-recursive function that scans relatives and add them to self.selected_handles"""
        if not start:
            return

        queue: List[Person] = [start]

        while queue:
            person = queue.pop()
            # Add the relative to the list
            if person is None or (person.handle in self.selected_handles):
                continue
            self.selected_handles.add(person.handle)

            for family_handle in person.parent_family_list:
                family = self.db.get_family_from_handle(family_handle)
                if family:
                    # Check Parents
                    for parent_handle in (
                        family.father_handle,
                        family.mother_handle,
                    ):
                        if parent_handle:
                            queue.append(self.db.get_person_from_handle(parent_handle))
                    # Check Sibilings
                    for child_ref in family.child_ref_list:
                        queue.append(self.db.get_person_from_handle(child_ref.ref))

            for family_handle in person.family_list:
                family = self.db.get_family_from_handle(family_handle)
                if family:
                    # Check Spouse
                    for parent_handle in (
                        family.father_handle,
                        family.mother_handle,
                    ):
                        if parent_handle:
                            queue.append(self.db.get_person_from_handle(parent_handle))
                    # Check Children
                    for child_ref in family.child_ref_list:
                        queue.append(self.db.get_person_from_handle(child_ref.ref))

        return
