builtin/sparse-checkout.c

   1 #include "builtin.h"
   2 #include "config.h"
   3 #include "dir.h"
   4 #include "parse-options.h"
   5 #include "pathspec.h"
   6 #include "repository.h"
   7 #include "run-command.h"
   8 #include "strbuf.h"
   9 #include "string-list.h"
  10 #include "cache.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
  19 static const char *empty_base = "";
  20
  21 static char const * const builtin_sparse_checkout_usage[] = {
  22         N_("git sparse-checkout (init|list|set|add|reapply|disable) <options>"),
  23         NULL
  24 };
  25
  26 static void write_patterns_to_file(FILE *fp, struct pattern_list *pl)
  27 {
  28         int i;
  29
  30         for (i = 0; i < pl->nr; i++) {
  31                 struct path_pattern *p = pl->patterns[i];
  32
  33                 if (p->flags & PATTERN_FLAG_NEGATIVE)
  34                         fprintf(fp, "!");
  35
  36                 fprintf(fp, "%s", p->pattern);
  37
  38                 if (p->flags & PATTERN_FLAG_MUSTBEDIR)
  39                         fprintf(fp, "/");
  40
  41                 fprintf(fp, "\n");
  42         }
  43 }
  44
  45 static char const * const builtin_sparse_checkout_list_usage[] = {
  46         N_("git sparse-checkout list"),
  47         NULL
  48 };
  49
  50 static int sparse_checkout_list(int argc, const char **argv)
  51 {
  52         static struct option builtin_sparse_checkout_list_options[] = {
  53                 OPT_END(),
  54         };
  55         struct pattern_list pl;
  56         char *sparse_filename;
  57         int res;
  58
  59         argc = parse_options(argc, argv, NULL,
  60                              builtin_sparse_checkout_list_options,
  61                              builtin_sparse_checkout_list_usage, 0);
  62
  63         memset(&pl, 0, sizeof(pl));
  64
  65         pl.use_cone_patterns = core_sparse_checkout_cone;
  66
  67         sparse_filename = get_sparse_checkout_filename();
  68         res = add_patterns_from_file_to_list(sparse_filename, "", 0, &pl, NULL, 0);
  69         free(sparse_filename);
  70
  71         if (res < 0) {
  72                 warning(_("this worktree is not sparse (sparse-checkout file may not exist)"));
  73                 return 0;
  74         }
  75
  76         if (pl.use_cone_patterns) {
  77                 int i;
  78                 struct pattern_entry *pe;
  79                 struct hashmap_iter iter;
  80                 struct string_list sl = STRING_LIST_INIT_DUP;
  81
  82                 hashmap_for_each_entry(&pl.recursive_hashmap, &iter, pe, ent) {
  83                         /* pe->pattern starts with "/", skip it */
  84                         string_list_insert(&sl, pe->pattern + 1);
  85                 }
  86
  87                 string_list_sort(&sl);
  88
  89                 for (i = 0; i < sl.nr; i++) {
  90                         quote_c_style(sl.items[i].string, NULL, stdout, 0);
  91                         printf("\n");
  92                 }
  93
  94                 return 0;
  95         }
  96
  97         write_patterns_to_file(stdout, &pl);
  98         clear_pattern_list(&pl);
  99
 100         return 0;
 101 }
 102
 103 static int update_working_directory(struct pattern_list *pl)
 104 {
 105         enum update_sparsity_result result;
 106         struct unpack_trees_options o;
 107         struct lock_file lock_file = LOCK_INIT;
 108         struct repository *r = the_repository;
 109
 110         /* If no branch has been checked out, there are no updates to make. */
 111         if (is_index_unborn(r->index))
 112                 return UPDATE_SPARSITY_SUCCESS;
 113
 114         r->index->sparse_checkout_patterns = pl;
 115
 116         memset(&o, 0, sizeof(o));
 117         o.verbose_update = isatty(2);
 118         o.update = 1;
 119         o.head_idx = -1;
 120         o.src_index = r->index;
 121         o.dst_index = r->index;
 122         o.skip_sparse_checkout = 0;
 123         o.pl = pl;
 124
 125         setup_work_tree();
 126
 127         repo_hold_locked_index(r, &lock_file, LOCK_DIE_ON_ERROR);
 128
 129         setup_unpack_trees_porcelain(&o, "sparse-checkout");
 130         result = update_sparsity(&o);
 131         clear_unpack_trees_porcelain(&o);
 132
 133         if (result == UPDATE_SPARSITY_WARNINGS)
 134                 /*
 135                  * We don't do any special handling of warnings from untracked
 136                  * files in the way or dirty entries that can't be removed.
 137                  */
 138                 result = UPDATE_SPARSITY_SUCCESS;
 139         if (result == UPDATE_SPARSITY_SUCCESS)
 140                 write_locked_index(r->index, &lock_file, COMMIT_LOCK);
 141         else
 142                 rollback_lock_file(&lock_file);
 143
 144         r->index->sparse_checkout_patterns = NULL;
 145         return result;
 146 }
 147
 148 static char *escaped_pattern(char *pattern)
 149 {
 150         char *p = pattern;
 151         struct strbuf final = STRBUF_INIT;
 152
 153         while (*p) {
 154                 if (is_glob_special(*p))
 155                         strbuf_addch(&final, '\\');
 156
 157                 strbuf_addch(&final, *p);
 158                 p++;
 159         }
 160
 161         return strbuf_detach(&final, NULL);
 162 }
 163
 164 static void write_cone_to_file(FILE *fp, struct pattern_list *pl)
 165 {
 166         int i;
 167         struct pattern_entry *pe;
 168         struct hashmap_iter iter;
 169         struct string_list sl = STRING_LIST_INIT_DUP;
 170         struct strbuf parent_pattern = STRBUF_INIT;
 171
 172         hashmap_for_each_entry(&pl->parent_hashmap, &iter, pe, ent) {
 173                 if (hashmap_get_entry(&pl->recursive_hashmap, pe, ent, NULL))
 174                         continue;
 175
 176                 if (!hashmap_contains_parent(&pl->recursive_hashmap,
 177                                              pe->pattern,
 178                                              &parent_pattern))
 179                         string_list_insert(&sl, pe->pattern);
 180         }
 181
 182         string_list_sort(&sl);
 183         string_list_remove_duplicates(&sl, 0);
 184
 185         fprintf(fp, "/*\n!/*/\n");
 186
 187         for (i = 0; i < sl.nr; i++) {
 188                 char *pattern = escaped_pattern(sl.items[i].string);
 189
 190                 if (strlen(pattern))
 191                         fprintf(fp, "%s/\n!%s/*/\n", pattern, pattern);
 192                 free(pattern);
 193         }
 194
 195         string_list_clear(&sl, 0);
 196
 197         hashmap_for_each_entry(&pl->recursive_hashmap, &iter, pe, ent) {
 198                 if (!hashmap_contains_parent(&pl->recursive_hashmap,
 199                                              pe->pattern,
 200                                              &parent_pattern))
 201                         string_list_insert(&sl, pe->pattern);
 202         }
 203
 204         strbuf_release(&parent_pattern);
 205
 206         string_list_sort(&sl);
 207         string_list_remove_duplicates(&sl, 0);
 208
 209         for (i = 0; i < sl.nr; i++) {
 210                 char *pattern = escaped_pattern(sl.items[i].string);
 211                 fprintf(fp, "%s/\n", pattern);
 212                 free(pattern);
 213         }
 214 }
 215
 216 static int write_patterns_and_update(struct pattern_list *pl)
 217 {
 218         char *sparse_filename;
 219         FILE *fp;
 220         int fd;
 221         struct lock_file lk = LOCK_INIT;
 222         int result;
 223
 224         sparse_filename = get_sparse_checkout_filename();
 225
 226         if (safe_create_leading_directories(sparse_filename))
 227                 die(_("failed to create directory for sparse-checkout file"));
 228
 229         fd = hold_lock_file_for_update(&lk, sparse_filename,
 230                                       LOCK_DIE_ON_ERROR);
 231
 232         result = update_working_directory(pl);
 233         if (result) {
 234                 rollback_lock_file(&lk);
 235                 free(sparse_filename);
 236                 clear_pattern_list(pl);
 237                 update_working_directory(NULL);
 238                 return result;
 239         }
 240
 241         fp = xfdopen(fd, "w");
 242
 243         if (core_sparse_checkout_cone)
 244                 write_cone_to_file(fp, pl);
 245         else
 246                 write_patterns_to_file(fp, pl);
 247
 248         fflush(fp);
 249         commit_lock_file(&lk);
 250
 251         free(sparse_filename);
 252         clear_pattern_list(pl);
 253
 254         return 0;
 255 }
 256
 257 enum sparse_checkout_mode {
 258         MODE_NO_PATTERNS = 0,
 259         MODE_ALL_PATTERNS = 1,
 260         MODE_CONE_PATTERNS = 2,
 261 };
 262
 263 static int set_config(enum sparse_checkout_mode mode)
 264 {
 265         const char *config_path;
 266
 267         if (upgrade_repository_format(1) < 0)
 268                 die(_("unable to upgrade repository format to enable worktreeConfig"));
 269         if (git_config_set_gently("extensions.worktreeConfig", "true")) {
 270                 error(_("failed to set extensions.worktreeConfig setting"));
 271                 return 1;
 272         }
 273
 274         config_path = git_path("config.worktree");
 275         git_config_set_in_file_gently(config_path,
 276                                       "core.sparseCheckout",
 277                                       mode ? "true" : NULL);
 278
 279         git_config_set_in_file_gently(config_path,
 280                                       "core.sparseCheckoutCone",
 281                                       mode == MODE_CONE_PATTERNS ? "true" : NULL);
 282
 283         if (mode == MODE_NO_PATTERNS)
 284                 set_sparse_index_config(the_repository, 0);
 285
 286         return 0;
 287 }
 288
 289 static char const * const builtin_sparse_checkout_init_usage[] = {
 290         N_("git sparse-checkout init [--cone] [--[no-]sparse-index]"),
 291         NULL
 292 };
 293
 294 static struct sparse_checkout_init_opts {
 295         int cone_mode;
 296         int sparse_index;
 297 } init_opts;
 298
 299 static int sparse_checkout_init(int argc, const char **argv)
 300 {
 301         struct pattern_list pl;
 302         char *sparse_filename;
 303         int res;
 304         struct object_id oid;
 305         int mode;
 306         struct strbuf pattern = STRBUF_INIT;
 307
 308         static struct option builtin_sparse_checkout_init_options[] = {
 309                 OPT_BOOL(0, "cone", &init_opts.cone_mode,
 310                          N_("initialize the sparse-checkout in cone mode")),
 311                 OPT_BOOL(0, "sparse-index", &init_opts.sparse_index,
 312                          N_("toggle the use of a sparse index")),
 313                 OPT_END(),
 314         };
 315
 316         repo_read_index(the_repository);
 317
 318         init_opts.sparse_index = -1;
 319
 320         argc = parse_options(argc, argv, NULL,
 321                              builtin_sparse_checkout_init_options,
 322                              builtin_sparse_checkout_init_usage, 0);
 323
 324         if (init_opts.cone_mode) {
 325                 mode = MODE_CONE_PATTERNS;
 326                 core_sparse_checkout_cone = 1;
 327         } else
 328                 mode = MODE_ALL_PATTERNS;
 329
 330         if (set_config(mode))
 331                 return 1;
 332
 333         memset(&pl, 0, sizeof(pl));
 334
 335         sparse_filename = get_sparse_checkout_filename();
 336         res = add_patterns_from_file_to_list(sparse_filename, "", 0, &pl, NULL, 0);
 337
 338         if (init_opts.sparse_index >= 0) {
 339                 if (set_sparse_index_config(the_repository, init_opts.sparse_index) < 0)
 340                         die(_("failed to modify sparse-index config"));
 341
 342                 /* force an index rewrite */
 343                 repo_read_index(the_repository);
 344                 the_repository->index->updated_workdir = 1;
 345         }
 346
 347         core_apply_sparse_checkout = 1;
 348
 349         /* If we already have a sparse-checkout file, use it. */
 350         if (res >= 0) {
 351                 free(sparse_filename);
 352                 return update_working_directory(NULL);
 353         }
 354
 355         if (get_oid("HEAD", &oid)) {
 356                 FILE *fp;
 357
 358                 /* assume we are in a fresh repo, but update the sparse-checkout file */
 359                 fp = xfopen(sparse_filename, "w");
 360                 if (!fp)
 361                         die(_("failed to open '%s'"), sparse_filename);
 362
 363                 free(sparse_filename);
 364                 fprintf(fp, "/*\n!/*/\n");
 365                 fclose(fp);
 366                 return 0;
 367         }
 368
 369         strbuf_addstr(&pattern, "/*");
 370         add_pattern(strbuf_detach(&pattern, NULL), empty_base, 0, &pl, 0);
 371         strbuf_addstr(&pattern, "!/*/");
 372         add_pattern(strbuf_detach(&pattern, NULL), empty_base, 0, &pl, 0);
 373         pl.use_cone_patterns = init_opts.cone_mode;
 374
 375         return write_patterns_and_update(&pl);
 376 }
 377
 378 static void insert_recursive_pattern(struct pattern_list *pl, struct strbuf *path)
 379 {
 380         struct pattern_entry *e = xmalloc(sizeof(*e));
 381         e->patternlen = path->len;
 382         e->pattern = strbuf_detach(path, NULL);
 383         hashmap_entry_init(&e->ent, fspathhash(e->pattern));
 384
 385         hashmap_add(&pl->recursive_hashmap, &e->ent);
 386
 387         while (e->patternlen) {
 388                 char *slash = strrchr(e->pattern, '/');
 389                 char *oldpattern = e->pattern;
 390                 size_t newlen;
 391
 392                 if (slash == e->pattern)
 393                         break;
 394
 395                 newlen = slash - e->pattern;
 396                 e = xmalloc(sizeof(struct pattern_entry));
 397                 e->patternlen = newlen;
 398                 e->pattern = xstrndup(oldpattern, newlen);
 399                 hashmap_entry_init(&e->ent, fspathhash(e->pattern));
 400
 401                 if (!hashmap_get_entry(&pl->parent_hashmap, e, ent, NULL))
 402                         hashmap_add(&pl->parent_hashmap, &e->ent);
 403         }
 404 }
 405
 406 static void strbuf_to_cone_pattern(struct strbuf *line, struct pattern_list *pl)
 407 {
 408         strbuf_trim(line);
 409
 410         strbuf_trim_trailing_dir_sep(line);
 411
 412         if (strbuf_normalize_path(line))
 413                 die(_("could not normalize path %s"), line->buf);
 414
 415         if (!line->len)
 416                 return;
 417
 418         if (line->buf[0] != '/')
 419                 strbuf_insertstr(line, 0, "/");
 420
 421         insert_recursive_pattern(pl, line);
 422 }
 423
 424 static char const * const builtin_sparse_checkout_set_usage[] = {
 425         N_("git sparse-checkout (set|add) (--stdin | <patterns>)"),
 426         NULL
 427 };
 428
 429 static struct sparse_checkout_set_opts {
 430         int use_stdin;
 431 } set_opts;
 432
 433 static void add_patterns_from_input(struct pattern_list *pl,
 434                                     int argc, const char **argv)
 435 {
 436         int i;
 437         if (core_sparse_checkout_cone) {
 438                 struct strbuf line = STRBUF_INIT;
 439
 440                 hashmap_init(&pl->recursive_hashmap, pl_hashmap_cmp, NULL, 0);
 441                 hashmap_init(&pl->parent_hashmap, pl_hashmap_cmp, NULL, 0);
 442                 pl->use_cone_patterns = 1;
 443
 444                 if (set_opts.use_stdin) {
 445                         struct strbuf unquoted = STRBUF_INIT;
 446                         while (!strbuf_getline(&line, stdin)) {
 447                                 if (line.buf[0] == '"') {
 448                                         strbuf_reset(&unquoted);
 449                                         if (unquote_c_style(&unquoted, line.buf, NULL))
 450                                                 die(_("unable to unquote C-style string '%s'"),
 451                                                 line.buf);
 452
 453                                         strbuf_swap(&unquoted, &line);
 454                                 }
 455
 456                                 strbuf_to_cone_pattern(&line, pl);
 457                         }
 458
 459                         strbuf_release(&unquoted);
 460                 } else {
 461                         for (i = 0; i < argc; i++) {
 462                                 strbuf_setlen(&line, 0);
 463                                 strbuf_addstr(&line, argv[i]);
 464                                 strbuf_to_cone_pattern(&line, pl);
 465                         }
 466                 }
 467         } else {
 468                 if (set_opts.use_stdin) {
 469                         struct strbuf line = STRBUF_INIT;
 470
 471                         while (!strbuf_getline(&line, stdin)) {
 472                                 size_t len;
 473                                 char *buf = strbuf_detach(&line, &len);
 474                                 add_pattern(buf, empty_base, 0, pl, 0);
 475                         }
 476                 } else {
 477                         for (i = 0; i < argc; i++)
 478                                 add_pattern(argv[i], empty_base, 0, pl, 0);
 479                 }
 480         }
 481 }
 482
 483 enum modify_type {
 484         REPLACE,
 485         ADD,
 486 };
 487
 488 static void add_patterns_cone_mode(int argc, const char **argv,
 489                                    struct pattern_list *pl)
 490 {
 491         struct strbuf buffer = STRBUF_INIT;
 492         struct pattern_entry *pe;
 493         struct hashmap_iter iter;
 494         struct pattern_list existing;
 495         char *sparse_filename = get_sparse_checkout_filename();
 496
 497         add_patterns_from_input(pl, argc, argv);
 498
 499         memset(&existing, 0, sizeof(existing));
 500         existing.use_cone_patterns = core_sparse_checkout_cone;
 501
 502         if (add_patterns_from_file_to_list(sparse_filename, "", 0,
 503                                            &existing, NULL, 0))
 504                 die(_("unable to load existing sparse-checkout patterns"));
 505         free(sparse_filename);
 506
 507         hashmap_for_each_entry(&existing.recursive_hashmap, &iter, pe, ent) {
 508                 if (!hashmap_contains_parent(&pl->recursive_hashmap,
 509                                         pe->pattern, &buffer) ||
 510                     !hashmap_contains_parent(&pl->parent_hashmap,
 511                                         pe->pattern, &buffer)) {
 512                         strbuf_reset(&buffer);
 513                         strbuf_addstr(&buffer, pe->pattern);
 514                         insert_recursive_pattern(pl, &buffer);
 515                 }
 516         }
 517
 518         clear_pattern_list(&existing);
 519         strbuf_release(&buffer);
 520 }
 521
 522 static void add_patterns_literal(int argc, const char **argv,
 523                                  struct pattern_list *pl)
 524 {
 525         char *sparse_filename = get_sparse_checkout_filename();
 526         if (add_patterns_from_file_to_list(sparse_filename, "", 0,
 527                                            pl, NULL, 0))
 528                 die(_("unable to load existing sparse-checkout patterns"));
 529         free(sparse_filename);
 530         add_patterns_from_input(pl, argc, argv);
 531 }
 532
 533 static int modify_pattern_list(int argc, const char **argv, enum modify_type m)
 534 {
 535         int result;
 536         int changed_config = 0;
 537         struct pattern_list *pl = xcalloc(1, sizeof(*pl));
 538
 539         switch (m) {
 540         case ADD:
 541                 if (core_sparse_checkout_cone)
 542                         add_patterns_cone_mode(argc, argv, pl);
 543                 else
 544                         add_patterns_literal(argc, argv, pl);
 545                 break;
 546
 547         case REPLACE:
 548                 add_patterns_from_input(pl, argc, argv);
 549                 break;
 550         }
 551
 552         if (!core_apply_sparse_checkout) {
 553                 set_config(MODE_ALL_PATTERNS);
 554                 core_apply_sparse_checkout = 1;
 555                 changed_config = 1;
 556         }
 557
 558         result = write_patterns_and_update(pl);
 559
 560         if (result && changed_config)
 561                 set_config(MODE_NO_PATTERNS);
 562
 563         clear_pattern_list(pl);
 564         free(pl);
 565         return result;
 566 }
 567
 568 static int sparse_checkout_set(int argc, const char **argv, const char *prefix,
 569                                enum modify_type m)
 570 {
 571         static struct option builtin_sparse_checkout_set_options[] = {
 572                 OPT_BOOL(0, "stdin", &set_opts.use_stdin,
 573                          N_("read patterns from standard in")),
 574                 OPT_END(),
 575         };
 576
 577         repo_read_index(the_repository);
 578
 579         argc = parse_options(argc, argv, prefix,
 580                              builtin_sparse_checkout_set_options,
 581                              builtin_sparse_checkout_set_usage,
 582                              PARSE_OPT_KEEP_UNKNOWN);
 583
 584         return modify_pattern_list(argc, argv, m);
 585 }
 586
 587 static char const * const builtin_sparse_checkout_reapply_usage[] = {
 588         N_("git sparse-checkout reapply"),
 589         NULL
 590 };
 591
 592 static int sparse_checkout_reapply(int argc, const char **argv)
 593 {
 594         static struct option builtin_sparse_checkout_reapply_options[] = {
 595                 OPT_END(),
 596         };
 597
 598         argc = parse_options(argc, argv, NULL,
 599                              builtin_sparse_checkout_reapply_options,
 600                              builtin_sparse_checkout_reapply_usage, 0);
 601
 602         repo_read_index(the_repository);
 603         return update_working_directory(NULL);
 604 }
 605
 606 static char const * const builtin_sparse_checkout_disable_usage[] = {
 607         N_("git sparse-checkout disable"),
 608         NULL
 609 };
 610
 611 static int sparse_checkout_disable(int argc, const char **argv)
 612 {
 613         static struct option builtin_sparse_checkout_disable_options[] = {
 614                 OPT_END(),
 615         };
 616         struct pattern_list pl;
 617         struct strbuf match_all = STRBUF_INIT;
 618
 619         argc = parse_options(argc, argv, NULL,
 620                              builtin_sparse_checkout_disable_options,
 621                              builtin_sparse_checkout_disable_usage, 0);
 622
 623         repo_read_index(the_repository);
 624
 625         memset(&pl, 0, sizeof(pl));
 626         hashmap_init(&pl.recursive_hashmap, pl_hashmap_cmp, NULL, 0);
 627         hashmap_init(&pl.parent_hashmap, pl_hashmap_cmp, NULL, 0);
 628         pl.use_cone_patterns = 0;
 629         core_apply_sparse_checkout = 1;
 630
 631         strbuf_addstr(&match_all, "/*");
 632         add_pattern(strbuf_detach(&match_all, NULL), empty_base, 0, &pl, 0);
 633
 634         prepare_repo_settings(the_repository);
 635         the_repository->settings.sparse_index = 0;
 636
 637         if (update_working_directory(&pl))
 638                 die(_("error while refreshing working directory"));
 639
 640         clear_pattern_list(&pl);
 641         return set_config(MODE_NO_PATTERNS);
 642 }
 643
 644 int cmd_sparse_checkout(int argc, const char **argv, const char *prefix)
 645 {
 646         static struct option builtin_sparse_checkout_options[] = {
 647                 OPT_END(),
 648         };
 649
 650         if (argc == 2 && !strcmp(argv[1], "-h"))
 651                 usage_with_options(builtin_sparse_checkout_usage,
 652                                    builtin_sparse_checkout_options);
 653
 654         argc = parse_options(argc, argv, prefix,
 655                              builtin_sparse_checkout_options,
 656                              builtin_sparse_checkout_usage,
 657                              PARSE_OPT_STOP_AT_NON_OPTION);
 658
 659         git_config(git_default_config, NULL);
 660
 661         if (argc > 0) {
 662                 if (!strcmp(argv[0], "list"))
 663                         return sparse_checkout_list(argc, argv);
 664                 if (!strcmp(argv[0], "init"))
 665                         return sparse_checkout_init(argc, argv);
 666                 if (!strcmp(argv[0], "set"))
 667                         return sparse_checkout_set(argc, argv, prefix, REPLACE);
 668                 if (!strcmp(argv[0], "add"))
 669                         return sparse_checkout_set(argc, argv, prefix, ADD);
 670                 if (!strcmp(argv[0], "reapply"))
 671                         return sparse_checkout_reapply(argc, argv);
 672                 if (!strcmp(argv[0], "disable"))
 673                         return sparse_checkout_disable(argc, argv);
 674         }
 675
 676         usage_with_options(builtin_sparse_checkout_usage,
 677                            builtin_sparse_checkout_options);
 678 }