2 import sys, stat, time, math
3 from bup import hashsplit, git, options, index, client, metadata, hlinkdb
4 from bup.helpers import *
5 from bup.hashsplit import GIT_MODE_TREE, GIT_MODE_FILE, GIT_MODE_SYMLINK
9 bup save [-tc] [-n name] <filenames...>
11 r,remote= hostname:/path/to/repo of remote repository
12 t,tree output a tree id
13 c,commit output a commit id
14 n,name= name of backup set to update (if any)
15 d,date= date for the commit (seconds since the epoch)
16 v,verbose increase log output (can be used more than once)
17 q,quiet don't show progress meter
18 smaller= only back up files smaller than n bytes
19 bwlimit= maximum bytes/sec to transmit to server
20 f,indexfile= the name of the index file (normally BUP_DIR/bupindex)
21 strip strips the path to every filename given
22 strip-path= path-prefix to be stripped when saving
23 graft= a graft point *old_path*=*new_path* (can be used more than once)
24 #,compress= set compression level to # (0-9, 9 is highest) [1]
26 o = options.Options(optspec)
27 (opt, flags, extra) = o.parse(sys.argv[1:])
29 git.check_repo_or_die()
30 if not (opt.tree or opt.commit or opt.name):
31 o.fatal("use one or more of -t, -c, -n")
33 o.fatal("no filenames given")
35 opt.progress = (istty2 and not opt.quiet)
36 opt.smaller = parse_num(opt.smaller or 0)
38 client.bwlimit = parse_num(opt.bwlimit)
41 date = parse_date_or_fatal(opt.date, o.fatal)
45 if opt.strip and opt.strip_path:
46 o.fatal("--strip is incompatible with --strip-path")
51 o.fatal("--strip is incompatible with --graft")
54 o.fatal("--strip-path is incompatible with --graft")
56 for (option, parameter) in flags:
57 if option == "--graft":
58 splitted_parameter = parameter.split('=')
59 if len(splitted_parameter) != 2:
60 o.fatal("a graft point must be of the form old_path=new_path")
61 old_path, new_path = splitted_parameter
62 if not (old_path and new_path):
63 o.fatal("a graft point cannot be empty")
64 graft_points.append((realpath(old_path), realpath(new_path)))
66 is_reverse = os.environ.get('BUP_SERVER_REVERSE')
67 if is_reverse and opt.remote:
68 o.fatal("don't use -r in reverse mode; it's automatic")
71 if opt.name.startswith('.'):
72 o.fatal('backup set names cannot start with "."')
74 o.fatal('backup set names cannot contain "/"')
75 refname = opt.name and 'refs/heads/%s' % opt.name or None
76 if opt.remote or is_reverse:
77 cli = client.Client(opt.remote)
78 oldref = refname and cli.read_ref(refname) or None
79 w = cli.new_packwriter()
82 oldref = refname and git.read_ref(refname) or None
83 w = git.PackWriter(compression_level=opt.compress)
95 # Metadata is stored in a file named .bupm in each directory. The
96 # first metadata entry will be the metadata for the current directory.
97 # The remaining entries will be for each of the other directory
98 # elements, in the order they're listed in the index.
100 # Since the git tree elements are sorted according to
101 # git.shalist_item_sort_key, the metalist items are accumulated as
102 # (sort_key, metadata) tuples, and then sorted when the .bupm file is
103 # created. The sort_key must be computed using the element's real
104 # name and mode rather than the git mode and (possibly mangled) name.
106 # Maintain a stack of information representing the current location in
107 # the archive being constructed. The current path is recorded in
108 # parts, which will be something like ['', 'home', 'someuser'], and
109 # the accumulated content and metadata for of the dirs in parts is
110 # stored in parallel stacks in shalists and metalists.
112 parts = [] # Current archive position (stack of dir names).
113 shalists = [] # Hashes for each dir in paths.
114 metalists = [] # Metadata for each dir in paths.
117 def _push(part, metadata):
118 # Enter a new archive directory -- make it the current directory.
121 metalists.append([('', metadata)]) # This dir's metadata (no name).
124 def _pop(force_tree, dir_metadata=None):
125 # Leave the current archive directory and add its tree to its parent.
126 assert(len(parts) >= 1)
128 shalist = shalists.pop()
129 metalist = metalists.pop()
130 if metalist and not force_tree:
131 if dir_metadata: # Override the original metadata pushed for this dir.
132 metalist = [('', dir_metadata)] + metalist[1:]
133 sorted_metalist = sorted(metalist, key = lambda x : x[0])
134 metadata = ''.join([m[1].encode() for m in sorted_metalist])
135 shalist.append((0100644, '.bupm', w.new_blob(metadata)))
136 tree = force_tree or w.new_tree(shalist)
138 shalists[-1].append((GIT_MODE_TREE,
139 git.mangle_name(part,
140 GIT_MODE_TREE, GIT_MODE_TREE),
146 def progress_report(n):
147 global count, subcount, lastremain
149 cc = count + subcount
150 pct = total and (cc*100.0/total) or 0
152 elapsed = now - tstart
153 kps = elapsed and int(cc/1024./elapsed)
154 kps_frac = 10 ** int(math.log(kps+1, 10) - 1)
155 kps = int(kps/kps_frac)*kps_frac
157 remain = elapsed*1.0/cc * (total-cc)
160 if (lastremain and (remain > lastremain)
161 and ((remain - lastremain)/lastremain < 0.05)):
165 hours = int(remain/60/60)
166 mins = int(remain/60 - hours*60)
167 secs = int(remain - hours*60*60 - mins*60)
172 kpsstr = '%dk/s' % kps
174 remainstr = '%dh%dm' % (hours, mins)
176 remainstr = '%dm%d' % (mins, secs)
178 remainstr = '%ds' % secs
179 qprogress('Saving: %.2f%% (%d/%dk, %d/%d files) %s %s\r'
180 % (pct, cc/1024, total/1024, fcount, ftotal,
184 indexfile = opt.indexfile or git.repo('bupindex')
185 r = index.Reader(indexfile)
186 if not os.access(indexfile + '.meta', os.W_OK|os.R_OK):
187 log('error: cannot access "%s"; have you run bup index?' % indexfile)
189 msr = index.MetaStoreReader(indexfile + '.meta')
190 hlink_db = hlinkdb.HLinkDB(indexfile + '.hlink')
192 def already_saved(ent):
193 return ent.is_valid() and w.exists(ent.sha) and ent.sha
195 def wantrecurse_pre(ent):
196 return not already_saved(ent)
198 def wantrecurse_during(ent):
199 return not already_saved(ent) or ent.sha_missing()
201 def find_hardlink_target(hlink_db, ent):
202 if hlink_db and not stat.S_ISDIR(ent.mode) and ent.nlink > 1:
203 link_paths = hlink_db.node_paths(ent.dev, ent.ino)
209 for (transname,ent) in r.filter(extra, wantrecurse=wantrecurse_pre):
210 if not (ftotal % 10024):
211 qprogress('Reading index: %d\r' % ftotal)
212 exists = ent.exists()
213 hashvalid = already_saved(ent)
214 ent.set_sha_missing(not hashvalid)
215 if not opt.smaller or ent.size < opt.smaller:
216 if exists and not hashvalid:
219 progress('Reading index: %d, done.\n' % ftotal)
220 hashsplit.progress_callback = progress_report
222 # Root collisions occur when strip or graft options map more than one
223 # path to the same directory (paths which originally had separate
224 # parents). When that situation is detected, use empty metadata for
225 # the parent. Otherwise, use the metadata for the common parent.
226 # Collision example: "bup save ... --strip /foo /foo/bar /bar".
228 # FIXME: Add collision tests, or handle collisions some other way.
230 # FIXME: Detect/handle strip/graft name collisions (other than root),
231 # i.e. if '/foo/bar' and '/bar' both map to '/'.
234 root_collision = None
236 count = subcount = fcount = 0
239 for (transname,ent) in r.filter(extra, wantrecurse=wantrecurse_during):
240 (dir, file) = os.path.split(ent.name)
241 exists = (ent.flags & index.IX_EXISTS)
242 hashvalid = already_saved(ent)
243 wasmissing = ent.sha_missing()
249 if ent.sha == index.EMPTY_SHA:
256 log('%s %-70s\n' % (status, ent.name))
257 elif not stat.S_ISDIR(ent.mode) and lastdir != dir:
258 if not lastdir.startswith(dir):
259 log('%s %-70s\n' % (status, os.path.join(dir, '')))
268 if opt.smaller and ent.size >= opt.smaller:
269 if exists and not hashvalid:
270 add_error('skipping large file "%s"' % ent.name)
271 lastskip_name = ent.name
274 assert(dir.startswith('/'))
276 dirp = stripped_path_components(dir, extra)
278 dirp = stripped_path_components(dir, [opt.strip_path])
280 dirp = grafted_path_components(graft_points, dir)
282 dirp = path_components(dir)
284 # At this point, dirp contains a representation of the archive
285 # path that looks like [(archive_dir_name, real_fs_path), ...].
286 # So given "bup save ... --strip /foo/bar /foo/bar/baz", dirp
287 # might look like this at some point:
288 # [('', '/foo/bar'), ('baz', '/foo/bar/baz'), ...].
290 # This dual representation supports stripping/grafting, where the
291 # archive path may not have a direct correspondence with the
292 # filesystem. The root directory is represented by an initial
293 # component named '', and any component that doesn't have a
294 # corresponding filesystem directory (due to grafting, for
295 # example) will have a real_fs_path of None, i.e. [('', None),
298 if first_root == None:
299 dir_name, fs_path = dirp[0]
301 # Not indexed, so just grab the FS metadata or use empty metadata.
303 meta = metadata.from_path(fs_path) if fs_path else metadata.Metadata()
304 except (OSError, IOError), e:
306 lastskip_name = dir_name
308 _push(dir_name, meta)
309 elif first_root != dirp[0]:
310 root_collision = True
312 # If switching to a new sub-tree, finish the current sub-tree.
313 while parts > [x[0] for x in dirp]:
314 _pop(force_tree = None)
316 # If switching to a new sub-tree, start a new sub-tree.
317 for path_component in dirp[len(parts):]:
318 dir_name, fs_path = path_component
319 # Not indexed, so just grab the FS metadata or use empty metadata.
321 meta = metadata.from_path(fs_path) if fs_path else metadata.Metadata()
322 except (OSError, IOError), e:
324 lastskip_name = dir_name
326 _push(dir_name, meta)
330 continue # We're at the top level -- keep the current root dir
331 # Since there's no filename, this is a subdir -- finish it.
332 oldtree = already_saved(ent) # may be None
333 newtree = _pop(force_tree = oldtree)
335 if lastskip_name and lastskip_name.startswith(ent.name):
338 ent.validate(GIT_MODE_TREE, newtree)
340 if exists and wasmissing:
344 # it's not a directory
348 git_name = git.mangle_name(file, ent.mode, ent.gitmode)
349 git_info = (ent.gitmode, git_name, id)
350 shalists[-1].append(git_info)
351 sort_key = git.shalist_item_sort_key((ent.mode, file, id))
352 meta = msr.metadata_at(ent.meta_ofs)
353 meta.hardlink_target = find_hardlink_target(hlink_db, ent)
354 # Restore the times that were cleared to 0 in the metastore.
355 (meta.atime, meta.mtime, meta.ctime) = (ent.atime, ent.mtime, ent.ctime)
356 metalists[-1].append((sort_key, meta))
358 if stat.S_ISREG(ent.mode):
360 f = hashsplit.open_noatime(ent.name)
361 except (IOError, OSError), e:
363 lastskip_name = ent.name
366 (mode, id) = hashsplit.split_to_blob_or_tree(
367 w.new_blob, w.new_tree, [f],
368 keep_boundaries=False)
369 except (IOError, OSError), e:
370 add_error('%s: %s' % (ent.name, e))
371 lastskip_name = ent.name
373 if stat.S_ISDIR(ent.mode):
374 assert(0) # handled above
375 elif stat.S_ISLNK(ent.mode):
377 rl = os.readlink(ent.name)
378 except (OSError, IOError), e:
380 lastskip_name = ent.name
382 (mode, id) = (GIT_MODE_SYMLINK, w.new_blob(rl))
384 # Everything else should be fully described by its
385 # metadata, so just record an empty blob, so the paths
386 # in the tree and .bupm will match up.
387 (mode, id) = (GIT_MODE_FILE, w.new_blob(""))
390 ent.validate(mode, id)
392 git_name = git.mangle_name(file, ent.mode, ent.gitmode)
393 git_info = (mode, git_name, id)
394 shalists[-1].append(git_info)
395 sort_key = git.shalist_item_sort_key((ent.mode, file, id))
396 hlink = find_hardlink_target(hlink_db, ent)
398 meta = metadata.from_path(ent.name, hardlink_target=hlink)
399 except (OSError, IOError), e:
401 lastskip_name = ent.name
403 metalists[-1].append((sort_key, meta))
405 if exists and wasmissing:
411 pct = total and count*100.0/total or 100
412 progress('Saving: %.2f%% (%d/%dk, %d/%d files), done. \n'
413 % (pct, count/1024, total/1024, fcount, ftotal))
415 while len(parts) > 1: # _pop() all the parts above the root
416 _pop(force_tree = None)
417 assert(len(shalists) == 1)
418 assert(len(metalists) == 1)
420 # Finish the root directory.
421 tree = _pop(force_tree = None,
422 # When there's a collision, use empty metadata for the root.
423 dir_metadata = metadata.Metadata() if root_collision else None)
426 print tree.encode('hex')
427 if opt.commit or opt.name:
428 msg = 'bup save\n\nGenerated by command:\n%r' % sys.argv
429 commit = w.new_commit(oldref, tree, date, msg)
431 print commit.encode('hex')
434 w.close() # must close before we can update the ref
438 cli.update_ref(refname, commit, oldref)
440 git.update_ref(refname, commit, oldref)
446 log('WARNING: %d errors encountered while saving.\n' % len(saved_errors))