Andrew's git - gitweb.git/blob

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