Merge branch 'master' of git://git.kernel.org/pub/scm/git/git
[git/jnareb-git.git] / builtin / tag.c
blobb66b34a1820b3c258ddd85180442df865becee15
1 /*
2 * Builtin "git tag"
4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>,
5 * Carlos Rica <jasampler@gmail.com>
6 * Based on git-tag.sh and mktag.c by Linus Torvalds.
7 */
9 #include "cache.h"
10 #include "builtin.h"
11 #include "refs.h"
12 #include "tag.h"
13 #include "run-command.h"
14 #include "parse-options.h"
16 static const char * const git_tag_usage[] = {
17 "git tag [-a|-s|-u <key-id>] [-f] [-m <msg>|-F <file>] <tagname> [<head>]",
18 "git tag -d <tagname>...",
19 "git tag -l [-n[<num>]] [<pattern>]",
20 "git tag -v <tagname>...",
21 NULL
24 static char signingkey[1000];
26 struct tag_filter {
27 const char *pattern;
28 int lines;
29 struct commit_list *with_commit;
32 static int show_reference(const char *refname, const unsigned char *sha1,
33 int flag, void *cb_data)
35 struct tag_filter *filter = cb_data;
37 if (!fnmatch(filter->pattern, refname, 0)) {
38 int i;
39 unsigned long size;
40 enum object_type type;
41 char *buf, *sp, *eol;
42 size_t len;
44 if (filter->with_commit) {
45 struct commit *commit;
47 commit = lookup_commit_reference_gently(sha1, 1);
48 if (!commit)
49 return 0;
50 if (!is_descendant_of(commit, filter->with_commit))
51 return 0;
54 if (!filter->lines) {
55 printf("%s\n", refname);
56 return 0;
58 printf("%-15s ", refname);
60 buf = read_sha1_file(sha1, &type, &size);
61 if (!buf || !size)
62 return 0;
64 /* skip header */
65 sp = strstr(buf, "\n\n");
66 if (!sp) {
67 free(buf);
68 return 0;
70 /* only take up to "lines" lines, and strip the signature */
71 size = parse_signature(buf, size);
72 for (i = 0, sp += 2;
73 i < filter->lines && sp < buf + size;
74 i++) {
75 if (i)
76 printf("\n ");
77 eol = memchr(sp, '\n', size - (sp - buf));
78 len = eol ? eol - sp : size - (sp - buf);
79 fwrite(sp, len, 1, stdout);
80 if (!eol)
81 break;
82 sp = eol + 1;
84 putchar('\n');
85 free(buf);
88 return 0;
91 static int list_tags(const char *pattern, int lines,
92 struct commit_list *with_commit)
94 struct tag_filter filter;
96 if (pattern == NULL)
97 pattern = "*";
99 filter.pattern = pattern;
100 filter.lines = lines;
101 filter.with_commit = with_commit;
103 for_each_tag_ref(show_reference, (void *) &filter);
105 return 0;
108 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
109 const unsigned char *sha1);
111 static int for_each_tag_name(const char **argv, each_tag_name_fn fn)
113 const char **p;
114 char ref[PATH_MAX];
115 int had_error = 0;
116 unsigned char sha1[20];
118 for (p = argv; *p; p++) {
119 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
120 >= sizeof(ref)) {
121 error(_("tag name too long: %.*s..."), 50, *p);
122 had_error = 1;
123 continue;
125 if (!resolve_ref(ref, sha1, 1, NULL)) {
126 error(_("tag '%s' not found."), *p);
127 had_error = 1;
128 continue;
130 if (fn(*p, ref, sha1))
131 had_error = 1;
133 return had_error;
136 static int delete_tag(const char *name, const char *ref,
137 const unsigned char *sha1)
139 if (delete_ref(ref, sha1, 0))
140 return 1;
141 printf(_("Deleted tag '%s' (was %s)\n"), name, find_unique_abbrev(sha1, DEFAULT_ABBREV));
142 return 0;
145 static int verify_tag(const char *name, const char *ref,
146 const unsigned char *sha1)
148 const char *argv_verify_tag[] = {"verify-tag",
149 "-v", "SHA1_HEX", NULL};
150 argv_verify_tag[2] = sha1_to_hex(sha1);
152 if (run_command_v_opt(argv_verify_tag, RUN_GIT_CMD))
153 return error(_("could not verify the tag '%s'"), name);
154 return 0;
157 static int do_sign(struct strbuf *buffer)
159 struct child_process gpg;
160 const char *args[4];
161 char *bracket;
162 int len;
163 int i, j;
165 if (!*signingkey) {
166 if (strlcpy(signingkey, git_committer_info(IDENT_ERROR_ON_NO_NAME),
167 sizeof(signingkey)) > sizeof(signingkey) - 1)
168 return error(_("committer info too long."));
169 bracket = strchr(signingkey, '>');
170 if (bracket)
171 bracket[1] = '\0';
174 /* When the username signingkey is bad, program could be terminated
175 * because gpg exits without reading and then write gets SIGPIPE. */
176 signal(SIGPIPE, SIG_IGN);
178 memset(&gpg, 0, sizeof(gpg));
179 gpg.argv = args;
180 gpg.in = -1;
181 gpg.out = -1;
182 args[0] = "gpg";
183 args[1] = "-bsau";
184 args[2] = signingkey;
185 args[3] = NULL;
187 if (start_command(&gpg))
188 return error(_("could not run gpg."));
190 if (write_in_full(gpg.in, buffer->buf, buffer->len) != buffer->len) {
191 close(gpg.in);
192 close(gpg.out);
193 finish_command(&gpg);
194 return error(_("gpg did not accept the tag data"));
196 close(gpg.in);
197 len = strbuf_read(buffer, gpg.out, 1024);
198 close(gpg.out);
200 if (finish_command(&gpg) || !len || len < 0)
201 return error(_("gpg failed to sign the tag"));
203 /* Strip CR from the line endings, in case we are on Windows. */
204 for (i = j = 0; i < buffer->len; i++)
205 if (buffer->buf[i] != '\r') {
206 if (i != j)
207 buffer->buf[j] = buffer->buf[i];
208 j++;
210 strbuf_setlen(buffer, j);
212 return 0;
215 static const char tag_template[] =
216 N_("\n"
217 "#\n"
218 "# Write a tag message\n"
219 "#\n");
221 static void set_signingkey(const char *value)
223 if (strlcpy(signingkey, value, sizeof(signingkey)) >= sizeof(signingkey))
224 die(_("signing key value too long (%.10s...)"), value);
227 static int git_tag_config(const char *var, const char *value, void *cb)
229 if (!strcmp(var, "user.signingkey")) {
230 if (!value)
231 return config_error_nonbool(var);
232 set_signingkey(value);
233 return 0;
236 return git_default_config(var, value, cb);
239 static void write_tag_body(int fd, const unsigned char *sha1)
241 unsigned long size;
242 enum object_type type;
243 char *buf, *sp;
245 buf = read_sha1_file(sha1, &type, &size);
246 if (!buf)
247 return;
248 /* skip header */
249 sp = strstr(buf, "\n\n");
251 if (!sp || !size || type != OBJ_TAG) {
252 free(buf);
253 return;
255 sp += 2; /* skip the 2 LFs */
256 write_or_die(fd, sp, parse_signature(sp, buf + size - sp));
258 free(buf);
261 static int build_tag_object(struct strbuf *buf, int sign, unsigned char *result)
263 if (sign && do_sign(buf) < 0)
264 return error(_("unable to sign the tag"));
265 if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
266 return error(_("unable to write tag file"));
267 return 0;
270 static void create_tag(const unsigned char *object, const char *tag,
271 struct strbuf *buf, int message, int sign,
272 unsigned char *prev, unsigned char *result)
274 enum object_type type;
275 char header_buf[1024];
276 int header_len;
277 char *path = NULL;
279 type = sha1_object_info(object, NULL);
280 if (type <= OBJ_NONE)
281 die(_("bad object type."));
283 header_len = snprintf(header_buf, sizeof(header_buf),
284 "object %s\n"
285 "type %s\n"
286 "tag %s\n"
287 "tagger %s\n\n",
288 sha1_to_hex(object),
289 typename(type),
290 tag,
291 git_committer_info(IDENT_ERROR_ON_NO_NAME));
293 if (header_len > sizeof(header_buf) - 1)
294 die(_("tag header too big."));
296 if (!message) {
297 int fd;
299 /* write the template message before editing: */
300 path = git_pathdup("TAG_EDITMSG");
301 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
302 if (fd < 0)
303 die_errno(_("could not create file '%s'"), path);
305 if (!is_null_sha1(prev))
306 write_tag_body(fd, prev);
307 else
308 write_or_die(fd, _(tag_template), strlen(_(tag_template)));
309 close(fd);
311 if (launch_editor(path, buf, NULL)) {
312 fprintf(stderr,
313 _("Please supply the message using either -m or -F option.\n"));
314 exit(1);
318 stripspace(buf, 1);
320 if (!message && !buf->len)
321 die(_("no tag message?"));
323 strbuf_insert(buf, 0, header_buf, header_len);
325 if (build_tag_object(buf, sign, result) < 0) {
326 if (path)
327 fprintf(stderr, _("The tag message has been left in %s\n"),
328 path);
329 exit(128);
331 if (path) {
332 unlink_or_warn(path);
333 free(path);
337 struct msg_arg {
338 int given;
339 struct strbuf buf;
342 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
344 struct msg_arg *msg = opt->value;
346 if (!arg)
347 return -1;
348 if (msg->buf.len)
349 strbuf_addstr(&(msg->buf), "\n\n");
350 strbuf_addstr(&(msg->buf), arg);
351 msg->given = 1;
352 return 0;
355 int cmd_tag(int argc, const char **argv, const char *prefix)
357 struct strbuf buf = STRBUF_INIT;
358 unsigned char object[20], prev[20];
359 char ref[PATH_MAX];
360 const char *object_ref, *tag;
361 struct ref_lock *lock;
363 int annotate = 0, sign = 0, force = 0, lines = -1,
364 list = 0, delete = 0, verify = 0;
365 const char *msgfile = NULL, *keyid = NULL;
366 struct msg_arg msg = { 0, STRBUF_INIT };
367 struct commit_list *with_commit = NULL;
368 struct option options[] = {
369 OPT_BOOLEAN('l', NULL, &list, "list tag names"),
370 { OPTION_INTEGER, 'n', NULL, &lines, "n",
371 "print <n> lines of each tag message",
372 PARSE_OPT_OPTARG, NULL, 1 },
373 OPT_BOOLEAN('d', NULL, &delete, "delete tags"),
374 OPT_BOOLEAN('v', NULL, &verify, "verify tags"),
376 OPT_GROUP("Tag creation options"),
377 OPT_BOOLEAN('a', NULL, &annotate,
378 "annotated tag, needs a message"),
379 OPT_CALLBACK('m', NULL, &msg, "message",
380 "tag message", parse_msg_arg),
381 OPT_FILENAME('F', NULL, &msgfile, "read message from file"),
382 OPT_BOOLEAN('s', NULL, &sign, "annotated and GPG-signed tag"),
383 OPT_STRING('u', NULL, &keyid, "key-id",
384 "use another key to sign the tag"),
385 OPT__FORCE(&force, "replace the tag if exists"),
387 OPT_GROUP("Tag listing options"),
389 OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
390 "print only tags that contain the commit",
391 PARSE_OPT_LASTARG_DEFAULT,
392 parse_opt_with_commit, (intptr_t)"HEAD",
394 OPT_END()
397 git_config(git_tag_config, NULL);
399 argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
401 if (keyid) {
402 sign = 1;
403 set_signingkey(keyid);
405 if (sign)
406 annotate = 1;
407 if (argc == 0 && !(delete || verify))
408 list = 1;
410 if ((annotate || msg.given || msgfile || force) &&
411 (list || delete || verify))
412 usage_with_options(git_tag_usage, options);
414 if (list + delete + verify > 1)
415 usage_with_options(git_tag_usage, options);
416 if (list)
417 return list_tags(argv[0], lines == -1 ? 0 : lines,
418 with_commit);
419 if (lines != -1)
420 die(_("-n option is only allowed with -l."));
421 if (with_commit)
422 die(_("--contains option is only allowed with -l."));
423 if (delete)
424 return for_each_tag_name(argv, delete_tag);
425 if (verify)
426 return for_each_tag_name(argv, verify_tag);
428 if (msg.given || msgfile) {
429 if (msg.given && msgfile)
430 die(_("only one -F or -m option is allowed."));
431 annotate = 1;
432 if (msg.given)
433 strbuf_addbuf(&buf, &(msg.buf));
434 else {
435 if (!strcmp(msgfile, "-")) {
436 if (strbuf_read(&buf, 0, 1024) < 0)
437 die_errno(_("cannot read '%s'"), msgfile);
438 } else {
439 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
440 die_errno(_("could not open or read '%s'"),
441 msgfile);
446 tag = argv[0];
448 object_ref = argc == 2 ? argv[1] : "HEAD";
449 if (argc > 2)
450 die(_("too many params"));
452 if (get_sha1(object_ref, object))
453 die(_("Failed to resolve '%s' as a valid ref."), object_ref);
455 if (snprintf(ref, sizeof(ref), "refs/tags/%s", tag) > sizeof(ref) - 1)
456 die(_("tag name too long: %.*s..."), 50, tag);
457 if (check_ref_format(ref))
458 die(_("'%s' is not a valid tag name."), tag);
460 if (!resolve_ref(ref, prev, 1, NULL))
461 hashclr(prev);
462 else if (!force)
463 die(_("tag '%s' already exists"), tag);
465 if (annotate)
466 create_tag(object, tag, &buf, msg.given || msgfile,
467 sign, prev, object);
469 lock = lock_any_ref_for_update(ref, prev, 0);
470 if (!lock)
471 die(_("%s: cannot lock the ref"), ref);
472 if (write_ref_sha1(lock, object, NULL) < 0)
473 die(_("%s: cannot update the ref"), ref);
474 if (force && hashcmp(prev, object))
475 printf(_("Updated tag '%s' (was %s)\n"), tag, find_unique_abbrev(prev, DEFAULT_ABBREV));
477 strbuf_release(&buf);
478 return 0;