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