22
22
Apache send all requests to be handled by the module 'dispatch'.
24
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.
25
Handles authentication and delegates to views for authorization,
26
then passes the request along to the appropriate view.
43
42
from ivle import util
46
44
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
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):
45
import ivle.webapp.security
46
from ivle.webapp.base.plugins import ViewPlugin, PublicViewPlugin
47
from ivle.webapp.base.xhtml import XHTMLView, XHTMLErrorView
48
from ivle.webapp.errors import BadRequest, HTTPError, NotFound, Unauthorized
49
from ivle.webapp.publisher import Publisher, PublishingError
50
from ivle.webapp import ApplicationRoot
52
config = ivle.config.Config()
54
class ObjectPermissionCheckingPublisher(Publisher):
55
"""A specialised publisher that checks object permissions.
57
This publisher verifies that the user holds any permission at all
58
on the model objects through which the resolution path passes. If
59
no permission is held, resolution is aborted with an Unauthorized
62
IMPORTANT: This does NOT check view permissions. It only checks
63
the objects in between the root and the view, exclusive!
66
def traversed_to_object(self, obj):
67
"""Check that the user has any permission at all over the object."""
68
if (hasattr(obj, 'get_permissions') and
69
len(obj.get_permissions(self.root.user, config)) == 0):
70
# Indicate the forbidden object if this is an admin.
71
if self.root.user and self.root.user.admin:
72
raise Unauthorized('Unauthorized: %s' % obj)
77
def generate_publisher(view_plugins, root, publicmode=False):
72
79
Build a Mapper object for doing URL matching using 'routes', based on the
73
80
given plugin registry.
75
m = routes.Mapper(explicit=True)
82
r = ObjectPermissionCheckingPublisher(root=root)
84
r.add_set_switch('api', 'api')
87
view_attr = 'public_views'
88
forward_route_attr = 'public_forward_routes'
89
reverse_route_attr = 'public_reverse_routes'
92
forward_route_attr = 'forward_routes'
93
reverse_route_attr = 'reverse_routes'
76
96
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))
94
"""Handles a request which may be to anywhere in the site except media.
97
if hasattr(plugin, forward_route_attr):
98
for fr in getattr(plugin, forward_route_attr):
99
# An annotated function can also be passed in directly.
100
if hasattr(fr, '_forward_route_meta'):
101
r.add_forward_func(fr)
105
if hasattr(plugin, reverse_route_attr):
106
for rr in getattr(plugin, reverse_route_attr):
107
# An annotated function can also be passed in directly.
108
if hasattr(rr, '_reverse_route_src'):
109
r.add_reverse_func(rr)
113
if hasattr(plugin, view_attr):
114
for v in getattr(plugin, view_attr):
119
def handler(apachereq):
120
"""Handles an HTTP request.
95
122
Intended to be called by mod_python, as a handler.
97
req: An Apache request object.
99
# Make the request object into an IVLE request which can be passed to apps
102
req = Request(req, html.write_html_head)
104
# Pass the apachereq to error reporter, since ivle req isn't created
106
handle_unknown_exception(apachereq, *sys.exc_info())
107
# Tell Apache not to generate its own errors as well
108
return mod_python.apache.OK
110
# Run the main handler, and catch all exceptions
112
return handler_(req, apachereq)
113
except mod_python.apache.SERVER_RETURN:
114
# An apache error. We discourage these, but they might still happen.
118
handle_unknown_exception(req, *sys.exc_info())
119
# Tell Apache not to generate its own errors as well
120
return mod_python.apache.OK
122
def handler_(req, apachereq):
124
Nested handler function. May raise exceptions. The top-level handler is
125
just used to catch exceptions.
126
Takes both an IVLE request and an Apache req.
128
# Hack? Try and get the user login early just in case we throw an error
129
# (most likely 404) to stop us seeing not logged in even when we are.
130
if not req.publicmode:
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()
124
@param apachereq: An Apache request object.
126
# Make the request object into an IVLE request which can be given to views
127
req = Request(apachereq, config)
129
req.publisher = generate_publisher(
130
config.plugin_index[ViewPlugin], ApplicationRoot(req),
131
publicmode=req.publicmode)
134
obj, viewcls, subpath = req.publisher.resolve(req.uri.decode('utf-8'))
136
# We 404 if we have a subpath but the view forbids it.
137
if not viewcls.subpath_allowed and subpath:
157
140
# Instantiate the view, which should be a BaseView class
158
view = viewcls(req, **kwargs)
141
view = viewcls(req, obj, subpath)
143
# Check that the request (mainly the user) is permitted to access
145
if not view.authorize(req):
146
# Indicate the forbidden object if this is an admin.
147
if req.user and req.user.admin:
148
raise Unauthorized('Unauthorized: %s' % view)
152
# Non-GET requests from other sites leave us vulnerable to
154
referer = req.headers_in.get('Referer')
155
if (referer is None or
156
urlparse.urlparse(req.headers_in.get('Referer')).netloc !=
158
if req.method != 'GET' and not view.offsite_posts_allowed:
160
"Non-GET requests from external sites are forbidden "
161
"for security reasons.")
159
163
# Render the output
161
165
except HTTPError, e:
166
170
if hasattr(viewcls, 'get_error_view'):
167
171
errviewcls = viewcls.get_error_view(e)
173
errviewcls = XHTMLView.get_error_view(e)
172
errview = errviewcls(req, e)
176
errview = errviewcls(req, e, obj)
173
177
errview.render(req)
176
180
req.write(e.message)
184
except mod_python.apache.SERVER_RETURN:
185
# A mod_python-specific Apache error.
186
# XXX: We need to raise these because req.throw_error() uses them.
187
# Remove this after Google Code issue 117 is fixed.
178
189
except Exception, e:
179
190
# A non-HTTPError appeared. We have an unknown exception. Panic.
180
191
handle_unknown_exception(req, *sys.exc_info())
194
# Commit the transaction if we have a store open.
185
### END New plugins framework ###
187
# Check req.app to see if it is valid. 404 if not.
188
if req.app is not None and req.app not in ivle.conf.apps.app_url:
189
req.throw_error(Request.HTTP_NOT_FOUND,
190
"There is no application called %s." % repr(req.app))
192
# Special handling for public mode - only allow the public app, call it
194
# NOTE: This will not behave correctly if the public app uses
195
# write_html_head_foot, but "serve" does not.
197
if req.app != ivle.conf.apps.public_app:
198
req.throw_error(Request.HTTP_FORBIDDEN,
199
"This application is not available on the public site.")
200
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
201
apps.call_app(app.dir, req)
197
except Unauthorized, e:
198
# Resolution failed due to a permission check. Display a pretty
199
# error, or maybe a login page.
200
XHTMLView.get_error_view(e)(req, e, req.publisher.root).render(req)
204
# app is the App object for the chosen app
206
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
208
app = ivle.conf.apps.app_url[req.app]
210
# Check if app requires auth. If so, perform authentication and login.
211
# This will either return a User object, None, or perform a redirect
212
# which we will not catch here.
214
req.user = login.login(req)
215
logged_in = req.user is not None
217
req.user = login.get_user_details(req)
221
# Keep the user's session alive by writing to the session object.
222
# req.get_session().save()
223
# Well, it's a fine idea, but it creates considerable grief in the
224
# concurrent update department, so instead, we'll just make the
225
# sessions not time out.
226
req.get_session().unlock()
228
# If user did not specify an app, HTTP redirect to default app and
231
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
233
# Set the default title to the app's tab name, if any. Otherwise URL
235
if app.name is not None:
202
except PublishingError, e:
205
if req.user and req.user.admin:
206
XHTMLErrorView(req, NotFound('Not found: ' +
207
str(e.args)), e[0]).render(req)
240
# Call the specified app with the request object
241
apps.call_app(app.dir, req)
243
# if not logged in, login.login will have written the login box.
244
# Just clean up and exit.
246
# MAKE SURE we write the HTTP (and possibly HTML) header. This
247
# wouldn't happen if nothing else ever got written, so we have to make
249
req.ensure_headers_written()
251
# When done, write out the HTML footer if the app has requested it
252
if req.write_html_head_foot:
253
html.write_html_foot(req)
255
# Note: Apache will not write custom HTML error messages here.
256
# Use req.throw_error to do that.
209
XHTMLErrorView(req, NotFound(), e[0]).render(req)
213
# Make sure we close the store.
259
216
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
315
logging.debug('Logging Unhandled Exception')
317
# We handle 3 types of error.
318
# IVLEErrors with 4xx response codes (client error).
319
# IVLEErrors with 5xx response codes (handled server error).
320
# Other exceptions (unhandled server error).
321
# IVLEErrors should not have other response codes than 4xx or 5xx
322
# (eg. throw_redirect should have been used for 3xx codes).
323
# Therefore, that is treated as an unhandled error.
325
if (exc_type == util.IVLEError and httpcode >= 400
326
and httpcode <= 499):
327
# IVLEErrors with 4xx response codes are client errors.
328
# Therefore, these have a "nice" response (we even coat it in the IVLE
331
req.write_html_head_foot = True
332
req.write_javascript_settings = False
333
req.write('<div id="ivle_padding">\n')
335
codename, msg = req.get_http_codename(httpcode)
336
except AttributeError:
337
codename, msg = None, None
338
# Override the default message with the supplied one,
340
if exc_value.message is not None:
341
msg = exc_value.message
342
if codename is not None:
343
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
345
req.write("<h1>Error</h1>\n")
347
req.write("<p>%s</p>\n" % cgi.escape(msg))
349
req.write("<p>An unknown error occured.</p>\n")
352
logging.info(str(msg))
354
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
356
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
357
%cgi.escape(logfile))
358
req.write('</div>\n')
359
html.write_html_foot(req)
256
# A "bad" error message. We shouldn't get here unless IVLE
257
# misbehaves (which is currently very easy, if things aren't set up
259
# Write the traceback.
261
# We need to special-case IVLEJailError, as we can get another
262
# almost-exception out of it.
263
if exc_type is util.IVLEJailError:
264
tb = 'Exception information extracted from IVLEJailError:\n'
265
tb += urllib.unquote(exc_value.info)
361
# A "bad" error message. We shouldn't get here unless IVLE
362
# misbehaves (which is currently very easy, if things aren't set up
364
# Write the traceback.
365
# If this is a non-4xx IVLEError, get the message and httpcode and
366
# make the error message a bit nicer (but still include the
368
# We also need to special-case IVLEJailError, as we can get another
369
# almost-exception out of it.
371
codename, msg = None, None
373
if exc_type is util.IVLEJailError:
374
msg = exc_value.type_str + ": " + exc_value.message
375
tb = 'Exception information extracted from IVLEJailError:\n'
376
tb += urllib.unquote(exc_value.info)
379
codename, msg = req.get_http_codename(httpcode)
380
except AttributeError:
382
# Override the default message with the supplied one,
384
if hasattr(exc_value, 'message') and exc_value.message is not None:
385
msg = exc_value.message
386
# Prepend the exception type
387
if exc_type != util.IVLEError:
388
msg = exc_type.__name__ + ": " + msg
390
tb = ''.join(traceback.format_exception(exc_type, exc_value,
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)
399
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
267
tb = ''.join(traceback.format_exception(exc_type, exc_value,
270
logging.error('\n' + tb)
272
# Error messages are only displayed is the user is NOT a student,
273
# or if there has been a problem logging the error message
274
show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
275
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
400
276
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
401
277
<html xmlns="http://www.w3.org/1999/xhtml">
402
278
<head><title>IVLE Internal Server Error</title></head>
404
<h1>IVLE Internal Server Error""")
406
if (codename is not None
407
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
408
req.write(": %s" % cgi.escape(codename))
280
<h1>IVLE Internal Server Error</h1>
411
281
<p>An error has occured which is the fault of the IVLE developers or
412
administration. The developers have been notified.</p>
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)))
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))
428
req.write("</body></html>")
285
req.write("Please report this issue to the server administrators, "
286
"along with the following information.")
288
req.write("Details have been logged for further examination.")
292
req.write("<h2>Debugging information</h2>")
293
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
294
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
