← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Split up ivle.webapp.base.views into ivle.webapp.base.{rest,xhtml}, as it was
getting rather large and messy.

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