← 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: 2009-01-13 01:36:15 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1123
Merge setup-refactor branch. This completely breaks existing installations;
every path (both filesystem and Python) has changed. Do not upgrade without
knowing what you are doing.

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-2009 The University of Melbourne
 
2
# Copyright (C) 2007-2008 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
18
19
# Author: Matt Giuca
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
 
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)
37
28
 
38
29
import ivle.util
39
 
import ivle.database
40
 
from ivle.webapp.base.plugins import CookiePlugin
 
30
import ivle.conf
 
31
import plugins.console # XXX: Relies on www/ being in the Python path.
41
32
 
42
33
class Request:
43
34
    """An IVLE request object. This is presented to the IVLE apps as a way of
57
48
        user (read)
58
49
            User object. Details of the user who is currently logged in, or
59
50
            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.
63
51
        hostname (read)
64
52
            String. Hostname the server is running on.
65
53
        headers_in (read)
79
67
        location (write)
80
68
            String. Response "Location" header value. Used with HTTP redirect
81
69
            responses.
 
70
        title (write)
 
71
            String. HTML page title. Used if write_html_head_foot is True, in
 
72
            the HTML title element text.
82
73
        styles (write)
83
74
            List of strings. Write a list of URLs to CSS files here, and they
84
75
            will be incorporated as <link rel="stylesheet" type="text/css">
97
88
            in the head, if write_html_head_foot is True.
98
89
            This is the propper way to specify functions that need to run at 
99
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.
100
103
    """
101
104
 
102
105
    # Special code for an OK response.
155
158
    HTTP_INSUFFICIENT_STORAGE         = 507
156
159
    HTTP_NOT_EXTENDED                 = 510
157
160
 
158
 
    def __init__(self, req, config):
159
 
        """Create an IVLE request from a mod_python one.
 
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.
160
165
 
161
 
        @param req: A mod_python request.
162
 
        @param config: An IVLE configuration.
 
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.
163
169
        """
164
170
 
165
171
        # Methods are mostly wrappers around the Apache request object
166
172
        self.apache_req = req
167
 
        self.config = config
 
173
        self.func_write_html_head = write_html_head
168
174
        self.headers_written = False
169
175
 
170
176
        # Determine if the browser used the public host name to make the
171
177
        # request (in which case we are in "public mode")
172
 
        if req.hostname == config['urls']['public_host']:
 
178
        if req.hostname == ivle.conf.public_host:
173
179
            self.publicmode = True
174
180
        else:
175
181
            self.publicmode = False
179
185
        self.uri = req.uri
180
186
        # Split the given path into the app (top-level dir) and sub-path
181
187
        # (after first stripping away the root directory)
182
 
        path = self.unmake_path(req.uri)
 
188
        path = ivle.util.unmake_path(req.uri)
183
189
        (self.app, self.path) = (ivle.util.split_path(path))
184
190
        self.user = None
185
191
        self.hostname = req.hostname
186
192
        self.headers_in = req.headers_in
187
193
        self.headers_out = req.headers_out
188
194
 
189
 
        # Open a database connection and transaction, keep it around for users
190
 
        # of the Request object to use
191
 
        self.store = ivle.database.get_store(config)
192
 
 
193
195
        # Default values for the output members
194
196
        self.status = Request.HTTP_OK
195
197
        self.content_type = None        # Use Apache's default
196
198
        self.location = None
 
199
        self.title = None     # Will be set by dispatch before passing to app
197
200
        self.styles = []
198
201
        self.scripts = []
199
202
        self.scripts_init = []
 
203
        self.write_html_head_foot = False
200
204
        # In some cases we don't want the template JS (such as the username
201
205
        # and public FQDN) in the output HTML. In that case, set this to 0.
202
206
        self.write_javascript_settings = True
203
207
        self.got_common_vars = False
204
208
 
205
 
    def __del__(self):
206
 
        """Cleanup."""
207
 
        self.store.close()
208
 
 
209
209
    def __writeheaders(self):
210
210
        """Writes out the HTTP and HTML headers before any real data is
211
211
        written."""
212
212
        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)
213
224
 
214
225
        # Prepare the HTTP and HTML headers before the first write is made
215
226
        if self.content_type != None:
217
228
        self.apache_req.status = self.status
218
229
        if self.location != None:
219
230
            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)
220
234
 
221
235
    def ensure_headers_written(self):
222
236
        """Writes out the HTTP and HTML headers if they haven't already been
239
253
            # This includes binary strings.
240
254
            self.apache_req.write(string, flush)
241
255
 
242
 
    def logout(self):
243
 
        """Log out the current user by destroying the session state.
244
 
        Then redirect to the top-level IVLE page."""
245
 
        if hasattr(self, 'session'):
246
 
            self.session.invalidate()
247
 
            self.session.delete()
248
 
            # Invalidates all IVLE cookies
249
 
            all_cookies = mod_python.Cookie.get_cookies(self)
250
 
 
251
 
            # Create cookies for plugins that might request them.
252
 
            for plugin in self.config.plugin_index[CookiePlugin]:
253
 
                for cookie in plugin.cookies:
254
 
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
255
 
                                                    expires=1, path='/'))
256
 
        self.throw_redirect(self.make_path(''))
257
 
 
258
 
 
259
256
    def flush(self):
260
257
        """Flushes the output buffer."""
261
258
        self.apache_req.flush()
274
271
        else:
275
272
            return self.apache_req.read(len)
276
273
 
 
274
    def throw_error(self, httpcode, message=None):
 
275
        """Writes out an HTTP error of the specified code. Raises an exception
 
276
        which is caught by the dispatch or web server, so any code following
 
277
        this call will not be executed.
 
278
 
 
279
        httpcode: An HTTP response status code. Pass a constant from the
 
280
        Request class.
 
281
        """
 
282
        raise ivle.util.IVLEError(httpcode, message)
 
283
 
277
284
    def throw_redirect(self, location):
278
285
        """Writes out an HTTP redirect to the specified URL. Raises an
279
286
        exception which is caught by the dispatch or web server, so any
282
289
        httpcode: An HTTP response status code. Pass a constant from the
283
290
        Request class.
284
291
        """
285
 
        # Note: location may be a unicode, but it MUST only have ASCII
286
 
        # characters (non-ascii characters should be URL-encoded).
287
 
        mod_python.util.redirect(self.apache_req, location.encode("ascii"))
 
292
        mod_python.util.redirect(self.apache_req, location)
288
293
 
289
294
    def add_cookie(self, cookie, value=None, **attributes):
290
295
        """Inserts a cookie into this request object's headers."""
291
296
        if value is None:
292
 
            mod_python.Cookie.add_cookie(self.apache_req, cookie)
 
297
            Cookie.add_cookie(self.apache_req, cookie)
293
298
        else:
294
 
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
295
 
 
296
 
    def make_path(self, path):
297
 
        """Prepend the IVLE URL prefix to the given path.
298
 
 
299
 
        This is used when generating URLs to send to the client.
300
 
 
301
 
        This method is DEPRECATED. We no longer support use of a prefix.
302
 
        """
303
 
        return os.path.join(self.config['urls']['root'], path)
304
 
 
305
 
    def unmake_path(self, path):
306
 
        """Strip the IVLE URL prefix from the given path, if present.
307
 
 
308
 
        Also normalises the path.
309
 
 
310
 
        This method is DEPRECATED. We no longer support use of a prefix.
311
 
        """
312
 
        path = os.path.normpath(path)
313
 
        root = os.path.normpath(self.config['urls']['root'])
314
 
 
315
 
        if path.startswith(root):
316
 
            path = path[len(root):]
317
 
            # Take out the slash as well
318
 
            if len(path) > 0 and path[0] == os.sep:
319
 
                path = path[1:]
320
 
 
321
 
        return path
 
299
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
322
300
 
323
301
    def get_session(self):
324
302
        """Returns a mod_python Session object for this request.
325
303
        Note that this is dependent on mod_python and may need to change
326
 
        interface if porting away from mod_python.
327
 
 
328
 
        IMPORTANT: Call unlock() on the session as soon as you are done with
329
 
                   it! If you don't, all other requests will block!
330
 
        """
 
304
        interface if porting away from mod_python."""
331
305
        # Cache the session object and set the timeout to 24 hours.
332
306
        if not hasattr(self, 'session'):
333
 
            self.session = mod_python.Session.FileSession(self.apache_req,
 
307
            self.session = Session.FileSession(self.apache_req,
334
308
                                               timeout = 60 * 60 * 24)
335
309
        return self.session
336
310
 
340
314
        interface if porting away from mod_python."""
341
315
        # Cache the fieldstorage object
342
316
        if not hasattr(self, 'fields'):
343
 
            self.fields = mod_python.util.FieldStorage(self.apache_req)
 
317
            self.fields = util.FieldStorage(self.apache_req)
344
318
        return self.fields
345
319
 
346
320
    def get_cgi_environ(self):