← 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: matt.giuca
  • Date: 2009-01-12 00:34:59 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1073
usrmgt-server: When creating svn repo, now explicitly asks for the exception
    to be thrown up, rather than ignored.

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
 
        req.status = 404
143
 
        XHTMLErrorView(req, NotFound()).render(req)
144
 
        return req.OK
145
 
 
146
 
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
147
 
    """
148
 
    Given an exception that has just been thrown from IVLE, print its details
149
 
    to the request.
150
 
    This is a full handler. It assumes nothing has been written, and writes a
151
 
    complete HTML page.
152
 
    req: May be EITHER an IVLE req or an Apache req.
153
 
    The handler code may pass an apache req if an exception occurs before
154
 
    the IVLE request is created.
155
 
    """
156
 
    req.content_type = "text/html"
157
 
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
158
 
    logfail = False
159
 
 
160
 
    # XXX: This remains here for ivle.interpret's IVLEErrors. Once we rewrite
161
 
    #      fileservice, req.status should always be 500 (ISE) here.
162
 
    try:
163
 
        httpcode = exc_value.httpcode
164
 
        req.status = httpcode
165
 
    except AttributeError:
166
 
        httpcode = None
167
 
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
168
 
 
169
 
    try:
170
 
        publicmode = req.publicmode
171
 
    except AttributeError:
172
 
        publicmode = True
173
 
    try:
174
 
        login = req.user.login
175
 
    except AttributeError:
176
 
        login = None
177
 
 
178
 
    # Log File
179
 
    try:
180
 
        for h in logging.getLogger().handlers:
181
 
            logging.getLogger().removeHandler(h)
182
 
        logging.basicConfig(level=logging.INFO,
183
 
            format='%(asctime)s %(levelname)s: ' +
184
 
                '(HTTP: ' + str(req.status) +
185
 
                ', Ref: ' + str(login) + '@' +
186
 
                str(socket.gethostname()) + str(req.uri) +
187
 
                ') %(message)s',
188
 
            filename=logfile,
189
 
            filemode='a')
190
 
    except IOError:
191
 
        logfail = True
192
 
 
193
 
    # A "bad" error message. We shouldn't get here unless IVLE
194
 
    # misbehaves (which is currently very easy, if things aren't set up
195
 
    # correctly).
196
 
    # Write the traceback.
197
 
 
198
 
    # We need to special-case IVLEJailError, as we can get another
199
 
    # almost-exception out of it.
200
 
    if exc_type is util.IVLEJailError:
201
 
        tb = 'Exception information extracted from IVLEJailError:\n'
202
 
        tb += urllib.unquote(exc_value.info)
203
 
    else:
204
 
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
205
 
                                                exc_traceback))
206
 
 
207
 
    logging.error('\n' + tb)
208
 
 
209
 
    # Error messages are only displayed is the user is NOT a student,
210
 
    # or if there has been a problem logging the error message
211
 
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
212
 
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
213
 
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
214
 
<html xmlns="http://www.w3.org/1999/xhtml">
215
 
<head><title>IVLE Internal Server Error</title></head>
216
 
<body>
217
 
<h1>IVLE Internal Server Error</h1>
218
 
<p>An error has occured which is the fault of the IVLE developers or
219
 
administrators. """)
220
 
 
221
 
    if logfail:
222
 
        req.write("Please report this issue to the server administrators, "
223
 
                  "along with the following information.")
224
 
    else:
225
 
        req.write("Details have been logged for further examination.")
226
 
    req.write("</p>")
227
 
 
228
 
    if show_errors:
229
 
        req.write("<h2>Debugging information</h2>")
230
 
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
231
 
    req.write("</body></html>")