builtin/sparse-checkout.c

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