author | Aurelien Campeas <aurelien.campeas@logilab.fr> |
Wed, 11 Jun 2014 14:47:50 +0200 | |
changeset 10361 | 46d72f33c428 |
parent 10338 | f738180d499d |
child 10603 | 65ad6980976e |
permissions | -rw-r--r-- |
8544
3d049071957e
massive copyright update to avoid clutering later patches
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8538
diff
changeset
|
1 |
# copyright 2003-2012 LOGILAB S.A. (Paris, FRANCE), all rights reserved. |
5421
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5290
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:
5290
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:
5290
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:
5290
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:
5290
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:
5290
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:
5290
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:
5290
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:
5290
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:
5290
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:
5290
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:
5290
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:
5290
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:
5290
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:
5290
diff
changeset
|
17 |
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>. |
6141
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5924
diff
changeset
|
18 |
"""Base class for request/session""" |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
19 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
20 |
__docformat__ = "restructuredtext en" |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
21 |
|
4933
433174d9394f
add missing warn imports
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4899
diff
changeset
|
22 |
from warnings import warn |
4891
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
23 |
from urlparse import urlsplit, urlunsplit |
2808
497424219fb0
fix urlquote imports
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2798
diff
changeset
|
24 |
from urllib import quote as urlquote, unquote as urlunquote |
2796
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
25 |
from datetime import time, datetime, timedelta |
4891
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
26 |
from cgi import parse_qs, parse_qsl |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
27 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
28 |
from logilab.common.decorators import cached |
3659 | 29 |
from logilab.common.deprecation import deprecated |
4466
8b0ca7904820
moved generic datetime manipulation function to lgc
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4459
diff
changeset
|
30 |
from logilab.common.date import ustrftime, strptime, todate, todatetime |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
31 |
|
9348
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
32 |
from rql.utils import rqlvar_maker |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
33 |
|
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
34 |
from cubicweb import (Unauthorized, NoSelectableObject, NoResultError, |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
35 |
MultipleResultsError, uilib) |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
36 |
from cubicweb.rset import ResultSet |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
37 |
|
2796
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
38 |
ONESECOND = timedelta(0, 1, 0) |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
39 |
CACHE_REGISTRY = {} |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
40 |
|
7116
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
41 |
class FindEntityError(Exception): |
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
42 |
"""raised when find_one_entity() can not return one and only one entity""" |
2796
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
43 |
|
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
44 |
class Cache(dict): |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
45 |
def __init__(self): |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
46 |
super(Cache, self).__init__() |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
47 |
_now = datetime.now() |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
48 |
self.cache_creation_date = _now |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
49 |
self.latest_cache_lookup = _now |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
50 |
|
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
51 |
|
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
52 |
class RequestSessionBase(object): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
53 |
"""base class containing stuff shared by server session and web request |
2825 | 54 |
|
55 |
request/session is the main resources accessor, mainly through it's vreg |
|
56 |
attribute: |
|
5290
15846058378b
[doc/book] fix a bit the request chapter, add autodoc
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5199
diff
changeset
|
57 |
|
15846058378b
[doc/book] fix a bit the request chapter, add autodoc
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5199
diff
changeset
|
58 |
:attribute vreg: the instance's registry |
15846058378b
[doc/book] fix a bit the request chapter, add autodoc
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5199
diff
changeset
|
59 |
:attribute vreg.schema: the instance's schema |
15846058378b
[doc/book] fix a bit the request chapter, add autodoc
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5199
diff
changeset
|
60 |
:attribute vreg.config: the instance's configuration |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
61 |
""" |
8525
c09feae04094
[entity edition] don't remove values from attribute cache on the repository side
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8309
diff
changeset
|
62 |
is_request = True # False for repository session |
c09feae04094
[entity edition] don't remove values from attribute cache on the repository side
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8309
diff
changeset
|
63 |
|
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
64 |
def __init__(self, vreg): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
65 |
self.vreg = vreg |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
66 |
try: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
67 |
encoding = vreg.property_value('ui.encoding') |
7815
2a164a9cf81c
[exceptions] stop catching any exception in various places (closes #1942716)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7543
diff
changeset
|
68 |
except Exception: # no vreg or property not registered |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
69 |
encoding = 'utf-8' |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
70 |
self.encoding = encoding |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
71 |
# cache result of execution for (rql expr / eids), |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
72 |
# should be emptied on commit/rollback of the server session / web |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
73 |
# connection |
8847
074f9f385f6b
[req] explicit `user` attribute
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8791
diff
changeset
|
74 |
self.user = None |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
75 |
self.local_perm_cache = {} |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
76 |
self._ = unicode |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
77 |
|
9051
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
78 |
def _set_user(self, orig_user): |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
79 |
"""set the user for this req_session_base |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
80 |
|
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
81 |
A special method is needed to ensure the linked user is linked to the |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
82 |
connection too. |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
83 |
""" |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
84 |
rset = self.eid_rset(orig_user.eid, 'CWUser') |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
85 |
user_cls = self.vreg['etypes'].etype_class('CWUser') |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
86 |
user = user_cls(self, rset, row=0, groups=orig_user.groups, |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
87 |
properties=orig_user.properties) |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
88 |
user.cw_attr_cache['login'] = orig_user.login # cache login |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
89 |
self.user = user |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
90 |
self.set_entity_cache(user) |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
91 |
self.set_language(user.prefered_language()) |
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
92 |
|
944d66870c6a
[req] add a _set_user method
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
9022
diff
changeset
|
93 |
|
8538
00597256de18
[request/session] refactor language handling: don't attempt to sync web/repo languages
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8525
diff
changeset
|
94 |
def set_language(self, lang): |
00597256de18
[request/session] refactor language handling: don't attempt to sync web/repo languages
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8525
diff
changeset
|
95 |
"""install i18n configuration for `lang` translation. |
00597256de18
[request/session] refactor language handling: don't attempt to sync web/repo languages
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8525
diff
changeset
|
96 |
|
00597256de18
[request/session] refactor language handling: don't attempt to sync web/repo languages
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8525
diff
changeset
|
97 |
Raises :exc:`KeyError` if translation doesn't exist. |
00597256de18
[request/session] refactor language handling: don't attempt to sync web/repo languages
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8525
diff
changeset
|
98 |
""" |
00597256de18
[request/session] refactor language handling: don't attempt to sync web/repo languages
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8525
diff
changeset
|
99 |
self.lang = lang |
00597256de18
[request/session] refactor language handling: don't attempt to sync web/repo languages
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8525
diff
changeset
|
100 |
gettext, pgettext = self.vreg.config.translations[lang] |
00597256de18
[request/session] refactor language handling: don't attempt to sync web/repo languages
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8525
diff
changeset
|
101 |
# use _cw.__ to translate a message without registering it to the catalog |
00597256de18
[request/session] refactor language handling: don't attempt to sync web/repo languages
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8525
diff
changeset
|
102 |
self._ = self.__ = gettext |
00597256de18
[request/session] refactor language handling: don't attempt to sync web/repo languages
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8525
diff
changeset
|
103 |
self.pgettext = pgettext |
00597256de18
[request/session] refactor language handling: don't attempt to sync web/repo languages
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8525
diff
changeset
|
104 |
|
9459
d3016c08b4ae
[repoapi] drop get_option_value's foreid argument
Julien Cristau <julien.cristau@logilab.fr>
parents:
9442
diff
changeset
|
105 |
def get_option_value(self, option): |
8585
3f60f416dddb
[dbapi] provide get_option_value over DBAPIRequest (closes #2515522)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8309
diff
changeset
|
106 |
raise NotImplementedError |
3f60f416dddb
[dbapi] provide get_option_value over DBAPIRequest (closes #2515522)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8309
diff
changeset
|
107 |
|
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
108 |
def property_value(self, key): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
109 |
"""return value of the property with the given key, giving priority to |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
110 |
user specific value if any, else using site value |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
111 |
""" |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
112 |
if self.user: |
9480
14159c600dad
[req] if a user has a None property, fall back to the default
Julien Cristau <julien.cristau@logilab.fr>
parents:
9469
diff
changeset
|
113 |
val = self.user.property_value(key) |
14159c600dad
[req] if a user has a None property, fall back to the default
Julien Cristau <julien.cristau@logilab.fr>
parents:
9469
diff
changeset
|
114 |
if val is not None: |
14159c600dad
[req] if a user has a None property, fall back to the default
Julien Cristau <julien.cristau@logilab.fr>
parents:
9469
diff
changeset
|
115 |
return val |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
116 |
return self.vreg.property_value(key) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
117 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
118 |
def etype_rset(self, etype, size=1): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
119 |
"""return a fake result set for a particular entity type""" |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
120 |
rset = ResultSet([('A',)]*size, '%s X' % etype, |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
121 |
description=[(etype,)]*size) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
122 |
def get_entity(row, col=0, etype=etype, req=self, rset=rset): |
7407
a78cc15227ef
[deprecation] drop remaining warnings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7121
diff
changeset
|
123 |
return req.vreg['etypes'].etype_class(etype)(req, rset, row, col) |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
124 |
rset.get_entity = get_entity |
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:
4835
diff
changeset
|
125 |
rset.req = self |
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:
4835
diff
changeset
|
126 |
return rset |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
127 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
128 |
def eid_rset(self, eid, etype=None): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
129 |
"""return a result set for the given eid without doing actual query |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
130 |
(we have the eid, we can suppose it exists and user has access to the |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
131 |
entity) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
132 |
""" |
8748
f5027f8d2478
drop typed_eid() in favour of int() (closes #2742462)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8596
diff
changeset
|
133 |
eid = int(eid) |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
134 |
if etype is None: |
9469
032825bbacab
[multi-sources-removal] Drop entities.source column
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9459
diff
changeset
|
135 |
etype = self.entity_metas(eid)['type'] |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
136 |
rset = ResultSet([(eid,)], 'Any X WHERE X eid %(x)s', {'x': eid}, |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
137 |
[(etype,)]) |
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:
4835
diff
changeset
|
138 |
rset.req = self |
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:
4835
diff
changeset
|
139 |
return rset |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
140 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
141 |
def empty_rset(self): |
5459
6e561796804c
[doc/book] regroup form/editcontroller stuff under an "edition control" chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5426
diff
changeset
|
142 |
""" return a guaranteed empty result """ |
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:
4835
diff
changeset
|
143 |
rset = ResultSet([], 'Any X WHERE X eid -1') |
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:
4835
diff
changeset
|
144 |
rset.req = self |
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:
4835
diff
changeset
|
145 |
return rset |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
146 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
147 |
def entity_from_eid(self, eid, etype=None): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
148 |
"""return an entity instance for the given eid. No query is done""" |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
149 |
try: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
150 |
return self.entity_cache(eid) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
151 |
except KeyError: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
152 |
rset = self.eid_rset(eid, etype) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
153 |
entity = rset.get_entity(0, 0) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
154 |
self.set_entity_cache(entity) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
155 |
return entity |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
156 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
157 |
def entity_cache(self, eid): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
158 |
raise KeyError |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
159 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
160 |
def set_entity_cache(self, entity): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
161 |
pass |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
162 |
|
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:
4466
diff
changeset
|
163 |
def create_entity(self, etype, **kwargs): |
3629
559cad62c786
backport stable branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3163
diff
changeset
|
164 |
"""add a new entity of the given type |
559cad62c786
backport stable branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3163
diff
changeset
|
165 |
|
559cad62c786
backport stable branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3163
diff
changeset
|
166 |
Example (in a shell session): |
559cad62c786
backport stable branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3163
diff
changeset
|
167 |
|
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:
4466
diff
changeset
|
168 |
>>> c = create_entity('Company', name=u'Logilab') |
5924
b218df942dd4
[book] update rql documentation and some erroneous/deprecated examples
Julien Jehannet <julien.jehannet@logilab.fr>
parents:
5736
diff
changeset
|
169 |
>>> create_entity('Person', firstname=u'John', surname=u'Doe', |
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:
4466
diff
changeset
|
170 |
... works_for=c) |
3674
387d51af966d
backport stable branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3659
diff
changeset
|
171 |
|
3629
559cad62c786
backport stable branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3163
diff
changeset
|
172 |
""" |
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:
4933
diff
changeset
|
173 |
cls = self.vreg['etypes'].etype_class(etype) |
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:
4933
diff
changeset
|
174 |
return cls.cw_instantiate(self.execute, **kwargs) |
2968
0e3460341023
somewhat painful backport of 3.5 branch, should mostly be ok
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2825
diff
changeset
|
175 |
|
9348
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
176 |
@deprecated('[3.18] use find(etype, **kwargs).entities()') |
7116
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
177 |
def find_entities(self, etype, **kwargs): |
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
178 |
"""find entities of the given type and attribute values. |
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
179 |
|
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
180 |
>>> users = find_entities('CWGroup', name=u'users') |
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
181 |
>>> groups = find_entities('CWGroup') |
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
182 |
""" |
9348
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
183 |
return self.find(etype, **kwargs).entities() |
7116
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
184 |
|
9348
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
185 |
@deprecated('[3.18] use find(etype, **kwargs).one()') |
7116
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
186 |
def find_one_entity(self, etype, **kwargs): |
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
187 |
"""find one entity of the given type and attribute values. |
7121 | 188 |
raise :exc:`FindEntityError` if can not return one and only one entity. |
7116
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
189 |
|
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
190 |
>>> users = find_one_entity('CWGroup', name=u'users') |
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
191 |
>>> groups = find_one_entity('CWGroup') |
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
192 |
Exception() |
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
193 |
""" |
9348
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
194 |
try: |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
195 |
return self.find(etype, **kwargs).one() |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
196 |
except (NoResultError, MultipleResultsError) as e: |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
197 |
raise FindEntityError("%s: (%s, %s)" % (str(e), etype, kwargs)) |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
198 |
|
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
199 |
def find(self, etype, **kwargs): |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
200 |
"""find entities of the given type and attribute values. |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
201 |
|
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
202 |
:returns: A :class:`ResultSet` |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
203 |
|
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
204 |
>>> users = find('CWGroup', name=u"users").one() |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
205 |
>>> groups = find('CWGroup').entities() |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
206 |
""" |
7116
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
207 |
parts = ['Any X WHERE X is %s' % etype] |
9348
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
208 |
varmaker = rqlvar_maker(defined='X') |
9720
a7210c912507
[req.find] Use vreg.schema.eschema for eschema lookup
Christophe de Vienne <cdevienne@gmail.com>
parents:
9480
diff
changeset
|
209 |
eschema = self.vreg.schema.eschema(etype) |
9348
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
210 |
for attr, value in kwargs.items(): |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
211 |
if isinstance(value, list) or isinstance(value, tuple): |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
212 |
raise NotImplementedError("List of values are not supported") |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
213 |
if hasattr(value, 'eid'): |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
214 |
kwargs[attr] = value.eid |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
215 |
if attr.startswith('reverse_'): |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
216 |
attr = attr[8:] |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
217 |
assert attr in eschema.objrels, \ |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
218 |
'%s not in %s object relations' % (attr, eschema) |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
219 |
parts.append( |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
220 |
'%(varname)s %(attr)s X, ' |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
221 |
'%(varname)s eid %%(reverse_%(attr)s)s' |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
222 |
% {'attr': attr, 'varname': varmaker.next()}) |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
223 |
else: |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
224 |
assert attr in eschema.subjrels, \ |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
225 |
'%s not in %s subject relations' % (attr, eschema) |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
226 |
parts.append('X %(attr)s %%(%(attr)s)s' % {'attr': attr}) |
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
227 |
|
7116
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
228 |
rql = ', '.join(parts) |
9348
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
229 |
|
eacd02792332
[req] New method: RequestSessionBase.find().
Christophe de Vienne <cdevienne@gmail.com>
parents:
8847
diff
changeset
|
230 |
return self.execute(rql, kwargs) |
7116
dfd4680a23f0
[session] add find_entities and find_one_entity to session/request API (closes #1550045)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6750
diff
changeset
|
231 |
|
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
232 |
def ensure_ro_rql(self, rql): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
233 |
"""raise an exception if the given rql is not a select query""" |
6747
63bf61e4e130
[security] fix access control problem
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6321
diff
changeset
|
234 |
first = rql.split(None, 1)[0].lower() |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
235 |
if first in ('insert', 'set', 'delete'): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
236 |
raise Unauthorized(self._('only select queries are authorized')) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
237 |
|
2796
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
238 |
def get_cache(self, cachename): |
5290
15846058378b
[doc/book] fix a bit the request chapter, add autodoc
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5199
diff
changeset
|
239 |
"""cachename should be dotted names as in : |
15846058378b
[doc/book] fix a bit the request chapter, add autodoc
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5199
diff
changeset
|
240 |
|
2796
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
241 |
- cubicweb.mycache |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
242 |
- cubes.blog.mycache |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
243 |
- etc. |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
244 |
""" |
9442
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9402
diff
changeset
|
245 |
warn.warning('[3.19] .get_cache will disappear soon. ' |
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9402
diff
changeset
|
246 |
'Distributed caching mechanisms are being introduced instead.' |
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9402
diff
changeset
|
247 |
'Other caching mechanism can be used more reliably ' |
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9402
diff
changeset
|
248 |
'to the same effect.', |
fbf2287fb2ce
[req] deprecate get_cache (closes #3181499)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9402
diff
changeset
|
249 |
DeprecationWarning) |
2796
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
250 |
if cachename in CACHE_REGISTRY: |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
251 |
cache = CACHE_REGISTRY[cachename] |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
252 |
else: |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
253 |
cache = CACHE_REGISTRY[cachename] = Cache() |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
254 |
_now = datetime.now() |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
255 |
if _now > cache.latest_cache_lookup + ONESECOND: |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
256 |
ecache = self.execute( |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
257 |
'Any C,T WHERE C is CWCache, C name %(name)s, C timestamp T', |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
258 |
{'name':cachename}).get_entity(0,0) |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
259 |
cache.latest_cache_lookup = _now |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
260 |
if not ecache.valid(cache.cache_creation_date): |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
261 |
cache.clear() |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
262 |
cache.cache_creation_date = _now |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
263 |
return cache |
14d2c69e12c4
move get_cache to base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
264 |
|
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
265 |
# url generation methods ################################################## |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
266 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
267 |
def build_url(self, *args, **kwargs): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
268 |
"""return an absolute URL using params dictionary key/values as URL |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
269 |
parameters. Values are automatically URL quoted, and the |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
270 |
publishing method to use may be specified or will be guessed. |
6321
a8a33679f4dd
[req] build_url: detect None values in arguments and raise ValueError
Julien Jehannet <julien.jehannet@logilab.fr>
parents:
6141
diff
changeset
|
271 |
|
8309
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8238
diff
changeset
|
272 |
if ``__secure__`` argument is True, the request will try to build a |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8238
diff
changeset
|
273 |
https url. |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8238
diff
changeset
|
274 |
|
6321
a8a33679f4dd
[req] build_url: detect None values in arguments and raise ValueError
Julien Jehannet <julien.jehannet@logilab.fr>
parents:
6141
diff
changeset
|
275 |
raises :exc:`ValueError` if None is found in arguments |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
276 |
""" |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
277 |
# use *args since we don't want first argument to be "anonymous" to |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
278 |
# avoid potential clash with kwargs |
9022
a1cee6915ea3
[req] drop from_controller on non WebRequest object (Closes #2901079)
pierre-yves
parents:
8847
diff
changeset
|
279 |
method = None |
2798
9c650701cb17
stop using controller class attribute, allowing to deprecate appobject.build_url in favor of req.build_url
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2796
diff
changeset
|
280 |
if args: |
9c650701cb17
stop using controller class attribute, allowing to deprecate appobject.build_url in favor of req.build_url
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2796
diff
changeset
|
281 |
assert len(args) == 1, 'only 0 or 1 non-named-argument expected' |
9c650701cb17
stop using controller class attribute, allowing to deprecate appobject.build_url in favor of req.build_url
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2796
diff
changeset
|
282 |
method = args[0] |
9022
a1cee6915ea3
[req] drop from_controller on non WebRequest object (Closes #2901079)
pierre-yves
parents:
8847
diff
changeset
|
283 |
if method is None: |
a1cee6915ea3
[req] drop from_controller on non WebRequest object (Closes #2901079)
pierre-yves
parents:
8847
diff
changeset
|
284 |
method = 'view' |
2798
9c650701cb17
stop using controller class attribute, allowing to deprecate appobject.build_url in favor of req.build_url
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2796
diff
changeset
|
285 |
# XXX I (adim) think that if method is passed explicitly, we should |
9c650701cb17
stop using controller class attribute, allowing to deprecate appobject.build_url in favor of req.build_url
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2796
diff
changeset
|
286 |
# not try to process it and directly call req.build_url() |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
287 |
base_url = kwargs.pop('base_url', None) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
288 |
if base_url is None: |
8309
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8238
diff
changeset
|
289 |
secure = kwargs.pop('__secure__', None) |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8238
diff
changeset
|
290 |
base_url = self.base_url(secure=secure) |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
291 |
if '_restpath' in kwargs: |
9022
a1cee6915ea3
[req] drop from_controller on non WebRequest object (Closes #2901079)
pierre-yves
parents:
8847
diff
changeset
|
292 |
assert method == 'view', repr(method) |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
293 |
path = kwargs.pop('_restpath') |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
294 |
else: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
295 |
path = method |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
296 |
if not kwargs: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
297 |
return u'%s%s' % (base_url, path) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
298 |
return u'%s%s?%s' % (base_url, path, self.build_url_params(**kwargs)) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
299 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
300 |
def build_url_params(self, **kwargs): |
9700 | 301 |
"""return encoded params to incorporate them in a URL""" |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
302 |
args = [] |
4892
7ee8f128be9e
[cleanup] use iteritems
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4891
diff
changeset
|
303 |
for param, values in kwargs.iteritems(): |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
304 |
if not isinstance(values, (list, tuple)): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
305 |
values = (values,) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
306 |
for value in values: |
6582
8eb7883b4223
[pylint] fix a bug of pylint detected errors and i18n pb (calling builtins._ instead of req._)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6321
diff
changeset
|
307 |
assert value is not None |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
308 |
args.append(u'%s=%s' % (param, self.url_quote(value))) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
309 |
return '&'.join(args) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
310 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
311 |
def url_quote(self, value, safe=''): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
312 |
"""urllib.quote is not unicode safe, use this method to do the |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
313 |
necessary encoding / decoding. Also it's designed to quote each |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
314 |
part of a url path and so the '/' character will be encoded as well. |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
315 |
""" |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
316 |
if isinstance(value, unicode): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
317 |
quoted = urlquote(value.encode(self.encoding), safe=safe) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
318 |
return unicode(quoted, self.encoding) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
319 |
return urlquote(str(value), safe=safe) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
320 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
321 |
def url_unquote(self, quoted): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
322 |
"""returns a unicode unquoted string |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
323 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
324 |
decoding is based on `self.encoding` which is the encoding |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
325 |
used in `url_quote` |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
326 |
""" |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
327 |
if isinstance(quoted, unicode): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
328 |
quoted = quoted.encode(self.encoding) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
329 |
try: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
330 |
return unicode(urlunquote(quoted), self.encoding) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
331 |
except UnicodeDecodeError: # might occurs on manually typed URLs |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
332 |
return unicode(urlunquote(quoted), 'iso-8859-1') |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
333 |
|
4300
03430023ce82
new url_parse_qs method on base request to parse unicode url formatted query strings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4222
diff
changeset
|
334 |
def url_parse_qsl(self, querystring): |
03430023ce82
new url_parse_qs method on base request to parse unicode url formatted query strings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4222
diff
changeset
|
335 |
"""return a list of (key, val) found in the url quoted query string""" |
03430023ce82
new url_parse_qs method on base request to parse unicode url formatted query strings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4222
diff
changeset
|
336 |
if isinstance(querystring, unicode): |
03430023ce82
new url_parse_qs method on base request to parse unicode url formatted query strings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4222
diff
changeset
|
337 |
querystring = querystring.encode(self.encoding) |
03430023ce82
new url_parse_qs method on base request to parse unicode url formatted query strings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4222
diff
changeset
|
338 |
for key, val in parse_qsl(querystring): |
03430023ce82
new url_parse_qs method on base request to parse unicode url formatted query strings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4222
diff
changeset
|
339 |
try: |
03430023ce82
new url_parse_qs method on base request to parse unicode url formatted query strings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4222
diff
changeset
|
340 |
yield unicode(key, self.encoding), unicode(val, self.encoding) |
03430023ce82
new url_parse_qs method on base request to parse unicode url formatted query strings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4222
diff
changeset
|
341 |
except UnicodeDecodeError: # might occurs on manually typed URLs |
03430023ce82
new url_parse_qs method on base request to parse unicode url formatted query strings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4222
diff
changeset
|
342 |
yield unicode(key, 'iso-8859-1'), unicode(val, 'iso-8859-1') |
03430023ce82
new url_parse_qs method on base request to parse unicode url formatted query strings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4222
diff
changeset
|
343 |
|
4891
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
344 |
|
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
345 |
def rebuild_url(self, url, **newparams): |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
346 |
"""return the given url with newparams inserted. If any new params |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
347 |
is already specified in the url, it's overriden by the new value |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
348 |
|
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
349 |
newparams may only be mono-valued. |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
350 |
""" |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
351 |
if isinstance(url, unicode): |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
352 |
url = url.encode(self.encoding) |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
353 |
schema, netloc, path, query, fragment = urlsplit(url) |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
354 |
query = parse_qs(query) |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
355 |
# sort for testing predictability |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
356 |
for key, val in sorted(newparams.iteritems()): |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
357 |
query[key] = (self.url_quote(val),) |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
358 |
query = '&'.join(u'%s=%s' % (param, value) |
10256
f753f364550f
[req] make rebuild_url predictable
Julien Cristau <julien.cristau@logilab.fr>
parents:
9821
diff
changeset
|
359 |
for param, values in sorted(query.items()) |
4891
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
360 |
for value in values) |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
361 |
return urlunsplit((schema, netloc, path, query, fragment)) |
90203ec7b3e3
[url] new rebuild_url method on base request
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4466
diff
changeset
|
362 |
|
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
363 |
# bound user related methods ############################################### |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
364 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
365 |
@cached |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
366 |
def user_data(self): |
9693
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
367 |
"""returns a dictionary with this user's information. |
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
368 |
|
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
369 |
The keys are : |
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
370 |
|
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
371 |
login |
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
372 |
The user login |
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
373 |
|
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
374 |
name |
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
375 |
The user name, returned by user.name() |
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
376 |
|
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
377 |
email |
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
378 |
The user principal email |
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
379 |
|
c7a184dd76b2
[doc] Document the user_data dictionnary content
Christophe de Vienne <christophe@unlish.com>
parents:
9386
diff
changeset
|
380 |
""" |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
381 |
userinfo = {} |
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:
4466
diff
changeset
|
382 |
user = self.user |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
383 |
userinfo['login'] = user.login |
3163
edfe43ceaa35
backport 3.5
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2968
diff
changeset
|
384 |
userinfo['name'] = user.name() |
5556
9ab2b4c74baf
[entity] introduce a new 'adapters' registry
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5527
diff
changeset
|
385 |
userinfo['email'] = user.cw_adapt_to('IEmailable').get_email() |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
386 |
return userinfo |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
387 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
388 |
# formating methods ####################################################### |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
389 |
|
2823
a4e3e9b1a9cd
backported from appobject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2808
diff
changeset
|
390 |
def view(self, __vid, rset=None, __fallback_oid=None, __registry='views', |
5516
232d13fc3e86
[req] avoid getting w in cw_extra_kwargs when calling .view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5459
diff
changeset
|
391 |
initargs=None, w=None, **kwargs): |
4070
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
392 |
"""Select object with the given id (`__oid`) then render it. If the |
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
393 |
object isn't selectable, try to select fallback object if |
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
394 |
`__fallback_oid` is specified. |
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
395 |
|
8238
087bb529035c
[spelling] fix dictionnary -> dictionary typo
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7990
diff
changeset
|
396 |
If specified `initargs` is expected to be a dictionary containing |
4070
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
397 |
arguments that should be given to selection (hence to object's __init__ |
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
398 |
as well), but not to render(). Other arbitrary keyword arguments will be |
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
399 |
given to selection *and* to render(), and so should be handled by |
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
400 |
object's call or cell_call method.. |
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
401 |
""" |
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
402 |
if initargs is None: |
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
403 |
initargs = kwargs |
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
404 |
else: |
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
405 |
initargs.update(kwargs) |
3655
af86ab65a282
3.6 updates
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3629
diff
changeset
|
406 |
try: |
4070
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
407 |
view = self.vreg[__registry].select(__vid, self, rset=rset, **initargs) |
7888
e257b4476454
[req] .view should not catch [Object|Registry]NotFound (which is a bug), only NoSelectableObject (closes #1973681)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7815
diff
changeset
|
408 |
except NoSelectableObject: |
5709
5606c01d68b2
[view] ensure fallback_oid is specified before trying to select fallback view, else simply raise the exception
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5516
diff
changeset
|
409 |
if __fallback_oid is None: |
5606c01d68b2
[view] ensure fallback_oid is specified before trying to select fallback view, else simply raise the exception
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5516
diff
changeset
|
410 |
raise |
3655
af86ab65a282
3.6 updates
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3629
diff
changeset
|
411 |
view = self.vreg[__registry].select(__fallback_oid, self, |
4070
6e9f7abee4ef
fix initargs handling
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
3720
diff
changeset
|
412 |
rset=rset, **initargs) |
5516
232d13fc3e86
[req] avoid getting w in cw_extra_kwargs when calling .view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5459
diff
changeset
|
413 |
return view.render(w=w, **kwargs) |
2823
a4e3e9b1a9cd
backported from appobject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2808
diff
changeset
|
414 |
|
7914
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
415 |
def printable_value(self, attrtype, value, props=None, displaytime=True, |
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
416 |
formatters=uilib.PRINTERS): |
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
417 |
"""return a displayablye value (i.e. unicode string)""" |
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
418 |
if value is None: |
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
419 |
return u'' |
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
420 |
try: |
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
421 |
as_string = formatters[attrtype] |
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
422 |
except KeyError: |
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
423 |
self.error('given bad attrtype %s', attrtype) |
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
424 |
return unicode(value) |
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
425 |
return as_string(value, self, props, displaytime) |
fb757a7d887e
[request, ui] printable_value is now a method of request, and may be given dict of formatters to use (closes #1984743)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7888
diff
changeset
|
426 |
|
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
427 |
def format_date(self, date, date_format=None, time=False): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
428 |
"""return a string for a date time according to instance's |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
429 |
configuration |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
430 |
""" |
5710
1c17e47df974
[req] fix format_time w/ 0:0 which is evaluated to False
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5709
diff
changeset
|
431 |
if date is not None: |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
432 |
if date_format is None: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
433 |
if time: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
434 |
date_format = self.property_value('ui.datetime-format') |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
435 |
else: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
436 |
date_format = self.property_value('ui.date-format') |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
437 |
return ustrftime(date, date_format) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
438 |
return u'' |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
439 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
440 |
def format_time(self, time): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
441 |
"""return a string for a time according to instance's |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
442 |
configuration |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
443 |
""" |
5710
1c17e47df974
[req] fix format_time w/ 0:0 which is evaluated to False
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5709
diff
changeset
|
444 |
if time is not None: |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
445 |
return ustrftime(time, self.property_value('ui.time-format')) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
446 |
return u'' |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
447 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
448 |
def format_float(self, num): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
449 |
"""return a string for floating point number according to instance's |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
450 |
configuration |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
451 |
""" |
4459
f628abfb3a6c
backport stable
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4307
diff
changeset
|
452 |
if num is not None: |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
453 |
return self.property_value('ui.float-format') % num |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
454 |
return u'' |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
455 |
|
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
456 |
def parse_datetime(self, value, etype='Datetime'): |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
457 |
"""get a datetime or time from a string (according to etype) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
458 |
Datetime formatted as Date are accepted |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
459 |
""" |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
460 |
assert etype in ('Datetime', 'Date', 'Time'), etype |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
461 |
# XXX raise proper validation error |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
462 |
if etype == 'Datetime': |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
463 |
format = self.property_value('ui.datetime-format') |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
464 |
try: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
465 |
return todatetime(strptime(value, format)) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
466 |
except ValueError: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
467 |
pass |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
468 |
elif etype == 'Time': |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
469 |
format = self.property_value('ui.time-format') |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
470 |
try: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
471 |
# (adim) I can't find a way to parse a Time with a custom format |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
472 |
date = strptime(value, format) # this returns a DateTime |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
473 |
return time(date.hour, date.minute, date.second) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
474 |
except ValueError: |
4222
5667f493c505
return localized message on parse_datetime errors
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4070
diff
changeset
|
475 |
raise ValueError(self._('can\'t parse %(value)r (expected %(format)s)') |
5667f493c505
return localized message on parse_datetime errors
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4070
diff
changeset
|
476 |
% {'value': value, 'format': format}) |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
477 |
try: |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
478 |
format = self.property_value('ui.date-format') |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
479 |
dt = strptime(value, format) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
480 |
if etype == 'Datetime': |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
481 |
return todatetime(dt) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
482 |
return todate(dt) |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
483 |
except ValueError: |
4222
5667f493c505
return localized message on parse_datetime errors
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4070
diff
changeset
|
484 |
raise ValueError(self._('can\'t parse %(value)r (expected %(format)s)') |
5667f493c505
return localized message on parse_datetime errors
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4070
diff
changeset
|
485 |
% {'value': value, 'format': format}) |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
486 |
|
9818
e3d2012adcd0
[request] Ensure base_url() always has a trailing '/' (closes #3955093)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
9480
diff
changeset
|
487 |
def _base_url(self, secure=None): |
e3d2012adcd0
[request] Ensure base_url() always has a trailing '/' (closes #3955093)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
9480
diff
changeset
|
488 |
if secure: |
e3d2012adcd0
[request] Ensure base_url() always has a trailing '/' (closes #3955093)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
9480
diff
changeset
|
489 |
return self.vreg.config.get('https-url') or self.vreg.config['base-url'] |
e3d2012adcd0
[request] Ensure base_url() always has a trailing '/' (closes #3955093)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
9480
diff
changeset
|
490 |
return self.vreg.config['base-url'] |
e3d2012adcd0
[request] Ensure base_url() always has a trailing '/' (closes #3955093)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
9480
diff
changeset
|
491 |
|
8309
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8238
diff
changeset
|
492 |
def base_url(self, secure=None): |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8238
diff
changeset
|
493 |
"""return the root url of the instance |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8238
diff
changeset
|
494 |
""" |
9818
e3d2012adcd0
[request] Ensure base_url() always has a trailing '/' (closes #3955093)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
9480
diff
changeset
|
495 |
url = self._base_url(secure=secure) |
e3d2012adcd0
[request] Ensure base_url() always has a trailing '/' (closes #3955093)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
9480
diff
changeset
|
496 |
return url if url is None else url.rstrip('/') + '/' |
5443
f299ee54d7e0
[webconfig] cleanup base_url management
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
497 |
|
f299ee54d7e0
[webconfig] cleanup base_url management
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
498 |
# abstract methods to override according to the web front-end ############# |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
499 |
|
7543
570522300e22
[ms, entity metas] add 'actual source' to entities table / base entity metadata cache. Closes #1767090
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7407
diff
changeset
|
500 |
def describe(self, eid, asdict=False): |
2792
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
501 |
"""return a tuple (type, sourceuri, extid) for the entity with id <eid>""" |
135580d15d42
rename and move cw.RequestSessionMixIn to cw.req.RequestSessionBase; move some appobjects methods where they actually belong to
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff
changeset
|
502 |
raise NotImplementedError |