sequencer: use run_command() directly
[git/git.git] / sequencer.c
CommitLineData
26ae337b 1#include "cache.h"
697cc8ef 2#include "lockfile.h"
26ae337b 3#include "sequencer.h"
26ae337b 4#include "dir.h"
043a4492
RR
5#include "object.h"
6#include "commit.h"
7#include "tag.h"
8#include "run-command.h"
9#include "exec_cmd.h"
10#include "utf8.h"
11#include "cache-tree.h"
12#include "diff.h"
13#include "revision.h"
14#include "rerere.h"
15#include "merge-recursive.h"
16#include "refs.h"
b27cfb0d 17#include "argv-array.h"
a1c75762 18#include "quote.h"
967dfd4d 19#include "trailer.h"
56dc3ab0 20#include "log-tree.h"
311af526 21#include "wt-status.h"
043a4492
RR
22
23#define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
26ae337b 24
5ed75e2a 25const char sign_off_header[] = "Signed-off-by: ";
cd650a4e 26static const char cherry_picked_prefix[] = "(cherry picked from commit ";
5ed75e2a 27
8a2a0f53
JS
28GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
29
30static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
31static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
32static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
1e41229d 33static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
f932729c 34
84583957
JS
35static GIT_PATH_FUNC(rebase_path, "rebase-merge")
36/*
37 * The file containing rebase commands, comments, and empty lines.
38 * This file is created by "git rebase -i" then edited by the user. As
39 * the lines are processed, they are removed from the front of this
40 * file and written to the tail of 'done'.
41 */
42static GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
1df6df0c
JS
43/*
44 * The rebase command lines that have already been processed. A line
45 * is moved here when it is first handled, before any associated user
46 * actions.
47 */
48static GIT_PATH_FUNC(rebase_path_done, "rebase-merge/done")
6e98de72
JS
49/*
50 * The commit message that is planned to be used for any changes that
51 * need to be committed following a user interaction.
52 */
53static GIT_PATH_FUNC(rebase_path_message, "rebase-merge/message")
54/*
55 * The file into which is accumulated the suggested commit message for
56 * squash/fixup commands. When the first of a series of squash/fixups
57 * is seen, the file is created and the commit message from the
58 * previous commit and from the first squash/fixup commit are written
59 * to it. The commit message for each subsequent squash/fixup commit
60 * is appended to the file as it is processed.
61 *
62 * The first line of the file is of the form
63 * # This is a combination of $count commits.
64 * where $count is the number of commits whose messages have been
65 * written to the file so far (including the initial "pick" commit).
66 * Each time that a commit message is processed, this line is read and
67 * updated. It is deleted just before the combined commit is made.
68 */
69static GIT_PATH_FUNC(rebase_path_squash_msg, "rebase-merge/message-squash")
70/*
71 * If the current series of squash/fixups has not yet included a squash
72 * command, then this file exists and holds the commit message of the
73 * original "pick" commit. (If the series ends without a "squash"
74 * command, then this can be used as the commit message of the combined
75 * commit without opening the editor.)
76 */
77static GIT_PATH_FUNC(rebase_path_fixup_msg, "rebase-merge/message-fixup")
b5a67045
JS
78/*
79 * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
80 * GIT_AUTHOR_DATE that will be used for the commit that is currently
81 * being rebased.
82 */
83static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
56dc3ab0
JS
84/*
85 * When an "edit" rebase command is being processed, the SHA1 of the
86 * commit to be edited is recorded in this file. When "git rebase
87 * --continue" is executed, if there are any staged changes then they
88 * will be amended to the HEAD commit, but only provided the HEAD
89 * commit is still the commit to be edited. When any other rebase
90 * command is processed, this file is deleted.
91 */
92static GIT_PATH_FUNC(rebase_path_amend, "rebase-merge/amend")
93/*
94 * When we stop at a given patch via the "edit" command, this file contains
95 * the abbreviated commit name of the corresponding patch.
96 */
97static GIT_PATH_FUNC(rebase_path_stopped_sha, "rebase-merge/stopped-sha")
25cb8df9
JS
98/*
99 * For the post-rewrite hook, we make a list of rewritten commits and
100 * their new sha1s. The rewritten-pending list keeps the sha1s of
101 * commits that have been processed, but not committed yet,
102 * e.g. because they are waiting for a 'squash' command.
103 */
104static GIT_PATH_FUNC(rebase_path_rewritten_list, "rebase-merge/rewritten-list")
105static GIT_PATH_FUNC(rebase_path_rewritten_pending,
106 "rebase-merge/rewritten-pending")
a1c75762
JS
107/*
108 * The following files are written by git-rebase just after parsing the
109 * command-line (and are only consumed, not modified, by the sequencer).
110 */
111static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
556907f1
JS
112static GIT_PATH_FUNC(rebase_path_orig_head, "rebase-merge/orig-head")
113static GIT_PATH_FUNC(rebase_path_verbose, "rebase-merge/verbose")
4b83ce9f
JS
114static GIT_PATH_FUNC(rebase_path_head_name, "rebase-merge/head-name")
115static GIT_PATH_FUNC(rebase_path_onto, "rebase-merge/onto")
796c7972 116static GIT_PATH_FUNC(rebase_path_autostash, "rebase-merge/autostash")
ca6c6b45
JS
117static GIT_PATH_FUNC(rebase_path_strategy, "rebase-merge/strategy")
118static GIT_PATH_FUNC(rebase_path_strategy_opts, "rebase-merge/strategy_opts")
b5a67045 119
b5a67045
JS
120static inline int is_rebase_i(const struct replay_opts *opts)
121{
84583957 122 return opts->action == REPLAY_INTERACTIVE_REBASE;
b5a67045
JS
123}
124
285abf56
JS
125static const char *get_dir(const struct replay_opts *opts)
126{
84583957
JS
127 if (is_rebase_i(opts))
128 return rebase_path();
285abf56
JS
129 return git_path_seq_dir();
130}
131
c0246501
JS
132static const char *get_todo_path(const struct replay_opts *opts)
133{
84583957
JS
134 if (is_rebase_i(opts))
135 return rebase_path_todo();
c0246501
JS
136 return git_path_todo_file();
137}
138
bab4d109
BC
139/*
140 * Returns 0 for non-conforming footer
141 * Returns 1 for conforming footer
142 * Returns 2 when sob exists within conforming footer
143 * Returns 3 when sob exists within conforming footer as last entry
144 */
145static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
146 int ignore_footer)
b971e04f 147{
967dfd4d
JT
148 struct trailer_info info;
149 int i;
150 int found_sob = 0, found_sob_last = 0;
b971e04f 151
967dfd4d 152 trailer_info_get(&info, sb->buf);
b971e04f 153
967dfd4d 154 if (info.trailer_start == info.trailer_end)
b971e04f
BC
155 return 0;
156
967dfd4d
JT
157 for (i = 0; i < info.trailer_nr; i++)
158 if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
159 found_sob = 1;
160 if (i == info.trailer_nr - 1)
161 found_sob_last = 1;
162 }
b971e04f 163
967dfd4d 164 trailer_info_release(&info);
bab4d109 165
967dfd4d 166 if (found_sob_last)
bab4d109
BC
167 return 3;
168 if (found_sob)
169 return 2;
b971e04f
BC
170 return 1;
171}
5ed75e2a 172
a1c75762
JS
173static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
174{
175 static struct strbuf buf = STRBUF_INIT;
176
177 strbuf_reset(&buf);
178 if (opts->gpg_sign)
179 sq_quotef(&buf, "-S%s", opts->gpg_sign);
180 return buf.buf;
181}
182
2863584f 183int sequencer_remove_state(struct replay_opts *opts)
26ae337b 184{
285abf56 185 struct strbuf dir = STRBUF_INIT;
03a4e260
JS
186 int i;
187
188 free(opts->gpg_sign);
189 free(opts->strategy);
190 for (i = 0; i < opts->xopts_nr; i++)
191 free(opts->xopts[i]);
192 free(opts->xopts);
26ae337b 193
285abf56
JS
194 strbuf_addf(&dir, "%s", get_dir(opts));
195 remove_dir_recursively(&dir, 0);
196 strbuf_release(&dir);
2863584f
JS
197
198 return 0;
26ae337b 199}
043a4492
RR
200
201static const char *action_name(const struct replay_opts *opts)
202{
84583957
JS
203 switch (opts->action) {
204 case REPLAY_REVERT:
205 return N_("revert");
206 case REPLAY_PICK:
207 return N_("cherry-pick");
208 case REPLAY_INTERACTIVE_REBASE:
209 return N_("rebase -i");
210 }
211 die(_("Unknown action: %d"), opts->action);
043a4492
RR
212}
213
043a4492
RR
214struct commit_message {
215 char *parent_label;
7b35eaf8
JK
216 char *label;
217 char *subject;
043a4492
RR
218 const char *message;
219};
220
39755964
JS
221static const char *short_commit_name(struct commit *commit)
222{
223 return find_unique_abbrev(commit->object.oid.hash, DEFAULT_ABBREV);
224}
225
043a4492
RR
226static int get_message(struct commit *commit, struct commit_message *out)
227{
043a4492 228 const char *abbrev, *subject;
7b35eaf8 229 int subject_len;
043a4492 230
7b35eaf8 231 out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
39755964 232 abbrev = short_commit_name(commit);
043a4492
RR
233
234 subject_len = find_commit_subject(out->message, &subject);
235
7b35eaf8
JK
236 out->subject = xmemdupz(subject, subject_len);
237 out->label = xstrfmt("%s... %s", abbrev, out->subject);
238 out->parent_label = xstrfmt("parent of %s", out->label);
239
043a4492
RR
240 return 0;
241}
242
d74a4e57 243static void free_message(struct commit *commit, struct commit_message *msg)
043a4492
RR
244{
245 free(msg->parent_label);
7b35eaf8
JK
246 free(msg->label);
247 free(msg->subject);
b66103c3 248 unuse_commit_buffer(commit, msg->message);
043a4492
RR
249}
250
ed727b19 251static void print_advice(int show_hint, struct replay_opts *opts)
043a4492
RR
252{
253 char *msg = getenv("GIT_CHERRY_PICK_HELP");
254
255 if (msg) {
256 fprintf(stderr, "%s\n", msg);
257 /*
41ccfdd9 258 * A conflict has occurred but the porcelain
043a4492
RR
259 * (typically rebase --interactive) wants to take care
260 * of the commit itself so remove CHERRY_PICK_HEAD
261 */
f932729c 262 unlink(git_path_cherry_pick_head());
043a4492
RR
263 return;
264 }
265
ed727b19
PH
266 if (show_hint) {
267 if (opts->no_commit)
268 advise(_("after resolving the conflicts, mark the corrected paths\n"
269 "with 'git add <paths>' or 'git rm <paths>'"));
270 else
271 advise(_("after resolving the conflicts, mark the corrected paths\n"
272 "with 'git add <paths>' or 'git rm <paths>'\n"
273 "and commit the result with 'git commit'"));
274 }
043a4492
RR
275}
276
f56fffef
JS
277static int write_message(const void *buf, size_t len, const char *filename,
278 int append_eol)
043a4492
RR
279{
280 static struct lock_file msg_file;
281
4ef3d8f0
JS
282 int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
283 if (msg_fd < 0)
93b3df6f 284 return error_errno(_("could not lock '%s'"), filename);
75871495 285 if (write_in_full(msg_fd, buf, len) < 0) {
4f66c837 286 rollback_lock_file(&msg_file);
93b3df6f 287 return error_errno(_("could not write to '%s'"), filename);
4f66c837 288 }
f56fffef
JS
289 if (append_eol && write(msg_fd, "\n", 1) < 0) {
290 rollback_lock_file(&msg_file);
35871806 291 return error_errno(_("could not write eol to '%s'"), filename);
f56fffef 292 }
4f66c837
JS
293 if (commit_lock_file(&msg_file) < 0) {
294 rollback_lock_file(&msg_file);
93b3df6f 295 return error(_("failed to finalize '%s'."), filename);
4f66c837 296 }
4ef3d8f0
JS
297
298 return 0;
043a4492
RR
299}
300
1dfc84e9
JS
301/*
302 * Reads a file that was presumably written by a shell script, i.e. with an
303 * end-of-line marker that needs to be stripped.
304 *
305 * Note that only the last end-of-line marker is stripped, consistent with the
306 * behavior of "$(cat path)" in a shell script.
307 *
308 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
309 */
310static int read_oneliner(struct strbuf *buf,
311 const char *path, int skip_if_empty)
312{
313 int orig_len = buf->len;
314
315 if (!file_exists(path))
316 return 0;
317
318 if (strbuf_read_file(buf, path, 0) < 0) {
319 warning_errno(_("could not read '%s'"), path);
320 return 0;
321 }
322
323 if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
324 if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
325 --buf->len;
326 buf->buf[buf->len] = '\0';
327 }
328
329 if (skip_if_empty && buf->len == orig_len)
330 return 0;
331
332 return 1;
333}
334
043a4492
RR
335static struct tree *empty_tree(void)
336{
cba595bd 337 return lookup_tree(EMPTY_TREE_SHA1_BIN);
043a4492
RR
338}
339
340static int error_dirty_index(struct replay_opts *opts)
341{
342 if (read_cache_unmerged())
c28cbc5e 343 return error_resolve_conflict(_(action_name(opts)));
043a4492 344
93b3df6f 345 error(_("your local changes would be overwritten by %s."),
c28cbc5e 346 _(action_name(opts)));
043a4492
RR
347
348 if (advice_commit_before_merge)
93b3df6f 349 advise(_("commit your changes or stash them to proceed."));
043a4492
RR
350 return -1;
351}
352
1e41229d
SB
353static void update_abort_safety_file(void)
354{
355 struct object_id head;
356
357 /* Do nothing on a single-pick */
358 if (!file_exists(git_path_seq_dir()))
359 return;
360
361 if (!get_oid("HEAD", &head))
362 write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
363 else
364 write_file(git_path_abort_safety_file(), "%s", "");
365}
366
334ae397 367static int fast_forward_to(const unsigned char *to, const unsigned char *from,
eb4be1cb 368 int unborn, struct replay_opts *opts)
043a4492 369{
d668d16c 370 struct ref_transaction *transaction;
eb4be1cb 371 struct strbuf sb = STRBUF_INIT;
d668d16c 372 struct strbuf err = STRBUF_INIT;
043a4492
RR
373
374 read_cache();
db699a8a 375 if (checkout_fast_forward(from, to, 1))
0e408fc3 376 return -1; /* the callee should have complained already */
651ab9f5 377
c28cbc5e 378 strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
d668d16c
RS
379
380 transaction = ref_transaction_begin(&err);
381 if (!transaction ||
382 ref_transaction_update(transaction, "HEAD",
383 to, unborn ? null_sha1 : from,
1d147bdf 384 0, sb.buf, &err) ||
db7516ab 385 ref_transaction_commit(transaction, &err)) {
d668d16c
RS
386 ref_transaction_free(transaction);
387 error("%s", err.buf);
388 strbuf_release(&sb);
389 strbuf_release(&err);
390 return -1;
391 }
651ab9f5 392
eb4be1cb 393 strbuf_release(&sb);
d668d16c
RS
394 strbuf_release(&err);
395 ref_transaction_free(transaction);
1e41229d 396 update_abort_safety_file();
d668d16c 397 return 0;
043a4492
RR
398}
399
75c961b7
JH
400void append_conflicts_hint(struct strbuf *msgbuf)
401{
402 int i;
403
261f315b
JH
404 strbuf_addch(msgbuf, '\n');
405 strbuf_commented_addf(msgbuf, "Conflicts:\n");
75c961b7
JH
406 for (i = 0; i < active_nr;) {
407 const struct cache_entry *ce = active_cache[i++];
408 if (ce_stage(ce)) {
261f315b 409 strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
75c961b7
JH
410 while (i < active_nr && !strcmp(ce->name,
411 active_cache[i]->name))
412 i++;
413 }
414 }
415}
416
043a4492
RR
417static int do_recursive_merge(struct commit *base, struct commit *next,
418 const char *base_label, const char *next_label,
419 unsigned char *head, struct strbuf *msgbuf,
420 struct replay_opts *opts)
421{
422 struct merge_options o;
423 struct tree *result, *next_tree, *base_tree, *head_tree;
03b86647 424 int clean;
03a4e260 425 char **xopt;
043a4492
RR
426 static struct lock_file index_lock;
427
b3e83cc7 428 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
043a4492
RR
429
430 read_cache();
431
432 init_merge_options(&o);
433 o.ancestor = base ? base_label : "(empty tree)";
434 o.branch1 = "HEAD";
435 o.branch2 = next ? next_label : "(empty tree)";
436
437 head_tree = parse_tree_indirect(head);
438 next_tree = next ? next->tree : empty_tree();
439 base_tree = base ? base->tree : empty_tree();
440
441 for (xopt = opts->xopts; xopt != opts->xopts + opts->xopts_nr; xopt++)
442 parse_merge_opt(&o, *xopt);
443
444 clean = merge_trees(&o,
445 head_tree,
446 next_tree, base_tree, &result);
548009c0 447 strbuf_release(&o.obuf);
f241ff0d
JS
448 if (clean < 0)
449 return clean;
043a4492
RR
450
451 if (active_cache_changed &&
03b86647 452 write_locked_index(&the_index, &index_lock, COMMIT_LOCK))
84583957
JS
453 /* TRANSLATORS: %s will be "revert", "cherry-pick" or
454 * "rebase -i".
455 */
c527b55e 456 return error(_("%s: Unable to write new index file"),
c28cbc5e 457 _(action_name(opts)));
043a4492
RR
458 rollback_lock_file(&index_lock);
459
5ed75e2a 460 if (opts->signoff)
bab4d109 461 append_signoff(msgbuf, 0, 0);
5ed75e2a 462
75c961b7
JH
463 if (!clean)
464 append_conflicts_hint(msgbuf);
043a4492
RR
465
466 return !clean;
467}
468
b27cfb0d
NH
469static int is_index_unchanged(void)
470{
471 unsigned char head_sha1[20];
472 struct commit *head_commit;
473
7695d118 474 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, head_sha1, NULL))
93b3df6f 475 return error(_("could not resolve HEAD commit\n"));
b27cfb0d
NH
476
477 head_commit = lookup_commit(head_sha1);
4b580061
NH
478
479 /*
480 * If head_commit is NULL, check_commit, called from
481 * lookup_commit, would have indicated that head_commit is not
482 * a commit object already. parse_commit() will return failure
483 * without further complaints in such a case. Otherwise, if
484 * the commit is invalid, parse_commit() will complain. So
485 * there is nothing for us to say here. Just return failure.
486 */
487 if (parse_commit(head_commit))
488 return -1;
b27cfb0d
NH
489
490 if (!active_cache_tree)
491 active_cache_tree = cache_tree();
492
493 if (!cache_tree_fully_valid(active_cache_tree))
d0cfc3e8 494 if (cache_tree_update(&the_index, 0))
93b3df6f 495 return error(_("unable to update cache tree\n"));
b27cfb0d 496
ed1c9977 497 return !hashcmp(active_cache_tree->sha1, head_commit->tree->object.oid.hash);
b27cfb0d
NH
498}
499
0473f28a
JS
500static int write_author_script(const char *message)
501{
502 struct strbuf buf = STRBUF_INIT;
503 const char *eol;
504 int res;
505
506 for (;;)
507 if (!*message || starts_with(message, "\n")) {
508missing_author:
509 /* Missing 'author' line? */
510 unlink(rebase_path_author_script());
511 return 0;
512 } else if (skip_prefix(message, "author ", &message))
513 break;
514 else if ((eol = strchr(message, '\n')))
515 message = eol + 1;
516 else
517 goto missing_author;
518
519 strbuf_addstr(&buf, "GIT_AUTHOR_NAME='");
520 while (*message && *message != '\n' && *message != '\r')
521 if (skip_prefix(message, " <", &message))
522 break;
523 else if (*message != '\'')
524 strbuf_addch(&buf, *(message++));
525 else
526 strbuf_addf(&buf, "'\\\\%c'", *(message++));
527 strbuf_addstr(&buf, "'\nGIT_AUTHOR_EMAIL='");
528 while (*message && *message != '\n' && *message != '\r')
529 if (skip_prefix(message, "> ", &message))
530 break;
531 else if (*message != '\'')
532 strbuf_addch(&buf, *(message++));
533 else
534 strbuf_addf(&buf, "'\\\\%c'", *(message++));
535 strbuf_addstr(&buf, "'\nGIT_AUTHOR_DATE='@");
536 while (*message && *message != '\n' && *message != '\r')
537 if (*message != '\'')
538 strbuf_addch(&buf, *(message++));
539 else
540 strbuf_addf(&buf, "'\\\\%c'", *(message++));
541 res = write_message(buf.buf, buf.len, rebase_path_author_script(), 1);
542 strbuf_release(&buf);
543 return res;
544}
545
b5a67045 546/*
a2a20b0d
JS
547 * Read a list of environment variable assignments (such as the author-script
548 * file) into an environment block. Returns -1 on error, 0 otherwise.
b5a67045 549 */
a2a20b0d 550static int read_env_script(struct argv_array *env)
b5a67045
JS
551{
552 struct strbuf script = STRBUF_INIT;
553 int i, count = 0;
a2a20b0d 554 char *p, *p2;
b5a67045
JS
555
556 if (strbuf_read_file(&script, rebase_path_author_script(), 256) <= 0)
a2a20b0d 557 return -1;
b5a67045
JS
558
559 for (p = script.buf; *p; p++)
560 if (skip_prefix(p, "'\\\\''", (const char **)&p2))
561 strbuf_splice(&script, p - script.buf, p2 - p, "'", 1);
562 else if (*p == '\'')
563 strbuf_splice(&script, p-- - script.buf, 1, "", 0);
564 else if (*p == '\n') {
565 *p = '\0';
566 count++;
567 }
568
a2a20b0d
JS
569 for (i = 0, p = script.buf; i < count; i++) {
570 argv_array_push(env, p);
b5a67045
JS
571 p += strlen(p) + 1;
572 }
b5a67045 573
a2a20b0d 574 return 0;
b5a67045
JS
575}
576
791eb870
JS
577static const char staged_changes_advice[] =
578N_("you have staged changes in your working tree\n"
579"If these changes are meant to be squashed into the previous commit, run:\n"
580"\n"
581" git commit --amend %s\n"
582"\n"
583"If they are meant to go into a new commit, run:\n"
584"\n"
585" git commit %s\n"
586"\n"
587"In both cases, once you're done, continue with:\n"
588"\n"
589" git rebase --continue\n");
590
043a4492
RR
591/*
592 * If we are cherry-pick, and if the merge did not result in
593 * hand-editing, we will hit this commit and inherit the original
594 * author date and name.
b5a67045 595 *
043a4492
RR
596 * If we are revert, or if our cherry-pick results in a hand merge,
597 * we had better say that the current user is responsible for that.
b5a67045
JS
598 *
599 * An exception is when run_git_commit() is called during an
600 * interactive rebase: in that case, we will want to retain the
601 * author metadata.
043a4492 602 */
ac2b0e8f 603static int run_git_commit(const char *defmsg, struct replay_opts *opts,
0009426d
JS
604 int allow_empty, int edit, int amend,
605 int cleanup_commit_message)
043a4492 606{
07d968ef 607 struct child_process cmd = CHILD_PROCESS_INIT;
17d65f03 608 const char *value;
b27cfb0d 609
07d968ef
JS
610 cmd.git_cmd = 1;
611
b5a67045 612 if (is_rebase_i(opts)) {
07d968ef 613 if (read_env_script(&cmd.env_array)) {
a1c75762
JS
614 const char *gpg_opt = gpg_sign_opt_quoted(opts);
615
791eb870
JS
616 return error(_(staged_changes_advice),
617 gpg_opt, gpg_opt);
a1c75762 618 }
b5a67045
JS
619 }
620
07d968ef
JS
621 argv_array_push(&cmd.args, "commit");
622 argv_array_push(&cmd.args, "-n");
043a4492 623
9240beda 624 if (amend)
07d968ef 625 argv_array_push(&cmd.args, "--amend");
3bdd5522 626 if (opts->gpg_sign)
07d968ef 627 argv_array_pushf(&cmd.args, "-S%s", opts->gpg_sign);
043a4492 628 if (opts->signoff)
07d968ef 629 argv_array_push(&cmd.args, "-s");
b5a67045 630 if (defmsg)
07d968ef 631 argv_array_pushl(&cmd.args, "-F", defmsg, NULL);
0009426d 632 if (cleanup_commit_message)
07d968ef 633 argv_array_push(&cmd.args, "--cleanup=strip");
a1c75762 634 if (edit)
07d968ef 635 argv_array_push(&cmd.args, "-e");
0009426d
JS
636 else if (!cleanup_commit_message &&
637 !opts->signoff && !opts->record_origin &&
b5a67045 638 git_config_get_value("commit.cleanup", &value))
07d968ef 639 argv_array_push(&cmd.args, "--cleanup=verbatim");
b27cfb0d 640
ac2b0e8f 641 if (allow_empty)
07d968ef 642 argv_array_push(&cmd.args, "--allow-empty");
df478b74 643
4bee9584 644 if (opts->allow_empty_message)
07d968ef 645 argv_array_push(&cmd.args, "--allow-empty-message");
4bee9584 646
b5a67045 647
07d968ef 648 return run_command(&cmd);
b27cfb0d
NH
649}
650
651static int is_original_commit_empty(struct commit *commit)
652{
653 const unsigned char *ptree_sha1;
654
655 if (parse_commit(commit))
93b3df6f 656 return error(_("could not parse commit %s\n"),
f2fd0760 657 oid_to_hex(&commit->object.oid));
b27cfb0d
NH
658 if (commit->parents) {
659 struct commit *parent = commit->parents->item;
660 if (parse_commit(parent))
93b3df6f 661 return error(_("could not parse parent commit %s\n"),
f2fd0760 662 oid_to_hex(&parent->object.oid));
ed1c9977 663 ptree_sha1 = parent->tree->object.oid.hash;
b27cfb0d
NH
664 } else {
665 ptree_sha1 = EMPTY_TREE_SHA1_BIN; /* commit is root */
043a4492 666 }
043a4492 667
ed1c9977 668 return !hashcmp(ptree_sha1, commit->tree->object.oid.hash);
043a4492
RR
669}
670
ac2b0e8f
JH
671/*
672 * Do we run "git commit" with "--allow-empty"?
673 */
674static int allow_empty(struct replay_opts *opts, struct commit *commit)
675{
676 int index_unchanged, empty_commit;
677
678 /*
679 * Three cases:
680 *
681 * (1) we do not allow empty at all and error out.
682 *
683 * (2) we allow ones that were initially empty, but
684 * forbid the ones that become empty;
685 *
686 * (3) we allow both.
687 */
688 if (!opts->allow_empty)
689 return 0; /* let "git commit" barf as necessary */
690
691 index_unchanged = is_index_unchanged();
692 if (index_unchanged < 0)
693 return index_unchanged;
694 if (!index_unchanged)
695 return 0; /* we do not have to say --allow-empty */
696
697 if (opts->keep_redundant_commits)
698 return 1;
699
700 empty_commit = is_original_commit_empty(commit);
701 if (empty_commit < 0)
702 return empty_commit;
703 if (!empty_commit)
704 return 0;
705 else
706 return 1;
707}
708
25c43667
JS
709/*
710 * Note that ordering matters in this enum. Not only must it match the mapping
711 * below, it is also divided into several sections that matter. When adding
712 * new commands, make sure you add it in the right section.
713 */
004fefa7 714enum todo_command {
25c43667 715 /* commands that handle commits */
004fefa7 716 TODO_PICK = 0,
25c43667 717 TODO_REVERT,
56dc3ab0 718 TODO_EDIT,
04efc8b5 719 TODO_REWORD,
6e98de72
JS
720 TODO_FIXUP,
721 TODO_SQUASH,
311af526
JS
722 /* commands that do something else than handling a single commit */
723 TODO_EXEC,
25c43667 724 /* commands that do nothing but are counted for reporting progress */
b3fdd581 725 TODO_NOOP,
ac191470
JS
726 TODO_DROP,
727 /* comments (not counted for reporting progress) */
728 TODO_COMMENT
004fefa7
JS
729};
730
414697a9
JS
731static struct {
732 char c;
733 const char *str;
734} todo_command_info[] = {
735 { 'p', "pick" },
736 { 0, "revert" },
737 { 'e', "edit" },
04efc8b5 738 { 'r', "reword" },
414697a9
JS
739 { 'f', "fixup" },
740 { 's', "squash" },
741 { 'x', "exec" },
b3fdd581 742 { 0, "noop" },
ac191470
JS
743 { 'd', "drop" },
744 { 0, NULL }
004fefa7
JS
745};
746
747static const char *command_to_string(const enum todo_command command)
748{
ac191470 749 if (command < TODO_COMMENT)
414697a9 750 return todo_command_info[command].str;
004fefa7
JS
751 die("Unknown command: %d", command);
752}
753
25c43667
JS
754static int is_noop(const enum todo_command command)
755{
b3fdd581 756 return TODO_NOOP <= command;
25c43667 757}
004fefa7 758
6e98de72
JS
759static int is_fixup(enum todo_command command)
760{
761 return command == TODO_FIXUP || command == TODO_SQUASH;
762}
763
764static int update_squash_messages(enum todo_command command,
765 struct commit *commit, struct replay_opts *opts)
766{
767 struct strbuf buf = STRBUF_INIT;
768 int count, res;
769 const char *message, *body;
770
771 if (file_exists(rebase_path_squash_msg())) {
772 struct strbuf header = STRBUF_INIT;
773 char *eol, *p;
774
775 if (strbuf_read_file(&buf, rebase_path_squash_msg(), 2048) <= 0)
776 return error(_("could not read '%s'"),
777 rebase_path_squash_msg());
778
779 p = buf.buf + 1;
780 eol = strchrnul(buf.buf, '\n');
781 if (buf.buf[0] != comment_line_char ||
782 (p += strcspn(p, "0123456789\n")) == eol)
783 return error(_("unexpected 1st line of squash message:"
784 "\n\n\t%.*s"),
785 (int)(eol - buf.buf), buf.buf);
786 count = strtol(p, NULL, 10);
787
788 if (count < 1)
789 return error(_("invalid 1st line of squash message:\n"
790 "\n\t%.*s"),
791 (int)(eol - buf.buf), buf.buf);
792
793 strbuf_addf(&header, "%c ", comment_line_char);
794 strbuf_addf(&header,
795 _("This is a combination of %d commits."), ++count);
796 strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
797 strbuf_release(&header);
798 } else {
799 unsigned char head[20];
800 struct commit *head_commit;
801 const char *head_message, *body;
802
803 if (get_sha1("HEAD", head))
804 return error(_("need a HEAD to fixup"));
805 if (!(head_commit = lookup_commit_reference(head)))
806 return error(_("could not read HEAD"));
807 if (!(head_message = get_commit_buffer(head_commit, NULL)))
808 return error(_("could not read HEAD's commit message"));
809
810 find_commit_subject(head_message, &body);
811 if (write_message(body, strlen(body),
812 rebase_path_fixup_msg(), 0)) {
813 unuse_commit_buffer(head_commit, head_message);
814 return error(_("cannot write '%s'"),
815 rebase_path_fixup_msg());
816 }
817
818 count = 2;
819 strbuf_addf(&buf, "%c ", comment_line_char);
820 strbuf_addf(&buf, _("This is a combination of %d commits."),
821 count);
822 strbuf_addf(&buf, "\n%c ", comment_line_char);
823 strbuf_addstr(&buf, _("This is the 1st commit message:"));
824 strbuf_addstr(&buf, "\n\n");
825 strbuf_addstr(&buf, body);
826
827 unuse_commit_buffer(head_commit, head_message);
828 }
829
830 if (!(message = get_commit_buffer(commit, NULL)))
831 return error(_("could not read commit message of %s"),
832 oid_to_hex(&commit->object.oid));
833 find_commit_subject(message, &body);
834
835 if (command == TODO_SQUASH) {
836 unlink(rebase_path_fixup_msg());
837 strbuf_addf(&buf, "\n%c ", comment_line_char);
838 strbuf_addf(&buf, _("This is the commit message #%d:"), count);
839 strbuf_addstr(&buf, "\n\n");
840 strbuf_addstr(&buf, body);
841 } else if (command == TODO_FIXUP) {
842 strbuf_addf(&buf, "\n%c ", comment_line_char);
843 strbuf_addf(&buf, _("The commit message #%d will be skipped:"),
844 count);
845 strbuf_addstr(&buf, "\n\n");
846 strbuf_add_commented_lines(&buf, body, strlen(body));
847 } else
848 return error(_("unknown command: %d"), command);
849 unuse_commit_buffer(commit, message);
850
851 res = write_message(buf.buf, buf.len, rebase_path_squash_msg(), 0);
852 strbuf_release(&buf);
853 return res;
854}
855
25cb8df9
JS
856static void flush_rewritten_pending(void) {
857 struct strbuf buf = STRBUF_INIT;
858 unsigned char newsha1[20];
859 FILE *out;
860
861 if (strbuf_read_file(&buf, rebase_path_rewritten_pending(), 82) > 0 &&
862 !get_sha1("HEAD", newsha1) &&
863 (out = fopen(rebase_path_rewritten_list(), "a"))) {
864 char *bol = buf.buf, *eol;
865
866 while (*bol) {
867 eol = strchrnul(bol, '\n');
868 fprintf(out, "%.*s %s\n", (int)(eol - bol),
869 bol, sha1_to_hex(newsha1));
870 if (!*eol)
871 break;
872 bol = eol + 1;
873 }
874 fclose(out);
875 unlink(rebase_path_rewritten_pending());
876 }
877 strbuf_release(&buf);
878}
879
880static void record_in_rewritten(struct object_id *oid,
881 enum todo_command next_command) {
882 FILE *out = fopen(rebase_path_rewritten_pending(), "a");
883
884 if (!out)
885 return;
886
887 fprintf(out, "%s\n", oid_to_hex(oid));
888 fclose(out);
889
890 if (!is_fixup(next_command))
891 flush_rewritten_pending();
892}
893
004fefa7 894static int do_pick_commit(enum todo_command command, struct commit *commit,
6e98de72 895 struct replay_opts *opts, int final_fixup)
043a4492 896{
6e98de72
JS
897 int edit = opts->edit, cleanup_commit_message = 0;
898 const char *msg_file = edit ? NULL : git_path_merge_msg();
043a4492
RR
899 unsigned char head[20];
900 struct commit *base, *next, *parent;
901 const char *base_label, *next_label;
d74a4e57 902 struct commit_message msg = { NULL, NULL, NULL, NULL };
043a4492 903 struct strbuf msgbuf = STRBUF_INIT;
bcbb68be 904 int res, unborn = 0, amend = 0, allow = 0;
043a4492
RR
905
906 if (opts->no_commit) {
907 /*
908 * We do not intend to commit immediately. We just want to
909 * merge the differences in, so let's compute the tree
910 * that represents the "current" state for merge-recursive
911 * to work on.
912 */
913 if (write_cache_as_tree(head, 0, NULL))
93b3df6f 914 return error(_("your index file is unmerged."));
043a4492 915 } else {
334ae397
MZ
916 unborn = get_sha1("HEAD", head);
917 if (unborn)
918 hashcpy(head, EMPTY_TREE_SHA1_BIN);
018ec3c8 919 if (index_differs_from(unborn ? EMPTY_TREE_SHA1_HEX : "HEAD", 0, 0))
043a4492
RR
920 return error_dirty_index(opts);
921 }
922 discard_cache();
923
637666c8 924 if (!commit->parents)
043a4492 925 parent = NULL;
043a4492
RR
926 else if (commit->parents->next) {
927 /* Reverting or cherry-picking a merge commit */
928 int cnt;
929 struct commit_list *p;
930
931 if (!opts->mainline)
93b3df6f 932 return error(_("commit %s is a merge but no -m option was given."),
f2fd0760 933 oid_to_hex(&commit->object.oid));
043a4492
RR
934
935 for (cnt = 1, p = commit->parents;
936 cnt != opts->mainline && p;
937 cnt++)
938 p = p->next;
939 if (cnt != opts->mainline || !p)
93b3df6f 940 return error(_("commit %s does not have parent %d"),
f2fd0760 941 oid_to_hex(&commit->object.oid), opts->mainline);
043a4492
RR
942 parent = p->item;
943 } else if (0 < opts->mainline)
93b3df6f 944 return error(_("mainline was specified but commit %s is not a merge."),
f2fd0760 945 oid_to_hex(&commit->object.oid));
043a4492
RR
946 else
947 parent = commit->parents->item;
948
bcbb68be
JS
949 if (get_message(commit, &msg) != 0)
950 return error(_("cannot get commit message for %s"),
951 oid_to_hex(&commit->object.oid));
952
6e98de72 953 if (opts->allow_ff && !is_fixup(command) &&
ed1c9977 954 ((parent && !hashcmp(parent->object.oid.hash, head)) ||
bcbb68be
JS
955 (!parent && unborn))) {
956 if (is_rebase_i(opts))
957 write_author_script(msg.message);
958 res = fast_forward_to(commit->object.oid.hash, head, unborn,
959 opts);
960 if (res || command != TODO_REWORD)
961 goto leave;
962 edit = amend = 1;
963 msg_file = NULL;
964 goto fast_forward_edit;
965 }
043a4492 966 if (parent && parse_commit(parent) < 0)
004fefa7
JS
967 /* TRANSLATORS: The first %s will be a "todo" command like
968 "revert" or "pick", the second %s a SHA1. */
043a4492 969 return error(_("%s: cannot parse parent commit %s"),
004fefa7
JS
970 command_to_string(command),
971 oid_to_hex(&parent->object.oid));
043a4492 972
043a4492
RR
973 /*
974 * "commit" is an existing commit. We would want to apply
975 * the difference it introduces since its first parent "prev"
976 * on top of the current HEAD if we are cherry-pick. Or the
977 * reverse of it if we are revert.
978 */
979
004fefa7 980 if (command == TODO_REVERT) {
043a4492
RR
981 base = commit;
982 base_label = msg.label;
983 next = parent;
984 next_label = msg.parent_label;
985 strbuf_addstr(&msgbuf, "Revert \"");
986 strbuf_addstr(&msgbuf, msg.subject);
987 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
f2fd0760 988 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
043a4492
RR
989
990 if (commit->parents && commit->parents->next) {
991 strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
f2fd0760 992 strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
043a4492
RR
993 }
994 strbuf_addstr(&msgbuf, ".\n");
995 } else {
996 const char *p;
997
998 base = parent;
999 base_label = msg.parent_label;
1000 next = commit;
1001 next_label = msg.label;
1002
23aa5142
JS
1003 /* Append the commit log message to msgbuf. */
1004 if (find_commit_subject(msg.message, &p))
1005 strbuf_addstr(&msgbuf, p);
043a4492
RR
1006
1007 if (opts->record_origin) {
bab4d109 1008 if (!has_conforming_footer(&msgbuf, NULL, 0))
b971e04f 1009 strbuf_addch(&msgbuf, '\n');
cd650a4e 1010 strbuf_addstr(&msgbuf, cherry_picked_prefix);
f2fd0760 1011 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
043a4492
RR
1012 strbuf_addstr(&msgbuf, ")\n");
1013 }
1014 }
1015
04efc8b5
JS
1016 if (command == TODO_REWORD)
1017 edit = 1;
1018 else if (is_fixup(command)) {
6e98de72
JS
1019 if (update_squash_messages(command, commit, opts))
1020 return -1;
1021 amend = 1;
1022 if (!final_fixup)
1023 msg_file = rebase_path_squash_msg();
1024 else if (file_exists(rebase_path_fixup_msg())) {
1025 cleanup_commit_message = 1;
1026 msg_file = rebase_path_fixup_msg();
1027 } else {
1028 const char *dest = git_path("SQUASH_MSG");
1029 unlink(dest);
1030 if (copy_file(dest, rebase_path_squash_msg(), 0666))
1031 return error(_("could not rename '%s' to '%s'"),
1032 rebase_path_squash_msg(), dest);
1033 unlink(git_path("MERGE_MSG"));
1034 msg_file = dest;
1035 edit = 1;
1036 }
1037 }
1038
0473f28a
JS
1039 if (is_rebase_i(opts) && write_author_script(msg.message) < 0)
1040 res = -1;
1041 else if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
043a4492
RR
1042 res = do_recursive_merge(base, next, base_label, next_label,
1043 head, &msgbuf, opts);
f241ff0d
JS
1044 if (res < 0)
1045 return res;
75871495 1046 res |= write_message(msgbuf.buf, msgbuf.len,
f56fffef 1047 git_path_merge_msg(), 0);
043a4492
RR
1048 } else {
1049 struct commit_list *common = NULL;
1050 struct commit_list *remotes = NULL;
1051
75871495 1052 res = write_message(msgbuf.buf, msgbuf.len,
f56fffef 1053 git_path_merge_msg(), 0);
043a4492
RR
1054
1055 commit_list_insert(base, &common);
1056 commit_list_insert(next, &remotes);
03a4e260
JS
1057 res |= try_merge_command(opts->strategy,
1058 opts->xopts_nr, (const char **)opts->xopts,
043a4492
RR
1059 common, sha1_to_hex(head), remotes);
1060 free_commit_list(common);
1061 free_commit_list(remotes);
1062 }
452202c7 1063 strbuf_release(&msgbuf);
043a4492
RR
1064
1065 /*
1066 * If the merge was clean or if it failed due to conflict, we write
1067 * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
1068 * However, if the merge did not even start, then we don't want to
1069 * write it at all.
1070 */
004fefa7 1071 if (command == TODO_PICK && !opts->no_commit && (res == 0 || res == 1) &&
dbfad033
JS
1072 update_ref(NULL, "CHERRY_PICK_HEAD", commit->object.oid.hash, NULL,
1073 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
1074 res = -1;
004fefa7 1075 if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
dbfad033
JS
1076 update_ref(NULL, "REVERT_HEAD", commit->object.oid.hash, NULL,
1077 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
1078 res = -1;
043a4492
RR
1079
1080 if (res) {
004fefa7 1081 error(command == TODO_REVERT
043a4492
RR
1082 ? _("could not revert %s... %s")
1083 : _("could not apply %s... %s"),
39755964 1084 short_commit_name(commit), msg.subject);
ed727b19 1085 print_advice(res == 1, opts);
043a4492 1086 rerere(opts->allow_rerere_auto);
c8d1351d 1087 goto leave;
043a4492
RR
1088 }
1089
c8d1351d 1090 allow = allow_empty(opts, commit);
706728a3
FC
1091 if (allow < 0) {
1092 res = allow;
1093 goto leave;
1094 }
c8d1351d 1095 if (!opts->no_commit)
bcbb68be 1096fast_forward_edit:
6e98de72
JS
1097 res = run_git_commit(msg_file, opts, allow, edit, amend,
1098 cleanup_commit_message);
1099
1100 if (!res && final_fixup) {
1101 unlink(rebase_path_fixup_msg());
1102 unlink(rebase_path_squash_msg());
1103 }
c8d1351d
FC
1104
1105leave:
d74a4e57 1106 free_message(commit, &msg);
1e41229d 1107 update_abort_safety_file();
043a4492
RR
1108
1109 return res;
1110}
1111
c3e8618c 1112static int prepare_revs(struct replay_opts *opts)
043a4492 1113{
a73e22e9
MZ
1114 /*
1115 * picking (but not reverting) ranges (but not individual revisions)
1116 * should be done in reverse
1117 */
1118 if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
043a4492
RR
1119 opts->revs->reverse ^= 1;
1120
1121 if (prepare_revision_walk(opts->revs))
c3e8618c 1122 return error(_("revision walk setup failed"));
043a4492
RR
1123
1124 if (!opts->revs->commits)
c3e8618c
JS
1125 return error(_("empty commit set passed"));
1126 return 0;
043a4492
RR
1127}
1128
0d9c6dc9 1129static int read_and_refresh_cache(struct replay_opts *opts)
043a4492
RR
1130{
1131 static struct lock_file index_lock;
1132 int index_fd = hold_locked_index(&index_lock, 0);
49fb937e
JS
1133 if (read_index_preload(&the_index, NULL) < 0) {
1134 rollback_lock_file(&index_lock);
0d9c6dc9 1135 return error(_("git %s: failed to read the index"),
c28cbc5e 1136 _(action_name(opts)));
49fb937e 1137 }
043a4492 1138 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
33c297aa 1139 if (the_index.cache_changed && index_fd >= 0) {
49fb937e
JS
1140 if (write_locked_index(&the_index, &index_lock, COMMIT_LOCK)) {
1141 rollback_lock_file(&index_lock);
0d9c6dc9 1142 return error(_("git %s: failed to refresh the index"),
c28cbc5e 1143 _(action_name(opts)));
49fb937e 1144 }
043a4492
RR
1145 }
1146 rollback_lock_file(&index_lock);
0d9c6dc9 1147 return 0;
043a4492
RR
1148}
1149
004fefa7
JS
1150struct todo_item {
1151 enum todo_command command;
1152 struct commit *commit;
c22f7dfb
JS
1153 const char *arg;
1154 int arg_len;
004fefa7
JS
1155 size_t offset_in_buf;
1156};
1157
1158struct todo_list {
1159 struct strbuf buf;
1160 struct todo_item *items;
1161 int nr, alloc, current;
1162};
1163
1164#define TODO_LIST_INIT { STRBUF_INIT }
1165
1166static void todo_list_release(struct todo_list *todo_list)
043a4492 1167{
004fefa7
JS
1168 strbuf_release(&todo_list->buf);
1169 free(todo_list->items);
1170 todo_list->items = NULL;
1171 todo_list->nr = todo_list->alloc = 0;
1172}
043a4492 1173
004fefa7
JS
1174static struct todo_item *append_new_todo(struct todo_list *todo_list)
1175{
1176 ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
1177 return todo_list->items + todo_list->nr++;
043a4492
RR
1178}
1179
004fefa7 1180static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
043a4492
RR
1181{
1182 unsigned char commit_sha1[20];
043a4492 1183 char *end_of_object_name;
004fefa7
JS
1184 int i, saved, status, padding;
1185
8f8550b3
JS
1186 /* left-trim */
1187 bol += strspn(bol, " \t");
1188
25c43667 1189 if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
ac191470 1190 item->command = TODO_COMMENT;
25c43667
JS
1191 item->commit = NULL;
1192 item->arg = bol;
1193 item->arg_len = eol - bol;
1194 return 0;
1195 }
1196
ac191470 1197 for (i = 0; i < TODO_COMMENT; i++)
414697a9
JS
1198 if (skip_prefix(bol, todo_command_info[i].str, &bol)) {
1199 item->command = i;
1200 break;
1201 } else if (bol[1] == ' ' && *bol == todo_command_info[i].c) {
1202 bol++;
004fefa7
JS
1203 item->command = i;
1204 break;
1205 }
ac191470 1206 if (i >= TODO_COMMENT)
004fefa7 1207 return -1;
043a4492 1208
25c43667
JS
1209 if (item->command == TODO_NOOP) {
1210 item->commit = NULL;
1211 item->arg = bol;
1212 item->arg_len = eol - bol;
1213 return 0;
1214 }
1215
043a4492
RR
1216 /* Eat up extra spaces/ tabs before object name */
1217 padding = strspn(bol, " \t");
1218 if (!padding)
004fefa7 1219 return -1;
043a4492
RR
1220 bol += padding;
1221
311af526
JS
1222 if (item->command == TODO_EXEC) {
1223 item->arg = bol;
1224 item->arg_len = (int)(eol - bol);
1225 return 0;
1226 }
1227
004fefa7 1228 end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
043a4492
RR
1229 saved = *end_of_object_name;
1230 *end_of_object_name = '\0';
1231 status = get_sha1(bol, commit_sha1);
1232 *end_of_object_name = saved;
1233
c22f7dfb
JS
1234 item->arg = end_of_object_name + strspn(end_of_object_name, " \t");
1235 item->arg_len = (int)(eol - item->arg);
1236
043a4492 1237 if (status < 0)
004fefa7 1238 return -1;
043a4492 1239
004fefa7
JS
1240 item->commit = lookup_commit_reference(commit_sha1);
1241 return !item->commit;
043a4492
RR
1242}
1243
004fefa7 1244static int parse_insn_buffer(char *buf, struct todo_list *todo_list)
043a4492 1245{
004fefa7
JS
1246 struct todo_item *item;
1247 char *p = buf, *next_p;
6e98de72 1248 int i, res = 0, fixup_okay = file_exists(rebase_path_done());
043a4492 1249
004fefa7 1250 for (i = 1; *p; i++, p = next_p) {
043a4492 1251 char *eol = strchrnul(p, '\n');
004fefa7
JS
1252
1253 next_p = *eol ? eol + 1 /* skip LF */ : eol;
1254
6307041d
JS
1255 if (p != eol && eol[-1] == '\r')
1256 eol--; /* strip Carriage Return */
1257
004fefa7
JS
1258 item = append_new_todo(todo_list);
1259 item->offset_in_buf = p - todo_list->buf.buf;
1260 if (parse_insn_line(item, p, eol)) {
93b3df6f 1261 res = error(_("invalid line %d: %.*s"),
004fefa7 1262 i, (int)(eol - p), p);
6e98de72 1263 item->command = TODO_NOOP;
004fefa7 1264 }
6e98de72
JS
1265
1266 if (fixup_okay)
1267 ; /* do nothing */
1268 else if (is_fixup(item->command))
1269 return error(_("cannot '%s' without a previous commit"),
1270 command_to_string(item->command));
1271 else if (!is_noop(item->command))
1272 fixup_okay = 1;
043a4492 1273 }
52865279 1274
004fefa7 1275 return res;
043a4492
RR
1276}
1277
004fefa7 1278static int read_populate_todo(struct todo_list *todo_list,
043a4492
RR
1279 struct replay_opts *opts)
1280{
c0246501 1281 const char *todo_file = get_todo_path(opts);
043a4492
RR
1282 int fd, res;
1283
004fefa7 1284 strbuf_reset(&todo_list->buf);
c0246501 1285 fd = open(todo_file, O_RDONLY);
043a4492 1286 if (fd < 0)
93b3df6f 1287 return error_errno(_("could not open '%s'"), todo_file);
004fefa7 1288 if (strbuf_read(&todo_list->buf, fd, 0) < 0) {
043a4492 1289 close(fd);
93b3df6f 1290 return error(_("could not read '%s'."), todo_file);
043a4492
RR
1291 }
1292 close(fd);
1293
004fefa7 1294 res = parse_insn_buffer(todo_list->buf.buf, todo_list);
2eeaf1b3 1295 if (res)
93b3df6f 1296 return error(_("unusable instruction sheet: '%s'"), todo_file);
2eeaf1b3 1297
52865279
JS
1298 if (!todo_list->nr &&
1299 (!is_rebase_i(opts) || !file_exists(rebase_path_done())))
1300 return error(_("no commits parsed."));
1301
2eeaf1b3 1302 if (!is_rebase_i(opts)) {
004fefa7
JS
1303 enum todo_command valid =
1304 opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
1305 int i;
1306
1307 for (i = 0; i < todo_list->nr; i++)
1308 if (valid == todo_list->items[i].command)
1309 continue;
1310 else if (valid == TODO_PICK)
93b3df6f 1311 return error(_("cannot cherry-pick during a revert."));
004fefa7 1312 else
93b3df6f 1313 return error(_("cannot revert during a cherry-pick."));
004fefa7
JS
1314 }
1315
0ae42a03 1316 return 0;
043a4492
RR
1317}
1318
03a4e260
JS
1319static int git_config_string_dup(char **dest,
1320 const char *var, const char *value)
1321{
1322 if (!value)
1323 return config_error_nonbool(var);
1324 free(*dest);
1325 *dest = xstrdup(value);
1326 return 0;
1327}
1328
043a4492
RR
1329static int populate_opts_cb(const char *key, const char *value, void *data)
1330{
1331 struct replay_opts *opts = data;
1332 int error_flag = 1;
1333
1334 if (!value)
1335 error_flag = 0;
1336 else if (!strcmp(key, "options.no-commit"))
1337 opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
1338 else if (!strcmp(key, "options.edit"))
1339 opts->edit = git_config_bool_or_int(key, value, &error_flag);
1340 else if (!strcmp(key, "options.signoff"))
1341 opts->signoff = git_config_bool_or_int(key, value, &error_flag);
1342 else if (!strcmp(key, "options.record-origin"))
1343 opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
1344 else if (!strcmp(key, "options.allow-ff"))
1345 opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
1346 else if (!strcmp(key, "options.mainline"))
1347 opts->mainline = git_config_int(key, value);
1348 else if (!strcmp(key, "options.strategy"))
03a4e260 1349 git_config_string_dup(&opts->strategy, key, value);
3253553e 1350 else if (!strcmp(key, "options.gpg-sign"))
03a4e260 1351 git_config_string_dup(&opts->gpg_sign, key, value);
043a4492
RR
1352 else if (!strcmp(key, "options.strategy-option")) {
1353 ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
1354 opts->xopts[opts->xopts_nr++] = xstrdup(value);
1355 } else
93b3df6f 1356 return error(_("invalid key: %s"), key);
043a4492
RR
1357
1358 if (!error_flag)
93b3df6f 1359 return error(_("invalid value for %s: %s"), key, value);
043a4492
RR
1360
1361 return 0;
1362}
1363
ca6c6b45
JS
1364static void read_strategy_opts(struct replay_opts *opts, struct strbuf *buf)
1365{
1366 int i;
1367
1368 strbuf_reset(buf);
1369 if (!read_oneliner(buf, rebase_path_strategy(), 0))
1370 return;
1371 opts->strategy = strbuf_detach(buf, NULL);
1372 if (!read_oneliner(buf, rebase_path_strategy_opts(), 0))
1373 return;
1374
1375 opts->xopts_nr = split_cmdline(buf->buf, (const char ***)&opts->xopts);
1376 for (i = 0; i < opts->xopts_nr; i++) {
1377 const char *arg = opts->xopts[i];
1378
1379 skip_prefix(arg, "--", &arg);
1380 opts->xopts[i] = xstrdup(arg);
1381 }
1382}
1383
5adf9bdc 1384static int read_populate_opts(struct replay_opts *opts)
043a4492 1385{
a1c75762
JS
1386 if (is_rebase_i(opts)) {
1387 struct strbuf buf = STRBUF_INIT;
1388
1389 if (read_oneliner(&buf, rebase_path_gpg_sign_opt(), 1)) {
1390 if (!starts_with(buf.buf, "-S"))
1391 strbuf_reset(&buf);
1392 else {
1393 free(opts->gpg_sign);
1394 opts->gpg_sign = xstrdup(buf.buf + 2);
1395 }
1396 }
a1c75762 1397
556907f1
JS
1398 if (file_exists(rebase_path_verbose()))
1399 opts->verbose = 1;
1400
ca6c6b45
JS
1401 read_strategy_opts(opts, &buf);
1402 strbuf_release(&buf);
1403
b5a67045 1404 return 0;
a1c75762 1405 }
b5a67045 1406
f932729c 1407 if (!file_exists(git_path_opts_file()))
0d00da7b
JS
1408 return 0;
1409 /*
1410 * The function git_parse_source(), called from git_config_from_file(),
1411 * may die() in case of a syntactically incorrect file. We do not care
1412 * about this case, though, because we wrote that file ourselves, so we
1413 * are pretty certain that it is syntactically correct.
1414 */
5adf9bdc 1415 if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
93b3df6f 1416 return error(_("malformed options sheet: '%s'"),
0d00da7b
JS
1417 git_path_opts_file());
1418 return 0;
043a4492
RR
1419}
1420
004fefa7 1421static int walk_revs_populate_todo(struct todo_list *todo_list,
043a4492
RR
1422 struct replay_opts *opts)
1423{
004fefa7
JS
1424 enum todo_command command = opts->action == REPLAY_PICK ?
1425 TODO_PICK : TODO_REVERT;
414697a9 1426 const char *command_string = todo_command_info[command].str;
043a4492 1427 struct commit *commit;
043a4492 1428
34b0528b
JS
1429 if (prepare_revs(opts))
1430 return -1;
043a4492 1431
004fefa7
JS
1432 while ((commit = get_revision(opts->revs))) {
1433 struct todo_item *item = append_new_todo(todo_list);
1434 const char *commit_buffer = get_commit_buffer(commit, NULL);
1435 const char *subject;
1436 int subject_len;
1437
1438 item->command = command;
1439 item->commit = commit;
c22f7dfb
JS
1440 item->arg = NULL;
1441 item->arg_len = 0;
004fefa7
JS
1442 item->offset_in_buf = todo_list->buf.len;
1443 subject_len = find_commit_subject(commit_buffer, &subject);
1444 strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
1445 short_commit_name(commit), subject_len, subject);
1446 unuse_commit_buffer(commit, commit_buffer);
1447 }
34b0528b 1448 return 0;
043a4492
RR
1449}
1450
1451static int create_seq_dir(void)
1452{
f932729c 1453 if (file_exists(git_path_seq_dir())) {
043a4492
RR
1454 error(_("a cherry-pick or revert is already in progress"));
1455 advise(_("try \"git cherry-pick (--continue | --quit | --abort)\""));
1456 return -1;
a70d8f80 1457 } else if (mkdir(git_path_seq_dir(), 0777) < 0)
93b3df6f 1458 return error_errno(_("could not create sequencer directory '%s'"),
f6e82b0d 1459 git_path_seq_dir());
043a4492
RR
1460 return 0;
1461}
1462
311fd397 1463static int save_head(const char *head)
043a4492 1464{
043a4492
RR
1465 static struct lock_file head_lock;
1466 struct strbuf buf = STRBUF_INIT;
1467 int fd;
1468
311fd397
JS
1469 fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
1470 if (fd < 0) {
1471 rollback_lock_file(&head_lock);
93b3df6f 1472 return error_errno(_("could not lock HEAD"));
311fd397 1473 }
043a4492 1474 strbuf_addf(&buf, "%s\n", head);
311fd397
JS
1475 if (write_in_full(fd, buf.buf, buf.len) < 0) {
1476 rollback_lock_file(&head_lock);
93b3df6f 1477 return error_errno(_("could not write to '%s'"),
311fd397
JS
1478 git_path_head_file());
1479 }
1480 if (commit_lock_file(&head_lock) < 0) {
1481 rollback_lock_file(&head_lock);
93b3df6f 1482 return error(_("failed to finalize '%s'."), git_path_head_file());
311fd397
JS
1483 }
1484 return 0;
043a4492
RR
1485}
1486
1e41229d
SB
1487static int rollback_is_safe(void)
1488{
1489 struct strbuf sb = STRBUF_INIT;
1490 struct object_id expected_head, actual_head;
1491
1492 if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
1493 strbuf_trim(&sb);
1494 if (get_oid_hex(sb.buf, &expected_head)) {
1495 strbuf_release(&sb);
1496 die(_("could not parse %s"), git_path_abort_safety_file());
1497 }
1498 strbuf_release(&sb);
1499 }
1500 else if (errno == ENOENT)
1501 oidclr(&expected_head);
1502 else
1503 die_errno(_("could not read '%s'"), git_path_abort_safety_file());
1504
1505 if (get_oid("HEAD", &actual_head))
1506 oidclr(&actual_head);
1507
1508 return !oidcmp(&actual_head, &expected_head);
1509}
1510
043a4492
RR
1511static int reset_for_rollback(const unsigned char *sha1)
1512{
1513 const char *argv[4]; /* reset --merge <arg> + NULL */
1e41229d 1514
043a4492
RR
1515 argv[0] = "reset";
1516 argv[1] = "--merge";
1517 argv[2] = sha1_to_hex(sha1);
1518 argv[3] = NULL;
1519 return run_command_v_opt(argv, RUN_GIT_CMD);
1520}
1521
1522static int rollback_single_pick(void)
1523{
1524 unsigned char head_sha1[20];
1525
f932729c
JK
1526 if (!file_exists(git_path_cherry_pick_head()) &&
1527 !file_exists(git_path_revert_head()))
043a4492 1528 return error(_("no cherry-pick or revert in progress"));
7695d118 1529 if (read_ref_full("HEAD", 0, head_sha1, NULL))
043a4492
RR
1530 return error(_("cannot resolve HEAD"));
1531 if (is_null_sha1(head_sha1))
1532 return error(_("cannot abort from a branch yet to be born"));
1533 return reset_for_rollback(head_sha1);
1534}
1535
2863584f 1536int sequencer_rollback(struct replay_opts *opts)
043a4492 1537{
043a4492
RR
1538 FILE *f;
1539 unsigned char sha1[20];
1540 struct strbuf buf = STRBUF_INIT;
1541
f932729c 1542 f = fopen(git_path_head_file(), "r");
043a4492
RR
1543 if (!f && errno == ENOENT) {
1544 /*
1545 * There is no multiple-cherry-pick in progress.
1546 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
1547 * a single-cherry-pick in progress, abort that.
1548 */
1549 return rollback_single_pick();
1550 }
1551 if (!f)
f7ed1953 1552 return error_errno(_("cannot open '%s'"), git_path_head_file());
8f309aeb 1553 if (strbuf_getline_lf(&buf, f)) {
f7ed1953 1554 error(_("cannot read '%s': %s"), git_path_head_file(),
f932729c 1555 ferror(f) ? strerror(errno) : _("unexpected end of file"));
043a4492
RR
1556 fclose(f);
1557 goto fail;
1558 }
1559 fclose(f);
1560 if (get_sha1_hex(buf.buf, sha1) || buf.buf[40] != '\0') {
1561 error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
f932729c 1562 git_path_head_file());
043a4492
RR
1563 goto fail;
1564 }
0f974e21
MG
1565 if (is_null_sha1(sha1)) {
1566 error(_("cannot abort from a branch yet to be born"));
1567 goto fail;
1568 }
1e41229d
SB
1569
1570 if (!rollback_is_safe()) {
1571 /* Do not error, just do not rollback */
1572 warning(_("You seem to have moved HEAD. "
1573 "Not rewinding, check your HEAD!"));
1574 } else
043a4492
RR
1575 if (reset_for_rollback(sha1))
1576 goto fail;
043a4492 1577 strbuf_release(&buf);
2863584f 1578 return sequencer_remove_state(opts);
043a4492
RR
1579fail:
1580 strbuf_release(&buf);
1581 return -1;
1582}
1583
004fefa7 1584static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
043a4492 1585{
043a4492 1586 static struct lock_file todo_lock;
004fefa7
JS
1587 const char *todo_path = get_todo_path(opts);
1588 int next = todo_list->current, offset, fd;
043a4492 1589
84583957
JS
1590 /*
1591 * rebase -i writes "git-rebase-todo" without the currently executing
1592 * command, appending it to "done" instead.
1593 */
1594 if (is_rebase_i(opts))
1595 next++;
1596
004fefa7 1597 fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
221675de 1598 if (fd < 0)
93b3df6f 1599 return error_errno(_("could not lock '%s'"), todo_path);
004fefa7
JS
1600 offset = next < todo_list->nr ?
1601 todo_list->items[next].offset_in_buf : todo_list->buf.len;
1602 if (write_in_full(fd, todo_list->buf.buf + offset,
1603 todo_list->buf.len - offset) < 0)
93b3df6f 1604 return error_errno(_("could not write to '%s'"), todo_path);
004fefa7 1605 if (commit_lock_file(&todo_lock) < 0)
93b3df6f 1606 return error(_("failed to finalize '%s'."), todo_path);
1df6df0c
JS
1607
1608 if (is_rebase_i(opts)) {
1609 const char *done_path = rebase_path_done();
1610 int fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
1611 int prev_offset = !next ? 0 :
1612 todo_list->items[next - 1].offset_in_buf;
1613
1614 if (fd >= 0 && offset > prev_offset &&
1615 write_in_full(fd, todo_list->buf.buf + prev_offset,
1616 offset - prev_offset) < 0) {
1617 close(fd);
1618 return error_errno(_("could not write to '%s'"),
1619 done_path);
1620 }
1621 if (fd >= 0)
1622 close(fd);
1623 }
221675de 1624 return 0;
043a4492
RR
1625}
1626
88d5a271 1627static int save_opts(struct replay_opts *opts)
043a4492 1628{
f932729c 1629 const char *opts_file = git_path_opts_file();
88d5a271 1630 int res = 0;
043a4492
RR
1631
1632 if (opts->no_commit)
88d5a271 1633 res |= git_config_set_in_file_gently(opts_file, "options.no-commit", "true");
043a4492 1634 if (opts->edit)
88d5a271 1635 res |= git_config_set_in_file_gently(opts_file, "options.edit", "true");
043a4492 1636 if (opts->signoff)
88d5a271 1637 res |= git_config_set_in_file_gently(opts_file, "options.signoff", "true");
043a4492 1638 if (opts->record_origin)
88d5a271 1639 res |= git_config_set_in_file_gently(opts_file, "options.record-origin", "true");
043a4492 1640 if (opts->allow_ff)
88d5a271 1641 res |= git_config_set_in_file_gently(opts_file, "options.allow-ff", "true");
043a4492
RR
1642 if (opts->mainline) {
1643 struct strbuf buf = STRBUF_INIT;
1644 strbuf_addf(&buf, "%d", opts->mainline);
88d5a271 1645 res |= git_config_set_in_file_gently(opts_file, "options.mainline", buf.buf);
043a4492
RR
1646 strbuf_release(&buf);
1647 }
1648 if (opts->strategy)
88d5a271 1649 res |= git_config_set_in_file_gently(opts_file, "options.strategy", opts->strategy);
3253553e 1650 if (opts->gpg_sign)
88d5a271 1651 res |= git_config_set_in_file_gently(opts_file, "options.gpg-sign", opts->gpg_sign);
043a4492
RR
1652 if (opts->xopts) {
1653 int i;
1654 for (i = 0; i < opts->xopts_nr; i++)
88d5a271 1655 res |= git_config_set_multivar_in_file_gently(opts_file,
043a4492
RR
1656 "options.strategy-option",
1657 opts->xopts[i], "^$", 0);
1658 }
88d5a271 1659 return res;
043a4492
RR
1660}
1661
56dc3ab0
JS
1662static int make_patch(struct commit *commit, struct replay_opts *opts)
1663{
1664 struct strbuf buf = STRBUF_INIT;
1665 struct rev_info log_tree_opt;
1666 const char *subject, *p;
1667 int res = 0;
1668
1669 p = short_commit_name(commit);
1670 if (write_message(p, strlen(p), rebase_path_stopped_sha(), 1) < 0)
1671 return -1;
1672
1673 strbuf_addf(&buf, "%s/patch", get_dir(opts));
1674 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
1675 init_revisions(&log_tree_opt, NULL);
1676 log_tree_opt.abbrev = 0;
1677 log_tree_opt.diff = 1;
1678 log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
1679 log_tree_opt.disable_stdin = 1;
1680 log_tree_opt.no_commit_id = 1;
1681 log_tree_opt.diffopt.file = fopen(buf.buf, "w");
1682 log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
1683 if (!log_tree_opt.diffopt.file)
1684 res |= error_errno(_("could not open '%s'"), buf.buf);
1685 else {
1686 res |= log_tree_commit(&log_tree_opt, commit);
1687 fclose(log_tree_opt.diffopt.file);
1688 }
1689 strbuf_reset(&buf);
1690
1691 strbuf_addf(&buf, "%s/message", get_dir(opts));
1692 if (!file_exists(buf.buf)) {
1693 const char *commit_buffer = get_commit_buffer(commit, NULL);
1694 find_commit_subject(commit_buffer, &subject);
1695 res |= write_message(subject, strlen(subject), buf.buf, 1);
1696 unuse_commit_buffer(commit, commit_buffer);
1697 }
1698 strbuf_release(&buf);
1699
1700 return res;
1701}
1702
1703static int intend_to_amend(void)
1704{
1705 unsigned char head[20];
1706 char *p;
1707
1708 if (get_sha1("HEAD", head))
1709 return error(_("cannot read HEAD"));
1710
1711 p = sha1_to_hex(head);
1712 return write_message(p, strlen(p), rebase_path_amend(), 1);
1713}
1714
1715static int error_with_patch(struct commit *commit,
1716 const char *subject, int subject_len,
1717 struct replay_opts *opts, int exit_code, int to_amend)
1718{
1719 if (make_patch(commit, opts))
1720 return -1;
1721
1722 if (to_amend) {
1723 if (intend_to_amend())
1724 return -1;
1725
1726 fprintf(stderr, "You can amend the commit now, with\n"
1727 "\n"
1728 " git commit --amend %s\n"
1729 "\n"
1730 "Once you are satisfied with your changes, run\n"
1731 "\n"
1732 " git rebase --continue\n", gpg_sign_opt_quoted(opts));
1733 } else if (exit_code)
1734 fprintf(stderr, "Could not apply %s... %.*s\n",
1735 short_commit_name(commit), subject_len, subject);
1736
1737 return exit_code;
1738}
1739
6e98de72
JS
1740static int error_failed_squash(struct commit *commit,
1741 struct replay_opts *opts, int subject_len, const char *subject)
1742{
1743 if (rename(rebase_path_squash_msg(), rebase_path_message()))
1744 return error(_("could not rename '%s' to '%s'"),
1745 rebase_path_squash_msg(), rebase_path_message());
1746 unlink(rebase_path_fixup_msg());
1747 unlink(git_path("MERGE_MSG"));
1748 if (copy_file(git_path("MERGE_MSG"), rebase_path_message(), 0666))
1749 return error(_("could not copy '%s' to '%s'"),
1750 rebase_path_message(), git_path("MERGE_MSG"));
1751 return error_with_patch(commit, subject, subject_len, opts, 1, 0);
1752}
1753
311af526
JS
1754static int do_exec(const char *command_line)
1755{
1756 const char *child_argv[] = { NULL, NULL };
1757 int dirty, status;
1758
1759 fprintf(stderr, "Executing: %s\n", command_line);
1760 child_argv[0] = command_line;
1761 status = run_command_v_opt(child_argv, RUN_USING_SHELL);
1762
1763 /* force re-reading of the cache */
1764 if (discard_cache() < 0 || read_cache() < 0)
1765 return error(_("could not read index"));
1766
1767 dirty = require_clean_work_tree("rebase", NULL, 1, 1);
1768
1769 if (status) {
1770 warning(_("execution failed: %s\n%s"
1771 "You can fix the problem, and then run\n"
1772 "\n"
1773 " git rebase --continue\n"
1774 "\n"),
1775 command_line,
1776 dirty ? N_("and made changes to the index and/or the "
1777 "working tree\n") : "");
1778 if (status == 127)
1779 /* command not found */
1780 status = 1;
1781 } else if (dirty) {
1782 warning(_("execution succeeded: %s\nbut "
1783 "left changes to the index and/or the working tree\n"
1784 "Commit or stash your changes, and then run\n"
1785 "\n"
1786 " git rebase --continue\n"
1787 "\n"), command_line);
1788 status = 1;
1789 }
1790
1791 return status;
1792}
1793
6e98de72
JS
1794static int is_final_fixup(struct todo_list *todo_list)
1795{
1796 int i = todo_list->current;
1797
1798 if (!is_fixup(todo_list->items[i].command))
1799 return 0;
1800
1801 while (++i < todo_list->nr)
1802 if (is_fixup(todo_list->items[i].command))
1803 return 0;
1804 else if (!is_noop(todo_list->items[i].command))
1805 break;
1806 return 1;
1807}
1808
25cb8df9
JS
1809static enum todo_command peek_command(struct todo_list *todo_list, int offset)
1810{
1811 int i;
1812
1813 for (i = todo_list->current + offset; i < todo_list->nr; i++)
1814 if (!is_noop(todo_list->items[i].command))
1815 return todo_list->items[i].command;
1816
1817 return -1;
1818}
1819
796c7972
JS
1820static int apply_autostash(struct replay_opts *opts)
1821{
1822 struct strbuf stash_sha1 = STRBUF_INIT;
1823 struct child_process child = CHILD_PROCESS_INIT;
1824 int ret = 0;
1825
1826 if (!read_oneliner(&stash_sha1, rebase_path_autostash(), 1)) {
1827 strbuf_release(&stash_sha1);
1828 return 0;
1829 }
1830 strbuf_trim(&stash_sha1);
1831
1832 child.git_cmd = 1;
1833 argv_array_push(&child.args, "stash");
1834 argv_array_push(&child.args, "apply");
1835 argv_array_push(&child.args, stash_sha1.buf);
1836 if (!run_command(&child))
1837 printf(_("Applied autostash."));
1838 else {
1839 struct child_process store = CHILD_PROCESS_INIT;
1840
1841 store.git_cmd = 1;
1842 argv_array_push(&store.args, "stash");
1843 argv_array_push(&store.args, "store");
1844 argv_array_push(&store.args, "-m");
1845 argv_array_push(&store.args, "autostash");
1846 argv_array_push(&store.args, "-q");
1847 argv_array_push(&store.args, stash_sha1.buf);
1848 if (run_command(&store))
1849 ret = error(_("cannot store %s"), stash_sha1.buf);
1850 else
1851 printf(_("Applying autostash resulted in conflicts.\n"
1852 "Your changes are safe in the stash.\n"
1853 "You can run \"git stash pop\" or"
1854 " \"git stash drop\" at any time.\n"));
1855 }
1856
1857 strbuf_release(&stash_sha1);
1858 return ret;
1859}
1860
96e832a5
JS
1861static const char *reflog_message(struct replay_opts *opts,
1862 const char *sub_action, const char *fmt, ...)
1863{
1864 va_list ap;
1865 static struct strbuf buf = STRBUF_INIT;
1866
1867 va_start(ap, fmt);
1868 strbuf_reset(&buf);
1869 strbuf_addstr(&buf, action_name(opts));
1870 if (sub_action)
1871 strbuf_addf(&buf, " (%s)", sub_action);
1872 if (fmt) {
1873 strbuf_addstr(&buf, ": ");
1874 strbuf_vaddf(&buf, fmt, ap);
1875 }
1876 va_end(ap);
1877
1878 return buf.buf;
1879}
1880
004fefa7 1881static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
043a4492 1882{
56dc3ab0 1883 int res = 0;
043a4492
RR
1884
1885 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
1886 if (opts->allow_ff)
1887 assert(!(opts->signoff || opts->no_commit ||
1888 opts->record_origin || opts->edit));
0d9c6dc9
JS
1889 if (read_and_refresh_cache(opts))
1890 return -1;
043a4492 1891
004fefa7
JS
1892 while (todo_list->current < todo_list->nr) {
1893 struct todo_item *item = todo_list->items + todo_list->current;
1894 if (save_todo(todo_list, opts))
221675de 1895 return -1;
6e98de72
JS
1896 if (is_rebase_i(opts)) {
1897 unlink(rebase_path_message());
1898 unlink(rebase_path_author_script());
1899 unlink(rebase_path_stopped_sha());
1900 unlink(rebase_path_amend());
1901 }
1902 if (item->command <= TODO_SQUASH) {
8ab37ef2
JS
1903 if (is_rebase_i(opts))
1904 setenv("GIT_REFLOG_ACTION", reflog_message(opts,
1905 command_to_string(item->command), NULL),
1906 1);
25c43667 1907 res = do_pick_commit(item->command, item->commit,
6e98de72 1908 opts, is_final_fixup(todo_list));
9d7bf3cf
JS
1909 if (is_rebase_i(opts) && res < 0) {
1910 /* Reschedule */
1911 todo_list->current--;
1912 if (save_todo(todo_list, opts))
1913 return -1;
1914 }
56dc3ab0
JS
1915 if (item->command == TODO_EDIT) {
1916 struct commit *commit = item->commit;
1917 if (!res)
1918 warning(_("stopped at %s... %.*s"),
1919 short_commit_name(commit),
1920 item->arg_len, item->arg);
1921 return error_with_patch(commit,
1922 item->arg, item->arg_len, opts, res,
1923 !res);
1924 }
25cb8df9
JS
1925 if (is_rebase_i(opts) && !res)
1926 record_in_rewritten(&item->commit->object.oid,
1927 peek_command(todo_list, 1));
6e98de72
JS
1928 if (res && is_fixup(item->command)) {
1929 if (res == 1)
1930 intend_to_amend();
1931 return error_failed_squash(item->commit, opts,
1932 item->arg_len, item->arg);
4a5146f9
JS
1933 } else if (res && is_rebase_i(opts))
1934 return res | error_with_patch(item->commit,
04efc8b5
JS
1935 item->arg, item->arg_len, opts, res,
1936 item->command == TODO_REWORD);
311af526
JS
1937 } else if (item->command == TODO_EXEC) {
1938 char *end_of_arg = (char *)(item->arg + item->arg_len);
1939 int saved = *end_of_arg;
1940
1941 *end_of_arg = '\0';
1942 res = do_exec(item->arg);
1943 *end_of_arg = saved;
56dc3ab0 1944 } else if (!is_noop(item->command))
25c43667
JS
1945 return error(_("unknown command %d"), item->command);
1946
004fefa7 1947 todo_list->current++;
043a4492
RR
1948 if (res)
1949 return res;
1950 }
1951
56dc3ab0 1952 if (is_rebase_i(opts)) {
4b83ce9f 1953 struct strbuf head_ref = STRBUF_INIT, buf = STRBUF_INIT;
25cb8df9 1954 struct stat st;
556907f1 1955
56dc3ab0
JS
1956 /* Stopped in the middle, as planned? */
1957 if (todo_list->current < todo_list->nr)
1958 return 0;
556907f1 1959
4b83ce9f
JS
1960 if (read_oneliner(&head_ref, rebase_path_head_name(), 0) &&
1961 starts_with(head_ref.buf, "refs/")) {
96e832a5 1962 const char *msg;
4b83ce9f
JS
1963 unsigned char head[20], orig[20];
1964 int res;
1965
1966 if (get_sha1("HEAD", head)) {
1967 res = error(_("cannot read HEAD"));
1968cleanup_head_ref:
1969 strbuf_release(&head_ref);
1970 strbuf_release(&buf);
1971 return res;
1972 }
1973 if (!read_oneliner(&buf, rebase_path_orig_head(), 0) ||
1974 get_sha1_hex(buf.buf, orig)) {
1975 res = error(_("could not read orig-head"));
1976 goto cleanup_head_ref;
1977 }
4b83ce9f
JS
1978 if (!read_oneliner(&buf, rebase_path_onto(), 0)) {
1979 res = error(_("could not read 'onto'"));
1980 goto cleanup_head_ref;
1981 }
96e832a5
JS
1982 msg = reflog_message(opts, "finish", "%s onto %s",
1983 head_ref.buf, buf.buf);
1984 if (update_ref(msg, head_ref.buf, head, orig,
4b83ce9f
JS
1985 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR)) {
1986 res = error(_("could not update %s"),
1987 head_ref.buf);
1988 goto cleanup_head_ref;
1989 }
96e832a5 1990 msg = reflog_message(opts, "finish", "returning to %s",
4b83ce9f 1991 head_ref.buf);
96e832a5 1992 if (create_symref("HEAD", head_ref.buf, msg)) {
4b83ce9f
JS
1993 res = error(_("could not update HEAD to %s"),
1994 head_ref.buf);
1995 goto cleanup_head_ref;
1996 }
1997 strbuf_reset(&buf);
1998 }
1999
556907f1
JS
2000 if (opts->verbose) {
2001 struct rev_info log_tree_opt;
2002 struct object_id orig, head;
2003
2004 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
2005 init_revisions(&log_tree_opt, NULL);
2006 log_tree_opt.diff = 1;
2007 log_tree_opt.diffopt.output_format =
2008 DIFF_FORMAT_DIFFSTAT;
2009 log_tree_opt.disable_stdin = 1;
2010
2011 if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
2012 !get_sha1(buf.buf, orig.hash) &&
2013 !get_sha1("HEAD", head.hash)) {
2014 diff_tree_sha1(orig.hash, head.hash,
2015 "", &log_tree_opt.diffopt);
2016 log_tree_diff_flush(&log_tree_opt);
2017 }
2018 }
25cb8df9
JS
2019 flush_rewritten_pending();
2020 if (!stat(rebase_path_rewritten_list(), &st) &&
2021 st.st_size > 0) {
2022 struct child_process child = CHILD_PROCESS_INIT;
79516045
JS
2023 const char *post_rewrite_hook =
2024 find_hook("post-rewrite");
25cb8df9
JS
2025
2026 child.in = open(rebase_path_rewritten_list(), O_RDONLY);
2027 child.git_cmd = 1;
2028 argv_array_push(&child.args, "notes");
2029 argv_array_push(&child.args, "copy");
2030 argv_array_push(&child.args, "--for-rewrite=rebase");
2031 /* we don't care if this copying failed */
2032 run_command(&child);
79516045
JS
2033
2034 if (post_rewrite_hook) {
2035 struct child_process hook = CHILD_PROCESS_INIT;
2036
2037 hook.in = open(rebase_path_rewritten_list(),
2038 O_RDONLY);
2039 hook.stdout_to_stderr = 1;
2040 argv_array_push(&hook.args, post_rewrite_hook);
2041 argv_array_push(&hook.args, "rebase");
2042 /* we don't care if this hook failed */
2043 run_command(&hook);
2044 }
25cb8df9 2045 }
796c7972 2046 apply_autostash(opts);
25cb8df9 2047
556907f1 2048 strbuf_release(&buf);
4b83ce9f 2049 strbuf_release(&head_ref);
56dc3ab0
JS
2050 }
2051
043a4492
RR
2052 /*
2053 * Sequence of picks finished successfully; cleanup by
2054 * removing the .git/sequencer directory
2055 */
2863584f 2056 return sequencer_remove_state(opts);
043a4492
RR
2057}
2058
2059static int continue_single_pick(void)
2060{
2061 const char *argv[] = { "commit", NULL };
2062
f932729c
JK
2063 if (!file_exists(git_path_cherry_pick_head()) &&
2064 !file_exists(git_path_revert_head()))
043a4492
RR
2065 return error(_("no cherry-pick or revert in progress"));
2066 return run_command_v_opt(argv, RUN_GIT_CMD);
2067}
2068
9d93ccd1
JS
2069static int commit_staged_changes(struct replay_opts *opts)
2070{
2071 int amend = 0;
2072
2073 if (has_unstaged_changes(1))
2074 return error(_("cannot rebase: You have unstaged changes."));
52632209
JS
2075 if (!has_uncommitted_changes(0)) {
2076 const char *cherry_pick_head = git_path("CHERRY_PICK_HEAD");
2077
2078 if (file_exists(cherry_pick_head) && unlink(cherry_pick_head))
2079 return error(_("could not remove CHERRY_PICK_HEAD"));
9d93ccd1 2080 return 0;
52632209 2081 }
9d93ccd1
JS
2082
2083 if (file_exists(rebase_path_amend())) {
2084 struct strbuf rev = STRBUF_INIT;
2085 unsigned char head[20], to_amend[20];
2086
2087 if (get_sha1("HEAD", head))
2088 return error(_("cannot amend non-existing commit"));
2089 if (!read_oneliner(&rev, rebase_path_amend(), 0))
2090 return error(_("invalid file: '%s'"), rebase_path_amend());
2091 if (get_sha1_hex(rev.buf, to_amend))
2092 return error(_("invalid contents: '%s'"),
2093 rebase_path_amend());
2094 if (hashcmp(head, to_amend))
2095 return error(_("\nYou have uncommitted changes in your "
2096 "working tree. Please, commit them\n"
2097 "first and then run 'git rebase "
2098 "--continue' again."));
2099
2100 strbuf_release(&rev);
2101 amend = 1;
2102 }
2103
2104 if (run_git_commit(rebase_path_message(), opts, 1, 1, amend, 0))
2105 return error(_("could not commit staged changes."));
2106 unlink(rebase_path_amend());
2107 return 0;
2108}
2109
2863584f 2110int sequencer_continue(struct replay_opts *opts)
043a4492 2111{
004fefa7
JS
2112 struct todo_list todo_list = TODO_LIST_INIT;
2113 int res;
043a4492 2114
2863584f
JS
2115 if (read_and_refresh_cache(opts))
2116 return -1;
2117
9d93ccd1
JS
2118 if (is_rebase_i(opts)) {
2119 if (commit_staged_changes(opts))
2120 return -1;
4258a6da 2121 } else if (!file_exists(get_todo_path(opts)))
043a4492 2122 return continue_single_pick();
004fefa7 2123 if (read_populate_opts(opts))
0ae42a03 2124 return -1;
004fefa7
JS
2125 if ((res = read_populate_todo(&todo_list, opts)))
2126 goto release_todo_list;
043a4492 2127
4258a6da
JS
2128 if (!is_rebase_i(opts)) {
2129 /* Verify that the conflict has been resolved */
2130 if (file_exists(git_path_cherry_pick_head()) ||
2131 file_exists(git_path_revert_head())) {
2132 res = continue_single_pick();
2133 if (res)
2134 goto release_todo_list;
2135 }
2136 if (index_differs_from("HEAD", 0, 0)) {
2137 res = error_dirty_index(opts);
004fefa7 2138 goto release_todo_list;
4258a6da
JS
2139 }
2140 todo_list.current++;
ca98c6d4
JS
2141 } else if (file_exists(rebase_path_stopped_sha())) {
2142 struct strbuf buf = STRBUF_INIT;
2143 struct object_id oid;
2144
2145 if (read_oneliner(&buf, rebase_path_stopped_sha(), 1) &&
2146 !get_sha1_committish(buf.buf, oid.hash))
2147 record_in_rewritten(&oid, peek_command(&todo_list, 0));
2148 strbuf_release(&buf);
043a4492 2149 }
4258a6da 2150
004fefa7
JS
2151 res = pick_commits(&todo_list, opts);
2152release_todo_list:
2153 todo_list_release(&todo_list);
2154 return res;
043a4492
RR
2155}
2156
2157static int single_pick(struct commit *cmit, struct replay_opts *opts)
2158{
2159 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
004fefa7 2160 return do_pick_commit(opts->action == REPLAY_PICK ?
6e98de72 2161 TODO_PICK : TODO_REVERT, cmit, opts, 0);
043a4492
RR
2162}
2163
2164int sequencer_pick_revisions(struct replay_opts *opts)
2165{
004fefa7 2166 struct todo_list todo_list = TODO_LIST_INIT;
043a4492 2167 unsigned char sha1[20];
004fefa7 2168 int i, res;
043a4492 2169
2863584f 2170 assert(opts->revs);
0d9c6dc9
JS
2171 if (read_and_refresh_cache(opts))
2172 return -1;
043a4492 2173
21246dbb
MV
2174 for (i = 0; i < opts->revs->pending.nr; i++) {
2175 unsigned char sha1[20];
2176 const char *name = opts->revs->pending.objects[i].name;
2177
2178 /* This happens when using --stdin. */
2179 if (!strlen(name))
2180 continue;
2181
2182 if (!get_sha1(name, sha1)) {
7c0b0d8d
JH
2183 if (!lookup_commit_reference_gently(sha1, 1)) {
2184 enum object_type type = sha1_object_info(sha1, NULL);
b9b946d4
JS
2185 return error(_("%s: can't cherry-pick a %s"),
2186 name, typename(type));
7c0b0d8d 2187 }
21246dbb 2188 } else
b9b946d4 2189 return error(_("%s: bad revision"), name);
21246dbb
MV
2190 }
2191
043a4492
RR
2192 /*
2193 * If we were called as "git cherry-pick <commit>", just
2194 * cherry-pick/revert it, set CHERRY_PICK_HEAD /
2195 * REVERT_HEAD, and don't touch the sequencer state.
2196 * This means it is possible to cherry-pick in the middle
2197 * of a cherry-pick sequence.
2198 */
2199 if (opts->revs->cmdline.nr == 1 &&
2200 opts->revs->cmdline.rev->whence == REV_CMD_REV &&
2201 opts->revs->no_walk &&
2202 !opts->revs->cmdline.rev->flags) {
2203 struct commit *cmit;
2204 if (prepare_revision_walk(opts->revs))
b9b946d4 2205 return error(_("revision walk setup failed"));
043a4492
RR
2206 cmit = get_revision(opts->revs);
2207 if (!cmit || get_revision(opts->revs))
b9b946d4 2208 return error("BUG: expected exactly one commit from walk");
043a4492
RR
2209 return single_pick(cmit, opts);
2210 }
2211
2212 /*
2213 * Start a new cherry-pick/ revert sequence; but
2214 * first, make sure that an existing one isn't in
2215 * progress
2216 */
2217
34b0528b
JS
2218 if (walk_revs_populate_todo(&todo_list, opts) ||
2219 create_seq_dir() < 0)
043a4492 2220 return -1;
0f974e21 2221 if (get_sha1("HEAD", sha1) && (opts->action == REPLAY_REVERT))
93b3df6f 2222 return error(_("can't revert as initial commit"));
311fd397
JS
2223 if (save_head(sha1_to_hex(sha1)))
2224 return -1;
88d5a271
JS
2225 if (save_opts(opts))
2226 return -1;
1e41229d 2227 update_abort_safety_file();
004fefa7
JS
2228 res = pick_commits(&todo_list, opts);
2229 todo_list_release(&todo_list);
2230 return res;
043a4492 2231}
5ed75e2a 2232
bab4d109 2233void append_signoff(struct strbuf *msgbuf, int ignore_footer, unsigned flag)
5ed75e2a 2234{
bab4d109 2235 unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
5ed75e2a 2236 struct strbuf sob = STRBUF_INIT;
bab4d109 2237 int has_footer;
5ed75e2a
MV
2238
2239 strbuf_addstr(&sob, sign_off_header);
2240 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
2241 getenv("GIT_COMMITTER_EMAIL")));
2242 strbuf_addch(&sob, '\n');
bab4d109
BC
2243
2244 /*
2245 * If the whole message buffer is equal to the sob, pretend that we
2246 * found a conforming footer with a matching sob
2247 */
2248 if (msgbuf->len - ignore_footer == sob.len &&
2249 !strncmp(msgbuf->buf, sob.buf, sob.len))
2250 has_footer = 3;
2251 else
2252 has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
2253
33f2f9ab
BC
2254 if (!has_footer) {
2255 const char *append_newlines = NULL;
2256 size_t len = msgbuf->len - ignore_footer;
2257
8c613fd5
BC
2258 if (!len) {
2259 /*
2260 * The buffer is completely empty. Leave foom for
2261 * the title and body to be filled in by the user.
2262 */
33f2f9ab 2263 append_newlines = "\n\n";
8c613fd5
BC
2264 } else if (msgbuf->buf[len - 1] != '\n') {
2265 /*
2266 * Incomplete line. Complete the line and add a
2267 * blank one so that there is an empty line between
2268 * the message body and the sob.
2269 */
2270 append_newlines = "\n\n";
2271 } else if (len == 1) {
2272 /*
2273 * Buffer contains a single newline. Add another
2274 * so that we leave room for the title and body.
2275 */
2276 append_newlines = "\n";
2277 } else if (msgbuf->buf[len - 2] != '\n') {
2278 /*
2279 * Buffer ends with a single newline. Add another
2280 * so that there is an empty line between the message
2281 * body and the sob.
2282 */
33f2f9ab 2283 append_newlines = "\n";
8c613fd5 2284 } /* else, the buffer already ends with two newlines. */
33f2f9ab
BC
2285
2286 if (append_newlines)
2287 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
2288 append_newlines, strlen(append_newlines));
5ed75e2a 2289 }
bab4d109
BC
2290
2291 if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
2292 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
2293 sob.buf, sob.len);
2294
5ed75e2a
MV
2295 strbuf_release(&sob);
2296}