← 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: William Grant
  • Date: 2009-07-06 07:58:11 UTC
  • mto: (1294.4.2 ui-the-third)
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: grantw@unimelb.edu.au-20090706075811-mfu9cqt3hi1sgbej
Only show the tabs in the IVLE crumb's menu if logged in.

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