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 |
R David Murray | cae7bdb | 2015-04-05 19:26:29 -0400 | [diff] [blame] | 23 | |\_____________________________ |
| 24 | | | getresponse() raises |
| 25 | | response = getresponse() | ConnectionError |
| 26 | v v |
| 27 | Unread-response Idle |
| 28 | [Response-headers-read] |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 29 | |\____________________ |
Tim Peters | 5ceadc8 | 2001-01-13 19:16:21 +0000 | [diff] [blame] | 30 | | | |
| 31 | | response.read() | putrequest() |
| 32 | v v |
| 33 | Idle Req-started-unread-response |
| 34 | ______/| |
| 35 | / | |
| 36 | response.read() | | ( putheader() )* endheaders() |
| 37 | v v |
| 38 | Request-started Req-sent-unread-response |
| 39 | | |
| 40 | | response.read() |
| 41 | v |
| 42 | Request-sent |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 43 | |
| 44 | This diagram presents the following rules: |
| 45 | -- a second request may not be started until {response-headers-read} |
| 46 | -- a response [object] cannot be retrieved until {request-sent} |
| 47 | -- there is no differentiation between an unread response body and a |
| 48 | partially read response body |
| 49 | |
| 50 | Note: this enforcement is applied by the HTTPConnection class. The |
| 51 | HTTPResponse class does not enforce this state machine, which |
| 52 | implies sophisticated clients may accelerate the request/response |
| 53 | pipeline. Caution should be taken, though: accelerating the states |
| 54 | beyond the above pattern may imply knowledge of the server's |
| 55 | connection-close behavior for certain requests. For example, it |
| 56 | is impossible to tell whether the server will close the connection |
| 57 | UNTIL the response headers have been read; this means that further |
| 58 | requests cannot be placed into the pipeline until it is known that |
| 59 | the server will NOT be closing the connection. |
| 60 | |
| 61 | Logical State __state __response |
| 62 | ------------- ------- ---------- |
| 63 | Idle _CS_IDLE None |
| 64 | Request-started _CS_REQ_STARTED None |
| 65 | Request-sent _CS_REQ_SENT None |
| 66 | Unread-response _CS_IDLE <response_class> |
| 67 | Req-started-unread-response _CS_REQ_STARTED <response_class> |
| 68 | Req-sent-unread-response _CS_REQ_SENT <response_class> |
Guido van Rossum | 41999c1 | 1997-12-09 00:12:23 +0000 | [diff] [blame] | 69 | """ |
Guido van Rossum | 23acc95 | 1994-02-21 16:36:04 +0000 | [diff] [blame] | 70 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 71 | import email.parser |
| 72 | import email.message |
Serhiy Storchaka | e4db769 | 2014-12-23 16:28:28 +0200 | [diff] [blame] | 73 | import http |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 74 | import io |
| 75 | import os |
Serhiy Storchaka | a112a8a | 2015-03-12 11:13:36 +0200 | [diff] [blame] | 76 | import re |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 77 | import socket |
Senthil Kumaran | 7bc0d87 | 2010-12-19 10:49:52 +0000 | [diff] [blame] | 78 | import collections |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 79 | from urllib.parse import urlsplit |
Guido van Rossum | 23acc95 | 1994-02-21 16:36:04 +0000 | [diff] [blame] | 80 | |
Berker Peksag | babc688 | 2015-02-20 09:39:38 +0200 | [diff] [blame] | 81 | # HTTPMessage, parse_headers(), and the HTTP status code constants are |
| 82 | # intentionally omitted for simplicity |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 83 | __all__ = ["HTTPResponse", "HTTPConnection", |
Skip Montanaro | 951a884 | 2001-06-01 16:25:38 +0000 | [diff] [blame] | 84 | "HTTPException", "NotConnected", "UnknownProtocol", |
Jeremy Hylton | 7c75c99 | 2002-06-28 23:38:14 +0000 | [diff] [blame] | 85 | "UnknownTransferEncoding", "UnimplementedFileMode", |
| 86 | "IncompleteRead", "InvalidURL", "ImproperConnectionState", |
| 87 | "CannotSendRequest", "CannotSendHeader", "ResponseNotReady", |
R David Murray | cae7bdb | 2015-04-05 19:26:29 -0400 | [diff] [blame] | 88 | "BadStatusLine", "LineTooLong", "RemoteDisconnected", "error", |
| 89 | "responses"] |
Skip Montanaro | 2dd4276 | 2001-01-23 15:35:05 +0000 | [diff] [blame] | 90 | |
Guido van Rossum | 23acc95 | 1994-02-21 16:36:04 +0000 | [diff] [blame] | 91 | HTTP_PORT = 80 |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 92 | HTTPS_PORT = 443 |
| 93 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 94 | _UNKNOWN = 'UNKNOWN' |
| 95 | |
| 96 | # connection states |
| 97 | _CS_IDLE = 'Idle' |
| 98 | _CS_REQ_STARTED = 'Request-started' |
| 99 | _CS_REQ_SENT = 'Request-sent' |
| 100 | |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 101 | |
Serhiy Storchaka | e4db769 | 2014-12-23 16:28:28 +0200 | [diff] [blame] | 102 | # hack to maintain backwards compatibility |
| 103 | globals().update(http.HTTPStatus.__members__) |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 104 | |
Serhiy Storchaka | e4db769 | 2014-12-23 16:28:28 +0200 | [diff] [blame] | 105 | # another hack to maintain backwards compatibility |
Georg Brandl | 6aab16e | 2006-02-17 19:17:25 +0000 | [diff] [blame] | 106 | # Mapping status codes to official W3C names |
Serhiy Storchaka | e4db769 | 2014-12-23 16:28:28 +0200 | [diff] [blame] | 107 | responses = {v: v.phrase for v in http.HTTPStatus.__members__.values()} |
Georg Brandl | 6aab16e | 2006-02-17 19:17:25 +0000 | [diff] [blame] | 108 | |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 109 | # maximal amount of data to read at one time in _safe_read |
| 110 | MAXAMOUNT = 1048576 |
| 111 | |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 112 | # maximal line length when calling readline(). |
| 113 | _MAXLINE = 65536 |
Georg Brandl | bf3f8eb | 2013-10-27 07:34:48 +0100 | [diff] [blame] | 114 | _MAXHEADERS = 100 |
| 115 | |
Serhiy Storchaka | a112a8a | 2015-03-12 11:13:36 +0200 | [diff] [blame] | 116 | # Header name/value ABNF (http://tools.ietf.org/html/rfc7230#section-3.2) |
| 117 | # |
| 118 | # VCHAR = %x21-7E |
| 119 | # obs-text = %x80-FF |
| 120 | # header-field = field-name ":" OWS field-value OWS |
| 121 | # field-name = token |
| 122 | # field-value = *( field-content / obs-fold ) |
| 123 | # field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ] |
| 124 | # field-vchar = VCHAR / obs-text |
| 125 | # |
| 126 | # obs-fold = CRLF 1*( SP / HTAB ) |
| 127 | # ; obsolete line folding |
| 128 | # ; see Section 3.2.4 |
| 129 | |
| 130 | # token = 1*tchar |
| 131 | # |
| 132 | # tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" |
| 133 | # / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~" |
| 134 | # / DIGIT / ALPHA |
| 135 | # ; any VCHAR, except delimiters |
| 136 | # |
| 137 | # VCHAR defined in http://tools.ietf.org/html/rfc5234#appendix-B.1 |
| 138 | |
| 139 | # the patterns for both name and value are more leniant than RFC |
| 140 | # definitions to allow for backwards compatibility |
| 141 | _is_legal_header_name = re.compile(rb'[^:\s][^:\r\n]*').fullmatch |
| 142 | _is_illegal_header_value = re.compile(rb'\n(?![ \t])|\r(?![ \t\n])').search |
| 143 | |
R David Murray | beed840 | 2015-03-22 15:18:23 -0400 | [diff] [blame] | 144 | # We always set the Content-Length header for these methods because some |
| 145 | # servers will otherwise respond with a 411 |
| 146 | _METHODS_EXPECTING_BODY = {'PATCH', 'POST', 'PUT'} |
| 147 | |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 148 | |
Martin Panter | 4439148 | 2016-02-09 10:20:52 +0000 | [diff] [blame] | 149 | def _encode(data, name='data'): |
| 150 | """Call data.encode("latin-1") but show a better error message.""" |
| 151 | try: |
| 152 | return data.encode("latin-1") |
| 153 | except UnicodeEncodeError as err: |
| 154 | raise UnicodeEncodeError( |
| 155 | err.encoding, |
| 156 | err.object, |
| 157 | err.start, |
| 158 | err.end, |
| 159 | "%s (%.20r) is not valid Latin-1. Use %s.encode('utf-8') " |
| 160 | "if you want to send it encoded in UTF-8." % |
| 161 | (name.title(), data[err.start:err.end], name)) from None |
| 162 | |
| 163 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 164 | class HTTPMessage(email.message.Message): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 165 | # XXX The only usage of this method is in |
| 166 | # http.server.CGIHTTPRequestHandler. Maybe move the code there so |
| 167 | # that it doesn't need to be part of the public API. The API has |
| 168 | # never been defined so this could cause backwards compatibility |
| 169 | # issues. |
| 170 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 171 | def getallmatchingheaders(self, name): |
| 172 | """Find all header lines matching a given header name. |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 173 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 174 | Look through the list of headers and find all lines matching a given |
| 175 | header name (and their continuation lines). A list of the lines is |
| 176 | returned, without interpretation. If the header does not occur, an |
| 177 | empty list is returned. If the header occurs multiple times, all |
| 178 | occurrences are returned. Case is not important in the header name. |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 179 | |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 180 | """ |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 181 | name = name.lower() + ':' |
| 182 | n = len(name) |
| 183 | lst = [] |
| 184 | hit = 0 |
| 185 | for line in self.keys(): |
| 186 | if line[:n].lower() == name: |
| 187 | hit = 1 |
| 188 | elif not line[:1].isspace(): |
| 189 | hit = 0 |
| 190 | if hit: |
| 191 | lst.append(line) |
| 192 | return lst |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 193 | |
Jeremy Hylton | 98eb6c2 | 2009-03-27 18:31:36 +0000 | [diff] [blame] | 194 | def parse_headers(fp, _class=HTTPMessage): |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 195 | """Parses only RFC2822 headers from a file pointer. |
| 196 | |
| 197 | email Parser wants to see strings rather than bytes. |
| 198 | But a TextIOWrapper around self.rfile would buffer too many bytes |
| 199 | from the stream, bytes which we later need to read as bytes. |
| 200 | So we read the correct bytes here, as bytes, for email Parser |
| 201 | to parse. |
| 202 | |
| 203 | """ |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 204 | headers = [] |
| 205 | while True: |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 206 | line = fp.readline(_MAXLINE + 1) |
| 207 | if len(line) > _MAXLINE: |
| 208 | raise LineTooLong("header line") |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 209 | headers.append(line) |
Georg Brandl | bf3f8eb | 2013-10-27 07:34:48 +0100 | [diff] [blame] | 210 | if len(headers) > _MAXHEADERS: |
| 211 | raise HTTPException("got more than %d headers" % _MAXHEADERS) |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 212 | if line in (b'\r\n', b'\n', b''): |
| 213 | break |
| 214 | hstring = b''.join(headers).decode('iso-8859-1') |
Jeremy Hylton | 98eb6c2 | 2009-03-27 18:31:36 +0000 | [diff] [blame] | 215 | return email.parser.Parser(_class=_class).parsestr(hstring) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 216 | |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 217 | |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 218 | class HTTPResponse(io.BufferedIOBase): |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 219 | |
| 220 | # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details. |
| 221 | |
Jeremy Hylton | 811fc14 | 2007-08-03 13:30:02 +0000 | [diff] [blame] | 222 | # The bytes from the socket object are iso-8859-1 strings. |
| 223 | # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded |
| 224 | # text following RFC 2047. The basic status line parsing only |
| 225 | # accepts iso-8859-1. |
| 226 | |
Senthil Kumaran | 052ddb0 | 2013-03-18 14:11:41 -0700 | [diff] [blame] | 227 | def __init__(self, sock, debuglevel=0, method=None, url=None): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 228 | # If the response includes a content-length header, we need to |
| 229 | # make sure that the client doesn't read more than the |
Jeremy Hylton | 39b198d | 2007-08-04 19:22:00 +0000 | [diff] [blame] | 230 | # specified number of bytes. If it does, it will block until |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 231 | # the server times out and closes the connection. This will |
| 232 | # happen if a self.fp.read() is done (without a size) whether |
| 233 | # self.fp is buffered or not. So, no self.fp.read() by |
| 234 | # clients unless they know what they are doing. |
Benjamin Peterson | f72d9fb | 2009-02-08 00:29:20 +0000 | [diff] [blame] | 235 | self.fp = sock.makefile("rb") |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 236 | self.debuglevel = debuglevel |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 237 | self._method = method |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 238 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 239 | # The HTTPResponse object is returned via urllib. The clients |
| 240 | # of http and urllib expect different attributes for the |
| 241 | # headers. headers is used here and supports urllib. msg is |
| 242 | # provided as a backwards compatibility layer for http |
| 243 | # clients. |
| 244 | |
| 245 | self.headers = self.msg = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 246 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 247 | # from the Status-Line of the response |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 248 | self.version = _UNKNOWN # HTTP-Version |
| 249 | self.status = _UNKNOWN # Status-Code |
| 250 | self.reason = _UNKNOWN # Reason-Phrase |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 251 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 252 | self.chunked = _UNKNOWN # is "chunked" being used? |
| 253 | self.chunk_left = _UNKNOWN # bytes left to read in current chunk |
| 254 | self.length = _UNKNOWN # number of bytes left in response |
| 255 | self.will_close = _UNKNOWN # conn will close at end of response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 256 | |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 257 | def _read_status(self): |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 258 | line = str(self.fp.readline(_MAXLINE + 1), "iso-8859-1") |
| 259 | if len(line) > _MAXLINE: |
| 260 | raise LineTooLong("status line") |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 261 | if self.debuglevel > 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 262 | print("reply:", repr(line)) |
Jeremy Hylton | b676952 | 2003-06-29 17:55:05 +0000 | [diff] [blame] | 263 | if not line: |
| 264 | # Presumably, the server closed the connection before |
| 265 | # sending a valid response. |
R David Murray | cae7bdb | 2015-04-05 19:26:29 -0400 | [diff] [blame] | 266 | raise RemoteDisconnected("Remote end closed connection without" |
| 267 | " response") |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 268 | try: |
Antoine Pitrou | 988dbd7 | 2010-12-17 17:35:56 +0000 | [diff] [blame] | 269 | version, status, reason = line.split(None, 2) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 270 | except ValueError: |
| 271 | try: |
Antoine Pitrou | 988dbd7 | 2010-12-17 17:35:56 +0000 | [diff] [blame] | 272 | version, status = line.split(None, 1) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 273 | reason = "" |
| 274 | except ValueError: |
Antoine Pitrou | 988dbd7 | 2010-12-17 17:35:56 +0000 | [diff] [blame] | 275 | # empty version will cause next test to fail. |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 276 | version = "" |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 277 | if not version.startswith("HTTP/"): |
Serhiy Storchaka | b5b9c8c | 2013-02-06 10:31:57 +0200 | [diff] [blame] | 278 | self._close_conn() |
Antoine Pitrou | 988dbd7 | 2010-12-17 17:35:56 +0000 | [diff] [blame] | 279 | raise BadStatusLine(line) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 280 | |
Jeremy Hylton | 23d4047 | 2001-04-13 14:57:08 +0000 | [diff] [blame] | 281 | # The status code is a three-digit number |
| 282 | try: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 283 | status = int(status) |
Jeremy Hylton | 23d4047 | 2001-04-13 14:57:08 +0000 | [diff] [blame] | 284 | if status < 100 or status > 999: |
| 285 | raise BadStatusLine(line) |
| 286 | except ValueError: |
| 287 | raise BadStatusLine(line) |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 288 | return version, status, reason |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 289 | |
Jeremy Hylton | 39c0380 | 2002-07-12 14:04:09 +0000 | [diff] [blame] | 290 | def begin(self): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 291 | if self.headers is not None: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 292 | # we've already started reading the response |
| 293 | return |
| 294 | |
| 295 | # read until we get a non-100 response |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 296 | while True: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 297 | version, status, reason = self._read_status() |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 298 | if status != CONTINUE: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 299 | break |
| 300 | # skip the header from the 100 response |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 301 | while True: |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 302 | skip = self.fp.readline(_MAXLINE + 1) |
| 303 | if len(skip) > _MAXLINE: |
| 304 | raise LineTooLong("header line") |
| 305 | skip = skip.strip() |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 306 | if not skip: |
| 307 | break |
| 308 | if self.debuglevel > 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 309 | print("header:", skip) |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 310 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 311 | self.code = self.status = status |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 312 | self.reason = reason.strip() |
Antoine Pitrou | 988dbd7 | 2010-12-17 17:35:56 +0000 | [diff] [blame] | 313 | if version in ("HTTP/1.0", "HTTP/0.9"): |
| 314 | # Some servers might still return "0.9", treat it as 1.0 anyway |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 315 | self.version = 10 |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 316 | elif version.startswith("HTTP/1."): |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 317 | self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1 |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 318 | else: |
| 319 | raise UnknownProtocol(version) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 320 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 321 | self.headers = self.msg = parse_headers(self.fp) |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 322 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 323 | if self.debuglevel > 0: |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 324 | for hdr in self.headers: |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 325 | print("header:", hdr, end=" ") |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 326 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 327 | # are we using the chunked-style of transfer encoding? |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 328 | tr_enc = self.headers.get("transfer-encoding") |
Jeremy Hylton | d229b3a | 2002-09-03 19:24:24 +0000 | [diff] [blame] | 329 | if tr_enc and tr_enc.lower() == "chunked": |
Jeremy Hylton | 236156f | 2008-12-15 03:00:50 +0000 | [diff] [blame] | 330 | self.chunked = True |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 331 | self.chunk_left = None |
| 332 | else: |
Jeremy Hylton | 236156f | 2008-12-15 03:00:50 +0000 | [diff] [blame] | 333 | self.chunked = False |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 334 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 335 | # will the connection close at the end of the response? |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 336 | self.will_close = self._check_close() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 337 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 338 | # do we have a Content-Length? |
| 339 | # 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] | 340 | self.length = None |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 341 | length = self.headers.get("content-length") |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 342 | |
| 343 | # are we using the chunked-style of transfer encoding? |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 344 | tr_enc = self.headers.get("transfer-encoding") |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 345 | if length and not self.chunked: |
Jeremy Hylton | 30a8181 | 2000-09-14 20:34:27 +0000 | [diff] [blame] | 346 | try: |
| 347 | self.length = int(length) |
| 348 | except ValueError: |
Christian Heimes | a612dc0 | 2008-02-24 13:08:18 +0000 | [diff] [blame] | 349 | self.length = None |
| 350 | else: |
| 351 | if self.length < 0: # ignore nonsensical negative lengths |
| 352 | self.length = None |
| 353 | else: |
| 354 | self.length = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 355 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 356 | # does the body have a fixed length? (of zero) |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 357 | if (status == NO_CONTENT or status == NOT_MODIFIED or |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 358 | 100 <= status < 200 or # 1xx codes |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 359 | self._method == "HEAD"): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 360 | self.length = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 361 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 362 | # if the connection remains open, and we aren't using chunked, and |
| 363 | # a content-length was not provided, then assume that the connection |
| 364 | # WILL close. |
Jeremy Hylton | 0ee5eeb | 2007-08-04 03:25:17 +0000 | [diff] [blame] | 365 | if (not self.will_close and |
| 366 | not self.chunked and |
| 367 | self.length is None): |
Jeremy Hylton | 236156f | 2008-12-15 03:00:50 +0000 | [diff] [blame] | 368 | self.will_close = True |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 369 | |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 370 | def _check_close(self): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 371 | conn = self.headers.get("connection") |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 372 | if self.version == 11: |
| 373 | # An HTTP/1.1 proxy is assumed to stay open unless |
| 374 | # explicitly closed. |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 375 | conn = self.headers.get("connection") |
Raymond Hettinger | bac788a | 2004-05-04 09:21:43 +0000 | [diff] [blame] | 376 | if conn and "close" in conn.lower(): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 377 | return True |
| 378 | return False |
| 379 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 380 | # Some HTTP/1.0 implementations have support for persistent |
| 381 | # connections, using rules different than HTTP/1.1. |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 382 | |
Christian Heimes | 895627f | 2007-12-08 17:28:33 +0000 | [diff] [blame] | 383 | # For older HTTP, Keep-Alive indicates persistent connection. |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 384 | if self.headers.get("keep-alive"): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 385 | return False |
Tim Peters | 77c06fb | 2002-11-24 02:35:35 +0000 | [diff] [blame] | 386 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 387 | # At least Akamai returns a "Connection: Keep-Alive" header, |
| 388 | # which was supposed to be sent by the client. |
| 389 | if conn and "keep-alive" in conn.lower(): |
| 390 | return False |
| 391 | |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 392 | # Proxy-Connection is a netscape hack. |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 393 | pconn = self.headers.get("proxy-connection") |
Raymond Hettinger | bac788a | 2004-05-04 09:21:43 +0000 | [diff] [blame] | 394 | if pconn and "keep-alive" in pconn.lower(): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 395 | return False |
| 396 | |
| 397 | # otherwise, assume it will close |
| 398 | return True |
| 399 | |
Serhiy Storchaka | b5b9c8c | 2013-02-06 10:31:57 +0200 | [diff] [blame] | 400 | def _close_conn(self): |
| 401 | fp = self.fp |
| 402 | self.fp = None |
| 403 | fp.close() |
| 404 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 405 | def close(self): |
Serhiy Storchaka | 7e7a3db | 2015-04-10 13:24:41 +0300 | [diff] [blame] | 406 | try: |
| 407 | super().close() # set "closed" flag |
| 408 | finally: |
| 409 | if self.fp: |
| 410 | self._close_conn() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 411 | |
Jeremy Hylton | df5f6b5 | 2007-08-08 17:36:33 +0000 | [diff] [blame] | 412 | # These implementations are for the benefit of io.BufferedReader. |
| 413 | |
| 414 | # XXX This class should probably be revised to act more like |
| 415 | # the "raw stream" that BufferedReader expects. |
| 416 | |
Jeremy Hylton | df5f6b5 | 2007-08-08 17:36:33 +0000 | [diff] [blame] | 417 | def flush(self): |
Serhiy Storchaka | b5b9c8c | 2013-02-06 10:31:57 +0200 | [diff] [blame] | 418 | super().flush() |
| 419 | if self.fp: |
| 420 | self.fp.flush() |
Jeremy Hylton | df5f6b5 | 2007-08-08 17:36:33 +0000 | [diff] [blame] | 421 | |
Jeremy Hylton | a7cff02 | 2009-04-01 02:35:56 +0000 | [diff] [blame] | 422 | def readable(self): |
| 423 | return True |
| 424 | |
Jeremy Hylton | df5f6b5 | 2007-08-08 17:36:33 +0000 | [diff] [blame] | 425 | # End of "raw stream" methods |
| 426 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 427 | def isclosed(self): |
Serhiy Storchaka | b5b9c8c | 2013-02-06 10:31:57 +0200 | [diff] [blame] | 428 | """True if the connection is closed.""" |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 429 | # NOTE: it is possible that we will not ever call self.close(). This |
| 430 | # case occurs when will_close is TRUE, length is None, and we |
| 431 | # read up to the last byte, but NOT past it. |
| 432 | # |
| 433 | # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be |
| 434 | # called, meaning self.isclosed() is meaningful. |
| 435 | return self.fp is None |
| 436 | |
| 437 | def read(self, amt=None): |
| 438 | if self.fp is None: |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 439 | return b"" |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 440 | |
Senthil Kumaran | 71fb6c8 | 2010-04-28 17:39:48 +0000 | [diff] [blame] | 441 | if self._method == "HEAD": |
Serhiy Storchaka | b5b9c8c | 2013-02-06 10:31:57 +0200 | [diff] [blame] | 442 | self._close_conn() |
Senthil Kumaran | 71fb6c8 | 2010-04-28 17:39:48 +0000 | [diff] [blame] | 443 | return b"" |
| 444 | |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 445 | if amt is not None: |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 446 | # Amount is given, implement using readinto |
| 447 | b = bytearray(amt) |
| 448 | n = self.readinto(b) |
| 449 | return memoryview(b)[:n].tobytes() |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 450 | else: |
| 451 | # Amount is not given (unbounded read) so we must check self.length |
| 452 | # and self.chunked |
Tim Peters | 230a60c | 2002-11-09 05:08:07 +0000 | [diff] [blame] | 453 | |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 454 | if self.chunked: |
| 455 | return self._readall_chunked() |
| 456 | |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 457 | if self.length is None: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 458 | s = self.fp.read() |
| 459 | else: |
Antoine Pitrou | beec61a | 2013-02-02 22:49:34 +0100 | [diff] [blame] | 460 | try: |
| 461 | s = self._safe_read(self.length) |
| 462 | except IncompleteRead: |
Serhiy Storchaka | b5b9c8c | 2013-02-06 10:31:57 +0200 | [diff] [blame] | 463 | self._close_conn() |
Antoine Pitrou | beec61a | 2013-02-02 22:49:34 +0100 | [diff] [blame] | 464 | raise |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 465 | self.length = 0 |
Serhiy Storchaka | b5b9c8c | 2013-02-06 10:31:57 +0200 | [diff] [blame] | 466 | self._close_conn() # we read everything |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 467 | return s |
| 468 | |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 469 | def readinto(self, b): |
| 470 | if self.fp is None: |
| 471 | return 0 |
| 472 | |
| 473 | if self._method == "HEAD": |
Serhiy Storchaka | b6c86fd | 2013-02-06 10:35:40 +0200 | [diff] [blame] | 474 | self._close_conn() |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 475 | return 0 |
| 476 | |
| 477 | if self.chunked: |
| 478 | return self._readinto_chunked(b) |
| 479 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 480 | if self.length is not None: |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 481 | if len(b) > self.length: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 482 | # clip the read to the "end of response" |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 483 | b = memoryview(b)[0:self.length] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 484 | |
| 485 | # we do not use _safe_read() here because this may be a .will_close |
| 486 | # connection, and the user is reading more bytes than will be provided |
| 487 | # (for example, reading in 1k chunks) |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 488 | n = self.fp.readinto(b) |
Serhiy Storchaka | 1c84ac1 | 2013-12-17 21:50:02 +0200 | [diff] [blame] | 489 | if not n and b: |
Antoine Pitrou | beec61a | 2013-02-02 22:49:34 +0100 | [diff] [blame] | 490 | # Ideally, we would raise IncompleteRead if the content-length |
| 491 | # wasn't satisfied, but it might break compatibility. |
Serhiy Storchaka | b5b9c8c | 2013-02-06 10:31:57 +0200 | [diff] [blame] | 492 | self._close_conn() |
Antoine Pitrou | 6a35e18 | 2013-02-02 23:04:56 +0100 | [diff] [blame] | 493 | elif self.length is not None: |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 494 | self.length -= n |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 495 | if not self.length: |
Serhiy Storchaka | b5b9c8c | 2013-02-06 10:31:57 +0200 | [diff] [blame] | 496 | self._close_conn() |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 497 | return n |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 498 | |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 499 | def _read_next_chunk_size(self): |
| 500 | # Read the next chunk size from the file |
| 501 | line = self.fp.readline(_MAXLINE + 1) |
| 502 | if len(line) > _MAXLINE: |
| 503 | raise LineTooLong("chunk size") |
| 504 | i = line.find(b";") |
| 505 | if i >= 0: |
| 506 | line = line[:i] # strip chunk-extensions |
| 507 | try: |
| 508 | return int(line, 16) |
| 509 | except ValueError: |
| 510 | # close the connection as protocol synchronisation is |
| 511 | # probably lost |
Serhiy Storchaka | b6c86fd | 2013-02-06 10:35:40 +0200 | [diff] [blame] | 512 | self._close_conn() |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 513 | raise |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 514 | |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 515 | def _read_and_discard_trailer(self): |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 516 | # read and discard trailer up to the CRLF terminator |
| 517 | ### note: we shouldn't have any trailers! |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 518 | while True: |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 519 | line = self.fp.readline(_MAXLINE + 1) |
| 520 | if len(line) > _MAXLINE: |
| 521 | raise LineTooLong("trailer line") |
Christian Heimes | 0bd4e11 | 2008-02-12 22:59:25 +0000 | [diff] [blame] | 522 | if not line: |
| 523 | # a vanishingly small number of sites EOF without |
| 524 | # sending the trailer |
| 525 | break |
Senthil Kumaran | 7e70a5c | 2012-04-29 10:39:49 +0800 | [diff] [blame] | 526 | if line in (b'\r\n', b'\n', b''): |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 527 | break |
| 528 | |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 529 | def _get_chunk_left(self): |
| 530 | # return self.chunk_left, reading a new chunk if necessary. |
| 531 | # chunk_left == 0: at the end of the current chunk, need to close it |
| 532 | # chunk_left == None: No current chunk, should read next. |
| 533 | # This function returns non-zero or None if the last chunk has |
| 534 | # been read. |
| 535 | chunk_left = self.chunk_left |
| 536 | if not chunk_left: # Can be 0 or None |
| 537 | if chunk_left is not None: |
| 538 | # We are at the end of chunk. dicard chunk end |
| 539 | self._safe_read(2) # toss the CRLF at the end of the chunk |
| 540 | try: |
| 541 | chunk_left = self._read_next_chunk_size() |
| 542 | except ValueError: |
| 543 | raise IncompleteRead(b'') |
| 544 | if chunk_left == 0: |
| 545 | # last chunk: 1*("0") [ chunk-extension ] CRLF |
| 546 | self._read_and_discard_trailer() |
| 547 | # we read everything; close the "file" |
| 548 | self._close_conn() |
| 549 | chunk_left = None |
| 550 | self.chunk_left = chunk_left |
| 551 | return chunk_left |
| 552 | |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 553 | def _readall_chunked(self): |
| 554 | assert self.chunked != _UNKNOWN |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 555 | value = [] |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 556 | try: |
| 557 | while True: |
| 558 | chunk_left = self._get_chunk_left() |
| 559 | if chunk_left is None: |
| 560 | break |
| 561 | value.append(self._safe_read(chunk_left)) |
| 562 | self.chunk_left = 0 |
| 563 | return b''.join(value) |
| 564 | except IncompleteRead: |
| 565 | raise IncompleteRead(b''.join(value)) |
Tim Peters | 230a60c | 2002-11-09 05:08:07 +0000 | [diff] [blame] | 566 | |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 567 | def _readinto_chunked(self, b): |
| 568 | assert self.chunked != _UNKNOWN |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 569 | total_bytes = 0 |
| 570 | mvb = memoryview(b) |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 571 | try: |
| 572 | while True: |
| 573 | chunk_left = self._get_chunk_left() |
| 574 | if chunk_left is None: |
| 575 | return total_bytes |
Antoine Pitrou | 4ce6aa4 | 2011-12-06 22:34:36 +0100 | [diff] [blame] | 576 | |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 577 | if len(mvb) <= chunk_left: |
| 578 | n = self._safe_readinto(mvb) |
| 579 | self.chunk_left = chunk_left - n |
| 580 | return total_bytes + n |
| 581 | |
| 582 | temp_mvb = mvb[:chunk_left] |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 583 | n = self._safe_readinto(temp_mvb) |
| 584 | mvb = mvb[n:] |
| 585 | total_bytes += n |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 586 | self.chunk_left = 0 |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 587 | |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 588 | except IncompleteRead: |
| 589 | raise IncompleteRead(bytes(b[0:total_bytes])) |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 590 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 591 | def _safe_read(self, amt): |
| 592 | """Read the number of bytes requested, compensating for partial reads. |
| 593 | |
| 594 | Normally, we have a blocking socket, but a read() can be interrupted |
| 595 | by a signal (resulting in a partial read). |
| 596 | |
| 597 | Note that we cannot distinguish between EOF and an interrupt when zero |
| 598 | bytes have been read. IncompleteRead() will be raised in this |
| 599 | situation. |
| 600 | |
| 601 | This function should be used when <amt> bytes "should" be present for |
| 602 | reading. If the bytes are truly not available (due to EOF), then the |
| 603 | IncompleteRead exception can be used to detect the problem. |
| 604 | """ |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 605 | s = [] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 606 | while amt > 0: |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 607 | chunk = self.fp.read(min(amt, MAXAMOUNT)) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 608 | if not chunk: |
Benjamin Peterson | 6accb98 | 2009-03-02 22:50:25 +0000 | [diff] [blame] | 609 | raise IncompleteRead(b''.join(s), amt) |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 610 | s.append(chunk) |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 611 | amt -= len(chunk) |
Guido van Rossum | a00f123 | 2007-09-12 19:43:09 +0000 | [diff] [blame] | 612 | return b"".join(s) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 613 | |
Antoine Pitrou | 38d9643 | 2011-12-06 22:33:57 +0100 | [diff] [blame] | 614 | def _safe_readinto(self, b): |
| 615 | """Same as _safe_read, but for reading into a buffer.""" |
| 616 | total_bytes = 0 |
| 617 | mvb = memoryview(b) |
| 618 | while total_bytes < len(b): |
| 619 | if MAXAMOUNT < len(mvb): |
| 620 | temp_mvb = mvb[0:MAXAMOUNT] |
| 621 | n = self.fp.readinto(temp_mvb) |
| 622 | else: |
| 623 | n = self.fp.readinto(mvb) |
| 624 | if not n: |
| 625 | raise IncompleteRead(bytes(mvb[0:total_bytes]), len(b)) |
| 626 | mvb = mvb[n:] |
| 627 | total_bytes += n |
| 628 | return total_bytes |
| 629 | |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 630 | def read1(self, n=-1): |
| 631 | """Read with at most one underlying system call. If at least one |
| 632 | byte is buffered, return that instead. |
| 633 | """ |
| 634 | if self.fp is None or self._method == "HEAD": |
| 635 | return b"" |
| 636 | if self.chunked: |
| 637 | return self._read1_chunked(n) |
Martin Panter | ce911c3 | 2016-03-17 06:42:48 +0000 | [diff] [blame] | 638 | if self.length is not None and (n < 0 or n > self.length): |
| 639 | n = self.length |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 640 | try: |
| 641 | result = self.fp.read1(n) |
| 642 | except ValueError: |
| 643 | if n >= 0: |
| 644 | raise |
| 645 | # some implementations, like BufferedReader, don't support -1 |
| 646 | # Read an arbitrarily selected largeish chunk. |
| 647 | result = self.fp.read1(16*1024) |
| 648 | if not result and n: |
| 649 | self._close_conn() |
Martin Panter | ce911c3 | 2016-03-17 06:42:48 +0000 | [diff] [blame] | 650 | elif self.length is not None: |
| 651 | self.length -= len(result) |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 652 | return result |
| 653 | |
| 654 | def peek(self, n=-1): |
| 655 | # Having this enables IOBase.readline() to read more than one |
| 656 | # byte at a time |
| 657 | if self.fp is None or self._method == "HEAD": |
| 658 | return b"" |
| 659 | if self.chunked: |
| 660 | return self._peek_chunked(n) |
| 661 | return self.fp.peek(n) |
| 662 | |
| 663 | def readline(self, limit=-1): |
| 664 | if self.fp is None or self._method == "HEAD": |
| 665 | return b"" |
| 666 | if self.chunked: |
| 667 | # Fallback to IOBase readline which uses peek() and read() |
| 668 | return super().readline(limit) |
Martin Panter | ce911c3 | 2016-03-17 06:42:48 +0000 | [diff] [blame] | 669 | if self.length is not None and (limit < 0 or limit > self.length): |
| 670 | limit = self.length |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 671 | result = self.fp.readline(limit) |
| 672 | if not result and limit: |
| 673 | self._close_conn() |
Martin Panter | ce911c3 | 2016-03-17 06:42:48 +0000 | [diff] [blame] | 674 | elif self.length is not None: |
| 675 | self.length -= len(result) |
Kristján Valur Jónsson | 8e5d0ca | 2014-03-19 10:07:26 +0000 | [diff] [blame] | 676 | return result |
| 677 | |
| 678 | def _read1_chunked(self, n): |
| 679 | # Strictly speaking, _get_chunk_left() may cause more than one read, |
| 680 | # but that is ok, since that is to satisfy the chunked protocol. |
| 681 | chunk_left = self._get_chunk_left() |
| 682 | if chunk_left is None or n == 0: |
| 683 | return b'' |
| 684 | if not (0 <= n <= chunk_left): |
| 685 | n = chunk_left # if n is negative or larger than chunk_left |
| 686 | read = self.fp.read1(n) |
| 687 | self.chunk_left -= len(read) |
| 688 | if not read: |
| 689 | raise IncompleteRead(b"") |
| 690 | return read |
| 691 | |
| 692 | def _peek_chunked(self, n): |
| 693 | # Strictly speaking, _get_chunk_left() may cause more than one read, |
| 694 | # but that is ok, since that is to satisfy the chunked protocol. |
| 695 | try: |
| 696 | chunk_left = self._get_chunk_left() |
| 697 | except IncompleteRead: |
| 698 | return b'' # peek doesn't worry about protocol |
| 699 | if chunk_left is None: |
| 700 | return b'' # eof |
| 701 | # peek is allowed to return more than requested. Just request the |
| 702 | # entire chunk, and truncate what we get. |
| 703 | return self.fp.peek(chunk_left)[:chunk_left] |
| 704 | |
Antoine Pitrou | b353c12 | 2009-02-11 00:39:14 +0000 | [diff] [blame] | 705 | def fileno(self): |
| 706 | return self.fp.fileno() |
| 707 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 708 | def getheader(self, name, default=None): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 709 | if self.headers is None: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 710 | raise ResponseNotReady() |
Senthil Kumaran | 9f8dc44 | 2010-08-02 11:04:58 +0000 | [diff] [blame] | 711 | headers = self.headers.get_all(name) or default |
| 712 | if isinstance(headers, str) or not hasattr(headers, '__iter__'): |
| 713 | return headers |
| 714 | else: |
| 715 | return ', '.join(headers) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 716 | |
Martin v. Löwis | deacce2 | 2004-08-18 12:46:26 +0000 | [diff] [blame] | 717 | def getheaders(self): |
| 718 | """Return list of (header, value) tuples.""" |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 719 | if self.headers is None: |
Martin v. Löwis | deacce2 | 2004-08-18 12:46:26 +0000 | [diff] [blame] | 720 | raise ResponseNotReady() |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 721 | return list(self.headers.items()) |
Martin v. Löwis | deacce2 | 2004-08-18 12:46:26 +0000 | [diff] [blame] | 722 | |
Antoine Pitrou | b353c12 | 2009-02-11 00:39:14 +0000 | [diff] [blame] | 723 | # We override IOBase.__iter__ so that it doesn't check for closed-ness |
| 724 | |
| 725 | def __iter__(self): |
| 726 | return self |
| 727 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 728 | # For compatibility with old-style urllib responses. |
| 729 | |
| 730 | def info(self): |
| 731 | return self.headers |
| 732 | |
| 733 | def geturl(self): |
| 734 | return self.url |
| 735 | |
| 736 | def getcode(self): |
| 737 | return self.status |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 738 | |
| 739 | class HTTPConnection: |
| 740 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 741 | _http_vsn = 11 |
| 742 | _http_vsn_str = 'HTTP/1.1' |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 743 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 744 | response_class = HTTPResponse |
| 745 | default_port = HTTP_PORT |
| 746 | auto_open = 1 |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 747 | debuglevel = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 748 | |
Senthil Kumaran | 052ddb0 | 2013-03-18 14:11:41 -0700 | [diff] [blame] | 749 | def __init__(self, host, port=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT, |
| 750 | source_address=None): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 751 | self.timeout = timeout |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 752 | self.source_address = source_address |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 753 | self.sock = None |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 754 | self._buffer = [] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 755 | self.__response = None |
| 756 | self.__state = _CS_IDLE |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 757 | self._method = None |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 758 | self._tunnel_host = None |
| 759 | self._tunnel_port = None |
Georg Brandl | c7c199f | 2011-01-22 22:06:24 +0000 | [diff] [blame] | 760 | self._tunnel_headers = {} |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 761 | |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 762 | (self.host, self.port) = self._get_hostport(host, port) |
| 763 | |
| 764 | # This is stored as an instance variable to allow unit |
| 765 | # tests to replace it with a suitable mockup |
| 766 | self._create_connection = socket.create_connection |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 767 | |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 768 | def set_tunnel(self, host, port=None, headers=None): |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 769 | """Set up host and port for HTTP CONNECT tunnelling. |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 770 | |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 771 | In a connection that uses HTTP CONNECT tunneling, the host passed to the |
| 772 | constructor is used as a proxy server that relays all communication to |
| 773 | the endpoint passed to `set_tunnel`. This done by sending an HTTP |
| 774 | CONNECT request to the proxy server when the connection is established. |
| 775 | |
| 776 | This method must be called before the HTML connection has been |
| 777 | established. |
| 778 | |
| 779 | The headers argument should be a mapping of extra HTTP headers to send |
| 780 | with the CONNECT request. |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 781 | """ |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 782 | |
| 783 | if self.sock: |
| 784 | raise RuntimeError("Can't set up tunnel for established connection") |
| 785 | |
Serhiy Storchaka | 4ac7ed9 | 2014-12-12 09:29:15 +0200 | [diff] [blame] | 786 | self._tunnel_host, self._tunnel_port = self._get_hostport(host, port) |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 787 | if headers: |
| 788 | self._tunnel_headers = headers |
| 789 | else: |
| 790 | self._tunnel_headers.clear() |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 791 | |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 792 | def _get_hostport(self, host, port): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 793 | if port is None: |
Skip Montanaro | 10e6e0e | 2004-09-14 16:32:02 +0000 | [diff] [blame] | 794 | i = host.rfind(':') |
Skip Montanaro | cae14d2 | 2004-09-14 17:55:21 +0000 | [diff] [blame] | 795 | j = host.rfind(']') # ipv6 addresses have [...] |
| 796 | if i > j: |
Skip Montanaro | 9d38997 | 2002-03-24 16:53:50 +0000 | [diff] [blame] | 797 | try: |
| 798 | port = int(host[i+1:]) |
| 799 | except ValueError: |
Łukasz Langa | a5a9a9c | 2011-10-18 21:17:39 +0200 | [diff] [blame] | 800 | if host[i+1:] == "": # http://foo.com:/ == http://foo.com/ |
| 801 | port = self.default_port |
| 802 | else: |
| 803 | raise InvalidURL("nonnumeric port: '%s'" % host[i+1:]) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 804 | host = host[:i] |
| 805 | else: |
| 806 | port = self.default_port |
Raymond Hettinger | 4d03791 | 2004-10-14 15:23:38 +0000 | [diff] [blame] | 807 | if host and host[0] == '[' and host[-1] == ']': |
Brett Cannon | 0a1af4a | 2004-09-15 23:26:23 +0000 | [diff] [blame] | 808 | host = host[1:-1] |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 809 | |
| 810 | return (host, port) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 811 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 812 | def set_debuglevel(self, level): |
| 813 | self.debuglevel = level |
| 814 | |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 815 | def _tunnel(self): |
Serhiy Storchaka | 4ac7ed9 | 2014-12-12 09:29:15 +0200 | [diff] [blame] | 816 | connect_str = "CONNECT %s:%d HTTP/1.0\r\n" % (self._tunnel_host, |
| 817 | self._tunnel_port) |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 818 | connect_bytes = connect_str.encode("ascii") |
| 819 | self.send(connect_bytes) |
Georg Brandl | c7c199f | 2011-01-22 22:06:24 +0000 | [diff] [blame] | 820 | for header, value in self._tunnel_headers.items(): |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 821 | header_str = "%s: %s\r\n" % (header, value) |
Marc-André Lemburg | 8f36af7 | 2011-02-25 15:42:01 +0000 | [diff] [blame] | 822 | header_bytes = header_str.encode("latin-1") |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 823 | self.send(header_bytes) |
Georg Brandl | c7c199f | 2011-01-22 22:06:24 +0000 | [diff] [blame] | 824 | self.send(b'\r\n') |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 825 | |
Georg Brandl | c7c199f | 2011-01-22 22:06:24 +0000 | [diff] [blame] | 826 | response = self.response_class(self.sock, method=self._method) |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 827 | (version, code, message) = response._read_status() |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 828 | |
Serhiy Storchaka | e4db769 | 2014-12-23 16:28:28 +0200 | [diff] [blame] | 829 | if code != http.HTTPStatus.OK: |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 830 | self.close() |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 831 | raise OSError("Tunnel connection failed: %d %s" % (code, |
| 832 | message.strip())) |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 833 | while True: |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 834 | line = response.fp.readline(_MAXLINE + 1) |
| 835 | if len(line) > _MAXLINE: |
| 836 | raise LineTooLong("header line") |
Senthil Kumaran | b12771a | 2012-04-23 23:50:07 +0800 | [diff] [blame] | 837 | if not line: |
| 838 | # for sites which EOF without sending a trailer |
| 839 | break |
Senthil Kumaran | 7e70a5c | 2012-04-29 10:39:49 +0800 | [diff] [blame] | 840 | if line in (b'\r\n', b'\n', b''): |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 841 | break |
| 842 | |
Berker Peksag | ab53ab0 | 2015-02-03 12:22:11 +0200 | [diff] [blame] | 843 | if self.debuglevel > 0: |
| 844 | print('header:', line.decode()) |
| 845 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 846 | def connect(self): |
| 847 | """Connect to the host and port specified in __init__.""" |
Benjamin Peterson | 9d8a3ad | 2015-01-23 11:02:57 -0500 | [diff] [blame] | 848 | self.sock = self._create_connection( |
| 849 | (self.host,self.port), self.timeout, self.source_address) |
| 850 | self.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1) |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 851 | |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 852 | if self._tunnel_host: |
| 853 | self._tunnel() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 854 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 855 | def close(self): |
| 856 | """Close the connection to the HTTP server.""" |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 857 | self.__state = _CS_IDLE |
Serhiy Storchaka | 7e7a3db | 2015-04-10 13:24:41 +0300 | [diff] [blame] | 858 | try: |
| 859 | sock = self.sock |
| 860 | if sock: |
| 861 | self.sock = None |
| 862 | sock.close() # close it manually... there may be other refs |
| 863 | finally: |
| 864 | response = self.__response |
| 865 | if response: |
| 866 | self.__response = None |
| 867 | response.close() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 868 | |
Senthil Kumaran | 5a2da3b | 2010-10-02 10:33:13 +0000 | [diff] [blame] | 869 | def send(self, data): |
Senthil Kumaran | 7bc0d87 | 2010-12-19 10:49:52 +0000 | [diff] [blame] | 870 | """Send `data' to the server. |
| 871 | ``data`` can be a string object, a bytes object, an array object, a |
| 872 | file-like object that supports a .read() method, or an iterable object. |
| 873 | """ |
| 874 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 875 | if self.sock is None: |
| 876 | if self.auto_open: |
| 877 | self.connect() |
| 878 | else: |
| 879 | raise NotConnected() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 880 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 881 | if self.debuglevel > 0: |
Senthil Kumaran | 5a2da3b | 2010-10-02 10:33:13 +0000 | [diff] [blame] | 882 | print("send:", repr(data)) |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 883 | blocksize = 8192 |
Senthil Kumaran | 5a2da3b | 2010-10-02 10:33:13 +0000 | [diff] [blame] | 884 | if hasattr(data, "read") : |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 885 | if self.debuglevel > 0: |
| 886 | print("sendIng a read()able") |
| 887 | encode = False |
Antoine Pitrou | ead1d62 | 2009-09-29 18:44:53 +0000 | [diff] [blame] | 888 | try: |
Senthil Kumaran | 5a2da3b | 2010-10-02 10:33:13 +0000 | [diff] [blame] | 889 | mode = data.mode |
Antoine Pitrou | ead1d62 | 2009-09-29 18:44:53 +0000 | [diff] [blame] | 890 | except AttributeError: |
| 891 | # io.BytesIO and other file-like objects don't have a `mode` |
| 892 | # attribute. |
| 893 | pass |
| 894 | else: |
| 895 | if "b" not in mode: |
| 896 | encode = True |
| 897 | if self.debuglevel > 0: |
| 898 | print("encoding file using iso-8859-1") |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 899 | while 1: |
Senthil Kumaran | 5a2da3b | 2010-10-02 10:33:13 +0000 | [diff] [blame] | 900 | datablock = data.read(blocksize) |
| 901 | if not datablock: |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 902 | break |
| 903 | if encode: |
Senthil Kumaran | 5a2da3b | 2010-10-02 10:33:13 +0000 | [diff] [blame] | 904 | datablock = datablock.encode("iso-8859-1") |
| 905 | self.sock.sendall(datablock) |
Andrew Svetlov | 7b2c8bb | 2013-04-12 22:49:19 +0300 | [diff] [blame] | 906 | return |
Senthil Kumaran | 7bc0d87 | 2010-12-19 10:49:52 +0000 | [diff] [blame] | 907 | try: |
Senthil Kumaran | 5a2da3b | 2010-10-02 10:33:13 +0000 | [diff] [blame] | 908 | self.sock.sendall(data) |
Senthil Kumaran | 7bc0d87 | 2010-12-19 10:49:52 +0000 | [diff] [blame] | 909 | except TypeError: |
| 910 | if isinstance(data, collections.Iterable): |
| 911 | for d in data: |
| 912 | self.sock.sendall(d) |
| 913 | else: |
Georg Brandl | 25e2cd1 | 2011-08-03 08:27:00 +0200 | [diff] [blame] | 914 | raise TypeError("data should be a bytes-like object " |
| 915 | "or an iterable, got %r" % type(data)) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 916 | |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 917 | def _output(self, s): |
| 918 | """Add a line of output to the current request buffer. |
Tim Peters | 469cdad | 2002-08-08 20:19:19 +0000 | [diff] [blame] | 919 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 920 | Assumes that the line does *not* end with \\r\\n. |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 921 | """ |
| 922 | self._buffer.append(s) |
| 923 | |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 924 | def _send_output(self, message_body=None): |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 925 | """Send the currently buffered request and clear the buffer. |
| 926 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 927 | Appends an extra \\r\\n to the buffer. |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 928 | A message_body may be specified, to be appended to the request. |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 929 | """ |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 930 | self._buffer.extend((b"", b"")) |
| 931 | msg = b"\r\n".join(self._buffer) |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 932 | del self._buffer[:] |
Benjamin Peterson | 9d8a3ad | 2015-01-23 11:02:57 -0500 | [diff] [blame] | 933 | |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 934 | self.send(msg) |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 935 | if message_body is not None: |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 936 | self.send(message_body) |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 937 | |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 938 | def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 939 | """Send a request to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 940 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 941 | `method' specifies an HTTP request method, e.g. 'GET'. |
| 942 | `url' specifies the object being requested, e.g. '/index.html'. |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 943 | `skip_host' if True does not add automatically a 'Host:' header |
| 944 | `skip_accept_encoding' if True does not add automatically an |
| 945 | 'Accept-Encoding:' header |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 946 | """ |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 947 | |
Greg Stein | 616a58d | 2003-06-24 06:35:19 +0000 | [diff] [blame] | 948 | # if a prior response has been completed, then forget about it. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 949 | if self.__response and self.__response.isclosed(): |
| 950 | self.__response = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 951 | |
Tim Peters | 58eb11c | 2004-01-18 20:29:55 +0000 | [diff] [blame] | 952 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 953 | # in certain cases, we cannot issue another request on this connection. |
| 954 | # this occurs when: |
| 955 | # 1) we are in the process of sending a request. (_CS_REQ_STARTED) |
| 956 | # 2) a response to a previous request has signalled that it is going |
| 957 | # to close the connection upon completion. |
| 958 | # 3) the headers for the previous response have not been read, thus |
| 959 | # we cannot determine whether point (2) is true. (_CS_REQ_SENT) |
| 960 | # |
| 961 | # if there is no prior response, then we can request at will. |
| 962 | # |
| 963 | # if point (2) is true, then we will have passed the socket to the |
| 964 | # response (effectively meaning, "there is no prior response"), and |
| 965 | # will open a new one when a new request is made. |
| 966 | # |
| 967 | # Note: if a prior response exists, then we *can* start a new request. |
| 968 | # We are not allowed to begin fetching the response to this new |
| 969 | # request, however, until that prior response is complete. |
| 970 | # |
| 971 | if self.__state == _CS_IDLE: |
| 972 | self.__state = _CS_REQ_STARTED |
| 973 | else: |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 974 | raise CannotSendRequest(self.__state) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 975 | |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 976 | # Save the method we use, we need it later in the response phase |
| 977 | self._method = method |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 978 | if not url: |
| 979 | url = '/' |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 980 | request = '%s %s %s' % (method, url, self._http_vsn_str) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 981 | |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 982 | # Non-ASCII characters should have been eliminated earlier |
| 983 | self._output(request.encode('ascii')) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 984 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 985 | if self._http_vsn == 11: |
| 986 | # Issue some standard headers for better HTTP/1.1 compliance |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 987 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 988 | if not skip_host: |
| 989 | # this header is issued *only* for HTTP/1.1 |
| 990 | # connections. more specifically, this means it is |
| 991 | # only issued when the client uses the new |
| 992 | # HTTPConnection() class. backwards-compat clients |
| 993 | # will be using HTTP/1.0 and those clients may be |
| 994 | # issuing this header themselves. we should NOT issue |
| 995 | # it twice; some web servers (such as Apache) barf |
| 996 | # when they see two Host: headers |
Guido van Rossum | f6922aa | 2001-01-14 21:03:01 +0000 | [diff] [blame] | 997 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 998 | # If we need a non-standard port,include it in the |
| 999 | # header. If the request is going through a proxy, |
| 1000 | # but the host of the actual URL, not the host of the |
| 1001 | # proxy. |
Jeremy Hylton | 8acf1e0 | 2002-03-08 19:35:51 +0000 | [diff] [blame] | 1002 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 1003 | netloc = '' |
| 1004 | if url.startswith('http'): |
| 1005 | nil, netloc, nil, nil, nil = urlsplit(url) |
| 1006 | |
| 1007 | if netloc: |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1008 | try: |
| 1009 | netloc_enc = netloc.encode("ascii") |
| 1010 | except UnicodeEncodeError: |
| 1011 | netloc_enc = netloc.encode("idna") |
| 1012 | self.putheader('Host', netloc_enc) |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 1013 | else: |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 1014 | if self._tunnel_host: |
| 1015 | host = self._tunnel_host |
| 1016 | port = self._tunnel_port |
| 1017 | else: |
| 1018 | host = self.host |
| 1019 | port = self.port |
| 1020 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1021 | try: |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 1022 | host_enc = host.encode("ascii") |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1023 | except UnicodeEncodeError: |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 1024 | host_enc = host.encode("idna") |
Senthil Kumaran | 74ebd9e | 2010-11-13 12:27:49 +0000 | [diff] [blame] | 1025 | |
| 1026 | # As per RFC 273, IPv6 address should be wrapped with [] |
| 1027 | # when used as Host header |
| 1028 | |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 1029 | if host.find(':') >= 0: |
Senthil Kumaran | 74ebd9e | 2010-11-13 12:27:49 +0000 | [diff] [blame] | 1030 | host_enc = b'[' + host_enc + b']' |
| 1031 | |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 1032 | if port == self.default_port: |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1033 | self.putheader('Host', host_enc) |
| 1034 | else: |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 1035 | host_enc = host_enc.decode("ascii") |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 1036 | self.putheader('Host', "%s:%s" % (host_enc, port)) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1037 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1038 | # note: we are assuming that clients will not attempt to set these |
| 1039 | # headers since *this* library must deal with the |
| 1040 | # consequences. this also means that when the supporting |
| 1041 | # libraries are updated to recognize other forms, then this |
| 1042 | # code should be changed (removed or updated). |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1043 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1044 | # we only want a Content-Encoding of "identity" since we don't |
| 1045 | # support encodings such as x-gzip or x-deflate. |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 1046 | if not skip_accept_encoding: |
| 1047 | self.putheader('Accept-Encoding', 'identity') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1048 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1049 | # we can accept "chunked" Transfer-Encodings, but no others |
| 1050 | # NOTE: no TE header implies *only* "chunked" |
| 1051 | #self.putheader('TE', 'chunked') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1052 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1053 | # if TE is supplied in the header, then it must appear in a |
| 1054 | # Connection header. |
| 1055 | #self.putheader('Connection', 'TE') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1056 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1057 | else: |
| 1058 | # For HTTP/1.0, the server will assume "not chunked" |
| 1059 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1060 | |
Benjamin Peterson | f608c61 | 2008-11-16 18:33:53 +0000 | [diff] [blame] | 1061 | def putheader(self, header, *values): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1062 | """Send a request header line to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1063 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1064 | For example: h.putheader('Accept', 'text/html') |
| 1065 | """ |
| 1066 | if self.__state != _CS_REQ_STARTED: |
| 1067 | raise CannotSendHeader() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1068 | |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 1069 | if hasattr(header, 'encode'): |
| 1070 | header = header.encode('ascii') |
Serhiy Storchaka | a112a8a | 2015-03-12 11:13:36 +0200 | [diff] [blame] | 1071 | |
| 1072 | if not _is_legal_header_name(header): |
| 1073 | raise ValueError('Invalid header name %r' % (header,)) |
| 1074 | |
Benjamin Peterson | f608c61 | 2008-11-16 18:33:53 +0000 | [diff] [blame] | 1075 | values = list(values) |
| 1076 | for i, one_value in enumerate(values): |
| 1077 | if hasattr(one_value, 'encode'): |
Marc-André Lemburg | 8f36af7 | 2011-02-25 15:42:01 +0000 | [diff] [blame] | 1078 | values[i] = one_value.encode('latin-1') |
Senthil Kumaran | 58d5dbf | 2010-10-03 18:22:42 +0000 | [diff] [blame] | 1079 | elif isinstance(one_value, int): |
| 1080 | values[i] = str(one_value).encode('ascii') |
Serhiy Storchaka | a112a8a | 2015-03-12 11:13:36 +0200 | [diff] [blame] | 1081 | |
| 1082 | if _is_illegal_header_value(values[i]): |
| 1083 | raise ValueError('Invalid header value %r' % (values[i],)) |
| 1084 | |
Benjamin Peterson | f608c61 | 2008-11-16 18:33:53 +0000 | [diff] [blame] | 1085 | value = b'\r\n\t'.join(values) |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 1086 | header = header + b': ' + value |
| 1087 | self._output(header) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1088 | |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 1089 | def endheaders(self, message_body=None): |
| 1090 | """Indicate that the last header line has been sent to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1091 | |
Senthil Kumaran | ad87fa6 | 2011-10-05 23:26:49 +0800 | [diff] [blame] | 1092 | This method sends the request to the server. The optional message_body |
| 1093 | argument can be used to pass a message body associated with the |
| 1094 | request. The message body will be sent in the same packet as the |
| 1095 | message headers if it is a string, otherwise it is sent as a separate |
| 1096 | packet. |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 1097 | """ |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1098 | if self.__state == _CS_REQ_STARTED: |
| 1099 | self.__state = _CS_REQ_SENT |
| 1100 | else: |
| 1101 | raise CannotSendHeader() |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 1102 | self._send_output(message_body) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1103 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1104 | def request(self, method, url, body=None, headers={}): |
| 1105 | """Send a complete request to the server.""" |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 1106 | self._send_request(method, url, body, headers) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1107 | |
R David Murray | beed840 | 2015-03-22 15:18:23 -0400 | [diff] [blame] | 1108 | def _set_content_length(self, body, method): |
| 1109 | # Set the content-length based on the body. If the body is "empty", we |
| 1110 | # set Content-Length: 0 for methods that expect a body (RFC 7230, |
| 1111 | # Section 3.3.2). If the body is set for other methods, we set the |
| 1112 | # header provided we can figure out what the length is. |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 1113 | thelen = None |
R David Murray | beed840 | 2015-03-22 15:18:23 -0400 | [diff] [blame] | 1114 | method_expects_body = method.upper() in _METHODS_EXPECTING_BODY |
| 1115 | if body is None and method_expects_body: |
| 1116 | thelen = '0' |
| 1117 | elif body is not None: |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 1118 | try: |
R David Murray | beed840 | 2015-03-22 15:18:23 -0400 | [diff] [blame] | 1119 | thelen = str(len(body)) |
| 1120 | except TypeError: |
| 1121 | # If this is a file-like object, try to |
| 1122 | # fstat its file descriptor |
| 1123 | try: |
| 1124 | thelen = str(os.fstat(body.fileno()).st_size) |
| 1125 | except (AttributeError, OSError): |
| 1126 | # Don't send a length if this failed |
| 1127 | if self.debuglevel > 0: print("Cannot stat!!") |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 1128 | |
| 1129 | if thelen is not None: |
| 1130 | self.putheader('Content-Length', thelen) |
| 1131 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1132 | def _send_request(self, method, url, body, headers): |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 1133 | # Honor explicitly requested Host: and Accept-Encoding: headers. |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 1134 | header_names = dict.fromkeys([k.lower() for k in headers]) |
| 1135 | skips = {} |
| 1136 | if 'host' in header_names: |
| 1137 | skips['skip_host'] = 1 |
| 1138 | if 'accept-encoding' in header_names: |
| 1139 | skips['skip_accept_encoding'] = 1 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1140 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 1141 | self.putrequest(method, url, **skips) |
| 1142 | |
R David Murray | beed840 | 2015-03-22 15:18:23 -0400 | [diff] [blame] | 1143 | if 'content-length' not in header_names: |
| 1144 | self._set_content_length(body, method) |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 1145 | for hdr, value in headers.items(): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1146 | self.putheader(hdr, value) |
Jeremy Hylton | ef9f48e | 2009-03-26 22:04:05 +0000 | [diff] [blame] | 1147 | if isinstance(body, str): |
Jeremy Hylton | 236654b | 2009-03-27 20:24:34 +0000 | [diff] [blame] | 1148 | # RFC 2616 Section 3.7.1 says that text default has a |
| 1149 | # default charset of iso-8859-1. |
Martin Panter | 4439148 | 2016-02-09 10:20:52 +0000 | [diff] [blame] | 1150 | body = _encode(body, 'body') |
Jeremy Hylton | ef9f48e | 2009-03-26 22:04:05 +0000 | [diff] [blame] | 1151 | self.endheaders(body) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1152 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1153 | def getresponse(self): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1154 | """Get the response from the server. |
| 1155 | |
| 1156 | If the HTTPConnection is in the correct state, returns an |
| 1157 | instance of HTTPResponse or of whatever object is returned by |
| 1158 | class the response_class variable. |
| 1159 | |
| 1160 | If a request has not been sent or if a previous response has |
| 1161 | not be handled, ResponseNotReady is raised. If the HTTP |
| 1162 | response indicates that the connection should be closed, then |
| 1163 | it will be closed before the response is returned. When the |
| 1164 | connection is closed, the underlying socket is closed. |
| 1165 | """ |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1166 | |
Greg Stein | 616a58d | 2003-06-24 06:35:19 +0000 | [diff] [blame] | 1167 | # if a prior response has been completed, then forget about it. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1168 | if self.__response and self.__response.isclosed(): |
| 1169 | self.__response = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1170 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1171 | # if a prior response exists, then it must be completed (otherwise, we |
| 1172 | # cannot read this response's header to determine the connection-close |
| 1173 | # behavior) |
| 1174 | # |
| 1175 | # note: if a prior response existed, but was connection-close, then the |
| 1176 | # socket and response were made independent of this HTTPConnection |
| 1177 | # object since a new request requires that we open a whole new |
| 1178 | # connection |
| 1179 | # |
| 1180 | # this means the prior response had one of two states: |
| 1181 | # 1) will_close: this connection was reset and the prior socket and |
| 1182 | # response operate independently |
| 1183 | # 2) persistent: the response was retained and we await its |
| 1184 | # isclosed() status to become true. |
| 1185 | # |
| 1186 | if self.__state != _CS_REQ_SENT or self.__response: |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1187 | raise ResponseNotReady(self.__state) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1188 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 1189 | if self.debuglevel > 0: |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1190 | response = self.response_class(self.sock, self.debuglevel, |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 1191 | method=self._method) |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 1192 | else: |
Antoine Pitrou | 988dbd7 | 2010-12-17 17:35:56 +0000 | [diff] [blame] | 1193 | response = self.response_class(self.sock, method=self._method) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1194 | |
Serhiy Storchaka | b491e05 | 2014-12-01 13:07:45 +0200 | [diff] [blame] | 1195 | try: |
R David Murray | cae7bdb | 2015-04-05 19:26:29 -0400 | [diff] [blame] | 1196 | try: |
| 1197 | response.begin() |
| 1198 | except ConnectionError: |
| 1199 | self.close() |
| 1200 | raise |
Serhiy Storchaka | b491e05 | 2014-12-01 13:07:45 +0200 | [diff] [blame] | 1201 | assert response.will_close != _UNKNOWN |
| 1202 | self.__state = _CS_IDLE |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1203 | |
Serhiy Storchaka | b491e05 | 2014-12-01 13:07:45 +0200 | [diff] [blame] | 1204 | if response.will_close: |
| 1205 | # this effectively passes the connection to the response |
| 1206 | self.close() |
| 1207 | else: |
| 1208 | # remember this, so we can tell when it is complete |
| 1209 | self.__response = response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1210 | |
Serhiy Storchaka | b491e05 | 2014-12-01 13:07:45 +0200 | [diff] [blame] | 1211 | return response |
| 1212 | except: |
| 1213 | response.close() |
| 1214 | raise |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1215 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1216 | try: |
| 1217 | import ssl |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 1218 | except ImportError: |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1219 | pass |
| 1220 | else: |
| 1221 | class HTTPSConnection(HTTPConnection): |
| 1222 | "This class allows communication via SSL." |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1223 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1224 | default_port = HTTPS_PORT |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1225 | |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 1226 | # XXX Should key_file and cert_file be deprecated in favour of context? |
| 1227 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1228 | def __init__(self, host, port=None, key_file=None, cert_file=None, |
Senthil Kumaran | 052ddb0 | 2013-03-18 14:11:41 -0700 | [diff] [blame] | 1229 | timeout=socket._GLOBAL_DEFAULT_TIMEOUT, |
| 1230 | source_address=None, *, context=None, |
| 1231 | check_hostname=None): |
| 1232 | super(HTTPSConnection, self).__init__(host, port, timeout, |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 1233 | source_address) |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1234 | self.key_file = key_file |
| 1235 | self.cert_file = cert_file |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 1236 | if context is None: |
Benjamin Peterson | 4ffb075 | 2014-11-03 14:29:33 -0500 | [diff] [blame] | 1237 | context = ssl._create_default_https_context() |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 1238 | will_verify = context.verify_mode != ssl.CERT_NONE |
| 1239 | if check_hostname is None: |
Benjamin Peterson | a090f01 | 2014-12-07 13:18:25 -0500 | [diff] [blame] | 1240 | check_hostname = context.check_hostname |
| 1241 | if check_hostname and not will_verify: |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 1242 | raise ValueError("check_hostname needs a SSL context with " |
| 1243 | "either CERT_OPTIONAL or CERT_REQUIRED") |
| 1244 | if key_file or cert_file: |
Antoine Pitrou | 8060399 | 2010-10-13 10:45:16 +0000 | [diff] [blame] | 1245 | context.load_cert_chain(cert_file, key_file) |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 1246 | self._context = context |
| 1247 | self._check_hostname = check_hostname |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1248 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1249 | def connect(self): |
| 1250 | "Connect to a host on a given (SSL) port." |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1251 | |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 1252 | super().connect() |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 1253 | |
| 1254 | if self._tunnel_host: |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 1255 | server_hostname = self._tunnel_host |
| 1256 | else: |
| 1257 | server_hostname = self.host |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 1258 | |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 1259 | self.sock = self._context.wrap_socket(self.sock, |
Benjamin Peterson | 7243b57 | 2014-11-23 17:04:34 -0600 | [diff] [blame] | 1260 | server_hostname=server_hostname) |
Christian Heimes | f723c71 | 2013-12-05 07:51:17 +0100 | [diff] [blame] | 1261 | if not self._context.check_hostname and self._check_hostname: |
| 1262 | try: |
Senthil Kumaran | 9da047b | 2014-04-14 13:07:56 -0400 | [diff] [blame] | 1263 | ssl.match_hostname(self.sock.getpeercert(), server_hostname) |
Christian Heimes | f723c71 | 2013-12-05 07:51:17 +0100 | [diff] [blame] | 1264 | except Exception: |
| 1265 | self.sock.shutdown(socket.SHUT_RDWR) |
| 1266 | self.sock.close() |
| 1267 | raise |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1268 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1269 | __all__.append("HTTPSConnection") |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1270 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1271 | class HTTPException(Exception): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1272 | # Subclasses that define an __init__ must call Exception.__init__ |
| 1273 | # or define self.args. Otherwise, str() will fail. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1274 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1275 | |
| 1276 | class NotConnected(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1277 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1278 | |
Skip Montanaro | 9d38997 | 2002-03-24 16:53:50 +0000 | [diff] [blame] | 1279 | class InvalidURL(HTTPException): |
| 1280 | pass |
| 1281 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1282 | class UnknownProtocol(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1283 | def __init__(self, version): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1284 | self.args = version, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1285 | self.version = version |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1286 | |
| 1287 | class UnknownTransferEncoding(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1288 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1289 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1290 | class UnimplementedFileMode(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1291 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1292 | |
| 1293 | class IncompleteRead(HTTPException): |
Benjamin Peterson | 6accb98 | 2009-03-02 22:50:25 +0000 | [diff] [blame] | 1294 | def __init__(self, partial, expected=None): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1295 | self.args = partial, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1296 | self.partial = partial |
Benjamin Peterson | 6accb98 | 2009-03-02 22:50:25 +0000 | [diff] [blame] | 1297 | self.expected = expected |
| 1298 | def __repr__(self): |
| 1299 | if self.expected is not None: |
| 1300 | e = ', %i more expected' % self.expected |
| 1301 | else: |
| 1302 | e = '' |
Serhiy Storchaka | 465e60e | 2014-07-25 23:36:00 +0300 | [diff] [blame] | 1303 | return '%s(%i bytes read%s)' % (self.__class__.__name__, |
| 1304 | len(self.partial), e) |
Benjamin Peterson | 6accb98 | 2009-03-02 22:50:25 +0000 | [diff] [blame] | 1305 | def __str__(self): |
| 1306 | return repr(self) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1307 | |
| 1308 | class ImproperConnectionState(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1309 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1310 | |
| 1311 | class CannotSendRequest(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1312 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1313 | |
| 1314 | class CannotSendHeader(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1315 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1316 | |
| 1317 | class ResponseNotReady(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1318 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1319 | |
| 1320 | class BadStatusLine(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1321 | def __init__(self, line): |
Benjamin Peterson | 11dbfd4 | 2010-03-21 22:50:04 +0000 | [diff] [blame] | 1322 | if not line: |
| 1323 | line = repr(line) |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1324 | self.args = line, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1325 | self.line = line |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1326 | |
Senthil Kumaran | 5466bf1 | 2010-12-18 16:55:23 +0000 | [diff] [blame] | 1327 | class LineTooLong(HTTPException): |
| 1328 | def __init__(self, line_type): |
| 1329 | HTTPException.__init__(self, "got more than %d bytes when reading %s" |
| 1330 | % (_MAXLINE, line_type)) |
| 1331 | |
R David Murray | cae7bdb | 2015-04-05 19:26:29 -0400 | [diff] [blame] | 1332 | class RemoteDisconnected(ConnectionResetError, BadStatusLine): |
| 1333 | def __init__(self, *pos, **kw): |
| 1334 | BadStatusLine.__init__(self, "") |
| 1335 | ConnectionResetError.__init__(self, *pos, **kw) |
| 1336 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1337 | # for backwards compatibility |
| 1338 | error = HTTPException |