← 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: Matt Giuca
  • Date: 2009-12-01 02:13:33 UTC
  • mto: This revision was merged to the branch mainline in revision 1322.
  • Revision ID: matt.giuca@gmail.com-20091201021333-747yff2jq5wsu4u1
doc/dev/architecture: Genshi is now the standard. Added note about the raw stream for old-school apps.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/__init__.py
30
30
import os
31
31
import os.path
32
32
import urllib
33
 
import urlparse
34
33
import cgi
35
34
import traceback
36
35
import logging
38
37
import time
39
38
 
40
39
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 BadRequest, HTTPError, NotFound, Unauthorized
49
 
from ivle.webapp.publisher import Publisher, PublishingError
50
 
from ivle.webapp import ApplicationRoot
 
48
from ivle.webapp.errors import HTTPError, Unauthorized, NotFound
51
49
 
52
50
config = ivle.config.Config()
53
51
 
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):
 
52
def generate_router(view_plugins, attr):
78
53
    """
79
54
    Build a Mapper object for doing URL matching using 'routes', based on the
80
55
    given plugin registry.
81
56
    """
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
 
 
 
57
    m = routes.Mapper(explicit=True)
96
58
    for plugin in view_plugins:
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
 
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
118
67
 
119
68
def handler(apachereq):
120
69
    """Handles an HTTP request.
135
84
        if user and user.valid:
136
85
            req.user = user
137
86
 
138
 
    req.publisher = generate_publisher(
139
 
        config.plugin_index[ViewPlugin],
140
 
        ApplicationRoot(req.config, req.store, req.user),
141
 
        publicmode=req.publicmode)
 
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')
142
92
 
143
 
    try:
144
 
        obj, viewcls, subpath = req.publisher.resolve(req.uri.decode('utf-8'))
 
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']
145
100
        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
 
 
150
101
            # Instantiate the view, which should be a BaseView class
151
 
            view = viewcls(req, obj, subpath)
 
102
            view = viewcls(req, **kwargs)
152
103
 
153
104
            # Check that the request (mainly the user) is permitted to access
154
105
            # the view.
155
106
            if not view.authorize(req):
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
 
 
 
107
                raise Unauthorized()
173
108
            # Render the output
174
109
            view.render(req)
175
110
        except HTTPError, e:
183
118
                errviewcls = XHTMLView.get_error_view(e)
184
119
 
185
120
            if errviewcls:
186
 
                errview = errviewcls(req, e, obj)
 
121
                errview = errviewcls(req, e)
187
122
                errview.render(req)
188
123
                return req.OK
189
124
            elif e.message:
203
138
        else:
204
139
            req.store.commit()
205
140
            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()
 
141
    else:
 
142
        XHTMLErrorView(req, NotFound()).render(req)
 
143
        return req.OK
223
144
 
224
145
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
225
146
    """