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