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