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'):
47
32
except ImportError:
48
33
# This needs to be importable from outside Apache.
54
38
import ivle.database
55
39
from ivle.webapp.base.plugins import CookiePlugin
56
import ivle.webapp.security
60
42
"""An IVLE request object. This is presented to the IVLE apps as a way of
97
79
String. Response "Location" header value. Used with HTTP redirect
82
List of strings. Write a list of URLs to CSS files here, and they
83
will be incorporated as <link rel="stylesheet" type="text/css">
84
elements in the head, if write_html_head_foot is True.
85
URLs should be relative to the IVLE root; they will be fixed up
88
List of strings. Write a list of URLs to JS files here, and they
89
will be incorporated as <script type="text/javascript"> elements
90
in the head, if write_html_head_foot is True.
91
URLs should be relative to the IVLE root; they will be fixed up
94
List of strings. Write a list of JS function names, and they
95
will be added as window.addListener('load', ..., false); calls
96
in the head, if write_html_head_foot is True.
97
This is the propper way to specify functions that need to run at
101
101
# Special code for an OK response.
106
106
# HTTP status codes
109
HTTP_SWITCHING_PROTOCOLS = 101
110
HTTP_PROCESSING = 102
114
HTTP_NON_AUTHORITATIVE = 203
115
HTTP_NO_CONTENT = 204
116
HTTP_RESET_CONTENT = 205
117
HTTP_PARTIAL_CONTENT = 206
118
HTTP_MULTI_STATUS = 207
119
HTTP_MULTIPLE_CHOICES = 300
120
HTTP_MOVED_PERMANENTLY = 301
109
121
HTTP_MOVED_TEMPORARILY = 302
123
HTTP_NOT_MODIFIED = 304
125
HTTP_TEMPORARY_REDIRECT = 307
126
HTTP_BAD_REQUEST = 400
127
HTTP_UNAUTHORIZED = 401
128
HTTP_PAYMENT_REQUIRED = 402
110
129
HTTP_FORBIDDEN = 403
111
130
HTTP_NOT_FOUND = 404
131
HTTP_METHOD_NOT_ALLOWED = 405
132
HTTP_NOT_ACCEPTABLE = 406
133
HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
134
HTTP_REQUEST_TIME_OUT = 408
137
HTTP_LENGTH_REQUIRED = 411
138
HTTP_PRECONDITION_FAILED = 412
139
HTTP_REQUEST_ENTITY_TOO_LARGE = 413
140
HTTP_REQUEST_URI_TOO_LARGE = 414
141
HTTP_UNSUPPORTED_MEDIA_TYPE = 415
142
HTTP_RANGE_NOT_SATISFIABLE = 416
143
HTTP_EXPECTATION_FAILED = 417
144
HTTP_UNPROCESSABLE_ENTITY = 422
146
HTTP_FAILED_DEPENDENCY = 424
112
147
HTTP_INTERNAL_SERVER_ERROR = 500
116
def __init__(self, req, config):
117
"""Create an IVLE request from a mod_python one.
119
@param req: A mod_python request.
120
@param config: An IVLE configuration.
148
HTTP_NOT_IMPLEMENTED = 501
149
HTTP_BAD_GATEWAY = 502
150
HTTP_SERVICE_UNAVAILABLE = 503
151
HTTP_GATEWAY_TIME_OUT = 504
152
HTTP_VERSION_NOT_SUPPORTED = 505
153
HTTP_VARIANT_ALSO_VARIES = 506
154
HTTP_INSUFFICIENT_STORAGE = 507
155
HTTP_NOT_EXTENDED = 510
157
def __init__(self, req):
158
"""Builds an IVLE request object from a mod_python request object.
159
This results in an object with all of the necessary methods and
162
req: A mod_python request object.
123
165
# Methods are mostly wrappers around the Apache request object
124
166
self.apache_req = req
126
167
self.headers_written = False
128
169
# Determine if the browser used the public host name to make the
129
170
# request (in which case we are in "public mode")
130
if req.hostname == config['urls']['public_host']:
171
if req.hostname == ivle.conf.public_host:
131
172
self.publicmode = True
133
174
self.publicmode = False
137
178
self.uri = req.uri
138
179
# Split the given path into the app (top-level dir) and sub-path
139
180
# (after first stripping away the root directory)
140
(self.app, self.path) = (ivle.util.split_path(req.uri))
181
path = ivle.util.unmake_path(req.uri)
182
(self.app, self.path) = (ivle.util.split_path(path))
141
184
self.hostname = req.hostname
142
185
self.headers_in = req.headers_in
143
186
self.headers_out = req.headers_out
188
# Open a database connection and transaction, keep it around for users
189
# of the Request object to use
190
self.store = ivle.database.get_store()
145
192
# Default values for the output members
146
193
self.status = Request.HTTP_OK
147
194
self.content_type = None # Use Apache's default
148
195
self.location = None
198
self.scripts_init = []
149
199
# In some cases we don't want the template JS (such as the username
150
200
# and public FQDN) in the output HTML. In that case, set this to 0.
151
201
self.write_javascript_settings = True
152
202
self.got_common_vars = False
154
204
def __del__(self):
159
if self._store is not None:
165
if self._store is not None:
168
208
def __writeheaders(self):
169
209
"""Writes out the HTTP and HTML headers before any real data is
253
293
mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
255
def make_path(self, path):
256
"""Prepend the IVLE URL prefix to the given path.
258
This is used when generating URLs to send to the client.
260
This method is DEPRECATED. We no longer support use of a prefix.
262
return os.path.join(self.config['urls']['root'], path)
264
295
def get_session(self):
265
296
"""Returns a mod_python Session object for this request.
266
297
Note that this is dependent on mod_python and may need to change
272
303
# Cache the session object and set the timeout to 24 hours.
273
304
if not hasattr(self, 'session'):
274
self.session = PotentiallySecureFileSession(
275
self.apache_req, timeout = 60 * 60 * 24)
305
self.session = mod_python.Session.FileSession(self.apache_req,
306
timeout = 60 * 60 * 24)
276
307
return self.session
278
309
def get_fieldstorage(self):
293
324
self.got_common_vars = True
294
325
return self.apache_req.subprocess_env
298
# Open a database connection and transaction, keep it around for users
299
# of the Request object to use.
300
if self._store is None:
301
self._store = ivle.database.get_store(self.config)
306
# Get and cache the request user, or None if it's not valid.
307
# This is a property so that we don't create a store unless
308
# some code actually requests the user.
328
def get_http_codename(code):
329
"""Given a HTTP error code int, returns a (name, description)
330
pair, suitable for displaying to the user.
331
May return (None,None) if code is unknown.
332
Only lists common 4xx and 5xx codes (since this is just used
333
to display throw_error error messages).
311
except AttributeError:
315
temp_user = ivle.webapp.security.get_user_details(self)
316
if temp_user and temp_user.valid:
317
self._user = temp_user
336
return http_codenames[code]
340
# Human strings for HTTP response codes
342
Request.HTTP_BAD_REQUEST:
344
"Your browser sent a request IVLE did not understand."),
345
Request.HTTP_UNAUTHORIZED:
347
"You are not allowed to view this part of IVLE."),
348
Request.HTTP_FORBIDDEN:
350
"You are not allowed to view this part of IVLE."),
351
Request.HTTP_NOT_FOUND:
353
"The application or file you requested does not exist."),
354
Request.HTTP_METHOD_NOT_ALLOWED:
355
("Method Not Allowed",
356
"Your browser is interacting with IVLE in the wrong way."
357
"This is probably a bug in IVLE. "
358
"Please report it to the administrators."),
359
Request.HTTP_INTERNAL_SERVER_ERROR:
360
("Internal Server Error",
361
"An unknown error occured in IVLE."),
362
Request.HTTP_NOT_IMPLEMENTED:
364
"The application or file you requested has not been implemented "
366
Request.HTTP_SERVICE_UNAVAILABLE:
367
("Service Unavailable",
368
"IVLE is currently experiencing technical difficulties. "
369
"Please try again later."),
added
removed
ivle/dispatch/request.py
