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