← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

  • Committer: William Grant
  • Date: 2010-02-24 01:38:33 UTC
  • Revision ID: grantw@unimelb.edu.au-20100224013833-u3hff23a3wbwsa9q
Refactor UserEditView to use BaseFormView.

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 (not authorization).
26
 
Then passes the request along to the appropriate ivle app.
 
25
Handles authentication and delegates to views for authorization,
 
26
then passes the request along to the appropriate view.
27
27
"""
28
28
 
29
29
import sys
30
30
import os
31
31
import os.path
32
32
import urllib
 
33
import urlparse
33
34
import cgi
34
35
import traceback
35
36
import logging
37
38
import time
38
39
 
39
40
import mod_python
40
 
import routes
41
41
 
42
42
from ivle import util
43
 
import ivle.conf
44
 
import ivle.conf.apps
 
43
import ivle.config
45
44
from ivle.dispatch.request import Request
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():
 
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 BadRequest, HTTPError, NotFound, Unauthorized
 
49
from ivle.webapp.publisher import Publisher, PublishingError
 
50
from ivle.webapp import ApplicationRoot
 
51
 
 
52
config = ivle.config.Config()
 
53
 
 
54
class ObjectPermissionCheckingPublisher(Publisher):
 
55
    """A specialised publisher that checks object permissions.
 
56
 
 
57
    This publisher verifies that the user holds any permission at all
 
58
    on the model objects through which the resolution path passes. If
 
59
    no permission is held, resolution is aborted with an Unauthorized
 
60
    exception.
 
61
 
 
62
    IMPORTANT: This does NOT check view permissions. It only checks
 
63
    the objects in between the root and the view, exclusive!
 
64
    """
 
65
 
 
66
    def traversed_to_object(self, obj):
 
67
        """Check that the user has any permission at all over the object."""
 
68
        if (hasattr(obj, 'get_permissions') and
 
69
            len(obj.get_permissions(self.root.user, config)) == 0):
 
70
            # Indicate the forbidden object if this is an admin.
 
71
            if self.root.user and self.root.user.admin:
 
72
                raise Unauthorized('Unauthorized: %s' % obj)
 
73
            else:
 
74
                raise Unauthorized()
 
75
 
 
76
 
 
77
def generate_publisher(view_plugins, root, publicmode=False):
62
78
    """
63
79
    Build a Mapper object for doing URL matching using 'routes', based on the
64
 
    plugins config.
 
80
    given plugin registry.
65
81
    """
66
 
    m = routes.Mapper(explicit=True)
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)
73
 
        # Establish a URL pattern for each element of plugin.urls
74
 
        for url in plugin.urls:
75
 
            routex = url[0]
76
 
            view_class = url[1]
77
 
            kwargs_dict = url[2] if len(url) >= 3 else {}
78
 
            m.connect(routex, view=view_class, **kwargs_dict)
79
 
    return m
80
 
 
81
 
def handler(req):
82
 
    """Handles a request which may be to anywhere in the site except media.
 
82
    r = ObjectPermissionCheckingPublisher(root=root)
 
83
 
 
84
    r.add_set_switch('api', 'api')
 
85
 
 
86
    if publicmode:
 
87
        view_attr = 'public_views'
 
88
        forward_route_attr = 'public_forward_routes'
 
89
        reverse_route_attr = 'public_reverse_routes'
 
90
    else:
 
91
        view_attr = 'views'
 
92
        forward_route_attr = 'forward_routes'
 
93
        reverse_route_attr = 'reverse_routes'
 
94
 
 
95
 
 
96
    for plugin in view_plugins:
 
97
        if hasattr(plugin, forward_route_attr):
 
98
            for fr in getattr(plugin, forward_route_attr):
 
99
                # An annotated function can also be passed in directly.
 
100
                if hasattr(fr, '_forward_route_meta'):
 
101
                    r.add_forward_func(fr)
 
102
                else:
 
103
                    r.add_forward(*fr)
 
104
 
 
105
        if hasattr(plugin, reverse_route_attr):
 
106
            for rr in getattr(plugin, reverse_route_attr):
 
107
                # An annotated function can also be passed in directly.
 
108
                if hasattr(rr, '_reverse_route_src'):
 
109
                    r.add_reverse_func(rr)
 
110
                else:
 
111
                    r.add_reverse(*rr)
 
112
 
 
113
        if hasattr(plugin, view_attr):
 
114
            for v in getattr(plugin, view_attr):
 
115
                r.add_view(*v)
 
116
 
 
117
    return r
 
118
 
 
119
def handler(apachereq):
 
120
    """Handles an HTTP request.
 
121
 
83
122
    Intended to be called by mod_python, as a handler.
84
123
 
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
 
    """
 
124
    @param apachereq: An Apache request object.
 
125
    """
 
126
    # Make the request object into an IVLE request which can be given to views
 
127
    req = Request(apachereq, config)
 
128
 
116
129
    # Hack? Try and get the user login early just in case we throw an error
117
130
    # (most likely 404) to stop us seeing not logged in even when we are.
118
131
    if not req.publicmode:
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()
126
 
    matchdict = req.mapper.match(req.uri)
127
 
    if matchdict is not None:
128
 
        viewcls = matchdict['view']
129
 
        # Get the remaining arguments, less 'view', 'action' and 'controller'
130
 
        # (The latter two seem to be built-in, and we don't want them).
131
 
        kwargs = matchdict.copy()
132
 
        del kwargs['view']
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
191
 
        else:
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
 
132
        user = ivle.webapp.security.get_user_details(req)
 
133
 
 
134
        # Don't set the user if it is disabled or hasn't accepted the ToS.
 
135
        if user and user.valid:
 
136
            req.user = user
 
137
 
 
138
    req.publisher = generate_publisher(
 
139
        config.plugin_index[ViewPlugin],
 
140
        ApplicationRoot(req.config, req.store, req.user),
 
141
        publicmode=req.publicmode)
 
142
 
 
143
    try:
 
144
        obj, viewcls, subpath = req.publisher.resolve(req.uri.decode('utf-8'))
 
145
        try:
 
146
            # We 404 if we have a subpath but the view forbids it.
 
147
            if not viewcls.subpath_allowed and subpath:
 
148
                raise NotFound()
 
149
 
 
150
            # Instantiate the view, which should be a BaseView class
 
151
            view = viewcls(req, obj, subpath)
 
152
 
 
153
            # Check that the request (mainly the user) is permitted to access
 
154
            # the view.
 
155
            if not view.authorize(req):
 
156
                # Indicate the forbidden object if this is an admin.
 
157
                if req.user and req.user.admin:
 
158
                    raise Unauthorized('Unauthorized: %s' % view)
 
159
                else:
 
160
                    raise Unauthorized()
 
161
 
 
162
            # Non-GET requests from other sites leave us vulnerable to
 
163
            # CSRFs. Block them.
 
164
            referer = req.headers_in.get('Referer')
 
165
            if (referer is None or
 
166
                urlparse.urlparse(req.headers_in.get('Referer')).netloc !=
 
167
                    req.hostname):
 
168
                if req.method != 'GET' and not view.offsite_posts_allowed:
 
169
                    raise BadRequest(
 
170
                        "Non-GET requests from external sites are forbidden "
 
171
                        "for security reasons.")
 
172
 
 
173
            # Render the output
 
174
            view.render(req)
 
175
        except HTTPError, e:
 
176
            # A view explicitly raised an HTTP error. Respect it.
 
177
            req.status = e.code
 
178
 
 
179
            # Try to find a custom error view.
 
180
            if hasattr(viewcls, 'get_error_view'):
 
181
                errviewcls = viewcls.get_error_view(e)
 
182
            else:
 
183
                errviewcls = XHTMLView.get_error_view(e)
 
184
 
 
185
            if errviewcls:
 
186
                errview = errviewcls(req, e, obj)
 
187
                errview.render(req)
 
188
                return req.OK
 
189
            elif e.message:
 
190
                req.write(e.message)
 
191
                return req.OK
 
192
            else:
 
193
                return e.code
 
194
        except mod_python.apache.SERVER_RETURN:
 
195
            # A mod_python-specific Apache error.
 
196
            # XXX: We need to raise these because req.throw_error() uses them.
 
197
            # Remove this after Google Code issue 117 is fixed.
 
198
            raise
 
199
        except Exception, e:
 
200
            # A non-HTTPError appeared. We have an unknown exception. Panic.
 
201
            handle_unknown_exception(req, *sys.exc_info())
 
202
            return req.OK
 
203
        else:
 
204
            req.store.commit()
 
205
            return req.OK
 
206
    except Unauthorized, e:
 
207
        # Resolution failed due to a permission check. Display a pretty
 
208
        # error, or maybe a login page.
 
209
        XHTMLView.get_error_view(e)(req, e, req.publisher.root).render(req)
 
210
        return req.OK
 
211
    except PublishingError, e:
 
212
        req.status = 404
 
213
 
 
214
        if req.user and req.user.admin:
 
215
            XHTMLErrorView(req, NotFound('Not found: ' +
 
216
                                         str(e.args)), e[0]).render(req)
 
217
        else:
 
218
            XHTMLErrorView(req, NotFound(), e[0]).render(req)
 
219
 
 
220
        return req.OK
 
221
    finally:
 
222
        req.store.close()
215
223
 
216
224
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
217
225
    """
220
228
    This is a full handler. It assumes nothing has been written, and writes a
221
229
    complete HTML page.
222
230
    req: May be EITHER an IVLE req or an Apache req.
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
 
231
    The handler code may pass an apache req if an exception occurs before
225
232
    the IVLE request is created.
226
233
    """
227
234
    req.content_type = "text/html"
228
 
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
 
235
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
229
236
    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 = ""
 
237
 
 
238
    # XXX: This remains here for ivle.interpret's IVLEErrors. Once we rewrite
 
239
    #      fileservice, req.status should always be 500 (ISE) here.
239
240
    try:
240
241
        httpcode = exc_value.httpcode
241
242
        req.status = httpcode
242
243
    except AttributeError:
243
244
        httpcode = None
244
245
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
246
 
245
247
    try:
246
248
        publicmode = req.publicmode
247
249
    except AttributeError:
250
252
        login = req.user.login
251
253
    except AttributeError:
252
254
        login = None
253
 
    try:
254
 
        role = req.user.role
255
 
    except AttributeError:
256
 
        role = None
257
255
 
258
256
    # Log File
259
257
    try:
269
267
            filemode='a')
270
268
    except IOError:
271
269
        logfail = True
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')
291
 
        try:
292
 
            codename, msg = req.get_http_codename(httpcode)
293
 
        except AttributeError:
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)
 
270
 
 
271
    # A "bad" error message. We shouldn't get here unless IVLE
 
272
    # misbehaves (which is currently very easy, if things aren't set up
 
273
    # correctly).
 
274
    # Write the traceback.
 
275
 
 
276
    # We need to special-case IVLEJailError, as we can get another
 
277
    # almost-exception out of it.
 
278
    if exc_type is util.IVLEJailError:
 
279
        tb = 'Exception information extracted from IVLEJailError:\n'
 
280
        tb += urllib.unquote(exc_value.info)
317
281
    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"                 
 
282
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
 
283
                                                exc_traceback))
 
284
 
 
285
    logging.error('\n' + tb)
 
286
 
 
287
    # Error messages are only displayed is the user is NOT a student,
 
288
    # or if there has been a problem logging the error message
 
289
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
 
290
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
357
291
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
358
292
<html xmlns="http://www.w3.org/1999/xhtml">
359
293
<head><title>IVLE Internal Server Error</title></head>
360
294
<body>
361
 
<h1>IVLE Internal Server Error""")
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>
 
295
<h1>IVLE Internal Server Error</h1>
368
296
<p>An error has occured which is the fault of the IVLE developers or
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>")
 
297
administrators. """)
 
298
 
 
299
    if logfail:
 
300
        req.write("Please report this issue to the server administrators, "
 
301
                  "along with the following information.")
 
302
    else:
 
303
        req.write("Details have been logged for further examination.")
 
304
    req.write("</p>")
 
305
 
 
306
    if show_errors:
 
307
        req.write("<h2>Debugging information</h2>")
 
308
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
 
309
    req.write("</body></html>")