lib/bup/index.py

   1 import os, stat, struct, tempfile
   2 from bup.helpers import *
   3
   4 EMPTY_SHA = '\0'*20
   5 FAKE_SHA = '\x01'*20
   6 INDEX_HDR = 'BUPI\0\0\0\2'
   7
   8 # FIXME: guess I should have used 64-bit integers to store the mtime/ctime.
   9 # NTFS mtime=0 corresponds to the year 1600, which can't be stored in a 32-bit
  10 # time_t.  Next time we update the bupindex format, keep that in mind.
  11 INDEX_SIG = '!IIIIIQII20sHII'
  12
  13 ENTLEN = struct.calcsize(INDEX_SIG)
  14 FOOTER_SIG = '!Q'
  15 FOOTLEN = struct.calcsize(FOOTER_SIG)
  16
  17 IX_EXISTS = 0x8000        # file exists on filesystem
  18 IX_HASHVALID = 0x4000     # the stored sha1 matches the filesystem
  19 IX_SHAMISSING = 0x2000    # the stored sha1 object doesn't seem to exist
  20
  21 class Error(Exception):
  22     pass
  23
  24
  25 class Level:
  26     def __init__(self, ename, parent):
  27         self.parent = parent
  28         self.ename = ename
  29         self.list = []
  30         self.count = 0
  31
  32     def write(self, f):
  33         (ofs,n) = (f.tell(), len(self.list))
  34         if self.list:
  35             count = len(self.list)
  36             #log('popping %r with %d entries\n'
  37             #    % (''.join(self.ename), count))
  38             for e in self.list:
  39                 e.write(f)
  40             if self.parent:
  41                 self.parent.count += count + self.count
  42         return (ofs,n)
  43
  44
  45 def _golevel(level, f, ename, newentry):
  46     # close nodes back up the tree
  47     assert(level)
  48     while ename[:len(level.ename)] != level.ename:
  49         n = BlankNewEntry(level.ename[-1])
  50         n.flags |= IX_EXISTS
  51         (n.children_ofs,n.children_n) = level.write(f)
  52         level.parent.list.append(n)
  53         level = level.parent
  54
  55     # create nodes down the tree
  56     while len(level.ename) < len(ename):
  57         level = Level(ename[:len(level.ename)+1], level)
  58
  59     # are we in precisely the right place?
  60     assert(ename == level.ename)
  61     n = newentry or BlankNewEntry(ename and level.ename[-1] or None)
  62     (n.children_ofs,n.children_n) = level.write(f)
  63     if level.parent:
  64         level.parent.list.append(n)
  65     level = level.parent
  66
  67     return level
  68
  69
  70 class Entry:
  71     def __init__(self, basename, name):
  72         self.basename = str(basename)
  73         self.name = str(name)
  74         self.children_ofs = 0
  75         self.children_n = 0
  76
  77     def __repr__(self):
  78         return ("(%s,0x%04x,%d,%d,%d,%d,%d,%s/%s,0x%04x,0x%08x/%d)"
  79                 % (self.name, self.dev,
  80                    self.ctime, self.mtime, self.uid, self.gid,
  81                    self.size, oct(self.mode), oct(self.gitmode),
  82                    self.flags, self.children_ofs, self.children_n))
  83
  84     def packed(self):
  85         try:
  86             return struct.pack(INDEX_SIG,
  87                            self.dev, self.ctime, self.mtime,
  88                            self.uid, self.gid, self.size, self.mode,
  89                            self.gitmode, self.sha, self.flags,
  90                            self.children_ofs, self.children_n)
  91         except DeprecationWarning, e:
  92             log('pack error: %s (%r)\n' % (e, self))
  93             raise
  94
  95     def from_stat(self, st, tstart):
  96         old = (self.dev, self.ctime, self.mtime,
  97                self.uid, self.gid, self.size, self.flags & IX_EXISTS)
  98         new = (st.st_dev, int(st.st_ctime), int(st.st_mtime),
  99                st.st_uid, st.st_gid, st.st_size, IX_EXISTS)
 100         self.dev = st.st_dev
 101         self.ctime = int(st.st_ctime)
 102         self.mtime = int(st.st_mtime)
 103         self.uid = st.st_uid
 104         self.gid = st.st_gid
 105         self.size = st.st_size
 106         self.mode = st.st_mode
 107         self.flags |= IX_EXISTS
 108         if int(st.st_ctime) >= tstart or old != new \
 109               or self.sha == EMPTY_SHA or not self.gitmode:
 110             self.invalidate()
 111         self._fixup()
 112
 113     def _fixup(self):
 114         if self.uid < 0:
 115             self.uid += 0x100000000
 116         if self.gid < 0:
 117             self.gid += 0x100000000
 118         assert(self.uid >= 0)
 119         assert(self.gid >= 0)
 120         if self.mtime < -0x80000000:  # can happen in NTFS on 64-bit linux
 121             self.mtime = 0
 122         if self.ctime < -0x80000000:
 123             self.ctime = 0
 124         if self.mtime > 0x7fffffff:
 125             self.mtime = 0x7fffffff
 126         if self.ctime > 0x7fffffff:
 127             self.ctime = 0x7fffffff
 128
 129     def is_valid(self):
 130         f = IX_HASHVALID|IX_EXISTS
 131         return (self.flags & f) == f
 132
 133     def invalidate(self):
 134         self.flags &= ~IX_HASHVALID
 135
 136     def validate(self, gitmode, sha):
 137         assert(sha)
 138         assert(gitmode)
 139         assert(gitmode+0 == gitmode)
 140         self.gitmode = gitmode
 141         self.sha = sha
 142         self.flags |= IX_HASHVALID|IX_EXISTS
 143
 144     def exists(self):
 145         return not self.is_deleted()
 146
 147     def sha_missing(self):
 148         return (self.flags & IX_SHAMISSING) or not (self.flags & IX_HASHVALID)
 149
 150     def is_deleted(self):
 151         return (self.flags & IX_EXISTS) == 0
 152
 153     def set_deleted(self):
 154         if self.flags & IX_EXISTS:
 155             self.flags &= ~(IX_EXISTS | IX_HASHVALID)
 156
 157     def is_real(self):
 158         return not self.is_fake()
 159
 160     def is_fake(self):
 161         return not self.ctime
 162
 163     def __cmp__(a, b):
 164         return (cmp(b.name, a.name)
 165                 or cmp(a.is_valid(), b.is_valid())
 166                 or cmp(a.is_fake(), b.is_fake()))
 167
 168     def write(self, f):
 169         f.write(self.basename + '\0' + self.packed())
 170
 171
 172 class NewEntry(Entry):
 173     def __init__(self, basename, name, dev, ctime, mtime, uid, gid,
 174                  size, mode, gitmode, sha, flags, children_ofs, children_n):
 175         Entry.__init__(self, basename, name)
 176         (self.dev, self.ctime, self.mtime, self.uid, self.gid,
 177          self.size, self.mode, self.gitmode, self.sha,
 178          self.flags, self.children_ofs, self.children_n
 179          ) = (dev, int(ctime), int(mtime), uid, gid,
 180               size, mode, gitmode, sha, flags, children_ofs, children_n)
 181         self._fixup()
 182
 183
 184 class BlankNewEntry(NewEntry):
 185     def __init__(self, basename):
 186         NewEntry.__init__(self, basename, basename,
 187                           0, 0, 0, 0, 0, 0, 0,
 188                           0, EMPTY_SHA, 0, 0, 0)
 189
 190
 191 class ExistingEntry(Entry):
 192     def __init__(self, parent, basename, name, m, ofs):
 193         Entry.__init__(self, basename, name)
 194         self.parent = parent
 195         self._m = m
 196         self._ofs = ofs
 197         (self.dev, self.ctime, self.mtime, self.uid, self.gid,
 198          self.size, self.mode, self.gitmode, self.sha,
 199          self.flags, self.children_ofs, self.children_n
 200          ) = struct.unpack(INDEX_SIG, str(buffer(m, ofs, ENTLEN)))
 201
 202     # effectively, we don't bother messing with IX_SHAMISSING if
 203     # not IX_HASHVALID, since it's redundant, and repacking is more
 204     # expensive than not repacking.
 205     # This is implemented by having sha_missing() check IX_HASHVALID too.
 206     def set_sha_missing(self, val):
 207         val = val and 1 or 0
 208         oldval = self.sha_missing() and 1 or 0
 209         if val != oldval:
 210             flag = val and IX_SHAMISSING or 0
 211             newflags = (self.flags & (~IX_SHAMISSING)) | flag
 212             self.flags = newflags
 213             self.repack()
 214
 215     def unset_sha_missing(self, flag):
 216         if self.flags & IX_SHAMISSING:
 217             self.flags &= ~IX_SHAMISSING
 218             self.repack()
 219
 220     def repack(self):
 221         self._m[self._ofs:self._ofs+ENTLEN] = self.packed()
 222         if self.parent and not self.is_valid():
 223             self.parent.invalidate()
 224             self.parent.repack()
 225
 226     def iter(self, name=None, wantrecurse=None):
 227         dname = name
 228         if dname and not dname.endswith('/'):
 229             dname += '/'
 230         ofs = self.children_ofs
 231         assert(ofs <= len(self._m))
 232         assert(self.children_n < 1000000)
 233         for i in xrange(self.children_n):
 234             eon = self._m.find('\0', ofs)
 235             assert(eon >= 0)
 236             assert(eon >= ofs)
 237             assert(eon > ofs)
 238             basename = str(buffer(self._m, ofs, eon-ofs))
 239             child = ExistingEntry(self, basename, self.name + basename,
 240                                   self._m, eon+1)
 241             if (not dname
 242                  or child.name.startswith(dname)
 243                  or child.name.endswith('/') and dname.startswith(child.name)):
 244                 if not wantrecurse or wantrecurse(child):
 245                     for e in child.iter(name=name, wantrecurse=wantrecurse):
 246                         yield e
 247             if not name or child.name == name or child.name.startswith(dname):
 248                 yield child
 249             ofs = eon + 1 + ENTLEN
 250
 251     def __iter__(self):
 252         return self.iter()
 253
 254
 255 class Reader:
 256     def __init__(self, filename):
 257         self.filename = filename
 258         self.m = ''
 259         self.writable = False
 260         self.count = 0
 261         f = None
 262         try:
 263             f = open(filename, 'r+')
 264         except IOError, e:
 265             if e.errno == errno.ENOENT:
 266                 pass
 267             else:
 268                 raise
 269         if f:
 270             b = f.read(len(INDEX_HDR))
 271             if b != INDEX_HDR:
 272                 log('warning: %s: header: expected %r, got %r'
 273                                  % (filename, INDEX_HDR, b))
 274             else:
 275                 st = os.fstat(f.fileno())
 276                 if st.st_size:
 277                     self.m = mmap_readwrite(f)
 278                     self.writable = True
 279                     self.count = struct.unpack(FOOTER_SIG,
 280                           str(buffer(self.m, st.st_size-FOOTLEN, FOOTLEN)))[0]
 281
 282     def __del__(self):
 283         self.close()
 284
 285     def __len__(self):
 286         return int(self.count)
 287
 288     def forward_iter(self):
 289         ofs = len(INDEX_HDR)
 290         while ofs+ENTLEN <= len(self.m)-FOOTLEN:
 291             eon = self.m.find('\0', ofs)
 292             assert(eon >= 0)
 293             assert(eon >= ofs)
 294             assert(eon > ofs)
 295             basename = str(buffer(self.m, ofs, eon-ofs))
 296             yield ExistingEntry(None, basename, basename, self.m, eon+1)
 297             ofs = eon + 1 + ENTLEN
 298
 299     def iter(self, name=None, wantrecurse=None):
 300         if len(self.m) > len(INDEX_HDR)+ENTLEN:
 301             dname = name
 302             if dname and not dname.endswith('/'):
 303                 dname += '/'
 304             root = ExistingEntry(None, '/', '/',
 305                                  self.m, len(self.m)-FOOTLEN-ENTLEN)
 306             for sub in root.iter(name=name, wantrecurse=wantrecurse):
 307                 yield sub
 308             if not dname or dname == root.name:
 309                 yield root
 310
 311     def __iter__(self):
 312         return self.iter()
 313
 314     def exists(self):
 315         return self.m
 316
 317     def save(self):
 318         if self.writable and self.m:
 319             self.m.flush()
 320
 321     def close(self):
 322         self.save()
 323         if self.writable and self.m:
 324             self.m.close()
 325             self.m = None
 326             self.writable = False
 327
 328     def filter(self, prefixes, wantrecurse=None):
 329         for (rp, path) in reduce_paths(prefixes):
 330             for e in self.iter(rp, wantrecurse=wantrecurse):
 331                 assert(e.name.startswith(rp))
 332                 name = path + e.name[len(rp):]
 333                 yield (name, e)
 334
 335
 336 # FIXME: this function isn't very generic, because it splits the filename
 337 # in an odd way and depends on a terminating '/' to indicate directories.
 338 def pathsplit(p):
 339     """Split a path into a list of elements of the file system hierarchy."""
 340     l = p.split('/')
 341     l = [i+'/' for i in l[:-1]] + l[-1:]
 342     if l[-1] == '':
 343         l.pop()  # extra blank caused by terminating '/'
 344     return l
 345
 346
 347 class Writer:
 348     def __init__(self, filename):
 349         self.rootlevel = self.level = Level([], None)
 350         self.f = None
 351         self.count = 0
 352         self.lastfile = None
 353         self.filename = None
 354         self.filename = filename = realpath(filename)
 355         (dir,name) = os.path.split(filename)
 356         (ffd,self.tmpname) = tempfile.mkstemp('.tmp', filename, dir)
 357         self.f = os.fdopen(ffd, 'wb', 65536)
 358         self.f.write(INDEX_HDR)
 359
 360     def __del__(self):
 361         self.abort()
 362
 363     def abort(self):
 364         f = self.f
 365         self.f = None
 366         if f:
 367             f.close()
 368             os.unlink(self.tmpname)
 369
 370     def flush(self):
 371         if self.level:
 372             self.level = _golevel(self.level, self.f, [], None)
 373             self.count = self.rootlevel.count
 374             if self.count:
 375                 self.count += 1
 376             self.f.write(struct.pack(FOOTER_SIG, self.count))
 377             self.f.flush()
 378         assert(self.level == None)
 379
 380     def close(self):
 381         self.flush()
 382         f = self.f
 383         self.f = None
 384         if f:
 385             f.close()
 386             os.rename(self.tmpname, self.filename)
 387
 388     def _add(self, ename, entry):
 389         if self.lastfile and self.lastfile <= ename:
 390             raise Error('%r must come before %r'
 391                              % (''.join(e.name), ''.join(self.lastfile)))
 392             self.lastfile = e.name
 393         self.level = _golevel(self.level, self.f, ename, entry)
 394
 395     def add(self, name, st, hashgen = None):
 396         endswith = name.endswith('/')
 397         ename = pathsplit(name)
 398         basename = ename[-1]
 399         #log('add: %r %r\n' % (basename, name))
 400         flags = IX_EXISTS
 401         sha = None
 402         if hashgen:
 403             (gitmode, sha) = hashgen(name)
 404             flags |= IX_HASHVALID
 405         else:
 406             (gitmode, sha) = (0, EMPTY_SHA)
 407         if st:
 408             isdir = stat.S_ISDIR(st.st_mode)
 409             assert(isdir == endswith)
 410             e = NewEntry(basename, name, st.st_dev, int(st.st_ctime),
 411                          int(st.st_mtime), st.st_uid, st.st_gid,
 412                          st.st_size, st.st_mode, gitmode, sha, flags,
 413                          0, 0)
 414         else:
 415             assert(endswith)
 416             e = BlankNewEntry(basename)
 417             e.gitmode = gitmode
 418             e.sha = sha
 419             e.flags = flags
 420         self._add(ename, e)
 421
 422     def add_ixentry(self, e):
 423         e.children_ofs = e.children_n = 0
 424         self._add(pathsplit(e.name), e)
 425
 426     def new_reader(self):
 427         self.flush()
 428         return Reader(self.tmpname)
 429
 430
 431 def reduce_paths(paths):
 432     xpaths = []
 433     for p in paths:
 434         rp = realpath(p)
 435         try:
 436             st = os.lstat(rp)
 437             if stat.S_ISDIR(st.st_mode):
 438                 rp = slashappend(rp)
 439                 p = slashappend(p)
 440             xpaths.append((rp, p))
 441         except OSError, e:
 442             add_error('reduce_paths: %s' % e)
 443     xpaths.sort()
 444
 445     paths = []
 446     prev = None
 447     for (rp, p) in xpaths:
 448         if prev and (prev == rp
 449                      or (prev.endswith('/') and rp.startswith(prev))):
 450             continue # already superceded by previous path
 451         paths.append((rp, p))
 452         prev = rp
 453     paths.sort(reverse=True)
 454     return paths
 455
 456 def merge(*iters):
 457     def pfunc(count, total):
 458         qprogress('bup: merging indexes (%d/%d)\r' % (count, total))
 459     def pfinal(count, total):
 460         progress('bup: merging indexes (%d/%d), done.\n' % (count, total))
 461     return merge_iter(iters, 1024, pfunc, pfinal, key='name')