gramps/gramps2/src/plugins/EventCmp.py

494 lines
17 KiB
Python
Raw Normal View History

2002-10-20 19:55:16 +05:30
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2006 Donald N. Allingham
2002-10-20 19:55:16 +05:30
#
# 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$
2002-10-20 19:55:16 +05:30
"Analysis and Exploration/Compare individual events"
#------------------------------------------------------------------------
#
# python modules
2002-10-20 19:55:16 +05:30
#
#------------------------------------------------------------------------
import os
from gettext import gettext as _
2002-10-20 19:55:16 +05:30
#------------------------------------------------------------------------
#
# GNOME/GTK modules
#
#------------------------------------------------------------------------
2002-10-20 19:55:16 +05:30
import gtk
import gtk.glade
import GrampsDisplay
2002-10-20 19:55:16 +05:30
#------------------------------------------------------------------------
#
# GRAMPS modules
#
#------------------------------------------------------------------------
import GenericFilter
import ListModel
import Sort
import Utils
import BaseDoc
import OpenSpreadSheet
import const
import DateHandler
from QuestionDialog import WarningDialog
from PluginUtils import Tool, register_tool
2002-10-20 19:55:16 +05:30
#------------------------------------------------------------------------
#
#
#
#------------------------------------------------------------------------
class TableReport:
def __init__(self,filename,doc):
self.filename = filename
self.doc = doc
def initialize(self,cols):
t = BaseDoc.TableStyle()
2002-10-20 19:55:16 +05:30
t.set_columns(cols)
for index in range(0,cols):
t.set_column_width(index,4)
self.doc.add_table_style("mytbl",t)
f = BaseDoc.FontStyle()
f.set_type_face(BaseDoc.FONT_SANS_SERIF)
2002-10-20 19:55:16 +05:30
f.set_size(12)
f.set_bold(1)
p = BaseDoc.ParagraphStyle()
2002-10-20 19:55:16 +05:30
p.set_font(f)
p.set_background_color((0xcc,0xff,0xff))
p.set_padding(0.1)
self.doc.add_style("head",p)
f = BaseDoc.FontStyle()
f.set_type_face(BaseDoc.FONT_SANS_SERIF)
2002-10-20 19:55:16 +05:30
f.set_size(10)
p = BaseDoc.ParagraphStyle()
2002-10-20 19:55:16 +05:30
p.set_font(f)
self.doc.add_style("data",p)
self.doc.open(self.filename)
self.doc.start_page("Page 1","mytbl")
def finalize(self):
self.doc.end_page()
self.doc.close()
def write_table_data(self,data):
self.doc.start_row()
for item in data:
self.doc.start_cell("data")
self.doc.write_text(item)
self.doc.end_cell()
self.doc.end_row()
def set_row(self,val):
self.row = val + 2
def write_table_head(self,data):
self.prev = 3
self.doc.start_row()
for item in data:
self.doc.start_cell("head")
self.doc.write_text(item)
self.doc.end_cell()
self.doc.end_row()
#------------------------------------------------------------------------
#
#
#
#------------------------------------------------------------------------
2005-12-06 12:08:09 +05:30
class EventComparison(Tool.Tool):
def __init__(self,db,person,options_class,name,callback=None,parent=None):
Tool.Tool.__init__(self,db,person,options_class,name)
2002-10-20 19:55:16 +05:30
self.parent = parent
if self.parent.child_windows.has_key(self.__class__):
self.parent.child_windows[self.__class__].present(None)
return
self.win_key = self.__class__
2002-10-20 19:55:16 +05:30
base = os.path.dirname(__file__)
self.glade_file = base + os.sep + "eventcmp.glade"
self.qual = 0
2003-08-17 07:44:33 +05:30
self.filterDialog = gtk.glade.XML(self.glade_file,"filters","gramps")
2002-10-20 19:55:16 +05:30
self.filterDialog.signal_autoconnect({
"on_apply_clicked" : self.on_apply_clicked,
"on_editor_clicked" : self.filter_editor_clicked,
2005-12-06 12:08:09 +05:30
## "on_filter_list_enter" : self.filter_list_enter,
"on_filters_delete_event": self.on_delete_event,
"on_help_clicked" : self.on_help_clicked,
"destroy_passed_object" : self.close
2002-10-20 19:55:16 +05:30
})
self.window = self.filterDialog.get_widget("filters")
self.window.set_icon(self.parent.topWindow.get_icon())
self.filters = self.filterDialog.get_widget("filter_list")
self.label = _('Event comparison filter selection')
2002-10-20 19:55:16 +05:30
Utils.set_titles(self.window,self.filterDialog.get_widget('title'),
self.label)
2002-10-20 19:55:16 +05:30
self.all = GenericFilter.GenericFilter()
self.all.set_name(_("Entire Database"))
self.all.add_rule(GenericFilter.Everyone([]))
self.filter_menu = GenericFilter.build_filter_menu([self.all])
2005-12-06 12:08:09 +05:30
filter_num = self.options.handler.get_filter_number()
self.filter_menu.set_active(filter_num)
self.filter_menu.show()
self.filters.set_menu(self.filter_menu)
self.add_itself_to_menu()
self.window.show()
def on_help_clicked(self,obj):
"""Display the relevant portion of GRAMPS manual"""
GrampsDisplay.help('tools-util')
def on_delete_event(self,obj,b):
self.remove_itself_from_menu()
def close(self,obj):
self.remove_itself_from_menu()
self.window.destroy()
def add_itself_to_menu(self):
self.parent.child_windows[self.win_key] = self
self.parent_menu_item = gtk.MenuItem(_("Event Comparison tool"))
self.parent_menu_item.connect("activate",self.present)
self.parent_menu_item.show()
self.parent.winsmenu.append(self.parent_menu_item)
def remove_itself_from_menu(self):
del self.parent.child_windows[self.win_key]
self.parent_menu_item.destroy()
def present(self,obj):
self.window.present()
2002-10-20 19:55:16 +05:30
def filter_editor_clicked(self,obj):
import FilterEditor
FilterEditor.FilterEditor(const.custom_filters,self.db,self.parent)
2005-12-06 12:08:09 +05:30
## def filter_list_enter(self,obj):
## self.filter_menu = GenericFilter.build_filter_menu([self.all])
## self.filters.set_menu(self.filter_menu)
2002-10-20 19:55:16 +05:30
def on_apply_clicked(self,obj):
cfilter = self.filter_menu.get_active().get_data("filter")
progress_bar = Utils.ProgressMeter(_('Comparing events'),'')
progress_bar.set_pass(_('Selecting people'),1)
plist = cfilter.apply(self.db,
self.db.get_person_handles(sort_handles=False))
progress_bar.step()
progress_bar.close()
2005-12-06 12:08:09 +05:30
self.options.handler.set_filter_number(self.filters.get_history())
# Save options
self.options.handler.save_options()
2002-10-20 19:55:16 +05:30
if len(plist) == 0:
WarningDialog(_("No matches were found"))
2002-10-20 19:55:16 +05:30
else:
DisplayChart(self.db,plist,self.parent)
2002-10-20 19:55:16 +05:30
#-------------------------------------------------------------------------
#
#
#
#-------------------------------------------------------------------------
def by_value(first,second):
return cmp(second[0],first[0])
#-------------------------------------------------------------------------
#
#
#
#-------------------------------------------------------------------------
def fix(line):
l = line.strip().replace('&','&').replace(l,'>','>')
return l.replace(l,'<','&lt;').replace(l,'"','&quot;')
2002-10-20 19:55:16 +05:30
#-------------------------------------------------------------------------
#
#
#
#-------------------------------------------------------------------------
class DisplayChart:
def __init__(self,database,people_list,parent):
self.db = database
2002-10-20 19:55:16 +05:30
self.my_list = people_list
self.row_data = []
self.parent = parent
self.win_key = self
self.save_form = None
2002-10-20 19:55:16 +05:30
base = os.path.dirname(__file__)
self.glade_file = base + os.sep + "eventcmp.glade"
2003-08-17 07:44:33 +05:30
self.topDialog = gtk.glade.XML(self.glade_file,"view","gramps")
2002-10-20 19:55:16 +05:30
self.topDialog.signal_autoconnect({
"on_write_table" : self.on_write_table,
"destroy_passed_object" : self.close,
"on_help_clicked" : self.on_help_clicked,
"on_view_delete_event" : self.on_delete_event,
2002-10-20 19:55:16 +05:30
})
self.window = self.topDialog.get_widget("view")
self.window.set_icon(self.parent.topWindow.get_icon())
self.eventlist = self.topDialog.get_widget('treeview')
Utils.set_titles(self.window, self.topDialog.get_widget('title'),
_('Event Comparison Results'))
2002-10-20 19:55:16 +05:30
self.sort = Sort.Sort(self.db)
self.my_list.sort(self.sort.by_last_name)
2002-10-20 19:55:16 +05:30
self.event_titles = self.make_event_titles()
self.build_row_data()
self.draw_clist_display()
self.add_itself_to_menu()
self.window.show()
def on_help_clicked(self,obj):
"""Display the relevant portion of GRAMPS manual"""
help_display('gramps-manual','tools-ae')
def on_delete_event(self,obj,b):
self.remove_itself_from_menu()
if self.save_form:
self.save_form.destroy()
def close(self,obj):
self.remove_itself_from_menu()
if self.save_form:
self.save_form.destroy()
self.window.destroy()
def add_itself_to_menu(self):
self.parent.child_windows[self.win_key] = self
self.parent_menu_item = gtk.MenuItem(_("Event Comparison Results"))
self.parent_menu_item.connect("activate",self.present)
self.parent_menu_item.show()
self.parent.winsmenu.append(self.parent_menu_item)
def remove_itself_from_menu(self):
del self.parent.child_windows[self.win_key]
self.parent_menu_item.destroy()
def present(self,obj):
self.window.present()
2002-10-20 19:55:16 +05:30
def draw_clist_display(self):
titles = []
index = 0
for event_name in self.event_titles:
# Need to display localized event names
titles.append((const.display_event(event_name),index,150))
index = index + 1
self.list = ListModel.ListModel(self.eventlist,titles)
self.progress_bar.set_pass(_('Building display'),len(self.row_data))
for data in self.row_data:
self.list.add(data)
self.progress_bar.step()
self.progress_bar.close()
2002-10-20 19:55:16 +05:30
def build_row_data(self):
self.progress_bar = Utils.ProgressMeter(_('Comparing events'),'')
self.progress_bar.set_pass(_('Building data'),
self.db.get_number_of_people())
for individual_id in self.my_list:
individual = self.db.get_person_from_handle(individual_id)
name = individual.get_primary_name().get_name()
birth_handle = individual.get_birth_handle()
bdate = ""
bplace = ""
if birth_handle:
birth = self.db.get_event_from_handle(birth_handle)
bdate = DateHandler.get_date(birth)
bplace_handle = birth.get_place_handle()
if bplace_handle:
bplace = self.db.get_place_from_handle(bplace_handle).get_title()
death_handle = individual.get_death_handle()
ddate = ""
dplace = ""
if death_handle:
death = self.db.get_event_from_handle(death_handle)
ddate = DateHandler.get_date(death)
dplace_handle = death.get_place_handle()
if dplace_handle:
dplace = self.db.get_place_from_handle(dplace_handle).get_title()
2002-10-20 19:55:16 +05:30
map = {}
elist = individual.get_event_list()[:]
for ievent_handle in elist:
if not ievent_handle:
continue
ievent = self.db.get_event_from_handle(ievent_handle)
event_name = ievent.get_name()
2002-10-20 19:55:16 +05:30
if map.has_key(event_name):
map[event_name].append(ievent_handle)
2002-10-20 19:55:16 +05:30
else:
map[event_name] = [ievent_handle]
2002-10-20 19:55:16 +05:30
first = 1
done = 0
while done == 0:
added = 0
if first:
tlist = [name,"%s\n%s" % (bdate,bplace),
"%s\n%s" % (ddate,dplace)]
2002-10-20 19:55:16 +05:30
else:
tlist = ["","",""]
for ename in self.event_titles[3:]:
if map.has_key(ename) and len(map[ename]) > 0:
event_handle = map[ename][0]
2002-10-20 19:55:16 +05:30
del map[ename][0]
date = ""
place = ""
if event_handle:
event = self.db.get_event_from_handle(event_handle)
date = DateHandler.get_date(event)
place_handle = event.get_place_handle()
if place_handle:
place = self.db.get_place_from_handle(place_handle).get_title()
tlist.append("%s\n%s" % (date, place))
2002-10-20 19:55:16 +05:30
added = 1
else:
tlist.append("")
if first:
first = 0
self.row_data.append(tlist)
2002-10-20 19:55:16 +05:30
elif added == 0:
done = 1
else:
self.row_data.append(tlist)
self.progress_bar.step()
2002-10-20 19:55:16 +05:30
def make_event_titles(self):
"""Creates the list of unique event types, along with the person's
name, birth, and death. This should be the column titles of the report"""
map = {}
for individual_id in self.my_list:
individual = self.db.get_person_from_handle(individual_id)
elist = individual.get_event_list()
for event_handle in elist:
if not event_handle:
continue
event = self.db.get_event_from_handle(event_handle)
name = event.get_name()
2002-10-20 19:55:16 +05:30
if not name:
break
if map.has_key(name):
map[name] = map[name] + 1
else:
map[name] = 1
unsort_list = [ (map[item],item) for item in map.keys() ]
2002-10-20 19:55:16 +05:30
unsort_list.sort(by_value)
sort_list = [ item[1] for item in unsort_list ]
2002-10-20 19:55:16 +05:30
return [_("Person"),_("Birth"),_("Death")] + sort_list
def on_write_table(self,obj):
2003-08-17 07:44:33 +05:30
self.form = gtk.glade.XML(self.glade_file,"dialog1","gramps")
2002-10-20 19:55:16 +05:30
self.form.signal_autoconnect({
"on_save_clicked" : self.on_save_clicked,
"destroy_passed_object" : Utils.destroy_passed_object
})
self.save_form = self.form.get_widget("dialog1")
self.save_form.show_all()
2002-10-20 19:55:16 +05:30
def on_save_clicked(self,obj):
name = unicode(self.form.get_widget("filename").get_text())
2002-10-20 19:55:16 +05:30
pstyle = BaseDoc.PaperStyle("junk",10,10)
doc = OpenSpreadSheet.OpenSpreadSheet(pstyle,BaseDoc.PAPER_PORTRAIT)
doc.creator(self.db.get_researcher().get_name())
2002-10-20 19:55:16 +05:30
spreadsheet = TableReport(name,doc)
spreadsheet.initialize(len(self.event_titles))
spreadsheet.write_table_head([const.display_event(event_name)
for event_name in self.event_titles])
2002-10-20 19:55:16 +05:30
index = 0
for top in self.row_data:
2002-10-20 19:55:16 +05:30
spreadsheet.set_row(index%2)
index = index + 1
spreadsheet.write_table_data(top)
spreadsheet.finalize()
Utils.destroy_passed_object(obj)
2005-12-06 12:08:09 +05:30
#------------------------------------------------------------------------
#
#
#
#------------------------------------------------------------------------
class EventComparisonOptions(Tool.ToolOptions):
"""
Defines options and provides handling interface.
"""
def __init__(self,name,person_id=None):
Tool.ToolOptions.__init__(self,name,person_id)
def enable_options(self):
# Semi-common options that should be enabled for this report
self.enable_dict = {
'filter' : 0,
}
2002-10-20 19:55:16 +05:30
#-------------------------------------------------------------------------
#
#
#
#-------------------------------------------------------------------------
register_tool(
2005-12-06 12:08:09 +05:30
name = 'eventcmp',
category = Tool.TOOL_ANAL,
tool_class = EventComparison,
options_class = EventComparisonOptions,
modes = Tool.MODE_GUI,
translated_name = _("Compare individual events"),
status = _("Stable"),
author_name = "Donald N. Allingham",
author_email = "don@gramps-project.org",
description=_("Aids in the analysis of data by allowing the "
"development of custom filters that can be applied "
"to the database to find similar events")
2002-10-20 19:55:16 +05:30
)