blob: 0ea15ab0c5de07008ab306a1d94404501cdfb0e5 [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
Jeremy Hyltonfb35f652007-08-03 20:30:33 +000069import io
Jeremy Hylton6459c8d2001-10-11 17:47:22 +000070import socket
Barry Warsaw820c1202008-06-12 04:06:45 +000071import email.parser
72import email.message
Jeremy Hylton1afc1692008-06-18 20:49:58 +000073from urllib.parse import urlsplit
Thomas Wouters89d996e2007-09-08 17:39:28 +000074import warnings
Guido van Rossum23acc951994-02-21 16:36:04 +000075
Thomas Wouters47b49bf2007-08-30 22:15:33 +000076__all__ = ["HTTPResponse", "HTTPConnection",
Skip Montanaro951a8842001-06-01 16:25:38 +000077 "HTTPException", "NotConnected", "UnknownProtocol",
Jeremy Hylton7c75c992002-06-28 23:38:14 +000078 "UnknownTransferEncoding", "UnimplementedFileMode",
79 "IncompleteRead", "InvalidURL", "ImproperConnectionState",
80 "CannotSendRequest", "CannotSendHeader", "ResponseNotReady",
Georg Brandl6aab16e2006-02-17 19:17:25 +000081 "BadStatusLine", "error", "responses"]
Skip Montanaro2dd42762001-01-23 15:35:05 +000082
Guido van Rossum23acc951994-02-21 16:36:04 +000083HTTP_PORT = 80
Guido van Rossum09c8b6c1999-12-07 21:37:17 +000084HTTPS_PORT = 443
85
Greg Stein5e0fa402000-06-26 08:28:01 +000086_UNKNOWN = 'UNKNOWN'
87
88# connection states
89_CS_IDLE = 'Idle'
90_CS_REQ_STARTED = 'Request-started'
91_CS_REQ_SENT = 'Request-sent'
92
Martin v. Löwis39a31782004-09-18 09:03:49 +000093# status codes
94# informational
95CONTINUE = 100
96SWITCHING_PROTOCOLS = 101
97PROCESSING = 102
98
99# successful
100OK = 200
101CREATED = 201
102ACCEPTED = 202
103NON_AUTHORITATIVE_INFORMATION = 203
104NO_CONTENT = 204
105RESET_CONTENT = 205
106PARTIAL_CONTENT = 206
107MULTI_STATUS = 207
108IM_USED = 226
109
110# redirection
111MULTIPLE_CHOICES = 300
112MOVED_PERMANENTLY = 301
113FOUND = 302
114SEE_OTHER = 303
115NOT_MODIFIED = 304
116USE_PROXY = 305
117TEMPORARY_REDIRECT = 307
118
119# client error
120BAD_REQUEST = 400
121UNAUTHORIZED = 401
122PAYMENT_REQUIRED = 402
123FORBIDDEN = 403
124NOT_FOUND = 404
125METHOD_NOT_ALLOWED = 405
126NOT_ACCEPTABLE = 406
127PROXY_AUTHENTICATION_REQUIRED = 407
128REQUEST_TIMEOUT = 408
129CONFLICT = 409
130GONE = 410
131LENGTH_REQUIRED = 411
132PRECONDITION_FAILED = 412
133REQUEST_ENTITY_TOO_LARGE = 413
134REQUEST_URI_TOO_LONG = 414
135UNSUPPORTED_MEDIA_TYPE = 415
136REQUESTED_RANGE_NOT_SATISFIABLE = 416
137EXPECTATION_FAILED = 417
138UNPROCESSABLE_ENTITY = 422
139LOCKED = 423
140FAILED_DEPENDENCY = 424
141UPGRADE_REQUIRED = 426
142
143# server error
144INTERNAL_SERVER_ERROR = 500
145NOT_IMPLEMENTED = 501
146BAD_GATEWAY = 502
147SERVICE_UNAVAILABLE = 503
148GATEWAY_TIMEOUT = 504
149HTTP_VERSION_NOT_SUPPORTED = 505
150INSUFFICIENT_STORAGE = 507
151NOT_EXTENDED = 510
152
Georg Brandl6aab16e2006-02-17 19:17:25 +0000153# Mapping status codes to official W3C names
154responses = {
155 100: 'Continue',
156 101: 'Switching Protocols',
157
158 200: 'OK',
159 201: 'Created',
160 202: 'Accepted',
161 203: 'Non-Authoritative Information',
162 204: 'No Content',
163 205: 'Reset Content',
164 206: 'Partial Content',
165
166 300: 'Multiple Choices',
167 301: 'Moved Permanently',
168 302: 'Found',
169 303: 'See Other',
170 304: 'Not Modified',
171 305: 'Use Proxy',
172 306: '(Unused)',
173 307: 'Temporary Redirect',
174
175 400: 'Bad Request',
176 401: 'Unauthorized',
177 402: 'Payment Required',
178 403: 'Forbidden',
179 404: 'Not Found',
180 405: 'Method Not Allowed',
181 406: 'Not Acceptable',
182 407: 'Proxy Authentication Required',
183 408: 'Request Timeout',
184 409: 'Conflict',
185 410: 'Gone',
186 411: 'Length Required',
187 412: 'Precondition Failed',
188 413: 'Request Entity Too Large',
189 414: 'Request-URI Too Long',
190 415: 'Unsupported Media Type',
191 416: 'Requested Range Not Satisfiable',
192 417: 'Expectation Failed',
193
194 500: 'Internal Server Error',
195 501: 'Not Implemented',
196 502: 'Bad Gateway',
197 503: 'Service Unavailable',
198 504: 'Gateway Timeout',
199 505: 'HTTP Version Not Supported',
200}
201
Georg Brandl80ba8e82005-09-29 20:16:07 +0000202# maximal amount of data to read at one time in _safe_read
203MAXAMOUNT = 1048576
204
Barry Warsaw820c1202008-06-12 04:06:45 +0000205class HTTPMessage(email.message.Message):
206 def getallmatchingheaders(self, name):
207 """Find all header lines matching a given header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000208
Barry Warsaw820c1202008-06-12 04:06:45 +0000209 Look through the list of headers and find all lines matching a given
210 header name (and their continuation lines). A list of the lines is
211 returned, without interpretation. If the header does not occur, an
212 empty list is returned. If the header occurs multiple times, all
213 occurrences are returned. Case is not important in the header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000214
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000215 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000216 name = name.lower() + ':'
217 n = len(name)
218 lst = []
219 hit = 0
220 for line in self.keys():
221 if line[:n].lower() == name:
222 hit = 1
223 elif not line[:1].isspace():
224 hit = 0
225 if hit:
226 lst.append(line)
227 return lst
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000228
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000229def parse_headers(fp, _class=HTTPMessage):
Barry Warsaw820c1202008-06-12 04:06:45 +0000230 """Parses only RFC2822 headers from a file pointer.
231
232 email Parser wants to see strings rather than bytes.
233 But a TextIOWrapper around self.rfile would buffer too many bytes
234 from the stream, bytes which we later need to read as bytes.
235 So we read the correct bytes here, as bytes, for email Parser
236 to parse.
237
238 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000239 headers = []
240 while True:
241 line = fp.readline()
242 headers.append(line)
243 if line in (b'\r\n', b'\n', b''):
244 break
245 hstring = b''.join(headers).decode('iso-8859-1')
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000246 return email.parser.Parser(_class=_class).parsestr(hstring)
Greg Stein5e0fa402000-06-26 08:28:01 +0000247
Antoine Pitroub353c122009-02-11 00:39:14 +0000248class HTTPResponse(io.RawIOBase):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000249
250 # strict: If true, raise BadStatusLine if the status line can't be
251 # parsed as a valid HTTP/1.0 or 1.1 status line. By default it is
Skip Montanaro186bec22002-07-25 16:10:38 +0000252 # false because it prevents clients from talking to HTTP/0.9
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000253 # servers. Note that a response with a sufficiently corrupted
254 # status line will look like an HTTP/0.9 response.
255
256 # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details.
257
Jeremy Hylton811fc142007-08-03 13:30:02 +0000258 # The bytes from the socket object are iso-8859-1 strings.
259 # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded
260 # text following RFC 2047. The basic status line parsing only
261 # accepts iso-8859-1.
262
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000263 def __init__(self, sock, debuglevel=0, strict=0, method=None):
Kristján Valur Jónsson7e11b3f2009-02-02 16:04:04 +0000264 # If the response includes a content-length header, we
Jeremy Hylton39b198d2007-08-04 19:22:00 +0000265 # need to make sure that the client doesn't read more than the
266 # specified number of bytes. If it does, it will block until
267 # the server times out and closes the connection. (The only
Kristján Valur Jónsson7e11b3f2009-02-02 16:04:04 +0000268 # applies to HTTP/1.1 connections.) This will happen if a self.fp.read()
269 # is done (without a size) whether self.fp is buffered or not.
270 # So, no self.fp.read() by clients unless they know what they are doing.
Benjamin Petersonf72d9fb2009-02-08 00:29:20 +0000271 self.fp = sock.makefile("rb")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000272 self.debuglevel = debuglevel
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000273 self.strict = strict
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000274 self._method = method
Greg Stein5e0fa402000-06-26 08:28:01 +0000275
Greg Steindd6eefb2000-07-18 09:09:48 +0000276 self.msg = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000277
Greg Steindd6eefb2000-07-18 09:09:48 +0000278 # from the Status-Line of the response
Tim Peters07e99cb2001-01-14 23:47:14 +0000279 self.version = _UNKNOWN # HTTP-Version
280 self.status = _UNKNOWN # Status-Code
281 self.reason = _UNKNOWN # Reason-Phrase
Greg Stein5e0fa402000-06-26 08:28:01 +0000282
Tim Peters07e99cb2001-01-14 23:47:14 +0000283 self.chunked = _UNKNOWN # is "chunked" being used?
284 self.chunk_left = _UNKNOWN # bytes left to read in current chunk
285 self.length = _UNKNOWN # number of bytes left in response
286 self.will_close = _UNKNOWN # conn will close at end of response
Greg Stein5e0fa402000-06-26 08:28:01 +0000287
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000288 def _read_status(self):
Jeremy Hylton04319c72007-08-04 03:41:19 +0000289 # Initialize with Simple-Response defaults.
Jeremy Hylton811fc142007-08-03 13:30:02 +0000290 line = str(self.fp.readline(), "iso-8859-1")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000291 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000292 print("reply:", repr(line))
Jeremy Hyltonb6769522003-06-29 17:55:05 +0000293 if not line:
294 # Presumably, the server closed the connection before
295 # sending a valid response.
296 raise BadStatusLine(line)
Greg Steindd6eefb2000-07-18 09:09:48 +0000297 try:
Guido van Rossum34735a62000-12-15 15:09:42 +0000298 [version, status, reason] = line.split(None, 2)
Greg Steindd6eefb2000-07-18 09:09:48 +0000299 except ValueError:
300 try:
Guido van Rossum34735a62000-12-15 15:09:42 +0000301 [version, status] = line.split(None, 1)
Greg Steindd6eefb2000-07-18 09:09:48 +0000302 reason = ""
303 except ValueError:
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000304 # empty version will cause next test to fail and status
305 # will be treated as 0.9 response.
306 version = ""
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000307 if not version.startswith("HTTP/"):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000308 if self.strict:
309 self.close()
310 raise BadStatusLine(line)
311 else:
Jeremy Hylton04319c72007-08-04 03:41:19 +0000312 # Assume it's a Simple-Response from an 0.9 server.
313 # We have to convert the first line back to raw bytes
314 # because self.fp.readline() needs to return bytes.
Guido van Rossum70d0dda2007-08-29 01:53:26 +0000315 self.fp = LineAndFileWrapper(bytes(line, "ascii"), self.fp)
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000316 return "HTTP/0.9", 200, ""
Greg Stein5e0fa402000-06-26 08:28:01 +0000317
Jeremy Hylton23d40472001-04-13 14:57:08 +0000318 # The status code is a three-digit number
319 try:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000320 status = int(status)
Jeremy Hylton23d40472001-04-13 14:57:08 +0000321 if status < 100 or status > 999:
322 raise BadStatusLine(line)
323 except ValueError:
324 raise BadStatusLine(line)
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000325 return version, status, reason
Greg Stein5e0fa402000-06-26 08:28:01 +0000326
Jeremy Hylton39c03802002-07-12 14:04:09 +0000327 def begin(self):
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000328 if self.msg is not None:
329 # we've already started reading the response
330 return
331
332 # read until we get a non-100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000333 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000334 version, status, reason = self._read_status()
Martin v. Löwis39a31782004-09-18 09:03:49 +0000335 if status != CONTINUE:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000336 break
337 # skip the header from the 100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000338 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000339 skip = self.fp.readline().strip()
340 if not skip:
341 break
342 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000343 print("header:", skip)
Tim Petersc411dba2002-07-16 21:35:23 +0000344
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000345 self.status = status
346 self.reason = reason.strip()
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000347 if version == "HTTP/1.0":
Greg Steindd6eefb2000-07-18 09:09:48 +0000348 self.version = 10
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000349 elif version.startswith("HTTP/1."):
Tim Peters07e99cb2001-01-14 23:47:14 +0000350 self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000351 elif version == "HTTP/0.9":
Jeremy Hylton110941a2000-10-12 19:58:36 +0000352 self.version = 9
Greg Steindd6eefb2000-07-18 09:09:48 +0000353 else:
354 raise UnknownProtocol(version)
Greg Stein5e0fa402000-06-26 08:28:01 +0000355
Jeremy Hylton110941a2000-10-12 19:58:36 +0000356 if self.version == 9:
Georg Brandl0aade9a2005-06-26 22:06:54 +0000357 self.length = None
Jeremy Hylton236156f2008-12-15 03:00:50 +0000358 self.chunked = False
359 self.will_close = True
Barry Warsaw820c1202008-06-12 04:06:45 +0000360 self.msg = email.message_from_string('')
Jeremy Hylton110941a2000-10-12 19:58:36 +0000361 return
362
Barry Warsaw820c1202008-06-12 04:06:45 +0000363 self.msg = parse_headers(self.fp)
364
Jeremy Hylton30f86742000-09-18 22:50:38 +0000365 if self.debuglevel > 0:
Barry Warsaw820c1202008-06-12 04:06:45 +0000366 for hdr in self.msg:
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000367 print("header:", hdr, end=" ")
Greg Stein5e0fa402000-06-26 08:28:01 +0000368
Greg Steindd6eefb2000-07-18 09:09:48 +0000369 # are we using the chunked-style of transfer encoding?
Barry Warsaw820c1202008-06-12 04:06:45 +0000370 tr_enc = self.msg.get("transfer-encoding")
Jeremy Hyltond229b3a2002-09-03 19:24:24 +0000371 if tr_enc and tr_enc.lower() == "chunked":
Jeremy Hylton236156f2008-12-15 03:00:50 +0000372 self.chunked = True
Greg Steindd6eefb2000-07-18 09:09:48 +0000373 self.chunk_left = None
374 else:
Jeremy Hylton236156f2008-12-15 03:00:50 +0000375 self.chunked = False
Greg Stein5e0fa402000-06-26 08:28:01 +0000376
Greg Steindd6eefb2000-07-18 09:09:48 +0000377 # will the connection close at the end of the response?
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000378 self.will_close = self._check_close()
Greg Stein5e0fa402000-06-26 08:28:01 +0000379
Greg Steindd6eefb2000-07-18 09:09:48 +0000380 # do we have a Content-Length?
381 # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked"
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000382 self.length = None
Barry Warsaw820c1202008-06-12 04:06:45 +0000383 length = self.msg.get("content-length")
384
385 # are we using the chunked-style of transfer encoding?
386 tr_enc = self.msg.get("transfer-encoding")
Greg Steindd6eefb2000-07-18 09:09:48 +0000387 if length and not self.chunked:
Jeremy Hylton30a81812000-09-14 20:34:27 +0000388 try:
389 self.length = int(length)
390 except ValueError:
Christian Heimesa612dc02008-02-24 13:08:18 +0000391 self.length = None
392 else:
393 if self.length < 0: # ignore nonsensical negative lengths
394 self.length = None
395 else:
396 self.length = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000397
Greg Steindd6eefb2000-07-18 09:09:48 +0000398 # does the body have a fixed length? (of zero)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000399 if (status == NO_CONTENT or status == NOT_MODIFIED or
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000400 100 <= status < 200 or # 1xx codes
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000401 self._method == "HEAD"):
Greg Steindd6eefb2000-07-18 09:09:48 +0000402 self.length = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000403
Greg Steindd6eefb2000-07-18 09:09:48 +0000404 # if the connection remains open, and we aren't using chunked, and
405 # a content-length was not provided, then assume that the connection
406 # WILL close.
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000407 if (not self.will_close and
408 not self.chunked and
409 self.length is None):
Jeremy Hylton236156f2008-12-15 03:00:50 +0000410 self.will_close = True
Greg Stein5e0fa402000-06-26 08:28:01 +0000411
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000412 def _check_close(self):
Barry Warsaw820c1202008-06-12 04:06:45 +0000413 conn = self.msg.get("connection")
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000414 if self.version == 11:
415 # An HTTP/1.1 proxy is assumed to stay open unless
416 # explicitly closed.
Barry Warsaw820c1202008-06-12 04:06:45 +0000417 conn = self.msg.get("connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000418 if conn and "close" in conn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000419 return True
420 return False
421
Jeremy Hylton2c178252004-08-07 16:28:14 +0000422 # Some HTTP/1.0 implementations have support for persistent
423 # connections, using rules different than HTTP/1.1.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000424
Christian Heimes895627f2007-12-08 17:28:33 +0000425 # For older HTTP, Keep-Alive indicates persistent connection.
Barry Warsaw820c1202008-06-12 04:06:45 +0000426 if self.msg.get("keep-alive"):
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000427 return False
Tim Peters77c06fb2002-11-24 02:35:35 +0000428
Jeremy Hylton2c178252004-08-07 16:28:14 +0000429 # At least Akamai returns a "Connection: Keep-Alive" header,
430 # which was supposed to be sent by the client.
431 if conn and "keep-alive" in conn.lower():
432 return False
433
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000434 # Proxy-Connection is a netscape hack.
Barry Warsaw820c1202008-06-12 04:06:45 +0000435 pconn = self.msg.get("proxy-connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000436 if pconn and "keep-alive" in pconn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000437 return False
438
439 # otherwise, assume it will close
440 return True
441
Greg Steindd6eefb2000-07-18 09:09:48 +0000442 def close(self):
443 if self.fp:
444 self.fp.close()
445 self.fp = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000446
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000447 # These implementations are for the benefit of io.BufferedReader.
448
449 # XXX This class should probably be revised to act more like
450 # the "raw stream" that BufferedReader expects.
451
452 @property
453 def closed(self):
454 return self.isclosed()
455
456 def flush(self):
457 self.fp.flush()
458
459 # End of "raw stream" methods
460
Greg Steindd6eefb2000-07-18 09:09:48 +0000461 def isclosed(self):
462 # NOTE: it is possible that we will not ever call self.close(). This
463 # case occurs when will_close is TRUE, length is None, and we
464 # read up to the last byte, but NOT past it.
465 #
466 # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be
467 # called, meaning self.isclosed() is meaningful.
468 return self.fp is None
469
470 def read(self, amt=None):
471 if self.fp is None:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000472 return b""
Greg Steindd6eefb2000-07-18 09:09:48 +0000473
474 if self.chunked:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000475 return self._read_chunked(amt)
Tim Peters230a60c2002-11-09 05:08:07 +0000476
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000477 if amt is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000478 # unbounded read
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000479 if self.length is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000480 s = self.fp.read()
481 else:
482 s = self._safe_read(self.length)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000483 self.length = 0
Tim Peters07e99cb2001-01-14 23:47:14 +0000484 self.close() # we read everything
Greg Steindd6eefb2000-07-18 09:09:48 +0000485 return s
486
487 if self.length is not None:
488 if amt > self.length:
489 # clip the read to the "end of response"
490 amt = self.length
Greg Steindd6eefb2000-07-18 09:09:48 +0000491
492 # we do not use _safe_read() here because this may be a .will_close
493 # connection, and the user is reading more bytes than will be provided
494 # (for example, reading in 1k chunks)
495 s = self.fp.read(amt)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000496 if self.length is not None:
497 self.length -= len(s)
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000498 if not self.length:
499 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +0000500 return s
501
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000502 def _read_chunked(self, amt):
503 assert self.chunked != _UNKNOWN
504 chunk_left = self.chunk_left
Georg Brandl95ba4692008-01-26 09:45:58 +0000505 value = b""
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000506
507 # XXX This accumulates chunks by repeated string concatenation,
508 # which is not efficient as the number or size of chunks gets big.
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000509 while True:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000510 if chunk_left is None:
511 line = self.fp.readline()
Georg Brandl95ba4692008-01-26 09:45:58 +0000512 i = line.find(b";")
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000513 if i >= 0:
514 line = line[:i] # strip chunk-extensions
Christian Heimesa612dc02008-02-24 13:08:18 +0000515 try:
516 chunk_left = int(line, 16)
517 except ValueError:
518 # close the connection as protocol synchronisation is
519 # probably lost
520 self.close()
521 raise IncompleteRead(value)
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000522 if chunk_left == 0:
523 break
524 if amt is None:
525 value += self._safe_read(chunk_left)
526 elif amt < chunk_left:
527 value += self._safe_read(amt)
528 self.chunk_left = chunk_left - amt
529 return value
530 elif amt == chunk_left:
531 value += self._safe_read(amt)
532 self._safe_read(2) # toss the CRLF at the end of the chunk
533 self.chunk_left = None
534 return value
535 else:
536 value += self._safe_read(chunk_left)
537 amt -= chunk_left
538
539 # we read the whole chunk, get another
540 self._safe_read(2) # toss the CRLF at the end of the chunk
541 chunk_left = None
542
543 # read and discard trailer up to the CRLF terminator
544 ### note: we shouldn't have any trailers!
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000545 while True:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000546 line = self.fp.readline()
Christian Heimes0bd4e112008-02-12 22:59:25 +0000547 if not line:
548 # a vanishingly small number of sites EOF without
549 # sending the trailer
550 break
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000551 if line == b"\r\n":
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000552 break
553
554 # we read everything; close the "file"
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000555 self.close()
556
557 return value
Tim Peters230a60c2002-11-09 05:08:07 +0000558
Greg Steindd6eefb2000-07-18 09:09:48 +0000559 def _safe_read(self, amt):
560 """Read the number of bytes requested, compensating for partial reads.
561
562 Normally, we have a blocking socket, but a read() can be interrupted
563 by a signal (resulting in a partial read).
564
565 Note that we cannot distinguish between EOF and an interrupt when zero
566 bytes have been read. IncompleteRead() will be raised in this
567 situation.
568
569 This function should be used when <amt> bytes "should" be present for
570 reading. If the bytes are truly not available (due to EOF), then the
571 IncompleteRead exception can be used to detect the problem.
572 """
Georg Brandl80ba8e82005-09-29 20:16:07 +0000573 s = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000574 while amt > 0:
Georg Brandl80ba8e82005-09-29 20:16:07 +0000575 chunk = self.fp.read(min(amt, MAXAMOUNT))
Greg Steindd6eefb2000-07-18 09:09:48 +0000576 if not chunk:
Benjamin Peterson6accb982009-03-02 22:50:25 +0000577 raise IncompleteRead(b''.join(s), amt)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000578 s.append(chunk)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000579 amt -= len(chunk)
Guido van Rossuma00f1232007-09-12 19:43:09 +0000580 return b"".join(s)
Greg Steindd6eefb2000-07-18 09:09:48 +0000581
Antoine Pitroub353c122009-02-11 00:39:14 +0000582 def fileno(self):
583 return self.fp.fileno()
584
Greg Steindd6eefb2000-07-18 09:09:48 +0000585 def getheader(self, name, default=None):
586 if self.msg is None:
587 raise ResponseNotReady()
Barry Warsaw820c1202008-06-12 04:06:45 +0000588 return ', '.join(self.msg.get_all(name, default))
Greg Stein5e0fa402000-06-26 08:28:01 +0000589
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000590 def getheaders(self):
591 """Return list of (header, value) tuples."""
592 if self.msg is None:
593 raise ResponseNotReady()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000594 return list(self.msg.items())
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000595
Antoine Pitroub353c122009-02-11 00:39:14 +0000596 # We override IOBase.__iter__ so that it doesn't check for closed-ness
597
598 def __iter__(self):
599 return self
600
Greg Stein5e0fa402000-06-26 08:28:01 +0000601
602class HTTPConnection:
603
Greg Steindd6eefb2000-07-18 09:09:48 +0000604 _http_vsn = 11
605 _http_vsn_str = 'HTTP/1.1'
Greg Stein5e0fa402000-06-26 08:28:01 +0000606
Greg Steindd6eefb2000-07-18 09:09:48 +0000607 response_class = HTTPResponse
608 default_port = HTTP_PORT
609 auto_open = 1
Jeremy Hylton30f86742000-09-18 22:50:38 +0000610 debuglevel = 0
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000611 strict = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000612
Georg Brandlf78e02b2008-06-10 17:40:04 +0000613 def __init__(self, host, port=None, strict=None,
614 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000615 self.timeout = timeout
Greg Steindd6eefb2000-07-18 09:09:48 +0000616 self.sock = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000617 self._buffer = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000618 self.__response = None
619 self.__state = _CS_IDLE
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000620 self._method = None
Tim Petersc411dba2002-07-16 21:35:23 +0000621
Greg Steindd6eefb2000-07-18 09:09:48 +0000622 self._set_hostport(host, port)
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000623 if strict is not None:
624 self.strict = strict
Greg Stein5e0fa402000-06-26 08:28:01 +0000625
Greg Steindd6eefb2000-07-18 09:09:48 +0000626 def _set_hostport(self, host, port):
627 if port is None:
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000628 i = host.rfind(':')
Skip Montanarocae14d22004-09-14 17:55:21 +0000629 j = host.rfind(']') # ipv6 addresses have [...]
630 if i > j:
Skip Montanaro9d389972002-03-24 16:53:50 +0000631 try:
632 port = int(host[i+1:])
633 except ValueError:
Jeremy Hyltonfbd79942002-07-02 20:19:08 +0000634 raise InvalidURL("nonnumeric port: '%s'" % host[i+1:])
Greg Steindd6eefb2000-07-18 09:09:48 +0000635 host = host[:i]
636 else:
637 port = self.default_port
Raymond Hettinger4d037912004-10-14 15:23:38 +0000638 if host and host[0] == '[' and host[-1] == ']':
Brett Cannon0a1af4a2004-09-15 23:26:23 +0000639 host = host[1:-1]
Greg Steindd6eefb2000-07-18 09:09:48 +0000640 self.host = host
641 self.port = port
Greg Stein5e0fa402000-06-26 08:28:01 +0000642
Jeremy Hylton30f86742000-09-18 22:50:38 +0000643 def set_debuglevel(self, level):
644 self.debuglevel = level
645
Greg Steindd6eefb2000-07-18 09:09:48 +0000646 def connect(self):
647 """Connect to the host and port specified in __init__."""
Guido van Rossumd8faa362007-04-27 19:54:29 +0000648 self.sock = socket.create_connection((self.host,self.port),
649 self.timeout)
Greg Stein5e0fa402000-06-26 08:28:01 +0000650
Greg Steindd6eefb2000-07-18 09:09:48 +0000651 def close(self):
652 """Close the connection to the HTTP server."""
653 if self.sock:
Tim Peters07e99cb2001-01-14 23:47:14 +0000654 self.sock.close() # close it manually... there may be other refs
Greg Steindd6eefb2000-07-18 09:09:48 +0000655 self.sock = None
656 if self.__response:
657 self.__response.close()
658 self.__response = None
659 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000660
Greg Steindd6eefb2000-07-18 09:09:48 +0000661 def send(self, str):
662 """Send `str' to the server."""
663 if self.sock is None:
664 if self.auto_open:
665 self.connect()
666 else:
667 raise NotConnected()
Greg Stein5e0fa402000-06-26 08:28:01 +0000668
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000669 # send the data to the server. if we get a broken pipe, then close
Greg Steindd6eefb2000-07-18 09:09:48 +0000670 # the socket. we want to reconnect when somebody tries to send again.
671 #
672 # NOTE: we DO propagate the error, though, because we cannot simply
673 # ignore the error... the caller will know if they can retry.
Jeremy Hylton30f86742000-09-18 22:50:38 +0000674 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000675 print("send:", repr(str))
Greg Steindd6eefb2000-07-18 09:09:48 +0000676 try:
Jeremy Hylton236654b2009-03-27 20:24:34 +0000677 blocksize = 8192
678 if hasattr(str, "read") :
679 if self.debuglevel > 0:
680 print("sendIng a read()able")
681 encode = False
682 if "b" not in str.mode:
683 encode = True
684 if self.debuglevel > 0:
685 print("encoding file using iso-8859-1")
686 while 1:
687 data = str.read(blocksize)
688 if not data:
689 break
690 if encode:
691 data = data.encode("iso-8859-1")
Thomas Wouters89f507f2006-12-13 04:49:30 +0000692 self.sock.sendall(data)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000693 else:
694 self.sock.sendall(str)
Guido van Rossumb940e112007-01-10 16:19:56 +0000695 except socket.error as v:
Guido van Rossum89df2452007-03-19 22:26:27 +0000696 if v.args[0] == 32: # Broken pipe
Greg Steindd6eefb2000-07-18 09:09:48 +0000697 self.close()
698 raise
Greg Stein5e0fa402000-06-26 08:28:01 +0000699
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000700 def _output(self, s):
701 """Add a line of output to the current request buffer.
Tim Peters469cdad2002-08-08 20:19:19 +0000702
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000703 Assumes that the line does *not* end with \\r\\n.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000704 """
705 self._buffer.append(s)
706
Benjamin Peterson1742e402008-11-30 22:15:29 +0000707 def _send_output(self, message_body=None):
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000708 """Send the currently buffered request and clear the buffer.
709
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000710 Appends an extra \\r\\n to the buffer.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000711 A message_body may be specified, to be appended to the request.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000712 """
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000713 self._buffer.extend((b"", b""))
714 msg = b"\r\n".join(self._buffer)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000715 del self._buffer[:]
Benjamin Peterson1742e402008-11-30 22:15:29 +0000716 # If msg and message_body are sent in a single send() call,
717 # it will avoid performance problems caused by the interaction
718 # between delayed ack and the Nagle algorithim.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000719 if isinstance(message_body, bytes):
Benjamin Peterson1742e402008-11-30 22:15:29 +0000720 msg += message_body
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000721 message_body = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000722 self.send(msg)
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000723 if message_body is not None:
Jeremy Hylton236654b2009-03-27 20:24:34 +0000724 # message_body was not a string (i.e. it is a file), and
725 # we must run the risk of Nagle.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000726 self.send(message_body)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000727
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000728 def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0):
Greg Steindd6eefb2000-07-18 09:09:48 +0000729 """Send a request to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000730
Greg Steindd6eefb2000-07-18 09:09:48 +0000731 `method' specifies an HTTP request method, e.g. 'GET'.
732 `url' specifies the object being requested, e.g. '/index.html'.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000733 `skip_host' if True does not add automatically a 'Host:' header
734 `skip_accept_encoding' if True does not add automatically an
735 'Accept-Encoding:' header
Greg Steindd6eefb2000-07-18 09:09:48 +0000736 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000737
Greg Stein616a58d2003-06-24 06:35:19 +0000738 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000739 if self.__response and self.__response.isclosed():
740 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000741
Tim Peters58eb11c2004-01-18 20:29:55 +0000742
Greg Steindd6eefb2000-07-18 09:09:48 +0000743 # in certain cases, we cannot issue another request on this connection.
744 # this occurs when:
745 # 1) we are in the process of sending a request. (_CS_REQ_STARTED)
746 # 2) a response to a previous request has signalled that it is going
747 # to close the connection upon completion.
748 # 3) the headers for the previous response have not been read, thus
749 # we cannot determine whether point (2) is true. (_CS_REQ_SENT)
750 #
751 # if there is no prior response, then we can request at will.
752 #
753 # if point (2) is true, then we will have passed the socket to the
754 # response (effectively meaning, "there is no prior response"), and
755 # will open a new one when a new request is made.
756 #
757 # Note: if a prior response exists, then we *can* start a new request.
758 # We are not allowed to begin fetching the response to this new
759 # request, however, until that prior response is complete.
760 #
761 if self.__state == _CS_IDLE:
762 self.__state = _CS_REQ_STARTED
763 else:
764 raise CannotSendRequest()
Greg Stein5e0fa402000-06-26 08:28:01 +0000765
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000766 # Save the method we use, we need it later in the response phase
767 self._method = method
Greg Steindd6eefb2000-07-18 09:09:48 +0000768 if not url:
769 url = '/'
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000770 request = '%s %s %s' % (method, url, self._http_vsn_str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000771
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000772 # Non-ASCII characters should have been eliminated earlier
773 self._output(request.encode('ascii'))
Greg Stein5e0fa402000-06-26 08:28:01 +0000774
Greg Steindd6eefb2000-07-18 09:09:48 +0000775 if self._http_vsn == 11:
776 # Issue some standard headers for better HTTP/1.1 compliance
Greg Stein5e0fa402000-06-26 08:28:01 +0000777
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000778 if not skip_host:
779 # this header is issued *only* for HTTP/1.1
780 # connections. more specifically, this means it is
781 # only issued when the client uses the new
782 # HTTPConnection() class. backwards-compat clients
783 # will be using HTTP/1.0 and those clients may be
784 # issuing this header themselves. we should NOT issue
785 # it twice; some web servers (such as Apache) barf
786 # when they see two Host: headers
Guido van Rossumf6922aa2001-01-14 21:03:01 +0000787
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000788 # If we need a non-standard port,include it in the
789 # header. If the request is going through a proxy,
790 # but the host of the actual URL, not the host of the
791 # proxy.
Jeremy Hylton8acf1e02002-03-08 19:35:51 +0000792
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000793 netloc = ''
794 if url.startswith('http'):
795 nil, netloc, nil, nil, nil = urlsplit(url)
796
797 if netloc:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000798 try:
799 netloc_enc = netloc.encode("ascii")
800 except UnicodeEncodeError:
801 netloc_enc = netloc.encode("idna")
802 self.putheader('Host', netloc_enc)
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000803 else:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000804 try:
805 host_enc = self.host.encode("ascii")
806 except UnicodeEncodeError:
807 host_enc = self.host.encode("idna")
Georg Brandl86b2fb92008-07-16 03:43:04 +0000808 if self.port == self.default_port:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000809 self.putheader('Host', host_enc)
810 else:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000811 host_enc = host_enc.decode("ascii")
Thomas Wouters477c8d52006-05-27 19:21:47 +0000812 self.putheader('Host', "%s:%s" % (host_enc, self.port))
Greg Stein5e0fa402000-06-26 08:28:01 +0000813
Greg Steindd6eefb2000-07-18 09:09:48 +0000814 # note: we are assuming that clients will not attempt to set these
815 # headers since *this* library must deal with the
816 # consequences. this also means that when the supporting
817 # libraries are updated to recognize other forms, then this
818 # code should be changed (removed or updated).
Greg Stein5e0fa402000-06-26 08:28:01 +0000819
Greg Steindd6eefb2000-07-18 09:09:48 +0000820 # we only want a Content-Encoding of "identity" since we don't
821 # support encodings such as x-gzip or x-deflate.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000822 if not skip_accept_encoding:
823 self.putheader('Accept-Encoding', 'identity')
Greg Stein5e0fa402000-06-26 08:28:01 +0000824
Greg Steindd6eefb2000-07-18 09:09:48 +0000825 # we can accept "chunked" Transfer-Encodings, but no others
826 # NOTE: no TE header implies *only* "chunked"
827 #self.putheader('TE', 'chunked')
Greg Stein5e0fa402000-06-26 08:28:01 +0000828
Greg Steindd6eefb2000-07-18 09:09:48 +0000829 # if TE is supplied in the header, then it must appear in a
830 # Connection header.
831 #self.putheader('Connection', 'TE')
Greg Stein5e0fa402000-06-26 08:28:01 +0000832
Greg Steindd6eefb2000-07-18 09:09:48 +0000833 else:
834 # For HTTP/1.0, the server will assume "not chunked"
835 pass
Greg Stein5e0fa402000-06-26 08:28:01 +0000836
Benjamin Petersonf608c612008-11-16 18:33:53 +0000837 def putheader(self, header, *values):
Greg Steindd6eefb2000-07-18 09:09:48 +0000838 """Send a request header line to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000839
Greg Steindd6eefb2000-07-18 09:09:48 +0000840 For example: h.putheader('Accept', 'text/html')
841 """
842 if self.__state != _CS_REQ_STARTED:
843 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +0000844
Guido van Rossum98297ee2007-11-06 21:34:58 +0000845 if hasattr(header, 'encode'):
846 header = header.encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +0000847 values = list(values)
848 for i, one_value in enumerate(values):
849 if hasattr(one_value, 'encode'):
850 values[i] = one_value.encode('ascii')
851 value = b'\r\n\t'.join(values)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000852 header = header + b': ' + value
853 self._output(header)
Greg Stein5e0fa402000-06-26 08:28:01 +0000854
Benjamin Peterson1742e402008-11-30 22:15:29 +0000855 def endheaders(self, message_body=None):
856 """Indicate that the last header line has been sent to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000857
Benjamin Peterson1742e402008-11-30 22:15:29 +0000858 This method sends the request to the server. The optional
859 message_body argument can be used to pass message body
860 associated with the request. The message body will be sent in
861 the same packet as the message headers if possible. The
862 message_body should be a string.
863 """
Greg Steindd6eefb2000-07-18 09:09:48 +0000864 if self.__state == _CS_REQ_STARTED:
865 self.__state = _CS_REQ_SENT
866 else:
867 raise CannotSendHeader()
Benjamin Peterson1742e402008-11-30 22:15:29 +0000868 self._send_output(message_body)
Greg Stein5e0fa402000-06-26 08:28:01 +0000869
Greg Steindd6eefb2000-07-18 09:09:48 +0000870 def request(self, method, url, body=None, headers={}):
871 """Send a complete request to the server."""
Greg Steindd6eefb2000-07-18 09:09:48 +0000872 try:
873 self._send_request(method, url, body, headers)
Guido van Rossumb940e112007-01-10 16:19:56 +0000874 except socket.error as v:
Greg Steindd6eefb2000-07-18 09:09:48 +0000875 # trap 'Broken pipe' if we're allowed to automatically reconnect
Guido van Rossum89df2452007-03-19 22:26:27 +0000876 if v.args[0] != 32 or not self.auto_open:
Greg Steindd6eefb2000-07-18 09:09:48 +0000877 raise
878 # try one more time
879 self._send_request(method, url, body, headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000880
Benjamin Peterson1742e402008-11-30 22:15:29 +0000881 def _set_content_length(self, body):
882 # Set the content-length based on the body.
883 thelen = None
884 try:
885 thelen = str(len(body))
886 except TypeError as te:
887 # If this is a file-like object, try to
888 # fstat its file descriptor
889 import os
890 try:
891 thelen = str(os.fstat(body.fileno()).st_size)
892 except (AttributeError, OSError):
893 # Don't send a length if this failed
894 if self.debuglevel > 0: print("Cannot stat!!")
895
896 if thelen is not None:
897 self.putheader('Content-Length', thelen)
898
Greg Steindd6eefb2000-07-18 09:09:48 +0000899 def _send_request(self, method, url, body, headers):
Jeremy Hylton2c178252004-08-07 16:28:14 +0000900 # honour explicitly requested Host: and Accept-Encoding headers
901 header_names = dict.fromkeys([k.lower() for k in headers])
902 skips = {}
903 if 'host' in header_names:
904 skips['skip_host'] = 1
905 if 'accept-encoding' in header_names:
906 skips['skip_accept_encoding'] = 1
Greg Stein5e0fa402000-06-26 08:28:01 +0000907
Jeremy Hylton2c178252004-08-07 16:28:14 +0000908 self.putrequest(method, url, **skips)
909
910 if body and ('content-length' not in header_names):
Benjamin Peterson1742e402008-11-30 22:15:29 +0000911 self._set_content_length(body)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000912 for hdr, value in headers.items():
Greg Steindd6eefb2000-07-18 09:09:48 +0000913 self.putheader(hdr, value)
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +0000914 if isinstance(body, str):
Jeremy Hylton236654b2009-03-27 20:24:34 +0000915 # RFC 2616 Section 3.7.1 says that text default has a
916 # default charset of iso-8859-1.
917 body = body.encode('iso-8859-1')
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +0000918 self.endheaders(body)
Greg Stein5e0fa402000-06-26 08:28:01 +0000919
Greg Steindd6eefb2000-07-18 09:09:48 +0000920 def getresponse(self):
Jeremy Hyltonfb35f652007-08-03 20:30:33 +0000921 """Get the response from the server."""
Greg Stein5e0fa402000-06-26 08:28:01 +0000922
Greg Stein616a58d2003-06-24 06:35:19 +0000923 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000924 if self.__response and self.__response.isclosed():
925 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000926
Greg Steindd6eefb2000-07-18 09:09:48 +0000927 #
928 # if a prior response exists, then it must be completed (otherwise, we
929 # cannot read this response's header to determine the connection-close
930 # behavior)
931 #
932 # note: if a prior response existed, but was connection-close, then the
933 # socket and response were made independent of this HTTPConnection
934 # object since a new request requires that we open a whole new
935 # connection
936 #
937 # this means the prior response had one of two states:
938 # 1) will_close: this connection was reset and the prior socket and
939 # response operate independently
940 # 2) persistent: the response was retained and we await its
941 # isclosed() status to become true.
942 #
943 if self.__state != _CS_REQ_SENT or self.__response:
944 raise ResponseNotReady()
Greg Stein5e0fa402000-06-26 08:28:01 +0000945
Jeremy Hylton30f86742000-09-18 22:50:38 +0000946 if self.debuglevel > 0:
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000947 response = self.response_class(self.sock, self.debuglevel,
Tim Petersc2659cf2003-05-12 20:19:37 +0000948 strict=self.strict,
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000949 method=self._method)
Jeremy Hylton30f86742000-09-18 22:50:38 +0000950 else:
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000951 response = self.response_class(self.sock, strict=self.strict,
952 method=self._method)
Greg Stein5e0fa402000-06-26 08:28:01 +0000953
Jeremy Hylton39c03802002-07-12 14:04:09 +0000954 response.begin()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000955 assert response.will_close != _UNKNOWN
Greg Steindd6eefb2000-07-18 09:09:48 +0000956 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000957
Greg Steindd6eefb2000-07-18 09:09:48 +0000958 if response.will_close:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000959 # this effectively passes the connection to the response
960 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +0000961 else:
962 # remember this, so we can tell when it is complete
963 self.__response = response
Greg Stein5e0fa402000-06-26 08:28:01 +0000964
Greg Steindd6eefb2000-07-18 09:09:48 +0000965 return response
Greg Stein5e0fa402000-06-26 08:28:01 +0000966
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000967try:
968 import ssl
969except ImportError:
970 pass
971else:
972 class HTTPSConnection(HTTPConnection):
973 "This class allows communication via SSL."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +0000974
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000975 default_port = HTTPS_PORT
Jeremy Hylton29d27ac2002-07-09 21:22:36 +0000976
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000977 def __init__(self, host, port=None, key_file=None, cert_file=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +0000978 strict=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000979 HTTPConnection.__init__(self, host, port, strict, timeout)
980 self.key_file = key_file
981 self.cert_file = cert_file
Jeremy Hylton29d27ac2002-07-09 21:22:36 +0000982
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000983 def connect(self):
984 "Connect to a host on a given (SSL) port."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +0000985
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000986 sock = socket.create_connection((self.host, self.port), self.timeout)
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000987 self.sock = ssl.wrap_socket(sock, self.key_file, self.cert_file)
Jeremy Hylton29d27ac2002-07-09 21:22:36 +0000988
Jeremy Hylton29d27ac2002-07-09 21:22:36 +0000989
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000990 def FakeSocket (sock, sslobj):
Thomas Wouters89d996e2007-09-08 17:39:28 +0000991 warnings.warn("FakeSocket is deprecated, and won't be in 3.x. " +
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000992 "Use the result of ssl.wrap_socket() directly instead.",
Thomas Wouters89d996e2007-09-08 17:39:28 +0000993 DeprecationWarning, stacklevel=2)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000994 return sslobj
Jeremy Hylton29d27ac2002-07-09 21:22:36 +0000995
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000996 __all__.append("HTTPSConnection")
Greg Stein5e0fa402000-06-26 08:28:01 +0000997
Greg Stein5e0fa402000-06-26 08:28:01 +0000998class HTTPException(Exception):
Jeremy Hylton12f4f352002-07-06 18:55:01 +0000999 # Subclasses that define an __init__ must call Exception.__init__
1000 # or define self.args. Otherwise, str() will fail.
Greg Steindd6eefb2000-07-18 09:09:48 +00001001 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001002
1003class NotConnected(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001004 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001005
Skip Montanaro9d389972002-03-24 16:53:50 +00001006class InvalidURL(HTTPException):
1007 pass
1008
Greg Stein5e0fa402000-06-26 08:28:01 +00001009class UnknownProtocol(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001010 def __init__(self, version):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001011 self.args = version,
Greg Steindd6eefb2000-07-18 09:09:48 +00001012 self.version = version
Greg Stein5e0fa402000-06-26 08:28:01 +00001013
1014class UnknownTransferEncoding(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001015 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001016
Greg Stein5e0fa402000-06-26 08:28:01 +00001017class UnimplementedFileMode(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001018 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001019
1020class IncompleteRead(HTTPException):
Benjamin Peterson6accb982009-03-02 22:50:25 +00001021 def __init__(self, partial, expected=None):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001022 self.args = partial,
Greg Steindd6eefb2000-07-18 09:09:48 +00001023 self.partial = partial
Benjamin Peterson6accb982009-03-02 22:50:25 +00001024 self.expected = expected
1025 def __repr__(self):
1026 if self.expected is not None:
1027 e = ', %i more expected' % self.expected
1028 else:
1029 e = ''
1030 return 'IncompleteRead(%i bytes read%s)' % (len(self.partial), e)
1031 def __str__(self):
1032 return repr(self)
Greg Stein5e0fa402000-06-26 08:28:01 +00001033
1034class ImproperConnectionState(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001035 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001036
1037class CannotSendRequest(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001038 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001039
1040class CannotSendHeader(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001041 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001042
1043class ResponseNotReady(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001044 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001045
1046class BadStatusLine(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001047 def __init__(self, line):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001048 self.args = line,
Greg Steindd6eefb2000-07-18 09:09:48 +00001049 self.line = line
Greg Stein5e0fa402000-06-26 08:28:01 +00001050
1051# for backwards compatibility
1052error = HTTPException
1053
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001054class LineAndFileWrapper:
1055 """A limited file-like object for HTTP/0.9 responses."""
1056
1057 # The status-line parsing code calls readline(), which normally
1058 # get the HTTP status line. For a 0.9 response, however, this is
1059 # actually the first line of the body! Clients need to get a
1060 # readable file object that contains that line.
1061
1062 def __init__(self, line, file):
1063 self._line = line
1064 self._file = file
1065 self._line_consumed = 0
1066 self._line_offset = 0
1067 self._line_left = len(line)
1068
1069 def __getattr__(self, attr):
1070 return getattr(self._file, attr)
1071
1072 def _done(self):
1073 # called when the last byte is read from the line. After the
1074 # call, all read methods are delegated to the underlying file
Skip Montanaro74b9a7a2003-02-25 17:48:15 +00001075 # object.
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001076 self._line_consumed = 1
1077 self.read = self._file.read
1078 self.readline = self._file.readline
1079 self.readlines = self._file.readlines
1080
1081 def read(self, amt=None):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001082 if self._line_consumed:
1083 return self._file.read(amt)
1084 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001085 if amt is None or amt > self._line_left:
1086 s = self._line[self._line_offset:]
1087 self._done()
1088 if amt is None:
1089 return s + self._file.read()
1090 else:
Tim Petersc411dba2002-07-16 21:35:23 +00001091 return s + self._file.read(amt - len(s))
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001092 else:
1093 assert amt <= self._line_left
1094 i = self._line_offset
1095 j = i + amt
1096 s = self._line[i:j]
1097 self._line_offset = j
1098 self._line_left -= amt
1099 if self._line_left == 0:
1100 self._done()
1101 return s
Tim Petersc411dba2002-07-16 21:35:23 +00001102
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001103 def readline(self):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001104 if self._line_consumed:
1105 return self._file.readline()
1106 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001107 s = self._line[self._line_offset:]
1108 self._done()
1109 return s
1110
1111 def readlines(self, size=None):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001112 if self._line_consumed:
1113 return self._file.readlines(size)
1114 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001115 L = [self._line[self._line_offset:]]
1116 self._done()
1117 if size is None:
1118 return L + self._file.readlines()
1119 else:
1120 return L + self._file.readlines(size)