# # Gramps - a GTK+/GNOME based genealogy program # # Copyright (C) 2000-2005 Donald N. Allingham # Copyright (C) 2011 Tim G L Lyons # # 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$ """ Provide merge capabilities for citations. """ #------------------------------------------------------------------------- # # Gramps modules # #------------------------------------------------------------------------- from gen.lib import (Person, Family, Event, Place, MediaObject, Repository) from gen.db import DbTxn from gen.ggettext import sgettext as _ import const import GrampsDisplay import ManagedWindow import DateHandler from Errors import MergeError from Utils import confidence #------------------------------------------------------------------------- # # Gramps constants # #------------------------------------------------------------------------- WIKI_HELP_PAGE = '%s_-_Entering_and_Editing_Data:_Detailed_-_part_3' % \ const.URL_MANUAL_PAGE WIKI_HELP_SEC = _('manual|Merge_Citations') _GLADE_FILE = 'mergecitation.glade' #------------------------------------------------------------------------- # # Merge Citations # #------------------------------------------------------------------------- class MergeCitations(ManagedWindow.ManagedWindow): """ Displays a dialog box that allows the citations to be combined into one. """ def __init__(self, dbstate, uistate, handle1, handle2): ManagedWindow.ManagedWindow.__init__(self, uistate, [], self.__class__) self.dbstate = dbstate database = dbstate.db self.citation1 = database.get_citation_from_handle(handle1) self.citation2 = database.get_citation_from_handle(handle2) self.define_glade('mergecitation', _GLADE_FILE) self.set_window(self._gladeobj.toplevel, self.get_widget('citation_title'), _("Merge Citations")) # Detailed Selection widgets page1 = self.citation1.get_page() page2 = self.citation2.get_page() entry1 = self.get_widget("page1") entry2 = self.get_widget("page2") entry1.set_text(page1) entry2.set_text(page2) if entry1.get_text() == entry2.get_text(): for widget_name in ('page1', 'page2', 'page_btn1', 'page_btn2'): self.get_widget(widget_name).set_sensitive(False) entry1 = self.get_widget("date1") entry2 = self.get_widget("date2") entry1.set_text(DateHandler.get_date(self.citation1)) entry2.set_text(DateHandler.get_date(self.citation2)) if entry1.get_text() == entry2.get_text(): for widget_name in ('date1', 'date2', 'date_btn1', 'date_btn2'): self.get_widget(widget_name).set_sensitive(False) entry1 = self.get_widget("confidence1") entry2 = self.get_widget("confidence2") entry1.set_text(confidence[self.citation1.get_confidence_level()]) entry2.set_text(confidence[self.citation2.get_confidence_level()]) if entry1.get_text() == entry2.get_text(): for widget_name in ('confidence1', 'confidence2', 'confidence_btn1', 'confidence_btn2'): self.get_widget(widget_name).set_sensitive(False) gramps1 = self.citation1.get_gramps_id() gramps2 = self.citation2.get_gramps_id() entry1 = self.get_widget("gramps1") entry2 = self.get_widget("gramps2") entry1.set_text(gramps1) entry2.set_text(gramps2) if entry1.get_text() == entry2.get_text(): for widget_name in ('gramps1', 'gramps2', 'gramps_btn1', 'gramps_btn2'): self.get_widget(widget_name).set_sensitive(False) # Main window widgets that determine which handle survives rbutton1 = self.get_widget("handle_btn1") rbutton_label1 = self.get_widget("label_handle_btn1") rbutton_label2 = self.get_widget("label_handle_btn2") rbutton_label1.set_label(page1 + " [" + gramps1 + "]") rbutton_label2.set_label(page2 + " [" + gramps2 + "]") rbutton1.connect("toggled", self.on_handle1_toggled) self.connect_button('citation_help', self.cb_help) self.connect_button('citation_ok', self.cb_merge) self.connect_button('citation_cancel', self.close) self.show() def on_handle1_toggled(self, obj): """first chosen citation changes""" if obj.get_active(): self.get_widget("page_btn1").set_active(True) self.get_widget("date_btn1").set_active(True) self.get_widget("confidence_btn1").set_active(True) self.get_widget("gramps_btn1").set_active(True) else: self.get_widget("page_btn2").set_active(True) self.get_widget("date_btn2").set_active(True) self.get_widget("confidence_btn2").set_active(True) self.get_widget("gramps_btn2").set_active(True) def cb_help(self, obj): """Display the relevant portion of Gramps manual""" GrampsDisplay.help(webpage = WIKI_HELP_PAGE, section = WIKI_HELP_SEC) def cb_merge(self, obj): """ Performs the merge of the citations when the merge button is clicked. """ self.uistate.set_busy_cursor(True) use_handle1 = self.get_widget("handle_btn1").get_active() if use_handle1: phoenix = self.citation1 titanic = self.citation2 else: phoenix = self.citation2 titanic = self.citation1 # Add second handle to history so that when merge is complete, # phoenix is the selected row. self.uistate.viewmanager.active_page.get_history().push( phoenix.get_handle()) if self.get_widget("page_btn1").get_active() ^ use_handle1: phoenix.set_page(titanic.get_page()) if self.get_widget("date_btn1").get_active() ^ use_handle1: phoenix.set_date_object(titanic.get_date_object()) if self.get_widget("confidence_btn1").get_active() ^ use_handle1: phoenix.set_confidence_level(titanic.get_confidence_level()) if self.get_widget("gramps_btn1").get_active() ^ use_handle1: phoenix.set_gramps_id(titanic.get_gramps_id()) query = MergeCitationQuery(self.dbstate, phoenix, titanic) query.execute() self.uistate.set_busy_cursor(False) self.close() class MergeCitationQuery(object): """ Create database query to merge two citations. """ def __init__(self, dbstate, phoenix, titanic): self.database = dbstate.db self.phoenix = phoenix self.titanic = titanic def execute(self): """ Merges to citations into a single citation. """ new_handle = self.phoenix.get_handle() old_handle = self.titanic.get_handle() self.phoenix.merge(self.titanic) with DbTxn(_("Merge Citation"), self.database) as trans: self.database.commit_citation(self.phoenix, trans) for (class_name, handle) in self.database.find_backlink_handles( old_handle): if class_name == Person.__name__: person = self.database.get_person_from_handle(handle) assert(person.has_citation_reference(old_handle)) person.replace_citation_references(old_handle, new_handle) self.database.commit_person(person, trans) elif class_name == Family.__name__: family = self.database.get_family_from_handle(handle) assert(family.has_citation_reference(old_handle)) family.replace_citation_references(old_handle, new_handle) self.database.commit_family(family, trans) elif class_name == Event.__name__: event = self.database.get_event_from_handle(handle) assert(event.has_citation_reference(old_handle)) event.replace_citation_references(old_handle, new_handle) self.database.commit_event(event, trans) elif class_name == Place.__name__: place = self.database.get_place_from_handle(handle) assert(place.has_citation_reference(old_handle)) place.replace_citation_references(old_handle, new_handle) self.database.commit_place(place, trans) elif class_name == MediaObject.__name__: obj = self.database.get_object_from_handle(handle) assert(obj.has_citation_reference(old_handle)) obj.replace_citation_references(old_handle, new_handle) self.database.commit_media_object(obj, trans) elif class_name == Repository.__name__: repository = self.database.get_repository_from_handle(handle) assert(repository.has_citation_reference(old_handle)) repository.replace_citation_references(old_handle, new_handle) self.database.commit_repository(repository, trans) else: raise MergeError("Encounter an object of type %s that has " "a citation reference." % class_name) self.database.remove_citation(old_handle, trans)