Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1 | """An extensible library for opening URLs using a variety of protocols |
| 2 | |
| 3 | The simplest way to use this module is to call the urlopen function, |
| 4 | which accepts a string containing a URL or a Request object (described |
| 5 | below). It opens the URL and returns the results as file-like |
| 6 | object; the returned object has some extra methods described below. |
| 7 | |
| 8 | The OpenerDirector manages a collection of Handler objects that do |
| 9 | all the actual work. Each Handler implements a particular protocol or |
| 10 | option. The OpenerDirector is a composite object that invokes the |
| 11 | Handlers needed to open the requested URL. For example, the |
| 12 | HTTPHandler performs HTTP GET and POST requests and deals with |
| 13 | non-error returns. The HTTPRedirectHandler automatically deals with |
| 14 | HTTP 301, 302, 303 and 307 redirect errors, and the HTTPDigestAuthHandler |
| 15 | deals with digest authentication. |
| 16 | |
| 17 | urlopen(url, data=None) -- Basic usage is the same as original |
| 18 | urllib. pass the url and optionally data to post to an HTTP URL, and |
| 19 | get a file-like object back. One difference is that you can also pass |
| 20 | a Request instance instead of URL. Raises a URLError (subclass of |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 21 | OSError); for HTTP errors, raises an HTTPError, which can also be |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 22 | treated as a valid response. |
| 23 | |
| 24 | build_opener -- Function that creates a new OpenerDirector instance. |
| 25 | Will install the default handlers. Accepts one or more Handlers as |
| 26 | arguments, either instances or Handler classes that it will |
| 27 | instantiate. If one of the argument is a subclass of the default |
| 28 | handler, the argument will be installed instead of the default. |
| 29 | |
| 30 | install_opener -- Installs a new opener as the default opener. |
| 31 | |
| 32 | objects of interest: |
Senthil Kumaran | 1107c5d | 2009-11-15 06:20:55 +0000 | [diff] [blame] | 33 | |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 34 | OpenerDirector -- Sets up the User Agent as the Python-urllib client and manages |
| 35 | the Handler classes, while dealing with requests and responses. |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 36 | |
| 37 | Request -- An object that encapsulates the state of a request. The |
| 38 | state can be as simple as the URL. It can also include extra HTTP |
| 39 | headers, e.g. a User-Agent. |
| 40 | |
| 41 | BaseHandler -- |
| 42 | |
| 43 | internals: |
| 44 | BaseHandler and parent |
| 45 | _call_chain conventions |
| 46 | |
| 47 | Example usage: |
| 48 | |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 49 | import urllib.request |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 50 | |
| 51 | # set up authentication info |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 52 | authinfo = urllib.request.HTTPBasicAuthHandler() |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 53 | authinfo.add_password(realm='PDQ Application', |
| 54 | uri='https://mahler:8092/site-updates.py', |
| 55 | user='klem', |
| 56 | passwd='geheim$parole') |
| 57 | |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 58 | proxy_support = urllib.request.ProxyHandler({"http" : "http://ahad-haam:3128"}) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 59 | |
| 60 | # build a new opener that adds authentication and caching FTP handlers |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 61 | opener = urllib.request.build_opener(proxy_support, authinfo, |
| 62 | urllib.request.CacheFTPHandler) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 63 | |
| 64 | # install it |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 65 | urllib.request.install_opener(opener) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 66 | |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 67 | f = urllib.request.urlopen('http://www.python.org/') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 68 | """ |
| 69 | |
| 70 | # XXX issues: |
| 71 | # If an authentication error handler that tries to perform |
| 72 | # authentication for some reason but fails, how should the error be |
| 73 | # signalled? The client needs to know the HTTP error code. But if |
| 74 | # the handler knows that the problem was, e.g., that it didn't know |
| 75 | # that hash algo that requested in the challenge, it would be good to |
| 76 | # pass that information along to the client, too. |
| 77 | # ftp errors aren't handled cleanly |
| 78 | # check digest against correct (i.e. non-apache) implementation |
| 79 | |
| 80 | # Possible extensions: |
| 81 | # complex proxies XXX not sure what exactly was meant by this |
| 82 | # abstract factory for opener |
| 83 | |
| 84 | import base64 |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 85 | import bisect |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 86 | import email |
| 87 | import hashlib |
| 88 | import http.client |
| 89 | import io |
| 90 | import os |
| 91 | import posixpath |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 92 | import re |
| 93 | import socket |
| 94 | import sys |
| 95 | import time |
Senthil Kumaran | 7bc0d87 | 2010-12-19 10:49:52 +0000 | [diff] [blame] | 96 | import collections |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 97 | import tempfile |
| 98 | import contextlib |
Senthil Kumaran | 38b968b9 | 2012-03-14 13:43:53 -0700 | [diff] [blame] | 99 | import warnings |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 100 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 101 | |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 102 | from urllib.error import URLError, HTTPError, ContentTooShortError |
| 103 | from urllib.parse import ( |
| 104 | urlparse, urlsplit, urljoin, unwrap, quote, unquote, |
| 105 | splittype, splithost, splitport, splituser, splitpasswd, |
Antoine Pitrou | df204be | 2012-11-24 17:59:08 +0100 | [diff] [blame] | 106 | splitattr, splitquery, splitvalue, splittag, to_bytes, |
| 107 | unquote_to_bytes, urlunparse) |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 108 | from urllib.response import addinfourl, addclosehook |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 109 | |
| 110 | # check for SSL |
| 111 | try: |
| 112 | import ssl |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 113 | except ImportError: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 114 | _have_ssl = False |
| 115 | else: |
| 116 | _have_ssl = True |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 117 | |
Senthil Kumaran | 6c5bd40 | 2011-11-01 23:20:31 +0800 | [diff] [blame] | 118 | __all__ = [ |
| 119 | # Classes |
| 120 | 'Request', 'OpenerDirector', 'BaseHandler', 'HTTPDefaultErrorHandler', |
| 121 | 'HTTPRedirectHandler', 'HTTPCookieProcessor', 'ProxyHandler', |
| 122 | 'HTTPPasswordMgr', 'HTTPPasswordMgrWithDefaultRealm', |
| 123 | 'AbstractBasicAuthHandler', 'HTTPBasicAuthHandler', 'ProxyBasicAuthHandler', |
| 124 | 'AbstractDigestAuthHandler', 'HTTPDigestAuthHandler', 'ProxyDigestAuthHandler', |
Antoine Pitrou | df204be | 2012-11-24 17:59:08 +0100 | [diff] [blame] | 125 | 'HTTPHandler', 'FileHandler', 'FTPHandler', 'CacheFTPHandler', 'DataHandler', |
Senthil Kumaran | 6c5bd40 | 2011-11-01 23:20:31 +0800 | [diff] [blame] | 126 | 'UnknownHandler', 'HTTPErrorProcessor', |
| 127 | # Functions |
| 128 | 'urlopen', 'install_opener', 'build_opener', |
| 129 | 'pathname2url', 'url2pathname', 'getproxies', |
| 130 | # Legacy interface |
| 131 | 'urlretrieve', 'urlcleanup', 'URLopener', 'FancyURLopener', |
| 132 | ] |
| 133 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 134 | # used in User-Agent header sent |
| 135 | __version__ = sys.version[:3] |
| 136 | |
| 137 | _opener = None |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 138 | def urlopen(url, data=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT, |
Senthil Kumaran | a5c85b3 | 2014-09-19 15:23:30 +0800 | [diff] [blame] | 139 | *, cafile=None, capath=None, cadefault=False, context=None): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 140 | global _opener |
Antoine Pitrou | de9ac6c | 2012-05-16 21:40:01 +0200 | [diff] [blame] | 141 | if cafile or capath or cadefault: |
Senthil Kumaran | a5c85b3 | 2014-09-19 15:23:30 +0800 | [diff] [blame] | 142 | if context is not None: |
| 143 | raise ValueError( |
| 144 | "You can't pass both context and any of cafile, capath, and " |
| 145 | "cadefault" |
| 146 | ) |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 147 | if not _have_ssl: |
| 148 | raise ValueError('SSL support not available') |
Benjamin Peterson | b666697 | 2014-12-07 13:46:02 -0500 | [diff] [blame] | 149 | context = ssl.create_default_context(ssl.Purpose.SERVER_AUTH, |
Christian Heimes | 67986f9 | 2013-11-23 22:43:47 +0100 | [diff] [blame] | 150 | cafile=cafile, |
| 151 | capath=capath) |
Benjamin Peterson | b666697 | 2014-12-07 13:46:02 -0500 | [diff] [blame] | 152 | https_handler = HTTPSHandler(context=context) |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 153 | opener = build_opener(https_handler) |
Senthil Kumaran | a5c85b3 | 2014-09-19 15:23:30 +0800 | [diff] [blame] | 154 | elif context: |
| 155 | https_handler = HTTPSHandler(context=context) |
| 156 | opener = build_opener(https_handler) |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 157 | elif _opener is None: |
| 158 | _opener = opener = build_opener() |
| 159 | else: |
| 160 | opener = _opener |
| 161 | return opener.open(url, data, timeout) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 162 | |
| 163 | def install_opener(opener): |
| 164 | global _opener |
| 165 | _opener = opener |
| 166 | |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 167 | _url_tempfiles = [] |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 168 | def urlretrieve(url, filename=None, reporthook=None, data=None): |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 169 | """ |
| 170 | Retrieve a URL into a temporary location on disk. |
| 171 | |
| 172 | Requires a URL argument. If a filename is passed, it is used as |
| 173 | the temporary file location. The reporthook argument should be |
| 174 | a callable that accepts a block number, a read size, and the |
| 175 | total file size of the URL target. The data argument should be |
| 176 | valid URL encoded data. |
| 177 | |
| 178 | If a filename is passed and the URL points to a local resource, |
| 179 | the result is a copy from local file to new file. |
| 180 | |
| 181 | Returns a tuple containing the path to the newly created |
| 182 | data file as well as the resulting HTTPMessage object. |
| 183 | """ |
| 184 | url_type, path = splittype(url) |
| 185 | |
| 186 | with contextlib.closing(urlopen(url, data)) as fp: |
| 187 | headers = fp.info() |
| 188 | |
| 189 | # Just return the local path and the "headers" for file:// |
| 190 | # URLs. No sense in performing a copy unless requested. |
| 191 | if url_type == "file" and not filename: |
| 192 | return os.path.normpath(path), headers |
| 193 | |
| 194 | # Handle temporary file setup. |
| 195 | if filename: |
| 196 | tfp = open(filename, 'wb') |
| 197 | else: |
| 198 | tfp = tempfile.NamedTemporaryFile(delete=False) |
| 199 | filename = tfp.name |
| 200 | _url_tempfiles.append(filename) |
| 201 | |
| 202 | with tfp: |
| 203 | result = filename, headers |
| 204 | bs = 1024*8 |
| 205 | size = -1 |
| 206 | read = 0 |
| 207 | blocknum = 0 |
| 208 | if "content-length" in headers: |
| 209 | size = int(headers["Content-Length"]) |
| 210 | |
| 211 | if reporthook: |
Gregory P. Smith | 6b0bdab | 2012-11-10 13:43:44 -0800 | [diff] [blame] | 212 | reporthook(blocknum, bs, size) |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 213 | |
| 214 | while True: |
| 215 | block = fp.read(bs) |
| 216 | if not block: |
| 217 | break |
| 218 | read += len(block) |
| 219 | tfp.write(block) |
| 220 | blocknum += 1 |
| 221 | if reporthook: |
Gregory P. Smith | 6b0bdab | 2012-11-10 13:43:44 -0800 | [diff] [blame] | 222 | reporthook(blocknum, bs, size) |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 223 | |
| 224 | if size >= 0 and read < size: |
| 225 | raise ContentTooShortError( |
| 226 | "retrieval incomplete: got only %i out of %i bytes" |
| 227 | % (read, size), result) |
| 228 | |
| 229 | return result |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 230 | |
| 231 | def urlcleanup(): |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 232 | for temp_file in _url_tempfiles: |
| 233 | try: |
| 234 | os.unlink(temp_file) |
Andrew Svetlov | 3438fa4 | 2012-12-17 23:35:18 +0200 | [diff] [blame] | 235 | except OSError: |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 236 | pass |
| 237 | |
| 238 | del _url_tempfiles[:] |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 239 | global _opener |
| 240 | if _opener: |
| 241 | _opener = None |
| 242 | |
| 243 | # copied from cookielib.py |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 244 | _cut_port_re = re.compile(r":\d+$", re.ASCII) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 245 | def request_host(request): |
| 246 | """Return request-host, as defined by RFC 2965. |
| 247 | |
| 248 | Variation from RFC: returned value is lowercased, for convenient |
| 249 | comparison. |
| 250 | |
| 251 | """ |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 252 | url = request.full_url |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 253 | host = urlparse(url)[1] |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 254 | if host == "": |
| 255 | host = request.get_header("Host", "") |
| 256 | |
| 257 | # remove port, if present |
| 258 | host = _cut_port_re.sub("", host, 1) |
| 259 | return host.lower() |
| 260 | |
| 261 | class Request: |
| 262 | |
| 263 | def __init__(self, url, data=None, headers={}, |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 264 | origin_req_host=None, unverifiable=False, |
| 265 | method=None): |
Senthil Kumaran | 5238092 | 2013-04-25 05:45:48 -0700 | [diff] [blame] | 266 | self.full_url = url |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 267 | self.headers = {} |
Andrew Svetlov | bff98fe | 2012-11-27 23:06:19 +0200 | [diff] [blame] | 268 | self.unredirected_hdrs = {} |
| 269 | self._data = None |
| 270 | self.data = data |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 271 | self._tunnel_host = None |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 272 | for key, value in headers.items(): |
| 273 | self.add_header(key, value) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 274 | if origin_req_host is None: |
| 275 | origin_req_host = request_host(self) |
| 276 | self.origin_req_host = origin_req_host |
| 277 | self.unverifiable = unverifiable |
Jason R. Coombs | 7dc4f4b | 2013-09-08 12:47:07 -0400 | [diff] [blame] | 278 | if method: |
| 279 | self.method = method |
Senthil Kumaran | 5238092 | 2013-04-25 05:45:48 -0700 | [diff] [blame] | 280 | |
| 281 | @property |
| 282 | def full_url(self): |
Senthil Kumaran | 8307075 | 2013-05-24 09:14:12 -0700 | [diff] [blame] | 283 | if self.fragment: |
| 284 | return '{}#{}'.format(self._full_url, self.fragment) |
Senthil Kumaran | 5238092 | 2013-04-25 05:45:48 -0700 | [diff] [blame] | 285 | return self._full_url |
| 286 | |
| 287 | @full_url.setter |
| 288 | def full_url(self, url): |
| 289 | # unwrap('<URL:type://host/path>') --> 'type://host/path' |
| 290 | self._full_url = unwrap(url) |
| 291 | self._full_url, self.fragment = splittag(self._full_url) |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 292 | self._parse() |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 293 | |
Senthil Kumaran | 5238092 | 2013-04-25 05:45:48 -0700 | [diff] [blame] | 294 | @full_url.deleter |
| 295 | def full_url(self): |
| 296 | self._full_url = None |
| 297 | self.fragment = None |
| 298 | self.selector = '' |
| 299 | |
Andrew Svetlov | bff98fe | 2012-11-27 23:06:19 +0200 | [diff] [blame] | 300 | @property |
| 301 | def data(self): |
| 302 | return self._data |
| 303 | |
| 304 | @data.setter |
| 305 | def data(self, data): |
| 306 | if data != self._data: |
| 307 | self._data = data |
| 308 | # issue 16464 |
| 309 | # if we change data we need to remove content-length header |
| 310 | # (cause it's most probably calculated for previous value) |
| 311 | if self.has_header("Content-length"): |
| 312 | self.remove_header("Content-length") |
| 313 | |
| 314 | @data.deleter |
| 315 | def data(self): |
R David Murray | 9cc7d45 | 2013-03-20 00:10:51 -0400 | [diff] [blame] | 316 | self.data = None |
Andrew Svetlov | bff98fe | 2012-11-27 23:06:19 +0200 | [diff] [blame] | 317 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 318 | def _parse(self): |
Senthil Kumaran | 5238092 | 2013-04-25 05:45:48 -0700 | [diff] [blame] | 319 | self.type, rest = splittype(self._full_url) |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 320 | if self.type is None: |
R David Murray | d8a4696 | 2013-04-03 06:58:34 -0400 | [diff] [blame] | 321 | raise ValueError("unknown url type: %r" % self.full_url) |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 322 | self.host, self.selector = splithost(rest) |
| 323 | if self.host: |
| 324 | self.host = unquote(self.host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 325 | |
| 326 | def get_method(self): |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 327 | """Return a string indicating the HTTP request method.""" |
Jason R. Coombs | aae6a1d | 2013-09-08 12:54:33 -0400 | [diff] [blame] | 328 | default_method = "POST" if self.data is not None else "GET" |
| 329 | return getattr(self, 'method', default_method) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 330 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 331 | def get_full_url(self): |
Senthil Kumaran | 5238092 | 2013-04-25 05:45:48 -0700 | [diff] [blame] | 332 | return self.full_url |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 333 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 334 | def set_proxy(self, host, type): |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 335 | if self.type == 'https' and not self._tunnel_host: |
| 336 | self._tunnel_host = self.host |
| 337 | else: |
| 338 | self.type= type |
| 339 | self.selector = self.full_url |
| 340 | self.host = host |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 341 | |
| 342 | def has_proxy(self): |
| 343 | return self.selector == self.full_url |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 344 | |
| 345 | def add_header(self, key, val): |
| 346 | # useful for something like authentication |
| 347 | self.headers[key.capitalize()] = val |
| 348 | |
| 349 | def add_unredirected_header(self, key, val): |
| 350 | # will not be added to a redirected request |
| 351 | self.unredirected_hdrs[key.capitalize()] = val |
| 352 | |
| 353 | def has_header(self, header_name): |
| 354 | return (header_name in self.headers or |
| 355 | header_name in self.unredirected_hdrs) |
| 356 | |
| 357 | def get_header(self, header_name, default=None): |
| 358 | return self.headers.get( |
| 359 | header_name, |
| 360 | self.unredirected_hdrs.get(header_name, default)) |
| 361 | |
Andrew Svetlov | bff98fe | 2012-11-27 23:06:19 +0200 | [diff] [blame] | 362 | def remove_header(self, header_name): |
| 363 | self.headers.pop(header_name, None) |
| 364 | self.unredirected_hdrs.pop(header_name, None) |
| 365 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 366 | def header_items(self): |
| 367 | hdrs = self.unredirected_hdrs.copy() |
| 368 | hdrs.update(self.headers) |
| 369 | return list(hdrs.items()) |
| 370 | |
| 371 | class OpenerDirector: |
| 372 | def __init__(self): |
| 373 | client_version = "Python-urllib/%s" % __version__ |
| 374 | self.addheaders = [('User-agent', client_version)] |
R. David Murray | 25b8cca | 2010-12-23 19:44:49 +0000 | [diff] [blame] | 375 | # self.handlers is retained only for backward compatibility |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 376 | self.handlers = [] |
R. David Murray | 25b8cca | 2010-12-23 19:44:49 +0000 | [diff] [blame] | 377 | # manage the individual handlers |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 378 | self.handle_open = {} |
| 379 | self.handle_error = {} |
| 380 | self.process_response = {} |
| 381 | self.process_request = {} |
| 382 | |
| 383 | def add_handler(self, handler): |
| 384 | if not hasattr(handler, "add_parent"): |
| 385 | raise TypeError("expected BaseHandler instance, got %r" % |
| 386 | type(handler)) |
| 387 | |
| 388 | added = False |
| 389 | for meth in dir(handler): |
| 390 | if meth in ["redirect_request", "do_open", "proxy_open"]: |
| 391 | # oops, coincidental match |
| 392 | continue |
| 393 | |
| 394 | i = meth.find("_") |
| 395 | protocol = meth[:i] |
| 396 | condition = meth[i+1:] |
| 397 | |
| 398 | if condition.startswith("error"): |
| 399 | j = condition.find("_") + i + 1 |
| 400 | kind = meth[j+1:] |
| 401 | try: |
| 402 | kind = int(kind) |
| 403 | except ValueError: |
| 404 | pass |
| 405 | lookup = self.handle_error.get(protocol, {}) |
| 406 | self.handle_error[protocol] = lookup |
| 407 | elif condition == "open": |
| 408 | kind = protocol |
| 409 | lookup = self.handle_open |
| 410 | elif condition == "response": |
| 411 | kind = protocol |
| 412 | lookup = self.process_response |
| 413 | elif condition == "request": |
| 414 | kind = protocol |
| 415 | lookup = self.process_request |
| 416 | else: |
| 417 | continue |
| 418 | |
| 419 | handlers = lookup.setdefault(kind, []) |
| 420 | if handlers: |
| 421 | bisect.insort(handlers, handler) |
| 422 | else: |
| 423 | handlers.append(handler) |
| 424 | added = True |
| 425 | |
| 426 | if added: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 427 | bisect.insort(self.handlers, handler) |
| 428 | handler.add_parent(self) |
| 429 | |
| 430 | def close(self): |
| 431 | # Only exists for backwards compatibility. |
| 432 | pass |
| 433 | |
| 434 | def _call_chain(self, chain, kind, meth_name, *args): |
| 435 | # Handlers raise an exception if no one else should try to handle |
| 436 | # the request, or return None if they can't but another handler |
| 437 | # could. Otherwise, they return the response. |
| 438 | handlers = chain.get(kind, ()) |
| 439 | for handler in handlers: |
| 440 | func = getattr(handler, meth_name) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 441 | result = func(*args) |
| 442 | if result is not None: |
| 443 | return result |
| 444 | |
| 445 | def open(self, fullurl, data=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT): |
| 446 | # accept a URL or a Request object |
| 447 | if isinstance(fullurl, str): |
| 448 | req = Request(fullurl, data) |
| 449 | else: |
| 450 | req = fullurl |
| 451 | if data is not None: |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 452 | req.data = data |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 453 | |
| 454 | req.timeout = timeout |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 455 | protocol = req.type |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 456 | |
| 457 | # pre-process request |
| 458 | meth_name = protocol+"_request" |
| 459 | for processor in self.process_request.get(protocol, []): |
| 460 | meth = getattr(processor, meth_name) |
| 461 | req = meth(req) |
| 462 | |
| 463 | response = self._open(req, data) |
| 464 | |
| 465 | # post-process response |
| 466 | meth_name = protocol+"_response" |
| 467 | for processor in self.process_response.get(protocol, []): |
| 468 | meth = getattr(processor, meth_name) |
| 469 | response = meth(req, response) |
| 470 | |
| 471 | return response |
| 472 | |
| 473 | def _open(self, req, data=None): |
| 474 | result = self._call_chain(self.handle_open, 'default', |
| 475 | 'default_open', req) |
| 476 | if result: |
| 477 | return result |
| 478 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 479 | protocol = req.type |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 480 | result = self._call_chain(self.handle_open, protocol, protocol + |
| 481 | '_open', req) |
| 482 | if result: |
| 483 | return result |
| 484 | |
| 485 | return self._call_chain(self.handle_open, 'unknown', |
| 486 | 'unknown_open', req) |
| 487 | |
| 488 | def error(self, proto, *args): |
| 489 | if proto in ('http', 'https'): |
| 490 | # XXX http[s] protocols are special-cased |
| 491 | dict = self.handle_error['http'] # https is not different than http |
| 492 | proto = args[2] # YUCK! |
| 493 | meth_name = 'http_error_%s' % proto |
| 494 | http_err = 1 |
| 495 | orig_args = args |
| 496 | else: |
| 497 | dict = self.handle_error |
| 498 | meth_name = proto + '_error' |
| 499 | http_err = 0 |
| 500 | args = (dict, proto, meth_name) + args |
| 501 | result = self._call_chain(*args) |
| 502 | if result: |
| 503 | return result |
| 504 | |
| 505 | if http_err: |
| 506 | args = (dict, 'default', 'http_error_default') + orig_args |
| 507 | return self._call_chain(*args) |
| 508 | |
| 509 | # XXX probably also want an abstract factory that knows when it makes |
| 510 | # sense to skip a superclass in favor of a subclass and when it might |
| 511 | # make sense to include both |
| 512 | |
| 513 | def build_opener(*handlers): |
| 514 | """Create an opener object from a list of handlers. |
| 515 | |
| 516 | The opener will use several default handlers, including support |
Senthil Kumaran | 1107c5d | 2009-11-15 06:20:55 +0000 | [diff] [blame] | 517 | for HTTP, FTP and when applicable HTTPS. |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 518 | |
| 519 | If any of the handlers passed as arguments are subclasses of the |
| 520 | default handlers, the default handlers will not be used. |
| 521 | """ |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 522 | opener = OpenerDirector() |
| 523 | default_classes = [ProxyHandler, UnknownHandler, HTTPHandler, |
| 524 | HTTPDefaultErrorHandler, HTTPRedirectHandler, |
Antoine Pitrou | df204be | 2012-11-24 17:59:08 +0100 | [diff] [blame] | 525 | FTPHandler, FileHandler, HTTPErrorProcessor, |
| 526 | DataHandler] |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 527 | if hasattr(http.client, "HTTPSConnection"): |
| 528 | default_classes.append(HTTPSHandler) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 529 | skip = set() |
| 530 | for klass in default_classes: |
| 531 | for check in handlers: |
Benjamin Peterson | 78c8538 | 2014-04-01 16:27:30 -0400 | [diff] [blame] | 532 | if isinstance(check, type): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 533 | if issubclass(check, klass): |
| 534 | skip.add(klass) |
| 535 | elif isinstance(check, klass): |
| 536 | skip.add(klass) |
| 537 | for klass in skip: |
| 538 | default_classes.remove(klass) |
| 539 | |
| 540 | for klass in default_classes: |
| 541 | opener.add_handler(klass()) |
| 542 | |
| 543 | for h in handlers: |
Benjamin Peterson | 5dd3cae | 2014-04-01 14:20:56 -0400 | [diff] [blame] | 544 | if isinstance(h, type): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 545 | h = h() |
| 546 | opener.add_handler(h) |
| 547 | return opener |
| 548 | |
| 549 | class BaseHandler: |
| 550 | handler_order = 500 |
| 551 | |
| 552 | def add_parent(self, parent): |
| 553 | self.parent = parent |
| 554 | |
| 555 | def close(self): |
| 556 | # Only exists for backwards compatibility |
| 557 | pass |
| 558 | |
| 559 | def __lt__(self, other): |
| 560 | if not hasattr(other, "handler_order"): |
| 561 | # Try to preserve the old behavior of having custom classes |
| 562 | # inserted after default ones (works only for custom user |
| 563 | # classes which are not aware of handler_order). |
| 564 | return True |
| 565 | return self.handler_order < other.handler_order |
| 566 | |
| 567 | |
| 568 | class HTTPErrorProcessor(BaseHandler): |
| 569 | """Process HTTP error responses.""" |
| 570 | handler_order = 1000 # after all other processing |
| 571 | |
| 572 | def http_response(self, request, response): |
| 573 | code, msg, hdrs = response.code, response.msg, response.info() |
| 574 | |
| 575 | # According to RFC 2616, "2xx" code indicates that the client's |
| 576 | # request was successfully received, understood, and accepted. |
| 577 | if not (200 <= code < 300): |
| 578 | response = self.parent.error( |
| 579 | 'http', request, response, code, msg, hdrs) |
| 580 | |
| 581 | return response |
| 582 | |
| 583 | https_response = http_response |
| 584 | |
| 585 | class HTTPDefaultErrorHandler(BaseHandler): |
| 586 | def http_error_default(self, req, fp, code, msg, hdrs): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 587 | raise HTTPError(req.full_url, code, msg, hdrs, fp) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 588 | |
| 589 | class HTTPRedirectHandler(BaseHandler): |
| 590 | # maximum number of redirections to any single URL |
| 591 | # this is needed because of the state that cookies introduce |
| 592 | max_repeats = 4 |
| 593 | # maximum total number of redirections (regardless of URL) before |
| 594 | # assuming we're in a loop |
| 595 | max_redirections = 10 |
| 596 | |
| 597 | def redirect_request(self, req, fp, code, msg, headers, newurl): |
| 598 | """Return a Request or None in response to a redirect. |
| 599 | |
| 600 | This is called by the http_error_30x methods when a |
| 601 | redirection response is received. If a redirection should |
| 602 | take place, return a new Request to allow http_error_30x to |
| 603 | perform the redirect. Otherwise, raise HTTPError if no-one |
| 604 | else should try to handle this url. Return None if you can't |
| 605 | but another Handler might. |
| 606 | """ |
| 607 | m = req.get_method() |
| 608 | if (not (code in (301, 302, 303, 307) and m in ("GET", "HEAD") |
| 609 | or code in (301, 302, 303) and m == "POST")): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 610 | raise HTTPError(req.full_url, code, msg, headers, fp) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 611 | |
| 612 | # Strictly (according to RFC 2616), 301 or 302 in response to |
| 613 | # a POST MUST NOT cause a redirection without confirmation |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 614 | # from the user (of urllib.request, in this case). In practice, |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 615 | # essentially all clients do redirect in this case, so we do |
| 616 | # the same. |
| 617 | # be conciliant with URIs containing a space |
| 618 | newurl = newurl.replace(' ', '%20') |
| 619 | CONTENT_HEADERS = ("content-length", "content-type") |
| 620 | newheaders = dict((k, v) for k, v in req.headers.items() |
| 621 | if k.lower() not in CONTENT_HEADERS) |
| 622 | return Request(newurl, |
| 623 | headers=newheaders, |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 624 | origin_req_host=req.origin_req_host, |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 625 | unverifiable=True) |
| 626 | |
| 627 | # Implementation note: To avoid the server sending us into an |
| 628 | # infinite loop, the request object needs to track what URLs we |
| 629 | # have already seen. Do this by adding a handler-specific |
| 630 | # attribute to the Request object. |
| 631 | def http_error_302(self, req, fp, code, msg, headers): |
| 632 | # Some servers (incorrectly) return multiple Location headers |
| 633 | # (so probably same goes for URI). Use first header. |
| 634 | if "location" in headers: |
| 635 | newurl = headers["location"] |
| 636 | elif "uri" in headers: |
| 637 | newurl = headers["uri"] |
| 638 | else: |
| 639 | return |
Facundo Batista | f24802c | 2008-08-17 03:36:03 +0000 | [diff] [blame] | 640 | |
| 641 | # fix a possible malformed URL |
| 642 | urlparts = urlparse(newurl) |
guido@google.com | a119df9 | 2011-03-29 11:41:02 -0700 | [diff] [blame] | 643 | |
| 644 | # For security reasons we don't allow redirection to anything other |
| 645 | # than http, https or ftp. |
| 646 | |
Senthil Kumaran | 6497aa3 | 2012-01-04 13:46:59 +0800 | [diff] [blame] | 647 | if urlparts.scheme not in ('http', 'https', 'ftp', ''): |
Senthil Kumaran | 34d38dc | 2011-10-20 02:48:01 +0800 | [diff] [blame] | 648 | raise HTTPError( |
| 649 | newurl, code, |
| 650 | "%s - Redirection to url '%s' is not allowed" % (msg, newurl), |
| 651 | headers, fp) |
guido@google.com | a119df9 | 2011-03-29 11:41:02 -0700 | [diff] [blame] | 652 | |
Facundo Batista | f24802c | 2008-08-17 03:36:03 +0000 | [diff] [blame] | 653 | if not urlparts.path: |
| 654 | urlparts = list(urlparts) |
| 655 | urlparts[2] = "/" |
| 656 | newurl = urlunparse(urlparts) |
| 657 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 658 | newurl = urljoin(req.full_url, newurl) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 659 | |
| 660 | # XXX Probably want to forget about the state of the current |
| 661 | # request, although that might interact poorly with other |
| 662 | # handlers that also use handler-specific request attributes |
| 663 | new = self.redirect_request(req, fp, code, msg, headers, newurl) |
| 664 | if new is None: |
| 665 | return |
| 666 | |
| 667 | # loop detection |
| 668 | # .redirect_dict has a key url if url was previously visited. |
| 669 | if hasattr(req, 'redirect_dict'): |
| 670 | visited = new.redirect_dict = req.redirect_dict |
| 671 | if (visited.get(newurl, 0) >= self.max_repeats or |
| 672 | len(visited) >= self.max_redirections): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 673 | raise HTTPError(req.full_url, code, |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 674 | self.inf_msg + msg, headers, fp) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 675 | else: |
| 676 | visited = new.redirect_dict = req.redirect_dict = {} |
| 677 | visited[newurl] = visited.get(newurl, 0) + 1 |
| 678 | |
| 679 | # Don't close the fp until we are sure that we won't use it |
| 680 | # with HTTPError. |
| 681 | fp.read() |
| 682 | fp.close() |
| 683 | |
Senthil Kumaran | fb8cc2f | 2009-07-19 02:44:19 +0000 | [diff] [blame] | 684 | return self.parent.open(new, timeout=req.timeout) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 685 | |
| 686 | http_error_301 = http_error_303 = http_error_307 = http_error_302 |
| 687 | |
| 688 | inf_msg = "The HTTP server returned a redirect error that would " \ |
| 689 | "lead to an infinite loop.\n" \ |
| 690 | "The last 30x error message was:\n" |
| 691 | |
| 692 | |
| 693 | def _parse_proxy(proxy): |
| 694 | """Return (scheme, user, password, host/port) given a URL or an authority. |
| 695 | |
| 696 | If a URL is supplied, it must have an authority (host:port) component. |
| 697 | According to RFC 3986, having an authority component means the URL must |
Senthil Kumaran | d8e24f1 | 2014-04-14 16:32:20 -0400 | [diff] [blame] | 698 | have two slashes after the scheme. |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 699 | """ |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 700 | scheme, r_scheme = splittype(proxy) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 701 | if not r_scheme.startswith("/"): |
| 702 | # authority |
| 703 | scheme = None |
| 704 | authority = proxy |
| 705 | else: |
| 706 | # URL |
| 707 | if not r_scheme.startswith("//"): |
| 708 | raise ValueError("proxy URL with no authority: %r" % proxy) |
| 709 | # We have an authority, so for RFC 3986-compliant URLs (by ss 3. |
| 710 | # and 3.3.), path is empty or starts with '/' |
| 711 | end = r_scheme.find("/", 2) |
| 712 | if end == -1: |
| 713 | end = None |
| 714 | authority = r_scheme[2:end] |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 715 | userinfo, hostport = splituser(authority) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 716 | if userinfo is not None: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 717 | user, password = splitpasswd(userinfo) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 718 | else: |
| 719 | user = password = None |
| 720 | return scheme, user, password, hostport |
| 721 | |
| 722 | class ProxyHandler(BaseHandler): |
| 723 | # Proxies must be in front |
| 724 | handler_order = 100 |
| 725 | |
| 726 | def __init__(self, proxies=None): |
| 727 | if proxies is None: |
| 728 | proxies = getproxies() |
| 729 | assert hasattr(proxies, 'keys'), "proxies must be a mapping" |
| 730 | self.proxies = proxies |
| 731 | for type, url in proxies.items(): |
| 732 | setattr(self, '%s_open' % type, |
Georg Brandl | fcbdbf2 | 2012-06-24 19:56:31 +0200 | [diff] [blame] | 733 | lambda r, proxy=url, type=type, meth=self.proxy_open: |
| 734 | meth(r, proxy, type)) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 735 | |
| 736 | def proxy_open(self, req, proxy, type): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 737 | orig_type = req.type |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 738 | proxy_type, user, password, hostport = _parse_proxy(proxy) |
| 739 | if proxy_type is None: |
| 740 | proxy_type = orig_type |
Senthil Kumaran | 7bb0497 | 2009-10-11 04:58:55 +0000 | [diff] [blame] | 741 | |
| 742 | if req.host and proxy_bypass(req.host): |
| 743 | return None |
| 744 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 745 | if user and password: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 746 | user_pass = '%s:%s' % (unquote(user), |
| 747 | unquote(password)) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 748 | creds = base64.b64encode(user_pass.encode()).decode("ascii") |
| 749 | req.add_header('Proxy-authorization', 'Basic ' + creds) |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 750 | hostport = unquote(hostport) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 751 | req.set_proxy(hostport, proxy_type) |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 752 | if orig_type == proxy_type or orig_type == 'https': |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 753 | # let other handlers take care of it |
| 754 | return None |
| 755 | else: |
| 756 | # need to start over, because the other handlers don't |
| 757 | # grok the proxy's URL type |
| 758 | # e.g. if we have a constructor arg proxies like so: |
| 759 | # {'http': 'ftp://proxy.example.com'}, we may end up turning |
| 760 | # a request for http://acme.example.com/a into one for |
| 761 | # ftp://proxy.example.com/a |
Senthil Kumaran | fb8cc2f | 2009-07-19 02:44:19 +0000 | [diff] [blame] | 762 | return self.parent.open(req, timeout=req.timeout) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 763 | |
| 764 | class HTTPPasswordMgr: |
| 765 | |
| 766 | def __init__(self): |
| 767 | self.passwd = {} |
| 768 | |
| 769 | def add_password(self, realm, uri, user, passwd): |
| 770 | # uri could be a single URI or a sequence |
| 771 | if isinstance(uri, str): |
| 772 | uri = [uri] |
Senthil Kumaran | 34d38dc | 2011-10-20 02:48:01 +0800 | [diff] [blame] | 773 | if realm not in self.passwd: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 774 | self.passwd[realm] = {} |
| 775 | for default_port in True, False: |
| 776 | reduced_uri = tuple( |
| 777 | [self.reduce_uri(u, default_port) for u in uri]) |
| 778 | self.passwd[realm][reduced_uri] = (user, passwd) |
| 779 | |
| 780 | def find_user_password(self, realm, authuri): |
| 781 | domains = self.passwd.get(realm, {}) |
| 782 | for default_port in True, False: |
| 783 | reduced_authuri = self.reduce_uri(authuri, default_port) |
| 784 | for uris, authinfo in domains.items(): |
| 785 | for uri in uris: |
| 786 | if self.is_suburi(uri, reduced_authuri): |
| 787 | return authinfo |
| 788 | return None, None |
| 789 | |
| 790 | def reduce_uri(self, uri, default_port=True): |
| 791 | """Accept authority or URI and extract only the authority and path.""" |
| 792 | # note HTTP URLs do not have a userinfo component |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 793 | parts = urlsplit(uri) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 794 | if parts[1]: |
| 795 | # URI |
| 796 | scheme = parts[0] |
| 797 | authority = parts[1] |
| 798 | path = parts[2] or '/' |
| 799 | else: |
| 800 | # host or host:port |
| 801 | scheme = None |
| 802 | authority = uri |
| 803 | path = '/' |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 804 | host, port = splitport(authority) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 805 | if default_port and port is None and scheme is not None: |
| 806 | dport = {"http": 80, |
| 807 | "https": 443, |
| 808 | }.get(scheme) |
| 809 | if dport is not None: |
| 810 | authority = "%s:%d" % (host, dport) |
| 811 | return authority, path |
| 812 | |
| 813 | def is_suburi(self, base, test): |
| 814 | """Check if test is below base in a URI tree |
| 815 | |
| 816 | Both args must be URIs in reduced form. |
| 817 | """ |
| 818 | if base == test: |
| 819 | return True |
| 820 | if base[0] != test[0]: |
| 821 | return False |
| 822 | common = posixpath.commonprefix((base[1], test[1])) |
| 823 | if len(common) == len(base[1]): |
| 824 | return True |
| 825 | return False |
| 826 | |
| 827 | |
| 828 | class HTTPPasswordMgrWithDefaultRealm(HTTPPasswordMgr): |
| 829 | |
| 830 | def find_user_password(self, realm, authuri): |
| 831 | user, password = HTTPPasswordMgr.find_user_password(self, realm, |
| 832 | authuri) |
| 833 | if user is not None: |
| 834 | return user, password |
| 835 | return HTTPPasswordMgr.find_user_password(self, None, authuri) |
| 836 | |
| 837 | |
| 838 | class AbstractBasicAuthHandler: |
| 839 | |
| 840 | # XXX this allows for multiple auth-schemes, but will stupidly pick |
| 841 | # the last one with a realm specified. |
| 842 | |
| 843 | # allow for double- and single-quoted realm values |
| 844 | # (single quotes are a violation of the RFC, but appear in the wild) |
| 845 | rx = re.compile('(?:.*,)*[ \t]*([^ \t]+)[ \t]+' |
Senthil Kumaran | 34f3fcc | 2012-05-15 22:30:25 +0800 | [diff] [blame] | 846 | 'realm=(["\']?)([^"\']*)\\2', re.I) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 847 | |
| 848 | # XXX could pre-emptively send auth info already accepted (RFC 2617, |
| 849 | # end of section 2, and section 1.2 immediately after "credentials" |
| 850 | # production). |
| 851 | |
| 852 | def __init__(self, password_mgr=None): |
| 853 | if password_mgr is None: |
| 854 | password_mgr = HTTPPasswordMgr() |
| 855 | self.passwd = password_mgr |
| 856 | self.add_password = self.passwd.add_password |
Senthil Kumaran | 67a62a4 | 2010-08-19 17:50:31 +0000 | [diff] [blame] | 857 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 858 | def http_error_auth_reqed(self, authreq, host, req, headers): |
| 859 | # host may be an authority (without userinfo) or a URL with an |
| 860 | # authority |
| 861 | # XXX could be multiple headers |
| 862 | authreq = headers.get(authreq, None) |
Senthil Kumaran | f4998ac | 2010-06-01 12:53:48 +0000 | [diff] [blame] | 863 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 864 | if authreq: |
Senthil Kumaran | 4de00a2 | 2011-05-11 21:17:57 +0800 | [diff] [blame] | 865 | scheme = authreq.split()[0] |
Senthil Kumaran | 1a129c8 | 2011-10-20 02:50:13 +0800 | [diff] [blame] | 866 | if scheme.lower() != 'basic': |
Senthil Kumaran | 4de00a2 | 2011-05-11 21:17:57 +0800 | [diff] [blame] | 867 | raise ValueError("AbstractBasicAuthHandler does not" |
| 868 | " support the following scheme: '%s'" % |
| 869 | scheme) |
| 870 | else: |
| 871 | mo = AbstractBasicAuthHandler.rx.search(authreq) |
| 872 | if mo: |
| 873 | scheme, quote, realm = mo.groups() |
Senthil Kumaran | 92a5bf0 | 2012-05-16 00:03:29 +0800 | [diff] [blame] | 874 | if quote not in ['"',"'"]: |
| 875 | warnings.warn("Basic Auth Realm was unquoted", |
| 876 | UserWarning, 2) |
Senthil Kumaran | 4de00a2 | 2011-05-11 21:17:57 +0800 | [diff] [blame] | 877 | if scheme.lower() == 'basic': |
Senthil Kumaran | 7837376 | 2014-08-20 07:53:58 +0530 | [diff] [blame] | 878 | return self.retry_http_basic_auth(host, req, realm) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 879 | |
| 880 | def retry_http_basic_auth(self, host, req, realm): |
| 881 | user, pw = self.passwd.find_user_password(realm, host) |
| 882 | if pw is not None: |
| 883 | raw = "%s:%s" % (user, pw) |
| 884 | auth = "Basic " + base64.b64encode(raw.encode()).decode("ascii") |
Senthil Kumaran | 7837376 | 2014-08-20 07:53:58 +0530 | [diff] [blame] | 885 | if req.get_header(self.auth_header, None) == auth: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 886 | return None |
Senthil Kumaran | ca2fc9e | 2010-02-24 16:53:16 +0000 | [diff] [blame] | 887 | req.add_unredirected_header(self.auth_header, auth) |
Senthil Kumaran | fb8cc2f | 2009-07-19 02:44:19 +0000 | [diff] [blame] | 888 | return self.parent.open(req, timeout=req.timeout) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 889 | else: |
| 890 | return None |
| 891 | |
| 892 | |
| 893 | class HTTPBasicAuthHandler(AbstractBasicAuthHandler, BaseHandler): |
| 894 | |
| 895 | auth_header = 'Authorization' |
| 896 | |
| 897 | def http_error_401(self, req, fp, code, msg, headers): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 898 | url = req.full_url |
Senthil Kumaran | 67a62a4 | 2010-08-19 17:50:31 +0000 | [diff] [blame] | 899 | response = self.http_error_auth_reqed('www-authenticate', |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 900 | url, req, headers) |
Senthil Kumaran | 67a62a4 | 2010-08-19 17:50:31 +0000 | [diff] [blame] | 901 | return response |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 902 | |
| 903 | |
| 904 | class ProxyBasicAuthHandler(AbstractBasicAuthHandler, BaseHandler): |
| 905 | |
| 906 | auth_header = 'Proxy-authorization' |
| 907 | |
| 908 | def http_error_407(self, req, fp, code, msg, headers): |
| 909 | # http_error_auth_reqed requires that there is no userinfo component in |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 910 | # authority. Assume there isn't one, since urllib.request does not (and |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 911 | # should not, RFC 3986 s. 3.2.1) support requests for URLs containing |
| 912 | # userinfo. |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 913 | authority = req.host |
Senthil Kumaran | 67a62a4 | 2010-08-19 17:50:31 +0000 | [diff] [blame] | 914 | response = self.http_error_auth_reqed('proxy-authenticate', |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 915 | authority, req, headers) |
Senthil Kumaran | 67a62a4 | 2010-08-19 17:50:31 +0000 | [diff] [blame] | 916 | return response |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 917 | |
| 918 | |
Nick Coghlan | c216c48 | 2014-11-12 23:33:50 +1000 | [diff] [blame] | 919 | class HTTPBasicPriorAuthHandler(HTTPBasicAuthHandler): |
| 920 | handler_order = 400 |
| 921 | |
| 922 | def http_request(self, req): |
| 923 | if not req.has_header('Authorization'): |
| 924 | user, passwd = self.passwd.find_user_password(None, req.host) |
| 925 | credentials = '{0}:{1}'.format(user, passwd).encode() |
| 926 | auth_str = base64.standard_b64encode(credentials).decode() |
| 927 | req.add_unredirected_header('Authorization', |
| 928 | 'Basic {}'.format(auth_str.strip())) |
| 929 | return req |
| 930 | |
| 931 | https_request = http_request |
| 932 | |
| 933 | |
Senthil Kumaran | 6c5bd40 | 2011-11-01 23:20:31 +0800 | [diff] [blame] | 934 | # Return n random bytes. |
| 935 | _randombytes = os.urandom |
| 936 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 937 | |
| 938 | class AbstractDigestAuthHandler: |
| 939 | # Digest authentication is specified in RFC 2617. |
| 940 | |
| 941 | # XXX The client does not inspect the Authentication-Info header |
| 942 | # in a successful response. |
| 943 | |
| 944 | # XXX It should be possible to test this implementation against |
| 945 | # a mock server that just generates a static set of challenges. |
| 946 | |
| 947 | # XXX qop="auth-int" supports is shaky |
| 948 | |
| 949 | def __init__(self, passwd=None): |
| 950 | if passwd is None: |
| 951 | passwd = HTTPPasswordMgr() |
| 952 | self.passwd = passwd |
| 953 | self.add_password = self.passwd.add_password |
| 954 | self.retried = 0 |
| 955 | self.nonce_count = 0 |
Senthil Kumaran | 4c7eaee | 2009-11-15 08:43:45 +0000 | [diff] [blame] | 956 | self.last_nonce = None |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 957 | |
| 958 | def reset_retry_count(self): |
| 959 | self.retried = 0 |
| 960 | |
| 961 | def http_error_auth_reqed(self, auth_header, host, req, headers): |
| 962 | authreq = headers.get(auth_header, None) |
| 963 | if self.retried > 5: |
| 964 | # Don't fail endlessly - if we failed once, we'll probably |
| 965 | # fail a second time. Hm. Unless the Password Manager is |
| 966 | # prompting for the information. Crap. This isn't great |
| 967 | # but it's better than the current 'repeat until recursion |
| 968 | # depth exceeded' approach <wink> |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 969 | raise HTTPError(req.full_url, 401, "digest auth failed", |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 970 | headers, None) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 971 | else: |
| 972 | self.retried += 1 |
| 973 | if authreq: |
| 974 | scheme = authreq.split()[0] |
| 975 | if scheme.lower() == 'digest': |
| 976 | return self.retry_http_digest_auth(req, authreq) |
Senthil Kumaran | 1a129c8 | 2011-10-20 02:50:13 +0800 | [diff] [blame] | 977 | elif scheme.lower() != 'basic': |
Senthil Kumaran | 4de00a2 | 2011-05-11 21:17:57 +0800 | [diff] [blame] | 978 | raise ValueError("AbstractDigestAuthHandler does not support" |
| 979 | " the following scheme: '%s'" % scheme) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 980 | |
| 981 | def retry_http_digest_auth(self, req, auth): |
| 982 | token, challenge = auth.split(' ', 1) |
| 983 | chal = parse_keqv_list(filter(None, parse_http_list(challenge))) |
| 984 | auth = self.get_authorization(req, chal) |
| 985 | if auth: |
| 986 | auth_val = 'Digest %s' % auth |
| 987 | if req.headers.get(self.auth_header, None) == auth_val: |
| 988 | return None |
| 989 | req.add_unredirected_header(self.auth_header, auth_val) |
Senthil Kumaran | fb8cc2f | 2009-07-19 02:44:19 +0000 | [diff] [blame] | 990 | resp = self.parent.open(req, timeout=req.timeout) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 991 | return resp |
| 992 | |
| 993 | def get_cnonce(self, nonce): |
| 994 | # The cnonce-value is an opaque |
| 995 | # quoted string value provided by the client and used by both client |
| 996 | # and server to avoid chosen plaintext attacks, to provide mutual |
| 997 | # authentication, and to provide some message integrity protection. |
| 998 | # This isn't a fabulous effort, but it's probably Good Enough. |
| 999 | s = "%s:%s:%s:" % (self.nonce_count, nonce, time.ctime()) |
Senthil Kumaran | 6c5bd40 | 2011-11-01 23:20:31 +0800 | [diff] [blame] | 1000 | b = s.encode("ascii") + _randombytes(8) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1001 | dig = hashlib.sha1(b).hexdigest() |
| 1002 | return dig[:16] |
| 1003 | |
| 1004 | def get_authorization(self, req, chal): |
| 1005 | try: |
| 1006 | realm = chal['realm'] |
| 1007 | nonce = chal['nonce'] |
| 1008 | qop = chal.get('qop') |
| 1009 | algorithm = chal.get('algorithm', 'MD5') |
| 1010 | # mod_digest doesn't send an opaque, even though it isn't |
| 1011 | # supposed to be optional |
| 1012 | opaque = chal.get('opaque', None) |
| 1013 | except KeyError: |
| 1014 | return None |
| 1015 | |
| 1016 | H, KD = self.get_algorithm_impls(algorithm) |
| 1017 | if H is None: |
| 1018 | return None |
| 1019 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1020 | user, pw = self.passwd.find_user_password(realm, req.full_url) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1021 | if user is None: |
| 1022 | return None |
| 1023 | |
| 1024 | # XXX not implemented yet |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1025 | if req.data is not None: |
| 1026 | entdig = self.get_entity_digest(req.data, chal) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1027 | else: |
| 1028 | entdig = None |
| 1029 | |
| 1030 | A1 = "%s:%s:%s" % (user, realm, pw) |
| 1031 | A2 = "%s:%s" % (req.get_method(), |
| 1032 | # XXX selector: what about proxies and full urls |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1033 | req.selector) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1034 | if qop == 'auth': |
Senthil Kumaran | 4c7eaee | 2009-11-15 08:43:45 +0000 | [diff] [blame] | 1035 | if nonce == self.last_nonce: |
| 1036 | self.nonce_count += 1 |
| 1037 | else: |
| 1038 | self.nonce_count = 1 |
| 1039 | self.last_nonce = nonce |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1040 | ncvalue = '%08x' % self.nonce_count |
| 1041 | cnonce = self.get_cnonce(nonce) |
| 1042 | noncebit = "%s:%s:%s:%s:%s" % (nonce, ncvalue, cnonce, qop, H(A2)) |
| 1043 | respdig = KD(H(A1), noncebit) |
| 1044 | elif qop is None: |
| 1045 | respdig = KD(H(A1), "%s:%s" % (nonce, H(A2))) |
| 1046 | else: |
| 1047 | # XXX handle auth-int. |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1048 | raise URLError("qop '%s' is not supported." % qop) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1049 | |
| 1050 | # XXX should the partial digests be encoded too? |
| 1051 | |
| 1052 | base = 'username="%s", realm="%s", nonce="%s", uri="%s", ' \ |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1053 | 'response="%s"' % (user, realm, nonce, req.selector, |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1054 | respdig) |
| 1055 | if opaque: |
| 1056 | base += ', opaque="%s"' % opaque |
| 1057 | if entdig: |
| 1058 | base += ', digest="%s"' % entdig |
| 1059 | base += ', algorithm="%s"' % algorithm |
| 1060 | if qop: |
| 1061 | base += ', qop=auth, nc=%s, cnonce="%s"' % (ncvalue, cnonce) |
| 1062 | return base |
| 1063 | |
| 1064 | def get_algorithm_impls(self, algorithm): |
| 1065 | # lambdas assume digest modules are imported at the top level |
| 1066 | if algorithm == 'MD5': |
| 1067 | H = lambda x: hashlib.md5(x.encode("ascii")).hexdigest() |
| 1068 | elif algorithm == 'SHA': |
| 1069 | H = lambda x: hashlib.sha1(x.encode("ascii")).hexdigest() |
| 1070 | # XXX MD5-sess |
| 1071 | KD = lambda s, d: H("%s:%s" % (s, d)) |
| 1072 | return H, KD |
| 1073 | |
| 1074 | def get_entity_digest(self, data, chal): |
| 1075 | # XXX not implemented yet |
| 1076 | return None |
| 1077 | |
| 1078 | |
| 1079 | class HTTPDigestAuthHandler(BaseHandler, AbstractDigestAuthHandler): |
| 1080 | """An authentication protocol defined by RFC 2069 |
| 1081 | |
| 1082 | Digest authentication improves on basic authentication because it |
| 1083 | does not transmit passwords in the clear. |
| 1084 | """ |
| 1085 | |
| 1086 | auth_header = 'Authorization' |
| 1087 | handler_order = 490 # before Basic auth |
| 1088 | |
| 1089 | def http_error_401(self, req, fp, code, msg, headers): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1090 | host = urlparse(req.full_url)[1] |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1091 | retry = self.http_error_auth_reqed('www-authenticate', |
| 1092 | host, req, headers) |
| 1093 | self.reset_retry_count() |
| 1094 | return retry |
| 1095 | |
| 1096 | |
| 1097 | class ProxyDigestAuthHandler(BaseHandler, AbstractDigestAuthHandler): |
| 1098 | |
| 1099 | auth_header = 'Proxy-Authorization' |
| 1100 | handler_order = 490 # before Basic auth |
| 1101 | |
| 1102 | def http_error_407(self, req, fp, code, msg, headers): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1103 | host = req.host |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1104 | retry = self.http_error_auth_reqed('proxy-authenticate', |
| 1105 | host, req, headers) |
| 1106 | self.reset_retry_count() |
| 1107 | return retry |
| 1108 | |
| 1109 | class AbstractHTTPHandler(BaseHandler): |
| 1110 | |
| 1111 | def __init__(self, debuglevel=0): |
| 1112 | self._debuglevel = debuglevel |
| 1113 | |
| 1114 | def set_http_debuglevel(self, level): |
| 1115 | self._debuglevel = level |
| 1116 | |
| 1117 | def do_request_(self, request): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1118 | host = request.host |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1119 | if not host: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1120 | raise URLError('no host given') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1121 | |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1122 | if request.data is not None: # POST |
| 1123 | data = request.data |
Senthil Kumaran | 2933312 | 2011-02-11 11:25:47 +0000 | [diff] [blame] | 1124 | if isinstance(data, str): |
Georg Brandl | fcbdbf2 | 2012-06-24 19:56:31 +0200 | [diff] [blame] | 1125 | msg = "POST data should be bytes or an iterable of bytes. " \ |
| 1126 | "It cannot be of type str." |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 1127 | raise TypeError(msg) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1128 | if not request.has_header('Content-type'): |
| 1129 | request.add_unredirected_header( |
| 1130 | 'Content-type', |
| 1131 | 'application/x-www-form-urlencoded') |
| 1132 | if not request.has_header('Content-length'): |
Senthil Kumaran | 7bc0d87 | 2010-12-19 10:49:52 +0000 | [diff] [blame] | 1133 | try: |
| 1134 | mv = memoryview(data) |
| 1135 | except TypeError: |
Senthil Kumaran | 7bc0d87 | 2010-12-19 10:49:52 +0000 | [diff] [blame] | 1136 | if isinstance(data, collections.Iterable): |
Georg Brandl | 6153604 | 2011-02-03 07:46:41 +0000 | [diff] [blame] | 1137 | raise ValueError("Content-Length should be specified " |
| 1138 | "for iterable data of type %r %r" % (type(data), |
Senthil Kumaran | 7bc0d87 | 2010-12-19 10:49:52 +0000 | [diff] [blame] | 1139 | data)) |
| 1140 | else: |
| 1141 | request.add_unredirected_header( |
Senthil Kumaran | 1e991f2 | 2010-12-24 04:03:59 +0000 | [diff] [blame] | 1142 | 'Content-length', '%d' % (len(mv) * mv.itemsize)) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1143 | |
Facundo Batista | 72dc1ea | 2008-08-16 14:44:32 +0000 | [diff] [blame] | 1144 | sel_host = host |
| 1145 | if request.has_proxy(): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1146 | scheme, sel = splittype(request.selector) |
Facundo Batista | 72dc1ea | 2008-08-16 14:44:32 +0000 | [diff] [blame] | 1147 | sel_host, sel_path = splithost(sel) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1148 | if not request.has_header('Host'): |
Facundo Batista | 72dc1ea | 2008-08-16 14:44:32 +0000 | [diff] [blame] | 1149 | request.add_unredirected_header('Host', sel_host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1150 | for name, value in self.parent.addheaders: |
| 1151 | name = name.capitalize() |
| 1152 | if not request.has_header(name): |
| 1153 | request.add_unredirected_header(name, value) |
| 1154 | |
| 1155 | return request |
| 1156 | |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 1157 | def do_open(self, http_class, req, **http_conn_args): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1158 | """Return an HTTPResponse object for the request, using http_class. |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1159 | |
| 1160 | http_class must implement the HTTPConnection API from http.client. |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1161 | """ |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1162 | host = req.host |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1163 | if not host: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1164 | raise URLError('no host given') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1165 | |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 1166 | # will parse host:port |
| 1167 | h = http_class(host, timeout=req.timeout, **http_conn_args) |
Senthil Kumaran | 42ef4b1 | 2010-09-27 01:26:03 +0000 | [diff] [blame] | 1168 | |
| 1169 | headers = dict(req.unredirected_hdrs) |
| 1170 | headers.update(dict((k, v) for k, v in req.headers.items() |
| 1171 | if k not in headers)) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1172 | |
| 1173 | # TODO(jhylton): Should this be redesigned to handle |
| 1174 | # persistent connections? |
| 1175 | |
| 1176 | # We want to make an HTTP/1.1 request, but the addinfourl |
| 1177 | # class isn't prepared to deal with a persistent connection. |
| 1178 | # It will try to read all remaining data from the socket, |
| 1179 | # which will block while the server waits for the next request. |
| 1180 | # So make sure the connection gets closed after the (only) |
| 1181 | # request. |
| 1182 | headers["Connection"] = "close" |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1183 | headers = dict((name.title(), val) for name, val in headers.items()) |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 1184 | |
| 1185 | if req._tunnel_host: |
Senthil Kumaran | 47fff87 | 2009-12-20 07:10:31 +0000 | [diff] [blame] | 1186 | tunnel_headers = {} |
| 1187 | proxy_auth_hdr = "Proxy-Authorization" |
| 1188 | if proxy_auth_hdr in headers: |
| 1189 | tunnel_headers[proxy_auth_hdr] = headers[proxy_auth_hdr] |
| 1190 | # Proxy-Authorization should not be sent to origin |
| 1191 | # server. |
| 1192 | del headers[proxy_auth_hdr] |
| 1193 | h.set_tunnel(req._tunnel_host, headers=tunnel_headers) |
Senthil Kumaran | 97f0c6b | 2009-07-25 04:24:38 +0000 | [diff] [blame] | 1194 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1195 | try: |
Serhiy Storchaka | f54c350 | 2014-09-06 21:41:39 +0300 | [diff] [blame] | 1196 | try: |
| 1197 | h.request(req.get_method(), req.selector, req.data, headers) |
| 1198 | except OSError as err: # timeout error |
| 1199 | raise URLError(err) |
Senthil Kumaran | 45686b4 | 2011-07-27 09:31:03 +0800 | [diff] [blame] | 1200 | r = h.getresponse() |
Serhiy Storchaka | f54c350 | 2014-09-06 21:41:39 +0300 | [diff] [blame] | 1201 | except: |
| 1202 | h.close() |
| 1203 | raise |
| 1204 | |
| 1205 | # If the server does not send us a 'Connection: close' header, |
| 1206 | # HTTPConnection assumes the socket should be left open. Manually |
| 1207 | # mark the socket to be closed when this response object goes away. |
| 1208 | if h.sock: |
| 1209 | h.sock.close() |
| 1210 | h.sock = None |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1211 | |
Senthil Kumaran | 2643041 | 2011-04-13 07:01:19 +0800 | [diff] [blame] | 1212 | r.url = req.get_full_url() |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1213 | # This line replaces the .msg attribute of the HTTPResponse |
| 1214 | # with .headers, because urllib clients expect the response to |
| 1215 | # have the reason in .msg. It would be good to mark this |
| 1216 | # attribute is deprecated and get then to use info() or |
| 1217 | # .headers. |
| 1218 | r.msg = r.reason |
| 1219 | return r |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1220 | |
| 1221 | |
| 1222 | class HTTPHandler(AbstractHTTPHandler): |
| 1223 | |
| 1224 | def http_open(self, req): |
| 1225 | return self.do_open(http.client.HTTPConnection, req) |
| 1226 | |
| 1227 | http_request = AbstractHTTPHandler.do_request_ |
| 1228 | |
| 1229 | if hasattr(http.client, 'HTTPSConnection'): |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 1230 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1231 | class HTTPSHandler(AbstractHTTPHandler): |
| 1232 | |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 1233 | def __init__(self, debuglevel=0, context=None, check_hostname=None): |
| 1234 | AbstractHTTPHandler.__init__(self, debuglevel) |
| 1235 | self._context = context |
| 1236 | self._check_hostname = check_hostname |
| 1237 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1238 | def https_open(self, req): |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 1239 | return self.do_open(http.client.HTTPSConnection, req, |
| 1240 | context=self._context, check_hostname=self._check_hostname) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1241 | |
| 1242 | https_request = AbstractHTTPHandler.do_request_ |
| 1243 | |
Senthil Kumaran | 4c875a9 | 2011-11-01 23:57:57 +0800 | [diff] [blame] | 1244 | __all__.append('HTTPSHandler') |
Senthil Kumaran | 0d54eb9 | 2011-11-01 23:49:46 +0800 | [diff] [blame] | 1245 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1246 | class HTTPCookieProcessor(BaseHandler): |
| 1247 | def __init__(self, cookiejar=None): |
| 1248 | import http.cookiejar |
| 1249 | if cookiejar is None: |
| 1250 | cookiejar = http.cookiejar.CookieJar() |
| 1251 | self.cookiejar = cookiejar |
| 1252 | |
| 1253 | def http_request(self, request): |
| 1254 | self.cookiejar.add_cookie_header(request) |
| 1255 | return request |
| 1256 | |
| 1257 | def http_response(self, request, response): |
| 1258 | self.cookiejar.extract_cookies(response, request) |
| 1259 | return response |
| 1260 | |
| 1261 | https_request = http_request |
| 1262 | https_response = http_response |
| 1263 | |
| 1264 | class UnknownHandler(BaseHandler): |
| 1265 | def unknown_open(self, req): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1266 | type = req.type |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1267 | raise URLError('unknown url type: %s' % type) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1268 | |
| 1269 | def parse_keqv_list(l): |
| 1270 | """Parse list of key=value strings where keys are not duplicated.""" |
| 1271 | parsed = {} |
| 1272 | for elt in l: |
| 1273 | k, v = elt.split('=', 1) |
| 1274 | if v[0] == '"' and v[-1] == '"': |
| 1275 | v = v[1:-1] |
| 1276 | parsed[k] = v |
| 1277 | return parsed |
| 1278 | |
| 1279 | def parse_http_list(s): |
| 1280 | """Parse lists as described by RFC 2068 Section 2. |
| 1281 | |
| 1282 | In particular, parse comma-separated lists where the elements of |
| 1283 | the list may include quoted-strings. A quoted-string could |
| 1284 | contain a comma. A non-quoted string could have quotes in the |
| 1285 | middle. Neither commas nor quotes count if they are escaped. |
| 1286 | Only double-quotes count, not single-quotes. |
| 1287 | """ |
| 1288 | res = [] |
| 1289 | part = '' |
| 1290 | |
| 1291 | escape = quote = False |
| 1292 | for cur in s: |
| 1293 | if escape: |
| 1294 | part += cur |
| 1295 | escape = False |
| 1296 | continue |
| 1297 | if quote: |
| 1298 | if cur == '\\': |
| 1299 | escape = True |
| 1300 | continue |
| 1301 | elif cur == '"': |
| 1302 | quote = False |
| 1303 | part += cur |
| 1304 | continue |
| 1305 | |
| 1306 | if cur == ',': |
| 1307 | res.append(part) |
| 1308 | part = '' |
| 1309 | continue |
| 1310 | |
| 1311 | if cur == '"': |
| 1312 | quote = True |
| 1313 | |
| 1314 | part += cur |
| 1315 | |
| 1316 | # append last part |
| 1317 | if part: |
| 1318 | res.append(part) |
| 1319 | |
| 1320 | return [part.strip() for part in res] |
| 1321 | |
| 1322 | class FileHandler(BaseHandler): |
| 1323 | # Use local file or FTP depending on form of URL |
| 1324 | def file_open(self, req): |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1325 | url = req.selector |
Senthil Kumaran | 2ef1632 | 2010-07-11 03:12:43 +0000 | [diff] [blame] | 1326 | if url[:2] == '//' and url[2:3] != '/' and (req.host and |
| 1327 | req.host != 'localhost'): |
Senthil Kumaran | bc07ac5 | 2014-07-22 00:15:20 -0700 | [diff] [blame] | 1328 | if not req.host in self.get_names(): |
Senthil Kumaran | 383c32d | 2010-10-14 11:57:35 +0000 | [diff] [blame] | 1329 | raise URLError("file:// scheme is supported only on localhost") |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1330 | else: |
| 1331 | return self.open_local_file(req) |
| 1332 | |
| 1333 | # names for the localhost |
| 1334 | names = None |
| 1335 | def get_names(self): |
| 1336 | if FileHandler.names is None: |
| 1337 | try: |
Senthil Kumaran | 99b2c8f | 2009-12-27 10:13:39 +0000 | [diff] [blame] | 1338 | FileHandler.names = tuple( |
| 1339 | socket.gethostbyname_ex('localhost')[2] + |
| 1340 | socket.gethostbyname_ex(socket.gethostname())[2]) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1341 | except socket.gaierror: |
| 1342 | FileHandler.names = (socket.gethostbyname('localhost'),) |
| 1343 | return FileHandler.names |
| 1344 | |
| 1345 | # not entirely sure what the rules are here |
| 1346 | def open_local_file(self, req): |
| 1347 | import email.utils |
| 1348 | import mimetypes |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1349 | host = req.host |
Senthil Kumaran | 06f5a53 | 2010-05-08 05:12:05 +0000 | [diff] [blame] | 1350 | filename = req.selector |
| 1351 | localfile = url2pathname(filename) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1352 | try: |
| 1353 | stats = os.stat(localfile) |
| 1354 | size = stats.st_size |
| 1355 | modified = email.utils.formatdate(stats.st_mtime, usegmt=True) |
Senthil Kumaran | 06f5a53 | 2010-05-08 05:12:05 +0000 | [diff] [blame] | 1356 | mtype = mimetypes.guess_type(filename)[0] |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1357 | headers = email.message_from_string( |
| 1358 | 'Content-type: %s\nContent-length: %d\nLast-modified: %s\n' % |
| 1359 | (mtype or 'text/plain', size, modified)) |
| 1360 | if host: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1361 | host, port = splitport(host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1362 | if not host or \ |
| 1363 | (not port and _safe_gethostbyname(host) in self.get_names()): |
Senthil Kumaran | 06f5a53 | 2010-05-08 05:12:05 +0000 | [diff] [blame] | 1364 | if host: |
| 1365 | origurl = 'file://' + host + filename |
| 1366 | else: |
| 1367 | origurl = 'file://' + filename |
| 1368 | return addinfourl(open(localfile, 'rb'), headers, origurl) |
Senthil Kumaran | 3ebef36 | 2012-10-21 18:31:25 -0700 | [diff] [blame] | 1369 | except OSError as exp: |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 1370 | # users shouldn't expect OSErrors coming from urlopen() |
Senthil Kumaran | 3ebef36 | 2012-10-21 18:31:25 -0700 | [diff] [blame] | 1371 | raise URLError(exp) |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1372 | raise URLError('file not on local host') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1373 | |
| 1374 | def _safe_gethostbyname(host): |
| 1375 | try: |
| 1376 | return socket.gethostbyname(host) |
| 1377 | except socket.gaierror: |
| 1378 | return None |
| 1379 | |
| 1380 | class FTPHandler(BaseHandler): |
| 1381 | def ftp_open(self, req): |
| 1382 | import ftplib |
| 1383 | import mimetypes |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1384 | host = req.host |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1385 | if not host: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1386 | raise URLError('ftp error: no host given') |
| 1387 | host, port = splitport(host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1388 | if port is None: |
| 1389 | port = ftplib.FTP_PORT |
| 1390 | else: |
| 1391 | port = int(port) |
| 1392 | |
| 1393 | # username/password handling |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1394 | user, host = splituser(host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1395 | if user: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1396 | user, passwd = splitpasswd(user) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1397 | else: |
| 1398 | passwd = None |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1399 | host = unquote(host) |
Senthil Kumaran | daa29d0 | 2010-11-18 15:36:41 +0000 | [diff] [blame] | 1400 | user = user or '' |
| 1401 | passwd = passwd or '' |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1402 | |
| 1403 | try: |
| 1404 | host = socket.gethostbyname(host) |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 1405 | except OSError as msg: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1406 | raise URLError(msg) |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1407 | path, attrs = splitattr(req.selector) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1408 | dirs = path.split('/') |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1409 | dirs = list(map(unquote, dirs)) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1410 | dirs, file = dirs[:-1], dirs[-1] |
| 1411 | if dirs and not dirs[0]: |
| 1412 | dirs = dirs[1:] |
| 1413 | try: |
| 1414 | fw = self.connect_ftp(user, passwd, host, port, dirs, req.timeout) |
| 1415 | type = file and 'I' or 'D' |
| 1416 | for attr in attrs: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1417 | attr, value = splitvalue(attr) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1418 | if attr.lower() == 'type' and \ |
| 1419 | value in ('a', 'A', 'i', 'I', 'd', 'D'): |
| 1420 | type = value.upper() |
| 1421 | fp, retrlen = fw.retrfile(file, type) |
| 1422 | headers = "" |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1423 | mtype = mimetypes.guess_type(req.full_url)[0] |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1424 | if mtype: |
| 1425 | headers += "Content-type: %s\n" % mtype |
| 1426 | if retrlen is not None and retrlen >= 0: |
| 1427 | headers += "Content-length: %d\n" % retrlen |
| 1428 | headers = email.message_from_string(headers) |
Jeremy Hylton | 6c5e28c | 2009-03-31 14:35:53 +0000 | [diff] [blame] | 1429 | return addinfourl(fp, headers, req.full_url) |
Senthil Kumaran | 3ebef36 | 2012-10-21 18:31:25 -0700 | [diff] [blame] | 1430 | except ftplib.all_errors as exp: |
| 1431 | exc = URLError('ftp error: %r' % exp) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1432 | raise exc.with_traceback(sys.exc_info()[2]) |
| 1433 | |
| 1434 | def connect_ftp(self, user, passwd, host, port, dirs, timeout): |
Nadeem Vawda | 08f5f7a | 2011-07-23 14:03:00 +0200 | [diff] [blame] | 1435 | return ftpwrapper(user, passwd, host, port, dirs, timeout, |
| 1436 | persistent=False) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1437 | |
| 1438 | class CacheFTPHandler(FTPHandler): |
| 1439 | # XXX would be nice to have pluggable cache strategies |
| 1440 | # XXX this stuff is definitely not thread safe |
| 1441 | def __init__(self): |
| 1442 | self.cache = {} |
| 1443 | self.timeout = {} |
| 1444 | self.soonest = 0 |
| 1445 | self.delay = 60 |
| 1446 | self.max_conns = 16 |
| 1447 | |
| 1448 | def setTimeout(self, t): |
| 1449 | self.delay = t |
| 1450 | |
| 1451 | def setMaxConns(self, m): |
| 1452 | self.max_conns = m |
| 1453 | |
| 1454 | def connect_ftp(self, user, passwd, host, port, dirs, timeout): |
| 1455 | key = user, host, port, '/'.join(dirs), timeout |
| 1456 | if key in self.cache: |
| 1457 | self.timeout[key] = time.time() + self.delay |
| 1458 | else: |
| 1459 | self.cache[key] = ftpwrapper(user, passwd, host, port, |
| 1460 | dirs, timeout) |
| 1461 | self.timeout[key] = time.time() + self.delay |
| 1462 | self.check_cache() |
| 1463 | return self.cache[key] |
| 1464 | |
| 1465 | def check_cache(self): |
| 1466 | # first check for old ones |
| 1467 | t = time.time() |
| 1468 | if self.soonest <= t: |
| 1469 | for k, v in list(self.timeout.items()): |
| 1470 | if v < t: |
| 1471 | self.cache[k].close() |
| 1472 | del self.cache[k] |
| 1473 | del self.timeout[k] |
| 1474 | self.soonest = min(list(self.timeout.values())) |
| 1475 | |
| 1476 | # then check the size |
| 1477 | if len(self.cache) == self.max_conns: |
| 1478 | for k, v in list(self.timeout.items()): |
| 1479 | if v == self.soonest: |
| 1480 | del self.cache[k] |
| 1481 | del self.timeout[k] |
| 1482 | break |
| 1483 | self.soonest = min(list(self.timeout.values())) |
| 1484 | |
Nadeem Vawda | 08f5f7a | 2011-07-23 14:03:00 +0200 | [diff] [blame] | 1485 | def clear_cache(self): |
| 1486 | for conn in self.cache.values(): |
| 1487 | conn.close() |
| 1488 | self.cache.clear() |
| 1489 | self.timeout.clear() |
| 1490 | |
Antoine Pitrou | df204be | 2012-11-24 17:59:08 +0100 | [diff] [blame] | 1491 | class DataHandler(BaseHandler): |
| 1492 | def data_open(self, req): |
| 1493 | # data URLs as specified in RFC 2397. |
| 1494 | # |
| 1495 | # ignores POSTed data |
| 1496 | # |
| 1497 | # syntax: |
| 1498 | # dataurl := "data:" [ mediatype ] [ ";base64" ] "," data |
| 1499 | # mediatype := [ type "/" subtype ] *( ";" parameter ) |
| 1500 | # data := *urlchar |
| 1501 | # parameter := attribute "=" value |
| 1502 | url = req.full_url |
| 1503 | |
| 1504 | scheme, data = url.split(":",1) |
| 1505 | mediatype, data = data.split(",",1) |
| 1506 | |
| 1507 | # even base64 encoded data URLs might be quoted so unquote in any case: |
| 1508 | data = unquote_to_bytes(data) |
| 1509 | if mediatype.endswith(";base64"): |
| 1510 | data = base64.decodebytes(data) |
| 1511 | mediatype = mediatype[:-7] |
| 1512 | |
| 1513 | if not mediatype: |
| 1514 | mediatype = "text/plain;charset=US-ASCII" |
| 1515 | |
| 1516 | headers = email.message_from_string("Content-type: %s\nContent-length: %d\n" % |
| 1517 | (mediatype, len(data))) |
| 1518 | |
| 1519 | return addinfourl(io.BytesIO(data), headers, url) |
| 1520 | |
Nadeem Vawda | 08f5f7a | 2011-07-23 14:03:00 +0200 | [diff] [blame] | 1521 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1522 | # Code move from the old urllib module |
| 1523 | |
| 1524 | MAXFTPCACHE = 10 # Trim the ftp cache beyond this size |
| 1525 | |
| 1526 | # Helper for non-unix systems |
Ronald Oussoren | 94f2528 | 2010-05-05 19:11:21 +0000 | [diff] [blame] | 1527 | if os.name == 'nt': |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1528 | from nturl2path import url2pathname, pathname2url |
| 1529 | else: |
| 1530 | def url2pathname(pathname): |
| 1531 | """OS-specific conversion from a relative URL of the 'file' scheme |
| 1532 | to a file system path; not recommended for general use.""" |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1533 | return unquote(pathname) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1534 | |
| 1535 | def pathname2url(pathname): |
| 1536 | """OS-specific conversion from a file system path to a relative URL |
| 1537 | of the 'file' scheme; not recommended for general use.""" |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1538 | return quote(pathname) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1539 | |
| 1540 | # This really consists of two pieces: |
| 1541 | # (1) a class which handles opening of all sorts of URLs |
| 1542 | # (plus assorted utilities etc.) |
| 1543 | # (2) a set of functions for parsing URLs |
| 1544 | # XXX Should these be separated out into different modules? |
| 1545 | |
| 1546 | |
| 1547 | ftpcache = {} |
| 1548 | class URLopener: |
| 1549 | """Class to open URLs. |
| 1550 | This is a class rather than just a subroutine because we may need |
| 1551 | more than one set of global protocol-specific options. |
| 1552 | Note -- this is a base class for those who don't want the |
| 1553 | automatic handling of errors type 302 (relocated) and 401 |
| 1554 | (authorization needed).""" |
| 1555 | |
| 1556 | __tempfiles = None |
| 1557 | |
| 1558 | version = "Python-urllib/%s" % __version__ |
| 1559 | |
| 1560 | # Constructor |
| 1561 | def __init__(self, proxies=None, **x509): |
Georg Brandl | fcbdbf2 | 2012-06-24 19:56:31 +0200 | [diff] [blame] | 1562 | msg = "%(class)s style of invoking requests is deprecated. " \ |
Senthil Kumaran | 38b968b9 | 2012-03-14 13:43:53 -0700 | [diff] [blame] | 1563 | "Use newer urlopen functions/methods" % {'class': self.__class__.__name__} |
| 1564 | warnings.warn(msg, DeprecationWarning, stacklevel=3) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1565 | if proxies is None: |
| 1566 | proxies = getproxies() |
| 1567 | assert hasattr(proxies, 'keys'), "proxies must be a mapping" |
| 1568 | self.proxies = proxies |
| 1569 | self.key_file = x509.get('key_file') |
| 1570 | self.cert_file = x509.get('cert_file') |
| 1571 | self.addheaders = [('User-Agent', self.version)] |
| 1572 | self.__tempfiles = [] |
| 1573 | self.__unlink = os.unlink # See cleanup() |
| 1574 | self.tempcache = None |
| 1575 | # Undocumented feature: if you assign {} to tempcache, |
| 1576 | # it is used to cache files retrieved with |
| 1577 | # self.retrieve(). This is not enabled by default |
| 1578 | # since it does not work for changing documents (and I |
| 1579 | # haven't got the logic to check expiration headers |
| 1580 | # yet). |
| 1581 | self.ftpcache = ftpcache |
| 1582 | # Undocumented feature: you can use a different |
| 1583 | # ftp cache by assigning to the .ftpcache member; |
| 1584 | # in case you want logically independent URL openers |
| 1585 | # XXX This is not threadsafe. Bah. |
| 1586 | |
| 1587 | def __del__(self): |
| 1588 | self.close() |
| 1589 | |
| 1590 | def close(self): |
| 1591 | self.cleanup() |
| 1592 | |
| 1593 | def cleanup(self): |
| 1594 | # This code sometimes runs when the rest of this module |
| 1595 | # has already been deleted, so it can't use any globals |
| 1596 | # or import anything. |
| 1597 | if self.__tempfiles: |
| 1598 | for file in self.__tempfiles: |
| 1599 | try: |
| 1600 | self.__unlink(file) |
| 1601 | except OSError: |
| 1602 | pass |
| 1603 | del self.__tempfiles[:] |
| 1604 | if self.tempcache: |
| 1605 | self.tempcache.clear() |
| 1606 | |
| 1607 | def addheader(self, *args): |
| 1608 | """Add a header to be used by the HTTP interface only |
| 1609 | e.g. u.addheader('Accept', 'sound/basic')""" |
| 1610 | self.addheaders.append(args) |
| 1611 | |
| 1612 | # External interface |
| 1613 | def open(self, fullurl, data=None): |
| 1614 | """Use URLopener().open(file) instead of open(file, 'r').""" |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1615 | fullurl = unwrap(to_bytes(fullurl)) |
Senthil Kumaran | 734f059 | 2010-02-20 22:19:04 +0000 | [diff] [blame] | 1616 | fullurl = quote(fullurl, safe="%/:=&?~#+!$,;'@()*[]|") |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1617 | if self.tempcache and fullurl in self.tempcache: |
| 1618 | filename, headers = self.tempcache[fullurl] |
| 1619 | fp = open(filename, 'rb') |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1620 | return addinfourl(fp, headers, fullurl) |
| 1621 | urltype, url = splittype(fullurl) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1622 | if not urltype: |
| 1623 | urltype = 'file' |
| 1624 | if urltype in self.proxies: |
| 1625 | proxy = self.proxies[urltype] |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1626 | urltype, proxyhost = splittype(proxy) |
| 1627 | host, selector = splithost(proxyhost) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1628 | url = (host, fullurl) # Signal special case to open_*() |
| 1629 | else: |
| 1630 | proxy = None |
| 1631 | name = 'open_' + urltype |
| 1632 | self.type = urltype |
| 1633 | name = name.replace('-', '_') |
| 1634 | if not hasattr(self, name): |
| 1635 | if proxy: |
| 1636 | return self.open_unknown_proxy(proxy, fullurl, data) |
| 1637 | else: |
| 1638 | return self.open_unknown(fullurl, data) |
| 1639 | try: |
| 1640 | if data is None: |
| 1641 | return getattr(self, name)(url) |
| 1642 | else: |
| 1643 | return getattr(self, name)(url, data) |
Senthil Kumaran | f577686 | 2012-10-21 13:30:02 -0700 | [diff] [blame] | 1644 | except (HTTPError, URLError): |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 1645 | raise |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 1646 | except OSError as msg: |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 1647 | raise OSError('socket error', msg).with_traceback(sys.exc_info()[2]) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1648 | |
| 1649 | def open_unknown(self, fullurl, data=None): |
| 1650 | """Overridable interface to open unknown URL type.""" |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1651 | type, url = splittype(fullurl) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 1652 | raise OSError('url error', 'unknown url type', type) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1653 | |
| 1654 | def open_unknown_proxy(self, proxy, fullurl, data=None): |
| 1655 | """Overridable interface to open unknown URL type.""" |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1656 | type, url = splittype(fullurl) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 1657 | raise OSError('url error', 'invalid proxy for %s' % type, proxy) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1658 | |
| 1659 | # External interface |
| 1660 | def retrieve(self, url, filename=None, reporthook=None, data=None): |
| 1661 | """retrieve(url) returns (filename, headers) for a local object |
| 1662 | or (tempfilename, headers) for a remote object.""" |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1663 | url = unwrap(to_bytes(url)) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1664 | if self.tempcache and url in self.tempcache: |
| 1665 | return self.tempcache[url] |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1666 | type, url1 = splittype(url) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1667 | if filename is None and (not type or type == 'file'): |
| 1668 | try: |
| 1669 | fp = self.open_local_file(url1) |
| 1670 | hdrs = fp.info() |
Philip Jenvey | cb134d7 | 2009-12-03 02:45:01 +0000 | [diff] [blame] | 1671 | fp.close() |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1672 | return url2pathname(splithost(url1)[1]), hdrs |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 1673 | except OSError as msg: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1674 | pass |
| 1675 | fp = self.open(url, data) |
Benjamin Peterson | 5f28b7b | 2009-03-26 21:49:58 +0000 | [diff] [blame] | 1676 | try: |
| 1677 | headers = fp.info() |
| 1678 | if filename: |
| 1679 | tfp = open(filename, 'wb') |
| 1680 | else: |
| 1681 | import tempfile |
| 1682 | garbage, path = splittype(url) |
| 1683 | garbage, path = splithost(path or "") |
| 1684 | path, garbage = splitquery(path or "") |
| 1685 | path, garbage = splitattr(path or "") |
| 1686 | suffix = os.path.splitext(path)[1] |
| 1687 | (fd, filename) = tempfile.mkstemp(suffix) |
| 1688 | self.__tempfiles.append(filename) |
| 1689 | tfp = os.fdopen(fd, 'wb') |
| 1690 | try: |
| 1691 | result = filename, headers |
| 1692 | if self.tempcache is not None: |
| 1693 | self.tempcache[url] = result |
| 1694 | bs = 1024*8 |
| 1695 | size = -1 |
| 1696 | read = 0 |
| 1697 | blocknum = 0 |
Senthil Kumaran | ce26014 | 2011-11-01 01:35:17 +0800 | [diff] [blame] | 1698 | if "content-length" in headers: |
| 1699 | size = int(headers["Content-Length"]) |
Benjamin Peterson | 5f28b7b | 2009-03-26 21:49:58 +0000 | [diff] [blame] | 1700 | if reporthook: |
Benjamin Peterson | 5f28b7b | 2009-03-26 21:49:58 +0000 | [diff] [blame] | 1701 | reporthook(blocknum, bs, size) |
| 1702 | while 1: |
| 1703 | block = fp.read(bs) |
| 1704 | if not block: |
| 1705 | break |
| 1706 | read += len(block) |
| 1707 | tfp.write(block) |
| 1708 | blocknum += 1 |
| 1709 | if reporthook: |
| 1710 | reporthook(blocknum, bs, size) |
| 1711 | finally: |
| 1712 | tfp.close() |
| 1713 | finally: |
| 1714 | fp.close() |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1715 | |
| 1716 | # raise exception if actual size does not match content-length header |
| 1717 | if size >= 0 and read < size: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1718 | raise ContentTooShortError( |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1719 | "retrieval incomplete: got only %i out of %i bytes" |
| 1720 | % (read, size), result) |
| 1721 | |
| 1722 | return result |
| 1723 | |
| 1724 | # Each method named open_<type> knows how to open that type of URL |
| 1725 | |
| 1726 | def _open_generic_http(self, connection_factory, url, data): |
| 1727 | """Make an HTTP connection using connection_class. |
| 1728 | |
| 1729 | This is an internal method that should be called from |
| 1730 | open_http() or open_https(). |
| 1731 | |
| 1732 | Arguments: |
| 1733 | - connection_factory should take a host name and return an |
| 1734 | HTTPConnection instance. |
| 1735 | - url is the url to retrieval or a host, relative-path pair. |
| 1736 | - data is payload for a POST request or None. |
| 1737 | """ |
| 1738 | |
| 1739 | user_passwd = None |
| 1740 | proxy_passwd= None |
| 1741 | if isinstance(url, str): |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1742 | host, selector = splithost(url) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1743 | if host: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1744 | user_passwd, host = splituser(host) |
| 1745 | host = unquote(host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1746 | realhost = host |
| 1747 | else: |
| 1748 | host, selector = url |
| 1749 | # check whether the proxy contains authorization information |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1750 | proxy_passwd, host = splituser(host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1751 | # now we proceed with the url we want to obtain |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1752 | urltype, rest = splittype(selector) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1753 | url = rest |
| 1754 | user_passwd = None |
| 1755 | if urltype.lower() != 'http': |
| 1756 | realhost = None |
| 1757 | else: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1758 | realhost, rest = splithost(rest) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1759 | if realhost: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1760 | user_passwd, realhost = splituser(realhost) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1761 | if user_passwd: |
| 1762 | selector = "%s://%s%s" % (urltype, realhost, rest) |
| 1763 | if proxy_bypass(realhost): |
| 1764 | host = realhost |
| 1765 | |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 1766 | if not host: raise OSError('http error', 'no host given') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1767 | |
| 1768 | if proxy_passwd: |
Senthil Kumaran | c5c5a14 | 2012-01-14 19:09:04 +0800 | [diff] [blame] | 1769 | proxy_passwd = unquote(proxy_passwd) |
Senthil Kumaran | 5626eec | 2010-08-04 17:46:23 +0000 | [diff] [blame] | 1770 | proxy_auth = base64.b64encode(proxy_passwd.encode()).decode('ascii') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1771 | else: |
| 1772 | proxy_auth = None |
| 1773 | |
| 1774 | if user_passwd: |
Senthil Kumaran | c5c5a14 | 2012-01-14 19:09:04 +0800 | [diff] [blame] | 1775 | user_passwd = unquote(user_passwd) |
Senthil Kumaran | 5626eec | 2010-08-04 17:46:23 +0000 | [diff] [blame] | 1776 | auth = base64.b64encode(user_passwd.encode()).decode('ascii') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1777 | else: |
| 1778 | auth = None |
| 1779 | http_conn = connection_factory(host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1780 | headers = {} |
| 1781 | if proxy_auth: |
| 1782 | headers["Proxy-Authorization"] = "Basic %s" % proxy_auth |
| 1783 | if auth: |
| 1784 | headers["Authorization"] = "Basic %s" % auth |
| 1785 | if realhost: |
| 1786 | headers["Host"] = realhost |
Senthil Kumaran | d91ffca | 2011-03-19 17:25:27 +0800 | [diff] [blame] | 1787 | |
| 1788 | # Add Connection:close as we don't support persistent connections yet. |
| 1789 | # This helps in closing the socket and avoiding ResourceWarning |
| 1790 | |
| 1791 | headers["Connection"] = "close" |
| 1792 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1793 | for header, value in self.addheaders: |
| 1794 | headers[header] = value |
| 1795 | |
| 1796 | if data is not None: |
| 1797 | headers["Content-Type"] = "application/x-www-form-urlencoded" |
| 1798 | http_conn.request("POST", selector, data, headers) |
| 1799 | else: |
| 1800 | http_conn.request("GET", selector, headers=headers) |
| 1801 | |
| 1802 | try: |
| 1803 | response = http_conn.getresponse() |
| 1804 | except http.client.BadStatusLine: |
| 1805 | # something went wrong with the HTTP status line |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1806 | raise URLError("http protocol error: bad status line") |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1807 | |
| 1808 | # According to RFC 2616, "2xx" code indicates that the client's |
| 1809 | # request was successfully received, understood, and accepted. |
| 1810 | if 200 <= response.status < 300: |
Antoine Pitrou | b353c12 | 2009-02-11 00:39:14 +0000 | [diff] [blame] | 1811 | return addinfourl(response, response.msg, "http:" + url, |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1812 | response.status) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1813 | else: |
| 1814 | return self.http_error( |
| 1815 | url, response.fp, |
| 1816 | response.status, response.reason, response.msg, data) |
| 1817 | |
| 1818 | def open_http(self, url, data=None): |
| 1819 | """Use HTTP protocol.""" |
| 1820 | return self._open_generic_http(http.client.HTTPConnection, url, data) |
| 1821 | |
| 1822 | def http_error(self, url, fp, errcode, errmsg, headers, data=None): |
| 1823 | """Handle http errors. |
| 1824 | |
| 1825 | Derived class can override this, or provide specific handlers |
| 1826 | named http_error_DDD where DDD is the 3-digit error code.""" |
| 1827 | # First check if there's a specific handler for this error |
| 1828 | name = 'http_error_%d' % errcode |
| 1829 | if hasattr(self, name): |
| 1830 | method = getattr(self, name) |
| 1831 | if data is None: |
| 1832 | result = method(url, fp, errcode, errmsg, headers) |
| 1833 | else: |
| 1834 | result = method(url, fp, errcode, errmsg, headers, data) |
| 1835 | if result: return result |
| 1836 | return self.http_error_default(url, fp, errcode, errmsg, headers) |
| 1837 | |
| 1838 | def http_error_default(self, url, fp, errcode, errmsg, headers): |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 1839 | """Default error handler: close the connection and raise OSError.""" |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1840 | fp.close() |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1841 | raise HTTPError(url, errcode, errmsg, headers, None) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1842 | |
| 1843 | if _have_ssl: |
| 1844 | def _https_connection(self, host): |
| 1845 | return http.client.HTTPSConnection(host, |
| 1846 | key_file=self.key_file, |
| 1847 | cert_file=self.cert_file) |
| 1848 | |
| 1849 | def open_https(self, url, data=None): |
| 1850 | """Use HTTPS protocol.""" |
| 1851 | return self._open_generic_http(self._https_connection, url, data) |
| 1852 | |
| 1853 | def open_file(self, url): |
| 1854 | """Use local file or FTP depending on form of URL.""" |
| 1855 | if not isinstance(url, str): |
Senthil Kumaran | 3ebef36 | 2012-10-21 18:31:25 -0700 | [diff] [blame] | 1856 | raise URLError('file error: proxy support for file protocol currently not implemented') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1857 | if url[:2] == '//' and url[2:3] != '/' and url[2:12].lower() != 'localhost/': |
Senthil Kumaran | 383c32d | 2010-10-14 11:57:35 +0000 | [diff] [blame] | 1858 | raise ValueError("file:// scheme is supported only on localhost") |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1859 | else: |
| 1860 | return self.open_local_file(url) |
| 1861 | |
| 1862 | def open_local_file(self, url): |
| 1863 | """Use local file.""" |
Senthil Kumaran | 6c5bd40 | 2011-11-01 23:20:31 +0800 | [diff] [blame] | 1864 | import email.utils |
| 1865 | import mimetypes |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1866 | host, file = splithost(url) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1867 | localname = url2pathname(file) |
| 1868 | try: |
| 1869 | stats = os.stat(localname) |
| 1870 | except OSError as e: |
Senthil Kumaran | f577686 | 2012-10-21 13:30:02 -0700 | [diff] [blame] | 1871 | raise URLError(e.strerror, e.filename) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1872 | size = stats.st_size |
| 1873 | modified = email.utils.formatdate(stats.st_mtime, usegmt=True) |
| 1874 | mtype = mimetypes.guess_type(url)[0] |
| 1875 | headers = email.message_from_string( |
| 1876 | 'Content-Type: %s\nContent-Length: %d\nLast-modified: %s\n' % |
| 1877 | (mtype or 'text/plain', size, modified)) |
| 1878 | if not host: |
| 1879 | urlfile = file |
| 1880 | if file[:1] == '/': |
| 1881 | urlfile = 'file://' + file |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1882 | return addinfourl(open(localname, 'rb'), headers, urlfile) |
| 1883 | host, port = splitport(host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1884 | if (not port |
Senthil Kumaran | 40d8078 | 2012-10-22 09:43:04 -0700 | [diff] [blame] | 1885 | and socket.gethostbyname(host) in ((localhost(),) + thishost())): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1886 | urlfile = file |
| 1887 | if file[:1] == '/': |
| 1888 | urlfile = 'file://' + file |
Senthil Kumaran | 3800ea9 | 2012-01-21 11:52:48 +0800 | [diff] [blame] | 1889 | elif file[:2] == './': |
| 1890 | raise ValueError("local file url may start with / or file:. Unknown url of type: %s" % url) |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1891 | return addinfourl(open(localname, 'rb'), headers, urlfile) |
Senthil Kumaran | 3ebef36 | 2012-10-21 18:31:25 -0700 | [diff] [blame] | 1892 | raise URLError('local file error: not on local host') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1893 | |
| 1894 | def open_ftp(self, url): |
| 1895 | """Use FTP protocol.""" |
| 1896 | if not isinstance(url, str): |
Senthil Kumaran | 3ebef36 | 2012-10-21 18:31:25 -0700 | [diff] [blame] | 1897 | raise URLError('ftp error: proxy support for ftp protocol currently not implemented') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1898 | import mimetypes |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1899 | host, path = splithost(url) |
Senthil Kumaran | 3ebef36 | 2012-10-21 18:31:25 -0700 | [diff] [blame] | 1900 | if not host: raise URLError('ftp error: no host given') |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1901 | host, port = splitport(host) |
| 1902 | user, host = splituser(host) |
| 1903 | if user: user, passwd = splitpasswd(user) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1904 | else: passwd = None |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1905 | host = unquote(host) |
| 1906 | user = unquote(user or '') |
| 1907 | passwd = unquote(passwd or '') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1908 | host = socket.gethostbyname(host) |
| 1909 | if not port: |
| 1910 | import ftplib |
| 1911 | port = ftplib.FTP_PORT |
| 1912 | else: |
| 1913 | port = int(port) |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1914 | path, attrs = splitattr(path) |
| 1915 | path = unquote(path) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1916 | dirs = path.split('/') |
| 1917 | dirs, file = dirs[:-1], dirs[-1] |
| 1918 | if dirs and not dirs[0]: dirs = dirs[1:] |
| 1919 | if dirs and not dirs[0]: dirs[0] = '/' |
| 1920 | key = user, host, port, '/'.join(dirs) |
| 1921 | # XXX thread unsafe! |
| 1922 | if len(self.ftpcache) > MAXFTPCACHE: |
| 1923 | # Prune the cache, rather arbitrarily |
Benjamin Peterson | 3c2dca6 | 2014-06-07 15:08:04 -0700 | [diff] [blame] | 1924 | for k in list(self.ftpcache): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1925 | if k != key: |
| 1926 | v = self.ftpcache[k] |
| 1927 | del self.ftpcache[k] |
| 1928 | v.close() |
| 1929 | try: |
Senthil Kumaran | 34d38dc | 2011-10-20 02:48:01 +0800 | [diff] [blame] | 1930 | if key not in self.ftpcache: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1931 | self.ftpcache[key] = \ |
| 1932 | ftpwrapper(user, passwd, host, port, dirs) |
| 1933 | if not file: type = 'D' |
| 1934 | else: type = 'I' |
| 1935 | for attr in attrs: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1936 | attr, value = splitvalue(attr) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1937 | if attr.lower() == 'type' and \ |
| 1938 | value in ('a', 'A', 'i', 'I', 'd', 'D'): |
| 1939 | type = value.upper() |
| 1940 | (fp, retrlen) = self.ftpcache[key].retrfile(file, type) |
| 1941 | mtype = mimetypes.guess_type("ftp:" + url)[0] |
| 1942 | headers = "" |
| 1943 | if mtype: |
| 1944 | headers += "Content-Type: %s\n" % mtype |
| 1945 | if retrlen is not None and retrlen >= 0: |
| 1946 | headers += "Content-Length: %d\n" % retrlen |
| 1947 | headers = email.message_from_string(headers) |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1948 | return addinfourl(fp, headers, "ftp:" + url) |
Senthil Kumaran | 3ebef36 | 2012-10-21 18:31:25 -0700 | [diff] [blame] | 1949 | except ftperrors() as exp: |
| 1950 | raise URLError('ftp error %r' % exp).with_traceback(sys.exc_info()[2]) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1951 | |
| 1952 | def open_data(self, url, data=None): |
| 1953 | """Use "data" URL.""" |
| 1954 | if not isinstance(url, str): |
Senthil Kumaran | 3ebef36 | 2012-10-21 18:31:25 -0700 | [diff] [blame] | 1955 | raise URLError('data error: proxy support for data protocol currently not implemented') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1956 | # ignore POSTed data |
| 1957 | # |
| 1958 | # syntax of data URLs: |
| 1959 | # dataurl := "data:" [ mediatype ] [ ";base64" ] "," data |
| 1960 | # mediatype := [ type "/" subtype ] *( ";" parameter ) |
| 1961 | # data := *urlchar |
| 1962 | # parameter := attribute "=" value |
| 1963 | try: |
| 1964 | [type, data] = url.split(',', 1) |
| 1965 | except ValueError: |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 1966 | raise OSError('data error', 'bad data URL') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1967 | if not type: |
| 1968 | type = 'text/plain;charset=US-ASCII' |
| 1969 | semi = type.rfind(';') |
| 1970 | if semi >= 0 and '=' not in type[semi:]: |
| 1971 | encoding = type[semi+1:] |
| 1972 | type = type[:semi] |
| 1973 | else: |
| 1974 | encoding = '' |
| 1975 | msg = [] |
Senthil Kumaran | f6c456d | 2010-05-01 08:29:18 +0000 | [diff] [blame] | 1976 | msg.append('Date: %s'%time.strftime('%a, %d %b %Y %H:%M:%S GMT', |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1977 | time.gmtime(time.time()))) |
| 1978 | msg.append('Content-type: %s' % type) |
| 1979 | if encoding == 'base64': |
Georg Brandl | 706824f | 2009-06-04 09:42:55 +0000 | [diff] [blame] | 1980 | # XXX is this encoding/decoding ok? |
Marc-André Lemburg | 8f36af7 | 2011-02-25 15:42:01 +0000 | [diff] [blame] | 1981 | data = base64.decodebytes(data.encode('ascii')).decode('latin-1') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1982 | else: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1983 | data = unquote(data) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1984 | msg.append('Content-Length: %d' % len(data)) |
| 1985 | msg.append('') |
| 1986 | msg.append(data) |
| 1987 | msg = '\n'.join(msg) |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1988 | headers = email.message_from_string(msg) |
| 1989 | f = io.StringIO(msg) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1990 | #f.fileno = None # needed for addinfourl |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 1991 | return addinfourl(f, headers, url) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 1992 | |
| 1993 | |
| 1994 | class FancyURLopener(URLopener): |
| 1995 | """Derived class with handlers for errors we can handle (perhaps).""" |
| 1996 | |
| 1997 | def __init__(self, *args, **kwargs): |
| 1998 | URLopener.__init__(self, *args, **kwargs) |
| 1999 | self.auth_cache = {} |
| 2000 | self.tries = 0 |
| 2001 | self.maxtries = 10 |
| 2002 | |
| 2003 | def http_error_default(self, url, fp, errcode, errmsg, headers): |
| 2004 | """Default error handling -- don't raise an exception.""" |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2005 | return addinfourl(fp, headers, "http:" + url, errcode) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2006 | |
| 2007 | def http_error_302(self, url, fp, errcode, errmsg, headers, data=None): |
| 2008 | """Error 302 -- relocated (temporarily).""" |
| 2009 | self.tries += 1 |
| 2010 | if self.maxtries and self.tries >= self.maxtries: |
| 2011 | if hasattr(self, "http_error_500"): |
| 2012 | meth = self.http_error_500 |
| 2013 | else: |
| 2014 | meth = self.http_error_default |
| 2015 | self.tries = 0 |
| 2016 | return meth(url, fp, 500, |
| 2017 | "Internal Server Error: Redirect Recursion", headers) |
| 2018 | result = self.redirect_internal(url, fp, errcode, errmsg, headers, |
| 2019 | data) |
| 2020 | self.tries = 0 |
| 2021 | return result |
| 2022 | |
| 2023 | def redirect_internal(self, url, fp, errcode, errmsg, headers, data): |
| 2024 | if 'location' in headers: |
| 2025 | newurl = headers['location'] |
| 2026 | elif 'uri' in headers: |
| 2027 | newurl = headers['uri'] |
| 2028 | else: |
| 2029 | return |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2030 | fp.close() |
guido@google.com | a119df9 | 2011-03-29 11:41:02 -0700 | [diff] [blame] | 2031 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2032 | # In case the server sent a relative URL, join with original: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2033 | newurl = urljoin(self.type + ":" + url, newurl) |
guido@google.com | a119df9 | 2011-03-29 11:41:02 -0700 | [diff] [blame] | 2034 | |
| 2035 | urlparts = urlparse(newurl) |
| 2036 | |
| 2037 | # For security reasons, we don't allow redirection to anything other |
| 2038 | # than http, https and ftp. |
| 2039 | |
| 2040 | # We are using newer HTTPError with older redirect_internal method |
| 2041 | # This older method will get deprecated in 3.3 |
| 2042 | |
Senthil Kumaran | 6497aa3 | 2012-01-04 13:46:59 +0800 | [diff] [blame] | 2043 | if urlparts.scheme not in ('http', 'https', 'ftp', ''): |
guido@google.com | a119df9 | 2011-03-29 11:41:02 -0700 | [diff] [blame] | 2044 | raise HTTPError(newurl, errcode, |
| 2045 | errmsg + |
| 2046 | " Redirection to url '%s' is not allowed." % newurl, |
| 2047 | headers, fp) |
| 2048 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2049 | return self.open(newurl) |
| 2050 | |
| 2051 | def http_error_301(self, url, fp, errcode, errmsg, headers, data=None): |
| 2052 | """Error 301 -- also relocated (permanently).""" |
| 2053 | return self.http_error_302(url, fp, errcode, errmsg, headers, data) |
| 2054 | |
| 2055 | def http_error_303(self, url, fp, errcode, errmsg, headers, data=None): |
| 2056 | """Error 303 -- also relocated (essentially identical to 302).""" |
| 2057 | return self.http_error_302(url, fp, errcode, errmsg, headers, data) |
| 2058 | |
| 2059 | def http_error_307(self, url, fp, errcode, errmsg, headers, data=None): |
| 2060 | """Error 307 -- relocated, but turn POST into error.""" |
| 2061 | if data is None: |
| 2062 | return self.http_error_302(url, fp, errcode, errmsg, headers, data) |
| 2063 | else: |
| 2064 | return self.http_error_default(url, fp, errcode, errmsg, headers) |
| 2065 | |
Senthil Kumaran | 80f1b05 | 2010-06-18 15:08:18 +0000 | [diff] [blame] | 2066 | def http_error_401(self, url, fp, errcode, errmsg, headers, data=None, |
| 2067 | retry=False): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2068 | """Error 401 -- authentication required. |
| 2069 | This function supports Basic authentication only.""" |
Senthil Kumaran | 34d38dc | 2011-10-20 02:48:01 +0800 | [diff] [blame] | 2070 | if 'www-authenticate' not in headers: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2071 | URLopener.http_error_default(self, url, fp, |
| 2072 | errcode, errmsg, headers) |
| 2073 | stuff = headers['www-authenticate'] |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2074 | match = re.match('[ \t]*([^ \t]+)[ \t]+realm="([^"]*)"', stuff) |
| 2075 | if not match: |
| 2076 | URLopener.http_error_default(self, url, fp, |
| 2077 | errcode, errmsg, headers) |
| 2078 | scheme, realm = match.groups() |
| 2079 | if scheme.lower() != 'basic': |
| 2080 | URLopener.http_error_default(self, url, fp, |
| 2081 | errcode, errmsg, headers) |
Senthil Kumaran | 80f1b05 | 2010-06-18 15:08:18 +0000 | [diff] [blame] | 2082 | if not retry: |
| 2083 | URLopener.http_error_default(self, url, fp, errcode, errmsg, |
| 2084 | headers) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2085 | name = 'retry_' + self.type + '_basic_auth' |
| 2086 | if data is None: |
| 2087 | return getattr(self,name)(url, realm) |
| 2088 | else: |
| 2089 | return getattr(self,name)(url, realm, data) |
| 2090 | |
Senthil Kumaran | 80f1b05 | 2010-06-18 15:08:18 +0000 | [diff] [blame] | 2091 | def http_error_407(self, url, fp, errcode, errmsg, headers, data=None, |
| 2092 | retry=False): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2093 | """Error 407 -- proxy authentication required. |
| 2094 | This function supports Basic authentication only.""" |
Senthil Kumaran | 34d38dc | 2011-10-20 02:48:01 +0800 | [diff] [blame] | 2095 | if 'proxy-authenticate' not in headers: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2096 | URLopener.http_error_default(self, url, fp, |
| 2097 | errcode, errmsg, headers) |
| 2098 | stuff = headers['proxy-authenticate'] |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2099 | match = re.match('[ \t]*([^ \t]+)[ \t]+realm="([^"]*)"', stuff) |
| 2100 | if not match: |
| 2101 | URLopener.http_error_default(self, url, fp, |
| 2102 | errcode, errmsg, headers) |
| 2103 | scheme, realm = match.groups() |
| 2104 | if scheme.lower() != 'basic': |
| 2105 | URLopener.http_error_default(self, url, fp, |
| 2106 | errcode, errmsg, headers) |
Senthil Kumaran | 80f1b05 | 2010-06-18 15:08:18 +0000 | [diff] [blame] | 2107 | if not retry: |
| 2108 | URLopener.http_error_default(self, url, fp, errcode, errmsg, |
| 2109 | headers) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2110 | name = 'retry_proxy_' + self.type + '_basic_auth' |
| 2111 | if data is None: |
| 2112 | return getattr(self,name)(url, realm) |
| 2113 | else: |
| 2114 | return getattr(self,name)(url, realm, data) |
| 2115 | |
| 2116 | def retry_proxy_http_basic_auth(self, url, realm, data=None): |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2117 | host, selector = splithost(url) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2118 | newurl = 'http://' + host + selector |
| 2119 | proxy = self.proxies['http'] |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2120 | urltype, proxyhost = splittype(proxy) |
| 2121 | proxyhost, proxyselector = splithost(proxyhost) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2122 | i = proxyhost.find('@') + 1 |
| 2123 | proxyhost = proxyhost[i:] |
| 2124 | user, passwd = self.get_user_passwd(proxyhost, realm, i) |
| 2125 | if not (user or passwd): return None |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2126 | proxyhost = "%s:%s@%s" % (quote(user, safe=''), |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2127 | quote(passwd, safe=''), proxyhost) |
| 2128 | self.proxies['http'] = 'http://' + proxyhost + proxyselector |
| 2129 | if data is None: |
| 2130 | return self.open(newurl) |
| 2131 | else: |
| 2132 | return self.open(newurl, data) |
| 2133 | |
| 2134 | def retry_proxy_https_basic_auth(self, url, realm, data=None): |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2135 | host, selector = splithost(url) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2136 | newurl = 'https://' + host + selector |
| 2137 | proxy = self.proxies['https'] |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2138 | urltype, proxyhost = splittype(proxy) |
| 2139 | proxyhost, proxyselector = splithost(proxyhost) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2140 | i = proxyhost.find('@') + 1 |
| 2141 | proxyhost = proxyhost[i:] |
| 2142 | user, passwd = self.get_user_passwd(proxyhost, realm, i) |
| 2143 | if not (user or passwd): return None |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2144 | proxyhost = "%s:%s@%s" % (quote(user, safe=''), |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2145 | quote(passwd, safe=''), proxyhost) |
| 2146 | self.proxies['https'] = 'https://' + proxyhost + proxyselector |
| 2147 | if data is None: |
| 2148 | return self.open(newurl) |
| 2149 | else: |
| 2150 | return self.open(newurl, data) |
| 2151 | |
| 2152 | def retry_http_basic_auth(self, url, realm, data=None): |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2153 | host, selector = splithost(url) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2154 | i = host.find('@') + 1 |
| 2155 | host = host[i:] |
| 2156 | user, passwd = self.get_user_passwd(host, realm, i) |
| 2157 | if not (user or passwd): return None |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2158 | host = "%s:%s@%s" % (quote(user, safe=''), |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2159 | quote(passwd, safe=''), host) |
| 2160 | newurl = 'http://' + host + selector |
| 2161 | if data is None: |
| 2162 | return self.open(newurl) |
| 2163 | else: |
| 2164 | return self.open(newurl, data) |
| 2165 | |
| 2166 | def retry_https_basic_auth(self, url, realm, data=None): |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2167 | host, selector = splithost(url) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2168 | i = host.find('@') + 1 |
| 2169 | host = host[i:] |
| 2170 | user, passwd = self.get_user_passwd(host, realm, i) |
| 2171 | if not (user or passwd): return None |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2172 | host = "%s:%s@%s" % (quote(user, safe=''), |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2173 | quote(passwd, safe=''), host) |
| 2174 | newurl = 'https://' + host + selector |
| 2175 | if data is None: |
| 2176 | return self.open(newurl) |
| 2177 | else: |
| 2178 | return self.open(newurl, data) |
| 2179 | |
Florent Xicluna | 757445b | 2010-05-17 17:24:07 +0000 | [diff] [blame] | 2180 | def get_user_passwd(self, host, realm, clear_cache=0): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2181 | key = realm + '@' + host.lower() |
| 2182 | if key in self.auth_cache: |
| 2183 | if clear_cache: |
| 2184 | del self.auth_cache[key] |
| 2185 | else: |
| 2186 | return self.auth_cache[key] |
| 2187 | user, passwd = self.prompt_user_passwd(host, realm) |
| 2188 | if user or passwd: self.auth_cache[key] = (user, passwd) |
| 2189 | return user, passwd |
| 2190 | |
| 2191 | def prompt_user_passwd(self, host, realm): |
| 2192 | """Override this in a GUI environment!""" |
| 2193 | import getpass |
| 2194 | try: |
| 2195 | user = input("Enter username for %s at %s: " % (realm, host)) |
| 2196 | passwd = getpass.getpass("Enter password for %s in %s at %s: " % |
| 2197 | (user, realm, host)) |
| 2198 | return user, passwd |
| 2199 | except KeyboardInterrupt: |
| 2200 | print() |
| 2201 | return None, None |
| 2202 | |
| 2203 | |
| 2204 | # Utility functions |
| 2205 | |
| 2206 | _localhost = None |
| 2207 | def localhost(): |
| 2208 | """Return the IP address of the magic hostname 'localhost'.""" |
| 2209 | global _localhost |
| 2210 | if _localhost is None: |
| 2211 | _localhost = socket.gethostbyname('localhost') |
| 2212 | return _localhost |
| 2213 | |
| 2214 | _thishost = None |
| 2215 | def thishost(): |
Senthil Kumaran | 99b2c8f | 2009-12-27 10:13:39 +0000 | [diff] [blame] | 2216 | """Return the IP addresses of the current host.""" |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2217 | global _thishost |
| 2218 | if _thishost is None: |
Senthil Kumaran | dcdadfe | 2013-06-01 11:12:17 -0700 | [diff] [blame] | 2219 | try: |
| 2220 | _thishost = tuple(socket.gethostbyname_ex(socket.gethostname())[2]) |
| 2221 | except socket.gaierror: |
| 2222 | _thishost = tuple(socket.gethostbyname_ex('localhost')[2]) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2223 | return _thishost |
| 2224 | |
| 2225 | _ftperrors = None |
| 2226 | def ftperrors(): |
| 2227 | """Return the set of errors raised by the FTP class.""" |
| 2228 | global _ftperrors |
| 2229 | if _ftperrors is None: |
| 2230 | import ftplib |
| 2231 | _ftperrors = ftplib.all_errors |
| 2232 | return _ftperrors |
| 2233 | |
| 2234 | _noheaders = None |
| 2235 | def noheaders(): |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2236 | """Return an empty email Message object.""" |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2237 | global _noheaders |
| 2238 | if _noheaders is None: |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2239 | _noheaders = email.message_from_string("") |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2240 | return _noheaders |
| 2241 | |
| 2242 | |
| 2243 | # Utility classes |
| 2244 | |
| 2245 | class ftpwrapper: |
| 2246 | """Class used by open_ftp() for cache of open FTP connections.""" |
| 2247 | |
Nadeem Vawda | 08f5f7a | 2011-07-23 14:03:00 +0200 | [diff] [blame] | 2248 | def __init__(self, user, passwd, host, port, dirs, timeout=None, |
| 2249 | persistent=True): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2250 | self.user = user |
| 2251 | self.passwd = passwd |
| 2252 | self.host = host |
| 2253 | self.port = port |
| 2254 | self.dirs = dirs |
| 2255 | self.timeout = timeout |
Nadeem Vawda | 08f5f7a | 2011-07-23 14:03:00 +0200 | [diff] [blame] | 2256 | self.refcount = 0 |
| 2257 | self.keepalive = persistent |
Victor Stinner | ab73e65 | 2015-04-07 12:49:27 +0200 | [diff] [blame] | 2258 | try: |
| 2259 | self.init() |
| 2260 | except: |
| 2261 | self.close() |
| 2262 | raise |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2263 | |
| 2264 | def init(self): |
| 2265 | import ftplib |
| 2266 | self.busy = 0 |
| 2267 | self.ftp = ftplib.FTP() |
| 2268 | self.ftp.connect(self.host, self.port, self.timeout) |
| 2269 | self.ftp.login(self.user, self.passwd) |
Senthil Kumaran | caa00fe | 2013-06-02 11:59:47 -0700 | [diff] [blame] | 2270 | _target = '/'.join(self.dirs) |
| 2271 | self.ftp.cwd(_target) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2272 | |
| 2273 | def retrfile(self, file, type): |
| 2274 | import ftplib |
| 2275 | self.endtransfer() |
| 2276 | if type in ('d', 'D'): cmd = 'TYPE A'; isdir = 1 |
| 2277 | else: cmd = 'TYPE ' + type; isdir = 0 |
| 2278 | try: |
| 2279 | self.ftp.voidcmd(cmd) |
| 2280 | except ftplib.all_errors: |
| 2281 | self.init() |
| 2282 | self.ftp.voidcmd(cmd) |
| 2283 | conn = None |
| 2284 | if file and not isdir: |
| 2285 | # Try to retrieve as a file |
| 2286 | try: |
| 2287 | cmd = 'RETR ' + file |
Senthil Kumaran | 2024acd | 2011-03-24 11:46:19 +0800 | [diff] [blame] | 2288 | conn, retrlen = self.ftp.ntransfercmd(cmd) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2289 | except ftplib.error_perm as reason: |
| 2290 | if str(reason)[:3] != '550': |
Benjamin Peterson | 901a278 | 2013-05-12 19:01:52 -0500 | [diff] [blame] | 2291 | raise URLError('ftp error: %r' % reason).with_traceback( |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2292 | sys.exc_info()[2]) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2293 | if not conn: |
| 2294 | # Set transfer mode to ASCII! |
| 2295 | self.ftp.voidcmd('TYPE A') |
| 2296 | # Try a directory listing. Verify that directory exists. |
| 2297 | if file: |
| 2298 | pwd = self.ftp.pwd() |
| 2299 | try: |
| 2300 | try: |
| 2301 | self.ftp.cwd(file) |
| 2302 | except ftplib.error_perm as reason: |
Benjamin Peterson | 901a278 | 2013-05-12 19:01:52 -0500 | [diff] [blame] | 2303 | raise URLError('ftp error: %r' % reason) from reason |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2304 | finally: |
| 2305 | self.ftp.cwd(pwd) |
| 2306 | cmd = 'LIST ' + file |
| 2307 | else: |
| 2308 | cmd = 'LIST' |
Senthil Kumaran | 2024acd | 2011-03-24 11:46:19 +0800 | [diff] [blame] | 2309 | conn, retrlen = self.ftp.ntransfercmd(cmd) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2310 | self.busy = 1 |
Senthil Kumaran | 2024acd | 2011-03-24 11:46:19 +0800 | [diff] [blame] | 2311 | |
Nadeem Vawda | 08f5f7a | 2011-07-23 14:03:00 +0200 | [diff] [blame] | 2312 | ftpobj = addclosehook(conn.makefile('rb'), self.file_close) |
| 2313 | self.refcount += 1 |
Senthil Kumaran | 2024acd | 2011-03-24 11:46:19 +0800 | [diff] [blame] | 2314 | conn.close() |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2315 | # Pass back both a suitably decorated object and a retrieval length |
Senthil Kumaran | 2024acd | 2011-03-24 11:46:19 +0800 | [diff] [blame] | 2316 | return (ftpobj, retrlen) |
| 2317 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2318 | def endtransfer(self): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2319 | self.busy = 0 |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2320 | |
| 2321 | def close(self): |
Nadeem Vawda | 08f5f7a | 2011-07-23 14:03:00 +0200 | [diff] [blame] | 2322 | self.keepalive = False |
| 2323 | if self.refcount <= 0: |
| 2324 | self.real_close() |
| 2325 | |
| 2326 | def file_close(self): |
| 2327 | self.endtransfer() |
| 2328 | self.refcount -= 1 |
| 2329 | if self.refcount <= 0 and not self.keepalive: |
| 2330 | self.real_close() |
| 2331 | |
| 2332 | def real_close(self): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2333 | self.endtransfer() |
| 2334 | try: |
| 2335 | self.ftp.close() |
| 2336 | except ftperrors(): |
| 2337 | pass |
| 2338 | |
| 2339 | # Proxy handling |
| 2340 | def getproxies_environment(): |
| 2341 | """Return a dictionary of scheme -> proxy server URL mappings. |
| 2342 | |
| 2343 | Scan the environment for variables named <scheme>_proxy; |
| 2344 | this seems to be the standard convention. If you need a |
| 2345 | different way, you can pass a proxies dictionary to the |
| 2346 | [Fancy]URLopener constructor. |
| 2347 | |
| 2348 | """ |
| 2349 | proxies = {} |
| 2350 | for name, value in os.environ.items(): |
| 2351 | name = name.lower() |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2352 | if value and name[-6:] == '_proxy': |
| 2353 | proxies[name[:-6]] = value |
| 2354 | return proxies |
| 2355 | |
| 2356 | def proxy_bypass_environment(host): |
| 2357 | """Test if proxies should not be used for a particular host. |
| 2358 | |
| 2359 | Checks the environment for a variable named no_proxy, which should |
| 2360 | be a list of DNS suffixes separated by commas, or '*' for all hosts. |
| 2361 | """ |
| 2362 | no_proxy = os.environ.get('no_proxy', '') or os.environ.get('NO_PROXY', '') |
| 2363 | # '*' is special case for always bypass |
| 2364 | if no_proxy == '*': |
| 2365 | return 1 |
| 2366 | # strip port off host |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2367 | hostonly, port = splitport(host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2368 | # check if the host ends with any of the DNS suffixes |
Senthil Kumaran | 89976f1 | 2011-08-06 12:27:40 +0800 | [diff] [blame] | 2369 | no_proxy_list = [proxy.strip() for proxy in no_proxy.split(',')] |
| 2370 | for name in no_proxy_list: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2371 | if name and (hostonly.endswith(name) or host.endswith(name)): |
| 2372 | return 1 |
| 2373 | # otherwise, don't bypass |
| 2374 | return 0 |
| 2375 | |
| 2376 | |
Ronald Oussoren | e72e161 | 2011-03-14 18:15:25 -0400 | [diff] [blame] | 2377 | # This code tests an OSX specific data structure but is testable on all |
| 2378 | # platforms |
| 2379 | def _proxy_bypass_macosx_sysconf(host, proxy_settings): |
| 2380 | """ |
| 2381 | Return True iff this host shouldn't be accessed using a proxy |
| 2382 | |
| 2383 | This function uses the MacOSX framework SystemConfiguration |
| 2384 | to fetch the proxy information. |
| 2385 | |
| 2386 | proxy_settings come from _scproxy._get_proxy_settings or get mocked ie: |
| 2387 | { 'exclude_simple': bool, |
| 2388 | 'exceptions': ['foo.bar', '*.bar.com', '127.0.0.1', '10.1', '10.0/16'] |
| 2389 | } |
| 2390 | """ |
Ronald Oussoren | e72e161 | 2011-03-14 18:15:25 -0400 | [diff] [blame] | 2391 | from fnmatch import fnmatch |
| 2392 | |
| 2393 | hostonly, port = splitport(host) |
| 2394 | |
| 2395 | def ip2num(ipAddr): |
| 2396 | parts = ipAddr.split('.') |
| 2397 | parts = list(map(int, parts)) |
| 2398 | if len(parts) != 4: |
| 2399 | parts = (parts + [0, 0, 0, 0])[:4] |
| 2400 | return (parts[0] << 24) | (parts[1] << 16) | (parts[2] << 8) | parts[3] |
| 2401 | |
| 2402 | # Check for simple host names: |
| 2403 | if '.' not in host: |
| 2404 | if proxy_settings['exclude_simple']: |
| 2405 | return True |
| 2406 | |
| 2407 | hostIP = None |
| 2408 | |
| 2409 | for value in proxy_settings.get('exceptions', ()): |
| 2410 | # Items in the list are strings like these: *.local, 169.254/16 |
| 2411 | if not value: continue |
| 2412 | |
| 2413 | m = re.match(r"(\d+(?:\.\d+)*)(/\d+)?", value) |
| 2414 | if m is not None: |
| 2415 | if hostIP is None: |
| 2416 | try: |
| 2417 | hostIP = socket.gethostbyname(hostonly) |
| 2418 | hostIP = ip2num(hostIP) |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 2419 | except OSError: |
Ronald Oussoren | e72e161 | 2011-03-14 18:15:25 -0400 | [diff] [blame] | 2420 | continue |
| 2421 | |
| 2422 | base = ip2num(m.group(1)) |
| 2423 | mask = m.group(2) |
| 2424 | if mask is None: |
| 2425 | mask = 8 * (m.group(1).count('.') + 1) |
| 2426 | else: |
| 2427 | mask = int(mask[1:]) |
| 2428 | mask = 32 - mask |
| 2429 | |
| 2430 | if (hostIP >> mask) == (base >> mask): |
| 2431 | return True |
| 2432 | |
| 2433 | elif fnmatch(host, value): |
| 2434 | return True |
| 2435 | |
| 2436 | return False |
| 2437 | |
| 2438 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2439 | if sys.platform == 'darwin': |
Ronald Oussoren | 8415120 | 2010-04-18 20:46:11 +0000 | [diff] [blame] | 2440 | from _scproxy import _get_proxy_settings, _get_proxies |
| 2441 | |
| 2442 | def proxy_bypass_macosx_sysconf(host): |
Ronald Oussoren | 8415120 | 2010-04-18 20:46:11 +0000 | [diff] [blame] | 2443 | proxy_settings = _get_proxy_settings() |
Ronald Oussoren | e72e161 | 2011-03-14 18:15:25 -0400 | [diff] [blame] | 2444 | return _proxy_bypass_macosx_sysconf(host, proxy_settings) |
Ronald Oussoren | 8415120 | 2010-04-18 20:46:11 +0000 | [diff] [blame] | 2445 | |
| 2446 | def getproxies_macosx_sysconf(): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2447 | """Return a dictionary of scheme -> proxy server URL mappings. |
| 2448 | |
Ronald Oussoren | 8415120 | 2010-04-18 20:46:11 +0000 | [diff] [blame] | 2449 | This function uses the MacOSX framework SystemConfiguration |
| 2450 | to fetch the proxy information. |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2451 | """ |
Ronald Oussoren | 8415120 | 2010-04-18 20:46:11 +0000 | [diff] [blame] | 2452 | return _get_proxies() |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2453 | |
Ronald Oussoren | 8415120 | 2010-04-18 20:46:11 +0000 | [diff] [blame] | 2454 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2455 | |
| 2456 | def proxy_bypass(host): |
| 2457 | if getproxies_environment(): |
| 2458 | return proxy_bypass_environment(host) |
| 2459 | else: |
Ronald Oussoren | 8415120 | 2010-04-18 20:46:11 +0000 | [diff] [blame] | 2460 | return proxy_bypass_macosx_sysconf(host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2461 | |
| 2462 | def getproxies(): |
Ronald Oussoren | 8415120 | 2010-04-18 20:46:11 +0000 | [diff] [blame] | 2463 | return getproxies_environment() or getproxies_macosx_sysconf() |
| 2464 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2465 | |
| 2466 | elif os.name == 'nt': |
| 2467 | def getproxies_registry(): |
| 2468 | """Return a dictionary of scheme -> proxy server URL mappings. |
| 2469 | |
| 2470 | Win32 uses the registry to store proxies. |
| 2471 | |
| 2472 | """ |
| 2473 | proxies = {} |
| 2474 | try: |
Georg Brandl | 4ed72ac | 2009-04-01 04:28:33 +0000 | [diff] [blame] | 2475 | import winreg |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 2476 | except ImportError: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2477 | # Std module, so should be around - but you never know! |
| 2478 | return proxies |
| 2479 | try: |
Georg Brandl | 4ed72ac | 2009-04-01 04:28:33 +0000 | [diff] [blame] | 2480 | internetSettings = winreg.OpenKey(winreg.HKEY_CURRENT_USER, |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2481 | r'Software\Microsoft\Windows\CurrentVersion\Internet Settings') |
Georg Brandl | 4ed72ac | 2009-04-01 04:28:33 +0000 | [diff] [blame] | 2482 | proxyEnable = winreg.QueryValueEx(internetSettings, |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2483 | 'ProxyEnable')[0] |
| 2484 | if proxyEnable: |
| 2485 | # Returned as Unicode but problems if not converted to ASCII |
Georg Brandl | 4ed72ac | 2009-04-01 04:28:33 +0000 | [diff] [blame] | 2486 | proxyServer = str(winreg.QueryValueEx(internetSettings, |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2487 | 'ProxyServer')[0]) |
| 2488 | if '=' in proxyServer: |
| 2489 | # Per-protocol settings |
| 2490 | for p in proxyServer.split(';'): |
| 2491 | protocol, address = p.split('=', 1) |
| 2492 | # See if address has a type:// prefix |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2493 | if not re.match('^([^/:]+)://', address): |
| 2494 | address = '%s://%s' % (protocol, address) |
| 2495 | proxies[protocol] = address |
| 2496 | else: |
| 2497 | # Use one setting for all protocols |
| 2498 | if proxyServer[:5] == 'http:': |
| 2499 | proxies['http'] = proxyServer |
| 2500 | else: |
| 2501 | proxies['http'] = 'http://%s' % proxyServer |
Senthil Kumaran | 04f31b8 | 2010-07-14 20:10:52 +0000 | [diff] [blame] | 2502 | proxies['https'] = 'https://%s' % proxyServer |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2503 | proxies['ftp'] = 'ftp://%s' % proxyServer |
| 2504 | internetSettings.Close() |
Andrew Svetlov | 2606a6f | 2012-12-19 14:33:35 +0200 | [diff] [blame] | 2505 | except (OSError, ValueError, TypeError): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2506 | # Either registry key not found etc, or the value in an |
| 2507 | # unexpected format. |
| 2508 | # proxies already set up to be empty so nothing to do |
| 2509 | pass |
| 2510 | return proxies |
| 2511 | |
| 2512 | def getproxies(): |
| 2513 | """Return a dictionary of scheme -> proxy server URL mappings. |
| 2514 | |
| 2515 | Returns settings gathered from the environment, if specified, |
| 2516 | or the registry. |
| 2517 | |
| 2518 | """ |
| 2519 | return getproxies_environment() or getproxies_registry() |
| 2520 | |
| 2521 | def proxy_bypass_registry(host): |
| 2522 | try: |
Georg Brandl | 4ed72ac | 2009-04-01 04:28:33 +0000 | [diff] [blame] | 2523 | import winreg |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 2524 | except ImportError: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2525 | # Std modules, so should be around - but you never know! |
| 2526 | return 0 |
| 2527 | try: |
Georg Brandl | 4ed72ac | 2009-04-01 04:28:33 +0000 | [diff] [blame] | 2528 | internetSettings = winreg.OpenKey(winreg.HKEY_CURRENT_USER, |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2529 | r'Software\Microsoft\Windows\CurrentVersion\Internet Settings') |
Georg Brandl | 4ed72ac | 2009-04-01 04:28:33 +0000 | [diff] [blame] | 2530 | proxyEnable = winreg.QueryValueEx(internetSettings, |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2531 | 'ProxyEnable')[0] |
Georg Brandl | 4ed72ac | 2009-04-01 04:28:33 +0000 | [diff] [blame] | 2532 | proxyOverride = str(winreg.QueryValueEx(internetSettings, |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2533 | 'ProxyOverride')[0]) |
| 2534 | # ^^^^ Returned as Unicode but problems if not converted to ASCII |
Andrew Svetlov | 2606a6f | 2012-12-19 14:33:35 +0200 | [diff] [blame] | 2535 | except OSError: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2536 | return 0 |
| 2537 | if not proxyEnable or not proxyOverride: |
| 2538 | return 0 |
| 2539 | # try to make a host list from name and IP address. |
Georg Brandl | 13e8946 | 2008-07-01 19:56:00 +0000 | [diff] [blame] | 2540 | rawHost, port = splitport(host) |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2541 | host = [rawHost] |
| 2542 | try: |
| 2543 | addr = socket.gethostbyname(rawHost) |
| 2544 | if addr != rawHost: |
| 2545 | host.append(addr) |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 2546 | except OSError: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2547 | pass |
| 2548 | try: |
| 2549 | fqdn = socket.getfqdn(rawHost) |
| 2550 | if fqdn != rawHost: |
| 2551 | host.append(fqdn) |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 2552 | except OSError: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2553 | pass |
| 2554 | # make a check value list from the registry entry: replace the |
| 2555 | # '<local>' string by the localhost entry and the corresponding |
| 2556 | # canonical entry. |
| 2557 | proxyOverride = proxyOverride.split(';') |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2558 | # now check if we match one of the registry values. |
| 2559 | for test in proxyOverride: |
Senthil Kumaran | 4947606 | 2009-05-01 06:00:23 +0000 | [diff] [blame] | 2560 | if test == '<local>': |
| 2561 | if '.' not in rawHost: |
| 2562 | return 1 |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2563 | test = test.replace(".", r"\.") # mask dots |
| 2564 | test = test.replace("*", r".*") # change glob sequence |
| 2565 | test = test.replace("?", r".") # change glob char |
| 2566 | for val in host: |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 2567 | if re.match(test, val, re.I): |
| 2568 | return 1 |
| 2569 | return 0 |
| 2570 | |
| 2571 | def proxy_bypass(host): |
| 2572 | """Return a dictionary of scheme -> proxy server URL mappings. |
| 2573 | |
| 2574 | Returns settings gathered from the environment, if specified, |
| 2575 | or the registry. |
| 2576 | |
| 2577 | """ |
| 2578 | if getproxies_environment(): |
| 2579 | return proxy_bypass_environment(host) |
| 2580 | else: |
| 2581 | return proxy_bypass_registry(host) |
| 2582 | |
| 2583 | else: |
| 2584 | # By default use environment variables |
| 2585 | getproxies = getproxies_environment |
| 2586 | proxy_bypass = proxy_bypass_environment |