← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Restore the media files (just help.css) to the new help system.

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