mercurial/sshrepo.py
changeset 17192 1ac628cd7113
parent 17191 5884812686f7
child 17193 1d710fe5ee0e
equal deleted inserted replaced
17191:5884812686f7 17192:1ac628cd7113
     1 # sshrepo.py - ssh repository proxy class for mercurial
       
     2 #
       
     3 # Copyright 2005, 2006 Matt Mackall <mpm@selenic.com>
       
     4 #
       
     5 # This software may be used and distributed according to the terms of the
       
     6 # GNU General Public License version 2 or any later version.
       
     7 
       
     8 import re
       
     9 from i18n import _
       
    10 import util, error, wireproto
       
    11 
       
    12 class remotelock(object):
       
    13     def __init__(self, repo):
       
    14         self.repo = repo
       
    15     def release(self):
       
    16         self.repo.unlock()
       
    17         self.repo = None
       
    18     def __del__(self):
       
    19         if self.repo:
       
    20             self.release()
       
    21 
       
    22 def _serverquote(s):
       
    23     '''quote a string for the remote shell ... which we assume is sh'''
       
    24     if re.match('[a-zA-Z0-9@%_+=:,./-]*$', s):
       
    25         return s
       
    26     return "'%s'" % s.replace("'", "'\\''")
       
    27 
       
    28 class sshrepository(wireproto.wirerepository):
       
    29     def __init__(self, ui, path, create=False):
       
    30         self._url = path
       
    31         self.ui = ui
       
    32         self.pipeo = self.pipei = self.pipee = None
       
    33 
       
    34         u = util.url(path, parsequery=False, parsefragment=False)
       
    35         if u.scheme != 'ssh' or not u.host or u.path is None:
       
    36             self._abort(error.RepoError(_("couldn't parse location %s") % path))
       
    37 
       
    38         self.user = u.user
       
    39         if u.passwd is not None:
       
    40             self._abort(error.RepoError(_("password in URL not supported")))
       
    41         self.host = u.host
       
    42         self.port = u.port
       
    43         self.path = u.path or "."
       
    44 
       
    45         sshcmd = self.ui.config("ui", "ssh", "ssh")
       
    46         remotecmd = self.ui.config("ui", "remotecmd", "hg")
       
    47 
       
    48         args = util.sshargs(sshcmd, self.host, self.user, self.port)
       
    49 
       
    50         if create:
       
    51             cmd = '%s %s %s' % (sshcmd, args,
       
    52                 util.shellquote("%s init %s" %
       
    53                     (_serverquote(remotecmd), _serverquote(self.path))))
       
    54             ui.note(_('running %s\n') % cmd)
       
    55             res = util.system(cmd)
       
    56             if res != 0:
       
    57                 self._abort(error.RepoError(_("could not create remote repo")))
       
    58 
       
    59         self.validate_repo(ui, sshcmd, args, remotecmd)
       
    60 
       
    61     def url(self):
       
    62         return self._url
       
    63 
       
    64     def validate_repo(self, ui, sshcmd, args, remotecmd):
       
    65         # cleanup up previous run
       
    66         self.cleanup()
       
    67 
       
    68         cmd = '%s %s %s' % (sshcmd, args,
       
    69             util.shellquote("%s -R %s serve --stdio" %
       
    70                 (_serverquote(remotecmd), _serverquote(self.path))))
       
    71         ui.note(_('running %s\n') % cmd)
       
    72         cmd = util.quotecommand(cmd)
       
    73         self.pipeo, self.pipei, self.pipee = util.popen3(cmd)
       
    74 
       
    75         # skip any noise generated by remote shell
       
    76         self._callstream("hello")
       
    77         r = self._callstream("between", pairs=("%s-%s" % ("0"*40, "0"*40)))
       
    78         lines = ["", "dummy"]
       
    79         max_noise = 500
       
    80         while lines[-1] and max_noise:
       
    81             l = r.readline()
       
    82             self.readerr()
       
    83             if lines[-1] == "1\n" and l == "\n":
       
    84                 break
       
    85             if l:
       
    86                 ui.debug("remote: ", l)
       
    87             lines.append(l)
       
    88             max_noise -= 1
       
    89         else:
       
    90             self._abort(error.RepoError(_('no suitable response from '
       
    91                                           'remote hg')))
       
    92 
       
    93         self.capabilities = set()
       
    94         for l in reversed(lines):
       
    95             if l.startswith("capabilities:"):
       
    96                 self.capabilities.update(l[:-1].split(":")[1].split())
       
    97                 break
       
    98 
       
    99     def readerr(self):
       
   100         while True:
       
   101             size = util.fstat(self.pipee).st_size
       
   102             if size == 0:
       
   103                 break
       
   104             s = self.pipee.read(size)
       
   105             if not s:
       
   106                 break
       
   107             for l in s.splitlines():
       
   108                 self.ui.status(_("remote: "), l, '\n')
       
   109 
       
   110     def _abort(self, exception):
       
   111         self.cleanup()
       
   112         raise exception
       
   113 
       
   114     def cleanup(self):
       
   115         if self.pipeo is None:
       
   116             return
       
   117         self.pipeo.close()
       
   118         self.pipei.close()
       
   119         try:
       
   120             # read the error descriptor until EOF
       
   121             for l in self.pipee:
       
   122                 self.ui.status(_("remote: "), l)
       
   123         except (IOError, ValueError):
       
   124             pass
       
   125         self.pipee.close()
       
   126 
       
   127     __del__ = cleanup
       
   128 
       
   129     def _callstream(self, cmd, **args):
       
   130         self.ui.debug("sending %s command\n" % cmd)
       
   131         self.pipeo.write("%s\n" % cmd)
       
   132         _func, names = wireproto.commands[cmd]
       
   133         keys = names.split()
       
   134         wireargs = {}
       
   135         for k in keys:
       
   136             if k == '*':
       
   137                 wireargs['*'] = args
       
   138                 break
       
   139             else:
       
   140                 wireargs[k] = args[k]
       
   141                 del args[k]
       
   142         for k, v in sorted(wireargs.iteritems()):
       
   143             self.pipeo.write("%s %d\n" % (k, len(v)))
       
   144             if isinstance(v, dict):
       
   145                 for dk, dv in v.iteritems():
       
   146                     self.pipeo.write("%s %d\n" % (dk, len(dv)))
       
   147                     self.pipeo.write(dv)
       
   148             else:
       
   149                 self.pipeo.write(v)
       
   150         self.pipeo.flush()
       
   151 
       
   152         return self.pipei
       
   153 
       
   154     def _call(self, cmd, **args):
       
   155         self._callstream(cmd, **args)
       
   156         return self._recv()
       
   157 
       
   158     def _callpush(self, cmd, fp, **args):
       
   159         r = self._call(cmd, **args)
       
   160         if r:
       
   161             return '', r
       
   162         while True:
       
   163             d = fp.read(4096)
       
   164             if not d:
       
   165                 break
       
   166             self._send(d)
       
   167         self._send("", flush=True)
       
   168         r = self._recv()
       
   169         if r:
       
   170             return '', r
       
   171         return self._recv(), ''
       
   172 
       
   173     def _decompress(self, stream):
       
   174         return stream
       
   175 
       
   176     def _recv(self):
       
   177         l = self.pipei.readline()
       
   178         if l == '\n':
       
   179             err = []
       
   180             while True:
       
   181                 line = self.pipee.readline()
       
   182                 if line == '-\n':
       
   183                     break
       
   184                 err.extend([line])
       
   185             if len(err) > 0:
       
   186                 # strip the trailing newline added to the last line server-side
       
   187                 err[-1] = err[-1][:-1]
       
   188             self._abort(error.OutOfBandError(*err))
       
   189         self.readerr()
       
   190         try:
       
   191             l = int(l)
       
   192         except ValueError:
       
   193             self._abort(error.ResponseError(_("unexpected response:"), l))
       
   194         return self.pipei.read(l)
       
   195 
       
   196     def _send(self, data, flush=False):
       
   197         self.pipeo.write("%d\n" % len(data))
       
   198         if data:
       
   199             self.pipeo.write(data)
       
   200         if flush:
       
   201             self.pipeo.flush()
       
   202         self.readerr()
       
   203 
       
   204     def lock(self):
       
   205         self._call("lock")
       
   206         return remotelock(self)
       
   207 
       
   208     def unlock(self):
       
   209         self._call("unlock")
       
   210 
       
   211     def addchangegroup(self, cg, source, url, lock=None):
       
   212         '''Send a changegroup to the remote server.  Return an integer
       
   213         similar to unbundle(). DEPRECATED, since it requires locking the
       
   214         remote.'''
       
   215         d = self._call("addchangegroup")
       
   216         if d:
       
   217             self._abort(error.RepoError(_("push refused: %s") % d))
       
   218         while True:
       
   219             d = cg.read(4096)
       
   220             if not d:
       
   221                 break
       
   222             self.pipeo.write(d)
       
   223             self.readerr()
       
   224 
       
   225         self.pipeo.flush()
       
   226 
       
   227         self.readerr()
       
   228         r = self._recv()
       
   229         if not r:
       
   230             return 1
       
   231         try:
       
   232             return int(r)
       
   233         except ValueError:
       
   234             self._abort(error.ResponseError(_("unexpected response:"), r))
       
   235 
       
   236 instance = sshrepository