← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/request.py

Allow fileservice actions to return custom JSON.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
29
29
    import mod_python.Session
30
30
    import mod_python.Cookie
31
31
    import mod_python.util
32
 
    import mod_python.apache
33
 
 
34
 
    class PotentiallySecureFileSession(mod_python.Session.FileSession):
35
 
        """A mod_python FileSession that sets secure cookie when appropriate.
36
 
 
37
 
        A secure cookie will be set if the request itself is over HTTPS, or if
38
 
        a proxy in front has set X-Forwarded-Proto: https. Otherwise the cookie
39
 
        will be insecure.
40
 
        """
41
 
        def make_cookie(self):
42
 
            cookie = super(PotentiallySecureFileSession, self).make_cookie()
43
 
            if (self._req.is_https() or
44
 
                self._req.headers_in.get('X-Forwarded-Proto') == 'https'):
45
 
                cookie.secure = True
46
 
            return cookie
47
32
except ImportError:
48
33
    # This needs to be importable from outside Apache.
49
34
    pass
50
35
 
51
 
import os.path
52
 
 
53
36
import ivle.util
 
37
import ivle.conf
54
38
import ivle.database
55
39
from ivle.webapp.base.plugins import CookiePlugin
56
 
import ivle.webapp.security
57
 
 
58
40
 
59
41
class Request:
60
42
    """An IVLE request object. This is presented to the IVLE apps as a way of
65
47
            String. The request method (eg. 'GET', 'POST', etc)
66
48
        uri (read)
67
49
            String. The path portion of the URI.
68
 
        unparsed_uri (read)
69
 
            String. The path portion of the URI, unparsed with query string.
70
50
        app (read)
71
51
            String. Name of the application specified in the URL, or None.
72
52
        path (read)
98
78
        location (write)
99
79
            String. Response "Location" header value. Used with HTTP redirect
100
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.
101
99
    """
102
100
 
103
101
    # Special code for an OK response.
107
105
 
108
106
    # HTTP status codes
109
107
 
 
108
    HTTP_CONTINUE                     = 100
 
109
    HTTP_SWITCHING_PROTOCOLS          = 101
 
110
    HTTP_PROCESSING                   = 102
110
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
111
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
112
129
    HTTP_FORBIDDEN                    = 403
113
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
114
147
    HTTP_INTERNAL_SERVER_ERROR        = 500
115
 
 
116
 
    _store = None
117
 
 
118
 
    def __init__(self, req, config):
119
 
        """Create an IVLE request from a mod_python one.
120
 
 
121
 
        @param req: A mod_python request.
122
 
        @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.
123
163
        """
124
164
 
125
165
        # Methods are mostly wrappers around the Apache request object
126
166
        self.apache_req = req
127
 
        self.config = config
128
167
        self.headers_written = False
129
168
 
130
169
        # Determine if the browser used the public host name to make the
131
170
        # request (in which case we are in "public mode")
132
 
        if req.hostname == config['urls']['public_host']:
 
171
        if req.hostname == ivle.conf.public_host:
133
172
            self.publicmode = True
134
173
        else:
135
174
            self.publicmode = False
137
176
        # Inherit values for the input members
138
177
        self.method = req.method
139
178
        self.uri = req.uri
140
 
        self.unparsed_uri = req.unparsed_uri
141
179
        # Split the given path into the app (top-level dir) and sub-path
142
180
        # (after first stripping away the root directory)
143
 
        (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))
 
183
        self.user = None
144
184
        self.hostname = req.hostname
145
185
        self.headers_in = req.headers_in
146
186
        self.headers_out = req.headers_out
147
187
 
 
188
        # Open a database connection and transaction, keep it around for users
 
189
        # of the Request object to use
 
190
        self.store = ivle.database.get_store()
 
191
 
148
192
        # Default values for the output members
149
193
        self.status = Request.HTTP_OK
150
194
        self.content_type = None        # Use Apache's default
151
195
        self.location = None
 
196
        self.styles = []
 
197
        self.scripts = []
 
198
        self.scripts_init = []
152
199
        # In some cases we don't want the template JS (such as the username
153
200
        # and public FQDN) in the output HTML. In that case, set this to 0.
154
201
        self.write_javascript_settings = True
155
202
        self.got_common_vars = False
156
203
 
157
204
    def __del__(self):
158
 
        self.cleanup()
159
 
 
160
 
    def cleanup(self):
161
 
        """Cleanup."""
162
 
        if self._store is not None:
163
 
            self._store.close()
164
 
            self._store = None
165
 
 
166
 
    def commit(self):
167
 
        """Cleanup."""
168
 
        if self._store is not None:
169
 
            self._store.commit()
 
205
        """Cleanup."""
 
206
        self.store.close()
170
207
 
171
208
    def __writeheaders(self):
172
209
        """Writes out the HTTP and HTML headers before any real data is
215
252
                for cookie in plugin.cookies:
216
253
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
217
254
                                                    expires=1, path='/'))
218
 
        self.throw_redirect(self.make_path(''))
 
255
        self.throw_redirect(ivle.util.make_path('')) 
219
256
 
220
257
 
221
258
    def flush(self):
255
292
        else:
256
293
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
257
294
 
258
 
    def make_path(self, path):
259
 
        """Prepend the IVLE URL prefix to the given path.
260
 
 
261
 
        This is used when generating URLs to send to the client.
262
 
 
263
 
        This method is DEPRECATED. We no longer support use of a prefix.
264
 
        """
265
 
        return os.path.join(self.config['urls']['root'], path)
266
 
 
267
295
    def get_session(self):
268
296
        """Returns a mod_python Session object for this request.
269
297
        Note that this is dependent on mod_python and may need to change
274
302
        """
275
303
        # Cache the session object and set the timeout to 24 hours.
276
304
        if not hasattr(self, 'session'):
277
 
            self.session = PotentiallySecureFileSession(
278
 
                self.apache_req, timeout = 60 * 60 * 24)
 
305
            self.session = mod_python.Session.FileSession(self.apache_req,
 
306
                                               timeout = 60 * 60 * 24)
279
307
        return self.session
280
308
 
281
309
    def get_fieldstorage(self):
296
324
            self.got_common_vars = True
297
325
        return self.apache_req.subprocess_env
298
326
 
299
 
    @property
300
 
    def store(self):
301
 
        # Open a database connection and transaction, keep it around for users
302
 
        # of the Request object to use.
303
 
        if self._store is None:
304
 
            self._store = ivle.database.get_store(self.config)
305
 
        return self._store
306
 
 
307
 
    @property
308
 
    def user(self):
309
 
        # Get and cache the request user, or None if it's not valid.
310
 
        # This is a property so that we don't create a store unless
311
 
        # some code actually requests the user.
 
327
    @staticmethod
 
328
    def get_http_codename(code):
 
329
        """Given a HTTP error code int, returns a (name, description)
 
330
        pair, suitable for displaying to the user.
 
331
        May return (None,None) if code is unknown.
 
332
        Only lists common 4xx and 5xx codes (since this is just used
 
333
        to display throw_error error messages).
 
334
        """
312
335
        try:
313
 
            return self._user
314
 
        except AttributeError:
315
 
            if self.publicmode:
316
 
                self._user = None
317
 
            else:
318
 
                temp_user = ivle.webapp.security.get_user_details(self)
319
 
                if temp_user and temp_user.valid:
320
 
                    self._user = temp_user
321
 
                else:
322
 
                    self._user = None
323
 
            return self._user
 
336
            return http_codenames[code]
 
337
        except KeyError:
 
338
            return None, None
324
339
 
 
340
# Human strings for HTTP response codes
 
341
http_codenames = {
 
342
    Request.HTTP_BAD_REQUEST:
 
343
        ("Bad Request",
 
344
        "Your browser sent a request IVLE did not understand."),
 
345
    Request.HTTP_UNAUTHORIZED:
 
346
        ("Unauthorized",
 
347
        "You are not allowed to view this part of IVLE."),
 
348
    Request.HTTP_FORBIDDEN:
 
349
        ("Forbidden",
 
350
        "You are not allowed to view this part of IVLE."),
 
351
    Request.HTTP_NOT_FOUND:
 
352
        ("Not Found",
 
353
        "The application or file you requested does not exist."),
 
354
    Request.HTTP_METHOD_NOT_ALLOWED:
 
355
        ("Method Not Allowed",
 
356
        "Your browser is interacting with IVLE in the wrong way."
 
357
        "This is probably a bug in IVLE. "
 
358
        "Please report it to the administrators."),
 
359
    Request.HTTP_INTERNAL_SERVER_ERROR:
 
360
        ("Internal Server Error",
 
361
        "An unknown error occured in IVLE."),
 
362
    Request.HTTP_NOT_IMPLEMENTED:
 
363
        ("Not Implemented",
 
364
        "The application or file you requested has not been implemented "
 
365
        "in IVLE."),
 
366
    Request.HTTP_SERVICE_UNAVAILABLE:
 
367
        ("Service Unavailable",
 
368
        "IVLE is currently experiencing technical difficulties. "
 
369
        "Please try again later."),
 
370
}