51ef7245b14cf1625385be872815fda11e2dc191
   1#include "cache.h"
   2#include "config.h"
   3#include "lockfile.h"
   4#include "dir.h"
   5#include "object.h"
   6#include "commit.h"
   7#include "sequencer.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#include "notes-utils.h"
  25#include "sigchain.h"
  26#include "unpack-trees.h"
  27#include "worktree.h"
  28#include "oidmap.h"
  29#include "oidset.h"
  30#include "alias.h"
  31
  32#define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
  33
  34const char sign_off_header[] = "Signed-off-by: ";
  35static const char cherry_picked_prefix[] = "(cherry picked from commit ";
  36
  37GIT_PATH_FUNC(git_path_commit_editmsg, "COMMIT_EDITMSG")
  38
  39GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
  40
  41static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
  42static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
  43static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
  44static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
  45
  46static GIT_PATH_FUNC(rebase_path, "rebase-merge")
  47/*
  48 * The file containing rebase commands, comments, and empty lines.
  49 * This file is created by "git rebase -i" then edited by the user. As
  50 * the lines are processed, they are removed from the front of this
  51 * file and written to the tail of 'done'.
  52 */
  53static GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
  54/*
  55 * The rebase command lines that have already been processed. A line
  56 * is moved here when it is first handled, before any associated user
  57 * actions.
  58 */
  59static GIT_PATH_FUNC(rebase_path_done, "rebase-merge/done")
  60/*
  61 * The file to keep track of how many commands were already processed (e.g.
  62 * for the prompt).
  63 */
  64static GIT_PATH_FUNC(rebase_path_msgnum, "rebase-merge/msgnum");
  65/*
  66 * The file to keep track of how many commands are to be processed in total
  67 * (e.g. for the prompt).
  68 */
  69static GIT_PATH_FUNC(rebase_path_msgtotal, "rebase-merge/end");
  70/*
  71 * The commit message that is planned to be used for any changes that
  72 * need to be committed following a user interaction.
  73 */
  74static GIT_PATH_FUNC(rebase_path_message, "rebase-merge/message")
  75/*
  76 * The file into which is accumulated the suggested commit message for
  77 * squash/fixup commands. When the first of a series of squash/fixups
  78 * is seen, the file is created and the commit message from the
  79 * previous commit and from the first squash/fixup commit are written
  80 * to it. The commit message for each subsequent squash/fixup commit
  81 * is appended to the file as it is processed.
  82 */
  83static GIT_PATH_FUNC(rebase_path_squash_msg, "rebase-merge/message-squash")
  84/*
  85 * If the current series of squash/fixups has not yet included a squash
  86 * command, then this file exists and holds the commit message of the
  87 * original "pick" commit.  (If the series ends without a "squash"
  88 * command, then this can be used as the commit message of the combined
  89 * commit without opening the editor.)
  90 */
  91static GIT_PATH_FUNC(rebase_path_fixup_msg, "rebase-merge/message-fixup")
  92/*
  93 * This file contains the list fixup/squash commands that have been
  94 * accumulated into message-fixup or message-squash so far.
  95 */
  96static GIT_PATH_FUNC(rebase_path_current_fixups, "rebase-merge/current-fixups")
  97/*
  98 * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
  99 * GIT_AUTHOR_DATE that will be used for the commit that is currently
 100 * being rebased.
 101 */
 102static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
 103/*
 104 * When an "edit" rebase command is being processed, the SHA1 of the
 105 * commit to be edited is recorded in this file.  When "git rebase
 106 * --continue" is executed, if there are any staged changes then they
 107 * will be amended to the HEAD commit, but only provided the HEAD
 108 * commit is still the commit to be edited.  When any other rebase
 109 * command is processed, this file is deleted.
 110 */
 111static GIT_PATH_FUNC(rebase_path_amend, "rebase-merge/amend")
 112/*
 113 * When we stop at a given patch via the "edit" command, this file contains
 114 * the abbreviated commit name of the corresponding patch.
 115 */
 116static GIT_PATH_FUNC(rebase_path_stopped_sha, "rebase-merge/stopped-sha")
 117/*
 118 * For the post-rewrite hook, we make a list of rewritten commits and
 119 * their new sha1s.  The rewritten-pending list keeps the sha1s of
 120 * commits that have been processed, but not committed yet,
 121 * e.g. because they are waiting for a 'squash' command.
 122 */
 123static GIT_PATH_FUNC(rebase_path_rewritten_list, "rebase-merge/rewritten-list")
 124static GIT_PATH_FUNC(rebase_path_rewritten_pending,
 125        "rebase-merge/rewritten-pending")
 126
 127/*
 128 * The path of the file containig the OID of the "squash onto" commit, i.e.
 129 * the dummy commit used for `reset [new root]`.
 130 */
 131static GIT_PATH_FUNC(rebase_path_squash_onto, "rebase-merge/squash-onto")
 132
 133/*
 134 * The path of the file listing refs that need to be deleted after the rebase
 135 * finishes. This is used by the `label` command to record the need for cleanup.
 136 */
 137static GIT_PATH_FUNC(rebase_path_refs_to_delete, "rebase-merge/refs-to-delete")
 138
 139/*
 140 * The following files are written by git-rebase just after parsing the
 141 * command-line (and are only consumed, not modified, by the sequencer).
 142 */
 143static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
 144static GIT_PATH_FUNC(rebase_path_orig_head, "rebase-merge/orig-head")
 145static GIT_PATH_FUNC(rebase_path_verbose, "rebase-merge/verbose")
 146static GIT_PATH_FUNC(rebase_path_signoff, "rebase-merge/signoff")
 147static GIT_PATH_FUNC(rebase_path_head_name, "rebase-merge/head-name")
 148static GIT_PATH_FUNC(rebase_path_onto, "rebase-merge/onto")
 149static GIT_PATH_FUNC(rebase_path_autostash, "rebase-merge/autostash")
 150static GIT_PATH_FUNC(rebase_path_strategy, "rebase-merge/strategy")
 151static GIT_PATH_FUNC(rebase_path_strategy_opts, "rebase-merge/strategy_opts")
 152static GIT_PATH_FUNC(rebase_path_allow_rerere_autoupdate, "rebase-merge/allow_rerere_autoupdate")
 153
 154static int git_sequencer_config(const char *k, const char *v, void *cb)
 155{
 156        struct replay_opts *opts = cb;
 157        int status;
 158
 159        if (!strcmp(k, "commit.cleanup")) {
 160                const char *s;
 161
 162                status = git_config_string(&s, k, v);
 163                if (status)
 164                        return status;
 165
 166                if (!strcmp(s, "verbatim"))
 167                        opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
 168                else if (!strcmp(s, "whitespace"))
 169                        opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SPACE;
 170                else if (!strcmp(s, "strip"))
 171                        opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_ALL;
 172                else if (!strcmp(s, "scissors"))
 173                        opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SPACE;
 174                else
 175                        warning(_("invalid commit message cleanup mode '%s'"),
 176                                  s);
 177
 178                return status;
 179        }
 180
 181        if (!strcmp(k, "commit.gpgsign")) {
 182                opts->gpg_sign = git_config_bool(k, v) ? xstrdup("") : NULL;
 183                return 0;
 184        }
 185
 186        status = git_gpg_config(k, v, NULL);
 187        if (status)
 188                return status;
 189
 190        return git_diff_basic_config(k, v, NULL);
 191}
 192
 193void sequencer_init_config(struct replay_opts *opts)
 194{
 195        opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
 196        git_config(git_sequencer_config, opts);
 197}
 198
 199static inline int is_rebase_i(const struct replay_opts *opts)
 200{
 201        return opts->action == REPLAY_INTERACTIVE_REBASE;
 202}
 203
 204static const char *get_dir(const struct replay_opts *opts)
 205{
 206        if (is_rebase_i(opts))
 207                return rebase_path();
 208        return git_path_seq_dir();
 209}
 210
 211static const char *get_todo_path(const struct replay_opts *opts)
 212{
 213        if (is_rebase_i(opts))
 214                return rebase_path_todo();
 215        return git_path_todo_file();
 216}
 217
 218/*
 219 * Returns 0 for non-conforming footer
 220 * Returns 1 for conforming footer
 221 * Returns 2 when sob exists within conforming footer
 222 * Returns 3 when sob exists within conforming footer as last entry
 223 */
 224static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
 225        int ignore_footer)
 226{
 227        struct process_trailer_options opts = PROCESS_TRAILER_OPTIONS_INIT;
 228        struct trailer_info info;
 229        size_t i;
 230        int found_sob = 0, found_sob_last = 0;
 231
 232        opts.no_divider = 1;
 233
 234        trailer_info_get(&info, sb->buf, &opts);
 235
 236        if (info.trailer_start == info.trailer_end)
 237                return 0;
 238
 239        for (i = 0; i < info.trailer_nr; i++)
 240                if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
 241                        found_sob = 1;
 242                        if (i == info.trailer_nr - 1)
 243                                found_sob_last = 1;
 244                }
 245
 246        trailer_info_release(&info);
 247
 248        if (found_sob_last)
 249                return 3;
 250        if (found_sob)
 251                return 2;
 252        return 1;
 253}
 254
 255static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
 256{
 257        static struct strbuf buf = STRBUF_INIT;
 258
 259        strbuf_reset(&buf);
 260        if (opts->gpg_sign)
 261                sq_quotef(&buf, "-S%s", opts->gpg_sign);
 262        return buf.buf;
 263}
 264
 265int sequencer_remove_state(struct replay_opts *opts)
 266{
 267        struct strbuf buf = STRBUF_INIT;
 268        int i;
 269
 270        if (is_rebase_i(opts) &&
 271            strbuf_read_file(&buf, rebase_path_refs_to_delete(), 0) > 0) {
 272                char *p = buf.buf;
 273                while (*p) {
 274                        char *eol = strchr(p, '\n');
 275                        if (eol)
 276                                *eol = '\0';
 277                        if (delete_ref("(rebase -i) cleanup", p, NULL, 0) < 0)
 278                                warning(_("could not delete '%s'"), p);
 279                        if (!eol)
 280                                break;
 281                        p = eol + 1;
 282                }
 283        }
 284
 285        free(opts->gpg_sign);
 286        free(opts->strategy);
 287        for (i = 0; i < opts->xopts_nr; i++)
 288                free(opts->xopts[i]);
 289        free(opts->xopts);
 290        strbuf_release(&opts->current_fixups);
 291
 292        strbuf_reset(&buf);
 293        strbuf_addstr(&buf, get_dir(opts));
 294        remove_dir_recursively(&buf, 0);
 295        strbuf_release(&buf);
 296
 297        return 0;
 298}
 299
 300static const char *action_name(const struct replay_opts *opts)
 301{
 302        switch (opts->action) {
 303        case REPLAY_REVERT:
 304                return N_("revert");
 305        case REPLAY_PICK:
 306                return N_("cherry-pick");
 307        case REPLAY_INTERACTIVE_REBASE:
 308                return N_("rebase -i");
 309        }
 310        die(_("Unknown action: %d"), opts->action);
 311}
 312
 313struct commit_message {
 314        char *parent_label;
 315        char *label;
 316        char *subject;
 317        const char *message;
 318};
 319
 320static const char *short_commit_name(struct commit *commit)
 321{
 322        return find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV);
 323}
 324
 325static int get_message(struct commit *commit, struct commit_message *out)
 326{
 327        const char *abbrev, *subject;
 328        int subject_len;
 329
 330        out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
 331        abbrev = short_commit_name(commit);
 332
 333        subject_len = find_commit_subject(out->message, &subject);
 334
 335        out->subject = xmemdupz(subject, subject_len);
 336        out->label = xstrfmt("%s... %s", abbrev, out->subject);
 337        out->parent_label = xstrfmt("parent of %s", out->label);
 338
 339        return 0;
 340}
 341
 342static void free_message(struct commit *commit, struct commit_message *msg)
 343{
 344        free(msg->parent_label);
 345        free(msg->label);
 346        free(msg->subject);
 347        unuse_commit_buffer(commit, msg->message);
 348}
 349
 350static void print_advice(int show_hint, struct replay_opts *opts)
 351{
 352        char *msg = getenv("GIT_CHERRY_PICK_HELP");
 353
 354        if (msg) {
 355                fprintf(stderr, "%s\n", msg);
 356                /*
 357                 * A conflict has occurred but the porcelain
 358                 * (typically rebase --interactive) wants to take care
 359                 * of the commit itself so remove CHERRY_PICK_HEAD
 360                 */
 361                unlink(git_path_cherry_pick_head());
 362                return;
 363        }
 364
 365        if (show_hint) {
 366                if (opts->no_commit)
 367                        advise(_("after resolving the conflicts, mark the corrected paths\n"
 368                                 "with 'git add <paths>' or 'git rm <paths>'"));
 369                else
 370                        advise(_("after resolving the conflicts, mark the corrected paths\n"
 371                                 "with 'git add <paths>' or 'git rm <paths>'\n"
 372                                 "and commit the result with 'git commit'"));
 373        }
 374}
 375
 376static int write_message(const void *buf, size_t len, const char *filename,
 377                         int append_eol)
 378{
 379        struct lock_file msg_file = LOCK_INIT;
 380
 381        int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
 382        if (msg_fd < 0)
 383                return error_errno(_("could not lock '%s'"), filename);
 384        if (write_in_full(msg_fd, buf, len) < 0) {
 385                error_errno(_("could not write to '%s'"), filename);
 386                rollback_lock_file(&msg_file);
 387                return -1;
 388        }
 389        if (append_eol && write(msg_fd, "\n", 1) < 0) {
 390                error_errno(_("could not write eol to '%s'"), filename);
 391                rollback_lock_file(&msg_file);
 392                return -1;
 393        }
 394        if (commit_lock_file(&msg_file) < 0)
 395                return error(_("failed to finalize '%s'"), filename);
 396
 397        return 0;
 398}
 399
 400/*
 401 * Reads a file that was presumably written by a shell script, i.e. with an
 402 * end-of-line marker that needs to be stripped.
 403 *
 404 * Note that only the last end-of-line marker is stripped, consistent with the
 405 * behavior of "$(cat path)" in a shell script.
 406 *
 407 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
 408 */
 409static int read_oneliner(struct strbuf *buf,
 410        const char *path, int skip_if_empty)
 411{
 412        int orig_len = buf->len;
 413
 414        if (!file_exists(path))
 415                return 0;
 416
 417        if (strbuf_read_file(buf, path, 0) < 0) {
 418                warning_errno(_("could not read '%s'"), path);
 419                return 0;
 420        }
 421
 422        if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
 423                if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
 424                        --buf->len;
 425                buf->buf[buf->len] = '\0';
 426        }
 427
 428        if (skip_if_empty && buf->len == orig_len)
 429                return 0;
 430
 431        return 1;
 432}
 433
 434static struct tree *empty_tree(void)
 435{
 436        return lookup_tree(the_hash_algo->empty_tree);
 437}
 438
 439static int error_dirty_index(struct replay_opts *opts)
 440{
 441        if (read_cache_unmerged())
 442                return error_resolve_conflict(_(action_name(opts)));
 443
 444        error(_("your local changes would be overwritten by %s."),
 445                _(action_name(opts)));
 446
 447        if (advice_commit_before_merge)
 448                advise(_("commit your changes or stash them to proceed."));
 449        return -1;
 450}
 451
 452static void update_abort_safety_file(void)
 453{
 454        struct object_id head;
 455
 456        /* Do nothing on a single-pick */
 457        if (!file_exists(git_path_seq_dir()))
 458                return;
 459
 460        if (!get_oid("HEAD", &head))
 461                write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
 462        else
 463                write_file(git_path_abort_safety_file(), "%s", "");
 464}
 465
 466static int fast_forward_to(const struct object_id *to, const struct object_id *from,
 467                        int unborn, struct replay_opts *opts)
 468{
 469        struct ref_transaction *transaction;
 470        struct strbuf sb = STRBUF_INIT;
 471        struct strbuf err = STRBUF_INIT;
 472
 473        read_cache();
 474        if (checkout_fast_forward(from, to, 1))
 475                return -1; /* the callee should have complained already */
 476
 477        strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
 478
 479        transaction = ref_transaction_begin(&err);
 480        if (!transaction ||
 481            ref_transaction_update(transaction, "HEAD",
 482                                   to, unborn && !is_rebase_i(opts) ?
 483                                   &null_oid : from,
 484                                   0, sb.buf, &err) ||
 485            ref_transaction_commit(transaction, &err)) {
 486                ref_transaction_free(transaction);
 487                error("%s", err.buf);
 488                strbuf_release(&sb);
 489                strbuf_release(&err);
 490                return -1;
 491        }
 492
 493        strbuf_release(&sb);
 494        strbuf_release(&err);
 495        ref_transaction_free(transaction);
 496        update_abort_safety_file();
 497        return 0;
 498}
 499
 500void append_conflicts_hint(struct strbuf *msgbuf)
 501{
 502        int i;
 503
 504        strbuf_addch(msgbuf, '\n');
 505        strbuf_commented_addf(msgbuf, "Conflicts:\n");
 506        for (i = 0; i < active_nr;) {
 507                const struct cache_entry *ce = active_cache[i++];
 508                if (ce_stage(ce)) {
 509                        strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
 510                        while (i < active_nr && !strcmp(ce->name,
 511                                                        active_cache[i]->name))
 512                                i++;
 513                }
 514        }
 515}
 516
 517static int do_recursive_merge(struct commit *base, struct commit *next,
 518                              const char *base_label, const char *next_label,
 519                              struct object_id *head, struct strbuf *msgbuf,
 520                              struct replay_opts *opts)
 521{
 522        struct merge_options o;
 523        struct tree *result, *next_tree, *base_tree, *head_tree;
 524        int clean;
 525        char **xopt;
 526        struct lock_file index_lock = LOCK_INIT;
 527
 528        if (hold_locked_index(&index_lock, LOCK_REPORT_ON_ERROR) < 0)
 529                return -1;
 530
 531        read_cache();
 532
 533        init_merge_options(&o);
 534        o.ancestor = base ? base_label : "(empty tree)";
 535        o.branch1 = "HEAD";
 536        o.branch2 = next ? next_label : "(empty tree)";
 537        if (is_rebase_i(opts))
 538                o.buffer_output = 2;
 539        o.show_rename_progress = 1;
 540
 541        head_tree = parse_tree_indirect(head);
 542        next_tree = next ? get_commit_tree(next) : empty_tree();
 543        base_tree = base ? get_commit_tree(base) : empty_tree();
 544
 545        for (xopt = opts->xopts; xopt != opts->xopts + opts->xopts_nr; xopt++)
 546                parse_merge_opt(&o, *xopt);
 547
 548        clean = merge_trees(&o,
 549                            head_tree,
 550                            next_tree, base_tree, &result);
 551        if (is_rebase_i(opts) && clean <= 0)
 552                fputs(o.obuf.buf, stdout);
 553        strbuf_release(&o.obuf);
 554        diff_warn_rename_limit("merge.renamelimit", o.needed_rename_limit, 0);
 555        if (clean < 0) {
 556                rollback_lock_file(&index_lock);
 557                return clean;
 558        }
 559
 560        if (write_locked_index(&the_index, &index_lock,
 561                               COMMIT_LOCK | SKIP_IF_UNCHANGED))
 562                /*
 563                 * TRANSLATORS: %s will be "revert", "cherry-pick" or
 564                 * "rebase -i".
 565                 */
 566                return error(_("%s: Unable to write new index file"),
 567                        _(action_name(opts)));
 568
 569        if (!clean)
 570                append_conflicts_hint(msgbuf);
 571
 572        return !clean;
 573}
 574
 575static struct object_id *get_cache_tree_oid(void)
 576{
 577        if (!active_cache_tree)
 578                active_cache_tree = cache_tree();
 579
 580        if (!cache_tree_fully_valid(active_cache_tree))
 581                if (cache_tree_update(&the_index, 0)) {
 582                        error(_("unable to update cache tree"));
 583                        return NULL;
 584                }
 585
 586        return &active_cache_tree->oid;
 587}
 588
 589static int is_index_unchanged(void)
 590{
 591        struct object_id head_oid, *cache_tree_oid;
 592        struct commit *head_commit;
 593
 594        if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, &head_oid, NULL))
 595                return error(_("could not resolve HEAD commit"));
 596
 597        head_commit = lookup_commit(&head_oid);
 598
 599        /*
 600         * If head_commit is NULL, check_commit, called from
 601         * lookup_commit, would have indicated that head_commit is not
 602         * a commit object already.  parse_commit() will return failure
 603         * without further complaints in such a case.  Otherwise, if
 604         * the commit is invalid, parse_commit() will complain.  So
 605         * there is nothing for us to say here.  Just return failure.
 606         */
 607        if (parse_commit(head_commit))
 608                return -1;
 609
 610        if (!(cache_tree_oid = get_cache_tree_oid()))
 611                return -1;
 612
 613        return !oidcmp(cache_tree_oid, get_commit_tree_oid(head_commit));
 614}
 615
 616static int write_author_script(const char *message)
 617{
 618        struct strbuf buf = STRBUF_INIT;
 619        const char *eol;
 620        int res;
 621
 622        for (;;)
 623                if (!*message || starts_with(message, "\n")) {
 624missing_author:
 625                        /* Missing 'author' line? */
 626                        unlink(rebase_path_author_script());
 627                        return 0;
 628                } else if (skip_prefix(message, "author ", &message))
 629                        break;
 630                else if ((eol = strchr(message, '\n')))
 631                        message = eol + 1;
 632                else
 633                        goto missing_author;
 634
 635        strbuf_addstr(&buf, "GIT_AUTHOR_NAME='");
 636        while (*message && *message != '\n' && *message != '\r')
 637                if (skip_prefix(message, " <", &message))
 638                        break;
 639                else if (*message != '\'')
 640                        strbuf_addch(&buf, *(message++));
 641                else
 642                        strbuf_addf(&buf, "'\\\\%c'", *(message++));
 643        strbuf_addstr(&buf, "'\nGIT_AUTHOR_EMAIL='");
 644        while (*message && *message != '\n' && *message != '\r')
 645                if (skip_prefix(message, "> ", &message))
 646                        break;
 647                else if (*message != '\'')
 648                        strbuf_addch(&buf, *(message++));
 649                else
 650                        strbuf_addf(&buf, "'\\\\%c'", *(message++));
 651        strbuf_addstr(&buf, "'\nGIT_AUTHOR_DATE='@");
 652        while (*message && *message != '\n' && *message != '\r')
 653                if (*message != '\'')
 654                        strbuf_addch(&buf, *(message++));
 655                else
 656                        strbuf_addf(&buf, "'\\\\%c'", *(message++));
 657        res = write_message(buf.buf, buf.len, rebase_path_author_script(), 1);
 658        strbuf_release(&buf);
 659        return res;
 660}
 661
 662/*
 663 * Read a list of environment variable assignments (such as the author-script
 664 * file) into an environment block. Returns -1 on error, 0 otherwise.
 665 */
 666static int read_env_script(struct argv_array *env)
 667{
 668        struct strbuf script = STRBUF_INIT;
 669        int i, count = 0;
 670        char *p, *p2;
 671
 672        if (strbuf_read_file(&script, rebase_path_author_script(), 256) <= 0)
 673                return -1;
 674
 675        for (p = script.buf; *p; p++)
 676                if (skip_prefix(p, "'\\\\''", (const char **)&p2))
 677                        strbuf_splice(&script, p - script.buf, p2 - p, "'", 1);
 678                else if (*p == '\'')
 679                        strbuf_splice(&script, p-- - script.buf, 1, "", 0);
 680                else if (*p == '\n') {
 681                        *p = '\0';
 682                        count++;
 683                }
 684
 685        for (i = 0, p = script.buf; i < count; i++) {
 686                argv_array_push(env, p);
 687                p += strlen(p) + 1;
 688        }
 689
 690        return 0;
 691}
 692
 693static char *get_author(const char *message)
 694{
 695        size_t len;
 696        const char *a;
 697
 698        a = find_commit_header(message, "author", &len);
 699        if (a)
 700                return xmemdupz(a, len);
 701
 702        return NULL;
 703}
 704
 705/* Read author-script and return an ident line (author <email> timestamp) */
 706static const char *read_author_ident(struct strbuf *buf)
 707{
 708        const char *keys[] = {
 709                "GIT_AUTHOR_NAME=", "GIT_AUTHOR_EMAIL=", "GIT_AUTHOR_DATE="
 710        };
 711        char *in, *out, *eol;
 712        int i = 0, len;
 713
 714        if (strbuf_read_file(buf, rebase_path_author_script(), 256) <= 0)
 715                return NULL;
 716
 717        /* dequote values and construct ident line in-place */
 718        for (in = out = buf->buf; i < 3 && in - buf->buf < buf->len; i++) {
 719                if (!skip_prefix(in, keys[i], (const char **)&in)) {
 720                        warning("could not parse '%s' (looking for '%s'",
 721                                rebase_path_author_script(), keys[i]);
 722                        return NULL;
 723                }
 724
 725                eol = strchrnul(in, '\n');
 726                *eol = '\0';
 727                sq_dequote(in);
 728                len = strlen(in);
 729
 730                if (i > 0) /* separate values by spaces */
 731                        *(out++) = ' ';
 732                if (i == 1) /* email needs to be surrounded by <...> */
 733                        *(out++) = '<';
 734                memmove(out, in, len);
 735                out += len;
 736                if (i == 1) /* email needs to be surrounded by <...> */
 737                        *(out++) = '>';
 738                in = eol + 1;
 739        }
 740
 741        if (i < 3) {
 742                warning("could not parse '%s' (looking for '%s')",
 743                        rebase_path_author_script(), keys[i]);
 744                return NULL;
 745        }
 746
 747        buf->len = out - buf->buf;
 748        return buf->buf;
 749}
 750
 751static const char staged_changes_advice[] =
 752N_("you have staged changes in your working tree\n"
 753"If these changes are meant to be squashed into the previous commit, run:\n"
 754"\n"
 755"  git commit --amend %s\n"
 756"\n"
 757"If they are meant to go into a new commit, run:\n"
 758"\n"
 759"  git commit %s\n"
 760"\n"
 761"In both cases, once you're done, continue with:\n"
 762"\n"
 763"  git rebase --continue\n");
 764
 765#define ALLOW_EMPTY (1<<0)
 766#define EDIT_MSG    (1<<1)
 767#define AMEND_MSG   (1<<2)
 768#define CLEANUP_MSG (1<<3)
 769#define VERIFY_MSG  (1<<4)
 770#define CREATE_ROOT_COMMIT (1<<5)
 771
 772/*
 773 * If we are cherry-pick, and if the merge did not result in
 774 * hand-editing, we will hit this commit and inherit the original
 775 * author date and name.
 776 *
 777 * If we are revert, or if our cherry-pick results in a hand merge,
 778 * we had better say that the current user is responsible for that.
 779 *
 780 * An exception is when run_git_commit() is called during an
 781 * interactive rebase: in that case, we will want to retain the
 782 * author metadata.
 783 */
 784static int run_git_commit(const char *defmsg, struct replay_opts *opts,
 785                          unsigned int flags)
 786{
 787        struct child_process cmd = CHILD_PROCESS_INIT;
 788        const char *value;
 789
 790        if ((flags & CREATE_ROOT_COMMIT) && !(flags & AMEND_MSG)) {
 791                struct strbuf msg = STRBUF_INIT, script = STRBUF_INIT;
 792                const char *author = is_rebase_i(opts) ?
 793                        read_author_ident(&script) : NULL;
 794                struct object_id root_commit, *cache_tree_oid;
 795                int res = 0;
 796
 797                if (!defmsg)
 798                        BUG("root commit without message");
 799
 800                if (!(cache_tree_oid = get_cache_tree_oid()))
 801                        res = -1;
 802
 803                if (!res)
 804                        res = strbuf_read_file(&msg, defmsg, 0);
 805
 806                if (res <= 0)
 807                        res = error_errno(_("could not read '%s'"), defmsg);
 808                else
 809                        res = commit_tree(msg.buf, msg.len, cache_tree_oid,
 810                                          NULL, &root_commit, author,
 811                                          opts->gpg_sign);
 812
 813                strbuf_release(&msg);
 814                strbuf_release(&script);
 815                if (!res) {
 816                        update_ref(NULL, "CHERRY_PICK_HEAD", &root_commit, NULL,
 817                                   REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR);
 818                        res = update_ref(NULL, "HEAD", &root_commit, NULL, 0,
 819                                         UPDATE_REFS_MSG_ON_ERR);
 820                }
 821                return res < 0 ? error(_("writing root commit")) : 0;
 822        }
 823
 824        cmd.git_cmd = 1;
 825
 826        if (is_rebase_i(opts)) {
 827                if (!(flags & EDIT_MSG)) {
 828                        cmd.stdout_to_stderr = 1;
 829                        cmd.err = -1;
 830                }
 831
 832                if (read_env_script(&cmd.env_array)) {
 833                        const char *gpg_opt = gpg_sign_opt_quoted(opts);
 834
 835                        return error(_(staged_changes_advice),
 836                                     gpg_opt, gpg_opt);
 837                }
 838        }
 839
 840        argv_array_push(&cmd.args, "commit");
 841
 842        if (!(flags & VERIFY_MSG))
 843                argv_array_push(&cmd.args, "-n");
 844        if ((flags & AMEND_MSG))
 845                argv_array_push(&cmd.args, "--amend");
 846        if (opts->gpg_sign)
 847                argv_array_pushf(&cmd.args, "-S%s", opts->gpg_sign);
 848        if (defmsg)
 849                argv_array_pushl(&cmd.args, "-F", defmsg, NULL);
 850        else if (!(flags & EDIT_MSG))
 851                argv_array_pushl(&cmd.args, "-C", "HEAD", NULL);
 852        if ((flags & CLEANUP_MSG))
 853                argv_array_push(&cmd.args, "--cleanup=strip");
 854        if ((flags & EDIT_MSG))
 855                argv_array_push(&cmd.args, "-e");
 856        else if (!(flags & CLEANUP_MSG) &&
 857                 !opts->signoff && !opts->record_origin &&
 858                 git_config_get_value("commit.cleanup", &value))
 859                argv_array_push(&cmd.args, "--cleanup=verbatim");
 860
 861        if ((flags & ALLOW_EMPTY))
 862                argv_array_push(&cmd.args, "--allow-empty");
 863
 864        if (opts->allow_empty_message)
 865                argv_array_push(&cmd.args, "--allow-empty-message");
 866
 867        if (cmd.err == -1) {
 868                /* hide stderr on success */
 869                struct strbuf buf = STRBUF_INIT;
 870                int rc = pipe_command(&cmd,
 871                                      NULL, 0,
 872                                      /* stdout is already redirected */
 873                                      NULL, 0,
 874                                      &buf, 0);
 875                if (rc)
 876                        fputs(buf.buf, stderr);
 877                strbuf_release(&buf);
 878                return rc;
 879        }
 880
 881        return run_command(&cmd);
 882}
 883
 884static int rest_is_empty(const struct strbuf *sb, int start)
 885{
 886        int i, eol;
 887        const char *nl;
 888
 889        /* Check if the rest is just whitespace and Signed-off-by's. */
 890        for (i = start; i < sb->len; i++) {
 891                nl = memchr(sb->buf + i, '\n', sb->len - i);
 892                if (nl)
 893                        eol = nl - sb->buf;
 894                else
 895                        eol = sb->len;
 896
 897                if (strlen(sign_off_header) <= eol - i &&
 898                    starts_with(sb->buf + i, sign_off_header)) {
 899                        i = eol;
 900                        continue;
 901                }
 902                while (i < eol)
 903                        if (!isspace(sb->buf[i++]))
 904                                return 0;
 905        }
 906
 907        return 1;
 908}
 909
 910/*
 911 * Find out if the message in the strbuf contains only whitespace and
 912 * Signed-off-by lines.
 913 */
 914int message_is_empty(const struct strbuf *sb,
 915                     enum commit_msg_cleanup_mode cleanup_mode)
 916{
 917        if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
 918                return 0;
 919        return rest_is_empty(sb, 0);
 920}
 921
 922/*
 923 * See if the user edited the message in the editor or left what
 924 * was in the template intact
 925 */
 926int template_untouched(const struct strbuf *sb, const char *template_file,
 927                       enum commit_msg_cleanup_mode cleanup_mode)
 928{
 929        struct strbuf tmpl = STRBUF_INIT;
 930        const char *start;
 931
 932        if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
 933                return 0;
 934
 935        if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
 936                return 0;
 937
 938        strbuf_stripspace(&tmpl, cleanup_mode == COMMIT_MSG_CLEANUP_ALL);
 939        if (!skip_prefix(sb->buf, tmpl.buf, &start))
 940                start = sb->buf;
 941        strbuf_release(&tmpl);
 942        return rest_is_empty(sb, start - sb->buf);
 943}
 944
 945int update_head_with_reflog(const struct commit *old_head,
 946                            const struct object_id *new_head,
 947                            const char *action, const struct strbuf *msg,
 948                            struct strbuf *err)
 949{
 950        struct ref_transaction *transaction;
 951        struct strbuf sb = STRBUF_INIT;
 952        const char *nl;
 953        int ret = 0;
 954
 955        if (action) {
 956                strbuf_addstr(&sb, action);
 957                strbuf_addstr(&sb, ": ");
 958        }
 959
 960        nl = strchr(msg->buf, '\n');
 961        if (nl) {
 962                strbuf_add(&sb, msg->buf, nl + 1 - msg->buf);
 963        } else {
 964                strbuf_addbuf(&sb, msg);
 965                strbuf_addch(&sb, '\n');
 966        }
 967
 968        transaction = ref_transaction_begin(err);
 969        if (!transaction ||
 970            ref_transaction_update(transaction, "HEAD", new_head,
 971                                   old_head ? &old_head->object.oid : &null_oid,
 972                                   0, sb.buf, err) ||
 973            ref_transaction_commit(transaction, err)) {
 974                ret = -1;
 975        }
 976        ref_transaction_free(transaction);
 977        strbuf_release(&sb);
 978
 979        return ret;
 980}
 981
 982static int run_rewrite_hook(const struct object_id *oldoid,
 983                            const struct object_id *newoid)
 984{
 985        struct child_process proc = CHILD_PROCESS_INIT;
 986        const char *argv[3];
 987        int code;
 988        struct strbuf sb = STRBUF_INIT;
 989
 990        argv[0] = find_hook("post-rewrite");
 991        if (!argv[0])
 992                return 0;
 993
 994        argv[1] = "amend";
 995        argv[2] = NULL;
 996
 997        proc.argv = argv;
 998        proc.in = -1;
 999        proc.stdout_to_stderr = 1;
1000
1001        code = start_command(&proc);
1002        if (code)
1003                return code;
1004        strbuf_addf(&sb, "%s %s\n", oid_to_hex(oldoid), oid_to_hex(newoid));
1005        sigchain_push(SIGPIPE, SIG_IGN);
1006        write_in_full(proc.in, sb.buf, sb.len);
1007        close(proc.in);
1008        strbuf_release(&sb);
1009        sigchain_pop(SIGPIPE);
1010        return finish_command(&proc);
1011}
1012
1013void commit_post_rewrite(const struct commit *old_head,
1014                         const struct object_id *new_head)
1015{
1016        struct notes_rewrite_cfg *cfg;
1017
1018        cfg = init_copy_notes_for_rewrite("amend");
1019        if (cfg) {
1020                /* we are amending, so old_head is not NULL */
1021                copy_note_for_rewrite(cfg, &old_head->object.oid, new_head);
1022                finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1023        }
1024        run_rewrite_hook(&old_head->object.oid, new_head);
1025}
1026
1027static int run_prepare_commit_msg_hook(struct strbuf *msg, const char *commit)
1028{
1029        struct argv_array hook_env = ARGV_ARRAY_INIT;
1030        int ret;
1031        const char *name;
1032
1033        name = git_path_commit_editmsg();
1034        if (write_message(msg->buf, msg->len, name, 0))
1035                return -1;
1036
1037        argv_array_pushf(&hook_env, "GIT_INDEX_FILE=%s", get_index_file());
1038        argv_array_push(&hook_env, "GIT_EDITOR=:");
1039        if (commit)
1040                ret = run_hook_le(hook_env.argv, "prepare-commit-msg", name,
1041                                  "commit", commit, NULL);
1042        else
1043                ret = run_hook_le(hook_env.argv, "prepare-commit-msg", name,
1044                                  "message", NULL);
1045        if (ret)
1046                ret = error(_("'prepare-commit-msg' hook failed"));
1047        argv_array_clear(&hook_env);
1048
1049        return ret;
1050}
1051
1052static const char implicit_ident_advice_noconfig[] =
1053N_("Your name and email address were configured automatically based\n"
1054"on your username and hostname. Please check that they are accurate.\n"
1055"You can suppress this message by setting them explicitly. Run the\n"
1056"following command and follow the instructions in your editor to edit\n"
1057"your configuration file:\n"
1058"\n"
1059"    git config --global --edit\n"
1060"\n"
1061"After doing this, you may fix the identity used for this commit with:\n"
1062"\n"
1063"    git commit --amend --reset-author\n");
1064
1065static const char implicit_ident_advice_config[] =
1066N_("Your name and email address were configured automatically based\n"
1067"on your username and hostname. Please check that they are accurate.\n"
1068"You can suppress this message by setting them explicitly:\n"
1069"\n"
1070"    git config --global user.name \"Your Name\"\n"
1071"    git config --global user.email you@example.com\n"
1072"\n"
1073"After doing this, you may fix the identity used for this commit with:\n"
1074"\n"
1075"    git commit --amend --reset-author\n");
1076
1077static const char *implicit_ident_advice(void)
1078{
1079        char *user_config = expand_user_path("~/.gitconfig", 0);
1080        char *xdg_config = xdg_config_home("config");
1081        int config_exists = file_exists(user_config) || file_exists(xdg_config);
1082
1083        free(user_config);
1084        free(xdg_config);
1085
1086        if (config_exists)
1087                return _(implicit_ident_advice_config);
1088        else
1089                return _(implicit_ident_advice_noconfig);
1090
1091}
1092
1093void print_commit_summary(const char *prefix, const struct object_id *oid,
1094                          unsigned int flags)
1095{
1096        struct rev_info rev;
1097        struct commit *commit;
1098        struct strbuf format = STRBUF_INIT;
1099        const char *head;
1100        struct pretty_print_context pctx = {0};
1101        struct strbuf author_ident = STRBUF_INIT;
1102        struct strbuf committer_ident = STRBUF_INIT;
1103
1104        commit = lookup_commit(oid);
1105        if (!commit)
1106                die(_("couldn't look up newly created commit"));
1107        if (parse_commit(commit))
1108                die(_("could not parse newly created commit"));
1109
1110        strbuf_addstr(&format, "format:%h] %s");
1111
1112        format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1113        format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1114        if (strbuf_cmp(&author_ident, &committer_ident)) {
1115                strbuf_addstr(&format, "\n Author: ");
1116                strbuf_addbuf_percentquote(&format, &author_ident);
1117        }
1118        if (flags & SUMMARY_SHOW_AUTHOR_DATE) {
1119                struct strbuf date = STRBUF_INIT;
1120
1121                format_commit_message(commit, "%ad", &date, &pctx);
1122                strbuf_addstr(&format, "\n Date: ");
1123                strbuf_addbuf_percentquote(&format, &date);
1124                strbuf_release(&date);
1125        }
1126        if (!committer_ident_sufficiently_given()) {
1127                strbuf_addstr(&format, "\n Committer: ");
1128                strbuf_addbuf_percentquote(&format, &committer_ident);
1129                if (advice_implicit_identity) {
1130                        strbuf_addch(&format, '\n');
1131                        strbuf_addstr(&format, implicit_ident_advice());
1132                }
1133        }
1134        strbuf_release(&author_ident);
1135        strbuf_release(&committer_ident);
1136
1137        init_revisions(&rev, prefix);
1138        setup_revisions(0, NULL, &rev, NULL);
1139
1140        rev.diff = 1;
1141        rev.diffopt.output_format =
1142                DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1143
1144        rev.verbose_header = 1;
1145        rev.show_root_diff = 1;
1146        get_commit_format(format.buf, &rev);
1147        rev.always_show_header = 0;
1148        rev.diffopt.detect_rename = DIFF_DETECT_RENAME;
1149        rev.diffopt.break_opt = 0;
1150        diff_setup_done(&rev.diffopt);
1151
1152        head = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1153        if (!head)
1154                die_errno(_("unable to resolve HEAD after creating commit"));
1155        if (!strcmp(head, "HEAD"))
1156                head = _("detached HEAD");
1157        else
1158                skip_prefix(head, "refs/heads/", &head);
1159        printf("[%s%s ", head, (flags & SUMMARY_INITIAL_COMMIT) ?
1160                                                _(" (root-commit)") : "");
1161
1162        if (!log_tree_commit(&rev, commit)) {
1163                rev.always_show_header = 1;
1164                rev.use_terminator = 1;
1165                log_tree_commit(&rev, commit);
1166        }
1167
1168        strbuf_release(&format);
1169}
1170
1171static int parse_head(struct commit **head)
1172{
1173        struct commit *current_head;
1174        struct object_id oid;
1175
1176        if (get_oid("HEAD", &oid)) {
1177                current_head = NULL;
1178        } else {
1179                current_head = lookup_commit_reference(&oid);
1180                if (!current_head)
1181                        return error(_("could not parse HEAD"));
1182                if (oidcmp(&oid, &current_head->object.oid)) {
1183                        warning(_("HEAD %s is not a commit!"),
1184                                oid_to_hex(&oid));
1185                }
1186                if (parse_commit(current_head))
1187                        return error(_("could not parse HEAD commit"));
1188        }
1189        *head = current_head;
1190
1191        return 0;
1192}
1193
1194/*
1195 * Try to commit without forking 'git commit'. In some cases we need
1196 * to run 'git commit' to display an error message
1197 *
1198 * Returns:
1199 *  -1 - error unable to commit
1200 *   0 - success
1201 *   1 - run 'git commit'
1202 */
1203static int try_to_commit(struct strbuf *msg, const char *author,
1204                         struct replay_opts *opts, unsigned int flags,
1205                         struct object_id *oid)
1206{
1207        struct object_id tree;
1208        struct commit *current_head;
1209        struct commit_list *parents = NULL;
1210        struct commit_extra_header *extra = NULL;
1211        struct strbuf err = STRBUF_INIT;
1212        struct strbuf commit_msg = STRBUF_INIT;
1213        char *amend_author = NULL;
1214        const char *hook_commit = NULL;
1215        enum commit_msg_cleanup_mode cleanup;
1216        int res = 0;
1217
1218        if (parse_head(&current_head))
1219                return -1;
1220
1221        if (flags & AMEND_MSG) {
1222                const char *exclude_gpgsig[] = { "gpgsig", NULL };
1223                const char *out_enc = get_commit_output_encoding();
1224                const char *message = logmsg_reencode(current_head, NULL,
1225                                                      out_enc);
1226
1227                if (!msg) {
1228                        const char *orig_message = NULL;
1229
1230                        find_commit_subject(message, &orig_message);
1231                        msg = &commit_msg;
1232                        strbuf_addstr(msg, orig_message);
1233                        hook_commit = "HEAD";
1234                }
1235                author = amend_author = get_author(message);
1236                unuse_commit_buffer(current_head, message);
1237                if (!author) {
1238                        res = error(_("unable to parse commit author"));
1239                        goto out;
1240                }
1241                parents = copy_commit_list(current_head->parents);
1242                extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1243        } else if (current_head) {
1244                commit_list_insert(current_head, &parents);
1245        }
1246
1247        if (write_cache_as_tree(&tree, 0, NULL)) {
1248                res = error(_("git write-tree failed to write a tree"));
1249                goto out;
1250        }
1251
1252        if (!(flags & ALLOW_EMPTY) && !oidcmp(current_head ?
1253                                              get_commit_tree_oid(current_head) :
1254                                              the_hash_algo->empty_tree, &tree)) {
1255                res = 1; /* run 'git commit' to display error message */
1256                goto out;
1257        }
1258
1259        if (find_hook("prepare-commit-msg")) {
1260                res = run_prepare_commit_msg_hook(msg, hook_commit);
1261                if (res)
1262                        goto out;
1263                if (strbuf_read_file(&commit_msg, git_path_commit_editmsg(),
1264                                     2048) < 0) {
1265                        res = error_errno(_("unable to read commit message "
1266                                              "from '%s'"),
1267                                            git_path_commit_editmsg());
1268                        goto out;
1269                }
1270                msg = &commit_msg;
1271        }
1272
1273        cleanup = (flags & CLEANUP_MSG) ? COMMIT_MSG_CLEANUP_ALL :
1274                                          opts->default_msg_cleanup;
1275
1276        if (cleanup != COMMIT_MSG_CLEANUP_NONE)
1277                strbuf_stripspace(msg, cleanup == COMMIT_MSG_CLEANUP_ALL);
1278        if (!opts->allow_empty_message && message_is_empty(msg, cleanup)) {
1279                res = 1; /* run 'git commit' to display error message */
1280                goto out;
1281        }
1282
1283        reset_ident_date();
1284
1285        if (commit_tree_extended(msg->buf, msg->len, &tree, parents,
1286                                 oid, author, opts->gpg_sign, extra)) {
1287                res = error(_("failed to write commit object"));
1288                goto out;
1289        }
1290
1291        if (update_head_with_reflog(current_head, oid,
1292                                    getenv("GIT_REFLOG_ACTION"), msg, &err)) {
1293                res = error("%s", err.buf);
1294                goto out;
1295        }
1296
1297        if (flags & AMEND_MSG)
1298                commit_post_rewrite(current_head, oid);
1299
1300out:
1301        free_commit_extra_headers(extra);
1302        strbuf_release(&err);
1303        strbuf_release(&commit_msg);
1304        free(amend_author);
1305
1306        return res;
1307}
1308
1309static int do_commit(const char *msg_file, const char *author,
1310                     struct replay_opts *opts, unsigned int flags)
1311{
1312        int res = 1;
1313
1314        if (!(flags & EDIT_MSG) && !(flags & VERIFY_MSG) &&
1315            !(flags & CREATE_ROOT_COMMIT)) {
1316                struct object_id oid;
1317                struct strbuf sb = STRBUF_INIT;
1318
1319                if (msg_file && strbuf_read_file(&sb, msg_file, 2048) < 0)
1320                        return error_errno(_("unable to read commit message "
1321                                             "from '%s'"),
1322                                           msg_file);
1323
1324                res = try_to_commit(msg_file ? &sb : NULL, author, opts, flags,
1325                                    &oid);
1326                strbuf_release(&sb);
1327                if (!res) {
1328                        unlink(git_path_cherry_pick_head());
1329                        unlink(git_path_merge_msg());
1330                        if (!is_rebase_i(opts))
1331                                print_commit_summary(NULL, &oid,
1332                                                SUMMARY_SHOW_AUTHOR_DATE);
1333                        return res;
1334                }
1335        }
1336        if (res == 1)
1337                return run_git_commit(msg_file, opts, flags);
1338
1339        return res;
1340}
1341
1342static int is_original_commit_empty(struct commit *commit)
1343{
1344        const struct object_id *ptree_oid;
1345
1346        if (parse_commit(commit))
1347                return error(_("could not parse commit %s"),
1348                             oid_to_hex(&commit->object.oid));
1349        if (commit->parents) {
1350                struct commit *parent = commit->parents->item;
1351                if (parse_commit(parent))
1352                        return error(_("could not parse parent commit %s"),
1353                                oid_to_hex(&parent->object.oid));
1354                ptree_oid = get_commit_tree_oid(parent);
1355        } else {
1356                ptree_oid = the_hash_algo->empty_tree; /* commit is root */
1357        }
1358
1359        return !oidcmp(ptree_oid, get_commit_tree_oid(commit));
1360}
1361
1362/*
1363 * Do we run "git commit" with "--allow-empty"?
1364 */
1365static int allow_empty(struct replay_opts *opts, struct commit *commit)
1366{
1367        int index_unchanged, empty_commit;
1368
1369        /*
1370         * Three cases:
1371         *
1372         * (1) we do not allow empty at all and error out.
1373         *
1374         * (2) we allow ones that were initially empty, but
1375         * forbid the ones that become empty;
1376         *
1377         * (3) we allow both.
1378         */
1379        if (!opts->allow_empty)
1380                return 0; /* let "git commit" barf as necessary */
1381
1382        index_unchanged = is_index_unchanged();
1383        if (index_unchanged < 0)
1384                return index_unchanged;
1385        if (!index_unchanged)
1386                return 0; /* we do not have to say --allow-empty */
1387
1388        if (opts->keep_redundant_commits)
1389                return 1;
1390
1391        empty_commit = is_original_commit_empty(commit);
1392        if (empty_commit < 0)
1393                return empty_commit;
1394        if (!empty_commit)
1395                return 0;
1396        else
1397                return 1;
1398}
1399
1400/*
1401 * Note that ordering matters in this enum. Not only must it match the mapping
1402 * below, it is also divided into several sections that matter.  When adding
1403 * new commands, make sure you add it in the right section.
1404 */
1405enum todo_command {
1406        /* commands that handle commits */
1407        TODO_PICK = 0,
1408        TODO_REVERT,
1409        TODO_EDIT,
1410        TODO_REWORD,
1411        TODO_FIXUP,
1412        TODO_SQUASH,
1413        /* commands that do something else than handling a single commit */
1414        TODO_EXEC,
1415        TODO_LABEL,
1416        TODO_RESET,
1417        TODO_MERGE,
1418        /* commands that do nothing but are counted for reporting progress */
1419        TODO_NOOP,
1420        TODO_DROP,
1421        /* comments (not counted for reporting progress) */
1422        TODO_COMMENT
1423};
1424
1425static struct {
1426        char c;
1427        const char *str;
1428} todo_command_info[] = {
1429        { 'p', "pick" },
1430        { 0,   "revert" },
1431        { 'e', "edit" },
1432        { 'r', "reword" },
1433        { 'f', "fixup" },
1434        { 's', "squash" },
1435        { 'x', "exec" },
1436        { 'l', "label" },
1437        { 't', "reset" },
1438        { 'm', "merge" },
1439        { 0,   "noop" },
1440        { 'd', "drop" },
1441        { 0,   NULL }
1442};
1443
1444static const char *command_to_string(const enum todo_command command)
1445{
1446        if (command < TODO_COMMENT)
1447                return todo_command_info[command].str;
1448        die("Unknown command: %d", command);
1449}
1450
1451static char command_to_char(const enum todo_command command)
1452{
1453        if (command < TODO_COMMENT && todo_command_info[command].c)
1454                return todo_command_info[command].c;
1455        return comment_line_char;
1456}
1457
1458static int is_noop(const enum todo_command command)
1459{
1460        return TODO_NOOP <= command;
1461}
1462
1463static int is_fixup(enum todo_command command)
1464{
1465        return command == TODO_FIXUP || command == TODO_SQUASH;
1466}
1467
1468/* Does this command create a (non-merge) commit? */
1469static int is_pick_or_similar(enum todo_command command)
1470{
1471        switch (command) {
1472        case TODO_PICK:
1473        case TODO_REVERT:
1474        case TODO_EDIT:
1475        case TODO_REWORD:
1476        case TODO_FIXUP:
1477        case TODO_SQUASH:
1478                return 1;
1479        default:
1480                return 0;
1481        }
1482}
1483
1484static int update_squash_messages(enum todo_command command,
1485                struct commit *commit, struct replay_opts *opts)
1486{
1487        struct strbuf buf = STRBUF_INIT;
1488        int res;
1489        const char *message, *body;
1490
1491        if (opts->current_fixup_count > 0) {
1492                struct strbuf header = STRBUF_INIT;
1493                char *eol;
1494
1495                if (strbuf_read_file(&buf, rebase_path_squash_msg(), 9) <= 0)
1496                        return error(_("could not read '%s'"),
1497                                rebase_path_squash_msg());
1498
1499                eol = buf.buf[0] != comment_line_char ?
1500                        buf.buf : strchrnul(buf.buf, '\n');
1501
1502                strbuf_addf(&header, "%c ", comment_line_char);
1503                strbuf_addf(&header, _("This is a combination of %d commits."),
1504                            opts->current_fixup_count + 2);
1505                strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
1506                strbuf_release(&header);
1507        } else {
1508                struct object_id head;
1509                struct commit *head_commit;
1510                const char *head_message, *body;
1511
1512                if (get_oid("HEAD", &head))
1513                        return error(_("need a HEAD to fixup"));
1514                if (!(head_commit = lookup_commit_reference(&head)))
1515                        return error(_("could not read HEAD"));
1516                if (!(head_message = get_commit_buffer(head_commit, NULL)))
1517                        return error(_("could not read HEAD's commit message"));
1518
1519                find_commit_subject(head_message, &body);
1520                if (write_message(body, strlen(body),
1521                                  rebase_path_fixup_msg(), 0)) {
1522                        unuse_commit_buffer(head_commit, head_message);
1523                        return error(_("cannot write '%s'"),
1524                                     rebase_path_fixup_msg());
1525                }
1526
1527                strbuf_addf(&buf, "%c ", comment_line_char);
1528                strbuf_addf(&buf, _("This is a combination of %d commits."), 2);
1529                strbuf_addf(&buf, "\n%c ", comment_line_char);
1530                strbuf_addstr(&buf, _("This is the 1st commit message:"));
1531                strbuf_addstr(&buf, "\n\n");
1532                strbuf_addstr(&buf, body);
1533
1534                unuse_commit_buffer(head_commit, head_message);
1535        }
1536
1537        if (!(message = get_commit_buffer(commit, NULL)))
1538                return error(_("could not read commit message of %s"),
1539                             oid_to_hex(&commit->object.oid));
1540        find_commit_subject(message, &body);
1541
1542        if (command == TODO_SQUASH) {
1543                unlink(rebase_path_fixup_msg());
1544                strbuf_addf(&buf, "\n%c ", comment_line_char);
1545                strbuf_addf(&buf, _("This is the commit message #%d:"),
1546                            ++opts->current_fixup_count);
1547                strbuf_addstr(&buf, "\n\n");
1548                strbuf_addstr(&buf, body);
1549        } else if (command == TODO_FIXUP) {
1550                strbuf_addf(&buf, "\n%c ", comment_line_char);
1551                strbuf_addf(&buf, _("The commit message #%d will be skipped:"),
1552                            ++opts->current_fixup_count);
1553                strbuf_addstr(&buf, "\n\n");
1554                strbuf_add_commented_lines(&buf, body, strlen(body));
1555        } else
1556                return error(_("unknown command: %d"), command);
1557        unuse_commit_buffer(commit, message);
1558
1559        res = write_message(buf.buf, buf.len, rebase_path_squash_msg(), 0);
1560        strbuf_release(&buf);
1561
1562        if (!res) {
1563                strbuf_addf(&opts->current_fixups, "%s%s %s",
1564                            opts->current_fixups.len ? "\n" : "",
1565                            command_to_string(command),
1566                            oid_to_hex(&commit->object.oid));
1567                res = write_message(opts->current_fixups.buf,
1568                                    opts->current_fixups.len,
1569                                    rebase_path_current_fixups(), 0);
1570        }
1571
1572        return res;
1573}
1574
1575static void flush_rewritten_pending(void) {
1576        struct strbuf buf = STRBUF_INIT;
1577        struct object_id newoid;
1578        FILE *out;
1579
1580        if (strbuf_read_file(&buf, rebase_path_rewritten_pending(), (GIT_MAX_HEXSZ + 1) * 2) > 0 &&
1581            !get_oid("HEAD", &newoid) &&
1582            (out = fopen_or_warn(rebase_path_rewritten_list(), "a"))) {
1583                char *bol = buf.buf, *eol;
1584
1585                while (*bol) {
1586                        eol = strchrnul(bol, '\n');
1587                        fprintf(out, "%.*s %s\n", (int)(eol - bol),
1588                                        bol, oid_to_hex(&newoid));
1589                        if (!*eol)
1590                                break;
1591                        bol = eol + 1;
1592                }
1593                fclose(out);
1594                unlink(rebase_path_rewritten_pending());
1595        }
1596        strbuf_release(&buf);
1597}
1598
1599static void record_in_rewritten(struct object_id *oid,
1600                enum todo_command next_command) {
1601        FILE *out = fopen_or_warn(rebase_path_rewritten_pending(), "a");
1602
1603        if (!out)
1604                return;
1605
1606        fprintf(out, "%s\n", oid_to_hex(oid));
1607        fclose(out);
1608
1609        if (!is_fixup(next_command))
1610                flush_rewritten_pending();
1611}
1612
1613static int do_pick_commit(enum todo_command command, struct commit *commit,
1614                struct replay_opts *opts, int final_fixup)
1615{
1616        unsigned int flags = opts->edit ? EDIT_MSG : 0;
1617        const char *msg_file = opts->edit ? NULL : git_path_merge_msg();
1618        struct object_id head;
1619        struct commit *base, *next, *parent;
1620        const char *base_label, *next_label;
1621        char *author = NULL;
1622        struct commit_message msg = { NULL, NULL, NULL, NULL };
1623        struct strbuf msgbuf = STRBUF_INIT;
1624        int res, unborn = 0, allow;
1625
1626        if (opts->no_commit) {
1627                /*
1628                 * We do not intend to commit immediately.  We just want to
1629                 * merge the differences in, so let's compute the tree
1630                 * that represents the "current" state for merge-recursive
1631                 * to work on.
1632                 */
1633                if (write_cache_as_tree(&head, 0, NULL))
1634                        return error(_("your index file is unmerged."));
1635        } else {
1636                unborn = get_oid("HEAD", &head);
1637                /* Do we want to generate a root commit? */
1638                if (is_pick_or_similar(command) && opts->have_squash_onto &&
1639                    !oidcmp(&head, &opts->squash_onto)) {
1640                        if (is_fixup(command))
1641                                return error(_("cannot fixup root commit"));
1642                        flags |= CREATE_ROOT_COMMIT;
1643                        unborn = 1;
1644                } else if (unborn)
1645                        oidcpy(&head, the_hash_algo->empty_tree);
1646                if (index_differs_from(unborn ? empty_tree_oid_hex() : "HEAD",
1647                                       NULL, 0))
1648                        return error_dirty_index(opts);
1649        }
1650        discard_cache();
1651
1652        if (!commit->parents)
1653                parent = NULL;
1654        else if (commit->parents->next) {
1655                /* Reverting or cherry-picking a merge commit */
1656                int cnt;
1657                struct commit_list *p;
1658
1659                if (!opts->mainline)
1660                        return error(_("commit %s is a merge but no -m option was given."),
1661                                oid_to_hex(&commit->object.oid));
1662
1663                for (cnt = 1, p = commit->parents;
1664                     cnt != opts->mainline && p;
1665                     cnt++)
1666                        p = p->next;
1667                if (cnt != opts->mainline || !p)
1668                        return error(_("commit %s does not have parent %d"),
1669                                oid_to_hex(&commit->object.oid), opts->mainline);
1670                parent = p->item;
1671        } else if (0 < opts->mainline)
1672                return error(_("mainline was specified but commit %s is not a merge."),
1673                        oid_to_hex(&commit->object.oid));
1674        else
1675                parent = commit->parents->item;
1676
1677        if (get_message(commit, &msg) != 0)
1678                return error(_("cannot get commit message for %s"),
1679                        oid_to_hex(&commit->object.oid));
1680
1681        if (opts->allow_ff && !is_fixup(command) &&
1682            ((parent && !oidcmp(&parent->object.oid, &head)) ||
1683             (!parent && unborn))) {
1684                if (is_rebase_i(opts))
1685                        write_author_script(msg.message);
1686                res = fast_forward_to(&commit->object.oid, &head, unborn,
1687                        opts);
1688                if (res || command != TODO_REWORD)
1689                        goto leave;
1690                flags |= EDIT_MSG | AMEND_MSG | VERIFY_MSG;
1691                msg_file = NULL;
1692                goto fast_forward_edit;
1693        }
1694        if (parent && parse_commit(parent) < 0)
1695                /* TRANSLATORS: The first %s will be a "todo" command like
1696                   "revert" or "pick", the second %s a SHA1. */
1697                return error(_("%s: cannot parse parent commit %s"),
1698                        command_to_string(command),
1699                        oid_to_hex(&parent->object.oid));
1700
1701        /*
1702         * "commit" is an existing commit.  We would want to apply
1703         * the difference it introduces since its first parent "prev"
1704         * on top of the current HEAD if we are cherry-pick.  Or the
1705         * reverse of it if we are revert.
1706         */
1707
1708        if (command == TODO_REVERT) {
1709                base = commit;
1710                base_label = msg.label;
1711                next = parent;
1712                next_label = msg.parent_label;
1713                strbuf_addstr(&msgbuf, "Revert \"");
1714                strbuf_addstr(&msgbuf, msg.subject);
1715                strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
1716                strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1717
1718                if (commit->parents && commit->parents->next) {
1719                        strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
1720                        strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
1721                }
1722                strbuf_addstr(&msgbuf, ".\n");
1723        } else {
1724                const char *p;
1725
1726                base = parent;
1727                base_label = msg.parent_label;
1728                next = commit;
1729                next_label = msg.label;
1730
1731                /* Append the commit log message to msgbuf. */
1732                if (find_commit_subject(msg.message, &p))
1733                        strbuf_addstr(&msgbuf, p);
1734
1735                if (opts->record_origin) {
1736                        strbuf_complete_line(&msgbuf);
1737                        if (!has_conforming_footer(&msgbuf, NULL, 0))
1738                                strbuf_addch(&msgbuf, '\n');
1739                        strbuf_addstr(&msgbuf, cherry_picked_prefix);
1740                        strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1741                        strbuf_addstr(&msgbuf, ")\n");
1742                }
1743                if (!is_fixup(command))
1744                        author = get_author(msg.message);
1745        }
1746
1747        if (command == TODO_REWORD)
1748                flags |= EDIT_MSG | VERIFY_MSG;
1749        else if (is_fixup(command)) {
1750                if (update_squash_messages(command, commit, opts))
1751                        return -1;
1752                flags |= AMEND_MSG;
1753                if (!final_fixup)
1754                        msg_file = rebase_path_squash_msg();
1755                else if (file_exists(rebase_path_fixup_msg())) {
1756                        flags |= CLEANUP_MSG;
1757                        msg_file = rebase_path_fixup_msg();
1758                } else {
1759                        const char *dest = git_path_squash_msg();
1760                        unlink(dest);
1761                        if (copy_file(dest, rebase_path_squash_msg(), 0666))
1762                                return error(_("could not rename '%s' to '%s'"),
1763                                             rebase_path_squash_msg(), dest);
1764                        unlink(git_path_merge_msg());
1765                        msg_file = dest;
1766                        flags |= EDIT_MSG;
1767                }
1768        }
1769
1770        if (opts->signoff && !is_fixup(command))
1771                append_signoff(&msgbuf, 0, 0);
1772
1773        if (is_rebase_i(opts) && write_author_script(msg.message) < 0)
1774                res = -1;
1775        else if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
1776                res = do_recursive_merge(base, next, base_label, next_label,
1777                                         &head, &msgbuf, opts);
1778                if (res < 0)
1779                        return res;
1780                res |= write_message(msgbuf.buf, msgbuf.len,
1781                                     git_path_merge_msg(), 0);
1782        } else {
1783                struct commit_list *common = NULL;
1784                struct commit_list *remotes = NULL;
1785
1786                res = write_message(msgbuf.buf, msgbuf.len,
1787                                    git_path_merge_msg(), 0);
1788
1789                commit_list_insert(base, &common);
1790                commit_list_insert(next, &remotes);
1791                res |= try_merge_command(opts->strategy,
1792                                         opts->xopts_nr, (const char **)opts->xopts,
1793                                        common, oid_to_hex(&head), remotes);
1794                free_commit_list(common);
1795                free_commit_list(remotes);
1796        }
1797        strbuf_release(&msgbuf);
1798
1799        /*
1800         * If the merge was clean or if it failed due to conflict, we write
1801         * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
1802         * However, if the merge did not even start, then we don't want to
1803         * write it at all.
1804         */
1805        if (command == TODO_PICK && !opts->no_commit && (res == 0 || res == 1) &&
1806            update_ref(NULL, "CHERRY_PICK_HEAD", &commit->object.oid, NULL,
1807                       REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
1808                res = -1;
1809        if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
1810            update_ref(NULL, "REVERT_HEAD", &commit->object.oid, NULL,
1811                       REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
1812                res = -1;
1813
1814        if (res) {
1815                error(command == TODO_REVERT
1816                      ? _("could not revert %s... %s")
1817                      : _("could not apply %s... %s"),
1818                      short_commit_name(commit), msg.subject);
1819                print_advice(res == 1, opts);
1820                rerere(opts->allow_rerere_auto);
1821                goto leave;
1822        }
1823
1824        allow = allow_empty(opts, commit);
1825        if (allow < 0) {
1826                res = allow;
1827                goto leave;
1828        } else if (allow)
1829                flags |= ALLOW_EMPTY;
1830        if (!opts->no_commit) {
1831fast_forward_edit:
1832                if (author || command == TODO_REVERT || (flags & AMEND_MSG))
1833                        res = do_commit(msg_file, author, opts, flags);
1834                else
1835                        res = error(_("unable to parse commit author"));
1836        }
1837
1838        if (!res && final_fixup) {
1839                unlink(rebase_path_fixup_msg());
1840                unlink(rebase_path_squash_msg());
1841                unlink(rebase_path_current_fixups());
1842                strbuf_reset(&opts->current_fixups);
1843                opts->current_fixup_count = 0;
1844        }
1845
1846leave:
1847        free_message(commit, &msg);
1848        free(author);
1849        update_abort_safety_file();
1850
1851        return res;
1852}
1853
1854static int prepare_revs(struct replay_opts *opts)
1855{
1856        /*
1857         * picking (but not reverting) ranges (but not individual revisions)
1858         * should be done in reverse
1859         */
1860        if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
1861                opts->revs->reverse ^= 1;
1862
1863        if (prepare_revision_walk(opts->revs))
1864                return error(_("revision walk setup failed"));
1865
1866        if (!opts->revs->commits)
1867                return error(_("empty commit set passed"));
1868        return 0;
1869}
1870
1871static int read_and_refresh_cache(struct replay_opts *opts)
1872{
1873        struct lock_file index_lock = LOCK_INIT;
1874        int index_fd = hold_locked_index(&index_lock, 0);
1875        if (read_index_preload(&the_index, NULL) < 0) {
1876                rollback_lock_file(&index_lock);
1877                return error(_("git %s: failed to read the index"),
1878                        _(action_name(opts)));
1879        }
1880        refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
1881        if (index_fd >= 0) {
1882                if (write_locked_index(&the_index, &index_lock,
1883                                       COMMIT_LOCK | SKIP_IF_UNCHANGED)) {
1884                        return error(_("git %s: failed to refresh the index"),
1885                                _(action_name(opts)));
1886                }
1887        }
1888        return 0;
1889}
1890
1891enum todo_item_flags {
1892        TODO_EDIT_MERGE_MSG = 1
1893};
1894
1895struct todo_item {
1896        enum todo_command command;
1897        struct commit *commit;
1898        unsigned int flags;
1899        const char *arg;
1900        int arg_len;
1901        size_t offset_in_buf;
1902};
1903
1904struct todo_list {
1905        struct strbuf buf;
1906        struct todo_item *items;
1907        int nr, alloc, current;
1908        int done_nr, total_nr;
1909        struct stat_data stat;
1910};
1911
1912#define TODO_LIST_INIT { STRBUF_INIT }
1913
1914static void todo_list_release(struct todo_list *todo_list)
1915{
1916        strbuf_release(&todo_list->buf);
1917        FREE_AND_NULL(todo_list->items);
1918        todo_list->nr = todo_list->alloc = 0;
1919}
1920
1921static struct todo_item *append_new_todo(struct todo_list *todo_list)
1922{
1923        ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
1924        return todo_list->items + todo_list->nr++;
1925}
1926
1927static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
1928{
1929        struct object_id commit_oid;
1930        char *end_of_object_name;
1931        int i, saved, status, padding;
1932
1933        item->flags = 0;
1934
1935        /* left-trim */
1936        bol += strspn(bol, " \t");
1937
1938        if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
1939                item->command = TODO_COMMENT;
1940                item->commit = NULL;
1941                item->arg = bol;
1942                item->arg_len = eol - bol;
1943                return 0;
1944        }
1945
1946        for (i = 0; i < TODO_COMMENT; i++)
1947                if (skip_prefix(bol, todo_command_info[i].str, &bol)) {
1948                        item->command = i;
1949                        break;
1950                } else if (bol[1] == ' ' && *bol == todo_command_info[i].c) {
1951                        bol++;
1952                        item->command = i;
1953                        break;
1954                }
1955        if (i >= TODO_COMMENT)
1956                return -1;
1957
1958        /* Eat up extra spaces/ tabs before object name */
1959        padding = strspn(bol, " \t");
1960        bol += padding;
1961
1962        if (item->command == TODO_NOOP) {
1963                if (bol != eol)
1964                        return error(_("%s does not accept arguments: '%s'"),
1965                                     command_to_string(item->command), bol);
1966                item->commit = NULL;
1967                item->arg = bol;
1968                item->arg_len = eol - bol;
1969                return 0;
1970        }
1971
1972        if (!padding)
1973                return error(_("missing arguments for %s"),
1974                             command_to_string(item->command));
1975
1976        if (item->command == TODO_EXEC || item->command == TODO_LABEL ||
1977            item->command == TODO_RESET) {
1978                item->commit = NULL;
1979                item->arg = bol;
1980                item->arg_len = (int)(eol - bol);
1981                return 0;
1982        }
1983
1984        if (item->command == TODO_MERGE) {
1985                if (skip_prefix(bol, "-C", &bol))
1986                        bol += strspn(bol, " \t");
1987                else if (skip_prefix(bol, "-c", &bol)) {
1988                        bol += strspn(bol, " \t");
1989                        item->flags |= TODO_EDIT_MERGE_MSG;
1990                } else {
1991                        item->flags |= TODO_EDIT_MERGE_MSG;
1992                        item->commit = NULL;
1993                        item->arg = bol;
1994                        item->arg_len = (int)(eol - bol);
1995                        return 0;
1996                }
1997        }
1998
1999        end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
2000        saved = *end_of_object_name;
2001        *end_of_object_name = '\0';
2002        status = get_oid(bol, &commit_oid);
2003        *end_of_object_name = saved;
2004
2005        item->arg = end_of_object_name + strspn(end_of_object_name, " \t");
2006        item->arg_len = (int)(eol - item->arg);
2007
2008        if (status < 0)
2009                return -1;
2010
2011        item->commit = lookup_commit_reference(&commit_oid);
2012        return !item->commit;
2013}
2014
2015static int parse_insn_buffer(char *buf, struct todo_list *todo_list)
2016{
2017        struct todo_item *item;
2018        char *p = buf, *next_p;
2019        int i, res = 0, fixup_okay = file_exists(rebase_path_done());
2020
2021        for (i = 1; *p; i++, p = next_p) {
2022                char *eol = strchrnul(p, '\n');
2023
2024                next_p = *eol ? eol + 1 /* skip LF */ : eol;
2025
2026                if (p != eol && eol[-1] == '\r')
2027                        eol--; /* strip Carriage Return */
2028
2029                item = append_new_todo(todo_list);
2030                item->offset_in_buf = p - todo_list->buf.buf;
2031                if (parse_insn_line(item, p, eol)) {
2032                        res = error(_("invalid line %d: %.*s"),
2033                                i, (int)(eol - p), p);
2034                        item->command = TODO_NOOP;
2035                }
2036
2037                if (fixup_okay)
2038                        ; /* do nothing */
2039                else if (is_fixup(item->command))
2040                        return error(_("cannot '%s' without a previous commit"),
2041                                command_to_string(item->command));
2042                else if (!is_noop(item->command))
2043                        fixup_okay = 1;
2044        }
2045
2046        return res;
2047}
2048
2049static int count_commands(struct todo_list *todo_list)
2050{
2051        int count = 0, i;
2052
2053        for (i = 0; i < todo_list->nr; i++)
2054                if (todo_list->items[i].command != TODO_COMMENT)
2055                        count++;
2056
2057        return count;
2058}
2059
2060static int get_item_line_offset(struct todo_list *todo_list, int index)
2061{
2062        return index < todo_list->nr ?
2063                todo_list->items[index].offset_in_buf : todo_list->buf.len;
2064}
2065
2066static const char *get_item_line(struct todo_list *todo_list, int index)
2067{
2068        return todo_list->buf.buf + get_item_line_offset(todo_list, index);
2069}
2070
2071static int get_item_line_length(struct todo_list *todo_list, int index)
2072{
2073        return get_item_line_offset(todo_list, index + 1)
2074                -  get_item_line_offset(todo_list, index);
2075}
2076
2077static ssize_t strbuf_read_file_or_whine(struct strbuf *sb, const char *path)
2078{
2079        int fd;
2080        ssize_t len;
2081
2082        fd = open(path, O_RDONLY);
2083        if (fd < 0)
2084                return error_errno(_("could not open '%s'"), path);
2085        len = strbuf_read(sb, fd, 0);
2086        close(fd);
2087        if (len < 0)
2088                return error(_("could not read '%s'."), path);
2089        return len;
2090}
2091
2092static int read_populate_todo(struct todo_list *todo_list,
2093                        struct replay_opts *opts)
2094{
2095        struct stat st;
2096        const char *todo_file = get_todo_path(opts);
2097        int res;
2098
2099        strbuf_reset(&todo_list->buf);
2100        if (strbuf_read_file_or_whine(&todo_list->buf, todo_file) < 0)
2101                return -1;
2102
2103        res = stat(todo_file, &st);
2104        if (res)
2105                return error(_("could not stat '%s'"), todo_file);
2106        fill_stat_data(&todo_list->stat, &st);
2107
2108        res = parse_insn_buffer(todo_list->buf.buf, todo_list);
2109        if (res) {
2110                if (is_rebase_i(opts))
2111                        return error(_("please fix this using "
2112                                       "'git rebase --edit-todo'."));
2113                return error(_("unusable instruction sheet: '%s'"), todo_file);
2114        }
2115
2116        if (!todo_list->nr &&
2117            (!is_rebase_i(opts) || !file_exists(rebase_path_done())))
2118                return error(_("no commits parsed."));
2119
2120        if (!is_rebase_i(opts)) {
2121                enum todo_command valid =
2122                        opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
2123                int i;
2124
2125                for (i = 0; i < todo_list->nr; i++)
2126                        if (valid == todo_list->items[i].command)
2127                                continue;
2128                        else if (valid == TODO_PICK)
2129                                return error(_("cannot cherry-pick during a revert."));
2130                        else
2131                                return error(_("cannot revert during a cherry-pick."));
2132        }
2133
2134        if (is_rebase_i(opts)) {
2135                struct todo_list done = TODO_LIST_INIT;
2136                FILE *f = fopen_or_warn(rebase_path_msgtotal(), "w");
2137
2138                if (strbuf_read_file(&done.buf, rebase_path_done(), 0) > 0 &&
2139                                !parse_insn_buffer(done.buf.buf, &done))
2140                        todo_list->done_nr = count_commands(&done);
2141                else
2142                        todo_list->done_nr = 0;
2143
2144                todo_list->total_nr = todo_list->done_nr
2145                        + count_commands(todo_list);
2146                todo_list_release(&done);
2147
2148                if (f) {
2149                        fprintf(f, "%d\n", todo_list->total_nr);
2150                        fclose(f);
2151                }
2152        }
2153
2154        return 0;
2155}
2156
2157static int git_config_string_dup(char **dest,
2158                                 const char *var, const char *value)
2159{
2160        if (!value)
2161                return config_error_nonbool(var);
2162        free(*dest);
2163        *dest = xstrdup(value);
2164        return 0;
2165}
2166
2167static int populate_opts_cb(const char *key, const char *value, void *data)
2168{
2169        struct replay_opts *opts = data;
2170        int error_flag = 1;
2171
2172        if (!value)
2173                error_flag = 0;
2174        else if (!strcmp(key, "options.no-commit"))
2175                opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
2176        else if (!strcmp(key, "options.edit"))
2177                opts->edit = git_config_bool_or_int(key, value, &error_flag);
2178        else if (!strcmp(key, "options.signoff"))
2179                opts->signoff = git_config_bool_or_int(key, value, &error_flag);
2180        else if (!strcmp(key, "options.record-origin"))
2181                opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
2182        else if (!strcmp(key, "options.allow-ff"))
2183                opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
2184        else if (!strcmp(key, "options.mainline"))
2185                opts->mainline = git_config_int(key, value);
2186        else if (!strcmp(key, "options.strategy"))
2187                git_config_string_dup(&opts->strategy, key, value);
2188        else if (!strcmp(key, "options.gpg-sign"))
2189                git_config_string_dup(&opts->gpg_sign, key, value);
2190        else if (!strcmp(key, "options.strategy-option")) {
2191                ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
2192                opts->xopts[opts->xopts_nr++] = xstrdup(value);
2193        } else if (!strcmp(key, "options.allow-rerere-auto"))
2194                opts->allow_rerere_auto =
2195                        git_config_bool_or_int(key, value, &error_flag) ?
2196                                RERERE_AUTOUPDATE : RERERE_NOAUTOUPDATE;
2197        else
2198                return error(_("invalid key: %s"), key);
2199
2200        if (!error_flag)
2201                return error(_("invalid value for %s: %s"), key, value);
2202
2203        return 0;
2204}
2205
2206static void read_strategy_opts(struct replay_opts *opts, struct strbuf *buf)
2207{
2208        int i;
2209
2210        strbuf_reset(buf);
2211        if (!read_oneliner(buf, rebase_path_strategy(), 0))
2212                return;
2213        opts->strategy = strbuf_detach(buf, NULL);
2214        if (!read_oneliner(buf, rebase_path_strategy_opts(), 0))
2215                return;
2216
2217        opts->xopts_nr = split_cmdline(buf->buf, (const char ***)&opts->xopts);
2218        for (i = 0; i < opts->xopts_nr; i++) {
2219                const char *arg = opts->xopts[i];
2220
2221                skip_prefix(arg, "--", &arg);
2222                opts->xopts[i] = xstrdup(arg);
2223        }
2224}
2225
2226static int read_populate_opts(struct replay_opts *opts)
2227{
2228        if (is_rebase_i(opts)) {
2229                struct strbuf buf = STRBUF_INIT;
2230
2231                if (read_oneliner(&buf, rebase_path_gpg_sign_opt(), 1)) {
2232                        if (!starts_with(buf.buf, "-S"))
2233                                strbuf_reset(&buf);
2234                        else {
2235                                free(opts->gpg_sign);
2236                                opts->gpg_sign = xstrdup(buf.buf + 2);
2237                        }
2238                        strbuf_reset(&buf);
2239                }
2240
2241                if (read_oneliner(&buf, rebase_path_allow_rerere_autoupdate(), 1)) {
2242                        if (!strcmp(buf.buf, "--rerere-autoupdate"))
2243                                opts->allow_rerere_auto = RERERE_AUTOUPDATE;
2244                        else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
2245                                opts->allow_rerere_auto = RERERE_NOAUTOUPDATE;
2246                        strbuf_reset(&buf);
2247                }
2248
2249                if (file_exists(rebase_path_verbose()))
2250                        opts->verbose = 1;
2251
2252                if (file_exists(rebase_path_signoff())) {
2253                        opts->allow_ff = 0;
2254                        opts->signoff = 1;
2255                }
2256
2257                read_strategy_opts(opts, &buf);
2258                strbuf_release(&buf);
2259
2260                if (read_oneliner(&opts->current_fixups,
2261                                  rebase_path_current_fixups(), 1)) {
2262                        const char *p = opts->current_fixups.buf;
2263                        opts->current_fixup_count = 1;
2264                        while ((p = strchr(p, '\n'))) {
2265                                opts->current_fixup_count++;
2266                                p++;
2267                        }
2268                }
2269
2270                if (read_oneliner(&buf, rebase_path_squash_onto(), 0)) {
2271                        if (get_oid_hex(buf.buf, &opts->squash_onto) < 0)
2272                                return error(_("unusable squash-onto"));
2273                        opts->have_squash_onto = 1;
2274                }
2275
2276                return 0;
2277        }
2278
2279        if (!file_exists(git_path_opts_file()))
2280                return 0;
2281        /*
2282         * The function git_parse_source(), called from git_config_from_file(),
2283         * may die() in case of a syntactically incorrect file. We do not care
2284         * about this case, though, because we wrote that file ourselves, so we
2285         * are pretty certain that it is syntactically correct.
2286         */
2287        if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
2288                return error(_("malformed options sheet: '%s'"),
2289                        git_path_opts_file());
2290        return 0;
2291}
2292
2293static int walk_revs_populate_todo(struct todo_list *todo_list,
2294                                struct replay_opts *opts)
2295{
2296        enum todo_command command = opts->action == REPLAY_PICK ?
2297                TODO_PICK : TODO_REVERT;
2298        const char *command_string = todo_command_info[command].str;
2299        struct commit *commit;
2300
2301        if (prepare_revs(opts))
2302                return -1;
2303
2304        while ((commit = get_revision(opts->revs))) {
2305                struct todo_item *item = append_new_todo(todo_list);
2306                const char *commit_buffer = get_commit_buffer(commit, NULL);
2307                const char *subject;
2308                int subject_len;
2309
2310                item->command = command;
2311                item->commit = commit;
2312                item->arg = NULL;
2313                item->arg_len = 0;
2314                item->offset_in_buf = todo_list->buf.len;
2315                subject_len = find_commit_subject(commit_buffer, &subject);
2316                strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
2317                        short_commit_name(commit), subject_len, subject);
2318                unuse_commit_buffer(commit, commit_buffer);
2319        }
2320        return 0;
2321}
2322
2323static int create_seq_dir(void)
2324{
2325        if (file_exists(git_path_seq_dir())) {
2326                error(_("a cherry-pick or revert is already in progress"));
2327                advise(_("try \"git cherry-pick (--continue | --quit | --abort)\""));
2328                return -1;
2329        } else if (mkdir(git_path_seq_dir(), 0777) < 0)
2330                return error_errno(_("could not create sequencer directory '%s'"),
2331                                   git_path_seq_dir());
2332        return 0;
2333}
2334
2335static int save_head(const char *head)
2336{
2337        struct lock_file head_lock = LOCK_INIT;
2338        struct strbuf buf = STRBUF_INIT;
2339        int fd;
2340        ssize_t written;
2341
2342        fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
2343        if (fd < 0)
2344                return error_errno(_("could not lock HEAD"));
2345        strbuf_addf(&buf, "%s\n", head);
2346        written = write_in_full(fd, buf.buf, buf.len);
2347        strbuf_release(&buf);
2348        if (written < 0) {
2349                error_errno(_("could not write to '%s'"), git_path_head_file());
2350                rollback_lock_file(&head_lock);
2351                return -1;
2352        }
2353        if (commit_lock_file(&head_lock) < 0)
2354                return error(_("failed to finalize '%s'"), git_path_head_file());
2355        return 0;
2356}
2357
2358static int rollback_is_safe(void)
2359{
2360        struct strbuf sb = STRBUF_INIT;
2361        struct object_id expected_head, actual_head;
2362
2363        if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
2364                strbuf_trim(&sb);
2365                if (get_oid_hex(sb.buf, &expected_head)) {
2366                        strbuf_release(&sb);
2367                        die(_("could not parse %s"), git_path_abort_safety_file());
2368                }
2369                strbuf_release(&sb);
2370        }
2371        else if (errno == ENOENT)
2372                oidclr(&expected_head);
2373        else
2374                die_errno(_("could not read '%s'"), git_path_abort_safety_file());
2375
2376        if (get_oid("HEAD", &actual_head))
2377                oidclr(&actual_head);
2378
2379        return !oidcmp(&actual_head, &expected_head);
2380}
2381
2382static int reset_for_rollback(const struct object_id *oid)
2383{
2384        const char *argv[4];    /* reset --merge <arg> + NULL */
2385
2386        argv[0] = "reset";
2387        argv[1] = "--merge";
2388        argv[2] = oid_to_hex(oid);
2389        argv[3] = NULL;
2390        return run_command_v_opt(argv, RUN_GIT_CMD);
2391}
2392
2393static int rollback_single_pick(void)
2394{
2395        struct object_id head_oid;
2396
2397        if (!file_exists(git_path_cherry_pick_head()) &&
2398            !file_exists(git_path_revert_head()))
2399                return error(_("no cherry-pick or revert in progress"));
2400        if (read_ref_full("HEAD", 0, &head_oid, NULL))
2401                return error(_("cannot resolve HEAD"));
2402        if (is_null_oid(&head_oid))
2403                return error(_("cannot abort from a branch yet to be born"));
2404        return reset_for_rollback(&head_oid);
2405}
2406
2407int sequencer_rollback(struct replay_opts *opts)
2408{
2409        FILE *f;
2410        struct object_id oid;
2411        struct strbuf buf = STRBUF_INIT;
2412        const char *p;
2413
2414        f = fopen(git_path_head_file(), "r");
2415        if (!f && errno == ENOENT) {
2416                /*
2417                 * There is no multiple-cherry-pick in progress.
2418                 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
2419                 * a single-cherry-pick in progress, abort that.
2420                 */
2421                return rollback_single_pick();
2422        }
2423        if (!f)
2424                return error_errno(_("cannot open '%s'"), git_path_head_file());
2425        if (strbuf_getline_lf(&buf, f)) {
2426                error(_("cannot read '%s': %s"), git_path_head_file(),
2427                      ferror(f) ?  strerror(errno) : _("unexpected end of file"));
2428                fclose(f);
2429                goto fail;
2430        }
2431        fclose(f);
2432        if (parse_oid_hex(buf.buf, &oid, &p) || *p != '\0') {
2433                error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
2434                        git_path_head_file());
2435                goto fail;
2436        }
2437        if (is_null_oid(&oid)) {
2438                error(_("cannot abort from a branch yet to be born"));
2439                goto fail;
2440        }
2441
2442        if (!rollback_is_safe()) {
2443                /* Do not error, just do not rollback */
2444                warning(_("You seem to have moved HEAD. "
2445                          "Not rewinding, check your HEAD!"));
2446        } else
2447        if (reset_for_rollback(&oid))
2448                goto fail;
2449        strbuf_release(&buf);
2450        return sequencer_remove_state(opts);
2451fail:
2452        strbuf_release(&buf);
2453        return -1;
2454}
2455
2456static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
2457{
2458        struct lock_file todo_lock = LOCK_INIT;
2459        const char *todo_path = get_todo_path(opts);
2460        int next = todo_list->current, offset, fd;
2461
2462        /*
2463         * rebase -i writes "git-rebase-todo" without the currently executing
2464         * command, appending it to "done" instead.
2465         */
2466        if (is_rebase_i(opts))
2467                next++;
2468
2469        fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
2470        if (fd < 0)
2471                return error_errno(_("could not lock '%s'"), todo_path);
2472        offset = get_item_line_offset(todo_list, next);
2473        if (write_in_full(fd, todo_list->buf.buf + offset,
2474                        todo_list->buf.len - offset) < 0)
2475                return error_errno(_("could not write to '%s'"), todo_path);
2476        if (commit_lock_file(&todo_lock) < 0)
2477                return error(_("failed to finalize '%s'"), todo_path);
2478
2479        if (is_rebase_i(opts) && next > 0) {
2480                const char *done = rebase_path_done();
2481                int fd = open(done, O_CREAT | O_WRONLY | O_APPEND, 0666);
2482                int ret = 0;
2483
2484                if (fd < 0)
2485                        return 0;
2486                if (write_in_full(fd, get_item_line(todo_list, next - 1),
2487                                  get_item_line_length(todo_list, next - 1))
2488                    < 0)
2489                        ret = error_errno(_("could not write to '%s'"), done);
2490                if (close(fd) < 0)
2491                        ret = error_errno(_("failed to finalize '%s'"), done);
2492                return ret;
2493        }
2494        return 0;
2495}
2496
2497static int save_opts(struct replay_opts *opts)
2498{
2499        const char *opts_file = git_path_opts_file();
2500        int res = 0;
2501
2502        if (opts->no_commit)
2503                res |= git_config_set_in_file_gently(opts_file, "options.no-commit", "true");
2504        if (opts->edit)
2505                res |= git_config_set_in_file_gently(opts_file, "options.edit", "true");
2506        if (opts->signoff)
2507                res |= git_config_set_in_file_gently(opts_file, "options.signoff", "true");
2508        if (opts->record_origin)
2509                res |= git_config_set_in_file_gently(opts_file, "options.record-origin", "true");
2510        if (opts->allow_ff)
2511                res |= git_config_set_in_file_gently(opts_file, "options.allow-ff", "true");
2512        if (opts->mainline) {
2513                struct strbuf buf = STRBUF_INIT;
2514                strbuf_addf(&buf, "%d", opts->mainline);
2515                res |= git_config_set_in_file_gently(opts_file, "options.mainline", buf.buf);
2516                strbuf_release(&buf);
2517        }
2518        if (opts->strategy)
2519                res |= git_config_set_in_file_gently(opts_file, "options.strategy", opts->strategy);
2520        if (opts->gpg_sign)
2521                res |= git_config_set_in_file_gently(opts_file, "options.gpg-sign", opts->gpg_sign);
2522        if (opts->xopts) {
2523                int i;
2524                for (i = 0; i < opts->xopts_nr; i++)
2525                        res |= git_config_set_multivar_in_file_gently(opts_file,
2526                                                        "options.strategy-option",
2527                                                        opts->xopts[i], "^$", 0);
2528        }
2529        if (opts->allow_rerere_auto)
2530                res |= git_config_set_in_file_gently(opts_file, "options.allow-rerere-auto",
2531                                                     opts->allow_rerere_auto == RERERE_AUTOUPDATE ?
2532                                                     "true" : "false");
2533        return res;
2534}
2535
2536static int make_patch(struct commit *commit, struct replay_opts *opts)
2537{
2538        struct strbuf buf = STRBUF_INIT;
2539        struct rev_info log_tree_opt;
2540        const char *subject, *p;
2541        int res = 0;
2542
2543        p = short_commit_name(commit);
2544        if (write_message(p, strlen(p), rebase_path_stopped_sha(), 1) < 0)
2545                return -1;
2546        if (update_ref("rebase", "REBASE_HEAD", &commit->object.oid,
2547                       NULL, REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
2548                res |= error(_("could not update %s"), "REBASE_HEAD");
2549
2550        strbuf_addf(&buf, "%s/patch", get_dir(opts));
2551        memset(&log_tree_opt, 0, sizeof(log_tree_opt));
2552        init_revisions(&log_tree_opt, NULL);
2553        log_tree_opt.abbrev = 0;
2554        log_tree_opt.diff = 1;
2555        log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
2556        log_tree_opt.disable_stdin = 1;
2557        log_tree_opt.no_commit_id = 1;
2558        log_tree_opt.diffopt.file = fopen(buf.buf, "w");
2559        log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
2560        if (!log_tree_opt.diffopt.file)
2561                res |= error_errno(_("could not open '%s'"), buf.buf);
2562        else {
2563                res |= log_tree_commit(&log_tree_opt, commit);
2564                fclose(log_tree_opt.diffopt.file);
2565        }
2566        strbuf_reset(&buf);
2567
2568        strbuf_addf(&buf, "%s/message", get_dir(opts));
2569        if (!file_exists(buf.buf)) {
2570                const char *commit_buffer = get_commit_buffer(commit, NULL);
2571                find_commit_subject(commit_buffer, &subject);
2572                res |= write_message(subject, strlen(subject), buf.buf, 1);
2573                unuse_commit_buffer(commit, commit_buffer);
2574        }
2575        strbuf_release(&buf);
2576
2577        return res;
2578}
2579
2580static int intend_to_amend(void)
2581{
2582        struct object_id head;
2583        char *p;
2584
2585        if (get_oid("HEAD", &head))
2586                return error(_("cannot read HEAD"));
2587
2588        p = oid_to_hex(&head);
2589        return write_message(p, strlen(p), rebase_path_amend(), 1);
2590}
2591
2592static int error_with_patch(struct commit *commit,
2593        const char *subject, int subject_len,
2594        struct replay_opts *opts, int exit_code, int to_amend)
2595{
2596        if (make_patch(commit, opts))
2597                return -1;
2598
2599        if (to_amend) {
2600                if (intend_to_amend())
2601                        return -1;
2602
2603                fprintf(stderr, "You can amend the commit now, with\n"
2604                        "\n"
2605                        "  git commit --amend %s\n"
2606                        "\n"
2607                        "Once you are satisfied with your changes, run\n"
2608                        "\n"
2609                        "  git rebase --continue\n", gpg_sign_opt_quoted(opts));
2610        } else if (exit_code)
2611                fprintf(stderr, "Could not apply %s... %.*s\n",
2612                        short_commit_name(commit), subject_len, subject);
2613
2614        return exit_code;
2615}
2616
2617static int error_failed_squash(struct commit *commit,
2618        struct replay_opts *opts, int subject_len, const char *subject)
2619{
2620        if (copy_file(rebase_path_message(), rebase_path_squash_msg(), 0666))
2621                return error(_("could not copy '%s' to '%s'"),
2622                        rebase_path_squash_msg(), rebase_path_message());
2623        unlink(git_path_merge_msg());
2624        if (copy_file(git_path_merge_msg(), rebase_path_message(), 0666))
2625                return error(_("could not copy '%s' to '%s'"),
2626                             rebase_path_message(), git_path_merge_msg());
2627        return error_with_patch(commit, subject, subject_len, opts, 1, 0);
2628}
2629
2630static int do_exec(const char *command_line)
2631{
2632        struct argv_array child_env = ARGV_ARRAY_INIT;
2633        const char *child_argv[] = { NULL, NULL };
2634        int dirty, status;
2635
2636        fprintf(stderr, "Executing: %s\n", command_line);
2637        child_argv[0] = command_line;
2638        argv_array_pushf(&child_env, "GIT_DIR=%s", absolute_path(get_git_dir()));
2639        status = run_command_v_opt_cd_env(child_argv, RUN_USING_SHELL, NULL,
2640                                          child_env.argv);
2641
2642        /* force re-reading of the cache */
2643        if (discard_cache() < 0 || read_cache() < 0)
2644                return error(_("could not read index"));
2645
2646        dirty = require_clean_work_tree("rebase", NULL, 1, 1);
2647
2648        if (status) {
2649                warning(_("execution failed: %s\n%s"
2650                          "You can fix the problem, and then run\n"
2651                          "\n"
2652                          "  git rebase --continue\n"
2653                          "\n"),
2654                        command_line,
2655                        dirty ? N_("and made changes to the index and/or the "
2656                                "working tree\n") : "");
2657                if (status == 127)
2658                        /* command not found */
2659                        status = 1;
2660        } else if (dirty) {
2661                warning(_("execution succeeded: %s\nbut "
2662                          "left changes to the index and/or the working tree\n"
2663                          "Commit or stash your changes, and then run\n"
2664                          "\n"
2665                          "  git rebase --continue\n"
2666                          "\n"), command_line);
2667                status = 1;
2668        }
2669
2670        argv_array_clear(&child_env);
2671
2672        return status;
2673}
2674
2675static int safe_append(const char *filename, const char *fmt, ...)
2676{
2677        va_list ap;
2678        struct lock_file lock = LOCK_INIT;
2679        int fd = hold_lock_file_for_update(&lock, filename,
2680                                           LOCK_REPORT_ON_ERROR);
2681        struct strbuf buf = STRBUF_INIT;
2682
2683        if (fd < 0)
2684                return -1;
2685
2686        if (strbuf_read_file(&buf, filename, 0) < 0 && errno != ENOENT) {
2687                error_errno(_("could not read '%s'"), filename);
2688                rollback_lock_file(&lock);
2689                return -1;
2690        }
2691        strbuf_complete(&buf, '\n');
2692        va_start(ap, fmt);
2693        strbuf_vaddf(&buf, fmt, ap);
2694        va_end(ap);
2695
2696        if (write_in_full(fd, buf.buf, buf.len) < 0) {
2697                error_errno(_("could not write to '%s'"), filename);
2698                strbuf_release(&buf);
2699                rollback_lock_file(&lock);
2700                return -1;
2701        }
2702        if (commit_lock_file(&lock) < 0) {
2703                strbuf_release(&buf);
2704                rollback_lock_file(&lock);
2705                return error(_("failed to finalize '%s'"), filename);
2706        }
2707
2708        strbuf_release(&buf);
2709        return 0;
2710}
2711
2712static int do_label(const char *name, int len)
2713{
2714        struct ref_store *refs = get_main_ref_store(the_repository);
2715        struct ref_transaction *transaction;
2716        struct strbuf ref_name = STRBUF_INIT, err = STRBUF_INIT;
2717        struct strbuf msg = STRBUF_INIT;
2718        int ret = 0;
2719        struct object_id head_oid;
2720
2721        if (len == 1 && *name == '#')
2722                return error("Illegal label name: '%.*s'", len, name);
2723
2724        strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
2725        strbuf_addf(&msg, "rebase -i (label) '%.*s'", len, name);
2726
2727        transaction = ref_store_transaction_begin(refs, &err);
2728        if (!transaction) {
2729                error("%s", err.buf);
2730                ret = -1;
2731        } else if (get_oid("HEAD", &head_oid)) {
2732                error(_("could not read HEAD"));
2733                ret = -1;
2734        } else if (ref_transaction_update(transaction, ref_name.buf, &head_oid,
2735                                          NULL, 0, msg.buf, &err) < 0 ||
2736                   ref_transaction_commit(transaction, &err)) {
2737                error("%s", err.buf);
2738                ret = -1;
2739        }
2740        ref_transaction_free(transaction);
2741        strbuf_release(&err);
2742        strbuf_release(&msg);
2743
2744        if (!ret)
2745                ret = safe_append(rebase_path_refs_to_delete(),
2746                                  "%s\n", ref_name.buf);
2747        strbuf_release(&ref_name);
2748
2749        return ret;
2750}
2751
2752static const char *reflog_message(struct replay_opts *opts,
2753        const char *sub_action, const char *fmt, ...);
2754
2755static int do_reset(const char *name, int len, struct replay_opts *opts)
2756{
2757        struct strbuf ref_name = STRBUF_INIT;
2758        struct object_id oid;
2759        struct lock_file lock = LOCK_INIT;
2760        struct tree_desc desc;
2761        struct tree *tree;
2762        struct unpack_trees_options unpack_tree_opts;
2763        int ret = 0, i;
2764
2765        if (hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0)
2766                return -1;
2767
2768        if (len == 10 && !strncmp("[new root]", name, len)) {
2769                if (!opts->have_squash_onto) {
2770                        const char *hex;
2771                        if (commit_tree("", 0, the_hash_algo->empty_tree,
2772                                        NULL, &opts->squash_onto,
2773                                        NULL, NULL))
2774                                return error(_("writing fake root commit"));
2775                        opts->have_squash_onto = 1;
2776                        hex = oid_to_hex(&opts->squash_onto);
2777                        if (write_message(hex, strlen(hex),
2778                                          rebase_path_squash_onto(), 0))
2779                                return error(_("writing squash-onto"));
2780                }
2781                oidcpy(&oid, &opts->squash_onto);
2782        } else {
2783                /* Determine the length of the label */
2784                for (i = 0; i < len; i++)
2785                        if (isspace(name[i]))
2786                                len = i;
2787
2788                strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
2789                if (get_oid(ref_name.buf, &oid) &&
2790                    get_oid(ref_name.buf + strlen("refs/rewritten/"), &oid)) {
2791                        error(_("could not read '%s'"), ref_name.buf);
2792                        rollback_lock_file(&lock);
2793                        strbuf_release(&ref_name);
2794                        return -1;
2795                }
2796        }
2797
2798        memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
2799        setup_unpack_trees_porcelain(&unpack_tree_opts, "reset");
2800        unpack_tree_opts.head_idx = 1;
2801        unpack_tree_opts.src_index = &the_index;
2802        unpack_tree_opts.dst_index = &the_index;
2803        unpack_tree_opts.fn = oneway_merge;
2804        unpack_tree_opts.merge = 1;
2805        unpack_tree_opts.update = 1;
2806
2807        if (read_cache_unmerged()) {
2808                rollback_lock_file(&lock);
2809                strbuf_release(&ref_name);
2810                return error_resolve_conflict(_(action_name(opts)));
2811        }
2812
2813        if (!fill_tree_descriptor(&desc, &oid)) {
2814                error(_("failed to find tree of %s"), oid_to_hex(&oid));
2815                rollback_lock_file(&lock);
2816                free((void *)desc.buffer);
2817                strbuf_release(&ref_name);
2818                return -1;
2819        }
2820
2821        if (unpack_trees(1, &desc, &unpack_tree_opts)) {
2822                rollback_lock_file(&lock);
2823                free((void *)desc.buffer);
2824                strbuf_release(&ref_name);
2825                return -1;
2826        }
2827
2828        tree = parse_tree_indirect(&oid);
2829        prime_cache_tree(&the_index, tree);
2830
2831        if (write_locked_index(&the_index, &lock, COMMIT_LOCK) < 0)
2832                ret = error(_("could not write index"));
2833        free((void *)desc.buffer);
2834
2835        if (!ret)
2836                ret = update_ref(reflog_message(opts, "reset", "'%.*s'",
2837                                                len, name), "HEAD", &oid,
2838                                 NULL, 0, UPDATE_REFS_MSG_ON_ERR);
2839
2840        strbuf_release(&ref_name);
2841        return ret;
2842}
2843
2844static int do_merge(struct commit *commit, const char *arg, int arg_len,
2845                    int flags, struct replay_opts *opts)
2846{
2847        int run_commit_flags = (flags & TODO_EDIT_MERGE_MSG) ?
2848                EDIT_MSG | VERIFY_MSG : 0;
2849        struct strbuf ref_name = STRBUF_INIT;
2850        struct commit *head_commit, *merge_commit, *i;
2851        struct commit_list *bases, *j, *reversed = NULL;
2852        struct merge_options o;
2853        int merge_arg_len, oneline_offset, can_fast_forward, ret;
2854        static struct lock_file lock;
2855        const char *p;
2856
2857        if (hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0) {
2858                ret = -1;
2859                goto leave_merge;
2860        }
2861
2862        head_commit = lookup_commit_reference_by_name("HEAD");
2863        if (!head_commit) {
2864                ret = error(_("cannot merge without a current revision"));
2865                goto leave_merge;
2866        }
2867
2868        oneline_offset = arg_len;
2869        merge_arg_len = strcspn(arg, " \t\n");
2870        p = arg + merge_arg_len;
2871        p += strspn(p, " \t\n");
2872        if (*p == '#' && (!p[1] || isspace(p[1]))) {
2873                p += 1 + strspn(p + 1, " \t\n");
2874                oneline_offset = p - arg;
2875        } else if (p - arg < arg_len)
2876                BUG("octopus merges are not supported yet: '%s'", p);
2877
2878        strbuf_addf(&ref_name, "refs/rewritten/%.*s", merge_arg_len, arg);
2879        merge_commit = lookup_commit_reference_by_name(ref_name.buf);
2880        if (!merge_commit) {
2881                /* fall back to non-rewritten ref or commit */
2882                strbuf_splice(&ref_name, 0, strlen("refs/rewritten/"), "", 0);
2883                merge_commit = lookup_commit_reference_by_name(ref_name.buf);
2884        }
2885
2886        if (!merge_commit) {
2887                ret = error(_("could not resolve '%s'"), ref_name.buf);
2888                goto leave_merge;
2889        }
2890
2891        if (opts->have_squash_onto &&
2892            !oidcmp(&head_commit->object.oid, &opts->squash_onto)) {
2893                /*
2894                 * When the user tells us to "merge" something into a
2895                 * "[new root]", let's simply fast-forward to the merge head.
2896                 */
2897                rollback_lock_file(&lock);
2898                ret = fast_forward_to(&merge_commit->object.oid,
2899                                       &head_commit->object.oid, 0, opts);
2900                goto leave_merge;
2901        }
2902
2903        if (commit) {
2904                const char *message = get_commit_buffer(commit, NULL);
2905                const char *body;
2906                int len;
2907
2908                if (!message) {
2909                        ret = error(_("could not get commit message of '%s'"),
2910                                    oid_to_hex(&commit->object.oid));
2911                        goto leave_merge;
2912                }
2913                write_author_script(message);
2914                find_commit_subject(message, &body);
2915                len = strlen(body);
2916                ret = write_message(body, len, git_path_merge_msg(), 0);
2917                unuse_commit_buffer(commit, message);
2918                if (ret) {
2919                        error_errno(_("could not write '%s'"),
2920                                    git_path_merge_msg());
2921                        goto leave_merge;
2922                }
2923        } else {
2924                struct strbuf buf = STRBUF_INIT;
2925                int len;
2926
2927                strbuf_addf(&buf, "author %s", git_author_info(0));
2928                write_author_script(buf.buf);
2929                strbuf_reset(&buf);
2930
2931                if (oneline_offset < arg_len) {
2932                        p = arg + oneline_offset;
2933                        len = arg_len - oneline_offset;
2934                } else {
2935                        strbuf_addf(&buf, "Merge branch '%.*s'",
2936                                    merge_arg_len, arg);
2937                        p = buf.buf;
2938                        len = buf.len;
2939                }
2940
2941                ret = write_message(p, len, git_path_merge_msg(), 0);
2942                strbuf_release(&buf);
2943                if (ret) {
2944                        error_errno(_("could not write '%s'"),
2945                                    git_path_merge_msg());
2946                        goto leave_merge;
2947                }
2948        }
2949
2950        /*
2951         * If HEAD is not identical to the first parent of the original merge
2952         * commit, we cannot fast-forward.
2953         */
2954        can_fast_forward = opts->allow_ff && commit && commit->parents &&
2955                !oidcmp(&commit->parents->item->object.oid,
2956                        &head_commit->object.oid);
2957
2958        /*
2959         * If the merge head is different from the original one, we cannot
2960         * fast-forward.
2961         */
2962        if (can_fast_forward) {
2963                struct commit_list *second_parent = commit->parents->next;
2964
2965                if (second_parent && !second_parent->next &&
2966                    oidcmp(&merge_commit->object.oid,
2967                           &second_parent->item->object.oid))
2968                        can_fast_forward = 0;
2969        }
2970
2971        if (can_fast_forward && commit->parents->next &&
2972            !commit->parents->next->next &&
2973            !oidcmp(&commit->parents->next->item->object.oid,
2974                    &merge_commit->object.oid)) {
2975                rollback_lock_file(&lock);
2976                ret = fast_forward_to(&commit->object.oid,
2977                                      &head_commit->object.oid, 0, opts);
2978                goto leave_merge;
2979        }
2980
2981        write_message(oid_to_hex(&merge_commit->object.oid), GIT_SHA1_HEXSZ,
2982                      git_path_merge_head(), 0);
2983        write_message("no-ff", 5, git_path_merge_mode(), 0);
2984
2985        bases = get_merge_bases(head_commit, merge_commit);
2986        if (bases && !oidcmp(&merge_commit->object.oid,
2987                             &bases->item->object.oid)) {
2988                ret = 0;
2989                /* skip merging an ancestor of HEAD */
2990                goto leave_merge;
2991        }
2992
2993        for (j = bases; j; j = j->next)
2994                commit_list_insert(j->item, &reversed);
2995        free_commit_list(bases);
2996
2997        read_cache();
2998        init_merge_options(&o);
2999        o.branch1 = "HEAD";
3000        o.branch2 = ref_name.buf;
3001        o.buffer_output = 2;
3002
3003        ret = merge_recursive(&o, head_commit, merge_commit, reversed, &i);
3004        if (ret <= 0)
3005                fputs(o.obuf.buf, stdout);
3006        strbuf_release(&o.obuf);
3007        if (ret < 0) {
3008                error(_("could not even attempt to merge '%.*s'"),
3009                      merge_arg_len, arg);
3010                goto leave_merge;
3011        }
3012        /*
3013         * The return value of merge_recursive() is 1 on clean, and 0 on
3014         * unclean merge.
3015         *
3016         * Let's reverse that, so that do_merge() returns 0 upon success and
3017         * 1 upon failed merge (keeping the return value -1 for the cases where
3018         * we will want to reschedule the `merge` command).
3019         */
3020        ret = !ret;
3021
3022        if (active_cache_changed &&
3023            write_locked_index(&the_index, &lock, COMMIT_LOCK)) {
3024                ret = error(_("merge: Unable to write new index file"));
3025                goto leave_merge;
3026        }
3027
3028        rollback_lock_file(&lock);
3029        if (ret)
3030                rerere(opts->allow_rerere_auto);
3031        else
3032                /*
3033                 * In case of problems, we now want to return a positive
3034                 * value (a negative one would indicate that the `merge`
3035                 * command needs to be rescheduled).
3036                 */
3037                ret = !!run_git_commit(git_path_merge_msg(), opts,
3038                                     run_commit_flags);
3039
3040leave_merge:
3041        strbuf_release(&ref_name);
3042        rollback_lock_file(&lock);
3043        return ret;
3044}
3045
3046static int is_final_fixup(struct todo_list *todo_list)
3047{
3048        int i = todo_list->current;
3049
3050        if (!is_fixup(todo_list->items[i].command))
3051                return 0;
3052
3053        while (++i < todo_list->nr)
3054                if (is_fixup(todo_list->items[i].command))
3055                        return 0;
3056                else if (!is_noop(todo_list->items[i].command))
3057                        break;
3058        return 1;
3059}
3060
3061static enum todo_command peek_command(struct todo_list *todo_list, int offset)
3062{
3063        int i;
3064
3065        for (i = todo_list->current + offset; i < todo_list->nr; i++)
3066                if (!is_noop(todo_list->items[i].command))
3067                        return todo_list->items[i].command;
3068
3069        return -1;
3070}
3071
3072static int apply_autostash(struct replay_opts *opts)
3073{
3074        struct strbuf stash_sha1 = STRBUF_INIT;
3075        struct child_process child = CHILD_PROCESS_INIT;
3076        int ret = 0;
3077
3078        if (!read_oneliner(&stash_sha1, rebase_path_autostash(), 1)) {
3079                strbuf_release(&stash_sha1);
3080                return 0;
3081        }
3082        strbuf_trim(&stash_sha1);
3083
3084        child.git_cmd = 1;
3085        child.no_stdout = 1;
3086        child.no_stderr = 1;
3087        argv_array_push(&child.args, "stash");
3088        argv_array_push(&child.args, "apply");
3089        argv_array_push(&child.args, stash_sha1.buf);
3090        if (!run_command(&child))
3091                fprintf(stderr, _("Applied autostash.\n"));
3092        else {
3093                struct child_process store = CHILD_PROCESS_INIT;
3094
3095                store.git_cmd = 1;
3096                argv_array_push(&store.args, "stash");
3097                argv_array_push(&store.args, "store");
3098                argv_array_push(&store.args, "-m");
3099                argv_array_push(&store.args, "autostash");
3100                argv_array_push(&store.args, "-q");
3101                argv_array_push(&store.args, stash_sha1.buf);
3102                if (run_command(&store))
3103                        ret = error(_("cannot store %s"), stash_sha1.buf);
3104                else
3105                        fprintf(stderr,
3106                                _("Applying autostash resulted in conflicts.\n"
3107                                  "Your changes are safe in the stash.\n"
3108                                  "You can run \"git stash pop\" or"
3109                                  " \"git stash drop\" at any time.\n"));
3110        }
3111
3112        strbuf_release(&stash_sha1);
3113        return ret;
3114}
3115
3116static const char *reflog_message(struct replay_opts *opts,
3117        const char *sub_action, const char *fmt, ...)
3118{
3119        va_list ap;
3120        static struct strbuf buf = STRBUF_INIT;
3121
3122        va_start(ap, fmt);
3123        strbuf_reset(&buf);
3124        strbuf_addstr(&buf, action_name(opts));
3125        if (sub_action)
3126                strbuf_addf(&buf, " (%s)", sub_action);
3127        if (fmt) {
3128                strbuf_addstr(&buf, ": ");
3129                strbuf_vaddf(&buf, fmt, ap);
3130        }
3131        va_end(ap);
3132
3133        return buf.buf;
3134}
3135
3136static const char rescheduled_advice[] =
3137N_("Could not execute the todo command\n"
3138"\n"
3139"    %.*s"
3140"\n"
3141"It has been rescheduled; To edit the command before continuing, please\n"
3142"edit the todo list first:\n"
3143"\n"
3144"    git rebase --edit-todo\n"
3145"    git rebase --continue\n");
3146
3147static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
3148{
3149        int res = 0, reschedule = 0;
3150
3151        setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
3152        if (opts->allow_ff)
3153                assert(!(opts->signoff || opts->no_commit ||
3154                                opts->record_origin || opts->edit));
3155        if (read_and_refresh_cache(opts))
3156                return -1;
3157
3158        while (todo_list->current < todo_list->nr) {
3159                struct todo_item *item = todo_list->items + todo_list->current;
3160                if (save_todo(todo_list, opts))
3161                        return -1;
3162                if (is_rebase_i(opts)) {
3163                        if (item->command != TODO_COMMENT) {
3164                                FILE *f = fopen(rebase_path_msgnum(), "w");
3165
3166                                todo_list->done_nr++;
3167
3168                                if (f) {
3169                                        fprintf(f, "%d\n", todo_list->done_nr);
3170                                        fclose(f);
3171                                }
3172                                fprintf(stderr, "Rebasing (%d/%d)%s",
3173                                        todo_list->done_nr,
3174                                        todo_list->total_nr,
3175                                        opts->verbose ? "\n" : "\r");
3176                        }
3177                        unlink(rebase_path_message());
3178                        unlink(rebase_path_author_script());
3179                        unlink(rebase_path_stopped_sha());
3180                        unlink(rebase_path_amend());
3181                        delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
3182                }
3183                if (item->command <= TODO_SQUASH) {
3184                        if (is_rebase_i(opts))
3185                                setenv("GIT_REFLOG_ACTION", reflog_message(opts,
3186                                        command_to_string(item->command), NULL),
3187                                        1);
3188                        res = do_pick_commit(item->command, item->commit,
3189                                        opts, is_final_fixup(todo_list));
3190                        if (is_rebase_i(opts) && res < 0) {
3191                                /* Reschedule */
3192                                advise(_(rescheduled_advice),
3193                                       get_item_line_length(todo_list,
3194                                                            todo_list->current),
3195                                       get_item_line(todo_list,
3196                                                     todo_list->current));
3197                                todo_list->current--;
3198                                if (save_todo(todo_list, opts))
3199                                        return -1;
3200                        }
3201                        if (item->command == TODO_EDIT) {
3202                                struct commit *commit = item->commit;
3203                                if (!res)
3204                                        fprintf(stderr,
3205                                                _("Stopped at %s...  %.*s\n"),
3206                                                short_commit_name(commit),
3207                                                item->arg_len, item->arg);
3208                                return error_with_patch(commit,
3209                                        item->arg, item->arg_len, opts, res,
3210                                        !res);
3211                        }
3212                        if (is_rebase_i(opts) && !res)
3213                                record_in_rewritten(&item->commit->object.oid,
3214                                        peek_command(todo_list, 1));
3215                        if (res && is_fixup(item->command)) {
3216                                if (res == 1)
3217                                        intend_to_amend();
3218                                return error_failed_squash(item->commit, opts,
3219                                        item->arg_len, item->arg);
3220                        } else if (res && is_rebase_i(opts) && item->commit)
3221                                return res | error_with_patch(item->commit,
3222                                        item->arg, item->arg_len, opts, res,
3223                                        item->command == TODO_REWORD);
3224                } else if (item->command == TODO_EXEC) {
3225                        char *end_of_arg = (char *)(item->arg + item->arg_len);
3226                        int saved = *end_of_arg;
3227                        struct stat st;
3228
3229                        *end_of_arg = '\0';
3230                        res = do_exec(item->arg);
3231                        *end_of_arg = saved;
3232
3233                        /* Reread the todo file if it has changed. */
3234                        if (res)
3235                                ; /* fall through */
3236                        else if (stat(get_todo_path(opts), &st))
3237                                res = error_errno(_("could not stat '%s'"),
3238                                                  get_todo_path(opts));
3239                        else if (match_stat_data(&todo_list->stat, &st)) {
3240                                todo_list_release(todo_list);
3241                                if (read_populate_todo(todo_list, opts))
3242                                        res = -1; /* message was printed */
3243                                /* `current` will be incremented below */
3244                                todo_list->current = -1;
3245                        }
3246                } else if (item->command == TODO_LABEL) {
3247                        if ((res = do_label(item->arg, item->arg_len)))
3248                                reschedule = 1;
3249                } else if (item->command == TODO_RESET) {
3250                        if ((res = do_reset(item->arg, item->arg_len, opts)))
3251                                reschedule = 1;
3252                } else if (item->command == TODO_MERGE) {
3253                        if ((res = do_merge(item->commit,
3254                                            item->arg, item->arg_len,
3255                                            item->flags, opts)) < 0)
3256                                reschedule = 1;
3257                        else if (item->commit)
3258                                record_in_rewritten(&item->commit->object.oid,
3259                                                    peek_command(todo_list, 1));
3260                        if (res > 0)
3261                                /* failed with merge conflicts */
3262                                return error_with_patch(item->commit,
3263                                                        item->arg,
3264                                                        item->arg_len, opts,
3265                                                        res, 0);
3266                } else if (!is_noop(item->command))
3267                        return error(_("unknown command %d"), item->command);
3268
3269                if (reschedule) {
3270                        advise(_(rescheduled_advice),
3271                               get_item_line_length(todo_list,
3272                                                    todo_list->current),
3273                               get_item_line(todo_list, todo_list->current));
3274                        todo_list->current--;
3275                        if (save_todo(todo_list, opts))
3276                                return -1;
3277                        if (item->commit)
3278                                return error_with_patch(item->commit,
3279                                                        item->arg,
3280                                                        item->arg_len, opts,
3281                                                        res, 0);
3282                }
3283
3284                todo_list->current++;
3285                if (res)
3286                        return res;
3287        }
3288
3289        if (is_rebase_i(opts)) {
3290                struct strbuf head_ref = STRBUF_INIT, buf = STRBUF_INIT;
3291                struct stat st;
3292
3293                /* Stopped in the middle, as planned? */
3294                if (todo_list->current < todo_list->nr)
3295                        return 0;
3296
3297                if (read_oneliner(&head_ref, rebase_path_head_name(), 0) &&
3298                                starts_with(head_ref.buf, "refs/")) {
3299                        const char *msg;
3300                        struct object_id head, orig;
3301                        int res;
3302
3303                        if (get_oid("HEAD", &head)) {
3304                                res = error(_("cannot read HEAD"));
3305cleanup_head_ref:
3306                                strbuf_release(&head_ref);
3307                                strbuf_release(&buf);
3308                                return res;
3309                        }
3310                        if (!read_oneliner(&buf, rebase_path_orig_head(), 0) ||
3311                                        get_oid_hex(buf.buf, &orig)) {
3312                                res = error(_("could not read orig-head"));
3313                                goto cleanup_head_ref;
3314                        }
3315                        strbuf_reset(&buf);
3316                        if (!read_oneliner(&buf, rebase_path_onto(), 0)) {
3317                                res = error(_("could not read 'onto'"));
3318                                goto cleanup_head_ref;
3319                        }
3320                        msg = reflog_message(opts, "finish", "%s onto %s",
3321                                head_ref.buf, buf.buf);
3322                        if (update_ref(msg, head_ref.buf, &head, &orig,
3323                                       REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR)) {
3324                                res = error(_("could not update %s"),
3325                                        head_ref.buf);
3326                                goto cleanup_head_ref;
3327                        }
3328                        msg = reflog_message(opts, "finish", "returning to %s",
3329                                head_ref.buf);
3330                        if (create_symref("HEAD", head_ref.buf, msg)) {
3331                                res = error(_("could not update HEAD to %s"),
3332                                        head_ref.buf);
3333                                goto cleanup_head_ref;
3334                        }
3335                        strbuf_reset(&buf);
3336                }
3337
3338                if (opts->verbose) {
3339                        struct rev_info log_tree_opt;
3340                        struct object_id orig, head;
3341
3342                        memset(&log_tree_opt, 0, sizeof(log_tree_opt));
3343                        init_revisions(&log_tree_opt, NULL);
3344                        log_tree_opt.diff = 1;
3345                        log_tree_opt.diffopt.output_format =
3346                                DIFF_FORMAT_DIFFSTAT;
3347                        log_tree_opt.disable_stdin = 1;
3348
3349                        if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
3350                            !get_oid(buf.buf, &orig) &&
3351                            !get_oid("HEAD", &head)) {
3352                                diff_tree_oid(&orig, &head, "",
3353                                              &log_tree_opt.diffopt);
3354                                log_tree_diff_flush(&log_tree_opt);
3355                        }
3356                }
3357                flush_rewritten_pending();
3358                if (!stat(rebase_path_rewritten_list(), &st) &&
3359                                st.st_size > 0) {
3360                        struct child_process child = CHILD_PROCESS_INIT;
3361                        const char *post_rewrite_hook =
3362                                find_hook("post-rewrite");
3363
3364                        child.in = open(rebase_path_rewritten_list(), O_RDONLY);
3365                        child.git_cmd = 1;
3366                        argv_array_push(&child.args, "notes");
3367                        argv_array_push(&child.args, "copy");
3368                        argv_array_push(&child.args, "--for-rewrite=rebase");
3369                        /* we don't care if this copying failed */
3370                        run_command(&child);
3371
3372                        if (post_rewrite_hook) {
3373                                struct child_process hook = CHILD_PROCESS_INIT;
3374
3375                                hook.in = open(rebase_path_rewritten_list(),
3376                                        O_RDONLY);
3377                                hook.stdout_to_stderr = 1;
3378                                argv_array_push(&hook.args, post_rewrite_hook);
3379                                argv_array_push(&hook.args, "rebase");
3380                                /* we don't care if this hook failed */
3381                                run_command(&hook);
3382                        }
3383                }
3384                apply_autostash(opts);
3385
3386                fprintf(stderr, "Successfully rebased and updated %s.\n",
3387                        head_ref.buf);
3388
3389                strbuf_release(&buf);
3390                strbuf_release(&head_ref);
3391        }
3392
3393        /*
3394         * Sequence of picks finished successfully; cleanup by
3395         * removing the .git/sequencer directory
3396         */
3397        return sequencer_remove_state(opts);
3398}
3399
3400static int continue_single_pick(void)
3401{
3402        const char *argv[] = { "commit", NULL };
3403
3404        if (!file_exists(git_path_cherry_pick_head()) &&
3405            !file_exists(git_path_revert_head()))
3406                return error(_("no cherry-pick or revert in progress"));
3407        return run_command_v_opt(argv, RUN_GIT_CMD);
3408}
3409
3410static int commit_staged_changes(struct replay_opts *opts,
3411                                 struct todo_list *todo_list)
3412{
3413        unsigned int flags = ALLOW_EMPTY | EDIT_MSG;
3414        unsigned int final_fixup = 0, is_clean;
3415
3416        if (has_unstaged_changes(1))
3417                return error(_("cannot rebase: You have unstaged changes."));
3418
3419        is_clean = !has_uncommitted_changes(0);
3420
3421        if (file_exists(rebase_path_amend())) {
3422                struct strbuf rev = STRBUF_INIT;
3423                struct object_id head, to_amend;
3424
3425                if (get_oid("HEAD", &head))
3426                        return error(_("cannot amend non-existing commit"));
3427                if (!read_oneliner(&rev, rebase_path_amend(), 0))
3428                        return error(_("invalid file: '%s'"), rebase_path_amend());
3429                if (get_oid_hex(rev.buf, &to_amend))
3430                        return error(_("invalid contents: '%s'"),
3431                                rebase_path_amend());
3432                if (!is_clean && oidcmp(&head, &to_amend))
3433                        return error(_("\nYou have uncommitted changes in your "
3434                                       "working tree. Please, commit them\n"
3435                                       "first and then run 'git rebase "
3436                                       "--continue' again."));
3437                /*
3438                 * When skipping a failed fixup/squash, we need to edit the
3439                 * commit message, the current fixup list and count, and if it
3440                 * was the last fixup/squash in the chain, we need to clean up
3441                 * the commit message and if there was a squash, let the user
3442                 * edit it.
3443                 */
3444                if (is_clean && !oidcmp(&head, &to_amend) &&
3445                    opts->current_fixup_count > 0 &&
3446                    file_exists(rebase_path_stopped_sha())) {
3447                        const char *p = opts->current_fixups.buf;
3448                        int len = opts->current_fixups.len;
3449
3450                        opts->current_fixup_count--;
3451                        if (!len)
3452                                BUG("Incorrect current_fixups:\n%s", p);
3453                        while (len && p[len - 1] != '\n')
3454                                len--;
3455                        strbuf_setlen(&opts->current_fixups, len);
3456                        if (write_message(p, len, rebase_path_current_fixups(),
3457                                          0) < 0)
3458                                return error(_("could not write file: '%s'"),
3459                                             rebase_path_current_fixups());
3460
3461                        /*
3462                         * If a fixup/squash in a fixup/squash chain failed, the
3463                         * commit message is already correct, no need to commit
3464                         * it again.
3465                         *
3466                         * Only if it is the final command in the fixup/squash
3467                         * chain, and only if the chain is longer than a single
3468                         * fixup/squash command (which was just skipped), do we
3469                         * actually need to re-commit with a cleaned up commit
3470                         * message.
3471                         */
3472                        if (opts->current_fixup_count > 0 &&
3473                            !is_fixup(peek_command(todo_list, 0))) {
3474                                final_fixup = 1;
3475                                /*
3476                                 * If there was not a single "squash" in the
3477                                 * chain, we only need to clean up the commit
3478                                 * message, no need to bother the user with
3479                                 * opening the commit message in the editor.
3480                                 */
3481                                if (!starts_with(p, "squash ") &&
3482                                    !strstr(p, "\nsquash "))
3483                                        flags = (flags & ~EDIT_MSG) | CLEANUP_MSG;
3484                        } else if (is_fixup(peek_command(todo_list, 0))) {
3485                                /*
3486                                 * We need to update the squash message to skip
3487                                 * the latest commit message.
3488                                 */
3489                                struct commit *commit;
3490                                const char *path = rebase_path_squash_msg();
3491
3492                                if (parse_head(&commit) ||
3493                                    !(p = get_commit_buffer(commit, NULL)) ||
3494                                    write_message(p, strlen(p), path, 0)) {
3495                                        unuse_commit_buffer(commit, p);
3496                                        return error(_("could not write file: "
3497                                                       "'%s'"), path);
3498                                }
3499                                unuse_commit_buffer(commit, p);
3500                        }
3501                }
3502
3503                strbuf_release(&rev);
3504                flags |= AMEND_MSG;
3505        }
3506
3507        if (is_clean) {
3508                const char *cherry_pick_head = git_path_cherry_pick_head();
3509
3510                if (file_exists(cherry_pick_head) && unlink(cherry_pick_head))
3511                        return error(_("could not remove CHERRY_PICK_HEAD"));
3512                if (!final_fixup)
3513                        return 0;
3514        }
3515
3516        if (run_git_commit(final_fixup ? NULL : rebase_path_message(),
3517                           opts, flags))
3518                return error(_("could not commit staged changes."));
3519        unlink(rebase_path_amend());
3520        if (final_fixup) {
3521                unlink(rebase_path_fixup_msg());
3522                unlink(rebase_path_squash_msg());
3523        }
3524        if (opts->current_fixup_count > 0) {
3525                /*
3526                 * Whether final fixup or not, we just cleaned up the commit
3527                 * message...
3528                 */
3529                unlink(rebase_path_current_fixups());
3530                strbuf_reset(&opts->current_fixups);
3531                opts->current_fixup_count = 0;
3532        }
3533        return 0;
3534}
3535
3536int sequencer_continue(struct replay_opts *opts)
3537{
3538        struct todo_list todo_list = TODO_LIST_INIT;
3539        int res;
3540
3541        if (read_and_refresh_cache(opts))
3542                return -1;
3543
3544        if (read_populate_opts(opts))
3545                return -1;
3546        if (is_rebase_i(opts)) {
3547                if ((res = read_populate_todo(&todo_list, opts)))
3548                        goto release_todo_list;
3549                if (commit_staged_changes(opts, &todo_list))
3550                        return -1;
3551        } else if (!file_exists(get_todo_path(opts)))
3552                return continue_single_pick();
3553        else if ((res = read_populate_todo(&todo_list, opts)))
3554                goto release_todo_list;
3555
3556        if (!is_rebase_i(opts)) {
3557                /* Verify that the conflict has been resolved */
3558                if (file_exists(git_path_cherry_pick_head()) ||
3559                    file_exists(git_path_revert_head())) {
3560                        res = continue_single_pick();
3561                        if (res)
3562                                goto release_todo_list;
3563                }
3564                if (index_differs_from("HEAD", NULL, 0)) {
3565                        res = error_dirty_index(opts);
3566                        goto release_todo_list;
3567                }
3568                todo_list.current++;
3569        } else if (file_exists(rebase_path_stopped_sha())) {
3570                struct strbuf buf = STRBUF_INIT;
3571                struct object_id oid;
3572
3573                if (read_oneliner(&buf, rebase_path_stopped_sha(), 1) &&
3574                    !get_oid_committish(buf.buf, &oid))
3575                        record_in_rewritten(&oid, peek_command(&todo_list, 0));
3576                strbuf_release(&buf);
3577        }
3578
3579        res = pick_commits(&todo_list, opts);
3580release_todo_list:
3581        todo_list_release(&todo_list);
3582        return res;
3583}
3584
3585static int single_pick(struct commit *cmit, struct replay_opts *opts)
3586{
3587        setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
3588        return do_pick_commit(opts->action == REPLAY_PICK ?
3589                TODO_PICK : TODO_REVERT, cmit, opts, 0);
3590}
3591
3592int sequencer_pick_revisions(struct replay_opts *opts)
3593{
3594        struct todo_list todo_list = TODO_LIST_INIT;
3595        struct object_id oid;
3596        int i, res;
3597
3598        assert(opts->revs);
3599        if (read_and_refresh_cache(opts))
3600                return -1;
3601
3602        for (i = 0; i < opts->revs->pending.nr; i++) {
3603                struct object_id oid;
3604                const char *name = opts->revs->pending.objects[i].name;
3605
3606                /* This happens when using --stdin. */
3607                if (!strlen(name))
3608                        continue;
3609
3610                if (!get_oid(name, &oid)) {
3611                        if (!lookup_commit_reference_gently(&oid, 1)) {
3612                                enum object_type type = oid_object_info(the_repository,
3613                                                                        &oid,
3614                                                                        NULL);
3615                                return error(_("%s: can't cherry-pick a %s"),
3616                                        name, type_name(type));
3617                        }
3618                } else
3619                        return error(_("%s: bad revision"), name);
3620        }
3621
3622        /*
3623         * If we were called as "git cherry-pick <commit>", just
3624         * cherry-pick/revert it, set CHERRY_PICK_HEAD /
3625         * REVERT_HEAD, and don't touch the sequencer state.
3626         * This means it is possible to cherry-pick in the middle
3627         * of a cherry-pick sequence.
3628         */
3629        if (opts->revs->cmdline.nr == 1 &&
3630            opts->revs->cmdline.rev->whence == REV_CMD_REV &&
3631            opts->revs->no_walk &&
3632            !opts->revs->cmdline.rev->flags) {
3633                struct commit *cmit;
3634                if (prepare_revision_walk(opts->revs))
3635                        return error(_("revision walk setup failed"));
3636                cmit = get_revision(opts->revs);
3637                if (!cmit || get_revision(opts->revs))
3638                        return error("BUG: expected exactly one commit from walk");
3639                return single_pick(cmit, opts);
3640        }
3641
3642        /*
3643         * Start a new cherry-pick/ revert sequence; but
3644         * first, make sure that an existing one isn't in
3645         * progress
3646         */
3647
3648        if (walk_revs_populate_todo(&todo_list, opts) ||
3649                        create_seq_dir() < 0)
3650                return -1;
3651        if (get_oid("HEAD", &oid) && (opts->action == REPLAY_REVERT))
3652                return error(_("can't revert as initial commit"));
3653        if (save_head(oid_to_hex(&oid)))
3654                return -1;
3655        if (save_opts(opts))
3656                return -1;
3657        update_abort_safety_file();
3658        res = pick_commits(&todo_list, opts);
3659        todo_list_release(&todo_list);
3660        return res;
3661}
3662
3663void append_signoff(struct strbuf *msgbuf, int ignore_footer, unsigned flag)
3664{
3665        unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
3666        struct strbuf sob = STRBUF_INIT;
3667        int has_footer;
3668
3669        strbuf_addstr(&sob, sign_off_header);
3670        strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
3671                                getenv("GIT_COMMITTER_EMAIL")));
3672        strbuf_addch(&sob, '\n');
3673
3674        if (!ignore_footer)
3675                strbuf_complete_line(msgbuf);
3676
3677        /*
3678         * If the whole message buffer is equal to the sob, pretend that we
3679         * found a conforming footer with a matching sob
3680         */
3681        if (msgbuf->len - ignore_footer == sob.len &&
3682            !strncmp(msgbuf->buf, sob.buf, sob.len))
3683                has_footer = 3;
3684        else
3685                has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
3686
3687        if (!has_footer) {
3688                const char *append_newlines = NULL;
3689                size_t len = msgbuf->len - ignore_footer;
3690
3691                if (!len) {
3692                        /*
3693                         * The buffer is completely empty.  Leave foom for
3694                         * the title and body to be filled in by the user.
3695                         */
3696                        append_newlines = "\n\n";
3697                } else if (len == 1) {
3698                        /*
3699                         * Buffer contains a single newline.  Add another
3700                         * so that we leave room for the title and body.
3701                         */
3702                        append_newlines = "\n";
3703                } else if (msgbuf->buf[len - 2] != '\n') {
3704                        /*
3705                         * Buffer ends with a single newline.  Add another
3706                         * so that there is an empty line between the message
3707                         * body and the sob.
3708                         */
3709                        append_newlines = "\n";
3710                } /* else, the buffer already ends with two newlines. */
3711
3712                if (append_newlines)
3713                        strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
3714                                append_newlines, strlen(append_newlines));
3715        }
3716
3717        if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
3718                strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
3719                                sob.buf, sob.len);
3720
3721        strbuf_release(&sob);
3722}
3723
3724struct labels_entry {
3725        struct hashmap_entry entry;
3726        char label[FLEX_ARRAY];
3727};
3728
3729static int labels_cmp(const void *fndata, const struct labels_entry *a,
3730                      const struct labels_entry *b, const void *key)
3731{
3732        return key ? strcmp(a->label, key) : strcmp(a->label, b->label);
3733}
3734
3735struct string_entry {
3736        struct oidmap_entry entry;
3737        char string[FLEX_ARRAY];
3738};
3739
3740struct label_state {
3741        struct oidmap commit2label;
3742        struct hashmap labels;
3743        struct strbuf buf;
3744};
3745
3746static const char *label_oid(struct object_id *oid, const char *label,
3747                             struct label_state *state)
3748{
3749        struct labels_entry *labels_entry;
3750        struct string_entry *string_entry;
3751        struct object_id dummy;
3752        size_t len;
3753        int i;
3754
3755        string_entry = oidmap_get(&state->commit2label, oid);
3756        if (string_entry)
3757                return string_entry->string;
3758
3759        /*
3760         * For "uninteresting" commits, i.e. commits that are not to be
3761         * rebased, and which can therefore not be labeled, we use a unique
3762         * abbreviation of the commit name. This is slightly more complicated
3763         * than calling find_unique_abbrev() because we also need to make
3764         * sure that the abbreviation does not conflict with any other
3765         * label.
3766         *
3767         * We disallow "interesting" commits to be labeled by a string that
3768         * is a valid full-length hash, to ensure that we always can find an
3769         * abbreviation for any uninteresting commit's names that does not
3770         * clash with any other label.
3771         */
3772        if (!label) {
3773                char *p;
3774
3775                strbuf_reset(&state->buf);
3776                strbuf_grow(&state->buf, GIT_SHA1_HEXSZ);
3777                label = p = state->buf.buf;
3778
3779                find_unique_abbrev_r(p, oid, default_abbrev);
3780
3781                /*
3782                 * We may need to extend the abbreviated hash so that there is
3783                 * no conflicting label.
3784                 */
3785                if (hashmap_get_from_hash(&state->labels, strihash(p), p)) {
3786                        size_t i = strlen(p) + 1;
3787
3788                        oid_to_hex_r(p, oid);
3789                        for (; i < GIT_SHA1_HEXSZ; i++) {
3790                                char save = p[i];
3791                                p[i] = '\0';
3792                                if (!hashmap_get_from_hash(&state->labels,
3793                                                           strihash(p), p))
3794                                        break;
3795                                p[i] = save;
3796                        }
3797                }
3798        } else if (((len = strlen(label)) == the_hash_algo->hexsz &&
3799                    !get_oid_hex(label, &dummy)) ||
3800                   (len == 1 && *label == '#') ||
3801                   hashmap_get_from_hash(&state->labels,
3802                                         strihash(label), label)) {
3803                /*
3804                 * If the label already exists, or if the label is a valid full
3805                 * OID, or the label is a '#' (which we use as a separator
3806                 * between merge heads and oneline), we append a dash and a
3807                 * number to make it unique.
3808                 */
3809                struct strbuf *buf = &state->buf;
3810
3811                strbuf_reset(buf);
3812                strbuf_add(buf, label, len);
3813
3814                for (i = 2; ; i++) {
3815                        strbuf_setlen(buf, len);
3816                        strbuf_addf(buf, "-%d", i);
3817                        if (!hashmap_get_from_hash(&state->labels,
3818                                                   strihash(buf->buf),
3819                                                   buf->buf))
3820                                break;
3821                }
3822
3823                label = buf->buf;
3824        }
3825
3826        FLEX_ALLOC_STR(labels_entry, label, label);
3827        hashmap_entry_init(labels_entry, strihash(label));
3828        hashmap_add(&state->labels, labels_entry);
3829
3830        FLEX_ALLOC_STR(string_entry, string, label);
3831        oidcpy(&string_entry->entry.oid, oid);
3832        oidmap_put(&state->commit2label, string_entry);
3833
3834        return string_entry->string;
3835}
3836
3837static int make_script_with_merges(struct pretty_print_context *pp,
3838                                   struct rev_info *revs, FILE *out,
3839                                   unsigned flags)
3840{
3841        int keep_empty = flags & TODO_LIST_KEEP_EMPTY;
3842        int rebase_cousins = flags & TODO_LIST_REBASE_COUSINS;
3843        struct strbuf buf = STRBUF_INIT, oneline = STRBUF_INIT;
3844        struct strbuf label = STRBUF_INIT;
3845        struct commit_list *commits = NULL, **tail = &commits, *iter;
3846        struct commit_list *tips = NULL, **tips_tail = &tips;
3847        struct commit *commit;
3848        struct oidmap commit2todo = OIDMAP_INIT;
3849        struct string_entry *entry;
3850        struct oidset interesting = OIDSET_INIT, child_seen = OIDSET_INIT,
3851                shown = OIDSET_INIT;
3852        struct label_state state = { OIDMAP_INIT, { NULL }, STRBUF_INIT };
3853
3854        int abbr = flags & TODO_LIST_ABBREVIATE_CMDS;
3855        const char *cmd_pick = abbr ? "p" : "pick",
3856                *cmd_label = abbr ? "l" : "label",
3857                *cmd_reset = abbr ? "t" : "reset",
3858                *cmd_merge = abbr ? "m" : "merge";
3859
3860        oidmap_init(&commit2todo, 0);
3861        oidmap_init(&state.commit2label, 0);
3862        hashmap_init(&state.labels, (hashmap_cmp_fn) labels_cmp, NULL, 0);
3863        strbuf_init(&state.buf, 32);
3864
3865        if (revs->cmdline.nr && (revs->cmdline.rev[0].flags & BOTTOM)) {
3866                struct object_id *oid = &revs->cmdline.rev[0].item->oid;
3867                FLEX_ALLOC_STR(entry, string, "onto");
3868                oidcpy(&entry->entry.oid, oid);
3869                oidmap_put(&state.commit2label, entry);
3870        }
3871
3872        /*
3873         * First phase:
3874         * - get onelines for all commits
3875         * - gather all branch tips (i.e. 2nd or later parents of merges)
3876         * - label all branch tips
3877         */
3878        while ((commit = get_revision(revs))) {
3879                struct commit_list *to_merge;
3880                int is_octopus;
3881                const char *p1, *p2;
3882                struct object_id *oid;
3883                int is_empty;
3884
3885                tail = &commit_list_insert(commit, tail)->next;
3886                oidset_insert(&interesting, &commit->object.oid);
3887
3888                is_empty = is_original_commit_empty(commit);
3889                if (!is_empty && (commit->object.flags & PATCHSAME))
3890                        continue;
3891
3892                strbuf_reset(&oneline);
3893                pretty_print_commit(pp, commit, &oneline);
3894
3895                to_merge = commit->parents ? commit->parents->next : NULL;
3896                if (!to_merge) {
3897                        /* non-merge commit: easy case */
3898                        strbuf_reset(&buf);
3899                        if (!keep_empty && is_empty)
3900                                strbuf_addf(&buf, "%c ", comment_line_char);
3901                        strbuf_addf(&buf, "%s %s %s", cmd_pick,
3902                                    oid_to_hex(&commit->object.oid),
3903                                    oneline.buf);
3904
3905                        FLEX_ALLOC_STR(entry, string, buf.buf);
3906                        oidcpy(&entry->entry.oid, &commit->object.oid);
3907                        oidmap_put(&commit2todo, entry);
3908
3909                        continue;
3910                }
3911
3912                is_octopus = to_merge && to_merge->next;
3913
3914                if (is_octopus)
3915                        BUG("Octopus merges not yet supported");
3916
3917                /* Create a label */
3918                strbuf_reset(&label);
3919                if (skip_prefix(oneline.buf, "Merge ", &p1) &&
3920                    (p1 = strchr(p1, '\'')) &&
3921                    (p2 = strchr(++p1, '\'')))
3922                        strbuf_add(&label, p1, p2 - p1);
3923                else if (skip_prefix(oneline.buf, "Merge pull request ",
3924                                     &p1) &&
3925                         (p1 = strstr(p1, " from ")))
3926                        strbuf_addstr(&label, p1 + strlen(" from "));
3927                else
3928                        strbuf_addbuf(&label, &oneline);
3929
3930                for (p1 = label.buf; *p1; p1++)
3931                        if (isspace(*p1))
3932                                *(char *)p1 = '-';
3933
3934                strbuf_reset(&buf);
3935                strbuf_addf(&buf, "%s -C %s",
3936                            cmd_merge, oid_to_hex(&commit->object.oid));
3937
3938                /* label the tip of merged branch */
3939                oid = &to_merge->item->object.oid;
3940                strbuf_addch(&buf, ' ');
3941
3942                if (!oidset_contains(&interesting, oid))
3943                        strbuf_addstr(&buf, label_oid(oid, NULL, &state));
3944                else {
3945                        tips_tail = &commit_list_insert(to_merge->item,
3946                                                        tips_tail)->next;
3947
3948                        strbuf_addstr(&buf, label_oid(oid, label.buf, &state));
3949                }
3950                strbuf_addf(&buf, " # %s", oneline.buf);
3951
3952                FLEX_ALLOC_STR(entry, string, buf.buf);
3953                oidcpy(&entry->entry.oid, &commit->object.oid);
3954                oidmap_put(&commit2todo, entry);
3955        }
3956
3957        /*
3958         * Second phase:
3959         * - label branch points
3960         * - add HEAD to the branch tips
3961         */
3962        for (iter = commits; iter; iter = iter->next) {
3963                struct commit_list *parent = iter->item->parents;
3964                for (; parent; parent = parent->next) {
3965                        struct object_id *oid = &parent->item->object.oid;
3966                        if (!oidset_contains(&interesting, oid))
3967                                continue;
3968                        if (!oidset_contains(&child_seen, oid))
3969                                oidset_insert(&child_seen, oid);
3970                        else
3971                                label_oid(oid, "branch-point", &state);
3972                }
3973
3974                /* Add HEAD as implict "tip of branch" */
3975                if (!iter->next)
3976                        tips_tail = &commit_list_insert(iter->item,
3977                                                        tips_tail)->next;
3978        }
3979
3980        /*
3981         * Third phase: output the todo list. This is a bit tricky, as we
3982         * want to avoid jumping back and forth between revisions. To
3983         * accomplish that goal, we walk backwards from the branch tips,
3984         * gathering commits not yet shown, reversing the list on the fly,
3985         * then outputting that list (labeling revisions as needed).
3986         */
3987        fprintf(out, "%s onto\n", cmd_label);
3988        for (iter = tips; iter; iter = iter->next) {
3989                struct commit_list *list = NULL, *iter2;
3990
3991                commit = iter->item;
3992                if (oidset_contains(&shown, &commit->object.oid))
3993                        continue;
3994                entry = oidmap_get(&state.commit2label, &commit->object.oid);
3995
3996                if (entry)
3997                        fprintf(out, "\n# Branch %s\n", entry->string);
3998                else
3999                        fprintf(out, "\n");
4000
4001                while (oidset_contains(&interesting, &commit->object.oid) &&
4002                       !oidset_contains(&shown, &commit->object.oid)) {
4003                        commit_list_insert(commit, &list);
4004                        if (!commit->parents) {
4005                                commit = NULL;
4006                                break;
4007                        }
4008                        commit = commit->parents->item;
4009                }
4010
4011                if (!commit)
4012                        fprintf(out, "%s %s\n", cmd_reset,
4013                                rebase_cousins ? "onto" : "[new root]");
4014                else {
4015                        const char *to = NULL;
4016
4017                        entry = oidmap_get(&state.commit2label,
4018                                           &commit->object.oid);
4019                        if (entry)
4020                                to = entry->string;
4021                        else if (!rebase_cousins)
4022                                to = label_oid(&commit->object.oid, NULL,
4023                                               &state);
4024
4025                        if (!to || !strcmp(to, "onto"))
4026                                fprintf(out, "%s onto\n", cmd_reset);
4027                        else {
4028                                strbuf_reset(&oneline);
4029                                pretty_print_commit(pp, commit, &oneline);
4030                                fprintf(out, "%s %s # %s\n",
4031                                        cmd_reset, to, oneline.buf);
4032                        }
4033                }
4034
4035                for (iter2 = list; iter2; iter2 = iter2->next) {
4036                        struct object_id *oid = &iter2->item->object.oid;
4037                        entry = oidmap_get(&commit2todo, oid);
4038                        /* only show if not already upstream */
4039                        if (entry)
4040                                fprintf(out, "%s\n", entry->string);
4041                        entry = oidmap_get(&state.commit2label, oid);
4042                        if (entry)
4043                                fprintf(out, "%s %s\n",
4044                                        cmd_label, entry->string);
4045                        oidset_insert(&shown, oid);
4046                }
4047
4048                free_commit_list(list);
4049        }
4050
4051        free_commit_list(commits);
4052        free_commit_list(tips);
4053
4054        strbuf_release(&label);
4055        strbuf_release(&oneline);
4056        strbuf_release(&buf);
4057
4058        oidmap_free(&commit2todo, 1);
4059        oidmap_free(&state.commit2label, 1);
4060        hashmap_free(&state.labels, 1);
4061        strbuf_release(&state.buf);
4062
4063        return 0;
4064}
4065
4066int sequencer_make_script(FILE *out, int argc, const char **argv,
4067                          unsigned flags)
4068{
4069        char *format = NULL;
4070        struct pretty_print_context pp = {0};
4071        struct strbuf buf = STRBUF_INIT;
4072        struct rev_info revs;
4073        struct commit *commit;
4074        int keep_empty = flags & TODO_LIST_KEEP_EMPTY;
4075        const char *insn = flags & TODO_LIST_ABBREVIATE_CMDS ? "p" : "pick";
4076        int rebase_merges = flags & TODO_LIST_REBASE_MERGES;
4077
4078        init_revisions(&revs, NULL);
4079        revs.verbose_header = 1;
4080        if (!rebase_merges)
4081                revs.max_parents = 1;
4082        revs.cherry_mark = 1;
4083        revs.limited = 1;
4084        revs.reverse = 1;
4085        revs.right_only = 1;
4086        revs.sort_order = REV_SORT_IN_GRAPH_ORDER;
4087        revs.topo_order = 1;
4088
4089        revs.pretty_given = 1;
4090        git_config_get_string("rebase.instructionFormat", &format);
4091        if (!format || !*format) {
4092                free(format);
4093                format = xstrdup("%s");
4094        }
4095        get_commit_format(format, &revs);
4096        free(format);
4097        pp.fmt = revs.commit_format;
4098        pp.output_encoding = get_log_output_encoding();
4099
4100        if (setup_revisions(argc, argv, &revs, NULL) > 1)
4101                return error(_("make_script: unhandled options"));
4102
4103        if (prepare_revision_walk(&revs) < 0)
4104                return error(_("make_script: error preparing revisions"));
4105
4106        if (rebase_merges)
4107                return make_script_with_merges(&pp, &revs, out, flags);
4108
4109        while ((commit = get_revision(&revs))) {
4110                int is_empty  = is_original_commit_empty(commit);
4111
4112                if (!is_empty && (commit->object.flags & PATCHSAME))
4113                        continue;
4114                strbuf_reset(&buf);
4115                if (!keep_empty && is_empty)
4116                        strbuf_addf(&buf, "%c ", comment_line_char);
4117                strbuf_addf(&buf, "%s %s ", insn,
4118                            oid_to_hex(&commit->object.oid));
4119                pretty_print_commit(&pp, commit, &buf);
4120                strbuf_addch(&buf, '\n');
4121                fputs(buf.buf, out);
4122        }
4123        strbuf_release(&buf);
4124        return 0;
4125}
4126
4127/*
4128 * Add commands after pick and (series of) squash/fixup commands
4129 * in the todo list.
4130 */
4131int sequencer_add_exec_commands(const char *commands)
4132{
4133        const char *todo_file = rebase_path_todo();
4134        struct todo_list todo_list = TODO_LIST_INIT;
4135        struct todo_item *item;
4136        struct strbuf *buf = &todo_list.buf;
4137        size_t offset = 0, commands_len = strlen(commands);
4138        int i, first;
4139
4140        if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
4141                return error(_("could not read '%s'."), todo_file);
4142
4143        if (parse_insn_buffer(todo_list.buf.buf, &todo_list)) {
4144                todo_list_release(&todo_list);
4145                return error(_("unusable todo list: '%s'"), todo_file);
4146        }
4147
4148        first = 1;
4149        /* insert <commands> before every pick except the first one */
4150        for (item = todo_list.items, i = 0; i < todo_list.nr; i++, item++) {
4151                if (item->command == TODO_PICK && !first) {
4152                        strbuf_insert(buf, item->offset_in_buf + offset,
4153                                      commands, commands_len);
4154                        offset += commands_len;
4155                }
4156                first = 0;
4157        }
4158
4159        /* append final <commands> */
4160        strbuf_add(buf, commands, commands_len);
4161
4162        i = write_message(buf->buf, buf->len, todo_file, 0);
4163        todo_list_release(&todo_list);
4164        return i;
4165}
4166
4167int transform_todos(unsigned flags)
4168{
4169        const char *todo_file = rebase_path_todo();
4170        struct todo_list todo_list = TODO_LIST_INIT;
4171        struct strbuf buf = STRBUF_INIT;
4172        struct todo_item *item;
4173        int i;
4174
4175        if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
4176                return error(_("could not read '%s'."), todo_file);
4177
4178        if (parse_insn_buffer(todo_list.buf.buf, &todo_list)) {
4179                todo_list_release(&todo_list);
4180                return error(_("unusable todo list: '%s'"), todo_file);
4181        }
4182
4183        for (item = todo_list.items, i = 0; i < todo_list.nr; i++, item++) {
4184                /* if the item is not a command write it and continue */
4185                if (item->command >= TODO_COMMENT) {
4186                        strbuf_addf(&buf, "%.*s\n", item->arg_len, item->arg);
4187                        continue;
4188                }
4189
4190                /* add command to the buffer */
4191                if (flags & TODO_LIST_ABBREVIATE_CMDS)
4192                        strbuf_addch(&buf, command_to_char(item->command));
4193                else
4194                        strbuf_addstr(&buf, command_to_string(item->command));
4195
4196                /* add commit id */
4197                if (item->commit) {
4198                        const char *oid = flags & TODO_LIST_SHORTEN_IDS ?
4199                                          short_commit_name(item->commit) :
4200                                          oid_to_hex(&item->commit->object.oid);
4201
4202                        if (item->command == TODO_MERGE) {
4203                                if (item->flags & TODO_EDIT_MERGE_MSG)
4204                                        strbuf_addstr(&buf, " -c");
4205                                else
4206                                        strbuf_addstr(&buf, " -C");
4207                        }
4208
4209                        strbuf_addf(&buf, " %s", oid);
4210                }
4211
4212                /* add all the rest */
4213                if (!item->arg_len)
4214                        strbuf_addch(&buf, '\n');
4215                else
4216                        strbuf_addf(&buf, " %.*s\n", item->arg_len, item->arg);
4217        }
4218
4219        i = write_message(buf.buf, buf.len, todo_file, 0);
4220        todo_list_release(&todo_list);
4221        return i;
4222}
4223
4224enum check_level {
4225        CHECK_IGNORE = 0, CHECK_WARN, CHECK_ERROR
4226};
4227
4228static enum check_level get_missing_commit_check_level(void)
4229{
4230        const char *value;
4231
4232        if (git_config_get_value("rebase.missingcommitscheck", &value) ||
4233                        !strcasecmp("ignore", value))
4234                return CHECK_IGNORE;
4235        if (!strcasecmp("warn", value))
4236                return CHECK_WARN;
4237        if (!strcasecmp("error", value))
4238                return CHECK_ERROR;
4239        warning(_("unrecognized setting %s for option "
4240                  "rebase.missingCommitsCheck. Ignoring."), value);
4241        return CHECK_IGNORE;
4242}
4243
4244/*
4245 * Check if the user dropped some commits by mistake
4246 * Behaviour determined by rebase.missingCommitsCheck.
4247 * Check if there is an unrecognized command or a
4248 * bad SHA-1 in a command.
4249 */
4250int check_todo_list(void)
4251{
4252        enum check_level check_level = get_missing_commit_check_level();
4253        struct strbuf todo_file = STRBUF_INIT;
4254        struct todo_list todo_list = TODO_LIST_INIT;
4255        struct strbuf missing = STRBUF_INIT;
4256        int advise_to_edit_todo = 0, res = 0, i;
4257
4258        strbuf_addstr(&todo_file, rebase_path_todo());
4259        if (strbuf_read_file_or_whine(&todo_list.buf, todo_file.buf) < 0) {
4260                res = -1;
4261                goto leave_check;
4262        }
4263        advise_to_edit_todo = res =
4264                parse_insn_buffer(todo_list.buf.buf, &todo_list);
4265
4266        if (res || check_level == CHECK_IGNORE)
4267                goto leave_check;
4268
4269        /* Mark the commits in git-rebase-todo as seen */
4270        for (i = 0; i < todo_list.nr; i++) {
4271                struct commit *commit = todo_list.items[i].commit;
4272                if (commit)
4273                        commit->util = (void *)1;
4274        }
4275
4276        todo_list_release(&todo_list);
4277        strbuf_addstr(&todo_file, ".backup");
4278        if (strbuf_read_file_or_whine(&todo_list.buf, todo_file.buf) < 0) {
4279                res = -1;
4280                goto leave_check;
4281        }
4282        strbuf_release(&todo_file);
4283        res = !!parse_insn_buffer(todo_list.buf.buf, &todo_list);
4284
4285        /* Find commits in git-rebase-todo.backup yet unseen */
4286        for (i = todo_list.nr - 1; i >= 0; i--) {
4287                struct todo_item *item = todo_list.items + i;
4288                struct commit *commit = item->commit;
4289                if (commit && !commit->util) {
4290                        strbuf_addf(&missing, " - %s %.*s\n",
4291                                    short_commit_name(commit),
4292                                    item->arg_len, item->arg);
4293                        commit->util = (void *)1;
4294                }
4295        }
4296
4297        /* Warn about missing commits */
4298        if (!missing.len)
4299                goto leave_check;
4300
4301        if (check_level == CHECK_ERROR)
4302                advise_to_edit_todo = res = 1;
4303
4304        fprintf(stderr,
4305                _("Warning: some commits may have been dropped accidentally.\n"
4306                "Dropped commits (newer to older):\n"));
4307
4308        /* Make the list user-friendly and display */
4309        fputs(missing.buf, stderr);
4310        strbuf_release(&missing);
4311
4312        fprintf(stderr, _("To avoid this message, use \"drop\" to "
4313                "explicitly remove a commit.\n\n"
4314                "Use 'git config rebase.missingCommitsCheck' to change "
4315                "the level of warnings.\n"
4316                "The possible behaviours are: ignore, warn, error.\n\n"));
4317
4318leave_check:
4319        strbuf_release(&todo_file);
4320        todo_list_release(&todo_list);
4321
4322        if (advise_to_edit_todo)
4323                fprintf(stderr,
4324                        _("You can fix this with 'git rebase --edit-todo' "
4325                          "and then run 'git rebase --continue'.\n"
4326                          "Or you can abort the rebase with 'git rebase"
4327                          " --abort'.\n"));
4328
4329        return res;
4330}
4331
4332static int rewrite_file(const char *path, const char *buf, size_t len)
4333{
4334        int rc = 0;
4335        int fd = open(path, O_WRONLY | O_TRUNC);
4336        if (fd < 0)
4337                return error_errno(_("could not open '%s' for writing"), path);
4338        if (write_in_full(fd, buf, len) < 0)
4339                rc = error_errno(_("could not write to '%s'"), path);
4340        if (close(fd) && !rc)
4341                rc = error_errno(_("could not close '%s'"), path);
4342        return rc;
4343}
4344
4345/* skip picking commits whose parents are unchanged */
4346int skip_unnecessary_picks(void)
4347{
4348        const char *todo_file = rebase_path_todo();
4349        struct strbuf buf = STRBUF_INIT;
4350        struct todo_list todo_list = TODO_LIST_INIT;
4351        struct object_id onto_oid, *oid = &onto_oid, *parent_oid;
4352        int fd, i;
4353
4354        if (!read_oneliner(&buf, rebase_path_onto(), 0))
4355                return error(_("could not read 'onto'"));
4356        if (get_oid(buf.buf, &onto_oid)) {
4357                strbuf_release(&buf);
4358                return error(_("need a HEAD to fixup"));
4359        }
4360        strbuf_release(&buf);
4361
4362        if (strbuf_read_file_or_whine(&todo_list.buf, todo_file) < 0)
4363                return -1;
4364        if (parse_insn_buffer(todo_list.buf.buf, &todo_list) < 0) {
4365                todo_list_release(&todo_list);
4366                return -1;
4367        }
4368
4369        for (i = 0; i < todo_list.nr; i++) {
4370                struct todo_item *item = todo_list.items + i;
4371
4372                if (item->command >= TODO_NOOP)
4373                        continue;
4374                if (item->command != TODO_PICK)
4375                        break;
4376                if (parse_commit(item->commit)) {
4377                        todo_list_release(&todo_list);
4378                        return error(_("could not parse commit '%s'"),
4379                                oid_to_hex(&item->commit->object.oid));
4380                }
4381                if (!item->commit->parents)
4382                        break; /* root commit */
4383                if (item->commit->parents->next)
4384                        break; /* merge commit */
4385                parent_oid = &item->commit->parents->item->object.oid;
4386                if (hashcmp(parent_oid->hash, oid->hash))
4387                        break;
4388                oid = &item->commit->object.oid;
4389        }
4390        if (i > 0) {
4391                int offset = get_item_line_offset(&todo_list, i);
4392                const char *done_path = rebase_path_done();
4393
4394                fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
4395                if (fd < 0) {
4396                        error_errno(_("could not open '%s' for writing"),
4397                                    done_path);
4398                        todo_list_release(&todo_list);
4399                        return -1;
4400                }
4401                if (write_in_full(fd, todo_list.buf.buf, offset) < 0) {
4402                        error_errno(_("could not write to '%s'"), done_path);
4403                        todo_list_release(&todo_list);
4404                        close(fd);
4405                        return -1;
4406                }
4407                close(fd);
4408
4409                if (rewrite_file(rebase_path_todo(), todo_list.buf.buf + offset,
4410                                 todo_list.buf.len - offset) < 0) {
4411                        todo_list_release(&todo_list);
4412                        return -1;
4413                }
4414
4415                todo_list.current = i;
4416                if (is_fixup(peek_command(&todo_list, 0)))
4417                        record_in_rewritten(oid, peek_command(&todo_list, 0));
4418        }
4419
4420        todo_list_release(&todo_list);
4421        printf("%s\n", oid_to_hex(oid));
4422
4423        return 0;
4424}
4425
4426struct subject2item_entry {
4427        struct hashmap_entry entry;
4428        int i;
4429        char subject[FLEX_ARRAY];
4430};
4431
4432static int subject2item_cmp(const void *fndata,
4433                            const struct subject2item_entry *a,
4434                            const struct subject2item_entry *b, const void *key)
4435{
4436        return key ? strcmp(a->subject, key) : strcmp(a->subject, b->subject);
4437}
4438
4439/*
4440 * Rearrange the todo list that has both "pick commit-id msg" and "pick
4441 * commit-id fixup!/squash! msg" in it so that the latter is put immediately
4442 * after the former, and change "pick" to "fixup"/"squash".
4443 *
4444 * Note that if the config has specified a custom instruction format, each log
4445 * message will have to be retrieved from the commit (as the oneline in the
4446 * script cannot be trusted) in order to normalize the autosquash arrangement.
4447 */
4448int rearrange_squash(void)
4449{
4450        const char *todo_file = rebase_path_todo();
4451        struct todo_list todo_list = TODO_LIST_INIT;
4452        struct hashmap subject2item;
4453        int res = 0, rearranged = 0, *next, *tail, i;
4454        char **subjects;
4455
4456        if (strbuf_read_file_or_whine(&todo_list.buf, todo_file) < 0)
4457                return -1;
4458        if (parse_insn_buffer(todo_list.buf.buf, &todo_list) < 0) {
4459                todo_list_release(&todo_list);
4460                return -1;
4461        }
4462
4463        /*
4464         * The hashmap maps onelines to the respective todo list index.
4465         *
4466         * If any items need to be rearranged, the next[i] value will indicate
4467         * which item was moved directly after the i'th.
4468         *
4469         * In that case, last[i] will indicate the index of the latest item to
4470         * be moved to appear after the i'th.
4471         */
4472        hashmap_init(&subject2item, (hashmap_cmp_fn) subject2item_cmp,
4473                     NULL, todo_list.nr);
4474        ALLOC_ARRAY(next, todo_list.nr);
4475        ALLOC_ARRAY(tail, todo_list.nr);
4476        ALLOC_ARRAY(subjects, todo_list.nr);
4477        for (i = 0; i < todo_list.nr; i++) {
4478                struct strbuf buf = STRBUF_INIT;
4479                struct todo_item *item = todo_list.items + i;
4480                const char *commit_buffer, *subject, *p;
4481                size_t subject_len;
4482                int i2 = -1;
4483                struct subject2item_entry *entry;
4484
4485                next[i] = tail[i] = -1;
4486                if (!item->commit || item->command == TODO_DROP) {
4487                        subjects[i] = NULL;
4488                        continue;
4489                }
4490
4491                if (is_fixup(item->command)) {
4492                        todo_list_release(&todo_list);
4493                        return error(_("the script was already rearranged."));
4494                }
4495
4496                item->commit->util = item;
4497
4498                parse_commit(item->commit);
4499                commit_buffer = get_commit_buffer(item->commit, NULL);
4500                find_commit_subject(commit_buffer, &subject);
4501                format_subject(&buf, subject, " ");
4502                subject = subjects[i] = strbuf_detach(&buf, &subject_len);
4503                unuse_commit_buffer(item->commit, commit_buffer);
4504                if ((skip_prefix(subject, "fixup! ", &p) ||
4505                     skip_prefix(subject, "squash! ", &p))) {
4506                        struct commit *commit2;
4507
4508                        for (;;) {
4509                                while (isspace(*p))
4510                                        p++;
4511                                if (!skip_prefix(p, "fixup! ", &p) &&
4512                                    !skip_prefix(p, "squash! ", &p))
4513                                        break;
4514                        }
4515
4516                        if ((entry = hashmap_get_from_hash(&subject2item,
4517                                                           strhash(p), p)))
4518                                /* found by title */
4519                                i2 = entry->i;
4520                        else if (!strchr(p, ' ') &&
4521                                 (commit2 =
4522                                  lookup_commit_reference_by_name(p)) &&
4523                                 commit2->util)
4524                                /* found by commit name */
4525                                i2 = (struct todo_item *)commit2->util
4526                                        - todo_list.items;
4527                        else {
4528                                /* copy can be a prefix of the commit subject */
4529                                for (i2 = 0; i2 < i; i2++)
4530                                        if (subjects[i2] &&
4531                                            starts_with(subjects[i2], p))
4532                                                break;
4533                                if (i2 == i)
4534                                        i2 = -1;
4535                        }
4536                }
4537                if (i2 >= 0) {
4538                        rearranged = 1;
4539                        todo_list.items[i].command =
4540                                starts_with(subject, "fixup!") ?
4541                                TODO_FIXUP : TODO_SQUASH;
4542                        if (next[i2] < 0)
4543                                next[i2] = i;
4544                        else
4545                                next[tail[i2]] = i;
4546                        tail[i2] = i;
4547                } else if (!hashmap_get_from_hash(&subject2item,
4548                                                strhash(subject), subject)) {
4549                        FLEX_ALLOC_MEM(entry, subject, subject, subject_len);
4550                        entry->i = i;
4551                        hashmap_entry_init(entry, strhash(entry->subject));
4552                        hashmap_put(&subject2item, entry);
4553                }
4554        }
4555
4556        if (rearranged) {
4557                struct strbuf buf = STRBUF_INIT;
4558
4559                for (i = 0; i < todo_list.nr; i++) {
4560                        enum todo_command command = todo_list.items[i].command;
4561                        int cur = i;
4562
4563                        /*
4564                         * Initially, all commands are 'pick's. If it is a
4565                         * fixup or a squash now, we have rearranged it.
4566                         */
4567                        if (is_fixup(command))
4568                                continue;
4569
4570                        while (cur >= 0) {
4571                                const char *bol =
4572                                        get_item_line(&todo_list, cur);
4573                                const char *eol =
4574                                        get_item_line(&todo_list, cur + 1);
4575
4576                                /* replace 'pick', by 'fixup' or 'squash' */
4577                                command = todo_list.items[cur].command;
4578                                if (is_fixup(command)) {
4579                                        strbuf_addstr(&buf,
4580                                                todo_command_info[command].str);
4581                                        bol += strcspn(bol, " \t");
4582                                }
4583
4584                                strbuf_add(&buf, bol, eol - bol);
4585
4586                                cur = next[cur];
4587                        }
4588                }
4589
4590                res = rewrite_file(todo_file, buf.buf, buf.len);
4591                strbuf_release(&buf);
4592        }
4593
4594        free(next);
4595        free(tail);
4596        for (i = 0; i < todo_list.nr; i++)
4597                free(subjects[i]);
4598        free(subjects);
4599        hashmap_free(&subject2item, 1);
4600        todo_list_release(&todo_list);
4601
4602        return res;
4603}