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