Url.py 5.25 KB
Newer Older
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3 4
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
5
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# 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.
#
##############################################################################

from AccessControl import ClassSecurityInfo
31
from Products.CMFCore.utils import getToolByName
32
from Products.ERP5Type import Permissions, PropertySheet
Nicolas Delaby's avatar
Nicolas Delaby committed
33
from Products.ERP5Type.Utils import deprecated
34
from Products.ERP5.Document.Coordinate import Coordinate
35 36
from Products.ERP5.mixin.url import UrlMixin, no_crawl_protocol_list,\
                            no_host_protocol_list, default_protocol_dict
37
from zLOG import LOG
38

39 40
_marker = object()

41
class Url(Coordinate, UrlMixin):
42 43 44 45
  """
  A Url is allows to represent in a standard way coordinates
  such as web sites, emails, ftp sites, etc.
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46

47 48 49
  meta_type = 'ERP5 Url'
  portal_type = 'Url'
  add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
50

51 52 53
  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
54

55
  # Default Properties
56
  property_sheets = (   PropertySheet.Url
57
                      , PropertySheet.SortIndex
Jean-Paul Smets's avatar
Jean-Paul Smets committed
58 59
                      )

60 61 62
  security.declareProtected(Permissions.AccessContentsInformation,
                            'asText')
  def asText(self):
63
    """
64 65 66 67 68
    Returns a text representation of the url_string a.k.a. scheme-specific-part
    This method is useful to handled emails, web pages of companies, etc.
    in the same way as for other coordinates (ex. telephones). Most
    users just enter www.erp5.com or info@erp5.com rather than
    http://www.erp5.com or mailto:info@erp5.com
69
    """
70 71 72
    if self.isDetailed():
      return self.getUrlString('')
    return self.getCoordinateText('')
73 74

  security.declareProtected(Permissions.ModifyPortalContent, 'fromText')
Nicolas Delaby's avatar
Nicolas Delaby committed
75
  @deprecated
76
  def fromText(self, text):
77
    """
78
    Sets url_string a.k.a. scheme-specific-part of a URL
79
    """
80
    self._setCoordinateText(text)
81
    self.setUrlString(text)
82 83 84 85 86

  security.declareProtected(Permissions.AccessContentsInformation,
                            'standardTextFormat')
  def standardTextFormat(self):
    """
87 88
    Returns the standard text formats for urls. The purpose
    of this method is unknown.
89
    """
90
    return ("http://www.erp5.org", "mailto:info@erp5.org")
91

92 93

  def getUrlString(self, default=_marker):
94 95
    """Fallback on coordinate_text
    """
96 97
    if not self.hasUrlString():
      if default is _marker:
98
        return self.getCoordinateText()
99
      else:
100
        return self.getCoordinateText(default)
101 102 103 104 105 106
    else:
      if default is _marker:
        return self._baseGetUrlString()
      else:
        return self._baseGetUrlString(default)

107 108
  security.declareProtected(Permissions.AccessContentsInformation, 'isDetailed')
  def isDetailed(self):
109 110
    """
    """
111
    return self.hasUrlString()
112

113
  security.declareProtected(Permissions.UseMailhostServices, 'send')
114
  @deprecated
115
  def send(self, from_url=None, to_url=None, msg=None,
116
           subject=None, attachment_list=None, extra_headers=None):
117 118
    """
    This method was previously named 'SendMail' and is used to send email
119 120

    * attachment_list is a list of dictionnaries with those keys:
121 122
     - name : name of the attachment,
     - content: data of the attachment
123
     - mime_type: mime-type corresponding to the attachment
124 125
    * extra_headers is a dictionnary of custom headers to add to the email.
      "X-" prefix is automatically added to those headers.
126
    """
127 128 129
    LOG('ERP5/Document/Url.send',0, 
     'DEPRECATED Url.send should not be used, use portal_notifications instead.')

130 131 132 133 134 135 136
    if from_url is None:
      from_url = self.getUrlString(None)
    if to_url is None:
      to_url = self.getUrlString(None)
    if from_url is None or to_url is None:
      raise AttributeError, "No mail defined"

137
    portal_notifications = getToolByName(self, 'portal_notifications')
138

139 140 141 142
    portal_notifications._sendEmailMessage(from_url=from_url, to_url=to_url,
                                           body=msg, subject=subject,
                                           attachment_list=attachment_list,
                                           extra_headers=extra_headers)