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
18
# Author: Matt Giuca, Will Grant
21
This is a mod_python handler program. The correct way to call it is to have
22
Apache send all requests to be handled by the module 'dispatch'.
24
Top-level handler. Handles all requests to all pages in IVLE.
25
Handles authentication (not authorization).
26
Then passes the request along to the appropriate ivle app.
46
from ivle.dispatch.request import Request
47
from ivle.dispatch import login
48
from ivle.webapp.base.plugins import ViewPlugin
49
from ivle.webapp.errors import HTTPError, Unauthorized
53
# XXX List of plugins, which will eventually be read in from conf
55
'ivle.webapp.core#Plugin',
56
'ivle.webapp.admin.user#Plugin',
57
'ivle.webapp.tutorial#Plugin',
58
'ivle.webapp.admin.subject#Plugin',
59
'ivle.webapp.filesystem.browser#Plugin',
60
'ivle.webapp.filesystem.diff#Plugin',
61
'ivle.webapp.filesystem.svnlog#Plugin',
62
'ivle.webapp.groups#Plugin',
63
'ivle.webapp.console#Plugin',
64
'ivle.webapp.security#Plugin',
65
'ivle.webapp.media#Plugin',
66
'ivle.webapp.forum#Plugin',
67
'ivle.webapp.help#Plugin',
68
'ivle.webapp.tos#Plugin',
69
'ivle.webapp.userservice#Plugin',
72
def generate_route_mapper(view_plugins):
74
Build a Mapper object for doing URL matching using 'routes', based on the
75
given plugin registry.
77
m = routes.Mapper(explicit=True)
78
for plugin in view_plugins:
79
# Establish a URL pattern for each element of plugin.urls
80
assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin
81
for url in plugin.urls:
84
kwargs_dict = url[2] if len(url) >= 3 else {}
85
m.connect(routex, view=view_class, **kwargs_dict)
88
def get_plugin(pluginstr):
89
plugin_path, classname = pluginstr.split('#')
90
# Load the plugin module from somewhere in the Python path
91
# (Note that plugin_path is a fully-qualified Python module name).
93
getattr(__import__(plugin_path, fromlist=[classname]), classname))
96
"""Handles a request which may be to anywhere in the site except media.
97
Intended to be called by mod_python, as a handler.
99
req: An Apache request object.
101
# Make the request object into an IVLE request which can be passed to apps
104
req = Request(req, html.write_html_head)
106
# Pass the apachereq to error reporter, since ivle req isn't created
108
handle_unknown_exception(apachereq, *sys.exc_info())
109
# Tell Apache not to generate its own errors as well
110
return mod_python.apache.OK
112
# Run the main handler, and catch all exceptions
114
return handler_(req, apachereq)
115
except mod_python.apache.SERVER_RETURN:
116
# An apache error. We discourage these, but they might still happen.
120
handle_unknown_exception(req, *sys.exc_info())
121
# Tell Apache not to generate its own errors as well
122
return mod_python.apache.OK
124
def handler_(req, apachereq):
126
Nested handler function. May raise exceptions. The top-level handler is
127
just used to catch exceptions.
128
Takes both an IVLE request and an Apache req.
130
# Hack? Try and get the user login early just in case we throw an error
131
# (most likely 404) to stop us seeing not logged in even when we are.
132
if not req.publicmode:
133
user = login.get_user_details(req)
135
# Don't set the user if it is disabled or hasn't accepted the ToS.
136
if user and user.valid:
139
### BEGIN New plugins framework ###
140
# XXX This should be done ONCE per Python process, not per request.
142
req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
143
# Index the plugins by base class
144
req.plugin_index = {}
145
for plugin in req.plugins.values():
146
# Getmro returns a tuple of all the super-classes of the plugin
147
for base in inspect.getmro(plugin):
148
if base not in req.plugin_index:
149
req.plugin_index[base] = []
150
req.plugin_index[base].append(plugin)
151
req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
152
req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
154
matchdict = req.mapper.match(req.uri)
155
if matchdict is not None:
156
viewcls = matchdict['view']
157
# Get the remaining arguments, less 'view', 'action' and 'controller'
158
# (The latter two seem to be built-in, and we don't want them).
159
kwargs = matchdict.copy()
162
# Instantiate the view, which should be a BaseView class
163
view = viewcls(req, **kwargs)
165
# Check that the request (mainly the user) is permitted to access
167
if not view.authorize(req):
172
# A view explicitly raised an HTTP error. Respect it.
175
# Try to find a custom error view.
176
if hasattr(viewcls, 'get_error_view'):
177
errviewcls = viewcls.get_error_view(e)
182
errview = errviewcls(req, e)
189
# A non-HTTPError appeared. We have an unknown exception. Panic.
190
handle_unknown_exception(req, *sys.exc_info())
195
### END New plugins framework ###
197
# Check req.app to see if it is valid. 404 if not.
198
if req.app is not None and req.app not in ivle.conf.apps.app_url:
199
req.throw_error(Request.HTTP_NOT_FOUND,
200
"There is no application called %s." % repr(req.app))
202
# Special handling for public mode - only allow the public app, call it
204
# NOTE: This will not behave correctly if the public app uses
205
# write_html_head_foot, but "serve" does not.
207
if req.app != ivle.conf.apps.public_app:
208
req.throw_error(Request.HTTP_FORBIDDEN,
209
"This application is not available on the public site.")
210
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
211
apps.call_app(app.dir, req)
214
# app is the App object for the chosen app
216
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
218
app = ivle.conf.apps.app_url[req.app]
220
# Check if app requires auth. If so, perform authentication and login.
221
# This will either return a User object, None, or perform a redirect
222
# which we will not catch here.
224
logged_in = req.user is not None
228
assert logged_in # XXX
231
# Keep the user's session alive by writing to the session object.
232
# req.get_session().save()
233
# Well, it's a fine idea, but it creates considerable grief in the
234
# concurrent update department, so instead, we'll just make the
235
# sessions not time out.
236
req.get_session().unlock()
238
# If user did not specify an app, HTTP redirect to default app and
241
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
243
# Set the default title to the app's tab name, if any. Otherwise URL
245
if app.name is not None:
250
# Call the specified app with the request object
251
apps.call_app(app.dir, req)
253
# if not logged in, login.login will have written the login box.
254
# Just clean up and exit.
256
# MAKE SURE we write the HTTP (and possibly HTML) header. This
257
# wouldn't happen if nothing else ever got written, so we have to make
259
req.ensure_headers_written()
261
# When done, write out the HTML footer if the app has requested it
262
if req.write_html_head_foot:
263
html.write_html_foot(req)
265
# Note: Apache will not write custom HTML error messages here.
266
# Use req.throw_error to do that.
269
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
271
Given an exception that has just been thrown from IVLE, print its details
273
This is a full handler. It assumes nothing has been written, and writes a
275
req: May be EITHER an IVLE req or an Apache req.
276
IVLE reqs may have the HTML head/foot written (on a 400 error), but
277
the handler code may pass an apache req if an exception occurs before
278
the IVLE request is created.
280
req.content_type = "text/html"
281
logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
283
# For some reason, some versions of mod_python have "_server" instead of
284
# "main_server". So we check for both.
286
admin_email = mod_python.apache.main_server.server_admin
287
except AttributeError:
289
admin_email = mod_python.apache._server.server_admin
290
except AttributeError:
293
httpcode = exc_value.httpcode
294
req.status = httpcode
295
except AttributeError:
297
req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
299
publicmode = req.publicmode
300
except AttributeError:
303
login = req.user.login
304
except AttributeError:
308
except AttributeError:
313
for h in logging.getLogger().handlers:
314
logging.getLogger().removeHandler(h)
315
logging.basicConfig(level=logging.INFO,
316
format='%(asctime)s %(levelname)s: ' +
317
'(HTTP: ' + str(req.status) +
318
', Ref: ' + str(login) + '@' +
319
str(socket.gethostname()) + str(req.uri) +
325
logging.debug('Logging Unhandled Exception')
327
# We handle 3 types of error.
328
# IVLEErrors with 4xx response codes (client error).
329
# IVLEErrors with 5xx response codes (handled server error).
330
# Other exceptions (unhandled server error).
331
# IVLEErrors should not have other response codes than 4xx or 5xx
332
# (eg. throw_redirect should have been used for 3xx codes).
333
# Therefore, that is treated as an unhandled error.
335
if (exc_type == util.IVLEError and httpcode >= 400
336
and httpcode <= 499):
337
# IVLEErrors with 4xx response codes are client errors.
338
# Therefore, these have a "nice" response (we even coat it in the IVLE
341
req.write_html_head_foot = True
342
req.write_javascript_settings = False
343
req.write('<div id="ivle_padding">\n')
345
codename, msg = req.get_http_codename(httpcode)
346
except AttributeError:
347
codename, msg = None, None
348
# Override the default message with the supplied one,
350
if exc_value.message is not None:
351
msg = exc_value.message
352
if codename is not None:
353
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
355
req.write("<h1>Error</h1>\n")
357
req.write("<p>%s</p>\n" % cgi.escape(msg))
359
req.write("<p>An unknown error occured.</p>\n")
362
logging.info(str(msg))
364
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
366
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
367
%cgi.escape(logfile))
368
req.write('</div>\n')
369
html.write_html_foot(req)
371
# A "bad" error message. We shouldn't get here unless IVLE
372
# misbehaves (which is currently very easy, if things aren't set up
374
# Write the traceback.
375
# If this is a non-4xx IVLEError, get the message and httpcode and
376
# make the error message a bit nicer (but still include the
378
# We also need to special-case IVLEJailError, as we can get another
379
# almost-exception out of it.
381
codename, msg = None, None
383
if exc_type is util.IVLEJailError:
384
msg = exc_value.type_str + ": " + exc_value.message
385
tb = 'Exception information extracted from IVLEJailError:\n'
386
tb += urllib.unquote(exc_value.info)
389
codename, msg = req.get_http_codename(httpcode)
390
except AttributeError:
392
# Override the default message with the supplied one,
394
if hasattr(exc_value, 'message') and exc_value.message is not None:
395
msg = exc_value.message
396
# Prepend the exception type
397
if exc_type != util.IVLEError:
398
msg = exc_type.__name__ + ": " + msg
400
tb = ''.join(traceback.format_exception(exc_type, exc_value,
404
logging.error('%s\n%s'%(str(msg), tb))
405
# Error messages are only displayed is the user is NOT a student,
406
# or if there has been a problem logging the error message
407
show_errors = (not publicmode) and ((login and \
408
str(role) != "student") or logfail)
409
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
410
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
411
<html xmlns="http://www.w3.org/1999/xhtml">
412
<head><title>IVLE Internal Server Error</title></head>
414
<h1>IVLE Internal Server Error""")
416
if (codename is not None
417
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
418
req.write(": %s" % cgi.escape(codename))
421
<p>An error has occured which is the fault of the IVLE developers or
422
administration. The developers have been notified.</p>
426
req.write("<p>%s</p>\n" % cgi.escape(msg))
427
if httpcode is not None:
428
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
430
<p>Please report this to <a href="mailto:%s">%s</a> (the system
431
administrator). Include the following information:</p>
432
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
434
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
436
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
437
%cgi.escape(logfile))
438
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
