2 from __future__ import absolute_import, print_function
3 from binascii import hexlify, unhexlify
4 from collections import namedtuple
5 from stat import S_ISDIR
6 import os, sys, textwrap, time
8 from bup import compat, git, client, vfs
9 from bup.compat import (
16 from bup.git import get_cat_data, parse_commit, walk_object
17 from bup.helpers import add_error, debug1, log, saved_errors
18 from bup.helpers import hostname, tty_width
19 from bup.io import path_msg
20 from bup.pwdgrp import userfullname, username
21 from bup.repo import LocalRepo, RemoteRepo
24 "usage: bup get [-s source] [-r remote] (<--ff|--append|...> REF [DEST])...",
26 """Transfer data from a source repository to a destination repository
27 according to the methods specified (--ff, --ff:, --append, etc.).
28 Both repositories default to BUP_DIR. A remote destination may be
29 specified with -r, and data may be pulled from a remote repository
30 with the related "bup on HOST get ..." command.""",
32 ('optional arguments:',
33 (('-h, --help', 'show this help message and exit'),
35 'increase log output (can be specified more than once)'),
36 ('-q, --quiet', "don't show progress meter"),
37 ('-s SOURCE, --source SOURCE',
38 'path to the source repository (defaults to BUP_DIR)'),
39 ('-r REMOTE, --remote REMOTE',
40 'hostname:/path/to/repo of remote destination repository'),
41 ('-t --print-trees', 'output a tree id for each ref set'),
42 ('-c, --print-commits', 'output a commit id for each ref set'),
43 ('--print-tags', 'output an id for each tag'),
44 ('--bwlimit BWLIMIT', 'maximum bytes/sec to transmit to server'),
45 ('-0, -1, -2, -3, -4, -5, -6, -7, -8, -9, --compress LEVEL',
46 'set compression LEVEL (default: 1)'))),
49 (('--ff REF, --ff: REF DEST',
50 'fast-forward dest REF (or DEST) to match source REF'),
51 ('--append REF, --append: REF DEST',
52 'append REF (treeish or committish) to dest REF (or DEST)'),
53 ('--pick REF, --pick: REF DEST',
54 'append single source REF commit to dest REF (or DEST)'),
55 ('--force-pick REF, --force-pick: REF DEST',
56 '--pick, overwriting REF (or DEST)'),
57 ('--new-tag REF, --new-tag: REF DEST',
58 'tag source ref REF as REF (or DEST) in dest unless it already exists'),
59 ('--replace, --replace: REF DEST',
60 'overwrite REF (or DEST) in dest with source REF'),
62 'fetch REF anonymously (without destination ref)'))))
64 def render_opts(opts, width=None):
68 for args, desc in opts:
69 result.append(textwrap.fill(args, width=width,
70 initial_indent=(' ' * 2),
71 subsequent_indent=(' ' * 4)))
73 result.append(textwrap.fill(desc, width=width,
74 initial_indent=(' ' * 6),
75 subsequent_indent=(' ' * 6)))
79 def usage(argspec, width=None):
82 usage, preamble, groups = argspec[0], argspec[1], argspec[2:]
84 msg.append(textwrap.fill(usage, width=width, subsequent_indent=' '))
86 msg.append(textwrap.fill(preamble.replace('\n', ' '), width=width))
88 for group_name, group_args in groups:
89 msg.extend(['\n', group_name, '\n'])
90 msg.extend(render_opts(group_args, width=width))
93 def misuse(message=None):
94 sys.stderr.write(usage(argspec))
96 sys.stderr.write('\nerror: ')
97 sys.stderr.write(message)
98 sys.stderr.write('\n')
101 def require_n_args_or_die(n, args):
102 if len(args) < n + 1:
103 misuse('%s argument requires %d %s'
104 % (n, 'values' if n == 1 else 'value'))
105 result = args[1:1+n], args[1+n:]
106 assert len(result[0]) == n
109 Spec = namedtuple('Spec', ('method', 'src', 'dest'))
113 return '--%s %s' % (s.method, path_msg(s.src))
114 return '--%s: %s %s' % (s.method, path_msg(s.src), path_msg(s.dest))
116 def parse_args(args):
123 opt.print_commits = opt.print_trees = opt.print_tags = False
126 opt.source = opt.remote = None
127 opt.target_specs = []
129 remaining = args[1:] # Skip argv[0]
132 if arg in (b'-h', b'--help'):
133 sys.stdout.write(usage(argspec))
135 elif arg in (b'-v', b'--verbose'):
137 remaining = remaining[1:]
138 elif arg in (b'--ff', b'--append', b'--pick', b'--force-pick',
139 b'--new-tag', b'--replace', b'--unnamed'):
140 (ref,), remaining = require_n_args_or_die(1, remaining)
141 opt.target_specs.append(Spec(method=arg[2:].decode('ascii'),
143 elif arg in (b'--ff:', b'--append:', b'--pick:', b'--force-pick:',
144 b'--new-tag:', b'--replace:'):
145 (ref, dest), remaining = require_n_args_or_die(2, remaining)
146 opt.target_specs.append(Spec(method=arg[2:-1].decode('ascii'),
148 elif arg in (b'-s', b'--source'):
149 (opt.source,), remaining = require_n_args_or_die(1, remaining)
150 elif arg in (b'-r', b'--remote'):
151 (opt.remote,), remaining = require_n_args_or_die(1, remaining)
152 elif arg in (b'-c', b'--print-commits'):
153 opt.print_commits, remaining = True, remaining[1:]
154 elif arg in (b'-t', b'--print-trees'):
155 opt.print_trees, remaining = True, remaining[1:]
156 elif arg == b'--print-tags':
157 opt.print_tags, remaining = True, remaining[1:]
158 elif arg in (b'-0', b'-1', b'-2', b'-3', b'-4', b'-5', b'-6', b'-7',
160 opt.compress = int(arg[1:])
161 remaining = remaining[1:]
162 elif arg == b'--compress':
163 (opt.compress,), remaining = require_n_args_or_die(1, remaining)
164 opt.compress = int(opt.compress)
165 elif arg == b'--bwlimit':
166 (opt.bwlimit,), remaining = require_n_args_or_die(1, remaining)
167 opt.bwlimit = long(opt.bwlimit)
168 elif arg.startswith(b'-') and len(arg) > 2 and arg[1] != b'-':
169 # Try to interpret this as -xyz, i.e. "-xyz -> -x -y -z".
170 # We do this last so that --foo -bar is valid if --foo
172 remaining[0:1] = (b'-' + bytes_from_byte(c) for c in arg[1:])
179 # FIXME: client error handling (remote exceptions, etc.)
181 # FIXME: walk_object in in git.py doesn't support opt.verbose. Do we
182 # need to adjust for that here?
183 def get_random_item(name, hash, repo, writer, opt):
184 def already_seen(oid):
185 return writer.exists(unhexlify(oid))
186 for item in walk_object(repo.cat, hash, stop_at=already_seen,
188 # already_seen ensures that writer.exists(id) is false.
189 # Otherwise, just_write() would fail.
190 writer.just_write(item.oid, item.type, item.data)
193 def append_commit(name, hash, parent, src_repo, writer, opt):
195 items = parse_commit(get_cat_data(src_repo.cat(hash), b'commit'))
196 tree = unhexlify(items.tree)
197 author = b'%s <%s>' % (items.author_name, items.author_mail)
198 author_time = (items.author_sec, items.author_offset)
199 committer = b'%s <%s@%s>' % (userfullname(), username(), hostname())
200 get_random_item(name, hexlify(tree), src_repo, writer, opt)
201 c = writer.new_commit(tree, parent,
202 author, items.author_sec, items.author_offset,
203 committer, now, None,
208 def append_commits(commits, src_name, dest_hash, src_repo, writer, opt):
209 last_c, tree = dest_hash, None
210 for commit in commits:
211 last_c, tree = append_commit(src_name, commit, last_c,
212 src_repo, writer, opt)
213 assert(tree is not None)
216 Loc = namedtuple('Loc', ['type', 'hash', 'path'])
217 default_loc = Loc(None, None, None)
219 def find_vfs_item(name, repo):
220 res = repo.resolve(name, follow=False, want_meta=False)
221 leaf_name, leaf_item = res[-1]
224 kind = type(leaf_item)
227 elif kind == vfs.Tags:
229 elif kind == vfs.RevList:
231 elif kind == vfs.Commit:
232 if len(res) > 1 and type(res[-2][1]) == vfs.RevList:
236 elif kind == vfs.Item:
237 if S_ISDIR(vfs.item_mode(leaf_item)):
241 elif kind == vfs.Chunky:
243 elif kind == vfs.FakeLink:
244 # Don't have to worry about ELOOP, excepting malicious
245 # remotes, since "latest" is the only FakeLink.
246 assert leaf_name == b'latest'
247 res = repo.resolve(leaf_item.target, parent=res[:-1],
248 follow=False, want_meta=False)
249 leaf_name, leaf_item = res[-1]
251 assert type(leaf_item) == vfs.Commit
252 name = b'/'.join(x[0] for x in res)
255 raise Exception('unexpected resolution for %s: %r'
256 % (path_msg(name), res))
257 path = b'/'.join(name for name, item in res)
258 if hasattr(leaf_item, 'coid'):
259 result = Loc(type=kind, hash=leaf_item.coid, path=path)
260 elif hasattr(leaf_item, 'oid'):
261 result = Loc(type=kind, hash=leaf_item.oid, path=path)
263 result = Loc(type=kind, hash=None, path=path)
267 Target = namedtuple('Target', ['spec', 'src', 'dest'])
271 loc = loc._replace(hash=hexlify(loc.hash))
275 # FIXME: see if resolve() means we can drop the vfs path cleanup
277 def cleanup_vfs_path(p):
278 result = os.path.normpath(p)
279 if result.startswith(b'/'):
284 def validate_vfs_path(p):
285 if p.startswith(b'/.') \
286 and not p.startswith(b'/.tag/'):
287 misuse('unsupported destination path %s in %s'
288 % (path_msg(dest.path), spec_msg(spec)))
292 def resolve_src(spec, src_repo):
293 src = find_vfs_item(spec.src, src_repo)
294 spec_args = spec_msg(spec)
296 misuse('cannot find source for %s' % spec_args)
297 if src.type == 'root':
298 misuse('cannot fetch entire repository for %s' % spec_args)
299 if src.type == 'tags':
300 misuse('cannot fetch entire /.tag directory for %s' % spec_args)
301 debug1('src: %s\n' % loc_desc(src))
305 def get_save_branch(repo, path):
306 res = repo.resolve(path, follow=False, want_meta=False)
307 leaf_name, leaf_item = res[-1]
309 misuse('error: cannot access %r in %r' % (leaf_name, path))
311 res_path = b'/'.join(name for name, item in res[:-1])
315 def resolve_branch_dest(spec, src, src_repo, dest_repo):
316 # Resulting dest must be treeish, or not exist.
318 # Pick a default dest.
319 if src.type == 'branch':
320 spec = spec._replace(dest=spec.src)
321 elif src.type == 'save':
322 spec = spec._replace(dest=get_save_branch(src_repo, spec.src))
323 elif src.path.startswith(b'/.tag/'): # Dest defaults to the same.
324 spec = spec._replace(dest=spec.src)
326 spec_args = spec_msg(spec)
328 misuse('no destination (implicit or explicit) for %s', spec_args)
330 dest = find_vfs_item(spec.dest, dest_repo)
332 if dest.type == 'commit':
333 misuse('destination for %s is a tagged commit, not a branch'
335 if dest.type != 'branch':
336 misuse('destination for %s is a %s, not a branch'
337 % (spec_args, dest.type))
339 dest = default_loc._replace(path=cleanup_vfs_path(spec.dest))
341 if dest.path.startswith(b'/.'):
342 misuse('destination for %s must be a valid branch name' % spec_args)
344 debug1('dest: %s\n' % loc_desc(dest))
348 def resolve_ff(spec, src_repo, dest_repo):
349 src = resolve_src(spec, src_repo)
350 spec_args = spec_msg(spec)
351 if src.type == 'tree':
352 misuse('%s is impossible; can only --append a tree to a branch'
354 if src.type not in ('branch', 'save', 'commit'):
355 misuse('source for %s must be a branch, save, or commit, not %s'
356 % (spec_args, src.type))
357 spec, dest = resolve_branch_dest(spec, src, src_repo, dest_repo)
358 return Target(spec=spec, src=src, dest=dest)
361 def handle_ff(item, src_repo, writer, opt):
362 assert item.spec.method == 'ff'
363 assert item.src.type in ('branch', 'save', 'commit')
364 src_oidx = hexlify(item.src.hash)
365 dest_oidx = hexlify(item.dest.hash) if item.dest.hash else None
366 if not dest_oidx or dest_oidx in src_repo.rev_list(src_oidx):
368 get_random_item(item.spec.src, src_oidx, src_repo, writer, opt)
369 commit_items = parse_commit(get_cat_data(src_repo.cat(src_oidx), b'commit'))
370 return item.src.hash, unhexlify(commit_items.tree)
371 misuse('destination is not an ancestor of source for %s'
372 % spec_msg(item.spec))
375 def resolve_append(spec, src_repo, dest_repo):
376 src = resolve_src(spec, src_repo)
377 if src.type not in ('branch', 'save', 'commit', 'tree'):
378 misuse('source for %s must be a branch, save, commit, or tree, not %s'
379 % (spec_msg(spec), src.type))
380 spec, dest = resolve_branch_dest(spec, src, src_repo, dest_repo)
381 return Target(spec=spec, src=src, dest=dest)
384 def handle_append(item, src_repo, writer, opt):
385 assert item.spec.method == 'append'
386 assert item.src.type in ('branch', 'save', 'commit', 'tree')
387 assert item.dest.type == 'branch' or not item.dest.type
388 src_oidx = hexlify(item.src.hash)
389 if item.src.type == 'tree':
390 get_random_item(item.spec.src, src_oidx, src_repo, writer, opt)
391 parent = item.dest.hash
392 msg = b'bup save\n\nGenerated by command:\n%r\n' % compat.get_argvb()
393 userline = b'%s <%s@%s>' % (userfullname(), username(), hostname())
395 commit = writer.new_commit(item.src.hash, parent,
397 userline, now, None, msg)
398 return commit, item.src.hash
399 commits = list(src_repo.rev_list(src_oidx))
401 return append_commits(commits, item.spec.src, item.dest.hash,
402 src_repo, writer, opt)
405 def resolve_pick(spec, src_repo, dest_repo):
406 src = resolve_src(spec, src_repo)
407 spec_args = spec_msg(spec)
408 if src.type == 'tree':
409 misuse('%s is impossible; can only --append a tree' % spec_args)
410 if src.type not in ('commit', 'save'):
411 misuse('%s impossible; can only pick a commit or save, not %s'
412 % (spec_args, src.type))
414 if src.path.startswith(b'/.tag/'):
415 spec = spec._replace(dest=spec.src)
416 elif src.type == 'save':
417 spec = spec._replace(dest=get_save_branch(src_repo, spec.src))
419 misuse('no destination provided for %s', spec_args)
420 dest = find_vfs_item(spec.dest, dest_repo)
422 cp = validate_vfs_path(cleanup_vfs_path(spec.dest))
423 dest = default_loc._replace(path=cp)
425 if not dest.type == 'branch' and not dest.path.startswith(b'/.tag/'):
426 misuse('%s destination is not a tag or branch' % spec_args)
427 if spec.method == 'pick' \
428 and dest.hash and dest.path.startswith(b'/.tag/'):
429 misuse('cannot overwrite existing tag for %s (requires --force-pick)'
431 return Target(spec=spec, src=src, dest=dest)
434 def handle_pick(item, src_repo, writer, opt):
435 assert item.spec.method in ('pick', 'force-pick')
436 assert item.src.type in ('save', 'commit')
437 src_oidx = hexlify(item.src.hash)
439 return append_commit(item.spec.src, src_oidx, item.dest.hash,
440 src_repo, writer, opt)
441 return append_commit(item.spec.src, src_oidx, None, src_repo, writer, opt)
444 def resolve_new_tag(spec, src_repo, dest_repo):
445 src = resolve_src(spec, src_repo)
446 spec_args = spec_msg(spec)
447 if not spec.dest and src.path.startswith(b'/.tag/'):
448 spec = spec._replace(dest=src.path)
450 misuse('no destination (implicit or explicit) for %s', spec_args)
451 dest = find_vfs_item(spec.dest, dest_repo)
453 dest = default_loc._replace(path=cleanup_vfs_path(spec.dest))
454 if not dest.path.startswith(b'/.tag/'):
455 misuse('destination for %s must be a VFS tag' % spec_args)
457 misuse('cannot overwrite existing tag for %s (requires --replace)'
459 return Target(spec=spec, src=src, dest=dest)
462 def handle_new_tag(item, src_repo, writer, opt):
463 assert item.spec.method == 'new-tag'
464 assert item.dest.path.startswith(b'/.tag/')
465 get_random_item(item.spec.src, hexlify(item.src.hash),
466 src_repo, writer, opt)
467 return (item.src.hash,)
470 def resolve_replace(spec, src_repo, dest_repo):
471 src = resolve_src(spec, src_repo)
472 spec_args = spec_msg(spec)
474 if src.path.startswith(b'/.tag/') or src.type == 'branch':
475 spec = spec._replace(dest=spec.src)
477 misuse('no destination provided for %s', spec_args)
478 dest = find_vfs_item(spec.dest, dest_repo)
480 if not dest.type == 'branch' and not dest.path.startswith(b'/.tag/'):
481 misuse('%s impossible; can only overwrite branch or tag'
484 cp = validate_vfs_path(cleanup_vfs_path(spec.dest))
485 dest = default_loc._replace(path=cp)
486 if not dest.path.startswith(b'/.tag/') \
487 and not src.type in ('branch', 'save', 'commit'):
488 misuse('cannot overwrite branch with %s for %s' % (src.type, spec_args))
489 return Target(spec=spec, src=src, dest=dest)
492 def handle_replace(item, src_repo, writer, opt):
493 assert(item.spec.method == 'replace')
494 if item.dest.path.startswith(b'/.tag/'):
495 get_random_item(item.spec.src, hexlify(item.src.hash),
496 src_repo, writer, opt)
497 return (item.src.hash,)
498 assert(item.dest.type == 'branch' or not item.dest.type)
499 src_oidx = hexlify(item.src.hash)
500 get_random_item(item.spec.src, src_oidx, src_repo, writer, opt)
501 commit_items = parse_commit(get_cat_data(src_repo.cat(src_oidx), b'commit'))
502 return item.src.hash, unhexlify(commit_items.tree)
505 def resolve_unnamed(spec, src_repo, dest_repo):
507 misuse('destination name given for %s' % spec_msg(spec))
508 src = resolve_src(spec, src_repo)
509 return Target(spec=spec, src=src, dest=None)
512 def handle_unnamed(item, src_repo, writer, opt):
513 get_random_item(item.spec.src, hexlify(item.src.hash),
514 src_repo, writer, opt)
518 def resolve_targets(specs, src_repo, dest_repo):
520 common_args = src_repo, dest_repo
522 debug1('initial-spec: %r\n' % (spec,))
523 if spec.method == 'ff':
524 resolved_items.append(resolve_ff(spec, *common_args))
525 elif spec.method == 'append':
526 resolved_items.append(resolve_append(spec, *common_args))
527 elif spec.method in ('pick', 'force-pick'):
528 resolved_items.append(resolve_pick(spec, *common_args))
529 elif spec.method == 'new-tag':
530 resolved_items.append(resolve_new_tag(spec, *common_args))
531 elif spec.method == 'replace':
532 resolved_items.append(resolve_replace(spec, *common_args))
533 elif spec.method == 'unnamed':
534 resolved_items.append(resolve_unnamed(spec, *common_args))
535 else: # Should be impossible -- prevented by the option parser.
538 # FIXME: check for prefix overlap? i.e.:
539 # bup get --ff foo --ff: baz foo/bar
540 # bup get --new-tag .tag/foo --new-tag: bar .tag/foo/bar
542 # Now that we have all the items, check for duplicate tags.
543 tags_targeted = set()
544 for item in resolved_items:
545 dest_path = item.dest and item.dest.path
547 assert(dest_path.startswith(b'/'))
548 if dest_path.startswith(b'/.tag/'):
549 if dest_path in tags_targeted:
550 if item.spec.method not in ('replace', 'force-pick'):
551 misuse('cannot overwrite tag %s via %s' \
552 % (path_msg(dest_path), spec_msg(item.spec)))
554 tags_targeted.add(dest_path)
555 return resolved_items
558 def log_item(name, type, opt, tree=None, commit=None, tag=None):
559 if tag and opt.print_tags:
561 if tree and opt.print_trees:
563 if commit and opt.print_commits:
564 print(hexstr(commit))
567 if type in ('root', 'branch', 'save', 'commit', 'tree'):
568 if not name.endswith(b'/'):
570 log('%s%s\n' % (path_msg(name), last))
573 is_reverse = environ.get(b'BUP_SERVER_REVERSE')
574 opt = parse_args(argv)
575 git.check_repo_or_die()
577 opt.source = argv_bytes(opt.source)
579 client.bwlimit = parse_num(opt.bwlimit)
580 if is_reverse and opt.remote:
581 misuse("don't use -r in reverse mode; it's automatic")
582 if opt.remote or is_reverse:
583 dest_repo = RemoteRepo(opt.remote)
585 dest_repo = LocalRepo()
587 with dest_repo as dest_repo:
588 with LocalRepo(repo_dir=opt.source) as src_repo:
589 with dest_repo.new_packwriter(compression_level=opt.compress) as writer:
590 # Resolve and validate all sources and destinations,
591 # implicit or explicit, and do it up-front, so we can
592 # fail before we start writing (for any obviously
594 target_items = resolve_targets(opt.target_specs,
597 updated_refs = {} # ref_name -> (original_ref, tip_commit(bin))
598 no_ref_info = (None, None)
600 handlers = {'ff': handle_ff,
601 'append': handle_append,
602 'force-pick': handle_pick,
604 'new-tag': handle_new_tag,
605 'replace': handle_replace,
606 'unnamed': handle_unnamed}
608 for item in target_items:
609 debug1('get-spec: %r\n' % (item.spec,))
610 debug1('get-src: %s\n' % loc_desc(item.src))
611 debug1('get-dest: %s\n' % loc_desc(item.dest))
612 dest_path = item.dest and item.dest.path
614 if dest_path.startswith(b'/.tag/'):
615 dest_ref = b'refs/tags/%s' % dest_path[6:]
617 dest_ref = b'refs/heads/%s' % dest_path[1:]
621 dest_hash = item.dest and item.dest.hash
622 orig_ref, cur_ref = updated_refs.get(dest_ref, no_ref_info)
623 orig_ref = orig_ref or dest_hash
624 cur_ref = cur_ref or dest_hash
626 handler = handlers[item.spec.method]
627 item_result = handler(item, src_repo, writer, opt)
628 if len(item_result) > 1:
629 new_id, tree = item_result
631 new_id = item_result[0]
634 log_item(item.spec.src, item.src.type, opt)
636 updated_refs[dest_ref] = (orig_ref, new_id)
637 if dest_ref.startswith(b'refs/tags/'):
638 log_item(item.spec.src, item.src.type, opt, tag=new_id)
640 log_item(item.spec.src, item.src.type, opt,
641 tree=tree, commit=new_id)
643 # Only update the refs at the very end, once the writer is
644 # closed, so that if something goes wrong above, the old refs
645 # will be undisturbed.
646 for ref_name, info in items(updated_refs):
647 orig_ref, new_ref = info
649 dest_repo.update_ref(ref_name, new_ref, orig_ref)
651 new_hex = hexlify(new_ref)
653 orig_hex = hexlify(orig_ref)
654 log('updated %r (%s -> %s)\n' % (ref_name, orig_hex, new_hex))
656 log('updated %r (%s)\n' % (ref_name, new_hex))
657 except (git.GitError, client.ClientError) as ex:
658 add_error('unable to update ref %r: %s' % (ref_name, ex))
661 log('WARNING: %d errors encountered while saving.\n' % len(saved_errors))