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