gramps/src/gen/lib/url.py

148 lines
4.6 KiB
Python
Raw Normal View History

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2006 Donald N. Allingham
# Copyright (C) 2009 Douglas S. Blank <doug.blank@gmail.com>
#
# 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$
"""
Url class for GRAMPS.
"""
#-------------------------------------------------------------------------
#
# standard python modules
#
#-------------------------------------------------------------------------
from warnings import warn
from urlparse import urlparse
#-------------------------------------------------------------------------
#
# GRAMPS modules
#
#-------------------------------------------------------------------------
from gen.lib.secondaryobj import SecondaryObject
from gen.lib.privacybase import PrivacyBase
from gen.lib.urltype import UrlType
#-------------------------------------------------------------------------
#
# Url for Person/Place/Repository
#
#-------------------------------------------------------------------------
class Url(SecondaryObject, PrivacyBase):
"""
Contains information related to internet Uniform Resource Locators,
allowing gramps to store information about internet resources.
"""
def __init__(self, source=None):
"""Create a new URL instance, copying from the source if present."""
PrivacyBase.__init__(self, source)
if source:
self.path = source.path
self.desc = source.desc
self.type = source.type
else:
self.path = ""
self.desc = ""
self.type = UrlType()
def serialize(self):
return (self.private, self.path, self.desc, self.type.serialize())
def unserialize(self, data):
(self.private, self.path, self.desc, type_value) = data
self.type.unserialize(type_value)
return self
def get_text_data_list(self):
"""
Return the list of all textual attributes of the object.
@return: Returns the list of all textual attributes of the object.
@rtype: list
"""
return [self.path, self.desc]
def set_path(self, path):
"""Set the URL path."""
self.path = path
def get_path(self):
"""Return the URL path."""
return self.path
def set_description(self, description):
"""Set the description of the URL."""
self.desc = description
def get_description(self):
"""Return the description of the URL."""
return self.desc
def set_type(self, the_type):
"""
@param the_type: descriptive type of the Url
@type the_type: str
"""
self.type.set(the_type)
def get_type(self):
"""
@returns: the descriptive type of the Url
@rtype: str
"""
return self.type
def are_equal(self, other):
"""Deprecated - use is_equal instead."""
warn( "Use is_equal instead of are_equal", DeprecationWarning, 2)
return self.is_equal(other)
def parse_path(self):
"""
Returns a 6 tuple-based object with the following items:
Property Pos Meaning
-------- --- ---------------------------------
scheme 0 URL scheme specifier
netloc 1 Network location part
path 2 Hierarchical path
params 3 Parameters for last path element
query 4 Query component
fragment 5 Fragment identifier
"""
return urlparse(self.path)
def get_full_path(self):
"""
Returns a full url, complete with scheme, even if missing from path.
"""
if self.type == UrlType.EMAIL and not self.path.startswith("mailto:"):
return "mailto:" + self.path
elif url.get_type() == UrlType.WEB_FTP and not self.path.startswith("ftp://"):
return "ftp://" + self.path
elif self.parse_path().scheme == '':
return "http://" + self.path
else:
return self.path