← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/request.py

ivle.webapp.testing: Add, with fake request and user.
ivle.webapp.base.test: Add! Test the JSONRESTView, using the new mocks.

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
 
from ivle.webapp.base.plugins import CookiePlugin
 
39
import plugins.console # XXX: Relies on www/ being in the Python path.
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.
81
84
        styles (write)
82
85
            List of strings. Write a list of URLs to CSS files here, and they
83
86
            will be incorporated as <link rel="stylesheet" type="text/css">
96
99
            in the head, if write_html_head_foot is True.
97
100
            This is the propper way to specify functions that need to run at 
98
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.
99
114
    """
100
115
 
101
116
    # Special code for an OK response.
154
169
    HTTP_INSUFFICIENT_STORAGE         = 507
155
170
    HTTP_NOT_EXTENDED                 = 510
156
171
 
157
 
    def __init__(self, req):
 
172
    def __init__(self, req, write_html_head):
158
173
        """Builds an IVLE request object from a mod_python request object.
159
174
        This results in an object with all of the necessary methods and
160
175
        additional fields.
161
176
 
162
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
 
184
        self.func_write_html_head = write_html_head
167
185
        self.headers_written = False
168
186
 
169
187
        # Determine if the browser used the public host name to make the
193
211
        self.status = Request.HTTP_OK
194
212
        self.content_type = None        # Use Apache's default
195
213
        self.location = None
 
214
        self.title = None     # Will be set by dispatch before passing to app
196
215
        self.styles = []
197
216
        self.scripts = []
198
217
        self.scripts_init = []
 
218
        self.write_html_head_foot = False
199
219
        # In some cases we don't want the template JS (such as the username
200
220
        # and public FQDN) in the output HTML. In that case, set this to 0.
201
221
        self.write_javascript_settings = True
209
229
        """Writes out the HTTP and HTML headers before any real data is
210
230
        written."""
211
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)
212
243
 
213
244
        # Prepare the HTTP and HTML headers before the first write is made
214
245
        if self.content_type != None:
216
247
        self.apache_req.status = self.status
217
248
        if self.location != None:
218
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)
219
253
 
220
254
    def ensure_headers_written(self):
221
255
        """Writes out the HTTP and HTML headers if they haven't already been
241
275
    def logout(self):
242
276
        """Log out the current user by destroying the session state.
243
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
        
244
281
        if hasattr(self, 'session'):
245
282
            self.session.invalidate()
246
283
            self.session.delete()
247
284
            # Invalidates all IVLE cookies
248
285
            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='/'))
 
286
            for cookie in all_cookies:
 
287
                if cookie in ivle_cookies:
 
288
                    self.add_cookie(mod_python.Cookie.Cookie(cookie,'',expires=1,path='/'))
255
289
        self.throw_redirect(ivle.util.make_path('')) 
256
290
 
257
291
 
273
307
        else:
274
308
            return self.apache_req.read(len)
275
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
 
276
320
    def throw_redirect(self, location):
277
321
        """Writes out an HTTP redirect to the specified URL. Raises an
278
322
        exception which is caught by the dispatch or web server, so any
295
339
    def get_session(self):
296
340
        """Returns a mod_python Session object for this request.
297
341
        Note that this is dependent on mod_python and may need to change
298
 
        interface if porting away from mod_python.
299
 
 
300
 
        IMPORTANT: Call unlock() on the session as soon as you are done with
301
 
                   it! If you don't, all other requests will block!
302
 
        """
 
342
        interface if porting away from mod_python."""
303
343
        # Cache the session object and set the timeout to 24 hours.
304
344
        if not hasattr(self, 'session'):
305
345
            self.session = mod_python.Session.FileSession(self.apache_req,