Andrew's git / gitweb.git / builtin/tag.c
?
builtin / tag.con commit t3507: introduce pristine-detach helper (2161da1)
   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
  16static 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
  22};
  23
  24static char signingkey[1000];
  25
  26struct tag_filter {
  27        const char *pattern;
  28        int lines;
  29        struct commit_list *with_commit;
  30};
  31
  32static int show_reference(const char *refname, const unsigned char *sha1,
  33                          int flag, void *cb_data)
  34{
  35        struct tag_filter *filter = cb_data;
  36
  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;
  43
  44                if (filter->with_commit) {
  45                        struct commit *commit;
  46
  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;
  52                }
  53
  54                if (!filter->lines) {
  55                        printf("%s\n", refname);
  56                        return 0;
  57                }
  58                printf("%-15s ", refname);
  59
  60                buf = read_sha1_file(sha1, &type, &size);
  61                if (!buf || !size)
  62                        return 0;
  63
  64                /* skip header */
  65                sp = strstr(buf, "\n\n");
  66                if (!sp) {
  67                        free(buf);
  68                        return 0;
  69                }
  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;
  83                }
  84                putchar('\n');
  85                free(buf);
  86        }
  87
  88        return 0;
  89}
  90
  91static int list_tags(const char *pattern, int lines,
  92                        struct commit_list *with_commit)
  93{
  94        struct tag_filter filter;
  95
  96        if (pattern == NULL)
  97                pattern = "*";
  98
  99        filter.pattern = pattern;
 100        filter.lines = lines;
 101        filter.with_commit = with_commit;
 102
 103        for_each_tag_ref(show_reference, (void *) &filter);
 104
 105        return 0;
 106}
 107
 108typedef int (*each_tag_name_fn)(const char *name, const char *ref,
 109                                const unsigned char *sha1);
 110
 111static int for_each_tag_name(const char **argv, each_tag_name_fn fn)
 112{
 113        const char **p;
 114        char ref[PATH_MAX];
 115        int had_error = 0;
 116        unsigned char sha1[20];
 117
 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;
 124                }
 125                if (!resolve_ref(ref, sha1, 1, NULL)) {
 126                        error("tag '%s' not found.", *p);
 127                        had_error = 1;
 128                        continue;
 129                }
 130                if (fn(*p, ref, sha1))
 131                        had_error = 1;
 132        }
 133        return had_error;
 134}
 135
 136static int delete_tag(const char *name, const char *ref,
 137                                const unsigned char *sha1)
 138{
 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;
 143}
 144
 145static int verify_tag(const char *name, const char *ref,
 146                                const unsigned char *sha1)
 147{
 148        const char *argv_verify_tag[] = {"verify-tag",
 149                                        "-v", "SHA1_HEX", NULL};
 150        argv_verify_tag[2] = sha1_to_hex(sha1);
 151
 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;
 155}
 156
 157static int do_sign(struct strbuf *buffer)
 158{
 159        struct child_process gpg;
 160        const char *args[4];
 161        char *bracket;
 162        int len;
 163        int i, j;
 164
 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';
 172        }
 173
 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);
 177
 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;
 186
 187        if (start_command(&gpg))
 188                return error("could not run gpg.");
 189
 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");
 195        }
 196        close(gpg.in);
 197        len = strbuf_read(buffer, gpg.out, 1024);
 198        close(gpg.out);
 199
 200        if (finish_command(&gpg) || !len || len < 0)
 201                return error("gpg failed to sign the tag");
 202
 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++;
 209                }
 210        strbuf_setlen(buffer, j);
 211
 212        return 0;
 213}
 214
 215static const char tag_template[] =
 216        "\n"
 217        "#\n"
 218        "# Write a tag message\n"
 219        "#\n";
 220
 221static void set_signingkey(const char *value)
 222{
 223        if (strlcpy(signingkey, value, sizeof(signingkey)) >= sizeof(signingkey))
 224                die("signing key value too long (%.10s...)", value);
 225}
 226
 227static int git_tag_config(const char *var, const char *value, void *cb)
 228{
 229        if (!strcmp(var, "user.signingkey")) {
 230                if (!value)
 231                        return config_error_nonbool(var);
 232                set_signingkey(value);
 233                return 0;
 234        }
 235
 236        return git_default_config(var, value, cb);
 237}
 238
 239static void write_tag_body(int fd, const unsigned char *sha1)
 240{
 241        unsigned long size;
 242        enum object_type type;
 243        char *buf, *sp;
 244
 245        buf = read_sha1_file(sha1, &type, &size);
 246        if (!buf)
 247                return;
 248        /* skip header */
 249        sp = strstr(buf, "\n\n");
 250
 251        if (!sp || !size || type != OBJ_TAG) {
 252                free(buf);
 253                return;
 254        }
 255        sp += 2; /* skip the 2 LFs */
 256        write_or_die(fd, sp, parse_signature(sp, buf + size - sp));
 257
 258        free(buf);
 259}
 260
 261static int build_tag_object(struct strbuf *buf, int sign, unsigned char *result)
 262{
 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;
 268}
 269
 270static 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)
 273{
 274        enum object_type type;
 275        char header_buf[1024];
 276        int header_len;
 277        char *path = NULL;
 278
 279        type = sha1_object_info(object, NULL);
 280        if (type <= OBJ_NONE)
 281            die("bad object type.");
 282
 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));
 292
 293        if (header_len > sizeof(header_buf) - 1)
 294                die("tag header too big.");
 295
 296        if (!message) {
 297                int fd;
 298
 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);
 304
 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);
 310
 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);
 315                }
 316        }
 317
 318        stripspace(buf, 1);
 319
 320        if (!message && !buf->len)
 321                die("no tag message?");
 322
 323        strbuf_insert(buf, 0, header_buf, header_len);
 324
 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);
 330        }
 331        if (path) {
 332                unlink_or_warn(path);
 333                free(path);
 334        }
 335}
 336
 337struct msg_arg {
 338        int given;
 339        struct strbuf buf;
 340};
 341
 342static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
 343{
 344        struct msg_arg *msg = opt->value;
 345
 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;
 353}
 354
 355int cmd_tag(int argc, const char **argv, const char *prefix)
 356{
 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;
 362
 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"),
 375
 376                OPT_GROUP("Tag creation options"),
 377                OPT_BOOLEAN('a', NULL, &annotate,
 378                                        "annotated tag, needs a message"),
 379                OPT_CALLBACK('m', NULL, &msg, "msg",
 380                             "message for the tag", parse_msg_arg),
 381                OPT_FILENAME('F', NULL, &msgfile, "message in a 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"),
 386
 387                OPT_GROUP("Tag listing options"),
 388                {
 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",
 393                },
 394                OPT_END()
 395        };
 396
 397        git_config(git_tag_config, NULL);
 398
 399        argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
 400
 401        if (keyid) {
 402                sign = 1;
 403                set_signingkey(keyid);
 404        }
 405        if (sign)
 406                annotate = 1;
 407        if (argc == 0 && !(delete || verify))
 408                list = 1;
 409
 410        if ((annotate || msg.given || msgfile || force) &&
 411            (list || delete || verify))
 412                usage_with_options(git_tag_usage, options);
 413
 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);
 427
 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);
 442                        }
 443                }
 444        }
 445
 446        tag = argv[0];
 447
 448        object_ref = argc == 2 ? argv[1] : "HEAD";
 449        if (argc > 2)
 450                die("too many params");
 451
 452        if (get_sha1(object_ref, object))
 453                die("Failed to resolve '%s' as a valid ref.", object_ref);
 454
 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);
 459
 460        if (!resolve_ref(ref, prev, 1, NULL))
 461                hashclr(prev);
 462        else if (!force)
 463                die("tag '%s' already exists", tag);
 464
 465        if (annotate)
 466                create_tag(object, tag, &buf, msg.given || msgfile,
 467                           sign, prev, object);
 468
 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));
 476
 477        strbuf_release(&buf);
 478        return 0;
 479}