← 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-24 06:01:52 UTC
  • mfrom: (1099.5.5 new-dispatch)
  • mto: This revision was merged to the branch mainline in revision 1119.
  • Revision ID: grantw@unimelb.edu.au-20090224060152-136r6lj6zc2eaexp
Merge my console and tutorial changes.

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