← 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: stevenbird
  • Date: 2008-01-31 23:40:25 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:357
fixed syntax error

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,
187
180
        path = common.util.unmake_path(req.uri)
188
181
        if self.publicmode:
189
182
            self.app = None
190
 
            (_, self.path) = (common.util.split_path(path))
 
183
            self.path = path
191
184
        else:
192
185
            (self.app, self.path) = (common.util.split_path(path))
193
 
        self.user = None
 
186
        self.username = None
194
187
        self.hostname = req.hostname
195
188
        self.headers_in = req.headers_in
196
189
        self.headers_out = req.headers_out
202
195
        self.title = None     # Will be set by dispatch before passing to app
203
196
        self.styles = []
204
197
        self.scripts = []
205
 
        self.scripts_init = []
206
198
        self.write_html_head_foot = False
207
199
        self.got_common_vars = False
208
200
 
210
202
        """Writes out the HTTP and HTML headers before any real data is
211
203
        written."""
212
204
        self.headers_written = True
213
 
        
214
 
        # app is the App object for the chosen app
215
 
        try:
216
 
            app = conf.apps.app_url[self.app]
217
 
        except KeyError:
218
 
            app = None
219
 
 
220
 
        # Write any final modifications to header content
221
 
        if app and app.useconsole and self.user:
222
 
            plugins.console.insert_scripts_styles(self.scripts, self.styles, \
223
 
                self.scripts_init)
224
 
 
225
205
        # Prepare the HTTP and HTML headers before the first write is made
226
206
        if self.content_type != None:
227
207
            self.apache_req.content_type = self.content_type
244
224
 
245
225
        if not self.headers_written:
246
226
            self.__writeheaders()
247
 
        if isinstance(string, unicode):
248
 
            # Encode unicode strings as UTF-8
249
 
            # (Otherwise cannot handle being written to a bytestream)
250
 
            self.apache_req.write(string.encode('utf8'), flush)
251
 
        else:
252
 
            # 8-bit clean strings just get written directly.
253
 
            # This includes binary strings.
254
 
            self.apache_req.write(string, flush)
 
227
        self.apache_req.write(string, flush)
255
228
 
256
229
    def flush(self):
257
230
        """Flushes the output buffer."""
271
244
        else:
272
245
            return self.apache_req.read(len)
273
246
 
274
 
    def throw_error(self, httpcode, message=None):
 
247
    def throw_error(self, httpcode):
275
248
        """Writes out an HTTP error of the specified code. Raises an exception
276
249
        which is caught by the dispatch or web server, so any code following
277
250
        this call will not be executed.
279
252
        httpcode: An HTTP response status code. Pass a constant from the
280
253
        Request class.
281
254
        """
282
 
        raise common.util.IVLEError(httpcode, message)
 
255
        raise mod_python.apache.SERVER_RETURN, httpcode
283
256
 
284
257
    def throw_redirect(self, location):
285
258
        """Writes out an HTTP redirect to the specified URL. Raises an
291
264
        """
292
265
        mod_python.util.redirect(self.apache_req, location)
293
266
 
294
 
    def add_cookie(self, cookie, value=None, **attributes):
295
 
        """Inserts a cookie into this request object's headers."""
296
 
        if value is None:
297
 
            Cookie.add_cookie(self.apache_req, cookie)
298
 
        else:
299
 
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
300
 
 
301
267
    def get_session(self):
302
268
        """Returns a mod_python Session object for this request.
303
269
        Note that this is dependent on mod_python and may need to change
304
270
        interface if porting away from mod_python."""
305
 
        # Cache the session object and set the timeout to 24 hours.
 
271
        # Cache the session object
306
272
        if not hasattr(self, 'session'):
307
 
            self.session = Session.FileSession(self.apache_req,
308
 
                                               timeout = 60 * 60 * 24)
 
273
            self.session = Session.Session(self.apache_req)
309
274
        return self.session
310
275
 
311
276
    def get_fieldstorage(self):
325
290
            self.apache_req.add_common_vars()
326
291
            self.got_common_vars = True
327
292
        return self.apache_req.subprocess_env
328
 
 
329
 
    @staticmethod
330
 
    def get_http_codename(code):
331
 
        """Given a HTTP error code int, returns a (name, description)
332
 
        pair, suitable for displaying to the user.
333
 
        May return (None,None) if code is unknown.
334
 
        Only lists common 4xx and 5xx codes (since this is just used
335
 
        to display throw_error error messages).
336
 
        """
337
 
        try:
338
 
            return http_codenames[code]
339
 
        except KeyError:
340
 
            return None, None
341
 
 
342
 
# Human strings for HTTP response codes
343
 
http_codenames = {
344
 
    Request.HTTP_BAD_REQUEST:
345
 
        ("Bad Request",
346
 
        "Your browser sent a request IVLE did not understand."),
347
 
    Request.HTTP_UNAUTHORIZED:
348
 
        ("Unauthorized",
349
 
        "You are not allowed to view this part of IVLE."),
350
 
    Request.HTTP_FORBIDDEN:
351
 
        ("Forbidden",
352
 
        "You are not allowed to view this part of IVLE."),
353
 
    Request.HTTP_NOT_FOUND:
354
 
        ("Not Found",
355
 
        "The application or file you requested does not exist."),
356
 
    Request.HTTP_METHOD_NOT_ALLOWED:
357
 
        ("Method Not Allowed",
358
 
        "Your browser is interacting with IVLE in the wrong way."
359
 
        "This is probably a bug in IVLE. "
360
 
        "Please report it to the administrators."),
361
 
    Request.HTTP_INTERNAL_SERVER_ERROR:
362
 
        ("Internal Server Error",
363
 
        "An unknown error occured in IVLE."),
364
 
    Request.HTTP_NOT_IMPLEMENTED:
365
 
        ("Not Implemented",
366
 
        "The application or file you requested has not been implemented "
367
 
        "in IVLE."),
368
 
    Request.HTTP_SERVICE_UNAVAILABLE:
369
 
        ("Service Unavailable",
370
 
        "IVLE is currently experiencing technical difficulties. "
371
 
        "Please try again later."),
372
 
}