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