← 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-03-03 23:19:52 UTC
  • Revision ID: grantw@unimelb.edu.au-20090303231952-8fwhgabeqbpeq1mz
Add the media version setting to ivle-config, so it can be easily set on the
command line.

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
import routes
 
41
 
 
42
from ivle import util
 
43
import ivle.conf
 
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 HTTPError, Unauthorized, NotFound
 
49
 
 
50
def generate_route_mapper(view_plugins, attr):
 
51
    """
 
52
    Build a Mapper object for doing URL matching using 'routes', based on the
 
53
    given plugin registry.
 
54
    """
 
55
    m = routes.Mapper(explicit=True)
 
56
    for plugin in view_plugins:
 
57
        # Establish a URL pattern for each element of plugin.urls
 
58
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
 
59
        for url in getattr(plugin, attr):
 
60
            routex = url[0]
 
61
            view_class = url[1]
 
62
            kwargs_dict = url[2] if len(url) >= 3 else {}
 
63
            m.connect(routex, view=view_class, **kwargs_dict)
 
64
    return m
 
65
 
 
66
def handler(apachereq):
 
67
    """Handles an HTTP request.
 
68
 
 
69
    Intended to be called by mod_python, as a handler.
 
70
 
 
71
    @param apachereq: An Apache request object.
 
72
    """
 
73
    # Make the request object into an IVLE request which can be given to views
 
74
    req = Request(apachereq)
 
75
 
 
76
    # Hack? Try and get the user login early just in case we throw an error
 
77
    # (most likely 404) to stop us seeing not logged in even when we are.
 
78
    if not req.publicmode:
 
79
        user = ivle.webapp.security.get_user_details(req)
 
80
 
 
81
        # Don't set the user if it is disabled or hasn't accepted the ToS.
 
82
        if user and user.valid:
 
83
            req.user = user
 
84
 
 
85
    conf = ivle.config.Config()
 
86
    req.config = conf
 
87
 
 
88
    if req.publicmode:
 
89
        req.mapper = generate_route_mapper(conf.plugin_index[PublicViewPlugin],
 
90
                                           'public_urls')
 
91
    else:
 
92
        req.mapper = generate_route_mapper(conf.plugin_index[ViewPlugin],
 
93
                                           'urls')
 
94
 
 
95
    matchdict = req.mapper.match(req.uri)
 
96
    if matchdict is not None:
 
97
        viewcls = matchdict['view']
 
98
        # Get the remaining arguments, less 'view', 'action' and 'controller'
 
99
        # (The latter two seem to be built-in, and we don't want them).
 
100
        kwargs = matchdict.copy()
 
101
        del kwargs['view']
 
102
        try:
 
103
            # Instantiate the view, which should be a BaseView class
 
104
            view = viewcls(req, **kwargs)
 
105
 
 
106
            # Check that the request (mainly the user) is permitted to access
 
107
            # the view.
 
108
            if not view.authorize(req):
 
109
                raise Unauthorized()
 
110
            # Render the output
 
111
            view.render(req)
 
112
        except HTTPError, e:
 
113
            # A view explicitly raised an HTTP error. Respect it.
 
114
            req.status = e.code
 
115
 
 
116
            # Try to find a custom error view.
 
117
            if hasattr(viewcls, 'get_error_view'):
 
118
                errviewcls = viewcls.get_error_view(e)
 
119
            else:
 
120
                errviewcls = XHTMLView.get_error_view(e)
 
121
 
 
122
            if errviewcls:
 
123
                errview = errviewcls(req, e)
 
124
                errview.render(req)
 
125
                return req.OK
 
126
            elif e.message:
 
127
                req.write(e.message)
 
128
                return req.OK
 
129
            else:
 
130
                return e.code
 
131
        except Exception, e:
 
132
            # A non-HTTPError appeared. We have an unknown exception. Panic.
 
133
            handle_unknown_exception(req, *sys.exc_info())
 
134
            return req.OK
 
135
        else:
 
136
            req.store.commit()
 
137
            return req.OK
 
138
    else:
 
139
        XHTMLErrorView(req, NotFound()).render(req)
 
140
        return req.OK
 
141
 
 
142
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
 
143
    """
 
144
    Given an exception that has just been thrown from IVLE, print its details
 
145
    to the request.
 
146
    This is a full handler. It assumes nothing has been written, and writes a
 
147
    complete HTML page.
 
148
    req: May be EITHER an IVLE req or an Apache req.
 
149
    The handler code may pass an apache req if an exception occurs before
 
150
    the IVLE request is created.
 
151
    """
 
152
    req.content_type = "text/html"
 
153
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
 
154
    logfail = False
 
155
    try:
 
156
        httpcode = exc_value.httpcode
 
157
        req.status = httpcode
 
158
    except AttributeError:
 
159
        httpcode = None
 
160
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
161
    try:
 
162
        publicmode = req.publicmode
 
163
    except AttributeError:
 
164
        publicmode = True
 
165
    try:
 
166
        login = req.user.login
 
167
    except AttributeError:
 
168
        login = None
 
169
 
 
170
    # Log File
 
171
    try:
 
172
        for h in logging.getLogger().handlers:
 
173
            logging.getLogger().removeHandler(h)
 
174
        logging.basicConfig(level=logging.INFO,
 
175
            format='%(asctime)s %(levelname)s: ' +
 
176
                '(HTTP: ' + str(req.status) +
 
177
                ', Ref: ' + str(login) + '@' +
 
178
                str(socket.gethostname()) + str(req.uri) +
 
179
                ') %(message)s',
 
180
            filename=logfile,
 
181
            filemode='a')
 
182
    except IOError:
 
183
        logfail = True
 
184
 
 
185
    # A "bad" error message. We shouldn't get here unless IVLE
 
186
    # misbehaves (which is currently very easy, if things aren't set up
 
187
    # correctly).
 
188
    # Write the traceback.
 
189
    # If this is a non-4xx IVLEError, get the message and httpcode and
 
190
    # make the error message a bit nicer (but still include the
 
191
    # traceback).
 
192
    # We also need to special-case IVLEJailError, as we can get another
 
193
    # almost-exception out of it.
 
194
 
 
195
    codename, msg = None, None
 
196
 
 
197
    if exc_type is util.IVLEJailError:
 
198
        msg = exc_value.type_str + ": " + exc_value.message
 
199
        tb = 'Exception information extracted from IVLEJailError:\n'
 
200
        tb += urllib.unquote(exc_value.info)
 
201
    else:
 
202
        try:
 
203
            codename, msg = req.get_http_codename(httpcode)
 
204
        except AttributeError:
 
205
            pass
 
206
 
 
207
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
 
208
                                                exc_traceback))
 
209
 
 
210
    logging.error('%s\n%s'%(str(msg), tb))
 
211
 
 
212
    # Error messages are only displayed is the user is NOT a student,
 
213
    # or if there has been a problem logging the error message
 
214
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
 
215
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
 
216
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
 
217
<html xmlns="http://www.w3.org/1999/xhtml">
 
218
<head><title>IVLE Internal Server Error</title></head>
 
219
<body>
 
220
<h1>IVLE Internal Server Error""")
 
221
    if show_errors:
 
222
        if codename is not None and \
 
223
           httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR:
 
224
            req.write(": %s" % cgi.escape(codename))
 
225
 
 
226
    req.write("""</h1>
 
227
<p>An error has occured which is the fault of the IVLE developers or
 
228
administrators. """)
 
229
 
 
230
    if logfail:
 
231
        req.write("Please report this issue to the server administrators, "
 
232
                  "along with the following information.")
 
233
    else:
 
234
        req.write("Details have been logged for further examination.")
 
235
    req.write("</p>")
 
236
 
 
237
    if show_errors:
 
238
        if msg is not None:
 
239
            req.write("<p>%s</p>\n" % cgi.escape(msg))
 
240
        if httpcode is not None:
 
241
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
 
242
        req.write("<h2>Debugging information</h2>")
 
243
 
 
244
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
 
245
    req.write("</body></html>")