#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2007  Donald N. Allingham
# Copyright (C) 2008       Brian G. Matherly
# Copyright (C) 2010       Jakim Friant
# Copyright (C) 2011       Paul Franklin
#
# 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.
#

"""
A plugin to verify the data against user-adjusted tests.
This is the research tool, not the low-level data ingerity check.

Note that this tool has an old heritage (20-Oct-2002 at least) and
so there are vestages of earlier ways of doing things which have not
been converted to a more-modern way.  For instance the way the tool
options are defined (and read in) is not done the way it would be now.
"""

# pylint: disable=not-callable
# pylint: disable=no-self-use
# pylint: disable=undefined-variable

#------------------------------------------------------------------------
#
# standard python modules
#
#------------------------------------------------------------------------

import os
import pickle
from hashlib import md5

#------------------------------------------------------------------------
#
# GNOME/GTK modules
#
#------------------------------------------------------------------------
from gi.repository import Gdk
from gi.repository import Gtk
from gi.repository import GObject

#------------------------------------------------------------------------
#
# Gramps modules
#
#------------------------------------------------------------------------
from gramps.gen.const import GRAMPS_LOCALE as glocale
_ = glocale.translation.sgettext
from gramps.gen.errors import WindowActiveError
from gramps.gen.const import URL_MANUAL_PAGE, VERSION_DIR
from gramps.gen.lib import (ChildRefType, EventRoleType, EventType,
                            FamilyRelType, NameType, Person)
from gramps.gen.lib.date import Today
from gramps.gui.editors import EditPerson, EditFamily
from gramps.gen.utils.db import family_name
from gramps.gui.display import display_help
from gramps.gui.managedwindow import ManagedWindow
from gramps.gen.updatecallback import UpdateCallback
from gramps.gui.plug import tool
from gramps.gui.glade import Glade

#-------------------------------------------------------------------------
#
# Constants
#
#-------------------------------------------------------------------------
WIKI_HELP_PAGE = '%s_-_Tools' % URL_MANUAL_PAGE
WIKI_HELP_SEC = _('manual|Verify_the_Data')

#-------------------------------------------------------------------------
#
# temp storage and related functions
#
#-------------------------------------------------------------------------
_person_cache = {}
_family_cache = {}
_event_cache = {}
_today = Today().get_sort_value()

def find_event(db, handle):
    """ find an event, given a handle """
    if handle in _event_cache:
        obj = _event_cache[handle]
    else:
        obj = db.get_event_from_handle(handle)
        _event_cache[handle] = obj
    return obj

def find_person(db, handle):
    """ find a person, given a handle """
    if handle in _person_cache:
        obj = _person_cache[handle]
    else:
        obj = db.get_person_from_handle(handle)
        _person_cache[handle] = obj
    return obj

def find_family(db, handle):
    """ find a family, given a handle """
    if handle in _family_cache:
        obj = _family_cache[handle]
    else:
        obj = db.get_family_from_handle(handle)
        _family_cache[handle] = obj
    return obj

def clear_cache():
    """ clear the cache """
    _person_cache.clear()
    _family_cache.clear()
    _event_cache.clear()

#-------------------------------------------------------------------------
#
# helper functions
#
#-------------------------------------------------------------------------
def get_date_from_event_handle(db, event_handle, estimate=False):
    """ get a date from an event handle """
    if not event_handle:
        return 0
    event = find_event(db, event_handle)
    if event:
        date_obj = event.get_date_object()
        if (not estimate
                and (date_obj.get_day() == 0 or date_obj.get_month() == 0)):
            return 0
        return date_obj.get_sort_value()
    else:
        return 0

def get_date_from_event_type(db, person, event_type, estimate=False):
    """ get a date from a person's specific event type """
    if not person:
        return 0
    for event_ref in person.get_event_ref_list():
        event = find_event(db, event_ref.ref)
        if event:
            if (event_ref.get_role() != EventRoleType.PRIMARY
                    and event.get_type() == EventType.BURIAL):
                continue
            if event.get_type() == event_type:
                date_obj = event.get_date_object()
                if (not estimate
                        and (date_obj.get_day() == 0
                             or date_obj.get_month() == 0)):
                    return 0
                return date_obj.get_sort_value()
    return 0

def get_bapt_date(db, person, estimate=False):
    """ get a person's baptism date """
    return get_date_from_event_type(db, person,
                                    EventType.BAPTISM, estimate)

def get_bury_date(db, person, estimate=False):
    """ get a person's burial date """
    # check role on burial event
    for event_ref in person.get_event_ref_list():
        event = find_event(db, event_ref.ref)
        if (event
                and event.get_type() == EventType.BURIAL
                and event_ref.get_role() == EventRoleType.PRIMARY):
            return get_date_from_event_type(db, person,
                                            EventType.BURIAL, estimate)

def get_birth_date(db, person, estimate=False):
    """ get a person's birth date (or baptism date if 'estimated') """
    if not person:
        return 0
    birth_ref = person.get_birth_ref()
    if not birth_ref:
        ret = 0
    else:
        ret = get_date_from_event_handle(db, birth_ref.ref, estimate)
    if estimate and (ret == 0):
        ret = get_bapt_date(db, person, estimate)
        ret = 0 if ret is None else ret
    return ret

def get_death(db, person):
    """
    boolean whether there is a death event or not
    (if a user claims a person is dead, we will believe it even with no date)
    """
    if not person:
        return False
    death_ref = person.get_death_ref()
    if death_ref:
        return True
    else:
        return False

def get_death_date(db, person, estimate=False):
    """ get a person's death date (or burial date if 'estimated') """
    if not person:
        return 0
    death_ref = person.get_death_ref()
    if not death_ref:
        ret = 0
    else:
        ret = get_date_from_event_handle(db, death_ref.ref, estimate)
    if estimate and (ret == 0):
        ret = get_bury_date(db, person, estimate)
        ret = 0 if ret is None else ret
    return ret

def get_age_at_death(db, person, estimate):
    """ get a person's age at death """
    birth_date = get_birth_date(db, person, estimate)
    death_date = get_death_date(db, person, estimate)
    if (birth_date > 0) and (death_date > 0):
        return death_date - birth_date
    return 0

def get_father(db, family):
    """ get a family's father """
    if not family:
        return None
    father_handle = family.get_father_handle()
    if father_handle:
        return find_person(db, father_handle)
    return None

def get_mother(db, family):
    """ get a family's mother """
    if not family:
        return None
    mother_handle = family.get_mother_handle()
    if mother_handle:
        return find_person(db, mother_handle)
    return None

def get_child_birth_dates(db, family, estimate):
    """ get a family's children's birth dates """
    dates = []
    for child_ref in family.get_child_ref_list():
        child = find_person(db, child_ref.ref)
        child_birth_date = get_birth_date(db, child, estimate)
        if child_birth_date > 0:
            dates.append(child_birth_date)
    return dates

def get_n_children(db, person):
    """ get the number of a family's children """
    number = 0
    for family_handle in person.get_family_handle_list():
        family = find_family(db, family_handle)
        if family:
            number += len(family.get_child_ref_list())
    return number

def get_marriage_date(db, family):
    """ get a family's marriage date """
    if not family:
        return 0
    for event_ref in family.get_event_ref_list():
        event = find_event(db, event_ref.ref)
        if (event.get_type() == EventType.MARRIAGE
                and (event_ref.get_role() == EventRoleType.FAMILY
                     or event_ref.get_role() == EventRoleType.PRIMARY)):
            date_obj = event.get_date_object()
            return date_obj.get_sort_value()
    return 0

#-------------------------------------------------------------------------
#
# Actual tool
#
#-------------------------------------------------------------------------
class Verify(tool.Tool, ManagedWindow, UpdateCallback):
    """
    A plugin to verify the data against user-adjusted tests.
    This is the research tool, not the low-level data ingerity check.
    """

    def __init__(self, dbstate, user, options_class, name, callback=None):
        """ initialize things """
        uistate = user.uistate
        self.label = _('Data Verify tool')
        self.v_r = None
        tool.Tool.__init__(self, dbstate, options_class, name)
        ManagedWindow.__init__(self, uistate, [], self.__class__)
        if uistate:
            UpdateCallback.__init__(self, self.uistate.pulse_progressbar)

        self.dbstate = dbstate
        if uistate:
            self.init_gui()
        else:
            self.add_results = self.add_results_cli
            self.run_the_tool(cli=True)

    def add_results_cli(self, results):
        """ print data for the user, no GUI """
        (msg, gramps_id, name, the_type, rule_id, severity, handle) = results
        severity_str = 'S'
        if severity == Rule.WARNING:
            severity_str = 'W'
        elif severity == Rule.ERROR:
            severity_str = 'E'
        # translators: needed for French+Arabic, ignore otherwise
        print(_("%(severity)s: %(msg)s, %(type)s: %(gid)s, %(name)s"
               ) % {'severity' : severity_str, 'msg' : msg, 'type' : the_type,
                    'gid' : gramps_id, 'name' : name})

    def init_gui(self):
        """ Draw dialog and make it handle everything """
        self.v_r = None
        self.top = Glade()
        self.top.connect_signals({
            "destroy_passed_object" : self.close,
            "on_help_clicked"       : self.on_help_clicked,
            "on_verify_ok_clicked"  : self.on_apply_clicked,
            "on_delete_event"       : self.close,
        })

        window = self.top.toplevel
        self.set_window(window, self.top.get_object('title'), self.label)
        self.setup_configs('interface.verify', 650, 400)

        o_dict = self.options.handler.options_dict
        for option in o_dict:
            if option in ['estimate_age', 'invdate']:
                self.top.get_object(option).set_active(o_dict[option])
            else:
                self.top.get_object(option).set_value(o_dict[option])
        self.show()

    def build_menu_names(self, obj):
        """ build the menu names """
        return (_("Tool settings"), self.label)

    def on_help_clicked(self, obj):
        """ Display the relevant portion of Gramps manual """
        display_help(webpage=WIKI_HELP_PAGE, section=WIKI_HELP_SEC)

    def on_apply_clicked(self, obj):
        """ event handler for user clicking the OK button: start things """
        run_button = self.top.get_object('button4')
        close_button = self.top.get_object('button5')
        run_button.set_sensitive(False)
        close_button.set_sensitive(False)
        o_dict = self.options.handler.options_dict
        for option in o_dict:
            if option in ['estimate_age', 'invdate']:
                o_dict[option] = self.top.get_object(option).get_active()
            else:
                o_dict[option] = self.top.get_object(option).get_value_as_int()

        try:
            self.v_r = VerifyResults(self.dbstate, self.uistate, self.track,
                                     self.top, self.close)
            self.add_results = self.v_r.add_results
            self.v_r.load_ignored(self.db.full_name)
        except WindowActiveError:
            pass
        except AttributeError: # VerifyResults.load_ignored was not run
            self.v_r.ignores = {}

        self.uistate.set_busy_cursor(True)
        self.uistate.progress.show()
        busy_cursor = Gdk.Cursor.new_for_display(Gdk.Display.get_default(),
                                                 Gdk.CursorType.WATCH)
        self.window.get_window().set_cursor(busy_cursor)
        try:
            self.v_r.window.get_window().set_cursor(busy_cursor)
        except AttributeError:
            pass

        self.run_the_tool(cli=False)

        self.uistate.progress.hide()
        self.uistate.set_busy_cursor(False)
        try:
            self.window.get_window().set_cursor(None)
            self.v_r.window.get_window().set_cursor(None)
        except AttributeError:
            pass
        run_button.set_sensitive(True)
        close_button.set_sensitive(True)
        self.reset()

        # Save options
        self.options.handler.save_options()

    def run_the_tool(self, cli=False):
        """ run the tool """

        person_handles = self.db.iter_person_handles()

        for option, value in self.options.handler.options_dict.items():
            exec('%s = %s' % (option, value), globals())
            # TODO my pylint doesn't seem to understand these variables really
            # are defined here, so I have disabled the undefined-variable error

        if self.v_r:
            self.v_r.real_model.clear()

        self.set_total(self.db.get_number_of_people() +
                       self.db.get_number_of_families())

        for person_handle in person_handles:
            person = find_person(self.db, person_handle)

            rule_list = [
                BirthAfterBapt(self.db, person),
                DeathBeforeBapt(self.db, person),
                BirthAfterBury(self.db, person),
                DeathAfterBury(self.db, person),
                BirthAfterDeath(self.db, person),
                BaptAfterBury(self.db, person),
                OldAge(self.db, person, oldage, estimate_age),
                OldAgeButNoDeath(self.db, person, oldage, estimate_age),
                UnknownGender(self.db, person),
                MultipleParents(self.db, person),
                MarriedOften(self.db, person, wedder),
                OldUnmarried(self.db, person, oldunm, estimate_age),
                TooManyChildren(self.db, person, mxchilddad, mxchildmom),
                Disconnected(self.db, person),
                InvalidBirthDate(self.db, person, invdate),
                InvalidDeathDate(self.db, person, invdate),
                BirthEqualsDeath(self.db, person),
                BirthEqualsMarriage(self.db, person),
                DeathEqualsMarriage(self.db, person),
                ]

            for rule in rule_list:
                if rule.broken():
                    self.add_results(rule.report_itself())

            clear_cache()
            if not cli:
                self.update()

        # Family-based rules
        for family_handle in self.db.iter_family_handles():
            family = find_family(self.db, family_handle)

            rule_list = [
                SameSexFamily(self.db, family),
                FemaleHusband(self.db, family),
                MaleWife(self.db, family),
                SameSurnameFamily(self.db, family),
                LargeAgeGapFamily(self.db, family, hwdif, estimate_age),
                MarriageBeforeBirth(self.db, family, estimate_age),
                MarriageAfterDeath(self.db, family, estimate_age),
                EarlyMarriage(self.db, family, yngmar, estimate_age),
                LateMarriage(self.db, family, oldmar, estimate_age),
                OldParent(self.db, family, oldmom, olddad, estimate_age),
                YoungParent(self.db, family, yngmom, yngdad, estimate_age),
                UnbornParent(self.db, family, estimate_age),
                DeadParent(self.db, family, estimate_age),
                LargeChildrenSpan(self.db, family, cbspan, estimate_age),
                LargeChildrenAgeDiff(self.db, family, cspace, estimate_age),
                MarriedRelation(self.db, family),
                ]

            for rule in rule_list:
                if rule.broken():
                    self.add_results(rule.report_itself())

            clear_cache()
            if not cli:
                self.update()

#-------------------------------------------------------------------------
#
# Display the results
#
#-------------------------------------------------------------------------
class VerifyResults(ManagedWindow):
    """ GUI class to show the results in another dialog """
    IGNORE_COL = 0
    WARNING_COL = 1
    OBJ_ID_COL = 2
    OBJ_NAME_COL = 3
    OBJ_TYPE_COL = 4
    RULE_ID_COL = 5
    OBJ_HANDLE_COL = 6
    FG_COLOR_COL = 7
    TRUE_COL = 8
    SHOW_COL = 9

    def __init__(self, dbstate, uistate, track, glade, closeall):
        """ initialize things """
        self.title = _('Data Verification Results')

        ManagedWindow.__init__(self, uistate, track, self.__class__)

        self.dbstate = dbstate
        self.closeall = closeall
        self._set_filename()
        self.top = glade
        window = self.top.get_object("verify_result")
        self.set_window(window, self.top.get_object('title2'), self.title)
        self.setup_configs('interface.verifyresults', 500, 300)
        window.connect("close", self.close)
        close_btn = self.top.get_object("closebutton1")
        close_btn.connect("clicked", self.close)

        self.warn_tree = self.top.get_object('warn_tree')
        self.warn_tree.connect('button_press_event', self.double_click)

        self.selection = self.warn_tree.get_selection()

        self.hide_button = self.top.get_object('hide_button')
        self.hide_button.connect('toggled', self.hide_toggled)

        self.mark_button = self.top.get_object('mark_all')
        self.mark_button.connect('clicked', self.mark_clicked)

        self.unmark_button = self.top.get_object('unmark_all')
        self.unmark_button.connect('clicked', self.unmark_clicked)

        self.invert_button = self.top.get_object('invert_all')
        self.invert_button.connect('clicked', self.invert_clicked)

        self.real_model = Gtk.ListStore(GObject.TYPE_BOOLEAN,
                                        GObject.TYPE_STRING,
                                        GObject.TYPE_STRING,
                                        GObject.TYPE_STRING,
                                        GObject.TYPE_STRING, object,
                                        GObject.TYPE_STRING,
                                        GObject.TYPE_STRING,
                                        GObject.TYPE_BOOLEAN,
                                        GObject.TYPE_BOOLEAN)
        self.filt_model = self.real_model.filter_new()
        self.filt_model.set_visible_column(VerifyResults.TRUE_COL)
        self.sort_model = self.filt_model.sort_new_with_model()
        self.warn_tree.set_model(self.sort_model)

        self.renderer = Gtk.CellRendererText()
        self.img_renderer = Gtk.CellRendererPixbuf()
        self.bool_renderer = Gtk.CellRendererToggle()
        self.bool_renderer.connect('toggled', self.selection_toggled)

        # Add ignore column
        ignore_column = Gtk.TreeViewColumn(_('Mark'), self.bool_renderer,
                                           active=VerifyResults.IGNORE_COL)
        ignore_column.set_sort_column_id(VerifyResults.IGNORE_COL)
        self.warn_tree.append_column(ignore_column)

        # Add image column
        img_column = Gtk.TreeViewColumn(None, self.img_renderer)
        img_column.set_cell_data_func(self.img_renderer, self.get_image)
        self.warn_tree.append_column(img_column)

        # Add column with the warning text
        warn_column = Gtk.TreeViewColumn(_('Warning'), self.renderer,
                                         text=VerifyResults.WARNING_COL,
                                         foreground=VerifyResults.FG_COLOR_COL)
        warn_column.set_sort_column_id(VerifyResults.WARNING_COL)
        self.warn_tree.append_column(warn_column)

        # Add column with object gramps_id
        id_column = Gtk.TreeViewColumn(_('ID'), self.renderer,
                                       text=VerifyResults.OBJ_ID_COL,
                                       foreground=VerifyResults.FG_COLOR_COL)
        id_column.set_sort_column_id(VerifyResults.OBJ_ID_COL)
        self.warn_tree.append_column(id_column)

        # Add column with object name
        name_column = Gtk.TreeViewColumn(_('Name'), self.renderer,
                                         text=VerifyResults.OBJ_NAME_COL,
                                         foreground=VerifyResults.FG_COLOR_COL)
        name_column.set_sort_column_id(VerifyResults.OBJ_NAME_COL)
        self.warn_tree.append_column(name_column)

        self.show()
        self.window_shown = False

    def _set_filename(self):
        """ set the file where people who will be ignored will be kept """
        db_filename = self.dbstate.db.get_save_path()
        if isinstance(db_filename, str):
            db_filename = db_filename.encode('utf-8')
        md5sum = md5(db_filename)
        self.ignores_filename = os.path.join(
            VERSION_DIR, md5sum.hexdigest() + os.path.extsep + 'vfm')

    def load_ignored(self, db_filename):
        """ get ready to load the file with the previously-ignored people """
        ## a new Gramps major version means recreating the .vfm file.
        ## User can copy over old one, with name of new one, but no guarantee
        ## that will work.
        if not self._load_ignored(self.ignores_filename):
            self.ignores = {}

    def _load_ignored(self, filename):
        """ load the file with the people who were previously ignored """
        try:
            try:
                file = open(filename, 'rb')
            except IOError:
                return False
            self.ignores = pickle.load(file)
            file.close()
            return True
        except (IOError, EOFError):
            file.close()
            return False

    def save_ignored(self, new_ignores):
        """ get ready to save the file with the ignored people """
        self.ignores = new_ignores
        self._save_ignored(self.ignores_filename)

    def _save_ignored(self, filename):
        """ save the file with the people the user wants to ignore """
        try:
            with open(filename, 'wb') as file:
                pickle.dump(self.ignores, file, 1)
            return True
        except IOError:
            return False

    def get_marking(self, handle, rule_id):
        if handle in self.ignores:
            return rule_id in self.ignores[handle]
        else:
            return False

    def get_new_marking(self):
        new_ignores = {}
        for row_num in range(len(self.real_model)):
            path = (row_num,)
            row = self.real_model[path]
            ignore = row[VerifyResults.IGNORE_COL]
            if ignore:
                handle = row[VerifyResults.OBJ_HANDLE_COL]
                rule_id = row[VerifyResults.RULE_ID_COL]
                if handle not in new_ignores:
                    new_ignores[handle] = set()
                new_ignores[handle].add(rule_id)
        return new_ignores

    def close(self, *obj):
        """ close the dialog and write out the file """
        new_ignores = self.get_new_marking()
        self.save_ignored(new_ignores)

        ManagedWindow.close(self, *obj)
        self.closeall()

    def hide_toggled(self, button):
        if button.get_active():
            button.set_label(_("_Show all"))
            self.filt_model = self.real_model.filter_new()
            self.filt_model.set_visible_column(VerifyResults.SHOW_COL)
            self.sort_model = self.filt_model.sort_new_with_model()
            self.warn_tree.set_model(self.sort_model)
        else:
            self.filt_model = self.real_model.filter_new()
            self.filt_model.set_visible_column(VerifyResults.TRUE_COL)
            self.sort_model = self.filt_model.sort_new_with_model()
            self.warn_tree.set_model(self.sort_model)
            button.set_label(_("_Hide marked"))

    def selection_toggled(self, cell, path_string):
        sort_path = tuple(map(int, path_string.split(':')))
        filt_path = self.sort_model.convert_path_to_child_path(
            Gtk.TreePath(sort_path))
        real_path = self.filt_model.convert_path_to_child_path(filt_path)
        row = self.real_model[real_path]
        row[VerifyResults.IGNORE_COL] = not row[VerifyResults.IGNORE_COL]
        row[VerifyResults.SHOW_COL] = not row[VerifyResults.IGNORE_COL]
        self.real_model.row_changed(real_path, row.iter)

    def mark_clicked(self, mark_button):
        for row_num in range(len(self.real_model)):
            path = (row_num,)
            row = self.real_model[path]
            row[VerifyResults.IGNORE_COL] = True
            row[VerifyResults.SHOW_COL] = False
        self.filt_model.refilter()

    def unmark_clicked(self, unmark_button):
        for row_num in range(len(self.real_model)):
            path = (row_num,)
            row = self.real_model[path]
            row[VerifyResults.IGNORE_COL] = False
            row[VerifyResults.SHOW_COL] = True
        self.filt_model.refilter()

    def invert_clicked(self, invert_button):
        for row_num in range(len(self.real_model)):
            path = (row_num,)
            row = self.real_model[path]
            row[VerifyResults.IGNORE_COL] = not row[VerifyResults.IGNORE_COL]
            row[VerifyResults.SHOW_COL] = not row[VerifyResults.SHOW_COL]
        self.filt_model.refilter()

    def double_click(self, obj, event):
        """ the user wants to edit the selected person or family """
        if (event.type == Gdk.EventType.DOUBLE_BUTTON_PRESS
                and event.button == 1):
            (model, node) = self.selection.get_selected()
            if not node:
                return
            sort_path = self.sort_model.get_path(node)
            filt_path = self.sort_model.convert_path_to_child_path(sort_path)
            real_path = self.filt_model.convert_path_to_child_path(filt_path)
            row = self.real_model[real_path]
            the_type = row[VerifyResults.OBJ_TYPE_COL]
            handle = row[VerifyResults.OBJ_HANDLE_COL]
            if the_type == 'Person':
                try:
                    person = self.dbstate.db.get_person_from_handle(handle)
                    EditPerson(self.dbstate, self.uistate, self.track, person)
                except WindowActiveError:
                    pass
            elif the_type == 'Family':
                try:
                    family = self.dbstate.db.get_family_from_handle(handle)
                    EditFamily(self.dbstate, self.uistate, self.track, family)
                except WindowActiveError:
                    pass

    def get_image(self, column, cell, model, iter_, user_data=None):
        """ flag whether each line is a person or family """
        the_type = model.get_value(iter_, VerifyResults.OBJ_TYPE_COL)
        if the_type == 'Person':
            cell.set_property('icon-name', 'gramps-person')
        elif the_type == 'Family':
            cell.set_property('icon-name', 'gramps-family')

    def add_results(self, results):
        (msg, gramps_id, name, the_type, rule_id, severity, handle) = results
        ignore = self.get_marking(handle, rule_id)
        if severity == Rule.ERROR:
            line_color = 'red'
        else:
            line_color = None
        self.real_model.append(row=[ignore, msg, gramps_id, name,
                                    the_type, rule_id, handle, line_color,
                                    True, not ignore])

        if not self.window_shown:
            self.window.show()
            self.window_shown = True

    def build_menu_names(self, obj):
        """ build the menu names """
        return (self.title, self.title)

#------------------------------------------------------------------------
#
#
#
#------------------------------------------------------------------------
class VerifyOptions(tool.ToolOptions):
    """
    Defines options and provides handling interface.
    """

    def __init__(self, name, person_id=None):
        """ initialize the options """
        tool.ToolOptions.__init__(self, name, person_id)

        # Options specific for this report
        self.options_dict = {
            'oldage'       : 90,
            'hwdif'        : 30,
            'cspace'       : 8,
            'cbspan'       : 25,
            'yngmar'       : 17,
            'oldmar'       : 50,
            'oldmom'       : 48,
            'yngmom'       : 17,
            'yngdad'       : 18,
            'olddad'       : 65,
            'wedder'       : 3,
            'mxchildmom'   : 12,
            'mxchilddad'   : 15,
            'lngwdw'       : 30,
            'oldunm'       : 99,
            'estimate_age' : 0,
            'invdate'      : 1,
        }
        # TODO these strings are defined in the glade file (more or less, since
        # those have accelerators), and so are not translated here, but that
        # means that a CLI user who runs gramps in a non-English language and
        # says (for instance) "show=oldage" will see "Maximum age" in English
        # (but I think such a CLI use is very unlikely and so is low priority,
        # especially since the tool's normal CLI output will be translated)
        self.options_help = {
            'oldage'       : ("=num", "Maximum age", "Age in years"),
            'hwdif'        : ("=num", "Maximum husband-wife age difference",
                              "Age difference in years"),
            'cspace'       : ("=num",
                              "Maximum number of years between children",
                              "Number of years"),
            'cbspan'       : ("=num",
                              "Maximum span of years for all children",
                              "Span in years"),
            'yngmar'       : ("=num", "Minimum age to marry", "Age in years"),
            'oldmar'       : ("=num", "Maximum age to marry", "Age in years"),
            'oldmom'       : ("=num", "Maximum age to bear a child",
                              "Age in years"),
            'yngmom'       : ("=num", "Minimum age to bear a child",
                              "Age in years"),
            'yngdad'       : ("=num", "Minimum age to father a child",
                              "Age in years"),
            'olddad'       : ("=num", "Maximum age to father a child",
                              "Age in years"),
            'wedder'       : ("=num", "Maximum number of spouses for a person",
                              "Number of spouses"),
            'mxchildmom'   : ("=num", "Maximum number of children for a woman",
                              "Number of children"),
            'mxchilddad'   : ("=num", "Maximum  number of children for a man",
                              "Number of chidlren"),
            'lngwdw'       : ("=num", "Maximum number of consecutive years "
                              "of widowhood before next marriage",
                              "Number of years"),
            'oldunm'       : ("=num", "Maximum age for an unmarried person"
                              "Number of years"),
            'estimate_age' : ("=0/1",
                              "Whether to estimate missing or inexact dates",
                              ["Do not estimate", "Estimate dates"],
                              True),
            'invdate'      : ("=0/1", "Whether to check for invalid dates"
                              "Do not identify invalid dates",
                              "Identify invalid dates", True),
        }

#-------------------------------------------------------------------------
#
# Base classes for different tests -- the rules
#
#-------------------------------------------------------------------------
class Rule:
    """
    Basic class for use in this tool.

    Other rules must inherit from this.
    """
    ID = 0
    TYPE = ''

    ERROR = 1
    WARNING = 2

    SEVERITY = WARNING

    def __init__(self, db, obj):
        """ initialize the rule """
        self.db = db
        self.obj = obj

    def broken(self):
        """
        Return boolean indicating whether this rule is violated.
        """
        return False

    def get_message(self):
        """ return the rule's error message """
        assert False, "Need to be overriden in the derived class"

    def get_name(self):
        """ return the person's primary name or the name of the family """
        assert False, "Need to be overriden in the derived class"

    def get_handle(self):
        """ return the object's handle """
        return self.obj.handle

    def get_id(self):
        """ return the object's gramps_id """
        return self.obj.gramps_id

    def get_rule_id(self):
        """ return the rule's identification number, and parameters """
        params = self._get_params()
        return (self.ID, params)

    def _get_params(self):
        """ return the rule's parameters """
        return tuple()

    def report_itself(self):
        """ return the details about a rule """
        handle = self.get_handle()
        the_type = self.TYPE
        rule_id = self.get_rule_id()
        severity = self.SEVERITY
        name = self.get_name()
        gramps_id = self.get_id()
        msg = self.get_message()
        return (msg, gramps_id, name, the_type, rule_id, severity, handle)

class PersonRule(Rule):
    """
    Person-based class.
    """
    TYPE = 'Person'
    def get_name(self):
        """ return the person's primary name """
        return self.obj.get_primary_name().get_name()

class FamilyRule(Rule):
    """
    Family-based class.
    """
    TYPE = 'Family'
    def get_name(self):
        """ return the name of the family """
        return family_name(self.obj, self.db)

#-------------------------------------------------------------------------
#
# Actual rules for testing
#
#-------------------------------------------------------------------------
class BirthAfterBapt(PersonRule):
    """ test if a person was baptised before their birth """
    ID = 1
    SEVERITY = Rule.ERROR
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        birth_date = get_birth_date(self.db, self.obj)
        bapt_date = get_bapt_date(self.db, self.obj)
        birth_ok = birth_date > 0 if birth_date is not None else False
        bapt_ok = bapt_date > 0 if bapt_date is not None else False
        return birth_ok and bapt_ok and birth_date > bapt_date

    def get_message(self):
        """ return the rule's error message """
        return _("Baptism before birth")

class DeathBeforeBapt(PersonRule):
    """ test if a person died before their baptism """
    ID = 2
    SEVERITY = Rule.ERROR
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        death_date = get_death_date(self.db, self.obj)
        bapt_date = get_bapt_date(self.db, self.obj)
        bapt_ok = bapt_date > 0 if bapt_date is not None else False
        death_ok = death_date > 0 if death_date is not None else False
        return death_ok and bapt_ok and bapt_date > death_date

    def get_message(self):
        """ return the rule's error message """
        return _("Death before baptism")

class BirthAfterBury(PersonRule):
    """ test if a person was buried before their birth """
    ID = 3
    SEVERITY = Rule.ERROR
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        birth_date = get_birth_date(self.db, self.obj)
        bury_date = get_bury_date(self.db, self.obj)
        birth_ok = birth_date > 0 if birth_date is not None else False
        bury_ok = bury_date > 0 if bury_date is not None else False
        return birth_ok and bury_ok and birth_date > bury_date

    def get_message(self):
        """ return the rule's error message """
        return _("Burial before birth")

class DeathAfterBury(PersonRule):
    """ test if a person was buried before their death """
    ID = 4
    SEVERITY = Rule.ERROR
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        death_date = get_death_date(self.db, self.obj)
        bury_date = get_bury_date(self.db, self.obj)
        death_ok = death_date > 0 if death_date is not None else False
        bury_ok = bury_date > 0 if bury_date is not None else False
        return death_ok and bury_ok and death_date > bury_date

    def get_message(self):
        """ return the rule's error message """
        return _("Burial before death")

class BirthAfterDeath(PersonRule):
    """ test if a person died before their birth """
    ID = 5
    SEVERITY = Rule.ERROR
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        birth_date = get_birth_date(self.db, self.obj)
        death_date = get_death_date(self.db, self.obj)
        birth_ok = birth_date > 0 if birth_date is not None else False
        death_ok = death_date > 0 if death_date is not None else False
        return birth_ok and death_ok and birth_date > death_date

    def get_message(self):
        """ return the rule's error message """
        return _("Death before birth")

class BaptAfterBury(PersonRule):
    """ test if a person was buried before their baptism """
    ID = 6
    SEVERITY = Rule.ERROR
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        bapt_date = get_bapt_date(self.db, self.obj)
        bury_date = get_bury_date(self.db, self.obj)
        bapt_ok = bapt_date > 0 if bapt_date is not None else False
        bury_ok = bury_date > 0 if bury_date is not None else False
        return bapt_ok and bury_ok and bapt_date > bury_date

    def get_message(self):
        """ return the rule's error message """
        return _("Burial before baptism")

class OldAge(PersonRule):
    """ test if a person died beyond the age the user has set """
    ID = 7
    SEVERITY = Rule.WARNING
    def __init__(self, db, person, old_age, est):
        """ initialize the rule """
        PersonRule.__init__(self, db, person)
        self.old_age = old_age
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.old_age, self.est)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        age_at_death = get_age_at_death(self.db, self.obj, self.est)
        return age_at_death / 365 > self.old_age

    def get_message(self):
        """ return the rule's error message """
        return _("Old age at death")

class UnknownGender(PersonRule):
    """ test if a person is neither a male nor a female """
    ID = 8
    SEVERITY = Rule.WARNING
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        female = self.obj.get_gender() == Person.FEMALE
        male = self.obj.get_gender() == Person.MALE
        return not (male or female)

    def get_message(self):
        """ return the rule's error message """
        return _("Unknown gender")

class MultipleParents(PersonRule):
    """ test if a person belongs to multiple families """
    ID = 9
    SEVERITY = Rule.WARNING
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        n_parent_sets = len(self.obj.get_parent_family_handle_list())
        return n_parent_sets > 1

    def get_message(self):
        """ return the rule's error message """
        return _("Multiple parents")

class MarriedOften(PersonRule):
    """ test if a person was married 'often' """
    ID = 10
    SEVERITY = Rule.WARNING
    def __init__(self, db, person, wedder):
        """ initialize the rule """
        PersonRule.__init__(self, db, person)
        self.wedder = wedder

    def _get_params(self):
        """ return the rule's parameters """
        return (self.wedder,)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        n_spouses = len(self.obj.get_family_handle_list())
        return n_spouses > self.wedder

    def get_message(self):
        """ return the rule's error message """
        return _("Married often")

class OldUnmarried(PersonRule):
    """ test if a person was married when they died """
    ID = 11
    SEVERITY = Rule.WARNING
    def __init__(self, db, person, old_unm, est):
        """ initialize the rule """
        PersonRule.__init__(self, db, person)
        self.old_unm = old_unm
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.old_unm, self.est)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        age_at_death = get_age_at_death(self.db, self.obj, self.est)
        n_spouses = len(self.obj.get_family_handle_list())
        return age_at_death / 365 > self.old_unm and n_spouses == 0

    def get_message(self):
        """ return the rule's error message """
        return _("Old and unmarried")

class TooManyChildren(PersonRule):
    """ test if a person had 'too many' children """
    ID = 12
    SEVERITY = Rule.WARNING
    def __init__(self, db, obj, mx_child_dad, mx_child_mom):
        """ initialize the rule """
        PersonRule.__init__(self, db, obj)
        self.mx_child_dad = mx_child_dad
        self.mx_child_mom = mx_child_mom

    def _get_params(self):
        """ return the rule's parameters """
        return (self.mx_child_dad, self.mx_child_mom)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        n_child = get_n_children(self.db, self.obj)

        if (self.obj.get_gender == Person.MALE
                and n_child > self.mx_child_dad):
            return True

        if (self.obj.get_gender == Person.FEMALE
                and n_child > self.mx_child_mom):
            return True

        return False

    def get_message(self):
        """ return the rule's error message """
        return _("Too many children")

class SameSexFamily(FamilyRule):
    """ test if a family's parents are both male or both female """
    ID = 13
    SEVERITY = Rule.WARNING
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        mother = get_mother(self.db, self.obj)
        father = get_father(self.db, self.obj)
        same_sex = (mother and father and
                    (mother.get_gender() == father.get_gender()))
        unknown_sex = (mother and
                       (mother.get_gender() == Person.UNKNOWN))
        return same_sex and not unknown_sex

    def get_message(self):
        """ return the rule's error message """
        return _("Same sex marriage")

class FemaleHusband(FamilyRule):
    """ test if a family's 'husband' is female """
    ID = 14
    SEVERITY = Rule.WARNING
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        father = get_father(self.db, self.obj)
        return father and (father.get_gender() == Person.FEMALE)

    def get_message(self):
        """ return the rule's error message """
        return _("Female husband")

class MaleWife(FamilyRule):
    """ test if a family's 'wife' is male """
    ID = 15
    SEVERITY = Rule.WARNING
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        mother = get_mother(self.db, self.obj)
        return mother and (mother.get_gender() == Person.MALE)

    def get_message(self):
        """ return the rule's error message """
        return _("Male wife")

class SameSurnameFamily(FamilyRule):
    """ test if a family's parents were born with the same surname """
    ID = 16
    SEVERITY = Rule.WARNING
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        mother = get_mother(self.db, self.obj)
        father = get_father(self.db, self.obj)
        _broken = False

        # Make sure both mother and father exist.
        if mother and father:
            mname = mother.get_primary_name()
            fname = father.get_primary_name()
            # Only compare birth names (not married names).
            if (mname.get_type() == NameType.BIRTH
                    and fname.get_type() == NameType.BIRTH):
                # Empty names don't count.
                if (len(mname.get_surname()) != 0
                        and len(fname.get_surname()) != 0):
                    # Finally, check if the names are the same.
                    if mname.get_surname() == fname.get_surname():
                        _broken = True

        return _broken

    def get_message(self):
        """ return the rule's error message """
        return _("Husband and wife with the same surname")

class LargeAgeGapFamily(FamilyRule):
    """ test if a family's parents were born far apart """
    ID = 17
    SEVERITY = Rule.WARNING
    def __init__(self, db, obj, hw_diff, est):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)
        self.hw_diff = hw_diff
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.hw_diff, self.est)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        mother = get_mother(self.db, self.obj)
        father = get_father(self.db, self.obj)
        mother_birth_date = get_birth_date(self.db, mother, self.est)
        father_birth_date = get_birth_date(self.db, father, self.est)
        mother_birth_date_ok = mother_birth_date > 0
        father_birth_date_ok = father_birth_date > 0
        large_diff = abs(
            father_birth_date-mother_birth_date) / 365 > self.hw_diff
        return mother_birth_date_ok and father_birth_date_ok and large_diff

    def get_message(self):
        """ return the rule's error message """
        return _("Large age difference between spouses")

class MarriageBeforeBirth(FamilyRule):
    """ test if each family's parent was born before the marriage """
    ID = 18
    SEVERITY = Rule.ERROR
    def __init__(self, db, obj, est):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.est,)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        marr_date = get_marriage_date(self.db, self.obj)
        marr_date_ok = marr_date > 0

        mother = get_mother(self.db, self.obj)
        father = get_father(self.db, self.obj)
        mother_birth_date = get_birth_date(self.db, mother, self.est)
        father_birth_date = get_birth_date(self.db, father, self.est)
        mother_birth_date_ok = mother_birth_date > 0
        father_birth_date_ok = father_birth_date > 0

        father_broken = (father_birth_date_ok and marr_date_ok
                         and (father_birth_date > marr_date))
        mother_broken = (mother_birth_date_ok and marr_date_ok
                         and (mother_birth_date > marr_date))

        return father_broken or mother_broken

    def get_message(self):
        """ return the rule's error message """
        return _("Marriage before birth")

class MarriageAfterDeath(FamilyRule):
    """ test if each family's parent died before the marriage """
    ID = 19
    SEVERITY = Rule.ERROR
    def __init__(self, db, obj, est):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.est,)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        marr_date = get_marriage_date(self.db, self.obj)
        marr_date_ok = marr_date > 0

        mother = get_mother(self.db, self.obj)
        father = get_father(self.db, self.obj)
        mother_death_date = get_death_date(self.db, mother, self.est)
        father_death_date = get_death_date(self.db, father, self.est)
        mother_death_date_ok = mother_death_date > 0
        father_death_date_ok = father_death_date > 0

        father_broken = (father_death_date_ok and marr_date_ok
                         and (father_death_date < marr_date))
        mother_broken = (mother_death_date_ok and marr_date_ok
                         and (mother_death_date < marr_date))

        return father_broken or mother_broken

    def get_message(self):
        """ return the rule's error message """
        return _("Marriage after death")

class EarlyMarriage(FamilyRule):
    """ test if each family's parent was 'too young' at the marriage """
    ID = 20
    SEVERITY = Rule.WARNING
    def __init__(self, db, obj, yng_mar, est):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)
        self.yng_mar = yng_mar
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.yng_mar, self.est,)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        marr_date = get_marriage_date(self.db, self.obj)
        marr_date_ok = marr_date > 0

        mother = get_mother(self.db, self.obj)
        father = get_father(self.db, self.obj)
        mother_birth_date = get_birth_date(self.db, mother, self.est)
        father_birth_date = get_birth_date(self.db, father, self.est)
        mother_birth_date_ok = mother_birth_date > 0
        father_birth_date_ok = father_birth_date > 0

        father_broken = (
            father_birth_date_ok and marr_date_ok and
            father_birth_date < marr_date and
            ((marr_date - father_birth_date) / 365 < self.yng_mar))
        mother_broken = (
            mother_birth_date_ok and marr_date_ok and
            mother_birth_date < marr_date and
            ((marr_date - mother_birth_date) / 365 < self.yng_mar))

        return father_broken or mother_broken

    def get_message(self):
        """ return the rule's error message """
        return _("Early marriage")

class LateMarriage(FamilyRule):
    """ test if each family's parent was 'too old' at the marriage """
    ID = 21
    SEVERITY = Rule.WARNING
    def __init__(self, db, obj, old_mar, est):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)
        self.old_mar = old_mar
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.old_mar, self.est)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        marr_date = get_marriage_date(self.db, self.obj)
        marr_date_ok = marr_date > 0

        mother = get_mother(self.db, self.obj)
        father = get_father(self.db, self.obj)
        mother_birth_date = get_birth_date(self.db, mother, self.est)
        father_birth_date = get_birth_date(self.db, father, self.est)
        mother_birth_date_ok = mother_birth_date > 0
        father_birth_date_ok = father_birth_date > 0

        father_broken = (
            father_birth_date_ok and marr_date_ok and
            ((marr_date - father_birth_date) / 365 > self.old_mar))
        mother_broken = (
            mother_birth_date_ok and marr_date_ok and
            ((marr_date - mother_birth_date) / 365 > self.old_mar))

        return father_broken or mother_broken

    def get_message(self):
        """ return the rule's error message """
        return _("Late marriage")

class OldParent(FamilyRule):
    """ test if each family's parent was 'too old' at a child's birth """
    ID = 22
    SEVERITY = Rule.WARNING
    def __init__(self, db, obj, old_mom, old_dad, est):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)
        self.old_mom = old_mom
        self.old_dad = old_dad
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.old_mom, self.old_dad, self.est)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        mother = get_mother(self.db, self.obj)
        father = get_father(self.db, self.obj)
        mother_birth_date = get_birth_date(self.db, mother, self.est)
        father_birth_date = get_birth_date(self.db, father, self.est)
        mother_birth_date_ok = mother_birth_date > 0
        father_birth_date_ok = father_birth_date > 0

        for child_ref in self.obj.get_child_ref_list():
            child = find_person(self.db, child_ref.ref)
            child_birth_date = get_birth_date(self.db, child, self.est)
            child_birth_date_ok = child_birth_date > 0
            if not child_birth_date_ok:
                continue
            father_broken = (
                father_birth_date_ok and
                ((child_birth_date - father_birth_date) / 365 > self.old_dad))
            if father_broken:
                self.get_message = self.father_message
                return True

            mother_broken = (
                mother_birth_date_ok and
                ((child_birth_date - mother_birth_date) / 365 > self.old_mom))
            if mother_broken:
                self.get_message = self.mother_message
                return True
        return False

    def father_message(self):
        """ return the rule's error message """
        return _("Old father")

    def mother_message(self):
        """ return the rule's error message """
        return _("Old mother")

class YoungParent(FamilyRule):
    """ test if each family's parent was 'too young' at a child's birth """
    ID = 23
    SEVERITY = Rule.WARNING
    def __init__(self, db, obj, yng_mom, yng_dad, est):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)
        self.yng_dad = yng_dad
        self.yng_mom = yng_mom
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.yng_mom, self.yng_dad, self.est)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        mother = get_mother(self.db, self.obj)
        father = get_father(self.db, self.obj)
        mother_birth_date = get_birth_date(self.db, mother, self.est)
        father_birth_date = get_birth_date(self.db, father, self.est)
        mother_birth_date_ok = mother_birth_date > 0
        father_birth_date_ok = father_birth_date > 0

        for child_ref in self.obj.get_child_ref_list():
            child = find_person(self.db, child_ref.ref)
            child_birth_date = get_birth_date(self.db, child, self.est)
            child_birth_date_ok = child_birth_date > 0
            if not child_birth_date_ok:
                continue
            father_broken = (
                father_birth_date_ok and
                ((child_birth_date - father_birth_date) / 365 < self.yng_dad))
            if father_broken:
                self.get_message = self.father_message
                return True

            mother_broken = (
                mother_birth_date_ok and
                ((child_birth_date - mother_birth_date) / 365 < self.yng_mom))
            if mother_broken:
                self.get_message = self.mother_message
                return True
        return False

    def father_message(self):
        """ return the rule's error message """
        return _("Young father")

    def mother_message(self):
        """ return the rule's error message """
        return _("Young mother")

class UnbornParent(FamilyRule):
    """ test if each family's parent was not yet born at a child's birth """
    ID = 24
    SEVERITY = Rule.ERROR
    def __init__(self, db, obj, est):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.est,)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        mother = get_mother(self.db, self.obj)
        father = get_father(self.db, self.obj)
        mother_birth_date = get_birth_date(self.db, mother, self.est)
        father_birth_date = get_birth_date(self.db, father, self.est)
        mother_birth_date_ok = mother_birth_date > 0
        father_birth_date_ok = father_birth_date > 0

        for child_ref in self.obj.get_child_ref_list():
            child = find_person(self.db, child_ref.ref)
            child_birth_date = get_birth_date(self.db, child, self.est)
            child_birth_date_ok = child_birth_date > 0
            if not child_birth_date_ok:
                continue
            father_broken = (father_birth_date_ok
                             and (father_birth_date > child_birth_date))
            if father_broken:
                self.get_message = self.father_message
                return True

            mother_broken = (mother_birth_date_ok
                             and (mother_birth_date > child_birth_date))
            if mother_broken:
                self.get_message = self.mother_message
                return True

    def father_message(self):
        """ return the rule's error message """
        return _("Unborn father")

    def mother_message(self):
        """ return the rule's error message """
        return _("Unborn mother")

class DeadParent(FamilyRule):
    """ test if each family's parent was dead at a child's birth """
    ID = 25
    SEVERITY = Rule.ERROR
    def __init__(self, db, obj, est):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.est,)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        mother = get_mother(self.db, self.obj)
        father = get_father(self.db, self.obj)
        mother_death_date = get_death_date(self.db, mother, self.est)
        father_death_date = get_death_date(self.db, father, self.est)
        mother_death_date_ok = mother_death_date > 0
        father_death_date_ok = father_death_date > 0

        for child_ref in self.obj.get_child_ref_list():
            child = find_person(self.db, child_ref.ref)
            child_birth_date = get_birth_date(self.db, child, self.est)
            child_birth_date_ok = child_birth_date > 0
            if not child_birth_date_ok:
                continue

            has_birth_rel_to_mother = child_ref.mrel == ChildRefType.BIRTH
            has_birth_rel_to_father = child_ref.frel == ChildRefType.BIRTH

            father_broken = (
                has_birth_rel_to_father
                and father_death_date_ok
                and ((father_death_date + 294) < child_birth_date))
            if father_broken:
                self.get_message = self.father_message
                return True

            mother_broken = (has_birth_rel_to_mother
                             and mother_death_date_ok
                             and (mother_death_date < child_birth_date))
            if mother_broken:
                self.get_message = self.mother_message
                return True

    def father_message(self):
        """ return the rule's error message """
        return _("Dead father")

    def mother_message(self):
        """ return the rule's error message """
        return _("Dead mother")

class LargeChildrenSpan(FamilyRule):
    """ test if a family's first and last children were born far apart """
    ID = 26
    SEVERITY = Rule.WARNING
    def __init__(self, db, obj, cb_span, est):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)
        self.cbs = cb_span
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.cbs, self.est)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        child_birh_dates = get_child_birth_dates(self.db, self.obj, self.est)
        child_birh_dates.sort()

        return (child_birh_dates and
                ((child_birh_dates[-1] - child_birh_dates[0]) / 365 > self.cbs))

    def get_message(self):
        """ return the rule's error message """
        return _("Large year span for all children")

class LargeChildrenAgeDiff(FamilyRule):
    """ test if any of a family's children were born far apart """
    ID = 27
    SEVERITY = Rule.WARNING
    def __init__(self, db, obj, c_space, est):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)
        self.c_space = c_space
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.c_space, self.est)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        child_birh_dates = get_child_birth_dates(self.db, self.obj, self.est)
        child_birh_dates_diff = [child_birh_dates[i+1] - child_birh_dates[i]
                                 for i in range(len(child_birh_dates)-1)]

        return (child_birh_dates_diff and
                max(child_birh_dates_diff) / 365 > self.c_space)

    def get_message(self):
        """ return the rule's error message """
        return _("Large age differences between children")

class Disconnected(PersonRule):
    """ test if a person has no children and no parents """
    ID = 28
    SEVERITY = Rule.WARNING
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        return (len(self.obj.get_parent_family_handle_list())
                + len(self.obj.get_family_handle_list()) == 0)

    def get_message(self):
        """ return the rule's error message """
        return _("Disconnected individual")

class InvalidBirthDate(PersonRule):
    """ test if a person has an 'invalid' birth date """
    ID = 29
    SEVERITY = Rule.ERROR
    def __init__(self, db, person, invdate):
        """ initialize the rule """
        PersonRule.__init__(self, db, person)
        self._invdate = invdate

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        if not self._invdate: # should we check?
            return False
        # if so, let's get the birth date
        person = self.obj
        birth_ref = person.get_birth_ref()
        if birth_ref:
            birth_event = self.db.get_event_from_handle(birth_ref.ref)
            birth_date = birth_event.get_date_object()
            if birth_date and not birth_date.get_valid():
                return True
        return False

    def get_message(self):
        """ return the rule's error message """
        return _("Invalid birth date")

class InvalidDeathDate(PersonRule):
    """ test if a person has an 'invalid' death date """
    ID = 30
    SEVERITY = Rule.ERROR
    def __init__(self, db, person, invdate):
        """ initialize the rule """
        PersonRule.__init__(self, db, person)
        self._invdate = invdate

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        if not self._invdate: # should we check?
            return False
        # if so, let's get the death date
        person = self.obj
        death_ref = person.get_death_ref()
        if death_ref:
            death_event = self.db.get_event_from_handle(death_ref.ref)
            death_date = death_event.get_date_object()
            if death_date and not death_date.get_valid():
                return True
        return False

    def get_message(self):
        """ return the rule's error message """
        return _("Invalid death date")

class MarriedRelation(FamilyRule):
    """ test if a family has a marriage date but is not marked 'married' """
    ID = 31
    SEVERITY = Rule.WARNING
    def __init__(self, db, obj):
        """ initialize the rule """
        FamilyRule.__init__(self, db, obj)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        marr_date = get_marriage_date(self.db, self.obj)
        marr_date_ok = marr_date > 0
        married = self.obj.get_relationship() == FamilyRelType.MARRIED
        if not married and marr_date_ok:
            return self.get_message

    def get_message(self):
        """ return the rule's error message """
        return _("Marriage date but not married")

class OldAgeButNoDeath(PersonRule):
    """ test if a person is 'too old' but is not shown as dead """
    ID = 32
    SEVERITY = Rule.WARNING
    def __init__(self, db, person, old_age, est):
        """ initialize the rule """
        PersonRule.__init__(self, db, person)
        self.old_age = old_age
        self.est = est

    def _get_params(self):
        """ return the rule's parameters """
        return (self.old_age, self.est)

    def broken(self):
        """ return boolean indicating whether this rule is violated """
        birth_date = get_birth_date(self.db, self.obj, self.est)
        dead = get_death(self.db, self.obj)
        death_date = get_death_date(self.db, self.obj, True) # or burial date
        if dead or death_date or not birth_date:
            return 0
        age = (_today - birth_date) / 365
        return age > self.old_age

    def get_message(self):
        """ return the rule's error message """
        return _("Old age but no death")

class BirthEqualsDeath(PersonRule):
    """ test if a person's birth date is the same as their death date """
    ID = 33
    SEVERITY = Rule.ERROR
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        birth_date = get_birth_date(self.db, self.obj)
        death_date = get_death_date(self.db, self.obj)
        birth_ok = birth_date > 0 if birth_date is not None else False
        death_ok = death_date > 0 if death_date is not None else False
        return death_ok and birth_ok and birth_date == death_date

    def get_message(self):
        """ return the rule's error message """
        return _("Birth equals death")

class BirthEqualsMarriage(PersonRule):
    """ test if a person's birth date is the same as their marriage date """
    ID = 34
    SEVERITY = Rule.ERROR
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        birth_date = get_birth_date(self.db, self.obj)
        birth_ok = birth_date > 0 if birth_date is not None else False
        for fhandle in self.obj.get_family_handle_list():
            family = self.db.get_family_from_handle(fhandle)
            marr_date = get_marriage_date(self.db, family)
            marr_ok = marr_date > 0 if marr_date is not None else False
            return marr_ok and birth_ok and birth_date == marr_date

    def get_message(self):
        """ return the rule's error message """
        return _("Birth equals marriage")

class DeathEqualsMarriage(PersonRule):
    """ test if a person's death date is the same as their marriage date """
    ID = 35
    SEVERITY = Rule.WARNING # it's possible
    def broken(self):
        """ return boolean indicating whether this rule is violated """
        death_date = get_death_date(self.db, self.obj)
        death_ok = death_date > 0 if death_date is not None else False
        for fhandle in self.obj.get_family_handle_list():
            family = self.db.get_family_from_handle(fhandle)
            marr_date = get_marriage_date(self.db, family)
            marr_ok = marr_date > 0 if marr_date is not None else False
            return marr_ok and death_ok and death_date == marr_date

    def get_message(self):
        """ return the rule's error message """
        return _("Death equals marriage")

