← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

  • Committer: William Grant
  • Date: 2009-02-25 23:04:11 UTC
  • Revision ID: grantw@unimelb.edu.au-20090225230411-lbdyl32ir0m3d59b
Make all of the services executable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/__init__.py
22
22
Apache send all requests to be handled by the module 'dispatch'.
23
23
 
24
24
Top-level handler. Handles all requests to all pages in IVLE.
25
 
Handles authentication (not authorization).
26
 
Then passes the request along to the appropriate ivle app.
 
25
Handles authentication and delegates to views for authorization,
 
26
then passes the request along to the appropriate view.
27
27
"""
28
28
 
29
29
import sys
35
35
import logging
36
36
import socket
37
37
import time
38
 
import inspect
39
38
 
40
39
import mod_python
41
40
import routes
42
41
 
43
42
from ivle import util
44
43
import ivle.conf
45
 
import ivle.conf.apps
46
44
from ivle.dispatch.request import Request
47
 
from ivle.dispatch import login
48
 
from ivle.webapp.base.plugins import ViewPlugin
49
 
from ivle.webapp.errors import HTTPError
50
 
import apps
51
 
import html
52
 
 
53
 
# XXX List of plugins, which will eventually be read in from conf
54
 
plugins_HACK = [
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',
67
 
    'ivle.webapp.help#Plugin',
68
 
    'ivle.webapp.tos#Plugin',
69
 
] 
70
 
 
71
 
def generate_route_mapper(view_plugins):
 
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 HTTPError, Unauthorized, NotFound
 
49
 
 
50
def generate_route_mapper(view_plugins, attr):
72
51
    """
73
52
    Build a Mapper object for doing URL matching using 'routes', based on the
74
53
    given plugin registry.
77
56
    for plugin in view_plugins:
78
57
        # Establish a URL pattern for each element of plugin.urls
79
58
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
80
 
        for url in plugin.urls:
 
59
        for url in getattr(plugin, attr):
81
60
            routex = url[0]
82
61
            view_class = url[1]
83
62
            kwargs_dict = url[2] if len(url) >= 3 else {}
84
63
            m.connect(routex, view=view_class, **kwargs_dict)
85
64
    return m
86
65
 
87
 
def get_plugin(pluginstr):
88
 
    plugin_path, classname = pluginstr.split('#')
89
 
    # Load the plugin module from somewhere in the Python path
90
 
    # (Note that plugin_path is a fully-qualified Python module name).
91
 
    return (plugin_path,
92
 
            getattr(__import__(plugin_path, fromlist=[classname]), classname))
 
66
def handler(apachereq):
 
67
    """Handles an HTTP request.
93
68
 
94
 
def handler(req):
95
 
    """Handles a request which may be to anywhere in the site except media.
96
69
    Intended to be called by mod_python, as a handler.
97
70
 
98
 
    req: An Apache request object.
99
 
    """
100
 
    # Make the request object into an IVLE request which can be passed to apps
101
 
    apachereq = req
102
 
    try:
103
 
        req = Request(req, html.write_html_head)
104
 
    except Exception:
105
 
        # Pass the apachereq to error reporter, since ivle req isn't created
106
 
        # yet.
107
 
        handle_unknown_exception(apachereq, *sys.exc_info())
108
 
        # Tell Apache not to generate its own errors as well
109
 
        return mod_python.apache.OK
110
 
 
111
 
    # Run the main handler, and catch all exceptions
112
 
    try:
113
 
        return handler_(req, apachereq)
114
 
    except mod_python.apache.SERVER_RETURN:
115
 
        # An apache error. We discourage these, but they might still happen.
116
 
        # Just raise up.
117
 
        raise
118
 
    except Exception:
119
 
        handle_unknown_exception(req, *sys.exc_info())
120
 
        # Tell Apache not to generate its own errors as well
121
 
        return mod_python.apache.OK
122
 
 
123
 
def handler_(req, apachereq):
124
 
    """
125
 
    Nested handler function. May raise exceptions. The top-level handler is
126
 
    just used to catch exceptions.
127
 
    Takes both an IVLE request and an Apache req.
128
 
    """
 
71
    @param apachereq: An Apache request object.
 
72
    """
 
73
    # Make the request object into an IVLE request which can be given to views
 
74
    req = Request(apachereq)
 
75
 
129
76
    # Hack? Try and get the user login early just in case we throw an error
130
77
    # (most likely 404) to stop us seeing not logged in even when we are.
131
78
    if not req.publicmode:
132
 
        req.user = login.get_user_details(req)
133
 
 
134
 
    ### BEGIN New plugins framework ###
135
 
    # XXX This should be done ONCE per Python process, not per request.
136
 
    # (Wait till WSGI)
137
 
    # XXX No authentication is done here
138
 
    req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
139
 
    # Index the plugins by base class
140
 
    req.plugin_index = {}
141
 
    for plugin in req.plugins.values():
142
 
        # Getmro returns a tuple of all the super-classes of the plugin
143
 
        for base in inspect.getmro(plugin):
144
 
            if base not in req.plugin_index:
145
 
                req.plugin_index[base] = []
146
 
            req.plugin_index[base].append(plugin)
147
 
    req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
148
 
    req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
 
79
        user = ivle.webapp.security.get_user_details(req)
 
80
 
 
81
        # Don't set the user if it is disabled or hasn't accepted the ToS.
 
82
        if user and user.valid:
 
83
            req.user = user
 
84
 
 
85
    conf = ivle.config.Config()
 
86
    req.config = conf
 
87
 
 
88
    if req.publicmode:
 
89
        req.mapper = generate_route_mapper(conf.plugin_index[PublicViewPlugin],
 
90
                                           'public_urls')
 
91
    else:
 
92
        req.mapper = generate_route_mapper(conf.plugin_index[ViewPlugin],
 
93
                                           'urls')
149
94
 
150
95
    matchdict = req.mapper.match(req.uri)
151
96
    if matchdict is not None:
157
102
        try:
158
103
            # Instantiate the view, which should be a BaseView class
159
104
            view = viewcls(req, **kwargs)
 
105
 
 
106
            # Check that the request (mainly the user) is permitted to access
 
107
            # the view.
 
108
            if not view.authorize(req):
 
109
                raise Unauthorized()
160
110
            # Render the output
161
111
            view.render(req)
162
112
        except HTTPError, e:
167
117
            if hasattr(viewcls, 'get_error_view'):
168
118
                errviewcls = viewcls.get_error_view(e)
169
119
            else:
170
 
                errviewcls = None
 
120
                errviewcls = XHTMLView.get_error_view(e)
171
121
 
172
122
            if errviewcls:
173
123
                errview = errviewcls(req, e)
174
124
                errview.render(req)
175
125
                return req.OK
176
 
            else:
 
126
            elif e.message:
177
127
                req.write(e.message)
 
128
                return req.OK
 
129
            else:
178
130
                return e.code
179
131
        except Exception, e:
180
132
            # A non-HTTPError appeared. We have an unknown exception. Panic.
183
135
        else:
184
136
            req.store.commit()
185
137
            return req.OK
186
 
    ### END New plugins framework ###
187
 
 
188
 
    # Check req.app to see if it is valid. 404 if not.
189
 
    if req.app is not None and req.app not in ivle.conf.apps.app_url:
190
 
        req.throw_error(Request.HTTP_NOT_FOUND,
191
 
            "There is no application called %s." % repr(req.app))
192
 
 
193
 
    # Special handling for public mode - only allow the public app, call it
194
 
    # and get out.
195
 
    # NOTE: This will not behave correctly if the public app uses
196
 
    # write_html_head_foot, but "serve" does not.
197
 
    if req.publicmode:
198
 
        if req.app != ivle.conf.apps.public_app:
199
 
            req.throw_error(Request.HTTP_FORBIDDEN,
200
 
                "This application is not available on the public site.")
201
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
202
 
        apps.call_app(app.dir, req)
 
138
    else:
 
139
        XHTMLErrorView(req, NotFound()).render(req)
203
140
        return req.OK
204
141
 
205
 
    # app is the App object for the chosen app
206
 
    if req.app is None:
207
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
208
 
    else:
209
 
        app = ivle.conf.apps.app_url[req.app]
210
 
 
211
 
    # Check if app requires auth. If so, perform authentication and login.
212
 
    # This will either return a User object, None, or perform a redirect
213
 
    # which we will not catch here.
214
 
    if app.requireauth:
215
 
        req.user = login.login(req)
216
 
        logged_in = req.user is not None
217
 
    else:
218
 
        req.user = login.get_user_details(req)
219
 
        logged_in = True
220
 
 
221
 
    if logged_in:
222
 
        # Keep the user's session alive by writing to the session object.
223
 
        # req.get_session().save()
224
 
        # Well, it's a fine idea, but it creates considerable grief in the
225
 
        # concurrent update department, so instead, we'll just make the
226
 
        # sessions not time out.
227
 
        req.get_session().unlock()
228
 
 
229
 
        # If user did not specify an app, HTTP redirect to default app and
230
 
        # exit.
231
 
        if req.app is None:
232
 
            req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
233
 
 
234
 
        # Set the default title to the app's tab name, if any. Otherwise URL
235
 
        # name.
236
 
        if app.name is not None:
237
 
            req.title = app.name
238
 
        else:
239
 
            req.title = req.app
240
 
 
241
 
        # Call the specified app with the request object
242
 
        apps.call_app(app.dir, req)
243
 
 
244
 
    # if not logged in, login.login will have written the login box.
245
 
    # Just clean up and exit.
246
 
 
247
 
    # MAKE SURE we write the HTTP (and possibly HTML) header. This
248
 
    # wouldn't happen if nothing else ever got written, so we have to make
249
 
    # sure.
250
 
    req.ensure_headers_written()
251
 
 
252
 
    # When done, write out the HTML footer if the app has requested it
253
 
    if req.write_html_head_foot:
254
 
        html.write_html_foot(req)
255
 
 
256
 
    # Note: Apache will not write custom HTML error messages here.
257
 
    # Use req.throw_error to do that.
258
 
    return req.OK
259
 
 
260
142
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
261
143
    """
262
144
    Given an exception that has just been thrown from IVLE, print its details
264
146
    This is a full handler. It assumes nothing has been written, and writes a
265
147
    complete HTML page.
266
148
    req: May be EITHER an IVLE req or an Apache req.
267
 
    IVLE reqs may have the HTML head/foot written (on a 400 error), but
268
 
    the handler code may pass an apache req if an exception occurs before
 
149
    The handler code may pass an apache req if an exception occurs before
269
150
    the IVLE request is created.
270
151
    """
271
152
    req.content_type = "text/html"
272
153
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
273
154
    logfail = False
274
 
    # For some reason, some versions of mod_python have "_server" instead of
275
 
    # "main_server". So we check for both.
276
 
    try:
277
 
        admin_email = mod_python.apache.main_server.server_admin
278
 
    except AttributeError:
279
 
        try:
280
 
            admin_email = mod_python.apache._server.server_admin
281
 
        except AttributeError:
282
 
            admin_email = ""
283
155
    try:
284
156
        httpcode = exc_value.httpcode
285
157
        req.status = httpcode
294
166
        login = req.user.login
295
167
    except AttributeError:
296
168
        login = None
297
 
    try:
298
 
        role = req.user.role
299
 
    except AttributeError:
300
 
        role = None
301
169
 
302
170
    # Log File
303
171
    try:
313
181
            filemode='a')
314
182
    except IOError:
315
183
        logfail = True
316
 
    logging.debug('Logging Unhandled Exception')
317
 
 
318
 
    # We handle 3 types of error.
319
 
    # IVLEErrors with 4xx response codes (client error).
320
 
    # IVLEErrors with 5xx response codes (handled server error).
321
 
    # Other exceptions (unhandled server error).
322
 
    # IVLEErrors should not have other response codes than 4xx or 5xx
323
 
    # (eg. throw_redirect should have been used for 3xx codes).
324
 
    # Therefore, that is treated as an unhandled error.
325
 
 
326
 
    if (exc_type == util.IVLEError and httpcode >= 400
327
 
        and httpcode <= 499):
328
 
        # IVLEErrors with 4xx response codes are client errors.
329
 
        # Therefore, these have a "nice" response (we even coat it in the IVLE
330
 
        # HTML wrappers).
331
 
        
332
 
        req.write_html_head_foot = True
333
 
        req.write_javascript_settings = False
334
 
        req.write('<div id="ivle_padding">\n')
 
184
 
 
185
    # A "bad" error message. We shouldn't get here unless IVLE
 
186
    # misbehaves (which is currently very easy, if things aren't set up
 
187
    # correctly).
 
188
    # Write the traceback.
 
189
    # If this is a non-4xx IVLEError, get the message and httpcode and
 
190
    # make the error message a bit nicer (but still include the
 
191
    # traceback).
 
192
    # We also need to special-case IVLEJailError, as we can get another
 
193
    # almost-exception out of it.
 
194
 
 
195
    codename, msg = None, None
 
196
 
 
197
    if exc_type is util.IVLEJailError:
 
198
        msg = exc_value.type_str + ": " + exc_value.message
 
199
        tb = 'Exception information extracted from IVLEJailError:\n'
 
200
        tb += urllib.unquote(exc_value.info)
 
201
    else:
335
202
        try:
336
203
            codename, msg = req.get_http_codename(httpcode)
337
204
        except AttributeError:
338
 
            codename, msg = None, None
339
 
        # Override the default message with the supplied one,
340
 
        # if available.
341
 
        if exc_value.message is not None:
342
 
            msg = exc_value.message
343
 
        if codename is not None:
344
 
            req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
345
 
        else:
346
 
            req.write("<h1>Error</h1>\n")
347
 
        if msg is not None:
348
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
349
 
        else:
350
 
            req.write("<p>An unknown error occured.</p>\n")
351
 
        
352
 
        # Logging
353
 
        logging.info(str(msg))
354
 
        
355
 
        req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
356
 
        if logfail:
357
 
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
358
 
                %cgi.escape(logfile))
359
 
        req.write('</div>\n')
360
 
        html.write_html_foot(req)
361
 
    else:
362
 
        # A "bad" error message. We shouldn't get here unless IVLE
363
 
        # misbehaves (which is currently very easy, if things aren't set up
364
 
        # correctly).
365
 
        # Write the traceback.
366
 
        # If this is a non-4xx IVLEError, get the message and httpcode and
367
 
        # make the error message a bit nicer (but still include the
368
 
        # traceback).
369
 
        # We also need to special-case IVLEJailError, as we can get another
370
 
        # almost-exception out of it.
371
 
 
372
 
        codename, msg = None, None
373
 
 
374
 
        if exc_type is util.IVLEJailError:
375
 
            msg = exc_value.type_str + ": " + exc_value.message
376
 
            tb = 'Exception information extracted from IVLEJailError:\n'
377
 
            tb += urllib.unquote(exc_value.info)
378
 
        else:
379
 
            try:
380
 
                codename, msg = req.get_http_codename(httpcode)
381
 
            except AttributeError:
382
 
                pass
383
 
            # Override the default message with the supplied one,
384
 
            # if available.
385
 
            if hasattr(exc_value, 'message') and exc_value.message is not None:
386
 
                msg = exc_value.message
387
 
                # Prepend the exception type
388
 
                if exc_type != util.IVLEError:
389
 
                    msg = exc_type.__name__ + ": " + msg
390
 
 
391
 
            tb = ''.join(traceback.format_exception(exc_type, exc_value,
392
 
                                                    exc_traceback))
393
 
 
394
 
        # Logging
395
 
        logging.error('%s\n%s'%(str(msg), tb))
396
 
        # Error messages are only displayed is the user is NOT a student,
397
 
        # or if there has been a problem logging the error message
398
 
        show_errors = (not publicmode) and ((login and \
399
 
                            str(role) != "student") or logfail)
400
 
        req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
 
205
            pass
 
206
 
 
207
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
 
208
                                                exc_traceback))
 
209
 
 
210
    logging.error('%s\n%s'%(str(msg), tb))
 
211
 
 
212
    # Error messages are only displayed is the user is NOT a student,
 
213
    # or if there has been a problem logging the error message
 
214
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
 
215
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
401
216
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
402
217
<html xmlns="http://www.w3.org/1999/xhtml">
403
218
<head><title>IVLE Internal Server Error</title></head>
404
219
<body>
405
220
<h1>IVLE Internal Server Error""")
406
 
        if (show_errors):
407
 
            if (codename is not None
408
 
                        and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
409
 
                req.write(": %s" % cgi.escape(codename))
410
 
        
411
 
        req.write("""</h1>
 
221
    if show_errors:
 
222
        if codename is not None and \
 
223
           httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR:
 
224
            req.write(": %s" % cgi.escape(codename))
 
225
 
 
226
    req.write("""</h1>
412
227
<p>An error has occured which is the fault of the IVLE developers or
413
 
administration. The developers have been notified.</p>
414
 
""")
415
 
        if (show_errors):
416
 
            if msg is not None:
417
 
                req.write("<p>%s</p>\n" % cgi.escape(msg))
418
 
            if httpcode is not None:
419
 
                req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
420
 
            req.write("""
421
 
    <p>Please report this to <a href="mailto:%s">%s</a> (the system
422
 
    administrator). Include the following information:</p>
423
 
    """ % (cgi.escape(admin_email), cgi.escape(admin_email)))
424
 
 
425
 
            req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
426
 
            if logfail:
427
 
                req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
428
 
                    %cgi.escape(logfile))
429
 
        req.write("</body></html>")
 
228
administrators. """)
 
229
 
 
230
    if logfail:
 
231
        req.write("Please report this issue to the server administrators, "
 
232
                  "along with the following information.")
 
233
    else:
 
234
        req.write("Details have been logged for further examination.")
 
235
    req.write("</p>")
 
236
 
 
237
    if show_errors:
 
238
        if msg is not None:
 
239
            req.write("<p>%s</p>\n" % cgi.escape(msg))
 
240
        if httpcode is not None:
 
241
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
 
242
        req.write("<h2>Debugging information</h2>")
 
243
 
 
244
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
 
245
    req.write("</body></html>")