builtin-ls-files.c

   1 /*
   2  * This merges the file listing in the directory cache index
   3  * with the actual working directory list, and shows different
   4  * combinations of the two.
   5  *
   6  * Copyright (C) Linus Torvalds, 2005
   7  */
   8 #include "cache.h"
   9 #include "quote.h"
  10 #include "dir.h"
  11 #include "builtin.h"
  12 #include "tree.h"
  13
  14 static int abbrev;
  15 static int show_deleted;
  16 static int show_cached;
  17 static int show_others;
  18 static int show_stage;
  19 static int show_unmerged;
  20 static int show_modified;
  21 static int show_killed;
  22 static int show_valid_bit;
  23 static int line_terminator = '\n';
  24
  25 static int prefix_len;
  26 static int prefix_offset;
  27 static const char **pathspec;
  28 static int error_unmatch;
  29 static char *ps_matched;
  30 static const char *with_tree;
  31
  32 static const char *tag_cached = "";
  33 static const char *tag_unmerged = "";
  34 static const char *tag_removed = "";
  35 static const char *tag_other = "";
  36 static const char *tag_killed = "";
  37 static const char *tag_modified = "";
  38
  39
  40 /*
  41  * Match a pathspec against a filename. The first "len" characters
  42  * are the common prefix
  43  */
  44 static int match(const char **spec, char *ps_matched,
  45                  const char *filename, int len)
  46 {
  47         const char *m;
  48
  49         while ((m = *spec++) != NULL) {
  50                 int matchlen = strlen(m + len);
  51
  52                 if (!matchlen)
  53                         goto matched;
  54                 if (!strncmp(m + len, filename + len, matchlen)) {
  55                         if (m[len + matchlen - 1] == '/')
  56                                 goto matched;
  57                         switch (filename[len + matchlen]) {
  58                         case '/': case '\0':
  59                                 goto matched;
  60                         }
  61                 }
  62                 if (!fnmatch(m + len, filename + len, 0))
  63                         goto matched;
  64                 if (ps_matched)
  65                         ps_matched++;
  66                 continue;
  67         matched:
  68                 if (ps_matched)
  69                         *ps_matched = 1;
  70                 return 1;
  71         }
  72         return 0;
  73 }
  74
  75 static void show_dir_entry(const char *tag, struct dir_entry *ent)
  76 {
  77         int len = prefix_len;
  78         int offset = prefix_offset;
  79
  80         if (len >= ent->len)
  81                 die("git-ls-files: internal error - directory entry not superset of prefix");
  82
  83         if (pathspec && !match(pathspec, ps_matched, ent->name, len))
  84                 return;
  85
  86         fputs(tag, stdout);
  87         write_name_quoted("", 0, ent->name + offset, line_terminator, stdout);
  88         putchar(line_terminator);
  89 }
  90
  91 static void show_other_files(struct dir_struct *dir)
  92 {
  93         int i;
  94
  95
  96         /*
  97          * Skip matching and unmerged entries for the paths,
  98          * since we want just "others".
  99          *
 100          * (Matching entries are normally pruned during
 101          * the directory tree walk, but will show up for
 102          * gitlinks because we don't necessarily have
 103          * dir->show_other_directories set to suppress
 104          * them).
 105          */
 106         for (i = 0; i < dir->nr; i++) {
 107                 struct dir_entry *ent = dir->entries[i];
 108                 int len, pos;
 109                 struct cache_entry *ce;
 110
 111                 /*
 112                  * Remove the '/' at the end that directory
 113                  * walking adds for directory entries.
 114                  */
 115                 len = ent->len;
 116                 if (len && ent->name[len-1] == '/')
 117                         len--;
 118                 pos = cache_name_pos(ent->name, len);
 119                 if (0 <= pos)
 120                         continue;       /* exact match */
 121                 pos = -pos - 1;
 122                 if (pos < active_nr) {
 123                         ce = active_cache[pos];
 124                         if (ce_namelen(ce) == len &&
 125                             !memcmp(ce->name, ent->name, len))
 126                                 continue; /* Yup, this one exists unmerged */
 127                 }
 128                 show_dir_entry(tag_other, ent);
 129         }
 130 }
 131
 132 static void show_killed_files(struct dir_struct *dir)
 133 {
 134         int i;
 135         for (i = 0; i < dir->nr; i++) {
 136                 struct dir_entry *ent = dir->entries[i];
 137                 char *cp, *sp;
 138                 int pos, len, killed = 0;
 139
 140                 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
 141                         sp = strchr(cp, '/');
 142                         if (!sp) {
 143                                 /* If ent->name is prefix of an entry in the
 144                                  * cache, it will be killed.
 145                                  */
 146                                 pos = cache_name_pos(ent->name, ent->len);
 147                                 if (0 <= pos)
 148                                         die("bug in show-killed-files");
 149                                 pos = -pos - 1;
 150                                 while (pos < active_nr &&
 151                                        ce_stage(active_cache[pos]))
 152                                         pos++; /* skip unmerged */
 153                                 if (active_nr <= pos)
 154                                         break;
 155                                 /* pos points at a name immediately after
 156                                  * ent->name in the cache.  Does it expect
 157                                  * ent->name to be a directory?
 158                                  */
 159                                 len = ce_namelen(active_cache[pos]);
 160                                 if ((ent->len < len) &&
 161                                     !strncmp(active_cache[pos]->name,
 162                                              ent->name, ent->len) &&
 163                                     active_cache[pos]->name[ent->len] == '/')
 164                                         killed = 1;
 165                                 break;
 166                         }
 167                         if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
 168                                 /* If any of the leading directories in
 169                                  * ent->name is registered in the cache,
 170                                  * ent->name will be killed.
 171                                  */
 172                                 killed = 1;
 173                                 break;
 174                         }
 175                 }
 176                 if (killed)
 177                         show_dir_entry(tag_killed, dir->entries[i]);
 178         }
 179 }
 180
 181 static void show_ce_entry(const char *tag, struct cache_entry *ce)
 182 {
 183         int len = prefix_len;
 184         int offset = prefix_offset;
 185
 186         if (len >= ce_namelen(ce))
 187                 die("git-ls-files: internal error - cache entry not superset of prefix");
 188
 189         if (pathspec && !match(pathspec, ps_matched, ce->name, len))
 190                 return;
 191
 192         if (tag && *tag && show_valid_bit &&
 193             (ce->ce_flags & htons(CE_VALID))) {
 194                 static char alttag[4];
 195                 memcpy(alttag, tag, 3);
 196                 if (isalpha(tag[0]))
 197                         alttag[0] = tolower(tag[0]);
 198                 else if (tag[0] == '?')
 199                         alttag[0] = '!';
 200                 else {
 201                         alttag[0] = 'v';
 202                         alttag[1] = tag[0];
 203                         alttag[2] = ' ';
 204                         alttag[3] = 0;
 205                 }
 206                 tag = alttag;
 207         }
 208
 209         if (!show_stage) {
 210                 fputs(tag, stdout);
 211                 write_name_quoted("", 0, ce->name + offset,
 212                                   line_terminator, stdout);
 213                 putchar(line_terminator);
 214         }
 215         else {
 216                 printf("%s%06o %s %d\t",
 217                        tag,
 218                        ntohl(ce->ce_mode),
 219                        abbrev ? find_unique_abbrev(ce->sha1,abbrev)
 220                                 : sha1_to_hex(ce->sha1),
 221                        ce_stage(ce));
 222                 write_name_quoted("", 0, ce->name + offset,
 223                                   line_terminator, stdout);
 224                 putchar(line_terminator);
 225         }
 226 }
 227
 228 static void show_files(struct dir_struct *dir, const char *prefix)
 229 {
 230         int i;
 231
 232         /* For cached/deleted files we don't need to even do the readdir */
 233         if (show_others || show_killed) {
 234                 const char *path = ".", *base = "";
 235                 int baselen = prefix_len;
 236
 237                 if (baselen)
 238                         path = base = prefix;
 239                 read_directory(dir, path, base, baselen, pathspec);
 240                 if (show_others)
 241                         show_other_files(dir);
 242                 if (show_killed)
 243                         show_killed_files(dir);
 244         }
 245         if (show_cached | show_stage) {
 246                 for (i = 0; i < active_nr; i++) {
 247                         struct cache_entry *ce = active_cache[i];
 248                         if (excluded(dir, ce->name) != dir->show_ignored)
 249                                 continue;
 250                         if (show_unmerged && !ce_stage(ce))
 251                                 continue;
 252                         if (ce->ce_flags & htons(CE_UPDATE))
 253                                 continue;
 254                         show_ce_entry(ce_stage(ce) ? tag_unmerged : tag_cached, ce);
 255                 }
 256         }
 257         if (show_deleted | show_modified) {
 258                 for (i = 0; i < active_nr; i++) {
 259                         struct cache_entry *ce = active_cache[i];
 260                         struct stat st;
 261                         int err;
 262                         if (excluded(dir, ce->name) != dir->show_ignored)
 263                                 continue;
 264                         err = lstat(ce->name, &st);
 265                         if (show_deleted && err)
 266                                 show_ce_entry(tag_removed, ce);
 267                         if (show_modified && ce_modified(ce, &st, 0))
 268                                 show_ce_entry(tag_modified, ce);
 269                 }
 270         }
 271 }
 272
 273 /*
 274  * Prune the index to only contain stuff starting with "prefix"
 275  */
 276 static void prune_cache(const char *prefix)
 277 {
 278         int pos = cache_name_pos(prefix, prefix_len);
 279         unsigned int first, last;
 280
 281         if (pos < 0)
 282                 pos = -pos-1;
 283         memmove(active_cache, active_cache + pos,
 284                 (active_nr - pos) * sizeof(struct cache_entry *));
 285         active_nr -= pos;
 286         first = 0;
 287         last = active_nr;
 288         while (last > first) {
 289                 int next = (last + first) >> 1;
 290                 struct cache_entry *ce = active_cache[next];
 291                 if (!strncmp(ce->name, prefix, prefix_len)) {
 292                         first = next+1;
 293                         continue;
 294                 }
 295                 last = next;
 296         }
 297         active_nr = last;
 298 }
 299
 300 static const char *verify_pathspec(const char *prefix)
 301 {
 302         const char **p, *n, *prev;
 303         char *real_prefix;
 304         unsigned long max;
 305
 306         prev = NULL;
 307         max = PATH_MAX;
 308         for (p = pathspec; (n = *p) != NULL; p++) {
 309                 int i, len = 0;
 310                 for (i = 0; i < max; i++) {
 311                         char c = n[i];
 312                         if (prev && prev[i] != c)
 313                                 break;
 314                         if (!c || c == '*' || c == '?')
 315                                 break;
 316                         if (c == '/')
 317                                 len = i+1;
 318                 }
 319                 prev = n;
 320                 if (len < max) {
 321                         max = len;
 322                         if (!max)
 323                                 break;
 324                 }
 325         }
 326
 327         if (prefix_offset > max || memcmp(prev, prefix, prefix_offset))
 328                 die("git-ls-files: cannot generate relative filenames containing '..'");
 329
 330         real_prefix = NULL;
 331         prefix_len = max;
 332         if (max) {
 333                 real_prefix = xmalloc(max + 1);
 334                 memcpy(real_prefix, prev, max);
 335                 real_prefix[max] = 0;
 336         }
 337         return real_prefix;
 338 }
 339
 340 /*
 341  * Read the tree specified with --with-tree option
 342  * (typically, HEAD) into stage #1 and then
 343  * squash them down to stage #0.  This is used for
 344  * --error-unmatch to list and check the path patterns
 345  * that were given from the command line.  We are not
 346  * going to write this index out.
 347  */
 348 static void overlay_tree(const char *tree_name, const char *prefix)
 349 {
 350         struct tree *tree;
 351         unsigned char sha1[20];
 352         const char **match;
 353         struct cache_entry *last_stage0 = NULL;
 354         int i;
 355
 356         if (get_sha1(tree_name, sha1))
 357                 die("tree-ish %s not found.", tree_name);
 358         tree = parse_tree_indirect(sha1);
 359         if (!tree)
 360                 die("bad tree-ish %s", tree_name);
 361
 362         /* Hoist the unmerged entries up to stage #3 to make room */
 363         for (i = 0; i < active_nr; i++) {
 364                 struct cache_entry *ce = active_cache[i];
 365                 if (!ce_stage(ce))
 366                         continue;
 367                 ce->ce_flags |= htons(CE_STAGEMASK);
 368         }
 369
 370         if (prefix) {
 371                 static const char *(matchbuf[2]);
 372                 matchbuf[0] = prefix;
 373                 matchbuf [1] = NULL;
 374                 match = matchbuf;
 375         } else
 376                 match = NULL;
 377         if (read_tree(tree, 1, match))
 378                 die("unable to read tree entries %s", tree_name);
 379
 380         for (i = 0; i < active_nr; i++) {
 381                 struct cache_entry *ce = active_cache[i];
 382                 switch (ce_stage(ce)) {
 383                 case 0:
 384                         last_stage0 = ce;
 385                         /* fallthru */
 386                 default:
 387                         continue;
 388                 case 1:
 389                         /*
 390                          * If there is stage #0 entry for this, we do not
 391                          * need to show it.  We use CE_UPDATE bit to mark
 392                          * such an entry.
 393                          */
 394                         if (last_stage0 &&
 395                             !strcmp(last_stage0->name, ce->name))
 396                                 ce->ce_flags |= htons(CE_UPDATE);
 397                 }
 398         }
 399 }
 400
 401 static const char ls_files_usage[] =
 402         "git-ls-files [-z] [-t] [-v] (--[cached|deleted|others|stage|unmerged|killed|modified])* "
 403         "[ --ignored ] [--exclude=<pattern>] [--exclude-from=<file>] "
 404         "[ --exclude-per-directory=<filename> ] [--full-name] [--abbrev] "
 405         "[--] [<file>]*";
 406
 407 int cmd_ls_files(int argc, const char **argv, const char *prefix)
 408 {
 409         int i;
 410         int exc_given = 0, require_work_tree = 0;
 411         struct dir_struct dir;
 412
 413         memset(&dir, 0, sizeof(dir));
 414         if (prefix)
 415                 prefix_offset = strlen(prefix);
 416         git_config(git_default_config);
 417
 418         for (i = 1; i < argc; i++) {
 419                 const char *arg = argv[i];
 420
 421                 if (!strcmp(arg, "--")) {
 422                         i++;
 423                         break;
 424                 }
 425                 if (!strcmp(arg, "-z")) {
 426                         line_terminator = 0;
 427                         continue;
 428                 }
 429                 if (!strcmp(arg, "-t") || !strcmp(arg, "-v")) {
 430                         tag_cached = "H ";
 431                         tag_unmerged = "M ";
 432                         tag_removed = "R ";
 433                         tag_modified = "C ";
 434                         tag_other = "? ";
 435                         tag_killed = "K ";
 436                         if (arg[1] == 'v')
 437                                 show_valid_bit = 1;
 438                         continue;
 439                 }
 440                 if (!strcmp(arg, "-c") || !strcmp(arg, "--cached")) {
 441                         show_cached = 1;
 442                         continue;
 443                 }
 444                 if (!strcmp(arg, "-d") || !strcmp(arg, "--deleted")) {
 445                         show_deleted = 1;
 446                         continue;
 447                 }
 448                 if (!strcmp(arg, "-m") || !strcmp(arg, "--modified")) {
 449                         show_modified = 1;
 450                         require_work_tree = 1;
 451                         continue;
 452                 }
 453                 if (!strcmp(arg, "-o") || !strcmp(arg, "--others")) {
 454                         show_others = 1;
 455                         require_work_tree = 1;
 456                         continue;
 457                 }
 458                 if (!strcmp(arg, "-i") || !strcmp(arg, "--ignored")) {
 459                         dir.show_ignored = 1;
 460                         require_work_tree = 1;
 461                         continue;
 462                 }
 463                 if (!strcmp(arg, "-s") || !strcmp(arg, "--stage")) {
 464                         show_stage = 1;
 465                         continue;
 466                 }
 467                 if (!strcmp(arg, "-k") || !strcmp(arg, "--killed")) {
 468                         show_killed = 1;
 469                         require_work_tree = 1;
 470                         continue;
 471                 }
 472                 if (!strcmp(arg, "--directory")) {
 473                         dir.show_other_directories = 1;
 474                         continue;
 475                 }
 476                 if (!strcmp(arg, "--no-empty-directory")) {
 477                         dir.hide_empty_directories = 1;
 478                         continue;
 479                 }
 480                 if (!strcmp(arg, "-u") || !strcmp(arg, "--unmerged")) {
 481                         /* There's no point in showing unmerged unless
 482                          * you also show the stage information.
 483                          */
 484                         show_stage = 1;
 485                         show_unmerged = 1;
 486                         continue;
 487                 }
 488                 if (!strcmp(arg, "-x") && i+1 < argc) {
 489                         exc_given = 1;
 490                         add_exclude(argv[++i], "", 0, &dir.exclude_list[EXC_CMDL]);
 491                         continue;
 492                 }
 493                 if (!prefixcmp(arg, "--exclude=")) {
 494                         exc_given = 1;
 495                         add_exclude(arg+10, "", 0, &dir.exclude_list[EXC_CMDL]);
 496                         continue;
 497                 }
 498                 if (!strcmp(arg, "-X") && i+1 < argc) {
 499                         exc_given = 1;
 500                         add_excludes_from_file(&dir, argv[++i]);
 501                         continue;
 502                 }
 503                 if (!prefixcmp(arg, "--exclude-from=")) {
 504                         exc_given = 1;
 505                         add_excludes_from_file(&dir, arg+15);
 506                         continue;
 507                 }
 508                 if (!prefixcmp(arg, "--exclude-per-directory=")) {
 509                         exc_given = 1;
 510                         dir.exclude_per_dir = arg + 24;
 511                         continue;
 512                 }
 513                 if (!strcmp(arg, "--full-name")) {
 514                         prefix_offset = 0;
 515                         continue;
 516                 }
 517                 if (!strcmp(arg, "--error-unmatch")) {
 518                         error_unmatch = 1;
 519                         continue;
 520                 }
 521                 if (!prefixcmp(arg, "--with-tree=")) {
 522                         with_tree = arg + 12;
 523                         continue;
 524                 }
 525                 if (!prefixcmp(arg, "--abbrev=")) {
 526                         abbrev = strtoul(arg+9, NULL, 10);
 527                         if (abbrev && abbrev < MINIMUM_ABBREV)
 528                                 abbrev = MINIMUM_ABBREV;
 529                         else if (abbrev > 40)
 530                                 abbrev = 40;
 531                         continue;
 532                 }
 533                 if (!strcmp(arg, "--abbrev")) {
 534                         abbrev = DEFAULT_ABBREV;
 535                         continue;
 536                 }
 537                 if (*arg == '-')
 538                         usage(ls_files_usage);
 539                 break;
 540         }
 541
 542         if (require_work_tree && !is_inside_work_tree()) {
 543                 const char *work_tree = get_git_work_tree();
 544                 if (!work_tree || chdir(work_tree))
 545                         die("This operation must be run in a work tree");
 546         }
 547
 548         pathspec = get_pathspec(prefix, argv + i);
 549
 550         /* Verify that the pathspec matches the prefix */
 551         if (pathspec)
 552                 prefix = verify_pathspec(prefix);
 553
 554         /* Treat unmatching pathspec elements as errors */
 555         if (pathspec && error_unmatch) {
 556                 int num;
 557                 for (num = 0; pathspec[num]; num++)
 558                         ;
 559                 ps_matched = xcalloc(1, num);
 560         }
 561
 562         if (dir.show_ignored && !exc_given) {
 563                 fprintf(stderr, "%s: --ignored needs some exclude pattern\n",
 564                         argv[0]);
 565                 exit(1);
 566         }
 567
 568         /* With no flags, we default to showing the cached files */
 569         if (!(show_stage | show_deleted | show_others | show_unmerged |
 570               show_killed | show_modified))
 571                 show_cached = 1;
 572
 573         read_cache();
 574         if (prefix)
 575                 prune_cache(prefix);
 576         if (with_tree) {
 577                 /*
 578                  * Basic sanity check; show-stages and show-unmerged
 579                  * would not make any sense with this option.
 580                  */
 581                 if (show_stage || show_unmerged)
 582                         die("ls-files --with-tree is incompatible with -s or -u");
 583                 overlay_tree(with_tree, prefix);
 584         }
 585         show_files(&dir, prefix);
 586
 587         if (ps_matched) {
 588                 /* We need to make sure all pathspec matched otherwise
 589                  * it is an error.
 590                  */
 591                 int num, errors = 0;
 592                 for (num = 0; pathspec[num]; num++) {
 593                         int other, found_dup;
 594
 595                         if (ps_matched[num])
 596                                 continue;
 597                         /*
 598                          * The caller might have fed identical pathspec
 599                          * twice.  Do not barf on such a mistake.
 600                          */
 601                         for (found_dup = other = 0;
 602                              !found_dup && pathspec[other];
 603                              other++) {
 604                                 if (other == num || !ps_matched[other])
 605                                         continue;
 606                                 if (!strcmp(pathspec[other], pathspec[num]))
 607                                         /*
 608                                          * Ok, we have a match already.
 609                                          */
 610                                         found_dup = 1;
 611                         }
 612                         if (found_dup)
 613                                 continue;
 614
 615                         error("pathspec '%s' did not match any file(s) known to git.",
 616                               pathspec[num] + prefix_offset);
 617                         errors++;
 618                 }
 619
 620                 if (errors)
 621                         fprintf(stderr, "Did you forget to 'git add'?\n");
 622
 623                 return errors ? 1 : 0;
 624         }
 625
 626         return 0;
 627 }