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 <dirent.h>
9#include <fnmatch.h>
10#include "cache.h"
12#include "quote.h"
13static int abbrev = 0;
15static int show_deleted = 0;
16static int show_cached = 0;
17static int show_others = 0;
18static int show_ignored = 0;
19static int show_stage = 0;
20static int show_unmerged = 0;
21static int show_modified = 0;
22static int show_killed = 0;
23static int show_other_directories = 0;
24static int show_valid_bit = 0;
25static int line_terminator = '\n';
26static int prefix_len = 0, prefix_offset = 0;
28static const char *prefix = NULL;
29static const char **pathspec = NULL;
30static int error_unmatch = 0;
31static char *ps_matched = NULL;
32static const char *tag_cached = "";
34static const char *tag_unmerged = "";
35static const char *tag_removed = "";
36static const char *tag_other = "";
37static const char *tag_killed = "";
38static const char *tag_modified = "";
39static const char *exclude_per_dir = NULL;
41/* We maintain three exclude pattern lists:
43 * EXC_CMDL lists patterns explicitly given on the command line.
44 * EXC_DIRS lists patterns obtained from per-directory ignore files.
45 * EXC_FILE lists patterns from fallback ignore files.
46 */
47#define EXC_CMDL 0
48#define EXC_DIRS 1
49#define EXC_FILE 2
50static struct exclude_list {
51 int nr;
52 int alloc;
53 struct exclude {
54 const char *pattern;
55 const char *base;
56 int baselen;
57 } **excludes;
58} exclude_list[3];
59static void add_exclude(const char *string, const char *base,
61 int baselen, struct exclude_list *which)
62{
63 struct exclude *x = xmalloc(sizeof (*x));
64 x->pattern = string;
66 x->base = base;
67 x->baselen = baselen;
68 if (which->nr == which->alloc) {
69 which->alloc = alloc_nr(which->alloc);
70 which->excludes = realloc(which->excludes,
71 which->alloc * sizeof(x));
72 }
73 which->excludes[which->nr++] = x;
74}
75static int add_excludes_from_file_1(const char *fname,
77 const char *base,
78 int baselen,
79 struct exclude_list *which)
80{
81 int fd, i;
82 long size;
83 char *buf, *entry;
84 fd = open(fname, O_RDONLY);
86 if (fd < 0)
87 goto err;
88 size = lseek(fd, 0, SEEK_END);
89 if (size < 0)
90 goto err;
91 lseek(fd, 0, SEEK_SET);
92 if (size == 0) {
93 close(fd);
94 return 0;
95 }
96 buf = xmalloc(size);
97 if (read(fd, buf, size) != size)
98 goto err;
99 close(fd);
100 entry = buf;
102 for (i = 0; i < size; i++) {
103 if (buf[i] == '\n') {
104 if (entry != buf + i && entry[0] != '#') {
105 buf[i - (i && buf[i-1] == '\r')] = 0;
106 add_exclude(entry, base, baselen, which);
107 }
108 entry = buf + i + 1;
109 }
110 }
111 return 0;
112 err:
114 if (0 <= fd)
115 close(fd);
116 return -1;
117}
118static void add_excludes_from_file(const char *fname)
120{
121 if (add_excludes_from_file_1(fname, "", 0,
122 &exclude_list[EXC_FILE]) < 0)
123 die("cannot use %s as an exclude file", fname);
124}
125static int push_exclude_per_directory(const char *base, int baselen)
127{
128 char exclude_file[PATH_MAX];
129 struct exclude_list *el = &exclude_list[EXC_DIRS];
130 int current_nr = el->nr;
131 if (exclude_per_dir) {
133 memcpy(exclude_file, base, baselen);
134 strcpy(exclude_file + baselen, exclude_per_dir);
135 add_excludes_from_file_1(exclude_file, base, baselen, el);
136 }
137 return current_nr;
138}
139static void pop_exclude_per_directory(int stk)
141{
142 struct exclude_list *el = &exclude_list[EXC_DIRS];
143 while (stk < el->nr)
145 free(el->excludes[--el->nr]);
146}
147/* Scan the list and let the last match determines the fate.
149 * Return 1 for exclude, 0 for include and -1 for undecided.
150 */
151static int excluded_1(const char *pathname,
152 int pathlen,
153 struct exclude_list *el)
154{
155 int i;
156 if (el->nr) {
158 for (i = el->nr - 1; 0 <= i; i--) {
159 struct exclude *x = el->excludes[i];
160 const char *exclude = x->pattern;
161 int to_exclude = 1;
162 if (*exclude == '!') {
164 to_exclude = 0;
165 exclude++;
166 }
167 if (!strchr(exclude, '/')) {
169 /* match basename */
170 const char *basename = strrchr(pathname, '/');
171 basename = (basename) ? basename+1 : pathname;
172 if (fnmatch(exclude, basename, 0) == 0)
173 return to_exclude;
174 }
175 else {
176 /* match with FNM_PATHNAME:
177 * exclude has base (baselen long) implicitly
178 * in front of it.
179 */
180 int baselen = x->baselen;
181 if (*exclude == '/')
182 exclude++;
183 if (pathlen < baselen ||
185 (baselen && pathname[baselen-1] != '/') ||
186 strncmp(pathname, x->base, baselen))
187 continue;
188 if (fnmatch(exclude, pathname+baselen,
190 FNM_PATHNAME) == 0)
191 return to_exclude;
192 }
193 }
194 }
195 return -1; /* undecided */
196}
197static int excluded(const char *pathname)
199{
200 int pathlen = strlen(pathname);
201 int st;
202 for (st = EXC_CMDL; st <= EXC_FILE; st++) {
204 switch (excluded_1(pathname, pathlen, &exclude_list[st])) {
205 case 0:
206 return 0;
207 case 1:
208 return 1;
209 }
210 }
211 return 0;
212}
213struct nond_on_fs {
215 int len;
216 char name[FLEX_ARRAY]; /* more */
217};
218static struct nond_on_fs **dir;
220static int nr_dir;
221static int dir_alloc;
222static void add_name(const char *pathname, int len)
224{
225 struct nond_on_fs *ent;
226 if (cache_name_pos(pathname, len) >= 0)
228 return;
229 if (nr_dir == dir_alloc) {
231 dir_alloc = alloc_nr(dir_alloc);
232 dir = xrealloc(dir, dir_alloc*sizeof(ent));
233 }
234 ent = xmalloc(sizeof(*ent) + len + 1);
235 ent->len = len;
236 memcpy(ent->name, pathname, len);
237 ent->name[len] = 0;
238 dir[nr_dir++] = ent;
239}
240static int dir_exists(const char *dirname, int len)
242{
243 int pos = cache_name_pos(dirname, len);
244 if (pos >= 0)
245 return 1;
246 pos = -pos-1;
247 if (pos >= active_nr) /* can't */
248 return 0;
249 return !strncmp(active_cache[pos]->name, dirname, len);
250}
251/*
253 * Read a directory tree. We currently ignore anything but
254 * directories, regular files and symlinks. That's because git
255 * doesn't handle them at all yet. Maybe that will change some
256 * day.
257 *
258 * Also, we ignore the name ".git" (even if it is not a directory).
259 * That likely will not change.
260 */
261static void read_directory(const char *path, const char *base, int baselen)
262{
263 DIR *dir = opendir(path);
264 if (dir) {
266 int exclude_stk;
267 struct dirent *de;
268 char fullname[MAXPATHLEN + 1];
269 memcpy(fullname, base, baselen);
270 exclude_stk = push_exclude_per_directory(base, baselen);
272 while ((de = readdir(dir)) != NULL) {
274 int len;
275 if ((de->d_name[0] == '.') &&
277 (de->d_name[1] == 0 ||
278 !strcmp(de->d_name + 1, ".") ||
279 !strcmp(de->d_name + 1, "git")))
280 continue;
281 len = strlen(de->d_name);
282 memcpy(fullname + baselen, de->d_name, len+1);
283 if (excluded(fullname) != show_ignored) {
284 if (!show_ignored || DTYPE(de) != DT_DIR) {
285 continue;
286 }
287 }
288 switch (DTYPE(de)) {
290 struct stat st;
291 default:
292 continue;
293 case DT_UNKNOWN:
294 if (lstat(fullname, &st))
295 continue;
296 if (S_ISREG(st.st_mode) || S_ISLNK(st.st_mode))
297 break;
298 if (!S_ISDIR(st.st_mode))
299 continue;
300 /* fallthrough */
301 case DT_DIR:
302 memcpy(fullname + baselen + len, "/", 2);
303 len++;
304 if (show_other_directories &&
305 !dir_exists(fullname, baselen + len))
306 break;
307 read_directory(fullname, fullname,
308 baselen + len);
309 continue;
310 case DT_REG:
311 case DT_LNK:
312 break;
313 }
314 add_name(fullname, baselen + len);
315 }
316 closedir(dir);
317 pop_exclude_per_directory(exclude_stk);
319 }
320}
321static int cmp_name(const void *p1, const void *p2)
323{
324 const struct nond_on_fs *e1 = *(const struct nond_on_fs **)p1;
325 const struct nond_on_fs *e2 = *(const struct nond_on_fs **)p2;
326 return cache_name_compare(e1->name, e1->len,
328 e2->name, e2->len);
329}
330/*
332 * Match a pathspec against a filename. The first "len" characters
333 * are the common prefix
334 */
335static int match(const char **spec, char *ps_matched,
336 const char *filename, int len)
337{
338 const char *m;
339 while ((m = *spec++) != NULL) {
341 int matchlen = strlen(m + len);
342 if (!matchlen)
344 goto matched;
345 if (!strncmp(m + len, filename + len, matchlen)) {
346 if (m[len + matchlen - 1] == '/')
347 goto matched;
348 switch (filename[len + matchlen]) {
349 case '/': case '\0':
350 goto matched;
351 }
352 }
353 if (!fnmatch(m + len, filename + len, 0))
354 goto matched;
355 if (ps_matched)
356 ps_matched++;
357 continue;
358 matched:
359 if (ps_matched)
360 *ps_matched = 1;
361 return 1;
362 }
363 return 0;
364}
365static void show_dir_entry(const char *tag, struct nond_on_fs *ent)
367{
368 int len = prefix_len;
369 int offset = prefix_offset;
370 if (len >= ent->len)
372 die("git-ls-files: internal error - directory entry not superset of prefix");
373 if (pathspec && !match(pathspec, ps_matched, ent->name, len))
375 return;
376 fputs(tag, stdout);
378 write_name_quoted("", 0, ent->name + offset, line_terminator, stdout);
379 putchar(line_terminator);
380}
381static void show_other_files(void)
383{
384 int i;
385 for (i = 0; i < nr_dir; i++) {
386 /* We should not have a matching entry, but we
387 * may have an unmerged entry for this path.
388 */
389 struct nond_on_fs *ent = dir[i];
390 int pos = cache_name_pos(ent->name, ent->len);
391 struct cache_entry *ce;
392 if (0 <= pos)
393 die("bug in show-other-files");
394 pos = -pos - 1;
395 if (pos < active_nr) {
396 ce = active_cache[pos];
397 if (ce_namelen(ce) == ent->len &&
398 !memcmp(ce->name, ent->name, ent->len))
399 continue; /* Yup, this one exists unmerged */
400 }
401 show_dir_entry(tag_other, ent);
402 }
403}
404static void show_killed_files(void)
406{
407 int i;
408 for (i = 0; i < nr_dir; i++) {
409 struct nond_on_fs *ent = dir[i];
410 char *cp, *sp;
411 int pos, len, killed = 0;
412 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
414 sp = strchr(cp, '/');
415 if (!sp) {
416 /* If ent->name is prefix of an entry in the
417 * cache, it will be killed.
418 */
419 pos = cache_name_pos(ent->name, ent->len);
420 if (0 <= pos)
421 die("bug in show-killed-files");
422 pos = -pos - 1;
423 while (pos < active_nr &&
424 ce_stage(active_cache[pos]))
425 pos++; /* skip unmerged */
426 if (active_nr <= pos)
427 break;
428 /* pos points at a name immediately after
429 * ent->name in the cache. Does it expect
430 * ent->name to be a directory?
431 */
432 len = ce_namelen(active_cache[pos]);
433 if ((ent->len < len) &&
434 !strncmp(active_cache[pos]->name,
435 ent->name, ent->len) &&
436 active_cache[pos]->name[ent->len] == '/')
437 killed = 1;
438 break;
439 }
440 if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
441 /* If any of the leading directories in
442 * ent->name is registered in the cache,
443 * ent->name will be killed.
444 */
445 killed = 1;
446 break;
447 }
448 }
449 if (killed)
450 show_dir_entry(tag_killed, dir[i]);
451 }
452}
453static void show_ce_entry(const char *tag, struct cache_entry *ce)
455{
456 int len = prefix_len;
457 int offset = prefix_offset;
458 if (len >= ce_namelen(ce))
460 die("git-ls-files: internal error - cache entry not superset of prefix");
461 if (pathspec && !match(pathspec, ps_matched, ce->name, len))
463 return;
464 if (tag && *tag && show_valid_bit &&
466 (ce->ce_flags & htons(CE_VALID))) {
467 static char alttag[4];
468 memcpy(alttag, tag, 3);
469 if (isalpha(tag[0]))
470 alttag[0] = tolower(tag[0]);
471 else if (tag[0] == '?')
472 alttag[0] = '!';
473 else {
474 alttag[0] = 'v';
475 alttag[1] = tag[0];
476 alttag[2] = ' ';
477 alttag[3] = 0;
478 }
479 tag = alttag;
480 }
481 if (!show_stage) {
483 fputs(tag, stdout);
484 write_name_quoted("", 0, ce->name + offset,
485 line_terminator, stdout);
486 putchar(line_terminator);
487 }
488 else {
489 printf("%s%06o %s %d\t",
490 tag,
491 ntohl(ce->ce_mode),
492 abbrev ? find_unique_abbrev(ce->sha1,abbrev)
493 : sha1_to_hex(ce->sha1),
494 ce_stage(ce));
495 write_name_quoted("", 0, ce->name + offset,
496 line_terminator, stdout);
497 putchar(line_terminator);
498 }
499}
500static void show_files(void)
502{
503 int i;
504 /* For cached/deleted files we don't need to even do the readdir */
506 if (show_others || show_killed) {
507 const char *path = ".", *base = "";
508 int baselen = prefix_len;
509 if (baselen) {
511 path = base = prefix;
512 if (exclude_per_dir) {
513 char *p, *pp = xmalloc(baselen+1);
514 memcpy(pp, prefix, baselen+1);
515 p = pp;
516 while (1) {
517 char save = *p;
518 *p = 0;
519 push_exclude_per_directory(pp, p-pp);
520 *p++ = save;
521 if (!save)
522 break;
523 p = strchr(p, '/');
524 if (p)
525 p++;
526 else
527 p = pp + baselen;
528 }
529 free(pp);
530 }
531 }
532 read_directory(path, base, baselen);
533 qsort(dir, nr_dir, sizeof(struct nond_on_fs *), cmp_name);
534 if (show_others)
535 show_other_files();
536 if (show_killed)
537 show_killed_files();
538 }
539 if (show_cached | show_stage) {
540 for (i = 0; i < active_nr; i++) {
541 struct cache_entry *ce = active_cache[i];
542 if (excluded(ce->name) != show_ignored)
543 continue;
544 if (show_unmerged && !ce_stage(ce))
545 continue;
546 show_ce_entry(ce_stage(ce) ? tag_unmerged : tag_cached, ce);
547 }
548 }
549 if (show_deleted | show_modified) {
550 for (i = 0; i < active_nr; i++) {
551 struct cache_entry *ce = active_cache[i];
552 struct stat st;
553 int err;
554 if (excluded(ce->name) != show_ignored)
555 continue;
556 err = lstat(ce->name, &st);
557 if (show_deleted && err)
558 show_ce_entry(tag_removed, ce);
559 if (show_modified && ce_modified(ce, &st, 0))
560 show_ce_entry(tag_modified, ce);
561 }
562 }
563}
564/*
566 * Prune the index to only contain stuff starting with "prefix"
567 */
568static void prune_cache(void)
569{
570 int pos = cache_name_pos(prefix, prefix_len);
571 unsigned int first, last;
572 if (pos < 0)
574 pos = -pos-1;
575 active_cache += pos;
576 active_nr -= pos;
577 first = 0;
578 last = active_nr;
579 while (last > first) {
580 int next = (last + first) >> 1;
581 struct cache_entry *ce = active_cache[next];
582 if (!strncmp(ce->name, prefix, prefix_len)) {
583 first = next+1;
584 continue;
585 }
586 last = next;
587 }
588 active_nr = last;
589}
590static void verify_pathspec(void)
592{
593 const char **p, *n, *prev;
594 char *real_prefix;
595 unsigned long max;
596 prev = NULL;
598 max = PATH_MAX;
599 for (p = pathspec; (n = *p) != NULL; p++) {
600 int i, len = 0;
601 for (i = 0; i < max; i++) {
602 char c = n[i];
603 if (prev && prev[i] != c)
604 break;
605 if (!c || c == '*' || c == '?')
606 break;
607 if (c == '/')
608 len = i+1;
609 }
610 prev = n;
611 if (len < max) {
612 max = len;
613 if (!max)
614 break;
615 }
616 }
617 if (prefix_offset > max || memcmp(prev, prefix, prefix_offset))
619 die("git-ls-files: cannot generate relative filenames containing '..'");
620 real_prefix = NULL;
622 prefix_len = max;
623 if (max) {
624 real_prefix = xmalloc(max + 1);
625 memcpy(real_prefix, prev, max);
626 real_prefix[max] = 0;
627 }
628 prefix = real_prefix;
629}
630static const char ls_files_usage[] =
632 "git-ls-files [-z] [-t] [-v] (--[cached|deleted|others|stage|unmerged|killed|modified])* "
633 "[ --ignored ] [--exclude=<pattern>] [--exclude-from=<file>] "
634 "[ --exclude-per-directory=<filename> ] [--full-name] [--abbrev] "
635 "[--] [<file>]*";
636int main(int argc, const char **argv)
638{
639 int i;
640 int exc_given = 0;
641 prefix = setup_git_directory();
643 if (prefix)
644 prefix_offset = strlen(prefix);
645 git_config(git_default_config);
646 for (i = 1; i < argc; i++) {
648 const char *arg = argv[i];
649 if (!strcmp(arg, "--")) {
651 i++;
652 break;
653 }
654 if (!strcmp(arg, "-z")) {
655 line_terminator = 0;
656 continue;
657 }
658 if (!strcmp(arg, "-t") || !strcmp(arg, "-v")) {
659 tag_cached = "H ";
660 tag_unmerged = "M ";
661 tag_removed = "R ";
662 tag_modified = "C ";
663 tag_other = "? ";
664 tag_killed = "K ";
665 if (arg[1] == 'v')
666 show_valid_bit = 1;
667 continue;
668 }
669 if (!strcmp(arg, "-c") || !strcmp(arg, "--cached")) {
670 show_cached = 1;
671 continue;
672 }
673 if (!strcmp(arg, "-d") || !strcmp(arg, "--deleted")) {
674 show_deleted = 1;
675 continue;
676 }
677 if (!strcmp(arg, "-m") || !strcmp(arg, "--modified")) {
678 show_modified = 1;
679 continue;
680 }
681 if (!strcmp(arg, "-o") || !strcmp(arg, "--others")) {
682 show_others = 1;
683 continue;
684 }
685 if (!strcmp(arg, "-i") || !strcmp(arg, "--ignored")) {
686 show_ignored = 1;
687 continue;
688 }
689 if (!strcmp(arg, "-s") || !strcmp(arg, "--stage")) {
690 show_stage = 1;
691 continue;
692 }
693 if (!strcmp(arg, "-k") || !strcmp(arg, "--killed")) {
694 show_killed = 1;
695 continue;
696 }
697 if (!strcmp(arg, "--directory")) {
698 show_other_directories = 1;
699 continue;
700 }
701 if (!strcmp(arg, "-u") || !strcmp(arg, "--unmerged")) {
702 /* There's no point in showing unmerged unless
703 * you also show the stage information.
704 */
705 show_stage = 1;
706 show_unmerged = 1;
707 continue;
708 }
709 if (!strcmp(arg, "-x") && i+1 < argc) {
710 exc_given = 1;
711 add_exclude(argv[++i], "", 0, &exclude_list[EXC_CMDL]);
712 continue;
713 }
714 if (!strncmp(arg, "--exclude=", 10)) {
715 exc_given = 1;
716 add_exclude(arg+10, "", 0, &exclude_list[EXC_CMDL]);
717 continue;
718 }
719 if (!strcmp(arg, "-X") && i+1 < argc) {
720 exc_given = 1;
721 add_excludes_from_file(argv[++i]);
722 continue;
723 }
724 if (!strncmp(arg, "--exclude-from=", 15)) {
725 exc_given = 1;
726 add_excludes_from_file(arg+15);
727 continue;
728 }
729 if (!strncmp(arg, "--exclude-per-directory=", 24)) {
730 exc_given = 1;
731 exclude_per_dir = arg + 24;
732 continue;
733 }
734 if (!strcmp(arg, "--full-name")) {
735 prefix_offset = 0;
736 continue;
737 }
738 if (!strcmp(arg, "--error-unmatch")) {
739 error_unmatch = 1;
740 continue;
741 }
742 if (!strncmp(arg, "--abbrev=", 9)) {
743 abbrev = strtoul(arg+9, NULL, 10);
744 if (abbrev && abbrev < MINIMUM_ABBREV)
745 abbrev = MINIMUM_ABBREV;
746 else if (abbrev > 40)
747 abbrev = 40;
748 continue;
749 }
750 if (!strcmp(arg, "--abbrev")) {
751 abbrev = DEFAULT_ABBREV;
752 continue;
753 }
754 if (*arg == '-')
755 usage(ls_files_usage);
756 break;
757 }
758 pathspec = get_pathspec(prefix, argv + i);
760 /* Verify that the pathspec matches the prefix */
762 if (pathspec)
763 verify_pathspec();
764 /* Treat unmatching pathspec elements as errors */
766 if (pathspec && error_unmatch) {
767 int num;
768 for (num = 0; pathspec[num]; num++)
769 ;
770 ps_matched = xcalloc(1, num);
771 }
772 if (show_ignored && !exc_given) {
774 fprintf(stderr, "%s: --ignored needs some exclude pattern\n",
775 argv[0]);
776 exit(1);
777 }
778 /* With no flags, we default to showing the cached files */
780 if (!(show_stage | show_deleted | show_others | show_unmerged |
781 show_killed | show_modified))
782 show_cached = 1;
783 read_cache();
785 if (prefix)
786 prune_cache();
787 show_files();
788 if (ps_matched) {
790 /* We need to make sure all pathspec matched otherwise
791 * it is an error.
792 */
793 int num, errors = 0;
794 for (num = 0; pathspec[num]; num++) {
795 if (ps_matched[num])
796 continue;
797 error("pathspec '%s' did not match any.",
798 pathspec[num] + prefix_offset);
799 errors++;
800 }
801 return errors ? 1 : 0;
802 }
803 return 0;
805}