entity.py 60.6 KB
Newer Older
Sylvain Thénault's avatar
Sylvain Thénault committed
1
# copyright 2003-2016 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
2
3
4
5
6
7
8
9
10
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of CubicWeb.
#
# CubicWeb is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
#
11
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
12
13
14
15
16
17
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
18
"""Base class for entity objects manipulated in clients"""
Adrien Di Mascio's avatar
Adrien Di Mascio committed
19

20
21
from warnings import warn

22
from six import text_type, string_types, integer_types
23
24
from six.moves import range

Adrien Di Mascio's avatar
Adrien Di Mascio committed
25
from logilab.common.decorators import cached
26
from logilab.common.deprecation import deprecated
27
from logilab.common.registry import yes
Pierre-Yves David's avatar
Pierre-Yves David committed
28
from logilab.mtconverter import TransformData, xml_escape
29

Adrien Di Mascio's avatar
Adrien Di Mascio committed
30
from rql.utils import rqlvar_maker
31
32
33
from rql.stmts import Select
from rql.nodes import (Not, VariableRef, Constant, make_relation,
                       Relation as RqlRelation)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
34

35
from cubicweb import Unauthorized, neg_role
36
from cubicweb.utils import support_args
Adrien Di Mascio's avatar
Adrien Di Mascio committed
37
from cubicweb.rset import ResultSet
38
from cubicweb.appobject import AppObject
39
40
from cubicweb.schema import (RQLVocabularyConstraint, RQLConstraint,
                             GeneratedConstraint)
41
from cubicweb.rqlrewrite import RQLRewriter
42

43
from cubicweb.uilib import soup2xhtml
Sylvain Thénault's avatar
Sylvain Thénault committed
44
from cubicweb.mttransforms import ENGINE
Adrien Di Mascio's avatar
Adrien Di Mascio committed
45
46
47

_marker = object()

Sylvain Thénault's avatar
Sylvain Thénault committed
48

Adrien Di Mascio's avatar
Adrien Di Mascio committed
49
50
51
def greater_card(rschema, subjtypes, objtypes, index):
    for subjtype in subjtypes:
        for objtype in objtypes:
Sylvain Thénault's avatar
Sylvain Thénault committed
52
            card = rschema.rdef(subjtype, objtype).cardinality[index]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
53
54
55
56
            if card in '+*':
                return card
    return '1'

57
58
59
60
def can_use_rest_path(value):
    """return True if value can be used at the end of a Rest URL path"""
    if value is None:
        return False
61
    value = text_type(value)
62
63
64
65
66
67
    # the check for ?, /, & are to prevent problems when running
    # behind Apache mod_proxy
    if value == u'' or u'?' in value or u'/' in value or u'&' in value:
        return False
    return True

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
def rel_vars(rel):
    return ((isinstance(rel.children[0], VariableRef)
             and rel.children[0].variable or None),
            (isinstance(rel.children[1].children[0], VariableRef)
             and rel.children[1].children[0].variable or None)
            )

def rel_matches(rel, rtype, role, varname, operator='='):
    if rel.r_type == rtype and rel.children[1].operator == operator:
        same_role_var_idx = 0 if role == 'subject' else 1
        variables = rel_vars(rel)
        if variables[same_role_var_idx].name == varname:
            return variables[1 - same_role_var_idx]

def build_cstr_with_linkto_infos(cstr, args, searchedvar, evar,
                                 lt_infos, eidvars):
    """restrict vocabulary as much as possible in entity creation,
    based on infos provided by __linkto form param.

    Example based on following schema:

      class works_in(RelationDefinition):
          subject = 'CWUser'
          object = 'Lab'
          cardinality = '1*'
          constraints = [RQLConstraint('S in_group G, O welcomes G')]

      class welcomes(RelationDefinition):
          subject = 'Lab'
          object = 'CWGroup'

    If you create a CWUser in the "scientists" CWGroup you can show
    only the labs that welcome them using :

      lt_infos = {('in_group', 'subject'): 321}

    You get following restriction : 'O welcomes G, G eid 321'

    """
    st = cstr.snippet_rqlst.copy()
    # replace relations in ST by eid infos from linkto where possible
109
    for (info_rtype, info_role), eids in lt_infos.items():
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
        eid = eids[0] # NOTE: we currently assume a pruned lt_info with only 1 eid
        for rel in st.iget_nodes(RqlRelation):
            targetvar = rel_matches(rel, info_rtype, info_role, evar.name)
            if targetvar is not None:
                if targetvar.name in eidvars:
                    rel.parent.remove(rel)
                else:
                    eidrel = make_relation(
                        targetvar, 'eid', (targetvar.name, 'Substitute'),
                        Constant)
                    rel.parent.replace(rel, eidrel)
                    args[targetvar.name] = eid
                    eidvars.add(targetvar.name)
    # if modified ST still contains evar references we must discard the
    # constraint, otherwise evar is unknown in the final rql query which can
    # lead to a SQL table cartesian product and multiple occurences of solutions
    evarname = evar.name
    for rel in st.iget_nodes(RqlRelation):
        for variable in rel_vars(rel):
            if variable and evarname == variable.name:
                return
    # else insert snippets into the global tree
    return GeneratedConstraint(st, cstr.mainvars - set(evarname))

def pruned_lt_info(eschema, lt_infos):
    pruned = {}
136
    for (lt_rtype, lt_role), eids in lt_infos.items():
137
138
139
140
141
142
143
144
145
146
        # we can only use lt_infos describing relation with a cardinality
        # of value 1 towards the linked entity
        if not len(eids) == 1:
            continue
        lt_card = eschema.rdef(lt_rtype, lt_role).cardinality[
            0 if lt_role == 'subject' else 1]
        if lt_card not in '?1':
            continue
        pruned[(lt_rtype, lt_role)] = eids
    return pruned
147

148

149
class Entity(AppObject):
150
151
    """an entity instance has e_schema automagically set on
    the class and instances has access to their issuing cursor.
152

153
    A property is set for each attribute and relation on each entity's type
Sylvain Thénault's avatar
Sylvain Thénault committed
154
    class. Becare that among attributes, 'eid' is *NEVER* stored in the
155
156
    dict containment (which acts as a cache for other attributes dynamically
    fetched)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
157
158
159
160

    :type e_schema: `cubicweb.schema.EntitySchema`
    :ivar e_schema: the entity's schema

161
162
163
164
    :type rest_attr: str
    :cvar rest_attr: indicates which attribute should be used to build REST urls
       If `None` is specified (the default), the first unique attribute will
       be used ('eid' if none found)
165

166
167
    :type cw_skip_copy_for: list
    :cvar cw_skip_copy_for: a list of couples (rtype, role) for each relation
168
169
170
       that should be skipped when copying this kind of entity. Note that some
       relations such as composite relations or relations that have '?1' as
       object cardinality are always skipped.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
171
172
    """
    __registry__ = 'etypes'
173
    __select__ = yes()
174

175
    # class attributes that must be set in class definition
Adrien Di Mascio's avatar
Adrien Di Mascio committed
176
    rest_attr = None
177
    fetch_attrs = None
178
179
    skip_copy_for = () # bw compat (< 3.14), use cw_skip_copy_for instead
    cw_skip_copy_for = [('in_state', 'subject')]
180
181
    # class attributes set automatically at registration time
    e_schema = None
182

Adrien Di Mascio's avatar
Adrien Di Mascio committed
183
    @classmethod
184
    def __initialize__(cls, schema):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
185
186
187
        """initialize a specific entity class by adding descriptors to access
        entity type's attributes and relations
        """
188
        etype = cls.__regid__
Adrien Di Mascio's avatar
Adrien Di Mascio committed
189
        assert etype != 'Any', etype
190
        cls.e_schema = eschema = schema.eschema(etype)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
191
        for rschema, _ in eschema.attribute_definitions():
192
            if rschema.type == 'eid':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
193
                continue
194
            setattr(cls, rschema.type, Attribute(rschema.type))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
195
        mixins = []
196
197
        for rschema, _, role in eschema.relation_definitions():
            if role == 'subject':
198
                attr = rschema.type
Adrien Di Mascio's avatar
Adrien Di Mascio committed
199
            else:
200
                attr = 'reverse_%s' % rschema.type
201
            setattr(cls, attr, Relation(rschema, role))
202

203
    fetch_attrs = ('modification_date',)
204

205
    @classmethod
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
    def cw_fetch_order(cls, select, attr, var):
        """This class method may be used to control sort order when multiple
        entities of this type are fetched through ORM methods. Its arguments
        are:

        * `select`, the RQL syntax tree

        * `attr`, the attribute being watched

        * `var`, the variable through which this attribute's value may be
          accessed in the query

        When you want to do some sorting on the given attribute, you should
        modify the syntax tree accordingly. For instance:

        .. sourcecode:: python

          from rql import nodes

          class Version(AnyEntity):
              __regid__ = 'Version'

              fetch_attrs = ('num', 'description', 'in_state')

              @classmethod
              def cw_fetch_order(cls, select, attr, var):
                  if attr == 'num':
                      func = nodes.Function('version_sort_value')
                      func.append(nodes.variable_ref(var))
                      sterm = nodes.SortTerm(func, asc=False)
                      select.add_sort_term(sterm)

        The default implementation call
        :meth:`~cubicweb.entity.Entity.cw_fetch_unrelated_order`
240
        """
241
        cls.cw_fetch_unrelated_order(select, attr, var)
242
243

    @classmethod
244
245
246
    def cw_fetch_unrelated_order(cls, select, attr, var):
        """This class method may be used to control sort order when multiple entities of
        this type are fetched to use in edition (e.g. propose them to create a
247
        new relation on an edited entity).
248
249
250
251
252
253

        See :meth:`~cubicweb.entity.Entity.cw_fetch_unrelated_order` for a
        description of its arguments and usage.

        By default entities will be listed on their modification date descending,
        i.e. you'll get entities recently modified first.
254
255
        """
        if attr == 'modification_date':
256
            select.add_sort_var(var, asc=False)
257

Adrien Di Mascio's avatar
Adrien Di Mascio committed
258
259
260
    @classmethod
    def fetch_rql(cls, user, restriction=None, fetchattrs=None, mainvar='X',
                  settype=True, ordermethod='fetch_order'):
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
        st = cls.fetch_rqlst(user, mainvar=mainvar, fetchattrs=fetchattrs,
                             settype=settype, ordermethod=ordermethod)
        rql = st.as_string()
        if restriction:
            # cannot use RQLRewriter API to insert 'X rtype %(x)s' restriction
            warn('[3.14] fetch_rql: use of `restriction` parameter is '
                 'deprecated, please use fetch_rqlst and supply a syntax'
                 'tree with your restriction instead', DeprecationWarning)
            insert = ' WHERE ' + ','.join(restriction)
            if ' WHERE ' in rql:
                select, where = rql.split(' WHERE ', 1)
                rql = select + insert + ',' + where
            else:
                rql += insert
        return rql

    @classmethod
    def fetch_rqlst(cls, user, select=None, mainvar='X', fetchattrs=None,
                    settype=True, ordermethod='fetch_order'):
        if select is None:
            select = Select()
            mainvar = select.get_variable(mainvar)
            select.add_selected(mainvar)
284
        elif isinstance(mainvar, string_types):
285
286
287
288
289
            assert mainvar in select.defined_vars
            mainvar = select.get_variable(mainvar)
        # eases string -> syntax tree test transition: please remove once stable
        select._varmaker = rqlvar_maker(defined=select.defined_vars,
                                        aliases=select.aliases, index=26)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
290
        if settype:
291
292
293
294
            rel = select.add_type_restriction(mainvar, cls.__regid__)
            # should use 'is_instance_of' instead of 'is' so we retrieve
            # subclasses instances as well
            rel.r_type = 'is_instance_of'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
295
296
        if fetchattrs is None:
            fetchattrs = cls.fetch_attrs
297
298
        cls._fetch_restrictions(mainvar, select, fetchattrs, user, ordermethod)
        return select
299

300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
    @classmethod
    def _fetch_ambiguous_rtypes(cls, select, var, fetchattrs, subjtypes, schema):
        """find rtypes in `fetchattrs` that relate different subject etypes
        taken from (`subjtypes`) to different target etypes; these so called
        "ambiguous" relations, are added directly to the `select` syntax tree
        selection but removed from `fetchattrs` to avoid the fetch recursion
        because we have to choose only one targettype for the recursion and
        adding its own fetch attrs to the selection -when we recurse- would
        filter out the other possible target types from the result set
        """
        for attr in fetchattrs.copy():
            rschema = schema.rschema(attr)
            if rschema.final:
                continue
            ttypes = None
            for subjtype in subjtypes:
                cur_ttypes = set(rschema.objects(subjtype))
                if ttypes is None:
                    ttypes = cur_ttypes
                elif cur_ttypes != ttypes:
                    # we found an ambiguous relation: remove it from fetchattrs
                    fetchattrs.remove(attr)
                    # ... and add it to the selection
                    targetvar = select.make_variable()
                    select.add_selected(targetvar)
                    rel = make_relation(var, attr, (targetvar,), VariableRef)
                    select.add_restriction(rel)
                    break

Adrien Di Mascio's avatar
Adrien Di Mascio committed
329
    @classmethod
330
331
    def _fetch_restrictions(cls, mainvar, select, fetchattrs,
                            user, ordermethod='fetch_order', visited=None):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
332
333
334
335
336
337
338
339
        eschema = cls.e_schema
        if visited is None:
            visited = set((eschema.type,))
        elif eschema.type in visited:
            # avoid infinite recursion
            return
        else:
            visited.add(eschema.type)
340
        for attr in sorted(fetchattrs):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
341
            try:
342
                rschema = eschema.subjrels[attr]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
343
344
            except KeyError:
                cls.warning('skipping fetch_attr %s defined in %s (not found in schema)',
345
                            attr, cls.__regid__)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
346
                continue
347
348
            # XXX takefirst=True to remove warning triggered by ambiguous inlined relations
            rdef = eschema.rdef(attr, takefirst=True)
Sylvain Thénault's avatar
Sylvain Thénault committed
349
            if not user.matching_groups(rdef.get_groups('read')):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
350
                continue
351
352
353
354
355
356
357
358
359
            if rschema.final or rdef.cardinality[0] in '?1':
                var = select.make_variable()
                select.add_selected(var)
                rel = make_relation(mainvar, attr, (var,), VariableRef)
                select.add_restriction(rel)
            else:
                cls.warning('bad relation %s specified in fetch attrs for %s',
                            attr, cls)
                continue
360
            if not rschema.final:
361
362
363
364
                # XXX we need outer join in case the relation is not mandatory
                # (card == '?')  *or if the entity is being added*, since in
                # that case the relation may still be missing. As we miss this
                # later information here, systematically add it.
365
                rel.change_optional('right')
366
                targettypes = rschema.objects(eschema.type)
367
                vreg = user._cw.vreg  # XXX user._cw.vreg iiiirk
368
                etypecls = vreg['etypes'].etype_class(targettypes[0])
369
370
                if len(targettypes) > 1:
                    # find fetch_attrs common to all destination types
371
                    fetchattrs = vreg['etypes'].fetch_attrs(targettypes)
Sylvain Thénault's avatar
Sylvain Thénault committed
372
                    # ... and handle ambiguous relations
373
374
                    cls._fetch_ambiguous_rtypes(select, var, fetchattrs,
                                                targettypes, vreg.schema)
375
376
                else:
                    fetchattrs = etypecls.fetch_attrs
377
                etypecls._fetch_restrictions(var, select, fetchattrs,
378
                                             user, None, visited=visited)
379
            if ordermethod is not None:
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
                try:
                    cmeth = getattr(cls, ordermethod)
                    warn('[3.14] %s %s class method should be renamed to cw_%s'
                         % (cls.__regid__, ordermethod, ordermethod),
                         DeprecationWarning)
                except AttributeError:
                    cmeth = getattr(cls, 'cw_' + ordermethod)
                if support_args(cmeth, 'select'):
                    cmeth(select, attr, var)
                else:
                    warn('[3.14] %s should now take (select, attr, var) and '
                         'modify the syntax tree when desired instead of '
                         'returning something' % cmeth, DeprecationWarning)
                    orderterm = cmeth(attr, var.name)
                    if orderterm is not None:
                        try:
                            var, order = orderterm.split()
                        except ValueError:
                            if '(' in orderterm:
399
400
                                cls.error('ignore %s until %s is upgraded',
                                          orderterm, cmeth)
401
402
403
404
405
406
407
                                orderterm = None
                            elif not ' ' in orderterm.strip():
                                var = orderterm
                                order = 'ASC'
                        if orderterm is not None:
                            select.add_sort_var(select.get_variable(var),
                                                order=='ASC')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
408

409
410
    @classmethod
    @cached
411
412
413
414
415
416
417
418
419
420
421
    def cw_rest_attr_info(cls):
        """this class method return an attribute name to be used in URL for
        entities of this type and a boolean flag telling if its value should be
        checked for uniqness.

        The attribute returned is, in order of priority:

        * class's `rest_attr` class attribute
        * an attribute defined as unique in the class'schema
        * 'eid'
        """
422
423
424
425
426
427
        mainattr, needcheck = 'eid', True
        if cls.rest_attr:
            mainattr = cls.rest_attr
            needcheck = not cls.e_schema.has_unique_values(mainattr)
        else:
            for rschema in cls.e_schema.subject_relations():
428
                if (rschema.final
429
                    and rschema not in ('eid', 'cwuri')
430
431
                    and cls.e_schema.has_unique_values(rschema)
                    and cls.e_schema.rdef(rschema.type).cardinality[0] == '1'):
432
433
434
435
436
437
438
                    mainattr = str(rschema)
                    needcheck = False
                    break
        if mainattr == 'eid':
            needcheck = False
        return mainattr, needcheck

439
    @classmethod
440
    def _cw_build_entity_query(cls, kwargs):
441
442
        relations = []
        restrictions = set()
443
        pendingrels = []
444
        eschema = cls.e_schema
445
        qargs = {}
446
        attrcache = {}
447
        for attr, value in kwargs.items():
448
449
450
451
452
            if attr.startswith('reverse_'):
                attr = attr[len('reverse_'):]
                role = 'object'
            else:
                role = 'subject'
453
            assert eschema.has_relation(attr, role), '%s %s not found on %s' % (attr, role, eschema)
454
            rschema = eschema.subjrels[attr] if role == 'subject' else eschema.objrels[attr]
455
            if not rschema.final and isinstance(value, (tuple, list, set, frozenset)):
456
457
458
                if len(value) == 0:
                    continue # avoid crash with empty IN clause
                elif len(value) == 1:
459
                    value = next(iter(value))
460
                else:
461
                    # prepare IN clause
462
                    pendingrels.append( (attr, role, value) )
463
                    continue
464
465
            if rschema.final: # attribute
                relations.append('X %s %%(%s)s' % (attr, attr))
466
467
                attrcache[attr] = value
            elif value is None:
468
                pendingrels.append( (attr, role, value) )
469
            else:
470
                rvar = attr.upper()
471
472
                if role == 'object':
                    relations.append('%s %s X' % (rvar, attr))
473
474
475
476
477
                else:
                    relations.append('X %s %s' % (attr, rvar))
                restriction = '%s eid %%(%s)s' % (rvar, attr)
                if not restriction in restrictions:
                    restrictions.add(restriction)
478
479
480
                if hasattr(value, 'eid'):
                    value = value.eid
            qargs[attr] = value
481
        rql = u''
482
        if relations:
483
            rql += ', '.join(relations)
484
        if restrictions:
485
            rql += ' WHERE %s' % ', '.join(restrictions)
486
        return rql, qargs, pendingrels, attrcache
487
488

    @classmethod
489
490
    def _cw_handle_pending_relations(cls, eid, pendingrels, execute):
        for attr, role, values in pendingrels:
491
492
            if role == 'object':
                restr = 'Y %s X' % attr
493
494
            else:
                restr = 'X %s Y' % attr
495
496
497
            if values is None:
                execute('DELETE %s WHERE X eid %%(x)s' % restr, {'x': eid})
                continue
498
            execute('SET %s WHERE X eid %%(x)s, Y eid IN (%s)' % (
499
                restr, ','.join(str(getattr(r, 'eid', r)) for r in values)),
500
501
502
503
504
505
506
507
                    {'x': eid}, build_descr=False)

    @classmethod
    def cw_instantiate(cls, execute, **kwargs):
        """add a new entity of this given type

        Example (in a shell session):

Jérôme Roy's avatar
Jérôme Roy committed
508
509
        >>> companycls = vreg['etypes'].etype_class('Company')
        >>> personcls = vreg['etypes'].etype_class('Person')
510
511
512
513
514
515
516
517
        >>> c = companycls.cw_instantiate(session.execute, name=u'Logilab')
        >>> p = personcls.cw_instantiate(session.execute, firstname=u'John', lastname=u'Doe',
        ...                              works_for=c)

        You can also set relations where the entity has 'object' role by
        prefixing the relation name by 'reverse_'. Also, relation values may be
        an entity or eid, a list of entities or eids.
        """
518
        rql, qargs, pendingrels, attrcache = cls._cw_build_entity_query(kwargs)
519
520
521
522
        if rql:
            rql = 'INSERT %s X: %s' % (cls.__regid__, rql)
        else:
            rql = 'INSERT %s X' % (cls.__regid__)
523
524
525
526
527
        try:
            created = execute(rql, qargs).get_entity(0, 0)
        except IndexError:
            raise Exception('could not create a %r with %r (%r)' %
                            (cls.__regid__, rql, qargs))
528
        created._cw_update_attr_cache(attrcache)
529
        cls._cw_handle_pending_relations(created.eid, pendingrels, execute)
530
531
        return created

532
    def __init__(self, req, rset=None, row=None, col=0):
533
        AppObject.__init__(self, req, rset=rset, row=row, col=col)
534
        self._cw_related_cache = {}
535
        self._cw_adapters_cache = {}
Adrien Di Mascio's avatar
Adrien Di Mascio committed
536
537
538
539
        if rset is not None:
            self.eid = rset[row][col]
        else:
            self.eid = None
540
        self._cw_is_saved = True
541
        self.cw_attr_cache = {}
542

Adrien Di Mascio's avatar
Adrien Di Mascio committed
543
544
    def __repr__(self):
        return '<Entity %s %s %s at %s>' % (
545
            self.e_schema, self.eid, list(self.cw_attr_cache), id(self))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
546

547
    def __lt__(self, other):
548
        return NotImplemented
549
550

    def __eq__(self, other):
Rémi Cardona's avatar
Rémi Cardona committed
551
        if isinstance(self.eid, integer_types):
552
553
554
555
            return self.eid == other.eid
        return self is other

    def __hash__(self):
Rémi Cardona's avatar
Rémi Cardona committed
556
        if isinstance(self.eid, integer_types):
557
558
            return self.eid
        return super(Entity, self).__hash__()
559

560
561
562
    def _cw_update_attr_cache(self, attrcache):
        trdata = self._cw.transaction_data
        uncached_attrs = trdata.get('%s.storage-special-process-attrs' % self.eid, set())
563
        uncached_attrs.update(trdata.get('%s.dont-cache-attrs' % self.eid, set()))
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
        for attr in uncached_attrs:
            attrcache.pop(attr, None)
            self.cw_attr_cache.pop(attr, None)
        self.cw_attr_cache.update(attrcache)

    def _cw_dont_cache_attribute(self, attr, repo_side=False):
        """Called when some attribute has been transformed by a *storage*,
        hence the original value should not be cached **by anyone**.

        For example we have a special "fs_importing" mode in BFSS
        where a file path is given as attribute value and stored as is
        in the data base. Later access to the attribute will provide
        the content of the file at the specified path. We do not want
        the "filepath" value to be cached.

        """
        trdata = self._cw.transaction_data
581
582
583
        trdata.setdefault('%s.dont-cache-attrs' % self.eid, set()).add(attr)
        if repo_side:
            trdata.setdefault('%s.storage-special-process-attrs' % self.eid, set()).add(attr)
584

585
586
587
588
    def __json_encode__(self):
        """custom json dumps hook to dump the entity's eid
        which is not part of dict structure itself
        """
589
        dumpable = self.cw_attr_cache.copy()
590
591
592
        dumpable['eid'] = self.eid
        return dumpable

593
594
595
596
597
    def cw_adapt_to(self, interface):
        """return an adapter the entity to the given interface name.

        return None if it can not be adapted.
        """
598
        cache = self._cw_adapters_cache
599
600
601
602
603
604
605
606
        try:
            return cache[interface]
        except KeyError:
            adapter = self._cw.vreg['adapters'].select_or_none(
                interface, self._cw, entity=self)
            cache[interface] = adapter
            return adapter

607
    def has_eid(self): # XXX cw_has_eid
Adrien Di Mascio's avatar
Adrien Di Mascio committed
608
609
610
611
        """return True if the entity has an attributed eid (False
        meaning that the entity has to be created
        """
        try:
612
            int(self.eid)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
613
614
615
616
            return True
        except (ValueError, TypeError):
            return False

617
    def cw_is_saved(self):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
618
        """during entity creation, there is some time during which the entity
619
620
621
        has an eid attributed though it's not saved (eg during
        'before_add_entity' hooks). You can use this method to ensure the entity
        has an eid *and* is saved in its source.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
622
        """
623
        return self.has_eid() and self._cw_is_saved
624

625
    @deprecated('[3.24] cw_metainformation is deprecated')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
626
    @cached
627
    def cw_metainformation(self):
628
629
630
631
        source = self.cw_source[0].name
        return {'type': self.cw_etype,
                'extid': self.cwuri if source != 'system' else None,
                'source': {'uri': source}}
Adrien Di Mascio's avatar
Adrien Di Mascio committed
632

633
    def cw_check_perm(self, action):
634
        self.e_schema.check_perm(self._cw, action, eid=self.eid)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
635

636
    def cw_has_perm(self, action):
637
        return self.e_schema.has_perm(self._cw, action, eid=self.eid)
638

639
    def view(self, __vid, __registry='views', w=None, initargs=None, **kwargs): # XXX cw_view
Adrien Di Mascio's avatar
Adrien Di Mascio committed
640
        """shortcut to apply a view on this entity"""
641
642
643
644
        if initargs is None:
            initargs = kwargs
        else:
            initargs.update(kwargs)
645
        view = self._cw.vreg[__registry].select(__vid, self._cw, rset=self.cw_rset,
646
                                                row=self.cw_row, col=self.cw_col,
647
                                                **initargs)
648
        return view.render(row=self.cw_row, col=self.cw_col, w=w, **kwargs)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
649

650
    def absolute_url(self, *args, **kwargs): # XXX cw_url
Adrien Di Mascio's avatar
Adrien Di Mascio committed
651
        """return an absolute url to view this entity"""
652
653
654
655
656
657
658
        # use *args since we don't want first argument to be "anonymous" to
        # avoid potential clash with kwargs
        if args:
            assert len(args) == 1, 'only 0 or 1 non-named-argument expected'
            method = args[0]
        else:
            method = None
659
        if method in (None, 'view'):
660
            kwargs['_restpath'] = self.rest_path()
Adrien Di Mascio's avatar
Adrien Di Mascio committed
661
662
        else:
            kwargs['rql'] = 'Any X WHERE X eid %s' % self.eid
663
        return self._cw.build_url(method, **kwargs)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
664

665
    def rest_path(self, *args, **kwargs): # XXX cw_rest_path
Adrien Di Mascio's avatar
Adrien Di Mascio committed
666
        """returns a REST-like (relative) path for this entity"""
667
668
        if args or kwargs:
            warn("[3.24] rest_path doesn't take parameters anymore", DeprecationWarning)
669
        mainattr, needcheck = self.cw_rest_attr_info()
Adrien Di Mascio's avatar
Adrien Di Mascio committed
670
        etype = str(self.e_schema)
671
        path = etype.lower()
672
        fallback = False
673
        if mainattr != 'eid':
674
            value = getattr(self, mainattr)
675
            if not can_use_rest_path(value):
676
                mainattr = 'eid'
677
                path = None
678
679
            elif needcheck:
                # make sure url is not ambiguous
680
681
682
683
684
685
                try:
                    nbresults = self.__unique
                except AttributeError:
                    rql = 'Any COUNT(X) WHERE X is %s, X %s %%(value)s' % (
                        etype, mainattr)
                    nbresults = self.__unique = self._cw.execute(rql, {'value' : value})[0][0]
686
687
                if nbresults != 1: # ambiguity?
                    mainattr = 'eid'
688
                    path = None
Adrien Di Mascio's avatar
Adrien Di Mascio committed
689
        if mainattr == 'eid':
690
            value = self.eid
691
692
693
        if path is None:
            # fallback url: <base-url>/<eid> url is used as cw entities uri,
            # prefer it to <base-url>/<etype>/eid/<eid>
694
695
            return text_type(value)
        return u'%s/%s' % (path, self._cw.url_quote(value))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
696

697
    def cw_attr_metadata(self, attr, metadata):
698
        """return a metadata for an attribute (None if unspecified)"""
699
        value = getattr(self, '%s_%s' % (attr, metadata), None)
700
        if value is None and metadata == 'encoding':
701
            value = self._cw.vreg.property_value('ui.encoding')
702
        return value
Adrien Di Mascio's avatar
Adrien Di Mascio committed
703
704

    def printable_value(self, attr, value=_marker, attrtype=None,
705
                        format='text/html', displaytime=True): # XXX cw_printable_value
Adrien Di Mascio's avatar
Adrien Di Mascio committed
706
707
708
709
710
        """return a displayable value (i.e. unicode string) which may contains
        html tags
        """
        attr = str(attr)
        if value is _marker:
711
            value = getattr(self, attr)
712
        if isinstance(value, string_types):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
713
714
715
716
717
            value = value.strip()
        if value is None or value == '': # don't use "not", 0 is an acceptable value
            return u''
        if attrtype is None:
            attrtype = self.e_schema.destination(attr)
Sylvain Thénault's avatar
Sylvain Thénault committed
718
        props = self.e_schema.rdef(attr)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
719
720
721
        if attrtype == 'String':
            # internalinalized *and* formatted string such as schema
            # description...
Sylvain Thénault's avatar
Sylvain Thénault committed
722
            if props.internationalizable:
723
                value = self._cw._(value)
724
            attrformat = self.cw_attr_metadata(attr, 'format')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
725
            if attrformat:
726
727
                return self._cw_mtc_transform(value, attrformat, format,
                                              self._cw.encoding)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
728
        elif attrtype == 'Bytes':
729
            attrformat = self.cw_attr_metadata(attr, 'format')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
730
            if attrformat:
731
732
733
                encoding = self.cw_attr_metadata(attr, 'encoding')
                return self._cw_mtc_transform(value.getvalue(), attrformat, format,
                                              encoding)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
734
            return u''
735
736
        value = self._cw.printable_value(attrtype, value, props,
                                         displaytime=displaytime)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
737
        if format == 'text/html':
Sylvain Thénault's avatar
Sylvain Thénault committed
738
            value = xml_escape(value)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
739
740
        return value

741
742
    def _cw_mtc_transform(self, data, format, target_format, encoding,
                          _engine=ENGINE):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
743
744
        trdata = TransformData(data, format, encoding, appobject=self)
        data = _engine.convert(trdata, target_format).decode()
745
        if target_format == 'text/html':
746
            data = soup2xhtml(data, self._cw.encoding)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
747
        return data
748

Adrien Di Mascio's avatar
Adrien Di Mascio committed
749
750
    # entity cloning ##########################################################

751
    def copy_relations(self, ceid): # XXX cw_copy_relations
Alexandre Fayolle's avatar
Alexandre Fayolle committed
752
753
754
        """copy relations of the object with the given eid on this
        object (this method is called on the newly created copy, and
        ceid designates the original entity).
Adrien Di Mascio's avatar
Adrien Di Mascio committed
755
756
757
758
759

        By default meta and composite relations are skipped.
        Overrides this if you want another behaviour
        """
        assert self.has_eid()
760
        execute = self._cw.execute
761
762
763
764
        skip_copy_for = {'subject': set(), 'object': set()}
        for rtype in self.skip_copy_for:
            skip_copy_for['subject'].add(rtype)
            warn('[3.14] skip_copy_for on entity classes (%s) is deprecated, '
Sylvain Thénault's avatar
Sylvain Thénault committed
765
                 'use cw_skip_copy_for instead with list of couples (rtype, role)' % self.cw_etype,
766
767
768
769
                 DeprecationWarning)
        for rtype, role in self.cw_skip_copy_for:
            assert role in ('subject', 'object'), role
            skip_copy_for[role].add(rtype)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
770
        for rschema in self.e_schema.subject_relations():
771
772
            if rschema.type in skip_copy_for['subject']:
                continue
773
            if rschema.final or rschema.meta or rschema.rule:
Adrien Di Mascio's avatar
Adrien Di Mascio committed
774
                continue
775
776
            # skip already defined relations
            if getattr(self, rschema.type):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
777
                continue
778
779
            # XXX takefirst=True to remove warning triggered by ambiguous relations
            rdef = self.e_schema.rdef(rschema, takefirst=True)
780
            # skip composite relation
Sylvain Thénault's avatar
Sylvain Thénault committed
781
            if rdef.composite:
782
783
784
                continue
            # skip relation with card in ?1 else we either change the copied
            # object (inlined relation) or inserting some inconsistency
Sylvain Thénault's avatar
Sylvain Thénault committed
785
            if rdef.cardinality[1] in '?1':
786
                continue
Adrien Di Mascio's avatar
Adrien Di Mascio committed
787
            rql = 'SET X %s V WHERE X eid %%(x)s, Y eid %%(y)s, Y %s V' % (
788
                rschema.type, rschema.type)
789
            execute(rql, {'x': self.eid, 'y': ceid})
790
            self.cw_clear_relation_cache(rschema.type, 'subject')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
791
        for rschema in self.e_schema.object_relations():
792
            if rschema.meta or rschema.rule:
793
794
                continue
            # skip already defined relations
Sylvain Thénault's avatar
Sylvain Thénault committed
795
            if self.related(rschema.type, 'object'):
796
                continue
797
798
            if rschema.type in skip_copy_for['object']:
                continue
799
800
            # XXX takefirst=True to remove warning triggered by ambiguous relations
            rdef = self.e_schema.rdef(rschema, 'object', takefirst=True)
801
            # skip composite relation
Sylvain Thénault's avatar
Sylvain Thénault committed
802
            if rdef.composite:
Adrien Di Mascio's avatar
Adrien Di Mascio committed
803
804
805
                continue
            # skip relation with card in ?1 else we either change the copied
            # object (inlined relation) or inserting some inconsistency
Sylvain Thénault's avatar
Sylvain Thénault committed
806
            if rdef.cardinality[0] in '?1':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
807
808
                continue
            rql = 'SET V %s X WHERE X eid %%(x)s, Y eid %%(y)s, V %s Y' % (
809
                rschema.type, rschema.type)
810
            execute(rql, {'x': self.eid, 'y': ceid})
811
            self.cw_clear_relation_cache(rschema.type, 'object')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
812
813
814

    # data fetching methods ###################################################

815
    @cached
816
    def as_rset(self): # XXX .cw_as_rset
Adrien Di Mascio's avatar
Adrien Di Mascio committed
817
818
        """returns a resultset containing `self` information"""
        rset = ResultSet([(self.eid,)], 'Any X WHERE X eid %(x)s',
819
                         {'x': self.eid}, [(self.cw_etype,)])
820
821
        rset.req = self._cw
        return rset
822

823
    def _cw_to_complete_relations(self):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
824
825
        """by default complete final relations to when calling .complete()"""
        for rschema in self.e_schema.subject_relations():
826
            if rschema.final:
Adrien Di Mascio's avatar
Adrien Di Mascio committed
827
                continue
Sylvain Thénault's avatar
Sylvain Thénault committed
828
            targets = rschema.objects(self.e_schema)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
829
            if rschema.inlined:
830
                matching_groups = self._cw.user.matching_groups
831
832
833
                if all(matching_groups(e.get_groups('read')) and
                       rschema.rdef(self.e_schema, e).get_groups('read')
                       for e in targets):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
834
                    yield rschema, 'subject'
835

836
    def _cw_to_complete_attributes(self, skip_bytes=True, skip_pwd=True):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
837
838
839
840
841
842
843
        for rschema, attrschema in self.e_schema.attribute_definitions():
            # skip binary data by default
            if skip_bytes and attrschema.type == 'Bytes':
                continue
            attr = rschema.type
            if attr == 'eid':
                continue
Julien Cristau's avatar
Julien Cristau committed
844
            # password retrieval is blocked at the repository server level
Sylvain Thénault's avatar
Sylvain Thénault committed
845
            rdef = rschema.rdef(self.e_schema, attrschema)
846
            if not self._cw.user.matching_groups(rdef.get_groups('read')) \
847
                   or (attrschema.type == 'Password' and skip_pwd):
848
                self.cw_attr_cache[attr] = None
Adrien Di Mascio's avatar
Adrien Di Mascio committed
849
850
                continue
            yield attr
851

852
    _cw_completed = False
853
    def complete(self, attributes=None, skip_bytes=True, skip_pwd=True): # XXX cw_complete
Adrien Di Mascio's avatar
Adrien Di Mascio committed
854
855
856
857
858
859
860
861
        """complete this entity by adding missing attributes (i.e. query the
        repository to fill the entity)

        :type skip_bytes: bool
        :param skip_bytes:
          if true, attribute of type Bytes won't be considered
        """
        assert self.has_eid()
862
863
864
865
        if self._cw_completed:
            return
        if attributes is None:
            self._cw_completed = True
Adrien Di Mascio's avatar
Adrien Di Mascio committed
866
        varmaker = rqlvar_maker()
867
        V = next(varmaker)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
868
869
        rql = ['WHERE %s eid %%(x)s' % V]
        selected = []
870
        for attr in (attributes or self._cw_to_complete_attributes(skip_bytes, skip_pwd)):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
871
            # if attribute already in entity, nothing to do
872
            if attr in self.cw_attr_cache:
Adrien Di Mascio's avatar
Adrien Di Mascio committed
873
874
                continue
            # case where attribute must be completed, but is not yet in entity
875
            var = next(varmaker)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
876
877
            rql.append('%s %s %s' % (V, attr, var))
            selected.append((attr, var))
878
        # +1 since this doesn't include the main variable
Adrien Di Mascio's avatar
Adrien Di Mascio committed
879
        lastattr = len(selected) + 1
880
        if attributes is None:
Adrien Di Mascio's avatar
Adrien Di Mascio committed
881
            # fetch additional relations (restricted to 0..1 relations)
882
            for rschema, role in self._cw_to_complete_relations():
Adrien Di Mascio's avatar
Adrien Di Mascio committed
883
                rtype = rschema.type
884
                if self.cw_relation_cached(rtype, role):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
885
                    continue
886
887
888
889
890
891
                # at this point we suppose that:
                # * this is a inlined relation
                # * entity (self) is the subject
                # * user has read perm on the relation and on the target entity
                assert rschema.inlined
                assert role == 'subject'
892
                var = next(varmaker)
893
894
895
                # keep outer join anyway, we don't want .complete to crash on
                # missing mandatory relation (see #1058267)
                rql.append('%s %s %s?' % (V, rtype, var))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
896
897
898
899
900
901
                selected.append(((rtype, role), var))
        if selected:
            # select V, we need it as the left most selected variable
            # if some outer join are included to fetch inlined relations
            rql = 'Any %s,%s %s' % (V, ','.join(var for attr, var in selected),
                                    ','.join(rql))
902
903
904
905
906
            try:
                rset = self._cw.execute(rql, {'x': self.eid}, build_descr=False)[0]
            except IndexError:
                raise Exception('unable to fetch attributes for entity with eid %s'
                                % self.eid)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
907
            # handle attributes
908
            for i in range(1, lastattr):
909
                self.cw_attr_cache[str(selected[i-1][0])] = rset[i]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
910
            # handle relations
911
            for i in range(lastattr, len(rset)):
912
                rtype, role = selected[i-1][0]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
913
914
915
                value = rset[i]
                if value is None:
                    rrset = ResultSet([], rql, {'x': self.eid})
916
                    rrset.req = self._cw
Adrien Di Mascio's avatar
Adrien Di Mascio committed
917
                else:
918
                    rrset = self._cw.eid_rset(value)
919
                self.cw_set_relation_cache(rtype, role, rrset)
920

921
    def cw_attr_value(self, name):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
922
923
924
925
926
927
928
        """get value for the attribute relation <name>, query the repository
        to get the value if necessary.

        :type name: str
        :param name: name of the attribute to get
        """
        try:
929
            return self.cw_attr_cache[name]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
930
        except KeyError:
931
            if not self.cw_is_saved():
Adrien Di Mascio's avatar
Adrien Di Mascio committed
932
933
934
                return None
            rql = "Any A WHERE X eid %%(x)s, X %s A" % name
            try:
935
                rset = self._cw.execute(rql, {'x': self.eid})
Adrien Di Mascio's avatar
Adrien Di Mascio committed
936
            except Unauthorized:
937
                self.cw_attr_cache[name] = value = None
Adrien Di Mascio's avatar
Adrien Di Mascio committed
938
939
940
            else:
                assert rset.rowcount <= 1, (self, rql, rset.rowcount)
                try:
941
                    self.cw_attr_cache[name] = value = rset.rows[0][0]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
942
943
944
945
946
                except IndexError:
                    # probably a multisource error
                    self.critical("can't get value for attribute %s of entity with eid %s",
                                  name, self.eid)
                    if self.e_schema.destination(name) == 'String':
947
                        self.cw_attr_cache[name] = value = self._cw._('unaccessible')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
948
                    else:
949
950
                        self.cw_attr_cache[name] = value = None
            return value
Adrien Di Mascio's avatar
Adrien Di Mascio committed
951

952
    def related(self, rtype, role='subject', limit=None, entities=False, # XXX .cw_related
953
                safe=False, targettypes=None):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
954
        """returns a resultset of related entities
955

956
957
958
959
960
961
962
963
964
965
966
        :param rtype:
          the name of the relation, aka relation type
        :param role:
          the role played by 'self' in the relation ('subject' or 'object')
        :param limit:
          resultset's maximum size
        :param entities:
          if True, the entites are returned; if False, a result set is returned
        :param safe:
          if True, an empty rset/list of entities will be returned in case of
          :exc:`Unauthorized`, else (the default), the exception is propagated
967
968
        :param targettypes:
          a tuple of target entity types to restrict the query
Adrien Di Mascio's avatar
Adrien Di Mascio committed
969
        """
970
        rtype = str(rtype)
971
972
973
        # Caching restricted/limited results is best avoided.
        cacheable = limit is None and targettypes is None
        if cacheable:
974
975
976
            cache_key = '%s_%s' % (rtype, role)
            if cache_key in self._cw_related_cache:
                return self._cw_related_cache[cache_key][entities]
977
978
979
        if not self.has_eid():
            if entities:
                return []
980
            return self._cw.empty_rset()
981
        rql = self.cw_related_rql(rtype, role, limit=limit, targettypes=targettypes)
982
983
984
985
986
987
        try:
            rset = self._cw.execute(rql, {'x': self.eid})
        except Unauthorized:
            if not safe:
                raise
            rset = self._cw.empty_rset()
988
989
        if cacheable:
            self.cw_set_relation_cache(rtype, role, rset)
990
        if entities:
991
            return tuple(rset.entities())