← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Port ivle.webapp.admin.user's media to the new framework.

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