2 * This handles recursive filename detection with exclude
3 * files, index knowledge etc..
5 * See Documentation/technical/api-directory-listing.txt
7 * Copyright (C) Linus Torvalds, 2005-2006
8 * Junio Hamano, 2005-2006
13 #include "wildmatch.h"
16 struct path_simplify {
22 * Tells read_directory_recursive how a file or directory should be treated.
23 * Values are ordered by significance, e.g. if a directory contains both
24 * excluded and untracked files, it is listed as untracked because
25 * path_untracked > path_excluded.
34 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
35 const char *path, int len,
36 int check_only, const struct path_simplify *simplify);
37 static int get_dtype(struct dirent *de, const char *path, int len);
39 /* helper string functions with support for the ignore_case flag */
40 int strcmp_icase(const char *a, const char *b)
42 return ignore_case ? strcasecmp(a, b) : strcmp(a, b);
45 int strncmp_icase(const char *a, const char *b, size_t count)
47 return ignore_case ? strncasecmp(a, b, count) : strncmp(a, b, count);
50 int fnmatch_icase(const char *pattern, const char *string, int flags)
52 return fnmatch(pattern, string, flags | (ignore_case ? FNM_CASEFOLD : 0));
55 inline int git_fnmatch(const char *pattern, const char *string,
56 int flags, int prefix)
59 if (flags & GFNM_PATHNAME)
60 fnm_flags |= FNM_PATHNAME;
62 if (strncmp(pattern, string, prefix))
67 if (flags & GFNM_ONESTAR) {
68 int pattern_len = strlen(++pattern);
69 int string_len = strlen(string);
70 return string_len < pattern_len ||
72 string + string_len - pattern_len);
74 return fnmatch(pattern, string, fnm_flags);
77 static int fnmatch_icase_mem(const char *pattern, int patternlen,
78 const char *string, int stringlen,
82 struct strbuf pat_buf = STRBUF_INIT;
83 struct strbuf str_buf = STRBUF_INIT;
84 const char *use_pat = pattern;
85 const char *use_str = string;
87 if (pattern[patternlen]) {
88 strbuf_add(&pat_buf, pattern, patternlen);
89 use_pat = pat_buf.buf;
91 if (string[stringlen]) {
92 strbuf_add(&str_buf, string, stringlen);
93 use_str = str_buf.buf;
98 match_status = wildmatch(use_pat, use_str, flags, NULL);
100 strbuf_release(&pat_buf);
101 strbuf_release(&str_buf);
106 static size_t common_prefix_len(const struct pathspec *pathspec)
111 GUARD_PATHSPEC(pathspec, PATHSPEC_FROMTOP | PATHSPEC_MAXDEPTH);
113 for (n = 0; n < pathspec->nr; n++) {
114 size_t i = 0, len = 0;
115 while (i < pathspec->items[n].nowildcard_len &&
116 (n == 0 || i < max)) {
117 char c = pathspec->items[n].match[i];
118 if (c != pathspec->items[0].match[i])
124 if (n == 0 || len < max) {
134 * Returns a copy of the longest leading path common among all
137 char *common_prefix(const struct pathspec *pathspec)
139 unsigned long len = common_prefix_len(pathspec);
141 return len ? xmemdupz(pathspec->items[0].match, len) : NULL;
144 int fill_directory(struct dir_struct *dir, const struct pathspec *pathspec)
149 * Calculate common prefix for the pathspec, and
150 * use that to optimize the directory walk
152 len = common_prefix_len(pathspec);
154 /* Read the directory and prune it */
155 read_directory(dir, pathspec->nr ? pathspec->raw[0] : "", len, pathspec);
159 int within_depth(const char *name, int namelen,
160 int depth, int max_depth)
162 const char *cp = name, *cpe = name + namelen;
168 if (depth > max_depth)
175 * Does 'match' match the given name?
176 * A match is found if
178 * (1) the 'match' string is leading directory of 'name', or
179 * (2) the 'match' string is a wildcard and matches 'name', or
180 * (3) the 'match' string is exactly the same as 'name'.
182 * and the return value tells which case it was.
184 * It returns 0 when there is no match.
186 static int match_pathspec_item(const struct pathspec_item *item, int prefix,
187 const char *name, int namelen)
189 /* name/namelen has prefix cut off by caller */
190 const char *match = item->match + prefix;
191 int matchlen = item->len - prefix;
193 /* If the match was just the prefix, we matched */
195 return MATCHED_RECURSIVELY;
197 if (matchlen <= namelen && !strncmp(match, name, matchlen)) {
198 if (matchlen == namelen)
199 return MATCHED_EXACTLY;
201 if (match[matchlen-1] == '/' || name[matchlen] == '/')
202 return MATCHED_RECURSIVELY;
205 if (item->nowildcard_len < item->len &&
206 !git_fnmatch(match, name,
207 item->flags & PATHSPEC_ONESTAR ? GFNM_ONESTAR : 0,
208 item->nowildcard_len - prefix))
209 return MATCHED_FNMATCH;
215 * Given a name and a list of pathspecs, returns the nature of the
216 * closest (i.e. most specific) match of the name to any of the
219 * The caller typically calls this multiple times with the same
220 * pathspec and seen[] array but with different name/namelen
221 * (e.g. entries from the index) and is interested in seeing if and
222 * how each pathspec matches all the names it calls this function
223 * with. A mark is left in the seen[] array for each pathspec element
224 * indicating the closest type of match that element achieved, so if
225 * seen[n] remains zero after multiple invocations, that means the nth
226 * pathspec did not match any names, which could indicate that the
227 * user mistyped the nth pathspec.
229 int match_pathspec_depth(const struct pathspec *ps,
230 const char *name, int namelen,
231 int prefix, char *seen)
235 GUARD_PATHSPEC(ps, PATHSPEC_FROMTOP | PATHSPEC_MAXDEPTH);
238 if (!ps->recursive ||
239 !(ps->magic & PATHSPEC_MAXDEPTH) ||
241 return MATCHED_RECURSIVELY;
243 if (within_depth(name, namelen, 0, ps->max_depth))
244 return MATCHED_EXACTLY;
252 for (i = ps->nr - 1; i >= 0; i--) {
254 if (seen && seen[i] == MATCHED_EXACTLY)
256 how = match_pathspec_item(ps->items+i, prefix, name, namelen);
258 (ps->magic & PATHSPEC_MAXDEPTH) &&
259 ps->max_depth != -1 &&
260 how && how != MATCHED_FNMATCH) {
261 int len = ps->items[i].len;
262 if (name[len] == '/')
264 if (within_depth(name+len, namelen-len, 0, ps->max_depth))
265 how = MATCHED_EXACTLY;
272 if (seen && seen[i] < how)
280 * Return the length of the "simple" part of a path match limiter.
282 int simple_length(const char *match)
287 unsigned char c = *match++;
289 if (c == '\0' || is_glob_special(c))
294 int no_wildcard(const char *string)
296 return string[simple_length(string)] == '\0';
299 void parse_exclude_pattern(const char **pattern,
304 const char *p = *pattern;
309 *flags |= EXC_FLAG_NEGATIVE;
313 if (len && p[len - 1] == '/') {
315 *flags |= EXC_FLAG_MUSTBEDIR;
317 for (i = 0; i < len; i++) {
322 *flags |= EXC_FLAG_NODIR;
323 *nowildcardlen = simple_length(p);
325 * we should have excluded the trailing slash from 'p' too,
326 * but that's one more allocation. Instead just make sure
327 * nowildcardlen does not exceed real patternlen
329 if (*nowildcardlen > len)
330 *nowildcardlen = len;
331 if (*p == '*' && no_wildcard(p + 1))
332 *flags |= EXC_FLAG_ENDSWITH;
337 void add_exclude(const char *string, const char *base,
338 int baselen, struct exclude_list *el, int srcpos)
345 parse_exclude_pattern(&string, &patternlen, &flags, &nowildcardlen);
346 if (flags & EXC_FLAG_MUSTBEDIR) {
348 x = xmalloc(sizeof(*x) + patternlen + 1);
350 memcpy(s, string, patternlen);
351 s[patternlen] = '\0';
354 x = xmalloc(sizeof(*x));
357 x->patternlen = patternlen;
358 x->nowildcardlen = nowildcardlen;
360 x->baselen = baselen;
363 ALLOC_GROW(el->excludes, el->nr + 1, el->alloc);
364 el->excludes[el->nr++] = x;
368 static void *read_skip_worktree_file_from_index(const char *path, size_t *size)
372 enum object_type type;
374 struct index_state *istate = &the_index;
377 pos = index_name_pos(istate, path, len);
380 if (!ce_skip_worktree(istate->cache[pos]))
382 data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
383 if (!data || type != OBJ_BLOB) {
392 * Frees memory within el which was allocated for exclude patterns and
393 * the file buffer. Does not free el itself.
395 void clear_exclude_list(struct exclude_list *el)
399 for (i = 0; i < el->nr; i++)
400 free(el->excludes[i]);
409 int add_excludes_from_file_to_list(const char *fname,
412 struct exclude_list *el,
416 int fd, i, lineno = 1;
420 fd = open(fname, O_RDONLY);
421 if (fd < 0 || fstat(fd, &st) < 0) {
423 warn_on_inaccessible(fname);
427 (buf = read_skip_worktree_file_from_index(fname, &size)) == NULL)
433 if (buf[size-1] != '\n') {
434 buf = xrealloc(buf, size+1);
439 size = xsize_t(st.st_size);
444 buf = xmalloc(size+1);
445 if (read_in_full(fd, buf, size) != size) {
456 for (i = 0; i < size; i++) {
457 if (buf[i] == '\n') {
458 if (entry != buf + i && entry[0] != '#') {
459 buf[i - (i && buf[i-1] == '\r')] = 0;
460 add_exclude(entry, base, baselen, el, lineno);
469 struct exclude_list *add_exclude_list(struct dir_struct *dir,
470 int group_type, const char *src)
472 struct exclude_list *el;
473 struct exclude_list_group *group;
475 group = &dir->exclude_list_group[group_type];
476 ALLOC_GROW(group->el, group->nr + 1, group->alloc);
477 el = &group->el[group->nr++];
478 memset(el, 0, sizeof(*el));
484 * Used to set up core.excludesfile and .git/info/exclude lists.
486 void add_excludes_from_file(struct dir_struct *dir, const char *fname)
488 struct exclude_list *el;
489 el = add_exclude_list(dir, EXC_FILE, fname);
490 if (add_excludes_from_file_to_list(fname, "", 0, el, 0) < 0)
491 die("cannot use %s as an exclude file", fname);
494 int match_basename(const char *basename, int basenamelen,
495 const char *pattern, int prefix, int patternlen,
498 if (prefix == patternlen) {
499 if (patternlen == basenamelen &&
500 !strncmp_icase(pattern, basename, basenamelen))
502 } else if (flags & EXC_FLAG_ENDSWITH) {
503 /* "*literal" matching against "fooliteral" */
504 if (patternlen - 1 <= basenamelen &&
505 !strncmp_icase(pattern + 1,
506 basename + basenamelen - (patternlen - 1),
510 if (fnmatch_icase_mem(pattern, patternlen,
511 basename, basenamelen,
518 int match_pathname(const char *pathname, int pathlen,
519 const char *base, int baselen,
520 const char *pattern, int prefix, int patternlen,
527 * match with FNM_PATHNAME; the pattern has base implicitly
530 if (*pattern == '/') {
537 * baselen does not count the trailing slash. base[] may or
538 * may not end with a trailing slash though.
540 if (pathlen < baselen + 1 ||
541 (baselen && pathname[baselen] != '/') ||
542 strncmp_icase(pathname, base, baselen))
545 namelen = baselen ? pathlen - baselen - 1 : pathlen;
546 name = pathname + pathlen - namelen;
550 * if the non-wildcard part is longer than the
551 * remaining pathname, surely it cannot match.
553 if (prefix > namelen)
556 if (strncmp_icase(pattern, name, prefix))
559 patternlen -= prefix;
564 * If the whole pattern did not have a wildcard,
565 * then our prefix match is all we need; we
566 * do not need to call fnmatch at all.
568 if (!patternlen && !namelen)
572 return fnmatch_icase_mem(pattern, patternlen,
578 * Scan the given exclude list in reverse to see whether pathname
579 * should be ignored. The first match (i.e. the last on the list), if
580 * any, determines the fate. Returns the exclude_list element which
581 * matched, or NULL for undecided.
583 static struct exclude *last_exclude_matching_from_list(const char *pathname,
585 const char *basename,
587 struct exclude_list *el)
592 return NULL; /* undefined */
594 for (i = el->nr - 1; 0 <= i; i--) {
595 struct exclude *x = el->excludes[i];
596 const char *exclude = x->pattern;
597 int prefix = x->nowildcardlen;
599 if (x->flags & EXC_FLAG_MUSTBEDIR) {
600 if (*dtype == DT_UNKNOWN)
601 *dtype = get_dtype(NULL, pathname, pathlen);
602 if (*dtype != DT_DIR)
606 if (x->flags & EXC_FLAG_NODIR) {
607 if (match_basename(basename,
608 pathlen - (basename - pathname),
609 exclude, prefix, x->patternlen,
615 assert(x->baselen == 0 || x->base[x->baselen - 1] == '/');
616 if (match_pathname(pathname, pathlen,
617 x->base, x->baselen ? x->baselen - 1 : 0,
618 exclude, prefix, x->patternlen, x->flags))
621 return NULL; /* undecided */
625 * Scan the list and let the last match determine the fate.
626 * Return 1 for exclude, 0 for include and -1 for undecided.
628 int is_excluded_from_list(const char *pathname,
629 int pathlen, const char *basename, int *dtype,
630 struct exclude_list *el)
632 struct exclude *exclude;
633 exclude = last_exclude_matching_from_list(pathname, pathlen, basename, dtype, el);
635 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
636 return -1; /* undecided */
639 static struct exclude *last_exclude_matching_from_lists(struct dir_struct *dir,
640 const char *pathname, int pathlen, const char *basename,
644 struct exclude_list_group *group;
645 struct exclude *exclude;
646 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
647 group = &dir->exclude_list_group[i];
648 for (j = group->nr - 1; j >= 0; j--) {
649 exclude = last_exclude_matching_from_list(
650 pathname, pathlen, basename, dtype_p,
660 * Loads the per-directory exclude list for the substring of base
661 * which has a char length of baselen.
663 static void prep_exclude(struct dir_struct *dir, const char *base, int baselen)
665 struct exclude_list_group *group;
666 struct exclude_list *el;
667 struct exclude_stack *stk = NULL;
670 group = &dir->exclude_list_group[EXC_DIRS];
672 /* Pop the exclude lists from the EXCL_DIRS exclude_list_group
673 * which originate from directories not in the prefix of the
674 * path being checked. */
675 while ((stk = dir->exclude_stack) != NULL) {
676 if (stk->baselen <= baselen &&
677 !strncmp(dir->basebuf, base, stk->baselen))
679 el = &group->el[dir->exclude_stack->exclude_ix];
680 dir->exclude_stack = stk->prev;
682 free((char *)el->src); /* see strdup() below */
683 clear_exclude_list(el);
688 /* Skip traversing into sub directories if the parent is excluded */
692 /* Read from the parent directories and push them down. */
693 current = stk ? stk->baselen : -1;
694 while (current < baselen) {
695 struct exclude_stack *stk = xcalloc(1, sizeof(*stk));
703 cp = strchr(base + current + 1, '/');
705 die("oops in prep_exclude");
708 stk->prev = dir->exclude_stack;
709 stk->baselen = cp - base;
710 stk->exclude_ix = group->nr;
711 el = add_exclude_list(dir, EXC_DIRS, NULL);
712 memcpy(dir->basebuf + current, base + current,
713 stk->baselen - current);
715 /* Abort if the directory is excluded */
718 dir->basebuf[stk->baselen - 1] = 0;
719 dir->exclude = last_exclude_matching_from_lists(dir,
720 dir->basebuf, stk->baselen - 1,
721 dir->basebuf + current, &dt);
722 dir->basebuf[stk->baselen - 1] = '/';
724 dir->exclude->flags & EXC_FLAG_NEGATIVE)
727 dir->basebuf[stk->baselen] = 0;
728 dir->exclude_stack = stk;
733 /* Try to read per-directory file unless path is too long */
734 if (dir->exclude_per_dir &&
735 stk->baselen + strlen(dir->exclude_per_dir) < PATH_MAX) {
736 strcpy(dir->basebuf + stk->baselen,
737 dir->exclude_per_dir);
739 * dir->basebuf gets reused by the traversal, but we
740 * need fname to remain unchanged to ensure the src
741 * member of each struct exclude correctly
742 * back-references its source file. Other invocations
743 * of add_exclude_list provide stable strings, so we
744 * strdup() and free() here in the caller.
746 el->src = strdup(dir->basebuf);
747 add_excludes_from_file_to_list(dir->basebuf,
748 dir->basebuf, stk->baselen, el, 1);
750 dir->exclude_stack = stk;
751 current = stk->baselen;
753 dir->basebuf[baselen] = '\0';
757 * Loads the exclude lists for the directory containing pathname, then
758 * scans all exclude lists to determine whether pathname is excluded.
759 * Returns the exclude_list element which matched, or NULL for
762 struct exclude *last_exclude_matching(struct dir_struct *dir,
763 const char *pathname,
766 int pathlen = strlen(pathname);
767 const char *basename = strrchr(pathname, '/');
768 basename = (basename) ? basename+1 : pathname;
770 prep_exclude(dir, pathname, basename-pathname);
775 return last_exclude_matching_from_lists(dir, pathname, pathlen,
780 * Loads the exclude lists for the directory containing pathname, then
781 * scans all exclude lists to determine whether pathname is excluded.
782 * Returns 1 if true, otherwise 0.
784 int is_excluded(struct dir_struct *dir, const char *pathname, int *dtype_p)
786 struct exclude *exclude =
787 last_exclude_matching(dir, pathname, dtype_p);
789 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
793 static struct dir_entry *dir_entry_new(const char *pathname, int len)
795 struct dir_entry *ent;
797 ent = xmalloc(sizeof(*ent) + len + 1);
799 memcpy(ent->name, pathname, len);
804 static struct dir_entry *dir_add_name(struct dir_struct *dir, const char *pathname, int len)
806 if (cache_name_exists(pathname, len, ignore_case))
809 ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
810 return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
813 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len)
815 if (!cache_name_is_other(pathname, len))
818 ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
819 return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
823 index_nonexistent = 0,
829 * Do not use the alphabetically stored index to look up
830 * the directory name; instead, use the case insensitive
833 static enum exist_status directory_exists_in_index_icase(const char *dirname, int len)
835 struct cache_entry *ce = index_name_exists(&the_index, dirname, len + 1, ignore_case);
836 unsigned char endchar;
839 return index_nonexistent;
840 endchar = ce->name[len];
843 * The cache_entry structure returned will contain this dirname
844 * and possibly additional path components.
847 return index_directory;
850 * If there are no additional path components, then this cache_entry
851 * represents a submodule. Submodules, despite being directories,
852 * are stored in the cache without a closing slash.
854 if (!endchar && S_ISGITLINK(ce->ce_mode))
857 /* This should never be hit, but it exists just in case. */
858 return index_nonexistent;
862 * The index sorts alphabetically by entry name, which
863 * means that a gitlink sorts as '\0' at the end, while
864 * a directory (which is defined not as an entry, but as
865 * the files it contains) will sort with the '/' at the
868 static enum exist_status directory_exists_in_index(const char *dirname, int len)
873 return directory_exists_in_index_icase(dirname, len);
875 pos = cache_name_pos(dirname, len);
878 while (pos < active_nr) {
879 struct cache_entry *ce = active_cache[pos++];
880 unsigned char endchar;
882 if (strncmp(ce->name, dirname, len))
884 endchar = ce->name[len];
888 return index_directory;
889 if (!endchar && S_ISGITLINK(ce->ce_mode))
892 return index_nonexistent;
896 * When we find a directory when traversing the filesystem, we
897 * have three distinct cases:
900 * - see it as a directory
903 * and which one we choose depends on a combination of existing
904 * git index contents and the flags passed into the directory
907 * Case 1: If we *already* have entries in the index under that
908 * directory name, we always recurse into the directory to see
911 * Case 2: If we *already* have that directory name as a gitlink,
912 * we always continue to see it as a gitlink, regardless of whether
913 * there is an actual git directory there or not (it might not
914 * be checked out as a subproject!)
916 * Case 3: if we didn't have it in the index previously, we
917 * have a few sub-cases:
919 * (a) if "show_other_directories" is true, we show it as
920 * just a directory, unless "hide_empty_directories" is
921 * also true, in which case we need to check if it contains any
922 * untracked and / or ignored files.
923 * (b) if it looks like a git directory, and we don't have
924 * 'no_gitlinks' set we treat it as a gitlink, and show it
926 * (c) otherwise, we recurse into it.
928 static enum path_treatment treat_directory(struct dir_struct *dir,
929 const char *dirname, int len, int exclude,
930 const struct path_simplify *simplify)
932 /* The "len-1" is to strip the final '/' */
933 switch (directory_exists_in_index(dirname, len-1)) {
934 case index_directory:
940 case index_nonexistent:
941 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
943 if (!(dir->flags & DIR_NO_GITLINKS)) {
944 unsigned char sha1[20];
945 if (resolve_gitlink_ref(dirname, "HEAD", sha1) == 0)
946 return path_untracked;
951 /* This is the "show_other_directories" case */
953 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
954 return exclude ? path_excluded : path_untracked;
956 return read_directory_recursive(dir, dirname, len, 1, simplify);
960 * This is an inexact early pruning of any recursive directory
961 * reading - if the path cannot possibly be in the pathspec,
962 * return true, and we'll skip it early.
964 static int simplify_away(const char *path, int pathlen, const struct path_simplify *simplify)
968 const char *match = simplify->path;
969 int len = simplify->len;
975 if (!memcmp(path, match, len))
985 * This function tells us whether an excluded path matches a
986 * list of "interesting" pathspecs. That is, whether a path matched
987 * by any of the pathspecs could possibly be ignored by excluding
988 * the specified path. This can happen if:
990 * 1. the path is mentioned explicitly in the pathspec
992 * 2. the path is a directory prefix of some element in the
995 static int exclude_matches_pathspec(const char *path, int len,
996 const struct path_simplify *simplify)
999 for (; simplify->path; simplify++) {
1000 if (len == simplify->len
1001 && !memcmp(path, simplify->path, len))
1003 if (len < simplify->len
1004 && simplify->path[len] == '/'
1005 && !memcmp(path, simplify->path, len))
1012 static int get_index_dtype(const char *path, int len)
1015 struct cache_entry *ce;
1017 ce = cache_name_exists(path, len, 0);
1019 if (!ce_uptodate(ce))
1021 if (S_ISGITLINK(ce->ce_mode))
1024 * Nobody actually cares about the
1025 * difference between DT_LNK and DT_REG
1030 /* Try to look it up as a directory */
1031 pos = cache_name_pos(path, len);
1035 while (pos < active_nr) {
1036 ce = active_cache[pos++];
1037 if (strncmp(ce->name, path, len))
1039 if (ce->name[len] > '/')
1041 if (ce->name[len] < '/')
1043 if (!ce_uptodate(ce))
1044 break; /* continue? */
1050 static int get_dtype(struct dirent *de, const char *path, int len)
1052 int dtype = de ? DTYPE(de) : DT_UNKNOWN;
1055 if (dtype != DT_UNKNOWN)
1057 dtype = get_index_dtype(path, len);
1058 if (dtype != DT_UNKNOWN)
1060 if (lstat(path, &st))
1062 if (S_ISREG(st.st_mode))
1064 if (S_ISDIR(st.st_mode))
1066 if (S_ISLNK(st.st_mode))
1071 static enum path_treatment treat_one_path(struct dir_struct *dir,
1072 struct strbuf *path,
1073 const struct path_simplify *simplify,
1074 int dtype, struct dirent *de)
1077 if (dtype == DT_UNKNOWN)
1078 dtype = get_dtype(de, path->buf, path->len);
1080 /* Always exclude indexed files */
1081 if (dtype != DT_DIR &&
1082 cache_name_exists(path->buf, path->len, ignore_case))
1085 exclude = is_excluded(dir, path->buf, &dtype);
1088 * Excluded? If we don't explicitly want to show
1089 * ignored files, ignore it
1091 if (exclude && !(dir->flags & (DIR_SHOW_IGNORED|DIR_SHOW_IGNORED_TOO)))
1092 return path_excluded;
1098 strbuf_addch(path, '/');
1099 return treat_directory(dir, path->buf, path->len, exclude,
1103 return exclude ? path_excluded : path_untracked;
1107 static enum path_treatment treat_path(struct dir_struct *dir,
1109 struct strbuf *path,
1111 const struct path_simplify *simplify)
1115 if (is_dot_or_dotdot(de->d_name) || !strcmp(de->d_name, ".git"))
1117 strbuf_setlen(path, baselen);
1118 strbuf_addstr(path, de->d_name);
1119 if (simplify_away(path->buf, path->len, simplify))
1123 return treat_one_path(dir, path, simplify, dtype, de);
1127 * Read a directory tree. We currently ignore anything but
1128 * directories, regular files and symlinks. That's because git
1129 * doesn't handle them at all yet. Maybe that will change some
1132 * Also, we ignore the name ".git" (even if it is not a directory).
1133 * That likely will not change.
1135 * Returns the most significant path_treatment value encountered in the scan.
1137 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
1138 const char *base, int baselen,
1140 const struct path_simplify *simplify)
1143 enum path_treatment state, subdir_state, dir_state = path_none;
1145 struct strbuf path = STRBUF_INIT;
1147 strbuf_add(&path, base, baselen);
1149 fdir = opendir(path.len ? path.buf : ".");
1153 while ((de = readdir(fdir)) != NULL) {
1154 /* check how the file or directory should be treated */
1155 state = treat_path(dir, de, &path, baselen, simplify);
1156 if (state > dir_state)
1159 /* recurse into subdir if instructed by treat_path */
1160 if (state == path_recurse) {
1161 subdir_state = read_directory_recursive(dir, path.buf,
1162 path.len, check_only, simplify);
1163 if (subdir_state > dir_state)
1164 dir_state = subdir_state;
1168 /* abort early if maximum state has been reached */
1169 if (dir_state == path_untracked)
1171 /* skip the dir_add_* part */
1175 /* add the path to the appropriate result list */
1178 if (dir->flags & DIR_SHOW_IGNORED)
1179 dir_add_name(dir, path.buf, path.len);
1180 else if ((dir->flags & DIR_SHOW_IGNORED_TOO) ||
1181 ((dir->flags & DIR_COLLECT_IGNORED) &&
1182 exclude_matches_pathspec(path.buf, path.len,
1184 dir_add_ignored(dir, path.buf, path.len);
1187 case path_untracked:
1188 if (!(dir->flags & DIR_SHOW_IGNORED))
1189 dir_add_name(dir, path.buf, path.len);
1198 strbuf_release(&path);
1203 static int cmp_name(const void *p1, const void *p2)
1205 const struct dir_entry *e1 = *(const struct dir_entry **)p1;
1206 const struct dir_entry *e2 = *(const struct dir_entry **)p2;
1208 return cache_name_compare(e1->name, e1->len,
1212 static struct path_simplify *create_simplify(const char **pathspec)
1215 struct path_simplify *simplify = NULL;
1220 for (nr = 0 ; ; nr++) {
1223 alloc = alloc_nr(alloc);
1224 simplify = xrealloc(simplify, alloc * sizeof(*simplify));
1226 match = *pathspec++;
1229 simplify[nr].path = match;
1230 simplify[nr].len = simple_length(match);
1232 simplify[nr].path = NULL;
1233 simplify[nr].len = 0;
1237 static void free_simplify(struct path_simplify *simplify)
1242 static int treat_leading_path(struct dir_struct *dir,
1243 const char *path, int len,
1244 const struct path_simplify *simplify)
1246 struct strbuf sb = STRBUF_INIT;
1247 int baselen, rc = 0;
1249 int old_flags = dir->flags;
1251 while (len && path[len - 1] == '/')
1256 dir->flags &= ~DIR_SHOW_OTHER_DIRECTORIES;
1258 cp = path + baselen + !!baselen;
1259 cp = memchr(cp, '/', path + len - cp);
1263 baselen = cp - path;
1264 strbuf_setlen(&sb, 0);
1265 strbuf_add(&sb, path, baselen);
1266 if (!is_directory(sb.buf))
1268 if (simplify_away(sb.buf, sb.len, simplify))
1270 if (treat_one_path(dir, &sb, simplify,
1271 DT_DIR, NULL) == path_none)
1272 break; /* do not recurse into it */
1273 if (len <= baselen) {
1275 break; /* finished checking */
1278 strbuf_release(&sb);
1279 dir->flags = old_flags;
1283 int read_directory(struct dir_struct *dir, const char *path, int len, const struct pathspec *pathspec)
1285 struct path_simplify *simplify;
1288 * Check out create_simplify()
1291 GUARD_PATHSPEC(pathspec, PATHSPEC_FROMTOP | PATHSPEC_MAXDEPTH);
1293 if (has_symlink_leading_path(path, len))
1296 simplify = create_simplify(pathspec ? pathspec->raw : NULL);
1297 if (!len || treat_leading_path(dir, path, len, simplify))
1298 read_directory_recursive(dir, path, len, 0, simplify);
1299 free_simplify(simplify);
1300 qsort(dir->entries, dir->nr, sizeof(struct dir_entry *), cmp_name);
1301 qsort(dir->ignored, dir->ignored_nr, sizeof(struct dir_entry *), cmp_name);
1305 int file_exists(const char *f)
1308 return lstat(f, &sb) == 0;
1312 * Given two normalized paths (a trailing slash is ok), if subdir is
1313 * outside dir, return -1. Otherwise return the offset in subdir that
1314 * can be used as relative path to dir.
1316 int dir_inside_of(const char *subdir, const char *dir)
1320 assert(dir && subdir && *dir && *subdir);
1322 while (*dir && *subdir && *dir == *subdir) {
1328 /* hel[p]/me vs hel[l]/yeah */
1329 if (*dir && *subdir)
1333 return !*dir ? offset : -1; /* same dir */
1335 /* foo/[b]ar vs foo/[] */
1336 if (is_dir_sep(dir[-1]))
1337 return is_dir_sep(subdir[-1]) ? offset : -1;
1339 /* foo[/]bar vs foo[] */
1340 return is_dir_sep(*subdir) ? offset + 1 : -1;
1343 int is_inside_dir(const char *dir)
1348 if (!getcwd(cwd, sizeof(cwd)))
1349 die_errno("can't find the current directory");
1350 return dir_inside_of(cwd, dir) >= 0;
1353 int is_empty_dir(const char *path)
1355 DIR *dir = opendir(path);
1362 while ((e = readdir(dir)) != NULL)
1363 if (!is_dot_or_dotdot(e->d_name)) {
1372 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
1376 int ret = 0, original_len = path->len, len, kept_down = 0;
1377 int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
1378 int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
1379 unsigned char submodule_head[20];
1381 if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
1382 !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
1383 /* Do not descend and nuke a nested git work tree. */
1389 flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
1390 dir = opendir(path->buf);
1392 /* an empty dir could be removed even if it is unreadble */
1394 return rmdir(path->buf);
1398 if (path->buf[original_len - 1] != '/')
1399 strbuf_addch(path, '/');
1402 while ((e = readdir(dir)) != NULL) {
1404 if (is_dot_or_dotdot(e->d_name))
1407 strbuf_setlen(path, len);
1408 strbuf_addstr(path, e->d_name);
1409 if (lstat(path->buf, &st))
1411 else if (S_ISDIR(st.st_mode)) {
1412 if (!remove_dir_recurse(path, flag, &kept_down))
1413 continue; /* happy */
1414 } else if (!only_empty && !unlink(path->buf))
1415 continue; /* happy, too */
1417 /* path too long, stat fails, or non-directory still exists */
1423 strbuf_setlen(path, original_len);
1424 if (!ret && !keep_toplevel && !kept_down)
1425 ret = rmdir(path->buf);
1428 * report the uplevel that it is not an error that we
1429 * did not rmdir() our directory.
1435 int remove_dir_recursively(struct strbuf *path, int flag)
1437 return remove_dir_recurse(path, flag, NULL);
1440 void setup_standard_excludes(struct dir_struct *dir)
1445 dir->exclude_per_dir = ".gitignore";
1446 path = git_path("info/exclude");
1447 if (!excludes_file) {
1448 home_config_paths(NULL, &xdg_path, "ignore");
1449 excludes_file = xdg_path;
1451 if (!access_or_warn(path, R_OK, 0))
1452 add_excludes_from_file(dir, path);
1453 if (excludes_file && !access_or_warn(excludes_file, R_OK, 0))
1454 add_excludes_from_file(dir, excludes_file);
1457 int remove_path(const char *name)
1461 if (unlink(name) && errno != ENOENT && errno != ENOTDIR)
1464 slash = strrchr(name, '/');
1466 char *dirs = xstrdup(name);
1467 slash = dirs + (slash - name);
1470 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
1476 int limit_pathspec_to_literal(void)
1478 static int flag = -1;
1480 flag = git_env_bool(GIT_LITERAL_PATHSPECS_ENVIRONMENT, 0);
1485 * Frees memory within dir which was allocated for exclude lists and
1486 * the exclude_stack. Does not free dir itself.
1488 void clear_directory(struct dir_struct *dir)
1491 struct exclude_list_group *group;
1492 struct exclude_list *el;
1493 struct exclude_stack *stk;
1495 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
1496 group = &dir->exclude_list_group[i];
1497 for (j = 0; j < group->nr; j++) {
1500 free((char *)el->src);
1501 clear_exclude_list(el);
1506 stk = dir->exclude_stack;
1508 struct exclude_stack *prev = stk->prev;