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