2 * This handles recursive filename detection with exclude
3 * files, index knowledge etc..
5 * Copyright (C) Linus Torvalds, 2005-2006
6 * Junio Hamano, 2005-2006
12 struct path_simplify
{
17 static int read_directory_recursive(struct dir_struct
*dir
, const char *path
, int len
,
18 int check_only
, const struct path_simplify
*simplify
);
19 static int get_dtype(struct dirent
*de
, const char *path
, int len
);
21 static int common_prefix(const char **pathspec
)
23 const char *path
, *slash
, *next
;
30 slash
= strrchr(path
, '/');
34 prefix
= slash
- path
+ 1;
35 while ((next
= *++pathspec
) != NULL
) {
36 int len
= strlen(next
);
37 if (len
>= prefix
&& !memcmp(path
, next
, prefix
))
43 if (next
[--len
] != '/')
45 if (memcmp(path
, next
, len
+1))
54 int fill_directory(struct dir_struct
*dir
, const char **pathspec
)
60 * Calculate common prefix for the pathspec, and
61 * use that to optimize the directory walk
63 len
= common_prefix(pathspec
);
67 path
= xmemdupz(*pathspec
, len
);
69 /* Read the directory and prune it */
70 read_directory(dir
, path
, len
, pathspec
);
75 * Does 'match' match the given name?
78 * (1) the 'match' string is leading directory of 'name', or
79 * (2) the 'match' string is a wildcard and matches 'name', or
80 * (3) the 'match' string is exactly the same as 'name'.
82 * and the return value tells which case it was.
84 * It returns 0 when there is no match.
86 static int match_one(const char *match
, const char *name
, int namelen
)
90 /* If the match was just the prefix, we matched */
92 return MATCHED_RECURSIVELY
;
95 unsigned char c1
= *match
;
96 unsigned char c2
= *name
;
97 if (c1
== '\0' || is_glob_special(c1
))
108 * If we don't match the matchstring exactly,
109 * we need to match by fnmatch
111 matchlen
= strlen(match
);
112 if (strncmp(match
, name
, matchlen
))
113 return !fnmatch(match
, name
, 0) ? MATCHED_FNMATCH
: 0;
115 if (namelen
== matchlen
)
116 return MATCHED_EXACTLY
;
117 if (match
[matchlen
-1] == '/' || name
[matchlen
] == '/')
118 return MATCHED_RECURSIVELY
;
123 * Given a name and a list of pathspecs, see if the name matches
124 * any of the pathspecs. The caller is also interested in seeing
125 * all pathspec matches some names it calls this function with
126 * (otherwise the user could have mistyped the unmatched pathspec),
127 * and a mark is left in seen[] array for pathspec element that
128 * actually matched anything.
130 int match_pathspec(const char **pathspec
, const char *name
, int namelen
,
131 int prefix
, char *seen
)
141 for (i
= 0; pathspec
[i
] != NULL
; i
++) {
143 const char *match
= pathspec
[i
] + prefix
;
144 if (seen
&& seen
[i
] == MATCHED_EXACTLY
)
146 how
= match_one(match
, name
, namelen
);
150 if (seen
&& seen
[i
] < how
)
157 static int no_wildcard(const char *string
)
159 return string
[strcspn(string
, "*?[{\\")] == '\0';
162 void add_exclude(const char *string
, const char *base
,
163 int baselen
, struct exclude_list
*which
)
170 if (*string
== '!') {
174 len
= strlen(string
);
175 if (len
&& string
[len
- 1] == '/') {
177 x
= xmalloc(sizeof(*x
) + len
);
179 memcpy(s
, string
, len
- 1);
183 flags
= EXC_FLAG_MUSTBEDIR
;
185 x
= xmalloc(sizeof(*x
));
188 x
->to_exclude
= to_exclude
;
189 x
->patternlen
= strlen(string
);
191 x
->baselen
= baselen
;
193 if (!strchr(string
, '/'))
194 x
->flags
|= EXC_FLAG_NODIR
;
195 if (no_wildcard(string
))
196 x
->flags
|= EXC_FLAG_NOWILDCARD
;
197 if (*string
== '*' && no_wildcard(string
+1))
198 x
->flags
|= EXC_FLAG_ENDSWITH
;
199 ALLOC_GROW(which
->excludes
, which
->nr
+ 1, which
->alloc
);
200 which
->excludes
[which
->nr
++] = x
;
203 static void *read_skip_worktree_file_from_index(const char *path
, size_t *size
)
207 enum object_type type
;
209 struct index_state
*istate
= &the_index
;
212 pos
= index_name_pos(istate
, path
, len
);
215 if (!ce_skip_worktree(istate
->cache
[pos
]))
217 data
= read_sha1_file(istate
->cache
[pos
]->sha1
, &type
, &sz
);
218 if (!data
|| type
!= OBJ_BLOB
) {
226 int add_excludes_from_file_to_list(const char *fname
,
230 struct exclude_list
*which
,
238 fd
= open(fname
, O_RDONLY
);
239 if (fd
< 0 || fstat(fd
, &st
) < 0) {
243 (buf
= read_skip_worktree_file_from_index(fname
, &size
)) == NULL
)
247 size
= xsize_t(st
.st_size
);
253 if (read_in_full(fd
, buf
, size
) != size
) {
263 for (i
= 0; i
<= size
; i
++) {
264 if (i
== size
|| buf
[i
] == '\n') {
265 if (entry
!= buf
+ i
&& entry
[0] != '#') {
266 buf
[i
- (i
&& buf
[i
-1] == '\r')] = 0;
267 add_exclude(entry
, base
, baselen
, which
);
275 void add_excludes_from_file(struct dir_struct
*dir
, const char *fname
)
277 if (add_excludes_from_file_to_list(fname
, "", 0, NULL
,
278 &dir
->exclude_list
[EXC_FILE
], 0) < 0)
279 die("cannot use %s as an exclude file", fname
);
282 static void prep_exclude(struct dir_struct
*dir
, const char *base
, int baselen
)
284 struct exclude_list
*el
;
285 struct exclude_stack
*stk
= NULL
;
288 if ((!dir
->exclude_per_dir
) ||
289 (baselen
+ strlen(dir
->exclude_per_dir
) >= PATH_MAX
))
290 return; /* too long a path -- ignore */
292 /* Pop the ones that are not the prefix of the path being checked. */
293 el
= &dir
->exclude_list
[EXC_DIRS
];
294 while ((stk
= dir
->exclude_stack
) != NULL
) {
295 if (stk
->baselen
<= baselen
&&
296 !strncmp(dir
->basebuf
, base
, stk
->baselen
))
298 dir
->exclude_stack
= stk
->prev
;
299 while (stk
->exclude_ix
< el
->nr
)
300 free(el
->excludes
[--el
->nr
]);
305 /* Read from the parent directories and push them down. */
306 current
= stk
? stk
->baselen
: -1;
307 while (current
< baselen
) {
308 struct exclude_stack
*stk
= xcalloc(1, sizeof(*stk
));
316 cp
= strchr(base
+ current
+ 1, '/');
318 die("oops in prep_exclude");
321 stk
->prev
= dir
->exclude_stack
;
322 stk
->baselen
= cp
- base
;
323 stk
->exclude_ix
= el
->nr
;
324 memcpy(dir
->basebuf
+ current
, base
+ current
,
325 stk
->baselen
- current
);
326 strcpy(dir
->basebuf
+ stk
->baselen
, dir
->exclude_per_dir
);
327 add_excludes_from_file_to_list(dir
->basebuf
,
328 dir
->basebuf
, stk
->baselen
,
329 &stk
->filebuf
, el
, 1);
330 dir
->exclude_stack
= stk
;
331 current
= stk
->baselen
;
333 dir
->basebuf
[baselen
] = '\0';
336 /* Scan the list and let the last match determine the fate.
337 * Return 1 for exclude, 0 for include and -1 for undecided.
339 int excluded_from_list(const char *pathname
,
340 int pathlen
, const char *basename
, int *dtype
,
341 struct exclude_list
*el
)
346 for (i
= el
->nr
- 1; 0 <= i
; i
--) {
347 struct exclude
*x
= el
->excludes
[i
];
348 const char *exclude
= x
->pattern
;
349 int to_exclude
= x
->to_exclude
;
351 if (x
->flags
& EXC_FLAG_MUSTBEDIR
) {
353 if (!prefixcmp(pathname
, exclude
))
358 if (*dtype
== DT_UNKNOWN
)
359 *dtype
= get_dtype(NULL
, pathname
, pathlen
);
360 if (*dtype
!= DT_DIR
)
364 if (x
->flags
& EXC_FLAG_NODIR
) {
366 if (x
->flags
& EXC_FLAG_NOWILDCARD
) {
367 if (!strcmp(exclude
, basename
))
369 } else if (x
->flags
& EXC_FLAG_ENDSWITH
) {
370 if (x
->patternlen
- 1 <= pathlen
&&
371 !strcmp(exclude
+ 1, pathname
+ pathlen
- x
->patternlen
+ 1))
374 if (fnmatch(exclude
, basename
, 0) == 0)
379 /* match with FNM_PATHNAME:
380 * exclude has base (baselen long) implicitly
383 int baselen
= x
->baselen
;
387 if (pathlen
< baselen
||
388 (baselen
&& pathname
[baselen
-1] != '/') ||
389 strncmp(pathname
, x
->base
, baselen
))
392 if (x
->flags
& EXC_FLAG_NOWILDCARD
) {
393 if (!strcmp(exclude
, pathname
+ baselen
))
396 if (fnmatch(exclude
, pathname
+baselen
,
403 return -1; /* undecided */
406 int excluded(struct dir_struct
*dir
, const char *pathname
, int *dtype_p
)
408 int pathlen
= strlen(pathname
);
410 const char *basename
= strrchr(pathname
, '/');
411 basename
= (basename
) ? basename
+1 : pathname
;
413 prep_exclude(dir
, pathname
, basename
-pathname
);
414 for (st
= EXC_CMDL
; st
<= EXC_FILE
; st
++) {
415 switch (excluded_from_list(pathname
, pathlen
, basename
,
416 dtype_p
, &dir
->exclude_list
[st
])) {
426 static struct dir_entry
*dir_entry_new(const char *pathname
, int len
)
428 struct dir_entry
*ent
;
430 ent
= xmalloc(sizeof(*ent
) + len
+ 1);
432 memcpy(ent
->name
, pathname
, len
);
437 static struct dir_entry
*dir_add_name(struct dir_struct
*dir
, const char *pathname
, int len
)
439 if (cache_name_exists(pathname
, len
, ignore_case
))
442 ALLOC_GROW(dir
->entries
, dir
->nr
+1, dir
->alloc
);
443 return dir
->entries
[dir
->nr
++] = dir_entry_new(pathname
, len
);
446 static struct dir_entry
*dir_add_ignored(struct dir_struct
*dir
, const char *pathname
, int len
)
448 if (!cache_name_is_other(pathname
, len
))
451 ALLOC_GROW(dir
->ignored
, dir
->ignored_nr
+1, dir
->ignored_alloc
);
452 return dir
->ignored
[dir
->ignored_nr
++] = dir_entry_new(pathname
, len
);
456 index_nonexistent
= 0,
462 * The index sorts alphabetically by entry name, which
463 * means that a gitlink sorts as '\0' at the end, while
464 * a directory (which is defined not as an entry, but as
465 * the files it contains) will sort with the '/' at the
468 static enum exist_status
directory_exists_in_index(const char *dirname
, int len
)
470 int pos
= cache_name_pos(dirname
, len
);
473 while (pos
< active_nr
) {
474 struct cache_entry
*ce
= active_cache
[pos
++];
475 unsigned char endchar
;
477 if (strncmp(ce
->name
, dirname
, len
))
479 endchar
= ce
->name
[len
];
483 return index_directory
;
484 if (!endchar
&& S_ISGITLINK(ce
->ce_mode
))
487 return index_nonexistent
;
491 * When we find a directory when traversing the filesystem, we
492 * have three distinct cases:
495 * - see it as a directory
498 * and which one we choose depends on a combination of existing
499 * git index contents and the flags passed into the directory
502 * Case 1: If we *already* have entries in the index under that
503 * directory name, we always recurse into the directory to see
506 * Case 2: If we *already* have that directory name as a gitlink,
507 * we always continue to see it as a gitlink, regardless of whether
508 * there is an actual git directory there or not (it might not
509 * be checked out as a subproject!)
511 * Case 3: if we didn't have it in the index previously, we
512 * have a few sub-cases:
514 * (a) if "show_other_directories" is true, we show it as
515 * just a directory, unless "hide_empty_directories" is
516 * also true and the directory is empty, in which case
517 * we just ignore it entirely.
518 * (b) if it looks like a git directory, and we don't have
519 * 'no_gitlinks' set we treat it as a gitlink, and show it
521 * (c) otherwise, we recurse into it.
523 enum directory_treatment
{
526 recurse_into_directory
,
529 static enum directory_treatment
treat_directory(struct dir_struct
*dir
,
530 const char *dirname
, int len
,
531 const struct path_simplify
*simplify
)
533 /* The "len-1" is to strip the final '/' */
534 switch (directory_exists_in_index(dirname
, len
-1)) {
535 case index_directory
:
536 return recurse_into_directory
;
539 if (dir
->flags
& DIR_SHOW_OTHER_DIRECTORIES
)
540 return ignore_directory
;
541 return show_directory
;
543 case index_nonexistent
:
544 if (dir
->flags
& DIR_SHOW_OTHER_DIRECTORIES
)
546 if (!(dir
->flags
& DIR_NO_GITLINKS
)) {
547 unsigned char sha1
[20];
548 if (resolve_gitlink_ref(dirname
, "HEAD", sha1
) == 0)
549 return show_directory
;
551 return recurse_into_directory
;
554 /* This is the "show_other_directories" case */
555 if (!(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
556 return show_directory
;
557 if (!read_directory_recursive(dir
, dirname
, len
, 1, simplify
))
558 return ignore_directory
;
559 return show_directory
;
563 * This is an inexact early pruning of any recursive directory
564 * reading - if the path cannot possibly be in the pathspec,
565 * return true, and we'll skip it early.
567 static int simplify_away(const char *path
, int pathlen
, const struct path_simplify
*simplify
)
571 const char *match
= simplify
->path
;
572 int len
= simplify
->len
;
578 if (!memcmp(path
, match
, len
))
587 static int in_pathspec(const char *path
, int len
, const struct path_simplify
*simplify
)
590 for (; simplify
->path
; simplify
++) {
591 if (len
== simplify
->len
592 && !memcmp(path
, simplify
->path
, len
))
599 static int get_index_dtype(const char *path
, int len
)
602 struct cache_entry
*ce
;
604 ce
= cache_name_exists(path
, len
, 0);
606 if (!ce_uptodate(ce
))
608 if (S_ISGITLINK(ce
->ce_mode
))
611 * Nobody actually cares about the
612 * difference between DT_LNK and DT_REG
617 /* Try to look it up as a directory */
618 pos
= cache_name_pos(path
, len
);
622 while (pos
< active_nr
) {
623 ce
= active_cache
[pos
++];
624 if (strncmp(ce
->name
, path
, len
))
626 if (ce
->name
[len
] > '/')
628 if (ce
->name
[len
] < '/')
630 if (!ce_uptodate(ce
))
631 break; /* continue? */
637 static int get_dtype(struct dirent
*de
, const char *path
, int len
)
639 int dtype
= de
? DTYPE(de
) : DT_UNKNOWN
;
642 if (dtype
!= DT_UNKNOWN
)
644 dtype
= get_index_dtype(path
, len
);
645 if (dtype
!= DT_UNKNOWN
)
647 if (lstat(path
, &st
))
649 if (S_ISREG(st
.st_mode
))
651 if (S_ISDIR(st
.st_mode
))
653 if (S_ISLNK(st
.st_mode
))
658 enum path_treatment
{
664 static enum path_treatment
treat_one_path(struct dir_struct
*dir
,
665 char *path
, int *len
,
666 const struct path_simplify
*simplify
,
667 int dtype
, struct dirent
*de
)
669 int exclude
= excluded(dir
, path
, &dtype
);
670 if (exclude
&& (dir
->flags
& DIR_COLLECT_IGNORED
)
671 && in_pathspec(path
, *len
, simplify
))
672 dir_add_ignored(dir
, path
, *len
);
675 * Excluded? If we don't explicitly want to show
676 * ignored files, ignore it
678 if (exclude
&& !(dir
->flags
& DIR_SHOW_IGNORED
))
681 if (dtype
== DT_UNKNOWN
)
682 dtype
= get_dtype(de
, path
, *len
);
685 * Do we want to see just the ignored files?
686 * We still need to recurse into directories,
687 * even if we don't ignore them, since the
688 * directory may contain files that we do..
690 if (!exclude
&& (dir
->flags
& DIR_SHOW_IGNORED
)) {
699 memcpy(path
+ *len
, "/", 2);
701 switch (treat_directory(dir
, path
, *len
, simplify
)) {
703 if (exclude
!= !!(dir
->flags
707 case recurse_into_directory
:
709 case ignore_directory
:
720 static enum path_treatment
treat_path(struct dir_struct
*dir
,
722 char *path
, int path_max
,
724 const struct path_simplify
*simplify
,
729 if (is_dot_or_dotdot(de
->d_name
) || !strcmp(de
->d_name
, ".git"))
731 *len
= strlen(de
->d_name
);
732 /* Ignore overly long pathnames! */
733 if (*len
+ baselen
+ 8 > path_max
)
735 memcpy(path
+ baselen
, de
->d_name
, *len
+ 1);
737 if (simplify_away(path
, *len
, simplify
))
741 return treat_one_path(dir
, path
, len
, simplify
, dtype
, de
);
745 * Read a directory tree. We currently ignore anything but
746 * directories, regular files and symlinks. That's because git
747 * doesn't handle them at all yet. Maybe that will change some
750 * Also, we ignore the name ".git" (even if it is not a directory).
751 * That likely will not change.
753 static int read_directory_recursive(struct dir_struct
*dir
,
754 const char *base
, int baselen
,
756 const struct path_simplify
*simplify
)
758 DIR *fdir
= opendir(*base
? base
: ".");
763 char path
[PATH_MAX
+ 1];
764 memcpy(path
, base
, baselen
);
766 while ((de
= readdir(fdir
)) != NULL
) {
768 switch (treat_path(dir
, de
, path
, sizeof(path
),
769 baselen
, simplify
, &len
)) {
771 contents
+= read_directory_recursive
772 (dir
, path
, len
, 0, simplify
);
783 dir_add_name(dir
, path
, len
);
792 static int cmp_name(const void *p1
, const void *p2
)
794 const struct dir_entry
*e1
= *(const struct dir_entry
**)p1
;
795 const struct dir_entry
*e2
= *(const struct dir_entry
**)p2
;
797 return cache_name_compare(e1
->name
, e1
->len
,
802 * Return the length of the "simple" part of a path match limiter.
804 static int simple_length(const char *match
)
809 unsigned char c
= *match
++;
811 if (c
== '\0' || is_glob_special(c
))
816 static struct path_simplify
*create_simplify(const char **pathspec
)
819 struct path_simplify
*simplify
= NULL
;
824 for (nr
= 0 ; ; nr
++) {
827 alloc
= alloc_nr(alloc
);
828 simplify
= xrealloc(simplify
, alloc
* sizeof(*simplify
));
833 simplify
[nr
].path
= match
;
834 simplify
[nr
].len
= simple_length(match
);
836 simplify
[nr
].path
= NULL
;
837 simplify
[nr
].len
= 0;
841 static void free_simplify(struct path_simplify
*simplify
)
846 static int treat_leading_path(struct dir_struct
*dir
,
847 const char *path
, int len
,
848 const struct path_simplify
*simplify
)
850 char pathbuf
[PATH_MAX
];
854 while (len
&& path
[len
- 1] == '/')
860 cp
= path
+ baselen
+ !!baselen
;
861 cp
= memchr(cp
, '/', path
+ len
- cp
);
866 memcpy(pathbuf
, path
, baselen
);
867 pathbuf
[baselen
] = '\0';
868 if (!is_directory(pathbuf
))
870 if (simplify_away(pathbuf
, baselen
, simplify
))
873 if (treat_one_path(dir
, pathbuf
, &blen
, simplify
,
874 DT_DIR
, NULL
) == path_ignored
)
875 return 0; /* do not recurse into it */
877 return 1; /* finished checking */
881 int read_directory(struct dir_struct
*dir
, const char *path
, int len
, const char **pathspec
)
883 struct path_simplify
*simplify
;
885 if (has_symlink_leading_path(path
, len
))
888 simplify
= create_simplify(pathspec
);
889 if (!len
|| treat_leading_path(dir
, path
, len
, simplify
))
890 read_directory_recursive(dir
, path
, len
, 0, simplify
);
891 free_simplify(simplify
);
892 qsort(dir
->entries
, dir
->nr
, sizeof(struct dir_entry
*), cmp_name
);
893 qsort(dir
->ignored
, dir
->ignored_nr
, sizeof(struct dir_entry
*), cmp_name
);
897 int file_exists(const char *f
)
900 return lstat(f
, &sb
) == 0;
904 * get_relative_cwd() gets the prefix of the current working directory
905 * relative to 'dir'. If we are not inside 'dir', it returns NULL.
907 * As a convenience, it also returns NULL if 'dir' is already NULL. The
908 * reason for this behaviour is that it is natural for functions returning
909 * directory names to return NULL to say "this directory does not exist"
910 * or "this directory is invalid". These cases are usually handled the
911 * same as if the cwd is not inside 'dir' at all, so get_relative_cwd()
912 * returns NULL for both of them.
914 * Most notably, get_relative_cwd(buffer, size, get_git_work_tree())
915 * unifies the handling of "outside work tree" with "no work tree at all".
917 char *get_relative_cwd(char *buffer
, int size
, const char *dir
)
923 if (!getcwd(buffer
, size
))
924 die_errno("can't find the current directory");
926 if (!is_absolute_path(dir
))
927 dir
= make_absolute_path(dir
);
929 while (*dir
&& *dir
== *cwd
) {
940 int is_inside_dir(const char *dir
)
942 char buffer
[PATH_MAX
];
943 return get_relative_cwd(buffer
, sizeof(buffer
), dir
) != NULL
;
946 int is_empty_dir(const char *path
)
948 DIR *dir
= opendir(path
);
955 while ((e
= readdir(dir
)) != NULL
)
956 if (!is_dot_or_dotdot(e
->d_name
)) {
965 int remove_dir_recursively(struct strbuf
*path
, int flag
)
969 int ret
= 0, original_len
= path
->len
, len
;
970 int only_empty
= (flag
& REMOVE_DIR_EMPTY_ONLY
);
971 unsigned char submodule_head
[20];
973 if ((flag
& REMOVE_DIR_KEEP_NESTED_GIT
) &&
974 !resolve_gitlink_ref(path
->buf
, "HEAD", submodule_head
))
975 /* Do not descend and nuke a nested git work tree. */
978 dir
= opendir(path
->buf
);
981 if (path
->buf
[original_len
- 1] != '/')
982 strbuf_addch(path
, '/');
985 while ((e
= readdir(dir
)) != NULL
) {
987 if (is_dot_or_dotdot(e
->d_name
))
990 strbuf_setlen(path
, len
);
991 strbuf_addstr(path
, e
->d_name
);
992 if (lstat(path
->buf
, &st
))
994 else if (S_ISDIR(st
.st_mode
)) {
995 if (!remove_dir_recursively(path
, only_empty
))
996 continue; /* happy */
997 } else if (!only_empty
&& !unlink(path
->buf
))
998 continue; /* happy, too */
1000 /* path too long, stat fails, or non-directory still exists */
1006 strbuf_setlen(path
, original_len
);
1008 ret
= rmdir(path
->buf
);
1012 void setup_standard_excludes(struct dir_struct
*dir
)
1016 dir
->exclude_per_dir
= ".gitignore";
1017 path
= git_path("info/exclude");
1018 if (!access(path
, R_OK
))
1019 add_excludes_from_file(dir
, path
);
1020 if (excludes_file
&& !access(excludes_file
, R_OK
))
1021 add_excludes_from_file(dir
, excludes_file
);
1024 int remove_path(const char *name
)
1028 if (unlink(name
) && errno
!= ENOENT
)
1031 slash
= strrchr(name
, '/');
1033 char *dirs
= xstrdup(name
);
1034 slash
= dirs
+ (slash
- name
);
1037 } while (rmdir(dirs
) && (slash
= strrchr(dirs
, '/')));