~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

  • Committer: Matt Giuca
  • Date: 2009-12-08 05:05:20 UTC
  • Revision ID: matt.giuca@gmail.com-20091208050520-a4nmmjxwtmhip063
ivle-createdatadirs: Fixed exit -- if path already exists, log and exit(0).

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
35
35
import logging
36
36
import socket
37
37
import time
38
 
import inspect
39
38
 
40
39
import mod_python
41
 
import routes
42
40
 
43
41
from ivle import util
44
 
import ivle.conf
45
 
import ivle.conf.apps
 
42
import ivle.config
46
43
from ivle.dispatch.request import Request
47
 
from ivle.dispatch import login
48
 
from ivle.webapp.base.plugins import ViewPlugin
49
 
from ivle.webapp.errors import HTTPError
50
 
import apps
51
 
import html
52
 
 
53
 
# XXX List of plugins, which will eventually be read in from conf
54
 
plugins_HACK = [
55
 
    'ivle.webapp.core#Plugin',
56
 
    'ivle.webapp.admin.user#Plugin',
57
 
    'ivle.webapp.tutorial#Plugin',
58
 
    'ivle.webapp.admin.subject#Plugin',
59
 
    'ivle.webapp.filesystem.browser#Plugin',
60
 
    'ivle.webapp.filesystem.diff#Plugin',
61
 
    'ivle.webapp.filesystem.svnlog#Plugin',
62
 
    'ivle.webapp.groups#Plugin',
63
 
    'ivle.webapp.console#Plugin',
64
 
    'ivle.webapp.security#Plugin',
65
 
    'ivle.webapp.media#Plugin',
66
 
    'ivle.webapp.forum#Plugin',
67
 
68
 
 
69
 
def generate_route_mapper(view_plugins):
 
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):
70
77
    """
71
78
    Build a Mapper object for doing URL matching using 'routes', based on the
72
79
    given plugin registry.
73
80
    """
74
 
    m = routes.Mapper(explicit=True)
 
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
 
75
95
    for plugin in view_plugins:
76
 
        # Establish a URL pattern for each element of plugin.urls
77
 
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
78
 
        for url in plugin.urls:
79
 
            routex = url[0]
80
 
            view_class = url[1]
81
 
            kwargs_dict = url[2] if len(url) >= 3 else {}
82
 
            m.connect(routex, view=view_class, **kwargs_dict)
83
 
    return m
84
 
 
85
 
def get_plugin(pluginstr):
86
 
    plugin_path, classname = pluginstr.split('#')
87
 
    # Load the plugin module from somewhere in the Python path
88
 
    # (Note that plugin_path is a fully-qualified Python module name).
89
 
    return (plugin_path,
90
 
            getattr(__import__(plugin_path, fromlist=[classname]), classname))
91
 
 
92
 
def handler(req):
93
 
    """Handles a request which may be to anywhere in the site except media.
 
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
 
94
121
    Intended to be called by mod_python, as a handler.
95
122
 
96
 
    req: An Apache request object.
97
 
    """
98
 
    # Make the request object into an IVLE request which can be passed to apps
99
 
    apachereq = req
100
 
    try:
101
 
        req = Request(req, html.write_html_head)
102
 
    except Exception:
103
 
        # Pass the apachereq to error reporter, since ivle req isn't created
104
 
        # yet.
105
 
        handle_unknown_exception(apachereq, *sys.exc_info())
106
 
        # Tell Apache not to generate its own errors as well
107
 
        return mod_python.apache.OK
108
 
 
109
 
    # Run the main handler, and catch all exceptions
110
 
    try:
111
 
        return handler_(req, apachereq)
112
 
    except mod_python.apache.SERVER_RETURN:
113
 
        # An apache error. We discourage these, but they might still happen.
114
 
        # Just raise up.
115
 
        raise
116
 
    except Exception:
117
 
        handle_unknown_exception(req, *sys.exc_info())
118
 
        # Tell Apache not to generate its own errors as well
119
 
        return mod_python.apache.OK
120
 
 
121
 
def handler_(req, apachereq):
122
 
    """
123
 
    Nested handler function. May raise exceptions. The top-level handler is
124
 
    just used to catch exceptions.
125
 
    Takes both an IVLE request and an Apache req.
126
 
    """
 
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
 
127
128
    # Hack? Try and get the user login early just in case we throw an error
128
129
    # (most likely 404) to stop us seeing not logged in even when we are.
129
130
    if not req.publicmode:
130
 
        req.user = login.get_user_details(req)
131
 
 
132
 
    ### BEGIN New plugins framework ###
133
 
    # XXX This should be done ONCE per Python process, not per request.
134
 
    # (Wait till WSGI)
135
 
    # XXX No authentication is done here
136
 
    req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
137
 
    # Index the plugins by base class
138
 
    req.plugin_index = {}
139
 
    for plugin in req.plugins.values():
140
 
        # Getmro returns a tuple of all the super-classes of the plugin
141
 
        for base in inspect.getmro(plugin):
142
 
            if base not in req.plugin_index:
143
 
                req.plugin_index[base] = []
144
 
            req.plugin_index[base].append(plugin)
145
 
    req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
146
 
    req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
147
 
 
148
 
    matchdict = req.mapper.match(req.uri)
149
 
    if matchdict is not None:
150
 
        viewcls = matchdict['view']
151
 
        # Get the remaining arguments, less 'view', 'action' and 'controller'
152
 
        # (The latter two seem to be built-in, and we don't want them).
153
 
        kwargs = matchdict.copy()
154
 
        del kwargs['view']
 
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'))
155
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
 
156
149
            # Instantiate the view, which should be a BaseView class
157
 
            view = viewcls(req, **kwargs)
 
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()
158
160
            # Render the output
159
161
            view.render(req)
160
162
        except HTTPError, e:
165
167
            if hasattr(viewcls, 'get_error_view'):
166
168
                errviewcls = viewcls.get_error_view(e)
167
169
            else:
168
 
                errviewcls = None
 
170
                errviewcls = XHTMLView.get_error_view(e)
169
171
 
170
172
            if errviewcls:
171
 
                errview = errviewcls(req, e)
 
173
                errview = errviewcls(req, e, obj)
172
174
                errview.render(req)
173
175
                return req.OK
174
 
            else:
 
176
            elif e.message:
175
177
                req.write(e.message)
 
178
                return req.OK
 
179
            else:
176
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
177
186
        except Exception, e:
178
187
            # A non-HTTPError appeared. We have an unknown exception. Panic.
179
188
            handle_unknown_exception(req, *sys.exc_info())
181
190
        else:
182
191
            req.store.commit()
183
192
            return req.OK
184
 
    ### END New plugins framework ###
185
 
 
186
 
    # Check req.app to see if it is valid. 404 if not.
187
 
    if req.app is not None and req.app not in ivle.conf.apps.app_url:
188
 
        req.throw_error(Request.HTTP_NOT_FOUND,
189
 
            "There is no application called %s." % repr(req.app))
190
 
 
191
 
    # Special handling for public mode - only allow the public app, call it
192
 
    # and get out.
193
 
    # NOTE: This will not behave correctly if the public app uses
194
 
    # write_html_head_foot, but "serve" does not.
195
 
    if req.publicmode:
196
 
        if req.app != ivle.conf.apps.public_app:
197
 
            req.throw_error(Request.HTTP_FORBIDDEN,
198
 
                "This application is not available on the public site.")
199
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
200
 
        apps.call_app(app.dir, req)
 
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)
201
197
        return req.OK
202
 
 
203
 
    # app is the App object for the chosen app
204
 
    if req.app is None:
205
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
206
 
    else:
207
 
        app = ivle.conf.apps.app_url[req.app]
208
 
 
209
 
    # Check if app requires auth. If so, perform authentication and login.
210
 
    # This will either return a User object, None, or perform a redirect
211
 
    # which we will not catch here.
212
 
    if app.requireauth:
213
 
        req.user = login.login(req)
214
 
        logged_in = req.user is not None
215
 
    else:
216
 
        req.user = login.get_user_details(req)
217
 
        logged_in = True
218
 
 
219
 
    if logged_in:
220
 
        # Keep the user's session alive by writing to the session object.
221
 
        # req.get_session().save()
222
 
        # Well, it's a fine idea, but it creates considerable grief in the
223
 
        # concurrent update department, so instead, we'll just make the
224
 
        # sessions not time out.
225
 
        req.get_session().unlock()
226
 
 
227
 
        # If user did not specify an app, HTTP redirect to default app and
228
 
        # exit.
229
 
        if req.app is None:
230
 
            req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
231
 
 
232
 
        # Set the default title to the app's tab name, if any. Otherwise URL
233
 
        # name.
234
 
        if app.name is not None:
235
 
            req.title = app.name
 
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)
236
204
        else:
237
 
            req.title = req.app
238
 
 
239
 
        # Call the specified app with the request object
240
 
        apps.call_app(app.dir, req)
241
 
 
242
 
    # if not logged in, login.login will have written the login box.
243
 
    # Just clean up and exit.
244
 
 
245
 
    # MAKE SURE we write the HTTP (and possibly HTML) header. This
246
 
    # wouldn't happen if nothing else ever got written, so we have to make
247
 
    # sure.
248
 
    req.ensure_headers_written()
249
 
 
250
 
    # When done, write out the HTML footer if the app has requested it
251
 
    if req.write_html_head_foot:
252
 
        html.write_html_foot(req)
253
 
 
254
 
    # Note: Apache will not write custom HTML error messages here.
255
 
    # Use req.throw_error to do that.
256
 
    return req.OK
 
205
            XHTMLErrorView(req, NotFound(), e[0]).render(req)
 
206
 
 
207
        return req.OK
257
208
 
258
209
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
259
210
    """
262
213
    This is a full handler. It assumes nothing has been written, and writes a
263
214
    complete HTML page.
264
215
    req: May be EITHER an IVLE req or an Apache req.
265
 
    IVLE reqs may have the HTML head/foot written (on a 400 error), but
266
 
    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
267
217
    the IVLE request is created.
268
218
    """
269
219
    req.content_type = "text/html"
270
 
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
 
220
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
271
221
    logfail = False
272
 
    # For some reason, some versions of mod_python have "_server" instead of
273
 
    # "main_server". So we check for both.
274
 
    try:
275
 
        admin_email = mod_python.apache.main_server.server_admin
276
 
    except AttributeError:
277
 
        try:
278
 
            admin_email = mod_python.apache._server.server_admin
279
 
        except AttributeError:
280
 
            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.
281
225
    try:
282
226
        httpcode = exc_value.httpcode
283
227
        req.status = httpcode
284
228
    except AttributeError:
285
229
        httpcode = None
286
230
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
231
 
287
232
    try:
288
233
        publicmode = req.publicmode
289
234
    except AttributeError:
292
237
        login = req.user.login
293
238
    except AttributeError:
294
239
        login = None
295
 
    try:
296
 
        role = req.user.role
297
 
    except AttributeError:
298
 
        role = None
299
240
 
300
241
    # Log File
301
242
    try:
311
252
            filemode='a')
312
253
    except IOError:
313
254
        logfail = True
314
 
    logging.debug('Logging Unhandled Exception')
315
 
 
316
 
    # We handle 3 types of error.
317
 
    # IVLEErrors with 4xx response codes (client error).
318
 
    # IVLEErrors with 5xx response codes (handled server error).
319
 
    # Other exceptions (unhandled server error).
320
 
    # IVLEErrors should not have other response codes than 4xx or 5xx
321
 
    # (eg. throw_redirect should have been used for 3xx codes).
322
 
    # Therefore, that is treated as an unhandled error.
323
 
 
324
 
    if (exc_type == util.IVLEError and httpcode >= 400
325
 
        and httpcode <= 499):
326
 
        # IVLEErrors with 4xx response codes are client errors.
327
 
        # Therefore, these have a "nice" response (we even coat it in the IVLE
328
 
        # HTML wrappers).
329
 
        
330
 
        req.write_html_head_foot = True
331
 
        req.write_javascript_settings = False
332
 
        req.write('<div id="ivle_padding">\n')
333
 
        try:
334
 
            codename, msg = req.get_http_codename(httpcode)
335
 
        except AttributeError:
336
 
            codename, msg = None, None
337
 
        # Override the default message with the supplied one,
338
 
        # if available.
339
 
        if exc_value.message is not None:
340
 
            msg = exc_value.message
341
 
        if codename is not None:
342
 
            req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
343
 
        else:
344
 
            req.write("<h1>Error</h1>\n")
345
 
        if msg is not None:
346
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
347
 
        else:
348
 
            req.write("<p>An unknown error occured.</p>\n")
349
 
        
350
 
        # Logging
351
 
        logging.info(str(msg))
352
 
        
353
 
        req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
354
 
        if logfail:
355
 
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
356
 
                %cgi.escape(logfile))
357
 
        req.write('</div>\n')
358
 
        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)
359
266
    else:
360
 
        # A "bad" error message. We shouldn't get here unless IVLE
361
 
        # misbehaves (which is currently very easy, if things aren't set up
362
 
        # correctly).
363
 
        # Write the traceback.
364
 
        # If this is a non-4xx IVLEError, get the message and httpcode and
365
 
        # make the error message a bit nicer (but still include the
366
 
        # traceback).
367
 
        # We also need to special-case IVLEJailError, as we can get another
368
 
        # almost-exception out of it.
369
 
 
370
 
        codename, msg = None, None
371
 
 
372
 
        if exc_type is util.IVLEJailError:
373
 
            msg = exc_value.type_str + ": " + exc_value.message
374
 
            tb = 'Exception information extracted from IVLEJailError:\n'
375
 
            tb += urllib.unquote(exc_value.info)
376
 
        else:
377
 
            try:
378
 
                codename, msg = req.get_http_codename(httpcode)
379
 
            except AttributeError:
380
 
                pass
381
 
            # Override the default message with the supplied one,
382
 
            # if available.
383
 
            if hasattr(exc_value, 'message') and exc_value.message is not None:
384
 
                msg = exc_value.message
385
 
                # Prepend the exception type
386
 
                if exc_type != util.IVLEError:
387
 
                    msg = exc_type.__name__ + ": " + msg
388
 
 
389
 
            tb = ''.join(traceback.format_exception(exc_type, exc_value,
390
 
                                                    exc_traceback))
391
 
 
392
 
        # Logging
393
 
        logging.error('%s\n%s'%(str(msg), tb))
394
 
        # Error messages are only displayed is the user is NOT a student,
395
 
        # or if there has been a problem logging the error message
396
 
        show_errors = (not publicmode) and ((login and \
397
 
                            str(role) != "student") or logfail)
398
 
        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"                 
399
276
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
400
277
<html xmlns="http://www.w3.org/1999/xhtml">
401
278
<head><title>IVLE Internal Server Error</title></head>
402
279
<body>
403
 
<h1>IVLE Internal Server Error""")
404
 
        if (show_errors):
405
 
            if (codename is not None
406
 
                        and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
407
 
                req.write(": %s" % cgi.escape(codename))
408
 
        
409
 
        req.write("""</h1>
 
280
<h1>IVLE Internal Server Error</h1>
410
281
<p>An error has occured which is the fault of the IVLE developers or
411
 
administration. The developers have been notified.</p>
412
 
""")
413
 
        if (show_errors):
414
 
            if msg is not None:
415
 
                req.write("<p>%s</p>\n" % cgi.escape(msg))
416
 
            if httpcode is not None:
417
 
                req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
418
 
            req.write("""
419
 
    <p>Please report this to <a href="mailto:%s">%s</a> (the system
420
 
    administrator). Include the following information:</p>
421
 
    """ % (cgi.escape(admin_email), cgi.escape(admin_email)))
422
 
 
423
 
            req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
424
 
            if logfail:
425
 
                req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
426
 
                    %cgi.escape(logfile))
427
 
        req.write("</body></html>")
 
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>")
 
293
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
 
294
    req.write("</body></html>")