blob: c7af8ec4fd987610984df94be032735ef60b1a72 [file] [log] [blame]
Guido van Rossume7b146f2000-02-04 15:28:42 +00001"""Open an arbitrary URL.
2
3See the following document for more info on URLs:
4"Names and Addresses, URIs, URLs, URNs, URCs", at
5http://www.w3.org/pub/WWW/Addressing/Overview.html
6
7See also the HTTP spec (from which the error codes are derived):
8"HTTP - Hypertext Transfer Protocol", at
9http://www.w3.org/pub/WWW/Protocols/
10
11Related 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
16The object returned by URLopener().open(file) will differ per
17protocol. All you know is that is has methods read(), readline(),
18readlines(), fileno(), close() and info(). The read*(), fileno()
Fredrik Lundhb49f88b2000-09-24 18:51:25 +000019and close() methods work like those of open files.
Guido van Rossume7b146f2000-02-04 15:28:42 +000020The info() method returns a mimetools.Message object which can be
21used to query various info about the object, if available.
22(mimetools.Message objects are queried with the getheader() method.)
23"""
Guido van Rossum7c6ebb51994-03-22 12:05:32 +000024
Guido van Rossum7c395db1994-07-04 22:14:49 +000025import string
Guido van Rossum7c6ebb51994-03-22 12:05:32 +000026import socket
Jack Jansendc3e3f61995-12-15 13:22:13 +000027import os
Guido van Rossumf0713d32001-08-09 17:43:35 +000028import time
Guido van Rossum3c8484e1996-11-20 22:02:24 +000029import sys
Senthil Kumaranbcd833f2012-01-11 00:09:24 +080030import base64
31
Brett Cannon69200fa2004-03-23 21:26:39 +000032from urlparse import urljoin as basejoin
Guido van Rossum7c6ebb51994-03-22 12:05:32 +000033
Skip Montanaro40fc1602001-03-01 04:27:19 +000034__all__ = ["urlopen", "URLopener", "FancyURLopener", "urlretrieve",
35 "urlcleanup", "quote", "quote_plus", "unquote", "unquote_plus",
Skip Montanaro44d5e0c2001-03-13 19:47:16 +000036 "urlencode", "url2pathname", "pathname2url", "splittag",
37 "localhost", "thishost", "ftperrors", "basejoin", "unwrap",
38 "splittype", "splithost", "splituser", "splitpasswd", "splitport",
39 "splitnport", "splitquery", "splitattr", "splitvalue",
Brett Cannond75f0432007-05-16 22:42:29 +000040 "getproxies"]
Skip Montanaro40fc1602001-03-01 04:27:19 +000041
Martin v. Löwis3e865952006-01-24 15:51:21 +000042__version__ = '1.17' # XXX This version is not always updated :-(
Guido van Rossumf668d171997-06-06 21:11:11 +000043
Jeremy Hyltonf90b0021999-02-25 16:12:12 +000044MAXFTPCACHE = 10 # Trim the ftp cache beyond this size
Guido van Rossum6cb15a01995-06-22 19:00:13 +000045
Jack Jansendc3e3f61995-12-15 13:22:13 +000046# Helper for non-unix systems
Ronald Oussoren9545a232010-05-05 19:09:31 +000047if os.name == 'nt':
Fredrik Lundhb49f88b2000-09-24 18:51:25 +000048 from nturl2path import url2pathname, pathname2url
Guido van Rossumd74fb6b2001-03-02 06:43:49 +000049elif os.name == 'riscos':
50 from rourl2path import url2pathname, pathname2url
Jack Jansendc3e3f61995-12-15 13:22:13 +000051else:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +000052 def url2pathname(pathname):
Georg Brandlc0b24732005-12-26 22:53:56 +000053 """OS-specific conversion from a relative URL of the 'file' scheme
54 to a file system path; not recommended for general use."""
Guido van Rossum367ac801999-03-12 14:31:10 +000055 return unquote(pathname)
Georg Brandlc0b24732005-12-26 22:53:56 +000056
Jeremy Hyltonf90b0021999-02-25 16:12:12 +000057 def pathname2url(pathname):
Georg Brandlc0b24732005-12-26 22:53:56 +000058 """OS-specific conversion from a file system path to a relative URL
59 of the 'file' scheme; not recommended for general use."""
Guido van Rossum367ac801999-03-12 14:31:10 +000060 return quote(pathname)
Guido van Rossum33add0a1998-12-18 15:25:22 +000061
Guido van Rossum7c6ebb51994-03-22 12:05:32 +000062# This really consists of two pieces:
63# (1) a class which handles opening of all sorts of URLs
64# (plus assorted utilities etc.)
65# (2) a set of functions for parsing URLs
66# XXX Should these be separated out into different modules?
67
68
69# Shortcut for basic usage
70_urlopener = None
Fred Drakedf6eca72002-04-04 20:41:34 +000071def urlopen(url, data=None, proxies=None):
Brett Cannon8bb8fa52008-07-02 01:57:08 +000072 """Create a file-like object for the specified URL to read from."""
73 from warnings import warnpy3k
Georg Brandl48e65f52010-02-06 22:44:17 +000074 warnpy3k("urllib.urlopen() has been removed in Python 3.0 in "
75 "favor of urllib2.urlopen()", stacklevel=2)
Brett Cannon8bb8fa52008-07-02 01:57:08 +000076
Jeremy Hyltonf90b0021999-02-25 16:12:12 +000077 global _urlopener
Fred Drakedf6eca72002-04-04 20:41:34 +000078 if proxies is not None:
79 opener = FancyURLopener(proxies=proxies)
80 elif not _urlopener:
81 opener = FancyURLopener()
82 _urlopener = opener
Jeremy Hyltonf90b0021999-02-25 16:12:12 +000083 else:
Fred Drakedf6eca72002-04-04 20:41:34 +000084 opener = _urlopener
85 if data is None:
86 return opener.open(url)
87 else:
88 return opener.open(url, data)
Fred Drake316a7932000-08-24 01:01:26 +000089def urlretrieve(url, filename=None, reporthook=None, data=None):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +000090 global _urlopener
91 if not _urlopener:
92 _urlopener = FancyURLopener()
Fred Drake316a7932000-08-24 01:01:26 +000093 return _urlopener.retrieve(url, filename, reporthook, data)
Guido van Rossum7c6ebb51994-03-22 12:05:32 +000094def urlcleanup():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +000095 if _urlopener:
96 _urlopener.cleanup()
Florent Xiclunaaf87f9f2010-05-17 13:35:09 +000097 _safe_quoters.clear()
Antoine Pitrouca173e22009-12-08 19:35:12 +000098 ftpcache.clear()
Guido van Rossum7c6ebb51994-03-22 12:05:32 +000099
Bill Janssen426ea0a2007-08-29 22:35:05 +0000100# check for SSL
101try:
102 import ssl
103except:
104 _have_ssl = False
105else:
106 _have_ssl = True
107
Georg Brandlb9256022005-08-24 18:46:39 +0000108# exception raised when downloaded size does not match content-length
109class ContentTooShortError(IOError):
110 def __init__(self, message, content):
111 IOError.__init__(self, message)
112 self.content = content
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000113
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000114ftpcache = {}
115class URLopener:
Guido van Rossume7b146f2000-02-04 15:28:42 +0000116 """Class to open URLs.
117 This is a class rather than just a subroutine because we may need
118 more than one set of global protocol-specific options.
119 Note -- this is a base class for those who don't want the
120 automatic handling of errors type 302 (relocated) and 401
121 (authorization needed)."""
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000122
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000123 __tempfiles = None
Guido van Rossum29e77811996-11-27 19:39:58 +0000124
Guido van Rossumba311382000-08-24 16:18:04 +0000125 version = "Python-urllib/%s" % __version__
126
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000127 # Constructor
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000128 def __init__(self, proxies=None, **x509):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000129 if proxies is None:
130 proxies = getproxies()
131 assert hasattr(proxies, 'has_key'), "proxies must be a mapping"
132 self.proxies = proxies
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000133 self.key_file = x509.get('key_file')
134 self.cert_file = x509.get('cert_file')
Georg Brandl0619a322006-07-26 07:40:17 +0000135 self.addheaders = [('User-Agent', self.version)]
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000136 self.__tempfiles = []
137 self.__unlink = os.unlink # See cleanup()
138 self.tempcache = None
139 # Undocumented feature: if you assign {} to tempcache,
140 # it is used to cache files retrieved with
141 # self.retrieve(). This is not enabled by default
142 # since it does not work for changing documents (and I
143 # haven't got the logic to check expiration headers
144 # yet).
145 self.ftpcache = ftpcache
146 # Undocumented feature: you can use a different
147 # ftp cache by assigning to the .ftpcache member;
148 # in case you want logically independent URL openers
149 # XXX This is not threadsafe. Bah.
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000150
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000151 def __del__(self):
152 self.close()
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000153
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000154 def close(self):
155 self.cleanup()
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000156
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000157 def cleanup(self):
158 # This code sometimes runs when the rest of this module
159 # has already been deleted, so it can't use any globals
160 # or import anything.
161 if self.__tempfiles:
162 for file in self.__tempfiles:
163 try:
164 self.__unlink(file)
Martin v. Löwis58682b72001-08-11 15:02:57 +0000165 except OSError:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000166 pass
167 del self.__tempfiles[:]
168 if self.tempcache:
169 self.tempcache.clear()
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000170
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000171 def addheader(self, *args):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000172 """Add a header to be used by the HTTP interface only
173 e.g. u.addheader('Accept', 'sound/basic')"""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000174 self.addheaders.append(args)
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000175
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000176 # External interface
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000177 def open(self, fullurl, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000178 """Use URLopener().open(file) instead of open(file, 'r')."""
Martin v. Löwis1d994332000-12-03 18:30:10 +0000179 fullurl = unwrap(toBytes(fullurl))
Senthil Kumaran7c2867f2009-04-21 03:24:19 +0000180 # percent encode url, fixing lame server errors for e.g, like space
181 # within url paths.
Senthil Kumaran18d5a692010-02-20 22:05:34 +0000182 fullurl = quote(fullurl, safe="%/:=&?~#+!$,;'@()*[]|")
Raymond Hettinger54f02222002-06-01 14:18:47 +0000183 if self.tempcache and fullurl in self.tempcache:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000184 filename, headers = self.tempcache[fullurl]
185 fp = open(filename, 'rb')
186 return addinfourl(fp, headers, fullurl)
Martin v. Löwis1d994332000-12-03 18:30:10 +0000187 urltype, url = splittype(fullurl)
188 if not urltype:
189 urltype = 'file'
Raymond Hettinger54f02222002-06-01 14:18:47 +0000190 if urltype in self.proxies:
Martin v. Löwis1d994332000-12-03 18:30:10 +0000191 proxy = self.proxies[urltype]
192 urltype, proxyhost = splittype(proxy)
Jeremy Hyltond52755f2000-10-02 23:04:02 +0000193 host, selector = splithost(proxyhost)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000194 url = (host, fullurl) # Signal special case to open_*()
Jeremy Hyltond52755f2000-10-02 23:04:02 +0000195 else:
196 proxy = None
Martin v. Löwis1d994332000-12-03 18:30:10 +0000197 name = 'open_' + urltype
198 self.type = urltype
Brett Cannonaaeffaf2004-03-23 23:50:17 +0000199 name = name.replace('-', '_')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000200 if not hasattr(self, name):
Jeremy Hyltond52755f2000-10-02 23:04:02 +0000201 if proxy:
202 return self.open_unknown_proxy(proxy, fullurl, data)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000203 else:
204 return self.open_unknown(fullurl, data)
205 try:
206 if data is None:
207 return getattr(self, name)(url)
208 else:
209 return getattr(self, name)(url, data)
210 except socket.error, msg:
211 raise IOError, ('socket error', msg), sys.exc_info()[2]
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000212
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000213 def open_unknown(self, fullurl, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000214 """Overridable interface to open unknown URL type."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000215 type, url = splittype(fullurl)
216 raise IOError, ('url error', 'unknown url type', type)
Guido van Rossumca445401995-08-29 19:19:12 +0000217
Jeremy Hyltond52755f2000-10-02 23:04:02 +0000218 def open_unknown_proxy(self, proxy, fullurl, data=None):
219 """Overridable interface to open unknown URL type."""
220 type, url = splittype(fullurl)
221 raise IOError, ('url error', 'invalid proxy for %s' % type, proxy)
222
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000223 # External interface
Sjoerd Mullenderd7b86f02000-08-25 11:23:36 +0000224 def retrieve(self, url, filename=None, reporthook=None, data=None):
Brett Cannon7d618c72003-04-24 02:43:20 +0000225 """retrieve(url) returns (filename, headers) for a local object
Guido van Rossume7b146f2000-02-04 15:28:42 +0000226 or (tempfilename, headers) for a remote object."""
Martin v. Löwis1d994332000-12-03 18:30:10 +0000227 url = unwrap(toBytes(url))
Raymond Hettinger54f02222002-06-01 14:18:47 +0000228 if self.tempcache and url in self.tempcache:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000229 return self.tempcache[url]
230 type, url1 = splittype(url)
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000231 if filename is None and (not type or type == 'file'):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000232 try:
233 fp = self.open_local_file(url1)
234 hdrs = fp.info()
Philip Jenvey0299d0d2009-12-03 02:40:13 +0000235 fp.close()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000236 return url2pathname(splithost(url1)[1]), hdrs
Georg Brandl84fedf72010-02-06 22:59:15 +0000237 except IOError:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000238 pass
Fred Drake316a7932000-08-24 01:01:26 +0000239 fp = self.open(url, data)
Benjamin Petersonb364bfe2009-03-22 17:45:11 +0000240 try:
241 headers = fp.info()
242 if filename:
243 tfp = open(filename, 'wb')
244 else:
245 import tempfile
246 garbage, path = splittype(url)
247 garbage, path = splithost(path or "")
248 path, garbage = splitquery(path or "")
249 path, garbage = splitattr(path or "")
250 suffix = os.path.splitext(path)[1]
251 (fd, filename) = tempfile.mkstemp(suffix)
252 self.__tempfiles.append(filename)
253 tfp = os.fdopen(fd, 'wb')
254 try:
255 result = filename, headers
256 if self.tempcache is not None:
257 self.tempcache[url] = result
258 bs = 1024*8
259 size = -1
260 read = 0
261 blocknum = 0
Senthil Kumaran87e58552011-11-01 02:44:45 +0800262 if "content-length" in headers:
263 size = int(headers["Content-Length"])
Benjamin Petersonb364bfe2009-03-22 17:45:11 +0000264 if reporthook:
Benjamin Petersonb364bfe2009-03-22 17:45:11 +0000265 reporthook(blocknum, bs, size)
266 while 1:
267 block = fp.read(bs)
268 if block == "":
269 break
270 read += len(block)
271 tfp.write(block)
272 blocknum += 1
273 if reporthook:
274 reporthook(blocknum, bs, size)
275 finally:
276 tfp.close()
277 finally:
278 fp.close()
Georg Brandlb9256022005-08-24 18:46:39 +0000279
280 # raise exception if actual size does not match content-length header
281 if size >= 0 and read < size:
282 raise ContentTooShortError("retrieval incomplete: got only %i out "
283 "of %i bytes" % (read, size), result)
284
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000285 return result
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000286
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000287 # Each method named open_<type> knows how to open that type of URL
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000288
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000289 def open_http(self, url, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000290 """Use HTTP protocol."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000291 import httplib
292 user_passwd = None
Martin v. Löwis3e865952006-01-24 15:51:21 +0000293 proxy_passwd= None
Walter Dörwald65230a22002-06-03 15:58:32 +0000294 if isinstance(url, str):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000295 host, selector = splithost(url)
296 if host:
297 user_passwd, host = splituser(host)
298 host = unquote(host)
299 realhost = host
300 else:
301 host, selector = url
Martin v. Löwis3e865952006-01-24 15:51:21 +0000302 # check whether the proxy contains authorization information
303 proxy_passwd, host = splituser(host)
304 # now we proceed with the url we want to obtain
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000305 urltype, rest = splittype(selector)
306 url = rest
307 user_passwd = None
Guido van Rossumb2493f82000-12-15 15:01:37 +0000308 if urltype.lower() != 'http':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000309 realhost = None
310 else:
311 realhost, rest = splithost(rest)
312 if realhost:
313 user_passwd, realhost = splituser(realhost)
314 if user_passwd:
315 selector = "%s://%s%s" % (urltype, realhost, rest)
Tim Peters55c12d42001-08-09 18:04:14 +0000316 if proxy_bypass(realhost):
317 host = realhost
318
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000319 #print "proxy via http:", host, selector
320 if not host: raise IOError, ('http error', 'no host given')
Tim Peters92037a12006-01-24 22:44:08 +0000321
Martin v. Löwis3e865952006-01-24 15:51:21 +0000322 if proxy_passwd:
Senthil Kumaranbcd833f2012-01-11 00:09:24 +0800323 proxy_passwd = unquote(proxy_passwd)
Andrew M. Kuchling872dba42006-10-27 17:11:23 +0000324 proxy_auth = base64.b64encode(proxy_passwd).strip()
Martin v. Löwis3e865952006-01-24 15:51:21 +0000325 else:
326 proxy_auth = None
327
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000328 if user_passwd:
Senthil Kumaranbcd833f2012-01-11 00:09:24 +0800329 user_passwd = unquote(user_passwd)
Andrew M. Kuchling872dba42006-10-27 17:11:23 +0000330 auth = base64.b64encode(user_passwd).strip()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000331 else:
332 auth = None
333 h = httplib.HTTP(host)
334 if data is not None:
335 h.putrequest('POST', selector)
Georg Brandl0619a322006-07-26 07:40:17 +0000336 h.putheader('Content-Type', 'application/x-www-form-urlencoded')
337 h.putheader('Content-Length', '%d' % len(data))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000338 else:
339 h.putrequest('GET', selector)
Martin v. Löwis3e865952006-01-24 15:51:21 +0000340 if proxy_auth: h.putheader('Proxy-Authorization', 'Basic %s' % proxy_auth)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000341 if auth: h.putheader('Authorization', 'Basic %s' % auth)
342 if realhost: h.putheader('Host', realhost)
Guido van Rossum68468eb2003-02-27 20:14:51 +0000343 for args in self.addheaders: h.putheader(*args)
Kristján Valur Jónsson84040db2009-01-09 20:27:16 +0000344 h.endheaders(data)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000345 errcode, errmsg, headers = h.getreply()
Neal Norwitzce55e212007-03-20 08:14:57 +0000346 fp = h.getfile()
Georg Brandlf66b6032007-03-14 08:27:52 +0000347 if errcode == -1:
Neal Norwitzce55e212007-03-20 08:14:57 +0000348 if fp: fp.close()
Georg Brandlf66b6032007-03-14 08:27:52 +0000349 # something went wrong with the HTTP status line
350 raise IOError, ('http protocol error', 0,
351 'got a bad status line', None)
Sean Reifscheidera1afbf62007-09-19 07:52:56 +0000352 # According to RFC 2616, "2xx" code indicates that the client's
353 # request was successfully received, understood, and accepted.
Kurt B. Kaiser0f7c25d2008-01-02 04:11:28 +0000354 if (200 <= errcode < 300):
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000355 return addinfourl(fp, headers, "http:" + url, errcode)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000356 else:
357 if data is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000358 return self.http_error(url, fp, errcode, errmsg, headers)
Guido van Rossum29aab751999-03-09 19:31:21 +0000359 else:
360 return self.http_error(url, fp, errcode, errmsg, headers, data)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000361
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000362 def http_error(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000363 """Handle http errors.
364 Derived class can override this, or provide specific handlers
365 named http_error_DDD where DDD is the 3-digit error code."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000366 # First check if there's a specific handler for this error
367 name = 'http_error_%d' % errcode
368 if hasattr(self, name):
369 method = getattr(self, name)
370 if data is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000371 result = method(url, fp, errcode, errmsg, headers)
Jeremy Hyltonb30f52a1999-02-25 16:14:58 +0000372 else:
373 result = method(url, fp, errcode, errmsg, headers, data)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000374 if result: return result
Jeremy Hyltonb30f52a1999-02-25 16:14:58 +0000375 return self.http_error_default(url, fp, errcode, errmsg, headers)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000376
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000377 def http_error_default(self, url, fp, errcode, errmsg, headers):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000378 """Default error handler: close the connection and raise IOError."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000379 fp.close()
380 raise IOError, ('http error', errcode, errmsg, headers)
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000381
Bill Janssen426ea0a2007-08-29 22:35:05 +0000382 if _have_ssl:
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000383 def open_https(self, url, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000384 """Use HTTPS protocol."""
Bill Janssen426ea0a2007-08-29 22:35:05 +0000385
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000386 import httplib
Fred Drake567ca8e2000-08-21 21:42:42 +0000387 user_passwd = None
Martin v. Löwis3e865952006-01-24 15:51:21 +0000388 proxy_passwd = None
Walter Dörwald65230a22002-06-03 15:58:32 +0000389 if isinstance(url, str):
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000390 host, selector = splithost(url)
Fred Drake567ca8e2000-08-21 21:42:42 +0000391 if host:
392 user_passwd, host = splituser(host)
393 host = unquote(host)
394 realhost = host
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000395 else:
396 host, selector = url
Martin v. Löwis3e865952006-01-24 15:51:21 +0000397 # here, we determine, whether the proxy contains authorization information
398 proxy_passwd, host = splituser(host)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000399 urltype, rest = splittype(selector)
Fred Drake567ca8e2000-08-21 21:42:42 +0000400 url = rest
401 user_passwd = None
Guido van Rossumb2493f82000-12-15 15:01:37 +0000402 if urltype.lower() != 'https':
Fred Drake567ca8e2000-08-21 21:42:42 +0000403 realhost = None
404 else:
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000405 realhost, rest = splithost(rest)
Fred Drake567ca8e2000-08-21 21:42:42 +0000406 if realhost:
407 user_passwd, realhost = splituser(realhost)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000408 if user_passwd:
409 selector = "%s://%s%s" % (urltype, realhost, rest)
Andrew M. Kuchling7ad47922000-06-10 01:41:48 +0000410 #print "proxy via https:", host, selector
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000411 if not host: raise IOError, ('https error', 'no host given')
Martin v. Löwis3e865952006-01-24 15:51:21 +0000412 if proxy_passwd:
Senthil Kumaranbcd833f2012-01-11 00:09:24 +0800413 proxy_passwd = unquote(proxy_passwd)
Andrew M. Kuchling872dba42006-10-27 17:11:23 +0000414 proxy_auth = base64.b64encode(proxy_passwd).strip()
Martin v. Löwis3e865952006-01-24 15:51:21 +0000415 else:
416 proxy_auth = None
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000417 if user_passwd:
Senthil Kumaranbcd833f2012-01-11 00:09:24 +0800418 user_passwd = unquote(user_passwd)
Andrew M. Kuchling872dba42006-10-27 17:11:23 +0000419 auth = base64.b64encode(user_passwd).strip()
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000420 else:
421 auth = None
422 h = httplib.HTTPS(host, 0,
423 key_file=self.key_file,
424 cert_file=self.cert_file)
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000425 if data is not None:
426 h.putrequest('POST', selector)
Georg Brandl0619a322006-07-26 07:40:17 +0000427 h.putheader('Content-Type',
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000428 'application/x-www-form-urlencoded')
Georg Brandl0619a322006-07-26 07:40:17 +0000429 h.putheader('Content-Length', '%d' % len(data))
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000430 else:
431 h.putrequest('GET', selector)
Andrew M. Kuchling52278572006-12-19 15:11:41 +0000432 if proxy_auth: h.putheader('Proxy-Authorization', 'Basic %s' % proxy_auth)
433 if auth: h.putheader('Authorization', 'Basic %s' % auth)
Fred Drake567ca8e2000-08-21 21:42:42 +0000434 if realhost: h.putheader('Host', realhost)
Guido van Rossum68468eb2003-02-27 20:14:51 +0000435 for args in self.addheaders: h.putheader(*args)
Kristján Valur Jónsson84040db2009-01-09 20:27:16 +0000436 h.endheaders(data)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000437 errcode, errmsg, headers = h.getreply()
Neal Norwitzce55e212007-03-20 08:14:57 +0000438 fp = h.getfile()
Georg Brandlf66b6032007-03-14 08:27:52 +0000439 if errcode == -1:
Neal Norwitzce55e212007-03-20 08:14:57 +0000440 if fp: fp.close()
Georg Brandlf66b6032007-03-14 08:27:52 +0000441 # something went wrong with the HTTP status line
442 raise IOError, ('http protocol error', 0,
443 'got a bad status line', None)
Georg Brandl9b915672007-09-24 18:08:24 +0000444 # According to RFC 2616, "2xx" code indicates that the client's
445 # request was successfully received, understood, and accepted.
Kurt B. Kaiser0f7c25d2008-01-02 04:11:28 +0000446 if (200 <= errcode < 300):
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000447 return addinfourl(fp, headers, "https:" + url, errcode)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000448 else:
Fred Drake567ca8e2000-08-21 21:42:42 +0000449 if data is None:
450 return self.http_error(url, fp, errcode, errmsg, headers)
451 else:
Guido van Rossumb2493f82000-12-15 15:01:37 +0000452 return self.http_error(url, fp, errcode, errmsg, headers,
453 data)
Fred Drake567ca8e2000-08-21 21:42:42 +0000454
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000455 def open_file(self, url):
Neal Norwitzc5d0dbd2006-04-09 04:00:49 +0000456 """Use local file or FTP depending on form of URL."""
Martin v. Löwis3e865952006-01-24 15:51:21 +0000457 if not isinstance(url, str):
458 raise IOError, ('file error', 'proxy support for file protocol currently not implemented')
Jack Jansen4ef11032002-09-12 20:14:04 +0000459 if url[:2] == '//' and url[2:3] != '/' and url[2:12].lower() != 'localhost/':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000460 return self.open_ftp(url)
461 else:
462 return self.open_local_file(url)
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000463
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000464 def open_local_file(self, url):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000465 """Use local file."""
Georg Brandl5a096e12007-01-22 19:40:21 +0000466 import mimetypes, mimetools, email.utils
Raymond Hettingera6172712004-12-31 19:15:26 +0000467 try:
468 from cStringIO import StringIO
469 except ImportError:
470 from StringIO import StringIO
Guido van Rossumf0713d32001-08-09 17:43:35 +0000471 host, file = splithost(url)
472 localname = url2pathname(file)
Guido van Rossuma2da3052002-04-15 00:25:01 +0000473 try:
474 stats = os.stat(localname)
475 except OSError, e:
476 raise IOError(e.errno, e.strerror, e.filename)
Walter Dörwald92b48b72002-03-22 17:30:38 +0000477 size = stats.st_size
Georg Brandl5a096e12007-01-22 19:40:21 +0000478 modified = email.utils.formatdate(stats.st_mtime, usegmt=True)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000479 mtype = mimetypes.guess_type(url)[0]
Raymond Hettingera6172712004-12-31 19:15:26 +0000480 headers = mimetools.Message(StringIO(
Guido van Rossumf0713d32001-08-09 17:43:35 +0000481 'Content-Type: %s\nContent-Length: %d\nLast-modified: %s\n' %
482 (mtype or 'text/plain', size, modified)))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000483 if not host:
Guido van Rossum336a2011999-06-24 15:27:36 +0000484 urlfile = file
485 if file[:1] == '/':
486 urlfile = 'file://' + file
Guido van Rossumf0713d32001-08-09 17:43:35 +0000487 return addinfourl(open(localname, 'rb'),
Guido van Rossum336a2011999-06-24 15:27:36 +0000488 headers, urlfile)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000489 host, port = splitport(host)
490 if not port \
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000491 and socket.gethostbyname(host) in (localhost(), thishost()):
Guido van Rossum336a2011999-06-24 15:27:36 +0000492 urlfile = file
493 if file[:1] == '/':
494 urlfile = 'file://' + file
Guido van Rossumf0713d32001-08-09 17:43:35 +0000495 return addinfourl(open(localname, 'rb'),
Guido van Rossum336a2011999-06-24 15:27:36 +0000496 headers, urlfile)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000497 raise IOError, ('local file error', 'not on local host')
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000498
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000499 def open_ftp(self, url):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000500 """Use FTP protocol."""
Martin v. Löwis3e865952006-01-24 15:51:21 +0000501 if not isinstance(url, str):
502 raise IOError, ('ftp error', 'proxy support for ftp protocol currently not implemented')
Raymond Hettingera6172712004-12-31 19:15:26 +0000503 import mimetypes, mimetools
504 try:
505 from cStringIO import StringIO
506 except ImportError:
507 from StringIO import StringIO
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000508 host, path = splithost(url)
509 if not host: raise IOError, ('ftp error', 'no host given')
510 host, port = splitport(host)
511 user, host = splituser(host)
512 if user: user, passwd = splitpasswd(user)
513 else: passwd = None
514 host = unquote(host)
Senthil Kumaran9fce5512010-11-20 11:24:08 +0000515 user = user or ''
516 passwd = passwd or ''
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000517 host = socket.gethostbyname(host)
518 if not port:
519 import ftplib
520 port = ftplib.FTP_PORT
521 else:
522 port = int(port)
523 path, attrs = splitattr(path)
524 path = unquote(path)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000525 dirs = path.split('/')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000526 dirs, file = dirs[:-1], dirs[-1]
527 if dirs and not dirs[0]: dirs = dirs[1:]
Guido van Rossum5e006a31999-08-18 17:40:33 +0000528 if dirs and not dirs[0]: dirs[0] = '/'
Guido van Rossumb2493f82000-12-15 15:01:37 +0000529 key = user, host, port, '/'.join(dirs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000530 # XXX thread unsafe!
531 if len(self.ftpcache) > MAXFTPCACHE:
532 # Prune the cache, rather arbitrarily
533 for k in self.ftpcache.keys():
534 if k != key:
535 v = self.ftpcache[k]
536 del self.ftpcache[k]
537 v.close()
538 try:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000539 if not key in self.ftpcache:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000540 self.ftpcache[key] = \
541 ftpwrapper(user, passwd, host, port, dirs)
542 if not file: type = 'D'
543 else: type = 'I'
544 for attr in attrs:
545 attr, value = splitvalue(attr)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000546 if attr.lower() == 'type' and \
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000547 value in ('a', 'A', 'i', 'I', 'd', 'D'):
Guido van Rossumb2493f82000-12-15 15:01:37 +0000548 type = value.upper()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000549 (fp, retrlen) = self.ftpcache[key].retrfile(file, type)
Guido van Rossum88e0b5b2001-08-23 13:38:15 +0000550 mtype = mimetypes.guess_type("ftp:" + url)[0]
551 headers = ""
552 if mtype:
553 headers += "Content-Type: %s\n" % mtype
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000554 if retrlen is not None and retrlen >= 0:
Guido van Rossum88e0b5b2001-08-23 13:38:15 +0000555 headers += "Content-Length: %d\n" % retrlen
Raymond Hettingera6172712004-12-31 19:15:26 +0000556 headers = mimetools.Message(StringIO(headers))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000557 return addinfourl(fp, headers, "ftp:" + url)
558 except ftperrors(), msg:
559 raise IOError, ('ftp error', msg), sys.exc_info()[2]
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000560
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000561 def open_data(self, url, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000562 """Use "data" URL."""
Martin v. Löwis3e865952006-01-24 15:51:21 +0000563 if not isinstance(url, str):
564 raise IOError, ('data error', 'proxy support for data protocol currently not implemented')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000565 # ignore POSTed data
566 #
567 # syntax of data URLs:
568 # dataurl := "data:" [ mediatype ] [ ";base64" ] "," data
569 # mediatype := [ type "/" subtype ] *( ";" parameter )
570 # data := *urlchar
571 # parameter := attribute "=" value
Raymond Hettingera6172712004-12-31 19:15:26 +0000572 import mimetools
573 try:
574 from cStringIO import StringIO
575 except ImportError:
576 from StringIO import StringIO
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000577 try:
Guido van Rossumb2493f82000-12-15 15:01:37 +0000578 [type, data] = url.split(',', 1)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000579 except ValueError:
580 raise IOError, ('data error', 'bad data URL')
581 if not type:
582 type = 'text/plain;charset=US-ASCII'
Guido van Rossumb2493f82000-12-15 15:01:37 +0000583 semi = type.rfind(';')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000584 if semi >= 0 and '=' not in type[semi:]:
585 encoding = type[semi+1:]
586 type = type[:semi]
587 else:
588 encoding = ''
589 msg = []
Senthil Kumaran1b7f9e52010-05-01 08:01:56 +0000590 msg.append('Date: %s'%time.strftime('%a, %d %b %Y %H:%M:%S GMT',
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000591 time.gmtime(time.time())))
592 msg.append('Content-type: %s' % type)
593 if encoding == 'base64':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000594 data = base64.decodestring(data)
595 else:
596 data = unquote(data)
Georg Brandl0619a322006-07-26 07:40:17 +0000597 msg.append('Content-Length: %d' % len(data))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000598 msg.append('')
599 msg.append(data)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000600 msg = '\n'.join(msg)
Raymond Hettingera6172712004-12-31 19:15:26 +0000601 f = StringIO(msg)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000602 headers = mimetools.Message(f, 0)
Georg Brandl1f663572005-11-26 16:50:44 +0000603 #f.fileno = None # needed for addinfourl
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000604 return addinfourl(f, headers, url)
Guido van Rossum6d4d1c21998-03-12 14:32:55 +0000605
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000606
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000607class FancyURLopener(URLopener):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000608 """Derived class with handlers for errors we can handle (perhaps)."""
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000609
Neal Norwitz60e04cd2002-06-11 13:38:51 +0000610 def __init__(self, *args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000611 URLopener.__init__(self, *args, **kwargs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000612 self.auth_cache = {}
Skip Montanaroc3e11d62001-02-15 16:56:36 +0000613 self.tries = 0
614 self.maxtries = 10
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000615
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000616 def http_error_default(self, url, fp, errcode, errmsg, headers):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000617 """Default error handling -- don't raise an exception."""
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000618 return addinfourl(fp, headers, "http:" + url, errcode)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000619
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000620 def http_error_302(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000621 """Error 302 -- relocated (temporarily)."""
Skip Montanaroc3e11d62001-02-15 16:56:36 +0000622 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 Hettinger54f02222002-06-01 14:18:47 +0000637 if 'location' in headers:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000638 newurl = headers['location']
Raymond Hettinger54f02222002-06-01 14:18:47 +0000639 elif 'uri' in headers:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000640 newurl = headers['uri']
641 else:
642 return
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000643 fp.close()
Guido van Rossum3527f591999-03-29 20:23:41 +0000644 # In case the server sent a relative URL, join with original:
Moshe Zadka5d87d472001-04-09 14:54:21 +0000645 newurl = basejoin(self.type + ":" + url, newurl)
guido@google.com60a4a902011-03-24 08:07:45 -0700646
647 # For security reasons we do not allow redirects to protocols
guido@google.com2bc23b82011-03-24 10:44:17 -0700648 # other than HTTP, HTTPS or FTP.
guido@google.com60a4a902011-03-24 08:07:45 -0700649 newurl_lower = newurl.lower()
650 if not (newurl_lower.startswith('http://') or
guido@google.com2bc23b82011-03-24 10:44:17 -0700651 newurl_lower.startswith('https://') or
652 newurl_lower.startswith('ftp://')):
guido@google.comf1509302011-03-28 13:47:01 -0700653 raise IOError('redirect error', errcode,
654 errmsg + " - Redirection to url '%s' is not allowed" %
655 newurl,
656 headers)
guido@google.com60a4a902011-03-24 08:07:45 -0700657
Guido van Rossumfa19f7c2003-05-16 01:46:51 +0000658 return self.open(newurl)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000659
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000660 def http_error_301(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000661 """Error 301 -- also relocated (permanently)."""
662 return self.http_error_302(url, fp, errcode, errmsg, headers, data)
Guido van Rossume6ad8911996-09-10 17:02:56 +0000663
Raymond Hettinger024aaa12003-04-24 15:32:12 +0000664 def http_error_303(self, url, fp, errcode, errmsg, headers, data=None):
665 """Error 303 -- also relocated (essentially identical to 302)."""
666 return self.http_error_302(url, fp, errcode, errmsg, headers, data)
667
Guido van Rossumfa19f7c2003-05-16 01:46:51 +0000668 def http_error_307(self, url, fp, errcode, errmsg, headers, data=None):
669 """Error 307 -- relocated, but turn POST into error."""
670 if data is None:
671 return self.http_error_302(url, fp, errcode, errmsg, headers, data)
672 else:
673 return self.http_error_default(url, fp, errcode, errmsg, headers)
674
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000675 def http_error_401(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000676 """Error 401 -- authentication required.
Martin v. Löwis3e865952006-01-24 15:51:21 +0000677 This function supports Basic authentication only."""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000678 if not 'www-authenticate' in headers:
Tim Peters85ba6732001-02-28 08:26:44 +0000679 URLopener.http_error_default(self, url, fp,
Fred Drakec680ae82001-10-13 18:37:07 +0000680 errcode, errmsg, headers)
Moshe Zadkae99bd172001-02-27 06:27:04 +0000681 stuff = headers['www-authenticate']
682 import re
683 match = re.match('[ \t]*([^ \t]+)[ \t]+realm="([^"]*)"', stuff)
684 if not match:
Tim Peters85ba6732001-02-28 08:26:44 +0000685 URLopener.http_error_default(self, url, fp,
Moshe Zadkae99bd172001-02-27 06:27:04 +0000686 errcode, errmsg, headers)
687 scheme, realm = match.groups()
688 if scheme.lower() != 'basic':
Tim Peters85ba6732001-02-28 08:26:44 +0000689 URLopener.http_error_default(self, url, fp,
Moshe Zadkae99bd172001-02-27 06:27:04 +0000690 errcode, errmsg, headers)
691 name = 'retry_' + self.type + '_basic_auth'
692 if data is None:
693 return getattr(self,name)(url, realm)
694 else:
695 return getattr(self,name)(url, realm, data)
Tim Peters92037a12006-01-24 22:44:08 +0000696
Martin v. Löwis3e865952006-01-24 15:51:21 +0000697 def http_error_407(self, url, fp, errcode, errmsg, headers, data=None):
698 """Error 407 -- proxy authentication required.
699 This function supports Basic authentication only."""
700 if not 'proxy-authenticate' in headers:
701 URLopener.http_error_default(self, url, fp,
702 errcode, errmsg, headers)
703 stuff = headers['proxy-authenticate']
704 import re
705 match = re.match('[ \t]*([^ \t]+)[ \t]+realm="([^"]*)"', stuff)
706 if not match:
707 URLopener.http_error_default(self, url, fp,
708 errcode, errmsg, headers)
709 scheme, realm = match.groups()
710 if scheme.lower() != 'basic':
711 URLopener.http_error_default(self, url, fp,
712 errcode, errmsg, headers)
713 name = 'retry_proxy_' + self.type + '_basic_auth'
714 if data is None:
715 return getattr(self,name)(url, realm)
716 else:
717 return getattr(self,name)(url, realm, data)
Tim Peters92037a12006-01-24 22:44:08 +0000718
Martin v. Löwis3e865952006-01-24 15:51:21 +0000719 def retry_proxy_http_basic_auth(self, url, realm, data=None):
720 host, selector = splithost(url)
721 newurl = 'http://' + host + selector
722 proxy = self.proxies['http']
723 urltype, proxyhost = splittype(proxy)
724 proxyhost, proxyselector = splithost(proxyhost)
725 i = proxyhost.find('@') + 1
726 proxyhost = proxyhost[i:]
727 user, passwd = self.get_user_passwd(proxyhost, realm, i)
728 if not (user or passwd): return None
729 proxyhost = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + proxyhost
730 self.proxies['http'] = 'http://' + proxyhost + proxyselector
731 if data is None:
732 return self.open(newurl)
733 else:
734 return self.open(newurl, data)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000735
Martin v. Löwis3e865952006-01-24 15:51:21 +0000736 def retry_proxy_https_basic_auth(self, url, realm, data=None):
737 host, selector = splithost(url)
738 newurl = 'https://' + host + selector
739 proxy = self.proxies['https']
740 urltype, proxyhost = splittype(proxy)
741 proxyhost, proxyselector = splithost(proxyhost)
742 i = proxyhost.find('@') + 1
743 proxyhost = proxyhost[i:]
744 user, passwd = self.get_user_passwd(proxyhost, realm, i)
745 if not (user or passwd): return None
746 proxyhost = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + proxyhost
747 self.proxies['https'] = 'https://' + proxyhost + proxyselector
748 if data is None:
749 return self.open(newurl)
750 else:
751 return self.open(newurl, data)
Tim Peters92037a12006-01-24 22:44:08 +0000752
Guido van Rossum3c8baed2000-02-01 23:36:55 +0000753 def retry_http_basic_auth(self, url, realm, data=None):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000754 host, selector = splithost(url)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000755 i = host.find('@') + 1
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000756 host = host[i:]
757 user, passwd = self.get_user_passwd(host, realm, i)
758 if not (user or passwd): return None
Guido van Rossumafc4f042001-01-15 18:31:13 +0000759 host = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + host
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000760 newurl = 'http://' + host + selector
Guido van Rossum3c8baed2000-02-01 23:36:55 +0000761 if data is None:
762 return self.open(newurl)
763 else:
764 return self.open(newurl, data)
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000765
Guido van Rossum3c8baed2000-02-01 23:36:55 +0000766 def retry_https_basic_auth(self, url, realm, data=None):
Tim Peterse1190062001-01-15 03:34:38 +0000767 host, selector = splithost(url)
768 i = host.find('@') + 1
769 host = host[i:]
770 user, passwd = self.get_user_passwd(host, realm, i)
771 if not (user or passwd): return None
Guido van Rossumafc4f042001-01-15 18:31:13 +0000772 host = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + host
Martin v. Löwis3e865952006-01-24 15:51:21 +0000773 newurl = 'https://' + host + selector
774 if data is None:
775 return self.open(newurl)
776 else:
777 return self.open(newurl, data)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000778
Florent Xiclunae127e242010-05-17 10:39:07 +0000779 def get_user_passwd(self, host, realm, clear_cache=0):
Guido van Rossumb2493f82000-12-15 15:01:37 +0000780 key = realm + '@' + host.lower()
Raymond Hettinger54f02222002-06-01 14:18:47 +0000781 if key in self.auth_cache:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000782 if clear_cache:
783 del self.auth_cache[key]
784 else:
785 return self.auth_cache[key]
786 user, passwd = self.prompt_user_passwd(host, realm)
787 if user or passwd: self.auth_cache[key] = (user, passwd)
788 return user, passwd
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000789
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000790 def prompt_user_passwd(self, host, realm):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000791 """Override this in a GUI environment!"""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000792 import getpass
793 try:
794 user = raw_input("Enter username for %s at %s: " % (realm,
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000795 host))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000796 passwd = getpass.getpass("Enter password for %s in %s at %s: " %
797 (user, realm, host))
798 return user, passwd
799 except KeyboardInterrupt:
800 print
801 return None, None
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000802
803
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000804# Utility functions
805
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000806_localhost = None
807def localhost():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000808 """Return the IP address of the magic hostname 'localhost'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000809 global _localhost
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000810 if _localhost is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000811 _localhost = socket.gethostbyname('localhost')
812 return _localhost
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000813
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000814_thishost = None
815def thishost():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000816 """Return the IP address of the current host."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000817 global _thishost
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000818 if _thishost is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000819 _thishost = socket.gethostbyname(socket.gethostname())
820 return _thishost
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000821
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000822_ftperrors = None
823def ftperrors():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000824 """Return the set of errors raised by the FTP class."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000825 global _ftperrors
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000826 if _ftperrors is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000827 import ftplib
828 _ftperrors = ftplib.all_errors
829 return _ftperrors
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000830
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000831_noheaders = None
832def noheaders():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000833 """Return an empty mimetools.Message object."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000834 global _noheaders
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000835 if _noheaders is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000836 import mimetools
Raymond Hettingera6172712004-12-31 19:15:26 +0000837 try:
838 from cStringIO import StringIO
839 except ImportError:
840 from StringIO import StringIO
841 _noheaders = mimetools.Message(StringIO(), 0)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000842 _noheaders.fp.close() # Recycle file descriptor
843 return _noheaders
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000844
845
846# Utility classes
847
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000848class ftpwrapper:
Guido van Rossume7b146f2000-02-04 15:28:42 +0000849 """Class used by open_ftp() for cache of open FTP connections."""
850
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000851 def __init__(self, user, passwd, host, port, dirs,
Nadeem Vawdab42c53e2011-07-23 15:51:16 +0200852 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
Nadeem Vawdaa620fac2011-07-23 17:04:42 +0200853 persistent=True):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000854 self.user = user
855 self.passwd = passwd
856 self.host = host
857 self.port = port
858 self.dirs = dirs
Facundo Batista711a54e2007-05-24 17:50:54 +0000859 self.timeout = timeout
Nadeem Vawdab42c53e2011-07-23 15:51:16 +0200860 self.refcount = 0
861 self.keepalive = persistent
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000862 self.init()
Guido van Rossume7b146f2000-02-04 15:28:42 +0000863
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000864 def init(self):
865 import ftplib
866 self.busy = 0
867 self.ftp = ftplib.FTP()
Facundo Batista711a54e2007-05-24 17:50:54 +0000868 self.ftp.connect(self.host, self.port, self.timeout)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000869 self.ftp.login(self.user, self.passwd)
870 for dir in self.dirs:
871 self.ftp.cwd(dir)
Guido van Rossume7b146f2000-02-04 15:28:42 +0000872
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000873 def retrfile(self, file, type):
874 import ftplib
875 self.endtransfer()
876 if type in ('d', 'D'): cmd = 'TYPE A'; isdir = 1
877 else: cmd = 'TYPE ' + type; isdir = 0
878 try:
879 self.ftp.voidcmd(cmd)
880 except ftplib.all_errors:
881 self.init()
882 self.ftp.voidcmd(cmd)
883 conn = None
884 if file and not isdir:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000885 # Try to retrieve as a file
886 try:
887 cmd = 'RETR ' + file
Nadeem Vawdab42c53e2011-07-23 15:51:16 +0200888 conn, retrlen = self.ftp.ntransfercmd(cmd)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000889 except ftplib.error_perm, reason:
Guido van Rossumb2493f82000-12-15 15:01:37 +0000890 if str(reason)[:3] != '550':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000891 raise IOError, ('ftp error', reason), sys.exc_info()[2]
892 if not conn:
893 # Set transfer mode to ASCII!
894 self.ftp.voidcmd('TYPE A')
Georg Brandld5e6cf22008-01-20 12:18:17 +0000895 # Try a directory listing. Verify that directory exists.
896 if file:
897 pwd = self.ftp.pwd()
898 try:
899 try:
900 self.ftp.cwd(file)
901 except ftplib.error_perm, reason:
902 raise IOError, ('ftp error', reason), sys.exc_info()[2]
903 finally:
904 self.ftp.cwd(pwd)
905 cmd = 'LIST ' + file
906 else:
907 cmd = 'LIST'
Nadeem Vawdab42c53e2011-07-23 15:51:16 +0200908 conn, retrlen = self.ftp.ntransfercmd(cmd)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000909 self.busy = 1
Nadeem Vawdab42c53e2011-07-23 15:51:16 +0200910 ftpobj = addclosehook(conn.makefile('rb'), self.file_close)
911 self.refcount += 1
912 conn.close()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000913 # Pass back both a suitably decorated object and a retrieval length
Nadeem Vawdab42c53e2011-07-23 15:51:16 +0200914 return (ftpobj, retrlen)
915
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000916 def endtransfer(self):
917 if not self.busy:
918 return
919 self.busy = 0
920 try:
921 self.ftp.voidresp()
922 except ftperrors():
923 pass
Guido van Rossume7b146f2000-02-04 15:28:42 +0000924
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000925 def close(self):
Nadeem Vawdab42c53e2011-07-23 15:51:16 +0200926 self.keepalive = False
927 if self.refcount <= 0:
928 self.real_close()
929
930 def file_close(self):
931 self.endtransfer()
932 self.refcount -= 1
933 if self.refcount <= 0 and not self.keepalive:
934 self.real_close()
935
936 def real_close(self):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000937 self.endtransfer()
938 try:
939 self.ftp.close()
940 except ftperrors():
941 pass
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000942
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000943class addbase:
Guido van Rossume7b146f2000-02-04 15:28:42 +0000944 """Base class for addinfo and addclosehook."""
945
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000946 def __init__(self, fp):
947 self.fp = fp
948 self.read = self.fp.read
949 self.readline = self.fp.readline
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000950 if hasattr(self.fp, "readlines"): self.readlines = self.fp.readlines
Georg Brandl1f663572005-11-26 16:50:44 +0000951 if hasattr(self.fp, "fileno"):
952 self.fileno = self.fp.fileno
953 else:
954 self.fileno = lambda: None
Raymond Hettinger42182eb2003-03-09 05:33:33 +0000955 if hasattr(self.fp, "__iter__"):
956 self.__iter__ = self.fp.__iter__
957 if hasattr(self.fp, "next"):
958 self.next = self.fp.next
Guido van Rossume7b146f2000-02-04 15:28:42 +0000959
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000960 def __repr__(self):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000961 return '<%s at %r whose fp = %r>' % (self.__class__.__name__,
962 id(self), self.fp)
Guido van Rossume7b146f2000-02-04 15:28:42 +0000963
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000964 def close(self):
965 self.read = None
966 self.readline = None
967 self.readlines = None
968 self.fileno = None
969 if self.fp: self.fp.close()
970 self.fp = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000971
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000972class addclosehook(addbase):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000973 """Class to add a close hook to an open file."""
974
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000975 def __init__(self, fp, closehook, *hookargs):
976 addbase.__init__(self, fp)
977 self.closehook = closehook
978 self.hookargs = hookargs
Guido van Rossume7b146f2000-02-04 15:28:42 +0000979
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000980 def close(self):
Guido van Rossumc580dae2000-05-24 13:21:46 +0000981 addbase.close(self)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000982 if self.closehook:
Guido van Rossum68468eb2003-02-27 20:14:51 +0000983 self.closehook(*self.hookargs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000984 self.closehook = None
985 self.hookargs = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000986
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000987class addinfo(addbase):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000988 """class to add an info() method to an open file."""
989
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000990 def __init__(self, fp, headers):
991 addbase.__init__(self, fp)
992 self.headers = headers
Guido van Rossume7b146f2000-02-04 15:28:42 +0000993
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000994 def info(self):
995 return self.headers
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000996
Guido van Rossume6ad8911996-09-10 17:02:56 +0000997class addinfourl(addbase):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000998 """class to add info() and geturl() methods to an open file."""
999
Georg Brandl9b0d46d2008-01-20 11:43:03 +00001000 def __init__(self, fp, headers, url, code=None):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001001 addbase.__init__(self, fp)
1002 self.headers = headers
1003 self.url = url
Georg Brandl9b0d46d2008-01-20 11:43:03 +00001004 self.code = code
Guido van Rossume7b146f2000-02-04 15:28:42 +00001005
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001006 def info(self):
1007 return self.headers
Guido van Rossume7b146f2000-02-04 15:28:42 +00001008
Georg Brandl9b0d46d2008-01-20 11:43:03 +00001009 def getcode(self):
1010 return self.code
1011
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001012 def geturl(self):
1013 return self.url
Guido van Rossume6ad8911996-09-10 17:02:56 +00001014
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001015
Guido van Rossum7c395db1994-07-04 22:14:49 +00001016# Utilities to parse URLs (most of these return None for missing parts):
Sjoerd Mullendere0371b81995-11-10 10:36:07 +00001017# unwrap('<URL:type://host/path>') --> 'type://host/path'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001018# splittype('type:opaquestring') --> 'type', 'opaquestring'
1019# splithost('//host[:port]/path') --> 'host[:port]', '/path'
Guido van Rossum7c395db1994-07-04 22:14:49 +00001020# splituser('user[:passwd]@host[:port]') --> 'user[:passwd]', 'host[:port]'
1021# splitpasswd('user:passwd') -> 'user', 'passwd'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001022# splitport('host:port') --> 'host', 'port'
1023# splitquery('/path?query') --> '/path', 'query'
1024# splittag('/path#tag') --> '/path', 'tag'
Guido van Rossum7c395db1994-07-04 22:14:49 +00001025# splitattr('/path;attr1=value1;attr2=value2;...') ->
1026# '/path', ['attr1=value1', 'attr2=value2', ...]
1027# splitvalue('attr=value') --> 'attr', 'value'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001028# unquote('abc%20def') -> 'abc def'
1029# quote('abc def') -> 'abc%20def')
1030
Walter Dörwald65230a22002-06-03 15:58:32 +00001031try:
1032 unicode
1033except NameError:
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001034 def _is_unicode(x):
1035 return 0
Walter Dörwald65230a22002-06-03 15:58:32 +00001036else:
1037 def _is_unicode(x):
1038 return isinstance(x, unicode)
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001039
Martin v. Löwis1d994332000-12-03 18:30:10 +00001040def toBytes(url):
1041 """toBytes(u"URL") --> 'URL'."""
1042 # Most URL schemes require ASCII. If that changes, the conversion
1043 # can be relaxed
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001044 if _is_unicode(url):
Martin v. Löwis1d994332000-12-03 18:30:10 +00001045 try:
1046 url = url.encode("ASCII")
1047 except UnicodeError:
Guido van Rossumb2493f82000-12-15 15:01:37 +00001048 raise UnicodeError("URL " + repr(url) +
1049 " contains non-ASCII characters")
Martin v. Löwis1d994332000-12-03 18:30:10 +00001050 return url
1051
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001052def unwrap(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001053 """unwrap('<URL:type://host/path>') --> 'type://host/path'."""
Guido van Rossumb2493f82000-12-15 15:01:37 +00001054 url = url.strip()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001055 if url[:1] == '<' and url[-1:] == '>':
Guido van Rossumb2493f82000-12-15 15:01:37 +00001056 url = url[1:-1].strip()
1057 if url[:4] == 'URL:': url = url[4:].strip()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001058 return url
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001059
Guido van Rossum332e1441997-09-29 23:23:46 +00001060_typeprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001061def splittype(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001062 """splittype('type:opaquestring') --> 'type', 'opaquestring'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001063 global _typeprog
1064 if _typeprog is None:
1065 import re
1066 _typeprog = re.compile('^([^/:]+):')
Guido van Rossum332e1441997-09-29 23:23:46 +00001067
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001068 match = _typeprog.match(url)
1069 if match:
1070 scheme = match.group(1)
Fred Drake9e94afd2000-07-01 07:03:30 +00001071 return scheme.lower(), url[len(scheme) + 1:]
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001072 return None, url
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001073
Guido van Rossum332e1441997-09-29 23:23:46 +00001074_hostprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001075def splithost(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001076 """splithost('//host[:port]/path') --> 'host[:port]', '/path'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001077 global _hostprog
1078 if _hostprog is None:
1079 import re
Georg Brandl1c168d82006-03-26 20:59:38 +00001080 _hostprog = re.compile('^//([^/?]*)(.*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001081
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001082 match = _hostprog.match(url)
Senthil Kumaran0b7cac12010-11-22 05:04:33 +00001083 if match:
1084 host_port = match.group(1)
1085 path = match.group(2)
1086 if path and not path.startswith('/'):
1087 path = '/' + path
1088 return host_port, path
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001089 return None, url
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001090
Guido van Rossum332e1441997-09-29 23:23:46 +00001091_userprog = None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001092def splituser(host):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001093 """splituser('user[:passwd]@host[:port]') --> 'user[:passwd]', 'host[:port]'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001094 global _userprog
1095 if _userprog is None:
1096 import re
Raymond Hettingerf2e45dd2002-08-18 20:08:56 +00001097 _userprog = re.compile('^(.*)@(.*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001098
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001099 match = _userprog.match(host)
Senthil Kumaran9fce5512010-11-20 11:24:08 +00001100 if match: return match.group(1, 2)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001101 return None, host
Guido van Rossum7c395db1994-07-04 22:14:49 +00001102
Guido van Rossum332e1441997-09-29 23:23:46 +00001103_passwdprog = None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001104def splitpasswd(user):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001105 """splitpasswd('user:passwd') -> 'user', 'passwd'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001106 global _passwdprog
1107 if _passwdprog is None:
1108 import re
Senthil Kumaran5e95e762009-03-30 21:51:50 +00001109 _passwdprog = re.compile('^([^:]*):(.*)$',re.S)
Guido van Rossum332e1441997-09-29 23:23:46 +00001110
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001111 match = _passwdprog.match(user)
1112 if match: return match.group(1, 2)
1113 return user, None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001114
Guido van Rossume7b146f2000-02-04 15:28:42 +00001115# splittag('/path#tag') --> '/path', 'tag'
Guido van Rossum332e1441997-09-29 23:23:46 +00001116_portprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001117def splitport(host):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001118 """splitport('host:port') --> 'host', 'port'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001119 global _portprog
1120 if _portprog is None:
1121 import re
1122 _portprog = re.compile('^(.*):([0-9]+)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001123
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001124 match = _portprog.match(host)
1125 if match: return match.group(1, 2)
1126 return host, None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001127
Guido van Rossum332e1441997-09-29 23:23:46 +00001128_nportprog = None
Guido van Rossum53725a21996-06-13 19:12:35 +00001129def splitnport(host, defport=-1):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001130 """Split host and port, returning numeric port.
1131 Return given default port if no ':' found; defaults to -1.
1132 Return numerical port if a valid number are found after ':'.
1133 Return None if ':' but not a valid number."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001134 global _nportprog
1135 if _nportprog is None:
1136 import re
1137 _nportprog = re.compile('^(.*):(.*)$')
Guido van Rossum7e7ca0b1998-03-26 21:01:39 +00001138
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001139 match = _nportprog.match(host)
1140 if match:
1141 host, port = match.group(1, 2)
1142 try:
Guido van Rossumb2493f82000-12-15 15:01:37 +00001143 if not port: raise ValueError, "no digits"
1144 nport = int(port)
1145 except ValueError:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001146 nport = None
1147 return host, nport
1148 return host, defport
Guido van Rossum53725a21996-06-13 19:12:35 +00001149
Guido van Rossum332e1441997-09-29 23:23:46 +00001150_queryprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001151def splitquery(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001152 """splitquery('/path?query') --> '/path', 'query'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001153 global _queryprog
1154 if _queryprog is None:
1155 import re
1156 _queryprog = re.compile('^(.*)\?([^?]*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001157
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001158 match = _queryprog.match(url)
1159 if match: return match.group(1, 2)
1160 return url, None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001161
Guido van Rossum332e1441997-09-29 23:23:46 +00001162_tagprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001163def splittag(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001164 """splittag('/path#tag') --> '/path', 'tag'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001165 global _tagprog
1166 if _tagprog is None:
1167 import re
1168 _tagprog = re.compile('^(.*)#([^#]*)$')
Guido van Rossum7e7ca0b1998-03-26 21:01:39 +00001169
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001170 match = _tagprog.match(url)
1171 if match: return match.group(1, 2)
1172 return url, None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001173
Guido van Rossum7c395db1994-07-04 22:14:49 +00001174def splitattr(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001175 """splitattr('/path;attr1=value1;attr2=value2;...') ->
1176 '/path', ['attr1=value1', 'attr2=value2', ...]."""
Guido van Rossumb2493f82000-12-15 15:01:37 +00001177 words = url.split(';')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001178 return words[0], words[1:]
Guido van Rossum7c395db1994-07-04 22:14:49 +00001179
Guido van Rossum332e1441997-09-29 23:23:46 +00001180_valueprog = None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001181def splitvalue(attr):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001182 """splitvalue('attr=value') --> 'attr', 'value'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001183 global _valueprog
1184 if _valueprog is None:
1185 import re
1186 _valueprog = re.compile('^([^=]*)=(.*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001187
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001188 match = _valueprog.match(attr)
1189 if match: return match.group(1, 2)
1190 return attr, None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001191
R. David Murraybfbdefe2010-05-25 15:20:46 +00001192# urlparse contains a duplicate of this method to avoid a circular import. If
1193# you update this method, also update the copy in urlparse. This code
1194# duplication does not exist in Python3.
1195
Senthil Kumaranf3e9b2a2010-03-18 12:14:15 +00001196_hexdig = '0123456789ABCDEFabcdef'
Florent Xiclunae127e242010-05-17 10:39:07 +00001197_hextochr = dict((a + b, chr(int(a + b, 16)))
1198 for a in _hexdig for b in _hexdig)
Raymond Hettinger803ce802005-09-10 06:49:04 +00001199
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001200def unquote(s):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001201 """unquote('abc%20def') -> 'abc def'."""
Raymond Hettinger803ce802005-09-10 06:49:04 +00001202 res = s.split('%')
Florent Xiclunaaf87f9f2010-05-17 13:35:09 +00001203 # fastpath
1204 if len(res) == 1:
1205 return s
1206 s = res[0]
1207 for item in res[1:]:
Raymond Hettinger803ce802005-09-10 06:49:04 +00001208 try:
Florent Xiclunaaf87f9f2010-05-17 13:35:09 +00001209 s += _hextochr[item[:2]] + item[2:]
Raymond Hettinger803ce802005-09-10 06:49:04 +00001210 except KeyError:
Florent Xiclunaaf87f9f2010-05-17 13:35:09 +00001211 s += '%' + item
Raymond Hettinger4b0f20d2005-10-15 16:41:53 +00001212 except UnicodeDecodeError:
Florent Xiclunaaf87f9f2010-05-17 13:35:09 +00001213 s += unichr(int(item[:2], 16)) + item[2:]
1214 return s
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001215
Guido van Rossum0564e121996-12-13 14:47:36 +00001216def unquote_plus(s):
Skip Montanaro79f1c172000-08-22 03:00:52 +00001217 """unquote('%7e/abc+def') -> '~/abc def'"""
Brett Cannonaaeffaf2004-03-23 23:50:17 +00001218 s = s.replace('+', ' ')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001219 return unquote(s)
Guido van Rossum0564e121996-12-13 14:47:36 +00001220
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001221always_safe = ('ABCDEFGHIJKLMNOPQRSTUVWXYZ'
Jeremy Hylton6102e292000-08-31 15:48:10 +00001222 'abcdefghijklmnopqrstuvwxyz'
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001223 '0123456789' '_.-')
Florent Xiclunaaf87f9f2010-05-17 13:35:09 +00001224_safe_map = {}
1225for i, c in zip(xrange(256), str(bytearray(xrange(256)))):
1226 _safe_map[c] = c if (i < 128 and c in always_safe) else '%{:02X}'.format(i)
1227_safe_quoters = {}
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001228
Senthil Kumaran880685f2010-07-22 01:47:30 +00001229def quote(s, safe='/'):
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001230 """quote('abc def') -> 'abc%20def'
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001231
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001232 Each part of a URL, e.g. the path info, the query, etc., has a
1233 different set of reserved characters that must be quoted.
1234
1235 RFC 2396 Uniform Resource Identifiers (URI): Generic Syntax lists
1236 the following reserved characters.
1237
1238 reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
1239 "$" | ","
1240
1241 Each of these characters is reserved in some component of a URL,
1242 but not necessarily in all of them.
1243
1244 By default, the quote function is intended for quoting the path
1245 section of a URL. Thus, it will not encode '/'. This character
1246 is reserved, but in typical usage the quote function is being
1247 called on a path where the existing slash characters are used as
1248 reserved characters.
1249 """
Florent Xiclunaaf87f9f2010-05-17 13:35:09 +00001250 # fastpath
1251 if not s:
Senthil Kumaranc7743aa2010-07-19 17:35:50 +00001252 if s is None:
1253 raise TypeError('None object cannot be quoted')
Florent Xiclunaaf87f9f2010-05-17 13:35:09 +00001254 return s
Raymond Hettinger199d2f72005-09-09 22:27:13 +00001255 cachekey = (safe, always_safe)
1256 try:
Florent Xiclunaaf87f9f2010-05-17 13:35:09 +00001257 (quoter, safe) = _safe_quoters[cachekey]
Raymond Hettinger199d2f72005-09-09 22:27:13 +00001258 except KeyError:
Florent Xiclunaaf87f9f2010-05-17 13:35:09 +00001259 safe_map = _safe_map.copy()
1260 safe_map.update([(c, c) for c in safe])
1261 quoter = safe_map.__getitem__
1262 safe = always_safe + safe
1263 _safe_quoters[cachekey] = (quoter, safe)
1264 if not s.rstrip(safe):
1265 return s
1266 return ''.join(map(quoter, s))
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001267
Senthil Kumaran880685f2010-07-22 01:47:30 +00001268def quote_plus(s, safe=''):
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001269 """Quote the query fragment of a URL; replacing ' ' with '+'"""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001270 if ' ' in s:
Senthil Kumaran880685f2010-07-22 01:47:30 +00001271 s = quote(s, safe + ' ')
Raymond Hettingercf6b6322005-09-10 18:17:54 +00001272 return s.replace(' ', '+')
Senthil Kumaran880685f2010-07-22 01:47:30 +00001273 return quote(s, safe)
Guido van Rossum0564e121996-12-13 14:47:36 +00001274
Florent Xiclunae127e242010-05-17 10:39:07 +00001275def urlencode(query, doseq=0):
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001276 """Encode a sequence of two-element tuples or dictionary into a URL query string.
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001277
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001278 If any values in the query arg are sequences and doseq is true, each
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001279 sequence element is converted to a separate parameter.
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001280
1281 If the query arg is a sequence of two-element tuples, the order of the
1282 parameters in the output will match the order of parameters in the
1283 input.
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001284 """
Tim Peters658cba62001-02-09 20:06:00 +00001285
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001286 if hasattr(query,"items"):
1287 # mapping objects
1288 query = query.items()
1289 else:
1290 # it's a bother at times that strings and string-like objects are
1291 # sequences...
1292 try:
1293 # non-sequence items should not work with len()
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001294 # non-empty strings will fail this
Walter Dörwald65230a22002-06-03 15:58:32 +00001295 if len(query) and not isinstance(query[0], tuple):
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001296 raise TypeError
1297 # zero-length sequences of all types will get here and succeed,
1298 # but that's a minor nit - since the original implementation
1299 # allowed empty dicts that type of behavior probably should be
1300 # preserved for consistency
1301 except TypeError:
1302 ty,va,tb = sys.exc_info()
1303 raise TypeError, "not a valid non-string sequence or mapping object", tb
1304
Guido van Rossume7b146f2000-02-04 15:28:42 +00001305 l = []
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001306 if not doseq:
1307 # preserve old behavior
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001308 for k, v in query:
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001309 k = quote_plus(str(k))
1310 v = quote_plus(str(v))
1311 l.append(k + '=' + v)
1312 else:
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001313 for k, v in query:
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001314 k = quote_plus(str(k))
Walter Dörwald65230a22002-06-03 15:58:32 +00001315 if isinstance(v, str):
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001316 v = quote_plus(v)
1317 l.append(k + '=' + v)
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001318 elif _is_unicode(v):
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001319 # is there a reasonable way to convert to ASCII?
1320 # encode generates a string, but "replace" or "ignore"
1321 # lose information and "strict" can raise UnicodeError
1322 v = quote_plus(v.encode("ASCII","replace"))
1323 l.append(k + '=' + v)
1324 else:
1325 try:
1326 # is this a sufficient test for sequence-ness?
Georg Brandl84fedf72010-02-06 22:59:15 +00001327 len(v)
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001328 except TypeError:
1329 # not a sequence
1330 v = quote_plus(str(v))
1331 l.append(k + '=' + v)
1332 else:
1333 # loop over the sequence
1334 for elt in v:
1335 l.append(k + '=' + quote_plus(str(elt)))
Guido van Rossumb2493f82000-12-15 15:01:37 +00001336 return '&'.join(l)
Guido van Rossum810a3391998-07-22 21:33:23 +00001337
Guido van Rossum442e7201996-03-20 15:33:11 +00001338# Proxy handling
Mark Hammond4f570b92000-07-26 07:04:38 +00001339def getproxies_environment():
1340 """Return a dictionary of scheme -> proxy server URL mappings.
1341
1342 Scan the environment for variables named <scheme>_proxy;
1343 this seems to be the standard convention. If you need a
1344 different way, you can pass a proxies dictionary to the
1345 [Fancy]URLopener constructor.
1346
1347 """
1348 proxies = {}
1349 for name, value in os.environ.items():
Guido van Rossumb2493f82000-12-15 15:01:37 +00001350 name = name.lower()
Mark Hammond4f570b92000-07-26 07:04:38 +00001351 if value and name[-6:] == '_proxy':
1352 proxies[name[:-6]] = value
1353 return proxies
1354
Georg Brandl22350112008-01-20 12:05:43 +00001355def proxy_bypass_environment(host):
1356 """Test if proxies should not be used for a particular host.
1357
1358 Checks the environment for a variable named no_proxy, which should
1359 be a list of DNS suffixes separated by commas, or '*' for all hosts.
1360 """
1361 no_proxy = os.environ.get('no_proxy', '') or os.environ.get('NO_PROXY', '')
1362 # '*' is special case for always bypass
1363 if no_proxy == '*':
1364 return 1
1365 # strip port off host
1366 hostonly, port = splitport(host)
1367 # check if the host ends with any of the DNS suffixes
Senthil Kumaranb5bd4c82011-08-06 12:24:33 +08001368 no_proxy_list = [proxy.strip() for proxy in no_proxy.split(',')]
1369 for name in no_proxy_list:
Georg Brandl22350112008-01-20 12:05:43 +00001370 if name and (hostonly.endswith(name) or host.endswith(name)):
1371 return 1
1372 # otherwise, don't bypass
1373 return 0
1374
1375
Jack Jansen11d9b062004-07-16 11:45:00 +00001376if sys.platform == 'darwin':
Ronald Oussoren51f06332009-09-20 10:31:22 +00001377 from _scproxy import _get_proxy_settings, _get_proxies
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001378
1379 def proxy_bypass_macosx_sysconf(host):
1380 """
1381 Return True iff this host shouldn't be accessed using a proxy
1382
1383 This function uses the MacOSX framework SystemConfiguration
1384 to fetch the proxy information.
1385 """
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001386 import re
1387 import socket
1388 from fnmatch import fnmatch
1389
Ronald Oussoren31802d02009-10-18 07:07:00 +00001390 hostonly, port = splitport(host)
1391
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001392 def ip2num(ipAddr):
1393 parts = ipAddr.split('.')
1394 parts = map(int, parts)
1395 if len(parts) != 4:
1396 parts = (parts + [0, 0, 0, 0])[:4]
1397 return (parts[0] << 24) | (parts[1] << 16) | (parts[2] << 8) | parts[3]
1398
Ronald Oussoren51f06332009-09-20 10:31:22 +00001399 proxy_settings = _get_proxy_settings()
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001400
Ronald Oussoren51f06332009-09-20 10:31:22 +00001401 # Check for simple host names:
1402 if '.' not in host:
1403 if proxy_settings['exclude_simple']:
1404 return True
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001405
Ronald Oussoren31802d02009-10-18 07:07:00 +00001406 hostIP = None
1407
Ronald Oussoren809073b2009-09-20 10:54:07 +00001408 for value in proxy_settings.get('exceptions', ()):
Ronald Oussoren51f06332009-09-20 10:31:22 +00001409 # Items in the list are strings like these: *.local, 169.254/16
Ronald Oussoren51f06332009-09-20 10:31:22 +00001410 if not value: continue
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001411
Ronald Oussoren51f06332009-09-20 10:31:22 +00001412 m = re.match(r"(\d+(?:\.\d+)*)(/\d+)?", value)
1413 if m is not None:
1414 if hostIP is None:
Ronald Oussoren31802d02009-10-18 07:07:00 +00001415 try:
1416 hostIP = socket.gethostbyname(hostonly)
1417 hostIP = ip2num(hostIP)
1418 except socket.error:
1419 continue
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001420
Ronald Oussoren51f06332009-09-20 10:31:22 +00001421 base = ip2num(m.group(1))
Ronald Oussorenb96fbb82010-06-27 13:59:39 +00001422 mask = m.group(2)
1423 if mask is None:
1424 mask = 8 * (m.group(1).count('.') + 1)
1425
1426 else:
1427 mask = int(mask[1:])
Ronald Oussoren1aa999c2011-03-14 18:53:59 -04001428 mask = 32 - mask
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001429
Ronald Oussoren51f06332009-09-20 10:31:22 +00001430 if (hostIP >> mask) == (base >> mask):
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001431 return True
1432
Ronald Oussoren51f06332009-09-20 10:31:22 +00001433 elif fnmatch(host, value):
1434 return True
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001435
Ronald Oussoren51f06332009-09-20 10:31:22 +00001436 return False
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001437
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001438 def getproxies_macosx_sysconf():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001439 """Return a dictionary of scheme -> proxy server URL mappings.
Guido van Rossum442e7201996-03-20 15:33:11 +00001440
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001441 This function uses the MacOSX framework SystemConfiguration
1442 to fetch the proxy information.
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001443 """
Ronald Oussoren51f06332009-09-20 10:31:22 +00001444 return _get_proxies()
Mark Hammond4f570b92000-07-26 07:04:38 +00001445
Georg Brandl22350112008-01-20 12:05:43 +00001446 def proxy_bypass(host):
1447 if getproxies_environment():
1448 return proxy_bypass_environment(host)
1449 else:
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001450 return proxy_bypass_macosx_sysconf(host)
Tim Peters55c12d42001-08-09 18:04:14 +00001451
Jack Jansen11d9b062004-07-16 11:45:00 +00001452 def getproxies():
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001453 return getproxies_environment() or getproxies_macosx_sysconf()
Tim Peters182b5ac2004-07-18 06:16:08 +00001454
Mark Hammond4f570b92000-07-26 07:04:38 +00001455elif os.name == 'nt':
1456 def getproxies_registry():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001457 """Return a dictionary of scheme -> proxy server URL mappings.
Mark Hammond4f570b92000-07-26 07:04:38 +00001458
1459 Win32 uses the registry to store proxies.
1460
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001461 """
1462 proxies = {}
Mark Hammond4f570b92000-07-26 07:04:38 +00001463 try:
1464 import _winreg
1465 except ImportError:
1466 # Std module, so should be around - but you never know!
1467 return proxies
1468 try:
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001469 internetSettings = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER,
1470 r'Software\Microsoft\Windows\CurrentVersion\Internet Settings')
Mark Hammond4f570b92000-07-26 07:04:38 +00001471 proxyEnable = _winreg.QueryValueEx(internetSettings,
1472 'ProxyEnable')[0]
1473 if proxyEnable:
1474 # Returned as Unicode but problems if not converted to ASCII
1475 proxyServer = str(_winreg.QueryValueEx(internetSettings,
1476 'ProxyServer')[0])
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001477 if '=' in proxyServer:
1478 # Per-protocol settings
Mark Hammond4f570b92000-07-26 07:04:38 +00001479 for p in proxyServer.split(';'):
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001480 protocol, address = p.split('=', 1)
Guido van Rossumb955d6c2002-03-31 23:38:48 +00001481 # See if address has a type:// prefix
Guido van Rossum64e5aa92002-04-02 14:38:16 +00001482 import re
1483 if not re.match('^([^/:]+)://', address):
Guido van Rossumb955d6c2002-03-31 23:38:48 +00001484 address = '%s://%s' % (protocol, address)
1485 proxies[protocol] = address
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001486 else:
1487 # Use one setting for all protocols
1488 if proxyServer[:5] == 'http:':
1489 proxies['http'] = proxyServer
1490 else:
1491 proxies['http'] = 'http://%s' % proxyServer
Senthil Kumaran0fdd3852010-07-14 20:22:17 +00001492 proxies['https'] = 'https://%s' % proxyServer
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001493 proxies['ftp'] = 'ftp://%s' % proxyServer
Mark Hammond4f570b92000-07-26 07:04:38 +00001494 internetSettings.Close()
1495 except (WindowsError, ValueError, TypeError):
1496 # Either registry key not found etc, or the value in an
1497 # unexpected format.
1498 # proxies already set up to be empty so nothing to do
1499 pass
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001500 return proxies
Guido van Rossum442e7201996-03-20 15:33:11 +00001501
Mark Hammond4f570b92000-07-26 07:04:38 +00001502 def getproxies():
1503 """Return a dictionary of scheme -> proxy server URL mappings.
1504
1505 Returns settings gathered from the environment, if specified,
1506 or the registry.
1507
1508 """
1509 return getproxies_environment() or getproxies_registry()
Tim Peters55c12d42001-08-09 18:04:14 +00001510
Georg Brandl22350112008-01-20 12:05:43 +00001511 def proxy_bypass_registry(host):
Tim Peters55c12d42001-08-09 18:04:14 +00001512 try:
1513 import _winreg
1514 import re
Tim Peters55c12d42001-08-09 18:04:14 +00001515 except ImportError:
1516 # Std modules, so should be around - but you never know!
1517 return 0
1518 try:
1519 internetSettings = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER,
1520 r'Software\Microsoft\Windows\CurrentVersion\Internet Settings')
1521 proxyEnable = _winreg.QueryValueEx(internetSettings,
1522 'ProxyEnable')[0]
1523 proxyOverride = str(_winreg.QueryValueEx(internetSettings,
1524 'ProxyOverride')[0])
1525 # ^^^^ Returned as Unicode but problems if not converted to ASCII
1526 except WindowsError:
1527 return 0
1528 if not proxyEnable or not proxyOverride:
1529 return 0
1530 # try to make a host list from name and IP address.
Georg Brandl1f636702006-02-18 23:10:23 +00001531 rawHost, port = splitport(host)
1532 host = [rawHost]
Tim Peters55c12d42001-08-09 18:04:14 +00001533 try:
Georg Brandl1f636702006-02-18 23:10:23 +00001534 addr = socket.gethostbyname(rawHost)
1535 if addr != rawHost:
Tim Peters55c12d42001-08-09 18:04:14 +00001536 host.append(addr)
1537 except socket.error:
1538 pass
Georg Brandl1f636702006-02-18 23:10:23 +00001539 try:
1540 fqdn = socket.getfqdn(rawHost)
1541 if fqdn != rawHost:
1542 host.append(fqdn)
1543 except socket.error:
1544 pass
Tim Peters55c12d42001-08-09 18:04:14 +00001545 # make a check value list from the registry entry: replace the
1546 # '<local>' string by the localhost entry and the corresponding
1547 # canonical entry.
1548 proxyOverride = proxyOverride.split(';')
Tim Peters55c12d42001-08-09 18:04:14 +00001549 # now check if we match one of the registry values.
1550 for test in proxyOverride:
Senthil Kumaran4af40d22009-05-01 05:59:52 +00001551 if test == '<local>':
1552 if '.' not in rawHost:
1553 return 1
Tim Petersab9ba272001-08-09 21:40:30 +00001554 test = test.replace(".", r"\.") # mask dots
1555 test = test.replace("*", r".*") # change glob sequence
1556 test = test.replace("?", r".") # change glob char
Tim Peters55c12d42001-08-09 18:04:14 +00001557 for val in host:
1558 # print "%s <--> %s" %( test, val )
1559 if re.match(test, val, re.I):
1560 return 1
1561 return 0
1562
Georg Brandl22350112008-01-20 12:05:43 +00001563 def proxy_bypass(host):
1564 """Return a dictionary of scheme -> proxy server URL mappings.
1565
1566 Returns settings gathered from the environment, if specified,
1567 or the registry.
1568
1569 """
1570 if getproxies_environment():
1571 return proxy_bypass_environment(host)
1572 else:
1573 return proxy_bypass_registry(host)
1574
Mark Hammond4f570b92000-07-26 07:04:38 +00001575else:
1576 # By default use environment variables
1577 getproxies = getproxies_environment
Georg Brandl22350112008-01-20 12:05:43 +00001578 proxy_bypass = proxy_bypass_environment
Guido van Rossum442e7201996-03-20 15:33:11 +00001579
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001580# Test and time quote() and unquote()
1581def test1():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001582 s = ''
1583 for i in range(256): s = s + chr(i)
1584 s = s*4
1585 t0 = time.time()
1586 qs = quote(s)
1587 uqs = unquote(qs)
1588 t1 = time.time()
1589 if uqs != s:
1590 print 'Wrong!'
Walter Dörwald70a6b492004-02-12 17:35:32 +00001591 print repr(s)
1592 print repr(qs)
1593 print repr(uqs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001594 print round(t1 - t0, 3), 'sec'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001595
1596
Guido van Rossum9ab96d41998-09-28 14:07:00 +00001597def reporthook(blocknum, blocksize, totalsize):
1598 # Report during remote transfers
Guido van Rossumb2493f82000-12-15 15:01:37 +00001599 print "Block number: %d, Block size: %d, Total size: %d" % (
1600 blocknum, blocksize, totalsize)