← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Allow any authenticated (even invalid) user to use the logout view.

Show diffs side-by-side

added added

removed removed

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