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