← 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: Matt Giuca
  • Date: 2010-02-12 05:22:13 UTC
  • Revision ID: matt.giuca@gmail.com-20100212052213-vq4x06ia07xk9d81
docs: Added new manual page, User roles, detailing the exact capabilities of each role.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
79
79
        location (write)
80
80
            String. Response "Location" header value. Used with HTTP redirect
81
81
            responses.
82
 
        styles (write)
83
 
            List of strings. Write a list of URLs to CSS files here, and they
84
 
            will be incorporated as <link rel="stylesheet" type="text/css">
85
 
            elements in the head, if write_html_head_foot is True.
86
 
            URLs should be relative to the IVLE root; they will be fixed up
87
 
            to be site-relative.
88
 
        scripts (write)
89
 
            List of strings. Write a list of URLs to JS files here, and they
90
 
            will be incorporated as <script type="text/javascript"> elements
91
 
            in the head, if write_html_head_foot is True.
92
 
            URLs should be relative to the IVLE root; they will be fixed up
93
 
            to be site-relative.
94
 
        scripts_init (write)
95
 
            List of strings. Write a list of JS function names, and they
96
 
            will be added as window.addListener('load', ..., false); calls
97
 
            in the head, if write_html_head_foot is True.
98
 
            This is the propper way to specify functions that need to run at 
99
 
            page load time.
100
82
    """
101
83
 
102
84
    # Special code for an OK response.
106
88
 
107
89
    # HTTP status codes
108
90
 
109
 
    HTTP_CONTINUE                     = 100
110
 
    HTTP_SWITCHING_PROTOCOLS          = 101
111
 
    HTTP_PROCESSING                   = 102
112
91
    HTTP_OK                           = 200
113
 
    HTTP_CREATED                      = 201
114
 
    HTTP_ACCEPTED                     = 202
115
 
    HTTP_NON_AUTHORITATIVE            = 203
116
 
    HTTP_NO_CONTENT                   = 204
117
 
    HTTP_RESET_CONTENT                = 205
118
 
    HTTP_PARTIAL_CONTENT              = 206
119
 
    HTTP_MULTI_STATUS                 = 207
120
 
    HTTP_MULTIPLE_CHOICES             = 300
121
 
    HTTP_MOVED_PERMANENTLY            = 301
122
92
    HTTP_MOVED_TEMPORARILY            = 302
123
 
    HTTP_SEE_OTHER                    = 303
124
 
    HTTP_NOT_MODIFIED                 = 304
125
 
    HTTP_USE_PROXY                    = 305
126
 
    HTTP_TEMPORARY_REDIRECT           = 307
127
 
    HTTP_BAD_REQUEST                  = 400
128
 
    HTTP_UNAUTHORIZED                 = 401
129
 
    HTTP_PAYMENT_REQUIRED             = 402
130
93
    HTTP_FORBIDDEN                    = 403
131
94
    HTTP_NOT_FOUND                    = 404
132
 
    HTTP_METHOD_NOT_ALLOWED           = 405
133
 
    HTTP_NOT_ACCEPTABLE               = 406
134
 
    HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
135
 
    HTTP_REQUEST_TIME_OUT             = 408
136
 
    HTTP_CONFLICT                     = 409
137
 
    HTTP_GONE                         = 410
138
 
    HTTP_LENGTH_REQUIRED              = 411
139
 
    HTTP_PRECONDITION_FAILED          = 412
140
 
    HTTP_REQUEST_ENTITY_TOO_LARGE     = 413
141
 
    HTTP_REQUEST_URI_TOO_LARGE        = 414
142
 
    HTTP_UNSUPPORTED_MEDIA_TYPE       = 415
143
 
    HTTP_RANGE_NOT_SATISFIABLE        = 416
144
 
    HTTP_EXPECTATION_FAILED           = 417
145
 
    HTTP_UNPROCESSABLE_ENTITY         = 422
146
 
    HTTP_LOCKED                       = 423
147
 
    HTTP_FAILED_DEPENDENCY            = 424
148
95
    HTTP_INTERNAL_SERVER_ERROR        = 500
149
 
    HTTP_NOT_IMPLEMENTED              = 501
150
 
    HTTP_BAD_GATEWAY                  = 502
151
 
    HTTP_SERVICE_UNAVAILABLE          = 503
152
 
    HTTP_GATEWAY_TIME_OUT             = 504
153
 
    HTTP_VERSION_NOT_SUPPORTED        = 505
154
 
    HTTP_VARIANT_ALSO_VARIES          = 506
155
 
    HTTP_INSUFFICIENT_STORAGE         = 507
156
 
    HTTP_NOT_EXTENDED                 = 510
157
96
 
158
97
    def __init__(self, req, config):
159
98
        """Create an IVLE request from a mod_python one.
179
118
        self.uri = req.uri
180
119
        # Split the given path into the app (top-level dir) and sub-path
181
120
        # (after first stripping away the root directory)
182
 
        path = self.unmake_path(req.uri)
183
 
        (self.app, self.path) = (ivle.util.split_path(path))
 
121
        (self.app, self.path) = (ivle.util.split_path(req.uri))
184
122
        self.user = None
185
123
        self.hostname = req.hostname
186
124
        self.headers_in = req.headers_in
194
132
        self.status = Request.HTTP_OK
195
133
        self.content_type = None        # Use Apache's default
196
134
        self.location = None
197
 
        self.styles = []
198
 
        self.scripts = []
199
 
        self.scripts_init = []
200
135
        # In some cases we don't want the template JS (such as the username
201
136
        # and public FQDN) in the output HTML. In that case, set this to 0.
202
137
        self.write_javascript_settings = True
302
237
        """
303
238
        return os.path.join(self.config['urls']['root'], path)
304
239
 
305
 
    def unmake_path(self, path):
306
 
        """Strip the IVLE URL prefix from the given path, if present.
307
 
 
308
 
        Also normalises the path.
309
 
 
310
 
        This method is DEPRECATED. We no longer support use of a prefix.
311
 
        """
312
 
        path = os.path.normpath(path)
313
 
        root = os.path.normpath(self.config['urls']['root'])
314
 
 
315
 
        if path.startswith(root):
316
 
            path = path[len(root):]
317
 
            # Take out the slash as well
318
 
            if len(path) > 0 and path[0] == os.sep:
319
 
                path = path[1:]
320
 
 
321
 
        return path
322
 
 
323
240
    def get_session(self):
324
241
        """Returns a mod_python Session object for this request.
325
242
        Note that this is dependent on mod_python and may need to change
352
269
            self.got_common_vars = True
353
270
        return self.apache_req.subprocess_env
354
271
 
355
 
    @staticmethod
356
 
    def get_http_codename(code):
357
 
        """Given a HTTP error code int, returns a (name, description)
358
 
        pair, suitable for displaying to the user.
359
 
        May return (None,None) if code is unknown.
360
 
        Only lists common 4xx and 5xx codes (since this is just used
361
 
        to display throw_error error messages).
362
 
        """
363
 
        try:
364
 
            return http_codenames[code]
365
 
        except KeyError:
366
 
            return None, None
367
 
 
368
 
# Human strings for HTTP response codes
369
 
http_codenames = {
370
 
    Request.HTTP_BAD_REQUEST:
371
 
        ("Bad Request",
372
 
        "Your browser sent a request IVLE did not understand."),
373
 
    Request.HTTP_UNAUTHORIZED:
374
 
        ("Unauthorized",
375
 
        "You are not allowed to view this part of IVLE."),
376
 
    Request.HTTP_FORBIDDEN:
377
 
        ("Forbidden",
378
 
        "You are not allowed to view this part of IVLE."),
379
 
    Request.HTTP_NOT_FOUND:
380
 
        ("Not Found",
381
 
        "The application or file you requested does not exist."),
382
 
    Request.HTTP_METHOD_NOT_ALLOWED:
383
 
        ("Method Not Allowed",
384
 
        "Your browser is interacting with IVLE in the wrong way."
385
 
        "This is probably a bug in IVLE. "
386
 
        "Please report it to the administrators."),
387
 
    Request.HTTP_INTERNAL_SERVER_ERROR:
388
 
        ("Internal Server Error",
389
 
        "An unknown error occured in IVLE."),
390
 
    Request.HTTP_NOT_IMPLEMENTED:
391
 
        ("Not Implemented",
392
 
        "The application or file you requested has not been implemented "
393
 
        "in IVLE."),
394
 
    Request.HTTP_SERVICE_UNAVAILABLE:
395
 
        ("Service Unavailable",
396
 
        "IVLE is currently experiencing technical difficulties. "
397
 
        "Please try again later."),
398
 
}