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