2 import errno, os, re, struct, sys, time, zlib
4 from bup import git, ssh
5 from bup.helpers import (Conn, atomically_replaced_file, chunkyreader, debug1,
6 debug2, linereader, mkdirp, progress, qprogress)
12 class ClientError(Exception):
16 def _raw_write_bwlimit(f, buf, bwcount, bwtime):
19 return (len(buf), time.time())
21 # We want to write in reasonably large blocks, but not so large that
22 # they're likely to overflow a router's queue. So our bwlimit timing
23 # has to be pretty granular. Also, if it takes too long from one
24 # transmit to the next, we can't just make up for lost time to bring
25 # the average back up to bwlimit - that will risk overflowing the
26 # outbound queue, which defeats the purpose. So if we fall behind
27 # by more than one block delay, we shouldn't ever try to catch up.
28 for i in xrange(0,len(buf),4096):
30 next = max(now, bwtime + 1.0*bwcount/bwlimit)
34 bwcount = len(sub) # might be less than 4096
36 return (bwcount, bwtime)
39 def parse_remote(remote):
40 protocol = r'([a-z]+)://'
41 host = r'(?P<sb>\[)?((?(sb)[0-9a-f:]+|[^:/]+))(?(sb)\])'
45 '%s(?:%s%s)?%s' % (protocol, host, port, path), remote, re.I)
47 if not url_match.group(1) in ('ssh', 'bup', 'file'):
48 raise ClientError, 'unexpected protocol: %s' % url_match.group(1)
49 return url_match.group(1,3,4,5)
51 rs = remote.split(':', 1)
52 if len(rs) == 1 or rs[0] in ('', '-'):
53 return 'file', None, None, rs[-1]
55 return 'ssh', rs[0], None, rs[1]
59 def __init__(self, remote, create=False):
60 self._busy = self.conn = None
61 self.sock = self.p = self.pout = self.pin = None
62 is_reverse = os.environ.get('BUP_SERVER_REVERSE')
65 remote = '%s:' % is_reverse
66 (self.protocol, self.host, self.port, self.dir) = parse_remote(remote)
67 self.cachedir = git.repo('index-cache/%s'
68 % re.sub(r'[^@\w]', '_',
69 "%s:%s" % (self.host, self.dir)))
71 self.pout = os.fdopen(3, 'rb')
72 self.pin = os.fdopen(4, 'wb')
73 self.conn = Conn(self.pout, self.pin)
75 if self.protocol in ('ssh', 'file'):
77 # FIXME: ssh and file shouldn't use the same module
78 self.p = ssh.connect(self.host, self.port, 'server')
79 self.pout = self.p.stdout
80 self.pin = self.p.stdin
81 self.conn = Conn(self.pout, self.pin)
83 raise ClientError, 'connect: %s' % e, sys.exc_info()[2]
84 elif self.protocol == 'bup':
85 self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
86 self.sock.connect((self.host, atoi(self.port) or 1982))
87 self.sockw = self.sock.makefile('wb')
88 self.conn = DemuxConn(self.sock.fileno(), self.sockw)
90 self.dir = re.sub(r'[\r\n]', ' ', self.dir)
92 self.conn.write('init-dir %s\n' % self.dir)
94 self.conn.write('set-dir %s\n' % self.dir)
102 if e.errno == errno.EPIPE:
108 if self.conn and not self._busy:
109 self.conn.write('quit\n')
112 if self.sock and self.sockw:
114 self.sock.shutdown(socket.SHUT_WR)
125 raise ClientError('server tunnel returned exit code %d' % rv)
127 self.sock = self.p = self.pin = self.pout = None
133 raise ClientError('server exited unexpectedly with code %r'
136 return self.conn.check_ok()
137 except Exception as e:
138 raise ClientError, e, sys.exc_info()[2]
140 def check_busy(self):
142 raise ClientError('already busy with command %r' % self._busy)
144 def ensure_busy(self):
146 raise ClientError('expected to be busy, but not busy?!')
151 def sync_indexes(self):
154 mkdirp(self.cachedir)
155 # All cached idxs are extra until proven otherwise
157 for f in os.listdir(self.cachedir):
159 if f.endswith('.idx'):
162 conn.write('list-indexes\n')
163 for line in linereader(conn):
166 assert(line.find('/') < 0)
167 parts = line.split(' ')
169 if len(parts) == 2 and parts[1] == 'load' and idx not in extra:
170 # If the server requests that we load an idx and we don't
171 # already have a copy of it, it is needed
173 # Any idx that the server has heard of is proven not extra
177 debug1('client: removing extra indexes: %s\n' % extra)
179 os.unlink(os.path.join(self.cachedir, idx))
180 debug1('client: server requested load of: %s\n' % needed)
183 git.auto_midx(self.cachedir)
185 def sync_index(self, name):
186 #debug1('requesting %r\n' % name)
188 mkdirp(self.cachedir)
189 fn = os.path.join(self.cachedir, name)
190 if os.path.exists(fn):
191 msg = "won't request existing .idx, try `bup bloom --check %s`" % fn
192 raise ClientError(msg)
193 self.conn.write('send-index %s\n' % name)
194 n = struct.unpack('!I', self.conn.read(4))[0]
196 with atomically_replaced_file(fn, 'w') as f:
198 progress('Receiving index from server: %d/%d\r' % (count, n))
199 for b in chunkyreader(self.conn, n):
202 qprogress('Receiving index from server: %d/%d\r' % (count, n))
203 progress('Receiving index from server: %d/%d, done.\n' % (count, n))
206 def _make_objcache(self):
207 return git.PackIdxList(self.cachedir)
209 def _suggest_packs(self):
212 assert(ob == 'receive-objects-v2')
213 self.conn.write('\xff\xff\xff\xff') # suspend receive-objects-v2
215 for line in linereader(self.conn):
218 debug2('%s\n' % line)
219 if line.startswith('index '):
221 debug1('client: received index suggestion: %s\n'
222 % git.shorten_hash(idx))
223 suggested.append(idx)
225 assert(line.endswith('.idx'))
226 debug1('client: completed writing pack, idx: %s\n'
227 % git.shorten_hash(line))
228 suggested.append(line)
233 for idx in suggested:
235 git.auto_midx(self.cachedir)
238 self.conn.write('%s\n' % ob)
241 def new_packwriter(self, compression_level=1,
242 max_pack_size=None, max_pack_objects=None):
245 self._busy = 'receive-objects-v2'
246 self.conn.write('receive-objects-v2\n')
247 return PackWriter_Remote(self.conn,
248 objcache_maker = self._make_objcache,
249 suggest_packs = self._suggest_packs,
251 onclose = self._not_busy,
252 ensure_busy = self.ensure_busy,
253 compression_level=compression_level,
254 max_pack_size=max_pack_size,
255 max_pack_objects=max_pack_objects)
257 def read_ref(self, refname):
259 self.conn.write('read-ref %s\n' % refname)
260 r = self.conn.readline().strip()
263 assert(len(r) == 40) # hexified sha
264 return r.decode('hex')
266 return None # nonexistent ref
268 def update_ref(self, refname, newval, oldval):
270 self.conn.write('update-ref %s\n%s\n%s\n'
271 % (refname, newval.encode('hex'),
272 (oldval or '').encode('hex')))
278 self.conn.write('cat %s\n' % re.sub(r'[\n\r]', '_', id))
280 sz = struct.unpack('!I', self.conn.read(4))[0]
282 yield self.conn.read(sz)
286 raise KeyError(str(e))
289 class PackWriter_Remote(git.PackWriter):
290 def __init__(self, conn, objcache_maker, suggest_packs,
295 max_pack_objects=None):
296 git.PackWriter.__init__(self,
297 objcache_maker=objcache_maker,
298 compression_level=compression_level,
299 max_pack_size=max_pack_size,
300 max_pack_objects=max_pack_objects)
302 self.filename = 'remote socket'
303 self.suggest_packs = suggest_packs
305 self.onclose = onclose
306 self.ensure_busy = ensure_busy
307 self._packopen = False
309 self._bwtime = time.time()
312 if not self._packopen:
314 self._packopen = True
316 def _end(self, run_midx=True):
317 assert(run_midx) # We don't support this via remote yet
318 if self._packopen and self.file:
319 self.file.write('\0\0\0\0')
320 self._packopen = False
321 self.onclose() # Unbusy
323 return self.suggest_packs() # Returns last idx received
331 raise ClientError("don't know how to abort remote pack writing")
333 def _raw_write(self, datalist, sha):
335 if not self._packopen:
338 data = ''.join(datalist)
341 crc = zlib.crc32(data) & 0xffffffff
342 outbuf = ''.join((struct.pack('!I', len(data) + 20 + 4),
344 struct.pack('!I', crc),
347 (self._bwcount, self._bwtime) = _raw_write_bwlimit(
348 self.file, outbuf, self._bwcount, self._bwtime)
350 raise ClientError, e, sys.exc_info()[2]
351 self.outbytes += len(data)
354 if self.file.has_input():
356 self.objcache.refresh()