134 lines
4.1 KiB
Python
134 lines
4.1 KiB
Python
#
|
|
# Gramps - a GTK+/GNOME based genealogy program
|
|
#
|
|
# Copyright (C) 2000-2006 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$
|
|
|
|
"""
|
|
UrlBase class for GRAMPS.
|
|
"""
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GRAMPS modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
from gen.lib.url import Url
|
|
from gen.lib.const import IDENTICAL, EQUAL
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# UrlBase classes
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class UrlBase(object):
|
|
"""
|
|
Base class for url-aware objects.
|
|
"""
|
|
|
|
def __init__(self, source=None):
|
|
"""
|
|
Initialize an UrlBase.
|
|
|
|
If the 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: UrlBase
|
|
"""
|
|
self.urls = map(Url, source.urls) if source else []
|
|
|
|
def serialize(self):
|
|
"""
|
|
Convert the object to a serialized tuple of data
|
|
"""
|
|
return [url.serialize() for url in self.urls]
|
|
|
|
def unserialize(self, data):
|
|
"""
|
|
Convert a serialized tuple of data to an object.
|
|
"""
|
|
self.urls = [Url().unserialize(item) for item in data]
|
|
|
|
def get_url_list(self):
|
|
"""
|
|
Return the list of :class:`~gen.lib.url.Url` instances associated with the object.
|
|
|
|
:returns: List of :class:`~gen.lib.url.Url` instances
|
|
:rtype: list
|
|
"""
|
|
return self.urls
|
|
|
|
def set_url_list(self, url_list):
|
|
"""
|
|
Set the list of :class:`~gen.lib.url.Url` instances to passed the list.
|
|
|
|
:param url_list: List of :class:`~gen.lib.url.Url` instances
|
|
:type url_list: list
|
|
"""
|
|
self.urls = url_list
|
|
|
|
def _merge_url_list(self, acquisition):
|
|
"""
|
|
Merge the list of urls from acquisition with our own.
|
|
|
|
:param acquisition: The url list of this object will be merged with
|
|
the current url list.
|
|
:rtype acquisition: UrlBase
|
|
"""
|
|
url_list = self.urls[:]
|
|
for addendum in acquisition.get_url_list():
|
|
for url in url_list:
|
|
equi = url.is_equivalent(addendum)
|
|
if equi == IDENTICAL:
|
|
break
|
|
elif equi == EQUAL:
|
|
url.merge(addendum)
|
|
break
|
|
else:
|
|
self.urls.append(addendum)
|
|
|
|
def add_url(self, url):
|
|
"""
|
|
Add a :class:`~gen.lib.url.Url` instance to the object's list of :class:`~gen.lib.url.Url` instances.
|
|
|
|
:param url: :class:`~gen.lib.url.Url` instance to be added to the Person's list of
|
|
related web sites.
|
|
:type url: :class:`~gen.lib.url.Url`
|
|
"""
|
|
self.urls.append(url)
|
|
|
|
def remove_url(self, url):
|
|
"""
|
|
Remove the specified :class:`~gen.lib.url.Url` instance from the url list.
|
|
|
|
If the instance does not exist in the list, the operation has no effect.
|
|
|
|
:param url: :class:`~gen.lib.url.Url` instance to remove from the list
|
|
:type url: :class:`~gen.lib.url.Url`
|
|
|
|
:returns: True if the url was removed, False if it was not in the list.
|
|
:rtype: bool
|
|
"""
|
|
if url in self.urls:
|
|
self.urls.remove(url)
|
|
return True
|
|
else:
|
|
return False
|