← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/request.py

  • Committer: William Grant
  • Date: 2009-02-25 23:04:11 UTC
  • Revision ID: grantw@unimelb.edu.au-20090225230411-lbdyl32ir0m3d59b
Make all of the services executable.

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
39
from ivle.webapp.base.plugins import CookiePlugin
41
40
 
79
78
        location (write)
80
79
            String. Response "Location" header value. Used with HTTP redirect
81
80
            responses.
 
81
        styles (write)
 
82
            List of strings. Write a list of URLs to CSS files here, and they
 
83
            will be incorporated as <link rel="stylesheet" type="text/css">
 
84
            elements in the head, if write_html_head_foot is True.
 
85
            URLs should be relative to the IVLE root; they will be fixed up
 
86
            to be site-relative.
 
87
        scripts (write)
 
88
            List of strings. Write a list of URLs to JS files here, and they
 
89
            will be incorporated as <script type="text/javascript"> elements
 
90
            in the head, if write_html_head_foot is True.
 
91
            URLs should be relative to the IVLE root; they will be fixed up
 
92
            to be site-relative.
 
93
        scripts_init (write)
 
94
            List of strings. Write a list of JS function names, and they
 
95
            will be added as window.addListener('load', ..., false); calls
 
96
            in the head, if write_html_head_foot is True.
 
97
            This is the propper way to specify functions that need to run at 
 
98
            page load time.
82
99
    """
83
100
 
84
101
    # Special code for an OK response.
88
105
 
89
106
    # HTTP status codes
90
107
 
 
108
    HTTP_CONTINUE                     = 100
 
109
    HTTP_SWITCHING_PROTOCOLS          = 101
 
110
    HTTP_PROCESSING                   = 102
91
111
    HTTP_OK                           = 200
 
112
    HTTP_CREATED                      = 201
 
113
    HTTP_ACCEPTED                     = 202
 
114
    HTTP_NON_AUTHORITATIVE            = 203
 
115
    HTTP_NO_CONTENT                   = 204
 
116
    HTTP_RESET_CONTENT                = 205
 
117
    HTTP_PARTIAL_CONTENT              = 206
 
118
    HTTP_MULTI_STATUS                 = 207
 
119
    HTTP_MULTIPLE_CHOICES             = 300
 
120
    HTTP_MOVED_PERMANENTLY            = 301
92
121
    HTTP_MOVED_TEMPORARILY            = 302
 
122
    HTTP_SEE_OTHER                    = 303
 
123
    HTTP_NOT_MODIFIED                 = 304
 
124
    HTTP_USE_PROXY                    = 305
 
125
    HTTP_TEMPORARY_REDIRECT           = 307
 
126
    HTTP_BAD_REQUEST                  = 400
 
127
    HTTP_UNAUTHORIZED                 = 401
 
128
    HTTP_PAYMENT_REQUIRED             = 402
93
129
    HTTP_FORBIDDEN                    = 403
94
130
    HTTP_NOT_FOUND                    = 404
 
131
    HTTP_METHOD_NOT_ALLOWED           = 405
 
132
    HTTP_NOT_ACCEPTABLE               = 406
 
133
    HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
 
134
    HTTP_REQUEST_TIME_OUT             = 408
 
135
    HTTP_CONFLICT                     = 409
 
136
    HTTP_GONE                         = 410
 
137
    HTTP_LENGTH_REQUIRED              = 411
 
138
    HTTP_PRECONDITION_FAILED          = 412
 
139
    HTTP_REQUEST_ENTITY_TOO_LARGE     = 413
 
140
    HTTP_REQUEST_URI_TOO_LARGE        = 414
 
141
    HTTP_UNSUPPORTED_MEDIA_TYPE       = 415
 
142
    HTTP_RANGE_NOT_SATISFIABLE        = 416
 
143
    HTTP_EXPECTATION_FAILED           = 417
 
144
    HTTP_UNPROCESSABLE_ENTITY         = 422
 
145
    HTTP_LOCKED                       = 423
 
146
    HTTP_FAILED_DEPENDENCY            = 424
95
147
    HTTP_INTERNAL_SERVER_ERROR        = 500
96
 
 
97
 
    def __init__(self, req, config):
98
 
        """Create an IVLE request from a mod_python one.
99
 
 
100
 
        @param req: A mod_python request.
101
 
        @param config: An IVLE configuration.
 
148
    HTTP_NOT_IMPLEMENTED              = 501
 
149
    HTTP_BAD_GATEWAY                  = 502
 
150
    HTTP_SERVICE_UNAVAILABLE          = 503
 
151
    HTTP_GATEWAY_TIME_OUT             = 504
 
152
    HTTP_VERSION_NOT_SUPPORTED        = 505
 
153
    HTTP_VARIANT_ALSO_VARIES          = 506
 
154
    HTTP_INSUFFICIENT_STORAGE         = 507
 
155
    HTTP_NOT_EXTENDED                 = 510
 
156
 
 
157
    def __init__(self, req):
 
158
        """Builds an IVLE request object from a mod_python request object.
 
159
        This results in an object with all of the necessary methods and
 
160
        additional fields.
 
161
 
 
162
        req: A mod_python request object.
102
163
        """
103
164
 
104
165
        # Methods are mostly wrappers around the Apache request object
105
166
        self.apache_req = req
106
 
        self.config = config
107
167
        self.headers_written = False
108
168
 
109
169
        # Determine if the browser used the public host name to make the
110
170
        # request (in which case we are in "public mode")
111
 
        if req.hostname == config['urls']['public_host']:
 
171
        if req.hostname == ivle.conf.public_host:
112
172
            self.publicmode = True
113
173
        else:
114
174
            self.publicmode = False
118
178
        self.uri = req.uri
119
179
        # Split the given path into the app (top-level dir) and sub-path
120
180
        # (after first stripping away the root directory)
121
 
        (self.app, self.path) = (ivle.util.split_path(req.uri))
 
181
        path = ivle.util.unmake_path(req.uri)
 
182
        (self.app, self.path) = (ivle.util.split_path(path))
122
183
        self.user = None
123
184
        self.hostname = req.hostname
124
185
        self.headers_in = req.headers_in
126
187
 
127
188
        # Open a database connection and transaction, keep it around for users
128
189
        # of the Request object to use
129
 
        self.store = ivle.database.get_store(config)
 
190
        self.store = ivle.database.get_store()
130
191
 
131
192
        # Default values for the output members
132
193
        self.status = Request.HTTP_OK
133
194
        self.content_type = None        # Use Apache's default
134
195
        self.location = None
 
196
        self.styles = []
 
197
        self.scripts = []
 
198
        self.scripts_init = []
135
199
        # In some cases we don't want the template JS (such as the username
136
200
        # and public FQDN) in the output HTML. In that case, set this to 0.
137
201
        self.write_javascript_settings = True
188
252
                for cookie in plugin.cookies:
189
253
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
190
254
                                                    expires=1, path='/'))
191
 
        self.throw_redirect(self.make_path(''))
 
255
        self.throw_redirect(ivle.util.make_path('')) 
192
256
 
193
257
 
194
258
    def flush(self):
228
292
        else:
229
293
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
230
294
 
231
 
    def make_path(self, path):
232
 
        """Prepend the IVLE URL prefix to the given path.
233
 
 
234
 
        This is used when generating URLs to send to the client.
235
 
 
236
 
        This method is DEPRECATED. We no longer support use of a prefix.
237
 
        """
238
 
        return os.path.join(self.config['urls']['root'], path)
239
 
 
240
295
    def get_session(self):
241
296
        """Returns a mod_python Session object for this request.
242
297
        Note that this is dependent on mod_python and may need to change
243
 
        interface if porting away from mod_python.
244
 
 
245
 
        IMPORTANT: Call unlock() on the session as soon as you are done with
246
 
                   it! If you don't, all other requests will block!
247
 
        """
 
298
        interface if porting away from mod_python."""
248
299
        # Cache the session object and set the timeout to 24 hours.
249
300
        if not hasattr(self, 'session'):
250
301
            self.session = mod_python.Session.FileSession(self.apache_req,
269
320
            self.got_common_vars = True
270
321
        return self.apache_req.subprocess_env
271
322
 
 
323
    @staticmethod
 
324
    def get_http_codename(code):
 
325
        """Given a HTTP error code int, returns a (name, description)
 
326
        pair, suitable for displaying to the user.
 
327
        May return (None,None) if code is unknown.
 
328
        Only lists common 4xx and 5xx codes (since this is just used
 
329
        to display throw_error error messages).
 
330
        """
 
331
        try:
 
332
            return http_codenames[code]
 
333
        except KeyError:
 
334
            return None, None
 
335
 
 
336
# Human strings for HTTP response codes
 
337
http_codenames = {
 
338
    Request.HTTP_BAD_REQUEST:
 
339
        ("Bad Request",
 
340
        "Your browser sent a request IVLE did not understand."),
 
341
    Request.HTTP_UNAUTHORIZED:
 
342
        ("Unauthorized",
 
343
        "You are not allowed to view this part of IVLE."),
 
344
    Request.HTTP_FORBIDDEN:
 
345
        ("Forbidden",
 
346
        "You are not allowed to view this part of IVLE."),
 
347
    Request.HTTP_NOT_FOUND:
 
348
        ("Not Found",
 
349
        "The application or file you requested does not exist."),
 
350
    Request.HTTP_METHOD_NOT_ALLOWED:
 
351
        ("Method Not Allowed",
 
352
        "Your browser is interacting with IVLE in the wrong way."
 
353
        "This is probably a bug in IVLE. "
 
354
        "Please report it to the administrators."),
 
355
    Request.HTTP_INTERNAL_SERVER_ERROR:
 
356
        ("Internal Server Error",
 
357
        "An unknown error occured in IVLE."),
 
358
    Request.HTTP_NOT_IMPLEMENTED:
 
359
        ("Not Implemented",
 
360
        "The application or file you requested has not been implemented "
 
361
        "in IVLE."),
 
362
    Request.HTTP_SERVICE_UNAVAILABLE:
 
363
        ("Service Unavailable",
 
364
        "IVLE is currently experiencing technical difficulties. "
 
365
        "Please try again later."),
 
366
}