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
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
# Special code for an OK response.
102
# Do not use HTTP_OK; for some reason Apache produces an "OK" error
103
# message if you do that.
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
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
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
147
HTTP_INTERNAL_SERVER_ERROR = 500
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.
165
# Methods are mostly wrappers around the Apache request object
166
self.apache_req = req
167
self.headers_written = False
169
# Determine if the browser used the public host name to make the
170
# request (in which case we are in "public mode")
171
if req.hostname == ivle.conf.public_host:
172
self.publicmode = True
174
self.publicmode = False
176
# Inherit values for the input members
177
self.method = req.method
179
# Split the given path into the app (top-level dir) and sub-path
180
# (after first stripping away the root directory)
181
path = ivle.util.unmake_path(req.uri)
182
(self.app, self.path) = (ivle.util.split_path(path))
184
self.hostname = req.hostname
185
self.headers_in = req.headers_in
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()
192
# Default values for the output members
193
self.status = Request.HTTP_OK
194
self.content_type = None # Use Apache's default
198
self.scripts_init = []
199
# In some cases we don't want the template JS (such as the username
200
# and public FQDN) in the output HTML. In that case, set this to 0.
201
self.write_javascript_settings = True
202
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
# Prepare the HTTP and HTML headers before the first write is made
214
if self.content_type != None:
215
self.apache_req.content_type = self.content_type
216
self.apache_req.status = self.status
217
if self.location != None:
218
self.apache_req.headers_out['Location'] = self.location
220
def ensure_headers_written(self):
221
"""Writes out the HTTP and HTML headers if they haven't already been
223
if not self.headers_written:
224
self.__writeheaders()
226
def write(self, string, flush=1):
227
"""Writes string directly to the client, then flushes the buffer,
228
unless flush is 0."""
230
if not self.headers_written:
231
self.__writeheaders()
232
if isinstance(string, unicode):
233
# Encode unicode strings as UTF-8
234
# (Otherwise cannot handle being written to a bytestream)
235
self.apache_req.write(string.encode('utf8'), flush)
237
# 8-bit clean strings just get written directly.
238
# This includes binary strings.
239
self.apache_req.write(string, flush)
242
"""Log out the current user by destroying the session state.
243
Then redirect to the top-level IVLE page."""
244
if hasattr(self, 'session'):
245
self.session.invalidate()
246
self.session.delete()
247
# Invalidates all IVLE cookies
248
all_cookies = mod_python.Cookie.get_cookies(self)
250
# Create cookies for plugins that might request them.
251
for plugin in self.config.plugin_index[CookiePlugin]:
252
for cookie in plugin.cookies:
253
self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
254
expires=1, path='/'))
255
self.throw_redirect(ivle.util.make_path(''))
259
"""Flushes the output buffer."""
260
self.apache_req.flush()
262
def sendfile(self, filename):
263
"""Sends the named file directly to the client."""
264
if not self.headers_written:
265
self.__writeheaders()
266
self.apache_req.sendfile(filename)
268
def read(self, len=None):
269
"""Reads at most len bytes directly from the client. (See mod_python
272
return self.apache_req.read()
274
return self.apache_req.read(len)
276
def throw_redirect(self, location):
277
"""Writes out an HTTP redirect to the specified URL. Raises an
278
exception which is caught by the dispatch or web server, so any
279
code following this call will not be executed.
281
httpcode: An HTTP response status code. Pass a constant from the
284
# Note: location may be a unicode, but it MUST only have ASCII
285
# characters (non-ascii characters should be URL-encoded).
286
mod_python.util.redirect(self.apache_req, location.encode("ascii"))
288
def add_cookie(self, cookie, value=None, **attributes):
289
"""Inserts a cookie into this request object's headers."""
291
mod_python.Cookie.add_cookie(self.apache_req, cookie)
293
mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
295
def get_session(self):
296
"""Returns a mod_python Session object for this request.
297
Note that this is dependent on mod_python and may need to change
298
interface if porting away from mod_python."""
299
# Cache the session object and set the timeout to 24 hours.
300
if not hasattr(self, 'session'):
301
self.session = mod_python.Session.FileSession(self.apache_req,
302
timeout = 60 * 60 * 24)
305
def get_fieldstorage(self):
306
"""Returns a mod_python FieldStorage object for this request.
307
Note that this is dependent on mod_python and may need to change
308
interface if porting away from mod_python."""
309
# Cache the fieldstorage object
310
if not hasattr(self, 'fields'):
311
self.fields = mod_python.util.FieldStorage(self.apache_req)
314
def get_cgi_environ(self):
315
"""Returns the CGI environment emulation for this request. (Calls
316
add_common_vars). The environment is returned as a mapping
317
compatible with os.environ."""
318
if not self.got_common_vars:
319
self.apache_req.add_common_vars()
320
self.got_common_vars = True
321
return self.apache_req.subprocess_env
324
def get_http_codename(code):
325
"""Given a HTTP error code int, returns a (name, description)
326
pair, suitable for displaying to the user.
327
May return (None,None) if code is unknown.
328
Only lists common 4xx and 5xx codes (since this is just used
329
to display throw_error error messages).
332
return http_codenames[code]
336
# Human strings for HTTP response codes
338
Request.HTTP_BAD_REQUEST:
340
"Your browser sent a request IVLE did not understand."),
341
Request.HTTP_UNAUTHORIZED:
343
"You are not allowed to view this part of IVLE."),
344
Request.HTTP_FORBIDDEN:
346
"You are not allowed to view this part of IVLE."),
347
Request.HTTP_NOT_FOUND:
349
"The application or file you requested does not exist."),
350
Request.HTTP_METHOD_NOT_ALLOWED:
351
("Method Not Allowed",
352
"Your browser is interacting with IVLE in the wrong way."
353
"This is probably a bug in IVLE. "
354
"Please report it to the administrators."),
355
Request.HTTP_INTERNAL_SERVER_ERROR:
356
("Internal Server Error",
357
"An unknown error occured in IVLE."),
358
Request.HTTP_NOT_IMPLEMENTED:
360
"The application or file you requested has not been implemented "
362
Request.HTTP_SERVICE_UNAVAILABLE:
363
("Service Unavailable",
364
"IVLE is currently experiencing technical difficulties. "
365
"Please try again later."),
added
removed
ivle/dispatch/request.py
