Url.py 7.69 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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
30
from Products.CMFCore.utils import getToolByName
31
from Products.ERP5Type import Permissions, PropertySheet
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32
from Products.ERP5Type.Base import Base
33
from Products.ERP5.Document.Coordinate import Coordinate
34
from zLOG import LOG
35
import urllib
36

37 38 39 40 41
no_crawl_protocol_list = ['mailto', 'javascript', ]
no_host_protocol_list = ['mailto', 'news', 'javascript',]
default_protocol_dict = { 'Email' : 'mailto',
                        }

42
class UrlMixIn:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
43

44 45 46 47 48 49 50 51
  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  security.declareProtected(Permissions.AccessContentsInformation,
                            'asURL')
  def asURL(self):
    """
52 53
    Returns a text representation of the Url if defined
    or None else.
54
    """
55 56 57
    url_string = self.getUrlString()
    if not url_string:
      return None
58 59 60 61 62
    protocol = self.getUrlProtocol()
    if not protocol:
      # A quick fix for all objects which did not
      # define protocol such as email addresses
      ptype = self.getPortalType()
63 64
      if default_protocol_dict.has_key(ptype):
        protocol = default_protocol_dict[ptype]
65 66
      else:
        protocol = 'http'
67

68
    if protocol in no_host_protocol_list or url_string.startswith('//'):
69
      return '%s:%s' % (protocol, url_string)
70 71 72 73

    if url_string.startswith(protocol):
      return url_string

74 75 76 77 78
    return '%s://%s' % (protocol, url_string)

  security.declareProtected(Permissions.ModifyPortalContent, 'fromText')
  def fromURL(self, url):
    """
79 80 81 82 83
    Analyses a URL and splits it into two parts. URLs
    normally follow RFC 1738. However, we accept URLs
    without the protocol a.k.a. scheme part (http, mailto, etc.). In this
    case only the url_string a.k.a. scheme-specific-part is taken
    into account. asURL will then generate the full URL.
84
    """
85 86
    if ':' in url:
      # This is the normal case (protocol specified in the URL)
87
      protocol, url_string = url.split(':', 1)
88 89 90 91
      if url_string.startswith('//'): url_string = url_string[2:]
      self._setUrlProtocol(protocol)
    else:
      url_string = url
92 93
    self.setUrlString(url_string)

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getURLServer')
  def getURLServer(self):
    """
      Returns the server part of a URL

      XXX - we must add here more consistency checking
      based on the protocol of the URL

      XXX - regular expressions would be better
    """
    url_string = self.getUrlString()
    return url_string.split('/')[0].split(':')[0]

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getURLPort')
  def getURLPort(self):
    """
      Returns the port part of a URL

      XXX - we must add here more consistency checking
      based on the protocol of the URL

      XXX - regular expressions would be better
    """
    url_string = self.getUrlString()
    server_part_list = url_string.split('/')[0].split(':')
    if len(server_part_list) > 1:
      return server_part_list[1]
    return None

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getURLPath')
  def getURLPath(self):
    """
      Returns the path part of a URL

      XXX - we must add here more consistency checking
      based on the protocol of the URL

      XXX - regular expressions would be better
    """
    url_string = self.getUrlString()
    return '/'.join(url_string.split('/')[1:])

139
class Url(Coordinate, Base, UrlMixIn):
140 141 142 143
  """
  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
144

145 146 147
  meta_type = 'ERP5 Url'
  portal_type = 'Url'
  add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
148

149 150 151
  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
152

153
  # Default Properties
154
  property_sheets = (   PropertySheet.Base
Jean-Paul Smets's avatar
Jean-Paul Smets committed
155 156
                      , PropertySheet.SimpleItem
                      , PropertySheet.Url
157
                      , PropertySheet.SortIndex
Jean-Paul Smets's avatar
Jean-Paul Smets committed
158 159
                      )

160 161 162
  security.declareProtected(Permissions.AccessContentsInformation,
                            'asText')
  def asText(self):
163
    """
164 165 166 167 168
    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
169
    """
170
    return self.getUrlString()
171 172 173

  security.declareProtected(Permissions.ModifyPortalContent, 'fromText')
  def fromText(self, text):
174
    """
175
    Sets url_string a.k.a. scheme-specific-part of a URL
176
    """
177
    self.setUrlString(text)
178 179 180 181 182

  security.declareProtected(Permissions.AccessContentsInformation,
                            'standardTextFormat')
  def standardTextFormat(self):
    """
183 184
    Returns the standard text formats for urls. The purpose
    of this method is unknown.
185
    """
186
    return ("http://www.erp5.org", "mailto:info@erp5.org")
187

188
  security.declareProtected(Permissions.UseMailhostServices, 'send')
189
  def send(self, from_url=None, to_url=None, msg=None,
190
           subject=None, attachment_list=None, extra_headers=None):
191 192
    """
    This method was previously named 'SendMail' and is used to send email
193 194

    * attachment_list is a list of dictionnaries with those keys:
195 196
     - name : name of the attachment,
     - content: data of the attachment
197
     - mime_type: mime-type corresponding to the attachment
198 199
    * extra_headers is a dictionnary of custom headers to add to the email.
      "X-" prefix is automatically added to those headers.
200
    """
201 202 203
    LOG('ERP5/Document/Url.send',0, 
     'DEPRECATED Url.send should not be used, use portal_notifications instead.')

204 205 206 207 208 209 210
    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"

211
    portal_notifications = getToolByName(self, 'portal_notifications')
212

213 214 215 216
    portal_notifications._sendEmailMessage(from_url=from_url, to_url=to_url,
                                           body=msg, subject=subject,
                                           attachment_list=attachment_list,
                                           extra_headers=extra_headers)