author | Aurelien Campeas <aurelien.campeas@logilab.fr> |
Wed, 05 Mar 2014 15:49:23 +0100 | |
branch | stable |
changeset 9560 | 97fed7743dbe |
parent 9229 | 739ae5366bed |
child 9257 | ce338133c92c |
permissions | -rw-r--r-- |
9229
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
1 |
# copyright 2003-2013 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:
5389
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:
5389
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:
5389
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:
5389
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:
5389
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:
5389
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:
5389
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:
5389
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:
5389
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:
5389
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:
5389
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:
5389
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:
5389
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:
5389
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:
5389
diff
changeset
|
17 |
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>. |
5423
e15abfdcce38
backport default into stable: stable is now cw 3.8
Sylvain Thénault <sylvain.thenault@logilab.fr>
diff
changeset
|
18 |
"""abstract class for http request""" |
0 | 19 |
|
20 |
__docformat__ = "restructuredtext en" |
|
21 |
||
22 |
import time |
|
23 |
import random |
|
24 |
import base64 |
|
8600
d74addac92bb
[downloadable] fix filename in HTTP header (closes #2522325, #2522324)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8480
diff
changeset
|
25 |
import urllib |
8752
e19f4bba89cd
Add CubicWebRequestBase.content (closes #2742453)
Julien Cristau <julien.cristau@logilab.fr>
parents:
8732
diff
changeset
|
26 |
from StringIO import StringIO |
7879
9aae456abab5
[pylint] fix pylint detected errors and tweak it so that pylint -E will be much less verbose next time (+ update some copyrights on the way)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7872
diff
changeset
|
27 |
from hashlib import sha1 # pylint: disable=E0611 |
7855
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
28 |
from Cookie import SimpleCookie |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
29 |
from calendar import timegm |
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
30 |
from datetime import date, datetime |
0 | 31 |
from urlparse import urlsplit |
8316
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
32 |
import httplib |
0 | 33 |
from itertools import count |
6078
c08e74b0609e
fix missing import in web.request
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
6064
diff
changeset
|
34 |
from warnings import warn |
0 | 35 |
|
36 |
from rql.utils import rqlvar_maker |
|
37 |
||
38 |
from logilab.common.decorators import cached |
|
2613
5e19c2bb370e
R [all] logilab.common 0.44 provides only deprecated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2559
diff
changeset
|
39 |
from logilab.common.deprecation import deprecated |
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2258
diff
changeset
|
40 |
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
|
41 |
|
0 | 42 |
from cubicweb.dbapi import DBAPIRequest |
6063
17a53f6dea42
[request] js is defined in uilib, not utils
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6062
diff
changeset
|
43 |
from cubicweb.uilib import remove_html_tags, js |
17a53f6dea42
[request] js is defined in uilib, not utils
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6062
diff
changeset
|
44 |
from cubicweb.utils import SizeConstrainedList, HTMLHead, make_uid |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8889
diff
changeset
|
45 |
from cubicweb.view import TRANSITIONAL_DOCTYPE_NOEXT |
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
|
46 |
from cubicweb.web import (INTERNAL_FIELD_VALUE, LOGGER, NothingToEdit, |
5940
0e3ae19b181a
[uilib] refactor json_dumps code organization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5890
diff
changeset
|
47 |
RequestError, StatusResponse) |
8316
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
48 |
from cubicweb.web.httpcache import GMTOFFSET, get_validators |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
49 |
from cubicweb.web.http_headers import Headers, Cookie, parseDateTime |
0 | 50 |
|
662
6f867ab70e3d
move _MARKER from appobject to web.request
sylvain.thenault@logilab.fr
parents:
610
diff
changeset
|
51 |
_MARKER = object() |
6f867ab70e3d
move _MARKER from appobject to web.request
sylvain.thenault@logilab.fr
parents:
610
diff
changeset
|
52 |
|
6564
ff9f7c566464
[request] fix ajax_replace_url which breaks if the url contains some quotes (that will be properly quoted but unquoted by the browser, breaking the js expression) by using a separated js function
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6543
diff
changeset
|
53 |
def build_cb_uid(seed): |
7879
9aae456abab5
[pylint] fix pylint detected errors and tweak it so that pylint -E will be much less verbose next time (+ update some copyrights on the way)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7872
diff
changeset
|
54 |
sha = sha1('%s%s%s' % (time.time(), seed, random.random())) |
6564
ff9f7c566464
[request] fix ajax_replace_url which breaks if the url contains some quotes (that will be properly quoted but unquoted by the browser, breaking the js expression) by using a separated js function
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6543
diff
changeset
|
55 |
return 'cb_%s' % (sha.hexdigest()) |
ff9f7c566464
[request] fix ajax_replace_url which breaks if the url contains some quotes (that will be properly quoted but unquoted by the browser, breaking the js expression) by using a separated js function
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6543
diff
changeset
|
56 |
|
0 | 57 |
|
58 |
def list_form_param(form, param, pop=False): |
|
59 |
"""get param from form parameters and return its value as a list, |
|
60 |
skipping internal markers if any |
|
61 |
||
62 |
* if the parameter isn't defined, return an empty list |
|
63 |
* if the parameter is a single (unicode) value, return a list |
|
64 |
containing that value |
|
65 |
* if the parameter is already a list or tuple, just skip internal |
|
66 |
markers |
|
67 |
||
8238
087bb529035c
[spelling] fix dictionnary -> dictionary typo
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8177
diff
changeset
|
68 |
if pop is True, the parameter is removed from the form dictionary |
0 | 69 |
""" |
70 |
if pop: |
|
71 |
try: |
|
72 |
value = form.pop(param) |
|
73 |
except KeyError: |
|
74 |
return [] |
|
75 |
else: |
|
76 |
value = form.get(param, ()) |
|
77 |
if value is None: |
|
78 |
value = () |
|
79 |
elif not isinstance(value, (list, tuple)): |
|
80 |
value = [value] |
|
81 |
return [v for v in value if v != INTERNAL_FIELD_VALUE] |
|
82 |
||
83 |
||
84 |
||
85 |
class CubicWebRequestBase(DBAPIRequest): |
|
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
86 |
"""abstract HTTP request, should be extended according to the HTTP backend |
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
87 |
Immutable attributes that describe the received query and generic configuration |
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
88 |
""" |
8128
0a927fe4541b
[controllers] deprecate JSonController and implement AjaxController / ajax-func registry (closes #2110265)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8082
diff
changeset
|
89 |
ajax_request = False # to be set to True by ajax controllers |
1421
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
90 |
|
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
91 |
def __init__(self, vreg, https=False, form=None, headers={}): |
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
92 |
""" |
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
93 |
:vreg: Vregistry, |
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
94 |
:https: boolean, s this a https request |
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
95 |
:form: Forms value |
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
96 |
""" |
0 | 97 |
super(CubicWebRequestBase, self).__init__(vreg) |
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
98 |
#: (Boolean) Is this an https request. |
0 | 99 |
self.https = https |
8480
086cff6a306a
[book] fix build warnings/errors. Closes #2430042
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8316
diff
changeset
|
100 |
#: User interface property (vary with https) (see :ref:`uiprops`) |
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
101 |
self.uiprops = None |
8480
086cff6a306a
[book] fix build warnings/errors. Closes #2430042
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8316
diff
changeset
|
102 |
#: url for serving datadir (vary with https) (see :ref:`resources`) |
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
103 |
self.datadir_url = None |
8869
a46197b1696f
[webconfig] fallback to default configs if https ones are not defined
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8732
diff
changeset
|
104 |
if https and vreg.config.https_uiprops is not None: |
5467
57372dbfd114
[https] fix resource urls in https version of a site: should use the https version as well to avoid warnings from the nrowser
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5444
diff
changeset
|
105 |
self.uiprops = vreg.config.https_uiprops |
8869
a46197b1696f
[webconfig] fallback to default configs if https ones are not defined
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8732
diff
changeset
|
106 |
else: |
a46197b1696f
[webconfig] fallback to default configs if https ones are not defined
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8732
diff
changeset
|
107 |
self.uiprops = vreg.config.uiprops |
a46197b1696f
[webconfig] fallback to default configs if https ones are not defined
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8732
diff
changeset
|
108 |
if https and vreg.config.https_datadir_url is not None: |
5467
57372dbfd114
[https] fix resource urls in https version of a site: should use the https version as well to avoid warnings from the nrowser
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5444
diff
changeset
|
109 |
self.datadir_url = vreg.config.https_datadir_url |
57372dbfd114
[https] fix resource urls in https version of a site: should use the https version as well to avoid warnings from the nrowser
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5444
diff
changeset
|
110 |
else: |
57372dbfd114
[https] fix resource urls in https version of a site: should use the https version as well to avoid warnings from the nrowser
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5444
diff
changeset
|
111 |
self.datadir_url = vreg.config.datadir_url |
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
112 |
#: raw html headers that can be added from any view |
7762
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
113 |
self.html_headers = HTMLHead(self) |
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
114 |
#: received headers |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
115 |
self._headers_in = Headers() |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
116 |
for k, v in headers.iteritems(): |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
117 |
self._headers_in.addRawHeader(k, v) |
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
118 |
#: form parameters |
0 | 119 |
self.setup_params(form) |
8752
e19f4bba89cd
Add CubicWebRequestBase.content (closes #2742453)
Julien Cristau <julien.cristau@logilab.fr>
parents:
8732
diff
changeset
|
120 |
#: received body |
e19f4bba89cd
Add CubicWebRequestBase.content (closes #2742453)
Julien Cristau <julien.cristau@logilab.fr>
parents:
8732
diff
changeset
|
121 |
self.content = StringIO() |
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
122 |
#: dictionary that may be used to store request data that has to be |
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
123 |
#: shared among various components used to publish the request (views, |
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
124 |
#: controller, application...) |
0 | 125 |
self.data = {} |
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
126 |
#: search state: 'normal' or 'linksearch' (eg searching for an object |
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
127 |
#: to create a relation with another) |
1426 | 128 |
self.search_state = ('normal',) |
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
129 |
#: page id, set by htmlheader template |
0 | 130 |
self.pageid = None |
3816
37b376bb4088
[web] set pageid at request instanciation rather than in htmlheader template
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3275
diff
changeset
|
131 |
self._set_pageid() |
5155
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
132 |
# prepare output header |
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
133 |
#: Header used for the final response |
5155
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
134 |
self.headers_out = Headers() |
8312
6c2119509fac
[web] Move request handling logic into cubicweb application. (closes #2200684)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
135 |
#: HTTP status use by the final response |
6c2119509fac
[web] Move request handling logic into cubicweb application. (closes #2200684)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
136 |
self.status_out = 200 |
3816
37b376bb4088
[web] set pageid at request instanciation rather than in htmlheader template
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3275
diff
changeset
|
137 |
|
37b376bb4088
[web] set pageid at request instanciation rather than in htmlheader template
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3275
diff
changeset
|
138 |
def _set_pageid(self): |
37b376bb4088
[web] set pageid at request instanciation rather than in htmlheader template
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3275
diff
changeset
|
139 |
"""initialize self.pageid |
37b376bb4088
[web] set pageid at request instanciation rather than in htmlheader template
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3275
diff
changeset
|
140 |
if req.form provides a specific pageid, use it, otherwise build a |
37b376bb4088
[web] set pageid at request instanciation rather than in htmlheader template
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3275
diff
changeset
|
141 |
new one. |
37b376bb4088
[web] set pageid at request instanciation rather than in htmlheader template
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3275
diff
changeset
|
142 |
""" |
37b376bb4088
[web] set pageid at request instanciation rather than in htmlheader template
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3275
diff
changeset
|
143 |
pid = self.form.get('pageid') |
37b376bb4088
[web] set pageid at request instanciation rather than in htmlheader template
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3275
diff
changeset
|
144 |
if pid is None: |
37b376bb4088
[web] set pageid at request instanciation rather than in htmlheader template
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3275
diff
changeset
|
145 |
pid = make_uid(id(self)) |
7374
3c9850d929e5
[web request] don't define pageid js variable when one is found in form parameters (eg, page ajax call)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7268
diff
changeset
|
146 |
self.html_headers.define_var('pageid', pid, override=False) |
3816
37b376bb4088
[web] set pageid at request instanciation rather than in htmlheader template
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3275
diff
changeset
|
147 |
self.pageid = pid |
0 | 148 |
|
8155
c075950cc929
[bw compat] json_request setter is necessary for some cubes which has json_request (eg preview)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8128
diff
changeset
|
149 |
def _get_json_request(self): |
8128
0a927fe4541b
[controllers] deprecate JSonController and implement AjaxController / ajax-func registry (closes #2110265)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8082
diff
changeset
|
150 |
warn('[3.15] self._cw.json_request is deprecated, use self._cw.ajax_request instead', |
0a927fe4541b
[controllers] deprecate JSonController and implement AjaxController / ajax-func registry (closes #2110265)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8082
diff
changeset
|
151 |
DeprecationWarning, stacklevel=2) |
0a927fe4541b
[controllers] deprecate JSonController and implement AjaxController / ajax-func registry (closes #2110265)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8082
diff
changeset
|
152 |
return self.ajax_request |
8155
c075950cc929
[bw compat] json_request setter is necessary for some cubes which has json_request (eg preview)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8128
diff
changeset
|
153 |
def _set_json_request(self, value): |
c075950cc929
[bw compat] json_request setter is necessary for some cubes which has json_request (eg preview)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8128
diff
changeset
|
154 |
warn('[3.15] self._cw.json_request is deprecated, use self._cw.ajax_request instead', |
c075950cc929
[bw compat] json_request setter is necessary for some cubes which has json_request (eg preview)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8128
diff
changeset
|
155 |
DeprecationWarning, stacklevel=2) |
c075950cc929
[bw compat] json_request setter is necessary for some cubes which has json_request (eg preview)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8128
diff
changeset
|
156 |
self.ajax_request = value |
c075950cc929
[bw compat] json_request setter is necessary for some cubes which has json_request (eg preview)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8128
diff
changeset
|
157 |
json_request = property(_get_json_request, _set_json_request) |
8128
0a927fe4541b
[controllers] deprecate JSonController and implement AjaxController / ajax-func registry (closes #2110265)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8082
diff
changeset
|
158 |
|
8309
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
159 |
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:
8271
diff
changeset
|
160 |
"""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:
8271
diff
changeset
|
161 |
|
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
162 |
secure = False -> base-url |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
163 |
secure = None -> https-url if req.https |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
164 |
secure = True -> https if it exist |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
165 |
""" |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
166 |
if secure is None: |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
167 |
secure = self.https |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
168 |
base_url = None |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
169 |
if secure: |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
170 |
base_url = self.vreg.config.get('https-url') |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
171 |
if base_url is None: |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
172 |
base_url = super(CubicWebRequestBase, self).base_url() |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
173 |
return base_url |
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8271
diff
changeset
|
174 |
|
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:
2788
diff
changeset
|
175 |
@property |
6581
4a3b264589dc
[dbapi] enhanced web compatible request when using dbapi
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6564
diff
changeset
|
176 |
def authmode(self): |
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
177 |
"""Authentification mode of the instance |
8480
086cff6a306a
[book] fix build warnings/errors. Closes #2430042
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8316
diff
changeset
|
178 |
(see :ref:`WebServerConfig`)""" |
6581
4a3b264589dc
[dbapi] enhanced web compatible request when using dbapi
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6564
diff
changeset
|
179 |
return self.vreg.config['auth-mode'] |
4a3b264589dc
[dbapi] enhanced web compatible request when using dbapi
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6564
diff
changeset
|
180 |
|
8271
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
181 |
# Various variable generator. |
3bd9b317b1d8
[req, doc] add some documentation of CubicWebRequestBase attributes
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8239
diff
changeset
|
182 |
|
6581
4a3b264589dc
[dbapi] enhanced web compatible request when using dbapi
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6564
diff
changeset
|
183 |
@property |
2801
7ef4c1c9266b
fix syntax error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2792
diff
changeset
|
184 |
def varmaker(self): |
4366
d51f28ba9399
fif inlined relation forms pb w/ new ajax forms.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4277
diff
changeset
|
185 |
"""the rql varmaker is exposed both as a property and as the |
d51f28ba9399
fif inlined relation forms pb w/ new ajax forms.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4277
diff
changeset
|
186 |
set_varmaker function since we've two use cases: |
d51f28ba9399
fif inlined relation forms pb w/ new ajax forms.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4277
diff
changeset
|
187 |
|
d51f28ba9399
fif inlined relation forms pb w/ new ajax forms.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4277
diff
changeset
|
188 |
* accessing the req.varmaker property to get a new variable name |
d51f28ba9399
fif inlined relation forms pb w/ new ajax forms.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4277
diff
changeset
|
189 |
|
d51f28ba9399
fif inlined relation forms pb w/ new ajax forms.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4277
diff
changeset
|
190 |
* calling req.set_varmaker() to ensure a varmaker is set for later ajax |
d51f28ba9399
fif inlined relation forms pb w/ new ajax forms.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4277
diff
changeset
|
191 |
calls sharing our .pageid |
d51f28ba9399
fif inlined relation forms pb w/ new ajax forms.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4277
diff
changeset
|
192 |
""" |
d51f28ba9399
fif inlined relation forms pb w/ new ajax forms.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4277
diff
changeset
|
193 |
return self.set_varmaker() |
d51f28ba9399
fif inlined relation forms pb w/ new ajax forms.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4277
diff
changeset
|
194 |
|
7266
f625097d1e99
[request] don't init tabindex unnecessarily, since it's added to page data which will makes an ajax call to unload_page_data necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7070
diff
changeset
|
195 |
def next_tabindex(self): |
6259
c3d98e4bee12
[request] memoize tabindex across ajax calls (on pageid) to avoid ui confusion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6108
diff
changeset
|
196 |
nextfunc = self.get_page_data('nexttabfunc') |
c3d98e4bee12
[request] memoize tabindex across ajax calls (on pageid) to avoid ui confusion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6108
diff
changeset
|
197 |
if nextfunc is None: |
c3d98e4bee12
[request] memoize tabindex across ajax calls (on pageid) to avoid ui confusion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6108
diff
changeset
|
198 |
nextfunc = count(1).next |
c3d98e4bee12
[request] memoize tabindex across ajax calls (on pageid) to avoid ui confusion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6108
diff
changeset
|
199 |
self.set_page_data('nexttabfunc', nextfunc) |
7266
f625097d1e99
[request] don't init tabindex unnecessarily, since it's added to page data which will makes an ajax call to unload_page_data necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7070
diff
changeset
|
200 |
return nextfunc() |
6259
c3d98e4bee12
[request] memoize tabindex across ajax calls (on pageid) to avoid ui confusion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6108
diff
changeset
|
201 |
|
4366
d51f28ba9399
fif inlined relation forms pb w/ new ajax forms.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4277
diff
changeset
|
202 |
def set_varmaker(self): |
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:
2788
diff
changeset
|
203 |
varmaker = self.get_page_data('rql_varmaker') |
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:
2788
diff
changeset
|
204 |
if varmaker 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:
2788
diff
changeset
|
205 |
varmaker = rqlvar_maker() |
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:
2788
diff
changeset
|
206 |
self.set_page_data('rql_varmaker', varmaker) |
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:
2788
diff
changeset
|
207 |
return varmaker |
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:
2788
diff
changeset
|
208 |
|
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
209 |
def set_session(self, session, user=None): |
0 | 210 |
"""method called by the session handler when the user is authenticated |
211 |
or an anonymous connection is open |
|
212 |
""" |
|
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
213 |
super(CubicWebRequestBase, self).set_session(session, 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
|
214 |
# set request language |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
215 |
vreg = self.vreg |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
216 |
if self.user: |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
217 |
try: |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
218 |
# 1. user specified language |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
219 |
lang = vreg.typed_value('ui.language', |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
220 |
self.user.properties['ui.language']) |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
221 |
self.set_language(lang) |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
222 |
return |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
223 |
except KeyError: |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
224 |
pass |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
225 |
if vreg.config['language-negociation']: |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
226 |
# 2. http negociated language |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
227 |
for lang in self.header_accept_language(): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
228 |
if lang in self.translations: |
0 | 229 |
self.set_language(lang) |
230 |
return |
|
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
231 |
# 3. default language |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
232 |
self.set_default_language(vreg) |
1426 | 233 |
|
0 | 234 |
# input form parameters management ######################################## |
1426 | 235 |
|
0 | 236 |
# common form parameters which should be protected against html values |
237 |
# XXX can't add 'eid' for instance since it may be multivalued |
|
238 |
# dont put rql as well, if query contains < and > it will be corrupted! |
|
1426 | 239 |
no_script_form_params = set(('vid', |
240 |
'etype', |
|
0 | 241 |
'vtitle', 'title', |
242 |
'__message', |
|
243 |
'__redirectvid', '__redirectrql')) |
|
1426 | 244 |
|
0 | 245 |
def setup_params(self, params): |
246 |
"""WARNING: we're intentionaly leaving INTERNAL_FIELD_VALUE here |
|
247 |
||
1426 | 248 |
subclasses should overrides to |
0 | 249 |
""" |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
250 |
self.form = {} |
0 | 251 |
if params is None: |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
252 |
return |
0 | 253 |
encoding = self.encoding |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
254 |
for param, val in params.iteritems(): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
255 |
if isinstance(val, (tuple, list)): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
256 |
val = [unicode(x, encoding) for x in val] |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
257 |
if len(val) == 1: |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
258 |
val = val[0] |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
259 |
elif isinstance(val, str): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
260 |
val = unicode(val, encoding) |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
261 |
if param in self.no_script_form_params and val: |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
262 |
val = self.no_script_form_param(param, val) |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
263 |
if param == '_cwmsgid': |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
264 |
self.set_message_id(val) |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
265 |
elif param == '__message': |
7432
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
266 |
warn('[3.13] __message in request parameter is deprecated (may ' |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
267 |
'only be given to .build_url). Seeing this message usualy ' |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
268 |
'means your application hold some <form> where you should ' |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
269 |
'replace use of __message hidden input by form.set_message, ' |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
270 |
'so new _cwmsgid mechanism is properly used', |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
271 |
DeprecationWarning) |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
272 |
self.set_message(val) |
0 | 273 |
else: |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
274 |
self.form[param] = val |
1426 | 275 |
|
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
276 |
def no_script_form_param(self, param, value): |
0 | 277 |
"""ensure there is no script in a user form param |
278 |
||
279 |
by default return a cleaned string instead of raising a security |
|
280 |
exception |
|
281 |
||
282 |
this method should be called on every user input (form at least) fields |
|
283 |
that are at some point inserted in a generated html page to protect |
|
284 |
against script kiddies |
|
285 |
""" |
|
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
286 |
# safety belt for strange urls like http://...?vtitle=yo&vtitle=yo |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
287 |
if isinstance(value, (list, tuple)): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
288 |
self.error('no_script_form_param got a list (%s). Who generated the URL ?', |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
289 |
repr(value)) |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
290 |
value = value[0] |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
291 |
return remove_html_tags(value) |
1426 | 292 |
|
0 | 293 |
def list_form_param(self, param, form=None, pop=False): |
294 |
"""get param from form parameters and return its value as a list, |
|
295 |
skipping internal markers if any |
|
1426 | 296 |
|
0 | 297 |
* if the parameter isn't defined, return an empty list |
298 |
* if the parameter is a single (unicode) value, return a list |
|
299 |
containing that value |
|
300 |
* if the parameter is already a list or tuple, just skip internal |
|
301 |
markers |
|
302 |
||
8238
087bb529035c
[spelling] fix dictionnary -> dictionary typo
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8177
diff
changeset
|
303 |
if pop is True, the parameter is removed from the form dictionary |
0 | 304 |
""" |
305 |
if form is None: |
|
306 |
form = self.form |
|
1426 | 307 |
return list_form_param(form, param, pop) |
308 |
||
0 | 309 |
def reset_headers(self): |
310 |
"""used by AutomaticWebTest to clear html headers between tests on |
|
311 |
the same resultset |
|
312 |
""" |
|
7762
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
313 |
self.html_headers = HTMLHead(self) |
0 | 314 |
return self |
315 |
||
316 |
# web state helpers ####################################################### |
|
1426 | 317 |
|
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
318 |
@property |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
319 |
def message(self): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
320 |
try: |
7432
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
321 |
return self.session.data.pop(self._msgid, u'') |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
322 |
except AttributeError: |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
323 |
try: |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
324 |
return self._msg |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
325 |
except AttributeError: |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
326 |
return None |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
327 |
|
0 | 328 |
def set_message(self, msg): |
329 |
assert isinstance(msg, unicode) |
|
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
330 |
self._msg = msg |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
331 |
|
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
332 |
def set_message_id(self, msgid): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
333 |
self._msgid = msgid |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
334 |
|
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
335 |
@cached |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
336 |
def redirect_message_id(self): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
337 |
return make_uid() |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
338 |
|
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
339 |
def set_redirect_message(self, msg): |
7432
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
340 |
# TODO - this should probably be merged with append_to_redirect_message |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
341 |
assert isinstance(msg, unicode) |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
342 |
msgid = self.redirect_message_id() |
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
343 |
self.session.data[msgid] = msg |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
344 |
return msgid |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
345 |
|
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
346 |
def append_to_redirect_message(self, msg): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
347 |
msgid = self.redirect_message_id() |
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
348 |
currentmsg = self.session.data.get(msgid) |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
349 |
if currentmsg is not None: |
7432
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
350 |
currentmsg = u'%s %s' % (currentmsg, msg) |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
351 |
else: |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
352 |
currentmsg = msg |
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
353 |
self.session.data[msgid] = currentmsg |
4897
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
354 |
return msgid |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
355 |
|
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
356 |
def reset_message(self): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
357 |
if hasattr(self, '_msg'): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
358 |
del self._msg |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
359 |
if hasattr(self, '_msgid'): |
e402e0b32075
[web] start a new message system based on id of message stored in session's data
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4851
diff
changeset
|
360 |
del self._msgid |
1426 | 361 |
|
0 | 362 |
def update_search_state(self): |
363 |
"""update the current search state""" |
|
364 |
searchstate = self.form.get('__mode') |
|
8541
5b6bc27ece6e
[web] search state doesn't need cnx, remove useless test
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8538
diff
changeset
|
365 |
if not searchstate: |
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
366 |
searchstate = self.session.data.get('search_state', 'normal') |
0 | 367 |
self.set_search_state(searchstate) |
368 |
||
369 |
def set_search_state(self, searchstate): |
|
370 |
"""set a new search state""" |
|
371 |
if searchstate is None or searchstate == 'normal': |
|
372 |
self.search_state = (searchstate or 'normal',) |
|
373 |
else: |
|
374 |
self.search_state = ('linksearch', searchstate.split(':')) |
|
375 |
assert len(self.search_state[-1]) == 4 |
|
8541
5b6bc27ece6e
[web] search state doesn't need cnx, remove useless test
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8538
diff
changeset
|
376 |
self.session.data['search_state'] = searchstate |
0 | 377 |
|
1173
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
378 |
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
|
379 |
"""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
|
380 |
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
|
381 |
""" |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
382 |
try: |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
383 |
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
|
384 |
except IndexError: |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
385 |
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
|
386 |
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
|
387 |
if etype != searchedtype: |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
388 |
return False |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
389 |
return True |
8f123fd081f4
forgot to add that expected method (was a function in view.__init__)
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
390 |
|
0 | 391 |
def update_breadcrumbs(self): |
392 |
"""stores the last visisted page in session data""" |
|
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
393 |
searchstate = self.session.data.get('search_state') |
0 | 394 |
if searchstate == 'normal': |
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
395 |
breadcrumbs = self.session.data.get('breadcrumbs') |
0 | 396 |
if breadcrumbs is None: |
397 |
breadcrumbs = SizeConstrainedList(10) |
|
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
398 |
self.session.data['breadcrumbs'] = breadcrumbs |
4864
e77d3e95872d
[web req] check latest url in breadcrumbs is not the same as the current one to keep more valuable information
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4719
diff
changeset
|
399 |
breadcrumbs.append(self.url()) |
e77d3e95872d
[web req] check latest url in breadcrumbs is not the same as the current one to keep more valuable information
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4719
diff
changeset
|
400 |
else: |
e77d3e95872d
[web req] check latest url in breadcrumbs is not the same as the current one to keep more valuable information
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4719
diff
changeset
|
401 |
url = self.url() |
4974
025a491bad0c
take care to empty breadcrumbs
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4868
diff
changeset
|
402 |
if breadcrumbs and breadcrumbs[-1] != url: |
4864
e77d3e95872d
[web req] check latest url in breadcrumbs is not the same as the current one to keep more valuable information
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4719
diff
changeset
|
403 |
breadcrumbs.append(url) |
0 | 404 |
|
405 |
def last_visited_page(self): |
|
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
406 |
breadcrumbs = self.session.data.get('breadcrumbs') |
0 | 407 |
if breadcrumbs: |
408 |
return breadcrumbs.pop() |
|
409 |
return self.base_url() |
|
410 |
||
6062
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
411 |
def user_rql_callback(self, rqlargs, *args, **kwargs): |
7793
8a330017ca4d
[doc] add some documentation in cubicweb.web.action
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
7660
diff
changeset
|
412 |
"""register a user callback to execute some rql query, and return a URL |
8a330017ca4d
[doc] add some documentation in cubicweb.web.action
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
7660
diff
changeset
|
413 |
to call that callback which can be inserted in an HTML view. |
6062
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
414 |
|
7793
8a330017ca4d
[doc] add some documentation in cubicweb.web.action
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
7660
diff
changeset
|
415 |
`rqlargs` should be a tuple containing argument to give to the execute function. |
8a330017ca4d
[doc] add some documentation in cubicweb.web.action
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
7660
diff
changeset
|
416 |
|
8a330017ca4d
[doc] add some documentation in cubicweb.web.action
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
7660
diff
changeset
|
417 |
The first argument following rqlargs must be the message to be |
8a330017ca4d
[doc] add some documentation in cubicweb.web.action
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
7660
diff
changeset
|
418 |
displayed after the callback is called. |
6062
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
419 |
|
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
420 |
For other allowed arguments, see :meth:`user_callback` 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:
2788
diff
changeset
|
421 |
""" |
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:
2788
diff
changeset
|
422 |
def rqlexec(req, rql, args=None, key=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:
2788
diff
changeset
|
423 |
req.execute(rql, args, key) |
6062
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
424 |
return self.user_callback(rqlexec, rqlargs, *args, **kwargs) |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
425 |
|
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
426 |
def user_callback(self, cb, cbargs, *args, **kwargs): |
7793
8a330017ca4d
[doc] add some documentation in cubicweb.web.action
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
7660
diff
changeset
|
427 |
"""register the given user callback and return a URL which can |
8a330017ca4d
[doc] add some documentation in cubicweb.web.action
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
7660
diff
changeset
|
428 |
be inserted in an HTML view. When the URL is accessed, the |
8032
bcb87336c7d2
[doc] fix most of ReST compilation errors and warnings
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7990
diff
changeset
|
429 |
callback function will be called (as 'cb(req, \*cbargs)', and a |
7793
8a330017ca4d
[doc] add some documentation in cubicweb.web.action
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
7660
diff
changeset
|
430 |
message will be displayed in the web interface. The third |
8a330017ca4d
[doc] add some documentation in cubicweb.web.action
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
7660
diff
changeset
|
431 |
positional argument must be 'msg', containing the message. |
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:
2788
diff
changeset
|
432 |
|
6062
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
433 |
You can specify the underlying js function to call using a 'jsfunc' |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
434 |
named args, to one of :func:`userCallback`, |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
435 |
':func:`userCallbackThenUpdateUI`, ':func:`userCallbackThenReloadPage` |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
436 |
(the default). Take care arguments may vary according to the used |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
437 |
function. |
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:
2788
diff
changeset
|
438 |
""" |
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:
2788
diff
changeset
|
439 |
self.add_js('cubicweb.ajax.js') |
6062
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
440 |
jsfunc = kwargs.pop('jsfunc', 'userCallbackThenReloadPage') |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
441 |
if 'msg' in kwargs: |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
442 |
warn('[3.10] msg should be given as positional argument', |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
443 |
DeprecationWarning, stacklevel=2) |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
444 |
args = (kwargs.pop('msg'),) + args |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
445 |
assert not kwargs, 'dunno what to do with remaining kwargs: %s' % kwargs |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
446 |
cbname = self.register_onetime_callback(cb, *cbargs) |
f1a550102f5c
[request] enhanced user[_rql]_callback method, allowing to call other js variant, eg one of userCallback, userCallbackThenUpdateUI, userCallbackThenReloadPage (the default). Also benefit from the new magic js object.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
447 |
return "javascript: %s" % getattr(js, jsfunc)(cbname, *args) |
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:
2788
diff
changeset
|
448 |
|
0 | 449 |
def register_onetime_callback(self, func, *args): |
6564
ff9f7c566464
[request] fix ajax_replace_url which breaks if the url contains some quotes (that will be properly quoted but unquoted by the browser, breaking the js expression) by using a separated js function
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6543
diff
changeset
|
450 |
cbname = build_cb_uid(func.__name__) |
0 | 451 |
def _cb(req): |
452 |
try: |
|
7990
a673d1d9a738
[diet] drop pre 3.6 API compatibility (but attempt to keep data cmopatibility). Closes #2017916
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7894
diff
changeset
|
453 |
return func(req, *args) |
a673d1d9a738
[diet] drop pre 3.6 API compatibility (but attempt to keep data cmopatibility). Closes #2017916
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7894
diff
changeset
|
454 |
finally: |
a673d1d9a738
[diet] drop pre 3.6 API compatibility (but attempt to keep data cmopatibility). Closes #2017916
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7894
diff
changeset
|
455 |
self.unregister_callback(self.pageid, cbname) |
0 | 456 |
self.set_page_data(cbname, _cb) |
457 |
return cbname |
|
1426 | 458 |
|
0 | 459 |
def unregister_callback(self, pageid, cbname): |
460 |
assert pageid is not None |
|
461 |
assert cbname.startswith('cb_') |
|
462 |
self.info('unregistering callback %s for pageid %s', cbname, pageid) |
|
463 |
self.del_page_data(cbname) |
|
464 |
||
465 |
def clear_user_callbacks(self): |
|
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
466 |
if self.session is not None: # XXX |
8696
0bb18407c053
[toward py3k] rewrite dict.keys() and dict.values() (part of #2711624)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8695
diff
changeset
|
467 |
for key in list(self.session.data): |
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
468 |
if key.startswith('cb_'): |
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
469 |
del self.session.data[key] |
1426 | 470 |
|
0 | 471 |
# web edition helpers ##################################################### |
1426 | 472 |
|
0 | 473 |
@cached # so it's writed only once |
474 |
def fckeditor_config(self): |
|
7277
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7273
diff
changeset
|
475 |
fckeditor_url = self.build_url('fckeditor/fckeditor.js') |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7273
diff
changeset
|
476 |
self.add_js(fckeditor_url, localfile=False) |
0 | 477 |
self.html_headers.define_var('fcklang', self.lang) |
478 |
self.html_headers.define_var('fckconfigpath', |
|
7070
5f8e52d722c5
[web] provide a data_url() method on req and get_rid of explicit datadir_url usage (#1438736)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
6581
diff
changeset
|
479 |
self.data_url('cubicweb.fckcwconfig.js')) |
1013
948a3882c94a
add a use_fckeditor method on http request
sylvain.thenault@logilab.fr
parents:
940
diff
changeset
|
480 |
def use_fckeditor(self): |
948a3882c94a
add a use_fckeditor method on http request
sylvain.thenault@logilab.fr
parents:
940
diff
changeset
|
481 |
return self.vreg.config.fckeditor_installed() and self.property_value('ui.fckeditor') |
0 | 482 |
|
483 |
def edited_eids(self, withtype=False): |
|
484 |
"""return a list of edited eids""" |
|
485 |
yielded = False |
|
486 |
# warning: use .keys since the caller may change `form` |
|
487 |
form = self.form |
|
488 |
try: |
|
489 |
eids = form['eid'] |
|
490 |
except KeyError: |
|
4155
80cc9c6ddcf0
NothingToEdit is not a ValidationError, simplify
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4154
diff
changeset
|
491 |
raise NothingToEdit(self._('no selected entities')) |
0 | 492 |
if isinstance(eids, basestring): |
493 |
eids = (eids,) |
|
494 |
for peid in eids: |
|
495 |
if withtype: |
|
496 |
typekey = '__type:%s' % peid |
|
497 |
assert typekey in form, 'no entity type specified' |
|
498 |
yield peid, form[typekey] |
|
499 |
else: |
|
500 |
yield peid |
|
501 |
yielded = True |
|
502 |
if not yielded: |
|
4155
80cc9c6ddcf0
NothingToEdit is not a ValidationError, simplify
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4154
diff
changeset
|
503 |
raise NothingToEdit(self._('no selected entities')) |
0 | 504 |
|
505 |
# minparams=3 by default: at least eid, __type, and some params to change |
|
506 |
def extract_entity_params(self, eid, minparams=3): |
|
507 |
"""extract form parameters relative to the given eid""" |
|
508 |
params = {} |
|
509 |
eid = str(eid) |
|
510 |
form = self.form |
|
511 |
for param in form: |
|
512 |
try: |
|
513 |
name, peid = param.split(':', 1) |
|
514 |
except ValueError: |
|
7639
5c9e94a09e97
[web form] avoid mis-formated warning for _cw_fields
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7536
diff
changeset
|
515 |
if not param.startswith('__') and param not in ('eid', '_cw_fields'): |
6079 | 516 |
self.warning('param %s mis-formatted', param) |
0 | 517 |
continue |
518 |
if peid == eid: |
|
519 |
value = form[param] |
|
520 |
if value == INTERNAL_FIELD_VALUE: |
|
521 |
value = None |
|
522 |
params[name] = value |
|
523 |
params['eid'] = eid |
|
524 |
if len(params) < minparams: |
|
525 |
raise RequestError(self._('missing parameters for entity %s') % eid) |
|
526 |
return params |
|
1426 | 527 |
|
4277
35cd057339b2
turn all the stuff used to handle 'generic relations' in forms into proper
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
528 |
# XXX this should go to the GenericRelationsField. missing edition cancel protocol. |
0 | 529 |
|
530 |
def remove_pending_operations(self): |
|
531 |
"""shortcut to clear req's pending_{delete,insert} entries |
|
532 |
||
533 |
This is needed when the edition is completed (whether it's validated |
|
534 |
or cancelled) |
|
535 |
""" |
|
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
536 |
self.session.data.pop('pending_insert', None) |
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
537 |
self.session.data.pop('pending_delete', None) |
0 | 538 |
|
539 |
def cancel_edition(self, errorurl): |
|
540 |
"""remove pending operations and `errorurl`'s specific stored data |
|
541 |
""" |
|
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
542 |
self.session.data.pop(errorurl, None) |
0 | 543 |
self.remove_pending_operations() |
1426 | 544 |
|
0 | 545 |
# high level methods for HTTP headers management ########################## |
546 |
||
547 |
# must be cached since login/password are popped from the form dictionary |
|
548 |
# and this method may be called multiple times during authentication |
|
549 |
@cached |
|
550 |
def get_authorization(self): |
|
551 |
"""Parse and return the Authorization header""" |
|
552 |
if self.authmode == "cookie": |
|
553 |
try: |
|
554 |
user = self.form.pop("__login") |
|
555 |
passwd = self.form.pop("__password", '') |
|
556 |
return user, passwd.encode('UTF8') |
|
557 |
except KeyError: |
|
558 |
self.debug('no login/password in form params') |
|
559 |
return None, None |
|
560 |
else: |
|
561 |
return self.header_authorization() |
|
1426 | 562 |
|
0 | 563 |
def get_cookie(self): |
564 |
"""retrieve request cookies, returns an empty cookie if not found""" |
|
7855
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
565 |
# XXX use http_headers implementation |
0 | 566 |
try: |
7855
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
567 |
return SimpleCookie(self.get_header('Cookie')) |
0 | 568 |
except KeyError: |
7855
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
569 |
return SimpleCookie() |
0 | 570 |
|
7855
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
571 |
def set_cookie(self, name, value, maxage=300, expires=None, secure=False): |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
572 |
"""set / update a cookie |
0 | 573 |
|
574 |
by default, cookie will be available for the next 5 minutes. |
|
575 |
Give maxage = None to have a "session" cookie expiring when the |
|
576 |
client close its browser |
|
577 |
""" |
|
7855
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
578 |
if isinstance(name, SimpleCookie): |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
579 |
warn('[3.13] set_cookie now takes name and value as two first ' |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
580 |
'argument, not anymore cookie object and name', |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
581 |
DeprecationWarning, stacklevel=2) |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
582 |
secure = name[value]['secure'] |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
583 |
name, value = value, name[value].value |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
584 |
if maxage: # don't check is None, 0 may be specified |
7858
f91255a3b2c2
[web request] fix stupid error that gone through the review
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7855
diff
changeset
|
585 |
assert expires is None, 'both max age and expires cant be specified' |
7855
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
586 |
expires = maxage + time.time() |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
587 |
elif expires: |
8176
eff4fe02ec64
[req cookie] fix remove_cookie expires which was leading to expires computed to 0 in set_cookie and the Cookie class interpret that has no expires. Closes #2154654
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8081
diff
changeset
|
588 |
# we don't want to handle times before the EPOCH (cause bug on |
eff4fe02ec64
[req cookie] fix remove_cookie expires which was leading to expires computed to 0 in set_cookie and the Cookie class interpret that has no expires. Closes #2154654
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8081
diff
changeset
|
589 |
# windows). Also use > and not >= else expires == 0 and Cookie think |
eff4fe02ec64
[req cookie] fix remove_cookie expires which was leading to expires computed to 0 in set_cookie and the Cookie class interpret that has no expires. Closes #2154654
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8081
diff
changeset
|
590 |
# that means no expire... |
eff4fe02ec64
[req cookie] fix remove_cookie expires which was leading to expires computed to 0 in set_cookie and the Cookie class interpret that has no expires. Closes #2154654
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8081
diff
changeset
|
591 |
assert expires + GMTOFFSET > date(1970, 1, 1) |
7855
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
592 |
expires = timegm((expires + GMTOFFSET).timetuple()) |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
593 |
else: |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
594 |
expires = None |
0 | 595 |
# make sure cookie is set on the correct path |
7870
1a1e04163cde
[test] unicode name/value in cookie makes tests failing (SimpleCookie then suppose it's a dict...)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7858
diff
changeset
|
596 |
cookie = Cookie(str(name), str(value), self.base_url_path(), |
1a1e04163cde
[test] unicode name/value in cookie makes tests failing (SimpleCookie then suppose it's a dict...)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7858
diff
changeset
|
597 |
expires=expires, secure=secure) |
7855
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
598 |
self.headers_out.addHeader('Set-cookie', cookie) |
0 | 599 |
|
7855
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
600 |
def remove_cookie(self, name, bwcompat=None): |
0 | 601 |
"""remove a cookie by expiring it""" |
7855
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
602 |
if bwcompat is not None: |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
603 |
warn('[3.13] remove_cookie now take only a name as argument', |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
604 |
DeprecationWarning, stacklevel=2) |
54283a5b7afc
[web request] fix cookie 'expires' formating (closes #1953945)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7793
diff
changeset
|
605 |
name = bwcompat |
8176
eff4fe02ec64
[req cookie] fix remove_cookie expires which was leading to expires computed to 0 in set_cookie and the Cookie class interpret that has no expires. Closes #2154654
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8081
diff
changeset
|
606 |
self.set_cookie(name, '', maxage=0, expires=date(2000, 1, 1)) |
0 | 607 |
|
8611
51068fe1e39a
[web] allow configuration of the Content-disposition value
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8610
diff
changeset
|
608 |
def set_content_type(self, content_type, filename=None, encoding=None, |
8612
3bb96935a6b9
[web] use `inline` `Content-Disposition` by default (closes #2535734)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8611
diff
changeset
|
609 |
disposition='inline'): |
0 | 610 |
"""set output content type for this request. An optional filename |
8611
51068fe1e39a
[web] allow configuration of the Content-disposition value
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8610
diff
changeset
|
611 |
may be given. |
51068fe1e39a
[web] allow configuration of the Content-disposition value
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8610
diff
changeset
|
612 |
|
51068fe1e39a
[web] allow configuration of the Content-disposition value
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8610
diff
changeset
|
613 |
The disposition argument may be `attachement` or `inline` as specified |
51068fe1e39a
[web] allow configuration of the Content-disposition value
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8610
diff
changeset
|
614 |
for the Content-disposition HTTP header. The disposition parameter have |
51068fe1e39a
[web] allow configuration of the Content-disposition value
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8610
diff
changeset
|
615 |
no effect if no filename are specified. |
0 | 616 |
""" |
6353
b622602f8e9d
don't add another encoding if already present in content-type
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
6259
diff
changeset
|
617 |
if content_type.startswith('text/') and ';charset=' not in content_type: |
0 | 618 |
content_type += ';charset=' + (encoding or self.encoding) |
619 |
self.set_header('content-type', content_type) |
|
620 |
if filename: |
|
8611
51068fe1e39a
[web] allow configuration of the Content-disposition value
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8610
diff
changeset
|
621 |
header = [disposition] |
8610
b1145ad53999
[downloadable] fix filename HTTP header for simple name with space (closes #2535715)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8600
diff
changeset
|
622 |
unicode_filename = None |
8600
d74addac92bb
[downloadable] fix filename in HTTP header (closes #2522325, #2522324)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8480
diff
changeset
|
623 |
try: |
8610
b1145ad53999
[downloadable] fix filename HTTP header for simple name with space (closes #2535715)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8600
diff
changeset
|
624 |
ascii_filename = filename.encode('ascii') |
8600
d74addac92bb
[downloadable] fix filename in HTTP header (closes #2522325, #2522324)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8480
diff
changeset
|
625 |
except UnicodeEncodeError: |
d74addac92bb
[downloadable] fix filename in HTTP header (closes #2522325, #2522324)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8480
diff
changeset
|
626 |
# fallback filename for very old browser |
8610
b1145ad53999
[downloadable] fix filename HTTP header for simple name with space (closes #2535715)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8600
diff
changeset
|
627 |
unicode_filename = filename |
b1145ad53999
[downloadable] fix filename HTTP header for simple name with space (closes #2535715)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8600
diff
changeset
|
628 |
ascii_filename = filename.encode('ascii', 'ignore') |
b1145ad53999
[downloadable] fix filename HTTP header for simple name with space (closes #2535715)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8600
diff
changeset
|
629 |
# escape " and \ |
b1145ad53999
[downloadable] fix filename HTTP header for simple name with space (closes #2535715)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8600
diff
changeset
|
630 |
# see http://greenbytes.de/tech/tc2231/#attwithfilenameandextparamescaped |
b1145ad53999
[downloadable] fix filename HTTP header for simple name with space (closes #2535715)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8600
diff
changeset
|
631 |
ascii_filename = ascii_filename.replace('\x5c', r'\\').replace('"', r'\"') |
b1145ad53999
[downloadable] fix filename HTTP header for simple name with space (closes #2535715)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8600
diff
changeset
|
632 |
header.append('filename="%s"' % ascii_filename) |
b1145ad53999
[downloadable] fix filename HTTP header for simple name with space (closes #2535715)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8600
diff
changeset
|
633 |
if unicode_filename is not None: |
8600
d74addac92bb
[downloadable] fix filename in HTTP header (closes #2522325, #2522324)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8480
diff
changeset
|
634 |
# encoded filename according RFC5987 |
8610
b1145ad53999
[downloadable] fix filename HTTP header for simple name with space (closes #2535715)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8600
diff
changeset
|
635 |
urlquoted_filename = urllib.quote(unicode_filename.encode('utf-8'), '') |
b1145ad53999
[downloadable] fix filename HTTP header for simple name with space (closes #2535715)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8600
diff
changeset
|
636 |
header.append("filename*=utf-8''" + urlquoted_filename) |
8600
d74addac92bb
[downloadable] fix filename in HTTP header (closes #2522325, #2522324)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8480
diff
changeset
|
637 |
self.set_header('content-disposition', ';'.join(header)) |
0 | 638 |
|
639 |
# high level methods for HTML headers management ########################## |
|
640 |
||
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
|
641 |
def add_onload(self, jscode): |
4851
e55bdd10421e
remove deprecation warning introduced by add_onload api change
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4719
diff
changeset
|
642 |
self.html_headers.add_onload(jscode) |
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
|
643 |
|
0 | 644 |
def add_js(self, jsfiles, localfile=True): |
8032
bcb87336c7d2
[doc] fix most of ReST compilation errors and warnings
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7990
diff
changeset
|
645 |
"""specify a list of JS files to include in the HTML headers. |
bcb87336c7d2
[doc] fix most of ReST compilation errors and warnings
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7990
diff
changeset
|
646 |
|
0 | 647 |
:param jsfiles: a JS filename or a list of JS filenames |
648 |
:param localfile: if True, the default data dir prefix is added to the |
|
649 |
JS filename |
|
650 |
""" |
|
651 |
if isinstance(jsfiles, basestring): |
|
652 |
jsfiles = (jsfiles,) |
|
653 |
for jsfile in jsfiles: |
|
654 |
if localfile: |
|
7070
5f8e52d722c5
[web] provide a data_url() method on req and get_rid of explicit datadir_url usage (#1438736)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
6581
diff
changeset
|
655 |
jsfile = self.data_url(jsfile) |
0 | 656 |
self.html_headers.add_js(jsfile) |
657 |
||
4860
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4719
diff
changeset
|
658 |
def add_css(self, cssfiles, media=u'all', localfile=True, ieonly=False, |
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4719
diff
changeset
|
659 |
iespec=u'[if lt IE 8]'): |
0 | 660 |
"""specify a CSS file to include in the HTML headers |
5290
15846058378b
[doc/book] fix a bit the request chapter, add autodoc
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4984
diff
changeset
|
661 |
|
8032
bcb87336c7d2
[doc] fix most of ReST compilation errors and warnings
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7990
diff
changeset
|
662 |
:param cssfiles: a CSS filename or a list of CSS filenames. |
0 | 663 |
:param media: the CSS's media if necessary |
664 |
:param localfile: if True, the default data dir prefix is added to the |
|
665 |
CSS filename |
|
4860
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4719
diff
changeset
|
666 |
:param ieonly: True if this css is specific to IE |
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4719
diff
changeset
|
667 |
:param iespec: conditional expression that will be used around |
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4719
diff
changeset
|
668 |
the css inclusion. cf: |
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4719
diff
changeset
|
669 |
http://msdn.microsoft.com/en-us/library/ms537512(VS.85).aspx |
0 | 670 |
""" |
671 |
if isinstance(cssfiles, basestring): |
|
672 |
cssfiles = (cssfiles,) |
|
673 |
if ieonly: |
|
674 |
if self.ie_browser(): |
|
4860
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4719
diff
changeset
|
675 |
extraargs = [iespec] |
0 | 676 |
add_css = self.html_headers.add_ie_css |
677 |
else: |
|
678 |
return # no need to do anything on non IE browsers |
|
679 |
else: |
|
4860
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4719
diff
changeset
|
680 |
extraargs = [] |
0 | 681 |
add_css = self.html_headers.add_css |
682 |
for cssfile in cssfiles: |
|
683 |
if localfile: |
|
7070
5f8e52d722c5
[web] provide a data_url() method on req and get_rid of explicit datadir_url usage (#1438736)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
6581
diff
changeset
|
684 |
cssfile = self.data_url(cssfile) |
4860
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4719
diff
changeset
|
685 |
add_css(cssfile, media, *extraargs) |
1426 | 686 |
|
5713
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
687 |
@deprecated('[3.9] use ajax_replace_url() instead, naming rql and vid arguments') |
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
|
688 |
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
|
689 |
**extraparams): |
5713
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
690 |
return self.ajax_replace_url(nodeid, replacemode, rql=rql, vid=vid, |
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
691 |
**extraparams) |
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
692 |
|
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
693 |
def ajax_replace_url(self, nodeid, replacemode='replace', **extraparams): |
5290
15846058378b
[doc/book] fix a bit the request chapter, add autodoc
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4984
diff
changeset
|
694 |
"""builds an ajax url that will replace nodeid's content |
15846058378b
[doc/book] fix a bit the request chapter, add autodoc
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4984
diff
changeset
|
695 |
|
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
|
696 |
: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
|
697 |
:param replacemode: defines how the replacement should be done. |
5290
15846058378b
[doc/book] fix a bit the request chapter, add autodoc
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4984
diff
changeset
|
698 |
|
5713
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
699 |
Possible values are : |
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
700 |
- 'replace' to replace the node's content with the generated HTML |
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
701 |
- 'swap' to replace the node itself with the generated HTML |
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
702 |
- 'append' to append the generated HTML to the node's content |
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
703 |
|
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
704 |
Arbitrary extra named arguments may be given, they will be included as |
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
705 |
parameters of the generated url. |
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
|
706 |
""" |
6564
ff9f7c566464
[request] fix ajax_replace_url which breaks if the url contains some quotes (that will be properly quoted but unquoted by the browser, breaking the js expression) by using a separated js function
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6543
diff
changeset
|
707 |
# define a function in headers and use it in the link to avoid url |
ff9f7c566464
[request] fix ajax_replace_url which breaks if the url contains some quotes (that will be properly quoted but unquoted by the browser, breaking the js expression) by using a separated js function
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6543
diff
changeset
|
708 |
# unescaping pb: browsers give the js expression to the interpreter |
ff9f7c566464
[request] fix ajax_replace_url which breaks if the url contains some quotes (that will be properly quoted but unquoted by the browser, breaking the js expression) by using a separated js function
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6543
diff
changeset
|
709 |
# after having url unescaping the content. This may make appear some |
ff9f7c566464
[request] fix ajax_replace_url which breaks if the url contains some quotes (that will be properly quoted but unquoted by the browser, breaking the js expression) by using a separated js function
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6543
diff
changeset
|
710 |
# quote or other special characters that will break the js expression. |
5713
605f571198eb
[web] ajax_replace_url superseed build_ajax_replace_url, more generic and relying on the json controller (closes #750090)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5685
diff
changeset
|
711 |
extraparams.setdefault('fname', 'view') |
8730
d4d9f33fd01b
[web/request] Prune extraneous 'pageid' from generated ajax URL parameters (closes #2758130)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
8728
diff
changeset
|
712 |
# remove pageid from the generated URL as it's forced as a parameter |
d4d9f33fd01b
[web/request] Prune extraneous 'pageid' from generated ajax URL parameters (closes #2758130)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
8728
diff
changeset
|
713 |
# to the loadxhtml call below. |
d4d9f33fd01b
[web/request] Prune extraneous 'pageid' from generated ajax URL parameters (closes #2758130)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
8728
diff
changeset
|
714 |
extraparams.pop('pageid', None) |
8728
75be9de9d68e
[web] Use the new '/ajax' URL path to access the AjaxController (closes #2758254)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
8612
diff
changeset
|
715 |
url = self.build_url('ajax', **extraparams) |
6564
ff9f7c566464
[request] fix ajax_replace_url which breaks if the url contains some quotes (that will be properly quoted but unquoted by the browser, breaking the js expression) by using a separated js function
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6543
diff
changeset
|
716 |
cbname = build_cb_uid(url[:50]) |
7515
e1ba23fdcf2d
closes #1484510: ajax_replace_url should propagate page id (until an underlying api does it automatically
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7411
diff
changeset
|
717 |
# think to propagate pageid. XXX see https://www.cubicweb.org/ticket/1753121 |
7660
a1506b5306cc
closes #1826543: error on some ajax_replace_url call
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7639
diff
changeset
|
718 |
jscode = u'function %s() { $("#%s").%s; }' % ( |
7515
e1ba23fdcf2d
closes #1484510: ajax_replace_url should propagate page id (until an underlying api does it automatically
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7411
diff
changeset
|
719 |
cbname, nodeid, js.loadxhtml(url, {'pageid': self.pageid}, |
e1ba23fdcf2d
closes #1484510: ajax_replace_url should propagate page id (until an underlying api does it automatically
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7411
diff
changeset
|
720 |
'get', replacemode)) |
6564
ff9f7c566464
[request] fix ajax_replace_url which breaks if the url contains some quotes (that will be properly quoted but unquoted by the browser, breaking the js expression) by using a separated js function
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6543
diff
changeset
|
721 |
self.html_headers.add_post_inline_script(jscode) |
ff9f7c566464
[request] fix ajax_replace_url which breaks if the url contains some quotes (that will be properly quoted but unquoted by the browser, breaking the js expression) by using a separated js function
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6543
diff
changeset
|
722 |
return "javascript: %s()" % cbname |
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
|
723 |
|
0 | 724 |
# urls/path management #################################################### |
1426 | 725 |
|
7432
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
726 |
def build_url(self, *args, **kwargs): |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
727 |
"""return an absolute URL using params dictionary key/values as URL |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
728 |
parameters. Values are automatically URL quoted, and the |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
729 |
publishing method to use may be specified or will be guessed. |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
730 |
""" |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
731 |
if '__message' in kwargs: |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
732 |
msg = kwargs.pop('__message') |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
733 |
kwargs['_cwmsgid'] = self.set_redirect_message(msg) |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
734 |
return super(CubicWebRequestBase, self).build_url(*args, **kwargs) |
cab99ccdb774
[ui messages, xss] Start migration towards use of _msgid instead of __message (prone to XSS injection) closes #1698245
Arthur Lutz <arthur.lutz@logilab.fr>
parents:
7412
diff
changeset
|
735 |
|
0 | 736 |
def url(self, includeparams=True): |
737 |
"""return currently accessed url""" |
|
738 |
return self.base_url() + self.relative_path(includeparams) |
|
739 |
||
740 |
def selected(self, url): |
|
741 |
"""return True if the url is equivalent to currently accessed url""" |
|
742 |
reqpath = self.relative_path().lower() |
|
743 |
baselen = len(self.base_url()) |
|
744 |
return (reqpath == url[baselen:].lower()) |
|
745 |
||
746 |
def base_url_prepend_host(self, hostname): |
|
747 |
protocol, roothost = urlsplit(self.base_url())[:2] |
|
748 |
if roothost.startswith('www.'): |
|
749 |
roothost = roothost[4:] |
|
750 |
return '%s://%s.%s' % (protocol, hostname, roothost) |
|
751 |
||
752 |
def base_url_path(self): |
|
753 |
"""returns the absolute path of the base url""" |
|
754 |
return urlsplit(self.base_url())[2] |
|
1426 | 755 |
|
7070
5f8e52d722c5
[web] provide a data_url() method on req and get_rid of explicit datadir_url usage (#1438736)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
6581
diff
changeset
|
756 |
def data_url(self, relpath): |
5f8e52d722c5
[web] provide a data_url() method on req and get_rid of explicit datadir_url usage (#1438736)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
6581
diff
changeset
|
757 |
"""returns the absolute path for a data resouce""" |
5f8e52d722c5
[web] provide a data_url() method on req and get_rid of explicit datadir_url usage (#1438736)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
6581
diff
changeset
|
758 |
return self.datadir_url + relpath |
5f8e52d722c5
[web] provide a data_url() method on req and get_rid of explicit datadir_url usage (#1438736)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
6581
diff
changeset
|
759 |
|
0 | 760 |
@cached |
761 |
def from_controller(self): |
|
762 |
"""return the id (string) of the controller issuing the request""" |
|
763 |
controller = self.relative_path(False).split('/', 1)[0] |
|
8696
0bb18407c053
[toward py3k] rewrite dict.keys() and dict.values() (part of #2711624)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8695
diff
changeset
|
764 |
if controller in self.vreg['controllers']: |
0 | 765 |
return controller |
766 |
return 'view' |
|
1426 | 767 |
|
9229
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
768 |
def is_client_cache_valid(self): |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
769 |
"""check if a client cached page exists (as specified in request |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
770 |
headers) and is still usable. |
0 | 771 |
|
9229
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
772 |
Return False if the page has to be calculated, else True. |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
773 |
|
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
774 |
Some response cache headers may be set by this method. |
0 | 775 |
""" |
8316
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
776 |
modified = True |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
777 |
if self.get_header('Cache-Control') not in ('max-age=0', 'no-cache'): |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
778 |
# Here, we search for any invalid 'not modified' condition |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
779 |
# see http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html#sec13.3 |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
780 |
validators = get_validators(self._headers_in) |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
781 |
if validators: # if we have no |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
782 |
modified = any(func(val, self.headers_out) for func, val in validators) |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
783 |
# Forge expected response |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
784 |
if modified: |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
785 |
if 'Expires' not in self.headers_out: |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
786 |
# Expires header seems to be required by IE7 -- Are you sure ? |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
787 |
self.add_header('Expires', 'Sat, 01 Jan 2000 00:00:00 GMT') |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
788 |
if self.http_method() == 'HEAD': |
9229
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
789 |
self.status_out = 200 |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
790 |
# XXX replace by True once validate_cache bw compat method is dropped |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
791 |
return 200 |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
792 |
# /!\ no raise, the function returns and we keep processing the request |
8316
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
793 |
else: |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
794 |
# overwrite headers_out to forge a brand new not-modified response |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
795 |
self.headers_out = self._forge_cached_headers() |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
796 |
if self.http_method() in ('HEAD', 'GET'): |
9229
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
797 |
self.status_out = httplib.NOT_MODIFIED |
8316
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
798 |
else: |
9229
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
799 |
self.status_out = httplib.PRECONDITION_FAILED |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
800 |
# XXX replace by True once validate_cache bw compat method is dropped |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
801 |
return self.status_out |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
802 |
# XXX replace by False once validate_cache bw compat method is dropped |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
803 |
return None |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
804 |
|
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
805 |
@deprecated('[3.18] use .is_client_cache_valid() method instead') |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
806 |
def validate_cache(self): |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
807 |
"""raise a `StatusResponse` exception if a cached page along the way |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
808 |
exists and is still usable. |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
809 |
""" |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
810 |
status_code = self.is_client_cache_valid() |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
811 |
if status_code is not None: |
739ae5366bed
[web] stop using deprecated StatusResponse. Closes #3098215
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
9138
diff
changeset
|
812 |
raise StatusResponse(status_code) |
1426 | 813 |
|
0 | 814 |
# abstract methods to override according to the web front-end ############# |
1426 | 815 |
|
0 | 816 |
def http_method(self): |
817 |
"""returns 'POST', 'GET', 'HEAD', etc.""" |
|
818 |
raise NotImplementedError() |
|
819 |
||
8316
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
820 |
def _forge_cached_headers(self): |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
821 |
# overwrite headers_out to forge a brand new not-modified response |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
822 |
headers = Headers() |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
823 |
for header in ( |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
824 |
# Required from sec 10.3.5: |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
825 |
'date', 'etag', 'content-location', 'expires', |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
826 |
'cache-control', 'vary', |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
827 |
# Others: |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
828 |
'server', 'proxy-authenticate', 'www-authenticate', 'warning'): |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
829 |
value = self._headers_in.getRawHeaders(header) |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
830 |
if value is not None: |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
831 |
headers.setRawHeaders(header, value) |
d5b1b75805dd
[cache] factorize _validate_cache() logic implemented in wsgi and twisted handlers
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
8314
diff
changeset
|
832 |
return headers |
1426 | 833 |
|
0 | 834 |
def relative_path(self, includeparams=True): |
835 |
"""return the normalized path of the request (ie at least relative |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2315
diff
changeset
|
836 |
to the instance's root, but some other normalization may be needed |
0 | 837 |
so that the returned path may be used to compare to generated urls |
838 |
||
839 |
:param includeparams: |
|
840 |
boolean indicating if GET form parameters should be kept in the path |
|
841 |
""" |
|
842 |
raise NotImplementedError() |
|
843 |
||
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
844 |
# http headers ############################################################ |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
845 |
|
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
846 |
### incoming headers |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
847 |
|
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
848 |
def get_header(self, header, default=None, raw=True): |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
849 |
"""return the value associated with the given input header, raise |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
850 |
KeyError if the header is not set |
0 | 851 |
""" |
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
852 |
if raw: |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
853 |
return self._headers_in.getRawHeaders(header, [default])[0] |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
854 |
return self._headers_in.getHeader(header, default) |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
855 |
|
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
856 |
def header_accept_language(self): |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
857 |
"""returns an ordered list of preferred languages""" |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
858 |
acceptedlangs = self.get_header('Accept-Language', raw=False) or {} |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
859 |
for lang, _ in sorted(acceptedlangs.iteritems(), key=lambda x: x[1], |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
860 |
reverse=True): |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
861 |
lang = lang.split('-')[0] |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
862 |
yield lang |
0 | 863 |
|
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
864 |
def header_if_modified_since(self): |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
865 |
"""If the HTTP header If-modified-since is set, return the equivalent |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
866 |
date time value (GMT), else return None |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
867 |
""" |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
868 |
mtime = self.get_header('If-modified-since', raw=False) |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
869 |
if mtime: |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
870 |
# :/ twisted is returned a localized time stamp |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
871 |
return datetime.fromtimestamp(mtime) + GMTOFFSET |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
872 |
return None |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
873 |
|
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
874 |
### outcoming headers |
5155
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
875 |
def set_header(self, header, value, raw=True): |
0 | 876 |
"""set an output HTTP header""" |
5155
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
877 |
if raw: |
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
878 |
# adding encoded header is important, else page content |
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
879 |
# will be reconverted back to unicode and apart unefficiency, this |
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
880 |
# may cause decoding problem (e.g. when downloading a file) |
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
881 |
self.headers_out.setRawHeaders(header, [str(value)]) |
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
882 |
else: |
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
883 |
self.headers_out.setHeader(header, value) |
0 | 884 |
|
885 |
def add_header(self, header, value): |
|
886 |
"""add an output HTTP header""" |
|
5155
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
887 |
# adding encoded header is important, else page content |
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
888 |
# will be reconverted back to unicode and apart unefficiency, this |
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
889 |
# may cause decoding problem (e.g. when downloading a file) |
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
890 |
self.headers_out.addRawHeader(header, str(value)) |
1426 | 891 |
|
0 | 892 |
def remove_header(self, header): |
893 |
"""remove an output HTTP header""" |
|
5155
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4984
diff
changeset
|
894 |
self.headers_out.removeHeader(header) |
1426 | 895 |
|
0 | 896 |
def header_authorization(self): |
897 |
"""returns a couple (auth-type, auth-value)""" |
|
898 |
auth = self.get_header("Authorization", None) |
|
899 |
if auth: |
|
900 |
scheme, rest = auth.split(' ', 1) |
|
901 |
scheme = scheme.lower() |
|
902 |
try: |
|
903 |
assert scheme == "basic" |
|
904 |
user, passwd = base64.decodestring(rest).split(":", 1) |
|
905 |
# XXX HTTP header encoding: use email.Header? |
|
906 |
return user.decode('UTF8'), passwd |
|
8695
358d8bed9626
[toward-py3k] rewrite to "except AnException as exc:" (part of #2711624)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
8645
diff
changeset
|
907 |
except Exception as ex: |
0 | 908 |
self.debug('bad authorization %s (%s: %s)', |
909 |
auth, ex.__class__.__name__, ex) |
|
910 |
return None, None |
|
911 |
||
1716
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
912 |
def parse_accept_header(self, header): |
7164
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
913 |
"""returns an ordered list of accepted values""" |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
914 |
try: |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
915 |
value_parser, value_sort_key = ACCEPT_HEADER_PARSER[header.lower()] |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
916 |
except KeyError: |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
917 |
value_parser = value_sort_key = None |
1716
b12d9e22bac3
basic support for http Accept header (untested)
sylvain.thenault@logilab.fr
parents:
1560
diff
changeset
|
918 |
accepteds = self.get_header(header, '') |
7164
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
919 |
values = _parse_accept_header(accepteds, value_parser, value_sort_key) |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
920 |
return (raw_value for (raw_value, parsed_value, score) in values) |
0 | 921 |
|
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8889
diff
changeset
|
922 |
@deprecated('[3.17] demote_to_html is deprecated as we always serve html') |
3094
978ed8c2c0e4
[googlemap] #344872 set request content-type to text/html
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2650
diff
changeset
|
923 |
def demote_to_html(self): |
978ed8c2c0e4
[googlemap] #344872 set request content-type to text/html
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2650
diff
changeset
|
924 |
"""helper method to dynamically set request content type to text/html |
978ed8c2c0e4
[googlemap] #344872 set request content-type to text/html
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2650
diff
changeset
|
925 |
|
978ed8c2c0e4
[googlemap] #344872 set request content-type to text/html
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2650
diff
changeset
|
926 |
The global doctype and xmldec must also be changed otherwise the browser |
978ed8c2c0e4
[googlemap] #344872 set request content-type to text/html
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2650
diff
changeset
|
927 |
will display '<[' at the beginning of the page |
978ed8c2c0e4
[googlemap] #344872 set request content-type to text/html
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2650
diff
changeset
|
928 |
""" |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8889
diff
changeset
|
929 |
pass |
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8889
diff
changeset
|
930 |
|
7187
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7164
diff
changeset
|
931 |
|
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
932 |
# xml doctype ############################################################# |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8312
diff
changeset
|
933 |
|
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8889
diff
changeset
|
934 |
def set_doctype(self, doctype, reset_xmldecl=None): |
7187
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7164
diff
changeset
|
935 |
"""helper method to dynamically change page doctype |
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7164
diff
changeset
|
936 |
|
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7164
diff
changeset
|
937 |
:param doctype: the new doctype, e.g. '<!DOCTYPE html>' |
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7164
diff
changeset
|
938 |
""" |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8889
diff
changeset
|
939 |
if reset_xmldecl is not None: |
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8889
diff
changeset
|
940 |
warn('[3.17] reset_xmldecl is deprecated as we only serve html', |
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8889
diff
changeset
|
941 |
DeprecationWarning, stacklevel=2) |
9138
bc6e25dbfd04
[web doctype] don't give through reset_xmldecl to avoid double deprecation warning
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8974
diff
changeset
|
942 |
self.main_stream.set_doctype(doctype) |
3094
978ed8c2c0e4
[googlemap] #344872 set request content-type to text/html
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2650
diff
changeset
|
943 |
|
0 | 944 |
# page data management #################################################### |
945 |
||
946 |
def get_page_data(self, key, default=None): |
|
5683
ca2badf54858
[request] fix typo
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5505
diff
changeset
|
947 |
"""return value associated to `key` in current page data""" |
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
948 |
page_data = self.session.data.get(self.pageid) |
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
949 |
if page_data is None: |
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
950 |
return default |
0 | 951 |
return page_data.get(key, default) |
1426 | 952 |
|
0 | 953 |
def set_page_data(self, key, value): |
954 |
"""set value associated to `key` in current page data""" |
|
955 |
self.html_headers.add_unload_pagedata() |
|
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
956 |
page_data = self.session.data.setdefault(self.pageid, {}) |
0 | 957 |
page_data[key] = value |
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
958 |
self.session.data[self.pageid] = page_data |
1426 | 959 |
|
0 | 960 |
def del_page_data(self, key=None): |
961 |
"""remove value associated to `key` in current page data |
|
962 |
if `key` is None, all page data will be cleared |
|
963 |
""" |
|
964 |
if key is None: |
|
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
965 |
self.session.data.pop(self.pageid, None) |
0 | 966 |
else: |
5223
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
967 |
try: |
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
968 |
del self.session.data[self.pageid][key] |
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
969 |
except KeyError: |
6abd6e3599f4
#773448: refactor session and 'no connection' handling, by introducing proper web session. We should now be able to see page even when no anon is configured, and be redirected to the login form as soon as one tries to do a query.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5155
diff
changeset
|
970 |
pass |
0 | 971 |
|
972 |
# user-agent detection #################################################### |
|
973 |
||
974 |
@cached |
|
975 |
def useragent(self): |
|
976 |
return self.get_header('User-Agent', None) |
|
977 |
||
978 |
def ie_browser(self): |
|
979 |
useragent = self.useragent() |
|
980 |
return useragent and 'MSIE' in useragent |
|
1426 | 981 |
|
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8889
diff
changeset
|
982 |
@deprecated('[3.17] xhtml_browser is deprecated (xhtml is no longer served)') |
0 | 983 |
def xhtml_browser(self): |
2558
81c8b5312f9c
move test on force-html-content-type to xhtml_browser method
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2556
diff
changeset
|
984 |
"""return True if the browser is considered as xhtml compatible. |
81c8b5312f9c
move test on force-html-content-type to xhtml_browser method
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2556
diff
changeset
|
985 |
|
81c8b5312f9c
move test on force-html-content-type to xhtml_browser method
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2556
diff
changeset
|
986 |
If the instance is configured to always return text/html and not |
81c8b5312f9c
move test on force-html-content-type to xhtml_browser method
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2556
diff
changeset
|
987 |
application/xhtml+xml, this method will always return False, even though |
81c8b5312f9c
move test on force-html-content-type to xhtml_browser method
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2556
diff
changeset
|
988 |
this is semantically different |
81c8b5312f9c
move test on force-html-content-type to xhtml_browser method
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2556
diff
changeset
|
989 |
""" |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8889
diff
changeset
|
990 |
return False |
0 | 991 |
|
1421
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
992 |
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
|
993 |
return 'text/html' |
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1173
diff
changeset
|
994 |
|
5467
57372dbfd114
[https] fix resource urls in https version of a site: should use the https version as well to avoid warnings from the nrowser
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5444
diff
changeset
|
995 |
@deprecated('[3.9] use req.uiprops[rid]') |
5444
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
996 |
def external_resource(self, rid, default=_MARKER): |
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
997 |
"""return a path to an external resource, using its identifier |
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
998 |
|
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
999 |
raise `KeyError` if the resource is not defined |
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
1000 |
""" |
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
1001 |
try: |
5467
57372dbfd114
[https] fix resource urls in https version of a site: should use the https version as well to avoid warnings from the nrowser
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5444
diff
changeset
|
1002 |
return self.uiprops[rid] |
5444
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
1003 |
except KeyError: |
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
1004 |
if default is _MARKER: |
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
1005 |
raise |
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
1006 |
return default |
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
1007 |
|
f7fdb5dd82f6
[webconfig] introduce property sheets. Use them to replace external_resources
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5426
diff
changeset
|
1008 |
|
7164
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1009 |
|
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1010 |
## HTTP-accept parsers / utilies ############################################## |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1011 |
def _mimetype_sort_key(accept_info): |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1012 |
"""accepted mimetypes must be sorted by : |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1013 |
|
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1014 |
1/ highest score first |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1015 |
2/ most specific mimetype first, e.g. : |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1016 |
- 'text/html level=1' is more specific 'text/html' |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1017 |
- 'text/html' is more specific than 'text/*' |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1018 |
- 'text/*' itself more specific than '*/*' |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1019 |
|
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1020 |
""" |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1021 |
raw_value, (media_type, media_subtype, media_type_params), score = accept_info |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1022 |
# FIXME: handle '+' in media_subtype ? (should xhtml+xml have a |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1023 |
# higher precedence than xml ?) |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1024 |
if media_subtype == '*': |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1025 |
score -= 0.0001 |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1026 |
if media_type == '*': |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1027 |
score -= 0.0001 |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1028 |
return 1./score, media_type, media_subtype, 1./(1+len(media_type_params)) |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1029 |
|
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1030 |
def _charset_sort_key(accept_info): |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1031 |
"""accepted mimetypes must be sorted by : |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1032 |
|
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1033 |
1/ highest score first |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1034 |
2/ most specific charset first, e.g. : |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1035 |
- 'utf-8' is more specific than '*' |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1036 |
""" |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1037 |
raw_value, value, score = accept_info |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1038 |
if value == '*': |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1039 |
score -= 0.0001 |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1040 |
return 1./score, value |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1041 |
|
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1042 |
def _parse_accept_header(raw_header, value_parser=None, value_sort_key=None): |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1043 |
"""returns an ordered list accepted types |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1044 |
|
7273
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1045 |
:param value_parser: a function to parse a raw accept chunk. If None |
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1046 |
is provided, the function defaults to identity. If a function is provided, |
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1047 |
it must accept 2 parameters ``value`` and ``other_params``. ``value`` is |
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1048 |
the value found before the first ';', `other_params` is a dictionary |
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1049 |
built from all other chunks after this first ';' |
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1050 |
|
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1051 |
:param value_sort_key: a key function to sort values found in the accept |
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1052 |
header. This function will be passed a 3-tuple |
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1053 |
(raw_value, parsed_value, score). If None is provided, the default |
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1054 |
sort_key is 1./score |
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1055 |
|
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1056 |
:return: a list of 3-tuple (raw_value, parsed_value, score), |
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1057 |
ordered by score. ``parsed_value`` will be the return value of |
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1058 |
``value_parser(raw_value)`` |
7164
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1059 |
""" |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1060 |
if value_sort_key is None: |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1061 |
value_sort_key = lambda infos: 1./infos[-1] |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1062 |
values = [] |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1063 |
for info in raw_header.split(','): |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1064 |
score = 1.0 |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1065 |
other_params = {} |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1066 |
try: |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1067 |
value, infodef = info.split(';', 1) |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1068 |
except ValueError: |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1069 |
value = info |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1070 |
else: |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1071 |
for info in infodef.split(';'): |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1072 |
try: |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1073 |
infokey, infoval = info.split('=') |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1074 |
if infokey == 'q': # XXX 'level' |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1075 |
score = float(infoval) |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1076 |
continue |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1077 |
except ValueError: |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1078 |
continue |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1079 |
other_params[infokey] = infoval |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1080 |
parsed_value = value_parser(value, other_params) if value_parser else value |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1081 |
values.append( (value.strip(), parsed_value, score) ) |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1082 |
values.sort(key=value_sort_key) |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1083 |
return values |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1084 |
|
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1085 |
|
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1086 |
def _mimetype_parser(value, other_params): |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1087 |
"""return a 3-tuple |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1088 |
(type, subtype, type_params) corresponding to the mimetype definition |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1089 |
e.g. : for 'text/*', `mimetypeinfo` will be ('text', '*', {}), for |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1090 |
'text/html;level=1', `mimetypeinfo` will be ('text', '*', {'level': '1'}) |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1091 |
""" |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1092 |
try: |
7273
a949fc438029
[etwist] refactor child resources management
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7187
diff
changeset
|
1093 |
media_type, media_subtype = value.strip().split('/', 1) |
7164
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1094 |
except ValueError: # safety belt : '/' should always be present |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1095 |
media_type = value.strip() |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1096 |
media_subtype = '*' |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1097 |
return (media_type, media_subtype, other_params) |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1098 |
|
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1099 |
|
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1100 |
ACCEPT_HEADER_PARSER = { |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1101 |
'accept': (_mimetype_parser, _mimetype_sort_key), |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1102 |
'accept-charset': (None, _charset_sort_key), |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1103 |
} |
93a19c1831aa
[http] implement 1587305: provide better implementation of Accept header parsing + tests
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7070
diff
changeset
|
1104 |
|
0 | 1105 |
from cubicweb import set_log_methods |
1106 |
set_log_methods(CubicWebRequestBase, LOGGER) |