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