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
52
# Elements are (module, classname) pairs.
54
('ivle.webapp.admin.user', 'Plugin'),
57
def get_routes_mapper():
59
Build a Mapper object for doing URL matching using 'routes', based on the
63
for plugin_path, classname in plugins_HACK:
64
# Load the plugin module from somewhere in the Python path
65
# (Note that plugin_path is a fully-qualified Python module name).
66
plugin = getattr(__import__(plugin_path, fromlist=[classname]),
68
# Establish a URL pattern for each element of plugin.urls
69
for url in plugin.urls:
72
kwargs_dict = url[2] if len(url) >= 3 else {}
73
m.connect(routex, view=view_class, **kwargs_dict)
77
"""Handles a request which may be to anywhere in the site except media.
78
Intended to be called by mod_python, as a handler.
80
req: An Apache request object.
82
# Make the request object into an IVLE request which can be passed to apps
85
req = Request(req, html.write_html_head)
87
# Pass the apachereq to error reporter, since ivle req isn't created
89
handle_unknown_exception(apachereq, *sys.exc_info())
90
# Tell Apache not to generate its own errors as well
91
return mod_python.apache.OK
93
# Run the main handler, and catch all exceptions
95
return handler_(req, apachereq)
96
except mod_python.apache.SERVER_RETURN:
97
# An apache error. We discourage these, but they might still happen.
101
handle_unknown_exception(req, *sys.exc_info())
102
# Tell Apache not to generate its own errors as well
103
return mod_python.apache.OK
105
def handler_(req, apachereq):
107
Nested handler function. May raise exceptions. The top-level handler is
108
just used to catch exceptions.
109
Takes both an IVLE request and an Apache req.
111
# Hack? Try and get the user login early just in case we throw an error
112
# (most likely 404) to stop us seeing not logged in even when we are.
113
if not req.publicmode:
114
req.user = login.get_user_details(req)
116
### BEGIN New plugins framework ###
117
# XXX This should be done ONCE per Python process, not per request.
119
# XXX No authentication is done here
120
mapper = get_routes_mapper()
121
matchdict = mapper.match(req.uri)
122
if matchdict is not None:
123
viewcls = matchdict['view']
124
# Get the remaining arguments, less 'view', 'action' and 'controller'
125
# (The latter two seem to be built-in, and we don't want them).
126
kwargs = matchdict.copy()
129
del kwargs['controller']
130
# Instantiate the view, which should be a BaseView class
131
view = viewcls(req, **kwargs)
136
### END New plugins framework ###
138
# Check req.app to see if it is valid. 404 if not.
139
if req.app is not None and req.app not in ivle.conf.apps.app_url:
140
req.throw_error(Request.HTTP_NOT_FOUND,
141
"There is no application called %s." % repr(req.app))
143
# Special handling for public mode - only allow the public app, call it
145
# NOTE: This will not behave correctly if the public app uses
146
# write_html_head_foot, but "serve" does not.
148
if req.app != ivle.conf.apps.public_app:
149
req.throw_error(Request.HTTP_FORBIDDEN,
150
"This application is not available on the public site.")
151
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
152
apps.call_app(app.dir, req)
155
# app is the App object for the chosen app
157
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
159
app = ivle.conf.apps.app_url[req.app]
161
# Check if app requires auth. If so, perform authentication and login.
162
# This will either return a User object, None, or perform a redirect
163
# which we will not catch here.
165
req.user = login.login(req)
166
logged_in = req.user is not None
168
req.user = login.get_user_details(req)
172
# Keep the user's session alive by writing to the session object.
173
# req.get_session().save()
174
# Well, it's a fine idea, but it creates considerable grief in the
175
# concurrent update department, so instead, we'll just make the
176
# sessions not time out.
177
req.get_session().unlock()
179
# If user did not specify an app, HTTP redirect to default app and
182
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
184
# Set the default title to the app's tab name, if any. Otherwise URL
186
if app.name is not None:
191
# Call the specified app with the request object
192
apps.call_app(app.dir, req)
194
# if not logged in, login.login will have written the login box.
195
# Just clean up and exit.
197
# MAKE SURE we write the HTTP (and possibly HTML) header. This
198
# wouldn't happen if nothing else ever got written, so we have to make
200
req.ensure_headers_written()
202
# When done, write out the HTML footer if the app has requested it
203
if req.write_html_head_foot:
204
# Show the console if required
205
if logged_in and app.useconsole:
206
plugins.console.present(req, windowpane=True)
207
html.write_html_foot(req)
209
# Note: Apache will not write custom HTML error messages here.
210
# Use req.throw_error to do that.
213
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
215
Given an exception that has just been thrown from IVLE, print its details
217
This is a full handler. It assumes nothing has been written, and writes a
219
req: May be EITHER an IVLE req or an Apache req.
220
IVLE reqs may have the HTML head/foot written (on a 400 error), but
221
the handler code may pass an apache req if an exception occurs before
222
the IVLE request is created.
224
req.content_type = "text/html"
225
logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
227
# For some reason, some versions of mod_python have "_server" instead of
228
# "main_server". So we check for both.
230
admin_email = mod_python.apache.main_server.server_admin
231
except AttributeError:
233
admin_email = mod_python.apache._server.server_admin
234
except AttributeError:
237
httpcode = exc_value.httpcode
238
req.status = httpcode
239
except AttributeError:
241
req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
243
publicmode = req.publicmode
244
except AttributeError:
247
login = req.user.login
248
except AttributeError:
252
except AttributeError:
257
for h in logging.getLogger().handlers:
258
logging.getLogger().removeHandler(h)
259
logging.basicConfig(level=logging.INFO,
260
format='%(asctime)s %(levelname)s: ' +
261
'(HTTP: ' + str(req.status) +
262
', Ref: ' + str(login) + '@' +
263
str(socket.gethostname()) + str(req.uri) +
269
logging.debug('Logging Unhandled Exception')
271
# We handle 3 types of error.
272
# IVLEErrors with 4xx response codes (client error).
273
# IVLEErrors with 5xx response codes (handled server error).
274
# Other exceptions (unhandled server error).
275
# IVLEErrors should not have other response codes than 4xx or 5xx
276
# (eg. throw_redirect should have been used for 3xx codes).
277
# Therefore, that is treated as an unhandled error.
279
if (exc_type == util.IVLEError and httpcode >= 400
280
and httpcode <= 499):
281
# IVLEErrors with 4xx response codes are client errors.
282
# Therefore, these have a "nice" response (we even coat it in the IVLE
285
req.write_html_head_foot = True
286
req.write_javascript_settings = False
287
req.write('<div id="ivle_padding">\n')
289
codename, msg = req.get_http_codename(httpcode)
290
except AttributeError:
291
codename, msg = None, None
292
# Override the default message with the supplied one,
294
if exc_value.message is not None:
295
msg = exc_value.message
296
if codename is not None:
297
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
299
req.write("<h1>Error</h1>\n")
301
req.write("<p>%s</p>\n" % cgi.escape(msg))
303
req.write("<p>An unknown error occured.</p>\n")
306
logging.info(str(msg))
308
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
310
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
311
%cgi.escape(logfile))
312
req.write('</div>\n')
313
html.write_html_foot(req)
315
# A "bad" error message. We shouldn't get here unless IVLE
316
# misbehaves (which is currently very easy, if things aren't set up
318
# Write the traceback.
319
# If this is a non-4xx IVLEError, get the message and httpcode and
320
# make the error message a bit nicer (but still include the
322
# We also need to special-case IVLEJailError, as we can get another
323
# almost-exception out of it.
325
codename, msg = None, None
327
if exc_type is util.IVLEJailError:
328
msg = exc_value.type_str + ": " + exc_value.message
329
tb = 'Exception information extracted from IVLEJailError:\n'
330
tb += urllib.unquote(exc_value.info)
333
codename, msg = req.get_http_codename(httpcode)
334
except AttributeError:
336
# Override the default message with the supplied one,
338
if hasattr(exc_value, 'message') and exc_value.message is not None:
339
msg = exc_value.message
340
# Prepend the exception type
341
if exc_type != util.IVLEError:
342
msg = exc_type.__name__ + ": " + msg
344
tb = ''.join(traceback.format_exception(exc_type, exc_value,
348
logging.error('%s\n%s'%(str(msg), tb))
349
# Error messages are only displayed is the user is NOT a student,
350
# or if there has been a problem logging the error message
351
show_errors = (not publicmode) and ((login and \
352
str(role) != "student") or logfail)
353
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
354
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
355
<html xmlns="http://www.w3.org/1999/xhtml">
356
<head><title>IVLE Internal Server Error</title></head>
358
<h1>IVLE Internal Server Error""")
360
if (codename is not None
361
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
362
req.write(": %s" % cgi.escape(codename))
365
<p>An error has occured which is the fault of the IVLE developers or
366
administration. The developers have been notified.</p>
370
req.write("<p>%s</p>\n" % cgi.escape(msg))
371
if httpcode is not None:
372
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
374
<p>Please report this to <a href="mailto:%s">%s</a> (the system
375
administrator). Include the following information:</p>
376
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
378
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
380
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
381
%cgi.escape(logfile))
382
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
