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, struct.error), 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,
  99                int(st.st_ctime.approx_secs()),
 100                int(st.st_mtime.approx_secs()),
 101                st.st_uid, st.st_gid, st.st_size, IX_EXISTS)
 102         self.dev = st.st_dev
 103         self.ctime = int(st.st_ctime.approx_secs())
 104         self.mtime = int(st.st_mtime.approx_secs())
 105         self.uid = st.st_uid
 106         self.gid = st.st_gid
 107         self.size = st.st_size
 108         self.mode = st.st_mode
 109         self.flags |= IX_EXISTS
 110         if int(st.st_ctime.approx_secs()) >= tstart or old != new \
 111               or self.sha == EMPTY_SHA or not self.gitmode:
 112             self.invalidate()
 113         self._fixup()
 114
 115     def _fixup(self):
 116         if self.uid < 0:
 117             self.uid += 0x100000000
 118         if self.gid < 0:
 119             self.gid += 0x100000000
 120         assert(self.uid >= 0)
 121         assert(self.gid >= 0)
 122         if self.mtime < -0x80000000:  # can happen in NTFS on 64-bit linux
 123             self.mtime = 0
 124         if self.ctime < -0x80000000:
 125             self.ctime = 0
 126         if self.mtime > 0x7fffffff:
 127             self.mtime = 0x7fffffff
 128         if self.ctime > 0x7fffffff:
 129             self.ctime = 0x7fffffff
 130
 131     def is_valid(self):
 132         f = IX_HASHVALID|IX_EXISTS
 133         return (self.flags & f) == f
 134
 135     def invalidate(self):
 136         self.flags &= ~IX_HASHVALID
 137
 138     def validate(self, gitmode, sha):
 139         assert(sha)
 140         assert(gitmode)
 141         assert(gitmode+0 == gitmode)
 142         self.gitmode = gitmode
 143         self.sha = sha
 144         self.flags |= IX_HASHVALID|IX_EXISTS
 145
 146     def exists(self):
 147         return not self.is_deleted()
 148
 149     def sha_missing(self):
 150         return (self.flags & IX_SHAMISSING) or not (self.flags & IX_HASHVALID)
 151
 152     def is_deleted(self):
 153         return (self.flags & IX_EXISTS) == 0
 154
 155     def set_deleted(self):
 156         if self.flags & IX_EXISTS:
 157             self.flags &= ~(IX_EXISTS | IX_HASHVALID)
 158
 159     def is_real(self):
 160         return not self.is_fake()
 161
 162     def is_fake(self):
 163         return not self.ctime
 164
 165     def __cmp__(a, b):
 166         return (cmp(b.name, a.name)
 167                 or cmp(a.is_valid(), b.is_valid())
 168                 or cmp(a.is_fake(), b.is_fake()))
 169
 170     def write(self, f):
 171         f.write(self.basename + '\0' + self.packed())
 172
 173
 174 class NewEntry(Entry):
 175     def __init__(self, basename, name, dev, ctime, mtime, uid, gid,
 176                  size, mode, gitmode, sha, flags, children_ofs, children_n):
 177         Entry.__init__(self, basename, name)
 178         (self.dev, self.ctime, self.mtime, self.uid, self.gid,
 179          self.size, self.mode, self.gitmode, self.sha,
 180          self.flags, self.children_ofs, self.children_n
 181          ) = (dev, int(ctime), int(mtime), uid, gid,
 182               size, mode, gitmode, sha, flags, children_ofs, children_n)
 183         self._fixup()
 184
 185
 186 class BlankNewEntry(NewEntry):
 187     def __init__(self, basename):
 188         NewEntry.__init__(self, basename, basename,
 189                           0, 0, 0, 0, 0, 0, 0,
 190                           0, EMPTY_SHA, 0, 0, 0)
 191
 192
 193 class ExistingEntry(Entry):
 194     def __init__(self, parent, basename, name, m, ofs):
 195         Entry.__init__(self, basename, name)
 196         self.parent = parent
 197         self._m = m
 198         self._ofs = ofs
 199         (self.dev, self.ctime, self.mtime, self.uid, self.gid,
 200          self.size, self.mode, self.gitmode, self.sha,
 201          self.flags, self.children_ofs, self.children_n
 202          ) = struct.unpack(INDEX_SIG, str(buffer(m, ofs, ENTLEN)))
 203
 204     # effectively, we don't bother messing with IX_SHAMISSING if
 205     # not IX_HASHVALID, since it's redundant, and repacking is more
 206     # expensive than not repacking.
 207     # This is implemented by having sha_missing() check IX_HASHVALID too.
 208     def set_sha_missing(self, val):
 209         val = val and 1 or 0
 210         oldval = self.sha_missing() and 1 or 0
 211         if val != oldval:
 212             flag = val and IX_SHAMISSING or 0
 213             newflags = (self.flags & (~IX_SHAMISSING)) | flag
 214             self.flags = newflags
 215             self.repack()
 216
 217     def unset_sha_missing(self, flag):
 218         if self.flags & IX_SHAMISSING:
 219             self.flags &= ~IX_SHAMISSING
 220             self.repack()
 221
 222     def repack(self):
 223         self._m[self._ofs:self._ofs+ENTLEN] = self.packed()
 224         if self.parent and not self.is_valid():
 225             self.parent.invalidate()
 226             self.parent.repack()
 227
 228     def iter(self, name=None, wantrecurse=None):
 229         dname = name
 230         if dname and not dname.endswith('/'):
 231             dname += '/'
 232         ofs = self.children_ofs
 233         assert(ofs <= len(self._m))
 234         assert(self.children_n < 1000000)
 235         for i in xrange(self.children_n):
 236             eon = self._m.find('\0', ofs)
 237             assert(eon >= 0)
 238             assert(eon >= ofs)
 239             assert(eon > ofs)
 240             basename = str(buffer(self._m, ofs, eon-ofs))
 241             child = ExistingEntry(self, basename, self.name + basename,
 242                                   self._m, eon+1)
 243             if (not dname
 244                  or child.name.startswith(dname)
 245                  or child.name.endswith('/') and dname.startswith(child.name)):
 246                 if not wantrecurse or wantrecurse(child):
 247                     for e in child.iter(name=name, wantrecurse=wantrecurse):
 248                         yield e
 249             if not name or child.name == name or child.name.startswith(dname):
 250                 yield child
 251             ofs = eon + 1 + ENTLEN
 252
 253     def __iter__(self):
 254         return self.iter()
 255
 256
 257 class Reader:
 258     def __init__(self, filename):
 259         self.filename = filename
 260         self.m = ''
 261         self.writable = False
 262         self.count = 0
 263         f = None
 264         try:
 265             f = open(filename, 'r+')
 266         except IOError, e:
 267             if e.errno == errno.ENOENT:
 268                 pass
 269             else:
 270                 raise
 271         if f:
 272             b = f.read(len(INDEX_HDR))
 273             if b != INDEX_HDR:
 274                 log('warning: %s: header: expected %r, got %r'
 275                                  % (filename, INDEX_HDR, b))
 276             else:
 277                 st = os.fstat(f.fileno())
 278                 if st.st_size:
 279                     self.m = mmap_readwrite(f)
 280                     self.writable = True
 281                     self.count = struct.unpack(FOOTER_SIG,
 282                           str(buffer(self.m, st.st_size-FOOTLEN, FOOTLEN)))[0]
 283
 284     def __del__(self):
 285         self.close()
 286
 287     def __len__(self):
 288         return int(self.count)
 289
 290     def forward_iter(self):
 291         ofs = len(INDEX_HDR)
 292         while ofs+ENTLEN <= len(self.m)-FOOTLEN:
 293             eon = self.m.find('\0', ofs)
 294             assert(eon >= 0)
 295             assert(eon >= ofs)
 296             assert(eon > ofs)
 297             basename = str(buffer(self.m, ofs, eon-ofs))
 298             yield ExistingEntry(None, basename, basename, self.m, eon+1)
 299             ofs = eon + 1 + ENTLEN
 300
 301     def iter(self, name=None, wantrecurse=None):
 302         if len(self.m) > len(INDEX_HDR)+ENTLEN:
 303             dname = name
 304             if dname and not dname.endswith('/'):
 305                 dname += '/'
 306             root = ExistingEntry(None, '/', '/',
 307                                  self.m, len(self.m)-FOOTLEN-ENTLEN)
 308             for sub in root.iter(name=name, wantrecurse=wantrecurse):
 309                 yield sub
 310             if not dname or dname == root.name:
 311                 yield root
 312
 313     def __iter__(self):
 314         return self.iter()
 315
 316     def exists(self):
 317         return self.m
 318
 319     def save(self):
 320         if self.writable and self.m:
 321             self.m.flush()
 322
 323     def close(self):
 324         self.save()
 325         if self.writable and self.m:
 326             self.m.close()
 327             self.m = None
 328             self.writable = False
 329
 330     def filter(self, prefixes, wantrecurse=None):
 331         for (rp, path) in reduce_paths(prefixes):
 332             for e in self.iter(rp, wantrecurse=wantrecurse):
 333                 assert(e.name.startswith(rp))
 334                 name = path + e.name[len(rp):]
 335                 yield (name, e)
 336
 337
 338 # FIXME: this function isn't very generic, because it splits the filename
 339 # in an odd way and depends on a terminating '/' to indicate directories.
 340 def pathsplit(p):
 341     """Split a path into a list of elements of the file system hierarchy."""
 342     l = p.split('/')
 343     l = [i+'/' for i in l[:-1]] + l[-1:]
 344     if l[-1] == '':
 345         l.pop()  # extra blank caused by terminating '/'
 346     return l
 347
 348
 349 class Writer:
 350     def __init__(self, filename):
 351         self.rootlevel = self.level = Level([], None)
 352         self.f = None
 353         self.count = 0
 354         self.lastfile = None
 355         self.filename = None
 356         self.filename = filename = realpath(filename)
 357         (dir,name) = os.path.split(filename)
 358         (ffd,self.tmpname) = tempfile.mkstemp('.tmp', filename, dir)
 359         self.f = os.fdopen(ffd, 'wb', 65536)
 360         self.f.write(INDEX_HDR)
 361
 362     def __del__(self):
 363         self.abort()
 364
 365     def abort(self):
 366         f = self.f
 367         self.f = None
 368         if f:
 369             f.close()
 370             os.unlink(self.tmpname)
 371
 372     def flush(self):
 373         if self.level:
 374             self.level = _golevel(self.level, self.f, [], None)
 375             self.count = self.rootlevel.count
 376             if self.count:
 377                 self.count += 1
 378             self.f.write(struct.pack(FOOTER_SIG, self.count))
 379             self.f.flush()
 380         assert(self.level == None)
 381
 382     def close(self):
 383         self.flush()
 384         f = self.f
 385         self.f = None
 386         if f:
 387             f.close()
 388             os.rename(self.tmpname, self.filename)
 389
 390     def _add(self, ename, entry):
 391         if self.lastfile and self.lastfile <= ename:
 392             raise Error('%r must come before %r'
 393                              % (''.join(e.name), ''.join(self.lastfile)))
 394             self.lastfile = e.name
 395         self.level = _golevel(self.level, self.f, ename, entry)
 396
 397     def add(self, name, st, hashgen = None):
 398         endswith = name.endswith('/')
 399         ename = pathsplit(name)
 400         basename = ename[-1]
 401         #log('add: %r %r\n' % (basename, name))
 402         flags = IX_EXISTS
 403         sha = None
 404         if hashgen:
 405             (gitmode, sha) = hashgen(name)
 406             flags |= IX_HASHVALID
 407         else:
 408             (gitmode, sha) = (0, EMPTY_SHA)
 409         if st:
 410             isdir = stat.S_ISDIR(st.st_mode)
 411             assert(isdir == endswith)
 412             e = NewEntry(basename, name, st.st_dev,
 413                          int(st.st_ctime.approx_secs()),
 414                          int(st.st_mtime.approx_secs()),
 415                          st.st_uid, st.st_gid,
 416                          st.st_size, st.st_mode, gitmode, sha, flags,
 417                          0, 0)
 418         else:
 419             assert(endswith)
 420             e = BlankNewEntry(basename)
 421             e.gitmode = gitmode
 422             e.sha = sha
 423             e.flags = flags
 424         self._add(ename, e)
 425
 426     def add_ixentry(self, e):
 427         e.children_ofs = e.children_n = 0
 428         self._add(pathsplit(e.name), e)
 429
 430     def new_reader(self):
 431         self.flush()
 432         return Reader(self.tmpname)
 433
 434
 435 def reduce_paths(paths):
 436     xpaths = []
 437     for p in paths:
 438         rp = realpath(p)
 439         try:
 440             st = os.lstat(rp)
 441             if stat.S_ISDIR(st.st_mode):
 442                 rp = slashappend(rp)
 443                 p = slashappend(p)
 444             xpaths.append((rp, p))
 445         except OSError, e:
 446             add_error('reduce_paths: %s' % e)
 447     xpaths.sort()
 448
 449     paths = []
 450     prev = None
 451     for (rp, p) in xpaths:
 452         if prev and (prev == rp
 453                      or (prev.endswith('/') and rp.startswith(prev))):
 454             continue # already superceded by previous path
 455         paths.append((rp, p))
 456         prev = rp
 457     paths.sort(reverse=True)
 458     return paths
 459
 460 def merge(*iters):
 461     def pfunc(count, total):
 462         qprogress('bup: merging indexes (%d/%d)\r' % (count, total))
 463     def pfinal(count, total):
 464         progress('bup: merging indexes (%d/%d), done.\n' % (count, total))
 465     return merge_iter(iters, 1024, pfunc, pfinal, key='name')