Initial revision

svn: r3

src/plugins/EventCmp.py

@@ -0,0 +1,698 @@
+#
+# Gramps - a GTK+/GNOME based genealogy program
+#
+# Copyright (C) 2000  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
+#
+
+"Analysis and Exploration/Compare individual events"
+
+#------------------------------------------------------------------------
+#
+# 
+#
+#------------------------------------------------------------------------
+import os
+import re
+import sort
+import utils
+import string
+import OpenOffice
+
+#------------------------------------------------------------------------
+#
+# 
+#
+#------------------------------------------------------------------------
+from gtk import *
+from gnome.ui import *
+from libglade import *
+
+#------------------------------------------------------------------------
+#
+# 
+#
+#------------------------------------------------------------------------
+import ListColors
+import Filter
+import const
+
+#------------------------------------------------------------------------
+#
+# 
+#
+#------------------------------------------------------------------------
+
+OBJECT   = "o"
+INDEX    = "i"
+FUNCTION = "f"
+QUALIFIER= "q"
+FILTER   = "x"
+
+#------------------------------------------------------------------------
+#
+# 
+#
+#------------------------------------------------------------------------
+class TableReport:
+    def __init__(self,filename):
+        self.filename = filename
+
+    def initialize(self):
+        pass
+
+    def finalize(self):
+        pass
+
+    def write_table_head():
+        pass
+
+    def set_row(self,val):
+        pass
+
+    def write_table_data():
+        pass
+
+#------------------------------------------------------------------------
+#
+# 
+#
+#------------------------------------------------------------------------
+class OpenOfficeTable(TableReport):
+
+    #--------------------------------------------------------------------
+    #
+    # 
+    #
+    #--------------------------------------------------------------------
+    def initialize(self):
+        templateFile = const.dataDir + os.sep + "table.sxc"
+        
+        self.open_office = OpenOffice.OpenOfficeCore(self.filename,\
+                                                     templateFile,".sxc")
+        self.file = self.open_office.setup()
+        self.file.write('<table:table table:name="Sheet1" table:style-name="ta1">\n')
+
+    #--------------------------------------------------------------------
+    #
+    # 
+    #
+    #--------------------------------------------------------------------
+    def finalize(self):
+        self.file.write('</table:table>\n')
+        self.open_office.end()
+        
+    #--------------------------------------------------------------------
+    #
+    # 
+    #
+    #--------------------------------------------------------------------
+    def write_table_data(self,data):
+        length = len(data)
+            
+        self.file.write('<table:table-row table:style-name="ro1">\n')
+        for item in data:
+            self.file.write('<table:table-cell table:style-name="ce' + str(self.row))
+            self.file.write('" table:value-type="string">\n')
+            self.file.write('<text:p>' + item + '</text:p>\n')
+            self.file.write('</table:table-cell>\n')
+        self.file.write('</table:table-row>\n')
+
+    #--------------------------------------------------------------------
+    #
+    # 
+    #
+    #--------------------------------------------------------------------
+    def set_row(self,val):
+        self.row = val + 2
+        
+    #--------------------------------------------------------------------
+    #
+    # 
+    #
+    #--------------------------------------------------------------------
+    def write_table_head(self,data):
+        length = len(data)
+        self.prev = 3
+        self.file.write('<table:table-column table:style-name="co1" ')
+        self.file.write('table:number-columns-repeated="' + str(length+1) + '"/>\n')
+        self.file.write('<table:table-row table:style-name="ro1">\n')
+        for item in data:
+            self.file.write('<table:table-cell table:style-name="ce1" ')
+            self.file.write('table:value-type="string">\n')
+            self.file.write('<text:p>' + item + '</text:p>\n')
+            self.file.write('</table:table-cell>\n')
+        self.file.write('</table:table-row>\n')
+
+
+#------------------------------------------------------------------------
+#
+# 
+#
+#------------------------------------------------------------------------
+class HtmlTable(TableReport):
+
+    #--------------------------------------------------------------------
+    #
+    # 
+    #
+    #--------------------------------------------------------------------
+    def __init__(self,file,template):
+        self.template = template
+        TableReport.__init__(self,file)
+        
+    #--------------------------------------------------------------------
+    #
+    # 
+    #
+    #--------------------------------------------------------------------
+    def initialize(self):
+        if self.template == "":
+            self.template = const.dataDir + os.sep + "table.html"
+            
+        templateFile = open(self.template,"r")
+        lines = templateFile.readlines()
+        templateFile.close()
+
+        self.last = []
+        self.first = []
+        in_last = 0
+        for line in lines:
+            if line[0:14] == "<!-- START -->":
+                in_last = 1
+                self.last.append(line);
+            elif in_last == 0:
+                self.first.append(line)
+            else:
+                self.last.append(line);
+
+        self.file = open(self.filename,"w")
+        for line in self.first:
+            self.file.write(line)
+
+    #--------------------------------------------------------------------
+    #
+    # 
+    #
+    #--------------------------------------------------------------------
+    def finalize(self):
+        
+        self.file.write("</table>")
+        for line in self.last:
+            self.file.write(line)
+        self.file.close()
+        
+    #--------------------------------------------------------------------
+    #
+    # 
+    #
+    #--------------------------------------------------------------------
+    def write_table_data(self,data):
+        length = len(data)
+            
+        self.file.write('<tr>\n')
+        for item in data:
+            self.file.write('<td>\n')
+            if item == "":
+                self.file.write('&nbsp;')
+            else:
+                self.file.write(fix(item))
+            self.file.write('\n</td>\n')
+        self.file.write('</tr>\n')
+
+    #--------------------------------------------------------------------
+    #
+    # 
+    #
+    #--------------------------------------------------------------------
+    def write_table_head(self,data):
+        self.file.write('<table cellspacing=1 cellpadding=1 border=1>\n')
+        self.file.write('<tr>\n')
+        for item in data:
+            self.file.write('<th>\n')
+            self.file.write(fix(item))
+            self.file.write('\n</th>\n')
+        self.file.write('</tr>\n')
+
+#------------------------------------------------------------------------
+#
+# 
+#
+#------------------------------------------------------------------------
+class EventComparison:
+
+    #------------------------------------------------------------------------
+    #
+    # 
+    #
+    #------------------------------------------------------------------------
+    def __init__(self,database):
+        self.db = database
+
+        base = os.path.dirname(__file__)
+        self.glade_file = base + os.sep + "eventcmp.glade"
+
+        self.filterDialog = GladeXML(self.glade_file,"filters")
+        self.filterDialog.signal_autoconnect({
+            "on_add_clicked": on_add_clicked,
+            "on_delete_clicked":on_delete_clicked,
+            "on_select_row" : on_select_row,
+            "on_filter_save_clicked" : on_filter_save_clicked,
+            "on_apply_clicked":on_apply_clicked,
+            "destroy_passed_object" : utils.destroy_passed_object
+            })
+    
+        top =self.filterDialog.get_widget("filters")
+        self.filter_menu = self.filterDialog.get_widget("filter_list")
+        self.filter_list_obj = self.filterDialog.get_widget("active_filters")
+        qualifier = self.filterDialog.get_widget("qualifier")
+
+        self.filter_list_obj.set_data(INDEX,-1)
+        self.filter_list_obj.set_data(OBJECT,self)
+
+        self.filter_list = []
+        
+        myMenu = GtkMenu()
+        for filter in Filter.filterList:
+            menuitem = GtkMenuItem(filter)
+            myMenu.append(menuitem)
+            menuitem.set_data(FILTER,Filter.filterMap[filter])
+            menuitem.set_data(FUNCTION,Filter.filterEnb[filter])
+            menuitem.set_data(QUALIFIER,qualifier)
+            menuitem.connect("activate",on_filter_name_changed)
+            menuitem.show()
+        self.filter_menu.set_menu(myMenu)
+
+        top.set_data(OBJECT,self)
+        top.show()
+
+    #------------------------------------------------------------------------
+    #
+    # 
+    #
+    #------------------------------------------------------------------------
+    def display_results(self):
+        my_list = []
+
+        for person in self.db.getPersonMap().values():
+            match = 1
+            for filter in self.filter_list:
+                if not filter.compare(person):
+                    match = 0
+            if match == 1:
+                my_list.append(person)
+
+        if len(my_list) == 0:
+            GnomeWarningDialog("No matches were found")
+            return
+
+        self.topDialog = GladeXML(self.glade_file,"top")
+        self.topDialog.signal_autoconnect({
+            "on_write_table" : on_write_table,
+            "destroy_passed_object" : utils.destroy_passed_object
+            })
+
+        top = self.topDialog.get_widget("top")
+        top.set_data(OBJECT,self)
+        table = self.topDialog.get_widget("addarea")
+    
+        my_list.sort(sort.by_last_name)
+
+        map = {}
+        for individual in my_list:
+            elist = individual.getEventList()
+            for event in elist:
+                name = event.getName()
+                if not name:
+                    break
+                if map.has_key(name):
+                    map[name] = map[name] + 1
+                else:
+                    map[name] = 1
+
+        unsort_list = []
+        for item in map.keys():
+            unsort_list.append((map[item],item))
+        unsort_list.sort(by_value)
+
+        sort_list = []
+        for item in unsort_list:
+            sort_list.append(item[1])
+
+        event_titles = ["Person","Birth","Death"] + sort_list
+
+        eventlist = GtkCList(len(event_titles),event_titles)
+        eventlist.set_data(INDEX,-1)
+    
+        table.add(eventlist)
+        eventlist.show()
+    
+        color_clist = ListColors.ColorList(eventlist,2)
+    
+        for individual in my_list:
+            name = individual.getPrimaryName().getName()
+            birth = individual.getBirth()
+            death = individual.getDeath()
+            map = {}
+            elist = individual.getEventList()[:]
+            for ievent in elist:
+                event_name = ievent.getName()
+                if map.has_key(event_name):
+                    map[event_name].append(ievent)
+                else:
+                    map[event_name] = [ievent]
+
+            first = 1
+            done = 0
+            while done == 0:
+                added = 0
+                if first:
+                    tlist = [name,birth.getDate(),death.getDate()]
+                    blist = ["",birth.getPlace(),death.getPlace()]
+                else:
+                    tlist = ["","",""]
+                    blist = ["","",""]
+                for ename in event_titles[3:]:
+                    if map.has_key(ename) and len(map[ename]) > 0:
+                        mylist = map[ename]
+                        event = mylist[0]
+                        del mylist[0]
+                        tlist.append(event.getDate())
+                        blist.append(event.getPlace())
+                        added = 1
+                    else:
+                        tlist.append("")
+                        blist.append("")
+                
+                if first:
+                    first = 0
+                    color_clist.add(tlist)
+                    color_clist.add(blist)
+                elif added == 0:
+                    done = 1
+                else:
+                    color_clist.add(tlist)
+                    color_clist.add(blist)
+
+        for index in range(0,len(event_titles)):
+            eventlist.set_column_width(index,eventlist.optimal_column_width(index))
+        top.show()
+
+    #------------------------------------------------------------------------
+    #
+    # 
+    #
+    #------------------------------------------------------------------------
+    def save_data(self):
+        
+        my_list = []
+        for person in self.db.getPersonMap().values():
+            match = 1
+            for filter in self.filter_list:
+                if not filter.compare(person):
+                    match = 0
+            if match == 1:
+                my_list.append(person)
+
+        my_list.sort(sort.by_last_name)
+
+        map = {}
+        for individual in my_list:
+            elist = individual.getEventList()[:]
+            for event in elist:
+                name = event.getName()
+                if not name:
+                    break
+                if map.has_key(name):
+                    map[name] = map[name] + 1
+                else:
+                    map[name] = 1
+
+        unsort_list = []
+        for item in map.keys():
+            unsort_list.append((map[item],item))
+        unsort_list.sort(by_value)
+
+        sort_list = []
+        for item in unsort_list:
+            sort_list.append(item[1])
+
+        name = self.form.get_widget("filename").get_text()
+
+        if self.form.get_widget("openoffice").get_active():
+            spreadsheet = OpenOfficeTable(name)
+        elif self.form.get_widget("html").get_active():
+            template = self.form.get_widget("htmlfile").get_text()
+            spreadsheet = HtmlTable(name,template)
+
+        spreadsheet.initialize()
+
+        event_titles = ["Person","Birth","Death"] + sort_list
+
+        spreadsheet.write_table_head(event_titles)
+    
+        index = 0
+        for individual in my_list:
+            spreadsheet.set_row(index%2)
+            index = index + 1
+            name = individual.getPrimaryName().getName()
+            birth = individual.getBirth()
+            death = individual.getDeath()
+            map = {}
+            elist = individual.getEventList()[:]
+            for ievent in elist:
+                event_name = ievent.getName()
+                if map.has_key(event_name):
+                    map[event_name].append(ievent)
+                else:
+                    map[event_name] = [ievent]
+
+            first = 1
+            done = 0
+            while done == 0:
+                added = 0
+                if first:
+                    tlist = [name,birth.getDate(),death.getDate()]
+                    blist = ["",birth.getPlace(),death.getPlace()]
+                else:
+                    tlist = ["","",""]
+                    blist = ["","",""]
+                for ename in event_titles[3:]:
+                    if map.has_key(ename) and len(map[ename]) > 0:
+                        mylist = map[ename]
+                        event = mylist[0]
+                        del mylist[0]
+                        tlist.append(event.getDate())
+                        blist.append(event.getPlace())
+                        added = 1
+                    else:
+                        tlist.append("")
+                        blist.append("")
+                
+                if first:
+                    first = 0
+                    spreadsheet.write_table_data(tlist)
+                    spreadsheet.write_table_data(blist)
+                elif added == 0:
+                    done = 1
+                else:
+                    spreadsheet.write_table_data(tlist)
+                    spreadsheet.write_table_data(blist)
+
+        spreadsheet.finalize()
+
+    #------------------------------------------------------------------------
+    #
+    # 
+    #
+    #------------------------------------------------------------------------
+    def display_save_form(self):
+        self.form = GladeXML(self.glade_file,"dialog1")
+        self.form.signal_autoconnect({
+            "on_save_clicked": on_save_clicked,
+            "on_html_toggled": on_html_toggled,
+            "destroy_passed_object" : utils.destroy_passed_object
+            })
+        self.save_form = self.form.get_widget("dialog1")
+        self.save_form.set_data(OBJECT,self)
+        self.save_form.show()
+
+#------------------------------------------------------------------------
+#
+# 
+#
+#------------------------------------------------------------------------
+def runTool(database,person,callback):
+    EventComparison(database)
+    
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def get_description():
+    return "Genealogical Research Event Analysis Tool\n\n" \
+           "Aids in the analysis of data by allowing the development "\
+           "of custom filters that can be applied to the database to "\
+           "find similar events"
+
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def on_apply_clicked(obj):
+    myobj = obj.get_data(OBJECT)
+    myobj.display_results()
+
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def on_write_table(obj):
+    myobj = obj.get_data(OBJECT)
+    myobj.display_save_form()
+
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def on_save_clicked(obj):
+    myobj = obj.get_data(OBJECT)
+    myobj.save_data()
+    utils.destroy_passed_object(obj)
+
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def on_html_toggled(obj):
+    myobj = obj.get_data(OBJECT)
+    if myobj.form.get_widget("html").get_active():
+        myobj.form.get_widget("htmltemplate").set_sensitive(1)
+    else:
+        myobj.form.get_widget("htmltemplate").set_sensitive(0)
+        
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def on_double_click(obj,event):
+    import EditPerson
+
+    row = obj.get_data(INDEX)
+    if event.button == 1 and event.type == GDK._2BUTTON_PRESS and row != -1:
+        EditPerson.EditPerson(obj.get_row_data(row))
+
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def on_select_row(obj,row,b,c):
+    obj.set_data(INDEX,row)
+
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def on_delete_clicked(obj):
+    myobj = obj.get_data(OBJECT)
+    row = myobj.filter_list_obj.get_data(INDEX)
+
+    if row == -1:
+        return
+    myobj.filter_list_obj.remove(row)
+    myobj.filter_list_obj.set_data(INDEX,row-1)
+    myobj.filter_list_obj.unselect_all()
+    del myobj.filter_list[row]
+
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def on_add_clicked(obj):
+
+    myobj = obj.get_data(OBJECT)
+
+    invert = myobj.filterDialog.get_widget("invert").get_active()
+    qualifier = myobj.filterDialog.get_widget("qualifier").get_text()
+    menu = myobj.filter_menu.get_menu()
+
+    function = menu.get_active().get_data(FILTER)
+
+    myfilter = function(qualifier)
+    myfilter.set_invert(invert)
+    
+    myobj.filter_list.append(myfilter)
+
+    row = myobj.filter_list_obj.get_data(INDEX)
+
+    myobj.filter_list_obj.set_data(INDEX,row+1)
+    if invert:
+        invert_text = "yes"
+    else:
+        invert_text = "no"
+
+    name = myfilter.__doc__
+    myobj.filter_list_obj.append([name,qualifier,invert_text])
+
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def on_filter_name_changed(obj):
+    function = obj.get_data(FUNCTION)
+    qualifier = obj.get_data(QUALIFIER)
+    qualifier.set_sensitive(function())
+
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def by_value(first,second):
+    return cmp(second[0],first[0])
+
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def on_filter_save_clicked(obj):
+    myobj = obj.get_data(OBJECT)
+
+    for filter in myobj.filter_list:
+        print "%s(\"%s\"),%d" % (filter,filter.text,filter.invert)
+        
+#-------------------------------------------------------------------------
+#
+#
+#
+#-------------------------------------------------------------------------
+def fix(line):
+    l = string.strip(line)
+    l = string.replace(l,'&','&amp;')
+    l = string.replace(l,'>','&gt;')
+    l = string.replace(l,'<','&lt;')
+    return string.replace(l,'"','&quot;')