← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/request.py

  • Committer: William Grant
  • Date: 2010-02-11 08:36:15 UTC
  • Revision ID: grantw@unimelb.edu.au-20100211083615-5imzir7px5dblvwk
divify the login form, fixing up the submit/error indentation while there.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
1
1
# IVLE - Informatics Virtual Learning Environment
2
 
# Copyright (C) 2007-2008 The University of Melbourne
 
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.request
19
18
# Author: Matt Giuca
20
 
# Date:   12/12/2007
21
 
 
22
 
# Builds an IVLE request object from a mod_python request object.
23
 
# See design notes/apps/dispatch.txt for a full specification of this request
24
 
# object.
25
 
 
26
 
import mod_python
27
 
from mod_python import (util, Session, Cookie)
 
19
 
 
20
"""
 
21
IVLE Request Object
 
22
 
 
23
Builds an IVLE request object from a mod_python request object.
 
24
See design notes/apps/dispatch.txt for a full specification of this request
 
25
object.
 
26
"""
 
27
 
 
28
try:
 
29
    import mod_python.Session
 
30
    import mod_python.Cookie
 
31
    import mod_python.util
 
32
except ImportError:
 
33
    # This needs to be importable from outside Apache.
 
34
    pass
 
35
 
 
36
import os.path
28
37
 
29
38
import ivle.util
30
 
import ivle.conf
31
 
import plugins.console # XXX: Relies on www/ being in the Python path.
 
39
import ivle.database
 
40
from ivle.webapp.base.plugins import CookiePlugin
32
41
 
33
42
class Request:
34
43
    """An IVLE request object. This is presented to the IVLE apps as a way of
48
57
        user (read)
49
58
            User object. Details of the user who is currently logged in, or
50
59
            None.
 
60
        store (read)
 
61
            storm.store.Store instance. Holds a database transaction open,
 
62
            which is available for the entire lifetime of the request.
51
63
        hostname (read)
52
64
            String. Hostname the server is running on.
53
65
        headers_in (read)
67
79
        location (write)
68
80
            String. Response "Location" header value. Used with HTTP redirect
69
81
            responses.
70
 
        title (write)
71
 
            String. HTML page title. Used if write_html_head_foot is True, in
72
 
            the HTML title element text.
73
 
        styles (write)
74
 
            List of strings. Write a list of URLs to CSS files here, and they
75
 
            will be incorporated as <link rel="stylesheet" type="text/css">
76
 
            elements in the head, if write_html_head_foot is True.
77
 
            URLs should be relative to the IVLE root; they will be fixed up
78
 
            to be site-relative.
79
 
        scripts (write)
80
 
            List of strings. Write a list of URLs to JS files here, and they
81
 
            will be incorporated as <script type="text/javascript"> elements
82
 
            in the head, if write_html_head_foot is True.
83
 
            URLs should be relative to the IVLE root; they will be fixed up
84
 
            to be site-relative.
85
 
        scripts_init (write)
86
 
            List of strings. Write a list of JS function names, and they
87
 
            will be added as window.addListener('load', ..., false); calls
88
 
            in the head, if write_html_head_foot is True.
89
 
            This is the propper way to specify functions that need to run at 
90
 
            page load time.
91
 
        write_html_head_foot (write)
92
 
            Boolean. If True, dispatch assumes that this is an XHTML page, and
93
 
            will immediately write a full HTML head, open the body element,
94
 
            and write heading contents to the page, before any bytes are
95
 
            written. It will then write footer contents and close the body and
96
 
            html elements at the end of execution.  
97
 
 
98
 
            This value should be set to true by all applications for all HTML
99
 
            output (unless there is a good reason, eg. exec). The
100
 
            applications should therefore output HTML content assuming that
101
 
            it will be written inside the body tag. Do not write opening or
102
 
            closing <html> or <body> tags.
103
82
    """
104
83
 
105
84
    # Special code for an OK response.
109
88
 
110
89
    # HTTP status codes
111
90
 
112
 
    HTTP_CONTINUE                     = 100
113
 
    HTTP_SWITCHING_PROTOCOLS          = 101
114
 
    HTTP_PROCESSING                   = 102
115
91
    HTTP_OK                           = 200
116
 
    HTTP_CREATED                      = 201
117
 
    HTTP_ACCEPTED                     = 202
118
 
    HTTP_NON_AUTHORITATIVE            = 203
119
 
    HTTP_NO_CONTENT                   = 204
120
 
    HTTP_RESET_CONTENT                = 205
121
 
    HTTP_PARTIAL_CONTENT              = 206
122
 
    HTTP_MULTI_STATUS                 = 207
123
 
    HTTP_MULTIPLE_CHOICES             = 300
124
 
    HTTP_MOVED_PERMANENTLY            = 301
125
92
    HTTP_MOVED_TEMPORARILY            = 302
126
 
    HTTP_SEE_OTHER                    = 303
127
 
    HTTP_NOT_MODIFIED                 = 304
128
 
    HTTP_USE_PROXY                    = 305
129
 
    HTTP_TEMPORARY_REDIRECT           = 307
130
 
    HTTP_BAD_REQUEST                  = 400
131
 
    HTTP_UNAUTHORIZED                 = 401
132
 
    HTTP_PAYMENT_REQUIRED             = 402
133
93
    HTTP_FORBIDDEN                    = 403
134
94
    HTTP_NOT_FOUND                    = 404
135
 
    HTTP_METHOD_NOT_ALLOWED           = 405
136
 
    HTTP_NOT_ACCEPTABLE               = 406
137
 
    HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
138
 
    HTTP_REQUEST_TIME_OUT             = 408
139
 
    HTTP_CONFLICT                     = 409
140
 
    HTTP_GONE                         = 410
141
 
    HTTP_LENGTH_REQUIRED              = 411
142
 
    HTTP_PRECONDITION_FAILED          = 412
143
 
    HTTP_REQUEST_ENTITY_TOO_LARGE     = 413
144
 
    HTTP_REQUEST_URI_TOO_LARGE        = 414
145
 
    HTTP_UNSUPPORTED_MEDIA_TYPE       = 415
146
 
    HTTP_RANGE_NOT_SATISFIABLE        = 416
147
 
    HTTP_EXPECTATION_FAILED           = 417
148
 
    HTTP_UNPROCESSABLE_ENTITY         = 422
149
 
    HTTP_LOCKED                       = 423
150
 
    HTTP_FAILED_DEPENDENCY            = 424
151
95
    HTTP_INTERNAL_SERVER_ERROR        = 500
152
 
    HTTP_NOT_IMPLEMENTED              = 501
153
 
    HTTP_BAD_GATEWAY                  = 502
154
 
    HTTP_SERVICE_UNAVAILABLE          = 503
155
 
    HTTP_GATEWAY_TIME_OUT             = 504
156
 
    HTTP_VERSION_NOT_SUPPORTED        = 505
157
 
    HTTP_VARIANT_ALSO_VARIES          = 506
158
 
    HTTP_INSUFFICIENT_STORAGE         = 507
159
 
    HTTP_NOT_EXTENDED                 = 510
160
 
 
161
 
    def __init__(self, req, write_html_head):
162
 
        """Builds an IVLE request object from a mod_python request object.
163
 
        This results in an object with all of the necessary methods and
164
 
        additional fields.
165
 
 
166
 
        req: A mod_python request object.
167
 
        write_html_head: Function which is called when writing the automatic
168
 
            HTML header. Accepts a single argument, the IVLE request object.
 
96
 
 
97
    def __init__(self, req, config):
 
98
        """Create an IVLE request from a mod_python one.
 
99
 
 
100
        @param req: A mod_python request.
 
101
        @param config: An IVLE configuration.
169
102
        """
170
103
 
171
104
        # Methods are mostly wrappers around the Apache request object
172
105
        self.apache_req = req
173
 
        self.func_write_html_head = write_html_head
 
106
        self.config = config
174
107
        self.headers_written = False
175
108
 
176
109
        # Determine if the browser used the public host name to make the
177
110
        # request (in which case we are in "public mode")
178
 
        if req.hostname == ivle.conf.public_host:
 
111
        if req.hostname == config['urls']['public_host']:
179
112
            self.publicmode = True
180
113
        else:
181
114
            self.publicmode = False
185
118
        self.uri = req.uri
186
119
        # Split the given path into the app (top-level dir) and sub-path
187
120
        # (after first stripping away the root directory)
188
 
        path = ivle.util.unmake_path(req.uri)
189
 
        (self.app, self.path) = (ivle.util.split_path(path))
 
121
        (self.app, self.path) = (ivle.util.split_path(req.uri))
190
122
        self.user = None
191
123
        self.hostname = req.hostname
192
124
        self.headers_in = req.headers_in
193
125
        self.headers_out = req.headers_out
194
126
 
 
127
        # Open a database connection and transaction, keep it around for users
 
128
        # of the Request object to use
 
129
        self.store = ivle.database.get_store(config)
 
130
 
195
131
        # Default values for the output members
196
132
        self.status = Request.HTTP_OK
197
133
        self.content_type = None        # Use Apache's default
198
134
        self.location = None
199
 
        self.title = None     # Will be set by dispatch before passing to app
200
 
        self.styles = []
201
 
        self.scripts = []
202
 
        self.scripts_init = []
203
 
        self.write_html_head_foot = False
204
135
        # In some cases we don't want the template JS (such as the username
205
136
        # and public FQDN) in the output HTML. In that case, set this to 0.
206
137
        self.write_javascript_settings = True
207
138
        self.got_common_vars = False
208
139
 
 
140
    def __del__(self):
 
141
        """Cleanup."""
 
142
        self.store.close()
 
143
 
209
144
    def __writeheaders(self):
210
145
        """Writes out the HTTP and HTML headers before any real data is
211
146
        written."""
212
147
        self.headers_written = True
213
 
        
214
 
        # app is the App object for the chosen app
215
 
        try:
216
 
            app = ivle.conf.apps.app_url[self.app]
217
 
        except KeyError:
218
 
            app = None
219
 
 
220
 
        # Write any final modifications to header content
221
 
        if app and app.useconsole and self.user:
222
 
            plugins.console.insert_scripts_styles(self.scripts, self.styles, \
223
 
                self.scripts_init)
224
148
 
225
149
        # Prepare the HTTP and HTML headers before the first write is made
226
150
        if self.content_type != None:
228
152
        self.apache_req.status = self.status
229
153
        if self.location != None:
230
154
            self.apache_req.headers_out['Location'] = self.location
231
 
        if self.write_html_head_foot:
232
 
            # Write the HTML header, pass "self" (request object)
233
 
            self.func_write_html_head(self)
234
155
 
235
156
    def ensure_headers_written(self):
236
157
        """Writes out the HTTP and HTML headers if they haven't already been
256
177
    def logout(self):
257
178
        """Log out the current user by destroying the session state.
258
179
        Then redirect to the top-level IVLE page."""
259
 
        # List of cookies that IVLE uses (to be removed at logout)
260
 
        ivle_cookies = ["ivleforumcookie", "clipboard"]
261
 
        
262
180
        if hasattr(self, 'session'):
263
181
            self.session.invalidate()
264
182
            self.session.delete()
265
183
            # Invalidates all IVLE cookies
266
 
            all_cookies = Cookie.get_cookies(self)
267
 
            for cookie in all_cookies:
268
 
                if cookie in ivle_cookies:
269
 
                    self.add_cookie(Cookie.Cookie(cookie,'',expires=1,path='/'))
270
 
        self.throw_redirect(ivle.util.make_path('')) 
 
184
            all_cookies = mod_python.Cookie.get_cookies(self)
 
185
 
 
186
            # Create cookies for plugins that might request them.
 
187
            for plugin in self.config.plugin_index[CookiePlugin]:
 
188
                for cookie in plugin.cookies:
 
189
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
 
190
                                                    expires=1, path='/'))
 
191
        self.throw_redirect(self.make_path(''))
271
192
 
272
193
 
273
194
    def flush(self):
288
209
        else:
289
210
            return self.apache_req.read(len)
290
211
 
291
 
    def throw_error(self, httpcode, message=None):
292
 
        """Writes out an HTTP error of the specified code. Raises an exception
293
 
        which is caught by the dispatch or web server, so any code following
294
 
        this call will not be executed.
295
 
 
296
 
        httpcode: An HTTP response status code. Pass a constant from the
297
 
        Request class.
298
 
        """
299
 
        raise ivle.util.IVLEError(httpcode, message)
300
 
 
301
212
    def throw_redirect(self, location):
302
213
        """Writes out an HTTP redirect to the specified URL. Raises an
303
214
        exception which is caught by the dispatch or web server, so any
306
217
        httpcode: An HTTP response status code. Pass a constant from the
307
218
        Request class.
308
219
        """
309
 
        mod_python.util.redirect(self.apache_req, location)
 
220
        # Note: location may be a unicode, but it MUST only have ASCII
 
221
        # characters (non-ascii characters should be URL-encoded).
 
222
        mod_python.util.redirect(self.apache_req, location.encode("ascii"))
310
223
 
311
224
    def add_cookie(self, cookie, value=None, **attributes):
312
225
        """Inserts a cookie into this request object's headers."""
313
226
        if value is None:
314
 
            Cookie.add_cookie(self.apache_req, cookie)
 
227
            mod_python.Cookie.add_cookie(self.apache_req, cookie)
315
228
        else:
316
 
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
 
229
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
 
230
 
 
231
    def make_path(self, path):
 
232
        """Prepend the IVLE URL prefix to the given path.
 
233
 
 
234
        This is used when generating URLs to send to the client.
 
235
 
 
236
        This method is DEPRECATED. We no longer support use of a prefix.
 
237
        """
 
238
        return os.path.join(self.config['urls']['root'], path)
317
239
 
318
240
    def get_session(self):
319
241
        """Returns a mod_python Session object for this request.
320
242
        Note that this is dependent on mod_python and may need to change
321
 
        interface if porting away from mod_python."""
 
243
        interface if porting away from mod_python.
 
244
 
 
245
        IMPORTANT: Call unlock() on the session as soon as you are done with
 
246
                   it! If you don't, all other requests will block!
 
247
        """
322
248
        # Cache the session object and set the timeout to 24 hours.
323
249
        if not hasattr(self, 'session'):
324
 
            self.session = Session.FileSession(self.apache_req,
 
250
            self.session = mod_python.Session.FileSession(self.apache_req,
325
251
                                               timeout = 60 * 60 * 24)
326
252
        return self.session
327
253
 
331
257
        interface if porting away from mod_python."""
332
258
        # Cache the fieldstorage object
333
259
        if not hasattr(self, 'fields'):
334
 
            self.fields = util.FieldStorage(self.apache_req)
 
260
            self.fields = mod_python.util.FieldStorage(self.apache_req)
335
261
        return self.fields
336
262
 
337
263
    def get_cgi_environ(self):
343
269
            self.got_common_vars = True
344
270
        return self.apache_req.subprocess_env
345
271
 
346
 
    @staticmethod
347
 
    def get_http_codename(code):
348
 
        """Given a HTTP error code int, returns a (name, description)
349
 
        pair, suitable for displaying to the user.
350
 
        May return (None,None) if code is unknown.
351
 
        Only lists common 4xx and 5xx codes (since this is just used
352
 
        to display throw_error error messages).
353
 
        """
354
 
        try:
355
 
            return http_codenames[code]
356
 
        except KeyError:
357
 
            return None, None
358
 
 
359
 
# Human strings for HTTP response codes
360
 
http_codenames = {
361
 
    Request.HTTP_BAD_REQUEST:
362
 
        ("Bad Request",
363
 
        "Your browser sent a request IVLE did not understand."),
364
 
    Request.HTTP_UNAUTHORIZED:
365
 
        ("Unauthorized",
366
 
        "You are not allowed to view this part of IVLE."),
367
 
    Request.HTTP_FORBIDDEN:
368
 
        ("Forbidden",
369
 
        "You are not allowed to view this part of IVLE."),
370
 
    Request.HTTP_NOT_FOUND:
371
 
        ("Not Found",
372
 
        "The application or file you requested does not exist."),
373
 
    Request.HTTP_METHOD_NOT_ALLOWED:
374
 
        ("Method Not Allowed",
375
 
        "Your browser is interacting with IVLE in the wrong way."
376
 
        "This is probably a bug in IVLE. "
377
 
        "Please report it to the administrators."),
378
 
    Request.HTTP_INTERNAL_SERVER_ERROR:
379
 
        ("Internal Server Error",
380
 
        "An unknown error occured in IVLE."),
381
 
    Request.HTTP_NOT_IMPLEMENTED:
382
 
        ("Not Implemented",
383
 
        "The application or file you requested has not been implemented "
384
 
        "in IVLE."),
385
 
    Request.HTTP_SERVICE_UNAVAILABLE:
386
 
        ("Service Unavailable",
387
 
        "IVLE is currently experiencing technical difficulties. "
388
 
        "Please try again later."),
389
 
}