cumulus-util

   1 #!/usr/bin/python
   2 #
   3 # Utility for managing Cumulus archives.
   4
   5 import getpass, os, stat, sys, time
   6 from optparse import OptionParser
   7 import cumulus
   8
   9 # Compatibility
  10 lbs = cumulus
  11
  12 # We support up to "LBS Snapshot v0.8" formats, but are also limited by the lbs
  13 # module.
  14 FORMAT_VERSION = min(lbs.FORMAT_VERSION, (0, 8))
  15
  16 def check_version(format):
  17     ver = lbs.parse_metadata_version(format)
  18     if ver > FORMAT_VERSION:
  19         raise RuntimeError("Unsupported LBS format: " + format)
  20
  21 parser = OptionParser(usage="%prog [option]... command [arg]...")
  22 parser.add_option("-v", action="store_true", dest="verbose", default=False,
  23                   help="increase verbosity")
  24 parser.add_option("--store", dest="store",
  25                   help="specify path to backup data store")
  26 parser.add_option("--localdb", dest="localdb",
  27                   help="specify path to local database")
  28 parser.add_option("--intent", dest="intent", default=1.0,
  29                   help="give expected next snapshot type when cleaning")
  30 (options, args) = parser.parse_args(sys.argv[1:])
  31
  32 # Read a passphrase from the user and store it in the LBS_GPG_PASSPHRASE
  33 # environment variable.
  34 def get_passphrase():
  35     ENV_KEY = 'LBS_GPG_PASSPHRASE'
  36     if not os.environ.has_key(ENV_KEY):
  37         os.environ[ENV_KEY] = getpass.getpass()
  38
  39 # Delete old snapshots from the local database, though do not actually schedule
  40 # any segment cleaning.
  41 # Syntax: $0 --localdb=LOCALDB prune-db
  42 def cmd_prune_db():
  43     db = lbs.LocalDatabase(options.localdb)
  44
  45     # Delete old snapshots from the local database.
  46     #db.garbage_collect()
  47     #db.commit()
  48
  49 # Run the segment cleaner.
  50 # Syntax: $0 --localdb=LOCALDB clean
  51 def cmd_clean(clean_threshold=7.0):
  52     db = lbs.LocalDatabase(options.localdb)
  53
  54     # Delete old snapshots from the local database.
  55     intent = float(options.intent)
  56     for s in db.list_schemes():
  57         db.garbage_collect(s, intent)
  58
  59     # Expire segments which are poorly-utilized.
  60     for s in db.get_segment_cleaning_list():
  61         if s.cleaning_benefit > clean_threshold:
  62             print "Cleaning segment %d (benefit %.2f)" % (s.id,
  63                                                           s.cleaning_benefit)
  64             db.mark_segment_expired(s)
  65         else:
  66             break
  67     db.balance_expired_objects()
  68     db.commit()
  69
  70 # List snapshots stored.
  71 # Syntax: $0 --data=DATADIR list-snapshots
  72 def cmd_list_snapshots():
  73     store = lbs.LowlevelDataStore(options.store)
  74     for s in sorted(store.list_snapshots()):
  75         print s
  76
  77 # List size of data needed for each snapshot.
  78 # Syntax: $0 --data=DATADIR list-snapshot-sizes
  79 def cmd_list_snapshot_sizes():
  80     lowlevel = lbs.LowlevelDataStore(options.store)
  81     store = lbs.ObjectStore(lowlevel)
  82     previous = set()
  83     for s in sorted(lowlevel.list_snapshots()):
  84         d = lbs.parse_full(store.load_snapshot(s))
  85         check_version(d['Format'])
  86         segments = d['Segments'].split()
  87         (size, added, removed) = (0, 0, 0)
  88         for seg in segments:
  89             segsize = lowlevel.lowlevel_stat(seg + ".tar.gpg")['size']
  90             size += segsize
  91             if seg not in previous: added += segsize
  92         for seg in previous:
  93             if seg not in segments:
  94                 removed += lowlevel.lowlevel_stat(seg + ".tar.gpg")['size']
  95         previous = set(segments)
  96         print "%s: %.3f +%.3f -%.3f" % (s, size / 1024.0**2, added / 1024.0**2, removed / 1024.0**2)
  97
  98 # Build checksum list for objects in the given segments, or all segments if
  99 # none are specified.
 100 def cmd_object_checksums(segments):
 101     get_passphrase()
 102     lowlevel = lbs.LowlevelDataStore(options.store)
 103     store = lbs.ObjectStore(lowlevel)
 104     if len(segments) == 0:
 105         segments = sorted(lowlevel.list_segments())
 106     for s in segments:
 107         for (o, data) in store.load_segment(s):
 108             csum = lbs.ChecksumCreator().update(data).compute()
 109             print "%s/%s:%d:%s" % (s, o, len(data), csum)
 110     store.cleanup()
 111
 112 # Read a snapshot file
 113 def cmd_read_snapshots(snapshots):
 114     get_passphrase()
 115     lowlevel = lbs.LowlevelDataStore(options.store)
 116     store = lbs.ObjectStore(lowlevel)
 117     for s in snapshots:
 118         d = lbs.parse_full(store.load_snapshot(s))
 119         check_version(d['Format'])
 120         print d
 121         print d['Segments'].split()
 122     store.cleanup()
 123
 124 # Produce a flattened metadata dump from a snapshot
 125 def cmd_read_metadata(snapshot):
 126     get_passphrase()
 127     lowlevel = lbs.LowlevelDataStore(options.store)
 128     store = lbs.ObjectStore(lowlevel)
 129     d = lbs.parse_full(store.load_snapshot(snapshot))
 130     check_version(d['Format'])
 131     metadata = lbs.read_metadata(store, d['Root'])
 132     blank = True
 133     for l in metadata:
 134         if l == '\n':
 135             if blank: continue
 136             blank = True
 137         else:
 138             blank = False
 139         sys.stdout.write(l)
 140     store.cleanup()
 141
 142 # Verify snapshot integrity
 143 def cmd_verify_snapshots(snapshots):
 144     get_passphrase()
 145     lowlevel = lbs.LowlevelDataStore(options.store)
 146     store = lbs.ObjectStore(lowlevel)
 147     for s in snapshots:
 148         lbs.accessed_segments.clear()
 149         print "#### Snapshot", s
 150         d = lbs.parse_full(store.load_snapshot(s))
 151         check_version(d['Format'])
 152         print "## Root:", d['Root']
 153         metadata = lbs.iterate_metadata(store, d['Root'])
 154         for m in metadata:
 155             if m.fields['type'] not in ('-', 'f'): continue
 156             print "%s [%d bytes]" % (m.fields['name'], int(m.fields['size']))
 157             verifier = lbs.ChecksumVerifier(m.fields['checksum'])
 158             size = 0
 159             for block in m.data():
 160                 data = store.get(block)
 161                 verifier.update(data)
 162                 size += len(data)
 163             if int(m.fields['size']) != size:
 164                 raise ValueError("File size does not match!")
 165             if not verifier.valid():
 166                 raise ValueError("Bad checksum found")
 167
 168         # Verify that the list of segments included with the snapshot was
 169         # actually accurate: covered all segments that were really read, and
 170         # doesn't contain duplicates.
 171         listed_segments = set(d['Segments'].split())
 172         if lbs.accessed_segments - listed_segments:
 173             print "Error: Some segments not listed in descriptor!"
 174             print sorted(list(lbs.accessed_segments - listed_segments))
 175         if listed_segments - lbs.accessed_segments :
 176             print "Warning: Extra unused segments listed in descriptor!"
 177             print sorted(list(listed_segments - lbs.accessed_segments))
 178     store.cleanup()
 179
 180 # Restore a snapshot, or some subset of files from it
 181 def cmd_restore_snapshot(args):
 182     get_passphrase()
 183     lowlevel = lbs.LowlevelDataStore(options.store)
 184     store = lbs.ObjectStore(lowlevel)
 185     snapshot = lbs.parse_full(store.load_snapshot(args[0]))
 186     check_version(snapshot['Format'])
 187     destdir = args[1]
 188     paths = args[2:]
 189
 190     def matchpath(path):
 191         "Return true if the specified path should be included in the restore."
 192
 193         # No specification of what to restore => restore everything
 194         if len(paths) == 0: return True
 195
 196         for p in paths:
 197             if path == p: return True
 198             if path.startswith(p + "/"): return True
 199         return False
 200
 201     def warn(m, msg):
 202         print "Warning: %s: %s" % (m.items.name, msg)
 203
 204     # Phase 1: Read the complete metadata log and create directory structure.
 205     metadata_items = []
 206     metadata_paths = {}
 207     metadata_segments = {}
 208     for m in lbs.iterate_metadata(store, snapshot['Root']):
 209         pathname = os.path.normpath(m.items.name)
 210         while os.path.isabs(pathname):
 211             pathname = pathname[1:]
 212         if not matchpath(pathname): continue
 213
 214         destpath = os.path.join(destdir, pathname)
 215         if m.items.type == 'd':
 216             path = destpath
 217         else:
 218             (path, filename) = os.path.split(destpath)
 219
 220         metadata_items.append((pathname, m))
 221         if m.items.type in ('-', 'f'):
 222             metadata_paths[pathname] = m
 223             for block in m.data():
 224                 (segment, object, checksum, slice) \
 225                     = lbs.ObjectStore.parse_ref(block)
 226                 if segment not in metadata_segments:
 227                     metadata_segments[segment] = set()
 228                 metadata_segments[segment].add(pathname)
 229
 230         try:
 231             if not os.path.isdir(path):
 232                 print "mkdir:", path
 233                 os.makedirs(path)
 234         except Exception, e:
 235             warn(m, "Error creating directory structure: %s" % (e,))
 236             continue
 237
 238     # Phase 2: Restore files, ordered by how data is stored in segments.
 239     def restore_file(pathname, m):
 240         assert m.items.type in ('-', 'f')
 241         print "extract:", pathname
 242         destpath = os.path.join(destdir, pathname)
 243
 244         file = open(destpath, 'wb')
 245         verifier = lbs.ChecksumVerifier(m.items.checksum)
 246         size = 0
 247         for block in m.data():
 248             data = store.get(block)
 249             verifier.update(data)
 250             size += len(data)
 251             file.write(data)
 252         file.close()
 253         if int(m.fields['size']) != size:
 254             raise ValueError("File size does not match!")
 255         if not verifier.valid():
 256             raise ValueError("Bad checksum found")
 257
 258     while metadata_segments:
 259         (segment, items) = metadata_segments.popitem()
 260         print "+ Segment", segment
 261         for pathname in sorted(items):
 262             if pathname in metadata_paths:
 263                 restore_file(pathname, metadata_paths[pathname])
 264                 del metadata_paths[pathname]
 265
 266     print "+ Remaining files"
 267     while metadata_paths:
 268         (pathname, m) = metadata_paths.popitem()
 269         restore_file(pathname, m)
 270
 271     # Phase 3: Restore special files (symlinks, devices).
 272     # Phase 4: Restore directory permissions and modification times.
 273     for (pathname, m) in reversed(metadata_items):
 274         print "permissions:", pathname
 275         destpath = os.path.join(destdir, pathname)
 276         (path, filename) = os.path.split(destpath)
 277
 278         # TODO: Check for ../../../paths that might attempt to write outside
 279         # the destination directory.  Maybe also check attempts to follow
 280         # symlinks pointing outside?
 281
 282         try:
 283             if m.items.type in ('-', 'f', 'd'):
 284                 pass
 285             elif m.items.type == 'l':
 286                 try:
 287                     target = m.items.target
 288                 except:
 289                     # Old (v0.2 format) name for 'target'
 290                     target = m.items.contents
 291                 os.symlink(target, destpath)
 292             elif m.items.type == 'p':
 293                 os.mkfifo(destpath)
 294             elif m.items.type in ('c', 'b'):
 295                 if m.items.type == 'c':
 296                     mode = 0600 | stat.S_IFCHR
 297                 else:
 298                     mode = 0600 | stat.S_IFBLK
 299                 os.mknod(destpath, mode, os.makedev(*m.items.device))
 300             elif m.items.type == 's':
 301                 pass        # TODO: Implement
 302             else:
 303                 warn(m, "Unknown type code: " + m.items.type)
 304                 continue
 305
 306         except Exception, e:
 307             warn(m, "Error restoring: %s" % (e,))
 308             continue
 309
 310         try:
 311             uid = m.items.user[0]
 312             gid = m.items.group[0]
 313             os.lchown(destpath, uid, gid)
 314         except Exception, e:
 315             warn(m, "Error restoring file ownership: %s" % (e,))
 316
 317         if m.items.type == 'l':
 318             continue
 319
 320         try:
 321             os.chmod(destpath, m.items.mode)
 322         except Exception, e:
 323             warn(m, "Error restoring file permissions: %s" % (e,))
 324
 325         try:
 326             os.utime(destpath, (time.time(), m.items.mtime))
 327         except Exception, e:
 328             warn(m, "Error restoring file timestamps: %s" % (e,))
 329
 330     store.cleanup()
 331
 332 if len(args) == 0:
 333     parser.print_usage()
 334     sys.exit(1)
 335 cmd = args[0]
 336 args = args[1:]
 337 if cmd == 'clean':
 338     cmd_clean()
 339 elif cmd == 'prune-db':
 340     cmd_prune_db()
 341 elif cmd == 'list-snapshots':
 342     cmd_list_snapshots()
 343 elif cmd == 'object-sums':
 344     cmd_object_checksums(args)
 345 elif cmd == 'read-snapshots':
 346     cmd_read_snapshots(args)
 347 elif cmd == 'read-metadata':
 348     cmd_read_metadata(args[0])
 349 elif cmd == 'list-snapshot-sizes':
 350     cmd_list_snapshot_sizes()
 351 elif cmd == 'verify-snapshots':
 352     cmd_verify_snapshots(args)
 353 elif cmd == 'restore-snapshot':
 354     cmd_restore_snapshot(args)
 355 else:
 356     print "Unknown command:", cmd
 357     parser.print_usage()
 358     sys.exit(1)