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 /* helper string functions with support for the ignore_case flag */
22 int strcmp_icase(const char *a, const char *b)
24 return ignore_case ? strcasecmp(a, b) : strcmp(a, b);
27 int strncmp_icase(const char *a, const char *b, size_t count)
29 return ignore_case ? strncasecmp(a, b, count) : strncmp(a, b, count);
32 int fnmatch_icase(const char *pattern, const char *string, int flags)
34 return fnmatch(pattern, string, flags | (ignore_case ? FNM_CASEFOLD : 0));
37 static int common_prefix(const char **pathspec)
39 const char *path, *slash, *next;
46 slash = strrchr(path, '/');
51 * The first 'prefix' characters of 'path' are common leading
52 * path components among the pathspecs we have seen so far,
53 * including the trailing slash.
55 prefix = slash - path + 1;
56 while ((next = *++pathspec) != NULL) {
57 int len, last_matching_slash = -1;
58 for (len = 0; len < prefix && next[len] == path[len]; len++)
60 last_matching_slash = len;
63 if (last_matching_slash < 0)
65 prefix = last_matching_slash + 1;
70 int fill_directory(struct dir_struct *dir, const char **pathspec)
76 * Calculate common prefix for the pathspec, and
77 * use that to optimize the directory walk
79 len = common_prefix(pathspec);
83 path = xmemdupz(*pathspec, len);
85 /* Read the directory and prune it */
86 read_directory(dir, path, len, pathspec);
91 * Does 'match' match the given name?
94 * (1) the 'match' string is leading directory of 'name', or
95 * (2) the 'match' string is a wildcard and matches 'name', or
96 * (3) the 'match' string is exactly the same as 'name'.
98 * and the return value tells which case it was.
100 * It returns 0 when there is no match.
102 static int match_one(const char *match, const char *name, int namelen)
106 /* If the match was just the prefix, we matched */
108 return MATCHED_RECURSIVELY;
111 unsigned char c1 = *match;
112 unsigned char c2 = *name;
113 if (c1 == '\0' || is_glob_special(c1))
124 * If we don't match the matchstring exactly,
125 * we need to match by fnmatch
127 matchlen = strlen(match);
128 if (strncmp(match, name, matchlen))
129 return !fnmatch(match, name, 0) ? MATCHED_FNMATCH : 0;
131 if (namelen == matchlen)
132 return MATCHED_EXACTLY;
133 if (match[matchlen-1] == '/' || name[matchlen] == '/')
134 return MATCHED_RECURSIVELY;
139 * Given a name and a list of pathspecs, see if the name matches
140 * any of the pathspecs. The caller is also interested in seeing
141 * all pathspec matches some names it calls this function with
142 * (otherwise the user could have mistyped the unmatched pathspec),
143 * and a mark is left in seen[] array for pathspec element that
144 * actually matched anything.
146 int match_pathspec(const char **pathspec, const char *name, int namelen,
147 int prefix, char *seen)
157 for (i = 0; pathspec[i] != NULL; i++) {
159 const char *match = pathspec[i] + prefix;
160 if (seen && seen[i] == MATCHED_EXACTLY)
162 how = match_one(match, name, namelen);
166 if (seen && seen[i] < how)
173 static int no_wildcard(const char *string)
175 return string[strcspn(string, "*?[{\\")] == '\0';
178 void add_exclude(const char *string, const char *base,
179 int baselen, struct exclude_list *which)
186 if (*string == '!') {
190 len = strlen(string);
191 if (len && string[len - 1] == '/') {
193 x = xmalloc(sizeof(*x) + len);
195 memcpy(s, string, len - 1);
199 flags = EXC_FLAG_MUSTBEDIR;
201 x = xmalloc(sizeof(*x));
204 x->to_exclude = to_exclude;
205 x->patternlen = strlen(string);
207 x->baselen = baselen;
209 if (!strchr(string, '/'))
210 x->flags |= EXC_FLAG_NODIR;
211 if (no_wildcard(string))
212 x->flags |= EXC_FLAG_NOWILDCARD;
213 if (*string == '*' && no_wildcard(string+1))
214 x->flags |= EXC_FLAG_ENDSWITH;
215 ALLOC_GROW(which->excludes, which->nr + 1, which->alloc);
216 which->excludes[which->nr++] = x;
219 static void *read_skip_worktree_file_from_index(const char *path, size_t *size)
223 enum object_type type;
225 struct index_state *istate = &the_index;
228 pos = index_name_pos(istate, path, len);
231 if (!ce_skip_worktree(istate->cache[pos]))
233 data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
234 if (!data || type != OBJ_BLOB) {
242 int add_excludes_from_file_to_list(const char *fname,
246 struct exclude_list *which,
254 fd = open(fname, O_RDONLY);
255 if (fd < 0 || fstat(fd, &st) < 0) {
259 (buf = read_skip_worktree_file_from_index(fname, &size)) == NULL)
265 if (buf[size-1] != '\n') {
266 buf = xrealloc(buf, size+1);
271 size = xsize_t(st.st_size);
276 buf = xmalloc(size+1);
277 if (read_in_full(fd, buf, size) != size) {
289 for (i = 0; i < size; i++) {
290 if (buf[i] == '\n') {
291 if (entry != buf + i && entry[0] != '#') {
292 buf[i - (i && buf[i-1] == '\r')] = 0;
293 add_exclude(entry, base, baselen, which);
301 void add_excludes_from_file(struct dir_struct *dir, const char *fname)
303 if (add_excludes_from_file_to_list(fname, "", 0, NULL,
304 &dir->exclude_list[EXC_FILE], 0) < 0)
305 die("cannot use %s as an exclude file", fname);
308 static void prep_exclude(struct dir_struct *dir, const char *base, int baselen)
310 struct exclude_list *el;
311 struct exclude_stack *stk = NULL;
314 if ((!dir->exclude_per_dir) ||
315 (baselen + strlen(dir->exclude_per_dir) >= PATH_MAX))
316 return; /* too long a path -- ignore */
318 /* Pop the ones that are not the prefix of the path being checked. */
319 el = &dir->exclude_list[EXC_DIRS];
320 while ((stk = dir->exclude_stack) != NULL) {
321 if (stk->baselen <= baselen &&
322 !strncmp(dir->basebuf, base, stk->baselen))
324 dir->exclude_stack = stk->prev;
325 while (stk->exclude_ix < el->nr)
326 free(el->excludes[--el->nr]);
331 /* Read from the parent directories and push them down. */
332 current = stk ? stk->baselen : -1;
333 while (current < baselen) {
334 struct exclude_stack *stk = xcalloc(1, sizeof(*stk));
342 cp = strchr(base + current + 1, '/');
344 die("oops in prep_exclude");
347 stk->prev = dir->exclude_stack;
348 stk->baselen = cp - base;
349 stk->exclude_ix = el->nr;
350 memcpy(dir->basebuf + current, base + current,
351 stk->baselen - current);
352 strcpy(dir->basebuf + stk->baselen, dir->exclude_per_dir);
353 add_excludes_from_file_to_list(dir->basebuf,
354 dir->basebuf, stk->baselen,
355 &stk->filebuf, el, 1);
356 dir->exclude_stack = stk;
357 current = stk->baselen;
359 dir->basebuf[baselen] = '\0';
362 /* Scan the list and let the last match determine the fate.
363 * Return 1 for exclude, 0 for include and -1 for undecided.
365 int excluded_from_list(const char *pathname,
366 int pathlen, const char *basename, int *dtype,
367 struct exclude_list *el)
372 for (i = el->nr - 1; 0 <= i; i--) {
373 struct exclude *x = el->excludes[i];
374 const char *exclude = x->pattern;
375 int to_exclude = x->to_exclude;
377 if (x->flags & EXC_FLAG_MUSTBEDIR) {
379 if (!prefixcmp(pathname, exclude))
384 if (*dtype == DT_UNKNOWN)
385 *dtype = get_dtype(NULL, pathname, pathlen);
386 if (*dtype != DT_DIR)
390 if (x->flags & EXC_FLAG_NODIR) {
392 if (x->flags & EXC_FLAG_NOWILDCARD) {
393 if (!strcmp_icase(exclude, basename))
395 } else if (x->flags & EXC_FLAG_ENDSWITH) {
396 if (x->patternlen - 1 <= pathlen &&
397 !strcmp_icase(exclude + 1, pathname + pathlen - x->patternlen + 1))
400 if (fnmatch_icase(exclude, basename, 0) == 0)
405 /* match with FNM_PATHNAME:
406 * exclude has base (baselen long) implicitly
409 int baselen = x->baselen;
413 if (pathlen < baselen ||
414 (baselen && pathname[baselen-1] != '/') ||
415 strncmp_icase(pathname, x->base, baselen))
418 if (x->flags & EXC_FLAG_NOWILDCARD) {
419 if (!strcmp_icase(exclude, pathname + baselen))
422 if (fnmatch_icase(exclude, pathname+baselen,
429 return -1; /* undecided */
432 int excluded(struct dir_struct *dir, const char *pathname, int *dtype_p)
434 int pathlen = strlen(pathname);
436 const char *basename = strrchr(pathname, '/');
437 basename = (basename) ? basename+1 : pathname;
439 prep_exclude(dir, pathname, basename-pathname);
440 for (st = EXC_CMDL; st <= EXC_FILE; st++) {
441 switch (excluded_from_list(pathname, pathlen, basename,
442 dtype_p, &dir->exclude_list[st])) {
452 static struct dir_entry *dir_entry_new(const char *pathname, int len)
454 struct dir_entry *ent;
456 ent = xmalloc(sizeof(*ent) + len + 1);
458 memcpy(ent->name, pathname, len);
463 static struct dir_entry *dir_add_name(struct dir_struct *dir, const char *pathname, int len)
465 if (cache_name_exists(pathname, len, ignore_case))
468 ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
469 return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
472 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len)
474 if (!cache_name_is_other(pathname, len))
477 ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
478 return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
482 index_nonexistent = 0,
488 * Do not use the alphabetically stored index to look up
489 * the directory name; instead, use the case insensitive
492 static enum exist_status directory_exists_in_index_icase(const char *dirname, int len)
494 struct cache_entry *ce = index_name_exists(&the_index, dirname, len + 1, ignore_case);
495 unsigned char endchar;
498 return index_nonexistent;
499 endchar = ce->name[len];
502 * The cache_entry structure returned will contain this dirname
503 * and possibly additional path components.
506 return index_directory;
509 * If there are no additional path components, then this cache_entry
510 * represents a submodule. Submodules, despite being directories,
511 * are stored in the cache without a closing slash.
513 if (!endchar && S_ISGITLINK(ce->ce_mode))
516 /* This should never be hit, but it exists just in case. */
517 return index_nonexistent;
521 * The index sorts alphabetically by entry name, which
522 * means that a gitlink sorts as '\0' at the end, while
523 * a directory (which is defined not as an entry, but as
524 * the files it contains) will sort with the '/' at the
527 static enum exist_status directory_exists_in_index(const char *dirname, int len)
532 return directory_exists_in_index_icase(dirname, len);
534 pos = cache_name_pos(dirname, len);
537 while (pos < active_nr) {
538 struct cache_entry *ce = active_cache[pos++];
539 unsigned char endchar;
541 if (strncmp(ce->name, dirname, len))
543 endchar = ce->name[len];
547 return index_directory;
548 if (!endchar && S_ISGITLINK(ce->ce_mode))
551 return index_nonexistent;
555 * When we find a directory when traversing the filesystem, we
556 * have three distinct cases:
559 * - see it as a directory
562 * and which one we choose depends on a combination of existing
563 * git index contents and the flags passed into the directory
566 * Case 1: If we *already* have entries in the index under that
567 * directory name, we always recurse into the directory to see
570 * Case 2: If we *already* have that directory name as a gitlink,
571 * we always continue to see it as a gitlink, regardless of whether
572 * there is an actual git directory there or not (it might not
573 * be checked out as a subproject!)
575 * Case 3: if we didn't have it in the index previously, we
576 * have a few sub-cases:
578 * (a) if "show_other_directories" is true, we show it as
579 * just a directory, unless "hide_empty_directories" is
580 * also true and the directory is empty, in which case
581 * we just ignore it entirely.
582 * (b) if it looks like a git directory, and we don't have
583 * 'no_gitlinks' set we treat it as a gitlink, and show it
585 * (c) otherwise, we recurse into it.
587 enum directory_treatment {
590 recurse_into_directory
593 static enum directory_treatment treat_directory(struct dir_struct *dir,
594 const char *dirname, int len,
595 const struct path_simplify *simplify)
597 /* The "len-1" is to strip the final '/' */
598 switch (directory_exists_in_index(dirname, len-1)) {
599 case index_directory:
600 return recurse_into_directory;
603 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
604 return ignore_directory;
605 return show_directory;
607 case index_nonexistent:
608 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
610 if (!(dir->flags & DIR_NO_GITLINKS)) {
611 unsigned char sha1[20];
612 if (resolve_gitlink_ref(dirname, "HEAD", sha1) == 0)
613 return show_directory;
615 return recurse_into_directory;
618 /* This is the "show_other_directories" case */
619 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
620 return show_directory;
621 if (!read_directory_recursive(dir, dirname, len, 1, simplify))
622 return ignore_directory;
623 return show_directory;
627 * This is an inexact early pruning of any recursive directory
628 * reading - if the path cannot possibly be in the pathspec,
629 * return true, and we'll skip it early.
631 static int simplify_away(const char *path, int pathlen, const struct path_simplify *simplify)
635 const char *match = simplify->path;
636 int len = simplify->len;
642 if (!memcmp(path, match, len))
652 * This function tells us whether an excluded path matches a
653 * list of "interesting" pathspecs. That is, whether a path matched
654 * by any of the pathspecs could possibly be ignored by excluding
655 * the specified path. This can happen if:
657 * 1. the path is mentioned explicitly in the pathspec
659 * 2. the path is a directory prefix of some element in the
662 static int exclude_matches_pathspec(const char *path, int len,
663 const struct path_simplify *simplify)
666 for (; simplify->path; simplify++) {
667 if (len == simplify->len
668 && !memcmp(path, simplify->path, len))
670 if (len < simplify->len
671 && simplify->path[len] == '/'
672 && !memcmp(path, simplify->path, len))
679 static int get_index_dtype(const char *path, int len)
682 struct cache_entry *ce;
684 ce = cache_name_exists(path, len, 0);
686 if (!ce_uptodate(ce))
688 if (S_ISGITLINK(ce->ce_mode))
691 * Nobody actually cares about the
692 * difference between DT_LNK and DT_REG
697 /* Try to look it up as a directory */
698 pos = cache_name_pos(path, len);
702 while (pos < active_nr) {
703 ce = active_cache[pos++];
704 if (strncmp(ce->name, path, len))
706 if (ce->name[len] > '/')
708 if (ce->name[len] < '/')
710 if (!ce_uptodate(ce))
711 break; /* continue? */
717 static int get_dtype(struct dirent *de, const char *path, int len)
719 int dtype = de ? DTYPE(de) : DT_UNKNOWN;
722 if (dtype != DT_UNKNOWN)
724 dtype = get_index_dtype(path, len);
725 if (dtype != DT_UNKNOWN)
727 if (lstat(path, &st))
729 if (S_ISREG(st.st_mode))
731 if (S_ISDIR(st.st_mode))
733 if (S_ISLNK(st.st_mode))
738 enum path_treatment {
744 static enum path_treatment treat_one_path(struct dir_struct *dir,
745 char *path, int *len,
746 const struct path_simplify *simplify,
747 int dtype, struct dirent *de)
749 int exclude = excluded(dir, path, &dtype);
750 if (exclude && (dir->flags & DIR_COLLECT_IGNORED)
751 && exclude_matches_pathspec(path, *len, simplify))
752 dir_add_ignored(dir, path, *len);
755 * Excluded? If we don't explicitly want to show
756 * ignored files, ignore it
758 if (exclude && !(dir->flags & DIR_SHOW_IGNORED))
761 if (dtype == DT_UNKNOWN)
762 dtype = get_dtype(de, path, *len);
765 * Do we want to see just the ignored files?
766 * We still need to recurse into directories,
767 * even if we don't ignore them, since the
768 * directory may contain files that we do..
770 if (!exclude && (dir->flags & DIR_SHOW_IGNORED)) {
779 memcpy(path + *len, "/", 2);
781 switch (treat_directory(dir, path, *len, simplify)) {
783 if (exclude != !!(dir->flags
787 case recurse_into_directory:
789 case ignore_directory:
800 static enum path_treatment treat_path(struct dir_struct *dir,
802 char *path, int path_max,
804 const struct path_simplify *simplify,
809 if (is_dot_or_dotdot(de->d_name) || !strcmp(de->d_name, ".git"))
811 *len = strlen(de->d_name);
812 /* Ignore overly long pathnames! */
813 if (*len + baselen + 8 > path_max)
815 memcpy(path + baselen, de->d_name, *len + 1);
817 if (simplify_away(path, *len, simplify))
821 return treat_one_path(dir, path, len, simplify, dtype, de);
825 * Read a directory tree. We currently ignore anything but
826 * directories, regular files and symlinks. That's because git
827 * doesn't handle them at all yet. Maybe that will change some
830 * Also, we ignore the name ".git" (even if it is not a directory).
831 * That likely will not change.
833 static int read_directory_recursive(struct dir_struct *dir,
834 const char *base, int baselen,
836 const struct path_simplify *simplify)
838 DIR *fdir = opendir(*base ? base : ".");
843 char path[PATH_MAX + 1];
844 memcpy(path, base, baselen);
846 while ((de = readdir(fdir)) != NULL) {
848 switch (treat_path(dir, de, path, sizeof(path),
849 baselen, simplify, &len)) {
851 contents += read_directory_recursive
852 (dir, path, len, 0, simplify);
863 dir_add_name(dir, path, len);
872 static int cmp_name(const void *p1, const void *p2)
874 const struct dir_entry *e1 = *(const struct dir_entry **)p1;
875 const struct dir_entry *e2 = *(const struct dir_entry **)p2;
877 return cache_name_compare(e1->name, e1->len,
882 * Return the length of the "simple" part of a path match limiter.
884 static int simple_length(const char *match)
889 unsigned char c = *match++;
891 if (c == '\0' || is_glob_special(c))
896 static struct path_simplify *create_simplify(const char **pathspec)
899 struct path_simplify *simplify = NULL;
904 for (nr = 0 ; ; nr++) {
907 alloc = alloc_nr(alloc);
908 simplify = xrealloc(simplify, alloc * sizeof(*simplify));
913 simplify[nr].path = match;
914 simplify[nr].len = simple_length(match);
916 simplify[nr].path = NULL;
917 simplify[nr].len = 0;
921 static void free_simplify(struct path_simplify *simplify)
926 static int treat_leading_path(struct dir_struct *dir,
927 const char *path, int len,
928 const struct path_simplify *simplify)
930 char pathbuf[PATH_MAX];
934 while (len && path[len - 1] == '/')
940 cp = path + baselen + !!baselen;
941 cp = memchr(cp, '/', path + len - cp);
946 memcpy(pathbuf, path, baselen);
947 pathbuf[baselen] = '\0';
948 if (!is_directory(pathbuf))
950 if (simplify_away(pathbuf, baselen, simplify))
953 if (treat_one_path(dir, pathbuf, &blen, simplify,
954 DT_DIR, NULL) == path_ignored)
955 return 0; /* do not recurse into it */
957 return 1; /* finished checking */
961 int read_directory(struct dir_struct *dir, const char *path, int len, const char **pathspec)
963 struct path_simplify *simplify;
965 if (has_symlink_leading_path(path, len))
968 simplify = create_simplify(pathspec);
969 if (!len || treat_leading_path(dir, path, len, simplify))
970 read_directory_recursive(dir, path, len, 0, simplify);
971 free_simplify(simplify);
972 qsort(dir->entries, dir->nr, sizeof(struct dir_entry *), cmp_name);
973 qsort(dir->ignored, dir->ignored_nr, sizeof(struct dir_entry *), cmp_name);
977 int file_exists(const char *f)
980 return lstat(f, &sb) == 0;
984 * get_relative_cwd() gets the prefix of the current working directory
985 * relative to 'dir'. If we are not inside 'dir', it returns NULL.
987 * As a convenience, it also returns NULL if 'dir' is already NULL. The
988 * reason for this behaviour is that it is natural for functions returning
989 * directory names to return NULL to say "this directory does not exist"
990 * or "this directory is invalid". These cases are usually handled the
991 * same as if the cwd is not inside 'dir' at all, so get_relative_cwd()
992 * returns NULL for both of them.
994 * Most notably, get_relative_cwd(buffer, size, get_git_work_tree())
995 * unifies the handling of "outside work tree" with "no work tree at all".
997 char *get_relative_cwd(char *buffer, int size, const char *dir)
1003 if (!getcwd(buffer, size))
1004 die_errno("can't find the current directory");
1006 if (!is_absolute_path(dir))
1007 dir = make_absolute_path(dir);
1009 while (*dir && *dir == *cwd) {
1025 int is_inside_dir(const char *dir)
1027 char buffer[PATH_MAX];
1028 return get_relative_cwd(buffer, sizeof(buffer), dir) != NULL;
1031 int is_empty_dir(const char *path)
1033 DIR *dir = opendir(path);
1040 while ((e = readdir(dir)) != NULL)
1041 if (!is_dot_or_dotdot(e->d_name)) {
1050 int remove_dir_recursively(struct strbuf *path, int flag)
1054 int ret = 0, original_len = path->len, len;
1055 int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
1056 unsigned char submodule_head[20];
1058 if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
1059 !resolve_gitlink_ref(path->buf, "HEAD", submodule_head))
1060 /* Do not descend and nuke a nested git work tree. */
1063 dir = opendir(path->buf);
1066 if (path->buf[original_len - 1] != '/')
1067 strbuf_addch(path, '/');
1070 while ((e = readdir(dir)) != NULL) {
1072 if (is_dot_or_dotdot(e->d_name))
1075 strbuf_setlen(path, len);
1076 strbuf_addstr(path, e->d_name);
1077 if (lstat(path->buf, &st))
1079 else if (S_ISDIR(st.st_mode)) {
1080 if (!remove_dir_recursively(path, only_empty))
1081 continue; /* happy */
1082 } else if (!only_empty && !unlink(path->buf))
1083 continue; /* happy, too */
1085 /* path too long, stat fails, or non-directory still exists */
1091 strbuf_setlen(path, original_len);
1093 ret = rmdir(path->buf);
1097 void setup_standard_excludes(struct dir_struct *dir)
1101 dir->exclude_per_dir = ".gitignore";
1102 path = git_path("info/exclude");
1103 if (!access(path, R_OK))
1104 add_excludes_from_file(dir, path);
1105 if (excludes_file && !access(excludes_file, R_OK))
1106 add_excludes_from_file(dir, excludes_file);
1109 int remove_path(const char *name)
1113 if (unlink(name) && errno != ENOENT)
1116 slash = strrchr(name, '/');
1118 char *dirs = xstrdup(name);
1119 slash = dirs + (slash - name);
1122 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));