2
# Copyright (C) 2007-2008 The University of Melbourne
1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22
# This is a mod_python handler program. The correct way to call it is to have
23
# Apache send all requests to be handled by the module 'dispatch'.
25
# Top-level handler. Handles all requests to all pages in IVLE.
26
# Handles authentication (not authorization).
27
# Then passes the request along to the appropriate ivle app.
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.
40
from mod_python import apache, Cookie
42
42
from ivle import util
44
44
import ivle.conf.apps
45
from ivle.dispatch.request import Request
46
from ivle.dispatch import login
48
from request import Request
49
49
import plugins.console # XXX: Relies on www/ being in the Python path.
51
# List of cookies that IVLE uses (to be removed at logout)
52
ivle_cookies = ["ivleforumcookie", "clipboard"]
51
# XXX List of plugins, which will eventually be read in from conf
53
'ivle.webapp.admin.user#Plugin',
54
'ivle.webapp.browser#Plugin',
55
'ivle.webapp.groups#Plugin',
56
'ivle.webapp.tutorial#Plugin',
59
def get_routes_mapper():
61
Build a Mapper object for doing URL matching using 'routes', based on the
64
m = routes.Mapper(explicit=True)
65
for pluginstr in plugins_HACK:
66
plugin_path, classname = pluginstr.split('#')
67
# Load the plugin module from somewhere in the Python path
68
# (Note that plugin_path is a fully-qualified Python module name).
69
plugin = getattr(__import__(plugin_path, fromlist=[classname]),
71
# Establish a URL pattern for each element of plugin.urls
72
for url in plugin.urls:
75
kwargs_dict = url[2] if len(url) >= 3 else {}
76
m.connect(routex, view=view_class, **kwargs_dict)
55
80
"""Handles a request which may be to anywhere in the site except media.
67
92
handle_unknown_exception(apachereq, *sys.exc_info())
68
93
# Tell Apache not to generate its own errors as well
94
return mod_python.apache.OK
71
96
# Run the main handler, and catch all exceptions
79
104
handle_unknown_exception(req, *sys.exc_info())
80
105
# Tell Apache not to generate its own errors as well
106
return mod_python.apache.OK
83
108
def handler_(req, apachereq):
91
116
if not req.publicmode:
92
117
req.user = login.get_user_details(req)
119
### BEGIN New plugins framework ###
120
# XXX This should be done ONCE per Python process, not per request.
122
# XXX No authentication is done here
123
req.mapper = get_routes_mapper()
124
matchdict = req.mapper.match(req.uri)
125
if matchdict is not None:
126
viewcls = matchdict['view']
127
# Get the remaining arguments, less 'view', 'action' and 'controller'
128
# (The latter two seem to be built-in, and we don't want them).
129
kwargs = matchdict.copy()
131
# Instantiate the view, which should be a BaseView class
132
view = viewcls(req, **kwargs)
137
### END New plugins framework ###
94
139
# Check req.app to see if it is valid. 404 if not.
95
140
if req.app is not None and req.app not in ivle.conf.apps.app_url:
96
# Maybe it is a special app!
97
if req.app == 'logout':
100
req.throw_error(Request.HTTP_NOT_FOUND,
101
"There is no application called %s." % repr(req.app))
141
req.throw_error(Request.HTTP_NOT_FOUND,
142
"There is no application called %s." % repr(req.app))
103
144
# Special handling for public mode - only allow the public app, call it
170
211
# Use req.throw_error to do that.
174
"""Log out the current user (if any) by destroying the session state.
175
Then redirect to the top-level IVLE page."""
176
session = req.get_session()
179
# Invalidates all IVLE cookies
180
all_cookies = Cookie.get_cookies(req)
181
for cookie in all_cookies:
182
if cookie in ivle_cookies:
183
req.add_cookie(Cookie.Cookie(cookie,'',expires=1,path='/'))
184
req.throw_redirect(util.make_path(''))
186
214
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
188
216
Given an exception that has just been thrown from IVLE, print its details
200
228
# For some reason, some versions of mod_python have "_server" instead of
201
229
# "main_server". So we check for both.
203
admin_email = apache.main_server.server_admin
231
admin_email = mod_python.apache.main_server.server_admin
204
232
except AttributeError:
206
admin_email = apache._server.server_admin
234
admin_email = mod_python.apache._server.server_admin
207
235
except AttributeError:
313
349
logging.error('%s\n%s'%(str(msg), tb))
350
# Error messages are only displayed is the user is NOT a student,
351
# or if there has been a problem logging the error message
352
show_errors = (not publicmode) and ((login and \
353
str(role) != "student") or logfail)
315
354
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
316
355
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
317
356
<html xmlns="http://www.w3.org/1999/xhtml">
318
357
<head><title>IVLE Internal Server Error</title></head>
320
359
<h1>IVLE Internal Server Error""")
321
if (codename is not None
322
and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
323
req.write(": %s" % cgi.escape(codename))
361
if (codename is not None
362
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
363
req.write(": %s" % cgi.escape(codename))
324
365
req.write("""</h1>
325
366
<p>An error has occured which is the fault of the IVLE developers or
367
administration. The developers have been notified.</p>
329
req.write("<p>%s</p>\n" % cgi.escape(msg))
330
if httpcode is not None:
331
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
333
<p>Please report this to <a href="mailto:%s">%s</a> (the system
334
administrator). Include the following information:</p>
335
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
371
req.write("<p>%s</p>\n" % cgi.escape(msg))
372
if httpcode is not None:
373
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
375
<p>Please report this to <a href="mailto:%s">%s</a> (the system
376
administrator). Include the following information:</p>
377
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
337
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
339
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
340
%cgi.escape(logfile))
379
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
381
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
382
%cgi.escape(logfile))
341
383
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
