author | Aurelien Campeas <aurelien.campeas@logilab.fr> |
Thu, 16 Jul 2009 16:30:58 +0200 | |
changeset 2384 | 6220783caa4b |
parent 2315 | a1849f3ef4af |
child 2476 | 1294a6bdf3bf |
permissions | -rw-r--r-- |
0 | 1 |
"""abstract class for http request |
2 |
||
3 |
:organization: Logilab |
|
1977
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1801
diff
changeset
|
4 |
:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2. |
0 | 5 |
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr |
1977
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1801
diff
changeset
|
6 |
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses |
0 | 7 |
""" |
8 |
__docformat__ = "restructuredtext en" |
|
9 |
||
10 |
import Cookie |
|
11 |
import sha |
|
12 |
import time |
|
13 |
import random |
|
14 |
import base64 |
|
15 |
from urlparse import urlsplit |
|
16 |
from itertools import count |
|
17 |
||
18 |
from rql.utils import rqlvar_maker |
|
19 |
||
20 |
from logilab.common.decorators import cached |
|
1717
d2c4d3bd0602
correct wrong condition and missing import
Graziella Toutoungis <graziella.toutoungis@logilab.fr>
parents:
1716
diff
changeset
|
21 |
from logilab.common.deprecation import obsolete |
0 | 22 |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2258
diff
changeset
|
23 |
from logilab.mtconverter import xml_escape |
1801
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
24 |
|
0 | 25 |
from cubicweb.dbapi import DBAPIRequest |
26 |
from cubicweb.common.mail import header |
|
27 |
from cubicweb.common.uilib import remove_html_tags |
|
940
15dcdc863965
fix imports : common.utils -> utils
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
890
diff
changeset
|
28 |
from cubicweb.utils import SizeConstrainedList, HTMLHead |
1801
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
29 |
from cubicweb.web import (INTERNAL_FIELD_VALUE, LOGGER, NothingToEdit, |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
30 |
RequestError, StatusResponse) |
0 | 31 |
|
662
6f867ab70e3d
move _MARKER from appobject to web.request
sylvain.thenault@logilab.fr
parents:
610
diff
changeset
|
32 |
_MARKER = object() |
6f867ab70e3d
move _MARKER from appobject to web.request
sylvain.thenault@logilab.fr
parents:
610
diff
changeset
|
33 |
|
0 | 34 |
|
35 |
def list_form_param(form, param, pop=False): |
|
36 |
"""get param from form parameters and return its value as a list, |
|
37 |
skipping internal markers if any |
|
38 |
||
39 |
* if the parameter isn't defined, return an empty list |
|
40 |
* if the parameter is a single (unicode) value, return a list |
|
41 |
containing that value |
|
42 |
* if the parameter is already a list or tuple, just skip internal |
|
43 |
markers |
|
44 |
||
45 |
if pop is True, the parameter is removed from the form dictionnary |
|
46 |
""" |
|
47 |
if pop: |
|
48 |
try: |
|
49 |
value = form.pop(param) |
|
50 |
except KeyError: |
|
51 |
return [] |
|
52 |
else: |
|
53 |
value = form.get(param, ()) |
|
54 |
if value is None: |
|
55 |
value = () |
|
56 |
elif not isinstance(value, (list, tuple)): |
|
57 |
value = [value] |
|
58 |
return [v for v in value if v != INTERNAL_FIELD_VALUE] |
|
59 |
||
60 |
||
61 |
||
62 |
class CubicWebRequestBase(DBAPIRequest): |
|
1421
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
63 |
"""abstract HTTP request, should be extended according to the HTTP backend""" |
2255
c346af0727ca
more generic way to detect json requests (not yet perfect though)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2245
diff
changeset
|
64 |
json_request = False # to be set to True by json controllers |
1421
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
65 |
|
0 | 66 |
def __init__(self, vreg, https, form=None): |
67 |
super(CubicWebRequestBase, self).__init__(vreg) |
|
68 |
self.message = None |
|
69 |
self.authmode = vreg.config['auth-mode'] |
|
70 |
self.https = https |
|
71 |
# raw html headers that can be added from any view |
|
72 |
self.html_headers = HTMLHead() |
|
73 |
# form parameters |
|
74 |
self.setup_params(form) |
|
75 |
# dictionnary that may be used to store request data that has to be |
|
76 |
# shared among various components used to publish the request (views, |
|
77 |
# controller, application...) |
|
78 |
self.data = {} |
|
79 |
# search state: 'normal' or 'linksearch' (eg searching for an object |
|
80 |
# to create a relation with another) |
|
1426 | 81 |
self.search_state = ('normal',) |
0 | 82 |
# tabindex generator |
83 |
self.tabindexgen = count() |
|
84 |
self.next_tabindex = self.tabindexgen.next |
|
85 |
# page id, set by htmlheader template |
|
86 |
self.pageid = None |
|
87 |
self.varmaker = rqlvar_maker() |
|
88 |
self.datadir_url = self._datadir_url() |
|
89 |
||
90 |
def set_connection(self, cnx, user=None): |
|
91 |
"""method called by the session handler when the user is authenticated |
|
92 |
or an anonymous connection is open |
|
93 |
""" |
|
94 |
super(CubicWebRequestBase, self).set_connection(cnx, user) |
|
2245
7463e1a748dd
new set_session_props method exposed by the repository, use it to be sure session language is in sync the request language
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2202
diff
changeset
|
95 |
# set request language |
0 | 96 |
vreg = self.vreg |
97 |
if self.user: |
|
98 |
try: |
|
99 |
# 1. user specified language |
|
100 |
lang = vreg.typed_value('ui.language', |
|
101 |
self.user.properties['ui.language']) |
|
102 |
self.set_language(lang) |
|
103 |
return |
|
104 |
except KeyError, ex: |
|
105 |
pass |
|
106 |
if vreg.config['language-negociation']: |
|
107 |
# 2. http negociated language |
|
108 |
for lang in self.header_accept_language(): |
|
109 |
if lang in self.translations: |
|
110 |
self.set_language(lang) |
|
111 |
return |
|
112 |
# 3. default language |
|
113 |
self.set_default_language(vreg) |
|
1426 | 114 |
|
0 | 115 |
def set_language(self, lang): |
116 |
self._ = self.__ = self.translations[lang] |
|
117 |
self.lang = lang |
|
2245
7463e1a748dd
new set_session_props method exposed by the repository, use it to be sure session language is in sync the request language
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2202
diff
changeset
|
118 |
self.cnx.set_session_props(lang=lang) |
0 | 119 |
self.debug('request language: %s', lang) |
1426 | 120 |
|
0 | 121 |
# input form parameters management ######################################## |
1426 | 122 |
|
0 | 123 |
# common form parameters which should be protected against html values |
124 |
# XXX can't add 'eid' for instance since it may be multivalued |
|
125 |
# dont put rql as well, if query contains < and > it will be corrupted! |
|
1426 | 126 |
no_script_form_params = set(('vid', |
127 |
'etype', |
|
0 | 128 |
'vtitle', 'title', |
129 |
'__message', |
|
130 |
'__redirectvid', '__redirectrql')) |
|
1426 | 131 |
|
0 | 132 |
def setup_params(self, params): |
133 |
"""WARNING: we're intentionaly leaving INTERNAL_FIELD_VALUE here |
|
134 |
||
1426 | 135 |
subclasses should overrides to |
0 | 136 |
""" |
137 |
if params is None: |
|
138 |
params = {} |
|
139 |
self.form = params |
|
140 |
encoding = self.encoding |
|
141 |
for k, v in params.items(): |
|
142 |
if isinstance(v, (tuple, list)): |
|
143 |
v = [unicode(x, encoding) for x in v] |
|
144 |
if len(v) == 1: |
|
145 |
v = v[0] |
|
146 |
if k in self.no_script_form_params: |
|
147 |
v = self.no_script_form_param(k, value=v) |
|
148 |
if isinstance(v, str): |
|
149 |
v = unicode(v, encoding) |
|
150 |
if k == '__message': |
|
151 |
self.set_message(v) |
|
152 |
del self.form[k] |
|
153 |
else: |
|
154 |
self.form[k] = v |
|
2202
cb374512949f
link to created entity when redirected to another page
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
155 |
# special key for created entity, added in controller's reset method |
2315
a1849f3ef4af
no link to created entity when no message is set
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2312
diff
changeset
|
156 |
# if no message set, we don't want this neither |
a1849f3ef4af
no link to created entity when no message is set
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2312
diff
changeset
|
157 |
if '__createdpath' in params and self.message: |
2202
cb374512949f
link to created entity when redirected to another page
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
158 |
self.message += ' (<a href="%s">%s</a>)' % ( |
cb374512949f
link to created entity when redirected to another page
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
159 |
self.build_url(params.pop('__createdpath')), |
cb374512949f
link to created entity when redirected to another page
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
160 |
self._('click here to see created entity')) |
1426 | 161 |
|
0 | 162 |
def no_script_form_param(self, param, default=None, value=None): |
163 |
"""ensure there is no script in a user form param |
|
164 |
||
165 |
by default return a cleaned string instead of raising a security |
|
166 |
exception |
|
167 |
||
168 |
this method should be called on every user input (form at least) fields |
|
169 |
that are at some point inserted in a generated html page to protect |
|
170 |
against script kiddies |
|
171 |
""" |
|
172 |
if value is None: |
|
173 |
value = self.form.get(param, default) |
|
174 |
if not value is default and value: |
|
175 |
# safety belt for strange urls like http://...?vtitle=yo&vtitle=yo |
|
176 |
if isinstance(value, (list, tuple)): |
|
177 |
self.error('no_script_form_param got a list (%s). Who generated the URL ?', |
|
178 |
repr(value)) |
|
179 |
value = value[0] |
|
180 |
return remove_html_tags(value) |
|
181 |
return value |
|
1426 | 182 |
|
0 | 183 |
def list_form_param(self, param, form=None, pop=False): |
184 |
"""get param from form parameters and return its value as a list, |
|
185 |
skipping internal markers if any |
|
1426 | 186 |
|
0 | 187 |
* if the parameter isn't defined, return an empty list |
188 |
* if the parameter is a single (unicode) value, return a list |
|
189 |
containing that value |
|
190 |
* if the parameter is already a list or tuple, just skip internal |
|
191 |
markers |
|
192 |
||
193 |
if pop is True, the parameter is removed from the form dictionnary |
|
194 |
""" |
|
195 |
if form is None: |
|
196 |
form = self.form |
|
1426 | 197 |
return list_form_param(form, param, pop) |
198 |
||
0 | 199 |
|
200 |
def reset_headers(self): |
|
201 |
"""used by AutomaticWebTest to clear html headers between tests on |
|
202 |
the same resultset |
|
203 |
""" |
|
204 |
self.html_headers = HTMLHead() |
|
205 |
return self |
|
206 |
||
207 |
# web state helpers ####################################################### |
|
1426 | 208 |
|
0 | 209 |
def set_message(self, msg): |
210 |
assert isinstance(msg, unicode) |
|
211 |
self.message = msg |
|
1426 | 212 |
|
0 | 213 |
def update_search_state(self): |
214 |
"""update the current search state""" |
|
215 |
searchstate = self.form.get('__mode') |
|
610
30cb5e29a416
take care, cnx may be None in which case we can't get/set session data
sylvain.thenault@logilab.fr
parents:
495
diff
changeset
|
216 |
if not searchstate and self.cnx is not None: |
0 | 217 |
searchstate = self.get_session_data('search_state', 'normal') |
218 |
self.set_search_state(searchstate) |
|
219 |
||
220 |
def set_search_state(self, searchstate): |
|
221 |
"""set a new search state""" |
|
222 |
if searchstate is None or searchstate == 'normal': |
|
223 |
self.search_state = (searchstate or 'normal',) |
|
224 |
else: |
|
225 |
self.search_state = ('linksearch', searchstate.split(':')) |
|
226 |
assert len(self.search_state[-1]) == 4 |
|
610
30cb5e29a416
take care, cnx may be None in which case we can't get/set session data
sylvain.thenault@logilab.fr
parents:
495
diff
changeset
|
227 |
if self.cnx is not None: |
30cb5e29a416
take care, cnx may be None in which case we can't get/set session data
sylvain.thenault@logilab.fr
parents:
495
diff
changeset
|
228 |
self.set_session_data('search_state', searchstate) |
0 | 229 |
|
1173
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
230 |
def match_search_state(self, rset): |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
231 |
"""when searching an entity to create a relation, return True if entities in |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
232 |
the given rset may be used as relation end |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
233 |
""" |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
234 |
try: |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
235 |
searchedtype = self.search_state[1][-1] |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
236 |
except IndexError: |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
237 |
return False # no searching for association |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
238 |
for etype in rset.column_types(0): |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
239 |
if etype != searchedtype: |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
240 |
return False |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
241 |
return True |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
242 |
|
0 | 243 |
def update_breadcrumbs(self): |
244 |
"""stores the last visisted page in session data""" |
|
245 |
searchstate = self.get_session_data('search_state') |
|
246 |
if searchstate == 'normal': |
|
247 |
breadcrumbs = self.get_session_data('breadcrumbs', None) |
|
248 |
if breadcrumbs is None: |
|
249 |
breadcrumbs = SizeConstrainedList(10) |
|
250 |
self.set_session_data('breadcrumbs', breadcrumbs) |
|
251 |
breadcrumbs.append(self.url()) |
|
252 |
||
253 |
def last_visited_page(self): |
|
254 |
breadcrumbs = self.get_session_data('breadcrumbs', None) |
|
255 |
if breadcrumbs: |
|
256 |
return breadcrumbs.pop() |
|
257 |
return self.base_url() |
|
258 |
||
259 |
def register_onetime_callback(self, func, *args): |
|
260 |
cbname = 'cb_%s' % ( |
|
261 |
sha.sha('%s%s%s%s' % (time.time(), func.__name__, |
|
1426 | 262 |
random.random(), |
0 | 263 |
self.user.login)).hexdigest()) |
264 |
def _cb(req): |
|
265 |
try: |
|
266 |
ret = func(req, *args) |
|
267 |
except TypeError: |
|
268 |
from warnings import warn |
|
269 |
warn('user callback should now take request as argument') |
|
1426 | 270 |
ret = func(*args) |
0 | 271 |
self.unregister_callback(self.pageid, cbname) |
272 |
return ret |
|
273 |
self.set_page_data(cbname, _cb) |
|
274 |
return cbname |
|
1426 | 275 |
|
0 | 276 |
def unregister_callback(self, pageid, cbname): |
277 |
assert pageid is not None |
|
278 |
assert cbname.startswith('cb_') |
|
279 |
self.info('unregistering callback %s for pageid %s', cbname, pageid) |
|
280 |
self.del_page_data(cbname) |
|
281 |
||
282 |
def clear_user_callbacks(self): |
|
283 |
if self.cnx is not None: |
|
284 |
sessdata = self.session_data() |
|
285 |
callbacks = [key for key in sessdata if key.startswith('cb_')] |
|
286 |
for callback in callbacks: |
|
287 |
self.del_session_data(callback) |
|
1426 | 288 |
|
0 | 289 |
# web edition helpers ##################################################### |
1426 | 290 |
|
0 | 291 |
@cached # so it's writed only once |
292 |
def fckeditor_config(self): |
|
890
3530baff9120
make fckeditor actually optional, fix its config, avoid needs for a link to fckeditor.js
sylvain.thenault@logilab.fr
parents:
662
diff
changeset
|
293 |
self.add_js('fckeditor/fckeditor.js') |
0 | 294 |
self.html_headers.define_var('fcklang', self.lang) |
295 |
self.html_headers.define_var('fckconfigpath', |
|
890
3530baff9120
make fckeditor actually optional, fix its config, avoid needs for a link to fckeditor.js
sylvain.thenault@logilab.fr
parents:
662
diff
changeset
|
296 |
self.build_url('data/cubicweb.fckcwconfig.js')) |
1013
948a3882c94a
add a use_fckeditor method on http request
sylvain.thenault@logilab.fr
parents:
940
diff
changeset
|
297 |
def use_fckeditor(self): |
948a3882c94a
add a use_fckeditor method on http request
sylvain.thenault@logilab.fr
parents:
940
diff
changeset
|
298 |
return self.vreg.config.fckeditor_installed() and self.property_value('ui.fckeditor') |
0 | 299 |
|
300 |
def edited_eids(self, withtype=False): |
|
301 |
"""return a list of edited eids""" |
|
302 |
yielded = False |
|
303 |
# warning: use .keys since the caller may change `form` |
|
304 |
form = self.form |
|
305 |
try: |
|
306 |
eids = form['eid'] |
|
307 |
except KeyError: |
|
308 |
raise NothingToEdit(None, {None: self._('no selected entities')}) |
|
309 |
if isinstance(eids, basestring): |
|
310 |
eids = (eids,) |
|
311 |
for peid in eids: |
|
312 |
if withtype: |
|
313 |
typekey = '__type:%s' % peid |
|
314 |
assert typekey in form, 'no entity type specified' |
|
315 |
yield peid, form[typekey] |
|
316 |
else: |
|
317 |
yield peid |
|
318 |
yielded = True |
|
319 |
if not yielded: |
|
320 |
raise NothingToEdit(None, {None: self._('no selected entities')}) |
|
321 |
||
322 |
# minparams=3 by default: at least eid, __type, and some params to change |
|
323 |
def extract_entity_params(self, eid, minparams=3): |
|
324 |
"""extract form parameters relative to the given eid""" |
|
325 |
params = {} |
|
326 |
eid = str(eid) |
|
327 |
form = self.form |
|
328 |
for param in form: |
|
329 |
try: |
|
330 |
name, peid = param.split(':', 1) |
|
331 |
except ValueError: |
|
332 |
if not param.startswith('__') and param != "eid": |
|
333 |
self.warning('param %s mis-formatted', param) |
|
334 |
continue |
|
335 |
if peid == eid: |
|
336 |
value = form[param] |
|
337 |
if value == INTERNAL_FIELD_VALUE: |
|
338 |
value = None |
|
339 |
params[name] = value |
|
340 |
params['eid'] = eid |
|
341 |
if len(params) < minparams: |
|
342 |
raise RequestError(self._('missing parameters for entity %s') % eid) |
|
343 |
return params |
|
1426 | 344 |
|
0 | 345 |
def get_pending_operations(self, entity, relname, role): |
346 |
operations = {'insert' : [], 'delete' : []} |
|
347 |
for optype in ('insert', 'delete'): |
|
348 |
data = self.get_session_data('pending_%s' % optype) or () |
|
349 |
for eidfrom, rel, eidto in data: |
|
350 |
if relname == rel: |
|
351 |
if role == 'subject' and entity.eid == eidfrom: |
|
352 |
operations[optype].append(eidto) |
|
353 |
if role == 'object' and entity.eid == eidto: |
|
354 |
operations[optype].append(eidfrom) |
|
355 |
return operations |
|
1426 | 356 |
|
0 | 357 |
def get_pending_inserts(self, eid=None): |
358 |
"""shortcut to access req's pending_insert entry |
|
359 |
||
360 |
This is where are stored relations being added while editing |
|
361 |
an entity. This used to be stored in a temporary cookie. |
|
362 |
""" |
|
363 |
pending = self.get_session_data('pending_insert') or () |
|
364 |
return ['%s:%s:%s' % (subj, rel, obj) for subj, rel, obj in pending |
|
365 |
if eid is None or eid in (subj, obj)] |
|
366 |
||
367 |
def get_pending_deletes(self, eid=None): |
|
368 |
"""shortcut to access req's pending_delete entry |
|
369 |
||
370 |
This is where are stored relations being removed while editing |
|
371 |
an entity. This used to be stored in a temporary cookie. |
|
372 |
""" |
|
373 |
pending = self.get_session_data('pending_delete') or () |
|
374 |
return ['%s:%s:%s' % (subj, rel, obj) for subj, rel, obj in pending |
|
375 |
if eid is None or eid in (subj, obj)] |
|
376 |
||
377 |
def remove_pending_operations(self): |
|
378 |
"""shortcut to clear req's pending_{delete,insert} entries |
|
379 |
||
380 |
This is needed when the edition is completed (whether it's validated |
|
381 |
or cancelled) |
|
382 |
""" |
|
383 |
self.del_session_data('pending_insert') |
|
384 |
self.del_session_data('pending_delete') |
|
385 |
||
386 |
def cancel_edition(self, errorurl): |
|
387 |
"""remove pending operations and `errorurl`'s specific stored data |
|
388 |
""" |
|
389 |
self.del_session_data(errorurl) |
|
390 |
self.remove_pending_operations() |
|
1426 | 391 |
|
0 | 392 |
# high level methods for HTTP headers management ########################## |
393 |
||
394 |
# must be cached since login/password are popped from the form dictionary |
|
395 |
# and this method may be called multiple times during authentication |
|
396 |
@cached |
|
397 |
def get_authorization(self): |
|
398 |
"""Parse and return the Authorization header""" |
|
399 |
if self.authmode == "cookie": |
|
400 |
try: |
|
401 |
user = self.form.pop("__login") |
|
402 |
passwd = self.form.pop("__password", '') |
|
403 |
return user, passwd.encode('UTF8') |
|
404 |
except KeyError: |
|
405 |
self.debug('no login/password in form params') |
|
406 |
return None, None |
|
407 |
else: |
|
408 |
return self.header_authorization() |
|
1426 | 409 |
|
0 | 410 |
def get_cookie(self): |
411 |
"""retrieve request cookies, returns an empty cookie if not found""" |
|
412 |
try: |
|
413 |
return Cookie.SimpleCookie(self.get_header('Cookie')) |
|
414 |
except KeyError: |
|
415 |
return Cookie.SimpleCookie() |
|
416 |
||
417 |
def set_cookie(self, cookie, key, maxage=300): |
|
418 |
"""set / update a cookie key |
|
419 |
||
420 |
by default, cookie will be available for the next 5 minutes. |
|
421 |
Give maxage = None to have a "session" cookie expiring when the |
|
422 |
client close its browser |
|
423 |
""" |
|
424 |
morsel = cookie[key] |
|
425 |
if maxage is not None: |
|
426 |
morsel['Max-Age'] = maxage |
|
427 |
# make sure cookie is set on the correct path |
|
428 |
morsel['path'] = self.base_url_path() |
|
429 |
self.add_header('Set-Cookie', morsel.OutputString()) |
|
430 |
||
431 |
def remove_cookie(self, cookie, key): |
|
432 |
"""remove a cookie by expiring it""" |
|
433 |
morsel = cookie[key] |
|
434 |
morsel['Max-Age'] = 0 |
|
435 |
# The only way to set up cookie age for IE is to use an old "expired" |
|
436 |
# syntax. IE doesn't support Max-Age there is no library support for |
|
1426 | 437 |
# managing |
0 | 438 |
# ===> Do _NOT_ comment this line : |
439 |
morsel['expires'] = 'Thu, 01-Jan-1970 00:00:00 GMT' |
|
440 |
self.add_header('Set-Cookie', morsel.OutputString()) |
|
441 |
||
442 |
def set_content_type(self, content_type, filename=None, encoding=None): |
|
443 |
"""set output content type for this request. An optional filename |
|
444 |
may be given |
|
445 |
""" |
|
446 |
if content_type.startswith('text/'): |
|
447 |
content_type += ';charset=' + (encoding or self.encoding) |
|
448 |
self.set_header('content-type', content_type) |
|
449 |
if filename: |
|
450 |
if isinstance(filename, unicode): |
|
451 |
filename = header(filename).encode() |
|
452 |
self.set_header('content-disposition', 'inline; filename=%s' |
|
453 |
% filename) |
|
454 |
||
455 |
# high level methods for HTML headers management ########################## |
|
456 |
||
2258
79bc598c6411
when request is a json request, bind on 'ajax-loaded' instead of document.ready()
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2255
diff
changeset
|
457 |
def add_onload(self, jscode): |
79bc598c6411
when request is a json request, bind on 'ajax-loaded' instead of document.ready()
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2255
diff
changeset
|
458 |
self.html_headers.add_onload(jscode, self.json_request) |
79bc598c6411
when request is a json request, bind on 'ajax-loaded' instead of document.ready()
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2255
diff
changeset
|
459 |
|
0 | 460 |
def add_js(self, jsfiles, localfile=True): |
461 |
"""specify a list of JS files to include in the HTML headers |
|
462 |
:param jsfiles: a JS filename or a list of JS filenames |
|
463 |
:param localfile: if True, the default data dir prefix is added to the |
|
464 |
JS filename |
|
465 |
""" |
|
466 |
if isinstance(jsfiles, basestring): |
|
467 |
jsfiles = (jsfiles,) |
|
468 |
for jsfile in jsfiles: |
|
469 |
if localfile: |
|
470 |
jsfile = self.datadir_url + jsfile |
|
471 |
self.html_headers.add_js(jsfile) |
|
472 |
||
473 |
def add_css(self, cssfiles, media=u'all', localfile=True, ieonly=False): |
|
474 |
"""specify a CSS file to include in the HTML headers |
|
475 |
:param cssfiles: a CSS filename or a list of CSS filenames |
|
476 |
:param media: the CSS's media if necessary |
|
477 |
:param localfile: if True, the default data dir prefix is added to the |
|
478 |
CSS filename |
|
479 |
""" |
|
480 |
if isinstance(cssfiles, basestring): |
|
481 |
cssfiles = (cssfiles,) |
|
482 |
if ieonly: |
|
483 |
if self.ie_browser(): |
|
484 |
add_css = self.html_headers.add_ie_css |
|
485 |
else: |
|
486 |
return # no need to do anything on non IE browsers |
|
487 |
else: |
|
488 |
add_css = self.html_headers.add_css |
|
489 |
for cssfile in cssfiles: |
|
490 |
if localfile: |
|
491 |
cssfile = self.datadir_url + cssfile |
|
492 |
add_css(cssfile, media) |
|
1426 | 493 |
|
1801
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
494 |
def build_ajax_replace_url(self, nodeid, rql, vid, replacemode='replace', |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
495 |
**extraparams): |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
496 |
"""builds an ajax url that will replace `nodeid`s content |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
497 |
:param nodeid: the dom id of the node to replace |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
498 |
:param rql: rql to execute |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
499 |
:param vid: the view to apply on the resultset |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
500 |
:param replacemode: defines how the replacement should be done. |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
501 |
Possible values are : |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
502 |
- 'replace' to replace the node's content with the generated HTML |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
503 |
- 'swap' to replace the node itself with the generated HTML |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
504 |
- 'append' to append the generated HTML to the node's content |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
505 |
""" |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
506 |
url = self.build_url('view', rql=rql, vid=vid, __notemplate=1, |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
507 |
**extraparams) |
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
508 |
return "javascript: loadxhtml('%s', '%s', '%s')" % ( |
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2258
diff
changeset
|
509 |
nodeid, xml_escape(url), replacemode) |
1801
672acc730ce5
ajax_replace_url becomes obsolete, req.build_ajax_replace_url should be used instead
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1718
diff
changeset
|
510 |
|
0 | 511 |
# urls/path management #################################################### |
1426 | 512 |
|
0 | 513 |
def url(self, includeparams=True): |
514 |
"""return currently accessed url""" |
|
515 |
return self.base_url() + self.relative_path(includeparams) |
|
516 |
||
517 |
def _datadir_url(self): |
|
518 |
"""return url of the application's data directory""" |
|
519 |
return self.base_url() + 'data%s/' % self.vreg.config.instance_md5_version() |
|
1426 | 520 |
|
0 | 521 |
def selected(self, url): |
522 |
"""return True if the url is equivalent to currently accessed url""" |
|
523 |
reqpath = self.relative_path().lower() |
|
524 |
baselen = len(self.base_url()) |
|
525 |
return (reqpath == url[baselen:].lower()) |
|
526 |
||
527 |
def base_url_prepend_host(self, hostname): |
|
528 |
protocol, roothost = urlsplit(self.base_url())[:2] |
|
529 |
if roothost.startswith('www.'): |
|
530 |
roothost = roothost[4:] |
|
531 |
return '%s://%s.%s' % (protocol, hostname, roothost) |
|
532 |
||
533 |
def base_url_path(self): |
|
534 |
"""returns the absolute path of the base url""" |
|
535 |
return urlsplit(self.base_url())[2] |
|
1426 | 536 |
|
0 | 537 |
@cached |
538 |
def from_controller(self): |
|
539 |
"""return the id (string) of the controller issuing the request""" |
|
540 |
controller = self.relative_path(False).split('/', 1)[0] |
|
541 |
registered_controllers = (ctrl.id for ctrl in |
|
542 |
self.vreg.registry_objects('controllers')) |
|
543 |
if controller in registered_controllers: |
|
544 |
return controller |
|
545 |
return 'view' |
|
1426 | 546 |
|
0 | 547 |
def external_resource(self, rid, default=_MARKER): |
548 |
"""return a path to an external resource, using its identifier |
|
549 |
||
550 |
raise KeyError if the resource is not defined |
|
551 |
""" |
|
552 |
try: |
|
553 |
value = self.vreg.config.ext_resources[rid] |
|
554 |
except KeyError: |
|
555 |
if default is _MARKER: |
|
556 |
raise |
|
557 |
return default |
|
558 |
if value is None: |
|
559 |
return None |
|
560 |
baseurl = self.datadir_url[:-1] # remove trailing / |
|
561 |
if isinstance(value, list): |
|
562 |
return [v.replace('DATADIR', baseurl) for v in value] |
|
563 |
return value.replace('DATADIR', baseurl) |
|
564 |
external_resource = cached(external_resource, keyarg=1) |
|
565 |
||
566 |
def validate_cache(self): |
|
567 |
"""raise a `DirectResponse` exception if a cached page along the way |
|
568 |
exists and is still usable. |
|
569 |
||
570 |
calls the client-dependant implementation of `_validate_cache` |
|
571 |
""" |
|
572 |
self._validate_cache() |
|
573 |
if self.http_method() == 'HEAD': |
|
574 |
raise StatusResponse(200, '') |
|
1426 | 575 |
|
0 | 576 |
# abstract methods to override according to the web front-end ############# |
1426 | 577 |
|
0 | 578 |
def http_method(self): |
579 |
"""returns 'POST', 'GET', 'HEAD', etc.""" |
|
580 |
raise NotImplementedError() |
|
581 |
||
582 |
def _validate_cache(self): |
|
583 |
"""raise a `DirectResponse` exception if a cached page along the way |
|
584 |
exists and is still usable |
|
585 |
""" |
|
586 |
raise NotImplementedError() |
|
1426 | 587 |
|
0 | 588 |
def relative_path(self, includeparams=True): |
589 |
"""return the normalized path of the request (ie at least relative |
|
590 |
to the application's root, but some other normalization may be needed |
|
591 |
so that the returned path may be used to compare to generated urls |
|
592 |
||
593 |
:param includeparams: |
|
594 |
boolean indicating if GET form parameters should be kept in the path |
|
595 |
""" |
|
596 |
raise NotImplementedError() |
|
597 |
||
598 |
def get_header(self, header, default=None): |
|
599 |
"""return the value associated with the given input HTTP header, |
|
600 |
raise KeyError if the header is not set |
|
601 |
""" |
|
602 |
raise NotImplementedError() |
|
603 |
||
604 |
def set_header(self, header, value): |
|
605 |
"""set an output HTTP header""" |
|
606 |
raise NotImplementedError() |
|
607 |
||
608 |
def add_header(self, header, value): |
|
609 |
"""add an output HTTP header""" |
|
610 |
raise NotImplementedError() |
|
1426 | 611 |
|
0 | 612 |
def remove_header(self, header): |
613 |
"""remove an output HTTP header""" |
|
614 |
raise NotImplementedError() |
|
1426 | 615 |
|
0 | 616 |
def header_authorization(self): |
617 |
"""returns a couple (auth-type, auth-value)""" |
|
618 |
auth = self.get_header("Authorization", None) |
|
619 |
if auth: |
|
620 |
scheme, rest = auth.split(' ', 1) |
|
621 |
scheme = scheme.lower() |
|
622 |
try: |
|
623 |
assert scheme == "basic" |
|
624 |
user, passwd = base64.decodestring(rest).split(":", 1) |
|
625 |
# XXX HTTP header encoding: use email.Header? |
|
626 |
return user.decode('UTF8'), passwd |
|
627 |
except Exception, ex: |
|
628 |
self.debug('bad authorization %s (%s: %s)', |
|
629 |
auth, ex.__class__.__name__, ex) |
|
630 |
return None, None |
|
631 |
||
1716
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
632 |
@obsolete("use parse_accept_header('Accept-Language')") |
0 | 633 |
def header_accept_language(self): |
634 |
"""returns an ordered list of preferred languages""" |
|
1716
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
635 |
return [value.split('-')[0] for value in |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
636 |
self.parse_accept_header('Accept-Language')] |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
637 |
|
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
638 |
def parse_accept_header(self, header): |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
639 |
"""returns an ordered list of preferred languages""" |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
640 |
accepteds = self.get_header(header, '') |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
641 |
values = [] |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
642 |
for info in accepteds.split(','): |
0 | 643 |
try: |
1716
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
644 |
value, scores = info.split(';', 1) |
0 | 645 |
except ValueError: |
1716
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
646 |
value = info |
0 | 647 |
score = 1.0 |
1716
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
648 |
else: |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
649 |
for score in scores.split(';'): |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
650 |
try: |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
651 |
scorekey, scoreval = score.split('=') |
1717
d2c4d3bd0602
correct wrong condition and missing import
Graziella Toutoungis <graziella.toutoungis@logilab.fr>
parents:
1716
diff
changeset
|
652 |
if scorekey == 'q': # XXX 'level' |
1716
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
653 |
score = float(score[2:]) # remove 'q=' |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
654 |
except ValueError: |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
655 |
continue |
1718
26ff2d292183
correct the values list append
Graziella Toutoungis <graziella.toutoungis@logilab.fr>
parents:
1717
diff
changeset
|
656 |
values.append((score, value)) |
1716
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
657 |
values.sort(reverse=True) |
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
658 |
return (value for (score, value) in values) |
0 | 659 |
|
660 |
def header_if_modified_since(self): |
|
661 |
"""If the HTTP header If-modified-since is set, return the equivalent |
|
662 |
mx date time value (GMT), else return None |
|
663 |
""" |
|
664 |
raise NotImplementedError() |
|
1426 | 665 |
|
0 | 666 |
# page data management #################################################### |
667 |
||
668 |
def get_page_data(self, key, default=None): |
|
669 |
"""return value associated to `key` in curernt page data""" |
|
670 |
page_data = self.cnx.get_session_data(self.pageid, {}) |
|
671 |
return page_data.get(key, default) |
|
1426 | 672 |
|
0 | 673 |
def set_page_data(self, key, value): |
674 |
"""set value associated to `key` in current page data""" |
|
675 |
self.html_headers.add_unload_pagedata() |
|
676 |
page_data = self.cnx.get_session_data(self.pageid, {}) |
|
677 |
page_data[key] = value |
|
678 |
return self.cnx.set_session_data(self.pageid, page_data) |
|
1426 | 679 |
|
0 | 680 |
def del_page_data(self, key=None): |
681 |
"""remove value associated to `key` in current page data |
|
682 |
if `key` is None, all page data will be cleared |
|
683 |
""" |
|
684 |
if key is None: |
|
685 |
self.cnx.del_session_data(self.pageid) |
|
686 |
else: |
|
687 |
page_data = self.cnx.get_session_data(self.pageid, {}) |
|
688 |
page_data.pop(key, None) |
|
689 |
self.cnx.set_session_data(self.pageid, page_data) |
|
690 |
||
691 |
# user-agent detection #################################################### |
|
692 |
||
693 |
@cached |
|
694 |
def useragent(self): |
|
695 |
return self.get_header('User-Agent', None) |
|
696 |
||
697 |
def ie_browser(self): |
|
698 |
useragent = self.useragent() |
|
699 |
return useragent and 'MSIE' in useragent |
|
1426 | 700 |
|
0 | 701 |
def xhtml_browser(self): |
702 |
useragent = self.useragent() |
|
1421
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
703 |
# * MSIE/Konqueror does not support xml content-type |
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
704 |
# * Opera supports xhtml and handles namespaces properly but it breaks |
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
705 |
# jQuery.attr() |
495
f8b1edfe9621
[#80966] Opera supports xhtml and handles namespaces properly but it breaks jQuery.attr(), so xhtml_browser return False if the webbrowser is opera
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
0
diff
changeset
|
706 |
if useragent and ('MSIE' in useragent or 'KHTML' in useragent |
f8b1edfe9621
[#80966] Opera supports xhtml and handles namespaces properly but it breaks jQuery.attr(), so xhtml_browser return False if the webbrowser is opera
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
0
diff
changeset
|
707 |
or 'Opera' in useragent): |
0 | 708 |
return False |
709 |
return True |
|
710 |
||
1421
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
711 |
def html_content_type(self): |
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
712 |
if self.xhtml_browser(): |
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
713 |
return 'application/xhtml+xml' |
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
714 |
return 'text/html' |
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
715 |
|
0 | 716 |
from cubicweb import set_log_methods |
717 |
set_log_methods(CubicWebRequestBase, LOGGER) |