← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Replaced Python config files (conf.py) with new config files system, using
    configobj (INI-file style config files).

setup.py config now produces ./etc/ivle.conf, a new-style config file.
ivle/conf/conf.py is now part of the IVLE source code. It reads the new config
file and provides the same legacy interface, so all of IVLE still functions,
including setup.py config.

Added /etc to the source tree (config files will be stored here).
Added configobj as a dependency in doc/setup/install_proc.txt.

setup.py install copies ./etc/ivle.conf into /etc/ivle/ivle.conf.

Removed boilerplate code generation from setup/configure.py (that code is now
part of ivle/conf/conf.py which is now in the source tree).

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