← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

ivle.webapp.testing: Add, with fake request and user.
ivle.webapp.base.test: Add! Test the JSONRESTView, using the new mocks.

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
40
40
import routes
41
41
 
42
42
from ivle import util
43
 
import ivle.config
 
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
 
config = ivle.config.Config()
51
 
 
52
 
def generate_router(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
# Elements are (module, classname) pairs.
 
53
plugins_HACK = [
 
54
    ('ivle.webapp.admin.user', 'Plugin'),
 
55
]
 
56
 
 
57
def get_routes_mapper():
53
58
    """
54
59
    Build a Mapper object for doing URL matching using 'routes', based on the
55
 
    given plugin registry.
 
60
    plugins config.
56
61
    """
57
 
    m = routes.Mapper(explicit=True)
58
 
    for plugin in view_plugins:
 
62
    m = routes.Mapper()
 
63
    for plugin_path, classname in plugins_HACK:
 
64
        # Load the plugin module from somewhere in the Python path
 
65
        # (Note that plugin_path is a fully-qualified Python module name).
 
66
        plugin = getattr(__import__(plugin_path, fromlist=[classname]),
 
67
            classname)
59
68
        # Establish a URL pattern for each element of plugin.urls
60
 
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
61
 
        for url in getattr(plugin, attr):
 
69
        for url in plugin.urls:
62
70
            routex = url[0]
63
71
            view_class = url[1]
64
72
            kwargs_dict = url[2] if len(url) >= 3 else {}
65
73
            m.connect(routex, view=view_class, **kwargs_dict)
66
74
    return m
67
75
 
68
 
def handler(apachereq):
69
 
    """Handles an HTTP request.
70
 
 
 
76
def handler(req):
 
77
    """Handles a request which may be to anywhere in the site except media.
71
78
    Intended to be called by mod_python, as a handler.
72
79
 
73
 
    @param apachereq: An Apache request object.
74
 
    """
75
 
    # Make the request object into an IVLE request which can be given to views
76
 
    req = Request(apachereq, config)
77
 
 
 
80
    req: An Apache request object.
 
81
    """
 
82
    # Make the request object into an IVLE request which can be passed to apps
 
83
    apachereq = req
 
84
    try:
 
85
        req = Request(req, html.write_html_head)
 
86
    except Exception:
 
87
        # Pass the apachereq to error reporter, since ivle req isn't created
 
88
        # yet.
 
89
        handle_unknown_exception(apachereq, *sys.exc_info())
 
90
        # Tell Apache not to generate its own errors as well
 
91
        return mod_python.apache.OK
 
92
 
 
93
    # Run the main handler, and catch all exceptions
 
94
    try:
 
95
        return handler_(req, apachereq)
 
96
    except mod_python.apache.SERVER_RETURN:
 
97
        # An apache error. We discourage these, but they might still happen.
 
98
        # Just raise up.
 
99
        raise
 
100
    except Exception:
 
101
        handle_unknown_exception(req, *sys.exc_info())
 
102
        # Tell Apache not to generate its own errors as well
 
103
        return mod_python.apache.OK
 
104
 
 
105
def handler_(req, apachereq):
 
106
    """
 
107
    Nested handler function. May raise exceptions. The top-level handler is
 
108
    just used to catch exceptions.
 
109
    Takes both an IVLE request and an Apache req.
 
110
    """
78
111
    # Hack? Try and get the user login early just in case we throw an error
79
112
    # (most likely 404) to stop us seeing not logged in even when we are.
80
113
    if not req.publicmode:
81
 
        user = ivle.webapp.security.get_user_details(req)
82
 
 
83
 
        # Don't set the user if it is disabled or hasn't accepted the ToS.
84
 
        if user and user.valid:
85
 
            req.user = user
86
 
 
87
 
    if req.publicmode:
88
 
        req.mapper = generate_router(config.plugin_index[PublicViewPlugin],
89
 
                                    'public_urls')
90
 
    else:
91
 
        req.mapper = generate_router(config.plugin_index[ViewPlugin], 'urls')
92
 
 
93
 
    matchdict = req.mapper.match(req.uri)
 
114
        req.user = login.get_user_details(req)
 
115
 
 
116
    ### BEGIN New plugins framework ###
 
117
    # XXX This should be done ONCE per Python process, not per request.
 
118
    # (Wait till WSGI)
 
119
    # XXX No authentication is done here
 
120
    mapper = get_routes_mapper()
 
121
    matchdict = mapper.match(req.uri)
94
122
    if matchdict is not None:
95
123
        viewcls = matchdict['view']
96
124
        # Get the remaining arguments, less 'view', 'action' and 'controller'
97
125
        # (The latter two seem to be built-in, and we don't want them).
98
126
        kwargs = matchdict.copy()
99
127
        del kwargs['view']
100
 
        try:
101
 
            # Instantiate the view, which should be a BaseView class
102
 
            view = viewcls(req, **kwargs)
103
 
 
104
 
            # Check that the request (mainly the user) is permitted to access
105
 
            # the view.
106
 
            if not view.authorize(req):
107
 
                raise Unauthorized()
108
 
            # Render the output
109
 
            view.render(req)
110
 
        except HTTPError, e:
111
 
            # A view explicitly raised an HTTP error. Respect it.
112
 
            req.status = e.code
113
 
 
114
 
            # Try to find a custom error view.
115
 
            if hasattr(viewcls, 'get_error_view'):
116
 
                errviewcls = viewcls.get_error_view(e)
117
 
            else:
118
 
                errviewcls = XHTMLView.get_error_view(e)
119
 
 
120
 
            if errviewcls:
121
 
                errview = errviewcls(req, e)
122
 
                errview.render(req)
123
 
                return req.OK
124
 
            elif e.message:
125
 
                req.write(e.message)
126
 
                return req.OK
127
 
            else:
128
 
                return e.code
129
 
        except mod_python.apache.SERVER_RETURN:
130
 
            # A mod_python-specific Apache error.
131
 
            # XXX: We need to raise these because req.throw_error() uses them.
132
 
            # Remove this after Google Code issue 117 is fixed.
133
 
            raise
134
 
        except Exception, e:
135
 
            # A non-HTTPError appeared. We have an unknown exception. Panic.
136
 
            handle_unknown_exception(req, *sys.exc_info())
137
 
            return req.OK
 
128
        del kwargs['action']
 
129
        del kwargs['controller']
 
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
138
188
        else:
139
 
            req.store.commit()
140
 
            return req.OK
141
 
    else:
142
 
        XHTMLErrorView(req, NotFound()).render(req)
143
 
        return req.OK
 
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
144
212
 
145
213
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
146
214
    """
149
217
    This is a full handler. It assumes nothing has been written, and writes a
150
218
    complete HTML page.
151
219
    req: May be EITHER an IVLE req or an Apache req.
152
 
    The handler code may pass an apache req if an exception occurs before
 
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
153
222
    the IVLE request is created.
154
223
    """
155
224
    req.content_type = "text/html"
156
 
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
 
225
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
157
226
    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 = ""
158
236
    try:
159
237
        httpcode = exc_value.httpcode
160
238
        req.status = httpcode
169
247
        login = req.user.login
170
248
    except AttributeError:
171
249
        login = None
 
250
    try:
 
251
        role = req.user.role
 
252
    except AttributeError:
 
253
        role = None
172
254
 
173
255
    # Log File
174
256
    try:
184
266
            filemode='a')
185
267
    except IOError:
186
268
        logfail = True
187
 
 
188
 
    # A "bad" error message. We shouldn't get here unless IVLE
189
 
    # misbehaves (which is currently very easy, if things aren't set up
190
 
    # correctly).
191
 
    # Write the traceback.
192
 
    # If this is a non-4xx IVLEError, get the message and httpcode and
193
 
    # make the error message a bit nicer (but still include the
194
 
    # traceback).
195
 
    # We also need to special-case IVLEJailError, as we can get another
196
 
    # almost-exception out of it.
197
 
 
198
 
    codename, msg = None, None
199
 
 
200
 
    if exc_type is util.IVLEJailError:
201
 
        msg = exc_value.type_str + ": " + exc_value.message
202
 
        tb = 'Exception information extracted from IVLEJailError:\n'
203
 
        tb += urllib.unquote(exc_value.info)
204
 
    else:
 
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')
205
288
        try:
206
289
            codename, msg = req.get_http_codename(httpcode)
207
290
        except AttributeError:
208
 
            pass
209
 
 
210
 
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
211
 
                                                exc_traceback))
212
 
 
213
 
    logging.error('%s\n%s'%(str(msg), tb))
214
 
 
215
 
    # Error messages are only displayed is the user is NOT a student,
216
 
    # or if there has been a problem logging the error message
217
 
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
218
 
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
 
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"                 
219
354
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
220
355
<html xmlns="http://www.w3.org/1999/xhtml">
221
356
<head><title>IVLE Internal Server Error</title></head>
222
357
<body>
223
358
<h1>IVLE Internal Server Error""")
224
 
    if show_errors:
225
 
        if codename is not None and \
226
 
           httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR:
227
 
            req.write(": %s" % cgi.escape(codename))
228
 
 
229
 
    req.write("""</h1>
 
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>
230
365
<p>An error has occured which is the fault of the IVLE developers or
231
 
administrators. """)
232
 
 
233
 
    if logfail:
234
 
        req.write("Please report this issue to the server administrators, "
235
 
                  "along with the following information.")
236
 
    else:
237
 
        req.write("Details have been logged for further examination.")
238
 
    req.write("</p>")
239
 
 
240
 
    if show_errors:
241
 
        if msg is not None:
242
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
243
 
        if httpcode is not None:
244
 
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
245
 
        req.write("<h2>Debugging information</h2>")
246
 
 
247
 
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
248
 
    req.write("</body></html>")
 
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>")