X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=bup.git;a=blobdiff_plain;f=lib%2Fbup%2Fclient.py;h=927e05321ab1e7e77be6d7040723e09605f8e39e;hp=3a0bb427a1bee94b93f7cc5d7ac347ac7a4a42a2;hb=bf67f94dd4f4096de4eee07a7dc377d6c889a016;hpb=fb3bd84cfd2455cd7a947297c9b9e5d326ab1033 diff --git a/lib/bup/client.py b/lib/bup/client.py index 3a0bb42..927e053 100644 --- a/lib/bup/client.py +++ b/lib/bup/client.py @@ -1,6 +1,19 @@ -import re, struct, errno, time, zlib -from bup import git, ssh -from bup.helpers import * + +from __future__ import print_function + +from __future__ import absolute_import +from binascii import hexlify, unhexlify +import errno, os, re, struct, sys, time, zlib +import socket + +from bup import git, ssh, vfs +from bup.compat import environ, range, reraise +from bup.helpers import (Conn, atomically_replaced_file, chunkyreader, debug1, + debug2, linereader, lines_until_sentinel, + mkdirp, progress, qprogress, DemuxConn, atoi) +from bup.io import path_msg +from bup.vint import read_bvec, read_vuint, write_bvec + bwlimit = None @@ -21,7 +34,7 @@ def _raw_write_bwlimit(f, buf, bwcount, bwtime): # the average back up to bwlimit - that will risk overflowing the # outbound queue, which defeats the purpose. So if we fall behind # by more than one block delay, we shouldn't ever try to catch up. - for i in xrange(0,len(buf),4096): + for i in range(0,len(buf),4096): now = time.time() next = max(now, bwtime + 1.0*bwcount/bwlimit) time.sleep(next-now) @@ -32,68 +45,81 @@ def _raw_write_bwlimit(f, buf, bwcount, bwtime): return (bwcount, bwtime) +_protocol_rs = br'([a-z]+)://' +_host_rs = br'(?P\[)?((?(sb)[0-9a-f:]+|[^:/]+))(?(sb)\])' +_port_rs = br'(?::(\d+))?' +_path_rs = br'(/.*)?' +_url_rx = re.compile(br'%s(?:%s%s)?%s' % (_protocol_rs, _host_rs, _port_rs, _path_rs), + re.I) + def parse_remote(remote): - protocol = r'([a-z]+)://' - host = r'(?P\[)?((?(sb)[0-9a-f:]+|[^:/]+))(?(sb)\])' - port = r'(?::(\d+))?' - path = r'(/.*)?' - url_match = re.match( - '%s(?:%s%s)?%s' % (protocol, host, port, path), remote, re.I) + url_match = _url_rx.match(remote) if url_match: - assert(url_match.group(1) in ('ssh', 'bup', 'file')) + if not url_match.group(1) in (b'ssh', b'bup', b'file'): + raise ClientError('unexpected protocol: %s' + % url_match.group(1).decode('ascii')) return url_match.group(1,3,4,5) else: - rs = remote.split(':', 1) - if len(rs) == 1 or rs[0] in ('', '-'): - return 'file', None, None, rs[-1] + rs = remote.split(b':', 1) + if len(rs) == 1 or rs[0] in (b'', b'-'): + return b'file', None, None, rs[-1] else: - return 'ssh', rs[0], None, rs[1] + return b'ssh', rs[0], None, rs[1] class Client: def __init__(self, remote, create=False): self._busy = self.conn = None self.sock = self.p = self.pout = self.pin = None - is_reverse = os.environ.get('BUP_SERVER_REVERSE') + is_reverse = environ.get(b'BUP_SERVER_REVERSE') if is_reverse: assert(not remote) - remote = '%s:' % is_reverse + remote = b'%s:' % is_reverse (self.protocol, self.host, self.port, self.dir) = parse_remote(remote) - self.cachedir = git.repo('index-cache/%s' - % re.sub(r'[^@\w]', '_', - "%s:%s" % (self.host, self.dir))) + # The b'None' here matches python2's behavior of b'%s' % None == 'None', + # python3 will (as of version 3.7.5) do the same for str ('%s' % None), + # but crashes instead when doing b'%s' % None. + cachehost = b'None' if self.host is None else self.host + cachedir = b'None' if self.dir is None else self.dir + self.cachedir = git.repo(b'index-cache/%s' + % re.sub(br'[^@\w]', + b'_', + b'%s:%s' % (cachehost, cachedir))) if is_reverse: self.pout = os.fdopen(3, 'rb') self.pin = os.fdopen(4, 'wb') self.conn = Conn(self.pout, self.pin) else: - if self.protocol in ('ssh', 'file'): + if self.protocol in (b'ssh', b'file'): try: # FIXME: ssh and file shouldn't use the same module - self.p = ssh.connect(self.host, self.port, 'server') + self.p = ssh.connect(self.host, self.port, b'server') self.pout = self.p.stdout self.pin = self.p.stdin self.conn = Conn(self.pout, self.pin) - except OSError, e: - raise ClientError, 'connect: %s' % e, sys.exc_info()[2] - elif self.protocol == 'bup': + except OSError as e: + reraise(ClientError('connect: %s' % e)) + elif self.protocol == b'bup': self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) - self.sock.connect((self.host, self.port or 1982)) + self.sock.connect((self.host, atoi(self.port) or 1982)) self.sockw = self.sock.makefile('wb') self.conn = DemuxConn(self.sock.fileno(), self.sockw) + self._available_commands = self._get_available_commands() + self._require_command(b'init-dir') + self._require_command(b'set-dir') if self.dir: - self.dir = re.sub(r'[\r\n]', ' ', self.dir) + self.dir = re.sub(br'[\r\n]', ' ', self.dir) if create: - self.conn.write('init-dir %s\n' % self.dir) + self.conn.write(b'init-dir %s\n' % self.dir) else: - self.conn.write('set-dir %s\n' % self.dir) + self.conn.write(b'set-dir %s\n' % self.dir) self.check_ok() self.sync_indexes() def __del__(self): try: self.close() - except IOError, e: + except IOError as e: if e.errno == errno.EPIPE: pass else: @@ -101,7 +127,7 @@ class Client: def close(self): if self.conn and not self._busy: - self.conn.write('quit\n') + self.conn.write(b'quit\n') if self.pin: self.pin.close() if self.sock and self.sockw: @@ -129,8 +155,8 @@ class Client: % rv) try: return self.conn.check_ok() - except Exception, e: - raise ClientError, e, sys.exc_info()[2] + except Exception as e: + reraise(ClientError(e)) def check_busy(self): if self._busy: @@ -143,25 +169,57 @@ class Client: def _not_busy(self): self._busy = None + def _get_available_commands(self): + self.check_busy() + self._busy = b'help' + conn = self.conn + conn.write(b'help\n') + result = set() + line = self.conn.readline() + if not line == b'Commands:\n': + raise ClientError('unexpected help header ' + repr(line)) + while True: + line = self.conn.readline() + if line == b'\n': + break + if not line.startswith(b' '): + raise ClientError('unexpected help line ' + repr(line)) + cmd = line.strip() + if not cmd: + raise ClientError('unexpected help line ' + repr(line)) + result.add(cmd) + # FIXME: confusing + not_ok = self.check_ok() + if not_ok: + raise not_ok + self._not_busy() + return frozenset(result) + + def _require_command(self, name): + if name not in self._available_commands: + raise ClientError('server does not appear to provide %s command' + % name.encode('ascii')) + def sync_indexes(self): + self._require_command(b'list-indexes') self.check_busy() conn = self.conn mkdirp(self.cachedir) # All cached idxs are extra until proven otherwise extra = set() for f in os.listdir(self.cachedir): - debug1('%s\n' % f) - if f.endswith('.idx'): + debug1(path_msg(f) + '\n') + if f.endswith(b'.idx'): extra.add(f) needed = set() - conn.write('list-indexes\n') + conn.write(b'list-indexes\n') for line in linereader(conn): if not line: break - assert(line.find('/') < 0) - parts = line.split(' ') + assert(line.find(b'/') < 0) + parts = line.split(b' ') idx = parts[0] - if len(parts) == 2 and parts[1] == 'load' and idx not in extra: + if len(parts) == 2 and parts[1] == b'load' and idx not in extra: # If the server requests that we load an idx and we don't # already have a copy of it, it is needed needed.add(idx) @@ -177,26 +235,28 @@ class Client: self.sync_index(idx) git.auto_midx(self.cachedir) - def sync_index(self, name): + self._require_command(b'send-index') #debug1('requesting %r\n' % name) self.check_busy() mkdirp(self.cachedir) - self.conn.write('send-index %s\n' % name) + fn = os.path.join(self.cachedir, name) + if os.path.exists(fn): + msg = ("won't request existing .idx, try `bup bloom --check %s`" + % path_msg(fn)) + raise ClientError(msg) + self.conn.write(b'send-index %s\n' % name) n = struct.unpack('!I', self.conn.read(4))[0] assert(n) - fn = os.path.join(self.cachedir, name) - f = open(fn + '.tmp', 'w') - count = 0 - progress('Receiving index from server: %d/%d\r' % (count, n)) - for b in chunkyreader(self.conn, n): - f.write(b) - count += len(b) + with atomically_replaced_file(fn, 'wb') as f: + count = 0 progress('Receiving index from server: %d/%d\r' % (count, n)) - progress('Receiving index from server: %d/%d, done.\n' % (count, n)) - self.check_ok() - f.close() - os.rename(fn + '.tmp', fn) + for b in chunkyreader(self.conn, n): + f.write(b) + count += len(b) + qprogress('Receiving index from server: %d/%d\r' % (count, n)) + progress('Receiving index from server: %d/%d, done.\n' % (count, n)) + self.check_ok() def _make_objcache(self): return git.PackIdxList(self.cachedir) @@ -204,83 +264,238 @@ class Client: def _suggest_packs(self): ob = self._busy if ob: - assert(ob == 'receive-objects-v2') - self.conn.write('\xff\xff\xff\xff') # suspend receive-objects-v2 + assert(ob == b'receive-objects-v2') + self.conn.write(b'\xff\xff\xff\xff') # suspend receive-objects-v2 suggested = [] for line in linereader(self.conn): if not line: break - debug2('%s\n' % line) - if line.startswith('index '): + debug2('%r\n' % line) + if line.startswith(b'index '): idx = line[6:] - debug1('client: received index suggestion: %s\n' % idx) + debug1('client: received index suggestion: %s\n' + % git.shorten_hash(idx).decode('ascii')) suggested.append(idx) else: - assert(line.endswith('.idx')) - debug1('client: completed writing pack, idx: %s\n' % line) + assert(line.endswith(b'.idx')) + debug1('client: completed writing pack, idx: %s\n' + % git.shorten_hash(line).decode('ascii')) suggested.append(line) self.check_ok() if ob: self._busy = None + idx = None for idx in suggested: self.sync_index(idx) git.auto_midx(self.cachedir) if ob: self._busy = ob - self.conn.write('%s\n' % ob) + self.conn.write(b'%s\n' % ob) return idx - def new_packwriter(self): + def new_packwriter(self, compression_level=1, + max_pack_size=None, max_pack_objects=None): + self._require_command(b'receive-objects-v2') self.check_busy() def _set_busy(): - self._busy = 'receive-objects-v2' - self.conn.write('receive-objects-v2\n') + self._busy = b'receive-objects-v2' + self.conn.write(b'receive-objects-v2\n') return PackWriter_Remote(self.conn, objcache_maker = self._make_objcache, suggest_packs = self._suggest_packs, onopen = _set_busy, onclose = self._not_busy, - ensure_busy = self.ensure_busy) + ensure_busy = self.ensure_busy, + compression_level=compression_level, + max_pack_size=max_pack_size, + max_pack_objects=max_pack_objects) def read_ref(self, refname): + self._require_command(b'read-ref') self.check_busy() - self.conn.write('read-ref %s\n' % refname) + self.conn.write(b'read-ref %s\n' % refname) r = self.conn.readline().strip() self.check_ok() if r: assert(len(r) == 40) # hexified sha - return r.decode('hex') + return unhexlify(r) else: return None # nonexistent ref def update_ref(self, refname, newval, oldval): + self._require_command(b'update-ref') self.check_busy() - self.conn.write('update-ref %s\n%s\n%s\n' - % (refname, newval.encode('hex'), - (oldval or '').encode('hex'))) + self.conn.write(b'update-ref %s\n%s\n%s\n' + % (refname, hexlify(newval), + hexlify(oldval) if oldval else b'')) self.check_ok() - def cat(self, id): + def join(self, id): + self._require_command(b'join') self.check_busy() - self._busy = 'cat' - self.conn.write('cat %s\n' % re.sub(r'[\n\r]', '_', id)) + self._busy = b'join' + # Send 'cat' so we'll work fine with older versions + self.conn.write(b'cat %s\n' % re.sub(br'[\n\r]', b'_', id)) while 1: sz = struct.unpack('!I', self.conn.read(4))[0] if not sz: break yield self.conn.read(sz) + # FIXME: ok to assume the only NotOk is a KerError? (it is true atm) e = self.check_ok() self._not_busy() if e: raise KeyError(str(e)) + def cat_batch(self, refs): + self._require_command(b'cat-batch') + self.check_busy() + self._busy = b'cat-batch' + conn = self.conn + conn.write(b'cat-batch\n') + # FIXME: do we want (only) binary protocol? + for ref in refs: + assert ref + assert b'\n' not in ref + conn.write(ref) + conn.write(b'\n') + conn.write(b'\n') + for ref in refs: + info = conn.readline() + if info == b'missing\n': + yield None, None, None, None + continue + if not (info and info.endswith(b'\n')): + raise ClientError('Hit EOF while looking for object info: %r' + % info) + oidx, oid_t, size = info.split(b' ') + size = int(size) + cr = chunkyreader(conn, size) + yield oidx, oid_t, size, cr + detritus = next(cr, None) + if detritus: + raise ClientError('unexpected leftover data ' + repr(detritus)) + # FIXME: confusing + not_ok = self.check_ok() + if not_ok: + raise not_ok + self._not_busy() + + def refs(self, patterns=None, limit_to_heads=False, limit_to_tags=False): + patterns = patterns or tuple() + self._require_command(b'refs') + self.check_busy() + self._busy = b'refs' + conn = self.conn + conn.write(b'refs %d %d\n' % (1 if limit_to_heads else 0, + 1 if limit_to_tags else 0)) + for pattern in patterns: + assert b'\n' not in pattern + conn.write(pattern) + conn.write(b'\n') + conn.write(b'\n') + for line in lines_until_sentinel(conn, b'\n', ClientError): + line = line[:-1] + oidx, name = line.split(b' ') + if len(oidx) != 40: + raise ClientError('Invalid object fingerprint in %r' % line) + if not name: + raise ClientError('Invalid reference name in %r' % line) + yield name, unhexlify(oidx) + # FIXME: confusing + not_ok = self.check_ok() + if not_ok: + raise not_ok + self._not_busy() + + def rev_list(self, refs, count=None, parse=None, format=None): + """See git.rev_list for the general semantics, but note that with the + current interface, the parse function must be able to handle + (consume) any blank lines produced by the format because the + first one received that it doesn't consume will be interpreted + as a terminator for the entire rev-list result. + + """ + self._require_command(b'rev-list') + assert (count is None) or (isinstance(count, Integral)) + if format: + assert b'\n' not in format + assert parse + for ref in refs: + assert ref + assert b'\n' not in ref + self.check_busy() + self._busy = b'rev-list' + conn = self.conn + conn.write(b'rev-list\n') + if count is not None: + conn.write(b'%d' % count) + conn.write(b'\n') + if format: + conn.write(format) + conn.write(b'\n') + for ref in refs: + conn.write(ref) + conn.write(b'\n') + conn.write(b'\n') + if not format: + for line in lines_until_sentinel(conn, b'\n', ClientError): + line = line.strip() + assert len(line) == 40 + yield line + else: + for line in lines_until_sentinel(conn, b'\n', ClientError): + if not line.startswith(b'commit '): + raise ClientError('unexpected line ' + repr(line)) + cmt_oidx = line[7:].strip() + assert len(cmt_oidx) == 40 + yield cmt_oidx, parse(conn) + # FIXME: confusing + not_ok = self.check_ok() + if not_ok: + raise not_ok + self._not_busy() + + def resolve(self, path, parent=None, want_meta=True, follow=False): + self._require_command(b'resolve') + self.check_busy() + self._busy = b'resolve' + conn = self.conn + conn.write(b'resolve %d\n' % ((1 if want_meta else 0) + | (2 if follow else 0) + | (4 if parent else 0))) + if parent: + vfs.write_resolution(conn, parent) + write_bvec(conn, path) + success = ord(conn.read(1)) + assert success in (0, 1) + if success: + result = vfs.read_resolution(conn) + else: + result = vfs.read_ioerror(conn) + # FIXME: confusing + not_ok = self.check_ok() + if not_ok: + raise not_ok + self._not_busy() + if isinstance(result, vfs.IOError): + raise result + return result + class PackWriter_Remote(git.PackWriter): def __init__(self, conn, objcache_maker, suggest_packs, onopen, onclose, - ensure_busy): - git.PackWriter.__init__(self, objcache_maker) + ensure_busy, + compression_level=1, + max_pack_size=None, + max_pack_objects=None): + git.PackWriter.__init__(self, + objcache_maker=objcache_maker, + compression_level=compression_level, + max_pack_size=max_pack_size, + max_pack_objects=max_pack_objects) self.file = conn - self.filename = 'remote socket' + self.filename = b'remote socket' self.suggest_packs = suggest_packs self.onopen = onopen self.onclose = onclose @@ -294,9 +509,10 @@ class PackWriter_Remote(git.PackWriter): self.onopen() self._packopen = True - def _end(self): + def _end(self, run_midx=True): + assert(run_midx) # We don't support this via remote yet if self._packopen and self.file: - self.file.write('\0\0\0\0') + self.file.write(b'\0\0\0\0') self._packopen = False self.onclose() # Unbusy self.objcache = None @@ -308,26 +524,26 @@ class PackWriter_Remote(git.PackWriter): return id def abort(self): - raise GitError("don't know how to abort remote pack writing") + raise ClientError("don't know how to abort remote pack writing") def _raw_write(self, datalist, sha): assert(self.file) if not self._packopen: self._open() self.ensure_busy() - data = ''.join(datalist) + data = b''.join(datalist) assert(data) assert(sha) crc = zlib.crc32(data) & 0xffffffff - outbuf = ''.join((struct.pack('!I', len(data) + 20 + 4), - sha, - struct.pack('!I', crc), - data)) + outbuf = b''.join((struct.pack('!I', len(data) + 20 + 4), + sha, + struct.pack('!I', crc), + data)) try: (self._bwcount, self._bwtime) = _raw_write_bwlimit( self.file, outbuf, self._bwcount, self._bwtime) - except IOError, e: - raise ClientError, e, sys.exc_info()[2] + except IOError as e: + reraise(ClientError(e)) self.outbytes += len(data) self.count += 1