author | Stéphanie Marcu <steph@logilab.fr> |
Wed, 23 Jun 2010 14:56:21 +0200 | |
branch | stable |
changeset 5830 | 23ea56123670 |
parent 5757 | e501806ab489 |
child 5762 | 730d458ec1bf |
permissions | -rw-r--r-- |
5421
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5320
diff
changeset
|
1 |
# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5320
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:
5320
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:
5320
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:
5320
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:
5320
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:
5320
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:
5320
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:
5320
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:
5320
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:
5320
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:
5320
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:
5320
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:
5320
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:
5320
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:
5320
diff
changeset
|
17 |
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>. |
5733 | 18 |
"""Base class for entity objects manipulated in clients""" |
0 | 19 |
|
20 |
__docformat__ = "restructuredtext en" |
|
21 |
||
1154 | 22 |
from warnings import warn |
23 |
||
0 | 24 |
from logilab.common import interface |
25 |
from logilab.common.compat import all |
|
26 |
from logilab.common.decorators import cached |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2125
diff
changeset
|
27 |
from logilab.mtconverter import TransformData, TransformError, xml_escape |
631
99f5852f8604
major selector refactoring (mostly to avoid looking for select parameters on the target class), start accept / interface unification)
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
28 |
|
0 | 29 |
from rql.utils import rqlvar_maker |
30 |
||
3664
af7ca3597b8d
use typed_eid
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3626
diff
changeset
|
31 |
from cubicweb import Unauthorized, typed_eid |
0 | 32 |
from cubicweb.rset import ResultSet |
692
800592b8d39b
replace deprecated cubicweb.common.selectors by its new module path (cubicweb.selectors)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
631
diff
changeset
|
33 |
from cubicweb.selectors import yes |
2656
a93ae0f6c0ad
R [base classes] only AppObject remaning, no more AppRsetObject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2650
diff
changeset
|
34 |
from cubicweb.appobject import AppObject |
4835
13b0b96d7982
[repo] enhanced security handling: deprecates unsafe_execute, in favor of explicit read/write security control using the `enabled_security` context manager. Also code executed on the repository side is now unsafe by default.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4831
diff
changeset
|
35 |
from cubicweb.req import _check_cw_unsafe |
2827
d1a89d165045
remove 3.2 bw compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2824
diff
changeset
|
36 |
from cubicweb.schema import RQLVocabularyConstraint, RQLConstraint |
3241
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
37 |
from cubicweb.rqlrewrite import RQLRewriter |
709 | 38 |
|
4023
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3998
diff
changeset
|
39 |
from cubicweb.uilib import printable_value, soup2xhtml |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3998
diff
changeset
|
40 |
from cubicweb.mixins import MI_REL_TRIGGERS |
eae23c40627a
drop common subpackage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3998
diff
changeset
|
41 |
from cubicweb.mttransforms import ENGINE |
0 | 42 |
|
43 |
_marker = object() |
|
44 |
||
45 |
def greater_card(rschema, subjtypes, objtypes, index): |
|
46 |
for subjtype in subjtypes: |
|
47 |
for objtype in objtypes: |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
48 |
card = rschema.rdef(subjtype, objtype).cardinality[index] |
0 | 49 |
if card in '+*': |
50 |
return card |
|
51 |
return '1' |
|
52 |
||
53 |
||
2656
a93ae0f6c0ad
R [base classes] only AppObject remaning, no more AppRsetObject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2650
diff
changeset
|
54 |
class Entity(AppObject, dict): |
0 | 55 |
"""an entity instance has e_schema automagically set on |
56 |
the class and instances has access to their issuing cursor. |
|
1474 | 57 |
|
0 | 58 |
A property is set for each attribute and relation on each entity's type |
59 |
class. Becare that among attributes, 'eid' is *NEITHER* stored in the |
|
60 |
dict containment (which acts as a cache for other attributes dynamically |
|
61 |
fetched) |
|
62 |
||
63 |
:type e_schema: `cubicweb.schema.EntitySchema` |
|
64 |
:ivar e_schema: the entity's schema |
|
65 |
||
66 |
:type rest_var: str |
|
67 |
:cvar rest_var: indicates which attribute should be used to build REST urls |
|
68 |
If None is specified, the first non-meta attribute will |
|
69 |
be used |
|
1474 | 70 |
|
0 | 71 |
:type skip_copy_for: list |
72 |
:cvar skip_copy_for: a list of relations that should be skipped when copying |
|
73 |
this kind of entity. Note that some relations such |
|
74 |
as composite relations or relations that have '?1' as object |
|
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
75 |
cardinality are always skipped. |
0 | 76 |
""" |
77 |
__registry__ = 'etypes' |
|
717 | 78 |
__select__ = yes() |
1264
fe2934a7df7f
cleanup, avoid spurious warning
sylvain.thenault@logilab.fr
parents:
1177
diff
changeset
|
79 |
|
1474 | 80 |
# class attributes that must be set in class definition |
0 | 81 |
rest_attr = None |
1138
22f634977c95
make pylint happy, fix some bugs on the way
sylvain.thenault@logilab.fr
parents:
1132
diff
changeset
|
82 |
fetch_attrs = None |
2920
64322aa83a1d
start a new workflow engine
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2877
diff
changeset
|
83 |
skip_copy_for = ('in_state',) |
1264
fe2934a7df7f
cleanup, avoid spurious warning
sylvain.thenault@logilab.fr
parents:
1177
diff
changeset
|
84 |
# class attributes set automatically at registration time |
fe2934a7df7f
cleanup, avoid spurious warning
sylvain.thenault@logilab.fr
parents:
1177
diff
changeset
|
85 |
e_schema = None |
1474 | 86 |
|
0 | 87 |
@classmethod |
2807
696ff03f9a58
__initialize__ needs the schema as argument
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
88 |
def __initialize__(cls, schema): |
0 | 89 |
"""initialize a specific entity class by adding descriptors to access |
90 |
entity type's attributes and relations |
|
91 |
""" |
|
3376
f5c69485381f
[appobjects] use __regid__ instead of __id__, more explicit
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3369
diff
changeset
|
92 |
etype = cls.__regid__ |
0 | 93 |
assert etype != 'Any', etype |
2807
696ff03f9a58
__initialize__ needs the schema as argument
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
94 |
cls.e_schema = eschema = schema.eschema(etype) |
0 | 95 |
for rschema, _ in eschema.attribute_definitions(): |
96 |
if rschema.type == 'eid': |
|
97 |
continue |
|
98 |
setattr(cls, rschema.type, Attribute(rschema.type)) |
|
99 |
mixins = [] |
|
2941
196493bd099c
[entity] use role instead of x
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2931
diff
changeset
|
100 |
for rschema, _, role in eschema.relation_definitions(): |
196493bd099c
[entity] use role instead of x
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2931
diff
changeset
|
101 |
if (rschema, role) in MI_REL_TRIGGERS: |
196493bd099c
[entity] use role instead of x
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2931
diff
changeset
|
102 |
mixin = MI_REL_TRIGGERS[(rschema, role)] |
0 | 103 |
if not (issubclass(cls, mixin) or mixin in mixins): # already mixed ? |
104 |
mixins.append(mixin) |
|
105 |
for iface in getattr(mixin, '__implements__', ()): |
|
106 |
if not interface.implements(cls, iface): |
|
107 |
interface.extend(cls, iface) |
|
2941
196493bd099c
[entity] use role instead of x
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2931
diff
changeset
|
108 |
if role == 'subject': |
0 | 109 |
setattr(cls, rschema.type, SubjectRelation(rschema)) |
110 |
else: |
|
111 |
attr = 'reverse_%s' % rschema.type |
|
112 |
setattr(cls, attr, ObjectRelation(rschema)) |
|
113 |
if mixins: |
|
3919
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
114 |
# see etype class instantation in cwvreg.ETypeRegistry.etype_class method: |
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
115 |
# due to class dumping, cls is the generated top level class with actual |
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
116 |
# user class as (only) parent. Since we want to be able to override mixins |
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
117 |
# method from this user class, we have to take care to insert mixins after that |
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
118 |
# class |
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
119 |
# |
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
120 |
# note that we don't plug mixins as user class parent since it causes pb |
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
121 |
# with some cases of entity classes inheritance. |
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
122 |
mixins.insert(0, cls.__bases__[0]) |
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
123 |
mixins += cls.__bases__[1:] |
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
124 |
cls.__bases__ = tuple(mixins) |
f91bd15f427c
fix nasty pluggable mixins bug, where mixins take precedence other user class
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
125 |
cls.info('plugged %s mixins on %s', mixins, cls) |
1474 | 126 |
|
0 | 127 |
@classmethod |
128 |
def fetch_rql(cls, user, restriction=None, fetchattrs=None, mainvar='X', |
|
129 |
settype=True, ordermethod='fetch_order'): |
|
130 |
"""return a rql to fetch all entities of the class type""" |
|
131 |
restrictions = restriction or [] |
|
132 |
if settype: |
|
3376
f5c69485381f
[appobjects] use __regid__ instead of __id__, more explicit
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3369
diff
changeset
|
133 |
restrictions.append('%s is %s' % (mainvar, cls.__regid__)) |
0 | 134 |
if fetchattrs is None: |
135 |
fetchattrs = cls.fetch_attrs |
|
136 |
selection = [mainvar] |
|
137 |
orderby = [] |
|
138 |
# start from 26 to avoid possible conflicts with X |
|
139 |
varmaker = rqlvar_maker(index=26) |
|
140 |
cls._fetch_restrictions(mainvar, varmaker, fetchattrs, selection, |
|
141 |
orderby, restrictions, user, ordermethod) |
|
142 |
rql = 'Any %s' % ','.join(selection) |
|
143 |
if orderby: |
|
144 |
rql += ' ORDERBY %s' % ','.join(orderby) |
|
145 |
rql += ' WHERE %s' % ', '.join(restrictions) |
|
146 |
return rql |
|
1474 | 147 |
|
0 | 148 |
@classmethod |
149 |
def _fetch_restrictions(cls, mainvar, varmaker, fetchattrs, |
|
150 |
selection, orderby, restrictions, user, |
|
151 |
ordermethod='fetch_order', visited=None): |
|
152 |
eschema = cls.e_schema |
|
153 |
if visited is None: |
|
154 |
visited = set((eschema.type,)) |
|
155 |
elif eschema.type in visited: |
|
156 |
# avoid infinite recursion |
|
157 |
return |
|
158 |
else: |
|
159 |
visited.add(eschema.type) |
|
160 |
_fetchattrs = [] |
|
161 |
for attr in fetchattrs: |
|
162 |
try: |
|
3689
deb13e88e037
follow yams 0.25 api changes to improve performance
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3683
diff
changeset
|
163 |
rschema = eschema.subjrels[attr] |
0 | 164 |
except KeyError: |
165 |
cls.warning('skipping fetch_attr %s defined in %s (not found in schema)', |
|
3376
f5c69485381f
[appobjects] use __regid__ instead of __id__, more explicit
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3369
diff
changeset
|
166 |
attr, cls.__regid__) |
0 | 167 |
continue |
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
168 |
rdef = eschema.rdef(attr) |
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
169 |
if not user.matching_groups(rdef.get_groups('read')): |
0 | 170 |
continue |
171 |
var = varmaker.next() |
|
172 |
selection.append(var) |
|
173 |
restriction = '%s %s %s' % (mainvar, attr, var) |
|
174 |
restrictions.append(restriction) |
|
3689
deb13e88e037
follow yams 0.25 api changes to improve performance
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3683
diff
changeset
|
175 |
if not rschema.final: |
0 | 176 |
# XXX this does not handle several destination types |
177 |
desttype = rschema.objects(eschema.type)[0] |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
178 |
card = rdef.cardinality[0] |
0 | 179 |
if card not in '?1': |
2928
edfdb69df6e8
oops, not self but cls here
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2877
diff
changeset
|
180 |
cls.warning('bad relation %s specified in fetch attrs for %s', |
edfdb69df6e8
oops, not self but cls here
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2877
diff
changeset
|
181 |
attr, cls) |
0 | 182 |
selection.pop() |
183 |
restrictions.pop() |
|
184 |
continue |
|
2871
83c5499e1436
[entity] fix fetch_rql w/ case where it's called while entity is not 'complete' (eg time where it's being added but have not yet all mandatory relations set)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2658
diff
changeset
|
185 |
# XXX we need outer join in case the relation is not mandatory |
83c5499e1436
[entity] fix fetch_rql w/ case where it's called while entity is not 'complete' (eg time where it's being added but have not yet all mandatory relations set)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2658
diff
changeset
|
186 |
# (card == '?') *or if the entity is being added*, since in |
83c5499e1436
[entity] fix fetch_rql w/ case where it's called while entity is not 'complete' (eg time where it's being added but have not yet all mandatory relations set)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2658
diff
changeset
|
187 |
# that case the relation may still be missing. As we miss this |
83c5499e1436
[entity] fix fetch_rql w/ case where it's called while entity is not 'complete' (eg time where it's being added but have not yet all mandatory relations set)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2658
diff
changeset
|
188 |
# later information here, systematically add it. |
83c5499e1436
[entity] fix fetch_rql w/ case where it's called while entity is not 'complete' (eg time where it's being added but have not yet all mandatory relations set)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2658
diff
changeset
|
189 |
restrictions[-1] += '?' |
4049
5838a4b0766d
3.5 api update
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4023
diff
changeset
|
190 |
# XXX user._cw.vreg iiiirk |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
191 |
destcls = user._cw.vreg['etypes'].etype_class(desttype) |
0 | 192 |
destcls._fetch_restrictions(var, varmaker, destcls.fetch_attrs, |
193 |
selection, orderby, restrictions, |
|
194 |
user, ordermethod, visited=visited) |
|
195 |
orderterm = getattr(cls, ordermethod)(attr, var) |
|
196 |
if orderterm: |
|
197 |
orderby.append(orderterm) |
|
198 |
return selection, orderby, restrictions |
|
199 |
||
1471
c889c3bcf5ec
new parent_classes method (cached)
sylvain.thenault@logilab.fr
parents:
1435
diff
changeset
|
200 |
@classmethod |
c889c3bcf5ec
new parent_classes method (cached)
sylvain.thenault@logilab.fr
parents:
1435
diff
changeset
|
201 |
@cached |
1840
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
202 |
def _rest_attr_info(cls): |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
203 |
mainattr, needcheck = 'eid', True |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
204 |
if cls.rest_attr: |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
205 |
mainattr = cls.rest_attr |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
206 |
needcheck = not cls.e_schema.has_unique_values(mainattr) |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
207 |
else: |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
208 |
for rschema in cls.e_schema.subject_relations(): |
3689
deb13e88e037
follow yams 0.25 api changes to improve performance
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3683
diff
changeset
|
209 |
if rschema.final and rschema != 'eid' and cls.e_schema.has_unique_values(rschema): |
1840
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
210 |
mainattr = str(rschema) |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
211 |
needcheck = False |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
212 |
break |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
213 |
if mainattr == 'eid': |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
214 |
needcheck = False |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
215 |
return mainattr, needcheck |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
216 |
|
5199
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
217 |
@classmethod |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
218 |
def cw_instantiate(cls, execute, **kwargs): |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
219 |
"""add a new entity of this given type |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
220 |
|
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
221 |
Example (in a shell session): |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
222 |
|
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
223 |
>>> companycls = vreg['etypes'].etype_class(('Company') |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
224 |
>>> personcls = vreg['etypes'].etype_class(('Person') |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
225 |
>>> c = companycls.cw_instantiate(req.execute, name=u'Logilab') |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
226 |
>>> personcls.cw_instantiate(req.execute, firstname=u'John', lastname=u'Doe', |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
227 |
... works_for=c) |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
228 |
|
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
229 |
""" |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
230 |
rql = 'INSERT %s X' % cls.__regid__ |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
231 |
relations = [] |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
232 |
restrictions = set() |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
233 |
pending_relations = [] |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
234 |
for attr, value in kwargs.items(): |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
235 |
if isinstance(value, (tuple, list, set, frozenset)): |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
236 |
if len(value) == 1: |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
237 |
value = iter(value).next() |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
238 |
else: |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
239 |
del kwargs[attr] |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
240 |
pending_relations.append( (attr, value) ) |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
241 |
continue |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
242 |
if hasattr(value, 'eid'): # non final relation |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
243 |
rvar = attr.upper() |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
244 |
# XXX safer detection of object relation |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
245 |
if attr.startswith('reverse_'): |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
246 |
relations.append('%s %s X' % (rvar, attr[len('reverse_'):])) |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
247 |
else: |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
248 |
relations.append('X %s %s' % (attr, rvar)) |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
249 |
restriction = '%s eid %%(%s)s' % (rvar, attr) |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
250 |
if not restriction in restrictions: |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
251 |
restrictions.add(restriction) |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
252 |
kwargs[attr] = value.eid |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
253 |
else: # attribute |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
254 |
relations.append('X %s %%(%s)s' % (attr, attr)) |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
255 |
if relations: |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
256 |
rql = '%s: %s' % (rql, ', '.join(relations)) |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
257 |
if restrictions: |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
258 |
rql = '%s WHERE %s' % (rql, ', '.join(restrictions)) |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
259 |
created = execute(rql, kwargs).get_entity(0, 0) |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
260 |
for attr, values in pending_relations: |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
261 |
if attr.startswith('reverse_'): |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
262 |
restr = 'Y %s X' % attr[len('reverse_'):] |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
263 |
else: |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
264 |
restr = 'X %s Y' % attr |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
265 |
execute('SET %s WHERE X eid %%(x)s, Y eid IN (%s)' % ( |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
266 |
restr, ','.join(str(r.eid) for r in values)), |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
267 |
{'x': created.eid}, build_descr=False) |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
268 |
return created |
ebb50479d2ab
[entity] move req.create_entity content to a cw_instantiate factory method on entity classes, so cube developpers will be able to easily customize instance creation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
269 |
|
1435
6cd6172718bb
allow to instantiate an entity without rset
sylvain.thenault@logilab.fr
parents:
1363
diff
changeset
|
270 |
def __init__(self, req, rset=None, row=None, col=0): |
2822
f26578339214
deprecate appobject.vreg and rename appobject instance attributes using cw_ prefix
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2818
diff
changeset
|
271 |
AppObject.__init__(self, req, rset=rset, row=row, col=col) |
0 | 272 |
dict.__init__(self) |
273 |
self._related_cache = {} |
|
274 |
if rset is not None: |
|
275 |
self.eid = rset[row][col] |
|
276 |
else: |
|
277 |
self.eid = None |
|
278 |
self._is_saved = True |
|
1474 | 279 |
|
0 | 280 |
def __repr__(self): |
281 |
return '<Entity %s %s %s at %s>' % ( |
|
282 |
self.e_schema, self.eid, self.keys(), id(self)) |
|
283 |
||
5320
848e92bb81cc
[json] provide a custom json encoder for entities that includes eid in the json object
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
5199
diff
changeset
|
284 |
def __json_encode__(self): |
848e92bb81cc
[json] provide a custom json encoder for entities that includes eid in the json object
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
5199
diff
changeset
|
285 |
"""custom json dumps hook to dump the entity's eid |
848e92bb81cc
[json] provide a custom json encoder for entities that includes eid in the json object
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
5199
diff
changeset
|
286 |
which is not part of dict structure itself |
848e92bb81cc
[json] provide a custom json encoder for entities that includes eid in the json object
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
5199
diff
changeset
|
287 |
""" |
848e92bb81cc
[json] provide a custom json encoder for entities that includes eid in the json object
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
5199
diff
changeset
|
288 |
dumpable = dict(self) |
848e92bb81cc
[json] provide a custom json encoder for entities that includes eid in the json object
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
5199
diff
changeset
|
289 |
dumpable['eid'] = self.eid |
848e92bb81cc
[json] provide a custom json encoder for entities that includes eid in the json object
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
5199
diff
changeset
|
290 |
return dumpable |
848e92bb81cc
[json] provide a custom json encoder for entities that includes eid in the json object
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
5199
diff
changeset
|
291 |
|
0 | 292 |
def __nonzero__(self): |
293 |
return True |
|
294 |
||
295 |
def __hash__(self): |
|
296 |
return id(self) |
|
297 |
||
3047
ba86b1bdbcab
fix __cmp__ arguments
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3000
diff
changeset
|
298 |
def __cmp__(self, other): |
3000
4e76477949d5
B [entities] #343385 comparing entities should raise NotImplementedError
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2928
diff
changeset
|
299 |
raise NotImplementedError('comparison not implemented for %s' % self.__class__) |
4e76477949d5
B [entities] #343385 comparing entities should raise NotImplementedError
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2928
diff
changeset
|
300 |
|
4970
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
301 |
def __getitem__(self, key): |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
302 |
if key == 'eid': |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
303 |
warn('[3.7] entity["eid"] is deprecated, use entity.eid instead', |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
304 |
DeprecationWarning, stacklevel=2) |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
305 |
return self.eid |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
306 |
return super(Entity, self).__getitem__(key) |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
307 |
|
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
308 |
def __setitem__(self, attr, value): |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
309 |
"""override __setitem__ to update self.edited_attributes. |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
310 |
|
4989
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
311 |
Typically, a before_[update|add]_hook could do:: |
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
312 |
|
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
313 |
entity['generated_attr'] = generated_value |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
314 |
|
4989
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
315 |
and this way, edited_attributes will be updated accordingly. Also, add |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
316 |
the attribute to skip_security since we don't want to check security |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
317 |
for such attributes set by hooks. |
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
318 |
""" |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
319 |
if attr == 'eid': |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
320 |
warn('[3.7] entity["eid"] = value is deprecated, use entity.eid = value instead', |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
321 |
DeprecationWarning, stacklevel=2) |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
322 |
self.eid = value |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
323 |
else: |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
324 |
super(Entity, self).__setitem__(attr, value) |
4990
3bf481cf51cb
[security] don't add attribute into skip_security if already in edited_attributes, else we may accidentaly skip a desired security check
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4989
diff
changeset
|
325 |
# don't add attribute into skip_security if already in edited |
3bf481cf51cb
[security] don't add attribute into skip_security if already in edited_attributes, else we may accidentaly skip a desired security check
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4989
diff
changeset
|
326 |
# attributes, else we may accidentaly skip a desired security check |
3bf481cf51cb
[security] don't add attribute into skip_security if already in edited_attributes, else we may accidentaly skip a desired security check
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4989
diff
changeset
|
327 |
if hasattr(self, 'edited_attributes') and \ |
3bf481cf51cb
[security] don't add attribute into skip_security if already in edited_attributes, else we may accidentaly skip a desired security check
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4989
diff
changeset
|
328 |
attr not in self.edited_attributes: |
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
329 |
self.edited_attributes.add(attr) |
4970
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
330 |
self.skip_security_attributes.add(attr) |
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
331 |
|
4989
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
332 |
def __delitem__(self, attr): |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
333 |
"""override __delitem__ to update self.edited_attributes on cleanup of |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
334 |
undesired changes introduced in the entity's dict. For example, see the |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
335 |
code snippet below from the `forge` cube: |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
336 |
|
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
337 |
.. sourcecode:: python |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
338 |
|
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
339 |
edited = self.entity.edited_attributes |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
340 |
has_load_left = 'load_left' in edited |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
341 |
if 'load' in edited and self.entity.load_left is None: |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
342 |
self.entity.load_left = self.entity['load'] |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
343 |
elif not has_load_left and edited: |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
344 |
# cleanup, this may cause undesired changes |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
345 |
del self.entity['load_left'] |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
346 |
|
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
347 |
""" |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
348 |
super(Entity, self).__delitem__(attr) |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
349 |
if hasattr(self, 'edited_attributes'): |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
350 |
self.edited_attributes.remove(attr) |
0e6dca27422c
[repo entity] we have to provide a __delitem__ implementation as well, see example in the docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4988
diff
changeset
|
351 |
|
4970
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
352 |
def setdefault(self, attr, default): |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
353 |
"""override setdefault to update self.edited_attributes""" |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
354 |
super(Entity, self).setdefault(attr, default) |
4990
3bf481cf51cb
[security] don't add attribute into skip_security if already in edited_attributes, else we may accidentaly skip a desired security check
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4989
diff
changeset
|
355 |
# don't add attribute into skip_security if already in edited |
3bf481cf51cb
[security] don't add attribute into skip_security if already in edited_attributes, else we may accidentaly skip a desired security check
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4989
diff
changeset
|
356 |
# attributes, else we may accidentaly skip a desired security check |
3bf481cf51cb
[security] don't add attribute into skip_security if already in edited_attributes, else we may accidentaly skip a desired security check
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4989
diff
changeset
|
357 |
if hasattr(self, 'edited_attributes') and \ |
3bf481cf51cb
[security] don't add attribute into skip_security if already in edited_attributes, else we may accidentaly skip a desired security check
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4989
diff
changeset
|
358 |
attr not in self.edited_attributes: |
4970
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
359 |
self.edited_attributes.add(attr) |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
360 |
self.skip_security_attributes.add(attr) |
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
361 |
|
5009
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
362 |
def pop(self, attr, default=_marker): |
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
363 |
"""override pop to update self.edited_attributes on cleanup of |
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
364 |
undesired changes introduced in the entity's dict. See `__delitem__` |
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
365 |
""" |
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
366 |
if default is _marker: |
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
367 |
value = super(Entity, self).pop(attr) |
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
368 |
else: |
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
369 |
value = super(Entity, self).pop(attr, default) |
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
370 |
if hasattr(self, 'edited_attributes') and attr in self.edited_attributes: |
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
371 |
self.edited_attributes.remove(attr) |
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
372 |
return value |
2ac04bc976c3
[entity] we also have to override dict.pop to properly maintain edited_attributes consistency
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4991
diff
changeset
|
373 |
|
5115
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
374 |
def update(self, values): |
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
375 |
"""override update to update self.edited_attributes. See `__setitem__` |
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
376 |
""" |
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
377 |
for attr, value in values.items(): |
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
378 |
self[attr] = value # use self.__setitem__ implementation |
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
379 |
|
4970
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
380 |
def rql_set_value(self, attr, value): |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
381 |
"""call by rql execution plan when some attribute is modified |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
382 |
|
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
383 |
don't use dict api in such case since we don't want attribute to be |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
384 |
added to skip_security_attributes. |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
385 |
""" |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
386 |
super(Entity, self).__setitem__(attr, value) |
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
387 |
|
0 | 388 |
def pre_add_hook(self): |
389 |
"""hook called by the repository before doing anything to add the entity |
|
390 |
(before_add entity hooks have not been called yet). This give the |
|
391 |
occasion to do weird stuff such as autocast (File -> Image for instance). |
|
1474 | 392 |
|
0 | 393 |
This method must return the actual entity to be added. |
394 |
""" |
|
395 |
return self |
|
1474 | 396 |
|
0 | 397 |
def set_eid(self, eid): |
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
398 |
self.eid = eid |
0 | 399 |
|
400 |
def has_eid(self): |
|
401 |
"""return True if the entity has an attributed eid (False |
|
402 |
meaning that the entity has to be created |
|
403 |
""" |
|
404 |
try: |
|
3664
af7ca3597b8d
use typed_eid
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3626
diff
changeset
|
405 |
typed_eid(self.eid) |
0 | 406 |
return True |
407 |
except (ValueError, TypeError): |
|
408 |
return False |
|
409 |
||
410 |
def is_saved(self): |
|
411 |
"""during entity creation, there is some time during which the entity |
|
412 |
has an eid attributed though it's not saved (eg during before_add_entity |
|
413 |
hooks). You can use this method to ensure the entity has an eid *and* is |
|
414 |
saved in its source. |
|
415 |
""" |
|
416 |
return self.has_eid() and self._is_saved |
|
1474 | 417 |
|
0 | 418 |
@cached |
419 |
def metainformation(self): |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
420 |
res = dict(zip(('type', 'source', 'extid'), self._cw.describe(self.eid))) |
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
421 |
res['source'] = self._cw.source_defs()[res['source']] |
0 | 422 |
return res |
423 |
||
475
b32a5772ff06
should clear local perm cache if first attempt failed
sylvain.thenault@logilab.fr
parents:
413
diff
changeset
|
424 |
def clear_local_perm_cache(self, action): |
b32a5772ff06
should clear local perm cache if first attempt failed
sylvain.thenault@logilab.fr
parents:
413
diff
changeset
|
425 |
for rqlexpr in self.e_schema.get_rqlexprs(action): |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
426 |
self._cw.local_perm_cache.pop((rqlexpr.eid, (('x', self.eid),)), None) |
475
b32a5772ff06
should clear local perm cache if first attempt failed
sylvain.thenault@logilab.fr
parents:
413
diff
changeset
|
427 |
|
0 | 428 |
def check_perm(self, action): |
3890
d7a270f50f54
backport stable branch (one more time painfully)
Sylvain Thénault <sylvain.thenault@logilab.fr>
diff
changeset
|
429 |
self.e_schema.check_perm(self._cw, action, eid=self.eid) |
0 | 430 |
|
431 |
def has_perm(self, action): |
|
3890
d7a270f50f54
backport stable branch (one more time painfully)
Sylvain Thénault <sylvain.thenault@logilab.fr>
diff
changeset
|
432 |
return self.e_schema.has_perm(self._cw, action, eid=self.eid) |
1474 | 433 |
|
5522
6be95896d49e
[entity] avoid getting w in cw_extra_kwargs when calling .view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
434 |
def view(self, __vid, __registry='views', w=None, **kwargs): |
0 | 435 |
"""shortcut to apply a view on this entity""" |
4451
65f4665233e6
misc typos found on my way: NameError / SyntaxError / double __select__, <sigh ...>
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4436
diff
changeset
|
436 |
view = self._cw.vreg[__registry].select(__vid, self._cw, rset=self.cw_rset, |
3459
e134d2dd9992
[entity] pass cw_row and cw_col to select(vid, ...) in self.view
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3452
diff
changeset
|
437 |
row=self.cw_row, col=self.cw_col, |
e134d2dd9992
[entity] pass cw_row and cw_col to select(vid, ...) in self.view
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3452
diff
changeset
|
438 |
**kwargs) |
5522
6be95896d49e
[entity] avoid getting w in cw_extra_kwargs when calling .view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
439 |
return view.render(row=self.cw_row, col=self.cw_col, w=w, **kwargs) |
0 | 440 |
|
2059
af33833d7571
absolute_url / build_url refactoring to avoid potential name clash
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2058
diff
changeset
|
441 |
def absolute_url(self, *args, **kwargs): |
0 | 442 |
"""return an absolute url to view this entity""" |
2059
af33833d7571
absolute_url / build_url refactoring to avoid potential name clash
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2058
diff
changeset
|
443 |
# use *args since we don't want first argument to be "anonymous" to |
af33833d7571
absolute_url / build_url refactoring to avoid potential name clash
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2058
diff
changeset
|
444 |
# avoid potential clash with kwargs |
af33833d7571
absolute_url / build_url refactoring to avoid potential name clash
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2058
diff
changeset
|
445 |
if args: |
af33833d7571
absolute_url / build_url refactoring to avoid potential name clash
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2058
diff
changeset
|
446 |
assert len(args) == 1, 'only 0 or 1 non-named-argument expected' |
af33833d7571
absolute_url / build_url refactoring to avoid potential name clash
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2058
diff
changeset
|
447 |
method = args[0] |
af33833d7571
absolute_url / build_url refactoring to avoid potential name clash
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2058
diff
changeset
|
448 |
else: |
af33833d7571
absolute_url / build_url refactoring to avoid potential name clash
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2058
diff
changeset
|
449 |
method = None |
0 | 450 |
# in linksearch mode, we don't want external urls else selecting |
451 |
# the object for use in the relation is tricky |
|
452 |
# XXX search_state is web specific |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
453 |
if getattr(self._cw, 'search_state', ('normal',))[0] == 'normal': |
0 | 454 |
kwargs['base_url'] = self.metainformation()['source'].get('base-url') |
1904
e23536d29231
minor refactoring of absolute_url()
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
1842
diff
changeset
|
455 |
if method in (None, 'view'): |
1842
c7a22540d6f7
add some bw compat code for old rest_path prototype
sylvain.thenault@logilab.fr
parents:
1840
diff
changeset
|
456 |
try: |
c7a22540d6f7
add some bw compat code for old rest_path prototype
sylvain.thenault@logilab.fr
parents:
1840
diff
changeset
|
457 |
kwargs['_restpath'] = self.rest_path(kwargs.get('base_url')) |
c7a22540d6f7
add some bw compat code for old rest_path prototype
sylvain.thenault@logilab.fr
parents:
1840
diff
changeset
|
458 |
except TypeError: |
3405
9d31c9cb8103
nicer deprecation warnings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3382
diff
changeset
|
459 |
warn('[3.4] %s: rest_path() now take use_ext_eid argument, ' |
3376
f5c69485381f
[appobjects] use __regid__ instead of __id__, more explicit
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3369
diff
changeset
|
460 |
'please update' % self.__regid__, DeprecationWarning) |
1842
c7a22540d6f7
add some bw compat code for old rest_path prototype
sylvain.thenault@logilab.fr
parents:
1840
diff
changeset
|
461 |
kwargs['_restpath'] = self.rest_path() |
0 | 462 |
else: |
463 |
kwargs['rql'] = 'Any X WHERE X eid %s' % self.eid |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
464 |
return self._cw.build_url(method, **kwargs) |
0 | 465 |
|
1840
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
466 |
def rest_path(self, use_ext_eid=False): |
0 | 467 |
"""returns a REST-like (relative) path for this entity""" |
468 |
mainattr, needcheck = self._rest_attr_info() |
|
469 |
etype = str(self.e_schema) |
|
1840
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
470 |
path = etype.lower() |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
471 |
if mainattr != 'eid': |
0 | 472 |
value = getattr(self, mainattr) |
2125
19861294506f
https://www.logilab.net/cwo/ticket/343724
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2005
diff
changeset
|
473 |
if value is None or unicode(value) == u'': |
1840
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
474 |
mainattr = 'eid' |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
475 |
path += '/eid' |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
476 |
elif needcheck: |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
477 |
# make sure url is not ambiguous |
4363
5c18d82042fb
cache result of the COUNT query used to see if a non unique attribute may be used as rest path on the entity instance to avoid recomputing it later
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
478 |
try: |
5c18d82042fb
cache result of the COUNT query used to see if a non unique attribute may be used as rest path on the entity instance to avoid recomputing it later
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
479 |
nbresults = self.__unique |
5c18d82042fb
cache result of the COUNT query used to see if a non unique attribute may be used as rest path on the entity instance to avoid recomputing it later
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
480 |
except AttributeError: |
5c18d82042fb
cache result of the COUNT query used to see if a non unique attribute may be used as rest path on the entity instance to avoid recomputing it later
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
481 |
rql = 'Any COUNT(X) WHERE X is %s, X %s %%(value)s' % ( |
5c18d82042fb
cache result of the COUNT query used to see if a non unique attribute may be used as rest path on the entity instance to avoid recomputing it later
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
482 |
etype, mainattr) |
5c18d82042fb
cache result of the COUNT query used to see if a non unique attribute may be used as rest path on the entity instance to avoid recomputing it later
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
483 |
nbresults = self.__unique = self._cw.execute(rql, {'value' : value})[0][0] |
1904
e23536d29231
minor refactoring of absolute_url()
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
1842
diff
changeset
|
484 |
if nbresults != 1: # ambiguity? |
e23536d29231
minor refactoring of absolute_url()
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
1842
diff
changeset
|
485 |
mainattr = 'eid' |
e23536d29231
minor refactoring of absolute_url()
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
1842
diff
changeset
|
486 |
path += '/eid' |
0 | 487 |
if mainattr == 'eid': |
1840
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
488 |
if use_ext_eid: |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
489 |
value = self.metainformation()['extid'] |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
490 |
else: |
f4b5c15d1147
test and fix #342997: local eid used for absolute_url of external entities
sylvain.thenault@logilab.fr
parents:
1804
diff
changeset
|
491 |
value = self.eid |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
492 |
return '%s/%s' % (path, self._cw.url_quote(value)) |
0 | 493 |
|
1360
13ae1121835e
rename attribute_metadata method to attr_metadata to save a few chars
sylvain.thenault@logilab.fr
parents:
1313
diff
changeset
|
494 |
def attr_metadata(self, attr, metadata): |
1101
0c067de38e46
unification of meta-attributes handling:
sylvain.thenault@logilab.fr
parents:
1098
diff
changeset
|
495 |
"""return a metadata for an attribute (None if unspecified)""" |
0c067de38e46
unification of meta-attributes handling:
sylvain.thenault@logilab.fr
parents:
1098
diff
changeset
|
496 |
value = getattr(self, '%s_%s' % (attr, metadata), None) |
0c067de38e46
unification of meta-attributes handling:
sylvain.thenault@logilab.fr
parents:
1098
diff
changeset
|
497 |
if value is None and metadata == 'encoding': |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
498 |
value = self._cw.vreg.property_value('ui.encoding') |
1101
0c067de38e46
unification of meta-attributes handling:
sylvain.thenault@logilab.fr
parents:
1098
diff
changeset
|
499 |
return value |
0 | 500 |
|
501 |
def printable_value(self, attr, value=_marker, attrtype=None, |
|
502 |
format='text/html', displaytime=True): |
|
503 |
"""return a displayable value (i.e. unicode string) which may contains |
|
504 |
html tags |
|
505 |
""" |
|
506 |
attr = str(attr) |
|
507 |
if value is _marker: |
|
508 |
value = getattr(self, attr) |
|
509 |
if isinstance(value, basestring): |
|
510 |
value = value.strip() |
|
511 |
if value is None or value == '': # don't use "not", 0 is an acceptable value |
|
512 |
return u'' |
|
513 |
if attrtype is None: |
|
514 |
attrtype = self.e_schema.destination(attr) |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
515 |
props = self.e_schema.rdef(attr) |
0 | 516 |
if attrtype == 'String': |
517 |
# internalinalized *and* formatted string such as schema |
|
518 |
# description... |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
519 |
if props.internationalizable: |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
520 |
value = self._cw._(value) |
1360
13ae1121835e
rename attribute_metadata method to attr_metadata to save a few chars
sylvain.thenault@logilab.fr
parents:
1313
diff
changeset
|
521 |
attrformat = self.attr_metadata(attr, 'format') |
0 | 522 |
if attrformat: |
523 |
return self.mtc_transform(value, attrformat, format, |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
524 |
self._cw.encoding) |
0 | 525 |
elif attrtype == 'Bytes': |
1360
13ae1121835e
rename attribute_metadata method to attr_metadata to save a few chars
sylvain.thenault@logilab.fr
parents:
1313
diff
changeset
|
526 |
attrformat = self.attr_metadata(attr, 'format') |
0 | 527 |
if attrformat: |
1360
13ae1121835e
rename attribute_metadata method to attr_metadata to save a few chars
sylvain.thenault@logilab.fr
parents:
1313
diff
changeset
|
528 |
encoding = self.attr_metadata(attr, 'encoding') |
0 | 529 |
return self.mtc_transform(value.getvalue(), attrformat, format, |
530 |
encoding) |
|
531 |
return u'' |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
532 |
value = printable_value(self._cw, attrtype, value, props, |
3212
07d11bacfefe
displaytime attribute should not have been removed from there
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3184
diff
changeset
|
533 |
displaytime=displaytime) |
0 | 534 |
if format == 'text/html': |
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2125
diff
changeset
|
535 |
value = xml_escape(value) |
0 | 536 |
return value |
537 |
||
538 |
def mtc_transform(self, data, format, target_format, encoding, |
|
539 |
_engine=ENGINE): |
|
540 |
trdata = TransformData(data, format, encoding, appobject=self) |
|
541 |
data = _engine.convert(trdata, target_format).decode() |
|
542 |
if format == 'text/html': |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
543 |
data = soup2xhtml(data, self._cw.encoding) |
0 | 544 |
return data |
1474 | 545 |
|
0 | 546 |
# entity cloning ########################################################## |
547 |
||
548 |
def copy_relations(self, ceid): |
|
3626
017869a514c3
[doc] updated docstrings
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
3552
diff
changeset
|
549 |
"""copy relations of the object with the given eid on this |
017869a514c3
[doc] updated docstrings
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
3552
diff
changeset
|
550 |
object (this method is called on the newly created copy, and |
017869a514c3
[doc] updated docstrings
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
3552
diff
changeset
|
551 |
ceid designates the original entity). |
0 | 552 |
|
553 |
By default meta and composite relations are skipped. |
|
554 |
Overrides this if you want another behaviour |
|
555 |
""" |
|
556 |
assert self.has_eid() |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
557 |
execute = self._cw.execute |
0 | 558 |
for rschema in self.e_schema.subject_relations(): |
3689
deb13e88e037
follow yams 0.25 api changes to improve performance
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3683
diff
changeset
|
559 |
if rschema.final or rschema.meta: |
0 | 560 |
continue |
561 |
# skip already defined relations |
|
562 |
if getattr(self, rschema.type): |
|
563 |
continue |
|
564 |
if rschema.type in self.skip_copy_for: |
|
565 |
continue |
|
566 |
# skip composite relation |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
567 |
rdef = self.e_schema.rdef(rschema) |
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
568 |
if rdef.composite: |
0 | 569 |
continue |
570 |
# skip relation with card in ?1 else we either change the copied |
|
571 |
# object (inlined relation) or inserting some inconsistency |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
572 |
if rdef.cardinality[1] in '?1': |
0 | 573 |
continue |
574 |
rql = 'SET X %s V WHERE X eid %%(x)s, Y eid %%(y)s, Y %s V' % ( |
|
575 |
rschema.type, rschema.type) |
|
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
576 |
execute(rql, {'x': self.eid, 'y': ceid}) |
0 | 577 |
self.clear_related_cache(rschema.type, 'subject') |
578 |
for rschema in self.e_schema.object_relations(): |
|
579 |
if rschema.meta: |
|
580 |
continue |
|
581 |
# skip already defined relations |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
582 |
if self.related(rschema.type, 'object'): |
0 | 583 |
continue |
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
584 |
rdef = self.e_schema.rdef(rschema, 'object') |
0 | 585 |
# skip composite relation |
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
586 |
if rdef.composite: |
0 | 587 |
continue |
588 |
# skip relation with card in ?1 else we either change the copied |
|
589 |
# object (inlined relation) or inserting some inconsistency |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
590 |
if rdef.cardinality[0] in '?1': |
0 | 591 |
continue |
592 |
rql = 'SET V %s X WHERE X eid %%(x)s, Y eid %%(y)s, V %s Y' % ( |
|
593 |
rschema.type, rschema.type) |
|
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
594 |
execute(rql, {'x': self.eid, 'y': ceid}) |
0 | 595 |
self.clear_related_cache(rschema.type, 'object') |
596 |
||
597 |
# data fetching methods ################################################### |
|
598 |
||
599 |
@cached |
|
600 |
def as_rset(self): |
|
601 |
"""returns a resultset containing `self` information""" |
|
602 |
rset = ResultSet([(self.eid,)], 'Any X WHERE X eid %(x)s', |
|
3376
f5c69485381f
[appobjects] use __regid__ instead of __id__, more explicit
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3369
diff
changeset
|
603 |
{'x': self.eid}, [(self.__regid__,)]) |
4850
bd640b137f50
[refactor] drop rset.vreg attribute, vreg should be accessed through rset.req. Also kill decorate_rset, simply set rset.req where we were calling this method.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4848
diff
changeset
|
604 |
rset.req = self._cw |
bd640b137f50
[refactor] drop rset.vreg attribute, vreg should be accessed through rset.req. Also kill decorate_rset, simply set rset.req where we were calling this method.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4848
diff
changeset
|
605 |
return rset |
1474 | 606 |
|
0 | 607 |
def to_complete_relations(self): |
608 |
"""by default complete final relations to when calling .complete()""" |
|
609 |
for rschema in self.e_schema.subject_relations(): |
|
3689
deb13e88e037
follow yams 0.25 api changes to improve performance
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3683
diff
changeset
|
610 |
if rschema.final: |
0 | 611 |
continue |
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
612 |
targets = rschema.objects(self.e_schema) |
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
613 |
if len(targets) > 1: |
0 | 614 |
# ambigous relations, the querier doesn't handle |
615 |
# outer join correctly in this case |
|
616 |
continue |
|
617 |
if rschema.inlined: |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
618 |
matching_groups = self._cw.user.matching_groups |
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
619 |
rdef = rschema.rdef(self.e_schema, targets[0]) |
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
620 |
if matching_groups(rdef.get_groups('read')) and \ |
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
621 |
all(matching_groups(e.get_groups('read')) for e in targets): |
0 | 622 |
yield rschema, 'subject' |
1474 | 623 |
|
4913
083b4d454192
server/web api for accessing to deleted_entites
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
4850
diff
changeset
|
624 |
def to_complete_attributes(self, skip_bytes=True, skip_pwd=True): |
0 | 625 |
for rschema, attrschema in self.e_schema.attribute_definitions(): |
626 |
# skip binary data by default |
|
627 |
if skip_bytes and attrschema.type == 'Bytes': |
|
628 |
continue |
|
629 |
attr = rschema.type |
|
630 |
if attr == 'eid': |
|
631 |
continue |
|
632 |
# password retreival is blocked at the repository server level |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
633 |
rdef = rschema.rdef(self.e_schema, attrschema) |
3890
d7a270f50f54
backport stable branch (one more time painfully)
Sylvain Thénault <sylvain.thenault@logilab.fr>
diff
changeset
|
634 |
if not self._cw.user.matching_groups(rdef.get_groups('read')) \ |
4913
083b4d454192
server/web api for accessing to deleted_entites
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
4850
diff
changeset
|
635 |
or (attrschema.type == 'Password' and skip_pwd): |
0 | 636 |
self[attr] = None |
637 |
continue |
|
638 |
yield attr |
|
1474 | 639 |
|
4408
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
640 |
_cw_completed = False |
4913
083b4d454192
server/web api for accessing to deleted_entites
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
4850
diff
changeset
|
641 |
def complete(self, attributes=None, skip_bytes=True, skip_pwd=True): |
0 | 642 |
"""complete this entity by adding missing attributes (i.e. query the |
643 |
repository to fill the entity) |
|
644 |
||
645 |
:type skip_bytes: bool |
|
646 |
:param skip_bytes: |
|
647 |
if true, attribute of type Bytes won't be considered |
|
648 |
""" |
|
649 |
assert self.has_eid() |
|
4408
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
650 |
if self._cw_completed: |
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
651 |
return |
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
652 |
if attributes is None: |
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
653 |
self._cw_completed = True |
0 | 654 |
varmaker = rqlvar_maker() |
655 |
V = varmaker.next() |
|
656 |
rql = ['WHERE %s eid %%(x)s' % V] |
|
657 |
selected = [] |
|
4913
083b4d454192
server/web api for accessing to deleted_entites
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
4850
diff
changeset
|
658 |
for attr in (attributes or self.to_complete_attributes(skip_bytes, skip_pwd)): |
0 | 659 |
# if attribute already in entity, nothing to do |
660 |
if self.has_key(attr): |
|
661 |
continue |
|
662 |
# case where attribute must be completed, but is not yet in entity |
|
663 |
var = varmaker.next() |
|
664 |
rql.append('%s %s %s' % (V, attr, var)) |
|
665 |
selected.append((attr, var)) |
|
666 |
# +1 since this doen't include the main variable |
|
667 |
lastattr = len(selected) + 1 |
|
668 |
if attributes is None: |
|
669 |
# fetch additional relations (restricted to 0..1 relations) |
|
670 |
for rschema, role in self.to_complete_relations(): |
|
671 |
rtype = rschema.type |
|
672 |
if self.relation_cached(rtype, role): |
|
673 |
continue |
|
674 |
var = varmaker.next() |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
675 |
targettype = rschema.targets(self.e_schema, role)[0] |
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
676 |
rdef = rschema.role_rdef(self.e_schema, targettype, role) |
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
677 |
card = rdef.role_cardinality(role) |
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
678 |
assert card in '1?', '%s %s %s %s' % (self.e_schema, rtype, |
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
679 |
role, card) |
0 | 680 |
if role == 'subject': |
681 |
if card == '1': |
|
682 |
rql.append('%s %s %s' % (V, rtype, var)) |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
683 |
else: |
0 | 684 |
rql.append('%s %s %s?' % (V, rtype, var)) |
685 |
else: |
|
686 |
if card == '1': |
|
687 |
rql.append('%s %s %s' % (var, rtype, V)) |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
688 |
else: |
0 | 689 |
rql.append('%s? %s %s' % (var, rtype, V)) |
690 |
selected.append(((rtype, role), var)) |
|
691 |
if selected: |
|
692 |
# select V, we need it as the left most selected variable |
|
693 |
# if some outer join are included to fetch inlined relations |
|
694 |
rql = 'Any %s,%s %s' % (V, ','.join(var for attr, var in selected), |
|
695 |
','.join(rql)) |
|
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
696 |
rset = self._cw.execute(rql, {'x': self.eid}, build_descr=False)[0] |
0 | 697 |
# handle attributes |
698 |
for i in xrange(1, lastattr): |
|
699 |
self[str(selected[i-1][0])] = rset[i] |
|
700 |
# handle relations |
|
701 |
for i in xrange(lastattr, len(rset)): |
|
2941
196493bd099c
[entity] use role instead of x
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2931
diff
changeset
|
702 |
rtype, role = selected[i-1][0] |
0 | 703 |
value = rset[i] |
704 |
if value is None: |
|
705 |
rrset = ResultSet([], rql, {'x': self.eid}) |
|
4850
bd640b137f50
[refactor] drop rset.vreg attribute, vreg should be accessed through rset.req. Also kill decorate_rset, simply set rset.req where we were calling this method.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4848
diff
changeset
|
706 |
rrset.req = self._cw |
0 | 707 |
else: |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
708 |
rrset = self._cw.eid_rset(value) |
2941
196493bd099c
[entity] use role instead of x
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2931
diff
changeset
|
709 |
self.set_related_cache(rtype, role, rrset) |
1474 | 710 |
|
0 | 711 |
def get_value(self, name): |
712 |
"""get value for the attribute relation <name>, query the repository |
|
713 |
to get the value if necessary. |
|
714 |
||
715 |
:type name: str |
|
716 |
:param name: name of the attribute to get |
|
717 |
""" |
|
718 |
try: |
|
719 |
value = self[name] |
|
720 |
except KeyError: |
|
721 |
if not self.is_saved(): |
|
722 |
return None |
|
723 |
rql = "Any A WHERE X eid %%(x)s, X %s A" % name |
|
724 |
try: |
|
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
725 |
rset = self._cw.execute(rql, {'x': self.eid}) |
0 | 726 |
except Unauthorized: |
727 |
self[name] = value = None |
|
728 |
else: |
|
729 |
assert rset.rowcount <= 1, (self, rql, rset.rowcount) |
|
730 |
try: |
|
731 |
self[name] = value = rset.rows[0][0] |
|
732 |
except IndexError: |
|
733 |
# probably a multisource error |
|
734 |
self.critical("can't get value for attribute %s of entity with eid %s", |
|
735 |
name, self.eid) |
|
736 |
if self.e_schema.destination(name) == 'String': |
|
2320 | 737 |
# XXX (syt) imo emtpy string is better |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
738 |
self[name] = value = self._cw._('unaccessible') |
0 | 739 |
else: |
740 |
self[name] = value = None |
|
741 |
return value |
|
742 |
||
743 |
def related(self, rtype, role='subject', limit=None, entities=False): |
|
744 |
"""returns a resultset of related entities |
|
1474 | 745 |
|
0 | 746 |
:param role: is the role played by 'self' in the relation ('subject' or 'object') |
747 |
:param limit: resultset's maximum size |
|
748 |
:param entities: if True, the entites are returned; if False, a result set is returned |
|
749 |
""" |
|
750 |
try: |
|
751 |
return self.related_cache(rtype, role, entities, limit) |
|
752 |
except KeyError: |
|
753 |
pass |
|
5757
e501806ab489
[entity] when .related() is called on a not-yet-saved entity, return an empty rset/list instead of raising an assertion error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5733
diff
changeset
|
754 |
if not self.has_eid(): |
e501806ab489
[entity] when .related() is called on a not-yet-saved entity, return an empty rset/list instead of raising an assertion error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5733
diff
changeset
|
755 |
if entities: |
e501806ab489
[entity] when .related() is called on a not-yet-saved entity, return an empty rset/list instead of raising an assertion error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5733
diff
changeset
|
756 |
return [] |
e501806ab489
[entity] when .related() is called on a not-yet-saved entity, return an empty rset/list instead of raising an assertion error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5733
diff
changeset
|
757 |
return self.empty_rset() |
0 | 758 |
rql = self.related_rql(rtype, role) |
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
759 |
rset = self._cw.execute(rql, {'x': self.eid}) |
0 | 760 |
self.set_related_cache(rtype, role, rset) |
761 |
return self.related(rtype, role, limit, entities) |
|
762 |
||
3130
2486163c4630
allow to specify targettypes in related_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3047
diff
changeset
|
763 |
def related_rql(self, rtype, role='subject', targettypes=None): |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
764 |
rschema = self._cw.vreg.schema[rtype] |
0 | 765 |
if role == 'subject': |
3672
554a588ffaea
[entity] make related_rql honors its targettypes argument
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3671
diff
changeset
|
766 |
restriction = 'E eid %%(x)s, E %s X' % rtype |
3130
2486163c4630
allow to specify targettypes in related_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3047
diff
changeset
|
767 |
if targettypes is None: |
2486163c4630
allow to specify targettypes in related_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3047
diff
changeset
|
768 |
targettypes = rschema.objects(self.e_schema) |
3672
554a588ffaea
[entity] make related_rql honors its targettypes argument
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3671
diff
changeset
|
769 |
else: |
3683
2e4794c97cf4
fix related_rql when target_type specified
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
3680
diff
changeset
|
770 |
restriction += ', X is IN (%s)' % ','.join(targettypes) |
0 | 771 |
card = greater_card(rschema, (self.e_schema,), targettypes, 0) |
772 |
else: |
|
3672
554a588ffaea
[entity] make related_rql honors its targettypes argument
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3671
diff
changeset
|
773 |
restriction = 'E eid %%(x)s, X %s E' % rtype |
3130
2486163c4630
allow to specify targettypes in related_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3047
diff
changeset
|
774 |
if targettypes is None: |
2486163c4630
allow to specify targettypes in related_rql
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3047
diff
changeset
|
775 |
targettypes = rschema.subjects(self.e_schema) |
3672
554a588ffaea
[entity] make related_rql honors its targettypes argument
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3671
diff
changeset
|
776 |
else: |
3683
2e4794c97cf4
fix related_rql when target_type specified
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
3680
diff
changeset
|
777 |
restriction += ', X is IN (%s)' % ','.join(targettypes) |
0 | 778 |
card = greater_card(rschema, targettypes, (self.e_schema,), 1) |
779 |
if len(targettypes) > 1: |
|
413
a7366dd3c33c
fix bug in entity.related_rql(): fetch_attr list / fetchorder weren't computed correctly
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
397
diff
changeset
|
780 |
fetchattrs_list = [] |
0 | 781 |
for ttype in targettypes: |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
782 |
etypecls = self._cw.vreg['etypes'].etype_class(ttype) |
413
a7366dd3c33c
fix bug in entity.related_rql(): fetch_attr list / fetchorder weren't computed correctly
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
397
diff
changeset
|
783 |
fetchattrs_list.append(set(etypecls.fetch_attrs)) |
a7366dd3c33c
fix bug in entity.related_rql(): fetch_attr list / fetchorder weren't computed correctly
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
397
diff
changeset
|
784 |
fetchattrs = reduce(set.intersection, fetchattrs_list) |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
785 |
rql = etypecls.fetch_rql(self._cw.user, [restriction], fetchattrs, |
0 | 786 |
settype=False) |
787 |
else: |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
788 |
etypecls = self._cw.vreg['etypes'].etype_class(targettypes[0]) |
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
789 |
rql = etypecls.fetch_rql(self._cw.user, [restriction], settype=False) |
0 | 790 |
# optimisation: remove ORDERBY if cardinality is 1 or ? (though |
791 |
# greater_card return 1 for those both cases) |
|
792 |
if card == '1': |
|
793 |
if ' ORDERBY ' in rql: |
|
794 |
rql = '%s WHERE %s' % (rql.split(' ORDERBY ', 1)[0], |
|
795 |
rql.split(' WHERE ', 1)[1]) |
|
796 |
elif not ' ORDERBY ' in rql: |
|
4630
528dee042927
fix #694445: related entity generates weird RQL which in turn generates weird SQL which fails on SQL Server
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4460
diff
changeset
|
797 |
args = rql.split(' WHERE ', 1) |
528dee042927
fix #694445: related entity generates weird RQL which in turn generates weird SQL which fails on SQL Server
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4460
diff
changeset
|
798 |
# if modification_date already retreived, we should use it instead |
528dee042927
fix #694445: related entity generates weird RQL which in turn generates weird SQL which fails on SQL Server
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4460
diff
changeset
|
799 |
# of adding another variable for sort. This should be be problematic |
528dee042927
fix #694445: related entity generates weird RQL which in turn generates weird SQL which fails on SQL Server
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4460
diff
changeset
|
800 |
# but it's actually with sqlserver, see ticket #694445 |
528dee042927
fix #694445: related entity generates weird RQL which in turn generates weird SQL which fails on SQL Server
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4460
diff
changeset
|
801 |
if 'X modification_date ' in args[1]: |
528dee042927
fix #694445: related entity generates weird RQL which in turn generates weird SQL which fails on SQL Server
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4460
diff
changeset
|
802 |
var = args[1].split('X modification_date ', 1)[1].split(',', 1)[0] |
528dee042927
fix #694445: related entity generates weird RQL which in turn generates weird SQL which fails on SQL Server
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4460
diff
changeset
|
803 |
args.insert(1, var.strip()) |
528dee042927
fix #694445: related entity generates weird RQL which in turn generates weird SQL which fails on SQL Server
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4460
diff
changeset
|
804 |
rql = '%s ORDERBY %s DESC WHERE %s' % tuple(args) |
528dee042927
fix #694445: related entity generates weird RQL which in turn generates weird SQL which fails on SQL Server
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4460
diff
changeset
|
805 |
else: |
528dee042927
fix #694445: related entity generates weird RQL which in turn generates weird SQL which fails on SQL Server
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4460
diff
changeset
|
806 |
rql = '%s ORDERBY Z DESC WHERE X modification_date Z, %s' % \ |
528dee042927
fix #694445: related entity generates weird RQL which in turn generates weird SQL which fails on SQL Server
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4460
diff
changeset
|
807 |
tuple(args) |
0 | 808 |
return rql |
1474 | 809 |
|
0 | 810 |
# generic vocabulary methods ############################################## |
811 |
||
812 |
def unrelated_rql(self, rtype, targettype, role, ordermethod=None, |
|
813 |
vocabconstraints=True): |
|
814 |
"""build a rql to fetch `targettype` entities unrelated to this entity |
|
3241
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
815 |
using (rtype, role) relation. |
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
816 |
|
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
817 |
Consider relation permissions so that returned entities may be actually |
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
818 |
linked by `rtype`. |
0 | 819 |
""" |
820 |
ordermethod = ordermethod or 'fetch_unrelated_order' |
|
821 |
if isinstance(rtype, basestring): |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
822 |
rtype = self._cw.vreg.schema.rschema(rtype) |
0 | 823 |
if role == 'subject': |
824 |
evar, searchedvar = 'S', 'O' |
|
825 |
subjtype, objtype = self.e_schema, targettype |
|
826 |
else: |
|
827 |
searchedvar, evar = 'S', 'O' |
|
828 |
objtype, subjtype = self.e_schema, targettype |
|
829 |
if self.has_eid(): |
|
830 |
restriction = ['NOT S %s O' % rtype, '%s eid %%(x)s' % evar] |
|
3241
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
831 |
args = {'x': self.eid} |
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
832 |
if role == 'subject': |
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
833 |
securitycheck_args = {'fromeid': self.eid} |
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
834 |
else: |
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
835 |
securitycheck_args = {'toeid': self.eid} |
0 | 836 |
else: |
837 |
restriction = [] |
|
3241
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
838 |
args = {} |
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
839 |
securitycheck_args = {} |
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
840 |
rdef = rtype.role_rdef(self.e_schema, targettype, role) |
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
841 |
insertsecurity = (rdef.has_local_role('add') and not |
3890
d7a270f50f54
backport stable branch (one more time painfully)
Sylvain Thénault <sylvain.thenault@logilab.fr>
diff
changeset
|
842 |
rdef.has_perm(self._cw, 'add', **securitycheck_args)) |
3961
d1cbf77db999
fix RQLUniqueConstraint behaviour by using a DISTINCT query and allowing
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3955
diff
changeset
|
843 |
# XXX consider constraint.mainvars to check if constraint apply |
0 | 844 |
if vocabconstraints: |
845 |
# RQLConstraint is a subclass for RQLVocabularyConstraint, so they |
|
846 |
# will be included as well |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
847 |
restriction += [cstr.restriction for cstr in rdef.constraints |
0 | 848 |
if isinstance(cstr, RQLVocabularyConstraint)] |
849 |
else: |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
850 |
restriction += [cstr.restriction for cstr in rdef.constraints |
0 | 851 |
if isinstance(cstr, RQLConstraint)] |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
852 |
etypecls = self._cw.vreg['etypes'].etype_class(targettype) |
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
853 |
rql = etypecls.fetch_rql(self._cw.user, restriction, |
0 | 854 |
mainvar=searchedvar, ordermethod=ordermethod) |
855 |
# ensure we have an order defined |
|
856 |
if not ' ORDERBY ' in rql: |
|
857 |
before, after = rql.split(' WHERE ', 1) |
|
858 |
rql = '%s ORDERBY %s WHERE %s' % (before, searchedvar, after) |
|
3241
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
859 |
if insertsecurity: |
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
860 |
rqlexprs = rdef.get_rqlexprs('add') |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
861 |
rewriter = RQLRewriter(self._cw) |
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
862 |
rqlst = self._cw.vreg.parse(self._cw, rql, args) |
3826
0c0c051863cb
close #511810: bad rql generated when looking for vocabulary for a relation on an entity which doesn't exist (yet)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3746
diff
changeset
|
863 |
if not self.has_eid(): |
0c0c051863cb
close #511810: bad rql generated when looking for vocabulary for a relation on an entity which doesn't exist (yet)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3746
diff
changeset
|
864 |
existant = searchedvar |
0c0c051863cb
close #511810: bad rql generated when looking for vocabulary for a relation on an entity which doesn't exist (yet)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3746
diff
changeset
|
865 |
else: |
0c0c051863cb
close #511810: bad rql generated when looking for vocabulary for a relation on an entity which doesn't exist (yet)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3746
diff
changeset
|
866 |
existant = None # instead of 'SO', improve perfs |
3241
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
867 |
for select in rqlst.children: |
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
868 |
rewriter.rewrite(select, [((searchedvar, searchedvar), rqlexprs)], |
3826
0c0c051863cb
close #511810: bad rql generated when looking for vocabulary for a relation on an entity which doesn't exist (yet)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3746
diff
changeset
|
869 |
select.solutions, args, existant) |
3241
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
870 |
rql = rqlst.as_string() |
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
871 |
return rql, args |
1474 | 872 |
|
0 | 873 |
def unrelated(self, rtype, targettype, role='subject', limit=None, |
874 |
ordermethod=None): |
|
875 |
"""return a result set of target type objects that may be related |
|
876 |
by a given relation, with self as subject or object |
|
877 |
""" |
|
3241
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
878 |
try: |
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
879 |
rql, args = self.unrelated_rql(rtype, targettype, role, ordermethod) |
1a6f7a0e7dbd
unrelated_rql now considers relation's add perm
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3212
diff
changeset
|
880 |
except Unauthorized: |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
881 |
return self._cw.empty_rset() |
0 | 882 |
if limit is not None: |
883 |
before, after = rql.split(' WHERE ', 1) |
|
884 |
rql = '%s LIMIT %s WHERE %s' % (before, limit, after) |
|
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
885 |
return self._cw.execute(rql, args) |
1474 | 886 |
|
0 | 887 |
# relations cache handling ################################################ |
1474 | 888 |
|
0 | 889 |
def relation_cached(self, rtype, role): |
890 |
"""return true if the given relation is already cached on the instance |
|
891 |
""" |
|
2647
b0a2e779845c
enable server side entity caching, 25% speedup on codenaf insertion. ALL CW TESTS OK
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2613
diff
changeset
|
892 |
return self._related_cache.get('%s_%s' % (rtype, role)) |
1474 | 893 |
|
0 | 894 |
def related_cache(self, rtype, role, entities=True, limit=None): |
895 |
"""return values for the given relation if it's cached on the instance, |
|
896 |
else raise `KeyError` |
|
897 |
""" |
|
898 |
res = self._related_cache['%s_%s' % (rtype, role)][entities] |
|
3680 | 899 |
if limit is not None and limit < len(res): |
0 | 900 |
if entities: |
901 |
res = res[:limit] |
|
902 |
else: |
|
903 |
res = res.limit(limit) |
|
904 |
return res |
|
1474 | 905 |
|
0 | 906 |
def set_related_cache(self, rtype, role, rset, col=0): |
907 |
"""set cached values for the given relation""" |
|
908 |
if rset: |
|
909 |
related = list(rset.entities(col)) |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
910 |
rschema = self._cw.vreg.schema.rschema(rtype) |
0 | 911 |
if role == 'subject': |
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
912 |
rcard = rschema.rdef(self.e_schema, related[0].e_schema).cardinality[1] |
0 | 913 |
target = 'object' |
914 |
else: |
|
3877
7ca53fc72a0a
reldefsecurity branch :
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3826
diff
changeset
|
915 |
rcard = rschema.rdef(related[0].e_schema, self.e_schema).cardinality[0] |
0 | 916 |
target = 'subject' |
917 |
if rcard in '?1': |
|
918 |
for rentity in related: |
|
3552
8facb3324170
[entity] put cached related entities as tuple to be sure no one is modifying
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3546
diff
changeset
|
919 |
rentity._related_cache['%s_%s' % (rtype, target)] = ( |
8facb3324170
[entity] put cached related entities as tuple to be sure no one is modifying
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3546
diff
changeset
|
920 |
self.as_rset(), (self,)) |
0 | 921 |
else: |
3552
8facb3324170
[entity] put cached related entities as tuple to be sure no one is modifying
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3546
diff
changeset
|
922 |
related = () |
0 | 923 |
self._related_cache['%s_%s' % (rtype, role)] = (rset, related) |
1474 | 924 |
|
0 | 925 |
def clear_related_cache(self, rtype=None, role=None): |
926 |
"""clear cached values for the given relation or the entire cache if |
|
927 |
no relation is given |
|
928 |
""" |
|
929 |
if rtype is None: |
|
930 |
self._related_cache = {} |
|
931 |
else: |
|
932 |
assert role |
|
933 |
self._related_cache.pop('%s_%s' % (rtype, role), None) |
|
1474 | 934 |
|
2942
77ebdbe93cf8
[entity] generic clear_all_caches methods, to use in test
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2941
diff
changeset
|
935 |
def clear_all_caches(self): |
4408
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
936 |
"""flush all caches on this entity. Further attributes/relations access |
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
937 |
will triggers new database queries to get back values. |
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
938 |
|
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
939 |
If you use custom caches on your entity class (take care to @cached!), |
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
940 |
you should override this method to clear them as well. |
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
941 |
""" |
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
942 |
# clear attributes cache |
3665
42f3a66cab51
fix clear_all_cache: ensure we don't remove eid from entity's dict
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3664
diff
changeset
|
943 |
haseid = 'eid' in self |
4408
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
944 |
self._cw_completed = False |
2942
77ebdbe93cf8
[entity] generic clear_all_caches methods, to use in test
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2941
diff
changeset
|
945 |
self.clear() |
4408
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
946 |
# clear relations cache |
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
947 |
for rschema, _, role in self.e_schema.relation_definitions(): |
899b426087ab
[entity] small optimization: once an entity has been completed, don't redo it (for nothing)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4406
diff
changeset
|
948 |
self.clear_related_cache(rschema.type, role) |
4460
5c22869079b9
clear rest_path __unique cache in clear_all_caches, fix related test
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4451
diff
changeset
|
949 |
# rest path unique cache |
5c22869079b9
clear rest_path __unique cache in clear_all_caches, fix related test
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4451
diff
changeset
|
950 |
try: |
5c22869079b9
clear rest_path __unique cache in clear_all_caches, fix related test
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4451
diff
changeset
|
951 |
del self.__unique |
5c22869079b9
clear rest_path __unique cache in clear_all_caches, fix related test
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4451
diff
changeset
|
952 |
except AttributeError: |
5c22869079b9
clear rest_path __unique cache in clear_all_caches, fix related test
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4451
diff
changeset
|
953 |
pass |
4759 | 954 |
|
0 | 955 |
# raw edition utilities ################################################### |
1474 | 956 |
|
4835
13b0b96d7982
[repo] enhanced security handling: deprecates unsafe_execute, in favor of explicit read/write security control using the `enabled_security` context manager. Also code executed on the repository side is now unsafe by default.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4831
diff
changeset
|
957 |
def set_attributes(self, **kwargs): |
5115
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
958 |
_check_cw_unsafe(kwargs) |
0 | 959 |
assert kwargs |
5127
3c2dda44e2f6
[entity] explain why the assert failed
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5115
diff
changeset
|
960 |
assert self._is_saved, "should not call set_attributes while entity "\ |
3c2dda44e2f6
[entity] explain why the assert failed
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5115
diff
changeset
|
961 |
"hasn't been saved yet" |
0 | 962 |
relations = [] |
963 |
for key in kwargs: |
|
964 |
relations.append('X %s %%(%s)s' % (key, key)) |
|
397
cf577e26f924
don't introduce a spurious 'x' key in the entity-as dict
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
237
diff
changeset
|
965 |
# and now update the database |
0 | 966 |
kwargs['x'] = self.eid |
4835
13b0b96d7982
[repo] enhanced security handling: deprecates unsafe_execute, in favor of explicit read/write security control using the `enabled_security` context manager. Also code executed on the repository side is now unsafe by default.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4831
diff
changeset
|
967 |
self._cw.execute('SET %s WHERE X eid %%(x)s' % ','.join(relations), |
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
968 |
kwargs) |
5115
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
969 |
kwargs.pop('x') |
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
970 |
# update current local object _after_ the rql query to avoid |
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
971 |
# interferences between the query execution itself and the |
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
972 |
# edited_attributes / skip_security_attributes machinery |
2e43ef618d14
[repository] forbid usage of set_attributes() in before_add_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5009
diff
changeset
|
973 |
self.update(kwargs) |
1474 | 974 |
|
4835
13b0b96d7982
[repo] enhanced security handling: deprecates unsafe_execute, in favor of explicit read/write security control using the `enabled_security` context manager. Also code executed on the repository side is now unsafe by default.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4831
diff
changeset
|
975 |
def set_relations(self, **kwargs): |
3955
235a9fda6058
support x.set_relations(a_relation=None) to delete a_relation relations from this entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3919
diff
changeset
|
976 |
"""add relations to the given object. To set a relation where this entity |
235a9fda6058
support x.set_relations(a_relation=None) to delete a_relation relations from this entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3919
diff
changeset
|
977 |
is the object of the relation, use 'reverse_'<relation> as argument name. |
235a9fda6058
support x.set_relations(a_relation=None) to delete a_relation relations from this entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3919
diff
changeset
|
978 |
|
5144
5a09bea07302
[doc/book] a new chapter on how to use the ORM
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5127
diff
changeset
|
979 |
Values may be an entity, a list of entities, or None (meaning that all |
3955
235a9fda6058
support x.set_relations(a_relation=None) to delete a_relation relations from this entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3919
diff
changeset
|
980 |
relations of the given type from or to this object should be deleted). |
235a9fda6058
support x.set_relations(a_relation=None) to delete a_relation relations from this entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3919
diff
changeset
|
981 |
""" |
235a9fda6058
support x.set_relations(a_relation=None) to delete a_relation relations from this entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3919
diff
changeset
|
982 |
# XXX update cache |
4835
13b0b96d7982
[repo] enhanced security handling: deprecates unsafe_execute, in favor of explicit read/write security control using the `enabled_security` context manager. Also code executed on the repository side is now unsafe by default.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4831
diff
changeset
|
983 |
_check_cw_unsafe(kwargs) |
3671
c765adac7f5c
new set_relations method on entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3665
diff
changeset
|
984 |
for attr, values in kwargs.iteritems(): |
c765adac7f5c
new set_relations method on entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3665
diff
changeset
|
985 |
if attr.startswith('reverse_'): |
c765adac7f5c
new set_relations method on entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3665
diff
changeset
|
986 |
restr = 'Y %s X' % attr[len('reverse_'):] |
c765adac7f5c
new set_relations method on entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3665
diff
changeset
|
987 |
else: |
c765adac7f5c
new set_relations method on entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3665
diff
changeset
|
988 |
restr = 'X %s Y' % attr |
3955
235a9fda6058
support x.set_relations(a_relation=None) to delete a_relation relations from this entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3919
diff
changeset
|
989 |
if values is None: |
4991
16f0cec3d008
[entity] fix dumb name error on .set_relations(rel=None)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4990
diff
changeset
|
990 |
self._cw.execute('DELETE %s WHERE X eid %%(x)s' % restr, |
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
991 |
{'x': self.eid}) |
3955
235a9fda6058
support x.set_relations(a_relation=None) to delete a_relation relations from this entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3919
diff
changeset
|
992 |
continue |
3746
74192424b2c8
accepts single values as create_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3689
diff
changeset
|
993 |
if not isinstance(values, (tuple, list, set, frozenset)): |
74192424b2c8
accepts single values as create_entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3689
diff
changeset
|
994 |
values = (values,) |
4835
13b0b96d7982
[repo] enhanced security handling: deprecates unsafe_execute, in favor of explicit read/write security control using the `enabled_security` context manager. Also code executed on the repository side is now unsafe by default.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4831
diff
changeset
|
995 |
self._cw.execute('SET %s WHERE X eid %%(x)s, Y eid IN (%s)' % ( |
3671
c765adac7f5c
new set_relations method on entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3665
diff
changeset
|
996 |
restr, ','.join(str(r.eid) for r in values)), |
5174
78438ad513ca
#759035: Automate addition of eid cachekey in RQL analysis
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5144
diff
changeset
|
997 |
{'x': self.eid}) |
3671
c765adac7f5c
new set_relations method on entity
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3665
diff
changeset
|
998 |
|
4835
13b0b96d7982
[repo] enhanced security handling: deprecates unsafe_execute, in favor of explicit read/write security control using the `enabled_security` context manager. Also code executed on the repository side is now unsafe by default.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4831
diff
changeset
|
999 |
def delete(self, **kwargs): |
0 | 1000 |
assert self.has_eid(), self.eid |
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
1001 |
self._cw.execute('DELETE %s X WHERE X eid %%(x)s' % self.e_schema, |
4835
13b0b96d7982
[repo] enhanced security handling: deprecates unsafe_execute, in favor of explicit read/write security control using the `enabled_security` context manager. Also code executed on the repository side is now unsafe by default.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4831
diff
changeset
|
1002 |
{'x': self.eid}, **kwargs) |
1474 | 1003 |
|
0 | 1004 |
# server side utilities ################################################### |
1474 | 1005 |
|
4970
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
1006 |
@property |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
1007 |
def skip_security_attributes(self): |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
1008 |
try: |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
1009 |
return self._skip_security_attributes |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
1010 |
except: |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
1011 |
self._skip_security_attributes = set() |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
1012 |
return self._skip_security_attributes |
1f3d8946ea84
fix security issue introduced by 4967:04543ed0bbdc: attributes explicitly set by hooks should not be checked by security hooks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4965
diff
changeset
|
1013 |
|
0 | 1014 |
def set_defaults(self): |
1015 |
"""set default values according to the schema""" |
|
1016 |
for attr, value in self.e_schema.defaults(): |
|
1017 |
if not self.has_key(attr): |
|
1018 |
self[str(attr)] = value |
|
1019 |
||
1020 |
def check(self, creation=False): |
|
1021 |
"""check this entity against its schema. Only final relation |
|
1022 |
are checked here, constraint on actual relations are checked in hooks |
|
1023 |
""" |
|
1024 |
# necessary since eid is handled specifically and yams require it to be |
|
1025 |
# in the dictionary |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
1026 |
if self._cw is None: |
0 | 1027 |
_ = unicode |
1028 |
else: |
|
3378
2f25f701301d
use ._cw instead of req on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3376
diff
changeset
|
1029 |
_ = self._cw._ |
4988
d85f639e9150
[yams] on creation, specify relations anyway so we don't get spurious warning for accessing eid through the dict api on yams validation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4970
diff
changeset
|
1030 |
if creation: |
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
1031 |
# on creations, we want to check all relations, especially |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
1032 |
# required attributes |
4988
d85f639e9150
[yams] on creation, specify relations anyway so we don't get spurious warning for accessing eid through the dict api on yams validation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4970
diff
changeset
|
1033 |
relations = [rschema for rschema in self.e_schema.subject_relations() |
d85f639e9150
[yams] on creation, specify relations anyway so we don't get spurious warning for accessing eid through the dict api on yams validation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4970
diff
changeset
|
1034 |
if rschema.final and rschema.type != 'eid'] |
d85f639e9150
[yams] on creation, specify relations anyway so we don't get spurious warning for accessing eid through the dict api on yams validation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4970
diff
changeset
|
1035 |
elif hasattr(self, 'edited_attributes'): |
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
1036 |
relations = [self._cw.vreg.schema.rschema(rtype) |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
1037 |
for rtype in self.edited_attributes] |
4988
d85f639e9150
[yams] on creation, specify relations anyway so we don't get spurious warning for accessing eid through the dict api on yams validation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4970
diff
changeset
|
1038 |
else: |
d85f639e9150
[yams] on creation, specify relations anyway so we don't get spurious warning for accessing eid through the dict api on yams validation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4970
diff
changeset
|
1039 |
relations = None |
4965
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
1040 |
self.e_schema.check(self, creation=creation, _=_, |
04543ed0bbdc
[source] only consider edited_attributes in source.preprocess_entity()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4913
diff
changeset
|
1041 |
relations=relations) |
0 | 1042 |
|
1043 |
def fti_containers(self, _done=None): |
|
1044 |
if _done is None: |
|
1045 |
_done = set() |
|
1046 |
_done.add(self.eid) |
|
1047 |
containers = tuple(self.e_schema.fulltext_containers()) |
|
1048 |
if containers: |
|
1049 |
for rschema, target in containers: |
|
1050 |
if target == 'object': |
|
1051 |
targets = getattr(self, rschema.type) |
|
1052 |
else: |
|
1053 |
targets = getattr(self, 'reverse_%s' % rschema) |
|
1054 |
for entity in targets: |
|
1055 |
if entity.eid in _done: |
|
1056 |
continue |
|
1057 |
for container in entity.fti_containers(_done): |
|
1058 |
yield container |
|
476
62968fa8845c
yield self if no ft container found
sylvain.thenault@logilab.fr
parents:
475
diff
changeset
|
1059 |
yielded = True |
0 | 1060 |
else: |
1061 |
yield self |
|
1474 | 1062 |
|
0 | 1063 |
def get_words(self): |
1064 |
"""used by the full text indexer to get words to index |
|
1065 |
||
1066 |
this method should only be used on the repository side since it depends |
|
4848
41f84eea63c9
rename logilab.db into logilab.database
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4835
diff
changeset
|
1067 |
on the logilab.database package |
1474 | 1068 |
|
0 | 1069 |
:rtype: list |
1070 |
:return: the list of indexable word of this entity |
|
1071 |
""" |
|
4848
41f84eea63c9
rename logilab.db into logilab.database
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4835
diff
changeset
|
1072 |
from logilab.database.fti import tokenize |
3546
f0aecddf367e
fix bug when renaming a full text indexed attribute
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3316
diff
changeset
|
1073 |
# take care to cases where we're modyfying the schema |
3649
59eb710b9862
3.6 updates
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3629
diff
changeset
|
1074 |
pending = self._cw.transaction_data.setdefault('pendingrdefs', set()) |
0 | 1075 |
words = [] |
1076 |
for rschema in self.e_schema.indexable_attributes(): |
|
3546
f0aecddf367e
fix bug when renaming a full text indexed attribute
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3316
diff
changeset
|
1077 |
if (self.e_schema, rschema) in pending: |
f0aecddf367e
fix bug when renaming a full text indexed attribute
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3316
diff
changeset
|
1078 |
continue |
0 | 1079 |
try: |
1080 |
value = self.printable_value(rschema, format='text/plain') |
|
1132 | 1081 |
except TransformError: |
0 | 1082 |
continue |
1083 |
except: |
|
1084 |
self.exception("can't add value of %s to text index for entity %s", |
|
1085 |
rschema, self.eid) |
|
1086 |
continue |
|
1087 |
if value: |
|
1088 |
words += tokenize(value) |
|
1089 |
for rschema, role in self.e_schema.fulltext_relations(): |
|
1090 |
if role == 'subject': |
|
1091 |
for entity in getattr(self, rschema.type): |
|
1092 |
words += entity.get_words() |
|
1093 |
else: # if role == 'object': |
|
1094 |
for entity in getattr(self, 'reverse_%s' % rschema.type): |
|
1095 |
words += entity.get_words() |
|
1096 |
return words |
|
1097 |
||
1098 |
||
1099 |
# attribute and relation descriptors ########################################## |
|
1100 |
||
1101 |
class Attribute(object): |
|
1102 |
"""descriptor that controls schema attribute access""" |
|
1103 |
||
1104 |
def __init__(self, attrname): |
|
1105 |
assert attrname != 'eid' |
|
1106 |
self._attrname = attrname |
|
1107 |
||
1108 |
def __get__(self, eobj, eclass): |
|
1109 |
if eobj is None: |
|
1110 |
return self |
|
1111 |
return eobj.get_value(self._attrname) |
|
1112 |
||
1113 |
def __set__(self, eobj, value): |
|
1114 |
eobj[self._attrname] = value |
|
1115 |
||
1116 |
class Relation(object): |
|
1117 |
"""descriptor that controls schema relation access""" |
|
1118 |
_role = None # for pylint |
|
1119 |
||
1120 |
def __init__(self, rschema): |
|
1121 |
self._rschema = rschema |
|
1122 |
self._rtype = rschema.type |
|
1123 |
||
1124 |
def __get__(self, eobj, eclass): |
|
1125 |
if eobj is None: |
|
1126 |
raise AttributeError('%s cannot be only be accessed from instances' |
|
1127 |
% self._rtype) |
|
1128 |
return eobj.related(self._rtype, self._role, entities=True) |
|
1474 | 1129 |
|
0 | 1130 |
def __set__(self, eobj, value): |
1131 |
raise NotImplementedError |
|
1132 |
||
1133 |
||
1134 |
class SubjectRelation(Relation): |
|
1135 |
"""descriptor that controls schema relation access""" |
|
1136 |
_role = 'subject' |
|
1474 | 1137 |
|
0 | 1138 |
class ObjectRelation(Relation): |
1139 |
"""descriptor that controls schema relation access""" |
|
1140 |
_role = 'object' |
|
1141 |
||
1142 |
from logging import getLogger |
|
1143 |
from cubicweb import set_log_methods |
|
1144 |
set_log_methods(Entity, getLogger('cubicweb.entity')) |