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
43
from ivle import util
44
45
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
49
from ivle.webapp.errors import HTTPError
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"]
53
# XXX List of plugins, which will eventually be read in from conf
55
'ivle.webapp.core#Plugin',
56
'ivle.webapp.admin.user#Plugin',
57
'ivle.webapp.tutorial#Plugin',
58
'ivle.webapp.admin.subject#Plugin',
59
'ivle.webapp.filesystem.browser#Plugin',
60
'ivle.webapp.filesystem.diff#Plugin',
61
'ivle.webapp.filesystem.svnlog#Plugin',
62
'ivle.webapp.groups#Plugin',
63
'ivle.webapp.console#Plugin',
64
'ivle.webapp.security#Plugin',
65
'ivle.webapp.media#Plugin',
66
'ivle.webapp.forum#Plugin',
67
'ivle.webapp.help#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))
55
94
"""Handles a request which may be to anywhere in the site except media.
91
130
if not req.publicmode:
92
131
req.user = login.get_user_details(req)
133
### BEGIN New plugins framework ###
134
# XXX This should be done ONCE per Python process, not per request.
136
# XXX No authentication is done here
137
req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
138
# Index the plugins by base class
139
req.plugin_index = {}
140
for plugin in req.plugins.values():
141
# Getmro returns a tuple of all the super-classes of the plugin
142
for base in inspect.getmro(plugin):
143
if base not in req.plugin_index:
144
req.plugin_index[base] = []
145
req.plugin_index[base].append(plugin)
146
req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
147
req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
149
matchdict = req.mapper.match(req.uri)
150
if matchdict is not None:
151
viewcls = matchdict['view']
152
# Get the remaining arguments, less 'view', 'action' and 'controller'
153
# (The latter two seem to be built-in, and we don't want them).
154
kwargs = matchdict.copy()
157
# Instantiate the view, which should be a BaseView class
158
view = viewcls(req, **kwargs)
162
# A view explicitly raised an HTTP error. Respect it.
165
# Try to find a custom error view.
166
if hasattr(viewcls, 'get_error_view'):
167
errviewcls = viewcls.get_error_view(e)
172
errview = errviewcls(req, e)
179
# A non-HTTPError appeared. We have an unknown exception. Panic.
180
handle_unknown_exception(req, *sys.exc_info())
185
### END New plugins framework ###
94
187
# Check req.app to see if it is valid. 404 if not.
95
188
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))
189
req.throw_error(Request.HTTP_NOT_FOUND,
190
"There is no application called %s." % repr(req.app))
103
192
# Special handling for public mode - only allow the public app, call it
162
251
# When done, write out the HTML footer if the app has requested it
163
252
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)
167
253
html.write_html_foot(req)
169
255
# Note: Apache will not write custom HTML error messages here.
170
256
# 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
259
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
188
261
Given an exception that has just been thrown from IVLE, print its details
200
273
# For some reason, some versions of mod_python have "_server" instead of
201
274
# "main_server". So we check for both.
203
admin_email = apache.main_server.server_admin
276
admin_email = mod_python.apache.main_server.server_admin
204
277
except AttributeError:
206
admin_email = apache._server.server_admin
279
admin_email = mod_python.apache._server.server_admin
207
280
except AttributeError:
313
394
logging.error('%s\n%s'%(str(msg), tb))
395
# Error messages are only displayed is the user is NOT a student,
396
# or if there has been a problem logging the error message
397
show_errors = (not publicmode) and ((login and \
398
str(role) != "student") or logfail)
315
399
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
316
400
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
317
401
<html xmlns="http://www.w3.org/1999/xhtml">
318
402
<head><title>IVLE Internal Server Error</title></head>
320
404
<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))
406
if (codename is not None
407
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
408
req.write(": %s" % cgi.escape(codename))
324
410
req.write("""</h1>
325
411
<p>An error has occured which is the fault of the IVLE developers or
412
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)))
416
req.write("<p>%s</p>\n" % cgi.escape(msg))
417
if httpcode is not None:
418
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
420
<p>Please report this to <a href="mailto:%s">%s</a> (the system
421
administrator). Include the following information:</p>
422
""" % (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))
424
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
426
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
427
%cgi.escape(logfile))
341
428
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
