blob: f9b74e49e5a1e0a5521f335c757e3fcc5952dbcd [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
Barry Warsaw820c1202008-06-12 04:06:45 +0000206class HTTPMessage(email.message.Message):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000207 # XXX The only usage of this method is in
208 # http.server.CGIHTTPRequestHandler. Maybe move the code there so
209 # that it doesn't need to be part of the public API. The API has
210 # never been defined so this could cause backwards compatibility
211 # issues.
212
Barry Warsaw820c1202008-06-12 04:06:45 +0000213 def getallmatchingheaders(self, name):
214 """Find all header lines matching a given header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000215
Barry Warsaw820c1202008-06-12 04:06:45 +0000216 Look through the list of headers and find all lines matching a given
217 header name (and their continuation lines). A list of the lines is
218 returned, without interpretation. If the header does not occur, an
219 empty list is returned. If the header occurs multiple times, all
220 occurrences are returned. Case is not important in the header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000221
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000222 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000223 name = name.lower() + ':'
224 n = len(name)
225 lst = []
226 hit = 0
227 for line in self.keys():
228 if line[:n].lower() == name:
229 hit = 1
230 elif not line[:1].isspace():
231 hit = 0
232 if hit:
233 lst.append(line)
234 return lst
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000235
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000236def parse_headers(fp, _class=HTTPMessage):
Barry Warsaw820c1202008-06-12 04:06:45 +0000237 """Parses only RFC2822 headers from a file pointer.
238
239 email Parser wants to see strings rather than bytes.
240 But a TextIOWrapper around self.rfile would buffer too many bytes
241 from the stream, bytes which we later need to read as bytes.
242 So we read the correct bytes here, as bytes, for email Parser
243 to parse.
244
245 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000246 headers = []
247 while True:
248 line = fp.readline()
249 headers.append(line)
250 if line in (b'\r\n', b'\n', b''):
251 break
252 hstring = b''.join(headers).decode('iso-8859-1')
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000253 return email.parser.Parser(_class=_class).parsestr(hstring)
Greg Stein5e0fa402000-06-26 08:28:01 +0000254
Antoine Pitroub353c122009-02-11 00:39:14 +0000255class HTTPResponse(io.RawIOBase):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000256
257 # strict: If true, raise BadStatusLine if the status line can't be
258 # parsed as a valid HTTP/1.0 or 1.1 status line. By default it is
Skip Montanaro186bec22002-07-25 16:10:38 +0000259 # false because it prevents clients from talking to HTTP/0.9
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000260 # servers. Note that a response with a sufficiently corrupted
261 # status line will look like an HTTP/0.9 response.
262
263 # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details.
264
Jeremy Hylton811fc142007-08-03 13:30:02 +0000265 # The bytes from the socket object are iso-8859-1 strings.
266 # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded
267 # text following RFC 2047. The basic status line parsing only
268 # accepts iso-8859-1.
269
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000270 def __init__(self, sock, debuglevel=0, strict=0, method=None, url=None):
271 # If the response includes a content-length header, we need to
272 # make sure that the client doesn't read more than the
Jeremy Hylton39b198d2007-08-04 19:22:00 +0000273 # specified number of bytes. If it does, it will block until
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000274 # the server times out and closes the connection. This will
275 # happen if a self.fp.read() is done (without a size) whether
276 # self.fp is buffered or not. So, no self.fp.read() by
277 # clients unless they know what they are doing.
Benjamin Petersonf72d9fb2009-02-08 00:29:20 +0000278 self.fp = sock.makefile("rb")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000279 self.debuglevel = debuglevel
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000280 self.strict = strict
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000281 self._method = method
Greg Stein5e0fa402000-06-26 08:28:01 +0000282
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000283 # The HTTPResponse object is returned via urllib. The clients
284 # of http and urllib expect different attributes for the
285 # headers. headers is used here and supports urllib. msg is
286 # provided as a backwards compatibility layer for http
287 # clients.
288
289 self.headers = self.msg = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000290
Greg Steindd6eefb2000-07-18 09:09:48 +0000291 # from the Status-Line of the response
Tim Peters07e99cb2001-01-14 23:47:14 +0000292 self.version = _UNKNOWN # HTTP-Version
293 self.status = _UNKNOWN # Status-Code
294 self.reason = _UNKNOWN # Reason-Phrase
Greg Stein5e0fa402000-06-26 08:28:01 +0000295
Tim Peters07e99cb2001-01-14 23:47:14 +0000296 self.chunked = _UNKNOWN # is "chunked" being used?
297 self.chunk_left = _UNKNOWN # bytes left to read in current chunk
298 self.length = _UNKNOWN # number of bytes left in response
299 self.will_close = _UNKNOWN # conn will close at end of response
Greg Stein5e0fa402000-06-26 08:28:01 +0000300
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000301 def _read_status(self):
Jeremy Hylton04319c72007-08-04 03:41:19 +0000302 # Initialize with Simple-Response defaults.
Jeremy Hylton811fc142007-08-03 13:30:02 +0000303 line = str(self.fp.readline(), "iso-8859-1")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000304 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000305 print("reply:", repr(line))
Jeremy Hyltonb6769522003-06-29 17:55:05 +0000306 if not line:
307 # Presumably, the server closed the connection before
308 # sending a valid response.
309 raise BadStatusLine(line)
Greg Steindd6eefb2000-07-18 09:09:48 +0000310 try:
Guido van Rossum34735a62000-12-15 15:09:42 +0000311 [version, status, reason] = line.split(None, 2)
Greg Steindd6eefb2000-07-18 09:09:48 +0000312 except ValueError:
313 try:
Guido van Rossum34735a62000-12-15 15:09:42 +0000314 [version, status] = line.split(None, 1)
Greg Steindd6eefb2000-07-18 09:09:48 +0000315 reason = ""
316 except ValueError:
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000317 # empty version will cause next test to fail and status
318 # will be treated as 0.9 response.
319 version = ""
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000320 if not version.startswith("HTTP/"):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000321 if self.strict:
322 self.close()
323 raise BadStatusLine(line)
324 else:
Jeremy Hylton04319c72007-08-04 03:41:19 +0000325 # Assume it's a Simple-Response from an 0.9 server.
326 # We have to convert the first line back to raw bytes
327 # because self.fp.readline() needs to return bytes.
Guido van Rossum70d0dda2007-08-29 01:53:26 +0000328 self.fp = LineAndFileWrapper(bytes(line, "ascii"), self.fp)
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000329 return "HTTP/0.9", 200, ""
Greg Stein5e0fa402000-06-26 08:28:01 +0000330
Jeremy Hylton23d40472001-04-13 14:57:08 +0000331 # The status code is a three-digit number
332 try:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000333 status = int(status)
Jeremy Hylton23d40472001-04-13 14:57:08 +0000334 if status < 100 or status > 999:
335 raise BadStatusLine(line)
336 except ValueError:
337 raise BadStatusLine(line)
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000338 return version, status, reason
Greg Stein5e0fa402000-06-26 08:28:01 +0000339
Jeremy Hylton39c03802002-07-12 14:04:09 +0000340 def begin(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000341 if self.headers is not None:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000342 # we've already started reading the response
343 return
344
345 # read until we get a non-100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000346 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000347 version, status, reason = self._read_status()
Martin v. Löwis39a31782004-09-18 09:03:49 +0000348 if status != CONTINUE:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000349 break
350 # skip the header from the 100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000351 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000352 skip = self.fp.readline().strip()
353 if not skip:
354 break
355 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000356 print("header:", skip)
Tim Petersc411dba2002-07-16 21:35:23 +0000357
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000358 self.code = self.status = status
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000359 self.reason = reason.strip()
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000360 if version == "HTTP/1.0":
Greg Steindd6eefb2000-07-18 09:09:48 +0000361 self.version = 10
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000362 elif version.startswith("HTTP/1."):
Tim Peters07e99cb2001-01-14 23:47:14 +0000363 self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000364 elif version == "HTTP/0.9":
Jeremy Hylton110941a2000-10-12 19:58:36 +0000365 self.version = 9
Greg Steindd6eefb2000-07-18 09:09:48 +0000366 else:
367 raise UnknownProtocol(version)
Greg Stein5e0fa402000-06-26 08:28:01 +0000368
Jeremy Hylton110941a2000-10-12 19:58:36 +0000369 if self.version == 9:
Georg Brandl0aade9a2005-06-26 22:06:54 +0000370 self.length = None
Jeremy Hylton236156f2008-12-15 03:00:50 +0000371 self.chunked = False
372 self.will_close = True
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000373 self.headers = self.msg = email.message_from_string('')
Jeremy Hylton110941a2000-10-12 19:58:36 +0000374 return
375
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000376 self.headers = self.msg = parse_headers(self.fp)
Barry Warsaw820c1202008-06-12 04:06:45 +0000377
Jeremy Hylton30f86742000-09-18 22:50:38 +0000378 if self.debuglevel > 0:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000379 for hdr in self.headers:
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000380 print("header:", hdr, end=" ")
Greg Stein5e0fa402000-06-26 08:28:01 +0000381
Greg Steindd6eefb2000-07-18 09:09:48 +0000382 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000383 tr_enc = self.headers.get("transfer-encoding")
Jeremy Hyltond229b3a2002-09-03 19:24:24 +0000384 if tr_enc and tr_enc.lower() == "chunked":
Jeremy Hylton236156f2008-12-15 03:00:50 +0000385 self.chunked = True
Greg Steindd6eefb2000-07-18 09:09:48 +0000386 self.chunk_left = None
387 else:
Jeremy Hylton236156f2008-12-15 03:00:50 +0000388 self.chunked = False
Greg Stein5e0fa402000-06-26 08:28:01 +0000389
Greg Steindd6eefb2000-07-18 09:09:48 +0000390 # will the connection close at the end of the response?
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000391 self.will_close = self._check_close()
Greg Stein5e0fa402000-06-26 08:28:01 +0000392
Greg Steindd6eefb2000-07-18 09:09:48 +0000393 # do we have a Content-Length?
394 # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked"
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000395 self.length = None
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000396 length = self.headers.get("content-length")
Barry Warsaw820c1202008-06-12 04:06:45 +0000397
398 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000399 tr_enc = self.headers.get("transfer-encoding")
Greg Steindd6eefb2000-07-18 09:09:48 +0000400 if length and not self.chunked:
Jeremy Hylton30a81812000-09-14 20:34:27 +0000401 try:
402 self.length = int(length)
403 except ValueError:
Christian Heimesa612dc02008-02-24 13:08:18 +0000404 self.length = None
405 else:
406 if self.length < 0: # ignore nonsensical negative lengths
407 self.length = None
408 else:
409 self.length = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000410
Greg Steindd6eefb2000-07-18 09:09:48 +0000411 # does the body have a fixed length? (of zero)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000412 if (status == NO_CONTENT or status == NOT_MODIFIED or
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000413 100 <= status < 200 or # 1xx codes
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000414 self._method == "HEAD"):
Greg Steindd6eefb2000-07-18 09:09:48 +0000415 self.length = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000416
Greg Steindd6eefb2000-07-18 09:09:48 +0000417 # if the connection remains open, and we aren't using chunked, and
418 # a content-length was not provided, then assume that the connection
419 # WILL close.
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000420 if (not self.will_close and
421 not self.chunked and
422 self.length is None):
Jeremy Hylton236156f2008-12-15 03:00:50 +0000423 self.will_close = True
Greg Stein5e0fa402000-06-26 08:28:01 +0000424
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000425 def _check_close(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000426 conn = self.headers.get("connection")
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000427 if self.version == 11:
428 # An HTTP/1.1 proxy is assumed to stay open unless
429 # explicitly closed.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000430 conn = self.headers.get("connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000431 if conn and "close" in conn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000432 return True
433 return False
434
Jeremy Hylton2c178252004-08-07 16:28:14 +0000435 # Some HTTP/1.0 implementations have support for persistent
436 # connections, using rules different than HTTP/1.1.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000437
Christian Heimes895627f2007-12-08 17:28:33 +0000438 # For older HTTP, Keep-Alive indicates persistent connection.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000439 if self.headers.get("keep-alive"):
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000440 return False
Tim Peters77c06fb2002-11-24 02:35:35 +0000441
Jeremy Hylton2c178252004-08-07 16:28:14 +0000442 # At least Akamai returns a "Connection: Keep-Alive" header,
443 # which was supposed to be sent by the client.
444 if conn and "keep-alive" in conn.lower():
445 return False
446
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000447 # Proxy-Connection is a netscape hack.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000448 pconn = self.headers.get("proxy-connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000449 if pconn and "keep-alive" in pconn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000450 return False
451
452 # otherwise, assume it will close
453 return True
454
Greg Steindd6eefb2000-07-18 09:09:48 +0000455 def close(self):
456 if self.fp:
457 self.fp.close()
458 self.fp = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000459
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000460 # These implementations are for the benefit of io.BufferedReader.
461
462 # XXX This class should probably be revised to act more like
463 # the "raw stream" that BufferedReader expects.
464
465 @property
466 def closed(self):
467 return self.isclosed()
468
469 def flush(self):
470 self.fp.flush()
471
Jeremy Hyltona7cff022009-04-01 02:35:56 +0000472 def readable(self):
473 return True
474
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000475 # End of "raw stream" methods
476
Greg Steindd6eefb2000-07-18 09:09:48 +0000477 def isclosed(self):
478 # NOTE: it is possible that we will not ever call self.close(). This
479 # case occurs when will_close is TRUE, length is None, and we
480 # read up to the last byte, but NOT past it.
481 #
482 # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be
483 # called, meaning self.isclosed() is meaningful.
484 return self.fp is None
485
486 def read(self, amt=None):
487 if self.fp is None:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000488 return b""
Greg Steindd6eefb2000-07-18 09:09:48 +0000489
Senthil Kumaran26826382010-04-28 17:44:30 +0000490 if self._method == "HEAD":
491 return b""
492
Greg Steindd6eefb2000-07-18 09:09:48 +0000493 if self.chunked:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000494 return self._read_chunked(amt)
Tim Peters230a60c2002-11-09 05:08:07 +0000495
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000496 if amt is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000497 # unbounded read
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000498 if self.length is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000499 s = self.fp.read()
500 else:
501 s = self._safe_read(self.length)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000502 self.length = 0
Tim Peters07e99cb2001-01-14 23:47:14 +0000503 self.close() # we read everything
Greg Steindd6eefb2000-07-18 09:09:48 +0000504 return s
505
506 if self.length is not None:
507 if amt > self.length:
508 # clip the read to the "end of response"
509 amt = self.length
Greg Steindd6eefb2000-07-18 09:09:48 +0000510
511 # we do not use _safe_read() here because this may be a .will_close
512 # connection, and the user is reading more bytes than will be provided
513 # (for example, reading in 1k chunks)
514 s = self.fp.read(amt)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000515 if self.length is not None:
516 self.length -= len(s)
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000517 if not self.length:
518 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +0000519 return s
520
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000521 def _read_chunked(self, amt):
522 assert self.chunked != _UNKNOWN
523 chunk_left = self.chunk_left
Chris Withers5a86acb2009-09-04 17:15:46 +0000524 value = []
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000525 while True:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000526 if chunk_left is None:
527 line = self.fp.readline()
Georg Brandl95ba4692008-01-26 09:45:58 +0000528 i = line.find(b";")
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000529 if i >= 0:
530 line = line[:i] # strip chunk-extensions
Christian Heimesa612dc02008-02-24 13:08:18 +0000531 try:
532 chunk_left = int(line, 16)
533 except ValueError:
534 # close the connection as protocol synchronisation is
535 # probably lost
536 self.close()
Chris Withers5a86acb2009-09-04 17:15:46 +0000537 raise IncompleteRead(b''.join(value))
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000538 if chunk_left == 0:
539 break
540 if amt is None:
Chris Withers5a86acb2009-09-04 17:15:46 +0000541 value.append(self._safe_read(chunk_left))
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000542 elif amt < chunk_left:
Chris Withers5a86acb2009-09-04 17:15:46 +0000543 value.append(self._safe_read(amt))
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000544 self.chunk_left = chunk_left - amt
Chris Withers5a86acb2009-09-04 17:15:46 +0000545 return b''.join(value)
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000546 elif amt == chunk_left:
Chris Withers5a86acb2009-09-04 17:15:46 +0000547 value.append(self._safe_read(amt))
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000548 self._safe_read(2) # toss the CRLF at the end of the chunk
549 self.chunk_left = None
Chris Withers5a86acb2009-09-04 17:15:46 +0000550 return b''.join(value)
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000551 else:
Chris Withers5a86acb2009-09-04 17:15:46 +0000552 value.append(self._safe_read(chunk_left))
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000553 amt -= chunk_left
554
555 # we read the whole chunk, get another
556 self._safe_read(2) # toss the CRLF at the end of the chunk
557 chunk_left = None
558
559 # read and discard trailer up to the CRLF terminator
560 ### note: we shouldn't have any trailers!
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000561 while True:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000562 line = self.fp.readline()
Christian Heimes0bd4e112008-02-12 22:59:25 +0000563 if not line:
564 # a vanishingly small number of sites EOF without
565 # sending the trailer
566 break
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000567 if line == b"\r\n":
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000568 break
569
570 # we read everything; close the "file"
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000571 self.close()
572
Chris Withers5a86acb2009-09-04 17:15:46 +0000573 return b''.join(value)
Tim Peters230a60c2002-11-09 05:08:07 +0000574
Greg Steindd6eefb2000-07-18 09:09:48 +0000575 def _safe_read(self, amt):
576 """Read the number of bytes requested, compensating for partial reads.
577
578 Normally, we have a blocking socket, but a read() can be interrupted
579 by a signal (resulting in a partial read).
580
581 Note that we cannot distinguish between EOF and an interrupt when zero
582 bytes have been read. IncompleteRead() will be raised in this
583 situation.
584
585 This function should be used when <amt> bytes "should" be present for
586 reading. If the bytes are truly not available (due to EOF), then the
587 IncompleteRead exception can be used to detect the problem.
588 """
Georg Brandl80ba8e82005-09-29 20:16:07 +0000589 s = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000590 while amt > 0:
Georg Brandl80ba8e82005-09-29 20:16:07 +0000591 chunk = self.fp.read(min(amt, MAXAMOUNT))
Greg Steindd6eefb2000-07-18 09:09:48 +0000592 if not chunk:
Benjamin Peterson6accb982009-03-02 22:50:25 +0000593 raise IncompleteRead(b''.join(s), amt)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000594 s.append(chunk)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000595 amt -= len(chunk)
Guido van Rossuma00f1232007-09-12 19:43:09 +0000596 return b"".join(s)
Greg Steindd6eefb2000-07-18 09:09:48 +0000597
Antoine Pitroub353c122009-02-11 00:39:14 +0000598 def fileno(self):
599 return self.fp.fileno()
600
Greg Steindd6eefb2000-07-18 09:09:48 +0000601 def getheader(self, name, default=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000602 if self.headers is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000603 raise ResponseNotReady()
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000604 return ', '.join(self.headers.get_all(name, default))
Greg Stein5e0fa402000-06-26 08:28:01 +0000605
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000606 def getheaders(self):
607 """Return list of (header, value) tuples."""
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000608 if self.headers is None:
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000609 raise ResponseNotReady()
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000610 return list(self.headers.items())
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000611
Antoine Pitroub353c122009-02-11 00:39:14 +0000612 # We override IOBase.__iter__ so that it doesn't check for closed-ness
613
614 def __iter__(self):
615 return self
616
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000617 # For compatibility with old-style urllib responses.
618
619 def info(self):
620 return self.headers
621
622 def geturl(self):
623 return self.url
624
625 def getcode(self):
626 return self.status
Greg Stein5e0fa402000-06-26 08:28:01 +0000627
628class HTTPConnection:
629
Greg Steindd6eefb2000-07-18 09:09:48 +0000630 _http_vsn = 11
631 _http_vsn_str = 'HTTP/1.1'
Greg Stein5e0fa402000-06-26 08:28:01 +0000632
Greg Steindd6eefb2000-07-18 09:09:48 +0000633 response_class = HTTPResponse
634 default_port = HTTP_PORT
635 auto_open = 1
Jeremy Hylton30f86742000-09-18 22:50:38 +0000636 debuglevel = 0
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000637 strict = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000638
Georg Brandlf78e02b2008-06-10 17:40:04 +0000639 def __init__(self, host, port=None, strict=None,
640 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000641 self.timeout = timeout
Greg Steindd6eefb2000-07-18 09:09:48 +0000642 self.sock = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000643 self._buffer = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000644 self.__response = None
645 self.__state = _CS_IDLE
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000646 self._method = None
Senthil Kumaran0ac1f832009-07-26 12:39:47 +0000647 self._tunnel_host = None
648 self._tunnel_port = None
Tim Petersc411dba2002-07-16 21:35:23 +0000649
Greg Steindd6eefb2000-07-18 09:09:48 +0000650 self._set_hostport(host, port)
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000651 if strict is not None:
652 self.strict = strict
Greg Stein5e0fa402000-06-26 08:28:01 +0000653
Senthil Kumaran4b9fbeb2009-12-20 07:18:22 +0000654 def _set_tunnel(self, host, port=None, headers=None):
Senthil Kumaran0ac1f832009-07-26 12:39:47 +0000655 self._tunnel_host = host
656 self._tunnel_port = port
Senthil Kumaran4b9fbeb2009-12-20 07:18:22 +0000657 if headers:
658 self._tunnel_headers = headers
659 else:
660 self._tunnel_headers.clear()
Senthil Kumaran0ac1f832009-07-26 12:39:47 +0000661
Greg Steindd6eefb2000-07-18 09:09:48 +0000662 def _set_hostport(self, host, port):
663 if port is None:
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000664 i = host.rfind(':')
Skip Montanarocae14d22004-09-14 17:55:21 +0000665 j = host.rfind(']') # ipv6 addresses have [...]
666 if i > j:
Skip Montanaro9d389972002-03-24 16:53:50 +0000667 try:
668 port = int(host[i+1:])
669 except ValueError:
Jeremy Hyltonfbd79942002-07-02 20:19:08 +0000670 raise InvalidURL("nonnumeric port: '%s'" % host[i+1:])
Greg Steindd6eefb2000-07-18 09:09:48 +0000671 host = host[:i]
672 else:
673 port = self.default_port
Raymond Hettinger4d037912004-10-14 15:23:38 +0000674 if host and host[0] == '[' and host[-1] == ']':
Brett Cannon0a1af4a2004-09-15 23:26:23 +0000675 host = host[1:-1]
Greg Steindd6eefb2000-07-18 09:09:48 +0000676 self.host = host
677 self.port = port
Greg Stein5e0fa402000-06-26 08:28:01 +0000678
Jeremy Hylton30f86742000-09-18 22:50:38 +0000679 def set_debuglevel(self, level):
680 self.debuglevel = level
681
Senthil Kumaran0ac1f832009-07-26 12:39:47 +0000682 def _tunnel(self):
683 self._set_hostport(self._tunnel_host, self._tunnel_port)
Senthil Kumaran4b9fbeb2009-12-20 07:18:22 +0000684 connect_str = "CONNECT %s:%d HTTP/1.0\r\n" %(self.host, self.port)
Senthil Kumaran0ac1f832009-07-26 12:39:47 +0000685 connect_bytes = connect_str.encode("ascii")
686 self.send(connect_bytes)
Senthil Kumaran4b9fbeb2009-12-20 07:18:22 +0000687 for header, value in self._tunnel_headers.iteritems():
688 header_str = "%s: %s\r\n" % (header, value)
689 header_bytes = header_str.encode("ascii")
690 self.send(header_bytes)
691
Senthil Kumaran0ac1f832009-07-26 12:39:47 +0000692 response = self.response_class(self.sock, strict = self.strict,
Senthil Kumaran4b9fbeb2009-12-20 07:18:22 +0000693 method = self._method)
Senthil Kumaran0ac1f832009-07-26 12:39:47 +0000694 (version, code, message) = response._read_status()
Senthil Kumaran4b9fbeb2009-12-20 07:18:22 +0000695
Senthil Kumaran0ac1f832009-07-26 12:39:47 +0000696 if code != 200:
697 self.close()
698 raise socket.error("Tunnel connection failed: %d %s" % (code,
699 message.strip()))
700 while True:
701 line = response.fp.readline()
702 if line == b'\r\n':
703 break
704
Greg Steindd6eefb2000-07-18 09:09:48 +0000705 def connect(self):
706 """Connect to the host and port specified in __init__."""
Guido van Rossumd8faa362007-04-27 19:54:29 +0000707 self.sock = socket.create_connection((self.host,self.port),
708 self.timeout)
Senthil Kumaran0ac1f832009-07-26 12:39:47 +0000709 if self._tunnel_host:
710 self._tunnel()
Greg Stein5e0fa402000-06-26 08:28:01 +0000711
Greg Steindd6eefb2000-07-18 09:09:48 +0000712 def close(self):
713 """Close the connection to the HTTP server."""
714 if self.sock:
Tim Peters07e99cb2001-01-14 23:47:14 +0000715 self.sock.close() # close it manually... there may be other refs
Greg Steindd6eefb2000-07-18 09:09:48 +0000716 self.sock = None
717 if self.__response:
718 self.__response.close()
719 self.__response = None
720 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000721
Greg Steindd6eefb2000-07-18 09:09:48 +0000722 def send(self, str):
723 """Send `str' to the server."""
724 if self.sock is None:
725 if self.auto_open:
726 self.connect()
727 else:
728 raise NotConnected()
Greg Stein5e0fa402000-06-26 08:28:01 +0000729
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000730 # send the data to the server. if we get a broken pipe, then close
Greg Steindd6eefb2000-07-18 09:09:48 +0000731 # the socket. we want to reconnect when somebody tries to send again.
732 #
733 # NOTE: we DO propagate the error, though, because we cannot simply
734 # ignore the error... the caller will know if they can retry.
Jeremy Hylton30f86742000-09-18 22:50:38 +0000735 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000736 print("send:", repr(str))
Jeremy Hylton636950f2009-03-28 04:34:21 +0000737 blocksize = 8192
738 if hasattr(str, "read") :
739 if self.debuglevel > 0:
740 print("sendIng a read()able")
741 encode = False
Antoine Pitrou595ad322009-09-29 19:02:24 +0000742 try:
743 mode = str.mode
744 except AttributeError:
745 # io.BytesIO and other file-like objects don't have a `mode`
746 # attribute.
747 pass
748 else:
749 if "b" not in mode:
750 encode = True
751 if self.debuglevel > 0:
752 print("encoding file using iso-8859-1")
Jeremy Hylton636950f2009-03-28 04:34:21 +0000753 while 1:
754 data = str.read(blocksize)
755 if not data:
756 break
757 if encode:
758 data = data.encode("iso-8859-1")
759 self.sock.sendall(data)
760 else:
761 self.sock.sendall(str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000762
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000763 def _output(self, s):
764 """Add a line of output to the current request buffer.
Tim Peters469cdad2002-08-08 20:19:19 +0000765
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000766 Assumes that the line does *not* end with \\r\\n.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000767 """
768 self._buffer.append(s)
769
Benjamin Peterson1742e402008-11-30 22:15:29 +0000770 def _send_output(self, message_body=None):
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000771 """Send the currently buffered request and clear the buffer.
772
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000773 Appends an extra \\r\\n to the buffer.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000774 A message_body may be specified, to be appended to the request.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000775 """
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000776 self._buffer.extend((b"", b""))
777 msg = b"\r\n".join(self._buffer)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000778 del self._buffer[:]
Benjamin Peterson1742e402008-11-30 22:15:29 +0000779 # If msg and message_body are sent in a single send() call,
780 # it will avoid performance problems caused by the interaction
781 # between delayed ack and the Nagle algorithim.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000782 if isinstance(message_body, bytes):
Benjamin Peterson1742e402008-11-30 22:15:29 +0000783 msg += message_body
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000784 message_body = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000785 self.send(msg)
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000786 if message_body is not None:
Jeremy Hylton236654b2009-03-27 20:24:34 +0000787 # message_body was not a string (i.e. it is a file), and
788 # we must run the risk of Nagle.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000789 self.send(message_body)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000790
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000791 def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0):
Greg Steindd6eefb2000-07-18 09:09:48 +0000792 """Send a request to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000793
Greg Steindd6eefb2000-07-18 09:09:48 +0000794 `method' specifies an HTTP request method, e.g. 'GET'.
795 `url' specifies the object being requested, e.g. '/index.html'.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000796 `skip_host' if True does not add automatically a 'Host:' header
797 `skip_accept_encoding' if True does not add automatically an
798 'Accept-Encoding:' header
Greg Steindd6eefb2000-07-18 09:09:48 +0000799 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000800
Greg Stein616a58d2003-06-24 06:35:19 +0000801 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000802 if self.__response and self.__response.isclosed():
803 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000804
Tim Peters58eb11c2004-01-18 20:29:55 +0000805
Greg Steindd6eefb2000-07-18 09:09:48 +0000806 # in certain cases, we cannot issue another request on this connection.
807 # this occurs when:
808 # 1) we are in the process of sending a request. (_CS_REQ_STARTED)
809 # 2) a response to a previous request has signalled that it is going
810 # to close the connection upon completion.
811 # 3) the headers for the previous response have not been read, thus
812 # we cannot determine whether point (2) is true. (_CS_REQ_SENT)
813 #
814 # if there is no prior response, then we can request at will.
815 #
816 # if point (2) is true, then we will have passed the socket to the
817 # response (effectively meaning, "there is no prior response"), and
818 # will open a new one when a new request is made.
819 #
820 # Note: if a prior response exists, then we *can* start a new request.
821 # We are not allowed to begin fetching the response to this new
822 # request, however, until that prior response is complete.
823 #
824 if self.__state == _CS_IDLE:
825 self.__state = _CS_REQ_STARTED
826 else:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000827 raise CannotSendRequest(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +0000828
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000829 # Save the method we use, we need it later in the response phase
830 self._method = method
Greg Steindd6eefb2000-07-18 09:09:48 +0000831 if not url:
832 url = '/'
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000833 request = '%s %s %s' % (method, url, self._http_vsn_str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000834
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000835 # Non-ASCII characters should have been eliminated earlier
836 self._output(request.encode('ascii'))
Greg Stein5e0fa402000-06-26 08:28:01 +0000837
Greg Steindd6eefb2000-07-18 09:09:48 +0000838 if self._http_vsn == 11:
839 # Issue some standard headers for better HTTP/1.1 compliance
Greg Stein5e0fa402000-06-26 08:28:01 +0000840
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000841 if not skip_host:
842 # this header is issued *only* for HTTP/1.1
843 # connections. more specifically, this means it is
844 # only issued when the client uses the new
845 # HTTPConnection() class. backwards-compat clients
846 # will be using HTTP/1.0 and those clients may be
847 # issuing this header themselves. we should NOT issue
848 # it twice; some web servers (such as Apache) barf
849 # when they see two Host: headers
Guido van Rossumf6922aa2001-01-14 21:03:01 +0000850
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000851 # If we need a non-standard port,include it in the
852 # header. If the request is going through a proxy,
853 # but the host of the actual URL, not the host of the
854 # proxy.
Jeremy Hylton8acf1e02002-03-08 19:35:51 +0000855
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000856 netloc = ''
857 if url.startswith('http'):
858 nil, netloc, nil, nil, nil = urlsplit(url)
859
860 if netloc:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000861 try:
862 netloc_enc = netloc.encode("ascii")
863 except UnicodeEncodeError:
864 netloc_enc = netloc.encode("idna")
865 self.putheader('Host', netloc_enc)
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000866 else:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000867 try:
868 host_enc = self.host.encode("ascii")
869 except UnicodeEncodeError:
870 host_enc = self.host.encode("idna")
Georg Brandl86b2fb92008-07-16 03:43:04 +0000871 if self.port == self.default_port:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000872 self.putheader('Host', host_enc)
873 else:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000874 host_enc = host_enc.decode("ascii")
Thomas Wouters477c8d52006-05-27 19:21:47 +0000875 self.putheader('Host', "%s:%s" % (host_enc, self.port))
Greg Stein5e0fa402000-06-26 08:28:01 +0000876
Greg Steindd6eefb2000-07-18 09:09:48 +0000877 # note: we are assuming that clients will not attempt to set these
878 # headers since *this* library must deal with the
879 # consequences. this also means that when the supporting
880 # libraries are updated to recognize other forms, then this
881 # code should be changed (removed or updated).
Greg Stein5e0fa402000-06-26 08:28:01 +0000882
Greg Steindd6eefb2000-07-18 09:09:48 +0000883 # we only want a Content-Encoding of "identity" since we don't
884 # support encodings such as x-gzip or x-deflate.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000885 if not skip_accept_encoding:
886 self.putheader('Accept-Encoding', 'identity')
Greg Stein5e0fa402000-06-26 08:28:01 +0000887
Greg Steindd6eefb2000-07-18 09:09:48 +0000888 # we can accept "chunked" Transfer-Encodings, but no others
889 # NOTE: no TE header implies *only* "chunked"
890 #self.putheader('TE', 'chunked')
Greg Stein5e0fa402000-06-26 08:28:01 +0000891
Greg Steindd6eefb2000-07-18 09:09:48 +0000892 # if TE is supplied in the header, then it must appear in a
893 # Connection header.
894 #self.putheader('Connection', 'TE')
Greg Stein5e0fa402000-06-26 08:28:01 +0000895
Greg Steindd6eefb2000-07-18 09:09:48 +0000896 else:
897 # For HTTP/1.0, the server will assume "not chunked"
898 pass
Greg Stein5e0fa402000-06-26 08:28:01 +0000899
Benjamin Petersonf608c612008-11-16 18:33:53 +0000900 def putheader(self, header, *values):
Greg Steindd6eefb2000-07-18 09:09:48 +0000901 """Send a request header line to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000902
Greg Steindd6eefb2000-07-18 09:09:48 +0000903 For example: h.putheader('Accept', 'text/html')
904 """
905 if self.__state != _CS_REQ_STARTED:
906 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +0000907
Guido van Rossum98297ee2007-11-06 21:34:58 +0000908 if hasattr(header, 'encode'):
909 header = header.encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +0000910 values = list(values)
911 for i, one_value in enumerate(values):
912 if hasattr(one_value, 'encode'):
913 values[i] = one_value.encode('ascii')
914 value = b'\r\n\t'.join(values)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000915 header = header + b': ' + value
916 self._output(header)
Greg Stein5e0fa402000-06-26 08:28:01 +0000917
Benjamin Peterson1742e402008-11-30 22:15:29 +0000918 def endheaders(self, message_body=None):
919 """Indicate that the last header line has been sent to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000920
Benjamin Peterson1742e402008-11-30 22:15:29 +0000921 This method sends the request to the server. The optional
922 message_body argument can be used to pass message body
923 associated with the request. The message body will be sent in
924 the same packet as the message headers if possible. The
925 message_body should be a string.
926 """
Greg Steindd6eefb2000-07-18 09:09:48 +0000927 if self.__state == _CS_REQ_STARTED:
928 self.__state = _CS_REQ_SENT
929 else:
930 raise CannotSendHeader()
Benjamin Peterson1742e402008-11-30 22:15:29 +0000931 self._send_output(message_body)
Greg Stein5e0fa402000-06-26 08:28:01 +0000932
Greg Steindd6eefb2000-07-18 09:09:48 +0000933 def request(self, method, url, body=None, headers={}):
934 """Send a complete request to the server."""
Jeremy Hylton636950f2009-03-28 04:34:21 +0000935 self._send_request(method, url, body, headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000936
Benjamin Peterson1742e402008-11-30 22:15:29 +0000937 def _set_content_length(self, body):
938 # Set the content-length based on the body.
939 thelen = None
940 try:
941 thelen = str(len(body))
942 except TypeError as te:
943 # If this is a file-like object, try to
944 # fstat its file descriptor
Benjamin Peterson1742e402008-11-30 22:15:29 +0000945 try:
946 thelen = str(os.fstat(body.fileno()).st_size)
947 except (AttributeError, OSError):
948 # Don't send a length if this failed
949 if self.debuglevel > 0: print("Cannot stat!!")
950
951 if thelen is not None:
952 self.putheader('Content-Length', thelen)
953
Greg Steindd6eefb2000-07-18 09:09:48 +0000954 def _send_request(self, method, url, body, headers):
Jeremy Hylton636950f2009-03-28 04:34:21 +0000955 # Honor explicitly requested Host: and Accept-Encoding: headers.
Jeremy Hylton2c178252004-08-07 16:28:14 +0000956 header_names = dict.fromkeys([k.lower() for k in headers])
957 skips = {}
958 if 'host' in header_names:
959 skips['skip_host'] = 1
960 if 'accept-encoding' in header_names:
961 skips['skip_accept_encoding'] = 1
Greg Stein5e0fa402000-06-26 08:28:01 +0000962
Jeremy Hylton2c178252004-08-07 16:28:14 +0000963 self.putrequest(method, url, **skips)
964
965 if body and ('content-length' not in header_names):
Benjamin Peterson1742e402008-11-30 22:15:29 +0000966 self._set_content_length(body)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000967 for hdr, value in headers.items():
Greg Steindd6eefb2000-07-18 09:09:48 +0000968 self.putheader(hdr, value)
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +0000969 if isinstance(body, str):
Jeremy Hylton236654b2009-03-27 20:24:34 +0000970 # RFC 2616 Section 3.7.1 says that text default has a
971 # default charset of iso-8859-1.
972 body = body.encode('iso-8859-1')
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +0000973 self.endheaders(body)
Greg Stein5e0fa402000-06-26 08:28:01 +0000974
Greg Steindd6eefb2000-07-18 09:09:48 +0000975 def getresponse(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000976 """Get the response from the server.
977
978 If the HTTPConnection is in the correct state, returns an
979 instance of HTTPResponse or of whatever object is returned by
980 class the response_class variable.
981
982 If a request has not been sent or if a previous response has
983 not be handled, ResponseNotReady is raised. If the HTTP
984 response indicates that the connection should be closed, then
985 it will be closed before the response is returned. When the
986 connection is closed, the underlying socket is closed.
987 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000988
Greg Stein616a58d2003-06-24 06:35:19 +0000989 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000990 if self.__response and self.__response.isclosed():
991 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000992
Greg Steindd6eefb2000-07-18 09:09:48 +0000993 # if a prior response exists, then it must be completed (otherwise, we
994 # cannot read this response's header to determine the connection-close
995 # behavior)
996 #
997 # note: if a prior response existed, but was connection-close, then the
998 # socket and response were made independent of this HTTPConnection
999 # object since a new request requires that we open a whole new
1000 # connection
1001 #
1002 # this means the prior response had one of two states:
1003 # 1) will_close: this connection was reset and the prior socket and
1004 # response operate independently
1005 # 2) persistent: the response was retained and we await its
1006 # isclosed() status to become true.
1007 #
1008 if self.__state != _CS_REQ_SENT or self.__response:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001009 raise ResponseNotReady(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +00001010
Jeremy Hylton30f86742000-09-18 22:50:38 +00001011 if self.debuglevel > 0:
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001012 response = self.response_class(self.sock, self.debuglevel,
Tim Petersc2659cf2003-05-12 20:19:37 +00001013 strict=self.strict,
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +00001014 method=self._method)
Jeremy Hylton30f86742000-09-18 22:50:38 +00001015 else:
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +00001016 response = self.response_class(self.sock, strict=self.strict,
1017 method=self._method)
Greg Stein5e0fa402000-06-26 08:28:01 +00001018
Jeremy Hylton39c03802002-07-12 14:04:09 +00001019 response.begin()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +00001020 assert response.will_close != _UNKNOWN
Greg Steindd6eefb2000-07-18 09:09:48 +00001021 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +00001022
Greg Steindd6eefb2000-07-18 09:09:48 +00001023 if response.will_close:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001024 # this effectively passes the connection to the response
1025 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +00001026 else:
1027 # remember this, so we can tell when it is complete
1028 self.__response = response
Greg Stein5e0fa402000-06-26 08:28:01 +00001029
Greg Steindd6eefb2000-07-18 09:09:48 +00001030 return response
Greg Stein5e0fa402000-06-26 08:28:01 +00001031
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001032try:
1033 import ssl
1034except ImportError:
1035 pass
1036else:
1037 class HTTPSConnection(HTTPConnection):
1038 "This class allows communication via SSL."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001039
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001040 default_port = HTTPS_PORT
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001041
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001042 def __init__(self, host, port=None, key_file=None, cert_file=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +00001043 strict=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001044 HTTPConnection.__init__(self, host, port, strict, timeout)
1045 self.key_file = key_file
1046 self.cert_file = cert_file
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001047
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001048 def connect(self):
1049 "Connect to a host on a given (SSL) port."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001050
Jeremy Hylton636950f2009-03-28 04:34:21 +00001051 sock = socket.create_connection((self.host, self.port),
1052 self.timeout)
Senthil Kumaran0ac1f832009-07-26 12:39:47 +00001053
1054 if self._tunnel_host:
1055 self.sock = sock
1056 self._tunnel()
1057
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001058 self.sock = ssl.wrap_socket(sock, self.key_file, self.cert_file)
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001059
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001060
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001061 def FakeSocket (sock, sslobj):
Thomas Wouters89d996e2007-09-08 17:39:28 +00001062 warnings.warn("FakeSocket is deprecated, and won't be in 3.x. " +
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001063 "Use the result of ssl.wrap_socket() directly instead.",
Thomas Wouters89d996e2007-09-08 17:39:28 +00001064 DeprecationWarning, stacklevel=2)
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001065 return sslobj
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001066
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001067 __all__.append("HTTPSConnection")
Greg Stein5e0fa402000-06-26 08:28:01 +00001068
Greg Stein5e0fa402000-06-26 08:28:01 +00001069class HTTPException(Exception):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001070 # Subclasses that define an __init__ must call Exception.__init__
1071 # or define self.args. Otherwise, str() will fail.
Greg Steindd6eefb2000-07-18 09:09:48 +00001072 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001073
1074class NotConnected(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001075 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001076
Skip Montanaro9d389972002-03-24 16:53:50 +00001077class InvalidURL(HTTPException):
1078 pass
1079
Greg Stein5e0fa402000-06-26 08:28:01 +00001080class UnknownProtocol(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001081 def __init__(self, version):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001082 self.args = version,
Greg Steindd6eefb2000-07-18 09:09:48 +00001083 self.version = version
Greg Stein5e0fa402000-06-26 08:28:01 +00001084
1085class UnknownTransferEncoding(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001086 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001087
Greg Stein5e0fa402000-06-26 08:28:01 +00001088class UnimplementedFileMode(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001089 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001090
1091class IncompleteRead(HTTPException):
Benjamin Peterson6accb982009-03-02 22:50:25 +00001092 def __init__(self, partial, expected=None):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001093 self.args = partial,
Greg Steindd6eefb2000-07-18 09:09:48 +00001094 self.partial = partial
Benjamin Peterson6accb982009-03-02 22:50:25 +00001095 self.expected = expected
1096 def __repr__(self):
1097 if self.expected is not None:
1098 e = ', %i more expected' % self.expected
1099 else:
1100 e = ''
1101 return 'IncompleteRead(%i bytes read%s)' % (len(self.partial), e)
1102 def __str__(self):
1103 return repr(self)
Greg Stein5e0fa402000-06-26 08:28:01 +00001104
1105class ImproperConnectionState(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001106 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001107
1108class CannotSendRequest(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001109 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001110
1111class CannotSendHeader(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001112 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001113
1114class ResponseNotReady(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001115 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001116
1117class BadStatusLine(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001118 def __init__(self, line):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001119 self.args = line,
Greg Steindd6eefb2000-07-18 09:09:48 +00001120 self.line = line
Greg Stein5e0fa402000-06-26 08:28:01 +00001121
1122# for backwards compatibility
1123error = HTTPException
1124
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001125class LineAndFileWrapper:
1126 """A limited file-like object for HTTP/0.9 responses."""
1127
1128 # The status-line parsing code calls readline(), which normally
1129 # get the HTTP status line. For a 0.9 response, however, this is
1130 # actually the first line of the body! Clients need to get a
1131 # readable file object that contains that line.
1132
1133 def __init__(self, line, file):
1134 self._line = line
1135 self._file = file
1136 self._line_consumed = 0
1137 self._line_offset = 0
1138 self._line_left = len(line)
1139
1140 def __getattr__(self, attr):
1141 return getattr(self._file, attr)
1142
1143 def _done(self):
1144 # called when the last byte is read from the line. After the
1145 # call, all read methods are delegated to the underlying file
Skip Montanaro74b9a7a2003-02-25 17:48:15 +00001146 # object.
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001147 self._line_consumed = 1
1148 self.read = self._file.read
1149 self.readline = self._file.readline
1150 self.readlines = self._file.readlines
1151
1152 def read(self, amt=None):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001153 if self._line_consumed:
1154 return self._file.read(amt)
1155 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001156 if amt is None or amt > self._line_left:
1157 s = self._line[self._line_offset:]
1158 self._done()
1159 if amt is None:
1160 return s + self._file.read()
1161 else:
Tim Petersc411dba2002-07-16 21:35:23 +00001162 return s + self._file.read(amt - len(s))
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001163 else:
1164 assert amt <= self._line_left
1165 i = self._line_offset
1166 j = i + amt
1167 s = self._line[i:j]
1168 self._line_offset = j
1169 self._line_left -= amt
1170 if self._line_left == 0:
1171 self._done()
1172 return s
Tim Petersc411dba2002-07-16 21:35:23 +00001173
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001174 def readline(self):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001175 if self._line_consumed:
1176 return self._file.readline()
1177 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001178 s = self._line[self._line_offset:]
1179 self._done()
1180 return s
1181
1182 def readlines(self, size=None):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001183 if self._line_consumed:
1184 return self._file.readlines(size)
1185 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001186 L = [self._line[self._line_offset:]]
1187 self._done()
1188 if size is None:
1189 return L + self._file.readlines()
1190 else:
1191 return L + self._file.readlines(size)