blob: 8ea75ce73b5201c95f6113289eddf563cbabefe6 [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
Jeremy Hylton636950f2009-03-28 04:34:21 +000071import io
72import os
73import socket
Jeremy Hylton1afc1692008-06-18 20:49:58 +000074from urllib.parse import urlsplit
Thomas Wouters89d996e2007-09-08 17:39:28 +000075import warnings
Guido van Rossum23acc951994-02-21 16:36:04 +000076
Thomas Wouters47b49bf2007-08-30 22:15:33 +000077__all__ = ["HTTPResponse", "HTTPConnection",
Skip Montanaro951a8842001-06-01 16:25:38 +000078 "HTTPException", "NotConnected", "UnknownProtocol",
Jeremy Hylton7c75c992002-06-28 23:38:14 +000079 "UnknownTransferEncoding", "UnimplementedFileMode",
80 "IncompleteRead", "InvalidURL", "ImproperConnectionState",
81 "CannotSendRequest", "CannotSendHeader", "ResponseNotReady",
Georg Brandl6aab16e2006-02-17 19:17:25 +000082 "BadStatusLine", "error", "responses"]
Skip Montanaro2dd42762001-01-23 15:35:05 +000083
Guido van Rossum23acc951994-02-21 16:36:04 +000084HTTP_PORT = 80
Guido van Rossum09c8b6c1999-12-07 21:37:17 +000085HTTPS_PORT = 443
86
Greg Stein5e0fa402000-06-26 08:28:01 +000087_UNKNOWN = 'UNKNOWN'
88
89# connection states
90_CS_IDLE = 'Idle'
91_CS_REQ_STARTED = 'Request-started'
92_CS_REQ_SENT = 'Request-sent'
93
Martin v. Löwis39a31782004-09-18 09:03:49 +000094# status codes
95# informational
96CONTINUE = 100
97SWITCHING_PROTOCOLS = 101
98PROCESSING = 102
99
100# successful
101OK = 200
102CREATED = 201
103ACCEPTED = 202
104NON_AUTHORITATIVE_INFORMATION = 203
105NO_CONTENT = 204
106RESET_CONTENT = 205
107PARTIAL_CONTENT = 206
108MULTI_STATUS = 207
109IM_USED = 226
110
111# redirection
112MULTIPLE_CHOICES = 300
113MOVED_PERMANENTLY = 301
114FOUND = 302
115SEE_OTHER = 303
116NOT_MODIFIED = 304
117USE_PROXY = 305
118TEMPORARY_REDIRECT = 307
119
120# client error
121BAD_REQUEST = 400
122UNAUTHORIZED = 401
123PAYMENT_REQUIRED = 402
124FORBIDDEN = 403
125NOT_FOUND = 404
126METHOD_NOT_ALLOWED = 405
127NOT_ACCEPTABLE = 406
128PROXY_AUTHENTICATION_REQUIRED = 407
129REQUEST_TIMEOUT = 408
130CONFLICT = 409
131GONE = 410
132LENGTH_REQUIRED = 411
133PRECONDITION_FAILED = 412
134REQUEST_ENTITY_TOO_LARGE = 413
135REQUEST_URI_TOO_LONG = 414
136UNSUPPORTED_MEDIA_TYPE = 415
137REQUESTED_RANGE_NOT_SATISFIABLE = 416
138EXPECTATION_FAILED = 417
139UNPROCESSABLE_ENTITY = 422
140LOCKED = 423
141FAILED_DEPENDENCY = 424
142UPGRADE_REQUIRED = 426
143
144# server error
145INTERNAL_SERVER_ERROR = 500
146NOT_IMPLEMENTED = 501
147BAD_GATEWAY = 502
148SERVICE_UNAVAILABLE = 503
149GATEWAY_TIMEOUT = 504
150HTTP_VERSION_NOT_SUPPORTED = 505
151INSUFFICIENT_STORAGE = 507
152NOT_EXTENDED = 510
153
Georg Brandl6aab16e2006-02-17 19:17:25 +0000154# Mapping status codes to official W3C names
155responses = {
156 100: 'Continue',
157 101: 'Switching Protocols',
158
159 200: 'OK',
160 201: 'Created',
161 202: 'Accepted',
162 203: 'Non-Authoritative Information',
163 204: 'No Content',
164 205: 'Reset Content',
165 206: 'Partial Content',
166
167 300: 'Multiple Choices',
168 301: 'Moved Permanently',
169 302: 'Found',
170 303: 'See Other',
171 304: 'Not Modified',
172 305: 'Use Proxy',
173 306: '(Unused)',
174 307: 'Temporary Redirect',
175
176 400: 'Bad Request',
177 401: 'Unauthorized',
178 402: 'Payment Required',
179 403: 'Forbidden',
180 404: 'Not Found',
181 405: 'Method Not Allowed',
182 406: 'Not Acceptable',
183 407: 'Proxy Authentication Required',
184 408: 'Request Timeout',
185 409: 'Conflict',
186 410: 'Gone',
187 411: 'Length Required',
188 412: 'Precondition Failed',
189 413: 'Request Entity Too Large',
190 414: 'Request-URI Too Long',
191 415: 'Unsupported Media Type',
192 416: 'Requested Range Not Satisfiable',
193 417: 'Expectation Failed',
194
195 500: 'Internal Server Error',
196 501: 'Not Implemented',
197 502: 'Bad Gateway',
198 503: 'Service Unavailable',
199 504: 'Gateway Timeout',
200 505: 'HTTP Version Not Supported',
201}
202
Georg Brandl80ba8e82005-09-29 20:16:07 +0000203# maximal amount of data to read at one time in _safe_read
204MAXAMOUNT = 1048576
205
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000206# maximal line length when calling readline().
207_MAXLINE = 65536
208
Barry Warsaw820c1202008-06-12 04:06:45 +0000209class HTTPMessage(email.message.Message):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000210 # XXX The only usage of this method is in
211 # http.server.CGIHTTPRequestHandler. Maybe move the code there so
212 # that it doesn't need to be part of the public API. The API has
213 # never been defined so this could cause backwards compatibility
214 # issues.
215
Barry Warsaw820c1202008-06-12 04:06:45 +0000216 def getallmatchingheaders(self, name):
217 """Find all header lines matching a given header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000218
Barry Warsaw820c1202008-06-12 04:06:45 +0000219 Look through the list of headers and find all lines matching a given
220 header name (and their continuation lines). A list of the lines is
221 returned, without interpretation. If the header does not occur, an
222 empty list is returned. If the header occurs multiple times, all
223 occurrences are returned. Case is not important in the header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000224
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000225 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000226 name = name.lower() + ':'
227 n = len(name)
228 lst = []
229 hit = 0
230 for line in self.keys():
231 if line[:n].lower() == name:
232 hit = 1
233 elif not line[:1].isspace():
234 hit = 0
235 if hit:
236 lst.append(line)
237 return lst
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000238
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000239def parse_headers(fp, _class=HTTPMessage):
Barry Warsaw820c1202008-06-12 04:06:45 +0000240 """Parses only RFC2822 headers from a file pointer.
241
242 email Parser wants to see strings rather than bytes.
243 But a TextIOWrapper around self.rfile would buffer too many bytes
244 from the stream, bytes which we later need to read as bytes.
245 So we read the correct bytes here, as bytes, for email Parser
246 to parse.
247
248 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000249 headers = []
250 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000251 line = fp.readline(_MAXLINE + 1)
252 if len(line) > _MAXLINE:
253 raise LineTooLong("header line")
Barry Warsaw820c1202008-06-12 04:06:45 +0000254 headers.append(line)
255 if line in (b'\r\n', b'\n', b''):
256 break
257 hstring = b''.join(headers).decode('iso-8859-1')
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000258 return email.parser.Parser(_class=_class).parsestr(hstring)
Greg Stein5e0fa402000-06-26 08:28:01 +0000259
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000260
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000261_strict_sentinel = object()
262
263class HTTPResponse(io.RawIOBase):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000264
265 # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details.
266
Jeremy Hylton811fc142007-08-03 13:30:02 +0000267 # The bytes from the socket object are iso-8859-1 strings.
268 # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded
269 # text following RFC 2047. The basic status line parsing only
270 # accepts iso-8859-1.
271
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000272 def __init__(self, sock, debuglevel=0, strict=_strict_sentinel, method=None, url=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000273 # If the response includes a content-length header, we need to
274 # make sure that the client doesn't read more than the
Jeremy Hylton39b198d2007-08-04 19:22:00 +0000275 # specified number of bytes. If it does, it will block until
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000276 # the server times out and closes the connection. This will
277 # happen if a self.fp.read() is done (without a size) whether
278 # self.fp is buffered or not. So, no self.fp.read() by
279 # clients unless they know what they are doing.
Benjamin Petersonf72d9fb2009-02-08 00:29:20 +0000280 self.fp = sock.makefile("rb")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000281 self.debuglevel = debuglevel
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000282 if strict is not _strict_sentinel:
283 warnings.warn("the 'strict' argument isn't supported anymore; "
284 "http.client now always assumes HTTP/1.x compliant servers.",
285 DeprecationWarning, 2)
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000286 self._method = method
Greg Stein5e0fa402000-06-26 08:28:01 +0000287
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000288 # The HTTPResponse object is returned via urllib. The clients
289 # of http and urllib expect different attributes for the
290 # headers. headers is used here and supports urllib. msg is
291 # provided as a backwards compatibility layer for http
292 # clients.
293
294 self.headers = self.msg = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000295
Greg Steindd6eefb2000-07-18 09:09:48 +0000296 # from the Status-Line of the response
Tim Peters07e99cb2001-01-14 23:47:14 +0000297 self.version = _UNKNOWN # HTTP-Version
298 self.status = _UNKNOWN # Status-Code
299 self.reason = _UNKNOWN # Reason-Phrase
Greg Stein5e0fa402000-06-26 08:28:01 +0000300
Tim Peters07e99cb2001-01-14 23:47:14 +0000301 self.chunked = _UNKNOWN # is "chunked" being used?
302 self.chunk_left = _UNKNOWN # bytes left to read in current chunk
303 self.length = _UNKNOWN # number of bytes left in response
304 self.will_close = _UNKNOWN # conn will close at end of response
Greg Stein5e0fa402000-06-26 08:28:01 +0000305
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000306 def _read_status(self):
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000307 line = str(self.fp.readline(_MAXLINE + 1), "iso-8859-1")
308 if len(line) > _MAXLINE:
309 raise LineTooLong("status line")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000310 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000311 print("reply:", repr(line))
Jeremy Hyltonb6769522003-06-29 17:55:05 +0000312 if not line:
313 # Presumably, the server closed the connection before
314 # sending a valid response.
315 raise BadStatusLine(line)
Greg Steindd6eefb2000-07-18 09:09:48 +0000316 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000317 version, status, reason = line.split(None, 2)
Greg Steindd6eefb2000-07-18 09:09:48 +0000318 except ValueError:
319 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000320 version, status = line.split(None, 1)
Greg Steindd6eefb2000-07-18 09:09:48 +0000321 reason = ""
322 except ValueError:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000323 # empty version will cause next test to fail.
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000324 version = ""
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000325 if not version.startswith("HTTP/"):
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000326 self.close()
327 raise BadStatusLine(line)
Greg Stein5e0fa402000-06-26 08:28:01 +0000328
Jeremy Hylton23d40472001-04-13 14:57:08 +0000329 # The status code is a three-digit number
330 try:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000331 status = int(status)
Jeremy Hylton23d40472001-04-13 14:57:08 +0000332 if status < 100 or status > 999:
333 raise BadStatusLine(line)
334 except ValueError:
335 raise BadStatusLine(line)
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000336 return version, status, reason
Greg Stein5e0fa402000-06-26 08:28:01 +0000337
Jeremy Hylton39c03802002-07-12 14:04:09 +0000338 def begin(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000339 if self.headers is not None:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000340 # we've already started reading the response
341 return
342
343 # read until we get a non-100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000344 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000345 version, status, reason = self._read_status()
Martin v. Löwis39a31782004-09-18 09:03:49 +0000346 if status != CONTINUE:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000347 break
348 # skip the header from the 100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000349 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000350 skip = self.fp.readline(_MAXLINE + 1)
351 if len(skip) > _MAXLINE:
352 raise LineTooLong("header line")
353 skip = skip.strip()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000354 if not skip:
355 break
356 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000357 print("header:", skip)
Tim Petersc411dba2002-07-16 21:35:23 +0000358
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000359 self.code = self.status = status
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000360 self.reason = reason.strip()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000361 if version in ("HTTP/1.0", "HTTP/0.9"):
362 # Some servers might still return "0.9", treat it as 1.0 anyway
Greg Steindd6eefb2000-07-18 09:09:48 +0000363 self.version = 10
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000364 elif version.startswith("HTTP/1."):
Tim Peters07e99cb2001-01-14 23:47:14 +0000365 self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1
Greg Steindd6eefb2000-07-18 09:09:48 +0000366 else:
367 raise UnknownProtocol(version)
Greg Stein5e0fa402000-06-26 08:28:01 +0000368
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000369 self.headers = self.msg = parse_headers(self.fp)
Barry Warsaw820c1202008-06-12 04:06:45 +0000370
Jeremy Hylton30f86742000-09-18 22:50:38 +0000371 if self.debuglevel > 0:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000372 for hdr in self.headers:
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000373 print("header:", hdr, end=" ")
Greg Stein5e0fa402000-06-26 08:28:01 +0000374
Greg Steindd6eefb2000-07-18 09:09:48 +0000375 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000376 tr_enc = self.headers.get("transfer-encoding")
Jeremy Hyltond229b3a2002-09-03 19:24:24 +0000377 if tr_enc and tr_enc.lower() == "chunked":
Jeremy Hylton236156f2008-12-15 03:00:50 +0000378 self.chunked = True
Greg Steindd6eefb2000-07-18 09:09:48 +0000379 self.chunk_left = None
380 else:
Jeremy Hylton236156f2008-12-15 03:00:50 +0000381 self.chunked = False
Greg Stein5e0fa402000-06-26 08:28:01 +0000382
Greg Steindd6eefb2000-07-18 09:09:48 +0000383 # will the connection close at the end of the response?
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000384 self.will_close = self._check_close()
Greg Stein5e0fa402000-06-26 08:28:01 +0000385
Greg Steindd6eefb2000-07-18 09:09:48 +0000386 # do we have a Content-Length?
387 # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked"
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000388 self.length = None
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000389 length = self.headers.get("content-length")
Barry Warsaw820c1202008-06-12 04:06:45 +0000390
391 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000392 tr_enc = self.headers.get("transfer-encoding")
Greg Steindd6eefb2000-07-18 09:09:48 +0000393 if length and not self.chunked:
Jeremy Hylton30a81812000-09-14 20:34:27 +0000394 try:
395 self.length = int(length)
396 except ValueError:
Christian Heimesa612dc02008-02-24 13:08:18 +0000397 self.length = None
398 else:
399 if self.length < 0: # ignore nonsensical negative lengths
400 self.length = None
401 else:
402 self.length = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000403
Greg Steindd6eefb2000-07-18 09:09:48 +0000404 # does the body have a fixed length? (of zero)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000405 if (status == NO_CONTENT or status == NOT_MODIFIED or
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000406 100 <= status < 200 or # 1xx codes
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000407 self._method == "HEAD"):
Greg Steindd6eefb2000-07-18 09:09:48 +0000408 self.length = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000409
Greg Steindd6eefb2000-07-18 09:09:48 +0000410 # if the connection remains open, and we aren't using chunked, and
411 # a content-length was not provided, then assume that the connection
412 # WILL close.
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000413 if (not self.will_close and
414 not self.chunked and
415 self.length is None):
Jeremy Hylton236156f2008-12-15 03:00:50 +0000416 self.will_close = True
Greg Stein5e0fa402000-06-26 08:28:01 +0000417
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000418 def _check_close(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000419 conn = self.headers.get("connection")
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000420 if self.version == 11:
421 # An HTTP/1.1 proxy is assumed to stay open unless
422 # explicitly closed.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000423 conn = self.headers.get("connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000424 if conn and "close" in conn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000425 return True
426 return False
427
Jeremy Hylton2c178252004-08-07 16:28:14 +0000428 # Some HTTP/1.0 implementations have support for persistent
429 # connections, using rules different than HTTP/1.1.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000430
Christian Heimes895627f2007-12-08 17:28:33 +0000431 # For older HTTP, Keep-Alive indicates persistent connection.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000432 if self.headers.get("keep-alive"):
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000433 return False
Tim Peters77c06fb2002-11-24 02:35:35 +0000434
Jeremy Hylton2c178252004-08-07 16:28:14 +0000435 # At least Akamai returns a "Connection: Keep-Alive" header,
436 # which was supposed to be sent by the client.
437 if conn and "keep-alive" in conn.lower():
438 return False
439
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000440 # Proxy-Connection is a netscape hack.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000441 pconn = self.headers.get("proxy-connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000442 if pconn and "keep-alive" in pconn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000443 return False
444
445 # otherwise, assume it will close
446 return True
447
Greg Steindd6eefb2000-07-18 09:09:48 +0000448 def close(self):
449 if self.fp:
450 self.fp.close()
451 self.fp = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000452
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000453 # These implementations are for the benefit of io.BufferedReader.
454
455 # XXX This class should probably be revised to act more like
456 # the "raw stream" that BufferedReader expects.
457
458 @property
459 def closed(self):
460 return self.isclosed()
461
462 def flush(self):
463 self.fp.flush()
464
Jeremy Hyltona7cff022009-04-01 02:35:56 +0000465 def readable(self):
466 return True
467
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000468 # End of "raw stream" methods
469
Greg Steindd6eefb2000-07-18 09:09:48 +0000470 def isclosed(self):
471 # NOTE: it is possible that we will not ever call self.close(). This
472 # case occurs when will_close is TRUE, length is None, and we
473 # read up to the last byte, but NOT past it.
474 #
475 # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be
476 # called, meaning self.isclosed() is meaningful.
477 return self.fp is None
478
479 def read(self, amt=None):
480 if self.fp is None:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000481 return b""
Greg Steindd6eefb2000-07-18 09:09:48 +0000482
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000483 if self._method == "HEAD":
Senthil Kumaran447f82f2010-06-04 16:38:00 +0000484 self.close()
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000485 return b""
486
Greg Steindd6eefb2000-07-18 09:09:48 +0000487 if self.chunked:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000488 return self._read_chunked(amt)
Tim Peters230a60c2002-11-09 05:08:07 +0000489
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000490 if amt is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000491 # unbounded read
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000492 if self.length is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000493 s = self.fp.read()
494 else:
495 s = self._safe_read(self.length)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000496 self.length = 0
Tim Peters07e99cb2001-01-14 23:47:14 +0000497 self.close() # we read everything
Greg Steindd6eefb2000-07-18 09:09:48 +0000498 return s
499
500 if self.length is not None:
501 if amt > self.length:
502 # clip the read to the "end of response"
503 amt = self.length
Greg Steindd6eefb2000-07-18 09:09:48 +0000504
505 # we do not use _safe_read() here because this may be a .will_close
506 # connection, and the user is reading more bytes than will be provided
507 # (for example, reading in 1k chunks)
508 s = self.fp.read(amt)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000509 if self.length is not None:
510 self.length -= len(s)
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000511 if not self.length:
512 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +0000513 return s
514
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000515 def _read_chunked(self, amt):
516 assert self.chunked != _UNKNOWN
517 chunk_left = self.chunk_left
Chris Withers9c33cbf2009-09-04 17:04:16 +0000518 value = []
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000519 while True:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000520 if chunk_left is None:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000521 line = self.fp.readline(_MAXLINE + 1)
522 if len(line) > _MAXLINE:
523 raise LineTooLong("chunk size")
Georg Brandl95ba4692008-01-26 09:45:58 +0000524 i = line.find(b";")
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000525 if i >= 0:
526 line = line[:i] # strip chunk-extensions
Christian Heimesa612dc02008-02-24 13:08:18 +0000527 try:
528 chunk_left = int(line, 16)
529 except ValueError:
530 # close the connection as protocol synchronisation is
531 # probably lost
532 self.close()
Chris Withers9c33cbf2009-09-04 17:04:16 +0000533 raise IncompleteRead(b''.join(value))
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000534 if chunk_left == 0:
535 break
536 if amt is None:
Chris Withers9c33cbf2009-09-04 17:04:16 +0000537 value.append(self._safe_read(chunk_left))
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000538 elif amt < chunk_left:
Chris Withers9c33cbf2009-09-04 17:04:16 +0000539 value.append(self._safe_read(amt))
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000540 self.chunk_left = chunk_left - amt
Chris Withers9c33cbf2009-09-04 17:04:16 +0000541 return b''.join(value)
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000542 elif amt == chunk_left:
Chris Withers9c33cbf2009-09-04 17:04:16 +0000543 value.append(self._safe_read(amt))
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000544 self._safe_read(2) # toss the CRLF at the end of the chunk
545 self.chunk_left = None
Chris Withers9c33cbf2009-09-04 17:04:16 +0000546 return b''.join(value)
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000547 else:
Chris Withers9c33cbf2009-09-04 17:04:16 +0000548 value.append(self._safe_read(chunk_left))
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000549 amt -= chunk_left
550
551 # we read the whole chunk, get another
552 self._safe_read(2) # toss the CRLF at the end of the chunk
553 chunk_left = None
554
555 # read and discard trailer up to the CRLF terminator
556 ### note: we shouldn't have any trailers!
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000557 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000558 line = self.fp.readline(_MAXLINE + 1)
559 if len(line) > _MAXLINE:
560 raise LineTooLong("trailer line")
Christian Heimes0bd4e112008-02-12 22:59:25 +0000561 if not line:
562 # a vanishingly small number of sites EOF without
563 # sending the trailer
564 break
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000565 if line == b"\r\n":
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000566 break
567
568 # we read everything; close the "file"
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000569 self.close()
570
Chris Withers9c33cbf2009-09-04 17:04:16 +0000571 return b''.join(value)
Tim Peters230a60c2002-11-09 05:08:07 +0000572
Greg Steindd6eefb2000-07-18 09:09:48 +0000573 def _safe_read(self, amt):
574 """Read the number of bytes requested, compensating for partial reads.
575
576 Normally, we have a blocking socket, but a read() can be interrupted
577 by a signal (resulting in a partial read).
578
579 Note that we cannot distinguish between EOF and an interrupt when zero
580 bytes have been read. IncompleteRead() will be raised in this
581 situation.
582
583 This function should be used when <amt> bytes "should" be present for
584 reading. If the bytes are truly not available (due to EOF), then the
585 IncompleteRead exception can be used to detect the problem.
586 """
Georg Brandl80ba8e82005-09-29 20:16:07 +0000587 s = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000588 while amt > 0:
Georg Brandl80ba8e82005-09-29 20:16:07 +0000589 chunk = self.fp.read(min(amt, MAXAMOUNT))
Greg Steindd6eefb2000-07-18 09:09:48 +0000590 if not chunk:
Benjamin Peterson6accb982009-03-02 22:50:25 +0000591 raise IncompleteRead(b''.join(s), amt)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000592 s.append(chunk)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000593 amt -= len(chunk)
Guido van Rossuma00f1232007-09-12 19:43:09 +0000594 return b"".join(s)
Greg Steindd6eefb2000-07-18 09:09:48 +0000595
Antoine Pitroub353c122009-02-11 00:39:14 +0000596 def fileno(self):
597 return self.fp.fileno()
598
Greg Steindd6eefb2000-07-18 09:09:48 +0000599 def getheader(self, name, default=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000600 if self.headers is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000601 raise ResponseNotReady()
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000602 headers = self.headers.get_all(name) or default
603 if isinstance(headers, str) or not hasattr(headers, '__iter__'):
604 return headers
605 else:
606 return ', '.join(headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000607
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000608 def getheaders(self):
609 """Return list of (header, value) tuples."""
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000610 if self.headers is None:
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000611 raise ResponseNotReady()
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000612 return list(self.headers.items())
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000613
Antoine Pitroub353c122009-02-11 00:39:14 +0000614 # We override IOBase.__iter__ so that it doesn't check for closed-ness
615
616 def __iter__(self):
617 return self
618
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000619 # For compatibility with old-style urllib responses.
620
621 def info(self):
622 return self.headers
623
624 def geturl(self):
625 return self.url
626
627 def getcode(self):
628 return self.status
Greg Stein5e0fa402000-06-26 08:28:01 +0000629
630class HTTPConnection:
631
Greg Steindd6eefb2000-07-18 09:09:48 +0000632 _http_vsn = 11
633 _http_vsn_str = 'HTTP/1.1'
Greg Stein5e0fa402000-06-26 08:28:01 +0000634
Greg Steindd6eefb2000-07-18 09:09:48 +0000635 response_class = HTTPResponse
636 default_port = HTTP_PORT
637 auto_open = 1
Jeremy Hylton30f86742000-09-18 22:50:38 +0000638 debuglevel = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000639
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000640 def __init__(self, host, port=None, strict=_strict_sentinel,
Gregory P. Smithb4066372010-01-03 03:28:29 +0000641 timeout=socket._GLOBAL_DEFAULT_TIMEOUT, source_address=None):
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000642 if strict is not _strict_sentinel:
643 warnings.warn("the 'strict' argument isn't supported anymore; "
644 "http.client now always assumes HTTP/1.x compliant servers.",
645 DeprecationWarning, 2)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000646 self.timeout = timeout
Gregory P. Smithb4066372010-01-03 03:28:29 +0000647 self.source_address = source_address
Greg Steindd6eefb2000-07-18 09:09:48 +0000648 self.sock = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000649 self._buffer = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000650 self.__response = None
651 self.__state = _CS_IDLE
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000652 self._method = None
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000653 self._tunnel_host = None
654 self._tunnel_port = None
Tim Petersc411dba2002-07-16 21:35:23 +0000655
Greg Steindd6eefb2000-07-18 09:09:48 +0000656 self._set_hostport(host, port)
Greg Stein5e0fa402000-06-26 08:28:01 +0000657
Senthil Kumaran47fff872009-12-20 07:10:31 +0000658 def set_tunnel(self, host, port=None, headers=None):
659 """ Sets up the host and the port for the HTTP CONNECT Tunnelling.
660
661 The headers argument should be a mapping of extra HTTP headers
662 to send with the CONNECT request.
663 """
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000664 self._tunnel_host = host
665 self._tunnel_port = port
Senthil Kumaran47fff872009-12-20 07:10:31 +0000666 if headers:
667 self._tunnel_headers = headers
668 else:
669 self._tunnel_headers.clear()
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000670
Greg Steindd6eefb2000-07-18 09:09:48 +0000671 def _set_hostport(self, host, port):
672 if port is None:
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000673 i = host.rfind(':')
Skip Montanarocae14d22004-09-14 17:55:21 +0000674 j = host.rfind(']') # ipv6 addresses have [...]
675 if i > j:
Skip Montanaro9d389972002-03-24 16:53:50 +0000676 try:
677 port = int(host[i+1:])
678 except ValueError:
Jeremy Hyltonfbd79942002-07-02 20:19:08 +0000679 raise InvalidURL("nonnumeric port: '%s'" % host[i+1:])
Greg Steindd6eefb2000-07-18 09:09:48 +0000680 host = host[:i]
681 else:
682 port = self.default_port
Raymond Hettinger4d037912004-10-14 15:23:38 +0000683 if host and host[0] == '[' and host[-1] == ']':
Brett Cannon0a1af4a2004-09-15 23:26:23 +0000684 host = host[1:-1]
Greg Steindd6eefb2000-07-18 09:09:48 +0000685 self.host = host
686 self.port = port
Greg Stein5e0fa402000-06-26 08:28:01 +0000687
Jeremy Hylton30f86742000-09-18 22:50:38 +0000688 def set_debuglevel(self, level):
689 self.debuglevel = level
690
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000691 def _tunnel(self):
692 self._set_hostport(self._tunnel_host, self._tunnel_port)
Senthil Kumaran47fff872009-12-20 07:10:31 +0000693 connect_str = "CONNECT %s:%d HTTP/1.0\r\n" %(self.host, self.port)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000694 connect_bytes = connect_str.encode("ascii")
695 self.send(connect_bytes)
Senthil Kumaran47fff872009-12-20 07:10:31 +0000696 for header, value in self._tunnel_headers.iteritems():
697 header_str = "%s: %s\r\n" % (header, value)
698 header_bytes = header_str.encode("ascii")
699 self.send(header_bytes)
700
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000701 response = self.response_class(self.sock, method = self._method)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000702 (version, code, message) = response._read_status()
Senthil Kumaran47fff872009-12-20 07:10:31 +0000703
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000704 if code != 200:
705 self.close()
706 raise socket.error("Tunnel connection failed: %d %s" % (code,
707 message.strip()))
708 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000709 line = response.fp.readline(_MAXLINE + 1)
710 if len(line) > _MAXLINE:
711 raise LineTooLong("header line")
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000712 if line == b'\r\n':
713 break
714
Greg Steindd6eefb2000-07-18 09:09:48 +0000715 def connect(self):
716 """Connect to the host and port specified in __init__."""
Guido van Rossumd8faa362007-04-27 19:54:29 +0000717 self.sock = socket.create_connection((self.host,self.port),
Gregory P. Smithb4066372010-01-03 03:28:29 +0000718 self.timeout, self.source_address)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000719 if self._tunnel_host:
720 self._tunnel()
Greg Stein5e0fa402000-06-26 08:28:01 +0000721
Greg Steindd6eefb2000-07-18 09:09:48 +0000722 def close(self):
723 """Close the connection to the HTTP server."""
724 if self.sock:
Tim Peters07e99cb2001-01-14 23:47:14 +0000725 self.sock.close() # close it manually... there may be other refs
Greg Steindd6eefb2000-07-18 09:09:48 +0000726 self.sock = None
727 if self.__response:
728 self.__response.close()
729 self.__response = None
730 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000731
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000732 def send(self, data):
733 """Send `data' to the server."""
Greg Steindd6eefb2000-07-18 09:09:48 +0000734 if self.sock is None:
735 if self.auto_open:
736 self.connect()
737 else:
738 raise NotConnected()
Greg Stein5e0fa402000-06-26 08:28:01 +0000739
Jeremy Hylton30f86742000-09-18 22:50:38 +0000740 if self.debuglevel > 0:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000741 print("send:", repr(data))
Jeremy Hylton636950f2009-03-28 04:34:21 +0000742 blocksize = 8192
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000743 if hasattr(data, "read") :
Jeremy Hylton636950f2009-03-28 04:34:21 +0000744 if self.debuglevel > 0:
745 print("sendIng a read()able")
746 encode = False
Antoine Pitrouead1d622009-09-29 18:44:53 +0000747 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000748 mode = data.mode
Antoine Pitrouead1d622009-09-29 18:44:53 +0000749 except AttributeError:
750 # io.BytesIO and other file-like objects don't have a `mode`
751 # attribute.
752 pass
753 else:
754 if "b" not in mode:
755 encode = True
756 if self.debuglevel > 0:
757 print("encoding file using iso-8859-1")
Jeremy Hylton636950f2009-03-28 04:34:21 +0000758 while 1:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000759 datablock = data.read(blocksize)
760 if not datablock:
Jeremy Hylton636950f2009-03-28 04:34:21 +0000761 break
762 if encode:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000763 datablock = datablock.encode("iso-8859-1")
764 self.sock.sendall(datablock)
Jeremy Hylton636950f2009-03-28 04:34:21 +0000765 else:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000766 self.sock.sendall(data)
Greg Stein5e0fa402000-06-26 08:28:01 +0000767
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000768 def _output(self, s):
769 """Add a line of output to the current request buffer.
Tim Peters469cdad2002-08-08 20:19:19 +0000770
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000771 Assumes that the line does *not* end with \\r\\n.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000772 """
773 self._buffer.append(s)
774
Benjamin Peterson1742e402008-11-30 22:15:29 +0000775 def _send_output(self, message_body=None):
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000776 """Send the currently buffered request and clear the buffer.
777
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000778 Appends an extra \\r\\n to the buffer.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000779 A message_body may be specified, to be appended to the request.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000780 """
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000781 self._buffer.extend((b"", b""))
782 msg = b"\r\n".join(self._buffer)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000783 del self._buffer[:]
Benjamin Peterson1742e402008-11-30 22:15:29 +0000784 # If msg and message_body are sent in a single send() call,
785 # it will avoid performance problems caused by the interaction
786 # between delayed ack and the Nagle algorithim.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000787 if isinstance(message_body, bytes):
Benjamin Peterson1742e402008-11-30 22:15:29 +0000788 msg += message_body
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000789 message_body = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000790 self.send(msg)
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000791 if message_body is not None:
Jeremy Hylton236654b2009-03-27 20:24:34 +0000792 # message_body was not a string (i.e. it is a file), and
793 # we must run the risk of Nagle.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000794 self.send(message_body)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000795
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000796 def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0):
Greg Steindd6eefb2000-07-18 09:09:48 +0000797 """Send a request to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000798
Greg Steindd6eefb2000-07-18 09:09:48 +0000799 `method' specifies an HTTP request method, e.g. 'GET'.
800 `url' specifies the object being requested, e.g. '/index.html'.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000801 `skip_host' if True does not add automatically a 'Host:' header
802 `skip_accept_encoding' if True does not add automatically an
803 'Accept-Encoding:' header
Greg Steindd6eefb2000-07-18 09:09:48 +0000804 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000805
Greg Stein616a58d2003-06-24 06:35:19 +0000806 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000807 if self.__response and self.__response.isclosed():
808 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000809
Tim Peters58eb11c2004-01-18 20:29:55 +0000810
Greg Steindd6eefb2000-07-18 09:09:48 +0000811 # in certain cases, we cannot issue another request on this connection.
812 # this occurs when:
813 # 1) we are in the process of sending a request. (_CS_REQ_STARTED)
814 # 2) a response to a previous request has signalled that it is going
815 # to close the connection upon completion.
816 # 3) the headers for the previous response have not been read, thus
817 # we cannot determine whether point (2) is true. (_CS_REQ_SENT)
818 #
819 # if there is no prior response, then we can request at will.
820 #
821 # if point (2) is true, then we will have passed the socket to the
822 # response (effectively meaning, "there is no prior response"), and
823 # will open a new one when a new request is made.
824 #
825 # Note: if a prior response exists, then we *can* start a new request.
826 # We are not allowed to begin fetching the response to this new
827 # request, however, until that prior response is complete.
828 #
829 if self.__state == _CS_IDLE:
830 self.__state = _CS_REQ_STARTED
831 else:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000832 raise CannotSendRequest(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +0000833
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000834 # Save the method we use, we need it later in the response phase
835 self._method = method
Greg Steindd6eefb2000-07-18 09:09:48 +0000836 if not url:
837 url = '/'
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000838 request = '%s %s %s' % (method, url, self._http_vsn_str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000839
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000840 # Non-ASCII characters should have been eliminated earlier
841 self._output(request.encode('ascii'))
Greg Stein5e0fa402000-06-26 08:28:01 +0000842
Greg Steindd6eefb2000-07-18 09:09:48 +0000843 if self._http_vsn == 11:
844 # Issue some standard headers for better HTTP/1.1 compliance
Greg Stein5e0fa402000-06-26 08:28:01 +0000845
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000846 if not skip_host:
847 # this header is issued *only* for HTTP/1.1
848 # connections. more specifically, this means it is
849 # only issued when the client uses the new
850 # HTTPConnection() class. backwards-compat clients
851 # will be using HTTP/1.0 and those clients may be
852 # issuing this header themselves. we should NOT issue
853 # it twice; some web servers (such as Apache) barf
854 # when they see two Host: headers
Guido van Rossumf6922aa2001-01-14 21:03:01 +0000855
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000856 # If we need a non-standard port,include it in the
857 # header. If the request is going through a proxy,
858 # but the host of the actual URL, not the host of the
859 # proxy.
Jeremy Hylton8acf1e02002-03-08 19:35:51 +0000860
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000861 netloc = ''
862 if url.startswith('http'):
863 nil, netloc, nil, nil, nil = urlsplit(url)
864
865 if netloc:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000866 try:
867 netloc_enc = netloc.encode("ascii")
868 except UnicodeEncodeError:
869 netloc_enc = netloc.encode("idna")
870 self.putheader('Host', netloc_enc)
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000871 else:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000872 try:
873 host_enc = self.host.encode("ascii")
874 except UnicodeEncodeError:
875 host_enc = self.host.encode("idna")
Senthil Kumaran74ebd9e2010-11-13 12:27:49 +0000876
877 # As per RFC 273, IPv6 address should be wrapped with []
878 # when used as Host header
879
880 if self.host.find(':') >= 0:
881 host_enc = b'[' + host_enc + b']'
882
Georg Brandl86b2fb92008-07-16 03:43:04 +0000883 if self.port == self.default_port:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000884 self.putheader('Host', host_enc)
885 else:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000886 host_enc = host_enc.decode("ascii")
Thomas Wouters477c8d52006-05-27 19:21:47 +0000887 self.putheader('Host', "%s:%s" % (host_enc, self.port))
Greg Stein5e0fa402000-06-26 08:28:01 +0000888
Greg Steindd6eefb2000-07-18 09:09:48 +0000889 # note: we are assuming that clients will not attempt to set these
890 # headers since *this* library must deal with the
891 # consequences. this also means that when the supporting
892 # libraries are updated to recognize other forms, then this
893 # code should be changed (removed or updated).
Greg Stein5e0fa402000-06-26 08:28:01 +0000894
Greg Steindd6eefb2000-07-18 09:09:48 +0000895 # we only want a Content-Encoding of "identity" since we don't
896 # support encodings such as x-gzip or x-deflate.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000897 if not skip_accept_encoding:
898 self.putheader('Accept-Encoding', 'identity')
Greg Stein5e0fa402000-06-26 08:28:01 +0000899
Greg Steindd6eefb2000-07-18 09:09:48 +0000900 # we can accept "chunked" Transfer-Encodings, but no others
901 # NOTE: no TE header implies *only* "chunked"
902 #self.putheader('TE', 'chunked')
Greg Stein5e0fa402000-06-26 08:28:01 +0000903
Greg Steindd6eefb2000-07-18 09:09:48 +0000904 # if TE is supplied in the header, then it must appear in a
905 # Connection header.
906 #self.putheader('Connection', 'TE')
Greg Stein5e0fa402000-06-26 08:28:01 +0000907
Greg Steindd6eefb2000-07-18 09:09:48 +0000908 else:
909 # For HTTP/1.0, the server will assume "not chunked"
910 pass
Greg Stein5e0fa402000-06-26 08:28:01 +0000911
Benjamin Petersonf608c612008-11-16 18:33:53 +0000912 def putheader(self, header, *values):
Greg Steindd6eefb2000-07-18 09:09:48 +0000913 """Send a request header line to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000914
Greg Steindd6eefb2000-07-18 09:09:48 +0000915 For example: h.putheader('Accept', 'text/html')
916 """
917 if self.__state != _CS_REQ_STARTED:
918 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +0000919
Guido van Rossum98297ee2007-11-06 21:34:58 +0000920 if hasattr(header, 'encode'):
921 header = header.encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +0000922 values = list(values)
923 for i, one_value in enumerate(values):
924 if hasattr(one_value, 'encode'):
925 values[i] = one_value.encode('ascii')
Senthil Kumaran58d5dbf2010-10-03 18:22:42 +0000926 elif isinstance(one_value, int):
927 values[i] = str(one_value).encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +0000928 value = b'\r\n\t'.join(values)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000929 header = header + b': ' + value
930 self._output(header)
Greg Stein5e0fa402000-06-26 08:28:01 +0000931
Benjamin Peterson1742e402008-11-30 22:15:29 +0000932 def endheaders(self, message_body=None):
933 """Indicate that the last header line has been sent to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000934
Benjamin Peterson1742e402008-11-30 22:15:29 +0000935 This method sends the request to the server. The optional
936 message_body argument can be used to pass message body
937 associated with the request. The message body will be sent in
938 the same packet as the message headers if possible. The
939 message_body should be a string.
940 """
Greg Steindd6eefb2000-07-18 09:09:48 +0000941 if self.__state == _CS_REQ_STARTED:
942 self.__state = _CS_REQ_SENT
943 else:
944 raise CannotSendHeader()
Benjamin Peterson1742e402008-11-30 22:15:29 +0000945 self._send_output(message_body)
Greg Stein5e0fa402000-06-26 08:28:01 +0000946
Greg Steindd6eefb2000-07-18 09:09:48 +0000947 def request(self, method, url, body=None, headers={}):
948 """Send a complete request to the server."""
Jeremy Hylton636950f2009-03-28 04:34:21 +0000949 self._send_request(method, url, body, headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000950
Benjamin Peterson1742e402008-11-30 22:15:29 +0000951 def _set_content_length(self, body):
952 # Set the content-length based on the body.
953 thelen = None
954 try:
955 thelen = str(len(body))
956 except TypeError as te:
957 # If this is a file-like object, try to
958 # fstat its file descriptor
Benjamin Peterson1742e402008-11-30 22:15:29 +0000959 try:
960 thelen = str(os.fstat(body.fileno()).st_size)
961 except (AttributeError, OSError):
962 # Don't send a length if this failed
963 if self.debuglevel > 0: print("Cannot stat!!")
964
965 if thelen is not None:
966 self.putheader('Content-Length', thelen)
967
Greg Steindd6eefb2000-07-18 09:09:48 +0000968 def _send_request(self, method, url, body, headers):
Jeremy Hylton636950f2009-03-28 04:34:21 +0000969 # Honor explicitly requested Host: and Accept-Encoding: headers.
Jeremy Hylton2c178252004-08-07 16:28:14 +0000970 header_names = dict.fromkeys([k.lower() for k in headers])
971 skips = {}
972 if 'host' in header_names:
973 skips['skip_host'] = 1
974 if 'accept-encoding' in header_names:
975 skips['skip_accept_encoding'] = 1
Greg Stein5e0fa402000-06-26 08:28:01 +0000976
Jeremy Hylton2c178252004-08-07 16:28:14 +0000977 self.putrequest(method, url, **skips)
978
979 if body and ('content-length' not in header_names):
Benjamin Peterson1742e402008-11-30 22:15:29 +0000980 self._set_content_length(body)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000981 for hdr, value in headers.items():
Greg Steindd6eefb2000-07-18 09:09:48 +0000982 self.putheader(hdr, value)
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +0000983 if isinstance(body, str):
Jeremy Hylton236654b2009-03-27 20:24:34 +0000984 # RFC 2616 Section 3.7.1 says that text default has a
985 # default charset of iso-8859-1.
986 body = body.encode('iso-8859-1')
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +0000987 self.endheaders(body)
Greg Stein5e0fa402000-06-26 08:28:01 +0000988
Greg Steindd6eefb2000-07-18 09:09:48 +0000989 def getresponse(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000990 """Get the response from the server.
991
992 If the HTTPConnection is in the correct state, returns an
993 instance of HTTPResponse or of whatever object is returned by
994 class the response_class variable.
995
996 If a request has not been sent or if a previous response has
997 not be handled, ResponseNotReady is raised. If the HTTP
998 response indicates that the connection should be closed, then
999 it will be closed before the response is returned. When the
1000 connection is closed, the underlying socket is closed.
1001 """
Greg Stein5e0fa402000-06-26 08:28:01 +00001002
Greg Stein616a58d2003-06-24 06:35:19 +00001003 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +00001004 if self.__response and self.__response.isclosed():
1005 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +00001006
Greg Steindd6eefb2000-07-18 09:09:48 +00001007 # if a prior response exists, then it must be completed (otherwise, we
1008 # cannot read this response's header to determine the connection-close
1009 # behavior)
1010 #
1011 # note: if a prior response existed, but was connection-close, then the
1012 # socket and response were made independent of this HTTPConnection
1013 # object since a new request requires that we open a whole new
1014 # connection
1015 #
1016 # this means the prior response had one of two states:
1017 # 1) will_close: this connection was reset and the prior socket and
1018 # response operate independently
1019 # 2) persistent: the response was retained and we await its
1020 # isclosed() status to become true.
1021 #
1022 if self.__state != _CS_REQ_SENT or self.__response:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001023 raise ResponseNotReady(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +00001024
Jeremy Hylton30f86742000-09-18 22:50:38 +00001025 if self.debuglevel > 0:
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001026 response = self.response_class(self.sock, self.debuglevel,
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +00001027 method=self._method)
Jeremy Hylton30f86742000-09-18 22:50:38 +00001028 else:
Antoine Pitrou988dbd72010-12-17 17:35:56 +00001029 response = self.response_class(self.sock, method=self._method)
Greg Stein5e0fa402000-06-26 08:28:01 +00001030
Jeremy Hylton39c03802002-07-12 14:04:09 +00001031 response.begin()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +00001032 assert response.will_close != _UNKNOWN
Greg Steindd6eefb2000-07-18 09:09:48 +00001033 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +00001034
Greg Steindd6eefb2000-07-18 09:09:48 +00001035 if response.will_close:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001036 # this effectively passes the connection to the response
1037 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +00001038 else:
1039 # remember this, so we can tell when it is complete
1040 self.__response = response
Greg Stein5e0fa402000-06-26 08:28:01 +00001041
Greg Steindd6eefb2000-07-18 09:09:48 +00001042 return response
Greg Stein5e0fa402000-06-26 08:28:01 +00001043
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001044try:
1045 import ssl
1046except ImportError:
1047 pass
1048else:
1049 class HTTPSConnection(HTTPConnection):
1050 "This class allows communication via SSL."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001051
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001052 default_port = HTTPS_PORT
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001053
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001054 # XXX Should key_file and cert_file be deprecated in favour of context?
1055
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001056 def __init__(self, host, port=None, key_file=None, cert_file=None,
Antoine Pitrou988dbd72010-12-17 17:35:56 +00001057 strict=_strict_sentinel, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001058 source_address=None, *, context=None, check_hostname=None):
Gregory P. Smithb4066372010-01-03 03:28:29 +00001059 super(HTTPSConnection, self).__init__(host, port, strict, timeout,
1060 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001061 self.key_file = key_file
1062 self.cert_file = cert_file
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001063 if context is None:
1064 # Some reasonable defaults
1065 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1066 context.options |= ssl.OP_NO_SSLv2
1067 will_verify = context.verify_mode != ssl.CERT_NONE
1068 if check_hostname is None:
1069 check_hostname = will_verify
1070 elif check_hostname and not will_verify:
1071 raise ValueError("check_hostname needs a SSL context with "
1072 "either CERT_OPTIONAL or CERT_REQUIRED")
1073 if key_file or cert_file:
Antoine Pitrou80603992010-10-13 10:45:16 +00001074 context.load_cert_chain(cert_file, key_file)
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001075 self._context = context
1076 self._check_hostname = check_hostname
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001077
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001078 def connect(self):
1079 "Connect to a host on a given (SSL) port."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001080
Jeremy Hylton636950f2009-03-28 04:34:21 +00001081 sock = socket.create_connection((self.host, self.port),
Gregory P. Smithb4066372010-01-03 03:28:29 +00001082 self.timeout, self.source_address)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +00001083
1084 if self._tunnel_host:
1085 self.sock = sock
1086 self._tunnel()
1087
Antoine Pitroud5323212010-10-22 18:19:07 +00001088 server_hostname = self.host if ssl.HAS_SNI else None
1089 self.sock = self._context.wrap_socket(sock,
1090 server_hostname=server_hostname)
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001091 try:
1092 if self._check_hostname:
1093 ssl.match_hostname(self.sock.getpeercert(), self.host)
1094 except Exception:
1095 self.sock.shutdown(socket.SHUT_RDWR)
1096 self.sock.close()
1097 raise
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001098
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001099 __all__.append("HTTPSConnection")
Greg Stein5e0fa402000-06-26 08:28:01 +00001100
Greg Stein5e0fa402000-06-26 08:28:01 +00001101class HTTPException(Exception):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001102 # Subclasses that define an __init__ must call Exception.__init__
1103 # or define self.args. Otherwise, str() will fail.
Greg Steindd6eefb2000-07-18 09:09:48 +00001104 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001105
1106class NotConnected(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001107 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001108
Skip Montanaro9d389972002-03-24 16:53:50 +00001109class InvalidURL(HTTPException):
1110 pass
1111
Greg Stein5e0fa402000-06-26 08:28:01 +00001112class UnknownProtocol(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001113 def __init__(self, version):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001114 self.args = version,
Greg Steindd6eefb2000-07-18 09:09:48 +00001115 self.version = version
Greg Stein5e0fa402000-06-26 08:28:01 +00001116
1117class UnknownTransferEncoding(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001118 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001119
Greg Stein5e0fa402000-06-26 08:28:01 +00001120class UnimplementedFileMode(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001121 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001122
1123class IncompleteRead(HTTPException):
Benjamin Peterson6accb982009-03-02 22:50:25 +00001124 def __init__(self, partial, expected=None):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001125 self.args = partial,
Greg Steindd6eefb2000-07-18 09:09:48 +00001126 self.partial = partial
Benjamin Peterson6accb982009-03-02 22:50:25 +00001127 self.expected = expected
1128 def __repr__(self):
1129 if self.expected is not None:
1130 e = ', %i more expected' % self.expected
1131 else:
1132 e = ''
1133 return 'IncompleteRead(%i bytes read%s)' % (len(self.partial), e)
1134 def __str__(self):
1135 return repr(self)
Greg Stein5e0fa402000-06-26 08:28:01 +00001136
1137class ImproperConnectionState(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001138 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001139
1140class CannotSendRequest(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001141 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001142
1143class CannotSendHeader(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001144 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001145
1146class ResponseNotReady(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001147 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001148
1149class BadStatusLine(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001150 def __init__(self, line):
Benjamin Peterson11dbfd42010-03-21 22:50:04 +00001151 if not line:
1152 line = repr(line)
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001153 self.args = line,
Greg Steindd6eefb2000-07-18 09:09:48 +00001154 self.line = line
Greg Stein5e0fa402000-06-26 08:28:01 +00001155
Senthil Kumaran5466bf12010-12-18 16:55:23 +00001156class LineTooLong(HTTPException):
1157 def __init__(self, line_type):
1158 HTTPException.__init__(self, "got more than %d bytes when reading %s"
1159 % (_MAXLINE, line_type))
1160
Greg Stein5e0fa402000-06-26 08:28:01 +00001161# for backwards compatibility
1162error = HTTPException