gramps/src/ChooseParents.py

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2005  Donald N. Allingham
#
# 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$

"""
ChooseParents interface allows users to select the paretns of an
individual.
"""

__author__ = "Donald N. Allingham"
__version__ = "$Revision$"

#-------------------------------------------------------------------------
#
# internationalization
#
#-------------------------------------------------------------------------
from gettext import gettext as _

#-------------------------------------------------------------------------
#
# GTK/Gnome modules
#
#-------------------------------------------------------------------------
import gtk.glade
import gtk.gdk
import gnome

#-------------------------------------------------------------------------
#
# gramps modules
#
#-------------------------------------------------------------------------
import RelLib
import const
import Utils
import PeopleModel
import Date
import NameDisplay
import DateHandler
import GenericFilter
from QuestionDialog import ErrorDialog, WarningDialog

#-------------------------------------------------------------------------
#
# ChooseParents
#
#-------------------------------------------------------------------------
class ChooseParents:
    """
    Displays the Choose Parents dialog box, allowing the parents
    to be edited.
    """
    def __init__(self,parent,db,person,family):
        """
        Creates a ChoosePerson dialog box.

        db - database associated the person
        person - person whose parents we are selecting
        family - current family
        """
        self.parent = parent
        self.db = db
        self.child_windows = {}
        self.person = self.db.get_person_from_handle(person.get_handle())
        if family:
            self.family = self.db.get_family_from_handle(family.get_handle())
        else:
            self.family = None
        self.old_type = ""
        self.type = ""
        self.parent_selected = 0
        self.renderer = gtk.CellRendererText()

        db.connect('person-add', self.redraw)
        db.connect('person-update', self.redraw)
        db.connect('person-delete', self.redraw)
        db.connect('person-rebuild', self.redraw2)

        # set default filters
        self.all_males_filter = GenericFilter.GenericFilter()
        self.all_males_filter.add_rule(GenericFilter.IsMale([]))
        self.likely_males_filter = self.build_likely(True)

        self.all_females_filter = GenericFilter.GenericFilter()
        self.all_females_filter.add_rule(GenericFilter.IsFemale([]))
        self.likely_females_filter = self.build_likely(False)

        self.father_filter = self.likely_males_filter
        self.mother_filter = self.likely_females_filter

        if self.family:
            self.father = self.family.get_father_handle()
            self.mother = self.family.get_mother_handle()
        else:
            self.mother = None
            self.father = None

        self.glade = gtk.glade.XML(const.gladeFile,"familyDialog","gramps")
        self.window = self.glade.get_widget("familyDialog")

        name = NameDisplay.displayer.display(self.person)
        self.title_text = _("Choose the Parents of %s") % name
        Utils.set_titles(self.window,self.glade.get_widget('title'),
                         self.title_text,_('Choose Parents'))
        
        self.mcombo = self.glade.get_widget("mcombo")
        self.fcombo = self.glade.get_widget("fcombo")
        self.prel = self.glade.get_widget("prel_combo")
        self.title = self.glade.get_widget("chooseTitle")
        self.father_list = self.glade.get_widget("father_list")
        self.mother_list = self.glade.get_widget("mother_list")
        self.flabel = self.glade.get_widget("flabel")
        self.mlabel = self.glade.get_widget("mlabel")
        self.showallf = self.glade.get_widget('showallf')
        self.showallm = self.glade.get_widget('showallm')
        self.add_itself_to_menu()
        
        self.build_father_list()
        self.build_mother_list()

        if gtk.gdk.screen_height() > 700:
            self.father_list.set_size_request(-1,150)
            self.mother_list.set_size_request(-1,150)
        
        for (f,mr,fr) in self.person.get_parent_family_handle_list():
            if f == self.family:
                mrel = mr
                frel = fr
                break
        else:
            mrel = const.CHILD_BIRTH
            frel = const.CHILD_BIRTH

        if self.family:
            self.type = self.family.get_relationship()
        else:
            self.type = RelLib.Family.MARRIED

        self.prel.set_active(self.type)
        self.redrawm()
        
        self.glade.signal_autoconnect({
            "on_add_parent_clicked"        : self.add_parent_clicked,
            "on_prel_changed"              : self.parent_relation_changed,
            "destroy_passed_object"        : self.close,
            "on_showallf_toggled"          : self.showallf_toggled,
            "on_showallm_toggled"          : self.showallm_toggled,
            "on_save_parents_clicked"      : self.save_parents_clicked,
            "on_help_familyDialog_clicked" : self.on_help_clicked,
            "on_familyDialog_delete_event" : self.on_delete_event,
            })

        self.keys = const.child_rel_list
        self.build_list(self.mcombo,mrel)
        self.build_list(self.fcombo,frel)
        
        self.window.show()

    def build_likely(self,is_male):
        birth_handle = self.person.get_birth_handle()
        
        filt = GenericFilter.GenericFilter()
        if is_male:
            filt.add_rule(GenericFilter.IsMale([]))
        else:
            filt.add_rule(GenericFilter.IsFemale([]))

        if birth_handle:
            birth = self.db.get_event_from_handle(birth_handle)
            date_obj = Date.Date(birth.get_date_object())
            year = date_obj.get_year()
            if year:
                date_obj.set_year(year-10)
                date_obj.set_modifier(Date.MOD_BEFORE)
                rule = GenericFilter.HasBirth(
                    [DateHandler.displayer.display(date_obj),"",""])
                filt.add_rule(rule)

                date_obj = Date.Date(birth.get_date_object())
                date_obj.set_year(year-60)
                date_obj.set_modifier(Date.MOD_AFTER)
                rule = GenericFilter.HasBirth(
                    [DateHandler.displayer.display(date_obj),"",""])
                filt.add_rule(rule)
        return filt

    def build_list(self,opt_menu,sel):
        cell = gtk.CellRendererText()
        opt_menu.pack_start(cell,True)
        opt_menu.add_attribute(cell,'text',0)
        
        store = gtk.ListStore(str)
        for val in self.keys:
            store.append(row=[val])
        opt_menu.set_model(store)
        opt_menu.set_active(sel)

    def build_father_list(self):
        self.father_selection = self.father_list.get_selection()
        self.father_selection.connect('changed',self.father_list_select_row)
        self.add_columns(self.father_list)
        self.redrawf()

    def build_mother_list(self):
        self.mother_selection = self.mother_list.get_selection()
        self.mother_selection.connect('changed',self.mother_list_select_row)
        self.add_columns(self.mother_list)
        self.redrawm()
        
    def add_columns(self,tree):
        column = gtk.TreeViewColumn(_('Name'), self.renderer,text=0)
        column.set_resizable(True)        
        column.set_clickable(True)
        column.set_sort_column_id(0)
        column.set_min_width(225)
        tree.append_column(column)
        column = gtk.TreeViewColumn(_('ID'), self.renderer,text=1)
        column.set_resizable(True)        
        column.set_clickable(True)
        column.set_sort_column_id(1)
        column.set_min_width(75)
        tree.append_column(column)
        column = gtk.TreeViewColumn(_('Birth date'), self.renderer,text=3)
        #column.set_resizable(True)        
        column.set_clickable(True)
        tree.append_column(column)

    def on_delete_event(self,obj,b):
        self.remove_itself_from_menu()
        self.close_child_windows()

    def close(self,obj):
        self.remove_itself_from_menu()
        self.close_child_windows()
        self.window.destroy()
        
    def close_child_windows(self):
        for child_window in self.child_windows.values():
            child_window.close()
        self.child_windows = {}

    def add_itself_to_menu(self):
        self.parent.child_windows[self] = self
        self.win_menu_item = gtk.MenuItem(self.title_text)
        self.win_menu_item.set_submenu(gtk.Menu())
        self.win_menu_item.show()
        self.parent.winsmenu.append(self.win_menu_item)
        self.winsmenu = self.win_menu_item.get_submenu()
        self.menu_item = gtk.MenuItem(_('Choose Parents'))
        self.menu_item.connect("activate",self.present)
        self.menu_item.show()
        self.winsmenu.append(self.menu_item)

    def remove_itself_from_menu(self):
        del self.parent.child_windows[self]
        self.menu_item.destroy()
        self.winsmenu.destroy()
        self.win_menu_item.destroy()

    def present(self,obj):
        self.window.present()

    def on_help_clicked(self,obj):
        """Display the relevant portion of GRAMPS manual"""
        gnome.help_display('gramps-manual','gramps-edit-quick')

    def redraw(self,handle_list):
        self.redrawf()
        self.redrawm()
#        self.father_model.rebuild_data()
#        self.mother_model.rebuild_data()

    def redraw2(self):
        self.redrawf()
        self.redrawm()
#        self.father_model.rebuild_data()
#        self.mother_model.rebuild_data()

    def redrawf(self):
        """Redraws the potential father list"""
        self.father_model = PeopleModel.PeopleModel(self.db,self.father_filter)
        self.father_list.set_model(self.father_model)
        
        if self.type == RelLib.Family.CIVIL_UNION:
            self.flabel.set_label("<b>%s</b>" % _("Par_ent"))
        else:
            self.flabel.set_label("<b>%s</b>" % _("Fath_er"))

    def redrawm(self):
        """Redraws the potential mother list"""
        self.mother_model = PeopleModel.PeopleModel(self.db,self.mother_filter)
        self.mother_list.set_model(self.mother_model)
        
        if self.type == RelLib.Family.CIVIL_UNION:
            self.mlabel.set_label("<b>%s</b>" % _("Pa_rent"))
        else:
            self.mlabel.set_label("<b>%s</b>" % _("Mothe_r"))

    def parent_relation_changed(self,obj):
        """Called everytime the parent relationship information is changed"""
        self.old_type = self.type
        self.type = self.prel.get_active()
        if (self.old_type == RelLib.Family.CIVIL_UNION or
            self.type == RelLib.Family.CIVIL_UNION):
            self.redrawf()
            self.redrawm()

    def showallf_toggled(self,obj):
        if self.father_filter == self.likely_males_filter:
            self.father_filter = self.all_females_filter
        else:
            self.father_filter = self.likely_males_filter
        self.redrawf()

    def showallm_toggled(self,obj):
        if self.mother_filter == self.likely_females_filter:
            self.mother_filter = self.all_females_filter
        else:
            self.mother_filter = self.likely_females_filter
        self.redrawm()
        
    def find_family(self,father_handle,mother_handle,trans):
        """
        Finds the family associated with the father and mother.
        If one does not exist, it is created.
        """
        if not father_handle and not mother_handle:
            return None
    
        for family_handle in self.db.get_family_handles():
            family = self.db.get_family_from_handle(family_handle)
            if (family.get_father_handle() == father_handle and
                family.get_mother_handle() == mother_handle):
                family.add_child_handle(self.person.get_handle())
                self.db.commit_family(family,trans)
                return family
            elif (family.get_father_handle() == mother_handle and
                  family.get_mother_handle() == father_handle):
                family.add_child_handle(self.person.get_handle())
                self.db.commit_family(family,trans)
                return family

        family = RelLib.Family()
        family.set_father_handle(father_handle)
        family.set_mother_handle(mother_handle)
        family.add_child_handle(self.person.get_handle())
        self.db.add_family(family,trans)

        if father_handle:
            self.father = self.db.get_person_from_handle(father_handle)
            self.father.add_family_handle(family.get_handle())
            self.db.commit_person(self.father,trans)
        if mother_handle:
            self.mother = self.db.get_person_from_handle(mother_handle)
            self.mother.add_family_handle(family.get_handle())
            self.db.commit_person(self.mother,trans)

        self.db.commit_family(family,trans)
        return family

    def father_select_function(self,store,path,iter,id_list):
        if len(path) != 1:
            val = self.father_model.get_value(iter,PeopleModel.COLUMN_INT_ID)
            id_list.append(val)

    def mother_select_function(self,store,path,iter,id_list):
        if len(path) != 1:
            val = self.mother_model.get_value(iter,PeopleModel.COLUMN_INT_ID)
            id_list.append(val)

    def get_selected_father_handles(self):
        mlist = []
        self.father_selection.selected_foreach(self.father_select_function,
                                               mlist)
        return mlist

    def get_selected_mother_handles(self):
        mlist = []
        self.mother_selection.selected_foreach(self.mother_select_function,
                                               mlist)
        return mlist

    def father_list_select_row(self,obj):
        """Called when a row is selected in the father list. Sets the
        active father based off the id associated with the row."""

        idlist = self.get_selected_father_handles()
        if idlist and idlist[0]:
            self.father = self.db.get_person_from_handle(idlist[0])
        else:
            self.father = None

        if not self.parent_selected and self.father:
            self.parent_selected = 1
            family_handle_list = self.father.get_family_handle_list()
            if len(family_handle_list) >= 1:
                family = self.db.get_family_from_handle(family_handle_list[0])
                handle = family.get_mother_handle()
                mother = self.db.get_person_from_handle(handle)
                sname = mother.get_primary_name().get_surname()
                tpath = self.mother_model.on_get_path(sname)
                self.mother_list.expand_row(tpath,0)
                path = self.mother_model.on_get_path(handle)
                self.mother_selection.select_path(path)
                self.mother_list.scroll_to_cell(path,None,1,0.5,0)

    def mother_list_select_row(self,obj):
        """Called when a row is selected in the father list. Sets the
        active father based off the id associated with the row."""

        idlist = self.get_selected_mother_handles()
        if idlist and idlist[0]:
            self.mother = self.db.get_person_from_handle(idlist[0])
        else:
            self.mother = None

        if not self.parent_selected and self.mother:
            self.parent_selected = 1
            family_handle_list = self.mother.get_family_handle_list()
            if len(family_handle_list) >= 1:
                family = self.db.get_family_from_handle(family_handle_list[0])
                handle = family.get_father_handle()
                father = self.db.get_person_from_handle(handle)
                sname = father.get_primary_name().get_surname()
                tpath = self.father_model.on_get_path(sname)
                self.father_list.expand_row(tpath,0)
                path = self.father_model.on_get_path(handle)
                self.father_selection.select_path(path)
                self.father_list.scroll_to_cell(path,None,1,0.5,0)

    def save_parents_clicked(self,obj):
        """
        Called with the OK button is pressed. Saves the selected people
        as parents of the main person.
        """
        try:
            mother_rel = self.mcombo.get_active()
        except KeyError:
            mother_rel = const.CHILD_BIRTH

        try:
            father_rel = self.fcombo.get_active()
        except KeyError:
            father_rel = const.CHILD_BIRTH

        trans = self.db.transaction_begin()
        if self.father or self.mother:
            if self.mother and not self.father:
                if self.mother.get_gender() == RelLib.Person.MALE:
                    self.father = self.mother
                    father_handle = self.father.get_handle()
                    self.mother = None
                    mother_handle = None
                else:
                    mother_handle = self.mother.get_handle()
                    father_handle = None
            elif self.father and not self.mother: 
                if self.father.get_gender() == RelLib.Person.FEMALE:
                    self.mother = self.father
                    self.father = None
                    mother_handle = self.mother.get_handle()
                    father_handle = None
                else:
                    father_handle = self.father.get_handle()
                    mother_handle = None
            elif self.mother.get_gender() != self.father.get_gender():
                if self.type == "Partners":
                    self.type = "Unknown"
                if self.father.get_gender() == RelLib.Person.FEMALE:
                    self.father, self.mother = self.mother, self.father
                father_handle = self.father.get_handle()
                mother_handle = self.mother.get_handle()
            else:
                self.type = "Partners"
                father_handle = self.father.get_handle()
                mother_handle = self.mother.get_handle()
            self.family = self.find_family(father_handle,mother_handle,trans)
        else:    
            self.family = None

        if self.family:
            if self.person.get_handle() in (father_handle,mother_handle):
                ErrorDialog(_("Error selecting a child"),
                            _("A person cannot be linked as his/her own parent"),
                            self.window)
                return
            self.family.add_child_handle(self.person.get_handle())
            self.family.set_relationship(self.type)
            self.change_family_type(self.family,mother_rel,father_rel)
            self.db.commit_family(self.family,trans)
        self.db.transaction_commit(trans,_("Choose Parents"))
        self.close(None)

    def add_new_parent(self,epo,val):
        """Adds a new person to either the father list or the mother list,
        depending on the gender of the person."""

        person = epo.person
        handle = person.get_handle()
        name = person.get_primary_name().get_surname()
        self.type = self.prel.get_active()

        if self.type == RelLib.Family.CIVIL_UNION:
            self.parent_relation_changed(self.prel)
        elif person.get_gender() == RelLib.Person.MALE:
            try:
                path = self.father_model.on_get_path(handle)
                top_path = self.father_model.on_get_path(name)
                self.father_list.expand_row(top_path,0)
                self.father_selection.select_path(path)
                self.father_list.scroll_to_cell(path,None,1,0.5,0)
            except KeyError:
                WarningDialog(_("Added person is not visible"),
                              _("The person you added is currently "
                                "not visible due to the chosen filter. "
                                "This may occur if you did not specify "
                                "a birth date."))
        else:
            try:
                path = self.mother_model.on_get_path(handle)
                top_path = self.mother_model.on_get_path(name)
                self.mother_list.expand_row(top_path,0)
                self.mother_selection.select_path(path)
                self.mother_list.scroll_to_cell(path,None,1,0.5,0)
            except:
                WarningDialog(_("Added person is not visible"),
                              _("The person you added is currently "
                                "not visible due to the chosen filter. "
                                "This may occur if you did not specify "
                                "a birth date."))
        
    def add_parent_clicked(self,obj):
        """Called with the Add New Person button is pressed. Calls the QuickAdd
        class to create a new person."""
        
        person = RelLib.Person()
        person.set_gender(RelLib.Person.MALE)
        
        try:
            import EditPerson
            EditPerson.EditPerson(self, person,self.db,self.add_new_parent)
        except:
            import DisplayTrace
            DisplayTrace.DisplayTrace()

    def change_family_type(self,family,mother_rel,father_rel):
        """
        Changes the family type of the specified family. If the family
        is None, the the relationship type shoud be deleted.
        """
        family_handle = family.get_handle()
        if self.person.get_handle() not in family.get_child_handle_list():
            family.add_child_handle(self.person.get_handle())
        for fam in self.person.get_parent_family_handle_list():
            if family_handle == fam[0]:
                if mother_rel == fam[1] and father_rel == fam[2]:
                    return
                if mother_rel != fam[1] or father_rel != fam[2]:
                    self.person.remove_parent_family_handle(family_handle)
                    self.person.add_parent_family_handle(family_handle,
                                                         mother_rel,father_rel)
                    break
        else:
            self.person.add_parent_family_handle(family_handle,
                                                 mother_rel,father_rel)

        trans = self.db.transaction_begin()
        self.db.commit_person(self.person,trans)
        self.db.commit_family(family,trans)
        if self.father:
            self.db.commit_person(self.father,trans)
        if self.mother:
            self.db.commit_person(self.mother,trans)
        self.db.transaction_commit(trans,_("Choose Parents"))

#-------------------------------------------------------------------------
#
# ModifyParents
#
#-------------------------------------------------------------------------
class ModifyParents:
    def __init__(self, db, person, family_handle, parent_window=None):
        """
        Creates a ChoosePerson dialog box.

        db - database associated the person
        person - person whose parents we are selecting
        family - current family
        """
        self.db = db
        self.person = person
        self.family = self.db.get_family_from_handle(family_handle)

        fid = self.family.get_father_handle()
        mid = self.family.get_mother_handle()
        self.father = self.db.get_person_from_handle(fid)
        self.mother = self.db.get_person_from_handle(mid)

        self.glade = gtk.glade.XML(const.gladeFile,"modparents","gramps")
        self.window = self.glade.get_widget("modparents")
        self.title = self.glade.get_widget("title")

        name  = NameDisplay.displayer.display(self.person)
        title = _("Modify the Parents of %s") % name
        Utils.set_titles(self.window, self.title, title, _("Modify Parents"))
        
        self.mother_rel = self.glade.get_widget("mrel")
        self.father_rel = self.glade.get_widget("frel")
        self.flabel = self.glade.get_widget("flabel")
        self.mlabel = self.glade.get_widget("mlabel")
        self.fcombo = self.glade.get_widget('fcombo')
        self.mcombo = self.glade.get_widget('mcombo')

        self.orig_mrel = const.CHILD_BIRTH
        self.orig_frel = const.CHILD_BIRTH
        for (f,mr,fr) in self.person.get_parent_family_handle_list():
            if f == self.family.get_handle():
                self.orig_mrel = mr
                self.orig_frel = fr

        self.glade.signal_autoconnect({
            "on_parents_help_clicked"  : self.on_help_clicked,
            })

        self.title.set_use_markup(True)

        if self.family.get_relationship() == RelLib.Family.CIVIL_UNION:
            self.mlabel.set_label("<b>%s</b>" % _("Pa_rent"))
            self.flabel.set_label("<b>%s</b>" % _("Par_ent"))
        else:
            self.mlabel.set_label('<b>%s</b>' % _("Mother"))
            self.flabel.set_label('<b>%s</b>' % _("Father"))

        if self.father:
            fname = NameDisplay.displayer.display(self.father)
            self.glade.get_widget("fname").set_text(fname)
        else:
            self.fcombo.set_sensitive(False)
            
        if self.mother:
            mname = NameDisplay.displayer.display(self.mother)
            self.glade.get_widget("mname").set_text(mname)
        else:
            self.mcombo.set_sensitive(False)

        self.pref = self.glade.get_widget('preferred')
        if len(self.person.get_parent_family_handle_list()) > 1:
            self.glade.get_widget('pref_label').show()
            self.pref.show()
            if self.family == self.person.get_parent_family_handle_list()[0]:
                self.pref.set_active(True)
            else:
                self.pref.set_active(False)

        if parent_window:
            self.window.set_transient_for(parent_window)

        if self.db.readonly:
            self.fcombo.set_sensitive(False)
            self.mcombo.set_sensitive(False)
            self.glade.get_widget('ok').set_sensitive(False)

        self.keys = const.child_rel_list

        self.build_list(self.mcombo,self.orig_mrel)
        self.build_list(self.fcombo,self.orig_frel)
        
        self.val = self.window.run()
        if self.val == gtk.RESPONSE_OK:
            self.save_parents_clicked()
        self.window.destroy()

    def build_list(self,opt_menu,sel):
        store = gtk.ListStore(str)
        for val in self.keys:
            store.append(row=[val])
        opt_menu.set_model(store)
        opt_menu.set_active(sel)

    def on_help_clicked(self,obj):
        """Display the relevant portion of GRAMPS manual"""
        gnome.help_display('gramps-manual','gramps-spec-par')
        self.val = self.window.run()

    def save_parents_clicked(self):
        """
        Called with the OK button nis pressed. Saves the selected people
        as parents of the main person.
        """

        mother_rel = self.mcombo.get_active()
        father_rel = self.fcombo.get_active()
        mod = False

        fhandle = self.family.get_handle()
        if mother_rel != self.orig_mrel or father_rel != self.orig_frel:
            self.person.remove_parent_family_handle(fhandle)
            self.person.add_parent_family_handle(fhandle,mother_rel,father_rel)
            mod = True

        if len(self.person.get_parent_family_handle_list()):
            make_pref = self.pref.get_active()

            plist = self.person.get_parent_family_handle_list()
            if make_pref:
                if self.family != plist[0]:
                    self.person.set_main_parent_family_handle(fhandle)
                    mod = True
            else:
                if self.family == plist[0]:
                    self.person.set_main_parent_family_handle(plist[0])
                    mod = True

        if mod:
            trans = self.db.transaction_begin()
            self.db.commit_person(self.person,trans)
            self.db.transaction_commit(trans,_("Modify Parents"))