author | Julien Cristau <julien.cristau@logilab.fr> |
Tue, 01 Apr 2014 15:46:17 +0200 | |
changeset 9607 | 6942622fd5dc |
parent 9563 | 48f0ff3e2a32 |
child 9735 | b71158815bc8 |
child 9737 | c6f47e635845 |
permissions | -rw-r--r-- |
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:
5426
diff
changeset
|
1 |
# copyright 2003-2011 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:
4212
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:
4212
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:
4212
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:
4212
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:
4212
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:
4212
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:
4212
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:
4212
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:
4212
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:
4212
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:
4212
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:
4212
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:
4212
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:
4212
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:
4212
diff
changeset
|
17 |
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>. |
0 | 18 |
"""WSGI request adapter for cubicweb |
19 |
||
20 |
NOTE: each docstring tagged with ``COME FROM DJANGO`` means that |
|
21 |
the code has been taken (or adapted) from Djanco source code : |
|
22 |
http://www.djangoproject.com/ |
|
23 |
||
24 |
""" |
|
25 |
||
26 |
__docformat__ = "restructuredtext en" |
|
27 |
||
28 |
from StringIO import StringIO |
|
29 |
from urllib import quote |
|
30 |
||
31 |
from logilab.common.decorators import cached |
|
32 |
||
33 |
from cubicweb.web.request import CubicWebRequestBase |
|
34 |
from cubicweb.wsgi import (pformat, qs2dict, safe_copyfileobj, parse_file_upload, |
|
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
35 |
normalize_header) |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
36 |
from cubicweb.web.http_headers import Headers |
0 | 37 |
|
38 |
||
39 |
||
40 |
class CubicWebWsgiRequest(CubicWebRequestBase): |
|
8752
e19f4bba89cd
Add CubicWebRequestBase.content (closes #2742453)
Julien Cristau <julien.cristau@logilab.fr>
parents:
8316
diff
changeset
|
41 |
"""most of this code COMES FROM DJANGO |
0 | 42 |
""" |
1802
d628defebc17
delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
0
diff
changeset
|
43 |
|
8309
48ef505aa9f9
[request] gather all base_url logic in a single place (closes #2200756)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7879
diff
changeset
|
44 |
def __init__(self, environ, vreg): |
0 | 45 |
self.environ = environ |
46 |
self.path = environ['PATH_INFO'] |
|
47 |
self.method = environ['REQUEST_METHOD'].upper() |
|
9563
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
48 |
try: |
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
49 |
length = int(environ['CONTENT_LENGTH']) |
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
50 |
except (KeyError, ValueError): |
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
51 |
length = 0 |
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
52 |
# wsgi.input is not seekable, so copy the request contents to a temporary file |
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
53 |
if length < 100000: |
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
54 |
self.content = StringIO() |
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
55 |
else: |
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
56 |
self.content = tempfile.TemporaryFile() |
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
57 |
safe_copyfileobj(environ['wsgi.input'], self.content, size=length) |
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
58 |
self.content.seek(0, 0) |
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
59 |
|
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
60 |
headers_in = dict((normalize_header(k[5:]), v) for k, v in self.environ.items() |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
61 |
if k.startswith('HTTP_')) |
0 | 62 |
https = environ.get("HTTPS") in ('yes', 'on', '1') |
63 |
post, files = self.get_posted_data() |
|
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
64 |
|
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
65 |
super(CubicWebWsgiRequest, self).__init__(vreg, https, post, |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
66 |
headers= headers_in) |
0 | 67 |
if files is not None: |
5155
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4212
diff
changeset
|
68 |
for key, (name, _, stream) in files.iteritems(): |
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
69 |
if name is not None: |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
70 |
name = unicode(name, self.encoding) |
5155
1dea6e0fdfc1
Switched from TwistedWeb2 to TwistedWeb
Adrien Chauve <adrien.chauve@logilab.fr>
parents:
4212
diff
changeset
|
71 |
self.form[key] = (name, stream) |
1802
d628defebc17
delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
0
diff
changeset
|
72 |
|
0 | 73 |
def __repr__(self): |
74 |
# Since this is called as part of error handling, we need to be very |
|
75 |
# robust against potentially malformed input. |
|
76 |
form = pformat(self.form) |
|
77 |
meta = pformat(self.environ) |
|
78 |
return '<CubicWebWsgiRequest\FORM:%s,\nMETA:%s>' % \ |
|
79 |
(form, meta) |
|
80 |
||
81 |
## cubicweb request interface ################################################ |
|
1802
d628defebc17
delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
0
diff
changeset
|
82 |
|
0 | 83 |
def http_method(self): |
84 |
"""returns 'POST', 'GET', 'HEAD', etc.""" |
|
85 |
return self.method |
|
1802
d628defebc17
delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
0
diff
changeset
|
86 |
|
0 | 87 |
def relative_path(self, includeparams=True): |
88 |
"""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:
1977
diff
changeset
|
89 |
to the instance's root, but some other normalization may be needed |
0 | 90 |
so that the returned path may be used to compare to generated urls |
91 |
||
92 |
:param includeparams: |
|
93 |
boolean indicating if GET form parameters should be kept in the path |
|
94 |
""" |
|
95 |
path = self.environ['PATH_INFO'] |
|
96 |
path = path[1:] # remove leading '/' |
|
97 |
if includeparams: |
|
98 |
qs = self.environ.get('QUERY_STRING') |
|
99 |
if qs: |
|
100 |
return '%s?%s' % (path, qs) |
|
1802
d628defebc17
delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
0
diff
changeset
|
101 |
|
0 | 102 |
return path |
103 |
||
104 |
## wsgi request helpers ################################################### |
|
1802
d628defebc17
delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
0
diff
changeset
|
105 |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
106 |
def instance_uri(self): |
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
107 |
"""Return the instance's base URI (no PATH_INFO or QUERY_STRING) |
0 | 108 |
|
2476
1294a6bdf3bf
application -> instance where it makes sense
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
109 |
see python2.5's wsgiref.util.instance_uri code |
0 | 110 |
""" |
111 |
environ = self.environ |
|
112 |
url = environ['wsgi.url_scheme'] + '://' |
|
113 |
if environ.get('HTTP_HOST'): |
|
114 |
url += environ['HTTP_HOST'] |
|
115 |
else: |
|
116 |
url += environ['SERVER_NAME'] |
|
117 |
if environ['wsgi.url_scheme'] == 'https': |
|
118 |
if environ['SERVER_PORT'] != '443': |
|
119 |
url += ':' + environ['SERVER_PORT'] |
|
120 |
else: |
|
121 |
if environ['SERVER_PORT'] != '80': |
|
122 |
url += ':' + environ['SERVER_PORT'] |
|
123 |
url += quote(environ.get('SCRIPT_NAME') or '/') |
|
124 |
return url |
|
1802
d628defebc17
delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
0
diff
changeset
|
125 |
|
0 | 126 |
def get_full_path(self): |
127 |
return '%s%s' % (self.path, self.environ.get('QUERY_STRING', '') and ('?' + self.environ.get('QUERY_STRING', '')) or '') |
|
128 |
||
129 |
def is_secure(self): |
|
130 |
return 'wsgi.url_scheme' in self.environ \ |
|
131 |
and self.environ['wsgi.url_scheme'] == 'https' |
|
132 |
||
133 |
def get_posted_data(self): |
|
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
134 |
# The WSGI spec says 'QUERY_STRING' may be absent. |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
135 |
post = qs2dict(self.environ.get('QUERY_STRING', '')) |
0 | 136 |
files = None |
137 |
if self.method == 'POST': |
|
138 |
if self.environ.get('CONTENT_TYPE', '').startswith('multipart'): |
|
139 |
header_dict = dict((normalize_header(k[5:]), v) |
|
140 |
for k, v in self.environ.items() |
|
141 |
if k.startswith('HTTP_')) |
|
142 |
header_dict['Content-Type'] = self.environ.get('CONTENT_TYPE', '') |
|
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
143 |
post_, files = parse_file_upload(header_dict, self.raw_post_data) |
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
144 |
post.update(post_) |
0 | 145 |
else: |
8314
cfd6ab461849
[Web-Request] Use rich header (closes #2204164)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8309
diff
changeset
|
146 |
post.update(qs2dict(self.raw_post_data)) |
0 | 147 |
return post, files |
148 |
||
149 |
@property |
|
150 |
@cached |
|
151 |
def raw_post_data(self): |
|
9563
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
152 |
postdata = self.content.read() |
48f0ff3e2a32
[wsgi] make sure request.content is available for consumption
Julien Cristau <julien.cristau@logilab.fr>
parents:
8752
diff
changeset
|
153 |
self.content.seek(0, 0) |
0 | 154 |
return postdata |