blob: 7db79b3f2134f9fe61e47460f293544ffd349f51 [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
Senthil Kumaran7bc0d872010-12-19 10:49:52 +000074import collections
Jeremy Hylton1afc1692008-06-18 20:49:58 +000075from urllib.parse import urlsplit
Thomas Wouters89d996e2007-09-08 17:39:28 +000076import warnings
Guido van Rossum23acc951994-02-21 16:36:04 +000077
Thomas Wouters47b49bf2007-08-30 22:15:33 +000078__all__ = ["HTTPResponse", "HTTPConnection",
Skip Montanaro951a8842001-06-01 16:25:38 +000079 "HTTPException", "NotConnected", "UnknownProtocol",
Jeremy Hylton7c75c992002-06-28 23:38:14 +000080 "UnknownTransferEncoding", "UnimplementedFileMode",
81 "IncompleteRead", "InvalidURL", "ImproperConnectionState",
82 "CannotSendRequest", "CannotSendHeader", "ResponseNotReady",
Georg Brandl6aab16e2006-02-17 19:17:25 +000083 "BadStatusLine", "error", "responses"]
Skip Montanaro2dd42762001-01-23 15:35:05 +000084
Guido van Rossum23acc951994-02-21 16:36:04 +000085HTTP_PORT = 80
Guido van Rossum09c8b6c1999-12-07 21:37:17 +000086HTTPS_PORT = 443
87
Greg Stein5e0fa402000-06-26 08:28:01 +000088_UNKNOWN = 'UNKNOWN'
89
90# connection states
91_CS_IDLE = 'Idle'
92_CS_REQ_STARTED = 'Request-started'
93_CS_REQ_SENT = 'Request-sent'
94
Martin v. Löwis39a31782004-09-18 09:03:49 +000095# status codes
96# informational
97CONTINUE = 100
98SWITCHING_PROTOCOLS = 101
99PROCESSING = 102
100
101# successful
102OK = 200
103CREATED = 201
104ACCEPTED = 202
105NON_AUTHORITATIVE_INFORMATION = 203
106NO_CONTENT = 204
107RESET_CONTENT = 205
108PARTIAL_CONTENT = 206
109MULTI_STATUS = 207
110IM_USED = 226
111
112# redirection
113MULTIPLE_CHOICES = 300
114MOVED_PERMANENTLY = 301
115FOUND = 302
116SEE_OTHER = 303
117NOT_MODIFIED = 304
118USE_PROXY = 305
119TEMPORARY_REDIRECT = 307
120
121# client error
122BAD_REQUEST = 400
123UNAUTHORIZED = 401
124PAYMENT_REQUIRED = 402
125FORBIDDEN = 403
126NOT_FOUND = 404
127METHOD_NOT_ALLOWED = 405
128NOT_ACCEPTABLE = 406
129PROXY_AUTHENTICATION_REQUIRED = 407
130REQUEST_TIMEOUT = 408
131CONFLICT = 409
132GONE = 410
133LENGTH_REQUIRED = 411
134PRECONDITION_FAILED = 412
135REQUEST_ENTITY_TOO_LARGE = 413
136REQUEST_URI_TOO_LONG = 414
137UNSUPPORTED_MEDIA_TYPE = 415
138REQUESTED_RANGE_NOT_SATISFIABLE = 416
139EXPECTATION_FAILED = 417
140UNPROCESSABLE_ENTITY = 422
141LOCKED = 423
142FAILED_DEPENDENCY = 424
143UPGRADE_REQUIRED = 426
Hynek Schlawack51b2ed52012-05-16 09:51:07 +0200144PRECONDITION_REQUIRED = 428
145TOO_MANY_REQUESTS = 429
146REQUEST_HEADER_FIELDS_TOO_LARGE = 431
Martin v. Löwis39a31782004-09-18 09:03:49 +0000147
148# server error
149INTERNAL_SERVER_ERROR = 500
150NOT_IMPLEMENTED = 501
151BAD_GATEWAY = 502
152SERVICE_UNAVAILABLE = 503
153GATEWAY_TIMEOUT = 504
154HTTP_VERSION_NOT_SUPPORTED = 505
155INSUFFICIENT_STORAGE = 507
156NOT_EXTENDED = 510
Hynek Schlawack51b2ed52012-05-16 09:51:07 +0200157NETWORK_AUTHENTICATION_REQUIRED = 511
Martin v. Löwis39a31782004-09-18 09:03:49 +0000158
Georg Brandl6aab16e2006-02-17 19:17:25 +0000159# Mapping status codes to official W3C names
160responses = {
161 100: 'Continue',
162 101: 'Switching Protocols',
163
164 200: 'OK',
165 201: 'Created',
166 202: 'Accepted',
167 203: 'Non-Authoritative Information',
168 204: 'No Content',
169 205: 'Reset Content',
170 206: 'Partial Content',
171
172 300: 'Multiple Choices',
173 301: 'Moved Permanently',
174 302: 'Found',
175 303: 'See Other',
176 304: 'Not Modified',
177 305: 'Use Proxy',
178 306: '(Unused)',
179 307: 'Temporary Redirect',
180
181 400: 'Bad Request',
182 401: 'Unauthorized',
183 402: 'Payment Required',
184 403: 'Forbidden',
185 404: 'Not Found',
186 405: 'Method Not Allowed',
187 406: 'Not Acceptable',
188 407: 'Proxy Authentication Required',
189 408: 'Request Timeout',
190 409: 'Conflict',
191 410: 'Gone',
192 411: 'Length Required',
193 412: 'Precondition Failed',
194 413: 'Request Entity Too Large',
195 414: 'Request-URI Too Long',
196 415: 'Unsupported Media Type',
197 416: 'Requested Range Not Satisfiable',
198 417: 'Expectation Failed',
Hynek Schlawack51b2ed52012-05-16 09:51:07 +0200199 428: 'Precondition Required',
200 429: 'Too Many Requests',
201 431: 'Request Header Fields Too Large',
Georg Brandl6aab16e2006-02-17 19:17:25 +0000202
203 500: 'Internal Server Error',
204 501: 'Not Implemented',
205 502: 'Bad Gateway',
206 503: 'Service Unavailable',
207 504: 'Gateway Timeout',
208 505: 'HTTP Version Not Supported',
Hynek Schlawack51b2ed52012-05-16 09:51:07 +0200209 511: 'Network Authentication Required',
Georg Brandl6aab16e2006-02-17 19:17:25 +0000210}
211
Georg Brandl80ba8e82005-09-29 20:16:07 +0000212# maximal amount of data to read at one time in _safe_read
213MAXAMOUNT = 1048576
214
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000215# maximal line length when calling readline().
216_MAXLINE = 65536
217
Barry Warsaw820c1202008-06-12 04:06:45 +0000218class HTTPMessage(email.message.Message):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000219 # XXX The only usage of this method is in
220 # http.server.CGIHTTPRequestHandler. Maybe move the code there so
221 # that it doesn't need to be part of the public API. The API has
222 # never been defined so this could cause backwards compatibility
223 # issues.
224
Barry Warsaw820c1202008-06-12 04:06:45 +0000225 def getallmatchingheaders(self, name):
226 """Find all header lines matching a given header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000227
Barry Warsaw820c1202008-06-12 04:06:45 +0000228 Look through the list of headers and find all lines matching a given
229 header name (and their continuation lines). A list of the lines is
230 returned, without interpretation. If the header does not occur, an
231 empty list is returned. If the header occurs multiple times, all
232 occurrences are returned. Case is not important in the header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000233
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000234 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000235 name = name.lower() + ':'
236 n = len(name)
237 lst = []
238 hit = 0
239 for line in self.keys():
240 if line[:n].lower() == name:
241 hit = 1
242 elif not line[:1].isspace():
243 hit = 0
244 if hit:
245 lst.append(line)
246 return lst
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000247
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000248def parse_headers(fp, _class=HTTPMessage):
Barry Warsaw820c1202008-06-12 04:06:45 +0000249 """Parses only RFC2822 headers from a file pointer.
250
251 email Parser wants to see strings rather than bytes.
252 But a TextIOWrapper around self.rfile would buffer too many bytes
253 from the stream, bytes which we later need to read as bytes.
254 So we read the correct bytes here, as bytes, for email Parser
255 to parse.
256
257 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000258 headers = []
259 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000260 line = fp.readline(_MAXLINE + 1)
261 if len(line) > _MAXLINE:
262 raise LineTooLong("header line")
Barry Warsaw820c1202008-06-12 04:06:45 +0000263 headers.append(line)
264 if line in (b'\r\n', b'\n', b''):
265 break
266 hstring = b''.join(headers).decode('iso-8859-1')
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000267 return email.parser.Parser(_class=_class).parsestr(hstring)
Greg Stein5e0fa402000-06-26 08:28:01 +0000268
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000269
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000270_strict_sentinel = object()
271
272class HTTPResponse(io.RawIOBase):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000273
274 # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details.
275
Jeremy Hylton811fc142007-08-03 13:30:02 +0000276 # The bytes from the socket object are iso-8859-1 strings.
277 # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded
278 # text following RFC 2047. The basic status line parsing only
279 # accepts iso-8859-1.
280
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000281 def __init__(self, sock, debuglevel=0, strict=_strict_sentinel, method=None, url=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000282 # If the response includes a content-length header, we need to
283 # make sure that the client doesn't read more than the
Jeremy Hylton39b198d2007-08-04 19:22:00 +0000284 # specified number of bytes. If it does, it will block until
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000285 # the server times out and closes the connection. This will
286 # happen if a self.fp.read() is done (without a size) whether
287 # self.fp is buffered or not. So, no self.fp.read() by
288 # clients unless they know what they are doing.
Benjamin Petersonf72d9fb2009-02-08 00:29:20 +0000289 self.fp = sock.makefile("rb")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000290 self.debuglevel = debuglevel
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000291 if strict is not _strict_sentinel:
292 warnings.warn("the 'strict' argument isn't supported anymore; "
293 "http.client now always assumes HTTP/1.x compliant servers.",
294 DeprecationWarning, 2)
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000295 self._method = method
Greg Stein5e0fa402000-06-26 08:28:01 +0000296
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000297 # The HTTPResponse object is returned via urllib. The clients
298 # of http and urllib expect different attributes for the
299 # headers. headers is used here and supports urllib. msg is
300 # provided as a backwards compatibility layer for http
301 # clients.
302
303 self.headers = self.msg = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000304
Greg Steindd6eefb2000-07-18 09:09:48 +0000305 # from the Status-Line of the response
Tim Peters07e99cb2001-01-14 23:47:14 +0000306 self.version = _UNKNOWN # HTTP-Version
307 self.status = _UNKNOWN # Status-Code
308 self.reason = _UNKNOWN # Reason-Phrase
Greg Stein5e0fa402000-06-26 08:28:01 +0000309
Tim Peters07e99cb2001-01-14 23:47:14 +0000310 self.chunked = _UNKNOWN # is "chunked" being used?
311 self.chunk_left = _UNKNOWN # bytes left to read in current chunk
312 self.length = _UNKNOWN # number of bytes left in response
313 self.will_close = _UNKNOWN # conn will close at end of response
Greg Stein5e0fa402000-06-26 08:28:01 +0000314
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000315 def _read_status(self):
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000316 line = str(self.fp.readline(_MAXLINE + 1), "iso-8859-1")
317 if len(line) > _MAXLINE:
318 raise LineTooLong("status line")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000319 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000320 print("reply:", repr(line))
Jeremy Hyltonb6769522003-06-29 17:55:05 +0000321 if not line:
322 # Presumably, the server closed the connection before
323 # sending a valid response.
324 raise BadStatusLine(line)
Greg Steindd6eefb2000-07-18 09:09:48 +0000325 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000326 version, status, reason = line.split(None, 2)
Greg Steindd6eefb2000-07-18 09:09:48 +0000327 except ValueError:
328 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000329 version, status = line.split(None, 1)
Greg Steindd6eefb2000-07-18 09:09:48 +0000330 reason = ""
331 except ValueError:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000332 # empty version will cause next test to fail.
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000333 version = ""
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000334 if not version.startswith("HTTP/"):
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000335 self.close()
336 raise BadStatusLine(line)
Greg Stein5e0fa402000-06-26 08:28:01 +0000337
Jeremy Hylton23d40472001-04-13 14:57:08 +0000338 # The status code is a three-digit number
339 try:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000340 status = int(status)
Jeremy Hylton23d40472001-04-13 14:57:08 +0000341 if status < 100 or status > 999:
342 raise BadStatusLine(line)
343 except ValueError:
344 raise BadStatusLine(line)
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000345 return version, status, reason
Greg Stein5e0fa402000-06-26 08:28:01 +0000346
Jeremy Hylton39c03802002-07-12 14:04:09 +0000347 def begin(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000348 if self.headers is not None:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000349 # we've already started reading the response
350 return
351
352 # read until we get a non-100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000353 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000354 version, status, reason = self._read_status()
Martin v. Löwis39a31782004-09-18 09:03:49 +0000355 if status != CONTINUE:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000356 break
357 # skip the header from the 100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000358 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000359 skip = self.fp.readline(_MAXLINE + 1)
360 if len(skip) > _MAXLINE:
361 raise LineTooLong("header line")
362 skip = skip.strip()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000363 if not skip:
364 break
365 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000366 print("header:", skip)
Tim Petersc411dba2002-07-16 21:35:23 +0000367
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000368 self.code = self.status = status
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000369 self.reason = reason.strip()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000370 if version in ("HTTP/1.0", "HTTP/0.9"):
371 # Some servers might still return "0.9", treat it as 1.0 anyway
Greg Steindd6eefb2000-07-18 09:09:48 +0000372 self.version = 10
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000373 elif version.startswith("HTTP/1."):
Tim Peters07e99cb2001-01-14 23:47:14 +0000374 self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1
Greg Steindd6eefb2000-07-18 09:09:48 +0000375 else:
376 raise UnknownProtocol(version)
Greg Stein5e0fa402000-06-26 08:28:01 +0000377
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000378 self.headers = self.msg = parse_headers(self.fp)
Barry Warsaw820c1202008-06-12 04:06:45 +0000379
Jeremy Hylton30f86742000-09-18 22:50:38 +0000380 if self.debuglevel > 0:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000381 for hdr in self.headers:
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000382 print("header:", hdr, end=" ")
Greg Stein5e0fa402000-06-26 08:28:01 +0000383
Greg Steindd6eefb2000-07-18 09:09:48 +0000384 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000385 tr_enc = self.headers.get("transfer-encoding")
Jeremy Hyltond229b3a2002-09-03 19:24:24 +0000386 if tr_enc and tr_enc.lower() == "chunked":
Jeremy Hylton236156f2008-12-15 03:00:50 +0000387 self.chunked = True
Greg Steindd6eefb2000-07-18 09:09:48 +0000388 self.chunk_left = None
389 else:
Jeremy Hylton236156f2008-12-15 03:00:50 +0000390 self.chunked = False
Greg Stein5e0fa402000-06-26 08:28:01 +0000391
Greg Steindd6eefb2000-07-18 09:09:48 +0000392 # will the connection close at the end of the response?
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000393 self.will_close = self._check_close()
Greg Stein5e0fa402000-06-26 08:28:01 +0000394
Greg Steindd6eefb2000-07-18 09:09:48 +0000395 # do we have a Content-Length?
396 # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked"
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000397 self.length = None
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000398 length = self.headers.get("content-length")
Barry Warsaw820c1202008-06-12 04:06:45 +0000399
400 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000401 tr_enc = self.headers.get("transfer-encoding")
Greg Steindd6eefb2000-07-18 09:09:48 +0000402 if length and not self.chunked:
Jeremy Hylton30a81812000-09-14 20:34:27 +0000403 try:
404 self.length = int(length)
405 except ValueError:
Christian Heimesa612dc02008-02-24 13:08:18 +0000406 self.length = None
407 else:
408 if self.length < 0: # ignore nonsensical negative lengths
409 self.length = None
410 else:
411 self.length = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000412
Greg Steindd6eefb2000-07-18 09:09:48 +0000413 # does the body have a fixed length? (of zero)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000414 if (status == NO_CONTENT or status == NOT_MODIFIED or
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000415 100 <= status < 200 or # 1xx codes
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000416 self._method == "HEAD"):
Greg Steindd6eefb2000-07-18 09:09:48 +0000417 self.length = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000418
Greg Steindd6eefb2000-07-18 09:09:48 +0000419 # if the connection remains open, and we aren't using chunked, and
420 # a content-length was not provided, then assume that the connection
421 # WILL close.
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000422 if (not self.will_close and
423 not self.chunked and
424 self.length is None):
Jeremy Hylton236156f2008-12-15 03:00:50 +0000425 self.will_close = True
Greg Stein5e0fa402000-06-26 08:28:01 +0000426
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000427 def _check_close(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000428 conn = self.headers.get("connection")
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000429 if self.version == 11:
430 # An HTTP/1.1 proxy is assumed to stay open unless
431 # explicitly closed.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000432 conn = self.headers.get("connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000433 if conn and "close" in conn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000434 return True
435 return False
436
Jeremy Hylton2c178252004-08-07 16:28:14 +0000437 # Some HTTP/1.0 implementations have support for persistent
438 # connections, using rules different than HTTP/1.1.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000439
Christian Heimes895627f2007-12-08 17:28:33 +0000440 # For older HTTP, Keep-Alive indicates persistent connection.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000441 if self.headers.get("keep-alive"):
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000442 return False
Tim Peters77c06fb2002-11-24 02:35:35 +0000443
Jeremy Hylton2c178252004-08-07 16:28:14 +0000444 # At least Akamai returns a "Connection: Keep-Alive" header,
445 # which was supposed to be sent by the client.
446 if conn and "keep-alive" in conn.lower():
447 return False
448
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000449 # Proxy-Connection is a netscape hack.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000450 pconn = self.headers.get("proxy-connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000451 if pconn and "keep-alive" in pconn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000452 return False
453
454 # otherwise, assume it will close
455 return True
456
Greg Steindd6eefb2000-07-18 09:09:48 +0000457 def close(self):
458 if self.fp:
459 self.fp.close()
460 self.fp = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000461
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000462 # These implementations are for the benefit of io.BufferedReader.
463
464 # XXX This class should probably be revised to act more like
465 # the "raw stream" that BufferedReader expects.
466
467 @property
468 def closed(self):
469 return self.isclosed()
470
471 def flush(self):
472 self.fp.flush()
473
Jeremy Hyltona7cff022009-04-01 02:35:56 +0000474 def readable(self):
475 return True
476
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000477 # End of "raw stream" methods
478
Greg Steindd6eefb2000-07-18 09:09:48 +0000479 def isclosed(self):
480 # NOTE: it is possible that we will not ever call self.close(). This
481 # case occurs when will_close is TRUE, length is None, and we
482 # read up to the last byte, but NOT past it.
483 #
484 # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be
485 # called, meaning self.isclosed() is meaningful.
486 return self.fp is None
487
488 def read(self, amt=None):
489 if self.fp is None:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000490 return b""
Greg Steindd6eefb2000-07-18 09:09:48 +0000491
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000492 if self._method == "HEAD":
Senthil Kumaran447f82f2010-06-04 16:38:00 +0000493 self.close()
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000494 return b""
495
Antoine Pitrou38d96432011-12-06 22:33:57 +0100496 if amt is not None:
497 # Amount is given, so call base class version
498 # (which is implemented in terms of self.readinto)
499 return super(HTTPResponse, self).read(amt)
500 else:
501 # Amount is not given (unbounded read) so we must check self.length
502 # and self.chunked
Tim Peters230a60c2002-11-09 05:08:07 +0000503
Antoine Pitrou38d96432011-12-06 22:33:57 +0100504 if self.chunked:
505 return self._readall_chunked()
506
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000507 if self.length is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000508 s = self.fp.read()
509 else:
510 s = self._safe_read(self.length)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000511 self.length = 0
Tim Peters07e99cb2001-01-14 23:47:14 +0000512 self.close() # we read everything
Greg Steindd6eefb2000-07-18 09:09:48 +0000513 return s
514
Antoine Pitrou38d96432011-12-06 22:33:57 +0100515 def readinto(self, b):
516 if self.fp is None:
517 return 0
518
519 if self._method == "HEAD":
520 self.close()
521 return 0
522
523 if self.chunked:
524 return self._readinto_chunked(b)
525
Greg Steindd6eefb2000-07-18 09:09:48 +0000526 if self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100527 if len(b) > self.length:
Greg Steindd6eefb2000-07-18 09:09:48 +0000528 # clip the read to the "end of response"
Antoine Pitrou38d96432011-12-06 22:33:57 +0100529 b = memoryview(b)[0:self.length]
Greg Steindd6eefb2000-07-18 09:09:48 +0000530
531 # we do not use _safe_read() here because this may be a .will_close
532 # connection, and the user is reading more bytes than will be provided
533 # (for example, reading in 1k chunks)
Antoine Pitrou38d96432011-12-06 22:33:57 +0100534 n = self.fp.readinto(b)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000535 if self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100536 self.length -= n
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000537 if not self.length:
538 self.close()
Antoine Pitrou084daa22012-12-15 19:11:54 +0100539 else:
Antoine Pitroud20e7742012-12-15 19:22:30 +0100540 if not n:
Antoine Pitrou084daa22012-12-15 19:11:54 +0100541 self.close()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100542 return n
Greg Steindd6eefb2000-07-18 09:09:48 +0000543
Antoine Pitrou38d96432011-12-06 22:33:57 +0100544 def _read_next_chunk_size(self):
545 # Read the next chunk size from the file
546 line = self.fp.readline(_MAXLINE + 1)
547 if len(line) > _MAXLINE:
548 raise LineTooLong("chunk size")
549 i = line.find(b";")
550 if i >= 0:
551 line = line[:i] # strip chunk-extensions
552 try:
553 return int(line, 16)
554 except ValueError:
555 # close the connection as protocol synchronisation is
556 # probably lost
557 self.close()
558 raise
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000559
Antoine Pitrou38d96432011-12-06 22:33:57 +0100560 def _read_and_discard_trailer(self):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000561 # read and discard trailer up to the CRLF terminator
562 ### note: we shouldn't have any trailers!
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000563 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000564 line = self.fp.readline(_MAXLINE + 1)
565 if len(line) > _MAXLINE:
566 raise LineTooLong("trailer line")
Christian Heimes0bd4e112008-02-12 22:59:25 +0000567 if not line:
568 # a vanishingly small number of sites EOF without
569 # sending the trailer
570 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800571 if line in (b'\r\n', b'\n', b''):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000572 break
573
Antoine Pitrou38d96432011-12-06 22:33:57 +0100574 def _readall_chunked(self):
575 assert self.chunked != _UNKNOWN
576 chunk_left = self.chunk_left
577 value = []
578 while True:
579 if chunk_left is None:
580 try:
581 chunk_left = self._read_next_chunk_size()
582 if chunk_left == 0:
583 break
584 except ValueError:
585 raise IncompleteRead(b''.join(value))
586 value.append(self._safe_read(chunk_left))
587
588 # we read the whole chunk, get another
589 self._safe_read(2) # toss the CRLF at the end of the chunk
590 chunk_left = None
591
592 self._read_and_discard_trailer()
593
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000594 # we read everything; close the "file"
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000595 self.close()
596
Chris Withers9c33cbf2009-09-04 17:04:16 +0000597 return b''.join(value)
Tim Peters230a60c2002-11-09 05:08:07 +0000598
Antoine Pitrou38d96432011-12-06 22:33:57 +0100599 def _readinto_chunked(self, b):
600 assert self.chunked != _UNKNOWN
601 chunk_left = self.chunk_left
602
603 total_bytes = 0
604 mvb = memoryview(b)
605 while True:
606 if chunk_left is None:
607 try:
608 chunk_left = self._read_next_chunk_size()
609 if chunk_left == 0:
610 break
611 except ValueError:
612 raise IncompleteRead(bytes(b[0:total_bytes]))
Antoine Pitrou4ce6aa42011-12-06 22:34:36 +0100613
Antoine Pitrou38d96432011-12-06 22:33:57 +0100614 if len(mvb) < chunk_left:
615 n = self._safe_readinto(mvb)
616 self.chunk_left = chunk_left - n
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100617 return total_bytes + n
Antoine Pitrou38d96432011-12-06 22:33:57 +0100618 elif len(mvb) == chunk_left:
619 n = self._safe_readinto(mvb)
620 self._safe_read(2) # toss the CRLF at the end of the chunk
621 self.chunk_left = None
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100622 return total_bytes + n
Antoine Pitrou38d96432011-12-06 22:33:57 +0100623 else:
624 temp_mvb = mvb[0:chunk_left]
625 n = self._safe_readinto(temp_mvb)
626 mvb = mvb[n:]
627 total_bytes += n
628
629 # we read the whole chunk, get another
630 self._safe_read(2) # toss the CRLF at the end of the chunk
631 chunk_left = None
632
633 self._read_and_discard_trailer()
634
635 # we read everything; close the "file"
636 self.close()
637
638 return total_bytes
639
Greg Steindd6eefb2000-07-18 09:09:48 +0000640 def _safe_read(self, amt):
641 """Read the number of bytes requested, compensating for partial reads.
642
643 Normally, we have a blocking socket, but a read() can be interrupted
644 by a signal (resulting in a partial read).
645
646 Note that we cannot distinguish between EOF and an interrupt when zero
647 bytes have been read. IncompleteRead() will be raised in this
648 situation.
649
650 This function should be used when <amt> bytes "should" be present for
651 reading. If the bytes are truly not available (due to EOF), then the
652 IncompleteRead exception can be used to detect the problem.
653 """
Georg Brandl80ba8e82005-09-29 20:16:07 +0000654 s = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000655 while amt > 0:
Georg Brandl80ba8e82005-09-29 20:16:07 +0000656 chunk = self.fp.read(min(amt, MAXAMOUNT))
Greg Steindd6eefb2000-07-18 09:09:48 +0000657 if not chunk:
Benjamin Peterson6accb982009-03-02 22:50:25 +0000658 raise IncompleteRead(b''.join(s), amt)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000659 s.append(chunk)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000660 amt -= len(chunk)
Guido van Rossuma00f1232007-09-12 19:43:09 +0000661 return b"".join(s)
Greg Steindd6eefb2000-07-18 09:09:48 +0000662
Antoine Pitrou38d96432011-12-06 22:33:57 +0100663 def _safe_readinto(self, b):
664 """Same as _safe_read, but for reading into a buffer."""
665 total_bytes = 0
666 mvb = memoryview(b)
667 while total_bytes < len(b):
668 if MAXAMOUNT < len(mvb):
669 temp_mvb = mvb[0:MAXAMOUNT]
670 n = self.fp.readinto(temp_mvb)
671 else:
672 n = self.fp.readinto(mvb)
673 if not n:
674 raise IncompleteRead(bytes(mvb[0:total_bytes]), len(b))
675 mvb = mvb[n:]
676 total_bytes += n
677 return total_bytes
678
Antoine Pitroub353c122009-02-11 00:39:14 +0000679 def fileno(self):
680 return self.fp.fileno()
681
Greg Steindd6eefb2000-07-18 09:09:48 +0000682 def getheader(self, name, default=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000683 if self.headers is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000684 raise ResponseNotReady()
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000685 headers = self.headers.get_all(name) or default
686 if isinstance(headers, str) or not hasattr(headers, '__iter__'):
687 return headers
688 else:
689 return ', '.join(headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000690
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000691 def getheaders(self):
692 """Return list of (header, value) tuples."""
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000693 if self.headers is None:
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000694 raise ResponseNotReady()
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000695 return list(self.headers.items())
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000696
Antoine Pitroub353c122009-02-11 00:39:14 +0000697 # We override IOBase.__iter__ so that it doesn't check for closed-ness
698
699 def __iter__(self):
700 return self
701
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000702 # For compatibility with old-style urllib responses.
703
704 def info(self):
705 return self.headers
706
707 def geturl(self):
708 return self.url
709
710 def getcode(self):
711 return self.status
Greg Stein5e0fa402000-06-26 08:28:01 +0000712
713class HTTPConnection:
714
Greg Steindd6eefb2000-07-18 09:09:48 +0000715 _http_vsn = 11
716 _http_vsn_str = 'HTTP/1.1'
Greg Stein5e0fa402000-06-26 08:28:01 +0000717
Greg Steindd6eefb2000-07-18 09:09:48 +0000718 response_class = HTTPResponse
719 default_port = HTTP_PORT
720 auto_open = 1
Jeremy Hylton30f86742000-09-18 22:50:38 +0000721 debuglevel = 0
Antoine Pitrou90e47742013-01-02 22:10:47 +0100722 # TCP Maximum Segment Size (MSS) is determined by the TCP stack on
723 # a per-connection basis. There is no simple and efficient
724 # platform independent mechanism for determining the MSS, so
725 # instead a reasonable estimate is chosen. The getsockopt()
726 # interface using the TCP_MAXSEG parameter may be a suitable
727 # approach on some operating systems. A value of 16KiB is chosen
728 # as a reasonable estimate of the maximum MSS.
729 mss = 16384
Greg Stein5e0fa402000-06-26 08:28:01 +0000730
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000731 def __init__(self, host, port=None, strict=_strict_sentinel,
Gregory P. Smithb4066372010-01-03 03:28:29 +0000732 timeout=socket._GLOBAL_DEFAULT_TIMEOUT, source_address=None):
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000733 if strict is not _strict_sentinel:
734 warnings.warn("the 'strict' argument isn't supported anymore; "
735 "http.client now always assumes HTTP/1.x compliant servers.",
736 DeprecationWarning, 2)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000737 self.timeout = timeout
Gregory P. Smithb4066372010-01-03 03:28:29 +0000738 self.source_address = source_address
Greg Steindd6eefb2000-07-18 09:09:48 +0000739 self.sock = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000740 self._buffer = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000741 self.__response = None
742 self.__state = _CS_IDLE
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000743 self._method = None
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000744 self._tunnel_host = None
745 self._tunnel_port = None
Georg Brandlc7c199f2011-01-22 22:06:24 +0000746 self._tunnel_headers = {}
Tim Petersc411dba2002-07-16 21:35:23 +0000747
Greg Steindd6eefb2000-07-18 09:09:48 +0000748 self._set_hostport(host, port)
Greg Stein5e0fa402000-06-26 08:28:01 +0000749
Senthil Kumaran47fff872009-12-20 07:10:31 +0000750 def set_tunnel(self, host, port=None, headers=None):
751 """ Sets up the host and the port for the HTTP CONNECT Tunnelling.
752
753 The headers argument should be a mapping of extra HTTP headers
754 to send with the CONNECT request.
755 """
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000756 self._tunnel_host = host
757 self._tunnel_port = port
Senthil Kumaran47fff872009-12-20 07:10:31 +0000758 if headers:
759 self._tunnel_headers = headers
760 else:
761 self._tunnel_headers.clear()
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000762
Greg Steindd6eefb2000-07-18 09:09:48 +0000763 def _set_hostport(self, host, port):
764 if port is None:
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000765 i = host.rfind(':')
Skip Montanarocae14d22004-09-14 17:55:21 +0000766 j = host.rfind(']') # ipv6 addresses have [...]
767 if i > j:
Skip Montanaro9d389972002-03-24 16:53:50 +0000768 try:
769 port = int(host[i+1:])
770 except ValueError:
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200771 if host[i+1:] == "": # http://foo.com:/ == http://foo.com/
772 port = self.default_port
773 else:
774 raise InvalidURL("nonnumeric port: '%s'" % host[i+1:])
Greg Steindd6eefb2000-07-18 09:09:48 +0000775 host = host[:i]
776 else:
777 port = self.default_port
Raymond Hettinger4d037912004-10-14 15:23:38 +0000778 if host and host[0] == '[' and host[-1] == ']':
Brett Cannon0a1af4a2004-09-15 23:26:23 +0000779 host = host[1:-1]
Greg Steindd6eefb2000-07-18 09:09:48 +0000780 self.host = host
781 self.port = port
Greg Stein5e0fa402000-06-26 08:28:01 +0000782
Jeremy Hylton30f86742000-09-18 22:50:38 +0000783 def set_debuglevel(self, level):
784 self.debuglevel = level
785
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000786 def _tunnel(self):
787 self._set_hostport(self._tunnel_host, self._tunnel_port)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000788 connect_str = "CONNECT %s:%d HTTP/1.0\r\n" % (self.host, self.port)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000789 connect_bytes = connect_str.encode("ascii")
790 self.send(connect_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000791 for header, value in self._tunnel_headers.items():
Senthil Kumaran47fff872009-12-20 07:10:31 +0000792 header_str = "%s: %s\r\n" % (header, value)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000793 header_bytes = header_str.encode("latin-1")
Senthil Kumaran47fff872009-12-20 07:10:31 +0000794 self.send(header_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000795 self.send(b'\r\n')
Senthil Kumaran47fff872009-12-20 07:10:31 +0000796
Georg Brandlc7c199f2011-01-22 22:06:24 +0000797 response = self.response_class(self.sock, method=self._method)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000798 (version, code, message) = response._read_status()
Senthil Kumaran47fff872009-12-20 07:10:31 +0000799
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000800 if code != 200:
801 self.close()
Andrew Svetlov0832af62012-12-18 23:10:48 +0200802 raise OSError("Tunnel connection failed: %d %s" % (code,
803 message.strip()))
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000804 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000805 line = response.fp.readline(_MAXLINE + 1)
806 if len(line) > _MAXLINE:
807 raise LineTooLong("header line")
Senthil Kumaranb12771a2012-04-23 23:50:07 +0800808 if not line:
809 # for sites which EOF without sending a trailer
810 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800811 if line in (b'\r\n', b'\n', b''):
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000812 break
813
Greg Steindd6eefb2000-07-18 09:09:48 +0000814 def connect(self):
815 """Connect to the host and port specified in __init__."""
Guido van Rossumd8faa362007-04-27 19:54:29 +0000816 self.sock = socket.create_connection((self.host,self.port),
Gregory P. Smithb4066372010-01-03 03:28:29 +0000817 self.timeout, self.source_address)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000818 if self._tunnel_host:
819 self._tunnel()
Greg Stein5e0fa402000-06-26 08:28:01 +0000820
Greg Steindd6eefb2000-07-18 09:09:48 +0000821 def close(self):
822 """Close the connection to the HTTP server."""
823 if self.sock:
Tim Peters07e99cb2001-01-14 23:47:14 +0000824 self.sock.close() # close it manually... there may be other refs
Greg Steindd6eefb2000-07-18 09:09:48 +0000825 self.sock = None
826 if self.__response:
827 self.__response.close()
828 self.__response = None
829 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000830
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000831 def send(self, data):
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000832 """Send `data' to the server.
833 ``data`` can be a string object, a bytes object, an array object, a
834 file-like object that supports a .read() method, or an iterable object.
835 """
836
Greg Steindd6eefb2000-07-18 09:09:48 +0000837 if self.sock is None:
838 if self.auto_open:
839 self.connect()
840 else:
841 raise NotConnected()
Greg Stein5e0fa402000-06-26 08:28:01 +0000842
Jeremy Hylton30f86742000-09-18 22:50:38 +0000843 if self.debuglevel > 0:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000844 print("send:", repr(data))
Jeremy Hylton636950f2009-03-28 04:34:21 +0000845 blocksize = 8192
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000846 if hasattr(data, "read") :
Jeremy Hylton636950f2009-03-28 04:34:21 +0000847 if self.debuglevel > 0:
848 print("sendIng a read()able")
849 encode = False
Antoine Pitrouead1d622009-09-29 18:44:53 +0000850 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000851 mode = data.mode
Antoine Pitrouead1d622009-09-29 18:44:53 +0000852 except AttributeError:
853 # io.BytesIO and other file-like objects don't have a `mode`
854 # attribute.
855 pass
856 else:
857 if "b" not in mode:
858 encode = True
859 if self.debuglevel > 0:
860 print("encoding file using iso-8859-1")
Jeremy Hylton636950f2009-03-28 04:34:21 +0000861 while 1:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000862 datablock = data.read(blocksize)
863 if not datablock:
Jeremy Hylton636950f2009-03-28 04:34:21 +0000864 break
865 if encode:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000866 datablock = datablock.encode("iso-8859-1")
867 self.sock.sendall(datablock)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000868
869 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000870 self.sock.sendall(data)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000871 except TypeError:
872 if isinstance(data, collections.Iterable):
873 for d in data:
874 self.sock.sendall(d)
875 else:
Georg Brandl25e2cd12011-08-03 08:27:00 +0200876 raise TypeError("data should be a bytes-like object "
877 "or an iterable, got %r" % type(data))
Greg Stein5e0fa402000-06-26 08:28:01 +0000878
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000879 def _output(self, s):
880 """Add a line of output to the current request buffer.
Tim Peters469cdad2002-08-08 20:19:19 +0000881
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000882 Assumes that the line does *not* end with \\r\\n.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000883 """
884 self._buffer.append(s)
885
Benjamin Peterson1742e402008-11-30 22:15:29 +0000886 def _send_output(self, message_body=None):
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000887 """Send the currently buffered request and clear the buffer.
888
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000889 Appends an extra \\r\\n to the buffer.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000890 A message_body may be specified, to be appended to the request.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000891 """
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000892 self._buffer.extend((b"", b""))
893 msg = b"\r\n".join(self._buffer)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000894 del self._buffer[:]
Benjamin Peterson1742e402008-11-30 22:15:29 +0000895 # If msg and message_body are sent in a single send() call,
896 # it will avoid performance problems caused by the interaction
Antoine Pitrou90e47742013-01-02 22:10:47 +0100897 # between delayed ack and the Nagle algorithm. However,
898 # there is no performance gain if the message is larger
899 # than MSS (and there is a memory penalty for the message
900 # copy).
901 if isinstance(message_body, bytes) and len(message_body) < self.mss:
Benjamin Peterson1742e402008-11-30 22:15:29 +0000902 msg += message_body
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000903 message_body = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000904 self.send(msg)
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000905 if message_body is not None:
Jeremy Hylton236654b2009-03-27 20:24:34 +0000906 # message_body was not a string (i.e. it is a file), and
907 # we must run the risk of Nagle.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000908 self.send(message_body)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000909
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000910 def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0):
Greg Steindd6eefb2000-07-18 09:09:48 +0000911 """Send a request to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000912
Greg Steindd6eefb2000-07-18 09:09:48 +0000913 `method' specifies an HTTP request method, e.g. 'GET'.
914 `url' specifies the object being requested, e.g. '/index.html'.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000915 `skip_host' if True does not add automatically a 'Host:' header
916 `skip_accept_encoding' if True does not add automatically an
917 'Accept-Encoding:' header
Greg Steindd6eefb2000-07-18 09:09:48 +0000918 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000919
Greg Stein616a58d2003-06-24 06:35:19 +0000920 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000921 if self.__response and self.__response.isclosed():
922 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000923
Tim Peters58eb11c2004-01-18 20:29:55 +0000924
Greg Steindd6eefb2000-07-18 09:09:48 +0000925 # in certain cases, we cannot issue another request on this connection.
926 # this occurs when:
927 # 1) we are in the process of sending a request. (_CS_REQ_STARTED)
928 # 2) a response to a previous request has signalled that it is going
929 # to close the connection upon completion.
930 # 3) the headers for the previous response have not been read, thus
931 # we cannot determine whether point (2) is true. (_CS_REQ_SENT)
932 #
933 # if there is no prior response, then we can request at will.
934 #
935 # if point (2) is true, then we will have passed the socket to the
936 # response (effectively meaning, "there is no prior response"), and
937 # will open a new one when a new request is made.
938 #
939 # Note: if a prior response exists, then we *can* start a new request.
940 # We are not allowed to begin fetching the response to this new
941 # request, however, until that prior response is complete.
942 #
943 if self.__state == _CS_IDLE:
944 self.__state = _CS_REQ_STARTED
945 else:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000946 raise CannotSendRequest(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +0000947
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000948 # Save the method we use, we need it later in the response phase
949 self._method = method
Greg Steindd6eefb2000-07-18 09:09:48 +0000950 if not url:
951 url = '/'
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000952 request = '%s %s %s' % (method, url, self._http_vsn_str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000953
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000954 # Non-ASCII characters should have been eliminated earlier
955 self._output(request.encode('ascii'))
Greg Stein5e0fa402000-06-26 08:28:01 +0000956
Greg Steindd6eefb2000-07-18 09:09:48 +0000957 if self._http_vsn == 11:
958 # Issue some standard headers for better HTTP/1.1 compliance
Greg Stein5e0fa402000-06-26 08:28:01 +0000959
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000960 if not skip_host:
961 # this header is issued *only* for HTTP/1.1
962 # connections. more specifically, this means it is
963 # only issued when the client uses the new
964 # HTTPConnection() class. backwards-compat clients
965 # will be using HTTP/1.0 and those clients may be
966 # issuing this header themselves. we should NOT issue
967 # it twice; some web servers (such as Apache) barf
968 # when they see two Host: headers
Guido van Rossumf6922aa2001-01-14 21:03:01 +0000969
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000970 # If we need a non-standard port,include it in the
971 # header. If the request is going through a proxy,
972 # but the host of the actual URL, not the host of the
973 # proxy.
Jeremy Hylton8acf1e02002-03-08 19:35:51 +0000974
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000975 netloc = ''
976 if url.startswith('http'):
977 nil, netloc, nil, nil, nil = urlsplit(url)
978
979 if netloc:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000980 try:
981 netloc_enc = netloc.encode("ascii")
982 except UnicodeEncodeError:
983 netloc_enc = netloc.encode("idna")
984 self.putheader('Host', netloc_enc)
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000985 else:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000986 try:
987 host_enc = self.host.encode("ascii")
988 except UnicodeEncodeError:
989 host_enc = self.host.encode("idna")
Senthil Kumaran74ebd9e2010-11-13 12:27:49 +0000990
991 # As per RFC 273, IPv6 address should be wrapped with []
992 # when used as Host header
993
994 if self.host.find(':') >= 0:
995 host_enc = b'[' + host_enc + b']'
996
Georg Brandl86b2fb92008-07-16 03:43:04 +0000997 if self.port == self.default_port:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000998 self.putheader('Host', host_enc)
999 else:
Guido van Rossum98297ee2007-11-06 21:34:58 +00001000 host_enc = host_enc.decode("ascii")
Thomas Wouters477c8d52006-05-27 19:21:47 +00001001 self.putheader('Host', "%s:%s" % (host_enc, self.port))
Greg Stein5e0fa402000-06-26 08:28:01 +00001002
Greg Steindd6eefb2000-07-18 09:09:48 +00001003 # note: we are assuming that clients will not attempt to set these
1004 # headers since *this* library must deal with the
1005 # consequences. this also means that when the supporting
1006 # libraries are updated to recognize other forms, then this
1007 # code should be changed (removed or updated).
Greg Stein5e0fa402000-06-26 08:28:01 +00001008
Greg Steindd6eefb2000-07-18 09:09:48 +00001009 # we only want a Content-Encoding of "identity" since we don't
1010 # support encodings such as x-gzip or x-deflate.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +00001011 if not skip_accept_encoding:
1012 self.putheader('Accept-Encoding', 'identity')
Greg Stein5e0fa402000-06-26 08:28:01 +00001013
Greg Steindd6eefb2000-07-18 09:09:48 +00001014 # we can accept "chunked" Transfer-Encodings, but no others
1015 # NOTE: no TE header implies *only* "chunked"
1016 #self.putheader('TE', 'chunked')
Greg Stein5e0fa402000-06-26 08:28:01 +00001017
Greg Steindd6eefb2000-07-18 09:09:48 +00001018 # if TE is supplied in the header, then it must appear in a
1019 # Connection header.
1020 #self.putheader('Connection', 'TE')
Greg Stein5e0fa402000-06-26 08:28:01 +00001021
Greg Steindd6eefb2000-07-18 09:09:48 +00001022 else:
1023 # For HTTP/1.0, the server will assume "not chunked"
1024 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001025
Benjamin Petersonf608c612008-11-16 18:33:53 +00001026 def putheader(self, header, *values):
Greg Steindd6eefb2000-07-18 09:09:48 +00001027 """Send a request header line to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001028
Greg Steindd6eefb2000-07-18 09:09:48 +00001029 For example: h.putheader('Accept', 'text/html')
1030 """
1031 if self.__state != _CS_REQ_STARTED:
1032 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +00001033
Guido van Rossum98297ee2007-11-06 21:34:58 +00001034 if hasattr(header, 'encode'):
1035 header = header.encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +00001036 values = list(values)
1037 for i, one_value in enumerate(values):
1038 if hasattr(one_value, 'encode'):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001039 values[i] = one_value.encode('latin-1')
Senthil Kumaran58d5dbf2010-10-03 18:22:42 +00001040 elif isinstance(one_value, int):
1041 values[i] = str(one_value).encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +00001042 value = b'\r\n\t'.join(values)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001043 header = header + b': ' + value
1044 self._output(header)
Greg Stein5e0fa402000-06-26 08:28:01 +00001045
Benjamin Peterson1742e402008-11-30 22:15:29 +00001046 def endheaders(self, message_body=None):
1047 """Indicate that the last header line has been sent to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001048
Senthil Kumaranad87fa62011-10-05 23:26:49 +08001049 This method sends the request to the server. The optional message_body
1050 argument can be used to pass a message body associated with the
1051 request. The message body will be sent in the same packet as the
1052 message headers if it is a string, otherwise it is sent as a separate
1053 packet.
Benjamin Peterson1742e402008-11-30 22:15:29 +00001054 """
Greg Steindd6eefb2000-07-18 09:09:48 +00001055 if self.__state == _CS_REQ_STARTED:
1056 self.__state = _CS_REQ_SENT
1057 else:
1058 raise CannotSendHeader()
Benjamin Peterson1742e402008-11-30 22:15:29 +00001059 self._send_output(message_body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001060
Greg Steindd6eefb2000-07-18 09:09:48 +00001061 def request(self, method, url, body=None, headers={}):
1062 """Send a complete request to the server."""
Jeremy Hylton636950f2009-03-28 04:34:21 +00001063 self._send_request(method, url, body, headers)
Greg Stein5e0fa402000-06-26 08:28:01 +00001064
Benjamin Peterson1742e402008-11-30 22:15:29 +00001065 def _set_content_length(self, body):
1066 # Set the content-length based on the body.
1067 thelen = None
1068 try:
1069 thelen = str(len(body))
1070 except TypeError as te:
1071 # If this is a file-like object, try to
1072 # fstat its file descriptor
Benjamin Peterson1742e402008-11-30 22:15:29 +00001073 try:
1074 thelen = str(os.fstat(body.fileno()).st_size)
1075 except (AttributeError, OSError):
1076 # Don't send a length if this failed
1077 if self.debuglevel > 0: print("Cannot stat!!")
1078
1079 if thelen is not None:
1080 self.putheader('Content-Length', thelen)
1081
Greg Steindd6eefb2000-07-18 09:09:48 +00001082 def _send_request(self, method, url, body, headers):
Jeremy Hylton636950f2009-03-28 04:34:21 +00001083 # Honor explicitly requested Host: and Accept-Encoding: headers.
Jeremy Hylton2c178252004-08-07 16:28:14 +00001084 header_names = dict.fromkeys([k.lower() for k in headers])
1085 skips = {}
1086 if 'host' in header_names:
1087 skips['skip_host'] = 1
1088 if 'accept-encoding' in header_names:
1089 skips['skip_accept_encoding'] = 1
Greg Stein5e0fa402000-06-26 08:28:01 +00001090
Jeremy Hylton2c178252004-08-07 16:28:14 +00001091 self.putrequest(method, url, **skips)
1092
Senthil Kumaran5fa4a892012-05-19 16:58:09 +08001093 if body is not None and ('content-length' not in header_names):
Benjamin Peterson1742e402008-11-30 22:15:29 +00001094 self._set_content_length(body)
Guido van Rossumcc2b0162007-02-11 06:12:03 +00001095 for hdr, value in headers.items():
Greg Steindd6eefb2000-07-18 09:09:48 +00001096 self.putheader(hdr, value)
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001097 if isinstance(body, str):
Jeremy Hylton236654b2009-03-27 20:24:34 +00001098 # RFC 2616 Section 3.7.1 says that text default has a
1099 # default charset of iso-8859-1.
1100 body = body.encode('iso-8859-1')
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001101 self.endheaders(body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001102
Greg Steindd6eefb2000-07-18 09:09:48 +00001103 def getresponse(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001104 """Get the response from the server.
1105
1106 If the HTTPConnection is in the correct state, returns an
1107 instance of HTTPResponse or of whatever object is returned by
1108 class the response_class variable.
1109
1110 If a request has not been sent or if a previous response has
1111 not be handled, ResponseNotReady is raised. If the HTTP
1112 response indicates that the connection should be closed, then
1113 it will be closed before the response is returned. When the
1114 connection is closed, the underlying socket is closed.
1115 """
Greg Stein5e0fa402000-06-26 08:28:01 +00001116
Greg Stein616a58d2003-06-24 06:35:19 +00001117 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +00001118 if self.__response and self.__response.isclosed():
1119 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +00001120
Greg Steindd6eefb2000-07-18 09:09:48 +00001121 # if a prior response exists, then it must be completed (otherwise, we
1122 # cannot read this response's header to determine the connection-close
1123 # behavior)
1124 #
1125 # note: if a prior response existed, but was connection-close, then the
1126 # socket and response were made independent of this HTTPConnection
1127 # object since a new request requires that we open a whole new
1128 # connection
1129 #
1130 # this means the prior response had one of two states:
1131 # 1) will_close: this connection was reset and the prior socket and
1132 # response operate independently
1133 # 2) persistent: the response was retained and we await its
1134 # isclosed() status to become true.
1135 #
1136 if self.__state != _CS_REQ_SENT or self.__response:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001137 raise ResponseNotReady(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +00001138
Jeremy Hylton30f86742000-09-18 22:50:38 +00001139 if self.debuglevel > 0:
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001140 response = self.response_class(self.sock, self.debuglevel,
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +00001141 method=self._method)
Jeremy Hylton30f86742000-09-18 22:50:38 +00001142 else:
Antoine Pitrou988dbd72010-12-17 17:35:56 +00001143 response = self.response_class(self.sock, method=self._method)
Greg Stein5e0fa402000-06-26 08:28:01 +00001144
Jeremy Hylton39c03802002-07-12 14:04:09 +00001145 response.begin()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +00001146 assert response.will_close != _UNKNOWN
Greg Steindd6eefb2000-07-18 09:09:48 +00001147 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +00001148
Greg Steindd6eefb2000-07-18 09:09:48 +00001149 if response.will_close:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001150 # this effectively passes the connection to the response
1151 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +00001152 else:
1153 # remember this, so we can tell when it is complete
1154 self.__response = response
Greg Stein5e0fa402000-06-26 08:28:01 +00001155
Greg Steindd6eefb2000-07-18 09:09:48 +00001156 return response
Greg Stein5e0fa402000-06-26 08:28:01 +00001157
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001158try:
1159 import ssl
1160except ImportError:
1161 pass
1162else:
1163 class HTTPSConnection(HTTPConnection):
1164 "This class allows communication via SSL."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001165
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001166 default_port = HTTPS_PORT
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001167
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001168 # XXX Should key_file and cert_file be deprecated in favour of context?
1169
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001170 def __init__(self, host, port=None, key_file=None, cert_file=None,
Antoine Pitrou988dbd72010-12-17 17:35:56 +00001171 strict=_strict_sentinel, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001172 source_address=None, *, context=None, check_hostname=None):
Gregory P. Smithb4066372010-01-03 03:28:29 +00001173 super(HTTPSConnection, self).__init__(host, port, strict, timeout,
1174 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001175 self.key_file = key_file
1176 self.cert_file = cert_file
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001177 if context is None:
1178 # Some reasonable defaults
1179 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1180 context.options |= ssl.OP_NO_SSLv2
1181 will_verify = context.verify_mode != ssl.CERT_NONE
1182 if check_hostname is None:
1183 check_hostname = will_verify
1184 elif check_hostname and not will_verify:
1185 raise ValueError("check_hostname needs a SSL context with "
1186 "either CERT_OPTIONAL or CERT_REQUIRED")
1187 if key_file or cert_file:
Antoine Pitrou80603992010-10-13 10:45:16 +00001188 context.load_cert_chain(cert_file, key_file)
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001189 self._context = context
1190 self._check_hostname = check_hostname
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001191
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001192 def connect(self):
1193 "Connect to a host on a given (SSL) port."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001194
Jeremy Hylton636950f2009-03-28 04:34:21 +00001195 sock = socket.create_connection((self.host, self.port),
Gregory P. Smithb4066372010-01-03 03:28:29 +00001196 self.timeout, self.source_address)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +00001197
1198 if self._tunnel_host:
1199 self.sock = sock
1200 self._tunnel()
1201
Antoine Pitroud5323212010-10-22 18:19:07 +00001202 server_hostname = self.host if ssl.HAS_SNI else None
1203 self.sock = self._context.wrap_socket(sock,
1204 server_hostname=server_hostname)
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001205 try:
1206 if self._check_hostname:
1207 ssl.match_hostname(self.sock.getpeercert(), self.host)
1208 except Exception:
1209 self.sock.shutdown(socket.SHUT_RDWR)
1210 self.sock.close()
1211 raise
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001212
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001213 __all__.append("HTTPSConnection")
Greg Stein5e0fa402000-06-26 08:28:01 +00001214
Greg Stein5e0fa402000-06-26 08:28:01 +00001215class HTTPException(Exception):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001216 # Subclasses that define an __init__ must call Exception.__init__
1217 # or define self.args. Otherwise, str() will fail.
Greg Steindd6eefb2000-07-18 09:09:48 +00001218 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001219
1220class NotConnected(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001221 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001222
Skip Montanaro9d389972002-03-24 16:53:50 +00001223class InvalidURL(HTTPException):
1224 pass
1225
Greg Stein5e0fa402000-06-26 08:28:01 +00001226class UnknownProtocol(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001227 def __init__(self, version):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001228 self.args = version,
Greg Steindd6eefb2000-07-18 09:09:48 +00001229 self.version = version
Greg Stein5e0fa402000-06-26 08:28:01 +00001230
1231class UnknownTransferEncoding(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001232 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001233
Greg Stein5e0fa402000-06-26 08:28:01 +00001234class UnimplementedFileMode(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001235 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001236
1237class IncompleteRead(HTTPException):
Benjamin Peterson6accb982009-03-02 22:50:25 +00001238 def __init__(self, partial, expected=None):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001239 self.args = partial,
Greg Steindd6eefb2000-07-18 09:09:48 +00001240 self.partial = partial
Benjamin Peterson6accb982009-03-02 22:50:25 +00001241 self.expected = expected
1242 def __repr__(self):
1243 if self.expected is not None:
1244 e = ', %i more expected' % self.expected
1245 else:
1246 e = ''
1247 return 'IncompleteRead(%i bytes read%s)' % (len(self.partial), e)
1248 def __str__(self):
1249 return repr(self)
Greg Stein5e0fa402000-06-26 08:28:01 +00001250
1251class ImproperConnectionState(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001252 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001253
1254class CannotSendRequest(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001255 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001256
1257class CannotSendHeader(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001258 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001259
1260class ResponseNotReady(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001261 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001262
1263class BadStatusLine(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001264 def __init__(self, line):
Benjamin Peterson11dbfd42010-03-21 22:50:04 +00001265 if not line:
1266 line = repr(line)
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001267 self.args = line,
Greg Steindd6eefb2000-07-18 09:09:48 +00001268 self.line = line
Greg Stein5e0fa402000-06-26 08:28:01 +00001269
Senthil Kumaran5466bf12010-12-18 16:55:23 +00001270class LineTooLong(HTTPException):
1271 def __init__(self, line_type):
1272 HTTPException.__init__(self, "got more than %d bytes when reading %s"
1273 % (_MAXLINE, line_type))
1274
Greg Stein5e0fa402000-06-26 08:28:01 +00001275# for backwards compatibility
1276error = HTTPException