← 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-01-19 23:44:35 UTC
  • mto: This revision was merged to the branch mainline in revision 1090.
  • Revision ID: grantw@unimelb.edu.au-20090119234435-9f6k53hvpxlr3rcu
bin/ivle-enrol: Port to Storm, reorder the semester and year arguments, give
    nice error messages on all known modes of failure.

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
 
1
# IVLE
 
2
# Copyright (C) 2007-2008 The University of Melbourne
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
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
 
"""
 
18
# Module: dispatch
 
19
# Author: Matt Giuca
 
20
# Date: 11/12/2007
 
21
 
 
22
# This is a mod_python handler program. The correct way to call it is to have
 
23
# Apache send all requests to be handled by the module 'dispatch'.
 
24
 
 
25
# Top-level handler. Handles all requests to all pages in IVLE.
 
26
# Handles authentication (not authorization).
 
27
# Then passes the request along to the appropriate ivle app.
28
28
 
29
29
import sys
30
30
import os
35
35
import logging
36
36
import socket
37
37
import time
38
 
import inspect
39
38
 
40
39
import mod_python
41
 
import routes
 
40
from mod_python import apache, Cookie
42
41
 
43
42
from ivle import util
44
43
import ivle.conf
45
44
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
 
from ivle.webapp.errors import HTTPError
50
45
import apps
 
46
import login
51
47
import html
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
 
    'ivle.webapp.forum#Plugin',
67
 
    'ivle.webapp.help#Plugin',
68
 
] 
69
 
 
70
 
def generate_route_mapper(view_plugins):
71
 
    """
72
 
    Build a Mapper object for doing URL matching using 'routes', based on the
73
 
    given plugin registry.
74
 
    """
75
 
    m = routes.Mapper(explicit=True)
76
 
    for plugin in view_plugins:
77
 
        # Establish a URL pattern for each element of plugin.urls
78
 
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
79
 
        for url in plugin.urls:
80
 
            routex = url[0]
81
 
            view_class = url[1]
82
 
            kwargs_dict = url[2] if len(url) >= 3 else {}
83
 
            m.connect(routex, view=view_class, **kwargs_dict)
84
 
    return m
85
 
 
86
 
def get_plugin(pluginstr):
87
 
    plugin_path, classname = pluginstr.split('#')
88
 
    # Load the plugin module from somewhere in the Python path
89
 
    # (Note that plugin_path is a fully-qualified Python module name).
90
 
    return (plugin_path,
91
 
            getattr(__import__(plugin_path, fromlist=[classname]), classname))
 
48
from request import Request
 
49
import plugins.console # XXX: Relies on www/ being in the Python path.
92
50
 
93
51
def handler(req):
94
52
    """Handles a request which may be to anywhere in the site except media.
105
63
        # yet.
106
64
        handle_unknown_exception(apachereq, *sys.exc_info())
107
65
        # Tell Apache not to generate its own errors as well
108
 
        return mod_python.apache.OK
 
66
        return apache.OK
109
67
 
110
68
    # Run the main handler, and catch all exceptions
111
69
    try:
117
75
    except Exception:
118
76
        handle_unknown_exception(req, *sys.exc_info())
119
77
        # Tell Apache not to generate its own errors as well
120
 
        return mod_python.apache.OK
 
78
        return apache.OK
121
79
 
122
80
def handler_(req, apachereq):
123
81
    """
130
88
    if not req.publicmode:
131
89
        req.user = login.get_user_details(req)
132
90
 
133
 
    ### BEGIN New plugins framework ###
134
 
    # XXX This should be done ONCE per Python process, not per request.
135
 
    # (Wait till WSGI)
136
 
    # XXX No authentication is done here
137
 
    req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
138
 
    # Index the plugins by base class
139
 
    req.plugin_index = {}
140
 
    for plugin in req.plugins.values():
141
 
        # Getmro returns a tuple of all the super-classes of the plugin
142
 
        for base in inspect.getmro(plugin):
143
 
            if base not in req.plugin_index:
144
 
                req.plugin_index[base] = []
145
 
            req.plugin_index[base].append(plugin)
146
 
    req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
147
 
    req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
148
 
 
149
 
    matchdict = req.mapper.match(req.uri)
150
 
    if matchdict is not None:
151
 
        viewcls = matchdict['view']
152
 
        # Get the remaining arguments, less 'view', 'action' and 'controller'
153
 
        # (The latter two seem to be built-in, and we don't want them).
154
 
        kwargs = matchdict.copy()
155
 
        del kwargs['view']
156
 
        try:
157
 
            # Instantiate the view, which should be a BaseView class
158
 
            view = viewcls(req, **kwargs)
159
 
            # Render the output
160
 
            view.render(req)
161
 
        except HTTPError, e:
162
 
            # A view explicitly raised an HTTP error. Respect it.
163
 
            req.status = e.code
164
 
 
165
 
            # Try to find a custom error view.
166
 
            if hasattr(viewcls, 'get_error_view'):
167
 
                errviewcls = viewcls.get_error_view(e)
168
 
            else:
169
 
                errviewcls = None
170
 
 
171
 
            if errviewcls:
172
 
                errview = errviewcls(req, e)
173
 
                errview.render(req)
174
 
                return req.OK
175
 
            else:
176
 
                req.write(e.message)
177
 
                return e.code
178
 
        except Exception, e:
179
 
            # A non-HTTPError appeared. We have an unknown exception. Panic.
180
 
            handle_unknown_exception(req, *sys.exc_info())
181
 
            return req.OK
182
 
        else:
183
 
            req.store.commit()
184
 
            return req.OK
185
 
    ### END New plugins framework ###
186
 
 
187
91
    # Check req.app to see if it is valid. 404 if not.
188
92
    if req.app is not None and req.app not in ivle.conf.apps.app_url:
189
93
        req.throw_error(Request.HTTP_NOT_FOUND,
250
154
 
251
155
    # When done, write out the HTML footer if the app has requested it
252
156
    if req.write_html_head_foot:
 
157
        # Show the console if required
 
158
        if logged_in and app.useconsole:
 
159
            plugins.console.present(req, windowpane=True)
253
160
        html.write_html_foot(req)
254
161
 
255
162
    # Note: Apache will not write custom HTML error messages here.
273
180
    # For some reason, some versions of mod_python have "_server" instead of
274
181
    # "main_server". So we check for both.
275
182
    try:
276
 
        admin_email = mod_python.apache.main_server.server_admin
 
183
        admin_email = apache.main_server.server_admin
277
184
    except AttributeError:
278
185
        try:
279
 
            admin_email = mod_python.apache._server.server_admin
 
186
            admin_email = apache._server.server_admin
280
187
        except AttributeError:
281
188
            admin_email = ""
282
189
    try:
284
191
        req.status = httpcode
285
192
    except AttributeError:
286
193
        httpcode = None
287
 
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
288
 
    try:
289
 
        publicmode = req.publicmode
290
 
    except AttributeError:
291
 
        publicmode = True
 
194
        req.status = apache.HTTP_INTERNAL_SERVER_ERROR
292
195
    try:
293
196
        login = req.user.login
294
197
    except AttributeError:
295
198
        login = None
296
 
    try:
297
 
        role = req.user.role
298
 
    except AttributeError:
299
 
        role = None
300
199
 
301
200
    # Log File
302
201
    try:
392
291
 
393
292
        # Logging
394
293
        logging.error('%s\n%s'%(str(msg), tb))
395
 
        # Error messages are only displayed is the user is NOT a student,
396
 
        # or if there has been a problem logging the error message
397
 
        show_errors = (not publicmode) and ((login and \
398
 
                            str(role) != "student") or logfail)
 
294
 
399
295
        req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
400
296
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
401
297
<html xmlns="http://www.w3.org/1999/xhtml">
402
298
<head><title>IVLE Internal Server Error</title></head>
403
299
<body>
404
300
<h1>IVLE Internal Server Error""")
405
 
        if (show_errors):
406
 
            if (codename is not None
407
 
                        and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
408
 
                req.write(": %s" % cgi.escape(codename))
409
 
        
 
301
        if (codename is not None
 
302
            and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
 
303
            req.write(": %s" % cgi.escape(codename))
410
304
        req.write("""</h1>
411
305
<p>An error has occured which is the fault of the IVLE developers or
412
 
administration. The developers have been notified.</p>
 
306
administration.</p>
413
307
""")
414
 
        if (show_errors):
415
 
            if msg is not None:
416
 
                req.write("<p>%s</p>\n" % cgi.escape(msg))
417
 
            if httpcode is not None:
418
 
                req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
419
 
            req.write("""
420
 
    <p>Please report this to <a href="mailto:%s">%s</a> (the system
421
 
    administrator). Include the following information:</p>
422
 
    """ % (cgi.escape(admin_email), cgi.escape(admin_email)))
 
308
        if msg is not None:
 
309
            req.write("<p>%s</p>\n" % cgi.escape(msg))
 
310
        if httpcode is not None:
 
311
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
 
312
        req.write("""
 
313
<p>Please report this to <a href="mailto:%s">%s</a> (the system
 
314
administrator). Include the following information:</p>
 
315
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
423
316
 
424
 
            req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
425
 
            if logfail:
426
 
                req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
427
 
                    %cgi.escape(logfile))
 
317
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
 
318
        if logfail:
 
319
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
 
320
                %cgi.escape(logfile))
428
321
        req.write("</body></html>")