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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

  • Committer: Matt Giuca
  • Date: 2010-02-25 01:53:19 UTC
  • Revision ID: matt.giuca@gmail.com-20100225015319-7j0oounlhi1bj6fp
Fixed broken console, due to function called with not enough arguments.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
43
import ivle.config
45
45
import ivle.webapp.security
46
46
from ivle.webapp.base.plugins import ViewPlugin, PublicViewPlugin
47
47
from ivle.webapp.base.xhtml import XHTMLView, XHTMLErrorView
48
 
from ivle.webapp.errors import HTTPError, Unauthorized, NotFound
 
48
from ivle.webapp.errors import BadRequest, HTTPError, NotFound, Unauthorized
 
49
from ivle.webapp.publisher import Publisher, PublishingError
 
50
from ivle.webapp import ApplicationRoot
49
51
 
50
52
config = ivle.config.Config()
51
53
 
52
 
def generate_router(view_plugins, attr):
 
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
 
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
67
118
 
68
119
def handler(apachereq):
69
120
    """Handles an HTTP request.
84
135
        if user and user.valid:
85
136
            req.user = user
86
137
 
87
 
    if req.publicmode:
88
 
        req.mapper = generate_router(config.plugin_index[PublicViewPlugin],
89
 
                                    'public_urls')
90
 
    else:
91
 
        req.mapper = generate_router(config.plugin_index[ViewPlugin], 'urls')
 
138
    req.publisher = generate_publisher(
 
139
        config.plugin_index[ViewPlugin],
 
140
        ApplicationRoot(req.config, req.store, req.user),
 
141
        publicmode=req.publicmode)
92
142
 
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']
 
143
    try:
 
144
        obj, viewcls, subpath = req.publisher.resolve(req.uri.decode('utf-8'))
100
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
 
101
150
            # Instantiate the view, which should be a BaseView class
102
 
            view = viewcls(req, **kwargs)
 
151
            view = viewcls(req, obj, subpath)
103
152
 
104
153
            # Check that the request (mainly the user) is permitted to access
105
154
            # the view.
106
155
            if not view.authorize(req):
107
 
                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
 
108
173
            # Render the output
109
174
            view.render(req)
110
175
        except HTTPError, e:
118
183
                errviewcls = XHTMLView.get_error_view(e)
119
184
 
120
185
            if errviewcls:
121
 
                errview = errviewcls(req, e)
 
186
                errview = errviewcls(req, e, obj)
122
187
                errview.render(req)
123
188
                return req.OK
124
189
            elif e.message:
138
203
        else:
139
204
            req.store.commit()
140
205
            return req.OK
141
 
    else:
142
 
        XHTMLErrorView(req, NotFound()).render(req)
143
 
        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()
144
223
 
145
224
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
146
225
    """
155
234
    req.content_type = "text/html"
156
235
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
157
236
    logfail = False
 
237
 
 
238
    # XXX: This remains here for ivle.interpret's IVLEErrors. Once we rewrite
 
239
    #      fileservice, req.status should always be 500 (ISE) here.
158
240
    try:
159
241
        httpcode = exc_value.httpcode
160
242
        req.status = httpcode
161
243
    except AttributeError:
162
244
        httpcode = None
163
245
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
246
 
164
247
    try:
165
248
        publicmode = req.publicmode
166
249
    except AttributeError:
189
272
    # misbehaves (which is currently very easy, if things aren't set up
190
273
    # correctly).
191
274
    # 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
 
275
 
 
276
    # We need to special-case IVLEJailError, as we can get another
196
277
    # almost-exception out of it.
197
 
 
198
 
    codename, msg = None, None
199
 
 
200
278
    if exc_type is util.IVLEJailError:
201
 
        msg = exc_value.type_str + ": " + exc_value.message
202
279
        tb = 'Exception information extracted from IVLEJailError:\n'
203
280
        tb += urllib.unquote(exc_value.info)
204
281
    else:
205
 
        try:
206
 
            codename, msg = req.get_http_codename(httpcode)
207
 
        except AttributeError:
208
 
            pass
209
 
 
210
282
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
211
283
                                                exc_traceback))
212
284
 
213
 
    logging.error('%s\n%s'%(str(msg), tb))
 
285
    logging.error('\n' + tb)
214
286
 
215
287
    # Error messages are only displayed is the user is NOT a student,
216
288
    # or if there has been a problem logging the error message
220
292
<html xmlns="http://www.w3.org/1999/xhtml">
221
293
<head><title>IVLE Internal Server Error</title></head>
222
294
<body>
223
 
<h1>IVLE Internal Server Error""")
224
 
    if show_errors:
225
 
        if codename is not None and \
226
 
           httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR:
227
 
            req.write(": %s" % cgi.escape(codename))
228
 
 
229
 
    req.write("""</h1>
 
295
<h1>IVLE Internal Server Error</h1>
230
296
<p>An error has occured which is the fault of the IVLE developers or
231
297
administrators. """)
232
298
 
238
304
    req.write("</p>")
239
305
 
240
306
    if show_errors:
241
 
        if msg is not None:
242
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
243
 
        if httpcode is not None:
244
 
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
245
307
        req.write("<h2>Debugging information</h2>")
246
 
 
247
308
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
248
309
    req.write("</body></html>")