42
42
from ivle import util
44
45
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):
46
from ivle.dispatch import login
49
import plugins.console # XXX: Relies on www/ being in the Python path.
51
# XXX List of plugins, which will eventually be read in from conf
52
# Elements are (module, classname) pairs.
54
('ivle.webapp.admin.user', 'Plugin'),
57
def get_routes_mapper():
79
59
Build a Mapper object for doing URL matching using 'routes', based on the
80
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'
96
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.
63
for plugin_path, classname in plugins_HACK:
64
# Load the plugin module from somewhere in the Python path
65
# (Note that plugin_path is a fully-qualified Python module name).
66
plugin = getattr(__import__(plugin_path, fromlist=[classname]),
68
# Establish a URL pattern for each element of plugin.urls
69
for url in plugin.urls:
72
kwargs_dict = url[2] if len(url) >= 3 else {}
73
m.connect(routex, view=view_class, **kwargs_dict)
77
"""Handles a request which may be to anywhere in the site except media.
122
78
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)
80
req: An Apache request object.
82
# Make the request object into an IVLE request which can be passed to apps
85
req = Request(req, html.write_html_head)
87
# Pass the apachereq to error reporter, since ivle req isn't created
89
handle_unknown_exception(apachereq, *sys.exc_info())
90
# Tell Apache not to generate its own errors as well
91
return mod_python.apache.OK
93
# Run the main handler, and catch all exceptions
95
return handler_(req, apachereq)
96
except mod_python.apache.SERVER_RETURN:
97
# An apache error. We discourage these, but they might still happen.
101
handle_unknown_exception(req, *sys.exc_info())
102
# Tell Apache not to generate its own errors as well
103
return mod_python.apache.OK
105
def handler_(req, apachereq):
107
Nested handler function. May raise exceptions. The top-level handler is
108
just used to catch exceptions.
109
Takes both an IVLE request and an Apache req.
129
111
# Hack? Try and get the user login early just in case we throw an error
130
112
# (most likely 404) to stop us seeing not logged in even when we are.
131
113
if not req.publicmode:
132
user = ivle.webapp.security.get_user_details(req)
134
# Don't set the user if it is disabled or hasn't accepted the ToS.
135
if user and user.valid:
138
req.publisher = generate_publisher(
139
config.plugin_index[ViewPlugin],
140
ApplicationRoot(req.config, req.store, req.user),
141
publicmode=req.publicmode)
144
obj, viewcls, subpath = req.publisher.resolve(req.uri.decode('utf-8'))
146
# We 404 if we have a subpath but the view forbids it.
147
if not viewcls.subpath_allowed and subpath:
150
# Instantiate the view, which should be a BaseView class
151
view = viewcls(req, obj, subpath)
153
# Check that the request (mainly the user) is permitted to access
155
if not view.authorize(req):
156
# Indicate the forbidden object if this is an admin.
157
if req.user and req.user.admin:
158
raise Unauthorized('Unauthorized: %s' % view)
162
# Non-GET requests from other sites leave us vulnerable to
164
referer = req.headers_in.get('Referer')
165
if (referer is None or
166
urlparse.urlparse(req.headers_in.get('Referer')).netloc !=
168
if req.method != 'GET' and not view.offsite_posts_allowed:
170
"Non-GET requests from external sites are forbidden "
171
"for security reasons.")
176
# A view explicitly raised an HTTP error. Respect it.
179
# Try to find a custom error view.
180
if hasattr(viewcls, 'get_error_view'):
181
errviewcls = viewcls.get_error_view(e)
183
errviewcls = XHTMLView.get_error_view(e)
186
errview = errviewcls(req, e, obj)
194
except mod_python.apache.SERVER_RETURN:
195
# A mod_python-specific Apache error.
196
# XXX: We need to raise these because req.throw_error() uses them.
197
# Remove this after Google Code issue 117 is fixed.
200
# A non-HTTPError appeared. We have an unknown exception. Panic.
201
handle_unknown_exception(req, *sys.exc_info())
206
except Unauthorized, e:
207
# Resolution failed due to a permission check. Display a pretty
208
# error, or maybe a login page.
209
XHTMLView.get_error_view(e)(req, e, req.publisher.root).render(req)
211
except PublishingError, e:
214
if req.user and req.user.admin:
215
XHTMLErrorView(req, NotFound('Not found: ' +
216
str(e.args)), e[0]).render(req)
218
XHTMLErrorView(req, NotFound(), e[0]).render(req)
114
req.user = login.get_user_details(req)
116
### BEGIN New plugins framework ###
117
# XXX This should be done ONCE per Python process, not per request.
119
# XXX No authentication is done here
120
mapper = get_routes_mapper()
121
matchdict = mapper.match(req.uri)
122
if matchdict is not None:
123
viewcls = matchdict['view']
124
# Get the remaining arguments, less 'view', 'action' and 'controller'
125
# (The latter two seem to be built-in, and we don't want them).
126
kwargs = matchdict.copy()
129
del kwargs['controller']
130
# Instantiate the view, which should be a BaseView class
131
view = viewcls(req, **kwargs)
136
### END New plugins framework ###
138
# Check req.app to see if it is valid. 404 if not.
139
if req.app is not None and req.app not in ivle.conf.apps.app_url:
140
req.throw_error(Request.HTTP_NOT_FOUND,
141
"There is no application called %s." % repr(req.app))
143
# Special handling for public mode - only allow the public app, call it
145
# NOTE: This will not behave correctly if the public app uses
146
# write_html_head_foot, but "serve" does not.
148
if req.app != ivle.conf.apps.public_app:
149
req.throw_error(Request.HTTP_FORBIDDEN,
150
"This application is not available on the public site.")
151
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
152
apps.call_app(app.dir, req)
155
# app is the App object for the chosen app
157
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
159
app = ivle.conf.apps.app_url[req.app]
161
# Check if app requires auth. If so, perform authentication and login.
162
# This will either return a User object, None, or perform a redirect
163
# which we will not catch here.
165
req.user = login.login(req)
166
logged_in = req.user is not None
168
req.user = login.get_user_details(req)
172
# Keep the user's session alive by writing to the session object.
173
# req.get_session().save()
174
# Well, it's a fine idea, but it creates considerable grief in the
175
# concurrent update department, so instead, we'll just make the
176
# sessions not time out.
177
req.get_session().unlock()
179
# If user did not specify an app, HTTP redirect to default app and
182
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
184
# Set the default title to the app's tab name, if any. Otherwise URL
186
if app.name is not None:
191
# Call the specified app with the request object
192
apps.call_app(app.dir, req)
194
# if not logged in, login.login will have written the login box.
195
# Just clean up and exit.
197
# MAKE SURE we write the HTTP (and possibly HTML) header. This
198
# wouldn't happen if nothing else ever got written, so we have to make
200
req.ensure_headers_written()
202
# When done, write out the HTML footer if the app has requested it
203
if req.write_html_head_foot:
204
# Show the console if required
205
if logged_in and app.useconsole:
206
plugins.console.present(req, windowpane=True)
207
html.write_html_foot(req)
209
# Note: Apache will not write custom HTML error messages here.
210
# Use req.throw_error to do that.
224
213
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
271
# A "bad" error message. We shouldn't get here unless IVLE
272
# misbehaves (which is currently very easy, if things aren't set up
274
# Write the traceback.
276
# We need to special-case IVLEJailError, as we can get another
277
# almost-exception out of it.
278
if exc_type is util.IVLEJailError:
279
tb = 'Exception information extracted from IVLEJailError:\n'
280
tb += urllib.unquote(exc_value.info)
269
logging.debug('Logging Unhandled Exception')
271
# We handle 3 types of error.
272
# IVLEErrors with 4xx response codes (client error).
273
# IVLEErrors with 5xx response codes (handled server error).
274
# Other exceptions (unhandled server error).
275
# IVLEErrors should not have other response codes than 4xx or 5xx
276
# (eg. throw_redirect should have been used for 3xx codes).
277
# Therefore, that is treated as an unhandled error.
279
if (exc_type == util.IVLEError and httpcode >= 400
280
and httpcode <= 499):
281
# IVLEErrors with 4xx response codes are client errors.
282
# Therefore, these have a "nice" response (we even coat it in the IVLE
285
req.write_html_head_foot = True
286
req.write_javascript_settings = False
287
req.write('<div id="ivle_padding">\n')
289
codename, msg = req.get_http_codename(httpcode)
290
except AttributeError:
291
codename, msg = None, None
292
# Override the default message with the supplied one,
294
if exc_value.message is not None:
295
msg = exc_value.message
296
if codename is not None:
297
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
299
req.write("<h1>Error</h1>\n")
301
req.write("<p>%s</p>\n" % cgi.escape(msg))
303
req.write("<p>An unknown error occured.</p>\n")
306
logging.info(str(msg))
308
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
310
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
311
%cgi.escape(logfile))
312
req.write('</div>\n')
313
html.write_html_foot(req)
282
tb = ''.join(traceback.format_exception(exc_type, exc_value,
285
logging.error('\n' + tb)
287
# Error messages are only displayed is the user is NOT a student,
288
# or if there has been a problem logging the error message
289
show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
290
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
315
# A "bad" error message. We shouldn't get here unless IVLE
316
# misbehaves (which is currently very easy, if things aren't set up
318
# Write the traceback.
319
# If this is a non-4xx IVLEError, get the message and httpcode and
320
# make the error message a bit nicer (but still include the
322
# We also need to special-case IVLEJailError, as we can get another
323
# almost-exception out of it.
325
codename, msg = None, None
327
if exc_type is util.IVLEJailError:
328
msg = exc_value.type_str + ": " + exc_value.message
329
tb = 'Exception information extracted from IVLEJailError:\n'
330
tb += urllib.unquote(exc_value.info)
333
codename, msg = req.get_http_codename(httpcode)
334
except AttributeError:
336
# Override the default message with the supplied one,
338
if hasattr(exc_value, 'message') and exc_value.message is not None:
339
msg = exc_value.message
340
# Prepend the exception type
341
if exc_type != util.IVLEError:
342
msg = exc_type.__name__ + ": " + msg
344
tb = ''.join(traceback.format_exception(exc_type, exc_value,
348
logging.error('%s\n%s'%(str(msg), tb))
349
# Error messages are only displayed is the user is NOT a student,
350
# or if there has been a problem logging the error message
351
show_errors = (not publicmode) and ((login and \
352
str(role) != "student") or logfail)
353
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
291
354
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
292
355
<html xmlns="http://www.w3.org/1999/xhtml">
293
356
<head><title>IVLE Internal Server Error</title></head>
295
<h1>IVLE Internal Server Error</h1>
358
<h1>IVLE Internal Server Error""")
360
if (codename is not None
361
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
362
req.write(": %s" % cgi.escape(codename))
296
365
<p>An error has occured which is the fault of the IVLE developers or
300
req.write("Please report this issue to the server administrators, "
301
"along with the following information.")
303
req.write("Details have been logged for further examination.")
307
req.write("<h2>Debugging information</h2>")
308
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
309
req.write("</body></html>")
366
administration. The developers have been notified.</p>
370
req.write("<p>%s</p>\n" % cgi.escape(msg))
371
if httpcode is not None:
372
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
374
<p>Please report this to <a href="mailto:%s">%s</a> (the system
375
administrator). Include the following information:</p>
376
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
378
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
380
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
381
%cgi.escape(logfile))
382
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
