-#!/usr/bin/env python
-"""Tag a commit in the bup repository.
-Creating a tag on a commit can be used for avoiding automatic cleanup from
-removing this commit due to old age.
+#!/bin/sh
+"""": # -*-python-*-
+bup_python="$(dirname "$0")/bup-python" || exit $?
+exec "$bup_python" "$0" ${1+"$@"}
"""
-import sys
-import os
+# end of bup preamble
+
+from __future__ import absolute_import
+from binascii import hexlify
+import os, sys
from bup import git, options
-from bup.helpers import *
+from bup.compat import argv_bytes
+from bup.helpers import debug1, handle_ctrl_c, log
+from bup.io import byte_stream, path_msg
+# FIXME: review for safe writes.
handle_ctrl_c()
optspec = """
bup tag
-bup tag <tag name> <commit>
-bup tag -d <tag name>
+bup tag [-f] <tag name> <commit>
+bup tag [-f] -d <tag name>
--
d,delete= Delete a tag
+f,force Overwrite existing tag, or ignore missing tag when deleting
"""
-o = options.Options('bup tag', optspec)
+o = options.Options(optspec)
(opt, flags, extra) = o.parse(sys.argv[1:])
git.check_repo_or_die()
-if opt.delete:
- tag_file = git.repo('refs/tags/%s' % opt.delete)
- debug1("tag file: %s\n" % tag_file)
- if not os.path.exists(tag_file):
- log("bup: error: tag '%s' not found." % opt.delete)
- sys.exit(1)
+tags = [t for sublist in git.tags().values() for t in sublist]
- try:
- os.unlink(tag_file)
- except OSError, e:
- log("bup: error: unable to delete tag '%s': %s" % (opt.delete, e))
+if opt.delete:
+ # git.delete_ref() doesn't complain if a ref doesn't exist. We
+ # could implement this verification but we'd need to read in the
+ # contents of the tag file and pass the hash, and we already know
+ # about the tag's existance via "tags".
+ tag_name = argv_bytes(opt.delete)
+ if not opt.force and tag_name not in tags:
+ log("error: tag '%s' doesn't exist\n" % path_msg(tag_name))
sys.exit(1)
-
+ tag_file = b'refs/tags/%s' % tag_name
+ git.delete_ref(tag_file)
sys.exit(0)
-tags = [t for sublist in git.tags().values() for t in sublist]
-
if not extra:
for t in tags:
- print t
+ sys.stdout.flush()
+ out = byte_stream(sys.stdout)
+ out.write(t)
+ out.write(b'\n')
sys.exit(0)
-elif len(extra) < 2:
- o.fatal('no commit ref or hash given.')
+elif len(extra) != 2:
+ o.fatal('expected commit ref and hash')
-(tag_name, commit) = extra[:2]
+tag_name, commit = map(argv_bytes, extra[:2])
if not tag_name:
o.fatal("tag name must not be empty.")
-debug1("args: tag name = %s; commit = %s\n" % (tag_name, commit))
+debug1("args: tag name = %s; commit = %s\n"
+ % (path_msg(tag_name), commit.decode('ascii')))
-if tag_name in tags:
- log("bup: error: tag '%s' already exists" % tag_name)
+if tag_name in tags and not opt.force:
+ log("bup: error: tag '%s' already exists\n" % path_msg(tag_name))
sys.exit(1)
+if tag_name.startswith(b'.'):
+ o.fatal("'%s' is not a valid tag name." % path_msg(tag_name))
+
try:
hash = git.rev_parse(commit)
-except git.GitError, e:
+except git.GitError as e:
log("bup: error: %s" % e)
sys.exit(2)
if not hash:
- log("bup: error: commit %s not found." % commit)
+ log("bup: error: commit %s not found.\n" % commit.decode('ascii'))
sys.exit(2)
-pL = git.PackIdxList(git.repo('objects/pack'))
+pL = git.PackIdxList(git.repo(b'objects/pack'))
if not pL.exists(hash):
- log("bup: error: commit %s not found." % commit)
+ log("bup: error: commit %s not found.\n" % commit.decode('ascii'))
sys.exit(2)
-tag_file = git.repo('refs/tags/%s' % tag_name)
+tag_file = git.repo(b'refs/tags/' + tag_name)
try:
- tag = file(tag_file, 'w')
-except OSError, e:
- log("bup: error: could not create tag '%s': %s" % (tag_name, e))
+ tag = open(tag_file, 'wb')
+except OSError as e:
+ log("bup: error: could not create tag '%s': %s" % (path_msg(tag_name), e))
sys.exit(3)
-
-tag.write(hash.encode('hex'))
-tag.close()
+with tag as tag:
+ tag.write(hexlify(hash))
+ tag.write(b'\n')