2
# Copyright (C) 2007-2008 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22
# This is a mod_python handler program. The correct way to call it is to have
23
# Apache send all requests to be handled by the module 'dispatch'.
25
# Top-level handler. Handles all requests to all pages in IVLE.
26
# Handles authentication (not authorization).
27
# Then passes the request along to the appropriate ivle app.
40
from mod_python import apache, Cookie
48
from request import Request
49
import plugins.console # XXX: Relies on www/ being in the Python path.
51
# List of cookies that IVLE uses (to be removed at logout)
52
ivle_cookies = ["ivleforumcookie", "clipboard"]
55
"""Handles a request which may be to anywhere in the site except media.
56
Intended to be called by mod_python, as a handler.
58
req: An Apache request object.
60
# Make the request object into an IVLE request which can be passed to apps
63
req = Request(req, html.write_html_head)
65
# Pass the apachereq to error reporter, since ivle req isn't created
67
handle_unknown_exception(apachereq, *sys.exc_info())
68
# Tell Apache not to generate its own errors as well
71
# Run the main handler, and catch all exceptions
73
return handler_(req, apachereq)
74
except mod_python.apache.SERVER_RETURN:
75
# An apache error. We discourage these, but they might still happen.
79
handle_unknown_exception(req, *sys.exc_info())
80
# Tell Apache not to generate its own errors as well
83
def handler_(req, apachereq):
85
Nested handler function. May raise exceptions. The top-level handler is
86
just used to catch exceptions.
87
Takes both an IVLE request and an Apache req.
89
# Hack? Try and get the user login early just in case we throw an error
90
# (most likely 404) to stop us seeing not logged in even when we are.
91
if not req.publicmode:
92
req.user = login.get_user_details(req)
94
# Check req.app to see if it is valid. 404 if not.
95
if req.app is not None and req.app not in ivle.conf.apps.app_url:
96
# Maybe it is a special app!
97
if req.app == 'logout':
100
req.throw_error(Request.HTTP_NOT_FOUND,
101
"There is no application called %s." % repr(req.app))
103
# Special handling for public mode - only allow the public app, call it
105
# NOTE: This will not behave correctly if the public app uses
106
# write_html_head_foot, but "serve" does not.
108
if req.app != ivle.conf.apps.public_app:
109
req.throw_error(Request.HTTP_FORBIDDEN,
110
"This application is not available on the public site.")
111
app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
112
apps.call_app(app.dir, req)
115
# app is the App object for the chosen app
117
app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
119
app = ivle.conf.apps.app_url[req.app]
121
# Check if app requires auth. If so, perform authentication and login.
122
# This will either return a User object, None, or perform a redirect
123
# which we will not catch here.
125
req.user = login.login(req)
126
logged_in = req.user is not None
128
req.user = login.get_user_details(req)
132
# Keep the user's session alive by writing to the session object.
133
# req.get_session().save()
134
# Well, it's a fine idea, but it creates considerable grief in the
135
# concurrent update department, so instead, we'll just make the
136
# sessions not time out.
137
req.get_session().unlock()
139
# If user did not specify an app, HTTP redirect to default app and
142
req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
144
# Set the default title to the app's tab name, if any. Otherwise URL
146
if app.name is not None:
151
# Call the specified app with the request object
152
apps.call_app(app.dir, req)
154
# if not logged in, login.login will have written the login box.
155
# Just clean up and exit.
157
# MAKE SURE we write the HTTP (and possibly HTML) header. This
158
# wouldn't happen if nothing else ever got written, so we have to make
160
req.ensure_headers_written()
162
# When done, write out the HTML footer if the app has requested it
163
if req.write_html_head_foot:
164
# Show the console if required
165
if logged_in and app.useconsole:
166
plugins.console.present(req, windowpane=True)
167
html.write_html_foot(req)
169
# Note: Apache will not write custom HTML error messages here.
170
# Use req.throw_error to do that.
174
"""Log out the current user (if any) by destroying the session state.
175
Then redirect to the top-level IVLE page."""
176
session = req.get_session()
179
# Invalidates all IVLE cookies
180
all_cookies = Cookie.get_cookies(req)
181
for cookie in all_cookies:
182
if cookie in ivle_cookies:
183
req.add_cookie(Cookie.Cookie(cookie,'',expires=1,path='/'))
184
req.throw_redirect(util.make_path(''))
186
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
188
Given an exception that has just been thrown from IVLE, print its details
190
This is a full handler. It assumes nothing has been written, and writes a
192
req: May be EITHER an IVLE req or an Apache req.
193
IVLE reqs may have the HTML head/foot written (on a 400 error), but
194
the handler code may pass an apache req if an exception occurs before
195
the IVLE request is created.
197
req.content_type = "text/html"
198
logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
200
# For some reason, some versions of mod_python have "_server" instead of
201
# "main_server". So we check for both.
203
admin_email = apache.main_server.server_admin
204
except AttributeError:
206
admin_email = apache._server.server_admin
207
except AttributeError:
210
httpcode = exc_value.httpcode
211
req.status = httpcode
212
except AttributeError:
214
req.status = apache.HTTP_INTERNAL_SERVER_ERROR
216
login = req.user.login
217
except AttributeError:
222
for h in logging.getLogger().handlers:
223
logging.getLogger().removeHandler(h)
224
logging.basicConfig(level=logging.INFO,
225
format='%(asctime)s %(levelname)s: ' +
226
'(HTTP: ' + str(req.status) +
227
', Ref: ' + str(login) + '@' +
228
str(socket.gethostname()) + str(req.uri) +
234
logging.debug('Logging Unhandled Exception')
236
# We handle 3 types of error.
237
# IVLEErrors with 4xx response codes (client error).
238
# IVLEErrors with 5xx response codes (handled server error).
239
# Other exceptions (unhandled server error).
240
# IVLEErrors should not have other response codes than 4xx or 5xx
241
# (eg. throw_redirect should have been used for 3xx codes).
242
# Therefore, that is treated as an unhandled error.
244
if (exc_type == util.IVLEError and httpcode >= 400
245
and httpcode <= 499):
246
# IVLEErrors with 4xx response codes are client errors.
247
# Therefore, these have a "nice" response (we even coat it in the IVLE
250
req.write_html_head_foot = True
251
req.write_javascript_settings = False
252
req.write('<div id="ivle_padding">\n')
254
codename, msg = req.get_http_codename(httpcode)
255
except AttributeError:
256
codename, msg = None, None
257
# Override the default message with the supplied one,
259
if exc_value.message is not None:
260
msg = exc_value.message
261
if codename is not None:
262
req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
264
req.write("<h1>Error</h1>\n")
266
req.write("<p>%s</p>\n" % cgi.escape(msg))
268
req.write("<p>An unknown error occured.</p>\n")
271
logging.info(str(msg))
273
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
275
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
276
%cgi.escape(logfile))
277
req.write('</div>\n')
278
html.write_html_foot(req)
280
# A "bad" error message. We shouldn't get here unless IVLE
281
# misbehaves (which is currently very easy, if things aren't set up
283
# Write the traceback.
284
# If this is a non-4xx IVLEError, get the message and httpcode and
285
# make the error message a bit nicer (but still include the
287
# We also need to special-case IVLEJailError, as we can get another
288
# almost-exception out of it.
290
codename, msg = None, None
292
if exc_type is util.IVLEJailError:
293
msg = exc_value.type_str + ": " + exc_value.message
294
tb = 'Exception information extracted from IVLEJailError:\n'
295
tb += urllib.unquote(exc_value.info)
298
codename, msg = req.get_http_codename(httpcode)
299
except AttributeError:
301
# Override the default message with the supplied one,
303
if hasattr(exc_value, 'message') and exc_value.message is not None:
304
msg = exc_value.message
305
# Prepend the exception type
306
if exc_type != util.IVLEError:
307
msg = exc_type.__name__ + ": " + msg
309
tb = ''.join(traceback.format_exception(exc_type, exc_value,
313
logging.error('%s\n%s'%(str(msg), tb))
315
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
316
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
317
<html xmlns="http://www.w3.org/1999/xhtml">
318
<head><title>IVLE Internal Server Error</title></head>
320
<h1>IVLE Internal Server Error""")
321
if (codename is not None
322
and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
323
req.write(": %s" % cgi.escape(codename))
325
<p>An error has occured which is the fault of the IVLE developers or
329
req.write("<p>%s</p>\n" % cgi.escape(msg))
330
if httpcode is not None:
331
req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
333
<p>Please report this to <a href="mailto:%s">%s</a> (the system
334
administrator). Include the following information:</p>
335
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
337
req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
339
req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
340
%cgi.escape(logfile))
341
req.write("</body></html>")
added
removed
ivle/dispatch/__init__.py
