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.browser#Plugin',
57
'ivle.webapp.groups#Plugin',
58
'ivle.webapp.console#Plugin',
61
def get_routes_mapper():
63
Build a Mapper object for doing URL matching using 'routes', based on the
66
m = routes.Mapper(explicit=True)
67
for pluginstr in plugins_HACK:
68
plugin_path, classname = pluginstr.split('#')
69
# Load the plugin module from somewhere in the Python path
70
# (Note that plugin_path is a fully-qualified Python module name).
71
plugin = getattr(__import__(plugin_path, fromlist=[classname]),
73
# Establish a URL pattern for each element of plugin.urls
74
for url in plugin.urls:
77
kwargs_dict = url[2] if len(url) >= 3 else {}
78
m.connect(routex, view=view_class, **kwargs_dict)
82
"""Handles a request which may be to anywhere in the site except media.
83
Intended to be called by mod_python, as a handler.
85
req: An Apache request object.
87
# Make the request object into an IVLE request which can be passed to apps
90
req = Request(req, html.write_html_head)
92
# Pass the apachereq to error reporter, since ivle req isn't created
94
handle_unknown_exception(apachereq, *sys.exc_info())
95
# Tell Apache not to generate its own errors as well
96
return mod_python.apache.OK
98
# Run the main handler, and catch all exceptions
100
return handler_(req, apachereq)
101
except mod_python.apache.SERVER_RETURN:
102
# An apache error. We discourage these, but they might still happen.
106
handle_unknown_exception(req, *sys.exc_info())
107
# Tell Apache not to generate its own errors as well
108
return mod_python.apache.OK
110
def handler_(req, apachereq):
112
Nested handler function. May raise exceptions. The top-level handler is
113
just used to catch exceptions.
114
Takes both an IVLE request and an Apache req.
116
# Hack? Try and get the user login early just in case we throw an error
117
# (most likely 404) to stop us seeing not logged in even when we are.
118
if not req.publicmode:
119
req.user = login.get_user_details(req)
121
### BEGIN New plugins framework ###
122
# XXX This should be done ONCE per Python process, not per request.
124
# XXX No authentication is done here
125
req.mapper = get_routes_mapper()
126
matchdict = req.mapper.match(req.uri)
127
if matchdict is not None:
128
viewcls = matchdict['view']
129
# Get the remaining arguments, less 'view', 'action' and 'controller'
130
# (The latter two seem to be built-in, and we don't want them).
131
kwargs = matchdict.copy()
133
# Instantiate the view, which should be a BaseView class
134
view = viewcls(req, **kwargs)
139
### END New plugins framework ###
141
# Check req.app to see if it is valid. 404 if not.
142
if req.app is not None and req.app not in ivle.conf.apps.app_url:
143
req.throw_error(Request.HTTP_NOT_FOUND,
144
"There is no application called %s." % repr(req.app))
146
# Special handling for public mode - only allow the public app, call it
148
# NOTE: This will not behave correctly if the public app uses
149
# write_html_head_foot, but "serve" does not.
151
if req.app != ivle.conf.apps.public_app:
152
req.throw_error(Request.HTTP_FORBIDDEN,
153
"This application is not available on the public site.")
154
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
155
apps.call_app(app.dir, req)
158
# app is the App object for the chosen app
160
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
162
app = ivle.conf.apps.app_url[req.app]
164
# Check if app requires auth. If so, perform authentication and login.
165
# This will either return a User object, None, or perform a redirect
166
# which we will not catch here.
168
req.user = login.login(req)
169
logged_in = req.user is not None
171
req.user = login.get_user_details(req)
175
# Keep the user's session alive by writing to the session object.
176
# req.get_session().save()
177
# Well, it's a fine idea, but it creates considerable grief in the
178
# concurrent update department, so instead, we'll just make the
179
# sessions not time out.
180
req.get_session().unlock()
182
# If user did not specify an app, HTTP redirect to default app and
185
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
187
# Set the default title to the app's tab name, if any. Otherwise URL
189
if app.name is not None:
194
# Call the specified app with the request object
195
apps.call_app(app.dir, req)
197
# if not logged in, login.login will have written the login box.
198
# Just clean up and exit.
200
# MAKE SURE we write the HTTP (and possibly HTML) header. This
201
# wouldn't happen if nothing else ever got written, so we have to make
203
req.ensure_headers_written()
205
# When done, write out the HTML footer if the app has requested it
206
if req.write_html_head_foot:
207
# Show the console if required
208
if logged_in and app.useconsole:
209
plugins.console.present(req, windowpane=True)
210
html.write_html_foot(req)
212
# Note: Apache will not write custom HTML error messages here.
213
# Use req.throw_error to do that.
216
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
218
Given an exception that has just been thrown from IVLE, print its details
220
This is a full handler. It assumes nothing has been written, and writes a
222
req: May be EITHER an IVLE req or an Apache req.
223
IVLE reqs may have the HTML head/foot written (on a 400 error), but
224
the handler code may pass an apache req if an exception occurs before
225
the IVLE request is created.
227
req.content_type = "text/html"
228
logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
230
# For some reason, some versions of mod_python have "_server" instead of
231
# "main_server". So we check for both.
233
admin_email = mod_python.apache.main_server.server_admin
234
except AttributeError:
236
admin_email = mod_python.apache._server.server_admin
237
except AttributeError:
240
httpcode = exc_value.httpcode
241
req.status = httpcode
242
except AttributeError:
244
req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
246
publicmode = req.publicmode
247
except AttributeError:
250
login = req.user.login
251
except AttributeError:
255
except AttributeError:
260
for h in logging.getLogger().handlers:
261
logging.getLogger().removeHandler(h)
262
logging.basicConfig(level=logging.INFO,
263
format='%(asctime)s %(levelname)s: ' +
264
'(HTTP: ' + str(req.status) +
265
', Ref: ' + str(login) + '@' +
266
str(socket.gethostname()) + str(req.uri) +
272
logging.debug('Logging Unhandled Exception')
274
# We handle 3 types of error.
275
# IVLEErrors with 4xx response codes (client error).
276
# IVLEErrors with 5xx response codes (handled server error).
277
# Other exceptions (unhandled server error).
278
# IVLEErrors should not have other response codes than 4xx or 5xx
279
# (eg. throw_redirect should have been used for 3xx codes).
280
# Therefore, that is treated as an unhandled error.
282
if (exc_type == util.IVLEError and httpcode >= 400
283
and httpcode <= 499):
284
# IVLEErrors with 4xx response codes are client errors.
285
# Therefore, these have a "nice" response (we even coat it in the IVLE
288
req.write_html_head_foot = True
289
req.write_javascript_settings = False
290
req.write('<div id="ivle_padding">\n')
292
codename, msg = req.get_http_codename(httpcode)
293
except AttributeError:
294
codename, msg = None, None
295
# Override the default message with the supplied one,
297
if exc_value.message is not None:
298
msg = exc_value.message
299
if codename is not None:
300
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
302
req.write("<h1>Error</h1>\n")
304
req.write("<p>%s</p>\n" % cgi.escape(msg))
306
req.write("<p>An unknown error occured.</p>\n")
309
logging.info(str(msg))
311
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
313
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
314
%cgi.escape(logfile))
315
req.write('</div>\n')
316
html.write_html_foot(req)
318
# A "bad" error message. We shouldn't get here unless IVLE
319
# misbehaves (which is currently very easy, if things aren't set up
321
# Write the traceback.
322
# If this is a non-4xx IVLEError, get the message and httpcode and
323
# make the error message a bit nicer (but still include the
325
# We also need to special-case IVLEJailError, as we can get another
326
# almost-exception out of it.
328
codename, msg = None, None
330
if exc_type is util.IVLEJailError:
331
msg = exc_value.type_str + ": " + exc_value.message
332
tb = 'Exception information extracted from IVLEJailError:\n'
333
tb += urllib.unquote(exc_value.info)
336
codename, msg = req.get_http_codename(httpcode)
337
except AttributeError:
339
# Override the default message with the supplied one,
341
if hasattr(exc_value, 'message') and exc_value.message is not None:
342
msg = exc_value.message
343
# Prepend the exception type
344
if exc_type != util.IVLEError:
345
msg = exc_type.__name__ + ": " + msg
347
tb = ''.join(traceback.format_exception(exc_type, exc_value,
351
logging.error('%s\n%s'%(str(msg), tb))
352
# Error messages are only displayed is the user is NOT a student,
353
# or if there has been a problem logging the error message
354
show_errors = (not publicmode) and ((login and \
355
str(role) != "student") or logfail)
356
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
357
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
358
<html xmlns="http://www.w3.org/1999/xhtml">
359
<head><title>IVLE Internal Server Error</title></head>
361
<h1>IVLE Internal Server Error""")
363
if (codename is not None
364
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
365
req.write(": %s" % cgi.escape(codename))
368
<p>An error has occured which is the fault of the IVLE developers or
369
administration. The developers have been notified.</p>
373
req.write("<p>%s</p>\n" % cgi.escape(msg))
374
if httpcode is not None:
375
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
377
<p>Please report this to <a href="mailto:%s">%s</a> (the system
378
administrator). Include the following information:</p>
379
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
381
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
383
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
384
%cgi.escape(logfile))
385
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
