##// END OF EJS Templates
test-obsolete-bundle-strip: add globs for Windows
test-obsolete-bundle-strip: add globs for Windows

File last commit:

r32062:ad6c5497 stable
r32693:c401ad7f default
Show More
sshpeer.py
367 lines | 11.6 KiB | text/x-python | PythonLexer
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 # sshpeer.py - ssh repository proxy class for mercurial
#
# Copyright 2005, 2006 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.
Gregory Szorc
sshpeer: use absolute_import
r25975 from __future__ import absolute_import
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 import re
Gregory Szorc
sshpeer: use absolute_import
r25975
from .i18n import _
from . import (
error,
util,
wireproto,
)
Peter Arrenbrecht
peer: introduce real peer classes...
r17192
class remotelock(object):
def __init__(self, repo):
self.repo = repo
def release(self):
self.repo.unlock()
self.repo = None
Bryan O'Sullivan
sshpeer: make remotelock a context manager
r27798 def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
if self.repo:
self.release()
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 def __del__(self):
if self.repo:
self.release()
def _serverquote(s):
Matt Mackall
sshpeer: more thorough shell quoting...
r23671 if not s:
return s
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 '''quote a string for the remote shell ... which we assume is sh'''
if re.match('[a-zA-Z0-9@%_+=:,./-]*$', s):
return s
return "'%s'" % s.replace("'", "'\\''")
Pierre-Yves David
sshpeer: extract the forward output logic...
r25244 def _forwardoutput(ui, pipe):
"""display all data currently available on pipe as remote output.
This is non blocking."""
s = util.readpipe(pipe)
if s:
for l in s.splitlines():
ui.status(_("remote: "), l, '\n')
Pierre-Yves David
sshpeer: introduce a "doublepipe" class...
r25421 class doublepipe(object):
"""Operate a side-channel pipe in addition of a main one
The side-channel pipe contains server output to be forwarded to the user
input. The double pipe will behave as the "main" pipe, but will ensure the
content of the "side" pipe is properly processed while we wait for blocking
call on the "main" pipe.
If large amounts of data are read from "main", the forward will cease after
the first bytes start to appear. This simplifies the implementation
without affecting actual output of sshpeer too much as we rarely issue
large read for data not yet emitted by the server.
The main pipe is expected to be a 'bufferedinputpipe' from the util module
Augie Fackler
sshpeer: fix docstring typo
r31953 that handle all the os specific bits. This class lives in this module
Mads Kiilerich
spelling: trivial spell checking
r26781 because it focus on behavior specific to the ssh protocol."""
Pierre-Yves David
sshpeer: introduce a "doublepipe" class...
r25421
def __init__(self, ui, main, side):
self._ui = ui
self._main = main
self._side = side
def _wait(self):
"""wait until some data are available on main or side
return a pair of boolean (ismainready, issideready)
(This will only wait for data if the setup is supported by `util.poll`)
"""
Pierre-Yves David
sshpeer: allow doublepipe on unbuffered main pipe...
r25457 if getattr(self._main, 'hasbuffer', False): # getattr for classic pipe
Pierre-Yves David
sshpeer: introduce a "doublepipe" class...
r25421 return (True, True) # main has data, assume side is worth poking at.
fds = [self._main.fileno(), self._side.fileno()]
try:
act = util.poll(fds)
except NotImplementedError:
# non supported yet case, assume all have data.
act = fds
return (self._main.fileno() in act, self._side.fileno() in act)
Pierre-Yves David
sshpeer: allow write operations through double pipe...
r25456 def write(self, data):
return self._call('write', data)
Pierre-Yves David
sshpeer: introduce a "doublepipe" class...
r25421 def read(self, size):
Augie Fackler
sshpeer: try harder to snag stderr when stdout closes unexpectedly...
r32062 r = self._call('read', size)
if size != 0 and not r:
# We've observed a condition that indicates the
# stdout closed unexpectedly. Check stderr one
# more time and snag anything that's there before
# letting anyone know the main part of the pipe
# closed prematurely.
_forwardoutput(self._ui, self._side)
return r
Pierre-Yves David
sshpeer: introduce a "doublepipe" class...
r25421
def readline(self):
return self._call('readline')
Pierre-Yves David
sshpeer: rename 'size' to 'data' in doublepipe...
r25455 def _call(self, methname, data=None):
Pierre-Yves David
sshpeer: introduce a "doublepipe" class...
r25421 """call <methname> on "main", forward output of "side" while blocking
"""
Pierre-Yves David
sshpeer: rename 'size' to 'data' in doublepipe...
r25455 # data can be '' or 0
if (data is not None and not data) or self._main.closed:
Pierre-Yves David
sshpeer: introduce a "doublepipe" class...
r25421 _forwardoutput(self._ui, self._side)
return ''
while True:
mainready, sideready = self._wait()
if sideready:
_forwardoutput(self._ui, self._side)
if mainready:
meth = getattr(self._main, methname)
Pierre-Yves David
sshpeer: rename 'size' to 'data' in doublepipe...
r25455 if data is None:
Pierre-Yves David
sshpeer: introduce a "doublepipe" class...
r25421 return meth()
else:
Pierre-Yves David
sshpeer: rename 'size' to 'data' in doublepipe...
r25455 return meth(data)
Pierre-Yves David
sshpeer: introduce a "doublepipe" class...
r25421
def close(self):
return self._main.close()
Pierre-Yves David
sshpeer: allow write operations through double pipe...
r25456 def flush(self):
return self._main.flush()
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 class sshpeer(wireproto.wirepeer):
def __init__(self, ui, path, create=False):
self._url = path
self.ui = ui
self.pipeo = self.pipei = self.pipee = None
u = util.url(path, parsequery=False, parsefragment=False)
if u.scheme != 'ssh' or not u.host or u.path is None:
self._abort(error.RepoError(_("couldn't parse location %s") % path))
self.user = u.user
if u.passwd is not None:
self._abort(error.RepoError(_("password in URL not supported")))
self.host = u.host
self.port = u.port
self.path = u.path or "."
sshcmd = self.ui.config("ui", "ssh", "ssh")
remotecmd = self.ui.config("ui", "remotecmd", "hg")
Matt Mackall
sshpeer: more thorough shell quoting...
r23671 args = util.sshargs(sshcmd,
_serverquote(self.host),
_serverquote(self.user),
_serverquote(self.port))
Peter Arrenbrecht
peer: introduce real peer classes...
r17192
if create:
cmd = '%s %s %s' % (sshcmd, args,
util.shellquote("%s init %s" %
(_serverquote(remotecmd), _serverquote(self.path))))
Siddharth Agarwal
sshpeer: only print out 'running ssh' messages in debug mode (BC)...
r20794 ui.debug('running %s\n' % cmd)
Simon Farnsworth
sshpeer: set a blockedtag when starting ssh...
r31197 res = ui.system(cmd, blockedtag='sshpeer')
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 if res != 0:
self._abort(error.RepoError(_("could not create remote repo")))
Matt Mackall
sshpeer: mark _validrepo internal
r19405 self._validaterepo(sshcmd, args, remotecmd)
Peter Arrenbrecht
peer: introduce real peer classes...
r17192
def url(self):
return self._url
Matt Mackall
sshpeer: mark _validrepo internal
r19405 def _validaterepo(self, sshcmd, args, remotecmd):
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 # cleanup up previous run
self.cleanup()
cmd = '%s %s %s' % (sshcmd, args,
util.shellquote("%s -R %s serve --stdio" %
(_serverquote(remotecmd), _serverquote(self.path))))
Siddharth Agarwal
sshpeer: only print out 'running ssh' messages in debug mode (BC)...
r20794 self.ui.debug('running %s\n' % cmd)
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 cmd = util.quotecommand(cmd)
Durham Goode
sshpeer: store subprocess so it cleans up correctly...
r18759
# while self.subprocess isn't used, having it allows the subprocess to
# to clean up correctly later
Pierre-Yves David
sshpeer: run the ssh command unbuffered...
r25408 #
# no buffer allow the use of 'select'
# feel free to remove buffering and select usage when we ultimately
# move to threading.
sub = util.popen4(cmd, bufsize=0)
self.pipeo, self.pipei, self.pipee, self.subprocess = sub
Peter Arrenbrecht
peer: introduce real peer classes...
r17192
Pierre-Yves David
sshpeer: use a 'bufferedinputpipe' for standard output of the ssh process...
r25407 self.pipei = util.bufferedinputpipe(self.pipei)
Pierre-Yves David
sshpeer: use the doublepipe object for the server to client channel...
r25422 self.pipei = doublepipe(self.ui, self.pipei, self.pipee)
Pierre-Yves David
sshpeer: also use doublepipe for client to server communication...
r25458 self.pipeo = doublepipe(self.ui, self.pipeo, self.pipee)
Pierre-Yves David
sshpeer: use a 'bufferedinputpipe' for standard output of the ssh process...
r25407
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 # skip any noise generated by remote shell
self._callstream("hello")
r = self._callstream("between", pairs=("%s-%s" % ("0"*40, "0"*40)))
lines = ["", "dummy"]
max_noise = 500
while lines[-1] and max_noise:
l = r.readline()
self.readerr()
if lines[-1] == "1\n" and l == "\n":
break
if l:
Matt Mackall
sshpeer: mark _validrepo internal
r19405 self.ui.debug("remote: ", l)
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 lines.append(l)
max_noise -= 1
else:
self._abort(error.RepoError(_('no suitable response from '
'remote hg')))
self._caps = set()
for l in reversed(lines):
if l.startswith("capabilities:"):
self._caps.update(l[:-1].split(":")[1].split())
break
def _capabilities(self):
return self._caps
def readerr(self):
Pierre-Yves David
sshpeer: extract the forward output logic...
r25244 _forwardoutput(self.ui, self.pipee)
Peter Arrenbrecht
peer: introduce real peer classes...
r17192
def _abort(self, exception):
self.cleanup()
raise exception
def cleanup(self):
if self.pipeo is None:
return
self.pipeo.close()
self.pipei.close()
try:
# read the error descriptor until EOF
for l in self.pipee:
self.ui.status(_("remote: "), l)
except (IOError, ValueError):
pass
self.pipee.close()
__del__ = cleanup
Augie Fackler
wireproto: make iterbatcher behave streamily over http(s)...
r28438 def _submitbatch(self, req):
Gregory Szorc
wireproto: consolidate code for obtaining "cmds" argument value...
r29733 rsp = self._callstream("batch", cmds=wireproto.encodebatchcmds(req))
Augie Fackler
wireproto: make iterbatcher behave streamily over http(s)...
r28438 available = self._getamount()
# TODO this response parsing is probably suboptimal for large
# batches with large responses.
toread = min(available, 1024)
work = rsp.read(toread)
available -= toread
chunk = work
while chunk:
while ';' in work:
one, work = work.split(';', 1)
yield wireproto.unescapearg(one)
toread = min(available, 1024)
chunk = rsp.read(toread)
available -= toread
work += chunk
yield wireproto.unescapearg(work)
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 def _callstream(self, cmd, **args):
self.ui.debug("sending %s command\n" % cmd)
self.pipeo.write("%s\n" % cmd)
_func, names = wireproto.commands[cmd]
keys = names.split()
wireargs = {}
for k in keys:
if k == '*':
wireargs['*'] = args
break
else:
wireargs[k] = args[k]
del args[k]
for k, v in sorted(wireargs.iteritems()):
self.pipeo.write("%s %d\n" % (k, len(v)))
if isinstance(v, dict):
for dk, dv in v.iteritems():
self.pipeo.write("%s %d\n" % (dk, len(dv)))
self.pipeo.write(dv)
else:
self.pipeo.write(v)
self.pipeo.flush()
return self.pipei
Pierre-Yves David
wireproto: drop the _decompress method in favor a new call type...
r20905 def _callcompressable(self, cmd, **args):
return self._callstream(cmd, **args)
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 def _call(self, cmd, **args):
self._callstream(cmd, **args)
return self._recv()
def _callpush(self, cmd, fp, **args):
r = self._call(cmd, **args)
if r:
return '', r
Augie Fackler
sshpeer: use `iter(callable, sentinel)` instead of while True...
r29727 for d in iter(lambda: fp.read(4096), ''):
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 self._send(d)
self._send("", flush=True)
r = self._recv()
if r:
return '', r
return self._recv(), ''
Pierre-Yves David
sshpeer: add implementation of _calltwowaystream...
r21073 def _calltwowaystream(self, cmd, fp, **args):
r = self._call(cmd, **args)
if r:
# XXX needs to be made better
liscju
i18n: translate abort messages...
r29389 raise error.Abort(_('unexpected remote reply: %s') % r)
Augie Fackler
sshpeer: use `iter(callable, sentinel)` instead of while True...
r29727 for d in iter(lambda: fp.read(4096), ''):
Pierre-Yves David
sshpeer: add implementation of _calltwowaystream...
r21073 self._send(d)
self._send("", flush=True)
return self.pipei
Peter Arrenbrecht
peer: introduce real peer classes...
r17192
Augie Fackler
wireproto: make iterbatcher behave streamily over http(s)...
r28438 def _getamount(self):
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 l = self.pipei.readline()
if l == '\n':
Pierre-Yves David
sshpeer: break "OutOfBandError" feature for ssh (BC)...
r25243 self.readerr()
msg = _('check previous remote output')
self._abort(error.OutOfBandError(hint=msg))
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 self.readerr()
try:
Augie Fackler
wireproto: make iterbatcher behave streamily over http(s)...
r28438 return int(l)
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 except ValueError:
self._abort(error.ResponseError(_("unexpected response:"), l))
Augie Fackler
wireproto: make iterbatcher behave streamily over http(s)...
r28438
def _recv(self):
return self.pipei.read(self._getamount())
Peter Arrenbrecht
peer: introduce real peer classes...
r17192
def _send(self, data, flush=False):
self.pipeo.write("%d\n" % len(data))
if data:
self.pipeo.write(data)
if flush:
self.pipeo.flush()
self.readerr()
def lock(self):
self._call("lock")
return remotelock(self)
def unlock(self):
self._call("unlock")
def addchangegroup(self, cg, source, url, lock=None):
'''Send a changegroup to the remote server. Return an integer
similar to unbundle(). DEPRECATED, since it requires locking the
remote.'''
d = self._call("addchangegroup")
if d:
self._abort(error.RepoError(_("push refused: %s") % d))
Augie Fackler
sshpeer: use `iter(callable, sentinel)` instead of while True...
r29727 for d in iter(lambda: cg.read(4096), ''):
Peter Arrenbrecht
peer: introduce real peer classes...
r17192 self.pipeo.write(d)
self.readerr()
self.pipeo.flush()
self.readerr()
r = self._recv()
if not r:
return 1
try:
return int(r)
except ValueError:
self._abort(error.ResponseError(_("unexpected response:"), r))
instance = sshpeer