← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Merged from trunk

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, Unauthorized
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.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',
71
 
] 
72
 
 
73
 
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):
74
51
    """
75
52
    Build a Mapper object for doing URL matching using 'routes', based on the
76
53
    given plugin registry.
79
56
    for plugin in view_plugins:
80
57
        # Establish a URL pattern for each element of plugin.urls
81
58
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
82
 
        for url in plugin.urls:
 
59
        for url in getattr(plugin, attr):
83
60
            routex = url[0]
84
61
            view_class = url[1]
85
62
            kwargs_dict = url[2] if len(url) >= 3 else {}
86
63
            m.connect(routex, view=view_class, **kwargs_dict)
87
64
    return m
88
65
 
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).
93
 
    return (plugin_path,
94
 
            getattr(__import__(plugin_path, fromlist=[classname]), classname))
 
66
def handler(apachereq):
 
67
    """Handles an HTTP request.
95
68
 
96
 
def handler(req):
97
 
    """Handles a request which may be to anywhere in the site except media.
98
69
    Intended to be called by mod_python, as a handler.
99
70
 
100
 
    req: An Apache request object.
101
 
    """
102
 
    # Make the request object into an IVLE request which can be passed to apps
103
 
    apachereq = req
104
 
    try:
105
 
        req = Request(req, html.write_html_head)
106
 
    except Exception:
107
 
        # Pass the apachereq to error reporter, since ivle req isn't created
108
 
        # yet.
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
112
 
 
113
 
    # Run the main handler, and catch all exceptions
114
 
    try:
115
 
        return handler_(req, apachereq)
116
 
    except mod_python.apache.SERVER_RETURN:
117
 
        # An apache error. We discourage these, but they might still happen.
118
 
        # Just raise up.
119
 
        raise
120
 
    except Exception:
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
124
 
 
125
 
def handler_(req, apachereq):
126
 
    """
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.
130
 
    """
 
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
 
131
76
    # Hack? Try and get the user login early just in case we throw an error
132
77
    # (most likely 404) to stop us seeing not logged in even when we are.
133
78
    if not req.publicmode:
134
 
        user = login.get_user_details(req)
 
79
        user = ivle.webapp.security.get_user_details(req)
135
80
 
136
81
        # Don't set the user if it is disabled or hasn't accepted the ToS.
137
82
        if user and user.valid:
138
83
            req.user = user
139
84
 
140
 
    ### BEGIN New plugins framework ###
141
 
    # XXX This should be done ONCE per Python process, not per request.
142
 
    # (Wait till WSGI)
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()])
153
 
    req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
 
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')
154
94
 
155
95
    matchdict = req.mapper.match(req.uri)
156
96
    if matchdict is not None:
177
117
            if hasattr(viewcls, 'get_error_view'):
178
118
                errviewcls = viewcls.get_error_view(e)
179
119
            else:
180
 
                errviewcls = None
 
120
                errviewcls = XHTMLView.get_error_view(e)
181
121
 
182
122
            if errviewcls:
183
123
                errview = errviewcls(req, e)
195
135
        else:
196
136
            req.store.commit()
197
137
            return req.OK
198
 
    ### END New plugins framework ###
199
 
 
200
 
    # Check req.app to see if it is valid. 404 if not.
201
 
    if req.app is not None and req.app not in ivle.conf.apps.app_url:
202
 
        req.throw_error(Request.HTTP_NOT_FOUND,
203
 
            "There is no application called %s." % repr(req.app))
204
 
 
205
 
    # Special handling for public mode - only allow the public app, call it
206
 
    # and get out.
207
 
    # NOTE: This will not behave correctly if the public app uses
208
 
    # write_html_head_foot, but "serve" does not.
209
 
    if req.publicmode:
210
 
        if req.app != ivle.conf.apps.public_app:
211
 
            req.throw_error(Request.HTTP_FORBIDDEN,
212
 
                "This application is not available on the public site.")
213
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
214
 
        apps.call_app(app.dir, req)
 
138
    else:
 
139
        XHTMLErrorView(req, NotFound()).render(req)
215
140
        return req.OK
216
141
 
217
 
    # app is the App object for the chosen app
218
 
    if req.app is None:
219
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
220
 
    else:
221
 
        app = ivle.conf.apps.app_url[req.app]
222
 
 
223
 
    # Check if app requires auth. If so, perform authentication and login.
224
 
    # This will either return a User object, None, or perform a redirect
225
 
    # which we will not catch here.
226
 
    if app.requireauth:
227
 
        logged_in = req.user is not None
228
 
    else:
229
 
        logged_in = True
230
 
 
231
 
    assert logged_in # XXX
232
 
 
233
 
    if logged_in:
234
 
        # Keep the user's session alive by writing to the session object.
235
 
        # req.get_session().save()
236
 
        # Well, it's a fine idea, but it creates considerable grief in the
237
 
        # concurrent update department, so instead, we'll just make the
238
 
        # sessions not time out.
239
 
        req.get_session().unlock()
240
 
 
241
 
        # If user did not specify an app, HTTP redirect to default app and
242
 
        # exit.
243
 
        if req.app is None:
244
 
            req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
245
 
 
246
 
        # Set the default title to the app's tab name, if any. Otherwise URL
247
 
        # name.
248
 
        if app.name is not None:
249
 
            req.title = app.name
250
 
        else:
251
 
            req.title = req.app
252
 
 
253
 
        # Call the specified app with the request object
254
 
        apps.call_app(app.dir, req)
255
 
 
256
 
    # if not logged in, login.login will have written the login box.
257
 
    # Just clean up and exit.
258
 
 
259
 
    # MAKE SURE we write the HTTP (and possibly HTML) header. This
260
 
    # wouldn't happen if nothing else ever got written, so we have to make
261
 
    # sure.
262
 
    req.ensure_headers_written()
263
 
 
264
 
    # When done, write out the HTML footer if the app has requested it
265
 
    if req.write_html_head_foot:
266
 
        html.write_html_foot(req)
267
 
 
268
 
    # Note: Apache will not write custom HTML error messages here.
269
 
    # Use req.throw_error to do that.
270
 
    return req.OK
271
 
 
272
142
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
273
143
    """
274
144
    Given an exception that has just been thrown from IVLE, print its details
276
146
    This is a full handler. It assumes nothing has been written, and writes a
277
147
    complete HTML page.
278
148
    req: May be EITHER an IVLE req or an Apache req.
279
 
    IVLE reqs may have the HTML head/foot written (on a 400 error), but
280
 
    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
281
150
    the IVLE request is created.
282
151
    """
283
152
    req.content_type = "text/html"
284
153
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
285
154
    logfail = False
286
 
    # For some reason, some versions of mod_python have "_server" instead of
287
 
    # "main_server". So we check for both.
288
 
    try:
289
 
        admin_email = mod_python.apache.main_server.server_admin
290
 
    except AttributeError:
291
 
        try:
292
 
            admin_email = mod_python.apache._server.server_admin
293
 
        except AttributeError:
294
 
            admin_email = ""
295
155
    try:
296
156
        httpcode = exc_value.httpcode
297
157
        req.status = httpcode
306
166
        login = req.user.login
307
167
    except AttributeError:
308
168
        login = None
309
 
    try:
310
 
        role = req.user.role
311
 
    except AttributeError:
312
 
        role = None
313
169
 
314
170
    # Log File
315
171
    try:
325
181
            filemode='a')
326
182
    except IOError:
327
183
        logfail = True
328
 
    logging.debug('Logging Unhandled Exception')
329
 
 
330
 
    # We handle 3 types of error.
331
 
    # IVLEErrors with 4xx response codes (client error).
332
 
    # IVLEErrors with 5xx response codes (handled server error).
333
 
    # Other exceptions (unhandled server error).
334
 
    # IVLEErrors should not have other response codes than 4xx or 5xx
335
 
    # (eg. throw_redirect should have been used for 3xx codes).
336
 
    # Therefore, that is treated as an unhandled error.
337
 
 
338
 
    if (exc_type == util.IVLEError and httpcode >= 400
339
 
        and httpcode <= 499):
340
 
        # IVLEErrors with 4xx response codes are client errors.
341
 
        # Therefore, these have a "nice" response (we even coat it in the IVLE
342
 
        # HTML wrappers).
343
 
        
344
 
        req.write_html_head_foot = True
345
 
        req.write_javascript_settings = False
346
 
        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:
347
202
        try:
348
203
            codename, msg = req.get_http_codename(httpcode)
349
204
        except AttributeError:
350
 
            codename, msg = None, None
351
 
        # Override the default message with the supplied one,
352
 
        # if available.
353
 
        if exc_value.message is not None:
354
 
            msg = exc_value.message
355
 
        if codename is not None:
356
 
            req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
357
 
        else:
358
 
            req.write("<h1>Error</h1>\n")
359
 
        if msg is not None:
360
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
361
 
        else:
362
 
            req.write("<p>An unknown error occured.</p>\n")
363
 
        
364
 
        # Logging
365
 
        logging.info(str(msg))
366
 
        
367
 
        req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
368
 
        if logfail:
369
 
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
370
 
                %cgi.escape(logfile))
371
 
        req.write('</div>\n')
372
 
        html.write_html_foot(req)
373
 
    else:
374
 
        # A "bad" error message. We shouldn't get here unless IVLE
375
 
        # misbehaves (which is currently very easy, if things aren't set up
376
 
        # correctly).
377
 
        # Write the traceback.
378
 
        # If this is a non-4xx IVLEError, get the message and httpcode and
379
 
        # make the error message a bit nicer (but still include the
380
 
        # traceback).
381
 
        # We also need to special-case IVLEJailError, as we can get another
382
 
        # almost-exception out of it.
383
 
 
384
 
        codename, msg = None, None
385
 
 
386
 
        if exc_type is util.IVLEJailError:
387
 
            msg = exc_value.type_str + ": " + exc_value.message
388
 
            tb = 'Exception information extracted from IVLEJailError:\n'
389
 
            tb += urllib.unquote(exc_value.info)
390
 
        else:
391
 
            try:
392
 
                codename, msg = req.get_http_codename(httpcode)
393
 
            except AttributeError:
394
 
                pass
395
 
            # Override the default message with the supplied one,
396
 
            # if available.
397
 
            if hasattr(exc_value, 'message') and exc_value.message is not None:
398
 
                msg = exc_value.message
399
 
                # Prepend the exception type
400
 
                if exc_type != util.IVLEError:
401
 
                    msg = exc_type.__name__ + ": " + msg
402
 
 
403
 
            tb = ''.join(traceback.format_exception(exc_type, exc_value,
404
 
                                                    exc_traceback))
405
 
 
406
 
        # Logging
407
 
        logging.error('%s\n%s'%(str(msg), tb))
408
 
        # Error messages are only displayed is the user is NOT a student,
409
 
        # or if there has been a problem logging the error message
410
 
        show_errors = (not publicmode) and ((login and \
411
 
                            str(role) != "student") or logfail)
412
 
        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"                 
413
216
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
414
217
<html xmlns="http://www.w3.org/1999/xhtml">
415
218
<head><title>IVLE Internal Server Error</title></head>
416
219
<body>
417
220
<h1>IVLE Internal Server Error""")
418
 
        if (show_errors):
419
 
            if (codename is not None
420
 
                        and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
421
 
                req.write(": %s" % cgi.escape(codename))
422
 
        
423
 
        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>
424
227
<p>An error has occured which is the fault of the IVLE developers or
425
 
administration. The developers have been notified.</p>
426
 
""")
427
 
        if (show_errors):
428
 
            if msg is not None:
429
 
                req.write("<p>%s</p>\n" % cgi.escape(msg))
430
 
            if httpcode is not None:
431
 
                req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
432
 
            req.write("""
433
 
    <p>Please report this to <a href="mailto:%s">%s</a> (the system
434
 
    administrator). Include the following information:</p>
435
 
    """ % (cgi.escape(admin_email), cgi.escape(admin_email)))
436
 
 
437
 
            req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
438
 
            if logfail:
439
 
                req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
440
 
                    %cgi.escape(logfile))
441
 
        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>")