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