blob: f5889edb5391f056ad8e3d10c874ebfaa9781c41 [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
23 |
24 | response = getresponse()
25 v
26 Unread-response [Response-headers-read]
27 |\____________________
Tim Peters5ceadc82001-01-13 19:16:21 +000028 | |
29 | response.read() | putrequest()
30 v v
31 Idle Req-started-unread-response
32 ______/|
33 / |
34 response.read() | | ( putheader() )* endheaders()
35 v v
36 Request-started Req-sent-unread-response
37 |
38 | response.read()
39 v
40 Request-sent
Greg Stein5e0fa402000-06-26 08:28:01 +000041
42This diagram presents the following rules:
43 -- a second request may not be started until {response-headers-read}
44 -- a response [object] cannot be retrieved until {request-sent}
45 -- there is no differentiation between an unread response body and a
46 partially read response body
47
48Note: this enforcement is applied by the HTTPConnection class. The
49 HTTPResponse class does not enforce this state machine, which
50 implies sophisticated clients may accelerate the request/response
51 pipeline. Caution should be taken, though: accelerating the states
52 beyond the above pattern may imply knowledge of the server's
53 connection-close behavior for certain requests. For example, it
54 is impossible to tell whether the server will close the connection
55 UNTIL the response headers have been read; this means that further
56 requests cannot be placed into the pipeline until it is known that
57 the server will NOT be closing the connection.
58
59Logical State __state __response
60------------- ------- ----------
61Idle _CS_IDLE None
62Request-started _CS_REQ_STARTED None
63Request-sent _CS_REQ_SENT None
64Unread-response _CS_IDLE <response_class>
65Req-started-unread-response _CS_REQ_STARTED <response_class>
66Req-sent-unread-response _CS_REQ_SENT <response_class>
Guido van Rossum41999c11997-12-09 00:12:23 +000067"""
Guido van Rossum23acc951994-02-21 16:36:04 +000068
Barry Warsaw820c1202008-06-12 04:06:45 +000069import email.parser
70import email.message
Serhiy Storchakae4db7692014-12-23 16:28:28 +020071import http
Jeremy Hylton636950f2009-03-28 04:34:21 +000072import io
73import os
Serhiy Storchakaa112a8a2015-03-12 11:13:36 +020074import re
Jeremy Hylton636950f2009-03-28 04:34:21 +000075import socket
Senthil Kumaran7bc0d872010-12-19 10:49:52 +000076import collections
Jeremy Hylton1afc1692008-06-18 20:49:58 +000077from urllib.parse import urlsplit
Guido van Rossum23acc951994-02-21 16:36:04 +000078
Berker Peksagbabc6882015-02-20 09:39:38 +020079# HTTPMessage, parse_headers(), and the HTTP status code constants are
80# intentionally omitted for simplicity
Thomas Wouters47b49bf2007-08-30 22:15:33 +000081__all__ = ["HTTPResponse", "HTTPConnection",
Skip Montanaro951a8842001-06-01 16:25:38 +000082 "HTTPException", "NotConnected", "UnknownProtocol",
Jeremy Hylton7c75c992002-06-28 23:38:14 +000083 "UnknownTransferEncoding", "UnimplementedFileMode",
84 "IncompleteRead", "InvalidURL", "ImproperConnectionState",
85 "CannotSendRequest", "CannotSendHeader", "ResponseNotReady",
Berker Peksagbabc6882015-02-20 09:39:38 +020086 "BadStatusLine", "LineTooLong", "error", "responses"]
Skip Montanaro2dd42762001-01-23 15:35:05 +000087
Guido van Rossum23acc951994-02-21 16:36:04 +000088HTTP_PORT = 80
Guido van Rossum09c8b6c1999-12-07 21:37:17 +000089HTTPS_PORT = 443
90
Greg Stein5e0fa402000-06-26 08:28:01 +000091_UNKNOWN = 'UNKNOWN'
92
93# connection states
94_CS_IDLE = 'Idle'
95_CS_REQ_STARTED = 'Request-started'
96_CS_REQ_SENT = 'Request-sent'
97
Martin v. Löwis39a31782004-09-18 09:03:49 +000098
Serhiy Storchakae4db7692014-12-23 16:28:28 +020099# hack to maintain backwards compatibility
100globals().update(http.HTTPStatus.__members__)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000101
Serhiy Storchakae4db7692014-12-23 16:28:28 +0200102# another hack to maintain backwards compatibility
Georg Brandl6aab16e2006-02-17 19:17:25 +0000103# Mapping status codes to official W3C names
Serhiy Storchakae4db7692014-12-23 16:28:28 +0200104responses = {v: v.phrase for v in http.HTTPStatus.__members__.values()}
Georg Brandl6aab16e2006-02-17 19:17:25 +0000105
Georg Brandl80ba8e82005-09-29 20:16:07 +0000106# maximal amount of data to read at one time in _safe_read
107MAXAMOUNT = 1048576
108
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000109# maximal line length when calling readline().
110_MAXLINE = 65536
Georg Brandlbf3f8eb2013-10-27 07:34:48 +0100111_MAXHEADERS = 100
112
Serhiy Storchakaa112a8a2015-03-12 11:13:36 +0200113# Header name/value ABNF (http://tools.ietf.org/html/rfc7230#section-3.2)
114#
115# VCHAR = %x21-7E
116# obs-text = %x80-FF
117# header-field = field-name ":" OWS field-value OWS
118# field-name = token
119# field-value = *( field-content / obs-fold )
120# field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ]
121# field-vchar = VCHAR / obs-text
122#
123# obs-fold = CRLF 1*( SP / HTAB )
124# ; obsolete line folding
125# ; see Section 3.2.4
126
127# token = 1*tchar
128#
129# tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*"
130# / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~"
131# / DIGIT / ALPHA
132# ; any VCHAR, except delimiters
133#
134# VCHAR defined in http://tools.ietf.org/html/rfc5234#appendix-B.1
135
136# the patterns for both name and value are more leniant than RFC
137# definitions to allow for backwards compatibility
138_is_legal_header_name = re.compile(rb'[^:\s][^:\r\n]*').fullmatch
139_is_illegal_header_value = re.compile(rb'\n(?![ \t])|\r(?![ \t\n])').search
140
R David Murraybeed8402015-03-22 15:18:23 -0400141# We always set the Content-Length header for these methods because some
142# servers will otherwise respond with a 411
143_METHODS_EXPECTING_BODY = {'PATCH', 'POST', 'PUT'}
144
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000145
Barry Warsaw820c1202008-06-12 04:06:45 +0000146class HTTPMessage(email.message.Message):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000147 # XXX The only usage of this method is in
148 # http.server.CGIHTTPRequestHandler. Maybe move the code there so
149 # that it doesn't need to be part of the public API. The API has
150 # never been defined so this could cause backwards compatibility
151 # issues.
152
Barry Warsaw820c1202008-06-12 04:06:45 +0000153 def getallmatchingheaders(self, name):
154 """Find all header lines matching a given header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000155
Barry Warsaw820c1202008-06-12 04:06:45 +0000156 Look through the list of headers and find all lines matching a given
157 header name (and their continuation lines). A list of the lines is
158 returned, without interpretation. If the header does not occur, an
159 empty list is returned. If the header occurs multiple times, all
160 occurrences are returned. Case is not important in the header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000161
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000162 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000163 name = name.lower() + ':'
164 n = len(name)
165 lst = []
166 hit = 0
167 for line in self.keys():
168 if line[:n].lower() == name:
169 hit = 1
170 elif not line[:1].isspace():
171 hit = 0
172 if hit:
173 lst.append(line)
174 return lst
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000175
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000176def parse_headers(fp, _class=HTTPMessage):
Barry Warsaw820c1202008-06-12 04:06:45 +0000177 """Parses only RFC2822 headers from a file pointer.
178
179 email Parser wants to see strings rather than bytes.
180 But a TextIOWrapper around self.rfile would buffer too many bytes
181 from the stream, bytes which we later need to read as bytes.
182 So we read the correct bytes here, as bytes, for email Parser
183 to parse.
184
185 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000186 headers = []
187 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000188 line = fp.readline(_MAXLINE + 1)
189 if len(line) > _MAXLINE:
190 raise LineTooLong("header line")
Barry Warsaw820c1202008-06-12 04:06:45 +0000191 headers.append(line)
Georg Brandlbf3f8eb2013-10-27 07:34:48 +0100192 if len(headers) > _MAXHEADERS:
193 raise HTTPException("got more than %d headers" % _MAXHEADERS)
Barry Warsaw820c1202008-06-12 04:06:45 +0000194 if line in (b'\r\n', b'\n', b''):
195 break
196 hstring = b''.join(headers).decode('iso-8859-1')
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000197 return email.parser.Parser(_class=_class).parsestr(hstring)
Greg Stein5e0fa402000-06-26 08:28:01 +0000198
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000199
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000200class HTTPResponse(io.BufferedIOBase):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000201
202 # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details.
203
Jeremy Hylton811fc142007-08-03 13:30:02 +0000204 # The bytes from the socket object are iso-8859-1 strings.
205 # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded
206 # text following RFC 2047. The basic status line parsing only
207 # accepts iso-8859-1.
208
Senthil Kumaran052ddb02013-03-18 14:11:41 -0700209 def __init__(self, sock, debuglevel=0, method=None, url=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000210 # If the response includes a content-length header, we need to
211 # make sure that the client doesn't read more than the
Jeremy Hylton39b198d2007-08-04 19:22:00 +0000212 # specified number of bytes. If it does, it will block until
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000213 # the server times out and closes the connection. This will
214 # happen if a self.fp.read() is done (without a size) whether
215 # self.fp is buffered or not. So, no self.fp.read() by
216 # clients unless they know what they are doing.
Benjamin Petersonf72d9fb2009-02-08 00:29:20 +0000217 self.fp = sock.makefile("rb")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000218 self.debuglevel = debuglevel
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000219 self._method = method
Greg Stein5e0fa402000-06-26 08:28:01 +0000220
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000221 # The HTTPResponse object is returned via urllib. The clients
222 # of http and urllib expect different attributes for the
223 # headers. headers is used here and supports urllib. msg is
224 # provided as a backwards compatibility layer for http
225 # clients.
226
227 self.headers = self.msg = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000228
Greg Steindd6eefb2000-07-18 09:09:48 +0000229 # from the Status-Line of the response
Tim Peters07e99cb2001-01-14 23:47:14 +0000230 self.version = _UNKNOWN # HTTP-Version
231 self.status = _UNKNOWN # Status-Code
232 self.reason = _UNKNOWN # Reason-Phrase
Greg Stein5e0fa402000-06-26 08:28:01 +0000233
Tim Peters07e99cb2001-01-14 23:47:14 +0000234 self.chunked = _UNKNOWN # is "chunked" being used?
235 self.chunk_left = _UNKNOWN # bytes left to read in current chunk
236 self.length = _UNKNOWN # number of bytes left in response
237 self.will_close = _UNKNOWN # conn will close at end of response
Greg Stein5e0fa402000-06-26 08:28:01 +0000238
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000239 def _read_status(self):
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000240 line = str(self.fp.readline(_MAXLINE + 1), "iso-8859-1")
241 if len(line) > _MAXLINE:
242 raise LineTooLong("status line")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000243 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000244 print("reply:", repr(line))
Jeremy Hyltonb6769522003-06-29 17:55:05 +0000245 if not line:
246 # Presumably, the server closed the connection before
247 # sending a valid response.
248 raise BadStatusLine(line)
Greg Steindd6eefb2000-07-18 09:09:48 +0000249 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000250 version, status, reason = line.split(None, 2)
Greg Steindd6eefb2000-07-18 09:09:48 +0000251 except ValueError:
252 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000253 version, status = line.split(None, 1)
Greg Steindd6eefb2000-07-18 09:09:48 +0000254 reason = ""
255 except ValueError:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000256 # empty version will cause next test to fail.
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000257 version = ""
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000258 if not version.startswith("HTTP/"):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200259 self._close_conn()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000260 raise BadStatusLine(line)
Greg Stein5e0fa402000-06-26 08:28:01 +0000261
Jeremy Hylton23d40472001-04-13 14:57:08 +0000262 # The status code is a three-digit number
263 try:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000264 status = int(status)
Jeremy Hylton23d40472001-04-13 14:57:08 +0000265 if status < 100 or status > 999:
266 raise BadStatusLine(line)
267 except ValueError:
268 raise BadStatusLine(line)
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000269 return version, status, reason
Greg Stein5e0fa402000-06-26 08:28:01 +0000270
Jeremy Hylton39c03802002-07-12 14:04:09 +0000271 def begin(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000272 if self.headers is not None:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000273 # we've already started reading the response
274 return
275
276 # read until we get a non-100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000277 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000278 version, status, reason = self._read_status()
Martin v. Löwis39a31782004-09-18 09:03:49 +0000279 if status != CONTINUE:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000280 break
281 # skip the header from the 100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000282 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000283 skip = self.fp.readline(_MAXLINE + 1)
284 if len(skip) > _MAXLINE:
285 raise LineTooLong("header line")
286 skip = skip.strip()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000287 if not skip:
288 break
289 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000290 print("header:", skip)
Tim Petersc411dba2002-07-16 21:35:23 +0000291
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000292 self.code = self.status = status
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000293 self.reason = reason.strip()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000294 if version in ("HTTP/1.0", "HTTP/0.9"):
295 # Some servers might still return "0.9", treat it as 1.0 anyway
Greg Steindd6eefb2000-07-18 09:09:48 +0000296 self.version = 10
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000297 elif version.startswith("HTTP/1."):
Tim Peters07e99cb2001-01-14 23:47:14 +0000298 self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1
Greg Steindd6eefb2000-07-18 09:09:48 +0000299 else:
300 raise UnknownProtocol(version)
Greg Stein5e0fa402000-06-26 08:28:01 +0000301
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000302 self.headers = self.msg = parse_headers(self.fp)
Barry Warsaw820c1202008-06-12 04:06:45 +0000303
Jeremy Hylton30f86742000-09-18 22:50:38 +0000304 if self.debuglevel > 0:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000305 for hdr in self.headers:
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000306 print("header:", hdr, end=" ")
Greg Stein5e0fa402000-06-26 08:28:01 +0000307
Greg Steindd6eefb2000-07-18 09:09:48 +0000308 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000309 tr_enc = self.headers.get("transfer-encoding")
Jeremy Hyltond229b3a2002-09-03 19:24:24 +0000310 if tr_enc and tr_enc.lower() == "chunked":
Jeremy Hylton236156f2008-12-15 03:00:50 +0000311 self.chunked = True
Greg Steindd6eefb2000-07-18 09:09:48 +0000312 self.chunk_left = None
313 else:
Jeremy Hylton236156f2008-12-15 03:00:50 +0000314 self.chunked = False
Greg Stein5e0fa402000-06-26 08:28:01 +0000315
Greg Steindd6eefb2000-07-18 09:09:48 +0000316 # will the connection close at the end of the response?
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000317 self.will_close = self._check_close()
Greg Stein5e0fa402000-06-26 08:28:01 +0000318
Greg Steindd6eefb2000-07-18 09:09:48 +0000319 # do we have a Content-Length?
320 # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked"
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000321 self.length = None
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000322 length = self.headers.get("content-length")
Barry Warsaw820c1202008-06-12 04:06:45 +0000323
324 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000325 tr_enc = self.headers.get("transfer-encoding")
Greg Steindd6eefb2000-07-18 09:09:48 +0000326 if length and not self.chunked:
Jeremy Hylton30a81812000-09-14 20:34:27 +0000327 try:
328 self.length = int(length)
329 except ValueError:
Christian Heimesa612dc02008-02-24 13:08:18 +0000330 self.length = None
331 else:
332 if self.length < 0: # ignore nonsensical negative lengths
333 self.length = None
334 else:
335 self.length = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000336
Greg Steindd6eefb2000-07-18 09:09:48 +0000337 # does the body have a fixed length? (of zero)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000338 if (status == NO_CONTENT or status == NOT_MODIFIED or
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000339 100 <= status < 200 or # 1xx codes
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000340 self._method == "HEAD"):
Greg Steindd6eefb2000-07-18 09:09:48 +0000341 self.length = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000342
Greg Steindd6eefb2000-07-18 09:09:48 +0000343 # if the connection remains open, and we aren't using chunked, and
344 # a content-length was not provided, then assume that the connection
345 # WILL close.
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000346 if (not self.will_close and
347 not self.chunked and
348 self.length is None):
Jeremy Hylton236156f2008-12-15 03:00:50 +0000349 self.will_close = True
Greg Stein5e0fa402000-06-26 08:28:01 +0000350
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000351 def _check_close(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000352 conn = self.headers.get("connection")
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000353 if self.version == 11:
354 # An HTTP/1.1 proxy is assumed to stay open unless
355 # explicitly closed.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000356 conn = self.headers.get("connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000357 if conn and "close" in conn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000358 return True
359 return False
360
Jeremy Hylton2c178252004-08-07 16:28:14 +0000361 # Some HTTP/1.0 implementations have support for persistent
362 # connections, using rules different than HTTP/1.1.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000363
Christian Heimes895627f2007-12-08 17:28:33 +0000364 # For older HTTP, Keep-Alive indicates persistent connection.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000365 if self.headers.get("keep-alive"):
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000366 return False
Tim Peters77c06fb2002-11-24 02:35:35 +0000367
Jeremy Hylton2c178252004-08-07 16:28:14 +0000368 # At least Akamai returns a "Connection: Keep-Alive" header,
369 # which was supposed to be sent by the client.
370 if conn and "keep-alive" in conn.lower():
371 return False
372
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000373 # Proxy-Connection is a netscape hack.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000374 pconn = self.headers.get("proxy-connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000375 if pconn and "keep-alive" in pconn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000376 return False
377
378 # otherwise, assume it will close
379 return True
380
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200381 def _close_conn(self):
382 fp = self.fp
383 self.fp = None
384 fp.close()
385
Greg Steindd6eefb2000-07-18 09:09:48 +0000386 def close(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200387 super().close() # set "closed" flag
Greg Steindd6eefb2000-07-18 09:09:48 +0000388 if self.fp:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200389 self._close_conn()
Greg Stein5e0fa402000-06-26 08:28:01 +0000390
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000391 # These implementations are for the benefit of io.BufferedReader.
392
393 # XXX This class should probably be revised to act more like
394 # the "raw stream" that BufferedReader expects.
395
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000396 def flush(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200397 super().flush()
398 if self.fp:
399 self.fp.flush()
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000400
Jeremy Hyltona7cff022009-04-01 02:35:56 +0000401 def readable(self):
402 return True
403
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000404 # End of "raw stream" methods
405
Greg Steindd6eefb2000-07-18 09:09:48 +0000406 def isclosed(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200407 """True if the connection is closed."""
Greg Steindd6eefb2000-07-18 09:09:48 +0000408 # NOTE: it is possible that we will not ever call self.close(). This
409 # case occurs when will_close is TRUE, length is None, and we
410 # read up to the last byte, but NOT past it.
411 #
412 # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be
413 # called, meaning self.isclosed() is meaningful.
414 return self.fp is None
415
416 def read(self, amt=None):
417 if self.fp is None:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000418 return b""
Greg Steindd6eefb2000-07-18 09:09:48 +0000419
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000420 if self._method == "HEAD":
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200421 self._close_conn()
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000422 return b""
423
Antoine Pitrou38d96432011-12-06 22:33:57 +0100424 if amt is not None:
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000425 # Amount is given, implement using readinto
426 b = bytearray(amt)
427 n = self.readinto(b)
428 return memoryview(b)[:n].tobytes()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100429 else:
430 # Amount is not given (unbounded read) so we must check self.length
431 # and self.chunked
Tim Peters230a60c2002-11-09 05:08:07 +0000432
Antoine Pitrou38d96432011-12-06 22:33:57 +0100433 if self.chunked:
434 return self._readall_chunked()
435
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000436 if self.length is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000437 s = self.fp.read()
438 else:
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100439 try:
440 s = self._safe_read(self.length)
441 except IncompleteRead:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200442 self._close_conn()
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100443 raise
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000444 self.length = 0
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200445 self._close_conn() # we read everything
Greg Steindd6eefb2000-07-18 09:09:48 +0000446 return s
447
Antoine Pitrou38d96432011-12-06 22:33:57 +0100448 def readinto(self, b):
449 if self.fp is None:
450 return 0
451
452 if self._method == "HEAD":
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200453 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100454 return 0
455
456 if self.chunked:
457 return self._readinto_chunked(b)
458
Greg Steindd6eefb2000-07-18 09:09:48 +0000459 if self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100460 if len(b) > self.length:
Greg Steindd6eefb2000-07-18 09:09:48 +0000461 # clip the read to the "end of response"
Antoine Pitrou38d96432011-12-06 22:33:57 +0100462 b = memoryview(b)[0:self.length]
Greg Steindd6eefb2000-07-18 09:09:48 +0000463
464 # we do not use _safe_read() here because this may be a .will_close
465 # connection, and the user is reading more bytes than will be provided
466 # (for example, reading in 1k chunks)
Antoine Pitrou38d96432011-12-06 22:33:57 +0100467 n = self.fp.readinto(b)
Serhiy Storchaka1c84ac12013-12-17 21:50:02 +0200468 if not n and b:
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100469 # Ideally, we would raise IncompleteRead if the content-length
470 # wasn't satisfied, but it might break compatibility.
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200471 self._close_conn()
Antoine Pitrou6a35e182013-02-02 23:04:56 +0100472 elif self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100473 self.length -= n
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000474 if not self.length:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200475 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100476 return n
Greg Steindd6eefb2000-07-18 09:09:48 +0000477
Antoine Pitrou38d96432011-12-06 22:33:57 +0100478 def _read_next_chunk_size(self):
479 # Read the next chunk size from the file
480 line = self.fp.readline(_MAXLINE + 1)
481 if len(line) > _MAXLINE:
482 raise LineTooLong("chunk size")
483 i = line.find(b";")
484 if i >= 0:
485 line = line[:i] # strip chunk-extensions
486 try:
487 return int(line, 16)
488 except ValueError:
489 # close the connection as protocol synchronisation is
490 # probably lost
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200491 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100492 raise
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000493
Antoine Pitrou38d96432011-12-06 22:33:57 +0100494 def _read_and_discard_trailer(self):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000495 # read and discard trailer up to the CRLF terminator
496 ### note: we shouldn't have any trailers!
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000497 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000498 line = self.fp.readline(_MAXLINE + 1)
499 if len(line) > _MAXLINE:
500 raise LineTooLong("trailer line")
Christian Heimes0bd4e112008-02-12 22:59:25 +0000501 if not line:
502 # a vanishingly small number of sites EOF without
503 # sending the trailer
504 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800505 if line in (b'\r\n', b'\n', b''):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000506 break
507
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000508 def _get_chunk_left(self):
509 # return self.chunk_left, reading a new chunk if necessary.
510 # chunk_left == 0: at the end of the current chunk, need to close it
511 # chunk_left == None: No current chunk, should read next.
512 # This function returns non-zero or None if the last chunk has
513 # been read.
514 chunk_left = self.chunk_left
515 if not chunk_left: # Can be 0 or None
516 if chunk_left is not None:
517 # We are at the end of chunk. dicard chunk end
518 self._safe_read(2) # toss the CRLF at the end of the chunk
519 try:
520 chunk_left = self._read_next_chunk_size()
521 except ValueError:
522 raise IncompleteRead(b'')
523 if chunk_left == 0:
524 # last chunk: 1*("0") [ chunk-extension ] CRLF
525 self._read_and_discard_trailer()
526 # we read everything; close the "file"
527 self._close_conn()
528 chunk_left = None
529 self.chunk_left = chunk_left
530 return chunk_left
531
Antoine Pitrou38d96432011-12-06 22:33:57 +0100532 def _readall_chunked(self):
533 assert self.chunked != _UNKNOWN
Antoine Pitrou38d96432011-12-06 22:33:57 +0100534 value = []
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000535 try:
536 while True:
537 chunk_left = self._get_chunk_left()
538 if chunk_left is None:
539 break
540 value.append(self._safe_read(chunk_left))
541 self.chunk_left = 0
542 return b''.join(value)
543 except IncompleteRead:
544 raise IncompleteRead(b''.join(value))
Tim Peters230a60c2002-11-09 05:08:07 +0000545
Antoine Pitrou38d96432011-12-06 22:33:57 +0100546 def _readinto_chunked(self, b):
547 assert self.chunked != _UNKNOWN
Antoine Pitrou38d96432011-12-06 22:33:57 +0100548 total_bytes = 0
549 mvb = memoryview(b)
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000550 try:
551 while True:
552 chunk_left = self._get_chunk_left()
553 if chunk_left is None:
554 return total_bytes
Antoine Pitrou4ce6aa42011-12-06 22:34:36 +0100555
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000556 if len(mvb) <= chunk_left:
557 n = self._safe_readinto(mvb)
558 self.chunk_left = chunk_left - n
559 return total_bytes + n
560
561 temp_mvb = mvb[:chunk_left]
Antoine Pitrou38d96432011-12-06 22:33:57 +0100562 n = self._safe_readinto(temp_mvb)
563 mvb = mvb[n:]
564 total_bytes += n
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000565 self.chunk_left = 0
Antoine Pitrou38d96432011-12-06 22:33:57 +0100566
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000567 except IncompleteRead:
568 raise IncompleteRead(bytes(b[0:total_bytes]))
Antoine Pitrou38d96432011-12-06 22:33:57 +0100569
Greg Steindd6eefb2000-07-18 09:09:48 +0000570 def _safe_read(self, amt):
571 """Read the number of bytes requested, compensating for partial reads.
572
573 Normally, we have a blocking socket, but a read() can be interrupted
574 by a signal (resulting in a partial read).
575
576 Note that we cannot distinguish between EOF and an interrupt when zero
577 bytes have been read. IncompleteRead() will be raised in this
578 situation.
579
580 This function should be used when <amt> bytes "should" be present for
581 reading. If the bytes are truly not available (due to EOF), then the
582 IncompleteRead exception can be used to detect the problem.
583 """
Georg Brandl80ba8e82005-09-29 20:16:07 +0000584 s = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000585 while amt > 0:
Georg Brandl80ba8e82005-09-29 20:16:07 +0000586 chunk = self.fp.read(min(amt, MAXAMOUNT))
Greg Steindd6eefb2000-07-18 09:09:48 +0000587 if not chunk:
Benjamin Peterson6accb982009-03-02 22:50:25 +0000588 raise IncompleteRead(b''.join(s), amt)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000589 s.append(chunk)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000590 amt -= len(chunk)
Guido van Rossuma00f1232007-09-12 19:43:09 +0000591 return b"".join(s)
Greg Steindd6eefb2000-07-18 09:09:48 +0000592
Antoine Pitrou38d96432011-12-06 22:33:57 +0100593 def _safe_readinto(self, b):
594 """Same as _safe_read, but for reading into a buffer."""
595 total_bytes = 0
596 mvb = memoryview(b)
597 while total_bytes < len(b):
598 if MAXAMOUNT < len(mvb):
599 temp_mvb = mvb[0:MAXAMOUNT]
600 n = self.fp.readinto(temp_mvb)
601 else:
602 n = self.fp.readinto(mvb)
603 if not n:
604 raise IncompleteRead(bytes(mvb[0:total_bytes]), len(b))
605 mvb = mvb[n:]
606 total_bytes += n
607 return total_bytes
608
Kristján Valur Jónsson8e5d0ca2014-03-19 10:07:26 +0000609 def read1(self, n=-1):
610 """Read with at most one underlying system call. If at least one
611 byte is buffered, return that instead.
612 """
613 if self.fp is None or self._method == "HEAD":
614 return b""
615 if self.chunked:
616 return self._read1_chunked(n)
617 try:
618 result = self.fp.read1(n)
619 except ValueError:
620 if n >= 0:
621 raise
622 # some implementations, like BufferedReader, don't support -1
623 # Read an arbitrarily selected largeish chunk.
624 result = self.fp.read1(16*1024)
625 if not result and n:
626 self._close_conn()
627 return result
628
629 def peek(self, n=-1):
630 # Having this enables IOBase.readline() to read more than one
631 # byte at a time
632 if self.fp is None or self._method == "HEAD":
633 return b""
634 if self.chunked:
635 return self._peek_chunked(n)
636 return self.fp.peek(n)
637
638 def readline(self, limit=-1):
639 if self.fp is None or self._method == "HEAD":
640 return b""
641 if self.chunked:
642 # Fallback to IOBase readline which uses peek() and read()
643 return super().readline(limit)
644 result = self.fp.readline(limit)
645 if not result and limit:
646 self._close_conn()
647 return result
648
649 def _read1_chunked(self, n):
650 # Strictly speaking, _get_chunk_left() may cause more than one read,
651 # but that is ok, since that is to satisfy the chunked protocol.
652 chunk_left = self._get_chunk_left()
653 if chunk_left is None or n == 0:
654 return b''
655 if not (0 <= n <= chunk_left):
656 n = chunk_left # if n is negative or larger than chunk_left
657 read = self.fp.read1(n)
658 self.chunk_left -= len(read)
659 if not read:
660 raise IncompleteRead(b"")
661 return read
662
663 def _peek_chunked(self, n):
664 # Strictly speaking, _get_chunk_left() may cause more than one read,
665 # but that is ok, since that is to satisfy the chunked protocol.
666 try:
667 chunk_left = self._get_chunk_left()
668 except IncompleteRead:
669 return b'' # peek doesn't worry about protocol
670 if chunk_left is None:
671 return b'' # eof
672 # peek is allowed to return more than requested. Just request the
673 # entire chunk, and truncate what we get.
674 return self.fp.peek(chunk_left)[:chunk_left]
675
Antoine Pitroub353c122009-02-11 00:39:14 +0000676 def fileno(self):
677 return self.fp.fileno()
678
Greg Steindd6eefb2000-07-18 09:09:48 +0000679 def getheader(self, name, default=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000680 if self.headers is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000681 raise ResponseNotReady()
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000682 headers = self.headers.get_all(name) or default
683 if isinstance(headers, str) or not hasattr(headers, '__iter__'):
684 return headers
685 else:
686 return ', '.join(headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000687
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000688 def getheaders(self):
689 """Return list of (header, value) tuples."""
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000690 if self.headers is None:
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000691 raise ResponseNotReady()
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000692 return list(self.headers.items())
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000693
Antoine Pitroub353c122009-02-11 00:39:14 +0000694 # We override IOBase.__iter__ so that it doesn't check for closed-ness
695
696 def __iter__(self):
697 return self
698
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000699 # For compatibility with old-style urllib responses.
700
701 def info(self):
702 return self.headers
703
704 def geturl(self):
705 return self.url
706
707 def getcode(self):
708 return self.status
Greg Stein5e0fa402000-06-26 08:28:01 +0000709
710class HTTPConnection:
711
Greg Steindd6eefb2000-07-18 09:09:48 +0000712 _http_vsn = 11
713 _http_vsn_str = 'HTTP/1.1'
Greg Stein5e0fa402000-06-26 08:28:01 +0000714
Greg Steindd6eefb2000-07-18 09:09:48 +0000715 response_class = HTTPResponse
716 default_port = HTTP_PORT
717 auto_open = 1
Jeremy Hylton30f86742000-09-18 22:50:38 +0000718 debuglevel = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000719
Senthil Kumaran052ddb02013-03-18 14:11:41 -0700720 def __init__(self, host, port=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
721 source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000722 self.timeout = timeout
Gregory P. Smithb4066372010-01-03 03:28:29 +0000723 self.source_address = source_address
Greg Steindd6eefb2000-07-18 09:09:48 +0000724 self.sock = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000725 self._buffer = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000726 self.__response = None
727 self.__state = _CS_IDLE
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000728 self._method = None
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000729 self._tunnel_host = None
730 self._tunnel_port = None
Georg Brandlc7c199f2011-01-22 22:06:24 +0000731 self._tunnel_headers = {}
Tim Petersc411dba2002-07-16 21:35:23 +0000732
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400733 (self.host, self.port) = self._get_hostport(host, port)
734
735 # This is stored as an instance variable to allow unit
736 # tests to replace it with a suitable mockup
737 self._create_connection = socket.create_connection
Greg Stein5e0fa402000-06-26 08:28:01 +0000738
Senthil Kumaran47fff872009-12-20 07:10:31 +0000739 def set_tunnel(self, host, port=None, headers=None):
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400740 """Set up host and port for HTTP CONNECT tunnelling.
Senthil Kumaran47fff872009-12-20 07:10:31 +0000741
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400742 In a connection that uses HTTP CONNECT tunneling, the host passed to the
743 constructor is used as a proxy server that relays all communication to
744 the endpoint passed to `set_tunnel`. This done by sending an HTTP
745 CONNECT request to the proxy server when the connection is established.
746
747 This method must be called before the HTML connection has been
748 established.
749
750 The headers argument should be a mapping of extra HTTP headers to send
751 with the CONNECT request.
Senthil Kumaran47fff872009-12-20 07:10:31 +0000752 """
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400753
754 if self.sock:
755 raise RuntimeError("Can't set up tunnel for established connection")
756
Serhiy Storchaka4ac7ed92014-12-12 09:29:15 +0200757 self._tunnel_host, self._tunnel_port = self._get_hostport(host, port)
Senthil Kumaran47fff872009-12-20 07:10:31 +0000758 if headers:
759 self._tunnel_headers = headers
760 else:
761 self._tunnel_headers.clear()
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000762
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400763 def _get_hostport(self, host, port):
Greg Steindd6eefb2000-07-18 09:09:48 +0000764 if port is None:
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000765 i = host.rfind(':')
Skip Montanarocae14d22004-09-14 17:55:21 +0000766 j = host.rfind(']') # ipv6 addresses have [...]
767 if i > j:
Skip Montanaro9d389972002-03-24 16:53:50 +0000768 try:
769 port = int(host[i+1:])
770 except ValueError:
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200771 if host[i+1:] == "": # http://foo.com:/ == http://foo.com/
772 port = self.default_port
773 else:
774 raise InvalidURL("nonnumeric port: '%s'" % host[i+1:])
Greg Steindd6eefb2000-07-18 09:09:48 +0000775 host = host[:i]
776 else:
777 port = self.default_port
Raymond Hettinger4d037912004-10-14 15:23:38 +0000778 if host and host[0] == '[' and host[-1] == ']':
Brett Cannon0a1af4a2004-09-15 23:26:23 +0000779 host = host[1:-1]
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400780
781 return (host, port)
Greg Stein5e0fa402000-06-26 08:28:01 +0000782
Jeremy Hylton30f86742000-09-18 22:50:38 +0000783 def set_debuglevel(self, level):
784 self.debuglevel = level
785
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000786 def _tunnel(self):
Serhiy Storchaka4ac7ed92014-12-12 09:29:15 +0200787 connect_str = "CONNECT %s:%d HTTP/1.0\r\n" % (self._tunnel_host,
788 self._tunnel_port)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000789 connect_bytes = connect_str.encode("ascii")
790 self.send(connect_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000791 for header, value in self._tunnel_headers.items():
Senthil Kumaran47fff872009-12-20 07:10:31 +0000792 header_str = "%s: %s\r\n" % (header, value)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000793 header_bytes = header_str.encode("latin-1")
Senthil Kumaran47fff872009-12-20 07:10:31 +0000794 self.send(header_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000795 self.send(b'\r\n')
Senthil Kumaran47fff872009-12-20 07:10:31 +0000796
Georg Brandlc7c199f2011-01-22 22:06:24 +0000797 response = self.response_class(self.sock, method=self._method)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000798 (version, code, message) = response._read_status()
Senthil Kumaran47fff872009-12-20 07:10:31 +0000799
Serhiy Storchakae4db7692014-12-23 16:28:28 +0200800 if code != http.HTTPStatus.OK:
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000801 self.close()
Andrew Svetlov0832af62012-12-18 23:10:48 +0200802 raise OSError("Tunnel connection failed: %d %s" % (code,
803 message.strip()))
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000804 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000805 line = response.fp.readline(_MAXLINE + 1)
806 if len(line) > _MAXLINE:
807 raise LineTooLong("header line")
Senthil Kumaranb12771a2012-04-23 23:50:07 +0800808 if not line:
809 # for sites which EOF without sending a trailer
810 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800811 if line in (b'\r\n', b'\n', b''):
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000812 break
813
Berker Peksagab53ab02015-02-03 12:22:11 +0200814 if self.debuglevel > 0:
815 print('header:', line.decode())
816
Greg Steindd6eefb2000-07-18 09:09:48 +0000817 def connect(self):
818 """Connect to the host and port specified in __init__."""
Benjamin Peterson9d8a3ad2015-01-23 11:02:57 -0500819 self.sock = self._create_connection(
820 (self.host,self.port), self.timeout, self.source_address)
821 self.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400822
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000823 if self._tunnel_host:
824 self._tunnel()
Greg Stein5e0fa402000-06-26 08:28:01 +0000825
Greg Steindd6eefb2000-07-18 09:09:48 +0000826 def close(self):
827 """Close the connection to the HTTP server."""
828 if self.sock:
Tim Peters07e99cb2001-01-14 23:47:14 +0000829 self.sock.close() # close it manually... there may be other refs
Greg Steindd6eefb2000-07-18 09:09:48 +0000830 self.sock = None
831 if self.__response:
832 self.__response.close()
833 self.__response = None
834 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000835
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000836 def send(self, data):
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000837 """Send `data' to the server.
838 ``data`` can be a string object, a bytes object, an array object, a
839 file-like object that supports a .read() method, or an iterable object.
840 """
841
Greg Steindd6eefb2000-07-18 09:09:48 +0000842 if self.sock is None:
843 if self.auto_open:
844 self.connect()
845 else:
846 raise NotConnected()
Greg Stein5e0fa402000-06-26 08:28:01 +0000847
Jeremy Hylton30f86742000-09-18 22:50:38 +0000848 if self.debuglevel > 0:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000849 print("send:", repr(data))
Jeremy Hylton636950f2009-03-28 04:34:21 +0000850 blocksize = 8192
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000851 if hasattr(data, "read") :
Jeremy Hylton636950f2009-03-28 04:34:21 +0000852 if self.debuglevel > 0:
853 print("sendIng a read()able")
854 encode = False
Antoine Pitrouead1d622009-09-29 18:44:53 +0000855 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000856 mode = data.mode
Antoine Pitrouead1d622009-09-29 18:44:53 +0000857 except AttributeError:
858 # io.BytesIO and other file-like objects don't have a `mode`
859 # attribute.
860 pass
861 else:
862 if "b" not in mode:
863 encode = True
864 if self.debuglevel > 0:
865 print("encoding file using iso-8859-1")
Jeremy Hylton636950f2009-03-28 04:34:21 +0000866 while 1:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000867 datablock = data.read(blocksize)
868 if not datablock:
Jeremy Hylton636950f2009-03-28 04:34:21 +0000869 break
870 if encode:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000871 datablock = datablock.encode("iso-8859-1")
872 self.sock.sendall(datablock)
Andrew Svetlov7b2c8bb2013-04-12 22:49:19 +0300873 return
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000874 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000875 self.sock.sendall(data)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000876 except TypeError:
877 if isinstance(data, collections.Iterable):
878 for d in data:
879 self.sock.sendall(d)
880 else:
Georg Brandl25e2cd12011-08-03 08:27:00 +0200881 raise TypeError("data should be a bytes-like object "
882 "or an iterable, got %r" % type(data))
Greg Stein5e0fa402000-06-26 08:28:01 +0000883
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000884 def _output(self, s):
885 """Add a line of output to the current request buffer.
Tim Peters469cdad2002-08-08 20:19:19 +0000886
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000887 Assumes that the line does *not* end with \\r\\n.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000888 """
889 self._buffer.append(s)
890
Benjamin Peterson1742e402008-11-30 22:15:29 +0000891 def _send_output(self, message_body=None):
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000892 """Send the currently buffered request and clear the buffer.
893
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000894 Appends an extra \\r\\n to the buffer.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000895 A message_body may be specified, to be appended to the request.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000896 """
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000897 self._buffer.extend((b"", b""))
898 msg = b"\r\n".join(self._buffer)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000899 del self._buffer[:]
Benjamin Peterson9d8a3ad2015-01-23 11:02:57 -0500900
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000901 self.send(msg)
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000902 if message_body is not None:
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000903 self.send(message_body)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000904
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000905 def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0):
Greg Steindd6eefb2000-07-18 09:09:48 +0000906 """Send a request to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000907
Greg Steindd6eefb2000-07-18 09:09:48 +0000908 `method' specifies an HTTP request method, e.g. 'GET'.
909 `url' specifies the object being requested, e.g. '/index.html'.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000910 `skip_host' if True does not add automatically a 'Host:' header
911 `skip_accept_encoding' if True does not add automatically an
912 'Accept-Encoding:' header
Greg Steindd6eefb2000-07-18 09:09:48 +0000913 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000914
Greg Stein616a58d2003-06-24 06:35:19 +0000915 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000916 if self.__response and self.__response.isclosed():
917 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000918
Tim Peters58eb11c2004-01-18 20:29:55 +0000919
Greg Steindd6eefb2000-07-18 09:09:48 +0000920 # in certain cases, we cannot issue another request on this connection.
921 # this occurs when:
922 # 1) we are in the process of sending a request. (_CS_REQ_STARTED)
923 # 2) a response to a previous request has signalled that it is going
924 # to close the connection upon completion.
925 # 3) the headers for the previous response have not been read, thus
926 # we cannot determine whether point (2) is true. (_CS_REQ_SENT)
927 #
928 # if there is no prior response, then we can request at will.
929 #
930 # if point (2) is true, then we will have passed the socket to the
931 # response (effectively meaning, "there is no prior response"), and
932 # will open a new one when a new request is made.
933 #
934 # Note: if a prior response exists, then we *can* start a new request.
935 # We are not allowed to begin fetching the response to this new
936 # request, however, until that prior response is complete.
937 #
938 if self.__state == _CS_IDLE:
939 self.__state = _CS_REQ_STARTED
940 else:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000941 raise CannotSendRequest(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +0000942
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000943 # Save the method we use, we need it later in the response phase
944 self._method = method
Greg Steindd6eefb2000-07-18 09:09:48 +0000945 if not url:
946 url = '/'
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000947 request = '%s %s %s' % (method, url, self._http_vsn_str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000948
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000949 # Non-ASCII characters should have been eliminated earlier
950 self._output(request.encode('ascii'))
Greg Stein5e0fa402000-06-26 08:28:01 +0000951
Greg Steindd6eefb2000-07-18 09:09:48 +0000952 if self._http_vsn == 11:
953 # Issue some standard headers for better HTTP/1.1 compliance
Greg Stein5e0fa402000-06-26 08:28:01 +0000954
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000955 if not skip_host:
956 # this header is issued *only* for HTTP/1.1
957 # connections. more specifically, this means it is
958 # only issued when the client uses the new
959 # HTTPConnection() class. backwards-compat clients
960 # will be using HTTP/1.0 and those clients may be
961 # issuing this header themselves. we should NOT issue
962 # it twice; some web servers (such as Apache) barf
963 # when they see two Host: headers
Guido van Rossumf6922aa2001-01-14 21:03:01 +0000964
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000965 # If we need a non-standard port,include it in the
966 # header. If the request is going through a proxy,
967 # but the host of the actual URL, not the host of the
968 # proxy.
Jeremy Hylton8acf1e02002-03-08 19:35:51 +0000969
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000970 netloc = ''
971 if url.startswith('http'):
972 nil, netloc, nil, nil, nil = urlsplit(url)
973
974 if netloc:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000975 try:
976 netloc_enc = netloc.encode("ascii")
977 except UnicodeEncodeError:
978 netloc_enc = netloc.encode("idna")
979 self.putheader('Host', netloc_enc)
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000980 else:
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400981 if self._tunnel_host:
982 host = self._tunnel_host
983 port = self._tunnel_port
984 else:
985 host = self.host
986 port = self.port
987
Thomas Wouters477c8d52006-05-27 19:21:47 +0000988 try:
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400989 host_enc = host.encode("ascii")
Thomas Wouters477c8d52006-05-27 19:21:47 +0000990 except UnicodeEncodeError:
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400991 host_enc = host.encode("idna")
Senthil Kumaran74ebd9e2010-11-13 12:27:49 +0000992
993 # As per RFC 273, IPv6 address should be wrapped with []
994 # when used as Host header
995
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400996 if host.find(':') >= 0:
Senthil Kumaran74ebd9e2010-11-13 12:27:49 +0000997 host_enc = b'[' + host_enc + b']'
998
Senthil Kumaran9da047b2014-04-14 13:07:56 -0400999 if port == self.default_port:
Thomas Wouters477c8d52006-05-27 19:21:47 +00001000 self.putheader('Host', host_enc)
1001 else:
Guido van Rossum98297ee2007-11-06 21:34:58 +00001002 host_enc = host_enc.decode("ascii")
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001003 self.putheader('Host', "%s:%s" % (host_enc, port))
Greg Stein5e0fa402000-06-26 08:28:01 +00001004
Greg Steindd6eefb2000-07-18 09:09:48 +00001005 # note: we are assuming that clients will not attempt to set these
1006 # headers since *this* library must deal with the
1007 # consequences. this also means that when the supporting
1008 # libraries are updated to recognize other forms, then this
1009 # code should be changed (removed or updated).
Greg Stein5e0fa402000-06-26 08:28:01 +00001010
Greg Steindd6eefb2000-07-18 09:09:48 +00001011 # we only want a Content-Encoding of "identity" since we don't
1012 # support encodings such as x-gzip or x-deflate.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +00001013 if not skip_accept_encoding:
1014 self.putheader('Accept-Encoding', 'identity')
Greg Stein5e0fa402000-06-26 08:28:01 +00001015
Greg Steindd6eefb2000-07-18 09:09:48 +00001016 # we can accept "chunked" Transfer-Encodings, but no others
1017 # NOTE: no TE header implies *only* "chunked"
1018 #self.putheader('TE', 'chunked')
Greg Stein5e0fa402000-06-26 08:28:01 +00001019
Greg Steindd6eefb2000-07-18 09:09:48 +00001020 # if TE is supplied in the header, then it must appear in a
1021 # Connection header.
1022 #self.putheader('Connection', 'TE')
Greg Stein5e0fa402000-06-26 08:28:01 +00001023
Greg Steindd6eefb2000-07-18 09:09:48 +00001024 else:
1025 # For HTTP/1.0, the server will assume "not chunked"
1026 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001027
Benjamin Petersonf608c612008-11-16 18:33:53 +00001028 def putheader(self, header, *values):
Greg Steindd6eefb2000-07-18 09:09:48 +00001029 """Send a request header line to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001030
Greg Steindd6eefb2000-07-18 09:09:48 +00001031 For example: h.putheader('Accept', 'text/html')
1032 """
1033 if self.__state != _CS_REQ_STARTED:
1034 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +00001035
Guido van Rossum98297ee2007-11-06 21:34:58 +00001036 if hasattr(header, 'encode'):
1037 header = header.encode('ascii')
Serhiy Storchakaa112a8a2015-03-12 11:13:36 +02001038
1039 if not _is_legal_header_name(header):
1040 raise ValueError('Invalid header name %r' % (header,))
1041
Benjamin Petersonf608c612008-11-16 18:33:53 +00001042 values = list(values)
1043 for i, one_value in enumerate(values):
1044 if hasattr(one_value, 'encode'):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001045 values[i] = one_value.encode('latin-1')
Senthil Kumaran58d5dbf2010-10-03 18:22:42 +00001046 elif isinstance(one_value, int):
1047 values[i] = str(one_value).encode('ascii')
Serhiy Storchakaa112a8a2015-03-12 11:13:36 +02001048
1049 if _is_illegal_header_value(values[i]):
1050 raise ValueError('Invalid header value %r' % (values[i],))
1051
Benjamin Petersonf608c612008-11-16 18:33:53 +00001052 value = b'\r\n\t'.join(values)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001053 header = header + b': ' + value
1054 self._output(header)
Greg Stein5e0fa402000-06-26 08:28:01 +00001055
Benjamin Peterson1742e402008-11-30 22:15:29 +00001056 def endheaders(self, message_body=None):
1057 """Indicate that the last header line has been sent to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001058
Senthil Kumaranad87fa62011-10-05 23:26:49 +08001059 This method sends the request to the server. The optional message_body
1060 argument can be used to pass a message body associated with the
1061 request. The message body will be sent in the same packet as the
1062 message headers if it is a string, otherwise it is sent as a separate
1063 packet.
Benjamin Peterson1742e402008-11-30 22:15:29 +00001064 """
Greg Steindd6eefb2000-07-18 09:09:48 +00001065 if self.__state == _CS_REQ_STARTED:
1066 self.__state = _CS_REQ_SENT
1067 else:
1068 raise CannotSendHeader()
Benjamin Peterson1742e402008-11-30 22:15:29 +00001069 self._send_output(message_body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001070
Greg Steindd6eefb2000-07-18 09:09:48 +00001071 def request(self, method, url, body=None, headers={}):
1072 """Send a complete request to the server."""
Jeremy Hylton636950f2009-03-28 04:34:21 +00001073 self._send_request(method, url, body, headers)
Greg Stein5e0fa402000-06-26 08:28:01 +00001074
R David Murraybeed8402015-03-22 15:18:23 -04001075 def _set_content_length(self, body, method):
1076 # Set the content-length based on the body. If the body is "empty", we
1077 # set Content-Length: 0 for methods that expect a body (RFC 7230,
1078 # Section 3.3.2). If the body is set for other methods, we set the
1079 # header provided we can figure out what the length is.
Benjamin Peterson1742e402008-11-30 22:15:29 +00001080 thelen = None
R David Murraybeed8402015-03-22 15:18:23 -04001081 method_expects_body = method.upper() in _METHODS_EXPECTING_BODY
1082 if body is None and method_expects_body:
1083 thelen = '0'
1084 elif body is not None:
Benjamin Peterson1742e402008-11-30 22:15:29 +00001085 try:
R David Murraybeed8402015-03-22 15:18:23 -04001086 thelen = str(len(body))
1087 except TypeError:
1088 # If this is a file-like object, try to
1089 # fstat its file descriptor
1090 try:
1091 thelen = str(os.fstat(body.fileno()).st_size)
1092 except (AttributeError, OSError):
1093 # Don't send a length if this failed
1094 if self.debuglevel > 0: print("Cannot stat!!")
Benjamin Peterson1742e402008-11-30 22:15:29 +00001095
1096 if thelen is not None:
1097 self.putheader('Content-Length', thelen)
1098
Greg Steindd6eefb2000-07-18 09:09:48 +00001099 def _send_request(self, method, url, body, headers):
Jeremy Hylton636950f2009-03-28 04:34:21 +00001100 # Honor explicitly requested Host: and Accept-Encoding: headers.
Jeremy Hylton2c178252004-08-07 16:28:14 +00001101 header_names = dict.fromkeys([k.lower() for k in headers])
1102 skips = {}
1103 if 'host' in header_names:
1104 skips['skip_host'] = 1
1105 if 'accept-encoding' in header_names:
1106 skips['skip_accept_encoding'] = 1
Greg Stein5e0fa402000-06-26 08:28:01 +00001107
Jeremy Hylton2c178252004-08-07 16:28:14 +00001108 self.putrequest(method, url, **skips)
1109
R David Murraybeed8402015-03-22 15:18:23 -04001110 if 'content-length' not in header_names:
1111 self._set_content_length(body, method)
Guido van Rossumcc2b0162007-02-11 06:12:03 +00001112 for hdr, value in headers.items():
Greg Steindd6eefb2000-07-18 09:09:48 +00001113 self.putheader(hdr, value)
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001114 if isinstance(body, str):
Jeremy Hylton236654b2009-03-27 20:24:34 +00001115 # RFC 2616 Section 3.7.1 says that text default has a
1116 # default charset of iso-8859-1.
1117 body = body.encode('iso-8859-1')
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001118 self.endheaders(body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001119
Greg Steindd6eefb2000-07-18 09:09:48 +00001120 def getresponse(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001121 """Get the response from the server.
1122
1123 If the HTTPConnection is in the correct state, returns an
1124 instance of HTTPResponse or of whatever object is returned by
1125 class the response_class variable.
1126
1127 If a request has not been sent or if a previous response has
1128 not be handled, ResponseNotReady is raised. If the HTTP
1129 response indicates that the connection should be closed, then
1130 it will be closed before the response is returned. When the
1131 connection is closed, the underlying socket is closed.
1132 """
Greg Stein5e0fa402000-06-26 08:28:01 +00001133
Greg Stein616a58d2003-06-24 06:35:19 +00001134 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +00001135 if self.__response and self.__response.isclosed():
1136 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +00001137
Greg Steindd6eefb2000-07-18 09:09:48 +00001138 # if a prior response exists, then it must be completed (otherwise, we
1139 # cannot read this response's header to determine the connection-close
1140 # behavior)
1141 #
1142 # note: if a prior response existed, but was connection-close, then the
1143 # socket and response were made independent of this HTTPConnection
1144 # object since a new request requires that we open a whole new
1145 # connection
1146 #
1147 # this means the prior response had one of two states:
1148 # 1) will_close: this connection was reset and the prior socket and
1149 # response operate independently
1150 # 2) persistent: the response was retained and we await its
1151 # isclosed() status to become true.
1152 #
1153 if self.__state != _CS_REQ_SENT or self.__response:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001154 raise ResponseNotReady(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +00001155
Jeremy Hylton30f86742000-09-18 22:50:38 +00001156 if self.debuglevel > 0:
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001157 response = self.response_class(self.sock, self.debuglevel,
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +00001158 method=self._method)
Jeremy Hylton30f86742000-09-18 22:50:38 +00001159 else:
Antoine Pitrou988dbd72010-12-17 17:35:56 +00001160 response = self.response_class(self.sock, method=self._method)
Greg Stein5e0fa402000-06-26 08:28:01 +00001161
Serhiy Storchakab491e052014-12-01 13:07:45 +02001162 try:
1163 response.begin()
1164 assert response.will_close != _UNKNOWN
1165 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +00001166
Serhiy Storchakab491e052014-12-01 13:07:45 +02001167 if response.will_close:
1168 # this effectively passes the connection to the response
1169 self.close()
1170 else:
1171 # remember this, so we can tell when it is complete
1172 self.__response = response
Greg Stein5e0fa402000-06-26 08:28:01 +00001173
Serhiy Storchakab491e052014-12-01 13:07:45 +02001174 return response
1175 except:
1176 response.close()
1177 raise
Greg Stein5e0fa402000-06-26 08:28:01 +00001178
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001179try:
1180 import ssl
Brett Cannoncd171c82013-07-04 17:43:24 -04001181except ImportError:
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001182 pass
1183else:
1184 class HTTPSConnection(HTTPConnection):
1185 "This class allows communication via SSL."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001186
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001187 default_port = HTTPS_PORT
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001188
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001189 # XXX Should key_file and cert_file be deprecated in favour of context?
1190
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001191 def __init__(self, host, port=None, key_file=None, cert_file=None,
Senthil Kumaran052ddb02013-03-18 14:11:41 -07001192 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
1193 source_address=None, *, context=None,
1194 check_hostname=None):
1195 super(HTTPSConnection, self).__init__(host, port, timeout,
Gregory P. Smithb4066372010-01-03 03:28:29 +00001196 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001197 self.key_file = key_file
1198 self.cert_file = cert_file
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001199 if context is None:
Benjamin Peterson4ffb0752014-11-03 14:29:33 -05001200 context = ssl._create_default_https_context()
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001201 will_verify = context.verify_mode != ssl.CERT_NONE
1202 if check_hostname is None:
Benjamin Petersona090f012014-12-07 13:18:25 -05001203 check_hostname = context.check_hostname
1204 if check_hostname and not will_verify:
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001205 raise ValueError("check_hostname needs a SSL context with "
1206 "either CERT_OPTIONAL or CERT_REQUIRED")
1207 if key_file or cert_file:
Antoine Pitrou80603992010-10-13 10:45:16 +00001208 context.load_cert_chain(cert_file, key_file)
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001209 self._context = context
1210 self._check_hostname = check_hostname
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001211
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001212 def connect(self):
1213 "Connect to a host on a given (SSL) port."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001214
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001215 super().connect()
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +00001216
1217 if self._tunnel_host:
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001218 server_hostname = self._tunnel_host
1219 else:
1220 server_hostname = self.host
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +00001221
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001222 self.sock = self._context.wrap_socket(self.sock,
Benjamin Peterson7243b572014-11-23 17:04:34 -06001223 server_hostname=server_hostname)
Christian Heimesf723c712013-12-05 07:51:17 +01001224 if not self._context.check_hostname and self._check_hostname:
1225 try:
Senthil Kumaran9da047b2014-04-14 13:07:56 -04001226 ssl.match_hostname(self.sock.getpeercert(), server_hostname)
Christian Heimesf723c712013-12-05 07:51:17 +01001227 except Exception:
1228 self.sock.shutdown(socket.SHUT_RDWR)
1229 self.sock.close()
1230 raise
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001231
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001232 __all__.append("HTTPSConnection")
Greg Stein5e0fa402000-06-26 08:28:01 +00001233
Greg Stein5e0fa402000-06-26 08:28:01 +00001234class HTTPException(Exception):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001235 # Subclasses that define an __init__ must call Exception.__init__
1236 # or define self.args. Otherwise, str() will fail.
Greg Steindd6eefb2000-07-18 09:09:48 +00001237 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001238
1239class NotConnected(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001240 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001241
Skip Montanaro9d389972002-03-24 16:53:50 +00001242class InvalidURL(HTTPException):
1243 pass
1244
Greg Stein5e0fa402000-06-26 08:28:01 +00001245class UnknownProtocol(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001246 def __init__(self, version):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001247 self.args = version,
Greg Steindd6eefb2000-07-18 09:09:48 +00001248 self.version = version
Greg Stein5e0fa402000-06-26 08:28:01 +00001249
1250class UnknownTransferEncoding(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001251 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001252
Greg Stein5e0fa402000-06-26 08:28:01 +00001253class UnimplementedFileMode(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001254 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001255
1256class IncompleteRead(HTTPException):
Benjamin Peterson6accb982009-03-02 22:50:25 +00001257 def __init__(self, partial, expected=None):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001258 self.args = partial,
Greg Steindd6eefb2000-07-18 09:09:48 +00001259 self.partial = partial
Benjamin Peterson6accb982009-03-02 22:50:25 +00001260 self.expected = expected
1261 def __repr__(self):
1262 if self.expected is not None:
1263 e = ', %i more expected' % self.expected
1264 else:
1265 e = ''
Serhiy Storchaka465e60e2014-07-25 23:36:00 +03001266 return '%s(%i bytes read%s)' % (self.__class__.__name__,
1267 len(self.partial), e)
Benjamin Peterson6accb982009-03-02 22:50:25 +00001268 def __str__(self):
1269 return repr(self)
Greg Stein5e0fa402000-06-26 08:28:01 +00001270
1271class ImproperConnectionState(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001272 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001273
1274class CannotSendRequest(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001275 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001276
1277class CannotSendHeader(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001278 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001279
1280class ResponseNotReady(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001281 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001282
1283class BadStatusLine(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001284 def __init__(self, line):
Benjamin Peterson11dbfd42010-03-21 22:50:04 +00001285 if not line:
1286 line = repr(line)
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001287 self.args = line,
Greg Steindd6eefb2000-07-18 09:09:48 +00001288 self.line = line
Greg Stein5e0fa402000-06-26 08:28:01 +00001289
Senthil Kumaran5466bf12010-12-18 16:55:23 +00001290class LineTooLong(HTTPException):
1291 def __init__(self, line_type):
1292 HTTPException.__init__(self, "got more than %d bytes when reading %s"
1293 % (_MAXLINE, line_type))
1294
Greg Stein5e0fa402000-06-26 08:28:01 +00001295# for backwards compatibility
1296error = HTTPException