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
  18 static const char * const git_tag_usage[] = {
  19         "git tag [-a|-s|-u <key-id>] [-f] [-m <msg>|-F <file>] <tagname> [<head>]",
  20         "git tag -d <tagname>...",
  21         "git tag -l [-n[<num>]] [<pattern>...]",
  22         "git tag -v <tagname>...",
  23         NULL
  24 };
  25
  26 static char signingkey[1000];
  27
  28 struct tag_filter {
  29         const char **patterns;
  30         int lines;
  31         struct commit_list *with_commit;
  32 };
  33
  34 static int match_pattern(const char **patterns, const char *ref)
  35 {
  36         /* no pattern means match everything */
  37         if (!*patterns)
  38                 return 1;
  39         for (; *patterns; patterns++)
  40                 if (!fnmatch(*patterns, ref, 0))
  41                         return 1;
  42         return 0;
  43 }
  44
  45 static int in_commit_list(const struct commit_list *want, struct commit *c)
  46 {
  47         for (; want; want = want->next)
  48                 if (!hashcmp(want->item->object.sha1, c->object.sha1))
  49                         return 1;
  50         return 0;
  51 }
  52
  53 static int contains_recurse(struct commit *candidate,
  54                             const struct commit_list *want)
  55 {
  56         struct commit_list *p;
  57
  58         /* was it previously marked as containing a want commit? */
  59         if (candidate->object.flags & TMP_MARK)
  60                 return 1;
  61         /* or marked as not possibly containing a want commit? */
  62         if (candidate->object.flags & UNINTERESTING)
  63                 return 0;
  64         /* or are we it? */
  65         if (in_commit_list(want, candidate))
  66                 return 1;
  67
  68         if (parse_commit(candidate) < 0)
  69                 return 0;
  70
  71         /* Otherwise recurse and mark ourselves for future traversals. */
  72         for (p = candidate->parents; p; p = p->next) {
  73                 if (contains_recurse(p->item, want)) {
  74                         candidate->object.flags |= TMP_MARK;
  75                         return 1;
  76                 }
  77         }
  78         candidate->object.flags |= UNINTERESTING;
  79         return 0;
  80 }
  81
  82 static int contains(struct commit *candidate, const struct commit_list *want)
  83 {
  84         return contains_recurse(candidate, want);
  85 }
  86
  87 static void show_tag_lines(const unsigned char *sha1, int lines)
  88 {
  89         int i;
  90         unsigned long size;
  91         enum object_type type;
  92         char *buf, *sp, *eol;
  93         size_t len;
  94
  95         buf = read_sha1_file(sha1, &type, &size);
  96         if (!buf)
  97                 die_errno("unable to read object %s", sha1_to_hex(sha1));
  98         if (!size) {
  99                 free(buf);
 100                 return;
 101         }
 102
 103         /* skip header */
 104         sp = strstr(buf, "\n\n");
 105         if (!sp) {
 106                 free(buf);
 107                 return;
 108         }
 109         /* only take up to "lines" lines, and strip the signature */
 110         size = parse_signature(buf, size);
 111         for (i = 0, sp += 2; i < lines && sp < buf + size; i++) {
 112                 if (i)
 113                         printf("\n    ");
 114                 eol = memchr(sp, '\n', size - (sp - buf));
 115                 len = eol ? eol - sp : size - (sp - buf);
 116                 fwrite(sp, len, 1, stdout);
 117                 if (!eol)
 118                         break;
 119                 sp = eol + 1;
 120         }
 121         free(buf);
 122 }
 123
 124 static int show_reference(const char *refname, const unsigned char *sha1,
 125                           int flag, void *cb_data)
 126 {
 127         struct tag_filter *filter = cb_data;
 128
 129         if (match_pattern(filter->patterns, refname)) {
 130                 if (filter->with_commit) {
 131                         struct commit *commit;
 132
 133                         commit = lookup_commit_reference_gently(sha1, 1);
 134                         if (!commit)
 135                                 return 0;
 136                         if (!contains(commit, filter->with_commit))
 137                                 return 0;
 138                 }
 139
 140                 if (!filter->lines) {
 141                         printf("%s\n", refname);
 142                         return 0;
 143                 }
 144                 printf("%-15s ", refname);
 145                 show_tag_lines(sha1, filter->lines);
 146                 putchar('\n');
 147         }
 148
 149         return 0;
 150 }
 151
 152 static int list_tags(const char **patterns, int lines,
 153                         struct commit_list *with_commit)
 154 {
 155         struct tag_filter filter;
 156
 157         filter.patterns = patterns;
 158         filter.lines = lines;
 159         filter.with_commit = with_commit;
 160
 161         for_each_tag_ref(show_reference, (void *) &filter);
 162
 163         return 0;
 164 }
 165
 166 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
 167                                 const unsigned char *sha1);
 168
 169 static int for_each_tag_name(const char **argv, each_tag_name_fn fn)
 170 {
 171         const char **p;
 172         char ref[PATH_MAX];
 173         int had_error = 0;
 174         unsigned char sha1[20];
 175
 176         for (p = argv; *p; p++) {
 177                 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
 178                                         >= sizeof(ref)) {
 179                         error(_("tag name too long: %.*s..."), 50, *p);
 180                         had_error = 1;
 181                         continue;
 182                 }
 183                 if (!resolve_ref(ref, sha1, 1, NULL)) {
 184                         error(_("tag '%s' not found."), *p);
 185                         had_error = 1;
 186                         continue;
 187                 }
 188                 if (fn(*p, ref, sha1))
 189                         had_error = 1;
 190         }
 191         return had_error;
 192 }
 193
 194 static int delete_tag(const char *name, const char *ref,
 195                                 const unsigned char *sha1)
 196 {
 197         if (delete_ref(ref, sha1, 0))
 198                 return 1;
 199         printf(_("Deleted tag '%s' (was %s)\n"), name, find_unique_abbrev(sha1, DEFAULT_ABBREV));
 200         return 0;
 201 }
 202
 203 static int verify_tag(const char *name, const char *ref,
 204                                 const unsigned char *sha1)
 205 {
 206         const char *argv_verify_tag[] = {"verify-tag",
 207                                         "-v", "SHA1_HEX", NULL};
 208         argv_verify_tag[2] = sha1_to_hex(sha1);
 209
 210         if (run_command_v_opt(argv_verify_tag, RUN_GIT_CMD))
 211                 return error(_("could not verify the tag '%s'"), name);
 212         return 0;
 213 }
 214
 215 static int do_sign(struct strbuf *buffer)
 216 {
 217         struct child_process gpg;
 218         const char *args[4];
 219         char *bracket;
 220         int len;
 221         int i, j;
 222
 223         if (!*signingkey) {
 224                 if (strlcpy(signingkey, git_committer_info(IDENT_ERROR_ON_NO_NAME),
 225                                 sizeof(signingkey)) > sizeof(signingkey) - 1)
 226                         return error(_("committer info too long."));
 227                 bracket = strchr(signingkey, '>');
 228                 if (bracket)
 229                         bracket[1] = '\0';
 230         }
 231
 232         /* When the username signingkey is bad, program could be terminated
 233          * because gpg exits without reading and then write gets SIGPIPE. */
 234         signal(SIGPIPE, SIG_IGN);
 235
 236         memset(&gpg, 0, sizeof(gpg));
 237         gpg.argv = args;
 238         gpg.in = -1;
 239         gpg.out = -1;
 240         args[0] = "gpg";
 241         args[1] = "-bsau";
 242         args[2] = signingkey;
 243         args[3] = NULL;
 244
 245         if (start_command(&gpg))
 246                 return error(_("could not run gpg."));
 247
 248         if (write_in_full(gpg.in, buffer->buf, buffer->len) != buffer->len) {
 249                 close(gpg.in);
 250                 close(gpg.out);
 251                 finish_command(&gpg);
 252                 return error(_("gpg did not accept the tag data"));
 253         }
 254         close(gpg.in);
 255         len = strbuf_read(buffer, gpg.out, 1024);
 256         close(gpg.out);
 257
 258         if (finish_command(&gpg) || !len || len < 0)
 259                 return error(_("gpg failed to sign the tag"));
 260
 261         /* Strip CR from the line endings, in case we are on Windows. */
 262         for (i = j = 0; i < buffer->len; i++)
 263                 if (buffer->buf[i] != '\r') {
 264                         if (i != j)
 265                                 buffer->buf[j] = buffer->buf[i];
 266                         j++;
 267                 }
 268         strbuf_setlen(buffer, j);
 269
 270         return 0;
 271 }
 272
 273 static const char tag_template[] =
 274         N_("\n"
 275         "#\n"
 276         "# Write a tag message\n"
 277         "#\n");
 278
 279 static void set_signingkey(const char *value)
 280 {
 281         if (strlcpy(signingkey, value, sizeof(signingkey)) >= sizeof(signingkey))
 282                 die(_("signing key value too long (%.10s...)"), value);
 283 }
 284
 285 static int git_tag_config(const char *var, const char *value, void *cb)
 286 {
 287         if (!strcmp(var, "user.signingkey")) {
 288                 if (!value)
 289                         return config_error_nonbool(var);
 290                 set_signingkey(value);
 291                 return 0;
 292         }
 293
 294         return git_default_config(var, value, cb);
 295 }
 296
 297 static void write_tag_body(int fd, const unsigned char *sha1)
 298 {
 299         unsigned long size;
 300         enum object_type type;
 301         char *buf, *sp;
 302
 303         buf = read_sha1_file(sha1, &type, &size);
 304         if (!buf)
 305                 return;
 306         /* skip header */
 307         sp = strstr(buf, "\n\n");
 308
 309         if (!sp || !size || type != OBJ_TAG) {
 310                 free(buf);
 311                 return;
 312         }
 313         sp += 2; /* skip the 2 LFs */
 314         write_or_die(fd, sp, parse_signature(sp, buf + size - sp));
 315
 316         free(buf);
 317 }
 318
 319 static int build_tag_object(struct strbuf *buf, int sign, unsigned char *result)
 320 {
 321         if (sign && do_sign(buf) < 0)
 322                 return error(_("unable to sign the tag"));
 323         if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
 324                 return error(_("unable to write tag file"));
 325         return 0;
 326 }
 327
 328 static void create_tag(const unsigned char *object, const char *tag,
 329                        struct strbuf *buf, int message, int sign,
 330                        unsigned char *prev, unsigned char *result)
 331 {
 332         enum object_type type;
 333         char header_buf[1024];
 334         int header_len;
 335         char *path = NULL;
 336
 337         type = sha1_object_info(object, NULL);
 338         if (type <= OBJ_NONE)
 339             die(_("bad object type."));
 340
 341         header_len = snprintf(header_buf, sizeof(header_buf),
 342                           "object %s\n"
 343                           "type %s\n"
 344                           "tag %s\n"
 345                           "tagger %s\n\n",
 346                           sha1_to_hex(object),
 347                           typename(type),
 348                           tag,
 349                           git_committer_info(IDENT_ERROR_ON_NO_NAME));
 350
 351         if (header_len > sizeof(header_buf) - 1)
 352                 die(_("tag header too big."));
 353
 354         if (!message) {
 355                 int fd;
 356
 357                 /* write the template message before editing: */
 358                 path = git_pathdup("TAG_EDITMSG");
 359                 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
 360                 if (fd < 0)
 361                         die_errno(_("could not create file '%s'"), path);
 362
 363                 if (!is_null_sha1(prev))
 364                         write_tag_body(fd, prev);
 365                 else
 366                         write_or_die(fd, _(tag_template), strlen(_(tag_template)));
 367                 close(fd);
 368
 369                 if (launch_editor(path, buf, NULL)) {
 370                         fprintf(stderr,
 371                         _("Please supply the message using either -m or -F option.\n"));
 372                         exit(1);
 373                 }
 374         }
 375
 376         stripspace(buf, 1);
 377
 378         if (!message && !buf->len)
 379                 die(_("no tag message?"));
 380
 381         strbuf_insert(buf, 0, header_buf, header_len);
 382
 383         if (build_tag_object(buf, sign, result) < 0) {
 384                 if (path)
 385                         fprintf(stderr, _("The tag message has been left in %s\n"),
 386                                 path);
 387                 exit(128);
 388         }
 389         if (path) {
 390                 unlink_or_warn(path);
 391                 free(path);
 392         }
 393 }
 394
 395 struct msg_arg {
 396         int given;
 397         struct strbuf buf;
 398 };
 399
 400 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
 401 {
 402         struct msg_arg *msg = opt->value;
 403
 404         if (!arg)
 405                 return -1;
 406         if (msg->buf.len)
 407                 strbuf_addstr(&(msg->buf), "\n\n");
 408         strbuf_addstr(&(msg->buf), arg);
 409         msg->given = 1;
 410         return 0;
 411 }
 412
 413 static int strbuf_check_tag_ref(struct strbuf *sb, const char *name)
 414 {
 415         if (name[0] == '-')
 416                 return CHECK_REF_FORMAT_ERROR;
 417
 418         strbuf_reset(sb);
 419         strbuf_addf(sb, "refs/tags/%s", name);
 420
 421         return check_ref_format(sb->buf);
 422 }
 423
 424 int cmd_tag(int argc, const char **argv, const char *prefix)
 425 {
 426         struct strbuf buf = STRBUF_INIT;
 427         struct strbuf ref = STRBUF_INIT;
 428         unsigned char object[20], prev[20];
 429         const char *object_ref, *tag;
 430         struct ref_lock *lock;
 431
 432         int annotate = 0, sign = 0, force = 0, lines = -1,
 433                 list = 0, delete = 0, verify = 0;
 434         const char *msgfile = NULL, *keyid = NULL;
 435         struct msg_arg msg = { 0, STRBUF_INIT };
 436         struct commit_list *with_commit = NULL;
 437         struct option options[] = {
 438                 OPT_BOOLEAN('l', NULL, &list, "list tag names"),
 439                 { OPTION_INTEGER, 'n', NULL, &lines, "n",
 440                                 "print <n> lines of each tag message",
 441                                 PARSE_OPT_OPTARG, NULL, 1 },
 442                 OPT_BOOLEAN('d', NULL, &delete, "delete tags"),
 443                 OPT_BOOLEAN('v', NULL, &verify, "verify tags"),
 444
 445                 OPT_GROUP("Tag creation options"),
 446                 OPT_BOOLEAN('a', NULL, &annotate,
 447                                         "annotated tag, needs a message"),
 448                 OPT_CALLBACK('m', NULL, &msg, "message",
 449                              "tag message", parse_msg_arg),
 450                 OPT_FILENAME('F', NULL, &msgfile, "read message from file"),
 451                 OPT_BOOLEAN('s', NULL, &sign, "annotated and GPG-signed tag"),
 452                 OPT_STRING('u', NULL, &keyid, "key-id",
 453                                         "use another key to sign the tag"),
 454                 OPT__FORCE(&force, "replace the tag if exists"),
 455
 456                 OPT_GROUP("Tag listing options"),
 457                 {
 458                         OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
 459                         "print only tags that contain the commit",
 460                         PARSE_OPT_LASTARG_DEFAULT,
 461                         parse_opt_with_commit, (intptr_t)"HEAD",
 462                 },
 463                 OPT_END()
 464         };
 465
 466         git_config(git_tag_config, NULL);
 467
 468         argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
 469
 470         if (keyid) {
 471                 sign = 1;
 472                 set_signingkey(keyid);
 473         }
 474         if (sign)
 475                 annotate = 1;
 476         if (argc == 0 && !(delete || verify))
 477                 list = 1;
 478
 479         if ((annotate || msg.given || msgfile || force) &&
 480             (list || delete || verify))
 481                 usage_with_options(git_tag_usage, options);
 482
 483         if (list + delete + verify > 1)
 484                 usage_with_options(git_tag_usage, options);
 485         if (list)
 486                 return list_tags(argv, lines == -1 ? 0 : lines,
 487                                  with_commit);
 488         if (lines != -1)
 489                 die(_("-n option is only allowed with -l."));
 490         if (with_commit)
 491                 die(_("--contains option is only allowed with -l."));
 492         if (delete)
 493                 return for_each_tag_name(argv, delete_tag);
 494         if (verify)
 495                 return for_each_tag_name(argv, verify_tag);
 496
 497         if (msg.given || msgfile) {
 498                 if (msg.given && msgfile)
 499                         die(_("only one -F or -m option is allowed."));
 500                 annotate = 1;
 501                 if (msg.given)
 502                         strbuf_addbuf(&buf, &(msg.buf));
 503                 else {
 504                         if (!strcmp(msgfile, "-")) {
 505                                 if (strbuf_read(&buf, 0, 1024) < 0)
 506                                         die_errno(_("cannot read '%s'"), msgfile);
 507                         } else {
 508                                 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
 509                                         die_errno(_("could not open or read '%s'"),
 510                                                 msgfile);
 511                         }
 512                 }
 513         }
 514
 515         tag = argv[0];
 516
 517         object_ref = argc == 2 ? argv[1] : "HEAD";
 518         if (argc > 2)
 519                 die(_("too many params"));
 520
 521         if (get_sha1(object_ref, object))
 522                 die(_("Failed to resolve '%s' as a valid ref."), object_ref);
 523
 524         if (strbuf_check_tag_ref(&ref, tag))
 525                 die(_("'%s' is not a valid tag name."), tag);
 526
 527         if (!resolve_ref(ref.buf, prev, 1, NULL))
 528                 hashclr(prev);
 529         else if (!force)
 530                 die(_("tag '%s' already exists"), tag);
 531
 532         if (annotate)
 533                 create_tag(object, tag, &buf, msg.given || msgfile,
 534                            sign, prev, object);
 535
 536         lock = lock_any_ref_for_update(ref.buf, prev, 0);
 537         if (!lock)
 538                 die(_("%s: cannot lock the ref"), ref.buf);
 539         if (write_ref_sha1(lock, object, NULL) < 0)
 540                 die(_("%s: cannot update the ref"), ref.buf);
 541         if (force && hashcmp(prev, object))
 542                 printf(_("Updated tag '%s' (was %s)\n"), tag, find_unique_abbrev(prev, DEFAULT_ABBREV));
 543
 544         strbuf_release(&buf);
 545         strbuf_release(&ref);
 546         return 0;
 547 }