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