← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/request.py

fixed a slight bug on line 155, which referenced a non-existant variable

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
36
36
import ivle.util
37
37
import ivle.conf
38
38
import ivle.database
39
 
import plugins.console # XXX: Relies on www/ being in the Python path.
 
39
from ivle.webapp.base.plugins import CookiePlugin
40
40
 
41
41
class Request:
42
42
    """An IVLE request object. This is presented to the IVLE apps as a way of
78
78
        location (write)
79
79
            String. Response "Location" header value. Used with HTTP redirect
80
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.
84
81
        styles (write)
85
82
            List of strings. Write a list of URLs to CSS files here, and they
86
83
            will be incorporated as <link rel="stylesheet" type="text/css">
99
96
            in the head, if write_html_head_foot is True.
100
97
            This is the propper way to specify functions that need to run at 
101
98
            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.
114
99
    """
115
100
 
116
101
    # Special code for an OK response.
169
154
    HTTP_INSUFFICIENT_STORAGE         = 507
170
155
    HTTP_NOT_EXTENDED                 = 510
171
156
 
172
 
    def __init__(self, req, write_html_head):
 
157
    def __init__(self, req):
173
158
        """Builds an IVLE request object from a mod_python request object.
174
159
        This results in an object with all of the necessary methods and
175
160
        additional fields.
176
161
 
177
162
        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.
180
163
        """
181
164
 
182
165
        # Methods are mostly wrappers around the Apache request object
183
166
        self.apache_req = req
184
 
        self.func_write_html_head = write_html_head
185
167
        self.headers_written = False
186
168
 
187
169
        # Determine if the browser used the public host name to make the
211
193
        self.status = Request.HTTP_OK
212
194
        self.content_type = None        # Use Apache's default
213
195
        self.location = None
214
 
        self.title = None     # Will be set by dispatch before passing to app
215
196
        self.styles = []
216
197
        self.scripts = []
217
198
        self.scripts_init = []
218
 
        self.write_html_head_foot = False
219
199
        # In some cases we don't want the template JS (such as the username
220
200
        # and public FQDN) in the output HTML. In that case, set this to 0.
221
201
        self.write_javascript_settings = True
229
209
        """Writes out the HTTP and HTML headers before any real data is
230
210
        written."""
231
211
        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)
243
212
 
244
213
        # Prepare the HTTP and HTML headers before the first write is made
245
214
        if self.content_type != None:
247
216
        self.apache_req.status = self.status
248
217
        if self.location != None:
249
218
            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)
253
219
 
254
220
    def ensure_headers_written(self):
255
221
        """Writes out the HTTP and HTML headers if they haven't already been
275
241
    def logout(self):
276
242
        """Log out the current user by destroying the session state.
277
243
        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
 
        
281
244
        if hasattr(self, 'session'):
282
245
            self.session.invalidate()
283
246
            self.session.delete()
284
247
            # Invalidates all IVLE cookies
285
248
            all_cookies = mod_python.Cookie.get_cookies(self)
286
 
            for cookie in all_cookies:
287
 
                if cookie in ivle_cookies:
288
 
                    self.add_cookie(mod_python.Cookie.Cookie(cookie,'',expires=1,path='/'))
 
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='/'))
289
255
        self.throw_redirect(ivle.util.make_path('')) 
290
256
 
291
257
 
307
273
        else:
308
274
            return self.apache_req.read(len)
309
275
 
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
 
 
320
276
    def throw_redirect(self, location):
321
277
        """Writes out an HTTP redirect to the specified URL. Raises an
322
278
        exception which is caught by the dispatch or web server, so any