url.py
540 lines
| 18.9 KiB
| text/x-python
|
PythonLexer
/ mercurial / url.py
|
r7270 | # url.py - HTTP handling for mercurial | ||
# | ||||
# Copyright 2005, 2006, 2007, 2008 Matt Mackall <mpm@selenic.com> | ||||
# Copyright 2006, 2007 Alexis S. L. Carvalho <alexis@cecm.usp.br> | ||||
# Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com> | ||||
# | ||||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r7270 | |||
|
r25990 | from __future__ import absolute_import | ||
import base64 | ||||
import os | ||||
import socket | ||||
from .i18n import _ | ||||
from . import ( | ||||
|
r30820 | encoding, | ||
|
r26587 | error, | ||
|
r25990 | httpconnection as httpconnectionmod, | ||
keepalive, | ||||
|
r34429 | pycompat, | ||
|
r25990 | sslutil, | ||
|
r34467 | urllibcompat, | ||
|
r25990 | util, | ||
) | ||||
|
r29455 | |||
httplib = util.httplib | ||||
|
r28861 | stringio = util.stringio | ||
|
r28883 | urlerr = util.urlerr | ||
urlreq = util.urlreq | ||||
|
r34695 | def escape(s, quote=None): | ||
'''Replace special characters "&", "<" and ">" to HTML-safe sequences. | ||||
If the optional flag quote is true, the quotation mark character (") | ||||
is also translated. | ||||
This is the same as cgi.escape in Python, but always operates on | ||||
bytes, whereas cgi.escape in Python 3 only works on unicodes. | ||||
''' | ||||
s = s.replace(b"&", b"&") | ||||
s = s.replace(b"<", b"<") | ||||
s = s.replace(b">", b">") | ||||
if quote: | ||||
s = s.replace(b'"', b""") | ||||
return s | ||||
|
r29377 | class passwordmgr(object): | ||
def __init__(self, ui, passwddb): | ||||
|
r7270 | self.ui = ui | ||
|
r29377 | self.passwddb = passwddb | ||
def add_password(self, realm, uri, user, passwd): | ||||
return self.passwddb.add_password(realm, uri, user, passwd) | ||||
|
r7270 | |||
def find_user_password(self, realm, authuri): | ||||
|
r29377 | authinfo = self.passwddb.find_user_password(realm, authuri) | ||
|
r7270 | user, passwd = authinfo | ||
if user and passwd: | ||||
|
r8333 | self._writedebug(user, passwd) | ||
|
r7270 | return (user, passwd) | ||
|
r15005 | if not user or not passwd: | ||
|
r15025 | res = httpconnectionmod.readauthforuri(self.ui, authuri, user) | ||
|
r13372 | if res: | ||
group, auth = res | ||||
|
r8847 | user, passwd = auth.get('username'), auth.get('password') | ||
|
r13372 | self.ui.debug("using auth.%s.* for authentication\n" % group) | ||
|
r8333 | if not user or not passwd: | ||
|
r20291 | u = util.url(authuri) | ||
u.query = None | ||||
|
r8333 | if not self.ui.interactive(): | ||
|
r26587 | raise error.Abort(_('http authorization required for %s') % | ||
|
r20291 | util.hidepassword(str(u))) | ||
|
r7270 | |||
|
r20291 | self.ui.write(_("http authorization required for %s\n") % | ||
util.hidepassword(str(u))) | ||||
|
r12862 | self.ui.write(_("realm: %s\n") % realm) | ||
|
r8333 | if user: | ||
|
r12862 | self.ui.write(_("user: %s\n") % user) | ||
|
r8333 | else: | ||
user = self.ui.prompt(_("user:"), default=None) | ||||
|
r7270 | |||
|
r8333 | if not passwd: | ||
passwd = self.ui.getpass() | ||||
|
r7270 | |||
|
r29377 | self.passwddb.add_password(realm, authuri, user, passwd) | ||
|
r8333 | self._writedebug(user, passwd) | ||
|
r7270 | return (user, passwd) | ||
|
r8333 | def _writedebug(self, user, passwd): | ||
msg = _('http auth: user %s, password %s\n') | ||||
self.ui.debug(msg % (user, passwd and '*' * len(passwd) or 'not set')) | ||||
|
r15025 | def find_stored_password(self, authuri): | ||
|
r29377 | return self.passwddb.find_user_password(None, authuri) | ||
|
r15025 | |||
|
r28883 | class proxyhandler(urlreq.proxyhandler): | ||
|
r7270 | def __init__(self, ui): | ||
|
r30664 | proxyurl = (ui.config("http_proxy", "host") or | ||
|
r30820 | encoding.environ.get('http_proxy')) | ||
|
r7270 | # XXX proxyauthinfo = None | ||
if proxyurl: | ||||
# proxy can be proper url or host[:port] | ||||
if not (proxyurl.startswith('http:') or | ||||
proxyurl.startswith('https:')): | ||||
proxyurl = 'http://' + proxyurl + '/' | ||||
|
r14076 | proxy = util.url(proxyurl) | ||
|
r13820 | if not proxy.user: | ||
proxy.user = ui.config("http_proxy", "user") | ||||
proxy.passwd = ui.config("http_proxy", "passwd") | ||||
|
r7270 | |||
# see if we should use a proxy for this url | ||||
|
r10282 | no_list = ["localhost", "127.0.0.1"] | ||
|
r7270 | no_list.extend([p.lower() for | ||
p in ui.configlist("http_proxy", "no")]) | ||||
no_list.extend([p.strip().lower() for | ||||
|
r30820 | p in encoding.environ.get("no_proxy", '').split(',') | ||
|
r7270 | if p.strip()]) | ||
# "http_proxy.always" config is for running tests on localhost | ||||
if ui.configbool("http_proxy", "always"): | ||||
self.no_list = [] | ||||
else: | ||||
self.no_list = no_list | ||||
|
r13820 | proxyurl = str(proxy) | ||
|
r7270 | proxies = {'http': proxyurl, 'https': proxyurl} | ||
|
r9467 | ui.debug('proxying through http://%s:%s\n' % | ||
|
r13820 | (proxy.host, proxy.port)) | ||
|
r7270 | else: | ||
proxies = {} | ||||
|
r28883 | urlreq.proxyhandler.__init__(self, proxies) | ||
|
r7270 | self.ui = ui | ||
def proxy_open(self, req, proxy, type_): | ||||
|
r34467 | host = urllibcompat.gethost(req).split(':')[0] | ||
|
r19535 | for e in self.no_list: | ||
if host == e: | ||||
return None | ||||
if e.startswith('*.') and host.endswith(e[2:]): | ||||
return None | ||||
if e.startswith('.') and host.endswith(e[1:]): | ||||
return None | ||||
|
r7270 | |||
|
r28883 | return urlreq.proxyhandler.proxy_open(self, req, proxy, type_) | ||
|
r7270 | |||
|
r13420 | def _gen_sendfile(orgsend): | ||
|
r7270 | def _sendfile(self, data): | ||
# send a file | ||||
|
r14244 | if isinstance(data, httpconnectionmod.httpsendfile): | ||
|
r7270 | # if auth required, some data sent twice, so rewind here | ||
data.seek(0) | ||||
for chunk in util.filechunkiter(data): | ||||
|
r13420 | orgsend(self, chunk) | ||
|
r7270 | else: | ||
|
r13420 | orgsend(self, data) | ||
|
r7270 | return _sendfile | ||
|
r28883 | has_https = util.safehasattr(urlreq, 'httpshandler') | ||
|
r10409 | |||
|
r7270 | class httpconnection(keepalive.HTTPConnection): | ||
# must be able to send big bundle as stream. | ||||
|
r13420 | send = _gen_sendfile(keepalive.HTTPConnection.send) | ||
|
r7270 | |||
|
r8590 | def getresponse(self): | ||
proxyres = getattr(self, 'proxyres', None) | ||||
if proxyres: | ||||
if proxyres.will_close: | ||||
self.close() | ||||
self.proxyres = None | ||||
return proxyres | ||||
return keepalive.HTTPConnection.getresponse(self) | ||||
|
r9852 | # general transaction handler to support different ways to handle | ||
# HTTPS proxying before and after Python 2.6.3. | ||||
def _generic_start_transaction(handler, h, req): | ||||
|
r14964 | tunnel_host = getattr(req, '_tunnel_host', None) | ||
if tunnel_host: | ||||
|
r9852 | if tunnel_host[:7] not in ['http://', 'https:/']: | ||
tunnel_host = 'https://' + tunnel_host | ||||
new_tunnel = True | ||||
else: | ||||
|
r34467 | tunnel_host = urllibcompat.getselector(req) | ||
|
r9852 | new_tunnel = False | ||
|
r34467 | if new_tunnel or tunnel_host == urllibcompat.getfullurl(req): # has proxy | ||
|
r14076 | u = util.url(tunnel_host) | ||
|
r13820 | if new_tunnel or u.scheme == 'https': # only use CONNECT for HTTPS | ||
h.realhostport = ':'.join([u.host, (u.port or '443')]) | ||||
|
r9852 | h.headers = req.headers.copy() | ||
h.headers.update(handler.parent.addheaders) | ||||
return | ||||
|
r10415 | h.realhostport = None | ||
|
r9852 | h.headers = None | ||
def _generic_proxytunnel(self): | ||||
proxyheaders = dict( | ||||
[(x, self.headers[x]) for x in self.headers | ||||
if x.lower().startswith('proxy-')]) | ||||
|
r10415 | self.send('CONNECT %s HTTP/1.0\r\n' % self.realhostport) | ||
|
r9852 | for header in proxyheaders.iteritems(): | ||
self.send('%s: %s\r\n' % header) | ||||
self.send('\r\n') | ||||
# majority of the following code is duplicated from | ||||
# httplib.HTTPConnection as there are no adequate places to | ||||
# override functions to provide the needed functionality | ||||
res = self.response_class(self.sock, | ||||
strict=self.strict, | ||||
method=self._method) | ||||
while True: | ||||
version, status, reason = res._read_status() | ||||
if status != httplib.CONTINUE: | ||||
break | ||||
|
r29729 | # skip lines that are all whitespace | ||
list(iter(lambda: res.fp.readline().strip(), '')) | ||||
|
r9852 | res.status = status | ||
res.reason = reason.strip() | ||||
if res.status == 200: | ||||
|
r29729 | # skip lines until we find a blank line | ||
list(iter(res.fp.readline, '\r\n')) | ||||
|
r9852 | return True | ||
if version == 'HTTP/1.0': | ||||
res.version = 10 | ||||
elif version.startswith('HTTP/1.'): | ||||
res.version = 11 | ||||
elif version == 'HTTP/0.9': | ||||
res.version = 9 | ||||
else: | ||||
raise httplib.UnknownProtocol(version) | ||||
if res.version == 9: | ||||
res.length = None | ||||
res.chunked = 0 | ||||
res.will_close = 1 | ||||
|
r28861 | res.msg = httplib.HTTPMessage(stringio()) | ||
|
r9852 | return False | ||
res.msg = httplib.HTTPMessage(res.fp) | ||||
res.msg.fp = None | ||||
# are we using the chunked-style of transfer encoding? | ||||
trenc = res.msg.getheader('transfer-encoding') | ||||
if trenc and trenc.lower() == "chunked": | ||||
res.chunked = 1 | ||||
res.chunk_left = None | ||||
else: | ||||
res.chunked = 0 | ||||
# will the connection close at the end of the response? | ||||
res.will_close = res._check_close() | ||||
# do we have a Content-Length? | ||||
|
r17428 | # NOTE: RFC 2616, section 4.4, #3 says we ignore this if | ||
# transfer-encoding is "chunked" | ||||
|
r9852 | length = res.msg.getheader('content-length') | ||
if length and not res.chunked: | ||||
try: | ||||
res.length = int(length) | ||||
except ValueError: | ||||
res.length = None | ||||
else: | ||||
if res.length < 0: # ignore nonsensical negative lengths | ||||
res.length = None | ||||
else: | ||||
res.length = None | ||||
# does the body have a fixed length? (of zero) | ||||
if (status == httplib.NO_CONTENT or status == httplib.NOT_MODIFIED or | ||||
100 <= status < 200 or # 1xx codes | ||||
res._method == 'HEAD'): | ||||
res.length = 0 | ||||
# if the connection remains open, and we aren't using chunked, and | ||||
# a content-length was not provided, then assume that the connection | ||||
# WILL close. | ||||
if (not res.will_close and | ||||
not res.chunked and | ||||
res.length is None): | ||||
res.will_close = 1 | ||||
self.proxyres = res | ||||
return False | ||||
|
r7270 | class httphandler(keepalive.HTTPHandler): | ||
def http_open(self, req): | ||||
return self.do_open(httpconnection, req) | ||||
|
r8590 | def _start_transaction(self, h, req): | ||
|
r9852 | _generic_start_transaction(self, h, req) | ||
|
r8590 | return keepalive.HTTPHandler._start_transaction(self, h, req) | ||
|
r7270 | if has_https: | ||
|
r25414 | class httpsconnection(httplib.HTTPConnection): | ||
|
r13424 | response_class = keepalive.HTTPResponse | ||
|
r25414 | default_port = httplib.HTTPS_PORT | ||
|
r13424 | # must be able to send big bundle as stream. | ||
send = _gen_sendfile(keepalive.safesend) | ||||
|
r25414 | getresponse = keepalive.wrapgetresponse(httplib.HTTPConnection) | ||
def __init__(self, host, port=None, key_file=None, cert_file=None, | ||||
*args, **kwargs): | ||||
httplib.HTTPConnection.__init__(self, host, port, *args, **kwargs) | ||||
self.key_file = key_file | ||||
self.cert_file = cert_file | ||||
|
r9726 | |||
|
r10409 | def connect(self): | ||
|
r29662 | self.sock = socket.create_connection((self.host, self.port)) | ||
|
r13422 | |||
|
r13421 | host = self.host | ||
|
r13424 | if self.realhostport: # use CONNECT proxy | ||
|
r14064 | _generic_proxytunnel(self) | ||
|
r13424 | host = self.realhostport.rsplit(':', 1)[0] | ||
|
r25429 | self.sock = sslutil.wrapsocket( | ||
|
r29248 | self.sock, self.key_file, self.cert_file, ui=self.ui, | ||
|
r29252 | serverhostname=host) | ||
|
r29227 | sslutil.validatesocket(self.sock) | ||
|
r10409 | |||
|
r28883 | class httpshandler(keepalive.KeepAliveHandler, urlreq.httpshandler): | ||
|
r8847 | def __init__(self, ui): | ||
keepalive.KeepAliveHandler.__init__(self) | ||||
|
r28883 | urlreq.httpshandler.__init__(self) | ||
|
r8847 | self.ui = ui | ||
|
r29377 | self.pwmgr = passwordmgr(self.ui, | ||
|
r29378 | self.ui.httppasswordmgrdb) | ||
|
r8847 | |||
|
r9852 | def _start_transaction(self, h, req): | ||
_generic_start_transaction(self, h, req) | ||||
return keepalive.KeepAliveHandler._start_transaction(self, h, req) | ||||
|
r7270 | def https_open(self, req): | ||
|
r34467 | # urllibcompat.getfullurl() does not contain credentials | ||
# and we may need them to match the certificates. | ||||
url = urllibcompat.getfullurl(req) | ||||
|
r15025 | user, password = self.pwmgr.find_stored_password(url) | ||
res = httpconnectionmod.readauthforuri(self.ui, url, user) | ||||
|
r13372 | if res: | ||
group, auth = res | ||||
self.auth = auth | ||||
self.ui.debug("using auth.%s.* for authentication\n" % group) | ||||
else: | ||||
self.auth = None | ||||
|
r8847 | return self.do_open(self._makeconnection, req) | ||
|
r10408 | def _makeconnection(self, host, port=None, *args, **kwargs): | ||
|
r8847 | keyfile = None | ||
certfile = None | ||||
|
r10511 | if len(args) >= 1: # key_file | ||
keyfile = args[0] | ||||
if len(args) >= 2: # cert_file | ||||
certfile = args[1] | ||||
args = args[2:] | ||||
|
r8847 | |||
# if the user has specified different key/cert files in | ||||
# hgrc, we prefer these | ||||
if self.auth and 'key' in self.auth and 'cert' in self.auth: | ||||
keyfile = self.auth['key'] | ||||
certfile = self.auth['cert'] | ||||
|
r16683 | conn = httpsconnection(host, port, keyfile, certfile, *args, | ||
**kwargs) | ||||
|
r10409 | conn.ui = self.ui | ||
return conn | ||||
|
r7270 | |||
|
r28883 | class httpdigestauthhandler(urlreq.httpdigestauthhandler): | ||
|
r11457 | def __init__(self, *args, **kwargs): | ||
|
r28883 | urlreq.httpdigestauthhandler.__init__(self, *args, **kwargs) | ||
|
r11457 | self.retried_req = None | ||
def reset_retry_count(self): | ||||
# Python 2.6.5 will call this on 401 or 407 errors and thus loop | ||||
# forever. We disable reset_retry_count completely and reset in | ||||
# http_error_auth_reqed instead. | ||||
pass | ||||
|
r7270 | def http_error_auth_reqed(self, auth_header, host, req, headers): | ||
|
r11457 | # Reset the retry counter once for each request. | ||
if req is not self.retried_req: | ||||
self.retried_req = req | ||||
self.retried = 0 | ||||
|
r28883 | return urlreq.httpdigestauthhandler.http_error_auth_reqed( | ||
|
r26806 | self, auth_header, host, req, headers) | ||
|
r7270 | |||
|
r28883 | class httpbasicauthhandler(urlreq.httpbasicauthhandler): | ||
|
r11844 | def __init__(self, *args, **kwargs): | ||
|
r20964 | self.auth = None | ||
|
r28883 | urlreq.httpbasicauthhandler.__init__(self, *args, **kwargs) | ||
|
r11844 | self.retried_req = None | ||
|
r20964 | def http_request(self, request): | ||
if self.auth: | ||||
request.add_unredirected_header(self.auth_header, self.auth) | ||||
return request | ||||
def https_request(self, request): | ||||
if self.auth: | ||||
request.add_unredirected_header(self.auth_header, self.auth) | ||||
return request | ||||
|
r11844 | def reset_retry_count(self): | ||
# Python 2.6.5 will call this on 401 or 407 errors and thus loop | ||||
# forever. We disable reset_retry_count completely and reset in | ||||
# http_error_auth_reqed instead. | ||||
pass | ||||
def http_error_auth_reqed(self, auth_header, host, req, headers): | ||||
# Reset the retry counter once for each request. | ||||
if req is not self.retried_req: | ||||
self.retried_req = req | ||||
self.retried = 0 | ||||
|
r28883 | return urlreq.httpbasicauthhandler.http_error_auth_reqed( | ||
|
r11844 | self, auth_header, host, req, headers) | ||
|
r20964 | def retry_http_basic_auth(self, host, req, realm): | ||
|
r34467 | user, pw = self.passwd.find_user_password( | ||
realm, urllibcompat.getfullurl(req)) | ||||
|
r20964 | if pw is not None: | ||
raw = "%s:%s" % (user, pw) | ||||
auth = 'Basic %s' % base64.b64encode(raw).strip() | ||||
|
r29639 | if req.get_header(self.auth_header, None) == auth: | ||
|
r20964 | return None | ||
self.auth = auth | ||||
req.add_unredirected_header(self.auth_header, auth) | ||||
return self.parent.open(req) | ||||
else: | ||||
return None | ||||
|
r31936 | class cookiehandler(urlreq.basehandler): | ||
def __init__(self, ui): | ||||
self.cookiejar = None | ||||
cookiefile = ui.config('auth', 'cookiefile') | ||||
if not cookiefile: | ||||
return | ||||
cookiefile = util.expandpath(cookiefile) | ||||
try: | ||||
cookiejar = util.cookielib.MozillaCookieJar(cookiefile) | ||||
cookiejar.load() | ||||
self.cookiejar = cookiejar | ||||
except util.cookielib.LoadError as e: | ||||
ui.warn(_('(error loading cookie file %s: %s; continuing without ' | ||||
'cookies)\n') % (cookiefile, str(e))) | ||||
def http_request(self, request): | ||||
if self.cookiejar: | ||||
self.cookiejar.add_cookie_header(request) | ||||
return request | ||||
def https_request(self, request): | ||||
if self.cookiejar: | ||||
self.cookiejar.add_cookie_header(request) | ||||
return request | ||||
|
r9347 | handlerfuncs = [] | ||
|
r35455 | def opener(ui, authinfo=None, useragent=None): | ||
|
r7270 | ''' | ||
construct an opener suitable for urllib2 | ||||
authinfo will be added to the password manager | ||||
''' | ||||
|
r25837 | # experimental config: ui.usehttp2 | ||
|
r33499 | if ui.configbool('ui', 'usehttp2'): | ||
|
r29377 | handlers = [ | ||
httpconnectionmod.http2handler( | ||||
ui, | ||||
|
r29378 | passwordmgr(ui, ui.httppasswordmgrdb)) | ||
|
r29377 | ] | ||
|
r14244 | else: | ||
handlers = [httphandler()] | ||||
if has_https: | ||||
handlers.append(httpshandler(ui)) | ||||
|
r7270 | |||
handlers.append(proxyhandler(ui)) | ||||
|
r29378 | passmgr = passwordmgr(ui, ui.httppasswordmgrdb) | ||
|
r7270 | if authinfo is not None: | ||
|
r29379 | realm, uris, user, passwd = authinfo | ||
saveduser, savedpass = passmgr.find_stored_password(uris[0]) | ||||
if user != saveduser or passwd: | ||||
passmgr.add_password(realm, uris, user, passwd) | ||||
|
r9467 | ui.debug('http auth: user %s, password %s\n' % | ||
|
r7270 | (user, passwd and '*' * len(passwd) or 'not set')) | ||
|
r11844 | handlers.extend((httpbasicauthhandler(passmgr), | ||
|
r7270 | httpdigestauthhandler(passmgr))) | ||
|
r9347 | handlers.extend([h(ui, passmgr) for h in handlerfuncs]) | ||
|
r31936 | handlers.append(cookiehandler(ui)) | ||
|
r28883 | opener = urlreq.buildopener(*handlers) | ||
|
r7270 | |||
|
r29589 | # The user agent should should *NOT* be used by servers for e.g. | ||
# protocol detection or feature negotiation: there are other | ||||
# facilities for that. | ||||
# | ||||
# "mercurial/proto-1.0" was the original user agent string and | ||||
# exists for backwards compatibility reasons. | ||||
# | ||||
# The "(Mercurial %s)" string contains the distribution | ||||
# name and version. Other client implementations should choose their | ||||
# own distribution name. Since servers should not be using the user | ||||
# agent string for anything, clients should be able to define whatever | ||||
# user agent they deem appropriate. | ||||
|
r35455 | # | ||
# The custom user agent is for lfs, because unfortunately some servers | ||||
# do look at this value. | ||||
if not useragent: | ||||
agent = 'mercurial/proto-1.0 (Mercurial %s)' % util.version() | ||||
opener.addheaders = [(r'User-agent', pycompat.sysstr(agent))] | ||||
else: | ||||
opener.addheaders = [(r'User-agent', pycompat.sysstr(useragent))] | ||||
|
r30763 | |||
# This header should only be needed by wire protocol requests. But it has | ||||
# been sent on all requests since forever. We keep sending it for backwards | ||||
# compatibility reasons. Modern versions of the wire protocol use | ||||
# X-HgProto-<N> for advertising client support. | ||||
|
r34429 | opener.addheaders.append((r'Accept', r'application/mercurial-0.1')) | ||
|
r7270 | return opener | ||
|
r13818 | def open(ui, url_, data=None): | ||
|
r14076 | u = util.url(url_) | ||
|
r13818 | if u.scheme: | ||
u.scheme = u.scheme.lower() | ||||
url_, authinfo = u.authinfo() | ||||
else: | ||||
path = util.normpath(os.path.abspath(url_)) | ||||
|
r28883 | url_ = 'file://' + urlreq.pathname2url(path) | ||
|
r7284 | authinfo = None | ||
|
r13818 | return opener(ui, authinfo).open(url_, data) | ||