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
,
116 for (n
= 0; n
< pathspec
->nr
; n
++) {
117 size_t i
= 0, len
= 0;
118 while (i
< pathspec
->items
[n
].nowildcard_len
&&
119 (n
== 0 || i
< max
)) {
120 char c
= pathspec
->items
[n
].match
[i
];
121 if (c
!= pathspec
->items
[0].match
[i
])
127 if (n
== 0 || len
< max
) {
137 * Returns a copy of the longest leading path common among all
140 char *common_prefix(const struct pathspec
*pathspec
)
142 unsigned long len
= common_prefix_len(pathspec
);
144 return len
? xmemdupz(pathspec
->items
[0].match
, len
) : NULL
;
147 int fill_directory(struct dir_struct
*dir
, const struct pathspec
*pathspec
)
152 * Calculate common prefix for the pathspec, and
153 * use that to optimize the directory walk
155 len
= common_prefix_len(pathspec
);
157 /* Read the directory and prune it */
158 read_directory(dir
, pathspec
->nr
? pathspec
->_raw
[0] : "", len
, pathspec
);
162 int within_depth(const char *name
, int namelen
,
163 int depth
, int max_depth
)
165 const char *cp
= name
, *cpe
= name
+ namelen
;
171 if (depth
> max_depth
)
178 * Does 'match' match the given name?
179 * A match is found if
181 * (1) the 'match' string is leading directory of 'name', or
182 * (2) the 'match' string is a wildcard and matches 'name', or
183 * (3) the 'match' string is exactly the same as 'name'.
185 * and the return value tells which case it was.
187 * It returns 0 when there is no match.
189 static int match_pathspec_item(const struct pathspec_item
*item
, int prefix
,
190 const char *name
, int namelen
)
192 /* name/namelen has prefix cut off by caller */
193 const char *match
= item
->match
+ prefix
;
194 int matchlen
= item
->len
- prefix
;
196 /* If the match was just the prefix, we matched */
198 return MATCHED_RECURSIVELY
;
200 if (matchlen
<= namelen
&& !strncmp(match
, name
, matchlen
)) {
201 if (matchlen
== namelen
)
202 return MATCHED_EXACTLY
;
204 if (match
[matchlen
-1] == '/' || name
[matchlen
] == '/')
205 return MATCHED_RECURSIVELY
;
208 if (item
->nowildcard_len
< item
->len
&&
209 !git_fnmatch(match
, name
,
210 item
->flags
& PATHSPEC_ONESTAR
? GFNM_ONESTAR
: 0,
211 item
->nowildcard_len
- prefix
))
212 return MATCHED_FNMATCH
;
218 * Given a name and a list of pathspecs, returns the nature of the
219 * closest (i.e. most specific) match of the name to any of the
222 * The caller typically calls this multiple times with the same
223 * pathspec and seen[] array but with different name/namelen
224 * (e.g. entries from the index) and is interested in seeing if and
225 * how each pathspec matches all the names it calls this function
226 * with. A mark is left in the seen[] array for each pathspec element
227 * indicating the closest type of match that element achieved, so if
228 * seen[n] remains zero after multiple invocations, that means the nth
229 * pathspec did not match any names, which could indicate that the
230 * user mistyped the nth pathspec.
232 int match_pathspec_depth(const struct pathspec
*ps
,
233 const char *name
, int namelen
,
234 int prefix
, char *seen
)
244 if (!ps
->recursive
||
245 !(ps
->magic
& PATHSPEC_MAXDEPTH
) ||
247 return MATCHED_RECURSIVELY
;
249 if (within_depth(name
, namelen
, 0, ps
->max_depth
))
250 return MATCHED_EXACTLY
;
258 for (i
= ps
->nr
- 1; i
>= 0; i
--) {
260 if (seen
&& seen
[i
] == MATCHED_EXACTLY
)
262 how
= match_pathspec_item(ps
->items
+i
, prefix
, name
, namelen
);
264 (ps
->magic
& PATHSPEC_MAXDEPTH
) &&
265 ps
->max_depth
!= -1 &&
266 how
&& how
!= MATCHED_FNMATCH
) {
267 int len
= ps
->items
[i
].len
;
268 if (name
[len
] == '/')
270 if (within_depth(name
+len
, namelen
-len
, 0, ps
->max_depth
))
271 how
= MATCHED_EXACTLY
;
278 if (seen
&& seen
[i
] < how
)
286 * Return the length of the "simple" part of a path match limiter.
288 int simple_length(const char *match
)
293 unsigned char c
= *match
++;
295 if (c
== '\0' || is_glob_special(c
))
300 int no_wildcard(const char *string
)
302 return string
[simple_length(string
)] == '\0';
305 void parse_exclude_pattern(const char **pattern
,
310 const char *p
= *pattern
;
315 *flags
|= EXC_FLAG_NEGATIVE
;
319 if (len
&& p
[len
- 1] == '/') {
321 *flags
|= EXC_FLAG_MUSTBEDIR
;
323 for (i
= 0; i
< len
; i
++) {
328 *flags
|= EXC_FLAG_NODIR
;
329 *nowildcardlen
= simple_length(p
);
331 * we should have excluded the trailing slash from 'p' too,
332 * but that's one more allocation. Instead just make sure
333 * nowildcardlen does not exceed real patternlen
335 if (*nowildcardlen
> len
)
336 *nowildcardlen
= len
;
337 if (*p
== '*' && no_wildcard(p
+ 1))
338 *flags
|= EXC_FLAG_ENDSWITH
;
343 void add_exclude(const char *string
, const char *base
,
344 int baselen
, struct exclude_list
*el
, int srcpos
)
351 parse_exclude_pattern(&string
, &patternlen
, &flags
, &nowildcardlen
);
352 if (flags
& EXC_FLAG_MUSTBEDIR
) {
354 x
= xmalloc(sizeof(*x
) + patternlen
+ 1);
356 memcpy(s
, string
, patternlen
);
357 s
[patternlen
] = '\0';
360 x
= xmalloc(sizeof(*x
));
363 x
->patternlen
= patternlen
;
364 x
->nowildcardlen
= nowildcardlen
;
366 x
->baselen
= baselen
;
369 ALLOC_GROW(el
->excludes
, el
->nr
+ 1, el
->alloc
);
370 el
->excludes
[el
->nr
++] = x
;
374 static void *read_skip_worktree_file_from_index(const char *path
, size_t *size
)
378 enum object_type type
;
380 struct index_state
*istate
= &the_index
;
383 pos
= index_name_pos(istate
, path
, len
);
386 if (!ce_skip_worktree(istate
->cache
[pos
]))
388 data
= read_sha1_file(istate
->cache
[pos
]->sha1
, &type
, &sz
);
389 if (!data
|| type
!= OBJ_BLOB
) {
398 * Frees memory within el which was allocated for exclude patterns and
399 * the file buffer. Does not free el itself.
401 void clear_exclude_list(struct exclude_list
*el
)
405 for (i
= 0; i
< el
->nr
; i
++)
406 free(el
->excludes
[i
]);
415 int add_excludes_from_file_to_list(const char *fname
,
418 struct exclude_list
*el
,
422 int fd
, i
, lineno
= 1;
426 fd
= open(fname
, O_RDONLY
);
427 if (fd
< 0 || fstat(fd
, &st
) < 0) {
429 warn_on_inaccessible(fname
);
433 (buf
= read_skip_worktree_file_from_index(fname
, &size
)) == NULL
)
439 if (buf
[size
-1] != '\n') {
440 buf
= xrealloc(buf
, size
+1);
445 size
= xsize_t(st
.st_size
);
450 buf
= xmalloc(size
+1);
451 if (read_in_full(fd
, buf
, size
) != size
) {
462 for (i
= 0; i
< size
; i
++) {
463 if (buf
[i
] == '\n') {
464 if (entry
!= buf
+ i
&& entry
[0] != '#') {
465 buf
[i
- (i
&& buf
[i
-1] == '\r')] = 0;
466 add_exclude(entry
, base
, baselen
, el
, lineno
);
475 struct exclude_list
*add_exclude_list(struct dir_struct
*dir
,
476 int group_type
, const char *src
)
478 struct exclude_list
*el
;
479 struct exclude_list_group
*group
;
481 group
= &dir
->exclude_list_group
[group_type
];
482 ALLOC_GROW(group
->el
, group
->nr
+ 1, group
->alloc
);
483 el
= &group
->el
[group
->nr
++];
484 memset(el
, 0, sizeof(*el
));
490 * Used to set up core.excludesfile and .git/info/exclude lists.
492 void add_excludes_from_file(struct dir_struct
*dir
, const char *fname
)
494 struct exclude_list
*el
;
495 el
= add_exclude_list(dir
, EXC_FILE
, fname
);
496 if (add_excludes_from_file_to_list(fname
, "", 0, el
, 0) < 0)
497 die("cannot use %s as an exclude file", fname
);
500 int match_basename(const char *basename
, int basenamelen
,
501 const char *pattern
, int prefix
, int patternlen
,
504 if (prefix
== patternlen
) {
505 if (patternlen
== basenamelen
&&
506 !strncmp_icase(pattern
, basename
, basenamelen
))
508 } else if (flags
& EXC_FLAG_ENDSWITH
) {
509 /* "*literal" matching against "fooliteral" */
510 if (patternlen
- 1 <= basenamelen
&&
511 !strncmp_icase(pattern
+ 1,
512 basename
+ basenamelen
- (patternlen
- 1),
516 if (fnmatch_icase_mem(pattern
, patternlen
,
517 basename
, basenamelen
,
524 int match_pathname(const char *pathname
, int pathlen
,
525 const char *base
, int baselen
,
526 const char *pattern
, int prefix
, int patternlen
,
533 * match with FNM_PATHNAME; the pattern has base implicitly
536 if (*pattern
== '/') {
543 * baselen does not count the trailing slash. base[] may or
544 * may not end with a trailing slash though.
546 if (pathlen
< baselen
+ 1 ||
547 (baselen
&& pathname
[baselen
] != '/') ||
548 strncmp_icase(pathname
, base
, baselen
))
551 namelen
= baselen
? pathlen
- baselen
- 1 : pathlen
;
552 name
= pathname
+ pathlen
- namelen
;
556 * if the non-wildcard part is longer than the
557 * remaining pathname, surely it cannot match.
559 if (prefix
> namelen
)
562 if (strncmp_icase(pattern
, name
, prefix
))
565 patternlen
-= prefix
;
570 * If the whole pattern did not have a wildcard,
571 * then our prefix match is all we need; we
572 * do not need to call fnmatch at all.
574 if (!patternlen
&& !namelen
)
578 return fnmatch_icase_mem(pattern
, patternlen
,
584 * Scan the given exclude list in reverse to see whether pathname
585 * should be ignored. The first match (i.e. the last on the list), if
586 * any, determines the fate. Returns the exclude_list element which
587 * matched, or NULL for undecided.
589 static struct exclude
*last_exclude_matching_from_list(const char *pathname
,
591 const char *basename
,
593 struct exclude_list
*el
)
598 return NULL
; /* undefined */
600 for (i
= el
->nr
- 1; 0 <= i
; i
--) {
601 struct exclude
*x
= el
->excludes
[i
];
602 const char *exclude
= x
->pattern
;
603 int prefix
= x
->nowildcardlen
;
605 if (x
->flags
& EXC_FLAG_MUSTBEDIR
) {
606 if (*dtype
== DT_UNKNOWN
)
607 *dtype
= get_dtype(NULL
, pathname
, pathlen
);
608 if (*dtype
!= DT_DIR
)
612 if (x
->flags
& EXC_FLAG_NODIR
) {
613 if (match_basename(basename
,
614 pathlen
- (basename
- pathname
),
615 exclude
, prefix
, x
->patternlen
,
621 assert(x
->baselen
== 0 || x
->base
[x
->baselen
- 1] == '/');
622 if (match_pathname(pathname
, pathlen
,
623 x
->base
, x
->baselen
? x
->baselen
- 1 : 0,
624 exclude
, prefix
, x
->patternlen
, x
->flags
))
627 return NULL
; /* undecided */
631 * Scan the list and let the last match determine the fate.
632 * Return 1 for exclude, 0 for include and -1 for undecided.
634 int is_excluded_from_list(const char *pathname
,
635 int pathlen
, const char *basename
, int *dtype
,
636 struct exclude_list
*el
)
638 struct exclude
*exclude
;
639 exclude
= last_exclude_matching_from_list(pathname
, pathlen
, basename
, dtype
, el
);
641 return exclude
->flags
& EXC_FLAG_NEGATIVE
? 0 : 1;
642 return -1; /* undecided */
645 static struct exclude
*last_exclude_matching_from_lists(struct dir_struct
*dir
,
646 const char *pathname
, int pathlen
, const char *basename
,
650 struct exclude_list_group
*group
;
651 struct exclude
*exclude
;
652 for (i
= EXC_CMDL
; i
<= EXC_FILE
; i
++) {
653 group
= &dir
->exclude_list_group
[i
];
654 for (j
= group
->nr
- 1; j
>= 0; j
--) {
655 exclude
= last_exclude_matching_from_list(
656 pathname
, pathlen
, basename
, dtype_p
,
666 * Loads the per-directory exclude list for the substring of base
667 * which has a char length of baselen.
669 static void prep_exclude(struct dir_struct
*dir
, const char *base
, int baselen
)
671 struct exclude_list_group
*group
;
672 struct exclude_list
*el
;
673 struct exclude_stack
*stk
= NULL
;
676 group
= &dir
->exclude_list_group
[EXC_DIRS
];
678 /* Pop the exclude lists from the EXCL_DIRS exclude_list_group
679 * which originate from directories not in the prefix of the
680 * path being checked. */
681 while ((stk
= dir
->exclude_stack
) != NULL
) {
682 if (stk
->baselen
<= baselen
&&
683 !strncmp(dir
->basebuf
, base
, stk
->baselen
))
685 el
= &group
->el
[dir
->exclude_stack
->exclude_ix
];
686 dir
->exclude_stack
= stk
->prev
;
688 free((char *)el
->src
); /* see strdup() below */
689 clear_exclude_list(el
);
694 /* Skip traversing into sub directories if the parent is excluded */
698 /* Read from the parent directories and push them down. */
699 current
= stk
? stk
->baselen
: -1;
700 while (current
< baselen
) {
701 struct exclude_stack
*stk
= xcalloc(1, sizeof(*stk
));
709 cp
= strchr(base
+ current
+ 1, '/');
711 die("oops in prep_exclude");
714 stk
->prev
= dir
->exclude_stack
;
715 stk
->baselen
= cp
- base
;
716 stk
->exclude_ix
= group
->nr
;
717 el
= add_exclude_list(dir
, EXC_DIRS
, NULL
);
718 memcpy(dir
->basebuf
+ current
, base
+ current
,
719 stk
->baselen
- current
);
721 /* Abort if the directory is excluded */
724 dir
->basebuf
[stk
->baselen
- 1] = 0;
725 dir
->exclude
= last_exclude_matching_from_lists(dir
,
726 dir
->basebuf
, stk
->baselen
- 1,
727 dir
->basebuf
+ current
, &dt
);
728 dir
->basebuf
[stk
->baselen
- 1] = '/';
730 dir
->exclude
->flags
& EXC_FLAG_NEGATIVE
)
733 dir
->basebuf
[stk
->baselen
] = 0;
734 dir
->exclude_stack
= stk
;
739 /* Try to read per-directory file unless path is too long */
740 if (dir
->exclude_per_dir
&&
741 stk
->baselen
+ strlen(dir
->exclude_per_dir
) < PATH_MAX
) {
742 strcpy(dir
->basebuf
+ stk
->baselen
,
743 dir
->exclude_per_dir
);
745 * dir->basebuf gets reused by the traversal, but we
746 * need fname to remain unchanged to ensure the src
747 * member of each struct exclude correctly
748 * back-references its source file. Other invocations
749 * of add_exclude_list provide stable strings, so we
750 * strdup() and free() here in the caller.
752 el
->src
= strdup(dir
->basebuf
);
753 add_excludes_from_file_to_list(dir
->basebuf
,
754 dir
->basebuf
, stk
->baselen
, el
, 1);
756 dir
->exclude_stack
= stk
;
757 current
= stk
->baselen
;
759 dir
->basebuf
[baselen
] = '\0';
763 * Loads the exclude lists for the directory containing pathname, then
764 * scans all exclude lists to determine whether pathname is excluded.
765 * Returns the exclude_list element which matched, or NULL for
768 struct exclude
*last_exclude_matching(struct dir_struct
*dir
,
769 const char *pathname
,
772 int pathlen
= strlen(pathname
);
773 const char *basename
= strrchr(pathname
, '/');
774 basename
= (basename
) ? basename
+1 : pathname
;
776 prep_exclude(dir
, pathname
, basename
-pathname
);
781 return last_exclude_matching_from_lists(dir
, pathname
, pathlen
,
786 * Loads the exclude lists for the directory containing pathname, then
787 * scans all exclude lists to determine whether pathname is excluded.
788 * Returns 1 if true, otherwise 0.
790 int is_excluded(struct dir_struct
*dir
, const char *pathname
, int *dtype_p
)
792 struct exclude
*exclude
=
793 last_exclude_matching(dir
, pathname
, dtype_p
);
795 return exclude
->flags
& EXC_FLAG_NEGATIVE
? 0 : 1;
799 static struct dir_entry
*dir_entry_new(const char *pathname
, int len
)
801 struct dir_entry
*ent
;
803 ent
= xmalloc(sizeof(*ent
) + len
+ 1);
805 memcpy(ent
->name
, pathname
, len
);
810 static struct dir_entry
*dir_add_name(struct dir_struct
*dir
, const char *pathname
, int len
)
812 if (cache_name_exists(pathname
, len
, ignore_case
))
815 ALLOC_GROW(dir
->entries
, dir
->nr
+1, dir
->alloc
);
816 return dir
->entries
[dir
->nr
++] = dir_entry_new(pathname
, len
);
819 struct dir_entry
*dir_add_ignored(struct dir_struct
*dir
, const char *pathname
, int len
)
821 if (!cache_name_is_other(pathname
, len
))
824 ALLOC_GROW(dir
->ignored
, dir
->ignored_nr
+1, dir
->ignored_alloc
);
825 return dir
->ignored
[dir
->ignored_nr
++] = dir_entry_new(pathname
, len
);
829 index_nonexistent
= 0,
835 * Do not use the alphabetically stored index to look up
836 * the directory name; instead, use the case insensitive
839 static enum exist_status
directory_exists_in_index_icase(const char *dirname
, int len
)
841 struct cache_entry
*ce
= index_name_exists(&the_index
, dirname
, len
+ 1, ignore_case
);
842 unsigned char endchar
;
845 return index_nonexistent
;
846 endchar
= ce
->name
[len
];
849 * The cache_entry structure returned will contain this dirname
850 * and possibly additional path components.
853 return index_directory
;
856 * If there are no additional path components, then this cache_entry
857 * represents a submodule. Submodules, despite being directories,
858 * are stored in the cache without a closing slash.
860 if (!endchar
&& S_ISGITLINK(ce
->ce_mode
))
863 /* This should never be hit, but it exists just in case. */
864 return index_nonexistent
;
868 * The index sorts alphabetically by entry name, which
869 * means that a gitlink sorts as '\0' at the end, while
870 * a directory (which is defined not as an entry, but as
871 * the files it contains) will sort with the '/' at the
874 static enum exist_status
directory_exists_in_index(const char *dirname
, int len
)
879 return directory_exists_in_index_icase(dirname
, len
);
881 pos
= cache_name_pos(dirname
, len
);
884 while (pos
< active_nr
) {
885 struct cache_entry
*ce
= active_cache
[pos
++];
886 unsigned char endchar
;
888 if (strncmp(ce
->name
, dirname
, len
))
890 endchar
= ce
->name
[len
];
894 return index_directory
;
895 if (!endchar
&& S_ISGITLINK(ce
->ce_mode
))
898 return index_nonexistent
;
902 * When we find a directory when traversing the filesystem, we
903 * have three distinct cases:
906 * - see it as a directory
909 * and which one we choose depends on a combination of existing
910 * git index contents and the flags passed into the directory
913 * Case 1: If we *already* have entries in the index under that
914 * directory name, we always recurse into the directory to see
917 * Case 2: If we *already* have that directory name as a gitlink,
918 * we always continue to see it as a gitlink, regardless of whether
919 * there is an actual git directory there or not (it might not
920 * be checked out as a subproject!)
922 * Case 3: if we didn't have it in the index previously, we
923 * have a few sub-cases:
925 * (a) if "show_other_directories" is true, we show it as
926 * just a directory, unless "hide_empty_directories" is
927 * also true, in which case we need to check if it contains any
928 * untracked and / or ignored files.
929 * (b) if it looks like a git directory, and we don't have
930 * 'no_gitlinks' set we treat it as a gitlink, and show it
932 * (c) otherwise, we recurse into it.
934 static enum path_treatment
treat_directory(struct dir_struct
*dir
,
935 const char *dirname
, int len
, int exclude
,
936 const struct path_simplify
*simplify
)
938 /* The "len-1" is to strip the final '/' */
939 switch (directory_exists_in_index(dirname
, len
-1)) {
940 case index_directory
:
946 case index_nonexistent
:
947 if (dir
->flags
& DIR_SHOW_OTHER_DIRECTORIES
)
949 if (!(dir
->flags
& DIR_NO_GITLINKS
)) {
950 unsigned char sha1
[20];
951 if (resolve_gitlink_ref(dirname
, "HEAD", sha1
) == 0)
952 return path_untracked
;
957 /* This is the "show_other_directories" case */
959 if (!(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
960 return exclude
? path_excluded
: path_untracked
;
962 return read_directory_recursive(dir
, dirname
, len
, 1, simplify
);
966 * This is an inexact early pruning of any recursive directory
967 * reading - if the path cannot possibly be in the pathspec,
968 * return true, and we'll skip it early.
970 static int simplify_away(const char *path
, int pathlen
, const struct path_simplify
*simplify
)
974 const char *match
= simplify
->path
;
975 int len
= simplify
->len
;
981 if (!memcmp(path
, match
, len
))
991 * This function tells us whether an excluded path matches a
992 * list of "interesting" pathspecs. That is, whether a path matched
993 * by any of the pathspecs could possibly be ignored by excluding
994 * the specified path. This can happen if:
996 * 1. the path is mentioned explicitly in the pathspec
998 * 2. the path is a directory prefix of some element in the
1001 static int exclude_matches_pathspec(const char *path
, int len
,
1002 const struct path_simplify
*simplify
)
1005 for (; simplify
->path
; simplify
++) {
1006 if (len
== simplify
->len
1007 && !memcmp(path
, simplify
->path
, len
))
1009 if (len
< simplify
->len
1010 && simplify
->path
[len
] == '/'
1011 && !memcmp(path
, simplify
->path
, len
))
1018 static int get_index_dtype(const char *path
, int len
)
1021 struct cache_entry
*ce
;
1023 ce
= cache_name_exists(path
, len
, 0);
1025 if (!ce_uptodate(ce
))
1027 if (S_ISGITLINK(ce
->ce_mode
))
1030 * Nobody actually cares about the
1031 * difference between DT_LNK and DT_REG
1036 /* Try to look it up as a directory */
1037 pos
= cache_name_pos(path
, len
);
1041 while (pos
< active_nr
) {
1042 ce
= active_cache
[pos
++];
1043 if (strncmp(ce
->name
, path
, len
))
1045 if (ce
->name
[len
] > '/')
1047 if (ce
->name
[len
] < '/')
1049 if (!ce_uptodate(ce
))
1050 break; /* continue? */
1056 static int get_dtype(struct dirent
*de
, const char *path
, int len
)
1058 int dtype
= de
? DTYPE(de
) : DT_UNKNOWN
;
1061 if (dtype
!= DT_UNKNOWN
)
1063 dtype
= get_index_dtype(path
, len
);
1064 if (dtype
!= DT_UNKNOWN
)
1066 if (lstat(path
, &st
))
1068 if (S_ISREG(st
.st_mode
))
1070 if (S_ISDIR(st
.st_mode
))
1072 if (S_ISLNK(st
.st_mode
))
1077 static enum path_treatment
treat_one_path(struct dir_struct
*dir
,
1078 struct strbuf
*path
,
1079 const struct path_simplify
*simplify
,
1080 int dtype
, struct dirent
*de
)
1083 if (dtype
== DT_UNKNOWN
)
1084 dtype
= get_dtype(de
, path
->buf
, path
->len
);
1086 /* Always exclude indexed files */
1087 if (dtype
!= DT_DIR
&&
1088 cache_name_exists(path
->buf
, path
->len
, ignore_case
))
1091 exclude
= is_excluded(dir
, path
->buf
, &dtype
);
1094 * Excluded? If we don't explicitly want to show
1095 * ignored files, ignore it
1097 if (exclude
&& !(dir
->flags
& (DIR_SHOW_IGNORED
|DIR_SHOW_IGNORED_TOO
)))
1098 return path_excluded
;
1104 strbuf_addch(path
, '/');
1105 return treat_directory(dir
, path
->buf
, path
->len
, exclude
,
1109 return exclude
? path_excluded
: path_untracked
;
1113 static enum path_treatment
treat_path(struct dir_struct
*dir
,
1115 struct strbuf
*path
,
1117 const struct path_simplify
*simplify
)
1121 if (is_dot_or_dotdot(de
->d_name
) || !strcmp(de
->d_name
, ".git"))
1123 strbuf_setlen(path
, baselen
);
1124 strbuf_addstr(path
, de
->d_name
);
1125 if (simplify_away(path
->buf
, path
->len
, simplify
))
1129 return treat_one_path(dir
, path
, simplify
, dtype
, de
);
1133 * Read a directory tree. We currently ignore anything but
1134 * directories, regular files and symlinks. That's because git
1135 * doesn't handle them at all yet. Maybe that will change some
1138 * Also, we ignore the name ".git" (even if it is not a directory).
1139 * That likely will not change.
1141 * Returns the most significant path_treatment value encountered in the scan.
1143 static enum path_treatment
read_directory_recursive(struct dir_struct
*dir
,
1144 const char *base
, int baselen
,
1146 const struct path_simplify
*simplify
)
1149 enum path_treatment state
, subdir_state
, dir_state
= path_none
;
1151 struct strbuf path
= STRBUF_INIT
;
1153 strbuf_add(&path
, base
, baselen
);
1155 fdir
= opendir(path
.len
? path
.buf
: ".");
1159 while ((de
= readdir(fdir
)) != NULL
) {
1160 /* check how the file or directory should be treated */
1161 state
= treat_path(dir
, de
, &path
, baselen
, simplify
);
1162 if (state
> dir_state
)
1165 /* recurse into subdir if instructed by treat_path */
1166 if (state
== path_recurse
) {
1167 subdir_state
= read_directory_recursive(dir
, path
.buf
,
1168 path
.len
, check_only
, simplify
);
1169 if (subdir_state
> dir_state
)
1170 dir_state
= subdir_state
;
1174 /* abort early if maximum state has been reached */
1175 if (dir_state
== path_untracked
)
1177 /* skip the dir_add_* part */
1181 /* add the path to the appropriate result list */
1184 if (dir
->flags
& DIR_SHOW_IGNORED
)
1185 dir_add_name(dir
, path
.buf
, path
.len
);
1186 else if ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) ||
1187 ((dir
->flags
& DIR_COLLECT_IGNORED
) &&
1188 exclude_matches_pathspec(path
.buf
, path
.len
,
1190 dir_add_ignored(dir
, path
.buf
, path
.len
);
1193 case path_untracked
:
1194 if (!(dir
->flags
& DIR_SHOW_IGNORED
))
1195 dir_add_name(dir
, path
.buf
, path
.len
);
1204 strbuf_release(&path
);
1209 static int cmp_name(const void *p1
, const void *p2
)
1211 const struct dir_entry
*e1
= *(const struct dir_entry
**)p1
;
1212 const struct dir_entry
*e2
= *(const struct dir_entry
**)p2
;
1214 return cache_name_compare(e1
->name
, e1
->len
,
1218 static struct path_simplify
*create_simplify(const char **pathspec
)
1221 struct path_simplify
*simplify
= NULL
;
1226 for (nr
= 0 ; ; nr
++) {
1229 alloc
= alloc_nr(alloc
);
1230 simplify
= xrealloc(simplify
, alloc
* sizeof(*simplify
));
1232 match
= *pathspec
++;
1235 simplify
[nr
].path
= match
;
1236 simplify
[nr
].len
= simple_length(match
);
1238 simplify
[nr
].path
= NULL
;
1239 simplify
[nr
].len
= 0;
1243 static void free_simplify(struct path_simplify
*simplify
)
1248 static int treat_leading_path(struct dir_struct
*dir
,
1249 const char *path
, int len
,
1250 const struct path_simplify
*simplify
)
1252 struct strbuf sb
= STRBUF_INIT
;
1253 int baselen
, rc
= 0;
1255 int old_flags
= dir
->flags
;
1257 while (len
&& path
[len
- 1] == '/')
1262 dir
->flags
&= ~DIR_SHOW_OTHER_DIRECTORIES
;
1264 cp
= path
+ baselen
+ !!baselen
;
1265 cp
= memchr(cp
, '/', path
+ len
- cp
);
1269 baselen
= cp
- path
;
1270 strbuf_setlen(&sb
, 0);
1271 strbuf_add(&sb
, path
, baselen
);
1272 if (!is_directory(sb
.buf
))
1274 if (simplify_away(sb
.buf
, sb
.len
, simplify
))
1276 if (treat_one_path(dir
, &sb
, simplify
,
1277 DT_DIR
, NULL
) == path_none
)
1278 break; /* do not recurse into it */
1279 if (len
<= baselen
) {
1281 break; /* finished checking */
1284 strbuf_release(&sb
);
1285 dir
->flags
= old_flags
;
1289 int read_directory(struct dir_struct
*dir
, const char *path
, int len
, const struct pathspec
*pathspec
)
1291 struct path_simplify
*simplify
;
1294 * Check out create_simplify()
1297 GUARD_PATHSPEC(pathspec
,
1302 if (has_symlink_leading_path(path
, len
))
1305 simplify
= create_simplify(pathspec
? pathspec
->_raw
: NULL
);
1306 if (!len
|| treat_leading_path(dir
, path
, len
, simplify
))
1307 read_directory_recursive(dir
, path
, len
, 0, simplify
);
1308 free_simplify(simplify
);
1309 qsort(dir
->entries
, dir
->nr
, sizeof(struct dir_entry
*), cmp_name
);
1310 qsort(dir
->ignored
, dir
->ignored_nr
, sizeof(struct dir_entry
*), cmp_name
);
1314 int file_exists(const char *f
)
1317 return lstat(f
, &sb
) == 0;
1321 * Given two normalized paths (a trailing slash is ok), if subdir is
1322 * outside dir, return -1. Otherwise return the offset in subdir that
1323 * can be used as relative path to dir.
1325 int dir_inside_of(const char *subdir
, const char *dir
)
1329 assert(dir
&& subdir
&& *dir
&& *subdir
);
1331 while (*dir
&& *subdir
&& *dir
== *subdir
) {
1337 /* hel[p]/me vs hel[l]/yeah */
1338 if (*dir
&& *subdir
)
1342 return !*dir
? offset
: -1; /* same dir */
1344 /* foo/[b]ar vs foo/[] */
1345 if (is_dir_sep(dir
[-1]))
1346 return is_dir_sep(subdir
[-1]) ? offset
: -1;
1348 /* foo[/]bar vs foo[] */
1349 return is_dir_sep(*subdir
) ? offset
+ 1 : -1;
1352 int is_inside_dir(const char *dir
)
1357 if (!getcwd(cwd
, sizeof(cwd
)))
1358 die_errno("can't find the current directory");
1359 return dir_inside_of(cwd
, dir
) >= 0;
1362 int is_empty_dir(const char *path
)
1364 DIR *dir
= opendir(path
);
1371 while ((e
= readdir(dir
)) != NULL
)
1372 if (!is_dot_or_dotdot(e
->d_name
)) {
1381 static int remove_dir_recurse(struct strbuf
*path
, int flag
, int *kept_up
)
1385 int ret
= 0, original_len
= path
->len
, len
, kept_down
= 0;
1386 int only_empty
= (flag
& REMOVE_DIR_EMPTY_ONLY
);
1387 int keep_toplevel
= (flag
& REMOVE_DIR_KEEP_TOPLEVEL
);
1388 unsigned char submodule_head
[20];
1390 if ((flag
& REMOVE_DIR_KEEP_NESTED_GIT
) &&
1391 !resolve_gitlink_ref(path
->buf
, "HEAD", submodule_head
)) {
1392 /* Do not descend and nuke a nested git work tree. */
1398 flag
&= ~REMOVE_DIR_KEEP_TOPLEVEL
;
1399 dir
= opendir(path
->buf
);
1401 /* an empty dir could be removed even if it is unreadble */
1403 return rmdir(path
->buf
);
1407 if (path
->buf
[original_len
- 1] != '/')
1408 strbuf_addch(path
, '/');
1411 while ((e
= readdir(dir
)) != NULL
) {
1413 if (is_dot_or_dotdot(e
->d_name
))
1416 strbuf_setlen(path
, len
);
1417 strbuf_addstr(path
, e
->d_name
);
1418 if (lstat(path
->buf
, &st
))
1420 else if (S_ISDIR(st
.st_mode
)) {
1421 if (!remove_dir_recurse(path
, flag
, &kept_down
))
1422 continue; /* happy */
1423 } else if (!only_empty
&& !unlink(path
->buf
))
1424 continue; /* happy, too */
1426 /* path too long, stat fails, or non-directory still exists */
1432 strbuf_setlen(path
, original_len
);
1433 if (!ret
&& !keep_toplevel
&& !kept_down
)
1434 ret
= rmdir(path
->buf
);
1437 * report the uplevel that it is not an error that we
1438 * did not rmdir() our directory.
1444 int remove_dir_recursively(struct strbuf
*path
, int flag
)
1446 return remove_dir_recurse(path
, flag
, NULL
);
1449 void setup_standard_excludes(struct dir_struct
*dir
)
1454 dir
->exclude_per_dir
= ".gitignore";
1455 path
= git_path("info/exclude");
1456 if (!excludes_file
) {
1457 home_config_paths(NULL
, &xdg_path
, "ignore");
1458 excludes_file
= xdg_path
;
1460 if (!access_or_warn(path
, R_OK
, 0))
1461 add_excludes_from_file(dir
, path
);
1462 if (excludes_file
&& !access_or_warn(excludes_file
, R_OK
, 0))
1463 add_excludes_from_file(dir
, excludes_file
);
1466 int remove_path(const char *name
)
1470 if (unlink(name
) && errno
!= ENOENT
&& errno
!= ENOTDIR
)
1473 slash
= strrchr(name
, '/');
1475 char *dirs
= xstrdup(name
);
1476 slash
= dirs
+ (slash
- name
);
1479 } while (rmdir(dirs
) == 0 && (slash
= strrchr(dirs
, '/')));
1486 * Frees memory within dir which was allocated for exclude lists and
1487 * the exclude_stack. Does not free dir itself.
1489 void clear_directory(struct dir_struct
*dir
)
1492 struct exclude_list_group
*group
;
1493 struct exclude_list
*el
;
1494 struct exclude_stack
*stk
;
1496 for (i
= EXC_CMDL
; i
<= EXC_FILE
; i
++) {
1497 group
= &dir
->exclude_list_group
[i
];
1498 for (j
= 0; j
< group
->nr
; j
++) {
1501 free((char *)el
->src
);
1502 clear_exclude_list(el
);
1507 stk
= dir
->exclude_stack
;
1509 struct exclude_stack
*prev
= stk
->prev
;