blob: cc452e2f52e374ebd6f4e52dc72bb4515e337104 [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
Georg Brandlbf3f8eb2013-10-27 07:34:48 +0100217_MAXHEADERS = 100
218
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000219
Barry Warsaw820c1202008-06-12 04:06:45 +0000220class HTTPMessage(email.message.Message):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000221 # XXX The only usage of this method is in
222 # http.server.CGIHTTPRequestHandler. Maybe move the code there so
223 # that it doesn't need to be part of the public API. The API has
224 # never been defined so this could cause backwards compatibility
225 # issues.
226
Barry Warsaw820c1202008-06-12 04:06:45 +0000227 def getallmatchingheaders(self, name):
228 """Find all header lines matching a given header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000229
Barry Warsaw820c1202008-06-12 04:06:45 +0000230 Look through the list of headers and find all lines matching a given
231 header name (and their continuation lines). A list of the lines is
232 returned, without interpretation. If the header does not occur, an
233 empty list is returned. If the header occurs multiple times, all
234 occurrences are returned. Case is not important in the header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000235
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000236 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000237 name = name.lower() + ':'
238 n = len(name)
239 lst = []
240 hit = 0
241 for line in self.keys():
242 if line[:n].lower() == name:
243 hit = 1
244 elif not line[:1].isspace():
245 hit = 0
246 if hit:
247 lst.append(line)
248 return lst
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000249
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000250def parse_headers(fp, _class=HTTPMessage):
Barry Warsaw820c1202008-06-12 04:06:45 +0000251 """Parses only RFC2822 headers from a file pointer.
252
253 email Parser wants to see strings rather than bytes.
254 But a TextIOWrapper around self.rfile would buffer too many bytes
255 from the stream, bytes which we later need to read as bytes.
256 So we read the correct bytes here, as bytes, for email Parser
257 to parse.
258
259 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000260 headers = []
261 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000262 line = fp.readline(_MAXLINE + 1)
263 if len(line) > _MAXLINE:
264 raise LineTooLong("header line")
Barry Warsaw820c1202008-06-12 04:06:45 +0000265 headers.append(line)
Georg Brandlbf3f8eb2013-10-27 07:34:48 +0100266 if len(headers) > _MAXHEADERS:
267 raise HTTPException("got more than %d headers" % _MAXHEADERS)
Barry Warsaw820c1202008-06-12 04:06:45 +0000268 if line in (b'\r\n', b'\n', b''):
269 break
270 hstring = b''.join(headers).decode('iso-8859-1')
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000271 return email.parser.Parser(_class=_class).parsestr(hstring)
Greg Stein5e0fa402000-06-26 08:28:01 +0000272
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000273
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000274_strict_sentinel = object()
275
276class HTTPResponse(io.RawIOBase):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000277
278 # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details.
279
Jeremy Hylton811fc142007-08-03 13:30:02 +0000280 # The bytes from the socket object are iso-8859-1 strings.
281 # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded
282 # text following RFC 2047. The basic status line parsing only
283 # accepts iso-8859-1.
284
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000285 def __init__(self, sock, debuglevel=0, strict=_strict_sentinel, method=None, url=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000286 # If the response includes a content-length header, we need to
287 # make sure that the client doesn't read more than the
Jeremy Hylton39b198d2007-08-04 19:22:00 +0000288 # specified number of bytes. If it does, it will block until
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000289 # the server times out and closes the connection. This will
290 # happen if a self.fp.read() is done (without a size) whether
291 # self.fp is buffered or not. So, no self.fp.read() by
292 # clients unless they know what they are doing.
Benjamin Petersonf72d9fb2009-02-08 00:29:20 +0000293 self.fp = sock.makefile("rb")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000294 self.debuglevel = debuglevel
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000295 if strict is not _strict_sentinel:
296 warnings.warn("the 'strict' argument isn't supported anymore; "
297 "http.client now always assumes HTTP/1.x compliant servers.",
298 DeprecationWarning, 2)
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000299 self._method = method
Greg Stein5e0fa402000-06-26 08:28:01 +0000300
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000301 # The HTTPResponse object is returned via urllib. The clients
302 # of http and urllib expect different attributes for the
303 # headers. headers is used here and supports urllib. msg is
304 # provided as a backwards compatibility layer for http
305 # clients.
306
307 self.headers = self.msg = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000308
Greg Steindd6eefb2000-07-18 09:09:48 +0000309 # from the Status-Line of the response
Tim Peters07e99cb2001-01-14 23:47:14 +0000310 self.version = _UNKNOWN # HTTP-Version
311 self.status = _UNKNOWN # Status-Code
312 self.reason = _UNKNOWN # Reason-Phrase
Greg Stein5e0fa402000-06-26 08:28:01 +0000313
Tim Peters07e99cb2001-01-14 23:47:14 +0000314 self.chunked = _UNKNOWN # is "chunked" being used?
315 self.chunk_left = _UNKNOWN # bytes left to read in current chunk
316 self.length = _UNKNOWN # number of bytes left in response
317 self.will_close = _UNKNOWN # conn will close at end of response
Greg Stein5e0fa402000-06-26 08:28:01 +0000318
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000319 def _read_status(self):
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000320 line = str(self.fp.readline(_MAXLINE + 1), "iso-8859-1")
321 if len(line) > _MAXLINE:
322 raise LineTooLong("status line")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000323 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000324 print("reply:", repr(line))
Jeremy Hyltonb6769522003-06-29 17:55:05 +0000325 if not line:
326 # Presumably, the server closed the connection before
327 # sending a valid response.
328 raise BadStatusLine(line)
Greg Steindd6eefb2000-07-18 09:09:48 +0000329 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000330 version, status, reason = line.split(None, 2)
Greg Steindd6eefb2000-07-18 09:09:48 +0000331 except ValueError:
332 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000333 version, status = line.split(None, 1)
Greg Steindd6eefb2000-07-18 09:09:48 +0000334 reason = ""
335 except ValueError:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000336 # empty version will cause next test to fail.
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000337 version = ""
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000338 if not version.startswith("HTTP/"):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200339 self._close_conn()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000340 raise BadStatusLine(line)
Greg Stein5e0fa402000-06-26 08:28:01 +0000341
Jeremy Hylton23d40472001-04-13 14:57:08 +0000342 # The status code is a three-digit number
343 try:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000344 status = int(status)
Jeremy Hylton23d40472001-04-13 14:57:08 +0000345 if status < 100 or status > 999:
346 raise BadStatusLine(line)
347 except ValueError:
348 raise BadStatusLine(line)
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000349 return version, status, reason
Greg Stein5e0fa402000-06-26 08:28:01 +0000350
Jeremy Hylton39c03802002-07-12 14:04:09 +0000351 def begin(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000352 if self.headers is not None:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000353 # we've already started reading the response
354 return
355
356 # read until we get a non-100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000357 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000358 version, status, reason = self._read_status()
Martin v. Löwis39a31782004-09-18 09:03:49 +0000359 if status != CONTINUE:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000360 break
361 # skip the header from the 100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000362 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000363 skip = self.fp.readline(_MAXLINE + 1)
364 if len(skip) > _MAXLINE:
365 raise LineTooLong("header line")
366 skip = skip.strip()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000367 if not skip:
368 break
369 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000370 print("header:", skip)
Tim Petersc411dba2002-07-16 21:35:23 +0000371
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000372 self.code = self.status = status
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000373 self.reason = reason.strip()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000374 if version in ("HTTP/1.0", "HTTP/0.9"):
375 # Some servers might still return "0.9", treat it as 1.0 anyway
Greg Steindd6eefb2000-07-18 09:09:48 +0000376 self.version = 10
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000377 elif version.startswith("HTTP/1."):
Tim Peters07e99cb2001-01-14 23:47:14 +0000378 self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1
Greg Steindd6eefb2000-07-18 09:09:48 +0000379 else:
380 raise UnknownProtocol(version)
Greg Stein5e0fa402000-06-26 08:28:01 +0000381
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000382 self.headers = self.msg = parse_headers(self.fp)
Barry Warsaw820c1202008-06-12 04:06:45 +0000383
Jeremy Hylton30f86742000-09-18 22:50:38 +0000384 if self.debuglevel > 0:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000385 for hdr in self.headers:
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000386 print("header:", hdr, end=" ")
Greg Stein5e0fa402000-06-26 08:28:01 +0000387
Greg Steindd6eefb2000-07-18 09:09:48 +0000388 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000389 tr_enc = self.headers.get("transfer-encoding")
Jeremy Hyltond229b3a2002-09-03 19:24:24 +0000390 if tr_enc and tr_enc.lower() == "chunked":
Jeremy Hylton236156f2008-12-15 03:00:50 +0000391 self.chunked = True
Greg Steindd6eefb2000-07-18 09:09:48 +0000392 self.chunk_left = None
393 else:
Jeremy Hylton236156f2008-12-15 03:00:50 +0000394 self.chunked = False
Greg Stein5e0fa402000-06-26 08:28:01 +0000395
Greg Steindd6eefb2000-07-18 09:09:48 +0000396 # will the connection close at the end of the response?
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000397 self.will_close = self._check_close()
Greg Stein5e0fa402000-06-26 08:28:01 +0000398
Greg Steindd6eefb2000-07-18 09:09:48 +0000399 # do we have a Content-Length?
400 # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked"
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000401 self.length = None
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000402 length = self.headers.get("content-length")
Barry Warsaw820c1202008-06-12 04:06:45 +0000403
404 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000405 tr_enc = self.headers.get("transfer-encoding")
Greg Steindd6eefb2000-07-18 09:09:48 +0000406 if length and not self.chunked:
Jeremy Hylton30a81812000-09-14 20:34:27 +0000407 try:
408 self.length = int(length)
409 except ValueError:
Christian Heimesa612dc02008-02-24 13:08:18 +0000410 self.length = None
411 else:
412 if self.length < 0: # ignore nonsensical negative lengths
413 self.length = None
414 else:
415 self.length = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000416
Greg Steindd6eefb2000-07-18 09:09:48 +0000417 # does the body have a fixed length? (of zero)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000418 if (status == NO_CONTENT or status == NOT_MODIFIED or
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000419 100 <= status < 200 or # 1xx codes
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000420 self._method == "HEAD"):
Greg Steindd6eefb2000-07-18 09:09:48 +0000421 self.length = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000422
Greg Steindd6eefb2000-07-18 09:09:48 +0000423 # if the connection remains open, and we aren't using chunked, and
424 # a content-length was not provided, then assume that the connection
425 # WILL close.
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000426 if (not self.will_close and
427 not self.chunked and
428 self.length is None):
Jeremy Hylton236156f2008-12-15 03:00:50 +0000429 self.will_close = True
Greg Stein5e0fa402000-06-26 08:28:01 +0000430
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000431 def _check_close(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000432 conn = self.headers.get("connection")
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000433 if self.version == 11:
434 # An HTTP/1.1 proxy is assumed to stay open unless
435 # explicitly closed.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000436 conn = self.headers.get("connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000437 if conn and "close" in conn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000438 return True
439 return False
440
Jeremy Hylton2c178252004-08-07 16:28:14 +0000441 # Some HTTP/1.0 implementations have support for persistent
442 # connections, using rules different than HTTP/1.1.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000443
Christian Heimes895627f2007-12-08 17:28:33 +0000444 # For older HTTP, Keep-Alive indicates persistent connection.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000445 if self.headers.get("keep-alive"):
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000446 return False
Tim Peters77c06fb2002-11-24 02:35:35 +0000447
Jeremy Hylton2c178252004-08-07 16:28:14 +0000448 # At least Akamai returns a "Connection: Keep-Alive" header,
449 # which was supposed to be sent by the client.
450 if conn and "keep-alive" in conn.lower():
451 return False
452
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000453 # Proxy-Connection is a netscape hack.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000454 pconn = self.headers.get("proxy-connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000455 if pconn and "keep-alive" in pconn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000456 return False
457
458 # otherwise, assume it will close
459 return True
460
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200461 def _close_conn(self):
462 fp = self.fp
463 self.fp = None
464 fp.close()
465
Greg Steindd6eefb2000-07-18 09:09:48 +0000466 def close(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200467 super().close() # set "closed" flag
Greg Steindd6eefb2000-07-18 09:09:48 +0000468 if self.fp:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200469 self._close_conn()
Greg Stein5e0fa402000-06-26 08:28:01 +0000470
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000471 # These implementations are for the benefit of io.BufferedReader.
472
473 # XXX This class should probably be revised to act more like
474 # the "raw stream" that BufferedReader expects.
475
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000476 def flush(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200477 super().flush()
478 if self.fp:
479 self.fp.flush()
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000480
Jeremy Hyltona7cff022009-04-01 02:35:56 +0000481 def readable(self):
482 return True
483
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000484 # End of "raw stream" methods
485
Greg Steindd6eefb2000-07-18 09:09:48 +0000486 def isclosed(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200487 """True if the connection is closed."""
Greg Steindd6eefb2000-07-18 09:09:48 +0000488 # NOTE: it is possible that we will not ever call self.close(). This
489 # case occurs when will_close is TRUE, length is None, and we
490 # read up to the last byte, but NOT past it.
491 #
492 # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be
493 # called, meaning self.isclosed() is meaningful.
494 return self.fp is None
495
496 def read(self, amt=None):
497 if self.fp is None:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000498 return b""
Greg Steindd6eefb2000-07-18 09:09:48 +0000499
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000500 if self._method == "HEAD":
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200501 self._close_conn()
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000502 return b""
503
Antoine Pitrou38d96432011-12-06 22:33:57 +0100504 if amt is not None:
505 # Amount is given, so call base class version
506 # (which is implemented in terms of self.readinto)
507 return super(HTTPResponse, self).read(amt)
508 else:
509 # Amount is not given (unbounded read) so we must check self.length
510 # and self.chunked
Tim Peters230a60c2002-11-09 05:08:07 +0000511
Antoine Pitrou38d96432011-12-06 22:33:57 +0100512 if self.chunked:
513 return self._readall_chunked()
514
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000515 if self.length is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000516 s = self.fp.read()
517 else:
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100518 try:
519 s = self._safe_read(self.length)
520 except IncompleteRead:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200521 self._close_conn()
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100522 raise
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000523 self.length = 0
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200524 self._close_conn() # we read everything
Greg Steindd6eefb2000-07-18 09:09:48 +0000525 return s
526
Antoine Pitrou38d96432011-12-06 22:33:57 +0100527 def readinto(self, b):
528 if self.fp is None:
529 return 0
530
531 if self._method == "HEAD":
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200532 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100533 return 0
534
535 if self.chunked:
536 return self._readinto_chunked(b)
537
Greg Steindd6eefb2000-07-18 09:09:48 +0000538 if self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100539 if len(b) > self.length:
Greg Steindd6eefb2000-07-18 09:09:48 +0000540 # clip the read to the "end of response"
Antoine Pitrou38d96432011-12-06 22:33:57 +0100541 b = memoryview(b)[0:self.length]
Greg Steindd6eefb2000-07-18 09:09:48 +0000542
543 # we do not use _safe_read() here because this may be a .will_close
544 # connection, and the user is reading more bytes than will be provided
545 # (for example, reading in 1k chunks)
Antoine Pitrou38d96432011-12-06 22:33:57 +0100546 n = self.fp.readinto(b)
Antoine Pitrou6a35e182013-02-02 23:04:56 +0100547 if not n:
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100548 # Ideally, we would raise IncompleteRead if the content-length
549 # wasn't satisfied, but it might break compatibility.
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200550 self._close_conn()
Antoine Pitrou6a35e182013-02-02 23:04:56 +0100551 elif self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100552 self.length -= n
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000553 if not self.length:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200554 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100555 return n
Greg Steindd6eefb2000-07-18 09:09:48 +0000556
Antoine Pitrou38d96432011-12-06 22:33:57 +0100557 def _read_next_chunk_size(self):
558 # Read the next chunk size from the file
559 line = self.fp.readline(_MAXLINE + 1)
560 if len(line) > _MAXLINE:
561 raise LineTooLong("chunk size")
562 i = line.find(b";")
563 if i >= 0:
564 line = line[:i] # strip chunk-extensions
565 try:
566 return int(line, 16)
567 except ValueError:
568 # close the connection as protocol synchronisation is
569 # probably lost
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200570 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100571 raise
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000572
Antoine Pitrou38d96432011-12-06 22:33:57 +0100573 def _read_and_discard_trailer(self):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000574 # read and discard trailer up to the CRLF terminator
575 ### note: we shouldn't have any trailers!
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000576 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000577 line = self.fp.readline(_MAXLINE + 1)
578 if len(line) > _MAXLINE:
579 raise LineTooLong("trailer line")
Christian Heimes0bd4e112008-02-12 22:59:25 +0000580 if not line:
581 # a vanishingly small number of sites EOF without
582 # sending the trailer
583 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800584 if line in (b'\r\n', b'\n', b''):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000585 break
586
Antoine Pitrou38d96432011-12-06 22:33:57 +0100587 def _readall_chunked(self):
588 assert self.chunked != _UNKNOWN
589 chunk_left = self.chunk_left
590 value = []
591 while True:
592 if chunk_left is None:
593 try:
594 chunk_left = self._read_next_chunk_size()
595 if chunk_left == 0:
596 break
597 except ValueError:
598 raise IncompleteRead(b''.join(value))
599 value.append(self._safe_read(chunk_left))
600
601 # we read the whole chunk, get another
602 self._safe_read(2) # toss the CRLF at the end of the chunk
603 chunk_left = None
604
605 self._read_and_discard_trailer()
606
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000607 # we read everything; close the "file"
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200608 self._close_conn()
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000609
Chris Withers9c33cbf2009-09-04 17:04:16 +0000610 return b''.join(value)
Tim Peters230a60c2002-11-09 05:08:07 +0000611
Antoine Pitrou38d96432011-12-06 22:33:57 +0100612 def _readinto_chunked(self, b):
613 assert self.chunked != _UNKNOWN
614 chunk_left = self.chunk_left
615
616 total_bytes = 0
617 mvb = memoryview(b)
618 while True:
619 if chunk_left is None:
620 try:
621 chunk_left = self._read_next_chunk_size()
622 if chunk_left == 0:
623 break
624 except ValueError:
625 raise IncompleteRead(bytes(b[0:total_bytes]))
Antoine Pitrou4ce6aa42011-12-06 22:34:36 +0100626
Antoine Pitrou38d96432011-12-06 22:33:57 +0100627 if len(mvb) < chunk_left:
628 n = self._safe_readinto(mvb)
629 self.chunk_left = chunk_left - n
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100630 return total_bytes + n
Antoine Pitrou38d96432011-12-06 22:33:57 +0100631 elif len(mvb) == chunk_left:
632 n = self._safe_readinto(mvb)
633 self._safe_read(2) # toss the CRLF at the end of the chunk
634 self.chunk_left = None
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100635 return total_bytes + n
Antoine Pitrou38d96432011-12-06 22:33:57 +0100636 else:
637 temp_mvb = mvb[0:chunk_left]
638 n = self._safe_readinto(temp_mvb)
639 mvb = mvb[n:]
640 total_bytes += n
641
642 # we read the whole chunk, get another
643 self._safe_read(2) # toss the CRLF at the end of the chunk
644 chunk_left = None
645
646 self._read_and_discard_trailer()
647
648 # we read everything; close the "file"
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200649 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100650
651 return total_bytes
652
Greg Steindd6eefb2000-07-18 09:09:48 +0000653 def _safe_read(self, amt):
654 """Read the number of bytes requested, compensating for partial reads.
655
656 Normally, we have a blocking socket, but a read() can be interrupted
657 by a signal (resulting in a partial read).
658
659 Note that we cannot distinguish between EOF and an interrupt when zero
660 bytes have been read. IncompleteRead() will be raised in this
661 situation.
662
663 This function should be used when <amt> bytes "should" be present for
664 reading. If the bytes are truly not available (due to EOF), then the
665 IncompleteRead exception can be used to detect the problem.
666 """
Georg Brandl80ba8e82005-09-29 20:16:07 +0000667 s = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000668 while amt > 0:
Georg Brandl80ba8e82005-09-29 20:16:07 +0000669 chunk = self.fp.read(min(amt, MAXAMOUNT))
Greg Steindd6eefb2000-07-18 09:09:48 +0000670 if not chunk:
Benjamin Peterson6accb982009-03-02 22:50:25 +0000671 raise IncompleteRead(b''.join(s), amt)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000672 s.append(chunk)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000673 amt -= len(chunk)
Guido van Rossuma00f1232007-09-12 19:43:09 +0000674 return b"".join(s)
Greg Steindd6eefb2000-07-18 09:09:48 +0000675
Antoine Pitrou38d96432011-12-06 22:33:57 +0100676 def _safe_readinto(self, b):
677 """Same as _safe_read, but for reading into a buffer."""
678 total_bytes = 0
679 mvb = memoryview(b)
680 while total_bytes < len(b):
681 if MAXAMOUNT < len(mvb):
682 temp_mvb = mvb[0:MAXAMOUNT]
683 n = self.fp.readinto(temp_mvb)
684 else:
685 n = self.fp.readinto(mvb)
686 if not n:
687 raise IncompleteRead(bytes(mvb[0:total_bytes]), len(b))
688 mvb = mvb[n:]
689 total_bytes += n
690 return total_bytes
691
Antoine Pitroub353c122009-02-11 00:39:14 +0000692 def fileno(self):
693 return self.fp.fileno()
694
Greg Steindd6eefb2000-07-18 09:09:48 +0000695 def getheader(self, name, default=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000696 if self.headers is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000697 raise ResponseNotReady()
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000698 headers = self.headers.get_all(name) or default
699 if isinstance(headers, str) or not hasattr(headers, '__iter__'):
700 return headers
701 else:
702 return ', '.join(headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000703
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000704 def getheaders(self):
705 """Return list of (header, value) tuples."""
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000706 if self.headers is None:
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000707 raise ResponseNotReady()
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000708 return list(self.headers.items())
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000709
Antoine Pitroub353c122009-02-11 00:39:14 +0000710 # We override IOBase.__iter__ so that it doesn't check for closed-ness
711
712 def __iter__(self):
713 return self
714
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000715 # For compatibility with old-style urllib responses.
716
717 def info(self):
718 return self.headers
719
720 def geturl(self):
721 return self.url
722
723 def getcode(self):
724 return self.status
Greg Stein5e0fa402000-06-26 08:28:01 +0000725
726class HTTPConnection:
727
Greg Steindd6eefb2000-07-18 09:09:48 +0000728 _http_vsn = 11
729 _http_vsn_str = 'HTTP/1.1'
Greg Stein5e0fa402000-06-26 08:28:01 +0000730
Greg Steindd6eefb2000-07-18 09:09:48 +0000731 response_class = HTTPResponse
732 default_port = HTTP_PORT
733 auto_open = 1
Jeremy Hylton30f86742000-09-18 22:50:38 +0000734 debuglevel = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000735
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000736 def __init__(self, host, port=None, strict=_strict_sentinel,
Gregory P. Smithb4066372010-01-03 03:28:29 +0000737 timeout=socket._GLOBAL_DEFAULT_TIMEOUT, source_address=None):
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000738 if strict is not _strict_sentinel:
739 warnings.warn("the 'strict' argument isn't supported anymore; "
740 "http.client now always assumes HTTP/1.x compliant servers.",
741 DeprecationWarning, 2)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000742 self.timeout = timeout
Gregory P. Smithb4066372010-01-03 03:28:29 +0000743 self.source_address = source_address
Greg Steindd6eefb2000-07-18 09:09:48 +0000744 self.sock = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000745 self._buffer = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000746 self.__response = None
747 self.__state = _CS_IDLE
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000748 self._method = None
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000749 self._tunnel_host = None
750 self._tunnel_port = None
Georg Brandlc7c199f2011-01-22 22:06:24 +0000751 self._tunnel_headers = {}
Tim Petersc411dba2002-07-16 21:35:23 +0000752
Greg Steindd6eefb2000-07-18 09:09:48 +0000753 self._set_hostport(host, port)
Greg Stein5e0fa402000-06-26 08:28:01 +0000754
Senthil Kumaran47fff872009-12-20 07:10:31 +0000755 def set_tunnel(self, host, port=None, headers=None):
756 """ Sets up the host and the port for the HTTP CONNECT Tunnelling.
757
758 The headers argument should be a mapping of extra HTTP headers
759 to send with the CONNECT request.
760 """
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000761 self._tunnel_host = host
762 self._tunnel_port = port
Senthil Kumaran47fff872009-12-20 07:10:31 +0000763 if headers:
764 self._tunnel_headers = headers
765 else:
766 self._tunnel_headers.clear()
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000767
Greg Steindd6eefb2000-07-18 09:09:48 +0000768 def _set_hostport(self, host, port):
769 if port is None:
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000770 i = host.rfind(':')
Skip Montanarocae14d22004-09-14 17:55:21 +0000771 j = host.rfind(']') # ipv6 addresses have [...]
772 if i > j:
Skip Montanaro9d389972002-03-24 16:53:50 +0000773 try:
774 port = int(host[i+1:])
775 except ValueError:
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200776 if host[i+1:] == "": # http://foo.com:/ == http://foo.com/
777 port = self.default_port
778 else:
779 raise InvalidURL("nonnumeric port: '%s'" % host[i+1:])
Greg Steindd6eefb2000-07-18 09:09:48 +0000780 host = host[:i]
781 else:
782 port = self.default_port
Raymond Hettinger4d037912004-10-14 15:23:38 +0000783 if host and host[0] == '[' and host[-1] == ']':
Brett Cannon0a1af4a2004-09-15 23:26:23 +0000784 host = host[1:-1]
Greg Steindd6eefb2000-07-18 09:09:48 +0000785 self.host = host
786 self.port = port
Greg Stein5e0fa402000-06-26 08:28:01 +0000787
Jeremy Hylton30f86742000-09-18 22:50:38 +0000788 def set_debuglevel(self, level):
789 self.debuglevel = level
790
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000791 def _tunnel(self):
792 self._set_hostport(self._tunnel_host, self._tunnel_port)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000793 connect_str = "CONNECT %s:%d HTTP/1.0\r\n" % (self.host, self.port)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000794 connect_bytes = connect_str.encode("ascii")
795 self.send(connect_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000796 for header, value in self._tunnel_headers.items():
Senthil Kumaran47fff872009-12-20 07:10:31 +0000797 header_str = "%s: %s\r\n" % (header, value)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000798 header_bytes = header_str.encode("latin-1")
Senthil Kumaran47fff872009-12-20 07:10:31 +0000799 self.send(header_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000800 self.send(b'\r\n')
Senthil Kumaran47fff872009-12-20 07:10:31 +0000801
Georg Brandlc7c199f2011-01-22 22:06:24 +0000802 response = self.response_class(self.sock, method=self._method)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000803 (version, code, message) = response._read_status()
Senthil Kumaran47fff872009-12-20 07:10:31 +0000804
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000805 if code != 200:
806 self.close()
807 raise socket.error("Tunnel connection failed: %d %s" % (code,
808 message.strip()))
809 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000810 line = response.fp.readline(_MAXLINE + 1)
811 if len(line) > _MAXLINE:
812 raise LineTooLong("header line")
Senthil Kumaranb12771a2012-04-23 23:50:07 +0800813 if not line:
814 # for sites which EOF without sending a trailer
815 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800816 if line in (b'\r\n', b'\n', b''):
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000817 break
818
Greg Steindd6eefb2000-07-18 09:09:48 +0000819 def connect(self):
820 """Connect to the host and port specified in __init__."""
Guido van Rossumd8faa362007-04-27 19:54:29 +0000821 self.sock = socket.create_connection((self.host,self.port),
Gregory P. Smithb4066372010-01-03 03:28:29 +0000822 self.timeout, self.source_address)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000823 if self._tunnel_host:
824 self._tunnel()
Greg Stein5e0fa402000-06-26 08:28:01 +0000825
Greg Steindd6eefb2000-07-18 09:09:48 +0000826 def close(self):
827 """Close the connection to the HTTP server."""
828 if self.sock:
Tim Peters07e99cb2001-01-14 23:47:14 +0000829 self.sock.close() # close it manually... there may be other refs
Greg Steindd6eefb2000-07-18 09:09:48 +0000830 self.sock = None
831 if self.__response:
832 self.__response.close()
833 self.__response = None
834 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000835
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000836 def send(self, data):
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000837 """Send `data' to the server.
838 ``data`` can be a string object, a bytes object, an array object, a
839 file-like object that supports a .read() method, or an iterable object.
840 """
841
Greg Steindd6eefb2000-07-18 09:09:48 +0000842 if self.sock is None:
843 if self.auto_open:
844 self.connect()
845 else:
846 raise NotConnected()
Greg Stein5e0fa402000-06-26 08:28:01 +0000847
Jeremy Hylton30f86742000-09-18 22:50:38 +0000848 if self.debuglevel > 0:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000849 print("send:", repr(data))
Jeremy Hylton636950f2009-03-28 04:34:21 +0000850 blocksize = 8192
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000851 if hasattr(data, "read") :
Jeremy Hylton636950f2009-03-28 04:34:21 +0000852 if self.debuglevel > 0:
853 print("sendIng a read()able")
854 encode = False
Antoine Pitrouead1d622009-09-29 18:44:53 +0000855 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000856 mode = data.mode
Antoine Pitrouead1d622009-09-29 18:44:53 +0000857 except AttributeError:
858 # io.BytesIO and other file-like objects don't have a `mode`
859 # attribute.
860 pass
861 else:
862 if "b" not in mode:
863 encode = True
864 if self.debuglevel > 0:
865 print("encoding file using iso-8859-1")
Jeremy Hylton636950f2009-03-28 04:34:21 +0000866 while 1:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000867 datablock = data.read(blocksize)
868 if not datablock:
Jeremy Hylton636950f2009-03-28 04:34:21 +0000869 break
870 if encode:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000871 datablock = datablock.encode("iso-8859-1")
872 self.sock.sendall(datablock)
Andrew Svetlov7b2c8bb2013-04-12 22:49:19 +0300873 return
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000874 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000875 self.sock.sendall(data)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000876 except TypeError:
877 if isinstance(data, collections.Iterable):
878 for d in data:
879 self.sock.sendall(d)
880 else:
Georg Brandl25e2cd12011-08-03 08:27:00 +0200881 raise TypeError("data should be a bytes-like object "
882 "or an iterable, got %r" % type(data))
Greg Stein5e0fa402000-06-26 08:28:01 +0000883
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000884 def _output(self, s):
885 """Add a line of output to the current request buffer.
Tim Peters469cdad2002-08-08 20:19:19 +0000886
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000887 Assumes that the line does *not* end with \\r\\n.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000888 """
889 self._buffer.append(s)
890
Benjamin Peterson1742e402008-11-30 22:15:29 +0000891 def _send_output(self, message_body=None):
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000892 """Send the currently buffered request and clear the buffer.
893
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000894 Appends an extra \\r\\n to the buffer.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000895 A message_body may be specified, to be appended to the request.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000896 """
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000897 self._buffer.extend((b"", b""))
898 msg = b"\r\n".join(self._buffer)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000899 del self._buffer[:]
Benjamin Peterson1742e402008-11-30 22:15:29 +0000900 # If msg and message_body are sent in a single send() call,
901 # it will avoid performance problems caused by the interaction
Ezio Melotti42da6632011-03-15 05:18:48 +0200902 # between delayed ack and the Nagle algorithm.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000903 if isinstance(message_body, bytes):
Benjamin Peterson1742e402008-11-30 22:15:29 +0000904 msg += message_body
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000905 message_body = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000906 self.send(msg)
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000907 if message_body is not None:
Jeremy Hylton236654b2009-03-27 20:24:34 +0000908 # message_body was not a string (i.e. it is a file), and
909 # we must run the risk of Nagle.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000910 self.send(message_body)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000911
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000912 def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0):
Greg Steindd6eefb2000-07-18 09:09:48 +0000913 """Send a request to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000914
Greg Steindd6eefb2000-07-18 09:09:48 +0000915 `method' specifies an HTTP request method, e.g. 'GET'.
916 `url' specifies the object being requested, e.g. '/index.html'.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000917 `skip_host' if True does not add automatically a 'Host:' header
918 `skip_accept_encoding' if True does not add automatically an
919 'Accept-Encoding:' header
Greg Steindd6eefb2000-07-18 09:09:48 +0000920 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000921
Greg Stein616a58d2003-06-24 06:35:19 +0000922 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000923 if self.__response and self.__response.isclosed():
924 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000925
Tim Peters58eb11c2004-01-18 20:29:55 +0000926
Greg Steindd6eefb2000-07-18 09:09:48 +0000927 # in certain cases, we cannot issue another request on this connection.
928 # this occurs when:
929 # 1) we are in the process of sending a request. (_CS_REQ_STARTED)
930 # 2) a response to a previous request has signalled that it is going
931 # to close the connection upon completion.
932 # 3) the headers for the previous response have not been read, thus
933 # we cannot determine whether point (2) is true. (_CS_REQ_SENT)
934 #
935 # if there is no prior response, then we can request at will.
936 #
937 # if point (2) is true, then we will have passed the socket to the
938 # response (effectively meaning, "there is no prior response"), and
939 # will open a new one when a new request is made.
940 #
941 # Note: if a prior response exists, then we *can* start a new request.
942 # We are not allowed to begin fetching the response to this new
943 # request, however, until that prior response is complete.
944 #
945 if self.__state == _CS_IDLE:
946 self.__state = _CS_REQ_STARTED
947 else:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000948 raise CannotSendRequest(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +0000949
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000950 # Save the method we use, we need it later in the response phase
951 self._method = method
Greg Steindd6eefb2000-07-18 09:09:48 +0000952 if not url:
953 url = '/'
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000954 request = '%s %s %s' % (method, url, self._http_vsn_str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000955
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000956 # Non-ASCII characters should have been eliminated earlier
957 self._output(request.encode('ascii'))
Greg Stein5e0fa402000-06-26 08:28:01 +0000958
Greg Steindd6eefb2000-07-18 09:09:48 +0000959 if self._http_vsn == 11:
960 # Issue some standard headers for better HTTP/1.1 compliance
Greg Stein5e0fa402000-06-26 08:28:01 +0000961
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000962 if not skip_host:
963 # this header is issued *only* for HTTP/1.1
964 # connections. more specifically, this means it is
965 # only issued when the client uses the new
966 # HTTPConnection() class. backwards-compat clients
967 # will be using HTTP/1.0 and those clients may be
968 # issuing this header themselves. we should NOT issue
969 # it twice; some web servers (such as Apache) barf
970 # when they see two Host: headers
Guido van Rossumf6922aa2001-01-14 21:03:01 +0000971
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000972 # If we need a non-standard port,include it in the
973 # header. If the request is going through a proxy,
974 # but the host of the actual URL, not the host of the
975 # proxy.
Jeremy Hylton8acf1e02002-03-08 19:35:51 +0000976
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000977 netloc = ''
978 if url.startswith('http'):
979 nil, netloc, nil, nil, nil = urlsplit(url)
980
981 if netloc:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000982 try:
983 netloc_enc = netloc.encode("ascii")
984 except UnicodeEncodeError:
985 netloc_enc = netloc.encode("idna")
986 self.putheader('Host', netloc_enc)
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000987 else:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000988 try:
989 host_enc = self.host.encode("ascii")
990 except UnicodeEncodeError:
991 host_enc = self.host.encode("idna")
Senthil Kumaran74ebd9e2010-11-13 12:27:49 +0000992
993 # As per RFC 273, IPv6 address should be wrapped with []
994 # when used as Host header
995
996 if self.host.find(':') >= 0:
997 host_enc = b'[' + host_enc + b']'
998
Georg Brandl86b2fb92008-07-16 03:43:04 +0000999 if self.port == self.default_port:
Thomas Wouters477c8d52006-05-27 19:21:47 +00001000 self.putheader('Host', host_enc)
1001 else:
Guido van Rossum98297ee2007-11-06 21:34:58 +00001002 host_enc = host_enc.decode("ascii")
Thomas Wouters477c8d52006-05-27 19:21:47 +00001003 self.putheader('Host', "%s:%s" % (host_enc, self.port))
Greg Stein5e0fa402000-06-26 08:28:01 +00001004
Greg Steindd6eefb2000-07-18 09:09:48 +00001005 # note: we are assuming that clients will not attempt to set these
1006 # headers since *this* library must deal with the
1007 # consequences. this also means that when the supporting
1008 # libraries are updated to recognize other forms, then this
1009 # code should be changed (removed or updated).
Greg Stein5e0fa402000-06-26 08:28:01 +00001010
Greg Steindd6eefb2000-07-18 09:09:48 +00001011 # we only want a Content-Encoding of "identity" since we don't
1012 # support encodings such as x-gzip or x-deflate.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +00001013 if not skip_accept_encoding:
1014 self.putheader('Accept-Encoding', 'identity')
Greg Stein5e0fa402000-06-26 08:28:01 +00001015
Greg Steindd6eefb2000-07-18 09:09:48 +00001016 # we can accept "chunked" Transfer-Encodings, but no others
1017 # NOTE: no TE header implies *only* "chunked"
1018 #self.putheader('TE', 'chunked')
Greg Stein5e0fa402000-06-26 08:28:01 +00001019
Greg Steindd6eefb2000-07-18 09:09:48 +00001020 # if TE is supplied in the header, then it must appear in a
1021 # Connection header.
1022 #self.putheader('Connection', 'TE')
Greg Stein5e0fa402000-06-26 08:28:01 +00001023
Greg Steindd6eefb2000-07-18 09:09:48 +00001024 else:
1025 # For HTTP/1.0, the server will assume "not chunked"
1026 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001027
Benjamin Petersonf608c612008-11-16 18:33:53 +00001028 def putheader(self, header, *values):
Greg Steindd6eefb2000-07-18 09:09:48 +00001029 """Send a request header line to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001030
Greg Steindd6eefb2000-07-18 09:09:48 +00001031 For example: h.putheader('Accept', 'text/html')
1032 """
1033 if self.__state != _CS_REQ_STARTED:
1034 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +00001035
Guido van Rossum98297ee2007-11-06 21:34:58 +00001036 if hasattr(header, 'encode'):
1037 header = header.encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +00001038 values = list(values)
1039 for i, one_value in enumerate(values):
1040 if hasattr(one_value, 'encode'):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001041 values[i] = one_value.encode('latin-1')
Senthil Kumaran58d5dbf2010-10-03 18:22:42 +00001042 elif isinstance(one_value, int):
1043 values[i] = str(one_value).encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +00001044 value = b'\r\n\t'.join(values)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001045 header = header + b': ' + value
1046 self._output(header)
Greg Stein5e0fa402000-06-26 08:28:01 +00001047
Benjamin Peterson1742e402008-11-30 22:15:29 +00001048 def endheaders(self, message_body=None):
1049 """Indicate that the last header line has been sent to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001050
Senthil Kumaranad87fa62011-10-05 23:26:49 +08001051 This method sends the request to the server. The optional message_body
1052 argument can be used to pass a message body associated with the
1053 request. The message body will be sent in the same packet as the
1054 message headers if it is a string, otherwise it is sent as a separate
1055 packet.
Benjamin Peterson1742e402008-11-30 22:15:29 +00001056 """
Greg Steindd6eefb2000-07-18 09:09:48 +00001057 if self.__state == _CS_REQ_STARTED:
1058 self.__state = _CS_REQ_SENT
1059 else:
1060 raise CannotSendHeader()
Benjamin Peterson1742e402008-11-30 22:15:29 +00001061 self._send_output(message_body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001062
Greg Steindd6eefb2000-07-18 09:09:48 +00001063 def request(self, method, url, body=None, headers={}):
1064 """Send a complete request to the server."""
Jeremy Hylton636950f2009-03-28 04:34:21 +00001065 self._send_request(method, url, body, headers)
Greg Stein5e0fa402000-06-26 08:28:01 +00001066
Benjamin Peterson1742e402008-11-30 22:15:29 +00001067 def _set_content_length(self, body):
1068 # Set the content-length based on the body.
1069 thelen = None
1070 try:
1071 thelen = str(len(body))
1072 except TypeError as te:
1073 # If this is a file-like object, try to
1074 # fstat its file descriptor
Benjamin Peterson1742e402008-11-30 22:15:29 +00001075 try:
1076 thelen = str(os.fstat(body.fileno()).st_size)
1077 except (AttributeError, OSError):
1078 # Don't send a length if this failed
1079 if self.debuglevel > 0: print("Cannot stat!!")
1080
1081 if thelen is not None:
1082 self.putheader('Content-Length', thelen)
1083
Greg Steindd6eefb2000-07-18 09:09:48 +00001084 def _send_request(self, method, url, body, headers):
Jeremy Hylton636950f2009-03-28 04:34:21 +00001085 # Honor explicitly requested Host: and Accept-Encoding: headers.
Jeremy Hylton2c178252004-08-07 16:28:14 +00001086 header_names = dict.fromkeys([k.lower() for k in headers])
1087 skips = {}
1088 if 'host' in header_names:
1089 skips['skip_host'] = 1
1090 if 'accept-encoding' in header_names:
1091 skips['skip_accept_encoding'] = 1
Greg Stein5e0fa402000-06-26 08:28:01 +00001092
Jeremy Hylton2c178252004-08-07 16:28:14 +00001093 self.putrequest(method, url, **skips)
1094
Senthil Kumaran5fa4a892012-05-19 16:58:09 +08001095 if body is not None and ('content-length' not in header_names):
Benjamin Peterson1742e402008-11-30 22:15:29 +00001096 self._set_content_length(body)
Guido van Rossumcc2b0162007-02-11 06:12:03 +00001097 for hdr, value in headers.items():
Greg Steindd6eefb2000-07-18 09:09:48 +00001098 self.putheader(hdr, value)
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001099 if isinstance(body, str):
Jeremy Hylton236654b2009-03-27 20:24:34 +00001100 # RFC 2616 Section 3.7.1 says that text default has a
1101 # default charset of iso-8859-1.
1102 body = body.encode('iso-8859-1')
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001103 self.endheaders(body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001104
Greg Steindd6eefb2000-07-18 09:09:48 +00001105 def getresponse(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001106 """Get the response from the server.
1107
1108 If the HTTPConnection is in the correct state, returns an
1109 instance of HTTPResponse or of whatever object is returned by
1110 class the response_class variable.
1111
1112 If a request has not been sent or if a previous response has
1113 not be handled, ResponseNotReady is raised. If the HTTP
1114 response indicates that the connection should be closed, then
1115 it will be closed before the response is returned. When the
1116 connection is closed, the underlying socket is closed.
1117 """
Greg Stein5e0fa402000-06-26 08:28:01 +00001118
Greg Stein616a58d2003-06-24 06:35:19 +00001119 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +00001120 if self.__response and self.__response.isclosed():
1121 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +00001122
Greg Steindd6eefb2000-07-18 09:09:48 +00001123 # if a prior response exists, then it must be completed (otherwise, we
1124 # cannot read this response's header to determine the connection-close
1125 # behavior)
1126 #
1127 # note: if a prior response existed, but was connection-close, then the
1128 # socket and response were made independent of this HTTPConnection
1129 # object since a new request requires that we open a whole new
1130 # connection
1131 #
1132 # this means the prior response had one of two states:
1133 # 1) will_close: this connection was reset and the prior socket and
1134 # response operate independently
1135 # 2) persistent: the response was retained and we await its
1136 # isclosed() status to become true.
1137 #
1138 if self.__state != _CS_REQ_SENT or self.__response:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001139 raise ResponseNotReady(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +00001140
Jeremy Hylton30f86742000-09-18 22:50:38 +00001141 if self.debuglevel > 0:
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001142 response = self.response_class(self.sock, self.debuglevel,
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +00001143 method=self._method)
Jeremy Hylton30f86742000-09-18 22:50:38 +00001144 else:
Antoine Pitrou988dbd72010-12-17 17:35:56 +00001145 response = self.response_class(self.sock, method=self._method)
Greg Stein5e0fa402000-06-26 08:28:01 +00001146
Jeremy Hylton39c03802002-07-12 14:04:09 +00001147 response.begin()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +00001148 assert response.will_close != _UNKNOWN
Greg Steindd6eefb2000-07-18 09:09:48 +00001149 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +00001150
Greg Steindd6eefb2000-07-18 09:09:48 +00001151 if response.will_close:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001152 # this effectively passes the connection to the response
1153 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +00001154 else:
1155 # remember this, so we can tell when it is complete
1156 self.__response = response
Greg Stein5e0fa402000-06-26 08:28:01 +00001157
Greg Steindd6eefb2000-07-18 09:09:48 +00001158 return response
Greg Stein5e0fa402000-06-26 08:28:01 +00001159
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001160try:
1161 import ssl
1162except ImportError:
1163 pass
1164else:
1165 class HTTPSConnection(HTTPConnection):
1166 "This class allows communication via SSL."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001167
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001168 default_port = HTTPS_PORT
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001169
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001170 # XXX Should key_file and cert_file be deprecated in favour of context?
1171
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001172 def __init__(self, host, port=None, key_file=None, cert_file=None,
Antoine Pitrou988dbd72010-12-17 17:35:56 +00001173 strict=_strict_sentinel, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001174 source_address=None, *, context=None, check_hostname=None):
Gregory P. Smithb4066372010-01-03 03:28:29 +00001175 super(HTTPSConnection, self).__init__(host, port, strict, timeout,
1176 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001177 self.key_file = key_file
1178 self.cert_file = cert_file
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001179 if context is None:
1180 # Some reasonable defaults
1181 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1182 context.options |= ssl.OP_NO_SSLv2
1183 will_verify = context.verify_mode != ssl.CERT_NONE
1184 if check_hostname is None:
1185 check_hostname = will_verify
1186 elif check_hostname and not will_verify:
1187 raise ValueError("check_hostname needs a SSL context with "
1188 "either CERT_OPTIONAL or CERT_REQUIRED")
1189 if key_file or cert_file:
Antoine Pitrou80603992010-10-13 10:45:16 +00001190 context.load_cert_chain(cert_file, key_file)
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001191 self._context = context
1192 self._check_hostname = check_hostname
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001193
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001194 def connect(self):
1195 "Connect to a host on a given (SSL) port."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001196
Jeremy Hylton636950f2009-03-28 04:34:21 +00001197 sock = socket.create_connection((self.host, self.port),
Gregory P. Smithb4066372010-01-03 03:28:29 +00001198 self.timeout, self.source_address)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +00001199
1200 if self._tunnel_host:
1201 self.sock = sock
1202 self._tunnel()
1203
Antoine Pitroud5323212010-10-22 18:19:07 +00001204 server_hostname = self.host if ssl.HAS_SNI else None
1205 self.sock = self._context.wrap_socket(sock,
1206 server_hostname=server_hostname)
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001207 try:
1208 if self._check_hostname:
1209 ssl.match_hostname(self.sock.getpeercert(), self.host)
1210 except Exception:
1211 self.sock.shutdown(socket.SHUT_RDWR)
1212 self.sock.close()
1213 raise
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001214
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001215 __all__.append("HTTPSConnection")
Greg Stein5e0fa402000-06-26 08:28:01 +00001216
Greg Stein5e0fa402000-06-26 08:28:01 +00001217class HTTPException(Exception):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001218 # Subclasses that define an __init__ must call Exception.__init__
1219 # or define self.args. Otherwise, str() will fail.
Greg Steindd6eefb2000-07-18 09:09:48 +00001220 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001221
1222class NotConnected(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001223 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001224
Skip Montanaro9d389972002-03-24 16:53:50 +00001225class InvalidURL(HTTPException):
1226 pass
1227
Greg Stein5e0fa402000-06-26 08:28:01 +00001228class UnknownProtocol(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001229 def __init__(self, version):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001230 self.args = version,
Greg Steindd6eefb2000-07-18 09:09:48 +00001231 self.version = version
Greg Stein5e0fa402000-06-26 08:28:01 +00001232
1233class UnknownTransferEncoding(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001234 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001235
Greg Stein5e0fa402000-06-26 08:28:01 +00001236class UnimplementedFileMode(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001237 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001238
1239class IncompleteRead(HTTPException):
Benjamin Peterson6accb982009-03-02 22:50:25 +00001240 def __init__(self, partial, expected=None):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001241 self.args = partial,
Greg Steindd6eefb2000-07-18 09:09:48 +00001242 self.partial = partial
Benjamin Peterson6accb982009-03-02 22:50:25 +00001243 self.expected = expected
1244 def __repr__(self):
1245 if self.expected is not None:
1246 e = ', %i more expected' % self.expected
1247 else:
1248 e = ''
1249 return 'IncompleteRead(%i bytes read%s)' % (len(self.partial), e)
1250 def __str__(self):
1251 return repr(self)
Greg Stein5e0fa402000-06-26 08:28:01 +00001252
1253class ImproperConnectionState(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001254 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001255
1256class CannotSendRequest(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001257 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001258
1259class CannotSendHeader(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001260 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001261
1262class ResponseNotReady(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001263 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001264
1265class BadStatusLine(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001266 def __init__(self, line):
Benjamin Peterson11dbfd42010-03-21 22:50:04 +00001267 if not line:
1268 line = repr(line)
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001269 self.args = line,
Greg Steindd6eefb2000-07-18 09:09:48 +00001270 self.line = line
Greg Stein5e0fa402000-06-26 08:28:01 +00001271
Senthil Kumaran5466bf12010-12-18 16:55:23 +00001272class LineTooLong(HTTPException):
1273 def __init__(self, line_type):
1274 HTTPException.__init__(self, "got more than %d bytes when reading %s"
1275 % (_MAXLINE, line_type))
1276
Greg Stein5e0fa402000-06-26 08:28:01 +00001277# for backwards compatibility
1278error = HTTPException