← 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: mattgiuca
  • Date: 2008-01-23 05:48:04 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:272
consoleservice: Error if not POST.

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
3
 
#
4
 
# This program is free software; you can redistribute it and/or modify
5
 
# it under the terms of the GNU General Public License as published by
6
 
# the Free Software Foundation; either version 2 of the License, or
7
 
# (at your option) any later version.
8
 
#
9
 
# This program is distributed in the hope that it will be useful,
10
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
 
# GNU General Public License for more details.
13
 
#
14
 
# You should have received a copy of the GNU General Public License
15
 
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
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
 
"""
28
 
 
29
 
import sys
30
 
import os
31
 
import os.path
32
 
import urllib
33
 
import urlparse
34
 
import cgi
35
 
import traceback
36
 
import logging
37
 
import socket
38
 
import time
39
 
 
40
 
import mod_python
41
 
 
42
 
from ivle import util
43
 
import ivle.config
44
 
from ivle.dispatch.request import Request
45
 
import ivle.webapp.security
46
 
from ivle.webapp.base.plugins import ViewPlugin, PublicViewPlugin
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):
78
 
    """
79
 
    Build a Mapper object for doing URL matching using 'routes', based on the
80
 
    given plugin registry.
81
 
    """
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
 
 
96
 
    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
118
 
 
119
 
def handler(apachereq):
120
 
    """Handles an HTTP request.
121
 
 
122
 
    Intended to be called by mod_python, as a handler.
123
 
 
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
 
 
129
 
    req.publisher = generate_publisher(
130
 
        config.plugin_index[ViewPlugin], ApplicationRoot(req),
131
 
        publicmode=req.publicmode)
132
 
 
133
 
    try:
134
 
        obj, viewcls, subpath = req.publisher.resolve(req.uri.decode('utf-8'))
135
 
        try:
136
 
            # We 404 if we have a subpath but the view forbids it.
137
 
            if not viewcls.subpath_allowed and subpath:
138
 
                raise NotFound()
139
 
 
140
 
            # Instantiate the view, which should be a BaseView class
141
 
            view = viewcls(req, obj, subpath)
142
 
 
143
 
            # Check that the request (mainly the user) is permitted to access
144
 
            # the view.
145
 
            if not view.authorize(req):
146
 
                # Indicate the forbidden object if this is an admin.
147
 
                if req.user and req.user.admin:
148
 
                    raise Unauthorized('Unauthorized: %s' % view)
149
 
                else:
150
 
                    raise Unauthorized()
151
 
 
152
 
            # Non-GET requests from other sites leave us vulnerable to
153
 
            # CSRFs. Block them.
154
 
            referer = req.headers_in.get('Referer')
155
 
            if (referer is None or
156
 
                urlparse.urlparse(req.headers_in.get('Referer')).netloc !=
157
 
                    req.hostname):
158
 
                if req.method != 'GET' and not view.offsite_posts_allowed:
159
 
                    raise BadRequest(
160
 
                        "Non-GET requests from external sites are forbidden "
161
 
                        "for security reasons.")
162
 
 
163
 
            # Render the output
164
 
            view.render(req)
165
 
        except HTTPError, e:
166
 
            # A view explicitly raised an HTTP error. Respect it.
167
 
            req.status = e.code
168
 
 
169
 
            # Try to find a custom error view.
170
 
            if hasattr(viewcls, 'get_error_view'):
171
 
                errviewcls = viewcls.get_error_view(e)
172
 
            else:
173
 
                errviewcls = XHTMLView.get_error_view(e)
174
 
 
175
 
            if errviewcls:
176
 
                errview = errviewcls(req, e, obj)
177
 
                errview.render(req)
178
 
                return req.OK
179
 
            elif e.message:
180
 
                req.write(e.message)
181
 
                return req.OK
182
 
            else:
183
 
                return e.code
184
 
        except mod_python.apache.SERVER_RETURN:
185
 
            # A mod_python-specific Apache error.
186
 
            # XXX: We need to raise these because req.throw_error() uses them.
187
 
            # Remove this after Google Code issue 117 is fixed.
188
 
            raise
189
 
        except Exception, e:
190
 
            # A non-HTTPError appeared. We have an unknown exception. Panic.
191
 
            handle_unknown_exception(req, *sys.exc_info())
192
 
            return req.OK
193
 
        else:
194
 
            # Commit the transaction if we have a store open.
195
 
            req.commit()
196
 
            return req.OK
197
 
    except Unauthorized, e:
198
 
        # Resolution failed due to a permission check. Display a pretty
199
 
        # error, or maybe a login page.
200
 
        XHTMLView.get_error_view(e)(req, e, req.publisher.root).render(req)
201
 
        return req.OK
202
 
    except PublishingError, e:
203
 
        req.status = 404
204
 
 
205
 
        if req.user and req.user.admin:
206
 
            XHTMLErrorView(req, NotFound('Not found: ' +
207
 
                                         str(e.args)), e[0]).render(req)
208
 
        else:
209
 
            XHTMLErrorView(req, NotFound(), e[0]).render(req)
210
 
 
211
 
        return req.OK
212
 
    finally:
213
 
        # Make sure we close the store.
214
 
        req.cleanup()
215
 
 
216
 
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
217
 
    """
218
 
    Given an exception that has just been thrown from IVLE, print its details
219
 
    to the request.
220
 
    This is a full handler. It assumes nothing has been written, and writes a
221
 
    complete HTML page.
222
 
    req: May be EITHER an IVLE req or an Apache req.
223
 
    The handler code may pass an apache req if an exception occurs before
224
 
    the IVLE request is created.
225
 
    """
226
 
    req.content_type = "text/html"
227
 
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
228
 
    logfail = False
229
 
 
230
 
    req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
231
 
 
232
 
    try:
233
 
        publicmode = req.publicmode
234
 
    except AttributeError:
235
 
        publicmode = True
236
 
    try:
237
 
        login = req.user.login
238
 
    except AttributeError:
239
 
        login = None
240
 
 
241
 
    # Log File
242
 
    try:
243
 
        for h in logging.getLogger().handlers:
244
 
            logging.getLogger().removeHandler(h)
245
 
        logging.basicConfig(level=logging.INFO,
246
 
            format='%(asctime)s %(levelname)s: ' +
247
 
                '(HTTP: ' + str(req.status) +
248
 
                ', Ref: ' + str(login) + '@' +
249
 
                str(socket.gethostname()) + str(req.uri) +
250
 
                ') %(message)s',
251
 
            filename=logfile,
252
 
            filemode='a')
253
 
    except IOError:
254
 
        logfail = True
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)
266
 
    else:
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"                 
276
 
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
277
 
<html xmlns="http://www.w3.org/1999/xhtml">
278
 
<head><title>IVLE Internal Server Error</title></head>
279
 
<body>
280
 
<h1>IVLE Internal Server Error</h1>
281
 
<p>An error has occured which is the fault of the IVLE developers or
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>")