Start preparing for 1.8.4.2
[alt-git.git] / dir.c
blob910bfcde4e432fae3bf57ec951258bc5a02bebb6
1 /*
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
9 */
10 #include "cache.h"
11 #include "dir.h"
12 #include "refs.h"
13 #include "wildmatch.h"
15 struct path_simplify {
16 int len;
17 const char *path;
21 * Tells read_directory_recursive how a file or directory should be treated.
22 * Values are ordered by significance, e.g. if a directory contains both
23 * excluded and untracked files, it is listed as untracked because
24 * path_untracked > path_excluded.
26 enum path_treatment {
27 path_none = 0,
28 path_recurse,
29 path_excluded,
30 path_untracked
33 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
34 const char *path, int len,
35 int check_only, const struct path_simplify *simplify);
36 static int get_dtype(struct dirent *de, const char *path, int len);
38 /* helper string functions with support for the ignore_case flag */
39 int strcmp_icase(const char *a, const char *b)
41 return ignore_case ? strcasecmp(a, b) : strcmp(a, b);
44 int strncmp_icase(const char *a, const char *b, size_t count)
46 return ignore_case ? strncasecmp(a, b, count) : strncmp(a, b, count);
49 int fnmatch_icase(const char *pattern, const char *string, int flags)
51 return fnmatch(pattern, string, flags | (ignore_case ? FNM_CASEFOLD : 0));
54 inline int git_fnmatch(const char *pattern, const char *string,
55 int flags, int prefix)
57 int fnm_flags = 0;
58 if (flags & GFNM_PATHNAME)
59 fnm_flags |= FNM_PATHNAME;
60 if (prefix > 0) {
61 if (strncmp(pattern, string, prefix))
62 return FNM_NOMATCH;
63 pattern += prefix;
64 string += prefix;
66 if (flags & GFNM_ONESTAR) {
67 int pattern_len = strlen(++pattern);
68 int string_len = strlen(string);
69 return string_len < pattern_len ||
70 strcmp(pattern,
71 string + string_len - pattern_len);
73 return fnmatch(pattern, string, fnm_flags);
76 static int fnmatch_icase_mem(const char *pattern, int patternlen,
77 const char *string, int stringlen,
78 int flags)
80 int match_status;
81 struct strbuf pat_buf = STRBUF_INIT;
82 struct strbuf str_buf = STRBUF_INIT;
83 const char *use_pat = pattern;
84 const char *use_str = string;
86 if (pattern[patternlen]) {
87 strbuf_add(&pat_buf, pattern, patternlen);
88 use_pat = pat_buf.buf;
90 if (string[stringlen]) {
91 strbuf_add(&str_buf, string, stringlen);
92 use_str = str_buf.buf;
95 if (ignore_case)
96 flags |= WM_CASEFOLD;
97 match_status = wildmatch(use_pat, use_str, flags, NULL);
99 strbuf_release(&pat_buf);
100 strbuf_release(&str_buf);
102 return match_status;
105 static size_t common_prefix_len(const char **pathspec)
107 const char *n, *first;
108 size_t max = 0;
109 int literal = limit_pathspec_to_literal();
111 if (!pathspec)
112 return max;
114 first = *pathspec;
115 while ((n = *pathspec++)) {
116 size_t i, len = 0;
117 for (i = 0; first == n || i < max; i++) {
118 char c = n[i];
119 if (!c || c != first[i] || (!literal && is_glob_special(c)))
120 break;
121 if (c == '/')
122 len = i + 1;
124 if (first == n || len < max) {
125 max = len;
126 if (!max)
127 break;
130 return max;
134 * Returns a copy of the longest leading path common among all
135 * pathspecs.
137 char *common_prefix(const char **pathspec)
139 unsigned long len = common_prefix_len(pathspec);
141 return len ? xmemdupz(*pathspec, len) : NULL;
144 int fill_directory(struct dir_struct *dir, const char **pathspec)
146 size_t len;
149 * Calculate common prefix for the pathspec, and
150 * use that to optimize the directory walk
152 len = common_prefix_len(pathspec);
154 /* Read the directory and prune it */
155 read_directory(dir, pathspec ? *pathspec : "", len, pathspec);
156 return len;
159 int within_depth(const char *name, int namelen,
160 int depth, int max_depth)
162 const char *cp = name, *cpe = name + namelen;
164 while (cp < cpe) {
165 if (*cp++ != '/')
166 continue;
167 depth++;
168 if (depth > max_depth)
169 return 0;
171 return 1;
175 * Does 'match' match the given name?
176 * A match is found if
178 * (1) the 'match' string is leading directory of 'name', or
179 * (2) the 'match' string is a wildcard and matches 'name', or
180 * (3) the 'match' string is exactly the same as 'name'.
182 * and the return value tells which case it was.
184 * It returns 0 when there is no match.
186 static int match_one(const char *match, const char *name, int namelen)
188 int matchlen;
189 int literal = limit_pathspec_to_literal();
191 /* If the match was just the prefix, we matched */
192 if (!*match)
193 return MATCHED_RECURSIVELY;
195 if (ignore_case) {
196 for (;;) {
197 unsigned char c1 = tolower(*match);
198 unsigned char c2 = tolower(*name);
199 if (c1 == '\0' || (!literal && is_glob_special(c1)))
200 break;
201 if (c1 != c2)
202 return 0;
203 match++;
204 name++;
205 namelen--;
207 } else {
208 for (;;) {
209 unsigned char c1 = *match;
210 unsigned char c2 = *name;
211 if (c1 == '\0' || (!literal && is_glob_special(c1)))
212 break;
213 if (c1 != c2)
214 return 0;
215 match++;
216 name++;
217 namelen--;
222 * If we don't match the matchstring exactly,
223 * we need to match by fnmatch
225 matchlen = strlen(match);
226 if (strncmp_icase(match, name, matchlen)) {
227 if (literal)
228 return 0;
229 return !fnmatch_icase(match, name, 0) ? MATCHED_FNMATCH : 0;
232 if (namelen == matchlen)
233 return MATCHED_EXACTLY;
234 if (match[matchlen-1] == '/' || name[matchlen] == '/')
235 return MATCHED_RECURSIVELY;
236 return 0;
240 * Given a name and a list of pathspecs, returns the nature of the
241 * closest (i.e. most specific) match of the name to any of the
242 * pathspecs.
244 * The caller typically calls this multiple times with the same
245 * pathspec and seen[] array but with different name/namelen
246 * (e.g. entries from the index) and is interested in seeing if and
247 * how each pathspec matches all the names it calls this function
248 * with. A mark is left in the seen[] array for each pathspec element
249 * indicating the closest type of match that element achieved, so if
250 * seen[n] remains zero after multiple invocations, that means the nth
251 * pathspec did not match any names, which could indicate that the
252 * user mistyped the nth pathspec.
254 int match_pathspec(const char **pathspec, const char *name, int namelen,
255 int prefix, char *seen)
257 int i, retval = 0;
259 if (!pathspec)
260 return 1;
262 name += prefix;
263 namelen -= prefix;
265 for (i = 0; pathspec[i] != NULL; i++) {
266 int how;
267 const char *match = pathspec[i] + prefix;
268 if (seen && seen[i] == MATCHED_EXACTLY)
269 continue;
270 how = match_one(match, name, namelen);
271 if (how) {
272 if (retval < how)
273 retval = how;
274 if (seen && seen[i] < how)
275 seen[i] = how;
278 return retval;
282 * Does 'match' match the given name?
283 * A match is found if
285 * (1) the 'match' string is leading directory of 'name', or
286 * (2) the 'match' string is a wildcard and matches 'name', or
287 * (3) the 'match' string is exactly the same as 'name'.
289 * and the return value tells which case it was.
291 * It returns 0 when there is no match.
293 static int match_pathspec_item(const struct pathspec_item *item, int prefix,
294 const char *name, int namelen)
296 /* name/namelen has prefix cut off by caller */
297 const char *match = item->match + prefix;
298 int matchlen = item->len - prefix;
300 /* If the match was just the prefix, we matched */
301 if (!*match)
302 return MATCHED_RECURSIVELY;
304 if (matchlen <= namelen && !strncmp(match, name, matchlen)) {
305 if (matchlen == namelen)
306 return MATCHED_EXACTLY;
308 if (match[matchlen-1] == '/' || name[matchlen] == '/')
309 return MATCHED_RECURSIVELY;
312 if (item->nowildcard_len < item->len &&
313 !git_fnmatch(match, name,
314 item->flags & PATHSPEC_ONESTAR ? GFNM_ONESTAR : 0,
315 item->nowildcard_len - prefix))
316 return MATCHED_FNMATCH;
318 return 0;
322 * Given a name and a list of pathspecs, returns the nature of the
323 * closest (i.e. most specific) match of the name to any of the
324 * pathspecs.
326 * The caller typically calls this multiple times with the same
327 * pathspec and seen[] array but with different name/namelen
328 * (e.g. entries from the index) and is interested in seeing if and
329 * how each pathspec matches all the names it calls this function
330 * with. A mark is left in the seen[] array for each pathspec element
331 * indicating the closest type of match that element achieved, so if
332 * seen[n] remains zero after multiple invocations, that means the nth
333 * pathspec did not match any names, which could indicate that the
334 * user mistyped the nth pathspec.
336 int match_pathspec_depth(const struct pathspec *ps,
337 const char *name, int namelen,
338 int prefix, char *seen)
340 int i, retval = 0;
342 if (!ps->nr) {
343 if (!ps->recursive || ps->max_depth == -1)
344 return MATCHED_RECURSIVELY;
346 if (within_depth(name, namelen, 0, ps->max_depth))
347 return MATCHED_EXACTLY;
348 else
349 return 0;
352 name += prefix;
353 namelen -= prefix;
355 for (i = ps->nr - 1; i >= 0; i--) {
356 int how;
357 if (seen && seen[i] == MATCHED_EXACTLY)
358 continue;
359 how = match_pathspec_item(ps->items+i, prefix, name, namelen);
360 if (ps->recursive && ps->max_depth != -1 &&
361 how && how != MATCHED_FNMATCH) {
362 int len = ps->items[i].len;
363 if (name[len] == '/')
364 len++;
365 if (within_depth(name+len, namelen-len, 0, ps->max_depth))
366 how = MATCHED_EXACTLY;
367 else
368 how = 0;
370 if (how) {
371 if (retval < how)
372 retval = how;
373 if (seen && seen[i] < how)
374 seen[i] = how;
377 return retval;
381 * Return the length of the "simple" part of a path match limiter.
383 static int simple_length(const char *match)
385 int len = -1;
387 for (;;) {
388 unsigned char c = *match++;
389 len++;
390 if (c == '\0' || is_glob_special(c))
391 return len;
395 static int no_wildcard(const char *string)
397 return string[simple_length(string)] == '\0';
400 void parse_exclude_pattern(const char **pattern,
401 int *patternlen,
402 int *flags,
403 int *nowildcardlen)
405 const char *p = *pattern;
406 size_t i, len;
408 *flags = 0;
409 if (*p == '!') {
410 *flags |= EXC_FLAG_NEGATIVE;
411 p++;
413 len = strlen(p);
414 if (len && p[len - 1] == '/') {
415 len--;
416 *flags |= EXC_FLAG_MUSTBEDIR;
418 for (i = 0; i < len; i++) {
419 if (p[i] == '/')
420 break;
422 if (i == len)
423 *flags |= EXC_FLAG_NODIR;
424 *nowildcardlen = simple_length(p);
426 * we should have excluded the trailing slash from 'p' too,
427 * but that's one more allocation. Instead just make sure
428 * nowildcardlen does not exceed real patternlen
430 if (*nowildcardlen > len)
431 *nowildcardlen = len;
432 if (*p == '*' && no_wildcard(p + 1))
433 *flags |= EXC_FLAG_ENDSWITH;
434 *pattern = p;
435 *patternlen = len;
438 void add_exclude(const char *string, const char *base,
439 int baselen, struct exclude_list *el, int srcpos)
441 struct exclude *x;
442 int patternlen;
443 int flags;
444 int nowildcardlen;
446 parse_exclude_pattern(&string, &patternlen, &flags, &nowildcardlen);
447 if (flags & EXC_FLAG_MUSTBEDIR) {
448 char *s;
449 x = xmalloc(sizeof(*x) + patternlen + 1);
450 s = (char *)(x+1);
451 memcpy(s, string, patternlen);
452 s[patternlen] = '\0';
453 x->pattern = s;
454 } else {
455 x = xmalloc(sizeof(*x));
456 x->pattern = string;
458 x->patternlen = patternlen;
459 x->nowildcardlen = nowildcardlen;
460 x->base = base;
461 x->baselen = baselen;
462 x->flags = flags;
463 x->srcpos = srcpos;
464 ALLOC_GROW(el->excludes, el->nr + 1, el->alloc);
465 el->excludes[el->nr++] = x;
466 x->el = el;
469 static void *read_skip_worktree_file_from_index(const char *path, size_t *size)
471 int pos, len;
472 unsigned long sz;
473 enum object_type type;
474 void *data;
475 struct index_state *istate = &the_index;
477 len = strlen(path);
478 pos = index_name_pos(istate, path, len);
479 if (pos < 0)
480 return NULL;
481 if (!ce_skip_worktree(istate->cache[pos]))
482 return NULL;
483 data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
484 if (!data || type != OBJ_BLOB) {
485 free(data);
486 return NULL;
488 *size = xsize_t(sz);
489 return data;
493 * Frees memory within el which was allocated for exclude patterns and
494 * the file buffer. Does not free el itself.
496 void clear_exclude_list(struct exclude_list *el)
498 int i;
500 for (i = 0; i < el->nr; i++)
501 free(el->excludes[i]);
502 free(el->excludes);
503 free(el->filebuf);
505 el->nr = 0;
506 el->excludes = NULL;
507 el->filebuf = NULL;
510 int add_excludes_from_file_to_list(const char *fname,
511 const char *base,
512 int baselen,
513 struct exclude_list *el,
514 int check_index)
516 struct stat st;
517 int fd, i, lineno = 1;
518 size_t size = 0;
519 char *buf, *entry;
521 fd = open(fname, O_RDONLY);
522 if (fd < 0 || fstat(fd, &st) < 0) {
523 if (errno != ENOENT)
524 warn_on_inaccessible(fname);
525 if (0 <= fd)
526 close(fd);
527 if (!check_index ||
528 (buf = read_skip_worktree_file_from_index(fname, &size)) == NULL)
529 return -1;
530 if (size == 0) {
531 free(buf);
532 return 0;
534 if (buf[size-1] != '\n') {
535 buf = xrealloc(buf, size+1);
536 buf[size++] = '\n';
539 else {
540 size = xsize_t(st.st_size);
541 if (size == 0) {
542 close(fd);
543 return 0;
545 buf = xmalloc(size+1);
546 if (read_in_full(fd, buf, size) != size) {
547 free(buf);
548 close(fd);
549 return -1;
551 buf[size++] = '\n';
552 close(fd);
555 el->filebuf = buf;
556 entry = buf;
557 for (i = 0; i < size; i++) {
558 if (buf[i] == '\n') {
559 if (entry != buf + i && entry[0] != '#') {
560 buf[i - (i && buf[i-1] == '\r')] = 0;
561 add_exclude(entry, base, baselen, el, lineno);
563 lineno++;
564 entry = buf + i + 1;
567 return 0;
570 struct exclude_list *add_exclude_list(struct dir_struct *dir,
571 int group_type, const char *src)
573 struct exclude_list *el;
574 struct exclude_list_group *group;
576 group = &dir->exclude_list_group[group_type];
577 ALLOC_GROW(group->el, group->nr + 1, group->alloc);
578 el = &group->el[group->nr++];
579 memset(el, 0, sizeof(*el));
580 el->src = src;
581 return el;
585 * Used to set up core.excludesfile and .git/info/exclude lists.
587 void add_excludes_from_file(struct dir_struct *dir, const char *fname)
589 struct exclude_list *el;
590 el = add_exclude_list(dir, EXC_FILE, fname);
591 if (add_excludes_from_file_to_list(fname, "", 0, el, 0) < 0)
592 die("cannot use %s as an exclude file", fname);
595 int match_basename(const char *basename, int basenamelen,
596 const char *pattern, int prefix, int patternlen,
597 int flags)
599 if (prefix == patternlen) {
600 if (patternlen == basenamelen &&
601 !strncmp_icase(pattern, basename, basenamelen))
602 return 1;
603 } else if (flags & EXC_FLAG_ENDSWITH) {
604 /* "*literal" matching against "fooliteral" */
605 if (patternlen - 1 <= basenamelen &&
606 !strncmp_icase(pattern + 1,
607 basename + basenamelen - (patternlen - 1),
608 patternlen - 1))
609 return 1;
610 } else {
611 if (fnmatch_icase_mem(pattern, patternlen,
612 basename, basenamelen,
613 0) == 0)
614 return 1;
616 return 0;
619 int match_pathname(const char *pathname, int pathlen,
620 const char *base, int baselen,
621 const char *pattern, int prefix, int patternlen,
622 int flags)
624 const char *name;
625 int namelen;
628 * match with FNM_PATHNAME; the pattern has base implicitly
629 * in front of it.
631 if (*pattern == '/') {
632 pattern++;
633 patternlen--;
634 prefix--;
638 * baselen does not count the trailing slash. base[] may or
639 * may not end with a trailing slash though.
641 if (pathlen < baselen + 1 ||
642 (baselen && pathname[baselen] != '/') ||
643 strncmp_icase(pathname, base, baselen))
644 return 0;
646 namelen = baselen ? pathlen - baselen - 1 : pathlen;
647 name = pathname + pathlen - namelen;
649 if (prefix) {
651 * if the non-wildcard part is longer than the
652 * remaining pathname, surely it cannot match.
654 if (prefix > namelen)
655 return 0;
657 if (strncmp_icase(pattern, name, prefix))
658 return 0;
659 pattern += prefix;
660 patternlen -= prefix;
661 name += prefix;
662 namelen -= prefix;
665 * If the whole pattern did not have a wildcard,
666 * then our prefix match is all we need; we
667 * do not need to call fnmatch at all.
669 if (!patternlen && !namelen)
670 return 1;
673 return fnmatch_icase_mem(pattern, patternlen,
674 name, namelen,
675 WM_PATHNAME) == 0;
679 * Scan the given exclude list in reverse to see whether pathname
680 * should be ignored. The first match (i.e. the last on the list), if
681 * any, determines the fate. Returns the exclude_list element which
682 * matched, or NULL for undecided.
684 static struct exclude *last_exclude_matching_from_list(const char *pathname,
685 int pathlen,
686 const char *basename,
687 int *dtype,
688 struct exclude_list *el)
690 int i;
692 if (!el->nr)
693 return NULL; /* undefined */
695 for (i = el->nr - 1; 0 <= i; i--) {
696 struct exclude *x = el->excludes[i];
697 const char *exclude = x->pattern;
698 int prefix = x->nowildcardlen;
700 if (x->flags & EXC_FLAG_MUSTBEDIR) {
701 if (*dtype == DT_UNKNOWN)
702 *dtype = get_dtype(NULL, pathname, pathlen);
703 if (*dtype != DT_DIR)
704 continue;
707 if (x->flags & EXC_FLAG_NODIR) {
708 if (match_basename(basename,
709 pathlen - (basename - pathname),
710 exclude, prefix, x->patternlen,
711 x->flags))
712 return x;
713 continue;
716 assert(x->baselen == 0 || x->base[x->baselen - 1] == '/');
717 if (match_pathname(pathname, pathlen,
718 x->base, x->baselen ? x->baselen - 1 : 0,
719 exclude, prefix, x->patternlen, x->flags))
720 return x;
722 return NULL; /* undecided */
726 * Scan the list and let the last match determine the fate.
727 * Return 1 for exclude, 0 for include and -1 for undecided.
729 int is_excluded_from_list(const char *pathname,
730 int pathlen, const char *basename, int *dtype,
731 struct exclude_list *el)
733 struct exclude *exclude;
734 exclude = last_exclude_matching_from_list(pathname, pathlen, basename, dtype, el);
735 if (exclude)
736 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
737 return -1; /* undecided */
740 static struct exclude *last_exclude_matching_from_lists(struct dir_struct *dir,
741 const char *pathname, int pathlen, const char *basename,
742 int *dtype_p)
744 int i, j;
745 struct exclude_list_group *group;
746 struct exclude *exclude;
747 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
748 group = &dir->exclude_list_group[i];
749 for (j = group->nr - 1; j >= 0; j--) {
750 exclude = last_exclude_matching_from_list(
751 pathname, pathlen, basename, dtype_p,
752 &group->el[j]);
753 if (exclude)
754 return exclude;
757 return NULL;
761 * Loads the per-directory exclude list for the substring of base
762 * which has a char length of baselen.
764 static void prep_exclude(struct dir_struct *dir, const char *base, int baselen)
766 struct exclude_list_group *group;
767 struct exclude_list *el;
768 struct exclude_stack *stk = NULL;
769 int current;
771 group = &dir->exclude_list_group[EXC_DIRS];
773 /* Pop the exclude lists from the EXCL_DIRS exclude_list_group
774 * which originate from directories not in the prefix of the
775 * path being checked. */
776 while ((stk = dir->exclude_stack) != NULL) {
777 if (stk->baselen <= baselen &&
778 !strncmp(dir->basebuf, base, stk->baselen))
779 break;
780 el = &group->el[dir->exclude_stack->exclude_ix];
781 dir->exclude_stack = stk->prev;
782 dir->exclude = NULL;
783 free((char *)el->src); /* see strdup() below */
784 clear_exclude_list(el);
785 free(stk);
786 group->nr--;
789 /* Skip traversing into sub directories if the parent is excluded */
790 if (dir->exclude)
791 return;
793 /* Read from the parent directories and push them down. */
794 current = stk ? stk->baselen : -1;
795 while (current < baselen) {
796 struct exclude_stack *stk = xcalloc(1, sizeof(*stk));
797 const char *cp;
799 if (current < 0) {
800 cp = base;
801 current = 0;
803 else {
804 cp = strchr(base + current + 1, '/');
805 if (!cp)
806 die("oops in prep_exclude");
807 cp++;
809 stk->prev = dir->exclude_stack;
810 stk->baselen = cp - base;
811 stk->exclude_ix = group->nr;
812 el = add_exclude_list(dir, EXC_DIRS, NULL);
813 memcpy(dir->basebuf + current, base + current,
814 stk->baselen - current);
816 /* Abort if the directory is excluded */
817 if (stk->baselen) {
818 int dt = DT_DIR;
819 dir->basebuf[stk->baselen - 1] = 0;
820 dir->exclude = last_exclude_matching_from_lists(dir,
821 dir->basebuf, stk->baselen - 1,
822 dir->basebuf + current, &dt);
823 dir->basebuf[stk->baselen - 1] = '/';
824 if (dir->exclude &&
825 dir->exclude->flags & EXC_FLAG_NEGATIVE)
826 dir->exclude = NULL;
827 if (dir->exclude) {
828 dir->basebuf[stk->baselen] = 0;
829 dir->exclude_stack = stk;
830 return;
834 /* Try to read per-directory file unless path is too long */
835 if (dir->exclude_per_dir &&
836 stk->baselen + strlen(dir->exclude_per_dir) < PATH_MAX) {
837 strcpy(dir->basebuf + stk->baselen,
838 dir->exclude_per_dir);
840 * dir->basebuf gets reused by the traversal, but we
841 * need fname to remain unchanged to ensure the src
842 * member of each struct exclude correctly
843 * back-references its source file. Other invocations
844 * of add_exclude_list provide stable strings, so we
845 * strdup() and free() here in the caller.
847 el->src = strdup(dir->basebuf);
848 add_excludes_from_file_to_list(dir->basebuf,
849 dir->basebuf, stk->baselen, el, 1);
851 dir->exclude_stack = stk;
852 current = stk->baselen;
854 dir->basebuf[baselen] = '\0';
858 * Loads the exclude lists for the directory containing pathname, then
859 * scans all exclude lists to determine whether pathname is excluded.
860 * Returns the exclude_list element which matched, or NULL for
861 * undecided.
863 struct exclude *last_exclude_matching(struct dir_struct *dir,
864 const char *pathname,
865 int *dtype_p)
867 int pathlen = strlen(pathname);
868 const char *basename = strrchr(pathname, '/');
869 basename = (basename) ? basename+1 : pathname;
871 prep_exclude(dir, pathname, basename-pathname);
873 if (dir->exclude)
874 return dir->exclude;
876 return last_exclude_matching_from_lists(dir, pathname, pathlen,
877 basename, dtype_p);
881 * Loads the exclude lists for the directory containing pathname, then
882 * scans all exclude lists to determine whether pathname is excluded.
883 * Returns 1 if true, otherwise 0.
885 int is_excluded(struct dir_struct *dir, const char *pathname, int *dtype_p)
887 struct exclude *exclude =
888 last_exclude_matching(dir, pathname, dtype_p);
889 if (exclude)
890 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
891 return 0;
894 static struct dir_entry *dir_entry_new(const char *pathname, int len)
896 struct dir_entry *ent;
898 ent = xmalloc(sizeof(*ent) + len + 1);
899 ent->len = len;
900 memcpy(ent->name, pathname, len);
901 ent->name[len] = 0;
902 return ent;
905 static struct dir_entry *dir_add_name(struct dir_struct *dir, const char *pathname, int len)
907 if (cache_name_exists(pathname, len, ignore_case))
908 return NULL;
910 ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
911 return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
914 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len)
916 if (!cache_name_is_other(pathname, len))
917 return NULL;
919 ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
920 return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
923 enum exist_status {
924 index_nonexistent = 0,
925 index_directory,
926 index_gitdir
930 * Do not use the alphabetically stored index to look up
931 * the directory name; instead, use the case insensitive
932 * name hash.
934 static enum exist_status directory_exists_in_index_icase(const char *dirname, int len)
936 const struct cache_entry *ce = index_name_exists(&the_index, dirname, len + 1, ignore_case);
937 unsigned char endchar;
939 if (!ce)
940 return index_nonexistent;
941 endchar = ce->name[len];
944 * The cache_entry structure returned will contain this dirname
945 * and possibly additional path components.
947 if (endchar == '/')
948 return index_directory;
951 * If there are no additional path components, then this cache_entry
952 * represents a submodule. Submodules, despite being directories,
953 * are stored in the cache without a closing slash.
955 if (!endchar && S_ISGITLINK(ce->ce_mode))
956 return index_gitdir;
958 /* This should never be hit, but it exists just in case. */
959 return index_nonexistent;
963 * The index sorts alphabetically by entry name, which
964 * means that a gitlink sorts as '\0' at the end, while
965 * a directory (which is defined not as an entry, but as
966 * the files it contains) will sort with the '/' at the
967 * end.
969 static enum exist_status directory_exists_in_index(const char *dirname, int len)
971 int pos;
973 if (ignore_case)
974 return directory_exists_in_index_icase(dirname, len);
976 pos = cache_name_pos(dirname, len);
977 if (pos < 0)
978 pos = -pos-1;
979 while (pos < active_nr) {
980 const struct cache_entry *ce = active_cache[pos++];
981 unsigned char endchar;
983 if (strncmp(ce->name, dirname, len))
984 break;
985 endchar = ce->name[len];
986 if (endchar > '/')
987 break;
988 if (endchar == '/')
989 return index_directory;
990 if (!endchar && S_ISGITLINK(ce->ce_mode))
991 return index_gitdir;
993 return index_nonexistent;
997 * When we find a directory when traversing the filesystem, we
998 * have three distinct cases:
1000 * - ignore it
1001 * - see it as a directory
1002 * - recurse into it
1004 * and which one we choose depends on a combination of existing
1005 * git index contents and the flags passed into the directory
1006 * traversal routine.
1008 * Case 1: If we *already* have entries in the index under that
1009 * directory name, we always recurse into the directory to see
1010 * all the files.
1012 * Case 2: If we *already* have that directory name as a gitlink,
1013 * we always continue to see it as a gitlink, regardless of whether
1014 * there is an actual git directory there or not (it might not
1015 * be checked out as a subproject!)
1017 * Case 3: if we didn't have it in the index previously, we
1018 * have a few sub-cases:
1020 * (a) if "show_other_directories" is true, we show it as
1021 * just a directory, unless "hide_empty_directories" is
1022 * also true, in which case we need to check if it contains any
1023 * untracked and / or ignored files.
1024 * (b) if it looks like a git directory, and we don't have
1025 * 'no_gitlinks' set we treat it as a gitlink, and show it
1026 * as a directory.
1027 * (c) otherwise, we recurse into it.
1029 static enum path_treatment treat_directory(struct dir_struct *dir,
1030 const char *dirname, int len, int exclude,
1031 const struct path_simplify *simplify)
1033 /* The "len-1" is to strip the final '/' */
1034 switch (directory_exists_in_index(dirname, len-1)) {
1035 case index_directory:
1036 return path_recurse;
1038 case index_gitdir:
1039 return path_none;
1041 case index_nonexistent:
1042 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
1043 break;
1044 if (!(dir->flags & DIR_NO_GITLINKS)) {
1045 unsigned char sha1[20];
1046 if (resolve_gitlink_ref(dirname, "HEAD", sha1) == 0)
1047 return path_untracked;
1049 return path_recurse;
1052 /* This is the "show_other_directories" case */
1054 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1055 return exclude ? path_excluded : path_untracked;
1057 return read_directory_recursive(dir, dirname, len, 1, simplify);
1061 * This is an inexact early pruning of any recursive directory
1062 * reading - if the path cannot possibly be in the pathspec,
1063 * return true, and we'll skip it early.
1065 static int simplify_away(const char *path, int pathlen, const struct path_simplify *simplify)
1067 if (simplify) {
1068 for (;;) {
1069 const char *match = simplify->path;
1070 int len = simplify->len;
1072 if (!match)
1073 break;
1074 if (len > pathlen)
1075 len = pathlen;
1076 if (!memcmp(path, match, len))
1077 return 0;
1078 simplify++;
1080 return 1;
1082 return 0;
1086 * This function tells us whether an excluded path matches a
1087 * list of "interesting" pathspecs. That is, whether a path matched
1088 * by any of the pathspecs could possibly be ignored by excluding
1089 * the specified path. This can happen if:
1091 * 1. the path is mentioned explicitly in the pathspec
1093 * 2. the path is a directory prefix of some element in the
1094 * pathspec
1096 static int exclude_matches_pathspec(const char *path, int len,
1097 const struct path_simplify *simplify)
1099 if (simplify) {
1100 for (; simplify->path; simplify++) {
1101 if (len == simplify->len
1102 && !memcmp(path, simplify->path, len))
1103 return 1;
1104 if (len < simplify->len
1105 && simplify->path[len] == '/'
1106 && !memcmp(path, simplify->path, len))
1107 return 1;
1110 return 0;
1113 static int get_index_dtype(const char *path, int len)
1115 int pos;
1116 const struct cache_entry *ce;
1118 ce = cache_name_exists(path, len, 0);
1119 if (ce) {
1120 if (!ce_uptodate(ce))
1121 return DT_UNKNOWN;
1122 if (S_ISGITLINK(ce->ce_mode))
1123 return DT_DIR;
1125 * Nobody actually cares about the
1126 * difference between DT_LNK and DT_REG
1128 return DT_REG;
1131 /* Try to look it up as a directory */
1132 pos = cache_name_pos(path, len);
1133 if (pos >= 0)
1134 return DT_UNKNOWN;
1135 pos = -pos-1;
1136 while (pos < active_nr) {
1137 ce = active_cache[pos++];
1138 if (strncmp(ce->name, path, len))
1139 break;
1140 if (ce->name[len] > '/')
1141 break;
1142 if (ce->name[len] < '/')
1143 continue;
1144 if (!ce_uptodate(ce))
1145 break; /* continue? */
1146 return DT_DIR;
1148 return DT_UNKNOWN;
1151 static int get_dtype(struct dirent *de, const char *path, int len)
1153 int dtype = de ? DTYPE(de) : DT_UNKNOWN;
1154 struct stat st;
1156 if (dtype != DT_UNKNOWN)
1157 return dtype;
1158 dtype = get_index_dtype(path, len);
1159 if (dtype != DT_UNKNOWN)
1160 return dtype;
1161 if (lstat(path, &st))
1162 return dtype;
1163 if (S_ISREG(st.st_mode))
1164 return DT_REG;
1165 if (S_ISDIR(st.st_mode))
1166 return DT_DIR;
1167 if (S_ISLNK(st.st_mode))
1168 return DT_LNK;
1169 return dtype;
1172 static enum path_treatment treat_one_path(struct dir_struct *dir,
1173 struct strbuf *path,
1174 const struct path_simplify *simplify,
1175 int dtype, struct dirent *de)
1177 int exclude;
1178 if (dtype == DT_UNKNOWN)
1179 dtype = get_dtype(de, path->buf, path->len);
1181 /* Always exclude indexed files */
1182 if (dtype != DT_DIR &&
1183 cache_name_exists(path->buf, path->len, ignore_case))
1184 return path_none;
1186 exclude = is_excluded(dir, path->buf, &dtype);
1189 * Excluded? If we don't explicitly want to show
1190 * ignored files, ignore it
1192 if (exclude && !(dir->flags & (DIR_SHOW_IGNORED|DIR_SHOW_IGNORED_TOO)))
1193 return path_excluded;
1195 switch (dtype) {
1196 default:
1197 return path_none;
1198 case DT_DIR:
1199 strbuf_addch(path, '/');
1200 return treat_directory(dir, path->buf, path->len, exclude,
1201 simplify);
1202 case DT_REG:
1203 case DT_LNK:
1204 return exclude ? path_excluded : path_untracked;
1208 static enum path_treatment treat_path(struct dir_struct *dir,
1209 struct dirent *de,
1210 struct strbuf *path,
1211 int baselen,
1212 const struct path_simplify *simplify)
1214 int dtype;
1216 if (is_dot_or_dotdot(de->d_name) || !strcmp(de->d_name, ".git"))
1217 return path_none;
1218 strbuf_setlen(path, baselen);
1219 strbuf_addstr(path, de->d_name);
1220 if (simplify_away(path->buf, path->len, simplify))
1221 return path_none;
1223 dtype = DTYPE(de);
1224 return treat_one_path(dir, path, simplify, dtype, de);
1228 * Read a directory tree. We currently ignore anything but
1229 * directories, regular files and symlinks. That's because git
1230 * doesn't handle them at all yet. Maybe that will change some
1231 * day.
1233 * Also, we ignore the name ".git" (even if it is not a directory).
1234 * That likely will not change.
1236 * Returns the most significant path_treatment value encountered in the scan.
1238 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
1239 const char *base, int baselen,
1240 int check_only,
1241 const struct path_simplify *simplify)
1243 DIR *fdir;
1244 enum path_treatment state, subdir_state, dir_state = path_none;
1245 struct dirent *de;
1246 struct strbuf path = STRBUF_INIT;
1248 strbuf_add(&path, base, baselen);
1250 fdir = opendir(path.len ? path.buf : ".");
1251 if (!fdir)
1252 goto out;
1254 while ((de = readdir(fdir)) != NULL) {
1255 /* check how the file or directory should be treated */
1256 state = treat_path(dir, de, &path, baselen, simplify);
1257 if (state > dir_state)
1258 dir_state = state;
1260 /* recurse into subdir if instructed by treat_path */
1261 if (state == path_recurse) {
1262 subdir_state = read_directory_recursive(dir, path.buf,
1263 path.len, check_only, simplify);
1264 if (subdir_state > dir_state)
1265 dir_state = subdir_state;
1268 if (check_only) {
1269 /* abort early if maximum state has been reached */
1270 if (dir_state == path_untracked)
1271 break;
1272 /* skip the dir_add_* part */
1273 continue;
1276 /* add the path to the appropriate result list */
1277 switch (state) {
1278 case path_excluded:
1279 if (dir->flags & DIR_SHOW_IGNORED)
1280 dir_add_name(dir, path.buf, path.len);
1281 else if ((dir->flags & DIR_SHOW_IGNORED_TOO) ||
1282 ((dir->flags & DIR_COLLECT_IGNORED) &&
1283 exclude_matches_pathspec(path.buf, path.len,
1284 simplify)))
1285 dir_add_ignored(dir, path.buf, path.len);
1286 break;
1288 case path_untracked:
1289 if (!(dir->flags & DIR_SHOW_IGNORED))
1290 dir_add_name(dir, path.buf, path.len);
1291 break;
1293 default:
1294 break;
1297 closedir(fdir);
1298 out:
1299 strbuf_release(&path);
1301 return dir_state;
1304 static int cmp_name(const void *p1, const void *p2)
1306 const struct dir_entry *e1 = *(const struct dir_entry **)p1;
1307 const struct dir_entry *e2 = *(const struct dir_entry **)p2;
1309 return cache_name_compare(e1->name, e1->len,
1310 e2->name, e2->len);
1313 static struct path_simplify *create_simplify(const char **pathspec)
1315 int nr, alloc = 0;
1316 struct path_simplify *simplify = NULL;
1318 if (!pathspec)
1319 return NULL;
1321 for (nr = 0 ; ; nr++) {
1322 const char *match;
1323 if (nr >= alloc) {
1324 alloc = alloc_nr(alloc);
1325 simplify = xrealloc(simplify, alloc * sizeof(*simplify));
1327 match = *pathspec++;
1328 if (!match)
1329 break;
1330 simplify[nr].path = match;
1331 simplify[nr].len = simple_length(match);
1333 simplify[nr].path = NULL;
1334 simplify[nr].len = 0;
1335 return simplify;
1338 static void free_simplify(struct path_simplify *simplify)
1340 free(simplify);
1343 static int treat_leading_path(struct dir_struct *dir,
1344 const char *path, int len,
1345 const struct path_simplify *simplify)
1347 struct strbuf sb = STRBUF_INIT;
1348 int baselen, rc = 0;
1349 const char *cp;
1350 int old_flags = dir->flags;
1352 while (len && path[len - 1] == '/')
1353 len--;
1354 if (!len)
1355 return 1;
1356 baselen = 0;
1357 dir->flags &= ~DIR_SHOW_OTHER_DIRECTORIES;
1358 while (1) {
1359 cp = path + baselen + !!baselen;
1360 cp = memchr(cp, '/', path + len - cp);
1361 if (!cp)
1362 baselen = len;
1363 else
1364 baselen = cp - path;
1365 strbuf_setlen(&sb, 0);
1366 strbuf_add(&sb, path, baselen);
1367 if (!is_directory(sb.buf))
1368 break;
1369 if (simplify_away(sb.buf, sb.len, simplify))
1370 break;
1371 if (treat_one_path(dir, &sb, simplify,
1372 DT_DIR, NULL) == path_none)
1373 break; /* do not recurse into it */
1374 if (len <= baselen) {
1375 rc = 1;
1376 break; /* finished checking */
1379 strbuf_release(&sb);
1380 dir->flags = old_flags;
1381 return rc;
1384 int read_directory(struct dir_struct *dir, const char *path, int len, const char **pathspec)
1386 struct path_simplify *simplify;
1388 if (has_symlink_leading_path(path, len))
1389 return dir->nr;
1391 simplify = create_simplify(pathspec);
1392 if (!len || treat_leading_path(dir, path, len, simplify))
1393 read_directory_recursive(dir, path, len, 0, simplify);
1394 free_simplify(simplify);
1395 qsort(dir->entries, dir->nr, sizeof(struct dir_entry *), cmp_name);
1396 qsort(dir->ignored, dir->ignored_nr, sizeof(struct dir_entry *), cmp_name);
1397 return dir->nr;
1400 int file_exists(const char *f)
1402 struct stat sb;
1403 return lstat(f, &sb) == 0;
1407 * Given two normalized paths (a trailing slash is ok), if subdir is
1408 * outside dir, return -1. Otherwise return the offset in subdir that
1409 * can be used as relative path to dir.
1411 int dir_inside_of(const char *subdir, const char *dir)
1413 int offset = 0;
1415 assert(dir && subdir && *dir && *subdir);
1417 while (*dir && *subdir && *dir == *subdir) {
1418 dir++;
1419 subdir++;
1420 offset++;
1423 /* hel[p]/me vs hel[l]/yeah */
1424 if (*dir && *subdir)
1425 return -1;
1427 if (!*subdir)
1428 return !*dir ? offset : -1; /* same dir */
1430 /* foo/[b]ar vs foo/[] */
1431 if (is_dir_sep(dir[-1]))
1432 return is_dir_sep(subdir[-1]) ? offset : -1;
1434 /* foo[/]bar vs foo[] */
1435 return is_dir_sep(*subdir) ? offset + 1 : -1;
1438 int is_inside_dir(const char *dir)
1440 char cwd[PATH_MAX];
1441 if (!dir)
1442 return 0;
1443 if (!getcwd(cwd, sizeof(cwd)))
1444 die_errno("can't find the current directory");
1445 return dir_inside_of(cwd, dir) >= 0;
1448 int is_empty_dir(const char *path)
1450 DIR *dir = opendir(path);
1451 struct dirent *e;
1452 int ret = 1;
1454 if (!dir)
1455 return 0;
1457 while ((e = readdir(dir)) != NULL)
1458 if (!is_dot_or_dotdot(e->d_name)) {
1459 ret = 0;
1460 break;
1463 closedir(dir);
1464 return ret;
1467 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
1469 DIR *dir;
1470 struct dirent *e;
1471 int ret = 0, original_len = path->len, len, kept_down = 0;
1472 int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
1473 int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
1474 unsigned char submodule_head[20];
1476 if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
1477 !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
1478 /* Do not descend and nuke a nested git work tree. */
1479 if (kept_up)
1480 *kept_up = 1;
1481 return 0;
1484 flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
1485 dir = opendir(path->buf);
1486 if (!dir) {
1487 /* an empty dir could be removed even if it is unreadble */
1488 if (!keep_toplevel)
1489 return rmdir(path->buf);
1490 else
1491 return -1;
1493 if (path->buf[original_len - 1] != '/')
1494 strbuf_addch(path, '/');
1496 len = path->len;
1497 while ((e = readdir(dir)) != NULL) {
1498 struct stat st;
1499 if (is_dot_or_dotdot(e->d_name))
1500 continue;
1502 strbuf_setlen(path, len);
1503 strbuf_addstr(path, e->d_name);
1504 if (lstat(path->buf, &st))
1505 ; /* fall thru */
1506 else if (S_ISDIR(st.st_mode)) {
1507 if (!remove_dir_recurse(path, flag, &kept_down))
1508 continue; /* happy */
1509 } else if (!only_empty && !unlink(path->buf))
1510 continue; /* happy, too */
1512 /* path too long, stat fails, or non-directory still exists */
1513 ret = -1;
1514 break;
1516 closedir(dir);
1518 strbuf_setlen(path, original_len);
1519 if (!ret && !keep_toplevel && !kept_down)
1520 ret = rmdir(path->buf);
1521 else if (kept_up)
1523 * report the uplevel that it is not an error that we
1524 * did not rmdir() our directory.
1526 *kept_up = !ret;
1527 return ret;
1530 int remove_dir_recursively(struct strbuf *path, int flag)
1532 return remove_dir_recurse(path, flag, NULL);
1535 void setup_standard_excludes(struct dir_struct *dir)
1537 const char *path;
1538 char *xdg_path;
1540 dir->exclude_per_dir = ".gitignore";
1541 path = git_path("info/exclude");
1542 if (!excludes_file) {
1543 home_config_paths(NULL, &xdg_path, "ignore");
1544 excludes_file = xdg_path;
1546 if (!access_or_warn(path, R_OK, 0))
1547 add_excludes_from_file(dir, path);
1548 if (excludes_file && !access_or_warn(excludes_file, R_OK, 0))
1549 add_excludes_from_file(dir, excludes_file);
1552 int remove_path(const char *name)
1554 char *slash;
1556 if (unlink(name) && errno != ENOENT && errno != ENOTDIR)
1557 return -1;
1559 slash = strrchr(name, '/');
1560 if (slash) {
1561 char *dirs = xstrdup(name);
1562 slash = dirs + (slash - name);
1563 do {
1564 *slash = '\0';
1565 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
1566 free(dirs);
1568 return 0;
1571 static int pathspec_item_cmp(const void *a_, const void *b_)
1573 struct pathspec_item *a, *b;
1575 a = (struct pathspec_item *)a_;
1576 b = (struct pathspec_item *)b_;
1577 return strcmp(a->match, b->match);
1580 int init_pathspec(struct pathspec *pathspec, const char **paths)
1582 const char **p = paths;
1583 int i;
1585 memset(pathspec, 0, sizeof(*pathspec));
1586 if (!p)
1587 return 0;
1588 while (*p)
1589 p++;
1590 pathspec->raw = paths;
1591 pathspec->nr = p - paths;
1592 if (!pathspec->nr)
1593 return 0;
1595 pathspec->items = xmalloc(sizeof(struct pathspec_item)*pathspec->nr);
1596 for (i = 0; i < pathspec->nr; i++) {
1597 struct pathspec_item *item = pathspec->items+i;
1598 const char *path = paths[i];
1600 item->match = path;
1601 item->len = strlen(path);
1602 item->flags = 0;
1603 if (limit_pathspec_to_literal()) {
1604 item->nowildcard_len = item->len;
1605 } else {
1606 item->nowildcard_len = simple_length(path);
1607 if (item->nowildcard_len < item->len) {
1608 pathspec->has_wildcard = 1;
1609 if (path[item->nowildcard_len] == '*' &&
1610 no_wildcard(path + item->nowildcard_len + 1))
1611 item->flags |= PATHSPEC_ONESTAR;
1616 qsort(pathspec->items, pathspec->nr,
1617 sizeof(struct pathspec_item), pathspec_item_cmp);
1619 return 0;
1622 void free_pathspec(struct pathspec *pathspec)
1624 free(pathspec->items);
1625 pathspec->items = NULL;
1628 int limit_pathspec_to_literal(void)
1630 static int flag = -1;
1631 if (flag < 0)
1632 flag = git_env_bool(GIT_LITERAL_PATHSPECS_ENVIRONMENT, 0);
1633 return flag;
1637 * Frees memory within dir which was allocated for exclude lists and
1638 * the exclude_stack. Does not free dir itself.
1640 void clear_directory(struct dir_struct *dir)
1642 int i, j;
1643 struct exclude_list_group *group;
1644 struct exclude_list *el;
1645 struct exclude_stack *stk;
1647 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
1648 group = &dir->exclude_list_group[i];
1649 for (j = 0; j < group->nr; j++) {
1650 el = &group->el[j];
1651 if (i == EXC_DIRS)
1652 free((char *)el->src);
1653 clear_exclude_list(el);
1655 free(group->el);
1658 stk = dir->exclude_stack;
1659 while (stk) {
1660 struct exclude_stack *prev = stk->prev;
1661 free(stk);
1662 stk = prev;