← Back to branch summary

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

« back to all changes in this revision

Viewing changes to www/dispatch/request.py

  • Committer: mattgiuca
  • Date: 2008-01-25 06:20:32 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:313
test/test_framework: Updated examples, a bit of better descriptions, sample
    partial solutions, etc.

Added all sample subject material.
This has been copied from test/test_framework and modified slightly.
There is now a subject "sample" with 2 worksheets. The 1st worksheet has 3
exercises. These work in IVLE by default.

setup.py: Added code to install subjects into the designated directory. This
means that installing IVLE will result in the sample subjects being
immediately available.

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/dispatch/request.py
25
25
 
26
26
import common.util
27
27
import mod_python
28
 
from mod_python import (util, Session, Cookie)
 
28
from mod_python import (util, Session)
29
29
import conf
30
 
import plugins.console
31
30
 
32
31
class Request:
33
32
    """An IVLE request object. This is presented to the IVLE apps as a way of
44
43
            String. The path specified in the URL *not including* the
45
44
            application or the IVLE location prefix. eg. a URL of
46
45
            "/ivle/files/joe/myfiles" has a path of "joe/myfiles".
47
 
        user (read)
48
 
            User object. Details of the user who is currently logged in, or
 
46
        username (read)
 
47
            String. Login name of the user who is currently logged in, or
49
48
            None.
50
49
        hostname (read)
51
50
            String. Hostname the server is running on.
81
80
            in the head, if write_html_head_foot is True.
82
81
            URLs should be relative to the IVLE root; they will be fixed up
83
82
            to be site-relative.
84
 
        scripts_init (write)
85
 
            List of strings. Write a list of JS function names, and they
86
 
            will be added as window.addListener('load', ..., false); calls
87
 
            in the head, if write_html_head_foot is True.
88
 
            This is the propper way to specify functions that need to run at 
89
 
            page load time.
90
83
        write_html_head_foot (write)
91
84
            Boolean. If True, dispatch assumes that this is an XHTML page, and
92
85
            will immediately write a full HTML head, open the body element,
185
178
        # Split the given path into the app (top-level dir) and sub-path
186
179
        # (after first stripping away the root directory)
187
180
        path = common.util.unmake_path(req.uri)
188
 
        (self.app, self.path) = (common.util.split_path(path))
189
 
        self.user = None
 
181
        if self.publicmode:
 
182
            self.app = None
 
183
            self.path = path
 
184
        else:
 
185
            (self.app, self.path) = (common.util.split_path(path))
 
186
        self.username = None
190
187
        self.hostname = req.hostname
191
188
        self.headers_in = req.headers_in
192
189
        self.headers_out = req.headers_out
198
195
        self.title = None     # Will be set by dispatch before passing to app
199
196
        self.styles = []
200
197
        self.scripts = []
201
 
        self.scripts_init = []
202
198
        self.write_html_head_foot = False
203
 
        # In some cases we don't want the template JS (such as the username
204
 
        # and public FQDN) in the output HTML. In that case, set this to 0.
205
 
        self.write_javascript_settings = True
206
199
        self.got_common_vars = False
207
200
 
208
201
    def __writeheaders(self):
209
202
        """Writes out the HTTP and HTML headers before any real data is
210
203
        written."""
211
204
        self.headers_written = True
212
 
        
213
 
        # app is the App object for the chosen app
214
 
        try:
215
 
            app = conf.apps.app_url[self.app]
216
 
        except KeyError:
217
 
            app = None
218
 
 
219
 
        # Write any final modifications to header content
220
 
        if app and app.useconsole and self.user:
221
 
            plugins.console.insert_scripts_styles(self.scripts, self.styles, \
222
 
                self.scripts_init)
223
 
 
224
205
        # Prepare the HTTP and HTML headers before the first write is made
225
206
        if self.content_type != None:
226
207
            self.apache_req.content_type = self.content_type
243
224
 
244
225
        if not self.headers_written:
245
226
            self.__writeheaders()
246
 
        if isinstance(string, unicode):
247
 
            # Encode unicode strings as UTF-8
248
 
            # (Otherwise cannot handle being written to a bytestream)
249
 
            self.apache_req.write(string.encode('utf8'), flush)
250
 
        else:
251
 
            # 8-bit clean strings just get written directly.
252
 
            # This includes binary strings.
253
 
            self.apache_req.write(string, flush)
 
227
        self.apache_req.write(string, flush)
254
228
 
255
229
    def flush(self):
256
230
        """Flushes the output buffer."""
270
244
        else:
271
245
            return self.apache_req.read(len)
272
246
 
273
 
    def throw_error(self, httpcode, message=None):
 
247
    def throw_error(self, httpcode):
274
248
        """Writes out an HTTP error of the specified code. Raises an exception
275
249
        which is caught by the dispatch or web server, so any code following
276
250
        this call will not be executed.
278
252
        httpcode: An HTTP response status code. Pass a constant from the
279
253
        Request class.
280
254
        """
281
 
        raise common.util.IVLEError(httpcode, message)
 
255
        raise mod_python.apache.SERVER_RETURN, httpcode
282
256
 
283
257
    def throw_redirect(self, location):
284
258
        """Writes out an HTTP redirect to the specified URL. Raises an
290
264
        """
291
265
        mod_python.util.redirect(self.apache_req, location)
292
266
 
293
 
    def add_cookie(self, cookie, value=None, **attributes):
294
 
        """Inserts a cookie into this request object's headers."""
295
 
        if value is None:
296
 
            Cookie.add_cookie(self.apache_req, cookie)
297
 
        else:
298
 
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
299
 
 
300
267
    def get_session(self):
301
268
        """Returns a mod_python Session object for this request.
302
269
        Note that this is dependent on mod_python and may need to change
303
270
        interface if porting away from mod_python."""
304
 
        # Cache the session object and set the timeout to 24 hours.
 
271
        # Cache the session object
305
272
        if not hasattr(self, 'session'):
306
 
            self.session = Session.FileSession(self.apache_req,
307
 
                                               timeout = 60 * 60 * 24)
 
273
            self.session = Session.Session(self.apache_req)
308
274
        return self.session
309
275
 
310
276
    def get_fieldstorage(self):
324
290
            self.apache_req.add_common_vars()
325
291
            self.got_common_vars = True
326
292
        return self.apache_req.subprocess_env
327
 
 
328
 
    @staticmethod
329
 
    def get_http_codename(code):
330
 
        """Given a HTTP error code int, returns a (name, description)
331
 
        pair, suitable for displaying to the user.
332
 
        May return (None,None) if code is unknown.
333
 
        Only lists common 4xx and 5xx codes (since this is just used
334
 
        to display throw_error error messages).
335
 
        """
336
 
        try:
337
 
            return http_codenames[code]
338
 
        except KeyError:
339
 
            return None, None
340
 
 
341
 
# Human strings for HTTP response codes
342
 
http_codenames = {
343
 
    Request.HTTP_BAD_REQUEST:
344
 
        ("Bad Request",
345
 
        "Your browser sent a request IVLE did not understand."),
346
 
    Request.HTTP_UNAUTHORIZED:
347
 
        ("Unauthorized",
348
 
        "You are not allowed to view this part of IVLE."),
349
 
    Request.HTTP_FORBIDDEN:
350
 
        ("Forbidden",
351
 
        "You are not allowed to view this part of IVLE."),
352
 
    Request.HTTP_NOT_FOUND:
353
 
        ("Not Found",
354
 
        "The application or file you requested does not exist."),
355
 
    Request.HTTP_METHOD_NOT_ALLOWED:
356
 
        ("Method Not Allowed",
357
 
        "Your browser is interacting with IVLE in the wrong way."
358
 
        "This is probably a bug in IVLE. "
359
 
        "Please report it to the administrators."),
360
 
    Request.HTTP_INTERNAL_SERVER_ERROR:
361
 
        ("Internal Server Error",
362
 
        "An unknown error occured in IVLE."),
363
 
    Request.HTTP_NOT_IMPLEMENTED:
364
 
        ("Not Implemented",
365
 
        "The application or file you requested has not been implemented "
366
 
        "in IVLE."),
367
 
    Request.HTTP_SERVICE_UNAVAILABLE:
368
 
        ("Service Unavailable",
369
 
        "IVLE is currently experiencing technical difficulties. "
370
 
        "Please try again later."),
371
 
}