← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Move the remaining images to the new framework, in the new ivle.webapp.core
plugin.

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