← 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-11 08:36:15 UTC
  • Revision ID: grantw@unimelb.edu.au-20100211083615-5imzir7px5dblvwk
divify the login form, fixing up the submit/error indentation while there.

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
 
def handler(req):
52
 
    """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)) == 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
 
53
121
    Intended to be called by mod_python, as a handler.
54
122
 
55
 
    req: An Apache request object.
56
 
    """
57
 
    # Make the request object into an IVLE request which can be passed to apps
58
 
    apachereq = req
59
 
    try:
60
 
        req = Request(req, html.write_html_head)
61
 
    except Exception:
62
 
        # Pass the apachereq to error reporter, since ivle req isn't created
63
 
        # yet.
64
 
        handle_unknown_exception(apachereq, *sys.exc_info())
65
 
        # Tell Apache not to generate its own errors as well
66
 
        return apache.OK
67
 
 
68
 
    # Run the main handler, and catch all exceptions
69
 
    try:
70
 
        return handler_(req, apachereq)
71
 
    except mod_python.apache.SERVER_RETURN:
72
 
        # An apache error. We discourage these, but they might still happen.
73
 
        # Just raise up.
74
 
        raise
75
 
    except Exception:
76
 
        handle_unknown_exception(req, *sys.exc_info())
77
 
        # Tell Apache not to generate its own errors as well
78
 
        return apache.OK
79
 
 
80
 
def handler_(req, apachereq):
81
 
    """
82
 
    Nested handler function. May raise exceptions. The top-level handler is
83
 
    just used to catch exceptions.
84
 
    Takes both an IVLE request and an Apache req.
85
 
    """
 
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
 
86
128
    # Hack? Try and get the user login early just in case we throw an error
87
129
    # (most likely 404) to stop us seeing not logged in even when we are.
88
130
    if not req.publicmode:
89
 
        req.user = login.get_user_details(req)
90
 
 
91
 
    # Check req.app to see if it is valid. 404 if not.
92
 
    if req.app is not None and req.app not in ivle.conf.apps.app_url:
93
 
        req.throw_error(Request.HTTP_NOT_FOUND,
94
 
            "There is no application called %s." % repr(req.app))
95
 
 
96
 
    # Special handling for public mode - only allow the public app, call it
97
 
    # and get out.
98
 
    # NOTE: This will not behave correctly if the public app uses
99
 
    # write_html_head_foot, but "serve" does not.
100
 
    if req.publicmode:
101
 
        if req.app != ivle.conf.apps.public_app:
102
 
            req.throw_error(Request.HTTP_FORBIDDEN,
103
 
                "This application is not available on the public site.")
104
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
105
 
        apps.call_app(app.dir, req)
106
 
        return req.OK
107
 
 
108
 
    # app is the App object for the chosen app
109
 
    if req.app is None:
110
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
111
 
    else:
112
 
        app = ivle.conf.apps.app_url[req.app]
113
 
 
114
 
    # Check if app requires auth. If so, perform authentication and login.
115
 
    # This will either return a User object, None, or perform a redirect
116
 
    # which we will not catch here.
117
 
    if app.requireauth:
118
 
        req.user = login.login(req)
119
 
        logged_in = req.user is not None
120
 
    else:
121
 
        req.user = login.get_user_details(req)
122
 
        logged_in = True
123
 
 
124
 
    if logged_in:
125
 
        # Keep the user's session alive by writing to the session object.
126
 
        # req.get_session().save()
127
 
        # Well, it's a fine idea, but it creates considerable grief in the
128
 
        # concurrent update department, so instead, we'll just make the
129
 
        # sessions not time out.
130
 
        req.get_session().unlock()
131
 
 
132
 
        # If user did not specify an app, HTTP redirect to default app and
133
 
        # exit.
134
 
        if req.app is None:
135
 
            req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
136
 
 
137
 
        # Set the default title to the app's tab name, if any. Otherwise URL
138
 
        # name.
139
 
        if app.name is not None:
140
 
            req.title = app.name
141
 
        else:
142
 
            req.title = req.app
143
 
 
144
 
        # Call the specified app with the request object
145
 
        apps.call_app(app.dir, req)
146
 
 
147
 
    # if not logged in, login.login will have written the login box.
148
 
    # Just clean up and exit.
149
 
 
150
 
    # MAKE SURE we write the HTTP (and possibly HTML) header. This
151
 
    # wouldn't happen if nothing else ever got written, so we have to make
152
 
    # sure.
153
 
    req.ensure_headers_written()
154
 
 
155
 
    # When done, write out the HTML footer if the app has requested it
156
 
    if req.write_html_head_foot:
157
 
        # Show the console if required
158
 
        if logged_in and app.useconsole:
159
 
            plugins.console.present(req, windowpane=True)
160
 
        html.write_html_foot(req)
161
 
 
162
 
    # Note: Apache will not write custom HTML error messages here.
163
 
    # Use req.throw_error to do that.
164
 
    return req.OK
 
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
165
208
 
166
209
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
167
210
    """
170
213
    This is a full handler. It assumes nothing has been written, and writes a
171
214
    complete HTML page.
172
215
    req: May be EITHER an IVLE req or an Apache req.
173
 
    IVLE reqs may have the HTML head/foot written (on a 400 error), but
174
 
    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
175
217
    the IVLE request is created.
176
218
    """
177
219
    req.content_type = "text/html"
178
 
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
 
220
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
179
221
    logfail = False
180
 
    # For some reason, some versions of mod_python have "_server" instead of
181
 
    # "main_server". So we check for both.
182
 
    try:
183
 
        admin_email = apache.main_server.server_admin
184
 
    except AttributeError:
185
 
        try:
186
 
            admin_email = apache._server.server_admin
187
 
        except AttributeError:
188
 
            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.
189
225
    try:
190
226
        httpcode = exc_value.httpcode
191
227
        req.status = httpcode
192
228
    except AttributeError:
193
229
        httpcode = None
194
 
        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
195
236
    try:
196
237
        login = req.user.login
197
238
    except AttributeError:
211
252
            filemode='a')
212
253
    except IOError:
213
254
        logfail = True
214
 
    logging.debug('Logging Unhandled Exception')
215
 
 
216
 
    # We handle 3 types of error.
217
 
    # IVLEErrors with 4xx response codes (client error).
218
 
    # IVLEErrors with 5xx response codes (handled server error).
219
 
    # Other exceptions (unhandled server error).
220
 
    # IVLEErrors should not have other response codes than 4xx or 5xx
221
 
    # (eg. throw_redirect should have been used for 3xx codes).
222
 
    # Therefore, that is treated as an unhandled error.
223
 
 
224
 
    if (exc_type == util.IVLEError and httpcode >= 400
225
 
        and httpcode <= 499):
226
 
        # IVLEErrors with 4xx response codes are client errors.
227
 
        # Therefore, these have a "nice" response (we even coat it in the IVLE
228
 
        # HTML wrappers).
229
 
        
230
 
        req.write_html_head_foot = True
231
 
        req.write_javascript_settings = False
232
 
        req.write('<div id="ivle_padding">\n')
233
 
        try:
234
 
            codename, msg = req.get_http_codename(httpcode)
235
 
        except AttributeError:
236
 
            codename, msg = None, None
237
 
        # Override the default message with the supplied one,
238
 
        # if available.
239
 
        if exc_value.message is not None:
240
 
            msg = exc_value.message
241
 
        if codename is not None:
242
 
            req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
243
 
        else:
244
 
            req.write("<h1>Error</h1>\n")
245
 
        if msg is not None:
246
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
247
 
        else:
248
 
            req.write("<p>An unknown error occured.</p>\n")
249
 
        
250
 
        # Logging
251
 
        logging.info(str(msg))
252
 
        
253
 
        req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
254
 
        if logfail:
255
 
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
256
 
                %cgi.escape(logfile))
257
 
        req.write('</div>\n')
258
 
        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)
259
266
    else:
260
 
        # A "bad" error message. We shouldn't get here unless IVLE
261
 
        # misbehaves (which is currently very easy, if things aren't set up
262
 
        # correctly).
263
 
        # Write the traceback.
264
 
        # If this is a non-4xx IVLEError, get the message and httpcode and
265
 
        # make the error message a bit nicer (but still include the
266
 
        # traceback).
267
 
        # We also need to special-case IVLEJailError, as we can get another
268
 
        # almost-exception out of it.
269
 
 
270
 
        codename, msg = None, None
271
 
 
272
 
        if exc_type is util.IVLEJailError:
273
 
            msg = exc_value.type_str + ": " + exc_value.message
274
 
            tb = 'Exception information extracted from IVLEJailError:\n'
275
 
            tb += urllib.unquote(exc_value.info)
276
 
        else:
277
 
            try:
278
 
                codename, msg = req.get_http_codename(httpcode)
279
 
            except AttributeError:
280
 
                pass
281
 
            # Override the default message with the supplied one,
282
 
            # if available.
283
 
            if hasattr(exc_value, 'message') and exc_value.message is not None:
284
 
                msg = exc_value.message
285
 
                # Prepend the exception type
286
 
                if exc_type != util.IVLEError:
287
 
                    msg = exc_type.__name__ + ": " + msg
288
 
 
289
 
            tb = ''.join(traceback.format_exception(exc_type, exc_value,
290
 
                                                    exc_traceback))
291
 
 
292
 
        # Logging
293
 
        logging.error('%s\n%s'%(str(msg), tb))
294
 
 
295
 
        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"                 
296
276
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
297
277
<html xmlns="http://www.w3.org/1999/xhtml">
298
278
<head><title>IVLE Internal Server Error</title></head>
299
279
<body>
300
 
<h1>IVLE Internal Server Error""")
301
 
        if (codename is not None
302
 
            and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
303
 
            req.write(": %s" % cgi.escape(codename))
304
 
        req.write("""</h1>
 
280
<h1>IVLE Internal Server Error</h1>
305
281
<p>An error has occured which is the fault of the IVLE developers or
306
 
administration.</p>
307
 
""")
308
 
        if msg is not None:
309
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
310
 
        if httpcode is not None:
311
 
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
312
 
        req.write("""
313
 
<p>Please report this to <a href="mailto:%s">%s</a> (the system
314
 
administrator). Include the following information:</p>
315
 
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
316
 
 
 
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>")
317
293
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
318
 
        if logfail:
319
 
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
320
 
                %cgi.escape(logfile))
321
 
        req.write("</body></html>")
 
294
    req.write("</body></html>")