439 lines
13 KiB
Python
439 lines
13 KiB
Python
#
|
|
# Gramps - a GTK+/GNOME based genealogy program
|
|
#
|
|
# Copyright (C) 2004-2005 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$
|
|
|
|
# Written by Alex Roitman
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Standard Python Modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
import os
|
|
import time
|
|
from xml.parsers.expat import ParserCreate
|
|
|
|
try:
|
|
import fcntl
|
|
use_lock = True
|
|
except:
|
|
use_lock = False
|
|
|
|
import const
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Constants
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
GNOME_FILENAME = os.path.join(const.user_home,".recently-used")
|
|
MAX_GNOME_ITEMS = 500
|
|
|
|
GRAMPS_FILENAME = os.path.join(const.home_dir,"recent-files.xml")
|
|
MAX_GRAMPS_ITEMS = 10
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GnomeRecentItem
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class GnomeRecentItem:
|
|
"""
|
|
Interface to a single GNOME recent-items item
|
|
"""
|
|
|
|
def __init__(self,u="",m="",t=0,p=False,g=[]):
|
|
self.uri = u
|
|
self.mime = m
|
|
self.time = t
|
|
self.private = p
|
|
self.groups = g
|
|
|
|
def set_uri(self,val):
|
|
self.uri = val
|
|
|
|
def get_uri(self):
|
|
return self.uri
|
|
|
|
def set_mime(self,val):
|
|
self.mime = val
|
|
|
|
def get_mime(self):
|
|
return self.mime
|
|
|
|
def set_time(self,val):
|
|
self.time = int(val)
|
|
|
|
def get_time(self):
|
|
return self.time
|
|
|
|
def set_private(self,val):
|
|
self.private = val
|
|
|
|
def get_private(self):
|
|
return self.private
|
|
|
|
def set_groups(self,val):
|
|
self.groups = val[:]
|
|
|
|
def get_groups(self):
|
|
return self.groups[:]
|
|
|
|
def add_group(self,group):
|
|
if group not in self.groups:
|
|
self.groups.append(group)
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GnomeRecentItem
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class GrampsRecentItem:
|
|
"""
|
|
Interface to a single GRAMPS recent-items item
|
|
"""
|
|
|
|
def __init__(self,p="",m="",t=0):
|
|
self.path = p
|
|
self.mime = m
|
|
self.time = t
|
|
|
|
def set_path(self,val):
|
|
self.path = val
|
|
|
|
def get_path(self):
|
|
return self.path
|
|
|
|
def set_mime(self,val):
|
|
self.mime = val
|
|
|
|
def get_mime(self):
|
|
return self.mime
|
|
|
|
def set_time(self,val):
|
|
self.time = int(val)
|
|
|
|
def get_time(self):
|
|
return self.time
|
|
|
|
def __cmp__(self,other_item):
|
|
return cmp(self.time,other_item.time)
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GnomeRecentFiles
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class GnomeRecentFiles:
|
|
"""
|
|
Interface to a GnomeRecentFiles collection
|
|
"""
|
|
|
|
def __init__(self):
|
|
gnome_parser = GnomeRecentParser()
|
|
self.gnome_recent_files = gnome_parser.get()
|
|
|
|
def add(self,item2add):
|
|
# First we need to walk the existing items to see
|
|
# if our item is already there
|
|
for item in self.gnome_recent_files:
|
|
if item.get_uri() == item2add.get_uri():
|
|
# Found it -- modify timestamp and add all groups
|
|
# to the item's groups
|
|
item.set_time(item2add.get_time())
|
|
for group in item2add.get_groups():
|
|
item.add_group(group)
|
|
return
|
|
# At this point we walked the items and not found one,
|
|
# so simply inserting a new item in the beginning
|
|
self.gnome_recent_files.insert(0,item2add)
|
|
|
|
def save(self):
|
|
"""
|
|
Attempt saving into XML, both for GNOME-wide and GRAMPS files.
|
|
The trick is not to fail under any circumstances.
|
|
"""
|
|
try:
|
|
self.do_save()
|
|
except:
|
|
pass
|
|
|
|
def do_save(self):
|
|
"""
|
|
Saves the current GNOME RecentFiles collection to the associated file.
|
|
"""
|
|
xml_file = file(os.path.expanduser(GNOME_FILENAME),'w')
|
|
if use_lock:
|
|
fcntl.lockf(xml_file,fcntl.LOCK_EX)
|
|
xml_file.write("<?xml version=\"1.0\" encoding=\"utf-8\"?>\n")
|
|
xml_file.write('<RecentFiles>\n')
|
|
index = 0
|
|
for item in self.gnome_recent_files:
|
|
if index > MAX_GNOME_ITEMS:
|
|
break
|
|
index = index + 1
|
|
xml_file.write(' <RecentItem>\n')
|
|
xml_file.write(' <URI>%s</URI>\n' % item.get_uri())
|
|
xml_file.write(' <Mime-Type>%s</Mime-Type>\n' % item.get_mime())
|
|
xml_file.write(' <Timestamp>%d</Timestamp>\n' % item.get_time())
|
|
if item.get_private():
|
|
xml_file.write(' <Private/>\n')
|
|
xml_file.write(' <Groups>\n')
|
|
for g in item.get_groups():
|
|
xml_file.write(' <Group>%s</Group>\n' % g)
|
|
xml_file.write(' </Groups>\n')
|
|
xml_file.write(' </RecentItem>\n')
|
|
xml_file.write('</RecentFiles>\n')
|
|
if use_lock:
|
|
fcntl.lockf(xml_file,fcntl.LOCK_UN)
|
|
xml_file.close()
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GrampsRecentFiles
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class GrampsRecentFiles:
|
|
"""
|
|
Interface to a GrampsRecentFiles collection
|
|
"""
|
|
|
|
def __init__(self):
|
|
gramps_parser = GrampsRecentParser()
|
|
self.gramps_recent_files = gramps_parser.get()
|
|
|
|
def add(self,item2add):
|
|
# First we need to walk the existing items to see
|
|
# if our item is already there
|
|
for item in self.gramps_recent_files:
|
|
if item.get_path() == item2add.get_path():
|
|
# Found it -- modify timestamp and add all groups
|
|
# to the item's groups
|
|
item.set_time(item2add.get_time())
|
|
return
|
|
# At this point we walked the items and not found one,
|
|
# so simply inserting a new item in the beginning
|
|
self.gramps_recent_files.insert(0,item2add)
|
|
|
|
def remove_filename(self,filename):
|
|
# First we need to walk the existing items to see
|
|
# if our item is already there
|
|
found = False
|
|
for index in range(len(self.gramps_recent_files)):
|
|
if self.gramps_recent_files[index].get_path() == filename:
|
|
# Found it -- break here and pop that item
|
|
found = True
|
|
break
|
|
if found:
|
|
self.gramps_recent_files.pop(index)
|
|
|
|
def save(self):
|
|
"""
|
|
Attempt saving into XML.
|
|
The trick is not to fail under any circumstances.
|
|
"""
|
|
try:
|
|
self.do_save()
|
|
except:
|
|
pass
|
|
|
|
def do_save(self):
|
|
"""
|
|
Saves the current GRAMPS RecentFiles collection to the associated file.
|
|
"""
|
|
xml_file = file(os.path.expanduser(GRAMPS_FILENAME),'w')
|
|
if use_lock:
|
|
fcntl.lockf(xml_file,fcntl.LOCK_EX)
|
|
xml_file.write("<?xml version=\"1.0\" encoding=\"utf-8\"?>\n")
|
|
xml_file.write('<RecentFiles>\n')
|
|
index = 0
|
|
for item in self.gramps_recent_files:
|
|
index = index + 1
|
|
if index > MAX_GRAMPS_ITEMS:
|
|
break
|
|
xml_file.write(' <RecentItem>\n')
|
|
xml_file.write(' <Path>%s</Path>\n' % item.get_path())
|
|
xml_file.write(' <Mime-Type>%s</Mime-Type>\n' % item.get_mime())
|
|
xml_file.write(' <Timestamp>%d</Timestamp>\n' % item.get_time())
|
|
xml_file.write(' </RecentItem>\n')
|
|
xml_file.write('</RecentFiles>\n')
|
|
if use_lock:
|
|
fcntl.lockf(xml_file,fcntl.LOCK_UN)
|
|
xml_file.close()
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GnomeRecentParser
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class GnomeRecentParser:
|
|
"""
|
|
Parsing class for the GnomeRecentParser collection.
|
|
"""
|
|
|
|
def __init__(self):
|
|
self.recent_files = []
|
|
|
|
try:
|
|
xml_file = open(os.path.expanduser(GNOME_FILENAME))
|
|
if use_lock:
|
|
fcntl.lockf(xml_file,fcntl.LOCK_SH)
|
|
|
|
p = ParserCreate()
|
|
p.StartElementHandler = self.startElement
|
|
p.EndElementHandler = self.endElement
|
|
p.CharacterDataHandler = self.characters
|
|
p.ParseFile(xml_file)
|
|
|
|
if use_lock:
|
|
fcntl.lockf(xml_file,fcntl.LOCK_UN)
|
|
xml_file.close()
|
|
except:
|
|
pass
|
|
|
|
def get(self):
|
|
return self.recent_files
|
|
|
|
def startElement(self,tag,attrs):
|
|
self.tlist = []
|
|
if tag == "RecentItem":
|
|
self.item = GnomeRecentItem()
|
|
elif tag == "Groups":
|
|
self.groups = []
|
|
|
|
def endElement(self,tag):
|
|
|
|
text = ''.join(self.tlist)
|
|
|
|
if tag == "RecentItem":
|
|
self.recent_files.append(self.item)
|
|
elif tag == "URI":
|
|
self.item.set_uri(text)
|
|
elif tag == "Mime-Type":
|
|
self.item.set_mime(text)
|
|
elif tag == "Timestamp":
|
|
self.item.set_time(int(text))
|
|
elif tag == "Private":
|
|
self.item.set_private(True)
|
|
elif tag == "Groups":
|
|
self.item.set_groups(self.groups)
|
|
elif tag == "Group":
|
|
self.groups.append(text)
|
|
|
|
def characters(self, data):
|
|
self.tlist.append(data)
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GrampsRecentParser
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class GrampsRecentParser:
|
|
"""
|
|
Parsing class for the GrampsRecentFiles collection.
|
|
"""
|
|
|
|
def __init__(self):
|
|
self.recent_files = []
|
|
|
|
try:
|
|
xml_file = open(os.path.expanduser(GRAMPS_FILENAME))
|
|
if use_lock:
|
|
fcntl.lockf(xml_file,fcntl.LOCK_SH)
|
|
|
|
p = ParserCreate()
|
|
p.StartElementHandler = self.startElement
|
|
p.EndElementHandler = self.endElement
|
|
p.CharacterDataHandler = self.characters
|
|
p.ParseFile(xml_file)
|
|
|
|
if use_lock:
|
|
fcntl.lockf(xml_file,fcntl.LOCK_UN)
|
|
xml_file.close()
|
|
except:
|
|
pass
|
|
|
|
def get(self):
|
|
return self.recent_files
|
|
|
|
def startElement(self,tag,attrs):
|
|
self.tlist = []
|
|
if tag == "RecentItem":
|
|
self.item = GrampsRecentItem()
|
|
|
|
def endElement(self,tag):
|
|
|
|
text = ''.join(self.tlist)
|
|
|
|
if tag == "RecentItem":
|
|
if os.path.isfile(self.item.get_path()):
|
|
self.recent_files.append(self.item)
|
|
elif tag == "Path":
|
|
self.item.set_path(text)
|
|
elif tag == "Mime-Type":
|
|
self.item.set_mime(text)
|
|
elif tag == "Timestamp":
|
|
self.item.set_time(int(text))
|
|
|
|
def characters(self, data):
|
|
self.tlist.append(data)
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Helper functions
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
def recent_files(filename,filetype):
|
|
"""
|
|
Add an entry to both GNOME and GRAMPS recent-items storages.
|
|
"""
|
|
|
|
the_time = int(time.time())
|
|
# Add the file to the recent items
|
|
gnome_rf = GnomeRecentFiles()
|
|
gnome_item = GnomeRecentItem(
|
|
u=filename,
|
|
m=filetype,
|
|
t=the_time,
|
|
p=False,
|
|
g=['Gramps'])
|
|
gnome_rf.add(gnome_item)
|
|
gnome_rf.save()
|
|
|
|
gramps_rf = GrampsRecentFiles()
|
|
gramps_item = GrampsRecentItem(
|
|
p=filename,
|
|
m=filetype,
|
|
t=the_time)
|
|
gramps_rf.add(gramps_item)
|
|
gramps_rf.save()
|
|
|
|
def remove_filename(filename):
|
|
# GNOME will deal with missing item on its own -- who are we, mere mortals,
|
|
# to tell GNOME what do to?
|
|
# gnome_rf = GnomeRecentFiles()
|
|
# gnome_rf.remove_uri(uri)
|
|
# gnome_rf.save()
|
|
|
|
gramps_rf = GrampsRecentFiles()
|
|
gramps_rf.remove_filename(filename)
|
|
gramps_rf.save()
|