← 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-25 07:54:59 UTC
  • mto: This revision was merged to the branch mainline in revision 1731.
  • Revision ID: matt.giuca@gmail.com-20100225075459-ofwtu37q7d8rbmc8
Fully link the Project Delete view, from all the places the Project Edit view is linked.

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
 
36
38
import ivle.util
37
 
import ivle.conf
38
39
import ivle.database
39
40
from ivle.webapp.base.plugins import CookiePlugin
 
41
import ivle.webapp.security
40
42
 
41
43
class Request:
42
44
    """An IVLE request object. This is presented to the IVLE apps as a way of
78
80
        location (write)
79
81
            String. Response "Location" header value. Used with HTTP redirect
80
82
            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.
99
83
    """
100
84
 
101
85
    # Special code for an OK response.
105
89
 
106
90
    # HTTP status codes
107
91
 
108
 
    HTTP_CONTINUE                     = 100
109
 
    HTTP_SWITCHING_PROTOCOLS          = 101
110
 
    HTTP_PROCESSING                   = 102
111
92
    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
121
93
    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
129
94
    HTTP_FORBIDDEN                    = 403
130
95
    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
147
96
    HTTP_INTERNAL_SERVER_ERROR        = 500
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.
 
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.
163
105
        """
164
106
 
165
107
        # Methods are mostly wrappers around the Apache request object
166
108
        self.apache_req = req
 
109
        self.config = config
167
110
        self.headers_written = False
168
111
 
169
112
        # Determine if the browser used the public host name to make the
170
113
        # request (in which case we are in "public mode")
171
 
        if req.hostname == ivle.conf.public_host:
 
114
        if req.hostname == config['urls']['public_host']:
172
115
            self.publicmode = True
173
116
        else:
174
117
            self.publicmode = False
178
121
        self.uri = req.uri
179
122
        # Split the given path into the app (top-level dir) and sub-path
180
123
        # (after first stripping away the root directory)
181
 
        path = ivle.util.unmake_path(req.uri)
182
 
        (self.app, self.path) = (ivle.util.split_path(path))
183
 
        self.user = None
 
124
        (self.app, self.path) = (ivle.util.split_path(req.uri))
184
125
        self.hostname = req.hostname
185
126
        self.headers_in = req.headers_in
186
127
        self.headers_out = req.headers_out
187
128
 
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
 
 
192
129
        # Default values for the output members
193
130
        self.status = Request.HTTP_OK
194
131
        self.content_type = None        # Use Apache's default
195
132
        self.location = None
196
 
        self.styles = []
197
 
        self.scripts = []
198
 
        self.scripts_init = []
199
133
        # In some cases we don't want the template JS (such as the username
200
134
        # and public FQDN) in the output HTML. In that case, set this to 0.
201
135
        self.write_javascript_settings = True
202
136
        self.got_common_vars = False
203
137
 
204
138
    def __del__(self):
205
 
        """Cleanup."""
206
 
        self.store.close()
 
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()
207
151
 
208
152
    def __writeheaders(self):
209
153
        """Writes out the HTTP and HTML headers before any real data is
252
196
                for cookie in plugin.cookies:
253
197
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
254
198
                                                    expires=1, path='/'))
255
 
        self.throw_redirect(ivle.util.make_path('')) 
 
199
        self.throw_redirect(self.make_path(''))
256
200
 
257
201
 
258
202
    def flush(self):
292
236
        else:
293
237
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
294
238
 
 
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
 
295
248
    def get_session(self):
296
249
        """Returns a mod_python Session object for this request.
297
250
        Note that this is dependent on mod_python and may need to change
324
277
            self.got_common_vars = True
325
278
        return self.apache_req.subprocess_env
326
279
 
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
 
        """
 
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.
335
293
        try:
336
 
            return http_codenames[code]
337
 
        except KeyError:
338
 
            return None, None
 
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
339
305
 
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
 
}