42
43
from ivle import util
44
46
from ivle.dispatch.request import Request
45
import ivle.webapp.security
47
from ivle.dispatch import login
46
48
from ivle.webapp.base.plugins import ViewPlugin, PublicViewPlugin
47
from ivle.webapp.base.xhtml import XHTMLView, XHTMLErrorView
48
from ivle.webapp.errors import HTTPError, Unauthorized, NotFound
50
config = ivle.config.Config()
52
def generate_router(view_plugins, attr):
49
from ivle.webapp.errors import HTTPError, Unauthorized
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.filesystem.serve#Plugin',
63
'ivle.webapp.groups#Plugin',
64
'ivle.webapp.console#Plugin',
65
'ivle.webapp.security#Plugin',
66
'ivle.webapp.media#Plugin',
67
'ivle.webapp.forum#Plugin',
68
'ivle.webapp.help#Plugin',
69
'ivle.webapp.tos#Plugin',
70
'ivle.webapp.userservice#Plugin',
73
def generate_route_mapper(view_plugins, attr):
54
75
Build a Mapper object for doing URL matching using 'routes', based on the
55
76
given plugin registry.
65
86
m.connect(routex, view=view_class, **kwargs_dict)
68
def handler(apachereq):
69
"""Handles an HTTP request.
89
def get_plugin(pluginstr):
90
plugin_path, classname = pluginstr.split('#')
91
# Load the plugin module from somewhere in the Python path
92
# (Note that plugin_path is a fully-qualified Python module name).
94
getattr(__import__(plugin_path, fromlist=[classname]), classname))
97
"""Handles a request which may be to anywhere in the site except media.
71
98
Intended to be called by mod_python, as a handler.
73
@param apachereq: An Apache request object.
75
# Make the request object into an IVLE request which can be given to views
76
req = Request(apachereq, config)
100
req: An Apache request object.
102
# Make the request object into an IVLE request which can be passed to apps
105
req = Request(req, html.write_html_head)
107
# Pass the apachereq to error reporter, since ivle req isn't created
109
handle_unknown_exception(apachereq, *sys.exc_info())
110
# Tell Apache not to generate its own errors as well
111
return mod_python.apache.OK
113
# Run the main handler, and catch all exceptions
115
return handler_(req, apachereq)
116
except mod_python.apache.SERVER_RETURN:
117
# An apache error. We discourage these, but they might still happen.
121
handle_unknown_exception(req, *sys.exc_info())
122
# Tell Apache not to generate its own errors as well
123
return mod_python.apache.OK
125
def handler_(req, apachereq):
127
Nested handler function. May raise exceptions. The top-level handler is
128
just used to catch exceptions.
129
Takes both an IVLE request and an Apache req.
78
131
# Hack? Try and get the user login early just in case we throw an error
79
132
# (most likely 404) to stop us seeing not logged in even when we are.
80
133
if not req.publicmode:
81
user = ivle.webapp.security.get_user_details(req)
134
user = login.get_user_details(req)
83
136
# Don't set the user if it is disabled or hasn't accepted the ToS.
84
137
if user and user.valid:
140
### BEGIN New plugins framework ###
141
# XXX This should be done ONCE per Python process, not per request.
143
req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
144
# Index the plugins by base class
145
req.plugin_index = {}
146
for plugin in req.plugins.values():
147
# Getmro returns a tuple of all the super-classes of the plugin
148
for base in inspect.getmro(plugin):
149
if base not in req.plugin_index:
150
req.plugin_index[base] = []
151
req.plugin_index[base].append(plugin)
152
req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
87
154
if req.publicmode:
88
req.mapper = generate_router(config.plugin_index[PublicViewPlugin],
155
req.mapper = generate_route_mapper(req.plugin_index[PublicViewPlugin],
91
req.mapper = generate_router(config.plugin_index[ViewPlugin], 'urls')
158
req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin],
93
161
matchdict = req.mapper.match(req.uri)
94
162
if matchdict is not None:
139
202
req.store.commit()
143
XHTMLErrorView(req, NotFound()).render(req)
205
# We had no matching URL! Check if it matches an old-style app. If
207
if req.app not in ivle.conf.apps.app_url:
208
return req.HTTP_NOT_FOUND # TODO: Prettify.
209
### END New plugins framework ###
212
### BEGIN legacy application framework ###
213
# We have no public apps back here.
214
assert not req.publicmode
216
# app is the App object for the chosen app
218
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
220
app = ivle.conf.apps.app_url[req.app]
222
# Check if app requires auth. If so, perform authentication and login.
223
# This will either return a User object, None, or perform a redirect
224
# which we will not catch here.
226
logged_in = req.user is not None
230
assert logged_in # XXX
233
# Keep the user's session alive by writing to the session object.
234
# req.get_session().save()
235
# Well, it's a fine idea, but it creates considerable grief in the
236
# concurrent update department, so instead, we'll just make the
237
# sessions not time out.
238
req.get_session().unlock()
240
# Call the specified app with the request object
241
apps.call_app(app.dir, req)
243
# MAKE SURE we write the HTTP (and possibly HTML) header. This
244
# wouldn't happen if nothing else ever got written, so we have to make
246
req.ensure_headers_written()
248
# When done, write out the HTML footer if the app has requested it
249
if req.write_html_head_foot:
250
html.write_html_foot(req)
252
# Note: Apache will not write custom HTML error messages here.
253
# Use req.throw_error to do that.
146
256
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
150
260
This is a full handler. It assumes nothing has been written, and writes a
151
261
complete HTML page.
152
262
req: May be EITHER an IVLE req or an Apache req.
153
The handler code may pass an apache req if an exception occurs before
263
IVLE reqs may have the HTML head/foot written (on a 400 error), but
264
the handler code may pass an apache req if an exception occurs before
154
265
the IVLE request is created.
156
267
req.content_type = "text/html"
157
logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
268
logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
160
# XXX: This remains here for ivle.interpret's IVLEErrors. Once we rewrite
161
# fileservice, req.status should always be 500 (ISE) here.
270
# For some reason, some versions of mod_python have "_server" instead of
271
# "main_server". So we check for both.
273
admin_email = mod_python.apache.main_server.server_admin
274
except AttributeError:
276
admin_email = mod_python.apache._server.server_admin
277
except AttributeError:
163
280
httpcode = exc_value.httpcode
164
281
req.status = httpcode
165
282
except AttributeError:
167
284
req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
170
286
publicmode = req.publicmode
171
287
except AttributeError:
193
# A "bad" error message. We shouldn't get here unless IVLE
194
# misbehaves (which is currently very easy, if things aren't set up
196
# Write the traceback.
198
# We need to special-case IVLEJailError, as we can get another
199
# almost-exception out of it.
200
if exc_type is util.IVLEJailError:
201
tb = 'Exception information extracted from IVLEJailError:\n'
202
tb += urllib.unquote(exc_value.info)
312
logging.debug('Logging Unhandled Exception')
314
# We handle 3 types of error.
315
# IVLEErrors with 4xx response codes (client error).
316
# IVLEErrors with 5xx response codes (handled server error).
317
# Other exceptions (unhandled server error).
318
# IVLEErrors should not have other response codes than 4xx or 5xx
319
# (eg. throw_redirect should have been used for 3xx codes).
320
# Therefore, that is treated as an unhandled error.
322
if (exc_type == util.IVLEError and httpcode >= 400
323
and httpcode <= 499):
324
# IVLEErrors with 4xx response codes are client errors.
325
# Therefore, these have a "nice" response (we even coat it in the IVLE
328
req.write_html_head_foot = True
329
req.write_javascript_settings = False
330
req.write('<div id="ivle_padding">\n')
332
codename, msg = req.get_http_codename(httpcode)
333
except AttributeError:
334
codename, msg = None, None
335
# Override the default message with the supplied one,
337
if exc_value.message is not None:
338
msg = exc_value.message
339
if codename is not None:
340
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
342
req.write("<h1>Error</h1>\n")
344
req.write("<p>%s</p>\n" % cgi.escape(msg))
346
req.write("<p>An unknown error occured.</p>\n")
349
logging.info(str(msg))
351
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
353
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
354
%cgi.escape(logfile))
355
req.write('</div>\n')
356
html.write_html_foot(req)
204
tb = ''.join(traceback.format_exception(exc_type, exc_value,
207
logging.error('\n' + tb)
209
# Error messages are only displayed is the user is NOT a student,
210
# or if there has been a problem logging the error message
211
show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
212
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
358
# A "bad" error message. We shouldn't get here unless IVLE
359
# misbehaves (which is currently very easy, if things aren't set up
361
# Write the traceback.
362
# If this is a non-4xx IVLEError, get the message and httpcode and
363
# make the error message a bit nicer (but still include the
365
# We also need to special-case IVLEJailError, as we can get another
366
# almost-exception out of it.
368
codename, msg = None, None
370
if exc_type is util.IVLEJailError:
371
msg = exc_value.type_str + ": " + exc_value.message
372
tb = 'Exception information extracted from IVLEJailError:\n'
373
tb += urllib.unquote(exc_value.info)
376
codename, msg = req.get_http_codename(httpcode)
377
except AttributeError:
379
# Override the default message with the supplied one,
381
if hasattr(exc_value, 'message') and exc_value.message is not None:
382
msg = exc_value.message
383
# Prepend the exception type
384
if exc_type != util.IVLEError:
385
msg = exc_type.__name__ + ": " + msg
387
tb = ''.join(traceback.format_exception(exc_type, exc_value,
391
logging.error('%s\n%s'%(str(msg), tb))
392
# Error messages are only displayed is the user is NOT a student,
393
# or if there has been a problem logging the error message
394
show_errors = (not publicmode) and ((login and \
395
str(role) != "student") or logfail)
396
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
213
397
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
214
398
<html xmlns="http://www.w3.org/1999/xhtml">
215
399
<head><title>IVLE Internal Server Error</title></head>
217
<h1>IVLE Internal Server Error</h1>
401
<h1>IVLE Internal Server Error""")
403
if (codename is not None
404
and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
405
req.write(": %s" % cgi.escape(codename))
218
408
<p>An error has occured which is the fault of the IVLE developers or
222
req.write("Please report this issue to the server administrators, "
223
"along with the following information.")
225
req.write("Details have been logged for further examination.")
229
req.write("<h2>Debugging information</h2>")
230
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
231
req.write("</body></html>")
409
administration. The developers have been notified.</p>
413
req.write("<p>%s</p>\n" % cgi.escape(msg))
414
if httpcode is not None:
415
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
417
<p>Please report this to <a href="mailto:%s">%s</a> (the system
418
administrator). Include the following information:</p>
419
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
421
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
423
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
424
%cgi.escape(logfile))
425
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
