← 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: 2009-04-28 05:06:00 UTC
  • Revision ID: grantw@unimelb.edu.au-20090428050600-hogd9d6wo7ksyqy8
ivle.database.get_store() now takes a configuration object.

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
 
40
import routes
41
41
 
42
42
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.
 
43
import ivle.config
 
44
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):
 
53
    """
 
54
    Build a Mapper object for doing URL matching using 'routes', based on the
 
55
    given plugin registry.
 
56
    """
 
57
    m = routes.Mapper(explicit=True)
 
58
    for plugin in view_plugins:
 
59
        # 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):
 
62
            routex = url[0]
 
63
            view_class = url[1]
 
64
            kwargs_dict = url[2] if len(url) >= 3 else {}
 
65
            m.connect(routex, view=view_class, **kwargs_dict)
 
66
    return m
 
67
 
 
68
def handler(apachereq):
 
69
    """Handles an HTTP request.
 
70
 
56
71
    Intended to be called by mod_python, as a handler.
57
72
 
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
 
    """
 
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
 
89
78
    # Hack? Try and get the user login early just in case we throw an error
90
79
    # (most likely 404) to stop us seeing not logged in even when we are.
91
80
    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.
 
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
 
107
87
    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)
 
88
        req.mapper = generate_router(config.plugin_index[PublicViewPlugin],
 
89
                                    'public_urls')
 
90
    else:
 
91
        req.mapper = generate_router(config.plugin_index[ViewPlugin], 'urls')
 
92
 
 
93
    matchdict = req.mapper.match(req.uri)
 
94
    if matchdict is not None:
 
95
        viewcls = matchdict['view']
 
96
        # Get the remaining arguments, less 'view', 'action' and 'controller'
 
97
        # (The latter two seem to be built-in, and we don't want them).
 
98
        kwargs = matchdict.copy()
 
99
        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
 
138
        else:
 
139
            req.store.commit()
 
140
            return req.OK
 
141
    else:
 
142
        XHTMLErrorView(req, NotFound()).render(req)
113
143
        return req.OK
114
144
 
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('')) 
185
 
 
186
145
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
187
146
    """
188
147
    Given an exception that has just been thrown from IVLE, print its details
190
149
    This is a full handler. It assumes nothing has been written, and writes a
191
150
    complete HTML page.
192
151
    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
 
152
    The handler code may pass an apache req if an exception occurs before
195
153
    the IVLE request is created.
196
154
    """
197
155
    req.content_type = "text/html"
198
 
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
 
156
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
199
157
    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 = ""
209
158
    try:
210
159
        httpcode = exc_value.httpcode
211
160
        req.status = httpcode
212
161
    except AttributeError:
213
162
        httpcode = None
214
 
        req.status = apache.HTTP_INTERNAL_SERVER_ERROR
 
163
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
164
    try:
 
165
        publicmode = req.publicmode
 
166
    except AttributeError:
 
167
        publicmode = True
215
168
    try:
216
169
        login = req.user.login
217
170
    except AttributeError:
231
184
            filemode='a')
232
185
    except IOError:
233
186
        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')
 
187
 
 
188
    # A "bad" error message. We shouldn't get here unless IVLE
 
189
    # misbehaves (which is currently very easy, if things aren't set up
 
190
    # correctly).
 
191
    # Write the traceback.
 
192
    # If this is a non-4xx IVLEError, get the message and httpcode and
 
193
    # make the error message a bit nicer (but still include the
 
194
    # traceback).
 
195
    # We also need to special-case IVLEJailError, as we can get another
 
196
    # almost-exception out of it.
 
197
 
 
198
    codename, msg = None, None
 
199
 
 
200
    if exc_type is util.IVLEJailError:
 
201
        msg = exc_value.type_str + ": " + exc_value.message
 
202
        tb = 'Exception information extracted from IVLEJailError:\n'
 
203
        tb += urllib.unquote(exc_value.info)
 
204
    else:
253
205
        try:
254
206
            codename, msg = req.get_http_codename(httpcode)
255
207
        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)
279
 
    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"                 
 
208
            pass
 
209
 
 
210
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
 
211
                                                exc_traceback))
 
212
 
 
213
    logging.error('%s\n%s'%(str(msg), tb))
 
214
 
 
215
    # Error messages are only displayed is the user is NOT a student,
 
216
    # or if there has been a problem logging the error message
 
217
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
 
218
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
316
219
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
317
220
<html xmlns="http://www.w3.org/1999/xhtml">
318
221
<head><title>IVLE Internal Server Error</title></head>
319
222
<body>
320
223
<h1>IVLE Internal Server Error""")
321
 
        if (codename is not None
322
 
            and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
 
224
    if show_errors:
 
225
        if codename is not None and \
 
226
           httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR:
323
227
            req.write(": %s" % cgi.escape(codename))
324
 
        req.write("""</h1>
 
228
 
 
229
    req.write("""</h1>
325
230
<p>An error has occured which is the fault of the IVLE developers or
326
 
administration.</p>
327
 
""")
 
231
administrators. """)
 
232
 
 
233
    if logfail:
 
234
        req.write("Please report this issue to the server administrators, "
 
235
                  "along with the following information.")
 
236
    else:
 
237
        req.write("Details have been logged for further examination.")
 
238
    req.write("</p>")
 
239
 
 
240
    if show_errors:
328
241
        if msg is not None:
329
242
            req.write("<p>%s</p>\n" % cgi.escape(msg))
330
243
        if httpcode is not None:
331
244
            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)))
 
245
        req.write("<h2>Debugging information</h2>")
336
246
 
337
247
        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>")
 
248
    req.write("</body></html>")