Éric Araujo | 06efea3 | 2012-02-26 01:33:22 +0100 | [diff] [blame] | 1 | r"""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 | |
Andrew M. Kuchling | ca2e790 | 2006-07-30 00:27:34 +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 | |
Antoine Pitrou | 7248178 | 2009-09-29 17:48:18 +0000 | [diff] [blame] | 69 | from array import array |
Victor Stinner | 2c6aee9 | 2010-07-24 02:46:16 +0000 | [diff] [blame] | 70 | import os |
Serhiy Storchaka | 59bdf63 | 2015-03-12 11:12:51 +0200 | [diff] [blame] | 71 | import re |
Jeremy Hylton | 6459c8d | 2001-10-11 17:47:22 +0000 | [diff] [blame] | 72 | import socket |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 73 | from sys import py3kwarning |
Jeremy Hylton | 8acf1e0 | 2002-03-08 19:35:51 +0000 | [diff] [blame] | 74 | from urlparse import urlsplit |
Bill Janssen | c459264 | 2007-08-31 19:02:23 +0000 | [diff] [blame] | 75 | import warnings |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 76 | with warnings.catch_warnings(): |
| 77 | if py3kwarning: |
| 78 | warnings.filterwarnings("ignore", ".*mimetools has been removed", |
| 79 | DeprecationWarning) |
Brett Cannon | 0a4128e | 2008-08-16 21:56:03 +0000 | [diff] [blame] | 80 | import mimetools |
Guido van Rossum | 23acc95 | 1994-02-21 16:36:04 +0000 | [diff] [blame] | 81 | |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 82 | try: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 83 | from cStringIO import StringIO |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 84 | except ImportError: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 85 | from StringIO import StringIO |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 86 | |
Thomas Wouters | a6900e8 | 2007-08-30 21:54:39 +0000 | [diff] [blame] | 87 | __all__ = ["HTTP", "HTTPResponse", "HTTPConnection", |
Skip Montanaro | 951a884 | 2001-06-01 16:25:38 +0000 | [diff] [blame] | 88 | "HTTPException", "NotConnected", "UnknownProtocol", |
Jeremy Hylton | 7c75c99 | 2002-06-28 23:38:14 +0000 | [diff] [blame] | 89 | "UnknownTransferEncoding", "UnimplementedFileMode", |
| 90 | "IncompleteRead", "InvalidURL", "ImproperConnectionState", |
| 91 | "CannotSendRequest", "CannotSendHeader", "ResponseNotReady", |
Georg Brandl | 6aab16e | 2006-02-17 19:17:25 +0000 | [diff] [blame] | 92 | "BadStatusLine", "error", "responses"] |
Skip Montanaro | 2dd4276 | 2001-01-23 15:35:05 +0000 | [diff] [blame] | 93 | |
Guido van Rossum | 23acc95 | 1994-02-21 16:36:04 +0000 | [diff] [blame] | 94 | HTTP_PORT = 80 |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 95 | HTTPS_PORT = 443 |
| 96 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 97 | _UNKNOWN = 'UNKNOWN' |
| 98 | |
| 99 | # connection states |
| 100 | _CS_IDLE = 'Idle' |
| 101 | _CS_REQ_STARTED = 'Request-started' |
| 102 | _CS_REQ_SENT = 'Request-sent' |
| 103 | |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 104 | # status codes |
| 105 | # informational |
| 106 | CONTINUE = 100 |
| 107 | SWITCHING_PROTOCOLS = 101 |
| 108 | PROCESSING = 102 |
| 109 | |
| 110 | # successful |
| 111 | OK = 200 |
| 112 | CREATED = 201 |
| 113 | ACCEPTED = 202 |
| 114 | NON_AUTHORITATIVE_INFORMATION = 203 |
| 115 | NO_CONTENT = 204 |
| 116 | RESET_CONTENT = 205 |
| 117 | PARTIAL_CONTENT = 206 |
| 118 | MULTI_STATUS = 207 |
| 119 | IM_USED = 226 |
| 120 | |
| 121 | # redirection |
| 122 | MULTIPLE_CHOICES = 300 |
| 123 | MOVED_PERMANENTLY = 301 |
| 124 | FOUND = 302 |
| 125 | SEE_OTHER = 303 |
| 126 | NOT_MODIFIED = 304 |
| 127 | USE_PROXY = 305 |
| 128 | TEMPORARY_REDIRECT = 307 |
| 129 | |
| 130 | # client error |
| 131 | BAD_REQUEST = 400 |
| 132 | UNAUTHORIZED = 401 |
| 133 | PAYMENT_REQUIRED = 402 |
| 134 | FORBIDDEN = 403 |
| 135 | NOT_FOUND = 404 |
| 136 | METHOD_NOT_ALLOWED = 405 |
| 137 | NOT_ACCEPTABLE = 406 |
| 138 | PROXY_AUTHENTICATION_REQUIRED = 407 |
| 139 | REQUEST_TIMEOUT = 408 |
| 140 | CONFLICT = 409 |
| 141 | GONE = 410 |
| 142 | LENGTH_REQUIRED = 411 |
| 143 | PRECONDITION_FAILED = 412 |
| 144 | REQUEST_ENTITY_TOO_LARGE = 413 |
| 145 | REQUEST_URI_TOO_LONG = 414 |
| 146 | UNSUPPORTED_MEDIA_TYPE = 415 |
| 147 | REQUESTED_RANGE_NOT_SATISFIABLE = 416 |
| 148 | EXPECTATION_FAILED = 417 |
| 149 | UNPROCESSABLE_ENTITY = 422 |
| 150 | LOCKED = 423 |
| 151 | FAILED_DEPENDENCY = 424 |
| 152 | UPGRADE_REQUIRED = 426 |
| 153 | |
| 154 | # server error |
| 155 | INTERNAL_SERVER_ERROR = 500 |
| 156 | NOT_IMPLEMENTED = 501 |
| 157 | BAD_GATEWAY = 502 |
| 158 | SERVICE_UNAVAILABLE = 503 |
| 159 | GATEWAY_TIMEOUT = 504 |
| 160 | HTTP_VERSION_NOT_SUPPORTED = 505 |
| 161 | INSUFFICIENT_STORAGE = 507 |
| 162 | NOT_EXTENDED = 510 |
| 163 | |
Georg Brandl | 6aab16e | 2006-02-17 19:17:25 +0000 | [diff] [blame] | 164 | # Mapping status codes to official W3C names |
| 165 | responses = { |
| 166 | 100: 'Continue', |
| 167 | 101: 'Switching Protocols', |
| 168 | |
| 169 | 200: 'OK', |
| 170 | 201: 'Created', |
| 171 | 202: 'Accepted', |
| 172 | 203: 'Non-Authoritative Information', |
| 173 | 204: 'No Content', |
| 174 | 205: 'Reset Content', |
| 175 | 206: 'Partial Content', |
| 176 | |
| 177 | 300: 'Multiple Choices', |
| 178 | 301: 'Moved Permanently', |
| 179 | 302: 'Found', |
| 180 | 303: 'See Other', |
| 181 | 304: 'Not Modified', |
| 182 | 305: 'Use Proxy', |
| 183 | 306: '(Unused)', |
| 184 | 307: 'Temporary Redirect', |
| 185 | |
| 186 | 400: 'Bad Request', |
| 187 | 401: 'Unauthorized', |
| 188 | 402: 'Payment Required', |
| 189 | 403: 'Forbidden', |
| 190 | 404: 'Not Found', |
| 191 | 405: 'Method Not Allowed', |
| 192 | 406: 'Not Acceptable', |
| 193 | 407: 'Proxy Authentication Required', |
| 194 | 408: 'Request Timeout', |
| 195 | 409: 'Conflict', |
| 196 | 410: 'Gone', |
| 197 | 411: 'Length Required', |
| 198 | 412: 'Precondition Failed', |
| 199 | 413: 'Request Entity Too Large', |
| 200 | 414: 'Request-URI Too Long', |
| 201 | 415: 'Unsupported Media Type', |
| 202 | 416: 'Requested Range Not Satisfiable', |
| 203 | 417: 'Expectation Failed', |
| 204 | |
| 205 | 500: 'Internal Server Error', |
| 206 | 501: 'Not Implemented', |
| 207 | 502: 'Bad Gateway', |
| 208 | 503: 'Service Unavailable', |
| 209 | 504: 'Gateway Timeout', |
| 210 | 505: 'HTTP Version Not Supported', |
| 211 | } |
| 212 | |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 213 | # maximal amount of data to read at one time in _safe_read |
| 214 | MAXAMOUNT = 1048576 |
| 215 | |
Antoine Pitrou | d7b6ac6 | 2010-12-18 18:18:21 +0000 | [diff] [blame] | 216 | # maximal line length when calling readline(). |
| 217 | _MAXLINE = 65536 |
| 218 | |
Berker Peksag | b7414e0 | 2014-08-05 07:15:57 +0300 | [diff] [blame] | 219 | # maximum amount of headers accepted |
| 220 | _MAXHEADERS = 100 |
| 221 | |
Serhiy Storchaka | 59bdf63 | 2015-03-12 11:12:51 +0200 | [diff] [blame] | 222 | # Header name/value ABNF (http://tools.ietf.org/html/rfc7230#section-3.2) |
| 223 | # |
| 224 | # VCHAR = %x21-7E |
| 225 | # obs-text = %x80-FF |
| 226 | # header-field = field-name ":" OWS field-value OWS |
| 227 | # field-name = token |
| 228 | # field-value = *( field-content / obs-fold ) |
| 229 | # field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ] |
| 230 | # field-vchar = VCHAR / obs-text |
| 231 | # |
| 232 | # obs-fold = CRLF 1*( SP / HTAB ) |
| 233 | # ; obsolete line folding |
| 234 | # ; see Section 3.2.4 |
| 235 | |
| 236 | # token = 1*tchar |
| 237 | # |
| 238 | # tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" |
| 239 | # / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~" |
| 240 | # / DIGIT / ALPHA |
| 241 | # ; any VCHAR, except delimiters |
| 242 | # |
| 243 | # VCHAR defined in http://tools.ietf.org/html/rfc5234#appendix-B.1 |
| 244 | |
Martin Panter | 6507657 | 2016-09-07 12:03:06 +0000 | [diff] [blame] | 245 | # the patterns for both name and value are more lenient than RFC |
Serhiy Storchaka | 59bdf63 | 2015-03-12 11:12:51 +0200 | [diff] [blame] | 246 | # definitions to allow for backwards compatibility |
| 247 | _is_legal_header_name = re.compile(r'\A[^:\s][^:\r\n]*\Z').match |
| 248 | _is_illegal_header_value = re.compile(r'\n(?![ \t])|\r(?![ \t\n])').search |
| 249 | |
R David Murray | b4b000f | 2015-03-22 15:15:44 -0400 | [diff] [blame] | 250 | # We always set the Content-Length header for these methods because some |
| 251 | # servers will otherwise respond with a 411 |
| 252 | _METHODS_EXPECTING_BODY = {'PATCH', 'POST', 'PUT'} |
| 253 | |
Berker Peksag | b7414e0 | 2014-08-05 07:15:57 +0300 | [diff] [blame] | 254 | |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 255 | class HTTPMessage(mimetools.Message): |
| 256 | |
| 257 | def addheader(self, key, value): |
| 258 | """Add header for field key handling repeats.""" |
| 259 | prev = self.dict.get(key) |
| 260 | if prev is None: |
| 261 | self.dict[key] = value |
| 262 | else: |
| 263 | combined = ", ".join((prev, value)) |
| 264 | self.dict[key] = combined |
| 265 | |
| 266 | def addcontinue(self, key, more): |
| 267 | """Add more field data from a continuation line.""" |
| 268 | prev = self.dict[key] |
| 269 | self.dict[key] = prev + "\n " + more |
| 270 | |
| 271 | def readheaders(self): |
| 272 | """Read header lines. |
| 273 | |
| 274 | Read header lines up to the entirely blank line that terminates them. |
| 275 | The (normally blank) line that ends the headers is skipped, but not |
Martin Panter | 75b2c5f | 2016-09-16 02:54:11 +0000 | [diff] [blame] | 276 | included in the returned list. If an invalid line is found in the |
| 277 | header section, it is skipped, and further lines are processed. |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 278 | |
| 279 | The variable self.status is set to the empty string if all went well, |
| 280 | otherwise it is an error message. The variable self.headers is a |
| 281 | completely uninterpreted list of lines contained in the header (so |
| 282 | printing them will reproduce the header exactly as it appears in the |
| 283 | file). |
| 284 | |
| 285 | If multiple header fields with the same name occur, they are combined |
| 286 | according to the rules in RFC 2616 sec 4.2: |
| 287 | |
| 288 | Appending each subsequent field-value to the first, each separated |
| 289 | by a comma. The order in which header fields with the same field-name |
| 290 | are received is significant to the interpretation of the combined |
| 291 | field value. |
| 292 | """ |
| 293 | # XXX The implementation overrides the readheaders() method of |
| 294 | # rfc822.Message. The base class design isn't amenable to |
| 295 | # customized behavior here so the method here is a copy of the |
| 296 | # base class code with a few small changes. |
| 297 | |
| 298 | self.dict = {} |
| 299 | self.unixfrom = '' |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 300 | self.headers = hlist = [] |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 301 | self.status = '' |
| 302 | headerseen = "" |
| 303 | firstline = 1 |
Martin Panter | 75b2c5f | 2016-09-16 02:54:11 +0000 | [diff] [blame] | 304 | tell = None |
| 305 | if not hasattr(self.fp, 'unread') and self.seekable: |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 306 | tell = self.fp.tell |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 307 | while True: |
Berker Peksag | b7414e0 | 2014-08-05 07:15:57 +0300 | [diff] [blame] | 308 | if len(hlist) > _MAXHEADERS: |
| 309 | raise HTTPException("got more than %d headers" % _MAXHEADERS) |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 310 | if tell: |
| 311 | try: |
Martin Panter | 75b2c5f | 2016-09-16 02:54:11 +0000 | [diff] [blame] | 312 | tell() |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 313 | except IOError: |
Martin Panter | 75b2c5f | 2016-09-16 02:54:11 +0000 | [diff] [blame] | 314 | tell = None |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 315 | self.seekable = 0 |
Antoine Pitrou | d7b6ac6 | 2010-12-18 18:18:21 +0000 | [diff] [blame] | 316 | line = self.fp.readline(_MAXLINE + 1) |
| 317 | if len(line) > _MAXLINE: |
| 318 | raise LineTooLong("header line") |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 319 | if not line: |
| 320 | self.status = 'EOF in headers' |
| 321 | break |
| 322 | # Skip unix From name time lines |
| 323 | if firstline and line.startswith('From '): |
| 324 | self.unixfrom = self.unixfrom + line |
| 325 | continue |
| 326 | firstline = 0 |
| 327 | if headerseen and line[0] in ' \t': |
| 328 | # XXX Not sure if continuation lines are handled properly |
| 329 | # for http and/or for repeating headers |
| 330 | # It's a continuation line. |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 331 | hlist.append(line) |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 332 | self.addcontinue(headerseen, line.strip()) |
| 333 | continue |
| 334 | elif self.iscomment(line): |
| 335 | # It's a comment. Ignore it. |
| 336 | continue |
| 337 | elif self.islast(line): |
| 338 | # Note! No pushback here! The delimiter line gets eaten. |
| 339 | break |
| 340 | headerseen = self.isheader(line) |
| 341 | if headerseen: |
| 342 | # It's a legal header line, save it. |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 343 | hlist.append(line) |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 344 | self.addheader(headerseen, line[len(headerseen)+1:].strip()) |
Benjamin Peterson | bfd976f | 2015-01-25 23:34:42 -0500 | [diff] [blame] | 345 | elif headerseen is not None: |
| 346 | # An empty header name. These aren't allowed in HTTP, but it's |
| 347 | # probably a benign mistake. Don't add the header, just keep |
| 348 | # going. |
Martin Panter | 75b2c5f | 2016-09-16 02:54:11 +0000 | [diff] [blame] | 349 | pass |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 350 | else: |
Martin Panter | 75b2c5f | 2016-09-16 02:54:11 +0000 | [diff] [blame] | 351 | # It's not a header line; skip it and try the next line. |
| 352 | self.status = 'Non-header line where header expected' |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 353 | |
| 354 | class HTTPResponse: |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 355 | |
| 356 | # strict: If true, raise BadStatusLine if the status line can't be |
| 357 | # 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] | 358 | # false because it prevents clients from talking to HTTP/0.9 |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 359 | # servers. Note that a response with a sufficiently corrupted |
| 360 | # status line will look like an HTTP/0.9 response. |
| 361 | |
| 362 | # See RFC 2616 sec 19.6 and RFC 1945 sec 6 for details. |
| 363 | |
Kristján Valur Jónsson | 3c43fcb | 2009-01-11 16:23:37 +0000 | [diff] [blame] | 364 | def __init__(self, sock, debuglevel=0, strict=0, method=None, buffering=False): |
| 365 | if buffering: |
| 366 | # The caller won't be using any sock.recv() calls, so buffering |
Gregory P. Smith | 77db016 | 2009-08-20 09:38:43 +0000 | [diff] [blame] | 367 | # is fine and recommended for performance. |
Kristján Valur Jónsson | 3c43fcb | 2009-01-11 16:23:37 +0000 | [diff] [blame] | 368 | self.fp = sock.makefile('rb') |
| 369 | else: |
| 370 | # The buffer size is specified as zero, because the headers of |
| 371 | # the response are read with readline(). If the reads were |
| 372 | # buffered the readline() calls could consume some of the |
| 373 | # response, which make be read via a recv() on the underlying |
| 374 | # socket. |
| 375 | self.fp = sock.makefile('rb', 0) |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 376 | self.debuglevel = debuglevel |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 377 | self.strict = strict |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 378 | self._method = method |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 379 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 380 | self.msg = None |
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 | # from the Status-Line of the response |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 383 | self.version = _UNKNOWN # HTTP-Version |
| 384 | self.status = _UNKNOWN # Status-Code |
| 385 | self.reason = _UNKNOWN # Reason-Phrase |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 386 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 387 | self.chunked = _UNKNOWN # is "chunked" being used? |
| 388 | self.chunk_left = _UNKNOWN # bytes left to read in current chunk |
| 389 | self.length = _UNKNOWN # number of bytes left in response |
| 390 | self.will_close = _UNKNOWN # conn will close at end of response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 391 | |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 392 | def _read_status(self): |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 393 | # Initialize with Simple-Response defaults |
Christian Heimes | 671138f | 2012-09-25 13:29:30 +0200 | [diff] [blame] | 394 | line = self.fp.readline(_MAXLINE + 1) |
| 395 | if len(line) > _MAXLINE: |
| 396 | raise LineTooLong("header line") |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 397 | if self.debuglevel > 0: |
| 398 | print "reply:", repr(line) |
Jeremy Hylton | b676952 | 2003-06-29 17:55:05 +0000 | [diff] [blame] | 399 | if not line: |
| 400 | # Presumably, the server closed the connection before |
| 401 | # sending a valid response. |
| 402 | raise BadStatusLine(line) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 403 | try: |
Guido van Rossum | 34735a6 | 2000-12-15 15:09:42 +0000 | [diff] [blame] | 404 | [version, status, reason] = line.split(None, 2) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 405 | except ValueError: |
| 406 | try: |
Guido van Rossum | 34735a6 | 2000-12-15 15:09:42 +0000 | [diff] [blame] | 407 | [version, status] = line.split(None, 1) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 408 | reason = "" |
| 409 | except ValueError: |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 410 | # empty version will cause next test to fail and status |
| 411 | # will be treated as 0.9 response. |
| 412 | version = "" |
| 413 | if not version.startswith('HTTP/'): |
| 414 | if self.strict: |
| 415 | self.close() |
| 416 | raise BadStatusLine(line) |
| 417 | else: |
| 418 | # assume it's a Simple-Response from an 0.9 server |
| 419 | self.fp = LineAndFileWrapper(line, self.fp) |
| 420 | return "HTTP/0.9", 200, "" |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 421 | |
Jeremy Hylton | 23d4047 | 2001-04-13 14:57:08 +0000 | [diff] [blame] | 422 | # The status code is a three-digit number |
| 423 | try: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 424 | status = int(status) |
Jeremy Hylton | 23d4047 | 2001-04-13 14:57:08 +0000 | [diff] [blame] | 425 | if status < 100 or status > 999: |
| 426 | raise BadStatusLine(line) |
| 427 | except ValueError: |
| 428 | raise BadStatusLine(line) |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 429 | return version, status, reason |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 430 | |
Jeremy Hylton | 39c0380 | 2002-07-12 14:04:09 +0000 | [diff] [blame] | 431 | def begin(self): |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 432 | if self.msg is not None: |
| 433 | # we've already started reading the response |
| 434 | return |
| 435 | |
| 436 | # read until we get a non-100 response |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 437 | while True: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 438 | version, status, reason = self._read_status() |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 439 | if status != CONTINUE: |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 440 | break |
| 441 | # skip the header from the 100 response |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 442 | while True: |
Antoine Pitrou | d7b6ac6 | 2010-12-18 18:18:21 +0000 | [diff] [blame] | 443 | skip = self.fp.readline(_MAXLINE + 1) |
| 444 | if len(skip) > _MAXLINE: |
| 445 | raise LineTooLong("header line") |
| 446 | skip = skip.strip() |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 447 | if not skip: |
| 448 | break |
| 449 | if self.debuglevel > 0: |
| 450 | print "header:", skip |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 451 | |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 452 | self.status = status |
| 453 | self.reason = reason.strip() |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 454 | if version == 'HTTP/1.0': |
| 455 | self.version = 10 |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 456 | elif version.startswith('HTTP/1.'): |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 457 | self.version = 11 # use HTTP/1.1 code for HTTP/1.x where x>=1 |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 458 | elif version == 'HTTP/0.9': |
| 459 | self.version = 9 |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 460 | else: |
| 461 | raise UnknownProtocol(version) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 462 | |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 463 | if self.version == 9: |
Georg Brandl | 0aade9a | 2005-06-26 22:06:54 +0000 | [diff] [blame] | 464 | self.length = None |
Jeremy Hylton | be4fcf1 | 2002-06-28 22:38:01 +0000 | [diff] [blame] | 465 | self.chunked = 0 |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 466 | self.will_close = 1 |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 467 | self.msg = HTTPMessage(StringIO()) |
Jeremy Hylton | 110941a | 2000-10-12 19:58:36 +0000 | [diff] [blame] | 468 | return |
| 469 | |
Jeremy Hylton | 6d0a4c7 | 2002-07-07 16:51:37 +0000 | [diff] [blame] | 470 | self.msg = HTTPMessage(self.fp, 0) |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 471 | if self.debuglevel > 0: |
| 472 | for hdr in self.msg.headers: |
| 473 | print "header:", hdr, |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 474 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 475 | # don't let the msg keep an fp |
| 476 | self.msg.fp = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 477 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 478 | # are we using the chunked-style of transfer encoding? |
| 479 | tr_enc = self.msg.getheader('transfer-encoding') |
Jeremy Hylton | d229b3a | 2002-09-03 19:24:24 +0000 | [diff] [blame] | 480 | if tr_enc and tr_enc.lower() == "chunked": |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 481 | self.chunked = 1 |
| 482 | self.chunk_left = None |
| 483 | else: |
| 484 | self.chunked = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 485 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 486 | # will the connection close at the end of the response? |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 487 | self.will_close = self._check_close() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 488 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 489 | # do we have a Content-Length? |
| 490 | # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked" |
| 491 | length = self.msg.getheader('content-length') |
| 492 | if length and not self.chunked: |
Jeremy Hylton | 30a8181 | 2000-09-14 20:34:27 +0000 | [diff] [blame] | 493 | try: |
| 494 | self.length = int(length) |
| 495 | except ValueError: |
| 496 | self.length = None |
Georg Brandl | 8c460d5 | 2008-02-24 00:14:24 +0000 | [diff] [blame] | 497 | else: |
| 498 | if self.length < 0: # ignore nonsensical negative lengths |
| 499 | self.length = None |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 500 | else: |
| 501 | self.length = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 502 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 503 | # does the body have a fixed length? (of zero) |
Martin v. Löwis | 39a3178 | 2004-09-18 09:03:49 +0000 | [diff] [blame] | 504 | if (status == NO_CONTENT or status == NOT_MODIFIED or |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 505 | 100 <= status < 200 or # 1xx codes |
| 506 | self._method == 'HEAD'): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 507 | self.length = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 508 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 509 | # if the connection remains open, and we aren't using chunked, and |
| 510 | # a content-length was not provided, then assume that the connection |
| 511 | # WILL close. |
| 512 | if not self.will_close and \ |
| 513 | not self.chunked and \ |
| 514 | self.length is None: |
| 515 | self.will_close = 1 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 516 | |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 517 | def _check_close(self): |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 518 | conn = self.msg.getheader('connection') |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 519 | if self.version == 11: |
| 520 | # An HTTP/1.1 proxy is assumed to stay open unless |
| 521 | # explicitly closed. |
| 522 | conn = self.msg.getheader('connection') |
Raymond Hettinger | bac788a | 2004-05-04 09:21:43 +0000 | [diff] [blame] | 523 | if conn and "close" in conn.lower(): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 524 | return True |
| 525 | return False |
| 526 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 527 | # Some HTTP/1.0 implementations have support for persistent |
| 528 | # connections, using rules different than HTTP/1.1. |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 529 | |
Georg Brandl | 26458c1 | 2007-12-08 10:56:39 +0000 | [diff] [blame] | 530 | # For older HTTP, Keep-Alive indicates persistent connection. |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 531 | if self.msg.getheader('keep-alive'): |
| 532 | return False |
Tim Peters | 77c06fb | 2002-11-24 02:35:35 +0000 | [diff] [blame] | 533 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 534 | # At least Akamai returns a "Connection: Keep-Alive" header, |
| 535 | # which was supposed to be sent by the client. |
| 536 | if conn and "keep-alive" in conn.lower(): |
| 537 | return False |
| 538 | |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 539 | # Proxy-Connection is a netscape hack. |
| 540 | pconn = self.msg.getheader('proxy-connection') |
Raymond Hettinger | bac788a | 2004-05-04 09:21:43 +0000 | [diff] [blame] | 541 | if pconn and "keep-alive" in pconn.lower(): |
Jeremy Hylton | 22b3a49 | 2002-11-13 17:27:43 +0000 | [diff] [blame] | 542 | return False |
| 543 | |
| 544 | # otherwise, assume it will close |
| 545 | return True |
| 546 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 547 | def close(self): |
Serhiy Storchaka | 1aa2c0f | 2015-04-10 13:24:10 +0300 | [diff] [blame] | 548 | fp = self.fp |
| 549 | if fp: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 550 | self.fp = None |
Serhiy Storchaka | 1aa2c0f | 2015-04-10 13:24:10 +0300 | [diff] [blame] | 551 | fp.close() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 552 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 553 | def isclosed(self): |
| 554 | # NOTE: it is possible that we will not ever call self.close(). This |
| 555 | # case occurs when will_close is TRUE, length is None, and we |
| 556 | # read up to the last byte, but NOT past it. |
| 557 | # |
| 558 | # IMPLIES: if will_close is FALSE, then self.close() will ALWAYS be |
| 559 | # called, meaning self.isclosed() is meaningful. |
| 560 | return self.fp is None |
| 561 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 562 | # XXX It would be nice to have readline and __iter__ for this, too. |
| 563 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 564 | def read(self, amt=None): |
| 565 | if self.fp is None: |
| 566 | return '' |
| 567 | |
Senthil Kumaran | ed920434 | 2010-04-28 17:20:43 +0000 | [diff] [blame] | 568 | if self._method == 'HEAD': |
Senthil Kumaran | dfaced5 | 2010-06-04 16:32:14 +0000 | [diff] [blame] | 569 | self.close() |
Senthil Kumaran | ed920434 | 2010-04-28 17:20:43 +0000 | [diff] [blame] | 570 | return '' |
| 571 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 572 | if self.chunked: |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 573 | return self._read_chunked(amt) |
Tim Peters | 230a60c | 2002-11-09 05:08:07 +0000 | [diff] [blame] | 574 | |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 575 | if amt is None: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 576 | # unbounded read |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 577 | if self.length is None: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 578 | s = self.fp.read() |
| 579 | else: |
Antoine Pitrou | d66c0ee | 2013-02-02 22:49:34 +0100 | [diff] [blame] | 580 | try: |
| 581 | s = self._safe_read(self.length) |
| 582 | except IncompleteRead: |
| 583 | self.close() |
| 584 | raise |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 585 | self.length = 0 |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 586 | self.close() # we read everything |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 587 | return s |
| 588 | |
| 589 | if self.length is not None: |
| 590 | if amt > self.length: |
| 591 | # clip the read to the "end of response" |
| 592 | amt = self.length |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 593 | |
| 594 | # we do not use _safe_read() here because this may be a .will_close |
| 595 | # connection, and the user is reading more bytes than will be provided |
| 596 | # (for example, reading in 1k chunks) |
| 597 | s = self.fp.read(amt) |
Serhiy Storchaka | c97f5ed | 2013-12-17 21:49:48 +0200 | [diff] [blame] | 598 | if not s and amt: |
Antoine Pitrou | d66c0ee | 2013-02-02 22:49:34 +0100 | [diff] [blame] | 599 | # Ideally, we would raise IncompleteRead if the content-length |
| 600 | # wasn't satisfied, but it might break compatibility. |
| 601 | self.close() |
Jeremy Hylton | def9d2a | 2004-11-07 16:13:49 +0000 | [diff] [blame] | 602 | if self.length is not None: |
| 603 | self.length -= len(s) |
Facundo Batista | 7066590 | 2007-10-18 03:16:03 +0000 | [diff] [blame] | 604 | if not self.length: |
| 605 | self.close() |
Antoine Pitrou | 4113d2b | 2012-12-15 19:11:54 +0100 | [diff] [blame] | 606 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 607 | return s |
| 608 | |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 609 | def _read_chunked(self, amt): |
| 610 | assert self.chunked != _UNKNOWN |
| 611 | chunk_left = self.chunk_left |
Chris Withers | 68c6e92 | 2009-09-04 16:12:32 +0000 | [diff] [blame] | 612 | value = [] |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 613 | while True: |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 614 | if chunk_left is None: |
Antoine Pitrou | d7b6ac6 | 2010-12-18 18:18:21 +0000 | [diff] [blame] | 615 | line = self.fp.readline(_MAXLINE + 1) |
| 616 | if len(line) > _MAXLINE: |
| 617 | raise LineTooLong("chunk size") |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 618 | i = line.find(';') |
| 619 | if i >= 0: |
| 620 | line = line[:i] # strip chunk-extensions |
Georg Brandl | 2363503 | 2008-02-24 00:03:22 +0000 | [diff] [blame] | 621 | try: |
| 622 | chunk_left = int(line, 16) |
| 623 | except ValueError: |
| 624 | # close the connection as protocol synchronisation is |
| 625 | # probably lost |
| 626 | self.close() |
Chris Withers | 68c6e92 | 2009-09-04 16:12:32 +0000 | [diff] [blame] | 627 | raise IncompleteRead(''.join(value)) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 628 | if chunk_left == 0: |
| 629 | break |
| 630 | if amt is None: |
Chris Withers | 68c6e92 | 2009-09-04 16:12:32 +0000 | [diff] [blame] | 631 | value.append(self._safe_read(chunk_left)) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 632 | elif amt < chunk_left: |
Chris Withers | 68c6e92 | 2009-09-04 16:12:32 +0000 | [diff] [blame] | 633 | value.append(self._safe_read(amt)) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 634 | self.chunk_left = chunk_left - amt |
Chris Withers | 68c6e92 | 2009-09-04 16:12:32 +0000 | [diff] [blame] | 635 | return ''.join(value) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 636 | elif amt == chunk_left: |
Chris Withers | 68c6e92 | 2009-09-04 16:12:32 +0000 | [diff] [blame] | 637 | value.append(self._safe_read(amt)) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 638 | self._safe_read(2) # toss the CRLF at the end of the chunk |
| 639 | self.chunk_left = None |
Chris Withers | 68c6e92 | 2009-09-04 16:12:32 +0000 | [diff] [blame] | 640 | return ''.join(value) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 641 | else: |
Chris Withers | 68c6e92 | 2009-09-04 16:12:32 +0000 | [diff] [blame] | 642 | value.append(self._safe_read(chunk_left)) |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 643 | amt -= chunk_left |
| 644 | |
| 645 | # we read the whole chunk, get another |
| 646 | self._safe_read(2) # toss the CRLF at the end of the chunk |
| 647 | chunk_left = None |
| 648 | |
| 649 | # read and discard trailer up to the CRLF terminator |
| 650 | ### note: we shouldn't have any trailers! |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 651 | while True: |
Antoine Pitrou | d7b6ac6 | 2010-12-18 18:18:21 +0000 | [diff] [blame] | 652 | line = self.fp.readline(_MAXLINE + 1) |
| 653 | if len(line) > _MAXLINE: |
| 654 | raise LineTooLong("trailer line") |
Martin v. Löwis | dad88dc | 2008-02-12 18:47:34 +0000 | [diff] [blame] | 655 | if not line: |
| 656 | # a vanishingly small number of sites EOF without |
| 657 | # sending the trailer |
| 658 | break |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 659 | if line == '\r\n': |
| 660 | break |
| 661 | |
| 662 | # we read everything; close the "file" |
Jeremy Hylton | d4c472c | 2002-09-03 20:49:06 +0000 | [diff] [blame] | 663 | self.close() |
| 664 | |
Chris Withers | 68c6e92 | 2009-09-04 16:12:32 +0000 | [diff] [blame] | 665 | return ''.join(value) |
Tim Peters | 230a60c | 2002-11-09 05:08:07 +0000 | [diff] [blame] | 666 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 667 | def _safe_read(self, amt): |
| 668 | """Read the number of bytes requested, compensating for partial reads. |
| 669 | |
| 670 | Normally, we have a blocking socket, but a read() can be interrupted |
| 671 | by a signal (resulting in a partial read). |
| 672 | |
| 673 | Note that we cannot distinguish between EOF and an interrupt when zero |
| 674 | bytes have been read. IncompleteRead() will be raised in this |
| 675 | situation. |
| 676 | |
| 677 | This function should be used when <amt> bytes "should" be present for |
| 678 | reading. If the bytes are truly not available (due to EOF), then the |
| 679 | IncompleteRead exception can be used to detect the problem. |
| 680 | """ |
Gregory P. Smith | 8cabfa3 | 2009-08-15 22:39:03 +0000 | [diff] [blame] | 681 | # NOTE(gps): As of svn r74426 socket._fileobject.read(x) will never |
| 682 | # return less than x bytes unless EOF is encountered. It now handles |
| 683 | # signal interruptions (socket.error EINTR) internally. This code |
| 684 | # never caught that exception anyways. It seems largely pointless. |
| 685 | # self.fp.read(amt) will work fine. |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 686 | s = [] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 687 | while amt > 0: |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 688 | chunk = self.fp.read(min(amt, MAXAMOUNT)) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 689 | if not chunk: |
Benjamin Peterson | 7d49bba | 2009-03-02 22:41:42 +0000 | [diff] [blame] | 690 | raise IncompleteRead(''.join(s), amt) |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 691 | s.append(chunk) |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 692 | amt -= len(chunk) |
Georg Brandl | 80ba8e8 | 2005-09-29 20:16:07 +0000 | [diff] [blame] | 693 | return ''.join(s) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 694 | |
Senthil Kumaran | d389cb5 | 2010-09-21 01:38:15 +0000 | [diff] [blame] | 695 | def fileno(self): |
| 696 | return self.fp.fileno() |
| 697 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 698 | def getheader(self, name, default=None): |
| 699 | if self.msg is None: |
| 700 | raise ResponseNotReady() |
| 701 | return self.msg.getheader(name, default) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 702 | |
Martin v. Löwis | deacce2 | 2004-08-18 12:46:26 +0000 | [diff] [blame] | 703 | def getheaders(self): |
| 704 | """Return list of (header, value) tuples.""" |
| 705 | if self.msg is None: |
| 706 | raise ResponseNotReady() |
| 707 | return self.msg.items() |
| 708 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 709 | |
| 710 | class HTTPConnection: |
| 711 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 712 | _http_vsn = 11 |
| 713 | _http_vsn_str = 'HTTP/1.1' |
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 | response_class = HTTPResponse |
| 716 | default_port = HTTP_PORT |
| 717 | auto_open = 1 |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 718 | debuglevel = 0 |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 719 | strict = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 720 | |
Facundo Batista | 4f1b1ed | 2008-05-29 16:39:26 +0000 | [diff] [blame] | 721 | def __init__(self, host, port=None, strict=None, |
Gregory P. Smith | 9d32521 | 2010-01-03 02:06:07 +0000 | [diff] [blame] | 722 | timeout=socket._GLOBAL_DEFAULT_TIMEOUT, source_address=None): |
Facundo Batista | 07c78be | 2007-03-23 18:54:07 +0000 | [diff] [blame] | 723 | self.timeout = timeout |
Gregory P. Smith | 9d32521 | 2010-01-03 02:06:07 +0000 | [diff] [blame] | 724 | self.source_address = source_address |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 725 | self.sock = None |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 726 | self._buffer = [] |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 727 | self.__response = None |
| 728 | self.__state = _CS_IDLE |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 729 | self._method = None |
Senthil Kumaran | e266f25 | 2009-05-24 09:14:50 +0000 | [diff] [blame] | 730 | self._tunnel_host = None |
| 731 | self._tunnel_port = None |
Senthil Kumaran | 7713acf | 2009-12-20 06:05:13 +0000 | [diff] [blame] | 732 | self._tunnel_headers = {} |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 733 | if strict is not None: |
| 734 | self.strict = strict |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 735 | |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 736 | (self.host, self.port) = self._get_hostport(host, port) |
| 737 | |
| 738 | # This is stored as an instance variable to allow unittests |
| 739 | # to replace with a suitable mock |
| 740 | self._create_connection = socket.create_connection |
| 741 | |
Senthil Kumaran | 7713acf | 2009-12-20 06:05:13 +0000 | [diff] [blame] | 742 | def set_tunnel(self, host, port=None, headers=None): |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 743 | """ Set up host and port for HTTP CONNECT tunnelling. |
| 744 | |
| 745 | In a connection that uses HTTP Connect tunneling, the host passed to the |
| 746 | constructor is used as proxy server that relays all communication to the |
| 747 | endpoint passed to set_tunnel. This is done by sending a HTTP CONNECT |
| 748 | request to the proxy server when the connection is established. |
| 749 | |
Senthil Kumaran | 812b975 | 2015-01-24 12:58:10 -0800 | [diff] [blame] | 750 | This method must be called before the HTTP connection has been |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 751 | established. |
Senthil Kumaran | 7713acf | 2009-12-20 06:05:13 +0000 | [diff] [blame] | 752 | |
| 753 | The headers argument should be a mapping of extra HTTP headers |
| 754 | to send with the CONNECT request. |
| 755 | """ |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 756 | # Verify if this is required. |
| 757 | if self.sock: |
| 758 | raise RuntimeError("Can't setup tunnel for established connection.") |
| 759 | |
Serhiy Storchaka | 9d1de8a | 2015-05-28 22:37:13 +0300 | [diff] [blame] | 760 | self._tunnel_host, self._tunnel_port = self._get_hostport(host, port) |
Senthil Kumaran | 7713acf | 2009-12-20 06:05:13 +0000 | [diff] [blame] | 761 | if headers: |
| 762 | self._tunnel_headers = headers |
| 763 | else: |
| 764 | self._tunnel_headers.clear() |
Senthil Kumaran | e266f25 | 2009-05-24 09:14:50 +0000 | [diff] [blame] | 765 | |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 766 | def _get_hostport(self, host, port): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 767 | if port is None: |
Skip Montanaro | 10e6e0e | 2004-09-14 16:32:02 +0000 | [diff] [blame] | 768 | i = host.rfind(':') |
Skip Montanaro | cae14d2 | 2004-09-14 17:55:21 +0000 | [diff] [blame] | 769 | j = host.rfind(']') # ipv6 addresses have [...] |
| 770 | if i > j: |
Skip Montanaro | 9d38997 | 2002-03-24 16:53:50 +0000 | [diff] [blame] | 771 | try: |
| 772 | port = int(host[i+1:]) |
| 773 | except ValueError: |
Łukasz Langa | 7a15390 | 2011-10-18 17:16:00 +0200 | [diff] [blame] | 774 | if host[i+1:] == "": # http://foo.com:/ == http://foo.com/ |
| 775 | port = self.default_port |
| 776 | else: |
| 777 | raise InvalidURL("nonnumeric port: '%s'" % host[i+1:]) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 778 | host = host[:i] |
| 779 | else: |
| 780 | port = self.default_port |
Raymond Hettinger | 4d03791 | 2004-10-14 15:23:38 +0000 | [diff] [blame] | 781 | if host and host[0] == '[' and host[-1] == ']': |
Brett Cannon | 0a1af4a | 2004-09-15 23:26:23 +0000 | [diff] [blame] | 782 | host = host[1:-1] |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 783 | return (host, port) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 784 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 785 | def set_debuglevel(self, level): |
| 786 | self.debuglevel = level |
| 787 | |
Senthil Kumaran | e266f25 | 2009-05-24 09:14:50 +0000 | [diff] [blame] | 788 | def _tunnel(self): |
Serhiy Storchaka | 9d1de8a | 2015-05-28 22:37:13 +0300 | [diff] [blame] | 789 | self.send("CONNECT %s:%d HTTP/1.0\r\n" % (self._tunnel_host, |
| 790 | self._tunnel_port)) |
Senthil Kumaran | 7713acf | 2009-12-20 06:05:13 +0000 | [diff] [blame] | 791 | for header, value in self._tunnel_headers.iteritems(): |
| 792 | self.send("%s: %s\r\n" % (header, value)) |
| 793 | self.send("\r\n") |
Senthil Kumaran | e266f25 | 2009-05-24 09:14:50 +0000 | [diff] [blame] | 794 | response = self.response_class(self.sock, strict = self.strict, |
| 795 | method = self._method) |
| 796 | (version, code, message) = response._read_status() |
| 797 | |
Martin Panter | b75a0e9 | 2015-09-07 01:18:47 +0000 | [diff] [blame] | 798 | if version == "HTTP/0.9": |
| 799 | # HTTP/0.9 doesn't support the CONNECT verb, so if httplib has |
| 800 | # concluded HTTP/0.9 is being used something has gone wrong. |
| 801 | self.close() |
| 802 | raise socket.error("Invalid response from tunnel request") |
Senthil Kumaran | e266f25 | 2009-05-24 09:14:50 +0000 | [diff] [blame] | 803 | if code != 200: |
| 804 | self.close() |
Antoine Pitrou | 92331d5 | 2009-10-14 19:04:48 +0000 | [diff] [blame] | 805 | raise socket.error("Tunnel connection failed: %d %s" % (code, |
| 806 | message.strip())) |
Senthil Kumaran | e266f25 | 2009-05-24 09:14:50 +0000 | [diff] [blame] | 807 | while True: |
Antoine Pitrou | d7b6ac6 | 2010-12-18 18:18:21 +0000 | [diff] [blame] | 808 | line = response.fp.readline(_MAXLINE + 1) |
| 809 | if len(line) > _MAXLINE: |
| 810 | raise LineTooLong("header line") |
Senthil Kumaran | 0267185 | 2012-04-23 23:46:46 +0800 | [diff] [blame] | 811 | if not line: |
| 812 | # for sites which EOF without sending trailer |
| 813 | break |
| 814 | if line == '\r\n': |
| 815 | break |
Senthil Kumaran | e266f25 | 2009-05-24 09:14:50 +0000 | [diff] [blame] | 816 | |
| 817 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 818 | def connect(self): |
| 819 | """Connect to the host and port specified in __init__.""" |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 820 | self.sock = self._create_connection((self.host,self.port), |
| 821 | self.timeout, self.source_address) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 822 | |
Senthil Kumaran | e266f25 | 2009-05-24 09:14:50 +0000 | [diff] [blame] | 823 | if self._tunnel_host: |
| 824 | self._tunnel() |
| 825 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 826 | def close(self): |
| 827 | """Close the connection to the HTTP server.""" |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 828 | self.__state = _CS_IDLE |
Serhiy Storchaka | 1aa2c0f | 2015-04-10 13:24:10 +0300 | [diff] [blame] | 829 | try: |
| 830 | sock = self.sock |
| 831 | if sock: |
| 832 | self.sock = None |
| 833 | sock.close() # close it manually... there may be other refs |
| 834 | finally: |
| 835 | response = self.__response |
| 836 | if response: |
| 837 | self.__response = None |
| 838 | response.close() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 839 | |
Senthil Kumaran | 452b0ce | 2010-10-02 10:43:45 +0000 | [diff] [blame] | 840 | def send(self, data): |
| 841 | """Send `data' to the server.""" |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 842 | if self.sock is None: |
| 843 | if self.auto_open: |
| 844 | self.connect() |
| 845 | else: |
| 846 | raise NotConnected() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 847 | |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 848 | if self.debuglevel > 0: |
Senthil Kumaran | 452b0ce | 2010-10-02 10:43:45 +0000 | [diff] [blame] | 849 | print "send:", repr(data) |
Victor Stinner | 2c6aee9 | 2010-07-24 02:46:16 +0000 | [diff] [blame] | 850 | blocksize = 8192 |
Senthil Kumaran | 452b0ce | 2010-10-02 10:43:45 +0000 | [diff] [blame] | 851 | if hasattr(data,'read') and not isinstance(data, array): |
Victor Stinner | 2c6aee9 | 2010-07-24 02:46:16 +0000 | [diff] [blame] | 852 | if self.debuglevel > 0: print "sendIng a read()able" |
Senthil Kumaran | 452b0ce | 2010-10-02 10:43:45 +0000 | [diff] [blame] | 853 | datablock = data.read(blocksize) |
| 854 | while datablock: |
| 855 | self.sock.sendall(datablock) |
| 856 | datablock = data.read(blocksize) |
Victor Stinner | 2c6aee9 | 2010-07-24 02:46:16 +0000 | [diff] [blame] | 857 | else: |
Senthil Kumaran | 452b0ce | 2010-10-02 10:43:45 +0000 | [diff] [blame] | 858 | self.sock.sendall(data) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 859 | |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 860 | def _output(self, s): |
| 861 | """Add a line of output to the current request buffer. |
Tim Peters | 469cdad | 2002-08-08 20:19:19 +0000 | [diff] [blame] | 862 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 863 | Assumes that the line does *not* end with \\r\\n. |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 864 | """ |
| 865 | self._buffer.append(s) |
| 866 | |
Jeremy Hylton | 0381f48 | 2008-11-29 01:09:35 +0000 | [diff] [blame] | 867 | def _send_output(self, message_body=None): |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 868 | """Send the currently buffered request and clear the buffer. |
| 869 | |
Jeremy Hylton | e3252ec | 2002-07-16 21:41:43 +0000 | [diff] [blame] | 870 | Appends an extra \\r\\n to the buffer. |
Kristján Valur Jónsson | 7e876f5 | 2009-01-09 20:23:16 +0000 | [diff] [blame] | 871 | A message_body may be specified, to be appended to the request. |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 872 | """ |
| 873 | self._buffer.extend(("", "")) |
| 874 | msg = "\r\n".join(self._buffer) |
| 875 | del self._buffer[:] |
Jeremy Hylton | 0381f48 | 2008-11-29 01:09:35 +0000 | [diff] [blame] | 876 | # If msg and message_body are sent in a single send() call, |
| 877 | # it will avoid performance problems caused by the interaction |
Ezio Melotti | 24b07bc | 2011-03-15 18:55:01 +0200 | [diff] [blame] | 878 | # between delayed ack and the Nagle algorithm. |
Kristján Valur Jónsson | 7e876f5 | 2009-01-09 20:23:16 +0000 | [diff] [blame] | 879 | if isinstance(message_body, str): |
Jeremy Hylton | 0381f48 | 2008-11-29 01:09:35 +0000 | [diff] [blame] | 880 | msg += message_body |
Kristján Valur Jónsson | 7e876f5 | 2009-01-09 20:23:16 +0000 | [diff] [blame] | 881 | message_body = None |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 882 | self.send(msg) |
Kristján Valur Jónsson | 7e876f5 | 2009-01-09 20:23:16 +0000 | [diff] [blame] | 883 | if message_body is not None: |
| 884 | #message_body was not a string (i.e. it is a file) and |
| 885 | #we must run the risk of Nagle |
| 886 | self.send(message_body) |
Jeremy Hylton | 8531b1b | 2002-07-16 21:21:11 +0000 | [diff] [blame] | 887 | |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 888 | def putrequest(self, method, url, skip_host=0, skip_accept_encoding=0): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 889 | """Send a request to the server. |
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 | `method' specifies an HTTP request method, e.g. 'GET'. |
| 892 | `url' specifies the object being requested, e.g. '/index.html'. |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 893 | `skip_host' if True does not add automatically a 'Host:' header |
| 894 | `skip_accept_encoding' if True does not add automatically an |
| 895 | 'Accept-Encoding:' header |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 896 | """ |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 897 | |
Greg Stein | 616a58d | 2003-06-24 06:35:19 +0000 | [diff] [blame] | 898 | # if a prior response has been completed, then forget about it. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 899 | if self.__response and self.__response.isclosed(): |
| 900 | self.__response = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 901 | |
Tim Peters | 58eb11c | 2004-01-18 20:29:55 +0000 | [diff] [blame] | 902 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 903 | # in certain cases, we cannot issue another request on this connection. |
| 904 | # this occurs when: |
| 905 | # 1) we are in the process of sending a request. (_CS_REQ_STARTED) |
| 906 | # 2) a response to a previous request has signalled that it is going |
| 907 | # to close the connection upon completion. |
| 908 | # 3) the headers for the previous response have not been read, thus |
| 909 | # we cannot determine whether point (2) is true. (_CS_REQ_SENT) |
| 910 | # |
| 911 | # if there is no prior response, then we can request at will. |
| 912 | # |
| 913 | # if point (2) is true, then we will have passed the socket to the |
| 914 | # response (effectively meaning, "there is no prior response"), and |
| 915 | # will open a new one when a new request is made. |
| 916 | # |
| 917 | # Note: if a prior response exists, then we *can* start a new request. |
| 918 | # We are not allowed to begin fetching the response to this new |
| 919 | # request, however, until that prior response is complete. |
| 920 | # |
| 921 | if self.__state == _CS_IDLE: |
| 922 | self.__state = _CS_REQ_STARTED |
| 923 | else: |
| 924 | raise CannotSendRequest() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 925 | |
Jeremy Hylton | c1b2cb9 | 2003-05-05 16:13:58 +0000 | [diff] [blame] | 926 | # Save the method we use, we need it later in the response phase |
| 927 | self._method = method |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 928 | if not url: |
| 929 | url = '/' |
Senthil Kumaran | 452b0ce | 2010-10-02 10:43:45 +0000 | [diff] [blame] | 930 | hdr = '%s %s %s' % (method, url, self._http_vsn_str) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 931 | |
Senthil Kumaran | 452b0ce | 2010-10-02 10:43:45 +0000 | [diff] [blame] | 932 | self._output(hdr) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 933 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 934 | if self._http_vsn == 11: |
| 935 | # Issue some standard headers for better HTTP/1.1 compliance |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 936 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 937 | if not skip_host: |
| 938 | # this header is issued *only* for HTTP/1.1 |
| 939 | # connections. more specifically, this means it is |
| 940 | # only issued when the client uses the new |
| 941 | # HTTPConnection() class. backwards-compat clients |
| 942 | # will be using HTTP/1.0 and those clients may be |
| 943 | # issuing this header themselves. we should NOT issue |
| 944 | # it twice; some web servers (such as Apache) barf |
| 945 | # when they see two Host: headers |
Guido van Rossum | f6922aa | 2001-01-14 21:03:01 +0000 | [diff] [blame] | 946 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 947 | # If we need a non-standard port,include it in the |
| 948 | # header. If the request is going through a proxy, |
| 949 | # but the host of the actual URL, not the host of the |
| 950 | # proxy. |
Jeremy Hylton | 8acf1e0 | 2002-03-08 19:35:51 +0000 | [diff] [blame] | 951 | |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 952 | netloc = '' |
| 953 | if url.startswith('http'): |
| 954 | nil, netloc, nil, nil, nil = urlsplit(url) |
| 955 | |
| 956 | if netloc: |
Georg Brandl | a2ac2ef | 2006-05-03 18:03:22 +0000 | [diff] [blame] | 957 | try: |
| 958 | netloc_enc = netloc.encode("ascii") |
| 959 | except UnicodeEncodeError: |
| 960 | netloc_enc = netloc.encode("idna") |
| 961 | self.putheader('Host', netloc_enc) |
Jeremy Hylton | 3921ff6 | 2002-03-09 06:07:23 +0000 | [diff] [blame] | 962 | else: |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 963 | if self._tunnel_host: |
| 964 | host = self._tunnel_host |
| 965 | port = self._tunnel_port |
| 966 | else: |
| 967 | host = self.host |
| 968 | port = self.port |
| 969 | |
Georg Brandl | a2ac2ef | 2006-05-03 18:03:22 +0000 | [diff] [blame] | 970 | try: |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 971 | host_enc = host.encode("ascii") |
Georg Brandl | a2ac2ef | 2006-05-03 18:03:22 +0000 | [diff] [blame] | 972 | except UnicodeEncodeError: |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 973 | host_enc = host.encode("idna") |
Senthil Kumaran | 501bfd8 | 2010-11-14 03:31:52 +0000 | [diff] [blame] | 974 | # Wrap the IPv6 Host Header with [] (RFC 2732) |
| 975 | if host_enc.find(':') >= 0: |
| 976 | host_enc = "[" + host_enc + "]" |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 977 | if port == self.default_port: |
Georg Brandl | a2ac2ef | 2006-05-03 18:03:22 +0000 | [diff] [blame] | 978 | self.putheader('Host', host_enc) |
| 979 | else: |
Senthil Kumaran | 36f28f7 | 2014-05-16 18:51:46 -0700 | [diff] [blame] | 980 | self.putheader('Host', "%s:%s" % (host_enc, port)) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 981 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 982 | # note: we are assuming that clients will not attempt to set these |
| 983 | # headers since *this* library must deal with the |
| 984 | # consequences. this also means that when the supporting |
| 985 | # libraries are updated to recognize other forms, then this |
| 986 | # code should be changed (removed or updated). |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 987 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 988 | # we only want a Content-Encoding of "identity" since we don't |
| 989 | # support encodings such as x-gzip or x-deflate. |
Martin v. Löwis | af7dc8d | 2003-11-19 19:51:55 +0000 | [diff] [blame] | 990 | if not skip_accept_encoding: |
| 991 | self.putheader('Accept-Encoding', 'identity') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 992 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 993 | # we can accept "chunked" Transfer-Encodings, but no others |
| 994 | # NOTE: no TE header implies *only* "chunked" |
| 995 | #self.putheader('TE', 'chunked') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 996 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 997 | # if TE is supplied in the header, then it must appear in a |
| 998 | # Connection header. |
| 999 | #self.putheader('Connection', 'TE') |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1000 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1001 | else: |
| 1002 | # For HTTP/1.0, the server will assume "not chunked" |
| 1003 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1004 | |
Brett Cannon | e3d0bf7 | 2008-11-15 22:40:44 +0000 | [diff] [blame] | 1005 | def putheader(self, header, *values): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1006 | """Send a request header line to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1007 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1008 | For example: h.putheader('Accept', 'text/html') |
| 1009 | """ |
| 1010 | if self.__state != _CS_REQ_STARTED: |
| 1011 | raise CannotSendHeader() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1012 | |
Serhiy Storchaka | 59bdf63 | 2015-03-12 11:12:51 +0200 | [diff] [blame] | 1013 | header = '%s' % header |
| 1014 | if not _is_legal_header_name(header): |
| 1015 | raise ValueError('Invalid header name %r' % (header,)) |
| 1016 | |
| 1017 | values = [str(v) for v in values] |
| 1018 | for one_value in values: |
| 1019 | if _is_illegal_header_value(one_value): |
| 1020 | raise ValueError('Invalid header value %r' % (one_value,)) |
| 1021 | |
| 1022 | hdr = '%s: %s' % (header, '\r\n\t'.join(values)) |
Senthil Kumaran | 452b0ce | 2010-10-02 10:43:45 +0000 | [diff] [blame] | 1023 | self._output(hdr) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1024 | |
Jeremy Hylton | 0381f48 | 2008-11-29 01:09:35 +0000 | [diff] [blame] | 1025 | def endheaders(self, message_body=None): |
| 1026 | """Indicate that the last header line has been sent to the server. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1027 | |
Jeremy Hylton | 0381f48 | 2008-11-29 01:09:35 +0000 | [diff] [blame] | 1028 | This method sends the request to the server. The optional |
Senthil Kumaran | 41d663f | 2011-10-05 23:52:49 +0800 | [diff] [blame] | 1029 | message_body argument can be used to pass a message body |
Jeremy Hylton | 0381f48 | 2008-11-29 01:09:35 +0000 | [diff] [blame] | 1030 | associated with the request. The message body will be sent in |
Senthil Kumaran | 41d663f | 2011-10-05 23:52:49 +0800 | [diff] [blame] | 1031 | the same packet as the message headers if it is string, otherwise it is |
| 1032 | sent as a separate packet. |
Jeremy Hylton | 0381f48 | 2008-11-29 01:09:35 +0000 | [diff] [blame] | 1033 | """ |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1034 | if self.__state == _CS_REQ_STARTED: |
| 1035 | self.__state = _CS_REQ_SENT |
| 1036 | else: |
| 1037 | raise CannotSendHeader() |
Jeremy Hylton | 0381f48 | 2008-11-29 01:09:35 +0000 | [diff] [blame] | 1038 | self._send_output(message_body) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1039 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1040 | def request(self, method, url, body=None, headers={}): |
| 1041 | """Send a complete request to the server.""" |
Victor Stinner | 2c6aee9 | 2010-07-24 02:46:16 +0000 | [diff] [blame] | 1042 | self._send_request(method, url, body, headers) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1043 | |
R David Murray | b4b000f | 2015-03-22 15:15:44 -0400 | [diff] [blame] | 1044 | def _set_content_length(self, body, method): |
| 1045 | # Set the content-length based on the body. If the body is "empty", we |
| 1046 | # set Content-Length: 0 for methods that expect a body (RFC 7230, |
| 1047 | # Section 3.3.2). If the body is set for other methods, we set the |
| 1048 | # header provided we can figure out what the length is. |
Jeremy Hylton | 0381f48 | 2008-11-29 01:09:35 +0000 | [diff] [blame] | 1049 | thelen = None |
R David Murray | b4b000f | 2015-03-22 15:15:44 -0400 | [diff] [blame] | 1050 | if body is None and method.upper() in _METHODS_EXPECTING_BODY: |
| 1051 | thelen = '0' |
| 1052 | elif body is not None: |
Jeremy Hylton | 0381f48 | 2008-11-29 01:09:35 +0000 | [diff] [blame] | 1053 | try: |
R David Murray | b4b000f | 2015-03-22 15:15:44 -0400 | [diff] [blame] | 1054 | thelen = str(len(body)) |
Serhiy Storchaka | 80573bb | 2015-05-16 18:58:41 +0300 | [diff] [blame] | 1055 | except (TypeError, AttributeError): |
R David Murray | b4b000f | 2015-03-22 15:15:44 -0400 | [diff] [blame] | 1056 | # If this is a file-like object, try to |
| 1057 | # fstat its file descriptor |
| 1058 | try: |
| 1059 | thelen = str(os.fstat(body.fileno()).st_size) |
| 1060 | except (AttributeError, OSError): |
| 1061 | # Don't send a length if this failed |
| 1062 | if self.debuglevel > 0: print "Cannot stat!!" |
Jeremy Hylton | 0381f48 | 2008-11-29 01:09:35 +0000 | [diff] [blame] | 1063 | |
| 1064 | if thelen is not None: |
| 1065 | self.putheader('Content-Length', thelen) |
| 1066 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1067 | def _send_request(self, method, url, body, headers): |
Victor Stinner | 2c6aee9 | 2010-07-24 02:46:16 +0000 | [diff] [blame] | 1068 | # Honor explicitly requested Host: and Accept-Encoding: headers. |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 1069 | header_names = dict.fromkeys([k.lower() for k in headers]) |
| 1070 | skips = {} |
| 1071 | if 'host' in header_names: |
| 1072 | skips['skip_host'] = 1 |
| 1073 | if 'accept-encoding' in header_names: |
| 1074 | skips['skip_accept_encoding'] = 1 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1075 | |
Jeremy Hylton | 2c17825 | 2004-08-07 16:28:14 +0000 | [diff] [blame] | 1076 | self.putrequest(method, url, **skips) |
| 1077 | |
R David Murray | b4b000f | 2015-03-22 15:15:44 -0400 | [diff] [blame] | 1078 | if 'content-length' not in header_names: |
| 1079 | self._set_content_length(body, method) |
Raymond Hettinger | b2e0b92 | 2003-02-26 22:45:18 +0000 | [diff] [blame] | 1080 | for hdr, value in headers.iteritems(): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1081 | self.putheader(hdr, value) |
Kristján Valur Jónsson | 7e876f5 | 2009-01-09 20:23:16 +0000 | [diff] [blame] | 1082 | self.endheaders(body) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1083 | |
Kristján Valur Jónsson | 3c43fcb | 2009-01-11 16:23:37 +0000 | [diff] [blame] | 1084 | def getresponse(self, buffering=False): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1085 | "Get the response from the server." |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1086 | |
Greg Stein | 616a58d | 2003-06-24 06:35:19 +0000 | [diff] [blame] | 1087 | # if a prior response has been completed, then forget about it. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1088 | if self.__response and self.__response.isclosed(): |
| 1089 | self.__response = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1090 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1091 | # |
| 1092 | # if a prior response exists, then it must be completed (otherwise, we |
| 1093 | # cannot read this response's header to determine the connection-close |
| 1094 | # behavior) |
| 1095 | # |
| 1096 | # note: if a prior response existed, but was connection-close, then the |
| 1097 | # socket and response were made independent of this HTTPConnection |
| 1098 | # object since a new request requires that we open a whole new |
| 1099 | # connection |
| 1100 | # |
| 1101 | # this means the prior response had one of two states: |
| 1102 | # 1) will_close: this connection was reset and the prior socket and |
| 1103 | # response operate independently |
| 1104 | # 2) persistent: the response was retained and we await its |
| 1105 | # isclosed() status to become true. |
| 1106 | # |
| 1107 | if self.__state != _CS_REQ_SENT or self.__response: |
| 1108 | raise ResponseNotReady() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1109 | |
Kristján Valur Jónsson | 3c43fcb | 2009-01-11 16:23:37 +0000 | [diff] [blame] | 1110 | args = (self.sock,) |
| 1111 | kwds = {"strict":self.strict, "method":self._method} |
Jeremy Hylton | 30f8674 | 2000-09-18 22:50:38 +0000 | [diff] [blame] | 1112 | if self.debuglevel > 0: |
Kristján Valur Jónsson | 3c43fcb | 2009-01-11 16:23:37 +0000 | [diff] [blame] | 1113 | args += (self.debuglevel,) |
| 1114 | if buffering: |
| 1115 | #only add this keyword if non-default, for compatibility with |
| 1116 | #other response_classes. |
| 1117 | kwds["buffering"] = True; |
| 1118 | response = self.response_class(*args, **kwds) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1119 | |
Serhiy Storchaka | d862db0 | 2014-12-01 13:07:28 +0200 | [diff] [blame] | 1120 | try: |
| 1121 | response.begin() |
| 1122 | assert response.will_close != _UNKNOWN |
| 1123 | self.__state = _CS_IDLE |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1124 | |
Serhiy Storchaka | d862db0 | 2014-12-01 13:07:28 +0200 | [diff] [blame] | 1125 | if response.will_close: |
| 1126 | # this effectively passes the connection to the response |
| 1127 | self.close() |
| 1128 | else: |
| 1129 | # remember this, so we can tell when it is complete |
| 1130 | self.__response = response |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1131 | |
Serhiy Storchaka | d862db0 | 2014-12-01 13:07:28 +0200 | [diff] [blame] | 1132 | return response |
| 1133 | except: |
| 1134 | response.close() |
| 1135 | raise |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1136 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1137 | |
Jeremy Hylton | 29b8d5a | 2000-08-01 17:33:32 +0000 | [diff] [blame] | 1138 | class HTTP: |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1139 | "Compatibility class with httplib.py from 1.5." |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1140 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1141 | _http_vsn = 10 |
| 1142 | _http_vsn_str = 'HTTP/1.0' |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1143 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1144 | debuglevel = 0 |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1145 | |
Jeremy Hylton | 29b8d5a | 2000-08-01 17:33:32 +0000 | [diff] [blame] | 1146 | _connection_class = HTTPConnection |
| 1147 | |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1148 | def __init__(self, host='', port=None, strict=None): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1149 | "Provide a default host, since the superclass requires one." |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1150 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1151 | # some joker passed 0 explicitly, meaning default port |
| 1152 | if port == 0: |
| 1153 | port = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1154 | |
Andrew Svetlov | 4bb142b | 2012-12-18 21:27:37 +0200 | [diff] [blame] | 1155 | # Note that we may pass an empty string as the host; this will raise |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1156 | # an error when we attempt to connect. Presumably, the client code |
| 1157 | # will call connect before then, with a proper host. |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1158 | self._setup(self._connection_class(host, port, strict)) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1159 | |
Greg Stein | 81937a4 | 2001-08-18 09:20:23 +0000 | [diff] [blame] | 1160 | def _setup(self, conn): |
| 1161 | self._conn = conn |
| 1162 | |
| 1163 | # set up delegation to flesh out interface |
| 1164 | self.send = conn.send |
| 1165 | self.putrequest = conn.putrequest |
Brett Cannon | e3d0bf7 | 2008-11-15 22:40:44 +0000 | [diff] [blame] | 1166 | self.putheader = conn.putheader |
Greg Stein | 81937a4 | 2001-08-18 09:20:23 +0000 | [diff] [blame] | 1167 | self.endheaders = conn.endheaders |
| 1168 | self.set_debuglevel = conn.set_debuglevel |
| 1169 | |
| 1170 | conn._http_vsn = self._http_vsn |
| 1171 | conn._http_vsn_str = self._http_vsn_str |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1172 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1173 | self.file = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1174 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1175 | def connect(self, host=None, port=None): |
| 1176 | "Accept arguments to set the host/port, since the superclass doesn't." |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1177 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1178 | if host is not None: |
Senthil Kumaran | 812b975 | 2015-01-24 12:58:10 -0800 | [diff] [blame] | 1179 | (self._conn.host, self._conn.port) = self._conn._get_hostport(host, port) |
Jeremy Hylton | 29b8d5a | 2000-08-01 17:33:32 +0000 | [diff] [blame] | 1180 | self._conn.connect() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1181 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1182 | def getfile(self): |
| 1183 | "Provide a getfile, since the superclass' does not use this concept." |
| 1184 | return self.file |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1185 | |
Kristján Valur Jónsson | 3c43fcb | 2009-01-11 16:23:37 +0000 | [diff] [blame] | 1186 | def getreply(self, buffering=False): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1187 | """Compat definition since superclass does not define it. |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1188 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1189 | Returns a tuple consisting of: |
| 1190 | - server status code (e.g. '200' if all goes well) |
| 1191 | - server "reason" corresponding to status code |
| 1192 | - any RFC822 headers in the response from the server |
| 1193 | """ |
| 1194 | try: |
Kristján Valur Jónsson | 3c43fcb | 2009-01-11 16:23:37 +0000 | [diff] [blame] | 1195 | if not buffering: |
| 1196 | response = self._conn.getresponse() |
| 1197 | else: |
| 1198 | #only add this keyword if non-default for compatibility |
| 1199 | #with other connection classes |
| 1200 | response = self._conn.getresponse(buffering) |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1201 | except BadStatusLine, e: |
| 1202 | ### hmm. if getresponse() ever closes the socket on a bad request, |
| 1203 | ### then we are going to have problems with self.sock |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1204 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1205 | ### should we keep this behavior? do people use it? |
| 1206 | # keep the socket open (as a file), and return it |
Jeremy Hylton | 29b8d5a | 2000-08-01 17:33:32 +0000 | [diff] [blame] | 1207 | self.file = self._conn.sock.makefile('rb', 0) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1208 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1209 | # close our socket -- we want to restart after any protocol error |
| 1210 | self.close() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1211 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1212 | self.headers = None |
| 1213 | return -1, e.line, None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1214 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1215 | self.headers = response.msg |
| 1216 | self.file = response.fp |
| 1217 | return response.status, response.reason, response.msg |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1218 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1219 | def close(self): |
Jeremy Hylton | 29b8d5a | 2000-08-01 17:33:32 +0000 | [diff] [blame] | 1220 | self._conn.close() |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1221 | |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1222 | # note that self.file == response.fp, which gets closed by the |
| 1223 | # superclass. just clear the object ref here. |
| 1224 | ### hmm. messy. if status==-1, then self.file is owned by us. |
| 1225 | ### well... we aren't explicitly closing, but losing this ref will |
| 1226 | ### do it |
| 1227 | self.file = None |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1228 | |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 1229 | try: |
| 1230 | import ssl |
| 1231 | except ImportError: |
| 1232 | pass |
| 1233 | else: |
| 1234 | class HTTPSConnection(HTTPConnection): |
| 1235 | "This class allows communication via SSL." |
| 1236 | |
| 1237 | default_port = HTTPS_PORT |
| 1238 | |
| 1239 | def __init__(self, host, port=None, key_file=None, cert_file=None, |
Gregory P. Smith | 9d32521 | 2010-01-03 02:06:07 +0000 | [diff] [blame] | 1240 | strict=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT, |
Benjamin Peterson | 227f6e0 | 2014-12-07 13:41:26 -0500 | [diff] [blame] | 1241 | source_address=None, context=None): |
Gregory P. Smith | 9d32521 | 2010-01-03 02:06:07 +0000 | [diff] [blame] | 1242 | HTTPConnection.__init__(self, host, port, strict, timeout, |
| 1243 | source_address) |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 1244 | self.key_file = key_file |
| 1245 | self.cert_file = cert_file |
Benjamin Peterson | fcfb18e | 2014-11-23 11:42:45 -0600 | [diff] [blame] | 1246 | if context is None: |
Benjamin Peterson | e3e7d40 | 2014-11-23 21:02:02 -0600 | [diff] [blame] | 1247 | context = ssl._create_default_https_context() |
Benjamin Peterson | fcfb18e | 2014-11-23 11:42:45 -0600 | [diff] [blame] | 1248 | if key_file or cert_file: |
| 1249 | context.load_cert_chain(cert_file, key_file) |
| 1250 | self._context = context |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 1251 | |
| 1252 | def connect(self): |
| 1253 | "Connect to a host on a given (SSL) port." |
| 1254 | |
Benjamin Peterson | fcfb18e | 2014-11-23 11:42:45 -0600 | [diff] [blame] | 1255 | HTTPConnection.connect(self) |
| 1256 | |
Senthil Kumaran | e266f25 | 2009-05-24 09:14:50 +0000 | [diff] [blame] | 1257 | if self._tunnel_host: |
Benjamin Peterson | fcfb18e | 2014-11-23 11:42:45 -0600 | [diff] [blame] | 1258 | server_hostname = self._tunnel_host |
| 1259 | else: |
| 1260 | server_hostname = self.host |
Benjamin Peterson | fcfb18e | 2014-11-23 11:42:45 -0600 | [diff] [blame] | 1261 | |
| 1262 | self.sock = self._context.wrap_socket(self.sock, |
Benjamin Peterson | 31aa69e | 2014-11-23 20:13:31 -0600 | [diff] [blame] | 1263 | server_hostname=server_hostname) |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 1264 | |
Thomas Wouters | a6900e8 | 2007-08-30 21:54:39 +0000 | [diff] [blame] | 1265 | __all__.append("HTTPSConnection") |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 1266 | |
Jeremy Hylton | 29b8d5a | 2000-08-01 17:33:32 +0000 | [diff] [blame] | 1267 | class HTTPS(HTTP): |
| 1268 | """Compatibility with 1.5 httplib interface |
| 1269 | |
| 1270 | Python 1.5.2 did not have an HTTPS class, but it defined an |
| 1271 | interface for sending http requests that is also useful for |
Tim Peters | 5ceadc8 | 2001-01-13 19:16:21 +0000 | [diff] [blame] | 1272 | https. |
Jeremy Hylton | 29b8d5a | 2000-08-01 17:33:32 +0000 | [diff] [blame] | 1273 | """ |
| 1274 | |
Martin v. Löwis | d7bf974 | 2000-09-21 22:09:47 +0000 | [diff] [blame] | 1275 | _connection_class = HTTPSConnection |
Tim Peters | 5ceadc8 | 2001-01-13 19:16:21 +0000 | [diff] [blame] | 1276 | |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1277 | def __init__(self, host='', port=None, key_file=None, cert_file=None, |
Benjamin Peterson | b206473 | 2014-11-23 20:55:24 -0600 | [diff] [blame] | 1278 | strict=None, context=None): |
Greg Stein | 81937a4 | 2001-08-18 09:20:23 +0000 | [diff] [blame] | 1279 | # provide a default host, pass the X509 cert info |
| 1280 | |
| 1281 | # urf. compensate for bad input. |
| 1282 | if port == 0: |
| 1283 | port = None |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1284 | self._setup(self._connection_class(host, port, key_file, |
Benjamin Peterson | b206473 | 2014-11-23 20:55:24 -0600 | [diff] [blame] | 1285 | cert_file, strict, |
| 1286 | context=context)) |
Greg Stein | 81937a4 | 2001-08-18 09:20:23 +0000 | [diff] [blame] | 1287 | |
| 1288 | # we never actually use these for anything, but we keep them |
| 1289 | # here for compatibility with post-1.5.2 CVS. |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1290 | self.key_file = key_file |
| 1291 | self.cert_file = cert_file |
Greg Stein | 81937a4 | 2001-08-18 09:20:23 +0000 | [diff] [blame] | 1292 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1293 | |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 1294 | def FakeSocket (sock, sslobj): |
Bill Janssen | c459264 | 2007-08-31 19:02:23 +0000 | [diff] [blame] | 1295 | warnings.warn("FakeSocket is deprecated, and won't be in 3.x. " + |
Bill Janssen | 98d19da | 2007-09-10 21:51:02 +0000 | [diff] [blame] | 1296 | "Use the result of ssl.wrap_socket() directly instead.", |
Bill Janssen | c459264 | 2007-08-31 19:02:23 +0000 | [diff] [blame] | 1297 | DeprecationWarning, stacklevel=2) |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 1298 | return sslobj |
| 1299 | |
| 1300 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1301 | class HTTPException(Exception): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1302 | # Subclasses that define an __init__ must call Exception.__init__ |
| 1303 | # or define self.args. Otherwise, str() will fail. |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1304 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1305 | |
| 1306 | class NotConnected(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1307 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1308 | |
Skip Montanaro | 9d38997 | 2002-03-24 16:53:50 +0000 | [diff] [blame] | 1309 | class InvalidURL(HTTPException): |
| 1310 | pass |
| 1311 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1312 | class UnknownProtocol(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1313 | def __init__(self, version): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1314 | self.args = version, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1315 | self.version = version |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1316 | |
| 1317 | class UnknownTransferEncoding(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1318 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1319 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1320 | class UnimplementedFileMode(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1321 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1322 | |
| 1323 | class IncompleteRead(HTTPException): |
Benjamin Peterson | 7d49bba | 2009-03-02 22:41:42 +0000 | [diff] [blame] | 1324 | def __init__(self, partial, expected=None): |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1325 | self.args = partial, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1326 | self.partial = partial |
Benjamin Peterson | 7d49bba | 2009-03-02 22:41:42 +0000 | [diff] [blame] | 1327 | self.expected = expected |
| 1328 | def __repr__(self): |
| 1329 | if self.expected is not None: |
| 1330 | e = ', %i more expected' % self.expected |
| 1331 | else: |
| 1332 | e = '' |
| 1333 | return 'IncompleteRead(%i bytes read%s)' % (len(self.partial), e) |
| 1334 | def __str__(self): |
| 1335 | return repr(self) |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1336 | |
| 1337 | class ImproperConnectionState(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1338 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1339 | |
| 1340 | class CannotSendRequest(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1341 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1342 | |
| 1343 | class CannotSendHeader(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1344 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1345 | |
| 1346 | class ResponseNotReady(ImproperConnectionState): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1347 | pass |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1348 | |
| 1349 | class BadStatusLine(HTTPException): |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1350 | def __init__(self, line): |
Dirkjan Ochtman | ebc73dc | 2010-02-24 04:49:00 +0000 | [diff] [blame] | 1351 | if not line: |
| 1352 | line = repr(line) |
Jeremy Hylton | 12f4f35 | 2002-07-06 18:55:01 +0000 | [diff] [blame] | 1353 | self.args = line, |
Greg Stein | dd6eefb | 2000-07-18 09:09:48 +0000 | [diff] [blame] | 1354 | self.line = line |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1355 | |
Antoine Pitrou | d7b6ac6 | 2010-12-18 18:18:21 +0000 | [diff] [blame] | 1356 | class LineTooLong(HTTPException): |
| 1357 | def __init__(self, line_type): |
| 1358 | HTTPException.__init__(self, "got more than %d bytes when reading %s" |
| 1359 | % (_MAXLINE, line_type)) |
| 1360 | |
Greg Stein | 5e0fa40 | 2000-06-26 08:28:01 +0000 | [diff] [blame] | 1361 | # for backwards compatibility |
| 1362 | error = HTTPException |
| 1363 | |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1364 | class LineAndFileWrapper: |
| 1365 | """A limited file-like object for HTTP/0.9 responses.""" |
| 1366 | |
| 1367 | # The status-line parsing code calls readline(), which normally |
| 1368 | # get the HTTP status line. For a 0.9 response, however, this is |
| 1369 | # actually the first line of the body! Clients need to get a |
| 1370 | # readable file object that contains that line. |
| 1371 | |
| 1372 | def __init__(self, line, file): |
| 1373 | self._line = line |
| 1374 | self._file = file |
| 1375 | self._line_consumed = 0 |
| 1376 | self._line_offset = 0 |
| 1377 | self._line_left = len(line) |
| 1378 | |
| 1379 | def __getattr__(self, attr): |
| 1380 | return getattr(self._file, attr) |
| 1381 | |
| 1382 | def _done(self): |
| 1383 | # called when the last byte is read from the line. After the |
| 1384 | # call, all read methods are delegated to the underlying file |
Skip Montanaro | 74b9a7a | 2003-02-25 17:48:15 +0000 | [diff] [blame] | 1385 | # object. |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1386 | self._line_consumed = 1 |
| 1387 | self.read = self._file.read |
| 1388 | self.readline = self._file.readline |
| 1389 | self.readlines = self._file.readlines |
| 1390 | |
| 1391 | def read(self, amt=None): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1392 | if self._line_consumed: |
| 1393 | return self._file.read(amt) |
| 1394 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1395 | if amt is None or amt > self._line_left: |
| 1396 | s = self._line[self._line_offset:] |
| 1397 | self._done() |
| 1398 | if amt is None: |
| 1399 | return s + self._file.read() |
| 1400 | else: |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 1401 | return s + self._file.read(amt - len(s)) |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1402 | else: |
| 1403 | assert amt <= self._line_left |
| 1404 | i = self._line_offset |
| 1405 | j = i + amt |
| 1406 | s = self._line[i:j] |
| 1407 | self._line_offset = j |
| 1408 | self._line_left -= amt |
| 1409 | if self._line_left == 0: |
| 1410 | self._done() |
| 1411 | return s |
Tim Peters | c411dba | 2002-07-16 21:35:23 +0000 | [diff] [blame] | 1412 | |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1413 | def readline(self): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1414 | if self._line_consumed: |
| 1415 | return self._file.readline() |
| 1416 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1417 | s = self._line[self._line_offset:] |
| 1418 | self._done() |
| 1419 | return s |
| 1420 | |
| 1421 | def readlines(self, size=None): |
Hye-Shik Chang | 39aef79 | 2004-06-05 13:30:56 +0000 | [diff] [blame] | 1422 | if self._line_consumed: |
| 1423 | return self._file.readlines(size) |
| 1424 | assert self._line_left |
Jeremy Hylton | d46aa37 | 2002-07-06 18:48:07 +0000 | [diff] [blame] | 1425 | L = [self._line[self._line_offset:]] |
| 1426 | self._done() |
| 1427 | if size is None: |
| 1428 | return L + self._file.readlines() |
| 1429 | else: |
| 1430 | return L + self._file.readlines(size) |