← 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: Matt Giuca
  • Date: 2009-03-24 08:03:53 UTC
  • mto: This revision was merged to the branch mainline in revision 1322.
  • Revision ID: matt.giuca@gmail.com-20090324080353-1w4oduwp7elujgs8
Fleshed out the documentation structure a bit.
Added a high-level description of the system on the front page, and 'dev' and
'man' sections.

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