Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1 | """Open an arbitrary URL. |
| 2 | |
| 3 | See the following document for more info on URLs: |
| 4 | "Names and Addresses, URIs, URLs, URNs, URCs", at |
| 5 | http://www.w3.org/pub/WWW/Addressing/Overview.html |
| 6 | |
| 7 | See also the HTTP spec (from which the error codes are derived): |
| 8 | "HTTP - Hypertext Transfer Protocol", at |
| 9 | http://www.w3.org/pub/WWW/Protocols/ |
| 10 | |
| 11 | Related standards and specs: |
| 12 | - RFC1808: the "relative URL" spec. (authoritative status) |
| 13 | - RFC1738 - the "URL standard". (authoritative status) |
| 14 | - RFC1630 - the "URI spec". (informational status) |
| 15 | |
| 16 | The object returned by URLopener().open(file) will differ per |
| 17 | protocol. All you know is that is has methods read(), readline(), |
| 18 | readlines(), fileno(), close() and info(). The read*(), fileno() |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 19 | and close() methods work like those of open files. |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 20 | The info() method returns a mimetools.Message object which can be |
| 21 | used to query various info about the object, if available. |
| 22 | (mimetools.Message objects are queried with the getheader() method.) |
| 23 | """ |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 24 | |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 25 | import string |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 26 | import socket |
Jack Jansen | dc3e3f6 | 1995-12-15 13:22:13 +0000 | [diff] [blame] | 27 | import os |
Guido van Rossum | f0713d3 | 2001-08-09 17:43:35 +0000 | [diff] [blame] | 28 | import time |
Guido van Rossum | 3c8484e | 1996-11-20 22:02:24 +0000 | [diff] [blame] | 29 | import sys |
Brett Cannon | 69200fa | 2004-03-23 21:26:39 +0000 | [diff] [blame] | 30 | from urlparse import urljoin as basejoin |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 31 | |
Skip Montanaro | 40fc160 | 2001-03-01 04:27:19 +0000 | [diff] [blame] | 32 | __all__ = ["urlopen", "URLopener", "FancyURLopener", "urlretrieve", |
| 33 | "urlcleanup", "quote", "quote_plus", "unquote", "unquote_plus", |
Skip Montanaro | 44d5e0c | 2001-03-13 19:47:16 +0000 | [diff] [blame] | 34 | "urlencode", "url2pathname", "pathname2url", "splittag", |
| 35 | "localhost", "thishost", "ftperrors", "basejoin", "unwrap", |
| 36 | "splittype", "splithost", "splituser", "splitpasswd", "splitport", |
| 37 | "splitnport", "splitquery", "splitattr", "splitvalue", |
Brett Cannon | d75f043 | 2007-05-16 22:42:29 +0000 | [diff] [blame] | 38 | "getproxies"] |
Skip Montanaro | 40fc160 | 2001-03-01 04:27:19 +0000 | [diff] [blame] | 39 | |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 40 | __version__ = '1.17' # XXX This version is not always updated :-( |
Guido van Rossum | f668d17 | 1997-06-06 21:11:11 +0000 | [diff] [blame] | 41 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 42 | MAXFTPCACHE = 10 # Trim the ftp cache beyond this size |
Guido van Rossum | 6cb15a0 | 1995-06-22 19:00:13 +0000 | [diff] [blame] | 43 | |
Jack Jansen | dc3e3f6 | 1995-12-15 13:22:13 +0000 | [diff] [blame] | 44 | # Helper for non-unix systems |
Ronald Oussoren | 9545a23 | 2010-05-05 19:09:31 +0000 | [diff] [blame^] | 45 | if os.name == 'nt': |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 46 | from nturl2path import url2pathname, pathname2url |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 47 | elif os.name == 'riscos': |
| 48 | from rourl2path import url2pathname, pathname2url |
Jack Jansen | dc3e3f6 | 1995-12-15 13:22:13 +0000 | [diff] [blame] | 49 | else: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 50 | def url2pathname(pathname): |
Georg Brandl | c0b2473 | 2005-12-26 22:53:56 +0000 | [diff] [blame] | 51 | """OS-specific conversion from a relative URL of the 'file' scheme |
| 52 | to a file system path; not recommended for general use.""" |
Guido van Rossum | 367ac80 | 1999-03-12 14:31:10 +0000 | [diff] [blame] | 53 | return unquote(pathname) |
Georg Brandl | c0b2473 | 2005-12-26 22:53:56 +0000 | [diff] [blame] | 54 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 55 | def pathname2url(pathname): |
Georg Brandl | c0b2473 | 2005-12-26 22:53:56 +0000 | [diff] [blame] | 56 | """OS-specific conversion from a file system path to a relative URL |
| 57 | of the 'file' scheme; not recommended for general use.""" |
Guido van Rossum | 367ac80 | 1999-03-12 14:31:10 +0000 | [diff] [blame] | 58 | return quote(pathname) |
Guido van Rossum | 33add0a | 1998-12-18 15:25:22 +0000 | [diff] [blame] | 59 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 60 | # This really consists of two pieces: |
| 61 | # (1) a class which handles opening of all sorts of URLs |
| 62 | # (plus assorted utilities etc.) |
| 63 | # (2) a set of functions for parsing URLs |
| 64 | # XXX Should these be separated out into different modules? |
| 65 | |
| 66 | |
| 67 | # Shortcut for basic usage |
| 68 | _urlopener = None |
Fred Drake | df6eca7 | 2002-04-04 20:41:34 +0000 | [diff] [blame] | 69 | def urlopen(url, data=None, proxies=None): |
Brett Cannon | 8bb8fa5 | 2008-07-02 01:57:08 +0000 | [diff] [blame] | 70 | """Create a file-like object for the specified URL to read from.""" |
| 71 | from warnings import warnpy3k |
Georg Brandl | 48e65f5 | 2010-02-06 22:44:17 +0000 | [diff] [blame] | 72 | warnpy3k("urllib.urlopen() has been removed in Python 3.0 in " |
| 73 | "favor of urllib2.urlopen()", stacklevel=2) |
Brett Cannon | 8bb8fa5 | 2008-07-02 01:57:08 +0000 | [diff] [blame] | 74 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 75 | global _urlopener |
Fred Drake | df6eca7 | 2002-04-04 20:41:34 +0000 | [diff] [blame] | 76 | if proxies is not None: |
| 77 | opener = FancyURLopener(proxies=proxies) |
| 78 | elif not _urlopener: |
| 79 | opener = FancyURLopener() |
| 80 | _urlopener = opener |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 81 | else: |
Fred Drake | df6eca7 | 2002-04-04 20:41:34 +0000 | [diff] [blame] | 82 | opener = _urlopener |
| 83 | if data is None: |
| 84 | return opener.open(url) |
| 85 | else: |
| 86 | return opener.open(url, data) |
Fred Drake | 316a793 | 2000-08-24 01:01:26 +0000 | [diff] [blame] | 87 | def urlretrieve(url, filename=None, reporthook=None, data=None): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 88 | global _urlopener |
| 89 | if not _urlopener: |
| 90 | _urlopener = FancyURLopener() |
Fred Drake | 316a793 | 2000-08-24 01:01:26 +0000 | [diff] [blame] | 91 | return _urlopener.retrieve(url, filename, reporthook, data) |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 92 | def urlcleanup(): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 93 | if _urlopener: |
| 94 | _urlopener.cleanup() |
Antoine Pitrou | ca173e2 | 2009-12-08 19:35:12 +0000 | [diff] [blame] | 95 | _safemaps.clear() |
| 96 | ftpcache.clear() |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 97 | |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 98 | # check for SSL |
| 99 | try: |
| 100 | import ssl |
| 101 | except: |
| 102 | _have_ssl = False |
| 103 | else: |
| 104 | _have_ssl = True |
| 105 | |
Georg Brandl | b925602 | 2005-08-24 18:46:39 +0000 | [diff] [blame] | 106 | # exception raised when downloaded size does not match content-length |
| 107 | class ContentTooShortError(IOError): |
| 108 | def __init__(self, message, content): |
| 109 | IOError.__init__(self, message) |
| 110 | self.content = content |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 111 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 112 | ftpcache = {} |
| 113 | class URLopener: |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 114 | """Class to open URLs. |
| 115 | This is a class rather than just a subroutine because we may need |
| 116 | more than one set of global protocol-specific options. |
| 117 | Note -- this is a base class for those who don't want the |
| 118 | automatic handling of errors type 302 (relocated) and 401 |
| 119 | (authorization needed).""" |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 120 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 121 | __tempfiles = None |
Guido van Rossum | 29e7781 | 1996-11-27 19:39:58 +0000 | [diff] [blame] | 122 | |
Guido van Rossum | ba31138 | 2000-08-24 16:18:04 +0000 | [diff] [blame] | 123 | version = "Python-urllib/%s" % __version__ |
| 124 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 125 | # Constructor |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 126 | def __init__(self, proxies=None, **x509): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 127 | if proxies is None: |
| 128 | proxies = getproxies() |
| 129 | assert hasattr(proxies, 'has_key'), "proxies must be a mapping" |
| 130 | self.proxies = proxies |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 131 | self.key_file = x509.get('key_file') |
| 132 | self.cert_file = x509.get('cert_file') |
Georg Brandl | 0619a32 | 2006-07-26 07:40:17 +0000 | [diff] [blame] | 133 | self.addheaders = [('User-Agent', self.version)] |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 134 | self.__tempfiles = [] |
| 135 | self.__unlink = os.unlink # See cleanup() |
| 136 | self.tempcache = None |
| 137 | # Undocumented feature: if you assign {} to tempcache, |
| 138 | # it is used to cache files retrieved with |
| 139 | # self.retrieve(). This is not enabled by default |
| 140 | # since it does not work for changing documents (and I |
| 141 | # haven't got the logic to check expiration headers |
| 142 | # yet). |
| 143 | self.ftpcache = ftpcache |
| 144 | # Undocumented feature: you can use a different |
| 145 | # ftp cache by assigning to the .ftpcache member; |
| 146 | # in case you want logically independent URL openers |
| 147 | # XXX This is not threadsafe. Bah. |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 148 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 149 | def __del__(self): |
| 150 | self.close() |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 151 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 152 | def close(self): |
| 153 | self.cleanup() |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 154 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 155 | def cleanup(self): |
| 156 | # This code sometimes runs when the rest of this module |
| 157 | # has already been deleted, so it can't use any globals |
| 158 | # or import anything. |
| 159 | if self.__tempfiles: |
| 160 | for file in self.__tempfiles: |
| 161 | try: |
| 162 | self.__unlink(file) |
Martin v. Löwis | 58682b7 | 2001-08-11 15:02:57 +0000 | [diff] [blame] | 163 | except OSError: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 164 | pass |
| 165 | del self.__tempfiles[:] |
| 166 | if self.tempcache: |
| 167 | self.tempcache.clear() |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 168 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 169 | def addheader(self, *args): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 170 | """Add a header to be used by the HTTP interface only |
| 171 | e.g. u.addheader('Accept', 'sound/basic')""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 172 | self.addheaders.append(args) |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 173 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 174 | # External interface |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 175 | def open(self, fullurl, data=None): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 176 | """Use URLopener().open(file) instead of open(file, 'r').""" |
Martin v. Löwis | 1d99433 | 2000-12-03 18:30:10 +0000 | [diff] [blame] | 177 | fullurl = unwrap(toBytes(fullurl)) |
Senthil Kumaran | 7c2867f | 2009-04-21 03:24:19 +0000 | [diff] [blame] | 178 | # percent encode url, fixing lame server errors for e.g, like space |
| 179 | # within url paths. |
Senthil Kumaran | 18d5a69 | 2010-02-20 22:05:34 +0000 | [diff] [blame] | 180 | fullurl = quote(fullurl, safe="%/:=&?~#+!$,;'@()*[]|") |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 181 | if self.tempcache and fullurl in self.tempcache: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 182 | filename, headers = self.tempcache[fullurl] |
| 183 | fp = open(filename, 'rb') |
| 184 | return addinfourl(fp, headers, fullurl) |
Martin v. Löwis | 1d99433 | 2000-12-03 18:30:10 +0000 | [diff] [blame] | 185 | urltype, url = splittype(fullurl) |
| 186 | if not urltype: |
| 187 | urltype = 'file' |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 188 | if urltype in self.proxies: |
Martin v. Löwis | 1d99433 | 2000-12-03 18:30:10 +0000 | [diff] [blame] | 189 | proxy = self.proxies[urltype] |
| 190 | urltype, proxyhost = splittype(proxy) |
Jeremy Hylton | d52755f | 2000-10-02 23:04:02 +0000 | [diff] [blame] | 191 | host, selector = splithost(proxyhost) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 192 | url = (host, fullurl) # Signal special case to open_*() |
Jeremy Hylton | d52755f | 2000-10-02 23:04:02 +0000 | [diff] [blame] | 193 | else: |
| 194 | proxy = None |
Martin v. Löwis | 1d99433 | 2000-12-03 18:30:10 +0000 | [diff] [blame] | 195 | name = 'open_' + urltype |
| 196 | self.type = urltype |
Brett Cannon | aaeffaf | 2004-03-23 23:50:17 +0000 | [diff] [blame] | 197 | name = name.replace('-', '_') |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 198 | if not hasattr(self, name): |
Jeremy Hylton | d52755f | 2000-10-02 23:04:02 +0000 | [diff] [blame] | 199 | if proxy: |
| 200 | return self.open_unknown_proxy(proxy, fullurl, data) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 201 | else: |
| 202 | return self.open_unknown(fullurl, data) |
| 203 | try: |
| 204 | if data is None: |
| 205 | return getattr(self, name)(url) |
| 206 | else: |
| 207 | return getattr(self, name)(url, data) |
| 208 | except socket.error, msg: |
| 209 | raise IOError, ('socket error', msg), sys.exc_info()[2] |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 210 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 211 | def open_unknown(self, fullurl, data=None): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 212 | """Overridable interface to open unknown URL type.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 213 | type, url = splittype(fullurl) |
| 214 | raise IOError, ('url error', 'unknown url type', type) |
Guido van Rossum | ca44540 | 1995-08-29 19:19:12 +0000 | [diff] [blame] | 215 | |
Jeremy Hylton | d52755f | 2000-10-02 23:04:02 +0000 | [diff] [blame] | 216 | def open_unknown_proxy(self, proxy, fullurl, data=None): |
| 217 | """Overridable interface to open unknown URL type.""" |
| 218 | type, url = splittype(fullurl) |
| 219 | raise IOError, ('url error', 'invalid proxy for %s' % type, proxy) |
| 220 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 221 | # External interface |
Sjoerd Mullender | d7b86f0 | 2000-08-25 11:23:36 +0000 | [diff] [blame] | 222 | def retrieve(self, url, filename=None, reporthook=None, data=None): |
Brett Cannon | 7d618c7 | 2003-04-24 02:43:20 +0000 | [diff] [blame] | 223 | """retrieve(url) returns (filename, headers) for a local object |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 224 | or (tempfilename, headers) for a remote object.""" |
Martin v. Löwis | 1d99433 | 2000-12-03 18:30:10 +0000 | [diff] [blame] | 225 | url = unwrap(toBytes(url)) |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 226 | if self.tempcache and url in self.tempcache: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 227 | return self.tempcache[url] |
| 228 | type, url1 = splittype(url) |
Raymond Hettinger | 10ff706 | 2002-06-02 03:04:52 +0000 | [diff] [blame] | 229 | if filename is None and (not type or type == 'file'): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 230 | try: |
| 231 | fp = self.open_local_file(url1) |
| 232 | hdrs = fp.info() |
Philip Jenvey | 0299d0d | 2009-12-03 02:40:13 +0000 | [diff] [blame] | 233 | fp.close() |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 234 | return url2pathname(splithost(url1)[1]), hdrs |
Georg Brandl | 84fedf7 | 2010-02-06 22:59:15 +0000 | [diff] [blame] | 235 | except IOError: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 236 | pass |
Fred Drake | 316a793 | 2000-08-24 01:01:26 +0000 | [diff] [blame] | 237 | fp = self.open(url, data) |
Benjamin Peterson | b364bfe | 2009-03-22 17:45:11 +0000 | [diff] [blame] | 238 | try: |
| 239 | headers = fp.info() |
| 240 | if filename: |
| 241 | tfp = open(filename, 'wb') |
| 242 | else: |
| 243 | import tempfile |
| 244 | garbage, path = splittype(url) |
| 245 | garbage, path = splithost(path or "") |
| 246 | path, garbage = splitquery(path or "") |
| 247 | path, garbage = splitattr(path or "") |
| 248 | suffix = os.path.splitext(path)[1] |
| 249 | (fd, filename) = tempfile.mkstemp(suffix) |
| 250 | self.__tempfiles.append(filename) |
| 251 | tfp = os.fdopen(fd, 'wb') |
| 252 | try: |
| 253 | result = filename, headers |
| 254 | if self.tempcache is not None: |
| 255 | self.tempcache[url] = result |
| 256 | bs = 1024*8 |
| 257 | size = -1 |
| 258 | read = 0 |
| 259 | blocknum = 0 |
| 260 | if reporthook: |
| 261 | if "content-length" in headers: |
| 262 | size = int(headers["Content-Length"]) |
| 263 | reporthook(blocknum, bs, size) |
| 264 | while 1: |
| 265 | block = fp.read(bs) |
| 266 | if block == "": |
| 267 | break |
| 268 | read += len(block) |
| 269 | tfp.write(block) |
| 270 | blocknum += 1 |
| 271 | if reporthook: |
| 272 | reporthook(blocknum, bs, size) |
| 273 | finally: |
| 274 | tfp.close() |
| 275 | finally: |
| 276 | fp.close() |
Georg Brandl | b925602 | 2005-08-24 18:46:39 +0000 | [diff] [blame] | 277 | |
| 278 | # raise exception if actual size does not match content-length header |
| 279 | if size >= 0 and read < size: |
| 280 | raise ContentTooShortError("retrieval incomplete: got only %i out " |
| 281 | "of %i bytes" % (read, size), result) |
| 282 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 283 | return result |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 284 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 285 | # Each method named open_<type> knows how to open that type of URL |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 286 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 287 | def open_http(self, url, data=None): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 288 | """Use HTTP protocol.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 289 | import httplib |
| 290 | user_passwd = None |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 291 | proxy_passwd= None |
Walter Dörwald | 65230a2 | 2002-06-03 15:58:32 +0000 | [diff] [blame] | 292 | if isinstance(url, str): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 293 | host, selector = splithost(url) |
| 294 | if host: |
| 295 | user_passwd, host = splituser(host) |
| 296 | host = unquote(host) |
| 297 | realhost = host |
| 298 | else: |
| 299 | host, selector = url |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 300 | # check whether the proxy contains authorization information |
| 301 | proxy_passwd, host = splituser(host) |
| 302 | # now we proceed with the url we want to obtain |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 303 | urltype, rest = splittype(selector) |
| 304 | url = rest |
| 305 | user_passwd = None |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 306 | if urltype.lower() != 'http': |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 307 | realhost = None |
| 308 | else: |
| 309 | realhost, rest = splithost(rest) |
| 310 | if realhost: |
| 311 | user_passwd, realhost = splituser(realhost) |
| 312 | if user_passwd: |
| 313 | selector = "%s://%s%s" % (urltype, realhost, rest) |
Tim Peters | 55c12d4 | 2001-08-09 18:04:14 +0000 | [diff] [blame] | 314 | if proxy_bypass(realhost): |
| 315 | host = realhost |
| 316 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 317 | #print "proxy via http:", host, selector |
| 318 | if not host: raise IOError, ('http error', 'no host given') |
Tim Peters | 92037a1 | 2006-01-24 22:44:08 +0000 | [diff] [blame] | 319 | |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 320 | if proxy_passwd: |
| 321 | import base64 |
Andrew M. Kuchling | 872dba4 | 2006-10-27 17:11:23 +0000 | [diff] [blame] | 322 | proxy_auth = base64.b64encode(proxy_passwd).strip() |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 323 | else: |
| 324 | proxy_auth = None |
| 325 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 326 | if user_passwd: |
| 327 | import base64 |
Andrew M. Kuchling | 872dba4 | 2006-10-27 17:11:23 +0000 | [diff] [blame] | 328 | auth = base64.b64encode(user_passwd).strip() |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 329 | else: |
| 330 | auth = None |
| 331 | h = httplib.HTTP(host) |
| 332 | if data is not None: |
| 333 | h.putrequest('POST', selector) |
Georg Brandl | 0619a32 | 2006-07-26 07:40:17 +0000 | [diff] [blame] | 334 | h.putheader('Content-Type', 'application/x-www-form-urlencoded') |
| 335 | h.putheader('Content-Length', '%d' % len(data)) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 336 | else: |
| 337 | h.putrequest('GET', selector) |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 338 | if proxy_auth: h.putheader('Proxy-Authorization', 'Basic %s' % proxy_auth) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 339 | if auth: h.putheader('Authorization', 'Basic %s' % auth) |
| 340 | if realhost: h.putheader('Host', realhost) |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 341 | for args in self.addheaders: h.putheader(*args) |
Kristján Valur Jónsson | 84040db | 2009-01-09 20:27:16 +0000 | [diff] [blame] | 342 | h.endheaders(data) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 343 | errcode, errmsg, headers = h.getreply() |
Neal Norwitz | ce55e21 | 2007-03-20 08:14:57 +0000 | [diff] [blame] | 344 | fp = h.getfile() |
Georg Brandl | f66b603 | 2007-03-14 08:27:52 +0000 | [diff] [blame] | 345 | if errcode == -1: |
Neal Norwitz | ce55e21 | 2007-03-20 08:14:57 +0000 | [diff] [blame] | 346 | if fp: fp.close() |
Georg Brandl | f66b603 | 2007-03-14 08:27:52 +0000 | [diff] [blame] | 347 | # something went wrong with the HTTP status line |
| 348 | raise IOError, ('http protocol error', 0, |
| 349 | 'got a bad status line', None) |
Sean Reifscheider | a1afbf6 | 2007-09-19 07:52:56 +0000 | [diff] [blame] | 350 | # According to RFC 2616, "2xx" code indicates that the client's |
| 351 | # request was successfully received, understood, and accepted. |
Kurt B. Kaiser | 0f7c25d | 2008-01-02 04:11:28 +0000 | [diff] [blame] | 352 | if (200 <= errcode < 300): |
Georg Brandl | 9b0d46d | 2008-01-20 11:43:03 +0000 | [diff] [blame] | 353 | return addinfourl(fp, headers, "http:" + url, errcode) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 354 | else: |
| 355 | if data is None: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 356 | return self.http_error(url, fp, errcode, errmsg, headers) |
Guido van Rossum | 29aab75 | 1999-03-09 19:31:21 +0000 | [diff] [blame] | 357 | else: |
| 358 | return self.http_error(url, fp, errcode, errmsg, headers, data) |
Guido van Rossum | bbb0a05 | 1995-08-04 04:29:05 +0000 | [diff] [blame] | 359 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 360 | def http_error(self, url, fp, errcode, errmsg, headers, data=None): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 361 | """Handle http errors. |
| 362 | Derived class can override this, or provide specific handlers |
| 363 | named http_error_DDD where DDD is the 3-digit error code.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 364 | # First check if there's a specific handler for this error |
| 365 | name = 'http_error_%d' % errcode |
| 366 | if hasattr(self, name): |
| 367 | method = getattr(self, name) |
| 368 | if data is None: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 369 | result = method(url, fp, errcode, errmsg, headers) |
Jeremy Hylton | b30f52a | 1999-02-25 16:14:58 +0000 | [diff] [blame] | 370 | else: |
| 371 | result = method(url, fp, errcode, errmsg, headers, data) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 372 | if result: return result |
Jeremy Hylton | b30f52a | 1999-02-25 16:14:58 +0000 | [diff] [blame] | 373 | return self.http_error_default(url, fp, errcode, errmsg, headers) |
Guido van Rossum | bbb0a05 | 1995-08-04 04:29:05 +0000 | [diff] [blame] | 374 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 375 | def http_error_default(self, url, fp, errcode, errmsg, headers): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 376 | """Default error handler: close the connection and raise IOError.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 377 | void = fp.read() |
| 378 | fp.close() |
| 379 | raise IOError, ('http error', errcode, errmsg, headers) |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 380 | |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 381 | if _have_ssl: |
Andrew M. Kuchling | 141e989 | 2000-04-23 02:53:11 +0000 | [diff] [blame] | 382 | def open_https(self, url, data=None): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 383 | """Use HTTPS protocol.""" |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 384 | |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 385 | import httplib |
Fred Drake | 567ca8e | 2000-08-21 21:42:42 +0000 | [diff] [blame] | 386 | user_passwd = None |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 387 | proxy_passwd = None |
Walter Dörwald | 65230a2 | 2002-06-03 15:58:32 +0000 | [diff] [blame] | 388 | if isinstance(url, str): |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 389 | host, selector = splithost(url) |
Fred Drake | 567ca8e | 2000-08-21 21:42:42 +0000 | [diff] [blame] | 390 | if host: |
| 391 | user_passwd, host = splituser(host) |
| 392 | host = unquote(host) |
| 393 | realhost = host |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 394 | else: |
| 395 | host, selector = url |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 396 | # here, we determine, whether the proxy contains authorization information |
| 397 | proxy_passwd, host = splituser(host) |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 398 | urltype, rest = splittype(selector) |
Fred Drake | 567ca8e | 2000-08-21 21:42:42 +0000 | [diff] [blame] | 399 | url = rest |
| 400 | user_passwd = None |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 401 | if urltype.lower() != 'https': |
Fred Drake | 567ca8e | 2000-08-21 21:42:42 +0000 | [diff] [blame] | 402 | realhost = None |
| 403 | else: |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 404 | realhost, rest = splithost(rest) |
Fred Drake | 567ca8e | 2000-08-21 21:42:42 +0000 | [diff] [blame] | 405 | if realhost: |
| 406 | user_passwd, realhost = splituser(realhost) |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 407 | if user_passwd: |
| 408 | selector = "%s://%s%s" % (urltype, realhost, rest) |
Andrew M. Kuchling | 7ad4792 | 2000-06-10 01:41:48 +0000 | [diff] [blame] | 409 | #print "proxy via https:", host, selector |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 410 | if not host: raise IOError, ('https error', 'no host given') |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 411 | if proxy_passwd: |
| 412 | import base64 |
Andrew M. Kuchling | 872dba4 | 2006-10-27 17:11:23 +0000 | [diff] [blame] | 413 | proxy_auth = base64.b64encode(proxy_passwd).strip() |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 414 | else: |
| 415 | proxy_auth = None |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 416 | if user_passwd: |
| 417 | import base64 |
Andrew M. Kuchling | 872dba4 | 2006-10-27 17:11:23 +0000 | [diff] [blame] | 418 | auth = base64.b64encode(user_passwd).strip() |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 419 | else: |
| 420 | auth = None |
| 421 | h = httplib.HTTPS(host, 0, |
| 422 | key_file=self.key_file, |
| 423 | cert_file=self.cert_file) |
Andrew M. Kuchling | 141e989 | 2000-04-23 02:53:11 +0000 | [diff] [blame] | 424 | if data is not None: |
| 425 | h.putrequest('POST', selector) |
Georg Brandl | 0619a32 | 2006-07-26 07:40:17 +0000 | [diff] [blame] | 426 | h.putheader('Content-Type', |
Andrew M. Kuchling | 141e989 | 2000-04-23 02:53:11 +0000 | [diff] [blame] | 427 | 'application/x-www-form-urlencoded') |
Georg Brandl | 0619a32 | 2006-07-26 07:40:17 +0000 | [diff] [blame] | 428 | h.putheader('Content-Length', '%d' % len(data)) |
Andrew M. Kuchling | 141e989 | 2000-04-23 02:53:11 +0000 | [diff] [blame] | 429 | else: |
| 430 | h.putrequest('GET', selector) |
Andrew M. Kuchling | 5227857 | 2006-12-19 15:11:41 +0000 | [diff] [blame] | 431 | if proxy_auth: h.putheader('Proxy-Authorization', 'Basic %s' % proxy_auth) |
| 432 | if auth: h.putheader('Authorization', 'Basic %s' % auth) |
Fred Drake | 567ca8e | 2000-08-21 21:42:42 +0000 | [diff] [blame] | 433 | if realhost: h.putheader('Host', realhost) |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 434 | for args in self.addheaders: h.putheader(*args) |
Kristján Valur Jónsson | 84040db | 2009-01-09 20:27:16 +0000 | [diff] [blame] | 435 | h.endheaders(data) |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 436 | errcode, errmsg, headers = h.getreply() |
Neal Norwitz | ce55e21 | 2007-03-20 08:14:57 +0000 | [diff] [blame] | 437 | fp = h.getfile() |
Georg Brandl | f66b603 | 2007-03-14 08:27:52 +0000 | [diff] [blame] | 438 | if errcode == -1: |
Neal Norwitz | ce55e21 | 2007-03-20 08:14:57 +0000 | [diff] [blame] | 439 | if fp: fp.close() |
Georg Brandl | f66b603 | 2007-03-14 08:27:52 +0000 | [diff] [blame] | 440 | # something went wrong with the HTTP status line |
| 441 | raise IOError, ('http protocol error', 0, |
| 442 | 'got a bad status line', None) |
Georg Brandl | 9b91567 | 2007-09-24 18:08:24 +0000 | [diff] [blame] | 443 | # According to RFC 2616, "2xx" code indicates that the client's |
| 444 | # request was successfully received, understood, and accepted. |
Kurt B. Kaiser | 0f7c25d | 2008-01-02 04:11:28 +0000 | [diff] [blame] | 445 | if (200 <= errcode < 300): |
Georg Brandl | 9b0d46d | 2008-01-20 11:43:03 +0000 | [diff] [blame] | 446 | return addinfourl(fp, headers, "https:" + url, errcode) |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 447 | else: |
Fred Drake | 567ca8e | 2000-08-21 21:42:42 +0000 | [diff] [blame] | 448 | if data is None: |
| 449 | return self.http_error(url, fp, errcode, errmsg, headers) |
| 450 | else: |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 451 | return self.http_error(url, fp, errcode, errmsg, headers, |
| 452 | data) |
Fred Drake | 567ca8e | 2000-08-21 21:42:42 +0000 | [diff] [blame] | 453 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 454 | def open_file(self, url): |
Neal Norwitz | c5d0dbd | 2006-04-09 04:00:49 +0000 | [diff] [blame] | 455 | """Use local file or FTP depending on form of URL.""" |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 456 | if not isinstance(url, str): |
| 457 | raise IOError, ('file error', 'proxy support for file protocol currently not implemented') |
Jack Jansen | 4ef1103 | 2002-09-12 20:14:04 +0000 | [diff] [blame] | 458 | if url[:2] == '//' and url[2:3] != '/' and url[2:12].lower() != 'localhost/': |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 459 | return self.open_ftp(url) |
| 460 | else: |
| 461 | return self.open_local_file(url) |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 462 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 463 | def open_local_file(self, url): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 464 | """Use local file.""" |
Georg Brandl | 5a096e1 | 2007-01-22 19:40:21 +0000 | [diff] [blame] | 465 | import mimetypes, mimetools, email.utils |
Raymond Hettinger | a617271 | 2004-12-31 19:15:26 +0000 | [diff] [blame] | 466 | try: |
| 467 | from cStringIO import StringIO |
| 468 | except ImportError: |
| 469 | from StringIO import StringIO |
Guido van Rossum | f0713d3 | 2001-08-09 17:43:35 +0000 | [diff] [blame] | 470 | host, file = splithost(url) |
| 471 | localname = url2pathname(file) |
Guido van Rossum | a2da305 | 2002-04-15 00:25:01 +0000 | [diff] [blame] | 472 | try: |
| 473 | stats = os.stat(localname) |
| 474 | except OSError, e: |
| 475 | raise IOError(e.errno, e.strerror, e.filename) |
Walter Dörwald | 92b48b7 | 2002-03-22 17:30:38 +0000 | [diff] [blame] | 476 | size = stats.st_size |
Georg Brandl | 5a096e1 | 2007-01-22 19:40:21 +0000 | [diff] [blame] | 477 | modified = email.utils.formatdate(stats.st_mtime, usegmt=True) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 478 | mtype = mimetypes.guess_type(url)[0] |
Raymond Hettinger | a617271 | 2004-12-31 19:15:26 +0000 | [diff] [blame] | 479 | headers = mimetools.Message(StringIO( |
Guido van Rossum | f0713d3 | 2001-08-09 17:43:35 +0000 | [diff] [blame] | 480 | 'Content-Type: %s\nContent-Length: %d\nLast-modified: %s\n' % |
| 481 | (mtype or 'text/plain', size, modified))) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 482 | if not host: |
Guido van Rossum | 336a201 | 1999-06-24 15:27:36 +0000 | [diff] [blame] | 483 | urlfile = file |
| 484 | if file[:1] == '/': |
| 485 | urlfile = 'file://' + file |
Guido van Rossum | f0713d3 | 2001-08-09 17:43:35 +0000 | [diff] [blame] | 486 | return addinfourl(open(localname, 'rb'), |
Guido van Rossum | 336a201 | 1999-06-24 15:27:36 +0000 | [diff] [blame] | 487 | headers, urlfile) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 488 | host, port = splitport(host) |
| 489 | if not port \ |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 490 | and socket.gethostbyname(host) in (localhost(), thishost()): |
Guido van Rossum | 336a201 | 1999-06-24 15:27:36 +0000 | [diff] [blame] | 491 | urlfile = file |
| 492 | if file[:1] == '/': |
| 493 | urlfile = 'file://' + file |
Guido van Rossum | f0713d3 | 2001-08-09 17:43:35 +0000 | [diff] [blame] | 494 | return addinfourl(open(localname, 'rb'), |
Guido van Rossum | 336a201 | 1999-06-24 15:27:36 +0000 | [diff] [blame] | 495 | headers, urlfile) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 496 | raise IOError, ('local file error', 'not on local host') |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 497 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 498 | def open_ftp(self, url): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 499 | """Use FTP protocol.""" |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 500 | if not isinstance(url, str): |
| 501 | raise IOError, ('ftp error', 'proxy support for ftp protocol currently not implemented') |
Raymond Hettinger | a617271 | 2004-12-31 19:15:26 +0000 | [diff] [blame] | 502 | import mimetypes, mimetools |
| 503 | try: |
| 504 | from cStringIO import StringIO |
| 505 | except ImportError: |
| 506 | from StringIO import StringIO |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 507 | host, path = splithost(url) |
| 508 | if not host: raise IOError, ('ftp error', 'no host given') |
| 509 | host, port = splitport(host) |
| 510 | user, host = splituser(host) |
| 511 | if user: user, passwd = splitpasswd(user) |
| 512 | else: passwd = None |
| 513 | host = unquote(host) |
| 514 | user = unquote(user or '') |
| 515 | passwd = unquote(passwd or '') |
| 516 | host = socket.gethostbyname(host) |
| 517 | if not port: |
| 518 | import ftplib |
| 519 | port = ftplib.FTP_PORT |
| 520 | else: |
| 521 | port = int(port) |
| 522 | path, attrs = splitattr(path) |
| 523 | path = unquote(path) |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 524 | dirs = path.split('/') |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 525 | dirs, file = dirs[:-1], dirs[-1] |
| 526 | if dirs and not dirs[0]: dirs = dirs[1:] |
Guido van Rossum | 5e006a3 | 1999-08-18 17:40:33 +0000 | [diff] [blame] | 527 | if dirs and not dirs[0]: dirs[0] = '/' |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 528 | key = user, host, port, '/'.join(dirs) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 529 | # XXX thread unsafe! |
| 530 | if len(self.ftpcache) > MAXFTPCACHE: |
| 531 | # Prune the cache, rather arbitrarily |
| 532 | for k in self.ftpcache.keys(): |
| 533 | if k != key: |
| 534 | v = self.ftpcache[k] |
| 535 | del self.ftpcache[k] |
| 536 | v.close() |
| 537 | try: |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 538 | if not key in self.ftpcache: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 539 | self.ftpcache[key] = \ |
| 540 | ftpwrapper(user, passwd, host, port, dirs) |
| 541 | if not file: type = 'D' |
| 542 | else: type = 'I' |
| 543 | for attr in attrs: |
| 544 | attr, value = splitvalue(attr) |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 545 | if attr.lower() == 'type' and \ |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 546 | value in ('a', 'A', 'i', 'I', 'd', 'D'): |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 547 | type = value.upper() |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 548 | (fp, retrlen) = self.ftpcache[key].retrfile(file, type) |
Guido van Rossum | 88e0b5b | 2001-08-23 13:38:15 +0000 | [diff] [blame] | 549 | mtype = mimetypes.guess_type("ftp:" + url)[0] |
| 550 | headers = "" |
| 551 | if mtype: |
| 552 | headers += "Content-Type: %s\n" % mtype |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 553 | if retrlen is not None and retrlen >= 0: |
Guido van Rossum | 88e0b5b | 2001-08-23 13:38:15 +0000 | [diff] [blame] | 554 | headers += "Content-Length: %d\n" % retrlen |
Raymond Hettinger | a617271 | 2004-12-31 19:15:26 +0000 | [diff] [blame] | 555 | headers = mimetools.Message(StringIO(headers)) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 556 | return addinfourl(fp, headers, "ftp:" + url) |
| 557 | except ftperrors(), msg: |
| 558 | raise IOError, ('ftp error', msg), sys.exc_info()[2] |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 559 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 560 | def open_data(self, url, data=None): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 561 | """Use "data" URL.""" |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 562 | if not isinstance(url, str): |
| 563 | raise IOError, ('data error', 'proxy support for data protocol currently not implemented') |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 564 | # ignore POSTed data |
| 565 | # |
| 566 | # syntax of data URLs: |
| 567 | # dataurl := "data:" [ mediatype ] [ ";base64" ] "," data |
| 568 | # mediatype := [ type "/" subtype ] *( ";" parameter ) |
| 569 | # data := *urlchar |
| 570 | # parameter := attribute "=" value |
Raymond Hettinger | a617271 | 2004-12-31 19:15:26 +0000 | [diff] [blame] | 571 | import mimetools |
| 572 | try: |
| 573 | from cStringIO import StringIO |
| 574 | except ImportError: |
| 575 | from StringIO import StringIO |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 576 | try: |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 577 | [type, data] = url.split(',', 1) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 578 | except ValueError: |
| 579 | raise IOError, ('data error', 'bad data URL') |
| 580 | if not type: |
| 581 | type = 'text/plain;charset=US-ASCII' |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 582 | semi = type.rfind(';') |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 583 | if semi >= 0 and '=' not in type[semi:]: |
| 584 | encoding = type[semi+1:] |
| 585 | type = type[:semi] |
| 586 | else: |
| 587 | encoding = '' |
| 588 | msg = [] |
Senthil Kumaran | 1b7f9e5 | 2010-05-01 08:01:56 +0000 | [diff] [blame] | 589 | msg.append('Date: %s'%time.strftime('%a, %d %b %Y %H:%M:%S GMT', |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 590 | time.gmtime(time.time()))) |
| 591 | msg.append('Content-type: %s' % type) |
| 592 | if encoding == 'base64': |
| 593 | import base64 |
| 594 | data = base64.decodestring(data) |
| 595 | else: |
| 596 | data = unquote(data) |
Georg Brandl | 0619a32 | 2006-07-26 07:40:17 +0000 | [diff] [blame] | 597 | msg.append('Content-Length: %d' % len(data)) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 598 | msg.append('') |
| 599 | msg.append(data) |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 600 | msg = '\n'.join(msg) |
Raymond Hettinger | a617271 | 2004-12-31 19:15:26 +0000 | [diff] [blame] | 601 | f = StringIO(msg) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 602 | headers = mimetools.Message(f, 0) |
Georg Brandl | 1f66357 | 2005-11-26 16:50:44 +0000 | [diff] [blame] | 603 | #f.fileno = None # needed for addinfourl |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 604 | return addinfourl(f, headers, url) |
Guido van Rossum | 6d4d1c2 | 1998-03-12 14:32:55 +0000 | [diff] [blame] | 605 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 606 | |
Guido van Rossum | bbb0a05 | 1995-08-04 04:29:05 +0000 | [diff] [blame] | 607 | class FancyURLopener(URLopener): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 608 | """Derived class with handlers for errors we can handle (perhaps).""" |
Guido van Rossum | bbb0a05 | 1995-08-04 04:29:05 +0000 | [diff] [blame] | 609 | |
Neal Norwitz | 60e04cd | 2002-06-11 13:38:51 +0000 | [diff] [blame] | 610 | def __init__(self, *args, **kwargs): |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 611 | URLopener.__init__(self, *args, **kwargs) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 612 | self.auth_cache = {} |
Skip Montanaro | c3e11d6 | 2001-02-15 16:56:36 +0000 | [diff] [blame] | 613 | self.tries = 0 |
| 614 | self.maxtries = 10 |
Guido van Rossum | bbb0a05 | 1995-08-04 04:29:05 +0000 | [diff] [blame] | 615 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 616 | def http_error_default(self, url, fp, errcode, errmsg, headers): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 617 | """Default error handling -- don't raise an exception.""" |
Georg Brandl | 9b0d46d | 2008-01-20 11:43:03 +0000 | [diff] [blame] | 618 | return addinfourl(fp, headers, "http:" + url, errcode) |
Guido van Rossum | bbb0a05 | 1995-08-04 04:29:05 +0000 | [diff] [blame] | 619 | |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 620 | def http_error_302(self, url, fp, errcode, errmsg, headers, data=None): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 621 | """Error 302 -- relocated (temporarily).""" |
Skip Montanaro | c3e11d6 | 2001-02-15 16:56:36 +0000 | [diff] [blame] | 622 | self.tries += 1 |
| 623 | if self.maxtries and self.tries >= self.maxtries: |
| 624 | if hasattr(self, "http_error_500"): |
| 625 | meth = self.http_error_500 |
| 626 | else: |
| 627 | meth = self.http_error_default |
| 628 | self.tries = 0 |
| 629 | return meth(url, fp, 500, |
| 630 | "Internal Server Error: Redirect Recursion", headers) |
| 631 | result = self.redirect_internal(url, fp, errcode, errmsg, headers, |
| 632 | data) |
| 633 | self.tries = 0 |
| 634 | return result |
| 635 | |
| 636 | def redirect_internal(self, url, fp, errcode, errmsg, headers, data): |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 637 | if 'location' in headers: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 638 | newurl = headers['location'] |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 639 | elif 'uri' in headers: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 640 | newurl = headers['uri'] |
| 641 | else: |
| 642 | return |
| 643 | void = fp.read() |
| 644 | fp.close() |
Guido van Rossum | 3527f59 | 1999-03-29 20:23:41 +0000 | [diff] [blame] | 645 | # In case the server sent a relative URL, join with original: |
Moshe Zadka | 5d87d47 | 2001-04-09 14:54:21 +0000 | [diff] [blame] | 646 | newurl = basejoin(self.type + ":" + url, newurl) |
Guido van Rossum | fa19f7c | 2003-05-16 01:46:51 +0000 | [diff] [blame] | 647 | return self.open(newurl) |
Guido van Rossum | bbb0a05 | 1995-08-04 04:29:05 +0000 | [diff] [blame] | 648 | |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 649 | def http_error_301(self, url, fp, errcode, errmsg, headers, data=None): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 650 | """Error 301 -- also relocated (permanently).""" |
| 651 | return self.http_error_302(url, fp, errcode, errmsg, headers, data) |
Guido van Rossum | e6ad891 | 1996-09-10 17:02:56 +0000 | [diff] [blame] | 652 | |
Raymond Hettinger | 024aaa1 | 2003-04-24 15:32:12 +0000 | [diff] [blame] | 653 | def http_error_303(self, url, fp, errcode, errmsg, headers, data=None): |
| 654 | """Error 303 -- also relocated (essentially identical to 302).""" |
| 655 | return self.http_error_302(url, fp, errcode, errmsg, headers, data) |
| 656 | |
Guido van Rossum | fa19f7c | 2003-05-16 01:46:51 +0000 | [diff] [blame] | 657 | def http_error_307(self, url, fp, errcode, errmsg, headers, data=None): |
| 658 | """Error 307 -- relocated, but turn POST into error.""" |
| 659 | if data is None: |
| 660 | return self.http_error_302(url, fp, errcode, errmsg, headers, data) |
| 661 | else: |
| 662 | return self.http_error_default(url, fp, errcode, errmsg, headers) |
| 663 | |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 664 | def http_error_401(self, url, fp, errcode, errmsg, headers, data=None): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 665 | """Error 401 -- authentication required. |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 666 | This function supports Basic authentication only.""" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 667 | if not 'www-authenticate' in headers: |
Tim Peters | 85ba673 | 2001-02-28 08:26:44 +0000 | [diff] [blame] | 668 | URLopener.http_error_default(self, url, fp, |
Fred Drake | c680ae8 | 2001-10-13 18:37:07 +0000 | [diff] [blame] | 669 | errcode, errmsg, headers) |
Moshe Zadka | e99bd17 | 2001-02-27 06:27:04 +0000 | [diff] [blame] | 670 | stuff = headers['www-authenticate'] |
| 671 | import re |
| 672 | match = re.match('[ \t]*([^ \t]+)[ \t]+realm="([^"]*)"', stuff) |
| 673 | if not match: |
Tim Peters | 85ba673 | 2001-02-28 08:26:44 +0000 | [diff] [blame] | 674 | URLopener.http_error_default(self, url, fp, |
Moshe Zadka | e99bd17 | 2001-02-27 06:27:04 +0000 | [diff] [blame] | 675 | errcode, errmsg, headers) |
| 676 | scheme, realm = match.groups() |
| 677 | if scheme.lower() != 'basic': |
Tim Peters | 85ba673 | 2001-02-28 08:26:44 +0000 | [diff] [blame] | 678 | URLopener.http_error_default(self, url, fp, |
Moshe Zadka | e99bd17 | 2001-02-27 06:27:04 +0000 | [diff] [blame] | 679 | errcode, errmsg, headers) |
| 680 | name = 'retry_' + self.type + '_basic_auth' |
| 681 | if data is None: |
| 682 | return getattr(self,name)(url, realm) |
| 683 | else: |
| 684 | return getattr(self,name)(url, realm, data) |
Tim Peters | 92037a1 | 2006-01-24 22:44:08 +0000 | [diff] [blame] | 685 | |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 686 | def http_error_407(self, url, fp, errcode, errmsg, headers, data=None): |
| 687 | """Error 407 -- proxy authentication required. |
| 688 | This function supports Basic authentication only.""" |
| 689 | if not 'proxy-authenticate' in headers: |
| 690 | URLopener.http_error_default(self, url, fp, |
| 691 | errcode, errmsg, headers) |
| 692 | stuff = headers['proxy-authenticate'] |
| 693 | import re |
| 694 | match = re.match('[ \t]*([^ \t]+)[ \t]+realm="([^"]*)"', stuff) |
| 695 | if not match: |
| 696 | URLopener.http_error_default(self, url, fp, |
| 697 | errcode, errmsg, headers) |
| 698 | scheme, realm = match.groups() |
| 699 | if scheme.lower() != 'basic': |
| 700 | URLopener.http_error_default(self, url, fp, |
| 701 | errcode, errmsg, headers) |
| 702 | name = 'retry_proxy_' + self.type + '_basic_auth' |
| 703 | if data is None: |
| 704 | return getattr(self,name)(url, realm) |
| 705 | else: |
| 706 | return getattr(self,name)(url, realm, data) |
Tim Peters | 92037a1 | 2006-01-24 22:44:08 +0000 | [diff] [blame] | 707 | |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 708 | def retry_proxy_http_basic_auth(self, url, realm, data=None): |
| 709 | host, selector = splithost(url) |
| 710 | newurl = 'http://' + host + selector |
| 711 | proxy = self.proxies['http'] |
| 712 | urltype, proxyhost = splittype(proxy) |
| 713 | proxyhost, proxyselector = splithost(proxyhost) |
| 714 | i = proxyhost.find('@') + 1 |
| 715 | proxyhost = proxyhost[i:] |
| 716 | user, passwd = self.get_user_passwd(proxyhost, realm, i) |
| 717 | if not (user or passwd): return None |
| 718 | proxyhost = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + proxyhost |
| 719 | self.proxies['http'] = 'http://' + proxyhost + proxyselector |
| 720 | if data is None: |
| 721 | return self.open(newurl) |
| 722 | else: |
| 723 | return self.open(newurl, data) |
Guido van Rossum | bbb0a05 | 1995-08-04 04:29:05 +0000 | [diff] [blame] | 724 | |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 725 | def retry_proxy_https_basic_auth(self, url, realm, data=None): |
| 726 | host, selector = splithost(url) |
| 727 | newurl = 'https://' + host + selector |
| 728 | proxy = self.proxies['https'] |
| 729 | urltype, proxyhost = splittype(proxy) |
| 730 | proxyhost, proxyselector = splithost(proxyhost) |
| 731 | i = proxyhost.find('@') + 1 |
| 732 | proxyhost = proxyhost[i:] |
| 733 | user, passwd = self.get_user_passwd(proxyhost, realm, i) |
| 734 | if not (user or passwd): return None |
| 735 | proxyhost = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + proxyhost |
| 736 | self.proxies['https'] = 'https://' + proxyhost + proxyselector |
| 737 | if data is None: |
| 738 | return self.open(newurl) |
| 739 | else: |
| 740 | return self.open(newurl, data) |
Tim Peters | 92037a1 | 2006-01-24 22:44:08 +0000 | [diff] [blame] | 741 | |
Guido van Rossum | 3c8baed | 2000-02-01 23:36:55 +0000 | [diff] [blame] | 742 | def retry_http_basic_auth(self, url, realm, data=None): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 743 | host, selector = splithost(url) |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 744 | i = host.find('@') + 1 |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 745 | host = host[i:] |
| 746 | user, passwd = self.get_user_passwd(host, realm, i) |
| 747 | if not (user or passwd): return None |
Guido van Rossum | afc4f04 | 2001-01-15 18:31:13 +0000 | [diff] [blame] | 748 | host = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + host |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 749 | newurl = 'http://' + host + selector |
Guido van Rossum | 3c8baed | 2000-02-01 23:36:55 +0000 | [diff] [blame] | 750 | if data is None: |
| 751 | return self.open(newurl) |
| 752 | else: |
| 753 | return self.open(newurl, data) |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 754 | |
Guido van Rossum | 3c8baed | 2000-02-01 23:36:55 +0000 | [diff] [blame] | 755 | def retry_https_basic_auth(self, url, realm, data=None): |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 756 | host, selector = splithost(url) |
| 757 | i = host.find('@') + 1 |
| 758 | host = host[i:] |
| 759 | user, passwd = self.get_user_passwd(host, realm, i) |
| 760 | if not (user or passwd): return None |
Guido van Rossum | afc4f04 | 2001-01-15 18:31:13 +0000 | [diff] [blame] | 761 | host = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + host |
Martin v. Löwis | 3e86595 | 2006-01-24 15:51:21 +0000 | [diff] [blame] | 762 | newurl = 'https://' + host + selector |
| 763 | if data is None: |
| 764 | return self.open(newurl) |
| 765 | else: |
| 766 | return self.open(newurl, data) |
Guido van Rossum | bbb0a05 | 1995-08-04 04:29:05 +0000 | [diff] [blame] | 767 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 768 | def get_user_passwd(self, host, realm, clear_cache = 0): |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 769 | key = realm + '@' + host.lower() |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 770 | if key in self.auth_cache: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 771 | if clear_cache: |
| 772 | del self.auth_cache[key] |
| 773 | else: |
| 774 | return self.auth_cache[key] |
| 775 | user, passwd = self.prompt_user_passwd(host, realm) |
| 776 | if user or passwd: self.auth_cache[key] = (user, passwd) |
| 777 | return user, passwd |
Guido van Rossum | bbb0a05 | 1995-08-04 04:29:05 +0000 | [diff] [blame] | 778 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 779 | def prompt_user_passwd(self, host, realm): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 780 | """Override this in a GUI environment!""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 781 | import getpass |
| 782 | try: |
| 783 | user = raw_input("Enter username for %s at %s: " % (realm, |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 784 | host)) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 785 | passwd = getpass.getpass("Enter password for %s in %s at %s: " % |
| 786 | (user, realm, host)) |
| 787 | return user, passwd |
| 788 | except KeyboardInterrupt: |
| 789 | print |
| 790 | return None, None |
Guido van Rossum | bbb0a05 | 1995-08-04 04:29:05 +0000 | [diff] [blame] | 791 | |
| 792 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 793 | # Utility functions |
| 794 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 795 | _localhost = None |
| 796 | def localhost(): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 797 | """Return the IP address of the magic hostname 'localhost'.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 798 | global _localhost |
Raymond Hettinger | 10ff706 | 2002-06-02 03:04:52 +0000 | [diff] [blame] | 799 | if _localhost is None: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 800 | _localhost = socket.gethostbyname('localhost') |
| 801 | return _localhost |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 802 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 803 | _thishost = None |
| 804 | def thishost(): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 805 | """Return the IP address of the current host.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 806 | global _thishost |
Raymond Hettinger | 10ff706 | 2002-06-02 03:04:52 +0000 | [diff] [blame] | 807 | if _thishost is None: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 808 | _thishost = socket.gethostbyname(socket.gethostname()) |
| 809 | return _thishost |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 810 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 811 | _ftperrors = None |
| 812 | def ftperrors(): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 813 | """Return the set of errors raised by the FTP class.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 814 | global _ftperrors |
Raymond Hettinger | 10ff706 | 2002-06-02 03:04:52 +0000 | [diff] [blame] | 815 | if _ftperrors is None: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 816 | import ftplib |
| 817 | _ftperrors = ftplib.all_errors |
| 818 | return _ftperrors |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 819 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 820 | _noheaders = None |
| 821 | def noheaders(): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 822 | """Return an empty mimetools.Message object.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 823 | global _noheaders |
Raymond Hettinger | 10ff706 | 2002-06-02 03:04:52 +0000 | [diff] [blame] | 824 | if _noheaders is None: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 825 | import mimetools |
Raymond Hettinger | a617271 | 2004-12-31 19:15:26 +0000 | [diff] [blame] | 826 | try: |
| 827 | from cStringIO import StringIO |
| 828 | except ImportError: |
| 829 | from StringIO import StringIO |
| 830 | _noheaders = mimetools.Message(StringIO(), 0) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 831 | _noheaders.fp.close() # Recycle file descriptor |
| 832 | return _noheaders |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 833 | |
| 834 | |
| 835 | # Utility classes |
| 836 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 837 | class ftpwrapper: |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 838 | """Class used by open_ftp() for cache of open FTP connections.""" |
| 839 | |
Facundo Batista | 4f1b1ed | 2008-05-29 16:39:26 +0000 | [diff] [blame] | 840 | def __init__(self, user, passwd, host, port, dirs, |
| 841 | timeout=socket._GLOBAL_DEFAULT_TIMEOUT): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 842 | self.user = user |
| 843 | self.passwd = passwd |
| 844 | self.host = host |
| 845 | self.port = port |
| 846 | self.dirs = dirs |
Facundo Batista | 711a54e | 2007-05-24 17:50:54 +0000 | [diff] [blame] | 847 | self.timeout = timeout |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 848 | self.init() |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 849 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 850 | def init(self): |
| 851 | import ftplib |
| 852 | self.busy = 0 |
| 853 | self.ftp = ftplib.FTP() |
Facundo Batista | 711a54e | 2007-05-24 17:50:54 +0000 | [diff] [blame] | 854 | self.ftp.connect(self.host, self.port, self.timeout) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 855 | self.ftp.login(self.user, self.passwd) |
| 856 | for dir in self.dirs: |
| 857 | self.ftp.cwd(dir) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 858 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 859 | def retrfile(self, file, type): |
| 860 | import ftplib |
| 861 | self.endtransfer() |
| 862 | if type in ('d', 'D'): cmd = 'TYPE A'; isdir = 1 |
| 863 | else: cmd = 'TYPE ' + type; isdir = 0 |
| 864 | try: |
| 865 | self.ftp.voidcmd(cmd) |
| 866 | except ftplib.all_errors: |
| 867 | self.init() |
| 868 | self.ftp.voidcmd(cmd) |
| 869 | conn = None |
| 870 | if file and not isdir: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 871 | # Try to retrieve as a file |
| 872 | try: |
| 873 | cmd = 'RETR ' + file |
| 874 | conn = self.ftp.ntransfercmd(cmd) |
| 875 | except ftplib.error_perm, reason: |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 876 | if str(reason)[:3] != '550': |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 877 | raise IOError, ('ftp error', reason), sys.exc_info()[2] |
| 878 | if not conn: |
| 879 | # Set transfer mode to ASCII! |
| 880 | self.ftp.voidcmd('TYPE A') |
Georg Brandl | d5e6cf2 | 2008-01-20 12:18:17 +0000 | [diff] [blame] | 881 | # Try a directory listing. Verify that directory exists. |
| 882 | if file: |
| 883 | pwd = self.ftp.pwd() |
| 884 | try: |
| 885 | try: |
| 886 | self.ftp.cwd(file) |
| 887 | except ftplib.error_perm, reason: |
| 888 | raise IOError, ('ftp error', reason), sys.exc_info()[2] |
| 889 | finally: |
| 890 | self.ftp.cwd(pwd) |
| 891 | cmd = 'LIST ' + file |
| 892 | else: |
| 893 | cmd = 'LIST' |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 894 | conn = self.ftp.ntransfercmd(cmd) |
| 895 | self.busy = 1 |
| 896 | # Pass back both a suitably decorated object and a retrieval length |
| 897 | return (addclosehook(conn[0].makefile('rb'), |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 898 | self.endtransfer), conn[1]) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 899 | def endtransfer(self): |
| 900 | if not self.busy: |
| 901 | return |
| 902 | self.busy = 0 |
| 903 | try: |
| 904 | self.ftp.voidresp() |
| 905 | except ftperrors(): |
| 906 | pass |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 907 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 908 | def close(self): |
| 909 | self.endtransfer() |
| 910 | try: |
| 911 | self.ftp.close() |
| 912 | except ftperrors(): |
| 913 | pass |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 914 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 915 | class addbase: |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 916 | """Base class for addinfo and addclosehook.""" |
| 917 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 918 | def __init__(self, fp): |
| 919 | self.fp = fp |
| 920 | self.read = self.fp.read |
| 921 | self.readline = self.fp.readline |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 922 | if hasattr(self.fp, "readlines"): self.readlines = self.fp.readlines |
Georg Brandl | 1f66357 | 2005-11-26 16:50:44 +0000 | [diff] [blame] | 923 | if hasattr(self.fp, "fileno"): |
| 924 | self.fileno = self.fp.fileno |
| 925 | else: |
| 926 | self.fileno = lambda: None |
Raymond Hettinger | 42182eb | 2003-03-09 05:33:33 +0000 | [diff] [blame] | 927 | if hasattr(self.fp, "__iter__"): |
| 928 | self.__iter__ = self.fp.__iter__ |
| 929 | if hasattr(self.fp, "next"): |
| 930 | self.next = self.fp.next |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 931 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 932 | def __repr__(self): |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 933 | return '<%s at %r whose fp = %r>' % (self.__class__.__name__, |
| 934 | id(self), self.fp) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 935 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 936 | def close(self): |
| 937 | self.read = None |
| 938 | self.readline = None |
| 939 | self.readlines = None |
| 940 | self.fileno = None |
| 941 | if self.fp: self.fp.close() |
| 942 | self.fp = None |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 943 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 944 | class addclosehook(addbase): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 945 | """Class to add a close hook to an open file.""" |
| 946 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 947 | def __init__(self, fp, closehook, *hookargs): |
| 948 | addbase.__init__(self, fp) |
| 949 | self.closehook = closehook |
| 950 | self.hookargs = hookargs |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 951 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 952 | def close(self): |
Guido van Rossum | c580dae | 2000-05-24 13:21:46 +0000 | [diff] [blame] | 953 | addbase.close(self) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 954 | if self.closehook: |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 955 | self.closehook(*self.hookargs) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 956 | self.closehook = None |
| 957 | self.hookargs = None |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 958 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 959 | class addinfo(addbase): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 960 | """class to add an info() method to an open file.""" |
| 961 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 962 | def __init__(self, fp, headers): |
| 963 | addbase.__init__(self, fp) |
| 964 | self.headers = headers |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 965 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 966 | def info(self): |
| 967 | return self.headers |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 968 | |
Guido van Rossum | e6ad891 | 1996-09-10 17:02:56 +0000 | [diff] [blame] | 969 | class addinfourl(addbase): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 970 | """class to add info() and geturl() methods to an open file.""" |
| 971 | |
Georg Brandl | 9b0d46d | 2008-01-20 11:43:03 +0000 | [diff] [blame] | 972 | def __init__(self, fp, headers, url, code=None): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 973 | addbase.__init__(self, fp) |
| 974 | self.headers = headers |
| 975 | self.url = url |
Georg Brandl | 9b0d46d | 2008-01-20 11:43:03 +0000 | [diff] [blame] | 976 | self.code = code |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 977 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 978 | def info(self): |
| 979 | return self.headers |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 980 | |
Georg Brandl | 9b0d46d | 2008-01-20 11:43:03 +0000 | [diff] [blame] | 981 | def getcode(self): |
| 982 | return self.code |
| 983 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 984 | def geturl(self): |
| 985 | return self.url |
Guido van Rossum | e6ad891 | 1996-09-10 17:02:56 +0000 | [diff] [blame] | 986 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 987 | |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 988 | # Utilities to parse URLs (most of these return None for missing parts): |
Sjoerd Mullender | e0371b8 | 1995-11-10 10:36:07 +0000 | [diff] [blame] | 989 | # unwrap('<URL:type://host/path>') --> 'type://host/path' |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 990 | # splittype('type:opaquestring') --> 'type', 'opaquestring' |
| 991 | # splithost('//host[:port]/path') --> 'host[:port]', '/path' |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 992 | # splituser('user[:passwd]@host[:port]') --> 'user[:passwd]', 'host[:port]' |
| 993 | # splitpasswd('user:passwd') -> 'user', 'passwd' |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 994 | # splitport('host:port') --> 'host', 'port' |
| 995 | # splitquery('/path?query') --> '/path', 'query' |
| 996 | # splittag('/path#tag') --> '/path', 'tag' |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 997 | # splitattr('/path;attr1=value1;attr2=value2;...') -> |
| 998 | # '/path', ['attr1=value1', 'attr2=value2', ...] |
| 999 | # splitvalue('attr=value') --> 'attr', 'value' |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1000 | # unquote('abc%20def') -> 'abc def' |
| 1001 | # quote('abc def') -> 'abc%20def') |
| 1002 | |
Walter Dörwald | 65230a2 | 2002-06-03 15:58:32 +0000 | [diff] [blame] | 1003 | try: |
| 1004 | unicode |
| 1005 | except NameError: |
Guido van Rossum | 4b46c0a | 2002-05-24 17:58:05 +0000 | [diff] [blame] | 1006 | def _is_unicode(x): |
| 1007 | return 0 |
Walter Dörwald | 65230a2 | 2002-06-03 15:58:32 +0000 | [diff] [blame] | 1008 | else: |
| 1009 | def _is_unicode(x): |
| 1010 | return isinstance(x, unicode) |
Guido van Rossum | 4b46c0a | 2002-05-24 17:58:05 +0000 | [diff] [blame] | 1011 | |
Martin v. Löwis | 1d99433 | 2000-12-03 18:30:10 +0000 | [diff] [blame] | 1012 | def toBytes(url): |
| 1013 | """toBytes(u"URL") --> 'URL'.""" |
| 1014 | # Most URL schemes require ASCII. If that changes, the conversion |
| 1015 | # can be relaxed |
Guido van Rossum | 4b46c0a | 2002-05-24 17:58:05 +0000 | [diff] [blame] | 1016 | if _is_unicode(url): |
Martin v. Löwis | 1d99433 | 2000-12-03 18:30:10 +0000 | [diff] [blame] | 1017 | try: |
| 1018 | url = url.encode("ASCII") |
| 1019 | except UnicodeError: |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1020 | raise UnicodeError("URL " + repr(url) + |
| 1021 | " contains non-ASCII characters") |
Martin v. Löwis | 1d99433 | 2000-12-03 18:30:10 +0000 | [diff] [blame] | 1022 | return url |
| 1023 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1024 | def unwrap(url): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1025 | """unwrap('<URL:type://host/path>') --> 'type://host/path'.""" |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1026 | url = url.strip() |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1027 | if url[:1] == '<' and url[-1:] == '>': |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1028 | url = url[1:-1].strip() |
| 1029 | if url[:4] == 'URL:': url = url[4:].strip() |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1030 | return url |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1031 | |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1032 | _typeprog = None |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1033 | def splittype(url): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1034 | """splittype('type:opaquestring') --> 'type', 'opaquestring'.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1035 | global _typeprog |
| 1036 | if _typeprog is None: |
| 1037 | import re |
| 1038 | _typeprog = re.compile('^([^/:]+):') |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1039 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1040 | match = _typeprog.match(url) |
| 1041 | if match: |
| 1042 | scheme = match.group(1) |
Fred Drake | 9e94afd | 2000-07-01 07:03:30 +0000 | [diff] [blame] | 1043 | return scheme.lower(), url[len(scheme) + 1:] |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1044 | return None, url |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1045 | |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1046 | _hostprog = None |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1047 | def splithost(url): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1048 | """splithost('//host[:port]/path') --> 'host[:port]', '/path'.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1049 | global _hostprog |
| 1050 | if _hostprog is None: |
| 1051 | import re |
Georg Brandl | 1c168d8 | 2006-03-26 20:59:38 +0000 | [diff] [blame] | 1052 | _hostprog = re.compile('^//([^/?]*)(.*)$') |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1053 | |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 1054 | match = _hostprog.match(url) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1055 | if match: return match.group(1, 2) |
| 1056 | return None, url |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1057 | |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1058 | _userprog = None |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 1059 | def splituser(host): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1060 | """splituser('user[:passwd]@host[:port]') --> 'user[:passwd]', 'host[:port]'.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1061 | global _userprog |
| 1062 | if _userprog is None: |
| 1063 | import re |
Raymond Hettinger | f2e45dd | 2002-08-18 20:08:56 +0000 | [diff] [blame] | 1064 | _userprog = re.compile('^(.*)@(.*)$') |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1065 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1066 | match = _userprog.match(host) |
Fred Drake | 567ca8e | 2000-08-21 21:42:42 +0000 | [diff] [blame] | 1067 | if match: return map(unquote, match.group(1, 2)) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1068 | return None, host |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 1069 | |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1070 | _passwdprog = None |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 1071 | def splitpasswd(user): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1072 | """splitpasswd('user:passwd') -> 'user', 'passwd'.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1073 | global _passwdprog |
| 1074 | if _passwdprog is None: |
| 1075 | import re |
Senthil Kumaran | 5e95e76 | 2009-03-30 21:51:50 +0000 | [diff] [blame] | 1076 | _passwdprog = re.compile('^([^:]*):(.*)$',re.S) |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1077 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1078 | match = _passwdprog.match(user) |
| 1079 | if match: return match.group(1, 2) |
| 1080 | return user, None |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 1081 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1082 | # splittag('/path#tag') --> '/path', 'tag' |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1083 | _portprog = None |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1084 | def splitport(host): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1085 | """splitport('host:port') --> 'host', 'port'.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1086 | global _portprog |
| 1087 | if _portprog is None: |
| 1088 | import re |
| 1089 | _portprog = re.compile('^(.*):([0-9]+)$') |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1090 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1091 | match = _portprog.match(host) |
| 1092 | if match: return match.group(1, 2) |
| 1093 | return host, None |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1094 | |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1095 | _nportprog = None |
Guido van Rossum | 53725a2 | 1996-06-13 19:12:35 +0000 | [diff] [blame] | 1096 | def splitnport(host, defport=-1): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1097 | """Split host and port, returning numeric port. |
| 1098 | Return given default port if no ':' found; defaults to -1. |
| 1099 | Return numerical port if a valid number are found after ':'. |
| 1100 | Return None if ':' but not a valid number.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1101 | global _nportprog |
| 1102 | if _nportprog is None: |
| 1103 | import re |
| 1104 | _nportprog = re.compile('^(.*):(.*)$') |
Guido van Rossum | 7e7ca0b | 1998-03-26 21:01:39 +0000 | [diff] [blame] | 1105 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1106 | match = _nportprog.match(host) |
| 1107 | if match: |
| 1108 | host, port = match.group(1, 2) |
| 1109 | try: |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1110 | if not port: raise ValueError, "no digits" |
| 1111 | nport = int(port) |
| 1112 | except ValueError: |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1113 | nport = None |
| 1114 | return host, nport |
| 1115 | return host, defport |
Guido van Rossum | 53725a2 | 1996-06-13 19:12:35 +0000 | [diff] [blame] | 1116 | |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1117 | _queryprog = None |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1118 | def splitquery(url): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1119 | """splitquery('/path?query') --> '/path', 'query'.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1120 | global _queryprog |
| 1121 | if _queryprog is None: |
| 1122 | import re |
| 1123 | _queryprog = re.compile('^(.*)\?([^?]*)$') |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1124 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1125 | match = _queryprog.match(url) |
| 1126 | if match: return match.group(1, 2) |
| 1127 | return url, None |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1128 | |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1129 | _tagprog = None |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1130 | def splittag(url): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1131 | """splittag('/path#tag') --> '/path', 'tag'.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1132 | global _tagprog |
| 1133 | if _tagprog is None: |
| 1134 | import re |
| 1135 | _tagprog = re.compile('^(.*)#([^#]*)$') |
Guido van Rossum | 7e7ca0b | 1998-03-26 21:01:39 +0000 | [diff] [blame] | 1136 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1137 | match = _tagprog.match(url) |
| 1138 | if match: return match.group(1, 2) |
| 1139 | return url, None |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1140 | |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 1141 | def splitattr(url): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1142 | """splitattr('/path;attr1=value1;attr2=value2;...') -> |
| 1143 | '/path', ['attr1=value1', 'attr2=value2', ...].""" |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1144 | words = url.split(';') |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1145 | return words[0], words[1:] |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 1146 | |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1147 | _valueprog = None |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 1148 | def splitvalue(attr): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1149 | """splitvalue('attr=value') --> 'attr', 'value'.""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1150 | global _valueprog |
| 1151 | if _valueprog is None: |
| 1152 | import re |
| 1153 | _valueprog = re.compile('^([^=]*)=(.*)$') |
Guido van Rossum | 332e144 | 1997-09-29 23:23:46 +0000 | [diff] [blame] | 1154 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1155 | match = _valueprog.match(attr) |
| 1156 | if match: return match.group(1, 2) |
| 1157 | return attr, None |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 1158 | |
Senthil Kumaran | f3e9b2a | 2010-03-18 12:14:15 +0000 | [diff] [blame] | 1159 | _hexdig = '0123456789ABCDEFabcdef' |
| 1160 | _hextochr = dict((a+b, chr(int(a+b,16))) for a in _hexdig for b in _hexdig) |
Raymond Hettinger | 803ce80 | 2005-09-10 06:49:04 +0000 | [diff] [blame] | 1161 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1162 | def unquote(s): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1163 | """unquote('abc%20def') -> 'abc def'.""" |
Raymond Hettinger | 803ce80 | 2005-09-10 06:49:04 +0000 | [diff] [blame] | 1164 | res = s.split('%') |
| 1165 | for i in xrange(1, len(res)): |
| 1166 | item = res[i] |
| 1167 | try: |
| 1168 | res[i] = _hextochr[item[:2]] + item[2:] |
| 1169 | except KeyError: |
| 1170 | res[i] = '%' + item |
Raymond Hettinger | 4b0f20d | 2005-10-15 16:41:53 +0000 | [diff] [blame] | 1171 | except UnicodeDecodeError: |
| 1172 | res[i] = unichr(int(item[:2], 16)) + item[2:] |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1173 | return "".join(res) |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1174 | |
Guido van Rossum | 0564e12 | 1996-12-13 14:47:36 +0000 | [diff] [blame] | 1175 | def unquote_plus(s): |
Skip Montanaro | 79f1c17 | 2000-08-22 03:00:52 +0000 | [diff] [blame] | 1176 | """unquote('%7e/abc+def') -> '~/abc def'""" |
Brett Cannon | aaeffaf | 2004-03-23 23:50:17 +0000 | [diff] [blame] | 1177 | s = s.replace('+', ' ') |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1178 | return unquote(s) |
Guido van Rossum | 0564e12 | 1996-12-13 14:47:36 +0000 | [diff] [blame] | 1179 | |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 1180 | always_safe = ('ABCDEFGHIJKLMNOPQRSTUVWXYZ' |
Jeremy Hylton | 6102e29 | 2000-08-31 15:48:10 +0000 | [diff] [blame] | 1181 | 'abcdefghijklmnopqrstuvwxyz' |
Jeremy Hylton | 7ae51bf | 2000-09-14 16:59:07 +0000 | [diff] [blame] | 1182 | '0123456789' '_.-') |
Raymond Hettinger | 199d2f7 | 2005-09-09 22:27:13 +0000 | [diff] [blame] | 1183 | _safemaps = {} |
Jeremy Hylton | 7ae51bf | 2000-09-14 16:59:07 +0000 | [diff] [blame] | 1184 | |
Guido van Rossum | 7c395db | 1994-07-04 22:14:49 +0000 | [diff] [blame] | 1185 | def quote(s, safe = '/'): |
Jeremy Hylton | 7ae51bf | 2000-09-14 16:59:07 +0000 | [diff] [blame] | 1186 | """quote('abc def') -> 'abc%20def' |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 1187 | |
Jeremy Hylton | 7ae51bf | 2000-09-14 16:59:07 +0000 | [diff] [blame] | 1188 | Each part of a URL, e.g. the path info, the query, etc., has a |
| 1189 | different set of reserved characters that must be quoted. |
| 1190 | |
| 1191 | RFC 2396 Uniform Resource Identifiers (URI): Generic Syntax lists |
| 1192 | the following reserved characters. |
| 1193 | |
| 1194 | reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" | |
| 1195 | "$" | "," |
| 1196 | |
| 1197 | Each of these characters is reserved in some component of a URL, |
| 1198 | but not necessarily in all of them. |
| 1199 | |
| 1200 | By default, the quote function is intended for quoting the path |
| 1201 | section of a URL. Thus, it will not encode '/'. This character |
| 1202 | is reserved, but in typical usage the quote function is being |
| 1203 | called on a path where the existing slash characters are used as |
| 1204 | reserved characters. |
| 1205 | """ |
Raymond Hettinger | 199d2f7 | 2005-09-09 22:27:13 +0000 | [diff] [blame] | 1206 | cachekey = (safe, always_safe) |
| 1207 | try: |
| 1208 | safe_map = _safemaps[cachekey] |
| 1209 | except KeyError: |
| 1210 | safe += always_safe |
| 1211 | safe_map = {} |
| 1212 | for i in range(256): |
| 1213 | c = chr(i) |
| 1214 | safe_map[c] = (c in safe) and c or ('%%%02X' % i) |
| 1215 | _safemaps[cachekey] = safe_map |
| 1216 | res = map(safe_map.__getitem__, s) |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1217 | return ''.join(res) |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1218 | |
Jeremy Hylton | 7ae51bf | 2000-09-14 16:59:07 +0000 | [diff] [blame] | 1219 | def quote_plus(s, safe = ''): |
| 1220 | """Quote the query fragment of a URL; replacing ' ' with '+'""" |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1221 | if ' ' in s: |
Raymond Hettinger | cf6b632 | 2005-09-10 18:17:54 +0000 | [diff] [blame] | 1222 | s = quote(s, safe + ' ') |
| 1223 | return s.replace(' ', '+') |
| 1224 | return quote(s, safe) |
Guido van Rossum | 0564e12 | 1996-12-13 14:47:36 +0000 | [diff] [blame] | 1225 | |
Skip Montanaro | 14f1ad4 | 2001-01-28 21:11:12 +0000 | [diff] [blame] | 1226 | def urlencode(query,doseq=0): |
| 1227 | """Encode a sequence of two-element tuples or dictionary into a URL query string. |
Skip Montanaro | a5d23a1 | 2001-01-20 15:56:39 +0000 | [diff] [blame] | 1228 | |
Skip Montanaro | 14f1ad4 | 2001-01-28 21:11:12 +0000 | [diff] [blame] | 1229 | If any values in the query arg are sequences and doseq is true, each |
Skip Montanaro | a5d23a1 | 2001-01-20 15:56:39 +0000 | [diff] [blame] | 1230 | sequence element is converted to a separate parameter. |
Skip Montanaro | 14f1ad4 | 2001-01-28 21:11:12 +0000 | [diff] [blame] | 1231 | |
| 1232 | If the query arg is a sequence of two-element tuples, the order of the |
| 1233 | parameters in the output will match the order of parameters in the |
| 1234 | input. |
Skip Montanaro | a5d23a1 | 2001-01-20 15:56:39 +0000 | [diff] [blame] | 1235 | """ |
Tim Peters | 658cba6 | 2001-02-09 20:06:00 +0000 | [diff] [blame] | 1236 | |
Skip Montanaro | 14f1ad4 | 2001-01-28 21:11:12 +0000 | [diff] [blame] | 1237 | if hasattr(query,"items"): |
| 1238 | # mapping objects |
| 1239 | query = query.items() |
| 1240 | else: |
| 1241 | # it's a bother at times that strings and string-like objects are |
| 1242 | # sequences... |
| 1243 | try: |
| 1244 | # non-sequence items should not work with len() |
Skip Montanaro | 14f1ad4 | 2001-01-28 21:11:12 +0000 | [diff] [blame] | 1245 | # non-empty strings will fail this |
Walter Dörwald | 65230a2 | 2002-06-03 15:58:32 +0000 | [diff] [blame] | 1246 | if len(query) and not isinstance(query[0], tuple): |
Skip Montanaro | 14f1ad4 | 2001-01-28 21:11:12 +0000 | [diff] [blame] | 1247 | raise TypeError |
| 1248 | # zero-length sequences of all types will get here and succeed, |
| 1249 | # but that's a minor nit - since the original implementation |
| 1250 | # allowed empty dicts that type of behavior probably should be |
| 1251 | # preserved for consistency |
| 1252 | except TypeError: |
| 1253 | ty,va,tb = sys.exc_info() |
| 1254 | raise TypeError, "not a valid non-string sequence or mapping object", tb |
| 1255 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1256 | l = [] |
Skip Montanaro | a5d23a1 | 2001-01-20 15:56:39 +0000 | [diff] [blame] | 1257 | if not doseq: |
| 1258 | # preserve old behavior |
Skip Montanaro | 14f1ad4 | 2001-01-28 21:11:12 +0000 | [diff] [blame] | 1259 | for k, v in query: |
Skip Montanaro | a5d23a1 | 2001-01-20 15:56:39 +0000 | [diff] [blame] | 1260 | k = quote_plus(str(k)) |
| 1261 | v = quote_plus(str(v)) |
| 1262 | l.append(k + '=' + v) |
| 1263 | else: |
Skip Montanaro | 14f1ad4 | 2001-01-28 21:11:12 +0000 | [diff] [blame] | 1264 | for k, v in query: |
Skip Montanaro | a5d23a1 | 2001-01-20 15:56:39 +0000 | [diff] [blame] | 1265 | k = quote_plus(str(k)) |
Walter Dörwald | 65230a2 | 2002-06-03 15:58:32 +0000 | [diff] [blame] | 1266 | if isinstance(v, str): |
Skip Montanaro | a5d23a1 | 2001-01-20 15:56:39 +0000 | [diff] [blame] | 1267 | v = quote_plus(v) |
| 1268 | l.append(k + '=' + v) |
Guido van Rossum | 4b46c0a | 2002-05-24 17:58:05 +0000 | [diff] [blame] | 1269 | elif _is_unicode(v): |
Skip Montanaro | a5d23a1 | 2001-01-20 15:56:39 +0000 | [diff] [blame] | 1270 | # is there a reasonable way to convert to ASCII? |
| 1271 | # encode generates a string, but "replace" or "ignore" |
| 1272 | # lose information and "strict" can raise UnicodeError |
| 1273 | v = quote_plus(v.encode("ASCII","replace")) |
| 1274 | l.append(k + '=' + v) |
| 1275 | else: |
| 1276 | try: |
| 1277 | # is this a sufficient test for sequence-ness? |
Georg Brandl | 84fedf7 | 2010-02-06 22:59:15 +0000 | [diff] [blame] | 1278 | len(v) |
Skip Montanaro | a5d23a1 | 2001-01-20 15:56:39 +0000 | [diff] [blame] | 1279 | except TypeError: |
| 1280 | # not a sequence |
| 1281 | v = quote_plus(str(v)) |
| 1282 | l.append(k + '=' + v) |
| 1283 | else: |
| 1284 | # loop over the sequence |
| 1285 | for elt in v: |
| 1286 | l.append(k + '=' + quote_plus(str(elt))) |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1287 | return '&'.join(l) |
Guido van Rossum | 810a339 | 1998-07-22 21:33:23 +0000 | [diff] [blame] | 1288 | |
Guido van Rossum | 442e720 | 1996-03-20 15:33:11 +0000 | [diff] [blame] | 1289 | # Proxy handling |
Mark Hammond | 4f570b9 | 2000-07-26 07:04:38 +0000 | [diff] [blame] | 1290 | def getproxies_environment(): |
| 1291 | """Return a dictionary of scheme -> proxy server URL mappings. |
| 1292 | |
| 1293 | Scan the environment for variables named <scheme>_proxy; |
| 1294 | this seems to be the standard convention. If you need a |
| 1295 | different way, you can pass a proxies dictionary to the |
| 1296 | [Fancy]URLopener constructor. |
| 1297 | |
| 1298 | """ |
| 1299 | proxies = {} |
| 1300 | for name, value in os.environ.items(): |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1301 | name = name.lower() |
Mark Hammond | 4f570b9 | 2000-07-26 07:04:38 +0000 | [diff] [blame] | 1302 | if value and name[-6:] == '_proxy': |
| 1303 | proxies[name[:-6]] = value |
| 1304 | return proxies |
| 1305 | |
Georg Brandl | 2235011 | 2008-01-20 12:05:43 +0000 | [diff] [blame] | 1306 | def proxy_bypass_environment(host): |
| 1307 | """Test if proxies should not be used for a particular host. |
| 1308 | |
| 1309 | Checks the environment for a variable named no_proxy, which should |
| 1310 | be a list of DNS suffixes separated by commas, or '*' for all hosts. |
| 1311 | """ |
| 1312 | no_proxy = os.environ.get('no_proxy', '') or os.environ.get('NO_PROXY', '') |
| 1313 | # '*' is special case for always bypass |
| 1314 | if no_proxy == '*': |
| 1315 | return 1 |
| 1316 | # strip port off host |
| 1317 | hostonly, port = splitport(host) |
| 1318 | # check if the host ends with any of the DNS suffixes |
| 1319 | for name in no_proxy.split(','): |
| 1320 | if name and (hostonly.endswith(name) or host.endswith(name)): |
| 1321 | return 1 |
| 1322 | # otherwise, don't bypass |
| 1323 | return 0 |
| 1324 | |
| 1325 | |
Jack Jansen | 11d9b06 | 2004-07-16 11:45:00 +0000 | [diff] [blame] | 1326 | if sys.platform == 'darwin': |
Ronald Oussoren | 51f0633 | 2009-09-20 10:31:22 +0000 | [diff] [blame] | 1327 | from _scproxy import _get_proxy_settings, _get_proxies |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1328 | |
| 1329 | def proxy_bypass_macosx_sysconf(host): |
| 1330 | """ |
| 1331 | Return True iff this host shouldn't be accessed using a proxy |
| 1332 | |
| 1333 | This function uses the MacOSX framework SystemConfiguration |
| 1334 | to fetch the proxy information. |
| 1335 | """ |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1336 | import re |
| 1337 | import socket |
| 1338 | from fnmatch import fnmatch |
| 1339 | |
Ronald Oussoren | 31802d0 | 2009-10-18 07:07:00 +0000 | [diff] [blame] | 1340 | hostonly, port = splitport(host) |
| 1341 | |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1342 | def ip2num(ipAddr): |
| 1343 | parts = ipAddr.split('.') |
| 1344 | parts = map(int, parts) |
| 1345 | if len(parts) != 4: |
| 1346 | parts = (parts + [0, 0, 0, 0])[:4] |
| 1347 | return (parts[0] << 24) | (parts[1] << 16) | (parts[2] << 8) | parts[3] |
| 1348 | |
Ronald Oussoren | 51f0633 | 2009-09-20 10:31:22 +0000 | [diff] [blame] | 1349 | proxy_settings = _get_proxy_settings() |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1350 | |
Ronald Oussoren | 51f0633 | 2009-09-20 10:31:22 +0000 | [diff] [blame] | 1351 | # Check for simple host names: |
| 1352 | if '.' not in host: |
| 1353 | if proxy_settings['exclude_simple']: |
| 1354 | return True |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1355 | |
Ronald Oussoren | 31802d0 | 2009-10-18 07:07:00 +0000 | [diff] [blame] | 1356 | hostIP = None |
| 1357 | |
Ronald Oussoren | 809073b | 2009-09-20 10:54:07 +0000 | [diff] [blame] | 1358 | for value in proxy_settings.get('exceptions', ()): |
Ronald Oussoren | 51f0633 | 2009-09-20 10:31:22 +0000 | [diff] [blame] | 1359 | # Items in the list are strings like these: *.local, 169.254/16 |
Ronald Oussoren | 51f0633 | 2009-09-20 10:31:22 +0000 | [diff] [blame] | 1360 | if not value: continue |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1361 | |
Ronald Oussoren | 51f0633 | 2009-09-20 10:31:22 +0000 | [diff] [blame] | 1362 | m = re.match(r"(\d+(?:\.\d+)*)(/\d+)?", value) |
| 1363 | if m is not None: |
| 1364 | if hostIP is None: |
Ronald Oussoren | 31802d0 | 2009-10-18 07:07:00 +0000 | [diff] [blame] | 1365 | try: |
| 1366 | hostIP = socket.gethostbyname(hostonly) |
| 1367 | hostIP = ip2num(hostIP) |
| 1368 | except socket.error: |
| 1369 | continue |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1370 | |
Ronald Oussoren | 51f0633 | 2009-09-20 10:31:22 +0000 | [diff] [blame] | 1371 | base = ip2num(m.group(1)) |
| 1372 | mask = int(m.group(2)[1:]) |
| 1373 | mask = 32 - mask |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1374 | |
Ronald Oussoren | 51f0633 | 2009-09-20 10:31:22 +0000 | [diff] [blame] | 1375 | if (hostIP >> mask) == (base >> mask): |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1376 | return True |
| 1377 | |
Ronald Oussoren | 51f0633 | 2009-09-20 10:31:22 +0000 | [diff] [blame] | 1378 | elif fnmatch(host, value): |
| 1379 | return True |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1380 | |
Ronald Oussoren | 51f0633 | 2009-09-20 10:31:22 +0000 | [diff] [blame] | 1381 | return False |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1382 | |
| 1383 | |
| 1384 | def getproxies_macosx_sysconf(): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1385 | """Return a dictionary of scheme -> proxy server URL mappings. |
Guido van Rossum | 442e720 | 1996-03-20 15:33:11 +0000 | [diff] [blame] | 1386 | |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1387 | This function uses the MacOSX framework SystemConfiguration |
| 1388 | to fetch the proxy information. |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1389 | """ |
Ronald Oussoren | 51f0633 | 2009-09-20 10:31:22 +0000 | [diff] [blame] | 1390 | return _get_proxies() |
Mark Hammond | 4f570b9 | 2000-07-26 07:04:38 +0000 | [diff] [blame] | 1391 | |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1392 | |
| 1393 | |
Georg Brandl | 2235011 | 2008-01-20 12:05:43 +0000 | [diff] [blame] | 1394 | def proxy_bypass(host): |
| 1395 | if getproxies_environment(): |
| 1396 | return proxy_bypass_environment(host) |
| 1397 | else: |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1398 | return proxy_bypass_macosx_sysconf(host) |
Tim Peters | 55c12d4 | 2001-08-09 18:04:14 +0000 | [diff] [blame] | 1399 | |
Jack Jansen | 11d9b06 | 2004-07-16 11:45:00 +0000 | [diff] [blame] | 1400 | def getproxies(): |
Ronald Oussoren | 9dd6b1d | 2008-05-12 11:31:05 +0000 | [diff] [blame] | 1401 | return getproxies_environment() or getproxies_macosx_sysconf() |
Tim Peters | 182b5ac | 2004-07-18 06:16:08 +0000 | [diff] [blame] | 1402 | |
Mark Hammond | 4f570b9 | 2000-07-26 07:04:38 +0000 | [diff] [blame] | 1403 | elif os.name == 'nt': |
| 1404 | def getproxies_registry(): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1405 | """Return a dictionary of scheme -> proxy server URL mappings. |
Mark Hammond | 4f570b9 | 2000-07-26 07:04:38 +0000 | [diff] [blame] | 1406 | |
| 1407 | Win32 uses the registry to store proxies. |
| 1408 | |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1409 | """ |
| 1410 | proxies = {} |
Mark Hammond | 4f570b9 | 2000-07-26 07:04:38 +0000 | [diff] [blame] | 1411 | try: |
| 1412 | import _winreg |
| 1413 | except ImportError: |
| 1414 | # Std module, so should be around - but you never know! |
| 1415 | return proxies |
| 1416 | try: |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 1417 | internetSettings = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER, |
| 1418 | r'Software\Microsoft\Windows\CurrentVersion\Internet Settings') |
Mark Hammond | 4f570b9 | 2000-07-26 07:04:38 +0000 | [diff] [blame] | 1419 | proxyEnable = _winreg.QueryValueEx(internetSettings, |
| 1420 | 'ProxyEnable')[0] |
| 1421 | if proxyEnable: |
| 1422 | # Returned as Unicode but problems if not converted to ASCII |
| 1423 | proxyServer = str(_winreg.QueryValueEx(internetSettings, |
| 1424 | 'ProxyServer')[0]) |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 1425 | if '=' in proxyServer: |
| 1426 | # Per-protocol settings |
Mark Hammond | 4f570b9 | 2000-07-26 07:04:38 +0000 | [diff] [blame] | 1427 | for p in proxyServer.split(';'): |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 1428 | protocol, address = p.split('=', 1) |
Guido van Rossum | b955d6c | 2002-03-31 23:38:48 +0000 | [diff] [blame] | 1429 | # See if address has a type:// prefix |
Guido van Rossum | 64e5aa9 | 2002-04-02 14:38:16 +0000 | [diff] [blame] | 1430 | import re |
| 1431 | if not re.match('^([^/:]+)://', address): |
Guido van Rossum | b955d6c | 2002-03-31 23:38:48 +0000 | [diff] [blame] | 1432 | address = '%s://%s' % (protocol, address) |
| 1433 | proxies[protocol] = address |
Fredrik Lundh | b49f88b | 2000-09-24 18:51:25 +0000 | [diff] [blame] | 1434 | else: |
| 1435 | # Use one setting for all protocols |
| 1436 | if proxyServer[:5] == 'http:': |
| 1437 | proxies['http'] = proxyServer |
| 1438 | else: |
| 1439 | proxies['http'] = 'http://%s' % proxyServer |
| 1440 | proxies['ftp'] = 'ftp://%s' % proxyServer |
Mark Hammond | 4f570b9 | 2000-07-26 07:04:38 +0000 | [diff] [blame] | 1441 | internetSettings.Close() |
| 1442 | except (WindowsError, ValueError, TypeError): |
| 1443 | # Either registry key not found etc, or the value in an |
| 1444 | # unexpected format. |
| 1445 | # proxies already set up to be empty so nothing to do |
| 1446 | pass |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1447 | return proxies |
Guido van Rossum | 442e720 | 1996-03-20 15:33:11 +0000 | [diff] [blame] | 1448 | |
Mark Hammond | 4f570b9 | 2000-07-26 07:04:38 +0000 | [diff] [blame] | 1449 | def getproxies(): |
| 1450 | """Return a dictionary of scheme -> proxy server URL mappings. |
| 1451 | |
| 1452 | Returns settings gathered from the environment, if specified, |
| 1453 | or the registry. |
| 1454 | |
| 1455 | """ |
| 1456 | return getproxies_environment() or getproxies_registry() |
Tim Peters | 55c12d4 | 2001-08-09 18:04:14 +0000 | [diff] [blame] | 1457 | |
Georg Brandl | 2235011 | 2008-01-20 12:05:43 +0000 | [diff] [blame] | 1458 | def proxy_bypass_registry(host): |
Tim Peters | 55c12d4 | 2001-08-09 18:04:14 +0000 | [diff] [blame] | 1459 | try: |
| 1460 | import _winreg |
| 1461 | import re |
Tim Peters | 55c12d4 | 2001-08-09 18:04:14 +0000 | [diff] [blame] | 1462 | except ImportError: |
| 1463 | # Std modules, so should be around - but you never know! |
| 1464 | return 0 |
| 1465 | try: |
| 1466 | internetSettings = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER, |
| 1467 | r'Software\Microsoft\Windows\CurrentVersion\Internet Settings') |
| 1468 | proxyEnable = _winreg.QueryValueEx(internetSettings, |
| 1469 | 'ProxyEnable')[0] |
| 1470 | proxyOverride = str(_winreg.QueryValueEx(internetSettings, |
| 1471 | 'ProxyOverride')[0]) |
| 1472 | # ^^^^ Returned as Unicode but problems if not converted to ASCII |
| 1473 | except WindowsError: |
| 1474 | return 0 |
| 1475 | if not proxyEnable or not proxyOverride: |
| 1476 | return 0 |
| 1477 | # try to make a host list from name and IP address. |
Georg Brandl | 1f63670 | 2006-02-18 23:10:23 +0000 | [diff] [blame] | 1478 | rawHost, port = splitport(host) |
| 1479 | host = [rawHost] |
Tim Peters | 55c12d4 | 2001-08-09 18:04:14 +0000 | [diff] [blame] | 1480 | try: |
Georg Brandl | 1f63670 | 2006-02-18 23:10:23 +0000 | [diff] [blame] | 1481 | addr = socket.gethostbyname(rawHost) |
| 1482 | if addr != rawHost: |
Tim Peters | 55c12d4 | 2001-08-09 18:04:14 +0000 | [diff] [blame] | 1483 | host.append(addr) |
| 1484 | except socket.error: |
| 1485 | pass |
Georg Brandl | 1f63670 | 2006-02-18 23:10:23 +0000 | [diff] [blame] | 1486 | try: |
| 1487 | fqdn = socket.getfqdn(rawHost) |
| 1488 | if fqdn != rawHost: |
| 1489 | host.append(fqdn) |
| 1490 | except socket.error: |
| 1491 | pass |
Tim Peters | 55c12d4 | 2001-08-09 18:04:14 +0000 | [diff] [blame] | 1492 | # make a check value list from the registry entry: replace the |
| 1493 | # '<local>' string by the localhost entry and the corresponding |
| 1494 | # canonical entry. |
| 1495 | proxyOverride = proxyOverride.split(';') |
Tim Peters | 55c12d4 | 2001-08-09 18:04:14 +0000 | [diff] [blame] | 1496 | # now check if we match one of the registry values. |
| 1497 | for test in proxyOverride: |
Senthil Kumaran | 4af40d2 | 2009-05-01 05:59:52 +0000 | [diff] [blame] | 1498 | if test == '<local>': |
| 1499 | if '.' not in rawHost: |
| 1500 | return 1 |
Tim Peters | ab9ba27 | 2001-08-09 21:40:30 +0000 | [diff] [blame] | 1501 | test = test.replace(".", r"\.") # mask dots |
| 1502 | test = test.replace("*", r".*") # change glob sequence |
| 1503 | test = test.replace("?", r".") # change glob char |
Tim Peters | 55c12d4 | 2001-08-09 18:04:14 +0000 | [diff] [blame] | 1504 | for val in host: |
| 1505 | # print "%s <--> %s" %( test, val ) |
| 1506 | if re.match(test, val, re.I): |
| 1507 | return 1 |
| 1508 | return 0 |
| 1509 | |
Georg Brandl | 2235011 | 2008-01-20 12:05:43 +0000 | [diff] [blame] | 1510 | def proxy_bypass(host): |
| 1511 | """Return a dictionary of scheme -> proxy server URL mappings. |
| 1512 | |
| 1513 | Returns settings gathered from the environment, if specified, |
| 1514 | or the registry. |
| 1515 | |
| 1516 | """ |
| 1517 | if getproxies_environment(): |
| 1518 | return proxy_bypass_environment(host) |
| 1519 | else: |
| 1520 | return proxy_bypass_registry(host) |
| 1521 | |
Mark Hammond | 4f570b9 | 2000-07-26 07:04:38 +0000 | [diff] [blame] | 1522 | else: |
| 1523 | # By default use environment variables |
| 1524 | getproxies = getproxies_environment |
Georg Brandl | 2235011 | 2008-01-20 12:05:43 +0000 | [diff] [blame] | 1525 | proxy_bypass = proxy_bypass_environment |
Guido van Rossum | 442e720 | 1996-03-20 15:33:11 +0000 | [diff] [blame] | 1526 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1527 | # Test and time quote() and unquote() |
| 1528 | def test1(): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1529 | s = '' |
| 1530 | for i in range(256): s = s + chr(i) |
| 1531 | s = s*4 |
| 1532 | t0 = time.time() |
| 1533 | qs = quote(s) |
| 1534 | uqs = unquote(qs) |
| 1535 | t1 = time.time() |
| 1536 | if uqs != s: |
| 1537 | print 'Wrong!' |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 1538 | print repr(s) |
| 1539 | print repr(qs) |
| 1540 | print repr(uqs) |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1541 | print round(t1 - t0, 3), 'sec' |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1542 | |
| 1543 | |
Guido van Rossum | 9ab96d4 | 1998-09-28 14:07:00 +0000 | [diff] [blame] | 1544 | def reporthook(blocknum, blocksize, totalsize): |
| 1545 | # Report during remote transfers |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1546 | print "Block number: %d, Block size: %d, Total size: %d" % ( |
| 1547 | blocknum, blocksize, totalsize) |
Guido van Rossum | 9ab96d4 | 1998-09-28 14:07:00 +0000 | [diff] [blame] | 1548 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1549 | # Test program |
Guido van Rossum | 2349015 | 1998-06-25 02:39:00 +0000 | [diff] [blame] | 1550 | def test(args=[]): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1551 | if not args: |
| 1552 | args = [ |
| 1553 | '/etc/passwd', |
| 1554 | 'file:/etc/passwd', |
| 1555 | 'file://localhost/etc/passwd', |
Collin Winter | 071d1ae | 2007-03-12 01:55:54 +0000 | [diff] [blame] | 1556 | 'ftp://ftp.gnu.org/pub/README', |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1557 | 'http://www.python.org/index.html', |
| 1558 | ] |
Guido van Rossum | 09c8b6c | 1999-12-07 21:37:17 +0000 | [diff] [blame] | 1559 | if hasattr(URLopener, "open_https"): |
| 1560 | args.append('https://synergy.as.cmu.edu/~geek/') |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1561 | try: |
| 1562 | for url in args: |
| 1563 | print '-'*10, url, '-'*10 |
| 1564 | fn, h = urlretrieve(url, None, reporthook) |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1565 | print fn |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1566 | if h: |
| 1567 | print '======' |
| 1568 | for k in h.keys(): print k + ':', h[k] |
| 1569 | print '======' |
Philip Jenvey | 0299d0d | 2009-12-03 02:40:13 +0000 | [diff] [blame] | 1570 | with open(fn, 'rb') as fp: |
| 1571 | data = fp.read() |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1572 | if '\r' in data: |
| 1573 | table = string.maketrans("", "") |
Guido van Rossum | b2493f8 | 2000-12-15 15:01:37 +0000 | [diff] [blame] | 1574 | data = data.translate(table, "\r") |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1575 | print data |
| 1576 | fn, h = None, None |
| 1577 | print '-'*40 |
| 1578 | finally: |
| 1579 | urlcleanup() |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1580 | |
Guido van Rossum | 2349015 | 1998-06-25 02:39:00 +0000 | [diff] [blame] | 1581 | def main(): |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1582 | import getopt, sys |
| 1583 | try: |
| 1584 | opts, args = getopt.getopt(sys.argv[1:], "th") |
| 1585 | except getopt.error, msg: |
| 1586 | print msg |
| 1587 | print "Use -h for help" |
| 1588 | return |
| 1589 | t = 0 |
| 1590 | for o, a in opts: |
| 1591 | if o == '-t': |
| 1592 | t = t + 1 |
| 1593 | if o == '-h': |
| 1594 | print "Usage: python urllib.py [-t] [url ...]" |
| 1595 | print "-t runs self-test;", |
| 1596 | print "otherwise, contents of urls are printed" |
| 1597 | return |
| 1598 | if t: |
| 1599 | if t > 1: |
| 1600 | test1() |
| 1601 | test(args) |
| 1602 | else: |
| 1603 | if not args: |
| 1604 | print "Use -h for help" |
| 1605 | for url in args: |
| 1606 | print urlopen(url).read(), |
Guido van Rossum | 2349015 | 1998-06-25 02:39:00 +0000 | [diff] [blame] | 1607 | |
Guido van Rossum | 7c6ebb5 | 1994-03-22 12:05:32 +0000 | [diff] [blame] | 1608 | # Run test program when run as a script |
| 1609 | if __name__ == '__main__': |
Jeremy Hylton | f90b002 | 1999-02-25 16:12:12 +0000 | [diff] [blame] | 1610 | main() |