blob: affe92dff4c90dd39b747857c36c838b1740d20a [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
Brett Cannon69200fa2004-03-23 21:26:39 +000030from urlparse import urljoin as basejoin
Guido van Rossum7c6ebb51994-03-22 12:05:32 +000031
Skip Montanaro40fc1602001-03-01 04:27:19 +000032__all__ = ["urlopen", "URLopener", "FancyURLopener", "urlretrieve",
33 "urlcleanup", "quote", "quote_plus", "unquote", "unquote_plus",
Skip Montanaro44d5e0c2001-03-13 19:47:16 +000034 "urlencode", "url2pathname", "pathname2url", "splittag",
35 "localhost", "thishost", "ftperrors", "basejoin", "unwrap",
36 "splittype", "splithost", "splituser", "splitpasswd", "splitport",
37 "splitnport", "splitquery", "splitattr", "splitvalue",
Brett Cannond75f0432007-05-16 22:42:29 +000038 "getproxies"]
Skip Montanaro40fc1602001-03-01 04:27:19 +000039
Martin v. Löwis3e865952006-01-24 15:51:21 +000040__version__ = '1.17' # XXX This version is not always updated :-(
Guido van Rossumf668d171997-06-06 21:11:11 +000041
Jeremy Hyltonf90b0021999-02-25 16:12:12 +000042MAXFTPCACHE = 10 # Trim the ftp cache beyond this size
Guido van Rossum6cb15a01995-06-22 19:00:13 +000043
Jack Jansendc3e3f61995-12-15 13:22:13 +000044# Helper for non-unix systems
45if os.name == 'mac':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +000046 from macurl2path import url2pathname, pathname2url
Guido van Rossum7e7ca0b1998-03-26 21:01:39 +000047elif 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 Brandl708c4872010-02-07 12:01:19 +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 Xicluna1c245922010-08-09 22:05:50 +000097 _safe_quoters.clear()
98 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 Kumaranb52c6f82009-08-15 17:49:55 +0000180 # percent encode url. fixing lame server errors like space within url
181 # parts
Senthil Kumarana241d0a2010-02-20 22:13:01 +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()
235 del fp
236 return url2pathname(splithost(url1)[1]), hdrs
237 except IOError, msg:
238 pass
Fred Drake316a7932000-08-24 01:01:26 +0000239 fp = self.open(url, data)
Benjamin Peterson373498f2009-03-22 17:49:21 +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
262 if reporthook:
263 if "content-length" in headers:
264 size = int(headers["Content-Length"])
265 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()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000279 del fp
280 del tfp
Georg Brandlb9256022005-08-24 18:46:39 +0000281
282 # raise exception if actual size does not match content-length header
283 if size >= 0 and read < size:
284 raise ContentTooShortError("retrieval incomplete: got only %i out "
285 "of %i bytes" % (read, size), result)
286
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000287 return result
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000288
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000289 # Each method named open_<type> knows how to open that type of URL
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000290
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000291 def open_http(self, url, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000292 """Use HTTP protocol."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000293 import httplib
294 user_passwd = None
Martin v. Löwis3e865952006-01-24 15:51:21 +0000295 proxy_passwd= None
Walter Dörwald65230a22002-06-03 15:58:32 +0000296 if isinstance(url, str):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000297 host, selector = splithost(url)
298 if host:
299 user_passwd, host = splituser(host)
300 host = unquote(host)
301 realhost = host
302 else:
303 host, selector = url
Martin v. Löwis3e865952006-01-24 15:51:21 +0000304 # check whether the proxy contains authorization information
305 proxy_passwd, host = splituser(host)
306 # now we proceed with the url we want to obtain
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000307 urltype, rest = splittype(selector)
308 url = rest
309 user_passwd = None
Guido van Rossumb2493f82000-12-15 15:01:37 +0000310 if urltype.lower() != 'http':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000311 realhost = None
312 else:
313 realhost, rest = splithost(rest)
314 if realhost:
315 user_passwd, realhost = splituser(realhost)
316 if user_passwd:
317 selector = "%s://%s%s" % (urltype, realhost, rest)
Tim Peters55c12d42001-08-09 18:04:14 +0000318 if proxy_bypass(realhost):
319 host = realhost
320
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000321 #print "proxy via http:", host, selector
322 if not host: raise IOError, ('http error', 'no host given')
Tim Peters92037a12006-01-24 22:44:08 +0000323
Martin v. Löwis3e865952006-01-24 15:51:21 +0000324 if proxy_passwd:
325 import base64
Andrew M. Kuchling872dba42006-10-27 17:11:23 +0000326 proxy_auth = base64.b64encode(proxy_passwd).strip()
Martin v. Löwis3e865952006-01-24 15:51:21 +0000327 else:
328 proxy_auth = None
329
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000330 if user_passwd:
331 import base64
Andrew M. Kuchling872dba42006-10-27 17:11:23 +0000332 auth = base64.b64encode(user_passwd).strip()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000333 else:
334 auth = None
335 h = httplib.HTTP(host)
336 if data is not None:
337 h.putrequest('POST', selector)
Georg Brandl0619a322006-07-26 07:40:17 +0000338 h.putheader('Content-Type', 'application/x-www-form-urlencoded')
339 h.putheader('Content-Length', '%d' % len(data))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000340 else:
341 h.putrequest('GET', selector)
Martin v. Löwis3e865952006-01-24 15:51:21 +0000342 if proxy_auth: h.putheader('Proxy-Authorization', 'Basic %s' % proxy_auth)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000343 if auth: h.putheader('Authorization', 'Basic %s' % auth)
344 if realhost: h.putheader('Host', realhost)
Guido van Rossum68468eb2003-02-27 20:14:51 +0000345 for args in self.addheaders: h.putheader(*args)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000346 h.endheaders()
347 if data is not None:
Fred Drakeec3dfde2001-07-04 05:18:29 +0000348 h.send(data)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000349 errcode, errmsg, headers = h.getreply()
Neal Norwitzce55e212007-03-20 08:14:57 +0000350 fp = h.getfile()
Georg Brandlf66b6032007-03-14 08:27:52 +0000351 if errcode == -1:
Neal Norwitzce55e212007-03-20 08:14:57 +0000352 if fp: fp.close()
Georg Brandlf66b6032007-03-14 08:27:52 +0000353 # something went wrong with the HTTP status line
354 raise IOError, ('http protocol error', 0,
355 'got a bad status line', None)
Sean Reifscheidera1afbf62007-09-19 07:52:56 +0000356 # According to RFC 2616, "2xx" code indicates that the client's
357 # request was successfully received, understood, and accepted.
Kurt B. Kaiser0f7c25d2008-01-02 04:11:28 +0000358 if (200 <= errcode < 300):
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000359 return addinfourl(fp, headers, "http:" + url, errcode)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000360 else:
361 if data is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000362 return self.http_error(url, fp, errcode, errmsg, headers)
Guido van Rossum29aab751999-03-09 19:31:21 +0000363 else:
364 return self.http_error(url, fp, errcode, errmsg, headers, data)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000365
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000366 def http_error(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000367 """Handle http errors.
368 Derived class can override this, or provide specific handlers
369 named http_error_DDD where DDD is the 3-digit error code."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000370 # First check if there's a specific handler for this error
371 name = 'http_error_%d' % errcode
372 if hasattr(self, name):
373 method = getattr(self, name)
374 if data is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000375 result = method(url, fp, errcode, errmsg, headers)
Jeremy Hyltonb30f52a1999-02-25 16:14:58 +0000376 else:
377 result = method(url, fp, errcode, errmsg, headers, data)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000378 if result: return result
Jeremy Hyltonb30f52a1999-02-25 16:14:58 +0000379 return self.http_error_default(url, fp, errcode, errmsg, headers)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000380
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000381 def http_error_default(self, url, fp, errcode, errmsg, headers):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000382 """Default error handler: close the connection and raise IOError."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000383 void = fp.read()
384 fp.close()
385 raise IOError, ('http error', errcode, errmsg, headers)
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000386
Bill Janssen426ea0a2007-08-29 22:35:05 +0000387 if _have_ssl:
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000388 def open_https(self, url, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000389 """Use HTTPS protocol."""
Bill Janssen426ea0a2007-08-29 22:35:05 +0000390
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000391 import httplib
Fred Drake567ca8e2000-08-21 21:42:42 +0000392 user_passwd = None
Martin v. Löwis3e865952006-01-24 15:51:21 +0000393 proxy_passwd = None
Walter Dörwald65230a22002-06-03 15:58:32 +0000394 if isinstance(url, str):
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000395 host, selector = splithost(url)
Fred Drake567ca8e2000-08-21 21:42:42 +0000396 if host:
397 user_passwd, host = splituser(host)
398 host = unquote(host)
399 realhost = host
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000400 else:
401 host, selector = url
Martin v. Löwis3e865952006-01-24 15:51:21 +0000402 # here, we determine, whether the proxy contains authorization information
403 proxy_passwd, host = splituser(host)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000404 urltype, rest = splittype(selector)
Fred Drake567ca8e2000-08-21 21:42:42 +0000405 url = rest
406 user_passwd = None
Guido van Rossumb2493f82000-12-15 15:01:37 +0000407 if urltype.lower() != 'https':
Fred Drake567ca8e2000-08-21 21:42:42 +0000408 realhost = None
409 else:
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000410 realhost, rest = splithost(rest)
Fred Drake567ca8e2000-08-21 21:42:42 +0000411 if realhost:
412 user_passwd, realhost = splituser(realhost)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000413 if user_passwd:
414 selector = "%s://%s%s" % (urltype, realhost, rest)
Andrew M. Kuchling7ad47922000-06-10 01:41:48 +0000415 #print "proxy via https:", host, selector
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000416 if not host: raise IOError, ('https error', 'no host given')
Martin v. Löwis3e865952006-01-24 15:51:21 +0000417 if proxy_passwd:
418 import base64
Andrew M. Kuchling872dba42006-10-27 17:11:23 +0000419 proxy_auth = base64.b64encode(proxy_passwd).strip()
Martin v. Löwis3e865952006-01-24 15:51:21 +0000420 else:
421 proxy_auth = None
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000422 if user_passwd:
423 import base64
Andrew M. Kuchling872dba42006-10-27 17:11:23 +0000424 auth = base64.b64encode(user_passwd).strip()
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000425 else:
426 auth = None
427 h = httplib.HTTPS(host, 0,
428 key_file=self.key_file,
429 cert_file=self.cert_file)
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000430 if data is not None:
431 h.putrequest('POST', selector)
Georg Brandl0619a322006-07-26 07:40:17 +0000432 h.putheader('Content-Type',
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000433 'application/x-www-form-urlencoded')
Georg Brandl0619a322006-07-26 07:40:17 +0000434 h.putheader('Content-Length', '%d' % len(data))
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000435 else:
436 h.putrequest('GET', selector)
Andrew M. Kuchling52278572006-12-19 15:11:41 +0000437 if proxy_auth: h.putheader('Proxy-Authorization', 'Basic %s' % proxy_auth)
438 if auth: h.putheader('Authorization', 'Basic %s' % auth)
Fred Drake567ca8e2000-08-21 21:42:42 +0000439 if realhost: h.putheader('Host', realhost)
Guido van Rossum68468eb2003-02-27 20:14:51 +0000440 for args in self.addheaders: h.putheader(*args)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000441 h.endheaders()
Andrew M. Kuchling43c5af02000-04-24 14:17:06 +0000442 if data is not None:
Fred Drakeec3dfde2001-07-04 05:18:29 +0000443 h.send(data)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000444 errcode, errmsg, headers = h.getreply()
Neal Norwitzce55e212007-03-20 08:14:57 +0000445 fp = h.getfile()
Georg Brandlf66b6032007-03-14 08:27:52 +0000446 if errcode == -1:
Neal Norwitzce55e212007-03-20 08:14:57 +0000447 if fp: fp.close()
Georg Brandlf66b6032007-03-14 08:27:52 +0000448 # something went wrong with the HTTP status line
449 raise IOError, ('http protocol error', 0,
450 'got a bad status line', None)
Georg Brandl9b915672007-09-24 18:08:24 +0000451 # According to RFC 2616, "2xx" code indicates that the client's
452 # request was successfully received, understood, and accepted.
Kurt B. Kaiser0f7c25d2008-01-02 04:11:28 +0000453 if (200 <= errcode < 300):
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000454 return addinfourl(fp, headers, "https:" + url, errcode)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000455 else:
Fred Drake567ca8e2000-08-21 21:42:42 +0000456 if data is None:
457 return self.http_error(url, fp, errcode, errmsg, headers)
458 else:
Guido van Rossumb2493f82000-12-15 15:01:37 +0000459 return self.http_error(url, fp, errcode, errmsg, headers,
460 data)
Fred Drake567ca8e2000-08-21 21:42:42 +0000461
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000462 def open_file(self, url):
Neal Norwitzc5d0dbd2006-04-09 04:00:49 +0000463 """Use local file or FTP depending on form of URL."""
Martin v. Löwis3e865952006-01-24 15:51:21 +0000464 if not isinstance(url, str):
465 raise IOError, ('file error', 'proxy support for file protocol currently not implemented')
Jack Jansen4ef11032002-09-12 20:14:04 +0000466 if url[:2] == '//' and url[2:3] != '/' and url[2:12].lower() != 'localhost/':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000467 return self.open_ftp(url)
468 else:
469 return self.open_local_file(url)
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000470
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000471 def open_local_file(self, url):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000472 """Use local file."""
Georg Brandl5a096e12007-01-22 19:40:21 +0000473 import mimetypes, mimetools, email.utils
Raymond Hettingera6172712004-12-31 19:15:26 +0000474 try:
475 from cStringIO import StringIO
476 except ImportError:
477 from StringIO import StringIO
Guido van Rossumf0713d32001-08-09 17:43:35 +0000478 host, file = splithost(url)
479 localname = url2pathname(file)
Guido van Rossuma2da3052002-04-15 00:25:01 +0000480 try:
481 stats = os.stat(localname)
482 except OSError, e:
483 raise IOError(e.errno, e.strerror, e.filename)
Walter Dörwald92b48b72002-03-22 17:30:38 +0000484 size = stats.st_size
Georg Brandl5a096e12007-01-22 19:40:21 +0000485 modified = email.utils.formatdate(stats.st_mtime, usegmt=True)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000486 mtype = mimetypes.guess_type(url)[0]
Raymond Hettingera6172712004-12-31 19:15:26 +0000487 headers = mimetools.Message(StringIO(
Guido van Rossumf0713d32001-08-09 17:43:35 +0000488 'Content-Type: %s\nContent-Length: %d\nLast-modified: %s\n' %
489 (mtype or 'text/plain', size, modified)))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000490 if not host:
Guido van Rossum336a2011999-06-24 15:27:36 +0000491 urlfile = file
492 if file[:1] == '/':
493 urlfile = 'file://' + file
Guido van Rossumf0713d32001-08-09 17:43:35 +0000494 return addinfourl(open(localname, 'rb'),
Guido van Rossum336a2011999-06-24 15:27:36 +0000495 headers, urlfile)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000496 host, port = splitport(host)
497 if not port \
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000498 and socket.gethostbyname(host) in (localhost(), thishost()):
Guido van Rossum336a2011999-06-24 15:27:36 +0000499 urlfile = file
500 if file[:1] == '/':
501 urlfile = 'file://' + file
Guido van Rossumf0713d32001-08-09 17:43:35 +0000502 return addinfourl(open(localname, 'rb'),
Guido van Rossum336a2011999-06-24 15:27:36 +0000503 headers, urlfile)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000504 raise IOError, ('local file error', 'not on local host')
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000505
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000506 def open_ftp(self, url):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000507 """Use FTP protocol."""
Martin v. Löwis3e865952006-01-24 15:51:21 +0000508 if not isinstance(url, str):
509 raise IOError, ('ftp error', 'proxy support for ftp protocol currently not implemented')
Raymond Hettingera6172712004-12-31 19:15:26 +0000510 import mimetypes, mimetools
511 try:
512 from cStringIO import StringIO
513 except ImportError:
514 from StringIO import StringIO
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000515 host, path = splithost(url)
516 if not host: raise IOError, ('ftp error', 'no host given')
517 host, port = splitport(host)
518 user, host = splituser(host)
519 if user: user, passwd = splitpasswd(user)
520 else: passwd = None
521 host = unquote(host)
522 user = unquote(user or '')
523 passwd = unquote(passwd or '')
524 host = socket.gethostbyname(host)
525 if not port:
526 import ftplib
527 port = ftplib.FTP_PORT
528 else:
529 port = int(port)
530 path, attrs = splitattr(path)
531 path = unquote(path)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000532 dirs = path.split('/')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000533 dirs, file = dirs[:-1], dirs[-1]
534 if dirs and not dirs[0]: dirs = dirs[1:]
Guido van Rossum5e006a31999-08-18 17:40:33 +0000535 if dirs and not dirs[0]: dirs[0] = '/'
Guido van Rossumb2493f82000-12-15 15:01:37 +0000536 key = user, host, port, '/'.join(dirs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000537 # XXX thread unsafe!
538 if len(self.ftpcache) > MAXFTPCACHE:
539 # Prune the cache, rather arbitrarily
540 for k in self.ftpcache.keys():
541 if k != key:
542 v = self.ftpcache[k]
543 del self.ftpcache[k]
544 v.close()
545 try:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000546 if not key in self.ftpcache:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000547 self.ftpcache[key] = \
548 ftpwrapper(user, passwd, host, port, dirs)
549 if not file: type = 'D'
550 else: type = 'I'
551 for attr in attrs:
552 attr, value = splitvalue(attr)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000553 if attr.lower() == 'type' and \
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000554 value in ('a', 'A', 'i', 'I', 'd', 'D'):
Guido van Rossumb2493f82000-12-15 15:01:37 +0000555 type = value.upper()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000556 (fp, retrlen) = self.ftpcache[key].retrfile(file, type)
Guido van Rossum88e0b5b2001-08-23 13:38:15 +0000557 mtype = mimetypes.guess_type("ftp:" + url)[0]
558 headers = ""
559 if mtype:
560 headers += "Content-Type: %s\n" % mtype
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000561 if retrlen is not None and retrlen >= 0:
Guido van Rossum88e0b5b2001-08-23 13:38:15 +0000562 headers += "Content-Length: %d\n" % retrlen
Raymond Hettingera6172712004-12-31 19:15:26 +0000563 headers = mimetools.Message(StringIO(headers))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000564 return addinfourl(fp, headers, "ftp:" + url)
565 except ftperrors(), msg:
566 raise IOError, ('ftp error', msg), sys.exc_info()[2]
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000567
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000568 def open_data(self, url, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000569 """Use "data" URL."""
Martin v. Löwis3e865952006-01-24 15:51:21 +0000570 if not isinstance(url, str):
571 raise IOError, ('data error', 'proxy support for data protocol currently not implemented')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000572 # ignore POSTed data
573 #
574 # syntax of data URLs:
575 # dataurl := "data:" [ mediatype ] [ ";base64" ] "," data
576 # mediatype := [ type "/" subtype ] *( ";" parameter )
577 # data := *urlchar
578 # parameter := attribute "=" value
Raymond Hettingera6172712004-12-31 19:15:26 +0000579 import mimetools
580 try:
581 from cStringIO import StringIO
582 except ImportError:
583 from StringIO import StringIO
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000584 try:
Guido van Rossumb2493f82000-12-15 15:01:37 +0000585 [type, data] = url.split(',', 1)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000586 except ValueError:
587 raise IOError, ('data error', 'bad data URL')
588 if not type:
589 type = 'text/plain;charset=US-ASCII'
Guido van Rossumb2493f82000-12-15 15:01:37 +0000590 semi = type.rfind(';')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000591 if semi >= 0 and '=' not in type[semi:]:
592 encoding = type[semi+1:]
593 type = type[:semi]
594 else:
595 encoding = ''
596 msg = []
Senthil Kumaranfcfd25b2010-05-01 08:06:38 +0000597 msg.append('Date: %s'%time.strftime('%a, %d %b %Y %H:%M:%S GMT',
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000598 time.gmtime(time.time())))
599 msg.append('Content-type: %s' % type)
600 if encoding == 'base64':
601 import base64
602 data = base64.decodestring(data)
603 else:
604 data = unquote(data)
Georg Brandl0619a322006-07-26 07:40:17 +0000605 msg.append('Content-Length: %d' % len(data))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000606 msg.append('')
607 msg.append(data)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000608 msg = '\n'.join(msg)
Raymond Hettingera6172712004-12-31 19:15:26 +0000609 f = StringIO(msg)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000610 headers = mimetools.Message(f, 0)
Georg Brandl1f663572005-11-26 16:50:44 +0000611 #f.fileno = None # needed for addinfourl
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000612 return addinfourl(f, headers, url)
Guido van Rossum6d4d1c21998-03-12 14:32:55 +0000613
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000614
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000615class FancyURLopener(URLopener):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000616 """Derived class with handlers for errors we can handle (perhaps)."""
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000617
Neal Norwitz60e04cd2002-06-11 13:38:51 +0000618 def __init__(self, *args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000619 URLopener.__init__(self, *args, **kwargs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000620 self.auth_cache = {}
Skip Montanaroc3e11d62001-02-15 16:56:36 +0000621 self.tries = 0
622 self.maxtries = 10
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000623
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000624 def http_error_default(self, url, fp, errcode, errmsg, headers):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000625 """Default error handling -- don't raise an exception."""
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000626 return addinfourl(fp, headers, "http:" + url, errcode)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000627
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000628 def http_error_302(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000629 """Error 302 -- relocated (temporarily)."""
Skip Montanaroc3e11d62001-02-15 16:56:36 +0000630 self.tries += 1
631 if self.maxtries and self.tries >= self.maxtries:
632 if hasattr(self, "http_error_500"):
633 meth = self.http_error_500
634 else:
635 meth = self.http_error_default
636 self.tries = 0
637 return meth(url, fp, 500,
638 "Internal Server Error: Redirect Recursion", headers)
639 result = self.redirect_internal(url, fp, errcode, errmsg, headers,
640 data)
641 self.tries = 0
642 return result
643
644 def redirect_internal(self, url, fp, errcode, errmsg, headers, data):
Raymond Hettinger54f02222002-06-01 14:18:47 +0000645 if 'location' in headers:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000646 newurl = headers['location']
Raymond Hettinger54f02222002-06-01 14:18:47 +0000647 elif 'uri' in headers:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000648 newurl = headers['uri']
649 else:
650 return
651 void = fp.read()
652 fp.close()
Guido van Rossum3527f591999-03-29 20:23:41 +0000653 # In case the server sent a relative URL, join with original:
Moshe Zadka5d87d472001-04-09 14:54:21 +0000654 newurl = basejoin(self.type + ":" + url, newurl)
Guido van Rossumfa19f7c2003-05-16 01:46:51 +0000655 return self.open(newurl)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000656
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000657 def http_error_301(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000658 """Error 301 -- also relocated (permanently)."""
659 return self.http_error_302(url, fp, errcode, errmsg, headers, data)
Guido van Rossume6ad8911996-09-10 17:02:56 +0000660
Raymond Hettinger024aaa12003-04-24 15:32:12 +0000661 def http_error_303(self, url, fp, errcode, errmsg, headers, data=None):
662 """Error 303 -- also relocated (essentially identical to 302)."""
663 return self.http_error_302(url, fp, errcode, errmsg, headers, data)
664
Guido van Rossumfa19f7c2003-05-16 01:46:51 +0000665 def http_error_307(self, url, fp, errcode, errmsg, headers, data=None):
666 """Error 307 -- relocated, but turn POST into error."""
667 if data is None:
668 return self.http_error_302(url, fp, errcode, errmsg, headers, data)
669 else:
670 return self.http_error_default(url, fp, errcode, errmsg, headers)
671
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000672 def http_error_401(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000673 """Error 401 -- authentication required.
Martin v. Löwis3e865952006-01-24 15:51:21 +0000674 This function supports Basic authentication only."""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000675 if not 'www-authenticate' in headers:
Tim Peters85ba6732001-02-28 08:26:44 +0000676 URLopener.http_error_default(self, url, fp,
Fred Drakec680ae82001-10-13 18:37:07 +0000677 errcode, errmsg, headers)
Moshe Zadkae99bd172001-02-27 06:27:04 +0000678 stuff = headers['www-authenticate']
679 import re
680 match = re.match('[ \t]*([^ \t]+)[ \t]+realm="([^"]*)"', stuff)
681 if not match:
Tim Peters85ba6732001-02-28 08:26:44 +0000682 URLopener.http_error_default(self, url, fp,
Moshe Zadkae99bd172001-02-27 06:27:04 +0000683 errcode, errmsg, headers)
684 scheme, realm = match.groups()
685 if scheme.lower() != 'basic':
Tim Peters85ba6732001-02-28 08:26:44 +0000686 URLopener.http_error_default(self, url, fp,
Moshe Zadkae99bd172001-02-27 06:27:04 +0000687 errcode, errmsg, headers)
688 name = 'retry_' + self.type + '_basic_auth'
689 if data is None:
690 return getattr(self,name)(url, realm)
691 else:
692 return getattr(self,name)(url, realm, data)
Tim Peters92037a12006-01-24 22:44:08 +0000693
Martin v. Löwis3e865952006-01-24 15:51:21 +0000694 def http_error_407(self, url, fp, errcode, errmsg, headers, data=None):
695 """Error 407 -- proxy authentication required.
696 This function supports Basic authentication only."""
697 if not 'proxy-authenticate' in headers:
698 URLopener.http_error_default(self, url, fp,
699 errcode, errmsg, headers)
700 stuff = headers['proxy-authenticate']
701 import re
702 match = re.match('[ \t]*([^ \t]+)[ \t]+realm="([^"]*)"', stuff)
703 if not match:
704 URLopener.http_error_default(self, url, fp,
705 errcode, errmsg, headers)
706 scheme, realm = match.groups()
707 if scheme.lower() != 'basic':
708 URLopener.http_error_default(self, url, fp,
709 errcode, errmsg, headers)
710 name = 'retry_proxy_' + self.type + '_basic_auth'
711 if data is None:
712 return getattr(self,name)(url, realm)
713 else:
714 return getattr(self,name)(url, realm, data)
Tim Peters92037a12006-01-24 22:44:08 +0000715
Martin v. Löwis3e865952006-01-24 15:51:21 +0000716 def retry_proxy_http_basic_auth(self, url, realm, data=None):
717 host, selector = splithost(url)
718 newurl = 'http://' + host + selector
719 proxy = self.proxies['http']
720 urltype, proxyhost = splittype(proxy)
721 proxyhost, proxyselector = splithost(proxyhost)
722 i = proxyhost.find('@') + 1
723 proxyhost = proxyhost[i:]
724 user, passwd = self.get_user_passwd(proxyhost, realm, i)
725 if not (user or passwd): return None
726 proxyhost = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + proxyhost
727 self.proxies['http'] = 'http://' + proxyhost + proxyselector
728 if data is None:
729 return self.open(newurl)
730 else:
731 return self.open(newurl, data)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000732
Martin v. Löwis3e865952006-01-24 15:51:21 +0000733 def retry_proxy_https_basic_auth(self, url, realm, data=None):
734 host, selector = splithost(url)
735 newurl = 'https://' + host + selector
736 proxy = self.proxies['https']
737 urltype, proxyhost = splittype(proxy)
738 proxyhost, proxyselector = splithost(proxyhost)
739 i = proxyhost.find('@') + 1
740 proxyhost = proxyhost[i:]
741 user, passwd = self.get_user_passwd(proxyhost, realm, i)
742 if not (user or passwd): return None
743 proxyhost = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + proxyhost
744 self.proxies['https'] = 'https://' + proxyhost + proxyselector
745 if data is None:
746 return self.open(newurl)
747 else:
748 return self.open(newurl, data)
Tim Peters92037a12006-01-24 22:44:08 +0000749
Guido van Rossum3c8baed2000-02-01 23:36:55 +0000750 def retry_http_basic_auth(self, url, realm, data=None):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000751 host, selector = splithost(url)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000752 i = host.find('@') + 1
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000753 host = host[i:]
754 user, passwd = self.get_user_passwd(host, realm, i)
755 if not (user or passwd): return None
Guido van Rossumafc4f042001-01-15 18:31:13 +0000756 host = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + host
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000757 newurl = 'http://' + host + selector
Guido van Rossum3c8baed2000-02-01 23:36:55 +0000758 if data is None:
759 return self.open(newurl)
760 else:
761 return self.open(newurl, data)
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000762
Guido van Rossum3c8baed2000-02-01 23:36:55 +0000763 def retry_https_basic_auth(self, url, realm, data=None):
Tim Peterse1190062001-01-15 03:34:38 +0000764 host, selector = splithost(url)
765 i = host.find('@') + 1
766 host = host[i:]
767 user, passwd = self.get_user_passwd(host, realm, i)
768 if not (user or passwd): return None
Guido van Rossumafc4f042001-01-15 18:31:13 +0000769 host = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + host
Martin v. Löwis3e865952006-01-24 15:51:21 +0000770 newurl = 'https://' + host + selector
771 if data is None:
772 return self.open(newurl)
773 else:
774 return self.open(newurl, data)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000775
Florent Xicluna1c245922010-08-09 22:05:50 +0000776 def get_user_passwd(self, host, realm, clear_cache=0):
Guido van Rossumb2493f82000-12-15 15:01:37 +0000777 key = realm + '@' + host.lower()
Raymond Hettinger54f02222002-06-01 14:18:47 +0000778 if key in self.auth_cache:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000779 if clear_cache:
780 del self.auth_cache[key]
781 else:
782 return self.auth_cache[key]
783 user, passwd = self.prompt_user_passwd(host, realm)
784 if user or passwd: self.auth_cache[key] = (user, passwd)
785 return user, passwd
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000786
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000787 def prompt_user_passwd(self, host, realm):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000788 """Override this in a GUI environment!"""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000789 import getpass
790 try:
791 user = raw_input("Enter username for %s at %s: " % (realm,
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000792 host))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000793 passwd = getpass.getpass("Enter password for %s in %s at %s: " %
794 (user, realm, host))
795 return user, passwd
796 except KeyboardInterrupt:
797 print
798 return None, None
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000799
800
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000801# Utility functions
802
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000803_localhost = None
804def localhost():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000805 """Return the IP address of the magic hostname 'localhost'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000806 global _localhost
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000807 if _localhost is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000808 _localhost = socket.gethostbyname('localhost')
809 return _localhost
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000810
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000811_thishost = None
812def thishost():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000813 """Return the IP address of the current host."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000814 global _thishost
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000815 if _thishost is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000816 _thishost = socket.gethostbyname(socket.gethostname())
817 return _thishost
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000818
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000819_ftperrors = None
820def ftperrors():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000821 """Return the set of errors raised by the FTP class."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000822 global _ftperrors
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000823 if _ftperrors is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000824 import ftplib
825 _ftperrors = ftplib.all_errors
826 return _ftperrors
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000827
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000828_noheaders = None
829def noheaders():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000830 """Return an empty mimetools.Message object."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000831 global _noheaders
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000832 if _noheaders is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000833 import mimetools
Raymond Hettingera6172712004-12-31 19:15:26 +0000834 try:
835 from cStringIO import StringIO
836 except ImportError:
837 from StringIO import StringIO
838 _noheaders = mimetools.Message(StringIO(), 0)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000839 _noheaders.fp.close() # Recycle file descriptor
840 return _noheaders
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000841
842
843# Utility classes
844
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000845class ftpwrapper:
Guido van Rossume7b146f2000-02-04 15:28:42 +0000846 """Class used by open_ftp() for cache of open FTP connections."""
847
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000848 def __init__(self, user, passwd, host, port, dirs,
849 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000850 self.user = user
851 self.passwd = passwd
852 self.host = host
853 self.port = port
854 self.dirs = dirs
Facundo Batista711a54e2007-05-24 17:50:54 +0000855 self.timeout = timeout
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000856 self.init()
Guido van Rossume7b146f2000-02-04 15:28:42 +0000857
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000858 def init(self):
859 import ftplib
860 self.busy = 0
861 self.ftp = ftplib.FTP()
Facundo Batista711a54e2007-05-24 17:50:54 +0000862 self.ftp.connect(self.host, self.port, self.timeout)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000863 self.ftp.login(self.user, self.passwd)
864 for dir in self.dirs:
865 self.ftp.cwd(dir)
Guido van Rossume7b146f2000-02-04 15:28:42 +0000866
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000867 def retrfile(self, file, type):
868 import ftplib
869 self.endtransfer()
870 if type in ('d', 'D'): cmd = 'TYPE A'; isdir = 1
871 else: cmd = 'TYPE ' + type; isdir = 0
872 try:
873 self.ftp.voidcmd(cmd)
874 except ftplib.all_errors:
875 self.init()
876 self.ftp.voidcmd(cmd)
877 conn = None
878 if file and not isdir:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000879 # Try to retrieve as a file
880 try:
881 cmd = 'RETR ' + file
882 conn = self.ftp.ntransfercmd(cmd)
883 except ftplib.error_perm, reason:
Guido van Rossumb2493f82000-12-15 15:01:37 +0000884 if str(reason)[:3] != '550':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000885 raise IOError, ('ftp error', reason), sys.exc_info()[2]
886 if not conn:
887 # Set transfer mode to ASCII!
888 self.ftp.voidcmd('TYPE A')
Georg Brandld5e6cf22008-01-20 12:18:17 +0000889 # Try a directory listing. Verify that directory exists.
890 if file:
891 pwd = self.ftp.pwd()
892 try:
893 try:
894 self.ftp.cwd(file)
895 except ftplib.error_perm, reason:
896 raise IOError, ('ftp error', reason), sys.exc_info()[2]
897 finally:
898 self.ftp.cwd(pwd)
899 cmd = 'LIST ' + file
900 else:
901 cmd = 'LIST'
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000902 conn = self.ftp.ntransfercmd(cmd)
903 self.busy = 1
904 # Pass back both a suitably decorated object and a retrieval length
905 return (addclosehook(conn[0].makefile('rb'),
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000906 self.endtransfer), conn[1])
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000907 def endtransfer(self):
908 if not self.busy:
909 return
910 self.busy = 0
911 try:
912 self.ftp.voidresp()
913 except ftperrors():
914 pass
Guido van Rossume7b146f2000-02-04 15:28:42 +0000915
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000916 def close(self):
917 self.endtransfer()
918 try:
919 self.ftp.close()
920 except ftperrors():
921 pass
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000922
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000923class addbase:
Guido van Rossume7b146f2000-02-04 15:28:42 +0000924 """Base class for addinfo and addclosehook."""
925
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000926 def __init__(self, fp):
927 self.fp = fp
928 self.read = self.fp.read
929 self.readline = self.fp.readline
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000930 if hasattr(self.fp, "readlines"): self.readlines = self.fp.readlines
Georg Brandl1f663572005-11-26 16:50:44 +0000931 if hasattr(self.fp, "fileno"):
932 self.fileno = self.fp.fileno
933 else:
934 self.fileno = lambda: None
Raymond Hettinger42182eb2003-03-09 05:33:33 +0000935 if hasattr(self.fp, "__iter__"):
936 self.__iter__ = self.fp.__iter__
937 if hasattr(self.fp, "next"):
938 self.next = self.fp.next
Guido van Rossume7b146f2000-02-04 15:28:42 +0000939
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000940 def __repr__(self):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000941 return '<%s at %r whose fp = %r>' % (self.__class__.__name__,
942 id(self), self.fp)
Guido van Rossume7b146f2000-02-04 15:28:42 +0000943
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000944 def close(self):
945 self.read = None
946 self.readline = None
947 self.readlines = None
948 self.fileno = None
949 if self.fp: self.fp.close()
950 self.fp = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000951
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000952class addclosehook(addbase):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000953 """Class to add a close hook to an open file."""
954
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000955 def __init__(self, fp, closehook, *hookargs):
956 addbase.__init__(self, fp)
957 self.closehook = closehook
958 self.hookargs = hookargs
Guido van Rossume7b146f2000-02-04 15:28:42 +0000959
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000960 def close(self):
Guido van Rossumc580dae2000-05-24 13:21:46 +0000961 addbase.close(self)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000962 if self.closehook:
Guido van Rossum68468eb2003-02-27 20:14:51 +0000963 self.closehook(*self.hookargs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000964 self.closehook = None
965 self.hookargs = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000966
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000967class addinfo(addbase):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000968 """class to add an info() method to an open file."""
969
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000970 def __init__(self, fp, headers):
971 addbase.__init__(self, fp)
972 self.headers = headers
Guido van Rossume7b146f2000-02-04 15:28:42 +0000973
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000974 def info(self):
975 return self.headers
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000976
Guido van Rossume6ad8911996-09-10 17:02:56 +0000977class addinfourl(addbase):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000978 """class to add info() and geturl() methods to an open file."""
979
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000980 def __init__(self, fp, headers, url, code=None):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000981 addbase.__init__(self, fp)
982 self.headers = headers
983 self.url = url
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000984 self.code = code
Guido van Rossume7b146f2000-02-04 15:28:42 +0000985
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000986 def info(self):
987 return self.headers
Guido van Rossume7b146f2000-02-04 15:28:42 +0000988
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000989 def getcode(self):
990 return self.code
991
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000992 def geturl(self):
993 return self.url
Guido van Rossume6ad8911996-09-10 17:02:56 +0000994
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000995
Guido van Rossum7c395db1994-07-04 22:14:49 +0000996# Utilities to parse URLs (most of these return None for missing parts):
Sjoerd Mullendere0371b81995-11-10 10:36:07 +0000997# unwrap('<URL:type://host/path>') --> 'type://host/path'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000998# splittype('type:opaquestring') --> 'type', 'opaquestring'
999# splithost('//host[:port]/path') --> 'host[:port]', '/path'
Guido van Rossum7c395db1994-07-04 22:14:49 +00001000# splituser('user[:passwd]@host[:port]') --> 'user[:passwd]', 'host[:port]'
1001# splitpasswd('user:passwd') -> 'user', 'passwd'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001002# splitport('host:port') --> 'host', 'port'
1003# splitquery('/path?query') --> '/path', 'query'
1004# splittag('/path#tag') --> '/path', 'tag'
Guido van Rossum7c395db1994-07-04 22:14:49 +00001005# splitattr('/path;attr1=value1;attr2=value2;...') ->
1006# '/path', ['attr1=value1', 'attr2=value2', ...]
1007# splitvalue('attr=value') --> 'attr', 'value'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001008# unquote('abc%20def') -> 'abc def'
1009# quote('abc def') -> 'abc%20def')
1010
Walter Dörwald65230a22002-06-03 15:58:32 +00001011try:
1012 unicode
1013except NameError:
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001014 def _is_unicode(x):
1015 return 0
Walter Dörwald65230a22002-06-03 15:58:32 +00001016else:
1017 def _is_unicode(x):
1018 return isinstance(x, unicode)
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001019
Martin v. Löwis1d994332000-12-03 18:30:10 +00001020def toBytes(url):
1021 """toBytes(u"URL") --> 'URL'."""
1022 # Most URL schemes require ASCII. If that changes, the conversion
1023 # can be relaxed
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001024 if _is_unicode(url):
Martin v. Löwis1d994332000-12-03 18:30:10 +00001025 try:
1026 url = url.encode("ASCII")
1027 except UnicodeError:
Guido van Rossumb2493f82000-12-15 15:01:37 +00001028 raise UnicodeError("URL " + repr(url) +
1029 " contains non-ASCII characters")
Martin v. Löwis1d994332000-12-03 18:30:10 +00001030 return url
1031
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001032def unwrap(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001033 """unwrap('<URL:type://host/path>') --> 'type://host/path'."""
Guido van Rossumb2493f82000-12-15 15:01:37 +00001034 url = url.strip()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001035 if url[:1] == '<' and url[-1:] == '>':
Guido van Rossumb2493f82000-12-15 15:01:37 +00001036 url = url[1:-1].strip()
1037 if url[:4] == 'URL:': url = url[4:].strip()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001038 return url
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001039
Guido van Rossum332e1441997-09-29 23:23:46 +00001040_typeprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001041def splittype(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001042 """splittype('type:opaquestring') --> 'type', 'opaquestring'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001043 global _typeprog
1044 if _typeprog is None:
1045 import re
1046 _typeprog = re.compile('^([^/:]+):')
Guido van Rossum332e1441997-09-29 23:23:46 +00001047
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001048 match = _typeprog.match(url)
1049 if match:
1050 scheme = match.group(1)
Fred Drake9e94afd2000-07-01 07:03:30 +00001051 return scheme.lower(), url[len(scheme) + 1:]
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001052 return None, url
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001053
Guido van Rossum332e1441997-09-29 23:23:46 +00001054_hostprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001055def splithost(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001056 """splithost('//host[:port]/path') --> 'host[:port]', '/path'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001057 global _hostprog
1058 if _hostprog is None:
1059 import re
Georg Brandl1c168d82006-03-26 20:59:38 +00001060 _hostprog = re.compile('^//([^/?]*)(.*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001061
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001062 match = _hostprog.match(url)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001063 if match: return match.group(1, 2)
1064 return None, url
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001065
Guido van Rossum332e1441997-09-29 23:23:46 +00001066_userprog = None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001067def splituser(host):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001068 """splituser('user[:passwd]@host[:port]') --> 'user[:passwd]', 'host[:port]'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001069 global _userprog
1070 if _userprog is None:
1071 import re
Raymond Hettingerf2e45dd2002-08-18 20:08:56 +00001072 _userprog = re.compile('^(.*)@(.*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001073
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001074 match = _userprog.match(host)
Fred Drake567ca8e2000-08-21 21:42:42 +00001075 if match: return map(unquote, match.group(1, 2))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001076 return None, host
Guido van Rossum7c395db1994-07-04 22:14:49 +00001077
Guido van Rossum332e1441997-09-29 23:23:46 +00001078_passwdprog = None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001079def splitpasswd(user):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001080 """splitpasswd('user:passwd') -> 'user', 'passwd'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001081 global _passwdprog
1082 if _passwdprog is None:
1083 import re
1084 _passwdprog = re.compile('^([^:]*):(.*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001085
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001086 match = _passwdprog.match(user)
1087 if match: return match.group(1, 2)
1088 return user, None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001089
Guido van Rossume7b146f2000-02-04 15:28:42 +00001090# splittag('/path#tag') --> '/path', 'tag'
Guido van Rossum332e1441997-09-29 23:23:46 +00001091_portprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001092def splitport(host):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001093 """splitport('host:port') --> 'host', 'port'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001094 global _portprog
1095 if _portprog is None:
1096 import re
1097 _portprog = re.compile('^(.*):([0-9]+)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001098
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001099 match = _portprog.match(host)
1100 if match: return match.group(1, 2)
1101 return host, None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001102
Guido van Rossum332e1441997-09-29 23:23:46 +00001103_nportprog = None
Guido van Rossum53725a21996-06-13 19:12:35 +00001104def splitnport(host, defport=-1):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001105 """Split host and port, returning numeric port.
1106 Return given default port if no ':' found; defaults to -1.
1107 Return numerical port if a valid number are found after ':'.
1108 Return None if ':' but not a valid number."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001109 global _nportprog
1110 if _nportprog is None:
1111 import re
1112 _nportprog = re.compile('^(.*):(.*)$')
Guido van Rossum7e7ca0b1998-03-26 21:01:39 +00001113
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001114 match = _nportprog.match(host)
1115 if match:
1116 host, port = match.group(1, 2)
1117 try:
Guido van Rossumb2493f82000-12-15 15:01:37 +00001118 if not port: raise ValueError, "no digits"
1119 nport = int(port)
1120 except ValueError:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001121 nport = None
1122 return host, nport
1123 return host, defport
Guido van Rossum53725a21996-06-13 19:12:35 +00001124
Guido van Rossum332e1441997-09-29 23:23:46 +00001125_queryprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001126def splitquery(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001127 """splitquery('/path?query') --> '/path', 'query'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001128 global _queryprog
1129 if _queryprog is None:
1130 import re
1131 _queryprog = re.compile('^(.*)\?([^?]*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001132
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001133 match = _queryprog.match(url)
1134 if match: return match.group(1, 2)
1135 return url, None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001136
Guido van Rossum332e1441997-09-29 23:23:46 +00001137_tagprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001138def splittag(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001139 """splittag('/path#tag') --> '/path', 'tag'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001140 global _tagprog
1141 if _tagprog is None:
1142 import re
1143 _tagprog = re.compile('^(.*)#([^#]*)$')
Guido van Rossum7e7ca0b1998-03-26 21:01:39 +00001144
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001145 match = _tagprog.match(url)
1146 if match: return match.group(1, 2)
1147 return url, None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001148
Guido van Rossum7c395db1994-07-04 22:14:49 +00001149def splitattr(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001150 """splitattr('/path;attr1=value1;attr2=value2;...') ->
1151 '/path', ['attr1=value1', 'attr2=value2', ...]."""
Guido van Rossumb2493f82000-12-15 15:01:37 +00001152 words = url.split(';')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001153 return words[0], words[1:]
Guido van Rossum7c395db1994-07-04 22:14:49 +00001154
Guido van Rossum332e1441997-09-29 23:23:46 +00001155_valueprog = None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001156def splitvalue(attr):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001157 """splitvalue('attr=value') --> 'attr', 'value'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001158 global _valueprog
1159 if _valueprog is None:
1160 import re
1161 _valueprog = re.compile('^([^=]*)=(.*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001162
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001163 match = _valueprog.match(attr)
1164 if match: return match.group(1, 2)
1165 return attr, None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001166
Senthil Kumaran34f92772010-03-29 19:30:44 +00001167_hexdig = '0123456789ABCDEFabcdef'
Florent Xicluna1c245922010-08-09 22:05:50 +00001168_hextochr = dict((a + b, chr(int(a + b, 16)))
1169 for a in _hexdig for b in _hexdig)
Raymond Hettinger803ce802005-09-10 06:49:04 +00001170
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001171def unquote(s):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001172 """unquote('abc%20def') -> 'abc def'."""
Raymond Hettinger803ce802005-09-10 06:49:04 +00001173 res = s.split('%')
Florent Xicluna1c245922010-08-09 22:05:50 +00001174 # fastpath
1175 if len(res) == 1:
1176 return s
1177 s = res[0]
1178 for item in res[1:]:
Raymond Hettinger803ce802005-09-10 06:49:04 +00001179 try:
Florent Xicluna1c245922010-08-09 22:05:50 +00001180 s += _hextochr[item[:2]] + item[2:]
Raymond Hettinger803ce802005-09-10 06:49:04 +00001181 except KeyError:
Florent Xicluna1c245922010-08-09 22:05:50 +00001182 s += '%' + item
Raymond Hettinger4b0f20d2005-10-15 16:41:53 +00001183 except UnicodeDecodeError:
Florent Xicluna1c245922010-08-09 22:05:50 +00001184 s += unichr(int(item[:2], 16)) + item[2:]
1185 return s
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001186
Guido van Rossum0564e121996-12-13 14:47:36 +00001187def unquote_plus(s):
Skip Montanaro79f1c172000-08-22 03:00:52 +00001188 """unquote('%7e/abc+def') -> '~/abc def'"""
Brett Cannonaaeffaf2004-03-23 23:50:17 +00001189 s = s.replace('+', ' ')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001190 return unquote(s)
Guido van Rossum0564e121996-12-13 14:47:36 +00001191
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001192always_safe = ('ABCDEFGHIJKLMNOPQRSTUVWXYZ'
Jeremy Hylton6102e292000-08-31 15:48:10 +00001193 'abcdefghijklmnopqrstuvwxyz'
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001194 '0123456789' '_.-')
Florent Xicluna1c245922010-08-09 22:05:50 +00001195_safe_map = {}
1196for i, c in zip(xrange(256), str(bytearray(xrange(256)))):
1197 _safe_map[c] = c if (i < 128 and c in always_safe) else '%{0:02X}'.format(i)
1198_safe_quoters = {}
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001199
Florent Xicluna1c245922010-08-09 22:05:50 +00001200def quote(s, safe='/'):
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001201 """quote('abc def') -> 'abc%20def'
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001202
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001203 Each part of a URL, e.g. the path info, the query, etc., has a
1204 different set of reserved characters that must be quoted.
1205
1206 RFC 2396 Uniform Resource Identifiers (URI): Generic Syntax lists
1207 the following reserved characters.
1208
1209 reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
1210 "$" | ","
1211
1212 Each of these characters is reserved in some component of a URL,
1213 but not necessarily in all of them.
1214
1215 By default, the quote function is intended for quoting the path
1216 section of a URL. Thus, it will not encode '/'. This character
1217 is reserved, but in typical usage the quote function is being
1218 called on a path where the existing slash characters are used as
1219 reserved characters.
1220 """
Florent Xicluna1c245922010-08-09 22:05:50 +00001221 # fastpath
1222 if not s:
1223 return s
Raymond Hettinger199d2f72005-09-09 22:27:13 +00001224 cachekey = (safe, always_safe)
1225 try:
Florent Xicluna1c245922010-08-09 22:05:50 +00001226 (quoter, safe) = _safe_quoters[cachekey]
Raymond Hettinger199d2f72005-09-09 22:27:13 +00001227 except KeyError:
Florent Xicluna1c245922010-08-09 22:05:50 +00001228 safe_map = _safe_map.copy()
1229 safe_map.update([(c, c) for c in safe])
1230 quoter = safe_map.__getitem__
1231 safe = always_safe + safe
1232 _safe_quoters[cachekey] = (quoter, safe)
1233 if not s.rstrip(safe):
1234 return s
1235 return ''.join(map(quoter, s))
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001236
Florent Xicluna1c245922010-08-09 22:05:50 +00001237def quote_plus(s, safe=''):
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001238 """Quote the query fragment of a URL; replacing ' ' with '+'"""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001239 if ' ' in s:
Raymond Hettingercf6b6322005-09-10 18:17:54 +00001240 s = quote(s, safe + ' ')
1241 return s.replace(' ', '+')
1242 return quote(s, safe)
Guido van Rossum0564e121996-12-13 14:47:36 +00001243
Florent Xicluna1c245922010-08-09 22:05:50 +00001244def urlencode(query, doseq=0):
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001245 """Encode a sequence of two-element tuples or dictionary into a URL query string.
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001246
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001247 If any values in the query arg are sequences and doseq is true, each
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001248 sequence element is converted to a separate parameter.
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001249
1250 If the query arg is a sequence of two-element tuples, the order of the
1251 parameters in the output will match the order of parameters in the
1252 input.
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001253 """
Tim Peters658cba62001-02-09 20:06:00 +00001254
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001255 if hasattr(query,"items"):
1256 # mapping objects
1257 query = query.items()
1258 else:
1259 # it's a bother at times that strings and string-like objects are
1260 # sequences...
1261 try:
1262 # non-sequence items should not work with len()
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001263 # non-empty strings will fail this
Walter Dörwald65230a22002-06-03 15:58:32 +00001264 if len(query) and not isinstance(query[0], tuple):
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001265 raise TypeError
1266 # zero-length sequences of all types will get here and succeed,
1267 # but that's a minor nit - since the original implementation
1268 # allowed empty dicts that type of behavior probably should be
1269 # preserved for consistency
1270 except TypeError:
1271 ty,va,tb = sys.exc_info()
1272 raise TypeError, "not a valid non-string sequence or mapping object", tb
1273
Guido van Rossume7b146f2000-02-04 15:28:42 +00001274 l = []
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001275 if not doseq:
1276 # preserve old behavior
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001277 for k, v in query:
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001278 k = quote_plus(str(k))
1279 v = quote_plus(str(v))
1280 l.append(k + '=' + v)
1281 else:
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001282 for k, v in query:
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001283 k = quote_plus(str(k))
Walter Dörwald65230a22002-06-03 15:58:32 +00001284 if isinstance(v, str):
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001285 v = quote_plus(v)
1286 l.append(k + '=' + v)
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001287 elif _is_unicode(v):
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001288 # is there a reasonable way to convert to ASCII?
1289 # encode generates a string, but "replace" or "ignore"
1290 # lose information and "strict" can raise UnicodeError
1291 v = quote_plus(v.encode("ASCII","replace"))
1292 l.append(k + '=' + v)
1293 else:
1294 try:
1295 # is this a sufficient test for sequence-ness?
1296 x = len(v)
1297 except TypeError:
1298 # not a sequence
1299 v = quote_plus(str(v))
1300 l.append(k + '=' + v)
1301 else:
1302 # loop over the sequence
1303 for elt in v:
1304 l.append(k + '=' + quote_plus(str(elt)))
Guido van Rossumb2493f82000-12-15 15:01:37 +00001305 return '&'.join(l)
Guido van Rossum810a3391998-07-22 21:33:23 +00001306
Guido van Rossum442e7201996-03-20 15:33:11 +00001307# Proxy handling
Mark Hammond4f570b92000-07-26 07:04:38 +00001308def getproxies_environment():
1309 """Return a dictionary of scheme -> proxy server URL mappings.
1310
1311 Scan the environment for variables named <scheme>_proxy;
1312 this seems to be the standard convention. If you need a
1313 different way, you can pass a proxies dictionary to the
1314 [Fancy]URLopener constructor.
1315
1316 """
1317 proxies = {}
1318 for name, value in os.environ.items():
Guido van Rossumb2493f82000-12-15 15:01:37 +00001319 name = name.lower()
Mark Hammond4f570b92000-07-26 07:04:38 +00001320 if value and name[-6:] == '_proxy':
1321 proxies[name[:-6]] = value
1322 return proxies
1323
Georg Brandl22350112008-01-20 12:05:43 +00001324def proxy_bypass_environment(host):
1325 """Test if proxies should not be used for a particular host.
1326
1327 Checks the environment for a variable named no_proxy, which should
1328 be a list of DNS suffixes separated by commas, or '*' for all hosts.
1329 """
1330 no_proxy = os.environ.get('no_proxy', '') or os.environ.get('NO_PROXY', '')
1331 # '*' is special case for always bypass
1332 if no_proxy == '*':
1333 return 1
1334 # strip port off host
1335 hostonly, port = splitport(host)
1336 # check if the host ends with any of the DNS suffixes
1337 for name in no_proxy.split(','):
1338 if name and (hostonly.endswith(name) or host.endswith(name)):
1339 return 1
1340 # otherwise, don't bypass
1341 return 0
1342
1343
Jack Jansen11d9b062004-07-16 11:45:00 +00001344if sys.platform == 'darwin':
Ronald Oussoren40617a82009-09-20 10:37:33 +00001345 from _scproxy import _get_proxy_settings, _get_proxies
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001346
1347 def proxy_bypass_macosx_sysconf(host):
1348 """
1349 Return True iff this host shouldn't be accessed using a proxy
1350
1351 This function uses the MacOSX framework SystemConfiguration
1352 to fetch the proxy information.
1353 """
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001354 import re
1355 import socket
1356 from fnmatch import fnmatch
1357
Ronald Oussorenc1bde6e2009-10-18 07:08:27 +00001358 hostonly, port = splitport(host)
1359
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001360 def ip2num(ipAddr):
1361 parts = ipAddr.split('.')
1362 parts = map(int, parts)
1363 if len(parts) != 4:
1364 parts = (parts + [0, 0, 0, 0])[:4]
1365 return (parts[0] << 24) | (parts[1] << 16) | (parts[2] << 8) | parts[3]
1366
Ronald Oussoren40617a82009-09-20 10:37:33 +00001367 proxy_settings = _get_proxy_settings()
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001368
Ronald Oussoren40617a82009-09-20 10:37:33 +00001369 # Check for simple host names:
1370 if '.' not in host:
1371 if proxy_settings['exclude_simple']:
1372 return True
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001373
Ronald Oussorenc1bde6e2009-10-18 07:08:27 +00001374 hostIP = None
1375
Ronald Oussoren78974df2009-09-20 10:54:47 +00001376 for value in proxy_settings.get('exceptions', ()):
Ronald Oussoren40617a82009-09-20 10:37:33 +00001377 # Items in the list are strings like these: *.local, 169.254/16
Ronald Oussoren40617a82009-09-20 10:37:33 +00001378 if not value: continue
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001379
Ronald Oussoren40617a82009-09-20 10:37:33 +00001380 m = re.match(r"(\d+(?:\.\d+)*)(/\d+)?", value)
1381 if m is not None:
1382 if hostIP is None:
Ronald Oussorenc1bde6e2009-10-18 07:08:27 +00001383 try:
1384 hostIP = socket.gethostbyname(hostonly)
1385 hostIP = ip2num(hostIP)
1386 except socket.error:
1387 continue
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001388
Ronald Oussoren40617a82009-09-20 10:37:33 +00001389 base = ip2num(m.group(1))
Ronald Oussoren68f74ba2010-06-27 14:00:56 +00001390 mask = m.group(2)
1391 if mask is None:
1392 mask = 8 * (m.group(1).count('.') + 1)
1393
1394 else:
1395 mask = int(mask[1:])
1396 mask = 32 - mask
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001397
Ronald Oussoren40617a82009-09-20 10:37:33 +00001398 if (hostIP >> mask) == (base >> mask):
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001399 return True
1400
Ronald Oussoren40617a82009-09-20 10:37:33 +00001401 elif fnmatch(host, value):
1402 return True
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001403
Ronald Oussoren40617a82009-09-20 10:37:33 +00001404 return False
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001405
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001406 def getproxies_macosx_sysconf():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001407 """Return a dictionary of scheme -> proxy server URL mappings.
Guido van Rossum442e7201996-03-20 15:33:11 +00001408
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001409 This function uses the MacOSX framework SystemConfiguration
1410 to fetch the proxy information.
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001411 """
Ronald Oussoren40617a82009-09-20 10:37:33 +00001412 return _get_proxies()
Mark Hammond4f570b92000-07-26 07:04:38 +00001413
Georg Brandl22350112008-01-20 12:05:43 +00001414 def proxy_bypass(host):
1415 if getproxies_environment():
1416 return proxy_bypass_environment(host)
1417 else:
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001418 return proxy_bypass_macosx_sysconf(host)
Tim Peters55c12d42001-08-09 18:04:14 +00001419
Jack Jansen11d9b062004-07-16 11:45:00 +00001420 def getproxies():
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001421 return getproxies_environment() or getproxies_macosx_sysconf()
Tim Peters182b5ac2004-07-18 06:16:08 +00001422
Mark Hammond4f570b92000-07-26 07:04:38 +00001423elif os.name == 'nt':
1424 def getproxies_registry():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001425 """Return a dictionary of scheme -> proxy server URL mappings.
Mark Hammond4f570b92000-07-26 07:04:38 +00001426
1427 Win32 uses the registry to store proxies.
1428
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001429 """
1430 proxies = {}
Mark Hammond4f570b92000-07-26 07:04:38 +00001431 try:
1432 import _winreg
1433 except ImportError:
1434 # Std module, so should be around - but you never know!
1435 return proxies
1436 try:
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001437 internetSettings = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER,
1438 r'Software\Microsoft\Windows\CurrentVersion\Internet Settings')
Mark Hammond4f570b92000-07-26 07:04:38 +00001439 proxyEnable = _winreg.QueryValueEx(internetSettings,
1440 'ProxyEnable')[0]
1441 if proxyEnable:
1442 # Returned as Unicode but problems if not converted to ASCII
1443 proxyServer = str(_winreg.QueryValueEx(internetSettings,
1444 'ProxyServer')[0])
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001445 if '=' in proxyServer:
1446 # Per-protocol settings
Mark Hammond4f570b92000-07-26 07:04:38 +00001447 for p in proxyServer.split(';'):
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001448 protocol, address = p.split('=', 1)
Guido van Rossumb955d6c2002-03-31 23:38:48 +00001449 # See if address has a type:// prefix
Guido van Rossum64e5aa92002-04-02 14:38:16 +00001450 import re
1451 if not re.match('^([^/:]+)://', address):
Guido van Rossumb955d6c2002-03-31 23:38:48 +00001452 address = '%s://%s' % (protocol, address)
1453 proxies[protocol] = address
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001454 else:
1455 # Use one setting for all protocols
1456 if proxyServer[:5] == 'http:':
1457 proxies['http'] = proxyServer
1458 else:
1459 proxies['http'] = 'http://%s' % proxyServer
Senthil Kumaran73ae8dd2010-07-14 20:25:15 +00001460 proxies['https'] = 'https://%s' % proxyServer
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001461 proxies['ftp'] = 'ftp://%s' % proxyServer
Mark Hammond4f570b92000-07-26 07:04:38 +00001462 internetSettings.Close()
1463 except (WindowsError, ValueError, TypeError):
1464 # Either registry key not found etc, or the value in an
1465 # unexpected format.
1466 # proxies already set up to be empty so nothing to do
1467 pass
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001468 return proxies
Guido van Rossum442e7201996-03-20 15:33:11 +00001469
Mark Hammond4f570b92000-07-26 07:04:38 +00001470 def getproxies():
1471 """Return a dictionary of scheme -> proxy server URL mappings.
1472
1473 Returns settings gathered from the environment, if specified,
1474 or the registry.
1475
1476 """
1477 return getproxies_environment() or getproxies_registry()
Tim Peters55c12d42001-08-09 18:04:14 +00001478
Georg Brandl22350112008-01-20 12:05:43 +00001479 def proxy_bypass_registry(host):
Tim Peters55c12d42001-08-09 18:04:14 +00001480 try:
1481 import _winreg
1482 import re
Tim Peters55c12d42001-08-09 18:04:14 +00001483 except ImportError:
1484 # Std modules, so should be around - but you never know!
1485 return 0
1486 try:
1487 internetSettings = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER,
1488 r'Software\Microsoft\Windows\CurrentVersion\Internet Settings')
1489 proxyEnable = _winreg.QueryValueEx(internetSettings,
1490 'ProxyEnable')[0]
1491 proxyOverride = str(_winreg.QueryValueEx(internetSettings,
1492 'ProxyOverride')[0])
1493 # ^^^^ Returned as Unicode but problems if not converted to ASCII
1494 except WindowsError:
1495 return 0
1496 if not proxyEnable or not proxyOverride:
1497 return 0
1498 # try to make a host list from name and IP address.
Georg Brandl1f636702006-02-18 23:10:23 +00001499 rawHost, port = splitport(host)
1500 host = [rawHost]
Tim Peters55c12d42001-08-09 18:04:14 +00001501 try:
Georg Brandl1f636702006-02-18 23:10:23 +00001502 addr = socket.gethostbyname(rawHost)
1503 if addr != rawHost:
Tim Peters55c12d42001-08-09 18:04:14 +00001504 host.append(addr)
1505 except socket.error:
1506 pass
Georg Brandl1f636702006-02-18 23:10:23 +00001507 try:
1508 fqdn = socket.getfqdn(rawHost)
1509 if fqdn != rawHost:
1510 host.append(fqdn)
1511 except socket.error:
1512 pass
Tim Peters55c12d42001-08-09 18:04:14 +00001513 # make a check value list from the registry entry: replace the
1514 # '<local>' string by the localhost entry and the corresponding
1515 # canonical entry.
1516 proxyOverride = proxyOverride.split(';')
1517 i = 0
1518 while i < len(proxyOverride):
1519 if proxyOverride[i] == '<local>':
1520 proxyOverride[i:i+1] = ['localhost',
1521 '127.0.0.1',
1522 socket.gethostname(),
1523 socket.gethostbyname(
1524 socket.gethostname())]
1525 i += 1
1526 # print proxyOverride
1527 # now check if we match one of the registry values.
1528 for test in proxyOverride:
Tim Petersab9ba272001-08-09 21:40:30 +00001529 test = test.replace(".", r"\.") # mask dots
1530 test = test.replace("*", r".*") # change glob sequence
1531 test = test.replace("?", r".") # change glob char
Tim Peters55c12d42001-08-09 18:04:14 +00001532 for val in host:
1533 # print "%s <--> %s" %( test, val )
1534 if re.match(test, val, re.I):
1535 return 1
1536 return 0
1537
Georg Brandl22350112008-01-20 12:05:43 +00001538 def proxy_bypass(host):
1539 """Return a dictionary of scheme -> proxy server URL mappings.
1540
1541 Returns settings gathered from the environment, if specified,
1542 or the registry.
1543
1544 """
1545 if getproxies_environment():
1546 return proxy_bypass_environment(host)
1547 else:
1548 return proxy_bypass_registry(host)
1549
Mark Hammond4f570b92000-07-26 07:04:38 +00001550else:
1551 # By default use environment variables
1552 getproxies = getproxies_environment
Georg Brandl22350112008-01-20 12:05:43 +00001553 proxy_bypass = proxy_bypass_environment
Guido van Rossum442e7201996-03-20 15:33:11 +00001554
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001555# Test and time quote() and unquote()
1556def test1():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001557 s = ''
1558 for i in range(256): s = s + chr(i)
1559 s = s*4
1560 t0 = time.time()
1561 qs = quote(s)
1562 uqs = unquote(qs)
1563 t1 = time.time()
1564 if uqs != s:
1565 print 'Wrong!'
Walter Dörwald70a6b492004-02-12 17:35:32 +00001566 print repr(s)
1567 print repr(qs)
1568 print repr(uqs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001569 print round(t1 - t0, 3), 'sec'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001570
1571
Guido van Rossum9ab96d41998-09-28 14:07:00 +00001572def reporthook(blocknum, blocksize, totalsize):
1573 # Report during remote transfers
Guido van Rossumb2493f82000-12-15 15:01:37 +00001574 print "Block number: %d, Block size: %d, Total size: %d" % (
1575 blocknum, blocksize, totalsize)
Guido van Rossum9ab96d41998-09-28 14:07:00 +00001576
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001577# Test program
Guido van Rossum23490151998-06-25 02:39:00 +00001578def test(args=[]):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001579 if not args:
1580 args = [
1581 '/etc/passwd',
1582 'file:/etc/passwd',
1583 'file://localhost/etc/passwd',
Collin Winter071d1ae2007-03-12 01:55:54 +00001584 'ftp://ftp.gnu.org/pub/README',
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001585 'http://www.python.org/index.html',
1586 ]
Guido van Rossum09c8b6c1999-12-07 21:37:17 +00001587 if hasattr(URLopener, "open_https"):
1588 args.append('https://synergy.as.cmu.edu/~geek/')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001589 try:
1590 for url in args:
1591 print '-'*10, url, '-'*10
1592 fn, h = urlretrieve(url, None, reporthook)
Guido van Rossumb2493f82000-12-15 15:01:37 +00001593 print fn
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001594 if h:
1595 print '======'
1596 for k in h.keys(): print k + ':', h[k]
1597 print '======'
1598 fp = open(fn, 'rb')
1599 data = fp.read()
1600 del fp
1601 if '\r' in data:
1602 table = string.maketrans("", "")
Guido van Rossumb2493f82000-12-15 15:01:37 +00001603 data = data.translate(table, "\r")
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001604 print data
1605 fn, h = None, None
1606 print '-'*40
1607 finally:
1608 urlcleanup()
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001609
Guido van Rossum23490151998-06-25 02:39:00 +00001610def main():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001611 import getopt, sys
1612 try:
1613 opts, args = getopt.getopt(sys.argv[1:], "th")
1614 except getopt.error, msg:
1615 print msg
1616 print "Use -h for help"
1617 return
1618 t = 0
1619 for o, a in opts:
1620 if o == '-t':
1621 t = t + 1
1622 if o == '-h':
1623 print "Usage: python urllib.py [-t] [url ...]"
1624 print "-t runs self-test;",
1625 print "otherwise, contents of urls are printed"
1626 return
1627 if t:
1628 if t > 1:
1629 test1()
1630 test(args)
1631 else:
1632 if not args:
1633 print "Use -h for help"
1634 for url in args:
1635 print urlopen(url).read(),
Guido van Rossum23490151998-06-25 02:39:00 +00001636
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001637# Run test program when run as a script
1638if __name__ == '__main__':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001639 main()