42
41
from ivle import util
44
43
from ivle.dispatch.request import Request
45
44
import ivle.webapp.security
46
45
from ivle.webapp.base.plugins import ViewPlugin, PublicViewPlugin
47
from ivle.webapp.errors import HTTPError, Unauthorized
49
def generate_route_mapper(view_plugins, attr):
46
from ivle.webapp.base.xhtml import XHTMLView, XHTMLErrorView
47
from ivle.webapp.errors import HTTPError, Unauthorized, NotFound
48
from ivle.webapp.publisher import Publisher, PublishingError
49
from ivle.webapp import ApplicationRoot
51
config = ivle.config.Config()
53
class ObjectPermissionCheckingPublisher(Publisher):
54
"""A specialised publisher that checks object permissions.
56
This publisher verifies that the user holds any permission at all
57
on the model objects through which the resolution path passes. If
58
no permission is held, resolution is aborted with an Unauthorized
61
IMPORTANT: This does NOT check view permissions. It only checks
62
the objects in between the root and the view, exclusive!
65
def traversed_to_object(self, obj):
66
"""Check that the user has any permission at all over the object."""
67
if (hasattr(obj, 'get_permissions') and
68
len(obj.get_permissions(self.root.user, config)) == 0):
69
# Indicate the forbidden object if this is an admin.
70
if self.root.user and self.root.user.admin:
71
raise Unauthorized('Unauthorized: %s' % obj)
76
def generate_publisher(view_plugins, root, publicmode=False):
51
78
Build a Mapper object for doing URL matching using 'routes', based on the
52
79
given plugin registry.
54
m = routes.Mapper(explicit=True)
81
r = ObjectPermissionCheckingPublisher(root=root)
83
r.add_set_switch('api', 'api')
86
view_attr = 'public_views'
87
forward_route_attr = 'public_forward_routes'
88
reverse_route_attr = 'public_reverse_routes'
91
forward_route_attr = 'forward_routes'
92
reverse_route_attr = 'reverse_routes'
55
95
for plugin in view_plugins:
56
# Establish a URL pattern for each element of plugin.urls
57
assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin
58
for url in getattr(plugin, attr):
61
kwargs_dict = url[2] if len(url) >= 3 else {}
62
m.connect(routex, view=view_class, **kwargs_dict)
66
"""Handles a request which may be to anywhere in the site except media.
96
if hasattr(plugin, forward_route_attr):
97
for fr in getattr(plugin, forward_route_attr):
98
# An annotated function can also be passed in directly.
99
if hasattr(fr, '_forward_route_meta'):
100
r.add_forward_func(fr)
104
if hasattr(plugin, reverse_route_attr):
105
for rr in getattr(plugin, reverse_route_attr):
106
# An annotated function can also be passed in directly.
107
if hasattr(rr, '_reverse_route_src'):
108
r.add_reverse_func(rr)
112
if hasattr(plugin, view_attr):
113
for v in getattr(plugin, view_attr):
118
def handler(apachereq):
119
"""Handles an HTTP request.
67
121
Intended to be called by mod_python, as a handler.
69
req: An Apache request object.
71
# Make the request object into an IVLE request which can be passed to apps
76
# Pass the apachereq to error reporter, since ivle req isn't created
78
handle_unknown_exception(apachereq, *sys.exc_info())
79
# Tell Apache not to generate its own errors as well
80
return mod_python.apache.OK
82
# Run the main handler, and catch all exceptions
84
return handler_(req, apachereq)
85
except mod_python.apache.SERVER_RETURN:
86
# An apache error. We discourage these, but they might still happen.
90
handle_unknown_exception(req, *sys.exc_info())
91
# Tell Apache not to generate its own errors as well
92
return mod_python.apache.OK
94
def handler_(req, apachereq):
96
Nested handler function. May raise exceptions. The top-level handler is
97
just used to catch exceptions.
98
Takes both an IVLE request and an Apache req.
123
@param apachereq: An Apache request object.
125
# Make the request object into an IVLE request which can be given to views
126
req = Request(apachereq, config)
100
128
# Hack? Try and get the user login early just in case we throw an error
101
129
# (most likely 404) to stop us seeing not logged in even when we are.
102
130
if not req.publicmode:
106
134
if user and user.valid:
109
conf = ivle.config.Config()
113
req.mapper = generate_route_mapper(conf.plugin_index[PublicViewPlugin],
116
req.mapper = generate_route_mapper(conf.plugin_index[ViewPlugin],
119
matchdict = req.mapper.match(req.uri)
120
if matchdict is not None:
121
viewcls = matchdict['view']
122
# Get the remaining arguments, less 'view', 'action' and 'controller'
123
# (The latter two seem to be built-in, and we don't want them).
124
kwargs = matchdict.copy()
137
req.publisher = generate_publisher(
138
config.plugin_index[ViewPlugin],
139
ApplicationRoot(req.config, req.store, req.user),
140
publicmode=req.publicmode)
143
obj, viewcls, subpath = req.publisher.resolve(req.uri.decode('utf-8'))
145
# We 404 if we have a subpath but the view forbids it.
146
if not viewcls.subpath_allowed and subpath:
127
149
# Instantiate the view, which should be a BaseView class
128
view = viewcls(req, **kwargs)
150
view = viewcls(req, obj, subpath)
130
152
# Check that the request (mainly the user) is permitted to access
132
154
if not view.authorize(req):
155
# Indicate the forbidden object if this is an admin.
156
if req.user and req.user.admin:
157
raise Unauthorized('Unauthorized: %s' % view)
134
160
# Render the output
136
162
except HTTPError, e:
220
logging.debug('Logging Unhandled Exception')
222
258
# A "bad" error message. We shouldn't get here unless IVLE
223
259
# misbehaves (which is currently very easy, if things aren't set up
225
261
# Write the traceback.
226
# If this is a non-4xx IVLEError, get the message and httpcode and
227
# make the error message a bit nicer (but still include the
229
# We also need to special-case IVLEJailError, as we can get another
263
# We need to special-case IVLEJailError, as we can get another
230
264
# almost-exception out of it.
232
codename, msg = None, None
234
265
if exc_type is util.IVLEJailError:
235
msg = exc_value.type_str + ": " + exc_value.message
236
266
tb = 'Exception information extracted from IVLEJailError:\n'
237
267
tb += urllib.unquote(exc_value.info)
240
codename, msg = req.get_http_codename(httpcode)
241
except AttributeError:
243
# Override the default message with the supplied one,
245
if hasattr(exc_value, 'message') and exc_value.message is not None:
246
msg = exc_value.message
247
# Prepend the exception type
248
if exc_type != util.IVLEError:
249
msg = exc_type.__name__ + ": " + repr(msg)
251
269
tb = ''.join(traceback.format_exception(exc_type, exc_value,
255
logging.error('%s\n%s'%(str(msg), tb))
272
logging.error('\n' + tb)
256
274
# Error messages are only displayed is the user is NOT a student,
257
275
# or if there has been a problem logging the error message
258
show_errors = (not publicmode) and ((login and \
259
str(role) != "student") or logfail)
276
show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
260
277
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
261
278
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
262
279
<html xmlns="http://www.w3.org/1999/xhtml">
263
280
<head><title>IVLE Internal Server Error</title></head>
265
<h1>IVLE Internal Server Error""")
267
if (codename is not None
268
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
269
req.write(": %s" % cgi.escape(codename))
282
<h1>IVLE Internal Server Error</h1>
272
283
<p>An error has occured which is the fault of the IVLE developers or
273
administration. The developers have been notified.</p>
277
req.write("<p>%s</p>\n" % cgi.escape(msg))
278
if httpcode is not None:
279
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
281
<p>Please report this to <a href="mailto:%s">%s</a> (the system
282
administrator). Include the following information:</p>
283
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
287
req.write("Please report this issue to the server administrators, "
288
"along with the following information.")
290
req.write("Details have been logged for further examination.")
294
req.write("<h2>Debugging information</h2>")
285
295
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
287
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
288
%cgi.escape(logfile))
289
296
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
