Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1 | """HTTP/1.1 client library |
Guido van Rossum | 41999c1 | 1997-12-09 00:12:23 +0000 | [diff] [blame] | 2 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 3 | <intro stuff goes here> |
| 4 | <other stuff, too> |
Guido van Rossum | 41999c1 | 1997-12-09 00:12:23 +0000 | [diff] [blame] | 5 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 6 | HTTPConnection goes through a number of "states", which define when a client |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 7 | may legally make another request or fetch the response for a particular |
| 8 | request. This diagram details these state transitions: |
Guido van Rossum | 41999c1 | 1997-12-09 00:12:23 +0000 | [diff] [blame] | 9 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 10 | (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 Peters | 5ceadc8 | 2001-01-13 19:16:21 +0000 | [diff] [blame] | 28 | | | |
| 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 Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 41 | |
| 42 | This 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 | |
| 48 | Note: 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 | |
| 59 | Logical State __state __response |
| 60 | ------------- ------- ---------- |
| 61 | Idle _CS_IDLE None |
| 62 | Request-started _CS_REQ_STARTED None |
| 63 | Request-sent _CS_REQ_SENT None |
| 64 | Unread-response _CS_IDLE <response_class> |
| 65 | Req-started-unread-response _CS_REQ_STARTED <response_class> |
| 66 | Req-sent-unread-response _CS_REQ_SENT <response_class> |
Guido van Rossum | 41999c1 | 1997-12-09 00:12:23 +0000 | [diff] [blame] | 67 | """ |
Guido van Rossum | 23acc95 | 1994-02-21 16:36:04 +0000 | [diff] [blame] | 68 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 69 | import email.parser |
| 70 | import email.message |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 71 | import io |
| 72 | import os |
| 73 | import socket |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 74 | from urllib.parse import urlsplit |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 75 | import warnings |
Guido van Rossum | 23acc95 | 1994-02-21 16:36:04 +0000 | [diff] [blame] | 76 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 77 | __all__ = ["HTTPResponse", "HTTPConnection", |
Skip Montanaro | 951a884 | 2001-06-01 16:25:38 +0000 | [diff] [blame] | 78 | "HTTPException", "NotConnected", "UnknownProtocol", |
Jeremy Hylton | 7c75c99 | 2002-06-28 23:38:14 +0000 | [diff] [blame] | 79 | "UnknownTransferEncoding", "UnimplementedFileMode", |
| 80 | "IncompleteRead", "InvalidURL", "ImproperConnectionState", |
| 81 | "CannotSendRequest", "CannotSendHeader", "ResponseNotReady", |
Georg Brandl | 6aab16e | 2006-02-17 19:17:25 +0000 | [diff] [blame] | 82 | "BadStatusLine", "error", "responses"] |
Skip Montanaro | 2dd4276 | 2001-01-23 15:35:05 +0000 | [diff] [blame] | 83 | |
Guido van Rossum | 23acc95 | 1994-02-21 16:36:04 +0000 | [diff] [blame] | 84 | HTTP_PORT = 80 |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 85 | HTTPS_PORT = 443 |
| 86 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 87 | _UNKNOWN = 'UNKNOWN' |
| 88 | |
| 89 | # connection states |
| 90 | _CS_IDLE = 'Idle' |
| 91 | _CS_REQ_STARTED = 'Request-started' |
| 92 | _CS_REQ_SENT = 'Request-sent' |
| 93 | |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 94 | # status codes |
| 95 | # informational |
| 96 | CONTINUE = 100 |
| 97 | SWITCHING_PROTOCOLS = 101 |
| 98 | PROCESSING = 102 |
| 99 | |
| 100 | # successful |
| 101 | OK = 200 |
| 102 | CREATED = 201 |
| 103 | ACCEPTED = 202 |
| 104 | NON_AUTHORITATIVE_INFORMATION = 203 |
| 105 | NO_CONTENT = 204 |
| 106 | RESET_CONTENT = 205 |
| 107 | PARTIAL_CONTENT = 206 |
| 108 | MULTI_STATUS = 207 |
| 109 | IM_USED = 226 |
| 110 | |
| 111 | # redirection |
| 112 | MULTIPLE_CHOICES = 300 |
| 113 | MOVED_PERMANENTLY = 301 |
| 114 | FOUND = 302 |
| 115 | SEE_OTHER = 303 |
| 116 | NOT_MODIFIED = 304 |
| 117 | USE_PROXY = 305 |
| 118 | TEMPORARY_REDIRECT = 307 |
| 119 | |
| 120 | # client error |
| 121 | BAD_REQUEST = 400 |
| 122 | UNAUTHORIZED = 401 |
| 123 | PAYMENT_REQUIRED = 402 |
| 124 | FORBIDDEN = 403 |
| 125 | NOT_FOUND = 404 |
| 126 | METHOD_NOT_ALLOWED = 405 |
| 127 | NOT_ACCEPTABLE = 406 |
| 128 | PROXY_AUTHENTICATION_REQUIRED = 407 |
| 129 | REQUEST_TIMEOUT = 408 |
| 130 | CONFLICT = 409 |
| 131 | GONE = 410 |
| 132 | LENGTH_REQUIRED = 411 |
| 133 | PRECONDITION_FAILED = 412 |
| 134 | REQUEST_ENTITY_TOO_LARGE = 413 |
| 135 | REQUEST_URI_TOO_LONG = 414 |
| 136 | UNSUPPORTED_MEDIA_TYPE = 415 |
| 137 | REQUESTED_RANGE_NOT_SATISFIABLE = 416 |
| 138 | EXPECTATION_FAILED = 417 |
| 139 | UNPROCESSABLE_ENTITY = 422 |
| 140 | LOCKED = 423 |
| 141 | FAILED_DEPENDENCY = 424 |
| 142 | UPGRADE_REQUIRED = 426 |
| 143 | |
| 144 | # server error |
| 145 | INTERNAL_SERVER_ERROR = 500 |
| 146 | NOT_IMPLEMENTED = 501 |
| 147 | BAD_GATEWAY = 502 |
| 148 | SERVICE_UNAVAILABLE = 503 |
| 149 | GATEWAY_TIMEOUT = 504 |
| 150 | HTTP_VERSION_NOT_SUPPORTED = 505 |
| 151 | INSUFFICIENT_STORAGE = 507 |
| 152 | NOT_EXTENDED = 510 |
| 153 | |
Georg Brandl | 6aab16e | 2006-02-17 19:17:25 +0000 | [diff] [blame] | 154 | # Mapping status codes to official W3C names |
| 155 | responses = { |
| 156 | 100: 'Continue', |
| 157 | 101: 'Switching Protocols', |
| 158 | |
| 159 | 200: 'OK', |
| 160 | 201: 'Created', |
| 161 | 202: 'Accepted', |
| 162 | 203: 'Non-Authoritative Information', |
| 163 | 204: 'No Content', |
| 164 | 205: 'Reset Content', |
| 165 | 206: 'Partial Content', |
| 166 | |
| 167 | 300: 'Multiple Choices', |
| 168 | 301: 'Moved Permanently', |
| 169 | 302: 'Found', |
| 170 | 303: 'See Other', |
| 171 | 304: 'Not Modified', |
| 172 | 305: 'Use Proxy', |
| 173 | 306: '(Unused)', |
| 174 | 307: 'Temporary Redirect', |
| 175 | |
| 176 | 400: 'Bad Request', |
| 177 | 401: 'Unauthorized', |
| 178 | 402: 'Payment Required', |
| 179 | 403: 'Forbidden', |
| 180 | 404: 'Not Found', |
| 181 | 405: 'Method Not Allowed', |
| 182 | 406: 'Not Acceptable', |
| 183 | 407: 'Proxy Authentication Required', |
| 184 | 408: 'Request Timeout', |
| 185 | 409: 'Conflict', |
| 186 | 410: 'Gone', |
| 187 | 411: 'Length Required', |
| 188 | 412: 'Precondition Failed', |
| 189 | 413: 'Request Entity Too Large', |
| 190 | 414: 'Request-URI Too Long', |
| 191 | 415: 'Unsupported Media Type', |
| 192 | 416: 'Requested Range Not Satisfiable', |
| 193 | 417: 'Expectation Failed', |
| 194 | |
| 195 | 500: 'Internal Server Error', |
| 196 | 501: 'Not Implemented', |
| 197 | 502: 'Bad Gateway', |
| 198 | 503: 'Service Unavailable', |
| 199 | 504: 'Gateway Timeout', |
| 200 | 505: 'HTTP Version Not Supported', |
| 201 | } |
| 202 | |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 203 | # maximal amount of data to read at one time in _safe_read |
| 204 | MAXAMOUNT = 1048576 |
| 205 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 206 | class HTTPMessage(email.message.Message): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 207 | # XXX The only usage of this method is in |
| 208 | # http.server.CGIHTTPRequestHandler. Maybe move the code there so |
| 209 | # that it doesn't need to be part of the public API. The API has |
| 210 | # never been defined so this could cause backwards compatibility |
| 211 | # issues. |
| 212 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 213 | def getallmatchingheaders(self, name): |
| 214 | """Find all header lines matching a given header name. |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 215 | |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 216 | Look through the list of headers and find all lines matching a given |
| 217 | header name (and their continuation lines). A list of the lines is |
| 218 | returned, without interpretation. If the header does not occur, an |
| 219 | empty list is returned. If the header occurs multiple times, all |
| 220 | occurrences are returned. Case is not important in the header name. |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 221 | |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 222 | """ |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 223 | name = name.lower() + ':' |
| 224 | n = len(name) |
| 225 | lst = [] |
| 226 | hit = 0 |
| 227 | for line in self.keys(): |
| 228 | if line[:n].lower() == name: |
| 229 | hit = 1 |
| 230 | elif not line[:1].isspace(): |
| 231 | hit = 0 |
| 232 | if hit: |
| 233 | lst.append(line) |
| 234 | return lst |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 235 | |
Jeremy Hylton | 98eb6c2 | 2009-03-27 18:31:36 +0000 | [diff] [blame] | 236 | def parse_headers(fp, _class=HTTPMessage): |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 237 | """Parses only RFC2822 headers from a file pointer. |
| 238 | |
| 239 | email Parser wants to see strings rather than bytes. |
| 240 | But a TextIOWrapper around self.rfile would buffer too many bytes |
| 241 | from the stream, bytes which we later need to read as bytes. |
| 242 | So we read the correct bytes here, as bytes, for email Parser |
| 243 | to parse. |
| 244 | |
| 245 | """ |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 246 | headers = [] |
| 247 | while True: |
| 248 | line = fp.readline() |
| 249 | headers.append(line) |
| 250 | if line in (b'\r\n', b'\n', b''): |
| 251 | break |
| 252 | hstring = b''.join(headers).decode('iso-8859-1') |
Jeremy Hylton | 98eb6c2 | 2009-03-27 18:31:36 +0000 | [diff] [blame] | 253 | return email.parser.Parser(_class=_class).parsestr(hstring) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 254 | |
Antoine Pitrou | b353c12 | 2009-02-11 00:39:14 +0000 | [diff] [blame] | 255 | class HTTPResponse(io.RawIOBase): |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 256 | |
| 257 | # strict: If true, raise BadStatusLine if the status line can't be |
| 258 | # parsed as a valid HTTP/1.0 or 1.1 status line. By default it is |
Skip Montanaro | 186bec2 | 2002-07-25 16:10:38 +0000 | [diff] [blame] | 259 | # false because it prevents clients from talking to HTTP/0.9 |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 260 | # servers. Note that a response with a sufficiently corrupted |
| 261 | # status line will look like an HTTP/0.9 response. |
| 262 | |
| 263 | # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details. |
| 264 | |
Jeremy Hylton | 811fc14 | 2007-08-03 13:30:02 +0000 | [diff] [blame] | 265 | # The bytes from the socket object are iso-8859-1 strings. |
| 266 | # See RFC 2616 sec 2.2 which notes an exception for MIME-encoded |
| 267 | # text following RFC 2047. The basic status line parsing only |
| 268 | # accepts iso-8859-1. |
| 269 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 270 | def __init__(self, sock, debuglevel=0, strict=0, method=None, url=None): |
| 271 | # If the response includes a content-length header, we need to |
| 272 | # make sure that the client doesn't read more than the |
Jeremy Hylton | 39b198d | 2007-08-04 19:22:00 +0000 | [diff] [blame] | 273 | # specified number of bytes. If it does, it will block until |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 274 | # the server times out and closes the connection. This will |
| 275 | # happen if a self.fp.read() is done (without a size) whether |
| 276 | # self.fp is buffered or not. So, no self.fp.read() by |
| 277 | # clients unless they know what they are doing. |
Benjamin Peterson | f72d9fb | 2009-02-08 00:29:20 +0000 | [diff] [blame] | 278 | self.fp = sock.makefile("rb") |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 279 | self.debuglevel = debuglevel |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 280 | self.strict = strict |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 281 | self._method = method |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 282 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 283 | # The HTTPResponse object is returned via urllib. The clients |
| 284 | # of http and urllib expect different attributes for the |
| 285 | # headers. headers is used here and supports urllib. msg is |
| 286 | # provided as a backwards compatibility layer for http |
| 287 | # clients. |
| 288 | |
| 289 | self.headers = self.msg = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 290 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 291 | # from the Status-Line of the response |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 292 | self.version = _UNKNOWN # HTTP-Version |
| 293 | self.status = _UNKNOWN # Status-Code |
| 294 | self.reason = _UNKNOWN # Reason-Phrase |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 295 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 296 | self.chunked = _UNKNOWN # is "chunked" being used? |
| 297 | self.chunk_left = _UNKNOWN # bytes left to read in current chunk |
| 298 | self.length = _UNKNOWN # number of bytes left in response |
| 299 | self.will_close = _UNKNOWN # conn will close at end of response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 300 | |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 301 | def _read_status(self): |
Jeremy Hylton | 04319c7 | 2007-08-04 03:41:19 +0000 | [diff] [blame] | 302 | # Initialize with Simple-Response defaults. |
Jeremy Hylton | 811fc14 | 2007-08-03 13:30:02 +0000 | [diff] [blame] | 303 | line = str(self.fp.readline(), "iso-8859-1") |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 304 | if self.debuglevel > 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 305 | print("reply:", repr(line)) |
Jeremy Hylton | b676952 | 2003-06-29 17:55:05 +0000 | [diff] [blame] | 306 | if not line: |
| 307 | # Presumably, the server closed the connection before |
| 308 | # sending a valid response. |
| 309 | raise BadStatusLine(line) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 310 | try: |
Guido van Rossum | 34735a6 | 2000-12-15 15:09:42 +0000 | [diff] [blame] | 311 | [version, status, reason] = line.split(None, 2) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 312 | except ValueError: |
| 313 | try: |
Guido van Rossum | 34735a6 | 2000-12-15 15:09:42 +0000 | [diff] [blame] | 314 | [version, status] = line.split(None, 1) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 315 | reason = "" |
| 316 | except ValueError: |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 317 | # empty version will cause next test to fail and status |
| 318 | # will be treated as 0.9 response. |
| 319 | version = "" |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 320 | if not version.startswith("HTTP/"): |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 321 | if self.strict: |
| 322 | self.close() |
| 323 | raise BadStatusLine(line) |
| 324 | else: |
Jeremy Hylton | 04319c7 | 2007-08-04 03:41:19 +0000 | [diff] [blame] | 325 | # Assume it's a Simple-Response from an 0.9 server. |
| 326 | # We have to convert the first line back to raw bytes |
| 327 | # because self.fp.readline() needs to return bytes. |
Guido van Rossum | 70d0dda | 2007-08-29 01:53:26 +0000 | [diff] [blame] | 328 | self.fp = LineAndFileWrapper(bytes(line, "ascii"), self.fp) |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 329 | return "HTTP/0.9", 200, "" |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 330 | |
Jeremy Hylton | 23d4047 | 2001-04-13 14:57:08 +0000 | [diff] [blame] | 331 | # The status code is a three-digit number |
| 332 | try: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 333 | status = int(status) |
Jeremy Hylton | 23d4047 | 2001-04-13 14:57:08 +0000 | [diff] [blame] | 334 | if status < 100 or status > 999: |
| 335 | raise BadStatusLine(line) |
| 336 | except ValueError: |
| 337 | raise BadStatusLine(line) |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 338 | return version, status, reason |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 339 | |
Jeremy Hylton | 39c0380 | 2002-07-12 14:04:09 +0000 | [diff] [blame] | 340 | def begin(self): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 341 | if self.headers is not None: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 342 | # we've already started reading the response |
| 343 | return |
| 344 | |
| 345 | # read until we get a non-100 response |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 346 | while True: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 347 | version, status, reason = self._read_status() |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 348 | if status != CONTINUE: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 349 | break |
| 350 | # skip the header from the 100 response |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 351 | while True: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 352 | skip = self.fp.readline().strip() |
| 353 | if not skip: |
| 354 | break |
| 355 | if self.debuglevel > 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 356 | print("header:", skip) |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 357 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 358 | self.code = self.status = status |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 359 | self.reason = reason.strip() |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 360 | if version == "HTTP/1.0": |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 361 | self.version = 10 |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 362 | elif version.startswith("HTTP/1."): |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 363 | self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1 |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 364 | elif version == "HTTP/0.9": |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 365 | self.version = 9 |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 366 | else: |
| 367 | raise UnknownProtocol(version) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 368 | |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 369 | if self.version == 9: |
Georg Brandl | 0aade9a | 2005-06-26 22:06:54 +0000 | [diff] [blame] | 370 | self.length = None |
Jeremy Hylton | 236156f | 2008-12-15 03:00:50 +0000 | [diff] [blame] | 371 | self.chunked = False |
| 372 | self.will_close = True |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 373 | self.headers = self.msg = email.message_from_string('') |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 374 | return |
| 375 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 376 | self.headers = self.msg = parse_headers(self.fp) |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 377 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 378 | if self.debuglevel > 0: |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 379 | for hdr in self.headers: |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 380 | print("header:", hdr, end=" ") |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 381 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 382 | # are we using the chunked-style of transfer encoding? |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 383 | tr_enc = self.headers.get("transfer-encoding") |
Jeremy Hylton | d229b3a | 2002-09-03 19:24:24 +0000 | [diff] [blame] | 384 | if tr_enc and tr_enc.lower() == "chunked": |
Jeremy Hylton | 236156f | 2008-12-15 03:00:50 +0000 | [diff] [blame] | 385 | self.chunked = True |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 386 | self.chunk_left = None |
| 387 | else: |
Jeremy Hylton | 236156f | 2008-12-15 03:00:50 +0000 | [diff] [blame] | 388 | self.chunked = False |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 389 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 390 | # will the connection close at the end of the response? |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 391 | self.will_close = self._check_close() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 392 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 393 | # do we have a Content-Length? |
| 394 | # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked" |
Jeremy Hylton | 0ee5eeb | 2007-08-04 03:25:17 +0000 | [diff] [blame] | 395 | self.length = None |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 396 | length = self.headers.get("content-length") |
Barry Warsaw | 820c120 | 2008-06-12 04:06:45 +0000 | [diff] [blame] | 397 | |
| 398 | # are we using the chunked-style of transfer encoding? |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 399 | tr_enc = self.headers.get("transfer-encoding") |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 400 | if length and not self.chunked: |
Jeremy Hylton | 30a8181 | 2000-09-14 20:34:27 +0000 | [diff] [blame] | 401 | try: |
| 402 | self.length = int(length) |
| 403 | except ValueError: |
Christian Heimes | a612dc0 | 2008-02-24 13:08:18 +0000 | [diff] [blame] | 404 | self.length = None |
| 405 | else: |
| 406 | if self.length < 0: # ignore nonsensical negative lengths |
| 407 | self.length = None |
| 408 | else: |
| 409 | self.length = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 410 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 411 | # does the body have a fixed length? (of zero) |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 412 | if (status == NO_CONTENT or status == NOT_MODIFIED or |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 413 | 100 <= status < 200 or # 1xx codes |
Jeremy Hylton | e5d0e84 | 2007-08-03 13:45:24 +0000 | [diff] [blame] | 414 | self._method == "HEAD"): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 415 | self.length = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 416 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 417 | # if the connection remains open, and we aren't using chunked, and |
| 418 | # a content-length was not provided, then assume that the connection |
| 419 | # WILL close. |
Jeremy Hylton | 0ee5eeb | 2007-08-04 03:25:17 +0000 | [diff] [blame] | 420 | if (not self.will_close and |
| 421 | not self.chunked and |
| 422 | self.length is None): |
Jeremy Hylton | 236156f | 2008-12-15 03:00:50 +0000 | [diff] [blame] | 423 | self.will_close = True |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 424 | |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 425 | def _check_close(self): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 426 | conn = self.headers.get("connection") |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 427 | if self.version == 11: |
| 428 | # An HTTP/1.1 proxy is assumed to stay open unless |
| 429 | # explicitly closed. |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 430 | conn = self.headers.get("connection") |
Raymond Hettinger | bac788a | 2004-05-04 09:21:43 +0000 | [diff] [blame] | 431 | if conn and "close" in conn.lower(): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 432 | return True |
| 433 | return False |
| 434 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 435 | # Some HTTP/1.0 implementations have support for persistent |
| 436 | # connections, using rules different than HTTP/1.1. |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 437 | |
Christian Heimes | 895627f | 2007-12-08 17:28:33 +0000 | [diff] [blame] | 438 | # For older HTTP, Keep-Alive indicates persistent connection. |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 439 | if self.headers.get("keep-alive"): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 440 | return False |
Tim Peters | 77c06fb | 2002-11-24 02:35:35 +0000 | [diff] [blame] | 441 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 442 | # At least Akamai returns a "Connection: Keep-Alive" header, |
| 443 | # which was supposed to be sent by the client. |
| 444 | if conn and "keep-alive" in conn.lower(): |
| 445 | return False |
| 446 | |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 447 | # Proxy-Connection is a netscape hack. |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 448 | pconn = self.headers.get("proxy-connection") |
Raymond Hettinger | bac788a | 2004-05-04 09:21:43 +0000 | [diff] [blame] | 449 | if pconn and "keep-alive" in pconn.lower(): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 450 | return False |
| 451 | |
| 452 | # otherwise, assume it will close |
| 453 | return True |
| 454 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 455 | def close(self): |
| 456 | if self.fp: |
| 457 | self.fp.close() |
| 458 | self.fp = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 459 | |
Jeremy Hylton | df5f6b5 | 2007-08-08 17:36:33 +0000 | [diff] [blame] | 460 | # These implementations are for the benefit of io.BufferedReader. |
| 461 | |
| 462 | # XXX This class should probably be revised to act more like |
| 463 | # the "raw stream" that BufferedReader expects. |
| 464 | |
| 465 | @property |
| 466 | def closed(self): |
| 467 | return self.isclosed() |
| 468 | |
| 469 | def flush(self): |
| 470 | self.fp.flush() |
| 471 | |
Jeremy Hylton | a7cff02 | 2009-04-01 02:35:56 +0000 | [diff] [blame] | 472 | def readable(self): |
| 473 | return True |
| 474 | |
Jeremy Hylton | df5f6b5 | 2007-08-08 17:36:33 +0000 | [diff] [blame] | 475 | # End of "raw stream" methods |
| 476 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 477 | def isclosed(self): |
| 478 | # NOTE: it is possible that we will not ever call self.close(). This |
| 479 | # case occurs when will_close is TRUE, length is None, and we |
| 480 | # read up to the last byte, but NOT past it. |
| 481 | # |
| 482 | # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be |
| 483 | # called, meaning self.isclosed() is meaningful. |
| 484 | return self.fp is None |
| 485 | |
| 486 | def read(self, amt=None): |
| 487 | if self.fp is None: |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 488 | return b"" |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 489 | |
| 490 | if self.chunked: |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 491 | return self._read_chunked(amt) |
Tim Peters | 230a60c | 2002-11-09 05:08:07 +0000 | [diff] [blame] | 492 | |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 493 | if amt is None: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 494 | # unbounded read |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 495 | if self.length is None: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 496 | s = self.fp.read() |
| 497 | else: |
| 498 | s = self._safe_read(self.length) |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 499 | self.length = 0 |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 500 | self.close() # we read everything |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 501 | return s |
| 502 | |
| 503 | if self.length is not None: |
| 504 | if amt > self.length: |
| 505 | # clip the read to the "end of response" |
| 506 | amt = self.length |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 507 | |
| 508 | # we do not use _safe_read() here because this may be a .will_close |
| 509 | # connection, and the user is reading more bytes than will be provided |
| 510 | # (for example, reading in 1k chunks) |
| 511 | s = self.fp.read(amt) |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 512 | if self.length is not None: |
| 513 | self.length -= len(s) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 514 | if not self.length: |
| 515 | self.close() |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 516 | return s |
| 517 | |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 518 | def _read_chunked(self, amt): |
| 519 | assert self.chunked != _UNKNOWN |
| 520 | chunk_left = self.chunk_left |
Chris Withers | 9c33cbf | 2009-09-04 17:04:16 +0000 | [diff] [blame] | 521 | value = [] |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 522 | while True: |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 523 | if chunk_left is None: |
| 524 | line = self.fp.readline() |
Georg Brandl | 95ba469 | 2008-01-26 09:45:58 +0000 | [diff] [blame] | 525 | i = line.find(b";") |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 526 | if i >= 0: |
| 527 | line = line[:i] # strip chunk-extensions |
Christian Heimes | a612dc0 | 2008-02-24 13:08:18 +0000 | [diff] [blame] | 528 | try: |
| 529 | chunk_left = int(line, 16) |
| 530 | except ValueError: |
| 531 | # close the connection as protocol synchronisation is |
| 532 | # probably lost |
| 533 | self.close() |
Chris Withers | 9c33cbf | 2009-09-04 17:04:16 +0000 | [diff] [blame] | 534 | raise IncompleteRead(b''.join(value)) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 535 | if chunk_left == 0: |
| 536 | break |
| 537 | if amt is None: |
Chris Withers | 9c33cbf | 2009-09-04 17:04:16 +0000 | [diff] [blame] | 538 | value.append(self._safe_read(chunk_left)) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 539 | elif amt < chunk_left: |
Chris Withers | 9c33cbf | 2009-09-04 17:04:16 +0000 | [diff] [blame] | 540 | value.append(self._safe_read(amt)) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 541 | self.chunk_left = chunk_left - amt |
Chris Withers | 9c33cbf | 2009-09-04 17:04:16 +0000 | [diff] [blame] | 542 | return b''.join(value) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 543 | elif amt == chunk_left: |
Chris Withers | 9c33cbf | 2009-09-04 17:04:16 +0000 | [diff] [blame] | 544 | value.append(self._safe_read(amt)) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 545 | self._safe_read(2) # toss the CRLF at the end of the chunk |
| 546 | self.chunk_left = None |
Chris Withers | 9c33cbf | 2009-09-04 17:04:16 +0000 | [diff] [blame] | 547 | return b''.join(value) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 548 | else: |
Chris Withers | 9c33cbf | 2009-09-04 17:04:16 +0000 | [diff] [blame] | 549 | value.append(self._safe_read(chunk_left)) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 550 | amt -= chunk_left |
| 551 | |
| 552 | # we read the whole chunk, get another |
| 553 | self._safe_read(2) # toss the CRLF at the end of the chunk |
| 554 | chunk_left = None |
| 555 | |
| 556 | # read and discard trailer up to the CRLF terminator |
| 557 | ### note: we shouldn't have any trailers! |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 558 | while True: |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 559 | line = self.fp.readline() |
Christian Heimes | 0bd4e11 | 2008-02-12 22:59:25 +0000 | [diff] [blame] | 560 | if not line: |
| 561 | # a vanishingly small number of sites EOF without |
| 562 | # sending the trailer |
| 563 | break |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 564 | if line == b"\r\n": |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 565 | break |
| 566 | |
| 567 | # we read everything; close the "file" |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 568 | self.close() |
| 569 | |
Chris Withers | 9c33cbf | 2009-09-04 17:04:16 +0000 | [diff] [blame] | 570 | return b''.join(value) |
Tim Peters | 230a60c | 2002-11-09 05:08:07 +0000 | [diff] [blame] | 571 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 572 | def _safe_read(self, amt): |
| 573 | """Read the number of bytes requested, compensating for partial reads. |
| 574 | |
| 575 | Normally, we have a blocking socket, but a read() can be interrupted |
| 576 | by a signal (resulting in a partial read). |
| 577 | |
| 578 | Note that we cannot distinguish between EOF and an interrupt when zero |
| 579 | bytes have been read. IncompleteRead() will be raised in this |
| 580 | situation. |
| 581 | |
| 582 | This function should be used when <amt> bytes "should" be present for |
| 583 | reading. If the bytes are truly not available (due to EOF), then the |
| 584 | IncompleteRead exception can be used to detect the problem. |
| 585 | """ |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 586 | s = [] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 587 | while amt > 0: |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 588 | chunk = self.fp.read(min(amt, MAXAMOUNT)) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 589 | if not chunk: |
Benjamin Peterson | 6accb98 | 2009-03-02 22:50:25 +0000 | [diff] [blame] | 590 | raise IncompleteRead(b''.join(s), amt) |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 591 | s.append(chunk) |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 592 | amt -= len(chunk) |
Guido van Rossum | a00f123 | 2007-09-12 19:43:09 +0000 | [diff] [blame] | 593 | return b"".join(s) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 594 | |
Antoine Pitrou | b353c12 | 2009-02-11 00:39:14 +0000 | [diff] [blame] | 595 | def fileno(self): |
| 596 | return self.fp.fileno() |
| 597 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 598 | def getheader(self, name, default=None): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 599 | if self.headers is None: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 600 | raise ResponseNotReady() |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 601 | return ', '.join(self.headers.get_all(name, default)) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 602 | |
Martin v. Löwis | deacce2 | 2004-08-18 12:46:26 +0000 | [diff] [blame] | 603 | def getheaders(self): |
| 604 | """Return list of (header, value) tuples.""" |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 605 | if self.headers is None: |
Martin v. Löwis | deacce2 | 2004-08-18 12:46:26 +0000 | [diff] [blame] | 606 | raise ResponseNotReady() |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 607 | return list(self.headers.items()) |
Martin v. Löwis | deacce2 | 2004-08-18 12:46:26 +0000 | [diff] [blame] | 608 | |
Antoine Pitrou | b353c12 | 2009-02-11 00:39:14 +0000 | [diff] [blame] | 609 | # We override IOBase.__iter__ so that it doesn't check for closed-ness |
| 610 | |
| 611 | def __iter__(self): |
| 612 | return self |
| 613 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 614 | # For compatibility with old-style urllib responses. |
| 615 | |
| 616 | def info(self): |
| 617 | return self.headers |
| 618 | |
| 619 | def geturl(self): |
| 620 | return self.url |
| 621 | |
| 622 | def getcode(self): |
| 623 | return self.status |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 624 | |
| 625 | class HTTPConnection: |
| 626 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 627 | _http_vsn = 11 |
| 628 | _http_vsn_str = 'HTTP/1.1' |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 629 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 630 | response_class = HTTPResponse |
| 631 | default_port = HTTP_PORT |
| 632 | auto_open = 1 |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 633 | debuglevel = 0 |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 634 | strict = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 635 | |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 636 | def __init__(self, host, port=None, strict=None, |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 637 | timeout=socket._GLOBAL_DEFAULT_TIMEOUT, source_address=None): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 638 | self.timeout = timeout |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 639 | self.source_address = source_address |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 640 | self.sock = None |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 641 | self._buffer = [] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 642 | self.__response = None |
| 643 | self.__state = _CS_IDLE |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 644 | self._method = None |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 645 | self._tunnel_host = None |
| 646 | self._tunnel_port = None |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 647 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 648 | self._set_hostport(host, port) |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 649 | if strict is not None: |
| 650 | self.strict = strict |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 651 | |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 652 | def set_tunnel(self, host, port=None, headers=None): |
| 653 | """ Sets up the host and the port for the HTTP CONNECT Tunnelling. |
| 654 | |
| 655 | The headers argument should be a mapping of extra HTTP headers |
| 656 | to send with the CONNECT request. |
| 657 | """ |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 658 | self._tunnel_host = host |
| 659 | self._tunnel_port = port |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 660 | if headers: |
| 661 | self._tunnel_headers = headers |
| 662 | else: |
| 663 | self._tunnel_headers.clear() |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 664 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 665 | def _set_hostport(self, host, port): |
| 666 | if port is None: |
Skip Montanaro | 10e6e0e | 2004-09-14 16:32:02 +0000 | [diff] [blame] | 667 | i = host.rfind(':') |
Skip Montanaro | cae14d2 | 2004-09-14 17:55:21 +0000 | [diff] [blame] | 668 | j = host.rfind(']') # ipv6 addresses have [...] |
| 669 | if i > j: |
Skip Montanaro | 9d38997 | 2002-03-24 16:53:50 +0000 | [diff] [blame] | 670 | try: |
| 671 | port = int(host[i+1:]) |
| 672 | except ValueError: |
Jeremy Hylton | fbd7994 | 2002-07-02 20:19:08 +0000 | [diff] [blame] | 673 | raise InvalidURL("nonnumeric port: '%s'" % host[i+1:]) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 674 | host = host[:i] |
| 675 | else: |
| 676 | port = self.default_port |
Raymond Hettinger | 4d03791 | 2004-10-14 15:23:38 +0000 | [diff] [blame] | 677 | if host and host[0] == '[' and host[-1] == ']': |
Brett Cannon | 0a1af4a | 2004-09-15 23:26:23 +0000 | [diff] [blame] | 678 | host = host[1:-1] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 679 | self.host = host |
| 680 | self.port = port |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 681 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 682 | def set_debuglevel(self, level): |
| 683 | self.debuglevel = level |
| 684 | |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 685 | def _tunnel(self): |
| 686 | self._set_hostport(self._tunnel_host, self._tunnel_port) |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 687 | connect_str = "CONNECT %s:%d HTTP/1.0\r\n" %(self.host, self.port) |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 688 | connect_bytes = connect_str.encode("ascii") |
| 689 | self.send(connect_bytes) |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 690 | for header, value in self._tunnel_headers.iteritems(): |
| 691 | header_str = "%s: %s\r\n" % (header, value) |
| 692 | header_bytes = header_str.encode("ascii") |
| 693 | self.send(header_bytes) |
| 694 | |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 695 | response = self.response_class(self.sock, strict = self.strict, |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 696 | method = self._method) |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 697 | (version, code, message) = response._read_status() |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 698 | |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 699 | if code != 200: |
| 700 | self.close() |
| 701 | raise socket.error("Tunnel connection failed: %d %s" % (code, |
| 702 | message.strip())) |
| 703 | while True: |
| 704 | line = response.fp.readline() |
| 705 | if line == b'\r\n': |
| 706 | break |
| 707 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 708 | def connect(self): |
| 709 | """Connect to the host and port specified in __init__.""" |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 710 | self.sock = socket.create_connection((self.host,self.port), |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 711 | self.timeout, self.source_address) |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 712 | if self._tunnel_host: |
| 713 | self._tunnel() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 714 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 715 | def close(self): |
| 716 | """Close the connection to the HTTP server.""" |
| 717 | if self.sock: |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 718 | self.sock.close() # close it manually... there may be other refs |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 719 | self.sock = None |
| 720 | if self.__response: |
| 721 | self.__response.close() |
| 722 | self.__response = None |
| 723 | self.__state = _CS_IDLE |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 724 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 725 | def send(self, str): |
| 726 | """Send `str' to the server.""" |
| 727 | if self.sock is None: |
| 728 | if self.auto_open: |
| 729 | self.connect() |
| 730 | else: |
| 731 | raise NotConnected() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 732 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 733 | # send the data to the server. if we get a broken pipe, then close |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 734 | # the socket. we want to reconnect when somebody tries to send again. |
| 735 | # |
| 736 | # NOTE: we DO propagate the error, though, because we cannot simply |
| 737 | # ignore the error... the caller will know if they can retry. |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 738 | if self.debuglevel > 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 739 | print("send:", repr(str)) |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 740 | blocksize = 8192 |
| 741 | if hasattr(str, "read") : |
| 742 | if self.debuglevel > 0: |
| 743 | print("sendIng a read()able") |
| 744 | encode = False |
Antoine Pitrou | ead1d62 | 2009-09-29 18:44:53 +0000 | [diff] [blame] | 745 | try: |
| 746 | mode = str.mode |
| 747 | except AttributeError: |
| 748 | # io.BytesIO and other file-like objects don't have a `mode` |
| 749 | # attribute. |
| 750 | pass |
| 751 | else: |
| 752 | if "b" not in mode: |
| 753 | encode = True |
| 754 | if self.debuglevel > 0: |
| 755 | print("encoding file using iso-8859-1") |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 756 | while 1: |
| 757 | data = str.read(blocksize) |
| 758 | if not data: |
| 759 | break |
| 760 | if encode: |
| 761 | data = data.encode("iso-8859-1") |
| 762 | self.sock.sendall(data) |
| 763 | else: |
| 764 | self.sock.sendall(str) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 765 | |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 766 | def _output(self, s): |
| 767 | """Add a line of output to the current request buffer. |
Tim Peters | 469cdad | 2002-08-08 20:19:19 +0000 | [diff] [blame] | 768 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 769 | Assumes that the line does *not* end with \\r\\n. |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 770 | """ |
| 771 | self._buffer.append(s) |
| 772 | |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 773 | def _send_output(self, message_body=None): |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 774 | """Send the currently buffered request and clear the buffer. |
| 775 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 776 | Appends an extra \\r\\n to the buffer. |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 777 | A message_body may be specified, to be appended to the request. |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 778 | """ |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 779 | self._buffer.extend((b"", b"")) |
| 780 | msg = b"\r\n".join(self._buffer) |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 781 | del self._buffer[:] |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 782 | # If msg and message_body are sent in a single send() call, |
| 783 | # it will avoid performance problems caused by the interaction |
| 784 | # between delayed ack and the Nagle algorithim. |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 785 | if isinstance(message_body, bytes): |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 786 | msg += message_body |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 787 | message_body = None |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 788 | self.send(msg) |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 789 | if message_body is not None: |
Jeremy Hylton | 236654b | 2009-03-27 20:24:34 +0000 | [diff] [blame] | 790 | # message_body was not a string (i.e. it is a file), and |
| 791 | # we must run the risk of Nagle. |
Benjamin Peterson | 822b21c | 2009-01-18 00:04:57 +0000 | [diff] [blame] | 792 | self.send(message_body) |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 793 | |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 794 | def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 795 | """Send a request to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 796 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 797 | `method' specifies an HTTP request method, e.g. 'GET'. |
| 798 | `url' specifies the object being requested, e.g. '/index.html'. |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 799 | `skip_host' if True does not add automatically a 'Host:' header |
| 800 | `skip_accept_encoding' if True does not add automatically an |
| 801 | 'Accept-Encoding:' header |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 802 | """ |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 803 | |
Greg Stein | 616a58d | 2003-06-24 06:35:19 +0000 | [diff] [blame] | 804 | # if a prior response has been completed, then forget about it. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 805 | if self.__response and self.__response.isclosed(): |
| 806 | self.__response = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 807 | |
Tim Peters | 58eb11c | 2004-01-18 20:29:55 +0000 | [diff] [blame] | 808 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 809 | # in certain cases, we cannot issue another request on this connection. |
| 810 | # this occurs when: |
| 811 | # 1) we are in the process of sending a request. (_CS_REQ_STARTED) |
| 812 | # 2) a response to a previous request has signalled that it is going |
| 813 | # to close the connection upon completion. |
| 814 | # 3) the headers for the previous response have not been read, thus |
| 815 | # we cannot determine whether point (2) is true. (_CS_REQ_SENT) |
| 816 | # |
| 817 | # if there is no prior response, then we can request at will. |
| 818 | # |
| 819 | # if point (2) is true, then we will have passed the socket to the |
| 820 | # response (effectively meaning, "there is no prior response"), and |
| 821 | # will open a new one when a new request is made. |
| 822 | # |
| 823 | # Note: if a prior response exists, then we *can* start a new request. |
| 824 | # We are not allowed to begin fetching the response to this new |
| 825 | # request, however, until that prior response is complete. |
| 826 | # |
| 827 | if self.__state == _CS_IDLE: |
| 828 | self.__state = _CS_REQ_STARTED |
| 829 | else: |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 830 | raise CannotSendRequest(self.__state) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 831 | |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 832 | # Save the method we use, we need it later in the response phase |
| 833 | self._method = method |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 834 | if not url: |
| 835 | url = '/' |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 836 | request = '%s %s %s' % (method, url, self._http_vsn_str) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 837 | |
Martin v. Löwis | dd5a860 | 2007-06-30 09:22:09 +0000 | [diff] [blame] | 838 | # Non-ASCII characters should have been eliminated earlier |
| 839 | self._output(request.encode('ascii')) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 840 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 841 | if self._http_vsn == 11: |
| 842 | # Issue some standard headers for better HTTP/1.1 compliance |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 843 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 844 | if not skip_host: |
| 845 | # this header is issued *only* for HTTP/1.1 |
| 846 | # connections. more specifically, this means it is |
| 847 | # only issued when the client uses the new |
| 848 | # HTTPConnection() class. backwards-compat clients |
| 849 | # will be using HTTP/1.0 and those clients may be |
| 850 | # issuing this header themselves. we should NOT issue |
| 851 | # it twice; some web servers (such as Apache) barf |
| 852 | # when they see two Host: headers |
Guido van Rossum | f6922aa | 2001-01-14 21:03:01 +0000 | [diff] [blame] | 853 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 854 | # If we need a non-standard port,include it in the |
| 855 | # header. If the request is going through a proxy, |
| 856 | # but the host of the actual URL, not the host of the |
| 857 | # proxy. |
Jeremy Hylton | 8acf1e0 | 2002-03-08 19:35:51 +0000 | [diff] [blame] | 858 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 859 | netloc = '' |
| 860 | if url.startswith('http'): |
| 861 | nil, netloc, nil, nil, nil = urlsplit(url) |
| 862 | |
| 863 | if netloc: |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 864 | try: |
| 865 | netloc_enc = netloc.encode("ascii") |
| 866 | except UnicodeEncodeError: |
| 867 | netloc_enc = netloc.encode("idna") |
| 868 | self.putheader('Host', netloc_enc) |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 869 | else: |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 870 | try: |
| 871 | host_enc = self.host.encode("ascii") |
| 872 | except UnicodeEncodeError: |
| 873 | host_enc = self.host.encode("idna") |
Georg Brandl | 86b2fb9 | 2008-07-16 03:43:04 +0000 | [diff] [blame] | 874 | if self.port == self.default_port: |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 875 | self.putheader('Host', host_enc) |
| 876 | else: |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 877 | host_enc = host_enc.decode("ascii") |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 878 | self.putheader('Host', "%s:%s" % (host_enc, self.port)) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 879 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 880 | # note: we are assuming that clients will not attempt to set these |
| 881 | # headers since *this* library must deal with the |
| 882 | # consequences. this also means that when the supporting |
| 883 | # libraries are updated to recognize other forms, then this |
| 884 | # code should be changed (removed or updated). |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 885 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 886 | # we only want a Content-Encoding of "identity" since we don't |
| 887 | # support encodings such as x-gzip or x-deflate. |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 888 | if not skip_accept_encoding: |
| 889 | self.putheader('Accept-Encoding', 'identity') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 890 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 891 | # we can accept "chunked" Transfer-Encodings, but no others |
| 892 | # NOTE: no TE header implies *only* "chunked" |
| 893 | #self.putheader('TE', 'chunked') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 894 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 895 | # if TE is supplied in the header, then it must appear in a |
| 896 | # Connection header. |
| 897 | #self.putheader('Connection', 'TE') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 898 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 899 | else: |
| 900 | # For HTTP/1.0, the server will assume "not chunked" |
| 901 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 902 | |
Benjamin Peterson | f608c61 | 2008-11-16 18:33:53 +0000 | [diff] [blame] | 903 | def putheader(self, header, *values): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 904 | """Send a request header line to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 905 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 906 | For example: h.putheader('Accept', 'text/html') |
| 907 | """ |
| 908 | if self.__state != _CS_REQ_STARTED: |
| 909 | raise CannotSendHeader() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 910 | |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 911 | if hasattr(header, 'encode'): |
| 912 | header = header.encode('ascii') |
Benjamin Peterson | f608c61 | 2008-11-16 18:33:53 +0000 | [diff] [blame] | 913 | values = list(values) |
| 914 | for i, one_value in enumerate(values): |
| 915 | if hasattr(one_value, 'encode'): |
| 916 | values[i] = one_value.encode('ascii') |
| 917 | value = b'\r\n\t'.join(values) |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 918 | header = header + b': ' + value |
| 919 | self._output(header) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 920 | |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 921 | def endheaders(self, message_body=None): |
| 922 | """Indicate that the last header line has been sent to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 923 | |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 924 | This method sends the request to the server. The optional |
| 925 | message_body argument can be used to pass message body |
| 926 | associated with the request. The message body will be sent in |
| 927 | the same packet as the message headers if possible. The |
| 928 | message_body should be a string. |
| 929 | """ |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 930 | if self.__state == _CS_REQ_STARTED: |
| 931 | self.__state = _CS_REQ_SENT |
| 932 | else: |
| 933 | raise CannotSendHeader() |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 934 | self._send_output(message_body) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 935 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 936 | def request(self, method, url, body=None, headers={}): |
| 937 | """Send a complete request to the server.""" |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 938 | self._send_request(method, url, body, headers) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 939 | |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 940 | def _set_content_length(self, body): |
| 941 | # Set the content-length based on the body. |
| 942 | thelen = None |
| 943 | try: |
| 944 | thelen = str(len(body)) |
| 945 | except TypeError as te: |
| 946 | # If this is a file-like object, try to |
| 947 | # fstat its file descriptor |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 948 | try: |
| 949 | thelen = str(os.fstat(body.fileno()).st_size) |
| 950 | except (AttributeError, OSError): |
| 951 | # Don't send a length if this failed |
| 952 | if self.debuglevel > 0: print("Cannot stat!!") |
| 953 | |
| 954 | if thelen is not None: |
| 955 | self.putheader('Content-Length', thelen) |
| 956 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 957 | def _send_request(self, method, url, body, headers): |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 958 | # Honor explicitly requested Host: and Accept-Encoding: headers. |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 959 | header_names = dict.fromkeys([k.lower() for k in headers]) |
| 960 | skips = {} |
| 961 | if 'host' in header_names: |
| 962 | skips['skip_host'] = 1 |
| 963 | if 'accept-encoding' in header_names: |
| 964 | skips['skip_accept_encoding'] = 1 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 965 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 966 | self.putrequest(method, url, **skips) |
| 967 | |
| 968 | if body and ('content-length' not in header_names): |
Benjamin Peterson | 1742e40 | 2008-11-30 22:15:29 +0000 | [diff] [blame] | 969 | self._set_content_length(body) |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 970 | for hdr, value in headers.items(): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 971 | self.putheader(hdr, value) |
Jeremy Hylton | ef9f48e | 2009-03-26 22:04:05 +0000 | [diff] [blame] | 972 | if isinstance(body, str): |
Jeremy Hylton | 236654b | 2009-03-27 20:24:34 +0000 | [diff] [blame] | 973 | # RFC 2616 Section 3.7.1 says that text default has a |
| 974 | # default charset of iso-8859-1. |
| 975 | body = body.encode('iso-8859-1') |
Jeremy Hylton | ef9f48e | 2009-03-26 22:04:05 +0000 | [diff] [blame] | 976 | self.endheaders(body) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 977 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 978 | def getresponse(self): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 979 | """Get the response from the server. |
| 980 | |
| 981 | If the HTTPConnection is in the correct state, returns an |
| 982 | instance of HTTPResponse or of whatever object is returned by |
| 983 | class the response_class variable. |
| 984 | |
| 985 | If a request has not been sent or if a previous response has |
| 986 | not be handled, ResponseNotReady is raised. If the HTTP |
| 987 | response indicates that the connection should be closed, then |
| 988 | it will be closed before the response is returned. When the |
| 989 | connection is closed, the underlying socket is closed. |
| 990 | """ |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 991 | |
Greg Stein | 616a58d | 2003-06-24 06:35:19 +0000 | [diff] [blame] | 992 | # if a prior response has been completed, then forget about it. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 993 | if self.__response and self.__response.isclosed(): |
| 994 | self.__response = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 995 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 996 | # if a prior response exists, then it must be completed (otherwise, we |
| 997 | # cannot read this response's header to determine the connection-close |
| 998 | # behavior) |
| 999 | # |
| 1000 | # note: if a prior response existed, but was connection-close, then the |
| 1001 | # socket and response were made independent of this HTTPConnection |
| 1002 | # object since a new request requires that we open a whole new |
| 1003 | # connection |
| 1004 | # |
| 1005 | # this means the prior response had one of two states: |
| 1006 | # 1) will_close: this connection was reset and the prior socket and |
| 1007 | # response operate independently |
| 1008 | # 2) persistent: the response was retained and we await its |
| 1009 | # isclosed() status to become true. |
| 1010 | # |
| 1011 | if self.__state != _CS_REQ_SENT or self.__response: |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1012 | raise ResponseNotReady(self.__state) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1013 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 1014 | if self.debuglevel > 0: |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1015 | response = self.response_class(self.sock, self.debuglevel, |
Tim Peters | c2659cf | 2003-05-12 20:19:37 +0000 | [diff] [blame] | 1016 | strict=self.strict, |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 1017 | method=self._method) |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 1018 | else: |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 1019 | response = self.response_class(self.sock, strict=self.strict, |
| 1020 | method=self._method) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1021 | |
Jeremy Hylton | 39c0380 | 2002-07-12 14:04:09 +0000 | [diff] [blame] | 1022 | response.begin() |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 1023 | assert response.will_close != _UNKNOWN |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1024 | self.__state = _CS_IDLE |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1025 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1026 | if response.will_close: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1027 | # this effectively passes the connection to the response |
| 1028 | self.close() |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1029 | else: |
| 1030 | # remember this, so we can tell when it is complete |
| 1031 | self.__response = response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1032 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1033 | return response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1034 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1035 | try: |
| 1036 | import ssl |
| 1037 | except ImportError: |
| 1038 | pass |
| 1039 | else: |
| 1040 | class HTTPSConnection(HTTPConnection): |
| 1041 | "This class allows communication via SSL." |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1042 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1043 | default_port = HTTPS_PORT |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1044 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1045 | def __init__(self, host, port=None, key_file=None, cert_file=None, |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 1046 | strict=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT, |
| 1047 | source_address=None): |
| 1048 | super(HTTPSConnection, self).__init__(host, port, strict, timeout, |
| 1049 | source_address) |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1050 | self.key_file = key_file |
| 1051 | self.cert_file = cert_file |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1052 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1053 | def connect(self): |
| 1054 | "Connect to a host on a given (SSL) port." |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1055 | |
Jeremy Hylton | 636950f | 2009-03-28 04:34:21 +0000 | [diff] [blame] | 1056 | sock = socket.create_connection((self.host, self.port), |
Gregory P. Smith | b406637 | 2010-01-03 03:28:29 +0000 | [diff] [blame] | 1057 | self.timeout, self.source_address) |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 1058 | |
| 1059 | if self._tunnel_host: |
| 1060 | self.sock = sock |
| 1061 | self._tunnel() |
| 1062 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1063 | self.sock = ssl.wrap_socket(sock, self.key_file, self.cert_file) |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1064 | |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1065 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1066 | def FakeSocket (sock, sslobj): |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 1067 | warnings.warn("FakeSocket is deprecated, and won't be in 3.x. " + |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1068 | "Use the result of ssl.wrap_socket() directly instead.", |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 1069 | DeprecationWarning, stacklevel=2) |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1070 | return sslobj |
Jeremy Hylton | 29d27ac | 2002-07-09 21:22:36 +0000 | [diff] [blame] | 1071 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1072 | __all__.append("HTTPSConnection") |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1073 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1074 | class HTTPException(Exception): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1075 | # Subclasses that define an __init__ must call Exception.__init__ |
| 1076 | # or define self.args. Otherwise, str() will fail. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1077 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1078 | |
| 1079 | class NotConnected(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1080 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1081 | |
Skip Montanaro | 9d38997 | 2002-03-24 16:53:50 +0000 | [diff] [blame] | 1082 | class InvalidURL(HTTPException): |
| 1083 | pass |
| 1084 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1085 | class UnknownProtocol(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1086 | def __init__(self, version): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1087 | self.args = version, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1088 | self.version = version |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1089 | |
| 1090 | class UnknownTransferEncoding(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1091 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1092 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1093 | class UnimplementedFileMode(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1094 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1095 | |
| 1096 | class IncompleteRead(HTTPException): |
Benjamin Peterson | 6accb98 | 2009-03-02 22:50:25 +0000 | [diff] [blame] | 1097 | def __init__(self, partial, expected=None): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1098 | self.args = partial, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1099 | self.partial = partial |
Benjamin Peterson | 6accb98 | 2009-03-02 22:50:25 +0000 | [diff] [blame] | 1100 | self.expected = expected |
| 1101 | def __repr__(self): |
| 1102 | if self.expected is not None: |
| 1103 | e = ', %i more expected' % self.expected |
| 1104 | else: |
| 1105 | e = '' |
| 1106 | return 'IncompleteRead(%i bytes read%s)' % (len(self.partial), e) |
| 1107 | def __str__(self): |
| 1108 | return repr(self) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1109 | |
| 1110 | class ImproperConnectionState(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1111 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1112 | |
| 1113 | class CannotSendRequest(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1114 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1115 | |
| 1116 | class CannotSendHeader(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1117 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1118 | |
| 1119 | class ResponseNotReady(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1120 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1121 | |
| 1122 | class BadStatusLine(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1123 | def __init__(self, line): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1124 | self.args = line, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1125 | self.line = line |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1126 | |
| 1127 | # for backwards compatibility |
| 1128 | error = HTTPException |
| 1129 | |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1130 | class LineAndFileWrapper: |
| 1131 | """A limited file-like object for HTTP/0.9 responses.""" |
| 1132 | |
| 1133 | # The status-line parsing code calls readline(), which normally |
| 1134 | # get the HTTP status line. For a 0.9 response, however, this is |
| 1135 | # actually the first line of the body! Clients need to get a |
| 1136 | # readable file object that contains that line. |
| 1137 | |
| 1138 | def __init__(self, line, file): |
| 1139 | self._line = line |
| 1140 | self._file = file |
| 1141 | self._line_consumed = 0 |
| 1142 | self._line_offset = 0 |
| 1143 | self._line_left = len(line) |
| 1144 | |
| 1145 | def __getattr__(self, attr): |
| 1146 | return getattr(self._file, attr) |
| 1147 | |
| 1148 | def _done(self): |
| 1149 | # called when the last byte is read from the line. After the |
| 1150 | # call, all read methods are delegated to the underlying file |
Skip Montanaro | 74b9a7a | 2003-02-25 17:48:15 +0000 | [diff] [blame] | 1151 | # object. |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1152 | self._line_consumed = 1 |
| 1153 | self.read = self._file.read |
| 1154 | self.readline = self._file.readline |
| 1155 | self.readlines = self._file.readlines |
| 1156 | |
| 1157 | def read(self, amt=None): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1158 | if self._line_consumed: |
| 1159 | return self._file.read(amt) |
| 1160 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1161 | if amt is None or amt > self._line_left: |
| 1162 | s = self._line[self._line_offset:] |
| 1163 | self._done() |
| 1164 | if amt is None: |
| 1165 | return s + self._file.read() |
| 1166 | else: |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 1167 | return s + self._file.read(amt - len(s)) |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1168 | else: |
| 1169 | assert amt <= self._line_left |
| 1170 | i = self._line_offset |
| 1171 | j = i + amt |
| 1172 | s = self._line[i:j] |
| 1173 | self._line_offset = j |
| 1174 | self._line_left -= amt |
| 1175 | if self._line_left == 0: |
| 1176 | self._done() |
| 1177 | return s |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 1178 | |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1179 | def readline(self): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1180 | if self._line_consumed: |
| 1181 | return self._file.readline() |
| 1182 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1183 | s = self._line[self._line_offset:] |
| 1184 | self._done() |
| 1185 | return s |
| 1186 | |
| 1187 | def readlines(self, size=None): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1188 | if self._line_consumed: |
| 1189 | return self._file.readlines(size) |
| 1190 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1191 | L = [self._line[self._line_offset:]] |
| 1192 | self._done() |
| 1193 | if size is None: |
| 1194 | return L + self._file.readlines() |
| 1195 | else: |
| 1196 | return L + self._file.readlines(size) |