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
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',
70
def generate_route_mapper(view_plugins):
72
Build a Mapper object for doing URL matching using 'routes', based on the
73
given plugin registry.
75
m = routes.Mapper(explicit=True)
76
for plugin in view_plugins:
77
# Establish a URL pattern for each element of plugin.urls
78
assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin
79
for url in plugin.urls:
82
kwargs_dict = url[2] if len(url) >= 3 else {}
83
m.connect(routex, view=view_class, **kwargs_dict)
86
def get_plugin(pluginstr):
87
plugin_path, classname = pluginstr.split('#')
88
# Load the plugin module from somewhere in the Python path
89
# (Note that plugin_path is a fully-qualified Python module name).
91
getattr(__import__(plugin_path, fromlist=[classname]), classname))
94
"""Handles a request which may be to anywhere in the site except media.
95
Intended to be called by mod_python, as a handler.
97
req: An Apache request object.
99
# Make the request object into an IVLE request which can be passed to apps
102
req = Request(req, html.write_html_head)
104
# Pass the apachereq to error reporter, since ivle req isn't created
106
handle_unknown_exception(apachereq, *sys.exc_info())
107
# Tell Apache not to generate its own errors as well
108
return mod_python.apache.OK
110
# Run the main handler, and catch all exceptions
112
return handler_(req, apachereq)
113
except mod_python.apache.SERVER_RETURN:
114
# An apache error. We discourage these, but they might still happen.
118
handle_unknown_exception(req, *sys.exc_info())
119
# Tell Apache not to generate its own errors as well
120
return mod_python.apache.OK
122
def handler_(req, apachereq):
124
Nested handler function. May raise exceptions. The top-level handler is
125
just used to catch exceptions.
126
Takes both an IVLE request and an Apache req.
128
# Hack? Try and get the user login early just in case we throw an error
129
# (most likely 404) to stop us seeing not logged in even when we are.
130
if not req.publicmode:
131
req.user = login.get_user_details(req)
133
### BEGIN New plugins framework ###
134
# XXX This should be done ONCE per Python process, not per request.
136
# XXX No authentication is done here
137
req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
138
# Index the plugins by base class
139
req.plugin_index = {}
140
for plugin in req.plugins.values():
141
# Getmro returns a tuple of all the super-classes of the plugin
142
for base in inspect.getmro(plugin):
143
if base not in req.plugin_index:
144
req.plugin_index[base] = []
145
req.plugin_index[base].append(plugin)
146
req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
147
req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
149
matchdict = req.mapper.match(req.uri)
150
if matchdict is not None:
151
viewcls = matchdict['view']
152
# Get the remaining arguments, less 'view', 'action' and 'controller'
153
# (The latter two seem to be built-in, and we don't want them).
154
kwargs = matchdict.copy()
157
# Instantiate the view, which should be a BaseView class
158
view = viewcls(req, **kwargs)
162
# A view explicitly raised an HTTP error. Respect it.
165
# Try to find a custom error view.
166
if hasattr(viewcls, 'get_error_view'):
167
errviewcls = viewcls.get_error_view(e)
172
errview = errviewcls(req, e)
179
# A non-HTTPError appeared. We have an unknown exception. Panic.
180
handle_unknown_exception(req, *sys.exc_info())
185
### END New plugins framework ###
187
# Check req.app to see if it is valid. 404 if not.
188
if req.app is not None and req.app not in ivle.conf.apps.app_url:
189
req.throw_error(Request.HTTP_NOT_FOUND,
190
"There is no application called %s." % repr(req.app))
192
# Special handling for public mode - only allow the public app, call it
194
# NOTE: This will not behave correctly if the public app uses
195
# write_html_head_foot, but "serve" does not.
197
if req.app != ivle.conf.apps.public_app:
198
req.throw_error(Request.HTTP_FORBIDDEN,
199
"This application is not available on the public site.")
200
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
201
apps.call_app(app.dir, req)
204
# app is the App object for the chosen app
206
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
208
app = ivle.conf.apps.app_url[req.app]
210
# Check if app requires auth. If so, perform authentication and login.
211
# This will either return a User object, None, or perform a redirect
212
# which we will not catch here.
214
req.user = login.login(req)
215
logged_in = req.user is not None
217
req.user = login.get_user_details(req)
221
# Keep the user's session alive by writing to the session object.
222
# req.get_session().save()
223
# Well, it's a fine idea, but it creates considerable grief in the
224
# concurrent update department, so instead, we'll just make the
225
# sessions not time out.
226
req.get_session().unlock()
228
# If user did not specify an app, HTTP redirect to default app and
231
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
233
# Set the default title to the app's tab name, if any. Otherwise URL
235
if app.name is not None:
240
# Call the specified app with the request object
241
apps.call_app(app.dir, req)
243
# if not logged in, login.login will have written the login box.
244
# Just clean up and exit.
246
# MAKE SURE we write the HTTP (and possibly HTML) header. This
247
# wouldn't happen if nothing else ever got written, so we have to make
249
req.ensure_headers_written()
251
# When done, write out the HTML footer if the app has requested it
252
if req.write_html_head_foot:
253
html.write_html_foot(req)
255
# Note: Apache will not write custom HTML error messages here.
256
# Use req.throw_error to do that.
259
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
261
Given an exception that has just been thrown from IVLE, print its details
263
This is a full handler. It assumes nothing has been written, and writes a
265
req: May be EITHER an IVLE req or an Apache req.
266
IVLE reqs may have the HTML head/foot written (on a 400 error), but
267
the handler code may pass an apache req if an exception occurs before
268
the IVLE request is created.
270
req.content_type = "text/html"
271
logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
273
# For some reason, some versions of mod_python have "_server" instead of
274
# "main_server". So we check for both.
276
admin_email = mod_python.apache.main_server.server_admin
277
except AttributeError:
279
admin_email = mod_python.apache._server.server_admin
280
except AttributeError:
283
httpcode = exc_value.httpcode
284
req.status = httpcode
285
except AttributeError:
287
req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
289
publicmode = req.publicmode
290
except AttributeError:
293
login = req.user.login
294
except AttributeError:
298
except AttributeError:
303
for h in logging.getLogger().handlers:
304
logging.getLogger().removeHandler(h)
305
logging.basicConfig(level=logging.INFO,
306
format='%(asctime)s %(levelname)s: ' +
307
'(HTTP: ' + str(req.status) +
308
', Ref: ' + str(login) + '@' +
309
str(socket.gethostname()) + str(req.uri) +
315
logging.debug('Logging Unhandled Exception')
317
# We handle 3 types of error.
318
# IVLEErrors with 4xx response codes (client error).
319
# IVLEErrors with 5xx response codes (handled server error).
320
# Other exceptions (unhandled server error).
321
# IVLEErrors should not have other response codes than 4xx or 5xx
322
# (eg. throw_redirect should have been used for 3xx codes).
323
# Therefore, that is treated as an unhandled error.
325
if (exc_type == util.IVLEError and httpcode >= 400
326
and httpcode <= 499):
327
# IVLEErrors with 4xx response codes are client errors.
328
# Therefore, these have a "nice" response (we even coat it in the IVLE
331
req.write_html_head_foot = True
332
req.write_javascript_settings = False
333
req.write('<div id="ivle_padding">\n')
335
codename, msg = req.get_http_codename(httpcode)
336
except AttributeError:
337
codename, msg = None, None
338
# Override the default message with the supplied one,
340
if exc_value.message is not None:
341
msg = exc_value.message
342
if codename is not None:
343
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
345
req.write("<h1>Error</h1>\n")
347
req.write("<p>%s</p>\n" % cgi.escape(msg))
349
req.write("<p>An unknown error occured.</p>\n")
352
logging.info(str(msg))
354
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
356
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
357
%cgi.escape(logfile))
358
req.write('</div>\n')
359
html.write_html_foot(req)
361
# A "bad" error message. We shouldn't get here unless IVLE
362
# misbehaves (which is currently very easy, if things aren't set up
364
# Write the traceback.
365
# If this is a non-4xx IVLEError, get the message and httpcode and
366
# make the error message a bit nicer (but still include the
368
# We also need to special-case IVLEJailError, as we can get another
369
# almost-exception out of it.
371
codename, msg = None, None
373
if exc_type is util.IVLEJailError:
374
msg = exc_value.type_str + ": " + exc_value.message
375
tb = 'Exception information extracted from IVLEJailError:\n'
376
tb += urllib.unquote(exc_value.info)
379
codename, msg = req.get_http_codename(httpcode)
380
except AttributeError:
382
# Override the default message with the supplied one,
384
if hasattr(exc_value, 'message') and exc_value.message is not None:
385
msg = exc_value.message
386
# Prepend the exception type
387
if exc_type != util.IVLEError:
388
msg = exc_type.__name__ + ": " + msg
390
tb = ''.join(traceback.format_exception(exc_type, exc_value,
394
logging.error('%s\n%s'%(str(msg), tb))
395
# Error messages are only displayed is the user is NOT a student,
396
# or if there has been a problem logging the error message
397
show_errors = (not publicmode) and ((login and \
398
str(role) != "student") or logfail)
399
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
400
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
401
<html xmlns="http://www.w3.org/1999/xhtml">
402
<head><title>IVLE Internal Server Error</title></head>
404
<h1>IVLE Internal Server Error""")
406
if (codename is not None
407
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
408
req.write(": %s" % cgi.escape(codename))
411
<p>An error has occured which is the fault of the IVLE developers or
412
administration. The developers have been notified.</p>
416
req.write("<p>%s</p>\n" % cgi.escape(msg))
417
if httpcode is not None:
418
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
420
<p>Please report this to <a href="mailto:%s">%s</a> (the system
421
administrator). Include the following information:</p>
422
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
424
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
426
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
427
%cgi.escape(logfile))
428
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
