← 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: David Coles
  • Date: 2009-11-27 05:34:33 UTC
  • mto: This revision was merged to the branch mainline in revision 1322.
  • Revision ID: coles.david@gmail.com-20091127053433-8ki9nm6xrkogxq67
Added diagram of system architecture

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 and delegates to views for authorization,
 
26
then passes the request along to the appropriate view.
 
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
 
 
39
import mod_python
 
40
import routes
 
41
 
 
42
from ivle import util
 
43
import ivle.config
 
44
from ivle.dispatch.request import Request
 
45
import ivle.webapp.security
 
46
from ivle.webapp.base.plugins import ViewPlugin, PublicViewPlugin
 
47
from ivle.webapp.base.xhtml import XHTMLView, XHTMLErrorView
 
48
from ivle.webapp.errors import HTTPError, Unauthorized, NotFound
 
49
 
 
50
config = ivle.config.Config()
 
51
 
 
52
def generate_router(view_plugins, attr):
 
53
    """
 
54
    Build a Mapper object for doing URL matching using 'routes', based on the
 
55
    given plugin registry.
 
56
    """
 
57
    m = routes.Mapper(explicit=True)
 
58
    for plugin in view_plugins:
 
59
        # Establish a URL pattern for each element of plugin.urls
 
60
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
 
61
        for url in getattr(plugin, attr):
 
62
            routex = url[0]
 
63
            view_class = url[1]
 
64
            kwargs_dict = url[2] if len(url) >= 3 else {}
 
65
            m.connect(routex, view=view_class, **kwargs_dict)
 
66
    return m
 
67
 
 
68
def handler(apachereq):
 
69
    """Handles an HTTP request.
 
70
 
 
71
    Intended to be called by mod_python, as a handler.
 
72
 
 
73
    @param apachereq: An Apache request object.
 
74
    """
 
75
    # Make the request object into an IVLE request which can be given to views
 
76
    req = Request(apachereq, config)
 
77
 
 
78
    # Hack? Try and get the user login early just in case we throw an error
 
79
    # (most likely 404) to stop us seeing not logged in even when we are.
 
80
    if not req.publicmode:
 
81
        user = ivle.webapp.security.get_user_details(req)
 
82
 
 
83
        # Don't set the user if it is disabled or hasn't accepted the ToS.
 
84
        if user and user.valid:
 
85
            req.user = user
 
86
 
 
87
    if req.publicmode:
 
88
        req.mapper = generate_router(config.plugin_index[PublicViewPlugin],
 
89
                                    'public_urls')
 
90
    else:
 
91
        req.mapper = generate_router(config.plugin_index[ViewPlugin], 'urls')
 
92
 
 
93
    matchdict = req.mapper.match(req.uri)
 
94
    if matchdict is not None:
 
95
        viewcls = matchdict['view']
 
96
        # Get the remaining arguments, less 'view', 'action' and 'controller'
 
97
        # (The latter two seem to be built-in, and we don't want them).
 
98
        kwargs = matchdict.copy()
 
99
        del kwargs['view']
 
100
        try:
 
101
            # Instantiate the view, which should be a BaseView class
 
102
            view = viewcls(req, **kwargs)
 
103
 
 
104
            # Check that the request (mainly the user) is permitted to access
 
105
            # the view.
 
106
            if not view.authorize(req):
 
107
                raise Unauthorized()
 
108
            # Render the output
 
109
            view.render(req)
 
110
        except HTTPError, e:
 
111
            # A view explicitly raised an HTTP error. Respect it.
 
112
            req.status = e.code
 
113
 
 
114
            # Try to find a custom error view.
 
115
            if hasattr(viewcls, 'get_error_view'):
 
116
                errviewcls = viewcls.get_error_view(e)
 
117
            else:
 
118
                errviewcls = XHTMLView.get_error_view(e)
 
119
 
 
120
            if errviewcls:
 
121
                errview = errviewcls(req, e)
 
122
                errview.render(req)
 
123
                return req.OK
 
124
            elif e.message:
 
125
                req.write(e.message)
 
126
                return req.OK
 
127
            else:
 
128
                return e.code
 
129
        except mod_python.apache.SERVER_RETURN:
 
130
            # A mod_python-specific Apache error.
 
131
            # XXX: We need to raise these because req.throw_error() uses them.
 
132
            # Remove this after Google Code issue 117 is fixed.
 
133
            raise
 
134
        except Exception, e:
 
135
            # A non-HTTPError appeared. We have an unknown exception. Panic.
 
136
            handle_unknown_exception(req, *sys.exc_info())
 
137
            return req.OK
 
138
        else:
 
139
            req.store.commit()
 
140
            return req.OK
 
141
    else:
 
142
        XHTMLErrorView(req, NotFound()).render(req)
 
143
        return req.OK
 
144
 
 
145
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
 
146
    """
 
147
    Given an exception that has just been thrown from IVLE, print its details
 
148
    to the request.
 
149
    This is a full handler. It assumes nothing has been written, and writes a
 
150
    complete HTML page.
 
151
    req: May be EITHER an IVLE req or an Apache req.
 
152
    The handler code may pass an apache req if an exception occurs before
 
153
    the IVLE request is created.
 
154
    """
 
155
    req.content_type = "text/html"
 
156
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
 
157
    logfail = False
 
158
 
 
159
    # XXX: This remains here for ivle.interpret's IVLEErrors. Once we rewrite
 
160
    #      fileservice, req.status should always be 500 (ISE) here.
 
161
    try:
 
162
        httpcode = exc_value.httpcode
 
163
        req.status = httpcode
 
164
    except AttributeError:
 
165
        httpcode = None
 
166
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
 
167
 
 
168
    try:
 
169
        publicmode = req.publicmode
 
170
    except AttributeError:
 
171
        publicmode = True
 
172
    try:
 
173
        login = req.user.login
 
174
    except AttributeError:
 
175
        login = None
 
176
 
 
177
    # Log File
 
178
    try:
 
179
        for h in logging.getLogger().handlers:
 
180
            logging.getLogger().removeHandler(h)
 
181
        logging.basicConfig(level=logging.INFO,
 
182
            format='%(asctime)s %(levelname)s: ' +
 
183
                '(HTTP: ' + str(req.status) +
 
184
                ', Ref: ' + str(login) + '@' +
 
185
                str(socket.gethostname()) + str(req.uri) +
 
186
                ') %(message)s',
 
187
            filename=logfile,
 
188
            filemode='a')
 
189
    except IOError:
 
190
        logfail = True
 
191
 
 
192
    # A "bad" error message. We shouldn't get here unless IVLE
 
193
    # misbehaves (which is currently very easy, if things aren't set up
 
194
    # correctly).
 
195
    # Write the traceback.
 
196
 
 
197
    # We need to special-case IVLEJailError, as we can get another
 
198
    # almost-exception out of it.
 
199
    if exc_type is util.IVLEJailError:
 
200
        tb = 'Exception information extracted from IVLEJailError:\n'
 
201
        tb += urllib.unquote(exc_value.info)
 
202
    else:
 
203
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
 
204
                                                exc_traceback))
 
205
 
 
206
    logging.error('\n' + tb)
 
207
 
 
208
    # Error messages are only displayed is the user is NOT a student,
 
209
    # or if there has been a problem logging the error message
 
210
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
 
211
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
 
212
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
 
213
<html xmlns="http://www.w3.org/1999/xhtml">
 
214
<head><title>IVLE Internal Server Error</title></head>
 
215
<body>
 
216
<h1>IVLE Internal Server Error</h1>
 
217
<p>An error has occured which is the fault of the IVLE developers or
 
218
administrators. """)
 
219
 
 
220
    if logfail:
 
221
        req.write("Please report this issue to the server administrators, "
 
222
                  "along with the following information.")
 
223
    else:
 
224
        req.write("Details have been logged for further examination.")
 
225
    req.write("</p>")
 
226
 
 
227
    if show_errors:
 
228
        req.write("<h2>Debugging information</h2>")
 
229
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
 
230
    req.write("</body></html>")