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 | fb35f65 | 2007-08-03 20:30:33 +0000 | [diff] [blame] | 69 | import io |
Jeremy Hylton | 6459c8d | 2001-10-11 17:47:22 +0000 | [diff] [blame] | 70 | import socket |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 71 | import email.parser |
| 72 | import email.message |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 73 | from urllib.parse 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 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 205 | class HTTPMessage(email.message.Message): |
| 206 | def getallmatchingheaders(self, name): |
| 207 | """Find all header lines matching a given header name. |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 208 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 209 | Look through the list of headers and find all lines matching a given |
| 210 | header name (and their continuation lines). A list of the lines is |
| 211 | returned, without interpretation. If the header does not occur, an |
| 212 | empty list is returned. If the header occurs multiple times, all |
| 213 | occurrences are returned. Case is not important in the header name. |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 214 | |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 215 | """ |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 216 | # XXX: copied from rfc822.Message for compatibility |
| 217 | name = name.lower() + ':' |
| 218 | n = len(name) |
| 219 | lst = [] |
| 220 | hit = 0 |
| 221 | for line in self.keys(): |
| 222 | if line[:n].lower() == name: |
| 223 | hit = 1 |
| 224 | elif not line[:1].isspace(): |
| 225 | hit = 0 |
| 226 | if hit: |
| 227 | lst.append(line) |
| 228 | return lst |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 229 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 230 | def parse_headers(fp): |
| 231 | """Parses only RFC2822 headers from a file pointer. |
| 232 | |
| 233 | email Parser wants to see strings rather than bytes. |
| 234 | But a TextIOWrapper around self.rfile would buffer too many bytes |
| 235 | from the stream, bytes which we later need to read as bytes. |
| 236 | So we read the correct bytes here, as bytes, for email Parser |
| 237 | to parse. |
| 238 | |
| 239 | """ |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 240 | headers = [] |
| 241 | while True: |
| 242 | line = fp.readline() |
| 243 | headers.append(line) |
| 244 | if line in (b'\r\n', b'\n', b''): |
| 245 | break |
| 246 | hstring = b''.join(headers).decode('iso-8859-1') |
| 247 | |
| 248 | return email.parser.Parser(_class=HTTPMessage).parsestr(hstring) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 249 | |
Antoine Pitrou | b353c12 | 2009-02-11 00:39:14 +0000 | [diff] [blame] | 250 | class HTTPResponse(io.RawIOBase): |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 251 | |
| 252 | # strict: If true, raise BadStatusLine if the status line can't be |
| 253 | # 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] | 254 | # false because it prevents clients from talking to HTTP/0.9 |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 255 | # servers. Note that a response with a sufficiently corrupted |
| 256 | # status line will look like an HTTP/0.9 response. |
| 257 | |
| 258 | # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details. |
| 259 | |
Jeremy Hylton | 811fc14 | 2007-08-03 13:30:02 +0000 | [diff] [blame] | 260 | # The bytes from the socket object are iso-8859-1 strings. |
| 261 | # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded |
| 262 | # text following RFC 2047. The basic status line parsing only |
| 263 | # accepts iso-8859-1. |
| 264 | |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 265 | def __init__(self, sock, debuglevel=0, strict=0, method=None): |
Kristján Valur Jónsson | 7e11b3f | 2009-02-02 16:04:04 +0000 | [diff] [blame] | 266 | # If the response includes a content-length header, we |
Jeremy Hylton | 39b198d | 2007-08-04 19:22:00 +0000 | [diff] [blame] | 267 | # need to make sure that the client doesn't read more than the |
| 268 | # specified number of bytes. If it does, it will block until |
| 269 | # the server times out and closes the connection. (The only |
Kristján Valur Jónsson | 7e11b3f | 2009-02-02 16:04:04 +0000 | [diff] [blame] | 270 | # applies to HTTP/1.1 connections.) This will happen if a self.fp.read() |
| 271 | # is done (without a size) whether self.fp is buffered or not. |
| 272 | # So, no self.fp.read() by clients unless they know what they are doing. |
Benjamin Peterson | f72d9fb | 2009-02-08 00:29:20 +0000 | [diff] [blame] | 273 | self.fp = sock.makefile("rb") |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 274 | self.debuglevel = debuglevel |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 275 | self.strict = strict |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 276 | self._method = method |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 277 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 278 | self.msg = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 279 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 280 | # from the Status-Line of the response |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 281 | self.version = _UNKNOWN # HTTP-Version |
| 282 | self.status = _UNKNOWN # Status-Code |
| 283 | self.reason = _UNKNOWN # Reason-Phrase |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 284 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 285 | self.chunked = _UNKNOWN # is "chunked" being used? |
| 286 | self.chunk_left = _UNKNOWN # bytes left to read in current chunk |
| 287 | self.length = _UNKNOWN # number of bytes left in response |
| 288 | self.will_close = _UNKNOWN # conn will close at end of response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 289 | |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 290 | def _read_status(self): |
Jeremy Hylton | 04319c7 | 2007-08-04 03:41:19 +0000 | [diff] [blame] | 291 | # Initialize with Simple-Response defaults. |
Jeremy Hylton | 811fc14 | 2007-08-03 13:30:02 +0000 | [diff] [blame] | 292 | line = str(self.fp.readline(), "iso-8859-1") |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 293 | if self.debuglevel > 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 294 | print("reply:", repr(line)) |
Jeremy Hylton | b676952 | 2003-06-29 17:55:05 +0000 | [diff] [blame] | 295 | if not line: |
| 296 | # Presumably, the server closed the connection before |
| 297 | # sending a valid response. |
| 298 | raise BadStatusLine(line) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 299 | try: |
Guido van Rossum | 34735a6 | 2000-12-15 15:09:42 +0000 | [diff] [blame] | 300 | [version, status, reason] = line.split(None, 2) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 301 | except ValueError: |
| 302 | try: |
Guido van Rossum | 34735a6 | 2000-12-15 15:09:42 +0000 | [diff] [blame] | 303 | [version, status] = line.split(None, 1) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 304 | reason = "" |
| 305 | except ValueError: |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 306 | # empty version will cause next test to fail and status |
| 307 | # will be treated as 0.9 response. |
| 308 | version = "" |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 309 | if not version.startswith("HTTP/"): |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 310 | if self.strict: |
| 311 | self.close() |
| 312 | raise BadStatusLine(line) |
| 313 | else: |
Jeremy Hylton | 04319c7 | 2007-08-04 03:41:19 +0000 | [diff] [blame] | 314 | # Assume it's a Simple-Response from an 0.9 server. |
| 315 | # We have to convert the first line back to raw bytes |
| 316 | # because self.fp.readline() needs to return bytes. |
Guido van Rossum | 70d0dda | 2007-08-29 01:53:26 +0000 | [diff] [blame] | 317 | self.fp = LineAndFileWrapper(bytes(line, "ascii"), self.fp) |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 318 | return "HTTP/0.9", 200, "" |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 319 | |
Jeremy Hylton | 23d4047 | 2001-04-13 14:57:08 +0000 | [diff] [blame] | 320 | # The status code is a three-digit number |
| 321 | try: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 322 | status = int(status) |
Jeremy Hylton | 23d4047 | 2001-04-13 14:57:08 +0000 | [diff] [blame] | 323 | if status < 100 or status > 999: |
| 324 | raise BadStatusLine(line) |
| 325 | except ValueError: |
| 326 | raise BadStatusLine(line) |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 327 | return version, status, reason |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 328 | |
Jeremy Hylton | 39c0380 | 2002-07-12 14:04:09 +0000 | [diff] [blame] | 329 | def begin(self): |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 330 | if self.msg is not None: |
| 331 | # we've already started reading the response |
| 332 | return |
| 333 | |
| 334 | # read until we get a non-100 response |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 335 | while True: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 336 | version, status, reason = self._read_status() |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 337 | if status != CONTINUE: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 338 | break |
| 339 | # skip the header from the 100 response |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 340 | while True: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 341 | skip = self.fp.readline().strip() |
| 342 | if not skip: |
| 343 | break |
| 344 | if self.debuglevel > 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 345 | print("header:", skip) |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 346 | |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 347 | self.status = status |
| 348 | self.reason = reason.strip() |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 349 | if version == "HTTP/1.0": |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 350 | self.version = 10 |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 351 | elif version.startswith("HTTP/1."): |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 352 | 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] | 353 | elif version == "HTTP/0.9": |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 354 | self.version = 9 |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 355 | else: |
| 356 | raise UnknownProtocol(version) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 357 | |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 358 | if self.version == 9: |
Georg Brandl | 0aade9a | 2005-06-26 22:06:54 +0000 | [diff] [blame] | 359 | self.length = None |
Jeremy Hylton | 236156f | 2008-12-15 03:00:50 +0000 | [diff] [blame] | 360 | self.chunked = False |
| 361 | self.will_close = True |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 362 | self.msg = email.message_from_string('') |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 363 | return |
| 364 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 365 | self.msg = parse_headers(self.fp) |
| 366 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 367 | if self.debuglevel > 0: |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 368 | for hdr in self.msg: |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 369 | print("header:", hdr, end=" ") |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 370 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 371 | # are we using the chunked-style of transfer encoding? |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 372 | tr_enc = self.msg.get("transfer-encoding") |
Jeremy Hylton | d229b3a | 2002-09-03 19:24:24 +0000 | [diff] [blame] | 373 | if tr_enc and tr_enc.lower() == "chunked": |
Jeremy Hylton | 236156f | 2008-12-15 03:00:50 +0000 | [diff] [blame] | 374 | self.chunked = True |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 375 | self.chunk_left = None |
| 376 | else: |
Jeremy Hylton | 236156f | 2008-12-15 03:00:50 +0000 | [diff] [blame] | 377 | self.chunked = False |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 378 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 379 | # will the connection close at the end of the response? |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 380 | self.will_close = self._check_close() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 381 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 382 | # do we have a Content-Length? |
| 383 | # 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] | 384 | self.length = None |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 385 | length = self.msg.get("content-length") |
| 386 | |
| 387 | # are we using the chunked-style of transfer encoding? |
| 388 | tr_enc = self.msg.get("transfer-encoding") |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 389 | if length and not self.chunked: |
Jeremy Hylton | 30a8181 | 2000-09-14 20:34:27 +0000 | [diff] [blame] | 390 | try: |
| 391 | self.length = int(length) |
| 392 | except ValueError: |
Christian Heimes | a612dc0 | 2008-02-24 13:08:18 +0000 | [diff] [blame] | 393 | self.length = None |
| 394 | else: |
| 395 | if self.length < 0: # ignore nonsensical negative lengths |
| 396 | self.length = None |
| 397 | else: |
| 398 | self.length = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 399 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 400 | # does the body have a fixed length? (of zero) |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 401 | if (status == NO_CONTENT or status == NOT_MODIFIED or |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 402 | 100 <= status < 200 or # 1xx codes |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 403 | self._method == "HEAD"): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 404 | self.length = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 405 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 406 | # if the connection remains open, and we aren't using chunked, and |
| 407 | # a content-length was not provided, then assume that the connection |
| 408 | # WILL close. |
Jeremy Hylton | 0ee5eeb | 2007-08-04 03:25:17 +0000 | [diff] [blame] | 409 | if (not self.will_close and |
| 410 | not self.chunked and |
| 411 | self.length is None): |
Jeremy Hylton | 236156f | 2008-12-15 03:00:50 +0000 | [diff] [blame] | 412 | self.will_close = True |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 413 | |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 414 | def _check_close(self): |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 415 | conn = self.msg.get("connection") |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 416 | if self.version == 11: |
| 417 | # An HTTP/1.1 proxy is assumed to stay open unless |
| 418 | # explicitly closed. |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 419 | conn = self.msg.get("connection") |
Raymond Hettinger | bac788a | 2004-05-04 09:21:43 +0000 | [diff] [blame] | 420 | if conn and "close" in conn.lower(): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 421 | return True |
| 422 | return False |
| 423 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 424 | # Some HTTP/1.0 implementations have support for persistent |
| 425 | # connections, using rules different than HTTP/1.1. |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 426 | |
Christian Heimes | 895627f | 2007-12-08 17:28:33 +0000 | [diff] [blame] | 427 | # For older HTTP, Keep-Alive indicates persistent connection. |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 428 | if self.msg.get("keep-alive"): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 429 | return False |
Tim Peters | 77c06fb | 2002-11-24 02:35:35 +0000 | [diff] [blame] | 430 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 431 | # At least Akamai returns a "Connection: Keep-Alive" header, |
| 432 | # which was supposed to be sent by the client. |
| 433 | if conn and "keep-alive" in conn.lower(): |
| 434 | return False |
| 435 | |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 436 | # Proxy-Connection is a netscape hack. |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 437 | pconn = self.msg.get("proxy-connection") |
Raymond Hettinger | bac788a | 2004-05-04 09:21:43 +0000 | [diff] [blame] | 438 | if pconn and "keep-alive" in pconn.lower(): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 439 | return False |
| 440 | |
| 441 | # otherwise, assume it will close |
| 442 | return True |
| 443 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 444 | def close(self): |
| 445 | if self.fp: |
| 446 | self.fp.close() |
| 447 | self.fp = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 448 | |
Jeremy Hylton | df5f6b5 | 2007-08-08 17:36:33 +0000 | [diff] [blame] | 449 | # These implementations are for the benefit of io.BufferedReader. |
| 450 | |
| 451 | # XXX This class should probably be revised to act more like |
| 452 | # the "raw stream" that BufferedReader expects. |
| 453 | |
| 454 | @property |
| 455 | def closed(self): |
| 456 | return self.isclosed() |
| 457 | |
| 458 | def flush(self): |
| 459 | self.fp.flush() |
| 460 | |
| 461 | # End of "raw stream" methods |
| 462 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 463 | def isclosed(self): |
| 464 | # NOTE: it is possible that we will not ever call self.close(). This |
| 465 | # case occurs when will_close is TRUE, length is None, and we |
| 466 | # read up to the last byte, but NOT past it. |
| 467 | # |
| 468 | # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be |
| 469 | # called, meaning self.isclosed() is meaningful. |
| 470 | return self.fp is None |
| 471 | |
| 472 | def read(self, amt=None): |
| 473 | if self.fp is None: |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 474 | return b"" |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 475 | |
| 476 | if self.chunked: |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 477 | return self._read_chunked(amt) |
Tim Peters | 230a60c | 2002-11-09 05:08:07 +0000 | [diff] [blame] | 478 | |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 479 | if amt is None: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 480 | # unbounded read |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 481 | if self.length is None: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 482 | s = self.fp.read() |
| 483 | else: |
| 484 | s = self._safe_read(self.length) |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 485 | self.length = 0 |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 486 | self.close() # we read everything |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 487 | return s |
| 488 | |
| 489 | if self.length is not None: |
| 490 | if amt > self.length: |
| 491 | # clip the read to the "end of response" |
| 492 | amt = self.length |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 493 | |
| 494 | # we do not use _safe_read() here because this may be a .will_close |
| 495 | # connection, and the user is reading more bytes than will be provided |
| 496 | # (for example, reading in 1k chunks) |
| 497 | s = self.fp.read(amt) |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 498 | if self.length is not None: |
| 499 | self.length -= len(s) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 500 | if not self.length: |
| 501 | self.close() |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 502 | return s |
| 503 | |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 504 | def _read_chunked(self, amt): |
| 505 | assert self.chunked != _UNKNOWN |
| 506 | chunk_left = self.chunk_left |
Georg Brandl | 95ba469 | 2008-01-26 09:45:58 +0000 | [diff] [blame] | 507 | value = b"" |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 508 | |
| 509 | # XXX This accumulates chunks by repeated string concatenation, |
| 510 | # 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] | 511 | while True: |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 512 | if chunk_left is None: |
| 513 | line = self.fp.readline() |
Georg Brandl | 95ba469 | 2008-01-26 09:45:58 +0000 | [diff] [blame] | 514 | i = line.find(b";") |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 515 | if i >= 0: |
| 516 | line = line[:i] # strip chunk-extensions |
Christian Heimes | a612dc0 | 2008-02-24 13:08:18 +0000 | [diff] [blame] | 517 | try: |
| 518 | chunk_left = int(line, 16) |
| 519 | except ValueError: |
| 520 | # close the connection as protocol synchronisation is |
| 521 | # probably lost |
| 522 | self.close() |
| 523 | raise IncompleteRead(value) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 524 | if chunk_left == 0: |
| 525 | break |
| 526 | if amt is None: |
| 527 | value += self._safe_read(chunk_left) |
| 528 | elif amt < chunk_left: |
| 529 | value += self._safe_read(amt) |
| 530 | self.chunk_left = chunk_left - amt |
| 531 | return value |
| 532 | elif amt == chunk_left: |
| 533 | value += self._safe_read(amt) |
| 534 | self._safe_read(2) # toss the CRLF at the end of the chunk |
| 535 | self.chunk_left = None |
| 536 | return value |
| 537 | else: |
| 538 | value += self._safe_read(chunk_left) |
| 539 | amt -= chunk_left |
| 540 | |
| 541 | # we read the whole chunk, get another |
| 542 | self._safe_read(2) # toss the CRLF at the end of the chunk |
| 543 | chunk_left = None |
| 544 | |
| 545 | # read and discard trailer up to the CRLF terminator |
| 546 | ### note: we shouldn't have any trailers! |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 547 | while True: |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 548 | line = self.fp.readline() |
Christian Heimes | 0bd4e11 | 2008-02-12 22:59:25 +0000 | [diff] [blame] | 549 | if not line: |
| 550 | # a vanishingly small number of sites EOF without |
| 551 | # sending the trailer |
| 552 | break |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 553 | if line == b"\r\n": |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 554 | break |
| 555 | |
| 556 | # we read everything; close the "file" |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 557 | self.close() |
| 558 | |
| 559 | return value |
Tim Peters | 230a60c | 2002-11-09 05:08:07 +0000 | [diff] [blame] | 560 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 561 | def _safe_read(self, amt): |
| 562 | """Read the number of bytes requested, compensating for partial reads. |
| 563 | |
| 564 | Normally, we have a blocking socket, but a read() can be interrupted |
| 565 | by a signal (resulting in a partial read). |
| 566 | |
| 567 | Note that we cannot distinguish between EOF and an interrupt when zero |
| 568 | bytes have been read. IncompleteRead() will be raised in this |
| 569 | situation. |
| 570 | |
| 571 | This function should be used when <amt> bytes "should" be present for |
| 572 | reading. If the bytes are truly not available (due to EOF), then the |
| 573 | IncompleteRead exception can be used to detect the problem. |
| 574 | """ |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 575 | s = [] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 576 | while amt > 0: |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 577 | chunk = self.fp.read(min(amt, MAXAMOUNT)) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 578 | if not chunk: |
Benjamin Peterson | 6accb98 | 2009-03-02 22:50:25 +0000 | [diff] [blame] | 579 | raise IncompleteRead(b''.join(s), amt) |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 580 | s.append(chunk) |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 581 | amt -= len(chunk) |
Guido van Rossum | a00f123 | 2007-09-12 19:43:09 +0000 | [diff] [blame] | 582 | return b"".join(s) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 583 | |
Antoine Pitrou | b353c12 | 2009-02-11 00:39:14 +0000 | [diff] [blame] | 584 | def fileno(self): |
| 585 | return self.fp.fileno() |
| 586 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 587 | def getheader(self, name, default=None): |
| 588 | if self.msg is None: |
| 589 | raise ResponseNotReady() |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 590 | return ', '.join(self.msg.get_all(name, default)) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 591 | |
Martin v. Löwis | deacce2 | 2004-08-18 12:46:26 +0000 | [diff] [blame] | 592 | def getheaders(self): |
| 593 | """Return list of (header, value) tuples.""" |
| 594 | if self.msg is None: |
| 595 | raise ResponseNotReady() |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 596 | return list(self.msg.items()) |
Martin v. Löwis | deacce2 | 2004-08-18 12:46:26 +0000 | [diff] [blame] | 597 | |
Antoine Pitrou | b353c12 | 2009-02-11 00:39:14 +0000 | [diff] [blame] | 598 | # We override IOBase.__iter__ so that it doesn't check for closed-ness |
| 599 | |
| 600 | def __iter__(self): |
| 601 | return self |
| 602 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 603 | |
| 604 | class HTTPConnection: |
| 605 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 606 | _http_vsn = 11 |
| 607 | _http_vsn_str = 'HTTP/1.1' |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 608 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 609 | response_class = HTTPResponse |
| 610 | default_port = HTTP_PORT |
| 611 | auto_open = 1 |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 612 | debuglevel = 0 |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 613 | strict = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 614 | |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 615 | def __init__(self, host, port=None, strict=None, |
| 616 | timeout=socket._GLOBAL_DEFAULT_TIMEOUT): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 617 | self.timeout = timeout |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 618 | self.sock = None |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 619 | self._buffer = [] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 620 | self.__response = None |
| 621 | self.__state = _CS_IDLE |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 622 | self._method = None |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 623 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 624 | self._set_hostport(host, port) |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 625 | if strict is not None: |
| 626 | self.strict = strict |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 627 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 628 | def _set_hostport(self, host, port): |
| 629 | if port is None: |
Skip Montanaro | 10e6e0e | 2004-09-14 16:32:02 +0000 | [diff] [blame] | 630 | i = host.rfind(':') |
Skip Montanaro | cae14d2 | 2004-09-14 17:55:21 +0000 | [diff] [blame] | 631 | j = host.rfind(']') # ipv6 addresses have [...] |
| 632 | if i > j: |
Skip Montanaro | 9d38997 | 2002-03-24 16:53:50 +0000 | [diff] [blame] | 633 | try: |
| 634 | port = int(host[i+1:]) |
| 635 | except ValueError: |
Jeremy Hylton | fbd7994 | 2002-07-02 20:19:08 +0000 | [diff] [blame] | 636 | raise InvalidURL("nonnumeric port: '%s'" % host[i+1:]) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 637 | host = host[:i] |
| 638 | else: |
| 639 | port = self.default_port |
Raymond Hettinger | 4d03791 | 2004-10-14 15:23:38 +0000 | [diff] [blame] | 640 | if host and host[0] == '[' and host[-1] == ']': |
Brett Cannon | 0a1af4a | 2004-09-15 23:26:23 +0000 | [diff] [blame] | 641 | host = host[1:-1] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 642 | self.host = host |
| 643 | self.port = port |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 644 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 645 | def set_debuglevel(self, level): |
| 646 | self.debuglevel = level |
| 647 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 648 | def connect(self): |
| 649 | """Connect to the host and port specified in __init__.""" |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 650 | self.sock = socket.create_connection((self.host,self.port), |
| 651 | self.timeout) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 652 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 653 | def close(self): |
| 654 | """Close the connection to the HTTP server.""" |
| 655 | if self.sock: |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 656 | self.sock.close() # close it manually... there may be other refs |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 657 | self.sock = None |
| 658 | if self.__response: |
| 659 | self.__response.close() |
| 660 | self.__response = None |
| 661 | self.__state = _CS_IDLE |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 662 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 663 | def send(self, str): |
| 664 | """Send `str' to the server.""" |
| 665 | if self.sock is None: |
| 666 | if self.auto_open: |
| 667 | self.connect() |
| 668 | else: |
| 669 | raise NotConnected() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 670 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 671 | # 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] | 672 | # the socket. we want to reconnect when somebody tries to send again. |
| 673 | # |
| 674 | # NOTE: we DO propagate the error, though, because we cannot simply |
| 675 | # ignore the error... the caller will know if they can retry. |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 676 | if self.debuglevel > 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 677 | print("send:", repr(str)) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 678 | try: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 679 | blocksize=8192 |
| 680 | if hasattr(str,'read') : |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 681 | if self.debuglevel > 0: print("sendIng a read()able") |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 682 | data=str.read(blocksize) |
| 683 | while data: |
| 684 | self.sock.sendall(data) |
| 685 | data=str.read(blocksize) |
| 686 | else: |
| 687 | self.sock.sendall(str) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 688 | except socket.error as v: |
Guido van Rossum | 89df245 | 2007-03-19 22:26:27 +0000 | [diff] [blame] | 689 | if v.args[0] == 32: # Broken pipe |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 690 | self.close() |
| 691 | raise |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 692 | |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 693 | def _output(self, s): |
| 694 | """Add a line of output to the current request buffer. |
Tim Peters | 469cdad | 2002-08-08 20:19:19 +0000 | [diff] [blame] | 695 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 696 | Assumes that the line does *not* end with \\r\\n. |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 697 | """ |
| 698 | self._buffer.append(s) |
| 699 | |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 700 | def _send_output(self, message_body=None): |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 701 | """Send the currently buffered request and clear the buffer. |
| 702 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 703 | Appends an extra \\r\\n to the buffer. |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 704 | A message_body may be specified, to be appended to the request. |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 705 | """ |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 706 | self._buffer.extend((b"", b"")) |
| 707 | msg = b"\r\n".join(self._buffer) |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 708 | del self._buffer[:] |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 709 | # If msg and message_body are sent in a single send() call, |
| 710 | # it will avoid performance problems caused by the interaction |
| 711 | # between delayed ack and the Nagle algorithim. |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 712 | if isinstance(message_body, bytes): |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 713 | msg += message_body |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 714 | message_body = None |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 715 | self.send(msg) |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 716 | if message_body is not None: |
| 717 | #message_body was not a string (i.e. it is a file) and |
| 718 | #we must run the risk of Nagle |
| 719 | self.send(message_body) |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 720 | |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 721 | def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 722 | """Send a request to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 723 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 724 | `method' specifies an HTTP request method, e.g. 'GET'. |
| 725 | `url' specifies the object being requested, e.g. '/index.html'. |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 726 | `skip_host' if True does not add automatically a 'Host:' header |
| 727 | `skip_accept_encoding' if True does not add automatically an |
| 728 | 'Accept-Encoding:' header |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 729 | """ |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 730 | |
Greg Stein | 616a58d | 2003-06-24 06:35:19 +0000 | [diff] [blame] | 731 | # if a prior response has been completed, then forget about it. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 732 | if self.__response and self.__response.isclosed(): |
| 733 | self.__response = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 734 | |
Tim Peters | 58eb11c | 2004-01-18 20:29:55 +0000 | [diff] [blame] | 735 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 736 | # in certain cases, we cannot issue another request on this connection. |
| 737 | # this occurs when: |
| 738 | # 1) we are in the process of sending a request. (_CS_REQ_STARTED) |
| 739 | # 2) a response to a previous request has signalled that it is going |
| 740 | # to close the connection upon completion. |
| 741 | # 3) the headers for the previous response have not been read, thus |
| 742 | # we cannot determine whether point (2) is true. (_CS_REQ_SENT) |
| 743 | # |
| 744 | # if there is no prior response, then we can request at will. |
| 745 | # |
| 746 | # if point (2) is true, then we will have passed the socket to the |
| 747 | # response (effectively meaning, "there is no prior response"), and |
| 748 | # will open a new one when a new request is made. |
| 749 | # |
| 750 | # Note: if a prior response exists, then we *can* start a new request. |
| 751 | # We are not allowed to begin fetching the response to this new |
| 752 | # request, however, until that prior response is complete. |
| 753 | # |
| 754 | if self.__state == _CS_IDLE: |
| 755 | self.__state = _CS_REQ_STARTED |
| 756 | else: |
| 757 | raise CannotSendRequest() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 758 | |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 759 | # Save the method we use, we need it later in the response phase |
| 760 | self._method = method |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 761 | if not url: |
| 762 | url = '/' |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 763 | request = '%s %s %s' % (method, url, self._http_vsn_str) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 764 | |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 765 | # Non-ASCII characters should have been eliminated earlier |
| 766 | self._output(request.encode('ascii')) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 767 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 768 | if self._http_vsn == 11: |
| 769 | # Issue some standard headers for better HTTP/1.1 compliance |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 770 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 771 | if not skip_host: |
| 772 | # this header is issued *only* for HTTP/1.1 |
| 773 | # connections. more specifically, this means it is |
| 774 | # only issued when the client uses the new |
| 775 | # HTTPConnection() class. backwards-compat clients |
| 776 | # will be using HTTP/1.0 and those clients may be |
| 777 | # issuing this header themselves. we should NOT issue |
| 778 | # it twice; some web servers (such as Apache) barf |
| 779 | # when they see two Host: headers |
Guido van Rossum | f6922aa | 2001-01-14 21:03:01 +0000 | [diff] [blame] | 780 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 781 | # If we need a non-standard port,include it in the |
| 782 | # header. If the request is going through a proxy, |
| 783 | # but the host of the actual URL, not the host of the |
| 784 | # proxy. |
Jeremy Hylton | 8acf1e0 | 2002-03-08 19:35:51 +0000 | [diff] [blame] | 785 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 786 | netloc = '' |
| 787 | if url.startswith('http'): |
| 788 | nil, netloc, nil, nil, nil = urlsplit(url) |
| 789 | |
| 790 | if netloc: |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 791 | try: |
| 792 | netloc_enc = netloc.encode("ascii") |
| 793 | except UnicodeEncodeError: |
| 794 | netloc_enc = netloc.encode("idna") |
| 795 | self.putheader('Host', netloc_enc) |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 796 | else: |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 797 | try: |
| 798 | host_enc = self.host.encode("ascii") |
| 799 | except UnicodeEncodeError: |
| 800 | host_enc = self.host.encode("idna") |
Georg Brandl | 86b2fb9 | 2008-07-16 03:43:04 +0000 | [diff] [blame] | 801 | if self.port == self.default_port: |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 802 | self.putheader('Host', host_enc) |
| 803 | else: |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 804 | host_enc = host_enc.decode("ascii") |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 805 | self.putheader('Host', "%s:%s" % (host_enc, self.port)) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 806 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 807 | # note: we are assuming that clients will not attempt to set these |
| 808 | # headers since *this* library must deal with the |
| 809 | # consequences. this also means that when the supporting |
| 810 | # libraries are updated to recognize other forms, then this |
| 811 | # code should be changed (removed or updated). |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 812 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 813 | # we only want a Content-Encoding of "identity" since we don't |
| 814 | # support encodings such as x-gzip or x-deflate. |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 815 | if not skip_accept_encoding: |
| 816 | self.putheader('Accept-Encoding', 'identity') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 817 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 818 | # we can accept "chunked" Transfer-Encodings, but no others |
| 819 | # NOTE: no TE header implies *only* "chunked" |
| 820 | #self.putheader('TE', 'chunked') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 821 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 822 | # if TE is supplied in the header, then it must appear in a |
| 823 | # Connection header. |
| 824 | #self.putheader('Connection', 'TE') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 825 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 826 | else: |
| 827 | # For HTTP/1.0, the server will assume "not chunked" |
| 828 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 829 | |
Benjamin Peterson | f608c61 | 2008-11-16 18:33:53 +0000 | [diff] [blame] | 830 | def putheader(self, header, *values): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 831 | """Send a request header line to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 832 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 833 | For example: h.putheader('Accept', 'text/html') |
| 834 | """ |
| 835 | if self.__state != _CS_REQ_STARTED: |
| 836 | raise CannotSendHeader() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 837 | |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 838 | if hasattr(header, 'encode'): |
| 839 | header = header.encode('ascii') |
Benjamin Peterson | f608c61 | 2008-11-16 18:33:53 +0000 | [diff] [blame] | 840 | values = list(values) |
| 841 | for i, one_value in enumerate(values): |
| 842 | if hasattr(one_value, 'encode'): |
| 843 | values[i] = one_value.encode('ascii') |
| 844 | value = b'\r\n\t'.join(values) |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 845 | header = header + b': ' + value |
| 846 | self._output(header) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 847 | |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 848 | def endheaders(self, message_body=None): |
| 849 | """Indicate that the last header line has been sent to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 850 | |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 851 | This method sends the request to the server. The optional |
| 852 | message_body argument can be used to pass message body |
| 853 | associated with the request. The message body will be sent in |
| 854 | the same packet as the message headers if possible. The |
| 855 | message_body should be a string. |
| 856 | """ |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 857 | if self.__state == _CS_REQ_STARTED: |
| 858 | self.__state = _CS_REQ_SENT |
| 859 | else: |
| 860 | raise CannotSendHeader() |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 861 | self._send_output(message_body) |
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 | def request(self, method, url, body=None, headers={}): |
| 864 | """Send a complete request to the server.""" |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 865 | try: |
| 866 | self._send_request(method, url, body, headers) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 867 | except socket.error as v: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 868 | # trap 'Broken pipe' if we're allowed to automatically reconnect |
Guido van Rossum | 89df245 | 2007-03-19 22:26:27 +0000 | [diff] [blame] | 869 | if v.args[0] != 32 or not self.auto_open: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 870 | raise |
| 871 | # try one more time |
| 872 | self._send_request(method, url, body, headers) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 873 | |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 874 | def _set_content_length(self, body): |
| 875 | # Set the content-length based on the body. |
| 876 | thelen = None |
| 877 | try: |
| 878 | thelen = str(len(body)) |
| 879 | except TypeError as te: |
| 880 | # If this is a file-like object, try to |
| 881 | # fstat its file descriptor |
| 882 | import os |
| 883 | try: |
| 884 | thelen = str(os.fstat(body.fileno()).st_size) |
| 885 | except (AttributeError, OSError): |
| 886 | # Don't send a length if this failed |
| 887 | if self.debuglevel > 0: print("Cannot stat!!") |
| 888 | |
| 889 | if thelen is not None: |
| 890 | self.putheader('Content-Length', thelen) |
| 891 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 892 | def _send_request(self, method, url, body, headers): |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 893 | # honour explicitly requested Host: and Accept-Encoding headers |
| 894 | header_names = dict.fromkeys([k.lower() for k in headers]) |
| 895 | skips = {} |
| 896 | if 'host' in header_names: |
| 897 | skips['skip_host'] = 1 |
| 898 | if 'accept-encoding' in header_names: |
| 899 | skips['skip_accept_encoding'] = 1 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 900 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 901 | self.putrequest(method, url, **skips) |
| 902 | |
| 903 | if body and ('content-length' not in header_names): |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 904 | self._set_content_length(body) |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 905 | for hdr, value in headers.items(): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 906 | self.putheader(hdr, value) |
Jeremy Hylton | ef9f48e | 2009-03-26 22:04:05 +0000 | [diff] [blame] | 907 | if isinstance(body, str): |
| 908 | body = body.encode('ascii') |
| 909 | self.endheaders(body) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 910 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 911 | def getresponse(self): |
Jeremy Hylton | fb35f65 | 2007-08-03 20:30:33 +0000 | [diff] [blame] | 912 | """Get the response from the server.""" |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 913 | |
Greg Stein | 616a58d | 2003-06-24 06:35:19 +0000 | [diff] [blame] | 914 | # if a prior response has been completed, then forget about it. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 915 | if self.__response and self.__response.isclosed(): |
| 916 | self.__response = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 917 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 918 | # |
| 919 | # if a prior response exists, then it must be completed (otherwise, we |
| 920 | # cannot read this response's header to determine the connection-close |
| 921 | # behavior) |
| 922 | # |
| 923 | # note: if a prior response existed, but was connection-close, then the |
| 924 | # socket and response were made independent of this HTTPConnection |
| 925 | # object since a new request requires that we open a whole new |
| 926 | # connection |
| 927 | # |
| 928 | # this means the prior response had one of two states: |
| 929 | # 1) will_close: this connection was reset and the prior socket and |
| 930 | # response operate independently |
| 931 | # 2) persistent: the response was retained and we await its |
| 932 | # isclosed() status to become true. |
| 933 | # |
| 934 | if self.__state != _CS_REQ_SENT or self.__response: |
| 935 | raise ResponseNotReady() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 936 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 937 | if self.debuglevel > 0: |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 938 | response = self.response_class(self.sock, self.debuglevel, |
Tim Peters | c2659cf | 2003-05-12 20:19:37 +0000 | [diff] [blame] | 939 | strict=self.strict, |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 940 | method=self._method) |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 941 | else: |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 942 | response = self.response_class(self.sock, strict=self.strict, |
| 943 | method=self._method) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 944 | |
Jeremy Hylton | 39c0380 | 2002-07-12 14:04:09 +0000 | [diff] [blame] | 945 | response.begin() |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 946 | assert response.will_close != _UNKNOWN |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 947 | self.__state = _CS_IDLE |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 948 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 949 | if response.will_close: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 950 | # this effectively passes the connection to the response |
| 951 | self.close() |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 952 | else: |
| 953 | # remember this, so we can tell when it is complete |
| 954 | self.__response = response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 955 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 956 | return response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 957 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 958 | try: |
| 959 | import ssl |
| 960 | except ImportError: |
| 961 | pass |
| 962 | else: |
| 963 | class HTTPSConnection(HTTPConnection): |
| 964 | "This class allows communication via SSL." |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 965 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 966 | default_port = HTTPS_PORT |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 967 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 968 | def __init__(self, host, port=None, key_file=None, cert_file=None, |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 969 | strict=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT): |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 970 | HTTPConnection.__init__(self, host, port, strict, timeout) |
| 971 | self.key_file = key_file |
| 972 | self.cert_file = cert_file |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 973 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 974 | def connect(self): |
| 975 | "Connect to a host on a given (SSL) port." |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 976 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 977 | sock = socket.create_connection((self.host, self.port), self.timeout) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 978 | self.sock = ssl.wrap_socket(sock, self.key_file, self.cert_file) |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 979 | |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 980 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 981 | def FakeSocket (sock, sslobj): |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 982 | warnings.warn("FakeSocket is deprecated, and won't be in 3.x. " + |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 983 | "Use the result of ssl.wrap_socket() directly instead.", |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 984 | DeprecationWarning, stacklevel=2) |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 985 | return sslobj |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 986 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 987 | __all__.append("HTTPSConnection") |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 988 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 989 | class HTTPException(Exception): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 990 | # Subclasses that define an __init__ must call Exception.__init__ |
| 991 | # or define self.args. Otherwise, str() will fail. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 992 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 993 | |
| 994 | class NotConnected(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 995 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 996 | |
Skip Montanaro | 9d38997 | 2002-03-24 16:53:50 +0000 | [diff] [blame] | 997 | class InvalidURL(HTTPException): |
| 998 | pass |
| 999 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1000 | class UnknownProtocol(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1001 | def __init__(self, version): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1002 | self.args = version, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1003 | self.version = version |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1004 | |
| 1005 | class UnknownTransferEncoding(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1006 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1007 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1008 | class UnimplementedFileMode(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1009 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1010 | |
| 1011 | class IncompleteRead(HTTPException): |
Benjamin Peterson | 6accb98 | 2009-03-02 22:50:25 +0000 | [diff] [blame] | 1012 | def __init__(self, partial, expected=None): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1013 | self.args = partial, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1014 | self.partial = partial |
Benjamin Peterson | 6accb98 | 2009-03-02 22:50:25 +0000 | [diff] [blame] | 1015 | self.expected = expected |
| 1016 | def __repr__(self): |
| 1017 | if self.expected is not None: |
| 1018 | e = ', %i more expected' % self.expected |
| 1019 | else: |
| 1020 | e = '' |
| 1021 | return 'IncompleteRead(%i bytes read%s)' % (len(self.partial), e) |
| 1022 | def __str__(self): |
| 1023 | return repr(self) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1024 | |
| 1025 | class ImproperConnectionState(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 | |
| 1028 | class CannotSendRequest(ImproperConnectionState): |
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 CannotSendHeader(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1032 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1033 | |
| 1034 | class ResponseNotReady(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1035 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1036 | |
| 1037 | class BadStatusLine(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1038 | def __init__(self, line): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1039 | self.args = line, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1040 | self.line = line |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1041 | |
| 1042 | # for backwards compatibility |
| 1043 | error = HTTPException |
| 1044 | |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1045 | class LineAndFileWrapper: |
| 1046 | """A limited file-like object for HTTP/0.9 responses.""" |
| 1047 | |
| 1048 | # The status-line parsing code calls readline(), which normally |
| 1049 | # get the HTTP status line. For a 0.9 response, however, this is |
| 1050 | # actually the first line of the body! Clients need to get a |
| 1051 | # readable file object that contains that line. |
| 1052 | |
| 1053 | def __init__(self, line, file): |
| 1054 | self._line = line |
| 1055 | self._file = file |
| 1056 | self._line_consumed = 0 |
| 1057 | self._line_offset = 0 |
| 1058 | self._line_left = len(line) |
| 1059 | |
| 1060 | def __getattr__(self, attr): |
| 1061 | return getattr(self._file, attr) |
| 1062 | |
| 1063 | def _done(self): |
| 1064 | # called when the last byte is read from the line. After the |
| 1065 | # call, all read methods are delegated to the underlying file |
Skip Montanaro | 74b9a7a | 2003-02-25 17:48:15 +0000 | [diff] [blame] | 1066 | # object. |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1067 | self._line_consumed = 1 |
| 1068 | self.read = self._file.read |
| 1069 | self.readline = self._file.readline |
| 1070 | self.readlines = self._file.readlines |
| 1071 | |
| 1072 | def read(self, amt=None): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1073 | if self._line_consumed: |
| 1074 | return self._file.read(amt) |
| 1075 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1076 | if amt is None or amt > self._line_left: |
| 1077 | s = self._line[self._line_offset:] |
| 1078 | self._done() |
| 1079 | if amt is None: |
| 1080 | return s + self._file.read() |
| 1081 | else: |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 1082 | return s + self._file.read(amt - len(s)) |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1083 | else: |
| 1084 | assert amt <= self._line_left |
| 1085 | i = self._line_offset |
| 1086 | j = i + amt |
| 1087 | s = self._line[i:j] |
| 1088 | self._line_offset = j |
| 1089 | self._line_left -= amt |
| 1090 | if self._line_left == 0: |
| 1091 | self._done() |
| 1092 | return s |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 1093 | |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1094 | def readline(self): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1095 | if self._line_consumed: |
| 1096 | return self._file.readline() |
| 1097 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1098 | s = self._line[self._line_offset:] |
| 1099 | self._done() |
| 1100 | return s |
| 1101 | |
| 1102 | def readlines(self, size=None): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1103 | if self._line_consumed: |
| 1104 | return self._file.readlines(size) |
| 1105 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1106 | L = [self._line[self._line_offset:]] |
| 1107 | self._done() |
| 1108 | if size is None: |
| 1109 | return L + self._file.readlines() |
| 1110 | else: |
| 1111 | return L + self._file.readlines(size) |