3 # Utility for managing LBS archives.
5 import getpass, os, stat, sys, time
6 from optparse import OptionParser
9 parser = OptionParser(usage="%prog [option]... command [arg]...")
10 parser.add_option("-v", action="store_true", dest="verbose", default=False,
11 help="increase verbosity")
12 parser.add_option("--store", dest="store",
13 help="specify path to backup data store")
14 parser.add_option("--localdb", dest="localdb",
15 help="specify path to local database")
16 (options, args) = parser.parse_args(sys.argv[1:])
18 # Read a passphrase from the user and store it in the LBS_GPG_PASSPHRASE
19 # environment variable.
21 ENV_KEY = 'LBS_GPG_PASSPHRASE'
22 if not os.environ.has_key(ENV_KEY):
23 os.environ[ENV_KEY] = getpass.getpass()
25 # Delete old snapshots from the local database, though do not actually schedule
26 # any segment cleaning.
27 # Syntax: $0 --localdb=LOCALDB prune-db
29 db = lbs.LocalDatabase(options.localdb)
31 # Delete old snapshots from the local database.
35 # Run the segment cleaner.
36 # Syntax: $0 --localdb=LOCALDB clean
37 def cmd_clean(clean_threshold=7.0):
38 db = lbs.LocalDatabase(options.localdb)
40 # Delete old snapshots from the local database.
43 # Expire segments which are poorly-utilized.
44 for s in db.get_segment_cleaning_list():
45 if s.cleaning_benefit > clean_threshold:
46 print "Cleaning segment %d (benefit %.2f)" % (s.id,
48 db.mark_segment_expired(s)
51 db.balance_expired_objects()
54 # List snapshots stored.
55 # Syntax: $0 --data=DATADIR list-snapshots
56 def cmd_list_snapshots():
57 store = lbs.LowlevelDataStore(options.store)
58 for s in sorted(store.list_snapshots()):
61 # List size of data needed for each snapshot.
62 # Syntax: $0 --data=DATADIR list-snapshot-sizes
63 def cmd_list_snapshot_sizes():
64 lowlevel = lbs.LowlevelDataStore(options.store)
65 store = lbs.ObjectStore(lowlevel)
67 for s in sorted(lowlevel.list_snapshots()):
68 d = lbs.parse_full(store.load_snapshot(s))
69 segments = d['Segments'].split()
70 (size, added, removed) = (0, 0, 0)
72 segsize = lowlevel.lowlevel_stat(seg + ".tar.gpg")['size']
74 if seg not in previous: added += segsize
76 if seg not in segments:
77 removed += lowlevel.lowlevel_stat(seg + ".tar.gpg")['size']
78 previous = set(segments)
79 print "%s: %.3f +%.3f -%.3f" % (s, size / 1024.0**2, added / 1024.0**2, removed / 1024.0**2)
81 # Build checksum list for objects in the given segments, or all segments if
83 def cmd_object_checksums(segments):
85 lowlevel = lbs.LowlevelDataStore(options.store)
86 store = lbs.ObjectStore(lowlevel)
87 if len(segments) == 0:
88 segments = sorted(lowlevel.list_segments())
90 for (o, data) in store.load_segment(s):
91 csum = lbs.ChecksumCreator().update(data).compute()
92 print "%s/%s:%d:%s" % (s, o, len(data), csum)
95 # Read a snapshot file
96 def cmd_read_snapshots(snapshots):
98 lowlevel = lbs.LowlevelDataStore(options.store)
99 store = lbs.ObjectStore(lowlevel)
101 d = lbs.parse_full(store.load_snapshot(s))
103 print d['Segments'].split()
106 # Produce a flattened metadata dump from a snapshot
107 def cmd_read_metadata(snapshot):
109 lowlevel = lbs.LowlevelDataStore(options.store)
110 store = lbs.ObjectStore(lowlevel)
111 d = lbs.parse_full(store.load_snapshot(snapshot))
112 metadata = lbs.read_metadata(store, d['Root'])
117 # Verify snapshot integrity
118 def cmd_verify_snapshots(snapshots):
120 lowlevel = lbs.LowlevelDataStore(options.store)
121 store = lbs.ObjectStore(lowlevel)
123 print "#### Snapshot", s
124 d = lbs.parse_full(store.load_snapshot(s))
125 print "## Root:", d['Root']
126 metadata = lbs.iterate_metadata(store, d['Root'])
128 if m.fields['type'] != '-': continue
129 print "%s [%d bytes]" % (m.fields['name'], int(m.fields['size']))
130 verifier = lbs.ChecksumVerifier(m.fields['checksum'])
132 for block in m.data():
133 data = store.get(block)
134 verifier.update(data)
136 if int(m.fields['size']) != size:
137 raise ValueError("File size does not match!")
138 if not verifier.valid():
139 raise ValueError("Bad checksum found")
142 # Restore a snapshot, or some subset of files from it
143 def cmd_restore_snapshot(args):
145 lowlevel = lbs.LowlevelDataStore(options.store)
146 store = lbs.ObjectStore(lowlevel)
147 snapshot = lbs.parse_full(store.load_snapshot(args[0]))
152 print "Warning: %s: %s" % (m.items.name, msg)
154 for m in lbs.iterate_metadata(store, snapshot['Root']):
155 pathname = os.path.normpath(m.items.name)
156 while os.path.isabs(pathname):
157 pathname = pathname[1:]
159 destpath = os.path.join(destdir, pathname)
160 (path, filename) = os.path.split(destpath)
162 # TODO: Check for ../../../paths that might attempt to write outside
163 # the destination directory. Maybe also check attempts to follow
164 # symlinks pointing outside?
167 if not os.path.isdir(path):
170 if m.items.type == '-':
171 file = open(destpath, 'wb')
172 verifier = lbs.ChecksumVerifier(m.items.checksum)
174 for block in m.data():
175 data = store.get(block)
176 verifier.update(data)
180 if int(m.fields['size']) != size:
181 raise ValueError("File size does not match!")
182 if not verifier.valid():
183 raise ValueError("Bad checksum found")
184 elif m.items.type == 'd':
187 elif m.items.type == 'l':
188 os.symlink(m.items.contents, destpath)
189 elif m.items.type == 'p':
191 elif m.items.type in ('c', 'b'):
192 if m.items.type == 'c':
193 mode = 0600 | stat.S_IFCHR
195 mode = 0600 | stat.S_IFBLK
196 os.mknod(destpath, mode, os.makedev(*m.items.device))
197 elif m.items.type == 's':
198 pass # TODO: Implement
200 warn(m, "Unknown type code: " + m.items.type)
204 warn(m, "Error restoring: %s" % (e,))
208 uid = m.items.user[0]
209 gid = m.items.group[0]
210 os.lchown(destpath, uid, gid)
212 warn(m, "Error restoring file ownership: %s" % (e,))
214 if m.items.type == 'l':
218 os.chmod(destpath, m.items.mode)
220 warn(m, "Error restoring file permissions: %s" % (e,))
223 os.utime(destpath, (time.time(), m.items.mtime))
225 warn(m, "Error restoring file timestamps: %s" % (e,))
236 elif cmd == 'prune-db':
238 elif cmd == 'list-snapshots':
240 elif cmd == 'object-sums':
241 cmd_object_checksums(args)
242 elif cmd == 'read-snapshots':
243 cmd_read_snapshots(args)
244 elif cmd == 'read-metadata':
245 cmd_read_metadata(args[0])
246 elif cmd == 'list-snapshot-sizes':
247 cmd_list_snapshot_sizes()
248 elif cmd == 'verify-snapshots':
249 cmd_verify_snapshots(args)
250 elif cmd == 'restore-snapshot':
251 cmd_restore_snapshot(args)
253 print "Unknown command:", cmd