← 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: matt.giuca
  • Date: 2009-02-02 22:27:12 UTC
  • Revision ID: svn-v4:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1191
tutorial: Fixed use of wrong variable names (broke during refactor).

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
 
28
import mod_python
 
29
from mod_python import (util, Session, Cookie)
35
30
 
36
31
import ivle.util
37
32
import ivle.conf
38
33
import ivle.database
39
 
from ivle.webapp.base.plugins import CookiePlugin
 
34
import plugins.console # XXX: Relies on www/ being in the Python path.
40
35
 
41
36
class Request:
42
37
    """An IVLE request object. This is presented to the IVLE apps as a way of
78
73
        location (write)
79
74
            String. Response "Location" header value. Used with HTTP redirect
80
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.
81
79
        styles (write)
82
80
            List of strings. Write a list of URLs to CSS files here, and they
83
81
            will be incorporated as <link rel="stylesheet" type="text/css">
96
94
            in the head, if write_html_head_foot is True.
97
95
            This is the propper way to specify functions that need to run at 
98
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.
99
109
    """
100
110
 
101
111
    # Special code for an OK response.
154
164
    HTTP_INSUFFICIENT_STORAGE         = 507
155
165
    HTTP_NOT_EXTENDED                 = 510
156
166
 
157
 
    def __init__(self, req):
 
167
    def __init__(self, req, write_html_head):
158
168
        """Builds an IVLE request object from a mod_python request object.
159
169
        This results in an object with all of the necessary methods and
160
170
        additional fields.
161
171
 
162
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
 
179
        self.func_write_html_head = write_html_head
167
180
        self.headers_written = False
168
181
 
169
182
        # Determine if the browser used the public host name to make the
193
206
        self.status = Request.HTTP_OK
194
207
        self.content_type = None        # Use Apache's default
195
208
        self.location = None
 
209
        self.title = None     # Will be set by dispatch before passing to app
196
210
        self.styles = []
197
211
        self.scripts = []
198
212
        self.scripts_init = []
 
213
        self.write_html_head_foot = False
199
214
        # In some cases we don't want the template JS (such as the username
200
215
        # and public FQDN) in the output HTML. In that case, set this to 0.
201
216
        self.write_javascript_settings = True
209
224
        """Writes out the HTTP and HTML headers before any real data is
210
225
        written."""
211
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)
212
238
 
213
239
        # Prepare the HTTP and HTML headers before the first write is made
214
240
        if self.content_type != None:
216
242
        self.apache_req.status = self.status
217
243
        if self.location != None:
218
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)
219
248
 
220
249
    def ensure_headers_written(self):
221
250
        """Writes out the HTTP and HTML headers if they haven't already been
241
270
    def logout(self):
242
271
        """Log out the current user by destroying the session state.
243
272
        Then redirect to the top-level IVLE page."""
 
273
        # List of cookies that IVLE uses (to be removed at logout)
 
274
        ivle_cookies = ["ivleforumcookie", "clipboard"]
 
275
        
244
276
        if hasattr(self, 'session'):
245
277
            self.session.invalidate()
246
278
            self.session.delete()
247
279
            # Invalidates all IVLE cookies
248
 
            all_cookies = mod_python.Cookie.get_cookies(self)
249
 
 
250
 
            # Create cookies for plugins that might request them.
251
 
            for plugin in self.config.plugin_index[CookiePlugin]:
252
 
                for cookie in plugin.cookies:
253
 
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
254
 
                                                    expires=1, path='/'))
 
280
            all_cookies = Cookie.get_cookies(self)
 
281
            for cookie in all_cookies:
 
282
                if cookie in ivle_cookies:
 
283
                    self.add_cookie(Cookie.Cookie(cookie,'',expires=1,path='/'))
255
284
        self.throw_redirect(ivle.util.make_path('')) 
256
285
 
257
286
 
273
302
        else:
274
303
            return self.apache_req.read(len)
275
304
 
 
305
    def throw_error(self, httpcode, message=None):
 
306
        """Writes out an HTTP error of the specified code. Raises an exception
 
307
        which is caught by the dispatch or web server, so any code following
 
308
        this call will not be executed.
 
309
 
 
310
        httpcode: An HTTP response status code. Pass a constant from the
 
311
        Request class.
 
312
        """
 
313
        raise ivle.util.IVLEError(httpcode, message)
 
314
 
276
315
    def throw_redirect(self, location):
277
316
        """Writes out an HTTP redirect to the specified URL. Raises an
278
317
        exception which is caught by the dispatch or web server, so any
288
327
    def add_cookie(self, cookie, value=None, **attributes):
289
328
        """Inserts a cookie into this request object's headers."""
290
329
        if value is None:
291
 
            mod_python.Cookie.add_cookie(self.apache_req, cookie)
 
330
            Cookie.add_cookie(self.apache_req, cookie)
292
331
        else:
293
 
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
 
332
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
294
333
 
295
334
    def get_session(self):
296
335
        """Returns a mod_python Session object for this request.
298
337
        interface if porting away from mod_python."""
299
338
        # Cache the session object and set the timeout to 24 hours.
300
339
        if not hasattr(self, 'session'):
301
 
            self.session = mod_python.Session.FileSession(self.apache_req,
 
340
            self.session = Session.FileSession(self.apache_req,
302
341
                                               timeout = 60 * 60 * 24)
303
342
        return self.session
304
343
 
308
347
        interface if porting away from mod_python."""
309
348
        # Cache the fieldstorage object
310
349
        if not hasattr(self, 'fields'):
311
 
            self.fields = mod_python.util.FieldStorage(self.apache_req)
 
350
            self.fields = util.FieldStorage(self.apache_req)
312
351
        return self.fields
313
352
 
314
353
    def get_cgi_environ(self):