blob: 5696467bd1a58890137628b93d27817bf93bb75e [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
Georg Brandl8c460d52008-02-24 00:14:24 +0000441 else:
442 if self.length < 0: # ignore nonsensical negative lengths
443 self.length = None
Greg Steindd6eefb2000-07-18 09:09:48 +0000444 else:
445 self.length = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000446
Greg Steindd6eefb2000-07-18 09:09:48 +0000447 # does the body have a fixed length? (of zero)
Martin v. Löwis39a31782004-09-18 09:03:49 +0000448 if (status == NO_CONTENT or status == NOT_MODIFIED or
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000449 100 <= status < 200 or # 1xx codes
450 self._method == 'HEAD'):
Greg Steindd6eefb2000-07-18 09:09:48 +0000451 self.length = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000452
Greg Steindd6eefb2000-07-18 09:09:48 +0000453 # if the connection remains open, and we aren't using chunked, and
454 # a content-length was not provided, then assume that the connection
455 # WILL close.
456 if not self.will_close and \
457 not self.chunked and \
458 self.length is None:
459 self.will_close = 1
Greg Stein5e0fa402000-06-26 08:28:01 +0000460
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000461 def _check_close(self):
Jeremy Hylton2c178252004-08-07 16:28:14 +0000462 conn = self.msg.getheader('connection')
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000463 if self.version == 11:
464 # An HTTP/1.1 proxy is assumed to stay open unless
465 # explicitly closed.
466 conn = self.msg.getheader('connection')
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000467 if conn and "close" in conn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000468 return True
469 return False
470
Jeremy Hylton2c178252004-08-07 16:28:14 +0000471 # Some HTTP/1.0 implementations have support for persistent
472 # connections, using rules different than HTTP/1.1.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000473
Georg Brandl26458c12007-12-08 10:56:39 +0000474 # For older HTTP, Keep-Alive indicates persistent connection.
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000475 if self.msg.getheader('keep-alive'):
476 return False
Tim Peters77c06fb2002-11-24 02:35:35 +0000477
Jeremy Hylton2c178252004-08-07 16:28:14 +0000478 # At least Akamai returns a "Connection: Keep-Alive" header,
479 # which was supposed to be sent by the client.
480 if conn and "keep-alive" in conn.lower():
481 return False
482
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000483 # Proxy-Connection is a netscape hack.
484 pconn = self.msg.getheader('proxy-connection')
Raymond Hettingerbac788a2004-05-04 09:21:43 +0000485 if pconn and "keep-alive" in pconn.lower():
Jeremy Hylton22b3a492002-11-13 17:27:43 +0000486 return False
487
488 # otherwise, assume it will close
489 return True
490
Greg Steindd6eefb2000-07-18 09:09:48 +0000491 def close(self):
492 if self.fp:
493 self.fp.close()
494 self.fp = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000495
Greg Steindd6eefb2000-07-18 09:09:48 +0000496 def isclosed(self):
497 # NOTE: it is possible that we will not ever call self.close(). This
498 # case occurs when will_close is TRUE, length is None, and we
499 # read up to the last byte, but NOT past it.
500 #
501 # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be
502 # called, meaning self.isclosed() is meaningful.
503 return self.fp is None
504
Jeremy Hylton2c178252004-08-07 16:28:14 +0000505 # XXX It would be nice to have readline and __iter__ for this, too.
506
Greg Steindd6eefb2000-07-18 09:09:48 +0000507 def read(self, amt=None):
508 if self.fp is None:
509 return ''
510
511 if self.chunked:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000512 return self._read_chunked(amt)
Tim Peters230a60c2002-11-09 05:08:07 +0000513
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000514 if amt is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000515 # unbounded read
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000516 if self.length is None:
Greg Steindd6eefb2000-07-18 09:09:48 +0000517 s = self.fp.read()
518 else:
519 s = self._safe_read(self.length)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000520 self.length = 0
Tim Peters07e99cb2001-01-14 23:47:14 +0000521 self.close() # we read everything
Greg Steindd6eefb2000-07-18 09:09:48 +0000522 return s
523
524 if self.length is not None:
525 if amt > self.length:
526 # clip the read to the "end of response"
527 amt = self.length
Greg Steindd6eefb2000-07-18 09:09:48 +0000528
529 # we do not use _safe_read() here because this may be a .will_close
530 # connection, and the user is reading more bytes than will be provided
531 # (for example, reading in 1k chunks)
532 s = self.fp.read(amt)
Jeremy Hyltondef9d2a2004-11-07 16:13:49 +0000533 if self.length is not None:
534 self.length -= len(s)
Facundo Batista70665902007-10-18 03:16:03 +0000535 if not self.length:
536 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +0000537 return s
538
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000539 def _read_chunked(self, amt):
540 assert self.chunked != _UNKNOWN
541 chunk_left = self.chunk_left
542 value = ''
543
544 # XXX This accumulates chunks by repeated string concatenation,
545 # which is not efficient as the number or size of chunks gets big.
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000546 while True:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000547 if chunk_left is None:
548 line = self.fp.readline()
549 i = line.find(';')
550 if i >= 0:
551 line = line[:i] # strip chunk-extensions
Georg Brandl23635032008-02-24 00:03:22 +0000552 try:
553 chunk_left = int(line, 16)
554 except ValueError:
555 # close the connection as protocol synchronisation is
556 # probably lost
557 self.close()
558 raise IncompleteRead(value)
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000559 if chunk_left == 0:
560 break
561 if amt is None:
562 value += self._safe_read(chunk_left)
563 elif amt < chunk_left:
564 value += self._safe_read(amt)
565 self.chunk_left = chunk_left - amt
566 return value
567 elif amt == chunk_left:
568 value += self._safe_read(amt)
569 self._safe_read(2) # toss the CRLF at the end of the chunk
570 self.chunk_left = None
571 return value
572 else:
573 value += self._safe_read(chunk_left)
574 amt -= chunk_left
575
576 # we read the whole chunk, get another
577 self._safe_read(2) # toss the CRLF at the end of the chunk
578 chunk_left = None
579
580 # read and discard trailer up to the CRLF terminator
581 ### note: we shouldn't have any trailers!
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000582 while True:
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000583 line = self.fp.readline()
Martin v. Löwisdad88dc2008-02-12 18:47:34 +0000584 if not line:
585 # a vanishingly small number of sites EOF without
586 # sending the trailer
587 break
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000588 if line == '\r\n':
589 break
590
591 # we read everything; close the "file"
Jeremy Hyltond4c472c2002-09-03 20:49:06 +0000592 self.close()
593
594 return value
Tim Peters230a60c2002-11-09 05:08:07 +0000595
Greg Steindd6eefb2000-07-18 09:09:48 +0000596 def _safe_read(self, amt):
597 """Read the number of bytes requested, compensating for partial reads.
598
599 Normally, we have a blocking socket, but a read() can be interrupted
600 by a signal (resulting in a partial read).
601
602 Note that we cannot distinguish between EOF and an interrupt when zero
603 bytes have been read. IncompleteRead() will be raised in this
604 situation.
605
606 This function should be used when <amt> bytes "should" be present for
607 reading. If the bytes are truly not available (due to EOF), then the
608 IncompleteRead exception can be used to detect the problem.
609 """
Georg Brandl80ba8e82005-09-29 20:16:07 +0000610 s = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000611 while amt > 0:
Georg Brandl80ba8e82005-09-29 20:16:07 +0000612 chunk = self.fp.read(min(amt, MAXAMOUNT))
Greg Steindd6eefb2000-07-18 09:09:48 +0000613 if not chunk:
614 raise IncompleteRead(s)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000615 s.append(chunk)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000616 amt -= len(chunk)
Georg Brandl80ba8e82005-09-29 20:16:07 +0000617 return ''.join(s)
Greg Steindd6eefb2000-07-18 09:09:48 +0000618
619 def getheader(self, name, default=None):
620 if self.msg is None:
621 raise ResponseNotReady()
622 return self.msg.getheader(name, default)
Greg Stein5e0fa402000-06-26 08:28:01 +0000623
Martin v. Löwisdeacce22004-08-18 12:46:26 +0000624 def getheaders(self):
625 """Return list of (header, value) tuples."""
626 if self.msg is None:
627 raise ResponseNotReady()
628 return self.msg.items()
629
Greg Stein5e0fa402000-06-26 08:28:01 +0000630
631class HTTPConnection:
632
Greg Steindd6eefb2000-07-18 09:09:48 +0000633 _http_vsn = 11
634 _http_vsn_str = 'HTTP/1.1'
Greg Stein5e0fa402000-06-26 08:28:01 +0000635
Greg Steindd6eefb2000-07-18 09:09:48 +0000636 response_class = HTTPResponse
637 default_port = HTTP_PORT
638 auto_open = 1
Jeremy Hylton30f86742000-09-18 22:50:38 +0000639 debuglevel = 0
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000640 strict = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000641
Facundo Batista07c78be2007-03-23 18:54:07 +0000642 def __init__(self, host, port=None, strict=None, timeout=None):
643 self.timeout = timeout
Greg Steindd6eefb2000-07-18 09:09:48 +0000644 self.sock = None
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000645 self._buffer = []
Greg Steindd6eefb2000-07-18 09:09:48 +0000646 self.__response = None
647 self.__state = _CS_IDLE
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000648 self._method = None
Tim Petersc411dba2002-07-16 21:35:23 +0000649
Greg Steindd6eefb2000-07-18 09:09:48 +0000650 self._set_hostport(host, port)
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000651 if strict is not None:
652 self.strict = strict
Greg Stein5e0fa402000-06-26 08:28:01 +0000653
Greg Steindd6eefb2000-07-18 09:09:48 +0000654 def _set_hostport(self, host, port):
655 if port is None:
Skip Montanaro10e6e0e2004-09-14 16:32:02 +0000656 i = host.rfind(':')
Skip Montanarocae14d22004-09-14 17:55:21 +0000657 j = host.rfind(']') # ipv6 addresses have [...]
658 if i > j:
Skip Montanaro9d389972002-03-24 16:53:50 +0000659 try:
660 port = int(host[i+1:])
661 except ValueError:
Jeremy Hyltonfbd79942002-07-02 20:19:08 +0000662 raise InvalidURL("nonnumeric port: '%s'" % host[i+1:])
Greg Steindd6eefb2000-07-18 09:09:48 +0000663 host = host[:i]
664 else:
665 port = self.default_port
Raymond Hettinger4d037912004-10-14 15:23:38 +0000666 if host and host[0] == '[' and host[-1] == ']':
Brett Cannon0a1af4a2004-09-15 23:26:23 +0000667 host = host[1:-1]
Greg Steindd6eefb2000-07-18 09:09:48 +0000668 self.host = host
669 self.port = port
Greg Stein5e0fa402000-06-26 08:28:01 +0000670
Jeremy Hylton30f86742000-09-18 22:50:38 +0000671 def set_debuglevel(self, level):
672 self.debuglevel = level
673
Greg Steindd6eefb2000-07-18 09:09:48 +0000674 def connect(self):
675 """Connect to the host and port specified in __init__."""
Georg Brandlf03facf2007-03-26 20:28:28 +0000676 self.sock = socket.create_connection((self.host,self.port),
677 self.timeout)
Greg Stein5e0fa402000-06-26 08:28:01 +0000678
Greg Steindd6eefb2000-07-18 09:09:48 +0000679 def close(self):
680 """Close the connection to the HTTP server."""
681 if self.sock:
Tim Peters07e99cb2001-01-14 23:47:14 +0000682 self.sock.close() # close it manually... there may be other refs
Greg Steindd6eefb2000-07-18 09:09:48 +0000683 self.sock = None
684 if self.__response:
685 self.__response.close()
686 self.__response = None
687 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000688
Greg Steindd6eefb2000-07-18 09:09:48 +0000689 def send(self, str):
690 """Send `str' to the server."""
691 if self.sock is None:
692 if self.auto_open:
693 self.connect()
694 else:
695 raise NotConnected()
Greg Stein5e0fa402000-06-26 08:28:01 +0000696
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000697 # send the data to the server. if we get a broken pipe, then close
Greg Steindd6eefb2000-07-18 09:09:48 +0000698 # the socket. we want to reconnect when somebody tries to send again.
699 #
700 # NOTE: we DO propagate the error, though, because we cannot simply
701 # ignore the error... the caller will know if they can retry.
Jeremy Hylton30f86742000-09-18 22:50:38 +0000702 if self.debuglevel > 0:
703 print "send:", repr(str)
Greg Steindd6eefb2000-07-18 09:09:48 +0000704 try:
Martin v. Löwis040a9272006-11-12 10:32:47 +0000705 blocksize=8192
706 if hasattr(str,'read') :
707 if self.debuglevel > 0: print "sendIng a read()able"
708 data=str.read(blocksize)
709 while data:
710 self.sock.sendall(data)
711 data=str.read(blocksize)
712 else:
713 self.sock.sendall(str)
Greg Steindd6eefb2000-07-18 09:09:48 +0000714 except socket.error, v:
Tim Peters07e99cb2001-01-14 23:47:14 +0000715 if v[0] == 32: # Broken pipe
Greg Steindd6eefb2000-07-18 09:09:48 +0000716 self.close()
717 raise
Greg Stein5e0fa402000-06-26 08:28:01 +0000718
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000719 def _output(self, s):
720 """Add a line of output to the current request buffer.
Tim Peters469cdad2002-08-08 20:19:19 +0000721
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000722 Assumes that the line does *not* end with \\r\\n.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000723 """
724 self._buffer.append(s)
725
726 def _send_output(self):
727 """Send the currently buffered request and clear the buffer.
728
Jeremy Hyltone3252ec2002-07-16 21:41:43 +0000729 Appends an extra \\r\\n to the buffer.
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000730 """
731 self._buffer.extend(("", ""))
732 msg = "\r\n".join(self._buffer)
733 del self._buffer[:]
734 self.send(msg)
735
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000736 def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0):
Greg Steindd6eefb2000-07-18 09:09:48 +0000737 """Send a request to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000738
Greg Steindd6eefb2000-07-18 09:09:48 +0000739 `method' specifies an HTTP request method, e.g. 'GET'.
740 `url' specifies the object being requested, e.g. '/index.html'.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000741 `skip_host' if True does not add automatically a 'Host:' header
742 `skip_accept_encoding' if True does not add automatically an
743 'Accept-Encoding:' header
Greg Steindd6eefb2000-07-18 09:09:48 +0000744 """
Greg Stein5e0fa402000-06-26 08:28:01 +0000745
Greg Stein616a58d2003-06-24 06:35:19 +0000746 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000747 if self.__response and self.__response.isclosed():
748 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000749
Tim Peters58eb11c2004-01-18 20:29:55 +0000750
Greg Steindd6eefb2000-07-18 09:09:48 +0000751 # in certain cases, we cannot issue another request on this connection.
752 # this occurs when:
753 # 1) we are in the process of sending a request. (_CS_REQ_STARTED)
754 # 2) a response to a previous request has signalled that it is going
755 # to close the connection upon completion.
756 # 3) the headers for the previous response have not been read, thus
757 # we cannot determine whether point (2) is true. (_CS_REQ_SENT)
758 #
759 # if there is no prior response, then we can request at will.
760 #
761 # if point (2) is true, then we will have passed the socket to the
762 # response (effectively meaning, "there is no prior response"), and
763 # will open a new one when a new request is made.
764 #
765 # Note: if a prior response exists, then we *can* start a new request.
766 # We are not allowed to begin fetching the response to this new
767 # request, however, until that prior response is complete.
768 #
769 if self.__state == _CS_IDLE:
770 self.__state = _CS_REQ_STARTED
771 else:
772 raise CannotSendRequest()
Greg Stein5e0fa402000-06-26 08:28:01 +0000773
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000774 # Save the method we use, we need it later in the response phase
775 self._method = method
Greg Steindd6eefb2000-07-18 09:09:48 +0000776 if not url:
777 url = '/'
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000778 str = '%s %s %s' % (method, url, self._http_vsn_str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000779
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000780 self._output(str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000781
Greg Steindd6eefb2000-07-18 09:09:48 +0000782 if self._http_vsn == 11:
783 # Issue some standard headers for better HTTP/1.1 compliance
Greg Stein5e0fa402000-06-26 08:28:01 +0000784
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000785 if not skip_host:
786 # this header is issued *only* for HTTP/1.1
787 # connections. more specifically, this means it is
788 # only issued when the client uses the new
789 # HTTPConnection() class. backwards-compat clients
790 # will be using HTTP/1.0 and those clients may be
791 # issuing this header themselves. we should NOT issue
792 # it twice; some web servers (such as Apache) barf
793 # when they see two Host: headers
Guido van Rossumf6922aa2001-01-14 21:03:01 +0000794
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000795 # If we need a non-standard port,include it in the
796 # header. If the request is going through a proxy,
797 # but the host of the actual URL, not the host of the
798 # proxy.
Jeremy Hylton8acf1e02002-03-08 19:35:51 +0000799
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000800 netloc = ''
801 if url.startswith('http'):
802 nil, netloc, nil, nil, nil = urlsplit(url)
803
804 if netloc:
Georg Brandla2ac2ef2006-05-03 18:03:22 +0000805 try:
806 netloc_enc = netloc.encode("ascii")
807 except UnicodeEncodeError:
808 netloc_enc = netloc.encode("idna")
809 self.putheader('Host', netloc_enc)
Jeremy Hylton3921ff62002-03-09 06:07:23 +0000810 else:
Georg Brandla2ac2ef2006-05-03 18:03:22 +0000811 try:
812 host_enc = self.host.encode("ascii")
813 except UnicodeEncodeError:
814 host_enc = self.host.encode("idna")
815 if self.port == HTTP_PORT:
816 self.putheader('Host', host_enc)
817 else:
818 self.putheader('Host', "%s:%s" % (host_enc, self.port))
Greg Stein5e0fa402000-06-26 08:28:01 +0000819
Greg Steindd6eefb2000-07-18 09:09:48 +0000820 # note: we are assuming that clients will not attempt to set these
821 # headers since *this* library must deal with the
822 # consequences. this also means that when the supporting
823 # libraries are updated to recognize other forms, then this
824 # code should be changed (removed or updated).
Greg Stein5e0fa402000-06-26 08:28:01 +0000825
Greg Steindd6eefb2000-07-18 09:09:48 +0000826 # we only want a Content-Encoding of "identity" since we don't
827 # support encodings such as x-gzip or x-deflate.
Martin v. Löwisaf7dc8d2003-11-19 19:51:55 +0000828 if not skip_accept_encoding:
829 self.putheader('Accept-Encoding', 'identity')
Greg Stein5e0fa402000-06-26 08:28:01 +0000830
Greg Steindd6eefb2000-07-18 09:09:48 +0000831 # we can accept "chunked" Transfer-Encodings, but no others
832 # NOTE: no TE header implies *only* "chunked"
833 #self.putheader('TE', 'chunked')
Greg Stein5e0fa402000-06-26 08:28:01 +0000834
Greg Steindd6eefb2000-07-18 09:09:48 +0000835 # if TE is supplied in the header, then it must appear in a
836 # Connection header.
837 #self.putheader('Connection', 'TE')
Greg Stein5e0fa402000-06-26 08:28:01 +0000838
Greg Steindd6eefb2000-07-18 09:09:48 +0000839 else:
840 # For HTTP/1.0, the server will assume "not chunked"
841 pass
Greg Stein5e0fa402000-06-26 08:28:01 +0000842
Greg Steindd6eefb2000-07-18 09:09:48 +0000843 def putheader(self, header, value):
844 """Send a request header line to the server.
Greg Stein5e0fa402000-06-26 08:28:01 +0000845
Greg Steindd6eefb2000-07-18 09:09:48 +0000846 For example: h.putheader('Accept', 'text/html')
847 """
848 if self.__state != _CS_REQ_STARTED:
849 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +0000850
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000851 str = '%s: %s' % (header, value)
852 self._output(str)
Greg Stein5e0fa402000-06-26 08:28:01 +0000853
Greg Steindd6eefb2000-07-18 09:09:48 +0000854 def endheaders(self):
855 """Indicate that the last header line has been sent to the server."""
Greg Stein5e0fa402000-06-26 08:28:01 +0000856
Greg Steindd6eefb2000-07-18 09:09:48 +0000857 if self.__state == _CS_REQ_STARTED:
858 self.__state = _CS_REQ_SENT
859 else:
860 raise CannotSendHeader()
Greg Stein5e0fa402000-06-26 08:28:01 +0000861
Jeremy Hylton8531b1b2002-07-16 21:21:11 +0000862 self._send_output()
Greg Stein5e0fa402000-06-26 08:28:01 +0000863
Greg Steindd6eefb2000-07-18 09:09:48 +0000864 def request(self, method, url, body=None, headers={}):
865 """Send a complete request to the server."""
Greg Stein5e0fa402000-06-26 08:28:01 +0000866
Greg Steindd6eefb2000-07-18 09:09:48 +0000867 try:
868 self._send_request(method, url, body, headers)
869 except socket.error, v:
870 # trap 'Broken pipe' if we're allowed to automatically reconnect
871 if v[0] != 32 or not self.auto_open:
872 raise
873 # try one more time
874 self._send_request(method, url, body, headers)
Greg Stein5e0fa402000-06-26 08:28:01 +0000875
Greg Steindd6eefb2000-07-18 09:09:48 +0000876 def _send_request(self, method, url, body, headers):
Jeremy Hylton2c178252004-08-07 16:28:14 +0000877 # honour explicitly requested Host: and Accept-Encoding headers
878 header_names = dict.fromkeys([k.lower() for k in headers])
879 skips = {}
880 if 'host' in header_names:
881 skips['skip_host'] = 1
882 if 'accept-encoding' in header_names:
883 skips['skip_accept_encoding'] = 1
Greg Stein5e0fa402000-06-26 08:28:01 +0000884
Jeremy Hylton2c178252004-08-07 16:28:14 +0000885 self.putrequest(method, url, **skips)
886
887 if body and ('content-length' not in header_names):
Martin v. Löwis040a9272006-11-12 10:32:47 +0000888 thelen=None
889 try:
890 thelen=str(len(body))
891 except TypeError, te:
892 # If this is a file-like object, try to
893 # fstat its file descriptor
894 import os
895 try:
896 thelen = str(os.fstat(body.fileno()).st_size)
897 except (AttributeError, OSError):
898 # Don't send a length if this failed
899 if self.debuglevel > 0: print "Cannot stat!!"
Tim Petersf733abb2007-01-30 03:03:46 +0000900
Martin v. Löwis040a9272006-11-12 10:32:47 +0000901 if thelen is not None:
902 self.putheader('Content-Length',thelen)
Raymond Hettingerb2e0b922003-02-26 22:45:18 +0000903 for hdr, value in headers.iteritems():
Greg Steindd6eefb2000-07-18 09:09:48 +0000904 self.putheader(hdr, value)
905 self.endheaders()
Greg Stein5e0fa402000-06-26 08:28:01 +0000906
Greg Steindd6eefb2000-07-18 09:09:48 +0000907 if body:
908 self.send(body)
Greg Stein5e0fa402000-06-26 08:28:01 +0000909
Greg Steindd6eefb2000-07-18 09:09:48 +0000910 def getresponse(self):
911 "Get the response from the server."
Greg Stein5e0fa402000-06-26 08:28:01 +0000912
Greg Stein616a58d2003-06-24 06:35:19 +0000913 # if a prior response has been completed, then forget about it.
Greg Steindd6eefb2000-07-18 09:09:48 +0000914 if self.__response and self.__response.isclosed():
915 self.__response = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000916
Greg Steindd6eefb2000-07-18 09:09:48 +0000917 #
918 # if a prior response exists, then it must be completed (otherwise, we
919 # cannot read this response's header to determine the connection-close
920 # behavior)
921 #
922 # note: if a prior response existed, but was connection-close, then the
923 # socket and response were made independent of this HTTPConnection
924 # object since a new request requires that we open a whole new
925 # connection
926 #
927 # this means the prior response had one of two states:
928 # 1) will_close: this connection was reset and the prior socket and
929 # response operate independently
930 # 2) persistent: the response was retained and we await its
931 # isclosed() status to become true.
932 #
933 if self.__state != _CS_REQ_SENT or self.__response:
934 raise ResponseNotReady()
Greg Stein5e0fa402000-06-26 08:28:01 +0000935
Jeremy Hylton30f86742000-09-18 22:50:38 +0000936 if self.debuglevel > 0:
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000937 response = self.response_class(self.sock, self.debuglevel,
Tim Petersc2659cf2003-05-12 20:19:37 +0000938 strict=self.strict,
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000939 method=self._method)
Jeremy Hylton30f86742000-09-18 22:50:38 +0000940 else:
Jeremy Hyltonc1b2cb92003-05-05 16:13:58 +0000941 response = self.response_class(self.sock, strict=self.strict,
942 method=self._method)
Greg Stein5e0fa402000-06-26 08:28:01 +0000943
Jeremy Hylton39c03802002-07-12 14:04:09 +0000944 response.begin()
Jeremy Hyltonbe4fcf12002-06-28 22:38:01 +0000945 assert response.will_close != _UNKNOWN
Greg Steindd6eefb2000-07-18 09:09:48 +0000946 self.__state = _CS_IDLE
Greg Stein5e0fa402000-06-26 08:28:01 +0000947
Greg Steindd6eefb2000-07-18 09:09:48 +0000948 if response.will_close:
Martin v. Löwis0af33882007-03-23 13:27:15 +0000949 # this effectively passes the connection to the response
950 self.close()
Greg Steindd6eefb2000-07-18 09:09:48 +0000951 else:
952 # remember this, so we can tell when it is complete
953 self.__response = response
Greg Stein5e0fa402000-06-26 08:28:01 +0000954
Greg Steindd6eefb2000-07-18 09:09:48 +0000955 return response
Greg Stein5e0fa402000-06-26 08:28:01 +0000956
Greg Stein5e0fa402000-06-26 08:28:01 +0000957
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +0000958class HTTP:
Greg Steindd6eefb2000-07-18 09:09:48 +0000959 "Compatibility class with httplib.py from 1.5."
Greg Stein5e0fa402000-06-26 08:28:01 +0000960
Greg Steindd6eefb2000-07-18 09:09:48 +0000961 _http_vsn = 10
962 _http_vsn_str = 'HTTP/1.0'
Greg Stein5e0fa402000-06-26 08:28:01 +0000963
Greg Steindd6eefb2000-07-18 09:09:48 +0000964 debuglevel = 0
Greg Stein5e0fa402000-06-26 08:28:01 +0000965
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +0000966 _connection_class = HTTPConnection
967
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000968 def __init__(self, host='', port=None, strict=None):
Greg Steindd6eefb2000-07-18 09:09:48 +0000969 "Provide a default host, since the superclass requires one."
Greg Stein5e0fa402000-06-26 08:28:01 +0000970
Greg Steindd6eefb2000-07-18 09:09:48 +0000971 # some joker passed 0 explicitly, meaning default port
972 if port == 0:
973 port = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000974
Greg Steindd6eefb2000-07-18 09:09:48 +0000975 # Note that we may pass an empty string as the host; this will throw
976 # an error when we attempt to connect. Presumably, the client code
977 # will call connect before then, with a proper host.
Jeremy Hyltond46aa372002-07-06 18:48:07 +0000978 self._setup(self._connection_class(host, port, strict))
Greg Stein5e0fa402000-06-26 08:28:01 +0000979
Greg Stein81937a42001-08-18 09:20:23 +0000980 def _setup(self, conn):
981 self._conn = conn
982
983 # set up delegation to flesh out interface
984 self.send = conn.send
985 self.putrequest = conn.putrequest
986 self.endheaders = conn.endheaders
987 self.set_debuglevel = conn.set_debuglevel
988
989 conn._http_vsn = self._http_vsn
990 conn._http_vsn_str = self._http_vsn_str
Greg Stein5e0fa402000-06-26 08:28:01 +0000991
Greg Steindd6eefb2000-07-18 09:09:48 +0000992 self.file = None
Greg Stein5e0fa402000-06-26 08:28:01 +0000993
Greg Steindd6eefb2000-07-18 09:09:48 +0000994 def connect(self, host=None, port=None):
995 "Accept arguments to set the host/port, since the superclass doesn't."
Greg Stein5e0fa402000-06-26 08:28:01 +0000996
Greg Steindd6eefb2000-07-18 09:09:48 +0000997 if host is not None:
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +0000998 self._conn._set_hostport(host, port)
999 self._conn.connect()
Greg Stein5e0fa402000-06-26 08:28:01 +00001000
Greg Steindd6eefb2000-07-18 09:09:48 +00001001 def getfile(self):
1002 "Provide a getfile, since the superclass' does not use this concept."
1003 return self.file
Greg Stein5e0fa402000-06-26 08:28:01 +00001004
Greg Steindd6eefb2000-07-18 09:09:48 +00001005 def putheader(self, header, *values):
1006 "The superclass allows only one value argument."
Guido van Rossum34735a62000-12-15 15:09:42 +00001007 self._conn.putheader(header, '\r\n\t'.join(values))
Greg Stein5e0fa402000-06-26 08:28:01 +00001008
Greg Steindd6eefb2000-07-18 09:09:48 +00001009 def getreply(self):
1010 """Compat definition since superclass does not define it.
Greg Stein5e0fa402000-06-26 08:28:01 +00001011
Greg Steindd6eefb2000-07-18 09:09:48 +00001012 Returns a tuple consisting of:
1013 - server status code (e.g. '200' if all goes well)
1014 - server "reason" corresponding to status code
1015 - any RFC822 headers in the response from the server
1016 """
1017 try:
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +00001018 response = self._conn.getresponse()
Greg Steindd6eefb2000-07-18 09:09:48 +00001019 except BadStatusLine, e:
1020 ### hmm. if getresponse() ever closes the socket on a bad request,
1021 ### then we are going to have problems with self.sock
Greg Stein5e0fa402000-06-26 08:28:01 +00001022
Greg Steindd6eefb2000-07-18 09:09:48 +00001023 ### should we keep this behavior? do people use it?
1024 # keep the socket open (as a file), and return it
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +00001025 self.file = self._conn.sock.makefile('rb', 0)
Greg Stein5e0fa402000-06-26 08:28:01 +00001026
Greg Steindd6eefb2000-07-18 09:09:48 +00001027 # close our socket -- we want to restart after any protocol error
1028 self.close()
Greg Stein5e0fa402000-06-26 08:28:01 +00001029
Greg Steindd6eefb2000-07-18 09:09:48 +00001030 self.headers = None
1031 return -1, e.line, None
Greg Stein5e0fa402000-06-26 08:28:01 +00001032
Greg Steindd6eefb2000-07-18 09:09:48 +00001033 self.headers = response.msg
1034 self.file = response.fp
1035 return response.status, response.reason, response.msg
Greg Stein5e0fa402000-06-26 08:28:01 +00001036
Greg Steindd6eefb2000-07-18 09:09:48 +00001037 def close(self):
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +00001038 self._conn.close()
Greg Stein5e0fa402000-06-26 08:28:01 +00001039
Greg Steindd6eefb2000-07-18 09:09:48 +00001040 # note that self.file == response.fp, which gets closed by the
1041 # superclass. just clear the object ref here.
1042 ### hmm. messy. if status==-1, then self.file is owned by us.
1043 ### well... we aren't explicitly closing, but losing this ref will
1044 ### do it
1045 self.file = None
Greg Stein5e0fa402000-06-26 08:28:01 +00001046
Bill Janssen426ea0a2007-08-29 22:35:05 +00001047try:
1048 import ssl
1049except ImportError:
1050 pass
1051else:
1052 class HTTPSConnection(HTTPConnection):
1053 "This class allows communication via SSL."
1054
1055 default_port = HTTPS_PORT
1056
1057 def __init__(self, host, port=None, key_file=None, cert_file=None,
1058 strict=None, timeout=None):
1059 HTTPConnection.__init__(self, host, port, strict, timeout)
1060 self.key_file = key_file
1061 self.cert_file = cert_file
1062
1063 def connect(self):
1064 "Connect to a host on a given (SSL) port."
1065
1066 sock = socket.create_connection((self.host, self.port), self.timeout)
Bill Janssen98d19da2007-09-10 21:51:02 +00001067 self.sock = ssl.wrap_socket(sock, self.key_file, self.cert_file)
Bill Janssen426ea0a2007-08-29 22:35:05 +00001068
Thomas Woutersa6900e82007-08-30 21:54:39 +00001069 __all__.append("HTTPSConnection")
Bill Janssen426ea0a2007-08-29 22:35:05 +00001070
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +00001071 class HTTPS(HTTP):
1072 """Compatibility with 1.5 httplib interface
1073
1074 Python 1.5.2 did not have an HTTPS class, but it defined an
1075 interface for sending http requests that is also useful for
Tim Peters5ceadc82001-01-13 19:16:21 +00001076 https.
Jeremy Hylton29b8d5a2000-08-01 17:33:32 +00001077 """
1078
Martin v. Löwisd7bf9742000-09-21 22:09:47 +00001079 _connection_class = HTTPSConnection
Tim Peters5ceadc82001-01-13 19:16:21 +00001080
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001081 def __init__(self, host='', port=None, key_file=None, cert_file=None,
1082 strict=None):
Greg Stein81937a42001-08-18 09:20:23 +00001083 # provide a default host, pass the X509 cert info
1084
1085 # urf. compensate for bad input.
1086 if port == 0:
1087 port = None
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001088 self._setup(self._connection_class(host, port, key_file,
1089 cert_file, strict))
Greg Stein81937a42001-08-18 09:20:23 +00001090
1091 # we never actually use these for anything, but we keep them
1092 # here for compatibility with post-1.5.2 CVS.
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001093 self.key_file = key_file
1094 self.cert_file = cert_file
Greg Stein81937a42001-08-18 09:20:23 +00001095
Greg Stein5e0fa402000-06-26 08:28:01 +00001096
Bill Janssen426ea0a2007-08-29 22:35:05 +00001097 def FakeSocket (sock, sslobj):
Bill Janssenc4592642007-08-31 19:02:23 +00001098 warnings.warn("FakeSocket is deprecated, and won't be in 3.x. " +
Bill Janssen98d19da2007-09-10 21:51:02 +00001099 "Use the result of ssl.wrap_socket() directly instead.",
Bill Janssenc4592642007-08-31 19:02:23 +00001100 DeprecationWarning, stacklevel=2)
Bill Janssen426ea0a2007-08-29 22:35:05 +00001101 return sslobj
1102
1103
Greg Stein5e0fa402000-06-26 08:28:01 +00001104class HTTPException(Exception):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001105 # Subclasses that define an __init__ must call Exception.__init__
1106 # or define self.args. Otherwise, str() will fail.
Greg Steindd6eefb2000-07-18 09:09:48 +00001107 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001108
1109class NotConnected(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001110 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001111
Skip Montanaro9d389972002-03-24 16:53:50 +00001112class InvalidURL(HTTPException):
1113 pass
1114
Greg Stein5e0fa402000-06-26 08:28:01 +00001115class UnknownProtocol(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001116 def __init__(self, version):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001117 self.args = version,
Greg Steindd6eefb2000-07-18 09:09:48 +00001118 self.version = version
Greg Stein5e0fa402000-06-26 08:28:01 +00001119
1120class UnknownTransferEncoding(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001121 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001122
Greg Stein5e0fa402000-06-26 08:28:01 +00001123class UnimplementedFileMode(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001124 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001125
1126class IncompleteRead(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001127 def __init__(self, partial):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001128 self.args = partial,
Greg Steindd6eefb2000-07-18 09:09:48 +00001129 self.partial = partial
Greg Stein5e0fa402000-06-26 08:28:01 +00001130
1131class ImproperConnectionState(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001132 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001133
1134class CannotSendRequest(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001135 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001136
1137class CannotSendHeader(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001138 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001139
1140class ResponseNotReady(ImproperConnectionState):
Greg Steindd6eefb2000-07-18 09:09:48 +00001141 pass
Greg Stein5e0fa402000-06-26 08:28:01 +00001142
1143class BadStatusLine(HTTPException):
Greg Steindd6eefb2000-07-18 09:09:48 +00001144 def __init__(self, line):
Jeremy Hylton12f4f352002-07-06 18:55:01 +00001145 self.args = line,
Greg Steindd6eefb2000-07-18 09:09:48 +00001146 self.line = line
Greg Stein5e0fa402000-06-26 08:28:01 +00001147
1148# for backwards compatibility
1149error = HTTPException
1150
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001151class LineAndFileWrapper:
1152 """A limited file-like object for HTTP/0.9 responses."""
1153
1154 # The status-line parsing code calls readline(), which normally
1155 # get the HTTP status line. For a 0.9 response, however, this is
1156 # actually the first line of the body! Clients need to get a
1157 # readable file object that contains that line.
1158
1159 def __init__(self, line, file):
1160 self._line = line
1161 self._file = file
1162 self._line_consumed = 0
1163 self._line_offset = 0
1164 self._line_left = len(line)
1165
1166 def __getattr__(self, attr):
1167 return getattr(self._file, attr)
1168
1169 def _done(self):
1170 # called when the last byte is read from the line. After the
1171 # call, all read methods are delegated to the underlying file
Skip Montanaro74b9a7a2003-02-25 17:48:15 +00001172 # object.
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001173 self._line_consumed = 1
1174 self.read = self._file.read
1175 self.readline = self._file.readline
1176 self.readlines = self._file.readlines
1177
1178 def read(self, amt=None):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001179 if self._line_consumed:
1180 return self._file.read(amt)
1181 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001182 if amt is None or amt > self._line_left:
1183 s = self._line[self._line_offset:]
1184 self._done()
1185 if amt is None:
1186 return s + self._file.read()
1187 else:
Tim Petersc411dba2002-07-16 21:35:23 +00001188 return s + self._file.read(amt - len(s))
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001189 else:
1190 assert amt <= self._line_left
1191 i = self._line_offset
1192 j = i + amt
1193 s = self._line[i:j]
1194 self._line_offset = j
1195 self._line_left -= amt
1196 if self._line_left == 0:
1197 self._done()
1198 return s
Tim Petersc411dba2002-07-16 21:35:23 +00001199
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001200 def readline(self):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001201 if self._line_consumed:
1202 return self._file.readline()
1203 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001204 s = self._line[self._line_offset:]
1205 self._done()
1206 return s
1207
1208 def readlines(self, size=None):
Hye-Shik Chang39aef792004-06-05 13:30:56 +00001209 if self._line_consumed:
1210 return self._file.readlines(size)
1211 assert self._line_left
Jeremy Hyltond46aa372002-07-06 18:48:07 +00001212 L = [self._line[self._line_offset:]]
1213 self._done()
1214 if size is None:
1215 return L + self._file.readlines()
1216 else:
1217 return L + self._file.readlines(size)
Greg Stein5e0fa402000-06-26 08:28:01 +00001218
Guido van Rossum23acc951994-02-21 16:36:04 +00001219def test():
Guido van Rossum41999c11997-12-09 00:12:23 +00001220 """Test this module.
1221
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001222 A hodge podge of tests collected here, because they have too many
1223 external dependencies for the regular test suite.
Guido van Rossum41999c11997-12-09 00:12:23 +00001224 """
Greg Stein5e0fa402000-06-26 08:28:01 +00001225
Guido van Rossum41999c11997-12-09 00:12:23 +00001226 import sys
1227 import getopt
1228 opts, args = getopt.getopt(sys.argv[1:], 'd')
1229 dl = 0
1230 for o, a in opts:
1231 if o == '-d': dl = dl + 1
1232 host = 'www.python.org'
1233 selector = '/'
1234 if args[0:]: host = args[0]
1235 if args[1:]: selector = args[1]
1236 h = HTTP()
1237 h.set_debuglevel(dl)
1238 h.connect(host)
1239 h.putrequest('GET', selector)
1240 h.endheaders()
Greg Stein5e0fa402000-06-26 08:28:01 +00001241 status, reason, headers = h.getreply()
1242 print 'status =', status
1243 print 'reason =', reason
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001244 print "read", len(h.getfile().read())
Guido van Rossum41999c11997-12-09 00:12:23 +00001245 print
1246 if headers:
Guido van Rossum34735a62000-12-15 15:09:42 +00001247 for header in headers.headers: print header.strip()
Guido van Rossum41999c11997-12-09 00:12:23 +00001248 print
Greg Stein5e0fa402000-06-26 08:28:01 +00001249
Jeremy Hylton8acf1e02002-03-08 19:35:51 +00001250 # minimal test that code to extract host from url works
1251 class HTTP11(HTTP):
1252 _http_vsn = 11
1253 _http_vsn_str = 'HTTP/1.1'
1254
1255 h = HTTP11('www.python.org')
1256 h.putrequest('GET', 'http://www.python.org/~jeremy/')
1257 h.endheaders()
1258 h.getreply()
1259 h.close()
1260
Bill Janssen426ea0a2007-08-29 22:35:05 +00001261 try:
1262 import ssl
1263 except ImportError:
1264 pass
1265 else:
Tim Petersc411dba2002-07-16 21:35:23 +00001266
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001267 for host, selector in (('sourceforge.net', '/projects/python'),
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001268 ):
1269 print "https://%s%s" % (host, selector)
1270 hs = HTTPS()
Jeremy Hylton8531b1b2002-07-16 21:21:11 +00001271 hs.set_debuglevel(dl)
Jeremy Hylton29d27ac2002-07-09 21:22:36 +00001272 hs.connect(host)
1273 hs.putrequest('GET', selector)
1274 hs.endheaders()
1275 status, reason, headers = hs.getreply()
1276 print 'status =', status
1277 print 'reason =', reason
1278 print "read", len(hs.getfile().read())
1279 print
1280 if headers:
1281 for header in headers.headers: print header.strip()
1282 print
Guido van Rossum23acc951994-02-21 16:36:04 +00001283
Guido van Rossum23acc951994-02-21 16:36:04 +00001284if __name__ == '__main__':
Guido van Rossum41999c11997-12-09 00:12:23 +00001285 test()