← Back to branch summary

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

« back to all changes in this revision

Viewing changes to www/dispatch/request.py

  • Committer: mattgiuca
  • Date: 2008-01-09 21:33:56 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:144
Trunk, and all subdirectories with Python files:
    Added to svn:ignore all *.pyc *.pyo, to avoid compiled files
    showing up in svn st / diff / commit lists.
    Added to svn:ignore trampoline/trampoline.

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/dispatch/request.py
26
26
import common.util
27
27
import mod_python
28
28
from mod_python import (util, Session)
29
 
import conf
30
29
 
31
30
class Request:
32
31
    """An IVLE request object. This is presented to the IVLE apps as a way of
46
45
        username (read)
47
46
            String. Login name of the user who is currently logged in, or
48
47
            None.
49
 
        hostname (read)
50
 
            String. Hostname the server is running on.
51
48
        headers_in (read)
52
49
            Table object representing headers sent by the client.
53
50
        headers_out (read, can be written to)
54
51
            Table object representing headers to be sent to the client.
55
 
        publicmode (read)
56
 
            Bool. True if the request came for the "public host" as
57
 
            configured in conf.py. Note that public mode requests do not
58
 
            have an app (app is set to None).
59
52
 
60
53
        status (write)
61
54
            Int. Response status number. Use one of the status codes defined
68
61
        title (write)
69
62
            String. HTML page title. Used if write_html_head_foot is True, in
70
63
            the HTML title element text.
71
 
        styles (write)
72
 
            List of strings. Write a list of URLs to CSS files here, and they
73
 
            will be incorporated as <link rel="stylesheet" type="text/css">
74
 
            elements in the head, if write_html_head_foot is True.
75
 
            URLs should be relative to the IVLE root; they will be fixed up
76
 
            to be site-relative.
77
 
        scripts (write)
78
 
            List of strings. Write a list of URLs to JS files here, and they
79
 
            will be incorporated as <script type="text/javascript"> elements
80
 
            in the head, if write_html_head_foot is True.
81
 
            URLs should be relative to the IVLE root; they will be fixed up
82
 
            to be site-relative.
83
64
        write_html_head_foot (write)
84
65
            Boolean. If True, dispatch assumes that this is an XHTML page, and
85
66
            will immediately write a full HTML head, open the body element,
165
146
        self.func_write_html_head = write_html_head
166
147
        self.headers_written = False
167
148
 
168
 
        # Determine if the browser used the public host name to make the
169
 
        # request (in which case we are in "public mode")
170
 
        if req.hostname == conf.public_host:
171
 
            self.publicmode = True
172
 
        else:
173
 
            self.publicmode = False
174
 
 
175
149
        # Inherit values for the input members
176
150
        self.method = req.method
177
151
        self.uri = req.uri
178
152
        # Split the given path into the app (top-level dir) and sub-path
179
153
        # (after first stripping away the root directory)
180
 
        path = common.util.unmake_path(req.uri)
181
 
        if self.publicmode:
182
 
            self.app = None
183
 
            self.path = path
184
 
        else:
185
 
            (self.app, self.path) = (common.util.split_path(path))
 
154
        (self.app, self.path) = (
 
155
            common.util.split_path(common.util.unmake_path(req.uri)))
186
156
        self.username = None
187
 
        self.hostname = req.hostname
188
157
        self.headers_in = req.headers_in
189
158
        self.headers_out = req.headers_out
190
159
 
191
160
        # Default values for the output members
192
 
        self.status = Request.HTTP_OK
 
161
        self.status = Request.OK
193
162
        self.content_type = None        # Use Apache's default
194
163
        self.location = None
195
164
        self.title = None     # Will be set by dispatch before passing to app
196
 
        self.styles = []
197
 
        self.scripts = []
198
165
        self.write_html_head_foot = False
199
 
        self.got_common_vars = False
200
166
 
201
167
    def __writeheaders(self):
202
168
        """Writes out the HTTP and HTML headers before any real data is
240
206
        """Reads at most len bytes directly from the client. (See mod_python
241
207
        Request.read)."""
242
208
        if len is None:
243
 
            return self.apache_req.read()
 
209
            self.apache_req.read()
244
210
        else:
245
 
            return self.apache_req.read(len)
 
211
            self.apache_req.read(len)
246
212
 
247
213
    def throw_error(self, httpcode):
248
214
        """Writes out an HTTP error of the specified code. Raises an exception
281
247
        if not hasattr(self, 'fields'):
282
248
            self.fields = util.FieldStorage(self.apache_req)
283
249
        return self.fields
284
 
 
285
 
    def get_cgi_environ(self):
286
 
        """Returns the CGI environment emulation for this request. (Calls
287
 
        add_common_vars). The environment is returned as a mapping
288
 
        compatible with os.environ."""
289
 
        if not self.got_common_vars:
290
 
            self.apache_req.add_common_vars()
291
 
            self.got_common_vars = True
292
 
        return self.apache_req.subprocess_env