builtin/sparse-checkout.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "config.h"
   4 #include "dir.h"
   5 #include "parse-options.h"
   6 #include "pathspec.h"
   7 #include "repository.h"
   8 #include "run-command.h"
   9 #include "strbuf.h"
  10 #include "string-list.h"
  11 #include "cache-tree.h"
  12 #include "lockfile.h"
  13 #include "resolve-undo.h"
  14 #include "unpack-trees.h"
  15 #include "wt-status.h"
  16 #include "quote.h"
  17 #include "sparse-index.h"
  18 #include "worktree.h"
  19
  20 static const char *empty_base = "";
  21
  22 static char const * const builtin_sparse_checkout_usage[] = {
  23         N_("git sparse-checkout (init | list | set | add | reapply | disable) [<options>]"),
  24         NULL
  25 };
  26
  27 static void write_patterns_to_file(FILE *fp, struct pattern_list *pl)
  28 {
  29         int i;
  30
  31         for (i = 0; i < pl->nr; i++) {
  32                 struct path_pattern *p = pl->patterns[i];
  33
  34                 if (p->flags & PATTERN_FLAG_NEGATIVE)
  35                         fprintf(fp, "!");
  36
  37                 fprintf(fp, "%s", p->pattern);
  38
  39                 if (p->flags & PATTERN_FLAG_MUSTBEDIR)
  40                         fprintf(fp, "/");
  41
  42                 fprintf(fp, "\n");
  43         }
  44 }
  45
  46 static char const * const builtin_sparse_checkout_list_usage[] = {
  47         "git sparse-checkout list",
  48         NULL
  49 };
  50
  51 static int sparse_checkout_list(int argc, const char **argv, const char *prefix)
  52 {
  53         static struct option builtin_sparse_checkout_list_options[] = {
  54                 OPT_END(),
  55         };
  56         struct pattern_list pl;
  57         char *sparse_filename;
  58         int res;
  59
  60         if (!core_apply_sparse_checkout)
  61                 die(_("this worktree is not sparse"));
  62
  63         argc = parse_options(argc, argv, prefix,
  64                              builtin_sparse_checkout_list_options,
  65                              builtin_sparse_checkout_list_usage, 0);
  66
  67         memset(&pl, 0, sizeof(pl));
  68
  69         pl.use_cone_patterns = core_sparse_checkout_cone;
  70
  71         sparse_filename = get_sparse_checkout_filename();
  72         res = add_patterns_from_file_to_list(sparse_filename, "", 0, &pl, NULL, 0);
  73         free(sparse_filename);
  74
  75         if (res < 0) {
  76                 warning(_("this worktree is not sparse (sparse-checkout file may not exist)"));
  77                 return 0;
  78         }
  79
  80         if (pl.use_cone_patterns) {
  81                 int i;
  82                 struct pattern_entry *pe;
  83                 struct hashmap_iter iter;
  84                 struct string_list sl = STRING_LIST_INIT_DUP;
  85
  86                 hashmap_for_each_entry(&pl.recursive_hashmap, &iter, pe, ent) {
  87                         /* pe->pattern starts with "/", skip it */
  88                         string_list_insert(&sl, pe->pattern + 1);
  89                 }
  90
  91                 string_list_sort(&sl);
  92
  93                 for (i = 0; i < sl.nr; i++) {
  94                         quote_c_style(sl.items[i].string, NULL, stdout, 0);
  95                         printf("\n");
  96                 }
  97
  98                 return 0;
  99         }
 100
 101         write_patterns_to_file(stdout, &pl);
 102         clear_pattern_list(&pl);
 103
 104         return 0;
 105 }
 106
 107 static void clean_tracked_sparse_directories(struct repository *r)
 108 {
 109         int i, was_full = 0;
 110         struct strbuf path = STRBUF_INIT;
 111         size_t pathlen;
 112         struct string_list_item *item;
 113         struct string_list sparse_dirs = STRING_LIST_INIT_DUP;
 114
 115         /*
 116          * If we are not using cone mode patterns, then we cannot
 117          * delete directories outside of the sparse cone.
 118          */
 119         if (!r || !r->index || !r->worktree)
 120                 return;
 121         if (init_sparse_checkout_patterns(r->index) ||
 122             !r->index->sparse_checkout_patterns->use_cone_patterns)
 123                 return;
 124
 125         /*
 126          * Use the sparse index as a data structure to assist finding
 127          * directories that are safe to delete. This conversion to a
 128          * sparse index will not delete directories that contain
 129          * conflicted entries or submodules.
 130          */
 131         if (r->index->sparse_index == INDEX_EXPANDED) {
 132                 /*
 133                  * If something, such as a merge conflict or other concern,
 134                  * prevents us from converting to a sparse index, then do
 135                  * not try deleting files.
 136                  */
 137                 if (convert_to_sparse(r->index, SPARSE_INDEX_MEMORY_ONLY))
 138                         return;
 139                 was_full = 1;
 140         }
 141
 142         strbuf_addstr(&path, r->worktree);
 143         strbuf_complete(&path, '/');
 144         pathlen = path.len;
 145
 146         /*
 147          * Collect directories that have gone out of scope but also
 148          * exist on disk, so there is some work to be done. We need to
 149          * store the entries in a list before exploring, since that might
 150          * expand the sparse-index again.
 151          */
 152         for (i = 0; i < r->index->cache_nr; i++) {
 153                 struct cache_entry *ce = r->index->cache[i];
 154
 155                 if (S_ISSPARSEDIR(ce->ce_mode) &&
 156                     repo_file_exists(r, ce->name))
 157                         string_list_append(&sparse_dirs, ce->name);
 158         }
 159
 160         for_each_string_list_item(item, &sparse_dirs) {
 161                 struct dir_struct dir = DIR_INIT;
 162                 struct pathspec p = { 0 };
 163                 struct strvec s = STRVEC_INIT;
 164
 165                 strbuf_setlen(&path, pathlen);
 166                 strbuf_addstr(&path, item->string);
 167
 168                 dir.flags |= DIR_SHOW_IGNORED_TOO;
 169
 170                 setup_standard_excludes(&dir);
 171                 strvec_push(&s, path.buf);
 172
 173                 parse_pathspec(&p, PATHSPEC_GLOB, 0, NULL, s.v);
 174                 fill_directory(&dir, r->index, &p);
 175
 176                 if (dir.nr) {
 177                         warning(_("directory '%s' contains untracked files,"
 178                                   " but is not in the sparse-checkout cone"),
 179                                 item->string);
 180                 } else if (remove_dir_recursively(&path, 0)) {
 181                         /*
 182                          * Removal is "best effort". If something blocks
 183                          * the deletion, then continue with a warning.
 184                          */
 185                         warning(_("failed to remove directory '%s'"),
 186                                 item->string);
 187                 }
 188
 189                 strvec_clear(&s);
 190                 clear_pathspec(&p);
 191                 dir_clear(&dir);
 192         }
 193
 194         string_list_clear(&sparse_dirs, 0);
 195         strbuf_release(&path);
 196
 197         if (was_full)
 198                 ensure_full_index(r->index);
 199 }
 200
 201 static int update_working_directory(struct pattern_list *pl)
 202 {
 203         enum update_sparsity_result result;
 204         struct unpack_trees_options o;
 205         struct lock_file lock_file = LOCK_INIT;
 206         struct repository *r = the_repository;
 207
 208         /* If no branch has been checked out, there are no updates to make. */
 209         if (is_index_unborn(r->index))
 210                 return UPDATE_SPARSITY_SUCCESS;
 211
 212         r->index->sparse_checkout_patterns = pl;
 213
 214         memset(&o, 0, sizeof(o));
 215         o.verbose_update = isatty(2);
 216         o.update = 1;
 217         o.head_idx = -1;
 218         o.src_index = r->index;
 219         o.dst_index = r->index;
 220         index_state_init(&o.result, r);
 221         o.skip_sparse_checkout = 0;
 222         o.pl = pl;
 223
 224         setup_work_tree();
 225
 226         repo_hold_locked_index(r, &lock_file, LOCK_DIE_ON_ERROR);
 227
 228         setup_unpack_trees_porcelain(&o, "sparse-checkout");
 229         result = update_sparsity(&o);
 230         clear_unpack_trees_porcelain(&o);
 231
 232         if (result == UPDATE_SPARSITY_WARNINGS)
 233                 /*
 234                  * We don't do any special handling of warnings from untracked
 235                  * files in the way or dirty entries that can't be removed.
 236                  */
 237                 result = UPDATE_SPARSITY_SUCCESS;
 238         if (result == UPDATE_SPARSITY_SUCCESS)
 239                 write_locked_index(r->index, &lock_file, COMMIT_LOCK);
 240         else
 241                 rollback_lock_file(&lock_file);
 242
 243         clean_tracked_sparse_directories(r);
 244
 245         r->index->sparse_checkout_patterns = NULL;
 246         return result;
 247 }
 248
 249 static char *escaped_pattern(char *pattern)
 250 {
 251         char *p = pattern;
 252         struct strbuf final = STRBUF_INIT;
 253
 254         while (*p) {
 255                 if (is_glob_special(*p))
 256                         strbuf_addch(&final, '\\');
 257
 258                 strbuf_addch(&final, *p);
 259                 p++;
 260         }
 261
 262         return strbuf_detach(&final, NULL);
 263 }
 264
 265 static void write_cone_to_file(FILE *fp, struct pattern_list *pl)
 266 {
 267         int i;
 268         struct pattern_entry *pe;
 269         struct hashmap_iter iter;
 270         struct string_list sl = STRING_LIST_INIT_DUP;
 271         struct strbuf parent_pattern = STRBUF_INIT;
 272
 273         hashmap_for_each_entry(&pl->parent_hashmap, &iter, pe, ent) {
 274                 if (hashmap_get_entry(&pl->recursive_hashmap, pe, ent, NULL))
 275                         continue;
 276
 277                 if (!hashmap_contains_parent(&pl->recursive_hashmap,
 278                                              pe->pattern,
 279                                              &parent_pattern))
 280                         string_list_insert(&sl, pe->pattern);
 281         }
 282
 283         string_list_sort(&sl);
 284         string_list_remove_duplicates(&sl, 0);
 285
 286         fprintf(fp, "/*\n!/*/\n");
 287
 288         for (i = 0; i < sl.nr; i++) {
 289                 char *pattern = escaped_pattern(sl.items[i].string);
 290
 291                 if (strlen(pattern))
 292                         fprintf(fp, "%s/\n!%s/*/\n", pattern, pattern);
 293                 free(pattern);
 294         }
 295
 296         string_list_clear(&sl, 0);
 297
 298         hashmap_for_each_entry(&pl->recursive_hashmap, &iter, pe, ent) {
 299                 if (!hashmap_contains_parent(&pl->recursive_hashmap,
 300                                              pe->pattern,
 301                                              &parent_pattern))
 302                         string_list_insert(&sl, pe->pattern);
 303         }
 304
 305         strbuf_release(&parent_pattern);
 306
 307         string_list_sort(&sl);
 308         string_list_remove_duplicates(&sl, 0);
 309
 310         for (i = 0; i < sl.nr; i++) {
 311                 char *pattern = escaped_pattern(sl.items[i].string);
 312                 fprintf(fp, "%s/\n", pattern);
 313                 free(pattern);
 314         }
 315 }
 316
 317 static int write_patterns_and_update(struct pattern_list *pl)
 318 {
 319         char *sparse_filename;
 320         FILE *fp;
 321         int fd;
 322         struct lock_file lk = LOCK_INIT;
 323         int result;
 324
 325         sparse_filename = get_sparse_checkout_filename();
 326
 327         if (safe_create_leading_directories(sparse_filename))
 328                 die(_("failed to create directory for sparse-checkout file"));
 329
 330         fd = hold_lock_file_for_update(&lk, sparse_filename,
 331                                       LOCK_DIE_ON_ERROR);
 332         free(sparse_filename);
 333
 334         result = update_working_directory(pl);
 335         if (result) {
 336                 rollback_lock_file(&lk);
 337                 clear_pattern_list(pl);
 338                 update_working_directory(NULL);
 339                 return result;
 340         }
 341
 342         fp = xfdopen(fd, "w");
 343
 344         if (core_sparse_checkout_cone)
 345                 write_cone_to_file(fp, pl);
 346         else
 347                 write_patterns_to_file(fp, pl);
 348
 349         fflush(fp);
 350         commit_lock_file(&lk);
 351
 352         clear_pattern_list(pl);
 353
 354         return 0;
 355 }
 356
 357 enum sparse_checkout_mode {
 358         MODE_NO_PATTERNS = 0,
 359         MODE_ALL_PATTERNS = 1,
 360         MODE_CONE_PATTERNS = 2,
 361 };
 362
 363 static int set_config(enum sparse_checkout_mode mode)
 364 {
 365         /* Update to use worktree config, if not already. */
 366         if (init_worktree_config(the_repository)) {
 367                 error(_("failed to initialize worktree config"));
 368                 return 1;
 369         }
 370
 371         if (repo_config_set_worktree_gently(the_repository,
 372                                             "core.sparseCheckout",
 373                                             mode ? "true" : "false") ||
 374             repo_config_set_worktree_gently(the_repository,
 375                                             "core.sparseCheckoutCone",
 376                                             mode == MODE_CONE_PATTERNS ?
 377                                                 "true" : "false"))
 378                 return 1;
 379
 380         if (mode == MODE_NO_PATTERNS)
 381                 return set_sparse_index_config(the_repository, 0);
 382
 383         return 0;
 384 }
 385
 386 static int update_modes(int *cone_mode, int *sparse_index)
 387 {
 388         int mode, record_mode;
 389
 390         /* Determine if we need to record the mode; ensure sparse checkout on */
 391         record_mode = (*cone_mode != -1) || !core_apply_sparse_checkout;
 392
 393         /* If not specified, use previous definition of cone mode */
 394         if (*cone_mode == -1 && core_apply_sparse_checkout)
 395                 *cone_mode = core_sparse_checkout_cone;
 396
 397         /* Set cone/non-cone mode appropriately */
 398         core_apply_sparse_checkout = 1;
 399         if (*cone_mode == 1 || *cone_mode == -1) {
 400                 mode = MODE_CONE_PATTERNS;
 401                 core_sparse_checkout_cone = 1;
 402         } else {
 403                 mode = MODE_ALL_PATTERNS;
 404                 core_sparse_checkout_cone = 0;
 405         }
 406         if (record_mode && set_config(mode))
 407                 return 1;
 408
 409         /* Set sparse-index/non-sparse-index mode if specified */
 410         if (*sparse_index >= 0) {
 411                 if (set_sparse_index_config(the_repository, *sparse_index) < 0)
 412                         die(_("failed to modify sparse-index config"));
 413
 414                 /* force an index rewrite */
 415                 repo_read_index(the_repository);
 416                 the_repository->index->updated_workdir = 1;
 417
 418                 if (!*sparse_index)
 419                         ensure_full_index(the_repository->index);
 420         }
 421
 422         return 0;
 423 }
 424
 425 static char const * const builtin_sparse_checkout_init_usage[] = {
 426         "git sparse-checkout init [--cone] [--[no-]sparse-index]",
 427         NULL
 428 };
 429
 430 static struct sparse_checkout_init_opts {
 431         int cone_mode;
 432         int sparse_index;
 433 } init_opts;
 434
 435 static int sparse_checkout_init(int argc, const char **argv, const char *prefix)
 436 {
 437         struct pattern_list pl;
 438         char *sparse_filename;
 439         int res;
 440         struct object_id oid;
 441         struct strbuf pattern = STRBUF_INIT;
 442
 443         static struct option builtin_sparse_checkout_init_options[] = {
 444                 OPT_BOOL(0, "cone", &init_opts.cone_mode,
 445                          N_("initialize the sparse-checkout in cone mode")),
 446                 OPT_BOOL(0, "sparse-index", &init_opts.sparse_index,
 447                          N_("toggle the use of a sparse index")),
 448                 OPT_END(),
 449         };
 450
 451         repo_read_index(the_repository);
 452
 453         init_opts.cone_mode = -1;
 454         init_opts.sparse_index = -1;
 455
 456         argc = parse_options(argc, argv, prefix,
 457                              builtin_sparse_checkout_init_options,
 458                              builtin_sparse_checkout_init_usage, 0);
 459
 460         if (update_modes(&init_opts.cone_mode, &init_opts.sparse_index))
 461                 return 1;
 462
 463         memset(&pl, 0, sizeof(pl));
 464
 465         sparse_filename = get_sparse_checkout_filename();
 466         res = add_patterns_from_file_to_list(sparse_filename, "", 0, &pl, NULL, 0);
 467
 468         /* If we already have a sparse-checkout file, use it. */
 469         if (res >= 0) {
 470                 free(sparse_filename);
 471                 return update_working_directory(NULL);
 472         }
 473
 474         if (get_oid("HEAD", &oid)) {
 475                 FILE *fp;
 476
 477                 /* assume we are in a fresh repo, but update the sparse-checkout file */
 478                 if (safe_create_leading_directories(sparse_filename))
 479                         die(_("unable to create leading directories of %s"),
 480                             sparse_filename);
 481                 fp = xfopen(sparse_filename, "w");
 482                 if (!fp)
 483                         die(_("failed to open '%s'"), sparse_filename);
 484
 485                 free(sparse_filename);
 486                 fprintf(fp, "/*\n!/*/\n");
 487                 fclose(fp);
 488                 return 0;
 489         }
 490
 491         strbuf_addstr(&pattern, "/*");
 492         add_pattern(strbuf_detach(&pattern, NULL), empty_base, 0, &pl, 0);
 493         strbuf_addstr(&pattern, "!/*/");
 494         add_pattern(strbuf_detach(&pattern, NULL), empty_base, 0, &pl, 0);
 495         pl.use_cone_patterns = init_opts.cone_mode;
 496
 497         return write_patterns_and_update(&pl);
 498 }
 499
 500 static void insert_recursive_pattern(struct pattern_list *pl, struct strbuf *path)
 501 {
 502         struct pattern_entry *e = xmalloc(sizeof(*e));
 503         e->patternlen = path->len;
 504         e->pattern = strbuf_detach(path, NULL);
 505         hashmap_entry_init(&e->ent, fspathhash(e->pattern));
 506
 507         hashmap_add(&pl->recursive_hashmap, &e->ent);
 508
 509         while (e->patternlen) {
 510                 char *slash = strrchr(e->pattern, '/');
 511                 char *oldpattern = e->pattern;
 512                 size_t newlen;
 513
 514                 if (!slash || slash == e->pattern)
 515                         break;
 516
 517                 newlen = slash - e->pattern;
 518                 e = xmalloc(sizeof(struct pattern_entry));
 519                 e->patternlen = newlen;
 520                 e->pattern = xstrndup(oldpattern, newlen);
 521                 hashmap_entry_init(&e->ent, fspathhash(e->pattern));
 522
 523                 if (!hashmap_get_entry(&pl->parent_hashmap, e, ent, NULL))
 524                         hashmap_add(&pl->parent_hashmap, &e->ent);
 525         }
 526 }
 527
 528 static void strbuf_to_cone_pattern(struct strbuf *line, struct pattern_list *pl)
 529 {
 530         strbuf_trim(line);
 531
 532         strbuf_trim_trailing_dir_sep(line);
 533
 534         if (strbuf_normalize_path(line))
 535                 die(_("could not normalize path %s"), line->buf);
 536
 537         if (!line->len)
 538                 return;
 539
 540         if (line->buf[0] != '/')
 541                 strbuf_insertstr(line, 0, "/");
 542
 543         insert_recursive_pattern(pl, line);
 544 }
 545
 546 static void add_patterns_from_input(struct pattern_list *pl,
 547                                     int argc, const char **argv,
 548                                     int use_stdin)
 549 {
 550         int i;
 551         if (core_sparse_checkout_cone) {
 552                 struct strbuf line = STRBUF_INIT;
 553
 554                 hashmap_init(&pl->recursive_hashmap, pl_hashmap_cmp, NULL, 0);
 555                 hashmap_init(&pl->parent_hashmap, pl_hashmap_cmp, NULL, 0);
 556                 pl->use_cone_patterns = 1;
 557
 558                 if (use_stdin) {
 559                         struct strbuf unquoted = STRBUF_INIT;
 560                         while (!strbuf_getline(&line, stdin)) {
 561                                 if (line.buf[0] == '"') {
 562                                         strbuf_reset(&unquoted);
 563                                         if (unquote_c_style(&unquoted, line.buf, NULL))
 564                                                 die(_("unable to unquote C-style string '%s'"),
 565                                                 line.buf);
 566
 567                                         strbuf_swap(&unquoted, &line);
 568                                 }
 569
 570                                 strbuf_to_cone_pattern(&line, pl);
 571                         }
 572
 573                         strbuf_release(&unquoted);
 574                 } else {
 575                         for (i = 0; i < argc; i++) {
 576                                 strbuf_setlen(&line, 0);
 577                                 strbuf_addstr(&line, argv[i]);
 578                                 strbuf_to_cone_pattern(&line, pl);
 579                         }
 580                 }
 581         } else {
 582                 if (use_stdin) {
 583                         struct strbuf line = STRBUF_INIT;
 584
 585                         while (!strbuf_getline(&line, stdin)) {
 586                                 size_t len;
 587                                 char *buf = strbuf_detach(&line, &len);
 588                                 add_pattern(buf, empty_base, 0, pl, 0);
 589                         }
 590                 } else {
 591                         for (i = 0; i < argc; i++)
 592                                 add_pattern(argv[i], empty_base, 0, pl, 0);
 593                 }
 594         }
 595 }
 596
 597 enum modify_type {
 598         REPLACE,
 599         ADD,
 600 };
 601
 602 static void add_patterns_cone_mode(int argc, const char **argv,
 603                                    struct pattern_list *pl,
 604                                    int use_stdin)
 605 {
 606         struct strbuf buffer = STRBUF_INIT;
 607         struct pattern_entry *pe;
 608         struct hashmap_iter iter;
 609         struct pattern_list existing;
 610         char *sparse_filename = get_sparse_checkout_filename();
 611
 612         add_patterns_from_input(pl, argc, argv, use_stdin);
 613
 614         memset(&existing, 0, sizeof(existing));
 615         existing.use_cone_patterns = core_sparse_checkout_cone;
 616
 617         if (add_patterns_from_file_to_list(sparse_filename, "", 0,
 618                                            &existing, NULL, 0))
 619                 die(_("unable to load existing sparse-checkout patterns"));
 620         free(sparse_filename);
 621
 622         if (!existing.use_cone_patterns)
 623                 die(_("existing sparse-checkout patterns do not use cone mode"));
 624
 625         hashmap_for_each_entry(&existing.recursive_hashmap, &iter, pe, ent) {
 626                 if (!hashmap_contains_parent(&pl->recursive_hashmap,
 627                                         pe->pattern, &buffer) ||
 628                     !hashmap_contains_parent(&pl->parent_hashmap,
 629                                         pe->pattern, &buffer)) {
 630                         strbuf_reset(&buffer);
 631                         strbuf_addstr(&buffer, pe->pattern);
 632                         insert_recursive_pattern(pl, &buffer);
 633                 }
 634         }
 635
 636         clear_pattern_list(&existing);
 637         strbuf_release(&buffer);
 638 }
 639
 640 static void add_patterns_literal(int argc, const char **argv,
 641                                  struct pattern_list *pl,
 642                                  int use_stdin)
 643 {
 644         char *sparse_filename = get_sparse_checkout_filename();
 645         if (add_patterns_from_file_to_list(sparse_filename, "", 0,
 646                                            pl, NULL, 0))
 647                 die(_("unable to load existing sparse-checkout patterns"));
 648         free(sparse_filename);
 649         add_patterns_from_input(pl, argc, argv, use_stdin);
 650 }
 651
 652 static int modify_pattern_list(int argc, const char **argv, int use_stdin,
 653                                enum modify_type m)
 654 {
 655         int result;
 656         int changed_config = 0;
 657         struct pattern_list *pl = xcalloc(1, sizeof(*pl));
 658
 659         switch (m) {
 660         case ADD:
 661                 if (core_sparse_checkout_cone)
 662                         add_patterns_cone_mode(argc, argv, pl, use_stdin);
 663                 else
 664                         add_patterns_literal(argc, argv, pl, use_stdin);
 665                 break;
 666
 667         case REPLACE:
 668                 add_patterns_from_input(pl, argc, argv, use_stdin);
 669                 break;
 670         }
 671
 672         if (!core_apply_sparse_checkout) {
 673                 set_config(MODE_ALL_PATTERNS);
 674                 core_apply_sparse_checkout = 1;
 675                 changed_config = 1;
 676         }
 677
 678         result = write_patterns_and_update(pl);
 679
 680         if (result && changed_config)
 681                 set_config(MODE_NO_PATTERNS);
 682
 683         clear_pattern_list(pl);
 684         free(pl);
 685         return result;
 686 }
 687
 688 static void sanitize_paths(int argc, const char **argv,
 689                            const char *prefix, int skip_checks)
 690 {
 691         int i;
 692
 693         if (!argc)
 694                 return;
 695
 696         if (prefix && *prefix && core_sparse_checkout_cone) {
 697                 /*
 698                  * The args are not pathspecs, so unfortunately we
 699                  * cannot imitate how cmd_add() uses parse_pathspec().
 700                  */
 701                 int prefix_len = strlen(prefix);
 702
 703                 for (i = 0; i < argc; i++)
 704                         argv[i] = prefix_path(prefix, prefix_len, argv[i]);
 705         }
 706
 707         if (skip_checks)
 708                 return;
 709
 710         if (prefix && *prefix && !core_sparse_checkout_cone)
 711                 die(_("please run from the toplevel directory in non-cone mode"));
 712
 713         if (core_sparse_checkout_cone) {
 714                 for (i = 0; i < argc; i++) {
 715                         if (argv[i][0] == '/')
 716                                 die(_("specify directories rather than patterns (no leading slash)"));
 717                         if (argv[i][0] == '!')
 718                                 die(_("specify directories rather than patterns.  If your directory starts with a '!', pass --skip-checks"));
 719                         if (strpbrk(argv[i], "*?[]"))
 720                                 die(_("specify directories rather than patterns.  If your directory really has any of '*?[]\\' in it, pass --skip-checks"));
 721                 }
 722         }
 723
 724         for (i = 0; i < argc; i++) {
 725                 struct cache_entry *ce;
 726                 struct index_state *index = the_repository->index;
 727                 int pos = index_name_pos(index, argv[i], strlen(argv[i]));
 728
 729                 if (pos < 0)
 730                         continue;
 731                 ce = index->cache[pos];
 732                 if (S_ISSPARSEDIR(ce->ce_mode))
 733                         continue;
 734
 735                 if (core_sparse_checkout_cone)
 736                         die(_("'%s' is not a directory; to treat it as a directory anyway, rerun with --skip-checks"), argv[i]);
 737                 else
 738                         warning(_("pass a leading slash before paths such as '%s' if you want a single file (see NON-CONE PROBLEMS in the git-sparse-checkout manual)."), argv[i]);
 739         }
 740 }
 741
 742 static char const * const builtin_sparse_checkout_add_usage[] = {
 743         N_("git sparse-checkout add [--skip-checks] (--stdin | <patterns>)"),
 744         NULL
 745 };
 746
 747 static struct sparse_checkout_add_opts {
 748         int skip_checks;
 749         int use_stdin;
 750 } add_opts;
 751
 752 static int sparse_checkout_add(int argc, const char **argv, const char *prefix)
 753 {
 754         static struct option builtin_sparse_checkout_add_options[] = {
 755                 OPT_BOOL_F(0, "skip-checks", &add_opts.skip_checks,
 756                            N_("skip some sanity checks on the given paths that might give false positives"),
 757                            PARSE_OPT_NONEG),
 758                 OPT_BOOL(0, "stdin", &add_opts.use_stdin,
 759                          N_("read patterns from standard in")),
 760                 OPT_END(),
 761         };
 762
 763         if (!core_apply_sparse_checkout)
 764                 die(_("no sparse-checkout to add to"));
 765
 766         repo_read_index(the_repository);
 767
 768         argc = parse_options(argc, argv, prefix,
 769                              builtin_sparse_checkout_add_options,
 770                              builtin_sparse_checkout_add_usage,
 771                              PARSE_OPT_KEEP_UNKNOWN_OPT);
 772
 773         sanitize_paths(argc, argv, prefix, add_opts.skip_checks);
 774
 775         return modify_pattern_list(argc, argv, add_opts.use_stdin, ADD);
 776 }
 777
 778 static char const * const builtin_sparse_checkout_set_usage[] = {
 779         N_("git sparse-checkout set [--[no-]cone] [--[no-]sparse-index] [--skip-checks] (--stdin | <patterns>)"),
 780         NULL
 781 };
 782
 783 static struct sparse_checkout_set_opts {
 784         int cone_mode;
 785         int sparse_index;
 786         int skip_checks;
 787         int use_stdin;
 788 } set_opts;
 789
 790 static int sparse_checkout_set(int argc, const char **argv, const char *prefix)
 791 {
 792         int default_patterns_nr = 2;
 793         const char *default_patterns[] = {"/*", "!/*/", NULL};
 794
 795         static struct option builtin_sparse_checkout_set_options[] = {
 796                 OPT_BOOL(0, "cone", &set_opts.cone_mode,
 797                          N_("initialize the sparse-checkout in cone mode")),
 798                 OPT_BOOL(0, "sparse-index", &set_opts.sparse_index,
 799                          N_("toggle the use of a sparse index")),
 800                 OPT_BOOL_F(0, "skip-checks", &set_opts.skip_checks,
 801                            N_("skip some sanity checks on the given paths that might give false positives"),
 802                            PARSE_OPT_NONEG),
 803                 OPT_BOOL_F(0, "stdin", &set_opts.use_stdin,
 804                            N_("read patterns from standard in"),
 805                            PARSE_OPT_NONEG),
 806                 OPT_END(),
 807         };
 808
 809         repo_read_index(the_repository);
 810
 811         set_opts.cone_mode = -1;
 812         set_opts.sparse_index = -1;
 813
 814         argc = parse_options(argc, argv, prefix,
 815                              builtin_sparse_checkout_set_options,
 816                              builtin_sparse_checkout_set_usage,
 817                              PARSE_OPT_KEEP_UNKNOWN_OPT);
 818
 819         if (update_modes(&set_opts.cone_mode, &set_opts.sparse_index))
 820                 return 1;
 821
 822         /*
 823          * Cone mode automatically specifies the toplevel directory.  For
 824          * non-cone mode, if nothing is specified, manually select just the
 825          * top-level directory (much as 'init' would do).
 826          */
 827         if (!core_sparse_checkout_cone && argc == 0) {
 828                 argv = default_patterns;
 829                 argc = default_patterns_nr;
 830         } else {
 831                 sanitize_paths(argc, argv, prefix, set_opts.skip_checks);
 832         }
 833
 834         return modify_pattern_list(argc, argv, set_opts.use_stdin, REPLACE);
 835 }
 836
 837 static char const * const builtin_sparse_checkout_reapply_usage[] = {
 838         "git sparse-checkout reapply [--[no-]cone] [--[no-]sparse-index]",
 839         NULL
 840 };
 841
 842 static struct sparse_checkout_reapply_opts {
 843         int cone_mode;
 844         int sparse_index;
 845 } reapply_opts;
 846
 847 static int sparse_checkout_reapply(int argc, const char **argv,
 848                                    const char *prefix)
 849 {
 850         static struct option builtin_sparse_checkout_reapply_options[] = {
 851                 OPT_BOOL(0, "cone", &reapply_opts.cone_mode,
 852                          N_("initialize the sparse-checkout in cone mode")),
 853                 OPT_BOOL(0, "sparse-index", &reapply_opts.sparse_index,
 854                          N_("toggle the use of a sparse index")),
 855                 OPT_END(),
 856         };
 857
 858         if (!core_apply_sparse_checkout)
 859                 die(_("must be in a sparse-checkout to reapply sparsity patterns"));
 860
 861         reapply_opts.cone_mode = -1;
 862         reapply_opts.sparse_index = -1;
 863
 864         argc = parse_options(argc, argv, prefix,
 865                              builtin_sparse_checkout_reapply_options,
 866                              builtin_sparse_checkout_reapply_usage, 0);
 867
 868         repo_read_index(the_repository);
 869
 870         if (update_modes(&reapply_opts.cone_mode, &reapply_opts.sparse_index))
 871                 return 1;
 872
 873         return update_working_directory(NULL);
 874 }
 875
 876 static char const * const builtin_sparse_checkout_disable_usage[] = {
 877         "git sparse-checkout disable",
 878         NULL
 879 };
 880
 881 static int sparse_checkout_disable(int argc, const char **argv,
 882                                    const char *prefix)
 883 {
 884         static struct option builtin_sparse_checkout_disable_options[] = {
 885                 OPT_END(),
 886         };
 887         struct pattern_list pl;
 888         struct strbuf match_all = STRBUF_INIT;
 889
 890         /*
 891          * We do not exit early if !core_apply_sparse_checkout; due to the
 892          * ability for users to manually muck things up between
 893          *   direct editing of .git/info/sparse-checkout
 894          *   running read-tree -m u HEAD or update-index --skip-worktree
 895          *   direct toggling of config options
 896          * users might end up with an index with SKIP_WORKTREE bit set on
 897          * some files and not know how to undo it.  So, here we just
 898          * forcibly return to a dense checkout regardless of initial state.
 899          */
 900
 901         argc = parse_options(argc, argv, prefix,
 902                              builtin_sparse_checkout_disable_options,
 903                              builtin_sparse_checkout_disable_usage, 0);
 904
 905         repo_read_index(the_repository);
 906
 907         memset(&pl, 0, sizeof(pl));
 908         hashmap_init(&pl.recursive_hashmap, pl_hashmap_cmp, NULL, 0);
 909         hashmap_init(&pl.parent_hashmap, pl_hashmap_cmp, NULL, 0);
 910         pl.use_cone_patterns = 0;
 911         core_apply_sparse_checkout = 1;
 912
 913         strbuf_addstr(&match_all, "/*");
 914         add_pattern(strbuf_detach(&match_all, NULL), empty_base, 0, &pl, 0);
 915
 916         prepare_repo_settings(the_repository);
 917         the_repository->settings.sparse_index = 0;
 918
 919         if (update_working_directory(&pl))
 920                 die(_("error while refreshing working directory"));
 921
 922         clear_pattern_list(&pl);
 923         return set_config(MODE_NO_PATTERNS);
 924 }
 925
 926 int cmd_sparse_checkout(int argc, const char **argv, const char *prefix)
 927 {
 928         parse_opt_subcommand_fn *fn = NULL;
 929         struct option builtin_sparse_checkout_options[] = {
 930                 OPT_SUBCOMMAND("list", &fn, sparse_checkout_list),
 931                 OPT_SUBCOMMAND("init", &fn, sparse_checkout_init),
 932                 OPT_SUBCOMMAND("set", &fn, sparse_checkout_set),
 933                 OPT_SUBCOMMAND("add", &fn, sparse_checkout_add),
 934                 OPT_SUBCOMMAND("reapply", &fn, sparse_checkout_reapply),
 935                 OPT_SUBCOMMAND("disable", &fn, sparse_checkout_disable),
 936                 OPT_END(),
 937         };
 938
 939         argc = parse_options(argc, argv, prefix,
 940                              builtin_sparse_checkout_options,
 941                              builtin_sparse_checkout_usage, 0);
 942
 943         git_config(git_default_config, NULL);
 944
 945         prepare_repo_settings(the_repository);
 946         the_repository->settings.command_requires_full_index = 0;
 947
 948         return fn(argc, argv, prefix);
 949 }