80
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.
84
116
# Special code for an OK response.
89
121
# HTTP status codes
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
92
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
93
144
HTTP_FORBIDDEN = 403
94
145
HTTP_NOT_FOUND = 404
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
95
162
HTTP_INTERNAL_SERVER_ERROR = 500
97
def __init__(self, req, config):
98
"""Create an IVLE request from a mod_python one.
100
@param req: A mod_python request.
101
@param config: An IVLE configuration.
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.
104
182
# Methods are mostly wrappers around the Apache request object
105
183
self.apache_req = req
184
self.func_write_html_head = write_html_head
107
185
self.headers_written = False
109
187
# Determine if the browser used the public host name to make the
110
188
# request (in which case we are in "public mode")
111
if req.hostname == config['urls']['public_host']:
189
if req.hostname == ivle.conf.public_host:
112
190
self.publicmode = True
114
192
self.publicmode = False
118
196
self.uri = req.uri
119
197
# Split the given path into the app (top-level dir) and sub-path
120
198
# (after first stripping away the root directory)
121
(self.app, self.path) = (ivle.util.split_path(req.uri))
199
path = ivle.util.unmake_path(req.uri)
200
(self.app, self.path) = (ivle.util.split_path(path))
123
202
self.hostname = req.hostname
124
203
self.headers_in = req.headers_in
127
206
# Open a database connection and transaction, keep it around for users
128
207
# of the Request object to use
129
self.store = ivle.database.get_store(config)
208
self.store = ivle.database.get_store()
131
210
# Default values for the output members
132
211
self.status = Request.HTTP_OK
133
212
self.content_type = None # Use Apache's default
134
213
self.location = None
214
self.title = None # Will be set by dispatch before passing to app
217
self.scripts_init = []
218
self.write_html_head_foot = False
135
219
# In some cases we don't want the template JS (such as the username
136
220
# and public FQDN) in the output HTML. In that case, set this to 0.
137
221
self.write_javascript_settings = True
145
229
"""Writes out the HTTP and HTML headers before any real data is
147
231
self.headers_written = True
233
# app is the App object for the chosen app
235
app = ivle.conf.apps.app_url[self.app]
149
239
# Prepare the HTTP and HTML headers before the first write is made
150
240
if self.content_type != None:
152
242
self.apache_req.status = self.status
153
243
if self.location != None:
154
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)
156
249
def ensure_headers_written(self):
157
250
"""Writes out the HTTP and HTML headers if they haven't already been
184
277
all_cookies = mod_python.Cookie.get_cookies(self)
186
279
# Create cookies for plugins that might request them.
187
for plugin in self.config.plugin_index[CookiePlugin]:
280
for plugin in self.plugin_index[CookiePlugin]:
188
281
for cookie in plugin.cookies:
189
282
self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
190
283
expires=1, path='/'))
191
self.throw_redirect(self.make_path(''))
284
self.throw_redirect(ivle.util.make_path(''))
210
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)
212
315
def throw_redirect(self, location):
213
316
"""Writes out an HTTP redirect to the specified URL. Raises an
214
317
exception which is caught by the dispatch or web server, so any
229
332
mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
231
def make_path(self, path):
232
"""Prepend the IVLE URL prefix to the given path.
234
This is used when generating URLs to send to the client.
236
This method is DEPRECATED. We no longer support use of a prefix.
238
return os.path.join(self.config['urls']['root'], path)
240
334
def get_session(self):
241
335
"""Returns a mod_python Session object for this request.
242
336
Note that this is dependent on mod_python and may need to change
243
interface if porting away from mod_python.
245
IMPORTANT: Call unlock() on the session as soon as you are done with
246
it! If you don't, all other requests will block!
337
interface if porting away from mod_python."""
248
338
# Cache the session object and set the timeout to 24 hours.
249
339
if not hasattr(self, 'session'):
250
340
self.session = mod_python.Session.FileSession(self.apache_req,
269
359
self.got_common_vars = True
270
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
