← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Added module ivle.config, which takes care of some work interfacing with
    configobj, including searching for the file and opening the object.
ivle.conf.conf now uses this instead of having its own search.

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.
50
 
 
51
 
# List of cookies that IVLE uses (to be removed at logout)
52
 
ivle_cookies = ["ivleforumcookie", "clipboard"]
 
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))
53
91
 
54
92
def handler(req):
55
93
    """Handles a request which may be to anywhere in the site except media.
66
104
        # yet.
67
105
        handle_unknown_exception(apachereq, *sys.exc_info())
68
106
        # Tell Apache not to generate its own errors as well
69
 
        return apache.OK
 
107
        return mod_python.apache.OK
70
108
 
71
109
    # Run the main handler, and catch all exceptions
72
110
    try:
78
116
    except Exception:
79
117
        handle_unknown_exception(req, *sys.exc_info())
80
118
        # Tell Apache not to generate its own errors as well
81
 
        return apache.OK
 
119
        return mod_python.apache.OK
82
120
 
83
121
def handler_(req, apachereq):
84
122
    """
91
129
    if not req.publicmode:
92
130
        req.user = login.get_user_details(req)
93
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
 
94
186
    # Check req.app to see if it is valid. 404 if not.
95
187
    if req.app is not None and req.app not in ivle.conf.apps.app_url:
96
 
        # Maybe it is a special app!
97
 
        if req.app == 'logout':
98
 
            logout(req)
99
 
        else:
100
 
            req.throw_error(Request.HTTP_NOT_FOUND,
101
 
                "There is no application called %s." % repr(req.app))
 
188
        req.throw_error(Request.HTTP_NOT_FOUND,
 
189
            "There is no application called %s." % repr(req.app))
102
190
 
103
191
    # Special handling for public mode - only allow the public app, call it
104
192
    # and get out.
161
249
 
162
250
    # When done, write out the HTML footer if the app has requested it
163
251
    if req.write_html_head_foot:
164
 
        # Show the console if required
165
 
        if logged_in and app.useconsole:
166
 
            plugins.console.present(req, windowpane=True)
167
252
        html.write_html_foot(req)
168
253
 
169
254
    # Note: Apache will not write custom HTML error messages here.
170
255
    # Use req.throw_error to do that.
171
256
    return req.OK
172
257
 
173
 
def logout(req):
174
 
    """Log out the current user (if any) by destroying the session state.
175
 
    Then redirect to the top-level IVLE page."""
176
 
    session = req.get_session()
177
 
    session.invalidate()
178
 
    session.delete()
179
 
    # Invalidates all IVLE cookies
180
 
    all_cookies = Cookie.get_cookies(req)
181
 
    for cookie in all_cookies:
182
 
        if cookie in ivle_cookies:
183
 
            req.add_cookie(Cookie.Cookie(cookie,'',expires=1,path='/'))
184
 
    req.throw_redirect(util.make_path('')) 
185
 
 
186
258
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
187
259
    """
188
260
    Given an exception that has just been thrown from IVLE, print its details
200
272
    # For some reason, some versions of mod_python have "_server" instead of
201
273
    # "main_server". So we check for both.
202
274
    try:
203
 
        admin_email = apache.main_server.server_admin
 
275
        admin_email = mod_python.apache.main_server.server_admin
204
276
    except AttributeError:
205
277
        try:
206
 
            admin_email = apache._server.server_admin
 
278
            admin_email = mod_python.apache._server.server_admin
207
279
        except AttributeError:
208
280
            admin_email = ""
209
281
    try:
211
283
        req.status = httpcode
212
284
    except AttributeError:
213
285
        httpcode = None
214
 
        req.status = apache.HTTP_INTERNAL_SERVER_ERROR
 
286
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
287
    try:
 
288
        publicmode = req.publicmode
 
289
    except AttributeError:
 
290
        publicmode = True
215
291
    try:
216
292
        login = req.user.login
217
293
    except AttributeError:
218
294
        login = None
 
295
    try:
 
296
        role = req.user.role
 
297
    except AttributeError:
 
298
        role = None
219
299
 
220
300
    # Log File
221
301
    try:
311
391
 
312
392
        # Logging
313
393
        logging.error('%s\n%s'%(str(msg), tb))
314
 
 
 
394
        # Error messages are only displayed is the user is NOT a student,
 
395
        # or if there has been a problem logging the error message
 
396
        show_errors = (not publicmode) and ((login and \
 
397
                            str(role) != "student") or logfail)
315
398
        req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
316
399
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
317
400
<html xmlns="http://www.w3.org/1999/xhtml">
318
401
<head><title>IVLE Internal Server Error</title></head>
319
402
<body>
320
403
<h1>IVLE Internal Server Error""")
321
 
        if (codename is not None
322
 
            and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
323
 
            req.write(": %s" % cgi.escape(codename))
 
404
        if (show_errors):
 
405
            if (codename is not None
 
406
                        and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
 
407
                req.write(": %s" % cgi.escape(codename))
 
408
        
324
409
        req.write("""</h1>
325
410
<p>An error has occured which is the fault of the IVLE developers or
326
 
administration.</p>
 
411
administration. The developers have been notified.</p>
327
412
""")
328
 
        if msg is not None:
329
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
330
 
        if httpcode is not None:
331
 
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
332
 
        req.write("""
333
 
<p>Please report this to <a href="mailto:%s">%s</a> (the system
334
 
administrator). Include the following information:</p>
335
 
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
 
413
        if (show_errors):
 
414
            if msg is not None:
 
415
                req.write("<p>%s</p>\n" % cgi.escape(msg))
 
416
            if httpcode is not None:
 
417
                req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
 
418
            req.write("""
 
419
    <p>Please report this to <a href="mailto:%s">%s</a> (the system
 
420
    administrator). Include the following information:</p>
 
421
    """ % (cgi.escape(admin_email), cgi.escape(admin_email)))
336
422
 
337
 
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
338
 
        if logfail:
339
 
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
340
 
                %cgi.escape(logfile))
 
423
            req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
 
424
            if logfail:
 
425
                req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
 
426
                    %cgi.escape(logfile))
341
427
        req.write("</body></html>")