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
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.
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.
40
from mod_python import apache, Cookie
43
42
from ivle import util
45
44
import ivle.conf.apps
46
from ivle.dispatch.request import Request
47
from ivle.dispatch import login
48
from ivle.webapp.base.plugins import ViewPlugin, ErrorPlugin
49
from ivle.webapp.errors import HTTPError
53
# XXX List of plugins, which will eventually be read in from conf
55
'ivle.webapp.core#Plugin',
56
'ivle.webapp.base#Plugin',
57
'ivle.webapp.admin.user#Plugin',
58
'ivle.webapp.tutorial#Plugin',
59
'ivle.webapp.admin.subject#Plugin',
60
'ivle.webapp.filesystem.browser#Plugin',
61
'ivle.webapp.filesystem.diff#Plugin',
62
'ivle.webapp.filesystem.svnlog#Plugin',
63
'ivle.webapp.groups#Plugin',
64
'ivle.webapp.console#Plugin',
65
'ivle.webapp.security#Plugin',
66
'ivle.webapp.media#Plugin',
67
'ivle.webapp.forum#Plugin',
70
def generate_route_mapper(view_plugins):
72
Build a Mapper object for doing URL matching using 'routes', based on the
73
given plugin registry.
75
m = routes.Mapper(explicit=True)
76
for plugin in view_plugins:
77
# Establish a URL pattern for each element of plugin.urls
78
assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin
79
for url in plugin.urls:
82
kwargs_dict = url[2] if len(url) >= 3 else {}
83
m.connect(routex, view=view_class, **kwargs_dict)
86
def get_plugin(pluginstr):
87
plugin_path, classname = pluginstr.split('#')
88
# Load the plugin module from somewhere in the Python path
89
# (Note that plugin_path is a fully-qualified Python module name).
91
getattr(__import__(plugin_path, fromlist=[classname]), classname))
93
def get_error_view(req, viewcls):
94
if ErrorPlugin not in req.plugin_index:
97
error_plugins = req.plugin_index[ErrorPlugin]
101
for plugin in error_plugins:
102
for src in plugin.error_views:
103
view_map[src] = plugin.error_views[src]
105
for cls in inspect.getmro(viewcls):
48
from request import Request
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"]
110
55
"""Handles a request which may be to anywhere in the site except media.
146
91
if not req.publicmode:
147
92
req.user = login.get_user_details(req)
149
### BEGIN New plugins framework ###
150
# XXX This should be done ONCE per Python process, not per request.
152
# XXX No authentication is done here
153
req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
154
# Index the plugins by base class
155
req.plugin_index = {}
156
for plugin in req.plugins.values():
157
# Getmro returns a tuple of all the super-classes of the plugin
158
for base in inspect.getmro(plugin):
159
if base not in req.plugin_index:
160
req.plugin_index[base] = []
161
req.plugin_index[base].append(plugin)
162
req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
163
req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
165
matchdict = req.mapper.match(req.uri)
166
if matchdict is not None:
167
viewcls = matchdict['view']
168
# Get the remaining arguments, less 'view', 'action' and 'controller'
169
# (The latter two seem to be built-in, and we don't want them).
170
kwargs = matchdict.copy()
173
# Instantiate the view, which should be a BaseView class
174
view = viewcls(req, **kwargs)
178
# A view explicitly raised an HTTP error. Respect it.
181
# Try to find a custom error view.
182
errviewcls = get_error_view(req, viewcls)
184
errview = errviewcls(req, e)
191
# A non-HTTPError appeared. We have an unknown exception. Panic.
192
handle_unknown_exception(req, *sys.exc_info())
197
### END New plugins framework ###
199
94
# Check req.app to see if it is valid. 404 if not.
200
95
if req.app is not None and req.app not in ivle.conf.apps.app_url:
201
req.throw_error(Request.HTTP_NOT_FOUND,
202
"There is no application called %s." % repr(req.app))
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))
204
103
# Special handling for public mode - only allow the public app, call it
263
162
# When done, write out the HTML footer if the app has requested it
264
163
if req.write_html_head_foot:
164
# Show the console if required
165
if logged_in and app.useconsole:
166
plugins.console.present(req, windowpane=True)
265
167
html.write_html_foot(req)
267
169
# Note: Apache will not write custom HTML error messages here.
268
170
# 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(''))
271
186
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
273
188
Given an exception that has just been thrown from IVLE, print its details
406
313
logging.error('%s\n%s'%(str(msg), tb))
407
# Error messages are only displayed is the user is NOT a student,
408
# or if there has been a problem logging the error message
409
show_errors = (not publicmode) and ((login and \
410
str(role) != "student") or logfail)
411
315
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
412
316
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
413
317
<html xmlns="http://www.w3.org/1999/xhtml">
414
318
<head><title>IVLE Internal Server Error</title></head>
416
320
<h1>IVLE Internal Server Error""")
418
if (codename is not None
419
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
420
req.write(": %s" % cgi.escape(codename))
321
if (codename is not None
322
and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
323
req.write(": %s" % cgi.escape(codename))
422
324
req.write("""</h1>
423
325
<p>An error has occured which is the fault of the IVLE developers or
424
administration. The developers have been notified.</p>
428
req.write("<p>%s</p>\n" % cgi.escape(msg))
429
if httpcode is not None:
430
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
432
<p>Please report this to <a href="mailto:%s">%s</a> (the system
433
administrator). Include the following information:</p>
434
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
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)))
436
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
438
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
439
%cgi.escape(logfile))
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))
440
341
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
