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