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 struct pathspec_item *item,
56 const char *pattern, const char *string,
60 if (strncmp(pattern, string, prefix))
65 if (item->flags & PATHSPEC_ONESTAR) {
66 int pattern_len = strlen(++pattern);
67 int string_len = strlen(string);
68 return string_len < pattern_len ||
70 string + string_len - pattern_len);
72 if (item->magic & PATHSPEC_GLOB)
73 return wildmatch(pattern, string, WM_PATHNAME, NULL);
75 /* wildmatch has not learned no FNM_PATHNAME mode yet */
76 return fnmatch(pattern, string, 0);
79 static int fnmatch_icase_mem(const char *pattern, int patternlen,
80 const char *string, int stringlen,
84 struct strbuf pat_buf = STRBUF_INIT;
85 struct strbuf str_buf = STRBUF_INIT;
86 const char *use_pat = pattern;
87 const char *use_str = string;
89 if (pattern[patternlen]) {
90 strbuf_add(&pat_buf, pattern, patternlen);
91 use_pat = pat_buf.buf;
93 if (string[stringlen]) {
94 strbuf_add(&str_buf, string, stringlen);
95 use_str = str_buf.buf;
100 match_status = wildmatch(use_pat, use_str, flags, NULL);
102 strbuf_release(&pat_buf);
103 strbuf_release(&str_buf);
108 static size_t common_prefix_len(const struct pathspec *pathspec)
113 GUARD_PATHSPEC(pathspec,
119 for (n = 0; n < pathspec->nr; n++) {
120 size_t i = 0, len = 0;
121 while (i < pathspec->items[n].nowildcard_len &&
122 (n == 0 || i < max)) {
123 char c = pathspec->items[n].match[i];
124 if (c != pathspec->items[0].match[i])
130 if (n == 0 || len < max) {
140 * Returns a copy of the longest leading path common among all
143 char *common_prefix(const struct pathspec *pathspec)
145 unsigned long len = common_prefix_len(pathspec);
147 return len ? xmemdupz(pathspec->items[0].match, len) : NULL;
150 int fill_directory(struct dir_struct *dir, const struct pathspec *pathspec)
155 * Calculate common prefix for the pathspec, and
156 * use that to optimize the directory walk
158 len = common_prefix_len(pathspec);
160 /* Read the directory and prune it */
161 read_directory(dir, pathspec->nr ? pathspec->_raw[0] : "", len, pathspec);
165 int within_depth(const char *name, int namelen,
166 int depth, int max_depth)
168 const char *cp = name, *cpe = name + namelen;
174 if (depth > max_depth)
181 * Does 'match' match the given name?
182 * A match is found if
184 * (1) the 'match' string is leading directory of 'name', or
185 * (2) the 'match' string is a wildcard and matches 'name', or
186 * (3) the 'match' string is exactly the same as 'name'.
188 * and the return value tells which case it was.
190 * It returns 0 when there is no match.
192 static int match_pathspec_item(const struct pathspec_item *item, int prefix,
193 const char *name, int namelen)
195 /* name/namelen has prefix cut off by caller */
196 const char *match = item->match + prefix;
197 int matchlen = item->len - prefix;
199 /* If the match was just the prefix, we matched */
201 return MATCHED_RECURSIVELY;
203 if (matchlen <= namelen && !strncmp(match, name, matchlen)) {
204 if (matchlen == namelen)
205 return MATCHED_EXACTLY;
207 if (match[matchlen-1] == '/' || name[matchlen] == '/')
208 return MATCHED_RECURSIVELY;
211 if (item->nowildcard_len < item->len &&
212 !git_fnmatch(item, match, name,
213 item->nowildcard_len - prefix))
214 return MATCHED_FNMATCH;
220 * Given a name and a list of pathspecs, returns the nature of the
221 * closest (i.e. most specific) match of the name to any of the
224 * The caller typically calls this multiple times with the same
225 * pathspec and seen[] array but with different name/namelen
226 * (e.g. entries from the index) and is interested in seeing if and
227 * how each pathspec matches all the names it calls this function
228 * with. A mark is left in the seen[] array for each pathspec element
229 * indicating the closest type of match that element achieved, so if
230 * seen[n] remains zero after multiple invocations, that means the nth
231 * pathspec did not match any names, which could indicate that the
232 * user mistyped the nth pathspec.
234 int match_pathspec_depth(const struct pathspec *ps,
235 const char *name, int namelen,
236 int prefix, char *seen)
247 if (!ps->recursive ||
248 !(ps->magic & PATHSPEC_MAXDEPTH) ||
250 return MATCHED_RECURSIVELY;
252 if (within_depth(name, namelen, 0, ps->max_depth))
253 return MATCHED_EXACTLY;
261 for (i = ps->nr - 1; i >= 0; i--) {
263 if (seen && seen[i] == MATCHED_EXACTLY)
265 how = match_pathspec_item(ps->items+i, prefix, name, namelen);
267 (ps->magic & PATHSPEC_MAXDEPTH) &&
268 ps->max_depth != -1 &&
269 how && how != MATCHED_FNMATCH) {
270 int len = ps->items[i].len;
271 if (name[len] == '/')
273 if (within_depth(name+len, namelen-len, 0, ps->max_depth))
274 how = MATCHED_EXACTLY;
281 if (seen && seen[i] < how)
289 * Return the length of the "simple" part of a path match limiter.
291 int simple_length(const char *match)
296 unsigned char c = *match++;
298 if (c == '\0' || is_glob_special(c))
303 int no_wildcard(const char *string)
305 return string[simple_length(string)] == '\0';
308 void parse_exclude_pattern(const char **pattern,
313 const char *p = *pattern;
318 *flags |= EXC_FLAG_NEGATIVE;
322 if (len && p[len - 1] == '/') {
324 *flags |= EXC_FLAG_MUSTBEDIR;
326 for (i = 0; i < len; i++) {
331 *flags |= EXC_FLAG_NODIR;
332 *nowildcardlen = simple_length(p);
334 * we should have excluded the trailing slash from 'p' too,
335 * but that's one more allocation. Instead just make sure
336 * nowildcardlen does not exceed real patternlen
338 if (*nowildcardlen > len)
339 *nowildcardlen = len;
340 if (*p == '*' && no_wildcard(p + 1))
341 *flags |= EXC_FLAG_ENDSWITH;
346 void add_exclude(const char *string, const char *base,
347 int baselen, struct exclude_list *el, int srcpos)
354 parse_exclude_pattern(&string, &patternlen, &flags, &nowildcardlen);
355 if (flags & EXC_FLAG_MUSTBEDIR) {
357 x = xmalloc(sizeof(*x) + patternlen + 1);
359 memcpy(s, string, patternlen);
360 s[patternlen] = '\0';
363 x = xmalloc(sizeof(*x));
366 x->patternlen = patternlen;
367 x->nowildcardlen = nowildcardlen;
369 x->baselen = baselen;
372 ALLOC_GROW(el->excludes, el->nr + 1, el->alloc);
373 el->excludes[el->nr++] = x;
377 static void *read_skip_worktree_file_from_index(const char *path, size_t *size)
381 enum object_type type;
383 struct index_state *istate = &the_index;
386 pos = index_name_pos(istate, path, len);
389 if (!ce_skip_worktree(istate->cache[pos]))
391 data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
392 if (!data || type != OBJ_BLOB) {
401 * Frees memory within el which was allocated for exclude patterns and
402 * the file buffer. Does not free el itself.
404 void clear_exclude_list(struct exclude_list *el)
408 for (i = 0; i < el->nr; i++)
409 free(el->excludes[i]);
418 int add_excludes_from_file_to_list(const char *fname,
421 struct exclude_list *el,
425 int fd, i, lineno = 1;
429 fd = open(fname, O_RDONLY);
430 if (fd < 0 || fstat(fd, &st) < 0) {
432 warn_on_inaccessible(fname);
436 (buf = read_skip_worktree_file_from_index(fname, &size)) == NULL)
442 if (buf[size-1] != '\n') {
443 buf = xrealloc(buf, size+1);
448 size = xsize_t(st.st_size);
453 buf = xmalloc(size+1);
454 if (read_in_full(fd, buf, size) != size) {
465 for (i = 0; i < size; i++) {
466 if (buf[i] == '\n') {
467 if (entry != buf + i && entry[0] != '#') {
468 buf[i - (i && buf[i-1] == '\r')] = 0;
469 add_exclude(entry, base, baselen, el, lineno);
478 struct exclude_list *add_exclude_list(struct dir_struct *dir,
479 int group_type, const char *src)
481 struct exclude_list *el;
482 struct exclude_list_group *group;
484 group = &dir->exclude_list_group[group_type];
485 ALLOC_GROW(group->el, group->nr + 1, group->alloc);
486 el = &group->el[group->nr++];
487 memset(el, 0, sizeof(*el));
493 * Used to set up core.excludesfile and .git/info/exclude lists.
495 void add_excludes_from_file(struct dir_struct *dir, const char *fname)
497 struct exclude_list *el;
498 el = add_exclude_list(dir, EXC_FILE, fname);
499 if (add_excludes_from_file_to_list(fname, "", 0, el, 0) < 0)
500 die("cannot use %s as an exclude file", fname);
503 int match_basename(const char *basename, int basenamelen,
504 const char *pattern, int prefix, int patternlen,
507 if (prefix == patternlen) {
508 if (patternlen == basenamelen &&
509 !strncmp_icase(pattern, basename, basenamelen))
511 } else if (flags & EXC_FLAG_ENDSWITH) {
512 /* "*literal" matching against "fooliteral" */
513 if (patternlen - 1 <= basenamelen &&
514 !strncmp_icase(pattern + 1,
515 basename + basenamelen - (patternlen - 1),
519 if (fnmatch_icase_mem(pattern, patternlen,
520 basename, basenamelen,
527 int match_pathname(const char *pathname, int pathlen,
528 const char *base, int baselen,
529 const char *pattern, int prefix, int patternlen,
536 * match with FNM_PATHNAME; the pattern has base implicitly
539 if (*pattern == '/') {
546 * baselen does not count the trailing slash. base[] may or
547 * may not end with a trailing slash though.
549 if (pathlen < baselen + 1 ||
550 (baselen && pathname[baselen] != '/') ||
551 strncmp_icase(pathname, base, baselen))
554 namelen = baselen ? pathlen - baselen - 1 : pathlen;
555 name = pathname + pathlen - namelen;
559 * if the non-wildcard part is longer than the
560 * remaining pathname, surely it cannot match.
562 if (prefix > namelen)
565 if (strncmp_icase(pattern, name, prefix))
568 patternlen -= prefix;
573 * If the whole pattern did not have a wildcard,
574 * then our prefix match is all we need; we
575 * do not need to call fnmatch at all.
577 if (!patternlen && !namelen)
581 return fnmatch_icase_mem(pattern, patternlen,
587 * Scan the given exclude list in reverse to see whether pathname
588 * should be ignored. The first match (i.e. the last on the list), if
589 * any, determines the fate. Returns the exclude_list element which
590 * matched, or NULL for undecided.
592 static struct exclude *last_exclude_matching_from_list(const char *pathname,
594 const char *basename,
596 struct exclude_list *el)
601 return NULL; /* undefined */
603 for (i = el->nr - 1; 0 <= i; i--) {
604 struct exclude *x = el->excludes[i];
605 const char *exclude = x->pattern;
606 int prefix = x->nowildcardlen;
608 if (x->flags & EXC_FLAG_MUSTBEDIR) {
609 if (*dtype == DT_UNKNOWN)
610 *dtype = get_dtype(NULL, pathname, pathlen);
611 if (*dtype != DT_DIR)
615 if (x->flags & EXC_FLAG_NODIR) {
616 if (match_basename(basename,
617 pathlen - (basename - pathname),
618 exclude, prefix, x->patternlen,
624 assert(x->baselen == 0 || x->base[x->baselen - 1] == '/');
625 if (match_pathname(pathname, pathlen,
626 x->base, x->baselen ? x->baselen - 1 : 0,
627 exclude, prefix, x->patternlen, x->flags))
630 return NULL; /* undecided */
634 * Scan the list and let the last match determine the fate.
635 * Return 1 for exclude, 0 for include and -1 for undecided.
637 int is_excluded_from_list(const char *pathname,
638 int pathlen, const char *basename, int *dtype,
639 struct exclude_list *el)
641 struct exclude *exclude;
642 exclude = last_exclude_matching_from_list(pathname, pathlen, basename, dtype, el);
644 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
645 return -1; /* undecided */
648 static struct exclude *last_exclude_matching_from_lists(struct dir_struct *dir,
649 const char *pathname, int pathlen, const char *basename,
653 struct exclude_list_group *group;
654 struct exclude *exclude;
655 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
656 group = &dir->exclude_list_group[i];
657 for (j = group->nr - 1; j >= 0; j--) {
658 exclude = last_exclude_matching_from_list(
659 pathname, pathlen, basename, dtype_p,
669 * Loads the per-directory exclude list for the substring of base
670 * which has a char length of baselen.
672 static void prep_exclude(struct dir_struct *dir, const char *base, int baselen)
674 struct exclude_list_group *group;
675 struct exclude_list *el;
676 struct exclude_stack *stk = NULL;
679 group = &dir->exclude_list_group[EXC_DIRS];
681 /* Pop the exclude lists from the EXCL_DIRS exclude_list_group
682 * which originate from directories not in the prefix of the
683 * path being checked. */
684 while ((stk = dir->exclude_stack) != NULL) {
685 if (stk->baselen <= baselen &&
686 !strncmp(dir->basebuf, base, stk->baselen))
688 el = &group->el[dir->exclude_stack->exclude_ix];
689 dir->exclude_stack = stk->prev;
691 free((char *)el->src); /* see strdup() below */
692 clear_exclude_list(el);
697 /* Skip traversing into sub directories if the parent is excluded */
701 /* Read from the parent directories and push them down. */
702 current = stk ? stk->baselen : -1;
703 while (current < baselen) {
704 struct exclude_stack *stk = xcalloc(1, sizeof(*stk));
712 cp = strchr(base + current + 1, '/');
714 die("oops in prep_exclude");
717 stk->prev = dir->exclude_stack;
718 stk->baselen = cp - base;
719 stk->exclude_ix = group->nr;
720 el = add_exclude_list(dir, EXC_DIRS, NULL);
721 memcpy(dir->basebuf + current, base + current,
722 stk->baselen - current);
724 /* Abort if the directory is excluded */
727 dir->basebuf[stk->baselen - 1] = 0;
728 dir->exclude = last_exclude_matching_from_lists(dir,
729 dir->basebuf, stk->baselen - 1,
730 dir->basebuf + current, &dt);
731 dir->basebuf[stk->baselen - 1] = '/';
733 dir->exclude->flags & EXC_FLAG_NEGATIVE)
736 dir->basebuf[stk->baselen] = 0;
737 dir->exclude_stack = stk;
742 /* Try to read per-directory file unless path is too long */
743 if (dir->exclude_per_dir &&
744 stk->baselen + strlen(dir->exclude_per_dir) < PATH_MAX) {
745 strcpy(dir->basebuf + stk->baselen,
746 dir->exclude_per_dir);
748 * dir->basebuf gets reused by the traversal, but we
749 * need fname to remain unchanged to ensure the src
750 * member of each struct exclude correctly
751 * back-references its source file. Other invocations
752 * of add_exclude_list provide stable strings, so we
753 * strdup() and free() here in the caller.
755 el->src = strdup(dir->basebuf);
756 add_excludes_from_file_to_list(dir->basebuf,
757 dir->basebuf, stk->baselen, el, 1);
759 dir->exclude_stack = stk;
760 current = stk->baselen;
762 dir->basebuf[baselen] = '\0';
766 * Loads the exclude lists for the directory containing pathname, then
767 * scans all exclude lists to determine whether pathname is excluded.
768 * Returns the exclude_list element which matched, or NULL for
771 struct exclude *last_exclude_matching(struct dir_struct *dir,
772 const char *pathname,
775 int pathlen = strlen(pathname);
776 const char *basename = strrchr(pathname, '/');
777 basename = (basename) ? basename+1 : pathname;
779 prep_exclude(dir, pathname, basename-pathname);
784 return last_exclude_matching_from_lists(dir, pathname, pathlen,
789 * Loads the exclude lists for the directory containing pathname, then
790 * scans all exclude lists to determine whether pathname is excluded.
791 * Returns 1 if true, otherwise 0.
793 int is_excluded(struct dir_struct *dir, const char *pathname, int *dtype_p)
795 struct exclude *exclude =
796 last_exclude_matching(dir, pathname, dtype_p);
798 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
802 static struct dir_entry *dir_entry_new(const char *pathname, int len)
804 struct dir_entry *ent;
806 ent = xmalloc(sizeof(*ent) + len + 1);
808 memcpy(ent->name, pathname, len);
813 static struct dir_entry *dir_add_name(struct dir_struct *dir, const char *pathname, int len)
815 if (cache_name_exists(pathname, len, ignore_case))
818 ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
819 return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
822 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len)
824 if (!cache_name_is_other(pathname, len))
827 ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
828 return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
832 index_nonexistent = 0,
838 * Do not use the alphabetically stored index to look up
839 * the directory name; instead, use the case insensitive
842 static enum exist_status directory_exists_in_index_icase(const char *dirname, int len)
844 struct cache_entry *ce = index_name_exists(&the_index, dirname, len + 1, ignore_case);
845 unsigned char endchar;
848 return index_nonexistent;
849 endchar = ce->name[len];
852 * The cache_entry structure returned will contain this dirname
853 * and possibly additional path components.
856 return index_directory;
859 * If there are no additional path components, then this cache_entry
860 * represents a submodule. Submodules, despite being directories,
861 * are stored in the cache without a closing slash.
863 if (!endchar && S_ISGITLINK(ce->ce_mode))
866 /* This should never be hit, but it exists just in case. */
867 return index_nonexistent;
871 * The index sorts alphabetically by entry name, which
872 * means that a gitlink sorts as '\0' at the end, while
873 * a directory (which is defined not as an entry, but as
874 * the files it contains) will sort with the '/' at the
877 static enum exist_status directory_exists_in_index(const char *dirname, int len)
882 return directory_exists_in_index_icase(dirname, len);
884 pos = cache_name_pos(dirname, len);
887 while (pos < active_nr) {
888 struct cache_entry *ce = active_cache[pos++];
889 unsigned char endchar;
891 if (strncmp(ce->name, dirname, len))
893 endchar = ce->name[len];
897 return index_directory;
898 if (!endchar && S_ISGITLINK(ce->ce_mode))
901 return index_nonexistent;
905 * When we find a directory when traversing the filesystem, we
906 * have three distinct cases:
909 * - see it as a directory
912 * and which one we choose depends on a combination of existing
913 * git index contents and the flags passed into the directory
916 * Case 1: If we *already* have entries in the index under that
917 * directory name, we always recurse into the directory to see
920 * Case 2: If we *already* have that directory name as a gitlink,
921 * we always continue to see it as a gitlink, regardless of whether
922 * there is an actual git directory there or not (it might not
923 * be checked out as a subproject!)
925 * Case 3: if we didn't have it in the index previously, we
926 * have a few sub-cases:
928 * (a) if "show_other_directories" is true, we show it as
929 * just a directory, unless "hide_empty_directories" is
930 * also true, in which case we need to check if it contains any
931 * untracked and / or ignored files.
932 * (b) if it looks like a git directory, and we don't have
933 * 'no_gitlinks' set we treat it as a gitlink, and show it
935 * (c) otherwise, we recurse into it.
937 static enum path_treatment treat_directory(struct dir_struct *dir,
938 const char *dirname, int len, int exclude,
939 const struct path_simplify *simplify)
941 /* The "len-1" is to strip the final '/' */
942 switch (directory_exists_in_index(dirname, len-1)) {
943 case index_directory:
949 case index_nonexistent:
950 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
952 if (!(dir->flags & DIR_NO_GITLINKS)) {
953 unsigned char sha1[20];
954 if (resolve_gitlink_ref(dirname, "HEAD", sha1) == 0)
955 return path_untracked;
960 /* This is the "show_other_directories" case */
962 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
963 return exclude ? path_excluded : path_untracked;
965 return read_directory_recursive(dir, dirname, len, 1, simplify);
969 * This is an inexact early pruning of any recursive directory
970 * reading - if the path cannot possibly be in the pathspec,
971 * return true, and we'll skip it early.
973 static int simplify_away(const char *path, int pathlen, const struct path_simplify *simplify)
977 const char *match = simplify->path;
978 int len = simplify->len;
984 if (!memcmp(path, match, len))
994 * This function tells us whether an excluded path matches a
995 * list of "interesting" pathspecs. That is, whether a path matched
996 * by any of the pathspecs could possibly be ignored by excluding
997 * the specified path. This can happen if:
999 * 1. the path is mentioned explicitly in the pathspec
1001 * 2. the path is a directory prefix of some element in the
1004 static int exclude_matches_pathspec(const char *path, int len,
1005 const struct path_simplify *simplify)
1008 for (; simplify->path; simplify++) {
1009 if (len == simplify->len
1010 && !memcmp(path, simplify->path, len))
1012 if (len < simplify->len
1013 && simplify->path[len] == '/'
1014 && !memcmp(path, simplify->path, len))
1021 static int get_index_dtype(const char *path, int len)
1024 struct cache_entry *ce;
1026 ce = cache_name_exists(path, len, 0);
1028 if (!ce_uptodate(ce))
1030 if (S_ISGITLINK(ce->ce_mode))
1033 * Nobody actually cares about the
1034 * difference between DT_LNK and DT_REG
1039 /* Try to look it up as a directory */
1040 pos = cache_name_pos(path, len);
1044 while (pos < active_nr) {
1045 ce = active_cache[pos++];
1046 if (strncmp(ce->name, path, len))
1048 if (ce->name[len] > '/')
1050 if (ce->name[len] < '/')
1052 if (!ce_uptodate(ce))
1053 break; /* continue? */
1059 static int get_dtype(struct dirent *de, const char *path, int len)
1061 int dtype = de ? DTYPE(de) : DT_UNKNOWN;
1064 if (dtype != DT_UNKNOWN)
1066 dtype = get_index_dtype(path, len);
1067 if (dtype != DT_UNKNOWN)
1069 if (lstat(path, &st))
1071 if (S_ISREG(st.st_mode))
1073 if (S_ISDIR(st.st_mode))
1075 if (S_ISLNK(st.st_mode))
1080 static enum path_treatment treat_one_path(struct dir_struct *dir,
1081 struct strbuf *path,
1082 const struct path_simplify *simplify,
1083 int dtype, struct dirent *de)
1086 if (dtype == DT_UNKNOWN)
1087 dtype = get_dtype(de, path->buf, path->len);
1089 /* Always exclude indexed files */
1090 if (dtype != DT_DIR &&
1091 cache_name_exists(path->buf, path->len, ignore_case))
1094 exclude = is_excluded(dir, path->buf, &dtype);
1097 * Excluded? If we don't explicitly want to show
1098 * ignored files, ignore it
1100 if (exclude && !(dir->flags & (DIR_SHOW_IGNORED|DIR_SHOW_IGNORED_TOO)))
1101 return path_excluded;
1107 strbuf_addch(path, '/');
1108 return treat_directory(dir, path->buf, path->len, exclude,
1112 return exclude ? path_excluded : path_untracked;
1116 static enum path_treatment treat_path(struct dir_struct *dir,
1118 struct strbuf *path,
1120 const struct path_simplify *simplify)
1124 if (is_dot_or_dotdot(de->d_name) || !strcmp(de->d_name, ".git"))
1126 strbuf_setlen(path, baselen);
1127 strbuf_addstr(path, de->d_name);
1128 if (simplify_away(path->buf, path->len, simplify))
1132 return treat_one_path(dir, path, simplify, dtype, de);
1136 * Read a directory tree. We currently ignore anything but
1137 * directories, regular files and symlinks. That's because git
1138 * doesn't handle them at all yet. Maybe that will change some
1141 * Also, we ignore the name ".git" (even if it is not a directory).
1142 * That likely will not change.
1144 * Returns the most significant path_treatment value encountered in the scan.
1146 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
1147 const char *base, int baselen,
1149 const struct path_simplify *simplify)
1152 enum path_treatment state, subdir_state, dir_state = path_none;
1154 struct strbuf path = STRBUF_INIT;
1156 strbuf_add(&path, base, baselen);
1158 fdir = opendir(path.len ? path.buf : ".");
1162 while ((de = readdir(fdir)) != NULL) {
1163 /* check how the file or directory should be treated */
1164 state = treat_path(dir, de, &path, baselen, simplify);
1165 if (state > dir_state)
1168 /* recurse into subdir if instructed by treat_path */
1169 if (state == path_recurse) {
1170 subdir_state = read_directory_recursive(dir, path.buf,
1171 path.len, check_only, simplify);
1172 if (subdir_state > dir_state)
1173 dir_state = subdir_state;
1177 /* abort early if maximum state has been reached */
1178 if (dir_state == path_untracked)
1180 /* skip the dir_add_* part */
1184 /* add the path to the appropriate result list */
1187 if (dir->flags & DIR_SHOW_IGNORED)
1188 dir_add_name(dir, path.buf, path.len);
1189 else if ((dir->flags & DIR_SHOW_IGNORED_TOO) ||
1190 ((dir->flags & DIR_COLLECT_IGNORED) &&
1191 exclude_matches_pathspec(path.buf, path.len,
1193 dir_add_ignored(dir, path.buf, path.len);
1196 case path_untracked:
1197 if (!(dir->flags & DIR_SHOW_IGNORED))
1198 dir_add_name(dir, path.buf, path.len);
1207 strbuf_release(&path);
1212 static int cmp_name(const void *p1, const void *p2)
1214 const struct dir_entry *e1 = *(const struct dir_entry **)p1;
1215 const struct dir_entry *e2 = *(const struct dir_entry **)p2;
1217 return cache_name_compare(e1->name, e1->len,
1221 static struct path_simplify *create_simplify(const char **pathspec)
1224 struct path_simplify *simplify = NULL;
1229 for (nr = 0 ; ; nr++) {
1232 alloc = alloc_nr(alloc);
1233 simplify = xrealloc(simplify, alloc * sizeof(*simplify));
1235 match = *pathspec++;
1238 simplify[nr].path = match;
1239 simplify[nr].len = simple_length(match);
1241 simplify[nr].path = NULL;
1242 simplify[nr].len = 0;
1246 static void free_simplify(struct path_simplify *simplify)
1251 static int treat_leading_path(struct dir_struct *dir,
1252 const char *path, int len,
1253 const struct path_simplify *simplify)
1255 struct strbuf sb = STRBUF_INIT;
1256 int baselen, rc = 0;
1258 int old_flags = dir->flags;
1260 while (len && path[len - 1] == '/')
1265 dir->flags &= ~DIR_SHOW_OTHER_DIRECTORIES;
1267 cp = path + baselen + !!baselen;
1268 cp = memchr(cp, '/', path + len - cp);
1272 baselen = cp - path;
1273 strbuf_setlen(&sb, 0);
1274 strbuf_add(&sb, path, baselen);
1275 if (!is_directory(sb.buf))
1277 if (simplify_away(sb.buf, sb.len, simplify))
1279 if (treat_one_path(dir, &sb, simplify,
1280 DT_DIR, NULL) == path_none)
1281 break; /* do not recurse into it */
1282 if (len <= baselen) {
1284 break; /* finished checking */
1287 strbuf_release(&sb);
1288 dir->flags = old_flags;
1292 int read_directory(struct dir_struct *dir, const char *path, int len, const struct pathspec *pathspec)
1294 struct path_simplify *simplify;
1297 * Check out create_simplify()
1300 GUARD_PATHSPEC(pathspec,
1306 if (has_symlink_leading_path(path, len))
1309 simplify = create_simplify(pathspec ? pathspec->_raw : NULL);
1310 if (!len || treat_leading_path(dir, path, len, simplify))
1311 read_directory_recursive(dir, path, len, 0, simplify);
1312 free_simplify(simplify);
1313 qsort(dir->entries, dir->nr, sizeof(struct dir_entry *), cmp_name);
1314 qsort(dir->ignored, dir->ignored_nr, sizeof(struct dir_entry *), cmp_name);
1318 int file_exists(const char *f)
1321 return lstat(f, &sb) == 0;
1325 * Given two normalized paths (a trailing slash is ok), if subdir is
1326 * outside dir, return -1. Otherwise return the offset in subdir that
1327 * can be used as relative path to dir.
1329 int dir_inside_of(const char *subdir, const char *dir)
1333 assert(dir && subdir && *dir && *subdir);
1335 while (*dir && *subdir && *dir == *subdir) {
1341 /* hel[p]/me vs hel[l]/yeah */
1342 if (*dir && *subdir)
1346 return !*dir ? offset : -1; /* same dir */
1348 /* foo/[b]ar vs foo/[] */
1349 if (is_dir_sep(dir[-1]))
1350 return is_dir_sep(subdir[-1]) ? offset : -1;
1352 /* foo[/]bar vs foo[] */
1353 return is_dir_sep(*subdir) ? offset + 1 : -1;
1356 int is_inside_dir(const char *dir)
1361 if (!getcwd(cwd, sizeof(cwd)))
1362 die_errno("can't find the current directory");
1363 return dir_inside_of(cwd, dir) >= 0;
1366 int is_empty_dir(const char *path)
1368 DIR *dir = opendir(path);
1375 while ((e = readdir(dir)) != NULL)
1376 if (!is_dot_or_dotdot(e->d_name)) {
1385 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
1389 int ret = 0, original_len = path->len, len, kept_down = 0;
1390 int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
1391 int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
1392 unsigned char submodule_head[20];
1394 if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
1395 !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
1396 /* Do not descend and nuke a nested git work tree. */
1402 flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
1403 dir = opendir(path->buf);
1405 /* an empty dir could be removed even if it is unreadble */
1407 return rmdir(path->buf);
1411 if (path->buf[original_len - 1] != '/')
1412 strbuf_addch(path, '/');
1415 while ((e = readdir(dir)) != NULL) {
1417 if (is_dot_or_dotdot(e->d_name))
1420 strbuf_setlen(path, len);
1421 strbuf_addstr(path, e->d_name);
1422 if (lstat(path->buf, &st))
1424 else if (S_ISDIR(st.st_mode)) {
1425 if (!remove_dir_recurse(path, flag, &kept_down))
1426 continue; /* happy */
1427 } else if (!only_empty && !unlink(path->buf))
1428 continue; /* happy, too */
1430 /* path too long, stat fails, or non-directory still exists */
1436 strbuf_setlen(path, original_len);
1437 if (!ret && !keep_toplevel && !kept_down)
1438 ret = rmdir(path->buf);
1441 * report the uplevel that it is not an error that we
1442 * did not rmdir() our directory.
1448 int remove_dir_recursively(struct strbuf *path, int flag)
1450 return remove_dir_recurse(path, flag, NULL);
1453 void setup_standard_excludes(struct dir_struct *dir)
1458 dir->exclude_per_dir = ".gitignore";
1459 path = git_path("info/exclude");
1460 if (!excludes_file) {
1461 home_config_paths(NULL, &xdg_path, "ignore");
1462 excludes_file = xdg_path;
1464 if (!access_or_warn(path, R_OK, 0))
1465 add_excludes_from_file(dir, path);
1466 if (excludes_file && !access_or_warn(excludes_file, R_OK, 0))
1467 add_excludes_from_file(dir, excludes_file);
1470 int remove_path(const char *name)
1474 if (unlink(name) && errno != ENOENT && errno != ENOTDIR)
1477 slash = strrchr(name, '/');
1479 char *dirs = xstrdup(name);
1480 slash = dirs + (slash - name);
1483 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
1490 * Frees memory within dir which was allocated for exclude lists and
1491 * the exclude_stack. Does not free dir itself.
1493 void clear_directory(struct dir_struct *dir)
1496 struct exclude_list_group *group;
1497 struct exclude_list *el;
1498 struct exclude_stack *stk;
1500 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
1501 group = &dir->exclude_list_group[i];
1502 for (j = 0; j < group->nr; j++) {
1505 free((char *)el->src);
1506 clear_exclude_list(el);
1511 stk = dir->exclude_stack;
1513 struct exclude_stack *prev = stk->prev;