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_sha1_file(buf->buf, buf->len, tag_type, result->hash) < 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 sign;
 198        enum {
 199                CLEANUP_NONE,
 200                CLEANUP_SPACE,
 201                CLEANUP_ALL
 202        } cleanup_mode;
 203};
 204
 205static void create_tag(const struct object_id *object, const char *tag,
 206                       struct strbuf *buf, struct create_tag_options *opt,
 207                       struct object_id *prev, struct object_id *result)
 208{
 209        enum object_type type;
 210        struct strbuf header = STRBUF_INIT;
 211        char *path = NULL;
 212
 213        type = sha1_object_info(object->hash, NULL);
 214        if (type <= OBJ_NONE)
 215            die(_("bad object type."));
 216
 217        strbuf_addf(&header,
 218                    "object %s\n"
 219                    "type %s\n"
 220                    "tag %s\n"
 221                    "tagger %s\n\n",
 222                    oid_to_hex(object),
 223                    typename(type),
 224                    tag,
 225                    git_committer_info(IDENT_STRICT));
 226
 227        if (!opt->message_given) {
 228                int fd;
 229
 230                /* write the template message before editing: */
 231                path = git_pathdup("TAG_EDITMSG");
 232                fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
 233                if (fd < 0)
 234                        die_errno(_("could not create file '%s'"), path);
 235
 236                if (!is_null_oid(prev)) {
 237                        write_tag_body(fd, prev);
 238                } else {
 239                        struct strbuf buf = STRBUF_INIT;
 240                        strbuf_addch(&buf, '\n');
 241                        if (opt->cleanup_mode == CLEANUP_ALL)
 242                                strbuf_commented_addf(&buf, _(tag_template), tag, comment_line_char);
 243                        else
 244                                strbuf_commented_addf(&buf, _(tag_template_nocleanup), tag, comment_line_char);
 245                        write_or_die(fd, buf.buf, buf.len);
 246                        strbuf_release(&buf);
 247                }
 248                close(fd);
 249
 250                if (launch_editor(path, buf, NULL)) {
 251                        fprintf(stderr,
 252                        _("Please supply the message using either -m or -F option.\n"));
 253                        exit(1);
 254                }
 255        }
 256
 257        if (opt->cleanup_mode != CLEANUP_NONE)
 258                strbuf_stripspace(buf, opt->cleanup_mode == CLEANUP_ALL);
 259
 260        if (!opt->message_given && !buf->len)
 261                die(_("no tag message?"));
 262
 263        strbuf_insert(buf, 0, header.buf, header.len);
 264        strbuf_release(&header);
 265
 266        if (build_tag_object(buf, opt->sign, result) < 0) {
 267                if (path)
 268                        fprintf(stderr, _("The tag message has been left in %s\n"),
 269                                path);
 270                exit(128);
 271        }
 272        if (path) {
 273                unlink_or_warn(path);
 274                free(path);
 275        }
 276}
 277
 278static void create_reflog_msg(const struct object_id *oid, struct strbuf *sb)
 279{
 280        enum object_type type;
 281        struct commit *c;
 282        char *buf;
 283        unsigned long size;
 284        int subject_len = 0;
 285        const char *subject_start;
 286
 287        char *rla = getenv("GIT_REFLOG_ACTION");
 288        if (rla) {
 289                strbuf_addstr(sb, rla);
 290        } else {
 291                strbuf_addstr(sb, "tag: tagging ");
 292                strbuf_add_unique_abbrev(sb, oid->hash, DEFAULT_ABBREV);
 293        }
 294
 295        strbuf_addstr(sb, " (");
 296        type = sha1_object_info(oid->hash, NULL);
 297        switch (type) {
 298        default:
 299                strbuf_addstr(sb, "object of unknown type");
 300                break;
 301        case OBJ_COMMIT:
 302                if ((buf = read_sha1_file(oid->hash, &type, &size)) != NULL) {
 303                        subject_len = find_commit_subject(buf, &subject_start);
 304                        strbuf_insert(sb, sb->len, subject_start, subject_len);
 305                } else {
 306                        strbuf_addstr(sb, "commit object");
 307                }
 308                free(buf);
 309
 310                if ((c = lookup_commit_reference(oid)) != NULL)
 311                        strbuf_addf(sb, ", %s", show_date(c->date, 0, DATE_MODE(SHORT)));
 312                break;
 313        case OBJ_TREE:
 314                strbuf_addstr(sb, "tree object");
 315                break;
 316        case OBJ_BLOB:
 317                strbuf_addstr(sb, "blob object");
 318                break;
 319        case OBJ_TAG:
 320                strbuf_addstr(sb, "other tag object");
 321                break;
 322        }
 323        strbuf_addch(sb, ')');
 324}
 325
 326struct msg_arg {
 327        int given;
 328        struct strbuf buf;
 329};
 330
 331static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
 332{
 333        struct msg_arg *msg = opt->value;
 334
 335        if (!arg)
 336                return -1;
 337        if (msg->buf.len)
 338                strbuf_addstr(&(msg->buf), "\n\n");
 339        strbuf_addstr(&(msg->buf), arg);
 340        msg->given = 1;
 341        return 0;
 342}
 343
 344static int strbuf_check_tag_ref(struct strbuf *sb, const char *name)
 345{
 346        if (name[0] == '-')
 347                return -1;
 348
 349        strbuf_reset(sb);
 350        strbuf_addf(sb, "refs/tags/%s", name);
 351
 352        return check_refname_format(sb->buf, 0);
 353}
 354
 355int cmd_tag(int argc, const char **argv, const char *prefix)
 356{
 357        struct strbuf buf = STRBUF_INIT;
 358        struct strbuf ref = STRBUF_INIT;
 359        struct strbuf reflog_msg = STRBUF_INIT;
 360        struct object_id object, prev;
 361        const char *object_ref, *tag;
 362        struct create_tag_options opt;
 363        char *cleanup_arg = NULL;
 364        int create_reflog = 0;
 365        int annotate = 0, force = 0;
 366        int cmdmode = 0, create_tag_object = 0;
 367        const char *msgfile = NULL, *keyid = NULL;
 368        struct msg_arg msg = { 0, STRBUF_INIT };
 369        struct ref_transaction *transaction;
 370        struct strbuf err = STRBUF_INIT;
 371        struct ref_filter filter;
 372        static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
 373        struct ref_format format = REF_FORMAT_INIT;
 374        int icase = 0;
 375        struct option options[] = {
 376                OPT_CMDMODE('l', "list", &cmdmode, N_("list tag names"), 'l'),
 377                { OPTION_INTEGER, 'n', NULL, &filter.lines, N_("n"),
 378                                N_("print <n> lines of each tag message"),
 379                                PARSE_OPT_OPTARG, NULL, 1 },
 380                OPT_CMDMODE('d', "delete", &cmdmode, N_("delete tags"), 'd'),
 381                OPT_CMDMODE('v', "verify", &cmdmode, N_("verify tags"), 'v'),
 382
 383                OPT_GROUP(N_("Tag creation options")),
 384                OPT_BOOL('a', "annotate", &annotate,
 385                                        N_("annotated tag, needs a message")),
 386                OPT_CALLBACK('m', "message", &msg, N_("message"),
 387                             N_("tag message"), parse_msg_arg),
 388                OPT_FILENAME('F', "file", &msgfile, N_("read message from file")),
 389                OPT_BOOL('s', "sign", &opt.sign, N_("annotated and GPG-signed tag")),
 390                OPT_STRING(0, "cleanup", &cleanup_arg, N_("mode"),
 391                        N_("how to strip spaces and #comments from message")),
 392                OPT_STRING('u', "local-user", &keyid, N_("key-id"),
 393                                        N_("use another key to sign the tag")),
 394                OPT__FORCE(&force, N_("replace the tag if exists")),
 395                OPT_BOOL(0, "create-reflog", &create_reflog, N_("create a reflog")),
 396
 397                OPT_GROUP(N_("Tag listing options")),
 398                OPT_COLUMN(0, "column", &colopts, N_("show tag list in columns")),
 399                OPT_CONTAINS(&filter.with_commit, N_("print only tags that contain the commit")),
 400                OPT_NO_CONTAINS(&filter.no_commit, N_("print only tags that don't contain the commit")),
 401                OPT_WITH(&filter.with_commit, N_("print only tags that contain the commit")),
 402                OPT_WITHOUT(&filter.no_commit, N_("print only tags that don't contain the commit")),
 403                OPT_MERGED(&filter, N_("print only tags that are merged")),
 404                OPT_NO_MERGED(&filter, N_("print only tags that are not merged")),
 405                OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
 406                             N_("field name to sort on"), &parse_opt_ref_sorting),
 407                {
 408                        OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
 409                        N_("print only tags of the object"), PARSE_OPT_LASTARG_DEFAULT,
 410                        parse_opt_object_name, (intptr_t) "HEAD"
 411                },
 412                OPT_STRING(  0 , "format", &format.format, N_("format"),
 413                           N_("format to use for the output")),
 414                OPT__COLOR(&format.use_color, N_("respect format colors")),
 415                OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
 416                OPT_END()
 417        };
 418
 419        setup_ref_filter_porcelain_msg();
 420
 421        git_config(git_tag_config, sorting_tail);
 422
 423        memset(&opt, 0, sizeof(opt));
 424        memset(&filter, 0, sizeof(filter));
 425        filter.lines = -1;
 426
 427        argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
 428
 429        if (keyid) {
 430                opt.sign = 1;
 431                set_signing_key(keyid);
 432        }
 433        create_tag_object = (opt.sign || annotate || msg.given || msgfile);
 434
 435        if (!cmdmode) {
 436                if (argc == 0)
 437                        cmdmode = 'l';
 438                else if (filter.with_commit || filter.no_commit ||
 439                         filter.points_at.nr || filter.merge_commit ||
 440                         filter.lines != -1)
 441                        cmdmode = 'l';
 442        }
 443
 444        if (cmdmode == 'l')
 445                setup_auto_pager("tag", 1);
 446
 447        if ((create_tag_object || force) && (cmdmode != 0))
 448                usage_with_options(git_tag_usage, options);
 449
 450        finalize_colopts(&colopts, -1);
 451        if (cmdmode == 'l' && filter.lines != -1) {
 452                if (explicitly_enable_column(colopts))
 453                        die(_("--column and -n are incompatible"));
 454                colopts = 0;
 455        }
 456        if (!sorting)
 457                sorting = ref_default_sorting();
 458        sorting->ignore_case = icase;
 459        filter.ignore_case = icase;
 460        if (cmdmode == 'l') {
 461                int ret;
 462                if (column_active(colopts)) {
 463                        struct column_options copts;
 464                        memset(&copts, 0, sizeof(copts));
 465                        copts.padding = 2;
 466                        run_column_filter(colopts, &copts);
 467                }
 468                filter.name_patterns = argv;
 469                ret = list_tags(&filter, sorting, &format);
 470                if (column_active(colopts))
 471                        stop_column_filter();
 472                return ret;
 473        }
 474        if (filter.lines != -1)
 475                die(_("-n option is only allowed in list mode"));
 476        if (filter.with_commit)
 477                die(_("--contains option is only allowed in list mode"));
 478        if (filter.no_commit)
 479                die(_("--no-contains option is only allowed in list mode"));
 480        if (filter.points_at.nr)
 481                die(_("--points-at option is only allowed in list mode"));
 482        if (filter.merge_commit)
 483                die(_("--merged and --no-merged options are only allowed in list mode"));
 484        if (cmdmode == 'd')
 485                return for_each_tag_name(argv, delete_tag, NULL);
 486        if (cmdmode == 'v') {
 487                if (format.format && verify_ref_format(&format))
 488                        usage_with_options(git_tag_usage, options);
 489                return for_each_tag_name(argv, verify_tag, &format);
 490        }
 491
 492        if (msg.given || msgfile) {
 493                if (msg.given && msgfile)
 494                        die(_("only one -F or -m option is allowed."));
 495                if (msg.given)
 496                        strbuf_addbuf(&buf, &(msg.buf));
 497                else {
 498                        if (!strcmp(msgfile, "-")) {
 499                                if (strbuf_read(&buf, 0, 1024) < 0)
 500                                        die_errno(_("cannot read '%s'"), msgfile);
 501                        } else {
 502                                if (strbuf_read_file(&buf, msgfile, 1024) < 0)
 503                                        die_errno(_("could not open or read '%s'"),
 504                                                msgfile);
 505                        }
 506                }
 507        }
 508
 509        tag = argv[0];
 510
 511        object_ref = argc == 2 ? argv[1] : "HEAD";
 512        if (argc > 2)
 513                die(_("too many params"));
 514
 515        if (get_oid(object_ref, &object))
 516                die(_("Failed to resolve '%s' as a valid ref."), object_ref);
 517
 518        if (strbuf_check_tag_ref(&ref, tag))
 519                die(_("'%s' is not a valid tag name."), tag);
 520
 521        if (read_ref(ref.buf, &prev))
 522                oidclr(&prev);
 523        else if (!force)
 524                die(_("tag '%s' already exists"), tag);
 525
 526        opt.message_given = msg.given || msgfile;
 527
 528        if (!cleanup_arg || !strcmp(cleanup_arg, "strip"))
 529                opt.cleanup_mode = CLEANUP_ALL;
 530        else if (!strcmp(cleanup_arg, "verbatim"))
 531                opt.cleanup_mode = CLEANUP_NONE;
 532        else if (!strcmp(cleanup_arg, "whitespace"))
 533                opt.cleanup_mode = CLEANUP_SPACE;
 534        else
 535                die(_("Invalid cleanup mode %s"), cleanup_arg);
 536
 537        create_reflog_msg(&object, &reflog_msg);
 538
 539        if (create_tag_object) {
 540                if (force_sign_annotate && !annotate)
 541                        opt.sign = 1;
 542                create_tag(&object, tag, &buf, &opt, &prev, &object);
 543        }
 544
 545        transaction = ref_transaction_begin(&err);
 546        if (!transaction ||
 547            ref_transaction_update(transaction, ref.buf, &object, &prev,
 548                                   create_reflog ? REF_FORCE_CREATE_REFLOG : 0,
 549                                   reflog_msg.buf, &err) ||
 550            ref_transaction_commit(transaction, &err))
 551                die("%s", err.buf);
 552        ref_transaction_free(transaction);
 553        if (force && !is_null_oid(&prev) && oidcmp(&prev, &object))
 554                printf(_("Updated tag '%s' (was %s)\n"), tag, find_unique_abbrev(prev.hash, DEFAULT_ABBREV));
 555
 556        UNLEAK(buf);
 557        UNLEAK(ref);
 558        UNLEAK(reflog_msg);
 559        UNLEAK(msg);
 560        UNLEAK(err);
 561        return 0;
 562}