29
import mod_python.Session
30
import mod_python.Cookie
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'):
48
# This needs to be importable from outside Apache.
29
from mod_python import (util, Session, Cookie)
54
33
import ivle.database
55
from ivle.webapp.base.plugins import CookiePlugin
56
import ivle.webapp.security
34
import plugins.console # XXX: Relies on www/ being in the Python path.
60
37
"""An IVLE request object. This is presented to the IVLE apps as a way of
96
71
content_type (write)
97
72
String. The Content-Type (mime type) header value.
98
content_length (write)
99
Integer. The number of octets to be transfered.
101
74
String. Response "Location" header value. Used with HTTP redirect
77
String. HTML page title. Used if write_html_head_foot is True, in
78
the HTML title element text.
80
List of strings. Write a list of URLs to CSS files here, and they
81
will be incorporated as <link rel="stylesheet" type="text/css">
82
elements in the head, if write_html_head_foot is True.
83
URLs should be relative to the IVLE root; they will be fixed up
86
List of strings. Write a list of URLs to JS files here, and they
87
will be incorporated as <script type="text/javascript"> elements
88
in the head, if write_html_head_foot is True.
89
URLs should be relative to the IVLE root; they will be fixed up
92
List of strings. Write a list of JS function names, and they
93
will be added as window.addListener('load', ..., false); calls
94
in the head, if write_html_head_foot is True.
95
This is the propper way to specify functions that need to run at
97
write_html_head_foot (write)
98
Boolean. If True, dispatch assumes that this is an XHTML page, and
99
will immediately write a full HTML head, open the body element,
100
and write heading contents to the page, before any bytes are
101
written. It will then write footer contents and close the body and
102
html elements at the end of execution.
104
This value should be set to true by all applications for all HTML
105
output (unless there is a good reason, eg. exec). The
106
applications should therefore output HTML content assuming that
107
it will be written inside the body tag. Do not write opening or
108
closing <html> or <body> tags.
105
111
# Special code for an OK response.
110
116
# HTTP status codes
119
HTTP_SWITCHING_PROTOCOLS = 101
120
HTTP_PROCESSING = 102
124
HTTP_NON_AUTHORITATIVE = 203
125
HTTP_NO_CONTENT = 204
126
HTTP_RESET_CONTENT = 205
127
HTTP_PARTIAL_CONTENT = 206
128
HTTP_MULTI_STATUS = 207
129
HTTP_MULTIPLE_CHOICES = 300
130
HTTP_MOVED_PERMANENTLY = 301
113
131
HTTP_MOVED_TEMPORARILY = 302
133
HTTP_NOT_MODIFIED = 304
135
HTTP_TEMPORARY_REDIRECT = 307
136
HTTP_BAD_REQUEST = 400
137
HTTP_UNAUTHORIZED = 401
138
HTTP_PAYMENT_REQUIRED = 402
114
139
HTTP_FORBIDDEN = 403
115
140
HTTP_NOT_FOUND = 404
141
HTTP_METHOD_NOT_ALLOWED = 405
142
HTTP_NOT_ACCEPTABLE = 406
143
HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
144
HTTP_REQUEST_TIME_OUT = 408
147
HTTP_LENGTH_REQUIRED = 411
148
HTTP_PRECONDITION_FAILED = 412
149
HTTP_REQUEST_ENTITY_TOO_LARGE = 413
150
HTTP_REQUEST_URI_TOO_LARGE = 414
151
HTTP_UNSUPPORTED_MEDIA_TYPE = 415
152
HTTP_RANGE_NOT_SATISFIABLE = 416
153
HTTP_EXPECTATION_FAILED = 417
154
HTTP_UNPROCESSABLE_ENTITY = 422
156
HTTP_FAILED_DEPENDENCY = 424
116
157
HTTP_INTERNAL_SERVER_ERROR = 500
120
def __init__(self, req, config):
121
"""Create an IVLE request from a mod_python one.
123
@param req: A mod_python request.
124
@param config: An IVLE configuration.
158
HTTP_NOT_IMPLEMENTED = 501
159
HTTP_BAD_GATEWAY = 502
160
HTTP_SERVICE_UNAVAILABLE = 503
161
HTTP_GATEWAY_TIME_OUT = 504
162
HTTP_VERSION_NOT_SUPPORTED = 505
163
HTTP_VARIANT_ALSO_VARIES = 506
164
HTTP_INSUFFICIENT_STORAGE = 507
165
HTTP_NOT_EXTENDED = 510
167
def __init__(self, req, write_html_head):
168
"""Builds an IVLE request object from a mod_python request object.
169
This results in an object with all of the necessary methods and
172
req: A mod_python request object.
173
write_html_head: Function which is called when writing the automatic
174
HTML header. Accepts a single argument, the IVLE request object.
127
177
# Methods are mostly wrappers around the Apache request object
128
178
self.apache_req = req
179
self.func_write_html_head = write_html_head
130
180
self.headers_written = False
132
182
# Determine if the browser used the public host name to make the
133
183
# request (in which case we are in "public mode")
134
if req.hostname == config['urls']['public_host']:
184
if req.hostname == ivle.conf.public_host:
135
185
self.publicmode = True
137
187
self.publicmode = False
139
189
# Inherit values for the input members
140
190
self.method = req.method
141
191
self.uri = req.uri
142
self.unparsed_uri = req.unparsed_uri
143
192
# Split the given path into the app (top-level dir) and sub-path
144
193
# (after first stripping away the root directory)
145
(self.app, self.path) = (ivle.util.split_path(req.uri))
194
path = ivle.util.unmake_path(req.uri)
195
(self.app, self.path) = (ivle.util.split_path(path))
146
197
self.hostname = req.hostname
147
198
self.headers_in = req.headers_in
148
199
self.headers_out = req.headers_out
201
# Open a database connection and transaction, keep it around for users
202
# of the Request object to use
203
self.store = ivle.database.get_store()
150
205
# Default values for the output members
151
206
self.status = Request.HTTP_OK
152
207
self.content_type = None # Use Apache's default
153
self.content_length = None # Don't provide Content-Length
154
208
self.location = None
209
self.title = None # Will be set by dispatch before passing to app
212
self.scripts_init = []
213
self.write_html_head_foot = False
155
214
# In some cases we don't want the template JS (such as the username
156
215
# and public FQDN) in the output HTML. In that case, set this to 0.
157
216
self.write_javascript_settings = True
158
217
self.got_common_vars = False
160
219
def __del__(self):
165
if self._store is not None:
171
if self._store is not None:
174
223
def __writeheaders(self):
175
224
"""Writes out the HTTP and HTML headers before any real data is
177
226
self.headers_written = True
228
# app is the App object for the chosen app
230
app = ivle.conf.apps.app_url[self.app]
234
# Write any final modifications to header content
235
if app and app.useconsole and self.user:
236
plugins.console.insert_scripts_styles(self.scripts, self.styles, \
179
239
# Prepare the HTTP and HTML headers before the first write is made
180
240
if self.content_type != None:
181
241
self.apache_req.content_type = self.content_type
182
if self.content_length:
183
self.apache_req.set_content_length(self.content_length)
184
242
self.apache_req.status = self.status
185
243
if self.location != None:
186
244
self.apache_req.headers_out['Location'] = self.location
245
if self.write_html_head_foot:
246
# Write the HTML header, pass "self" (request object)
247
self.func_write_html_head(self)
188
249
def ensure_headers_written(self):
189
250
"""Writes out the HTTP and HTML headers if they haven't already been
209
270
def logout(self):
210
271
"""Log out the current user by destroying the session state.
211
272
Then redirect to the top-level IVLE page."""
273
# List of cookies that IVLE uses (to be removed at logout)
274
ivle_cookies = ["ivleforumcookie", "clipboard"]
212
276
if hasattr(self, 'session'):
213
277
self.session.invalidate()
214
278
self.session.delete()
215
279
# Invalidates all IVLE cookies
216
all_cookies = mod_python.Cookie.get_cookies(self)
218
# Create cookies for plugins that might request them.
219
for plugin in self.config.plugin_index[CookiePlugin]:
220
for cookie in plugin.cookies:
221
self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
222
expires=1, path='/'))
223
self.throw_redirect(self.make_path(''))
280
all_cookies = Cookie.get_cookies(self)
281
for cookie in all_cookies:
282
if cookie in ivle_cookies:
283
self.add_cookie(Cookie.Cookie(cookie,'',expires=1,path='/'))
284
self.throw_redirect(ivle.util.make_path(''))
242
303
return self.apache_req.read(len)
305
def throw_error(self, httpcode, message=None):
306
"""Writes out an HTTP error of the specified code. Raises an exception
307
which is caught by the dispatch or web server, so any code following
308
this call will not be executed.
310
httpcode: An HTTP response status code. Pass a constant from the
313
raise ivle.util.IVLEError(httpcode, message)
244
315
def throw_redirect(self, location):
245
316
"""Writes out an HTTP redirect to the specified URL. Raises an
246
317
exception which is caught by the dispatch or web server, so any
256
327
def add_cookie(self, cookie, value=None, **attributes):
257
328
"""Inserts a cookie into this request object's headers."""
258
329
if value is None:
259
mod_python.Cookie.add_cookie(self.apache_req, cookie)
330
Cookie.add_cookie(self.apache_req, cookie)
261
mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
263
def make_path(self, path):
264
"""Prepend the IVLE URL prefix to the given path.
266
This is used when generating URLs to send to the client.
268
This method is DEPRECATED. We no longer support use of a prefix.
270
return os.path.join(self.config['urls']['root'], path)
332
Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
272
334
def get_session(self):
273
335
"""Returns a mod_python Session object for this request.
274
336
Note that this is dependent on mod_python and may need to change
275
interface if porting away from mod_python.
277
IMPORTANT: Call unlock() on the session as soon as you are done with
278
it! If you don't, all other requests will block!
337
interface if porting away from mod_python."""
280
338
# Cache the session object and set the timeout to 24 hours.
281
339
if not hasattr(self, 'session'):
282
self.session = PotentiallySecureFileSession(
283
self.apache_req, timeout = 60 * 60 * 24)
340
self.session = Session.FileSession(self.apache_req,
341
timeout = 60 * 60 * 24)
284
342
return self.session
286
344
def get_fieldstorage(self):
289
347
interface if porting away from mod_python."""
290
348
# Cache the fieldstorage object
291
349
if not hasattr(self, 'fields'):
292
self.fields = mod_python.util.FieldStorage(self.apache_req)
350
self.fields = util.FieldStorage(self.apache_req)
293
351
return self.fields
295
353
def get_cgi_environ(self):
301
359
self.got_common_vars = True
302
360
return self.apache_req.subprocess_env
306
# Open a database connection and transaction, keep it around for users
307
# of the Request object to use.
308
if self._store is None:
309
self._store = ivle.database.get_store(self.config)
314
# Get and cache the request user, or None if it's not valid.
315
# This is a property so that we don't create a store unless
316
# some code actually requests the user.
363
def get_http_codename(code):
364
"""Given a HTTP error code int, returns a (name, description)
365
pair, suitable for displaying to the user.
366
May return (None,None) if code is unknown.
367
Only lists common 4xx and 5xx codes (since this is just used
368
to display throw_error error messages).
319
except AttributeError:
323
temp_user = ivle.webapp.security.get_user_details(self)
324
if temp_user and temp_user.valid:
325
self._user = temp_user
371
return http_codenames[code]
375
# Human strings for HTTP response codes
377
Request.HTTP_BAD_REQUEST:
379
"Your browser sent a request IVLE did not understand."),
380
Request.HTTP_UNAUTHORIZED:
382
"You are not allowed to view this part of IVLE."),
383
Request.HTTP_FORBIDDEN:
385
"You are not allowed to view this part of IVLE."),
386
Request.HTTP_NOT_FOUND:
388
"The application or file you requested does not exist."),
389
Request.HTTP_METHOD_NOT_ALLOWED:
390
("Method Not Allowed",
391
"Your browser is interacting with IVLE in the wrong way."
392
"This is probably a bug in IVLE. "
393
"Please report it to the administrators."),
394
Request.HTTP_INTERNAL_SERVER_ERROR:
395
("Internal Server Error",
396
"An unknown error occured in IVLE."),
397
Request.HTTP_NOT_IMPLEMENTED:
399
"The application or file you requested has not been implemented "
401
Request.HTTP_SERVICE_UNAVAILABLE:
402
("Service Unavailable",
403
"IVLE is currently experiencing technical difficulties. "
404
"Please try again later."),
added
removed
ivle/dispatch/request.py
