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