builtin-commit.con commit Merge git://git.kernel.org/pub/scm/gitk/gitk (35d2f73)
   1/*
   2 * Builtin "git commit"
   3 *
   4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
   5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
   6 */
   7
   8#include "cache.h"
   9#include "cache-tree.h"
  10#include "color.h"
  11#include "dir.h"
  12#include "builtin.h"
  13#include "diff.h"
  14#include "diffcore.h"
  15#include "commit.h"
  16#include "revision.h"
  17#include "wt-status.h"
  18#include "run-command.h"
  19#include "refs.h"
  20#include "log-tree.h"
  21#include "strbuf.h"
  22#include "utf8.h"
  23#include "parse-options.h"
  24#include "string-list.h"
  25#include "rerere.h"
  26#include "unpack-trees.h"
  27
  28static const char * const builtin_commit_usage[] = {
  29        "git commit [options] [--] <filepattern>...",
  30        NULL
  31};
  32
  33static const char * const builtin_status_usage[] = {
  34        "git status [options] [--] <filepattern>...",
  35        NULL
  36};
  37
  38static unsigned char head_sha1[20], merge_head_sha1[20];
  39static char *use_message_buffer;
  40static const char commit_editmsg[] = "COMMIT_EDITMSG";
  41static struct lock_file index_lock; /* real index */
  42static struct lock_file false_lock; /* used only for partial commits */
  43static enum {
  44        COMMIT_AS_IS = 1,
  45        COMMIT_NORMAL,
  46        COMMIT_PARTIAL,
  47} commit_style;
  48
  49static const char *logfile, *force_author;
  50static const char *template_file;
  51static char *edit_message, *use_message;
  52static char *author_name, *author_email, *author_date;
  53static int all, edit_flag, also, interactive, only, amend, signoff;
  54static int quiet, verbose, no_verify, allow_empty;
  55static char *untracked_files_arg;
  56/*
  57 * The default commit message cleanup mode will remove the lines
  58 * beginning with # (shell comments) and leading and trailing
  59 * whitespaces (empty lines or containing only whitespaces)
  60 * if editor is used, and only the whitespaces if the message
  61 * is specified explicitly.
  62 */
  63static enum {
  64        CLEANUP_SPACE,
  65        CLEANUP_NONE,
  66        CLEANUP_ALL,
  67} cleanup_mode;
  68static char *cleanup_arg;
  69
  70static int use_editor = 1, initial_commit, in_merge;
  71static const char *only_include_assumed;
  72static struct strbuf message;
  73
  74static int opt_parse_m(const struct option *opt, const char *arg, int unset)
  75{
  76        struct strbuf *buf = opt->value;
  77        if (unset)
  78                strbuf_setlen(buf, 0);
  79        else {
  80                strbuf_addstr(buf, arg);
  81                strbuf_addstr(buf, "\n\n");
  82        }
  83        return 0;
  84}
  85
  86static struct option builtin_commit_options[] = {
  87        OPT__QUIET(&quiet),
  88        OPT__VERBOSE(&verbose),
  89        OPT_GROUP("Commit message options"),
  90
  91        OPT_STRING('F', "file", &logfile, "FILE", "read log from file"),
  92        OPT_STRING(0, "author", &force_author, "AUTHOR", "override author for commit"),
  93        OPT_CALLBACK('m', "message", &message, "MESSAGE", "specify commit message", opt_parse_m),
  94        OPT_STRING('c', "reedit-message", &edit_message, "COMMIT", "reuse and edit message from specified commit "),
  95        OPT_STRING('C', "reuse-message", &use_message, "COMMIT", "reuse message from specified commit"),
  96        OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
  97        OPT_STRING('t', "template", &template_file, "FILE", "use specified template file"),
  98        OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
  99
 100        OPT_GROUP("Commit contents options"),
 101        OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
 102        OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
 103        OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
 104        OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
 105        OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
 106        OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
 107        { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg, "mode", "show untracked files, optional modes: all, normal, no. (Default: all)", PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
 108        OPT_BOOLEAN(0, "allow-empty", &allow_empty, "ok to record an empty change"),
 109        OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
 110
 111        OPT_END()
 112};
 113
 114static void rollback_index_files(void)
 115{
 116        switch (commit_style) {
 117        case COMMIT_AS_IS:
 118                break; /* nothing to do */
 119        case COMMIT_NORMAL:
 120                rollback_lock_file(&index_lock);
 121                break;
 122        case COMMIT_PARTIAL:
 123                rollback_lock_file(&index_lock);
 124                rollback_lock_file(&false_lock);
 125                break;
 126        }
 127}
 128
 129static int commit_index_files(void)
 130{
 131        int err = 0;
 132
 133        switch (commit_style) {
 134        case COMMIT_AS_IS:
 135                break; /* nothing to do */
 136        case COMMIT_NORMAL:
 137                err = commit_lock_file(&index_lock);
 138                break;
 139        case COMMIT_PARTIAL:
 140                err = commit_lock_file(&index_lock);
 141                rollback_lock_file(&false_lock);
 142                break;
 143        }
 144
 145        return err;
 146}
 147
 148/*
 149 * Take a union of paths in the index and the named tree (typically, "HEAD"),
 150 * and return the paths that match the given pattern in list.
 151 */
 152static int list_paths(struct string_list *list, const char *with_tree,
 153                      const char *prefix, const char **pattern)
 154{
 155        int i;
 156        char *m;
 157
 158        for (i = 0; pattern[i]; i++)
 159                ;
 160        m = xcalloc(1, i);
 161
 162        if (with_tree)
 163                overlay_tree_on_cache(with_tree, prefix);
 164
 165        for (i = 0; i < active_nr; i++) {
 166                struct cache_entry *ce = active_cache[i];
 167                if (ce->ce_flags & CE_UPDATE)
 168                        continue;
 169                if (!pathspec_match(pattern, m, ce->name, 0))
 170                        continue;
 171                string_list_insert(ce->name, list);
 172        }
 173
 174        return report_path_error(m, pattern, prefix ? strlen(prefix) : 0);
 175}
 176
 177static void add_remove_files(struct string_list *list)
 178{
 179        int i;
 180        for (i = 0; i < list->nr; i++) {
 181                struct stat st;
 182                struct string_list_item *p = &(list->items[i]);
 183
 184                if (!lstat(p->string, &st)) {
 185                        if (add_to_cache(p->string, &st, 0))
 186                                die("updating files failed");
 187                } else
 188                        remove_file_from_cache(p->string);
 189        }
 190}
 191
 192static void create_base_index(void)
 193{
 194        struct tree *tree;
 195        struct unpack_trees_options opts;
 196        struct tree_desc t;
 197
 198        if (initial_commit) {
 199                discard_cache();
 200                return;
 201        }
 202
 203        memset(&opts, 0, sizeof(opts));
 204        opts.head_idx = 1;
 205        opts.index_only = 1;
 206        opts.merge = 1;
 207        opts.src_index = &the_index;
 208        opts.dst_index = &the_index;
 209
 210        opts.fn = oneway_merge;
 211        tree = parse_tree_indirect(head_sha1);
 212        if (!tree)
 213                die("failed to unpack HEAD tree object");
 214        parse_tree(tree);
 215        init_tree_desc(&t, tree->buffer, tree->size);
 216        if (unpack_trees(1, &t, &opts))
 217                exit(128); /* We've already reported the error, finish dying */
 218}
 219
 220static char *prepare_index(int argc, const char **argv, const char *prefix)
 221{
 222        int fd;
 223        struct string_list partial;
 224        const char **pathspec = NULL;
 225
 226        if (interactive) {
 227                interactive_add(argc, argv, prefix);
 228                if (read_cache() < 0)
 229                        die("index file corrupt");
 230                commit_style = COMMIT_AS_IS;
 231                return get_index_file();
 232        }
 233
 234        if (read_cache() < 0)
 235                die("index file corrupt");
 236
 237        if (*argv)
 238                pathspec = get_pathspec(prefix, argv);
 239
 240        /*
 241         * Non partial, non as-is commit.
 242         *
 243         * (1) get the real index;
 244         * (2) update the_index as necessary;
 245         * (3) write the_index out to the real index (still locked);
 246         * (4) return the name of the locked index file.
 247         *
 248         * The caller should run hooks on the locked real index, and
 249         * (A) if all goes well, commit the real index;
 250         * (B) on failure, rollback the real index.
 251         */
 252        if (all || (also && pathspec && *pathspec)) {
 253                int fd = hold_locked_index(&index_lock, 1);
 254                add_files_to_cache(also ? prefix : NULL, pathspec, 0);
 255                refresh_cache(REFRESH_QUIET);
 256                if (write_cache(fd, active_cache, active_nr) ||
 257                    close_lock_file(&index_lock))
 258                        die("unable to write new_index file");
 259                commit_style = COMMIT_NORMAL;
 260                return index_lock.filename;
 261        }
 262
 263        /*
 264         * As-is commit.
 265         *
 266         * (1) return the name of the real index file.
 267         *
 268         * The caller should run hooks on the real index, and run
 269         * hooks on the real index, and create commit from the_index.
 270         * We still need to refresh the index here.
 271         */
 272        if (!pathspec || !*pathspec) {
 273                fd = hold_locked_index(&index_lock, 1);
 274                refresh_cache(REFRESH_QUIET);
 275                if (write_cache(fd, active_cache, active_nr) ||
 276                    commit_locked_index(&index_lock))
 277                        die("unable to write new_index file");
 278                commit_style = COMMIT_AS_IS;
 279                return get_index_file();
 280        }
 281
 282        /*
 283         * A partial commit.
 284         *
 285         * (0) find the set of affected paths;
 286         * (1) get lock on the real index file;
 287         * (2) update the_index with the given paths;
 288         * (3) write the_index out to the real index (still locked);
 289         * (4) get lock on the false index file;
 290         * (5) reset the_index from HEAD;
 291         * (6) update the_index the same way as (2);
 292         * (7) write the_index out to the false index file;
 293         * (8) return the name of the false index file (still locked);
 294         *
 295         * The caller should run hooks on the locked false index, and
 296         * create commit from it.  Then
 297         * (A) if all goes well, commit the real index;
 298         * (B) on failure, rollback the real index;
 299         * In either case, rollback the false index.
 300         */
 301        commit_style = COMMIT_PARTIAL;
 302
 303        if (file_exists(git_path("MERGE_HEAD")))
 304                die("cannot do a partial commit during a merge.");
 305
 306        memset(&partial, 0, sizeof(partial));
 307        partial.strdup_strings = 1;
 308        if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
 309                exit(1);
 310
 311        discard_cache();
 312        if (read_cache() < 0)
 313                die("cannot read the index");
 314
 315        fd = hold_locked_index(&index_lock, 1);
 316        add_remove_files(&partial);
 317        refresh_cache(REFRESH_QUIET);
 318        if (write_cache(fd, active_cache, active_nr) ||
 319            close_lock_file(&index_lock))
 320                die("unable to write new_index file");
 321
 322        fd = hold_lock_file_for_update(&false_lock,
 323                                       git_path("next-index-%"PRIuMAX, (uintmax_t) getpid()), 1);
 324
 325        create_base_index();
 326        add_remove_files(&partial);
 327        refresh_cache(REFRESH_QUIET);
 328
 329        if (write_cache(fd, active_cache, active_nr) ||
 330            close_lock_file(&false_lock))
 331                die("unable to write temporary index file");
 332
 333        discard_cache();
 334        read_cache_from(false_lock.filename);
 335
 336        return false_lock.filename;
 337}
 338
 339static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn)
 340{
 341        struct wt_status s;
 342
 343        wt_status_prepare(&s);
 344        if (wt_status_relative_paths)
 345                s.prefix = prefix;
 346
 347        if (amend) {
 348                s.amend = 1;
 349                s.reference = "HEAD^1";
 350        }
 351        s.verbose = verbose;
 352        s.untracked = (show_untracked_files == SHOW_ALL_UNTRACKED_FILES);
 353        s.index_file = index_file;
 354        s.fp = fp;
 355        s.nowarn = nowarn;
 356
 357        wt_status_print(&s);
 358
 359        return s.commitable;
 360}
 361
 362static int run_hook(const char *index_file, const char *name, ...)
 363{
 364        struct child_process hook;
 365        const char *argv[10], *env[2];
 366        char index[PATH_MAX];
 367        va_list args;
 368        int i;
 369
 370        va_start(args, name);
 371        argv[0] = git_path("hooks/%s", name);
 372        i = 0;
 373        do {
 374                if (++i >= ARRAY_SIZE(argv))
 375                        die ("run_hook(): too many arguments");
 376                argv[i] = va_arg(args, const char *);
 377        } while (argv[i]);
 378        va_end(args);
 379
 380        snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
 381        env[0] = index;
 382        env[1] = NULL;
 383
 384        if (access(argv[0], X_OK) < 0)
 385                return 0;
 386
 387        memset(&hook, 0, sizeof(hook));
 388        hook.argv = argv;
 389        hook.no_stdin = 1;
 390        hook.stdout_to_stderr = 1;
 391        hook.env = env;
 392
 393        return run_command(&hook);
 394}
 395
 396static int is_a_merge(const unsigned char *sha1)
 397{
 398        struct commit *commit = lookup_commit(sha1);
 399        if (!commit || parse_commit(commit))
 400                die("could not parse HEAD commit");
 401        return !!(commit->parents && commit->parents->next);
 402}
 403
 404static const char sign_off_header[] = "Signed-off-by: ";
 405
 406static void determine_author_info(void)
 407{
 408        char *name, *email, *date;
 409
 410        name = getenv("GIT_AUTHOR_NAME");
 411        email = getenv("GIT_AUTHOR_EMAIL");
 412        date = getenv("GIT_AUTHOR_DATE");
 413
 414        if (use_message) {
 415                const char *a, *lb, *rb, *eol;
 416
 417                a = strstr(use_message_buffer, "\nauthor ");
 418                if (!a)
 419                        die("invalid commit: %s", use_message);
 420
 421                lb = strstr(a + 8, " <");
 422                rb = strstr(a + 8, "> ");
 423                eol = strchr(a + 8, '\n');
 424                if (!lb || !rb || !eol)
 425                        die("invalid commit: %s", use_message);
 426
 427                name = xstrndup(a + 8, lb - (a + 8));
 428                email = xstrndup(lb + 2, rb - (lb + 2));
 429                date = xstrndup(rb + 2, eol - (rb + 2));
 430        }
 431
 432        if (force_author) {
 433                const char *lb = strstr(force_author, " <");
 434                const char *rb = strchr(force_author, '>');
 435
 436                if (!lb || !rb)
 437                        die("malformed --author parameter");
 438                name = xstrndup(force_author, lb - force_author);
 439                email = xstrndup(lb + 2, rb - (lb + 2));
 440        }
 441
 442        author_name = name;
 443        author_email = email;
 444        author_date = date;
 445}
 446
 447static int prepare_to_commit(const char *index_file, const char *prefix)
 448{
 449        struct stat statbuf;
 450        int commitable, saved_color_setting;
 451        struct strbuf sb = STRBUF_INIT;
 452        char *buffer;
 453        FILE *fp;
 454        const char *hook_arg1 = NULL;
 455        const char *hook_arg2 = NULL;
 456        int ident_shown = 0;
 457
 458        if (!no_verify && run_hook(index_file, "pre-commit", NULL))
 459                return 0;
 460
 461        if (message.len) {
 462                strbuf_addbuf(&sb, &message);
 463                hook_arg1 = "message";
 464        } else if (logfile && !strcmp(logfile, "-")) {
 465                if (isatty(0))
 466                        fprintf(stderr, "(reading log message from standard input)\n");
 467                if (strbuf_read(&sb, 0, 0) < 0)
 468                        die("could not read log from standard input");
 469                hook_arg1 = "message";
 470        } else if (logfile) {
 471                if (strbuf_read_file(&sb, logfile, 0) < 0)
 472                        die("could not read log file '%s': %s",
 473                            logfile, strerror(errno));
 474                hook_arg1 = "message";
 475        } else if (use_message) {
 476                buffer = strstr(use_message_buffer, "\n\n");
 477                if (!buffer || buffer[2] == '\0')
 478                        die("commit has empty message");
 479                strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
 480                hook_arg1 = "commit";
 481                hook_arg2 = use_message;
 482        } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
 483                if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
 484                        die("could not read MERGE_MSG: %s", strerror(errno));
 485                hook_arg1 = "merge";
 486        } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
 487                if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
 488                        die("could not read SQUASH_MSG: %s", strerror(errno));
 489                hook_arg1 = "squash";
 490        } else if (template_file && !stat(template_file, &statbuf)) {
 491                if (strbuf_read_file(&sb, template_file, 0) < 0)
 492                        die("could not read %s: %s",
 493                            template_file, strerror(errno));
 494                hook_arg1 = "template";
 495        }
 496
 497        /*
 498         * This final case does not modify the template message,
 499         * it just sets the argument to the prepare-commit-msg hook.
 500         */
 501        else if (in_merge)
 502                hook_arg1 = "merge";
 503
 504        fp = fopen(git_path(commit_editmsg), "w");
 505        if (fp == NULL)
 506                die("could not open %s: %s",
 507                    git_path(commit_editmsg), strerror(errno));
 508
 509        if (cleanup_mode != CLEANUP_NONE)
 510                stripspace(&sb, 0);
 511
 512        if (signoff) {
 513                struct strbuf sob = STRBUF_INIT;
 514                int i;
 515
 516                strbuf_addstr(&sob, sign_off_header);
 517                strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
 518                                             getenv("GIT_COMMITTER_EMAIL")));
 519                strbuf_addch(&sob, '\n');
 520                for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
 521                        ; /* do nothing */
 522                if (prefixcmp(sb.buf + i, sob.buf)) {
 523                        if (prefixcmp(sb.buf + i, sign_off_header))
 524                                strbuf_addch(&sb, '\n');
 525                        strbuf_addbuf(&sb, &sob);
 526                }
 527                strbuf_release(&sob);
 528        }
 529
 530        if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
 531                die("could not write commit template: %s", strerror(errno));
 532
 533        strbuf_release(&sb);
 534
 535        determine_author_info();
 536
 537        /* This checks if committer ident is explicitly given */
 538        git_committer_info(0);
 539        if (use_editor) {
 540                char *author_ident;
 541                const char *committer_ident;
 542
 543                if (in_merge)
 544                        fprintf(fp,
 545                                "#\n"
 546                                "# It looks like you may be committing a MERGE.\n"
 547                                "# If this is not correct, please remove the file\n"
 548                                "#      %s\n"
 549                                "# and try again.\n"
 550                                "#\n",
 551                                git_path("MERGE_HEAD"));
 552
 553                fprintf(fp,
 554                        "\n"
 555                        "# Please enter the commit message for your changes.");
 556                if (cleanup_mode == CLEANUP_ALL)
 557                        fprintf(fp,
 558                                " Lines starting\n"
 559                                "# with '#' will be ignored, and an empty"
 560                                " message aborts the commit.\n");
 561                else /* CLEANUP_SPACE, that is. */
 562                        fprintf(fp,
 563                                " Lines starting\n"
 564                                "# with '#' will be kept; you may remove them"
 565                                " yourself if you want to.\n"
 566                                "# An empty message aborts the commit.\n");
 567                if (only_include_assumed)
 568                        fprintf(fp, "# %s\n", only_include_assumed);
 569
 570                author_ident = xstrdup(fmt_name(author_name, author_email));
 571                committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
 572                                           getenv("GIT_COMMITTER_EMAIL"));
 573                if (strcmp(author_ident, committer_ident))
 574                        fprintf(fp,
 575                                "%s"
 576                                "# Author:    %s\n",
 577                                ident_shown++ ? "" : "#\n",
 578                                author_ident);
 579                free(author_ident);
 580
 581                if (!user_ident_explicitly_given)
 582                        fprintf(fp,
 583                                "%s"
 584                                "# Committer: %s\n",
 585                                ident_shown++ ? "" : "#\n",
 586                                committer_ident);
 587
 588                if (ident_shown)
 589                        fprintf(fp, "#\n");
 590
 591                saved_color_setting = wt_status_use_color;
 592                wt_status_use_color = 0;
 593                commitable = run_status(fp, index_file, prefix, 1);
 594                wt_status_use_color = saved_color_setting;
 595        } else {
 596                struct rev_info rev;
 597                unsigned char sha1[20];
 598                const char *parent = "HEAD";
 599
 600                if (!active_nr && read_cache() < 0)
 601                        die("Cannot read index");
 602
 603                if (amend)
 604                        parent = "HEAD^1";
 605
 606                if (get_sha1(parent, sha1))
 607                        commitable = !!active_nr;
 608                else {
 609                        init_revisions(&rev, "");
 610                        rev.abbrev = 0;
 611                        setup_revisions(0, NULL, &rev, parent);
 612                        DIFF_OPT_SET(&rev.diffopt, QUIET);
 613                        DIFF_OPT_SET(&rev.diffopt, EXIT_WITH_STATUS);
 614                        run_diff_index(&rev, 1 /* cached */);
 615
 616                        commitable = !!DIFF_OPT_TST(&rev.diffopt, HAS_CHANGES);
 617                }
 618        }
 619
 620        fclose(fp);
 621
 622        if (!commitable && !in_merge && !allow_empty &&
 623            !(amend && is_a_merge(head_sha1))) {
 624                run_status(stdout, index_file, prefix, 0);
 625                unlink(commit_editmsg);
 626                return 0;
 627        }
 628
 629        /*
 630         * Re-read the index as pre-commit hook could have updated it,
 631         * and write it out as a tree.  We must do this before we invoke
 632         * the editor and after we invoke run_status above.
 633         */
 634        discard_cache();
 635        read_cache_from(index_file);
 636        if (!active_cache_tree)
 637                active_cache_tree = cache_tree();
 638        if (cache_tree_update(active_cache_tree,
 639                              active_cache, active_nr, 0, 0) < 0) {
 640                error("Error building trees; the index is unmerged?");
 641                return 0;
 642        }
 643
 644        if (run_hook(index_file, "prepare-commit-msg",
 645                     git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
 646                return 0;
 647
 648        if (use_editor) {
 649                char index[PATH_MAX];
 650                const char *env[2] = { index, NULL };
 651                snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
 652                if (launch_editor(git_path(commit_editmsg), NULL, env)) {
 653                        fprintf(stderr,
 654                        "Please supply the message using either -m or -F option.\n");
 655                        exit(1);
 656                }
 657        }
 658
 659        if (!no_verify &&
 660            run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
 661                return 0;
 662        }
 663
 664        return 1;
 665}
 666
 667/*
 668 * Find out if the message in the strbuf contains only whitespace and
 669 * Signed-off-by lines.
 670 */
 671static int message_is_empty(struct strbuf *sb)
 672{
 673        struct strbuf tmpl = STRBUF_INIT;
 674        const char *nl;
 675        int eol, i, start = 0;
 676
 677        if (cleanup_mode == CLEANUP_NONE && sb->len)
 678                return 0;
 679
 680        /* See if the template is just a prefix of the message. */
 681        if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
 682                stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
 683                if (start + tmpl.len <= sb->len &&
 684                    memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
 685                        start += tmpl.len;
 686        }
 687        strbuf_release(&tmpl);
 688
 689        /* Check if the rest is just whitespace and Signed-of-by's. */
 690        for (i = start; i < sb->len; i++) {
 691                nl = memchr(sb->buf + i, '\n', sb->len - i);
 692                if (nl)
 693                        eol = nl - sb->buf;
 694                else
 695                        eol = sb->len;
 696
 697                if (strlen(sign_off_header) <= eol - i &&
 698                    !prefixcmp(sb->buf + i, sign_off_header)) {
 699                        i = eol;
 700                        continue;
 701                }
 702                while (i < eol)
 703                        if (!isspace(sb->buf[i++]))
 704                                return 0;
 705        }
 706
 707        return 1;
 708}
 709
 710static const char *find_author_by_nickname(const char *name)
 711{
 712        struct rev_info revs;
 713        struct commit *commit;
 714        struct strbuf buf = STRBUF_INIT;
 715        const char *av[20];
 716        int ac = 0;
 717
 718        init_revisions(&revs, NULL);
 719        strbuf_addf(&buf, "--author=%s", name);
 720        av[++ac] = "--all";
 721        av[++ac] = "-i";
 722        av[++ac] = buf.buf;
 723        av[++ac] = NULL;
 724        setup_revisions(ac, av, &revs, NULL);
 725        prepare_revision_walk(&revs);
 726        commit = get_revision(&revs);
 727        if (commit) {
 728                strbuf_release(&buf);
 729                format_commit_message(commit, "%an <%ae>", &buf, DATE_NORMAL);
 730                return strbuf_detach(&buf, NULL);
 731        }
 732        die("No existing author found with '%s'", name);
 733}
 734
 735static int parse_and_validate_options(int argc, const char *argv[],
 736                                      const char * const usage[],
 737                                      const char *prefix)
 738{
 739        int f = 0;
 740
 741        argc = parse_options(argc, argv, builtin_commit_options, usage, 0);
 742        logfile = parse_options_fix_filename(prefix, logfile);
 743        template_file = parse_options_fix_filename(prefix, template_file);
 744
 745        if (force_author && !strchr(force_author, '>'))
 746                force_author = find_author_by_nickname(force_author);
 747
 748        if (logfile || message.len || use_message)
 749                use_editor = 0;
 750        if (edit_flag)
 751                use_editor = 1;
 752        if (!use_editor)
 753                setenv("GIT_EDITOR", ":", 1);
 754
 755        if (get_sha1("HEAD", head_sha1))
 756                initial_commit = 1;
 757
 758        if (!get_sha1("MERGE_HEAD", merge_head_sha1))
 759                in_merge = 1;
 760
 761        /* Sanity check options */
 762        if (amend && initial_commit)
 763                die("You have nothing to amend.");
 764        if (amend && in_merge)
 765                die("You are in the middle of a merge -- cannot amend.");
 766
 767        if (use_message)
 768                f++;
 769        if (edit_message)
 770                f++;
 771        if (logfile)
 772                f++;
 773        if (f > 1)
 774                die("Only one of -c/-C/-F can be used.");
 775        if (message.len && f > 0)
 776                die("Option -m cannot be combined with -c/-C/-F.");
 777        if (edit_message)
 778                use_message = edit_message;
 779        if (amend && !use_message)
 780                use_message = "HEAD";
 781        if (use_message) {
 782                unsigned char sha1[20];
 783                static char utf8[] = "UTF-8";
 784                const char *out_enc;
 785                char *enc, *end;
 786                struct commit *commit;
 787
 788                if (get_sha1(use_message, sha1))
 789                        die("could not lookup commit %s", use_message);
 790                commit = lookup_commit_reference(sha1);
 791                if (!commit || parse_commit(commit))
 792                        die("could not parse commit %s", use_message);
 793
 794                enc = strstr(commit->buffer, "\nencoding");
 795                if (enc) {
 796                        end = strchr(enc + 10, '\n');
 797                        enc = xstrndup(enc + 10, end - (enc + 10));
 798                } else {
 799                        enc = utf8;
 800                }
 801                out_enc = git_commit_encoding ? git_commit_encoding : utf8;
 802
 803                if (strcmp(out_enc, enc))
 804                        use_message_buffer =
 805                                reencode_string(commit->buffer, out_enc, enc);
 806
 807                /*
 808                 * If we failed to reencode the buffer, just copy it
 809                 * byte for byte so the user can try to fix it up.
 810                 * This also handles the case where input and output
 811                 * encodings are identical.
 812                 */
 813                if (use_message_buffer == NULL)
 814                        use_message_buffer = xstrdup(commit->buffer);
 815                if (enc != utf8)
 816                        free(enc);
 817        }
 818
 819        if (!!also + !!only + !!all + !!interactive > 1)
 820                die("Only one of --include/--only/--all/--interactive can be used.");
 821        if (argc == 0 && (also || (only && !amend)))
 822                die("No paths with --include/--only does not make sense.");
 823        if (argc == 0 && only && amend)
 824                only_include_assumed = "Clever... amending the last one with dirty index.";
 825        if (argc > 0 && !also && !only)
 826                only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
 827        if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
 828                cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
 829        else if (!strcmp(cleanup_arg, "verbatim"))
 830                cleanup_mode = CLEANUP_NONE;
 831        else if (!strcmp(cleanup_arg, "whitespace"))
 832                cleanup_mode = CLEANUP_SPACE;
 833        else if (!strcmp(cleanup_arg, "strip"))
 834                cleanup_mode = CLEANUP_ALL;
 835        else
 836                die("Invalid cleanup mode %s", cleanup_arg);
 837
 838        if (!untracked_files_arg)
 839                ; /* default already initialized */
 840        else if (!strcmp(untracked_files_arg, "no"))
 841                show_untracked_files = SHOW_NO_UNTRACKED_FILES;
 842        else if (!strcmp(untracked_files_arg, "normal"))
 843                show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
 844        else if (!strcmp(untracked_files_arg, "all"))
 845                show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
 846        else
 847                die("Invalid untracked files mode '%s'", untracked_files_arg);
 848
 849        if (all && argc > 0)
 850                die("Paths with -a does not make sense.");
 851        else if (interactive && argc > 0)
 852                die("Paths with --interactive does not make sense.");
 853
 854        return argc;
 855}
 856
 857int cmd_status(int argc, const char **argv, const char *prefix)
 858{
 859        const char *index_file;
 860        int commitable;
 861
 862        git_config(git_status_config, NULL);
 863
 864        if (wt_status_use_color == -1)
 865                wt_status_use_color = git_use_color_default;
 866
 867        argc = parse_and_validate_options(argc, argv, builtin_status_usage, prefix);
 868
 869        index_file = prepare_index(argc, argv, prefix);
 870
 871        commitable = run_status(stdout, index_file, prefix, 0);
 872
 873        rollback_index_files();
 874
 875        return commitable ? 0 : 1;
 876}
 877
 878static void print_summary(const char *prefix, const unsigned char *sha1)
 879{
 880        struct rev_info rev;
 881        struct commit *commit;
 882        static const char *format = "format:%h: \"%s\"";
 883        unsigned char junk_sha1[20];
 884        const char *head = resolve_ref("HEAD", junk_sha1, 0, NULL);
 885
 886        commit = lookup_commit(sha1);
 887        if (!commit)
 888                die("couldn't look up newly created commit");
 889        if (!commit || parse_commit(commit))
 890                die("could not parse newly created commit");
 891
 892        init_revisions(&rev, prefix);
 893        setup_revisions(0, NULL, &rev, NULL);
 894
 895        rev.abbrev = 0;
 896        rev.diff = 1;
 897        rev.diffopt.output_format =
 898                DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
 899
 900        rev.verbose_header = 1;
 901        rev.show_root_diff = 1;
 902        get_commit_format(format, &rev);
 903        rev.always_show_header = 0;
 904        rev.diffopt.detect_rename = 1;
 905        rev.diffopt.rename_limit = 100;
 906        rev.diffopt.break_opt = 0;
 907        diff_setup_done(&rev.diffopt);
 908
 909        printf("[%s%s]: created ",
 910                !prefixcmp(head, "refs/heads/") ?
 911                        head + 11 :
 912                        !strcmp(head, "HEAD") ?
 913                                "detached HEAD" :
 914                                head,
 915                initial_commit ? " (root-commit)" : "");
 916
 917        if (!log_tree_commit(&rev, commit)) {
 918                struct strbuf buf = STRBUF_INIT;
 919                format_commit_message(commit, format + 7, &buf, DATE_NORMAL);
 920                printf("%s\n", buf.buf);
 921                strbuf_release(&buf);
 922        }
 923}
 924
 925static int git_commit_config(const char *k, const char *v, void *cb)
 926{
 927        if (!strcmp(k, "commit.template"))
 928                return git_config_string(&template_file, k, v);
 929
 930        return git_status_config(k, v, cb);
 931}
 932
 933static const char commit_utf8_warn[] =
 934"Warning: commit message does not conform to UTF-8.\n"
 935"You may want to amend it after fixing the message, or set the config\n"
 936"variable i18n.commitencoding to the encoding your project uses.\n";
 937
 938int cmd_commit(int argc, const char **argv, const char *prefix)
 939{
 940        struct strbuf sb = STRBUF_INIT;
 941        const char *index_file, *reflog_msg;
 942        char *nl, *p;
 943        unsigned char commit_sha1[20];
 944        struct ref_lock *ref_lock;
 945        struct commit_list *parents = NULL, **pptr = &parents;
 946        struct stat statbuf;
 947        int allow_fast_forward = 1;
 948
 949        git_config(git_commit_config, NULL);
 950
 951        argc = parse_and_validate_options(argc, argv, builtin_commit_usage, prefix);
 952
 953        index_file = prepare_index(argc, argv, prefix);
 954
 955        /* Set up everything for writing the commit object.  This includes
 956           running hooks, writing the trees, and interacting with the user.  */
 957        if (!prepare_to_commit(index_file, prefix)) {
 958                rollback_index_files();
 959                return 1;
 960        }
 961
 962        /* Determine parents */
 963        if (initial_commit) {
 964                reflog_msg = "commit (initial)";
 965        } else if (amend) {
 966                struct commit_list *c;
 967                struct commit *commit;
 968
 969                reflog_msg = "commit (amend)";
 970                commit = lookup_commit(head_sha1);
 971                if (!commit || parse_commit(commit))
 972                        die("could not parse HEAD commit");
 973
 974                for (c = commit->parents; c; c = c->next)
 975                        pptr = &commit_list_insert(c->item, pptr)->next;
 976        } else if (in_merge) {
 977                struct strbuf m = STRBUF_INIT;
 978                FILE *fp;
 979
 980                reflog_msg = "commit (merge)";
 981                pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
 982                fp = fopen(git_path("MERGE_HEAD"), "r");
 983                if (fp == NULL)
 984                        die("could not open %s for reading: %s",
 985                            git_path("MERGE_HEAD"), strerror(errno));
 986                while (strbuf_getline(&m, fp, '\n') != EOF) {
 987                        unsigned char sha1[20];
 988                        if (get_sha1_hex(m.buf, sha1) < 0)
 989                                die("Corrupt MERGE_HEAD file (%s)", m.buf);
 990                        pptr = &commit_list_insert(lookup_commit(sha1), pptr)->next;
 991                }
 992                fclose(fp);
 993                strbuf_release(&m);
 994                if (!stat(git_path("MERGE_MODE"), &statbuf)) {
 995                        if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
 996                                die("could not read MERGE_MODE: %s",
 997                                                strerror(errno));
 998                        if (!strcmp(sb.buf, "no-ff"))
 999                                allow_fast_forward = 0;
1000                }
1001                if (allow_fast_forward)
1002                        parents = reduce_heads(parents);
1003        } else {
1004                reflog_msg = "commit";
1005                pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
1006        }
1007
1008        /* Finally, get the commit message */
1009        strbuf_reset(&sb);
1010        if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1011                rollback_index_files();
1012                die("could not read commit message");
1013        }
1014
1015        /* Truncate the message just before the diff, if any. */
1016        p = strstr(sb.buf, "\ndiff --git a/");
1017        if (p != NULL)
1018                strbuf_setlen(&sb, p - sb.buf + 1);
1019
1020        if (cleanup_mode != CLEANUP_NONE)
1021                stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1022        if (message_is_empty(&sb)) {
1023                rollback_index_files();
1024                fprintf(stderr, "Aborting commit due to empty commit message.\n");
1025                exit(1);
1026        }
1027
1028        if (commit_tree(sb.buf, active_cache_tree->sha1, parents, commit_sha1,
1029                        fmt_ident(author_name, author_email, author_date,
1030                                IDENT_ERROR_ON_NO_NAME))) {
1031                rollback_index_files();
1032                die("failed to write commit object");
1033        }
1034
1035        ref_lock = lock_any_ref_for_update("HEAD",
1036                                           initial_commit ? NULL : head_sha1,
1037                                           0);
1038
1039        nl = strchr(sb.buf, '\n');
1040        if (nl)
1041                strbuf_setlen(&sb, nl + 1 - sb.buf);
1042        else
1043                strbuf_addch(&sb, '\n');
1044        strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1045        strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1046
1047        if (!ref_lock) {
1048                rollback_index_files();
1049                die("cannot lock HEAD ref");
1050        }
1051        if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1052                rollback_index_files();
1053                die("cannot update HEAD ref");
1054        }
1055
1056        unlink(git_path("MERGE_HEAD"));
1057        unlink(git_path("MERGE_MSG"));
1058        unlink(git_path("MERGE_MODE"));
1059        unlink(git_path("SQUASH_MSG"));
1060
1061        if (commit_index_files())
1062                die ("Repository has been updated, but unable to write\n"
1063                     "new_index file. Check that disk is not full or quota is\n"
1064                     "not exceeded, and then \"git reset HEAD\" to recover.");
1065
1066        rerere();
1067        run_hook(get_index_file(), "post-commit", NULL);
1068        if (!quiet)
1069                print_summary(prefix, commit_sha1);
1070
1071        return 0;
1072}