httppeer.py
995 lines
| 33.4 KiB
| text/x-python
|
PythonLexer
/ mercurial / httppeer.py
|
r17192 | # httppeer.py - HTTP repository proxy classes for mercurial | ||
# | ||||
# Copyright 2005, 2006 Matt Mackall <mpm@selenic.com> | ||||
# Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com> | ||||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
# GNU General Public License version 2 or any later version. | ||||
|
r25954 | from __future__ import absolute_import | ||
import errno | ||||
|
r33820 | import io | ||
|
r25954 | import os | ||
import socket | ||||
|
r30763 | import struct | ||
|
r37669 | import weakref | ||
|
r25954 | |||
from .i18n import _ | ||||
|
r37501 | from .thirdparty import ( | ||
cbor, | ||||
) | ||||
|
r25954 | from . import ( | ||
|
r28666 | bundle2, | ||
|
r25954 | error, | ||
httpconnection, | ||||
|
r30924 | pycompat, | ||
|
r37627 | repository, | ||
|
r25954 | statichttprepo, | ||
|
r36977 | url as urlmod, | ||
|
r25954 | util, | ||
|
r37501 | wireprotoframing, | ||
|
r37576 | wireprototypes, | ||
|
r37632 | wireprotov1peer, | ||
|
r37737 | wireprotov2peer, | ||
|
r37563 | wireprotov2server, | ||
|
r25954 | ) | ||
|
r37828 | from .utils import ( | ||
interfaceutil, | ||||
) | ||||
|
r17192 | |||
|
r29455 | httplib = util.httplib | ||
|
r28883 | urlerr = util.urlerr | ||
urlreq = util.urlreq | ||||
|
r30759 | def encodevalueinheaders(value, header, limit): | ||
"""Encode a string value into multiple HTTP headers. | ||||
``value`` will be encoded into 1 or more HTTP headers with the names | ||||
``header-<N>`` where ``<N>`` is an integer starting at 1. Each header | ||||
name + value will be at most ``limit`` bytes long. | ||||
|
r34733 | Returns an iterable of 2-tuples consisting of header names and | ||
values as native strings. | ||||
|
r30759 | """ | ||
|
r34733 | # HTTP Headers are ASCII. Python 3 requires them to be unicodes, | ||
# not bytes. This function always takes bytes in as arguments. | ||||
fmt = pycompat.strurl(header) + r'-%s' | ||||
# Note: it is *NOT* a bug that the last bit here is a bytestring | ||||
# and not a unicode: we're just getting the encoded length anyway, | ||||
# and using an r-string to make it portable between Python 2 and 3 | ||||
# doesn't work because then the \r is a literal backslash-r | ||||
# instead of a carriage return. | ||||
valuelen = limit - len(fmt % r'000') - len(': \r\n') | ||||
|
r30759 | result = [] | ||
n = 0 | ||||
for i in xrange(0, len(value), valuelen): | ||||
n += 1 | ||||
|
r34733 | result.append((fmt % str(n), pycompat.strurl(value[i:i + valuelen]))) | ||
|
r30759 | |||
return result | ||||
|
r32002 | def _wraphttpresponse(resp): | ||
"""Wrap an HTTPResponse with common error handlers. | ||||
This ensures that any I/O from any consumer raises the appropriate | ||||
error and messaging. | ||||
""" | ||||
origread = resp.read | ||||
class readerproxy(resp.__class__): | ||||
def read(self, size=None): | ||||
try: | ||||
return origread(size) | ||||
except httplib.IncompleteRead as e: | ||||
# e.expected is an integer if length known or None otherwise. | ||||
if e.expected: | ||||
msg = _('HTTP request error (incomplete response; ' | ||||
'expected %d bytes got %d)') % (e.expected, | ||||
len(e.partial)) | ||||
else: | ||||
msg = _('HTTP request error (incomplete response)') | ||||
|
r32023 | raise error.PeerTransportError( | ||
|
r32002 | msg, | ||
hint=_('this may be an intermittent network failure; ' | ||||
'if the error persists, consider contacting the ' | ||||
'network or server operator')) | ||||
except httplib.HTTPException as e: | ||||
|
r32023 | raise error.PeerTransportError( | ||
|
r32002 | _('HTTP request error (%s)') % e, | ||
|
r32087 | hint=_('this may be an intermittent network failure; ' | ||
|
r32002 | 'if the error persists, consider contacting the ' | ||
'network or server operator')) | ||||
resp.__class__ = readerproxy | ||||
|
r33820 | class _multifile(object): | ||
def __init__(self, *fileobjs): | ||||
for f in fileobjs: | ||||
if not util.safehasattr(f, 'length'): | ||||
raise ValueError( | ||||
'_multifile only supports file objects that ' | ||||
'have a length but this one does not:', type(f), f) | ||||
self._fileobjs = fileobjs | ||||
self._index = 0 | ||||
@property | ||||
def length(self): | ||||
return sum(f.length for f in self._fileobjs) | ||||
def read(self, amt=None): | ||||
if amt <= 0: | ||||
return ''.join(f.read() for f in self._fileobjs) | ||||
parts = [] | ||||
while amt and self._index < len(self._fileobjs): | ||||
parts.append(self._fileobjs[self._index].read(amt)) | ||||
got = len(parts[-1]) | ||||
if got < amt: | ||||
self._index += 1 | ||||
amt -= got | ||||
return ''.join(parts) | ||||
def seek(self, offset, whence=os.SEEK_SET): | ||||
if whence != os.SEEK_SET: | ||||
raise NotImplementedError( | ||||
'_multifile does not support anything other' | ||||
' than os.SEEK_SET for whence on seek()') | ||||
if offset != 0: | ||||
raise NotImplementedError( | ||||
'_multifile only supports seeking to start, but that ' | ||||
'could be fixed if you need it') | ||||
for f in self._fileobjs: | ||||
f.seek(0) | ||||
self._index = 0 | ||||
|
r37567 | def makev1commandrequest(ui, requestbuilder, caps, capablefn, | ||
repobaseurl, cmd, args): | ||||
"""Make an HTTP request to run a command for a version 1 client. | ||||
``caps`` is a set of known server capabilities. The value may be | ||||
None if capabilities are not yet known. | ||||
``capablefn`` is a function to evaluate a capability. | ||||
``cmd``, ``args``, and ``data`` define the command, its arguments, and | ||||
raw data to pass to it. | ||||
""" | ||||
if cmd == 'pushkey': | ||||
args['data'] = '' | ||||
data = args.pop('data', None) | ||||
headers = args.pop('headers', {}) | ||||
ui.debug("sending %s command\n" % cmd) | ||||
q = [('cmd', cmd)] | ||||
headersize = 0 | ||||
# Important: don't use self.capable() here or else you end up | ||||
# with infinite recursion when trying to look up capabilities | ||||
# for the first time. | ||||
postargsok = caps is not None and 'httppostargs' in caps | ||||
# Send arguments via POST. | ||||
if postargsok and args: | ||||
strargs = urlreq.urlencode(sorted(args.items())) | ||||
if not data: | ||||
data = strargs | ||||
else: | ||||
if isinstance(data, bytes): | ||||
i = io.BytesIO(data) | ||||
i.length = len(data) | ||||
data = i | ||||
argsio = io.BytesIO(strargs) | ||||
argsio.length = len(strargs) | ||||
data = _multifile(argsio, data) | ||||
headers[r'X-HgArgs-Post'] = len(strargs) | ||||
elif args: | ||||
# Calling self.capable() can infinite loop if we are calling | ||||
# "capabilities". But that command should never accept wire | ||||
# protocol arguments. So this should never happen. | ||||
assert cmd != 'capabilities' | ||||
httpheader = capablefn('httpheader') | ||||
if httpheader: | ||||
headersize = int(httpheader.split(',', 1)[0]) | ||||
# Send arguments via HTTP headers. | ||||
if headersize > 0: | ||||
# The headers can typically carry more data than the URL. | ||||
encargs = urlreq.urlencode(sorted(args.items())) | ||||
for header, value in encodevalueinheaders(encargs, 'X-HgArg', | ||||
headersize): | ||||
headers[header] = value | ||||
# Send arguments via query string (Mercurial <1.9). | ||||
else: | ||||
q += sorted(args.items()) | ||||
qs = '?%s' % urlreq.urlencode(q) | ||||
cu = "%s%s" % (repobaseurl, qs) | ||||
size = 0 | ||||
if util.safehasattr(data, 'length'): | ||||
size = data.length | ||||
elif data is not None: | ||||
size = len(data) | ||||
if data is not None and r'Content-Type' not in headers: | ||||
headers[r'Content-Type'] = r'application/mercurial-0.1' | ||||
# Tell the server we accept application/mercurial-0.2 and multiple | ||||
# compression formats if the server is capable of emitting those | ||||
# payloads. | ||||
|
r37574 | # Note: Keep this set empty by default, as client advertisement of | ||
# protocol parameters should only occur after the handshake. | ||||
protoparams = set() | ||||
|
r37567 | |||
mediatypes = set() | ||||
if caps is not None: | ||||
mt = capablefn('httpmediatype') | ||||
if mt: | ||||
protoparams.add('0.1') | ||||
mediatypes = set(mt.split(',')) | ||||
|
r37574 | protoparams.add('partial-pull') | ||
|
r37567 | if '0.2tx' in mediatypes: | ||
protoparams.add('0.2') | ||||
if '0.2tx' in mediatypes and capablefn('compression'): | ||||
# We /could/ compare supported compression formats and prune | ||||
# non-mutually supported or error if nothing is mutually supported. | ||||
# For now, send the full list to the server and have it error. | ||||
comps = [e.wireprotosupport().name for e in | ||||
util.compengines.supportedwireengines(util.CLIENTROLE)] | ||||
protoparams.add('comp=%s' % ','.join(comps)) | ||||
if protoparams: | ||||
protoheaders = encodevalueinheaders(' '.join(sorted(protoparams)), | ||||
'X-HgProto', | ||||
headersize or 1024) | ||||
for header, value in protoheaders: | ||||
headers[header] = value | ||||
|
r37573 | |||
varyheaders = [] | ||||
for header in headers: | ||||
if header.lower().startswith(r'x-hg'): | ||||
|
r37567 | varyheaders.append(header) | ||
if varyheaders: | ||||
|
r37573 | headers[r'Vary'] = r','.join(sorted(varyheaders)) | ||
|
r37567 | |||
req = requestbuilder(pycompat.strurl(cu), data, headers) | ||||
if data is not None: | ||||
ui.debug("sending %d bytes\n" % size) | ||||
req.add_unredirected_header(r'Content-Length', r'%d' % size) | ||||
return req, cu, qs | ||||
|
r37756 | def _reqdata(req): | ||
"""Get request data, if any. If no data, returns None.""" | ||||
if pycompat.ispy3: | ||||
return req.data | ||||
if not req.has_data(): | ||||
return None | ||||
return req.get_data() | ||||
|
r37566 | def sendrequest(ui, opener, req): | ||
"""Send a prepared HTTP request. | ||||
Returns the response object. | ||||
""" | ||||
|
r38139 | dbg = ui.debug | ||
|
r37566 | if (ui.debugflag | ||
and ui.configbool('devel', 'debug.peer-request')): | ||||
line = 'devel-peer-request: %s\n' | ||||
|
r37754 | dbg(line % '%s %s' % (pycompat.bytesurl(req.get_method()), | ||
pycompat.bytesurl(req.get_full_url()))) | ||||
|
r37566 | hgargssize = None | ||
for header, value in sorted(req.header_items()): | ||||
|
r37755 | header = pycompat.bytesurl(header) | ||
value = pycompat.bytesurl(value) | ||||
|
r37566 | if header.startswith('X-hgarg-'): | ||
if hgargssize is None: | ||||
hgargssize = 0 | ||||
hgargssize += len(value) | ||||
else: | ||||
dbg(line % ' %s %s' % (header, value)) | ||||
if hgargssize is not None: | ||||
dbg(line % ' %d bytes of commands arguments in headers' | ||||
% hgargssize) | ||||
|
r37756 | data = _reqdata(req) | ||
if data is not None: | ||||
|
r37566 | length = getattr(data, 'length', None) | ||
if length is None: | ||||
length = len(data) | ||||
dbg(line % ' %d bytes of data' % length) | ||||
start = util.timer() | ||||
|
r37568 | try: | ||
res = opener.open(req) | ||||
except urlerr.httperror as inst: | ||||
if inst.code == 401: | ||||
raise error.Abort(_('authorization failed')) | ||||
raise | ||||
except httplib.HTTPException as inst: | ||||
ui.debug('http error requesting %s\n' % | ||||
util.hidepassword(req.get_full_url())) | ||||
ui.traceback() | ||||
raise IOError(None, inst) | ||||
finally: | ||||
|
r38138 | if ui.debugflag and ui.configbool('devel', 'debug.peer-request'): | ||
|
r37754 | dbg(line % ' finished in %.4f seconds (%d)' | ||
|
r37568 | % (util.timer() - start, res.code)) | ||
# Insert error handlers for common I/O failures. | ||||
_wraphttpresponse(res) | ||||
|
r37566 | |||
return res | ||||
|
r37851 | class RedirectedRepoError(error.RepoError): | ||
def __init__(self, msg, respurl): | ||||
super(RedirectedRepoError, self).__init__(msg) | ||||
self.respurl = respurl | ||||
|
r37576 | def parsev1commandresponse(ui, baseurl, requrl, qs, resp, compressible, | ||
allowcbor=False): | ||||
|
r37569 | # record the url we got redirected to | ||
|
r37851 | redirected = False | ||
|
r37569 | respurl = pycompat.bytesurl(resp.geturl()) | ||
if respurl.endswith(qs): | ||||
respurl = respurl[:-len(qs)] | ||||
|
r37851 | qsdropped = False | ||
else: | ||||
qsdropped = True | ||||
|
r37569 | if baseurl.rstrip('/') != respurl.rstrip('/'): | ||
|
r37851 | redirected = True | ||
|
r37569 | if not ui.quiet: | ||
ui.warn(_('real URL is %s\n') % respurl) | ||||
try: | ||||
proto = pycompat.bytesurl(resp.getheader(r'content-type', r'')) | ||||
except AttributeError: | ||||
proto = pycompat.bytesurl(resp.headers.get(r'content-type', r'')) | ||||
safeurl = util.hidepassword(baseurl) | ||||
if proto.startswith('application/hg-error'): | ||||
raise error.OutOfBandError(resp.read()) | ||||
|
r37572 | |||
# Pre 1.0 versions of Mercurial used text/plain and | ||||
# application/hg-changegroup. We don't support such old servers. | ||||
if not proto.startswith('application/mercurial-'): | ||||
|
r37569 | ui.debug("requested URL: '%s'\n" % util.hidepassword(requrl)) | ||
|
r37851 | msg = _("'%s' does not appear to be an hg repository:\n" | ||
"---%%<--- (%s)\n%s\n---%%<---\n") % ( | ||||
safeurl, proto or 'no content-type', resp.read(1024)) | ||||
# Some servers may strip the query string from the redirect. We | ||||
# raise a special error type so callers can react to this specially. | ||||
if redirected and qsdropped: | ||||
raise RedirectedRepoError(msg, respurl) | ||||
else: | ||||
raise error.RepoError(msg) | ||||
|
r37569 | |||
|
r37572 | try: | ||
|
r37576 | subtype = proto.split('-', 1)[1] | ||
# Unless we end up supporting CBOR in the legacy wire protocol, | ||||
# this should ONLY be encountered for the initial capabilities | ||||
# request during handshake. | ||||
if subtype == 'cbor': | ||||
if allowcbor: | ||||
return respurl, proto, resp | ||||
else: | ||||
raise error.RepoError(_('unexpected CBOR response from ' | ||||
'server')) | ||||
version_info = tuple([int(n) for n in subtype.split('.')]) | ||||
|
r37572 | except ValueError: | ||
raise error.RepoError(_("'%s' sent a broken Content-Type " | ||||
"header (%s)") % (safeurl, proto)) | ||||
|
r37569 | |||
|
r37572 | # TODO consider switching to a decompression reader that uses | ||
# generators. | ||||
if version_info == (0, 1): | ||||
if compressible: | ||||
resp = util.compengines['zlib'].decompressorreader(resp) | ||||
|
r37569 | |||
|
r37572 | elif version_info == (0, 2): | ||
# application/mercurial-0.2 always identifies the compression | ||||
# engine in the payload header. | ||||
elen = struct.unpack('B', resp.read(1))[0] | ||||
ename = resp.read(elen) | ||||
engine = util.compengines.forwiretype(ename) | ||||
|
r37569 | |||
|
r37572 | resp = engine.decompressorreader(resp) | ||
else: | ||||
raise error.RepoError(_("'%s' uses newer protocol %s") % | ||||
|
r37576 | (safeurl, subtype)) | ||
|
r37569 | |||
|
r37576 | return respurl, proto, resp | ||
|
r37569 | |||
|
r37632 | class httppeer(wireprotov1peer.wirepeer): | ||
|
r37570 | def __init__(self, ui, path, url, opener, requestbuilder, caps): | ||
|
r37337 | self.ui = ui | ||
|
r33671 | self._path = path | ||
|
r37024 | self._url = url | ||
|
r37570 | self._caps = caps | ||
|
r37024 | self._urlopener = opener | ||
|
r37565 | self._requestbuilder = requestbuilder | ||
|
r17192 | |||
def __del__(self): | ||||
|
r37024 | for h in self._urlopener.handlers: | ||
h.close() | ||||
getattr(h, "close_all", lambda: None)() | ||||
|
r17192 | |||
|
r37336 | # Begin of ipeerconnection interface. | ||
|
r33804 | |||
|
r17192 | def url(self): | ||
|
r33671 | return self._path | ||
|
r17192 | |||
|
r33804 | def local(self): | ||
return None | ||||
def peer(self): | ||||
return self | ||||
def canpush(self): | ||||
return True | ||||
|
r17192 | |||
|
r33804 | def close(self): | ||
pass | ||||
|
r17192 | |||
|
r37336 | # End of ipeerconnection interface. | ||
|
r33804 | |||
|
r37336 | # Begin of ipeercommands interface. | ||
|
r33804 | |||
def capabilities(self): | ||||
|
r33671 | return self._caps | ||
|
r17192 | |||
|
r37336 | # End of ipeercommands interface. | ||
|
r33804 | |||
|
r30464 | def _callstream(self, cmd, _compressible=False, **args): | ||
|
r35360 | args = pycompat.byteskwargs(args) | ||
|
r36236 | |||
|
r37567 | req, cu, qs = makev1commandrequest(self.ui, self._requestbuilder, | ||
self._caps, self.capable, | ||||
self._url, cmd, args) | ||||
|
r30763 | |||
|
r37568 | resp = sendrequest(self.ui, self._urlopener, req) | ||
|
r32002 | |||
|
r37576 | self._url, ct, resp = parsev1commandresponse(self.ui, self._url, cu, qs, | ||
resp, _compressible) | ||||
|
r30464 | |||
|
r17192 | return resp | ||
def _call(self, cmd, **args): | ||||
fp = self._callstream(cmd, **args) | ||||
try: | ||||
return fp.read() | ||||
finally: | ||||
# if using keepalive, allow connection to be reused | ||||
fp.close() | ||||
def _callpush(self, cmd, cg, **args): | ||||
# have to stream bundle to a temp file because we do not have | ||||
# http 1.1 chunked transfer. | ||||
types = self.capable('unbundle') | ||||
try: | ||||
types = types.split(',') | ||||
except AttributeError: | ||||
# servers older than d1b16a746db6 will send 'unbundle' as a | ||||
# boolean capability. They only support headerless/uncompressed | ||||
# bundles. | ||||
types = [""] | ||||
for x in types: | ||||
|
r28666 | if x in bundle2.bundletypes: | ||
|
r17192 | type = x | ||
break | ||||
|
r28666 | tempname = bundle2.writebundle(self.ui, cg, None, type) | ||
|
r17192 | fp = httpconnection.httpsendfile(self.ui, tempname, "rb") | ||
|
r36311 | headers = {r'Content-Type': r'application/mercurial-0.1'} | ||
|
r17192 | |||
try: | ||||
|
r25085 | r = self._call(cmd, data=fp, headers=headers, **args) | ||
vals = r.split('\n', 1) | ||||
if len(vals) < 2: | ||||
raise error.ResponseError(_("unexpected response:"), r) | ||||
return vals | ||||
|
r36448 | except urlerr.httperror: | ||
# Catch and re-raise these so we don't try and treat them | ||||
# like generic socket errors. They lack any values in | ||||
# .args on Python 3 which breaks our socket.error block. | ||||
raise | ||||
|
r25660 | except socket.error as err: | ||
|
r25085 | if err.args[0] in (errno.ECONNRESET, errno.EPIPE): | ||
|
r26587 | raise error.Abort(_('push failed: %s') % err.args[1]) | ||
raise error.Abort(err.args[1]) | ||||
|
r17192 | finally: | ||
fp.close() | ||||
os.unlink(tempname) | ||||
|
r21074 | def _calltwowaystream(self, cmd, fp, **args): | ||
fh = None | ||||
|
r23086 | fp_ = None | ||
|
r21074 | filename = None | ||
try: | ||||
# dump bundle to disk | ||||
|
r38182 | fd, filename = pycompat.mkstemp(prefix="hg-bundle-", suffix=".hg") | ||
|
r36853 | fh = os.fdopen(fd, r"wb") | ||
|
r21074 | d = fp.read(4096) | ||
while d: | ||||
fh.write(d) | ||||
d = fp.read(4096) | ||||
fh.close() | ||||
# start http push | ||||
|
r23086 | fp_ = httpconnection.httpsendfile(self.ui, filename, "rb") | ||
|
r36311 | headers = {r'Content-Type': r'application/mercurial-0.1'} | ||
|
r23086 | return self._callstream(cmd, data=fp_, headers=headers, **args) | ||
|
r21074 | finally: | ||
|
r23086 | if fp_ is not None: | ||
fp_.close() | ||||
|
r21074 | if fh is not None: | ||
fh.close() | ||||
os.unlink(filename) | ||||
|
r20905 | def _callcompressable(self, cmd, **args): | ||
|
r30464 | return self._callstream(cmd, _compressible=True, **args) | ||
|
r17192 | |||
|
r21188 | def _abort(self, exception): | ||
raise exception | ||||
|
r37669 | def sendv2request(ui, opener, requestbuilder, apiurl, permission, requests): | ||
reactor = wireprotoframing.clientreactor(hasmultiplesend=False, | ||||
buffersends=True) | ||||
|
r37737 | handler = wireprotov2peer.clienthandler(ui, reactor) | ||
|
r37669 | url = '%s/%s' % (apiurl, permission) | ||
if len(requests) > 1: | ||||
url += '/multirequest' | ||||
else: | ||||
url += '/%s' % requests[0][0] | ||||
for command, args, f in requests: | ||||
|
r37737 | assert not list(handler.callcommand(command, args, f)) | ||
|
r37669 | |||
# TODO stream this. | ||||
|
r37737 | body = b''.join(map(bytes, handler.flushcommands())) | ||
|
r37669 | |||
# TODO modify user-agent to reflect v2 | ||||
headers = { | ||||
r'Accept': wireprotov2server.FRAMINGTYPE, | ||||
r'Content-Type': wireprotov2server.FRAMINGTYPE, | ||||
} | ||||
req = requestbuilder(pycompat.strurl(url), body, headers) | ||||
req.add_unredirected_header(r'Content-Length', r'%d' % len(body)) | ||||
try: | ||||
res = opener.open(req) | ||||
except urlerr.httperror as e: | ||||
if e.code == 401: | ||||
raise error.Abort(_('authorization failed')) | ||||
raise | ||||
except httplib.HTTPException as e: | ||||
ui.traceback() | ||||
raise IOError(None, e) | ||||
|
r37737 | return handler, res | ||
|
r37669 | |||
class queuedcommandfuture(pycompat.futures.Future): | ||||
"""Wraps result() on command futures to trigger submission on call.""" | ||||
def result(self, timeout=None): | ||||
if self.done(): | ||||
return pycompat.futures.Future.result(self, timeout) | ||||
self._peerexecutor.sendcommands() | ||||
# sendcommands() will restore the original __class__ and self.result | ||||
# will resolve to Future.result. | ||||
return self.result(timeout) | ||||
|
r37828 | @interfaceutil.implementer(repository.ipeercommandexecutor) | ||
|
r37669 | class httpv2executor(object): | ||
def __init__(self, ui, opener, requestbuilder, apiurl, descriptor): | ||||
self._ui = ui | ||||
self._opener = opener | ||||
self._requestbuilder = requestbuilder | ||||
self._apiurl = apiurl | ||||
self._descriptor = descriptor | ||||
self._sent = False | ||||
self._closed = False | ||||
self._neededpermissions = set() | ||||
self._calls = [] | ||||
self._futures = weakref.WeakSet() | ||||
self._responseexecutor = None | ||||
self._responsef = None | ||||
def __enter__(self): | ||||
return self | ||||
def __exit__(self, exctype, excvalue, exctb): | ||||
self.close() | ||||
def callcommand(self, command, args): | ||||
if self._sent: | ||||
raise error.ProgrammingError('callcommand() cannot be used after ' | ||||
'commands are sent') | ||||
if self._closed: | ||||
raise error.ProgrammingError('callcommand() cannot be used after ' | ||||
'close()') | ||||
# The service advertises which commands are available. So if we attempt | ||||
# to call an unknown command or pass an unknown argument, we can screen | ||||
# for this. | ||||
if command not in self._descriptor['commands']: | ||||
raise error.ProgrammingError( | ||||
'wire protocol command %s is not available' % command) | ||||
cmdinfo = self._descriptor['commands'][command] | ||||
unknownargs = set(args.keys()) - set(cmdinfo.get('args', {})) | ||||
if unknownargs: | ||||
raise error.ProgrammingError( | ||||
'wire protocol command %s does not accept argument: %s' % ( | ||||
command, ', '.join(sorted(unknownargs)))) | ||||
self._neededpermissions |= set(cmdinfo['permissions']) | ||||
# TODO we /could/ also validate types here, since the API descriptor | ||||
# includes types... | ||||
f = pycompat.futures.Future() | ||||
# Monkeypatch it so result() triggers sendcommands(), otherwise result() | ||||
# could deadlock. | ||||
f.__class__ = queuedcommandfuture | ||||
f._peerexecutor = self | ||||
self._futures.add(f) | ||||
self._calls.append((command, args, f)) | ||||
return f | ||||
def sendcommands(self): | ||||
if self._sent: | ||||
return | ||||
if not self._calls: | ||||
return | ||||
self._sent = True | ||||
# Unhack any future types so caller sees a clean type and so we | ||||
# break reference cycle. | ||||
for f in self._futures: | ||||
if isinstance(f, queuedcommandfuture): | ||||
f.__class__ = pycompat.futures.Future | ||||
f._peerexecutor = None | ||||
# Mark the future as running and filter out cancelled futures. | ||||
calls = [(command, args, f) | ||||
for command, args, f in self._calls | ||||
if f.set_running_or_notify_cancel()] | ||||
# Clear out references, prevent improper object usage. | ||||
self._calls = None | ||||
if not calls: | ||||
return | ||||
permissions = set(self._neededpermissions) | ||||
if 'push' in permissions and 'pull' in permissions: | ||||
permissions.remove('pull') | ||||
if len(permissions) > 1: | ||||
raise error.RepoError(_('cannot make request requiring multiple ' | ||||
'permissions: %s') % | ||||
_(', ').join(sorted(permissions))) | ||||
permission = { | ||||
'push': 'rw', | ||||
'pull': 'ro', | ||||
}[permissions.pop()] | ||||
|
r37737 | handler, resp = sendv2request( | ||
|
r37669 | self._ui, self._opener, self._requestbuilder, self._apiurl, | ||
permission, calls) | ||||
# TODO we probably want to validate the HTTP code, media type, etc. | ||||
self._responseexecutor = pycompat.futures.ThreadPoolExecutor(1) | ||||
self._responsef = self._responseexecutor.submit(self._handleresponse, | ||||
|
r37737 | handler, resp) | ||
|
r37669 | |||
def close(self): | ||||
if self._closed: | ||||
return | ||||
self.sendcommands() | ||||
self._closed = True | ||||
if not self._responsef: | ||||
return | ||||
try: | ||||
self._responsef.result() | ||||
finally: | ||||
self._responseexecutor.shutdown(wait=True) | ||||
self._responsef = None | ||||
self._responseexecutor = None | ||||
# If any of our futures are still in progress, mark them as | ||||
# errored, otherwise a result() could wait indefinitely. | ||||
for f in self._futures: | ||||
if not f.done(): | ||||
f.set_exception(error.ResponseError( | ||||
_('unfulfilled command response'))) | ||||
self._futures = None | ||||
|
r37737 | def _handleresponse(self, handler, resp): | ||
|
r37669 | # Called in a thread to read the response. | ||
|
r37737 | while handler.readframe(resp): | ||
pass | ||||
|
r37669 | |||
|
r37501 | # TODO implement interface for version 2 peers | ||
|
r37828 | @interfaceutil.implementer(repository.ipeerconnection, | ||
repository.ipeercapabilities, | ||||
repository.ipeerrequests) | ||||
|
r37501 | class httpv2peer(object): | ||
|
r37576 | def __init__(self, ui, repourl, apipath, opener, requestbuilder, | ||
apidescriptor): | ||||
|
r37501 | self.ui = ui | ||
if repourl.endswith('/'): | ||||
repourl = repourl[:-1] | ||||
|
r37627 | self._url = repourl | ||
|
r37576 | self._apipath = apipath | ||
|
r37669 | self._apiurl = '%s/%s' % (repourl, apipath) | ||
|
r37501 | self._opener = opener | ||
|
r37576 | self._requestbuilder = requestbuilder | ||
self._descriptor = apidescriptor | ||||
|
r37501 | |||
|
r37627 | # Start of ipeerconnection. | ||
def url(self): | ||||
return self._url | ||||
def local(self): | ||||
return None | ||||
def peer(self): | ||||
return self | ||||
def canpush(self): | ||||
# TODO change once implemented. | ||||
return False | ||||
|
r37501 | def close(self): | ||
pass | ||||
|
r37627 | # End of ipeerconnection. | ||
|
r37629 | # Start of ipeercapabilities. | ||
def capable(self, name): | ||||
# The capabilities used internally historically map to capabilities | ||||
# advertised from the "capabilities" wire protocol command. However, | ||||
# version 2 of that command works differently. | ||||
# Maps to commands that are available. | ||||
if name in ('branchmap', 'getbundle', 'known', 'lookup', 'pushkey'): | ||||
return True | ||||
# Other concepts. | ||||
if name in ('bundle2',): | ||||
return True | ||||
return False | ||||
def requirecap(self, name, purpose): | ||||
if self.capable(name): | ||||
return | ||||
raise error.CapabilityError( | ||||
_('cannot %s; client or remote repository does not support the %r ' | ||||
'capability') % (purpose, name)) | ||||
# End of ipeercapabilities. | ||||
|
r37501 | def _call(self, name, **args): | ||
|
r37669 | with self.commandexecutor() as e: | ||
return e.callcommand(name, args).result() | ||||
|
r37561 | |||
|
r37669 | def commandexecutor(self): | ||
return httpv2executor(self.ui, self._opener, self._requestbuilder, | ||||
self._apiurl, self._descriptor) | ||||
|
r37501 | |||
|
r37576 | # Registry of API service names to metadata about peers that handle it. | ||
# | ||||
# The following keys are meaningful: | ||||
# | ||||
# init | ||||
# Callable receiving (ui, repourl, servicepath, opener, requestbuilder, | ||||
# apidescriptor) to create a peer. | ||||
# | ||||
# priority | ||||
# Integer priority for the service. If we could choose from multiple | ||||
# services, we choose the one with the highest priority. | ||||
API_PEERS = { | ||||
|
r37662 | wireprototypes.HTTP_WIREPROTO_V2: { | ||
|
r37576 | 'init': httpv2peer, | ||
'priority': 50, | ||||
}, | ||||
} | ||||
|
r37570 | def performhandshake(ui, url, opener, requestbuilder): | ||
# The handshake is a request to the capabilities command. | ||||
caps = None | ||||
def capable(x): | ||||
raise error.ProgrammingError('should not be called') | ||||
|
r37576 | args = {} | ||
# The client advertises support for newer protocols by adding an | ||||
# X-HgUpgrade-* header with a list of supported APIs and an | ||||
# X-HgProto-* header advertising which serializing formats it supports. | ||||
# We only support the HTTP version 2 transport and CBOR responses for | ||||
# now. | ||||
advertisev2 = ui.configbool('experimental', 'httppeer.advertise-v2') | ||||
if advertisev2: | ||||
args['headers'] = { | ||||
r'X-HgProto-1': r'cbor', | ||||
} | ||||
args['headers'].update( | ||||
encodevalueinheaders(' '.join(sorted(API_PEERS)), | ||||
'X-HgUpgrade', | ||||
# We don't know the header limit this early. | ||||
# So make it small. | ||||
1024)) | ||||
|
r37570 | req, requrl, qs = makev1commandrequest(ui, requestbuilder, caps, | ||
capable, url, 'capabilities', | ||||
|
r37576 | args) | ||
|
r37570 | resp = sendrequest(ui, opener, req) | ||
|
r37851 | # The server may redirect us to the repo root, stripping the | ||
# ?cmd=capabilities query string from the URL. The server would likely | ||||
# return HTML in this case and ``parsev1commandresponse()`` would raise. | ||||
# We catch this special case and re-issue the capabilities request against | ||||
# the new URL. | ||||
# | ||||
# We should ideally not do this, as a redirect that drops the query | ||||
# string from the URL is arguably a server bug. (Garbage in, garbage out). | ||||
# However, Mercurial clients for several years appeared to handle this | ||||
# issue without behavior degradation. And according to issue 5860, it may | ||||
# be a longstanding bug in some server implementations. So we allow a | ||||
# redirect that drops the query string to "just work." | ||||
try: | ||||
respurl, ct, resp = parsev1commandresponse(ui, url, requrl, qs, resp, | ||||
compressible=False, | ||||
allowcbor=advertisev2) | ||||
except RedirectedRepoError as e: | ||||
req, requrl, qs = makev1commandrequest(ui, requestbuilder, caps, | ||||
capable, e.respurl, | ||||
'capabilities', args) | ||||
resp = sendrequest(ui, opener, req) | ||||
respurl, ct, resp = parsev1commandresponse(ui, url, requrl, qs, resp, | ||||
compressible=False, | ||||
allowcbor=advertisev2) | ||||
|
r37570 | |||
try: | ||||
|
r37576 | rawdata = resp.read() | ||
|
r37570 | finally: | ||
resp.close() | ||||
|
r37576 | if not ct.startswith('application/mercurial-'): | ||
raise error.ProgrammingError('unexpected content-type: %s' % ct) | ||||
if advertisev2: | ||||
if ct == 'application/mercurial-cbor': | ||||
try: | ||||
info = cbor.loads(rawdata) | ||||
except cbor.CBORDecodeError: | ||||
raise error.Abort(_('error decoding CBOR from remote server'), | ||||
hint=_('try again and consider contacting ' | ||||
'the server operator')) | ||||
# We got a legacy response. That's fine. | ||||
elif ct in ('application/mercurial-0.1', 'application/mercurial-0.2'): | ||||
info = { | ||||
'v1capabilities': set(rawdata.split()) | ||||
} | ||||
else: | ||||
raise error.RepoError( | ||||
_('unexpected response type from server: %s') % ct) | ||||
else: | ||||
info = { | ||||
'v1capabilities': set(rawdata.split()) | ||||
} | ||||
return respurl, info | ||||
|
r37570 | |||
|
r37571 | def makepeer(ui, path, opener=None, requestbuilder=urlreq.request): | ||
|
r37565 | """Construct an appropriate HTTP peer instance. | ||
|
r37571 | ``opener`` is an ``url.opener`` that should be used to establish | ||
connections, perform HTTP requests. | ||||
|
r37565 | ``requestbuilder`` is the type used for constructing HTTP requests. | ||
It exists as an argument so extensions can override the default. | ||||
""" | ||||
|
r37024 | u = util.url(path) | ||
if u.query or u.fragment: | ||||
raise error.Abort(_('unsupported URL component: "%s"') % | ||||
(u.query or u.fragment)) | ||||
# urllib cannot handle URLs with embedded user or passwd. | ||||
url, authinfo = u.authinfo() | ||||
ui.debug('using %s\n' % url) | ||||
|
r37571 | opener = opener or urlmod.opener(ui, authinfo) | ||
|
r37024 | |||
|
r37576 | respurl, info = performhandshake(ui, url, opener, requestbuilder) | ||
# Given the intersection of APIs that both we and the server support, | ||||
# sort by their advertised priority and pick the first one. | ||||
# | ||||
# TODO consider making this request-based and interface driven. For | ||||
# example, the caller could say "I want a peer that does X." It's quite | ||||
# possible that not all peers would do that. Since we know the service | ||||
# capabilities, we could filter out services not meeting the | ||||
# requirements. Possibly by consulting the interfaces defined by the | ||||
# peer type. | ||||
apipeerchoices = set(info.get('apis', {}).keys()) & set(API_PEERS.keys()) | ||||
|
r37570 | |||
|
r37576 | preferredchoices = sorted(apipeerchoices, | ||
key=lambda x: API_PEERS[x]['priority'], | ||||
reverse=True) | ||||
for service in preferredchoices: | ||||
apipath = '%s/%s' % (info['apibase'].rstrip('/'), service) | ||||
return API_PEERS[service]['init'](ui, respurl, apipath, opener, | ||||
requestbuilder, | ||||
info['apis'][service]) | ||||
# Failed to construct an API peer. Fall back to legacy. | ||||
return httppeer(ui, path, respurl, opener, requestbuilder, | ||||
info['v1capabilities']) | ||||
|
r37024 | |||
|
r37735 | def instance(ui, path, create, intents=None): | ||
|
r17192 | if create: | ||
|
r26587 | raise error.Abort(_('cannot create new http repository')) | ||
|
r17192 | try: | ||
|
r36977 | if path.startswith('https:') and not urlmod.has_https: | ||
|
r36238 | raise error.Abort(_('Python support for SSL and HTTPS ' | ||
'is not installed')) | ||||
|
r35902 | |||
|
r37024 | inst = makepeer(ui, path) | ||
|
r35902 | |||
|
r17192 | return inst | ||
|
r25660 | except error.RepoError as httpexception: | ||
|
r17192 | try: | ||
r = statichttprepo.instance(ui, "static-" + path, create) | ||||
|
r29241 | ui.note(_('(falling back to static-http)\n')) | ||
|
r17192 | return r | ||
except error.RepoError: | ||||
raise httpexception # use the original http RepoError instead | ||||