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