blob: ba7d6fc38cf9d7ea7e37c7a26125f3597c0f68ad [file] [log] [blame]
Greg Stein5e0fa402000-06-26 08:28:01 +00001"""HTTP/1.1 client library
Guido van Rossum41999c11997-12-09 00:12:23 +00002
Greg Stein5e0fa402000-06-26 08:28:01 +00003<intro stuff goes here>
4<other stuff, too>
Guido van Rossum41999c11997-12-09 00:12:23 +00005
Thomas Wouters0e3f5912006-08-11 14:57:12 +00006HTTPConnection goes through a number of "states", which define when a client
Greg Stein5e0fa402000-06-26 08:28:01 +00007may legally make another request or fetch the response for a particular
8request. This diagram details these state transitions:
Guido van Rossum41999c11997-12-09 00:12:23 +00009
Greg Stein5e0fa402000-06-26 08:28:01 +000010 (null)
11 |
12 | HTTPConnection()
13 v
14 Idle
15 |
16 | putrequest()
17 v
18 Request-started
19 |
20 | ( putheader() )* endheaders()
21 v
22 Request-sent
23 |
24 | response = getresponse()
25 v
26 Unread-response [Response-headers-read]
27 |\____________________
Tim Peters5ceadc82001-01-13 19:16:21 +000028 | |
29 | response.read() | putrequest()
30 v v
31 Idle Req-started-unread-response
32 ______/|
33 / |
34 response.read() | | ( putheader() )* endheaders()
35 v v
36 Request-started Req-sent-unread-response
37 |
38 | response.read()
39 v
40 Request-sent
Greg Stein5e0fa402000-06-26 08:28:01 +000041
42This diagram presents the following rules:
43 -- a second request may not be started until {response-headers-read}
44 -- a response [object] cannot be retrieved until {request-sent}
45 -- there is no differentiation between an unread response body and a
46 partially read response body
47
48Note: this enforcement is applied by the HTTPConnection class. The
49 HTTPResponse class does not enforce this state machine, which
50 implies sophisticated clients may accelerate the request/response
51 pipeline. Caution should be taken, though: accelerating the states
52 beyond the above pattern may imply knowledge of the server's
53 connection-close behavior for certain requests. For example, it
54 is impossible to tell whether the server will close the connection
55 UNTIL the response headers have been read; this means that further
56 requests cannot be placed into the pipeline until it is known that
57 the server will NOT be closing the connection.
58
59Logical State __state __response
60------------- ------- ----------
61Idle _CS_IDLE None
62Request-started _CS_REQ_STARTED None
63Request-sent _CS_REQ_SENT None
64Unread-response _CS_IDLE <response_class>
65Req-started-unread-response _CS_REQ_STARTED <response_class>
66Req-sent-unread-response _CS_REQ_SENT <response_class>
Guido van Rossum41999c11997-12-09 00:12:23 +000067"""
Guido van Rossum23acc951994-02-21 16:36:04 +000068
Barry Warsaw820c1202008-06-12 04:06:45 +000069import email.parser
70import email.message
Jeremy Hylton636950f2009-03-28 04:34:21 +000071import io
72import os
73import socket
Senthil Kumaran7bc0d872010-12-19 10:49:52 +000074import collections
Jeremy Hylton1afc1692008-06-18 20:49:58 +000075from urllib.parse import urlsplit
Thomas Wouters89d996e2007-09-08 17:39:28 +000076import warnings
Guido van Rossum23acc951994-02-21 16:36:04 +000077
Thomas Wouters47b49bf2007-08-30 22:15:33 +000078__all__ = ["HTTPResponse", "HTTPConnection",
Skip Montanaro951a8842001-06-01 16:25:38 +000079 "HTTPException", "NotConnected", "UnknownProtocol",
Jeremy Hylton7c75c992002-06-28 23:38:14 +000080 "UnknownTransferEncoding", "UnimplementedFileMode",
81 "IncompleteRead", "InvalidURL", "ImproperConnectionState",
82 "CannotSendRequest", "CannotSendHeader", "ResponseNotReady",
Georg Brandl6aab16e2006-02-17 19:17:25 +000083 "BadStatusLine", "error", "responses"]
Skip Montanaro2dd42762001-01-23 15:35:05 +000084
Guido van Rossum23acc951994-02-21 16:36:04 +000085HTTP_PORT = 80
Guido van Rossum09c8b6c1999-12-07 21:37:17 +000086HTTPS_PORT = 443
87
Greg Stein5e0fa402000-06-26 08:28:01 +000088_UNKNOWN = 'UNKNOWN'
89
90# connection states
91_CS_IDLE = 'Idle'
92_CS_REQ_STARTED = 'Request-started'
93_CS_REQ_SENT = 'Request-sent'
94
Martin v. Löwis39a31782004-09-18 09:03:49 +000095# status codes
96# informational
97CONTINUE = 100
98SWITCHING_PROTOCOLS = 101
99PROCESSING = 102
100
101# successful
102OK = 200
103CREATED = 201
104ACCEPTED = 202
105NON_AUTHORITATIVE_INFORMATION = 203
106NO_CONTENT = 204
107RESET_CONTENT = 205
108PARTIAL_CONTENT = 206
109MULTI_STATUS = 207
110IM_USED = 226
111
112# redirection
113MULTIPLE_CHOICES = 300
114MOVED_PERMANENTLY = 301
115FOUND = 302
116SEE_OTHER = 303
117NOT_MODIFIED = 304
118USE_PROXY = 305
119TEMPORARY_REDIRECT = 307
120
121# client error
122BAD_REQUEST = 400
123UNAUTHORIZED = 401
124PAYMENT_REQUIRED = 402
125FORBIDDEN = 403
126NOT_FOUND = 404
127METHOD_NOT_ALLOWED = 405
128NOT_ACCEPTABLE = 406
129PROXY_AUTHENTICATION_REQUIRED = 407
130REQUEST_TIMEOUT = 408
131CONFLICT = 409
132GONE = 410
133LENGTH_REQUIRED = 411
134PRECONDITION_FAILED = 412
135REQUEST_ENTITY_TOO_LARGE = 413
136REQUEST_URI_TOO_LONG = 414
137UNSUPPORTED_MEDIA_TYPE = 415
138REQUESTED_RANGE_NOT_SATISFIABLE = 416
139EXPECTATION_FAILED = 417
140UNPROCESSABLE_ENTITY = 422
141LOCKED = 423
142FAILED_DEPENDENCY = 424
143UPGRADE_REQUIRED = 426
Hynek Schlawack51b2ed52012-05-16 09:51:07 +0200144PRECONDITION_REQUIRED = 428
145TOO_MANY_REQUESTS = 429
146REQUEST_HEADER_FIELDS_TOO_LARGE = 431
Martin v. Löwis39a31782004-09-18 09:03:49 +0000147
148# server error
149INTERNAL_SERVER_ERROR = 500
150NOT_IMPLEMENTED = 501
151BAD_GATEWAY = 502
152SERVICE_UNAVAILABLE = 503
153GATEWAY_TIMEOUT = 504
154HTTP_VERSION_NOT_SUPPORTED = 505
155INSUFFICIENT_STORAGE = 507
156NOT_EXTENDED = 510
Hynek Schlawack51b2ed52012-05-16 09:51:07 +0200157NETWORK_AUTHENTICATION_REQUIRED = 511
Martin v. Löwis39a31782004-09-18 09:03:49 +0000158
Georg Brandl6aab16e2006-02-17 19:17:25 +0000159# Mapping status codes to official W3C names
160responses = {
161 100: 'Continue',
162 101: 'Switching Protocols',
163
164 200: 'OK',
165 201: 'Created',
166 202: 'Accepted',
167 203: 'Non-Authoritative Information',
168 204: 'No Content',
169 205: 'Reset Content',
170 206: 'Partial Content',
171
172 300: 'Multiple Choices',
173 301: 'Moved Permanently',
174 302: 'Found',
175 303: 'See Other',
176 304: 'Not Modified',
177 305: 'Use Proxy',
178 306: '(Unused)',
179 307: 'Temporary Redirect',
180
181 400: 'Bad Request',
182 401: 'Unauthorized',
183 402: 'Payment Required',
184 403: 'Forbidden',
185 404: 'Not Found',
186 405: 'Method Not Allowed',
187 406: 'Not Acceptable',
188 407: 'Proxy Authentication Required',
189 408: 'Request Timeout',
190 409: 'Conflict',
191 410: 'Gone',
192 411: 'Length Required',
193 412: 'Precondition Failed',
194 413: 'Request Entity Too Large',
195 414: 'Request-URI Too Long',
196 415: 'Unsupported Media Type',
197 416: 'Requested Range Not Satisfiable',
198 417: 'Expectation Failed',
Hynek Schlawack51b2ed52012-05-16 09:51:07 +0200199 428: 'Precondition Required',
200 429: 'Too Many Requests',
201 431: 'Request Header Fields Too Large',
Georg Brandl6aab16e2006-02-17 19:17:25 +0000202
203 500: 'Internal Server Error',
204 501: 'Not Implemented',
205 502: 'Bad Gateway',
206 503: 'Service Unavailable',
207 504: 'Gateway Timeout',
208 505: 'HTTP Version Not Supported',
Hynek Schlawack51b2ed52012-05-16 09:51:07 +0200209 511: 'Network Authentication Required',
Georg Brandl6aab16e2006-02-17 19:17:25 +0000210}
211
Georg Brandl80ba8e82005-09-29 20:16:07 +0000212# maximal amount of data to read at one time in _safe_read
213MAXAMOUNT = 1048576
214
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000215# maximal line length when calling readline().
216_MAXLINE = 65536
217
Barry Warsaw820c1202008-06-12 04:06:45 +0000218class HTTPMessage(email.message.Message):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000219 # XXX The only usage of this method is in
220 # http.server.CGIHTTPRequestHandler. Maybe move the code there so
221 # that it doesn't need to be part of the public API. The API has
222 # never been defined so this could cause backwards compatibility
223 # issues.
224
Barry Warsaw820c1202008-06-12 04:06:45 +0000225 def getallmatchingheaders(self, name):
226 """Find all header lines matching a given header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000227
Barry Warsaw820c1202008-06-12 04:06:45 +0000228 Look through the list of headers and find all lines matching a given
229 header name (and their continuation lines). A list of the lines is
230 returned, without interpretation. If the header does not occur, an
231 empty list is returned. If the header occurs multiple times, all
232 occurrences are returned. Case is not important in the header name.
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000233
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000234 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000235 name = name.lower() + ':'
236 n = len(name)
237 lst = []
238 hit = 0
239 for line in self.keys():
240 if line[:n].lower() == name:
241 hit = 1
242 elif not line[:1].isspace():
243 hit = 0
244 if hit:
245 lst.append(line)
246 return lst
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000247
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000248def parse_headers(fp, _class=HTTPMessage):
Barry Warsaw820c1202008-06-12 04:06:45 +0000249 """Parses only RFC2822 headers from a file pointer.
250
251 email Parser wants to see strings rather than bytes.
252 But a TextIOWrapper around self.rfile would buffer too many bytes
253 from the stream, bytes which we later need to read as bytes.
254 So we read the correct bytes here, as bytes, for email Parser
255 to parse.
256
257 """
Barry Warsaw820c1202008-06-12 04:06:45 +0000258 headers = []
259 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000260 line = fp.readline(_MAXLINE + 1)
261 if len(line) > _MAXLINE:
262 raise LineTooLong("header line")
Barry Warsaw820c1202008-06-12 04:06:45 +0000263 headers.append(line)
264 if line in (b'\r\n', b'\n', b''):
265 break
266 hstring = b''.join(headers).decode('iso-8859-1')
Jeremy Hylton98eb6c22009-03-27 18:31:36 +0000267 return email.parser.Parser(_class=_class).parsestr(hstring)
Greg Stein5e0fa402000-06-26 08:28:01 +0000268
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000269
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000270_strict_sentinel = object()
271
272class HTTPResponse(io.RawIOBase):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000273
274 # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details.
275
Jeremy Hylton811fc142007-08-03 13:30:02 +0000276 # The bytes from the socket object are iso-8859-1 strings.
277 # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded
278 # text following RFC 2047. The basic status line parsing only
279 # accepts iso-8859-1.
280
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000281 def __init__(self, sock, debuglevel=0, strict=_strict_sentinel, method=None, url=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000282 # If the response includes a content-length header, we need to
283 # make sure that the client doesn't read more than the
Jeremy Hylton39b198d2007-08-04 19:22:00 +0000284 # specified number of bytes. If it does, it will block until
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000285 # the server times out and closes the connection. This will
286 # happen if a self.fp.read() is done (without a size) whether
287 # self.fp is buffered or not. So, no self.fp.read() by
288 # clients unless they know what they are doing.
Benjamin Petersonf72d9fb2009-02-08 00:29:20 +0000289 self.fp = sock.makefile("rb")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000290 self.debuglevel = debuglevel
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000291 if strict is not _strict_sentinel:
292 warnings.warn("the 'strict' argument isn't supported anymore; "
293 "http.client now always assumes HTTP/1.x compliant servers.",
294 DeprecationWarning, 2)
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000295 self._method = method
Greg Stein5e0fa402000-06-26 08:28:01 +0000296
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000297 # The HTTPResponse object is returned via urllib. The clients
298 # of http and urllib expect different attributes for the
299 # headers. headers is used here and supports urllib. msg is
300 # provided as a backwards compatibility layer for http
301 # clients.
302
303 self.headers = self.msg = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000304
Greg Steindd6eefb2000-07-18 09:09:48 +0000305 # from the Status-Line of the response
Tim Peters07e99cb2001-01-14 23:47:14 +0000306 self.version = _UNKNOWN # HTTP-Version
307 self.status = _UNKNOWN # Status-Code
308 self.reason = _UNKNOWN # Reason-Phrase
Greg Stein5e0fa402000-06-26 08:28:01 +0000309
Tim Peters07e99cb2001-01-14 23:47:14 +0000310 self.chunked = _UNKNOWN # is "chunked" being used?
311 self.chunk_left = _UNKNOWN # bytes left to read in current chunk
312 self.length = _UNKNOWN # number of bytes left in response
313 self.will_close = _UNKNOWN # conn will close at end of response
Greg Stein5e0fa402000-06-26 08:28:01 +0000314
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000315 def _read_status(self):
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000316 line = str(self.fp.readline(_MAXLINE + 1), "iso-8859-1")
317 if len(line) > _MAXLINE:
318 raise LineTooLong("status line")
Jeremy Hylton30f86742000-09-18 22:50:38 +0000319 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000320 print("reply:", repr(line))
Jeremy Hyltonb6769522003-06-29 17:55:05 +0000321 if not line:
322 # Presumably, the server closed the connection before
323 # sending a valid response.
324 raise BadStatusLine(line)
Greg Steindd6eefb2000-07-18 09:09:48 +0000325 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000326 version, status, reason = line.split(None, 2)
Greg Steindd6eefb2000-07-18 09:09:48 +0000327 except ValueError:
328 try:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000329 version, status = line.split(None, 1)
Greg Steindd6eefb2000-07-18 09:09:48 +0000330 reason = ""
331 except ValueError:
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000332 # empty version will cause next test to fail.
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000333 version = ""
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000334 if not version.startswith("HTTP/"):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200335 self._close_conn()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000336 raise BadStatusLine(line)
Greg Stein5e0fa402000-06-26 08:28:01 +0000337
Jeremy Hylton23d40472001-04-13 14:57:08 +0000338 # The status code is a three-digit number
339 try:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000340 status = int(status)
Jeremy Hylton23d40472001-04-13 14:57:08 +0000341 if status < 100 or status > 999:
342 raise BadStatusLine(line)
343 except ValueError:
344 raise BadStatusLine(line)
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000345 return version, status, reason
Greg Stein5e0fa402000-06-26 08:28:01 +0000346
Jeremy Hylton39c03802002-07-12 14:04:09 +0000347 def begin(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000348 if self.headers is not None:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000349 # we've already started reading the response
350 return
351
352 # read until we get a non-100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000353 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000354 version, status, reason = self._read_status()
Martin v. Löwis39a31782004-09-18 09:03:49 +0000355 if status != CONTINUE:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000356 break
357 # skip the header from the 100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000358 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000359 skip = self.fp.readline(_MAXLINE + 1)
360 if len(skip) > _MAXLINE:
361 raise LineTooLong("header line")
362 skip = skip.strip()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000363 if not skip:
364 break
365 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000366 print("header:", skip)
Tim Petersc411dba2002-07-16 21:35:23 +0000367
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000368 self.code = self.status = status
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000369 self.reason = reason.strip()
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000370 if version in ("HTTP/1.0", "HTTP/0.9"):
371 # Some servers might still return "0.9", treat it as 1.0 anyway
Greg Steindd6eefb2000-07-18 09:09:48 +0000372 self.version = 10
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000373 elif version.startswith("HTTP/1."):
Tim Peters07e99cb2001-01-14 23:47:14 +0000374 self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1
Greg Steindd6eefb2000-07-18 09:09:48 +0000375 else:
376 raise UnknownProtocol(version)
Greg Stein5e0fa402000-06-26 08:28:01 +0000377
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000378 self.headers = self.msg = parse_headers(self.fp)
Barry Warsaw820c1202008-06-12 04:06:45 +0000379
Jeremy Hylton30f86742000-09-18 22:50:38 +0000380 if self.debuglevel > 0:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000381 for hdr in self.headers:
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000382 print("header:", hdr, end=" ")
Greg Stein5e0fa402000-06-26 08:28:01 +0000383
Greg Steindd6eefb2000-07-18 09:09:48 +0000384 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000385 tr_enc = self.headers.get("transfer-encoding")
Jeremy Hyltond229b3a2002-09-03 19:24:24 +0000386 if tr_enc and tr_enc.lower() == "chunked":
Jeremy Hylton236156f2008-12-15 03:00:50 +0000387 self.chunked = True
Greg Steindd6eefb2000-07-18 09:09:48 +0000388 self.chunk_left = None
389 else:
Jeremy Hylton236156f2008-12-15 03:00:50 +0000390 self.chunked = False
Greg Stein5e0fa402000-06-26 08:28:01 +0000391
Greg Steindd6eefb2000-07-18 09:09:48 +0000392 # will the connection close at the end of the response?
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000393 self.will_close = self._check_close()
Greg Stein5e0fa402000-06-26 08:28:01 +0000394
Greg Steindd6eefb2000-07-18 09:09:48 +0000395 # do we have a Content-Length?
396 # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked"
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000397 self.length = None
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000398 length = self.headers.get("content-length")
Barry Warsaw820c1202008-06-12 04:06:45 +0000399
400 # are we using the chunked-style of transfer encoding?
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000401 tr_enc = self.headers.get("transfer-encoding")
Greg Steindd6eefb2000-07-18 09:09:48 +0000402 if length and not self.chunked:
Jeremy Hylton30a81812000-09-14 20:34:27 +0000403 try:
404 self.length = int(length)
405 except ValueError:
Christian Heimesa612dc02008-02-24 13:08:18 +0000406 self.length = None
407 else:
408 if self.length < 0: # ignore nonsensical negative lengths
409 self.length = None
410 else:
411 self.length = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000412
Greg Steindd6eefb2000-07-18 09:09:48 +0000413 # does the body have a fixed length? (of zero)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000414 if (status == NO_CONTENT or status == NOT_MODIFIED or
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000415 100 <= status < 200 or # 1xx codes
Jeremy Hyltone5d0e842007-08-03 13:45:24 +0000416 self._method == "HEAD"):
Greg Steindd6eefb2000-07-18 09:09:48 +0000417 self.length = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000418
Greg Steindd6eefb2000-07-18 09:09:48 +0000419 # if the connection remains open, and we aren't using chunked, and
420 # a content-length was not provided, then assume that the connection
421 # WILL close.
Jeremy Hylton0ee5eeb2007-08-04 03:25:17 +0000422 if (not self.will_close and
423 not self.chunked and
424 self.length is None):
Jeremy Hylton236156f2008-12-15 03:00:50 +0000425 self.will_close = True
Greg Stein5e0fa402000-06-26 08:28:01 +0000426
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000427 def _check_close(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000428 conn = self.headers.get("connection")
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000429 if self.version == 11:
430 # An HTTP/1.1 proxy is assumed to stay open unless
431 # explicitly closed.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000432 conn = self.headers.get("connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000433 if conn and "close" in conn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000434 return True
435 return False
436
Jeremy Hylton2c178252004-08-07 16:28:14 +0000437 # Some HTTP/1.0 implementations have support for persistent
438 # connections, using rules different than HTTP/1.1.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000439
Christian Heimes895627f2007-12-08 17:28:33 +0000440 # For older HTTP, Keep-Alive indicates persistent connection.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000441 if self.headers.get("keep-alive"):
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000442 return False
Tim Peters77c06fb2002-11-24 02:35:35 +0000443
Jeremy Hylton2c178252004-08-07 16:28:14 +0000444 # At least Akamai returns a "Connection: Keep-Alive" header,
445 # which was supposed to be sent by the client.
446 if conn and "keep-alive" in conn.lower():
447 return False
448
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000449 # Proxy-Connection is a netscape hack.
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000450 pconn = self.headers.get("proxy-connection")
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000451 if pconn and "keep-alive" in pconn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000452 return False
453
454 # otherwise, assume it will close
455 return True
456
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200457 def _close_conn(self):
458 fp = self.fp
459 self.fp = None
460 fp.close()
461
Greg Steindd6eefb2000-07-18 09:09:48 +0000462 def close(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200463 super().close() # set "closed" flag
Greg Steindd6eefb2000-07-18 09:09:48 +0000464 if self.fp:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200465 self._close_conn()
Greg Stein5e0fa402000-06-26 08:28:01 +0000466
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000467 # These implementations are for the benefit of io.BufferedReader.
468
469 # XXX This class should probably be revised to act more like
470 # the "raw stream" that BufferedReader expects.
471
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000472 def flush(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200473 super().flush()
474 if self.fp:
475 self.fp.flush()
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000476
Jeremy Hyltona7cff022009-04-01 02:35:56 +0000477 def readable(self):
478 return True
479
Jeremy Hyltondf5f6b52007-08-08 17:36:33 +0000480 # End of "raw stream" methods
481
Greg Steindd6eefb2000-07-18 09:09:48 +0000482 def isclosed(self):
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200483 """True if the connection is closed."""
Greg Steindd6eefb2000-07-18 09:09:48 +0000484 # NOTE: it is possible that we will not ever call self.close(). This
485 # case occurs when will_close is TRUE, length is None, and we
486 # read up to the last byte, but NOT past it.
487 #
488 # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be
489 # called, meaning self.isclosed() is meaningful.
490 return self.fp is None
491
492 def read(self, amt=None):
493 if self.fp is None:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000494 return b""
Greg Steindd6eefb2000-07-18 09:09:48 +0000495
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000496 if self._method == "HEAD":
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200497 self._close_conn()
Senthil Kumaran71fb6c82010-04-28 17:39:48 +0000498 return b""
499
Antoine Pitrou38d96432011-12-06 22:33:57 +0100500 if amt is not None:
501 # Amount is given, so call base class version
502 # (which is implemented in terms of self.readinto)
503 return super(HTTPResponse, self).read(amt)
504 else:
505 # Amount is not given (unbounded read) so we must check self.length
506 # and self.chunked
Tim Peters230a60c2002-11-09 05:08:07 +0000507
Antoine Pitrou38d96432011-12-06 22:33:57 +0100508 if self.chunked:
509 return self._readall_chunked()
510
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000511 if self.length is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000512 s = self.fp.read()
513 else:
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100514 try:
515 s = self._safe_read(self.length)
516 except IncompleteRead:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200517 self._close_conn()
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100518 raise
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000519 self.length = 0
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200520 self._close_conn() # we read everything
Greg Steindd6eefb2000-07-18 09:09:48 +0000521 return s
522
Antoine Pitrou38d96432011-12-06 22:33:57 +0100523 def readinto(self, b):
524 if self.fp is None:
525 return 0
526
527 if self._method == "HEAD":
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200528 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100529 return 0
530
531 if self.chunked:
532 return self._readinto_chunked(b)
533
Greg Steindd6eefb2000-07-18 09:09:48 +0000534 if self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100535 if len(b) > self.length:
Greg Steindd6eefb2000-07-18 09:09:48 +0000536 # clip the read to the "end of response"
Antoine Pitrou38d96432011-12-06 22:33:57 +0100537 b = memoryview(b)[0:self.length]
Greg Steindd6eefb2000-07-18 09:09:48 +0000538
539 # we do not use _safe_read() here because this may be a .will_close
540 # connection, and the user is reading more bytes than will be provided
541 # (for example, reading in 1k chunks)
Antoine Pitrou38d96432011-12-06 22:33:57 +0100542 n = self.fp.readinto(b)
Antoine Pitrou6a35e182013-02-02 23:04:56 +0100543 if not n:
Antoine Pitroubeec61a2013-02-02 22:49:34 +0100544 # Ideally, we would raise IncompleteRead if the content-length
545 # wasn't satisfied, but it might break compatibility.
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200546 self._close_conn()
Antoine Pitrou6a35e182013-02-02 23:04:56 +0100547 elif self.length is not None:
Antoine Pitrou38d96432011-12-06 22:33:57 +0100548 self.length -= n
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000549 if not self.length:
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200550 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100551 return n
Greg Steindd6eefb2000-07-18 09:09:48 +0000552
Antoine Pitrou38d96432011-12-06 22:33:57 +0100553 def _read_next_chunk_size(self):
554 # Read the next chunk size from the file
555 line = self.fp.readline(_MAXLINE + 1)
556 if len(line) > _MAXLINE:
557 raise LineTooLong("chunk size")
558 i = line.find(b";")
559 if i >= 0:
560 line = line[:i] # strip chunk-extensions
561 try:
562 return int(line, 16)
563 except ValueError:
564 # close the connection as protocol synchronisation is
565 # probably lost
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200566 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100567 raise
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000568
Antoine Pitrou38d96432011-12-06 22:33:57 +0100569 def _read_and_discard_trailer(self):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000570 # read and discard trailer up to the CRLF terminator
571 ### note: we shouldn't have any trailers!
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000572 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000573 line = self.fp.readline(_MAXLINE + 1)
574 if len(line) > _MAXLINE:
575 raise LineTooLong("trailer line")
Christian Heimes0bd4e112008-02-12 22:59:25 +0000576 if not line:
577 # a vanishingly small number of sites EOF without
578 # sending the trailer
579 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800580 if line in (b'\r\n', b'\n', b''):
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000581 break
582
Antoine Pitrou38d96432011-12-06 22:33:57 +0100583 def _readall_chunked(self):
584 assert self.chunked != _UNKNOWN
585 chunk_left = self.chunk_left
586 value = []
587 while True:
588 if chunk_left is None:
589 try:
590 chunk_left = self._read_next_chunk_size()
591 if chunk_left == 0:
592 break
593 except ValueError:
594 raise IncompleteRead(b''.join(value))
595 value.append(self._safe_read(chunk_left))
596
597 # we read the whole chunk, get another
598 self._safe_read(2) # toss the CRLF at the end of the chunk
599 chunk_left = None
600
601 self._read_and_discard_trailer()
602
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000603 # we read everything; close the "file"
Serhiy Storchakab5b9c8c2013-02-06 10:31:57 +0200604 self._close_conn()
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000605
Chris Withers9c33cbf2009-09-04 17:04:16 +0000606 return b''.join(value)
Tim Peters230a60c2002-11-09 05:08:07 +0000607
Antoine Pitrou38d96432011-12-06 22:33:57 +0100608 def _readinto_chunked(self, b):
609 assert self.chunked != _UNKNOWN
610 chunk_left = self.chunk_left
611
612 total_bytes = 0
613 mvb = memoryview(b)
614 while True:
615 if chunk_left is None:
616 try:
617 chunk_left = self._read_next_chunk_size()
618 if chunk_left == 0:
619 break
620 except ValueError:
621 raise IncompleteRead(bytes(b[0:total_bytes]))
Antoine Pitrou4ce6aa42011-12-06 22:34:36 +0100622
Antoine Pitrou38d96432011-12-06 22:33:57 +0100623 if len(mvb) < chunk_left:
624 n = self._safe_readinto(mvb)
625 self.chunk_left = chunk_left - n
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100626 return total_bytes + n
Antoine Pitrou38d96432011-12-06 22:33:57 +0100627 elif len(mvb) == chunk_left:
628 n = self._safe_readinto(mvb)
629 self._safe_read(2) # toss the CRLF at the end of the chunk
630 self.chunk_left = None
Antoine Pitrouf7e78182012-01-04 18:57:22 +0100631 return total_bytes + n
Antoine Pitrou38d96432011-12-06 22:33:57 +0100632 else:
633 temp_mvb = mvb[0:chunk_left]
634 n = self._safe_readinto(temp_mvb)
635 mvb = mvb[n:]
636 total_bytes += n
637
638 # we read the whole chunk, get another
639 self._safe_read(2) # toss the CRLF at the end of the chunk
640 chunk_left = None
641
642 self._read_and_discard_trailer()
643
644 # we read everything; close the "file"
Serhiy Storchakab6c86fd2013-02-06 10:35:40 +0200645 self._close_conn()
Antoine Pitrou38d96432011-12-06 22:33:57 +0100646
647 return total_bytes
648
Greg Steindd6eefb2000-07-18 09:09:48 +0000649 def _safe_read(self, amt):
650 """Read the number of bytes requested, compensating for partial reads.
651
652 Normally, we have a blocking socket, but a read() can be interrupted
653 by a signal (resulting in a partial read).
654
655 Note that we cannot distinguish between EOF and an interrupt when zero
656 bytes have been read. IncompleteRead() will be raised in this
657 situation.
658
659 This function should be used when <amt> bytes "should" be present for
660 reading. If the bytes are truly not available (due to EOF), then the
661 IncompleteRead exception can be used to detect the problem.
662 """
Georg Brandl80ba8e82005-09-29 20:16:07 +0000663 s = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000664 while amt > 0:
Georg Brandl80ba8e82005-09-29 20:16:07 +0000665 chunk = self.fp.read(min(amt, MAXAMOUNT))
Greg Steindd6eefb2000-07-18 09:09:48 +0000666 if not chunk:
Benjamin Peterson6accb982009-03-02 22:50:25 +0000667 raise IncompleteRead(b''.join(s), amt)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000668 s.append(chunk)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000669 amt -= len(chunk)
Guido van Rossuma00f1232007-09-12 19:43:09 +0000670 return b"".join(s)
Greg Steindd6eefb2000-07-18 09:09:48 +0000671
Antoine Pitrou38d96432011-12-06 22:33:57 +0100672 def _safe_readinto(self, b):
673 """Same as _safe_read, but for reading into a buffer."""
674 total_bytes = 0
675 mvb = memoryview(b)
676 while total_bytes < len(b):
677 if MAXAMOUNT < len(mvb):
678 temp_mvb = mvb[0:MAXAMOUNT]
679 n = self.fp.readinto(temp_mvb)
680 else:
681 n = self.fp.readinto(mvb)
682 if not n:
683 raise IncompleteRead(bytes(mvb[0:total_bytes]), len(b))
684 mvb = mvb[n:]
685 total_bytes += n
686 return total_bytes
687
Antoine Pitroub353c122009-02-11 00:39:14 +0000688 def fileno(self):
689 return self.fp.fileno()
690
Greg Steindd6eefb2000-07-18 09:09:48 +0000691 def getheader(self, name, default=None):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000692 if self.headers is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000693 raise ResponseNotReady()
Senthil Kumaran9f8dc442010-08-02 11:04:58 +0000694 headers = self.headers.get_all(name) or default
695 if isinstance(headers, str) or not hasattr(headers, '__iter__'):
696 return headers
697 else:
698 return ', '.join(headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000699
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000700 def getheaders(self):
701 """Return list of (header, value) tuples."""
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000702 if self.headers is None:
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000703 raise ResponseNotReady()
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000704 return list(self.headers.items())
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000705
Antoine Pitroub353c122009-02-11 00:39:14 +0000706 # We override IOBase.__iter__ so that it doesn't check for closed-ness
707
708 def __iter__(self):
709 return self
710
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000711 # For compatibility with old-style urllib responses.
712
713 def info(self):
714 return self.headers
715
716 def geturl(self):
717 return self.url
718
719 def getcode(self):
720 return self.status
Greg Stein5e0fa402000-06-26 08:28:01 +0000721
722class HTTPConnection:
723
Greg Steindd6eefb2000-07-18 09:09:48 +0000724 _http_vsn = 11
725 _http_vsn_str = 'HTTP/1.1'
Greg Stein5e0fa402000-06-26 08:28:01 +0000726
Greg Steindd6eefb2000-07-18 09:09:48 +0000727 response_class = HTTPResponse
728 default_port = HTTP_PORT
729 auto_open = 1
Jeremy Hylton30f86742000-09-18 22:50:38 +0000730 debuglevel = 0
Antoine Pitrou90e47742013-01-02 22:10:47 +0100731 # TCP Maximum Segment Size (MSS) is determined by the TCP stack on
732 # a per-connection basis. There is no simple and efficient
733 # platform independent mechanism for determining the MSS, so
734 # instead a reasonable estimate is chosen. The getsockopt()
735 # interface using the TCP_MAXSEG parameter may be a suitable
736 # approach on some operating systems. A value of 16KiB is chosen
737 # as a reasonable estimate of the maximum MSS.
738 mss = 16384
Greg Stein5e0fa402000-06-26 08:28:01 +0000739
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000740 def __init__(self, host, port=None, strict=_strict_sentinel,
Gregory P. Smithb4066372010-01-03 03:28:29 +0000741 timeout=socket._GLOBAL_DEFAULT_TIMEOUT, source_address=None):
Antoine Pitrou988dbd72010-12-17 17:35:56 +0000742 if strict is not _strict_sentinel:
743 warnings.warn("the 'strict' argument isn't supported anymore; "
744 "http.client now always assumes HTTP/1.x compliant servers.",
745 DeprecationWarning, 2)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000746 self.timeout = timeout
Gregory P. Smithb4066372010-01-03 03:28:29 +0000747 self.source_address = source_address
Greg Steindd6eefb2000-07-18 09:09:48 +0000748 self.sock = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000749 self._buffer = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000750 self.__response = None
751 self.__state = _CS_IDLE
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000752 self._method = None
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000753 self._tunnel_host = None
754 self._tunnel_port = None
Georg Brandlc7c199f2011-01-22 22:06:24 +0000755 self._tunnel_headers = {}
Tim Petersc411dba2002-07-16 21:35:23 +0000756
Greg Steindd6eefb2000-07-18 09:09:48 +0000757 self._set_hostport(host, port)
Greg Stein5e0fa402000-06-26 08:28:01 +0000758
Senthil Kumaran47fff872009-12-20 07:10:31 +0000759 def set_tunnel(self, host, port=None, headers=None):
760 """ Sets up the host and the port for the HTTP CONNECT Tunnelling.
761
762 The headers argument should be a mapping of extra HTTP headers
763 to send with the CONNECT request.
764 """
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000765 self._tunnel_host = host
766 self._tunnel_port = port
Senthil Kumaran47fff872009-12-20 07:10:31 +0000767 if headers:
768 self._tunnel_headers = headers
769 else:
770 self._tunnel_headers.clear()
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000771
Greg Steindd6eefb2000-07-18 09:09:48 +0000772 def _set_hostport(self, host, port):
773 if port is None:
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000774 i = host.rfind(':')
Skip Montanarocae14d22004-09-14 17:55:21 +0000775 j = host.rfind(']') # ipv6 addresses have [...]
776 if i > j:
Skip Montanaro9d389972002-03-24 16:53:50 +0000777 try:
778 port = int(host[i+1:])
779 except ValueError:
Łukasz Langaa5a9a9c2011-10-18 21:17:39 +0200780 if host[i+1:] == "": # http://foo.com:/ == http://foo.com/
781 port = self.default_port
782 else:
783 raise InvalidURL("nonnumeric port: '%s'" % host[i+1:])
Greg Steindd6eefb2000-07-18 09:09:48 +0000784 host = host[:i]
785 else:
786 port = self.default_port
Raymond Hettinger4d037912004-10-14 15:23:38 +0000787 if host and host[0] == '[' and host[-1] == ']':
Brett Cannon0a1af4a2004-09-15 23:26:23 +0000788 host = host[1:-1]
Greg Steindd6eefb2000-07-18 09:09:48 +0000789 self.host = host
790 self.port = port
Greg Stein5e0fa402000-06-26 08:28:01 +0000791
Jeremy Hylton30f86742000-09-18 22:50:38 +0000792 def set_debuglevel(self, level):
793 self.debuglevel = level
794
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000795 def _tunnel(self):
796 self._set_hostport(self._tunnel_host, self._tunnel_port)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000797 connect_str = "CONNECT %s:%d HTTP/1.0\r\n" % (self.host, self.port)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000798 connect_bytes = connect_str.encode("ascii")
799 self.send(connect_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000800 for header, value in self._tunnel_headers.items():
Senthil Kumaran47fff872009-12-20 07:10:31 +0000801 header_str = "%s: %s\r\n" % (header, value)
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000802 header_bytes = header_str.encode("latin-1")
Senthil Kumaran47fff872009-12-20 07:10:31 +0000803 self.send(header_bytes)
Georg Brandlc7c199f2011-01-22 22:06:24 +0000804 self.send(b'\r\n')
Senthil Kumaran47fff872009-12-20 07:10:31 +0000805
Georg Brandlc7c199f2011-01-22 22:06:24 +0000806 response = self.response_class(self.sock, method=self._method)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000807 (version, code, message) = response._read_status()
Senthil Kumaran47fff872009-12-20 07:10:31 +0000808
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000809 if code != 200:
810 self.close()
Andrew Svetlov0832af62012-12-18 23:10:48 +0200811 raise OSError("Tunnel connection failed: %d %s" % (code,
812 message.strip()))
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000813 while True:
Senthil Kumaran5466bf12010-12-18 16:55:23 +0000814 line = response.fp.readline(_MAXLINE + 1)
815 if len(line) > _MAXLINE:
816 raise LineTooLong("header line")
Senthil Kumaranb12771a2012-04-23 23:50:07 +0800817 if not line:
818 # for sites which EOF without sending a trailer
819 break
Senthil Kumaran7e70a5c2012-04-29 10:39:49 +0800820 if line in (b'\r\n', b'\n', b''):
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000821 break
822
Greg Steindd6eefb2000-07-18 09:09:48 +0000823 def connect(self):
824 """Connect to the host and port specified in __init__."""
Guido van Rossumd8faa362007-04-27 19:54:29 +0000825 self.sock = socket.create_connection((self.host,self.port),
Gregory P. Smithb4066372010-01-03 03:28:29 +0000826 self.timeout, self.source_address)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +0000827 if self._tunnel_host:
828 self._tunnel()
Greg Stein5e0fa402000-06-26 08:28:01 +0000829
Greg Steindd6eefb2000-07-18 09:09:48 +0000830 def close(self):
831 """Close the connection to the HTTP server."""
832 if self.sock:
Tim Peters07e99cb2001-01-14 23:47:14 +0000833 self.sock.close() # close it manually... there may be other refs
Greg Steindd6eefb2000-07-18 09:09:48 +0000834 self.sock = None
835 if self.__response:
836 self.__response.close()
837 self.__response = None
838 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000839
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000840 def send(self, data):
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000841 """Send `data' to the server.
842 ``data`` can be a string object, a bytes object, an array object, a
843 file-like object that supports a .read() method, or an iterable object.
844 """
845
Greg Steindd6eefb2000-07-18 09:09:48 +0000846 if self.sock is None:
847 if self.auto_open:
848 self.connect()
849 else:
850 raise NotConnected()
Greg Stein5e0fa402000-06-26 08:28:01 +0000851
Jeremy Hylton30f86742000-09-18 22:50:38 +0000852 if self.debuglevel > 0:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000853 print("send:", repr(data))
Jeremy Hylton636950f2009-03-28 04:34:21 +0000854 blocksize = 8192
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000855 if hasattr(data, "read") :
Jeremy Hylton636950f2009-03-28 04:34:21 +0000856 if self.debuglevel > 0:
857 print("sendIng a read()able")
858 encode = False
Antoine Pitrouead1d622009-09-29 18:44:53 +0000859 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000860 mode = data.mode
Antoine Pitrouead1d622009-09-29 18:44:53 +0000861 except AttributeError:
862 # io.BytesIO and other file-like objects don't have a `mode`
863 # attribute.
864 pass
865 else:
866 if "b" not in mode:
867 encode = True
868 if self.debuglevel > 0:
869 print("encoding file using iso-8859-1")
Jeremy Hylton636950f2009-03-28 04:34:21 +0000870 while 1:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000871 datablock = data.read(blocksize)
872 if not datablock:
Jeremy Hylton636950f2009-03-28 04:34:21 +0000873 break
874 if encode:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000875 datablock = datablock.encode("iso-8859-1")
876 self.sock.sendall(datablock)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000877
878 try:
Senthil Kumaran5a2da3b2010-10-02 10:33:13 +0000879 self.sock.sendall(data)
Senthil Kumaran7bc0d872010-12-19 10:49:52 +0000880 except TypeError:
881 if isinstance(data, collections.Iterable):
882 for d in data:
883 self.sock.sendall(d)
884 else:
Georg Brandl25e2cd12011-08-03 08:27:00 +0200885 raise TypeError("data should be a bytes-like object "
886 "or an iterable, got %r" % type(data))
Greg Stein5e0fa402000-06-26 08:28:01 +0000887
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000888 def _output(self, s):
889 """Add a line of output to the current request buffer.
Tim Peters469cdad2002-08-08 20:19:19 +0000890
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000891 Assumes that the line does *not* end with \\r\\n.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000892 """
893 self._buffer.append(s)
894
Benjamin Peterson1742e402008-11-30 22:15:29 +0000895 def _send_output(self, message_body=None):
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000896 """Send the currently buffered request and clear the buffer.
897
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000898 Appends an extra \\r\\n to the buffer.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000899 A message_body may be specified, to be appended to the request.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000900 """
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000901 self._buffer.extend((b"", b""))
902 msg = b"\r\n".join(self._buffer)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000903 del self._buffer[:]
Benjamin Peterson1742e402008-11-30 22:15:29 +0000904 # If msg and message_body are sent in a single send() call,
905 # it will avoid performance problems caused by the interaction
Antoine Pitrou90e47742013-01-02 22:10:47 +0100906 # between delayed ack and the Nagle algorithm. However,
907 # there is no performance gain if the message is larger
908 # than MSS (and there is a memory penalty for the message
909 # copy).
910 if isinstance(message_body, bytes) and len(message_body) < self.mss:
Benjamin Peterson1742e402008-11-30 22:15:29 +0000911 msg += message_body
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000912 message_body = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000913 self.send(msg)
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000914 if message_body is not None:
Jeremy Hylton236654b2009-03-27 20:24:34 +0000915 # message_body was not a string (i.e. it is a file), and
916 # we must run the risk of Nagle.
Benjamin Peterson822b21c2009-01-18 00:04:57 +0000917 self.send(message_body)
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000918
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000919 def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0):
Greg Steindd6eefb2000-07-18 09:09:48 +0000920 """Send a request to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000921
Greg Steindd6eefb2000-07-18 09:09:48 +0000922 `method' specifies an HTTP request method, e.g. 'GET'.
923 `url' specifies the object being requested, e.g. '/index.html'.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000924 `skip_host' if True does not add automatically a 'Host:' header
925 `skip_accept_encoding' if True does not add automatically an
926 'Accept-Encoding:' header
Greg Steindd6eefb2000-07-18 09:09:48 +0000927 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000928
Greg Stein616a58d2003-06-24 06:35:19 +0000929 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000930 if self.__response and self.__response.isclosed():
931 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000932
Tim Peters58eb11c2004-01-18 20:29:55 +0000933
Greg Steindd6eefb2000-07-18 09:09:48 +0000934 # in certain cases, we cannot issue another request on this connection.
935 # this occurs when:
936 # 1) we are in the process of sending a request. (_CS_REQ_STARTED)
937 # 2) a response to a previous request has signalled that it is going
938 # to close the connection upon completion.
939 # 3) the headers for the previous response have not been read, thus
940 # we cannot determine whether point (2) is true. (_CS_REQ_SENT)
941 #
942 # if there is no prior response, then we can request at will.
943 #
944 # if point (2) is true, then we will have passed the socket to the
945 # response (effectively meaning, "there is no prior response"), and
946 # will open a new one when a new request is made.
947 #
948 # Note: if a prior response exists, then we *can* start a new request.
949 # We are not allowed to begin fetching the response to this new
950 # request, however, until that prior response is complete.
951 #
952 if self.__state == _CS_IDLE:
953 self.__state = _CS_REQ_STARTED
954 else:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +0000955 raise CannotSendRequest(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +0000956
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000957 # Save the method we use, we need it later in the response phase
958 self._method = method
Greg Steindd6eefb2000-07-18 09:09:48 +0000959 if not url:
960 url = '/'
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000961 request = '%s %s %s' % (method, url, self._http_vsn_str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000962
Martin v. Löwisdd5a8602007-06-30 09:22:09 +0000963 # Non-ASCII characters should have been eliminated earlier
964 self._output(request.encode('ascii'))
Greg Stein5e0fa402000-06-26 08:28:01 +0000965
Greg Steindd6eefb2000-07-18 09:09:48 +0000966 if self._http_vsn == 11:
967 # Issue some standard headers for better HTTP/1.1 compliance
Greg Stein5e0fa402000-06-26 08:28:01 +0000968
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000969 if not skip_host:
970 # this header is issued *only* for HTTP/1.1
971 # connections. more specifically, this means it is
972 # only issued when the client uses the new
973 # HTTPConnection() class. backwards-compat clients
974 # will be using HTTP/1.0 and those clients may be
975 # issuing this header themselves. we should NOT issue
976 # it twice; some web servers (such as Apache) barf
977 # when they see two Host: headers
Guido van Rossumf6922aa2001-01-14 21:03:01 +0000978
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000979 # If we need a non-standard port,include it in the
980 # header. If the request is going through a proxy,
981 # but the host of the actual URL, not the host of the
982 # proxy.
Jeremy Hylton8acf1e02002-03-08 19:35:51 +0000983
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000984 netloc = ''
985 if url.startswith('http'):
986 nil, netloc, nil, nil, nil = urlsplit(url)
987
988 if netloc:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000989 try:
990 netloc_enc = netloc.encode("ascii")
991 except UnicodeEncodeError:
992 netloc_enc = netloc.encode("idna")
993 self.putheader('Host', netloc_enc)
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000994 else:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000995 try:
996 host_enc = self.host.encode("ascii")
997 except UnicodeEncodeError:
998 host_enc = self.host.encode("idna")
Senthil Kumaran74ebd9e2010-11-13 12:27:49 +0000999
1000 # As per RFC 273, IPv6 address should be wrapped with []
1001 # when used as Host header
1002
1003 if self.host.find(':') >= 0:
1004 host_enc = b'[' + host_enc + b']'
1005
Georg Brandl86b2fb92008-07-16 03:43:04 +00001006 if self.port == self.default_port:
Thomas Wouters477c8d52006-05-27 19:21:47 +00001007 self.putheader('Host', host_enc)
1008 else:
Guido van Rossum98297ee2007-11-06 21:34:58 +00001009 host_enc = host_enc.decode("ascii")
Thomas Wouters477c8d52006-05-27 19:21:47 +00001010 self.putheader('Host', "%s:%s" % (host_enc, self.port))
Greg Stein5e0fa402000-06-26 08:28:01 +00001011
Greg Steindd6eefb2000-07-18 09:09:48 +00001012 # note: we are assuming that clients will not attempt to set these
1013 # headers since *this* library must deal with the
1014 # consequences. this also means that when the supporting
1015 # libraries are updated to recognize other forms, then this
1016 # code should be changed (removed or updated).
Greg Stein5e0fa402000-06-26 08:28:01 +00001017
Greg Steindd6eefb2000-07-18 09:09:48 +00001018 # we only want a Content-Encoding of "identity" since we don't
1019 # support encodings such as x-gzip or x-deflate.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +00001020 if not skip_accept_encoding:
1021 self.putheader('Accept-Encoding', 'identity')
Greg Stein5e0fa402000-06-26 08:28:01 +00001022
Greg Steindd6eefb2000-07-18 09:09:48 +00001023 # we can accept "chunked" Transfer-Encodings, but no others
1024 # NOTE: no TE header implies *only* "chunked"
1025 #self.putheader('TE', 'chunked')
Greg Stein5e0fa402000-06-26 08:28:01 +00001026
Greg Steindd6eefb2000-07-18 09:09:48 +00001027 # if TE is supplied in the header, then it must appear in a
1028 # Connection header.
1029 #self.putheader('Connection', 'TE')
Greg Stein5e0fa402000-06-26 08:28:01 +00001030
Greg Steindd6eefb2000-07-18 09:09:48 +00001031 else:
1032 # For HTTP/1.0, the server will assume "not chunked"
1033 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001034
Benjamin Petersonf608c612008-11-16 18:33:53 +00001035 def putheader(self, header, *values):
Greg Steindd6eefb2000-07-18 09:09:48 +00001036 """Send a request header line to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001037
Greg Steindd6eefb2000-07-18 09:09:48 +00001038 For example: h.putheader('Accept', 'text/html')
1039 """
1040 if self.__state != _CS_REQ_STARTED:
1041 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +00001042
Guido van Rossum98297ee2007-11-06 21:34:58 +00001043 if hasattr(header, 'encode'):
1044 header = header.encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +00001045 values = list(values)
1046 for i, one_value in enumerate(values):
1047 if hasattr(one_value, 'encode'):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00001048 values[i] = one_value.encode('latin-1')
Senthil Kumaran58d5dbf2010-10-03 18:22:42 +00001049 elif isinstance(one_value, int):
1050 values[i] = str(one_value).encode('ascii')
Benjamin Petersonf608c612008-11-16 18:33:53 +00001051 value = b'\r\n\t'.join(values)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001052 header = header + b': ' + value
1053 self._output(header)
Greg Stein5e0fa402000-06-26 08:28:01 +00001054
Benjamin Peterson1742e402008-11-30 22:15:29 +00001055 def endheaders(self, message_body=None):
1056 """Indicate that the last header line has been sent to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +00001057
Senthil Kumaranad87fa62011-10-05 23:26:49 +08001058 This method sends the request to the server. The optional message_body
1059 argument can be used to pass a message body associated with the
1060 request. The message body will be sent in the same packet as the
1061 message headers if it is a string, otherwise it is sent as a separate
1062 packet.
Benjamin Peterson1742e402008-11-30 22:15:29 +00001063 """
Greg Steindd6eefb2000-07-18 09:09:48 +00001064 if self.__state == _CS_REQ_STARTED:
1065 self.__state = _CS_REQ_SENT
1066 else:
1067 raise CannotSendHeader()
Benjamin Peterson1742e402008-11-30 22:15:29 +00001068 self._send_output(message_body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001069
Greg Steindd6eefb2000-07-18 09:09:48 +00001070 def request(self, method, url, body=None, headers={}):
1071 """Send a complete request to the server."""
Jeremy Hylton636950f2009-03-28 04:34:21 +00001072 self._send_request(method, url, body, headers)
Greg Stein5e0fa402000-06-26 08:28:01 +00001073
Benjamin Peterson1742e402008-11-30 22:15:29 +00001074 def _set_content_length(self, body):
1075 # Set the content-length based on the body.
1076 thelen = None
1077 try:
1078 thelen = str(len(body))
1079 except TypeError as te:
1080 # If this is a file-like object, try to
1081 # fstat its file descriptor
Benjamin Peterson1742e402008-11-30 22:15:29 +00001082 try:
1083 thelen = str(os.fstat(body.fileno()).st_size)
1084 except (AttributeError, OSError):
1085 # Don't send a length if this failed
1086 if self.debuglevel > 0: print("Cannot stat!!")
1087
1088 if thelen is not None:
1089 self.putheader('Content-Length', thelen)
1090
Greg Steindd6eefb2000-07-18 09:09:48 +00001091 def _send_request(self, method, url, body, headers):
Jeremy Hylton636950f2009-03-28 04:34:21 +00001092 # Honor explicitly requested Host: and Accept-Encoding: headers.
Jeremy Hylton2c178252004-08-07 16:28:14 +00001093 header_names = dict.fromkeys([k.lower() for k in headers])
1094 skips = {}
1095 if 'host' in header_names:
1096 skips['skip_host'] = 1
1097 if 'accept-encoding' in header_names:
1098 skips['skip_accept_encoding'] = 1
Greg Stein5e0fa402000-06-26 08:28:01 +00001099
Jeremy Hylton2c178252004-08-07 16:28:14 +00001100 self.putrequest(method, url, **skips)
1101
Senthil Kumaran5fa4a892012-05-19 16:58:09 +08001102 if body is not None and ('content-length' not in header_names):
Benjamin Peterson1742e402008-11-30 22:15:29 +00001103 self._set_content_length(body)
Guido van Rossumcc2b0162007-02-11 06:12:03 +00001104 for hdr, value in headers.items():
Greg Steindd6eefb2000-07-18 09:09:48 +00001105 self.putheader(hdr, value)
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001106 if isinstance(body, str):
Jeremy Hylton236654b2009-03-27 20:24:34 +00001107 # RFC 2616 Section 3.7.1 says that text default has a
1108 # default charset of iso-8859-1.
1109 body = body.encode('iso-8859-1')
Jeremy Hyltonef9f48e2009-03-26 22:04:05 +00001110 self.endheaders(body)
Greg Stein5e0fa402000-06-26 08:28:01 +00001111
Greg Steindd6eefb2000-07-18 09:09:48 +00001112 def getresponse(self):
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001113 """Get the response from the server.
1114
1115 If the HTTPConnection is in the correct state, returns an
1116 instance of HTTPResponse or of whatever object is returned by
1117 class the response_class variable.
1118
1119 If a request has not been sent or if a previous response has
1120 not be handled, ResponseNotReady is raised. If the HTTP
1121 response indicates that the connection should be closed, then
1122 it will be closed before the response is returned. When the
1123 connection is closed, the underlying socket is closed.
1124 """
Greg Stein5e0fa402000-06-26 08:28:01 +00001125
Greg Stein616a58d2003-06-24 06:35:19 +00001126 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +00001127 if self.__response and self.__response.isclosed():
1128 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +00001129
Greg Steindd6eefb2000-07-18 09:09:48 +00001130 # if a prior response exists, then it must be completed (otherwise, we
1131 # cannot read this response's header to determine the connection-close
1132 # behavior)
1133 #
1134 # note: if a prior response existed, but was connection-close, then the
1135 # socket and response were made independent of this HTTPConnection
1136 # object since a new request requires that we open a whole new
1137 # connection
1138 #
1139 # this means the prior response had one of two states:
1140 # 1) will_close: this connection was reset and the prior socket and
1141 # response operate independently
1142 # 2) persistent: the response was retained and we await its
1143 # isclosed() status to become true.
1144 #
1145 if self.__state != _CS_REQ_SENT or self.__response:
Jeremy Hylton6c5e28c2009-03-31 14:35:53 +00001146 raise ResponseNotReady(self.__state)
Greg Stein5e0fa402000-06-26 08:28:01 +00001147
Jeremy Hylton30f86742000-09-18 22:50:38 +00001148 if self.debuglevel > 0:
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001149 response = self.response_class(self.sock, self.debuglevel,
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +00001150 method=self._method)
Jeremy Hylton30f86742000-09-18 22:50:38 +00001151 else:
Antoine Pitrou988dbd72010-12-17 17:35:56 +00001152 response = self.response_class(self.sock, method=self._method)
Greg Stein5e0fa402000-06-26 08:28:01 +00001153
Jeremy Hylton39c03802002-07-12 14:04:09 +00001154 response.begin()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +00001155 assert response.will_close != _UNKNOWN
Greg Steindd6eefb2000-07-18 09:09:48 +00001156 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +00001157
Greg Steindd6eefb2000-07-18 09:09:48 +00001158 if response.will_close:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001159 # this effectively passes the connection to the response
1160 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +00001161 else:
1162 # remember this, so we can tell when it is complete
1163 self.__response = response
Greg Stein5e0fa402000-06-26 08:28:01 +00001164
Greg Steindd6eefb2000-07-18 09:09:48 +00001165 return response
Greg Stein5e0fa402000-06-26 08:28:01 +00001166
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001167try:
1168 import ssl
1169except ImportError:
1170 pass
1171else:
1172 class HTTPSConnection(HTTPConnection):
1173 "This class allows communication via SSL."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001174
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001175 default_port = HTTPS_PORT
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001176
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001177 # XXX Should key_file and cert_file be deprecated in favour of context?
1178
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001179 def __init__(self, host, port=None, key_file=None, cert_file=None,
Antoine Pitrou988dbd72010-12-17 17:35:56 +00001180 strict=_strict_sentinel, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001181 source_address=None, *, context=None, check_hostname=None):
Gregory P. Smithb4066372010-01-03 03:28:29 +00001182 super(HTTPSConnection, self).__init__(host, port, strict, timeout,
1183 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001184 self.key_file = key_file
1185 self.cert_file = cert_file
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001186 if context is None:
1187 # Some reasonable defaults
1188 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1189 context.options |= ssl.OP_NO_SSLv2
1190 will_verify = context.verify_mode != ssl.CERT_NONE
1191 if check_hostname is None:
1192 check_hostname = will_verify
1193 elif check_hostname and not will_verify:
1194 raise ValueError("check_hostname needs a SSL context with "
1195 "either CERT_OPTIONAL or CERT_REQUIRED")
1196 if key_file or cert_file:
Antoine Pitrou80603992010-10-13 10:45:16 +00001197 context.load_cert_chain(cert_file, key_file)
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001198 self._context = context
1199 self._check_hostname = check_hostname
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001200
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001201 def connect(self):
1202 "Connect to a host on a given (SSL) port."
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001203
Jeremy Hylton636950f2009-03-28 04:34:21 +00001204 sock = socket.create_connection((self.host, self.port),
Gregory P. Smithb4066372010-01-03 03:28:29 +00001205 self.timeout, self.source_address)
Senthil Kumaran97f0c6b2009-07-25 04:24:38 +00001206
1207 if self._tunnel_host:
1208 self.sock = sock
1209 self._tunnel()
1210
Antoine Pitroud5323212010-10-22 18:19:07 +00001211 server_hostname = self.host if ssl.HAS_SNI else None
1212 self.sock = self._context.wrap_socket(sock,
1213 server_hostname=server_hostname)
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001214 try:
1215 if self._check_hostname:
1216 ssl.match_hostname(self.sock.getpeercert(), self.host)
1217 except Exception:
1218 self.sock.shutdown(socket.SHUT_RDWR)
1219 self.sock.close()
1220 raise
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001221
Thomas Wouters47b49bf2007-08-30 22:15:33 +00001222 __all__.append("HTTPSConnection")
Greg Stein5e0fa402000-06-26 08:28:01 +00001223
Greg Stein5e0fa402000-06-26 08:28:01 +00001224class HTTPException(Exception):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001225 # Subclasses that define an __init__ must call Exception.__init__
1226 # or define self.args. Otherwise, str() will fail.
Greg Steindd6eefb2000-07-18 09:09:48 +00001227 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001228
1229class NotConnected(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001230 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001231
Skip Montanaro9d389972002-03-24 16:53:50 +00001232class InvalidURL(HTTPException):
1233 pass
1234
Greg Stein5e0fa402000-06-26 08:28:01 +00001235class UnknownProtocol(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001236 def __init__(self, version):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001237 self.args = version,
Greg Steindd6eefb2000-07-18 09:09:48 +00001238 self.version = version
Greg Stein5e0fa402000-06-26 08:28:01 +00001239
1240class UnknownTransferEncoding(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001241 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001242
Greg Stein5e0fa402000-06-26 08:28:01 +00001243class UnimplementedFileMode(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001244 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001245
1246class IncompleteRead(HTTPException):
Benjamin Peterson6accb982009-03-02 22:50:25 +00001247 def __init__(self, partial, expected=None):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001248 self.args = partial,
Greg Steindd6eefb2000-07-18 09:09:48 +00001249 self.partial = partial
Benjamin Peterson6accb982009-03-02 22:50:25 +00001250 self.expected = expected
1251 def __repr__(self):
1252 if self.expected is not None:
1253 e = ', %i more expected' % self.expected
1254 else:
1255 e = ''
1256 return 'IncompleteRead(%i bytes read%s)' % (len(self.partial), e)
1257 def __str__(self):
1258 return repr(self)
Greg Stein5e0fa402000-06-26 08:28:01 +00001259
1260class ImproperConnectionState(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001261 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001262
1263class CannotSendRequest(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001264 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001265
1266class CannotSendHeader(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001267 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001268
1269class ResponseNotReady(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001270 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001271
1272class BadStatusLine(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001273 def __init__(self, line):
Benjamin Peterson11dbfd42010-03-21 22:50:04 +00001274 if not line:
1275 line = repr(line)
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001276 self.args = line,
Greg Steindd6eefb2000-07-18 09:09:48 +00001277 self.line = line
Greg Stein5e0fa402000-06-26 08:28:01 +00001278
Senthil Kumaran5466bf12010-12-18 16:55:23 +00001279class LineTooLong(HTTPException):
1280 def __init__(self, line_type):
1281 HTTPException.__init__(self, "got more than %d bytes when reading %s"
1282 % (_MAXLINE, line_type))
1283
Greg Stein5e0fa402000-06-26 08:28:01 +00001284# for backwards compatibility
1285error = HTTPException