1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23
Builds an IVLE request object from a mod_python request object.
24
See design notes/apps/dispatch.txt for a full specification of this request
29
import mod_python.Session
30
import mod_python.Cookie
31
import mod_python.util
33
# This needs to be importable from outside Apache.
39
from ivle.webapp.base.plugins import CookiePlugin
42
"""An IVLE request object. This is presented to the IVLE apps as a way of
43
interacting with the web server and the dispatcher.
45
Request object attributes:
47
String. The request method (eg. 'GET', 'POST', etc)
49
String. The path portion of the URI.
51
String. Name of the application specified in the URL, or None.
53
String. The path specified in the URL *not including* the
54
application or the IVLE location prefix. eg. a URL of
55
"/ivle/files/joe/myfiles" has a path of "joe/myfiles".
57
User object. Details of the user who is currently logged in, or
60
storm.store.Store instance. Holds a database transaction open,
61
which is available for the entire lifetime of the request.
63
String. Hostname the server is running on.
65
Table object representing headers sent by the client.
66
headers_out (read, can be written to)
67
Table object representing headers to be sent to the client.
69
Bool. True if the request came for the "public host" as
70
configured in conf.py. Note that public mode requests do not
71
have an app (app is set to None).
74
Int. Response status number. Use one of the status codes defined
77
String. The Content-Type (mime type) header value.
79
String. Response "Location" header value. Used with HTTP redirect
82
String. HTML page title. Used if write_html_head_foot is True, in
83
the HTML title element text.
85
List of strings. Write a list of URLs to CSS files here, and they
86
will be incorporated as <link rel="stylesheet" type="text/css">
87
elements in the head, if write_html_head_foot is True.
88
URLs should be relative to the IVLE root; they will be fixed up
91
List of strings. Write a list of URLs to JS files here, and they
92
will be incorporated as <script type="text/javascript"> elements
93
in the head, if write_html_head_foot is True.
94
URLs should be relative to the IVLE root; they will be fixed up
97
List of strings. Write a list of JS function names, and they
98
will be added as window.addListener('load', ..., false); calls
99
in the head, if write_html_head_foot is True.
100
This is the propper way to specify functions that need to run at
102
write_html_head_foot (write)
103
Boolean. If True, dispatch assumes that this is an XHTML page, and
104
will immediately write a full HTML head, open the body element,
105
and write heading contents to the page, before any bytes are
106
written. It will then write footer contents and close the body and
107
html elements at the end of execution.
109
This value should be set to true by all applications for all HTML
110
output (unless there is a good reason, eg. exec). The
111
applications should therefore output HTML content assuming that
112
it will be written inside the body tag. Do not write opening or
113
closing <html> or <body> tags.
116
# Special code for an OK response.
117
# Do not use HTTP_OK; for some reason Apache produces an "OK" error
118
# message if you do that.
124
HTTP_SWITCHING_PROTOCOLS = 101
125
HTTP_PROCESSING = 102
129
HTTP_NON_AUTHORITATIVE = 203
130
HTTP_NO_CONTENT = 204
131
HTTP_RESET_CONTENT = 205
132
HTTP_PARTIAL_CONTENT = 206
133
HTTP_MULTI_STATUS = 207
134
HTTP_MULTIPLE_CHOICES = 300
135
HTTP_MOVED_PERMANENTLY = 301
136
HTTP_MOVED_TEMPORARILY = 302
138
HTTP_NOT_MODIFIED = 304
140
HTTP_TEMPORARY_REDIRECT = 307
141
HTTP_BAD_REQUEST = 400
142
HTTP_UNAUTHORIZED = 401
143
HTTP_PAYMENT_REQUIRED = 402
146
HTTP_METHOD_NOT_ALLOWED = 405
147
HTTP_NOT_ACCEPTABLE = 406
148
HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
149
HTTP_REQUEST_TIME_OUT = 408
152
HTTP_LENGTH_REQUIRED = 411
153
HTTP_PRECONDITION_FAILED = 412
154
HTTP_REQUEST_ENTITY_TOO_LARGE = 413
155
HTTP_REQUEST_URI_TOO_LARGE = 414
156
HTTP_UNSUPPORTED_MEDIA_TYPE = 415
157
HTTP_RANGE_NOT_SATISFIABLE = 416
158
HTTP_EXPECTATION_FAILED = 417
159
HTTP_UNPROCESSABLE_ENTITY = 422
161
HTTP_FAILED_DEPENDENCY = 424
162
HTTP_INTERNAL_SERVER_ERROR = 500
163
HTTP_NOT_IMPLEMENTED = 501
164
HTTP_BAD_GATEWAY = 502
165
HTTP_SERVICE_UNAVAILABLE = 503
166
HTTP_GATEWAY_TIME_OUT = 504
167
HTTP_VERSION_NOT_SUPPORTED = 505
168
HTTP_VARIANT_ALSO_VARIES = 506
169
HTTP_INSUFFICIENT_STORAGE = 507
170
HTTP_NOT_EXTENDED = 510
172
def __init__(self, req, write_html_head):
173
"""Builds an IVLE request object from a mod_python request object.
174
This results in an object with all of the necessary methods and
177
req: A mod_python request object.
178
write_html_head: Function which is called when writing the automatic
179
HTML header. Accepts a single argument, the IVLE request object.
182
# Methods are mostly wrappers around the Apache request object
183
self.apache_req = req
184
self.func_write_html_head = write_html_head
185
self.headers_written = False
187
# Determine if the browser used the public host name to make the
188
# request (in which case we are in "public mode")
189
if req.hostname == ivle.conf.public_host:
190
self.publicmode = True
192
self.publicmode = False
194
# Inherit values for the input members
195
self.method = req.method
197
# Split the given path into the app (top-level dir) and sub-path
198
# (after first stripping away the root directory)
199
path = ivle.util.unmake_path(req.uri)
200
(self.app, self.path) = (ivle.util.split_path(path))
202
self.hostname = req.hostname
203
self.headers_in = req.headers_in
204
self.headers_out = req.headers_out
206
# Open a database connection and transaction, keep it around for users
207
# of the Request object to use
208
self.store = ivle.database.get_store()
210
# Default values for the output members
211
self.status = Request.HTTP_OK
212
self.content_type = None # Use Apache's default
214
self.title = None # Will be set by dispatch before passing to app
217
self.scripts_init = []
218
self.write_html_head_foot = False
219
# In some cases we don't want the template JS (such as the username
220
# and public FQDN) in the output HTML. In that case, set this to 0.
221
self.write_javascript_settings = True
222
self.got_common_vars = False
228
def __writeheaders(self):
229
"""Writes out the HTTP and HTML headers before any real data is
231
self.headers_written = True
233
# app is the App object for the chosen app
235
app = ivle.conf.apps.app_url[self.app]
239
# Prepare the HTTP and HTML headers before the first write is made
240
if self.content_type != None:
241
self.apache_req.content_type = self.content_type
242
self.apache_req.status = self.status
243
if self.location != None:
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)
249
def ensure_headers_written(self):
250
"""Writes out the HTTP and HTML headers if they haven't already been
252
if not self.headers_written:
253
self.__writeheaders()
255
def write(self, string, flush=1):
256
"""Writes string directly to the client, then flushes the buffer,
257
unless flush is 0."""
259
if not self.headers_written:
260
self.__writeheaders()
261
if isinstance(string, unicode):
262
# Encode unicode strings as UTF-8
263
# (Otherwise cannot handle being written to a bytestream)
264
self.apache_req.write(string.encode('utf8'), flush)
266
# 8-bit clean strings just get written directly.
267
# This includes binary strings.
268
self.apache_req.write(string, flush)
271
"""Log out the current user by destroying the session state.
272
Then redirect to the top-level IVLE page."""
273
if hasattr(self, 'session'):
274
self.session.invalidate()
275
self.session.delete()
276
# Invalidates all IVLE cookies
277
all_cookies = mod_python.Cookie.get_cookies(self)
279
# Create cookies for plugins that might request them.
280
for plugin in self.plugin_index[CookiePlugin]:
281
for cookie in plugin.cookies:
282
self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
283
expires=1, path='/'))
284
self.throw_redirect(ivle.util.make_path(''))
288
"""Flushes the output buffer."""
289
self.apache_req.flush()
291
def sendfile(self, filename):
292
"""Sends the named file directly to the client."""
293
if not self.headers_written:
294
self.__writeheaders()
295
self.apache_req.sendfile(filename)
297
def read(self, len=None):
298
"""Reads at most len bytes directly from the client. (See mod_python
301
return self.apache_req.read()
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)
315
def throw_redirect(self, location):
316
"""Writes out an HTTP redirect to the specified URL. Raises an
317
exception which is caught by the dispatch or web server, so any
318
code following this call will not be executed.
320
httpcode: An HTTP response status code. Pass a constant from the
323
# Note: location may be a unicode, but it MUST only have ASCII
324
# characters (non-ascii characters should be URL-encoded).
325
mod_python.util.redirect(self.apache_req, location.encode("ascii"))
327
def add_cookie(self, cookie, value=None, **attributes):
328
"""Inserts a cookie into this request object's headers."""
330
mod_python.Cookie.add_cookie(self.apache_req, cookie)
332
mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
334
def get_session(self):
335
"""Returns a mod_python Session object for this request.
336
Note that this is dependent on mod_python and may need to change
337
interface if porting away from mod_python."""
338
# Cache the session object and set the timeout to 24 hours.
339
if not hasattr(self, 'session'):
340
self.session = mod_python.Session.FileSession(self.apache_req,
341
timeout = 60 * 60 * 24)
344
def get_fieldstorage(self):
345
"""Returns a mod_python FieldStorage object for this request.
346
Note that this is dependent on mod_python and may need to change
347
interface if porting away from mod_python."""
348
# Cache the fieldstorage object
349
if not hasattr(self, 'fields'):
350
self.fields = mod_python.util.FieldStorage(self.apache_req)
353
def get_cgi_environ(self):
354
"""Returns the CGI environment emulation for this request. (Calls
355
add_common_vars). The environment is returned as a mapping
356
compatible with os.environ."""
357
if not self.got_common_vars:
358
self.apache_req.add_common_vars()
359
self.got_common_vars = True
360
return self.apache_req.subprocess_env
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).
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
