paulb@187 | 1 | #!/usr/bin/env python |
paulb@187 | 2 | |
paulb@187 | 3 | """ |
paulb@187 | 4 | Zope classes. |
paulb@187 | 5 | In places this resembles CGI a lot because Zope seems to recycle a lot of that |
paulb@187 | 6 | baggage. |
paulb@187 | 7 | """ |
paulb@187 | 8 | |
paulb@187 | 9 | import Generic |
paulb@187 | 10 | from Helpers import Environment |
paulb@187 | 11 | from Helpers.Request import Cookie |
paulb@188 | 12 | from Helpers.Response import ConvertingStream |
paulb@187 | 13 | |
paulb@187 | 14 | class Transaction(Generic.Transaction): |
paulb@187 | 15 | |
paulb@187 | 16 | """ |
paulb@187 | 17 | Zope transaction interface. |
paulb@187 | 18 | """ |
paulb@187 | 19 | |
paulb@187 | 20 | def __init__(self, request): |
paulb@187 | 21 | |
paulb@187 | 22 | """ |
paulb@187 | 23 | Initialise the transaction with the Zope 'request' object. |
paulb@187 | 24 | """ |
paulb@187 | 25 | |
paulb@187 | 26 | self.request = request |
paulb@187 | 27 | self.response = request.RESPONSE |
paulb@188 | 28 | |
paulb@188 | 29 | # Attributes which may be changed later. |
paulb@188 | 30 | |
paulb@188 | 31 | self.content_type = None |
paulb@187 | 32 | self.user = None |
paulb@187 | 33 | |
paulb@187 | 34 | # Request-related methods. |
paulb@187 | 35 | |
paulb@187 | 36 | def get_request_stream(self): |
paulb@187 | 37 | |
paulb@187 | 38 | """ |
paulb@187 | 39 | Returns the request stream for the transaction. |
paulb@187 | 40 | """ |
paulb@187 | 41 | |
paulb@187 | 42 | # NOTE: Possibly not safe. |
paulb@187 | 43 | |
paulb@187 | 44 | return self.request.stdin |
paulb@187 | 45 | |
paulb@187 | 46 | def get_request_method(self): |
paulb@187 | 47 | |
paulb@187 | 48 | """ |
paulb@187 | 49 | Returns the request method. |
paulb@187 | 50 | """ |
paulb@187 | 51 | |
paulb@187 | 52 | return self.request.environ.get("REQUEST_METHOD") |
paulb@187 | 53 | |
paulb@187 | 54 | def get_headers(self): |
paulb@187 | 55 | |
paulb@187 | 56 | """ |
paulb@187 | 57 | Returns all request headers as a dictionary-like object mapping header |
paulb@187 | 58 | names to values. |
paulb@187 | 59 | """ |
paulb@187 | 60 | |
paulb@187 | 61 | return Environment.get_headers(self.request.environ) |
paulb@187 | 62 | |
paulb@187 | 63 | def get_header_values(self, key): |
paulb@187 | 64 | |
paulb@187 | 65 | """ |
paulb@187 | 66 | Returns a list of all request header values associated with the given |
paulb@187 | 67 | 'key'. Note that according to RFC 2616, 'key' is treated as a |
paulb@187 | 68 | case-insensitive string. |
paulb@187 | 69 | """ |
paulb@187 | 70 | |
paulb@187 | 71 | return self.convert_to_list(self.get_headers().get(key)) |
paulb@187 | 72 | |
paulb@187 | 73 | def get_content_type(self): |
paulb@187 | 74 | |
paulb@187 | 75 | """ |
paulb@187 | 76 | Returns the content type specified on the request, along with the |
paulb@187 | 77 | charset employed. |
paulb@187 | 78 | """ |
paulb@187 | 79 | |
paulb@187 | 80 | return self.parse_content_type(self.request.environ.get("CONTENT_TYPE")) |
paulb@187 | 81 | |
paulb@187 | 82 | def get_content_charsets(self): |
paulb@187 | 83 | |
paulb@187 | 84 | """ |
paulb@187 | 85 | Returns the character set preferences. |
paulb@187 | 86 | |
paulb@187 | 87 | NOTE: Not decently supported. |
paulb@187 | 88 | """ |
paulb@187 | 89 | |
paulb@187 | 90 | return self.parse_content_preferences(None) |
paulb@187 | 91 | |
paulb@187 | 92 | def get_content_languages(self): |
paulb@187 | 93 | |
paulb@187 | 94 | """ |
paulb@187 | 95 | Returns extracted language information from the transaction. |
paulb@187 | 96 | |
paulb@187 | 97 | NOTE: Not decently supported. |
paulb@187 | 98 | """ |
paulb@187 | 99 | |
paulb@187 | 100 | return self.parse_content_preferences(None) |
paulb@187 | 101 | |
paulb@187 | 102 | def get_path(self): |
paulb@187 | 103 | |
paulb@187 | 104 | """ |
paulb@187 | 105 | Returns the entire path from the request. |
paulb@187 | 106 | """ |
paulb@187 | 107 | |
paulb@187 | 108 | # NOTE: Based on WebStack.CGI.get_path. |
paulb@187 | 109 | |
paulb@187 | 110 | path = self.get_path_without_query() |
paulb@187 | 111 | qs = self.get_query_string() |
paulb@187 | 112 | if qs: |
paulb@187 | 113 | path += "?" |
paulb@187 | 114 | path += qs |
paulb@187 | 115 | return path |
paulb@187 | 116 | |
paulb@187 | 117 | def get_path_without_query(self): |
paulb@187 | 118 | |
paulb@187 | 119 | """ |
paulb@187 | 120 | Returns the entire path from the request minus the query string. |
paulb@187 | 121 | """ |
paulb@187 | 122 | |
paulb@187 | 123 | # NOTE: Based on WebStack.CGI.get_path. |
paulb@187 | 124 | |
paulb@187 | 125 | path = self.request.environ.get("SCRIPT_NAME") or "" |
paulb@187 | 126 | if self.request.environ.has_key("PATH_INFO"): |
paulb@187 | 127 | path += self.request.environ["PATH_INFO"] |
paulb@187 | 128 | return path |
paulb@187 | 129 | |
paulb@187 | 130 | def get_path_info(self): |
paulb@187 | 131 | |
paulb@187 | 132 | """ |
paulb@187 | 133 | Returns the "path info" (the part of the URL after the resource name |
paulb@187 | 134 | handling the current request) from the request. |
paulb@187 | 135 | """ |
paulb@187 | 136 | |
paulb@187 | 137 | return self.request.environ.get("PATH_INFO") or "" |
paulb@187 | 138 | |
paulb@187 | 139 | def get_query_string(self): |
paulb@187 | 140 | |
paulb@187 | 141 | """ |
paulb@187 | 142 | Returns the query string from the path in the request. |
paulb@187 | 143 | """ |
paulb@187 | 144 | |
paulb@187 | 145 | return self.request.environ.get("QUERY_STRING") or "" |
paulb@187 | 146 | |
paulb@187 | 147 | # Higher level request-related methods. |
paulb@187 | 148 | |
paulb@187 | 149 | def get_fields_from_path(self): |
paulb@187 | 150 | |
paulb@187 | 151 | """ |
paulb@187 | 152 | Extracts the form fields from the path specified in the transaction. The |
paulb@187 | 153 | underlying framework may refuse to supply fields from the path if |
paulb@187 | 154 | handling a POST transaction. |
paulb@187 | 155 | |
paulb@187 | 156 | Returns a dictionary mapping field names to lists of values (even if a |
paulb@187 | 157 | single value is associated with any given field name). |
paulb@187 | 158 | """ |
paulb@187 | 159 | |
paulb@187 | 160 | fields = {} |
paulb@187 | 161 | for key, value in self.request.form.items(): |
paulb@187 | 162 | if type(value) == type([]): |
paulb@187 | 163 | fields[key] = value |
paulb@187 | 164 | else: |
paulb@187 | 165 | fields[key] = [value] |
paulb@187 | 166 | return fields |
paulb@187 | 167 | |
paulb@187 | 168 | def get_fields_from_body(self, encoding=None): |
paulb@187 | 169 | |
paulb@187 | 170 | """ |
paulb@187 | 171 | Extracts the form fields from the message body in the transaction. The |
paulb@187 | 172 | optional 'encoding' parameter specifies the character encoding of the |
paulb@187 | 173 | message body for cases where no such information is available, but where |
paulb@187 | 174 | the default encoding is to be overridden. |
paulb@187 | 175 | |
paulb@187 | 176 | Returns a dictionary mapping field names to lists of values (even if a |
paulb@187 | 177 | single value is associated with any given field name). |
paulb@187 | 178 | |
paulb@187 | 179 | NOTE: Zope doesn't distinguish between path and body fields. |
paulb@187 | 180 | """ |
paulb@187 | 181 | |
paulb@187 | 182 | # NOTE: Conversion to Unicode may be inappropriate. |
paulb@187 | 183 | |
paulb@187 | 184 | encoding = self.get_content_type().charset or encoding or "iso-8859-1" |
paulb@187 | 185 | fields = {} |
paulb@187 | 186 | for field_name, field_values in self.get_fields_from_path().items(): |
paulb@187 | 187 | fields[field_name] = [] |
paulb@187 | 188 | for field_value in field_values: |
paulb@187 | 189 | fields[field_name].append(unicode(field_value, encoding)) |
paulb@187 | 190 | return fields |
paulb@187 | 191 | |
paulb@187 | 192 | def get_user(self): |
paulb@187 | 193 | |
paulb@187 | 194 | """ |
paulb@187 | 195 | Extracts user information from the transaction. |
paulb@187 | 196 | |
paulb@187 | 197 | Returns a username as a string or None if no user is defined. |
paulb@187 | 198 | """ |
paulb@187 | 199 | |
paulb@187 | 200 | if self.user is not None: |
paulb@187 | 201 | return self.user |
paulb@187 | 202 | else: |
paulb@187 | 203 | return self.request.environ.get("REMOTE_USER") |
paulb@187 | 204 | |
paulb@187 | 205 | def get_cookies(self): |
paulb@187 | 206 | |
paulb@187 | 207 | """ |
paulb@187 | 208 | Obtains cookie information from the request. |
paulb@187 | 209 | |
paulb@187 | 210 | Returns a dictionary mapping cookie names to cookie objects. |
paulb@187 | 211 | """ |
paulb@187 | 212 | |
paulb@187 | 213 | cookies = {} |
paulb@187 | 214 | for name, value in self.request.cookies.items(): |
paulb@187 | 215 | cookies[name] = Cookie(name, value) |
paulb@187 | 216 | return cookies |
paulb@187 | 217 | |
paulb@187 | 218 | def get_cookie(self, cookie_name): |
paulb@187 | 219 | |
paulb@187 | 220 | """ |
paulb@187 | 221 | Obtains cookie information from the request. |
paulb@187 | 222 | |
paulb@187 | 223 | Returns a cookie object for the given 'cookie_name' or None if no such |
paulb@187 | 224 | cookie exists. |
paulb@187 | 225 | """ |
paulb@187 | 226 | |
paulb@187 | 227 | return Cookie(cookie_name, self.request.cookies.get(cookie_name)) |
paulb@187 | 228 | |
paulb@187 | 229 | # Response-related methods. |
paulb@187 | 230 | |
paulb@187 | 231 | def get_response_stream(self): |
paulb@187 | 232 | |
paulb@187 | 233 | """ |
paulb@187 | 234 | Returns the response stream for the transaction. |
paulb@187 | 235 | """ |
paulb@187 | 236 | |
paulb@188 | 237 | # Unicode can upset this operation. Using either the specified charset, |
paulb@188 | 238 | # the same charset as that used in the request, or a default encoding. |
paulb@187 | 239 | |
paulb@188 | 240 | encoding = self.get_content_type().charset or "utf-8" |
paulb@188 | 241 | if self.content_type: |
paulb@188 | 242 | encoding = self.content_type.charset or encoding |
paulb@188 | 243 | return ConvertingStream(self.response, encoding) |
paulb@187 | 244 | |
paulb@187 | 245 | def get_response_code(self): |
paulb@187 | 246 | |
paulb@187 | 247 | """ |
paulb@187 | 248 | Get the response code associated with the transaction. If no response |
paulb@187 | 249 | code is defined, None is returned. |
paulb@187 | 250 | """ |
paulb@187 | 251 | |
paulb@187 | 252 | return self.response.status |
paulb@187 | 253 | |
paulb@187 | 254 | def set_response_code(self, response_code): |
paulb@187 | 255 | |
paulb@187 | 256 | """ |
paulb@187 | 257 | Set the 'response_code' using a numeric constant defined in the HTTP |
paulb@187 | 258 | specification. |
paulb@187 | 259 | """ |
paulb@187 | 260 | |
paulb@187 | 261 | self.response.setStatus(response_code) |
paulb@187 | 262 | |
paulb@187 | 263 | def set_header_value(self, header, value): |
paulb@187 | 264 | |
paulb@187 | 265 | """ |
paulb@187 | 266 | Set the HTTP 'header' with the given 'value'. |
paulb@187 | 267 | """ |
paulb@187 | 268 | |
paulb@187 | 269 | self.response.setHeader(header, value) |
paulb@187 | 270 | |
paulb@187 | 271 | def set_content_type(self, content_type): |
paulb@187 | 272 | |
paulb@187 | 273 | """ |
paulb@187 | 274 | Sets the 'content_type' for the response. |
paulb@187 | 275 | """ |
paulb@187 | 276 | |
paulb@188 | 277 | self.content_type = content_type |
paulb@187 | 278 | self.response.setHeader("Content-Type", self.format_content_type(content_type)) |
paulb@187 | 279 | |
paulb@187 | 280 | # Higher level response-related methods. |
paulb@187 | 281 | |
paulb@187 | 282 | def set_cookie(self, cookie): |
paulb@187 | 283 | |
paulb@187 | 284 | """ |
paulb@187 | 285 | Stores the given 'cookie' object in the response. |
paulb@187 | 286 | """ |
paulb@187 | 287 | |
paulb@187 | 288 | self.set_cookie_value(cookie.name, cookie.value) |
paulb@187 | 289 | |
paulb@187 | 290 | def set_cookie_value(self, name, value, path=None, expires=None): |
paulb@187 | 291 | |
paulb@187 | 292 | """ |
paulb@187 | 293 | Stores a cookie with the given 'name' and 'value' in the response. |
paulb@187 | 294 | |
paulb@187 | 295 | The optional 'path' is a string which specifies the scope of the cookie, |
paulb@187 | 296 | and the optional 'expires' parameter is a value compatible with the |
paulb@187 | 297 | time.time function, and indicates the expiry date/time of the cookie. |
paulb@187 | 298 | """ |
paulb@187 | 299 | |
paulb@187 | 300 | self.response.setCookie(name, value) |
paulb@187 | 301 | |
paulb@187 | 302 | def delete_cookie(self, cookie_name): |
paulb@187 | 303 | |
paulb@187 | 304 | """ |
paulb@187 | 305 | Adds to the response a request that the cookie with the given |
paulb@187 | 306 | 'cookie_name' be deleted/discarded by the client. |
paulb@187 | 307 | """ |
paulb@187 | 308 | |
paulb@187 | 309 | self.response.expireCookie(cookie_name) |
paulb@187 | 310 | |
paulb@187 | 311 | # Session-related methods. |
paulb@187 | 312 | |
paulb@187 | 313 | def get_session(self, create=1): |
paulb@187 | 314 | |
paulb@187 | 315 | """ |
paulb@187 | 316 | Gets a session corresponding to an identifier supplied in the |
paulb@187 | 317 | transaction. |
paulb@187 | 318 | |
paulb@187 | 319 | If no session has yet been established according to information |
paulb@187 | 320 | provided in the transaction then the optional 'create' parameter |
paulb@187 | 321 | determines whether a new session will be established. |
paulb@187 | 322 | |
paulb@187 | 323 | Where no session has been established and where 'create' is set to 0 |
paulb@187 | 324 | then None is returned. In all other cases, a session object is created |
paulb@187 | 325 | (where appropriate) and returned. |
paulb@187 | 326 | """ |
paulb@187 | 327 | |
paulb@187 | 328 | raise NotImplementedError, "get_session" |
paulb@187 | 329 | |
paulb@187 | 330 | def expire_session(self): |
paulb@187 | 331 | |
paulb@187 | 332 | """ |
paulb@187 | 333 | Expires any session established according to information provided in the |
paulb@187 | 334 | transaction. |
paulb@187 | 335 | """ |
paulb@187 | 336 | |
paulb@187 | 337 | raise NotImplementedError, "expire_session" |
paulb@187 | 338 | |
paulb@187 | 339 | # Application-specific methods. |
paulb@187 | 340 | |
paulb@187 | 341 | def set_user(self, username): |
paulb@187 | 342 | |
paulb@187 | 343 | """ |
paulb@187 | 344 | An application-specific method which sets the user information with |
paulb@187 | 345 | 'username' in the transaction. This affects subsequent calls to |
paulb@187 | 346 | 'get_user'. |
paulb@187 | 347 | """ |
paulb@187 | 348 | |
paulb@187 | 349 | self.user = username |
paulb@187 | 350 | |
paulb@187 | 351 | # vim: tabstop=4 expandtab shiftwidth=4 |