gramps/src/Editors/_EditPerson.py

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

"""
EditPerson Dialog. Provides the interface to allow the GRAMPS program
to edit information about a particular Person.
"""

__author__ = "Don Allingham"
__revision__ = "$Revision$"

#-------------------------------------------------------------------------
#
# Standard python modules
#
#-------------------------------------------------------------------------
import locale
from gettext import gettext as _

#-------------------------------------------------------------------------
#
# GTK/Gnome modules
#
#-------------------------------------------------------------------------
import gtk

#-------------------------------------------------------------------------
#
# gramps modules
#
#-------------------------------------------------------------------------
import const
import Utils
import Mime
import RelLib
import GrampsWidgets
from BasicUtils import name_displayer
import Errors

from GrampsDb import set_birth_death_index

from _EditPrimary import EditPrimary
from QuestionDialog import *
from DisplayTabs import \
     PersonEventEmbedList,NameEmbedList,SourceEmbedList,AttrEmbedList,\
     AddrEmbedList,NoteTab,GalleryTab,WebEmbedList,PersonRefEmbedList, \
     LdsEmbedList,PersonBackRefList
    
#-------------------------------------------------------------------------
#
# Constants
#
#-------------------------------------------------------------------------

_select_gender = ((True, False, False),
                  (False, True, False),
                  (False, False, True))

_use_patronymic = set(
    ["ru", "RU", "ru_RU", "koi8r", "ru_koi8r", "russian", "Russian"]
    )

class EditPerson(EditPrimary):
    """
    The EditPerson dialog is derived from the EditPrimary class. It
    allos for the editing of the primary object type of Person.
    """

    use_patronymic = locale.getlocale(locale.LC_TIME)[0] in _use_patronymic

    def __init__(self, state, uistate, track, person, callback=None):
        """
        Creates an EditPerson window.  Associates a person with the window.
        """
        EditPrimary.__init__(self, state, uistate, track, person, 
                             state.db.get_person_from_handle, callback)

    def empty_object(self):
        """
        Returns an empty Person object for comparison for changes. This
        is used by the base class (EditPrimary)
        """
        return RelLib.Person()

    def get_menu_title(self):
	if self.obj.get_handle():
	    name = name_displayer.display(self.obj)
	    title = _('Person') + ': %s' % name
	else:
	    title = _('New Person')
        return title

    def _local_init(self):
        """
        Local initialization function. Performs basic initialization,
        including setting up widgets and the glade interface. This is called
        by the base class of EditPrimary, and overridden here.
        """
        self.pname = self.obj.get_primary_name()
        self.should_guess_gender = (not self.obj.get_gramps_id() and
                                    self.obj.get_gender () ==
                                    RelLib.Person.UNKNOWN)

        self.load_obj = None
        self.top = gtk.glade.XML(const.person_glade, "edit_person", "gramps")

        self.set_window(self.top.get_widget("edit_person"), None, self.get_menu_title())
        width = Config.get(Config.PERSON_WIDTH)
        height = Config.get(Config.PERSON_HEIGHT)
        self.window.set_default_size(width, height)
        
        self.obj_photo = self.top.get_widget("personPix")
        self.eventbox = self.top.get_widget("eventbox1")

    def _post_init(self):
        """
        Post initalization function. Handles any initialization that
        needs to be done after the interface is brought up. This called
        by _EditPrimary's init routine, and overridden in the derived
        class (this class)
        """
        self.load_person_image()
        if self.pname.get_surname() and not self.pname.get_first_name():
            self.given.grab_focus()
        else:
            self.surname_field.grab_focus()

    def _connect_signals(self):
        """
        Connects any signals that need to be connected. Called by the
        init routine of the base class (_EditPrimary).
        """
        self.define_cancel_button(self.top.get_widget("button15"))
        self.define_ok_button(self.top.get_widget("ok"), self.save)
        self.define_help_button(self.top.get_widget("button134"), 'adv-pers')

        self.given.connect("focus_out_event", self._given_focus_out_event)
        self.top.get_widget("button177").connect("clicked",
                                                 self._edit_name_clicked)

        self.eventbox.connect('button-press-event',
                              self._image_button_press)

        self._add_db_signal('family-rebuild', self.family_change)
        self._add_db_signal('family-delete', self.family_change)
        self._add_db_signal('family-update', self.family_change)
        self._add_db_signal('family-add', self.family_change)

    def family_change(self, handle_list):
        flist = self.obj.get_family_handle_list() + self.obj.get_parent_family_handle_list()
        for handle in handle_list:
            if handle in flist:
                self._update_families()
                return

    def _update_families(self):
        phandle = self.obj.get_handle()
        person = self.dbstate.db.get_person_from_handle(phandle)
        self.obj.set_family_handle_list(person.get_family_handle_list())
        self.obj.set_parent_family_handle_list(person.get_parent_family_handle_list())
        self.person_ref_list.data = self.obj.get_person_ref_list()
        self.person_ref_list.rebuild()

    def _setup_fields(self):
        """
        Connects the GrampsWidget objects to field in the interface. This
        allows the widgets to keep the data in the attached Person object
        up to date at all times, eliminating a lot of need in 'save' routine.
        """

        self.private = GrampsWidgets.PrivacyButton(
            self.top.get_widget('private'), 
            self.obj, 
            self.db.readonly)

        self.gender = GrampsWidgets.MonitoredMenu(
            self.top.get_widget('gender'), 
            self.obj.set_gender, 
            self.obj.get_gender, 
            (
            (_('female'), RelLib.Person.FEMALE), 
            (_('male'), RelLib.Person.MALE), 
            (_('unknown'), RelLib.Person.UNKNOWN)
            ), 
            self.db.readonly)

        self.marker = GrampsWidgets.MonitoredDataType(
            self.top.get_widget('marker'), 
            self.obj.set_marker, 
            self.obj.get_marker, 
            self.db.readonly,
            self.db.get_marker_types(),
            )
        
        self.ntype_field = GrampsWidgets.MonitoredDataType(
            self.top.get_widget("ntype"), 
            self.pname.set_type, 
            self.pname.get_type,
            self.db.readonly,
            self.db.get_name_types())

        if self.use_patronymic:
            self.prefix = GrampsWidgets.MonitoredEntry(
                self.top.get_widget("prefix"), 
                self.pname.set_patronymic, 
                self.pname.get_patronymic, 
                self.db.readonly)
            
            prefix_label = self.top.get_widget('prefix_label')
            prefix_label.set_text(_('Patronymic:'))
            prefix_label.set_use_underline(True)
        else:
            self.prefix = GrampsWidgets.MonitoredEntry(
                self.top.get_widget("prefix"), 
                self.pname.set_surname_prefix, 
                self.pname.get_surname_prefix, 
                self.db.readonly)

        self.suffix = GrampsWidgets.MonitoredEntry(
            self.top.get_widget("suffix"), 
            self.pname.set_suffix, 
            self.pname.get_suffix, 
            self.db.readonly)

        self.call = GrampsWidgets.MonitoredEntry(
            self.top.get_widget("call"), 
            self.pname.set_call_name, 
            self.pname.get_call_name, 
            self.db.readonly)

        self.given = GrampsWidgets.MonitoredEntry(
            self.top.get_widget("given_name"), 
            self.pname.set_first_name, 
            self.pname.get_first_name, 
            self.db.readonly)

        self.title = GrampsWidgets.MonitoredEntry(
            self.top.get_widget("title"), 
            self.pname.set_title, 
            self.pname.get_title, 
            self.db.readonly)
        
        self.surname_field = GrampsWidgets.MonitoredEntry(
            self.top.get_widget("surname"), 
            self.pname.set_surname, 
            self.pname.get_surname, 
            self.db.readonly, 
            autolist=self.db.get_surname_list())

        self.gid = GrampsWidgets.MonitoredEntry(
            self.top.get_widget("gid"), 
            self.obj.set_gramps_id, 
            self.obj.get_gramps_id, 
            self.db.readonly)

    def _create_tabbed_pages(self):
        """
        Creates the notebook tabs and inserts them into the main
        window.
        
        """
        notebook = gtk.Notebook()

        self.event_list = self._add_tab(
            notebook, 
            PersonEventEmbedList(self.dbstate, self.uistate, 
                                 self.track, self.obj))
        
        self.name_list = self._add_tab(
            notebook, 
            NameEmbedList(self.dbstate, self.uistate, self.track, 
                          self.obj.get_alternate_names(), self.obj,
                          self.name_callback))
        
        self.srcref_list = self._add_tab(
            notebook, 
            SourceEmbedList(self.dbstate,self.uistate,self.track,self.obj))
        
        self.attr_list = self._add_tab(
            notebook, 
            AttrEmbedList(self.dbstate, self.uistate, self.track, 
                          self.obj.get_attribute_list()))
        
        self.addr_list = self._add_tab(
            notebook, 
            AddrEmbedList(self.dbstate, self.uistate, self.track, 
                          self.obj.get_address_list()))
        
        self.note_tab = self._add_tab(
            notebook, 
            NoteTab(self.dbstate, self.uistate, self.track, 
                    self.obj.get_note_list(), self.get_menu_title(),
                    notetype=RelLib.NoteType.PERSON))
        
        self.gallery_tab = self._add_tab(
            notebook, 
            GalleryTab(self.dbstate, self.uistate, self.track, 
                       self.obj.get_media_list(),
                       self.load_person_image))
        
        self.web_list = self._add_tab(
            notebook, 
            WebEmbedList(self.dbstate, self.uistate, self.track, 
                         self.obj.get_url_list()))

        self.person_ref_list = PersonRefEmbedList(self.dbstate, self.uistate, self.track, 
                                                  self.obj.get_person_ref_list())
        self.pref_list = self._add_tab(notebook, self.person_ref_list)
        self.lds_list = self._add_tab(
            notebook, 
            LdsEmbedList(self.dbstate, self.uistate, self.track, 
                         self.obj.get_lds_ord_list()))

        self.backref_tab = self._add_tab(
            notebook,
            PersonBackRefList(self.dbstate, self.uistate, self.track,
                              self.db.find_backlink_handles(self.obj.handle)))

        self._setup_notebook_tabs( notebook)
        notebook.show_all()
        self.top.get_widget('vbox').pack_start(notebook, True)

    def name_callback(self):
        self.pname = self.obj.get_primary_name()

        self.ntype_field.reinit(self.pname.set_type, self.pname.get_type)

        if self.use_patronymic:
            self.prefix.reinit(
                self.pname.set_patronymic,
                self.pname.get_patronymic)
        else:
            self.prefix.reinit(
                self.pname.set_surname_prefix, 
                self.pname.get_surname_prefix)

        self.suffix.reinit(
            self.pname.set_suffix, 
            self.pname.get_suffix)

        self.call.reinit(
            self.pname.set_call_name, 
            self.pname.get_call_name)

        self.given.reinit(
            self.pname.set_first_name, 
            self.pname.get_first_name)

        self.title.reinit(
            self.pname.set_title, 
            self.pname.get_title)
        
        self.surname_field.reinit(
            self.pname.set_surname, 
            self.pname.get_surname)

    def build_menu_names(self, person):
        """
        Provides the information need by the base class to define the
        window management menu entries.
        """
        return (_('Edit Person'), self.get_menu_title())

    def _image_callback(self, ref, obj):
        """
        Called when a media reference had been edited. This allows fot
        the updating image on the main form which has just been modified. 
        """
        self.load_photo(obj.get_path())
        self.gallery_tab.edit_callback(ref, obj)

    def _image_button_press(self, obj, event):
        """
        Button press event that is caught when a button has been
        pressed while on the image on the main form. This does not apply
        to the images in galleries, just the image on the main form.
        """
        if event.type == gtk.gdk._2BUTTON_PRESS and event.button == 1:

            media_list = self.obj.get_media_list()
            if media_list:
                from Editors import EditMediaRef
                
                media_ref = media_list[0]
                object_handle = media_ref.get_reference_handle()
                media_obj = self.db.get_object_from_handle(object_handle)

                try:
                    EditMediaRef(self.dbstate, self.uistate, self.track, 
                                 media_obj, media_ref, self._image_callback)
                except Errors.WindowActiveError, msg:
                    pass

        elif event.type == gtk.gdk.BUTTON_PRESS and event.button == 3:
            media_list = self.obj.get_media_list()
            if media_list:
                photo = media_list[0]
                self._show_popup(photo, event)

    def _show_popup(self, photo, event):
        """
        Look for right-clicks on a picture and create a popup
        menu of the available actions.
        """
        
        menu = gtk.Menu()
        menu.set_title(_("Media Object"))
        obj = self.db.get_object_from_handle(photo.get_reference_handle())
        mtype = obj.get_mime_type()
        progname = Mime.get_application(mtype)
        
        if progname and len(progname) > 1:
            Utils.add_menuitem(menu, _("Open in %s") % progname[1], 
                               photo, self._popup_view_photo)
        Utils.add_menuitem(menu, _("Edit Object Properties"), photo, 
                           self._popup_change_description)
        menu.popup(None, None, None, event.button, event.time)

    def _popup_view_photo(self, obj):
        """
        Open this picture in the default picture viewer
        """
        media_list = self.obj.get_media_list()
        if media_list:
            photo = media_list[0]
            object_handle = photo.get_reference_handle()
            Utils.view_photo(self.db.get_object_from_handle(object_handle))

    def _popup_change_description(self, obj):
        """
        Brings up the EditMediaRef dialog for the image on the main form.
        """
        media_list = self.obj.get_media_list()
        if media_list:
            from Editors import EditMediaRef
            
            media_ref = media_list[0]
            object_handle = media_ref.get_reference_handle()
            media_obj = self.db.get_object_from_handle(object_handle)
            EditMediaRef(self.dbstate, self.uistate, self.track, 
                         media_obj, media_ref, self._image_callback)

    def _given_focus_out_event (self, entry, event):
        """
        Callback that occurs when the user leaves the given name field,
        allowing us to attempt to guess the gender of the person if
        so requested.
        """
        if not self.should_guess_gender:
            return False
        try:
            gender_type = self.db.genderStats.guess_gender(
                unicode(entry.get_text()))
            self.gender.force(gender_type)
        except:
            return False
        return False

    def load_photo(self, path):
        """loads, scales, and displays the person's main photo from the path"""
        self.load_obj = path
        if path == None:
            self.obj_photo.hide()
        else:
            try:
                i = gtk.gdk.pixbuf_new_from_file(path)
                ratio = float(max(i.get_height(), i.get_width()))
                scale = float(100.0)/ratio
                x = int(scale*(i.get_width()))
                y = int(scale*(i.get_height()))
                i = i.scale_simple(x, y, gtk.gdk.INTERP_BILINEAR)
                self.obj_photo.set_from_pixbuf(i)
                self.obj_photo.show()
            except:
                self.obj_photo.hide()

    def _check_for_unknown_gender(self):
        if self.obj.get_gender() == RelLib.Person.UNKNOWN:
	    d = GenderDialog(self.window)
	    gender = d.run()
	    d.destroy()
	    if gender >= 0:
		self.obj.set_gender(gender)
        
    def _check_and_update_id(self):
        original = self.db.get_person_from_handle(self.obj.get_handle())
        
        if original and original.get_gramps_id() != self.obj.get_gramps_id():
            idval = self.obj.get_gramps_id()
            person = self.db.get_person_from_gramps_id(idval)
            if person:
                name = self.nd.display(person)
                msg1 = _("GRAMPS ID value was not changed.")
                msg2 = _("You have attempted to change the GRAMPS ID "
                         "to a value of %(grampsid)s. This value is "
                         "already used by %(person)s.") % {
                    'grampsid' : idval, 
                    'person' : name }
                WarningDialog(msg1, msg2)

    def _update_family_ids(self, trans):
        # Update each of the families child lists to reflect any
        # change in ordering due to the new birth date
        family = self.obj.get_main_parents_family_handle()
        if (family):
            f = self.db.find_family_from_handle(family, trans)
            new_order = self.reorder_child_ref_list(self.obj,
                                                f.get_child_ref_list())
            f.set_child_ref_list(new_order)
        for family in self.obj.get_parent_family_handle_list():
            f = self.db.find_family_from_handle(family, trans)
            new_order = self.reorder_child_ref_list(self.obj,
                                                f.get_child_ref_list())
            f.set_child_ref_list(new_order)

        error = False
        original = self.db.get_person_from_handle(self.obj.handle)

        if original:
            (female, male, unknown) = _select_gender[self.obj.get_gender()]
            if male and original.get_gender() != RelLib.Person.MALE:
                for tmp_handle in self.obj.get_family_handle_list():
                    temp_family = self.db.get_family_from_handle(tmp_handle)
                    if self.obj == temp_family.get_mother_handle():
                        if temp_family.get_father_handle() != None:
                            error = True
                        else:
                            temp_family.set_mother_handle(None)
                            temp_family.set_father_handle(self.obj)
            elif female and original != RelLib.Person.FEMALE:
                for tmp_handle in self.obj.get_family_handle_list():
                    temp_family = self.db.get_family_from_handle(tmp_handle)
                    if self.obj == temp_family.get_father_handle():
                        if temp_family.get_mother_handle() != None:
                            error = True
                        else:
                            temp_family.set_father_handle(None)
                            temp_family.set_mother_handle(self.obj)
            elif unknown and original.get_gender() != RelLib.Person.UNKNOWN:
                for tmp_handle in self.obj.get_family_handle_list():
                    temp_family = self.db.get_family_from_handle(tmp_handle)
                    if self.obj == temp_family.get_father_handle():
                        if temp_family.get_mother_handle() != None:
                            error = True
                        else:
                            temp_family.set_father_handle(None)
                            temp_family.set_mother_handle(self.obj)
                    if self.obj == temp_family.get_mother_handle():
                        if temp_family.get_father_handle() != None:
                            error = True
                        else:
                            temp_family.set_mother_handle(None)
                            temp_family.set_father_handle(self.obj)

            if error:
                msg2 = _("Problem changing the gender")
                msg = _("Changing the gender caused problems "
                        "with marriage information.\nPlease check "
                        "the person's marriages.")
                ErrorDialog(msg2, msg)

    def save(self, obj):
        """
        Save the data.
        """

        self.ok_button.set_sensitive(False)
        if self.object_is_empty():
            ErrorDialog(_("Cannot save person"), 
                        _("No data exists for this person. Please "
                          "enter data or cancel the edit."))
            self.ok_button.set_sensitive(True)
            return
        
        self._check_for_unknown_gender()

        set_birth_death_index(self.db, self.obj)
        self.window.hide()

        trans = self.db.transaction_begin()

        self._check_and_update_id()
        self._update_family_ids(trans)

        if not self.obj.get_handle():
            self.db.add_person(self.obj, trans)
        else:
            if not self.obj.get_gramps_id():
                self.obj.set_gramps_id(self.db.find_next_person_gramps_id())
            self.db.commit_person(self.obj, trans)

        msg = _("Edit Person (%s)") % self.nd.display(self.obj)
        self.db.transaction_commit(trans, msg)
        self.close()
        if self.callback:
            self.callback(self.obj)

    def _edit_name_clicked(self, obj):
        """
        Called when the edit name button is clicked for the primary name
        on the main form (not in the names tab). Brings up the EditName
        dialog for this name.
        """
        from Editors import EditName
        EditName(self.dbstate, self.uistate, self.track, 
                 self.pname, self._update_name)

    def _update_name(self, name):
        """
        Called when the primary name has been changed by the EditName
        dialog. This allows us to update the main form in response to
        any changes.
        """
        for obj in (self.suffix, self.prefix, self.given, self.title, 
                    self.ntype_field, self.surname_field, self.call):
            obj.update()

    def load_person_image(self):
        """
        Loads the primary image into the main form if it exists.
        """
        media_list = self.obj.get_media_list()
        if media_list:
            photo = media_list[0]
            object_handle = photo.get_reference_handle()
            obj = self.db.get_object_from_handle(object_handle)
            if self.load_obj != obj.get_path():
                mime_type = obj.get_mime_type()
                if mime_type and mime_type.startswith("image"):
                    self.load_photo(obj.get_path())
                else:
                    self.load_photo(None)
        else:
            self.load_photo(None)

    def birth_dates_in_order(self, child_ref_list):
        """Check any *valid* birthdates in the list to insure that they are in
        numerically increasing order."""
        inorder = True
        prev_date = 0
        handle_list = [ref.ref for ref in child_ref_list]
        for i in range(len(handle_list)):
            child_handle = handle_list[i]
            child = self.db.get_person_from_handle(child_handle)
            if child.get_birth_ref():
                event_handle = child.get_birth_ref().ref
                event = self.db.get_event_from_handle(event_handle)
                child_date = event.get_date_object().get_sort_value()
            else:
                continue
            if (prev_date <= child_date):   # <= allows for twins
                prev_date = child_date
            else:
                inorder = False
        return inorder

    def reorder_child_ref_list(self, person, child_ref_list):
        """Reorder the child list to put the specified person in his/her
        correct birth order.  Only check *valid* birthdates.  Move the person
        as short a distance as possible."""

        if self.birth_dates_in_order(child_ref_list):
            return(child_ref_list)

        # Build the person's date string once
        event_ref = person.get_birth_ref()
        if event_ref:
            event = self.db.get_event_from_handle(event_ref.ref)
            person_bday = event.get_date_object().get_sort_value()
        else:
            person_bday = 0

        # First, see if the person needs to be moved forward in the list
        handle_list = [ref.ref for ref in child_ref_list]

        index = handle_list.index(person.get_handle())
        target = index
        for i in range(index-1, -1, -1):
            other = self.db.get_person_from_handle(handle_list[i])
            event_ref = other.get_birth_ref()
            if event_ref:
                event = self.db.get_event_from_handle(event_ref.ref)
                other_bday = event.get_date_object().get_sort_value()
                if other_bday == 0:
                    continue;
                if person_bday < other_bday:
                    target = i
            else:
                continue

        # Now try moving to a later position in the list
        if (target == index):
            for i in range(index, len(handle_list)):
                other = self.db.get_person_from_handle(handle_list[i])
                event_ref = other.get_birth_ref()
                if event_ref:
                    event = self.db.get_event_from_handle(event_ref.ref)
                    other_bday = event.get_date_object().get_sort_value()
                    if other_bday == "99999999":
                        continue;
                    if person_bday > other_bday:
                        target = i
                else:
                    continue

        # Actually need to move?  Do it now.
        if (target != index):
            ref = child_ref_list.pop(index)
            child_ref_list.insert(target, ref)
        return child_ref_list

    def _cleanup_on_exit(self):
        (width, height) = self.window.get_size()
        Config.set(Config.PERSON_WIDTH, width)
        Config.set(Config.PERSON_HEIGHT, height)
        Config.sync()


class GenderDialog(gtk.MessageDialog):
    def __init__(self,parent=None):
        gtk.MessageDialog.__init__(self,
				   parent, 
				   flags=gtk.DIALOG_MODAL,
				   type=gtk.MESSAGE_QUESTION,
				   )
        self.set_icon(ICON)
        self.set_title('')

	self.set_markup('<span size="larger" weight="bold">%s</span>' % 
			_('Unknown gender specified'))
	self.format_secondary_text(
	    _("The gender of the person is currently unknown. "
	      "Usually, this is a mistake. Please specify the gender."))

	self.add_button(_('Male'), RelLib.Person.MALE)
	self.add_button(_('Female'), RelLib.Person.FEMALE)
	self.add_button(_('Unknown'), RelLib.Person.UNKNOWN)