1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2008 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
18
# Module: dispatch.request
22
# Builds an IVLE request object from a mod_python request object.
23
# See design notes/apps/dispatch.txt for a full specification of this request
27
from mod_python import (util, Session, Cookie)
31
import plugins.console # XXX: Relies on www/ being in the Python path.
34
"""An IVLE request object. This is presented to the IVLE apps as a way of
35
interacting with the web server and the dispatcher.
37
Request object attributes:
39
String. The request method (eg. 'GET', 'POST', etc)
41
String. The path portion of the URI.
43
String. Name of the application specified in the URL, or None.
45
String. The path specified in the URL *not including* the
46
application or the IVLE location prefix. eg. a URL of
47
"/ivle/files/joe/myfiles" has a path of "joe/myfiles".
49
User object. Details of the user who is currently logged in, or
52
String. Hostname the server is running on.
54
Table object representing headers sent by the client.
55
headers_out (read, can be written to)
56
Table object representing headers to be sent to the client.
58
Bool. True if the request came for the "public host" as
59
configured in conf.py. Note that public mode requests do not
60
have an app (app is set to None).
63
Int. Response status number. Use one of the status codes defined
66
String. The Content-Type (mime type) header value.
68
String. Response "Location" header value. Used with HTTP redirect
71
String. HTML page title. Used if write_html_head_foot is True, in
72
the HTML title element text.
74
List of strings. Write a list of URLs to CSS files here, and they
75
will be incorporated as <link rel="stylesheet" type="text/css">
76
elements in the head, if write_html_head_foot is True.
77
URLs should be relative to the IVLE root; they will be fixed up
80
List of strings. Write a list of URLs to JS files here, and they
81
will be incorporated as <script type="text/javascript"> elements
82
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 JS function names, and they
87
will be added as window.addListener('load', ..., false); calls
88
in the head, if write_html_head_foot is True.
89
This is the propper way to specify functions that need to run at
91
write_html_head_foot (write)
92
Boolean. If True, dispatch assumes that this is an XHTML page, and
93
will immediately write a full HTML head, open the body element,
94
and write heading contents to the page, before any bytes are
95
written. It will then write footer contents and close the body and
96
html elements at the end of execution.
98
This value should be set to true by all applications for all HTML
99
output (unless there is a good reason, eg. exec). The
100
applications should therefore output HTML content assuming that
101
it will be written inside the body tag. Do not write opening or
102
closing <html> or <body> tags.
105
# Special code for an OK response.
106
# Do not use HTTP_OK; for some reason Apache produces an "OK" error
107
# message if you do that.
113
HTTP_SWITCHING_PROTOCOLS = 101
114
HTTP_PROCESSING = 102
118
HTTP_NON_AUTHORITATIVE = 203
119
HTTP_NO_CONTENT = 204
120
HTTP_RESET_CONTENT = 205
121
HTTP_PARTIAL_CONTENT = 206
122
HTTP_MULTI_STATUS = 207
123
HTTP_MULTIPLE_CHOICES = 300
124
HTTP_MOVED_PERMANENTLY = 301
125
HTTP_MOVED_TEMPORARILY = 302
127
HTTP_NOT_MODIFIED = 304
129
HTTP_TEMPORARY_REDIRECT = 307
130
HTTP_BAD_REQUEST = 400
131
HTTP_UNAUTHORIZED = 401
132
HTTP_PAYMENT_REQUIRED = 402
135
HTTP_METHOD_NOT_ALLOWED = 405
136
HTTP_NOT_ACCEPTABLE = 406
137
HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
138
HTTP_REQUEST_TIME_OUT = 408
141
HTTP_LENGTH_REQUIRED = 411
142
HTTP_PRECONDITION_FAILED = 412
143
HTTP_REQUEST_ENTITY_TOO_LARGE = 413
144
HTTP_REQUEST_URI_TOO_LARGE = 414
145
HTTP_UNSUPPORTED_MEDIA_TYPE = 415
146
HTTP_RANGE_NOT_SATISFIABLE = 416
147
HTTP_EXPECTATION_FAILED = 417
148
HTTP_UNPROCESSABLE_ENTITY = 422
150
HTTP_FAILED_DEPENDENCY = 424
151
HTTP_INTERNAL_SERVER_ERROR = 500
152
HTTP_NOT_IMPLEMENTED = 501
153
HTTP_BAD_GATEWAY = 502
154
HTTP_SERVICE_UNAVAILABLE = 503
155
HTTP_GATEWAY_TIME_OUT = 504
156
HTTP_VERSION_NOT_SUPPORTED = 505
157
HTTP_VARIANT_ALSO_VARIES = 506
158
HTTP_INSUFFICIENT_STORAGE = 507
159
HTTP_NOT_EXTENDED = 510
161
def __init__(self, req, write_html_head):
162
"""Builds an IVLE request object from a mod_python request object.
163
This results in an object with all of the necessary methods and
166
req: A mod_python request object.
167
write_html_head: Function which is called when writing the automatic
168
HTML header. Accepts a single argument, the IVLE request object.
171
# Methods are mostly wrappers around the Apache request object
172
self.apache_req = req
173
self.func_write_html_head = write_html_head
174
self.headers_written = False
176
# Determine if the browser used the public host name to make the
177
# request (in which case we are in "public mode")
178
if req.hostname == ivle.conf.public_host:
179
self.publicmode = True
181
self.publicmode = False
183
# Inherit values for the input members
184
self.method = req.method
186
# Split the given path into the app (top-level dir) and sub-path
187
# (after first stripping away the root directory)
188
path = ivle.util.unmake_path(req.uri)
189
(self.app, self.path) = (ivle.util.split_path(path))
191
self.hostname = req.hostname
192
self.headers_in = req.headers_in
193
self.headers_out = req.headers_out
195
# Default values for the output members
196
self.status = Request.HTTP_OK
197
self.content_type = None # Use Apache's default
199
self.title = None # Will be set by dispatch before passing to app
202
self.scripts_init = []
203
self.write_html_head_foot = False
204
# In some cases we don't want the template JS (such as the username
205
# and public FQDN) in the output HTML. In that case, set this to 0.
206
self.write_javascript_settings = True
207
self.got_common_vars = False
209
def __writeheaders(self):
210
"""Writes out the HTTP and HTML headers before any real data is
212
self.headers_written = True
214
# app is the App object for the chosen app
216
app = ivle.conf.apps.app_url[self.app]
220
# Write any final modifications to header content
221
if app and app.useconsole and self.user:
222
plugins.console.insert_scripts_styles(self.scripts, self.styles, \
225
# Prepare the HTTP and HTML headers before the first write is made
226
if self.content_type != None:
227
self.apache_req.content_type = self.content_type
228
self.apache_req.status = self.status
229
if self.location != None:
230
self.apache_req.headers_out['Location'] = self.location
231
if self.write_html_head_foot:
232
# Write the HTML header, pass "self" (request object)
233
self.func_write_html_head(self)
235
def ensure_headers_written(self):
236
"""Writes out the HTTP and HTML headers if they haven't already been
238
if not self.headers_written:
239
self.__writeheaders()
241
def write(self, string, flush=1):
242
"""Writes string directly to the client, then flushes the buffer,
243
unless flush is 0."""
245
if not self.headers_written:
246
self.__writeheaders()
247
if isinstance(string, unicode):
248
# Encode unicode strings as UTF-8
249
# (Otherwise cannot handle being written to a bytestream)
250
self.apache_req.write(string.encode('utf8'), flush)
252
# 8-bit clean strings just get written directly.
253
# This includes binary strings.
254
self.apache_req.write(string, flush)
257
"""Log out the current user by destroying the session state.
258
Then redirect to the top-level IVLE page."""
259
# List of cookies that IVLE uses (to be removed at logout)
260
ivle_cookies = ["ivleforumcookie", "clipboard"]
262
if hasattr(self, 'session'):
263
self.session.invalidate()
264
self.session.delete()
265
# Invalidates all IVLE cookies
266
all_cookies = Cookie.get_cookies(self)
267
for cookie in all_cookies:
268
if cookie in ivle_cookies:
269
self.add_cookie(Cookie.Cookie(cookie,'',expires=1,path='/'))
270
self.throw_redirect(ivle.util.make_path(''))
274
"""Flushes the output buffer."""
275
self.apache_req.flush()
277
def sendfile(self, filename):
278
"""Sends the named file directly to the client."""
279
if not self.headers_written:
280
self.__writeheaders()
281
self.apache_req.sendfile(filename)
283
def read(self, len=None):
284
"""Reads at most len bytes directly from the client. (See mod_python
287
return self.apache_req.read()
289
return self.apache_req.read(len)
291
def throw_error(self, httpcode, message=None):
292
"""Writes out an HTTP error of the specified code. Raises an exception
293
which is caught by the dispatch or web server, so any code following
294
this call will not be executed.
296
httpcode: An HTTP response status code. Pass a constant from the
299
raise ivle.util.IVLEError(httpcode, message)
301
def throw_redirect(self, location):
302
"""Writes out an HTTP redirect to the specified URL. Raises an
303
exception which is caught by the dispatch or web server, so any
304
code following this call will not be executed.
306
httpcode: An HTTP response status code. Pass a constant from the
309
mod_python.util.redirect(self.apache_req, location)
311
def add_cookie(self, cookie, value=None, **attributes):
312
"""Inserts a cookie into this request object's headers."""
314
Cookie.add_cookie(self.apache_req, cookie)
316
Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
318
def get_session(self):
319
"""Returns a mod_python Session object for this request.
320
Note that this is dependent on mod_python and may need to change
321
interface if porting away from mod_python."""
322
# Cache the session object and set the timeout to 24 hours.
323
if not hasattr(self, 'session'):
324
self.session = Session.FileSession(self.apache_req,
325
timeout = 60 * 60 * 24)
328
def get_fieldstorage(self):
329
"""Returns a mod_python FieldStorage object for this request.
330
Note that this is dependent on mod_python and may need to change
331
interface if porting away from mod_python."""
332
# Cache the fieldstorage object
333
if not hasattr(self, 'fields'):
334
self.fields = util.FieldStorage(self.apache_req)
337
def get_cgi_environ(self):
338
"""Returns the CGI environment emulation for this request. (Calls
339
add_common_vars). The environment is returned as a mapping
340
compatible with os.environ."""
341
if not self.got_common_vars:
342
self.apache_req.add_common_vars()
343
self.got_common_vars = True
344
return self.apache_req.subprocess_env
347
def get_http_codename(code):
348
"""Given a HTTP error code int, returns a (name, description)
349
pair, suitable for displaying to the user.
350
May return (None,None) if code is unknown.
351
Only lists common 4xx and 5xx codes (since this is just used
352
to display throw_error error messages).
355
return http_codenames[code]
359
# Human strings for HTTP response codes
361
Request.HTTP_BAD_REQUEST:
363
"Your browser sent a request IVLE did not understand."),
364
Request.HTTP_UNAUTHORIZED:
366
"You are not allowed to view this part of IVLE."),
367
Request.HTTP_FORBIDDEN:
369
"You are not allowed to view this part of IVLE."),
370
Request.HTTP_NOT_FOUND:
372
"The application or file you requested does not exist."),
373
Request.HTTP_METHOD_NOT_ALLOWED:
374
("Method Not Allowed",
375
"Your browser is interacting with IVLE in the wrong way."
376
"This is probably a bug in IVLE. "
377
"Please report it to the administrators."),
378
Request.HTTP_INTERNAL_SERVER_ERROR:
379
("Internal Server Error",
380
"An unknown error occured in IVLE."),
381
Request.HTTP_NOT_IMPLEMENTED:
383
"The application or file you requested has not been implemented "
385
Request.HTTP_SERVICE_UNAVAILABLE:
386
("Service Unavailable",
387
"IVLE is currently experiencing technical difficulties. "
388
"Please try again later."),
added
removed
ivle/dispatch/request.py
