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