blob: 763e1ef4f6bf323f6bb2177d1c1b37b064e98400 [file] [log] [blame]
Greg Stein5e0fa402000-06-26 08:28:01 +00001"""HTTP/1.1 client library
Guido van Rossum41999c11997-12-09 00:12:23 +00002
Greg Stein5e0fa402000-06-26 08:28:01 +00003<intro stuff goes here>
4<other stuff, too>
Guido van Rossum41999c11997-12-09 00:12:23 +00005
Thomas Wouters0e3f5912006-08-11 14:57:12 +00006HTTPConnection goes through a number of "states", which define when a client
Greg Stein5e0fa402000-06-26 08:28:01 +00007may legally make another request or fetch the response for a particular
8request. This diagram details these state transitions:
Guido van Rossum41999c11997-12-09 00:12:23 +00009
Greg Stein5e0fa402000-06-26 08:28:01 +000010 (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 Murraycae7bdb2015-04-05 19:26:29 -040023 |\_____________________________
24 | | getresponse() raises
25 | response = getresponse() | ConnectionError
26 v v
27 Unread-response Idle
28 [Response-headers-read]
Greg Stein5e0fa402000-06-26 08:28:01 +000029 |\____________________
Tim Peters5ceadc82001-01-13 19:16:21 +000030 | |
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 Stein5e0fa402000-06-26 08:28:01 +000043
44This 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
50Note: 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
61Logical State __state __response
62------------- ------- ----------
63Idle _CS_IDLE None
64Request-started _CS_REQ_STARTED None
65Request-sent _CS_REQ_SENT None
66Unread-response _CS_IDLE <response_class>
67Req-started-unread-response _CS_REQ_STARTED <response_class>
68Req-sent-unread-response _CS_REQ_SENT <response_class>
Guido van Rossum41999c11997-12-09 00:12:23 +000069"""
Guido van Rossum23acc951994-02-21 16:36:04 +000070
Barry Warsaw820c1202008-06-12 04:06:45 +000071import email.parser
72import email.message
Serhiy Storchakae4db7692014-12-23 16:28:28 +020073import http
Jeremy Hylton636950f2009-03-28 04:34:21 +000074import io
75import os
Serhiy Storchakaa112a8a2015-03-12 11:13:36 +020076import re
Jeremy Hylton636950f2009-03-28 04:34:21 +000077import socket
Senthil Kumaran7bc0d872010-12-19 10:49:52 +000078import collections
Jeremy Hylton1afc1692008-06-18 20:49:58 +000079from urllib.parse import urlsplit
Guido van Rossum23acc951994-02-21 16:36:04 +000080
Berker Peksagbabc6882015-02-20 09:39:38 +020081# HTTPMessage, parse_headers(), and the HTTP status code constants are
82# intentionally omitted for simplicity
Thomas Wouters47b49bf2007-08-30 22:15:33 +000083__all__ = ["HTTPResponse", "HTTPConnection",
Skip Montanaro951a8842001-06-01 16:25:38 +000084 "HTTPException", "NotConnected", "UnknownProtocol",
Jeremy Hylton7c75c992002-06-28 23:38:14 +000085 "UnknownTransferEncoding", "UnimplementedFileMode",
86 "IncompleteRead", "InvalidURL", "ImproperConnectionState",
87 "CannotSendRequest", "CannotSendHeader", "ResponseNotReady",
R David Murraycae7bdb2015-04-05 19:26:29 -040088 "BadStatusLine", "LineTooLong", "RemoteDisconnected", "error",
89 "responses"]
Skip Montanaro2dd42762001-01-23 15:35:05 +000090
Guido van Rossum23acc951994-02-21 16:36:04 +000091HTTP_PORT = 80
Guido van Rossum09c8b6c1999-12-07 21:37:17 +000092HTTPS_PORT = 443
93
Greg Stein5e0fa402000-06-26 08:28:01 +000094_UNKNOWN = 'UNKNOWN'
95
96# connection states
97_CS_IDLE = 'Idle'
98_CS_REQ_STARTED = 'Request-started'
99_CS_REQ_SENT = 'Request-sent'
100
Martin v. Löwis39a31782004-09-18 09:03:49 +0000101
Serhiy Storchakae4db7692014-12-23 16:28:28 +0200102# hack to maintain backwards compatibility
103globals().update(http.HTTPStatus.__members__)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000104
Serhiy Storchakae4db7692014-12-23 16:28:28 +0200105# another hack to maintain backwards compatibility
Georg Brandl6aab16e2006-02-17 19:17:25 +0000106# Mapping status codes to official W3C names
Serhiy Storchakae4db7692014-12-23 16:28:28 +0200107responses = {v: v.phrase for v in http.HTTPStatus.__members__.values()}
Georg Brandl6aab16e2006-02-17 19:17:25 +0000108
Georg Brandl80ba8e82005-09-29 20:16:07 +0000109# maximal amount of data to read at one time in _safe_read
110MAXAMOUNT = 1048576
111
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000112# maximal line length when calling readline().
113_MAXLINE = 65536
Georg Brandlbf3f8eb2013-10-27 07:34:48 +0100114_MAXHEADERS = 100
115
Serhiy Storchakaa112a8a2015-03-12 11:13:36 +0200116# Header name/value ABNF (http://tools.ietf.org/html/rfc7230#section-3.2)
117#
118# VCHAR = %x21-7E
119# obs-text = %x80-FF
120# header-field = field-name ":" OWS field-value OWS
121# field-name = token
122# field-value = *( field-content / obs-fold )
123# field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ]
124# field-vchar = VCHAR / obs-text
125#
126# obs-fold = CRLF 1*( SP / HTAB )
127# ; obsolete line folding
128# ; see Section 3.2.4
129
130# token = 1*tchar
131#
132# tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*"
133# / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~"
134# / DIGIT / ALPHA
135# ; any VCHAR, except delimiters
136#
137# VCHAR defined in http://tools.ietf.org/html/rfc5234#appendix-B.1
138
139# the patterns for both name and value are more leniant than RFC
140# definitions to allow for backwards compatibility
141_is_legal_header_name = re.compile(rb'[^:\s][^:\r\n]*').fullmatch
142_is_illegal_header_value = re.compile(rb'\n(?![ \t])|\r(?![ \t\n])').search
143
R David Murraybeed8402015-03-22 15:18:23 -0400144# We always set the Content-Length header for these methods because some
145# servers will otherwise respond with a 411
146_METHODS_EXPECTING_BODY = {'PATCH', 'POST', 'PUT'}
147
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000148
Martin Panter44391482016-02-09 10:20:52 +0000149def _encode(data, name='data'):
150 """Call data.encode("latin-1") but show a better error message."""
151 try:
152 return data.encode("latin-1")
153 except UnicodeEncodeError as err:
154 raise UnicodeEncodeError(
155 err.encoding,
156 err.object,
157 err.start,
158 err.end,
159 "%s (%.20r) is not valid Latin-1. Use %s.encode('utf-8') "
160 "if you want to send it encoded in UTF-8." %
161 (name.title(), data[err.start:err.end], name)) from None
162
163
Barry Warsaw820c1202008-06-12 04:06:45 +0000164class HTTPMessage(email.message.Message):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000165 # XXX The only usage of this method is in
166 # http.server.CGIHTTPRequestHandler. Maybe move the code there so
167 # that it doesn't need to be part of the public API. The API has
168 # never been defined so this could cause backwards compatibility
169 # issues.
170
Barry Warsaw820c1202008-06-12 04:06:45 +0000171 def getallmatchingheaders(self, name):
172 """Find all header lines matching a given header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000173
Barry Warsaw820c1202008-06-12 04:06:45 +0000174 Look through the list of headers and find all lines matching a given
175 header name (and their continuation lines). A list of the lines is
176 returned, without interpretation. If the header does not occur, an
177 empty list is returned. If the header occurs multiple times, all
178 occurrences are returned. Case is not important in the header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000179
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000180 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000181 name = name.lower() + ':'
182 n = len(name)
183 lst = []
184 hit = 0
185 for line in self.keys():
186 if line[:n].lower() == name:
187 hit = 1
188 elif not line[:1].isspace():
189 hit = 0
190 if hit:
191 lst.append(line)
192 return lst
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000193
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000194def parse_headers(fp, _class=HTTPMessage):
Barry Warsaw820c1202008-06-12 04:06:45 +0000195 """Parses only RFC2822 headers from a file pointer.
196
197 email Parser wants to see strings rather than bytes.
198 But a TextIOWrapper around self.rfile would buffer too many bytes
199 from the stream, bytes which we later need to read as bytes.
200 So we read the correct bytes here, as bytes, for email Parser
201 to parse.
202
203 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000204 headers = []
205 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000206 line = fp.readline(_MAXLINE + 1)
207 if len(line) > _MAXLINE:
208 raise LineTooLong("header line")
Barry Warsaw820c1202008-06-12 04:06:45 +0000209 headers.append(line)
Georg Brandlbf3f8eb2013-10-27 07:34:48 +0100210 if len(headers) > _MAXHEADERS:
211 raise HTTPException("got more than %d headers" % _MAXHEADERS)
Barry Warsaw820c1202008-06-12 04:06:45 +0000212 if line in (b'\r\n', b'\n', b''):
213 break
214 hstring = b''.join(headers).decode('iso-8859-1')
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000215 return email.parser.Parser(_class=_class).parsestr(hstring)
Greg Stein5e0fa402000-06-26 08:28:01 +0000216
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000217
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000218class HTTPResponse(io.BufferedIOBase):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000219
220 # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details.
221
Jeremy Hylton811fc142007-08-03 13:30:02 +0000222 # The bytes from the socket object are iso-8859-1 strings.
223 # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded
224 # text following RFC 2047. The basic status line parsing only
225 # accepts iso-8859-1.
226
Senthil Kumaran052ddb02013-03-18 14:11:41 -0700227 def __init__(self, sock, debuglevel=0, method=None, url=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000228 # If the response includes a content-length header, we need to
229 # make sure that the client doesn't read more than the
Jeremy Hylton39b198d2007-08-04 19:22:00 +0000230 # specified number of bytes. If it does, it will block until
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000231 # the server times out and closes the connection. This will
232 # happen if a self.fp.read() is done (without a size) whether
233 # self.fp is buffered or not. So, no self.fp.read() by
234 # clients unless they know what they are doing.
Benjamin Petersonf72d9fb2009-02-08 00:29:20 +0000235 self.fp = sock.makefile("rb")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000236 self.debuglevel = debuglevel
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000237 self._method = method
Greg Stein5e0fa402000-06-26 08:28:01 +0000238
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000239 # The HTTPResponse object is returned via urllib. The clients
240 # of http and urllib expect different attributes for the
241 # headers. headers is used here and supports urllib. msg is
242 # provided as a backwards compatibility layer for http
243 # clients.
244
245 self.headers = self.msg = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000246
Greg Steindd6eefb2000-07-18 09:09:48 +0000247 # from the Status-Line of the response
Tim Peters07e99cb2001-01-14 23:47:14 +0000248 self.version = _UNKNOWN # HTTP-Version
249 self.status = _UNKNOWN # Status-Code
250 self.reason = _UNKNOWN # Reason-Phrase
Greg Stein5e0fa402000-06-26 08:28:01 +0000251
Tim Peters07e99cb2001-01-14 23:47:14 +0000252 self.chunked = _UNKNOWN # is "chunked" being used?
253 self.chunk_left = _UNKNOWN # bytes left to read in current chunk
254 self.length = _UNKNOWN # number of bytes left in response
255 self.will_close = _UNKNOWN # conn will close at end of response
Greg Stein5e0fa402000-06-26 08:28:01 +0000256
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000257 def _read_status(self):
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000258 line = str(self.fp.readline(_MAXLINE + 1), "iso-8859-1")
259 if len(line) > _MAXLINE:
260 raise LineTooLong("status line")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000261 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000262 print("reply:", repr(line))
Jeremy Hyltonb6769522003-06-29 17:55:05 +0000263 if not line:
264 # Presumably, the server closed the connection before
265 # sending a valid response.
R David Murraycae7bdb2015-04-05 19:26:29 -0400266 raise RemoteDisconnected("Remote end closed connection without"
267 " response")
Greg Steindd6eefb2000-07-18 09:09:48 +0000268 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000269 version, status, reason = line.split(None, 2)
Greg Steindd6eefb2000-07-18 09:09:48 +0000270 except ValueError:
271 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000272 version, status = line.split(None, 1)
Greg Steindd6eefb2000-07-18 09:09:48 +0000273 reason = ""
274 except ValueError:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000275 # empty version will cause next test to fail.
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000276 version = ""
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000277 if not version.startswith("HTTP/"):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200278 self._close_conn()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000279 raise BadStatusLine(line)
Greg Stein5e0fa402000-06-26 08:28:01 +0000280
Jeremy Hylton23d40472001-04-13 14:57:08 +0000281 # The status code is a three-digit number
282 try:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000283 status = int(status)
Jeremy Hylton23d40472001-04-13 14:57:08 +0000284 if status < 100 or status > 999:
285 raise BadStatusLine(line)
286 except ValueError:
287 raise BadStatusLine(line)
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000288 return version, status, reason
Greg Stein5e0fa402000-06-26 08:28:01 +0000289
Jeremy Hylton39c03802002-07-12 14:04:09 +0000290 def begin(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000291 if self.headers is not None:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000292 # we've already started reading the response
293 return
294
295 # read until we get a non-100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000296 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000297 version, status, reason = self._read_status()
Martin v. Löwis39a31782004-09-18 09:03:49 +0000298 if status != CONTINUE:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000299 break
300 # skip the header from the 100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000301 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000302 skip = self.fp.readline(_MAXLINE + 1)
303 if len(skip) > _MAXLINE:
304 raise LineTooLong("header line")
305 skip = skip.strip()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000306 if not skip:
307 break
308 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000309 print("header:", skip)
Tim Petersc411dba2002-07-16 21:35:23 +0000310
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000311 self.code = self.status = status
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000312 self.reason = reason.strip()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000313 if version in ("HTTP/1.0", "HTTP/0.9"):
314 # Some servers might still return "0.9", treat it as 1.0 anyway
Greg Steindd6eefb2000-07-18 09:09:48 +0000315 self.version = 10
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000316 elif version.startswith("HTTP/1."):
Tim Peters07e99cb2001-01-14 23:47:14 +0000317 self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1
Greg Steindd6eefb2000-07-18 09:09:48 +0000318 else:
319 raise UnknownProtocol(version)
Greg Stein5e0fa402000-06-26 08:28:01 +0000320
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000321 self.headers = self.msg = parse_headers(self.fp)
Barry Warsaw820c1202008-06-12 04:06:45 +0000322
Jeremy Hylton30f86742000-09-18 22:50:38 +0000323 if self.debuglevel > 0:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000324 for hdr in self.headers:
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000325 print("header:", hdr, end=" ")
Greg Stein5e0fa402000-06-26 08:28:01 +0000326
Greg Steindd6eefb2000-07-18 09:09:48 +0000327 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000328 tr_enc = self.headers.get("transfer-encoding")
Jeremy Hyltond229b3a2002-09-03 19:24:24 +0000329 if tr_enc and tr_enc.lower() == "chunked":
Jeremy Hylton236156f2008-12-15 03:00:50 +0000330 self.chunked = True
Greg Steindd6eefb2000-07-18 09:09:48 +0000331 self.chunk_left = None
332 else:
Jeremy Hylton236156f2008-12-15 03:00:50 +0000333 self.chunked = False
Greg Stein5e0fa402000-06-26 08:28:01 +0000334
Greg Steindd6eefb2000-07-18 09:09:48 +0000335 # will the connection close at the end of the response?
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000336 self.will_close = self._check_close()
Greg Stein5e0fa402000-06-26 08:28:01 +0000337
Greg Steindd6eefb2000-07-18 09:09:48 +0000338 # do we have a Content-Length?
339 # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked"
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000340 self.length = None
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000341 length = self.headers.get("content-length")
Barry Warsaw820c1202008-06-12 04:06:45 +0000342
343 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000344 tr_enc = self.headers.get("transfer-encoding")
Greg Steindd6eefb2000-07-18 09:09:48 +0000345 if length and not self.chunked:
Jeremy Hylton30a81812000-09-14 20:34:27 +0000346 try:
347 self.length = int(length)
348 except ValueError:
Christian Heimesa612dc02008-02-24 13:08:18 +0000349 self.length = None
350 else:
351 if self.length < 0: # ignore nonsensical negative lengths
352 self.length = None
353 else:
354 self.length = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000355
Greg Steindd6eefb2000-07-18 09:09:48 +0000356 # does the body have a fixed length? (of zero)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000357 if (status == NO_CONTENT or status == NOT_MODIFIED or
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000358 100 <= status < 200 or # 1xx codes
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000359 self._method == "HEAD"):
Greg Steindd6eefb2000-07-18 09:09:48 +0000360 self.length = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000361
Greg Steindd6eefb2000-07-18 09:09:48 +0000362 # if the connection remains open, and we aren't using chunked, and
363 # a content-length was not provided, then assume that the connection
364 # WILL close.
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000365 if (not self.will_close and
366 not self.chunked and
367 self.length is None):
Jeremy Hylton236156f2008-12-15 03:00:50 +0000368 self.will_close = True
Greg Stein5e0fa402000-06-26 08:28:01 +0000369
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000370 def _check_close(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000371 conn = self.headers.get("connection")
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000372 if self.version == 11:
373 # An HTTP/1.1 proxy is assumed to stay open unless
374 # explicitly closed.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000375 conn = self.headers.get("connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000376 if conn and "close" in conn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000377 return True
378 return False
379
Jeremy Hylton2c178252004-08-07 16:28:14 +0000380 # Some HTTP/1.0 implementations have support for persistent
381 # connections, using rules different than HTTP/1.1.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000382
Christian Heimes895627f2007-12-08 17:28:33 +0000383 # For older HTTP, Keep-Alive indicates persistent connection.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000384 if self.headers.get("keep-alive"):
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000385 return False
Tim Peters77c06fb2002-11-24 02:35:35 +0000386
Jeremy Hylton2c178252004-08-07 16:28:14 +0000387 # At least Akamai returns a "Connection: Keep-Alive" header,
388 # which was supposed to be sent by the client.
389 if conn and "keep-alive" in conn.lower():
390 return False
391
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000392 # Proxy-Connection is a netscape hack.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000393 pconn = self.headers.get("proxy-connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000394 if pconn and "keep-alive" in pconn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000395 return False
396
397 # otherwise, assume it will close
398 return True
399
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200400 def _close_conn(self):
401 fp = self.fp
402 self.fp = None
403 fp.close()
404
Greg Steindd6eefb2000-07-18 09:09:48 +0000405 def close(self):
Serhiy Storchaka7e7a3db2015-04-10 13:24:41 +0300406 try:
407 super().close() # set "closed" flag
408 finally:
409 if self.fp:
410 self._close_conn()
Greg Stein5e0fa402000-06-26 08:28:01 +0000411
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000412 # These implementations are for the benefit of io.BufferedReader.
413
414 # XXX This class should probably be revised to act more like
415 # the "raw stream" that BufferedReader expects.
416
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000417 def flush(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200418 super().flush()
419 if self.fp:
420 self.fp.flush()
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000421
Jeremy Hyltona7cff022009-04-01 02:35:56 +0000422 def readable(self):
Raymond Hettinger15b87bf2015-08-18 22:03:08 -0700423 """Always returns True"""
Jeremy Hyltona7cff022009-04-01 02:35:56 +0000424 return True
425
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000426 # End of "raw stream" methods
427
Greg Steindd6eefb2000-07-18 09:09:48 +0000428 def isclosed(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200429 """True if the connection is closed."""
Greg Steindd6eefb2000-07-18 09:09:48 +0000430 # NOTE: it is possible that we will not ever call self.close(). This
431 # case occurs when will_close is TRUE, length is None, and we
432 # read up to the last byte, but NOT past it.
433 #
434 # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be
435 # called, meaning self.isclosed() is meaningful.
436 return self.fp is None
437
438 def read(self, amt=None):
439 if self.fp is None:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000440 return b""
Greg Steindd6eefb2000-07-18 09:09:48 +0000441
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000442 if self._method == "HEAD":
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200443 self._close_conn()
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000444 return b""
445
Antoine Pitrou38d96432011-12-06 22:33:57 +0100446 if amt is not None:
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000447 # Amount is given, implement using readinto
448 b = bytearray(amt)
449 n = self.readinto(b)
450 return memoryview(b)[:n].tobytes()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100451 else:
452 # Amount is not given (unbounded read) so we must check self.length
453 # and self.chunked
Tim Peters230a60c2002-11-09 05:08:07 +0000454
Antoine Pitrou38d96432011-12-06 22:33:57 +0100455 if self.chunked:
456 return self._readall_chunked()
457
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000458 if self.length is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000459 s = self.fp.read()
460 else:
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100461 try:
462 s = self._safe_read(self.length)
463 except IncompleteRead:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200464 self._close_conn()
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100465 raise
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000466 self.length = 0
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200467 self._close_conn() # we read everything
Greg Steindd6eefb2000-07-18 09:09:48 +0000468 return s
469
Antoine Pitrou38d96432011-12-06 22:33:57 +0100470 def readinto(self, b):
Raymond Hettinger15b87bf2015-08-18 22:03:08 -0700471 """Read up to len(b) bytes into bytearray b and return the number
472 of bytes read.
473 """
474
Antoine Pitrou38d96432011-12-06 22:33:57 +0100475 if self.fp is None:
476 return 0
477
478 if self._method == "HEAD":
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200479 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100480 return 0
481
482 if self.chunked:
483 return self._readinto_chunked(b)
484
Greg Steindd6eefb2000-07-18 09:09:48 +0000485 if self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100486 if len(b) > self.length:
Greg Steindd6eefb2000-07-18 09:09:48 +0000487 # clip the read to the "end of response"
Antoine Pitrou38d96432011-12-06 22:33:57 +0100488 b = memoryview(b)[0:self.length]
Greg Steindd6eefb2000-07-18 09:09:48 +0000489
490 # we do not use _safe_read() here because this may be a .will_close
491 # connection, and the user is reading more bytes than will be provided
492 # (for example, reading in 1k chunks)
Antoine Pitrou38d96432011-12-06 22:33:57 +0100493 n = self.fp.readinto(b)
Serhiy Storchaka1c84ac12013-12-17 21:50:02 +0200494 if not n and b:
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100495 # Ideally, we would raise IncompleteRead if the content-length
496 # wasn't satisfied, but it might break compatibility.
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200497 self._close_conn()
Antoine Pitrou6a35e182013-02-02 23:04:56 +0100498 elif self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100499 self.length -= n
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000500 if not self.length:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200501 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100502 return n
Greg Steindd6eefb2000-07-18 09:09:48 +0000503
Antoine Pitrou38d96432011-12-06 22:33:57 +0100504 def _read_next_chunk_size(self):
505 # Read the next chunk size from the file
506 line = self.fp.readline(_MAXLINE + 1)
507 if len(line) > _MAXLINE:
508 raise LineTooLong("chunk size")
509 i = line.find(b";")
510 if i >= 0:
511 line = line[:i] # strip chunk-extensions
512 try:
513 return int(line, 16)
514 except ValueError:
515 # close the connection as protocol synchronisation is
516 # probably lost
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200517 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100518 raise
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000519
Antoine Pitrou38d96432011-12-06 22:33:57 +0100520 def _read_and_discard_trailer(self):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000521 # read and discard trailer up to the CRLF terminator
522 ### note: we shouldn't have any trailers!
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000523 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000524 line = self.fp.readline(_MAXLINE + 1)
525 if len(line) > _MAXLINE:
526 raise LineTooLong("trailer line")
Christian Heimes0bd4e112008-02-12 22:59:25 +0000527 if not line:
528 # a vanishingly small number of sites EOF without
529 # sending the trailer
530 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800531 if line in (b'\r\n', b'\n', b''):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000532 break
533
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000534 def _get_chunk_left(self):
535 # return self.chunk_left, reading a new chunk if necessary.
536 # chunk_left == 0: at the end of the current chunk, need to close it
537 # chunk_left == None: No current chunk, should read next.
538 # This function returns non-zero or None if the last chunk has
539 # been read.
540 chunk_left = self.chunk_left
541 if not chunk_left: # Can be 0 or None
542 if chunk_left is not None:
543 # We are at the end of chunk. dicard chunk end
544 self._safe_read(2) # toss the CRLF at the end of the chunk
545 try:
546 chunk_left = self._read_next_chunk_size()
547 except ValueError:
548 raise IncompleteRead(b'')
549 if chunk_left == 0:
550 # last chunk: 1*("0") [ chunk-extension ] CRLF
551 self._read_and_discard_trailer()
552 # we read everything; close the "file"
553 self._close_conn()
554 chunk_left = None
555 self.chunk_left = chunk_left
556 return chunk_left
557
Antoine Pitrou38d96432011-12-06 22:33:57 +0100558 def _readall_chunked(self):
559 assert self.chunked != _UNKNOWN
Antoine Pitrou38d96432011-12-06 22:33:57 +0100560 value = []
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000561 try:
562 while True:
563 chunk_left = self._get_chunk_left()
564 if chunk_left is None:
565 break
566 value.append(self._safe_read(chunk_left))
567 self.chunk_left = 0
568 return b''.join(value)
569 except IncompleteRead:
570 raise IncompleteRead(b''.join(value))
Tim Peters230a60c2002-11-09 05:08:07 +0000571
Antoine Pitrou38d96432011-12-06 22:33:57 +0100572 def _readinto_chunked(self, b):
573 assert self.chunked != _UNKNOWN
Antoine Pitrou38d96432011-12-06 22:33:57 +0100574 total_bytes = 0
575 mvb = memoryview(b)
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000576 try:
577 while True:
578 chunk_left = self._get_chunk_left()
579 if chunk_left is None:
580 return total_bytes
Antoine Pitrou4ce6aa42011-12-06 22:34:36 +0100581
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000582 if len(mvb) <= chunk_left:
583 n = self._safe_readinto(mvb)
584 self.chunk_left = chunk_left - n
585 return total_bytes + n
586
587 temp_mvb = mvb[:chunk_left]
Antoine Pitrou38d96432011-12-06 22:33:57 +0100588 n = self._safe_readinto(temp_mvb)
589 mvb = mvb[n:]
590 total_bytes += n
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000591 self.chunk_left = 0
Antoine Pitrou38d96432011-12-06 22:33:57 +0100592
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000593 except IncompleteRead:
594 raise IncompleteRead(bytes(b[0:total_bytes]))
Antoine Pitrou38d96432011-12-06 22:33:57 +0100595
Greg Steindd6eefb2000-07-18 09:09:48 +0000596 def _safe_read(self, amt):
597 """Read the number of bytes requested, compensating for partial reads.
598
599 Normally, we have a blocking socket, but a read() can be interrupted
600 by a signal (resulting in a partial read).
601
602 Note that we cannot distinguish between EOF and an interrupt when zero
603 bytes have been read. IncompleteRead() will be raised in this
604 situation.
605
606 This function should be used when <amt> bytes "should" be present for
607 reading. If the bytes are truly not available (due to EOF), then the
608 IncompleteRead exception can be used to detect the problem.
609 """
Georg Brandl80ba8e82005-09-29 20:16:07 +0000610 s = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000611 while amt > 0:
Georg Brandl80ba8e82005-09-29 20:16:07 +0000612 chunk = self.fp.read(min(amt, MAXAMOUNT))
Greg Steindd6eefb2000-07-18 09:09:48 +0000613 if not chunk:
Benjamin Peterson6accb982009-03-02 22:50:25 +0000614 raise IncompleteRead(b''.join(s), amt)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000615 s.append(chunk)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000616 amt -= len(chunk)
Guido van Rossuma00f1232007-09-12 19:43:09 +0000617 return b"".join(s)
Greg Steindd6eefb2000-07-18 09:09:48 +0000618
Antoine Pitrou38d96432011-12-06 22:33:57 +0100619 def _safe_readinto(self, b):
620 """Same as _safe_read, but for reading into a buffer."""
621 total_bytes = 0
622 mvb = memoryview(b)
623 while total_bytes < len(b):
624 if MAXAMOUNT < len(mvb):
625 temp_mvb = mvb[0:MAXAMOUNT]
626 n = self.fp.readinto(temp_mvb)
627 else:
628 n = self.fp.readinto(mvb)
629 if not n:
630 raise IncompleteRead(bytes(mvb[0:total_bytes]), len(b))
631 mvb = mvb[n:]
632 total_bytes += n
633 return total_bytes
634
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000635 def read1(self, n=-1):
636 """Read with at most one underlying system call. If at least one
637 byte is buffered, return that instead.
638 """
639 if self.fp is None or self._method == "HEAD":
640 return b""
641 if self.chunked:
642 return self._read1_chunked(n)
Martin Panterce911c32016-03-17 06:42:48 +0000643 if self.length is not None and (n < 0 or n > self.length):
644 n = self.length
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000645 try:
646 result = self.fp.read1(n)
647 except ValueError:
648 if n >= 0:
649 raise
650 # some implementations, like BufferedReader, don't support -1
651 # Read an arbitrarily selected largeish chunk.
652 result = self.fp.read1(16*1024)
653 if not result and n:
654 self._close_conn()
Martin Panterce911c32016-03-17 06:42:48 +0000655 elif self.length is not None:
656 self.length -= len(result)
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000657 return result
658
659 def peek(self, n=-1):
660 # Having this enables IOBase.readline() to read more than one
661 # byte at a time
662 if self.fp is None or self._method == "HEAD":
663 return b""
664 if self.chunked:
665 return self._peek_chunked(n)
666 return self.fp.peek(n)
667
668 def readline(self, limit=-1):
669 if self.fp is None or self._method == "HEAD":
670 return b""
671 if self.chunked:
672 # Fallback to IOBase readline which uses peek() and read()
673 return super().readline(limit)
Martin Panterce911c32016-03-17 06:42:48 +0000674 if self.length is not None and (limit < 0 or limit > self.length):
675 limit = self.length
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000676 result = self.fp.readline(limit)
677 if not result and limit:
678 self._close_conn()
Martin Panterce911c32016-03-17 06:42:48 +0000679 elif self.length is not None:
680 self.length -= len(result)
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000681 return result
682
683 def _read1_chunked(self, n):
684 # Strictly speaking, _get_chunk_left() may cause more than one read,
685 # but that is ok, since that is to satisfy the chunked protocol.
686 chunk_left = self._get_chunk_left()
687 if chunk_left is None or n == 0:
688 return b''
689 if not (0 <= n <= chunk_left):
690 n = chunk_left # if n is negative or larger than chunk_left
691 read = self.fp.read1(n)
692 self.chunk_left -= len(read)
693 if not read:
694 raise IncompleteRead(b"")
695 return read
696
697 def _peek_chunked(self, n):
698 # Strictly speaking, _get_chunk_left() may cause more than one read,
699 # but that is ok, since that is to satisfy the chunked protocol.
700 try:
701 chunk_left = self._get_chunk_left()
702 except IncompleteRead:
703 return b'' # peek doesn't worry about protocol
704 if chunk_left is None:
705 return b'' # eof
706 # peek is allowed to return more than requested. Just request the
707 # entire chunk, and truncate what we get.
708 return self.fp.peek(chunk_left)[:chunk_left]
709
Antoine Pitroub353c122009-02-11 00:39:14 +0000710 def fileno(self):
711 return self.fp.fileno()
712
Greg Steindd6eefb2000-07-18 09:09:48 +0000713 def getheader(self, name, default=None):
Raymond Hettinger15b87bf2015-08-18 22:03:08 -0700714 '''Returns the value of the header matching *name*.
715
716 If there are multiple matching headers, the values are
717 combined into a single string separated by commas and spaces.
718
719 If no matching header is found, returns *default* or None if
720 the *default* is not specified.
721
722 If the headers are unknown, raises http.client.ResponseNotReady.
723
724 '''
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000725 if self.headers is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000726 raise ResponseNotReady()
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000727 headers = self.headers.get_all(name) or default
728 if isinstance(headers, str) or not hasattr(headers, '__iter__'):
729 return headers
730 else:
731 return ', '.join(headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000732
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000733 def getheaders(self):
734 """Return list of (header, value) tuples."""
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000735 if self.headers is None:
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000736 raise ResponseNotReady()
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000737 return list(self.headers.items())
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000738
Antoine Pitroub353c122009-02-11 00:39:14 +0000739 # We override IOBase.__iter__ so that it doesn't check for closed-ness
740
741 def __iter__(self):
742 return self
743
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000744 # For compatibility with old-style urllib responses.
745
746 def info(self):
Raymond Hettinger15b87bf2015-08-18 22:03:08 -0700747 '''Returns an instance of the class mimetools.Message containing
748 meta-information associated with the URL.
749
750 When the method is HTTP, these headers are those returned by
751 the server at the head of the retrieved HTML page (including
752 Content-Length and Content-Type).
753
754 When the method is FTP, a Content-Length header will be
755 present if (as is now usual) the server passed back a file
756 length in response to the FTP retrieval request. A
757 Content-Type header will be present if the MIME type can be
758 guessed.
759
760 When the method is local-file, returned headers will include
Serhiy Storchaka3fd4a732015-12-18 13:10:37 +0200761 a Date representing the file's last-modified time, a
Raymond Hettinger15b87bf2015-08-18 22:03:08 -0700762 Content-Length giving file size, and a Content-Type
Serhiy Storchaka3fd4a732015-12-18 13:10:37 +0200763 containing a guess at the file's type. See also the
Raymond Hettinger15b87bf2015-08-18 22:03:08 -0700764 description of the mimetools module.
765
766 '''
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000767 return self.headers
768
769 def geturl(self):
Raymond Hettinger15b87bf2015-08-18 22:03:08 -0700770 '''Return the real URL of the page.
771
772 In some cases, the HTTP server redirects a client to another
773 URL. The urlopen() function handles this transparently, but in
774 some cases the caller needs to know which URL the client was
775 redirected to. The geturl() method can be used to get at this
776 redirected URL.
777
778 '''
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000779 return self.url
780
781 def getcode(self):
Raymond Hettinger15b87bf2015-08-18 22:03:08 -0700782 '''Return the HTTP status code that was sent with the response,
783 or None if the URL is not an HTTP URL.
784
785 '''
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000786 return self.status
Greg Stein5e0fa402000-06-26 08:28:01 +0000787
788class HTTPConnection:
789
Greg Steindd6eefb2000-07-18 09:09:48 +0000790 _http_vsn = 11
791 _http_vsn_str = 'HTTP/1.1'
Greg Stein5e0fa402000-06-26 08:28:01 +0000792
Greg Steindd6eefb2000-07-18 09:09:48 +0000793 response_class = HTTPResponse
794 default_port = HTTP_PORT
795 auto_open = 1
Jeremy Hylton30f86742000-09-18 22:50:38 +0000796 debuglevel = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000797
Senthil Kumaran052ddb02013-03-18 14:11:41 -0700798 def __init__(self, host, port=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
799 source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000800 self.timeout = timeout
Gregory P. Smithb4066372010-01-03 03:28:29 +0000801 self.source_address = source_address
Greg Steindd6eefb2000-07-18 09:09:48 +0000802 self.sock = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000803 self._buffer = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000804 self.__response = None
805 self.__state = _CS_IDLE
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000806 self._method = None
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000807 self._tunnel_host = None
808 self._tunnel_port = None
Georg Brandlc7c199f2011-01-22 22:06:24 +0000809 self._tunnel_headers = {}
Tim Petersc411dba2002-07-16 21:35:23 +0000810
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400811 (self.host, self.port) = self._get_hostport(host, port)
812
813 # This is stored as an instance variable to allow unit
814 # tests to replace it with a suitable mockup
815 self._create_connection = socket.create_connection
Greg Stein5e0fa402000-06-26 08:28:01 +0000816
Senthil Kumaran47fff872009-12-20 07:10:31 +0000817 def set_tunnel(self, host, port=None, headers=None):
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400818 """Set up host and port for HTTP CONNECT tunnelling.
Senthil Kumaran47fff872009-12-20 07:10:31 +0000819
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400820 In a connection that uses HTTP CONNECT tunneling, the host passed to the
821 constructor is used as a proxy server that relays all communication to
822 the endpoint passed to `set_tunnel`. This done by sending an HTTP
823 CONNECT request to the proxy server when the connection is established.
824
825 This method must be called before the HTML connection has been
826 established.
827
828 The headers argument should be a mapping of extra HTTP headers to send
829 with the CONNECT request.
Senthil Kumaran47fff872009-12-20 07:10:31 +0000830 """
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400831
832 if self.sock:
833 raise RuntimeError("Can't set up tunnel for established connection")
834
Serhiy Storchaka4ac7ed92014-12-12 09:29:15 +0200835 self._tunnel_host, self._tunnel_port = self._get_hostport(host, port)
Senthil Kumaran47fff872009-12-20 07:10:31 +0000836 if headers:
837 self._tunnel_headers = headers
838 else:
839 self._tunnel_headers.clear()
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000840
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400841 def _get_hostport(self, host, port):
Greg Steindd6eefb2000-07-18 09:09:48 +0000842 if port is None:
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000843 i = host.rfind(':')
Skip Montanarocae14d22004-09-14 17:55:21 +0000844 j = host.rfind(']') # ipv6 addresses have [...]
845 if i > j:
Skip Montanaro9d389972002-03-24 16:53:50 +0000846 try:
847 port = int(host[i+1:])
848 except ValueError:
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200849 if host[i+1:] == "": # http://foo.com:/ == http://foo.com/
850 port = self.default_port
851 else:
852 raise InvalidURL("nonnumeric port: '%s'" % host[i+1:])
Greg Steindd6eefb2000-07-18 09:09:48 +0000853 host = host[:i]
854 else:
855 port = self.default_port
Raymond Hettinger4d037912004-10-14 15:23:38 +0000856 if host and host[0] == '[' and host[-1] == ']':
Brett Cannon0a1af4a2004-09-15 23:26:23 +0000857 host = host[1:-1]
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400858
859 return (host, port)
Greg Stein5e0fa402000-06-26 08:28:01 +0000860
Jeremy Hylton30f86742000-09-18 22:50:38 +0000861 def set_debuglevel(self, level):
862 self.debuglevel = level
863
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000864 def _tunnel(self):
Serhiy Storchaka4ac7ed92014-12-12 09:29:15 +0200865 connect_str = "CONNECT %s:%d HTTP/1.0\r\n" % (self._tunnel_host,
866 self._tunnel_port)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000867 connect_bytes = connect_str.encode("ascii")
868 self.send(connect_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000869 for header, value in self._tunnel_headers.items():
Senthil Kumaran47fff872009-12-20 07:10:31 +0000870 header_str = "%s: %s\r\n" % (header, value)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000871 header_bytes = header_str.encode("latin-1")
Senthil Kumaran47fff872009-12-20 07:10:31 +0000872 self.send(header_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000873 self.send(b'\r\n')
Senthil Kumaran47fff872009-12-20 07:10:31 +0000874
Georg Brandlc7c199f2011-01-22 22:06:24 +0000875 response = self.response_class(self.sock, method=self._method)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000876 (version, code, message) = response._read_status()
Senthil Kumaran47fff872009-12-20 07:10:31 +0000877
Serhiy Storchakae4db7692014-12-23 16:28:28 +0200878 if code != http.HTTPStatus.OK:
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000879 self.close()
Andrew Svetlov0832af62012-12-18 23:10:48 +0200880 raise OSError("Tunnel connection failed: %d %s" % (code,
881 message.strip()))
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000882 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000883 line = response.fp.readline(_MAXLINE + 1)
884 if len(line) > _MAXLINE:
885 raise LineTooLong("header line")
Senthil Kumaranb12771a2012-04-23 23:50:07 +0800886 if not line:
887 # for sites which EOF without sending a trailer
888 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800889 if line in (b'\r\n', b'\n', b''):
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000890 break
891
Berker Peksagab53ab02015-02-03 12:22:11 +0200892 if self.debuglevel > 0:
893 print('header:', line.decode())
894
Greg Steindd6eefb2000-07-18 09:09:48 +0000895 def connect(self):
896 """Connect to the host and port specified in __init__."""
Benjamin Peterson9d8a3ad2015-01-23 11:02:57 -0500897 self.sock = self._create_connection(
898 (self.host,self.port), self.timeout, self.source_address)
899 self.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400900
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000901 if self._tunnel_host:
902 self._tunnel()
Greg Stein5e0fa402000-06-26 08:28:01 +0000903
Greg Steindd6eefb2000-07-18 09:09:48 +0000904 def close(self):
905 """Close the connection to the HTTP server."""
Greg Steindd6eefb2000-07-18 09:09:48 +0000906 self.__state = _CS_IDLE
Serhiy Storchaka7e7a3db2015-04-10 13:24:41 +0300907 try:
908 sock = self.sock
909 if sock:
910 self.sock = None
911 sock.close() # close it manually... there may be other refs
912 finally:
913 response = self.__response
914 if response:
915 self.__response = None
916 response.close()
Greg Stein5e0fa402000-06-26 08:28:01 +0000917
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000918 def send(self, data):
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000919 """Send `data' to the server.
920 ``data`` can be a string object, a bytes object, an array object, a
921 file-like object that supports a .read() method, or an iterable object.
922 """
923
Greg Steindd6eefb2000-07-18 09:09:48 +0000924 if self.sock is None:
925 if self.auto_open:
926 self.connect()
927 else:
928 raise NotConnected()
Greg Stein5e0fa402000-06-26 08:28:01 +0000929
Jeremy Hylton30f86742000-09-18 22:50:38 +0000930 if self.debuglevel > 0:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000931 print("send:", repr(data))
Jeremy Hylton636950f2009-03-28 04:34:21 +0000932 blocksize = 8192
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000933 if hasattr(data, "read") :
Jeremy Hylton636950f2009-03-28 04:34:21 +0000934 if self.debuglevel > 0:
935 print("sendIng a read()able")
936 encode = False
Antoine Pitrouead1d622009-09-29 18:44:53 +0000937 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000938 mode = data.mode
Antoine Pitrouead1d622009-09-29 18:44:53 +0000939 except AttributeError:
940 # io.BytesIO and other file-like objects don't have a `mode`
941 # attribute.
942 pass
943 else:
944 if "b" not in mode:
945 encode = True
946 if self.debuglevel > 0:
947 print("encoding file using iso-8859-1")
Jeremy Hylton636950f2009-03-28 04:34:21 +0000948 while 1:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000949 datablock = data.read(blocksize)
950 if not datablock:
Jeremy Hylton636950f2009-03-28 04:34:21 +0000951 break
952 if encode:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000953 datablock = datablock.encode("iso-8859-1")
954 self.sock.sendall(datablock)
Andrew Svetlov7b2c8bb2013-04-12 22:49:19 +0300955 return
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000956 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000957 self.sock.sendall(data)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000958 except TypeError:
959 if isinstance(data, collections.Iterable):
960 for d in data:
961 self.sock.sendall(d)
962 else:
Georg Brandl25e2cd12011-08-03 08:27:00 +0200963 raise TypeError("data should be a bytes-like object "
964 "or an iterable, got %r" % type(data))
Greg Stein5e0fa402000-06-26 08:28:01 +0000965
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000966 def _output(self, s):
967 """Add a line of output to the current request buffer.
Tim Peters469cdad2002-08-08 20:19:19 +0000968
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000969 Assumes that the line does *not* end with \\r\\n.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000970 """
971 self._buffer.append(s)
972
Benjamin Peterson1742e402008-11-30 22:15:29 +0000973 def _send_output(self, message_body=None):
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000974 """Send the currently buffered request and clear the buffer.
975
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000976 Appends an extra \\r\\n to the buffer.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000977 A message_body may be specified, to be appended to the request.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000978 """
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000979 self._buffer.extend((b"", b""))
980 msg = b"\r\n".join(self._buffer)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000981 del self._buffer[:]
Benjamin Peterson9d8a3ad2015-01-23 11:02:57 -0500982
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000983 self.send(msg)
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000984 if message_body is not None:
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000985 self.send(message_body)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000986
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000987 def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0):
Greg Steindd6eefb2000-07-18 09:09:48 +0000988 """Send a request to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000989
Greg Steindd6eefb2000-07-18 09:09:48 +0000990 `method' specifies an HTTP request method, e.g. 'GET'.
991 `url' specifies the object being requested, e.g. '/index.html'.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000992 `skip_host' if True does not add automatically a 'Host:' header
993 `skip_accept_encoding' if True does not add automatically an
994 'Accept-Encoding:' header
Greg Steindd6eefb2000-07-18 09:09:48 +0000995 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000996
Greg Stein616a58d2003-06-24 06:35:19 +0000997 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000998 if self.__response and self.__response.isclosed():
999 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +00001000
Tim Peters58eb11c2004-01-18 20:29:55 +00001001
Greg Steindd6eefb2000-07-18 09:09:48 +00001002 # in certain cases, we cannot issue another request on this connection.
1003 # this occurs when:
1004 # 1) we are in the process of sending a request. (_CS_REQ_STARTED)
1005 # 2) a response to a previous request has signalled that it is going
1006 # to close the connection upon completion.
1007 # 3) the headers for the previous response have not been read, thus
1008 # we cannot determine whether point (2) is true. (_CS_REQ_SENT)
1009 #
1010 # if there is no prior response, then we can request at will.
1011 #
1012 # if point (2) is true, then we will have passed the socket to the
1013 # response (effectively meaning, "there is no prior response"), and
1014 # will open a new one when a new request is made.
1015 #
1016 # Note: if a prior response exists, then we *can* start a new request.
1017 # We are not allowed to begin fetching the response to this new
1018 # request, however, until that prior response is complete.
1019 #
1020 if self.__state == _CS_IDLE:
1021 self.__state = _CS_REQ_STARTED
1022 else:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001023 raise CannotSendRequest(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +00001024
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +00001025 # Save the method we use, we need it later in the response phase
1026 self._method = method
Greg Steindd6eefb2000-07-18 09:09:48 +00001027 if not url:
1028 url = '/'
Martin v. Löwisdd5a8602007-06-30 09:22:09 +00001029 request = '%s %s %s' % (method, url, self._http_vsn_str)
Greg Stein5e0fa402000-06-26 08:28:01 +00001030
Martin v. Löwisdd5a8602007-06-30 09:22:09 +00001031 # Non-ASCII characters should have been eliminated earlier
1032 self._output(request.encode('ascii'))
Greg Stein5e0fa402000-06-26 08:28:01 +00001033
Greg Steindd6eefb2000-07-18 09:09:48 +00001034 if self._http_vsn == 11:
1035 # Issue some standard headers for better HTTP/1.1 compliance
Greg Stein5e0fa402000-06-26 08:28:01 +00001036
Jeremy Hylton3921ff62002-03-09 06:07:23 +00001037 if not skip_host:
1038 # this header is issued *only* for HTTP/1.1
1039 # connections. more specifically, this means it is
1040 # only issued when the client uses the new
1041 # HTTPConnection() class. backwards-compat clients
1042 # will be using HTTP/1.0 and those clients may be
1043 # issuing this header themselves. we should NOT issue
1044 # it twice; some web servers (such as Apache) barf
1045 # when they see two Host: headers
Guido van Rossumf6922aa2001-01-14 21:03:01 +00001046
Jeremy Hylton3921ff62002-03-09 06:07:23 +00001047 # If we need a non-standard port,include it in the
1048 # header. If the request is going through a proxy,
1049 # but the host of the actual URL, not the host of the
1050 # proxy.
Jeremy Hylton8acf1e02002-03-08 19:35:51 +00001051
Jeremy Hylton3921ff62002-03-09 06:07:23 +00001052 netloc = ''
1053 if url.startswith('http'):
1054 nil, netloc, nil, nil, nil = urlsplit(url)
1055
1056 if netloc:
Thomas Wouters477c8d52006-05-27 19:21:47 +00001057 try:
1058 netloc_enc = netloc.encode("ascii")
1059 except UnicodeEncodeError:
1060 netloc_enc = netloc.encode("idna")
1061 self.putheader('Host', netloc_enc)
Jeremy Hylton3921ff62002-03-09 06:07:23 +00001062 else:
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001063 if self._tunnel_host:
1064 host = self._tunnel_host
1065 port = self._tunnel_port
1066 else:
1067 host = self.host
1068 port = self.port
1069
Thomas Wouters477c8d52006-05-27 19:21:47 +00001070 try:
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001071 host_enc = host.encode("ascii")
Thomas Wouters477c8d52006-05-27 19:21:47 +00001072 except UnicodeEncodeError:
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001073 host_enc = host.encode("idna")
Senthil Kumaran74ebd9e2010-11-13 12:27:49 +00001074
1075 # As per RFC 273, IPv6 address should be wrapped with []
1076 # when used as Host header
1077
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001078 if host.find(':') >= 0:
Senthil Kumaran74ebd9e2010-11-13 12:27:49 +00001079 host_enc = b'[' + host_enc + b']'
1080
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001081 if port == self.default_port:
Thomas Wouters477c8d52006-05-27 19:21:47 +00001082 self.putheader('Host', host_enc)
1083 else:
Guido van Rossum98297ee2007-11-06 21:34:58 +00001084 host_enc = host_enc.decode("ascii")
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001085 self.putheader('Host', "%s:%s" % (host_enc, port))
Greg Stein5e0fa402000-06-26 08:28:01 +00001086
Greg Steindd6eefb2000-07-18 09:09:48 +00001087 # note: we are assuming that clients will not attempt to set these
1088 # headers since *this* library must deal with the
1089 # consequences. this also means that when the supporting
1090 # libraries are updated to recognize other forms, then this
1091 # code should be changed (removed or updated).
Greg Stein5e0fa402000-06-26 08:28:01 +00001092
Greg Steindd6eefb2000-07-18 09:09:48 +00001093 # we only want a Content-Encoding of "identity" since we don't
1094 # support encodings such as x-gzip or x-deflate.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +00001095 if not skip_accept_encoding:
1096 self.putheader('Accept-Encoding', 'identity')
Greg Stein5e0fa402000-06-26 08:28:01 +00001097
Greg Steindd6eefb2000-07-18 09:09:48 +00001098 # we can accept "chunked" Transfer-Encodings, but no others
1099 # NOTE: no TE header implies *only* "chunked"
1100 #self.putheader('TE', 'chunked')
Greg Stein5e0fa402000-06-26 08:28:01 +00001101
Greg Steindd6eefb2000-07-18 09:09:48 +00001102 # if TE is supplied in the header, then it must appear in a
1103 # Connection header.
1104 #self.putheader('Connection', 'TE')
Greg Stein5e0fa402000-06-26 08:28:01 +00001105
Greg Steindd6eefb2000-07-18 09:09:48 +00001106 else:
1107 # For HTTP/1.0, the server will assume "not chunked"
1108 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001109
Benjamin Petersonf608c612008-11-16 18:33:53 +00001110 def putheader(self, header, *values):
Greg Steindd6eefb2000-07-18 09:09:48 +00001111 """Send a request header line to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001112
Greg Steindd6eefb2000-07-18 09:09:48 +00001113 For example: h.putheader('Accept', 'text/html')
1114 """
1115 if self.__state != _CS_REQ_STARTED:
1116 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +00001117
Guido van Rossum98297ee2007-11-06 21:34:58 +00001118 if hasattr(header, 'encode'):
1119 header = header.encode('ascii')
Serhiy Storchakaa112a8a2015-03-12 11:13:36 +02001120
1121 if not _is_legal_header_name(header):
1122 raise ValueError('Invalid header name %r' % (header,))
1123
Benjamin Petersonf608c612008-11-16 18:33:53 +00001124 values = list(values)
1125 for i, one_value in enumerate(values):
1126 if hasattr(one_value, 'encode'):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001127 values[i] = one_value.encode('latin-1')
Senthil Kumaran58d5dbf2010-10-03 18:22:42 +00001128 elif isinstance(one_value, int):
1129 values[i] = str(one_value).encode('ascii')
Serhiy Storchakaa112a8a2015-03-12 11:13:36 +02001130
1131 if _is_illegal_header_value(values[i]):
1132 raise ValueError('Invalid header value %r' % (values[i],))
1133
Benjamin Petersonf608c612008-11-16 18:33:53 +00001134 value = b'\r\n\t'.join(values)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001135 header = header + b': ' + value
1136 self._output(header)
Greg Stein5e0fa402000-06-26 08:28:01 +00001137
Benjamin Peterson1742e402008-11-30 22:15:29 +00001138 def endheaders(self, message_body=None):
1139 """Indicate that the last header line has been sent to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001140
Senthil Kumaranad87fa62011-10-05 23:26:49 +08001141 This method sends the request to the server. The optional message_body
1142 argument can be used to pass a message body associated with the
1143 request. The message body will be sent in the same packet as the
1144 message headers if it is a string, otherwise it is sent as a separate
1145 packet.
Benjamin Peterson1742e402008-11-30 22:15:29 +00001146 """
Greg Steindd6eefb2000-07-18 09:09:48 +00001147 if self.__state == _CS_REQ_STARTED:
1148 self.__state = _CS_REQ_SENT
1149 else:
1150 raise CannotSendHeader()
Benjamin Peterson1742e402008-11-30 22:15:29 +00001151 self._send_output(message_body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001152
Greg Steindd6eefb2000-07-18 09:09:48 +00001153 def request(self, method, url, body=None, headers={}):
1154 """Send a complete request to the server."""
Jeremy Hylton636950f2009-03-28 04:34:21 +00001155 self._send_request(method, url, body, headers)
Greg Stein5e0fa402000-06-26 08:28:01 +00001156
R David Murraybeed8402015-03-22 15:18:23 -04001157 def _set_content_length(self, body, method):
1158 # Set the content-length based on the body. If the body is "empty", we
1159 # set Content-Length: 0 for methods that expect a body (RFC 7230,
1160 # Section 3.3.2). If the body is set for other methods, we set the
1161 # header provided we can figure out what the length is.
Benjamin Peterson1742e402008-11-30 22:15:29 +00001162 thelen = None
R David Murraybeed8402015-03-22 15:18:23 -04001163 method_expects_body = method.upper() in _METHODS_EXPECTING_BODY
1164 if body is None and method_expects_body:
1165 thelen = '0'
1166 elif body is not None:
Benjamin Peterson1742e402008-11-30 22:15:29 +00001167 try:
R David Murraybeed8402015-03-22 15:18:23 -04001168 thelen = str(len(body))
1169 except TypeError:
1170 # If this is a file-like object, try to
1171 # fstat its file descriptor
1172 try:
1173 thelen = str(os.fstat(body.fileno()).st_size)
1174 except (AttributeError, OSError):
1175 # Don't send a length if this failed
1176 if self.debuglevel > 0: print("Cannot stat!!")
Benjamin Peterson1742e402008-11-30 22:15:29 +00001177
1178 if thelen is not None:
1179 self.putheader('Content-Length', thelen)
1180
Greg Steindd6eefb2000-07-18 09:09:48 +00001181 def _send_request(self, method, url, body, headers):
Jeremy Hylton636950f2009-03-28 04:34:21 +00001182 # Honor explicitly requested Host: and Accept-Encoding: headers.
Jeremy Hylton2c178252004-08-07 16:28:14 +00001183 header_names = dict.fromkeys([k.lower() for k in headers])
1184 skips = {}
1185 if 'host' in header_names:
1186 skips['skip_host'] = 1
1187 if 'accept-encoding' in header_names:
1188 skips['skip_accept_encoding'] = 1
Greg Stein5e0fa402000-06-26 08:28:01 +00001189
Jeremy Hylton2c178252004-08-07 16:28:14 +00001190 self.putrequest(method, url, **skips)
1191
R David Murraybeed8402015-03-22 15:18:23 -04001192 if 'content-length' not in header_names:
1193 self._set_content_length(body, method)
Guido van Rossumcc2b0162007-02-11 06:12:03 +00001194 for hdr, value in headers.items():
Greg Steindd6eefb2000-07-18 09:09:48 +00001195 self.putheader(hdr, value)
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001196 if isinstance(body, str):
Jeremy Hylton236654b2009-03-27 20:24:34 +00001197 # RFC 2616 Section 3.7.1 says that text default has a
1198 # default charset of iso-8859-1.
Martin Panter44391482016-02-09 10:20:52 +00001199 body = _encode(body, 'body')
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001200 self.endheaders(body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001201
Greg Steindd6eefb2000-07-18 09:09:48 +00001202 def getresponse(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001203 """Get the response from the server.
1204
1205 If the HTTPConnection is in the correct state, returns an
1206 instance of HTTPResponse or of whatever object is returned by
Martin Pantercc71a792016-04-05 06:19:42 +00001207 the response_class variable.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001208
1209 If a request has not been sent or if a previous response has
1210 not be handled, ResponseNotReady is raised. If the HTTP
1211 response indicates that the connection should be closed, then
1212 it will be closed before the response is returned. When the
1213 connection is closed, the underlying socket is closed.
1214 """
Greg Stein5e0fa402000-06-26 08:28:01 +00001215
Greg Stein616a58d2003-06-24 06:35:19 +00001216 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +00001217 if self.__response and self.__response.isclosed():
1218 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +00001219
Greg Steindd6eefb2000-07-18 09:09:48 +00001220 # if a prior response exists, then it must be completed (otherwise, we
1221 # cannot read this response's header to determine the connection-close
1222 # behavior)
1223 #
1224 # note: if a prior response existed, but was connection-close, then the
1225 # socket and response were made independent of this HTTPConnection
1226 # object since a new request requires that we open a whole new
1227 # connection
1228 #
1229 # this means the prior response had one of two states:
1230 # 1) will_close: this connection was reset and the prior socket and
1231 # response operate independently
1232 # 2) persistent: the response was retained and we await its
1233 # isclosed() status to become true.
1234 #
1235 if self.__state != _CS_REQ_SENT or self.__response:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001236 raise ResponseNotReady(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +00001237
Jeremy Hylton30f86742000-09-18 22:50:38 +00001238 if self.debuglevel > 0:
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001239 response = self.response_class(self.sock, self.debuglevel,
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +00001240 method=self._method)
Jeremy Hylton30f86742000-09-18 22:50:38 +00001241 else:
Antoine Pitrou988dbd72010-12-17 17:35:56 +00001242 response = self.response_class(self.sock, method=self._method)
Greg Stein5e0fa402000-06-26 08:28:01 +00001243
Serhiy Storchakab491e052014-12-01 13:07:45 +02001244 try:
R David Murraycae7bdb2015-04-05 19:26:29 -04001245 try:
1246 response.begin()
1247 except ConnectionError:
1248 self.close()
1249 raise
Serhiy Storchakab491e052014-12-01 13:07:45 +02001250 assert response.will_close != _UNKNOWN
1251 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +00001252
Serhiy Storchakab491e052014-12-01 13:07:45 +02001253 if response.will_close:
1254 # this effectively passes the connection to the response
1255 self.close()
1256 else:
1257 # remember this, so we can tell when it is complete
1258 self.__response = response
Greg Stein5e0fa402000-06-26 08:28:01 +00001259
Serhiy Storchakab491e052014-12-01 13:07:45 +02001260 return response
1261 except:
1262 response.close()
1263 raise
Greg Stein5e0fa402000-06-26 08:28:01 +00001264
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001265try:
1266 import ssl
Brett Cannoncd171c82013-07-04 17:43:24 -04001267except ImportError:
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001268 pass
1269else:
1270 class HTTPSConnection(HTTPConnection):
1271 "This class allows communication via SSL."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001272
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001273 default_port = HTTPS_PORT
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001274
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001275 # XXX Should key_file and cert_file be deprecated in favour of context?
1276
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001277 def __init__(self, host, port=None, key_file=None, cert_file=None,
Senthil Kumaran052ddb02013-03-18 14:11:41 -07001278 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
1279 source_address=None, *, context=None,
1280 check_hostname=None):
1281 super(HTTPSConnection, self).__init__(host, port, timeout,
Gregory P. Smithb4066372010-01-03 03:28:29 +00001282 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001283 self.key_file = key_file
1284 self.cert_file = cert_file
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001285 if context is None:
Benjamin Peterson4ffb0752014-11-03 14:29:33 -05001286 context = ssl._create_default_https_context()
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001287 will_verify = context.verify_mode != ssl.CERT_NONE
1288 if check_hostname is None:
Benjamin Petersona090f012014-12-07 13:18:25 -05001289 check_hostname = context.check_hostname
1290 if check_hostname and not will_verify:
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001291 raise ValueError("check_hostname needs a SSL context with "
1292 "either CERT_OPTIONAL or CERT_REQUIRED")
1293 if key_file or cert_file:
Antoine Pitrou80603992010-10-13 10:45:16 +00001294 context.load_cert_chain(cert_file, key_file)
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001295 self._context = context
1296 self._check_hostname = check_hostname
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001297
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001298 def connect(self):
1299 "Connect to a host on a given (SSL) port."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001300
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001301 super().connect()
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +00001302
1303 if self._tunnel_host:
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001304 server_hostname = self._tunnel_host
1305 else:
1306 server_hostname = self.host
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +00001307
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001308 self.sock = self._context.wrap_socket(self.sock,
Benjamin Peterson7243b572014-11-23 17:04:34 -06001309 server_hostname=server_hostname)
Christian Heimesf723c712013-12-05 07:51:17 +01001310 if not self._context.check_hostname and self._check_hostname:
1311 try:
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001312 ssl.match_hostname(self.sock.getpeercert(), server_hostname)
Christian Heimesf723c712013-12-05 07:51:17 +01001313 except Exception:
1314 self.sock.shutdown(socket.SHUT_RDWR)
1315 self.sock.close()
1316 raise
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001317
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001318 __all__.append("HTTPSConnection")
Greg Stein5e0fa402000-06-26 08:28:01 +00001319
Greg Stein5e0fa402000-06-26 08:28:01 +00001320class HTTPException(Exception):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001321 # Subclasses that define an __init__ must call Exception.__init__
1322 # or define self.args. Otherwise, str() will fail.
Greg Steindd6eefb2000-07-18 09:09:48 +00001323 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001324
1325class NotConnected(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001326 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001327
Skip Montanaro9d389972002-03-24 16:53:50 +00001328class InvalidURL(HTTPException):
1329 pass
1330
Greg Stein5e0fa402000-06-26 08:28:01 +00001331class UnknownProtocol(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001332 def __init__(self, version):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001333 self.args = version,
Greg Steindd6eefb2000-07-18 09:09:48 +00001334 self.version = version
Greg Stein5e0fa402000-06-26 08:28:01 +00001335
1336class UnknownTransferEncoding(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001337 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001338
Greg Stein5e0fa402000-06-26 08:28:01 +00001339class UnimplementedFileMode(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001340 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001341
1342class IncompleteRead(HTTPException):
Benjamin Peterson6accb982009-03-02 22:50:25 +00001343 def __init__(self, partial, expected=None):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001344 self.args = partial,
Greg Steindd6eefb2000-07-18 09:09:48 +00001345 self.partial = partial
Benjamin Peterson6accb982009-03-02 22:50:25 +00001346 self.expected = expected
1347 def __repr__(self):
1348 if self.expected is not None:
1349 e = ', %i more expected' % self.expected
1350 else:
1351 e = ''
Serhiy Storchaka465e60e2014-07-25 23:36:00 +03001352 return '%s(%i bytes read%s)' % (self.__class__.__name__,
1353 len(self.partial), e)
Benjamin Peterson6accb982009-03-02 22:50:25 +00001354 def __str__(self):
1355 return repr(self)
Greg Stein5e0fa402000-06-26 08:28:01 +00001356
1357class ImproperConnectionState(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001358 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001359
1360class CannotSendRequest(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001361 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001362
1363class CannotSendHeader(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001364 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001365
1366class ResponseNotReady(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001367 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001368
1369class BadStatusLine(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001370 def __init__(self, line):
Benjamin Peterson11dbfd42010-03-21 22:50:04 +00001371 if not line:
1372 line = repr(line)
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001373 self.args = line,
Greg Steindd6eefb2000-07-18 09:09:48 +00001374 self.line = line
Greg Stein5e0fa402000-06-26 08:28:01 +00001375
Senthil Kumaran5466bf12010-12-18 16:55:23 +00001376class LineTooLong(HTTPException):
1377 def __init__(self, line_type):
1378 HTTPException.__init__(self, "got more than %d bytes when reading %s"
1379 % (_MAXLINE, line_type))
1380
R David Murraycae7bdb2015-04-05 19:26:29 -04001381class RemoteDisconnected(ConnectionResetError, BadStatusLine):
1382 def __init__(self, *pos, **kw):
1383 BadStatusLine.__init__(self, "")
1384 ConnectionResetError.__init__(self, *pos, **kw)
1385
Greg Stein5e0fa402000-06-26 08:28:01 +00001386# for backwards compatibility
1387error = HTTPException