← 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 13:28:58 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-20090704132858-yii1cu4x9ad1m5mu
Port GroupsView.

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
            # We 404 if we have a subpath but the view forbids it.
 
102
            if not viewcls.subpath_allowed and subpath:
 
103
                raise NotFound()
 
104
 
 
105
            # Instantiate the view, which should be a BaseView class
 
106
            view = viewcls(req, obj, subpath)
 
107
 
 
108
            # Check that the request (mainly the user) is permitted to access
 
109
            # the view.
 
110
            if not view.authorize(req):
 
111
                raise Unauthorized()
 
112
            # Render the output
 
113
            view.render(req)
 
114
        except HTTPError, e:
 
115
            # A view explicitly raised an HTTP error. Respect it.
 
116
            req.status = e.code
 
117
 
 
118
            # Try to find a custom error view.
 
119
            if hasattr(viewcls, 'get_error_view'):
 
120
                errviewcls = viewcls.get_error_view(e)
 
121
            else:
 
122
                errviewcls = XHTMLView.get_error_view(e)
 
123
 
 
124
            if errviewcls:
 
125
                errview = errviewcls(req, e)
 
126
                errview.render(req)
 
127
                return req.OK
 
128
            elif e.message:
 
129
                req.write(e.message)
 
130
                return req.OK
 
131
            else:
 
132
                return e.code
 
133
        except mod_python.apache.SERVER_RETURN:
 
134
            # A mod_python-specific Apache error.
 
135
            # XXX: We need to raise these because req.throw_error() uses them.
 
136
            # Remove this after Google Code issue 117 is fixed.
 
137
            raise
 
138
        except Exception, e:
 
139
            # A non-HTTPError appeared. We have an unknown exception. Panic.
 
140
            handle_unknown_exception(req, *sys.exc_info())
 
141
            return req.OK
 
142
        else:
 
143
            req.store.commit()
 
144
            return req.OK
 
145
    except RoutingError, e:
 
146
        if req.user.admin:
 
147
            XHTMLErrorView(req, NotFound('Not found: ' +
 
148
                                         str(e.args))).render(req)
 
149
        else:
 
150
            XHTMLErrorView(req, NotFound()).render(req)
 
151
 
 
152
        return req.OK
 
153
 
 
154
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
 
155
    """
 
156
    Given an exception that has just been thrown from IVLE, print its details
 
157
    to the request.
 
158
    This is a full handler. It assumes nothing has been written, and writes a
 
159
    complete HTML page.
 
160
    req: May be EITHER an IVLE req or an Apache req.
 
161
    The handler code may pass an apache req if an exception occurs before
 
162
    the IVLE request is created.
 
163
    """
 
164
    req.content_type = "text/html"
 
165
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
 
166
    logfail = False
 
167
 
 
168
    # XXX: This remains here for ivle.interpret's IVLEErrors. Once we rewrite
 
169
    #      fileservice, req.status should always be 500 (ISE) here.
 
170
    try:
 
171
        httpcode = exc_value.httpcode
 
172
        req.status = httpcode
 
173
    except AttributeError:
 
174
        httpcode = None
 
175
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
176
 
 
177
    try:
 
178
        publicmode = req.publicmode
 
179
    except AttributeError:
 
180
        publicmode = True
 
181
    try:
 
182
        login = req.user.login
 
183
    except AttributeError:
 
184
        login = None
 
185
 
 
186
    # Log File
 
187
    try:
 
188
        for h in logging.getLogger().handlers:
 
189
            logging.getLogger().removeHandler(h)
 
190
        logging.basicConfig(level=logging.INFO,
 
191
            format='%(asctime)s %(levelname)s: ' +
 
192
                '(HTTP: ' + str(req.status) +
 
193
                ', Ref: ' + str(login) + '@' +
 
194
                str(socket.gethostname()) + str(req.uri) +
 
195
                ') %(message)s',
 
196
            filename=logfile,
 
197
            filemode='a')
 
198
    except IOError:
 
199
        logfail = True
 
200
 
 
201
    # A "bad" error message. We shouldn't get here unless IVLE
 
202
    # misbehaves (which is currently very easy, if things aren't set up
 
203
    # correctly).
 
204
    # Write the traceback.
 
205
 
 
206
    # We need to special-case IVLEJailError, as we can get another
 
207
    # almost-exception out of it.
 
208
    if exc_type is util.IVLEJailError:
 
209
        tb = 'Exception information extracted from IVLEJailError:\n'
 
210
        tb += urllib.unquote(exc_value.info)
 
211
    else:
 
212
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
 
213
                                                exc_traceback))
 
214
 
 
215
    logging.error('\n' + tb)
 
216
 
 
217
    # Error messages are only displayed is the user is NOT a student,
 
218
    # or if there has been a problem logging the error message
 
219
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
 
220
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
 
221
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
 
222
<html xmlns="http://www.w3.org/1999/xhtml">
 
223
<head><title>IVLE Internal Server Error</title></head>
 
224
<body>
 
225
<h1>IVLE Internal Server Error</h1>
 
226
<p>An error has occured which is the fault of the IVLE developers or
 
227
administrators. """)
 
228
 
 
229
    if logfail:
 
230
        req.write("Please report this issue to the server administrators, "
 
231
                  "along with the following information.")
 
232
    else:
 
233
        req.write("Details have been logged for further examination.")
 
234
    req.write("</p>")
 
235
 
 
236
    if show_errors:
 
237
        req.write("<h2>Debugging information</h2>")
 
238
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
 
239
    req.write("</body></html>")