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_one(const char *match, const char *name, int namelen)
189 int literal = limit_pathspec_to_literal();
191 /* If the match was just the prefix, we matched */
193 return MATCHED_RECURSIVELY;
197 unsigned char c1 = tolower(*match);
198 unsigned char c2 = tolower(*name);
199 if (c1 == '\0' || (!literal && is_glob_special(c1)))
209 unsigned char c1 = *match;
210 unsigned char c2 = *name;
211 if (c1 == '\0' || (!literal && is_glob_special(c1)))
222 * If we don't match the matchstring exactly,
223 * we need to match by fnmatch
225 matchlen = strlen(match);
226 if (strncmp_icase(match, name, matchlen)) {
229 return !fnmatch_icase(match, name, 0) ? MATCHED_FNMATCH : 0;
232 if (namelen == matchlen)
233 return MATCHED_EXACTLY;
234 if (match[matchlen-1] == '/' || name[matchlen] == '/')
235 return MATCHED_RECURSIVELY;
240 * Given a name and a list of pathspecs, returns the nature of the
241 * closest (i.e. most specific) match of the name to any of the
244 * The caller typically calls this multiple times with the same
245 * pathspec and seen[] array but with different name/namelen
246 * (e.g. entries from the index) and is interested in seeing if and
247 * how each pathspec matches all the names it calls this function
248 * with. A mark is left in the seen[] array for each pathspec element
249 * indicating the closest type of match that element achieved, so if
250 * seen[n] remains zero after multiple invocations, that means the nth
251 * pathspec did not match any names, which could indicate that the
252 * user mistyped the nth pathspec.
254 int match_pathspec(const char **pathspec, const char *name, int namelen,
255 int prefix, char *seen)
265 for (i = 0; pathspec[i] != NULL; i++) {
267 const char *match = pathspec[i] + prefix;
268 if (seen && seen[i] == MATCHED_EXACTLY)
270 how = match_one(match, name, namelen);
274 if (seen && seen[i] < how)
282 * Does 'match' match the given name?
283 * A match is found if
285 * (1) the 'match' string is leading directory of 'name', or
286 * (2) the 'match' string is a wildcard and matches 'name', or
287 * (3) the 'match' string is exactly the same as 'name'.
289 * and the return value tells which case it was.
291 * It returns 0 when there is no match.
293 static int match_pathspec_item(const struct pathspec_item *item, int prefix,
294 const char *name, int namelen)
296 /* name/namelen has prefix cut off by caller */
297 const char *match = item->match + prefix;
298 int matchlen = item->len - prefix;
300 /* If the match was just the prefix, we matched */
302 return MATCHED_RECURSIVELY;
304 if (matchlen <= namelen && !strncmp(match, name, matchlen)) {
305 if (matchlen == namelen)
306 return MATCHED_EXACTLY;
308 if (match[matchlen-1] == '/' || name[matchlen] == '/')
309 return MATCHED_RECURSIVELY;
312 if (item->nowildcard_len < item->len &&
313 !git_fnmatch(match, name,
314 item->flags & PATHSPEC_ONESTAR ? GFNM_ONESTAR : 0,
315 item->nowildcard_len - prefix))
316 return MATCHED_FNMATCH;
322 * Given a name and a list of pathspecs, returns the nature of the
323 * closest (i.e. most specific) match of the name to any of the
326 * The caller typically calls this multiple times with the same
327 * pathspec and seen[] array but with different name/namelen
328 * (e.g. entries from the index) and is interested in seeing if and
329 * how each pathspec matches all the names it calls this function
330 * with. A mark is left in the seen[] array for each pathspec element
331 * indicating the closest type of match that element achieved, so if
332 * seen[n] remains zero after multiple invocations, that means the nth
333 * pathspec did not match any names, which could indicate that the
334 * user mistyped the nth pathspec.
336 int match_pathspec_depth(const struct pathspec *ps,
337 const char *name, int namelen,
338 int prefix, char *seen)
342 GUARD_PATHSPEC(ps, PATHSPEC_FROMTOP | PATHSPEC_MAXDEPTH);
345 if (!ps->recursive ||
346 !(ps->magic & PATHSPEC_MAXDEPTH) ||
348 return MATCHED_RECURSIVELY;
350 if (within_depth(name, namelen, 0, ps->max_depth))
351 return MATCHED_EXACTLY;
359 for (i = ps->nr - 1; i >= 0; i--) {
361 if (seen && seen[i] == MATCHED_EXACTLY)
363 how = match_pathspec_item(ps->items+i, prefix, name, namelen);
365 (ps->magic & PATHSPEC_MAXDEPTH) &&
366 ps->max_depth != -1 &&
367 how && how != MATCHED_FNMATCH) {
368 int len = ps->items[i].len;
369 if (name[len] == '/')
371 if (within_depth(name+len, namelen-len, 0, ps->max_depth))
372 how = MATCHED_EXACTLY;
379 if (seen && seen[i] < how)
387 * Return the length of the "simple" part of a path match limiter.
389 int simple_length(const char *match)
394 unsigned char c = *match++;
396 if (c == '\0' || is_glob_special(c))
401 int no_wildcard(const char *string)
403 return string[simple_length(string)] == '\0';
406 void parse_exclude_pattern(const char **pattern,
411 const char *p = *pattern;
416 *flags |= EXC_FLAG_NEGATIVE;
420 if (len && p[len - 1] == '/') {
422 *flags |= EXC_FLAG_MUSTBEDIR;
424 for (i = 0; i < len; i++) {
429 *flags |= EXC_FLAG_NODIR;
430 *nowildcardlen = simple_length(p);
432 * we should have excluded the trailing slash from 'p' too,
433 * but that's one more allocation. Instead just make sure
434 * nowildcardlen does not exceed real patternlen
436 if (*nowildcardlen > len)
437 *nowildcardlen = len;
438 if (*p == '*' && no_wildcard(p + 1))
439 *flags |= EXC_FLAG_ENDSWITH;
444 void add_exclude(const char *string, const char *base,
445 int baselen, struct exclude_list *el, int srcpos)
452 parse_exclude_pattern(&string, &patternlen, &flags, &nowildcardlen);
453 if (flags & EXC_FLAG_MUSTBEDIR) {
455 x = xmalloc(sizeof(*x) + patternlen + 1);
457 memcpy(s, string, patternlen);
458 s[patternlen] = '\0';
461 x = xmalloc(sizeof(*x));
464 x->patternlen = patternlen;
465 x->nowildcardlen = nowildcardlen;
467 x->baselen = baselen;
470 ALLOC_GROW(el->excludes, el->nr + 1, el->alloc);
471 el->excludes[el->nr++] = x;
475 static void *read_skip_worktree_file_from_index(const char *path, size_t *size)
479 enum object_type type;
481 struct index_state *istate = &the_index;
484 pos = index_name_pos(istate, path, len);
487 if (!ce_skip_worktree(istate->cache[pos]))
489 data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
490 if (!data || type != OBJ_BLOB) {
499 * Frees memory within el which was allocated for exclude patterns and
500 * the file buffer. Does not free el itself.
502 void clear_exclude_list(struct exclude_list *el)
506 for (i = 0; i < el->nr; i++)
507 free(el->excludes[i]);
516 int add_excludes_from_file_to_list(const char *fname,
519 struct exclude_list *el,
523 int fd, i, lineno = 1;
527 fd = open(fname, O_RDONLY);
528 if (fd < 0 || fstat(fd, &st) < 0) {
530 warn_on_inaccessible(fname);
534 (buf = read_skip_worktree_file_from_index(fname, &size)) == NULL)
540 if (buf[size-1] != '\n') {
541 buf = xrealloc(buf, size+1);
546 size = xsize_t(st.st_size);
551 buf = xmalloc(size+1);
552 if (read_in_full(fd, buf, size) != size) {
563 for (i = 0; i < size; i++) {
564 if (buf[i] == '\n') {
565 if (entry != buf + i && entry[0] != '#') {
566 buf[i - (i && buf[i-1] == '\r')] = 0;
567 add_exclude(entry, base, baselen, el, lineno);
576 struct exclude_list *add_exclude_list(struct dir_struct *dir,
577 int group_type, const char *src)
579 struct exclude_list *el;
580 struct exclude_list_group *group;
582 group = &dir->exclude_list_group[group_type];
583 ALLOC_GROW(group->el, group->nr + 1, group->alloc);
584 el = &group->el[group->nr++];
585 memset(el, 0, sizeof(*el));
591 * Used to set up core.excludesfile and .git/info/exclude lists.
593 void add_excludes_from_file(struct dir_struct *dir, const char *fname)
595 struct exclude_list *el;
596 el = add_exclude_list(dir, EXC_FILE, fname);
597 if (add_excludes_from_file_to_list(fname, "", 0, el, 0) < 0)
598 die("cannot use %s as an exclude file", fname);
601 int match_basename(const char *basename, int basenamelen,
602 const char *pattern, int prefix, int patternlen,
605 if (prefix == patternlen) {
606 if (patternlen == basenamelen &&
607 !strncmp_icase(pattern, basename, basenamelen))
609 } else if (flags & EXC_FLAG_ENDSWITH) {
610 /* "*literal" matching against "fooliteral" */
611 if (patternlen - 1 <= basenamelen &&
612 !strncmp_icase(pattern + 1,
613 basename + basenamelen - (patternlen - 1),
617 if (fnmatch_icase_mem(pattern, patternlen,
618 basename, basenamelen,
625 int match_pathname(const char *pathname, int pathlen,
626 const char *base, int baselen,
627 const char *pattern, int prefix, int patternlen,
634 * match with FNM_PATHNAME; the pattern has base implicitly
637 if (*pattern == '/') {
644 * baselen does not count the trailing slash. base[] may or
645 * may not end with a trailing slash though.
647 if (pathlen < baselen + 1 ||
648 (baselen && pathname[baselen] != '/') ||
649 strncmp_icase(pathname, base, baselen))
652 namelen = baselen ? pathlen - baselen - 1 : pathlen;
653 name = pathname + pathlen - namelen;
657 * if the non-wildcard part is longer than the
658 * remaining pathname, surely it cannot match.
660 if (prefix > namelen)
663 if (strncmp_icase(pattern, name, prefix))
666 patternlen -= prefix;
671 * If the whole pattern did not have a wildcard,
672 * then our prefix match is all we need; we
673 * do not need to call fnmatch at all.
675 if (!patternlen && !namelen)
679 return fnmatch_icase_mem(pattern, patternlen,
685 * Scan the given exclude list in reverse to see whether pathname
686 * should be ignored. The first match (i.e. the last on the list), if
687 * any, determines the fate. Returns the exclude_list element which
688 * matched, or NULL for undecided.
690 static struct exclude *last_exclude_matching_from_list(const char *pathname,
692 const char *basename,
694 struct exclude_list *el)
699 return NULL; /* undefined */
701 for (i = el->nr - 1; 0 <= i; i--) {
702 struct exclude *x = el->excludes[i];
703 const char *exclude = x->pattern;
704 int prefix = x->nowildcardlen;
706 if (x->flags & EXC_FLAG_MUSTBEDIR) {
707 if (*dtype == DT_UNKNOWN)
708 *dtype = get_dtype(NULL, pathname, pathlen);
709 if (*dtype != DT_DIR)
713 if (x->flags & EXC_FLAG_NODIR) {
714 if (match_basename(basename,
715 pathlen - (basename - pathname),
716 exclude, prefix, x->patternlen,
722 assert(x->baselen == 0 || x->base[x->baselen - 1] == '/');
723 if (match_pathname(pathname, pathlen,
724 x->base, x->baselen ? x->baselen - 1 : 0,
725 exclude, prefix, x->patternlen, x->flags))
728 return NULL; /* undecided */
732 * Scan the list and let the last match determine the fate.
733 * Return 1 for exclude, 0 for include and -1 for undecided.
735 int is_excluded_from_list(const char *pathname,
736 int pathlen, const char *basename, int *dtype,
737 struct exclude_list *el)
739 struct exclude *exclude;
740 exclude = last_exclude_matching_from_list(pathname, pathlen, basename, dtype, el);
742 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
743 return -1; /* undecided */
746 static struct exclude *last_exclude_matching_from_lists(struct dir_struct *dir,
747 const char *pathname, int pathlen, const char *basename,
751 struct exclude_list_group *group;
752 struct exclude *exclude;
753 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
754 group = &dir->exclude_list_group[i];
755 for (j = group->nr - 1; j >= 0; j--) {
756 exclude = last_exclude_matching_from_list(
757 pathname, pathlen, basename, dtype_p,
767 * Loads the per-directory exclude list for the substring of base
768 * which has a char length of baselen.
770 static void prep_exclude(struct dir_struct *dir, const char *base, int baselen)
772 struct exclude_list_group *group;
773 struct exclude_list *el;
774 struct exclude_stack *stk = NULL;
777 group = &dir->exclude_list_group[EXC_DIRS];
779 /* Pop the exclude lists from the EXCL_DIRS exclude_list_group
780 * which originate from directories not in the prefix of the
781 * path being checked. */
782 while ((stk = dir->exclude_stack) != NULL) {
783 if (stk->baselen <= baselen &&
784 !strncmp(dir->basebuf, base, stk->baselen))
786 el = &group->el[dir->exclude_stack->exclude_ix];
787 dir->exclude_stack = stk->prev;
789 free((char *)el->src); /* see strdup() below */
790 clear_exclude_list(el);
795 /* Skip traversing into sub directories if the parent is excluded */
799 /* Read from the parent directories and push them down. */
800 current = stk ? stk->baselen : -1;
801 while (current < baselen) {
802 struct exclude_stack *stk = xcalloc(1, sizeof(*stk));
810 cp = strchr(base + current + 1, '/');
812 die("oops in prep_exclude");
815 stk->prev = dir->exclude_stack;
816 stk->baselen = cp - base;
817 stk->exclude_ix = group->nr;
818 el = add_exclude_list(dir, EXC_DIRS, NULL);
819 memcpy(dir->basebuf + current, base + current,
820 stk->baselen - current);
822 /* Abort if the directory is excluded */
825 dir->basebuf[stk->baselen - 1] = 0;
826 dir->exclude = last_exclude_matching_from_lists(dir,
827 dir->basebuf, stk->baselen - 1,
828 dir->basebuf + current, &dt);
829 dir->basebuf[stk->baselen - 1] = '/';
831 dir->exclude->flags & EXC_FLAG_NEGATIVE)
834 dir->basebuf[stk->baselen] = 0;
835 dir->exclude_stack = stk;
840 /* Try to read per-directory file unless path is too long */
841 if (dir->exclude_per_dir &&
842 stk->baselen + strlen(dir->exclude_per_dir) < PATH_MAX) {
843 strcpy(dir->basebuf + stk->baselen,
844 dir->exclude_per_dir);
846 * dir->basebuf gets reused by the traversal, but we
847 * need fname to remain unchanged to ensure the src
848 * member of each struct exclude correctly
849 * back-references its source file. Other invocations
850 * of add_exclude_list provide stable strings, so we
851 * strdup() and free() here in the caller.
853 el->src = strdup(dir->basebuf);
854 add_excludes_from_file_to_list(dir->basebuf,
855 dir->basebuf, stk->baselen, el, 1);
857 dir->exclude_stack = stk;
858 current = stk->baselen;
860 dir->basebuf[baselen] = '\0';
864 * Loads the exclude lists for the directory containing pathname, then
865 * scans all exclude lists to determine whether pathname is excluded.
866 * Returns the exclude_list element which matched, or NULL for
869 struct exclude *last_exclude_matching(struct dir_struct *dir,
870 const char *pathname,
873 int pathlen = strlen(pathname);
874 const char *basename = strrchr(pathname, '/');
875 basename = (basename) ? basename+1 : pathname;
877 prep_exclude(dir, pathname, basename-pathname);
882 return last_exclude_matching_from_lists(dir, pathname, pathlen,
887 * Loads the exclude lists for the directory containing pathname, then
888 * scans all exclude lists to determine whether pathname is excluded.
889 * Returns 1 if true, otherwise 0.
891 int is_excluded(struct dir_struct *dir, const char *pathname, int *dtype_p)
893 struct exclude *exclude =
894 last_exclude_matching(dir, pathname, dtype_p);
896 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
900 static struct dir_entry *dir_entry_new(const char *pathname, int len)
902 struct dir_entry *ent;
904 ent = xmalloc(sizeof(*ent) + len + 1);
906 memcpy(ent->name, pathname, len);
911 static struct dir_entry *dir_add_name(struct dir_struct *dir, const char *pathname, int len)
913 if (cache_name_exists(pathname, len, ignore_case))
916 ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
917 return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
920 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len)
922 if (!cache_name_is_other(pathname, len))
925 ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
926 return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
930 index_nonexistent = 0,
936 * Do not use the alphabetically stored index to look up
937 * the directory name; instead, use the case insensitive
940 static enum exist_status directory_exists_in_index_icase(const char *dirname, int len)
942 struct cache_entry *ce = index_name_exists(&the_index, dirname, len + 1, ignore_case);
943 unsigned char endchar;
946 return index_nonexistent;
947 endchar = ce->name[len];
950 * The cache_entry structure returned will contain this dirname
951 * and possibly additional path components.
954 return index_directory;
957 * If there are no additional path components, then this cache_entry
958 * represents a submodule. Submodules, despite being directories,
959 * are stored in the cache without a closing slash.
961 if (!endchar && S_ISGITLINK(ce->ce_mode))
964 /* This should never be hit, but it exists just in case. */
965 return index_nonexistent;
969 * The index sorts alphabetically by entry name, which
970 * means that a gitlink sorts as '\0' at the end, while
971 * a directory (which is defined not as an entry, but as
972 * the files it contains) will sort with the '/' at the
975 static enum exist_status directory_exists_in_index(const char *dirname, int len)
980 return directory_exists_in_index_icase(dirname, len);
982 pos = cache_name_pos(dirname, len);
985 while (pos < active_nr) {
986 struct cache_entry *ce = active_cache[pos++];
987 unsigned char endchar;
989 if (strncmp(ce->name, dirname, len))
991 endchar = ce->name[len];
995 return index_directory;
996 if (!endchar && S_ISGITLINK(ce->ce_mode))
999 return index_nonexistent;
1003 * When we find a directory when traversing the filesystem, we
1004 * have three distinct cases:
1007 * - see it as a directory
1010 * and which one we choose depends on a combination of existing
1011 * git index contents and the flags passed into the directory
1012 * traversal routine.
1014 * Case 1: If we *already* have entries in the index under that
1015 * directory name, we always recurse into the directory to see
1018 * Case 2: If we *already* have that directory name as a gitlink,
1019 * we always continue to see it as a gitlink, regardless of whether
1020 * there is an actual git directory there or not (it might not
1021 * be checked out as a subproject!)
1023 * Case 3: if we didn't have it in the index previously, we
1024 * have a few sub-cases:
1026 * (a) if "show_other_directories" is true, we show it as
1027 * just a directory, unless "hide_empty_directories" is
1028 * also true, in which case we need to check if it contains any
1029 * untracked and / or ignored files.
1030 * (b) if it looks like a git directory, and we don't have
1031 * 'no_gitlinks' set we treat it as a gitlink, and show it
1033 * (c) otherwise, we recurse into it.
1035 static enum path_treatment treat_directory(struct dir_struct *dir,
1036 const char *dirname, int len, int exclude,
1037 const struct path_simplify *simplify)
1039 /* The "len-1" is to strip the final '/' */
1040 switch (directory_exists_in_index(dirname, len-1)) {
1041 case index_directory:
1042 return path_recurse;
1047 case index_nonexistent:
1048 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
1050 if (!(dir->flags & DIR_NO_GITLINKS)) {
1051 unsigned char sha1[20];
1052 if (resolve_gitlink_ref(dirname, "HEAD", sha1) == 0)
1053 return path_untracked;
1055 return path_recurse;
1058 /* This is the "show_other_directories" case */
1060 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1061 return exclude ? path_excluded : path_untracked;
1063 return read_directory_recursive(dir, dirname, len, 1, simplify);
1067 * This is an inexact early pruning of any recursive directory
1068 * reading - if the path cannot possibly be in the pathspec,
1069 * return true, and we'll skip it early.
1071 static int simplify_away(const char *path, int pathlen, const struct path_simplify *simplify)
1075 const char *match = simplify->path;
1076 int len = simplify->len;
1082 if (!memcmp(path, match, len))
1092 * This function tells us whether an excluded path matches a
1093 * list of "interesting" pathspecs. That is, whether a path matched
1094 * by any of the pathspecs could possibly be ignored by excluding
1095 * the specified path. This can happen if:
1097 * 1. the path is mentioned explicitly in the pathspec
1099 * 2. the path is a directory prefix of some element in the
1102 static int exclude_matches_pathspec(const char *path, int len,
1103 const struct path_simplify *simplify)
1106 for (; simplify->path; simplify++) {
1107 if (len == simplify->len
1108 && !memcmp(path, simplify->path, len))
1110 if (len < simplify->len
1111 && simplify->path[len] == '/'
1112 && !memcmp(path, simplify->path, len))
1119 static int get_index_dtype(const char *path, int len)
1122 struct cache_entry *ce;
1124 ce = cache_name_exists(path, len, 0);
1126 if (!ce_uptodate(ce))
1128 if (S_ISGITLINK(ce->ce_mode))
1131 * Nobody actually cares about the
1132 * difference between DT_LNK and DT_REG
1137 /* Try to look it up as a directory */
1138 pos = cache_name_pos(path, len);
1142 while (pos < active_nr) {
1143 ce = active_cache[pos++];
1144 if (strncmp(ce->name, path, len))
1146 if (ce->name[len] > '/')
1148 if (ce->name[len] < '/')
1150 if (!ce_uptodate(ce))
1151 break; /* continue? */
1157 static int get_dtype(struct dirent *de, const char *path, int len)
1159 int dtype = de ? DTYPE(de) : DT_UNKNOWN;
1162 if (dtype != DT_UNKNOWN)
1164 dtype = get_index_dtype(path, len);
1165 if (dtype != DT_UNKNOWN)
1167 if (lstat(path, &st))
1169 if (S_ISREG(st.st_mode))
1171 if (S_ISDIR(st.st_mode))
1173 if (S_ISLNK(st.st_mode))
1178 static enum path_treatment treat_one_path(struct dir_struct *dir,
1179 struct strbuf *path,
1180 const struct path_simplify *simplify,
1181 int dtype, struct dirent *de)
1184 if (dtype == DT_UNKNOWN)
1185 dtype = get_dtype(de, path->buf, path->len);
1187 /* Always exclude indexed files */
1188 if (dtype != DT_DIR &&
1189 cache_name_exists(path->buf, path->len, ignore_case))
1192 exclude = is_excluded(dir, path->buf, &dtype);
1195 * Excluded? If we don't explicitly want to show
1196 * ignored files, ignore it
1198 if (exclude && !(dir->flags & (DIR_SHOW_IGNORED|DIR_SHOW_IGNORED_TOO)))
1199 return path_excluded;
1205 strbuf_addch(path, '/');
1206 return treat_directory(dir, path->buf, path->len, exclude,
1210 return exclude ? path_excluded : path_untracked;
1214 static enum path_treatment treat_path(struct dir_struct *dir,
1216 struct strbuf *path,
1218 const struct path_simplify *simplify)
1222 if (is_dot_or_dotdot(de->d_name) || !strcmp(de->d_name, ".git"))
1224 strbuf_setlen(path, baselen);
1225 strbuf_addstr(path, de->d_name);
1226 if (simplify_away(path->buf, path->len, simplify))
1230 return treat_one_path(dir, path, simplify, dtype, de);
1234 * Read a directory tree. We currently ignore anything but
1235 * directories, regular files and symlinks. That's because git
1236 * doesn't handle them at all yet. Maybe that will change some
1239 * Also, we ignore the name ".git" (even if it is not a directory).
1240 * That likely will not change.
1242 * Returns the most significant path_treatment value encountered in the scan.
1244 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
1245 const char *base, int baselen,
1247 const struct path_simplify *simplify)
1250 enum path_treatment state, subdir_state, dir_state = path_none;
1252 struct strbuf path = STRBUF_INIT;
1254 strbuf_add(&path, base, baselen);
1256 fdir = opendir(path.len ? path.buf : ".");
1260 while ((de = readdir(fdir)) != NULL) {
1261 /* check how the file or directory should be treated */
1262 state = treat_path(dir, de, &path, baselen, simplify);
1263 if (state > dir_state)
1266 /* recurse into subdir if instructed by treat_path */
1267 if (state == path_recurse) {
1268 subdir_state = read_directory_recursive(dir, path.buf,
1269 path.len, check_only, simplify);
1270 if (subdir_state > dir_state)
1271 dir_state = subdir_state;
1275 /* abort early if maximum state has been reached */
1276 if (dir_state == path_untracked)
1278 /* skip the dir_add_* part */
1282 /* add the path to the appropriate result list */
1285 if (dir->flags & DIR_SHOW_IGNORED)
1286 dir_add_name(dir, path.buf, path.len);
1287 else if ((dir->flags & DIR_SHOW_IGNORED_TOO) ||
1288 ((dir->flags & DIR_COLLECT_IGNORED) &&
1289 exclude_matches_pathspec(path.buf, path.len,
1291 dir_add_ignored(dir, path.buf, path.len);
1294 case path_untracked:
1295 if (!(dir->flags & DIR_SHOW_IGNORED))
1296 dir_add_name(dir, path.buf, path.len);
1305 strbuf_release(&path);
1310 static int cmp_name(const void *p1, const void *p2)
1312 const struct dir_entry *e1 = *(const struct dir_entry **)p1;
1313 const struct dir_entry *e2 = *(const struct dir_entry **)p2;
1315 return cache_name_compare(e1->name, e1->len,
1319 static struct path_simplify *create_simplify(const char **pathspec)
1322 struct path_simplify *simplify = NULL;
1327 for (nr = 0 ; ; nr++) {
1330 alloc = alloc_nr(alloc);
1331 simplify = xrealloc(simplify, alloc * sizeof(*simplify));
1333 match = *pathspec++;
1336 simplify[nr].path = match;
1337 simplify[nr].len = simple_length(match);
1339 simplify[nr].path = NULL;
1340 simplify[nr].len = 0;
1344 static void free_simplify(struct path_simplify *simplify)
1349 static int treat_leading_path(struct dir_struct *dir,
1350 const char *path, int len,
1351 const struct path_simplify *simplify)
1353 struct strbuf sb = STRBUF_INIT;
1354 int baselen, rc = 0;
1356 int old_flags = dir->flags;
1358 while (len && path[len - 1] == '/')
1363 dir->flags &= ~DIR_SHOW_OTHER_DIRECTORIES;
1365 cp = path + baselen + !!baselen;
1366 cp = memchr(cp, '/', path + len - cp);
1370 baselen = cp - path;
1371 strbuf_setlen(&sb, 0);
1372 strbuf_add(&sb, path, baselen);
1373 if (!is_directory(sb.buf))
1375 if (simplify_away(sb.buf, sb.len, simplify))
1377 if (treat_one_path(dir, &sb, simplify,
1378 DT_DIR, NULL) == path_none)
1379 break; /* do not recurse into it */
1380 if (len <= baselen) {
1382 break; /* finished checking */
1385 strbuf_release(&sb);
1386 dir->flags = old_flags;
1390 int read_directory(struct dir_struct *dir, const char *path, int len, const struct pathspec *pathspec)
1392 struct path_simplify *simplify;
1395 * Check out create_simplify()
1398 GUARD_PATHSPEC(pathspec, PATHSPEC_FROMTOP | PATHSPEC_MAXDEPTH);
1400 if (has_symlink_leading_path(path, len))
1403 simplify = create_simplify(pathspec ? pathspec->raw : NULL);
1404 if (!len || treat_leading_path(dir, path, len, simplify))
1405 read_directory_recursive(dir, path, len, 0, simplify);
1406 free_simplify(simplify);
1407 qsort(dir->entries, dir->nr, sizeof(struct dir_entry *), cmp_name);
1408 qsort(dir->ignored, dir->ignored_nr, sizeof(struct dir_entry *), cmp_name);
1412 int file_exists(const char *f)
1415 return lstat(f, &sb) == 0;
1419 * Given two normalized paths (a trailing slash is ok), if subdir is
1420 * outside dir, return -1. Otherwise return the offset in subdir that
1421 * can be used as relative path to dir.
1423 int dir_inside_of(const char *subdir, const char *dir)
1427 assert(dir && subdir && *dir && *subdir);
1429 while (*dir && *subdir && *dir == *subdir) {
1435 /* hel[p]/me vs hel[l]/yeah */
1436 if (*dir && *subdir)
1440 return !*dir ? offset : -1; /* same dir */
1442 /* foo/[b]ar vs foo/[] */
1443 if (is_dir_sep(dir[-1]))
1444 return is_dir_sep(subdir[-1]) ? offset : -1;
1446 /* foo[/]bar vs foo[] */
1447 return is_dir_sep(*subdir) ? offset + 1 : -1;
1450 int is_inside_dir(const char *dir)
1455 if (!getcwd(cwd, sizeof(cwd)))
1456 die_errno("can't find the current directory");
1457 return dir_inside_of(cwd, dir) >= 0;
1460 int is_empty_dir(const char *path)
1462 DIR *dir = opendir(path);
1469 while ((e = readdir(dir)) != NULL)
1470 if (!is_dot_or_dotdot(e->d_name)) {
1479 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
1483 int ret = 0, original_len = path->len, len, kept_down = 0;
1484 int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
1485 int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
1486 unsigned char submodule_head[20];
1488 if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
1489 !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
1490 /* Do not descend and nuke a nested git work tree. */
1496 flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
1497 dir = opendir(path->buf);
1499 /* an empty dir could be removed even if it is unreadble */
1501 return rmdir(path->buf);
1505 if (path->buf[original_len - 1] != '/')
1506 strbuf_addch(path, '/');
1509 while ((e = readdir(dir)) != NULL) {
1511 if (is_dot_or_dotdot(e->d_name))
1514 strbuf_setlen(path, len);
1515 strbuf_addstr(path, e->d_name);
1516 if (lstat(path->buf, &st))
1518 else if (S_ISDIR(st.st_mode)) {
1519 if (!remove_dir_recurse(path, flag, &kept_down))
1520 continue; /* happy */
1521 } else if (!only_empty && !unlink(path->buf))
1522 continue; /* happy, too */
1524 /* path too long, stat fails, or non-directory still exists */
1530 strbuf_setlen(path, original_len);
1531 if (!ret && !keep_toplevel && !kept_down)
1532 ret = rmdir(path->buf);
1535 * report the uplevel that it is not an error that we
1536 * did not rmdir() our directory.
1542 int remove_dir_recursively(struct strbuf *path, int flag)
1544 return remove_dir_recurse(path, flag, NULL);
1547 void setup_standard_excludes(struct dir_struct *dir)
1552 dir->exclude_per_dir = ".gitignore";
1553 path = git_path("info/exclude");
1554 if (!excludes_file) {
1555 home_config_paths(NULL, &xdg_path, "ignore");
1556 excludes_file = xdg_path;
1558 if (!access_or_warn(path, R_OK, 0))
1559 add_excludes_from_file(dir, path);
1560 if (excludes_file && !access_or_warn(excludes_file, R_OK, 0))
1561 add_excludes_from_file(dir, excludes_file);
1564 int remove_path(const char *name)
1568 if (unlink(name) && errno != ENOENT && errno != ENOTDIR)
1571 slash = strrchr(name, '/');
1573 char *dirs = xstrdup(name);
1574 slash = dirs + (slash - name);
1577 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
1583 int limit_pathspec_to_literal(void)
1585 static int flag = -1;
1587 flag = git_env_bool(GIT_LITERAL_PATHSPECS_ENVIRONMENT, 0);
1592 * Frees memory within dir which was allocated for exclude lists and
1593 * the exclude_stack. Does not free dir itself.
1595 void clear_directory(struct dir_struct *dir)
1598 struct exclude_list_group *group;
1599 struct exclude_list *el;
1600 struct exclude_stack *stk;
1602 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
1603 group = &dir->exclude_list_group[i];
1604 for (j = 0; j < group->nr; j++) {
1607 free((char *)el->src);
1608 clear_exclude_list(el);
1613 stk = dir->exclude_stack;
1615 struct exclude_stack *prev = stk->prev;