sequencer (rebase -i): respect strategy/strategy_opts settings
[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
JS
546/*
547 * Read the author-script file into an environment block, ready for use in
548 * run_command(), that can be free()d afterwards.
549 */
550static char **read_author_script(void)
551{
552 struct strbuf script = STRBUF_INIT;
553 int i, count = 0;
554 char *p, *p2, **env;
555 size_t env_size;
556
557 if (strbuf_read_file(&script, rebase_path_author_script(), 256) <= 0)
558 return NULL;
559
560 for (p = script.buf; *p; p++)
561 if (skip_prefix(p, "'\\\\''", (const char **)&p2))
562 strbuf_splice(&script, p - script.buf, p2 - p, "'", 1);
563 else if (*p == '\'')
564 strbuf_splice(&script, p-- - script.buf, 1, "", 0);
565 else if (*p == '\n') {
566 *p = '\0';
567 count++;
568 }
569
570 env_size = (count + 1) * sizeof(*env);
571 strbuf_grow(&script, env_size);
572 memmove(script.buf + env_size, script.buf, script.len);
573 p = script.buf + env_size;
574 env = (char **)strbuf_detach(&script, NULL);
575
576 for (i = 0; i < count; i++) {
577 env[i] = p;
578 p += strlen(p) + 1;
579 }
580 env[count] = NULL;
581
582 return env;
583}
584
791eb870
JS
585static const char staged_changes_advice[] =
586N_("you have staged changes in your working tree\n"
587"If these changes are meant to be squashed into the previous commit, run:\n"
588"\n"
589" git commit --amend %s\n"
590"\n"
591"If they are meant to go into a new commit, run:\n"
592"\n"
593" git commit %s\n"
594"\n"
595"In both cases, once you're done, continue with:\n"
596"\n"
597" git rebase --continue\n");
598
043a4492
RR
599/*
600 * If we are cherry-pick, and if the merge did not result in
601 * hand-editing, we will hit this commit and inherit the original
602 * author date and name.
b5a67045 603 *
043a4492
RR
604 * If we are revert, or if our cherry-pick results in a hand merge,
605 * we had better say that the current user is responsible for that.
b5a67045
JS
606 *
607 * An exception is when run_git_commit() is called during an
608 * interactive rebase: in that case, we will want to retain the
609 * author metadata.
043a4492 610 */
ac2b0e8f 611static int run_git_commit(const char *defmsg, struct replay_opts *opts,
0009426d
JS
612 int allow_empty, int edit, int amend,
613 int cleanup_commit_message)
043a4492 614{
b5a67045 615 char **env = NULL;
b27cfb0d
NH
616 struct argv_array array;
617 int rc;
17d65f03 618 const char *value;
b27cfb0d 619
b5a67045
JS
620 if (is_rebase_i(opts)) {
621 env = read_author_script();
a1c75762
JS
622 if (!env) {
623 const char *gpg_opt = gpg_sign_opt_quoted(opts);
624
791eb870
JS
625 return error(_(staged_changes_advice),
626 gpg_opt, gpg_opt);
a1c75762 627 }
b5a67045
JS
628 }
629
b27cfb0d
NH
630 argv_array_init(&array);
631 argv_array_push(&array, "commit");
632 argv_array_push(&array, "-n");
043a4492 633
9240beda
JS
634 if (amend)
635 argv_array_push(&array, "--amend");
3bdd5522
JK
636 if (opts->gpg_sign)
637 argv_array_pushf(&array, "-S%s", opts->gpg_sign);
043a4492 638 if (opts->signoff)
b27cfb0d 639 argv_array_push(&array, "-s");
b5a67045
JS
640 if (defmsg)
641 argv_array_pushl(&array, "-F", defmsg, NULL);
0009426d
JS
642 if (cleanup_commit_message)
643 argv_array_push(&array, "--cleanup=strip");
a1c75762 644 if (edit)
b5a67045 645 argv_array_push(&array, "-e");
0009426d
JS
646 else if (!cleanup_commit_message &&
647 !opts->signoff && !opts->record_origin &&
b5a67045
JS
648 git_config_get_value("commit.cleanup", &value))
649 argv_array_push(&array, "--cleanup=verbatim");
b27cfb0d 650
ac2b0e8f 651 if (allow_empty)
b27cfb0d 652 argv_array_push(&array, "--allow-empty");
df478b74 653
4bee9584
CW
654 if (opts->allow_empty_message)
655 argv_array_push(&array, "--allow-empty-message");
656
b5a67045
JS
657 rc = run_command_v_opt_cd_env(array.argv, RUN_GIT_CMD, NULL,
658 (const char *const *)env);
b27cfb0d 659 argv_array_clear(&array);
b5a67045
JS
660 free(env);
661
b27cfb0d
NH
662 return rc;
663}
664
665static int is_original_commit_empty(struct commit *commit)
666{
667 const unsigned char *ptree_sha1;
668
669 if (parse_commit(commit))
93b3df6f 670 return error(_("could not parse commit %s\n"),
f2fd0760 671 oid_to_hex(&commit->object.oid));
b27cfb0d
NH
672 if (commit->parents) {
673 struct commit *parent = commit->parents->item;
674 if (parse_commit(parent))
93b3df6f 675 return error(_("could not parse parent commit %s\n"),
f2fd0760 676 oid_to_hex(&parent->object.oid));
ed1c9977 677 ptree_sha1 = parent->tree->object.oid.hash;
b27cfb0d
NH
678 } else {
679 ptree_sha1 = EMPTY_TREE_SHA1_BIN; /* commit is root */
043a4492 680 }
043a4492 681
ed1c9977 682 return !hashcmp(ptree_sha1, commit->tree->object.oid.hash);
043a4492
RR
683}
684
ac2b0e8f
JH
685/*
686 * Do we run "git commit" with "--allow-empty"?
687 */
688static int allow_empty(struct replay_opts *opts, struct commit *commit)
689{
690 int index_unchanged, empty_commit;
691
692 /*
693 * Three cases:
694 *
695 * (1) we do not allow empty at all and error out.
696 *
697 * (2) we allow ones that were initially empty, but
698 * forbid the ones that become empty;
699 *
700 * (3) we allow both.
701 */
702 if (!opts->allow_empty)
703 return 0; /* let "git commit" barf as necessary */
704
705 index_unchanged = is_index_unchanged();
706 if (index_unchanged < 0)
707 return index_unchanged;
708 if (!index_unchanged)
709 return 0; /* we do not have to say --allow-empty */
710
711 if (opts->keep_redundant_commits)
712 return 1;
713
714 empty_commit = is_original_commit_empty(commit);
715 if (empty_commit < 0)
716 return empty_commit;
717 if (!empty_commit)
718 return 0;
719 else
720 return 1;
721}
722
25c43667
JS
723/*
724 * Note that ordering matters in this enum. Not only must it match the mapping
725 * below, it is also divided into several sections that matter. When adding
726 * new commands, make sure you add it in the right section.
727 */
004fefa7 728enum todo_command {
25c43667 729 /* commands that handle commits */
004fefa7 730 TODO_PICK = 0,
25c43667 731 TODO_REVERT,
56dc3ab0 732 TODO_EDIT,
04efc8b5 733 TODO_REWORD,
6e98de72
JS
734 TODO_FIXUP,
735 TODO_SQUASH,
311af526
JS
736 /* commands that do something else than handling a single commit */
737 TODO_EXEC,
25c43667
JS
738 /* commands that do nothing but are counted for reporting progress */
739 TODO_NOOP
004fefa7
JS
740};
741
414697a9
JS
742static struct {
743 char c;
744 const char *str;
745} todo_command_info[] = {
746 { 'p', "pick" },
747 { 0, "revert" },
748 { 'e', "edit" },
04efc8b5 749 { 'r', "reword" },
414697a9
JS
750 { 'f', "fixup" },
751 { 's', "squash" },
752 { 'x', "exec" },
753 { 0, "noop" }
004fefa7
JS
754};
755
756static const char *command_to_string(const enum todo_command command)
757{
414697a9
JS
758 if ((size_t)command < ARRAY_SIZE(todo_command_info))
759 return todo_command_info[command].str;
004fefa7
JS
760 die("Unknown command: %d", command);
761}
762
25c43667
JS
763static int is_noop(const enum todo_command command)
764{
765 return TODO_NOOP <= (size_t)command;
766}
004fefa7 767
6e98de72
JS
768static int is_fixup(enum todo_command command)
769{
770 return command == TODO_FIXUP || command == TODO_SQUASH;
771}
772
773static int update_squash_messages(enum todo_command command,
774 struct commit *commit, struct replay_opts *opts)
775{
776 struct strbuf buf = STRBUF_INIT;
777 int count, res;
778 const char *message, *body;
779
780 if (file_exists(rebase_path_squash_msg())) {
781 struct strbuf header = STRBUF_INIT;
782 char *eol, *p;
783
784 if (strbuf_read_file(&buf, rebase_path_squash_msg(), 2048) <= 0)
785 return error(_("could not read '%s'"),
786 rebase_path_squash_msg());
787
788 p = buf.buf + 1;
789 eol = strchrnul(buf.buf, '\n');
790 if (buf.buf[0] != comment_line_char ||
791 (p += strcspn(p, "0123456789\n")) == eol)
792 return error(_("unexpected 1st line of squash message:"
793 "\n\n\t%.*s"),
794 (int)(eol - buf.buf), buf.buf);
795 count = strtol(p, NULL, 10);
796
797 if (count < 1)
798 return error(_("invalid 1st line of squash message:\n"
799 "\n\t%.*s"),
800 (int)(eol - buf.buf), buf.buf);
801
802 strbuf_addf(&header, "%c ", comment_line_char);
803 strbuf_addf(&header,
804 _("This is a combination of %d commits."), ++count);
805 strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
806 strbuf_release(&header);
807 } else {
808 unsigned char head[20];
809 struct commit *head_commit;
810 const char *head_message, *body;
811
812 if (get_sha1("HEAD", head))
813 return error(_("need a HEAD to fixup"));
814 if (!(head_commit = lookup_commit_reference(head)))
815 return error(_("could not read HEAD"));
816 if (!(head_message = get_commit_buffer(head_commit, NULL)))
817 return error(_("could not read HEAD's commit message"));
818
819 find_commit_subject(head_message, &body);
820 if (write_message(body, strlen(body),
821 rebase_path_fixup_msg(), 0)) {
822 unuse_commit_buffer(head_commit, head_message);
823 return error(_("cannot write '%s'"),
824 rebase_path_fixup_msg());
825 }
826
827 count = 2;
828 strbuf_addf(&buf, "%c ", comment_line_char);
829 strbuf_addf(&buf, _("This is a combination of %d commits."),
830 count);
831 strbuf_addf(&buf, "\n%c ", comment_line_char);
832 strbuf_addstr(&buf, _("This is the 1st commit message:"));
833 strbuf_addstr(&buf, "\n\n");
834 strbuf_addstr(&buf, body);
835
836 unuse_commit_buffer(head_commit, head_message);
837 }
838
839 if (!(message = get_commit_buffer(commit, NULL)))
840 return error(_("could not read commit message of %s"),
841 oid_to_hex(&commit->object.oid));
842 find_commit_subject(message, &body);
843
844 if (command == TODO_SQUASH) {
845 unlink(rebase_path_fixup_msg());
846 strbuf_addf(&buf, "\n%c ", comment_line_char);
847 strbuf_addf(&buf, _("This is the commit message #%d:"), count);
848 strbuf_addstr(&buf, "\n\n");
849 strbuf_addstr(&buf, body);
850 } else if (command == TODO_FIXUP) {
851 strbuf_addf(&buf, "\n%c ", comment_line_char);
852 strbuf_addf(&buf, _("The commit message #%d will be skipped:"),
853 count);
854 strbuf_addstr(&buf, "\n\n");
855 strbuf_add_commented_lines(&buf, body, strlen(body));
856 } else
857 return error(_("unknown command: %d"), command);
858 unuse_commit_buffer(commit, message);
859
860 res = write_message(buf.buf, buf.len, rebase_path_squash_msg(), 0);
861 strbuf_release(&buf);
862 return res;
863}
864
25cb8df9
JS
865static void flush_rewritten_pending(void) {
866 struct strbuf buf = STRBUF_INIT;
867 unsigned char newsha1[20];
868 FILE *out;
869
870 if (strbuf_read_file(&buf, rebase_path_rewritten_pending(), 82) > 0 &&
871 !get_sha1("HEAD", newsha1) &&
872 (out = fopen(rebase_path_rewritten_list(), "a"))) {
873 char *bol = buf.buf, *eol;
874
875 while (*bol) {
876 eol = strchrnul(bol, '\n');
877 fprintf(out, "%.*s %s\n", (int)(eol - bol),
878 bol, sha1_to_hex(newsha1));
879 if (!*eol)
880 break;
881 bol = eol + 1;
882 }
883 fclose(out);
884 unlink(rebase_path_rewritten_pending());
885 }
886 strbuf_release(&buf);
887}
888
889static void record_in_rewritten(struct object_id *oid,
890 enum todo_command next_command) {
891 FILE *out = fopen(rebase_path_rewritten_pending(), "a");
892
893 if (!out)
894 return;
895
896 fprintf(out, "%s\n", oid_to_hex(oid));
897 fclose(out);
898
899 if (!is_fixup(next_command))
900 flush_rewritten_pending();
901}
902
004fefa7 903static int do_pick_commit(enum todo_command command, struct commit *commit,
6e98de72 904 struct replay_opts *opts, int final_fixup)
043a4492 905{
6e98de72
JS
906 int edit = opts->edit, cleanup_commit_message = 0;
907 const char *msg_file = edit ? NULL : git_path_merge_msg();
043a4492
RR
908 unsigned char head[20];
909 struct commit *base, *next, *parent;
910 const char *base_label, *next_label;
d74a4e57 911 struct commit_message msg = { NULL, NULL, NULL, NULL };
043a4492 912 struct strbuf msgbuf = STRBUF_INIT;
bcbb68be 913 int res, unborn = 0, amend = 0, allow = 0;
043a4492
RR
914
915 if (opts->no_commit) {
916 /*
917 * We do not intend to commit immediately. We just want to
918 * merge the differences in, so let's compute the tree
919 * that represents the "current" state for merge-recursive
920 * to work on.
921 */
922 if (write_cache_as_tree(head, 0, NULL))
93b3df6f 923 return error(_("your index file is unmerged."));
043a4492 924 } else {
334ae397
MZ
925 unborn = get_sha1("HEAD", head);
926 if (unborn)
927 hashcpy(head, EMPTY_TREE_SHA1_BIN);
018ec3c8 928 if (index_differs_from(unborn ? EMPTY_TREE_SHA1_HEX : "HEAD", 0, 0))
043a4492
RR
929 return error_dirty_index(opts);
930 }
931 discard_cache();
932
637666c8 933 if (!commit->parents)
043a4492 934 parent = NULL;
043a4492
RR
935 else if (commit->parents->next) {
936 /* Reverting or cherry-picking a merge commit */
937 int cnt;
938 struct commit_list *p;
939
940 if (!opts->mainline)
93b3df6f 941 return error(_("commit %s is a merge but no -m option was given."),
f2fd0760 942 oid_to_hex(&commit->object.oid));
043a4492
RR
943
944 for (cnt = 1, p = commit->parents;
945 cnt != opts->mainline && p;
946 cnt++)
947 p = p->next;
948 if (cnt != opts->mainline || !p)
93b3df6f 949 return error(_("commit %s does not have parent %d"),
f2fd0760 950 oid_to_hex(&commit->object.oid), opts->mainline);
043a4492
RR
951 parent = p->item;
952 } else if (0 < opts->mainline)
93b3df6f 953 return error(_("mainline was specified but commit %s is not a merge."),
f2fd0760 954 oid_to_hex(&commit->object.oid));
043a4492
RR
955 else
956 parent = commit->parents->item;
957
bcbb68be
JS
958 if (get_message(commit, &msg) != 0)
959 return error(_("cannot get commit message for %s"),
960 oid_to_hex(&commit->object.oid));
961
6e98de72 962 if (opts->allow_ff && !is_fixup(command) &&
ed1c9977 963 ((parent && !hashcmp(parent->object.oid.hash, head)) ||
bcbb68be
JS
964 (!parent && unborn))) {
965 if (is_rebase_i(opts))
966 write_author_script(msg.message);
967 res = fast_forward_to(commit->object.oid.hash, head, unborn,
968 opts);
969 if (res || command != TODO_REWORD)
970 goto leave;
971 edit = amend = 1;
972 msg_file = NULL;
973 goto fast_forward_edit;
974 }
043a4492 975 if (parent && parse_commit(parent) < 0)
004fefa7
JS
976 /* TRANSLATORS: The first %s will be a "todo" command like
977 "revert" or "pick", the second %s a SHA1. */
043a4492 978 return error(_("%s: cannot parse parent commit %s"),
004fefa7
JS
979 command_to_string(command),
980 oid_to_hex(&parent->object.oid));
043a4492 981
043a4492
RR
982 /*
983 * "commit" is an existing commit. We would want to apply
984 * the difference it introduces since its first parent "prev"
985 * on top of the current HEAD if we are cherry-pick. Or the
986 * reverse of it if we are revert.
987 */
988
004fefa7 989 if (command == TODO_REVERT) {
043a4492
RR
990 base = commit;
991 base_label = msg.label;
992 next = parent;
993 next_label = msg.parent_label;
994 strbuf_addstr(&msgbuf, "Revert \"");
995 strbuf_addstr(&msgbuf, msg.subject);
996 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
f2fd0760 997 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
043a4492
RR
998
999 if (commit->parents && commit->parents->next) {
1000 strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
f2fd0760 1001 strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
043a4492
RR
1002 }
1003 strbuf_addstr(&msgbuf, ".\n");
1004 } else {
1005 const char *p;
1006
1007 base = parent;
1008 base_label = msg.parent_label;
1009 next = commit;
1010 next_label = msg.label;
1011
23aa5142
JS
1012 /* Append the commit log message to msgbuf. */
1013 if (find_commit_subject(msg.message, &p))
1014 strbuf_addstr(&msgbuf, p);
043a4492
RR
1015
1016 if (opts->record_origin) {
bab4d109 1017 if (!has_conforming_footer(&msgbuf, NULL, 0))
b971e04f 1018 strbuf_addch(&msgbuf, '\n');
cd650a4e 1019 strbuf_addstr(&msgbuf, cherry_picked_prefix);
f2fd0760 1020 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
043a4492
RR
1021 strbuf_addstr(&msgbuf, ")\n");
1022 }
1023 }
1024
04efc8b5
JS
1025 if (command == TODO_REWORD)
1026 edit = 1;
1027 else if (is_fixup(command)) {
6e98de72
JS
1028 if (update_squash_messages(command, commit, opts))
1029 return -1;
1030 amend = 1;
1031 if (!final_fixup)
1032 msg_file = rebase_path_squash_msg();
1033 else if (file_exists(rebase_path_fixup_msg())) {
1034 cleanup_commit_message = 1;
1035 msg_file = rebase_path_fixup_msg();
1036 } else {
1037 const char *dest = git_path("SQUASH_MSG");
1038 unlink(dest);
1039 if (copy_file(dest, rebase_path_squash_msg(), 0666))
1040 return error(_("could not rename '%s' to '%s'"),
1041 rebase_path_squash_msg(), dest);
1042 unlink(git_path("MERGE_MSG"));
1043 msg_file = dest;
1044 edit = 1;
1045 }
1046 }
1047
0473f28a
JS
1048 if (is_rebase_i(opts) && write_author_script(msg.message) < 0)
1049 res = -1;
1050 else if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
043a4492
RR
1051 res = do_recursive_merge(base, next, base_label, next_label,
1052 head, &msgbuf, opts);
f241ff0d
JS
1053 if (res < 0)
1054 return res;
75871495 1055 res |= write_message(msgbuf.buf, msgbuf.len,
f56fffef 1056 git_path_merge_msg(), 0);
043a4492
RR
1057 } else {
1058 struct commit_list *common = NULL;
1059 struct commit_list *remotes = NULL;
1060
75871495 1061 res = write_message(msgbuf.buf, msgbuf.len,
f56fffef 1062 git_path_merge_msg(), 0);
043a4492
RR
1063
1064 commit_list_insert(base, &common);
1065 commit_list_insert(next, &remotes);
03a4e260
JS
1066 res |= try_merge_command(opts->strategy,
1067 opts->xopts_nr, (const char **)opts->xopts,
043a4492
RR
1068 common, sha1_to_hex(head), remotes);
1069 free_commit_list(common);
1070 free_commit_list(remotes);
1071 }
452202c7 1072 strbuf_release(&msgbuf);
043a4492
RR
1073
1074 /*
1075 * If the merge was clean or if it failed due to conflict, we write
1076 * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
1077 * However, if the merge did not even start, then we don't want to
1078 * write it at all.
1079 */
004fefa7 1080 if (command == TODO_PICK && !opts->no_commit && (res == 0 || res == 1) &&
dbfad033
JS
1081 update_ref(NULL, "CHERRY_PICK_HEAD", commit->object.oid.hash, NULL,
1082 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
1083 res = -1;
004fefa7 1084 if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
dbfad033
JS
1085 update_ref(NULL, "REVERT_HEAD", commit->object.oid.hash, NULL,
1086 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
1087 res = -1;
043a4492
RR
1088
1089 if (res) {
004fefa7 1090 error(command == TODO_REVERT
043a4492
RR
1091 ? _("could not revert %s... %s")
1092 : _("could not apply %s... %s"),
39755964 1093 short_commit_name(commit), msg.subject);
ed727b19 1094 print_advice(res == 1, opts);
043a4492 1095 rerere(opts->allow_rerere_auto);
c8d1351d 1096 goto leave;
043a4492
RR
1097 }
1098
c8d1351d 1099 allow = allow_empty(opts, commit);
706728a3
FC
1100 if (allow < 0) {
1101 res = allow;
1102 goto leave;
1103 }
c8d1351d 1104 if (!opts->no_commit)
bcbb68be 1105fast_forward_edit:
6e98de72
JS
1106 res = run_git_commit(msg_file, opts, allow, edit, amend,
1107 cleanup_commit_message);
1108
1109 if (!res && final_fixup) {
1110 unlink(rebase_path_fixup_msg());
1111 unlink(rebase_path_squash_msg());
1112 }
c8d1351d
FC
1113
1114leave:
d74a4e57 1115 free_message(commit, &msg);
1e41229d 1116 update_abort_safety_file();
043a4492
RR
1117
1118 return res;
1119}
1120
c3e8618c 1121static int prepare_revs(struct replay_opts *opts)
043a4492 1122{
a73e22e9
MZ
1123 /*
1124 * picking (but not reverting) ranges (but not individual revisions)
1125 * should be done in reverse
1126 */
1127 if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
043a4492
RR
1128 opts->revs->reverse ^= 1;
1129
1130 if (prepare_revision_walk(opts->revs))
c3e8618c 1131 return error(_("revision walk setup failed"));
043a4492
RR
1132
1133 if (!opts->revs->commits)
c3e8618c
JS
1134 return error(_("empty commit set passed"));
1135 return 0;
043a4492
RR
1136}
1137
0d9c6dc9 1138static int read_and_refresh_cache(struct replay_opts *opts)
043a4492
RR
1139{
1140 static struct lock_file index_lock;
1141 int index_fd = hold_locked_index(&index_lock, 0);
49fb937e
JS
1142 if (read_index_preload(&the_index, NULL) < 0) {
1143 rollback_lock_file(&index_lock);
0d9c6dc9 1144 return error(_("git %s: failed to read the index"),
c28cbc5e 1145 _(action_name(opts)));
49fb937e 1146 }
043a4492 1147 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
33c297aa 1148 if (the_index.cache_changed && index_fd >= 0) {
49fb937e
JS
1149 if (write_locked_index(&the_index, &index_lock, COMMIT_LOCK)) {
1150 rollback_lock_file(&index_lock);
0d9c6dc9 1151 return error(_("git %s: failed to refresh the index"),
c28cbc5e 1152 _(action_name(opts)));
49fb937e 1153 }
043a4492
RR
1154 }
1155 rollback_lock_file(&index_lock);
0d9c6dc9 1156 return 0;
043a4492
RR
1157}
1158
004fefa7
JS
1159struct todo_item {
1160 enum todo_command command;
1161 struct commit *commit;
c22f7dfb
JS
1162 const char *arg;
1163 int arg_len;
004fefa7
JS
1164 size_t offset_in_buf;
1165};
1166
1167struct todo_list {
1168 struct strbuf buf;
1169 struct todo_item *items;
1170 int nr, alloc, current;
1171};
1172
1173#define TODO_LIST_INIT { STRBUF_INIT }
1174
1175static void todo_list_release(struct todo_list *todo_list)
043a4492 1176{
004fefa7
JS
1177 strbuf_release(&todo_list->buf);
1178 free(todo_list->items);
1179 todo_list->items = NULL;
1180 todo_list->nr = todo_list->alloc = 0;
1181}
043a4492 1182
004fefa7
JS
1183static struct todo_item *append_new_todo(struct todo_list *todo_list)
1184{
1185 ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
1186 return todo_list->items + todo_list->nr++;
043a4492
RR
1187}
1188
004fefa7 1189static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
043a4492
RR
1190{
1191 unsigned char commit_sha1[20];
043a4492 1192 char *end_of_object_name;
004fefa7
JS
1193 int i, saved, status, padding;
1194
8f8550b3
JS
1195 /* left-trim */
1196 bol += strspn(bol, " \t");
1197
25c43667
JS
1198 if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
1199 item->command = TODO_NOOP;
1200 item->commit = NULL;
1201 item->arg = bol;
1202 item->arg_len = eol - bol;
1203 return 0;
1204 }
1205
414697a9
JS
1206 for (i = 0; i < ARRAY_SIZE(todo_command_info); i++)
1207 if (skip_prefix(bol, todo_command_info[i].str, &bol)) {
1208 item->command = i;
1209 break;
1210 } else if (bol[1] == ' ' && *bol == todo_command_info[i].c) {
1211 bol++;
004fefa7
JS
1212 item->command = i;
1213 break;
1214 }
414697a9 1215 if (i >= ARRAY_SIZE(todo_command_info))
004fefa7 1216 return -1;
043a4492 1217
25c43667
JS
1218 if (item->command == TODO_NOOP) {
1219 item->commit = NULL;
1220 item->arg = bol;
1221 item->arg_len = eol - bol;
1222 return 0;
1223 }
1224
043a4492
RR
1225 /* Eat up extra spaces/ tabs before object name */
1226 padding = strspn(bol, " \t");
1227 if (!padding)
004fefa7 1228 return -1;
043a4492
RR
1229 bol += padding;
1230
311af526
JS
1231 if (item->command == TODO_EXEC) {
1232 item->arg = bol;
1233 item->arg_len = (int)(eol - bol);
1234 return 0;
1235 }
1236
004fefa7 1237 end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
043a4492
RR
1238 saved = *end_of_object_name;
1239 *end_of_object_name = '\0';
1240 status = get_sha1(bol, commit_sha1);
1241 *end_of_object_name = saved;
1242
c22f7dfb
JS
1243 item->arg = end_of_object_name + strspn(end_of_object_name, " \t");
1244 item->arg_len = (int)(eol - item->arg);
1245
043a4492 1246 if (status < 0)
004fefa7 1247 return -1;
043a4492 1248
004fefa7
JS
1249 item->commit = lookup_commit_reference(commit_sha1);
1250 return !item->commit;
043a4492
RR
1251}
1252
004fefa7 1253static int parse_insn_buffer(char *buf, struct todo_list *todo_list)
043a4492 1254{
004fefa7
JS
1255 struct todo_item *item;
1256 char *p = buf, *next_p;
6e98de72 1257 int i, res = 0, fixup_okay = file_exists(rebase_path_done());
043a4492 1258
004fefa7 1259 for (i = 1; *p; i++, p = next_p) {
043a4492 1260 char *eol = strchrnul(p, '\n');
004fefa7
JS
1261
1262 next_p = *eol ? eol + 1 /* skip LF */ : eol;
1263
6307041d
JS
1264 if (p != eol && eol[-1] == '\r')
1265 eol--; /* strip Carriage Return */
1266
004fefa7
JS
1267 item = append_new_todo(todo_list);
1268 item->offset_in_buf = p - todo_list->buf.buf;
1269 if (parse_insn_line(item, p, eol)) {
93b3df6f 1270 res = error(_("invalid line %d: %.*s"),
004fefa7 1271 i, (int)(eol - p), p);
6e98de72 1272 item->command = TODO_NOOP;
004fefa7 1273 }
6e98de72
JS
1274
1275 if (fixup_okay)
1276 ; /* do nothing */
1277 else if (is_fixup(item->command))
1278 return error(_("cannot '%s' without a previous commit"),
1279 command_to_string(item->command));
1280 else if (!is_noop(item->command))
1281 fixup_okay = 1;
043a4492 1282 }
52865279 1283
004fefa7 1284 return res;
043a4492
RR
1285}
1286
004fefa7 1287static int read_populate_todo(struct todo_list *todo_list,
043a4492
RR
1288 struct replay_opts *opts)
1289{
c0246501 1290 const char *todo_file = get_todo_path(opts);
043a4492
RR
1291 int fd, res;
1292
004fefa7 1293 strbuf_reset(&todo_list->buf);
c0246501 1294 fd = open(todo_file, O_RDONLY);
043a4492 1295 if (fd < 0)
93b3df6f 1296 return error_errno(_("could not open '%s'"), todo_file);
004fefa7 1297 if (strbuf_read(&todo_list->buf, fd, 0) < 0) {
043a4492 1298 close(fd);
93b3df6f 1299 return error(_("could not read '%s'."), todo_file);
043a4492
RR
1300 }
1301 close(fd);
1302
004fefa7 1303 res = parse_insn_buffer(todo_list->buf.buf, todo_list);
2eeaf1b3 1304 if (res)
93b3df6f 1305 return error(_("unusable instruction sheet: '%s'"), todo_file);
2eeaf1b3 1306
52865279
JS
1307 if (!todo_list->nr &&
1308 (!is_rebase_i(opts) || !file_exists(rebase_path_done())))
1309 return error(_("no commits parsed."));
1310
2eeaf1b3 1311 if (!is_rebase_i(opts)) {
004fefa7
JS
1312 enum todo_command valid =
1313 opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
1314 int i;
1315
1316 for (i = 0; i < todo_list->nr; i++)
1317 if (valid == todo_list->items[i].command)
1318 continue;
1319 else if (valid == TODO_PICK)
93b3df6f 1320 return error(_("cannot cherry-pick during a revert."));
004fefa7 1321 else
93b3df6f 1322 return error(_("cannot revert during a cherry-pick."));
004fefa7
JS
1323 }
1324
0ae42a03 1325 return 0;
043a4492
RR
1326}
1327
03a4e260
JS
1328static int git_config_string_dup(char **dest,
1329 const char *var, const char *value)
1330{
1331 if (!value)
1332 return config_error_nonbool(var);
1333 free(*dest);
1334 *dest = xstrdup(value);
1335 return 0;
1336}
1337
043a4492
RR
1338static int populate_opts_cb(const char *key, const char *value, void *data)
1339{
1340 struct replay_opts *opts = data;
1341 int error_flag = 1;
1342
1343 if (!value)
1344 error_flag = 0;
1345 else if (!strcmp(key, "options.no-commit"))
1346 opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
1347 else if (!strcmp(key, "options.edit"))
1348 opts->edit = git_config_bool_or_int(key, value, &error_flag);
1349 else if (!strcmp(key, "options.signoff"))
1350 opts->signoff = git_config_bool_or_int(key, value, &error_flag);
1351 else if (!strcmp(key, "options.record-origin"))
1352 opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
1353 else if (!strcmp(key, "options.allow-ff"))
1354 opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
1355 else if (!strcmp(key, "options.mainline"))
1356 opts->mainline = git_config_int(key, value);
1357 else if (!strcmp(key, "options.strategy"))
03a4e260 1358 git_config_string_dup(&opts->strategy, key, value);
3253553e 1359 else if (!strcmp(key, "options.gpg-sign"))
03a4e260 1360 git_config_string_dup(&opts->gpg_sign, key, value);
043a4492
RR
1361 else if (!strcmp(key, "options.strategy-option")) {
1362 ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
1363 opts->xopts[opts->xopts_nr++] = xstrdup(value);
1364 } else
93b3df6f 1365 return error(_("invalid key: %s"), key);
043a4492
RR
1366
1367 if (!error_flag)
93b3df6f 1368 return error(_("invalid value for %s: %s"), key, value);
043a4492
RR
1369
1370 return 0;
1371}
1372
ca6c6b45
JS
1373static void read_strategy_opts(struct replay_opts *opts, struct strbuf *buf)
1374{
1375 int i;
1376
1377 strbuf_reset(buf);
1378 if (!read_oneliner(buf, rebase_path_strategy(), 0))
1379 return;
1380 opts->strategy = strbuf_detach(buf, NULL);
1381 if (!read_oneliner(buf, rebase_path_strategy_opts(), 0))
1382 return;
1383
1384 opts->xopts_nr = split_cmdline(buf->buf, (const char ***)&opts->xopts);
1385 for (i = 0; i < opts->xopts_nr; i++) {
1386 const char *arg = opts->xopts[i];
1387
1388 skip_prefix(arg, "--", &arg);
1389 opts->xopts[i] = xstrdup(arg);
1390 }
1391}
1392
5adf9bdc 1393static int read_populate_opts(struct replay_opts *opts)
043a4492 1394{
a1c75762
JS
1395 if (is_rebase_i(opts)) {
1396 struct strbuf buf = STRBUF_INIT;
1397
1398 if (read_oneliner(&buf, rebase_path_gpg_sign_opt(), 1)) {
1399 if (!starts_with(buf.buf, "-S"))
1400 strbuf_reset(&buf);
1401 else {
1402 free(opts->gpg_sign);
1403 opts->gpg_sign = xstrdup(buf.buf + 2);
1404 }
1405 }
a1c75762 1406
556907f1
JS
1407 if (file_exists(rebase_path_verbose()))
1408 opts->verbose = 1;
1409
ca6c6b45
JS
1410 read_strategy_opts(opts, &buf);
1411 strbuf_release(&buf);
1412
b5a67045 1413 return 0;
a1c75762 1414 }
b5a67045 1415
f932729c 1416 if (!file_exists(git_path_opts_file()))
0d00da7b
JS
1417 return 0;
1418 /*
1419 * The function git_parse_source(), called from git_config_from_file(),
1420 * may die() in case of a syntactically incorrect file. We do not care
1421 * about this case, though, because we wrote that file ourselves, so we
1422 * are pretty certain that it is syntactically correct.
1423 */
5adf9bdc 1424 if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
93b3df6f 1425 return error(_("malformed options sheet: '%s'"),
0d00da7b
JS
1426 git_path_opts_file());
1427 return 0;
043a4492
RR
1428}
1429
004fefa7 1430static int walk_revs_populate_todo(struct todo_list *todo_list,
043a4492
RR
1431 struct replay_opts *opts)
1432{
004fefa7
JS
1433 enum todo_command command = opts->action == REPLAY_PICK ?
1434 TODO_PICK : TODO_REVERT;
414697a9 1435 const char *command_string = todo_command_info[command].str;
043a4492 1436 struct commit *commit;
043a4492 1437
34b0528b
JS
1438 if (prepare_revs(opts))
1439 return -1;
043a4492 1440
004fefa7
JS
1441 while ((commit = get_revision(opts->revs))) {
1442 struct todo_item *item = append_new_todo(todo_list);
1443 const char *commit_buffer = get_commit_buffer(commit, NULL);
1444 const char *subject;
1445 int subject_len;
1446
1447 item->command = command;
1448 item->commit = commit;
c22f7dfb
JS
1449 item->arg = NULL;
1450 item->arg_len = 0;
004fefa7
JS
1451 item->offset_in_buf = todo_list->buf.len;
1452 subject_len = find_commit_subject(commit_buffer, &subject);
1453 strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
1454 short_commit_name(commit), subject_len, subject);
1455 unuse_commit_buffer(commit, commit_buffer);
1456 }
34b0528b 1457 return 0;
043a4492
RR
1458}
1459
1460static int create_seq_dir(void)
1461{
f932729c 1462 if (file_exists(git_path_seq_dir())) {
043a4492
RR
1463 error(_("a cherry-pick or revert is already in progress"));
1464 advise(_("try \"git cherry-pick (--continue | --quit | --abort)\""));
1465 return -1;
a70d8f80 1466 } else if (mkdir(git_path_seq_dir(), 0777) < 0)
93b3df6f 1467 return error_errno(_("could not create sequencer directory '%s'"),
f6e82b0d 1468 git_path_seq_dir());
043a4492
RR
1469 return 0;
1470}
1471
311fd397 1472static int save_head(const char *head)
043a4492 1473{
043a4492
RR
1474 static struct lock_file head_lock;
1475 struct strbuf buf = STRBUF_INIT;
1476 int fd;
1477
311fd397
JS
1478 fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
1479 if (fd < 0) {
1480 rollback_lock_file(&head_lock);
93b3df6f 1481 return error_errno(_("could not lock HEAD"));
311fd397 1482 }
043a4492 1483 strbuf_addf(&buf, "%s\n", head);
311fd397
JS
1484 if (write_in_full(fd, buf.buf, buf.len) < 0) {
1485 rollback_lock_file(&head_lock);
93b3df6f 1486 return error_errno(_("could not write to '%s'"),
311fd397
JS
1487 git_path_head_file());
1488 }
1489 if (commit_lock_file(&head_lock) < 0) {
1490 rollback_lock_file(&head_lock);
93b3df6f 1491 return error(_("failed to finalize '%s'."), git_path_head_file());
311fd397
JS
1492 }
1493 return 0;
043a4492
RR
1494}
1495
1e41229d
SB
1496static int rollback_is_safe(void)
1497{
1498 struct strbuf sb = STRBUF_INIT;
1499 struct object_id expected_head, actual_head;
1500
1501 if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
1502 strbuf_trim(&sb);
1503 if (get_oid_hex(sb.buf, &expected_head)) {
1504 strbuf_release(&sb);
1505 die(_("could not parse %s"), git_path_abort_safety_file());
1506 }
1507 strbuf_release(&sb);
1508 }
1509 else if (errno == ENOENT)
1510 oidclr(&expected_head);
1511 else
1512 die_errno(_("could not read '%s'"), git_path_abort_safety_file());
1513
1514 if (get_oid("HEAD", &actual_head))
1515 oidclr(&actual_head);
1516
1517 return !oidcmp(&actual_head, &expected_head);
1518}
1519
043a4492
RR
1520static int reset_for_rollback(const unsigned char *sha1)
1521{
1522 const char *argv[4]; /* reset --merge <arg> + NULL */
1e41229d 1523
043a4492
RR
1524 argv[0] = "reset";
1525 argv[1] = "--merge";
1526 argv[2] = sha1_to_hex(sha1);
1527 argv[3] = NULL;
1528 return run_command_v_opt(argv, RUN_GIT_CMD);
1529}
1530
1531static int rollback_single_pick(void)
1532{
1533 unsigned char head_sha1[20];
1534
f932729c
JK
1535 if (!file_exists(git_path_cherry_pick_head()) &&
1536 !file_exists(git_path_revert_head()))
043a4492 1537 return error(_("no cherry-pick or revert in progress"));
7695d118 1538 if (read_ref_full("HEAD", 0, head_sha1, NULL))
043a4492
RR
1539 return error(_("cannot resolve HEAD"));
1540 if (is_null_sha1(head_sha1))
1541 return error(_("cannot abort from a branch yet to be born"));
1542 return reset_for_rollback(head_sha1);
1543}
1544
2863584f 1545int sequencer_rollback(struct replay_opts *opts)
043a4492 1546{
043a4492
RR
1547 FILE *f;
1548 unsigned char sha1[20];
1549 struct strbuf buf = STRBUF_INIT;
1550
f932729c 1551 f = fopen(git_path_head_file(), "r");
043a4492
RR
1552 if (!f && errno == ENOENT) {
1553 /*
1554 * There is no multiple-cherry-pick in progress.
1555 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
1556 * a single-cherry-pick in progress, abort that.
1557 */
1558 return rollback_single_pick();
1559 }
1560 if (!f)
f7ed1953 1561 return error_errno(_("cannot open '%s'"), git_path_head_file());
8f309aeb 1562 if (strbuf_getline_lf(&buf, f)) {
f7ed1953 1563 error(_("cannot read '%s': %s"), git_path_head_file(),
f932729c 1564 ferror(f) ? strerror(errno) : _("unexpected end of file"));
043a4492
RR
1565 fclose(f);
1566 goto fail;
1567 }
1568 fclose(f);
1569 if (get_sha1_hex(buf.buf, sha1) || buf.buf[40] != '\0') {
1570 error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
f932729c 1571 git_path_head_file());
043a4492
RR
1572 goto fail;
1573 }
0f974e21
MG
1574 if (is_null_sha1(sha1)) {
1575 error(_("cannot abort from a branch yet to be born"));
1576 goto fail;
1577 }
1e41229d
SB
1578
1579 if (!rollback_is_safe()) {
1580 /* Do not error, just do not rollback */
1581 warning(_("You seem to have moved HEAD. "
1582 "Not rewinding, check your HEAD!"));
1583 } else
043a4492
RR
1584 if (reset_for_rollback(sha1))
1585 goto fail;
043a4492 1586 strbuf_release(&buf);
2863584f 1587 return sequencer_remove_state(opts);
043a4492
RR
1588fail:
1589 strbuf_release(&buf);
1590 return -1;
1591}
1592
004fefa7 1593static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
043a4492 1594{
043a4492 1595 static struct lock_file todo_lock;
004fefa7
JS
1596 const char *todo_path = get_todo_path(opts);
1597 int next = todo_list->current, offset, fd;
043a4492 1598
84583957
JS
1599 /*
1600 * rebase -i writes "git-rebase-todo" without the currently executing
1601 * command, appending it to "done" instead.
1602 */
1603 if (is_rebase_i(opts))
1604 next++;
1605
004fefa7 1606 fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
221675de 1607 if (fd < 0)
93b3df6f 1608 return error_errno(_("could not lock '%s'"), todo_path);
004fefa7
JS
1609 offset = next < todo_list->nr ?
1610 todo_list->items[next].offset_in_buf : todo_list->buf.len;
1611 if (write_in_full(fd, todo_list->buf.buf + offset,
1612 todo_list->buf.len - offset) < 0)
93b3df6f 1613 return error_errno(_("could not write to '%s'"), todo_path);
004fefa7 1614 if (commit_lock_file(&todo_lock) < 0)
93b3df6f 1615 return error(_("failed to finalize '%s'."), todo_path);
1df6df0c
JS
1616
1617 if (is_rebase_i(opts)) {
1618 const char *done_path = rebase_path_done();
1619 int fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
1620 int prev_offset = !next ? 0 :
1621 todo_list->items[next - 1].offset_in_buf;
1622
1623 if (fd >= 0 && offset > prev_offset &&
1624 write_in_full(fd, todo_list->buf.buf + prev_offset,
1625 offset - prev_offset) < 0) {
1626 close(fd);
1627 return error_errno(_("could not write to '%s'"),
1628 done_path);
1629 }
1630 if (fd >= 0)
1631 close(fd);
1632 }
221675de 1633 return 0;
043a4492
RR
1634}
1635
88d5a271 1636static int save_opts(struct replay_opts *opts)
043a4492 1637{
f932729c 1638 const char *opts_file = git_path_opts_file();
88d5a271 1639 int res = 0;
043a4492
RR
1640
1641 if (opts->no_commit)
88d5a271 1642 res |= git_config_set_in_file_gently(opts_file, "options.no-commit", "true");
043a4492 1643 if (opts->edit)
88d5a271 1644 res |= git_config_set_in_file_gently(opts_file, "options.edit", "true");
043a4492 1645 if (opts->signoff)
88d5a271 1646 res |= git_config_set_in_file_gently(opts_file, "options.signoff", "true");
043a4492 1647 if (opts->record_origin)
88d5a271 1648 res |= git_config_set_in_file_gently(opts_file, "options.record-origin", "true");
043a4492 1649 if (opts->allow_ff)
88d5a271 1650 res |= git_config_set_in_file_gently(opts_file, "options.allow-ff", "true");
043a4492
RR
1651 if (opts->mainline) {
1652 struct strbuf buf = STRBUF_INIT;
1653 strbuf_addf(&buf, "%d", opts->mainline);
88d5a271 1654 res |= git_config_set_in_file_gently(opts_file, "options.mainline", buf.buf);
043a4492
RR
1655 strbuf_release(&buf);
1656 }
1657 if (opts->strategy)
88d5a271 1658 res |= git_config_set_in_file_gently(opts_file, "options.strategy", opts->strategy);
3253553e 1659 if (opts->gpg_sign)
88d5a271 1660 res |= git_config_set_in_file_gently(opts_file, "options.gpg-sign", opts->gpg_sign);
043a4492
RR
1661 if (opts->xopts) {
1662 int i;
1663 for (i = 0; i < opts->xopts_nr; i++)
88d5a271 1664 res |= git_config_set_multivar_in_file_gently(opts_file,
043a4492
RR
1665 "options.strategy-option",
1666 opts->xopts[i], "^$", 0);
1667 }
88d5a271 1668 return res;
043a4492
RR
1669}
1670
56dc3ab0
JS
1671static int make_patch(struct commit *commit, struct replay_opts *opts)
1672{
1673 struct strbuf buf = STRBUF_INIT;
1674 struct rev_info log_tree_opt;
1675 const char *subject, *p;
1676 int res = 0;
1677
1678 p = short_commit_name(commit);
1679 if (write_message(p, strlen(p), rebase_path_stopped_sha(), 1) < 0)
1680 return -1;
1681
1682 strbuf_addf(&buf, "%s/patch", get_dir(opts));
1683 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
1684 init_revisions(&log_tree_opt, NULL);
1685 log_tree_opt.abbrev = 0;
1686 log_tree_opt.diff = 1;
1687 log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
1688 log_tree_opt.disable_stdin = 1;
1689 log_tree_opt.no_commit_id = 1;
1690 log_tree_opt.diffopt.file = fopen(buf.buf, "w");
1691 log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
1692 if (!log_tree_opt.diffopt.file)
1693 res |= error_errno(_("could not open '%s'"), buf.buf);
1694 else {
1695 res |= log_tree_commit(&log_tree_opt, commit);
1696 fclose(log_tree_opt.diffopt.file);
1697 }
1698 strbuf_reset(&buf);
1699
1700 strbuf_addf(&buf, "%s/message", get_dir(opts));
1701 if (!file_exists(buf.buf)) {
1702 const char *commit_buffer = get_commit_buffer(commit, NULL);
1703 find_commit_subject(commit_buffer, &subject);
1704 res |= write_message(subject, strlen(subject), buf.buf, 1);
1705 unuse_commit_buffer(commit, commit_buffer);
1706 }
1707 strbuf_release(&buf);
1708
1709 return res;
1710}
1711
1712static int intend_to_amend(void)
1713{
1714 unsigned char head[20];
1715 char *p;
1716
1717 if (get_sha1("HEAD", head))
1718 return error(_("cannot read HEAD"));
1719
1720 p = sha1_to_hex(head);
1721 return write_message(p, strlen(p), rebase_path_amend(), 1);
1722}
1723
1724static int error_with_patch(struct commit *commit,
1725 const char *subject, int subject_len,
1726 struct replay_opts *opts, int exit_code, int to_amend)
1727{
1728 if (make_patch(commit, opts))
1729 return -1;
1730
1731 if (to_amend) {
1732 if (intend_to_amend())
1733 return -1;
1734
1735 fprintf(stderr, "You can amend the commit now, with\n"
1736 "\n"
1737 " git commit --amend %s\n"
1738 "\n"
1739 "Once you are satisfied with your changes, run\n"
1740 "\n"
1741 " git rebase --continue\n", gpg_sign_opt_quoted(opts));
1742 } else if (exit_code)
1743 fprintf(stderr, "Could not apply %s... %.*s\n",
1744 short_commit_name(commit), subject_len, subject);
1745
1746 return exit_code;
1747}
1748
6e98de72
JS
1749static int error_failed_squash(struct commit *commit,
1750 struct replay_opts *opts, int subject_len, const char *subject)
1751{
1752 if (rename(rebase_path_squash_msg(), rebase_path_message()))
1753 return error(_("could not rename '%s' to '%s'"),
1754 rebase_path_squash_msg(), rebase_path_message());
1755 unlink(rebase_path_fixup_msg());
1756 unlink(git_path("MERGE_MSG"));
1757 if (copy_file(git_path("MERGE_MSG"), rebase_path_message(), 0666))
1758 return error(_("could not copy '%s' to '%s'"),
1759 rebase_path_message(), git_path("MERGE_MSG"));
1760 return error_with_patch(commit, subject, subject_len, opts, 1, 0);
1761}
1762
311af526
JS
1763static int do_exec(const char *command_line)
1764{
1765 const char *child_argv[] = { NULL, NULL };
1766 int dirty, status;
1767
1768 fprintf(stderr, "Executing: %s\n", command_line);
1769 child_argv[0] = command_line;
1770 status = run_command_v_opt(child_argv, RUN_USING_SHELL);
1771
1772 /* force re-reading of the cache */
1773 if (discard_cache() < 0 || read_cache() < 0)
1774 return error(_("could not read index"));
1775
1776 dirty = require_clean_work_tree("rebase", NULL, 1, 1);
1777
1778 if (status) {
1779 warning(_("execution failed: %s\n%s"
1780 "You can fix the problem, and then run\n"
1781 "\n"
1782 " git rebase --continue\n"
1783 "\n"),
1784 command_line,
1785 dirty ? N_("and made changes to the index and/or the "
1786 "working tree\n") : "");
1787 if (status == 127)
1788 /* command not found */
1789 status = 1;
1790 } else if (dirty) {
1791 warning(_("execution succeeded: %s\nbut "
1792 "left changes to the index and/or the working tree\n"
1793 "Commit or stash your changes, and then run\n"
1794 "\n"
1795 " git rebase --continue\n"
1796 "\n"), command_line);
1797 status = 1;
1798 }
1799
1800 return status;
1801}
1802
6e98de72
JS
1803static int is_final_fixup(struct todo_list *todo_list)
1804{
1805 int i = todo_list->current;
1806
1807 if (!is_fixup(todo_list->items[i].command))
1808 return 0;
1809
1810 while (++i < todo_list->nr)
1811 if (is_fixup(todo_list->items[i].command))
1812 return 0;
1813 else if (!is_noop(todo_list->items[i].command))
1814 break;
1815 return 1;
1816}
1817
25cb8df9
JS
1818static enum todo_command peek_command(struct todo_list *todo_list, int offset)
1819{
1820 int i;
1821
1822 for (i = todo_list->current + offset; i < todo_list->nr; i++)
1823 if (!is_noop(todo_list->items[i].command))
1824 return todo_list->items[i].command;
1825
1826 return -1;
1827}
1828
796c7972
JS
1829static int apply_autostash(struct replay_opts *opts)
1830{
1831 struct strbuf stash_sha1 = STRBUF_INIT;
1832 struct child_process child = CHILD_PROCESS_INIT;
1833 int ret = 0;
1834
1835 if (!read_oneliner(&stash_sha1, rebase_path_autostash(), 1)) {
1836 strbuf_release(&stash_sha1);
1837 return 0;
1838 }
1839 strbuf_trim(&stash_sha1);
1840
1841 child.git_cmd = 1;
1842 argv_array_push(&child.args, "stash");
1843 argv_array_push(&child.args, "apply");
1844 argv_array_push(&child.args, stash_sha1.buf);
1845 if (!run_command(&child))
1846 printf(_("Applied autostash."));
1847 else {
1848 struct child_process store = CHILD_PROCESS_INIT;
1849
1850 store.git_cmd = 1;
1851 argv_array_push(&store.args, "stash");
1852 argv_array_push(&store.args, "store");
1853 argv_array_push(&store.args, "-m");
1854 argv_array_push(&store.args, "autostash");
1855 argv_array_push(&store.args, "-q");
1856 argv_array_push(&store.args, stash_sha1.buf);
1857 if (run_command(&store))
1858 ret = error(_("cannot store %s"), stash_sha1.buf);
1859 else
1860 printf(_("Applying autostash resulted in conflicts.\n"
1861 "Your changes are safe in the stash.\n"
1862 "You can run \"git stash pop\" or"
1863 " \"git stash drop\" at any time.\n"));
1864 }
1865
1866 strbuf_release(&stash_sha1);
1867 return ret;
1868}
1869
96e832a5
JS
1870static const char *reflog_message(struct replay_opts *opts,
1871 const char *sub_action, const char *fmt, ...)
1872{
1873 va_list ap;
1874 static struct strbuf buf = STRBUF_INIT;
1875
1876 va_start(ap, fmt);
1877 strbuf_reset(&buf);
1878 strbuf_addstr(&buf, action_name(opts));
1879 if (sub_action)
1880 strbuf_addf(&buf, " (%s)", sub_action);
1881 if (fmt) {
1882 strbuf_addstr(&buf, ": ");
1883 strbuf_vaddf(&buf, fmt, ap);
1884 }
1885 va_end(ap);
1886
1887 return buf.buf;
1888}
1889
004fefa7 1890static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
043a4492 1891{
56dc3ab0 1892 int res = 0;
043a4492
RR
1893
1894 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
1895 if (opts->allow_ff)
1896 assert(!(opts->signoff || opts->no_commit ||
1897 opts->record_origin || opts->edit));
0d9c6dc9
JS
1898 if (read_and_refresh_cache(opts))
1899 return -1;
043a4492 1900
004fefa7
JS
1901 while (todo_list->current < todo_list->nr) {
1902 struct todo_item *item = todo_list->items + todo_list->current;
1903 if (save_todo(todo_list, opts))
221675de 1904 return -1;
6e98de72
JS
1905 if (is_rebase_i(opts)) {
1906 unlink(rebase_path_message());
1907 unlink(rebase_path_author_script());
1908 unlink(rebase_path_stopped_sha());
1909 unlink(rebase_path_amend());
1910 }
1911 if (item->command <= TODO_SQUASH) {
8ab37ef2
JS
1912 if (is_rebase_i(opts))
1913 setenv("GIT_REFLOG_ACTION", reflog_message(opts,
1914 command_to_string(item->command), NULL),
1915 1);
25c43667 1916 res = do_pick_commit(item->command, item->commit,
6e98de72 1917 opts, is_final_fixup(todo_list));
56dc3ab0
JS
1918 if (item->command == TODO_EDIT) {
1919 struct commit *commit = item->commit;
1920 if (!res)
1921 warning(_("stopped at %s... %.*s"),
1922 short_commit_name(commit),
1923 item->arg_len, item->arg);
1924 return error_with_patch(commit,
1925 item->arg, item->arg_len, opts, res,
1926 !res);
1927 }
25cb8df9
JS
1928 if (is_rebase_i(opts) && !res)
1929 record_in_rewritten(&item->commit->object.oid,
1930 peek_command(todo_list, 1));
6e98de72
JS
1931 if (res && is_fixup(item->command)) {
1932 if (res == 1)
1933 intend_to_amend();
1934 return error_failed_squash(item->commit, opts,
1935 item->arg_len, item->arg);
4a5146f9
JS
1936 } else if (res && is_rebase_i(opts))
1937 return res | error_with_patch(item->commit,
04efc8b5
JS
1938 item->arg, item->arg_len, opts, res,
1939 item->command == TODO_REWORD);
311af526
JS
1940 } else if (item->command == TODO_EXEC) {
1941 char *end_of_arg = (char *)(item->arg + item->arg_len);
1942 int saved = *end_of_arg;
1943
1944 *end_of_arg = '\0';
1945 res = do_exec(item->arg);
1946 *end_of_arg = saved;
56dc3ab0 1947 } else if (!is_noop(item->command))
25c43667
JS
1948 return error(_("unknown command %d"), item->command);
1949
004fefa7 1950 todo_list->current++;
043a4492
RR
1951 if (res)
1952 return res;
1953 }
1954
56dc3ab0 1955 if (is_rebase_i(opts)) {
4b83ce9f 1956 struct strbuf head_ref = STRBUF_INIT, buf = STRBUF_INIT;
25cb8df9 1957 struct stat st;
556907f1 1958
56dc3ab0
JS
1959 /* Stopped in the middle, as planned? */
1960 if (todo_list->current < todo_list->nr)
1961 return 0;
556907f1 1962
4b83ce9f
JS
1963 if (read_oneliner(&head_ref, rebase_path_head_name(), 0) &&
1964 starts_with(head_ref.buf, "refs/")) {
96e832a5 1965 const char *msg;
4b83ce9f
JS
1966 unsigned char head[20], orig[20];
1967 int res;
1968
1969 if (get_sha1("HEAD", head)) {
1970 res = error(_("cannot read HEAD"));
1971cleanup_head_ref:
1972 strbuf_release(&head_ref);
1973 strbuf_release(&buf);
1974 return res;
1975 }
1976 if (!read_oneliner(&buf, rebase_path_orig_head(), 0) ||
1977 get_sha1_hex(buf.buf, orig)) {
1978 res = error(_("could not read orig-head"));
1979 goto cleanup_head_ref;
1980 }
4b83ce9f
JS
1981 if (!read_oneliner(&buf, rebase_path_onto(), 0)) {
1982 res = error(_("could not read 'onto'"));
1983 goto cleanup_head_ref;
1984 }
96e832a5
JS
1985 msg = reflog_message(opts, "finish", "%s onto %s",
1986 head_ref.buf, buf.buf);
1987 if (update_ref(msg, head_ref.buf, head, orig,
4b83ce9f
JS
1988 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR)) {
1989 res = error(_("could not update %s"),
1990 head_ref.buf);
1991 goto cleanup_head_ref;
1992 }
96e832a5 1993 msg = reflog_message(opts, "finish", "returning to %s",
4b83ce9f 1994 head_ref.buf);
96e832a5 1995 if (create_symref("HEAD", head_ref.buf, msg)) {
4b83ce9f
JS
1996 res = error(_("could not update HEAD to %s"),
1997 head_ref.buf);
1998 goto cleanup_head_ref;
1999 }
2000 strbuf_reset(&buf);
2001 }
2002
556907f1
JS
2003 if (opts->verbose) {
2004 struct rev_info log_tree_opt;
2005 struct object_id orig, head;
2006
2007 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
2008 init_revisions(&log_tree_opt, NULL);
2009 log_tree_opt.diff = 1;
2010 log_tree_opt.diffopt.output_format =
2011 DIFF_FORMAT_DIFFSTAT;
2012 log_tree_opt.disable_stdin = 1;
2013
2014 if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
2015 !get_sha1(buf.buf, orig.hash) &&
2016 !get_sha1("HEAD", head.hash)) {
2017 diff_tree_sha1(orig.hash, head.hash,
2018 "", &log_tree_opt.diffopt);
2019 log_tree_diff_flush(&log_tree_opt);
2020 }
2021 }
25cb8df9
JS
2022 flush_rewritten_pending();
2023 if (!stat(rebase_path_rewritten_list(), &st) &&
2024 st.st_size > 0) {
2025 struct child_process child = CHILD_PROCESS_INIT;
79516045
JS
2026 const char *post_rewrite_hook =
2027 find_hook("post-rewrite");
25cb8df9
JS
2028
2029 child.in = open(rebase_path_rewritten_list(), O_RDONLY);
2030 child.git_cmd = 1;
2031 argv_array_push(&child.args, "notes");
2032 argv_array_push(&child.args, "copy");
2033 argv_array_push(&child.args, "--for-rewrite=rebase");
2034 /* we don't care if this copying failed */
2035 run_command(&child);
79516045
JS
2036
2037 if (post_rewrite_hook) {
2038 struct child_process hook = CHILD_PROCESS_INIT;
2039
2040 hook.in = open(rebase_path_rewritten_list(),
2041 O_RDONLY);
2042 hook.stdout_to_stderr = 1;
2043 argv_array_push(&hook.args, post_rewrite_hook);
2044 argv_array_push(&hook.args, "rebase");
2045 /* we don't care if this hook failed */
2046 run_command(&hook);
2047 }
25cb8df9 2048 }
796c7972 2049 apply_autostash(opts);
25cb8df9 2050
556907f1 2051 strbuf_release(&buf);
4b83ce9f 2052 strbuf_release(&head_ref);
56dc3ab0
JS
2053 }
2054
043a4492
RR
2055 /*
2056 * Sequence of picks finished successfully; cleanup by
2057 * removing the .git/sequencer directory
2058 */
2863584f 2059 return sequencer_remove_state(opts);
043a4492
RR
2060}
2061
2062static int continue_single_pick(void)
2063{
2064 const char *argv[] = { "commit", NULL };
2065
f932729c
JK
2066 if (!file_exists(git_path_cherry_pick_head()) &&
2067 !file_exists(git_path_revert_head()))
043a4492
RR
2068 return error(_("no cherry-pick or revert in progress"));
2069 return run_command_v_opt(argv, RUN_GIT_CMD);
2070}
2071
9d93ccd1
JS
2072static int commit_staged_changes(struct replay_opts *opts)
2073{
2074 int amend = 0;
2075
2076 if (has_unstaged_changes(1))
2077 return error(_("cannot rebase: You have unstaged changes."));
52632209
JS
2078 if (!has_uncommitted_changes(0)) {
2079 const char *cherry_pick_head = git_path("CHERRY_PICK_HEAD");
2080
2081 if (file_exists(cherry_pick_head) && unlink(cherry_pick_head))
2082 return error(_("could not remove CHERRY_PICK_HEAD"));
9d93ccd1 2083 return 0;
52632209 2084 }
9d93ccd1
JS
2085
2086 if (file_exists(rebase_path_amend())) {
2087 struct strbuf rev = STRBUF_INIT;
2088 unsigned char head[20], to_amend[20];
2089
2090 if (get_sha1("HEAD", head))
2091 return error(_("cannot amend non-existing commit"));
2092 if (!read_oneliner(&rev, rebase_path_amend(), 0))
2093 return error(_("invalid file: '%s'"), rebase_path_amend());
2094 if (get_sha1_hex(rev.buf, to_amend))
2095 return error(_("invalid contents: '%s'"),
2096 rebase_path_amend());
2097 if (hashcmp(head, to_amend))
2098 return error(_("\nYou have uncommitted changes in your "
2099 "working tree. Please, commit them\n"
2100 "first and then run 'git rebase "
2101 "--continue' again."));
2102
2103 strbuf_release(&rev);
2104 amend = 1;
2105 }
2106
2107 if (run_git_commit(rebase_path_message(), opts, 1, 1, amend, 0))
2108 return error(_("could not commit staged changes."));
2109 unlink(rebase_path_amend());
2110 return 0;
2111}
2112
2863584f 2113int sequencer_continue(struct replay_opts *opts)
043a4492 2114{
004fefa7
JS
2115 struct todo_list todo_list = TODO_LIST_INIT;
2116 int res;
043a4492 2117
2863584f
JS
2118 if (read_and_refresh_cache(opts))
2119 return -1;
2120
9d93ccd1
JS
2121 if (is_rebase_i(opts)) {
2122 if (commit_staged_changes(opts))
2123 return -1;
4258a6da 2124 } else if (!file_exists(get_todo_path(opts)))
043a4492 2125 return continue_single_pick();
004fefa7 2126 if (read_populate_opts(opts))
0ae42a03 2127 return -1;
004fefa7
JS
2128 if ((res = read_populate_todo(&todo_list, opts)))
2129 goto release_todo_list;
043a4492 2130
4258a6da
JS
2131 if (!is_rebase_i(opts)) {
2132 /* Verify that the conflict has been resolved */
2133 if (file_exists(git_path_cherry_pick_head()) ||
2134 file_exists(git_path_revert_head())) {
2135 res = continue_single_pick();
2136 if (res)
2137 goto release_todo_list;
2138 }
2139 if (index_differs_from("HEAD", 0, 0)) {
2140 res = error_dirty_index(opts);
004fefa7 2141 goto release_todo_list;
4258a6da
JS
2142 }
2143 todo_list.current++;
ca98c6d4
JS
2144 } else if (file_exists(rebase_path_stopped_sha())) {
2145 struct strbuf buf = STRBUF_INIT;
2146 struct object_id oid;
2147
2148 if (read_oneliner(&buf, rebase_path_stopped_sha(), 1) &&
2149 !get_sha1_committish(buf.buf, oid.hash))
2150 record_in_rewritten(&oid, peek_command(&todo_list, 0));
2151 strbuf_release(&buf);
043a4492 2152 }
4258a6da 2153
004fefa7
JS
2154 res = pick_commits(&todo_list, opts);
2155release_todo_list:
2156 todo_list_release(&todo_list);
2157 return res;
043a4492
RR
2158}
2159
2160static int single_pick(struct commit *cmit, struct replay_opts *opts)
2161{
2162 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
004fefa7 2163 return do_pick_commit(opts->action == REPLAY_PICK ?
6e98de72 2164 TODO_PICK : TODO_REVERT, cmit, opts, 0);
043a4492
RR
2165}
2166
2167int sequencer_pick_revisions(struct replay_opts *opts)
2168{
004fefa7 2169 struct todo_list todo_list = TODO_LIST_INIT;
043a4492 2170 unsigned char sha1[20];
004fefa7 2171 int i, res;
043a4492 2172
2863584f 2173 assert(opts->revs);
0d9c6dc9
JS
2174 if (read_and_refresh_cache(opts))
2175 return -1;
043a4492 2176
21246dbb
MV
2177 for (i = 0; i < opts->revs->pending.nr; i++) {
2178 unsigned char sha1[20];
2179 const char *name = opts->revs->pending.objects[i].name;
2180
2181 /* This happens when using --stdin. */
2182 if (!strlen(name))
2183 continue;
2184
2185 if (!get_sha1(name, sha1)) {
7c0b0d8d
JH
2186 if (!lookup_commit_reference_gently(sha1, 1)) {
2187 enum object_type type = sha1_object_info(sha1, NULL);
b9b946d4
JS
2188 return error(_("%s: can't cherry-pick a %s"),
2189 name, typename(type));
7c0b0d8d 2190 }
21246dbb 2191 } else
b9b946d4 2192 return error(_("%s: bad revision"), name);
21246dbb
MV
2193 }
2194
043a4492
RR
2195 /*
2196 * If we were called as "git cherry-pick <commit>", just
2197 * cherry-pick/revert it, set CHERRY_PICK_HEAD /
2198 * REVERT_HEAD, and don't touch the sequencer state.
2199 * This means it is possible to cherry-pick in the middle
2200 * of a cherry-pick sequence.
2201 */
2202 if (opts->revs->cmdline.nr == 1 &&
2203 opts->revs->cmdline.rev->whence == REV_CMD_REV &&
2204 opts->revs->no_walk &&
2205 !opts->revs->cmdline.rev->flags) {
2206 struct commit *cmit;
2207 if (prepare_revision_walk(opts->revs))
b9b946d4 2208 return error(_("revision walk setup failed"));
043a4492
RR
2209 cmit = get_revision(opts->revs);
2210 if (!cmit || get_revision(opts->revs))
b9b946d4 2211 return error("BUG: expected exactly one commit from walk");
043a4492
RR
2212 return single_pick(cmit, opts);
2213 }
2214
2215 /*
2216 * Start a new cherry-pick/ revert sequence; but
2217 * first, make sure that an existing one isn't in
2218 * progress
2219 */
2220
34b0528b
JS
2221 if (walk_revs_populate_todo(&todo_list, opts) ||
2222 create_seq_dir() < 0)
043a4492 2223 return -1;
0f974e21 2224 if (get_sha1("HEAD", sha1) && (opts->action == REPLAY_REVERT))
93b3df6f 2225 return error(_("can't revert as initial commit"));
311fd397
JS
2226 if (save_head(sha1_to_hex(sha1)))
2227 return -1;
88d5a271
JS
2228 if (save_opts(opts))
2229 return -1;
1e41229d 2230 update_abort_safety_file();
004fefa7
JS
2231 res = pick_commits(&todo_list, opts);
2232 todo_list_release(&todo_list);
2233 return res;
043a4492 2234}
5ed75e2a 2235
bab4d109 2236void append_signoff(struct strbuf *msgbuf, int ignore_footer, unsigned flag)
5ed75e2a 2237{
bab4d109 2238 unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
5ed75e2a 2239 struct strbuf sob = STRBUF_INIT;
bab4d109 2240 int has_footer;
5ed75e2a
MV
2241
2242 strbuf_addstr(&sob, sign_off_header);
2243 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
2244 getenv("GIT_COMMITTER_EMAIL")));
2245 strbuf_addch(&sob, '\n');
bab4d109
BC
2246
2247 /*
2248 * If the whole message buffer is equal to the sob, pretend that we
2249 * found a conforming footer with a matching sob
2250 */
2251 if (msgbuf->len - ignore_footer == sob.len &&
2252 !strncmp(msgbuf->buf, sob.buf, sob.len))
2253 has_footer = 3;
2254 else
2255 has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
2256
33f2f9ab
BC
2257 if (!has_footer) {
2258 const char *append_newlines = NULL;
2259 size_t len = msgbuf->len - ignore_footer;
2260
8c613fd5
BC
2261 if (!len) {
2262 /*
2263 * The buffer is completely empty. Leave foom for
2264 * the title and body to be filled in by the user.
2265 */
33f2f9ab 2266 append_newlines = "\n\n";
8c613fd5
BC
2267 } else if (msgbuf->buf[len - 1] != '\n') {
2268 /*
2269 * Incomplete line. Complete the line and add a
2270 * blank one so that there is an empty line between
2271 * the message body and the sob.
2272 */
2273 append_newlines = "\n\n";
2274 } else if (len == 1) {
2275 /*
2276 * Buffer contains a single newline. Add another
2277 * so that we leave room for the title and body.
2278 */
2279 append_newlines = "\n";
2280 } else if (msgbuf->buf[len - 2] != '\n') {
2281 /*
2282 * Buffer ends with a single newline. Add another
2283 * so that there is an empty line between the message
2284 * body and the sob.
2285 */
33f2f9ab 2286 append_newlines = "\n";
8c613fd5 2287 } /* else, the buffer already ends with two newlines. */
33f2f9ab
BC
2288
2289 if (append_newlines)
2290 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
2291 append_newlines, strlen(append_newlines));
5ed75e2a 2292 }
bab4d109
BC
2293
2294 if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
2295 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
2296 sob.buf, sob.len);
2297
5ed75e2a
MV
2298 strbuf_release(&sob);
2299}