# # Gramps - a GTK+/GNOME based genealogy program # # Copyright (C) 2000-2004 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$ """ Contains the interface to allow a database to get written using GRAMPS' XML file format. """ #------------------------------------------------------------------------- # # load standard python libraries # #------------------------------------------------------------------------- import string import time import shutil import os import codecs #------------------------------------------------------------------------- # # load gtk libraries # #------------------------------------------------------------------------- import gtk #------------------------------------------------------------------------- # # load GRAMPS libraries # #------------------------------------------------------------------------- import const import Calendar import Gregorian import RelLib from gettext import gettext as _ from QuestionDialog import ErrorDialog #------------------------------------------------------------------------- # # Attempt to load the GZIP library. Some version of python do not seem # to be compiled with this available. # #------------------------------------------------------------------------- try: import gzip _gzip_ok = 1 except: _gzip_ok = 0 #------------------------------------------------------------------------- # # # #------------------------------------------------------------------------- def exportData(database, filename, person, callback=None): ret = 0 if os.path.isfile(filename): try: shutil.copyfile(filename, filename + ".bak") shutil.copystat(filename, filename + ".bak") except: pass compress = _gzip_ok == 1 try: g = XmlWriter(database,callback,0,compress) ret = g.write(filename) except: import DisplayTrace DisplayTrace.DisplayTrace() ErrorDialog(_("Failure writing %s") % filename, _("An attempt is being made to recover the original file")) shutil.copyfile(filename + ".bak", filename) try: shutil.copystat(filename + ".bak", filename) except: pass return ret #------------------------------------------------------------------------- # # # #------------------------------------------------------------------------- def quick_write(database, filename,callback=None): g = XmlWriter(database,callback,0,1) g.write(filename) #------------------------------------------------------------------------- # # # #------------------------------------------------------------------------- class XmlWriter: """ Writes a database to the XML file. """ def __init__(self,db,callback,strip_photos,compress=1): """ Initializes, but does not write, an XML file. db - database to write callback - function to provide progress indication strip_photos - remove full paths off of media object paths compress - attempt to compress the database """ self.compress = compress self.db = db self.callback = callback self.strip_photos = strip_photos def write(self,filename): """ Write the database to the specified file. """ base = os.path.dirname(filename) if os.path.isdir(base): if not os.access(base,os.W_OK) or not os.access(base,os.R_OK): ErrorDialog(_('Failure writing %s') % filename, _("The database cannot be saved because you do not " "have permission to write to the directory. " "Please make sure you have write access to the " "directory and try again.")) return 0 if os.path.exists(filename): if not os.access(filename,os.W_OK): ErrorDialog(_('Failure writing %s') % filename, _("The database cannot be saved because you do not " "have permission to write to the file. " "Please make sure you have write access to the " "file and try again.")) return 0 self.fileroot = os.path.dirname(filename) try: if self.compress: try: g = gzip.open(filename,"wb") except: g = open(filename,"w") else: g = open(filename,"w") except IOError,msg: ErrorDialog(_('Failure writing %s') % filename,msg) return 0 self.g = codecs.getwriter("utf8")(g) self.write_xml_data() g.close() return 1 def write_handle(self,handle): """ Write the database to the specified file handle. """ if self.compress: try: g = gzip.GzipFile(mode="wb",fileobj=handle) except: g = handle else: g = handle self.g = codecs.getwriter("utf8")(g) self.write_xml_data() g.close() def write_xml_data(self): date = string.split(time.ctime(time.time())) owner = self.db.get_researcher() familyList = self.db.get_family_handles() person_len = self.db.get_number_of_people() family_len = len(familyList) source_len = len(self.db.get_source_handles()) place_len = len(self.db.get_place_handles()) objList = self.db.get_media_object_handles() total = person_len + family_len + place_len + source_len self.g.write('\n') self.g.write('\n') self.g.write("\n") self.g.write("
\n") self.g.write(" \n" % place_len) self.g.write(" \n") self.write_line("resname",owner.get_name(),3) self.write_line("resaddr",owner.get_address(),3) self.write_line("rescity",owner.get_city(),3) self.write_line("resstate",owner.get_state(),3) self.write_line("rescountry",owner.get_country(),3) self.write_line("respostal",owner.get_postal_code(),3) self.write_line("resphone",owner.get_phone(),3) self.write_line("resemail",owner.get_email(),3) self.g.write(" \n") self.g.write("
\n") count = 0 delta = max(int(total/50),1) if person_len > 0: self.g.write(" \n") keys = self.db.get_person_handles(sort_handles=False) keys.sort () for key in keys: person = self.db.get_person_from_handle(key) if self.callback and count % delta == 0: self.callback(float(count)/float(total)) count += 1 self.write_id("person",person,2) if person.get_gender() == RelLib.Person.male: self.write_line("gender","M",3) elif person.get_gender() == RelLib.Person.female: self.write_line("gender","F",3) else: self.write_line("gender","U",3) self.dump_name("name",person.get_primary_name(),3) for name in person.get_alternate_names(): self.dump_name("aka",name,3) self.write_line("nick",person.get_nick_name(),3) birth = self.db.get_event_from_handle(person.get_birth_handle()) death = self.db.get_event_from_handle(person.get_death_handle()) self.dump_my_event("Birth",birth,3) self.dump_my_event("Death",death,3) for event_handle in person.get_event_list(): event = self.db.get_event_from_handle(event_handle) self.dump_event(event,3) self.dump_ordinance("baptism",person.get_lds_baptism(),3) self.dump_ordinance("endowment",person.get_lds_endowment(),3) self.dump_ordinance("sealed_to_parents",person.get_lds_sealing(),3) self.write_media_list(person.get_media_list()) if len(person.get_address_list()) > 0: for address in person.get_address_list(): self.g.write(' \n' % conf_priv(address)) self.write_date(address.get_date_object(),4) self.write_line("street",address.get_street(),4) self.write_line("city",address.get_city(),4) self.write_line("state",address.get_state(),4) self.write_line("country",address.get_country(),4) self.write_line("postal",address.get_postal_code(),4) self.write_line("phone",address.get_phone(),4) if address.get_note() != "": self.write_note("note",address.get_note_object(),4) for s in address.get_source_references(): self.dump_source_ref(s,4) self.g.write(' \n') self.write_attribute_list(person.get_attribute_list()) self.write_url_list(person.get_url_list()) for alt in person.get_parent_family_handle_list(): if alt[1] != "Birth": mrel=' mrel="%s"' % alt[1] else: mrel='' if alt[2] != "Birth": frel=' frel="%s"' % alt[2] else: frel='' self.g.write(" \n" % \ (alt[0], mrel, frel)) for family in person.get_family_handle_list(): self.write_ref("parentin",family,3) self.write_note("note",person.get_note_object(),3) for s in person.get_source_references(): self.dump_source_ref(s,4) self.g.write(" \n") self.g.write(" \n") if family_len > 0: self.g.write(" \n") familyList.sort () for key in self.db.get_family_handles(): family = self.db.get_family_from_handle(key) if self.callback and count % delta == 0: self.callback(float(count)/float(total)) count = count + 1 self.write_family_handle(family,2) fid = family.get_father_handle() mid = family.get_mother_handle() self.write_ref("father",fid,3) self.write_ref("mother",mid,3) for event_handle in family.get_event_list(): event = self.db.get_event_from_handle(event_handle) self.dump_event(event,3) self.dump_ordinance("sealed_to_spouse",family.get_lds_sealing(),3) self.write_media_list(family.get_media_list()) if len(family.get_child_handle_list()) > 0: for person in family.get_child_handle_list(): self.write_ref("child",person,3) self.write_attribute_list(family.get_attribute_list()) self.write_note("note",family.get_note_object(),3) for s in family.get_source_references(): self.dump_source_ref(s,3) self.g.write(" \n") self.g.write(" \n") if source_len > 0: self.g.write(" \n") keys = self.db.get_source_handles () keys.sort () for key in keys: source = self.db.get_source_from_handle(key) if self.callback and count % delta == 0: self.callback(float(count)/float(total)) count = count + 1 self.g.write(" \n") self.write_force_line("stitle",source.get_title(),3) self.write_line("sauthor",source.get_author(),3) self.write_line("spubinfo",source.get_publication_info(),3) self.write_line("sabbrev",source.get_abbreviation(),3) if source.get_note() != "": self.write_note("note",source.get_note_object(),3) self.write_media_list(source.get_media_list()) self.g.write(" \n") self.g.write(" \n") if place_len > 0: self.g.write(" \n") keys = self.db.get_place_handles() keys.sort () for key in keys: try: place = self.db.get_place_from_handle(key) if self.callback and count % delta == 0: self.callback(float(count)/float(total)) self.write_place_obj(place) except: print "Could not find place %s" % key count = count + 1 self.g.write(" \n") if len(objList) > 0: self.g.write(" \n") objList.sort () for key in self.db.get_media_object_handles(): object = self.db.get_object_from_handle(key) self.write_object(object) self.g.write(" \n") if len(self.db.get_bookmarks()) > 0: self.g.write(" \n") for person_handle in self.db.get_bookmarks(): self.g.write(' \n' % person_handle) self.g.write(" \n") self.g.write("\n") def fix(self,line): l = line.strip() l = l.replace('&','&') l = l.replace('>','>') l = l.replace('<','<') return l.replace('"','"') def write_note(self,val,noteobj,indent=0): if not noteobj: return text = noteobj.get() if not text: return if indent != 0: self.g.write(" " * indent) format = noteobj.get_format() if format: self.g.write('<%s format="%d">' % (val,format)) else: self.g.write('<%s>' % val) self.g.write(self.fix(string.rstrip(text))) self.g.write("\n" % val) def write_text(self,val,text,indent=0): if not text: return if indent != 0: self.g.write(" " * indent) self.g.write('<%s>' % val) self.g.write(self.fix(string.rstrip(text))) self.g.write("\n" % val) def dump_event(self,event,index=1): if event: self.dump_my_event(event.get_name(),event,index) def write_witness(self,witness_list,index): if not witness_list: return for w in witness_list: sp = " "*index com = self.fix(w.get_comment()) if w.get_type() == RelLib.Event.ID: self.g.write('%s\n' % sp) self.g.write(' %s%s\n' % (sp,w.get_value())) if com: self.g.write(' %s%s\n' % (sp,com)) self.g.write('%s\n' % sp) else: nm = self.fix(w.get_value()) self.g.write('%s\n' % sp) self.g.write(' %s%s\n' % (sp,nm)) if com: self.g.write(' %s%s\n' % (sp,com)) self.g.write('%s\n' % sp) def dump_my_event(self,name,event,index=1): if not event or event.is_empty(): return sp = " " * index name = const.save_event(name) self.g.write('%s\n' % (sp,self.fix(name),conf_priv(event))) self.write_date(event.get_date_object(),index+1) self.write_witness(event.get_witness_list(),index+1) self.write_ref("place",event.get_place_handle(),index+1) self.write_line("cause",event.get_cause(),index+1) self.write_line("description",event.get_description(),index+1) if event.get_note(): self.write_note("note",event.get_note_object(),index+1) for s in event.get_source_references(): self.dump_source_ref(s,index+1) self.write_media_list(event.get_media_list(),index+1) self.g.write("%s\n" % sp) def dump_ordinance(self,name,ord,index=1): if not ord: return sp = " " * index sp2 = " " * (index+1) self.g.write('%s\n' % (sp,self.fix(name))) dateobj = ord.get_date_object() if dateobj != None and not dateobj.is_empty(): self.write_date(dateobj,index+1) if ord.get_temple(): self.g.write('%s\n' % (sp2,self.fix(ord.get_temple()))) self.write_ref("place",ord.get_place_handle(),index+1) if ord.get_status() != 0: self.g.write('%s\n' % (sp2,ord.get_status())) if ord.get_family_handle(): self.g.write('%s\n' % \ (sp2,self.fix(ord.get_family_handle().get_gramps_id()))) if ord.get_note() != "": self.write_note("note",ord.get_note_object(),index+1) for s in ord.get_source_references(): self.dump_source_ref(s,index+1) self.g.write('%s\n' % sp) def dump_source_ref(self,source_ref,index=1): source = self.db.get_source_from_handle(source_ref.get_base_handle()) if source: p = source_ref.get_page() c = source_ref.get_comments() t = source_ref.get_text() d = source_ref.get_date() q = source_ref.get_confidence_level() self.g.write(" " * index) if p == "" and c == "" and t == "" and d.is_empty() and q == 2: self.g.write('\n' % source.get_handle()) else: if q == 2: self.g.write('\n' % source.get_handle()) else: self.g.write('\n' % (source.get_handle(),q)) self.write_line("spage",p,index+1) self.write_text("scomments",c,index+1) self.write_text("stext",t,index+1) self.write_date(d,index+1) self.g.write("%s\n" % (" " * index)) def write_ref(self,label,id,index=1): if id: self.g.write('%s<%s ref="%s"/>\n' % (" "*index,label,id)) def write_id(self,label,person,index=1): if person: self.g.write('%s<%s id="%s"' % (" "*index,label,person.get_gramps_id())) comp = person.get_complete_flag() if comp: self.g.write(' complete="1"') self.g.write('>\n') def write_family_handle(self,family,index=1): if family: rel = family.get_relationship() comp = family.get_complete_flag() sp = " " * index self.g.write('%s\n' % const.save_frel(rel)) else: self.g.write('>\n') def write_last(self,name,indent=1): p = name.get_surname_prefix() n = name.get_surname() if p: self.g.write('%s%s\n' % (' '*indent,p,self.fix(n))) else: self.g.write('%s%s\n' % (' '*indent,self.fix(n))) def write_line(self,label,value,indent=1): if value: self.g.write('%s<%s>%s\n' % (' '*indent,label,self.fix(value),label)) def write_date(self,date,indent=1): sp = ' '*indent if date.is_empty(): return name = date.get_calendar().NAME if name != Gregorian.Gregorian.NAME: calstr = ' cformat="%s"' % name else: calstr = '' if date.is_range(): d1 = date.get_start_date().get_iso_date() d2 = date.get_stop_date().get_iso_date() self.g.write('%s\n' % (sp,d1,d2,calstr)) elif date.is_valid(): d1 = date.get_start_date() mode = d1.get_mode_val() dstr = d1.get_iso_date() if mode == Calendar.BEFORE: pref = ' type="before"' elif mode == Calendar.AFTER: pref = ' type="after"' elif mode == Calendar.ABOUT: pref = ' type="about"' else: pref = "" self.g.write('%s\n' % (sp,dstr,pref,calstr)) else: self.g.write('%s\n' %(sp,self.fix(date.get_text()))) def write_force_line(self,label,value,indent=1): if value != None: self.g.write('%s<%s>%s\n' % (' '*indent,label,self.fix(value),label)) def dump_name(self,label,name,index=1): sp = " "*index type = name.get_type() if type: self.g.write('%s<%s type="%s"%s>\n' % (sp,label,type,conf_priv(name))) else: self.g.write('%s<%s%s>\n' % (sp,label,conf_priv(name))) self.write_line("first",name.get_first_name(),index+1) self.write_last(name,index+1) self.write_line("suffix",name.get_suffix(),index+1) self.write_line("title",name.get_title(),index+1) if name.get_note() != "": self.write_note("note",name.get_note_object(),index+1) for s in name.get_source_references(): self.dump_source_ref(s,index+1) self.g.write('%s\n' % (sp,label)) def append_value(self,orig,val): if orig: return "%s, %s" % (orig,val) else: return val def build_place_title(self,loc): "Builds a title from a location" city = self.fix(loc.get_city()) parish = self.fix(loc.get_parish()) state = self.fix(loc.get_state()) country = self.fix(loc.get_country()) county = self.fix(loc.get_county()) value = "" if city: value = city if parish: value = self.append_value(value,parish) if county: value = self.append_value(value,county) if state: value = self.append_value(value,state) if country: value = self.append_value(value,country) return value def dump_location(self,loc): "Writes the location information to the output file" city = self.fix(loc.get_city()) parish = self.fix(loc.get_parish()) state = self.fix(loc.get_state()) country = self.fix(loc.get_country()) county = self.fix(loc.get_county()) zip = self.fix(loc.get_postal_code()) phone = self.fix(loc.get_phone()) self.g.write(' \n') def write_attribute_list(self, list, indent=3): sp = ' ' * indent for attr in list: self.g.write('%s\n') else: self.g.write('>\n') for s in attr.get_source_references(): self.dump_source_ref(s,indent+1) self.write_note("note",attr.get_note_object(),4) self.g.write('%s\n' % sp) def write_media_list(self,list,indent=3): sp = ' '*indent for photo in list: mobj_id = photo.get_reference_handle() self.g.write('%s\n") else: self.g.write(">\n") self.write_attribute_list(proplist,indent+1) for ref in refslist: self.dump_source_ref(ref,indent+1) self.write_note("note",photo.get_note_object(),indent+1) self.g.write('%s\n' % sp) def write_url_list(self,list): for url in list: self.g.write(' \n') def write_place_obj(self,place): title = self.fix(place.get_title()) long = self.fix(place.get_longitude()) lat = self.fix(place.get_latitude()) id = place.get_handle() main_loc = place.get_main_location() llen = len(place.get_alternate_locations()) + len(place.get_url_list()) + \ len(place.get_media_list()) + len(place.get_source_references()) ml_empty = main_loc.is_empty() note = place.get_note() if title == "": title = self.fix(self.build_place_title(place.get_main_location())) self.g.write(' 0 or note: self.g.write('>\n') else: self.g.write('/>\n') return if long or lat: self.g.write(' \n' % (long,lat)) self.dump_location(main_loc) for loc in place.get_alternate_locations(): self.dump_location(loc) self.write_media_list(place.get_media_list()) self.write_url_list(place.get_url_list()) if note != "": self.write_note("note",place.get_note_object(),3) for s in place.get_source_references(): self.dump_source_ref(s,3) self.g.write(" \n") def write_object(self,object): id = object.get_handle() type = object.get_mime_type() path = object.get_path() if self.strip_photos: path = os.path.basename(path) else: l = len(self.fileroot) if len(path) >= l: if self.fileroot == path[0:l]: path = path[l+1:] self.g.write(' \n') else: self.g.write('>\n') self.write_attribute_list(alist) if note != "": self.write_note("note",object.get_note_object(),3) for s in slist: self.dump_source_ref(s,3) self.g.write(" \n") #------------------------------------------------------------------------- # # # #------------------------------------------------------------------------- def sortById(first,second): fid = first.get_gramps_id() sid = second.get_gramps_id() if fid < sid: return -1 else: return fid != sid #------------------------------------------------------------------------- # # # #------------------------------------------------------------------------- def conf_priv(obj): if obj.get_privacy() != 0: return ' priv="%d"' % obj.get_privacy() else: return '' #------------------------------------------------------------------------- # # # #------------------------------------------------------------------------- _title = _('GRAMPS _XML database') _description = _('The GRAMPS XML database is a format used by older ' 'versions of GRAMPS. It is read-write compatible with ' 'the present GRAMPS database format.') _config = None _filename = 'gramps' from Plugins import register_export register_export(exportData,_title,_description,_config,_filename)