← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Merged from new-dispatch branch.
This branch is now a child of new-dispatch (until that branch is merged with
    trunk).

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
] 
 
68
 
 
69
def generate_route_mapper(view_plugins):
 
70
    """
 
71
    Build a Mapper object for doing URL matching using 'routes', based on the
 
72
    given plugin registry.
 
73
    """
 
74
    m = routes.Mapper(explicit=True)
 
75
    for plugin in view_plugins:
 
76
        # Establish a URL pattern for each element of plugin.urls
 
77
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
 
78
        for url in plugin.urls:
 
79
            routex = url[0]
 
80
            view_class = url[1]
 
81
            kwargs_dict = url[2] if len(url) >= 3 else {}
 
82
            m.connect(routex, view=view_class, **kwargs_dict)
 
83
    return m
 
84
 
 
85
def get_plugin(pluginstr):
 
86
    plugin_path, classname = pluginstr.split('#')
 
87
    # Load the plugin module from somewhere in the Python path
 
88
    # (Note that plugin_path is a fully-qualified Python module name).
 
89
    return (plugin_path,
 
90
            getattr(__import__(plugin_path, fromlist=[classname]), classname))
50
91
 
51
92
def handler(req):
52
93
    """Handles a request which may be to anywhere in the site except media.
63
104
        # yet.
64
105
        handle_unknown_exception(apachereq, *sys.exc_info())
65
106
        # Tell Apache not to generate its own errors as well
66
 
        return apache.OK
 
107
        return mod_python.apache.OK
67
108
 
68
109
    # Run the main handler, and catch all exceptions
69
110
    try:
75
116
    except Exception:
76
117
        handle_unknown_exception(req, *sys.exc_info())
77
118
        # Tell Apache not to generate its own errors as well
78
 
        return apache.OK
 
119
        return mod_python.apache.OK
79
120
 
80
121
def handler_(req, apachereq):
81
122
    """
88
129
    if not req.publicmode:
89
130
        req.user = login.get_user_details(req)
90
131
 
 
132
    ### BEGIN New plugins framework ###
 
133
    # XXX This should be done ONCE per Python process, not per request.
 
134
    # (Wait till WSGI)
 
135
    # XXX No authentication is done here
 
136
    req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
 
137
    # Index the plugins by base class
 
138
    req.plugin_index = {}
 
139
    for plugin in req.plugins.values():
 
140
        # Getmro returns a tuple of all the super-classes of the plugin
 
141
        for base in inspect.getmro(plugin):
 
142
            if base not in req.plugin_index:
 
143
                req.plugin_index[base] = []
 
144
            req.plugin_index[base].append(plugin)
 
145
    req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
 
146
    req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
 
147
 
 
148
    matchdict = req.mapper.match(req.uri)
 
149
    if matchdict is not None:
 
150
        viewcls = matchdict['view']
 
151
        # Get the remaining arguments, less 'view', 'action' and 'controller'
 
152
        # (The latter two seem to be built-in, and we don't want them).
 
153
        kwargs = matchdict.copy()
 
154
        del kwargs['view']
 
155
        try:
 
156
            # Instantiate the view, which should be a BaseView class
 
157
            view = viewcls(req, **kwargs)
 
158
            # Render the output
 
159
            view.render(req)
 
160
        except HTTPError, e:
 
161
            # A view explicitly raised an HTTP error. Respect it.
 
162
            req.status = e.code
 
163
 
 
164
            # Try to find a custom error view.
 
165
            if hasattr(viewcls, 'get_error_view'):
 
166
                errviewcls = viewcls.get_error_view(e)
 
167
            else:
 
168
                errviewcls = None
 
169
 
 
170
            if errviewcls:
 
171
                errview = errviewcls(req, e)
 
172
                errview.render(req)
 
173
                return req.OK
 
174
            else:
 
175
                req.write(e.message)
 
176
                return e.code
 
177
        except Exception, e:
 
178
            # A non-HTTPError appeared. We have an unknown exception. Panic.
 
179
            handle_unknown_exception(req, *sys.exc_info())
 
180
            return req.OK
 
181
        else:
 
182
            req.store.commit()
 
183
            return req.OK
 
184
    ### END New plugins framework ###
 
185
 
91
186
    # Check req.app to see if it is valid. 404 if not.
92
187
    if req.app is not None and req.app not in ivle.conf.apps.app_url:
93
188
        req.throw_error(Request.HTTP_NOT_FOUND,
154
249
 
155
250
    # When done, write out the HTML footer if the app has requested it
156
251
    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
252
        html.write_html_foot(req)
161
253
 
162
254
    # Note: Apache will not write custom HTML error messages here.
180
272
    # For some reason, some versions of mod_python have "_server" instead of
181
273
    # "main_server". So we check for both.
182
274
    try:
183
 
        admin_email = apache.main_server.server_admin
 
275
        admin_email = mod_python.apache.main_server.server_admin
184
276
    except AttributeError:
185
277
        try:
186
 
            admin_email = apache._server.server_admin
 
278
            admin_email = mod_python.apache._server.server_admin
187
279
        except AttributeError:
188
280
            admin_email = ""
189
281
    try:
191
283
        req.status = httpcode
192
284
    except AttributeError:
193
285
        httpcode = None
194
 
        req.status = apache.HTTP_INTERNAL_SERVER_ERROR
 
286
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
195
287
    try:
196
288
        publicmode = req.publicmode
197
289
    except AttributeError:
301
393
        logging.error('%s\n%s'%(str(msg), tb))
302
394
        # Error messages are only displayed is the user is NOT a student,
303
395
        # or if there has been a problem logging the error message
304
 
        show_errors = (not publicmode) and (not login or \
305
 
                            (not str(role) == "student") or logfail)
 
396
        show_errors = (not publicmode) and ((login and \
 
397
                            str(role) != "student") or logfail)
306
398
        req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
307
399
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
308
400
<html xmlns="http://www.w3.org/1999/xhtml">
311
403
<h1>IVLE Internal Server Error""")
312
404
        if (show_errors):
313
405
            if (codename is not None
314
 
                        and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
 
406
                        and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
315
407
                req.write(": %s" % cgi.escape(codename))
316
408
        
317
409
        req.write("""</h1>