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