notes.c: use designated initializers for clarity
[git/debian.git] / builtin / tag.c
blobab5f5c74f437288797383ccd2aab199435f28266
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 "config.h"
11 #include "builtin.h"
12 #include "environment.h"
13 #include "gettext.h"
14 #include "hex.h"
15 #include "refs.h"
16 #include "object-store.h"
17 #include "tag.h"
18 #include "run-command.h"
19 #include "parse-options.h"
20 #include "diff.h"
21 #include "revision.h"
22 #include "gpg-interface.h"
23 #include "oid-array.h"
24 #include "column.h"
25 #include "ref-filter.h"
26 #include "date.h"
27 #include "write-or-die.h"
29 static const char * const git_tag_usage[] = {
30 N_("git tag [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] [-e]\n"
31 " <tagname> [<commit> | <object>]"),
32 N_("git tag -d <tagname>..."),
33 N_("git tag [-n[<num>]] -l [--contains <commit>] [--no-contains <commit>]\n"
34 " [--points-at <object>] [--column[=<options>] | --no-column]\n"
35 " [--create-reflog] [--sort=<key>] [--format=<format>]\n"
36 " [--merged <commit>] [--no-merged <commit>] [<pattern>...]"),
37 N_("git tag -v [--format=<format>] <tagname>..."),
38 NULL
41 static unsigned int colopts;
42 static int force_sign_annotate;
43 static int config_sign_tag = -1; /* unspecified */
44 static int omit_empty = 0;
46 static int list_tags(struct ref_filter *filter, struct ref_sorting *sorting,
47 struct ref_format *format)
49 struct ref_array array;
50 struct strbuf output = STRBUF_INIT;
51 struct strbuf err = STRBUF_INIT;
52 char *to_free = NULL;
53 int i;
55 memset(&array, 0, sizeof(array));
57 if (filter->lines == -1)
58 filter->lines = 0;
60 if (!format->format) {
61 if (filter->lines) {
62 to_free = xstrfmt("%s %%(contents:lines=%d)",
63 "%(align:15)%(refname:lstrip=2)%(end)",
64 filter->lines);
65 format->format = to_free;
66 } else
67 format->format = "%(refname:lstrip=2)";
70 if (verify_ref_format(format))
71 die(_("unable to parse format string"));
72 filter->with_commit_tag_algo = 1;
73 filter_refs(&array, filter, FILTER_REFS_TAGS);
74 filter_ahead_behind(the_repository, format, &array);
75 ref_array_sort(sorting, &array);
77 for (i = 0; i < array.nr; i++) {
78 strbuf_reset(&output);
79 strbuf_reset(&err);
80 if (format_ref_array_item(array.items[i], format, &output, &err))
81 die("%s", err.buf);
82 fwrite(output.buf, 1, output.len, stdout);
83 if (output.len || !omit_empty)
84 putchar('\n');
87 strbuf_release(&err);
88 strbuf_release(&output);
89 ref_array_clear(&array);
90 free(to_free);
92 return 0;
95 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
96 const struct object_id *oid, void *cb_data);
98 static int for_each_tag_name(const char **argv, each_tag_name_fn fn,
99 void *cb_data)
101 const char **p;
102 struct strbuf ref = STRBUF_INIT;
103 int had_error = 0;
104 struct object_id oid;
106 for (p = argv; *p; p++) {
107 strbuf_reset(&ref);
108 strbuf_addf(&ref, "refs/tags/%s", *p);
109 if (read_ref(ref.buf, &oid)) {
110 error(_("tag '%s' not found."), *p);
111 had_error = 1;
112 continue;
114 if (fn(*p, ref.buf, &oid, cb_data))
115 had_error = 1;
117 strbuf_release(&ref);
118 return had_error;
121 static int collect_tags(const char *name, const char *ref,
122 const struct object_id *oid, void *cb_data)
124 struct string_list *ref_list = cb_data;
126 string_list_append(ref_list, ref);
127 ref_list->items[ref_list->nr - 1].util = oiddup(oid);
128 return 0;
131 static int delete_tags(const char **argv)
133 int result;
134 struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
135 struct string_list_item *item;
137 result = for_each_tag_name(argv, collect_tags, (void *)&refs_to_delete);
138 if (delete_refs(NULL, &refs_to_delete, REF_NO_DEREF))
139 result = 1;
141 for_each_string_list_item(item, &refs_to_delete) {
142 const char *name = item->string;
143 struct object_id *oid = item->util;
144 if (!ref_exists(name))
145 printf(_("Deleted tag '%s' (was %s)\n"),
146 item->string + 10,
147 repo_find_unique_abbrev(the_repository, oid, DEFAULT_ABBREV));
149 free(oid);
151 string_list_clear(&refs_to_delete, 0);
152 return result;
155 static int verify_tag(const char *name, const char *ref,
156 const struct object_id *oid, void *cb_data)
158 int flags;
159 struct ref_format *format = cb_data;
160 flags = GPG_VERIFY_VERBOSE;
162 if (format->format)
163 flags = GPG_VERIFY_OMIT_STATUS;
165 if (gpg_verify_tag(oid, name, flags))
166 return -1;
168 if (format->format)
169 pretty_print_ref(name, oid, format);
171 return 0;
174 static int do_sign(struct strbuf *buffer)
176 return sign_buffer(buffer, buffer, get_signing_key());
179 static const char tag_template[] =
180 N_("\nWrite a message for tag:\n %s\n"
181 "Lines starting with '%c' will be ignored.\n");
183 static const char tag_template_nocleanup[] =
184 N_("\nWrite a message for tag:\n %s\n"
185 "Lines starting with '%c' will be kept; you may remove them"
186 " yourself if you want to.\n");
188 static int git_tag_config(const char *var, const char *value, void *cb)
190 if (!strcmp(var, "tag.gpgsign")) {
191 config_sign_tag = git_config_bool(var, value);
192 return 0;
195 if (!strcmp(var, "tag.sort")) {
196 if (!value)
197 return config_error_nonbool(var);
198 string_list_append(cb, value);
199 return 0;
202 if (!strcmp(var, "tag.forcesignannotated")) {
203 force_sign_annotate = git_config_bool(var, value);
204 return 0;
207 if (starts_with(var, "column."))
208 return git_column_config(var, value, "tag", &colopts);
209 return git_color_default_config(var, value, cb);
212 static void write_tag_body(int fd, const struct object_id *oid)
214 unsigned long size;
215 enum object_type type;
216 char *buf, *sp, *orig;
217 struct strbuf payload = STRBUF_INIT;
218 struct strbuf signature = STRBUF_INIT;
220 orig = buf = repo_read_object_file(the_repository, oid, &type, &size);
221 if (!buf)
222 return;
223 if (parse_signature(buf, size, &payload, &signature)) {
224 buf = payload.buf;
225 size = payload.len;
227 /* skip header */
228 sp = strstr(buf, "\n\n");
230 if (!sp || !size || type != OBJ_TAG) {
231 free(buf);
232 return;
234 sp += 2; /* skip the 2 LFs */
235 write_or_die(fd, sp, buf + size - sp);
237 free(orig);
238 strbuf_release(&payload);
239 strbuf_release(&signature);
242 static int build_tag_object(struct strbuf *buf, int sign, struct object_id *result)
244 if (sign && do_sign(buf) < 0)
245 return error(_("unable to sign the tag"));
246 if (write_object_file(buf->buf, buf->len, OBJ_TAG, result) < 0)
247 return error(_("unable to write tag file"));
248 return 0;
251 struct create_tag_options {
252 unsigned int message_given:1;
253 unsigned int use_editor:1;
254 unsigned int sign;
255 enum {
256 CLEANUP_NONE,
257 CLEANUP_SPACE,
258 CLEANUP_ALL
259 } cleanup_mode;
262 static const char message_advice_nested_tag[] =
263 N_("You have created a nested tag. The object referred to by your new tag is\n"
264 "already a tag. If you meant to tag the object that it points to, use:\n"
265 "\n"
266 "\tgit tag -f %s %s^{}");
268 static void create_tag(const struct object_id *object, const char *object_ref,
269 const char *tag,
270 struct strbuf *buf, struct create_tag_options *opt,
271 struct object_id *prev, struct object_id *result)
273 enum object_type type;
274 struct strbuf header = STRBUF_INIT;
275 char *path = NULL;
277 type = oid_object_info(the_repository, object, NULL);
278 if (type <= OBJ_NONE)
279 die(_("bad object type."));
281 if (type == OBJ_TAG)
282 advise_if_enabled(ADVICE_NESTED_TAG, _(message_advice_nested_tag),
283 tag, object_ref);
285 strbuf_addf(&header,
286 "object %s\n"
287 "type %s\n"
288 "tag %s\n"
289 "tagger %s\n\n",
290 oid_to_hex(object),
291 type_name(type),
292 tag,
293 git_committer_info(IDENT_STRICT));
295 if (!opt->message_given || opt->use_editor) {
296 int fd;
298 /* write the template message before editing: */
299 path = git_pathdup("TAG_EDITMSG");
300 fd = xopen(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
302 if (opt->message_given) {
303 write_or_die(fd, buf->buf, buf->len);
304 strbuf_reset(buf);
305 } else if (!is_null_oid(prev)) {
306 write_tag_body(fd, prev);
307 } else {
308 struct strbuf buf = STRBUF_INIT;
309 strbuf_addch(&buf, '\n');
310 if (opt->cleanup_mode == CLEANUP_ALL)
311 strbuf_commented_addf(&buf, _(tag_template), tag, comment_line_char);
312 else
313 strbuf_commented_addf(&buf, _(tag_template_nocleanup), tag, comment_line_char);
314 write_or_die(fd, buf.buf, buf.len);
315 strbuf_release(&buf);
317 close(fd);
319 if (launch_editor(path, buf, NULL)) {
320 fprintf(stderr,
321 _("Please supply the message using either -m or -F option.\n"));
322 exit(1);
326 if (opt->cleanup_mode != CLEANUP_NONE)
327 strbuf_stripspace(buf, opt->cleanup_mode == CLEANUP_ALL);
329 if (!opt->message_given && !buf->len)
330 die(_("no tag message?"));
332 strbuf_insert(buf, 0, header.buf, header.len);
333 strbuf_release(&header);
335 if (build_tag_object(buf, opt->sign, result) < 0) {
336 if (path)
337 fprintf(stderr, _("The tag message has been left in %s\n"),
338 path);
339 exit(128);
341 if (path) {
342 unlink_or_warn(path);
343 free(path);
347 static void create_reflog_msg(const struct object_id *oid, struct strbuf *sb)
349 enum object_type type;
350 struct commit *c;
351 char *buf;
352 unsigned long size;
353 int subject_len = 0;
354 const char *subject_start;
356 char *rla = getenv("GIT_REFLOG_ACTION");
357 if (rla) {
358 strbuf_addstr(sb, rla);
359 } else {
360 strbuf_addstr(sb, "tag: tagging ");
361 strbuf_add_unique_abbrev(sb, oid, DEFAULT_ABBREV);
364 strbuf_addstr(sb, " (");
365 type = oid_object_info(the_repository, oid, NULL);
366 switch (type) {
367 default:
368 strbuf_addstr(sb, "object of unknown type");
369 break;
370 case OBJ_COMMIT:
371 if ((buf = repo_read_object_file(the_repository, oid, &type, &size))) {
372 subject_len = find_commit_subject(buf, &subject_start);
373 strbuf_insert(sb, sb->len, subject_start, subject_len);
374 } else {
375 strbuf_addstr(sb, "commit object");
377 free(buf);
379 if ((c = lookup_commit_reference(the_repository, oid)))
380 strbuf_addf(sb, ", %s", show_date(c->date, 0, DATE_MODE(SHORT)));
381 break;
382 case OBJ_TREE:
383 strbuf_addstr(sb, "tree object");
384 break;
385 case OBJ_BLOB:
386 strbuf_addstr(sb, "blob object");
387 break;
388 case OBJ_TAG:
389 strbuf_addstr(sb, "other tag object");
390 break;
392 strbuf_addch(sb, ')');
395 struct msg_arg {
396 int given;
397 struct strbuf buf;
400 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
402 struct msg_arg *msg = opt->value;
404 BUG_ON_OPT_NEG(unset);
406 if (!arg)
407 return -1;
408 if (msg->buf.len)
409 strbuf_addstr(&(msg->buf), "\n\n");
410 strbuf_addstr(&(msg->buf), arg);
411 msg->given = 1;
412 return 0;
415 static int strbuf_check_tag_ref(struct strbuf *sb, const char *name)
417 if (name[0] == '-')
418 return -1;
420 strbuf_reset(sb);
421 strbuf_addf(sb, "refs/tags/%s", name);
423 return check_refname_format(sb->buf, 0);
426 int cmd_tag(int argc, const char **argv, const char *prefix)
428 struct strbuf buf = STRBUF_INIT;
429 struct strbuf ref = STRBUF_INIT;
430 struct strbuf reflog_msg = STRBUF_INIT;
431 struct object_id object, prev;
432 const char *object_ref, *tag;
433 struct create_tag_options opt;
434 char *cleanup_arg = NULL;
435 int create_reflog = 0;
436 int annotate = 0, force = 0;
437 int cmdmode = 0, create_tag_object = 0;
438 char *msgfile = NULL;
439 const char *keyid = NULL;
440 struct msg_arg msg = { .buf = STRBUF_INIT };
441 struct ref_transaction *transaction;
442 struct strbuf err = STRBUF_INIT;
443 struct ref_filter filter;
444 struct ref_sorting *sorting;
445 struct string_list sorting_options = STRING_LIST_INIT_DUP;
446 struct ref_format format = REF_FORMAT_INIT;
447 int icase = 0;
448 int edit_flag = 0;
449 struct option options[] = {
450 OPT_CMDMODE('l', "list", &cmdmode, N_("list tag names"), 'l'),
451 { OPTION_INTEGER, 'n', NULL, &filter.lines, N_("n"),
452 N_("print <n> lines of each tag message"),
453 PARSE_OPT_OPTARG, NULL, 1 },
454 OPT_CMDMODE('d', "delete", &cmdmode, N_("delete tags"), 'd'),
455 OPT_CMDMODE('v', "verify", &cmdmode, N_("verify tags"), 'v'),
457 OPT_GROUP(N_("Tag creation options")),
458 OPT_BOOL('a', "annotate", &annotate,
459 N_("annotated tag, needs a message")),
460 OPT_CALLBACK_F('m', "message", &msg, N_("message"),
461 N_("tag message"), PARSE_OPT_NONEG, parse_msg_arg),
462 OPT_FILENAME('F', "file", &msgfile, N_("read message from file")),
463 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of tag message")),
464 OPT_BOOL('s', "sign", &opt.sign, N_("annotated and GPG-signed tag")),
465 OPT_CLEANUP(&cleanup_arg),
466 OPT_STRING('u', "local-user", &keyid, N_("key-id"),
467 N_("use another key to sign the tag")),
468 OPT__FORCE(&force, N_("replace the tag if exists"), 0),
469 OPT_BOOL(0, "create-reflog", &create_reflog, N_("create a reflog")),
471 OPT_GROUP(N_("Tag listing options")),
472 OPT_COLUMN(0, "column", &colopts, N_("show tag list in columns")),
473 OPT_CONTAINS(&filter.with_commit, N_("print only tags that contain the commit")),
474 OPT_NO_CONTAINS(&filter.no_commit, N_("print only tags that don't contain the commit")),
475 OPT_WITH(&filter.with_commit, N_("print only tags that contain the commit")),
476 OPT_WITHOUT(&filter.no_commit, N_("print only tags that don't contain the commit")),
477 OPT_MERGED(&filter, N_("print only tags that are merged")),
478 OPT_NO_MERGED(&filter, N_("print only tags that are not merged")),
479 OPT_BOOL(0, "omit-empty", &omit_empty,
480 N_("do not output a newline after empty formatted refs")),
481 OPT_REF_SORT(&sorting_options),
483 OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
484 N_("print only tags of the object"), PARSE_OPT_LASTARG_DEFAULT,
485 parse_opt_object_name, (intptr_t) "HEAD"
487 OPT_STRING( 0 , "format", &format.format, N_("format"),
488 N_("format to use for the output")),
489 OPT__COLOR(&format.use_color, N_("respect format colors")),
490 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
491 OPT_END()
493 int ret = 0;
494 const char *only_in_list = NULL;
496 setup_ref_filter_porcelain_msg();
498 git_config(git_tag_config, &sorting_options);
500 memset(&opt, 0, sizeof(opt));
501 memset(&filter, 0, sizeof(filter));
502 filter.lines = -1;
503 opt.sign = -1;
505 argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
507 if (!cmdmode) {
508 if (argc == 0)
509 cmdmode = 'l';
510 else if (filter.with_commit || filter.no_commit ||
511 filter.reachable_from || filter.unreachable_from ||
512 filter.points_at.nr || filter.lines != -1)
513 cmdmode = 'l';
516 if (cmdmode == 'l')
517 setup_auto_pager("tag", 1);
519 if (opt.sign == -1)
520 opt.sign = cmdmode ? 0 : config_sign_tag > 0;
522 if (keyid) {
523 opt.sign = 1;
524 set_signing_key(keyid);
526 create_tag_object = (opt.sign || annotate || msg.given || msgfile);
528 if ((create_tag_object || force) && (cmdmode != 0))
529 usage_with_options(git_tag_usage, options);
531 finalize_colopts(&colopts, -1);
532 if (cmdmode == 'l' && filter.lines != -1) {
533 if (explicitly_enable_column(colopts))
534 die(_("options '%s' and '%s' cannot be used together"), "--column", "-n");
535 colopts = 0;
537 sorting = ref_sorting_options(&sorting_options);
538 ref_sorting_set_sort_flags_all(sorting, REF_SORTING_ICASE, icase);
539 filter.ignore_case = icase;
540 if (cmdmode == 'l') {
541 if (column_active(colopts)) {
542 struct column_options copts;
543 memset(&copts, 0, sizeof(copts));
544 copts.padding = 2;
545 run_column_filter(colopts, &copts);
547 filter.name_patterns = argv;
548 ret = list_tags(&filter, sorting, &format);
549 if (column_active(colopts))
550 stop_column_filter();
551 goto cleanup;
553 if (filter.lines != -1)
554 only_in_list = "-n";
555 else if (filter.with_commit)
556 only_in_list = "--contains";
557 else if (filter.no_commit)
558 only_in_list = "--no-contains";
559 else if (filter.points_at.nr)
560 only_in_list = "--points-at";
561 else if (filter.reachable_from)
562 only_in_list = "--merged";
563 else if (filter.unreachable_from)
564 only_in_list = "--no-merged";
565 if (only_in_list)
566 die(_("the '%s' option is only allowed in list mode"), only_in_list);
567 if (cmdmode == 'd') {
568 ret = delete_tags(argv);
569 goto cleanup;
571 if (cmdmode == 'v') {
572 if (format.format && verify_ref_format(&format))
573 usage_with_options(git_tag_usage, options);
574 ret = for_each_tag_name(argv, verify_tag, &format);
575 goto cleanup;
578 if (msg.given || msgfile) {
579 if (msg.given && msgfile)
580 die(_("options '%s' and '%s' cannot be used together"), "-F", "-m");
581 if (msg.given)
582 strbuf_addbuf(&buf, &(msg.buf));
583 else {
584 if (!strcmp(msgfile, "-")) {
585 if (strbuf_read(&buf, 0, 1024) < 0)
586 die_errno(_("cannot read '%s'"), msgfile);
587 } else {
588 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
589 die_errno(_("could not open or read '%s'"),
590 msgfile);
595 tag = argv[0];
597 object_ref = argc == 2 ? argv[1] : "HEAD";
598 if (argc > 2)
599 die(_("too many arguments"));
601 if (repo_get_oid(the_repository, object_ref, &object))
602 die(_("Failed to resolve '%s' as a valid ref."), object_ref);
604 if (strbuf_check_tag_ref(&ref, tag))
605 die(_("'%s' is not a valid tag name."), tag);
607 if (read_ref(ref.buf, &prev))
608 oidclr(&prev);
609 else if (!force)
610 die(_("tag '%s' already exists"), tag);
612 opt.message_given = msg.given || msgfile;
613 opt.use_editor = edit_flag;
615 if (!cleanup_arg || !strcmp(cleanup_arg, "strip"))
616 opt.cleanup_mode = CLEANUP_ALL;
617 else if (!strcmp(cleanup_arg, "verbatim"))
618 opt.cleanup_mode = CLEANUP_NONE;
619 else if (!strcmp(cleanup_arg, "whitespace"))
620 opt.cleanup_mode = CLEANUP_SPACE;
621 else
622 die(_("Invalid cleanup mode %s"), cleanup_arg);
624 create_reflog_msg(&object, &reflog_msg);
626 if (create_tag_object) {
627 if (force_sign_annotate && !annotate)
628 opt.sign = 1;
629 create_tag(&object, object_ref, tag, &buf, &opt, &prev, &object);
632 transaction = ref_transaction_begin(&err);
633 if (!transaction ||
634 ref_transaction_update(transaction, ref.buf, &object, &prev,
635 create_reflog ? REF_FORCE_CREATE_REFLOG : 0,
636 reflog_msg.buf, &err) ||
637 ref_transaction_commit(transaction, &err))
638 die("%s", err.buf);
639 ref_transaction_free(transaction);
640 if (force && !is_null_oid(&prev) && !oideq(&prev, &object))
641 printf(_("Updated tag '%s' (was %s)\n"), tag,
642 repo_find_unique_abbrev(the_repository, &prev, DEFAULT_ABBREV));
644 cleanup:
645 ref_sorting_release(sorting);
646 strbuf_release(&buf);
647 strbuf_release(&ref);
648 strbuf_release(&reflog_msg);
649 strbuf_release(&msg.buf);
650 strbuf_release(&err);
651 free(msgfile);
652 return ret;