blob: c7d8e781df06212bfc62682f11ce513adf3a5444 [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
Andrew M. Kuchlingca2e7902006-07-30 00:27:34 +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
Guido van Rossum65ab98c1995-08-07 20:13:02 +000069import mimetools
Jeremy Hylton6459c8d2001-10-11 17:47:22 +000070import socket
Jeremy Hylton8acf1e02002-03-08 19:35:51 +000071from urlparse import urlsplit
Bill Janssenc4592642007-08-31 19:02:23 +000072import warnings
Guido van Rossum23acc951994-02-21 16:36:04 +000073
Guido van Rossum09c8b6c1999-12-07 21:37:17 +000074try:
Greg Steindd6eefb2000-07-18 09:09:48 +000075 from cStringIO import StringIO
Greg Stein5e0fa402000-06-26 08:28:01 +000076except ImportError:
Greg Steindd6eefb2000-07-18 09:09:48 +000077 from StringIO import StringIO
Guido van Rossum09c8b6c1999-12-07 21:37:17 +000078
Thomas Woutersa6900e82007-08-30 21:54:39 +000079__all__ = ["HTTP", "HTTPResponse", "HTTPConnection",
Skip Montanaro951a8842001-06-01 16:25:38 +000080 "HTTPException", "NotConnected", "UnknownProtocol",
Jeremy Hylton7c75c992002-06-28 23:38:14 +000081 "UnknownTransferEncoding", "UnimplementedFileMode",
82 "IncompleteRead", "InvalidURL", "ImproperConnectionState",
83 "CannotSendRequest", "CannotSendHeader", "ResponseNotReady",
Georg Brandl6aab16e2006-02-17 19:17:25 +000084 "BadStatusLine", "error", "responses"]
Skip Montanaro2dd42762001-01-23 15:35:05 +000085
Guido van Rossum23acc951994-02-21 16:36:04 +000086HTTP_PORT = 80
Guido van Rossum09c8b6c1999-12-07 21:37:17 +000087HTTPS_PORT = 443
88
Greg Stein5e0fa402000-06-26 08:28:01 +000089_UNKNOWN = 'UNKNOWN'
90
91# connection states
92_CS_IDLE = 'Idle'
93_CS_REQ_STARTED = 'Request-started'
94_CS_REQ_SENT = 'Request-sent'
95
Martin v. Löwis39a31782004-09-18 09:03:49 +000096# status codes
97# informational
98CONTINUE = 100
99SWITCHING_PROTOCOLS = 101
100PROCESSING = 102
101
102# successful
103OK = 200
104CREATED = 201
105ACCEPTED = 202
106NON_AUTHORITATIVE_INFORMATION = 203
107NO_CONTENT = 204
108RESET_CONTENT = 205
109PARTIAL_CONTENT = 206
110MULTI_STATUS = 207
111IM_USED = 226
112
113# redirection
114MULTIPLE_CHOICES = 300
115MOVED_PERMANENTLY = 301
116FOUND = 302
117SEE_OTHER = 303
118NOT_MODIFIED = 304
119USE_PROXY = 305
120TEMPORARY_REDIRECT = 307
121
122# client error
123BAD_REQUEST = 400
124UNAUTHORIZED = 401
125PAYMENT_REQUIRED = 402
126FORBIDDEN = 403
127NOT_FOUND = 404
128METHOD_NOT_ALLOWED = 405
129NOT_ACCEPTABLE = 406
130PROXY_AUTHENTICATION_REQUIRED = 407
131REQUEST_TIMEOUT = 408
132CONFLICT = 409
133GONE = 410
134LENGTH_REQUIRED = 411
135PRECONDITION_FAILED = 412
136REQUEST_ENTITY_TOO_LARGE = 413
137REQUEST_URI_TOO_LONG = 414
138UNSUPPORTED_MEDIA_TYPE = 415
139REQUESTED_RANGE_NOT_SATISFIABLE = 416
140EXPECTATION_FAILED = 417
141UNPROCESSABLE_ENTITY = 422
142LOCKED = 423
143FAILED_DEPENDENCY = 424
144UPGRADE_REQUIRED = 426
145
146# server error
147INTERNAL_SERVER_ERROR = 500
148NOT_IMPLEMENTED = 501
149BAD_GATEWAY = 502
150SERVICE_UNAVAILABLE = 503
151GATEWAY_TIMEOUT = 504
152HTTP_VERSION_NOT_SUPPORTED = 505
153INSUFFICIENT_STORAGE = 507
154NOT_EXTENDED = 510
155
Georg Brandl6aab16e2006-02-17 19:17:25 +0000156# Mapping status codes to official W3C names
157responses = {
158 100: 'Continue',
159 101: 'Switching Protocols',
160
161 200: 'OK',
162 201: 'Created',
163 202: 'Accepted',
164 203: 'Non-Authoritative Information',
165 204: 'No Content',
166 205: 'Reset Content',
167 206: 'Partial Content',
168
169 300: 'Multiple Choices',
170 301: 'Moved Permanently',
171 302: 'Found',
172 303: 'See Other',
173 304: 'Not Modified',
174 305: 'Use Proxy',
175 306: '(Unused)',
176 307: 'Temporary Redirect',
177
178 400: 'Bad Request',
179 401: 'Unauthorized',
180 402: 'Payment Required',
181 403: 'Forbidden',
182 404: 'Not Found',
183 405: 'Method Not Allowed',
184 406: 'Not Acceptable',
185 407: 'Proxy Authentication Required',
186 408: 'Request Timeout',
187 409: 'Conflict',
188 410: 'Gone',
189 411: 'Length Required',
190 412: 'Precondition Failed',
191 413: 'Request Entity Too Large',
192 414: 'Request-URI Too Long',
193 415: 'Unsupported Media Type',
194 416: 'Requested Range Not Satisfiable',
195 417: 'Expectation Failed',
196
197 500: 'Internal Server Error',
198 501: 'Not Implemented',
199 502: 'Bad Gateway',
200 503: 'Service Unavailable',
201 504: 'Gateway Timeout',
202 505: 'HTTP Version Not Supported',
203}
204
Georg Brandl80ba8e82005-09-29 20:16:07 +0000205# maximal amount of data to read at one time in _safe_read
206MAXAMOUNT = 1048576
207
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000208class HTTPMessage(mimetools.Message):
209
210 def addheader(self, key, value):
211 """Add header for field key handling repeats."""
212 prev = self.dict.get(key)
213 if prev is None:
214 self.dict[key] = value
215 else:
216 combined = ", ".join((prev, value))
217 self.dict[key] = combined
218
219 def addcontinue(self, key, more):
220 """Add more field data from a continuation line."""
221 prev = self.dict[key]
222 self.dict[key] = prev + "\n " + more
223
224 def readheaders(self):
225 """Read header lines.
226
227 Read header lines up to the entirely blank line that terminates them.
228 The (normally blank) line that ends the headers is skipped, but not
229 included in the returned list. If a non-header line ends the headers,
230 (which is an error), an attempt is made to backspace over it; it is
231 never included in the returned list.
232
233 The variable self.status is set to the empty string if all went well,
234 otherwise it is an error message. The variable self.headers is a
235 completely uninterpreted list of lines contained in the header (so
236 printing them will reproduce the header exactly as it appears in the
237 file).
238
239 If multiple header fields with the same name occur, they are combined
240 according to the rules in RFC 2616 sec 4.2:
241
242 Appending each subsequent field-value to the first, each separated
243 by a comma. The order in which header fields with the same field-name
244 are received is significant to the interpretation of the combined
245 field value.
246 """
247 # XXX The implementation overrides the readheaders() method of
248 # rfc822.Message. The base class design isn't amenable to
249 # customized behavior here so the method here is a copy of the
250 # base class code with a few small changes.
251
252 self.dict = {}
253 self.unixfrom = ''
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000254 self.headers = hlist = []
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000255 self.status = ''
256 headerseen = ""
257 firstline = 1
258 startofline = unread = tell = None
259 if hasattr(self.fp, 'unread'):
260 unread = self.fp.unread
261 elif self.seekable:
262 tell = self.fp.tell
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000263 while True:
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000264 if tell:
265 try:
266 startofline = tell()
267 except IOError:
268 startofline = tell = None
269 self.seekable = 0
270 line = self.fp.readline()
271 if not line:
272 self.status = 'EOF in headers'
273 break
274 # Skip unix From name time lines
275 if firstline and line.startswith('From '):
276 self.unixfrom = self.unixfrom + line
277 continue
278 firstline = 0
279 if headerseen and line[0] in ' \t':
280 # XXX Not sure if continuation lines are handled properly
281 # for http and/or for repeating headers
282 # It's a continuation line.
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000283 hlist.append(line)
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000284 self.addcontinue(headerseen, line.strip())
285 continue
286 elif self.iscomment(line):
287 # It's a comment. Ignore it.
288 continue
289 elif self.islast(line):
290 # Note! No pushback here! The delimiter line gets eaten.
291 break
292 headerseen = self.isheader(line)
293 if headerseen:
294 # It's a legal header line, save it.
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000295 hlist.append(line)
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000296 self.addheader(headerseen, line[len(headerseen)+1:].strip())
297 continue
298 else:
299 # It's not a header line; throw it back and stop here.
300 if not self.dict:
301 self.status = 'No headers'
302 else:
303 self.status = 'Non-header line where header expected'
304 # Try to undo the read.
305 if unread:
306 unread(line)
307 elif tell:
308 self.fp.seek(startofline)
309 else:
310 self.status = self.status + '; bad seek'
311 break
Greg Stein5e0fa402000-06-26 08:28:01 +0000312
313class HTTPResponse:
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000314
315 # strict: If true, raise BadStatusLine if the status line can't be
316 # parsed as a valid HTTP/1.0 or 1.1 status line. By default it is
Skip Montanaro186bec22002-07-25 16:10:38 +0000317 # false because it prevents clients from talking to HTTP/0.9
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000318 # servers. Note that a response with a sufficiently corrupted
319 # status line will look like an HTTP/0.9 response.
320
321 # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details.
322
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000323 def __init__(self, sock, debuglevel=0, strict=0, method=None):
Greg Steindd6eefb2000-07-18 09:09:48 +0000324 self.fp = sock.makefile('rb', 0)
Jeremy Hylton30f86742000-09-18 22:50:38 +0000325 self.debuglevel = debuglevel
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000326 self.strict = strict
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000327 self._method = method
Greg Stein5e0fa402000-06-26 08:28:01 +0000328
Greg Steindd6eefb2000-07-18 09:09:48 +0000329 self.msg = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000330
Greg Steindd6eefb2000-07-18 09:09:48 +0000331 # from the Status-Line of the response
Tim Peters07e99cb2001-01-14 23:47:14 +0000332 self.version = _UNKNOWN # HTTP-Version
333 self.status = _UNKNOWN # Status-Code
334 self.reason = _UNKNOWN # Reason-Phrase
Greg Stein5e0fa402000-06-26 08:28:01 +0000335
Tim Peters07e99cb2001-01-14 23:47:14 +0000336 self.chunked = _UNKNOWN # is "chunked" being used?
337 self.chunk_left = _UNKNOWN # bytes left to read in current chunk
338 self.length = _UNKNOWN # number of bytes left in response
339 self.will_close = _UNKNOWN # conn will close at end of response
Greg Stein5e0fa402000-06-26 08:28:01 +0000340
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000341 def _read_status(self):
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000342 # Initialize with Simple-Response defaults
Greg Stein5e0fa402000-06-26 08:28:01 +0000343 line = self.fp.readline()
Jeremy Hylton30f86742000-09-18 22:50:38 +0000344 if self.debuglevel > 0:
345 print "reply:", repr(line)
Jeremy Hyltonb6769522003-06-29 17:55:05 +0000346 if not line:
347 # Presumably, the server closed the connection before
348 # sending a valid response.
349 raise BadStatusLine(line)
Greg Steindd6eefb2000-07-18 09:09:48 +0000350 try:
Guido van Rossum34735a62000-12-15 15:09:42 +0000351 [version, status, reason] = line.split(None, 2)
Greg Steindd6eefb2000-07-18 09:09:48 +0000352 except ValueError:
353 try:
Guido van Rossum34735a62000-12-15 15:09:42 +0000354 [version, status] = line.split(None, 1)
Greg Steindd6eefb2000-07-18 09:09:48 +0000355 reason = ""
356 except ValueError:
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000357 # empty version will cause next test to fail and status
358 # will be treated as 0.9 response.
359 version = ""
360 if not version.startswith('HTTP/'):
361 if self.strict:
362 self.close()
363 raise BadStatusLine(line)
364 else:
365 # assume it's a Simple-Response from an 0.9 server
366 self.fp = LineAndFileWrapper(line, self.fp)
367 return "HTTP/0.9", 200, ""
Greg Stein5e0fa402000-06-26 08:28:01 +0000368
Jeremy Hylton23d40472001-04-13 14:57:08 +0000369 # The status code is a three-digit number
370 try:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000371 status = int(status)
Jeremy Hylton23d40472001-04-13 14:57:08 +0000372 if status < 100 or status > 999:
373 raise BadStatusLine(line)
374 except ValueError:
375 raise BadStatusLine(line)
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000376 return version, status, reason
Greg Stein5e0fa402000-06-26 08:28:01 +0000377
Jeremy Hylton39c03802002-07-12 14:04:09 +0000378 def begin(self):
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000379 if self.msg is not None:
380 # we've already started reading the response
381 return
382
383 # read until we get a non-100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000384 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000385 version, status, reason = self._read_status()
Martin v. Löwis39a31782004-09-18 09:03:49 +0000386 if status != CONTINUE:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000387 break
388 # skip the header from the 100 response
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000389 while True:
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000390 skip = self.fp.readline().strip()
391 if not skip:
392 break
393 if self.debuglevel > 0:
394 print "header:", skip
Tim Petersc411dba2002-07-16 21:35:23 +0000395
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000396 self.status = status
397 self.reason = reason.strip()
Greg Steindd6eefb2000-07-18 09:09:48 +0000398 if version == 'HTTP/1.0':
399 self.version = 10
Jeremy Hylton110941a2000-10-12 19:58:36 +0000400 elif version.startswith('HTTP/1.'):
Tim Peters07e99cb2001-01-14 23:47:14 +0000401 self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1
Jeremy Hylton110941a2000-10-12 19:58:36 +0000402 elif version == 'HTTP/0.9':
403 self.version = 9
Greg Steindd6eefb2000-07-18 09:09:48 +0000404 else:
405 raise UnknownProtocol(version)
Greg Stein5e0fa402000-06-26 08:28:01 +0000406
Jeremy Hylton110941a2000-10-12 19:58:36 +0000407 if self.version == 9:
Georg Brandl0aade9a2005-06-26 22:06:54 +0000408 self.length = None
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000409 self.chunked = 0
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000410 self.will_close = 1
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000411 self.msg = HTTPMessage(StringIO())
Jeremy Hylton110941a2000-10-12 19:58:36 +0000412 return
413
Jeremy Hylton6d0a4c72002-07-07 16:51:37 +0000414 self.msg = HTTPMessage(self.fp, 0)
Jeremy Hylton30f86742000-09-18 22:50:38 +0000415 if self.debuglevel > 0:
416 for hdr in self.msg.headers:
417 print "header:", hdr,
Greg Stein5e0fa402000-06-26 08:28:01 +0000418
Greg Steindd6eefb2000-07-18 09:09:48 +0000419 # don't let the msg keep an fp
420 self.msg.fp = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000421
Greg Steindd6eefb2000-07-18 09:09:48 +0000422 # are we using the chunked-style of transfer encoding?
423 tr_enc = self.msg.getheader('transfer-encoding')
Jeremy Hyltond229b3a2002-09-03 19:24:24 +0000424 if tr_enc and tr_enc.lower() == "chunked":
Greg Steindd6eefb2000-07-18 09:09:48 +0000425 self.chunked = 1
426 self.chunk_left = None
427 else:
428 self.chunked = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000429
Greg Steindd6eefb2000-07-18 09:09:48 +0000430 # will the connection close at the end of the response?
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000431 self.will_close = self._check_close()
Greg Stein5e0fa402000-06-26 08:28:01 +0000432
Greg Steindd6eefb2000-07-18 09:09:48 +0000433 # do we have a Content-Length?
434 # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked"
435 length = self.msg.getheader('content-length')
436 if length and not self.chunked:
Jeremy Hylton30a81812000-09-14 20:34:27 +0000437 try:
438 self.length = int(length)
439 except ValueError:
440 self.length = None
Greg Steindd6eefb2000-07-18 09:09:48 +0000441 else:
442 self.length = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000443
Greg Steindd6eefb2000-07-18 09:09:48 +0000444 # does the body have a fixed length? (of zero)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000445 if (status == NO_CONTENT or status == NOT_MODIFIED or
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000446 100 <= status < 200 or # 1xx codes
447 self._method == 'HEAD'):
Greg Steindd6eefb2000-07-18 09:09:48 +0000448 self.length = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000449
Greg Steindd6eefb2000-07-18 09:09:48 +0000450 # if the connection remains open, and we aren't using chunked, and
451 # a content-length was not provided, then assume that the connection
452 # WILL close.
453 if not self.will_close and \
454 not self.chunked and \
455 self.length is None:
456 self.will_close = 1
Greg Stein5e0fa402000-06-26 08:28:01 +0000457
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000458 def _check_close(self):
Jeremy Hylton2c178252004-08-07 16:28:14 +0000459 conn = self.msg.getheader('connection')
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000460 if self.version == 11:
461 # An HTTP/1.1 proxy is assumed to stay open unless
462 # explicitly closed.
463 conn = self.msg.getheader('connection')
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000464 if conn and "close" in conn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000465 return True
466 return False
467
Jeremy Hylton2c178252004-08-07 16:28:14 +0000468 # Some HTTP/1.0 implementations have support for persistent
469 # connections, using rules different than HTTP/1.1.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000470
Georg Brandl26458c12007-12-08 10:56:39 +0000471 # For older HTTP, Keep-Alive indicates persistent connection.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000472 if self.msg.getheader('keep-alive'):
473 return False
Tim Peters77c06fb2002-11-24 02:35:35 +0000474
Jeremy Hylton2c178252004-08-07 16:28:14 +0000475 # At least Akamai returns a "Connection: Keep-Alive" header,
476 # which was supposed to be sent by the client.
477 if conn and "keep-alive" in conn.lower():
478 return False
479
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000480 # Proxy-Connection is a netscape hack.
481 pconn = self.msg.getheader('proxy-connection')
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000482 if pconn and "keep-alive" in pconn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000483 return False
484
485 # otherwise, assume it will close
486 return True
487
Greg Steindd6eefb2000-07-18 09:09:48 +0000488 def close(self):
489 if self.fp:
490 self.fp.close()
491 self.fp = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000492
Greg Steindd6eefb2000-07-18 09:09:48 +0000493 def isclosed(self):
494 # NOTE: it is possible that we will not ever call self.close(). This
495 # case occurs when will_close is TRUE, length is None, and we
496 # read up to the last byte, but NOT past it.
497 #
498 # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be
499 # called, meaning self.isclosed() is meaningful.
500 return self.fp is None
501
Jeremy Hylton2c178252004-08-07 16:28:14 +0000502 # XXX It would be nice to have readline and __iter__ for this, too.
503
Greg Steindd6eefb2000-07-18 09:09:48 +0000504 def read(self, amt=None):
505 if self.fp is None:
506 return ''
507
508 if self.chunked:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000509 return self._read_chunked(amt)
Tim Peters230a60c2002-11-09 05:08:07 +0000510
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000511 if amt is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000512 # unbounded read
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000513 if self.length is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000514 s = self.fp.read()
515 else:
516 s = self._safe_read(self.length)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000517 self.length = 0
Tim Peters07e99cb2001-01-14 23:47:14 +0000518 self.close() # we read everything
Greg Steindd6eefb2000-07-18 09:09:48 +0000519 return s
520
521 if self.length is not None:
522 if amt > self.length:
523 # clip the read to the "end of response"
524 amt = self.length
Greg Steindd6eefb2000-07-18 09:09:48 +0000525
526 # we do not use _safe_read() here because this may be a .will_close
527 # connection, and the user is reading more bytes than will be provided
528 # (for example, reading in 1k chunks)
529 s = self.fp.read(amt)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000530 if self.length is not None:
531 self.length -= len(s)
Facundo Batista70665902007-10-18 03:16:03 +0000532 if not self.length:
533 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +0000534 return s
535
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000536 def _read_chunked(self, amt):
537 assert self.chunked != _UNKNOWN
538 chunk_left = self.chunk_left
539 value = ''
540
541 # XXX This accumulates chunks by repeated string concatenation,
542 # which is not efficient as the number or size of chunks gets big.
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000543 while True:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000544 if chunk_left is None:
545 line = self.fp.readline()
546 i = line.find(';')
547 if i >= 0:
548 line = line[:i] # strip chunk-extensions
549 chunk_left = int(line, 16)
550 if chunk_left == 0:
551 break
552 if amt is None:
553 value += self._safe_read(chunk_left)
554 elif amt < chunk_left:
555 value += self._safe_read(amt)
556 self.chunk_left = chunk_left - amt
557 return value
558 elif amt == chunk_left:
559 value += self._safe_read(amt)
560 self._safe_read(2) # toss the CRLF at the end of the chunk
561 self.chunk_left = None
562 return value
563 else:
564 value += self._safe_read(chunk_left)
565 amt -= chunk_left
566
567 # we read the whole chunk, get another
568 self._safe_read(2) # toss the CRLF at the end of the chunk
569 chunk_left = None
570
571 # read and discard trailer up to the CRLF terminator
572 ### note: we shouldn't have any trailers!
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000573 while True:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000574 line = self.fp.readline()
Martin v. Löwisdad88dc2008-02-12 18:47:34 +0000575 if not line:
576 # a vanishingly small number of sites EOF without
577 # sending the trailer
578 break
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000579 if line == '\r\n':
580 break
581
582 # we read everything; close the "file"
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000583 self.close()
584
585 return value
Tim Peters230a60c2002-11-09 05:08:07 +0000586
Greg Steindd6eefb2000-07-18 09:09:48 +0000587 def _safe_read(self, amt):
588 """Read the number of bytes requested, compensating for partial reads.
589
590 Normally, we have a blocking socket, but a read() can be interrupted
591 by a signal (resulting in a partial read).
592
593 Note that we cannot distinguish between EOF and an interrupt when zero
594 bytes have been read. IncompleteRead() will be raised in this
595 situation.
596
597 This function should be used when <amt> bytes "should" be present for
598 reading. If the bytes are truly not available (due to EOF), then the
599 IncompleteRead exception can be used to detect the problem.
600 """
Georg Brandl80ba8e82005-09-29 20:16:07 +0000601 s = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000602 while amt > 0:
Georg Brandl80ba8e82005-09-29 20:16:07 +0000603 chunk = self.fp.read(min(amt, MAXAMOUNT))
Greg Steindd6eefb2000-07-18 09:09:48 +0000604 if not chunk:
605 raise IncompleteRead(s)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000606 s.append(chunk)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000607 amt -= len(chunk)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000608 return ''.join(s)
Greg Steindd6eefb2000-07-18 09:09:48 +0000609
610 def getheader(self, name, default=None):
611 if self.msg is None:
612 raise ResponseNotReady()
613 return self.msg.getheader(name, default)
Greg Stein5e0fa402000-06-26 08:28:01 +0000614
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000615 def getheaders(self):
616 """Return list of (header, value) tuples."""
617 if self.msg is None:
618 raise ResponseNotReady()
619 return self.msg.items()
620
Greg Stein5e0fa402000-06-26 08:28:01 +0000621
622class HTTPConnection:
623
Greg Steindd6eefb2000-07-18 09:09:48 +0000624 _http_vsn = 11
625 _http_vsn_str = 'HTTP/1.1'
Greg Stein5e0fa402000-06-26 08:28:01 +0000626
Greg Steindd6eefb2000-07-18 09:09:48 +0000627 response_class = HTTPResponse
628 default_port = HTTP_PORT
629 auto_open = 1
Jeremy Hylton30f86742000-09-18 22:50:38 +0000630 debuglevel = 0
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000631 strict = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000632
Facundo Batista07c78be2007-03-23 18:54:07 +0000633 def __init__(self, host, port=None, strict=None, timeout=None):
634 self.timeout = timeout
Greg Steindd6eefb2000-07-18 09:09:48 +0000635 self.sock = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000636 self._buffer = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000637 self.__response = None
638 self.__state = _CS_IDLE
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000639 self._method = None
Tim Petersc411dba2002-07-16 21:35:23 +0000640
Greg Steindd6eefb2000-07-18 09:09:48 +0000641 self._set_hostport(host, port)
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000642 if strict is not None:
643 self.strict = strict
Greg Stein5e0fa402000-06-26 08:28:01 +0000644
Greg Steindd6eefb2000-07-18 09:09:48 +0000645 def _set_hostport(self, host, port):
646 if port is None:
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000647 i = host.rfind(':')
Skip Montanarocae14d22004-09-14 17:55:21 +0000648 j = host.rfind(']') # ipv6 addresses have [...]
649 if i > j:
Skip Montanaro9d389972002-03-24 16:53:50 +0000650 try:
651 port = int(host[i+1:])
652 except ValueError:
Jeremy Hyltonfbd79942002-07-02 20:19:08 +0000653 raise InvalidURL("nonnumeric port: '%s'" % host[i+1:])
Greg Steindd6eefb2000-07-18 09:09:48 +0000654 host = host[:i]
655 else:
656 port = self.default_port
Raymond Hettinger4d037912004-10-14 15:23:38 +0000657 if host and host[0] == '[' and host[-1] == ']':
Brett Cannon0a1af4a2004-09-15 23:26:23 +0000658 host = host[1:-1]
Greg Steindd6eefb2000-07-18 09:09:48 +0000659 self.host = host
660 self.port = port
Greg Stein5e0fa402000-06-26 08:28:01 +0000661
Jeremy Hylton30f86742000-09-18 22:50:38 +0000662 def set_debuglevel(self, level):
663 self.debuglevel = level
664
Greg Steindd6eefb2000-07-18 09:09:48 +0000665 def connect(self):
666 """Connect to the host and port specified in __init__."""
Georg Brandlf03facf2007-03-26 20:28:28 +0000667 self.sock = socket.create_connection((self.host,self.port),
668 self.timeout)
Greg Stein5e0fa402000-06-26 08:28:01 +0000669
Greg Steindd6eefb2000-07-18 09:09:48 +0000670 def close(self):
671 """Close the connection to the HTTP server."""
672 if self.sock:
Tim Peters07e99cb2001-01-14 23:47:14 +0000673 self.sock.close() # close it manually... there may be other refs
Greg Steindd6eefb2000-07-18 09:09:48 +0000674 self.sock = None
675 if self.__response:
676 self.__response.close()
677 self.__response = None
678 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000679
Greg Steindd6eefb2000-07-18 09:09:48 +0000680 def send(self, str):
681 """Send `str' to the server."""
682 if self.sock is None:
683 if self.auto_open:
684 self.connect()
685 else:
686 raise NotConnected()
Greg Stein5e0fa402000-06-26 08:28:01 +0000687
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000688 # send the data to the server. if we get a broken pipe, then close
Greg Steindd6eefb2000-07-18 09:09:48 +0000689 # the socket. we want to reconnect when somebody tries to send again.
690 #
691 # NOTE: we DO propagate the error, though, because we cannot simply
692 # ignore the error... the caller will know if they can retry.
Jeremy Hylton30f86742000-09-18 22:50:38 +0000693 if self.debuglevel > 0:
694 print "send:", repr(str)
Greg Steindd6eefb2000-07-18 09:09:48 +0000695 try:
Martin v. Löwis040a9272006-11-12 10:32:47 +0000696 blocksize=8192
697 if hasattr(str,'read') :
698 if self.debuglevel > 0: print "sendIng a read()able"
699 data=str.read(blocksize)
700 while data:
701 self.sock.sendall(data)
702 data=str.read(blocksize)
703 else:
704 self.sock.sendall(str)
Greg Steindd6eefb2000-07-18 09:09:48 +0000705 except socket.error, v:
Tim Peters07e99cb2001-01-14 23:47:14 +0000706 if v[0] == 32: # Broken pipe
Greg Steindd6eefb2000-07-18 09:09:48 +0000707 self.close()
708 raise
Greg Stein5e0fa402000-06-26 08:28:01 +0000709
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000710 def _output(self, s):
711 """Add a line of output to the current request buffer.
Tim Peters469cdad2002-08-08 20:19:19 +0000712
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000713 Assumes that the line does *not* end with \\r\\n.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000714 """
715 self._buffer.append(s)
716
717 def _send_output(self):
718 """Send the currently buffered request and clear the buffer.
719
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000720 Appends an extra \\r\\n to the buffer.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000721 """
722 self._buffer.extend(("", ""))
723 msg = "\r\n".join(self._buffer)
724 del self._buffer[:]
725 self.send(msg)
726
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000727 def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0):
Greg Steindd6eefb2000-07-18 09:09:48 +0000728 """Send a request to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000729
Greg Steindd6eefb2000-07-18 09:09:48 +0000730 `method' specifies an HTTP request method, e.g. 'GET'.
731 `url' specifies the object being requested, e.g. '/index.html'.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000732 `skip_host' if True does not add automatically a 'Host:' header
733 `skip_accept_encoding' if True does not add automatically an
734 'Accept-Encoding:' header
Greg Steindd6eefb2000-07-18 09:09:48 +0000735 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000736
Greg Stein616a58d2003-06-24 06:35:19 +0000737 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000738 if self.__response and self.__response.isclosed():
739 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000740
Tim Peters58eb11c2004-01-18 20:29:55 +0000741
Greg Steindd6eefb2000-07-18 09:09:48 +0000742 # in certain cases, we cannot issue another request on this connection.
743 # this occurs when:
744 # 1) we are in the process of sending a request. (_CS_REQ_STARTED)
745 # 2) a response to a previous request has signalled that it is going
746 # to close the connection upon completion.
747 # 3) the headers for the previous response have not been read, thus
748 # we cannot determine whether point (2) is true. (_CS_REQ_SENT)
749 #
750 # if there is no prior response, then we can request at will.
751 #
752 # if point (2) is true, then we will have passed the socket to the
753 # response (effectively meaning, "there is no prior response"), and
754 # will open a new one when a new request is made.
755 #
756 # Note: if a prior response exists, then we *can* start a new request.
757 # We are not allowed to begin fetching the response to this new
758 # request, however, until that prior response is complete.
759 #
760 if self.__state == _CS_IDLE:
761 self.__state = _CS_REQ_STARTED
762 else:
763 raise CannotSendRequest()
Greg Stein5e0fa402000-06-26 08:28:01 +0000764
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000765 # Save the method we use, we need it later in the response phase
766 self._method = method
Greg Steindd6eefb2000-07-18 09:09:48 +0000767 if not url:
768 url = '/'
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000769 str = '%s %s %s' % (method, url, self._http_vsn_str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000770
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000771 self._output(str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000772
Greg Steindd6eefb2000-07-18 09:09:48 +0000773 if self._http_vsn == 11:
774 # Issue some standard headers for better HTTP/1.1 compliance
Greg Stein5e0fa402000-06-26 08:28:01 +0000775
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000776 if not skip_host:
777 # this header is issued *only* for HTTP/1.1
778 # connections. more specifically, this means it is
779 # only issued when the client uses the new
780 # HTTPConnection() class. backwards-compat clients
781 # will be using HTTP/1.0 and those clients may be
782 # issuing this header themselves. we should NOT issue
783 # it twice; some web servers (such as Apache) barf
784 # when they see two Host: headers
Guido van Rossumf6922aa2001-01-14 21:03:01 +0000785
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000786 # If we need a non-standard port,include it in the
787 # header. If the request is going through a proxy,
788 # but the host of the actual URL, not the host of the
789 # proxy.
Jeremy Hylton8acf1e02002-03-08 19:35:51 +0000790
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000791 netloc = ''
792 if url.startswith('http'):
793 nil, netloc, nil, nil, nil = urlsplit(url)
794
795 if netloc:
Georg Brandla2ac2ef2006-05-03 18:03:22 +0000796 try:
797 netloc_enc = netloc.encode("ascii")
798 except UnicodeEncodeError:
799 netloc_enc = netloc.encode("idna")
800 self.putheader('Host', netloc_enc)
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000801 else:
Georg Brandla2ac2ef2006-05-03 18:03:22 +0000802 try:
803 host_enc = self.host.encode("ascii")
804 except UnicodeEncodeError:
805 host_enc = self.host.encode("idna")
806 if self.port == HTTP_PORT:
807 self.putheader('Host', host_enc)
808 else:
809 self.putheader('Host', "%s:%s" % (host_enc, self.port))
Greg Stein5e0fa402000-06-26 08:28:01 +0000810
Greg Steindd6eefb2000-07-18 09:09:48 +0000811 # note: we are assuming that clients will not attempt to set these
812 # headers since *this* library must deal with the
813 # consequences. this also means that when the supporting
814 # libraries are updated to recognize other forms, then this
815 # code should be changed (removed or updated).
Greg Stein5e0fa402000-06-26 08:28:01 +0000816
Greg Steindd6eefb2000-07-18 09:09:48 +0000817 # we only want a Content-Encoding of "identity" since we don't
818 # support encodings such as x-gzip or x-deflate.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000819 if not skip_accept_encoding:
820 self.putheader('Accept-Encoding', 'identity')
Greg Stein5e0fa402000-06-26 08:28:01 +0000821
Greg Steindd6eefb2000-07-18 09:09:48 +0000822 # we can accept "chunked" Transfer-Encodings, but no others
823 # NOTE: no TE header implies *only* "chunked"
824 #self.putheader('TE', 'chunked')
Greg Stein5e0fa402000-06-26 08:28:01 +0000825
Greg Steindd6eefb2000-07-18 09:09:48 +0000826 # if TE is supplied in the header, then it must appear in a
827 # Connection header.
828 #self.putheader('Connection', 'TE')
Greg Stein5e0fa402000-06-26 08:28:01 +0000829
Greg Steindd6eefb2000-07-18 09:09:48 +0000830 else:
831 # For HTTP/1.0, the server will assume "not chunked"
832 pass
Greg Stein5e0fa402000-06-26 08:28:01 +0000833
Greg Steindd6eefb2000-07-18 09:09:48 +0000834 def putheader(self, header, value):
835 """Send a request header line to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000836
Greg Steindd6eefb2000-07-18 09:09:48 +0000837 For example: h.putheader('Accept', 'text/html')
838 """
839 if self.__state != _CS_REQ_STARTED:
840 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +0000841
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000842 str = '%s: %s' % (header, value)
843 self._output(str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000844
Greg Steindd6eefb2000-07-18 09:09:48 +0000845 def endheaders(self):
846 """Indicate that the last header line has been sent to the server."""
Greg Stein5e0fa402000-06-26 08:28:01 +0000847
Greg Steindd6eefb2000-07-18 09:09:48 +0000848 if self.__state == _CS_REQ_STARTED:
849 self.__state = _CS_REQ_SENT
850 else:
851 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +0000852
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000853 self._send_output()
Greg Stein5e0fa402000-06-26 08:28:01 +0000854
Greg Steindd6eefb2000-07-18 09:09:48 +0000855 def request(self, method, url, body=None, headers={}):
856 """Send a complete request to the server."""
Greg Stein5e0fa402000-06-26 08:28:01 +0000857
Greg Steindd6eefb2000-07-18 09:09:48 +0000858 try:
859 self._send_request(method, url, body, headers)
860 except socket.error, v:
861 # trap 'Broken pipe' if we're allowed to automatically reconnect
862 if v[0] != 32 or not self.auto_open:
863 raise
864 # try one more time
865 self._send_request(method, url, body, headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000866
Greg Steindd6eefb2000-07-18 09:09:48 +0000867 def _send_request(self, method, url, body, headers):
Jeremy Hylton2c178252004-08-07 16:28:14 +0000868 # honour explicitly requested Host: and Accept-Encoding headers
869 header_names = dict.fromkeys([k.lower() for k in headers])
870 skips = {}
871 if 'host' in header_names:
872 skips['skip_host'] = 1
873 if 'accept-encoding' in header_names:
874 skips['skip_accept_encoding'] = 1
Greg Stein5e0fa402000-06-26 08:28:01 +0000875
Jeremy Hylton2c178252004-08-07 16:28:14 +0000876 self.putrequest(method, url, **skips)
877
878 if body and ('content-length' not in header_names):
Martin v. Löwis040a9272006-11-12 10:32:47 +0000879 thelen=None
880 try:
881 thelen=str(len(body))
882 except TypeError, te:
883 # If this is a file-like object, try to
884 # fstat its file descriptor
885 import os
886 try:
887 thelen = str(os.fstat(body.fileno()).st_size)
888 except (AttributeError, OSError):
889 # Don't send a length if this failed
890 if self.debuglevel > 0: print "Cannot stat!!"
Tim Petersf733abb2007-01-30 03:03:46 +0000891
Martin v. Löwis040a9272006-11-12 10:32:47 +0000892 if thelen is not None:
893 self.putheader('Content-Length',thelen)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000894 for hdr, value in headers.iteritems():
Greg Steindd6eefb2000-07-18 09:09:48 +0000895 self.putheader(hdr, value)
896 self.endheaders()
Greg Stein5e0fa402000-06-26 08:28:01 +0000897
Greg Steindd6eefb2000-07-18 09:09:48 +0000898 if body:
899 self.send(body)
Greg Stein5e0fa402000-06-26 08:28:01 +0000900
Greg Steindd6eefb2000-07-18 09:09:48 +0000901 def getresponse(self):
902 "Get the response from the server."
Greg Stein5e0fa402000-06-26 08:28:01 +0000903
Greg Stein616a58d2003-06-24 06:35:19 +0000904 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000905 if self.__response and self.__response.isclosed():
906 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000907
Greg Steindd6eefb2000-07-18 09:09:48 +0000908 #
909 # if a prior response exists, then it must be completed (otherwise, we
910 # cannot read this response's header to determine the connection-close
911 # behavior)
912 #
913 # note: if a prior response existed, but was connection-close, then the
914 # socket and response were made independent of this HTTPConnection
915 # object since a new request requires that we open a whole new
916 # connection
917 #
918 # this means the prior response had one of two states:
919 # 1) will_close: this connection was reset and the prior socket and
920 # response operate independently
921 # 2) persistent: the response was retained and we await its
922 # isclosed() status to become true.
923 #
924 if self.__state != _CS_REQ_SENT or self.__response:
925 raise ResponseNotReady()
Greg Stein5e0fa402000-06-26 08:28:01 +0000926
Jeremy Hylton30f86742000-09-18 22:50:38 +0000927 if self.debuglevel > 0:
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000928 response = self.response_class(self.sock, self.debuglevel,
Tim Petersc2659cf2003-05-12 20:19:37 +0000929 strict=self.strict,
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000930 method=self._method)
Jeremy Hylton30f86742000-09-18 22:50:38 +0000931 else:
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000932 response = self.response_class(self.sock, strict=self.strict,
933 method=self._method)
Greg Stein5e0fa402000-06-26 08:28:01 +0000934
Jeremy Hylton39c03802002-07-12 14:04:09 +0000935 response.begin()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000936 assert response.will_close != _UNKNOWN
Greg Steindd6eefb2000-07-18 09:09:48 +0000937 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000938
Greg Steindd6eefb2000-07-18 09:09:48 +0000939 if response.will_close:
Martin v. Löwis0af33882007-03-23 13:27:15 +0000940 # this effectively passes the connection to the response
941 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +0000942 else:
943 # remember this, so we can tell when it is complete
944 self.__response = response
Greg Stein5e0fa402000-06-26 08:28:01 +0000945
Greg Steindd6eefb2000-07-18 09:09:48 +0000946 return response
Greg Stein5e0fa402000-06-26 08:28:01 +0000947
Greg Stein5e0fa402000-06-26 08:28:01 +0000948
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +0000949class HTTP:
Greg Steindd6eefb2000-07-18 09:09:48 +0000950 "Compatibility class with httplib.py from 1.5."
Greg Stein5e0fa402000-06-26 08:28:01 +0000951
Greg Steindd6eefb2000-07-18 09:09:48 +0000952 _http_vsn = 10
953 _http_vsn_str = 'HTTP/1.0'
Greg Stein5e0fa402000-06-26 08:28:01 +0000954
Greg Steindd6eefb2000-07-18 09:09:48 +0000955 debuglevel = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000956
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +0000957 _connection_class = HTTPConnection
958
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000959 def __init__(self, host='', port=None, strict=None):
Greg Steindd6eefb2000-07-18 09:09:48 +0000960 "Provide a default host, since the superclass requires one."
Greg Stein5e0fa402000-06-26 08:28:01 +0000961
Greg Steindd6eefb2000-07-18 09:09:48 +0000962 # some joker passed 0 explicitly, meaning default port
963 if port == 0:
964 port = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000965
Greg Steindd6eefb2000-07-18 09:09:48 +0000966 # Note that we may pass an empty string as the host; this will throw
967 # an error when we attempt to connect. Presumably, the client code
968 # will call connect before then, with a proper host.
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000969 self._setup(self._connection_class(host, port, strict))
Greg Stein5e0fa402000-06-26 08:28:01 +0000970
Greg Stein81937a42001-08-18 09:20:23 +0000971 def _setup(self, conn):
972 self._conn = conn
973
974 # set up delegation to flesh out interface
975 self.send = conn.send
976 self.putrequest = conn.putrequest
977 self.endheaders = conn.endheaders
978 self.set_debuglevel = conn.set_debuglevel
979
980 conn._http_vsn = self._http_vsn
981 conn._http_vsn_str = self._http_vsn_str
Greg Stein5e0fa402000-06-26 08:28:01 +0000982
Greg Steindd6eefb2000-07-18 09:09:48 +0000983 self.file = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000984
Greg Steindd6eefb2000-07-18 09:09:48 +0000985 def connect(self, host=None, port=None):
986 "Accept arguments to set the host/port, since the superclass doesn't."
Greg Stein5e0fa402000-06-26 08:28:01 +0000987
Greg Steindd6eefb2000-07-18 09:09:48 +0000988 if host is not None:
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +0000989 self._conn._set_hostport(host, port)
990 self._conn.connect()
Greg Stein5e0fa402000-06-26 08:28:01 +0000991
Greg Steindd6eefb2000-07-18 09:09:48 +0000992 def getfile(self):
993 "Provide a getfile, since the superclass' does not use this concept."
994 return self.file
Greg Stein5e0fa402000-06-26 08:28:01 +0000995
Greg Steindd6eefb2000-07-18 09:09:48 +0000996 def putheader(self, header, *values):
997 "The superclass allows only one value argument."
Guido van Rossum34735a62000-12-15 15:09:42 +0000998 self._conn.putheader(header, '\r\n\t'.join(values))
Greg Stein5e0fa402000-06-26 08:28:01 +0000999
Greg Steindd6eefb2000-07-18 09:09:48 +00001000 def getreply(self):
1001 """Compat definition since superclass does not define it.
Greg Stein5e0fa402000-06-26 08:28:01 +00001002
Greg Steindd6eefb2000-07-18 09:09:48 +00001003 Returns a tuple consisting of:
1004 - server status code (e.g. '200' if all goes well)
1005 - server "reason" corresponding to status code
1006 - any RFC822 headers in the response from the server
1007 """
1008 try:
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +00001009 response = self._conn.getresponse()
Greg Steindd6eefb2000-07-18 09:09:48 +00001010 except BadStatusLine, e:
1011 ### hmm. if getresponse() ever closes the socket on a bad request,
1012 ### then we are going to have problems with self.sock
Greg Stein5e0fa402000-06-26 08:28:01 +00001013
Greg Steindd6eefb2000-07-18 09:09:48 +00001014 ### should we keep this behavior? do people use it?
1015 # keep the socket open (as a file), and return it
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +00001016 self.file = self._conn.sock.makefile('rb', 0)
Greg Stein5e0fa402000-06-26 08:28:01 +00001017
Greg Steindd6eefb2000-07-18 09:09:48 +00001018 # close our socket -- we want to restart after any protocol error
1019 self.close()
Greg Stein5e0fa402000-06-26 08:28:01 +00001020
Greg Steindd6eefb2000-07-18 09:09:48 +00001021 self.headers = None
1022 return -1, e.line, None
Greg Stein5e0fa402000-06-26 08:28:01 +00001023
Greg Steindd6eefb2000-07-18 09:09:48 +00001024 self.headers = response.msg
1025 self.file = response.fp
1026 return response.status, response.reason, response.msg
Greg Stein5e0fa402000-06-26 08:28:01 +00001027
Greg Steindd6eefb2000-07-18 09:09:48 +00001028 def close(self):
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +00001029 self._conn.close()
Greg Stein5e0fa402000-06-26 08:28:01 +00001030
Greg Steindd6eefb2000-07-18 09:09:48 +00001031 # note that self.file == response.fp, which gets closed by the
1032 # superclass. just clear the object ref here.
1033 ### hmm. messy. if status==-1, then self.file is owned by us.
1034 ### well... we aren't explicitly closing, but losing this ref will
1035 ### do it
1036 self.file = None
Greg Stein5e0fa402000-06-26 08:28:01 +00001037
Bill Janssen426ea0a2007-08-29 22:35:05 +00001038try:
1039 import ssl
1040except ImportError:
1041 pass
1042else:
1043 class HTTPSConnection(HTTPConnection):
1044 "This class allows communication via SSL."
1045
1046 default_port = HTTPS_PORT
1047
1048 def __init__(self, host, port=None, key_file=None, cert_file=None,
1049 strict=None, timeout=None):
1050 HTTPConnection.__init__(self, host, port, strict, timeout)
1051 self.key_file = key_file
1052 self.cert_file = cert_file
1053
1054 def connect(self):
1055 "Connect to a host on a given (SSL) port."
1056
1057 sock = socket.create_connection((self.host, self.port), self.timeout)
Bill Janssen98d19da2007-09-10 21:51:02 +00001058 self.sock = ssl.wrap_socket(sock, self.key_file, self.cert_file)
Bill Janssen426ea0a2007-08-29 22:35:05 +00001059
Thomas Woutersa6900e82007-08-30 21:54:39 +00001060 __all__.append("HTTPSConnection")
Bill Janssen426ea0a2007-08-29 22:35:05 +00001061
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +00001062 class HTTPS(HTTP):
1063 """Compatibility with 1.5 httplib interface
1064
1065 Python 1.5.2 did not have an HTTPS class, but it defined an
1066 interface for sending http requests that is also useful for
Tim Peters5ceadc82001-01-13 19:16:21 +00001067 https.
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +00001068 """
1069
Martin v. Löwisd7bf9742000-09-21 22:09:47 +00001070 _connection_class = HTTPSConnection
Tim Peters5ceadc82001-01-13 19:16:21 +00001071
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001072 def __init__(self, host='', port=None, key_file=None, cert_file=None,
1073 strict=None):
Greg Stein81937a42001-08-18 09:20:23 +00001074 # provide a default host, pass the X509 cert info
1075
1076 # urf. compensate for bad input.
1077 if port == 0:
1078 port = None
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001079 self._setup(self._connection_class(host, port, key_file,
1080 cert_file, strict))
Greg Stein81937a42001-08-18 09:20:23 +00001081
1082 # we never actually use these for anything, but we keep them
1083 # here for compatibility with post-1.5.2 CVS.
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001084 self.key_file = key_file
1085 self.cert_file = cert_file
Greg Stein81937a42001-08-18 09:20:23 +00001086
Greg Stein5e0fa402000-06-26 08:28:01 +00001087
Bill Janssen426ea0a2007-08-29 22:35:05 +00001088 def FakeSocket (sock, sslobj):
Bill Janssenc4592642007-08-31 19:02:23 +00001089 warnings.warn("FakeSocket is deprecated, and won't be in 3.x. " +
Bill Janssen98d19da2007-09-10 21:51:02 +00001090 "Use the result of ssl.wrap_socket() directly instead.",
Bill Janssenc4592642007-08-31 19:02:23 +00001091 DeprecationWarning, stacklevel=2)
Bill Janssen426ea0a2007-08-29 22:35:05 +00001092 return sslobj
1093
1094
Greg Stein5e0fa402000-06-26 08:28:01 +00001095class HTTPException(Exception):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001096 # Subclasses that define an __init__ must call Exception.__init__
1097 # or define self.args. Otherwise, str() will fail.
Greg Steindd6eefb2000-07-18 09:09:48 +00001098 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001099
1100class NotConnected(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001101 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001102
Skip Montanaro9d389972002-03-24 16:53:50 +00001103class InvalidURL(HTTPException):
1104 pass
1105
Greg Stein5e0fa402000-06-26 08:28:01 +00001106class UnknownProtocol(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001107 def __init__(self, version):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001108 self.args = version,
Greg Steindd6eefb2000-07-18 09:09:48 +00001109 self.version = version
Greg Stein5e0fa402000-06-26 08:28:01 +00001110
1111class UnknownTransferEncoding(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001112 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001113
Greg Stein5e0fa402000-06-26 08:28:01 +00001114class UnimplementedFileMode(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001115 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001116
1117class IncompleteRead(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001118 def __init__(self, partial):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001119 self.args = partial,
Greg Steindd6eefb2000-07-18 09:09:48 +00001120 self.partial = partial
Greg Stein5e0fa402000-06-26 08:28:01 +00001121
1122class ImproperConnectionState(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001123 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001124
1125class CannotSendRequest(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001126 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001127
1128class CannotSendHeader(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001129 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001130
1131class ResponseNotReady(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001132 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001133
1134class BadStatusLine(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001135 def __init__(self, line):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001136 self.args = line,
Greg Steindd6eefb2000-07-18 09:09:48 +00001137 self.line = line
Greg Stein5e0fa402000-06-26 08:28:01 +00001138
1139# for backwards compatibility
1140error = HTTPException
1141
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001142class LineAndFileWrapper:
1143 """A limited file-like object for HTTP/0.9 responses."""
1144
1145 # The status-line parsing code calls readline(), which normally
1146 # get the HTTP status line. For a 0.9 response, however, this is
1147 # actually the first line of the body! Clients need to get a
1148 # readable file object that contains that line.
1149
1150 def __init__(self, line, file):
1151 self._line = line
1152 self._file = file
1153 self._line_consumed = 0
1154 self._line_offset = 0
1155 self._line_left = len(line)
1156
1157 def __getattr__(self, attr):
1158 return getattr(self._file, attr)
1159
1160 def _done(self):
1161 # called when the last byte is read from the line. After the
1162 # call, all read methods are delegated to the underlying file
Skip Montanaro74b9a7a2003-02-25 17:48:15 +00001163 # object.
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001164 self._line_consumed = 1
1165 self.read = self._file.read
1166 self.readline = self._file.readline
1167 self.readlines = self._file.readlines
1168
1169 def read(self, amt=None):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001170 if self._line_consumed:
1171 return self._file.read(amt)
1172 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001173 if amt is None or amt > self._line_left:
1174 s = self._line[self._line_offset:]
1175 self._done()
1176 if amt is None:
1177 return s + self._file.read()
1178 else:
Tim Petersc411dba2002-07-16 21:35:23 +00001179 return s + self._file.read(amt - len(s))
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001180 else:
1181 assert amt <= self._line_left
1182 i = self._line_offset
1183 j = i + amt
1184 s = self._line[i:j]
1185 self._line_offset = j
1186 self._line_left -= amt
1187 if self._line_left == 0:
1188 self._done()
1189 return s
Tim Petersc411dba2002-07-16 21:35:23 +00001190
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001191 def readline(self):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001192 if self._line_consumed:
1193 return self._file.readline()
1194 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001195 s = self._line[self._line_offset:]
1196 self._done()
1197 return s
1198
1199 def readlines(self, size=None):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001200 if self._line_consumed:
1201 return self._file.readlines(size)
1202 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001203 L = [self._line[self._line_offset:]]
1204 self._done()
1205 if size is None:
1206 return L + self._file.readlines()
1207 else:
1208 return L + self._file.readlines(size)
Greg Stein5e0fa402000-06-26 08:28:01 +00001209
Guido van Rossum23acc951994-02-21 16:36:04 +00001210def test():
Guido van Rossum41999c11997-12-09 00:12:23 +00001211 """Test this module.
1212
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001213 A hodge podge of tests collected here, because they have too many
1214 external dependencies for the regular test suite.
Guido van Rossum41999c11997-12-09 00:12:23 +00001215 """
Greg Stein5e0fa402000-06-26 08:28:01 +00001216
Guido van Rossum41999c11997-12-09 00:12:23 +00001217 import sys
1218 import getopt
1219 opts, args = getopt.getopt(sys.argv[1:], 'd')
1220 dl = 0
1221 for o, a in opts:
1222 if o == '-d': dl = dl + 1
1223 host = 'www.python.org'
1224 selector = '/'
1225 if args[0:]: host = args[0]
1226 if args[1:]: selector = args[1]
1227 h = HTTP()
1228 h.set_debuglevel(dl)
1229 h.connect(host)
1230 h.putrequest('GET', selector)
1231 h.endheaders()
Greg Stein5e0fa402000-06-26 08:28:01 +00001232 status, reason, headers = h.getreply()
1233 print 'status =', status
1234 print 'reason =', reason
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001235 print "read", len(h.getfile().read())
Guido van Rossum41999c11997-12-09 00:12:23 +00001236 print
1237 if headers:
Guido van Rossum34735a62000-12-15 15:09:42 +00001238 for header in headers.headers: print header.strip()
Guido van Rossum41999c11997-12-09 00:12:23 +00001239 print
Greg Stein5e0fa402000-06-26 08:28:01 +00001240
Jeremy Hylton8acf1e02002-03-08 19:35:51 +00001241 # minimal test that code to extract host from url works
1242 class HTTP11(HTTP):
1243 _http_vsn = 11
1244 _http_vsn_str = 'HTTP/1.1'
1245
1246 h = HTTP11('www.python.org')
1247 h.putrequest('GET', 'http://www.python.org/~jeremy/')
1248 h.endheaders()
1249 h.getreply()
1250 h.close()
1251
Bill Janssen426ea0a2007-08-29 22:35:05 +00001252 try:
1253 import ssl
1254 except ImportError:
1255 pass
1256 else:
Tim Petersc411dba2002-07-16 21:35:23 +00001257
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001258 for host, selector in (('sourceforge.net', '/projects/python'),
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001259 ):
1260 print "https://%s%s" % (host, selector)
1261 hs = HTTPS()
Jeremy Hylton8531b1b2002-07-16 21:21:11 +00001262 hs.set_debuglevel(dl)
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001263 hs.connect(host)
1264 hs.putrequest('GET', selector)
1265 hs.endheaders()
1266 status, reason, headers = hs.getreply()
1267 print 'status =', status
1268 print 'reason =', reason
1269 print "read", len(hs.getfile().read())
1270 print
1271 if headers:
1272 for header in headers.headers: print header.strip()
1273 print
Guido van Rossum23acc951994-02-21 16:36:04 +00001274
Guido van Rossum23acc951994-02-21 16:36:04 +00001275if __name__ == '__main__':
Guido van Rossum41999c11997-12-09 00:12:23 +00001276 test()