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