← 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-29 23:52:19 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:329
Converted Console from an "app" into a "plugin". It can now be plugged in to
any app.
Added "plugins" directory in www. Added "console" plugin. This contains all of
the functionality of what was previously the console app, but modularized so
it can be imported by another app.

apps/console: Removed most of the logic (moved to plugins/console). Replaced
with a simple import of the console plugin. Should behave exactly the same.
apps/tutorial: As proof of concept, imported the console plugin. It now
appears at the bottom of the page (yet to make it have "pop up" behaviour).

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
29
30
 
30
31
class Request:
31
32
    """An IVLE request object. This is presented to the IVLE apps as a way of
45
46
        username (read)
46
47
            String. Login name of the user who is currently logged in, or
47
48
            None.
 
49
        hostname (read)
 
50
            String. Hostname the server is running on.
48
51
        headers_in (read)
49
52
            Table object representing headers sent by the client.
50
53
        headers_out (read, can be written to)
51
54
            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).
52
59
 
53
60
        status (write)
54
61
            Int. Response status number. Use one of the status codes defined
61
68
        title (write)
62
69
            String. HTML page title. Used if write_html_head_foot is True, in
63
70
            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.
64
83
        write_html_head_foot (write)
65
84
            Boolean. If True, dispatch assumes that this is an XHTML page, and
66
85
            will immediately write a full HTML head, open the body element,
146
165
        self.func_write_html_head = write_html_head
147
166
        self.headers_written = False
148
167
 
 
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
 
149
175
        # Inherit values for the input members
150
176
        self.method = req.method
151
177
        self.uri = req.uri
152
178
        # Split the given path into the app (top-level dir) and sub-path
153
179
        # (after first stripping away the root directory)
154
 
        (self.app, self.path) = (
155
 
            common.util.split_path(common.util.unmake_path(req.uri)))
 
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))
156
186
        self.username = None
 
187
        self.hostname = req.hostname
157
188
        self.headers_in = req.headers_in
158
189
        self.headers_out = req.headers_out
159
190
 
160
191
        # Default values for the output members
161
 
        self.status = Request.OK
 
192
        self.status = Request.HTTP_OK
162
193
        self.content_type = None        # Use Apache's default
163
194
        self.location = None
164
195
        self.title = None     # Will be set by dispatch before passing to app
 
196
        self.styles = []
 
197
        self.scripts = []
165
198
        self.write_html_head_foot = False
 
199
        self.got_common_vars = False
166
200
 
167
201
    def __writeheaders(self):
168
202
        """Writes out the HTTP and HTML headers before any real data is
206
240
        """Reads at most len bytes directly from the client. (See mod_python
207
241
        Request.read)."""
208
242
        if len is None:
209
 
            self.apache_req.read()
 
243
            return self.apache_req.read()
210
244
        else:
211
 
            self.apache_req.read(len)
 
245
            return self.apache_req.read(len)
212
246
 
213
247
    def throw_error(self, httpcode):
214
248
        """Writes out an HTTP error of the specified code. Raises an exception
247
281
        if not hasattr(self, 'fields'):
248
282
            self.fields = util.FieldStorage(self.apache_req)
249
283
        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