1
2
3
4
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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
139
140
141
142
143
144
145
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
# Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# 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
from Products.CMFCore.utils import getToolByName
from Products.ERP5Type import Permissions, PropertySheet
from Products.ERP5Type.Utils import deprecated
from erp5.component.document.Coordinate import Coordinate
from erp5.component.mixin.UrlMixin import UrlMixin
from zLOG import LOG
_marker = object()
class Url(Coordinate, UrlMixin):
"""
A Url is allows to represent in a standard way coordinates
such as web sites, emails, ftp sites, etc.
"""
meta_type = 'ERP5 Url'
portal_type = 'Url'
add_permission = Permissions.AddPortalContent
# Declarative security
security = ClassSecurityInfo()
security.declareObjectProtected(Permissions.AccessContentsInformation)
# Default Properties
property_sheets = ( PropertySheet.Url
, PropertySheet.SortIndex
)
security.declareProtected(Permissions.AccessContentsInformation,
'asText')
def asText(self):
"""
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
"""
if self.isDetailed():
return self.getUrlString('')
return self.getCoordinateText('')
security.declareProtected(Permissions.ModifyPortalContent, 'fromText')
@deprecated
def fromText(self, text):
"""
Sets url_string a.k.a. scheme-specific-part of a URL
"""
self._setCoordinateText(text)
self.setUrlString(text)
security.declareProtected(Permissions.AccessContentsInformation,
'standardTextFormat')
def standardTextFormat(self):
"""
Returns the standard text formats for urls. The purpose
of this method is unknown.
"""
return ("http://www.erp5.org", "mailto:info@erp5.org")
security.declareProtected(Permissions.AccessContentsInformation,
'getUrlString')
def getUrlString(self, default=_marker):
"""Fallback on coordinate_text
"""
if not self.hasUrlString():
if default is _marker:
return self.getCoordinateText()
else:
return self.getCoordinateText(default)
else:
if default is _marker:
return self._baseGetUrlString()
else:
return self._baseGetUrlString(default)
security.declareProtected(Permissions.AccessContentsInformation, 'isDetailed')
def isDetailed(self):
"""
"""
return self.hasUrlString()
security.declareProtected(Permissions.UseMailhostServices, 'send')
@deprecated
def send(self, from_url=None, to_url=None, msg=None,
subject=None, attachment_list=None, extra_headers=None):
"""
This method was previously named 'SendMail' and is used to send email
* attachment_list is a list of dictionnaries with those keys:
- name : name of the attachment,
- content: data of the attachment
- mime_type: mime-type corresponding to the attachment
* extra_headers is a dictionnary of custom headers to add to the email.
"X-" prefix is automatically added to those headers.
"""
LOG('ERP5/Document/Url.send',0,
'DEPRECATED Url.send should not be used, use portal_notifications instead.')
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")
portal_notifications = getToolByName(self, 'portal_notifications')
portal_notifications._sendEmailMessage(from_url=from_url, to_url=to_url,
body=msg, subject=subject,
attachment_list=attachment_list,
extra_headers=extra_headers)