git.py

   1 import os, errno, zlib, time, sha, subprocess, struct, stat, re, tempfile
   2 import heapq
   3 from helpers import *
   4
   5 verbose = 0
   6 ignore_midx = 0
   7 home_repodir = os.path.expanduser('~/.bup')
   8 repodir = None
   9
  10 _typemap =  { 'blob':3, 'tree':2, 'commit':1, 'tag':4 }
  11 _typermap = { 3:'blob', 2:'tree', 1:'commit', 4:'tag' }
  12
  13
  14 class GitError(Exception):
  15     pass
  16
  17
  18 def repo(sub = ''):
  19     global repodir
  20     if not repodir:
  21         raise GitError('You should call check_repo_or_die()')
  22     gd = os.path.join(repodir, '.git')
  23     if os.path.exists(gd):
  24         repodir = gd
  25     return os.path.join(repodir, sub)
  26
  27
  28 def _encode_packobj(type, content):
  29     szout = ''
  30     sz = len(content)
  31     szbits = (sz & 0x0f) | (_typemap[type]<<4)
  32     sz >>= 4
  33     while 1:
  34         if sz: szbits |= 0x80
  35         szout += chr(szbits)
  36         if not sz:
  37             break
  38         szbits = sz & 0x7f
  39         sz >>= 7
  40     z = zlib.compressobj(1)
  41     yield szout
  42     yield z.compress(content)
  43     yield z.flush()
  44
  45
  46 def _encode_looseobj(type, content):
  47     z = zlib.compressobj(1)
  48     yield z.compress('%s %d\0' % (type, len(content)))
  49     yield z.compress(content)
  50     yield z.flush()
  51
  52
  53 def _decode_looseobj(buf):
  54     assert(buf);
  55     s = zlib.decompress(buf)
  56     i = s.find('\0')
  57     assert(i > 0)
  58     l = s[:i].split(' ')
  59     type = l[0]
  60     sz = int(l[1])
  61     content = s[i+1:]
  62     assert(type in _typemap)
  63     assert(sz == len(content))
  64     return (type, content)
  65
  66
  67 def _decode_packobj(buf):
  68     assert(buf)
  69     c = ord(buf[0])
  70     type = _typermap[(c & 0x70) >> 4]
  71     sz = c & 0x0f
  72     shift = 4
  73     i = 0
  74     while c & 0x80:
  75         i += 1
  76         c = ord(buf[i])
  77         sz |= (c & 0x7f) << shift
  78         shift += 7
  79         if not (c & 0x80):
  80             break
  81     return (type, zlib.decompress(buf[i+1:]))
  82
  83
  84 class PackIndex:
  85     def __init__(self, filename):
  86         self.name = filename
  87         self.map = mmap_read(open(filename))
  88         assert(str(self.map[0:8]) == '\377tOc\0\0\0\2')
  89         self.fanout = list(struct.unpack('!256I',
  90                                          str(buffer(self.map, 8, 256*4))))
  91         self.fanout.append(0)  # entry "-1"
  92         nsha = self.fanout[255]
  93         self.ofstable = buffer(self.map,
  94                                8 + 256*4 + nsha*20 + nsha*4,
  95                                nsha*4)
  96         self.ofs64table = buffer(self.map,
  97                                  8 + 256*4 + nsha*20 + nsha*4 + nsha*4)
  98
  99     def _ofs_from_idx(self, idx):
 100         ofs = struct.unpack('!I', str(buffer(self.ofstable, idx*4, 4)))[0]
 101         if ofs & 0x80000000:
 102             idx64 = ofs & 0x7fffffff
 103             ofs = struct.unpack('!I',
 104                                 str(buffer(self.ofs64table, idx64*8, 8)))[0]
 105         return ofs
 106
 107     def _idx_from_hash(self, hash):
 108         assert(len(hash) == 20)
 109         b1 = ord(hash[0])
 110         start = self.fanout[b1-1] # range -1..254
 111         end = self.fanout[b1] # range 0..255
 112         buf = buffer(self.map, 8 + 256*4, end*20)
 113         want = str(hash)
 114         while start < end:
 115             mid = start + (end-start)/2
 116             v = str(buf[mid*20:(mid+1)*20])
 117             if v < want:
 118                 start = mid+1
 119             elif v > want:
 120                 end = mid
 121             else: # got it!
 122                 return mid
 123         return None
 124
 125     def find_offset(self, hash):
 126         idx = self._idx_from_hash(hash)
 127         if idx != None:
 128             return self._ofs_from_idx(idx)
 129         return None
 130
 131     def exists(self, hash):
 132         return hash and (self._idx_from_hash(hash) != None) and True or None
 133
 134     def __iter__(self):
 135         for i in xrange(self.fanout[255]):
 136             yield buffer(self.map, 8 + 256*4 + 20*i, 20)
 137
 138     def __len__(self):
 139         return int(self.fanout[255])
 140
 141
 142 def extract_bits(buf, bits):
 143     mask = (1<<bits) - 1
 144     v = struct.unpack('!I', buf[0:4])[0]
 145     v = (v >> (32-bits)) & mask
 146     return v
 147
 148
 149 class PackMidx:
 150     def __init__(self, filename):
 151         self.name = filename
 152         assert(filename.endswith('.midx'))
 153         self.map = mmap_read(open(filename))
 154         if str(self.map[0:8]) == 'MIDX\0\0\0\1':
 155             log('Warning: ignoring old-style midx %r\n' % filename)
 156             self.bits = 0
 157             self.entries = 1
 158             self.fanout = buffer('\0\0\0\0')
 159             self.shalist = buffer('\0'*20)
 160             self.idxnames = []
 161         else:
 162             assert(str(self.map[0:8]) == 'MIDX\0\0\0\2')
 163             self.bits = struct.unpack('!I', self.map[8:12])[0]
 164             self.entries = 2**self.bits
 165             self.fanout = buffer(self.map, 12, self.entries*4)
 166             shaofs = 12 + self.entries*4
 167             nsha = self._fanget(self.entries-1)
 168             self.shalist = buffer(self.map, shaofs, nsha*20)
 169             self.idxnames = str(self.map[shaofs + 20*nsha:]).split('\0')
 170
 171     def _fanget(self, i):
 172         start = i*4
 173         s = self.fanout[start:start+4]
 174         return struct.unpack('!I', s)[0]
 175
 176     def exists(self, hash):
 177         want = str(hash)
 178         el = extract_bits(want, self.bits)
 179         if el:
 180             start = self._fanget(el-1)
 181         else:
 182             start = 0
 183         end = self._fanget(el)
 184         while start < end:
 185             mid = start + (end-start)/2
 186             v = str(self.shalist[mid*20:(mid+1)*20])
 187             if v < want:
 188                 start = mid+1
 189             elif v > want:
 190                 end = mid
 191             else: # got it!
 192                 return True
 193         return None
 194
 195     def __iter__(self):
 196         for i in xrange(self._fanget(self.entries-1)):
 197             yield buffer(self.shalist, i*20, 20)
 198
 199     def __len__(self):
 200         return self._fanget(self.entries-1)
 201
 202
 203 _mpi_count = 0
 204 class MultiPackIndex:
 205     def __init__(self, dir):
 206         global _mpi_count
 207         assert(_mpi_count == 0)
 208         _mpi_count += 1
 209         self.dir = dir
 210         self.also = {}
 211         self.packs = []
 212         self.refresh()
 213
 214     def __del__(self):
 215         global _mpi_count
 216         _mpi_count -= 1
 217         assert(_mpi_count == 0)
 218
 219     def __iter__(self):
 220         return iter(idxmerge(self.packs))
 221
 222     def exists(self, hash):
 223         if hash in self.also:
 224             return True
 225         for i in range(len(self.packs)):
 226             p = self.packs[i]
 227             if p.exists(hash):
 228                 # reorder so most recently used packs are searched first
 229                 self.packs = [p] + self.packs[:i] + self.packs[i+1:]
 230                 return p.name
 231         return None
 232
 233     def refresh(self):
 234         global ignore_midx
 235         d = dict([(p.name, 1) for p in self.packs])
 236         if os.path.exists(self.dir):
 237             if not ignore_midx:
 238                 midxl = []
 239                 for f in os.listdir(self.dir):
 240                     full = os.path.join(self.dir, f)
 241                     if f.endswith('.midx') and not d.get(full):
 242                         midxl.append(PackMidx(full))
 243                 midxl.sort(lambda x,y: -cmp(len(x),len(y)))
 244                 for ix in midxl:
 245                     any = 0
 246                     for sub in ix.idxnames:
 247                         if not d.get(os.path.join(self.dir, sub)):
 248                             self.packs.append(ix)
 249                             d[ix.name] = 1
 250                             for name in ix.idxnames:
 251                                 d[os.path.join(self.dir, name)] = 1
 252                             break
 253             for f in os.listdir(self.dir):
 254                 full = os.path.join(self.dir, f)
 255                 if f.endswith('.idx') and not d.get(full):
 256                     self.packs.append(PackIndex(full))
 257                     d[full] = 1
 258         #log('MultiPackIndex: using %d packs.\n' % len(self.packs))
 259
 260     def add(self, hash):
 261         self.also[hash] = 1
 262
 263     def zap_also(self):
 264         self.also = {}
 265
 266
 267 def calc_hash(type, content):
 268     header = '%s %d\0' % (type, len(content))
 269     sum = sha.sha(header)
 270     sum.update(content)
 271     return sum.digest()
 272
 273
 274 def _shalist_sort_key(ent):
 275     (mode, name, id) = ent
 276     if stat.S_ISDIR(int(mode, 8)):
 277         return name + '/'
 278     else:
 279         return name
 280
 281
 282 def idxmerge(idxlist):
 283     total = sum([len(i) for i in idxlist])
 284     iters = [iter(i) for i in idxlist]
 285     heap = [(next(it), it) for it in iters]
 286     heapq.heapify(heap)
 287     count = 0
 288     while heap:
 289         if (count % 10024) == 0:
 290             progress('Creating midx: %.2f%% (%d/%d)\r'
 291                      % (count*100.0/total, count, total))
 292         (e, it) = heap[0]
 293         yield e
 294         count += 1
 295         e = next(it)
 296         if e:
 297             heapq.heapreplace(heap, (e, it))
 298         else:
 299             heapq.heappop(heap)
 300     log('Creating midx: %.2f%% (%d/%d), done.\n' % (100, total, total))
 301
 302
 303 class PackWriter:
 304     def __init__(self, objcache_maker=None):
 305         self.count = 0
 306         self.outbytes = 0
 307         self.filename = None
 308         self.file = None
 309         self.objcache_maker = objcache_maker
 310         self.objcache = None
 311
 312     def __del__(self):
 313         self.close()
 314
 315     def _make_objcache(self):
 316         if not self.objcache:
 317             if self.objcache_maker:
 318                 self.objcache = self.objcache_maker()
 319             else:
 320                 self.objcache = MultiPackIndex(repo('objects/pack'))
 321
 322     def _open(self):
 323         if not self.file:
 324             self._make_objcache()
 325             (fd,name) = tempfile.mkstemp(suffix='.pack', dir=repo('objects'))
 326             self.file = os.fdopen(fd, 'w+b')
 327             assert(name.endswith('.pack'))
 328             self.filename = name[:-5]
 329             self.file.write('PACK\0\0\0\2\0\0\0\0')
 330
 331     def _raw_write(self, datalist):
 332         self._open()
 333         f = self.file
 334         for d in datalist:
 335             f.write(d)
 336             self.outbytes += len(d)
 337         self.count += 1
 338
 339     def _write(self, bin, type, content):
 340         if verbose:
 341             log('>')
 342         self._raw_write(_encode_packobj(type, content))
 343         return bin
 344
 345     def breakpoint(self):
 346         id = self._end()
 347         self.outbytes = self.count = 0
 348         return id
 349
 350     def write(self, type, content):
 351         return self._write(calc_hash(type, content), type, content)
 352
 353     def exists(self, id):
 354         if not self.objcache:
 355             self._make_objcache()
 356         return self.objcache.exists(id)
 357
 358     def maybe_write(self, type, content):
 359         bin = calc_hash(type, content)
 360         if not self.exists(bin):
 361             self._write(bin, type, content)
 362             self.objcache.add(bin)
 363         return bin
 364
 365     def new_blob(self, blob):
 366         return self.maybe_write('blob', blob)
 367
 368     def new_tree(self, shalist):
 369         shalist = sorted(shalist, key = _shalist_sort_key)
 370         l = []
 371         for (mode,name,bin) in shalist:
 372             assert(mode)
 373             assert(mode[0] != '0')
 374             assert(name)
 375             assert(len(bin) == 20)
 376             l.append('%s %s\0%s' % (mode,name,bin))
 377         return self.maybe_write('tree', ''.join(l))
 378
 379     def _new_commit(self, tree, parent, author, adate, committer, cdate, msg):
 380         l = []
 381         if tree: l.append('tree %s' % tree.encode('hex'))
 382         if parent: l.append('parent %s' % parent.encode('hex'))
 383         if author: l.append('author %s %s' % (author, _git_date(adate)))
 384         if committer: l.append('committer %s %s' % (committer, _git_date(cdate)))
 385         l.append('')
 386         l.append(msg)
 387         return self.maybe_write('commit', '\n'.join(l))
 388
 389     def new_commit(self, parent, tree, msg):
 390         now = time.time()
 391         userline = '%s <%s@%s>' % (userfullname(), username(), hostname())
 392         commit = self._new_commit(tree, parent,
 393                                   userline, now, userline, now,
 394                                   msg)
 395         return commit
 396
 397     def abort(self):
 398         f = self.file
 399         if f:
 400             self.file = None
 401             f.close()
 402             os.unlink(self.filename + '.pack')
 403
 404     def _end(self):
 405         f = self.file
 406         if not f: return None
 407         self.file = None
 408         self.objcache = None
 409
 410         # update object count
 411         f.seek(8)
 412         cp = struct.pack('!i', self.count)
 413         assert(len(cp) == 4)
 414         f.write(cp)
 415
 416         # calculate the pack sha1sum
 417         f.seek(0)
 418         sum = sha.sha()
 419         while 1:
 420             b = f.read(65536)
 421             sum.update(b)
 422             if not b: break
 423         f.write(sum.digest())
 424
 425         f.close()
 426
 427         p = subprocess.Popen(['git', 'index-pack', '-v',
 428                               '--index-version=2',
 429                               self.filename + '.pack'],
 430                              preexec_fn = _gitenv,
 431                              stdout = subprocess.PIPE)
 432         out = p.stdout.read().strip()
 433         _git_wait('git index-pack', p)
 434         if not out:
 435             raise GitError('git index-pack produced no output')
 436         nameprefix = repo('objects/pack/%s' % out)
 437         if os.path.exists(self.filename + '.map'):
 438             os.unlink(self.filename + '.map')
 439         os.rename(self.filename + '.pack', nameprefix + '.pack')
 440         os.rename(self.filename + '.idx', nameprefix + '.idx')
 441         return nameprefix
 442
 443     def close(self):
 444         return self._end()
 445
 446
 447 def _git_date(date):
 448     return time.strftime('%s %z', time.localtime(date))
 449
 450
 451 def _gitenv():
 452     os.environ['GIT_DIR'] = os.path.abspath(repo())
 453
 454
 455 def list_refs(refname = None):
 456     argv = ['git', 'show-ref', '--']
 457     if refname:
 458         argv += [refname]
 459     p = subprocess.Popen(argv, preexec_fn = _gitenv, stdout = subprocess.PIPE)
 460     out = p.stdout.read().strip()
 461     rv = p.wait()  # not fatal
 462     if rv:
 463         assert(not out)
 464     if out:
 465         for d in out.split('\n'):
 466             (sha, name) = d.split(' ', 1)
 467             yield (name, sha.decode('hex'))
 468
 469
 470 def read_ref(refname):
 471     l = list(list_refs(refname))
 472     if l:
 473         assert(len(l) == 1)
 474         return l[0][1]
 475     else:
 476         return None
 477
 478
 479 def rev_list(ref):
 480     assert(not ref.startswith('-'))
 481     argv = ['git', 'rev-list', '--pretty=format:%ct', ref, '--']
 482     p = subprocess.Popen(argv, preexec_fn = _gitenv, stdout = subprocess.PIPE)
 483     commit = None
 484     for row in p.stdout:
 485         s = row.strip()
 486         if s.startswith('commit '):
 487             commit = s[7:].decode('hex')
 488         else:
 489             date = int(s)
 490             yield (date, commit)
 491     rv = p.wait()  # not fatal
 492     if rv:
 493         raise GitError, 'git rev-list returned error %d' % rv
 494
 495
 496 def update_ref(refname, newval, oldval):
 497     if not oldval:
 498         oldval = ''
 499     assert(refname.startswith('refs/heads/'))
 500     p = subprocess.Popen(['git', 'update-ref', refname,
 501                           newval.encode('hex'), oldval.encode('hex')],
 502                          preexec_fn = _gitenv)
 503     _git_wait('git update-ref', p)
 504
 505
 506 def guess_repo(path=None):
 507     global repodir
 508     if path:
 509         repodir = path
 510     if not repodir:
 511         repodir = os.environ.get('BUP_DIR')
 512         if not repodir:
 513             repodir = os.path.expanduser('~/.bup')
 514
 515
 516 def init_repo(path=None):
 517     guess_repo(path)
 518     d = repo()
 519     if os.path.exists(d) and not os.path.isdir(os.path.join(d, '.')):
 520         raise GitError('"%d" exists but is not a directory\n' % d)
 521     p = subprocess.Popen(['git', '--bare', 'init'], stdout=sys.stderr,
 522                          preexec_fn = _gitenv)
 523     _git_wait('git init', p)
 524     p = subprocess.Popen(['git', 'config', 'pack.indexVersion', '2'],
 525                          stdout=sys.stderr, preexec_fn = _gitenv)
 526     _git_wait('git config', p)
 527
 528
 529 def check_repo_or_die(path=None):
 530     guess_repo(path)
 531     if not os.path.isdir(repo('objects/pack/.')):
 532         if repodir == home_repodir:
 533             init_repo()
 534         else:
 535             log('error: %r is not a bup/git repository\n' % repo())
 536             sys.exit(15)
 537
 538
 539 def _treeparse(buf):
 540     ofs = 0
 541     while ofs < len(buf):
 542         z = buf[ofs:].find('\0')
 543         assert(z > 0)
 544         spl = buf[ofs:ofs+z].split(' ', 1)
 545         assert(len(spl) == 2)
 546         sha = buf[ofs+z+1:ofs+z+1+20]
 547         ofs += z+1+20
 548         yield (spl[0], spl[1], sha)
 549
 550
 551 _ver = None
 552 def ver():
 553     global _ver
 554     if not _ver:
 555         p = subprocess.Popen(['git', '--version'],
 556                              stdout=subprocess.PIPE)
 557         gvs = p.stdout.read()
 558         _git_wait('git --version', p)
 559         m = re.match(r'git version (\S+.\S+)', gvs)
 560         if not m:
 561             raise GitError('git --version weird output: %r' % gvs)
 562         _ver = tuple(m.group(1).split('.'))
 563     needed = ('1','5', '3', '1')
 564     if _ver < needed:
 565         raise GitError('git version %s or higher is required; you have %s'
 566                        % ('.'.join(needed), '.'.join(_ver)))
 567     return _ver
 568
 569
 570 def _git_wait(cmd, p):
 571     rv = p.wait()
 572     if rv != 0:
 573         raise GitError('%s returned %d' % (cmd, rv))
 574
 575
 576 def _git_capture(argv):
 577     p = subprocess.Popen(argv, stdout=subprocess.PIPE, preexec_fn = _gitenv)
 578     r = p.stdout.read()
 579     _git_wait(repr(argv), p)
 580     return r
 581
 582
 583 _ver_warned = 0
 584 class CatPipe:
 585     def __init__(self):
 586         global _ver_warned
 587         wanted = ('1','5','6')
 588         if ver() < wanted:
 589             if not _ver_warned:
 590                 log('warning: git version < %s; bup will be slow.\n'
 591                     % '.'.join(wanted))
 592                 _ver_warned = 1
 593             self.get = self._slow_get
 594         else:
 595             self.p = subprocess.Popen(['git', 'cat-file', '--batch'],
 596                                       stdin=subprocess.PIPE,
 597                                       stdout=subprocess.PIPE,
 598                                       preexec_fn = _gitenv)
 599             self.get = self._fast_get
 600
 601     def _fast_get(self, id):
 602         assert(id.find('\n') < 0)
 603         assert(id.find('\r') < 0)
 604         assert(id[0] != '-')
 605         self.p.stdin.write('%s\n' % id)
 606         hdr = self.p.stdout.readline()
 607         if hdr.endswith(' missing\n'):
 608             raise KeyError('blob %r is missing' % id)
 609         spl = hdr.split(' ')
 610         if len(spl) != 3 or len(spl[0]) != 40:
 611             raise GitError('expected blob, got %r' % spl)
 612         (hex, type, size) = spl
 613         it = iter(chunkyreader(self.p.stdout, int(spl[2])))
 614         try:
 615             yield type
 616             for blob in it:
 617                 yield blob
 618         except StopIteration:
 619             while 1:
 620                 it.next()
 621         assert(self.p.stdout.readline() == '\n')
 622
 623     def _slow_get(self, id):
 624         assert(id.find('\n') < 0)
 625         assert(id.find('\r') < 0)
 626         assert(id[0] != '-')
 627         type = _git_capture(['git', 'cat-file', '-t', id]).strip()
 628         yield type
 629
 630         p = subprocess.Popen(['git', 'cat-file', type, id],
 631                              stdout=subprocess.PIPE,
 632                              preexec_fn = _gitenv)
 633         for blob in chunkyreader(p.stdout):
 634             yield blob
 635         _git_wait('git cat-file', p)
 636
 637     def _join(self, it):
 638         type = it.next()
 639         if type == 'blob':
 640             for blob in it:
 641                 yield blob
 642         elif type == 'tree':
 643             treefile = ''.join(it)
 644             for (mode, name, sha) in _treeparse(treefile):
 645                 for blob in self.join(sha.encode('hex')):
 646                     yield blob
 647         elif type == 'commit':
 648             treeline = ''.join(it).split('\n')[0]
 649             assert(treeline.startswith('tree '))
 650             for blob in self.join(treeline[5:]):
 651                 yield blob
 652         else:
 653             raise GitError('invalid object type %r: expected blob/tree/commit'
 654                            % type)
 655
 656     def join(self, id):
 657         for d in self._join(self.get(id)):
 658             yield d
 659
 660
 661 def cat(id):
 662     c = CatPipe()
 663     for d in c.join(id):
 664         yield d