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
52
# XXX List of plugins, which will eventually be read in from conf
54
'ivle.webapp.core#Plugin',
55
'ivle.webapp.admin.user#Plugin',
56
'ivle.webapp.tutorial#Plugin',
57
'ivle.webapp.admin.subject#Plugin',
58
'ivle.webapp.filesystem.browser#Plugin',
59
'ivle.webapp.filesystem.diff#Plugin',
60
'ivle.webapp.filesystem.svnlog#Plugin',
61
'ivle.webapp.groups#Plugin',
62
'ivle.webapp.console#Plugin',
63
'ivle.webapp.security#Plugin',
64
'ivle.webapp.media#Plugin',
67
def generate_route_mapper(view_plugins):
69
Build a Mapper object for doing URL matching using 'routes', based on the
70
given plugin registry.
72
m = routes.Mapper(explicit=True)
73
for plugin in view_plugins:
74
# Establish a URL pattern for each element of plugin.urls
75
assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin
76
for url in plugin.urls:
79
kwargs_dict = url[2] if len(url) >= 3 else {}
80
m.connect(routex, view=view_class, **kwargs_dict)
83
def get_plugin(pluginstr):
84
plugin_path, classname = pluginstr.split('#')
85
# Load the plugin module from somewhere in the Python path
86
# (Note that plugin_path is a fully-qualified Python module name).
88
getattr(__import__(plugin_path, fromlist=[classname]), classname))
91
"""Handles a request which may be to anywhere in the site except media.
92
Intended to be called by mod_python, as a handler.
94
req: An Apache request object.
96
# Make the request object into an IVLE request which can be passed to apps
99
req = Request(req, html.write_html_head)
101
# Pass the apachereq to error reporter, since ivle req isn't created
103
handle_unknown_exception(apachereq, *sys.exc_info())
104
# Tell Apache not to generate its own errors as well
105
return mod_python.apache.OK
107
# Run the main handler, and catch all exceptions
109
return handler_(req, apachereq)
110
except mod_python.apache.SERVER_RETURN:
111
# An apache error. We discourage these, but they might still happen.
115
handle_unknown_exception(req, *sys.exc_info())
116
# Tell Apache not to generate its own errors as well
117
return mod_python.apache.OK
119
def handler_(req, apachereq):
121
Nested handler function. May raise exceptions. The top-level handler is
122
just used to catch exceptions.
123
Takes both an IVLE request and an Apache req.
125
# Hack? Try and get the user login early just in case we throw an error
126
# (most likely 404) to stop us seeing not logged in even when we are.
127
if not req.publicmode:
128
req.user = login.get_user_details(req)
130
### BEGIN New plugins framework ###
131
# XXX This should be done ONCE per Python process, not per request.
133
# XXX No authentication is done here
134
req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
135
# Index the plugins by base class
136
req.plugin_index = {}
137
for plugin in req.plugins.values():
138
# Getmro returns a tuple of all the super-classes of the plugin
139
for base in inspect.getmro(plugin):
140
if base not in req.plugin_index:
141
req.plugin_index[base] = []
142
req.plugin_index[base].append(plugin)
143
req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
144
req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
146
matchdict = req.mapper.match(req.uri)
147
if matchdict is not None:
148
viewcls = matchdict['view']
149
# Get the remaining arguments, less 'view', 'action' and 'controller'
150
# (The latter two seem to be built-in, and we don't want them).
151
kwargs = matchdict.copy()
153
# Instantiate the view, which should be a BaseView class
154
view = viewcls(req, **kwargs)
159
### END New plugins framework ###
161
# Check req.app to see if it is valid. 404 if not.
162
if req.app is not None and req.app not in ivle.conf.apps.app_url:
163
req.throw_error(Request.HTTP_NOT_FOUND,
164
"There is no application called %s." % repr(req.app))
166
# Special handling for public mode - only allow the public app, call it
168
# NOTE: This will not behave correctly if the public app uses
169
# write_html_head_foot, but "serve" does not.
171
if req.app != ivle.conf.apps.public_app:
172
req.throw_error(Request.HTTP_FORBIDDEN,
173
"This application is not available on the public site.")
174
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
175
apps.call_app(app.dir, req)
178
# app is the App object for the chosen app
180
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
182
app = ivle.conf.apps.app_url[req.app]
184
# Check if app requires auth. If so, perform authentication and login.
185
# This will either return a User object, None, or perform a redirect
186
# which we will not catch here.
188
req.user = login.login(req)
189
logged_in = req.user is not None
191
req.user = login.get_user_details(req)
195
# Keep the user's session alive by writing to the session object.
196
# req.get_session().save()
197
# Well, it's a fine idea, but it creates considerable grief in the
198
# concurrent update department, so instead, we'll just make the
199
# sessions not time out.
200
req.get_session().unlock()
202
# If user did not specify an app, HTTP redirect to default app and
205
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
207
# Set the default title to the app's tab name, if any. Otherwise URL
209
if app.name is not None:
214
# Call the specified app with the request object
215
apps.call_app(app.dir, req)
217
# if not logged in, login.login will have written the login box.
218
# Just clean up and exit.
220
# MAKE SURE we write the HTTP (and possibly HTML) header. This
221
# wouldn't happen if nothing else ever got written, so we have to make
223
req.ensure_headers_written()
225
# When done, write out the HTML footer if the app has requested it
226
if req.write_html_head_foot:
227
html.write_html_foot(req)
229
# Note: Apache will not write custom HTML error messages here.
230
# Use req.throw_error to do that.
233
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
235
Given an exception that has just been thrown from IVLE, print its details
237
This is a full handler. It assumes nothing has been written, and writes a
239
req: May be EITHER an IVLE req or an Apache req.
240
IVLE reqs may have the HTML head/foot written (on a 400 error), but
241
the handler code may pass an apache req if an exception occurs before
242
the IVLE request is created.
244
req.content_type = "text/html"
245
logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
247
# For some reason, some versions of mod_python have "_server" instead of
248
# "main_server". So we check for both.
250
admin_email = mod_python.apache.main_server.server_admin
251
except AttributeError:
253
admin_email = mod_python.apache._server.server_admin
254
except AttributeError:
257
httpcode = exc_value.httpcode
258
req.status = httpcode
259
except AttributeError:
261
req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
263
publicmode = req.publicmode
264
except AttributeError:
267
login = req.user.login
268
except AttributeError:
272
except AttributeError:
277
for h in logging.getLogger().handlers:
278
logging.getLogger().removeHandler(h)
279
logging.basicConfig(level=logging.INFO,
280
format='%(asctime)s %(levelname)s: ' +
281
'(HTTP: ' + str(req.status) +
282
', Ref: ' + str(login) + '@' +
283
str(socket.gethostname()) + str(req.uri) +
289
logging.debug('Logging Unhandled Exception')
291
# We handle 3 types of error.
292
# IVLEErrors with 4xx response codes (client error).
293
# IVLEErrors with 5xx response codes (handled server error).
294
# Other exceptions (unhandled server error).
295
# IVLEErrors should not have other response codes than 4xx or 5xx
296
# (eg. throw_redirect should have been used for 3xx codes).
297
# Therefore, that is treated as an unhandled error.
299
if (exc_type == util.IVLEError and httpcode >= 400
300
and httpcode <= 499):
301
# IVLEErrors with 4xx response codes are client errors.
302
# Therefore, these have a "nice" response (we even coat it in the IVLE
305
req.write_html_head_foot = True
306
req.write_javascript_settings = False
307
req.write('<div id="ivle_padding">\n')
309
codename, msg = req.get_http_codename(httpcode)
310
except AttributeError:
311
codename, msg = None, None
312
# Override the default message with the supplied one,
314
if exc_value.message is not None:
315
msg = exc_value.message
316
if codename is not None:
317
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
319
req.write("<h1>Error</h1>\n")
321
req.write("<p>%s</p>\n" % cgi.escape(msg))
323
req.write("<p>An unknown error occured.</p>\n")
326
logging.info(str(msg))
328
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
330
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
331
%cgi.escape(logfile))
332
req.write('</div>\n')
333
html.write_html_foot(req)
335
# A "bad" error message. We shouldn't get here unless IVLE
336
# misbehaves (which is currently very easy, if things aren't set up
338
# Write the traceback.
339
# If this is a non-4xx IVLEError, get the message and httpcode and
340
# make the error message a bit nicer (but still include the
342
# We also need to special-case IVLEJailError, as we can get another
343
# almost-exception out of it.
345
codename, msg = None, None
347
if exc_type is util.IVLEJailError:
348
msg = exc_value.type_str + ": " + exc_value.message
349
tb = 'Exception information extracted from IVLEJailError:\n'
350
tb += urllib.unquote(exc_value.info)
353
codename, msg = req.get_http_codename(httpcode)
354
except AttributeError:
356
# Override the default message with the supplied one,
358
if hasattr(exc_value, 'message') and exc_value.message is not None:
359
msg = exc_value.message
360
# Prepend the exception type
361
if exc_type != util.IVLEError:
362
msg = exc_type.__name__ + ": " + msg
364
tb = ''.join(traceback.format_exception(exc_type, exc_value,
368
logging.error('%s\n%s'%(str(msg), tb))
369
# Error messages are only displayed is the user is NOT a student,
370
# or if there has been a problem logging the error message
371
show_errors = (not publicmode) and ((login and \
372
str(role) != "student") or logfail)
373
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
374
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
375
<html xmlns="http://www.w3.org/1999/xhtml">
376
<head><title>IVLE Internal Server Error</title></head>
378
<h1>IVLE Internal Server Error""")
380
if (codename is not None
381
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
382
req.write(": %s" % cgi.escape(codename))
385
<p>An error has occured which is the fault of the IVLE developers or
386
administration. The developers have been notified.</p>
390
req.write("<p>%s</p>\n" % cgi.escape(msg))
391
if httpcode is not None:
392
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
394
<p>Please report this to <a href="mailto:%s">%s</a> (the system
395
administrator). Include the following information:</p>
396
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
398
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
400
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
401
%cgi.escape(logfile))
402
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
