← 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-08-18 12:15:25 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1027
Tutorial: Added new feature - previous attempt viewing. Allows users to see
    code they have previously submitted to tutorials.
    A new button ("View previous attempts") appears on each exercise box.
    This uses the getattempts and getattempt Ajax services checked in
    previously.
Note once again: Students are not (for the moment) able to see deactivated
attempts (this is a conservative approach - the ability to see deactivated
attempts can be turned on by setting HISTORY_ALLOW_INACTIVE = True in
tutorialservice).

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 (not authorization).
26
 
Then passes the request along to the appropriate ivle app.
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
 
import ivle.conf.apps
45
 
from ivle.dispatch.request import Request
46
 
from ivle.dispatch import login
47
 
from ivle.webapp.base.plugins import ViewPlugin, PublicViewPlugin
48
 
from ivle.webapp.errors import HTTPError, Unauthorized
49
 
import apps
50
 
import html
51
 
 
52
 
def generate_route_mapper(view_plugins, attr):
53
 
    """
54
 
    Build a Mapper object for doing URL matching using 'routes', based on the
55
 
    given plugin registry.
56
 
    """
57
 
    m = routes.Mapper(explicit=True)
58
 
    for plugin in view_plugins:
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
67
 
 
68
 
def handler(req):
69
 
    """Handles a request which may be to anywhere in the site except media.
70
 
    Intended to be called by mod_python, as a handler.
71
 
 
72
 
    req: An Apache request object.
73
 
    """
74
 
    # Make the request object into an IVLE request which can be passed to apps
75
 
    apachereq = req
76
 
    try:
77
 
        req = Request(req, html.write_html_head)
78
 
    except Exception:
79
 
        # Pass the apachereq to error reporter, since ivle req isn't created
80
 
        # yet.
81
 
        handle_unknown_exception(apachereq, *sys.exc_info())
82
 
        # Tell Apache not to generate its own errors as well
83
 
        return mod_python.apache.OK
84
 
 
85
 
    # Run the main handler, and catch all exceptions
86
 
    try:
87
 
        return handler_(req, apachereq)
88
 
    except mod_python.apache.SERVER_RETURN:
89
 
        # An apache error. We discourage these, but they might still happen.
90
 
        # Just raise up.
91
 
        raise
92
 
    except Exception:
93
 
        handle_unknown_exception(req, *sys.exc_info())
94
 
        # Tell Apache not to generate its own errors as well
95
 
        return mod_python.apache.OK
96
 
 
97
 
def handler_(req, apachereq):
98
 
    """
99
 
    Nested handler function. May raise exceptions. The top-level handler is
100
 
    just used to catch exceptions.
101
 
    Takes both an IVLE request and an Apache req.
102
 
    """
103
 
    # Hack? Try and get the user login early just in case we throw an error
104
 
    # (most likely 404) to stop us seeing not logged in even when we are.
105
 
    if not req.publicmode:
106
 
        user = login.get_user_details(req)
107
 
 
108
 
        # Don't set the user if it is disabled or hasn't accepted the ToS.
109
 
        if user and user.valid:
110
 
            req.user = user
111
 
 
112
 
    conf = ivle.config.Config()
113
 
    req.config = conf
114
 
 
115
 
    ### BEGIN New plugins framework ###
116
 
    if req.publicmode:
117
 
        req.mapper = generate_route_mapper(conf.plugin_index[PublicViewPlugin],
118
 
                                           'public_urls')
119
 
    else:
120
 
        req.mapper = generate_route_mapper(conf.plugin_index[ViewPlugin],
121
 
                                           'urls')
122
 
 
123
 
    matchdict = req.mapper.match(req.uri)
124
 
    if matchdict is not None:
125
 
        viewcls = matchdict['view']
126
 
        # Get the remaining arguments, less 'view', 'action' and 'controller'
127
 
        # (The latter two seem to be built-in, and we don't want them).
128
 
        kwargs = matchdict.copy()
129
 
        del kwargs['view']
130
 
        try:
131
 
            # Instantiate the view, which should be a BaseView class
132
 
            view = viewcls(req, **kwargs)
133
 
 
134
 
            # Check that the request (mainly the user) is permitted to access
135
 
            # the view.
136
 
            if not view.authorize(req):
137
 
                raise Unauthorized()
138
 
            # Render the output
139
 
            view.render(req)
140
 
        except HTTPError, e:
141
 
            # A view explicitly raised an HTTP error. Respect it.
142
 
            req.status = e.code
143
 
 
144
 
            # Try to find a custom error view.
145
 
            if hasattr(viewcls, 'get_error_view'):
146
 
                errviewcls = viewcls.get_error_view(e)
147
 
            else:
148
 
                errviewcls = None
149
 
 
150
 
            if errviewcls:
151
 
                errview = errviewcls(req, e)
152
 
                errview.render(req)
153
 
                return req.OK
154
 
            elif e.message:
155
 
                req.write(e.message)
156
 
                return req.OK
157
 
            else:
158
 
                return e.code
159
 
        except Exception, e:
160
 
            # A non-HTTPError appeared. We have an unknown exception. Panic.
161
 
            handle_unknown_exception(req, *sys.exc_info())
162
 
            return req.OK
163
 
        else:
164
 
            req.store.commit()
165
 
            return req.OK
166
 
    else:
167
 
        # We had no matching URL! Check if it matches an old-style app. If
168
 
        # not, 404.
169
 
        if req.app not in ivle.conf.apps.app_url:
170
 
            return req.HTTP_NOT_FOUND # TODO: Prettify.
171
 
    ### END New plugins framework ###
172
 
 
173
 
 
174
 
    ### BEGIN legacy application framework ###
175
 
    # We have no public apps back here.
176
 
    assert not req.publicmode
177
 
 
178
 
    # app is the App object for the chosen app
179
 
    if req.app is None:
180
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
181
 
    else:
182
 
        app = ivle.conf.apps.app_url[req.app]
183
 
 
184
 
    # Check if app requires auth. If so, perform authentication and login.
185
 
    # This will either return a User object, None, or perform a redirect
186
 
    # which we will not catch here.
187
 
    if app.requireauth:
188
 
        logged_in = req.user is not None
189
 
    else:
190
 
        logged_in = True
191
 
 
192
 
    assert logged_in # XXX
193
 
 
194
 
    if logged_in:
195
 
        # Keep the user's session alive by writing to the session object.
196
 
        # req.get_session().save()
197
 
        # Well, it's a fine idea, but it creates considerable grief in the
198
 
        # concurrent update department, so instead, we'll just make the
199
 
        # sessions not time out.
200
 
        req.get_session().unlock()
201
 
 
202
 
        # Call the specified app with the request object
203
 
        apps.call_app(app.dir, req)
204
 
 
205
 
    # MAKE SURE we write the HTTP (and possibly HTML) header. This
206
 
    # wouldn't happen if nothing else ever got written, so we have to make
207
 
    # sure.
208
 
    req.ensure_headers_written()
209
 
 
210
 
    # When done, write out the HTML footer if the app has requested it
211
 
    if req.write_html_head_foot:
212
 
        html.write_html_foot(req)
213
 
 
214
 
    # Note: Apache will not write custom HTML error messages here.
215
 
    # Use req.throw_error to do that.
216
 
    return req.OK
217
 
 
218
 
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
219
 
    """
220
 
    Given an exception that has just been thrown from IVLE, print its details
221
 
    to the request.
222
 
    This is a full handler. It assumes nothing has been written, and writes a
223
 
    complete HTML page.
224
 
    req: May be EITHER an IVLE req or an Apache req.
225
 
    IVLE reqs may have the HTML head/foot written (on a 400 error), but
226
 
    the handler code may pass an apache req if an exception occurs before
227
 
    the IVLE request is created.
228
 
    """
229
 
    req.content_type = "text/html"
230
 
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
231
 
    logfail = False
232
 
    # For some reason, some versions of mod_python have "_server" instead of
233
 
    # "main_server". So we check for both.
234
 
    try:
235
 
        admin_email = mod_python.apache.main_server.server_admin
236
 
    except AttributeError:
237
 
        try:
238
 
            admin_email = mod_python.apache._server.server_admin
239
 
        except AttributeError:
240
 
            admin_email = ""
241
 
    try:
242
 
        httpcode = exc_value.httpcode
243
 
        req.status = httpcode
244
 
    except AttributeError:
245
 
        httpcode = None
246
 
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
247
 
    try:
248
 
        publicmode = req.publicmode
249
 
    except AttributeError:
250
 
        publicmode = True
251
 
    try:
252
 
        login = req.user.login
253
 
    except AttributeError:
254
 
        login = None
255
 
    try:
256
 
        role = req.user.role
257
 
    except AttributeError:
258
 
        role = None
259
 
 
260
 
    # Log File
261
 
    try:
262
 
        for h in logging.getLogger().handlers:
263
 
            logging.getLogger().removeHandler(h)
264
 
        logging.basicConfig(level=logging.INFO,
265
 
            format='%(asctime)s %(levelname)s: ' +
266
 
                '(HTTP: ' + str(req.status) +
267
 
                ', Ref: ' + str(login) + '@' +
268
 
                str(socket.gethostname()) + str(req.uri) +
269
 
                ') %(message)s',
270
 
            filename=logfile,
271
 
            filemode='a')
272
 
    except IOError:
273
 
        logfail = True
274
 
    logging.debug('Logging Unhandled Exception')
275
 
 
276
 
    # We handle 3 types of error.
277
 
    # IVLEErrors with 4xx response codes (client error).
278
 
    # IVLEErrors with 5xx response codes (handled server error).
279
 
    # Other exceptions (unhandled server error).
280
 
    # IVLEErrors should not have other response codes than 4xx or 5xx
281
 
    # (eg. throw_redirect should have been used for 3xx codes).
282
 
    # Therefore, that is treated as an unhandled error.
283
 
 
284
 
    if (exc_type == util.IVLEError and httpcode >= 400
285
 
        and httpcode <= 499):
286
 
        # IVLEErrors with 4xx response codes are client errors.
287
 
        # Therefore, these have a "nice" response (we even coat it in the IVLE
288
 
        # HTML wrappers).
289
 
        
290
 
        req.write_html_head_foot = True
291
 
        req.write_javascript_settings = False
292
 
        req.write('<div id="ivle_padding">\n')
293
 
        try:
294
 
            codename, msg = req.get_http_codename(httpcode)
295
 
        except AttributeError:
296
 
            codename, msg = None, None
297
 
        # Override the default message with the supplied one,
298
 
        # if available.
299
 
        if exc_value.message is not None:
300
 
            msg = exc_value.message
301
 
        if codename is not None:
302
 
            req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
303
 
        else:
304
 
            req.write("<h1>Error</h1>\n")
305
 
        if msg is not None:
306
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
307
 
        else:
308
 
            req.write("<p>An unknown error occured.</p>\n")
309
 
        
310
 
        # Logging
311
 
        logging.info(str(msg))
312
 
        
313
 
        req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
314
 
        if logfail:
315
 
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
316
 
                %cgi.escape(logfile))
317
 
        req.write('</div>\n')
318
 
        html.write_html_foot(req)
319
 
    else:
320
 
        # A "bad" error message. We shouldn't get here unless IVLE
321
 
        # misbehaves (which is currently very easy, if things aren't set up
322
 
        # correctly).
323
 
        # Write the traceback.
324
 
        # If this is a non-4xx IVLEError, get the message and httpcode and
325
 
        # make the error message a bit nicer (but still include the
326
 
        # traceback).
327
 
        # We also need to special-case IVLEJailError, as we can get another
328
 
        # almost-exception out of it.
329
 
 
330
 
        codename, msg = None, None
331
 
 
332
 
        if exc_type is util.IVLEJailError:
333
 
            msg = exc_value.type_str + ": " + exc_value.message
334
 
            tb = 'Exception information extracted from IVLEJailError:\n'
335
 
            tb += urllib.unquote(exc_value.info)
336
 
        else:
337
 
            try:
338
 
                codename, msg = req.get_http_codename(httpcode)
339
 
            except AttributeError:
340
 
                pass
341
 
            # Override the default message with the supplied one,
342
 
            # if available.
343
 
            if hasattr(exc_value, 'message') and exc_value.message is not None:
344
 
                msg = exc_value.message
345
 
                # Prepend the exception type
346
 
                if exc_type != util.IVLEError:
347
 
                    msg = exc_type.__name__ + ": " + repr(msg)
348
 
 
349
 
            tb = ''.join(traceback.format_exception(exc_type, exc_value,
350
 
                                                    exc_traceback))
351
 
 
352
 
        # Logging
353
 
        logging.error('%s\n%s'%(str(msg), tb))
354
 
        # Error messages are only displayed is the user is NOT a student,
355
 
        # or if there has been a problem logging the error message
356
 
        show_errors = (not publicmode) and ((login and \
357
 
                            str(role) != "student") or logfail)
358
 
        req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
359
 
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
360
 
<html xmlns="http://www.w3.org/1999/xhtml">
361
 
<head><title>IVLE Internal Server Error</title></head>
362
 
<body>
363
 
<h1>IVLE Internal Server Error""")
364
 
        if (show_errors):
365
 
            if (codename is not None
366
 
                        and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
367
 
                req.write(": %s" % cgi.escape(codename))
368
 
        
369
 
        req.write("""</h1>
370
 
<p>An error has occured which is the fault of the IVLE developers or
371
 
administration. The developers have been notified.</p>
372
 
""")
373
 
        if (show_errors):
374
 
            if msg is not None:
375
 
                req.write("<p>%s</p>\n" % cgi.escape(msg))
376
 
            if httpcode is not None:
377
 
                req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
378
 
            req.write("""
379
 
    <p>Please report this to <a href="mailto:%s">%s</a> (the system
380
 
    administrator). Include the following information:</p>
381
 
    """ % (cgi.escape(admin_email), cgi.escape(admin_email)))
382
 
 
383
 
            req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
384
 
            if logfail:
385
 
                req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
386
 
                    %cgi.escape(logfile))
387
 
        req.write("</body></html>")