← 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-23 08:08:27 UTC
  • Revision ID: grantw@unimelb.edu.au-20100223080827-wklsx122pcw79wi7
https://launchpad.net/bugs/525559
Reject off-site non-GET requests.

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
 
45
import ivle.webapp.security
47
46
from ivle.webapp.base.plugins import ViewPlugin, PublicViewPlugin
48
 
from ivle.webapp.errors import HTTPError, Unauthorized
49
 
import apps
50
 
import html
51
 
 
52
 
def generate_route_mapper(view_plugins, attr):
 
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):
53
78
    """
54
79
    Build a Mapper object for doing URL matching using 'routes', based on the
55
80
    given plugin registry.
56
81
    """
57
 
    m = routes.Mapper(explicit=True)
 
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
 
58
96
    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(req):
69
 
    """Handles a request which may be to anywhere in the site except media.
 
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
 
70
122
    Intended to be called by mod_python, as a handler.
71
123
 
72
 
    req: An Apache request object.
73
 
    """
74
 
    # Make the request object into an IVLE request which can be passed to apps
75
 
    apachereq = req
76
 
    try:
77
 
        req = Request(req, html.write_html_head)
78
 
    except Exception:
79
 
        # Pass the apachereq to error reporter, since ivle req isn't created
80
 
        # yet.
81
 
        handle_unknown_exception(apachereq, *sys.exc_info())
82
 
        # Tell Apache not to generate its own errors as well
83
 
        return mod_python.apache.OK
84
 
 
85
 
    # Run the main handler, and catch all exceptions
86
 
    try:
87
 
        return handler_(req, apachereq)
88
 
    except mod_python.apache.SERVER_RETURN:
89
 
        # An apache error. We discourage these, but they might still happen.
90
 
        # Just raise up.
91
 
        raise
92
 
    except Exception:
93
 
        handle_unknown_exception(req, *sys.exc_info())
94
 
        # Tell Apache not to generate its own errors as well
95
 
        return mod_python.apache.OK
96
 
 
97
 
def handler_(req, apachereq):
98
 
    """
99
 
    Nested handler function. May raise exceptions. The top-level handler is
100
 
    just used to catch exceptions.
101
 
    Takes both an IVLE request and an Apache req.
102
 
    """
 
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
 
103
129
    # Hack? Try and get the user login early just in case we throw an error
104
130
    # (most likely 404) to stop us seeing not logged in even when we are.
105
131
    if not req.publicmode:
106
 
        user = login.get_user_details(req)
 
132
        user = ivle.webapp.security.get_user_details(req)
107
133
 
108
134
        # Don't set the user if it is disabled or hasn't accepted the ToS.
109
135
        if user and user.valid:
110
136
            req.user = user
111
137
 
112
 
    conf = ivle.config.Config()
113
 
    req.config = conf
114
 
 
115
 
    ### BEGIN New plugins framework ###
116
 
    if req.publicmode:
117
 
        req.mapper = generate_route_mapper(conf.plugin_index[PublicViewPlugin],
118
 
                                           'public_urls')
119
 
    else:
120
 
        req.mapper = generate_route_mapper(conf.plugin_index[ViewPlugin],
121
 
                                           'urls')
122
 
 
123
 
    matchdict = req.mapper.match(req.uri)
124
 
    if matchdict is not None:
125
 
        viewcls = matchdict['view']
126
 
        # Get the remaining arguments, less 'view', 'action' and 'controller'
127
 
        # (The latter two seem to be built-in, and we don't want them).
128
 
        kwargs = matchdict.copy()
129
 
        del kwargs['view']
 
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'))
130
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
 
131
150
            # Instantiate the view, which should be a BaseView class
132
 
            view = viewcls(req, **kwargs)
 
151
            view = viewcls(req, obj, subpath)
133
152
 
134
153
            # Check that the request (mainly the user) is permitted to access
135
154
            # the view.
136
155
            if not view.authorize(req):
137
 
                raise Unauthorized()
 
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
 
138
173
            # Render the output
139
174
            view.render(req)
140
175
        except HTTPError, e:
145
180
            if hasattr(viewcls, 'get_error_view'):
146
181
                errviewcls = viewcls.get_error_view(e)
147
182
            else:
148
 
                errviewcls = None
 
183
                errviewcls = XHTMLView.get_error_view(e)
149
184
 
150
185
            if errviewcls:
151
 
                errview = errviewcls(req, e)
 
186
                errview = errviewcls(req, e, obj)
152
187
                errview.render(req)
153
188
                return req.OK
154
189
            elif e.message:
156
191
                return req.OK
157
192
            else:
158
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
159
199
        except Exception, e:
160
200
            # A non-HTTPError appeared. We have an unknown exception. Panic.
161
201
            handle_unknown_exception(req, *sys.exc_info())
163
203
        else:
164
204
            req.store.commit()
165
205
            return req.OK
166
 
    else:
167
 
        # We had no matching URL! Check if it matches an old-style app. If
168
 
        # not, 404.
169
 
        if req.app not in ivle.conf.apps.app_url:
170
 
            return req.HTTP_NOT_FOUND # TODO: Prettify.
171
 
    ### END New plugins framework ###
172
 
 
173
 
 
174
 
    ### BEGIN legacy application framework ###
175
 
    # We have no public apps back here.
176
 
    assert not req.publicmode
177
 
 
178
 
    # app is the App object for the chosen app
179
 
    if req.app is None:
180
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
181
 
    else:
182
 
        app = ivle.conf.apps.app_url[req.app]
183
 
 
184
 
    # Check if app requires auth. If so, perform authentication and login.
185
 
    # This will either return a User object, None, or perform a redirect
186
 
    # which we will not catch here.
187
 
    if app.requireauth:
188
 
        logged_in = req.user is not None
189
 
    else:
190
 
        logged_in = True
191
 
 
192
 
    assert logged_in # XXX
193
 
 
194
 
    if logged_in:
195
 
        # Keep the user's session alive by writing to the session object.
196
 
        # req.get_session().save()
197
 
        # Well, it's a fine idea, but it creates considerable grief in the
198
 
        # concurrent update department, so instead, we'll just make the
199
 
        # sessions not time out.
200
 
        req.get_session().unlock()
201
 
 
202
 
        # Call the specified app with the request object
203
 
        apps.call_app(app.dir, req)
204
 
 
205
 
    # MAKE SURE we write the HTTP (and possibly HTML) header. This
206
 
    # wouldn't happen if nothing else ever got written, so we have to make
207
 
    # sure.
208
 
    req.ensure_headers_written()
209
 
 
210
 
    # When done, write out the HTML footer if the app has requested it
211
 
    if req.write_html_head_foot:
212
 
        html.write_html_foot(req)
213
 
 
214
 
    # Note: Apache will not write custom HTML error messages here.
215
 
    # Use req.throw_error to do that.
216
 
    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()
217
223
 
218
224
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
219
225
    """
222
228
    This is a full handler. It assumes nothing has been written, and writes a
223
229
    complete HTML page.
224
230
    req: May be EITHER an IVLE req or an Apache req.
225
 
    IVLE reqs may have the HTML head/foot written (on a 400 error), but
226
 
    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
227
232
    the IVLE request is created.
228
233
    """
229
234
    req.content_type = "text/html"
230
 
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
 
235
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
231
236
    logfail = False
232
 
    # For some reason, some versions of mod_python have "_server" instead of
233
 
    # "main_server". So we check for both.
234
 
    try:
235
 
        admin_email = mod_python.apache.main_server.server_admin
236
 
    except AttributeError:
237
 
        try:
238
 
            admin_email = mod_python.apache._server.server_admin
239
 
        except AttributeError:
240
 
            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.
241
240
    try:
242
241
        httpcode = exc_value.httpcode
243
242
        req.status = httpcode
244
243
    except AttributeError:
245
244
        httpcode = None
246
245
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
246
 
247
247
    try:
248
248
        publicmode = req.publicmode
249
249
    except AttributeError:
252
252
        login = req.user.login
253
253
    except AttributeError:
254
254
        login = None
255
 
    try:
256
 
        role = req.user.role
257
 
    except AttributeError:
258
 
        role = None
259
255
 
260
256
    # Log File
261
257
    try:
271
267
            filemode='a')
272
268
    except IOError:
273
269
        logfail = True
274
 
    logging.debug('Logging Unhandled Exception')
275
 
 
276
 
    # We handle 3 types of error.
277
 
    # IVLEErrors with 4xx response codes (client error).
278
 
    # IVLEErrors with 5xx response codes (handled server error).
279
 
    # Other exceptions (unhandled server error).
280
 
    # IVLEErrors should not have other response codes than 4xx or 5xx
281
 
    # (eg. throw_redirect should have been used for 3xx codes).
282
 
    # Therefore, that is treated as an unhandled error.
283
 
 
284
 
    if (exc_type == util.IVLEError and httpcode >= 400
285
 
        and httpcode <= 499):
286
 
        # IVLEErrors with 4xx response codes are client errors.
287
 
        # Therefore, these have a "nice" response (we even coat it in the IVLE
288
 
        # HTML wrappers).
289
 
        
290
 
        req.write_html_head_foot = True
291
 
        req.write_javascript_settings = False
292
 
        req.write('<div id="ivle_padding">\n')
293
 
        try:
294
 
            codename, msg = req.get_http_codename(httpcode)
295
 
        except AttributeError:
296
 
            codename, msg = None, None
297
 
        # Override the default message with the supplied one,
298
 
        # if available.
299
 
        if exc_value.message is not None:
300
 
            msg = exc_value.message
301
 
        if codename is not None:
302
 
            req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
303
 
        else:
304
 
            req.write("<h1>Error</h1>\n")
305
 
        if msg is not None:
306
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
307
 
        else:
308
 
            req.write("<p>An unknown error occured.</p>\n")
309
 
        
310
 
        # Logging
311
 
        logging.info(str(msg))
312
 
        
313
 
        req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
314
 
        if logfail:
315
 
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
316
 
                %cgi.escape(logfile))
317
 
        req.write('</div>\n')
318
 
        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)
319
281
    else:
320
 
        # A "bad" error message. We shouldn't get here unless IVLE
321
 
        # misbehaves (which is currently very easy, if things aren't set up
322
 
        # correctly).
323
 
        # Write the traceback.
324
 
        # If this is a non-4xx IVLEError, get the message and httpcode and
325
 
        # make the error message a bit nicer (but still include the
326
 
        # traceback).
327
 
        # We also need to special-case IVLEJailError, as we can get another
328
 
        # almost-exception out of it.
329
 
 
330
 
        codename, msg = None, None
331
 
 
332
 
        if exc_type is util.IVLEJailError:
333
 
            msg = exc_value.type_str + ": " + exc_value.message
334
 
            tb = 'Exception information extracted from IVLEJailError:\n'
335
 
            tb += urllib.unquote(exc_value.info)
336
 
        else:
337
 
            try:
338
 
                codename, msg = req.get_http_codename(httpcode)
339
 
            except AttributeError:
340
 
                pass
341
 
            # Override the default message with the supplied one,
342
 
            # if available.
343
 
            if hasattr(exc_value, 'message') and exc_value.message is not None:
344
 
                msg = exc_value.message
345
 
                # Prepend the exception type
346
 
                if exc_type != util.IVLEError:
347
 
                    msg = exc_type.__name__ + ": " + repr(msg)
348
 
 
349
 
            tb = ''.join(traceback.format_exception(exc_type, exc_value,
350
 
                                                    exc_traceback))
351
 
 
352
 
        # Logging
353
 
        logging.error('%s\n%s'%(str(msg), tb))
354
 
        # Error messages are only displayed is the user is NOT a student,
355
 
        # or if there has been a problem logging the error message
356
 
        show_errors = (not publicmode) and ((login and \
357
 
                            str(role) != "student") or logfail)
358
 
        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"                 
359
291
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
360
292
<html xmlns="http://www.w3.org/1999/xhtml">
361
293
<head><title>IVLE Internal Server Error</title></head>
362
294
<body>
363
 
<h1>IVLE Internal Server Error""")
364
 
        if (show_errors):
365
 
            if (codename is not None
366
 
                        and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
367
 
                req.write(": %s" % cgi.escape(codename))
368
 
        
369
 
        req.write("""</h1>
 
295
<h1>IVLE Internal Server Error</h1>
370
296
<p>An error has occured which is the fault of the IVLE developers or
371
 
administration. The developers have been notified.</p>
372
 
""")
373
 
        if (show_errors):
374
 
            if msg is not None:
375
 
                req.write("<p>%s</p>\n" % cgi.escape(msg))
376
 
            if httpcode is not None:
377
 
                req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
378
 
            req.write("""
379
 
    <p>Please report this to <a href="mailto:%s">%s</a> (the system
380
 
    administrator). Include the following information:</p>
381
 
    """ % (cgi.escape(admin_email), cgi.escape(admin_email)))
382
 
 
383
 
            req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
384
 
            if logfail:
385
 
                req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
386
 
                    %cgi.escape(logfile))
387
 
        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>")