git.oblomov.eu Git - git/blob - builtin/am.c

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