44
42
String. The path specified in the URL *not including* the
45
43
application or the IVLE location prefix. eg. a URL of
46
44
"/ivle/files/joe/myfiles" has a path of "joe/myfiles".
48
User object. Details of the user who is currently logged in, or
46
String. Login name of the user who is currently logged in, or
51
String. Hostname the server is running on.
53
Table object representing headers sent by the client.
54
headers_out (read, can be written to)
55
Table object representing headers to be sent to the client.
57
Bool. True if the request came for the "public host" as
58
configured in conf.py. Note that public mode requests do not
59
have an app (app is set to None).
62
50
Int. Response status number. Use one of the status codes defined
70
58
String. HTML page title. Used if write_html_head_foot is True, in
71
59
the HTML title element text.
73
List of strings. Write a list of URLs to CSS files here, and they
74
will be incorporated as <link rel="stylesheet" type="text/css">
75
elements in the head, if write_html_head_foot is True.
76
URLs should be relative to the IVLE root; they will be fixed up
79
List of strings. Write a list of URLs to JS files here, and they
80
will be incorporated as <script type="text/javascript"> elements
81
in the head, if write_html_head_foot is True.
82
URLs should be relative to the IVLE root; they will be fixed up
85
List of strings. Write a list of JS function names, and they
86
will be added as window.addListener('load', ..., false); calls
87
in the head, if write_html_head_foot is True.
88
This is the propper way to specify functions that need to run at
90
60
write_html_head_foot (write)
91
61
Boolean. If True, dispatch assumes that this is an XHTML page, and
92
62
will immediately write a full HTML head, open the body element,
172
142
self.func_write_html_head = write_html_head
173
143
self.headers_written = False
175
# Determine if the browser used the public host name to make the
176
# request (in which case we are in "public mode")
177
if req.hostname == conf.public_host:
178
self.publicmode = True
180
self.publicmode = False
182
145
# Inherit values for the input members
183
146
self.method = req.method
184
147
self.uri = req.uri
185
148
# Split the given path into the app (top-level dir) and sub-path
186
149
# (after first stripping away the root directory)
187
path = common.util.unmake_path(req.uri)
190
(_, self.path) = (common.util.split_path(path))
192
(self.app, self.path) = (common.util.split_path(path))
194
self.hostname = req.hostname
195
self.headers_in = req.headers_in
196
self.headers_out = req.headers_out
150
(self.app, self.path) = (
151
common.util.split_path(common.util.unmake_path(req.uri)))
198
154
# Default values for the output members
199
self.status = Request.HTTP_OK
155
self.status = Request.OK
200
156
self.content_type = None # Use Apache's default
201
157
self.location = None
202
158
self.title = None # Will be set by dispatch before passing to app
205
self.scripts_init = []
206
159
self.write_html_head_foot = False
207
self.got_common_vars = False
209
161
def __writeheaders(self):
210
162
"""Writes out the HTTP and HTML headers before any real data is
212
164
self.headers_written = True
214
# app is the App object for the chosen app
216
app = conf.apps.app_url[self.app]
220
# Write any final modifications to header content
221
if app and app.useconsole and self.user:
222
plugins.console.insert_scripts_styles(self.scripts, self.styles, \
225
165
# Prepare the HTTP and HTML headers before the first write is made
226
166
if self.content_type != None:
227
167
self.apache_req.content_type = self.content_type
245
185
if not self.headers_written:
246
186
self.__writeheaders()
247
if isinstance(string, unicode):
248
# Encode unicode strings as UTF-8
249
# (Otherwise cannot handle being written to a bytestream)
250
self.apache_req.write(string.encode('utf8'), flush)
252
# 8-bit clean strings just get written directly.
253
# This includes binary strings.
254
self.apache_req.write(string, flush)
187
self.apache_req.write(string, flush)
257
190
"""Flushes the output buffer."""
267
200
"""Reads at most len bytes directly from the client. (See mod_python
268
201
Request.read)."""
270
return self.apache_req.read()
203
self.apache_req.read()
272
return self.apache_req.read(len)
205
self.apache_req.read(len)
274
def throw_error(self, httpcode, message=None):
207
def throw_error(self, httpcode):
275
208
"""Writes out an HTTP error of the specified code. Raises an exception
276
209
which is caught by the dispatch or web server, so any code following
277
210
this call will not be executed.
279
212
httpcode: An HTTP response status code. Pass a constant from the
282
raise common.util.IVLEError(httpcode, message)
215
raise mod_python.apache.SERVER_RETURN, httpcode
284
217
def throw_redirect(self, location):
285
218
"""Writes out an HTTP redirect to the specified URL. Raises an
292
225
mod_python.util.redirect(self.apache_req, location)
294
def add_cookie(self, cookie, value=None, **attributes):
295
"""Inserts a cookie into this request object's headers."""
297
Cookie.add_cookie(self.apache_req, cookie)
299
Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
301
227
def get_session(self):
302
228
"""Returns a mod_python Session object for this request.
303
229
Note that this is dependent on mod_python and may need to change
304
230
interface if porting away from mod_python."""
305
# Cache the session object and set the timeout to 24 hours.
231
# Cache the session object
306
232
if not hasattr(self, 'session'):
307
self.session = Session.FileSession(self.apache_req,
308
timeout = 60 * 60 * 24)
233
self.session = Session.Session(self.apache_req)
309
234
return self.session
311
236
def get_fieldstorage(self):
316
241
if not hasattr(self, 'fields'):
317
242
self.fields = util.FieldStorage(self.apache_req)
318
243
return self.fields
320
def get_cgi_environ(self):
321
"""Returns the CGI environment emulation for this request. (Calls
322
add_common_vars). The environment is returned as a mapping
323
compatible with os.environ."""
324
if not self.got_common_vars:
325
self.apache_req.add_common_vars()
326
self.got_common_vars = True
327
return self.apache_req.subprocess_env
330
def get_http_codename(code):
331
"""Given a HTTP error code int, returns a (name, description)
332
pair, suitable for displaying to the user.
333
May return (None,None) if code is unknown.
334
Only lists common 4xx and 5xx codes (since this is just used
335
to display throw_error error messages).
338
return http_codenames[code]
342
# Human strings for HTTP response codes
344
Request.HTTP_BAD_REQUEST:
346
"Your browser sent a request IVLE did not understand."),
347
Request.HTTP_UNAUTHORIZED:
349
"You are not allowed to view this part of IVLE."),
350
Request.HTTP_FORBIDDEN:
352
"You are not allowed to view this part of IVLE."),
353
Request.HTTP_NOT_FOUND:
355
"The application or file you requested does not exist."),
356
Request.HTTP_METHOD_NOT_ALLOWED:
357
("Method Not Allowed",
358
"Your browser is interacting with IVLE in the wrong way."
359
"This is probably a bug in IVLE. "
360
"Please report it to the administrators."),
361
Request.HTTP_INTERNAL_SERVER_ERROR:
362
("Internal Server Error",
363
"An unknown error occured in IVLE."),
364
Request.HTTP_NOT_IMPLEMENTED:
366
"The application or file you requested has not been implemented "
368
Request.HTTP_SERVICE_UNAVAILABLE:
369
("Service Unavailable",
370
"IVLE is currently experiencing technical difficulties. "
371
"Please try again later."),
added
removed
www/dispatch/request.py
