factor out refresh_and_write_cache function
[git/git.git] / builtin / am.c
CommitLineData
73c2779f
PT
1/*
2 * Builtin "git am"
3 *
4 * Based on git-am.sh by Junio C Hamano.
5 */
f8adbec9 6#define USE_THE_INDEX_COMPATIBILITY_MACROS
73c2779f 7#include "cache.h"
b2141fc1 8#include "config.h"
73c2779f 9#include "builtin.h"
d807c4a0 10#include "exec-cmd.h"
8c3bd9e2
PT
11#include "parse-options.h"
12#include "dir.h"
11c2177f 13#include "run-command.h"
3e20dcf3 14#include "quote.h"
db86e61c 15#include "tempfile.h"
38a824fe 16#include "lockfile.h"
c9e8d960
PT
17#include "cache-tree.h"
18#include "refs.h"
19#include "commit.h"
32a5fcbf
PT
20#include "diff.h"
21#include "diffcore.h"
9990080c
PT
22#include "unpack-trees.h"
23#include "branch.h"
eb898b83 24#include "sequencer.h"
84f3de28
PT
25#include "revision.h"
26#include "merge-recursive.h"
df2760a5
PT
27#include "revision.h"
28#include "log-tree.h"
88b291fe 29#include "notes-utils.h"
f1cb96d6 30#include "rerere.h"
7ff26832 31#include "prompt.h"
4b98bae2 32#include "mailinfo.h"
edfac5eb 33#include "apply.h"
a77598ef 34#include "string-list.h"
3836d88a 35#include "packfile.h"
f86bcc7b 36#include "repository.h"
3e20dcf3 37
38a824fe
PT
38/**
39 * Returns the length of the first line of msg.
40 */
41static int linelen(const char *msg)
42{
43 return strchrnul(msg, '\n') - msg;
44}
45
5ae41c79
PT
46/**
47 * Returns true if `str` consists of only whitespace, false otherwise.
48 */
49static int str_isspace(const char *str)
50{
51 for (; *str; str++)
52 if (!isspace(*str))
53 return 0;
54
55 return 1;
56}
57
11c2177f
PT
58enum patch_format {
59 PATCH_FORMAT_UNKNOWN = 0,
5ae41c79 60 PATCH_FORMAT_MBOX,
336108c1 61 PATCH_FORMAT_STGIT,
94cd175c 62 PATCH_FORMAT_STGIT_SERIES,
d9925d1a
EW
63 PATCH_FORMAT_HG,
64 PATCH_FORMAT_MBOXRD
11c2177f 65};
8c3bd9e2 66
4f1b6961
PT
67enum keep_type {
68 KEEP_FALSE = 0,
69 KEEP_TRUE, /* pass -k flag to git-mailinfo */
70 KEEP_NON_PATCH /* pass -b flag to git-mailinfo */
71};
72
9b646617
PT
73enum scissors_type {
74 SCISSORS_UNSET = -1,
75 SCISSORS_FALSE = 0, /* pass --no-scissors to git-mailinfo */
76 SCISSORS_TRUE /* pass --scissors to git-mailinfo */
77};
78
b5e82359
PT
79enum signoff_type {
80 SIGNOFF_FALSE = 0,
81 SIGNOFF_TRUE = 1,
82 SIGNOFF_EXPLICIT /* --signoff was set on the command-line */
83};
84
8c3bd9e2
PT
85struct am_state {
86 /* state directory path */
87 char *dir;
88
89 /* current and last patch numbers, 1-indexed */
90 int cur;
91 int last;
11c2177f 92
3e20dcf3
PT
93 /* commit metadata and message */
94 char *author_name;
95 char *author_email;
96 char *author_date;
97 char *msg;
98 size_t msg_len;
99
13b97ea5 100 /* when --rebasing, records the original commit the patch came from */
8c88769b 101 struct object_id orig_commit;
13b97ea5 102
11c2177f
PT
103 /* number of digits in patch filename */
104 int prec;
5d28cf78
PT
105
106 /* various operating modes and command line options */
7ff26832 107 int interactive;
84f3de28 108 int threeway;
5d28cf78 109 int quiet;
b5e82359 110 int signoff; /* enum signoff_type */
ef7ee16d 111 int utf8;
4f1b6961 112 int keep; /* enum keep_type */
702cbaad 113 int message_id;
9b646617 114 int scissors; /* enum scissors_type */
257e8cec 115 struct argv_array git_apply_opts;
2d83109a 116 const char *resolvemsg;
0cd4bcba 117 int committer_date_is_author_date;
f07adb62 118 int ignore_date;
f1cb96d6 119 int allow_rerere_autoupdate;
7e35dacb 120 const char *sign_commit;
35bdcc59 121 int rebasing;
8c3bd9e2
PT
122};
123
124/**
16d2676c 125 * Initializes am_state with the default values.
8c3bd9e2 126 */
16d2676c 127static void am_state_init(struct am_state *state)
8c3bd9e2 128{
7e35dacb
PT
129 int gpgsign;
130
8c3bd9e2
PT
131 memset(state, 0, sizeof(*state));
132
16d2676c 133 state->dir = git_pathdup("rebase-apply");
11c2177f
PT
134
135 state->prec = 4;
ef7ee16d 136
e97a5e76
RL
137 git_config_get_bool("am.threeway", &state->threeway);
138
ef7ee16d 139 state->utf8 = 1;
702cbaad
PT
140
141 git_config_get_bool("am.messageid", &state->message_id);
9b646617
PT
142
143 state->scissors = SCISSORS_UNSET;
257e8cec
PT
144
145 argv_array_init(&state->git_apply_opts);
7e35dacb
PT
146
147 if (!git_config_get_bool("commit.gpgsign", &gpgsign))
148 state->sign_commit = gpgsign ? "" : NULL;
8c3bd9e2
PT
149}
150
151/**
152 * Releases memory allocated by an am_state.
153 */
154static void am_state_release(struct am_state *state)
155{
156 free(state->dir);
3e20dcf3
PT
157 free(state->author_name);
158 free(state->author_email);
159 free(state->author_date);
160 free(state->msg);
257e8cec 161 argv_array_clear(&state->git_apply_opts);
8c3bd9e2
PT
162}
163
164/**
165 * Returns path relative to the am_state directory.
166 */
167static inline const char *am_path(const struct am_state *state, const char *path)
168{
169 return mkpath("%s/%s", state->dir, path);
170}
171
25b763ba
JH
172/**
173 * For convenience to call write_file()
174 */
1dad879a
RS
175static void write_state_text(const struct am_state *state,
176 const char *name, const char *string)
25b763ba 177{
1dad879a 178 write_file(am_path(state, name), "%s", string);
25b763ba
JH
179}
180
1dad879a
RS
181static void write_state_count(const struct am_state *state,
182 const char *name, int value)
25b763ba 183{
1dad879a 184 write_file(am_path(state, name), "%d", value);
25b763ba
JH
185}
186
1dad879a
RS
187static void write_state_bool(const struct am_state *state,
188 const char *name, int value)
25b763ba 189{
1dad879a 190 write_state_text(state, name, value ? "t" : "f");
25b763ba
JH
191}
192
5d28cf78
PT
193/**
194 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
195 * at the end.
196 */
197static void say(const struct am_state *state, FILE *fp, const char *fmt, ...)
198{
199 va_list ap;
200
201 va_start(ap, fmt);
202 if (!state->quiet) {
203 vfprintf(fp, fmt, ap);
204 putc('\n', fp);
205 }
206 va_end(ap);
207}
208
8c3bd9e2
PT
209/**
210 * Returns 1 if there is an am session in progress, 0 otherwise.
211 */
212static int am_in_progress(const struct am_state *state)
213{
214 struct stat st;
215
216 if (lstat(state->dir, &st) < 0 || !S_ISDIR(st.st_mode))
217 return 0;
218 if (lstat(am_path(state, "last"), &st) || !S_ISREG(st.st_mode))
219 return 0;
220 if (lstat(am_path(state, "next"), &st) || !S_ISREG(st.st_mode))
221 return 0;
222 return 1;
223}
224
225/**
226 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
227 * number of bytes read on success, -1 if the file does not exist. If `trim` is
228 * set, trailing whitespace will be removed.
229 */
230static int read_state_file(struct strbuf *sb, const struct am_state *state,
231 const char *file, int trim)
232{
233 strbuf_reset(sb);
234
235 if (strbuf_read_file(sb, am_path(state, file), 0) >= 0) {
236 if (trim)
237 strbuf_trim(sb);
238
239 return sb->len;
240 }
241
242 if (errno == ENOENT)
243 return -1;
244
245 die_errno(_("could not read '%s'"), am_path(state, file));
246}
247
3e20dcf3
PT
248/**
249 * Reads and parses the state directory's "author-script" file, and sets
250 * state->author_name, state->author_email and state->author_date accordingly.
251 * Returns 0 on success, -1 if the file could not be parsed.
252 *
253 * The author script is of the format:
254 *
255 * GIT_AUTHOR_NAME='$author_name'
256 * GIT_AUTHOR_EMAIL='$author_email'
257 * GIT_AUTHOR_DATE='$author_date'
258 *
259 * where $author_name, $author_email and $author_date are quoted. We are strict
260 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
261 * script, and thus if the file differs from what this function expects, it is
262 * better to bail out than to do something that the user does not expect.
263 */
a75d3513 264static int read_am_author_script(struct am_state *state)
3e20dcf3
PT
265{
266 const char *filename = am_path(state, "author-script");
3e20dcf3
PT
267
268 assert(!state->author_name);
269 assert(!state->author_email);
270 assert(!state->author_date);
271
bcd33ec2
PW
272 return read_author_script(filename, &state->author_name,
273 &state->author_email, &state->author_date, 1);
3e20dcf3
PT
274}
275
276/**
277 * Saves state->author_name, state->author_email and state->author_date in the
278 * state directory's "author-script" file.
279 */
280static void write_author_script(const struct am_state *state)
281{
282 struct strbuf sb = STRBUF_INIT;
283
284 strbuf_addstr(&sb, "GIT_AUTHOR_NAME=");
285 sq_quote_buf(&sb, state->author_name);
286 strbuf_addch(&sb, '\n');
287
288 strbuf_addstr(&sb, "GIT_AUTHOR_EMAIL=");
289 sq_quote_buf(&sb, state->author_email);
290 strbuf_addch(&sb, '\n');
291
292 strbuf_addstr(&sb, "GIT_AUTHOR_DATE=");
293 sq_quote_buf(&sb, state->author_date);
294 strbuf_addch(&sb, '\n');
295
25b763ba 296 write_state_text(state, "author-script", sb.buf);
3e20dcf3
PT
297
298 strbuf_release(&sb);
299}
300
301/**
302 * Reads the commit message from the state directory's "final-commit" file,
303 * setting state->msg to its contents and state->msg_len to the length of its
304 * contents in bytes.
305 *
306 * Returns 0 on success, -1 if the file does not exist.
307 */
308static int read_commit_msg(struct am_state *state)
309{
310 struct strbuf sb = STRBUF_INIT;
311
312 assert(!state->msg);
313
314 if (read_state_file(&sb, state, "final-commit", 0) < 0) {
315 strbuf_release(&sb);
316 return -1;
317 }
318
319 state->msg = strbuf_detach(&sb, &state->msg_len);
320 return 0;
321}
322
323/**
324 * Saves state->msg in the state directory's "final-commit" file.
325 */
326static void write_commit_msg(const struct am_state *state)
327{
3e20dcf3 328 const char *filename = am_path(state, "final-commit");
e78d5d49 329 write_file_buf(filename, state->msg, state->msg_len);
3e20dcf3
PT
330}
331
8c3bd9e2
PT
332/**
333 * Loads state from disk.
334 */
335static void am_load(struct am_state *state)
336{
337 struct strbuf sb = STRBUF_INIT;
338
339 if (read_state_file(&sb, state, "next", 1) < 0)
033abf97 340 BUG("state file 'next' does not exist");
8c3bd9e2
PT
341 state->cur = strtol(sb.buf, NULL, 10);
342
343 if (read_state_file(&sb, state, "last", 1) < 0)
033abf97 344 BUG("state file 'last' does not exist");
8c3bd9e2
PT
345 state->last = strtol(sb.buf, NULL, 10);
346
a75d3513 347 if (read_am_author_script(state) < 0)
3e20dcf3
PT
348 die(_("could not parse author script"));
349
350 read_commit_msg(state);
351
13b97ea5 352 if (read_state_file(&sb, state, "original-commit", 1) < 0)
8c88769b 353 oidclr(&state->orig_commit);
354 else if (get_oid_hex(sb.buf, &state->orig_commit) < 0)
13b97ea5
PT
355 die(_("could not parse %s"), am_path(state, "original-commit"));
356
84f3de28
PT
357 read_state_file(&sb, state, "threeway", 1);
358 state->threeway = !strcmp(sb.buf, "t");
359
5d28cf78
PT
360 read_state_file(&sb, state, "quiet", 1);
361 state->quiet = !strcmp(sb.buf, "t");
362
eb898b83
PT
363 read_state_file(&sb, state, "sign", 1);
364 state->signoff = !strcmp(sb.buf, "t");
365
ef7ee16d
PT
366 read_state_file(&sb, state, "utf8", 1);
367 state->utf8 = !strcmp(sb.buf, "t");
368
fd4a3f48
PW
369 if (file_exists(am_path(state, "rerere-autoupdate"))) {
370 read_state_file(&sb, state, "rerere-autoupdate", 1);
371 state->allow_rerere_autoupdate = strcmp(sb.buf, "t") ?
372 RERERE_NOAUTOUPDATE : RERERE_AUTOUPDATE;
373 } else {
374 state->allow_rerere_autoupdate = 0;
375 }
376
4f1b6961
PT
377 read_state_file(&sb, state, "keep", 1);
378 if (!strcmp(sb.buf, "t"))
379 state->keep = KEEP_TRUE;
380 else if (!strcmp(sb.buf, "b"))
381 state->keep = KEEP_NON_PATCH;
382 else
383 state->keep = KEEP_FALSE;
384
702cbaad
PT
385 read_state_file(&sb, state, "messageid", 1);
386 state->message_id = !strcmp(sb.buf, "t");
387
9b646617
PT
388 read_state_file(&sb, state, "scissors", 1);
389 if (!strcmp(sb.buf, "t"))
390 state->scissors = SCISSORS_TRUE;
391 else if (!strcmp(sb.buf, "f"))
392 state->scissors = SCISSORS_FALSE;
393 else
394 state->scissors = SCISSORS_UNSET;
395
257e8cec
PT
396 read_state_file(&sb, state, "apply-opt", 1);
397 argv_array_clear(&state->git_apply_opts);
398 if (sq_dequote_to_argv_array(sb.buf, &state->git_apply_opts) < 0)
399 die(_("could not parse %s"), am_path(state, "apply-opt"));
400
35bdcc59
PT
401 state->rebasing = !!file_exists(am_path(state, "rebasing"));
402
8c3bd9e2
PT
403 strbuf_release(&sb);
404}
405
406/**
407 * Removes the am_state directory, forcefully terminating the current am
408 * session.
409 */
410static void am_destroy(const struct am_state *state)
411{
412 struct strbuf sb = STRBUF_INIT;
413
414 strbuf_addstr(&sb, state->dir);
415 remove_dir_recursively(&sb, 0);
416 strbuf_release(&sb);
417}
418
b8803d8f
PT
419/**
420 * Runs applypatch-msg hook. Returns its exit code.
421 */
422static int run_applypatch_msg_hook(struct am_state *state)
423{
424 int ret;
425
426 assert(state->msg);
427 ret = run_hook_le(NULL, "applypatch-msg", am_path(state, "final-commit"), NULL);
428
429 if (!ret) {
6a83d902 430 FREE_AND_NULL(state->msg);
b8803d8f
PT
431 if (read_commit_msg(state) < 0)
432 die(_("'%s' was deleted by the applypatch-msg hook"),
433 am_path(state, "final-commit"));
434 }
435
436 return ret;
437}
438
13b97ea5
PT
439/**
440 * Runs post-rewrite hook. Returns it exit code.
441 */
442static int run_post_rewrite_hook(const struct am_state *state)
443{
444 struct child_process cp = CHILD_PROCESS_INIT;
445 const char *hook = find_hook("post-rewrite");
446 int ret;
447
448 if (!hook)
449 return 0;
450
451 argv_array_push(&cp.args, hook);
452 argv_array_push(&cp.args, "rebase");
453
454 cp.in = xopen(am_path(state, "rewritten"), O_RDONLY);
455 cp.stdout_to_stderr = 1;
6206286e 456 cp.trace2_hook_name = "post-rewrite";
13b97ea5
PT
457
458 ret = run_command(&cp);
459
460 close(cp.in);
461 return ret;
462}
463
88b291fe
PT
464/**
465 * Reads the state directory's "rewritten" file, and copies notes from the old
466 * commits listed in the file to their rewritten commits.
467 *
468 * Returns 0 on success, -1 on failure.
469 */
470static int copy_notes_for_rebase(const struct am_state *state)
471{
472 struct notes_rewrite_cfg *c;
473 struct strbuf sb = STRBUF_INIT;
474 const char *invalid_line = _("Malformed input line: '%s'.");
475 const char *msg = "Notes added by 'git rebase'";
476 FILE *fp;
477 int ret = 0;
478
479 assert(state->rebasing);
480
481 c = init_copy_notes_for_rewrite("rebase");
482 if (!c)
483 return 0;
484
485 fp = xfopen(am_path(state, "rewritten"), "r");
486
8f309aeb 487 while (!strbuf_getline_lf(&sb, fp)) {
8c88769b 488 struct object_id from_obj, to_obj;
24dd363e 489 const char *p;
88b291fe 490
24dd363e 491 if (sb.len != the_hash_algo->hexsz * 2 + 1) {
88b291fe
PT
492 ret = error(invalid_line, sb.buf);
493 goto finish;
494 }
495
24dd363e 496 if (parse_oid_hex(sb.buf, &from_obj, &p)) {
88b291fe
PT
497 ret = error(invalid_line, sb.buf);
498 goto finish;
499 }
500
24dd363e 501 if (*p != ' ') {
88b291fe
PT
502 ret = error(invalid_line, sb.buf);
503 goto finish;
504 }
505
24dd363e 506 if (get_oid_hex(p + 1, &to_obj)) {
88b291fe
PT
507 ret = error(invalid_line, sb.buf);
508 goto finish;
509 }
510
bb7e4739 511 if (copy_note_for_rewrite(c, &from_obj, &to_obj))
88b291fe 512 ret = error(_("Failed to copy notes from '%s' to '%s'"),
8c88769b 513 oid_to_hex(&from_obj), oid_to_hex(&to_obj));
88b291fe
PT
514 }
515
516finish:
1d18d758 517 finish_copy_notes_for_rewrite(the_repository, c, msg);
88b291fe
PT
518 fclose(fp);
519 strbuf_release(&sb);
520 return ret;
521}
522
c29807b2
PT
523/**
524 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
525 * non-indented lines and checking if they look like they begin with valid
526 * header field names.
527 *
528 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
529 */
530static int is_mail(FILE *fp)
531{
532 const char *header_regex = "^[!-9;-~]+:";
533 struct strbuf sb = STRBUF_INIT;
534 regex_t regex;
535 int ret = 1;
536
537 if (fseek(fp, 0L, SEEK_SET))
538 die_errno(_("fseek failed"));
539
540 if (regcomp(&regex, header_regex, REG_NOSUB | REG_EXTENDED))
541 die("invalid pattern: %s", header_regex);
542
1a0c8dfd 543 while (!strbuf_getline(&sb, fp)) {
c29807b2
PT
544 if (!sb.len)
545 break; /* End of header */
546
547 /* Ignore indented folded lines */
548 if (*sb.buf == '\t' || *sb.buf == ' ')
549 continue;
550
551 /* It's a header if it matches header_regex */
552 if (regexec(&regex, sb.buf, 0, NULL, 0)) {
553 ret = 0;
554 goto done;
555 }
556 }
557
558done:
559 regfree(&regex);
560 strbuf_release(&sb);
561 return ret;
562}
563
564/**
565 * Attempts to detect the patch_format of the patches contained in `paths`,
566 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
567 * detection fails.
568 */
569static int detect_patch_format(const char **paths)
570{
571 enum patch_format ret = PATCH_FORMAT_UNKNOWN;
572 struct strbuf l1 = STRBUF_INIT;
5ae41c79
PT
573 struct strbuf l2 = STRBUF_INIT;
574 struct strbuf l3 = STRBUF_INIT;
c29807b2
PT
575 FILE *fp;
576
577 /*
578 * We default to mbox format if input is from stdin and for directories
579 */
580 if (!*paths || !strcmp(*paths, "-") || is_directory(*paths))
581 return PATCH_FORMAT_MBOX;
582
583 /*
584 * Otherwise, check the first few lines of the first patch, starting
585 * from the first non-blank line, to try to detect its format.
586 */
587
588 fp = xfopen(*paths, "r");
589
1a0c8dfd 590 while (!strbuf_getline(&l1, fp)) {
c29807b2
PT
591 if (l1.len)
592 break;
593 }
594
595 if (starts_with(l1.buf, "From ") || starts_with(l1.buf, "From: ")) {
596 ret = PATCH_FORMAT_MBOX;
597 goto done;
598 }
599
336108c1
PT
600 if (starts_with(l1.buf, "# This series applies on GIT commit")) {
601 ret = PATCH_FORMAT_STGIT_SERIES;
602 goto done;
603 }
604
94cd175c
PT
605 if (!strcmp(l1.buf, "# HG changeset patch")) {
606 ret = PATCH_FORMAT_HG;
607 goto done;
608 }
609
1a0c8dfd 610 strbuf_getline(&l2, fp);
1a0c8dfd 611 strbuf_getline(&l3, fp);
5ae41c79
PT
612
613 /*
614 * If the second line is empty and the third is a From, Author or Date
615 * entry, this is likely an StGit patch.
616 */
617 if (l1.len && !l2.len &&
618 (starts_with(l3.buf, "From:") ||
619 starts_with(l3.buf, "Author:") ||
620 starts_with(l3.buf, "Date:"))) {
621 ret = PATCH_FORMAT_STGIT;
622 goto done;
623 }
624
c29807b2
PT
625 if (l1.len && is_mail(fp)) {
626 ret = PATCH_FORMAT_MBOX;
627 goto done;
628 }
629
630done:
631 fclose(fp);
632 strbuf_release(&l1);
542627a4
RS
633 strbuf_release(&l2);
634 strbuf_release(&l3);
c29807b2
PT
635 return ret;
636}
637
11c2177f
PT
638/**
639 * Splits out individual email patches from `paths`, where each path is either
640 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
641 */
d9925d1a
EW
642static int split_mail_mbox(struct am_state *state, const char **paths,
643 int keep_cr, int mboxrd)
11c2177f
PT
644{
645 struct child_process cp = CHILD_PROCESS_INIT;
646 struct strbuf last = STRBUF_INIT;
1b090735 647 int ret;
11c2177f
PT
648
649 cp.git_cmd = 1;
650 argv_array_push(&cp.args, "mailsplit");
651 argv_array_pushf(&cp.args, "-d%d", state->prec);
652 argv_array_pushf(&cp.args, "-o%s", state->dir);
653 argv_array_push(&cp.args, "-b");
5d123a40
PT
654 if (keep_cr)
655 argv_array_push(&cp.args, "--keep-cr");
d9925d1a
EW
656 if (mboxrd)
657 argv_array_push(&cp.args, "--mboxrd");
11c2177f
PT
658 argv_array_push(&cp.args, "--");
659 argv_array_pushv(&cp.args, paths);
660
1b090735
RS
661 ret = capture_command(&cp, &last, 8);
662 if (ret)
663 goto exit;
11c2177f
PT
664
665 state->cur = 1;
666 state->last = strtol(last.buf, NULL, 10);
667
1b090735
RS
668exit:
669 strbuf_release(&last);
670 return ret ? -1 : 0;
11c2177f
PT
671}
672
5ae41c79
PT
673/**
674 * Callback signature for split_mail_conv(). The foreign patch should be
675 * read from `in`, and the converted patch (in RFC2822 mail format) should be
676 * written to `out`. Return 0 on success, or -1 on failure.
677 */
678typedef int (*mail_conv_fn)(FILE *out, FILE *in, int keep_cr);
679
680/**
681 * Calls `fn` for each file in `paths` to convert the foreign patch to the
682 * RFC2822 mail format suitable for parsing with git-mailinfo.
683 *
684 * Returns 0 on success, -1 on failure.
685 */
686static int split_mail_conv(mail_conv_fn fn, struct am_state *state,
687 const char **paths, int keep_cr)
688{
689 static const char *stdin_only[] = {"-", NULL};
690 int i;
691
692 if (!*paths)
693 paths = stdin_only;
694
695 for (i = 0; *paths; paths++, i++) {
696 FILE *in, *out;
697 const char *mail;
698 int ret;
699
700 if (!strcmp(*paths, "-"))
701 in = stdin;
702 else
703 in = fopen(*paths, "r");
704
705 if (!in)
6e59e9c0
NTND
706 return error_errno(_("could not open '%s' for reading"),
707 *paths);
5ae41c79
PT
708
709 mail = mkpath("%s/%0*d", state->dir, state->prec, i + 1);
710
711 out = fopen(mail, "w");
ac8ce18d
RS
712 if (!out) {
713 if (in != stdin)
714 fclose(in);
6e59e9c0
NTND
715 return error_errno(_("could not open '%s' for writing"),
716 mail);
ac8ce18d 717 }
5ae41c79
PT
718
719 ret = fn(out, in, keep_cr);
720
721 fclose(out);
ac8ce18d
RS
722 if (in != stdin)
723 fclose(in);
5ae41c79
PT
724
725 if (ret)
726 return error(_("could not parse patch '%s'"), *paths);
727 }
728
729 state->cur = 1;
730 state->last = i;
731 return 0;
732}
733
734/**
735 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
736 * message suitable for parsing with git-mailinfo.
737 */
738static int stgit_patch_to_mail(FILE *out, FILE *in, int keep_cr)
739{
740 struct strbuf sb = STRBUF_INIT;
741 int subject_printed = 0;
742
8f309aeb 743 while (!strbuf_getline_lf(&sb, in)) {
5ae41c79
PT
744 const char *str;
745
746 if (str_isspace(sb.buf))
747 continue;
748 else if (skip_prefix(sb.buf, "Author:", &str))
749 fprintf(out, "From:%s\n", str);
750 else if (starts_with(sb.buf, "From") || starts_with(sb.buf, "Date"))
751 fprintf(out, "%s\n", sb.buf);
752 else if (!subject_printed) {
753 fprintf(out, "Subject: %s\n", sb.buf);
754 subject_printed = 1;
755 } else {
756 fprintf(out, "\n%s\n", sb.buf);
757 break;
758 }
759 }
760
761 strbuf_reset(&sb);
762 while (strbuf_fread(&sb, 8192, in) > 0) {
763 fwrite(sb.buf, 1, sb.len, out);
764 strbuf_reset(&sb);
765 }
766
767 strbuf_release(&sb);
768 return 0;
769}
770
336108c1
PT
771/**
772 * This function only supports a single StGit series file in `paths`.
773 *
774 * Given an StGit series file, converts the StGit patches in the series into
775 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
776 * the state directory.
777 *
778 * Returns 0 on success, -1 on failure.
779 */
780static int split_mail_stgit_series(struct am_state *state, const char **paths,
781 int keep_cr)
782{
783 const char *series_dir;
784 char *series_dir_buf;
785 FILE *fp;
786 struct argv_array patches = ARGV_ARRAY_INIT;
787 struct strbuf sb = STRBUF_INIT;
788 int ret;
789
790 if (!paths[0] || paths[1])
791 return error(_("Only one StGIT patch series can be applied at once"));
792
793 series_dir_buf = xstrdup(*paths);
794 series_dir = dirname(series_dir_buf);
795
796 fp = fopen(*paths, "r");
797 if (!fp)
6e59e9c0 798 return error_errno(_("could not open '%s' for reading"), *paths);
336108c1 799
8f309aeb 800 while (!strbuf_getline_lf(&sb, fp)) {
336108c1
PT
801 if (*sb.buf == '#')
802 continue; /* skip comment lines */
803
804 argv_array_push(&patches, mkpath("%s/%s", series_dir, sb.buf));
805 }
806
807 fclose(fp);
808 strbuf_release(&sb);
809 free(series_dir_buf);
810
811 ret = split_mail_conv(stgit_patch_to_mail, state, patches.argv, keep_cr);
812
813 argv_array_clear(&patches);
814 return ret;
815}
816
94cd175c
PT
817/**
818 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
819 * message suitable for parsing with git-mailinfo.
820 */
821static int hg_patch_to_mail(FILE *out, FILE *in, int keep_cr)
822{
823 struct strbuf sb = STRBUF_INIT;
b36474ff 824 int rc = 0;
94cd175c 825
8f309aeb 826 while (!strbuf_getline_lf(&sb, in)) {
94cd175c
PT
827 const char *str;
828
829 if (skip_prefix(sb.buf, "# User ", &str))
830 fprintf(out, "From: %s\n", str);
831 else if (skip_prefix(sb.buf, "# Date ", &str)) {
dddbad72 832 timestamp_t timestamp;
94cd175c
PT
833 long tz, tz2;
834 char *end;
835
836 errno = 0;
1aeb7e75 837 timestamp = parse_timestamp(str, &end, 10);
b36474ff
RS
838 if (errno) {
839 rc = error(_("invalid timestamp"));
840 goto exit;
841 }
94cd175c 842
b36474ff
RS
843 if (!skip_prefix(end, " ", &str)) {
844 rc = error(_("invalid Date line"));
845 goto exit;
846 }
94cd175c
PT
847
848 errno = 0;
849 tz = strtol(str, &end, 10);
b36474ff
RS
850 if (errno) {
851 rc = error(_("invalid timezone offset"));
852 goto exit;
853 }
94cd175c 854
b36474ff
RS
855 if (*end) {
856 rc = error(_("invalid Date line"));
857 goto exit;
858 }
94cd175c
PT
859
860 /*
861 * mercurial's timezone is in seconds west of UTC,
862 * however git's timezone is in hours + minutes east of
863 * UTC. Convert it.
864 */
865 tz2 = labs(tz) / 3600 * 100 + labs(tz) % 3600 / 60;
866 if (tz > 0)
867 tz2 = -tz2;
868
869 fprintf(out, "Date: %s\n", show_date(timestamp, tz2, DATE_MODE(RFC2822)));
870 } else if (starts_with(sb.buf, "# ")) {
871 continue;
872 } else {
873 fprintf(out, "\n%s\n", sb.buf);
874 break;
875 }
876 }
877
878 strbuf_reset(&sb);
879 while (strbuf_fread(&sb, 8192, in) > 0) {
880 fwrite(sb.buf, 1, sb.len, out);
881 strbuf_reset(&sb);
882 }
b36474ff 883exit:
94cd175c 884 strbuf_release(&sb);
b36474ff 885 return rc;
94cd175c
PT
886}
887
11c2177f
PT
888/**
889 * Splits a list of files/directories into individual email patches. Each path
890 * in `paths` must be a file/directory that is formatted according to
891 * `patch_format`.
892 *
893 * Once split out, the individual email patches will be stored in the state
894 * directory, with each patch's filename being its index, padded to state->prec
895 * digits.
896 *
897 * state->cur will be set to the index of the first mail, and state->last will
898 * be set to the index of the last mail.
899 *
5d123a40
PT
900 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
901 * to disable this behavior, -1 to use the default configured setting.
902 *
11c2177f
PT
903 * Returns 0 on success, -1 on failure.
904 */
905static int split_mail(struct am_state *state, enum patch_format patch_format,
5d123a40 906 const char **paths, int keep_cr)
11c2177f 907{
5d123a40
PT
908 if (keep_cr < 0) {
909 keep_cr = 0;
910 git_config_get_bool("am.keepcr", &keep_cr);
911 }
912
11c2177f
PT
913 switch (patch_format) {
914 case PATCH_FORMAT_MBOX:
d9925d1a 915 return split_mail_mbox(state, paths, keep_cr, 0);
5ae41c79
PT
916 case PATCH_FORMAT_STGIT:
917 return split_mail_conv(stgit_patch_to_mail, state, paths, keep_cr);
336108c1
PT
918 case PATCH_FORMAT_STGIT_SERIES:
919 return split_mail_stgit_series(state, paths, keep_cr);
94cd175c
PT
920 case PATCH_FORMAT_HG:
921 return split_mail_conv(hg_patch_to_mail, state, paths, keep_cr);
d9925d1a
EW
922 case PATCH_FORMAT_MBOXRD:
923 return split_mail_mbox(state, paths, keep_cr, 1);
11c2177f 924 default:
033abf97 925 BUG("invalid patch_format");
11c2177f
PT
926 }
927 return -1;
928}
929
8c3bd9e2
PT
930/**
931 * Setup a new am session for applying patches
932 */
11c2177f 933static void am_setup(struct am_state *state, enum patch_format patch_format,
5d123a40 934 const char **paths, int keep_cr)
8c3bd9e2 935{
8c88769b 936 struct object_id curr_head;
4f1b6961 937 const char *str;
257e8cec 938 struct strbuf sb = STRBUF_INIT;
33388a71 939
c29807b2
PT
940 if (!patch_format)
941 patch_format = detect_patch_format(paths);
942
943 if (!patch_format) {
944 fprintf_ln(stderr, _("Patch format detection failed."));
945 exit(128);
946 }
947
8c3bd9e2
PT
948 if (mkdir(state->dir, 0777) < 0 && errno != EEXIST)
949 die_errno(_("failed to create directory '%s'"), state->dir);
fbd7a232 950 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
8c3bd9e2 951
5d123a40 952 if (split_mail(state, patch_format, paths, keep_cr) < 0) {
11c2177f
PT
953 am_destroy(state);
954 die(_("Failed to split patches."));
955 }
956
35bdcc59
PT
957 if (state->rebasing)
958 state->threeway = 1;
959
25b763ba
JH
960 write_state_bool(state, "threeway", state->threeway);
961 write_state_bool(state, "quiet", state->quiet);
962 write_state_bool(state, "sign", state->signoff);
963 write_state_bool(state, "utf8", state->utf8);
ef7ee16d 964
fd4a3f48
PW
965 if (state->allow_rerere_autoupdate)
966 write_state_bool(state, "rerere-autoupdate",
967 state->allow_rerere_autoupdate == RERERE_AUTOUPDATE);
968
4f1b6961
PT
969 switch (state->keep) {
970 case KEEP_FALSE:
971 str = "f";
972 break;
973 case KEEP_TRUE:
974 str = "t";
975 break;
976 case KEEP_NON_PATCH:
977 str = "b";
978 break;
979 default:
033abf97 980 BUG("invalid value for state->keep");
4f1b6961
PT
981 }
982
25b763ba
JH
983 write_state_text(state, "keep", str);
984 write_state_bool(state, "messageid", state->message_id);
702cbaad 985
9b646617
PT
986 switch (state->scissors) {
987 case SCISSORS_UNSET:
988 str = "";
989 break;
990 case SCISSORS_FALSE:
991 str = "f";
992 break;
993 case SCISSORS_TRUE:
994 str = "t";
995 break;
996 default:
033abf97 997 BUG("invalid value for state->scissors");
9b646617 998 }
25b763ba 999 write_state_text(state, "scissors", str);
9b646617 1000
e35f11c2 1001 sq_quote_argv(&sb, state->git_apply_opts.argv);
25b763ba 1002 write_state_text(state, "apply-opt", sb.buf);
257e8cec 1003
35bdcc59 1004 if (state->rebasing)
25b763ba 1005 write_state_text(state, "rebasing", "");
35bdcc59 1006 else
25b763ba 1007 write_state_text(state, "applying", "");
35bdcc59 1008
8c88769b 1009 if (!get_oid("HEAD", &curr_head)) {
1010 write_state_text(state, "abort-safety", oid_to_hex(&curr_head));
35bdcc59 1011 if (!state->rebasing)
ae077771 1012 update_ref("am", "ORIG_HEAD", &curr_head, NULL, 0,
1013 UPDATE_REFS_DIE_ON_ERR);
33388a71 1014 } else {
25b763ba 1015 write_state_text(state, "abort-safety", "");
35bdcc59 1016 if (!state->rebasing)
755b49ae 1017 delete_ref(NULL, "ORIG_HEAD", NULL, 0);
33388a71
PT
1018 }
1019
8c3bd9e2
PT
1020 /*
1021 * NOTE: Since the "next" and "last" files determine if an am_state
1022 * session is in progress, they should be written last.
1023 */
1024
25b763ba
JH
1025 write_state_count(state, "next", state->cur);
1026 write_state_count(state, "last", state->last);
257e8cec
PT
1027
1028 strbuf_release(&sb);
8c3bd9e2
PT
1029}
1030
1031/**
1032 * Increments the patch pointer, and cleans am_state for the application of the
1033 * next patch.
1034 */
1035static void am_next(struct am_state *state)
1036{
8c88769b 1037 struct object_id head;
33388a71 1038
88ce3ef6
ÆAB
1039 FREE_AND_NULL(state->author_name);
1040 FREE_AND_NULL(state->author_email);
1041 FREE_AND_NULL(state->author_date);
1042 FREE_AND_NULL(state->msg);
3e20dcf3
PT
1043 state->msg_len = 0;
1044
1045 unlink(am_path(state, "author-script"));
1046 unlink(am_path(state, "final-commit"));
1047
8c88769b 1048 oidclr(&state->orig_commit);
13b97ea5 1049 unlink(am_path(state, "original-commit"));
fbd7a232 1050 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
13b97ea5 1051
8c88769b 1052 if (!get_oid("HEAD", &head))
1053 write_state_text(state, "abort-safety", oid_to_hex(&head));
33388a71 1054 else
25b763ba 1055 write_state_text(state, "abort-safety", "");
33388a71 1056
8c3bd9e2 1057 state->cur++;
25b763ba 1058 write_state_count(state, "next", state->cur);
8c3bd9e2
PT
1059}
1060
3e20dcf3
PT
1061/**
1062 * Returns the filename of the current patch email.
1063 */
1064static const char *msgnum(const struct am_state *state)
1065{
1066 static struct strbuf sb = STRBUF_INIT;
1067
1068 strbuf_reset(&sb);
1069 strbuf_addf(&sb, "%0*d", state->prec, state->cur);
1070
1071 return sb.buf;
1072}
1073
2d83109a
PT
1074/**
1075 * Dies with a user-friendly message on how to proceed after resolving the
1076 * problem. This message can be overridden with state->resolvemsg.
1077 */
1078static void NORETURN die_user_resolve(const struct am_state *state)
1079{
1080 if (state->resolvemsg) {
1081 printf_ln("%s", state->resolvemsg);
1082 } else {
7ff26832 1083 const char *cmdline = state->interactive ? "git am -i" : "git am";
2d83109a
PT
1084
1085 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline);
1086 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline);
1087 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline);
1088 }
1089
1090 exit(128);
1091}
1092
0fb3c4fc
GB
1093/**
1094 * Appends signoff to the "msg" field of the am_state.
1095 */
1096static void am_append_signoff(struct am_state *state)
aab84542 1097{
0fb3c4fc 1098 struct strbuf sb = STRBUF_INIT;
aab84542 1099
0fb3c4fc 1100 strbuf_attach(&sb, state->msg, state->msg_len, state->msg_len);
735285b4 1101 append_signoff(&sb, 0, 0);
b5e82359
PT
1102 state->msg = strbuf_detach(&sb, &state->msg_len);
1103}
1104
3e20dcf3
PT
1105/**
1106 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1107 * state->msg will be set to the patch message. state->author_name,
1108 * state->author_email and state->author_date will be set to the patch author's
1109 * name, email and date respectively. The patch body will be written to the
1110 * state directory's "patch" file.
1111 *
1112 * Returns 1 if the patch should be skipped, 0 otherwise.
1113 */
1114static int parse_mail(struct am_state *state, const char *mail)
1115{
1116 FILE *fp;
3e20dcf3
PT
1117 struct strbuf sb = STRBUF_INIT;
1118 struct strbuf msg = STRBUF_INIT;
1119 struct strbuf author_name = STRBUF_INIT;
1120 struct strbuf author_date = STRBUF_INIT;
1121 struct strbuf author_email = STRBUF_INIT;
1122 int ret = 0;
4b98bae2 1123 struct mailinfo mi;
3e20dcf3 1124
4b98bae2 1125 setup_mailinfo(&mi);
3e20dcf3 1126
4b98bae2
JH
1127 if (state->utf8)
1128 mi.metainfo_charset = get_commit_output_encoding();
1129 else
1130 mi.metainfo_charset = NULL;
4f1b6961
PT
1131
1132 switch (state->keep) {
1133 case KEEP_FALSE:
1134 break;
1135 case KEEP_TRUE:
4b98bae2 1136 mi.keep_subject = 1;
4f1b6961
PT
1137 break;
1138 case KEEP_NON_PATCH:
4b98bae2 1139 mi.keep_non_patch_brackets_in_subject = 1;
4f1b6961
PT
1140 break;
1141 default:
033abf97 1142 BUG("invalid value for state->keep");
4f1b6961
PT
1143 }
1144
702cbaad 1145 if (state->message_id)
4b98bae2 1146 mi.add_message_id = 1;
702cbaad 1147
9b646617
PT
1148 switch (state->scissors) {
1149 case SCISSORS_UNSET:
1150 break;
1151 case SCISSORS_FALSE:
4b98bae2 1152 mi.use_scissors = 0;
9b646617
PT
1153 break;
1154 case SCISSORS_TRUE:
4b98bae2 1155 mi.use_scissors = 1;
9b646617
PT
1156 break;
1157 default:
033abf97 1158 BUG("invalid value for state->scissors");
9b646617
PT
1159 }
1160
23a9e071
NTND
1161 mi.input = xfopen(mail, "r");
1162 mi.output = xfopen(am_path(state, "info"), "w");
4b98bae2 1163 if (mailinfo(&mi, am_path(state, "msg"), am_path(state, "patch")))
3e20dcf3
PT
1164 die("could not parse patch");
1165
4b98bae2
JH
1166 fclose(mi.input);
1167 fclose(mi.output);
3e20dcf3 1168
3aa4d81f
RS
1169 if (mi.format_flowed)
1170 warning(_("Patch sent with format=flowed; "
1171 "space at the end of lines might be lost."));
1172
3e20dcf3
PT
1173 /* Extract message and author information */
1174 fp = xfopen(am_path(state, "info"), "r");
8f309aeb 1175 while (!strbuf_getline_lf(&sb, fp)) {
3e20dcf3
PT
1176 const char *x;
1177
1178 if (skip_prefix(sb.buf, "Subject: ", &x)) {
1179 if (msg.len)
1180 strbuf_addch(&msg, '\n');
1181 strbuf_addstr(&msg, x);
1182 } else if (skip_prefix(sb.buf, "Author: ", &x))
1183 strbuf_addstr(&author_name, x);
1184 else if (skip_prefix(sb.buf, "Email: ", &x))
1185 strbuf_addstr(&author_email, x);
1186 else if (skip_prefix(sb.buf, "Date: ", &x))
1187 strbuf_addstr(&author_date, x);
1188 }
1189 fclose(fp);
1190
1191 /* Skip pine's internal folder data */
1192 if (!strcmp(author_name.buf, "Mail System Internal Data")) {
1193 ret = 1;
1194 goto finish;
1195 }
1196
e3b1e3bd 1197 if (is_empty_or_missing_file(am_path(state, "patch"))) {
6c486862 1198 printf_ln(_("Patch is empty."));
2d83109a 1199 die_user_resolve(state);
3e20dcf3
PT
1200 }
1201
1202 strbuf_addstr(&msg, "\n\n");
4b98bae2 1203 strbuf_addbuf(&msg, &mi.log_message);
63af4a84 1204 strbuf_stripspace(&msg, 0);
3e20dcf3
PT
1205
1206 assert(!state->author_name);
1207 state->author_name = strbuf_detach(&author_name, NULL);
1208
1209 assert(!state->author_email);
1210 state->author_email = strbuf_detach(&author_email, NULL);
1211
1212 assert(!state->author_date);
1213 state->author_date = strbuf_detach(&author_date, NULL);
1214
1215 assert(!state->msg);
1216 state->msg = strbuf_detach(&msg, &state->msg_len);
1217
1218finish:
1219 strbuf_release(&msg);
1220 strbuf_release(&author_date);
1221 strbuf_release(&author_email);
1222 strbuf_release(&author_name);
1223 strbuf_release(&sb);
4b98bae2 1224 clear_mailinfo(&mi);
3e20dcf3
PT
1225 return ret;
1226}
1227
df2760a5
PT
1228/**
1229 * Sets commit_id to the commit hash where the mail was generated from.
1230 * Returns 0 on success, -1 on failure.
1231 */
8c88769b 1232static int get_mail_commit_oid(struct object_id *commit_id, const char *mail)
df2760a5
PT
1233{
1234 struct strbuf sb = STRBUF_INIT;
1235 FILE *fp = xfopen(mail, "r");
1236 const char *x;
5b34ba41 1237 int ret = 0;
df2760a5 1238
5b34ba41
JS
1239 if (strbuf_getline_lf(&sb, fp) ||
1240 !skip_prefix(sb.buf, "From ", &x) ||
1241 get_oid_hex(x, commit_id) < 0)
1242 ret = -1;
df2760a5
PT
1243
1244 strbuf_release(&sb);
1245 fclose(fp);
5b34ba41 1246 return ret;
df2760a5
PT
1247}
1248
1249/**
1250 * Sets state->msg, state->author_name, state->author_email, state->author_date
1251 * to the commit's respective info.
1252 */
1253static void get_commit_info(struct am_state *state, struct commit *commit)
1254{
2e2bbb96 1255 const char *buffer, *ident_line, *msg;
df2760a5 1256 size_t ident_len;
721f5f1e 1257 struct ident_split id;
df2760a5
PT
1258
1259 buffer = logmsg_reencode(commit, NULL, get_commit_output_encoding());
1260
1261 ident_line = find_commit_header(buffer, "author", &ident_len);
1262
721f5f1e 1263 if (split_ident_line(&id, ident_line, ident_len) < 0)
2e2bbb96 1264 die(_("invalid ident line: %.*s"), (int)ident_len, ident_line);
df2760a5
PT
1265
1266 assert(!state->author_name);
721f5f1e 1267 if (id.name_begin)
2e2bbb96 1268 state->author_name =
721f5f1e
JK
1269 xmemdupz(id.name_begin, id.name_end - id.name_begin);
1270 else
df2760a5
PT
1271 state->author_name = xstrdup("");
1272
1273 assert(!state->author_email);
721f5f1e 1274 if (id.mail_begin)
2e2bbb96 1275 state->author_email =
721f5f1e
JK
1276 xmemdupz(id.mail_begin, id.mail_end - id.mail_begin);
1277 else
df2760a5
PT
1278 state->author_email = xstrdup("");
1279
df2760a5 1280 assert(!state->author_date);
721f5f1e 1281 state->author_date = xstrdup(show_ident_date(&id, DATE_MODE(NORMAL)));
df2760a5
PT
1282
1283 assert(!state->msg);
1284 msg = strstr(buffer, "\n\n");
1285 if (!msg)
f2fd0760 1286 die(_("unable to parse commit %s"), oid_to_hex(&commit->object.oid));
df2760a5
PT
1287 state->msg = xstrdup(msg + 2);
1288 state->msg_len = strlen(state->msg);
f131db9e 1289 unuse_commit_buffer(commit, buffer);
df2760a5
PT
1290}
1291
1292/**
1293 * Writes `commit` as a patch to the state directory's "patch" file.
1294 */
1295static void write_commit_patch(const struct am_state *state, struct commit *commit)
1296{
1297 struct rev_info rev_info;
1298 FILE *fp;
1299
1300 fp = xfopen(am_path(state, "patch"), "w");
2abf3503 1301 repo_init_revisions(the_repository, &rev_info, NULL);
df2760a5
PT
1302 rev_info.diff = 1;
1303 rev_info.abbrev = 0;
1304 rev_info.disable_stdin = 1;
1305 rev_info.show_root_diff = 1;
1306 rev_info.diffopt.output_format = DIFF_FORMAT_PATCH;
1307 rev_info.no_commit_id = 1;
0d1e0e78
BW
1308 rev_info.diffopt.flags.binary = 1;
1309 rev_info.diffopt.flags.full_index = 1;
df2760a5
PT
1310 rev_info.diffopt.use_color = 0;
1311 rev_info.diffopt.file = fp;
1312 rev_info.diffopt.close_file = 1;
1313 add_pending_object(&rev_info, &commit->object, "");
1314 diff_setup_done(&rev_info.diffopt);
1315 log_tree_commit(&rev_info, commit);
1316}
1317
7ff26832
PT
1318/**
1319 * Writes the diff of the index against HEAD as a patch to the state
1320 * directory's "patch" file.
1321 */
1322static void write_index_patch(const struct am_state *state)
1323{
1324 struct tree *tree;
8c88769b 1325 struct object_id head;
7ff26832
PT
1326 struct rev_info rev_info;
1327 FILE *fp;
1328
7663e438
JK
1329 if (!get_oid("HEAD", &head)) {
1330 struct commit *commit = lookup_commit_or_die(&head, "HEAD");
1331 tree = get_commit_tree(commit);
1332 } else
f86bcc7b
SB
1333 tree = lookup_tree(the_repository,
1334 the_repository->hash_algo->empty_tree);
7ff26832
PT
1335
1336 fp = xfopen(am_path(state, "patch"), "w");
2abf3503 1337 repo_init_revisions(the_repository, &rev_info, NULL);
7ff26832
PT
1338 rev_info.diff = 1;
1339 rev_info.disable_stdin = 1;
1340 rev_info.no_commit_id = 1;
1341 rev_info.diffopt.output_format = DIFF_FORMAT_PATCH;
1342 rev_info.diffopt.use_color = 0;
1343 rev_info.diffopt.file = fp;
1344 rev_info.diffopt.close_file = 1;
1345 add_pending_object(&rev_info, &tree->object, "");
1346 diff_setup_done(&rev_info.diffopt);
1347 run_diff_index(&rev_info, 1);
1348}
1349
df2760a5
PT
1350/**
1351 * Like parse_mail(), but parses the mail by looking up its commit ID
1352 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1353 * of patches.
1354 *
13b97ea5
PT
1355 * state->orig_commit will be set to the original commit ID.
1356 *
df2760a5
PT
1357 * Will always return 0 as the patch should never be skipped.
1358 */
1359static int parse_mail_rebase(struct am_state *state, const char *mail)
1360{
1361 struct commit *commit;
8c88769b 1362 struct object_id commit_oid;
df2760a5 1363
8c88769b 1364 if (get_mail_commit_oid(&commit_oid, mail) < 0)
df2760a5
PT
1365 die(_("could not parse %s"), mail);
1366
bc83266a 1367 commit = lookup_commit_or_die(&commit_oid, mail);
df2760a5
PT
1368
1369 get_commit_info(state, commit);
1370
1371 write_commit_patch(state, commit);
1372
8c88769b 1373 oidcpy(&state->orig_commit, &commit_oid);
1374 write_state_text(state, "original-commit", oid_to_hex(&commit_oid));
fbd7a232
NTND
1375 update_ref("am", "REBASE_HEAD", &commit_oid,
1376 NULL, REF_NO_DEREF, UPDATE_REFS_DIE_ON_ERR);
13b97ea5 1377
df2760a5
PT
1378 return 0;
1379}
1380
38a824fe 1381/**
84f3de28
PT
1382 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1383 * `index_file` is not NULL, the patch will be applied to that index.
38a824fe 1384 */
84f3de28 1385static int run_apply(const struct am_state *state, const char *index_file)
38a824fe 1386{
edfac5eb
CC
1387 struct argv_array apply_paths = ARGV_ARRAY_INIT;
1388 struct argv_array apply_opts = ARGV_ARRAY_INIT;
1389 struct apply_state apply_state;
1390 int res, opts_left;
edfac5eb
CC
1391 int force_apply = 0;
1392 int options = 0;
1393
82ea77ec 1394 if (init_apply_state(&apply_state, the_repository, NULL))
033abf97 1395 BUG("init_apply_state() failed");
edfac5eb
CC
1396
1397 argv_array_push(&apply_opts, "apply");
1398 argv_array_pushv(&apply_opts, state->git_apply_opts.argv);
1399
1400 opts_left = apply_parse_options(apply_opts.argc, apply_opts.argv,
1401 &apply_state, &force_apply, &options,
1402 NULL);
1403
1404 if (opts_left != 0)
1405 die("unknown option passed through to git apply");
1406
1407 if (index_file) {
1408 apply_state.index_file = index_file;
1409 apply_state.cached = 1;
1410 } else
1411 apply_state.check_index = 1;
84f3de28
PT
1412
1413 /*
1414 * If we are allowed to fall back on 3-way merge, don't give false
1415 * errors during the initial attempt.
1416 */
edfac5eb
CC
1417 if (state->threeway && !index_file)
1418 apply_state.apply_verbosity = verbosity_silent;
84f3de28 1419
edfac5eb 1420 if (check_apply_state(&apply_state, force_apply))
033abf97 1421 BUG("check_apply_state() failed");
84f3de28 1422
edfac5eb 1423 argv_array_push(&apply_paths, am_path(state, "patch"));
257e8cec 1424
edfac5eb 1425 res = apply_all_patches(&apply_state, apply_paths.argc, apply_paths.argv, options);
84f3de28 1426
edfac5eb
CC
1427 argv_array_clear(&apply_paths);
1428 argv_array_clear(&apply_opts);
1429 clear_apply_state(&apply_state);
38a824fe 1430
edfac5eb
CC
1431 if (res)
1432 return res;
38a824fe 1433
edfac5eb
CC
1434 if (index_file) {
1435 /* Reload index as apply_all_patches() will have modified it. */
1436 discard_cache();
1437 read_cache_from(index_file);
1438 }
84f3de28
PT
1439
1440 return 0;
1441}
1442
1443/**
1444 * Builds an index that contains just the blobs needed for a 3way merge.
1445 */
1446static int build_fake_ancestor(const struct am_state *state, const char *index_file)
1447{
1448 struct child_process cp = CHILD_PROCESS_INIT;
1449
1450 cp.git_cmd = 1;
1451 argv_array_push(&cp.args, "apply");
257e8cec 1452 argv_array_pushv(&cp.args, state->git_apply_opts.argv);
84f3de28
PT
1453 argv_array_pushf(&cp.args, "--build-fake-ancestor=%s", index_file);
1454 argv_array_push(&cp.args, am_path(state, "patch"));
1455
1456 if (run_command(&cp))
1457 return -1;
1458
1459 return 0;
1460}
1461
1462/**
1463 * Attempt a threeway merge, using index_path as the temporary index.
1464 */
1465static int fall_back_threeway(const struct am_state *state, const char *index_path)
1466{
3f338f43
JS
1467 struct object_id orig_tree, their_tree, our_tree;
1468 const struct object_id *bases[1] = { &orig_tree };
1469 struct merge_options o;
1470 struct commit *result;
1471 char *their_tree_name;
84f3de28 1472
3f338f43 1473 if (get_oid("HEAD", &our_tree) < 0)
d41836a0 1474 oidcpy(&our_tree, the_hash_algo->empty_tree);
84f3de28
PT
1475
1476 if (build_fake_ancestor(state, index_path))
1477 return error("could not build fake ancestor");
1478
1479 discard_cache();
1480 read_cache_from(index_path);
1481
fc5cb99f 1482 if (write_index_as_tree(&orig_tree, &the_index, index_path, 0, NULL))
84f3de28
PT
1483 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1484
1485 say(state, stdout, _("Using index info to reconstruct a base tree..."));
1486
1487 if (!state->quiet) {
1488 /*
1489 * List paths that needed 3-way fallback, so that the user can
1490 * review them with extra care to spot mismerges.
1491 */
1492 struct rev_info rev_info;
84f3de28 1493
2abf3503 1494 repo_init_revisions(the_repository, &rev_info, NULL);
84f3de28 1495 rev_info.diffopt.output_format = DIFF_FORMAT_NAME_STATUS;
cdb5330a
NTND
1496 rev_info.diffopt.filter |= diff_filter_bit('A');
1497 rev_info.diffopt.filter |= diff_filter_bit('M');
a58a1b01 1498 add_pending_oid(&rev_info, "HEAD", &our_tree, 0);
84f3de28
PT
1499 diff_setup_done(&rev_info.diffopt);
1500 run_diff_index(&rev_info, 1);
1501 }
1502
1503 if (run_apply(state, index_path))
1504 return error(_("Did you hand edit your patch?\n"
1505 "It does not apply to blobs recorded in its index."));
1506
fc5cb99f 1507 if (write_index_as_tree(&their_tree, &the_index, index_path, 0, NULL))
84f3de28
PT
1508 return error("could not write tree");
1509
1510 say(state, stdout, _("Falling back to patching base and 3-way merge..."));
1511
38a824fe
PT
1512 discard_cache();
1513 read_cache();
1514
84f3de28
PT
1515 /*
1516 * This is not so wrong. Depending on which base we picked, orig_tree
715a51bc 1517 * may be wildly different from ours, but their_tree has the same set of
84f3de28
PT
1518 * wildly different changes in parts the patch did not touch, so
1519 * recursive ends up canceling them, saying that we reverted all those
1520 * changes.
1521 */
1522
0d6caa2d 1523 init_merge_options(&o, the_repository);
3f338f43
JS
1524
1525 o.branch1 = "HEAD";
1526 their_tree_name = xstrfmt("%.*s", linelen(state->msg), state->msg);
1527 o.branch2 = their_tree_name;
6aba117d 1528 o.detect_directory_renames = 0;
3f338f43
JS
1529
1530 if (state->quiet)
1531 o.verbosity = 0;
1532
1533 if (merge_recursive_generic(&o, &our_tree, &their_tree, 1, bases, &result)) {
35843b11 1534 repo_rerere(the_repository, state->allow_rerere_autoupdate);
3f338f43 1535 free(their_tree_name);
84f3de28
PT
1536 return error(_("Failed to merge in the changes."));
1537 }
1538
3f338f43 1539 free(their_tree_name);
38a824fe
PT
1540 return 0;
1541}
1542
c9e8d960
PT
1543/**
1544 * Commits the current index with state->msg as the commit message and
1545 * state->author_name, state->author_email and state->author_date as the author
1546 * information.
1547 */
1548static void do_commit(const struct am_state *state)
1549{
8c88769b 1550 struct object_id tree, parent, commit;
1551 const struct object_id *old_oid;
c9e8d960
PT
1552 struct commit_list *parents = NULL;
1553 const char *reflog_msg, *author;
1554 struct strbuf sb = STRBUF_INIT;
1555
6c24c5c0
PT
1556 if (run_hook_le(NULL, "pre-applypatch", NULL))
1557 exit(1);
1558
fc5cb99f 1559 if (write_cache_as_tree(&tree, 0, NULL))
c9e8d960
PT
1560 die(_("git write-tree failed to write a tree"));
1561
e82caf38 1562 if (!get_oid_commit("HEAD", &parent)) {
8c88769b 1563 old_oid = &parent;
c1f5eb49
SB
1564 commit_list_insert(lookup_commit(the_repository, &parent),
1565 &parents);
c9e8d960 1566 } else {
8c88769b 1567 old_oid = NULL;
5d28cf78 1568 say(state, stderr, _("applying to an empty history"));
c9e8d960
PT
1569 }
1570
1571 author = fmt_ident(state->author_name, state->author_email,
39ab4d09 1572 WANT_AUTHOR_IDENT,
f07adb62
PT
1573 state->ignore_date ? NULL : state->author_date,
1574 IDENT_STRICT);
c9e8d960 1575
0cd4bcba
PT
1576 if (state->committer_date_is_author_date)
1577 setenv("GIT_COMMITTER_DATE",
1578 state->ignore_date ? "" : state->author_date, 1);
1579
5078f344
PO
1580 if (commit_tree(state->msg, state->msg_len, &tree, parents, &commit,
1581 author, state->sign_commit))
c9e8d960
PT
1582 die(_("failed to write commit object"));
1583
1584 reflog_msg = getenv("GIT_REFLOG_ACTION");
1585 if (!reflog_msg)
1586 reflog_msg = "am";
1587
1588 strbuf_addf(&sb, "%s: %.*s", reflog_msg, linelen(state->msg),
1589 state->msg);
1590
ae077771 1591 update_ref(sb.buf, "HEAD", &commit, old_oid, 0,
1592 UPDATE_REFS_DIE_ON_ERR);
c9e8d960 1593
13b97ea5
PT
1594 if (state->rebasing) {
1595 FILE *fp = xfopen(am_path(state, "rewritten"), "a");
1596
8c88769b 1597 assert(!is_null_oid(&state->orig_commit));
1598 fprintf(fp, "%s ", oid_to_hex(&state->orig_commit));
1599 fprintf(fp, "%s\n", oid_to_hex(&commit));
13b97ea5
PT
1600 fclose(fp);
1601 }
1602
7088f807
PT
1603 run_hook_le(NULL, "post-applypatch", NULL);
1604
c9e8d960
PT
1605 strbuf_release(&sb);
1606}
1607
240bfd2d
PT
1608/**
1609 * Validates the am_state for resuming -- the "msg" and authorship fields must
1610 * be filled up.
1611 */
1612static void validate_resume_state(const struct am_state *state)
1613{
1614 if (!state->msg)
1615 die(_("cannot resume: %s does not exist."),
1616 am_path(state, "final-commit"));
1617
1618 if (!state->author_name || !state->author_email || !state->author_date)
1619 die(_("cannot resume: %s does not exist."),
1620 am_path(state, "author-script"));
1621}
1622
7ff26832
PT
1623/**
1624 * Interactively prompt the user on whether the current patch should be
1625 * applied.
1626 *
1627 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1628 * skip it.
1629 */
1630static int do_interactive(struct am_state *state)
1631{
1632 assert(state->msg);
1633
7ff26832 1634 for (;;) {
97387c8b 1635 char reply[64];
7ff26832
PT
1636
1637 puts(_("Commit Body is:"));
1638 puts("--------------------------");
1639 printf("%s", state->msg);
1640 puts("--------------------------");
1641
1642 /*
1643 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1644 * in your translation. The program will only accept English
1645 * input at this point.
1646 */
97387c8b
JK
1647 printf(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "));
1648 if (!fgets(reply, sizeof(reply), stdin))
1649 die("unable to read from stdin; aborting");
7ff26832 1650
1db65f32 1651 if (*reply == 'y' || *reply == 'Y') {
7ff26832
PT
1652 return 0;
1653 } else if (*reply == 'a' || *reply == 'A') {
1654 state->interactive = 0;
1655 return 0;
1656 } else if (*reply == 'n' || *reply == 'N') {
1657 return 1;
1658 } else if (*reply == 'e' || *reply == 'E') {
1659 struct strbuf msg = STRBUF_INIT;
1660
1661 if (!launch_editor(am_path(state, "final-commit"), &msg, NULL)) {
1662 free(state->msg);
1663 state->msg = strbuf_detach(&msg, &state->msg_len);
1664 }
1665 strbuf_release(&msg);
1666 } else if (*reply == 'v' || *reply == 'V') {
1667 const char *pager = git_pager(1);
1668 struct child_process cp = CHILD_PROCESS_INIT;
1669
1670 if (!pager)
1671 pager = "cat";
708b8cc9 1672 prepare_pager_args(&cp, pager);
7ff26832
PT
1673 argv_array_push(&cp.args, am_path(state, "patch"));
1674 run_command(&cp);
1675 }
1676 }
1677}
1678
8c3bd9e2
PT
1679/**
1680 * Applies all queued mail.
8c7b1563
PT
1681 *
1682 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1683 * well as the state directory's "patch" file is used as-is for applying the
1684 * patch and committing it.
8c3bd9e2 1685 */
8c7b1563 1686static void am_run(struct am_state *state, int resume)
8c3bd9e2 1687{
c9e8d960 1688 const char *argv_gc_auto[] = {"gc", "--auto", NULL};
32a5fcbf 1689 struct strbuf sb = STRBUF_INIT;
c9e8d960 1690
33388a71
PT
1691 unlink(am_path(state, "dirtyindex"));
1692
22184497
TG
1693 if (refresh_and_write_cache(REFRESH_QUIET, 0, 0) < 0)
1694 die(_("unable to write index file"));
38a824fe 1695
150fe065 1696 if (repo_index_has_changes(the_repository, NULL, &sb)) {
25b763ba 1697 write_state_bool(state, "dirtyindex", 1);
32a5fcbf 1698 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb.buf);
33388a71 1699 }
32a5fcbf
PT
1700
1701 strbuf_release(&sb);
1702
8c3bd9e2 1703 while (state->cur <= state->last) {
3e20dcf3 1704 const char *mail = am_path(state, msgnum(state));
84f3de28 1705 int apply_status;
3e20dcf3 1706
4d9c7e6f
JK
1707 reset_ident_date();
1708
3e20dcf3
PT
1709 if (!file_exists(mail))
1710 goto next;
1711
8c7b1563
PT
1712 if (resume) {
1713 validate_resume_state(state);
8c7b1563 1714 } else {
df2760a5
PT
1715 int skip;
1716
1717 if (state->rebasing)
1718 skip = parse_mail_rebase(state, mail);
1719 else
1720 skip = parse_mail(state, mail);
1721
1722 if (skip)
8c7b1563 1723 goto next; /* mail should be skipped */
3e20dcf3 1724
b7cc7051
GB
1725 if (state->signoff)
1726 am_append_signoff(state);
1727
8c7b1563
PT
1728 write_author_script(state);
1729 write_commit_msg(state);
1730 }
8c3bd9e2 1731
7ff26832
PT
1732 if (state->interactive && do_interactive(state))
1733 goto next;
1734
b8803d8f
PT
1735 if (run_applypatch_msg_hook(state))
1736 exit(1);
1737
5d28cf78 1738 say(state, stdout, _("Applying: %.*s"), linelen(state->msg), state->msg);
38a824fe 1739
84f3de28
PT
1740 apply_status = run_apply(state, NULL);
1741
1742 if (apply_status && state->threeway) {
1743 struct strbuf sb = STRBUF_INIT;
1744
1745 strbuf_addstr(&sb, am_path(state, "patch-merge-index"));
1746 apply_status = fall_back_threeway(state, sb.buf);
1747 strbuf_release(&sb);
1748
1749 /*
1750 * Applying the patch to an earlier tree and merging
1751 * the result may have produced the same tree as ours.
1752 */
e1f8694f 1753 if (!apply_status &&
150fe065 1754 !repo_index_has_changes(the_repository, NULL, NULL)) {
84f3de28
PT
1755 say(state, stdout, _("No changes -- Patch already applied."));
1756 goto next;
1757 }
1758 }
1759
1760 if (apply_status) {
38a824fe
PT
1761 printf_ln(_("Patch failed at %s %.*s"), msgnum(state),
1762 linelen(state->msg), state->msg);
1763
38a824fe 1764 if (advice_amworkdir)
431bb23a 1765 advise(_("Use 'git am --show-current-patch' to see the failed patch"));
38a824fe 1766
2d83109a 1767 die_user_resolve(state);
38a824fe
PT
1768 }
1769
c9e8d960 1770 do_commit(state);
8c3bd9e2 1771
3e20dcf3 1772next:
8c3bd9e2 1773 am_next(state);
852a1710
PT
1774
1775 if (resume)
1776 am_load(state);
1777 resume = 0;
8c3bd9e2
PT
1778 }
1779
e3b1e3bd 1780 if (!is_empty_or_missing_file(am_path(state, "rewritten"))) {
13b97ea5 1781 assert(state->rebasing);
88b291fe 1782 copy_notes_for_rebase(state);
13b97ea5
PT
1783 run_post_rewrite_hook(state);
1784 }
1785
35bdcc59
PT
1786 /*
1787 * In rebasing mode, it's up to the caller to take care of
1788 * housekeeping.
1789 */
1790 if (!state->rebasing) {
1791 am_destroy(state);
2d511cfc 1792 close_object_store(the_repository->objects);
35bdcc59
PT
1793 run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
1794 }
8c3bd9e2 1795}
73c2779f 1796
240bfd2d
PT
1797/**
1798 * Resume the current am session after patch application failure. The user did
1799 * all the hard work, and we do not have to do any patch application. Just
1800 * trust and commit what the user has in the index and working tree.
1801 */
1802static void am_resolve(struct am_state *state)
1803{
1804 validate_resume_state(state);
1805
5d28cf78 1806 say(state, stdout, _("Applying: %.*s"), linelen(state->msg), state->msg);
240bfd2d 1807
150fe065 1808 if (!repo_index_has_changes(the_repository, NULL, NULL)) {
240bfd2d
PT
1809 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1810 "If there is nothing left to stage, chances are that something else\n"
1811 "already introduced the same changes; you might want to skip this patch."));
2d83109a 1812 die_user_resolve(state);
240bfd2d
PT
1813 }
1814
1815 if (unmerged_cache()) {
1816 printf_ln(_("You still have unmerged paths in your index.\n"
6c486862
JNA
1817 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1818 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
2d83109a 1819 die_user_resolve(state);
240bfd2d
PT
1820 }
1821
7ff26832
PT
1822 if (state->interactive) {
1823 write_index_patch(state);
1824 if (do_interactive(state))
1825 goto next;
1826 }
1827
35843b11 1828 repo_rerere(the_repository, 0);
f1cb96d6 1829
240bfd2d
PT
1830 do_commit(state);
1831
7ff26832 1832next:
240bfd2d 1833 am_next(state);
852a1710 1834 am_load(state);
8c7b1563 1835 am_run(state, 0);
240bfd2d
PT
1836}
1837
9990080c
PT
1838/**
1839 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1840 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1841 * failure.
1842 */
1843static int fast_forward_to(struct tree *head, struct tree *remote, int reset)
1844{
837e34eb 1845 struct lock_file lock_file = LOCK_INIT;
9990080c
PT
1846 struct unpack_trees_options opts;
1847 struct tree_desc t[2];
1848
1849 if (parse_tree(head) || parse_tree(remote))
1850 return -1;
1851
837e34eb 1852 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
9990080c
PT
1853
1854 refresh_cache(REFRESH_QUIET);
1855
1856 memset(&opts, 0, sizeof(opts));
1857 opts.head_idx = 1;
1858 opts.src_index = &the_index;
1859 opts.dst_index = &the_index;
1860 opts.update = 1;
1861 opts.merge = 1;
1862 opts.reset = reset;
1863 opts.fn = twoway_merge;
1864 init_tree_desc(&t[0], head->buffer, head->size);
1865 init_tree_desc(&t[1], remote->buffer, remote->size);
1866
1867 if (unpack_trees(2, t, &opts)) {
837e34eb 1868 rollback_lock_file(&lock_file);
9990080c
PT
1869 return -1;
1870 }
1871
837e34eb 1872 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
9990080c
PT
1873 die(_("unable to write new index file"));
1874
1875 return 0;
1876}
1877
3ecc7040
PT
1878/**
1879 * Merges a tree into the index. The index's stat info will take precedence
1880 * over the merged tree's. Returns 0 on success, -1 on failure.
1881 */
1882static int merge_tree(struct tree *tree)
1883{
837e34eb 1884 struct lock_file lock_file = LOCK_INIT;
3ecc7040
PT
1885 struct unpack_trees_options opts;
1886 struct tree_desc t[1];
1887
1888 if (parse_tree(tree))
1889 return -1;
1890
837e34eb 1891 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
3ecc7040
PT
1892
1893 memset(&opts, 0, sizeof(opts));
1894 opts.head_idx = 1;
1895 opts.src_index = &the_index;
1896 opts.dst_index = &the_index;
1897 opts.merge = 1;
1898 opts.fn = oneway_merge;
1899 init_tree_desc(&t[0], tree->buffer, tree->size);
1900
1901 if (unpack_trees(1, t, &opts)) {
837e34eb 1902 rollback_lock_file(&lock_file);
3ecc7040
PT
1903 return -1;
1904 }
1905
837e34eb 1906 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
3ecc7040
PT
1907 die(_("unable to write new index file"));
1908
1909 return 0;
1910}
1911
9990080c
PT
1912/**
1913 * Clean the index without touching entries that are not modified between
1914 * `head` and `remote`.
1915 */
8c88769b 1916static int clean_index(const struct object_id *head, const struct object_id *remote)
9990080c 1917{
9990080c 1918 struct tree *head_tree, *remote_tree, *index_tree;
8c88769b 1919 struct object_id index;
9990080c 1920
a9dbc179 1921 head_tree = parse_tree_indirect(head);
9990080c 1922 if (!head_tree)
8c88769b 1923 return error(_("Could not parse object '%s'."), oid_to_hex(head));
9990080c 1924
a9dbc179 1925 remote_tree = parse_tree_indirect(remote);
9990080c 1926 if (!remote_tree)
8c88769b 1927 return error(_("Could not parse object '%s'."), oid_to_hex(remote));
9990080c
PT
1928
1929 read_cache_unmerged();
1930
1931 if (fast_forward_to(head_tree, head_tree, 1))
1932 return -1;
1933
fc5cb99f 1934 if (write_cache_as_tree(&index, 0, NULL))
9990080c
PT
1935 return -1;
1936
a9dbc179 1937 index_tree = parse_tree_indirect(&index);
9990080c 1938 if (!index_tree)
8c88769b 1939 return error(_("Could not parse object '%s'."), oid_to_hex(&index));
9990080c
PT
1940
1941 if (fast_forward_to(index_tree, remote_tree, 0))
1942 return -1;
1943
3ecc7040 1944 if (merge_tree(remote_tree))
9990080c 1945 return -1;
9990080c 1946
f4a4b9ac 1947 remove_branch_state(the_repository, 0);
9990080c
PT
1948
1949 return 0;
1950}
1951
f1cb96d6
PT
1952/**
1953 * Resets rerere's merge resolution metadata.
1954 */
1955static void am_rerere_clear(void)
1956{
1957 struct string_list merge_rr = STRING_LIST_INIT_DUP;
55e6b354 1958 rerere_clear(the_repository, &merge_rr);
f1cb96d6
PT
1959 string_list_clear(&merge_rr, 1);
1960}
1961
9990080c
PT
1962/**
1963 * Resume the current am session by skipping the current patch.
1964 */
1965static void am_skip(struct am_state *state)
1966{
8c88769b 1967 struct object_id head;
9990080c 1968
f1cb96d6
PT
1969 am_rerere_clear();
1970
8c88769b 1971 if (get_oid("HEAD", &head))
d41836a0 1972 oidcpy(&head, the_hash_algo->empty_tree);
9990080c 1973
8c88769b 1974 if (clean_index(&head, &head))
9990080c
PT
1975 die(_("failed to clean index"));
1976
45339f74
EN
1977 if (state->rebasing) {
1978 FILE *fp = xfopen(am_path(state, "rewritten"), "a");
1979
1980 assert(!is_null_oid(&state->orig_commit));
1981 fprintf(fp, "%s ", oid_to_hex(&state->orig_commit));
1982 fprintf(fp, "%s\n", oid_to_hex(&head));
1983 fclose(fp);
1984 }
1985
9990080c 1986 am_next(state);
852a1710 1987 am_load(state);
9990080c
PT
1988 am_run(state, 0);
1989}
1990
33388a71
PT
1991/**
1992 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
1993 *
1994 * It is not safe to reset HEAD when:
1995 * 1. git-am previously failed because the index was dirty.
1996 * 2. HEAD has moved since git-am previously failed.
1997 */
1998static int safe_to_abort(const struct am_state *state)
1999{
2000 struct strbuf sb = STRBUF_INIT;
8c88769b 2001 struct object_id abort_safety, head;
33388a71
PT
2002
2003 if (file_exists(am_path(state, "dirtyindex")))
2004 return 0;
2005
2006 if (read_state_file(&sb, state, "abort-safety", 1) > 0) {
8c88769b 2007 if (get_oid_hex(sb.buf, &abort_safety))
ccd71b2f 2008 die(_("could not parse %s"), am_path(state, "abort-safety"));
33388a71 2009 } else
8c88769b 2010 oidclr(&abort_safety);
28ac7aa7 2011 strbuf_release(&sb);
33388a71 2012
8c88769b 2013 if (get_oid("HEAD", &head))
2014 oidclr(&head);
33388a71 2015
4a7e27e9 2016 if (oideq(&head, &abort_safety))
33388a71
PT
2017 return 1;
2018
1868331f 2019 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
33388a71
PT
2020 "Not rewinding to ORIG_HEAD"));
2021
2022 return 0;
2023}
2024
2025/**
2026 * Aborts the current am session if it is safe to do so.
2027 */
2028static void am_abort(struct am_state *state)
2029{
8c88769b 2030 struct object_id curr_head, orig_head;
33388a71
PT
2031 int has_curr_head, has_orig_head;
2032 char *curr_branch;
2033
2034 if (!safe_to_abort(state)) {
2035 am_destroy(state);
2036 return;
2037 }
2038
f1cb96d6
PT
2039 am_rerere_clear();
2040
0f2dc722 2041 curr_branch = resolve_refdup("HEAD", 0, &curr_head, NULL);
57e0ef0e 2042 has_curr_head = curr_branch && !is_null_oid(&curr_head);
33388a71 2043 if (!has_curr_head)
d41836a0 2044 oidcpy(&curr_head, the_hash_algo->empty_tree);
33388a71 2045
8c88769b 2046 has_orig_head = !get_oid("ORIG_HEAD", &orig_head);
33388a71 2047 if (!has_orig_head)
d41836a0 2048 oidcpy(&orig_head, the_hash_algo->empty_tree);
33388a71 2049
8c88769b 2050 clean_index(&curr_head, &orig_head);
33388a71
PT
2051
2052 if (has_orig_head)
ae077771 2053 update_ref("am --abort", "HEAD", &orig_head,
2054 has_curr_head ? &curr_head : NULL, 0,
2055 UPDATE_REFS_DIE_ON_ERR);
33388a71 2056 else if (curr_branch)
91774afc 2057 delete_ref(NULL, curr_branch, NULL, REF_NO_DEREF);
33388a71
PT
2058
2059 free(curr_branch);
2060 am_destroy(state);
2061}
2062
984913a2
NTND
2063static int show_patch(struct am_state *state)
2064{
2065 struct strbuf sb = STRBUF_INIT;
2066 const char *patch_path;
2067 int len;
2068
66335298
NTND
2069 if (!is_null_oid(&state->orig_commit)) {
2070 const char *av[4] = { "show", NULL, "--", NULL };
2071 char *new_oid_str;
2072 int ret;
2073
2074 av[1] = new_oid_str = xstrdup(oid_to_hex(&state->orig_commit));
2075 ret = run_command_v_opt(av, RUN_GIT_CMD);
2076 free(new_oid_str);
2077 return ret;
2078 }
2079
984913a2
NTND
2080 patch_path = am_path(state, msgnum(state));
2081 len = strbuf_read_file(&sb, patch_path, 0);
2082 if (len < 0)
2083 die_errno(_("failed to read '%s'"), patch_path);
2084
2085 setup_pager();
2086 write_in_full(1, sb.buf, sb.len);
2087 strbuf_release(&sb);
2088 return 0;
2089}
2090
11c2177f
PT
2091/**
2092 * parse_options() callback that validates and sets opt->value to the
2093 * PATCH_FORMAT_* enum value corresponding to `arg`.
2094 */
2095static int parse_opt_patchformat(const struct option *opt, const char *arg, int unset)
2096{
2097 int *opt_value = opt->value;
2098
fce56648
JK
2099 if (unset)
2100 *opt_value = PATCH_FORMAT_UNKNOWN;
2101 else if (!strcmp(arg, "mbox"))
11c2177f 2102 *opt_value = PATCH_FORMAT_MBOX;
5ae41c79
PT
2103 else if (!strcmp(arg, "stgit"))
2104 *opt_value = PATCH_FORMAT_STGIT;
336108c1
PT
2105 else if (!strcmp(arg, "stgit-series"))
2106 *opt_value = PATCH_FORMAT_STGIT_SERIES;
94cd175c
PT
2107 else if (!strcmp(arg, "hg"))
2108 *opt_value = PATCH_FORMAT_HG;
d9925d1a
EW
2109 else if (!strcmp(arg, "mboxrd"))
2110 *opt_value = PATCH_FORMAT_MBOXRD;
5a59a230
NTND
2111 /*
2112 * Please update $__git_patchformat in git-completion.bash
2113 * when you add new options
2114 */
11c2177f
PT
2115 else
2116 return error(_("Invalid value for --patch-format: %s"), arg);
2117 return 0;
2118}
2119
240bfd2d
PT
2120enum resume_mode {
2121 RESUME_FALSE = 0,
8c7b1563 2122 RESUME_APPLY,
9990080c 2123 RESUME_RESOLVED,
33388a71 2124 RESUME_SKIP,
65ed8ff3 2125 RESUME_ABORT,
9ca488c0 2126 RESUME_QUIT,
984913a2 2127 RESUME_SHOW_PATCH
240bfd2d
PT
2128};
2129
434c64df
RMM
2130static int git_am_config(const char *k, const char *v, void *cb)
2131{
2132 int status;
2133
2134 status = git_gpg_config(k, v, NULL);
2135 if (status)
2136 return status;
2137
2138 return git_default_config(k, v, NULL);
2139}
2140
73c2779f
PT
2141int cmd_am(int argc, const char **argv, const char *prefix)
2142{
8c3bd9e2 2143 struct am_state state;
c2676cde 2144 int binary = -1;
5d123a40 2145 int keep_cr = -1;
11c2177f 2146 int patch_format = PATCH_FORMAT_UNKNOWN;
240bfd2d 2147 enum resume_mode resume = RESUME_FALSE;
852a1710 2148 int in_progress;
984913a2 2149 int ret = 0;
8c3bd9e2
PT
2150
2151 const char * const usage[] = {
d65fdc9c 2152 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
d96a0313 2153 N_("git am [<options>] (--continue | --skip | --abort)"),
8c3bd9e2
PT
2154 NULL
2155 };
2156
2157 struct option options[] = {
7ff26832
PT
2158 OPT_BOOL('i', "interactive", &state.interactive,
2159 N_("run interactively")),
c2676cde 2160 OPT_HIDDEN_BOOL('b', "binary", &binary,
1fb5a0ea 2161 N_("historical option -- no-op")),
84f3de28
PT
2162 OPT_BOOL('3', "3way", &state.threeway,
2163 N_("allow fall back on 3way merging if needed")),
5d28cf78 2164 OPT__QUIET(&state.quiet, N_("be quiet")),
b5e82359
PT
2165 OPT_SET_INT('s', "signoff", &state.signoff,
2166 N_("add a Signed-off-by line to the commit message"),
2167 SIGNOFF_EXPLICIT),
ef7ee16d
PT
2168 OPT_BOOL('u', "utf8", &state.utf8,
2169 N_("recode into utf8 (default)")),
4f1b6961
PT
2170 OPT_SET_INT('k', "keep", &state.keep,
2171 N_("pass -k flag to git-mailinfo"), KEEP_TRUE),
2172 OPT_SET_INT(0, "keep-non-patch", &state.keep,
2173 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH),
702cbaad
PT
2174 OPT_BOOL('m', "message-id", &state.message_id,
2175 N_("pass -m flag to git-mailinfo")),
3e4a67b4
NTND
2176 OPT_SET_INT_F(0, "keep-cr", &keep_cr,
2177 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2178 1, PARSE_OPT_NONEG),
2179 OPT_SET_INT_F(0, "no-keep-cr", &keep_cr,
2180 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2181 0, PARSE_OPT_NONEG),
9b646617
PT
2182 OPT_BOOL('c', "scissors", &state.scissors,
2183 N_("strip everything before a scissors line")),
257e8cec
PT
2184 OPT_PASSTHRU_ARGV(0, "whitespace", &state.git_apply_opts, N_("action"),
2185 N_("pass it through git-apply"),
2186 0),
2187 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state.git_apply_opts, NULL,
2188 N_("pass it through git-apply"),
2189 PARSE_OPT_NOARG),
2190 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state.git_apply_opts, NULL,
2191 N_("pass it through git-apply"),
2192 PARSE_OPT_NOARG),
2193 OPT_PASSTHRU_ARGV(0, "directory", &state.git_apply_opts, N_("root"),
2194 N_("pass it through git-apply"),
2195 0),
2196 OPT_PASSTHRU_ARGV(0, "exclude", &state.git_apply_opts, N_("path"),
2197 N_("pass it through git-apply"),
2198 0),
2199 OPT_PASSTHRU_ARGV(0, "include", &state.git_apply_opts, N_("path"),
2200 N_("pass it through git-apply"),
2201 0),
2202 OPT_PASSTHRU_ARGV('C', NULL, &state.git_apply_opts, N_("n"),
2203 N_("pass it through git-apply"),
2204 0),
2205 OPT_PASSTHRU_ARGV('p', NULL, &state.git_apply_opts, N_("num"),
2206 N_("pass it through git-apply"),
2207 0),
11c2177f
PT
2208 OPT_CALLBACK(0, "patch-format", &patch_format, N_("format"),
2209 N_("format the patch(es) are in"),
2210 parse_opt_patchformat),
257e8cec
PT
2211 OPT_PASSTHRU_ARGV(0, "reject", &state.git_apply_opts, NULL,
2212 N_("pass it through git-apply"),
2213 PARSE_OPT_NOARG),
2d83109a
PT
2214 OPT_STRING(0, "resolvemsg", &state.resolvemsg, NULL,
2215 N_("override error message when patch failure occurs")),
240bfd2d
PT
2216 OPT_CMDMODE(0, "continue", &resume,
2217 N_("continue applying patches after resolving a conflict"),
2218 RESUME_RESOLVED),
2219 OPT_CMDMODE('r', "resolved", &resume,
2220 N_("synonyms for --continue"),
2221 RESUME_RESOLVED),
9990080c
PT
2222 OPT_CMDMODE(0, "skip", &resume,
2223 N_("skip the current patch"),
2224 RESUME_SKIP),
33388a71
PT
2225 OPT_CMDMODE(0, "abort", &resume,
2226 N_("restore the original branch and abort the patching operation."),
2227 RESUME_ABORT),
65ed8ff3
NTND
2228 OPT_CMDMODE(0, "quit", &resume,
2229 N_("abort the patching operation but keep HEAD where it is."),
2230 RESUME_QUIT),
984913a2
NTND
2231 OPT_CMDMODE(0, "show-current-patch", &resume,
2232 N_("show the patch being applied."),
2233 RESUME_SHOW_PATCH),
0cd4bcba
PT
2234 OPT_BOOL(0, "committer-date-is-author-date",
2235 &state.committer_date_is_author_date,
2236 N_("lie about committer date")),
f07adb62
PT
2237 OPT_BOOL(0, "ignore-date", &state.ignore_date,
2238 N_("use current timestamp for author date")),
f1cb96d6 2239 OPT_RERERE_AUTOUPDATE(&state.allow_rerere_autoupdate),
7e35dacb
PT
2240 { OPTION_STRING, 'S', "gpg-sign", &state.sign_commit, N_("key-id"),
2241 N_("GPG-sign commits"),
2242 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
35bdcc59
PT
2243 OPT_HIDDEN_BOOL(0, "rebasing", &state.rebasing,
2244 N_("(internal use for git-rebase)")),
8c3bd9e2
PT
2245 OPT_END()
2246 };
73c2779f 2247
f3a2fffe
JK
2248 if (argc == 2 && !strcmp(argv[1], "-h"))
2249 usage_with_options(usage, options);
2250
434c64df 2251 git_config(git_am_config, NULL);
8c3bd9e2 2252
16d2676c 2253 am_state_init(&state);
8c3bd9e2 2254
852a1710
PT
2255 in_progress = am_in_progress(&state);
2256 if (in_progress)
2257 am_load(&state);
2258
8c3bd9e2
PT
2259 argc = parse_options(argc, argv, prefix, options, usage, 0);
2260
c2676cde
PT
2261 if (binary >= 0)
2262 fprintf_ln(stderr, _("The -b/--binary option has been a no-op for long time, and\n"
2263 "it will be removed. Please do not use it anymore."));
2264
5e4f9cff
PT
2265 /* Ensure a valid committer ident can be constructed */
2266 git_committer_info(IDENT_STRICT);
2267
e1ff0a32 2268 if (repo_read_index_preload(the_repository, NULL, 0) < 0)
38a824fe
PT
2269 die(_("failed to read the index"));
2270
852a1710 2271 if (in_progress) {
8d185503
PT
2272 /*
2273 * Catch user error to feed us patches when there is a session
2274 * in progress:
2275 *
2276 * 1. mbox path(s) are provided on the command-line.
2277 * 2. stdin is not a tty: the user is trying to feed us a patch
2278 * from standard input. This is somewhat unreliable -- stdin
2279 * could be /dev/null for example and the caller did not
2280 * intend to feed us a patch but wanted to continue
2281 * unattended.
2282 */
2283 if (argc || (resume == RESUME_FALSE && !isatty(0)))
2284 die(_("previous rebase directory %s still exists but mbox given."),
2285 state.dir);
2286
8c7b1563
PT
2287 if (resume == RESUME_FALSE)
2288 resume = RESUME_APPLY;
b5e82359
PT
2289
2290 if (state.signoff == SIGNOFF_EXPLICIT)
2291 am_append_signoff(&state);
8c7b1563 2292 } else {
11c2177f
PT
2293 struct argv_array paths = ARGV_ARRAY_INIT;
2294 int i;
2295
6d42ac29
PT
2296 /*
2297 * Handle stray state directory in the independent-run case. In
2298 * the --rebasing case, it is up to the caller to take care of
2299 * stray directories.
2300 */
2301 if (file_exists(state.dir) && !state.rebasing) {
65ed8ff3 2302 if (resume == RESUME_ABORT || resume == RESUME_QUIT) {
6d42ac29
PT
2303 am_destroy(&state);
2304 am_state_release(&state);
2305 return 0;
2306 }
2307
2308 die(_("Stray %s directory found.\n"
2309 "Use \"git am --abort\" to remove it."),
2310 state.dir);
2311 }
2312
240bfd2d
PT
2313 if (resume)
2314 die(_("Resolve operation not in progress, we are not resuming."));
2315
11c2177f
PT
2316 for (i = 0; i < argc; i++) {
2317 if (is_absolute_path(argv[i]) || !prefix)
2318 argv_array_push(&paths, argv[i]);
2319 else
2320 argv_array_push(&paths, mkpath("%s/%s", prefix, argv[i]));
2321 }
2322
6e7baf24
JK
2323 if (state.interactive && !paths.argc)
2324 die(_("interactive mode requires patches on the command line"));
2325
5d123a40 2326 am_setup(&state, patch_format, paths.argv, keep_cr);
11c2177f
PT
2327
2328 argv_array_clear(&paths);
2329 }
8c3bd9e2 2330
240bfd2d
PT
2331 switch (resume) {
2332 case RESUME_FALSE:
8c7b1563
PT
2333 am_run(&state, 0);
2334 break;
2335 case RESUME_APPLY:
2336 am_run(&state, 1);
240bfd2d
PT
2337 break;
2338 case RESUME_RESOLVED:
2339 am_resolve(&state);
2340 break;
9990080c
PT
2341 case RESUME_SKIP:
2342 am_skip(&state);
2343 break;
33388a71
PT
2344 case RESUME_ABORT:
2345 am_abort(&state);
2346 break;
65ed8ff3
NTND
2347 case RESUME_QUIT:
2348 am_rerere_clear();
2349 am_destroy(&state);
2350 break;
984913a2
NTND
2351 case RESUME_SHOW_PATCH:
2352 ret = show_patch(&state);
2353 break;
240bfd2d 2354 default:
033abf97 2355 BUG("invalid resume value");
240bfd2d 2356 }
8c3bd9e2
PT
2357
2358 am_state_release(&state);
2359
984913a2 2360 return ret;
73c2779f 2361}