357 lines
12 KiB
Python
357 lines
12 KiB
Python
#
|
|
# Gramps - a GTK+/GNOME based genealogy program
|
|
#
|
|
# Copyright (C) 2000-2007 Donald N. Allingham
|
|
# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
#
|
|
|
|
"""
|
|
Basic Primary Object class for Gramps.
|
|
"""
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Gramps modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
from .tableobj import TableObject
|
|
from .privacybase import PrivacyBase
|
|
from .citationbase import CitationBase
|
|
from .mediabase import MediaBase
|
|
from .tagbase import TagBase
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Basic Primary Object class
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class BasicPrimaryObject(TableObject, PrivacyBase, TagBase):
|
|
"""
|
|
The BasicPrimaryObject is the base class for :class:`~.note.Note` objects.
|
|
|
|
It is also the base class for the :class:`PrimaryObject` class.
|
|
|
|
The :class:`PrimaryObject` is the base class for all other primary objects
|
|
in the database. Primary objects are the core objects in the database.
|
|
Each object has a database handle and a Gramps ID value. The database
|
|
handle is used as the record number for the database, and the Gramps
|
|
ID is the user visible version.
|
|
"""
|
|
|
|
def __init__(self, source=None):
|
|
"""
|
|
Initialize a PrimaryObject.
|
|
|
|
If source is None, both the ID and handle are assigned as empty
|
|
strings. If source is not None, then object is initialized from values
|
|
of the source object.
|
|
|
|
:param source: Object used to initialize the new object
|
|
:type source: PrimaryObject
|
|
"""
|
|
TableObject.__init__(self, source)
|
|
PrivacyBase.__init__(self, source)
|
|
TagBase.__init__(self)
|
|
if source:
|
|
self.gramps_id = source.gramps_id
|
|
else:
|
|
self.gramps_id = None
|
|
|
|
@classmethod
|
|
def get_label(cls, field, _):
|
|
"""
|
|
Get the associated label given a field name of this object.
|
|
No index positions allowed on lists.
|
|
"""
|
|
chain = field.split(".")
|
|
path = cls._follow_schema_path(chain[:-1])
|
|
labels = path.get_labels(_)
|
|
if chain[-1] in labels:
|
|
return labels[chain[-1]]
|
|
else:
|
|
raise Exception("%s has no such label on %s: '%s'" % (cls, path, field))
|
|
|
|
@classmethod
|
|
def get_field_type(cls, field):
|
|
"""
|
|
Get the associated label given a field name of this object.
|
|
No index positions allowed on lists.
|
|
"""
|
|
chain = field.split(".")
|
|
ftype = cls._follow_schema_path(chain)
|
|
return ftype
|
|
|
|
@classmethod
|
|
def _follow_schema_path(cls, chain):
|
|
"""
|
|
Follow a list of schema items. Return endpoint.
|
|
"""
|
|
path = cls
|
|
for part in chain:
|
|
schema = path.get_schema()
|
|
if part.isdigit():
|
|
pass # skip over
|
|
elif part in schema.keys():
|
|
path = schema[part]
|
|
else:
|
|
raise Exception("No such %s in %s" % (part, schema))
|
|
if isinstance(path, (list, tuple)):
|
|
path = path[0]
|
|
return path
|
|
|
|
def get_field(self, field):
|
|
"""
|
|
Get the value of a field.
|
|
"""
|
|
chain = field.split(".")
|
|
path = self._follow_field_path(chain)
|
|
return path
|
|
|
|
def _follow_field_path(self, chain, ignore_errors=False):
|
|
"""
|
|
Follow a list of items. Return endpoint.
|
|
"""
|
|
path = self
|
|
for part in chain:
|
|
class_ = None
|
|
if hasattr(path, part): # attribute
|
|
path = getattr(path, part)
|
|
elif part.isdigit(): # index into list
|
|
path = path[int(part)]
|
|
elif part.endswith(")"): # callable
|
|
# parse
|
|
function, sargs = part.split("(", 1)
|
|
sargs = sargs[:-1] # remove right-parent
|
|
# eval arguments
|
|
args = []
|
|
for sarg in sargs.split(","):
|
|
if sarg:
|
|
args.append(eval(sarg.strip()))
|
|
# call
|
|
path = getattr(path, function)(*args)
|
|
elif ignore_errors:
|
|
return
|
|
else:
|
|
raise Exception("%s is not a valid field of %s; use %s" % (part, path, dir(path)))
|
|
return path
|
|
|
|
def set_field(self, field, value, ignore_errors=False):
|
|
"""
|
|
Set the value of a basic field (str, int, float, or bool).
|
|
value can be a string or actual value.
|
|
"""
|
|
chain = field.split(".")
|
|
path = self._follow_field_path(chain[:-1], ignore_errors)
|
|
ftype = self.get_field_type(field)
|
|
# ftype is str, bool, float, or int
|
|
value = (value in ['True', True]) if ftype is bool else value
|
|
setattr(path, chain[-1], ftype(value))
|
|
|
|
def set_gramps_id(self, gramps_id):
|
|
"""
|
|
Set the Gramps ID for the primary object.
|
|
|
|
:param gramps_id: Gramps ID
|
|
:type gramps_id: str
|
|
"""
|
|
self.gramps_id = gramps_id
|
|
|
|
def get_gramps_id(self):
|
|
"""
|
|
Return the Gramps ID for the primary object.
|
|
|
|
:returns: Gramps ID associated with the object
|
|
:rtype: str
|
|
"""
|
|
return self.gramps_id
|
|
|
|
def has_handle_reference(self, classname, handle):
|
|
"""
|
|
Return True if the object has reference to a given handle of given
|
|
primary object type.
|
|
|
|
:param classname: The name of the primary object class.
|
|
:type classname: str
|
|
:param handle: The handle to be checked.
|
|
:type handle: str
|
|
|
|
:returns:
|
|
Returns whether the object has reference to this handle of
|
|
this object type.
|
|
|
|
:rtype: bool
|
|
"""
|
|
return False
|
|
|
|
def remove_handle_references(self, classname, handle_list):
|
|
"""
|
|
Remove all references in this object to object handles in the list.
|
|
|
|
:param classname: The name of the primary object class.
|
|
:type classname: str
|
|
:param handle_list: The list of handles to be removed.
|
|
:type handle_list: str
|
|
"""
|
|
pass
|
|
|
|
def replace_handle_reference(self, classname, old_handle, new_handle):
|
|
"""
|
|
Replace all references to old handle with those to the new handle.
|
|
|
|
:param classname: The name of the primary object class.
|
|
:type classname: str
|
|
:param old_handle: The handle to be replaced.
|
|
:type old_handle: str
|
|
:param new_handle: The handle to replace the old one with.
|
|
:type new_handle: str
|
|
"""
|
|
pass
|
|
|
|
def has_media_reference(self, handle):
|
|
"""
|
|
Indicate if the object has a media references.
|
|
|
|
In the base class, no such references exist. Derived classes should
|
|
override this if they provide media references.
|
|
"""
|
|
return False
|
|
|
|
def remove_citation_references(self, handle_list):
|
|
"""
|
|
Remove the specified source references from the object.
|
|
|
|
In the base class no such references exist. Derived classes should
|
|
override this if they provide source references.
|
|
"""
|
|
pass
|
|
|
|
def remove_media_references(self, handle_list):
|
|
"""
|
|
Remove the specified media references from the object.
|
|
|
|
In the base class no such references exist. Derived classes should
|
|
override this if they provide media references.
|
|
"""
|
|
pass
|
|
|
|
def replace_citation_references(self, old_handle, new_handle):
|
|
pass
|
|
|
|
def replace_media_references(self, old_handle, new_handle):
|
|
pass
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Primary Object class
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class PrimaryObject(BasicPrimaryObject):
|
|
"""
|
|
The PrimaryObject is the base class for all primary objects in the
|
|
database.
|
|
|
|
Primary objects are the core objects in the database.
|
|
Each object has a database handle and a Gramps ID value. The database
|
|
handle is used as the record number for the database, and the Gramps
|
|
ID is the user visible version.
|
|
"""
|
|
|
|
def __init__(self, source=None):
|
|
"""
|
|
Initialize a PrimaryObject.
|
|
|
|
If source is None, both the ID and handle are assigned as empty
|
|
strings. If source is not None, then object is initialized from values
|
|
of the source object.
|
|
|
|
:param source: Object used to initialize the new object
|
|
:type source: PrimaryObject
|
|
"""
|
|
BasicPrimaryObject.__init__(self, source)
|
|
|
|
def has_handle_reference(self, classname, handle):
|
|
"""
|
|
Return True if the object has reference to a given handle of given
|
|
primary object type.
|
|
|
|
:param classname: The name of the primary object class.
|
|
:type classname: str
|
|
:param handle: The handle to be checked.
|
|
:type handle: str
|
|
:returns: Returns whether the object has reference to this handle
|
|
of this object type.
|
|
:rtype: bool
|
|
"""
|
|
if classname == 'Citation' and isinstance(self, CitationBase):
|
|
return self.has_citation_reference(handle)
|
|
elif classname == 'MediaObject' and isinstance(self, MediaBase):
|
|
return self.has_media_reference(handle)
|
|
else:
|
|
return self._has_handle_reference(classname, handle)
|
|
|
|
def remove_handle_references(self, classname, handle_list):
|
|
"""
|
|
Remove all references in this object to object handles in the list.
|
|
|
|
:param classname: The name of the primary object class.
|
|
:type classname: str
|
|
:param handle_list: The list of handles to be removed.
|
|
:type handle_list: str
|
|
"""
|
|
if classname == 'Citation' and isinstance(self, CitationBase):
|
|
self.remove_citation_references(handle_list)
|
|
elif classname == 'MediaObject' and isinstance(self, MediaBase):
|
|
self.remove_media_references(handle_list)
|
|
else:
|
|
self._remove_handle_references(classname, handle_list)
|
|
|
|
def replace_handle_reference(self, classname, old_handle, new_handle):
|
|
"""
|
|
Replace all references to old handle with those to the new handle.
|
|
|
|
:param classname: The name of the primary object class.
|
|
:type classname: str
|
|
:param old_handle: The handle to be replaced.
|
|
:type old_handle: str
|
|
:param new_handle: The handle to replace the old one with.
|
|
:type new_handle: str
|
|
"""
|
|
if classname == 'Citation' and isinstance(self, CitationBase):
|
|
self.replace_citation_references(old_handle, new_handle)
|
|
elif classname == 'MediaObject' and isinstance(self, MediaBase):
|
|
self.replace_media_references(old_handle, new_handle)
|
|
else:
|
|
self._replace_handle_reference(classname, old_handle, new_handle)
|
|
|
|
def _has_handle_reference(self, classname, handle):
|
|
"""
|
|
Return True if the handle is referenced by the object.
|
|
"""
|
|
return False
|
|
|
|
def _remove_handle_references(self, classname, handle_list):
|
|
"""
|
|
Remove the handle references from the object.
|
|
"""
|
|
pass
|
|
|
|
def _replace_handle_reference(self, classname, old_handle, new_handle):
|
|
"""
|
|
Replace the handle reference with the new reference.
|
|
"""
|
|
pass
|