wireproto: rename wireproto to wireprotov1server (API)
We have wireprotov2server, wireprotov1peer, and wireprotov2peer.
wireproto only contains server functionality. So it makes sense to
rename it to wireprotov1server so the naming aligns with everything
else.
Differential Revision: https://phab.mercurial-scm.org/D3400
--- a/hgext/clonebundles.py Mon Apr 16 22:10:02 2018 -0700
+++ b/hgext/clonebundles.py Mon Apr 16 22:21:54 2018 -0700
@@ -198,7 +198,7 @@
from mercurial import (
extensions,
- wireproto,
+ wireprotov1server,
)
testedwith = 'ships-with-hg-core'
@@ -215,4 +215,4 @@
return caps
def extsetup(ui):
- extensions.wrapfunction(wireproto, '_capabilities', capabilities)
+ extensions.wrapfunction(wireprotov1server, '_capabilities', capabilities)
--- a/hgext/infinitepush/__init__.py Mon Apr 16 22:10:02 2018 -0700
+++ b/hgext/infinitepush/__init__.py Mon Apr 16 22:21:54 2018 -0700
@@ -125,9 +125,9 @@
pycompat,
registrar,
util,
- wireproto,
wireprototypes,
wireprotov1peer,
+ wireprotov1server,
)
from . import (
@@ -278,7 +278,7 @@
clientextsetup(ui)
def commonsetup(ui):
- wireproto.commands['listkeyspatterns'] = (
+ wireprotov1server.commands['listkeyspatterns'] = (
wireprotolistkeyspatterns, 'namespace patterns')
scratchbranchpat = ui.config('infinitepush', 'branchpattern')
if scratchbranchpat:
@@ -302,8 +302,8 @@
extensions.wrapfunction(localrepo.localrepository, 'listkeys',
localrepolistkeys)
- wireproto.commands['lookup'] = (
- _lookupwrap(wireproto.commands['lookup'][0]), 'key')
+ wireprotov1server.commands['lookup'] = (
+ _lookupwrap(wireprotov1server.commands['lookup'][0]), 'key')
extensions.wrapfunction(exchange, 'getbundlechunks', getbundlechunks)
extensions.wrapfunction(bundle2, 'processparts', processparts)
--- a/hgext/largefiles/uisetup.py Mon Apr 16 22:10:02 2018 -0700
+++ b/hgext/largefiles/uisetup.py Mon Apr 16 22:21:54 2018 -0700
@@ -31,7 +31,7 @@
subrepo,
upgrade,
url,
- wireproto,
+ wireprotov1server,
)
from . import (
@@ -164,22 +164,24 @@
overrides.openlargefile)
# create the new wireproto commands ...
- wireproto.wireprotocommand('putlfile', 'sha', permission='push')(
+ wireprotov1server.wireprotocommand('putlfile', 'sha', permission='push')(
proto.putlfile)
- wireproto.wireprotocommand('getlfile', 'sha', permission='pull')(
+ wireprotov1server.wireprotocommand('getlfile', 'sha', permission='pull')(
proto.getlfile)
- wireproto.wireprotocommand('statlfile', 'sha', permission='pull')(
+ wireprotov1server.wireprotocommand('statlfile', 'sha', permission='pull')(
proto.statlfile)
- wireproto.wireprotocommand('lheads', '', permission='pull')(
- wireproto.heads)
+ wireprotov1server.wireprotocommand('lheads', '', permission='pull')(
+ wireprotov1server.heads)
# ... and wrap some existing ones
- extensions.wrapfunction(wireproto.commands['heads'], 'func', proto.heads)
+ extensions.wrapfunction(wireprotov1server.commands['heads'], 'func',
+ proto.heads)
# TODO also wrap wireproto.commandsv2 once heads is implemented there.
extensions.wrapfunction(webcommands, 'decodepath', overrides.decodepath)
- extensions.wrapfunction(wireproto, '_capabilities', proto._capabilities)
+ extensions.wrapfunction(wireprotov1server, '_capabilities',
+ proto._capabilities)
# can't do this in reposetup because it needs to have happened before
# wirerepo.__init__ is called
--- a/hgext/lfs/__init__.py Mon Apr 16 22:10:02 2018 -0700
+++ b/hgext/lfs/__init__.py Mon Apr 16 22:21:54 2018 -0700
@@ -149,8 +149,8 @@
upgrade,
util,
vfs as vfsmod,
- wireproto,
wireprotoserver,
+ wireprotov1server,
)
from . import (
@@ -323,7 +323,7 @@
wrapper.allsupportedversions)
wrapfunction(exchange, 'push', wrapper.push)
- wrapfunction(wireproto, '_capabilities', wrapper._capabilities)
+ wrapfunction(wireprotov1server, '_capabilities', wrapper._capabilities)
wrapfunction(wireprotoserver, 'handlewsgirequest',
wireprotolfsserver.handlewsgirequest)
--- a/mercurial/sshpeer.py Mon Apr 16 22:10:02 2018 -0700
+++ b/mercurial/sshpeer.py Mon Apr 16 22:21:54 2018 -0700
@@ -15,10 +15,10 @@
error,
pycompat,
util,
- wireproto,
wireprotoserver,
wireprototypes,
wireprotov1peer,
+ wireprotov1server,
)
from .utils import (
procutil,
@@ -441,7 +441,7 @@
dbg(line % ' %s-%s: %d' % (key, dk, len(dv)))
self.ui.debug("sending %s command\n" % cmd)
self._pipeo.write("%s\n" % cmd)
- _func, names = wireproto.commands[cmd]
+ _func, names = wireprotov1server.commands[cmd]
keys = names.split()
wireargs = {}
for k in keys:
--- a/mercurial/wireproto.py Mon Apr 16 22:10:02 2018 -0700
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,667 +0,0 @@
-# wireproto.py - generic wire protocol support functions
-#
-# Copyright 2005-2010 Matt Mackall <mpm@selenic.com>
-#
-# This software may be used and distributed according to the terms of the
-# GNU General Public License version 2 or any later version.
-
-from __future__ import absolute_import
-
-import os
-import tempfile
-
-from .i18n import _
-from .node import (
- hex,
- nullid,
-)
-
-from . import (
- bundle2,
- changegroup as changegroupmod,
- discovery,
- encoding,
- error,
- exchange,
- pushkey as pushkeymod,
- pycompat,
- streamclone,
- util,
- wireprototypes,
-)
-
-from .utils import (
- procutil,
- stringutil,
-)
-
-urlerr = util.urlerr
-urlreq = util.urlreq
-
-bundle2requiredmain = _('incompatible Mercurial client; bundle2 required')
-bundle2requiredhint = _('see https://www.mercurial-scm.org/wiki/'
- 'IncompatibleClient')
-bundle2required = '%s\n(%s)\n' % (bundle2requiredmain, bundle2requiredhint)
-
-def clientcompressionsupport(proto):
- """Returns a list of compression methods supported by the client.
-
- Returns a list of the compression methods supported by the client
- according to the protocol capabilities. If no such capability has
- been announced, fallback to the default of zlib and uncompressed.
- """
- for cap in proto.getprotocaps():
- if cap.startswith('comp='):
- return cap[5:].split(',')
- return ['zlib', 'none']
-
-# wire protocol command can either return a string or one of these classes.
-
-def getdispatchrepo(repo, proto, command):
- """Obtain the repo used for processing wire protocol commands.
-
- The intent of this function is to serve as a monkeypatch point for
- extensions that need commands to operate on different repo views under
- specialized circumstances.
- """
- return repo.filtered('served')
-
-def dispatch(repo, proto, command):
- repo = getdispatchrepo(repo, proto, command)
-
- func, spec = commands[command]
- args = proto.getargs(spec)
-
- return func(repo, proto, *args)
-
-def options(cmd, keys, others):
- opts = {}
- for k in keys:
- if k in others:
- opts[k] = others[k]
- del others[k]
- if others:
- procutil.stderr.write("warning: %s ignored unexpected arguments %s\n"
- % (cmd, ",".join(others)))
- return opts
-
-def bundle1allowed(repo, action):
- """Whether a bundle1 operation is allowed from the server.
-
- Priority is:
-
- 1. server.bundle1gd.<action> (if generaldelta active)
- 2. server.bundle1.<action>
- 3. server.bundle1gd (if generaldelta active)
- 4. server.bundle1
- """
- ui = repo.ui
- gd = 'generaldelta' in repo.requirements
-
- if gd:
- v = ui.configbool('server', 'bundle1gd.%s' % action)
- if v is not None:
- return v
-
- v = ui.configbool('server', 'bundle1.%s' % action)
- if v is not None:
- return v
-
- if gd:
- v = ui.configbool('server', 'bundle1gd')
- if v is not None:
- return v
-
- return ui.configbool('server', 'bundle1')
-
-commands = wireprototypes.commanddict()
-
-def wireprotocommand(name, args=None, permission='push'):
- """Decorator to declare a wire protocol command.
-
- ``name`` is the name of the wire protocol command being provided.
-
- ``args`` defines the named arguments accepted by the command. It is
- a space-delimited list of argument names. ``*`` denotes a special value
- that says to accept all named arguments.
-
- ``permission`` defines the permission type needed to run this command.
- Can be ``push`` or ``pull``. These roughly map to read-write and read-only,
- respectively. Default is to assume command requires ``push`` permissions
- because otherwise commands not declaring their permissions could modify
- a repository that is supposed to be read-only.
- """
- transports = {k for k, v in wireprototypes.TRANSPORTS.items()
- if v['version'] == 1}
-
- # Because SSHv2 is a mirror of SSHv1, we allow "batch" commands through to
- # SSHv2.
- # TODO undo this hack when SSH is using the unified frame protocol.
- if name == b'batch':
- transports.add(wireprototypes.SSHV2)
-
- if permission not in ('push', 'pull'):
- raise error.ProgrammingError('invalid wire protocol permission; '
- 'got %s; expected "push" or "pull"' %
- permission)
-
- if args is None:
- args = ''
-
- if not isinstance(args, bytes):
- raise error.ProgrammingError('arguments for version 1 commands '
- 'must be declared as bytes')
-
- def register(func):
- if name in commands:
- raise error.ProgrammingError('%s command already registered '
- 'for version 1' % name)
- commands[name] = wireprototypes.commandentry(
- func, args=args, transports=transports, permission=permission)
-
- return func
- return register
-
-# TODO define a more appropriate permissions type to use for this.
-@wireprotocommand('batch', 'cmds *', permission='pull')
-def batch(repo, proto, cmds, others):
- unescapearg = wireprototypes.unescapebatcharg
- repo = repo.filtered("served")
- res = []
- for pair in cmds.split(';'):
- op, args = pair.split(' ', 1)
- vals = {}
- for a in args.split(','):
- if a:
- n, v = a.split('=')
- vals[unescapearg(n)] = unescapearg(v)
- func, spec = commands[op]
-
- # Validate that client has permissions to perform this command.
- perm = commands[op].permission
- assert perm in ('push', 'pull')
- proto.checkperm(perm)
-
- if spec:
- keys = spec.split()
- data = {}
- for k in keys:
- if k == '*':
- star = {}
- for key in vals.keys():
- if key not in keys:
- star[key] = vals[key]
- data['*'] = star
- else:
- data[k] = vals[k]
- result = func(repo, proto, *[data[k] for k in keys])
- else:
- result = func(repo, proto)
- if isinstance(result, wireprototypes.ooberror):
- return result
-
- # For now, all batchable commands must return bytesresponse or
- # raw bytes (for backwards compatibility).
- assert isinstance(result, (wireprototypes.bytesresponse, bytes))
- if isinstance(result, wireprototypes.bytesresponse):
- result = result.data
- res.append(wireprototypes.escapebatcharg(result))
-
- return wireprototypes.bytesresponse(';'.join(res))
-
-@wireprotocommand('between', 'pairs', permission='pull')
-def between(repo, proto, pairs):
- pairs = [wireprototypes.decodelist(p, '-') for p in pairs.split(" ")]
- r = []
- for b in repo.between(pairs):
- r.append(wireprototypes.encodelist(b) + "\n")
-
- return wireprototypes.bytesresponse(''.join(r))
-
-@wireprotocommand('branchmap', permission='pull')
-def branchmap(repo, proto):
- branchmap = repo.branchmap()
- heads = []
- for branch, nodes in branchmap.iteritems():
- branchname = urlreq.quote(encoding.fromlocal(branch))
- branchnodes = wireprototypes.encodelist(nodes)
- heads.append('%s %s' % (branchname, branchnodes))
-
- return wireprototypes.bytesresponse('\n'.join(heads))
-
-@wireprotocommand('branches', 'nodes', permission='pull')
-def branches(repo, proto, nodes):
- nodes = wireprototypes.decodelist(nodes)
- r = []
- for b in repo.branches(nodes):
- r.append(wireprototypes.encodelist(b) + "\n")
-
- return wireprototypes.bytesresponse(''.join(r))
-
-@wireprotocommand('clonebundles', '', permission='pull')
-def clonebundles(repo, proto):
- """Server command for returning info for available bundles to seed clones.
-
- Clients will parse this response and determine what bundle to fetch.
-
- Extensions may wrap this command to filter or dynamically emit data
- depending on the request. e.g. you could advertise URLs for the closest
- data center given the client's IP address.
- """
- return wireprototypes.bytesresponse(
- repo.vfs.tryread('clonebundles.manifest'))
-
-wireprotocaps = ['lookup', 'branchmap', 'pushkey',
- 'known', 'getbundle', 'unbundlehash']
-
-def _capabilities(repo, proto):
- """return a list of capabilities for a repo
-
- This function exists to allow extensions to easily wrap capabilities
- computation
-
- - returns a lists: easy to alter
- - change done here will be propagated to both `capabilities` and `hello`
- command without any other action needed.
- """
- # copy to prevent modification of the global list
- caps = list(wireprotocaps)
-
- # Command of same name as capability isn't exposed to version 1 of
- # transports. So conditionally add it.
- if commands.commandavailable('changegroupsubset', proto):
- caps.append('changegroupsubset')
-
- if streamclone.allowservergeneration(repo):
- if repo.ui.configbool('server', 'preferuncompressed'):
- caps.append('stream-preferred')
- requiredformats = repo.requirements & repo.supportedformats
- # if our local revlogs are just revlogv1, add 'stream' cap
- if not requiredformats - {'revlogv1'}:
- caps.append('stream')
- # otherwise, add 'streamreqs' detailing our local revlog format
- else:
- caps.append('streamreqs=%s' % ','.join(sorted(requiredformats)))
- if repo.ui.configbool('experimental', 'bundle2-advertise'):
- capsblob = bundle2.encodecaps(bundle2.getrepocaps(repo, role='server'))
- caps.append('bundle2=' + urlreq.quote(capsblob))
- caps.append('unbundle=%s' % ','.join(bundle2.bundlepriority))
-
- return proto.addcapabilities(repo, caps)
-
-# If you are writing an extension and consider wrapping this function. Wrap
-# `_capabilities` instead.
-@wireprotocommand('capabilities', permission='pull')
-def capabilities(repo, proto):
- caps = _capabilities(repo, proto)
- return wireprototypes.bytesresponse(' '.join(sorted(caps)))
-
-@wireprotocommand('changegroup', 'roots', permission='pull')
-def changegroup(repo, proto, roots):
- nodes = wireprototypes.decodelist(roots)
- outgoing = discovery.outgoing(repo, missingroots=nodes,
- missingheads=repo.heads())
- cg = changegroupmod.makechangegroup(repo, outgoing, '01', 'serve')
- gen = iter(lambda: cg.read(32768), '')
- return wireprototypes.streamres(gen=gen)
-
-@wireprotocommand('changegroupsubset', 'bases heads',
- permission='pull')
-def changegroupsubset(repo, proto, bases, heads):
- bases = wireprototypes.decodelist(bases)
- heads = wireprototypes.decodelist(heads)
- outgoing = discovery.outgoing(repo, missingroots=bases,
- missingheads=heads)
- cg = changegroupmod.makechangegroup(repo, outgoing, '01', 'serve')
- gen = iter(lambda: cg.read(32768), '')
- return wireprototypes.streamres(gen=gen)
-
-@wireprotocommand('debugwireargs', 'one two *',
- permission='pull')
-def debugwireargs(repo, proto, one, two, others):
- # only accept optional args from the known set
- opts = options('debugwireargs', ['three', 'four'], others)
- return wireprototypes.bytesresponse(repo.debugwireargs(
- one, two, **pycompat.strkwargs(opts)))
-
-def find_pullbundle(repo, proto, opts, clheads, heads, common):
- """Return a file object for the first matching pullbundle.
-
- Pullbundles are specified in .hg/pullbundles.manifest similar to
- clonebundles.
- For each entry, the bundle specification is checked for compatibility:
- - Client features vs the BUNDLESPEC.
- - Revisions shared with the clients vs base revisions of the bundle.
- A bundle can be applied only if all its base revisions are known by
- the client.
- - At least one leaf of the bundle's DAG is missing on the client.
- - Every leaf of the bundle's DAG is part of node set the client wants.
- E.g. do not send a bundle of all changes if the client wants only
- one specific branch of many.
- """
- def decodehexstring(s):
- return set([h.decode('hex') for h in s.split(';')])
-
- manifest = repo.vfs.tryread('pullbundles.manifest')
- if not manifest:
- return None
- res = exchange.parseclonebundlesmanifest(repo, manifest)
- res = exchange.filterclonebundleentries(repo, res)
- if not res:
- return None
- cl = repo.changelog
- heads_anc = cl.ancestors([cl.rev(rev) for rev in heads], inclusive=True)
- common_anc = cl.ancestors([cl.rev(rev) for rev in common], inclusive=True)
- compformats = clientcompressionsupport(proto)
- for entry in res:
- if 'COMPRESSION' in entry and entry['COMPRESSION'] not in compformats:
- continue
- # No test yet for VERSION, since V2 is supported by any client
- # that advertises partial pulls
- if 'heads' in entry:
- try:
- bundle_heads = decodehexstring(entry['heads'])
- except TypeError:
- # Bad heads entry
- continue
- if bundle_heads.issubset(common):
- continue # Nothing new
- if all(cl.rev(rev) in common_anc for rev in bundle_heads):
- continue # Still nothing new
- if any(cl.rev(rev) not in heads_anc and
- cl.rev(rev) not in common_anc for rev in bundle_heads):
- continue
- if 'bases' in entry:
- try:
- bundle_bases = decodehexstring(entry['bases'])
- except TypeError:
- # Bad bases entry
- continue
- if not all(cl.rev(rev) in common_anc for rev in bundle_bases):
- continue
- path = entry['URL']
- repo.ui.debug('sending pullbundle "%s"\n' % path)
- try:
- return repo.vfs.open(path)
- except IOError:
- repo.ui.debug('pullbundle "%s" not accessible\n' % path)
- continue
- return None
-
-@wireprotocommand('getbundle', '*', permission='pull')
-def getbundle(repo, proto, others):
- opts = options('getbundle', wireprototypes.GETBUNDLE_ARGUMENTS.keys(),
- others)
- for k, v in opts.iteritems():
- keytype = wireprototypes.GETBUNDLE_ARGUMENTS[k]
- if keytype == 'nodes':
- opts[k] = wireprototypes.decodelist(v)
- elif keytype == 'csv':
- opts[k] = list(v.split(','))
- elif keytype == 'scsv':
- opts[k] = set(v.split(','))
- elif keytype == 'boolean':
- # Client should serialize False as '0', which is a non-empty string
- # so it evaluates as a True bool.
- if v == '0':
- opts[k] = False
- else:
- opts[k] = bool(v)
- elif keytype != 'plain':
- raise KeyError('unknown getbundle option type %s'
- % keytype)
-
- if not bundle1allowed(repo, 'pull'):
- if not exchange.bundle2requested(opts.get('bundlecaps')):
- if proto.name == 'http-v1':
- return wireprototypes.ooberror(bundle2required)
- raise error.Abort(bundle2requiredmain,
- hint=bundle2requiredhint)
-
- prefercompressed = True
-
- try:
- clheads = set(repo.changelog.heads())
- heads = set(opts.get('heads', set()))
- common = set(opts.get('common', set()))
- common.discard(nullid)
- if (repo.ui.configbool('server', 'pullbundle') and
- 'partial-pull' in proto.getprotocaps()):
- # Check if a pre-built bundle covers this request.
- bundle = find_pullbundle(repo, proto, opts, clheads, heads, common)
- if bundle:
- return wireprototypes.streamres(gen=util.filechunkiter(bundle),
- prefer_uncompressed=True)
-
- if repo.ui.configbool('server', 'disablefullbundle'):
- # Check to see if this is a full clone.
- changegroup = opts.get('cg', True)
- if changegroup and not common and clheads == heads:
- raise error.Abort(
- _('server has pull-based clones disabled'),
- hint=_('remove --pull if specified or upgrade Mercurial'))
-
- info, chunks = exchange.getbundlechunks(repo, 'serve',
- **pycompat.strkwargs(opts))
- prefercompressed = info.get('prefercompressed', True)
- except error.Abort as exc:
- # cleanly forward Abort error to the client
- if not exchange.bundle2requested(opts.get('bundlecaps')):
- if proto.name == 'http-v1':
- return wireprototypes.ooberror(pycompat.bytestr(exc) + '\n')
- raise # cannot do better for bundle1 + ssh
- # bundle2 request expect a bundle2 reply
- bundler = bundle2.bundle20(repo.ui)
- manargs = [('message', pycompat.bytestr(exc))]
- advargs = []
- if exc.hint is not None:
- advargs.append(('hint', exc.hint))
- bundler.addpart(bundle2.bundlepart('error:abort',
- manargs, advargs))
- chunks = bundler.getchunks()
- prefercompressed = False
-
- return wireprototypes.streamres(
- gen=chunks, prefer_uncompressed=not prefercompressed)
-
-@wireprotocommand('heads', permission='pull')
-def heads(repo, proto):
- h = repo.heads()
- return wireprototypes.bytesresponse(wireprototypes.encodelist(h) + '\n')
-
-@wireprotocommand('hello', permission='pull')
-def hello(repo, proto):
- """Called as part of SSH handshake to obtain server info.
-
- Returns a list of lines describing interesting things about the
- server, in an RFC822-like format.
-
- Currently, the only one defined is ``capabilities``, which consists of a
- line of space separated tokens describing server abilities:
-
- capabilities: <token0> <token1> <token2>
- """
- caps = capabilities(repo, proto).data
- return wireprototypes.bytesresponse('capabilities: %s\n' % caps)
-
-@wireprotocommand('listkeys', 'namespace', permission='pull')
-def listkeys(repo, proto, namespace):
- d = sorted(repo.listkeys(encoding.tolocal(namespace)).items())
- return wireprototypes.bytesresponse(pushkeymod.encodekeys(d))
-
-@wireprotocommand('lookup', 'key', permission='pull')
-def lookup(repo, proto, key):
- try:
- k = encoding.tolocal(key)
- n = repo.lookup(k)
- r = hex(n)
- success = 1
- except Exception as inst:
- r = stringutil.forcebytestr(inst)
- success = 0
- return wireprototypes.bytesresponse('%d %s\n' % (success, r))
-
-@wireprotocommand('known', 'nodes *', permission='pull')
-def known(repo, proto, nodes, others):
- v = ''.join(b and '1' or '0'
- for b in repo.known(wireprototypes.decodelist(nodes)))
- return wireprototypes.bytesresponse(v)
-
-@wireprotocommand('protocaps', 'caps', permission='pull')
-def protocaps(repo, proto, caps):
- if proto.name == wireprototypes.SSHV1:
- proto._protocaps = set(caps.split(' '))
- return wireprototypes.bytesresponse('OK')
-
-@wireprotocommand('pushkey', 'namespace key old new', permission='push')
-def pushkey(repo, proto, namespace, key, old, new):
- # compatibility with pre-1.8 clients which were accidentally
- # sending raw binary nodes rather than utf-8-encoded hex
- if len(new) == 20 and stringutil.escapestr(new) != new:
- # looks like it could be a binary node
- try:
- new.decode('utf-8')
- new = encoding.tolocal(new) # but cleanly decodes as UTF-8
- except UnicodeDecodeError:
- pass # binary, leave unmodified
- else:
- new = encoding.tolocal(new) # normal path
-
- with proto.mayberedirectstdio() as output:
- r = repo.pushkey(encoding.tolocal(namespace), encoding.tolocal(key),
- encoding.tolocal(old), new) or False
-
- output = output.getvalue() if output else ''
- return wireprototypes.bytesresponse('%d\n%s' % (int(r), output))
-
-@wireprotocommand('stream_out', permission='pull')
-def stream(repo, proto):
- '''If the server supports streaming clone, it advertises the "stream"
- capability with a value representing the version and flags of the repo
- it is serving. Client checks to see if it understands the format.
- '''
- return wireprototypes.streamreslegacy(
- streamclone.generatev1wireproto(repo))
-
-@wireprotocommand('unbundle', 'heads', permission='push')
-def unbundle(repo, proto, heads):
- their_heads = wireprototypes.decodelist(heads)
-
- with proto.mayberedirectstdio() as output:
- try:
- exchange.check_heads(repo, their_heads, 'preparing changes')
- cleanup = lambda: None
- try:
- payload = proto.getpayload()
- if repo.ui.configbool('server', 'streamunbundle'):
- def cleanup():
- # Ensure that the full payload is consumed, so
- # that the connection doesn't contain trailing garbage.
- for p in payload:
- pass
- fp = util.chunkbuffer(payload)
- else:
- # write bundle data to temporary file as it can be big
- fp, tempname = None, None
- def cleanup():
- if fp:
- fp.close()
- if tempname:
- os.unlink(tempname)
- fd, tempname = tempfile.mkstemp(prefix='hg-unbundle-')
- repo.ui.debug('redirecting incoming bundle to %s\n' %
- tempname)
- fp = os.fdopen(fd, pycompat.sysstr('wb+'))
- r = 0
- for p in payload:
- fp.write(p)
- fp.seek(0)
-
- gen = exchange.readbundle(repo.ui, fp, None)
- if (isinstance(gen, changegroupmod.cg1unpacker)
- and not bundle1allowed(repo, 'push')):
- if proto.name == 'http-v1':
- # need to special case http because stderr do not get to
- # the http client on failed push so we need to abuse
- # some other error type to make sure the message get to
- # the user.
- return wireprototypes.ooberror(bundle2required)
- raise error.Abort(bundle2requiredmain,
- hint=bundle2requiredhint)
-
- r = exchange.unbundle(repo, gen, their_heads, 'serve',
- proto.client())
- if util.safehasattr(r, 'addpart'):
- # The return looks streamable, we are in the bundle2 case
- # and should return a stream.
- return wireprototypes.streamreslegacy(gen=r.getchunks())
- return wireprototypes.pushres(
- r, output.getvalue() if output else '')
-
- finally:
- cleanup()
-
- except (error.BundleValueError, error.Abort, error.PushRaced) as exc:
- # handle non-bundle2 case first
- if not getattr(exc, 'duringunbundle2', False):
- try:
- raise
- except error.Abort:
- # The old code we moved used procutil.stderr directly.
- # We did not change it to minimise code change.
- # This need to be moved to something proper.
- # Feel free to do it.
- procutil.stderr.write("abort: %s\n" % exc)
- if exc.hint is not None:
- procutil.stderr.write("(%s)\n" % exc.hint)
- procutil.stderr.flush()
- return wireprototypes.pushres(
- 0, output.getvalue() if output else '')
- except error.PushRaced:
- return wireprototypes.pusherr(
- pycompat.bytestr(exc),
- output.getvalue() if output else '')
-
- bundler = bundle2.bundle20(repo.ui)
- for out in getattr(exc, '_bundle2salvagedoutput', ()):
- bundler.addpart(out)
- try:
- try:
- raise
- except error.PushkeyFailed as exc:
- # check client caps
- remotecaps = getattr(exc, '_replycaps', None)
- if (remotecaps is not None
- and 'pushkey' not in remotecaps.get('error', ())):
- # no support remote side, fallback to Abort handler.
- raise
- part = bundler.newpart('error:pushkey')
- part.addparam('in-reply-to', exc.partid)
- if exc.namespace is not None:
- part.addparam('namespace', exc.namespace,
- mandatory=False)
- if exc.key is not None:
- part.addparam('key', exc.key, mandatory=False)
- if exc.new is not None:
- part.addparam('new', exc.new, mandatory=False)
- if exc.old is not None:
- part.addparam('old', exc.old, mandatory=False)
- if exc.ret is not None:
- part.addparam('ret', exc.ret, mandatory=False)
- except error.BundleValueError as exc:
- errpart = bundler.newpart('error:unsupportedcontent')
- if exc.parttype is not None:
- errpart.addparam('parttype', exc.parttype)
- if exc.params:
- errpart.addparam('params', '\0'.join(exc.params))
- except error.Abort as exc:
- manargs = [('message', stringutil.forcebytestr(exc))]
- advargs = []
- if exc.hint is not None:
- advargs.append(('hint', exc.hint))
- bundler.addpart(bundle2.bundlepart('error:abort',
- manargs, advargs))
- except error.PushRaced as exc:
- bundler.newpart('error:pushraced',
- [('message', stringutil.forcebytestr(exc))])
- return wireprototypes.streamreslegacy(gen=bundler.getchunks())
--- a/mercurial/wireprotoserver.py Mon Apr 16 22:10:02 2018 -0700
+++ b/mercurial/wireprotoserver.py Mon Apr 16 22:21:54 2018 -0700
@@ -24,8 +24,8 @@
hook,
pycompat,
util,
- wireproto,
wireprototypes,
+ wireprotov1server,
wireprotov2server,
)
from .utils import (
@@ -166,7 +166,7 @@
# there are no other known users, so with any luck we can discard this
# hook if remotefilelog becomes a first-party extension.
def iscmd(cmd):
- return cmd in wireproto.commands
+ return cmd in wireprotov1server.commands
def handlewsgirequest(rctx, req, res, checkperm):
"""Possibly process a wire protocol request.
@@ -329,7 +329,7 @@
return HGTYPE2, util._noopengine(), {}
# Now find an agreed upon compression format.
- compformats = wireproto.clientcompressionsupport(proto)
+ compformats = wireprotov1server.clientcompressionsupport(proto)
for engine in wireprototypes.supportedcompengines(ui, util.SERVERROLE):
if engine.wireprotosupport().name in compformats:
opts = {}
@@ -380,7 +380,7 @@
descriptors[api] = descriptorfn(req, repo)
- v1caps = wireproto.dispatch(repo, proto, 'capabilities')
+ v1caps = wireprotov1server.dispatch(repo, proto, 'capabilities')
assert isinstance(v1caps, wireprototypes.bytesresponse)
m = {
@@ -424,13 +424,13 @@
if bodygen is not None:
res.setbodygen(bodygen)
- if not wireproto.commands.commandavailable(cmd, proto):
+ if not wireprotov1server.commands.commandavailable(cmd, proto):
setresponse(HTTP_OK, HGERRTYPE,
_('requested wire protocol command is not available over '
'HTTP'))
return
- proto.checkperm(wireproto.commands[cmd].permission)
+ proto.checkperm(wireprotov1server.commands[cmd].permission)
# Possibly handle a modern client wanting to switch protocols.
if (cmd == 'capabilities' and
@@ -438,7 +438,7 @@
return
- rsp = wireproto.dispatch(repo, proto, cmd)
+ rsp = wireprotov1server.dispatch(repo, proto, cmd)
if isinstance(rsp, bytes):
setresponse(HTTP_OK, HGTYPE, bodybytes=rsp)
@@ -649,7 +649,8 @@
state = 'upgrade-initial'
continue
- available = wireproto.commands.commandavailable(request, proto)
+ available = wireprotov1server.commands.commandavailable(
+ request, proto)
# This command isn't available. Send an empty response and go
# back to waiting for a new command.
@@ -657,7 +658,7 @@
_sshv1respondbytes(fout, b'')
continue
- rsp = wireproto.dispatch(repo, proto, request)
+ rsp = wireprotov1server.dispatch(repo, proto, request)
if isinstance(rsp, bytes):
_sshv1respondbytes(fout, rsp)
@@ -764,7 +765,7 @@
elif state == 'upgrade-v2-finish':
# Send the upgrade response.
fout.write(b'upgraded %s %s\n' % (token, SSHV2))
- servercaps = wireproto.capabilities(repo, proto)
+ servercaps = wireprotov1server.capabilities(repo, proto)
rsp = b'capabilities: %s' % servercaps.data
fout.write(b'%d\n%s\n' % (len(rsp), rsp))
fout.flush()
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/mercurial/wireprotov1server.py Mon Apr 16 22:21:54 2018 -0700
@@ -0,0 +1,667 @@
+# wireprotov1server.py - Wire protocol version 1 server functionality
+#
+# Copyright 2005-2010 Matt Mackall <mpm@selenic.com>
+#
+# This software may be used and distributed according to the terms of the
+# GNU General Public License version 2 or any later version.
+
+from __future__ import absolute_import
+
+import os
+import tempfile
+
+from .i18n import _
+from .node import (
+ hex,
+ nullid,
+)
+
+from . import (
+ bundle2,
+ changegroup as changegroupmod,
+ discovery,
+ encoding,
+ error,
+ exchange,
+ pushkey as pushkeymod,
+ pycompat,
+ streamclone,
+ util,
+ wireprototypes,
+)
+
+from .utils import (
+ procutil,
+ stringutil,
+)
+
+urlerr = util.urlerr
+urlreq = util.urlreq
+
+bundle2requiredmain = _('incompatible Mercurial client; bundle2 required')
+bundle2requiredhint = _('see https://www.mercurial-scm.org/wiki/'
+ 'IncompatibleClient')
+bundle2required = '%s\n(%s)\n' % (bundle2requiredmain, bundle2requiredhint)
+
+def clientcompressionsupport(proto):
+ """Returns a list of compression methods supported by the client.
+
+ Returns a list of the compression methods supported by the client
+ according to the protocol capabilities. If no such capability has
+ been announced, fallback to the default of zlib and uncompressed.
+ """
+ for cap in proto.getprotocaps():
+ if cap.startswith('comp='):
+ return cap[5:].split(',')
+ return ['zlib', 'none']
+
+# wire protocol command can either return a string or one of these classes.
+
+def getdispatchrepo(repo, proto, command):
+ """Obtain the repo used for processing wire protocol commands.
+
+ The intent of this function is to serve as a monkeypatch point for
+ extensions that need commands to operate on different repo views under
+ specialized circumstances.
+ """
+ return repo.filtered('served')
+
+def dispatch(repo, proto, command):
+ repo = getdispatchrepo(repo, proto, command)
+
+ func, spec = commands[command]
+ args = proto.getargs(spec)
+
+ return func(repo, proto, *args)
+
+def options(cmd, keys, others):
+ opts = {}
+ for k in keys:
+ if k in others:
+ opts[k] = others[k]
+ del others[k]
+ if others:
+ procutil.stderr.write("warning: %s ignored unexpected arguments %s\n"
+ % (cmd, ",".join(others)))
+ return opts
+
+def bundle1allowed(repo, action):
+ """Whether a bundle1 operation is allowed from the server.
+
+ Priority is:
+
+ 1. server.bundle1gd.<action> (if generaldelta active)
+ 2. server.bundle1.<action>
+ 3. server.bundle1gd (if generaldelta active)
+ 4. server.bundle1
+ """
+ ui = repo.ui
+ gd = 'generaldelta' in repo.requirements
+
+ if gd:
+ v = ui.configbool('server', 'bundle1gd.%s' % action)
+ if v is not None:
+ return v
+
+ v = ui.configbool('server', 'bundle1.%s' % action)
+ if v is not None:
+ return v
+
+ if gd:
+ v = ui.configbool('server', 'bundle1gd')
+ if v is not None:
+ return v
+
+ return ui.configbool('server', 'bundle1')
+
+commands = wireprototypes.commanddict()
+
+def wireprotocommand(name, args=None, permission='push'):
+ """Decorator to declare a wire protocol command.
+
+ ``name`` is the name of the wire protocol command being provided.
+
+ ``args`` defines the named arguments accepted by the command. It is
+ a space-delimited list of argument names. ``*`` denotes a special value
+ that says to accept all named arguments.
+
+ ``permission`` defines the permission type needed to run this command.
+ Can be ``push`` or ``pull``. These roughly map to read-write and read-only,
+ respectively. Default is to assume command requires ``push`` permissions
+ because otherwise commands not declaring their permissions could modify
+ a repository that is supposed to be read-only.
+ """
+ transports = {k for k, v in wireprototypes.TRANSPORTS.items()
+ if v['version'] == 1}
+
+ # Because SSHv2 is a mirror of SSHv1, we allow "batch" commands through to
+ # SSHv2.
+ # TODO undo this hack when SSH is using the unified frame protocol.
+ if name == b'batch':
+ transports.add(wireprototypes.SSHV2)
+
+ if permission not in ('push', 'pull'):
+ raise error.ProgrammingError('invalid wire protocol permission; '
+ 'got %s; expected "push" or "pull"' %
+ permission)
+
+ if args is None:
+ args = ''
+
+ if not isinstance(args, bytes):
+ raise error.ProgrammingError('arguments for version 1 commands '
+ 'must be declared as bytes')
+
+ def register(func):
+ if name in commands:
+ raise error.ProgrammingError('%s command already registered '
+ 'for version 1' % name)
+ commands[name] = wireprototypes.commandentry(
+ func, args=args, transports=transports, permission=permission)
+
+ return func
+ return register
+
+# TODO define a more appropriate permissions type to use for this.
+@wireprotocommand('batch', 'cmds *', permission='pull')
+def batch(repo, proto, cmds, others):
+ unescapearg = wireprototypes.unescapebatcharg
+ repo = repo.filtered("served")
+ res = []
+ for pair in cmds.split(';'):
+ op, args = pair.split(' ', 1)
+ vals = {}
+ for a in args.split(','):
+ if a:
+ n, v = a.split('=')
+ vals[unescapearg(n)] = unescapearg(v)
+ func, spec = commands[op]
+
+ # Validate that client has permissions to perform this command.
+ perm = commands[op].permission
+ assert perm in ('push', 'pull')
+ proto.checkperm(perm)
+
+ if spec:
+ keys = spec.split()
+ data = {}
+ for k in keys:
+ if k == '*':
+ star = {}
+ for key in vals.keys():
+ if key not in keys:
+ star[key] = vals[key]
+ data['*'] = star
+ else:
+ data[k] = vals[k]
+ result = func(repo, proto, *[data[k] for k in keys])
+ else:
+ result = func(repo, proto)
+ if isinstance(result, wireprototypes.ooberror):
+ return result
+
+ # For now, all batchable commands must return bytesresponse or
+ # raw bytes (for backwards compatibility).
+ assert isinstance(result, (wireprototypes.bytesresponse, bytes))
+ if isinstance(result, wireprototypes.bytesresponse):
+ result = result.data
+ res.append(wireprototypes.escapebatcharg(result))
+
+ return wireprototypes.bytesresponse(';'.join(res))
+
+@wireprotocommand('between', 'pairs', permission='pull')
+def between(repo, proto, pairs):
+ pairs = [wireprototypes.decodelist(p, '-') for p in pairs.split(" ")]
+ r = []
+ for b in repo.between(pairs):
+ r.append(wireprototypes.encodelist(b) + "\n")
+
+ return wireprototypes.bytesresponse(''.join(r))
+
+@wireprotocommand('branchmap', permission='pull')
+def branchmap(repo, proto):
+ branchmap = repo.branchmap()
+ heads = []
+ for branch, nodes in branchmap.iteritems():
+ branchname = urlreq.quote(encoding.fromlocal(branch))
+ branchnodes = wireprototypes.encodelist(nodes)
+ heads.append('%s %s' % (branchname, branchnodes))
+
+ return wireprototypes.bytesresponse('\n'.join(heads))
+
+@wireprotocommand('branches', 'nodes', permission='pull')
+def branches(repo, proto, nodes):
+ nodes = wireprototypes.decodelist(nodes)
+ r = []
+ for b in repo.branches(nodes):
+ r.append(wireprototypes.encodelist(b) + "\n")
+
+ return wireprototypes.bytesresponse(''.join(r))
+
+@wireprotocommand('clonebundles', '', permission='pull')
+def clonebundles(repo, proto):
+ """Server command for returning info for available bundles to seed clones.
+
+ Clients will parse this response and determine what bundle to fetch.
+
+ Extensions may wrap this command to filter or dynamically emit data
+ depending on the request. e.g. you could advertise URLs for the closest
+ data center given the client's IP address.
+ """
+ return wireprototypes.bytesresponse(
+ repo.vfs.tryread('clonebundles.manifest'))
+
+wireprotocaps = ['lookup', 'branchmap', 'pushkey',
+ 'known', 'getbundle', 'unbundlehash']
+
+def _capabilities(repo, proto):
+ """return a list of capabilities for a repo
+
+ This function exists to allow extensions to easily wrap capabilities
+ computation
+
+ - returns a lists: easy to alter
+ - change done here will be propagated to both `capabilities` and `hello`
+ command without any other action needed.
+ """
+ # copy to prevent modification of the global list
+ caps = list(wireprotocaps)
+
+ # Command of same name as capability isn't exposed to version 1 of
+ # transports. So conditionally add it.
+ if commands.commandavailable('changegroupsubset', proto):
+ caps.append('changegroupsubset')
+
+ if streamclone.allowservergeneration(repo):
+ if repo.ui.configbool('server', 'preferuncompressed'):
+ caps.append('stream-preferred')
+ requiredformats = repo.requirements & repo.supportedformats
+ # if our local revlogs are just revlogv1, add 'stream' cap
+ if not requiredformats - {'revlogv1'}:
+ caps.append('stream')
+ # otherwise, add 'streamreqs' detailing our local revlog format
+ else:
+ caps.append('streamreqs=%s' % ','.join(sorted(requiredformats)))
+ if repo.ui.configbool('experimental', 'bundle2-advertise'):
+ capsblob = bundle2.encodecaps(bundle2.getrepocaps(repo, role='server'))
+ caps.append('bundle2=' + urlreq.quote(capsblob))
+ caps.append('unbundle=%s' % ','.join(bundle2.bundlepriority))
+
+ return proto.addcapabilities(repo, caps)
+
+# If you are writing an extension and consider wrapping this function. Wrap
+# `_capabilities` instead.
+@wireprotocommand('capabilities', permission='pull')
+def capabilities(repo, proto):
+ caps = _capabilities(repo, proto)
+ return wireprototypes.bytesresponse(' '.join(sorted(caps)))
+
+@wireprotocommand('changegroup', 'roots', permission='pull')
+def changegroup(repo, proto, roots):
+ nodes = wireprototypes.decodelist(roots)
+ outgoing = discovery.outgoing(repo, missingroots=nodes,
+ missingheads=repo.heads())
+ cg = changegroupmod.makechangegroup(repo, outgoing, '01', 'serve')
+ gen = iter(lambda: cg.read(32768), '')
+ return wireprototypes.streamres(gen=gen)
+
+@wireprotocommand('changegroupsubset', 'bases heads',
+ permission='pull')
+def changegroupsubset(repo, proto, bases, heads):
+ bases = wireprototypes.decodelist(bases)
+ heads = wireprototypes.decodelist(heads)
+ outgoing = discovery.outgoing(repo, missingroots=bases,
+ missingheads=heads)
+ cg = changegroupmod.makechangegroup(repo, outgoing, '01', 'serve')
+ gen = iter(lambda: cg.read(32768), '')
+ return wireprototypes.streamres(gen=gen)
+
+@wireprotocommand('debugwireargs', 'one two *',
+ permission='pull')
+def debugwireargs(repo, proto, one, two, others):
+ # only accept optional args from the known set
+ opts = options('debugwireargs', ['three', 'four'], others)
+ return wireprototypes.bytesresponse(repo.debugwireargs(
+ one, two, **pycompat.strkwargs(opts)))
+
+def find_pullbundle(repo, proto, opts, clheads, heads, common):
+ """Return a file object for the first matching pullbundle.
+
+ Pullbundles are specified in .hg/pullbundles.manifest similar to
+ clonebundles.
+ For each entry, the bundle specification is checked for compatibility:
+ - Client features vs the BUNDLESPEC.
+ - Revisions shared with the clients vs base revisions of the bundle.
+ A bundle can be applied only if all its base revisions are known by
+ the client.
+ - At least one leaf of the bundle's DAG is missing on the client.
+ - Every leaf of the bundle's DAG is part of node set the client wants.
+ E.g. do not send a bundle of all changes if the client wants only
+ one specific branch of many.
+ """
+ def decodehexstring(s):
+ return set([h.decode('hex') for h in s.split(';')])
+
+ manifest = repo.vfs.tryread('pullbundles.manifest')
+ if not manifest:
+ return None
+ res = exchange.parseclonebundlesmanifest(repo, manifest)
+ res = exchange.filterclonebundleentries(repo, res)
+ if not res:
+ return None
+ cl = repo.changelog
+ heads_anc = cl.ancestors([cl.rev(rev) for rev in heads], inclusive=True)
+ common_anc = cl.ancestors([cl.rev(rev) for rev in common], inclusive=True)
+ compformats = clientcompressionsupport(proto)
+ for entry in res:
+ if 'COMPRESSION' in entry and entry['COMPRESSION'] not in compformats:
+ continue
+ # No test yet for VERSION, since V2 is supported by any client
+ # that advertises partial pulls
+ if 'heads' in entry:
+ try:
+ bundle_heads = decodehexstring(entry['heads'])
+ except TypeError:
+ # Bad heads entry
+ continue
+ if bundle_heads.issubset(common):
+ continue # Nothing new
+ if all(cl.rev(rev) in common_anc for rev in bundle_heads):
+ continue # Still nothing new
+ if any(cl.rev(rev) not in heads_anc and
+ cl.rev(rev) not in common_anc for rev in bundle_heads):
+ continue
+ if 'bases' in entry:
+ try:
+ bundle_bases = decodehexstring(entry['bases'])
+ except TypeError:
+ # Bad bases entry
+ continue
+ if not all(cl.rev(rev) in common_anc for rev in bundle_bases):
+ continue
+ path = entry['URL']
+ repo.ui.debug('sending pullbundle "%s"\n' % path)
+ try:
+ return repo.vfs.open(path)
+ except IOError:
+ repo.ui.debug('pullbundle "%s" not accessible\n' % path)
+ continue
+ return None
+
+@wireprotocommand('getbundle', '*', permission='pull')
+def getbundle(repo, proto, others):
+ opts = options('getbundle', wireprototypes.GETBUNDLE_ARGUMENTS.keys(),
+ others)
+ for k, v in opts.iteritems():
+ keytype = wireprototypes.GETBUNDLE_ARGUMENTS[k]
+ if keytype == 'nodes':
+ opts[k] = wireprototypes.decodelist(v)
+ elif keytype == 'csv':
+ opts[k] = list(v.split(','))
+ elif keytype == 'scsv':
+ opts[k] = set(v.split(','))
+ elif keytype == 'boolean':
+ # Client should serialize False as '0', which is a non-empty string
+ # so it evaluates as a True bool.
+ if v == '0':
+ opts[k] = False
+ else:
+ opts[k] = bool(v)
+ elif keytype != 'plain':
+ raise KeyError('unknown getbundle option type %s'
+ % keytype)
+
+ if not bundle1allowed(repo, 'pull'):
+ if not exchange.bundle2requested(opts.get('bundlecaps')):
+ if proto.name == 'http-v1':
+ return wireprototypes.ooberror(bundle2required)
+ raise error.Abort(bundle2requiredmain,
+ hint=bundle2requiredhint)
+
+ prefercompressed = True
+
+ try:
+ clheads = set(repo.changelog.heads())
+ heads = set(opts.get('heads', set()))
+ common = set(opts.get('common', set()))
+ common.discard(nullid)
+ if (repo.ui.configbool('server', 'pullbundle') and
+ 'partial-pull' in proto.getprotocaps()):
+ # Check if a pre-built bundle covers this request.
+ bundle = find_pullbundle(repo, proto, opts, clheads, heads, common)
+ if bundle:
+ return wireprototypes.streamres(gen=util.filechunkiter(bundle),
+ prefer_uncompressed=True)
+
+ if repo.ui.configbool('server', 'disablefullbundle'):
+ # Check to see if this is a full clone.
+ changegroup = opts.get('cg', True)
+ if changegroup and not common and clheads == heads:
+ raise error.Abort(
+ _('server has pull-based clones disabled'),
+ hint=_('remove --pull if specified or upgrade Mercurial'))
+
+ info, chunks = exchange.getbundlechunks(repo, 'serve',
+ **pycompat.strkwargs(opts))
+ prefercompressed = info.get('prefercompressed', True)
+ except error.Abort as exc:
+ # cleanly forward Abort error to the client
+ if not exchange.bundle2requested(opts.get('bundlecaps')):
+ if proto.name == 'http-v1':
+ return wireprototypes.ooberror(pycompat.bytestr(exc) + '\n')
+ raise # cannot do better for bundle1 + ssh
+ # bundle2 request expect a bundle2 reply
+ bundler = bundle2.bundle20(repo.ui)
+ manargs = [('message', pycompat.bytestr(exc))]
+ advargs = []
+ if exc.hint is not None:
+ advargs.append(('hint', exc.hint))
+ bundler.addpart(bundle2.bundlepart('error:abort',
+ manargs, advargs))
+ chunks = bundler.getchunks()
+ prefercompressed = False
+
+ return wireprototypes.streamres(
+ gen=chunks, prefer_uncompressed=not prefercompressed)
+
+@wireprotocommand('heads', permission='pull')
+def heads(repo, proto):
+ h = repo.heads()
+ return wireprototypes.bytesresponse(wireprototypes.encodelist(h) + '\n')
+
+@wireprotocommand('hello', permission='pull')
+def hello(repo, proto):
+ """Called as part of SSH handshake to obtain server info.
+
+ Returns a list of lines describing interesting things about the
+ server, in an RFC822-like format.
+
+ Currently, the only one defined is ``capabilities``, which consists of a
+ line of space separated tokens describing server abilities:
+
+ capabilities: <token0> <token1> <token2>
+ """
+ caps = capabilities(repo, proto).data
+ return wireprototypes.bytesresponse('capabilities: %s\n' % caps)
+
+@wireprotocommand('listkeys', 'namespace', permission='pull')
+def listkeys(repo, proto, namespace):
+ d = sorted(repo.listkeys(encoding.tolocal(namespace)).items())
+ return wireprototypes.bytesresponse(pushkeymod.encodekeys(d))
+
+@wireprotocommand('lookup', 'key', permission='pull')
+def lookup(repo, proto, key):
+ try:
+ k = encoding.tolocal(key)
+ n = repo.lookup(k)
+ r = hex(n)
+ success = 1
+ except Exception as inst:
+ r = stringutil.forcebytestr(inst)
+ success = 0
+ return wireprototypes.bytesresponse('%d %s\n' % (success, r))
+
+@wireprotocommand('known', 'nodes *', permission='pull')
+def known(repo, proto, nodes, others):
+ v = ''.join(b and '1' or '0'
+ for b in repo.known(wireprototypes.decodelist(nodes)))
+ return wireprototypes.bytesresponse(v)
+
+@wireprotocommand('protocaps', 'caps', permission='pull')
+def protocaps(repo, proto, caps):
+ if proto.name == wireprototypes.SSHV1:
+ proto._protocaps = set(caps.split(' '))
+ return wireprototypes.bytesresponse('OK')
+
+@wireprotocommand('pushkey', 'namespace key old new', permission='push')
+def pushkey(repo, proto, namespace, key, old, new):
+ # compatibility with pre-1.8 clients which were accidentally
+ # sending raw binary nodes rather than utf-8-encoded hex
+ if len(new) == 20 and stringutil.escapestr(new) != new:
+ # looks like it could be a binary node
+ try:
+ new.decode('utf-8')
+ new = encoding.tolocal(new) # but cleanly decodes as UTF-8
+ except UnicodeDecodeError:
+ pass # binary, leave unmodified
+ else:
+ new = encoding.tolocal(new) # normal path
+
+ with proto.mayberedirectstdio() as output:
+ r = repo.pushkey(encoding.tolocal(namespace), encoding.tolocal(key),
+ encoding.tolocal(old), new) or False
+
+ output = output.getvalue() if output else ''
+ return wireprototypes.bytesresponse('%d\n%s' % (int(r), output))
+
+@wireprotocommand('stream_out', permission='pull')
+def stream(repo, proto):
+ '''If the server supports streaming clone, it advertises the "stream"
+ capability with a value representing the version and flags of the repo
+ it is serving. Client checks to see if it understands the format.
+ '''
+ return wireprototypes.streamreslegacy(
+ streamclone.generatev1wireproto(repo))
+
+@wireprotocommand('unbundle', 'heads', permission='push')
+def unbundle(repo, proto, heads):
+ their_heads = wireprototypes.decodelist(heads)
+
+ with proto.mayberedirectstdio() as output:
+ try:
+ exchange.check_heads(repo, their_heads, 'preparing changes')
+ cleanup = lambda: None
+ try:
+ payload = proto.getpayload()
+ if repo.ui.configbool('server', 'streamunbundle'):
+ def cleanup():
+ # Ensure that the full payload is consumed, so
+ # that the connection doesn't contain trailing garbage.
+ for p in payload:
+ pass
+ fp = util.chunkbuffer(payload)
+ else:
+ # write bundle data to temporary file as it can be big
+ fp, tempname = None, None
+ def cleanup():
+ if fp:
+ fp.close()
+ if tempname:
+ os.unlink(tempname)
+ fd, tempname = tempfile.mkstemp(prefix='hg-unbundle-')
+ repo.ui.debug('redirecting incoming bundle to %s\n' %
+ tempname)
+ fp = os.fdopen(fd, pycompat.sysstr('wb+'))
+ r = 0
+ for p in payload:
+ fp.write(p)
+ fp.seek(0)
+
+ gen = exchange.readbundle(repo.ui, fp, None)
+ if (isinstance(gen, changegroupmod.cg1unpacker)
+ and not bundle1allowed(repo, 'push')):
+ if proto.name == 'http-v1':
+ # need to special case http because stderr do not get to
+ # the http client on failed push so we need to abuse
+ # some other error type to make sure the message get to
+ # the user.
+ return wireprototypes.ooberror(bundle2required)
+ raise error.Abort(bundle2requiredmain,
+ hint=bundle2requiredhint)
+
+ r = exchange.unbundle(repo, gen, their_heads, 'serve',
+ proto.client())
+ if util.safehasattr(r, 'addpart'):
+ # The return looks streamable, we are in the bundle2 case
+ # and should return a stream.
+ return wireprototypes.streamreslegacy(gen=r.getchunks())
+ return wireprototypes.pushres(
+ r, output.getvalue() if output else '')
+
+ finally:
+ cleanup()
+
+ except (error.BundleValueError, error.Abort, error.PushRaced) as exc:
+ # handle non-bundle2 case first
+ if not getattr(exc, 'duringunbundle2', False):
+ try:
+ raise
+ except error.Abort:
+ # The old code we moved used procutil.stderr directly.
+ # We did not change it to minimise code change.
+ # This need to be moved to something proper.
+ # Feel free to do it.
+ procutil.stderr.write("abort: %s\n" % exc)
+ if exc.hint is not None:
+ procutil.stderr.write("(%s)\n" % exc.hint)
+ procutil.stderr.flush()
+ return wireprototypes.pushres(
+ 0, output.getvalue() if output else '')
+ except error.PushRaced:
+ return wireprototypes.pusherr(
+ pycompat.bytestr(exc),
+ output.getvalue() if output else '')
+
+ bundler = bundle2.bundle20(repo.ui)
+ for out in getattr(exc, '_bundle2salvagedoutput', ()):
+ bundler.addpart(out)
+ try:
+ try:
+ raise
+ except error.PushkeyFailed as exc:
+ # check client caps
+ remotecaps = getattr(exc, '_replycaps', None)
+ if (remotecaps is not None
+ and 'pushkey' not in remotecaps.get('error', ())):
+ # no support remote side, fallback to Abort handler.
+ raise
+ part = bundler.newpart('error:pushkey')
+ part.addparam('in-reply-to', exc.partid)
+ if exc.namespace is not None:
+ part.addparam('namespace', exc.namespace,
+ mandatory=False)
+ if exc.key is not None:
+ part.addparam('key', exc.key, mandatory=False)
+ if exc.new is not None:
+ part.addparam('new', exc.new, mandatory=False)
+ if exc.old is not None:
+ part.addparam('old', exc.old, mandatory=False)
+ if exc.ret is not None:
+ part.addparam('ret', exc.ret, mandatory=False)
+ except error.BundleValueError as exc:
+ errpart = bundler.newpart('error:unsupportedcontent')
+ if exc.parttype is not None:
+ errpart.addparam('parttype', exc.parttype)
+ if exc.params:
+ errpart.addparam('params', '\0'.join(exc.params))
+ except error.Abort as exc:
+ manargs = [('message', stringutil.forcebytestr(exc))]
+ advargs = []
+ if exc.hint is not None:
+ advargs.append(('hint', exc.hint))
+ bundler.addpart(bundle2.bundlepart('error:abort',
+ manargs, advargs))
+ except error.PushRaced as exc:
+ bundler.newpart('error:pushraced',
+ [('message', stringutil.forcebytestr(exc))])
+ return wireprototypes.streamreslegacy(gen=bundler.getchunks())
--- a/tests/sshprotoext.py Mon Apr 16 22:10:02 2018 -0700
+++ b/tests/sshprotoext.py Mon Apr 16 22:21:54 2018 -0700
@@ -15,8 +15,8 @@
extensions,
registrar,
sshpeer,
- wireproto,
wireprotoserver,
+ wireprotov1server,
)
configtable = {}
@@ -50,7 +50,7 @@
assert l == b'between\n'
proto = wireprotoserver.sshv1protocolhandler(self._ui, self._fin,
self._fout)
- rsp = wireproto.dispatch(self._repo, proto, b'between')
+ rsp = wireprotov1server.dispatch(self._repo, proto, b'between')
wireprotoserver._sshv1respondbytes(self._fout, rsp.data)
super(prehelloserver, self).serve_forever()
--- a/tests/test-http-permissions.t Mon Apr 16 22:10:02 2018 -0700
+++ b/tests/test-http-permissions.t Mon Apr 16 22:21:54 2018 -0700
@@ -3,7 +3,7 @@
$ cat > fakeremoteuser.py << EOF
> import os
> from mercurial.hgweb import hgweb_mod
- > from mercurial import wireproto
+ > from mercurial import wireprotov1server
> class testenvhgweb(hgweb_mod.hgweb):
> def __call__(self, env, respond):
> # Allow REMOTE_USER to define authenticated user.
@@ -15,16 +15,16 @@
> return super(testenvhgweb, self).__call__(env, respond)
> hgweb_mod.hgweb = testenvhgweb
>
- > @wireproto.wireprotocommand('customreadnoperm')
+ > @wireprotov1server.wireprotocommand('customreadnoperm')
> def customread(repo, proto):
> return b'read-only command no defined permissions\n'
- > @wireproto.wireprotocommand('customwritenoperm')
+ > @wireprotov1server.wireprotocommand('customwritenoperm')
> def customwritenoperm(repo, proto):
> return b'write command no defined permissions\n'
- > @wireproto.wireprotocommand('customreadwithperm', permission='pull')
+ > @wireprotov1server.wireprotocommand('customreadwithperm', permission='pull')
> def customreadwithperm(repo, proto):
> return b'read-only command w/ defined permissions\n'
- > @wireproto.wireprotocommand('customwritewithperm', permission='push')
+ > @wireprotov1server.wireprotocommand('customwritewithperm', permission='push')
> def customwritewithperm(repo, proto):
> return b'write command w/ defined permissions\n'
> EOF
--- a/tests/test-sshserver.py Mon Apr 16 22:10:02 2018 -0700
+++ b/tests/test-sshserver.py Mon Apr 16 22:21:54 2018 -0700
@@ -6,8 +6,8 @@
import silenttestrunner
from mercurial import (
- wireproto,
wireprotoserver,
+ wireprotov1server,
)
from mercurial.utils import (
@@ -29,7 +29,7 @@
proto = wireprotoserver.sshv1protocolhandler(server._ui,
server._fin,
server._fout)
- _func, spec = wireproto.commands[cmd]
+ _func, spec = wireprotov1server.commands[cmd]
self.assertEqual(proto.getargs(spec), expected)
def mockserver(inbytes):
--- a/tests/test-wireproto.py Mon Apr 16 22:10:02 2018 -0700
+++ b/tests/test-wireproto.py Mon Apr 16 22:21:54 2018 -0700
@@ -5,9 +5,9 @@
pycompat,
ui as uimod,
util,
- wireproto,
wireprototypes,
wireprotov1peer,
+ wireprotov1server,
)
stringio = util.stringio
@@ -55,7 +55,7 @@
def _call(self, cmd, **args):
args = pycompat.byteskwargs(args)
- res = wireproto.dispatch(self.serverrepo, proto(args), cmd)
+ res = wireprotov1server.dispatch(self.serverrepo, proto(args), cmd)
if isinstance(res, wireprototypes.bytesresponse):
return res.data
elif isinstance(res, bytes):
@@ -87,7 +87,7 @@
def greet(repo, proto, name):
return mangle(repo.greet(unmangle(name)))
-wireproto.commands[b'greet'] = (greet, b'name',)
+wireprotov1server.commands[b'greet'] = (greet, b'name')
srv = serverrepo()
clt = clientpeer(srv, uimod.ui())
--- a/tests/wireprotohelpers.sh Mon Apr 16 22:10:02 2018 -0700
+++ b/tests/wireprotohelpers.sh Mon Apr 16 22:21:54 2018 -0700
@@ -16,11 +16,11 @@
cat > dummycommands.py << EOF
from mercurial import (
wireprototypes,
+ wireprotov1server,
wireprotov2server,
- wireproto,
)
-@wireproto.wireprotocommand('customreadonly', permission='pull')
+@wireprotov1server.wireprotocommand('customreadonly', permission='pull')
def customreadonlyv1(repo, proto):
return wireprototypes.bytesresponse(b'customreadonly bytes response')
@@ -28,7 +28,7 @@
def customreadonlyv2(repo, proto):
return wireprototypes.cborresponse(b'customreadonly bytes response')
-@wireproto.wireprotocommand('customreadwrite', permission='push')
+@wireprotov1server.wireprotocommand('customreadwrite', permission='push')
def customreadwrite(repo, proto):
return wireprototypes.bytesresponse(b'customreadwrite bytes response')