← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/request.py

Port www/apps/logout to new framework (in ivle.webapp.security).

Show diffs side-by-side

added added

removed removed

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