document.erp5.Url.py 5.27 KB
Newer Older
1

2
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
3 4 5
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
6
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
#
# 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
32
from Products.CMFCore.utils import getToolByName
33
from Products.ERP5Type import Permissions, PropertySheet
Nicolas Delaby's avatar
Nicolas Delaby committed
34
from Products.ERP5Type.Utils import deprecated
35
from erp5.component.document.Coordinate import Coordinate
36
from erp5.component.mixin.UrlMixin import UrlMixin
37

38
from zLOG import LOG
39

40 41
_marker = object()

42
class Url(Coordinate, UrlMixin):
43 44 45 46
  """
  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
47

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

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

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

61 62 63
  security.declareProtected(Permissions.AccessContentsInformation,
                            'asText')
  def asText(self):
64
    """
65 66 67 68 69
    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
70
    """
71 72 73
    if self.isDetailed():
      return self.getUrlString('')
    return self.getCoordinateText('')
74 75

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

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

93

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

110 111
  security.declareProtected(Permissions.AccessContentsInformation, 'isDetailed')
  def isDetailed(self):
112 113
    """
    """
114
    return self.hasUrlString()
115

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

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

133 134 135 136 137
    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:
138
      raise AttributeError("No mail defined")
139

140
    portal_notifications = getToolByName(self, 'portal_notifications')
141

142 143 144 145
    portal_notifications._sendEmailMessage(from_url=from_url, to_url=to_url,
                                           body=msg, subject=subject,
                                           attachment_list=attachment_list,
                                           extra_headers=extra_headers)