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.groups#Plugin',
58
'ivle.webapp.console#Plugin',
59
'ivle.webapp.security#Plugin',
62
def get_routes_mapper():
64
Build a Mapper object for doing URL matching using 'routes', based on the
67
m = routes.Mapper(explicit=True)
68
for pluginstr in plugins_HACK:
69
plugin_path, classname = pluginstr.split('#')
70
# Load the plugin module from somewhere in the Python path
71
# (Note that plugin_path is a fully-qualified Python module name).
72
plugin = getattr(__import__(plugin_path, fromlist=[classname]),
74
# Establish a URL pattern for each element of plugin.urls
75
for url in plugin.urls:
78
kwargs_dict = url[2] if len(url) >= 3 else {}
79
m.connect(routex, view=view_class, **kwargs_dict)
83
"""Handles a request which may be to anywhere in the site except media.
84
Intended to be called by mod_python, as a handler.
86
req: An Apache request object.
88
# Make the request object into an IVLE request which can be passed to apps
91
req = Request(req, html.write_html_head)
93
# Pass the apachereq to error reporter, since ivle req isn't created
95
handle_unknown_exception(apachereq, *sys.exc_info())
96
# Tell Apache not to generate its own errors as well
97
return mod_python.apache.OK
99
# Run the main handler, and catch all exceptions
101
return handler_(req, apachereq)
102
except mod_python.apache.SERVER_RETURN:
103
# An apache error. We discourage these, but they might still happen.
107
handle_unknown_exception(req, *sys.exc_info())
108
# Tell Apache not to generate its own errors as well
109
return mod_python.apache.OK
111
def handler_(req, apachereq):
113
Nested handler function. May raise exceptions. The top-level handler is
114
just used to catch exceptions.
115
Takes both an IVLE request and an Apache req.
117
# Hack? Try and get the user login early just in case we throw an error
118
# (most likely 404) to stop us seeing not logged in even when we are.
119
if not req.publicmode:
120
req.user = login.get_user_details(req)
122
### BEGIN New plugins framework ###
123
# XXX This should be done ONCE per Python process, not per request.
125
# XXX No authentication is done here
126
req.mapper = get_routes_mapper()
127
matchdict = req.mapper.match(req.uri)
128
if matchdict is not None:
129
viewcls = matchdict['view']
130
# Get the remaining arguments, less 'view', 'action' and 'controller'
131
# (The latter two seem to be built-in, and we don't want them).
132
kwargs = matchdict.copy()
134
# Instantiate the view, which should be a BaseView class
135
view = viewcls(req, **kwargs)
140
### END New plugins framework ###
142
# Check req.app to see if it is valid. 404 if not.
143
if req.app is not None and req.app not in ivle.conf.apps.app_url:
144
req.throw_error(Request.HTTP_NOT_FOUND,
145
"There is no application called %s." % repr(req.app))
147
# Special handling for public mode - only allow the public app, call it
149
# NOTE: This will not behave correctly if the public app uses
150
# write_html_head_foot, but "serve" does not.
152
if req.app != ivle.conf.apps.public_app:
153
req.throw_error(Request.HTTP_FORBIDDEN,
154
"This application is not available on the public site.")
155
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
156
apps.call_app(app.dir, req)
159
# app is the App object for the chosen app
161
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
163
app = ivle.conf.apps.app_url[req.app]
165
# Check if app requires auth. If so, perform authentication and login.
166
# This will either return a User object, None, or perform a redirect
167
# which we will not catch here.
169
req.user = login.login(req)
170
logged_in = req.user is not None
172
req.user = login.get_user_details(req)
176
# Keep the user's session alive by writing to the session object.
177
# req.get_session().save()
178
# Well, it's a fine idea, but it creates considerable grief in the
179
# concurrent update department, so instead, we'll just make the
180
# sessions not time out.
181
req.get_session().unlock()
183
# If user did not specify an app, HTTP redirect to default app and
186
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
188
# Set the default title to the app's tab name, if any. Otherwise URL
190
if app.name is not None:
195
# Call the specified app with the request object
196
apps.call_app(app.dir, req)
198
# if not logged in, login.login will have written the login box.
199
# Just clean up and exit.
201
# MAKE SURE we write the HTTP (and possibly HTML) header. This
202
# wouldn't happen if nothing else ever got written, so we have to make
204
req.ensure_headers_written()
206
# When done, write out the HTML footer if the app has requested it
207
if req.write_html_head_foot:
208
# Show the console if required
209
if logged_in and app.useconsole:
210
plugins.console.present(req, windowpane=True)
211
html.write_html_foot(req)
213
# Note: Apache will not write custom HTML error messages here.
214
# Use req.throw_error to do that.
217
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
219
Given an exception that has just been thrown from IVLE, print its details
221
This is a full handler. It assumes nothing has been written, and writes a
223
req: May be EITHER an IVLE req or an Apache req.
224
IVLE reqs may have the HTML head/foot written (on a 400 error), but
225
the handler code may pass an apache req if an exception occurs before
226
the IVLE request is created.
228
req.content_type = "text/html"
229
logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
231
# For some reason, some versions of mod_python have "_server" instead of
232
# "main_server". So we check for both.
234
admin_email = mod_python.apache.main_server.server_admin
235
except AttributeError:
237
admin_email = mod_python.apache._server.server_admin
238
except AttributeError:
241
httpcode = exc_value.httpcode
242
req.status = httpcode
243
except AttributeError:
245
req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
247
publicmode = req.publicmode
248
except AttributeError:
251
login = req.user.login
252
except AttributeError:
256
except AttributeError:
261
for h in logging.getLogger().handlers:
262
logging.getLogger().removeHandler(h)
263
logging.basicConfig(level=logging.INFO,
264
format='%(asctime)s %(levelname)s: ' +
265
'(HTTP: ' + str(req.status) +
266
', Ref: ' + str(login) + '@' +
267
str(socket.gethostname()) + str(req.uri) +
273
logging.debug('Logging Unhandled Exception')
275
# We handle 3 types of error.
276
# IVLEErrors with 4xx response codes (client error).
277
# IVLEErrors with 5xx response codes (handled server error).
278
# Other exceptions (unhandled server error).
279
# IVLEErrors should not have other response codes than 4xx or 5xx
280
# (eg. throw_redirect should have been used for 3xx codes).
281
# Therefore, that is treated as an unhandled error.
283
if (exc_type == util.IVLEError and httpcode >= 400
284
and httpcode <= 499):
285
# IVLEErrors with 4xx response codes are client errors.
286
# Therefore, these have a "nice" response (we even coat it in the IVLE
289
req.write_html_head_foot = True
290
req.write_javascript_settings = False
291
req.write('<div id="ivle_padding">\n')
293
codename, msg = req.get_http_codename(httpcode)
294
except AttributeError:
295
codename, msg = None, None
296
# Override the default message with the supplied one,
298
if exc_value.message is not None:
299
msg = exc_value.message
300
if codename is not None:
301
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
303
req.write("<h1>Error</h1>\n")
305
req.write("<p>%s</p>\n" % cgi.escape(msg))
307
req.write("<p>An unknown error occured.</p>\n")
310
logging.info(str(msg))
312
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
314
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
315
%cgi.escape(logfile))
316
req.write('</div>\n')
317
html.write_html_foot(req)
319
# A "bad" error message. We shouldn't get here unless IVLE
320
# misbehaves (which is currently very easy, if things aren't set up
322
# Write the traceback.
323
# If this is a non-4xx IVLEError, get the message and httpcode and
324
# make the error message a bit nicer (but still include the
326
# We also need to special-case IVLEJailError, as we can get another
327
# almost-exception out of it.
329
codename, msg = None, None
331
if exc_type is util.IVLEJailError:
332
msg = exc_value.type_str + ": " + exc_value.message
333
tb = 'Exception information extracted from IVLEJailError:\n'
334
tb += urllib.unquote(exc_value.info)
337
codename, msg = req.get_http_codename(httpcode)
338
except AttributeError:
340
# Override the default message with the supplied one,
342
if hasattr(exc_value, 'message') and exc_value.message is not None:
343
msg = exc_value.message
344
# Prepend the exception type
345
if exc_type != util.IVLEError:
346
msg = exc_type.__name__ + ": " + msg
348
tb = ''.join(traceback.format_exception(exc_type, exc_value,
352
logging.error('%s\n%s'%(str(msg), tb))
353
# Error messages are only displayed is the user is NOT a student,
354
# or if there has been a problem logging the error message
355
show_errors = (not publicmode) and ((login and \
356
str(role) != "student") or logfail)
357
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
358
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
359
<html xmlns="http://www.w3.org/1999/xhtml">
360
<head><title>IVLE Internal Server Error</title></head>
362
<h1>IVLE Internal Server Error""")
364
if (codename is not None
365
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
366
req.write(": %s" % cgi.escape(codename))
369
<p>An error has occured which is the fault of the IVLE developers or
370
administration. The developers have been notified.</p>
374
req.write("<p>%s</p>\n" % cgi.escape(msg))
375
if httpcode is not None:
376
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
378
<p>Please report this to <a href="mailto:%s">%s</a> (the system
379
administrator). Include the following information:</p>
380
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
382
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
384
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
385
%cgi.escape(logfile))
386
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
