29
29
import mod_python.Session
30
30
import mod_python.Cookie
31
31
import mod_python.util
32
import mod_python.apache
34
class PotentiallySecureFileSession(mod_python.Session.FileSession):
35
"""A mod_python FileSession that sets secure cookie when appropriate.
37
A secure cookie will be set if the request itself is over HTTPS, or if
38
a proxy in front has set X-Forwarded-Proto: https. Otherwise the cookie
41
def make_cookie(self):
42
cookie = super(PotentiallySecureFileSession, self).make_cookie()
43
if (self._req.is_https() or
44
self._req.headers_in.get('X-Forwarded-Proto') == 'https'):
32
47
except ImportError:
33
48
# This needs to be importable from outside Apache.
48
65
String. The request method (eg. 'GET', 'POST', etc)
50
67
String. The path portion of the URI.
69
String. The path portion of the URI, unparsed with query string.
52
71
String. Name of the application specified in the URL, or None.
80
99
String. Response "Location" header value. Used with HTTP redirect
83
List of strings. Write a list of URLs to CSS files here, and they
84
will be incorporated as <link rel="stylesheet" type="text/css">
85
elements in the head, if write_html_head_foot is True.
86
URLs should be relative to the IVLE root; they will be fixed up
89
List of strings. Write a list of URLs to JS files here, and they
90
will be incorporated as <script type="text/javascript"> elements
91
in the head, if write_html_head_foot is True.
92
URLs should be relative to the IVLE root; they will be fixed up
95
List of strings. Write a list of JS function names, and they
96
will be added as window.addListener('load', ..., false); calls
97
in the head, if write_html_head_foot is True.
98
This is the propper way to specify functions that need to run at
102
103
# Special code for an OK response.
107
108
# HTTP status codes
110
HTTP_SWITCHING_PROTOCOLS = 101
111
HTTP_PROCESSING = 102
115
HTTP_NON_AUTHORITATIVE = 203
116
HTTP_NO_CONTENT = 204
117
HTTP_RESET_CONTENT = 205
118
HTTP_PARTIAL_CONTENT = 206
119
HTTP_MULTI_STATUS = 207
120
HTTP_MULTIPLE_CHOICES = 300
121
HTTP_MOVED_PERMANENTLY = 301
122
111
HTTP_MOVED_TEMPORARILY = 302
124
HTTP_NOT_MODIFIED = 304
126
HTTP_TEMPORARY_REDIRECT = 307
127
HTTP_BAD_REQUEST = 400
128
HTTP_UNAUTHORIZED = 401
129
HTTP_PAYMENT_REQUIRED = 402
130
112
HTTP_FORBIDDEN = 403
131
113
HTTP_NOT_FOUND = 404
132
HTTP_METHOD_NOT_ALLOWED = 405
133
HTTP_NOT_ACCEPTABLE = 406
134
HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
135
HTTP_REQUEST_TIME_OUT = 408
138
HTTP_LENGTH_REQUIRED = 411
139
HTTP_PRECONDITION_FAILED = 412
140
HTTP_REQUEST_ENTITY_TOO_LARGE = 413
141
HTTP_REQUEST_URI_TOO_LARGE = 414
142
HTTP_UNSUPPORTED_MEDIA_TYPE = 415
143
HTTP_RANGE_NOT_SATISFIABLE = 416
144
HTTP_EXPECTATION_FAILED = 417
145
HTTP_UNPROCESSABLE_ENTITY = 422
147
HTTP_FAILED_DEPENDENCY = 424
148
114
HTTP_INTERNAL_SERVER_ERROR = 500
149
HTTP_NOT_IMPLEMENTED = 501
150
HTTP_BAD_GATEWAY = 502
151
HTTP_SERVICE_UNAVAILABLE = 503
152
HTTP_GATEWAY_TIME_OUT = 504
153
HTTP_VERSION_NOT_SUPPORTED = 505
154
HTTP_VARIANT_ALSO_VARIES = 506
155
HTTP_INSUFFICIENT_STORAGE = 507
156
HTTP_NOT_EXTENDED = 510
158
118
def __init__(self, req, config):
159
119
"""Create an IVLE request from a mod_python one.
177
137
# Inherit values for the input members
178
138
self.method = req.method
179
139
self.uri = req.uri
140
self.unparsed_uri = req.unparsed_uri
180
141
# Split the given path into the app (top-level dir) and sub-path
181
142
# (after first stripping away the root directory)
182
path = self.unmake_path(req.uri)
183
(self.app, self.path) = (ivle.util.split_path(path))
143
(self.app, self.path) = (ivle.util.split_path(req.uri))
185
144
self.hostname = req.hostname
186
145
self.headers_in = req.headers_in
187
146
self.headers_out = req.headers_out
189
# Open a database connection and transaction, keep it around for users
190
# of the Request object to use
191
self.store = ivle.database.get_store(config)
193
148
# Default values for the output members
194
149
self.status = Request.HTTP_OK
195
150
self.content_type = None # Use Apache's default
196
151
self.location = None
199
self.scripts_init = []
200
152
# In some cases we don't want the template JS (such as the username
201
153
# and public FQDN) in the output HTML. In that case, set this to 0.
202
154
self.write_javascript_settings = True
203
155
self.got_common_vars = False
205
157
def __del__(self):
162
if self._store is not None:
168
if self._store is not None:
209
171
def __writeheaders(self):
210
172
"""Writes out the HTTP and HTML headers before any real data is
294
256
mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
296
def unmake_path(self, path):
297
"""Strip the IVLE URL prefix from the given path, if present.
299
Also normalises the path.
258
def make_path(self, path):
259
"""Prepend the IVLE URL prefix to the given path.
261
This is used when generating URLs to send to the client.
263
This method is DEPRECATED. We no longer support use of a prefix.
301
path = os.path.normpath(path)
302
root = os.path.normpath(self.config['urls']['root'])
304
if path.startswith(root):
305
path = path[len(root):]
306
# Take out the slash as well
307
if len(path) > 0 and path[0] == os.sep:
265
return os.path.join(self.config['urls']['root'], path)
312
267
def get_session(self):
313
268
"""Returns a mod_python Session object for this request.
320
275
# Cache the session object and set the timeout to 24 hours.
321
276
if not hasattr(self, 'session'):
322
self.session = mod_python.Session.FileSession(self.apache_req,
323
timeout = 60 * 60 * 24)
277
self.session = PotentiallySecureFileSession(
278
self.apache_req, timeout = 60 * 60 * 24)
324
279
return self.session
326
281
def get_fieldstorage(self):
341
296
self.got_common_vars = True
342
297
return self.apache_req.subprocess_env
345
def get_http_codename(code):
346
"""Given a HTTP error code int, returns a (name, description)
347
pair, suitable for displaying to the user.
348
May return (None,None) if code is unknown.
349
Only lists common 4xx and 5xx codes (since this is just used
350
to display throw_error error messages).
301
# Open a database connection and transaction, keep it around for users
302
# of the Request object to use.
303
if self._store is None:
304
self._store = ivle.database.get_store(self.config)
309
# Get and cache the request user, or None if it's not valid.
310
# This is a property so that we don't create a store unless
311
# some code actually requests the user.
353
return http_codenames[code]
314
except AttributeError:
318
temp_user = ivle.webapp.security.get_user_details(self)
319
if temp_user and temp_user.valid:
320
self._user = temp_user
357
# Human strings for HTTP response codes
359
Request.HTTP_BAD_REQUEST:
361
"Your browser sent a request IVLE did not understand."),
362
Request.HTTP_UNAUTHORIZED:
364
"You are not allowed to view this part of IVLE."),
365
Request.HTTP_FORBIDDEN:
367
"You are not allowed to view this part of IVLE."),
368
Request.HTTP_NOT_FOUND:
370
"The application or file you requested does not exist."),
371
Request.HTTP_METHOD_NOT_ALLOWED:
372
("Method Not Allowed",
373
"Your browser is interacting with IVLE in the wrong way."
374
"This is probably a bug in IVLE. "
375
"Please report it to the administrators."),
376
Request.HTTP_INTERNAL_SERVER_ERROR:
377
("Internal Server Error",
378
"An unknown error occured in IVLE."),
379
Request.HTTP_NOT_IMPLEMENTED:
381
"The application or file you requested has not been implemented "
383
Request.HTTP_SERVICE_UNAVAILABLE:
384
("Service Unavailable",
385
"IVLE is currently experiencing technical difficulties. "
386
"Please try again later."),
added
removed
ivle/dispatch/request.py
