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