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, PublicViewPlugin
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.filesystem.serve#Plugin',
63
'ivle.webapp.groups#Plugin',
64
'ivle.webapp.console#Plugin',
65
'ivle.webapp.security#Plugin',
66
'ivle.webapp.media#Plugin',
67
'ivle.webapp.forum#Plugin',
68
'ivle.webapp.help#Plugin',
69
'ivle.webapp.tos#Plugin',
70
'ivle.webapp.userservice#Plugin',
73
def generate_route_mapper(view_plugins, attr):
75
Build a Mapper object for doing URL matching using 'routes', based on the
76
given plugin registry.
78
m = routes.Mapper(explicit=True)
79
for plugin in view_plugins:
80
# Establish a URL pattern for each element of plugin.urls
81
assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin
82
for url in getattr(plugin, attr):
85
kwargs_dict = url[2] if len(url) >= 3 else {}
86
m.connect(routex, view=view_class, **kwargs_dict)
89
def get_plugin(pluginstr):
90
plugin_path, classname = pluginstr.split('#')
91
# Load the plugin module from somewhere in the Python path
92
# (Note that plugin_path is a fully-qualified Python module name).
94
getattr(__import__(plugin_path, fromlist=[classname]), classname))
97
"""Handles a request which may be to anywhere in the site except media.
98
Intended to be called by mod_python, as a handler.
100
req: An Apache request object.
102
# Make the request object into an IVLE request which can be passed to apps
105
req = Request(req, html.write_html_head)
107
# Pass the apachereq to error reporter, since ivle req isn't created
109
handle_unknown_exception(apachereq, *sys.exc_info())
110
# Tell Apache not to generate its own errors as well
111
return mod_python.apache.OK
113
# Run the main handler, and catch all exceptions
115
return handler_(req, apachereq)
116
except mod_python.apache.SERVER_RETURN:
117
# An apache error. We discourage these, but they might still happen.
121
handle_unknown_exception(req, *sys.exc_info())
122
# Tell Apache not to generate its own errors as well
123
return mod_python.apache.OK
125
def handler_(req, apachereq):
127
Nested handler function. May raise exceptions. The top-level handler is
128
just used to catch exceptions.
129
Takes both an IVLE request and an Apache req.
131
# Hack? Try and get the user login early just in case we throw an error
132
# (most likely 404) to stop us seeing not logged in even when we are.
133
if not req.publicmode:
134
user = login.get_user_details(req)
136
# Don't set the user if it is disabled or hasn't accepted the ToS.
137
if user and user.valid:
140
### BEGIN New plugins framework ###
141
# XXX This should be done ONCE per Python process, not per request.
143
req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
144
# Index the plugins by base class
145
req.plugin_index = {}
146
for plugin in req.plugins.values():
147
# Getmro returns a tuple of all the super-classes of the plugin
148
for base in inspect.getmro(plugin):
149
if base not in req.plugin_index:
150
req.plugin_index[base] = []
151
req.plugin_index[base].append(plugin)
152
req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
155
req.mapper = generate_route_mapper(req.plugin_index[PublicViewPlugin],
158
req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin],
161
matchdict = req.mapper.match(req.uri)
162
if matchdict is not None:
163
viewcls = matchdict['view']
164
# Get the remaining arguments, less 'view', 'action' and 'controller'
165
# (The latter two seem to be built-in, and we don't want them).
166
kwargs = matchdict.copy()
169
# Instantiate the view, which should be a BaseView class
170
view = viewcls(req, **kwargs)
172
# Check that the request (mainly the user) is permitted to access
174
if not view.authorize(req):
179
# A view explicitly raised an HTTP error. Respect it.
182
# Try to find a custom error view.
183
if hasattr(viewcls, 'get_error_view'):
184
errviewcls = viewcls.get_error_view(e)
189
errview = errviewcls(req, e)
198
# A non-HTTPError appeared. We have an unknown exception. Panic.
199
handle_unknown_exception(req, *sys.exc_info())
205
# We had no matching URL! Check if it matches an old-style app. If
207
if req.app not in ivle.conf.apps.app_url:
208
return req.HTTP_NOT_FOUND # TODO: Prettify.
209
### END New plugins framework ###
212
### BEGIN legacy application framework ###
213
# We have no public apps back here.
214
assert not req.publicmode
216
# app is the App object for the chosen app
218
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
220
app = ivle.conf.apps.app_url[req.app]
222
# Check if app requires auth. If so, perform authentication and login.
223
# This will either return a User object, None, or perform a redirect
224
# which we will not catch here.
226
logged_in = req.user is not None
230
assert logged_in # XXX
233
# Keep the user's session alive by writing to the session object.
234
# req.get_session().save()
235
# Well, it's a fine idea, but it creates considerable grief in the
236
# concurrent update department, so instead, we'll just make the
237
# sessions not time out.
238
req.get_session().unlock()
240
# Call the specified app with the request object
241
apps.call_app(app.dir, req)
243
# MAKE SURE we write the HTTP (and possibly HTML) header. This
244
# wouldn't happen if nothing else ever got written, so we have to make
246
req.ensure_headers_written()
248
# When done, write out the HTML footer if the app has requested it
249
if req.write_html_head_foot:
250
html.write_html_foot(req)
252
# Note: Apache will not write custom HTML error messages here.
253
# Use req.throw_error to do that.
256
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
258
Given an exception that has just been thrown from IVLE, print its details
260
This is a full handler. It assumes nothing has been written, and writes a
262
req: May be EITHER an IVLE req or an Apache req.
263
IVLE reqs may have the HTML head/foot written (on a 400 error), but
264
the handler code may pass an apache req if an exception occurs before
265
the IVLE request is created.
267
req.content_type = "text/html"
268
logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
270
# For some reason, some versions of mod_python have "_server" instead of
271
# "main_server". So we check for both.
273
admin_email = mod_python.apache.main_server.server_admin
274
except AttributeError:
276
admin_email = mod_python.apache._server.server_admin
277
except AttributeError:
280
httpcode = exc_value.httpcode
281
req.status = httpcode
282
except AttributeError:
284
req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
286
publicmode = req.publicmode
287
except AttributeError:
290
login = req.user.login
291
except AttributeError:
295
except AttributeError:
300
for h in logging.getLogger().handlers:
301
logging.getLogger().removeHandler(h)
302
logging.basicConfig(level=logging.INFO,
303
format='%(asctime)s %(levelname)s: ' +
304
'(HTTP: ' + str(req.status) +
305
', Ref: ' + str(login) + '@' +
306
str(socket.gethostname()) + str(req.uri) +
312
logging.debug('Logging Unhandled Exception')
314
# We handle 3 types of error.
315
# IVLEErrors with 4xx response codes (client error).
316
# IVLEErrors with 5xx response codes (handled server error).
317
# Other exceptions (unhandled server error).
318
# IVLEErrors should not have other response codes than 4xx or 5xx
319
# (eg. throw_redirect should have been used for 3xx codes).
320
# Therefore, that is treated as an unhandled error.
322
if (exc_type == util.IVLEError and httpcode >= 400
323
and httpcode <= 499):
324
# IVLEErrors with 4xx response codes are client errors.
325
# Therefore, these have a "nice" response (we even coat it in the IVLE
328
req.write_html_head_foot = True
329
req.write_javascript_settings = False
330
req.write('<div id="ivle_padding">\n')
332
codename, msg = req.get_http_codename(httpcode)
333
except AttributeError:
334
codename, msg = None, None
335
# Override the default message with the supplied one,
337
if exc_value.message is not None:
338
msg = exc_value.message
339
if codename is not None:
340
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
342
req.write("<h1>Error</h1>\n")
344
req.write("<p>%s</p>\n" % cgi.escape(msg))
346
req.write("<p>An unknown error occured.</p>\n")
349
logging.info(str(msg))
351
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
353
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
354
%cgi.escape(logfile))
355
req.write('</div>\n')
356
html.write_html_foot(req)
358
# A "bad" error message. We shouldn't get here unless IVLE
359
# misbehaves (which is currently very easy, if things aren't set up
361
# Write the traceback.
362
# If this is a non-4xx IVLEError, get the message and httpcode and
363
# make the error message a bit nicer (but still include the
365
# We also need to special-case IVLEJailError, as we can get another
366
# almost-exception out of it.
368
codename, msg = None, None
370
if exc_type is util.IVLEJailError:
371
msg = exc_value.type_str + ": " + exc_value.message
372
tb = 'Exception information extracted from IVLEJailError:\n'
373
tb += urllib.unquote(exc_value.info)
376
codename, msg = req.get_http_codename(httpcode)
377
except AttributeError:
379
# Override the default message with the supplied one,
381
if hasattr(exc_value, 'message') and exc_value.message is not None:
382
msg = exc_value.message
383
# Prepend the exception type
384
if exc_type != util.IVLEError:
385
msg = exc_type.__name__ + ": " + msg
387
tb = ''.join(traceback.format_exception(exc_type, exc_value,
391
logging.error('%s\n%s'%(str(msg), tb))
392
# Error messages are only displayed is the user is NOT a student,
393
# or if there has been a problem logging the error message
394
show_errors = (not publicmode) and ((login and \
395
str(role) != "student") or logfail)
396
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
397
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
398
<html xmlns="http://www.w3.org/1999/xhtml">
399
<head><title>IVLE Internal Server Error</title></head>
401
<h1>IVLE Internal Server Error""")
403
if (codename is not None
404
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
405
req.write(": %s" % cgi.escape(codename))
408
<p>An error has occured which is the fault of the IVLE developers or
409
administration. The developers have been notified.</p>
413
req.write("<p>%s</p>\n" % cgi.escape(msg))
414
if httpcode is not None:
415
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
417
<p>Please report this to <a href="mailto:%s">%s</a> (the system
418
administrator). Include the following information:</p>
419
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
421
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
423
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
424
%cgi.escape(logfile))
425
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
