git.py

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