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, '/');
35 * The first 'prefix' characters of 'path' are common leading
36 * path components among the pathspecs we have seen so far,
37 * including the trailing slash.
39 prefix = slash - path + 1;
40 while ((next = *++pathspec) != NULL) {
41 int len, last_matching_slash = -1;
42 for (len = 0; len < prefix && next[len] == path[len]; len++)
44 last_matching_slash = len;
47 if (last_matching_slash < 0)
49 prefix = last_matching_slash + 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)
249 if (buf[size-1] != '\n') {
250 buf = xrealloc(buf, size+1);
255 size = xsize_t(st.st_size);
260 buf = xmalloc(size+1);
261 if (read_in_full(fd, buf, size) != size) {
273 for (i = 0; i < size; i++) {
274 if (buf[i] == '\n') {
275 if (entry != buf + i && entry[0] != '#') {
276 buf[i - (i && buf[i-1] == '\r')] = 0;
277 add_exclude(entry, base, baselen, which);
285 void add_excludes_from_file(struct dir_struct *dir, const char *fname)
287 if (add_excludes_from_file_to_list(fname, "", 0, NULL,
288 &dir->exclude_list[EXC_FILE], 0) < 0)
289 die("cannot use %s as an exclude file", fname);
292 static void prep_exclude(struct dir_struct *dir, const char *base, int baselen)
294 struct exclude_list *el;
295 struct exclude_stack *stk = NULL;
298 if ((!dir->exclude_per_dir) ||
299 (baselen + strlen(dir->exclude_per_dir) >= PATH_MAX))
300 return; /* too long a path -- ignore */
302 /* Pop the ones that are not the prefix of the path being checked. */
303 el = &dir->exclude_list[EXC_DIRS];
304 while ((stk = dir->exclude_stack) != NULL) {
305 if (stk->baselen <= baselen &&
306 !strncmp(dir->basebuf, base, stk->baselen))
308 dir->exclude_stack = stk->prev;
309 while (stk->exclude_ix < el->nr)
310 free(el->excludes[--el->nr]);
315 /* Read from the parent directories and push them down. */
316 current = stk ? stk->baselen : -1;
317 while (current < baselen) {
318 struct exclude_stack *stk = xcalloc(1, sizeof(*stk));
326 cp = strchr(base + current + 1, '/');
328 die("oops in prep_exclude");
331 stk->prev = dir->exclude_stack;
332 stk->baselen = cp - base;
333 stk->exclude_ix = el->nr;
334 memcpy(dir->basebuf + current, base + current,
335 stk->baselen - current);
336 strcpy(dir->basebuf + stk->baselen, dir->exclude_per_dir);
337 add_excludes_from_file_to_list(dir->basebuf,
338 dir->basebuf, stk->baselen,
339 &stk->filebuf, el, 1);
340 dir->exclude_stack = stk;
341 current = stk->baselen;
343 dir->basebuf[baselen] = '\0';
346 /* Scan the list and let the last match determine the fate.
347 * Return 1 for exclude, 0 for include and -1 for undecided.
349 int excluded_from_list(const char *pathname,
350 int pathlen, const char *basename, int *dtype,
351 struct exclude_list *el)
356 for (i = el->nr - 1; 0 <= i; i--) {
357 struct exclude *x = el->excludes[i];
358 const char *exclude = x->pattern;
359 int to_exclude = x->to_exclude;
361 if (x->flags & EXC_FLAG_MUSTBEDIR) {
363 if (!prefixcmp(pathname, exclude) &&
364 pathname[x->patternlen] == '/')
369 if (*dtype == DT_UNKNOWN)
370 *dtype = get_dtype(NULL, pathname, pathlen);
371 if (*dtype != DT_DIR)
375 if (x->flags & EXC_FLAG_NODIR) {
377 if (x->flags & EXC_FLAG_NOWILDCARD) {
378 if (!strcmp(exclude, basename))
380 } else if (x->flags & EXC_FLAG_ENDSWITH) {
381 if (x->patternlen - 1 <= pathlen &&
382 !strcmp(exclude + 1, pathname + pathlen - x->patternlen + 1))
385 if (fnmatch(exclude, basename, 0) == 0)
390 /* match with FNM_PATHNAME:
391 * exclude has base (baselen long) implicitly
394 int baselen = x->baselen;
398 if (pathlen < baselen ||
399 (baselen && pathname[baselen-1] != '/') ||
400 strncmp(pathname, x->base, baselen))
403 if (x->flags & EXC_FLAG_NOWILDCARD) {
404 if (!strcmp(exclude, pathname + baselen))
407 if (fnmatch(exclude, pathname+baselen,
414 return -1; /* undecided */
417 int excluded(struct dir_struct *dir, const char *pathname, int *dtype_p)
419 int pathlen = strlen(pathname);
421 const char *basename = strrchr(pathname, '/');
422 basename = (basename) ? basename+1 : pathname;
424 prep_exclude(dir, pathname, basename-pathname);
425 for (st = EXC_CMDL; st <= EXC_FILE; st++) {
426 switch (excluded_from_list(pathname, pathlen, basename,
427 dtype_p, &dir->exclude_list[st])) {
437 static struct dir_entry *dir_entry_new(const char *pathname, int len)
439 struct dir_entry *ent;
441 ent = xmalloc(sizeof(*ent) + len + 1);
443 memcpy(ent->name, pathname, len);
448 static struct dir_entry *dir_add_name(struct dir_struct *dir, const char *pathname, int len)
450 if (cache_name_exists(pathname, len, ignore_case))
453 ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
454 return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
457 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len)
459 if (!cache_name_is_other(pathname, len))
462 ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
463 return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
467 index_nonexistent = 0,
473 * The index sorts alphabetically by entry name, which
474 * means that a gitlink sorts as '\0' at the end, while
475 * a directory (which is defined not as an entry, but as
476 * the files it contains) will sort with the '/' at the
479 static enum exist_status directory_exists_in_index(const char *dirname, int len)
481 int pos = cache_name_pos(dirname, len);
484 while (pos < active_nr) {
485 struct cache_entry *ce = active_cache[pos++];
486 unsigned char endchar;
488 if (strncmp(ce->name, dirname, len))
490 endchar = ce->name[len];
494 return index_directory;
495 if (!endchar && S_ISGITLINK(ce->ce_mode))
498 return index_nonexistent;
502 * When we find a directory when traversing the filesystem, we
503 * have three distinct cases:
506 * - see it as a directory
509 * and which one we choose depends on a combination of existing
510 * git index contents and the flags passed into the directory
513 * Case 1: If we *already* have entries in the index under that
514 * directory name, we always recurse into the directory to see
517 * Case 2: If we *already* have that directory name as a gitlink,
518 * we always continue to see it as a gitlink, regardless of whether
519 * there is an actual git directory there or not (it might not
520 * be checked out as a subproject!)
522 * Case 3: if we didn't have it in the index previously, we
523 * have a few sub-cases:
525 * (a) if "show_other_directories" is true, we show it as
526 * just a directory, unless "hide_empty_directories" is
527 * also true and the directory is empty, in which case
528 * we just ignore it entirely.
529 * (b) if it looks like a git directory, and we don't have
530 * 'no_gitlinks' set we treat it as a gitlink, and show it
532 * (c) otherwise, we recurse into it.
534 enum directory_treatment {
537 recurse_into_directory
540 static enum directory_treatment treat_directory(struct dir_struct *dir,
541 const char *dirname, int len,
542 const struct path_simplify *simplify)
544 /* The "len-1" is to strip the final '/' */
545 switch (directory_exists_in_index(dirname, len-1)) {
546 case index_directory:
547 return recurse_into_directory;
550 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
551 return ignore_directory;
552 return show_directory;
554 case index_nonexistent:
555 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
557 if (!(dir->flags & DIR_NO_GITLINKS)) {
558 unsigned char sha1[20];
559 if (resolve_gitlink_ref(dirname, "HEAD", sha1) == 0)
560 return show_directory;
562 return recurse_into_directory;
565 /* This is the "show_other_directories" case */
566 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
567 return show_directory;
568 if (!read_directory_recursive(dir, dirname, len, 1, simplify))
569 return ignore_directory;
570 return show_directory;
574 * This is an inexact early pruning of any recursive directory
575 * reading - if the path cannot possibly be in the pathspec,
576 * return true, and we'll skip it early.
578 static int simplify_away(const char *path, int pathlen, const struct path_simplify *simplify)
582 const char *match = simplify->path;
583 int len = simplify->len;
589 if (!memcmp(path, match, len))
599 * This function tells us whether an excluded path matches a
600 * list of "interesting" pathspecs. That is, whether a path matched
601 * by any of the pathspecs could possibly be ignored by excluding
602 * the specified path. This can happen if:
604 * 1. the path is mentioned explicitly in the pathspec
606 * 2. the path is a directory prefix of some element in the
609 static int exclude_matches_pathspec(const char *path, int len,
610 const struct path_simplify *simplify)
613 for (; simplify->path; simplify++) {
614 if (len == simplify->len
615 && !memcmp(path, simplify->path, len))
617 if (len < simplify->len
618 && simplify->path[len] == '/'
619 && !memcmp(path, simplify->path, len))
626 static int get_index_dtype(const char *path, int len)
629 struct cache_entry *ce;
631 ce = cache_name_exists(path, len, 0);
633 if (!ce_uptodate(ce))
635 if (S_ISGITLINK(ce->ce_mode))
638 * Nobody actually cares about the
639 * difference between DT_LNK and DT_REG
644 /* Try to look it up as a directory */
645 pos = cache_name_pos(path, len);
649 while (pos < active_nr) {
650 ce = active_cache[pos++];
651 if (strncmp(ce->name, path, len))
653 if (ce->name[len] > '/')
655 if (ce->name[len] < '/')
657 if (!ce_uptodate(ce))
658 break; /* continue? */
664 static int get_dtype(struct dirent *de, const char *path, int len)
666 int dtype = de ? DTYPE(de) : DT_UNKNOWN;
669 if (dtype != DT_UNKNOWN)
671 dtype = get_index_dtype(path, len);
672 if (dtype != DT_UNKNOWN)
674 if (lstat(path, &st))
676 if (S_ISREG(st.st_mode))
678 if (S_ISDIR(st.st_mode))
680 if (S_ISLNK(st.st_mode))
685 enum path_treatment {
691 static enum path_treatment treat_one_path(struct dir_struct *dir,
692 char *path, int *len,
693 const struct path_simplify *simplify,
694 int dtype, struct dirent *de)
696 int exclude = excluded(dir, path, &dtype);
697 if (exclude && (dir->flags & DIR_COLLECT_IGNORED)
698 && exclude_matches_pathspec(path, *len, simplify))
699 dir_add_ignored(dir, path, *len);
702 * Excluded? If we don't explicitly want to show
703 * ignored files, ignore it
705 if (exclude && !(dir->flags & DIR_SHOW_IGNORED))
708 if (dtype == DT_UNKNOWN)
709 dtype = get_dtype(de, path, *len);
712 * Do we want to see just the ignored files?
713 * We still need to recurse into directories,
714 * even if we don't ignore them, since the
715 * directory may contain files that we do..
717 if (!exclude && (dir->flags & DIR_SHOW_IGNORED)) {
726 memcpy(path + *len, "/", 2);
728 switch (treat_directory(dir, path, *len, simplify)) {
730 if (exclude != !!(dir->flags
734 case recurse_into_directory:
736 case ignore_directory:
747 static enum path_treatment treat_path(struct dir_struct *dir,
749 char *path, int path_max,
751 const struct path_simplify *simplify,
756 if (is_dot_or_dotdot(de->d_name) || !strcmp(de->d_name, ".git"))
758 *len = strlen(de->d_name);
759 /* Ignore overly long pathnames! */
760 if (*len + baselen + 8 > path_max)
762 memcpy(path + baselen, de->d_name, *len + 1);
764 if (simplify_away(path, *len, simplify))
768 return treat_one_path(dir, path, len, simplify, dtype, de);
772 * Read a directory tree. We currently ignore anything but
773 * directories, regular files and symlinks. That's because git
774 * doesn't handle them at all yet. Maybe that will change some
777 * Also, we ignore the name ".git" (even if it is not a directory).
778 * That likely will not change.
780 static int read_directory_recursive(struct dir_struct *dir,
781 const char *base, int baselen,
783 const struct path_simplify *simplify)
785 DIR *fdir = opendir(*base ? base : ".");
790 char path[PATH_MAX + 1];
791 memcpy(path, base, baselen);
793 while ((de = readdir(fdir)) != NULL) {
795 switch (treat_path(dir, de, path, sizeof(path),
796 baselen, simplify, &len)) {
798 contents += read_directory_recursive
799 (dir, path, len, 0, simplify);
810 dir_add_name(dir, path, len);
819 static int cmp_name(const void *p1, const void *p2)
821 const struct dir_entry *e1 = *(const struct dir_entry **)p1;
822 const struct dir_entry *e2 = *(const struct dir_entry **)p2;
824 return cache_name_compare(e1->name, e1->len,
829 * Return the length of the "simple" part of a path match limiter.
831 static int simple_length(const char *match)
836 unsigned char c = *match++;
838 if (c == '\0' || is_glob_special(c))
843 static struct path_simplify *create_simplify(const char **pathspec)
846 struct path_simplify *simplify = NULL;
851 for (nr = 0 ; ; nr++) {
854 alloc = alloc_nr(alloc);
855 simplify = xrealloc(simplify, alloc * sizeof(*simplify));
860 simplify[nr].path = match;
861 simplify[nr].len = simple_length(match);
863 simplify[nr].path = NULL;
864 simplify[nr].len = 0;
868 static void free_simplify(struct path_simplify *simplify)
873 static int treat_leading_path(struct dir_struct *dir,
874 const char *path, int len,
875 const struct path_simplify *simplify)
877 char pathbuf[PATH_MAX];
881 while (len && path[len - 1] == '/')
887 cp = path + baselen + !!baselen;
888 cp = memchr(cp, '/', path + len - cp);
893 memcpy(pathbuf, path, baselen);
894 pathbuf[baselen] = '\0';
895 if (!is_directory(pathbuf))
897 if (simplify_away(pathbuf, baselen, simplify))
900 if (treat_one_path(dir, pathbuf, &blen, simplify,
901 DT_DIR, NULL) == path_ignored)
902 return 0; /* do not recurse into it */
904 return 1; /* finished checking */
908 int read_directory(struct dir_struct *dir, const char *path, int len, const char **pathspec)
910 struct path_simplify *simplify;
912 if (has_symlink_leading_path(path, len))
915 simplify = create_simplify(pathspec);
916 if (!len || treat_leading_path(dir, path, len, simplify))
917 read_directory_recursive(dir, path, len, 0, simplify);
918 free_simplify(simplify);
919 qsort(dir->entries, dir->nr, sizeof(struct dir_entry *), cmp_name);
920 qsort(dir->ignored, dir->ignored_nr, sizeof(struct dir_entry *), cmp_name);
924 int file_exists(const char *f)
927 return lstat(f, &sb) == 0;
931 * get_relative_cwd() gets the prefix of the current working directory
932 * relative to 'dir'. If we are not inside 'dir', it returns NULL.
934 * As a convenience, it also returns NULL if 'dir' is already NULL. The
935 * reason for this behaviour is that it is natural for functions returning
936 * directory names to return NULL to say "this directory does not exist"
937 * or "this directory is invalid". These cases are usually handled the
938 * same as if the cwd is not inside 'dir' at all, so get_relative_cwd()
939 * returns NULL for both of them.
941 * Most notably, get_relative_cwd(buffer, size, get_git_work_tree())
942 * unifies the handling of "outside work tree" with "no work tree at all".
944 char *get_relative_cwd(char *buffer, int size, const char *dir)
950 if (!getcwd(buffer, size))
951 die_errno("can't find the current directory");
953 if (!is_absolute_path(dir))
954 dir = make_absolute_path(dir);
956 while (*dir && *dir == *cwd) {
972 int is_inside_dir(const char *dir)
974 char buffer[PATH_MAX];
975 return get_relative_cwd(buffer, sizeof(buffer), dir) != NULL;
978 int is_empty_dir(const char *path)
980 DIR *dir = opendir(path);
987 while ((e = readdir(dir)) != NULL)
988 if (!is_dot_or_dotdot(e->d_name)) {
997 int remove_dir_recursively(struct strbuf *path, int flag)
1001 int ret = 0, original_len = path->len, len;
1002 int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
1003 unsigned char submodule_head[20];
1005 if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
1006 !resolve_gitlink_ref(path->buf, "HEAD", submodule_head))
1007 /* Do not descend and nuke a nested git work tree. */
1010 dir = opendir(path->buf);
1013 if (path->buf[original_len - 1] != '/')
1014 strbuf_addch(path, '/');
1017 while ((e = readdir(dir)) != NULL) {
1019 if (is_dot_or_dotdot(e->d_name))
1022 strbuf_setlen(path, len);
1023 strbuf_addstr(path, e->d_name);
1024 if (lstat(path->buf, &st))
1026 else if (S_ISDIR(st.st_mode)) {
1027 if (!remove_dir_recursively(path, only_empty))
1028 continue; /* happy */
1029 } else if (!only_empty && !unlink(path->buf))
1030 continue; /* happy, too */
1032 /* path too long, stat fails, or non-directory still exists */
1038 strbuf_setlen(path, original_len);
1040 ret = rmdir(path->buf);
1044 void setup_standard_excludes(struct dir_struct *dir)
1048 dir->exclude_per_dir = ".gitignore";
1049 path = git_path("info/exclude");
1050 if (!access(path, R_OK))
1051 add_excludes_from_file(dir, path);
1052 if (excludes_file && !access(excludes_file, R_OK))
1053 add_excludes_from_file(dir, excludes_file);
1056 int remove_path(const char *name)
1060 if (unlink(name) && errno != ENOENT)
1063 slash = strrchr(name, '/');
1065 char *dirs = xstrdup(name);
1066 slash = dirs + (slash - name);
1069 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));