← 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: me at id
  • Date: 2009-01-15 02:55:57 UTC
  • mto: This revision was merged to the branch mainline in revision 1090.
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:branches%2Fstorm:1149
ivle.fileservice_lib.action.get_login: Always give credentials as strs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
25
25
object.
26
26
"""
27
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
import mod_python
 
29
from mod_python import (util, Session, Cookie)
37
30
 
38
31
import ivle.util
 
32
import ivle.conf
39
33
import ivle.database
40
 
from ivle.webapp.base.plugins import CookiePlugin
 
34
import plugins.console # XXX: Relies on www/ being in the Python path.
41
35
 
42
36
class Request:
43
37
    """An IVLE request object. This is presented to the IVLE apps as a way of
79
73
        location (write)
80
74
            String. Response "Location" header value. Used with HTTP redirect
81
75
            responses.
 
76
        title (write)
 
77
            String. HTML page title. Used if write_html_head_foot is True, in
 
78
            the HTML title element text.
82
79
        styles (write)
83
80
            List of strings. Write a list of URLs to CSS files here, and they
84
81
            will be incorporated as <link rel="stylesheet" type="text/css">
97
94
            in the head, if write_html_head_foot is True.
98
95
            This is the propper way to specify functions that need to run at 
99
96
            page load time.
 
97
        write_html_head_foot (write)
 
98
            Boolean. If True, dispatch assumes that this is an XHTML page, and
 
99
            will immediately write a full HTML head, open the body element,
 
100
            and write heading contents to the page, before any bytes are
 
101
            written. It will then write footer contents and close the body and
 
102
            html elements at the end of execution.  
 
103
 
 
104
            This value should be set to true by all applications for all HTML
 
105
            output (unless there is a good reason, eg. exec). The
 
106
            applications should therefore output HTML content assuming that
 
107
            it will be written inside the body tag. Do not write opening or
 
108
            closing <html> or <body> tags.
100
109
    """
101
110
 
102
111
    # Special code for an OK response.
155
164
    HTTP_INSUFFICIENT_STORAGE         = 507
156
165
    HTTP_NOT_EXTENDED                 = 510
157
166
 
158
 
    def __init__(self, req, config):
159
 
        """Create an IVLE request from a mod_python one.
 
167
    def __init__(self, req, write_html_head):
 
168
        """Builds an IVLE request object from a mod_python request object.
 
169
        This results in an object with all of the necessary methods and
 
170
        additional fields.
160
171
 
161
 
        @param req: A mod_python request.
162
 
        @param config: An IVLE configuration.
 
172
        req: A mod_python request object.
 
173
        write_html_head: Function which is called when writing the automatic
 
174
            HTML header. Accepts a single argument, the IVLE request object.
163
175
        """
164
176
 
165
177
        # Methods are mostly wrappers around the Apache request object
166
178
        self.apache_req = req
167
 
        self.config = config
 
179
        self.func_write_html_head = write_html_head
168
180
        self.headers_written = False
169
181
 
170
182
        # Determine if the browser used the public host name to make the
171
183
        # request (in which case we are in "public mode")
172
 
        if req.hostname == config['urls']['public_host']:
 
184
        if req.hostname == ivle.conf.public_host:
173
185
            self.publicmode = True
174
186
        else:
175
187
            self.publicmode = False
179
191
        self.uri = req.uri
180
192
        # Split the given path into the app (top-level dir) and sub-path
181
193
        # (after first stripping away the root directory)
182
 
        path = self.unmake_path(req.uri)
 
194
        path = ivle.util.unmake_path(req.uri)
183
195
        (self.app, self.path) = (ivle.util.split_path(path))
184
196
        self.user = None
185
197
        self.hostname = req.hostname
188
200
 
189
201
        # Open a database connection and transaction, keep it around for users
190
202
        # of the Request object to use
191
 
        self.store = ivle.database.get_store(config)
 
203
        self.store = ivle.database.get_store()
192
204
 
193
205
        # Default values for the output members
194
206
        self.status = Request.HTTP_OK
195
207
        self.content_type = None        # Use Apache's default
196
208
        self.location = None
 
209
        self.title = None     # Will be set by dispatch before passing to app
197
210
        self.styles = []
198
211
        self.scripts = []
199
212
        self.scripts_init = []
 
213
        self.write_html_head_foot = False
200
214
        # In some cases we don't want the template JS (such as the username
201
215
        # and public FQDN) in the output HTML. In that case, set this to 0.
202
216
        self.write_javascript_settings = True
210
224
        """Writes out the HTTP and HTML headers before any real data is
211
225
        written."""
212
226
        self.headers_written = True
 
227
        
 
228
        # app is the App object for the chosen app
 
229
        try:
 
230
            app = ivle.conf.apps.app_url[self.app]
 
231
        except KeyError:
 
232
            app = None
 
233
 
 
234
        # Write any final modifications to header content
 
235
        if app and app.useconsole and self.user:
 
236
            plugins.console.insert_scripts_styles(self.scripts, self.styles, \
 
237
                self.scripts_init)
213
238
 
214
239
        # Prepare the HTTP and HTML headers before the first write is made
215
240
        if self.content_type != None:
217
242
        self.apache_req.status = self.status
218
243
        if self.location != None:
219
244
            self.apache_req.headers_out['Location'] = self.location
 
245
        if self.write_html_head_foot:
 
246
            # Write the HTML header, pass "self" (request object)
 
247
            self.func_write_html_head(self)
220
248
 
221
249
    def ensure_headers_written(self):
222
250
        """Writes out the HTTP and HTML headers if they haven't already been
239
267
            # This includes binary strings.
240
268
            self.apache_req.write(string, flush)
241
269
 
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
270
    def flush(self):
260
271
        """Flushes the output buffer."""
261
272
        self.apache_req.flush()
274
285
        else:
275
286
            return self.apache_req.read(len)
276
287
 
 
288
    def throw_error(self, httpcode, message=None):
 
289
        """Writes out an HTTP error of the specified code. Raises an exception
 
290
        which is caught by the dispatch or web server, so any code following
 
291
        this call will not be executed.
 
292
 
 
293
        httpcode: An HTTP response status code. Pass a constant from the
 
294
        Request class.
 
295
        """
 
296
        raise ivle.util.IVLEError(httpcode, message)
 
297
 
277
298
    def throw_redirect(self, location):
278
299
        """Writes out an HTTP redirect to the specified URL. Raises an
279
300
        exception which is caught by the dispatch or web server, so any
289
310
    def add_cookie(self, cookie, value=None, **attributes):
290
311
        """Inserts a cookie into this request object's headers."""
291
312
        if value is None:
292
 
            mod_python.Cookie.add_cookie(self.apache_req, cookie)
 
313
            Cookie.add_cookie(self.apache_req, cookie)
293
314
        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
 
315
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
322
316
 
323
317
    def get_session(self):
324
318
        """Returns a mod_python Session object for this request.
325
319
        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
 
        """
 
320
        interface if porting away from mod_python."""
331
321
        # Cache the session object and set the timeout to 24 hours.
332
322
        if not hasattr(self, 'session'):
333
 
            self.session = mod_python.Session.FileSession(self.apache_req,
 
323
            self.session = Session.FileSession(self.apache_req,
334
324
                                               timeout = 60 * 60 * 24)
335
325
        return self.session
336
326
 
340
330
        interface if porting away from mod_python."""
341
331
        # Cache the fieldstorage object
342
332
        if not hasattr(self, 'fields'):
343
 
            self.fields = mod_python.util.FieldStorage(self.apache_req)
 
333
            self.fields = util.FieldStorage(self.apache_req)
344
334
        return self.fields
345
335
 
346
336
    def get_cgi_environ(self):