blob: 70900cd211e930148ec6bd418b488751c197b0a3 [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()
Guido van Rossum7c6ebb51994-03-22 12:05:32 +000097
Bill Janssen426ea0a2007-08-29 22:35:05 +000098# check for SSL
99try:
100 import ssl
101except:
102 _have_ssl = False
103else:
104 _have_ssl = True
105
Georg Brandlb9256022005-08-24 18:46:39 +0000106# exception raised when downloaded size does not match content-length
107class ContentTooShortError(IOError):
108 def __init__(self, message, content):
109 IOError.__init__(self, message)
110 self.content = content
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000111
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000112ftpcache = {}
113class URLopener:
Guido van Rossume7b146f2000-02-04 15:28:42 +0000114 """Class to open URLs.
115 This is a class rather than just a subroutine because we may need
116 more than one set of global protocol-specific options.
117 Note -- this is a base class for those who don't want the
118 automatic handling of errors type 302 (relocated) and 401
119 (authorization needed)."""
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000120
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000121 __tempfiles = None
Guido van Rossum29e77811996-11-27 19:39:58 +0000122
Guido van Rossumba311382000-08-24 16:18:04 +0000123 version = "Python-urllib/%s" % __version__
124
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000125 # Constructor
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000126 def __init__(self, proxies=None, **x509):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000127 if proxies is None:
128 proxies = getproxies()
129 assert hasattr(proxies, 'has_key'), "proxies must be a mapping"
130 self.proxies = proxies
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000131 self.key_file = x509.get('key_file')
132 self.cert_file = x509.get('cert_file')
Georg Brandl0619a322006-07-26 07:40:17 +0000133 self.addheaders = [('User-Agent', self.version)]
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000134 self.__tempfiles = []
135 self.__unlink = os.unlink # See cleanup()
136 self.tempcache = None
137 # Undocumented feature: if you assign {} to tempcache,
138 # it is used to cache files retrieved with
139 # self.retrieve(). This is not enabled by default
140 # since it does not work for changing documents (and I
141 # haven't got the logic to check expiration headers
142 # yet).
143 self.ftpcache = ftpcache
144 # Undocumented feature: you can use a different
145 # ftp cache by assigning to the .ftpcache member;
146 # in case you want logically independent URL openers
147 # XXX This is not threadsafe. Bah.
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000148
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000149 def __del__(self):
150 self.close()
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000151
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000152 def close(self):
153 self.cleanup()
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000154
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000155 def cleanup(self):
156 # This code sometimes runs when the rest of this module
157 # has already been deleted, so it can't use any globals
158 # or import anything.
159 if self.__tempfiles:
160 for file in self.__tempfiles:
161 try:
162 self.__unlink(file)
Martin v. Löwis58682b72001-08-11 15:02:57 +0000163 except OSError:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000164 pass
165 del self.__tempfiles[:]
166 if self.tempcache:
167 self.tempcache.clear()
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000168
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000169 def addheader(self, *args):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000170 """Add a header to be used by the HTTP interface only
171 e.g. u.addheader('Accept', 'sound/basic')"""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000172 self.addheaders.append(args)
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000173
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000174 # External interface
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000175 def open(self, fullurl, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000176 """Use URLopener().open(file) instead of open(file, 'r')."""
Martin v. Löwis1d994332000-12-03 18:30:10 +0000177 fullurl = unwrap(toBytes(fullurl))
Senthil Kumaranb52c6f82009-08-15 17:49:55 +0000178 # percent encode url. fixing lame server errors like space within url
179 # parts
Senthil Kumarana241d0a2010-02-20 22:13:01 +0000180 fullurl = quote(fullurl, safe="%/:=&?~#+!$,;'@()*[]|")
Raymond Hettinger54f02222002-06-01 14:18:47 +0000181 if self.tempcache and fullurl in self.tempcache:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000182 filename, headers = self.tempcache[fullurl]
183 fp = open(filename, 'rb')
184 return addinfourl(fp, headers, fullurl)
Martin v. Löwis1d994332000-12-03 18:30:10 +0000185 urltype, url = splittype(fullurl)
186 if not urltype:
187 urltype = 'file'
Raymond Hettinger54f02222002-06-01 14:18:47 +0000188 if urltype in self.proxies:
Martin v. Löwis1d994332000-12-03 18:30:10 +0000189 proxy = self.proxies[urltype]
190 urltype, proxyhost = splittype(proxy)
Jeremy Hyltond52755f2000-10-02 23:04:02 +0000191 host, selector = splithost(proxyhost)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000192 url = (host, fullurl) # Signal special case to open_*()
Jeremy Hyltond52755f2000-10-02 23:04:02 +0000193 else:
194 proxy = None
Martin v. Löwis1d994332000-12-03 18:30:10 +0000195 name = 'open_' + urltype
196 self.type = urltype
Brett Cannonaaeffaf2004-03-23 23:50:17 +0000197 name = name.replace('-', '_')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000198 if not hasattr(self, name):
Jeremy Hyltond52755f2000-10-02 23:04:02 +0000199 if proxy:
200 return self.open_unknown_proxy(proxy, fullurl, data)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000201 else:
202 return self.open_unknown(fullurl, data)
203 try:
204 if data is None:
205 return getattr(self, name)(url)
206 else:
207 return getattr(self, name)(url, data)
208 except socket.error, msg:
209 raise IOError, ('socket error', msg), sys.exc_info()[2]
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000210
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000211 def open_unknown(self, fullurl, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000212 """Overridable interface to open unknown URL type."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000213 type, url = splittype(fullurl)
214 raise IOError, ('url error', 'unknown url type', type)
Guido van Rossumca445401995-08-29 19:19:12 +0000215
Jeremy Hyltond52755f2000-10-02 23:04:02 +0000216 def open_unknown_proxy(self, proxy, fullurl, data=None):
217 """Overridable interface to open unknown URL type."""
218 type, url = splittype(fullurl)
219 raise IOError, ('url error', 'invalid proxy for %s' % type, proxy)
220
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000221 # External interface
Sjoerd Mullenderd7b86f02000-08-25 11:23:36 +0000222 def retrieve(self, url, filename=None, reporthook=None, data=None):
Brett Cannon7d618c72003-04-24 02:43:20 +0000223 """retrieve(url) returns (filename, headers) for a local object
Guido van Rossume7b146f2000-02-04 15:28:42 +0000224 or (tempfilename, headers) for a remote object."""
Martin v. Löwis1d994332000-12-03 18:30:10 +0000225 url = unwrap(toBytes(url))
Raymond Hettinger54f02222002-06-01 14:18:47 +0000226 if self.tempcache and url in self.tempcache:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000227 return self.tempcache[url]
228 type, url1 = splittype(url)
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000229 if filename is None and (not type or type == 'file'):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000230 try:
231 fp = self.open_local_file(url1)
232 hdrs = fp.info()
233 del fp
234 return url2pathname(splithost(url1)[1]), hdrs
235 except IOError, msg:
236 pass
Fred Drake316a7932000-08-24 01:01:26 +0000237 fp = self.open(url, data)
Benjamin Peterson373498f2009-03-22 17:49:21 +0000238 try:
239 headers = fp.info()
240 if filename:
241 tfp = open(filename, 'wb')
242 else:
243 import tempfile
244 garbage, path = splittype(url)
245 garbage, path = splithost(path or "")
246 path, garbage = splitquery(path or "")
247 path, garbage = splitattr(path or "")
248 suffix = os.path.splitext(path)[1]
249 (fd, filename) = tempfile.mkstemp(suffix)
250 self.__tempfiles.append(filename)
251 tfp = os.fdopen(fd, 'wb')
252 try:
253 result = filename, headers
254 if self.tempcache is not None:
255 self.tempcache[url] = result
256 bs = 1024*8
257 size = -1
258 read = 0
259 blocknum = 0
260 if reporthook:
261 if "content-length" in headers:
262 size = int(headers["Content-Length"])
263 reporthook(blocknum, bs, size)
264 while 1:
265 block = fp.read(bs)
266 if block == "":
267 break
268 read += len(block)
269 tfp.write(block)
270 blocknum += 1
271 if reporthook:
272 reporthook(blocknum, bs, size)
273 finally:
274 tfp.close()
275 finally:
276 fp.close()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000277 del fp
278 del tfp
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:
323 import base64
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:
329 import base64
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)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000344 h.endheaders()
345 if data is not None:
Fred Drakeec3dfde2001-07-04 05:18:29 +0000346 h.send(data)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000347 errcode, errmsg, headers = h.getreply()
Neal Norwitzce55e212007-03-20 08:14:57 +0000348 fp = h.getfile()
Georg Brandlf66b6032007-03-14 08:27:52 +0000349 if errcode == -1:
Neal Norwitzce55e212007-03-20 08:14:57 +0000350 if fp: fp.close()
Georg Brandlf66b6032007-03-14 08:27:52 +0000351 # something went wrong with the HTTP status line
352 raise IOError, ('http protocol error', 0,
353 'got a bad status line', None)
Sean Reifscheidera1afbf62007-09-19 07:52:56 +0000354 # According to RFC 2616, "2xx" code indicates that the client's
355 # request was successfully received, understood, and accepted.
Kurt B. Kaiser0f7c25d2008-01-02 04:11:28 +0000356 if (200 <= errcode < 300):
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000357 return addinfourl(fp, headers, "http:" + url, errcode)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000358 else:
359 if data is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000360 return self.http_error(url, fp, errcode, errmsg, headers)
Guido van Rossum29aab751999-03-09 19:31:21 +0000361 else:
362 return self.http_error(url, fp, errcode, errmsg, headers, data)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000363
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000364 def http_error(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000365 """Handle http errors.
366 Derived class can override this, or provide specific handlers
367 named http_error_DDD where DDD is the 3-digit error code."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000368 # First check if there's a specific handler for this error
369 name = 'http_error_%d' % errcode
370 if hasattr(self, name):
371 method = getattr(self, name)
372 if data is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000373 result = method(url, fp, errcode, errmsg, headers)
Jeremy Hyltonb30f52a1999-02-25 16:14:58 +0000374 else:
375 result = method(url, fp, errcode, errmsg, headers, data)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000376 if result: return result
Jeremy Hyltonb30f52a1999-02-25 16:14:58 +0000377 return self.http_error_default(url, fp, errcode, errmsg, headers)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000378
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000379 def http_error_default(self, url, fp, errcode, errmsg, headers):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000380 """Default error handler: close the connection and raise IOError."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000381 void = fp.read()
382 fp.close()
383 raise IOError, ('http error', errcode, errmsg, headers)
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000384
Bill Janssen426ea0a2007-08-29 22:35:05 +0000385 if _have_ssl:
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000386 def open_https(self, url, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000387 """Use HTTPS protocol."""
Bill Janssen426ea0a2007-08-29 22:35:05 +0000388
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000389 import httplib
Fred Drake567ca8e2000-08-21 21:42:42 +0000390 user_passwd = None
Martin v. Löwis3e865952006-01-24 15:51:21 +0000391 proxy_passwd = None
Walter Dörwald65230a22002-06-03 15:58:32 +0000392 if isinstance(url, str):
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000393 host, selector = splithost(url)
Fred Drake567ca8e2000-08-21 21:42:42 +0000394 if host:
395 user_passwd, host = splituser(host)
396 host = unquote(host)
397 realhost = host
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000398 else:
399 host, selector = url
Martin v. Löwis3e865952006-01-24 15:51:21 +0000400 # here, we determine, whether the proxy contains authorization information
401 proxy_passwd, host = splituser(host)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000402 urltype, rest = splittype(selector)
Fred Drake567ca8e2000-08-21 21:42:42 +0000403 url = rest
404 user_passwd = None
Guido van Rossumb2493f82000-12-15 15:01:37 +0000405 if urltype.lower() != 'https':
Fred Drake567ca8e2000-08-21 21:42:42 +0000406 realhost = None
407 else:
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000408 realhost, rest = splithost(rest)
Fred Drake567ca8e2000-08-21 21:42:42 +0000409 if realhost:
410 user_passwd, realhost = splituser(realhost)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000411 if user_passwd:
412 selector = "%s://%s%s" % (urltype, realhost, rest)
Andrew M. Kuchling7ad47922000-06-10 01:41:48 +0000413 #print "proxy via https:", host, selector
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000414 if not host: raise IOError, ('https error', 'no host given')
Martin v. Löwis3e865952006-01-24 15:51:21 +0000415 if proxy_passwd:
416 import base64
Andrew M. Kuchling872dba42006-10-27 17:11:23 +0000417 proxy_auth = base64.b64encode(proxy_passwd).strip()
Martin v. Löwis3e865952006-01-24 15:51:21 +0000418 else:
419 proxy_auth = None
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000420 if user_passwd:
421 import base64
Andrew M. Kuchling872dba42006-10-27 17:11:23 +0000422 auth = base64.b64encode(user_passwd).strip()
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000423 else:
424 auth = None
425 h = httplib.HTTPS(host, 0,
426 key_file=self.key_file,
427 cert_file=self.cert_file)
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000428 if data is not None:
429 h.putrequest('POST', selector)
Georg Brandl0619a322006-07-26 07:40:17 +0000430 h.putheader('Content-Type',
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000431 'application/x-www-form-urlencoded')
Georg Brandl0619a322006-07-26 07:40:17 +0000432 h.putheader('Content-Length', '%d' % len(data))
Andrew M. Kuchling141e9892000-04-23 02:53:11 +0000433 else:
434 h.putrequest('GET', selector)
Andrew M. Kuchling52278572006-12-19 15:11:41 +0000435 if proxy_auth: h.putheader('Proxy-Authorization', 'Basic %s' % proxy_auth)
436 if auth: h.putheader('Authorization', 'Basic %s' % auth)
Fred Drake567ca8e2000-08-21 21:42:42 +0000437 if realhost: h.putheader('Host', realhost)
Guido van Rossum68468eb2003-02-27 20:14:51 +0000438 for args in self.addheaders: h.putheader(*args)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000439 h.endheaders()
Andrew M. Kuchling43c5af02000-04-24 14:17:06 +0000440 if data is not None:
Fred Drakeec3dfde2001-07-04 05:18:29 +0000441 h.send(data)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000442 errcode, errmsg, headers = h.getreply()
Neal Norwitzce55e212007-03-20 08:14:57 +0000443 fp = h.getfile()
Georg Brandlf66b6032007-03-14 08:27:52 +0000444 if errcode == -1:
Neal Norwitzce55e212007-03-20 08:14:57 +0000445 if fp: fp.close()
Georg Brandlf66b6032007-03-14 08:27:52 +0000446 # something went wrong with the HTTP status line
447 raise IOError, ('http protocol error', 0,
448 'got a bad status line', None)
Georg Brandl9b915672007-09-24 18:08:24 +0000449 # According to RFC 2616, "2xx" code indicates that the client's
450 # request was successfully received, understood, and accepted.
Kurt B. Kaiser0f7c25d2008-01-02 04:11:28 +0000451 if (200 <= errcode < 300):
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000452 return addinfourl(fp, headers, "https:" + url, errcode)
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000453 else:
Fred Drake567ca8e2000-08-21 21:42:42 +0000454 if data is None:
455 return self.http_error(url, fp, errcode, errmsg, headers)
456 else:
Guido van Rossumb2493f82000-12-15 15:01:37 +0000457 return self.http_error(url, fp, errcode, errmsg, headers,
458 data)
Fred Drake567ca8e2000-08-21 21:42:42 +0000459
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000460 def open_file(self, url):
Neal Norwitzc5d0dbd2006-04-09 04:00:49 +0000461 """Use local file or FTP depending on form of URL."""
Martin v. Löwis3e865952006-01-24 15:51:21 +0000462 if not isinstance(url, str):
463 raise IOError, ('file error', 'proxy support for file protocol currently not implemented')
Jack Jansen4ef11032002-09-12 20:14:04 +0000464 if url[:2] == '//' and url[2:3] != '/' and url[2:12].lower() != 'localhost/':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000465 return self.open_ftp(url)
466 else:
467 return self.open_local_file(url)
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000468
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000469 def open_local_file(self, url):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000470 """Use local file."""
Georg Brandl5a096e12007-01-22 19:40:21 +0000471 import mimetypes, mimetools, email.utils
Raymond Hettingera6172712004-12-31 19:15:26 +0000472 try:
473 from cStringIO import StringIO
474 except ImportError:
475 from StringIO import StringIO
Guido van Rossumf0713d32001-08-09 17:43:35 +0000476 host, file = splithost(url)
477 localname = url2pathname(file)
Guido van Rossuma2da3052002-04-15 00:25:01 +0000478 try:
479 stats = os.stat(localname)
480 except OSError, e:
481 raise IOError(e.errno, e.strerror, e.filename)
Walter Dörwald92b48b72002-03-22 17:30:38 +0000482 size = stats.st_size
Georg Brandl5a096e12007-01-22 19:40:21 +0000483 modified = email.utils.formatdate(stats.st_mtime, usegmt=True)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000484 mtype = mimetypes.guess_type(url)[0]
Raymond Hettingera6172712004-12-31 19:15:26 +0000485 headers = mimetools.Message(StringIO(
Guido van Rossumf0713d32001-08-09 17:43:35 +0000486 'Content-Type: %s\nContent-Length: %d\nLast-modified: %s\n' %
487 (mtype or 'text/plain', size, modified)))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000488 if not host:
Guido van Rossum336a2011999-06-24 15:27:36 +0000489 urlfile = file
490 if file[:1] == '/':
491 urlfile = 'file://' + file
Guido van Rossumf0713d32001-08-09 17:43:35 +0000492 return addinfourl(open(localname, 'rb'),
Guido van Rossum336a2011999-06-24 15:27:36 +0000493 headers, urlfile)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000494 host, port = splitport(host)
495 if not port \
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000496 and socket.gethostbyname(host) in (localhost(), thishost()):
Guido van Rossum336a2011999-06-24 15:27:36 +0000497 urlfile = file
498 if file[:1] == '/':
499 urlfile = 'file://' + file
Guido van Rossumf0713d32001-08-09 17:43:35 +0000500 return addinfourl(open(localname, 'rb'),
Guido van Rossum336a2011999-06-24 15:27:36 +0000501 headers, urlfile)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000502 raise IOError, ('local file error', 'not on local host')
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000503
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000504 def open_ftp(self, url):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000505 """Use FTP protocol."""
Martin v. Löwis3e865952006-01-24 15:51:21 +0000506 if not isinstance(url, str):
507 raise IOError, ('ftp error', 'proxy support for ftp protocol currently not implemented')
Raymond Hettingera6172712004-12-31 19:15:26 +0000508 import mimetypes, mimetools
509 try:
510 from cStringIO import StringIO
511 except ImportError:
512 from StringIO import StringIO
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000513 host, path = splithost(url)
514 if not host: raise IOError, ('ftp error', 'no host given')
515 host, port = splitport(host)
516 user, host = splituser(host)
517 if user: user, passwd = splitpasswd(user)
518 else: passwd = None
519 host = unquote(host)
520 user = unquote(user or '')
521 passwd = unquote(passwd or '')
522 host = socket.gethostbyname(host)
523 if not port:
524 import ftplib
525 port = ftplib.FTP_PORT
526 else:
527 port = int(port)
528 path, attrs = splitattr(path)
529 path = unquote(path)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000530 dirs = path.split('/')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000531 dirs, file = dirs[:-1], dirs[-1]
532 if dirs and not dirs[0]: dirs = dirs[1:]
Guido van Rossum5e006a31999-08-18 17:40:33 +0000533 if dirs and not dirs[0]: dirs[0] = '/'
Guido van Rossumb2493f82000-12-15 15:01:37 +0000534 key = user, host, port, '/'.join(dirs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000535 # XXX thread unsafe!
536 if len(self.ftpcache) > MAXFTPCACHE:
537 # Prune the cache, rather arbitrarily
538 for k in self.ftpcache.keys():
539 if k != key:
540 v = self.ftpcache[k]
541 del self.ftpcache[k]
542 v.close()
543 try:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000544 if not key in self.ftpcache:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000545 self.ftpcache[key] = \
546 ftpwrapper(user, passwd, host, port, dirs)
547 if not file: type = 'D'
548 else: type = 'I'
549 for attr in attrs:
550 attr, value = splitvalue(attr)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000551 if attr.lower() == 'type' and \
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000552 value in ('a', 'A', 'i', 'I', 'd', 'D'):
Guido van Rossumb2493f82000-12-15 15:01:37 +0000553 type = value.upper()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000554 (fp, retrlen) = self.ftpcache[key].retrfile(file, type)
Guido van Rossum88e0b5b2001-08-23 13:38:15 +0000555 mtype = mimetypes.guess_type("ftp:" + url)[0]
556 headers = ""
557 if mtype:
558 headers += "Content-Type: %s\n" % mtype
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000559 if retrlen is not None and retrlen >= 0:
Guido van Rossum88e0b5b2001-08-23 13:38:15 +0000560 headers += "Content-Length: %d\n" % retrlen
Raymond Hettingera6172712004-12-31 19:15:26 +0000561 headers = mimetools.Message(StringIO(headers))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000562 return addinfourl(fp, headers, "ftp:" + url)
563 except ftperrors(), msg:
564 raise IOError, ('ftp error', msg), sys.exc_info()[2]
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000565
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000566 def open_data(self, url, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000567 """Use "data" URL."""
Martin v. Löwis3e865952006-01-24 15:51:21 +0000568 if not isinstance(url, str):
569 raise IOError, ('data error', 'proxy support for data protocol currently not implemented')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000570 # ignore POSTed data
571 #
572 # syntax of data URLs:
573 # dataurl := "data:" [ mediatype ] [ ";base64" ] "," data
574 # mediatype := [ type "/" subtype ] *( ";" parameter )
575 # data := *urlchar
576 # parameter := attribute "=" value
Raymond Hettingera6172712004-12-31 19:15:26 +0000577 import mimetools
578 try:
579 from cStringIO import StringIO
580 except ImportError:
581 from StringIO import StringIO
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000582 try:
Guido van Rossumb2493f82000-12-15 15:01:37 +0000583 [type, data] = url.split(',', 1)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000584 except ValueError:
585 raise IOError, ('data error', 'bad data URL')
586 if not type:
587 type = 'text/plain;charset=US-ASCII'
Guido van Rossumb2493f82000-12-15 15:01:37 +0000588 semi = type.rfind(';')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000589 if semi >= 0 and '=' not in type[semi:]:
590 encoding = type[semi+1:]
591 type = type[:semi]
592 else:
593 encoding = ''
594 msg = []
Senthil Kumaranfcfd25b2010-05-01 08:06:38 +0000595 msg.append('Date: %s'%time.strftime('%a, %d %b %Y %H:%M:%S GMT',
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000596 time.gmtime(time.time())))
597 msg.append('Content-type: %s' % type)
598 if encoding == 'base64':
599 import base64
600 data = base64.decodestring(data)
601 else:
602 data = unquote(data)
Georg Brandl0619a322006-07-26 07:40:17 +0000603 msg.append('Content-Length: %d' % len(data))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000604 msg.append('')
605 msg.append(data)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000606 msg = '\n'.join(msg)
Raymond Hettingera6172712004-12-31 19:15:26 +0000607 f = StringIO(msg)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000608 headers = mimetools.Message(f, 0)
Georg Brandl1f663572005-11-26 16:50:44 +0000609 #f.fileno = None # needed for addinfourl
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000610 return addinfourl(f, headers, url)
Guido van Rossum6d4d1c21998-03-12 14:32:55 +0000611
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000612
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000613class FancyURLopener(URLopener):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000614 """Derived class with handlers for errors we can handle (perhaps)."""
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000615
Neal Norwitz60e04cd2002-06-11 13:38:51 +0000616 def __init__(self, *args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000617 URLopener.__init__(self, *args, **kwargs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000618 self.auth_cache = {}
Skip Montanaroc3e11d62001-02-15 16:56:36 +0000619 self.tries = 0
620 self.maxtries = 10
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000621
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000622 def http_error_default(self, url, fp, errcode, errmsg, headers):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000623 """Default error handling -- don't raise an exception."""
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000624 return addinfourl(fp, headers, "http:" + url, errcode)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000625
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000626 def http_error_302(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000627 """Error 302 -- relocated (temporarily)."""
Skip Montanaroc3e11d62001-02-15 16:56:36 +0000628 self.tries += 1
629 if self.maxtries and self.tries >= self.maxtries:
630 if hasattr(self, "http_error_500"):
631 meth = self.http_error_500
632 else:
633 meth = self.http_error_default
634 self.tries = 0
635 return meth(url, fp, 500,
636 "Internal Server Error: Redirect Recursion", headers)
637 result = self.redirect_internal(url, fp, errcode, errmsg, headers,
638 data)
639 self.tries = 0
640 return result
641
642 def redirect_internal(self, url, fp, errcode, errmsg, headers, data):
Raymond Hettinger54f02222002-06-01 14:18:47 +0000643 if 'location' in headers:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000644 newurl = headers['location']
Raymond Hettinger54f02222002-06-01 14:18:47 +0000645 elif 'uri' in headers:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000646 newurl = headers['uri']
647 else:
648 return
649 void = fp.read()
650 fp.close()
Guido van Rossum3527f591999-03-29 20:23:41 +0000651 # In case the server sent a relative URL, join with original:
Moshe Zadka5d87d472001-04-09 14:54:21 +0000652 newurl = basejoin(self.type + ":" + url, newurl)
Guido van Rossumfa19f7c2003-05-16 01:46:51 +0000653 return self.open(newurl)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000654
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000655 def http_error_301(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000656 """Error 301 -- also relocated (permanently)."""
657 return self.http_error_302(url, fp, errcode, errmsg, headers, data)
Guido van Rossume6ad8911996-09-10 17:02:56 +0000658
Raymond Hettinger024aaa12003-04-24 15:32:12 +0000659 def http_error_303(self, url, fp, errcode, errmsg, headers, data=None):
660 """Error 303 -- also relocated (essentially identical to 302)."""
661 return self.http_error_302(url, fp, errcode, errmsg, headers, data)
662
Guido van Rossumfa19f7c2003-05-16 01:46:51 +0000663 def http_error_307(self, url, fp, errcode, errmsg, headers, data=None):
664 """Error 307 -- relocated, but turn POST into error."""
665 if data is None:
666 return self.http_error_302(url, fp, errcode, errmsg, headers, data)
667 else:
668 return self.http_error_default(url, fp, errcode, errmsg, headers)
669
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000670 def http_error_401(self, url, fp, errcode, errmsg, headers, data=None):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000671 """Error 401 -- authentication required.
Martin v. Löwis3e865952006-01-24 15:51:21 +0000672 This function supports Basic authentication only."""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000673 if not 'www-authenticate' in headers:
Tim Peters85ba6732001-02-28 08:26:44 +0000674 URLopener.http_error_default(self, url, fp,
Fred Drakec680ae82001-10-13 18:37:07 +0000675 errcode, errmsg, headers)
Moshe Zadkae99bd172001-02-27 06:27:04 +0000676 stuff = headers['www-authenticate']
677 import re
678 match = re.match('[ \t]*([^ \t]+)[ \t]+realm="([^"]*)"', stuff)
679 if not match:
Tim Peters85ba6732001-02-28 08:26:44 +0000680 URLopener.http_error_default(self, url, fp,
Moshe Zadkae99bd172001-02-27 06:27:04 +0000681 errcode, errmsg, headers)
682 scheme, realm = match.groups()
683 if scheme.lower() != 'basic':
Tim Peters85ba6732001-02-28 08:26:44 +0000684 URLopener.http_error_default(self, url, fp,
Moshe Zadkae99bd172001-02-27 06:27:04 +0000685 errcode, errmsg, headers)
686 name = 'retry_' + self.type + '_basic_auth'
687 if data is None:
688 return getattr(self,name)(url, realm)
689 else:
690 return getattr(self,name)(url, realm, data)
Tim Peters92037a12006-01-24 22:44:08 +0000691
Martin v. Löwis3e865952006-01-24 15:51:21 +0000692 def http_error_407(self, url, fp, errcode, errmsg, headers, data=None):
693 """Error 407 -- proxy authentication required.
694 This function supports Basic authentication only."""
695 if not 'proxy-authenticate' in headers:
696 URLopener.http_error_default(self, url, fp,
697 errcode, errmsg, headers)
698 stuff = headers['proxy-authenticate']
699 import re
700 match = re.match('[ \t]*([^ \t]+)[ \t]+realm="([^"]*)"', stuff)
701 if not match:
702 URLopener.http_error_default(self, url, fp,
703 errcode, errmsg, headers)
704 scheme, realm = match.groups()
705 if scheme.lower() != 'basic':
706 URLopener.http_error_default(self, url, fp,
707 errcode, errmsg, headers)
708 name = 'retry_proxy_' + self.type + '_basic_auth'
709 if data is None:
710 return getattr(self,name)(url, realm)
711 else:
712 return getattr(self,name)(url, realm, data)
Tim Peters92037a12006-01-24 22:44:08 +0000713
Martin v. Löwis3e865952006-01-24 15:51:21 +0000714 def retry_proxy_http_basic_auth(self, url, realm, data=None):
715 host, selector = splithost(url)
716 newurl = 'http://' + host + selector
717 proxy = self.proxies['http']
718 urltype, proxyhost = splittype(proxy)
719 proxyhost, proxyselector = splithost(proxyhost)
720 i = proxyhost.find('@') + 1
721 proxyhost = proxyhost[i:]
722 user, passwd = self.get_user_passwd(proxyhost, realm, i)
723 if not (user or passwd): return None
724 proxyhost = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + proxyhost
725 self.proxies['http'] = 'http://' + proxyhost + proxyselector
726 if data is None:
727 return self.open(newurl)
728 else:
729 return self.open(newurl, data)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000730
Martin v. Löwis3e865952006-01-24 15:51:21 +0000731 def retry_proxy_https_basic_auth(self, url, realm, data=None):
732 host, selector = splithost(url)
733 newurl = 'https://' + host + selector
734 proxy = self.proxies['https']
735 urltype, proxyhost = splittype(proxy)
736 proxyhost, proxyselector = splithost(proxyhost)
737 i = proxyhost.find('@') + 1
738 proxyhost = proxyhost[i:]
739 user, passwd = self.get_user_passwd(proxyhost, realm, i)
740 if not (user or passwd): return None
741 proxyhost = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + proxyhost
742 self.proxies['https'] = 'https://' + proxyhost + proxyselector
743 if data is None:
744 return self.open(newurl)
745 else:
746 return self.open(newurl, data)
Tim Peters92037a12006-01-24 22:44:08 +0000747
Guido van Rossum3c8baed2000-02-01 23:36:55 +0000748 def retry_http_basic_auth(self, url, realm, data=None):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000749 host, selector = splithost(url)
Guido van Rossumb2493f82000-12-15 15:01:37 +0000750 i = host.find('@') + 1
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000751 host = host[i:]
752 user, passwd = self.get_user_passwd(host, realm, i)
753 if not (user or passwd): return None
Guido van Rossumafc4f042001-01-15 18:31:13 +0000754 host = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + host
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000755 newurl = 'http://' + host + selector
Guido van Rossum3c8baed2000-02-01 23:36:55 +0000756 if data is None:
757 return self.open(newurl)
758 else:
759 return self.open(newurl, data)
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000760
Guido van Rossum3c8baed2000-02-01 23:36:55 +0000761 def retry_https_basic_auth(self, url, realm, data=None):
Tim Peterse1190062001-01-15 03:34:38 +0000762 host, selector = splithost(url)
763 i = host.find('@') + 1
764 host = host[i:]
765 user, passwd = self.get_user_passwd(host, realm, i)
766 if not (user or passwd): return None
Guido van Rossumafc4f042001-01-15 18:31:13 +0000767 host = quote(user, safe='') + ':' + quote(passwd, safe='') + '@' + host
Martin v. Löwis3e865952006-01-24 15:51:21 +0000768 newurl = 'https://' + host + selector
769 if data is None:
770 return self.open(newurl)
771 else:
772 return self.open(newurl, data)
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000773
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000774 def get_user_passwd(self, host, realm, clear_cache = 0):
Guido van Rossumb2493f82000-12-15 15:01:37 +0000775 key = realm + '@' + host.lower()
Raymond Hettinger54f02222002-06-01 14:18:47 +0000776 if key in self.auth_cache:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000777 if clear_cache:
778 del self.auth_cache[key]
779 else:
780 return self.auth_cache[key]
781 user, passwd = self.prompt_user_passwd(host, realm)
782 if user or passwd: self.auth_cache[key] = (user, passwd)
783 return user, passwd
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000784
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000785 def prompt_user_passwd(self, host, realm):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000786 """Override this in a GUI environment!"""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000787 import getpass
788 try:
789 user = raw_input("Enter username for %s at %s: " % (realm,
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000790 host))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000791 passwd = getpass.getpass("Enter password for %s in %s at %s: " %
792 (user, realm, host))
793 return user, passwd
794 except KeyboardInterrupt:
795 print
796 return None, None
Guido van Rossumbbb0a051995-08-04 04:29:05 +0000797
798
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000799# Utility functions
800
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000801_localhost = None
802def localhost():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000803 """Return the IP address of the magic hostname 'localhost'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000804 global _localhost
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000805 if _localhost is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000806 _localhost = socket.gethostbyname('localhost')
807 return _localhost
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000808
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000809_thishost = None
810def thishost():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000811 """Return the IP address of the current host."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000812 global _thishost
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000813 if _thishost is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000814 _thishost = socket.gethostbyname(socket.gethostname())
815 return _thishost
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000816
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000817_ftperrors = None
818def ftperrors():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000819 """Return the set of errors raised by the FTP class."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000820 global _ftperrors
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000821 if _ftperrors is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000822 import ftplib
823 _ftperrors = ftplib.all_errors
824 return _ftperrors
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000825
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000826_noheaders = None
827def noheaders():
Guido van Rossume7b146f2000-02-04 15:28:42 +0000828 """Return an empty mimetools.Message object."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000829 global _noheaders
Raymond Hettinger10ff7062002-06-02 03:04:52 +0000830 if _noheaders is None:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000831 import mimetools
Raymond Hettingera6172712004-12-31 19:15:26 +0000832 try:
833 from cStringIO import StringIO
834 except ImportError:
835 from StringIO import StringIO
836 _noheaders = mimetools.Message(StringIO(), 0)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000837 _noheaders.fp.close() # Recycle file descriptor
838 return _noheaders
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000839
840
841# Utility classes
842
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000843class ftpwrapper:
Guido van Rossume7b146f2000-02-04 15:28:42 +0000844 """Class used by open_ftp() for cache of open FTP connections."""
845
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000846 def __init__(self, user, passwd, host, port, dirs,
847 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000848 self.user = user
849 self.passwd = passwd
850 self.host = host
851 self.port = port
852 self.dirs = dirs
Facundo Batista711a54e2007-05-24 17:50:54 +0000853 self.timeout = timeout
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000854 self.init()
Guido van Rossume7b146f2000-02-04 15:28:42 +0000855
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000856 def init(self):
857 import ftplib
858 self.busy = 0
859 self.ftp = ftplib.FTP()
Facundo Batista711a54e2007-05-24 17:50:54 +0000860 self.ftp.connect(self.host, self.port, self.timeout)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000861 self.ftp.login(self.user, self.passwd)
862 for dir in self.dirs:
863 self.ftp.cwd(dir)
Guido van Rossume7b146f2000-02-04 15:28:42 +0000864
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000865 def retrfile(self, file, type):
866 import ftplib
867 self.endtransfer()
868 if type in ('d', 'D'): cmd = 'TYPE A'; isdir = 1
869 else: cmd = 'TYPE ' + type; isdir = 0
870 try:
871 self.ftp.voidcmd(cmd)
872 except ftplib.all_errors:
873 self.init()
874 self.ftp.voidcmd(cmd)
875 conn = None
876 if file and not isdir:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000877 # Try to retrieve as a file
878 try:
879 cmd = 'RETR ' + file
880 conn = self.ftp.ntransfercmd(cmd)
881 except ftplib.error_perm, reason:
Guido van Rossumb2493f82000-12-15 15:01:37 +0000882 if str(reason)[:3] != '550':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000883 raise IOError, ('ftp error', reason), sys.exc_info()[2]
884 if not conn:
885 # Set transfer mode to ASCII!
886 self.ftp.voidcmd('TYPE A')
Georg Brandld5e6cf22008-01-20 12:18:17 +0000887 # Try a directory listing. Verify that directory exists.
888 if file:
889 pwd = self.ftp.pwd()
890 try:
891 try:
892 self.ftp.cwd(file)
893 except ftplib.error_perm, reason:
894 raise IOError, ('ftp error', reason), sys.exc_info()[2]
895 finally:
896 self.ftp.cwd(pwd)
897 cmd = 'LIST ' + file
898 else:
899 cmd = 'LIST'
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000900 conn = self.ftp.ntransfercmd(cmd)
901 self.busy = 1
902 # Pass back both a suitably decorated object and a retrieval length
903 return (addclosehook(conn[0].makefile('rb'),
Fredrik Lundhb49f88b2000-09-24 18:51:25 +0000904 self.endtransfer), conn[1])
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000905 def endtransfer(self):
906 if not self.busy:
907 return
908 self.busy = 0
909 try:
910 self.ftp.voidresp()
911 except ftperrors():
912 pass
Guido van Rossume7b146f2000-02-04 15:28:42 +0000913
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000914 def close(self):
915 self.endtransfer()
916 try:
917 self.ftp.close()
918 except ftperrors():
919 pass
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000920
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000921class addbase:
Guido van Rossume7b146f2000-02-04 15:28:42 +0000922 """Base class for addinfo and addclosehook."""
923
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000924 def __init__(self, fp):
925 self.fp = fp
926 self.read = self.fp.read
927 self.readline = self.fp.readline
Guido van Rossum09c8b6c1999-12-07 21:37:17 +0000928 if hasattr(self.fp, "readlines"): self.readlines = self.fp.readlines
Georg Brandl1f663572005-11-26 16:50:44 +0000929 if hasattr(self.fp, "fileno"):
930 self.fileno = self.fp.fileno
931 else:
932 self.fileno = lambda: None
Raymond Hettinger42182eb2003-03-09 05:33:33 +0000933 if hasattr(self.fp, "__iter__"):
934 self.__iter__ = self.fp.__iter__
935 if hasattr(self.fp, "next"):
936 self.next = self.fp.next
Guido van Rossume7b146f2000-02-04 15:28:42 +0000937
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000938 def __repr__(self):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000939 return '<%s at %r whose fp = %r>' % (self.__class__.__name__,
940 id(self), self.fp)
Guido van Rossume7b146f2000-02-04 15:28:42 +0000941
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000942 def close(self):
943 self.read = None
944 self.readline = None
945 self.readlines = None
946 self.fileno = None
947 if self.fp: self.fp.close()
948 self.fp = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000949
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000950class addclosehook(addbase):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000951 """Class to add a close hook to an open file."""
952
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000953 def __init__(self, fp, closehook, *hookargs):
954 addbase.__init__(self, fp)
955 self.closehook = closehook
956 self.hookargs = hookargs
Guido van Rossume7b146f2000-02-04 15:28:42 +0000957
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000958 def close(self):
Guido van Rossumc580dae2000-05-24 13:21:46 +0000959 addbase.close(self)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000960 if self.closehook:
Guido van Rossum68468eb2003-02-27 20:14:51 +0000961 self.closehook(*self.hookargs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000962 self.closehook = None
963 self.hookargs = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000964
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000965class addinfo(addbase):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000966 """class to add an info() method to an open file."""
967
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000968 def __init__(self, fp, headers):
969 addbase.__init__(self, fp)
970 self.headers = headers
Guido van Rossume7b146f2000-02-04 15:28:42 +0000971
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000972 def info(self):
973 return self.headers
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000974
Guido van Rossume6ad8911996-09-10 17:02:56 +0000975class addinfourl(addbase):
Guido van Rossume7b146f2000-02-04 15:28:42 +0000976 """class to add info() and geturl() methods to an open file."""
977
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000978 def __init__(self, fp, headers, url, code=None):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000979 addbase.__init__(self, fp)
980 self.headers = headers
981 self.url = url
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000982 self.code = code
Guido van Rossume7b146f2000-02-04 15:28:42 +0000983
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000984 def info(self):
985 return self.headers
Guido van Rossume7b146f2000-02-04 15:28:42 +0000986
Georg Brandl9b0d46d2008-01-20 11:43:03 +0000987 def getcode(self):
988 return self.code
989
Jeremy Hyltonf90b0021999-02-25 16:12:12 +0000990 def geturl(self):
991 return self.url
Guido van Rossume6ad8911996-09-10 17:02:56 +0000992
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000993
Guido van Rossum7c395db1994-07-04 22:14:49 +0000994# Utilities to parse URLs (most of these return None for missing parts):
Sjoerd Mullendere0371b81995-11-10 10:36:07 +0000995# unwrap('<URL:type://host/path>') --> 'type://host/path'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +0000996# splittype('type:opaquestring') --> 'type', 'opaquestring'
997# splithost('//host[:port]/path') --> 'host[:port]', '/path'
Guido van Rossum7c395db1994-07-04 22:14:49 +0000998# splituser('user[:passwd]@host[:port]') --> 'user[:passwd]', 'host[:port]'
999# splitpasswd('user:passwd') -> 'user', 'passwd'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001000# splitport('host:port') --> 'host', 'port'
1001# splitquery('/path?query') --> '/path', 'query'
1002# splittag('/path#tag') --> '/path', 'tag'
Guido van Rossum7c395db1994-07-04 22:14:49 +00001003# splitattr('/path;attr1=value1;attr2=value2;...') ->
1004# '/path', ['attr1=value1', 'attr2=value2', ...]
1005# splitvalue('attr=value') --> 'attr', 'value'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001006# unquote('abc%20def') -> 'abc def'
1007# quote('abc def') -> 'abc%20def')
1008
Walter Dörwald65230a22002-06-03 15:58:32 +00001009try:
1010 unicode
1011except NameError:
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001012 def _is_unicode(x):
1013 return 0
Walter Dörwald65230a22002-06-03 15:58:32 +00001014else:
1015 def _is_unicode(x):
1016 return isinstance(x, unicode)
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001017
Martin v. Löwis1d994332000-12-03 18:30:10 +00001018def toBytes(url):
1019 """toBytes(u"URL") --> 'URL'."""
1020 # Most URL schemes require ASCII. If that changes, the conversion
1021 # can be relaxed
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001022 if _is_unicode(url):
Martin v. Löwis1d994332000-12-03 18:30:10 +00001023 try:
1024 url = url.encode("ASCII")
1025 except UnicodeError:
Guido van Rossumb2493f82000-12-15 15:01:37 +00001026 raise UnicodeError("URL " + repr(url) +
1027 " contains non-ASCII characters")
Martin v. Löwis1d994332000-12-03 18:30:10 +00001028 return url
1029
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001030def unwrap(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001031 """unwrap('<URL:type://host/path>') --> 'type://host/path'."""
Guido van Rossumb2493f82000-12-15 15:01:37 +00001032 url = url.strip()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001033 if url[:1] == '<' and url[-1:] == '>':
Guido van Rossumb2493f82000-12-15 15:01:37 +00001034 url = url[1:-1].strip()
1035 if url[:4] == 'URL:': url = url[4:].strip()
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001036 return url
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001037
Guido van Rossum332e1441997-09-29 23:23:46 +00001038_typeprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001039def splittype(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001040 """splittype('type:opaquestring') --> 'type', 'opaquestring'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001041 global _typeprog
1042 if _typeprog is None:
1043 import re
1044 _typeprog = re.compile('^([^/:]+):')
Guido van Rossum332e1441997-09-29 23:23:46 +00001045
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001046 match = _typeprog.match(url)
1047 if match:
1048 scheme = match.group(1)
Fred Drake9e94afd2000-07-01 07:03:30 +00001049 return scheme.lower(), url[len(scheme) + 1:]
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001050 return None, url
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001051
Guido van Rossum332e1441997-09-29 23:23:46 +00001052_hostprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001053def splithost(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001054 """splithost('//host[:port]/path') --> 'host[:port]', '/path'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001055 global _hostprog
1056 if _hostprog is None:
1057 import re
Georg Brandl1c168d82006-03-26 20:59:38 +00001058 _hostprog = re.compile('^//([^/?]*)(.*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001059
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001060 match = _hostprog.match(url)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001061 if match: return match.group(1, 2)
1062 return None, url
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001063
Guido van Rossum332e1441997-09-29 23:23:46 +00001064_userprog = None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001065def splituser(host):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001066 """splituser('user[:passwd]@host[:port]') --> 'user[:passwd]', 'host[:port]'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001067 global _userprog
1068 if _userprog is None:
1069 import re
Raymond Hettingerf2e45dd2002-08-18 20:08:56 +00001070 _userprog = re.compile('^(.*)@(.*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001071
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001072 match = _userprog.match(host)
Fred Drake567ca8e2000-08-21 21:42:42 +00001073 if match: return map(unquote, match.group(1, 2))
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001074 return None, host
Guido van Rossum7c395db1994-07-04 22:14:49 +00001075
Guido van Rossum332e1441997-09-29 23:23:46 +00001076_passwdprog = None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001077def splitpasswd(user):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001078 """splitpasswd('user:passwd') -> 'user', 'passwd'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001079 global _passwdprog
1080 if _passwdprog is None:
1081 import re
1082 _passwdprog = re.compile('^([^:]*):(.*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001083
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001084 match = _passwdprog.match(user)
1085 if match: return match.group(1, 2)
1086 return user, None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001087
Guido van Rossume7b146f2000-02-04 15:28:42 +00001088# splittag('/path#tag') --> '/path', 'tag'
Guido van Rossum332e1441997-09-29 23:23:46 +00001089_portprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001090def splitport(host):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001091 """splitport('host:port') --> 'host', 'port'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001092 global _portprog
1093 if _portprog is None:
1094 import re
1095 _portprog = re.compile('^(.*):([0-9]+)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001096
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001097 match = _portprog.match(host)
1098 if match: return match.group(1, 2)
1099 return host, None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001100
Guido van Rossum332e1441997-09-29 23:23:46 +00001101_nportprog = None
Guido van Rossum53725a21996-06-13 19:12:35 +00001102def splitnport(host, defport=-1):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001103 """Split host and port, returning numeric port.
1104 Return given default port if no ':' found; defaults to -1.
1105 Return numerical port if a valid number are found after ':'.
1106 Return None if ':' but not a valid number."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001107 global _nportprog
1108 if _nportprog is None:
1109 import re
1110 _nportprog = re.compile('^(.*):(.*)$')
Guido van Rossum7e7ca0b1998-03-26 21:01:39 +00001111
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001112 match = _nportprog.match(host)
1113 if match:
1114 host, port = match.group(1, 2)
1115 try:
Guido van Rossumb2493f82000-12-15 15:01:37 +00001116 if not port: raise ValueError, "no digits"
1117 nport = int(port)
1118 except ValueError:
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001119 nport = None
1120 return host, nport
1121 return host, defport
Guido van Rossum53725a21996-06-13 19:12:35 +00001122
Guido van Rossum332e1441997-09-29 23:23:46 +00001123_queryprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001124def splitquery(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001125 """splitquery('/path?query') --> '/path', 'query'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001126 global _queryprog
1127 if _queryprog is None:
1128 import re
1129 _queryprog = re.compile('^(.*)\?([^?]*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001130
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001131 match = _queryprog.match(url)
1132 if match: return match.group(1, 2)
1133 return url, None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001134
Guido van Rossum332e1441997-09-29 23:23:46 +00001135_tagprog = None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001136def splittag(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001137 """splittag('/path#tag') --> '/path', 'tag'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001138 global _tagprog
1139 if _tagprog is None:
1140 import re
1141 _tagprog = re.compile('^(.*)#([^#]*)$')
Guido van Rossum7e7ca0b1998-03-26 21:01:39 +00001142
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001143 match = _tagprog.match(url)
1144 if match: return match.group(1, 2)
1145 return url, None
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001146
Guido van Rossum7c395db1994-07-04 22:14:49 +00001147def splitattr(url):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001148 """splitattr('/path;attr1=value1;attr2=value2;...') ->
1149 '/path', ['attr1=value1', 'attr2=value2', ...]."""
Guido van Rossumb2493f82000-12-15 15:01:37 +00001150 words = url.split(';')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001151 return words[0], words[1:]
Guido van Rossum7c395db1994-07-04 22:14:49 +00001152
Guido van Rossum332e1441997-09-29 23:23:46 +00001153_valueprog = None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001154def splitvalue(attr):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001155 """splitvalue('attr=value') --> 'attr', 'value'."""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001156 global _valueprog
1157 if _valueprog is None:
1158 import re
1159 _valueprog = re.compile('^([^=]*)=(.*)$')
Guido van Rossum332e1441997-09-29 23:23:46 +00001160
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001161 match = _valueprog.match(attr)
1162 if match: return match.group(1, 2)
1163 return attr, None
Guido van Rossum7c395db1994-07-04 22:14:49 +00001164
Senthil Kumaran34f92772010-03-29 19:30:44 +00001165_hexdig = '0123456789ABCDEFabcdef'
1166_hextochr = dict((a+b, chr(int(a+b,16))) for a in _hexdig for b in _hexdig)
Raymond Hettinger803ce802005-09-10 06:49:04 +00001167
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001168def unquote(s):
Guido van Rossume7b146f2000-02-04 15:28:42 +00001169 """unquote('abc%20def') -> 'abc def'."""
Raymond Hettinger803ce802005-09-10 06:49:04 +00001170 res = s.split('%')
1171 for i in xrange(1, len(res)):
1172 item = res[i]
1173 try:
1174 res[i] = _hextochr[item[:2]] + item[2:]
1175 except KeyError:
1176 res[i] = '%' + item
Raymond Hettinger4b0f20d2005-10-15 16:41:53 +00001177 except UnicodeDecodeError:
1178 res[i] = unichr(int(item[:2], 16)) + item[2:]
Guido van Rossumb2493f82000-12-15 15:01:37 +00001179 return "".join(res)
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001180
Guido van Rossum0564e121996-12-13 14:47:36 +00001181def unquote_plus(s):
Skip Montanaro79f1c172000-08-22 03:00:52 +00001182 """unquote('%7e/abc+def') -> '~/abc def'"""
Brett Cannonaaeffaf2004-03-23 23:50:17 +00001183 s = s.replace('+', ' ')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001184 return unquote(s)
Guido van Rossum0564e121996-12-13 14:47:36 +00001185
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001186always_safe = ('ABCDEFGHIJKLMNOPQRSTUVWXYZ'
Jeremy Hylton6102e292000-08-31 15:48:10 +00001187 'abcdefghijklmnopqrstuvwxyz'
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001188 '0123456789' '_.-')
Raymond Hettinger199d2f72005-09-09 22:27:13 +00001189_safemaps = {}
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001190
Guido van Rossum7c395db1994-07-04 22:14:49 +00001191def quote(s, safe = '/'):
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001192 """quote('abc def') -> 'abc%20def'
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001193
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001194 Each part of a URL, e.g. the path info, the query, etc., has a
1195 different set of reserved characters that must be quoted.
1196
1197 RFC 2396 Uniform Resource Identifiers (URI): Generic Syntax lists
1198 the following reserved characters.
1199
1200 reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
1201 "$" | ","
1202
1203 Each of these characters is reserved in some component of a URL,
1204 but not necessarily in all of them.
1205
1206 By default, the quote function is intended for quoting the path
1207 section of a URL. Thus, it will not encode '/'. This character
1208 is reserved, but in typical usage the quote function is being
1209 called on a path where the existing slash characters are used as
1210 reserved characters.
1211 """
Raymond Hettinger199d2f72005-09-09 22:27:13 +00001212 cachekey = (safe, always_safe)
1213 try:
1214 safe_map = _safemaps[cachekey]
1215 except KeyError:
1216 safe += always_safe
1217 safe_map = {}
1218 for i in range(256):
1219 c = chr(i)
1220 safe_map[c] = (c in safe) and c or ('%%%02X' % i)
1221 _safemaps[cachekey] = safe_map
1222 res = map(safe_map.__getitem__, s)
Guido van Rossumb2493f82000-12-15 15:01:37 +00001223 return ''.join(res)
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001224
Jeremy Hylton7ae51bf2000-09-14 16:59:07 +00001225def quote_plus(s, safe = ''):
1226 """Quote the query fragment of a URL; replacing ' ' with '+'"""
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001227 if ' ' in s:
Raymond Hettingercf6b6322005-09-10 18:17:54 +00001228 s = quote(s, safe + ' ')
1229 return s.replace(' ', '+')
1230 return quote(s, safe)
Guido van Rossum0564e121996-12-13 14:47:36 +00001231
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001232def urlencode(query,doseq=0):
1233 """Encode a sequence of two-element tuples or dictionary into a URL query string.
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001234
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001235 If any values in the query arg are sequences and doseq is true, each
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001236 sequence element is converted to a separate parameter.
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001237
1238 If the query arg is a sequence of two-element tuples, the order of the
1239 parameters in the output will match the order of parameters in the
1240 input.
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001241 """
Tim Peters658cba62001-02-09 20:06:00 +00001242
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001243 if hasattr(query,"items"):
1244 # mapping objects
1245 query = query.items()
1246 else:
1247 # it's a bother at times that strings and string-like objects are
1248 # sequences...
1249 try:
1250 # non-sequence items should not work with len()
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001251 # non-empty strings will fail this
Walter Dörwald65230a22002-06-03 15:58:32 +00001252 if len(query) and not isinstance(query[0], tuple):
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001253 raise TypeError
1254 # zero-length sequences of all types will get here and succeed,
1255 # but that's a minor nit - since the original implementation
1256 # allowed empty dicts that type of behavior probably should be
1257 # preserved for consistency
1258 except TypeError:
1259 ty,va,tb = sys.exc_info()
1260 raise TypeError, "not a valid non-string sequence or mapping object", tb
1261
Guido van Rossume7b146f2000-02-04 15:28:42 +00001262 l = []
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001263 if not doseq:
1264 # preserve old behavior
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001265 for k, v in query:
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001266 k = quote_plus(str(k))
1267 v = quote_plus(str(v))
1268 l.append(k + '=' + v)
1269 else:
Skip Montanaro14f1ad42001-01-28 21:11:12 +00001270 for k, v in query:
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001271 k = quote_plus(str(k))
Walter Dörwald65230a22002-06-03 15:58:32 +00001272 if isinstance(v, str):
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001273 v = quote_plus(v)
1274 l.append(k + '=' + v)
Guido van Rossum4b46c0a2002-05-24 17:58:05 +00001275 elif _is_unicode(v):
Skip Montanaroa5d23a12001-01-20 15:56:39 +00001276 # is there a reasonable way to convert to ASCII?
1277 # encode generates a string, but "replace" or "ignore"
1278 # lose information and "strict" can raise UnicodeError
1279 v = quote_plus(v.encode("ASCII","replace"))
1280 l.append(k + '=' + v)
1281 else:
1282 try:
1283 # is this a sufficient test for sequence-ness?
1284 x = len(v)
1285 except TypeError:
1286 # not a sequence
1287 v = quote_plus(str(v))
1288 l.append(k + '=' + v)
1289 else:
1290 # loop over the sequence
1291 for elt in v:
1292 l.append(k + '=' + quote_plus(str(elt)))
Guido van Rossumb2493f82000-12-15 15:01:37 +00001293 return '&'.join(l)
Guido van Rossum810a3391998-07-22 21:33:23 +00001294
Guido van Rossum442e7201996-03-20 15:33:11 +00001295# Proxy handling
Mark Hammond4f570b92000-07-26 07:04:38 +00001296def getproxies_environment():
1297 """Return a dictionary of scheme -> proxy server URL mappings.
1298
1299 Scan the environment for variables named <scheme>_proxy;
1300 this seems to be the standard convention. If you need a
1301 different way, you can pass a proxies dictionary to the
1302 [Fancy]URLopener constructor.
1303
1304 """
1305 proxies = {}
1306 for name, value in os.environ.items():
Guido van Rossumb2493f82000-12-15 15:01:37 +00001307 name = name.lower()
Mark Hammond4f570b92000-07-26 07:04:38 +00001308 if value and name[-6:] == '_proxy':
1309 proxies[name[:-6]] = value
1310 return proxies
1311
Georg Brandl22350112008-01-20 12:05:43 +00001312def proxy_bypass_environment(host):
1313 """Test if proxies should not be used for a particular host.
1314
1315 Checks the environment for a variable named no_proxy, which should
1316 be a list of DNS suffixes separated by commas, or '*' for all hosts.
1317 """
1318 no_proxy = os.environ.get('no_proxy', '') or os.environ.get('NO_PROXY', '')
1319 # '*' is special case for always bypass
1320 if no_proxy == '*':
1321 return 1
1322 # strip port off host
1323 hostonly, port = splitport(host)
1324 # check if the host ends with any of the DNS suffixes
1325 for name in no_proxy.split(','):
1326 if name and (hostonly.endswith(name) or host.endswith(name)):
1327 return 1
1328 # otherwise, don't bypass
1329 return 0
1330
1331
Jack Jansen11d9b062004-07-16 11:45:00 +00001332if sys.platform == 'darwin':
Ronald Oussoren40617a82009-09-20 10:37:33 +00001333 from _scproxy import _get_proxy_settings, _get_proxies
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001334
1335 def proxy_bypass_macosx_sysconf(host):
1336 """
1337 Return True iff this host shouldn't be accessed using a proxy
1338
1339 This function uses the MacOSX framework SystemConfiguration
1340 to fetch the proxy information.
1341 """
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001342 import re
1343 import socket
1344 from fnmatch import fnmatch
1345
Ronald Oussorenc1bde6e2009-10-18 07:08:27 +00001346 hostonly, port = splitport(host)
1347
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001348 def ip2num(ipAddr):
1349 parts = ipAddr.split('.')
1350 parts = map(int, parts)
1351 if len(parts) != 4:
1352 parts = (parts + [0, 0, 0, 0])[:4]
1353 return (parts[0] << 24) | (parts[1] << 16) | (parts[2] << 8) | parts[3]
1354
Ronald Oussoren40617a82009-09-20 10:37:33 +00001355 proxy_settings = _get_proxy_settings()
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001356
Ronald Oussoren40617a82009-09-20 10:37:33 +00001357 # Check for simple host names:
1358 if '.' not in host:
1359 if proxy_settings['exclude_simple']:
1360 return True
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001361
Ronald Oussorenc1bde6e2009-10-18 07:08:27 +00001362 hostIP = None
1363
Ronald Oussoren78974df2009-09-20 10:54:47 +00001364 for value in proxy_settings.get('exceptions', ()):
Ronald Oussoren40617a82009-09-20 10:37:33 +00001365 # Items in the list are strings like these: *.local, 169.254/16
Ronald Oussoren40617a82009-09-20 10:37:33 +00001366 if not value: continue
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001367
Ronald Oussoren40617a82009-09-20 10:37:33 +00001368 m = re.match(r"(\d+(?:\.\d+)*)(/\d+)?", value)
1369 if m is not None:
1370 if hostIP is None:
Ronald Oussorenc1bde6e2009-10-18 07:08:27 +00001371 try:
1372 hostIP = socket.gethostbyname(hostonly)
1373 hostIP = ip2num(hostIP)
1374 except socket.error:
1375 continue
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001376
Ronald Oussoren40617a82009-09-20 10:37:33 +00001377 base = ip2num(m.group(1))
1378 mask = int(m.group(2)[1:])
1379 mask = 32 - mask
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001380
Ronald Oussoren40617a82009-09-20 10:37:33 +00001381 if (hostIP >> mask) == (base >> mask):
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001382 return True
1383
Ronald Oussoren40617a82009-09-20 10:37:33 +00001384 elif fnmatch(host, value):
1385 return True
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001386
Ronald Oussoren40617a82009-09-20 10:37:33 +00001387 return False
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001388
1389
1390 def getproxies_macosx_sysconf():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001391 """Return a dictionary of scheme -> proxy server URL mappings.
Guido van Rossum442e7201996-03-20 15:33:11 +00001392
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001393 This function uses the MacOSX framework SystemConfiguration
1394 to fetch the proxy information.
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001395 """
Ronald Oussoren40617a82009-09-20 10:37:33 +00001396 return _get_proxies()
Mark Hammond4f570b92000-07-26 07:04:38 +00001397
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001398
1399
Georg Brandl22350112008-01-20 12:05:43 +00001400 def proxy_bypass(host):
1401 if getproxies_environment():
1402 return proxy_bypass_environment(host)
1403 else:
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001404 return proxy_bypass_macosx_sysconf(host)
Tim Peters55c12d42001-08-09 18:04:14 +00001405
Jack Jansen11d9b062004-07-16 11:45:00 +00001406 def getproxies():
Ronald Oussoren9dd6b1d2008-05-12 11:31:05 +00001407 return getproxies_environment() or getproxies_macosx_sysconf()
Tim Peters182b5ac2004-07-18 06:16:08 +00001408
Mark Hammond4f570b92000-07-26 07:04:38 +00001409elif os.name == 'nt':
1410 def getproxies_registry():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001411 """Return a dictionary of scheme -> proxy server URL mappings.
Mark Hammond4f570b92000-07-26 07:04:38 +00001412
1413 Win32 uses the registry to store proxies.
1414
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001415 """
1416 proxies = {}
Mark Hammond4f570b92000-07-26 07:04:38 +00001417 try:
1418 import _winreg
1419 except ImportError:
1420 # Std module, so should be around - but you never know!
1421 return proxies
1422 try:
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001423 internetSettings = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER,
1424 r'Software\Microsoft\Windows\CurrentVersion\Internet Settings')
Mark Hammond4f570b92000-07-26 07:04:38 +00001425 proxyEnable = _winreg.QueryValueEx(internetSettings,
1426 'ProxyEnable')[0]
1427 if proxyEnable:
1428 # Returned as Unicode but problems if not converted to ASCII
1429 proxyServer = str(_winreg.QueryValueEx(internetSettings,
1430 'ProxyServer')[0])
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001431 if '=' in proxyServer:
1432 # Per-protocol settings
Mark Hammond4f570b92000-07-26 07:04:38 +00001433 for p in proxyServer.split(';'):
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001434 protocol, address = p.split('=', 1)
Guido van Rossumb955d6c2002-03-31 23:38:48 +00001435 # See if address has a type:// prefix
Guido van Rossum64e5aa92002-04-02 14:38:16 +00001436 import re
1437 if not re.match('^([^/:]+)://', address):
Guido van Rossumb955d6c2002-03-31 23:38:48 +00001438 address = '%s://%s' % (protocol, address)
1439 proxies[protocol] = address
Fredrik Lundhb49f88b2000-09-24 18:51:25 +00001440 else:
1441 # Use one setting for all protocols
1442 if proxyServer[:5] == 'http:':
1443 proxies['http'] = proxyServer
1444 else:
1445 proxies['http'] = 'http://%s' % proxyServer
1446 proxies['ftp'] = 'ftp://%s' % proxyServer
Mark Hammond4f570b92000-07-26 07:04:38 +00001447 internetSettings.Close()
1448 except (WindowsError, ValueError, TypeError):
1449 # Either registry key not found etc, or the value in an
1450 # unexpected format.
1451 # proxies already set up to be empty so nothing to do
1452 pass
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001453 return proxies
Guido van Rossum442e7201996-03-20 15:33:11 +00001454
Mark Hammond4f570b92000-07-26 07:04:38 +00001455 def getproxies():
1456 """Return a dictionary of scheme -> proxy server URL mappings.
1457
1458 Returns settings gathered from the environment, if specified,
1459 or the registry.
1460
1461 """
1462 return getproxies_environment() or getproxies_registry()
Tim Peters55c12d42001-08-09 18:04:14 +00001463
Georg Brandl22350112008-01-20 12:05:43 +00001464 def proxy_bypass_registry(host):
Tim Peters55c12d42001-08-09 18:04:14 +00001465 try:
1466 import _winreg
1467 import re
Tim Peters55c12d42001-08-09 18:04:14 +00001468 except ImportError:
1469 # Std modules, so should be around - but you never know!
1470 return 0
1471 try:
1472 internetSettings = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER,
1473 r'Software\Microsoft\Windows\CurrentVersion\Internet Settings')
1474 proxyEnable = _winreg.QueryValueEx(internetSettings,
1475 'ProxyEnable')[0]
1476 proxyOverride = str(_winreg.QueryValueEx(internetSettings,
1477 'ProxyOverride')[0])
1478 # ^^^^ Returned as Unicode but problems if not converted to ASCII
1479 except WindowsError:
1480 return 0
1481 if not proxyEnable or not proxyOverride:
1482 return 0
1483 # try to make a host list from name and IP address.
Georg Brandl1f636702006-02-18 23:10:23 +00001484 rawHost, port = splitport(host)
1485 host = [rawHost]
Tim Peters55c12d42001-08-09 18:04:14 +00001486 try:
Georg Brandl1f636702006-02-18 23:10:23 +00001487 addr = socket.gethostbyname(rawHost)
1488 if addr != rawHost:
Tim Peters55c12d42001-08-09 18:04:14 +00001489 host.append(addr)
1490 except socket.error:
1491 pass
Georg Brandl1f636702006-02-18 23:10:23 +00001492 try:
1493 fqdn = socket.getfqdn(rawHost)
1494 if fqdn != rawHost:
1495 host.append(fqdn)
1496 except socket.error:
1497 pass
Tim Peters55c12d42001-08-09 18:04:14 +00001498 # make a check value list from the registry entry: replace the
1499 # '<local>' string by the localhost entry and the corresponding
1500 # canonical entry.
1501 proxyOverride = proxyOverride.split(';')
1502 i = 0
1503 while i < len(proxyOverride):
1504 if proxyOverride[i] == '<local>':
1505 proxyOverride[i:i+1] = ['localhost',
1506 '127.0.0.1',
1507 socket.gethostname(),
1508 socket.gethostbyname(
1509 socket.gethostname())]
1510 i += 1
1511 # print proxyOverride
1512 # now check if we match one of the registry values.
1513 for test in proxyOverride:
Tim Petersab9ba272001-08-09 21:40:30 +00001514 test = test.replace(".", r"\.") # mask dots
1515 test = test.replace("*", r".*") # change glob sequence
1516 test = test.replace("?", r".") # change glob char
Tim Peters55c12d42001-08-09 18:04:14 +00001517 for val in host:
1518 # print "%s <--> %s" %( test, val )
1519 if re.match(test, val, re.I):
1520 return 1
1521 return 0
1522
Georg Brandl22350112008-01-20 12:05:43 +00001523 def proxy_bypass(host):
1524 """Return a dictionary of scheme -> proxy server URL mappings.
1525
1526 Returns settings gathered from the environment, if specified,
1527 or the registry.
1528
1529 """
1530 if getproxies_environment():
1531 return proxy_bypass_environment(host)
1532 else:
1533 return proxy_bypass_registry(host)
1534
Mark Hammond4f570b92000-07-26 07:04:38 +00001535else:
1536 # By default use environment variables
1537 getproxies = getproxies_environment
Georg Brandl22350112008-01-20 12:05:43 +00001538 proxy_bypass = proxy_bypass_environment
Guido van Rossum442e7201996-03-20 15:33:11 +00001539
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001540# Test and time quote() and unquote()
1541def test1():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001542 s = ''
1543 for i in range(256): s = s + chr(i)
1544 s = s*4
1545 t0 = time.time()
1546 qs = quote(s)
1547 uqs = unquote(qs)
1548 t1 = time.time()
1549 if uqs != s:
1550 print 'Wrong!'
Walter Dörwald70a6b492004-02-12 17:35:32 +00001551 print repr(s)
1552 print repr(qs)
1553 print repr(uqs)
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001554 print round(t1 - t0, 3), 'sec'
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001555
1556
Guido van Rossum9ab96d41998-09-28 14:07:00 +00001557def reporthook(blocknum, blocksize, totalsize):
1558 # Report during remote transfers
Guido van Rossumb2493f82000-12-15 15:01:37 +00001559 print "Block number: %d, Block size: %d, Total size: %d" % (
1560 blocknum, blocksize, totalsize)
Guido van Rossum9ab96d41998-09-28 14:07:00 +00001561
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001562# Test program
Guido van Rossum23490151998-06-25 02:39:00 +00001563def test(args=[]):
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001564 if not args:
1565 args = [
1566 '/etc/passwd',
1567 'file:/etc/passwd',
1568 'file://localhost/etc/passwd',
Collin Winter071d1ae2007-03-12 01:55:54 +00001569 'ftp://ftp.gnu.org/pub/README',
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001570 'http://www.python.org/index.html',
1571 ]
Guido van Rossum09c8b6c1999-12-07 21:37:17 +00001572 if hasattr(URLopener, "open_https"):
1573 args.append('https://synergy.as.cmu.edu/~geek/')
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001574 try:
1575 for url in args:
1576 print '-'*10, url, '-'*10
1577 fn, h = urlretrieve(url, None, reporthook)
Guido van Rossumb2493f82000-12-15 15:01:37 +00001578 print fn
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001579 if h:
1580 print '======'
1581 for k in h.keys(): print k + ':', h[k]
1582 print '======'
1583 fp = open(fn, 'rb')
1584 data = fp.read()
1585 del fp
1586 if '\r' in data:
1587 table = string.maketrans("", "")
Guido van Rossumb2493f82000-12-15 15:01:37 +00001588 data = data.translate(table, "\r")
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001589 print data
1590 fn, h = None, None
1591 print '-'*40
1592 finally:
1593 urlcleanup()
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001594
Guido van Rossum23490151998-06-25 02:39:00 +00001595def main():
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001596 import getopt, sys
1597 try:
1598 opts, args = getopt.getopt(sys.argv[1:], "th")
1599 except getopt.error, msg:
1600 print msg
1601 print "Use -h for help"
1602 return
1603 t = 0
1604 for o, a in opts:
1605 if o == '-t':
1606 t = t + 1
1607 if o == '-h':
1608 print "Usage: python urllib.py [-t] [url ...]"
1609 print "-t runs self-test;",
1610 print "otherwise, contents of urls are printed"
1611 return
1612 if t:
1613 if t > 1:
1614 test1()
1615 test(args)
1616 else:
1617 if not args:
1618 print "Use -h for help"
1619 for url in args:
1620 print urlopen(url).read(),
Guido van Rossum23490151998-06-25 02:39:00 +00001621
Guido van Rossum7c6ebb51994-03-22 12:05:32 +00001622# Run test program when run as a script
1623if __name__ == '__main__':
Jeremy Hyltonf90b0021999-02-25 16:12:12 +00001624 main()