← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Created a new help system.

The new help system allows plugins to register their help paths, using
a dict of dicts and helpfile paths. This system allows multiple plugins
to use the same heading for their help files (ie. 'admin').

It also allows XHTMLViews to have a 'help' property, which makes the
context-sensitive help link point to their help path.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/__init__.py
1
 
# IVLE
2
 
# Copyright (C) 2007-2008 The University of Melbourne
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2009 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
 
# 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.
 
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
28
 
29
29
import sys
30
30
import os
35
35
import logging
36
36
import socket
37
37
import time
 
38
import inspect
38
39
 
39
40
import mod_python
40
 
from mod_python import apache, Cookie
 
41
import routes
41
42
 
42
43
from ivle import util
43
44
import ivle.conf
44
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
from ivle.webapp.errors import HTTPError
45
50
import apps
46
 
import login
47
51
import html
48
 
from request import Request
49
 
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
    '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))
50
92
 
51
93
def handler(req):
52
94
    """Handles a request which may be to anywhere in the site except media.
63
105
        # yet.
64
106
        handle_unknown_exception(apachereq, *sys.exc_info())
65
107
        # Tell Apache not to generate its own errors as well
66
 
        return apache.OK
 
108
        return mod_python.apache.OK
67
109
 
68
110
    # Run the main handler, and catch all exceptions
69
111
    try:
75
117
    except Exception:
76
118
        handle_unknown_exception(req, *sys.exc_info())
77
119
        # Tell Apache not to generate its own errors as well
78
 
        return apache.OK
 
120
        return mod_python.apache.OK
79
121
 
80
122
def handler_(req, apachereq):
81
123
    """
88
130
    if not req.publicmode:
89
131
        req.user = login.get_user_details(req)
90
132
 
 
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
 
91
187
    # Check req.app to see if it is valid. 404 if not.
92
188
    if req.app is not None and req.app not in ivle.conf.apps.app_url:
93
189
        req.throw_error(Request.HTTP_NOT_FOUND,
154
250
 
155
251
    # When done, write out the HTML footer if the app has requested it
156
252
    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)
160
253
        html.write_html_foot(req)
161
254
 
162
255
    # Note: Apache will not write custom HTML error messages here.
180
273
    # For some reason, some versions of mod_python have "_server" instead of
181
274
    # "main_server". So we check for both.
182
275
    try:
183
 
        admin_email = apache.main_server.server_admin
 
276
        admin_email = mod_python.apache.main_server.server_admin
184
277
    except AttributeError:
185
278
        try:
186
 
            admin_email = apache._server.server_admin
 
279
            admin_email = mod_python.apache._server.server_admin
187
280
        except AttributeError:
188
281
            admin_email = ""
189
282
    try:
191
284
        req.status = httpcode
192
285
    except AttributeError:
193
286
        httpcode = None
194
 
        req.status = apache.HTTP_INTERNAL_SERVER_ERROR
 
287
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
288
    try:
 
289
        publicmode = req.publicmode
 
290
    except AttributeError:
 
291
        publicmode = True
195
292
    try:
196
293
        login = req.user.login
197
294
    except AttributeError:
198
295
        login = None
 
296
    try:
 
297
        role = req.user.role
 
298
    except AttributeError:
 
299
        role = None
199
300
 
200
301
    # Log File
201
302
    try:
291
392
 
292
393
        # Logging
293
394
        logging.error('%s\n%s'%(str(msg), tb))
294
 
 
 
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)
295
399
        req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
296
400
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
297
401
<html xmlns="http://www.w3.org/1999/xhtml">
298
402
<head><title>IVLE Internal Server Error</title></head>
299
403
<body>
300
404
<h1>IVLE Internal Server Error""")
301
 
        if (codename is not None
302
 
            and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
303
 
            req.write(": %s" % cgi.escape(codename))
 
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
        
304
410
        req.write("""</h1>
305
411
<p>An error has occured which is the fault of the IVLE developers or
306
 
administration.</p>
 
412
administration. The developers have been notified.</p>
307
413
""")
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)))
 
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)))
316
423
 
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))
 
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))
321
428
        req.write("</body></html>")