← 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: 2009-07-04 11:50:52 UTC
  • mto: (1294.4.2 ui-the-third)
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: grantw@unimelb.edu.au-20090704115052-g8f0ffjdcoc0t6uk
Don't explicitly raise RoutingError during media traversal.

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 cgi
 
34
import traceback
 
35
import logging
 
36
import socket
 
37
import time
 
38
 
 
39
import mod_python
 
40
 
 
41
from ivle import util
 
42
import ivle.config
 
43
from ivle.dispatch.request import Request
 
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.urls import Router, RoutingError
 
49
from ivle.webapp import ApplicationRoot
 
50
 
 
51
config = ivle.config.Config()
 
52
 
 
53
def generate_router(view_plugins, root):
 
54
    """
 
55
    Build a Mapper object for doing URL matching using 'routes', based on the
 
56
    given plugin registry.
 
57
    """
 
58
    r = Router(root=root)
 
59
 
 
60
    r.add_set_switch('api', 'api')
 
61
 
 
62
    for plugin in view_plugins:
 
63
        if hasattr(plugin, 'forward_routes'):
 
64
            for fr in plugin.forward_routes:
 
65
                r.add_forward(*fr)
 
66
 
 
67
        if hasattr(plugin, 'views'):
 
68
            for v in plugin.views:
 
69
                r.add_view(*v)
 
70
 
 
71
    return r
 
72
 
 
73
def handler(apachereq):
 
74
    """Handles an HTTP request.
 
75
 
 
76
    Intended to be called by mod_python, as a handler.
 
77
 
 
78
    @param apachereq: An Apache request object.
 
79
    """
 
80
    # Make the request object into an IVLE request which can be given to views
 
81
    req = Request(apachereq, config)
 
82
 
 
83
    # Hack? Try and get the user login early just in case we throw an error
 
84
    # (most likely 404) to stop us seeing not logged in even when we are.
 
85
    if not req.publicmode:
 
86
        user = ivle.webapp.security.get_user_details(req)
 
87
 
 
88
        # Don't set the user if it is disabled or hasn't accepted the ToS.
 
89
        if user and user.valid:
 
90
            req.user = user
 
91
 
 
92
    if req.publicmode:
 
93
        raise NotImplementedError("no public mode with obtrav yet!")
 
94
 
 
95
    req.router = generate_router(config.plugin_index[ViewPlugin],
 
96
                                 ApplicationRoot(req.config, req.store))
 
97
 
 
98
    try:
 
99
        obj, viewcls, subpath = req.router.resolve(req.uri.decode('utf-8'))
 
100
        try:
 
101
            # Instantiate the view, which should be a BaseView class
 
102
            view = viewcls(req, obj)
 
103
 
 
104
            # Check that the request (mainly the user) is permitted to access
 
105
            # the view.
 
106
            if not view.authorize(req):
 
107
                raise Unauthorized()
 
108
            # Render the output
 
109
            view.render(req)
 
110
        except HTTPError, e:
 
111
            # A view explicitly raised an HTTP error. Respect it.
 
112
            req.status = e.code
 
113
 
 
114
            # Try to find a custom error view.
 
115
            if hasattr(viewcls, 'get_error_view'):
 
116
                errviewcls = viewcls.get_error_view(e)
 
117
            else:
 
118
                errviewcls = XHTMLView.get_error_view(e)
 
119
 
 
120
            if errviewcls:
 
121
                errview = errviewcls(req, e)
 
122
                errview.render(req)
 
123
                return req.OK
 
124
            elif e.message:
 
125
                req.write(e.message)
 
126
                return req.OK
 
127
            else:
 
128
                return e.code
 
129
        except mod_python.apache.SERVER_RETURN:
 
130
            # A mod_python-specific Apache error.
 
131
            # XXX: We need to raise these because req.throw_error() uses them.
 
132
            # Remove this after Google Code issue 117 is fixed.
 
133
            raise
 
134
        except Exception, e:
 
135
            # A non-HTTPError appeared. We have an unknown exception. Panic.
 
136
            handle_unknown_exception(req, *sys.exc_info())
 
137
            return req.OK
 
138
        else:
 
139
            req.store.commit()
 
140
            return req.OK
 
141
    except RoutingError, e:
 
142
        if req.user.admin:
 
143
            XHTMLErrorView(req, NotFound('Not found: ' +
 
144
                                         str(e.args))).render(req)
 
145
        else:
 
146
            XHTMLErrorView(req, NotFound()).render(req)
 
147
 
 
148
        return req.OK
 
149
 
 
150
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
 
151
    """
 
152
    Given an exception that has just been thrown from IVLE, print its details
 
153
    to the request.
 
154
    This is a full handler. It assumes nothing has been written, and writes a
 
155
    complete HTML page.
 
156
    req: May be EITHER an IVLE req or an Apache req.
 
157
    The handler code may pass an apache req if an exception occurs before
 
158
    the IVLE request is created.
 
159
    """
 
160
    req.content_type = "text/html"
 
161
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
 
162
    logfail = False
 
163
 
 
164
    # XXX: This remains here for ivle.interpret's IVLEErrors. Once we rewrite
 
165
    #      fileservice, req.status should always be 500 (ISE) here.
 
166
    try:
 
167
        httpcode = exc_value.httpcode
 
168
        req.status = httpcode
 
169
    except AttributeError:
 
170
        httpcode = None
 
171
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
172
 
 
173
    try:
 
174
        publicmode = req.publicmode
 
175
    except AttributeError:
 
176
        publicmode = True
 
177
    try:
 
178
        login = req.user.login
 
179
    except AttributeError:
 
180
        login = None
 
181
 
 
182
    # Log File
 
183
    try:
 
184
        for h in logging.getLogger().handlers:
 
185
            logging.getLogger().removeHandler(h)
 
186
        logging.basicConfig(level=logging.INFO,
 
187
            format='%(asctime)s %(levelname)s: ' +
 
188
                '(HTTP: ' + str(req.status) +
 
189
                ', Ref: ' + str(login) + '@' +
 
190
                str(socket.gethostname()) + str(req.uri) +
 
191
                ') %(message)s',
 
192
            filename=logfile,
 
193
            filemode='a')
 
194
    except IOError:
 
195
        logfail = True
 
196
 
 
197
    # A "bad" error message. We shouldn't get here unless IVLE
 
198
    # misbehaves (which is currently very easy, if things aren't set up
 
199
    # correctly).
 
200
    # Write the traceback.
 
201
 
 
202
    # We need to special-case IVLEJailError, as we can get another
 
203
    # almost-exception out of it.
 
204
    if exc_type is util.IVLEJailError:
 
205
        tb = 'Exception information extracted from IVLEJailError:\n'
 
206
        tb += urllib.unquote(exc_value.info)
 
207
    else:
 
208
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
 
209
                                                exc_traceback))
 
210
 
 
211
    logging.error('\n' + tb)
 
212
 
 
213
    # Error messages are only displayed is the user is NOT a student,
 
214
    # or if there has been a problem logging the error message
 
215
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
 
216
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
 
217
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
 
218
<html xmlns="http://www.w3.org/1999/xhtml">
 
219
<head><title>IVLE Internal Server Error</title></head>
 
220
<body>
 
221
<h1>IVLE Internal Server Error</h1>
 
222
<p>An error has occured which is the fault of the IVLE developers or
 
223
administrators. """)
 
224
 
 
225
    if logfail:
 
226
        req.write("Please report this issue to the server administrators, "
 
227
                  "along with the following information.")
 
228
    else:
 
229
        req.write("Details have been logged for further examination.")
 
230
    req.write("</p>")
 
231
 
 
232
    if show_errors:
 
233
        req.write("<h2>Debugging information</h2>")
 
234
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
 
235
    req.write("</body></html>")