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