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 and delegates to views for authorization,
26
then passes the request along to the appropriate view.
25
Handles authentication (not authorization).
26
Then passes the request along to the appropriate ivle app.
42
43
from ivle import util
44
46
from ivle.dispatch.request import Request
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):
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',
69
def generate_route_mapper(view_plugins):
79
71
Build a Mapper object for doing URL matching using 'routes', based on the
80
72
given plugin registry.
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'
74
m = routes.Mapper(explicit=True)
96
75
for plugin in view_plugins:
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.
76
# Establish a URL pattern for each element of plugin.urls
77
assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin
78
for url in plugin.urls:
81
kwargs_dict = url[2] if len(url) >= 3 else {}
82
m.connect(routex, view=view_class, **kwargs_dict)
85
def get_plugin(pluginstr):
86
plugin_path, classname = pluginstr.split('#')
87
# Load the plugin module from somewhere in the Python path
88
# (Note that plugin_path is a fully-qualified Python module name).
90
getattr(__import__(plugin_path, fromlist=[classname]), classname))
93
"""Handles a request which may be to anywhere in the site except media.
122
94
Intended to be called by mod_python, as a handler.
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'))
96
req: An Apache request object.
98
# Make the request object into an IVLE request which can be passed to apps
101
req = Request(req, html.write_html_head)
103
# Pass the apachereq to error reporter, since ivle req isn't created
105
handle_unknown_exception(apachereq, *sys.exc_info())
106
# Tell Apache not to generate its own errors as well
107
return mod_python.apache.OK
109
# Run the main handler, and catch all exceptions
111
return handler_(req, apachereq)
112
except mod_python.apache.SERVER_RETURN:
113
# An apache error. We discourage these, but they might still happen.
117
handle_unknown_exception(req, *sys.exc_info())
118
# Tell Apache not to generate its own errors as well
119
return mod_python.apache.OK
121
def handler_(req, apachereq):
123
Nested handler function. May raise exceptions. The top-level handler is
124
just used to catch exceptions.
125
Takes both an IVLE request and an Apache req.
127
# Hack? Try and get the user login early just in case we throw an error
128
# (most likely 404) to stop us seeing not logged in even when we are.
129
if not req.publicmode:
130
req.user = login.get_user_details(req)
132
### BEGIN New plugins framework ###
133
# XXX This should be done ONCE per Python process, not per request.
135
# XXX No authentication is done here
136
req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
137
# Index the plugins by base class
138
req.plugin_index = {}
139
for plugin in req.plugins.values():
140
# Getmro returns a tuple of all the super-classes of the plugin
141
for base in inspect.getmro(plugin):
142
if base not in req.plugin_index:
143
req.plugin_index[base] = []
144
req.plugin_index[base].append(plugin)
145
req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
146
req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
148
matchdict = req.mapper.match(req.uri)
149
if matchdict is not None:
150
viewcls = matchdict['view']
151
# Get the remaining arguments, less 'view', 'action' and 'controller'
152
# (The latter two seem to be built-in, and we don't want them).
153
kwargs = matchdict.copy()
136
# We 404 if we have a subpath but the view forbids it.
137
if not viewcls.subpath_allowed and subpath:
140
156
# Instantiate the view, which should be a BaseView class
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.")
157
view = viewcls(req, **kwargs)
163
158
# Render the output
165
160
except HTTPError, e:
170
165
if hasattr(viewcls, 'get_error_view'):
171
166
errviewcls = viewcls.get_error_view(e)
173
errviewcls = XHTMLView.get_error_view(e)
176
errview = errviewcls(req, e, obj)
171
errview = errviewcls(req, e)
177
172
errview.render(req)
180
175
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.
189
177
except Exception, e:
190
178
# A non-HTTPError appeared. We have an unknown exception. Panic.
191
179
handle_unknown_exception(req, *sys.exc_info())
194
# Commit the transaction if we have a store open.
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)
184
### END New plugins framework ###
186
# Check req.app to see if it is valid. 404 if not.
187
if req.app is not None and req.app not in ivle.conf.apps.app_url:
188
req.throw_error(Request.HTTP_NOT_FOUND,
189
"There is no application called %s." % repr(req.app))
191
# Special handling for public mode - only allow the public app, call it
193
# NOTE: This will not behave correctly if the public app uses
194
# write_html_head_foot, but "serve" does not.
196
if req.app != ivle.conf.apps.public_app:
197
req.throw_error(Request.HTTP_FORBIDDEN,
198
"This application is not available on the public site.")
199
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
200
apps.call_app(app.dir, req)
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)
203
# app is the App object for the chosen app
205
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
207
app = ivle.conf.apps.app_url[req.app]
209
# Check if app requires auth. If so, perform authentication and login.
210
# This will either return a User object, None, or perform a redirect
211
# which we will not catch here.
213
req.user = login.login(req)
214
logged_in = req.user is not None
216
req.user = login.get_user_details(req)
220
# Keep the user's session alive by writing to the session object.
221
# req.get_session().save()
222
# Well, it's a fine idea, but it creates considerable grief in the
223
# concurrent update department, so instead, we'll just make the
224
# sessions not time out.
225
req.get_session().unlock()
227
# If user did not specify an app, HTTP redirect to default app and
230
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
232
# Set the default title to the app's tab name, if any. Otherwise URL
234
if app.name is not None:
209
XHTMLErrorView(req, NotFound(), e[0]).render(req)
213
# Make sure we close the store.
239
# Call the specified app with the request object
240
apps.call_app(app.dir, req)
242
# if not logged in, login.login will have written the login box.
243
# Just clean up and exit.
245
# MAKE SURE we write the HTTP (and possibly HTML) header. This
246
# wouldn't happen if nothing else ever got written, so we have to make
248
req.ensure_headers_written()
250
# When done, write out the HTML footer if the app has requested it
251
if req.write_html_head_foot:
252
html.write_html_foot(req)
254
# Note: Apache will not write custom HTML error messages here.
255
# Use req.throw_error to do that.
216
258
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
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)
314
logging.debug('Logging Unhandled Exception')
316
# We handle 3 types of error.
317
# IVLEErrors with 4xx response codes (client error).
318
# IVLEErrors with 5xx response codes (handled server error).
319
# Other exceptions (unhandled server error).
320
# IVLEErrors should not have other response codes than 4xx or 5xx
321
# (eg. throw_redirect should have been used for 3xx codes).
322
# Therefore, that is treated as an unhandled error.
324
if (exc_type == util.IVLEError and httpcode >= 400
325
and httpcode <= 499):
326
# IVLEErrors with 4xx response codes are client errors.
327
# Therefore, these have a "nice" response (we even coat it in the IVLE
330
req.write_html_head_foot = True
331
req.write_javascript_settings = False
332
req.write('<div id="ivle_padding">\n')
334
codename, msg = req.get_http_codename(httpcode)
335
except AttributeError:
336
codename, msg = None, None
337
# Override the default message with the supplied one,
339
if exc_value.message is not None:
340
msg = exc_value.message
341
if codename is not None:
342
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
344
req.write("<h1>Error</h1>\n")
346
req.write("<p>%s</p>\n" % cgi.escape(msg))
348
req.write("<p>An unknown error occured.</p>\n")
351
logging.info(str(msg))
353
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
355
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
356
%cgi.escape(logfile))
357
req.write('</div>\n')
358
html.write_html_foot(req)
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"
360
# A "bad" error message. We shouldn't get here unless IVLE
361
# misbehaves (which is currently very easy, if things aren't set up
363
# Write the traceback.
364
# If this is a non-4xx IVLEError, get the message and httpcode and
365
# make the error message a bit nicer (but still include the
367
# We also need to special-case IVLEJailError, as we can get another
368
# almost-exception out of it.
370
codename, msg = None, None
372
if exc_type is util.IVLEJailError:
373
msg = exc_value.type_str + ": " + exc_value.message
374
tb = 'Exception information extracted from IVLEJailError:\n'
375
tb += urllib.unquote(exc_value.info)
378
codename, msg = req.get_http_codename(httpcode)
379
except AttributeError:
381
# Override the default message with the supplied one,
383
if hasattr(exc_value, 'message') and exc_value.message is not None:
384
msg = exc_value.message
385
# Prepend the exception type
386
if exc_type != util.IVLEError:
387
msg = exc_type.__name__ + ": " + msg
389
tb = ''.join(traceback.format_exception(exc_type, exc_value,
393
logging.error('%s\n%s'%(str(msg), tb))
394
# Error messages are only displayed is the user is NOT a student,
395
# or if there has been a problem logging the error message
396
show_errors = (not publicmode) and ((login and \
397
str(role) != "student") or logfail)
398
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
276
399
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
277
400
<html xmlns="http://www.w3.org/1999/xhtml">
278
401
<head><title>IVLE Internal Server Error</title></head>
280
<h1>IVLE Internal Server Error</h1>
403
<h1>IVLE Internal Server Error""")
405
if (codename is not None
406
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
407
req.write(": %s" % cgi.escape(codename))
281
410
<p>An error has occured which is the fault of the IVLE developers or
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>")
411
administration. The developers have been notified.</p>
415
req.write("<p>%s</p>\n" % cgi.escape(msg))
416
if httpcode is not None:
417
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
419
<p>Please report this to <a href="mailto:%s">%s</a> (the system
420
administrator). Include the following information:</p>
421
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
423
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
425
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
426
%cgi.escape(logfile))
427
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
