Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1 | """HTTP/1.1 client library |
Guido van Rossum | 41999c1 | 1997-12-09 00:12:23 +0000 | [diff] [blame] | 2 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 3 | <intro stuff goes here> |
| 4 | <other stuff, too> |
Guido van Rossum | 41999c1 | 1997-12-09 00:12:23 +0000 | [diff] [blame] | 5 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 6 | HTTPConnection goes through a number of "states", which define when a client |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 7 | may legally make another request or fetch the response for a particular |
| 8 | request. This diagram details these state transitions: |
Guido van Rossum | 41999c1 | 1997-12-09 00:12:23 +0000 | [diff] [blame] | 9 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 10 | (null) |
| 11 | | |
| 12 | | HTTPConnection() |
| 13 | v |
| 14 | Idle |
| 15 | | |
| 16 | | putrequest() |
| 17 | v |
| 18 | Request-started |
| 19 | | |
| 20 | | ( putheader() )* endheaders() |
| 21 | v |
| 22 | Request-sent |
| 23 | | |
| 24 | | response = getresponse() |
| 25 | v |
| 26 | Unread-response [Response-headers-read] |
| 27 | |\____________________ |
Tim Peters | 5ceadc8 | 2001-01-13 19:16:21 +0000 | [diff] [blame] | 28 | | | |
| 29 | | response.read() | putrequest() |
| 30 | v v |
| 31 | Idle Req-started-unread-response |
| 32 | ______/| |
| 33 | / | |
| 34 | response.read() | | ( putheader() )* endheaders() |
| 35 | v v |
| 36 | Request-started Req-sent-unread-response |
| 37 | | |
| 38 | | response.read() |
| 39 | v |
| 40 | Request-sent |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 41 | |
| 42 | This diagram presents the following rules: |
| 43 | -- a second request may not be started until {response-headers-read} |
| 44 | -- a response [object] cannot be retrieved until {request-sent} |
| 45 | -- there is no differentiation between an unread response body and a |
| 46 | partially read response body |
| 47 | |
| 48 | Note: this enforcement is applied by the HTTPConnection class. The |
| 49 | HTTPResponse class does not enforce this state machine, which |
| 50 | implies sophisticated clients may accelerate the request/response |
| 51 | pipeline. Caution should be taken, though: accelerating the states |
| 52 | beyond the above pattern may imply knowledge of the server's |
| 53 | connection-close behavior for certain requests. For example, it |
| 54 | is impossible to tell whether the server will close the connection |
| 55 | UNTIL the response headers have been read; this means that further |
| 56 | requests cannot be placed into the pipeline until it is known that |
| 57 | the server will NOT be closing the connection. |
| 58 | |
| 59 | Logical State __state __response |
| 60 | ------------- ------- ---------- |
| 61 | Idle _CS_IDLE None |
| 62 | Request-started _CS_REQ_STARTED None |
| 63 | Request-sent _CS_REQ_SENT None |
| 64 | Unread-response _CS_IDLE <response_class> |
| 65 | Req-started-unread-response _CS_REQ_STARTED <response_class> |
| 66 | Req-sent-unread-response _CS_REQ_SENT <response_class> |
Guido van Rossum | 41999c1 | 1997-12-09 00:12:23 +0000 | [diff] [blame] | 67 | """ |
Guido van Rossum | 23acc95 | 1994-02-21 16:36:04 +0000 | [diff] [blame] | 68 | |
Jeremy Hylton | 6459c8d | 2001-10-11 17:47:22 +0000 | [diff] [blame] | 69 | import errno |
Jeremy Hylton | fb35f65 | 2007-08-03 20:30:33 +0000 | [diff] [blame] | 70 | import io |
Guido van Rossum | 65ab98c | 1995-08-07 20:13:02 +0000 | [diff] [blame] | 71 | import mimetools |
Jeremy Hylton | 6459c8d | 2001-10-11 17:47:22 +0000 | [diff] [blame] | 72 | import socket |
Jeremy Hylton | 8acf1e0 | 2002-03-08 19:35:51 +0000 | [diff] [blame] | 73 | from urlparse import urlsplit |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 74 | import warnings |
Guido van Rossum | 23acc95 | 1994-02-21 16:36:04 +0000 | [diff] [blame] | 75 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 76 | __all__ = ["HTTPResponse", "HTTPConnection", |
Skip Montanaro | 951a884 | 2001-06-01 16:25:38 +0000 | [diff] [blame] | 77 | "HTTPException", "NotConnected", "UnknownProtocol", |
Jeremy Hylton | 7c75c99 | 2002-06-28 23:38:14 +0000 | [diff] [blame] | 78 | "UnknownTransferEncoding", "UnimplementedFileMode", |
| 79 | "IncompleteRead", "InvalidURL", "ImproperConnectionState", |
| 80 | "CannotSendRequest", "CannotSendHeader", "ResponseNotReady", |
Georg Brandl | 6aab16e | 2006-02-17 19:17:25 +0000 | [diff] [blame] | 81 | "BadStatusLine", "error", "responses"] |
Skip Montanaro | 2dd4276 | 2001-01-23 15:35:05 +0000 | [diff] [blame] | 82 | |
Guido van Rossum | 23acc95 | 1994-02-21 16:36:04 +0000 | [diff] [blame] | 83 | HTTP_PORT = 80 |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 84 | HTTPS_PORT = 443 |
| 85 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 86 | _UNKNOWN = 'UNKNOWN' |
| 87 | |
| 88 | # connection states |
| 89 | _CS_IDLE = 'Idle' |
| 90 | _CS_REQ_STARTED = 'Request-started' |
| 91 | _CS_REQ_SENT = 'Request-sent' |
| 92 | |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 93 | # status codes |
| 94 | # informational |
| 95 | CONTINUE = 100 |
| 96 | SWITCHING_PROTOCOLS = 101 |
| 97 | PROCESSING = 102 |
| 98 | |
| 99 | # successful |
| 100 | OK = 200 |
| 101 | CREATED = 201 |
| 102 | ACCEPTED = 202 |
| 103 | NON_AUTHORITATIVE_INFORMATION = 203 |
| 104 | NO_CONTENT = 204 |
| 105 | RESET_CONTENT = 205 |
| 106 | PARTIAL_CONTENT = 206 |
| 107 | MULTI_STATUS = 207 |
| 108 | IM_USED = 226 |
| 109 | |
| 110 | # redirection |
| 111 | MULTIPLE_CHOICES = 300 |
| 112 | MOVED_PERMANENTLY = 301 |
| 113 | FOUND = 302 |
| 114 | SEE_OTHER = 303 |
| 115 | NOT_MODIFIED = 304 |
| 116 | USE_PROXY = 305 |
| 117 | TEMPORARY_REDIRECT = 307 |
| 118 | |
| 119 | # client error |
| 120 | BAD_REQUEST = 400 |
| 121 | UNAUTHORIZED = 401 |
| 122 | PAYMENT_REQUIRED = 402 |
| 123 | FORBIDDEN = 403 |
| 124 | NOT_FOUND = 404 |
| 125 | METHOD_NOT_ALLOWED = 405 |
| 126 | NOT_ACCEPTABLE = 406 |
| 127 | PROXY_AUTHENTICATION_REQUIRED = 407 |
| 128 | REQUEST_TIMEOUT = 408 |
| 129 | CONFLICT = 409 |
| 130 | GONE = 410 |
| 131 | LENGTH_REQUIRED = 411 |
| 132 | PRECONDITION_FAILED = 412 |
| 133 | REQUEST_ENTITY_TOO_LARGE = 413 |
| 134 | REQUEST_URI_TOO_LONG = 414 |
| 135 | UNSUPPORTED_MEDIA_TYPE = 415 |
| 136 | REQUESTED_RANGE_NOT_SATISFIABLE = 416 |
| 137 | EXPECTATION_FAILED = 417 |
| 138 | UNPROCESSABLE_ENTITY = 422 |
| 139 | LOCKED = 423 |
| 140 | FAILED_DEPENDENCY = 424 |
| 141 | UPGRADE_REQUIRED = 426 |
| 142 | |
| 143 | # server error |
| 144 | INTERNAL_SERVER_ERROR = 500 |
| 145 | NOT_IMPLEMENTED = 501 |
| 146 | BAD_GATEWAY = 502 |
| 147 | SERVICE_UNAVAILABLE = 503 |
| 148 | GATEWAY_TIMEOUT = 504 |
| 149 | HTTP_VERSION_NOT_SUPPORTED = 505 |
| 150 | INSUFFICIENT_STORAGE = 507 |
| 151 | NOT_EXTENDED = 510 |
| 152 | |
Georg Brandl | 6aab16e | 2006-02-17 19:17:25 +0000 | [diff] [blame] | 153 | # Mapping status codes to official W3C names |
| 154 | responses = { |
| 155 | 100: 'Continue', |
| 156 | 101: 'Switching Protocols', |
| 157 | |
| 158 | 200: 'OK', |
| 159 | 201: 'Created', |
| 160 | 202: 'Accepted', |
| 161 | 203: 'Non-Authoritative Information', |
| 162 | 204: 'No Content', |
| 163 | 205: 'Reset Content', |
| 164 | 206: 'Partial Content', |
| 165 | |
| 166 | 300: 'Multiple Choices', |
| 167 | 301: 'Moved Permanently', |
| 168 | 302: 'Found', |
| 169 | 303: 'See Other', |
| 170 | 304: 'Not Modified', |
| 171 | 305: 'Use Proxy', |
| 172 | 306: '(Unused)', |
| 173 | 307: 'Temporary Redirect', |
| 174 | |
| 175 | 400: 'Bad Request', |
| 176 | 401: 'Unauthorized', |
| 177 | 402: 'Payment Required', |
| 178 | 403: 'Forbidden', |
| 179 | 404: 'Not Found', |
| 180 | 405: 'Method Not Allowed', |
| 181 | 406: 'Not Acceptable', |
| 182 | 407: 'Proxy Authentication Required', |
| 183 | 408: 'Request Timeout', |
| 184 | 409: 'Conflict', |
| 185 | 410: 'Gone', |
| 186 | 411: 'Length Required', |
| 187 | 412: 'Precondition Failed', |
| 188 | 413: 'Request Entity Too Large', |
| 189 | 414: 'Request-URI Too Long', |
| 190 | 415: 'Unsupported Media Type', |
| 191 | 416: 'Requested Range Not Satisfiable', |
| 192 | 417: 'Expectation Failed', |
| 193 | |
| 194 | 500: 'Internal Server Error', |
| 195 | 501: 'Not Implemented', |
| 196 | 502: 'Bad Gateway', |
| 197 | 503: 'Service Unavailable', |
| 198 | 504: 'Gateway Timeout', |
| 199 | 505: 'HTTP Version Not Supported', |
| 200 | } |
| 201 | |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 202 | # maximal amount of data to read at one time in _safe_read |
| 203 | MAXAMOUNT = 1048576 |
| 204 | |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 205 | class HTTPMessage(mimetools.Message): |
| 206 | |
| 207 | def addheader(self, key, value): |
| 208 | """Add header for field key handling repeats.""" |
| 209 | prev = self.dict.get(key) |
| 210 | if prev is None: |
| 211 | self.dict[key] = value |
| 212 | else: |
| 213 | combined = ", ".join((prev, value)) |
| 214 | self.dict[key] = combined |
| 215 | |
| 216 | def addcontinue(self, key, more): |
| 217 | """Add more field data from a continuation line.""" |
| 218 | prev = self.dict[key] |
| 219 | self.dict[key] = prev + "\n " + more |
| 220 | |
| 221 | def readheaders(self): |
| 222 | """Read header lines. |
| 223 | |
| 224 | Read header lines up to the entirely blank line that terminates them. |
| 225 | The (normally blank) line that ends the headers is skipped, but not |
| 226 | included in the returned list. If a non-header line ends the headers, |
| 227 | (which is an error), an attempt is made to backspace over it; it is |
| 228 | never included in the returned list. |
| 229 | |
| 230 | The variable self.status is set to the empty string if all went well, |
| 231 | otherwise it is an error message. The variable self.headers is a |
| 232 | completely uninterpreted list of lines contained in the header (so |
| 233 | printing them will reproduce the header exactly as it appears in the |
| 234 | file). |
| 235 | |
| 236 | If multiple header fields with the same name occur, they are combined |
| 237 | according to the rules in RFC 2616 sec 4.2: |
| 238 | |
| 239 | Appending each subsequent field-value to the first, each separated |
| 240 | by a comma. The order in which header fields with the same field-name |
| 241 | are received is significant to the interpretation of the combined |
| 242 | field value. |
| 243 | """ |
| 244 | # XXX The implementation overrides the readheaders() method of |
| 245 | # rfc822.Message. The base class design isn't amenable to |
| 246 | # customized behavior here so the method here is a copy of the |
| 247 | # base class code with a few small changes. |
| 248 | |
| 249 | self.dict = {} |
| 250 | self.unixfrom = '' |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 251 | self.headers = hlist = [] |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 252 | self.status = '' |
| 253 | headerseen = "" |
| 254 | firstline = 1 |
| 255 | startofline = unread = tell = None |
| 256 | if hasattr(self.fp, 'unread'): |
| 257 | unread = self.fp.unread |
| 258 | elif self.seekable: |
| 259 | tell = self.fp.tell |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 260 | while True: |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 261 | if tell: |
| 262 | try: |
| 263 | startofline = tell() |
| 264 | except IOError: |
| 265 | startofline = tell = None |
| 266 | self.seekable = 0 |
Jeremy Hylton | 811fc14 | 2007-08-03 13:30:02 +0000 | [diff] [blame] | 267 | line = str(self.fp.readline(), "iso-8859-1") |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 268 | if not line: |
| 269 | self.status = 'EOF in headers' |
| 270 | break |
| 271 | # Skip unix From name time lines |
| 272 | if firstline and line.startswith('From '): |
| 273 | self.unixfrom = self.unixfrom + line |
| 274 | continue |
| 275 | firstline = 0 |
| 276 | if headerseen and line[0] in ' \t': |
| 277 | # XXX Not sure if continuation lines are handled properly |
| 278 | # for http and/or for repeating headers |
| 279 | # It's a continuation line. |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 280 | hlist.append(line) |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 281 | self.addcontinue(headerseen, line.strip()) |
| 282 | continue |
| 283 | elif self.iscomment(line): |
| 284 | # It's a comment. Ignore it. |
| 285 | continue |
| 286 | elif self.islast(line): |
| 287 | # Note! No pushback here! The delimiter line gets eaten. |
| 288 | break |
| 289 | headerseen = self.isheader(line) |
| 290 | if headerseen: |
| 291 | # It's a legal header line, save it. |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 292 | hlist.append(line) |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 293 | self.addheader(headerseen, line[len(headerseen)+1:].strip()) |
| 294 | continue |
| 295 | else: |
| 296 | # It's not a header line; throw it back and stop here. |
| 297 | if not self.dict: |
| 298 | self.status = 'No headers' |
| 299 | else: |
| 300 | self.status = 'Non-header line where header expected' |
| 301 | # Try to undo the read. |
| 302 | if unread: |
| 303 | unread(line) |
| 304 | elif tell: |
| 305 | self.fp.seek(startofline) |
| 306 | else: |
| 307 | self.status = self.status + '; bad seek' |
| 308 | break |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 309 | |
Jeremy Hylton | 97043c3 | 2007-08-04 02:34:24 +0000 | [diff] [blame] | 310 | class HTTPResponse: |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 311 | |
| 312 | # strict: If true, raise BadStatusLine if the status line can't be |
| 313 | # parsed as a valid HTTP/1.0 or 1.1 status line. By default it is |
Skip Montanaro | 186bec2 | 2002-07-25 16:10:38 +0000 | [diff] [blame] | 314 | # false because it prevents clients from talking to HTTP/0.9 |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 315 | # servers. Note that a response with a sufficiently corrupted |
| 316 | # status line will look like an HTTP/0.9 response. |
| 317 | |
| 318 | # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details. |
| 319 | |
Jeremy Hylton | 811fc14 | 2007-08-03 13:30:02 +0000 | [diff] [blame] | 320 | # The bytes from the socket object are iso-8859-1 strings. |
| 321 | # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded |
| 322 | # text following RFC 2047. The basic status line parsing only |
| 323 | # accepts iso-8859-1. |
| 324 | |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 325 | def __init__(self, sock, debuglevel=0, strict=0, method=None): |
Jeremy Hylton | 39b198d | 2007-08-04 19:22:00 +0000 | [diff] [blame] | 326 | # XXX If the response includes a content-length header, we |
| 327 | # need to make sure that the client doesn't read more than the |
| 328 | # specified number of bytes. If it does, it will block until |
| 329 | # the server times out and closes the connection. (The only |
| 330 | # applies to HTTP/1.1 connections.) Since some clients access |
| 331 | # self.fp directly rather than calling read(), this is a little |
| 332 | # tricky. |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 333 | self.fp = sock.makefile("rb", 0) |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 334 | self.debuglevel = debuglevel |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 335 | self.strict = strict |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 336 | self._method = method |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 337 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 338 | self.msg = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 339 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 340 | # from the Status-Line of the response |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 341 | self.version = _UNKNOWN # HTTP-Version |
| 342 | self.status = _UNKNOWN # Status-Code |
| 343 | self.reason = _UNKNOWN # Reason-Phrase |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 344 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 345 | self.chunked = _UNKNOWN # is "chunked" being used? |
| 346 | self.chunk_left = _UNKNOWN # bytes left to read in current chunk |
| 347 | self.length = _UNKNOWN # number of bytes left in response |
| 348 | self.will_close = _UNKNOWN # conn will close at end of response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 349 | |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 350 | def _read_status(self): |
Jeremy Hylton | 04319c7 | 2007-08-04 03:41:19 +0000 | [diff] [blame] | 351 | # Initialize with Simple-Response defaults. |
Jeremy Hylton | 811fc14 | 2007-08-03 13:30:02 +0000 | [diff] [blame] | 352 | line = str(self.fp.readline(), "iso-8859-1") |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 353 | if self.debuglevel > 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 354 | print("reply:", repr(line)) |
Jeremy Hylton | b676952 | 2003-06-29 17:55:05 +0000 | [diff] [blame] | 355 | if not line: |
| 356 | # Presumably, the server closed the connection before |
| 357 | # sending a valid response. |
| 358 | raise BadStatusLine(line) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 359 | try: |
Guido van Rossum | 34735a6 | 2000-12-15 15:09:42 +0000 | [diff] [blame] | 360 | [version, status, reason] = line.split(None, 2) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 361 | except ValueError: |
| 362 | try: |
Guido van Rossum | 34735a6 | 2000-12-15 15:09:42 +0000 | [diff] [blame] | 363 | [version, status] = line.split(None, 1) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 364 | reason = "" |
| 365 | except ValueError: |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 366 | # empty version will cause next test to fail and status |
| 367 | # will be treated as 0.9 response. |
| 368 | version = "" |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 369 | if not version.startswith("HTTP/"): |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 370 | if self.strict: |
| 371 | self.close() |
| 372 | raise BadStatusLine(line) |
| 373 | else: |
Jeremy Hylton | 04319c7 | 2007-08-04 03:41:19 +0000 | [diff] [blame] | 374 | # Assume it's a Simple-Response from an 0.9 server. |
| 375 | # We have to convert the first line back to raw bytes |
| 376 | # because self.fp.readline() needs to return bytes. |
Guido van Rossum | 70d0dda | 2007-08-29 01:53:26 +0000 | [diff] [blame] | 377 | self.fp = LineAndFileWrapper(bytes(line, "ascii"), self.fp) |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 378 | return "HTTP/0.9", 200, "" |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 379 | |
Jeremy Hylton | 23d4047 | 2001-04-13 14:57:08 +0000 | [diff] [blame] | 380 | # The status code is a three-digit number |
| 381 | try: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 382 | status = int(status) |
Jeremy Hylton | 23d4047 | 2001-04-13 14:57:08 +0000 | [diff] [blame] | 383 | if status < 100 or status > 999: |
| 384 | raise BadStatusLine(line) |
| 385 | except ValueError: |
| 386 | raise BadStatusLine(line) |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 387 | return version, status, reason |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 388 | |
Jeremy Hylton | 39c0380 | 2002-07-12 14:04:09 +0000 | [diff] [blame] | 389 | def begin(self): |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 390 | if self.msg is not None: |
| 391 | # we've already started reading the response |
| 392 | return |
| 393 | |
| 394 | # read until we get a non-100 response |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 395 | while True: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 396 | version, status, reason = self._read_status() |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 397 | if status != CONTINUE: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 398 | break |
| 399 | # skip the header from the 100 response |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 400 | while True: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 401 | skip = self.fp.readline().strip() |
| 402 | if not skip: |
| 403 | break |
| 404 | if self.debuglevel > 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 405 | print("header:", skip) |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 406 | |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 407 | self.status = status |
| 408 | self.reason = reason.strip() |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 409 | if version == "HTTP/1.0": |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 410 | self.version = 10 |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 411 | elif version.startswith("HTTP/1."): |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 412 | self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1 |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 413 | elif version == "HTTP/0.9": |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 414 | self.version = 9 |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 415 | else: |
| 416 | raise UnknownProtocol(version) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 417 | |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 418 | if self.version == 9: |
Georg Brandl | 0aade9a | 2005-06-26 22:06:54 +0000 | [diff] [blame] | 419 | self.length = None |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 420 | self.chunked = 0 |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 421 | self.will_close = 1 |
Jeremy Hylton | 4e7855d | 2007-08-04 03:34:03 +0000 | [diff] [blame] | 422 | self.msg = HTTPMessage(io.BytesIO()) |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 423 | return |
| 424 | |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 425 | self.msg = HTTPMessage(self.fp, 0) |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 426 | if self.debuglevel > 0: |
| 427 | for hdr in self.msg.headers: |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 428 | print("header:", hdr, end=" ") |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 429 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 430 | # don't let the msg keep an fp |
| 431 | self.msg.fp = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 432 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 433 | # are we using the chunked-style of transfer encoding? |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 434 | tr_enc = self.msg.getheader("transfer-encoding") |
Jeremy Hylton | d229b3a | 2002-09-03 19:24:24 +0000 | [diff] [blame] | 435 | if tr_enc and tr_enc.lower() == "chunked": |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 436 | self.chunked = 1 |
| 437 | self.chunk_left = None |
| 438 | else: |
| 439 | self.chunked = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 440 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 441 | # will the connection close at the end of the response? |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 442 | self.will_close = self._check_close() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 443 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 444 | # do we have a Content-Length? |
| 445 | # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked" |
Jeremy Hylton | 0ee5eeb | 2007-08-04 03:25:17 +0000 | [diff] [blame] | 446 | self.length = None |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 447 | length = self.msg.getheader("content-length") |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 448 | if length and not self.chunked: |
Jeremy Hylton | 30a8181 | 2000-09-14 20:34:27 +0000 | [diff] [blame] | 449 | try: |
| 450 | self.length = int(length) |
| 451 | except ValueError: |
Jeremy Hylton | 0ee5eeb | 2007-08-04 03:25:17 +0000 | [diff] [blame] | 452 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 453 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 454 | # does the body have a fixed length? (of zero) |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 455 | if (status == NO_CONTENT or status == NOT_MODIFIED or |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 456 | 100 <= status < 200 or # 1xx codes |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 457 | self._method == "HEAD"): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 458 | self.length = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 459 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 460 | # if the connection remains open, and we aren't using chunked, and |
| 461 | # a content-length was not provided, then assume that the connection |
| 462 | # WILL close. |
Jeremy Hylton | 0ee5eeb | 2007-08-04 03:25:17 +0000 | [diff] [blame] | 463 | if (not self.will_close and |
| 464 | not self.chunked and |
| 465 | self.length is None): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 466 | self.will_close = 1 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 467 | |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 468 | def _check_close(self): |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 469 | conn = self.msg.getheader("connection") |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 470 | if self.version == 11: |
| 471 | # An HTTP/1.1 proxy is assumed to stay open unless |
| 472 | # explicitly closed. |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 473 | conn = self.msg.getheader("connection") |
Raymond Hettinger | bac788a | 2004-05-04 09:21:43 +0000 | [diff] [blame] | 474 | if conn and "close" in conn.lower(): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 475 | return True |
| 476 | return False |
| 477 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 478 | # Some HTTP/1.0 implementations have support for persistent |
| 479 | # connections, using rules different than HTTP/1.1. |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 480 | |
Christian Heimes | 895627f | 2007-12-08 17:28:33 +0000 | [diff] [blame] | 481 | # For older HTTP, Keep-Alive indicates persistent connection. |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 482 | if self.msg.getheader("keep-alive"): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 483 | return False |
Tim Peters | 77c06fb | 2002-11-24 02:35:35 +0000 | [diff] [blame] | 484 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 485 | # At least Akamai returns a "Connection: Keep-Alive" header, |
| 486 | # which was supposed to be sent by the client. |
| 487 | if conn and "keep-alive" in conn.lower(): |
| 488 | return False |
| 489 | |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 490 | # Proxy-Connection is a netscape hack. |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 491 | pconn = self.msg.getheader("proxy-connection") |
Raymond Hettinger | bac788a | 2004-05-04 09:21:43 +0000 | [diff] [blame] | 492 | if pconn and "keep-alive" in pconn.lower(): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 493 | return False |
| 494 | |
| 495 | # otherwise, assume it will close |
| 496 | return True |
| 497 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 498 | def close(self): |
| 499 | if self.fp: |
| 500 | self.fp.close() |
| 501 | self.fp = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 502 | |
Jeremy Hylton | df5f6b5 | 2007-08-08 17:36:33 +0000 | [diff] [blame] | 503 | # These implementations are for the benefit of io.BufferedReader. |
| 504 | |
| 505 | # XXX This class should probably be revised to act more like |
| 506 | # the "raw stream" that BufferedReader expects. |
| 507 | |
| 508 | @property |
| 509 | def closed(self): |
| 510 | return self.isclosed() |
| 511 | |
| 512 | def flush(self): |
| 513 | self.fp.flush() |
| 514 | |
| 515 | # End of "raw stream" methods |
| 516 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 517 | def isclosed(self): |
| 518 | # NOTE: it is possible that we will not ever call self.close(). This |
| 519 | # case occurs when will_close is TRUE, length is None, and we |
| 520 | # read up to the last byte, but NOT past it. |
| 521 | # |
| 522 | # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be |
| 523 | # called, meaning self.isclosed() is meaningful. |
| 524 | return self.fp is None |
| 525 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 526 | # XXX It would be nice to have readline and __iter__ for this, too. |
| 527 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 528 | def read(self, amt=None): |
| 529 | if self.fp is None: |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 530 | return b"" |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 531 | |
| 532 | if self.chunked: |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 533 | return self._read_chunked(amt) |
Tim Peters | 230a60c | 2002-11-09 05:08:07 +0000 | [diff] [blame] | 534 | |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 535 | if amt is None: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 536 | # unbounded read |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 537 | if self.length is None: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 538 | s = self.fp.read() |
| 539 | else: |
| 540 | s = self._safe_read(self.length) |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 541 | self.length = 0 |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 542 | self.close() # we read everything |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 543 | return s |
| 544 | |
| 545 | if self.length is not None: |
| 546 | if amt > self.length: |
| 547 | # clip the read to the "end of response" |
| 548 | amt = self.length |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 549 | |
| 550 | # we do not use _safe_read() here because this may be a .will_close |
| 551 | # connection, and the user is reading more bytes than will be provided |
| 552 | # (for example, reading in 1k chunks) |
| 553 | s = self.fp.read(amt) |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 554 | if self.length is not None: |
| 555 | self.length -= len(s) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 556 | if not self.length: |
| 557 | self.close() |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 558 | return s |
| 559 | |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 560 | def _read_chunked(self, amt): |
| 561 | assert self.chunked != _UNKNOWN |
| 562 | chunk_left = self.chunk_left |
Georg Brandl | 95ba469 | 2008-01-26 09:45:58 +0000 | [diff] [blame] | 563 | value = b"" |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 564 | |
| 565 | # XXX This accumulates chunks by repeated string concatenation, |
| 566 | # which is not efficient as the number or size of chunks gets big. |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 567 | while True: |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 568 | if chunk_left is None: |
| 569 | line = self.fp.readline() |
Georg Brandl | 95ba469 | 2008-01-26 09:45:58 +0000 | [diff] [blame] | 570 | i = line.find(b";") |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 571 | if i >= 0: |
| 572 | line = line[:i] # strip chunk-extensions |
| 573 | chunk_left = int(line, 16) |
| 574 | if chunk_left == 0: |
| 575 | break |
| 576 | if amt is None: |
| 577 | value += self._safe_read(chunk_left) |
| 578 | elif amt < chunk_left: |
| 579 | value += self._safe_read(amt) |
| 580 | self.chunk_left = chunk_left - amt |
| 581 | return value |
| 582 | elif amt == chunk_left: |
| 583 | value += self._safe_read(amt) |
| 584 | self._safe_read(2) # toss the CRLF at the end of the chunk |
| 585 | self.chunk_left = None |
| 586 | return value |
| 587 | else: |
| 588 | value += self._safe_read(chunk_left) |
| 589 | amt -= chunk_left |
| 590 | |
| 591 | # we read the whole chunk, get another |
| 592 | self._safe_read(2) # toss the CRLF at the end of the chunk |
| 593 | chunk_left = None |
| 594 | |
| 595 | # read and discard trailer up to the CRLF terminator |
| 596 | ### note: we shouldn't have any trailers! |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 597 | while True: |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 598 | line = self.fp.readline() |
Christian Heimes | 0bd4e11 | 2008-02-12 22:59:25 +0000 | [diff] [blame] | 599 | if not line: |
| 600 | # a vanishingly small number of sites EOF without |
| 601 | # sending the trailer |
| 602 | break |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 603 | if line == b"\r\n": |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 604 | break |
| 605 | |
| 606 | # we read everything; close the "file" |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 607 | self.close() |
| 608 | |
| 609 | return value |
Tim Peters | 230a60c | 2002-11-09 05:08:07 +0000 | [diff] [blame] | 610 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 611 | def _safe_read(self, amt): |
| 612 | """Read the number of bytes requested, compensating for partial reads. |
| 613 | |
| 614 | Normally, we have a blocking socket, but a read() can be interrupted |
| 615 | by a signal (resulting in a partial read). |
| 616 | |
| 617 | Note that we cannot distinguish between EOF and an interrupt when zero |
| 618 | bytes have been read. IncompleteRead() will be raised in this |
| 619 | situation. |
| 620 | |
| 621 | This function should be used when <amt> bytes "should" be present for |
| 622 | reading. If the bytes are truly not available (due to EOF), then the |
| 623 | IncompleteRead exception can be used to detect the problem. |
| 624 | """ |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 625 | s = [] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 626 | while amt > 0: |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 627 | chunk = self.fp.read(min(amt, MAXAMOUNT)) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 628 | if not chunk: |
| 629 | raise IncompleteRead(s) |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 630 | s.append(chunk) |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 631 | amt -= len(chunk) |
Guido van Rossum | a00f123 | 2007-09-12 19:43:09 +0000 | [diff] [blame] | 632 | return b"".join(s) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 633 | |
| 634 | def getheader(self, name, default=None): |
| 635 | if self.msg is None: |
| 636 | raise ResponseNotReady() |
| 637 | return self.msg.getheader(name, default) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 638 | |
Martin v. Löwis | deacce2 | 2004-08-18 12:46:26 +0000 | [diff] [blame] | 639 | def getheaders(self): |
| 640 | """Return list of (header, value) tuples.""" |
| 641 | if self.msg is None: |
| 642 | raise ResponseNotReady() |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 643 | return list(self.msg.items()) |
Martin v. Löwis | deacce2 | 2004-08-18 12:46:26 +0000 | [diff] [blame] | 644 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 645 | |
| 646 | class HTTPConnection: |
| 647 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 648 | _http_vsn = 11 |
| 649 | _http_vsn_str = 'HTTP/1.1' |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 650 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 651 | response_class = HTTPResponse |
| 652 | default_port = HTTP_PORT |
| 653 | auto_open = 1 |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 654 | debuglevel = 0 |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 655 | strict = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 656 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 657 | def __init__(self, host, port=None, strict=None, timeout=None): |
| 658 | self.timeout = timeout |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 659 | self.sock = None |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 660 | self._buffer = [] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 661 | self.__response = None |
| 662 | self.__state = _CS_IDLE |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 663 | self._method = None |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 664 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 665 | self._set_hostport(host, port) |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 666 | if strict is not None: |
| 667 | self.strict = strict |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 668 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 669 | def _set_hostport(self, host, port): |
| 670 | if port is None: |
Skip Montanaro | 10e6e0e | 2004-09-14 16:32:02 +0000 | [diff] [blame] | 671 | i = host.rfind(':') |
Skip Montanaro | cae14d2 | 2004-09-14 17:55:21 +0000 | [diff] [blame] | 672 | j = host.rfind(']') # ipv6 addresses have [...] |
| 673 | if i > j: |
Skip Montanaro | 9d38997 | 2002-03-24 16:53:50 +0000 | [diff] [blame] | 674 | try: |
| 675 | port = int(host[i+1:]) |
| 676 | except ValueError: |
Jeremy Hylton | fbd7994 | 2002-07-02 20:19:08 +0000 | [diff] [blame] | 677 | raise InvalidURL("nonnumeric port: '%s'" % host[i+1:]) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 678 | host = host[:i] |
| 679 | else: |
| 680 | port = self.default_port |
Raymond Hettinger | 4d03791 | 2004-10-14 15:23:38 +0000 | [diff] [blame] | 681 | if host and host[0] == '[' and host[-1] == ']': |
Brett Cannon | 0a1af4a | 2004-09-15 23:26:23 +0000 | [diff] [blame] | 682 | host = host[1:-1] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 683 | self.host = host |
| 684 | self.port = port |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 685 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 686 | def set_debuglevel(self, level): |
| 687 | self.debuglevel = level |
| 688 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 689 | def connect(self): |
| 690 | """Connect to the host and port specified in __init__.""" |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 691 | self.sock = socket.create_connection((self.host,self.port), |
| 692 | self.timeout) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 693 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 694 | def close(self): |
| 695 | """Close the connection to the HTTP server.""" |
| 696 | if self.sock: |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 697 | self.sock.close() # close it manually... there may be other refs |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 698 | self.sock = None |
| 699 | if self.__response: |
| 700 | self.__response.close() |
| 701 | self.__response = None |
| 702 | self.__state = _CS_IDLE |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 703 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 704 | def send(self, str): |
| 705 | """Send `str' to the server.""" |
| 706 | if self.sock is None: |
| 707 | if self.auto_open: |
| 708 | self.connect() |
| 709 | else: |
| 710 | raise NotConnected() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 711 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 712 | # send the data to the server. if we get a broken pipe, then close |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 713 | # the socket. we want to reconnect when somebody tries to send again. |
| 714 | # |
| 715 | # NOTE: we DO propagate the error, though, because we cannot simply |
| 716 | # ignore the error... the caller will know if they can retry. |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 717 | if self.debuglevel > 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 718 | print("send:", repr(str)) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 719 | try: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 720 | blocksize=8192 |
| 721 | if hasattr(str,'read') : |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 722 | if self.debuglevel > 0: print("sendIng a read()able") |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 723 | data=str.read(blocksize) |
| 724 | while data: |
| 725 | self.sock.sendall(data) |
| 726 | data=str.read(blocksize) |
| 727 | else: |
| 728 | self.sock.sendall(str) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 729 | except socket.error as v: |
Guido van Rossum | 89df245 | 2007-03-19 22:26:27 +0000 | [diff] [blame] | 730 | if v.args[0] == 32: # Broken pipe |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 731 | self.close() |
| 732 | raise |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 733 | |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 734 | def _output(self, s): |
| 735 | """Add a line of output to the current request buffer. |
Tim Peters | 469cdad | 2002-08-08 20:19:19 +0000 | [diff] [blame] | 736 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 737 | Assumes that the line does *not* end with \\r\\n. |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 738 | """ |
| 739 | self._buffer.append(s) |
| 740 | |
| 741 | def _send_output(self): |
| 742 | """Send the currently buffered request and clear the buffer. |
| 743 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 744 | Appends an extra \\r\\n to the buffer. |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 745 | """ |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 746 | self._buffer.extend((b"", b"")) |
| 747 | msg = b"\r\n".join(self._buffer) |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 748 | del self._buffer[:] |
| 749 | self.send(msg) |
| 750 | |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 751 | def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 752 | """Send a request to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 753 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 754 | `method' specifies an HTTP request method, e.g. 'GET'. |
| 755 | `url' specifies the object being requested, e.g. '/index.html'. |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 756 | `skip_host' if True does not add automatically a 'Host:' header |
| 757 | `skip_accept_encoding' if True does not add automatically an |
| 758 | 'Accept-Encoding:' header |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 759 | """ |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 760 | |
Greg Stein | 616a58d | 2003-06-24 06:35:19 +0000 | [diff] [blame] | 761 | # if a prior response has been completed, then forget about it. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 762 | if self.__response and self.__response.isclosed(): |
| 763 | self.__response = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 764 | |
Tim Peters | 58eb11c | 2004-01-18 20:29:55 +0000 | [diff] [blame] | 765 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 766 | # in certain cases, we cannot issue another request on this connection. |
| 767 | # this occurs when: |
| 768 | # 1) we are in the process of sending a request. (_CS_REQ_STARTED) |
| 769 | # 2) a response to a previous request has signalled that it is going |
| 770 | # to close the connection upon completion. |
| 771 | # 3) the headers for the previous response have not been read, thus |
| 772 | # we cannot determine whether point (2) is true. (_CS_REQ_SENT) |
| 773 | # |
| 774 | # if there is no prior response, then we can request at will. |
| 775 | # |
| 776 | # if point (2) is true, then we will have passed the socket to the |
| 777 | # response (effectively meaning, "there is no prior response"), and |
| 778 | # will open a new one when a new request is made. |
| 779 | # |
| 780 | # Note: if a prior response exists, then we *can* start a new request. |
| 781 | # We are not allowed to begin fetching the response to this new |
| 782 | # request, however, until that prior response is complete. |
| 783 | # |
| 784 | if self.__state == _CS_IDLE: |
| 785 | self.__state = _CS_REQ_STARTED |
| 786 | else: |
| 787 | raise CannotSendRequest() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 788 | |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 789 | # Save the method we use, we need it later in the response phase |
| 790 | self._method = method |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 791 | if not url: |
| 792 | url = '/' |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 793 | request = '%s %s %s' % (method, url, self._http_vsn_str) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 794 | |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 795 | # Non-ASCII characters should have been eliminated earlier |
| 796 | self._output(request.encode('ascii')) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 797 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 798 | if self._http_vsn == 11: |
| 799 | # Issue some standard headers for better HTTP/1.1 compliance |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 800 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 801 | if not skip_host: |
| 802 | # this header is issued *only* for HTTP/1.1 |
| 803 | # connections. more specifically, this means it is |
| 804 | # only issued when the client uses the new |
| 805 | # HTTPConnection() class. backwards-compat clients |
| 806 | # will be using HTTP/1.0 and those clients may be |
| 807 | # issuing this header themselves. we should NOT issue |
| 808 | # it twice; some web servers (such as Apache) barf |
| 809 | # when they see two Host: headers |
Guido van Rossum | f6922aa | 2001-01-14 21:03:01 +0000 | [diff] [blame] | 810 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 811 | # If we need a non-standard port,include it in the |
| 812 | # header. If the request is going through a proxy, |
| 813 | # but the host of the actual URL, not the host of the |
| 814 | # proxy. |
Jeremy Hylton | 8acf1e0 | 2002-03-08 19:35:51 +0000 | [diff] [blame] | 815 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 816 | netloc = '' |
| 817 | if url.startswith('http'): |
| 818 | nil, netloc, nil, nil, nil = urlsplit(url) |
| 819 | |
| 820 | if netloc: |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 821 | try: |
| 822 | netloc_enc = netloc.encode("ascii") |
| 823 | except UnicodeEncodeError: |
| 824 | netloc_enc = netloc.encode("idna") |
| 825 | self.putheader('Host', netloc_enc) |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 826 | else: |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 827 | try: |
| 828 | host_enc = self.host.encode("ascii") |
| 829 | except UnicodeEncodeError: |
| 830 | host_enc = self.host.encode("idna") |
| 831 | if self.port == HTTP_PORT: |
| 832 | self.putheader('Host', host_enc) |
| 833 | else: |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 834 | host_enc = host_enc.decode("ascii") |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 835 | self.putheader('Host', "%s:%s" % (host_enc, self.port)) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 836 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 837 | # note: we are assuming that clients will not attempt to set these |
| 838 | # headers since *this* library must deal with the |
| 839 | # consequences. this also means that when the supporting |
| 840 | # libraries are updated to recognize other forms, then this |
| 841 | # code should be changed (removed or updated). |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 842 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 843 | # we only want a Content-Encoding of "identity" since we don't |
| 844 | # support encodings such as x-gzip or x-deflate. |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 845 | if not skip_accept_encoding: |
| 846 | self.putheader('Accept-Encoding', 'identity') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 847 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 848 | # we can accept "chunked" Transfer-Encodings, but no others |
| 849 | # NOTE: no TE header implies *only* "chunked" |
| 850 | #self.putheader('TE', 'chunked') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 851 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 852 | # if TE is supplied in the header, then it must appear in a |
| 853 | # Connection header. |
| 854 | #self.putheader('Connection', 'TE') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 855 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 856 | else: |
| 857 | # For HTTP/1.0, the server will assume "not chunked" |
| 858 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 859 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 860 | def putheader(self, header, value): |
| 861 | """Send a request header line to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 862 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 863 | For example: h.putheader('Accept', 'text/html') |
| 864 | """ |
| 865 | if self.__state != _CS_REQ_STARTED: |
| 866 | raise CannotSendHeader() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 867 | |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 868 | if hasattr(header, 'encode'): |
| 869 | header = header.encode('ascii') |
| 870 | if hasattr(value, 'encode'): |
| 871 | value = value.encode('ascii') |
| 872 | header = header + b': ' + value |
| 873 | self._output(header) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 874 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 875 | def endheaders(self): |
| 876 | """Indicate that the last header line has been sent to the server.""" |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 877 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 878 | if self.__state == _CS_REQ_STARTED: |
| 879 | self.__state = _CS_REQ_SENT |
| 880 | else: |
| 881 | raise CannotSendHeader() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 882 | |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 883 | self._send_output() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 884 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 885 | def request(self, method, url, body=None, headers={}): |
| 886 | """Send a complete request to the server.""" |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 887 | try: |
| 888 | self._send_request(method, url, body, headers) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 889 | except socket.error as v: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 890 | # trap 'Broken pipe' if we're allowed to automatically reconnect |
Guido van Rossum | 89df245 | 2007-03-19 22:26:27 +0000 | [diff] [blame] | 891 | if v.args[0] != 32 or not self.auto_open: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 892 | raise |
| 893 | # try one more time |
| 894 | self._send_request(method, url, body, headers) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 895 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 896 | def _send_request(self, method, url, body, headers): |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 897 | # honour explicitly requested Host: and Accept-Encoding headers |
| 898 | header_names = dict.fromkeys([k.lower() for k in headers]) |
| 899 | skips = {} |
| 900 | if 'host' in header_names: |
| 901 | skips['skip_host'] = 1 |
| 902 | if 'accept-encoding' in header_names: |
| 903 | skips['skip_accept_encoding'] = 1 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 904 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 905 | self.putrequest(method, url, **skips) |
| 906 | |
| 907 | if body and ('content-length' not in header_names): |
Jeremy Hylton | 4b878bd | 2007-08-10 18:49:01 +0000 | [diff] [blame] | 908 | thelen = None |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 909 | try: |
Jeremy Hylton | 4b878bd | 2007-08-10 18:49:01 +0000 | [diff] [blame] | 910 | thelen = str(len(body)) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 911 | except TypeError as te: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 912 | # If this is a file-like object, try to |
| 913 | # fstat its file descriptor |
| 914 | import os |
| 915 | try: |
| 916 | thelen = str(os.fstat(body.fileno()).st_size) |
| 917 | except (AttributeError, OSError): |
| 918 | # Don't send a length if this failed |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 919 | if self.debuglevel > 0: print("Cannot stat!!") |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 920 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 921 | if thelen is not None: |
| 922 | self.putheader('Content-Length',thelen) |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 923 | for hdr, value in headers.items(): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 924 | self.putheader(hdr, value) |
| 925 | self.endheaders() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 926 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 927 | if body: |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 928 | if isinstance(body, str): body = body.encode('ascii') |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 929 | self.send(body) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 930 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 931 | def getresponse(self): |
Jeremy Hylton | fb35f65 | 2007-08-03 20:30:33 +0000 | [diff] [blame] | 932 | """Get the response from the server.""" |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 933 | |
Greg Stein | 616a58d | 2003-06-24 06:35:19 +0000 | [diff] [blame] | 934 | # if a prior response has been completed, then forget about it. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 935 | if self.__response and self.__response.isclosed(): |
| 936 | self.__response = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 937 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 938 | # |
| 939 | # if a prior response exists, then it must be completed (otherwise, we |
| 940 | # cannot read this response's header to determine the connection-close |
| 941 | # behavior) |
| 942 | # |
| 943 | # note: if a prior response existed, but was connection-close, then the |
| 944 | # socket and response were made independent of this HTTPConnection |
| 945 | # object since a new request requires that we open a whole new |
| 946 | # connection |
| 947 | # |
| 948 | # this means the prior response had one of two states: |
| 949 | # 1) will_close: this connection was reset and the prior socket and |
| 950 | # response operate independently |
| 951 | # 2) persistent: the response was retained and we await its |
| 952 | # isclosed() status to become true. |
| 953 | # |
| 954 | if self.__state != _CS_REQ_SENT or self.__response: |
| 955 | raise ResponseNotReady() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 956 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 957 | if self.debuglevel > 0: |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 958 | response = self.response_class(self.sock, self.debuglevel, |
Tim Peters | c2659cf | 2003-05-12 20:19:37 +0000 | [diff] [blame] | 959 | strict=self.strict, |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 960 | method=self._method) |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 961 | else: |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 962 | response = self.response_class(self.sock, strict=self.strict, |
| 963 | method=self._method) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 964 | |
Jeremy Hylton | 39c0380 | 2002-07-12 14:04:09 +0000 | [diff] [blame] | 965 | response.begin() |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 966 | assert response.will_close != _UNKNOWN |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 967 | self.__state = _CS_IDLE |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 968 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 969 | if response.will_close: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 970 | # this effectively passes the connection to the response |
| 971 | self.close() |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 972 | else: |
| 973 | # remember this, so we can tell when it is complete |
| 974 | self.__response = response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 975 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 976 | return response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 977 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 978 | try: |
| 979 | import ssl |
| 980 | except ImportError: |
| 981 | pass |
| 982 | else: |
| 983 | class HTTPSConnection(HTTPConnection): |
| 984 | "This class allows communication via SSL." |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 985 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 986 | default_port = HTTPS_PORT |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 987 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 988 | def __init__(self, host, port=None, key_file=None, cert_file=None, |
| 989 | strict=None, timeout=None): |
| 990 | HTTPConnection.__init__(self, host, port, strict, timeout) |
| 991 | self.key_file = key_file |
| 992 | self.cert_file = cert_file |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 993 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 994 | def connect(self): |
| 995 | "Connect to a host on a given (SSL) port." |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 996 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 997 | sock = socket.create_connection((self.host, self.port), self.timeout) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 998 | self.sock = ssl.wrap_socket(sock, self.key_file, self.cert_file) |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 999 | |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1000 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1001 | def FakeSocket (sock, sslobj): |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 1002 | warnings.warn("FakeSocket is deprecated, and won't be in 3.x. " + |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1003 | "Use the result of ssl.wrap_socket() directly instead.", |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 1004 | DeprecationWarning, stacklevel=2) |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1005 | return sslobj |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1006 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1007 | __all__.append("HTTPSConnection") |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1008 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1009 | class HTTPException(Exception): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1010 | # Subclasses that define an __init__ must call Exception.__init__ |
| 1011 | # or define self.args. Otherwise, str() will fail. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1012 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1013 | |
| 1014 | class NotConnected(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1015 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1016 | |
Skip Montanaro | 9d38997 | 2002-03-24 16:53:50 +0000 | [diff] [blame] | 1017 | class InvalidURL(HTTPException): |
| 1018 | pass |
| 1019 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1020 | class UnknownProtocol(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1021 | def __init__(self, version): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1022 | self.args = version, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1023 | self.version = version |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1024 | |
| 1025 | class UnknownTransferEncoding(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1026 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1027 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1028 | class UnimplementedFileMode(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1029 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1030 | |
| 1031 | class IncompleteRead(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1032 | def __init__(self, partial): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1033 | self.args = partial, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1034 | self.partial = partial |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1035 | |
| 1036 | class ImproperConnectionState(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1037 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1038 | |
| 1039 | class CannotSendRequest(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1040 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1041 | |
| 1042 | class CannotSendHeader(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1043 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1044 | |
| 1045 | class ResponseNotReady(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1046 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1047 | |
| 1048 | class BadStatusLine(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1049 | def __init__(self, line): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1050 | self.args = line, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1051 | self.line = line |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1052 | |
| 1053 | # for backwards compatibility |
| 1054 | error = HTTPException |
| 1055 | |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1056 | class LineAndFileWrapper: |
| 1057 | """A limited file-like object for HTTP/0.9 responses.""" |
| 1058 | |
| 1059 | # The status-line parsing code calls readline(), which normally |
| 1060 | # get the HTTP status line. For a 0.9 response, however, this is |
| 1061 | # actually the first line of the body! Clients need to get a |
| 1062 | # readable file object that contains that line. |
| 1063 | |
| 1064 | def __init__(self, line, file): |
| 1065 | self._line = line |
| 1066 | self._file = file |
| 1067 | self._line_consumed = 0 |
| 1068 | self._line_offset = 0 |
| 1069 | self._line_left = len(line) |
| 1070 | |
| 1071 | def __getattr__(self, attr): |
| 1072 | return getattr(self._file, attr) |
| 1073 | |
| 1074 | def _done(self): |
| 1075 | # called when the last byte is read from the line. After the |
| 1076 | # call, all read methods are delegated to the underlying file |
Skip Montanaro | 74b9a7a | 2003-02-25 17:48:15 +0000 | [diff] [blame] | 1077 | # object. |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1078 | self._line_consumed = 1 |
| 1079 | self.read = self._file.read |
| 1080 | self.readline = self._file.readline |
| 1081 | self.readlines = self._file.readlines |
| 1082 | |
| 1083 | def read(self, amt=None): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1084 | if self._line_consumed: |
| 1085 | return self._file.read(amt) |
| 1086 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1087 | if amt is None or amt > self._line_left: |
| 1088 | s = self._line[self._line_offset:] |
| 1089 | self._done() |
| 1090 | if amt is None: |
| 1091 | return s + self._file.read() |
| 1092 | else: |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 1093 | return s + self._file.read(amt - len(s)) |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1094 | else: |
| 1095 | assert amt <= self._line_left |
| 1096 | i = self._line_offset |
| 1097 | j = i + amt |
| 1098 | s = self._line[i:j] |
| 1099 | self._line_offset = j |
| 1100 | self._line_left -= amt |
| 1101 | if self._line_left == 0: |
| 1102 | self._done() |
| 1103 | return s |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 1104 | |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1105 | def readline(self): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1106 | if self._line_consumed: |
| 1107 | return self._file.readline() |
| 1108 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1109 | s = self._line[self._line_offset:] |
| 1110 | self._done() |
| 1111 | return s |
| 1112 | |
| 1113 | def readlines(self, size=None): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1114 | if self._line_consumed: |
| 1115 | return self._file.readlines(size) |
| 1116 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1117 | L = [self._line[self._line_offset:]] |
| 1118 | self._done() |
| 1119 | if size is None: |
| 1120 | return L + self._file.readlines() |
| 1121 | else: |
| 1122 | return L + self._file.readlines(size) |