builtin/stash.c

   1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
   2 #include "builtin.h"
   3 #include "config.h"
   4 #include "parse-options.h"
   5 #include "refs.h"
   6 #include "lockfile.h"
   7 #include "cache-tree.h"
   8 #include "unpack-trees.h"
   9 #include "merge-recursive.h"
  10 #include "strvec.h"
  11 #include "run-command.h"
  12 #include "dir.h"
  13 #include "entry.h"
  14 #include "rerere.h"
  15 #include "revision.h"
  16 #include "log-tree.h"
  17 #include "diffcore.h"
  18 #include "exec-cmd.h"
  19 #include "entry.h"
  20
  21 #define INCLUDE_ALL_FILES 2
  22
  23 static const char * const git_stash_usage[] = {
  24         N_("git stash list [<options>]"),
  25         N_("git stash show [<options>] [<stash>]"),
  26         N_("git stash drop [-q|--quiet] [<stash>]"),
  27         N_("git stash ( pop | apply ) [--index] [-q|--quiet] [<stash>]"),
  28         N_("git stash branch <branchname> [<stash>]"),
  29         "git stash clear",
  30         N_("git stash [push [-p|--patch] [-S|--staged] [-k|--[no-]keep-index] [-q|--quiet]\n"
  31            "          [-u|--include-untracked] [-a|--all] [-m|--message <message>]\n"
  32            "          [--pathspec-from-file=<file> [--pathspec-file-nul]]\n"
  33            "          [--] [<pathspec>...]]"),
  34         N_("git stash save [-p|--patch] [-S|--staged] [-k|--[no-]keep-index] [-q|--quiet]\n"
  35            "          [-u|--include-untracked] [-a|--all] [<message>]"),
  36         NULL
  37 };
  38
  39 static const char * const git_stash_list_usage[] = {
  40         N_("git stash list [<options>]"),
  41         NULL
  42 };
  43
  44 static const char * const git_stash_show_usage[] = {
  45         N_("git stash show [<options>] [<stash>]"),
  46         NULL
  47 };
  48
  49 static const char * const git_stash_drop_usage[] = {
  50         N_("git stash drop [-q|--quiet] [<stash>]"),
  51         NULL
  52 };
  53
  54 static const char * const git_stash_pop_usage[] = {
  55         N_("git stash pop [--index] [-q|--quiet] [<stash>]"),
  56         NULL
  57 };
  58
  59 static const char * const git_stash_apply_usage[] = {
  60         N_("git stash apply [--index] [-q|--quiet] [<stash>]"),
  61         NULL
  62 };
  63
  64 static const char * const git_stash_branch_usage[] = {
  65         N_("git stash branch <branchname> [<stash>]"),
  66         NULL
  67 };
  68
  69 static const char * const git_stash_clear_usage[] = {
  70         "git stash clear",
  71         NULL
  72 };
  73
  74 static const char * const git_stash_store_usage[] = {
  75         N_("git stash store [-m|--message <message>] [-q|--quiet] <commit>"),
  76         NULL
  77 };
  78
  79 static const char * const git_stash_push_usage[] = {
  80         N_("git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
  81            "          [-u|--include-untracked] [-a|--all] [-m|--message <message>]\n"
  82            "          [--] [<pathspec>...]]"),
  83         NULL
  84 };
  85
  86 static const char * const git_stash_save_usage[] = {
  87         N_("git stash save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n"
  88            "               [-u|--include-untracked] [-a|--all] [<message>]"),
  89         NULL
  90 };
  91
  92 static const char ref_stash[] = "refs/stash";
  93 static struct strbuf stash_index_path = STRBUF_INIT;
  94
  95 /*
  96  * w_commit is set to the commit containing the working tree
  97  * b_commit is set to the base commit
  98  * i_commit is set to the commit containing the index tree
  99  * u_commit is set to the commit containing the untracked files tree
 100  * w_tree is set to the working tree
 101  * b_tree is set to the base tree
 102  * i_tree is set to the index tree
 103  * u_tree is set to the untracked files tree
 104  */
 105 struct stash_info {
 106         struct object_id w_commit;
 107         struct object_id b_commit;
 108         struct object_id i_commit;
 109         struct object_id u_commit;
 110         struct object_id w_tree;
 111         struct object_id b_tree;
 112         struct object_id i_tree;
 113         struct object_id u_tree;
 114         struct strbuf revision;
 115         int is_stash_ref;
 116         int has_u;
 117 };
 118
 119 static void free_stash_info(struct stash_info *info)
 120 {
 121         strbuf_release(&info->revision);
 122 }
 123
 124 static void assert_stash_like(struct stash_info *info, const char *revision)
 125 {
 126         if (get_oidf(&info->b_commit, "%s^1", revision) ||
 127             get_oidf(&info->w_tree, "%s:", revision) ||
 128             get_oidf(&info->b_tree, "%s^1:", revision) ||
 129             get_oidf(&info->i_tree, "%s^2:", revision))
 130                 die(_("'%s' is not a stash-like commit"), revision);
 131 }
 132
 133 static int get_stash_info(struct stash_info *info, int argc, const char **argv)
 134 {
 135         int ret;
 136         char *end_of_rev;
 137         char *expanded_ref;
 138         const char *revision;
 139         const char *commit = NULL;
 140         struct object_id dummy;
 141         struct strbuf symbolic = STRBUF_INIT;
 142
 143         if (argc > 1) {
 144                 int i;
 145                 struct strbuf refs_msg = STRBUF_INIT;
 146
 147                 for (i = 0; i < argc; i++)
 148                         strbuf_addf(&refs_msg, " '%s'", argv[i]);
 149
 150                 fprintf_ln(stderr, _("Too many revisions specified:%s"),
 151                            refs_msg.buf);
 152                 strbuf_release(&refs_msg);
 153
 154                 return -1;
 155         }
 156
 157         if (argc == 1)
 158                 commit = argv[0];
 159
 160         strbuf_init(&info->revision, 0);
 161         if (!commit) {
 162                 if (!ref_exists(ref_stash)) {
 163                         free_stash_info(info);
 164                         fprintf_ln(stderr, _("No stash entries found."));
 165                         return -1;
 166                 }
 167
 168                 strbuf_addf(&info->revision, "%s@{0}", ref_stash);
 169         } else if (strspn(commit, "0123456789") == strlen(commit)) {
 170                 strbuf_addf(&info->revision, "%s@{%s}", ref_stash, commit);
 171         } else {
 172                 strbuf_addstr(&info->revision, commit);
 173         }
 174
 175         revision = info->revision.buf;
 176
 177         if (get_oid(revision, &info->w_commit)) {
 178                 error(_("%s is not a valid reference"), revision);
 179                 free_stash_info(info);
 180                 return -1;
 181         }
 182
 183         assert_stash_like(info, revision);
 184
 185         info->has_u = !get_oidf(&info->u_tree, "%s^3:", revision);
 186
 187         end_of_rev = strchrnul(revision, '@');
 188         strbuf_add(&symbolic, revision, end_of_rev - revision);
 189
 190         ret = dwim_ref(symbolic.buf, symbolic.len, &dummy, &expanded_ref, 0);
 191         strbuf_release(&symbolic);
 192         switch (ret) {
 193         case 0: /* Not found, but valid ref */
 194                 info->is_stash_ref = 0;
 195                 break;
 196         case 1:
 197                 info->is_stash_ref = !strcmp(expanded_ref, ref_stash);
 198                 break;
 199         default: /* Invalid or ambiguous */
 200                 free_stash_info(info);
 201         }
 202
 203         free(expanded_ref);
 204         return !(ret == 0 || ret == 1);
 205 }
 206
 207 static int do_clear_stash(void)
 208 {
 209         struct object_id obj;
 210         if (get_oid(ref_stash, &obj))
 211                 return 0;
 212
 213         return delete_ref(NULL, ref_stash, &obj, 0);
 214 }
 215
 216 static int clear_stash(int argc, const char **argv, const char *prefix)
 217 {
 218         struct option options[] = {
 219                 OPT_END()
 220         };
 221
 222         argc = parse_options(argc, argv, prefix, options,
 223                              git_stash_clear_usage,
 224                              PARSE_OPT_STOP_AT_NON_OPTION);
 225
 226         if (argc)
 227                 return error(_("git stash clear with arguments is "
 228                                "unimplemented"));
 229
 230         return do_clear_stash();
 231 }
 232
 233 static int reset_tree(struct object_id *i_tree, int update, int reset)
 234 {
 235         int nr_trees = 1;
 236         struct unpack_trees_options opts;
 237         struct tree_desc t[MAX_UNPACK_TREES];
 238         struct tree *tree;
 239         struct lock_file lock_file = LOCK_INIT;
 240
 241         read_cache_preload(NULL);
 242         if (refresh_cache(REFRESH_QUIET))
 243                 return -1;
 244
 245         hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
 246
 247         memset(&opts, 0, sizeof(opts));
 248
 249         tree = parse_tree_indirect(i_tree);
 250         if (parse_tree(tree))
 251                 return -1;
 252
 253         init_tree_desc(t, tree->buffer, tree->size);
 254
 255         opts.head_idx = 1;
 256         opts.src_index = &the_index;
 257         opts.dst_index = &the_index;
 258         opts.merge = 1;
 259         opts.reset = reset ? UNPACK_RESET_PROTECT_UNTRACKED : 0;
 260         opts.update = update;
 261         if (update)
 262                 opts.preserve_ignored = 0; /* FIXME: !overwrite_ignore */
 263         opts.fn = oneway_merge;
 264
 265         if (unpack_trees(nr_trees, t, &opts))
 266                 return -1;
 267
 268         if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
 269                 return error(_("unable to write new index file"));
 270
 271         return 0;
 272 }
 273
 274 static int diff_tree_binary(struct strbuf *out, struct object_id *w_commit)
 275 {
 276         struct child_process cp = CHILD_PROCESS_INIT;
 277         const char *w_commit_hex = oid_to_hex(w_commit);
 278
 279         /*
 280          * Diff-tree would not be very hard to replace with a native function,
 281          * however it should be done together with apply_cached.
 282          */
 283         cp.git_cmd = 1;
 284         strvec_pushl(&cp.args, "diff-tree", "--binary", NULL);
 285         strvec_pushf(&cp.args, "%s^2^..%s^2", w_commit_hex, w_commit_hex);
 286
 287         return pipe_command(&cp, NULL, 0, out, 0, NULL, 0);
 288 }
 289
 290 static int apply_cached(struct strbuf *out)
 291 {
 292         struct child_process cp = CHILD_PROCESS_INIT;
 293
 294         /*
 295          * Apply currently only reads either from stdin or a file, thus
 296          * apply_all_patches would have to be updated to optionally take a
 297          * buffer.
 298          */
 299         cp.git_cmd = 1;
 300         strvec_pushl(&cp.args, "apply", "--cached", NULL);
 301         return pipe_command(&cp, out->buf, out->len, NULL, 0, NULL, 0);
 302 }
 303
 304 static int reset_head(void)
 305 {
 306         struct child_process cp = CHILD_PROCESS_INIT;
 307
 308         /*
 309          * Reset is overall quite simple, however there is no current public
 310          * API for resetting.
 311          */
 312         cp.git_cmd = 1;
 313         strvec_pushl(&cp.args, "reset", "--quiet", "--refresh", NULL);
 314
 315         return run_command(&cp);
 316 }
 317
 318 static int is_path_a_directory(const char *path)
 319 {
 320         /*
 321          * This function differs from abspath.c:is_directory() in that
 322          * here we use lstat() instead of stat(); we do not want to
 323          * follow symbolic links here.
 324          */
 325         struct stat st;
 326         return (!lstat(path, &st) && S_ISDIR(st.st_mode));
 327 }
 328
 329 static void add_diff_to_buf(struct diff_queue_struct *q,
 330                             struct diff_options *options,
 331                             void *data)
 332 {
 333         int i;
 334
 335         for (i = 0; i < q->nr; i++) {
 336                 if (is_path_a_directory(q->queue[i]->one->path))
 337                         continue;
 338
 339                 strbuf_addstr(data, q->queue[i]->one->path);
 340
 341                 /* NUL-terminate: will be fed to update-index -z */
 342                 strbuf_addch(data, '\0');
 343         }
 344 }
 345
 346 static int restore_untracked(struct object_id *u_tree)
 347 {
 348         int res;
 349         struct child_process cp = CHILD_PROCESS_INIT;
 350
 351         /*
 352          * We need to run restore files from a given index, but without
 353          * affecting the current index, so we use GIT_INDEX_FILE with
 354          * run_command to fork processes that will not interfere.
 355          */
 356         cp.git_cmd = 1;
 357         strvec_push(&cp.args, "read-tree");
 358         strvec_push(&cp.args, oid_to_hex(u_tree));
 359         strvec_pushf(&cp.env_array, "GIT_INDEX_FILE=%s",
 360                      stash_index_path.buf);
 361         if (run_command(&cp)) {
 362                 remove_path(stash_index_path.buf);
 363                 return -1;
 364         }
 365
 366         child_process_init(&cp);
 367         cp.git_cmd = 1;
 368         strvec_pushl(&cp.args, "checkout-index", "--all", NULL);
 369         strvec_pushf(&cp.env_array, "GIT_INDEX_FILE=%s",
 370                      stash_index_path.buf);
 371
 372         res = run_command(&cp);
 373         remove_path(stash_index_path.buf);
 374         return res;
 375 }
 376
 377 static void unstage_changes_unless_new(struct object_id *orig_tree)
 378 {
 379         /*
 380          * When we enter this function, there has been a clean merge of
 381          * relevant trees, and the merge logic always stages whatever merges
 382          * cleanly.  We want to unstage those changes, unless it corresponds
 383          * to a file that didn't exist as of orig_tree.
 384          *
 385          * However, if any SKIP_WORKTREE path is modified relative to
 386          * orig_tree, then we want to clear the SKIP_WORKTREE bit and write
 387          * it to the worktree before unstaging.
 388          */
 389
 390         struct checkout state = CHECKOUT_INIT;
 391         struct diff_options diff_opts;
 392         struct lock_file lock = LOCK_INIT;
 393         int i;
 394
 395         /* If any entries have skip_worktree set, we'll have to check 'em out */
 396         state.force = 1;
 397         state.quiet = 1;
 398         state.refresh_cache = 1;
 399         state.istate = &the_index;
 400
 401         /*
 402          * Step 1: get a difference between orig_tree (which corresponding
 403          * to the index before a merge was run) and the current index
 404          * (reflecting the changes brought in by the merge).
 405          */
 406         diff_setup(&diff_opts);
 407         diff_opts.flags.recursive = 1;
 408         diff_opts.detect_rename = 0;
 409         diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
 410         diff_setup_done(&diff_opts);
 411
 412         do_diff_cache(orig_tree, &diff_opts);
 413         diffcore_std(&diff_opts);
 414
 415         /* Iterate over the paths that changed due to the merge... */
 416         for (i = 0; i < diff_queued_diff.nr; i++) {
 417                 struct diff_filepair *p;
 418                 struct cache_entry *ce;
 419                 int pos;
 420
 421                 /* Look up the path's position in the current index. */
 422                 p = diff_queued_diff.queue[i];
 423                 pos = index_name_pos(&the_index, p->two->path,
 424                                      strlen(p->two->path));
 425
 426                 /*
 427                  * Step 2: Place changes in the working tree
 428                  *
 429                  * Stash is about restoring changes *to the working tree*.
 430                  * So if the merge successfully got a new version of some
 431                  * path, but left it out of the working tree, then clear the
 432                  * SKIP_WORKTREE bit and write it to the working tree.
 433                  */
 434                 if (pos >= 0 && ce_skip_worktree(active_cache[pos])) {
 435                         struct stat st;
 436
 437                         ce = active_cache[pos];
 438                         if (!lstat(ce->name, &st)) {
 439                                 /* Conflicting path present; relocate it */
 440                                 struct strbuf new_path = STRBUF_INIT;
 441                                 int fd;
 442
 443                                 strbuf_addf(&new_path,
 444                                             "%s.stash.XXXXXX", ce->name);
 445                                 fd = xmkstemp(new_path.buf);
 446                                 close(fd);
 447                                 printf(_("WARNING: Untracked file in way of "
 448                                          "tracked file!  Renaming\n "
 449                                          "           %s -> %s\n"
 450                                          "         to make room.\n"),
 451                                        ce->name, new_path.buf);
 452                                 if (rename(ce->name, new_path.buf))
 453                                         die("Failed to move %s to %s\n",
 454                                             ce->name, new_path.buf);
 455                                 strbuf_release(&new_path);
 456                         }
 457                         checkout_entry(ce, &state, NULL, NULL);
 458                         ce->ce_flags &= ~CE_SKIP_WORKTREE;
 459                 }
 460
 461                 /*
 462                  * Step 3: "unstage" changes, as long as they are still tracked
 463                  */
 464                 if (p->one->oid_valid) {
 465                         /*
 466                          * Path existed in orig_tree; restore index entry
 467                          * from that tree in order to "unstage" the changes.
 468                          */
 469                         int option = ADD_CACHE_OK_TO_REPLACE;
 470                         if (pos < 0)
 471                                 option = ADD_CACHE_OK_TO_ADD;
 472
 473                         ce = make_cache_entry(&the_index,
 474                                               p->one->mode,
 475                                               &p->one->oid,
 476                                               p->one->path,
 477                                               0, 0);
 478                         add_index_entry(&the_index, ce, option);
 479                 }
 480         }
 481         diff_flush(&diff_opts);
 482
 483         /*
 484          * Step 4: write the new index to disk
 485          */
 486         repo_hold_locked_index(the_repository, &lock, LOCK_DIE_ON_ERROR);
 487         if (write_locked_index(&the_index, &lock,
 488                                COMMIT_LOCK | SKIP_IF_UNCHANGED))
 489                 die(_("Unable to write index."));
 490 }
 491
 492 static int do_apply_stash(const char *prefix, struct stash_info *info,
 493                           int index, int quiet)
 494 {
 495         int ret;
 496         int has_index = index;
 497         struct merge_options o;
 498         struct object_id c_tree;
 499         struct object_id index_tree;
 500         struct commit *result;
 501         const struct object_id *bases[1];
 502
 503         read_cache_preload(NULL);
 504         if (refresh_and_write_cache(REFRESH_QUIET, 0, 0))
 505                 return -1;
 506
 507         if (write_cache_as_tree(&c_tree, 0, NULL))
 508                 return error(_("cannot apply a stash in the middle of a merge"));
 509
 510         if (index) {
 511                 if (oideq(&info->b_tree, &info->i_tree) ||
 512                     oideq(&c_tree, &info->i_tree)) {
 513                         has_index = 0;
 514                 } else {
 515                         struct strbuf out = STRBUF_INIT;
 516
 517                         if (diff_tree_binary(&out, &info->w_commit)) {
 518                                 strbuf_release(&out);
 519                                 return error(_("could not generate diff %s^!."),
 520                                              oid_to_hex(&info->w_commit));
 521                         }
 522
 523                         ret = apply_cached(&out);
 524                         strbuf_release(&out);
 525                         if (ret)
 526                                 return error(_("conflicts in index. "
 527                                                "Try without --index."));
 528
 529                         discard_cache();
 530                         read_cache();
 531                         if (write_cache_as_tree(&index_tree, 0, NULL))
 532                                 return error(_("could not save index tree"));
 533
 534                         reset_head();
 535                         discard_cache();
 536                         read_cache();
 537                 }
 538         }
 539
 540         init_merge_options(&o, the_repository);
 541
 542         o.branch1 = "Updated upstream";
 543         o.branch2 = "Stashed changes";
 544
 545         if (oideq(&info->b_tree, &c_tree))
 546                 o.branch1 = "Version stash was based on";
 547
 548         if (quiet)
 549                 o.verbosity = 0;
 550
 551         if (o.verbosity >= 3)
 552                 printf_ln(_("Merging %s with %s"), o.branch1, o.branch2);
 553
 554         bases[0] = &info->b_tree;
 555
 556         ret = merge_recursive_generic(&o, &c_tree, &info->w_tree, 1, bases,
 557                                       &result);
 558         if (ret) {
 559                 rerere(0);
 560
 561                 if (index)
 562                         fprintf_ln(stderr, _("Index was not unstashed."));
 563
 564                 goto restore_untracked;
 565         }
 566
 567         if (has_index) {
 568                 if (reset_tree(&index_tree, 0, 0))
 569                         ret = -1;
 570         } else {
 571                 unstage_changes_unless_new(&c_tree);
 572         }
 573
 574 restore_untracked:
 575         if (info->has_u && restore_untracked(&info->u_tree))
 576                 ret = error(_("could not restore untracked files from stash"));
 577
 578         if (!quiet) {
 579                 struct child_process cp = CHILD_PROCESS_INIT;
 580
 581                 /*
 582                  * Status is quite simple and could be replaced with calls to
 583                  * wt_status in the future, but it adds complexities which may
 584                  * require more tests.
 585                  */
 586                 cp.git_cmd = 1;
 587                 cp.dir = prefix;
 588                 strvec_pushf(&cp.env_array, GIT_WORK_TREE_ENVIRONMENT"=%s",
 589                              absolute_path(get_git_work_tree()));
 590                 strvec_pushf(&cp.env_array, GIT_DIR_ENVIRONMENT"=%s",
 591                              absolute_path(get_git_dir()));
 592                 strvec_push(&cp.args, "status");
 593                 run_command(&cp);
 594         }
 595
 596         return ret;
 597 }
 598
 599 static int apply_stash(int argc, const char **argv, const char *prefix)
 600 {
 601         int ret;
 602         int quiet = 0;
 603         int index = 0;
 604         struct stash_info info;
 605         struct option options[] = {
 606                 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
 607                 OPT_BOOL(0, "index", &index,
 608                          N_("attempt to recreate the index")),
 609                 OPT_END()
 610         };
 611
 612         argc = parse_options(argc, argv, prefix, options,
 613                              git_stash_apply_usage, 0);
 614
 615         if (get_stash_info(&info, argc, argv))
 616                 return -1;
 617
 618         ret = do_apply_stash(prefix, &info, index, quiet);
 619         free_stash_info(&info);
 620         return ret;
 621 }
 622
 623 static int reject_reflog_ent(struct object_id *ooid, struct object_id *noid,
 624                              const char *email, timestamp_t timestamp, int tz,
 625                              const char *message, void *cb_data)
 626 {
 627         return 1;
 628 }
 629
 630 static int reflog_is_empty(const char *refname)
 631 {
 632         return !for_each_reflog_ent(refname, reject_reflog_ent, NULL);
 633 }
 634
 635 static int do_drop_stash(struct stash_info *info, int quiet)
 636 {
 637         int ret;
 638         struct child_process cp_reflog = CHILD_PROCESS_INIT;
 639
 640         /*
 641          * reflog does not provide a simple function for deleting refs. One will
 642          * need to be added to avoid implementing too much reflog code here
 643          */
 644
 645         cp_reflog.git_cmd = 1;
 646         strvec_pushl(&cp_reflog.args, "reflog", "delete", "--updateref",
 647                      "--rewrite", NULL);
 648         strvec_push(&cp_reflog.args, info->revision.buf);
 649         ret = run_command(&cp_reflog);
 650         if (!ret) {
 651                 if (!quiet)
 652                         printf_ln(_("Dropped %s (%s)"), info->revision.buf,
 653                                   oid_to_hex(&info->w_commit));
 654         } else {
 655                 return error(_("%s: Could not drop stash entry"),
 656                              info->revision.buf);
 657         }
 658
 659         if (reflog_is_empty(ref_stash))
 660                 do_clear_stash();
 661
 662         return 0;
 663 }
 664
 665 static void assert_stash_ref(struct stash_info *info)
 666 {
 667         if (!info->is_stash_ref) {
 668                 error(_("'%s' is not a stash reference"), info->revision.buf);
 669                 free_stash_info(info);
 670                 exit(1);
 671         }
 672 }
 673
 674 static int drop_stash(int argc, const char **argv, const char *prefix)
 675 {
 676         int ret;
 677         int quiet = 0;
 678         struct stash_info info;
 679         struct option options[] = {
 680                 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
 681                 OPT_END()
 682         };
 683
 684         argc = parse_options(argc, argv, prefix, options,
 685                              git_stash_drop_usage, 0);
 686
 687         if (get_stash_info(&info, argc, argv))
 688                 return -1;
 689
 690         assert_stash_ref(&info);
 691
 692         ret = do_drop_stash(&info, quiet);
 693         free_stash_info(&info);
 694         return ret;
 695 }
 696
 697 static int pop_stash(int argc, const char **argv, const char *prefix)
 698 {
 699         int ret;
 700         int index = 0;
 701         int quiet = 0;
 702         struct stash_info info;
 703         struct option options[] = {
 704                 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
 705                 OPT_BOOL(0, "index", &index,
 706                          N_("attempt to recreate the index")),
 707                 OPT_END()
 708         };
 709
 710         argc = parse_options(argc, argv, prefix, options,
 711                              git_stash_pop_usage, 0);
 712
 713         if (get_stash_info(&info, argc, argv))
 714                 return -1;
 715
 716         assert_stash_ref(&info);
 717         if ((ret = do_apply_stash(prefix, &info, index, quiet)))
 718                 printf_ln(_("The stash entry is kept in case "
 719                             "you need it again."));
 720         else
 721                 ret = do_drop_stash(&info, quiet);
 722
 723         free_stash_info(&info);
 724         return ret;
 725 }
 726
 727 static int branch_stash(int argc, const char **argv, const char *prefix)
 728 {
 729         int ret;
 730         const char *branch = NULL;
 731         struct stash_info info;
 732         struct child_process cp = CHILD_PROCESS_INIT;
 733         struct option options[] = {
 734                 OPT_END()
 735         };
 736
 737         argc = parse_options(argc, argv, prefix, options,
 738                              git_stash_branch_usage, 0);
 739
 740         if (!argc) {
 741                 fprintf_ln(stderr, _("No branch name specified"));
 742                 return -1;
 743         }
 744
 745         branch = argv[0];
 746
 747         if (get_stash_info(&info, argc - 1, argv + 1))
 748                 return -1;
 749
 750         cp.git_cmd = 1;
 751         strvec_pushl(&cp.args, "checkout", "-b", NULL);
 752         strvec_push(&cp.args, branch);
 753         strvec_push(&cp.args, oid_to_hex(&info.b_commit));
 754         ret = run_command(&cp);
 755         if (!ret)
 756                 ret = do_apply_stash(prefix, &info, 1, 0);
 757         if (!ret && info.is_stash_ref)
 758                 ret = do_drop_stash(&info, 0);
 759
 760         free_stash_info(&info);
 761
 762         return ret;
 763 }
 764
 765 static int list_stash(int argc, const char **argv, const char *prefix)
 766 {
 767         struct child_process cp = CHILD_PROCESS_INIT;
 768         struct option options[] = {
 769                 OPT_END()
 770         };
 771
 772         argc = parse_options(argc, argv, prefix, options,
 773                              git_stash_list_usage,
 774                              PARSE_OPT_KEEP_UNKNOWN);
 775
 776         if (!ref_exists(ref_stash))
 777                 return 0;
 778
 779         cp.git_cmd = 1;
 780         strvec_pushl(&cp.args, "log", "--format=%gd: %gs", "-g",
 781                      "--first-parent", NULL);
 782         strvec_pushv(&cp.args, argv);
 783         strvec_push(&cp.args, ref_stash);
 784         strvec_push(&cp.args, "--");
 785         return run_command(&cp);
 786 }
 787
 788 static int show_stat = 1;
 789 static int show_patch;
 790 static int show_include_untracked;
 791
 792 static int git_stash_config(const char *var, const char *value, void *cb)
 793 {
 794         if (!strcmp(var, "stash.showstat")) {
 795                 show_stat = git_config_bool(var, value);
 796                 return 0;
 797         }
 798         if (!strcmp(var, "stash.showpatch")) {
 799                 show_patch = git_config_bool(var, value);
 800                 return 0;
 801         }
 802         if (!strcmp(var, "stash.showincludeuntracked")) {
 803                 show_include_untracked = git_config_bool(var, value);
 804                 return 0;
 805         }
 806         return git_diff_basic_config(var, value, cb);
 807 }
 808
 809 static void diff_include_untracked(const struct stash_info *info, struct diff_options *diff_opt)
 810 {
 811         const struct object_id *oid[] = { &info->w_commit, &info->u_tree };
 812         struct tree *tree[ARRAY_SIZE(oid)];
 813         struct tree_desc tree_desc[ARRAY_SIZE(oid)];
 814         struct unpack_trees_options unpack_tree_opt = { 0 };
 815         int i;
 816
 817         for (i = 0; i < ARRAY_SIZE(oid); i++) {
 818                 tree[i] = parse_tree_indirect(oid[i]);
 819                 if (parse_tree(tree[i]) < 0)
 820                         die(_("failed to parse tree"));
 821                 init_tree_desc(&tree_desc[i], tree[i]->buffer, tree[i]->size);
 822         }
 823
 824         unpack_tree_opt.head_idx = -1;
 825         unpack_tree_opt.src_index = &the_index;
 826         unpack_tree_opt.dst_index = &the_index;
 827         unpack_tree_opt.merge = 1;
 828         unpack_tree_opt.fn = stash_worktree_untracked_merge;
 829
 830         if (unpack_trees(ARRAY_SIZE(tree_desc), tree_desc, &unpack_tree_opt))
 831                 die(_("failed to unpack trees"));
 832
 833         do_diff_cache(&info->b_commit, diff_opt);
 834 }
 835
 836 static int show_stash(int argc, const char **argv, const char *prefix)
 837 {
 838         int i;
 839         int ret = 0;
 840         struct stash_info info;
 841         struct rev_info rev;
 842         struct strvec stash_args = STRVEC_INIT;
 843         struct strvec revision_args = STRVEC_INIT;
 844         enum {
 845                 UNTRACKED_NONE,
 846                 UNTRACKED_INCLUDE,
 847                 UNTRACKED_ONLY
 848         } show_untracked = show_include_untracked ? UNTRACKED_INCLUDE : UNTRACKED_NONE;
 849         struct option options[] = {
 850                 OPT_SET_INT('u', "include-untracked", &show_untracked,
 851                             N_("include untracked files in the stash"),
 852                             UNTRACKED_INCLUDE),
 853                 OPT_SET_INT_F(0, "only-untracked", &show_untracked,
 854                               N_("only show untracked files in the stash"),
 855                               UNTRACKED_ONLY, PARSE_OPT_NONEG),
 856                 OPT_END()
 857         };
 858
 859         init_diff_ui_defaults();
 860         git_config(git_diff_ui_config, NULL);
 861         init_revisions(&rev, prefix);
 862
 863         argc = parse_options(argc, argv, prefix, options, git_stash_show_usage,
 864                              PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
 865                              PARSE_OPT_KEEP_DASHDASH);
 866
 867         strvec_push(&revision_args, argv[0]);
 868         for (i = 1; i < argc; i++) {
 869                 if (argv[i][0] != '-')
 870                         strvec_push(&stash_args, argv[i]);
 871                 else
 872                         strvec_push(&revision_args, argv[i]);
 873         }
 874
 875         ret = get_stash_info(&info, stash_args.nr, stash_args.v);
 876         strvec_clear(&stash_args);
 877         if (ret)
 878                 return -1;
 879
 880         /*
 881          * The config settings are applied only if there are not passed
 882          * any options.
 883          */
 884         if (revision_args.nr == 1) {
 885                 if (show_stat)
 886                         rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT;
 887
 888                 if (show_patch)
 889                         rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
 890
 891                 if (!show_stat && !show_patch) {
 892                         free_stash_info(&info);
 893                         return 0;
 894                 }
 895         }
 896
 897         argc = setup_revisions(revision_args.nr, revision_args.v, &rev, NULL);
 898         if (argc > 1) {
 899                 free_stash_info(&info);
 900                 usage_with_options(git_stash_show_usage, options);
 901         }
 902         if (!rev.diffopt.output_format) {
 903                 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
 904                 diff_setup_done(&rev.diffopt);
 905         }
 906
 907         rev.diffopt.flags.recursive = 1;
 908         setup_diff_pager(&rev.diffopt);
 909         switch (show_untracked) {
 910         case UNTRACKED_NONE:
 911                 diff_tree_oid(&info.b_commit, &info.w_commit, "", &rev.diffopt);
 912                 break;
 913         case UNTRACKED_ONLY:
 914                 if (info.has_u)
 915                         diff_root_tree_oid(&info.u_tree, "", &rev.diffopt);
 916                 break;
 917         case UNTRACKED_INCLUDE:
 918                 if (info.has_u)
 919                         diff_include_untracked(&info, &rev.diffopt);
 920                 else
 921                         diff_tree_oid(&info.b_commit, &info.w_commit, "", &rev.diffopt);
 922                 break;
 923         }
 924         log_tree_diff_flush(&rev);
 925
 926         free_stash_info(&info);
 927         return diff_result_code(&rev.diffopt, 0);
 928 }
 929
 930 static int do_store_stash(const struct object_id *w_commit, const char *stash_msg,
 931                           int quiet)
 932 {
 933         if (!stash_msg)
 934                 stash_msg = "Created via \"git stash store\".";
 935
 936         if (update_ref(stash_msg, ref_stash, w_commit, NULL,
 937                        REF_FORCE_CREATE_REFLOG,
 938                        quiet ? UPDATE_REFS_QUIET_ON_ERR :
 939                        UPDATE_REFS_MSG_ON_ERR)) {
 940                 if (!quiet) {
 941                         fprintf_ln(stderr, _("Cannot update %s with %s"),
 942                                    ref_stash, oid_to_hex(w_commit));
 943                 }
 944                 return -1;
 945         }
 946
 947         return 0;
 948 }
 949
 950 static int store_stash(int argc, const char **argv, const char *prefix)
 951 {
 952         int quiet = 0;
 953         const char *stash_msg = NULL;
 954         struct object_id obj;
 955         struct object_context dummy;
 956         struct option options[] = {
 957                 OPT__QUIET(&quiet, N_("be quiet")),
 958                 OPT_STRING('m', "message", &stash_msg, "message",
 959                            N_("stash message")),
 960                 OPT_END()
 961         };
 962
 963         argc = parse_options(argc, argv, prefix, options,
 964                              git_stash_store_usage,
 965                              PARSE_OPT_KEEP_UNKNOWN);
 966
 967         if (argc != 1) {
 968                 if (!quiet)
 969                         fprintf_ln(stderr, _("\"git stash store\" requires one "
 970                                              "<commit> argument"));
 971                 return -1;
 972         }
 973
 974         if (get_oid_with_context(the_repository,
 975                                  argv[0], quiet ? GET_OID_QUIETLY : 0, &obj,
 976                                  &dummy)) {
 977                 if (!quiet)
 978                         fprintf_ln(stderr, _("Cannot update %s with %s"),
 979                                              ref_stash, argv[0]);
 980                 return -1;
 981         }
 982
 983         return do_store_stash(&obj, stash_msg, quiet);
 984 }
 985
 986 static void add_pathspecs(struct strvec *args,
 987                           const struct pathspec *ps) {
 988         int i;
 989
 990         for (i = 0; i < ps->nr; i++)
 991                 strvec_push(args, ps->items[i].original);
 992 }
 993
 994 /*
 995  * `untracked_files` will be filled with the names of untracked files.
 996  * The return value is:
 997  *
 998  * = 0 if there are not any untracked files
 999  * > 0 if there are untracked files
1000  */
1001 static int get_untracked_files(const struct pathspec *ps, int include_untracked,
1002                                struct strbuf *untracked_files)
1003 {
1004         int i;
1005         int found = 0;
1006         struct dir_struct dir = DIR_INIT;
1007
1008         if (include_untracked != INCLUDE_ALL_FILES)
1009                 setup_standard_excludes(&dir);
1010
1011         fill_directory(&dir, the_repository->index, ps);
1012         for (i = 0; i < dir.nr; i++) {
1013                 struct dir_entry *ent = dir.entries[i];
1014                 found++;
1015                 strbuf_addstr(untracked_files, ent->name);
1016                 /* NUL-terminate: will be fed to update-index -z */
1017                 strbuf_addch(untracked_files, '\0');
1018         }
1019
1020         dir_clear(&dir);
1021         return found;
1022 }
1023
1024 /*
1025  * The return value of `check_changes_tracked_files()` can be:
1026  *
1027  * < 0 if there was an error
1028  * = 0 if there are no changes.
1029  * > 0 if there are changes.
1030  */
1031 static int check_changes_tracked_files(const struct pathspec *ps)
1032 {
1033         int result;
1034         struct rev_info rev;
1035         struct object_id dummy;
1036         int ret = 0;
1037
1038         /* No initial commit. */
1039         if (get_oid("HEAD", &dummy))
1040                 return -1;
1041
1042         if (read_cache() < 0)
1043                 return -1;
1044
1045         init_revisions(&rev, NULL);
1046         copy_pathspec(&rev.prune_data, ps);
1047
1048         rev.diffopt.flags.quick = 1;
1049         rev.diffopt.flags.ignore_submodules = 1;
1050         rev.abbrev = 0;
1051
1052         add_head_to_pending(&rev);
1053         diff_setup_done(&rev.diffopt);
1054
1055         result = run_diff_index(&rev, 1);
1056         if (diff_result_code(&rev.diffopt, result)) {
1057                 ret = 1;
1058                 goto done;
1059         }
1060
1061         object_array_clear(&rev.pending);
1062         result = run_diff_files(&rev, 0);
1063         if (diff_result_code(&rev.diffopt, result)) {
1064                 ret = 1;
1065                 goto done;
1066         }
1067
1068 done:
1069         clear_pathspec(&rev.prune_data);
1070         return ret;
1071 }
1072
1073 /*
1074  * The function will fill `untracked_files` with the names of untracked files
1075  * It will return 1 if there were any changes and 0 if there were not.
1076  */
1077 static int check_changes(const struct pathspec *ps, int include_untracked,
1078                          struct strbuf *untracked_files)
1079 {
1080         int ret = 0;
1081         if (check_changes_tracked_files(ps))
1082                 ret = 1;
1083
1084         if (include_untracked && get_untracked_files(ps, include_untracked,
1085                                                      untracked_files))
1086                 ret = 1;
1087
1088         return ret;
1089 }
1090
1091 static int save_untracked_files(struct stash_info *info, struct strbuf *msg,
1092                                 struct strbuf files)
1093 {
1094         int ret = 0;
1095         struct strbuf untracked_msg = STRBUF_INIT;
1096         struct child_process cp_upd_index = CHILD_PROCESS_INIT;
1097         struct index_state istate = { NULL };
1098
1099         cp_upd_index.git_cmd = 1;
1100         strvec_pushl(&cp_upd_index.args, "update-index", "-z", "--add",
1101                      "--remove", "--stdin", NULL);
1102         strvec_pushf(&cp_upd_index.env_array, "GIT_INDEX_FILE=%s",
1103                          stash_index_path.buf);
1104
1105         strbuf_addf(&untracked_msg, "untracked files on %s\n", msg->buf);
1106         if (pipe_command(&cp_upd_index, files.buf, files.len, NULL, 0,
1107                          NULL, 0)) {
1108                 ret = -1;
1109                 goto done;
1110         }
1111
1112         if (write_index_as_tree(&info->u_tree, &istate, stash_index_path.buf, 0,
1113                                 NULL)) {
1114                 ret = -1;
1115                 goto done;
1116         }
1117
1118         if (commit_tree(untracked_msg.buf, untracked_msg.len,
1119                         &info->u_tree, NULL, &info->u_commit, NULL, NULL)) {
1120                 ret = -1;
1121                 goto done;
1122         }
1123
1124 done:
1125         discard_index(&istate);
1126         strbuf_release(&untracked_msg);
1127         remove_path(stash_index_path.buf);
1128         return ret;
1129 }
1130
1131 static int stash_staged(struct stash_info *info, struct strbuf *out_patch,
1132                         int quiet)
1133 {
1134         int ret = 0;
1135         struct child_process cp_diff_tree = CHILD_PROCESS_INIT;
1136         struct index_state istate = { NULL };
1137
1138         if (write_index_as_tree(&info->w_tree, &istate, the_repository->index_file,
1139                                 0, NULL)) {
1140                 ret = -1;
1141                 goto done;
1142         }
1143
1144         cp_diff_tree.git_cmd = 1;
1145         strvec_pushl(&cp_diff_tree.args, "diff-tree", "-p", "-U1", "HEAD",
1146                      oid_to_hex(&info->w_tree), "--", NULL);
1147         if (pipe_command(&cp_diff_tree, NULL, 0, out_patch, 0, NULL, 0)) {
1148                 ret = -1;
1149                 goto done;
1150         }
1151
1152         if (!out_patch->len) {
1153                 if (!quiet)
1154                         fprintf_ln(stderr, _("No staged changes"));
1155                 ret = 1;
1156         }
1157
1158 done:
1159         discard_index(&istate);
1160         return ret;
1161 }
1162
1163 static int stash_patch(struct stash_info *info, const struct pathspec *ps,
1164                        struct strbuf *out_patch, int quiet)
1165 {
1166         int ret = 0;
1167         struct child_process cp_read_tree = CHILD_PROCESS_INIT;
1168         struct child_process cp_diff_tree = CHILD_PROCESS_INIT;
1169         struct index_state istate = { NULL };
1170         char *old_index_env = NULL, *old_repo_index_file;
1171
1172         remove_path(stash_index_path.buf);
1173
1174         cp_read_tree.git_cmd = 1;
1175         strvec_pushl(&cp_read_tree.args, "read-tree", "HEAD", NULL);
1176         strvec_pushf(&cp_read_tree.env_array, "GIT_INDEX_FILE=%s",
1177                      stash_index_path.buf);
1178         if (run_command(&cp_read_tree)) {
1179                 ret = -1;
1180                 goto done;
1181         }
1182
1183         /* Find out what the user wants. */
1184         old_repo_index_file = the_repository->index_file;
1185         the_repository->index_file = stash_index_path.buf;
1186         old_index_env = xstrdup_or_null(getenv(INDEX_ENVIRONMENT));
1187         setenv(INDEX_ENVIRONMENT, the_repository->index_file, 1);
1188
1189         ret = run_add_interactive(NULL, "--patch=stash", ps);
1190
1191         the_repository->index_file = old_repo_index_file;
1192         if (old_index_env && *old_index_env)
1193                 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
1194         else
1195                 unsetenv(INDEX_ENVIRONMENT);
1196         FREE_AND_NULL(old_index_env);
1197
1198         /* State of the working tree. */
1199         if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1200                                 NULL)) {
1201                 ret = -1;
1202                 goto done;
1203         }
1204
1205         cp_diff_tree.git_cmd = 1;
1206         strvec_pushl(&cp_diff_tree.args, "diff-tree", "-p", "-U1", "HEAD",
1207                      oid_to_hex(&info->w_tree), "--", NULL);
1208         if (pipe_command(&cp_diff_tree, NULL, 0, out_patch, 0, NULL, 0)) {
1209                 ret = -1;
1210                 goto done;
1211         }
1212
1213         if (!out_patch->len) {
1214                 if (!quiet)
1215                         fprintf_ln(stderr, _("No changes selected"));
1216                 ret = 1;
1217         }
1218
1219 done:
1220         discard_index(&istate);
1221         remove_path(stash_index_path.buf);
1222         return ret;
1223 }
1224
1225 static int stash_working_tree(struct stash_info *info, const struct pathspec *ps)
1226 {
1227         int ret = 0;
1228         struct rev_info rev;
1229         struct child_process cp_upd_index = CHILD_PROCESS_INIT;
1230         struct strbuf diff_output = STRBUF_INIT;
1231         struct index_state istate = { NULL };
1232
1233         init_revisions(&rev, NULL);
1234         copy_pathspec(&rev.prune_data, ps);
1235
1236         set_alternate_index_output(stash_index_path.buf);
1237         if (reset_tree(&info->i_tree, 0, 0)) {
1238                 ret = -1;
1239                 goto done;
1240         }
1241         set_alternate_index_output(NULL);
1242
1243         rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
1244         rev.diffopt.format_callback = add_diff_to_buf;
1245         rev.diffopt.format_callback_data = &diff_output;
1246
1247         if (read_cache_preload(&rev.diffopt.pathspec) < 0) {
1248                 ret = -1;
1249                 goto done;
1250         }
1251
1252         add_pending_object(&rev, parse_object(the_repository, &info->b_commit),
1253                            "");
1254         if (run_diff_index(&rev, 0)) {
1255                 ret = -1;
1256                 goto done;
1257         }
1258
1259         cp_upd_index.git_cmd = 1;
1260         strvec_pushl(&cp_upd_index.args, "update-index",
1261                      "--ignore-skip-worktree-entries",
1262                      "-z", "--add", "--remove", "--stdin", NULL);
1263         strvec_pushf(&cp_upd_index.env_array, "GIT_INDEX_FILE=%s",
1264                      stash_index_path.buf);
1265
1266         if (pipe_command(&cp_upd_index, diff_output.buf, diff_output.len,
1267                          NULL, 0, NULL, 0)) {
1268                 ret = -1;
1269                 goto done;
1270         }
1271
1272         if (write_index_as_tree(&info->w_tree, &istate, stash_index_path.buf, 0,
1273                                 NULL)) {
1274                 ret = -1;
1275                 goto done;
1276         }
1277
1278 done:
1279         discard_index(&istate);
1280         UNLEAK(rev);
1281         object_array_clear(&rev.pending);
1282         clear_pathspec(&rev.prune_data);
1283         strbuf_release(&diff_output);
1284         remove_path(stash_index_path.buf);
1285         return ret;
1286 }
1287
1288 static int do_create_stash(const struct pathspec *ps, struct strbuf *stash_msg_buf,
1289                            int include_untracked, int patch_mode, int only_staged,
1290                            struct stash_info *info, struct strbuf *patch,
1291                            int quiet)
1292 {
1293         int ret = 0;
1294         int flags = 0;
1295         int untracked_commit_option = 0;
1296         const char *head_short_sha1 = NULL;
1297         const char *branch_ref = NULL;
1298         const char *branch_name = "(no branch)";
1299         struct commit *head_commit = NULL;
1300         struct commit_list *parents = NULL;
1301         struct strbuf msg = STRBUF_INIT;
1302         struct strbuf commit_tree_label = STRBUF_INIT;
1303         struct strbuf untracked_files = STRBUF_INIT;
1304
1305         prepare_fallback_ident("git stash", "git@stash");
1306
1307         read_cache_preload(NULL);
1308         if (refresh_and_write_cache(REFRESH_QUIET, 0, 0) < 0) {
1309                 ret = -1;
1310                 goto done;
1311         }
1312
1313         if (get_oid("HEAD", &info->b_commit)) {
1314                 if (!quiet)
1315                         fprintf_ln(stderr, _("You do not have "
1316                                              "the initial commit yet"));
1317                 ret = -1;
1318                 goto done;
1319         } else {
1320                 head_commit = lookup_commit(the_repository, &info->b_commit);
1321         }
1322
1323         if (!check_changes(ps, include_untracked, &untracked_files)) {
1324                 ret = 1;
1325                 goto done;
1326         }
1327
1328         branch_ref = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
1329         if (flags & REF_ISSYMREF)
1330                 skip_prefix(branch_ref, "refs/heads/", &branch_name);
1331         head_short_sha1 = find_unique_abbrev(&head_commit->object.oid,
1332                                              DEFAULT_ABBREV);
1333         strbuf_addf(&msg, "%s: %s ", branch_name, head_short_sha1);
1334         pp_commit_easy(CMIT_FMT_ONELINE, head_commit, &msg);
1335
1336         strbuf_addf(&commit_tree_label, "index on %s\n", msg.buf);
1337         commit_list_insert(head_commit, &parents);
1338         if (write_cache_as_tree(&info->i_tree, 0, NULL) ||
1339             commit_tree(commit_tree_label.buf, commit_tree_label.len,
1340                         &info->i_tree, parents, &info->i_commit, NULL, NULL)) {
1341                 if (!quiet)
1342                         fprintf_ln(stderr, _("Cannot save the current "
1343                                              "index state"));
1344                 ret = -1;
1345                 goto done;
1346         }
1347
1348         if (include_untracked) {
1349                 if (save_untracked_files(info, &msg, untracked_files)) {
1350                         if (!quiet)
1351                                 fprintf_ln(stderr, _("Cannot save "
1352                                                      "the untracked files"));
1353                         ret = -1;
1354                         goto done;
1355                 }
1356                 untracked_commit_option = 1;
1357         }
1358         if (patch_mode) {
1359                 ret = stash_patch(info, ps, patch, quiet);
1360                 if (ret < 0) {
1361                         if (!quiet)
1362                                 fprintf_ln(stderr, _("Cannot save the current "
1363                                                      "worktree state"));
1364                         goto done;
1365                 } else if (ret > 0) {
1366                         goto done;
1367                 }
1368         } else if (only_staged) {
1369                 ret = stash_staged(info, patch, quiet);
1370                 if (ret < 0) {
1371                         if (!quiet)
1372                                 fprintf_ln(stderr, _("Cannot save the current "
1373                                                      "staged state"));
1374                         goto done;
1375                 } else if (ret > 0) {
1376                         goto done;
1377                 }
1378         } else {
1379                 if (stash_working_tree(info, ps)) {
1380                         if (!quiet)
1381                                 fprintf_ln(stderr, _("Cannot save the current "
1382                                                      "worktree state"));
1383                         ret = -1;
1384                         goto done;
1385                 }
1386         }
1387
1388         if (!stash_msg_buf->len)
1389                 strbuf_addf(stash_msg_buf, "WIP on %s", msg.buf);
1390         else
1391                 strbuf_insertf(stash_msg_buf, 0, "On %s: ", branch_name);
1392
1393         /*
1394          * `parents` will be empty after calling `commit_tree()`, so there is
1395          * no need to call `free_commit_list()`
1396          */
1397         parents = NULL;
1398         if (untracked_commit_option)
1399                 commit_list_insert(lookup_commit(the_repository,
1400                                                  &info->u_commit),
1401                                    &parents);
1402         commit_list_insert(lookup_commit(the_repository, &info->i_commit),
1403                            &parents);
1404         commit_list_insert(head_commit, &parents);
1405
1406         if (commit_tree(stash_msg_buf->buf, stash_msg_buf->len, &info->w_tree,
1407                         parents, &info->w_commit, NULL, NULL)) {
1408                 if (!quiet)
1409                         fprintf_ln(stderr, _("Cannot record "
1410                                              "working tree state"));
1411                 ret = -1;
1412                 goto done;
1413         }
1414
1415 done:
1416         strbuf_release(&commit_tree_label);
1417         strbuf_release(&msg);
1418         strbuf_release(&untracked_files);
1419         return ret;
1420 }
1421
1422 static int create_stash(int argc, const char **argv, const char *prefix)
1423 {
1424         int ret = 0;
1425         struct strbuf stash_msg_buf = STRBUF_INIT;
1426         struct stash_info info;
1427         struct pathspec ps;
1428
1429         /* Starting with argv[1], since argv[0] is "create" */
1430         strbuf_join_argv(&stash_msg_buf, argc - 1, ++argv, ' ');
1431
1432         memset(&ps, 0, sizeof(ps));
1433         if (!check_changes_tracked_files(&ps))
1434                 return 0;
1435
1436         ret = do_create_stash(&ps, &stash_msg_buf, 0, 0, 0, &info,
1437                               NULL, 0);
1438         if (!ret)
1439                 printf_ln("%s", oid_to_hex(&info.w_commit));
1440
1441         strbuf_release(&stash_msg_buf);
1442         return ret;
1443 }
1444
1445 static int do_push_stash(const struct pathspec *ps, const char *stash_msg, int quiet,
1446                          int keep_index, int patch_mode, int include_untracked, int only_staged)
1447 {
1448         int ret = 0;
1449         struct stash_info info;
1450         struct strbuf patch = STRBUF_INIT;
1451         struct strbuf stash_msg_buf = STRBUF_INIT;
1452         struct strbuf untracked_files = STRBUF_INIT;
1453
1454         if (patch_mode && keep_index == -1)
1455                 keep_index = 1;
1456
1457         if (patch_mode && include_untracked) {
1458                 fprintf_ln(stderr, _("Can't use --patch and --include-untracked"
1459                                      " or --all at the same time"));
1460                 ret = -1;
1461                 goto done;
1462         }
1463
1464         /* --patch overrides --staged */
1465         if (patch_mode)
1466                 only_staged = 0;
1467
1468         if (only_staged && include_untracked) {
1469                 fprintf_ln(stderr, _("Can't use --staged and --include-untracked"
1470                                      " or --all at the same time"));
1471                 ret = -1;
1472                 goto done;
1473         }
1474
1475         read_cache_preload(NULL);
1476         if (!include_untracked && ps->nr) {
1477                 int i;
1478                 char *ps_matched = xcalloc(ps->nr, 1);
1479
1480                 /* TODO: audit for interaction with sparse-index. */
1481                 ensure_full_index(&the_index);
1482                 for (i = 0; i < active_nr; i++)
1483                         ce_path_match(&the_index, active_cache[i], ps,
1484                                       ps_matched);
1485
1486                 if (report_path_error(ps_matched, ps)) {
1487                         fprintf_ln(stderr, _("Did you forget to 'git add'?"));
1488                         ret = -1;
1489                         free(ps_matched);
1490                         goto done;
1491                 }
1492                 free(ps_matched);
1493         }
1494
1495         if (refresh_and_write_cache(REFRESH_QUIET, 0, 0)) {
1496                 ret = -1;
1497                 goto done;
1498         }
1499
1500         if (!check_changes(ps, include_untracked, &untracked_files)) {
1501                 if (!quiet)
1502                         printf_ln(_("No local changes to save"));
1503                 goto done;
1504         }
1505
1506         if (!reflog_exists(ref_stash) && do_clear_stash()) {
1507                 ret = -1;
1508                 if (!quiet)
1509                         fprintf_ln(stderr, _("Cannot initialize stash"));
1510                 goto done;
1511         }
1512
1513         if (stash_msg)
1514                 strbuf_addstr(&stash_msg_buf, stash_msg);
1515         if (do_create_stash(ps, &stash_msg_buf, include_untracked, patch_mode, only_staged,
1516                             &info, &patch, quiet)) {
1517                 ret = -1;
1518                 goto done;
1519         }
1520
1521         if (do_store_stash(&info.w_commit, stash_msg_buf.buf, 1)) {
1522                 ret = -1;
1523                 if (!quiet)
1524                         fprintf_ln(stderr, _("Cannot save the current status"));
1525                 goto done;
1526         }
1527
1528         if (!quiet)
1529                 printf_ln(_("Saved working directory and index state %s"),
1530                           stash_msg_buf.buf);
1531
1532         if (!(patch_mode || only_staged)) {
1533                 if (include_untracked && !ps->nr) {
1534                         struct child_process cp = CHILD_PROCESS_INIT;
1535
1536                         cp.git_cmd = 1;
1537                         if (startup_info->original_cwd) {
1538                                 cp.dir = startup_info->original_cwd;
1539                                 strvec_pushf(&cp.env_array, "%s=%s",
1540                                              GIT_WORK_TREE_ENVIRONMENT,
1541                                              the_repository->worktree);
1542                         }
1543                         strvec_pushl(&cp.args, "clean", "--force",
1544                                      "--quiet", "-d", ":/", NULL);
1545                         if (include_untracked == INCLUDE_ALL_FILES)
1546                                 strvec_push(&cp.args, "-x");
1547                         if (run_command(&cp)) {
1548                                 ret = -1;
1549                                 goto done;
1550                         }
1551                 }
1552                 discard_cache();
1553                 if (ps->nr) {
1554                         struct child_process cp_add = CHILD_PROCESS_INIT;
1555                         struct child_process cp_diff = CHILD_PROCESS_INIT;
1556                         struct child_process cp_apply = CHILD_PROCESS_INIT;
1557                         struct strbuf out = STRBUF_INIT;
1558
1559                         cp_add.git_cmd = 1;
1560                         strvec_push(&cp_add.args, "add");
1561                         if (!include_untracked)
1562                                 strvec_push(&cp_add.args, "-u");
1563                         if (include_untracked == INCLUDE_ALL_FILES)
1564                                 strvec_push(&cp_add.args, "--force");
1565                         strvec_push(&cp_add.args, "--");
1566                         add_pathspecs(&cp_add.args, ps);
1567                         if (run_command(&cp_add)) {
1568                                 ret = -1;
1569                                 goto done;
1570                         }
1571
1572                         cp_diff.git_cmd = 1;
1573                         strvec_pushl(&cp_diff.args, "diff-index", "-p",
1574                                      "--cached", "--binary", "HEAD", "--",
1575                                      NULL);
1576                         add_pathspecs(&cp_diff.args, ps);
1577                         if (pipe_command(&cp_diff, NULL, 0, &out, 0, NULL, 0)) {
1578                                 ret = -1;
1579                                 goto done;
1580                         }
1581
1582                         cp_apply.git_cmd = 1;
1583                         strvec_pushl(&cp_apply.args, "apply", "--index",
1584                                      "-R", NULL);
1585                         if (pipe_command(&cp_apply, out.buf, out.len, NULL, 0,
1586                                          NULL, 0)) {
1587                                 ret = -1;
1588                                 goto done;
1589                         }
1590                 } else {
1591                         struct child_process cp = CHILD_PROCESS_INIT;
1592                         cp.git_cmd = 1;
1593                         /* BUG: this nukes untracked files in the way */
1594                         strvec_pushl(&cp.args, "reset", "--hard", "-q",
1595                                      "--no-recurse-submodules", NULL);
1596                         if (run_command(&cp)) {
1597                                 ret = -1;
1598                                 goto done;
1599                         }
1600                 }
1601
1602                 if (keep_index == 1 && !is_null_oid(&info.i_tree)) {
1603                         struct child_process cp = CHILD_PROCESS_INIT;
1604
1605                         cp.git_cmd = 1;
1606                         strvec_pushl(&cp.args, "checkout", "--no-overlay",
1607                                      oid_to_hex(&info.i_tree), "--", NULL);
1608                         if (!ps->nr)
1609                                 strvec_push(&cp.args, ":/");
1610                         else
1611                                 add_pathspecs(&cp.args, ps);
1612                         if (run_command(&cp)) {
1613                                 ret = -1;
1614                                 goto done;
1615                         }
1616                 }
1617                 goto done;
1618         } else {
1619                 struct child_process cp = CHILD_PROCESS_INIT;
1620
1621                 cp.git_cmd = 1;
1622                 strvec_pushl(&cp.args, "apply", "-R", NULL);
1623
1624                 if (pipe_command(&cp, patch.buf, patch.len, NULL, 0, NULL, 0)) {
1625                         if (!quiet)
1626                                 fprintf_ln(stderr, _("Cannot remove "
1627                                                      "worktree changes"));
1628                         ret = -1;
1629                         goto done;
1630                 }
1631
1632                 if (keep_index < 1) {
1633                         struct child_process cp = CHILD_PROCESS_INIT;
1634
1635                         cp.git_cmd = 1;
1636                         strvec_pushl(&cp.args, "reset", "-q", "--refresh", "--",
1637                                      NULL);
1638                         add_pathspecs(&cp.args, ps);
1639                         if (run_command(&cp)) {
1640                                 ret = -1;
1641                                 goto done;
1642                         }
1643                 }
1644                 goto done;
1645         }
1646
1647 done:
1648         strbuf_release(&stash_msg_buf);
1649         return ret;
1650 }
1651
1652 static int push_stash(int argc, const char **argv, const char *prefix,
1653                       int push_assumed)
1654 {
1655         int force_assume = 0;
1656         int keep_index = -1;
1657         int only_staged = 0;
1658         int patch_mode = 0;
1659         int include_untracked = 0;
1660         int quiet = 0;
1661         int pathspec_file_nul = 0;
1662         const char *stash_msg = NULL;
1663         const char *pathspec_from_file = NULL;
1664         struct pathspec ps;
1665         struct option options[] = {
1666                 OPT_BOOL('k', "keep-index", &keep_index,
1667                          N_("keep index")),
1668                 OPT_BOOL('S', "staged", &only_staged,
1669                          N_("stash staged changes only")),
1670                 OPT_BOOL('p', "patch", &patch_mode,
1671                          N_("stash in patch mode")),
1672                 OPT__QUIET(&quiet, N_("quiet mode")),
1673                 OPT_BOOL('u', "include-untracked", &include_untracked,
1674                          N_("include untracked files in stash")),
1675                 OPT_SET_INT('a', "all", &include_untracked,
1676                             N_("include ignore files"), 2),
1677                 OPT_STRING('m', "message", &stash_msg, N_("message"),
1678                            N_("stash message")),
1679                 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
1680                 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
1681                 OPT_END()
1682         };
1683
1684         if (argc) {
1685                 force_assume = !strcmp(argv[0], "-p");
1686                 argc = parse_options(argc, argv, prefix, options,
1687                                      push_assumed ? git_stash_usage :
1688                                      git_stash_push_usage,
1689                                      PARSE_OPT_KEEP_DASHDASH);
1690         }
1691
1692         if (argc) {
1693                 if (!strcmp(argv[0], "--")) {
1694                         argc--;
1695                         argv++;
1696                 } else if (push_assumed && !force_assume) {
1697                         die("subcommand wasn't specified; 'push' can't be assumed due to unexpected token '%s'",
1698                             argv[0]);
1699                 }
1700         }
1701
1702         parse_pathspec(&ps, 0, PATHSPEC_PREFER_FULL | PATHSPEC_PREFIX_ORIGIN,
1703                        prefix, argv);
1704
1705         if (pathspec_from_file) {
1706                 if (patch_mode)
1707                         die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--patch");
1708
1709                 if (only_staged)
1710                         die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--staged");
1711
1712                 if (ps.nr)
1713                         die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
1714
1715                 parse_pathspec_file(&ps, 0,
1716                                     PATHSPEC_PREFER_FULL | PATHSPEC_PREFIX_ORIGIN,
1717                                     prefix, pathspec_from_file, pathspec_file_nul);
1718         } else if (pathspec_file_nul) {
1719                 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
1720         }
1721
1722         return do_push_stash(&ps, stash_msg, quiet, keep_index, patch_mode,
1723                              include_untracked, only_staged);
1724 }
1725
1726 static int save_stash(int argc, const char **argv, const char *prefix)
1727 {
1728         int keep_index = -1;
1729         int only_staged = 0;
1730         int patch_mode = 0;
1731         int include_untracked = 0;
1732         int quiet = 0;
1733         int ret = 0;
1734         const char *stash_msg = NULL;
1735         struct pathspec ps;
1736         struct strbuf stash_msg_buf = STRBUF_INIT;
1737         struct option options[] = {
1738                 OPT_BOOL('k', "keep-index", &keep_index,
1739                          N_("keep index")),
1740                 OPT_BOOL('S', "staged", &only_staged,
1741                          N_("stash staged changes only")),
1742                 OPT_BOOL('p', "patch", &patch_mode,
1743                          N_("stash in patch mode")),
1744                 OPT__QUIET(&quiet, N_("quiet mode")),
1745                 OPT_BOOL('u', "include-untracked", &include_untracked,
1746                          N_("include untracked files in stash")),
1747                 OPT_SET_INT('a', "all", &include_untracked,
1748                             N_("include ignore files"), 2),
1749                 OPT_STRING('m', "message", &stash_msg, "message",
1750                            N_("stash message")),
1751                 OPT_END()
1752         };
1753
1754         argc = parse_options(argc, argv, prefix, options,
1755                              git_stash_save_usage,
1756                              PARSE_OPT_KEEP_DASHDASH);
1757
1758         if (argc)
1759                 stash_msg = strbuf_join_argv(&stash_msg_buf, argc, argv, ' ');
1760
1761         memset(&ps, 0, sizeof(ps));
1762         ret = do_push_stash(&ps, stash_msg, quiet, keep_index,
1763                             patch_mode, include_untracked, only_staged);
1764
1765         strbuf_release(&stash_msg_buf);
1766         return ret;
1767 }
1768
1769 int cmd_stash(int argc, const char **argv, const char *prefix)
1770 {
1771         pid_t pid = getpid();
1772         const char *index_file;
1773         struct strvec args = STRVEC_INIT;
1774
1775         struct option options[] = {
1776                 OPT_END()
1777         };
1778
1779         git_config(git_stash_config, NULL);
1780
1781         argc = parse_options(argc, argv, prefix, options, git_stash_usage,
1782                              PARSE_OPT_KEEP_UNKNOWN | PARSE_OPT_KEEP_DASHDASH);
1783
1784         index_file = get_index_file();
1785         strbuf_addf(&stash_index_path, "%s.stash.%" PRIuMAX, index_file,
1786                     (uintmax_t)pid);
1787
1788         if (!argc)
1789                 return !!push_stash(0, NULL, prefix, 0);
1790         else if (!strcmp(argv[0], "apply"))
1791                 return !!apply_stash(argc, argv, prefix);
1792         else if (!strcmp(argv[0], "clear"))
1793                 return !!clear_stash(argc, argv, prefix);
1794         else if (!strcmp(argv[0], "drop"))
1795                 return !!drop_stash(argc, argv, prefix);
1796         else if (!strcmp(argv[0], "pop"))
1797                 return !!pop_stash(argc, argv, prefix);
1798         else if (!strcmp(argv[0], "branch"))
1799                 return !!branch_stash(argc, argv, prefix);
1800         else if (!strcmp(argv[0], "list"))
1801                 return !!list_stash(argc, argv, prefix);
1802         else if (!strcmp(argv[0], "show"))
1803                 return !!show_stash(argc, argv, prefix);
1804         else if (!strcmp(argv[0], "store"))
1805                 return !!store_stash(argc, argv, prefix);
1806         else if (!strcmp(argv[0], "create"))
1807                 return !!create_stash(argc, argv, prefix);
1808         else if (!strcmp(argv[0], "push"))
1809                 return !!push_stash(argc, argv, prefix, 0);
1810         else if (!strcmp(argv[0], "save"))
1811                 return !!save_stash(argc, argv, prefix);
1812         else if (*argv[0] != '-')
1813                 usage_msg_optf(_("unknown subcommand: %s"),
1814                                git_stash_usage, options, argv[0]);
1815
1816         /* Assume 'stash push' */
1817         strvec_push(&args, "push");
1818         strvec_pushv(&args, argv);
1819         return !!push_stash(args.nr, args.v, prefix, 1);
1820 }