Various enhancements:
* Modified Event object to include references to Citations * Implemented database upgrade for Events (upgrade for Media had already been done) * Enhanced database upgrade to do backlinks * Modified Media object to remove sourceref * Implemented citations bottombar gramplet * Some minor fixes and improvements svn: r18054
This commit is contained in:
Tim G L Lyons
469
src/plugins/gramplet/Citations.py
Normal file
469
src/plugins/gramplet/Citations.py
Normal file
@@ -0,0 +1,469 @@
|
||||
# Gramps - a GTK+/GNOME based genealogy program
|
||||
#
|
||||
# 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$
|
||||
#
|
||||
|
||||
from gui.editors import EditCitation
|
||||
from ListModel import ListModel, NOSORT
|
||||
from gen.plug import Gramplet
|
||||
from gen.ggettext import gettext as _
|
||||
import Errors
|
||||
import gtk
|
||||
|
||||
class Citations(Gramplet):
|
||||
"""
|
||||
Displays the citations for an object.
|
||||
"""
|
||||
def init(self):
|
||||
self.gui.WIDGET = self.build_gui()
|
||||
self.gui.get_container_widget().remove(self.gui.textview)
|
||||
self.gui.get_container_widget().add_with_viewport(self.gui.WIDGET)
|
||||
self.gui.WIDGET.show()
|
||||
|
||||
def build_gui(self):
|
||||
"""
|
||||
Build the GUI interface.
|
||||
"""
|
||||
tip = _('Double-click on a row to edit the selected citation.')
|
||||
self.set_tooltip(tip)
|
||||
top = gtk.TreeView()
|
||||
titles = [('', NOSORT, 50,),
|
||||
(_('Source'), 1, 200),
|
||||
(_('Reference'), 2, 300),
|
||||
(_('Author'), 3, 100)]
|
||||
self.model = ListModel(top, titles, event_func=self.edit_citation)
|
||||
return top
|
||||
|
||||
def add_citations(self, obj):
|
||||
for citation_handle in obj.get_citation_references():
|
||||
self.add_citation_ref(citation_handle)
|
||||
|
||||
def add_name_citations(self, obj):
|
||||
names = [obj.get_primary_name()] + obj.get_alternate_names()
|
||||
for name in names:
|
||||
self.add_citations(name)
|
||||
|
||||
def add_attribute_citations(self, obj):
|
||||
for attr in obj.get_attribute_list():
|
||||
self.add_citations(attr)
|
||||
|
||||
def add_mediaref_citations(self, obj):
|
||||
for media_ref in obj.get_media_list():
|
||||
self.add_citations(media_ref)
|
||||
self.add_attribute_citations(media_ref)
|
||||
media = self.dbstate.db.get_object_from_handle(media_ref.ref)
|
||||
self.add_media_citations(media)
|
||||
|
||||
def add_media_citations(self, media):
|
||||
self.add_citations(media)
|
||||
self.add_attribute_citations(media)
|
||||
|
||||
def add_eventref_citations(self, obj):
|
||||
for event_ref in obj.get_event_ref_list():
|
||||
self.add_attribute_citations(event_ref)
|
||||
event = self.dbstate.db.get_event_from_handle(event_ref.ref)
|
||||
self.add_event_citations(event)
|
||||
|
||||
def add_event_citations(self, event):
|
||||
self.add_citations(event)
|
||||
self.add_attribute_citations(event)
|
||||
self.add_mediaref_citations(event)
|
||||
place_handle = event.get_place_handle()
|
||||
place = self.dbstate.db.get_place_from_handle(place_handle)
|
||||
if place:
|
||||
self.add_place_citations(place)
|
||||
|
||||
def add_place_citations(self, place):
|
||||
self.add_citations(place)
|
||||
self.add_mediaref_citations(place)
|
||||
|
||||
def add_address_citations(self, obj):
|
||||
for address in obj.get_address_list():
|
||||
self.add_citations(address)
|
||||
|
||||
def add_lds_citations(self, obj):
|
||||
for lds in obj.get_lds_ord_list():
|
||||
self.add_citations(lds)
|
||||
place_handle = lds.get_place_handle()
|
||||
place = self.dbstate.db.get_place_from_handle(place_handle)
|
||||
if place:
|
||||
self.add_place_citations(place)
|
||||
|
||||
def add_association_citations(self, obj):
|
||||
for assoc in obj.get_person_ref_list():
|
||||
self.add_citations(assoc)
|
||||
|
||||
def add_citation_ref(self, citation_handle):
|
||||
"""
|
||||
Add a citation to the model.
|
||||
"""
|
||||
citation = self.dbstate.db.get_citation_from_handle(citation_handle)
|
||||
page = citation.get_page()
|
||||
source = self.dbstate.db.get_source_from_handle(citation.ref)
|
||||
title = source.get_title()
|
||||
author = source.get_author()
|
||||
self.model.add((citation_handle, title, page, author))
|
||||
|
||||
def check_citations(self, obj):
|
||||
return True if obj.get_citation_references() else False
|
||||
|
||||
def check_name_citations(self, obj):
|
||||
names = [obj.get_primary_name()] + obj.get_alternate_names()
|
||||
for name in names:
|
||||
if self.check_citations(name):
|
||||
return True
|
||||
return False
|
||||
|
||||
def check_attribute_citations(self, obj):
|
||||
for attr in obj.get_attribute_list():
|
||||
if self.check_citations(attr):
|
||||
return True
|
||||
return False
|
||||
|
||||
def check_mediaref_citations(self, obj):
|
||||
for media_ref in obj.get_media_list():
|
||||
if self.check_citations(media_ref):
|
||||
return True
|
||||
if self.check_attribute_citations(media_ref):
|
||||
return True
|
||||
media = self.dbstate.db.get_object_from_handle(media_ref.ref)
|
||||
if self.check_media_citations(media):
|
||||
return True
|
||||
return False
|
||||
|
||||
def check_media_citations(self, media):
|
||||
if self.check_citations(media):
|
||||
return True
|
||||
if self.check_attribute_citations(media):
|
||||
return True
|
||||
return False
|
||||
|
||||
def check_eventref_citations(self, obj):
|
||||
for event_ref in obj.get_event_ref_list():
|
||||
if self.check_attribute_citations(event_ref):
|
||||
return True
|
||||
event = self.dbstate.db.get_event_from_handle(event_ref.ref)
|
||||
if self.check_event_citations(event):
|
||||
return True
|
||||
return False
|
||||
|
||||
def check_event_citations(self, event):
|
||||
if self.check_citations(event):
|
||||
return True
|
||||
if self.check_attribute_citations(event):
|
||||
return True
|
||||
if self.check_mediaref_citations(event):
|
||||
return True
|
||||
place_handle = event.get_place_handle()
|
||||
place = self.dbstate.db.get_place_from_handle(place_handle)
|
||||
if place and self.check_place_citations(place):
|
||||
return True
|
||||
return False
|
||||
|
||||
def check_place_citations(self, place):
|
||||
if self.check_citations(place):
|
||||
return True
|
||||
if self.check_mediaref_citations(place):
|
||||
return True
|
||||
return False
|
||||
|
||||
def check_address_citations(self, obj):
|
||||
for address in obj.get_address_list():
|
||||
if self.check_citations(address):
|
||||
return True
|
||||
return False
|
||||
|
||||
def check_lds_citations(self, obj):
|
||||
for lds in obj.get_lds_ord_list():
|
||||
if self.check_citations(lds):
|
||||
return True
|
||||
place_handle = lds.get_place_handle()
|
||||
place = self.dbstate.db.get_place_from_handle(place_handle)
|
||||
if place and self.check_place_citations(place):
|
||||
return True
|
||||
return False
|
||||
|
||||
def check_association_citations(self, obj):
|
||||
for assoc in obj.get_person_ref_list():
|
||||
if self.check_citations(assoc):
|
||||
return True
|
||||
return False
|
||||
|
||||
def edit_citation(self, treeview):
|
||||
"""
|
||||
Edit the selected citation.
|
||||
"""
|
||||
model, iter_ = treeview.get_selection().get_selected()
|
||||
if iter_:
|
||||
handle = model.get_value(iter_, 0)
|
||||
try:
|
||||
citation = self.dbstate.db.get_citation_from_handle(handle)
|
||||
source = self.dbstate.db.get_source_from_handle(citation.ref)
|
||||
EditCitation(self.dbstate, self.uistate, [], citation, source)
|
||||
except Errors.WindowActiveError:
|
||||
pass
|
||||
|
||||
class PersonCitations(Citations):
|
||||
"""
|
||||
Displays the citations for a person.
|
||||
"""
|
||||
def db_changed(self):
|
||||
self.dbstate.db.connect('person-update', self.update)
|
||||
self.update()
|
||||
|
||||
def active_changed(self, handle):
|
||||
self.update()
|
||||
|
||||
def update_has_data(self):
|
||||
active_handle = self.get_active('Person')
|
||||
active = self.dbstate.db.get_person_from_handle(active_handle)
|
||||
self.set_has_data(self.get_has_data(active))
|
||||
|
||||
def main(self):
|
||||
active_handle = self.get_active('Person')
|
||||
active = self.dbstate.db.get_person_from_handle(active_handle)
|
||||
|
||||
self.model.clear()
|
||||
if active:
|
||||
self.display_citations(active)
|
||||
else:
|
||||
self.set_has_data(False)
|
||||
|
||||
def display_citations(self, person):
|
||||
"""
|
||||
Display the citations for the active person.
|
||||
"""
|
||||
self.add_citations(person)
|
||||
self.add_eventref_citations(person)
|
||||
for handle in person.get_family_handle_list():
|
||||
family = self.dbstate.db.get_family_from_handle(handle)
|
||||
self.add_eventref_citations(family)
|
||||
self.add_name_citations(person)
|
||||
self.add_attribute_citations(person)
|
||||
self.add_address_citations(person)
|
||||
self.add_mediaref_citations(person)
|
||||
self.add_association_citations(person)
|
||||
self.add_lds_citations(person)
|
||||
|
||||
self.set_has_data(self.model.count > 0)
|
||||
|
||||
def get_has_data(self, person):
|
||||
"""
|
||||
Return True if the gramplet has data, else return False.
|
||||
"""
|
||||
if person is None:
|
||||
return False
|
||||
if self.check_citations(person):
|
||||
return True
|
||||
if self.check_eventref_citations(person):
|
||||
return True
|
||||
for handle in person.get_family_handle_list():
|
||||
family = self.dbstate.db.get_family_from_handle(handle)
|
||||
if self.check_eventref_citations(family):
|
||||
return True
|
||||
if self.check_name_citations(person):
|
||||
return True
|
||||
if self.check_attribute_citations(person):
|
||||
return True
|
||||
if self.check_address_citations(person):
|
||||
return True
|
||||
if self.check_mediaref_citations(person):
|
||||
return True
|
||||
if self.check_association_citations(person):
|
||||
return True
|
||||
if self.check_lds_citations(person):
|
||||
return True
|
||||
return False
|
||||
|
||||
class EventCitations(Citations):
|
||||
"""
|
||||
Displays the citations for an event.
|
||||
"""
|
||||
def db_changed(self):
|
||||
self.dbstate.db.connect('event-update', self.update)
|
||||
self.connect_signal('Event', self.update)
|
||||
self.update()
|
||||
|
||||
def update_has_data(self):
|
||||
active_handle = self.get_active('Event')
|
||||
active = self.dbstate.db.get_event_from_handle(active_handle)
|
||||
self.set_has_data(self.get_has_data(active))
|
||||
|
||||
def main(self):
|
||||
active_handle = self.get_active('Event')
|
||||
active = self.dbstate.db.get_event_from_handle(active_handle)
|
||||
|
||||
self.model.clear()
|
||||
if active:
|
||||
self.display_citations(active)
|
||||
else:
|
||||
self.set_has_data(False)
|
||||
|
||||
def display_citations(self, event):
|
||||
"""
|
||||
Display the citations for the active event.
|
||||
"""
|
||||
self.add_event_citations(event)
|
||||
self.set_has_data(self.model.count > 0)
|
||||
|
||||
def get_has_data(self, event):
|
||||
"""
|
||||
Return True if the gramplet has data, else return False.
|
||||
"""
|
||||
if event is None:
|
||||
return False
|
||||
if self.check_event_citations(event):
|
||||
return True
|
||||
return False
|
||||
|
||||
class FamilyCitations(Citations):
|
||||
"""
|
||||
Displays the citations for a family.
|
||||
"""
|
||||
def db_changed(self):
|
||||
self.dbstate.db.connect('family-update', self.update)
|
||||
self.connect_signal('Family', self.update)
|
||||
self.update()
|
||||
|
||||
def update_has_data(self):
|
||||
active_handle = self.get_active('Family')
|
||||
active = self.dbstate.db.get_family_from_handle(active_handle)
|
||||
self.set_has_data(self.get_has_data(active))
|
||||
|
||||
def main(self):
|
||||
active_handle = self.get_active('Family')
|
||||
active = self.dbstate.db.get_family_from_handle(active_handle)
|
||||
|
||||
self.model.clear()
|
||||
if active:
|
||||
self.display_citations(active)
|
||||
else:
|
||||
self.set_has_data(False)
|
||||
|
||||
def display_citations(self, family):
|
||||
"""
|
||||
Display the citations for the active family.
|
||||
"""
|
||||
self.add_citations(family)
|
||||
self.add_eventref_citations(family)
|
||||
self.add_attribute_citations(family)
|
||||
self.add_mediaref_citations(family)
|
||||
self.add_lds_citations(family)
|
||||
|
||||
self.set_has_data(self.model.count > 0)
|
||||
|
||||
def get_has_data(self, family):
|
||||
"""
|
||||
Return True if the gramplet has data, else return False.
|
||||
"""
|
||||
if family is None:
|
||||
return False
|
||||
if self.check_citations(family):
|
||||
return True
|
||||
if self.check_eventref_citations(family):
|
||||
return True
|
||||
if self.check_attribute_citations(family):
|
||||
return True
|
||||
if self.check_mediaref_citations(family):
|
||||
return True
|
||||
if self.check_lds_citations(family):
|
||||
return True
|
||||
return False
|
||||
|
||||
class PlaceCitations(Citations):
|
||||
"""
|
||||
Displays the citations for a place.
|
||||
"""
|
||||
def db_changed(self):
|
||||
self.dbstate.db.connect('place-update', self.update)
|
||||
self.connect_signal('Place', self.update)
|
||||
self.update()
|
||||
|
||||
def update_has_data(self):
|
||||
active_handle = self.get_active('Place')
|
||||
active = self.dbstate.db.get_place_from_handle(active_handle)
|
||||
self.set_has_data(self.get_has_data(active))
|
||||
|
||||
def main(self):
|
||||
active_handle = self.get_active('Place')
|
||||
active = self.dbstate.db.get_place_from_handle(active_handle)
|
||||
|
||||
self.model.clear()
|
||||
if active:
|
||||
self.display_citations(active)
|
||||
else:
|
||||
self.set_has_data(False)
|
||||
|
||||
def display_citations(self, place):
|
||||
"""
|
||||
Display the citations for the active place.
|
||||
"""
|
||||
self.add_place_citations(place)
|
||||
self.set_has_data(self.model.count > 0)
|
||||
|
||||
def get_has_data(self, place):
|
||||
"""
|
||||
Return True if the gramplet has data, else return False.
|
||||
"""
|
||||
if place is None:
|
||||
return False
|
||||
if self.check_place_citations(place):
|
||||
return True
|
||||
return False
|
||||
|
||||
class MediaCitations(Citations):
|
||||
"""
|
||||
Displays the citations for a media object.
|
||||
"""
|
||||
def db_changed(self):
|
||||
self.dbstate.db.connect('media-update', self.update)
|
||||
self.connect_signal('Media', self.update)
|
||||
self.update()
|
||||
|
||||
def update_has_data(self):
|
||||
active_handle = self.get_active('Media')
|
||||
active = self.dbstate.db.get_object_from_handle(active_handle)
|
||||
self.set_has_data(self.get_has_data(active))
|
||||
|
||||
def main(self):
|
||||
active_handle = self.get_active('Media')
|
||||
active = self.dbstate.db.get_object_from_handle(active_handle)
|
||||
|
||||
self.model.clear()
|
||||
if active:
|
||||
self.display_citations(active)
|
||||
else:
|
||||
self.set_has_data(False)
|
||||
|
||||
def display_citations(self, media):
|
||||
"""
|
||||
Display the citations for the active media object.
|
||||
"""
|
||||
self.add_media_citations(media)
|
||||
self.set_has_data(self.model.count > 0)
|
||||
|
||||
def get_has_data(self, media):
|
||||
"""
|
||||
Return True if the gramplet has data, else return False.
|
||||
"""
|
||||
if media is None:
|
||||
return False
|
||||
if self.check_media_citations(media):
|
||||
return True
|
||||
return False
|
||||
Reference in New Issue
Block a user