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