blob: 5c52ba349ac022a157bcbee73bf8cdd2b9e39d2f [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 +0000274class HTTPResponse(io.RawIOBase):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000275
276 # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details.
277
Jeremy Hylton811fc142007-08-03 13:30:02 +0000278 # The bytes from the socket object are iso-8859-1 strings.
279 # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded
280 # text following RFC 2047. The basic status line parsing only
281 # accepts iso-8859-1.
282
Senthil Kumaran052ddb02013-03-18 14:11:41 -0700283 def __init__(self, sock, debuglevel=0, method=None, url=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000284 # If the response includes a content-length header, we need to
285 # make sure that the client doesn't read more than the
Jeremy Hylton39b198d2007-08-04 19:22:00 +0000286 # specified number of bytes. If it does, it will block until
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000287 # the server times out and closes the connection. This will
288 # happen if a self.fp.read() is done (without a size) whether
289 # self.fp is buffered or not. So, no self.fp.read() by
290 # clients unless they know what they are doing.
Benjamin Petersonf72d9fb2009-02-08 00:29:20 +0000291 self.fp = sock.makefile("rb")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000292 self.debuglevel = debuglevel
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000293 self._method = method
Greg Stein5e0fa402000-06-26 08:28:01 +0000294
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000295 # The HTTPResponse object is returned via urllib. The clients
296 # of http and urllib expect different attributes for the
297 # headers. headers is used here and supports urllib. msg is
298 # provided as a backwards compatibility layer for http
299 # clients.
300
301 self.headers = self.msg = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000302
Greg Steindd6eefb2000-07-18 09:09:48 +0000303 # from the Status-Line of the response
Tim Peters07e99cb2001-01-14 23:47:14 +0000304 self.version = _UNKNOWN # HTTP-Version
305 self.status = _UNKNOWN # Status-Code
306 self.reason = _UNKNOWN # Reason-Phrase
Greg Stein5e0fa402000-06-26 08:28:01 +0000307
Tim Peters07e99cb2001-01-14 23:47:14 +0000308 self.chunked = _UNKNOWN # is "chunked" being used?
309 self.chunk_left = _UNKNOWN # bytes left to read in current chunk
310 self.length = _UNKNOWN # number of bytes left in response
311 self.will_close = _UNKNOWN # conn will close at end of response
Greg Stein5e0fa402000-06-26 08:28:01 +0000312
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000313 def _read_status(self):
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000314 line = str(self.fp.readline(_MAXLINE + 1), "iso-8859-1")
315 if len(line) > _MAXLINE:
316 raise LineTooLong("status line")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000317 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000318 print("reply:", repr(line))
Jeremy Hyltonb6769522003-06-29 17:55:05 +0000319 if not line:
320 # Presumably, the server closed the connection before
321 # sending a valid response.
322 raise BadStatusLine(line)
Greg Steindd6eefb2000-07-18 09:09:48 +0000323 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000324 version, status, reason = line.split(None, 2)
Greg Steindd6eefb2000-07-18 09:09:48 +0000325 except ValueError:
326 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000327 version, status = line.split(None, 1)
Greg Steindd6eefb2000-07-18 09:09:48 +0000328 reason = ""
329 except ValueError:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000330 # empty version will cause next test to fail.
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000331 version = ""
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000332 if not version.startswith("HTTP/"):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200333 self._close_conn()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000334 raise BadStatusLine(line)
Greg Stein5e0fa402000-06-26 08:28:01 +0000335
Jeremy Hylton23d40472001-04-13 14:57:08 +0000336 # The status code is a three-digit number
337 try:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000338 status = int(status)
Jeremy Hylton23d40472001-04-13 14:57:08 +0000339 if status < 100 or status > 999:
340 raise BadStatusLine(line)
341 except ValueError:
342 raise BadStatusLine(line)
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000343 return version, status, reason
Greg Stein5e0fa402000-06-26 08:28:01 +0000344
Jeremy Hylton39c03802002-07-12 14:04:09 +0000345 def begin(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000346 if self.headers is not None:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000347 # we've already started reading the response
348 return
349
350 # read until we get a non-100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000351 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000352 version, status, reason = self._read_status()
Martin v. Löwis39a31782004-09-18 09:03:49 +0000353 if status != CONTINUE:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000354 break
355 # skip the header from the 100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000356 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000357 skip = self.fp.readline(_MAXLINE + 1)
358 if len(skip) > _MAXLINE:
359 raise LineTooLong("header line")
360 skip = skip.strip()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000361 if not skip:
362 break
363 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000364 print("header:", skip)
Tim Petersc411dba2002-07-16 21:35:23 +0000365
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000366 self.code = self.status = status
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000367 self.reason = reason.strip()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000368 if version in ("HTTP/1.0", "HTTP/0.9"):
369 # Some servers might still return "0.9", treat it as 1.0 anyway
Greg Steindd6eefb2000-07-18 09:09:48 +0000370 self.version = 10
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000371 elif version.startswith("HTTP/1."):
Tim Peters07e99cb2001-01-14 23:47:14 +0000372 self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1
Greg Steindd6eefb2000-07-18 09:09:48 +0000373 else:
374 raise UnknownProtocol(version)
Greg Stein5e0fa402000-06-26 08:28:01 +0000375
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000376 self.headers = self.msg = parse_headers(self.fp)
Barry Warsaw820c1202008-06-12 04:06:45 +0000377
Jeremy Hylton30f86742000-09-18 22:50:38 +0000378 if self.debuglevel > 0:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000379 for hdr in self.headers:
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000380 print("header:", hdr, end=" ")
Greg Stein5e0fa402000-06-26 08:28:01 +0000381
Greg Steindd6eefb2000-07-18 09:09:48 +0000382 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000383 tr_enc = self.headers.get("transfer-encoding")
Jeremy Hyltond229b3a2002-09-03 19:24:24 +0000384 if tr_enc and tr_enc.lower() == "chunked":
Jeremy Hylton236156f2008-12-15 03:00:50 +0000385 self.chunked = True
Greg Steindd6eefb2000-07-18 09:09:48 +0000386 self.chunk_left = None
387 else:
Jeremy Hylton236156f2008-12-15 03:00:50 +0000388 self.chunked = False
Greg Stein5e0fa402000-06-26 08:28:01 +0000389
Greg Steindd6eefb2000-07-18 09:09:48 +0000390 # will the connection close at the end of the response?
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000391 self.will_close = self._check_close()
Greg Stein5e0fa402000-06-26 08:28:01 +0000392
Greg Steindd6eefb2000-07-18 09:09:48 +0000393 # do we have a Content-Length?
394 # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked"
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000395 self.length = None
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000396 length = self.headers.get("content-length")
Barry Warsaw820c1202008-06-12 04:06:45 +0000397
398 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000399 tr_enc = self.headers.get("transfer-encoding")
Greg Steindd6eefb2000-07-18 09:09:48 +0000400 if length and not self.chunked:
Jeremy Hylton30a81812000-09-14 20:34:27 +0000401 try:
402 self.length = int(length)
403 except ValueError:
Christian Heimesa612dc02008-02-24 13:08:18 +0000404 self.length = None
405 else:
406 if self.length < 0: # ignore nonsensical negative lengths
407 self.length = None
408 else:
409 self.length = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000410
Greg Steindd6eefb2000-07-18 09:09:48 +0000411 # does the body have a fixed length? (of zero)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000412 if (status == NO_CONTENT or status == NOT_MODIFIED or
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000413 100 <= status < 200 or # 1xx codes
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000414 self._method == "HEAD"):
Greg Steindd6eefb2000-07-18 09:09:48 +0000415 self.length = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000416
Greg Steindd6eefb2000-07-18 09:09:48 +0000417 # if the connection remains open, and we aren't using chunked, and
418 # a content-length was not provided, then assume that the connection
419 # WILL close.
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000420 if (not self.will_close and
421 not self.chunked and
422 self.length is None):
Jeremy Hylton236156f2008-12-15 03:00:50 +0000423 self.will_close = True
Greg Stein5e0fa402000-06-26 08:28:01 +0000424
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000425 def _check_close(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000426 conn = self.headers.get("connection")
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000427 if self.version == 11:
428 # An HTTP/1.1 proxy is assumed to stay open unless
429 # explicitly closed.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000430 conn = self.headers.get("connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000431 if conn and "close" in conn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000432 return True
433 return False
434
Jeremy Hylton2c178252004-08-07 16:28:14 +0000435 # Some HTTP/1.0 implementations have support for persistent
436 # connections, using rules different than HTTP/1.1.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000437
Christian Heimes895627f2007-12-08 17:28:33 +0000438 # For older HTTP, Keep-Alive indicates persistent connection.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000439 if self.headers.get("keep-alive"):
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000440 return False
Tim Peters77c06fb2002-11-24 02:35:35 +0000441
Jeremy Hylton2c178252004-08-07 16:28:14 +0000442 # At least Akamai returns a "Connection: Keep-Alive" header,
443 # which was supposed to be sent by the client.
444 if conn and "keep-alive" in conn.lower():
445 return False
446
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000447 # Proxy-Connection is a netscape hack.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000448 pconn = self.headers.get("proxy-connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000449 if pconn and "keep-alive" in pconn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000450 return False
451
452 # otherwise, assume it will close
453 return True
454
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200455 def _close_conn(self):
456 fp = self.fp
457 self.fp = None
458 fp.close()
459
Greg Steindd6eefb2000-07-18 09:09:48 +0000460 def close(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200461 super().close() # set "closed" flag
Greg Steindd6eefb2000-07-18 09:09:48 +0000462 if self.fp:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200463 self._close_conn()
Greg Stein5e0fa402000-06-26 08:28:01 +0000464
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000465 # These implementations are for the benefit of io.BufferedReader.
466
467 # XXX This class should probably be revised to act more like
468 # the "raw stream" that BufferedReader expects.
469
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000470 def flush(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200471 super().flush()
472 if self.fp:
473 self.fp.flush()
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000474
Jeremy Hyltona7cff022009-04-01 02:35:56 +0000475 def readable(self):
476 return True
477
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000478 # End of "raw stream" methods
479
Greg Steindd6eefb2000-07-18 09:09:48 +0000480 def isclosed(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200481 """True if the connection is closed."""
Greg Steindd6eefb2000-07-18 09:09:48 +0000482 # NOTE: it is possible that we will not ever call self.close(). This
483 # case occurs when will_close is TRUE, length is None, and we
484 # read up to the last byte, but NOT past it.
485 #
486 # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be
487 # called, meaning self.isclosed() is meaningful.
488 return self.fp is None
489
490 def read(self, amt=None):
491 if self.fp is None:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000492 return b""
Greg Steindd6eefb2000-07-18 09:09:48 +0000493
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000494 if self._method == "HEAD":
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200495 self._close_conn()
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000496 return b""
497
Antoine Pitrou38d96432011-12-06 22:33:57 +0100498 if amt is not None:
499 # Amount is given, so call base class version
500 # (which is implemented in terms of self.readinto)
501 return super(HTTPResponse, self).read(amt)
502 else:
503 # Amount is not given (unbounded read) so we must check self.length
504 # and self.chunked
Tim Peters230a60c2002-11-09 05:08:07 +0000505
Antoine Pitrou38d96432011-12-06 22:33:57 +0100506 if self.chunked:
507 return self._readall_chunked()
508
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000509 if self.length is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000510 s = self.fp.read()
511 else:
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100512 try:
513 s = self._safe_read(self.length)
514 except IncompleteRead:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200515 self._close_conn()
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100516 raise
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000517 self.length = 0
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200518 self._close_conn() # we read everything
Greg Steindd6eefb2000-07-18 09:09:48 +0000519 return s
520
Antoine Pitrou38d96432011-12-06 22:33:57 +0100521 def readinto(self, b):
522 if self.fp is None:
523 return 0
524
525 if self._method == "HEAD":
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200526 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100527 return 0
528
529 if self.chunked:
530 return self._readinto_chunked(b)
531
Greg Steindd6eefb2000-07-18 09:09:48 +0000532 if self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100533 if len(b) > self.length:
Greg Steindd6eefb2000-07-18 09:09:48 +0000534 # clip the read to the "end of response"
Antoine Pitrou38d96432011-12-06 22:33:57 +0100535 b = memoryview(b)[0:self.length]
Greg Steindd6eefb2000-07-18 09:09:48 +0000536
537 # we do not use _safe_read() here because this may be a .will_close
538 # connection, and the user is reading more bytes than will be provided
539 # (for example, reading in 1k chunks)
Antoine Pitrou38d96432011-12-06 22:33:57 +0100540 n = self.fp.readinto(b)
Antoine Pitrou6a35e182013-02-02 23:04:56 +0100541 if not n:
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100542 # Ideally, we would raise IncompleteRead if the content-length
543 # wasn't satisfied, but it might break compatibility.
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200544 self._close_conn()
Antoine Pitrou6a35e182013-02-02 23:04:56 +0100545 elif self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100546 self.length -= n
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000547 if not self.length:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200548 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100549 return n
Greg Steindd6eefb2000-07-18 09:09:48 +0000550
Antoine Pitrou38d96432011-12-06 22:33:57 +0100551 def _read_next_chunk_size(self):
552 # Read the next chunk size from the file
553 line = self.fp.readline(_MAXLINE + 1)
554 if len(line) > _MAXLINE:
555 raise LineTooLong("chunk size")
556 i = line.find(b";")
557 if i >= 0:
558 line = line[:i] # strip chunk-extensions
559 try:
560 return int(line, 16)
561 except ValueError:
562 # close the connection as protocol synchronisation is
563 # probably lost
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200564 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100565 raise
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000566
Antoine Pitrou38d96432011-12-06 22:33:57 +0100567 def _read_and_discard_trailer(self):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000568 # read and discard trailer up to the CRLF terminator
569 ### note: we shouldn't have any trailers!
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000570 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000571 line = self.fp.readline(_MAXLINE + 1)
572 if len(line) > _MAXLINE:
573 raise LineTooLong("trailer line")
Christian Heimes0bd4e112008-02-12 22:59:25 +0000574 if not line:
575 # a vanishingly small number of sites EOF without
576 # sending the trailer
577 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800578 if line in (b'\r\n', b'\n', b''):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000579 break
580
Antoine Pitrou38d96432011-12-06 22:33:57 +0100581 def _readall_chunked(self):
582 assert self.chunked != _UNKNOWN
583 chunk_left = self.chunk_left
584 value = []
585 while True:
586 if chunk_left is None:
587 try:
588 chunk_left = self._read_next_chunk_size()
589 if chunk_left == 0:
590 break
591 except ValueError:
592 raise IncompleteRead(b''.join(value))
593 value.append(self._safe_read(chunk_left))
594
595 # we read the whole chunk, get another
596 self._safe_read(2) # toss the CRLF at the end of the chunk
597 chunk_left = None
598
599 self._read_and_discard_trailer()
600
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000601 # we read everything; close the "file"
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200602 self._close_conn()
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000603
Chris Withers9c33cbf2009-09-04 17:04:16 +0000604 return b''.join(value)
Tim Peters230a60c2002-11-09 05:08:07 +0000605
Antoine Pitrou38d96432011-12-06 22:33:57 +0100606 def _readinto_chunked(self, b):
607 assert self.chunked != _UNKNOWN
608 chunk_left = self.chunk_left
609
610 total_bytes = 0
611 mvb = memoryview(b)
612 while True:
613 if chunk_left is None:
614 try:
615 chunk_left = self._read_next_chunk_size()
616 if chunk_left == 0:
617 break
618 except ValueError:
619 raise IncompleteRead(bytes(b[0:total_bytes]))
Antoine Pitrou4ce6aa42011-12-06 22:34:36 +0100620
Antoine Pitrou38d96432011-12-06 22:33:57 +0100621 if len(mvb) < chunk_left:
622 n = self._safe_readinto(mvb)
623 self.chunk_left = chunk_left - n
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100624 return total_bytes + n
Antoine Pitrou38d96432011-12-06 22:33:57 +0100625 elif len(mvb) == chunk_left:
626 n = self._safe_readinto(mvb)
627 self._safe_read(2) # toss the CRLF at the end of the chunk
628 self.chunk_left = None
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100629 return total_bytes + n
Antoine Pitrou38d96432011-12-06 22:33:57 +0100630 else:
631 temp_mvb = mvb[0:chunk_left]
632 n = self._safe_readinto(temp_mvb)
633 mvb = mvb[n:]
634 total_bytes += n
635
636 # we read the whole chunk, get another
637 self._safe_read(2) # toss the CRLF at the end of the chunk
638 chunk_left = None
639
640 self._read_and_discard_trailer()
641
642 # we read everything; close the "file"
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200643 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100644
645 return total_bytes
646
Greg Steindd6eefb2000-07-18 09:09:48 +0000647 def _safe_read(self, amt):
648 """Read the number of bytes requested, compensating for partial reads.
649
650 Normally, we have a blocking socket, but a read() can be interrupted
651 by a signal (resulting in a partial read).
652
653 Note that we cannot distinguish between EOF and an interrupt when zero
654 bytes have been read. IncompleteRead() will be raised in this
655 situation.
656
657 This function should be used when <amt> bytes "should" be present for
658 reading. If the bytes are truly not available (due to EOF), then the
659 IncompleteRead exception can be used to detect the problem.
660 """
Georg Brandl80ba8e82005-09-29 20:16:07 +0000661 s = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000662 while amt > 0:
Georg Brandl80ba8e82005-09-29 20:16:07 +0000663 chunk = self.fp.read(min(amt, MAXAMOUNT))
Greg Steindd6eefb2000-07-18 09:09:48 +0000664 if not chunk:
Benjamin Peterson6accb982009-03-02 22:50:25 +0000665 raise IncompleteRead(b''.join(s), amt)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000666 s.append(chunk)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000667 amt -= len(chunk)
Guido van Rossuma00f1232007-09-12 19:43:09 +0000668 return b"".join(s)
Greg Steindd6eefb2000-07-18 09:09:48 +0000669
Antoine Pitrou38d96432011-12-06 22:33:57 +0100670 def _safe_readinto(self, b):
671 """Same as _safe_read, but for reading into a buffer."""
672 total_bytes = 0
673 mvb = memoryview(b)
674 while total_bytes < len(b):
675 if MAXAMOUNT < len(mvb):
676 temp_mvb = mvb[0:MAXAMOUNT]
677 n = self.fp.readinto(temp_mvb)
678 else:
679 n = self.fp.readinto(mvb)
680 if not n:
681 raise IncompleteRead(bytes(mvb[0:total_bytes]), len(b))
682 mvb = mvb[n:]
683 total_bytes += n
684 return total_bytes
685
Antoine Pitroub353c122009-02-11 00:39:14 +0000686 def fileno(self):
687 return self.fp.fileno()
688
Greg Steindd6eefb2000-07-18 09:09:48 +0000689 def getheader(self, name, default=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000690 if self.headers is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000691 raise ResponseNotReady()
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000692 headers = self.headers.get_all(name) or default
693 if isinstance(headers, str) or not hasattr(headers, '__iter__'):
694 return headers
695 else:
696 return ', '.join(headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000697
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000698 def getheaders(self):
699 """Return list of (header, value) tuples."""
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000700 if self.headers is None:
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000701 raise ResponseNotReady()
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000702 return list(self.headers.items())
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000703
Antoine Pitroub353c122009-02-11 00:39:14 +0000704 # We override IOBase.__iter__ so that it doesn't check for closed-ness
705
706 def __iter__(self):
707 return self
708
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000709 # For compatibility with old-style urllib responses.
710
711 def info(self):
712 return self.headers
713
714 def geturl(self):
715 return self.url
716
717 def getcode(self):
718 return self.status
Greg Stein5e0fa402000-06-26 08:28:01 +0000719
720class HTTPConnection:
721
Greg Steindd6eefb2000-07-18 09:09:48 +0000722 _http_vsn = 11
723 _http_vsn_str = 'HTTP/1.1'
Greg Stein5e0fa402000-06-26 08:28:01 +0000724
Greg Steindd6eefb2000-07-18 09:09:48 +0000725 response_class = HTTPResponse
726 default_port = HTTP_PORT
727 auto_open = 1
Jeremy Hylton30f86742000-09-18 22:50:38 +0000728 debuglevel = 0
Antoine Pitrou90e47742013-01-02 22:10:47 +0100729 # TCP Maximum Segment Size (MSS) is determined by the TCP stack on
730 # a per-connection basis. There is no simple and efficient
731 # platform independent mechanism for determining the MSS, so
732 # instead a reasonable estimate is chosen. The getsockopt()
733 # interface using the TCP_MAXSEG parameter may be a suitable
734 # approach on some operating systems. A value of 16KiB is chosen
735 # as a reasonable estimate of the maximum MSS.
736 mss = 16384
Greg Stein5e0fa402000-06-26 08:28:01 +0000737
Senthil Kumaran052ddb02013-03-18 14:11:41 -0700738 def __init__(self, host, port=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
739 source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000740 self.timeout = timeout
Gregory P. Smithb4066372010-01-03 03:28:29 +0000741 self.source_address = source_address
Greg Steindd6eefb2000-07-18 09:09:48 +0000742 self.sock = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000743 self._buffer = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000744 self.__response = None
745 self.__state = _CS_IDLE
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000746 self._method = None
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000747 self._tunnel_host = None
748 self._tunnel_port = None
Georg Brandlc7c199f2011-01-22 22:06:24 +0000749 self._tunnel_headers = {}
Tim Petersc411dba2002-07-16 21:35:23 +0000750
Greg Steindd6eefb2000-07-18 09:09:48 +0000751 self._set_hostport(host, port)
Greg Stein5e0fa402000-06-26 08:28:01 +0000752
Senthil Kumaran47fff872009-12-20 07:10:31 +0000753 def set_tunnel(self, host, port=None, headers=None):
754 """ Sets up the host and the port for the HTTP CONNECT Tunnelling.
755
756 The headers argument should be a mapping of extra HTTP headers
757 to send with the CONNECT request.
758 """
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000759 self._tunnel_host = host
760 self._tunnel_port = port
Senthil Kumaran47fff872009-12-20 07:10:31 +0000761 if headers:
762 self._tunnel_headers = headers
763 else:
764 self._tunnel_headers.clear()
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000765
Greg Steindd6eefb2000-07-18 09:09:48 +0000766 def _set_hostport(self, host, port):
767 if port is None:
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000768 i = host.rfind(':')
Skip Montanarocae14d22004-09-14 17:55:21 +0000769 j = host.rfind(']') # ipv6 addresses have [...]
770 if i > j:
Skip Montanaro9d389972002-03-24 16:53:50 +0000771 try:
772 port = int(host[i+1:])
773 except ValueError:
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200774 if host[i+1:] == "": # http://foo.com:/ == http://foo.com/
775 port = self.default_port
776 else:
777 raise InvalidURL("nonnumeric port: '%s'" % host[i+1:])
Greg Steindd6eefb2000-07-18 09:09:48 +0000778 host = host[:i]
779 else:
780 port = self.default_port
Raymond Hettinger4d037912004-10-14 15:23:38 +0000781 if host and host[0] == '[' and host[-1] == ']':
Brett Cannon0a1af4a2004-09-15 23:26:23 +0000782 host = host[1:-1]
Greg Steindd6eefb2000-07-18 09:09:48 +0000783 self.host = host
784 self.port = port
Greg Stein5e0fa402000-06-26 08:28:01 +0000785
Jeremy Hylton30f86742000-09-18 22:50:38 +0000786 def set_debuglevel(self, level):
787 self.debuglevel = level
788
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000789 def _tunnel(self):
790 self._set_hostport(self._tunnel_host, self._tunnel_port)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000791 connect_str = "CONNECT %s:%d HTTP/1.0\r\n" % (self.host, self.port)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000792 connect_bytes = connect_str.encode("ascii")
793 self.send(connect_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000794 for header, value in self._tunnel_headers.items():
Senthil Kumaran47fff872009-12-20 07:10:31 +0000795 header_str = "%s: %s\r\n" % (header, value)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000796 header_bytes = header_str.encode("latin-1")
Senthil Kumaran47fff872009-12-20 07:10:31 +0000797 self.send(header_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000798 self.send(b'\r\n')
Senthil Kumaran47fff872009-12-20 07:10:31 +0000799
Georg Brandlc7c199f2011-01-22 22:06:24 +0000800 response = self.response_class(self.sock, method=self._method)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000801 (version, code, message) = response._read_status()
Senthil Kumaran47fff872009-12-20 07:10:31 +0000802
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000803 if code != 200:
804 self.close()
Andrew Svetlov0832af62012-12-18 23:10:48 +0200805 raise OSError("Tunnel connection failed: %d %s" % (code,
806 message.strip()))
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000807 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000808 line = response.fp.readline(_MAXLINE + 1)
809 if len(line) > _MAXLINE:
810 raise LineTooLong("header line")
Senthil Kumaranb12771a2012-04-23 23:50:07 +0800811 if not line:
812 # for sites which EOF without sending a trailer
813 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800814 if line in (b'\r\n', b'\n', b''):
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000815 break
816
Greg Steindd6eefb2000-07-18 09:09:48 +0000817 def connect(self):
818 """Connect to the host and port specified in __init__."""
Guido van Rossumd8faa362007-04-27 19:54:29 +0000819 self.sock = socket.create_connection((self.host,self.port),
Gregory P. Smithb4066372010-01-03 03:28:29 +0000820 self.timeout, self.source_address)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000821 if self._tunnel_host:
822 self._tunnel()
Greg Stein5e0fa402000-06-26 08:28:01 +0000823
Greg Steindd6eefb2000-07-18 09:09:48 +0000824 def close(self):
825 """Close the connection to the HTTP server."""
826 if self.sock:
Tim Peters07e99cb2001-01-14 23:47:14 +0000827 self.sock.close() # close it manually... there may be other refs
Greg Steindd6eefb2000-07-18 09:09:48 +0000828 self.sock = None
829 if self.__response:
830 self.__response.close()
831 self.__response = None
832 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000833
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000834 def send(self, data):
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000835 """Send `data' to the server.
836 ``data`` can be a string object, a bytes object, an array object, a
837 file-like object that supports a .read() method, or an iterable object.
838 """
839
Greg Steindd6eefb2000-07-18 09:09:48 +0000840 if self.sock is None:
841 if self.auto_open:
842 self.connect()
843 else:
844 raise NotConnected()
Greg Stein5e0fa402000-06-26 08:28:01 +0000845
Jeremy Hylton30f86742000-09-18 22:50:38 +0000846 if self.debuglevel > 0:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000847 print("send:", repr(data))
Jeremy Hylton636950f2009-03-28 04:34:21 +0000848 blocksize = 8192
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000849 if hasattr(data, "read") :
Jeremy Hylton636950f2009-03-28 04:34:21 +0000850 if self.debuglevel > 0:
851 print("sendIng a read()able")
852 encode = False
Antoine Pitrouead1d622009-09-29 18:44:53 +0000853 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000854 mode = data.mode
Antoine Pitrouead1d622009-09-29 18:44:53 +0000855 except AttributeError:
856 # io.BytesIO and other file-like objects don't have a `mode`
857 # attribute.
858 pass
859 else:
860 if "b" not in mode:
861 encode = True
862 if self.debuglevel > 0:
863 print("encoding file using iso-8859-1")
Jeremy Hylton636950f2009-03-28 04:34:21 +0000864 while 1:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000865 datablock = data.read(blocksize)
866 if not datablock:
Jeremy Hylton636950f2009-03-28 04:34:21 +0000867 break
868 if encode:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000869 datablock = datablock.encode("iso-8859-1")
870 self.sock.sendall(datablock)
Andrew Svetlov7b2c8bb2013-04-12 22:49:19 +0300871 return
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000872 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000873 self.sock.sendall(data)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000874 except TypeError:
875 if isinstance(data, collections.Iterable):
876 for d in data:
877 self.sock.sendall(d)
878 else:
Georg Brandl25e2cd12011-08-03 08:27:00 +0200879 raise TypeError("data should be a bytes-like object "
880 "or an iterable, got %r" % type(data))
Greg Stein5e0fa402000-06-26 08:28:01 +0000881
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000882 def _output(self, s):
883 """Add a line of output to the current request buffer.
Tim Peters469cdad2002-08-08 20:19:19 +0000884
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000885 Assumes that the line does *not* end with \\r\\n.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000886 """
887 self._buffer.append(s)
888
Benjamin Peterson1742e402008-11-30 22:15:29 +0000889 def _send_output(self, message_body=None):
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000890 """Send the currently buffered request and clear the buffer.
891
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000892 Appends an extra \\r\\n to the buffer.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000893 A message_body may be specified, to be appended to the request.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000894 """
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000895 self._buffer.extend((b"", b""))
896 msg = b"\r\n".join(self._buffer)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000897 del self._buffer[:]
Benjamin Peterson1742e402008-11-30 22:15:29 +0000898 # If msg and message_body are sent in a single send() call,
899 # it will avoid performance problems caused by the interaction
Antoine Pitrou90e47742013-01-02 22:10:47 +0100900 # between delayed ack and the Nagle algorithm. However,
901 # there is no performance gain if the message is larger
902 # than MSS (and there is a memory penalty for the message
903 # copy).
904 if isinstance(message_body, bytes) and len(message_body) < self.mss:
Benjamin Peterson1742e402008-11-30 22:15:29 +0000905 msg += message_body
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000906 message_body = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000907 self.send(msg)
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000908 if message_body is not None:
Jeremy Hylton236654b2009-03-27 20:24:34 +0000909 # message_body was not a string (i.e. it is a file), and
910 # we must run the risk of Nagle.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000911 self.send(message_body)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000912
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000913 def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0):
Greg Steindd6eefb2000-07-18 09:09:48 +0000914 """Send a request to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000915
Greg Steindd6eefb2000-07-18 09:09:48 +0000916 `method' specifies an HTTP request method, e.g. 'GET'.
917 `url' specifies the object being requested, e.g. '/index.html'.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000918 `skip_host' if True does not add automatically a 'Host:' header
919 `skip_accept_encoding' if True does not add automatically an
920 'Accept-Encoding:' header
Greg Steindd6eefb2000-07-18 09:09:48 +0000921 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000922
Greg Stein616a58d2003-06-24 06:35:19 +0000923 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000924 if self.__response and self.__response.isclosed():
925 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000926
Tim Peters58eb11c2004-01-18 20:29:55 +0000927
Greg Steindd6eefb2000-07-18 09:09:48 +0000928 # in certain cases, we cannot issue another request on this connection.
929 # this occurs when:
930 # 1) we are in the process of sending a request. (_CS_REQ_STARTED)
931 # 2) a response to a previous request has signalled that it is going
932 # to close the connection upon completion.
933 # 3) the headers for the previous response have not been read, thus
934 # we cannot determine whether point (2) is true. (_CS_REQ_SENT)
935 #
936 # if there is no prior response, then we can request at will.
937 #
938 # if point (2) is true, then we will have passed the socket to the
939 # response (effectively meaning, "there is no prior response"), and
940 # will open a new one when a new request is made.
941 #
942 # Note: if a prior response exists, then we *can* start a new request.
943 # We are not allowed to begin fetching the response to this new
944 # request, however, until that prior response is complete.
945 #
946 if self.__state == _CS_IDLE:
947 self.__state = _CS_REQ_STARTED
948 else:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000949 raise CannotSendRequest(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +0000950
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000951 # Save the method we use, we need it later in the response phase
952 self._method = method
Greg Steindd6eefb2000-07-18 09:09:48 +0000953 if not url:
954 url = '/'
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000955 request = '%s %s %s' % (method, url, self._http_vsn_str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000956
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000957 # Non-ASCII characters should have been eliminated earlier
958 self._output(request.encode('ascii'))
Greg Stein5e0fa402000-06-26 08:28:01 +0000959
Greg Steindd6eefb2000-07-18 09:09:48 +0000960 if self._http_vsn == 11:
961 # Issue some standard headers for better HTTP/1.1 compliance
Greg Stein5e0fa402000-06-26 08:28:01 +0000962
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000963 if not skip_host:
964 # this header is issued *only* for HTTP/1.1
965 # connections. more specifically, this means it is
966 # only issued when the client uses the new
967 # HTTPConnection() class. backwards-compat clients
968 # will be using HTTP/1.0 and those clients may be
969 # issuing this header themselves. we should NOT issue
970 # it twice; some web servers (such as Apache) barf
971 # when they see two Host: headers
Guido van Rossumf6922aa2001-01-14 21:03:01 +0000972
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000973 # If we need a non-standard port,include it in the
974 # header. If the request is going through a proxy,
975 # but the host of the actual URL, not the host of the
976 # proxy.
Jeremy Hylton8acf1e02002-03-08 19:35:51 +0000977
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000978 netloc = ''
979 if url.startswith('http'):
980 nil, netloc, nil, nil, nil = urlsplit(url)
981
982 if netloc:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000983 try:
984 netloc_enc = netloc.encode("ascii")
985 except UnicodeEncodeError:
986 netloc_enc = netloc.encode("idna")
987 self.putheader('Host', netloc_enc)
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000988 else:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000989 try:
990 host_enc = self.host.encode("ascii")
991 except UnicodeEncodeError:
992 host_enc = self.host.encode("idna")
Senthil Kumaran74ebd9e2010-11-13 12:27:49 +0000993
994 # As per RFC 273, IPv6 address should be wrapped with []
995 # when used as Host header
996
997 if self.host.find(':') >= 0:
998 host_enc = b'[' + host_enc + b']'
999
Georg Brandl86b2fb92008-07-16 03:43:04 +00001000 if self.port == self.default_port:
Thomas Wouters477c8d52006-05-27 19:21:47 +00001001 self.putheader('Host', host_enc)
1002 else:
Guido van Rossum98297ee2007-11-06 21:34:58 +00001003 host_enc = host_enc.decode("ascii")
Thomas Wouters477c8d52006-05-27 19:21:47 +00001004 self.putheader('Host', "%s:%s" % (host_enc, self.port))
Greg Stein5e0fa402000-06-26 08:28:01 +00001005
Greg Steindd6eefb2000-07-18 09:09:48 +00001006 # note: we are assuming that clients will not attempt to set these
1007 # headers since *this* library must deal with the
1008 # consequences. this also means that when the supporting
1009 # libraries are updated to recognize other forms, then this
1010 # code should be changed (removed or updated).
Greg Stein5e0fa402000-06-26 08:28:01 +00001011
Greg Steindd6eefb2000-07-18 09:09:48 +00001012 # we only want a Content-Encoding of "identity" since we don't
1013 # support encodings such as x-gzip or x-deflate.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +00001014 if not skip_accept_encoding:
1015 self.putheader('Accept-Encoding', 'identity')
Greg Stein5e0fa402000-06-26 08:28:01 +00001016
Greg Steindd6eefb2000-07-18 09:09:48 +00001017 # we can accept "chunked" Transfer-Encodings, but no others
1018 # NOTE: no TE header implies *only* "chunked"
1019 #self.putheader('TE', 'chunked')
Greg Stein5e0fa402000-06-26 08:28:01 +00001020
Greg Steindd6eefb2000-07-18 09:09:48 +00001021 # if TE is supplied in the header, then it must appear in a
1022 # Connection header.
1023 #self.putheader('Connection', 'TE')
Greg Stein5e0fa402000-06-26 08:28:01 +00001024
Greg Steindd6eefb2000-07-18 09:09:48 +00001025 else:
1026 # For HTTP/1.0, the server will assume "not chunked"
1027 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001028
Benjamin Petersonf608c612008-11-16 18:33:53 +00001029 def putheader(self, header, *values):
Greg Steindd6eefb2000-07-18 09:09:48 +00001030 """Send a request header line to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001031
Greg Steindd6eefb2000-07-18 09:09:48 +00001032 For example: h.putheader('Accept', 'text/html')
1033 """
1034 if self.__state != _CS_REQ_STARTED:
1035 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +00001036
Guido van Rossum98297ee2007-11-06 21:34:58 +00001037 if hasattr(header, 'encode'):
1038 header = header.encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +00001039 values = list(values)
1040 for i, one_value in enumerate(values):
1041 if hasattr(one_value, 'encode'):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001042 values[i] = one_value.encode('latin-1')
Senthil Kumaran58d5dbf2010-10-03 18:22:42 +00001043 elif isinstance(one_value, int):
1044 values[i] = str(one_value).encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +00001045 value = b'\r\n\t'.join(values)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001046 header = header + b': ' + value
1047 self._output(header)
Greg Stein5e0fa402000-06-26 08:28:01 +00001048
Benjamin Peterson1742e402008-11-30 22:15:29 +00001049 def endheaders(self, message_body=None):
1050 """Indicate that the last header line has been sent to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001051
Senthil Kumaranad87fa62011-10-05 23:26:49 +08001052 This method sends the request to the server. The optional message_body
1053 argument can be used to pass a message body associated with the
1054 request. The message body will be sent in the same packet as the
1055 message headers if it is a string, otherwise it is sent as a separate
1056 packet.
Benjamin Peterson1742e402008-11-30 22:15:29 +00001057 """
Greg Steindd6eefb2000-07-18 09:09:48 +00001058 if self.__state == _CS_REQ_STARTED:
1059 self.__state = _CS_REQ_SENT
1060 else:
1061 raise CannotSendHeader()
Benjamin Peterson1742e402008-11-30 22:15:29 +00001062 self._send_output(message_body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001063
Greg Steindd6eefb2000-07-18 09:09:48 +00001064 def request(self, method, url, body=None, headers={}):
1065 """Send a complete request to the server."""
Jeremy Hylton636950f2009-03-28 04:34:21 +00001066 self._send_request(method, url, body, headers)
Greg Stein5e0fa402000-06-26 08:28:01 +00001067
Benjamin Peterson1742e402008-11-30 22:15:29 +00001068 def _set_content_length(self, body):
1069 # Set the content-length based on the body.
1070 thelen = None
1071 try:
1072 thelen = str(len(body))
1073 except TypeError as te:
1074 # If this is a file-like object, try to
1075 # fstat its file descriptor
Benjamin Peterson1742e402008-11-30 22:15:29 +00001076 try:
1077 thelen = str(os.fstat(body.fileno()).st_size)
1078 except (AttributeError, OSError):
1079 # Don't send a length if this failed
1080 if self.debuglevel > 0: print("Cannot stat!!")
1081
1082 if thelen is not None:
1083 self.putheader('Content-Length', thelen)
1084
Greg Steindd6eefb2000-07-18 09:09:48 +00001085 def _send_request(self, method, url, body, headers):
Jeremy Hylton636950f2009-03-28 04:34:21 +00001086 # Honor explicitly requested Host: and Accept-Encoding: headers.
Jeremy Hylton2c178252004-08-07 16:28:14 +00001087 header_names = dict.fromkeys([k.lower() for k in headers])
1088 skips = {}
1089 if 'host' in header_names:
1090 skips['skip_host'] = 1
1091 if 'accept-encoding' in header_names:
1092 skips['skip_accept_encoding'] = 1
Greg Stein5e0fa402000-06-26 08:28:01 +00001093
Jeremy Hylton2c178252004-08-07 16:28:14 +00001094 self.putrequest(method, url, **skips)
1095
Senthil Kumaran5fa4a892012-05-19 16:58:09 +08001096 if body is not None and ('content-length' not in header_names):
Benjamin Peterson1742e402008-11-30 22:15:29 +00001097 self._set_content_length(body)
Guido van Rossumcc2b0162007-02-11 06:12:03 +00001098 for hdr, value in headers.items():
Greg Steindd6eefb2000-07-18 09:09:48 +00001099 self.putheader(hdr, value)
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001100 if isinstance(body, str):
Jeremy Hylton236654b2009-03-27 20:24:34 +00001101 # RFC 2616 Section 3.7.1 says that text default has a
1102 # default charset of iso-8859-1.
1103 body = body.encode('iso-8859-1')
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001104 self.endheaders(body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001105
Greg Steindd6eefb2000-07-18 09:09:48 +00001106 def getresponse(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001107 """Get the response from the server.
1108
1109 If the HTTPConnection is in the correct state, returns an
1110 instance of HTTPResponse or of whatever object is returned by
1111 class the response_class variable.
1112
1113 If a request has not been sent or if a previous response has
1114 not be handled, ResponseNotReady is raised. If the HTTP
1115 response indicates that the connection should be closed, then
1116 it will be closed before the response is returned. When the
1117 connection is closed, the underlying socket is closed.
1118 """
Greg Stein5e0fa402000-06-26 08:28:01 +00001119
Greg Stein616a58d2003-06-24 06:35:19 +00001120 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +00001121 if self.__response and self.__response.isclosed():
1122 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +00001123
Greg Steindd6eefb2000-07-18 09:09:48 +00001124 # if a prior response exists, then it must be completed (otherwise, we
1125 # cannot read this response's header to determine the connection-close
1126 # behavior)
1127 #
1128 # note: if a prior response existed, but was connection-close, then the
1129 # socket and response were made independent of this HTTPConnection
1130 # object since a new request requires that we open a whole new
1131 # connection
1132 #
1133 # this means the prior response had one of two states:
1134 # 1) will_close: this connection was reset and the prior socket and
1135 # response operate independently
1136 # 2) persistent: the response was retained and we await its
1137 # isclosed() status to become true.
1138 #
1139 if self.__state != _CS_REQ_SENT or self.__response:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001140 raise ResponseNotReady(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +00001141
Jeremy Hylton30f86742000-09-18 22:50:38 +00001142 if self.debuglevel > 0:
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001143 response = self.response_class(self.sock, self.debuglevel,
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +00001144 method=self._method)
Jeremy Hylton30f86742000-09-18 22:50:38 +00001145 else:
Antoine Pitrou988dbd72010-12-17 17:35:56 +00001146 response = self.response_class(self.sock, method=self._method)
Greg Stein5e0fa402000-06-26 08:28:01 +00001147
Jeremy Hylton39c03802002-07-12 14:04:09 +00001148 response.begin()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +00001149 assert response.will_close != _UNKNOWN
Greg Steindd6eefb2000-07-18 09:09:48 +00001150 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +00001151
Greg Steindd6eefb2000-07-18 09:09:48 +00001152 if response.will_close:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001153 # this effectively passes the connection to the response
1154 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +00001155 else:
1156 # remember this, so we can tell when it is complete
1157 self.__response = response
Greg Stein5e0fa402000-06-26 08:28:01 +00001158
Greg Steindd6eefb2000-07-18 09:09:48 +00001159 return response
Greg Stein5e0fa402000-06-26 08:28:01 +00001160
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001161try:
1162 import ssl
Brett Cannoncd171c82013-07-04 17:43:24 -04001163except ImportError:
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001164 pass
1165else:
1166 class HTTPSConnection(HTTPConnection):
1167 "This class allows communication via SSL."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001168
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001169 default_port = HTTPS_PORT
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001170
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001171 # XXX Should key_file and cert_file be deprecated in favour of context?
1172
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001173 def __init__(self, host, port=None, key_file=None, cert_file=None,
Senthil Kumaran052ddb02013-03-18 14:11:41 -07001174 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
1175 source_address=None, *, context=None,
1176 check_hostname=None):
1177 super(HTTPSConnection, self).__init__(host, port, timeout,
Gregory P. Smithb4066372010-01-03 03:28:29 +00001178 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001179 self.key_file = key_file
1180 self.cert_file = cert_file
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001181 if context is None:
Christian Heimes67986f92013-11-23 22:43:47 +01001182 context = ssl._create_stdlib_context()
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001183 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