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