← 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: Nick Chadwick
  • Date: 2009-02-23 23:11:26 UTC
  • mto: (1099.1.227 exercise-ui)
  • mto: This revision was merged to the branch mainline in revision 1100.
  • Revision ID: chadnickbok@gmail.com-20090223231126-zfb5wfw8jnxazefl
Fixed database so that lecturers can edit worksheets

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