author | Nicolas Chauvat <nicolas.chauvat@logilab.fr> |
Thu, 14 Feb 2013 16:45:07 +0100 | |
changeset 8697 | 574bb05e40a4 |
parent 8450 | 11063635c4e4 |
child 8748 | f5027f8d2478 |
permissions | -rw-r--r-- |
7143
0517e3bf0b84
[AnyEntity] rename __linkto attribute as cw_linkto to avoid name mangling which make overriding/monkey-patching unnecessarily harder
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6039
diff
changeset
|
1 |
# copyright 2003-2011 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/>. |
5556
9ab2b4c74baf
[entity] introduce a new 'adapters' registry
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5424
diff
changeset
|
18 |
"""base application's entities class implementation: `AnyEntity`""" |
0 | 19 |
|
20 |
__docformat__ = "restructuredtext en" |
|
21 |
||
22 |
from warnings import warn |
|
23 |
||
2613
5e19c2bb370e
R [all] logilab.common 0.44 provides only deprecated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2459
diff
changeset
|
24 |
from logilab.common.deprecation import deprecated |
0 | 25 |
from logilab.common.decorators import cached |
26 |
||
27 |
from cubicweb import Unauthorized, typed_eid |
|
713
5adb6d8e5fa7
update imports of "cubicweb.common.entity" and use the new module path "cubicweb.entity"
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
479
diff
changeset
|
28 |
from cubicweb.entity import Entity |
0 | 29 |
|
30 |
||
31 |
class AnyEntity(Entity): |
|
32 |
"""an entity instance has e_schema automagically set on the class and |
|
33 |
instances have access to their issuing cursor |
|
34 |
""" |
|
3377
dd9d292b6a6d
use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3369
diff
changeset
|
35 |
__regid__ = 'Any' |
5556
9ab2b4c74baf
[entity] introduce a new 'adapters' registry
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5424
diff
changeset
|
36 |
__implements__ = () |
0 | 37 |
|
6039
6e84db1b3e44
[view] deprecate create_url in favor of a cw_create_url class method on entity classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5557
diff
changeset
|
38 |
@classmethod |
6e84db1b3e44
[view] deprecate create_url in favor of a cw_create_url class method on entity classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5557
diff
changeset
|
39 |
def cw_create_url(cls, req, **kwargs): |
6e84db1b3e44
[view] deprecate create_url in favor of a cw_create_url class method on entity classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5557
diff
changeset
|
40 |
""" return the url of the entity creation form for this entity type""" |
6e84db1b3e44
[view] deprecate create_url in favor of a cw_create_url class method on entity classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5557
diff
changeset
|
41 |
return req.build_url('add/%s' % cls.__regid__, **kwargs) |
6e84db1b3e44
[view] deprecate create_url in favor of a cw_create_url class method on entity classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5557
diff
changeset
|
42 |
|
8450
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
43 |
@classmethod |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
44 |
def cw_fti_index_rql_queries(cls, req): |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
45 |
"""return the list of rql queries to fetch entities to FT-index |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
46 |
|
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
47 |
The default is to fetch all entities at once and to prefetch |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
48 |
indexable attributes but one could imagine iterating over |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
49 |
"smaller" resultsets if the table is very big or returning |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
50 |
a subset of entities that match some business-logic condition. |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
51 |
""" |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
52 |
restrictions = ['X is %s' % cls.__regid__] |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
53 |
selected = ['X'] |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
54 |
for attrschema in cls.e_schema.indexable_attributes(): |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
55 |
varname = attrschema.type.upper() |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
56 |
restrictions.append('X %s %s' % (attrschema, varname)) |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
57 |
selected.append(varname) |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
58 |
return ['Any %s WHERE %s' % (', '.join(selected), |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
59 |
', '.join(restrictions))] |
11063635c4e4
[fti] allow usage of custom RQL to fetch entities to index (closes #2410509)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7875
diff
changeset
|
60 |
|
0 | 61 |
# meta data api ########################################################### |
62 |
||
63 |
def dc_title(self): |
|
64 |
"""return a suitable *unicode* title for this entity""" |
|
65 |
for rschema, attrschema in self.e_schema.attribute_definitions(): |
|
66 |
if rschema.meta: |
|
67 |
continue |
|
5557
1a534c596bff
[entity] continue cleanup of Entity/AnyEntity namespace
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5556
diff
changeset
|
68 |
value = self.cw_attr_value(rschema.type) |
0 | 69 |
if value: |
70 |
# make the value printable (dates, floats, bytes, etc.) |
|
71 |
return self.printable_value(rschema.type, value, attrschema.type, |
|
72 |
format='text/plain') |
|
73 |
return u'%s #%s' % (self.dc_type(), self.eid) |
|
74 |
||
75 |
def dc_long_title(self): |
|
76 |
"""return a more detailled title for this entity""" |
|
77 |
return self.dc_title() |
|
1493 | 78 |
|
0 | 79 |
def dc_description(self, format='text/plain'): |
80 |
"""return a suitable description for this entity""" |
|
3689
deb13e88e037
follow yams 0.25 api changes to improve performance
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3578
diff
changeset
|
81 |
if 'description' in self.e_schema.subjrels: |
0 | 82 |
return self.printable_value('description', format=format) |
83 |
return u'' |
|
84 |
||
85 |
def dc_authors(self): |
|
86 |
"""return a suitable description for the author(s) of the entity""" |
|
87 |
try: |
|
88 |
return ', '.join(u.name() for u in self.owned_by) |
|
89 |
except Unauthorized: |
|
90 |
return u'' |
|
91 |
||
92 |
def dc_creator(self): |
|
93 |
"""return a suitable description for the creator of the entity""" |
|
94 |
if self.creator: |
|
95 |
return self.creator.name() |
|
96 |
return u'' |
|
97 |
||
98 |
def dc_date(self, date_format=None):# XXX default to ISO 8601 ? |
|
99 |
"""return latest modification date of this entity""" |
|
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3418
diff
changeset
|
100 |
return self._cw.format_date(self.modification_date, date_format=date_format) |
0 | 101 |
|
102 |
def dc_type(self, form=''): |
|
103 |
"""return the display name for the type of this entity (translated)""" |
|
3418
7b49fa7e942d
[api] use _cw, cw_row, cw_col, cw_rset etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3377
diff
changeset
|
104 |
return self.e_schema.display_name(self._cw, form) |
0 | 105 |
|
106 |
def dc_language(self): |
|
107 |
"""return language used by this entity (translated)""" |
|
108 |
# check if entities has internationalizable attributes |
|
109 |
# XXX one is enough or check if all String attributes are internationalizable? |
|
110 |
for rschema, attrschema in self.e_schema.attribute_definitions(): |
|
4147
52fe79a98b21
3.6 remove deprecation warning
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
111 |
if rschema.rdef(self.e_schema, attrschema).internationalizable: |
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3418
diff
changeset
|
112 |
return self._cw._(self._cw.user.property_value('ui.language')) |
3418
7b49fa7e942d
[api] use _cw, cw_row, cw_col, cw_rset etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3377
diff
changeset
|
113 |
return self._cw._(self._cw.vreg.property_value('ui.language')) |
1493 | 114 |
|
0 | 115 |
@property |
116 |
def creator(self): |
|
1398
5fe84a5f7035
rename internal entity types to have CW prefix instead of E
sylvain.thenault@logilab.fr
parents:
1360
diff
changeset
|
117 |
"""return the CWUser entity which has created this entity, or None if |
0 | 118 |
unknown or if the curent user doesn't has access to this euser |
119 |
""" |
|
120 |
try: |
|
121 |
return self.created_by[0] |
|
122 |
except (Unauthorized, IndexError): |
|
123 |
return None |
|
124 |
||
125 |
# abstractions making the whole things (well, some at least) working ###### |
|
1493 | 126 |
|
0 | 127 |
def sortvalue(self, rtype=None): |
128 |
"""return a value which can be used to sort this entity or given |
|
129 |
entity's attribute |
|
130 |
""" |
|
131 |
if rtype is None: |
|
132 |
return self.dc_title().lower() |
|
5557
1a534c596bff
[entity] continue cleanup of Entity/AnyEntity namespace
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5556
diff
changeset
|
133 |
value = self.cw_attr_value(rtype) |
0 | 134 |
# do not restrict to `unicode` because Bytes will return a `str` value |
135 |
if isinstance(value, basestring): |
|
136 |
return self.printable_value(rtype, format='text/plain').lower() |
|
137 |
return value |
|
138 |
||
1493 | 139 |
|
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:
7143
diff
changeset
|
140 |
def fetch_config(fetchattrs, mainattr=None, pclass=AnyEntity, order='ASC'): |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
141 |
"""function to ease basic configuration of an entity class ORM. Basic usage |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
142 |
is: |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
143 |
|
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
144 |
.. sourcecode:: python |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
145 |
|
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
146 |
class MyEntity(AnyEntity): |
0 | 147 |
|
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:
7143
diff
changeset
|
148 |
fetch_attrs, cw_fetch_order = fetch_config(['attr1', 'attr2']) |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
149 |
# uncomment line below if you want the same sorting for 'unrelated' entities |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
150 |
# cw_fetch_unrelated_order = cw_fetch_order |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
151 |
|
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
152 |
Using this, when using ORM methods retrieving this type of entity, 'attr1' |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
153 |
and 'attr2' will be automatically prefetched and results will be sorted on |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
154 |
'attr1' ascending (ie the first attribute in the list). |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
155 |
|
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
156 |
This function will automatically add to fetched attributes those defined in |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
157 |
parent class given using the `pclass` argument. |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
158 |
|
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
159 |
Also, You can use `mainattr` and `order` argument to have a different |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
160 |
sorting. |
9bbf83f68bcc
[entity] upgrade fetch_[unrelated_]order to benefit from changes introduced in 3.14 (closes #1942758)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7143
diff
changeset
|
161 |
""" |
0 | 162 |
if pclass is not None: |
163 |
fetchattrs += pclass.fetch_attrs |
|
164 |
if mainattr is None: |
|
165 |
mainattr = fetchattrs[0] |
|
166 |
@classmethod |
|
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:
7143
diff
changeset
|
167 |
def fetch_order(cls, select, attr, var): |
0 | 168 |
if attr == mainattr: |
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:
7143
diff
changeset
|
169 |
select.add_sort_var(var, order=='ASC') |
0 | 170 |
return fetchattrs, fetch_order |