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