sequencer.con commit t3504: use test_commit (6f0e577)
   1#include "cache.h"
   2#include "config.h"
   3#include "lockfile.h"
   4#include "sequencer.h"
   5#include "dir.h"
   6#include "object.h"
   7#include "commit.h"
   8#include "tag.h"
   9#include "run-command.h"
  10#include "exec_cmd.h"
  11#include "utf8.h"
  12#include "cache-tree.h"
  13#include "diff.h"
  14#include "revision.h"
  15#include "rerere.h"
  16#include "merge-recursive.h"
  17#include "refs.h"
  18#include "argv-array.h"
  19#include "quote.h"
  20#include "trailer.h"
  21#include "log-tree.h"
  22#include "wt-status.h"
  23
  24#define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
  25
  26const char sign_off_header[] = "Signed-off-by: ";
  27static const char cherry_picked_prefix[] = "(cherry picked from commit ";
  28
  29GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
  30
  31static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
  32static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
  33static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
  34static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
  35
  36static GIT_PATH_FUNC(rebase_path, "rebase-merge")
  37/*
  38 * The file containing rebase commands, comments, and empty lines.
  39 * This file is created by "git rebase -i" then edited by the user. As
  40 * the lines are processed, they are removed from the front of this
  41 * file and written to the tail of 'done'.
  42 */
  43static GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
  44/*
  45 * The rebase command lines that have already been processed. A line
  46 * is moved here when it is first handled, before any associated user
  47 * actions.
  48 */
  49static GIT_PATH_FUNC(rebase_path_done, "rebase-merge/done")
  50/*
  51 * The file to keep track of how many commands were already processed (e.g.
  52 * for the prompt).
  53 */
  54static GIT_PATH_FUNC(rebase_path_msgnum, "rebase-merge/msgnum");
  55/*
  56 * The file to keep track of how many commands are to be processed in total
  57 * (e.g. for the prompt).
  58 */
  59static GIT_PATH_FUNC(rebase_path_msgtotal, "rebase-merge/end");
  60/*
  61 * The commit message that is planned to be used for any changes that
  62 * need to be committed following a user interaction.
  63 */
  64static GIT_PATH_FUNC(rebase_path_message, "rebase-merge/message")
  65/*
  66 * The file into which is accumulated the suggested commit message for
  67 * squash/fixup commands. When the first of a series of squash/fixups
  68 * is seen, the file is created and the commit message from the
  69 * previous commit and from the first squash/fixup commit are written
  70 * to it. The commit message for each subsequent squash/fixup commit
  71 * is appended to the file as it is processed.
  72 *
  73 * The first line of the file is of the form
  74 *     # This is a combination of $count commits.
  75 * where $count is the number of commits whose messages have been
  76 * written to the file so far (including the initial "pick" commit).
  77 * Each time that a commit message is processed, this line is read and
  78 * updated. It is deleted just before the combined commit is made.
  79 */
  80static GIT_PATH_FUNC(rebase_path_squash_msg, "rebase-merge/message-squash")
  81/*
  82 * If the current series of squash/fixups has not yet included a squash
  83 * command, then this file exists and holds the commit message of the
  84 * original "pick" commit.  (If the series ends without a "squash"
  85 * command, then this can be used as the commit message of the combined
  86 * commit without opening the editor.)
  87 */
  88static GIT_PATH_FUNC(rebase_path_fixup_msg, "rebase-merge/message-fixup")
  89/*
  90 * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
  91 * GIT_AUTHOR_DATE that will be used for the commit that is currently
  92 * being rebased.
  93 */
  94static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
  95/*
  96 * When an "edit" rebase command is being processed, the SHA1 of the
  97 * commit to be edited is recorded in this file.  When "git rebase
  98 * --continue" is executed, if there are any staged changes then they
  99 * will be amended to the HEAD commit, but only provided the HEAD
 100 * commit is still the commit to be edited.  When any other rebase
 101 * command is processed, this file is deleted.
 102 */
 103static GIT_PATH_FUNC(rebase_path_amend, "rebase-merge/amend")
 104/*
 105 * When we stop at a given patch via the "edit" command, this file contains
 106 * the abbreviated commit name of the corresponding patch.
 107 */
 108static GIT_PATH_FUNC(rebase_path_stopped_sha, "rebase-merge/stopped-sha")
 109/*
 110 * For the post-rewrite hook, we make a list of rewritten commits and
 111 * their new sha1s.  The rewritten-pending list keeps the sha1s of
 112 * commits that have been processed, but not committed yet,
 113 * e.g. because they are waiting for a 'squash' command.
 114 */
 115static GIT_PATH_FUNC(rebase_path_rewritten_list, "rebase-merge/rewritten-list")
 116static GIT_PATH_FUNC(rebase_path_rewritten_pending,
 117        "rebase-merge/rewritten-pending")
 118/*
 119 * The following files are written by git-rebase just after parsing the
 120 * command-line (and are only consumed, not modified, by the sequencer).
 121 */
 122static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
 123static GIT_PATH_FUNC(rebase_path_orig_head, "rebase-merge/orig-head")
 124static GIT_PATH_FUNC(rebase_path_verbose, "rebase-merge/verbose")
 125static GIT_PATH_FUNC(rebase_path_head_name, "rebase-merge/head-name")
 126static GIT_PATH_FUNC(rebase_path_onto, "rebase-merge/onto")
 127static GIT_PATH_FUNC(rebase_path_autostash, "rebase-merge/autostash")
 128static GIT_PATH_FUNC(rebase_path_strategy, "rebase-merge/strategy")
 129static GIT_PATH_FUNC(rebase_path_strategy_opts, "rebase-merge/strategy_opts")
 130static GIT_PATH_FUNC(rebase_path_allow_rerere_autoupdate, "rebase-merge/allow_rerere_autoupdate")
 131
 132static inline int is_rebase_i(const struct replay_opts *opts)
 133{
 134        return opts->action == REPLAY_INTERACTIVE_REBASE;
 135}
 136
 137static const char *get_dir(const struct replay_opts *opts)
 138{
 139        if (is_rebase_i(opts))
 140                return rebase_path();
 141        return git_path_seq_dir();
 142}
 143
 144static const char *get_todo_path(const struct replay_opts *opts)
 145{
 146        if (is_rebase_i(opts))
 147                return rebase_path_todo();
 148        return git_path_todo_file();
 149}
 150
 151/*
 152 * Returns 0 for non-conforming footer
 153 * Returns 1 for conforming footer
 154 * Returns 2 when sob exists within conforming footer
 155 * Returns 3 when sob exists within conforming footer as last entry
 156 */
 157static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
 158        int ignore_footer)
 159{
 160        struct trailer_info info;
 161        int i;
 162        int found_sob = 0, found_sob_last = 0;
 163
 164        trailer_info_get(&info, sb->buf);
 165
 166        if (info.trailer_start == info.trailer_end)
 167                return 0;
 168
 169        for (i = 0; i < info.trailer_nr; i++)
 170                if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
 171                        found_sob = 1;
 172                        if (i == info.trailer_nr - 1)
 173                                found_sob_last = 1;
 174                }
 175
 176        trailer_info_release(&info);
 177
 178        if (found_sob_last)
 179                return 3;
 180        if (found_sob)
 181                return 2;
 182        return 1;
 183}
 184
 185static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
 186{
 187        static struct strbuf buf = STRBUF_INIT;
 188
 189        strbuf_reset(&buf);
 190        if (opts->gpg_sign)
 191                sq_quotef(&buf, "-S%s", opts->gpg_sign);
 192        return buf.buf;
 193}
 194
 195int sequencer_remove_state(struct replay_opts *opts)
 196{
 197        struct strbuf dir = STRBUF_INIT;
 198        int i;
 199
 200        free(opts->gpg_sign);
 201        free(opts->strategy);
 202        for (i = 0; i < opts->xopts_nr; i++)
 203                free(opts->xopts[i]);
 204        free(opts->xopts);
 205
 206        strbuf_addf(&dir, "%s", get_dir(opts));
 207        remove_dir_recursively(&dir, 0);
 208        strbuf_release(&dir);
 209
 210        return 0;
 211}
 212
 213static const char *action_name(const struct replay_opts *opts)
 214{
 215        switch (opts->action) {
 216        case REPLAY_REVERT:
 217                return N_("revert");
 218        case REPLAY_PICK:
 219                return N_("cherry-pick");
 220        case REPLAY_INTERACTIVE_REBASE:
 221                return N_("rebase -i");
 222        }
 223        die(_("Unknown action: %d"), opts->action);
 224}
 225
 226struct commit_message {
 227        char *parent_label;
 228        char *label;
 229        char *subject;
 230        const char *message;
 231};
 232
 233static const char *short_commit_name(struct commit *commit)
 234{
 235        return find_unique_abbrev(commit->object.oid.hash, DEFAULT_ABBREV);
 236}
 237
 238static int get_message(struct commit *commit, struct commit_message *out)
 239{
 240        const char *abbrev, *subject;
 241        int subject_len;
 242
 243        out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
 244        abbrev = short_commit_name(commit);
 245
 246        subject_len = find_commit_subject(out->message, &subject);
 247
 248        out->subject = xmemdupz(subject, subject_len);
 249        out->label = xstrfmt("%s... %s", abbrev, out->subject);
 250        out->parent_label = xstrfmt("parent of %s", out->label);
 251
 252        return 0;
 253}
 254
 255static void free_message(struct commit *commit, struct commit_message *msg)
 256{
 257        free(msg->parent_label);
 258        free(msg->label);
 259        free(msg->subject);
 260        unuse_commit_buffer(commit, msg->message);
 261}
 262
 263static void print_advice(int show_hint, struct replay_opts *opts)
 264{
 265        char *msg = getenv("GIT_CHERRY_PICK_HELP");
 266
 267        if (msg) {
 268                fprintf(stderr, "%s\n", msg);
 269                /*
 270                 * A conflict has occurred but the porcelain
 271                 * (typically rebase --interactive) wants to take care
 272                 * of the commit itself so remove CHERRY_PICK_HEAD
 273                 */
 274                unlink(git_path_cherry_pick_head());
 275                return;
 276        }
 277
 278        if (show_hint) {
 279                if (opts->no_commit)
 280                        advise(_("after resolving the conflicts, mark the corrected paths\n"
 281                                 "with 'git add <paths>' or 'git rm <paths>'"));
 282                else
 283                        advise(_("after resolving the conflicts, mark the corrected paths\n"
 284                                 "with 'git add <paths>' or 'git rm <paths>'\n"
 285                                 "and commit the result with 'git commit'"));
 286        }
 287}
 288
 289static int write_message(const void *buf, size_t len, const char *filename,
 290                         int append_eol)
 291{
 292        static struct lock_file msg_file;
 293
 294        int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
 295        if (msg_fd < 0)
 296                return error_errno(_("could not lock '%s'"), filename);
 297        if (write_in_full(msg_fd, buf, len) < 0) {
 298                rollback_lock_file(&msg_file);
 299                return error_errno(_("could not write to '%s'"), filename);
 300        }
 301        if (append_eol && write(msg_fd, "\n", 1) < 0) {
 302                rollback_lock_file(&msg_file);
 303                return error_errno(_("could not write eol to '%s'"), filename);
 304        }
 305        if (commit_lock_file(&msg_file) < 0) {
 306                rollback_lock_file(&msg_file);
 307                return error(_("failed to finalize '%s'."), filename);
 308        }
 309
 310        return 0;
 311}
 312
 313/*
 314 * Reads a file that was presumably written by a shell script, i.e. with an
 315 * end-of-line marker that needs to be stripped.
 316 *
 317 * Note that only the last end-of-line marker is stripped, consistent with the
 318 * behavior of "$(cat path)" in a shell script.
 319 *
 320 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
 321 */
 322static int read_oneliner(struct strbuf *buf,
 323        const char *path, int skip_if_empty)
 324{
 325        int orig_len = buf->len;
 326
 327        if (!file_exists(path))
 328                return 0;
 329
 330        if (strbuf_read_file(buf, path, 0) < 0) {
 331                warning_errno(_("could not read '%s'"), path);
 332                return 0;
 333        }
 334
 335        if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
 336                if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
 337                        --buf->len;
 338                buf->buf[buf->len] = '\0';
 339        }
 340
 341        if (skip_if_empty && buf->len == orig_len)
 342                return 0;
 343
 344        return 1;
 345}
 346
 347static struct tree *empty_tree(void)
 348{
 349        return lookup_tree(&empty_tree_oid);
 350}
 351
 352static int error_dirty_index(struct replay_opts *opts)
 353{
 354        if (read_cache_unmerged())
 355                return error_resolve_conflict(_(action_name(opts)));
 356
 357        error(_("your local changes would be overwritten by %s."),
 358                _(action_name(opts)));
 359
 360        if (advice_commit_before_merge)
 361                advise(_("commit your changes or stash them to proceed."));
 362        return -1;
 363}
 364
 365static void update_abort_safety_file(void)
 366{
 367        struct object_id head;
 368
 369        /* Do nothing on a single-pick */
 370        if (!file_exists(git_path_seq_dir()))
 371                return;
 372
 373        if (!get_oid("HEAD", &head))
 374                write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
 375        else
 376                write_file(git_path_abort_safety_file(), "%s", "");
 377}
 378
 379static int fast_forward_to(const struct object_id *to, const struct object_id *from,
 380                        int unborn, struct replay_opts *opts)
 381{
 382        struct ref_transaction *transaction;
 383        struct strbuf sb = STRBUF_INIT;
 384        struct strbuf err = STRBUF_INIT;
 385
 386        read_cache();
 387        if (checkout_fast_forward(from, to, 1))
 388                return -1; /* the callee should have complained already */
 389
 390        strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
 391
 392        transaction = ref_transaction_begin(&err);
 393        if (!transaction ||
 394            ref_transaction_update(transaction, "HEAD",
 395                                   to->hash, unborn ? null_sha1 : from->hash,
 396                                   0, sb.buf, &err) ||
 397            ref_transaction_commit(transaction, &err)) {
 398                ref_transaction_free(transaction);
 399                error("%s", err.buf);
 400                strbuf_release(&sb);
 401                strbuf_release(&err);
 402                return -1;
 403        }
 404
 405        strbuf_release(&sb);
 406        strbuf_release(&err);
 407        ref_transaction_free(transaction);
 408        update_abort_safety_file();
 409        return 0;
 410}
 411
 412void append_conflicts_hint(struct strbuf *msgbuf)
 413{
 414        int i;
 415
 416        strbuf_addch(msgbuf, '\n');
 417        strbuf_commented_addf(msgbuf, "Conflicts:\n");
 418        for (i = 0; i < active_nr;) {
 419                const struct cache_entry *ce = active_cache[i++];
 420                if (ce_stage(ce)) {
 421                        strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
 422                        while (i < active_nr && !strcmp(ce->name,
 423                                                        active_cache[i]->name))
 424                                i++;
 425                }
 426        }
 427}
 428
 429static int do_recursive_merge(struct commit *base, struct commit *next,
 430                              const char *base_label, const char *next_label,
 431                              struct object_id *head, struct strbuf *msgbuf,
 432                              struct replay_opts *opts)
 433{
 434        struct merge_options o;
 435        struct tree *result, *next_tree, *base_tree, *head_tree;
 436        int clean;
 437        char **xopt;
 438        static struct lock_file index_lock;
 439
 440        hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
 441
 442        read_cache();
 443
 444        init_merge_options(&o);
 445        o.ancestor = base ? base_label : "(empty tree)";
 446        o.branch1 = "HEAD";
 447        o.branch2 = next ? next_label : "(empty tree)";
 448        if (is_rebase_i(opts))
 449                o.buffer_output = 2;
 450
 451        head_tree = parse_tree_indirect(head);
 452        next_tree = next ? next->tree : empty_tree();
 453        base_tree = base ? base->tree : empty_tree();
 454
 455        for (xopt = opts->xopts; xopt != opts->xopts + opts->xopts_nr; xopt++)
 456                parse_merge_opt(&o, *xopt);
 457
 458        clean = merge_trees(&o,
 459                            head_tree,
 460                            next_tree, base_tree, &result);
 461        if (is_rebase_i(opts) && clean <= 0)
 462                fputs(o.obuf.buf, stdout);
 463        strbuf_release(&o.obuf);
 464        if (clean < 0)
 465                return clean;
 466
 467        if (active_cache_changed &&
 468            write_locked_index(&the_index, &index_lock, COMMIT_LOCK))
 469                /*
 470                 * TRANSLATORS: %s will be "revert", "cherry-pick" or
 471                 * "rebase -i".
 472                 */
 473                return error(_("%s: Unable to write new index file"),
 474                        _(action_name(opts)));
 475        rollback_lock_file(&index_lock);
 476
 477        if (opts->signoff)
 478                append_signoff(msgbuf, 0, 0);
 479
 480        if (!clean)
 481                append_conflicts_hint(msgbuf);
 482
 483        return !clean;
 484}
 485
 486static int is_index_unchanged(void)
 487{
 488        struct object_id head_oid;
 489        struct commit *head_commit;
 490
 491        if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, head_oid.hash, NULL))
 492                return error(_("could not resolve HEAD commit\n"));
 493
 494        head_commit = lookup_commit(&head_oid);
 495
 496        /*
 497         * If head_commit is NULL, check_commit, called from
 498         * lookup_commit, would have indicated that head_commit is not
 499         * a commit object already.  parse_commit() will return failure
 500         * without further complaints in such a case.  Otherwise, if
 501         * the commit is invalid, parse_commit() will complain.  So
 502         * there is nothing for us to say here.  Just return failure.
 503         */
 504        if (parse_commit(head_commit))
 505                return -1;
 506
 507        if (!active_cache_tree)
 508                active_cache_tree = cache_tree();
 509
 510        if (!cache_tree_fully_valid(active_cache_tree))
 511                if (cache_tree_update(&the_index, 0))
 512                        return error(_("unable to update cache tree\n"));
 513
 514        return !oidcmp(&active_cache_tree->oid,
 515                       &head_commit->tree->object.oid);
 516}
 517
 518static int write_author_script(const char *message)
 519{
 520        struct strbuf buf = STRBUF_INIT;
 521        const char *eol;
 522        int res;
 523
 524        for (;;)
 525                if (!*message || starts_with(message, "\n")) {
 526missing_author:
 527                        /* Missing 'author' line? */
 528                        unlink(rebase_path_author_script());
 529                        return 0;
 530                } else if (skip_prefix(message, "author ", &message))
 531                        break;
 532                else if ((eol = strchr(message, '\n')))
 533                        message = eol + 1;
 534                else
 535                        goto missing_author;
 536
 537        strbuf_addstr(&buf, "GIT_AUTHOR_NAME='");
 538        while (*message && *message != '\n' && *message != '\r')
 539                if (skip_prefix(message, " <", &message))
 540                        break;
 541                else if (*message != '\'')
 542                        strbuf_addch(&buf, *(message++));
 543                else
 544                        strbuf_addf(&buf, "'\\\\%c'", *(message++));
 545        strbuf_addstr(&buf, "'\nGIT_AUTHOR_EMAIL='");
 546        while (*message && *message != '\n' && *message != '\r')
 547                if (skip_prefix(message, "> ", &message))
 548                        break;
 549                else if (*message != '\'')
 550                        strbuf_addch(&buf, *(message++));
 551                else
 552                        strbuf_addf(&buf, "'\\\\%c'", *(message++));
 553        strbuf_addstr(&buf, "'\nGIT_AUTHOR_DATE='@");
 554        while (*message && *message != '\n' && *message != '\r')
 555                if (*message != '\'')
 556                        strbuf_addch(&buf, *(message++));
 557                else
 558                        strbuf_addf(&buf, "'\\\\%c'", *(message++));
 559        res = write_message(buf.buf, buf.len, rebase_path_author_script(), 1);
 560        strbuf_release(&buf);
 561        return res;
 562}
 563
 564/*
 565 * Read a list of environment variable assignments (such as the author-script
 566 * file) into an environment block. Returns -1 on error, 0 otherwise.
 567 */
 568static int read_env_script(struct argv_array *env)
 569{
 570        struct strbuf script = STRBUF_INIT;
 571        int i, count = 0;
 572        char *p, *p2;
 573
 574        if (strbuf_read_file(&script, rebase_path_author_script(), 256) <= 0)
 575                return -1;
 576
 577        for (p = script.buf; *p; p++)
 578                if (skip_prefix(p, "'\\\\''", (const char **)&p2))
 579                        strbuf_splice(&script, p - script.buf, p2 - p, "'", 1);
 580                else if (*p == '\'')
 581                        strbuf_splice(&script, p-- - script.buf, 1, "", 0);
 582                else if (*p == '\n') {
 583                        *p = '\0';
 584                        count++;
 585                }
 586
 587        for (i = 0, p = script.buf; i < count; i++) {
 588                argv_array_push(env, p);
 589                p += strlen(p) + 1;
 590        }
 591
 592        return 0;
 593}
 594
 595static const char staged_changes_advice[] =
 596N_("you have staged changes in your working tree\n"
 597"If these changes are meant to be squashed into the previous commit, run:\n"
 598"\n"
 599"  git commit --amend %s\n"
 600"\n"
 601"If they are meant to go into a new commit, run:\n"
 602"\n"
 603"  git commit %s\n"
 604"\n"
 605"In both cases, once you're done, continue with:\n"
 606"\n"
 607"  git rebase --continue\n");
 608
 609#define ALLOW_EMPTY (1<<0)
 610#define EDIT_MSG    (1<<1)
 611#define AMEND_MSG   (1<<2)
 612#define CLEANUP_MSG (1<<3)
 613#define VERIFY_MSG  (1<<4)
 614
 615/*
 616 * If we are cherry-pick, and if the merge did not result in
 617 * hand-editing, we will hit this commit and inherit the original
 618 * author date and name.
 619 *
 620 * If we are revert, or if our cherry-pick results in a hand merge,
 621 * we had better say that the current user is responsible for that.
 622 *
 623 * An exception is when run_git_commit() is called during an
 624 * interactive rebase: in that case, we will want to retain the
 625 * author metadata.
 626 */
 627static int run_git_commit(const char *defmsg, struct replay_opts *opts,
 628                          unsigned int flags)
 629{
 630        struct child_process cmd = CHILD_PROCESS_INIT;
 631        const char *value;
 632
 633        cmd.git_cmd = 1;
 634
 635        if (is_rebase_i(opts)) {
 636                if (!(flags & EDIT_MSG)) {
 637                        cmd.stdout_to_stderr = 1;
 638                        cmd.err = -1;
 639                }
 640
 641                if (read_env_script(&cmd.env_array)) {
 642                        const char *gpg_opt = gpg_sign_opt_quoted(opts);
 643
 644                        return error(_(staged_changes_advice),
 645                                     gpg_opt, gpg_opt);
 646                }
 647        }
 648
 649        argv_array_push(&cmd.args, "commit");
 650
 651        if (!(flags & VERIFY_MSG))
 652                argv_array_push(&cmd.args, "-n");
 653        if ((flags & AMEND_MSG))
 654                argv_array_push(&cmd.args, "--amend");
 655        if (opts->gpg_sign)
 656                argv_array_pushf(&cmd.args, "-S%s", opts->gpg_sign);
 657        if (opts->signoff)
 658                argv_array_push(&cmd.args, "-s");
 659        if (defmsg)
 660                argv_array_pushl(&cmd.args, "-F", defmsg, NULL);
 661        if ((flags & CLEANUP_MSG))
 662                argv_array_push(&cmd.args, "--cleanup=strip");
 663        if ((flags & EDIT_MSG))
 664                argv_array_push(&cmd.args, "-e");
 665        else if (!(flags & CLEANUP_MSG) &&
 666                 !opts->signoff && !opts->record_origin &&
 667                 git_config_get_value("commit.cleanup", &value))
 668                argv_array_push(&cmd.args, "--cleanup=verbatim");
 669
 670        if ((flags & ALLOW_EMPTY))
 671                argv_array_push(&cmd.args, "--allow-empty");
 672
 673        if (opts->allow_empty_message)
 674                argv_array_push(&cmd.args, "--allow-empty-message");
 675
 676        if (cmd.err == -1) {
 677                /* hide stderr on success */
 678                struct strbuf buf = STRBUF_INIT;
 679                int rc = pipe_command(&cmd,
 680                                      NULL, 0,
 681                                      /* stdout is already redirected */
 682                                      NULL, 0,
 683                                      &buf, 0);
 684                if (rc)
 685                        fputs(buf.buf, stderr);
 686                strbuf_release(&buf);
 687                return rc;
 688        }
 689
 690        return run_command(&cmd);
 691}
 692
 693static int is_original_commit_empty(struct commit *commit)
 694{
 695        const unsigned char *ptree_sha1;
 696
 697        if (parse_commit(commit))
 698                return error(_("could not parse commit %s\n"),
 699                             oid_to_hex(&commit->object.oid));
 700        if (commit->parents) {
 701                struct commit *parent = commit->parents->item;
 702                if (parse_commit(parent))
 703                        return error(_("could not parse parent commit %s\n"),
 704                                oid_to_hex(&parent->object.oid));
 705                ptree_sha1 = parent->tree->object.oid.hash;
 706        } else {
 707                ptree_sha1 = EMPTY_TREE_SHA1_BIN; /* commit is root */
 708        }
 709
 710        return !hashcmp(ptree_sha1, commit->tree->object.oid.hash);
 711}
 712
 713/*
 714 * Do we run "git commit" with "--allow-empty"?
 715 */
 716static int allow_empty(struct replay_opts *opts, struct commit *commit)
 717{
 718        int index_unchanged, empty_commit;
 719
 720        /*
 721         * Three cases:
 722         *
 723         * (1) we do not allow empty at all and error out.
 724         *
 725         * (2) we allow ones that were initially empty, but
 726         * forbid the ones that become empty;
 727         *
 728         * (3) we allow both.
 729         */
 730        if (!opts->allow_empty)
 731                return 0; /* let "git commit" barf as necessary */
 732
 733        index_unchanged = is_index_unchanged();
 734        if (index_unchanged < 0)
 735                return index_unchanged;
 736        if (!index_unchanged)
 737                return 0; /* we do not have to say --allow-empty */
 738
 739        if (opts->keep_redundant_commits)
 740                return 1;
 741
 742        empty_commit = is_original_commit_empty(commit);
 743        if (empty_commit < 0)
 744                return empty_commit;
 745        if (!empty_commit)
 746                return 0;
 747        else
 748                return 1;
 749}
 750
 751/*
 752 * Note that ordering matters in this enum. Not only must it match the mapping
 753 * below, it is also divided into several sections that matter.  When adding
 754 * new commands, make sure you add it in the right section.
 755 */
 756enum todo_command {
 757        /* commands that handle commits */
 758        TODO_PICK = 0,
 759        TODO_REVERT,
 760        TODO_EDIT,
 761        TODO_REWORD,
 762        TODO_FIXUP,
 763        TODO_SQUASH,
 764        /* commands that do something else than handling a single commit */
 765        TODO_EXEC,
 766        /* commands that do nothing but are counted for reporting progress */
 767        TODO_NOOP,
 768        TODO_DROP,
 769        /* comments (not counted for reporting progress) */
 770        TODO_COMMENT
 771};
 772
 773static struct {
 774        char c;
 775        const char *str;
 776} todo_command_info[] = {
 777        { 'p', "pick" },
 778        { 0,   "revert" },
 779        { 'e', "edit" },
 780        { 'r', "reword" },
 781        { 'f', "fixup" },
 782        { 's', "squash" },
 783        { 'x', "exec" },
 784        { 0,   "noop" },
 785        { 'd', "drop" },
 786        { 0,   NULL }
 787};
 788
 789static const char *command_to_string(const enum todo_command command)
 790{
 791        if (command < TODO_COMMENT)
 792                return todo_command_info[command].str;
 793        die("Unknown command: %d", command);
 794}
 795
 796static int is_noop(const enum todo_command command)
 797{
 798        return TODO_NOOP <= command;
 799}
 800
 801static int is_fixup(enum todo_command command)
 802{
 803        return command == TODO_FIXUP || command == TODO_SQUASH;
 804}
 805
 806static int update_squash_messages(enum todo_command command,
 807                struct commit *commit, struct replay_opts *opts)
 808{
 809        struct strbuf buf = STRBUF_INIT;
 810        int count, res;
 811        const char *message, *body;
 812
 813        if (file_exists(rebase_path_squash_msg())) {
 814                struct strbuf header = STRBUF_INIT;
 815                char *eol, *p;
 816
 817                if (strbuf_read_file(&buf, rebase_path_squash_msg(), 2048) <= 0)
 818                        return error(_("could not read '%s'"),
 819                                rebase_path_squash_msg());
 820
 821                p = buf.buf + 1;
 822                eol = strchrnul(buf.buf, '\n');
 823                if (buf.buf[0] != comment_line_char ||
 824                    (p += strcspn(p, "0123456789\n")) == eol)
 825                        return error(_("unexpected 1st line of squash message:"
 826                                       "\n\n\t%.*s"),
 827                                     (int)(eol - buf.buf), buf.buf);
 828                count = strtol(p, NULL, 10);
 829
 830                if (count < 1)
 831                        return error(_("invalid 1st line of squash message:\n"
 832                                       "\n\t%.*s"),
 833                                     (int)(eol - buf.buf), buf.buf);
 834
 835                strbuf_addf(&header, "%c ", comment_line_char);
 836                strbuf_addf(&header,
 837                            _("This is a combination of %d commits."), ++count);
 838                strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
 839                strbuf_release(&header);
 840        } else {
 841                struct object_id head;
 842                struct commit *head_commit;
 843                const char *head_message, *body;
 844
 845                if (get_oid("HEAD", &head))
 846                        return error(_("need a HEAD to fixup"));
 847                if (!(head_commit = lookup_commit_reference(&head)))
 848                        return error(_("could not read HEAD"));
 849                if (!(head_message = get_commit_buffer(head_commit, NULL)))
 850                        return error(_("could not read HEAD's commit message"));
 851
 852                find_commit_subject(head_message, &body);
 853                if (write_message(body, strlen(body),
 854                                  rebase_path_fixup_msg(), 0)) {
 855                        unuse_commit_buffer(head_commit, head_message);
 856                        return error(_("cannot write '%s'"),
 857                                     rebase_path_fixup_msg());
 858                }
 859
 860                count = 2;
 861                strbuf_addf(&buf, "%c ", comment_line_char);
 862                strbuf_addf(&buf, _("This is a combination of %d commits."),
 863                            count);
 864                strbuf_addf(&buf, "\n%c ", comment_line_char);
 865                strbuf_addstr(&buf, _("This is the 1st commit message:"));
 866                strbuf_addstr(&buf, "\n\n");
 867                strbuf_addstr(&buf, body);
 868
 869                unuse_commit_buffer(head_commit, head_message);
 870        }
 871
 872        if (!(message = get_commit_buffer(commit, NULL)))
 873                return error(_("could not read commit message of %s"),
 874                             oid_to_hex(&commit->object.oid));
 875        find_commit_subject(message, &body);
 876
 877        if (command == TODO_SQUASH) {
 878                unlink(rebase_path_fixup_msg());
 879                strbuf_addf(&buf, "\n%c ", comment_line_char);
 880                strbuf_addf(&buf, _("This is the commit message #%d:"), count);
 881                strbuf_addstr(&buf, "\n\n");
 882                strbuf_addstr(&buf, body);
 883        } else if (command == TODO_FIXUP) {
 884                strbuf_addf(&buf, "\n%c ", comment_line_char);
 885                strbuf_addf(&buf, _("The commit message #%d will be skipped:"),
 886                            count);
 887                strbuf_addstr(&buf, "\n\n");
 888                strbuf_add_commented_lines(&buf, body, strlen(body));
 889        } else
 890                return error(_("unknown command: %d"), command);
 891        unuse_commit_buffer(commit, message);
 892
 893        res = write_message(buf.buf, buf.len, rebase_path_squash_msg(), 0);
 894        strbuf_release(&buf);
 895        return res;
 896}
 897
 898static void flush_rewritten_pending(void) {
 899        struct strbuf buf = STRBUF_INIT;
 900        unsigned char newsha1[20];
 901        FILE *out;
 902
 903        if (strbuf_read_file(&buf, rebase_path_rewritten_pending(), 82) > 0 &&
 904            !get_sha1("HEAD", newsha1) &&
 905            (out = fopen_or_warn(rebase_path_rewritten_list(), "a"))) {
 906                char *bol = buf.buf, *eol;
 907
 908                while (*bol) {
 909                        eol = strchrnul(bol, '\n');
 910                        fprintf(out, "%.*s %s\n", (int)(eol - bol),
 911                                        bol, sha1_to_hex(newsha1));
 912                        if (!*eol)
 913                                break;
 914                        bol = eol + 1;
 915                }
 916                fclose(out);
 917                unlink(rebase_path_rewritten_pending());
 918        }
 919        strbuf_release(&buf);
 920}
 921
 922static void record_in_rewritten(struct object_id *oid,
 923                enum todo_command next_command) {
 924        FILE *out = fopen_or_warn(rebase_path_rewritten_pending(), "a");
 925
 926        if (!out)
 927                return;
 928
 929        fprintf(out, "%s\n", oid_to_hex(oid));
 930        fclose(out);
 931
 932        if (!is_fixup(next_command))
 933                flush_rewritten_pending();
 934}
 935
 936static int do_pick_commit(enum todo_command command, struct commit *commit,
 937                struct replay_opts *opts, int final_fixup)
 938{
 939        unsigned int flags = opts->edit ? EDIT_MSG : 0;
 940        const char *msg_file = opts->edit ? NULL : git_path_merge_msg();
 941        struct object_id head;
 942        struct commit *base, *next, *parent;
 943        const char *base_label, *next_label;
 944        struct commit_message msg = { NULL, NULL, NULL, NULL };
 945        struct strbuf msgbuf = STRBUF_INIT;
 946        int res, unborn = 0, allow;
 947
 948        if (opts->no_commit) {
 949                /*
 950                 * We do not intend to commit immediately.  We just want to
 951                 * merge the differences in, so let's compute the tree
 952                 * that represents the "current" state for merge-recursive
 953                 * to work on.
 954                 */
 955                if (write_cache_as_tree(head.hash, 0, NULL))
 956                        return error(_("your index file is unmerged."));
 957        } else {
 958                unborn = get_oid("HEAD", &head);
 959                if (unborn)
 960                        oidcpy(&head, &empty_tree_oid);
 961                if (index_differs_from(unborn ? EMPTY_TREE_SHA1_HEX : "HEAD", 0, 0))
 962                        return error_dirty_index(opts);
 963        }
 964        discard_cache();
 965
 966        if (!commit->parents)
 967                parent = NULL;
 968        else if (commit->parents->next) {
 969                /* Reverting or cherry-picking a merge commit */
 970                int cnt;
 971                struct commit_list *p;
 972
 973                if (!opts->mainline)
 974                        return error(_("commit %s is a merge but no -m option was given."),
 975                                oid_to_hex(&commit->object.oid));
 976
 977                for (cnt = 1, p = commit->parents;
 978                     cnt != opts->mainline && p;
 979                     cnt++)
 980                        p = p->next;
 981                if (cnt != opts->mainline || !p)
 982                        return error(_("commit %s does not have parent %d"),
 983                                oid_to_hex(&commit->object.oid), opts->mainline);
 984                parent = p->item;
 985        } else if (0 < opts->mainline)
 986                return error(_("mainline was specified but commit %s is not a merge."),
 987                        oid_to_hex(&commit->object.oid));
 988        else
 989                parent = commit->parents->item;
 990
 991        if (get_message(commit, &msg) != 0)
 992                return error(_("cannot get commit message for %s"),
 993                        oid_to_hex(&commit->object.oid));
 994
 995        if (opts->allow_ff && !is_fixup(command) &&
 996            ((parent && !oidcmp(&parent->object.oid, &head)) ||
 997             (!parent && unborn))) {
 998                if (is_rebase_i(opts))
 999                        write_author_script(msg.message);
1000                res = fast_forward_to(&commit->object.oid, &head, unborn,
1001                        opts);
1002                if (res || command != TODO_REWORD)
1003                        goto leave;
1004                flags |= EDIT_MSG | AMEND_MSG;
1005                if (command == TODO_REWORD)
1006                        flags |= VERIFY_MSG;
1007                msg_file = NULL;
1008                goto fast_forward_edit;
1009        }
1010        if (parent && parse_commit(parent) < 0)
1011                /* TRANSLATORS: The first %s will be a "todo" command like
1012                   "revert" or "pick", the second %s a SHA1. */
1013                return error(_("%s: cannot parse parent commit %s"),
1014                        command_to_string(command),
1015                        oid_to_hex(&parent->object.oid));
1016
1017        /*
1018         * "commit" is an existing commit.  We would want to apply
1019         * the difference it introduces since its first parent "prev"
1020         * on top of the current HEAD if we are cherry-pick.  Or the
1021         * reverse of it if we are revert.
1022         */
1023
1024        if (command == TODO_REVERT) {
1025                base = commit;
1026                base_label = msg.label;
1027                next = parent;
1028                next_label = msg.parent_label;
1029                strbuf_addstr(&msgbuf, "Revert \"");
1030                strbuf_addstr(&msgbuf, msg.subject);
1031                strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
1032                strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1033
1034                if (commit->parents && commit->parents->next) {
1035                        strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
1036                        strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
1037                }
1038                strbuf_addstr(&msgbuf, ".\n");
1039        } else {
1040                const char *p;
1041
1042                base = parent;
1043                base_label = msg.parent_label;
1044                next = commit;
1045                next_label = msg.label;
1046
1047                /* Append the commit log message to msgbuf. */
1048                if (find_commit_subject(msg.message, &p))
1049                        strbuf_addstr(&msgbuf, p);
1050
1051                if (opts->record_origin) {
1052                        strbuf_complete_line(&msgbuf);
1053                        if (!has_conforming_footer(&msgbuf, NULL, 0))
1054                                strbuf_addch(&msgbuf, '\n');
1055                        strbuf_addstr(&msgbuf, cherry_picked_prefix);
1056                        strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1057                        strbuf_addstr(&msgbuf, ")\n");
1058                }
1059        }
1060
1061        if (command == TODO_REWORD)
1062                flags |= EDIT_MSG | VERIFY_MSG;
1063        else if (is_fixup(command)) {
1064                if (update_squash_messages(command, commit, opts))
1065                        return -1;
1066                flags |= AMEND_MSG;
1067                if (!final_fixup)
1068                        msg_file = rebase_path_squash_msg();
1069                else if (file_exists(rebase_path_fixup_msg())) {
1070                        flags |= CLEANUP_MSG;
1071                        msg_file = rebase_path_fixup_msg();
1072                } else {
1073                        const char *dest = git_path_squash_msg();
1074                        unlink(dest);
1075                        if (copy_file(dest, rebase_path_squash_msg(), 0666))
1076                                return error(_("could not rename '%s' to '%s'"),
1077                                             rebase_path_squash_msg(), dest);
1078                        unlink(git_path_merge_msg());
1079                        msg_file = dest;
1080                        flags |= EDIT_MSG;
1081                }
1082        }
1083
1084        if (is_rebase_i(opts) && write_author_script(msg.message) < 0)
1085                res = -1;
1086        else if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
1087                res = do_recursive_merge(base, next, base_label, next_label,
1088                                         &head, &msgbuf, opts);
1089                if (res < 0)
1090                        return res;
1091                res |= write_message(msgbuf.buf, msgbuf.len,
1092                                     git_path_merge_msg(), 0);
1093        } else {
1094                struct commit_list *common = NULL;
1095                struct commit_list *remotes = NULL;
1096
1097                res = write_message(msgbuf.buf, msgbuf.len,
1098                                    git_path_merge_msg(), 0);
1099
1100                commit_list_insert(base, &common);
1101                commit_list_insert(next, &remotes);
1102                res |= try_merge_command(opts->strategy,
1103                                         opts->xopts_nr, (const char **)opts->xopts,
1104                                        common, oid_to_hex(&head), remotes);
1105                free_commit_list(common);
1106                free_commit_list(remotes);
1107        }
1108        strbuf_release(&msgbuf);
1109
1110        /*
1111         * If the merge was clean or if it failed due to conflict, we write
1112         * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
1113         * However, if the merge did not even start, then we don't want to
1114         * write it at all.
1115         */
1116        if (command == TODO_PICK && !opts->no_commit && (res == 0 || res == 1) &&
1117            update_ref(NULL, "CHERRY_PICK_HEAD", commit->object.oid.hash, NULL,
1118                       REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
1119                res = -1;
1120        if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
1121            update_ref(NULL, "REVERT_HEAD", commit->object.oid.hash, NULL,
1122                       REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
1123                res = -1;
1124
1125        if (res) {
1126                error(command == TODO_REVERT
1127                      ? _("could not revert %s... %s")
1128                      : _("could not apply %s... %s"),
1129                      short_commit_name(commit), msg.subject);
1130                print_advice(res == 1, opts);
1131                rerere(opts->allow_rerere_auto);
1132                goto leave;
1133        }
1134
1135        allow = allow_empty(opts, commit);
1136        if (allow < 0) {
1137                res = allow;
1138                goto leave;
1139        } else if (allow)
1140                flags |= ALLOW_EMPTY;
1141        if (!opts->no_commit)
1142fast_forward_edit:
1143                res = run_git_commit(msg_file, opts, flags);
1144
1145        if (!res && final_fixup) {
1146                unlink(rebase_path_fixup_msg());
1147                unlink(rebase_path_squash_msg());
1148        }
1149
1150leave:
1151        free_message(commit, &msg);
1152        update_abort_safety_file();
1153
1154        return res;
1155}
1156
1157static int prepare_revs(struct replay_opts *opts)
1158{
1159        /*
1160         * picking (but not reverting) ranges (but not individual revisions)
1161         * should be done in reverse
1162         */
1163        if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
1164                opts->revs->reverse ^= 1;
1165
1166        if (prepare_revision_walk(opts->revs))
1167                return error(_("revision walk setup failed"));
1168
1169        if (!opts->revs->commits)
1170                return error(_("empty commit set passed"));
1171        return 0;
1172}
1173
1174static int read_and_refresh_cache(struct replay_opts *opts)
1175{
1176        static struct lock_file index_lock;
1177        int index_fd = hold_locked_index(&index_lock, 0);
1178        if (read_index_preload(&the_index, NULL) < 0) {
1179                rollback_lock_file(&index_lock);
1180                return error(_("git %s: failed to read the index"),
1181                        _(action_name(opts)));
1182        }
1183        refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
1184        if (the_index.cache_changed && index_fd >= 0) {
1185                if (write_locked_index(&the_index, &index_lock, COMMIT_LOCK)) {
1186                        rollback_lock_file(&index_lock);
1187                        return error(_("git %s: failed to refresh the index"),
1188                                _(action_name(opts)));
1189                }
1190        }
1191        rollback_lock_file(&index_lock);
1192        return 0;
1193}
1194
1195struct todo_item {
1196        enum todo_command command;
1197        struct commit *commit;
1198        const char *arg;
1199        int arg_len;
1200        size_t offset_in_buf;
1201};
1202
1203struct todo_list {
1204        struct strbuf buf;
1205        struct todo_item *items;
1206        int nr, alloc, current;
1207        int done_nr, total_nr;
1208        struct stat_data stat;
1209};
1210
1211#define TODO_LIST_INIT { STRBUF_INIT }
1212
1213static void todo_list_release(struct todo_list *todo_list)
1214{
1215        strbuf_release(&todo_list->buf);
1216        FREE_AND_NULL(todo_list->items);
1217        todo_list->nr = todo_list->alloc = 0;
1218}
1219
1220static struct todo_item *append_new_todo(struct todo_list *todo_list)
1221{
1222        ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
1223        return todo_list->items + todo_list->nr++;
1224}
1225
1226static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
1227{
1228        struct object_id commit_oid;
1229        char *end_of_object_name;
1230        int i, saved, status, padding;
1231
1232        /* left-trim */
1233        bol += strspn(bol, " \t");
1234
1235        if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
1236                item->command = TODO_COMMENT;
1237                item->commit = NULL;
1238                item->arg = bol;
1239                item->arg_len = eol - bol;
1240                return 0;
1241        }
1242
1243        for (i = 0; i < TODO_COMMENT; i++)
1244                if (skip_prefix(bol, todo_command_info[i].str, &bol)) {
1245                        item->command = i;
1246                        break;
1247                } else if (bol[1] == ' ' && *bol == todo_command_info[i].c) {
1248                        bol++;
1249                        item->command = i;
1250                        break;
1251                }
1252        if (i >= TODO_COMMENT)
1253                return -1;
1254
1255        if (item->command == TODO_NOOP) {
1256                item->commit = NULL;
1257                item->arg = bol;
1258                item->arg_len = eol - bol;
1259                return 0;
1260        }
1261
1262        /* Eat up extra spaces/ tabs before object name */
1263        padding = strspn(bol, " \t");
1264        if (!padding)
1265                return -1;
1266        bol += padding;
1267
1268        if (item->command == TODO_EXEC) {
1269                item->arg = bol;
1270                item->arg_len = (int)(eol - bol);
1271                return 0;
1272        }
1273
1274        end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
1275        saved = *end_of_object_name;
1276        *end_of_object_name = '\0';
1277        status = get_oid(bol, &commit_oid);
1278        *end_of_object_name = saved;
1279
1280        item->arg = end_of_object_name + strspn(end_of_object_name, " \t");
1281        item->arg_len = (int)(eol - item->arg);
1282
1283        if (status < 0)
1284                return -1;
1285
1286        item->commit = lookup_commit_reference(&commit_oid);
1287        return !item->commit;
1288}
1289
1290static int parse_insn_buffer(char *buf, struct todo_list *todo_list)
1291{
1292        struct todo_item *item;
1293        char *p = buf, *next_p;
1294        int i, res = 0, fixup_okay = file_exists(rebase_path_done());
1295
1296        for (i = 1; *p; i++, p = next_p) {
1297                char *eol = strchrnul(p, '\n');
1298
1299                next_p = *eol ? eol + 1 /* skip LF */ : eol;
1300
1301                if (p != eol && eol[-1] == '\r')
1302                        eol--; /* strip Carriage Return */
1303
1304                item = append_new_todo(todo_list);
1305                item->offset_in_buf = p - todo_list->buf.buf;
1306                if (parse_insn_line(item, p, eol)) {
1307                        res = error(_("invalid line %d: %.*s"),
1308                                i, (int)(eol - p), p);
1309                        item->command = TODO_NOOP;
1310                }
1311
1312                if (fixup_okay)
1313                        ; /* do nothing */
1314                else if (is_fixup(item->command))
1315                        return error(_("cannot '%s' without a previous commit"),
1316                                command_to_string(item->command));
1317                else if (!is_noop(item->command))
1318                        fixup_okay = 1;
1319        }
1320
1321        return res;
1322}
1323
1324static int count_commands(struct todo_list *todo_list)
1325{
1326        int count = 0, i;
1327
1328        for (i = 0; i < todo_list->nr; i++)
1329                if (todo_list->items[i].command != TODO_COMMENT)
1330                        count++;
1331
1332        return count;
1333}
1334
1335static int read_populate_todo(struct todo_list *todo_list,
1336                        struct replay_opts *opts)
1337{
1338        struct stat st;
1339        const char *todo_file = get_todo_path(opts);
1340        int fd, res;
1341
1342        strbuf_reset(&todo_list->buf);
1343        fd = open(todo_file, O_RDONLY);
1344        if (fd < 0)
1345                return error_errno(_("could not open '%s'"), todo_file);
1346        if (strbuf_read(&todo_list->buf, fd, 0) < 0) {
1347                close(fd);
1348                return error(_("could not read '%s'."), todo_file);
1349        }
1350        close(fd);
1351
1352        res = stat(todo_file, &st);
1353        if (res)
1354                return error(_("could not stat '%s'"), todo_file);
1355        fill_stat_data(&todo_list->stat, &st);
1356
1357        res = parse_insn_buffer(todo_list->buf.buf, todo_list);
1358        if (res) {
1359                if (is_rebase_i(opts))
1360                        return error(_("please fix this using "
1361                                       "'git rebase --edit-todo'."));
1362                return error(_("unusable instruction sheet: '%s'"), todo_file);
1363        }
1364
1365        if (!todo_list->nr &&
1366            (!is_rebase_i(opts) || !file_exists(rebase_path_done())))
1367                return error(_("no commits parsed."));
1368
1369        if (!is_rebase_i(opts)) {
1370                enum todo_command valid =
1371                        opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
1372                int i;
1373
1374                for (i = 0; i < todo_list->nr; i++)
1375                        if (valid == todo_list->items[i].command)
1376                                continue;
1377                        else if (valid == TODO_PICK)
1378                                return error(_("cannot cherry-pick during a revert."));
1379                        else
1380                                return error(_("cannot revert during a cherry-pick."));
1381        }
1382
1383        if (is_rebase_i(opts)) {
1384                struct todo_list done = TODO_LIST_INIT;
1385                FILE *f = fopen_or_warn(rebase_path_msgtotal(), "w");
1386
1387                if (strbuf_read_file(&done.buf, rebase_path_done(), 0) > 0 &&
1388                                !parse_insn_buffer(done.buf.buf, &done))
1389                        todo_list->done_nr = count_commands(&done);
1390                else
1391                        todo_list->done_nr = 0;
1392
1393                todo_list->total_nr = todo_list->done_nr
1394                        + count_commands(todo_list);
1395                todo_list_release(&done);
1396
1397                if (f) {
1398                        fprintf(f, "%d\n", todo_list->total_nr);
1399                        fclose(f);
1400                }
1401        }
1402
1403        return 0;
1404}
1405
1406static int git_config_string_dup(char **dest,
1407                                 const char *var, const char *value)
1408{
1409        if (!value)
1410                return config_error_nonbool(var);
1411        free(*dest);
1412        *dest = xstrdup(value);
1413        return 0;
1414}
1415
1416static int populate_opts_cb(const char *key, const char *value, void *data)
1417{
1418        struct replay_opts *opts = data;
1419        int error_flag = 1;
1420
1421        if (!value)
1422                error_flag = 0;
1423        else if (!strcmp(key, "options.no-commit"))
1424                opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
1425        else if (!strcmp(key, "options.edit"))
1426                opts->edit = git_config_bool_or_int(key, value, &error_flag);
1427        else if (!strcmp(key, "options.signoff"))
1428                opts->signoff = git_config_bool_or_int(key, value, &error_flag);
1429        else if (!strcmp(key, "options.record-origin"))
1430                opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
1431        else if (!strcmp(key, "options.allow-ff"))
1432                opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
1433        else if (!strcmp(key, "options.mainline"))
1434                opts->mainline = git_config_int(key, value);
1435        else if (!strcmp(key, "options.strategy"))
1436                git_config_string_dup(&opts->strategy, key, value);
1437        else if (!strcmp(key, "options.gpg-sign"))
1438                git_config_string_dup(&opts->gpg_sign, key, value);
1439        else if (!strcmp(key, "options.strategy-option")) {
1440                ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
1441                opts->xopts[opts->xopts_nr++] = xstrdup(value);
1442        } else
1443                return error(_("invalid key: %s"), key);
1444
1445        if (!error_flag)
1446                return error(_("invalid value for %s: %s"), key, value);
1447
1448        return 0;
1449}
1450
1451static void read_strategy_opts(struct replay_opts *opts, struct strbuf *buf)
1452{
1453        int i;
1454
1455        strbuf_reset(buf);
1456        if (!read_oneliner(buf, rebase_path_strategy(), 0))
1457                return;
1458        opts->strategy = strbuf_detach(buf, NULL);
1459        if (!read_oneliner(buf, rebase_path_strategy_opts(), 0))
1460                return;
1461
1462        opts->xopts_nr = split_cmdline(buf->buf, (const char ***)&opts->xopts);
1463        for (i = 0; i < opts->xopts_nr; i++) {
1464                const char *arg = opts->xopts[i];
1465
1466                skip_prefix(arg, "--", &arg);
1467                opts->xopts[i] = xstrdup(arg);
1468        }
1469}
1470
1471static int read_populate_opts(struct replay_opts *opts)
1472{
1473        if (is_rebase_i(opts)) {
1474                struct strbuf buf = STRBUF_INIT;
1475
1476                if (read_oneliner(&buf, rebase_path_gpg_sign_opt(), 1)) {
1477                        if (!starts_with(buf.buf, "-S"))
1478                                strbuf_reset(&buf);
1479                        else {
1480                                free(opts->gpg_sign);
1481                                opts->gpg_sign = xstrdup(buf.buf + 2);
1482                        }
1483                        strbuf_reset(&buf);
1484                }
1485
1486                if (read_oneliner(&buf, rebase_path_allow_rerere_autoupdate(), 1)) {
1487                        if (!strcmp(buf.buf, "--rerere-autoupdate"))
1488                                opts->allow_rerere_auto = RERERE_AUTOUPDATE;
1489                        else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
1490                                opts->allow_rerere_auto = RERERE_NOAUTOUPDATE;
1491                        strbuf_reset(&buf);
1492                }
1493
1494                if (file_exists(rebase_path_verbose()))
1495                        opts->verbose = 1;
1496
1497                read_strategy_opts(opts, &buf);
1498                strbuf_release(&buf);
1499
1500                return 0;
1501        }
1502
1503        if (!file_exists(git_path_opts_file()))
1504                return 0;
1505        /*
1506         * The function git_parse_source(), called from git_config_from_file(),
1507         * may die() in case of a syntactically incorrect file. We do not care
1508         * about this case, though, because we wrote that file ourselves, so we
1509         * are pretty certain that it is syntactically correct.
1510         */
1511        if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
1512                return error(_("malformed options sheet: '%s'"),
1513                        git_path_opts_file());
1514        return 0;
1515}
1516
1517static int walk_revs_populate_todo(struct todo_list *todo_list,
1518                                struct replay_opts *opts)
1519{
1520        enum todo_command command = opts->action == REPLAY_PICK ?
1521                TODO_PICK : TODO_REVERT;
1522        const char *command_string = todo_command_info[command].str;
1523        struct commit *commit;
1524
1525        if (prepare_revs(opts))
1526                return -1;
1527
1528        while ((commit = get_revision(opts->revs))) {
1529                struct todo_item *item = append_new_todo(todo_list);
1530                const char *commit_buffer = get_commit_buffer(commit, NULL);
1531                const char *subject;
1532                int subject_len;
1533
1534                item->command = command;
1535                item->commit = commit;
1536                item->arg = NULL;
1537                item->arg_len = 0;
1538                item->offset_in_buf = todo_list->buf.len;
1539                subject_len = find_commit_subject(commit_buffer, &subject);
1540                strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
1541                        short_commit_name(commit), subject_len, subject);
1542                unuse_commit_buffer(commit, commit_buffer);
1543        }
1544        return 0;
1545}
1546
1547static int create_seq_dir(void)
1548{
1549        if (file_exists(git_path_seq_dir())) {
1550                error(_("a cherry-pick or revert is already in progress"));
1551                advise(_("try \"git cherry-pick (--continue | --quit | --abort)\""));
1552                return -1;
1553        } else if (mkdir(git_path_seq_dir(), 0777) < 0)
1554                return error_errno(_("could not create sequencer directory '%s'"),
1555                                   git_path_seq_dir());
1556        return 0;
1557}
1558
1559static int save_head(const char *head)
1560{
1561        static struct lock_file head_lock;
1562        struct strbuf buf = STRBUF_INIT;
1563        int fd;
1564
1565        fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
1566        if (fd < 0) {
1567                rollback_lock_file(&head_lock);
1568                return error_errno(_("could not lock HEAD"));
1569        }
1570        strbuf_addf(&buf, "%s\n", head);
1571        if (write_in_full(fd, buf.buf, buf.len) < 0) {
1572                rollback_lock_file(&head_lock);
1573                return error_errno(_("could not write to '%s'"),
1574                                   git_path_head_file());
1575        }
1576        if (commit_lock_file(&head_lock) < 0) {
1577                rollback_lock_file(&head_lock);
1578                return error(_("failed to finalize '%s'."), git_path_head_file());
1579        }
1580        return 0;
1581}
1582
1583static int rollback_is_safe(void)
1584{
1585        struct strbuf sb = STRBUF_INIT;
1586        struct object_id expected_head, actual_head;
1587
1588        if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
1589                strbuf_trim(&sb);
1590                if (get_oid_hex(sb.buf, &expected_head)) {
1591                        strbuf_release(&sb);
1592                        die(_("could not parse %s"), git_path_abort_safety_file());
1593                }
1594                strbuf_release(&sb);
1595        }
1596        else if (errno == ENOENT)
1597                oidclr(&expected_head);
1598        else
1599                die_errno(_("could not read '%s'"), git_path_abort_safety_file());
1600
1601        if (get_oid("HEAD", &actual_head))
1602                oidclr(&actual_head);
1603
1604        return !oidcmp(&actual_head, &expected_head);
1605}
1606
1607static int reset_for_rollback(const unsigned char *sha1)
1608{
1609        const char *argv[4];    /* reset --merge <arg> + NULL */
1610
1611        argv[0] = "reset";
1612        argv[1] = "--merge";
1613        argv[2] = sha1_to_hex(sha1);
1614        argv[3] = NULL;
1615        return run_command_v_opt(argv, RUN_GIT_CMD);
1616}
1617
1618static int rollback_single_pick(void)
1619{
1620        unsigned char head_sha1[20];
1621
1622        if (!file_exists(git_path_cherry_pick_head()) &&
1623            !file_exists(git_path_revert_head()))
1624                return error(_("no cherry-pick or revert in progress"));
1625        if (read_ref_full("HEAD", 0, head_sha1, NULL))
1626                return error(_("cannot resolve HEAD"));
1627        if (is_null_sha1(head_sha1))
1628                return error(_("cannot abort from a branch yet to be born"));
1629        return reset_for_rollback(head_sha1);
1630}
1631
1632int sequencer_rollback(struct replay_opts *opts)
1633{
1634        FILE *f;
1635        unsigned char sha1[20];
1636        struct strbuf buf = STRBUF_INIT;
1637
1638        f = fopen(git_path_head_file(), "r");
1639        if (!f && errno == ENOENT) {
1640                /*
1641                 * There is no multiple-cherry-pick in progress.
1642                 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
1643                 * a single-cherry-pick in progress, abort that.
1644                 */
1645                return rollback_single_pick();
1646        }
1647        if (!f)
1648                return error_errno(_("cannot open '%s'"), git_path_head_file());
1649        if (strbuf_getline_lf(&buf, f)) {
1650                error(_("cannot read '%s': %s"), git_path_head_file(),
1651                      ferror(f) ?  strerror(errno) : _("unexpected end of file"));
1652                fclose(f);
1653                goto fail;
1654        }
1655        fclose(f);
1656        if (get_sha1_hex(buf.buf, sha1) || buf.buf[40] != '\0') {
1657                error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
1658                        git_path_head_file());
1659                goto fail;
1660        }
1661        if (is_null_sha1(sha1)) {
1662                error(_("cannot abort from a branch yet to be born"));
1663                goto fail;
1664        }
1665
1666        if (!rollback_is_safe()) {
1667                /* Do not error, just do not rollback */
1668                warning(_("You seem to have moved HEAD. "
1669                          "Not rewinding, check your HEAD!"));
1670        } else
1671        if (reset_for_rollback(sha1))
1672                goto fail;
1673        strbuf_release(&buf);
1674        return sequencer_remove_state(opts);
1675fail:
1676        strbuf_release(&buf);
1677        return -1;
1678}
1679
1680static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
1681{
1682        static struct lock_file todo_lock;
1683        const char *todo_path = get_todo_path(opts);
1684        int next = todo_list->current, offset, fd;
1685
1686        /*
1687         * rebase -i writes "git-rebase-todo" without the currently executing
1688         * command, appending it to "done" instead.
1689         */
1690        if (is_rebase_i(opts))
1691                next++;
1692
1693        fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
1694        if (fd < 0)
1695                return error_errno(_("could not lock '%s'"), todo_path);
1696        offset = next < todo_list->nr ?
1697                todo_list->items[next].offset_in_buf : todo_list->buf.len;
1698        if (write_in_full(fd, todo_list->buf.buf + offset,
1699                        todo_list->buf.len - offset) < 0)
1700                return error_errno(_("could not write to '%s'"), todo_path);
1701        if (commit_lock_file(&todo_lock) < 0)
1702                return error(_("failed to finalize '%s'."), todo_path);
1703
1704        if (is_rebase_i(opts)) {
1705                const char *done_path = rebase_path_done();
1706                int fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
1707                int prev_offset = !next ? 0 :
1708                        todo_list->items[next - 1].offset_in_buf;
1709
1710                if (fd >= 0 && offset > prev_offset &&
1711                    write_in_full(fd, todo_list->buf.buf + prev_offset,
1712                                  offset - prev_offset) < 0) {
1713                        close(fd);
1714                        return error_errno(_("could not write to '%s'"),
1715                                           done_path);
1716                }
1717                if (fd >= 0)
1718                        close(fd);
1719        }
1720        return 0;
1721}
1722
1723static int save_opts(struct replay_opts *opts)
1724{
1725        const char *opts_file = git_path_opts_file();
1726        int res = 0;
1727
1728        if (opts->no_commit)
1729                res |= git_config_set_in_file_gently(opts_file, "options.no-commit", "true");
1730        if (opts->edit)
1731                res |= git_config_set_in_file_gently(opts_file, "options.edit", "true");
1732        if (opts->signoff)
1733                res |= git_config_set_in_file_gently(opts_file, "options.signoff", "true");
1734        if (opts->record_origin)
1735                res |= git_config_set_in_file_gently(opts_file, "options.record-origin", "true");
1736        if (opts->allow_ff)
1737                res |= git_config_set_in_file_gently(opts_file, "options.allow-ff", "true");
1738        if (opts->mainline) {
1739                struct strbuf buf = STRBUF_INIT;
1740                strbuf_addf(&buf, "%d", opts->mainline);
1741                res |= git_config_set_in_file_gently(opts_file, "options.mainline", buf.buf);
1742                strbuf_release(&buf);
1743        }
1744        if (opts->strategy)
1745                res |= git_config_set_in_file_gently(opts_file, "options.strategy", opts->strategy);
1746        if (opts->gpg_sign)
1747                res |= git_config_set_in_file_gently(opts_file, "options.gpg-sign", opts->gpg_sign);
1748        if (opts->xopts) {
1749                int i;
1750                for (i = 0; i < opts->xopts_nr; i++)
1751                        res |= git_config_set_multivar_in_file_gently(opts_file,
1752                                                        "options.strategy-option",
1753                                                        opts->xopts[i], "^$", 0);
1754        }
1755        return res;
1756}
1757
1758static int make_patch(struct commit *commit, struct replay_opts *opts)
1759{
1760        struct strbuf buf = STRBUF_INIT;
1761        struct rev_info log_tree_opt;
1762        const char *subject, *p;
1763        int res = 0;
1764
1765        p = short_commit_name(commit);
1766        if (write_message(p, strlen(p), rebase_path_stopped_sha(), 1) < 0)
1767                return -1;
1768
1769        strbuf_addf(&buf, "%s/patch", get_dir(opts));
1770        memset(&log_tree_opt, 0, sizeof(log_tree_opt));
1771        init_revisions(&log_tree_opt, NULL);
1772        log_tree_opt.abbrev = 0;
1773        log_tree_opt.diff = 1;
1774        log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
1775        log_tree_opt.disable_stdin = 1;
1776        log_tree_opt.no_commit_id = 1;
1777        log_tree_opt.diffopt.file = fopen(buf.buf, "w");
1778        log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
1779        if (!log_tree_opt.diffopt.file)
1780                res |= error_errno(_("could not open '%s'"), buf.buf);
1781        else {
1782                res |= log_tree_commit(&log_tree_opt, commit);
1783                fclose(log_tree_opt.diffopt.file);
1784        }
1785        strbuf_reset(&buf);
1786
1787        strbuf_addf(&buf, "%s/message", get_dir(opts));
1788        if (!file_exists(buf.buf)) {
1789                const char *commit_buffer = get_commit_buffer(commit, NULL);
1790                find_commit_subject(commit_buffer, &subject);
1791                res |= write_message(subject, strlen(subject), buf.buf, 1);
1792                unuse_commit_buffer(commit, commit_buffer);
1793        }
1794        strbuf_release(&buf);
1795
1796        return res;
1797}
1798
1799static int intend_to_amend(void)
1800{
1801        unsigned char head[20];
1802        char *p;
1803
1804        if (get_sha1("HEAD", head))
1805                return error(_("cannot read HEAD"));
1806
1807        p = sha1_to_hex(head);
1808        return write_message(p, strlen(p), rebase_path_amend(), 1);
1809}
1810
1811static int error_with_patch(struct commit *commit,
1812        const char *subject, int subject_len,
1813        struct replay_opts *opts, int exit_code, int to_amend)
1814{
1815        if (make_patch(commit, opts))
1816                return -1;
1817
1818        if (to_amend) {
1819                if (intend_to_amend())
1820                        return -1;
1821
1822                fprintf(stderr, "You can amend the commit now, with\n"
1823                        "\n"
1824                        "  git commit --amend %s\n"
1825                        "\n"
1826                        "Once you are satisfied with your changes, run\n"
1827                        "\n"
1828                        "  git rebase --continue\n", gpg_sign_opt_quoted(opts));
1829        } else if (exit_code)
1830                fprintf(stderr, "Could not apply %s... %.*s\n",
1831                        short_commit_name(commit), subject_len, subject);
1832
1833        return exit_code;
1834}
1835
1836static int error_failed_squash(struct commit *commit,
1837        struct replay_opts *opts, int subject_len, const char *subject)
1838{
1839        if (rename(rebase_path_squash_msg(), rebase_path_message()))
1840                return error(_("could not rename '%s' to '%s'"),
1841                        rebase_path_squash_msg(), rebase_path_message());
1842        unlink(rebase_path_fixup_msg());
1843        unlink(git_path_merge_msg());
1844        if (copy_file(git_path_merge_msg(), rebase_path_message(), 0666))
1845                return error(_("could not copy '%s' to '%s'"),
1846                             rebase_path_message(), git_path_merge_msg());
1847        return error_with_patch(commit, subject, subject_len, opts, 1, 0);
1848}
1849
1850static int do_exec(const char *command_line)
1851{
1852        const char *child_argv[] = { NULL, NULL };
1853        int dirty, status;
1854
1855        fprintf(stderr, "Executing: %s\n", command_line);
1856        child_argv[0] = command_line;
1857        status = run_command_v_opt(child_argv, RUN_USING_SHELL);
1858
1859        /* force re-reading of the cache */
1860        if (discard_cache() < 0 || read_cache() < 0)
1861                return error(_("could not read index"));
1862
1863        dirty = require_clean_work_tree("rebase", NULL, 1, 1);
1864
1865        if (status) {
1866                warning(_("execution failed: %s\n%s"
1867                          "You can fix the problem, and then run\n"
1868                          "\n"
1869                          "  git rebase --continue\n"
1870                          "\n"),
1871                        command_line,
1872                        dirty ? N_("and made changes to the index and/or the "
1873                                "working tree\n") : "");
1874                if (status == 127)
1875                        /* command not found */
1876                        status = 1;
1877        } else if (dirty) {
1878                warning(_("execution succeeded: %s\nbut "
1879                          "left changes to the index and/or the working tree\n"
1880                          "Commit or stash your changes, and then run\n"
1881                          "\n"
1882                          "  git rebase --continue\n"
1883                          "\n"), command_line);
1884                status = 1;
1885        }
1886
1887        return status;
1888}
1889
1890static int is_final_fixup(struct todo_list *todo_list)
1891{
1892        int i = todo_list->current;
1893
1894        if (!is_fixup(todo_list->items[i].command))
1895                return 0;
1896
1897        while (++i < todo_list->nr)
1898                if (is_fixup(todo_list->items[i].command))
1899                        return 0;
1900                else if (!is_noop(todo_list->items[i].command))
1901                        break;
1902        return 1;
1903}
1904
1905static enum todo_command peek_command(struct todo_list *todo_list, int offset)
1906{
1907        int i;
1908
1909        for (i = todo_list->current + offset; i < todo_list->nr; i++)
1910                if (!is_noop(todo_list->items[i].command))
1911                        return todo_list->items[i].command;
1912
1913        return -1;
1914}
1915
1916static int apply_autostash(struct replay_opts *opts)
1917{
1918        struct strbuf stash_sha1 = STRBUF_INIT;
1919        struct child_process child = CHILD_PROCESS_INIT;
1920        int ret = 0;
1921
1922        if (!read_oneliner(&stash_sha1, rebase_path_autostash(), 1)) {
1923                strbuf_release(&stash_sha1);
1924                return 0;
1925        }
1926        strbuf_trim(&stash_sha1);
1927
1928        child.git_cmd = 1;
1929        child.no_stdout = 1;
1930        child.no_stderr = 1;
1931        argv_array_push(&child.args, "stash");
1932        argv_array_push(&child.args, "apply");
1933        argv_array_push(&child.args, stash_sha1.buf);
1934        if (!run_command(&child))
1935                fprintf(stderr, _("Applied autostash.\n"));
1936        else {
1937                struct child_process store = CHILD_PROCESS_INIT;
1938
1939                store.git_cmd = 1;
1940                argv_array_push(&store.args, "stash");
1941                argv_array_push(&store.args, "store");
1942                argv_array_push(&store.args, "-m");
1943                argv_array_push(&store.args, "autostash");
1944                argv_array_push(&store.args, "-q");
1945                argv_array_push(&store.args, stash_sha1.buf);
1946                if (run_command(&store))
1947                        ret = error(_("cannot store %s"), stash_sha1.buf);
1948                else
1949                        fprintf(stderr,
1950                                _("Applying autostash resulted in conflicts.\n"
1951                                  "Your changes are safe in the stash.\n"
1952                                  "You can run \"git stash pop\" or"
1953                                  " \"git stash drop\" at any time.\n"));
1954        }
1955
1956        strbuf_release(&stash_sha1);
1957        return ret;
1958}
1959
1960static const char *reflog_message(struct replay_opts *opts,
1961        const char *sub_action, const char *fmt, ...)
1962{
1963        va_list ap;
1964        static struct strbuf buf = STRBUF_INIT;
1965
1966        va_start(ap, fmt);
1967        strbuf_reset(&buf);
1968        strbuf_addstr(&buf, action_name(opts));
1969        if (sub_action)
1970                strbuf_addf(&buf, " (%s)", sub_action);
1971        if (fmt) {
1972                strbuf_addstr(&buf, ": ");
1973                strbuf_vaddf(&buf, fmt, ap);
1974        }
1975        va_end(ap);
1976
1977        return buf.buf;
1978}
1979
1980static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
1981{
1982        int res = 0;
1983
1984        setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
1985        if (opts->allow_ff)
1986                assert(!(opts->signoff || opts->no_commit ||
1987                                opts->record_origin || opts->edit));
1988        if (read_and_refresh_cache(opts))
1989                return -1;
1990
1991        while (todo_list->current < todo_list->nr) {
1992                struct todo_item *item = todo_list->items + todo_list->current;
1993                if (save_todo(todo_list, opts))
1994                        return -1;
1995                if (is_rebase_i(opts)) {
1996                        if (item->command != TODO_COMMENT) {
1997                                FILE *f = fopen(rebase_path_msgnum(), "w");
1998
1999                                todo_list->done_nr++;
2000
2001                                if (f) {
2002                                        fprintf(f, "%d\n", todo_list->done_nr);
2003                                        fclose(f);
2004                                }
2005                                fprintf(stderr, "Rebasing (%d/%d)%s",
2006                                        todo_list->done_nr,
2007                                        todo_list->total_nr,
2008                                        opts->verbose ? "\n" : "\r");
2009                        }
2010                        unlink(rebase_path_message());
2011                        unlink(rebase_path_author_script());
2012                        unlink(rebase_path_stopped_sha());
2013                        unlink(rebase_path_amend());
2014                }
2015                if (item->command <= TODO_SQUASH) {
2016                        if (is_rebase_i(opts))
2017                                setenv("GIT_REFLOG_ACTION", reflog_message(opts,
2018                                        command_to_string(item->command), NULL),
2019                                        1);
2020                        res = do_pick_commit(item->command, item->commit,
2021                                        opts, is_final_fixup(todo_list));
2022                        if (is_rebase_i(opts) && res < 0) {
2023                                /* Reschedule */
2024                                todo_list->current--;
2025                                if (save_todo(todo_list, opts))
2026                                        return -1;
2027                        }
2028                        if (item->command == TODO_EDIT) {
2029                                struct commit *commit = item->commit;
2030                                if (!res)
2031                                        fprintf(stderr,
2032                                                _("Stopped at %s...  %.*s\n"),
2033                                                short_commit_name(commit),
2034                                                item->arg_len, item->arg);
2035                                return error_with_patch(commit,
2036                                        item->arg, item->arg_len, opts, res,
2037                                        !res);
2038                        }
2039                        if (is_rebase_i(opts) && !res)
2040                                record_in_rewritten(&item->commit->object.oid,
2041                                        peek_command(todo_list, 1));
2042                        if (res && is_fixup(item->command)) {
2043                                if (res == 1)
2044                                        intend_to_amend();
2045                                return error_failed_squash(item->commit, opts,
2046                                        item->arg_len, item->arg);
2047                        } else if (res && is_rebase_i(opts))
2048                                return res | error_with_patch(item->commit,
2049                                        item->arg, item->arg_len, opts, res,
2050                                        item->command == TODO_REWORD);
2051                } else if (item->command == TODO_EXEC) {
2052                        char *end_of_arg = (char *)(item->arg + item->arg_len);
2053                        int saved = *end_of_arg;
2054                        struct stat st;
2055
2056                        *end_of_arg = '\0';
2057                        res = do_exec(item->arg);
2058                        *end_of_arg = saved;
2059
2060                        /* Reread the todo file if it has changed. */
2061                        if (res)
2062                                ; /* fall through */
2063                        else if (stat(get_todo_path(opts), &st))
2064                                res = error_errno(_("could not stat '%s'"),
2065                                                  get_todo_path(opts));
2066                        else if (match_stat_data(&todo_list->stat, &st)) {
2067                                todo_list_release(todo_list);
2068                                if (read_populate_todo(todo_list, opts))
2069                                        res = -1; /* message was printed */
2070                                /* `current` will be incremented below */
2071                                todo_list->current = -1;
2072                        }
2073                } else if (!is_noop(item->command))
2074                        return error(_("unknown command %d"), item->command);
2075
2076                todo_list->current++;
2077                if (res)
2078                        return res;
2079        }
2080
2081        if (is_rebase_i(opts)) {
2082                struct strbuf head_ref = STRBUF_INIT, buf = STRBUF_INIT;
2083                struct stat st;
2084
2085                /* Stopped in the middle, as planned? */
2086                if (todo_list->current < todo_list->nr)
2087                        return 0;
2088
2089                if (read_oneliner(&head_ref, rebase_path_head_name(), 0) &&
2090                                starts_with(head_ref.buf, "refs/")) {
2091                        const char *msg;
2092                        unsigned char head[20], orig[20];
2093                        int res;
2094
2095                        if (get_sha1("HEAD", head)) {
2096                                res = error(_("cannot read HEAD"));
2097cleanup_head_ref:
2098                                strbuf_release(&head_ref);
2099                                strbuf_release(&buf);
2100                                return res;
2101                        }
2102                        if (!read_oneliner(&buf, rebase_path_orig_head(), 0) ||
2103                                        get_sha1_hex(buf.buf, orig)) {
2104                                res = error(_("could not read orig-head"));
2105                                goto cleanup_head_ref;
2106                        }
2107                        strbuf_reset(&buf);
2108                        if (!read_oneliner(&buf, rebase_path_onto(), 0)) {
2109                                res = error(_("could not read 'onto'"));
2110                                goto cleanup_head_ref;
2111                        }
2112                        msg = reflog_message(opts, "finish", "%s onto %s",
2113                                head_ref.buf, buf.buf);
2114                        if (update_ref(msg, head_ref.buf, head, orig,
2115                                        REF_NODEREF, UPDATE_REFS_MSG_ON_ERR)) {
2116                                res = error(_("could not update %s"),
2117                                        head_ref.buf);
2118                                goto cleanup_head_ref;
2119                        }
2120                        msg = reflog_message(opts, "finish", "returning to %s",
2121                                head_ref.buf);
2122                        if (create_symref("HEAD", head_ref.buf, msg)) {
2123                                res = error(_("could not update HEAD to %s"),
2124                                        head_ref.buf);
2125                                goto cleanup_head_ref;
2126                        }
2127                        strbuf_reset(&buf);
2128                }
2129
2130                if (opts->verbose) {
2131                        struct rev_info log_tree_opt;
2132                        struct object_id orig, head;
2133
2134                        memset(&log_tree_opt, 0, sizeof(log_tree_opt));
2135                        init_revisions(&log_tree_opt, NULL);
2136                        log_tree_opt.diff = 1;
2137                        log_tree_opt.diffopt.output_format =
2138                                DIFF_FORMAT_DIFFSTAT;
2139                        log_tree_opt.disable_stdin = 1;
2140
2141                        if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
2142                            !get_sha1(buf.buf, orig.hash) &&
2143                            !get_sha1("HEAD", head.hash)) {
2144                                diff_tree_oid(&orig, &head, "",
2145                                              &log_tree_opt.diffopt);
2146                                log_tree_diff_flush(&log_tree_opt);
2147                        }
2148                }
2149                flush_rewritten_pending();
2150                if (!stat(rebase_path_rewritten_list(), &st) &&
2151                                st.st_size > 0) {
2152                        struct child_process child = CHILD_PROCESS_INIT;
2153                        const char *post_rewrite_hook =
2154                                find_hook("post-rewrite");
2155
2156                        child.in = open(rebase_path_rewritten_list(), O_RDONLY);
2157                        child.git_cmd = 1;
2158                        argv_array_push(&child.args, "notes");
2159                        argv_array_push(&child.args, "copy");
2160                        argv_array_push(&child.args, "--for-rewrite=rebase");
2161                        /* we don't care if this copying failed */
2162                        run_command(&child);
2163
2164                        if (post_rewrite_hook) {
2165                                struct child_process hook = CHILD_PROCESS_INIT;
2166
2167                                hook.in = open(rebase_path_rewritten_list(),
2168                                        O_RDONLY);
2169                                hook.stdout_to_stderr = 1;
2170                                argv_array_push(&hook.args, post_rewrite_hook);
2171                                argv_array_push(&hook.args, "rebase");
2172                                /* we don't care if this hook failed */
2173                                run_command(&hook);
2174                        }
2175                }
2176                apply_autostash(opts);
2177
2178                fprintf(stderr, "Successfully rebased and updated %s.\n",
2179                        head_ref.buf);
2180
2181                strbuf_release(&buf);
2182                strbuf_release(&head_ref);
2183        }
2184
2185        /*
2186         * Sequence of picks finished successfully; cleanup by
2187         * removing the .git/sequencer directory
2188         */
2189        return sequencer_remove_state(opts);
2190}
2191
2192static int continue_single_pick(void)
2193{
2194        const char *argv[] = { "commit", NULL };
2195
2196        if (!file_exists(git_path_cherry_pick_head()) &&
2197            !file_exists(git_path_revert_head()))
2198                return error(_("no cherry-pick or revert in progress"));
2199        return run_command_v_opt(argv, RUN_GIT_CMD);
2200}
2201
2202static int commit_staged_changes(struct replay_opts *opts)
2203{
2204        unsigned int flags = ALLOW_EMPTY | EDIT_MSG;
2205
2206        if (has_unstaged_changes(1))
2207                return error(_("cannot rebase: You have unstaged changes."));
2208        if (!has_uncommitted_changes(0)) {
2209                const char *cherry_pick_head = git_path_cherry_pick_head();
2210
2211                if (file_exists(cherry_pick_head) && unlink(cherry_pick_head))
2212                        return error(_("could not remove CHERRY_PICK_HEAD"));
2213                return 0;
2214        }
2215
2216        if (file_exists(rebase_path_amend())) {
2217                struct strbuf rev = STRBUF_INIT;
2218                unsigned char head[20], to_amend[20];
2219
2220                if (get_sha1("HEAD", head))
2221                        return error(_("cannot amend non-existing commit"));
2222                if (!read_oneliner(&rev, rebase_path_amend(), 0))
2223                        return error(_("invalid file: '%s'"), rebase_path_amend());
2224                if (get_sha1_hex(rev.buf, to_amend))
2225                        return error(_("invalid contents: '%s'"),
2226                                rebase_path_amend());
2227                if (hashcmp(head, to_amend))
2228                        return error(_("\nYou have uncommitted changes in your "
2229                                       "working tree. Please, commit them\n"
2230                                       "first and then run 'git rebase "
2231                                       "--continue' again."));
2232
2233                strbuf_release(&rev);
2234                flags |= AMEND_MSG;
2235        }
2236
2237        if (run_git_commit(rebase_path_message(), opts, flags))
2238                return error(_("could not commit staged changes."));
2239        unlink(rebase_path_amend());
2240        return 0;
2241}
2242
2243int sequencer_continue(struct replay_opts *opts)
2244{
2245        struct todo_list todo_list = TODO_LIST_INIT;
2246        int res;
2247
2248        if (read_and_refresh_cache(opts))
2249                return -1;
2250
2251        if (is_rebase_i(opts)) {
2252                if (commit_staged_changes(opts))
2253                        return -1;
2254        } else if (!file_exists(get_todo_path(opts)))
2255                return continue_single_pick();
2256        if (read_populate_opts(opts))
2257                return -1;
2258        if ((res = read_populate_todo(&todo_list, opts)))
2259                goto release_todo_list;
2260
2261        if (!is_rebase_i(opts)) {
2262                /* Verify that the conflict has been resolved */
2263                if (file_exists(git_path_cherry_pick_head()) ||
2264                    file_exists(git_path_revert_head())) {
2265                        res = continue_single_pick();
2266                        if (res)
2267                                goto release_todo_list;
2268                }
2269                if (index_differs_from("HEAD", 0, 0)) {
2270                        res = error_dirty_index(opts);
2271                        goto release_todo_list;
2272                }
2273                todo_list.current++;
2274        } else if (file_exists(rebase_path_stopped_sha())) {
2275                struct strbuf buf = STRBUF_INIT;
2276                struct object_id oid;
2277
2278                if (read_oneliner(&buf, rebase_path_stopped_sha(), 1) &&
2279                    !get_sha1_committish(buf.buf, oid.hash))
2280                        record_in_rewritten(&oid, peek_command(&todo_list, 0));
2281                strbuf_release(&buf);
2282        }
2283
2284        res = pick_commits(&todo_list, opts);
2285release_todo_list:
2286        todo_list_release(&todo_list);
2287        return res;
2288}
2289
2290static int single_pick(struct commit *cmit, struct replay_opts *opts)
2291{
2292        setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
2293        return do_pick_commit(opts->action == REPLAY_PICK ?
2294                TODO_PICK : TODO_REVERT, cmit, opts, 0);
2295}
2296
2297int sequencer_pick_revisions(struct replay_opts *opts)
2298{
2299        struct todo_list todo_list = TODO_LIST_INIT;
2300        struct object_id oid;
2301        int i, res;
2302
2303        assert(opts->revs);
2304        if (read_and_refresh_cache(opts))
2305                return -1;
2306
2307        for (i = 0; i < opts->revs->pending.nr; i++) {
2308                struct object_id oid;
2309                const char *name = opts->revs->pending.objects[i].name;
2310
2311                /* This happens when using --stdin. */
2312                if (!strlen(name))
2313                        continue;
2314
2315                if (!get_oid(name, &oid)) {
2316                        if (!lookup_commit_reference_gently(&oid, 1)) {
2317                                enum object_type type = sha1_object_info(oid.hash, NULL);
2318                                return error(_("%s: can't cherry-pick a %s"),
2319                                        name, typename(type));
2320                        }
2321                } else
2322                        return error(_("%s: bad revision"), name);
2323        }
2324
2325        /*
2326         * If we were called as "git cherry-pick <commit>", just
2327         * cherry-pick/revert it, set CHERRY_PICK_HEAD /
2328         * REVERT_HEAD, and don't touch the sequencer state.
2329         * This means it is possible to cherry-pick in the middle
2330         * of a cherry-pick sequence.
2331         */
2332        if (opts->revs->cmdline.nr == 1 &&
2333            opts->revs->cmdline.rev->whence == REV_CMD_REV &&
2334            opts->revs->no_walk &&
2335            !opts->revs->cmdline.rev->flags) {
2336                struct commit *cmit;
2337                if (prepare_revision_walk(opts->revs))
2338                        return error(_("revision walk setup failed"));
2339                cmit = get_revision(opts->revs);
2340                if (!cmit || get_revision(opts->revs))
2341                        return error("BUG: expected exactly one commit from walk");
2342                return single_pick(cmit, opts);
2343        }
2344
2345        /*
2346         * Start a new cherry-pick/ revert sequence; but
2347         * first, make sure that an existing one isn't in
2348         * progress
2349         */
2350
2351        if (walk_revs_populate_todo(&todo_list, opts) ||
2352                        create_seq_dir() < 0)
2353                return -1;
2354        if (get_oid("HEAD", &oid) && (opts->action == REPLAY_REVERT))
2355                return error(_("can't revert as initial commit"));
2356        if (save_head(oid_to_hex(&oid)))
2357                return -1;
2358        if (save_opts(opts))
2359                return -1;
2360        update_abort_safety_file();
2361        res = pick_commits(&todo_list, opts);
2362        todo_list_release(&todo_list);
2363        return res;
2364}
2365
2366void append_signoff(struct strbuf *msgbuf, int ignore_footer, unsigned flag)
2367{
2368        unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
2369        struct strbuf sob = STRBUF_INIT;
2370        int has_footer;
2371
2372        strbuf_addstr(&sob, sign_off_header);
2373        strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
2374                                getenv("GIT_COMMITTER_EMAIL")));
2375        strbuf_addch(&sob, '\n');
2376
2377        if (!ignore_footer)
2378                strbuf_complete_line(msgbuf);
2379
2380        /*
2381         * If the whole message buffer is equal to the sob, pretend that we
2382         * found a conforming footer with a matching sob
2383         */
2384        if (msgbuf->len - ignore_footer == sob.len &&
2385            !strncmp(msgbuf->buf, sob.buf, sob.len))
2386                has_footer = 3;
2387        else
2388                has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
2389
2390        if (!has_footer) {
2391                const char *append_newlines = NULL;
2392                size_t len = msgbuf->len - ignore_footer;
2393
2394                if (!len) {
2395                        /*
2396                         * The buffer is completely empty.  Leave foom for
2397                         * the title and body to be filled in by the user.
2398                         */
2399                        append_newlines = "\n\n";
2400                } else if (len == 1) {
2401                        /*
2402                         * Buffer contains a single newline.  Add another
2403                         * so that we leave room for the title and body.
2404                         */
2405                        append_newlines = "\n";
2406                } else if (msgbuf->buf[len - 2] != '\n') {
2407                        /*
2408                         * Buffer ends with a single newline.  Add another
2409                         * so that there is an empty line between the message
2410                         * body and the sob.
2411                         */
2412                        append_newlines = "\n";
2413                } /* else, the buffer already ends with two newlines. */
2414
2415                if (append_newlines)
2416                        strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
2417                                append_newlines, strlen(append_newlines));
2418        }
2419
2420        if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
2421                strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
2422                                sob.buf, sob.len);
2423
2424        strbuf_release(&sob);
2425}