← 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.base.rest#RESTView: Remove broken old render() - it should be
                                implemented by subclasses.
                     #JSONRESTView: Remove an impossible assertion, and fix
                                    some exception message spacing.
ivle.webapp.base.test.test_rest: Add a named operation with both default and
                                 non-default arguments, and check that we die
                                 properly when the non-default is unspecified.

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