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',
69
def generate_route_mapper(view_plugins):
71
Build a Mapper object for doing URL matching using 'routes', based on the
72
given plugin registry.
74
m = routes.Mapper(explicit=True)
75
for plugin in view_plugins:
76
# Establish a URL pattern for each element of plugin.urls
77
assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin
78
for url in plugin.urls:
81
kwargs_dict = url[2] if len(url) >= 3 else {}
82
m.connect(routex, view=view_class, **kwargs_dict)
85
def get_plugin(pluginstr):
86
plugin_path, classname = pluginstr.split('#')
87
# Load the plugin module from somewhere in the Python path
88
# (Note that plugin_path is a fully-qualified Python module name).
90
getattr(__import__(plugin_path, fromlist=[classname]), classname))
93
"""Handles a request which may be to anywhere in the site except media.
94
Intended to be called by mod_python, as a handler.
96
req: An Apache request object.
98
# Make the request object into an IVLE request which can be passed to apps
101
req = Request(req, html.write_html_head)
103
# Pass the apachereq to error reporter, since ivle req isn't created
105
handle_unknown_exception(apachereq, *sys.exc_info())
106
# Tell Apache not to generate its own errors as well
107
return mod_python.apache.OK
109
# Run the main handler, and catch all exceptions
111
return handler_(req, apachereq)
112
except mod_python.apache.SERVER_RETURN:
113
# An apache error. We discourage these, but they might still happen.
117
handle_unknown_exception(req, *sys.exc_info())
118
# Tell Apache not to generate its own errors as well
119
return mod_python.apache.OK
121
def handler_(req, apachereq):
123
Nested handler function. May raise exceptions. The top-level handler is
124
just used to catch exceptions.
125
Takes both an IVLE request and an Apache req.
127
# Hack? Try and get the user login early just in case we throw an error
128
# (most likely 404) to stop us seeing not logged in even when we are.
129
if not req.publicmode:
130
req.user = login.get_user_details(req)
132
### BEGIN New plugins framework ###
133
# XXX This should be done ONCE per Python process, not per request.
135
# XXX No authentication is done here
136
req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
137
# Index the plugins by base class
138
req.plugin_index = {}
139
for plugin in req.plugins.values():
140
# Getmro returns a tuple of all the super-classes of the plugin
141
for base in inspect.getmro(plugin):
142
if base not in req.plugin_index:
143
req.plugin_index[base] = []
144
req.plugin_index[base].append(plugin)
145
req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
146
req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
148
matchdict = req.mapper.match(req.uri)
149
if matchdict is not None:
150
viewcls = matchdict['view']
151
# Get the remaining arguments, less 'view', 'action' and 'controller'
152
# (The latter two seem to be built-in, and we don't want them).
153
kwargs = matchdict.copy()
156
# Instantiate the view, which should be a BaseView class
157
view = viewcls(req, **kwargs)
161
# A view explicitly raised an HTTP error. Respect it.
164
# Try to find a custom error view.
165
if hasattr(viewcls, 'get_error_view'):
166
errviewcls = viewcls.get_error_view(e)
171
errview = errviewcls(req, e)
178
# A non-HTTPError appeared. We have an unknown exception. Panic.
179
handle_unknown_exception(req, *sys.exc_info())
184
### END New plugins framework ###
186
# Check req.app to see if it is valid. 404 if not.
187
if req.app is not None and req.app not in ivle.conf.apps.app_url:
188
req.throw_error(Request.HTTP_NOT_FOUND,
189
"There is no application called %s." % repr(req.app))
191
# Special handling for public mode - only allow the public app, call it
193
# NOTE: This will not behave correctly if the public app uses
194
# write_html_head_foot, but "serve" does not.
196
if req.app != ivle.conf.apps.public_app:
197
req.throw_error(Request.HTTP_FORBIDDEN,
198
"This application is not available on the public site.")
199
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
200
apps.call_app(app.dir, req)
203
# app is the App object for the chosen app
205
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
207
app = ivle.conf.apps.app_url[req.app]
209
# Check if app requires auth. If so, perform authentication and login.
210
# This will either return a User object, None, or perform a redirect
211
# which we will not catch here.
213
req.user = login.login(req)
214
logged_in = req.user is not None
216
req.user = login.get_user_details(req)
220
# Keep the user's session alive by writing to the session object.
221
# req.get_session().save()
222
# Well, it's a fine idea, but it creates considerable grief in the
223
# concurrent update department, so instead, we'll just make the
224
# sessions not time out.
225
req.get_session().unlock()
227
# If user did not specify an app, HTTP redirect to default app and
230
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
232
# Set the default title to the app's tab name, if any. Otherwise URL
234
if app.name is not None:
239
# Call the specified app with the request object
240
apps.call_app(app.dir, req)
242
# if not logged in, login.login will have written the login box.
243
# Just clean up and exit.
245
# MAKE SURE we write the HTTP (and possibly HTML) header. This
246
# wouldn't happen if nothing else ever got written, so we have to make
248
req.ensure_headers_written()
250
# When done, write out the HTML footer if the app has requested it
251
if req.write_html_head_foot:
252
html.write_html_foot(req)
254
# Note: Apache will not write custom HTML error messages here.
255
# Use req.throw_error to do that.
258
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
260
Given an exception that has just been thrown from IVLE, print its details
262
This is a full handler. It assumes nothing has been written, and writes a
264
req: May be EITHER an IVLE req or an Apache req.
265
IVLE reqs may have the HTML head/foot written (on a 400 error), but
266
the handler code may pass an apache req if an exception occurs before
267
the IVLE request is created.
269
req.content_type = "text/html"
270
logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
272
# For some reason, some versions of mod_python have "_server" instead of
273
# "main_server". So we check for both.
275
admin_email = mod_python.apache.main_server.server_admin
276
except AttributeError:
278
admin_email = mod_python.apache._server.server_admin
279
except AttributeError:
282
httpcode = exc_value.httpcode
283
req.status = httpcode
284
except AttributeError:
286
req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
288
publicmode = req.publicmode
289
except AttributeError:
292
login = req.user.login
293
except AttributeError:
297
except AttributeError:
302
for h in logging.getLogger().handlers:
303
logging.getLogger().removeHandler(h)
304
logging.basicConfig(level=logging.INFO,
305
format='%(asctime)s %(levelname)s: ' +
306
'(HTTP: ' + str(req.status) +
307
', Ref: ' + str(login) + '@' +
308
str(socket.gethostname()) + str(req.uri) +
314
logging.debug('Logging Unhandled Exception')
316
# We handle 3 types of error.
317
# IVLEErrors with 4xx response codes (client error).
318
# IVLEErrors with 5xx response codes (handled server error).
319
# Other exceptions (unhandled server error).
320
# IVLEErrors should not have other response codes than 4xx or 5xx
321
# (eg. throw_redirect should have been used for 3xx codes).
322
# Therefore, that is treated as an unhandled error.
324
if (exc_type == util.IVLEError and httpcode >= 400
325
and httpcode <= 499):
326
# IVLEErrors with 4xx response codes are client errors.
327
# Therefore, these have a "nice" response (we even coat it in the IVLE
330
req.write_html_head_foot = True
331
req.write_javascript_settings = False
332
req.write('<div id="ivle_padding">\n')
334
codename, msg = req.get_http_codename(httpcode)
335
except AttributeError:
336
codename, msg = None, None
337
# Override the default message with the supplied one,
339
if exc_value.message is not None:
340
msg = exc_value.message
341
if codename is not None:
342
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
344
req.write("<h1>Error</h1>\n")
346
req.write("<p>%s</p>\n" % cgi.escape(msg))
348
req.write("<p>An unknown error occured.</p>\n")
351
logging.info(str(msg))
353
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
355
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
356
%cgi.escape(logfile))
357
req.write('</div>\n')
358
html.write_html_foot(req)
360
# A "bad" error message. We shouldn't get here unless IVLE
361
# misbehaves (which is currently very easy, if things aren't set up
363
# Write the traceback.
364
# If this is a non-4xx IVLEError, get the message and httpcode and
365
# make the error message a bit nicer (but still include the
367
# We also need to special-case IVLEJailError, as we can get another
368
# almost-exception out of it.
370
codename, msg = None, None
372
if exc_type is util.IVLEJailError:
373
msg = exc_value.type_str + ": " + exc_value.message
374
tb = 'Exception information extracted from IVLEJailError:\n'
375
tb += urllib.unquote(exc_value.info)
378
codename, msg = req.get_http_codename(httpcode)
379
except AttributeError:
381
# Override the default message with the supplied one,
383
if hasattr(exc_value, 'message') and exc_value.message is not None:
384
msg = exc_value.message
385
# Prepend the exception type
386
if exc_type != util.IVLEError:
387
msg = exc_type.__name__ + ": " + msg
389
tb = ''.join(traceback.format_exception(exc_type, exc_value,
393
logging.error('%s\n%s'%(str(msg), tb))
394
# Error messages are only displayed is the user is NOT a student,
395
# or if there has been a problem logging the error message
396
show_errors = (not publicmode) and ((login and \
397
str(role) != "student") or logfail)
398
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
399
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
400
<html xmlns="http://www.w3.org/1999/xhtml">
401
<head><title>IVLE Internal Server Error</title></head>
403
<h1>IVLE Internal Server Error""")
405
if (codename is not None
406
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
407
req.write(": %s" % cgi.escape(codename))
410
<p>An error has occured which is the fault of the IVLE developers or
411
administration. The developers have been notified.</p>
415
req.write("<p>%s</p>\n" % cgi.escape(msg))
416
if httpcode is not None:
417
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
419
<p>Please report this to <a href="mailto:%s">%s</a> (the system
420
administrator). Include the following information:</p>
421
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
423
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
425
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
426
%cgi.escape(logfile))
427
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
