cmd/index-cmd.py

   1 #!/usr/bin/env python
   2
   3 import sys, stat, time, os, errno
   4 from bup import metadata, options, git, index, drecurse, hlinkdb
   5 from bup.helpers import *
   6 from bup.hashsplit import GIT_MODE_TREE, GIT_MODE_FILE
   7
   8 class IterHelper:
   9     def __init__(self, l):
  10         self.i = iter(l)
  11         self.cur = None
  12         self.next()
  13
  14     def next(self):
  15         try:
  16             self.cur = self.i.next()
  17         except StopIteration:
  18             self.cur = None
  19         return self.cur
  20
  21
  22 def check_index(reader):
  23     try:
  24         log('check: checking forward iteration...\n')
  25         e = None
  26         d = {}
  27         for e in reader.forward_iter():
  28             if e.children_n:
  29                 if opt.verbose:
  30                     log('%08x+%-4d %r\n' % (e.children_ofs, e.children_n,
  31                                             e.name))
  32                 assert(e.children_ofs)
  33                 assert(e.name.endswith('/'))
  34                 assert(not d.get(e.children_ofs))
  35                 d[e.children_ofs] = 1
  36             if e.flags & index.IX_HASHVALID:
  37                 assert(e.sha != index.EMPTY_SHA)
  38                 assert(e.gitmode)
  39         assert(not e or e.name == '/')  # last entry is *always* /
  40         log('check: checking normal iteration...\n')
  41         last = None
  42         for e in reader:
  43             if last:
  44                 assert(last > e.name)
  45             last = e.name
  46     except:
  47         log('index error! at %r\n' % e)
  48         raise
  49     log('check: passed.\n')
  50
  51
  52 def clear_index(indexfile):
  53     indexfiles = [indexfile, indexfile + '.meta', indexfile + '.hlink']
  54     for indexfile in indexfiles:
  55         path = git.repo(indexfile)
  56         try:
  57             os.remove(path)
  58             if opt.verbose:
  59                 log('clear: removed %s\n' % path)
  60         except OSError, e:
  61             if e.errno != errno.ENOENT:
  62                 raise
  63
  64
  65 def update_index(top, excluded_paths):
  66     # tmax and start must be epoch nanoseconds.
  67     tmax = (time.time() - 1) * 10**9
  68     ri = index.Reader(indexfile)
  69     msw = index.MetaStoreWriter(indexfile + '.meta')
  70     wi = index.Writer(indexfile, msw, tmax)
  71     rig = IterHelper(ri.iter(name=top))
  72     tstart = int(time.time()) * 10**9
  73
  74     hlinks = hlinkdb.HLinkDB(indexfile + '.hlink')
  75
  76     hashgen = None
  77     if opt.fake_valid:
  78         def hashgen(name):
  79             return (GIT_MODE_FILE, index.FAKE_SHA)
  80
  81     total = 0
  82     bup_dir = os.path.abspath(git.repo())
  83     for (path,pst) in drecurse.recursive_dirlist([top], xdev=opt.xdev,
  84                                                  bup_dir=bup_dir,
  85                                                  excluded_paths=excluded_paths):
  86         if opt.verbose>=2 or (opt.verbose==1 and stat.S_ISDIR(pst.st_mode)):
  87             sys.stdout.write('%s\n' % path)
  88             sys.stdout.flush()
  89             qprogress('Indexing: %d\r' % total)
  90         elif not (total % 128):
  91             qprogress('Indexing: %d\r' % total)
  92         total += 1
  93         while rig.cur and rig.cur.name > path:  # deleted paths
  94             if rig.cur.exists():
  95                 rig.cur.set_deleted()
  96                 rig.cur.repack()
  97                 if rig.cur.nlink > 1 and not stat.S_ISDIR(rig.cur.mode):
  98                     hlinks.del_path(rig.cur.name)
  99             rig.next()
 100         if rig.cur and rig.cur.name == path:    # paths that already existed
 101             if not stat.S_ISDIR(rig.cur.mode) and rig.cur.nlink > 1:
 102                 hlinks.del_path(rig.cur.name)
 103             if not stat.S_ISDIR(pst.st_mode) and pst.st_nlink > 1:
 104                 hlinks.add_path(path, pst.st_dev, pst.st_ino)
 105             meta = metadata.from_path(path, statinfo=pst)
 106             # Clear these so they don't bloat the store -- they're
 107             # already in the index (since they vary a lot and they're
 108             # fixed length).  If you've noticed "tmax", you might
 109             # wonder why it's OK to do this, since that code may
 110             # adjust (mangle) the index mtime and ctime -- producing
 111             # fake values which must not end up in a .bupm.  However,
 112             # it looks like that shouldn't be possible:  (1) When
 113             # "save" validates the index entry, it always reads the
 114             # metadata from the filesytem. (2) Metadata is only
 115             # read/used from the index if hashvalid is true. (3) index
 116             # always invalidates "faked" entries, because "old != new"
 117             # in from_stat().
 118             meta.ctime = meta.mtime = meta.atime = 0
 119             meta_ofs = msw.store(meta)
 120             rig.cur.from_stat(pst, meta_ofs, tstart,
 121                               check_device=opt.check_device)
 122             if not (rig.cur.flags & index.IX_HASHVALID):
 123                 if hashgen:
 124                     (rig.cur.gitmode, rig.cur.sha) = hashgen(path)
 125                     rig.cur.flags |= index.IX_HASHVALID
 126             if opt.fake_invalid:
 127                 rig.cur.invalidate()
 128             rig.cur.repack()
 129             rig.next()
 130         else:  # new paths
 131             meta = metadata.from_path(path, statinfo=pst)
 132             # See same assignment to 0, above, for rationale.
 133             meta.atime = meta.mtime = meta.ctime = 0
 134             meta_ofs = msw.store(meta)
 135             wi.add(path, pst, meta_ofs, hashgen = hashgen)
 136             if not stat.S_ISDIR(pst.st_mode) and pst.st_nlink > 1:
 137                 hlinks.add_path(path, pst.st_dev, pst.st_ino)
 138
 139     progress('Indexing: %d, done.\n' % total)
 140
 141     hlinks.prepare_save()
 142
 143     if ri.exists():
 144         ri.save()
 145         wi.flush()
 146         if wi.count:
 147             wr = wi.new_reader()
 148             if opt.check:
 149                 log('check: before merging: oldfile\n')
 150                 check_index(ri)
 151                 log('check: before merging: newfile\n')
 152                 check_index(wr)
 153             mi = index.Writer(indexfile, msw, tmax)
 154
 155             for e in index.merge(ri, wr):
 156                 # FIXME: shouldn't we remove deleted entries eventually?  When?
 157                 mi.add_ixentry(e)
 158
 159             ri.close()
 160             mi.close()
 161             wr.close()
 162         wi.abort()
 163     else:
 164         wi.close()
 165
 166     msw.close()
 167     hlinks.commit_save()
 168
 169
 170 optspec = """
 171 bup index <-p|m|s|u> [options...] <filenames...>
 172 --
 173  Modes:
 174 p,print    print the index entries for the given names (also works with -u)
 175 m,modified print only added/deleted/modified files (implies -p)
 176 s,status   print each filename with a status char (A/M/D) (implies -p)
 177 u,update   recursively update the index entries for the given file/dir names (default if no mode is specified)
 178 check      carefully check index file integrity
 179 clear      clear the index
 180  Options:
 181 H,hash     print the hash for each object next to its name
 182 l,long     print more information about each file
 183 no-check-device don't invalidate an entry if the containing device changes
 184 fake-valid mark all index entries as up-to-date even if they aren't
 185 fake-invalid mark all index entries as invalid
 186 f,indexfile=  the name of the index file (normally BUP_DIR/bupindex)
 187 exclude=   a path to exclude from the backup (can be used more than once)
 188 exclude-from= a file that contains exclude paths (can be used more than once)
 189 v,verbose  increase log output (can be used more than once)
 190 x,xdev,one-file-system  don't cross filesystem boundaries
 191 """
 192 o = options.Options(optspec)
 193 (opt, flags, extra) = o.parse(sys.argv[1:])
 194
 195 if not (opt.modified or \
 196         opt['print'] or \
 197         opt.status or \
 198         opt.update or \
 199         opt.check or \
 200         opt.clear):
 201     opt.update = 1
 202 if (opt.fake_valid or opt.fake_invalid) and not opt.update:
 203     o.fatal('--fake-{in,}valid are meaningless without -u')
 204 if opt.fake_valid and opt.fake_invalid:
 205     o.fatal('--fake-valid is incompatible with --fake-invalid')
 206
 207 # FIXME: remove this once we account for timestamp races, i.e. index;
 208 # touch new-file; index.  It's possible for this to happen quickly
 209 # enough that new-file ends up with the same timestamp as the first
 210 # index, and then bup will ignore it.
 211 tick_start = time.time()
 212 time.sleep(1 - (tick_start - int(tick_start)))
 213
 214 git.check_repo_or_die()
 215 indexfile = opt.indexfile or git.repo('bupindex')
 216
 217 handle_ctrl_c()
 218
 219 if opt.check:
 220     log('check: starting initial check.\n')
 221     check_index(index.Reader(indexfile))
 222
 223 if opt.clear:
 224     log('clear: clearing index.\n')
 225     clear_index(indexfile)
 226
 227 excluded_paths = parse_excludes(flags, o.fatal)
 228 paths = index.reduce_paths(extra)
 229
 230 if opt.update:
 231     if not extra:
 232         o.fatal('update mode (-u) requested but no paths given')
 233     for (rp,path) in paths:
 234         update_index(rp, excluded_paths)
 235
 236 if opt['print'] or opt.status or opt.modified:
 237     for (name, ent) in index.Reader(indexfile).filter(extra or ['']):
 238         if (opt.modified
 239             and (ent.is_valid() or ent.is_deleted() or not ent.mode)):
 240             continue
 241         line = ''
 242         if opt.status:
 243             if ent.is_deleted():
 244                 line += 'D '
 245             elif not ent.is_valid():
 246                 if ent.sha == index.EMPTY_SHA:
 247                     line += 'A '
 248                 else:
 249                     line += 'M '
 250             else:
 251                 line += '  '
 252         if opt.hash:
 253             line += ent.sha.encode('hex') + ' '
 254         if opt.long:
 255             line += "%7s %7s " % (oct(ent.mode), oct(ent.gitmode))
 256         print line + (name or './')
 257
 258 if opt.check and (opt['print'] or opt.status or opt.modified or opt.update):
 259     log('check: starting final check.\n')
 260     check_index(index.Reader(indexfile))
 261
 262 if saved_errors:
 263     log('WARNING: %d errors encountered.\n' % len(saved_errors))
 264     sys.exit(1)