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