← 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-15 05:37:50 UTC
  • Revision ID: grantw@unimelb.edu.au-20100215053750-hihmegnp8e7dshc2
Ignore test coverage files.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/__init__.py
1
 
# IVLE
2
 
# Copyright (C) 2007-2008 The University of Melbourne
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2009 The University of Melbourne
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
17
 
18
 
# Module: dispatch
19
 
# Author: Matt Giuca
20
 
# Date: 11/12/2007
21
 
 
22
 
# This is a mod_python handler program. The correct way to call it is to have
23
 
# Apache send all requests to be handled by the module 'dispatch'.
24
 
 
25
 
# Top-level handler. Handles all requests to all pages in IVLE.
26
 
# Handles authentication (not authorization).
27
 
# Then passes the request along to the appropriate ivle app.
 
18
# Author: Matt Giuca, Will Grant
 
19
 
 
20
"""
 
21
This is a mod_python handler program. The correct way to call it is to have
 
22
Apache send all requests to be handled by the module 'dispatch'.
 
23
 
 
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.
 
27
"""
28
28
 
29
29
import sys
30
30
import os
37
37
import time
38
38
 
39
39
import mod_python
40
 
from mod_python import apache, Cookie
41
40
 
42
41
from ivle import util
43
 
import ivle.conf
44
 
import ivle.conf.apps
45
 
import apps
46
 
import login
47
 
import html
48
 
from request import Request
49
 
import plugins.console # XXX: Relies on www/ being in the Python path.
50
 
 
51
 
# List of cookies that IVLE uses (to be removed at logout)
52
 
ivle_cookies = ["ivleforumcookie", "clipboard"]
53
 
 
54
 
def handler(req):
55
 
    """Handles a request which may be to anywhere in the site except media.
 
42
import ivle.config
 
43
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.publisher import Publisher, PublishingError
 
49
from ivle.webapp import ApplicationRoot
 
50
 
 
51
config = ivle.config.Config()
 
52
 
 
53
class ObjectPermissionCheckingPublisher(Publisher):
 
54
    """A specialised publisher that checks object permissions.
 
55
 
 
56
    This publisher verifies that the user holds any permission at all
 
57
    on the model objects through which the resolution path passes. If
 
58
    no permission is held, resolution is aborted with an Unauthorized
 
59
    exception.
 
60
 
 
61
    IMPORTANT: This does NOT check view permissions. It only checks
 
62
    the objects in between the root and the view, exclusive!
 
63
    """
 
64
 
 
65
    def traversed_to_object(self, obj):
 
66
        """Check that the user has any permission at all over the object."""
 
67
        if (hasattr(obj, 'get_permissions') and
 
68
            len(obj.get_permissions(self.root.user, config)) == 0):
 
69
            # Indicate the forbidden object if this is an admin.
 
70
            if self.root.user and self.root.user.admin:
 
71
                raise Unauthorized('Unauthorized: %s' % obj)
 
72
            else:
 
73
                raise Unauthorized()
 
74
 
 
75
 
 
76
def generate_publisher(view_plugins, root, publicmode=False):
 
77
    """
 
78
    Build a Mapper object for doing URL matching using 'routes', based on the
 
79
    given plugin registry.
 
80
    """
 
81
    r = ObjectPermissionCheckingPublisher(root=root)
 
82
 
 
83
    r.add_set_switch('api', 'api')
 
84
 
 
85
    if publicmode:
 
86
        view_attr = 'public_views'
 
87
        forward_route_attr = 'public_forward_routes'
 
88
        reverse_route_attr = 'public_reverse_routes'
 
89
    else:
 
90
        view_attr = 'views'
 
91
        forward_route_attr = 'forward_routes'
 
92
        reverse_route_attr = 'reverse_routes'
 
93
 
 
94
 
 
95
    for plugin in view_plugins:
 
96
        if hasattr(plugin, forward_route_attr):
 
97
            for fr in getattr(plugin, forward_route_attr):
 
98
                # An annotated function can also be passed in directly.
 
99
                if hasattr(fr, '_forward_route_meta'):
 
100
                    r.add_forward_func(fr)
 
101
                else:
 
102
                    r.add_forward(*fr)
 
103
 
 
104
        if hasattr(plugin, reverse_route_attr):
 
105
            for rr in getattr(plugin, reverse_route_attr):
 
106
                # An annotated function can also be passed in directly.
 
107
                if hasattr(rr, '_reverse_route_src'):
 
108
                    r.add_reverse_func(rr)
 
109
                else:
 
110
                    r.add_reverse(*rr)
 
111
 
 
112
        if hasattr(plugin, view_attr):
 
113
            for v in getattr(plugin, view_attr):
 
114
                r.add_view(*v)
 
115
 
 
116
    return r
 
117
 
 
118
def handler(apachereq):
 
119
    """Handles an HTTP request.
 
120
 
56
121
    Intended to be called by mod_python, as a handler.
57
122
 
58
 
    req: An Apache request object.
59
 
    """
60
 
    # Make the request object into an IVLE request which can be passed to apps
61
 
    apachereq = req
62
 
    try:
63
 
        req = Request(req, html.write_html_head)
64
 
    except Exception:
65
 
        # Pass the apachereq to error reporter, since ivle req isn't created
66
 
        # yet.
67
 
        handle_unknown_exception(apachereq, *sys.exc_info())
68
 
        # Tell Apache not to generate its own errors as well
69
 
        return apache.OK
70
 
 
71
 
    # Run the main handler, and catch all exceptions
72
 
    try:
73
 
        return handler_(req, apachereq)
74
 
    except mod_python.apache.SERVER_RETURN:
75
 
        # An apache error. We discourage these, but they might still happen.
76
 
        # Just raise up.
77
 
        raise
78
 
    except Exception:
79
 
        handle_unknown_exception(req, *sys.exc_info())
80
 
        # Tell Apache not to generate its own errors as well
81
 
        return apache.OK
82
 
 
83
 
def handler_(req, apachereq):
84
 
    """
85
 
    Nested handler function. May raise exceptions. The top-level handler is
86
 
    just used to catch exceptions.
87
 
    Takes both an IVLE request and an Apache req.
88
 
    """
 
123
    @param apachereq: An Apache request object.
 
124
    """
 
125
    # Make the request object into an IVLE request which can be given to views
 
126
    req = Request(apachereq, config)
 
127
 
89
128
    # Hack? Try and get the user login early just in case we throw an error
90
129
    # (most likely 404) to stop us seeing not logged in even when we are.
91
130
    if not req.publicmode:
92
 
        req.user = login.get_user_details(req)
93
 
 
94
 
    # Check req.app to see if it is valid. 404 if not.
95
 
    if req.app is not None and req.app not in ivle.conf.apps.app_url:
96
 
        # Maybe it is a special app!
97
 
        if req.app == 'logout':
98
 
            logout(req)
99
 
        else:
100
 
            req.throw_error(Request.HTTP_NOT_FOUND,
101
 
                "There is no application called %s." % repr(req.app))
102
 
 
103
 
    # Special handling for public mode - only allow the public app, call it
104
 
    # and get out.
105
 
    # NOTE: This will not behave correctly if the public app uses
106
 
    # write_html_head_foot, but "serve" does not.
107
 
    if req.publicmode:
108
 
        if req.app != ivle.conf.apps.public_app:
109
 
            req.throw_error(Request.HTTP_FORBIDDEN,
110
 
                "This application is not available on the public site.")
111
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
112
 
        apps.call_app(app.dir, req)
113
 
        return req.OK
114
 
 
115
 
    # app is the App object for the chosen app
116
 
    if req.app is None:
117
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
118
 
    else:
119
 
        app = ivle.conf.apps.app_url[req.app]
120
 
 
121
 
    # Check if app requires auth. If so, perform authentication and login.
122
 
    # This will either return a User object, None, or perform a redirect
123
 
    # which we will not catch here.
124
 
    if app.requireauth:
125
 
        req.user = login.login(req)
126
 
        logged_in = req.user is not None
127
 
    else:
128
 
        req.user = login.get_user_details(req)
129
 
        logged_in = True
130
 
 
131
 
    if logged_in:
132
 
        # Keep the user's session alive by writing to the session object.
133
 
        # req.get_session().save()
134
 
        # Well, it's a fine idea, but it creates considerable grief in the
135
 
        # concurrent update department, so instead, we'll just make the
136
 
        # sessions not time out.
137
 
        req.get_session().unlock()
138
 
 
139
 
        # If user did not specify an app, HTTP redirect to default app and
140
 
        # exit.
141
 
        if req.app is None:
142
 
            req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
143
 
 
144
 
        # Set the default title to the app's tab name, if any. Otherwise URL
145
 
        # name.
146
 
        if app.name is not None:
147
 
            req.title = app.name
148
 
        else:
149
 
            req.title = req.app
150
 
 
151
 
        # Call the specified app with the request object
152
 
        apps.call_app(app.dir, req)
153
 
 
154
 
    # if not logged in, login.login will have written the login box.
155
 
    # Just clean up and exit.
156
 
 
157
 
    # MAKE SURE we write the HTTP (and possibly HTML) header. This
158
 
    # wouldn't happen if nothing else ever got written, so we have to make
159
 
    # sure.
160
 
    req.ensure_headers_written()
161
 
 
162
 
    # When done, write out the HTML footer if the app has requested it
163
 
    if req.write_html_head_foot:
164
 
        # Show the console if required
165
 
        if logged_in and app.useconsole:
166
 
            plugins.console.present(req, windowpane=True)
167
 
        html.write_html_foot(req)
168
 
 
169
 
    # Note: Apache will not write custom HTML error messages here.
170
 
    # Use req.throw_error to do that.
171
 
    return req.OK
172
 
 
173
 
def logout(req):
174
 
    """Log out the current user (if any) by destroying the session state.
175
 
    Then redirect to the top-level IVLE page."""
176
 
    session = req.get_session()
177
 
    session.invalidate()
178
 
    session.delete()
179
 
    # Invalidates all IVLE cookies
180
 
    all_cookies = Cookie.get_cookies(req)
181
 
    for cookie in all_cookies:
182
 
        if cookie in ivle_cookies:
183
 
            req.add_cookie(Cookie.Cookie(cookie,'',expires=1,path='/'))
184
 
    req.throw_redirect(util.make_path('')) 
 
131
        user = ivle.webapp.security.get_user_details(req)
 
132
 
 
133
        # Don't set the user if it is disabled or hasn't accepted the ToS.
 
134
        if user and user.valid:
 
135
            req.user = user
 
136
 
 
137
    req.publisher = generate_publisher(
 
138
        config.plugin_index[ViewPlugin],
 
139
        ApplicationRoot(req.config, req.store, req.user),
 
140
        publicmode=req.publicmode)
 
141
 
 
142
    try:
 
143
        obj, viewcls, subpath = req.publisher.resolve(req.uri.decode('utf-8'))
 
144
        try:
 
145
            # We 404 if we have a subpath but the view forbids it.
 
146
            if not viewcls.subpath_allowed and subpath:
 
147
                raise NotFound()
 
148
 
 
149
            # Instantiate the view, which should be a BaseView class
 
150
            view = viewcls(req, obj, subpath)
 
151
 
 
152
            # Check that the request (mainly the user) is permitted to access
 
153
            # the view.
 
154
            if not view.authorize(req):
 
155
                # Indicate the forbidden object if this is an admin.
 
156
                if req.user and req.user.admin:
 
157
                    raise Unauthorized('Unauthorized: %s' % view)
 
158
                else:
 
159
                    raise Unauthorized()
 
160
            # Render the output
 
161
            view.render(req)
 
162
        except HTTPError, e:
 
163
            # A view explicitly raised an HTTP error. Respect it.
 
164
            req.status = e.code
 
165
 
 
166
            # Try to find a custom error view.
 
167
            if hasattr(viewcls, 'get_error_view'):
 
168
                errviewcls = viewcls.get_error_view(e)
 
169
            else:
 
170
                errviewcls = XHTMLView.get_error_view(e)
 
171
 
 
172
            if errviewcls:
 
173
                errview = errviewcls(req, e, obj)
 
174
                errview.render(req)
 
175
                return req.OK
 
176
            elif e.message:
 
177
                req.write(e.message)
 
178
                return req.OK
 
179
            else:
 
180
                return e.code
 
181
        except mod_python.apache.SERVER_RETURN:
 
182
            # A mod_python-specific Apache error.
 
183
            # XXX: We need to raise these because req.throw_error() uses them.
 
184
            # Remove this after Google Code issue 117 is fixed.
 
185
            raise
 
186
        except Exception, e:
 
187
            # A non-HTTPError appeared. We have an unknown exception. Panic.
 
188
            handle_unknown_exception(req, *sys.exc_info())
 
189
            return req.OK
 
190
        else:
 
191
            req.store.commit()
 
192
            return req.OK
 
193
    except Unauthorized, e:
 
194
        # Resolution failed due to a permission check. Display a pretty
 
195
        # error, or maybe a login page.
 
196
        XHTMLView.get_error_view(e)(req, e, req.publisher.root).render(req)
 
197
        return req.OK
 
198
    except PublishingError, e:
 
199
        req.status = 404
 
200
 
 
201
        if req.user and req.user.admin:
 
202
            XHTMLErrorView(req, NotFound('Not found: ' +
 
203
                                         str(e.args)), e[0]).render(req)
 
204
        else:
 
205
            XHTMLErrorView(req, NotFound(), e[0]).render(req)
 
206
 
 
207
        return req.OK
185
208
 
186
209
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
187
210
    """
190
213
    This is a full handler. It assumes nothing has been written, and writes a
191
214
    complete HTML page.
192
215
    req: May be EITHER an IVLE req or an Apache req.
193
 
    IVLE reqs may have the HTML head/foot written (on a 400 error), but
194
 
    the handler code may pass an apache req if an exception occurs before
 
216
    The handler code may pass an apache req if an exception occurs before
195
217
    the IVLE request is created.
196
218
    """
197
219
    req.content_type = "text/html"
198
 
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
 
220
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
199
221
    logfail = False
200
 
    # For some reason, some versions of mod_python have "_server" instead of
201
 
    # "main_server". So we check for both.
202
 
    try:
203
 
        admin_email = apache.main_server.server_admin
204
 
    except AttributeError:
205
 
        try:
206
 
            admin_email = apache._server.server_admin
207
 
        except AttributeError:
208
 
            admin_email = ""
 
222
 
 
223
    # XXX: This remains here for ivle.interpret's IVLEErrors. Once we rewrite
 
224
    #      fileservice, req.status should always be 500 (ISE) here.
209
225
    try:
210
226
        httpcode = exc_value.httpcode
211
227
        req.status = httpcode
212
228
    except AttributeError:
213
229
        httpcode = None
214
 
        req.status = apache.HTTP_INTERNAL_SERVER_ERROR
 
230
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
231
 
 
232
    try:
 
233
        publicmode = req.publicmode
 
234
    except AttributeError:
 
235
        publicmode = True
215
236
    try:
216
237
        login = req.user.login
217
238
    except AttributeError:
231
252
            filemode='a')
232
253
    except IOError:
233
254
        logfail = True
234
 
    logging.debug('Logging Unhandled Exception')
235
 
 
236
 
    # We handle 3 types of error.
237
 
    # IVLEErrors with 4xx response codes (client error).
238
 
    # IVLEErrors with 5xx response codes (handled server error).
239
 
    # Other exceptions (unhandled server error).
240
 
    # IVLEErrors should not have other response codes than 4xx or 5xx
241
 
    # (eg. throw_redirect should have been used for 3xx codes).
242
 
    # Therefore, that is treated as an unhandled error.
243
 
 
244
 
    if (exc_type == util.IVLEError and httpcode >= 400
245
 
        and httpcode <= 499):
246
 
        # IVLEErrors with 4xx response codes are client errors.
247
 
        # Therefore, these have a "nice" response (we even coat it in the IVLE
248
 
        # HTML wrappers).
249
 
        
250
 
        req.write_html_head_foot = True
251
 
        req.write_javascript_settings = False
252
 
        req.write('<div id="ivle_padding">\n')
253
 
        try:
254
 
            codename, msg = req.get_http_codename(httpcode)
255
 
        except AttributeError:
256
 
            codename, msg = None, None
257
 
        # Override the default message with the supplied one,
258
 
        # if available.
259
 
        if exc_value.message is not None:
260
 
            msg = exc_value.message
261
 
        if codename is not None:
262
 
            req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
263
 
        else:
264
 
            req.write("<h1>Error</h1>\n")
265
 
        if msg is not None:
266
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
267
 
        else:
268
 
            req.write("<p>An unknown error occured.</p>\n")
269
 
        
270
 
        # Logging
271
 
        logging.info(str(msg))
272
 
        
273
 
        req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
274
 
        if logfail:
275
 
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
276
 
                %cgi.escape(logfile))
277
 
        req.write('</div>\n')
278
 
        html.write_html_foot(req)
 
255
 
 
256
    # A "bad" error message. We shouldn't get here unless IVLE
 
257
    # misbehaves (which is currently very easy, if things aren't set up
 
258
    # correctly).
 
259
    # Write the traceback.
 
260
 
 
261
    # We need to special-case IVLEJailError, as we can get another
 
262
    # almost-exception out of it.
 
263
    if exc_type is util.IVLEJailError:
 
264
        tb = 'Exception information extracted from IVLEJailError:\n'
 
265
        tb += urllib.unquote(exc_value.info)
279
266
    else:
280
 
        # A "bad" error message. We shouldn't get here unless IVLE
281
 
        # misbehaves (which is currently very easy, if things aren't set up
282
 
        # correctly).
283
 
        # Write the traceback.
284
 
        # If this is a non-4xx IVLEError, get the message and httpcode and
285
 
        # make the error message a bit nicer (but still include the
286
 
        # traceback).
287
 
        # We also need to special-case IVLEJailError, as we can get another
288
 
        # almost-exception out of it.
289
 
 
290
 
        codename, msg = None, None
291
 
 
292
 
        if exc_type is util.IVLEJailError:
293
 
            msg = exc_value.type_str + ": " + exc_value.message
294
 
            tb = 'Exception information extracted from IVLEJailError:\n'
295
 
            tb += urllib.unquote(exc_value.info)
296
 
        else:
297
 
            try:
298
 
                codename, msg = req.get_http_codename(httpcode)
299
 
            except AttributeError:
300
 
                pass
301
 
            # Override the default message with the supplied one,
302
 
            # if available.
303
 
            if hasattr(exc_value, 'message') and exc_value.message is not None:
304
 
                msg = exc_value.message
305
 
                # Prepend the exception type
306
 
                if exc_type != util.IVLEError:
307
 
                    msg = exc_type.__name__ + ": " + msg
308
 
 
309
 
            tb = ''.join(traceback.format_exception(exc_type, exc_value,
310
 
                                                    exc_traceback))
311
 
 
312
 
        # Logging
313
 
        logging.error('%s\n%s'%(str(msg), tb))
314
 
 
315
 
        req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
 
267
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
 
268
                                                exc_traceback))
 
269
 
 
270
    logging.error('\n' + tb)
 
271
 
 
272
    # Error messages are only displayed is the user is NOT a student,
 
273
    # or if there has been a problem logging the error message
 
274
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
 
275
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
316
276
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
317
277
<html xmlns="http://www.w3.org/1999/xhtml">
318
278
<head><title>IVLE Internal Server Error</title></head>
319
279
<body>
320
 
<h1>IVLE Internal Server Error""")
321
 
        if (codename is not None
322
 
            and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
323
 
            req.write(": %s" % cgi.escape(codename))
324
 
        req.write("""</h1>
 
280
<h1>IVLE Internal Server Error</h1>
325
281
<p>An error has occured which is the fault of the IVLE developers or
326
 
administration.</p>
327
 
""")
328
 
        if msg is not None:
329
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
330
 
        if httpcode is not None:
331
 
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
332
 
        req.write("""
333
 
<p>Please report this to <a href="mailto:%s">%s</a> (the system
334
 
administrator). Include the following information:</p>
335
 
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
336
 
 
 
282
administrators. """)
 
283
 
 
284
    if logfail:
 
285
        req.write("Please report this issue to the server administrators, "
 
286
                  "along with the following information.")
 
287
    else:
 
288
        req.write("Details have been logged for further examination.")
 
289
    req.write("</p>")
 
290
 
 
291
    if show_errors:
 
292
        req.write("<h2>Debugging information</h2>")
337
293
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
338
 
        if logfail:
339
 
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
340
 
                %cgi.escape(logfile))
341
 
        req.write("</body></html>")
 
294
    req.write("</body></html>")