← 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: chadnickbok
  • Date: 2009-01-22 02:14:14 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1173
Fixes Issue #14

When uploading files, students will now be shown an
error message if there upload would replace already existing
files.

This upload will not be performed until it will not clobber
any old files.

Note that there is currently a way to change this behaviour in
the code in action.py, to allow files to be overwritten. However
there is no way this flag can be set through the browser interface
(yet).

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/__init__.py
1
 
# IVLE - Informatics Virtual Learning Environment
2
 
# Copyright (C) 2007-2009 The University of Melbourne
 
1
# IVLE
 
2
# Copyright (C) 2007-2008 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
 
# 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
 
"""
 
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.
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
41
 
41
42
from ivle import util
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
 
 
 
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.
121
53
    Intended to be called by mod_python, as a handler.
122
54
 
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
 
 
 
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
    """
128
86
    # Hack? Try and get the user login early just in case we throw an error
129
87
    # (most likely 404) to stop us seeing not logged in even when we are.
130
88
    if not req.publicmode:
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
208
 
    finally:
209
 
        req.store.close()
 
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
210
165
 
211
166
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
212
167
    """
215
170
    This is a full handler. It assumes nothing has been written, and writes a
216
171
    complete HTML page.
217
172
    req: May be EITHER an IVLE req or an Apache req.
218
 
    The handler code may pass an apache req if an exception occurs before
 
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
219
175
    the IVLE request is created.
220
176
    """
221
177
    req.content_type = "text/html"
222
 
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
 
178
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
223
179
    logfail = False
224
 
 
225
 
    # XXX: This remains here for ivle.interpret's IVLEErrors. Once we rewrite
226
 
    #      fileservice, req.status should always be 500 (ISE) here.
 
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 = ""
227
189
    try:
228
190
        httpcode = exc_value.httpcode
229
191
        req.status = httpcode
230
192
    except AttributeError:
231
193
        httpcode = None
232
 
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
233
 
 
 
194
        req.status = apache.HTTP_INTERNAL_SERVER_ERROR
234
195
    try:
235
196
        publicmode = req.publicmode
236
197
    except AttributeError:
239
200
        login = req.user.login
240
201
    except AttributeError:
241
202
        login = None
 
203
    try:
 
204
        role = req.user.role
 
205
    except AttributeError:
 
206
        role = None
242
207
 
243
208
    # Log File
244
209
    try:
254
219
            filemode='a')
255
220
    except IOError:
256
221
        logfail = True
257
 
 
258
 
    # A "bad" error message. We shouldn't get here unless IVLE
259
 
    # misbehaves (which is currently very easy, if things aren't set up
260
 
    # correctly).
261
 
    # Write the traceback.
262
 
 
263
 
    # We need to special-case IVLEJailError, as we can get another
264
 
    # almost-exception out of it.
265
 
    if exc_type is util.IVLEJailError:
266
 
        tb = 'Exception information extracted from IVLEJailError:\n'
267
 
        tb += urllib.unquote(exc_value.info)
 
222
    logging.debug('Logging Unhandled Exception')
 
223
 
 
224
    # We handle 3 types of error.
 
225
    # IVLEErrors with 4xx response codes (client error).
 
226
    # IVLEErrors with 5xx response codes (handled server error).
 
227
    # Other exceptions (unhandled server error).
 
228
    # IVLEErrors should not have other response codes than 4xx or 5xx
 
229
    # (eg. throw_redirect should have been used for 3xx codes).
 
230
    # Therefore, that is treated as an unhandled error.
 
231
 
 
232
    if (exc_type == util.IVLEError and httpcode >= 400
 
233
        and httpcode <= 499):
 
234
        # IVLEErrors with 4xx response codes are client errors.
 
235
        # Therefore, these have a "nice" response (we even coat it in the IVLE
 
236
        # HTML wrappers).
 
237
        
 
238
        req.write_html_head_foot = True
 
239
        req.write_javascript_settings = False
 
240
        req.write('<div id="ivle_padding">\n')
 
241
        try:
 
242
            codename, msg = req.get_http_codename(httpcode)
 
243
        except AttributeError:
 
244
            codename, msg = None, None
 
245
        # Override the default message with the supplied one,
 
246
        # if available.
 
247
        if exc_value.message is not None:
 
248
            msg = exc_value.message
 
249
        if codename is not None:
 
250
            req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
 
251
        else:
 
252
            req.write("<h1>Error</h1>\n")
 
253
        if msg is not None:
 
254
            req.write("<p>%s</p>\n" % cgi.escape(msg))
 
255
        else:
 
256
            req.write("<p>An unknown error occured.</p>\n")
 
257
        
 
258
        # Logging
 
259
        logging.info(str(msg))
 
260
        
 
261
        req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
 
262
        if logfail:
 
263
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
 
264
                %cgi.escape(logfile))
 
265
        req.write('</div>\n')
 
266
        html.write_html_foot(req)
268
267
    else:
269
 
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
270
 
                                                exc_traceback))
271
 
 
272
 
    logging.error('\n' + tb)
273
 
 
274
 
    # Error messages are only displayed is the user is NOT a student,
275
 
    # or if there has been a problem logging the error message
276
 
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
277
 
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
 
268
        # A "bad" error message. We shouldn't get here unless IVLE
 
269
        # misbehaves (which is currently very easy, if things aren't set up
 
270
        # correctly).
 
271
        # Write the traceback.
 
272
        # If this is a non-4xx IVLEError, get the message and httpcode and
 
273
        # make the error message a bit nicer (but still include the
 
274
        # traceback).
 
275
        # We also need to special-case IVLEJailError, as we can get another
 
276
        # almost-exception out of it.
 
277
 
 
278
        codename, msg = None, None
 
279
 
 
280
        if exc_type is util.IVLEJailError:
 
281
            msg = exc_value.type_str + ": " + exc_value.message
 
282
            tb = 'Exception information extracted from IVLEJailError:\n'
 
283
            tb += urllib.unquote(exc_value.info)
 
284
        else:
 
285
            try:
 
286
                codename, msg = req.get_http_codename(httpcode)
 
287
            except AttributeError:
 
288
                pass
 
289
            # Override the default message with the supplied one,
 
290
            # if available.
 
291
            if hasattr(exc_value, 'message') and exc_value.message is not None:
 
292
                msg = exc_value.message
 
293
                # Prepend the exception type
 
294
                if exc_type != util.IVLEError:
 
295
                    msg = exc_type.__name__ + ": " + msg
 
296
 
 
297
            tb = ''.join(traceback.format_exception(exc_type, exc_value,
 
298
                                                    exc_traceback))
 
299
 
 
300
        # Logging
 
301
        logging.error('%s\n%s'%(str(msg), tb))
 
302
        # Error messages are only displayed is the user is NOT a student,
 
303
        # or if there has been a problem logging the error message
 
304
        show_errors = (not publicmode) and (not login or \
 
305
                            (not str(role) == "student") or logfail)
 
306
        req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
278
307
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
279
308
<html xmlns="http://www.w3.org/1999/xhtml">
280
309
<head><title>IVLE Internal Server Error</title></head>
281
310
<body>
282
 
<h1>IVLE Internal Server Error</h1>
 
311
<h1>IVLE Internal Server Error""")
 
312
        if (show_errors):
 
313
            if (codename is not None
 
314
                        and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
 
315
                req.write(": %s" % cgi.escape(codename))
 
316
        
 
317
        req.write("""</h1>
283
318
<p>An error has occured which is the fault of the IVLE developers or
284
 
administrators. """)
285
 
 
286
 
    if logfail:
287
 
        req.write("Please report this issue to the server administrators, "
288
 
                  "along with the following information.")
289
 
    else:
290
 
        req.write("Details have been logged for further examination.")
291
 
    req.write("</p>")
292
 
 
293
 
    if show_errors:
294
 
        req.write("<h2>Debugging information</h2>")
295
 
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
296
 
    req.write("</body></html>")
 
319
administration. The developers have been notified.</p>
 
320
""")
 
321
        if (show_errors):
 
322
            if msg is not None:
 
323
                req.write("<p>%s</p>\n" % cgi.escape(msg))
 
324
            if httpcode is not None:
 
325
                req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
 
326
            req.write("""
 
327
    <p>Please report this to <a href="mailto:%s">%s</a> (the system
 
328
    administrator). Include the following information:</p>
 
329
    """ % (cgi.escape(admin_email), cgi.escape(admin_email)))
 
330
 
 
331
            req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
 
332
            if logfail:
 
333
                req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
 
334
                    %cgi.escape(logfile))
 
335
        req.write("</body></html>")