builtin/tag.c

   1 /*
   2  * Builtin "git tag"
   3  *
   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  */
   8
   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"
  15 #include "diff.h"
  16 #include "revision.h"
  17 #include "gpg-interface.h"
  18 #include "sha1-array.h"
  19 #include "column.h"
  20 #include "ref-filter.h"
  21
  22 static const char * const git_tag_usage[] = {
  23         N_("git tag [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] <tagname> [<head>]"),
  24         N_("git tag -d <tagname>..."),
  25         N_("git tag -l [-n[<num>]] [--contains <commit>] [--points-at <object>]"
  26                 "\n\t\t[--format=<format>] [--[no-]merged [<commit>]] [<pattern>...]"),
  27         N_("git tag -v [--format=<format>] <tagname>..."),
  28         NULL
  29 };
  30
  31 static unsigned int colopts;
  32 static int force_sign_annotate;
  33
  34 static int list_tags(struct ref_filter *filter, struct ref_sorting *sorting, const char *format)
  35 {
  36         struct ref_array array;
  37         char *to_free = NULL;
  38         int i;
  39
  40         memset(&array, 0, sizeof(array));
  41
  42         if (filter->lines == -1)
  43                 filter->lines = 0;
  44
  45         if (!format) {
  46                 if (filter->lines) {
  47                         to_free = xstrfmt("%s %%(contents:lines=%d)",
  48                                           "%(align:15)%(refname:lstrip=2)%(end)",
  49                                           filter->lines);
  50                         format = to_free;
  51                 } else
  52                         format = "%(refname:lstrip=2)";
  53         }
  54
  55         verify_ref_format(format);
  56         filter->with_commit_tag_algo = 1;
  57         filter_refs(&array, filter, FILTER_REFS_TAGS);
  58         ref_array_sort(sorting, &array);
  59
  60         for (i = 0; i < array.nr; i++)
  61                 show_ref_array_item(array.items[i], format, 0);
  62         ref_array_clear(&array);
  63         free(to_free);
  64
  65         return 0;
  66 }
  67
  68 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
  69                                 const unsigned char *sha1, const void *cb_data);
  70
  71 static int for_each_tag_name(const char **argv, each_tag_name_fn fn,
  72                              const void *cb_data)
  73 {
  74         const char **p;
  75         char ref[PATH_MAX];
  76         int had_error = 0;
  77         unsigned char sha1[20];
  78
  79         for (p = argv; *p; p++) {
  80                 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
  81                                         >= sizeof(ref)) {
  82                         error(_("tag name too long: %.*s..."), 50, *p);
  83                         had_error = 1;
  84                         continue;
  85                 }
  86                 if (read_ref(ref, sha1)) {
  87                         error(_("tag '%s' not found."), *p);
  88                         had_error = 1;
  89                         continue;
  90                 }
  91                 if (fn(*p, ref, sha1, cb_data))
  92                         had_error = 1;
  93         }
  94         return had_error;
  95 }
  96
  97 static int delete_tag(const char *name, const char *ref,
  98                       const unsigned char *sha1, const void *cb_data)
  99 {
 100         if (delete_ref(NULL, ref, sha1, 0))
 101                 return 1;
 102         printf(_("Deleted tag '%s' (was %s)\n"), name, find_unique_abbrev(sha1, DEFAULT_ABBREV));
 103         return 0;
 104 }
 105
 106 static int verify_tag(const char *name, const char *ref,
 107                       const unsigned char *sha1, const void *cb_data)
 108 {
 109         int flags;
 110         const char *fmt_pretty = cb_data;
 111         flags = GPG_VERIFY_VERBOSE;
 112
 113         if (fmt_pretty)
 114                 flags = GPG_VERIFY_OMIT_STATUS;
 115
 116         if (gpg_verify_tag(sha1, name, flags))
 117                 return -1;
 118
 119         if (fmt_pretty)
 120                 pretty_print_ref(name, sha1, fmt_pretty);
 121
 122         return 0;
 123 }
 124
 125 static int do_sign(struct strbuf *buffer)
 126 {
 127         return sign_buffer(buffer, buffer, get_signing_key());
 128 }
 129
 130 static const char tag_template[] =
 131         N_("\nWrite a message for tag:\n  %s\n"
 132         "Lines starting with '%c' will be ignored.\n");
 133
 134 static const char tag_template_nocleanup[] =
 135         N_("\nWrite a message for tag:\n  %s\n"
 136         "Lines starting with '%c' will be kept; you may remove them"
 137         " yourself if you want to.\n");
 138
 139 /* Parse arg given and add it the ref_sorting array */
 140 static int parse_sorting_string(const char *arg, struct ref_sorting **sorting_tail)
 141 {
 142         struct ref_sorting *s;
 143         int len;
 144
 145         s = xcalloc(1, sizeof(*s));
 146         s->next = *sorting_tail;
 147         *sorting_tail = s;
 148
 149         if (*arg == '-') {
 150                 s->reverse = 1;
 151                 arg++;
 152         }
 153         if (skip_prefix(arg, "version:", &arg) ||
 154             skip_prefix(arg, "v:", &arg))
 155                 s->version = 1;
 156
 157         len = strlen(arg);
 158         s->atom = parse_ref_filter_atom(arg, arg+len);
 159
 160         return 0;
 161 }
 162
 163 static int git_tag_config(const char *var, const char *value, void *cb)
 164 {
 165         int status;
 166         struct ref_sorting **sorting_tail = (struct ref_sorting **)cb;
 167
 168         if (!strcmp(var, "tag.sort")) {
 169                 if (!value)
 170                         return config_error_nonbool(var);
 171                 parse_sorting_string(value, sorting_tail);
 172                 return 0;
 173         }
 174
 175         status = git_gpg_config(var, value, cb);
 176         if (status)
 177                 return status;
 178         if (!strcmp(var, "tag.forcesignannotated")) {
 179                 force_sign_annotate = git_config_bool(var, value);
 180                 return 0;
 181         }
 182
 183         if (starts_with(var, "column."))
 184                 return git_column_config(var, value, "tag", &colopts);
 185         return git_default_config(var, value, cb);
 186 }
 187
 188 static void write_tag_body(int fd, const unsigned char *sha1)
 189 {
 190         unsigned long size;
 191         enum object_type type;
 192         char *buf, *sp;
 193
 194         buf = read_sha1_file(sha1, &type, &size);
 195         if (!buf)
 196                 return;
 197         /* skip header */
 198         sp = strstr(buf, "\n\n");
 199
 200         if (!sp || !size || type != OBJ_TAG) {
 201                 free(buf);
 202                 return;
 203         }
 204         sp += 2; /* skip the 2 LFs */
 205         write_or_die(fd, sp, parse_signature(sp, buf + size - sp));
 206
 207         free(buf);
 208 }
 209
 210 static int build_tag_object(struct strbuf *buf, int sign, unsigned char *result)
 211 {
 212         if (sign && do_sign(buf) < 0)
 213                 return error(_("unable to sign the tag"));
 214         if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
 215                 return error(_("unable to write tag file"));
 216         return 0;
 217 }
 218
 219 struct create_tag_options {
 220         unsigned int message_given:1;
 221         unsigned int sign;
 222         enum {
 223                 CLEANUP_NONE,
 224                 CLEANUP_SPACE,
 225                 CLEANUP_ALL
 226         } cleanup_mode;
 227 };
 228
 229 static void create_tag(const unsigned char *object, const char *tag,
 230                        struct strbuf *buf, struct create_tag_options *opt,
 231                        unsigned char *prev, unsigned char *result)
 232 {
 233         enum object_type type;
 234         char header_buf[1024];
 235         int header_len;
 236         char *path = NULL;
 237
 238         type = sha1_object_info(object, NULL);
 239         if (type <= OBJ_NONE)
 240             die(_("bad object type."));
 241
 242         header_len = snprintf(header_buf, sizeof(header_buf),
 243                           "object %s\n"
 244                           "type %s\n"
 245                           "tag %s\n"
 246                           "tagger %s\n\n",
 247                           sha1_to_hex(object),
 248                           typename(type),
 249                           tag,
 250                           git_committer_info(IDENT_STRICT));
 251
 252         if (header_len > sizeof(header_buf) - 1)
 253                 die(_("tag header too big."));
 254
 255         if (!opt->message_given) {
 256                 int fd;
 257
 258                 /* write the template message before editing: */
 259                 path = git_pathdup("TAG_EDITMSG");
 260                 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
 261                 if (fd < 0)
 262                         die_errno(_("could not create file '%s'"), path);
 263
 264                 if (!is_null_sha1(prev)) {
 265                         write_tag_body(fd, prev);
 266                 } else {
 267                         struct strbuf buf = STRBUF_INIT;
 268                         strbuf_addch(&buf, '\n');
 269                         if (opt->cleanup_mode == CLEANUP_ALL)
 270                                 strbuf_commented_addf(&buf, _(tag_template), tag, comment_line_char);
 271                         else
 272                                 strbuf_commented_addf(&buf, _(tag_template_nocleanup), tag, comment_line_char);
 273                         write_or_die(fd, buf.buf, buf.len);
 274                         strbuf_release(&buf);
 275                 }
 276                 close(fd);
 277
 278                 if (launch_editor(path, buf, NULL)) {
 279                         fprintf(stderr,
 280                         _("Please supply the message using either -m or -F option.\n"));
 281                         exit(1);
 282                 }
 283         }
 284
 285         if (opt->cleanup_mode != CLEANUP_NONE)
 286                 strbuf_stripspace(buf, opt->cleanup_mode == CLEANUP_ALL);
 287
 288         if (!opt->message_given && !buf->len)
 289                 die(_("no tag message?"));
 290
 291         strbuf_insert(buf, 0, header_buf, header_len);
 292
 293         if (build_tag_object(buf, opt->sign, result) < 0) {
 294                 if (path)
 295                         fprintf(stderr, _("The tag message has been left in %s\n"),
 296                                 path);
 297                 exit(128);
 298         }
 299         if (path) {
 300                 unlink_or_warn(path);
 301                 free(path);
 302         }
 303 }
 304
 305 static void create_reflog_msg(const unsigned char *sha1, struct strbuf *sb)
 306 {
 307         enum object_type type;
 308         struct commit *c;
 309         char *buf;
 310         unsigned long size;
 311         int subject_len = 0;
 312         const char *subject_start;
 313
 314         char *rla = getenv("GIT_REFLOG_ACTION");
 315         if (rla) {
 316                 strbuf_addstr(sb, rla);
 317         } else {
 318                 strbuf_addstr(sb, _("tag: tagging "));
 319                 strbuf_add_unique_abbrev(sb, sha1, DEFAULT_ABBREV);
 320         }
 321
 322         strbuf_addstr(sb, " (");
 323         type = sha1_object_info(sha1, NULL);
 324         switch (type) {
 325         default:
 326                 strbuf_addstr(sb, _("object of unknown type"));
 327                 break;
 328         case OBJ_COMMIT:
 329                 if ((buf = read_sha1_file(sha1, &type, &size)) != NULL) {
 330                         subject_len = find_commit_subject(buf, &subject_start);
 331                         strbuf_insert(sb, sb->len, subject_start, subject_len);
 332                 } else {
 333                         strbuf_addstr(sb, _("commit object"));
 334                 }
 335                 free(buf);
 336
 337                 if ((c = lookup_commit_reference(sha1)) != NULL)
 338                         strbuf_addf(sb, ", %s", show_date(c->date, 0, DATE_MODE(SHORT)));
 339                 break;
 340         case OBJ_TREE:
 341                 strbuf_addstr(sb, _("tree object"));
 342                 break;
 343         case OBJ_BLOB:
 344                 strbuf_addstr(sb, _("blob object"));
 345                 break;
 346         case OBJ_TAG:
 347                 strbuf_addstr(sb, _("other tag object"));
 348                 break;
 349         }
 350         strbuf_addch(sb, ')');
 351 }
 352
 353 struct msg_arg {
 354         int given;
 355         struct strbuf buf;
 356 };
 357
 358 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
 359 {
 360         struct msg_arg *msg = opt->value;
 361
 362         if (!arg)
 363                 return -1;
 364         if (msg->buf.len)
 365                 strbuf_addstr(&(msg->buf), "\n\n");
 366         strbuf_addstr(&(msg->buf), arg);
 367         msg->given = 1;
 368         return 0;
 369 }
 370
 371 static int strbuf_check_tag_ref(struct strbuf *sb, const char *name)
 372 {
 373         if (name[0] == '-')
 374                 return -1;
 375
 376         strbuf_reset(sb);
 377         strbuf_addf(sb, "refs/tags/%s", name);
 378
 379         return check_refname_format(sb->buf, 0);
 380 }
 381
 382 int cmd_tag(int argc, const char **argv, const char *prefix)
 383 {
 384         struct strbuf buf = STRBUF_INIT;
 385         struct strbuf ref = STRBUF_INIT;
 386         struct strbuf reflog_msg = STRBUF_INIT;
 387         unsigned char object[20], prev[20];
 388         const char *object_ref, *tag;
 389         struct create_tag_options opt;
 390         char *cleanup_arg = NULL;
 391         int create_reflog = 0;
 392         int annotate = 0, force = 0;
 393         int cmdmode = 0, create_tag_object = 0;
 394         const char *msgfile = NULL, *keyid = NULL;
 395         struct msg_arg msg = { 0, STRBUF_INIT };
 396         struct ref_transaction *transaction;
 397         struct strbuf err = STRBUF_INIT;
 398         struct ref_filter filter;
 399         static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
 400         const char *format = NULL;
 401         int icase = 0;
 402         struct option options[] = {
 403                 OPT_CMDMODE('l', "list", &cmdmode, N_("list tag names"), 'l'),
 404                 { OPTION_INTEGER, 'n', NULL, &filter.lines, N_("n"),
 405                                 N_("print <n> lines of each tag message"),
 406                                 PARSE_OPT_OPTARG, NULL, 1 },
 407                 OPT_CMDMODE('d', "delete", &cmdmode, N_("delete tags"), 'd'),
 408                 OPT_CMDMODE('v', "verify", &cmdmode, N_("verify tags"), 'v'),
 409
 410                 OPT_GROUP(N_("Tag creation options")),
 411                 OPT_BOOL('a', "annotate", &annotate,
 412                                         N_("annotated tag, needs a message")),
 413                 OPT_CALLBACK('m', "message", &msg, N_("message"),
 414                              N_("tag message"), parse_msg_arg),
 415                 OPT_FILENAME('F', "file", &msgfile, N_("read message from file")),
 416                 OPT_BOOL('s', "sign", &opt.sign, N_("annotated and GPG-signed tag")),
 417                 OPT_STRING(0, "cleanup", &cleanup_arg, N_("mode"),
 418                         N_("how to strip spaces and #comments from message")),
 419                 OPT_STRING('u', "local-user", &keyid, N_("key-id"),
 420                                         N_("use another key to sign the tag")),
 421                 OPT__FORCE(&force, N_("replace the tag if exists")),
 422                 OPT_BOOL(0, "create-reflog", &create_reflog, N_("create a reflog")),
 423
 424                 OPT_GROUP(N_("Tag listing options")),
 425                 OPT_COLUMN(0, "column", &colopts, N_("show tag list in columns")),
 426                 OPT_CONTAINS(&filter.with_commit, N_("print only tags that contain the commit")),
 427                 OPT_WITH(&filter.with_commit, N_("print only tags that contain the commit")),
 428                 OPT_MERGED(&filter, N_("print only tags that are merged")),
 429                 OPT_NO_MERGED(&filter, N_("print only tags that are not merged")),
 430                 OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
 431                              N_("field name to sort on"), &parse_opt_ref_sorting),
 432                 {
 433                         OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
 434                         N_("print only tags of the object"), 0, parse_opt_object_name
 435                 },
 436                 OPT_STRING(  0 , "format", &format, N_("format"), N_("format to use for the output")),
 437                 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
 438                 OPT_END()
 439         };
 440
 441         setup_ref_filter_porcelain_msg();
 442
 443         git_config(git_tag_config, sorting_tail);
 444
 445         memset(&opt, 0, sizeof(opt));
 446         memset(&filter, 0, sizeof(filter));
 447         filter.lines = -1;
 448
 449         argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
 450
 451         if (keyid) {
 452                 opt.sign = 1;
 453                 set_signing_key(keyid);
 454         }
 455         create_tag_object = (opt.sign || annotate || msg.given || msgfile);
 456
 457         if (argc == 0 && !cmdmode)
 458                 cmdmode = 'l';
 459
 460         if ((create_tag_object || force) && (cmdmode != 0))
 461                 usage_with_options(git_tag_usage, options);
 462
 463         finalize_colopts(&colopts, -1);
 464         if (cmdmode == 'l' && filter.lines != -1) {
 465                 if (explicitly_enable_column(colopts))
 466                         die(_("--column and -n are incompatible"));
 467                 colopts = 0;
 468         }
 469         if (!sorting)
 470                 sorting = ref_default_sorting();
 471         sorting->ignore_case = icase;
 472         filter.ignore_case = icase;
 473         if (cmdmode == 'l') {
 474                 int ret;
 475                 if (column_active(colopts)) {
 476                         struct column_options copts;
 477                         memset(&copts, 0, sizeof(copts));
 478                         copts.padding = 2;
 479                         run_column_filter(colopts, &copts);
 480                 }
 481                 filter.name_patterns = argv;
 482                 ret = list_tags(&filter, sorting, format);
 483                 if (column_active(colopts))
 484                         stop_column_filter();
 485                 return ret;
 486         }
 487         if (filter.lines != -1)
 488                 die(_("-n option is only allowed with -l."));
 489         if (filter.with_commit)
 490                 die(_("--contains option is only allowed with -l."));
 491         if (filter.points_at.nr)
 492                 die(_("--points-at option is only allowed with -l."));
 493         if (filter.merge_commit)
 494                 die(_("--merged and --no-merged option are only allowed with -l"));
 495         if (cmdmode == 'd')
 496                 return for_each_tag_name(argv, delete_tag, NULL);
 497         if (cmdmode == 'v') {
 498                 if (format)
 499                         verify_ref_format(format);
 500                 return for_each_tag_name(argv, verify_tag, format);
 501         }
 502
 503         if (msg.given || msgfile) {
 504                 if (msg.given && msgfile)
 505                         die(_("only one -F or -m option is allowed."));
 506                 if (msg.given)
 507                         strbuf_addbuf(&buf, &(msg.buf));
 508                 else {
 509                         if (!strcmp(msgfile, "-")) {
 510                                 if (strbuf_read(&buf, 0, 1024) < 0)
 511                                         die_errno(_("cannot read '%s'"), msgfile);
 512                         } else {
 513                                 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
 514                                         die_errno(_("could not open or read '%s'"),
 515                                                 msgfile);
 516                         }
 517                 }
 518         }
 519
 520         tag = argv[0];
 521
 522         object_ref = argc == 2 ? argv[1] : "HEAD";
 523         if (argc > 2)
 524                 die(_("too many params"));
 525
 526         if (get_sha1(object_ref, object))
 527                 die(_("Failed to resolve '%s' as a valid ref."), object_ref);
 528
 529         if (strbuf_check_tag_ref(&ref, tag))
 530                 die(_("'%s' is not a valid tag name."), tag);
 531
 532         if (read_ref(ref.buf, prev))
 533                 hashclr(prev);
 534         else if (!force)
 535                 die(_("tag '%s' already exists"), tag);
 536
 537         opt.message_given = msg.given || msgfile;
 538
 539         if (!cleanup_arg || !strcmp(cleanup_arg, "strip"))
 540                 opt.cleanup_mode = CLEANUP_ALL;
 541         else if (!strcmp(cleanup_arg, "verbatim"))
 542                 opt.cleanup_mode = CLEANUP_NONE;
 543         else if (!strcmp(cleanup_arg, "whitespace"))
 544                 opt.cleanup_mode = CLEANUP_SPACE;
 545         else
 546                 die(_("Invalid cleanup mode %s"), cleanup_arg);
 547
 548         create_reflog_msg(object, &reflog_msg);
 549
 550         if (create_tag_object) {
 551                 if (force_sign_annotate && !annotate)
 552                         opt.sign = 1;
 553                 create_tag(object, tag, &buf, &opt, prev, object);
 554         }
 555
 556         transaction = ref_transaction_begin(&err);
 557         if (!transaction ||
 558             ref_transaction_update(transaction, ref.buf, object, prev,
 559                                    create_reflog ? REF_FORCE_CREATE_REFLOG : 0,
 560                                    reflog_msg.buf, &err) ||
 561             ref_transaction_commit(transaction, &err))
 562                 die("%s", err.buf);
 563         ref_transaction_free(transaction);
 564         if (force && !is_null_sha1(prev) && hashcmp(prev, object))
 565                 printf(_("Updated tag '%s' (was %s)\n"), tag, find_unique_abbrev(prev, DEFAULT_ABBREV));
 566
 567         strbuf_release(&err);
 568         strbuf_release(&buf);
 569         strbuf_release(&ref);
 570         strbuf_release(&reflog_msg);
 571         return 0;
 572 }