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.
45
from ivle.dispatch.request import Request
46
from ivle.dispatch import login
49
import plugins.console # XXX: Relies on www/ being in the Python path.
51
# XXX List of plugins, which will eventually be read in from conf
53
'ivle.webapp.admin.user#Plugin',
54
'ivle.webapp.tutorial#Plugin',
55
'ivle.webapp.admin.subject#Plugin',
56
'ivle.webapp.filesystem.browser#Plugin',
57
'ivle.webapp.filesystem.diff#Plugin',
58
'ivle.webapp.filesystem.svnlog#Plugin',
59
'ivle.webapp.groups#Plugin',
60
'ivle.webapp.console#Plugin',
61
'ivle.webapp.security#Plugin',
62
'ivle.webapp.media#Plugin',
65
def generate_route_mapper(plugins):
67
Build a Mapper object for doing URL matching using 'routes', based on the
68
given plugin registry.
70
m = routes.Mapper(explicit=True)
72
# Establish a URL pattern for each element of plugin.urls
73
if not hasattr(plugins[name], 'urls'):
75
for url in plugins[name].urls:
78
kwargs_dict = url[2] if len(url) >= 3 else {}
79
m.connect(routex, view=view_class, **kwargs_dict)
82
def get_plugin(pluginstr):
83
plugin_path, classname = pluginstr.split('#')
84
# Load the plugin module from somewhere in the Python path
85
# (Note that plugin_path is a fully-qualified Python module name).
87
getattr(__import__(plugin_path, fromlist=[classname]), classname))
90
"""Handles a request which may be to anywhere in the site except media.
91
Intended to be called by mod_python, as a handler.
93
req: An Apache request object.
95
# Make the request object into an IVLE request which can be passed to apps
98
req = Request(req, html.write_html_head)
100
# Pass the apachereq to error reporter, since ivle req isn't created
102
handle_unknown_exception(apachereq, *sys.exc_info())
103
# Tell Apache not to generate its own errors as well
104
return mod_python.apache.OK
106
# Run the main handler, and catch all exceptions
108
return handler_(req, apachereq)
109
except mod_python.apache.SERVER_RETURN:
110
# An apache error. We discourage these, but they might still happen.
114
handle_unknown_exception(req, *sys.exc_info())
115
# Tell Apache not to generate its own errors as well
116
return mod_python.apache.OK
118
def handler_(req, apachereq):
120
Nested handler function. May raise exceptions. The top-level handler is
121
just used to catch exceptions.
122
Takes both an IVLE request and an Apache req.
124
# Hack? Try and get the user login early just in case we throw an error
125
# (most likely 404) to stop us seeing not logged in even when we are.
126
if not req.publicmode:
127
req.user = login.get_user_details(req)
129
### BEGIN New plugins framework ###
130
# XXX This should be done ONCE per Python process, not per request.
132
# XXX No authentication is done here
133
req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
134
req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
135
req.mapper = generate_route_mapper(req.plugins)
137
matchdict = req.mapper.match(req.uri)
138
if matchdict is not None:
139
viewcls = matchdict['view']
140
# Get the remaining arguments, less 'view', 'action' and 'controller'
141
# (The latter two seem to be built-in, and we don't want them).
142
kwargs = matchdict.copy()
144
# Instantiate the view, which should be a BaseView class
145
view = viewcls(req, **kwargs)
150
### END New plugins framework ###
152
# Check req.app to see if it is valid. 404 if not.
153
if req.app is not None and req.app not in ivle.conf.apps.app_url:
154
req.throw_error(Request.HTTP_NOT_FOUND,
155
"There is no application called %s." % repr(req.app))
157
# Special handling for public mode - only allow the public app, call it
159
# NOTE: This will not behave correctly if the public app uses
160
# write_html_head_foot, but "serve" does not.
162
if req.app != ivle.conf.apps.public_app:
163
req.throw_error(Request.HTTP_FORBIDDEN,
164
"This application is not available on the public site.")
165
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
166
apps.call_app(app.dir, req)
169
# app is the App object for the chosen app
171
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
173
app = ivle.conf.apps.app_url[req.app]
175
# Check if app requires auth. If so, perform authentication and login.
176
# This will either return a User object, None, or perform a redirect
177
# which we will not catch here.
179
req.user = login.login(req)
180
logged_in = req.user is not None
182
req.user = login.get_user_details(req)
186
# Keep the user's session alive by writing to the session object.
187
# req.get_session().save()
188
# Well, it's a fine idea, but it creates considerable grief in the
189
# concurrent update department, so instead, we'll just make the
190
# sessions not time out.
191
req.get_session().unlock()
193
# If user did not specify an app, HTTP redirect to default app and
196
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
198
# Set the default title to the app's tab name, if any. Otherwise URL
200
if app.name is not None:
205
# Call the specified app with the request object
206
apps.call_app(app.dir, req)
208
# if not logged in, login.login will have written the login box.
209
# Just clean up and exit.
211
# MAKE SURE we write the HTTP (and possibly HTML) header. This
212
# wouldn't happen if nothing else ever got written, so we have to make
214
req.ensure_headers_written()
216
# When done, write out the HTML footer if the app has requested it
217
if req.write_html_head_foot:
218
# Show the console if required
219
if logged_in and app.useconsole:
220
plugins.console.present(req, windowpane=True)
221
html.write_html_foot(req)
223
# Note: Apache will not write custom HTML error messages here.
224
# Use req.throw_error to do that.
227
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
229
Given an exception that has just been thrown from IVLE, print its details
231
This is a full handler. It assumes nothing has been written, and writes a
233
req: May be EITHER an IVLE req or an Apache req.
234
IVLE reqs may have the HTML head/foot written (on a 400 error), but
235
the handler code may pass an apache req if an exception occurs before
236
the IVLE request is created.
238
req.content_type = "text/html"
239
logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
241
# For some reason, some versions of mod_python have "_server" instead of
242
# "main_server". So we check for both.
244
admin_email = mod_python.apache.main_server.server_admin
245
except AttributeError:
247
admin_email = mod_python.apache._server.server_admin
248
except AttributeError:
251
httpcode = exc_value.httpcode
252
req.status = httpcode
253
except AttributeError:
255
req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
257
publicmode = req.publicmode
258
except AttributeError:
261
login = req.user.login
262
except AttributeError:
266
except AttributeError:
271
for h in logging.getLogger().handlers:
272
logging.getLogger().removeHandler(h)
273
logging.basicConfig(level=logging.INFO,
274
format='%(asctime)s %(levelname)s: ' +
275
'(HTTP: ' + str(req.status) +
276
', Ref: ' + str(login) + '@' +
277
str(socket.gethostname()) + str(req.uri) +
283
logging.debug('Logging Unhandled Exception')
285
# We handle 3 types of error.
286
# IVLEErrors with 4xx response codes (client error).
287
# IVLEErrors with 5xx response codes (handled server error).
288
# Other exceptions (unhandled server error).
289
# IVLEErrors should not have other response codes than 4xx or 5xx
290
# (eg. throw_redirect should have been used for 3xx codes).
291
# Therefore, that is treated as an unhandled error.
293
if (exc_type == util.IVLEError and httpcode >= 400
294
and httpcode <= 499):
295
# IVLEErrors with 4xx response codes are client errors.
296
# Therefore, these have a "nice" response (we even coat it in the IVLE
299
req.write_html_head_foot = True
300
req.write_javascript_settings = False
301
req.write('<div id="ivle_padding">\n')
303
codename, msg = req.get_http_codename(httpcode)
304
except AttributeError:
305
codename, msg = None, None
306
# Override the default message with the supplied one,
308
if exc_value.message is not None:
309
msg = exc_value.message
310
if codename is not None:
311
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
313
req.write("<h1>Error</h1>\n")
315
req.write("<p>%s</p>\n" % cgi.escape(msg))
317
req.write("<p>An unknown error occured.</p>\n")
320
logging.info(str(msg))
322
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
324
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
325
%cgi.escape(logfile))
326
req.write('</div>\n')
327
html.write_html_foot(req)
329
# A "bad" error message. We shouldn't get here unless IVLE
330
# misbehaves (which is currently very easy, if things aren't set up
332
# Write the traceback.
333
# If this is a non-4xx IVLEError, get the message and httpcode and
334
# make the error message a bit nicer (but still include the
336
# We also need to special-case IVLEJailError, as we can get another
337
# almost-exception out of it.
339
codename, msg = None, None
341
if exc_type is util.IVLEJailError:
342
msg = exc_value.type_str + ": " + exc_value.message
343
tb = 'Exception information extracted from IVLEJailError:\n'
344
tb += urllib.unquote(exc_value.info)
347
codename, msg = req.get_http_codename(httpcode)
348
except AttributeError:
350
# Override the default message with the supplied one,
352
if hasattr(exc_value, 'message') and exc_value.message is not None:
353
msg = exc_value.message
354
# Prepend the exception type
355
if exc_type != util.IVLEError:
356
msg = exc_type.__name__ + ": " + msg
358
tb = ''.join(traceback.format_exception(exc_type, exc_value,
362
logging.error('%s\n%s'%(str(msg), tb))
363
# Error messages are only displayed is the user is NOT a student,
364
# or if there has been a problem logging the error message
365
show_errors = (not publicmode) and ((login and \
366
str(role) != "student") or logfail)
367
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
368
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
369
<html xmlns="http://www.w3.org/1999/xhtml">
370
<head><title>IVLE Internal Server Error</title></head>
372
<h1>IVLE Internal Server Error""")
374
if (codename is not None
375
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
376
req.write(": %s" % cgi.escape(codename))
379
<p>An error has occured which is the fault of the IVLE developers or
380
administration. The developers have been notified.</p>
384
req.write("<p>%s</p>\n" % cgi.escape(msg))
385
if httpcode is not None:
386
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
388
<p>Please report this to <a href="mailto:%s">%s</a> (the system
389
administrator). Include the following information:</p>
390
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
392
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
394
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
395
%cgi.escape(logfile))
396
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
