← 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-31 01:44:30 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:345
Global CSS change: ivlebody no longer has 1em of padding (it has none).
This is because most apps were disabling it (and it had to change anyway for
other reasons -- see below).

Hence, all apps which WERE disabling the padding have had that removed, and
just work by default. (console, browser, tutorial)
All apps which WEREN'T disabling the padding (very few) now have to manually
include an extra div. This has been done on all such apps, and has been
heavily documented (both in the CSS file and doc/app_howto). (help, dummy,
debuginfo).

media/common/ivle.css: 
    The real change here (which isn't yet being used) is that ivlebody is now
    positioned absolutely and takes up all the space on the canvas. This is
    to be used for full-page layouts in console and browser.

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