← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/request.py

Move ivle.dispatch.login.get_user_details() to ivle.webapp.security.

That empties ivle.dispatch.login, so it dies.

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
 
import ivle.webapp.security
42
40
 
43
41
class Request:
44
42
    """An IVLE request object. This is presented to the IVLE apps as a way of
80
78
        location (write)
81
79
            String. Response "Location" header value. Used with HTTP redirect
82
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.
83
99
    """
84
100
 
85
101
    # Special code for an OK response.
89
105
 
90
106
    # HTTP status codes
91
107
 
 
108
    HTTP_CONTINUE                     = 100
 
109
    HTTP_SWITCHING_PROTOCOLS          = 101
 
110
    HTTP_PROCESSING                   = 102
92
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
93
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
94
129
    HTTP_FORBIDDEN                    = 403
95
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
96
147
    HTTP_INTERNAL_SERVER_ERROR        = 500
97
 
 
98
 
    _store = None
99
 
 
100
 
    def __init__(self, req, config):
101
 
        """Create an IVLE request from a mod_python one.
102
 
 
103
 
        @param req: A mod_python request.
104
 
        @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.
105
163
        """
106
164
 
107
165
        # Methods are mostly wrappers around the Apache request object
108
166
        self.apache_req = req
109
 
        self.config = config
110
167
        self.headers_written = False
111
168
 
112
169
        # Determine if the browser used the public host name to make the
113
170
        # request (in which case we are in "public mode")
114
 
        if req.hostname == config['urls']['public_host']:
 
171
        if req.hostname == ivle.conf.public_host:
115
172
            self.publicmode = True
116
173
        else:
117
174
            self.publicmode = False
121
178
        self.uri = req.uri
122
179
        # Split the given path into the app (top-level dir) and sub-path
123
180
        # (after first stripping away the root directory)
124
 
        (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
125
184
        self.hostname = req.hostname
126
185
        self.headers_in = req.headers_in
127
186
        self.headers_out = req.headers_out
128
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
 
129
192
        # Default values for the output members
130
193
        self.status = Request.HTTP_OK
131
194
        self.content_type = None        # Use Apache's default
132
195
        self.location = None
 
196
        self.title = None     # Will be set by dispatch before passing to app
 
197
        self.styles = []
 
198
        self.scripts = []
 
199
        self.scripts_init = []
133
200
        # In some cases we don't want the template JS (such as the username
134
201
        # and public FQDN) in the output HTML. In that case, set this to 0.
135
202
        self.write_javascript_settings = True
136
203
        self.got_common_vars = False
137
204
 
138
205
    def __del__(self):
139
 
        self.cleanup()
140
 
 
141
 
    def cleanup(self):
142
 
        """Cleanup."""
143
 
        if self._store is not None:
144
 
            self._store.close()
145
 
            self._store = None
146
 
 
147
 
    def commit(self):
148
 
        """Cleanup."""
149
 
        if self._store is not None:
150
 
            self._store.commit()
 
206
        """Cleanup."""
 
207
        self.store.close()
151
208
 
152
209
    def __writeheaders(self):
153
210
        """Writes out the HTTP and HTML headers before any real data is
196
253
                for cookie in plugin.cookies:
197
254
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
198
255
                                                    expires=1, path='/'))
199
 
        self.throw_redirect(self.make_path(''))
 
256
        self.throw_redirect(ivle.util.make_path('')) 
200
257
 
201
258
 
202
259
    def flush(self):
236
293
        else:
237
294
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
238
295
 
239
 
    def make_path(self, path):
240
 
        """Prepend the IVLE URL prefix to the given path.
241
 
 
242
 
        This is used when generating URLs to send to the client.
243
 
 
244
 
        This method is DEPRECATED. We no longer support use of a prefix.
245
 
        """
246
 
        return os.path.join(self.config['urls']['root'], path)
247
 
 
248
296
    def get_session(self):
249
297
        """Returns a mod_python Session object for this request.
250
298
        Note that this is dependent on mod_python and may need to change
251
 
        interface if porting away from mod_python.
252
 
 
253
 
        IMPORTANT: Call unlock() on the session as soon as you are done with
254
 
                   it! If you don't, all other requests will block!
255
 
        """
 
299
        interface if porting away from mod_python."""
256
300
        # Cache the session object and set the timeout to 24 hours.
257
301
        if not hasattr(self, 'session'):
258
302
            self.session = mod_python.Session.FileSession(self.apache_req,
277
321
            self.got_common_vars = True
278
322
        return self.apache_req.subprocess_env
279
323
 
280
 
    @property
281
 
    def store(self):
282
 
        # Open a database connection and transaction, keep it around for users
283
 
        # of the Request object to use.
284
 
        if self._store is None:
285
 
            self._store = ivle.database.get_store(self.config)
286
 
        return self._store
287
 
 
288
 
    @property
289
 
    def user(self):
290
 
        # Get and cache the request user, or None if it's not valid.
291
 
        # This is a property so that we don't create a store unless
292
 
        # some code actually requests the user.
 
324
    @staticmethod
 
325
    def get_http_codename(code):
 
326
        """Given a HTTP error code int, returns a (name, description)
 
327
        pair, suitable for displaying to the user.
 
328
        May return (None,None) if code is unknown.
 
329
        Only lists common 4xx and 5xx codes (since this is just used
 
330
        to display throw_error error messages).
 
331
        """
293
332
        try:
294
 
            return self._user
295
 
        except AttributeError:
296
 
            if self.publicmode:
297
 
                self._user = None
298
 
            else:
299
 
                temp_user = ivle.webapp.security.get_user_details(self)
300
 
                if temp_user and temp_user.valid:
301
 
                    self._user = temp_user
302
 
                else:
303
 
                    self._user = None
304
 
            return self._user
 
333
            return http_codenames[code]
 
334
        except KeyError:
 
335
            return None, None
305
336
 
 
337
# Human strings for HTTP response codes
 
338
http_codenames = {
 
339
    Request.HTTP_BAD_REQUEST:
 
340
        ("Bad Request",
 
341
        "Your browser sent a request IVLE did not understand."),
 
342
    Request.HTTP_UNAUTHORIZED:
 
343
        ("Unauthorized",
 
344
        "You are not allowed to view this part of IVLE."),
 
345
    Request.HTTP_FORBIDDEN:
 
346
        ("Forbidden",
 
347
        "You are not allowed to view this part of IVLE."),
 
348
    Request.HTTP_NOT_FOUND:
 
349
        ("Not Found",
 
350
        "The application or file you requested does not exist."),
 
351
    Request.HTTP_METHOD_NOT_ALLOWED:
 
352
        ("Method Not Allowed",
 
353
        "Your browser is interacting with IVLE in the wrong way."
 
354
        "This is probably a bug in IVLE. "
 
355
        "Please report it to the administrators."),
 
356
    Request.HTTP_INTERNAL_SERVER_ERROR:
 
357
        ("Internal Server Error",
 
358
        "An unknown error occured in IVLE."),
 
359
    Request.HTTP_NOT_IMPLEMENTED:
 
360
        ("Not Implemented",
 
361
        "The application or file you requested has not been implemented "
 
362
        "in IVLE."),
 
363
    Request.HTTP_SERVICE_UNAVAILABLE:
 
364
        ("Service Unavailable",
 
365
        "IVLE is currently experiencing technical difficulties. "
 
366
        "Please try again later."),
 
367
}