author | Aurelien Campeas <aurelien.campeas@logilab.fr> |
Tue, 17 Mar 2015 16:00:30 +0100 | |
changeset 10341 | 57c5ec22922d |
parent 9442 | fbf2287fb2ce |
child 10603 | 65ad6980976e |
permissions | -rw-r--r-- |
9211
d45d66d94baa
[entities] properly escape in EmailAddress.printable_value when format is html. Closes #3064025
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8930
diff
changeset
|
1 |
# copyright 2003-2013 LOGILAB S.A. (Paris, FRANCE), all rights reserved. |
5421
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
2 |
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
3 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
4 |
# This file is part of CubicWeb. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
5 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
6 |
# CubicWeb is free software: you can redistribute it and/or modify it under the |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
7 |
# terms of the GNU Lesser General Public License as published by the Free |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
8 |
# Software Foundation, either version 2.1 of the License, or (at your option) |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
9 |
# any later version. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
10 |
# |
5424
8ecbcbff9777
replace logilab-common by CubicWeb in disclaimer
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5421
diff
changeset
|
11 |
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT |
5421
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
12 |
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
13 |
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
14 |
# details. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
15 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
16 |
# You should have received a copy of the GNU Lesser General Public License along |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
17 |
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>. |
9211
d45d66d94baa
[entities] properly escape in EmailAddress.printable_value when format is html. Closes #3064025
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8930
diff
changeset
|
18 |
"""entity classes for optional library entities""" |
0 | 19 |
|
20 |
__docformat__ = "restructuredtext en" |
|
9442
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9211
diff
changeset
|
21 |
from warnings import warn |
0 | 22 |
|
23 |
from urlparse import urlsplit, urlunsplit |
|
1016
26387b836099
use datetime instead of mx.DateTime
sylvain.thenault@logilab.fr
parents:
713
diff
changeset
|
24 |
from datetime import datetime |
0 | 25 |
|
9211
d45d66d94baa
[entities] properly escape in EmailAddress.printable_value when format is html. Closes #3064025
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8930
diff
changeset
|
26 |
from logilab.mtconverter import xml_escape |
d45d66d94baa
[entities] properly escape in EmailAddress.printable_value when format is html. Closes #3064025
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8930
diff
changeset
|
27 |
|
1302
dd984d682ab0
don't fail on unregistered properties
sylvain.thenault@logilab.fr
parents:
1154
diff
changeset
|
28 |
from cubicweb import UnknownProperty |
713
5adb6d8e5fa7
update imports of "cubicweb.common.entity" and use the new module path "cubicweb.entity"
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
583
diff
changeset
|
29 |
from cubicweb.entity import _marker |
0 | 30 |
from cubicweb.entities import AnyEntity, fetch_config |
31 |
||
32 |
def mangle_email(address): |
|
33 |
try: |
|
34 |
name, host = address.split('@', 1) |
|
35 |
except ValueError: |
|
36 |
return address |
|
37 |
return '%s at %s' % (name, host.replace('.', ' dot ')) |
|
38 |
||
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
39 |
|
0 | 40 |
class EmailAddress(AnyEntity): |
3377
dd9d292b6a6d
use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3230
diff
changeset
|
41 |
__regid__ = 'EmailAddress' |
7827
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7737
diff
changeset
|
42 |
fetch_attrs, cw_fetch_order = fetch_config(['address', 'alias']) |
7737
db6d296cc66f
[web] closes #1892494: emailaddress and anonymity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5556
diff
changeset
|
43 |
rest_attr = 'eid' |
0 | 44 |
|
45 |
def dc_title(self): |
|
46 |
if self.alias: |
|
47 |
return '%s <%s>' % (self.alias, self.display_address()) |
|
48 |
return self.display_address() |
|
1477 | 49 |
|
0 | 50 |
@property |
51 |
def email_of(self): |
|
5556
9ab2b4c74baf
[entity] introduce a new 'adapters' registry
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
52 |
return self.reverse_use_email and self.reverse_use_email[0] or None |
1477 | 53 |
|
3204
0b766b8a13e1
#370578: change EmailAddress identical_to/canonical to prefered_form
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
54 |
@property |
0b766b8a13e1
#370578: change EmailAddress identical_to/canonical to prefered_form
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
55 |
def prefered(self): |
3207
2516324401dd
return self, not None, when no prefered form
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3204
diff
changeset
|
56 |
return self.prefered_form and self.prefered_form[0] or self |
3204
0b766b8a13e1
#370578: change EmailAddress identical_to/canonical to prefered_form
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
57 |
|
0 | 58 |
def related_emails(self, skipeids=None): |
59 |
# XXX move to eemail |
|
60 |
# check email relations are in the schema first |
|
61 |
subjrels = self.e_schema.object_relations() |
|
62 |
if not ('sender' in subjrels and 'recipients' in subjrels): |
|
63 |
return |
|
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
64 |
rset = self._cw.execute('DISTINCT Any X, S, D ORDERBY D DESC ' |
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
65 |
'WHERE X sender Y or X recipients Y, ' |
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
66 |
'X subject S, X date D, Y eid %(y)s', |
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
67 |
{'y': self.eid}) |
0 | 68 |
if skipeids is None: |
69 |
skipeids = set() |
|
70 |
for i in xrange(len(rset)): |
|
71 |
eid = rset[i][0] |
|
72 |
if eid in skipeids: |
|
73 |
continue |
|
74 |
skipeids.add(eid) |
|
75 |
yield rset.get_entity(i, 0) |
|
76 |
||
77 |
def display_address(self): |
|
3418
7b49fa7e942d
[api] use _cw, cw_row, cw_col, cw_rset etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3377
diff
changeset
|
78 |
if self._cw.vreg.config['mangle-emails']: |
0 | 79 |
return mangle_email(self.address) |
80 |
return self.address |
|
81 |
||
82 |
def printable_value(self, attr, value=_marker, attrtype=None, |
|
83 |
format='text/html'): |
|
84 |
"""overriden to return displayable address when necessary""" |
|
85 |
if attr == 'address': |
|
9211
d45d66d94baa
[entities] properly escape in EmailAddress.printable_value when format is html. Closes #3064025
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8930
diff
changeset
|
86 |
address = self.display_address() |
d45d66d94baa
[entities] properly escape in EmailAddress.printable_value when format is html. Closes #3064025
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8930
diff
changeset
|
87 |
if format == 'text/html': |
d45d66d94baa
[entities] properly escape in EmailAddress.printable_value when format is html. Closes #3064025
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8930
diff
changeset
|
88 |
address = xml_escape(address) |
d45d66d94baa
[entities] properly escape in EmailAddress.printable_value when format is html. Closes #3064025
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8930
diff
changeset
|
89 |
return address |
0 | 90 |
return super(EmailAddress, self).printable_value(attr, value, attrtype, format) |
91 |
||
92 |
||
2828
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
93 |
class Bookmark(AnyEntity): |
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
94 |
"""customized class for Bookmark entities""" |
3377
dd9d292b6a6d
use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3230
diff
changeset
|
95 |
__regid__ = 'Bookmark' |
7827
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7737
diff
changeset
|
96 |
fetch_attrs, cw_fetch_order = fetch_config(['title', 'path']) |
2828
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
97 |
|
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
98 |
def actual_url(self): |
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3418
diff
changeset
|
99 |
url = self._cw.build_url(self.path) |
2828
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
100 |
if self.title: |
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
101 |
urlparts = list(urlsplit(url)) |
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
102 |
if urlparts[3]: |
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3418
diff
changeset
|
103 |
urlparts[3] += '&vtitle=%s' % self._cw.url_quote(self.title) |
2828
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
104 |
else: |
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3418
diff
changeset
|
105 |
urlparts[3] = 'vtitle=%s' % self._cw.url_quote(self.title) |
2828
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
106 |
url = urlunsplit(urlparts) |
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
107 |
return url |
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
108 |
|
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
109 |
def action_url(self): |
306fe72bfd07
remove old bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2098
diff
changeset
|
110 |
return self.absolute_url() + '/follow' |
0 | 111 |
|
112 |
||
1398
5fe84a5f7035
rename internal entity types to have CW prefix instead of E
sylvain.thenault@logilab.fr
parents:
1302
diff
changeset
|
113 |
class CWProperty(AnyEntity): |
3377
dd9d292b6a6d
use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3230
diff
changeset
|
114 |
__regid__ = 'CWProperty' |
0 | 115 |
|
7827
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7737
diff
changeset
|
116 |
fetch_attrs, cw_fetch_order = fetch_config(['pkey', 'value']) |
0 | 117 |
rest_attr = 'pkey' |
118 |
||
119 |
def typed_value(self): |
|
3460
e4843535db25
[api] some more _cw / __regid__, automatic tests now pass again
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3451
diff
changeset
|
120 |
return self._cw.vreg.typed_value(self.pkey, self.value) |
1477 | 121 |
|
1780
7549509ce0e6
dc_description should take a format argument
sylvain.thenault@logilab.fr
parents:
1477
diff
changeset
|
122 |
def dc_description(self, format='text/plain'): |
1302
dd984d682ab0
don't fail on unregistered properties
sylvain.thenault@logilab.fr
parents:
1154
diff
changeset
|
123 |
try: |
3460
e4843535db25
[api] some more _cw / __regid__, automatic tests now pass again
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3451
diff
changeset
|
124 |
return self._cw._(self._cw.vreg.property_info(self.pkey)['help']) |
1302
dd984d682ab0
don't fail on unregistered properties
sylvain.thenault@logilab.fr
parents:
1154
diff
changeset
|
125 |
except UnknownProperty: |
dd984d682ab0
don't fail on unregistered properties
sylvain.thenault@logilab.fr
parents:
1154
diff
changeset
|
126 |
return u'' |
0 | 127 |
|
128 |
||
1398
5fe84a5f7035
rename internal entity types to have CW prefix instead of E
sylvain.thenault@logilab.fr
parents:
1302
diff
changeset
|
129 |
class CWCache(AnyEntity): |
0 | 130 |
"""Cache""" |
3377
dd9d292b6a6d
use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3230
diff
changeset
|
131 |
__regid__ = 'CWCache' |
7827
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7737
diff
changeset
|
132 |
fetch_attrs, cw_fetch_order = fetch_config(['name']) |
0 | 133 |
|
9442
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9211
diff
changeset
|
134 |
def __init__(self, *args, **kwargs): |
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9211
diff
changeset
|
135 |
warn('[3.19] CWCache entity type is going away soon. ' |
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9211
diff
changeset
|
136 |
'Other caching mechanisms can be used more reliably ' |
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9211
diff
changeset
|
137 |
'to the same effect.', |
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9211
diff
changeset
|
138 |
DeprecationWarning) |
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9211
diff
changeset
|
139 |
super(CWCache, self).__init__(*args, **kwargs) |
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9211
diff
changeset
|
140 |
|
0 | 141 |
def touch(self): |
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3418
diff
changeset
|
142 |
self._cw.execute('SET X timestamp %(t)s WHERE X eid %(x)s', |
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
143 |
{'t': datetime.now(), 'x': self.eid}) |
0 | 144 |
|
145 |
def valid(self, date): |
|
2060
10d9fbdbed35
[entities][CWCache] handle classic datetime vs None comparison bug
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
146 |
if date: |
2098
13aab3775af7
[CWCache] fix CWCache validity test
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2060
diff
changeset
|
147 |
return date > self.timestamp |
2060
10d9fbdbed35
[entities][CWCache] handle classic datetime vs None comparison bug
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
148 |
return False |
10d9fbdbed35
[entities][CWCache] handle classic datetime vs None comparison bug
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
149 |