Merge branch 'nd/wildmatch'
[git] / dir.c
1 /*
2  * This handles recursive filename detection with exclude
3  * files, index knowledge etc..
4  *
5  * Copyright (C) Linus Torvalds, 2005-2006
6  *               Junio Hamano, 2005-2006
7  */
8 #include "cache.h"
9 #include "dir.h"
10 #include "refs.h"
11 #include "wildmatch.h"
12
13 struct path_simplify {
14         int len;
15         const char *path;
16 };
17
18 static int read_directory_recursive(struct dir_struct *dir, const char *path, int len,
19         int check_only, const struct path_simplify *simplify);
20 static int get_dtype(struct dirent *de, const char *path, int len);
21
22 /* helper string functions with support for the ignore_case flag */
23 int strcmp_icase(const char *a, const char *b)
24 {
25         return ignore_case ? strcasecmp(a, b) : strcmp(a, b);
26 }
27
28 int strncmp_icase(const char *a, const char *b, size_t count)
29 {
30         return ignore_case ? strncasecmp(a, b, count) : strncmp(a, b, count);
31 }
32
33 int fnmatch_icase(const char *pattern, const char *string, int flags)
34 {
35         return fnmatch(pattern, string, flags | (ignore_case ? FNM_CASEFOLD : 0));
36 }
37
38 inline int git_fnmatch(const char *pattern, const char *string,
39                        int flags, int prefix)
40 {
41         int fnm_flags = 0;
42         if (flags & GFNM_PATHNAME)
43                 fnm_flags |= FNM_PATHNAME;
44         if (prefix > 0) {
45                 if (strncmp(pattern, string, prefix))
46                         return FNM_NOMATCH;
47                 pattern += prefix;
48                 string += prefix;
49         }
50         if (flags & GFNM_ONESTAR) {
51                 int pattern_len = strlen(++pattern);
52                 int string_len = strlen(string);
53                 return string_len < pattern_len ||
54                        strcmp(pattern,
55                               string + string_len - pattern_len);
56         }
57         return fnmatch(pattern, string, fnm_flags);
58 }
59
60 static size_t common_prefix_len(const char **pathspec)
61 {
62         const char *n, *first;
63         size_t max = 0;
64         int literal = limit_pathspec_to_literal();
65
66         if (!pathspec)
67                 return max;
68
69         first = *pathspec;
70         while ((n = *pathspec++)) {
71                 size_t i, len = 0;
72                 for (i = 0; first == n || i < max; i++) {
73                         char c = n[i];
74                         if (!c || c != first[i] || (!literal && is_glob_special(c)))
75                                 break;
76                         if (c == '/')
77                                 len = i + 1;
78                 }
79                 if (first == n || len < max) {
80                         max = len;
81                         if (!max)
82                                 break;
83                 }
84         }
85         return max;
86 }
87
88 /*
89  * Returns a copy of the longest leading path common among all
90  * pathspecs.
91  */
92 char *common_prefix(const char **pathspec)
93 {
94         unsigned long len = common_prefix_len(pathspec);
95
96         return len ? xmemdupz(*pathspec, len) : NULL;
97 }
98
99 int fill_directory(struct dir_struct *dir, const char **pathspec)
100 {
101         size_t len;
102
103         /*
104          * Calculate common prefix for the pathspec, and
105          * use that to optimize the directory walk
106          */
107         len = common_prefix_len(pathspec);
108
109         /* Read the directory and prune it */
110         read_directory(dir, pathspec ? *pathspec : "", len, pathspec);
111         return len;
112 }
113
114 int within_depth(const char *name, int namelen,
115                         int depth, int max_depth)
116 {
117         const char *cp = name, *cpe = name + namelen;
118
119         while (cp < cpe) {
120                 if (*cp++ != '/')
121                         continue;
122                 depth++;
123                 if (depth > max_depth)
124                         return 0;
125         }
126         return 1;
127 }
128
129 /*
130  * Does 'match' match the given name?
131  * A match is found if
132  *
133  * (1) the 'match' string is leading directory of 'name', or
134  * (2) the 'match' string is a wildcard and matches 'name', or
135  * (3) the 'match' string is exactly the same as 'name'.
136  *
137  * and the return value tells which case it was.
138  *
139  * It returns 0 when there is no match.
140  */
141 static int match_one(const char *match, const char *name, int namelen)
142 {
143         int matchlen;
144         int literal = limit_pathspec_to_literal();
145
146         /* If the match was just the prefix, we matched */
147         if (!*match)
148                 return MATCHED_RECURSIVELY;
149
150         if (ignore_case) {
151                 for (;;) {
152                         unsigned char c1 = tolower(*match);
153                         unsigned char c2 = tolower(*name);
154                         if (c1 == '\0' || (!literal && is_glob_special(c1)))
155                                 break;
156                         if (c1 != c2)
157                                 return 0;
158                         match++;
159                         name++;
160                         namelen--;
161                 }
162         } else {
163                 for (;;) {
164                         unsigned char c1 = *match;
165                         unsigned char c2 = *name;
166                         if (c1 == '\0' || (!literal && is_glob_special(c1)))
167                                 break;
168                         if (c1 != c2)
169                                 return 0;
170                         match++;
171                         name++;
172                         namelen--;
173                 }
174         }
175
176         /*
177          * If we don't match the matchstring exactly,
178          * we need to match by fnmatch
179          */
180         matchlen = strlen(match);
181         if (strncmp_icase(match, name, matchlen)) {
182                 if (literal)
183                         return 0;
184                 return !fnmatch_icase(match, name, 0) ? MATCHED_FNMATCH : 0;
185         }
186
187         if (namelen == matchlen)
188                 return MATCHED_EXACTLY;
189         if (match[matchlen-1] == '/' || name[matchlen] == '/')
190                 return MATCHED_RECURSIVELY;
191         return 0;
192 }
193
194 /*
195  * Given a name and a list of pathspecs, see if the name matches
196  * any of the pathspecs.  The caller is also interested in seeing
197  * all pathspec matches some names it calls this function with
198  * (otherwise the user could have mistyped the unmatched pathspec),
199  * and a mark is left in seen[] array for pathspec element that
200  * actually matched anything.
201  */
202 int match_pathspec(const char **pathspec, const char *name, int namelen,
203                 int prefix, char *seen)
204 {
205         int i, retval = 0;
206
207         if (!pathspec)
208                 return 1;
209
210         name += prefix;
211         namelen -= prefix;
212
213         for (i = 0; pathspec[i] != NULL; i++) {
214                 int how;
215                 const char *match = pathspec[i] + prefix;
216                 if (seen && seen[i] == MATCHED_EXACTLY)
217                         continue;
218                 how = match_one(match, name, namelen);
219                 if (how) {
220                         if (retval < how)
221                                 retval = how;
222                         if (seen && seen[i] < how)
223                                 seen[i] = how;
224                 }
225         }
226         return retval;
227 }
228
229 /*
230  * Does 'match' match the given name?
231  * A match is found if
232  *
233  * (1) the 'match' string is leading directory of 'name', or
234  * (2) the 'match' string is a wildcard and matches 'name', or
235  * (3) the 'match' string is exactly the same as 'name'.
236  *
237  * and the return value tells which case it was.
238  *
239  * It returns 0 when there is no match.
240  */
241 static int match_pathspec_item(const struct pathspec_item *item, int prefix,
242                                const char *name, int namelen)
243 {
244         /* name/namelen has prefix cut off by caller */
245         const char *match = item->match + prefix;
246         int matchlen = item->len - prefix;
247
248         /* If the match was just the prefix, we matched */
249         if (!*match)
250                 return MATCHED_RECURSIVELY;
251
252         if (matchlen <= namelen && !strncmp(match, name, matchlen)) {
253                 if (matchlen == namelen)
254                         return MATCHED_EXACTLY;
255
256                 if (match[matchlen-1] == '/' || name[matchlen] == '/')
257                         return MATCHED_RECURSIVELY;
258         }
259
260         if (item->nowildcard_len < item->len &&
261             !git_fnmatch(match, name,
262                          item->flags & PATHSPEC_ONESTAR ? GFNM_ONESTAR : 0,
263                          item->nowildcard_len - prefix))
264                 return MATCHED_FNMATCH;
265
266         return 0;
267 }
268
269 /*
270  * Given a name and a list of pathspecs, see if the name matches
271  * any of the pathspecs.  The caller is also interested in seeing
272  * all pathspec matches some names it calls this function with
273  * (otherwise the user could have mistyped the unmatched pathspec),
274  * and a mark is left in seen[] array for pathspec element that
275  * actually matched anything.
276  */
277 int match_pathspec_depth(const struct pathspec *ps,
278                          const char *name, int namelen,
279                          int prefix, char *seen)
280 {
281         int i, retval = 0;
282
283         if (!ps->nr) {
284                 if (!ps->recursive || ps->max_depth == -1)
285                         return MATCHED_RECURSIVELY;
286
287                 if (within_depth(name, namelen, 0, ps->max_depth))
288                         return MATCHED_EXACTLY;
289                 else
290                         return 0;
291         }
292
293         name += prefix;
294         namelen -= prefix;
295
296         for (i = ps->nr - 1; i >= 0; i--) {
297                 int how;
298                 if (seen && seen[i] == MATCHED_EXACTLY)
299                         continue;
300                 how = match_pathspec_item(ps->items+i, prefix, name, namelen);
301                 if (ps->recursive && ps->max_depth != -1 &&
302                     how && how != MATCHED_FNMATCH) {
303                         int len = ps->items[i].len;
304                         if (name[len] == '/')
305                                 len++;
306                         if (within_depth(name+len, namelen-len, 0, ps->max_depth))
307                                 how = MATCHED_EXACTLY;
308                         else
309                                 how = 0;
310                 }
311                 if (how) {
312                         if (retval < how)
313                                 retval = how;
314                         if (seen && seen[i] < how)
315                                 seen[i] = how;
316                 }
317         }
318         return retval;
319 }
320
321 /*
322  * Return the length of the "simple" part of a path match limiter.
323  */
324 static int simple_length(const char *match)
325 {
326         int len = -1;
327
328         for (;;) {
329                 unsigned char c = *match++;
330                 len++;
331                 if (c == '\0' || is_glob_special(c))
332                         return len;
333         }
334 }
335
336 static int no_wildcard(const char *string)
337 {
338         return string[simple_length(string)] == '\0';
339 }
340
341 void parse_exclude_pattern(const char **pattern,
342                            int *patternlen,
343                            int *flags,
344                            int *nowildcardlen)
345 {
346         const char *p = *pattern;
347         size_t i, len;
348
349         *flags = 0;
350         if (*p == '!') {
351                 *flags |= EXC_FLAG_NEGATIVE;
352                 p++;
353         }
354         len = strlen(p);
355         if (len && p[len - 1] == '/') {
356                 len--;
357                 *flags |= EXC_FLAG_MUSTBEDIR;
358         }
359         for (i = 0; i < len; i++) {
360                 if (p[i] == '/')
361                         break;
362         }
363         if (i == len)
364                 *flags |= EXC_FLAG_NODIR;
365         *nowildcardlen = simple_length(p);
366         /*
367          * we should have excluded the trailing slash from 'p' too,
368          * but that's one more allocation. Instead just make sure
369          * nowildcardlen does not exceed real patternlen
370          */
371         if (*nowildcardlen > len)
372                 *nowildcardlen = len;
373         if (*p == '*' && no_wildcard(p + 1))
374                 *flags |= EXC_FLAG_ENDSWITH;
375         *pattern = p;
376         *patternlen = len;
377 }
378
379 void add_exclude(const char *string, const char *base,
380                  int baselen, struct exclude_list *which)
381 {
382         struct exclude *x;
383         int patternlen;
384         int flags;
385         int nowildcardlen;
386
387         parse_exclude_pattern(&string, &patternlen, &flags, &nowildcardlen);
388         if (flags & EXC_FLAG_MUSTBEDIR) {
389                 char *s;
390                 x = xmalloc(sizeof(*x) + patternlen + 1);
391                 s = (char *)(x+1);
392                 memcpy(s, string, patternlen);
393                 s[patternlen] = '\0';
394                 x->pattern = s;
395         } else {
396                 x = xmalloc(sizeof(*x));
397                 x->pattern = string;
398         }
399         x->patternlen = patternlen;
400         x->nowildcardlen = nowildcardlen;
401         x->base = base;
402         x->baselen = baselen;
403         x->flags = flags;
404         ALLOC_GROW(which->excludes, which->nr + 1, which->alloc);
405         which->excludes[which->nr++] = x;
406 }
407
408 static void *read_skip_worktree_file_from_index(const char *path, size_t *size)
409 {
410         int pos, len;
411         unsigned long sz;
412         enum object_type type;
413         void *data;
414         struct index_state *istate = &the_index;
415
416         len = strlen(path);
417         pos = index_name_pos(istate, path, len);
418         if (pos < 0)
419                 return NULL;
420         if (!ce_skip_worktree(istate->cache[pos]))
421                 return NULL;
422         data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
423         if (!data || type != OBJ_BLOB) {
424                 free(data);
425                 return NULL;
426         }
427         *size = xsize_t(sz);
428         return data;
429 }
430
431 void free_excludes(struct exclude_list *el)
432 {
433         int i;
434
435         for (i = 0; i < el->nr; i++)
436                 free(el->excludes[i]);
437         free(el->excludes);
438
439         el->nr = 0;
440         el->excludes = NULL;
441 }
442
443 int add_excludes_from_file_to_list(const char *fname,
444                                    const char *base,
445                                    int baselen,
446                                    char **buf_p,
447                                    struct exclude_list *which,
448                                    int check_index)
449 {
450         struct stat st;
451         int fd, i;
452         size_t size = 0;
453         char *buf, *entry;
454
455         fd = open(fname, O_RDONLY);
456         if (fd < 0 || fstat(fd, &st) < 0) {
457                 if (errno != ENOENT)
458                         warn_on_inaccessible(fname);
459                 if (0 <= fd)
460                         close(fd);
461                 if (!check_index ||
462                     (buf = read_skip_worktree_file_from_index(fname, &size)) == NULL)
463                         return -1;
464                 if (size == 0) {
465                         free(buf);
466                         return 0;
467                 }
468                 if (buf[size-1] != '\n') {
469                         buf = xrealloc(buf, size+1);
470                         buf[size++] = '\n';
471                 }
472         }
473         else {
474                 size = xsize_t(st.st_size);
475                 if (size == 0) {
476                         close(fd);
477                         return 0;
478                 }
479                 buf = xmalloc(size+1);
480                 if (read_in_full(fd, buf, size) != size) {
481                         free(buf);
482                         close(fd);
483                         return -1;
484                 }
485                 buf[size++] = '\n';
486                 close(fd);
487         }
488
489         if (buf_p)
490                 *buf_p = buf;
491         entry = buf;
492         for (i = 0; i < size; i++) {
493                 if (buf[i] == '\n') {
494                         if (entry != buf + i && entry[0] != '#') {
495                                 buf[i - (i && buf[i-1] == '\r')] = 0;
496                                 add_exclude(entry, base, baselen, which);
497                         }
498                         entry = buf + i + 1;
499                 }
500         }
501         return 0;
502 }
503
504 void add_excludes_from_file(struct dir_struct *dir, const char *fname)
505 {
506         if (add_excludes_from_file_to_list(fname, "", 0, NULL,
507                                            &dir->exclude_list[EXC_FILE], 0) < 0)
508                 die("cannot use %s as an exclude file", fname);
509 }
510
511 static void prep_exclude(struct dir_struct *dir, const char *base, int baselen)
512 {
513         struct exclude_list *el;
514         struct exclude_stack *stk = NULL;
515         int current;
516
517         if ((!dir->exclude_per_dir) ||
518             (baselen + strlen(dir->exclude_per_dir) >= PATH_MAX))
519                 return; /* too long a path -- ignore */
520
521         /* Pop the ones that are not the prefix of the path being checked. */
522         el = &dir->exclude_list[EXC_DIRS];
523         while ((stk = dir->exclude_stack) != NULL) {
524                 if (stk->baselen <= baselen &&
525                     !strncmp(dir->basebuf, base, stk->baselen))
526                         break;
527                 dir->exclude_stack = stk->prev;
528                 while (stk->exclude_ix < el->nr)
529                         free(el->excludes[--el->nr]);
530                 free(stk->filebuf);
531                 free(stk);
532         }
533
534         /* Read from the parent directories and push them down. */
535         current = stk ? stk->baselen : -1;
536         while (current < baselen) {
537                 struct exclude_stack *stk = xcalloc(1, sizeof(*stk));
538                 const char *cp;
539
540                 if (current < 0) {
541                         cp = base;
542                         current = 0;
543                 }
544                 else {
545                         cp = strchr(base + current + 1, '/');
546                         if (!cp)
547                                 die("oops in prep_exclude");
548                         cp++;
549                 }
550                 stk->prev = dir->exclude_stack;
551                 stk->baselen = cp - base;
552                 stk->exclude_ix = el->nr;
553                 memcpy(dir->basebuf + current, base + current,
554                        stk->baselen - current);
555                 strcpy(dir->basebuf + stk->baselen, dir->exclude_per_dir);
556                 add_excludes_from_file_to_list(dir->basebuf,
557                                                dir->basebuf, stk->baselen,
558                                                &stk->filebuf, el, 1);
559                 dir->exclude_stack = stk;
560                 current = stk->baselen;
561         }
562         dir->basebuf[baselen] = '\0';
563 }
564
565 int match_basename(const char *basename, int basenamelen,
566                    const char *pattern, int prefix, int patternlen,
567                    int flags)
568 {
569         if (prefix == patternlen) {
570                 if (!strcmp_icase(pattern, basename))
571                         return 1;
572         } else if (flags & EXC_FLAG_ENDSWITH) {
573                 if (patternlen - 1 <= basenamelen &&
574                     !strcmp_icase(pattern + 1,
575                                   basename + basenamelen - patternlen + 1))
576                         return 1;
577         } else {
578                 if (fnmatch_icase(pattern, basename, 0) == 0)
579                         return 1;
580         }
581         return 0;
582 }
583
584 int match_pathname(const char *pathname, int pathlen,
585                    const char *base, int baselen,
586                    const char *pattern, int prefix, int patternlen,
587                    int flags)
588 {
589         const char *name;
590         int namelen;
591
592         /*
593          * match with FNM_PATHNAME; the pattern has base implicitly
594          * in front of it.
595          */
596         if (*pattern == '/') {
597                 pattern++;
598                 prefix--;
599         }
600
601         /*
602          * baselen does not count the trailing slash. base[] may or
603          * may not end with a trailing slash though.
604          */
605         if (pathlen < baselen + 1 ||
606             (baselen && pathname[baselen] != '/') ||
607             strncmp_icase(pathname, base, baselen))
608                 return 0;
609
610         namelen = baselen ? pathlen - baselen - 1 : pathlen;
611         name = pathname + pathlen - namelen;
612
613         if (prefix) {
614                 /*
615                  * if the non-wildcard part is longer than the
616                  * remaining pathname, surely it cannot match.
617                  */
618                 if (prefix > namelen)
619                         return 0;
620
621                 if (strncmp_icase(pattern, name, prefix))
622                         return 0;
623                 pattern += prefix;
624                 name    += prefix;
625                 namelen -= prefix;
626         }
627
628         return wildmatch(pattern, name,
629                          ignore_case ? FNM_CASEFOLD : 0) == 0;
630 }
631
632 /* Scan the list and let the last match determine the fate.
633  * Return 1 for exclude, 0 for include and -1 for undecided.
634  */
635 int excluded_from_list(const char *pathname,
636                        int pathlen, const char *basename, int *dtype,
637                        struct exclude_list *el)
638 {
639         int i;
640
641         if (!el->nr)
642                 return -1;      /* undefined */
643
644         for (i = el->nr - 1; 0 <= i; i--) {
645                 struct exclude *x = el->excludes[i];
646                 const char *exclude = x->pattern;
647                 int to_exclude = x->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
648                 int prefix = x->nowildcardlen;
649
650                 if (x->flags & EXC_FLAG_MUSTBEDIR) {
651                         if (*dtype == DT_UNKNOWN)
652                                 *dtype = get_dtype(NULL, pathname, pathlen);
653                         if (*dtype != DT_DIR)
654                                 continue;
655                 }
656
657                 if (x->flags & EXC_FLAG_NODIR) {
658                         if (match_basename(basename,
659                                            pathlen - (basename - pathname),
660                                            exclude, prefix, x->patternlen,
661                                            x->flags))
662                                 return to_exclude;
663                         continue;
664                 }
665
666                 assert(x->baselen == 0 || x->base[x->baselen - 1] == '/');
667                 if (match_pathname(pathname, pathlen,
668                                    x->base, x->baselen ? x->baselen - 1 : 0,
669                                    exclude, prefix, x->patternlen, x->flags))
670                         return to_exclude;
671         }
672         return -1; /* undecided */
673 }
674
675 static int excluded(struct dir_struct *dir, const char *pathname, int *dtype_p)
676 {
677         int pathlen = strlen(pathname);
678         int st;
679         const char *basename = strrchr(pathname, '/');
680         basename = (basename) ? basename+1 : pathname;
681
682         prep_exclude(dir, pathname, basename-pathname);
683         for (st = EXC_CMDL; st <= EXC_FILE; st++) {
684                 switch (excluded_from_list(pathname, pathlen, basename,
685                                            dtype_p, &dir->exclude_list[st])) {
686                 case 0:
687                         return 0;
688                 case 1:
689                         return 1;
690                 }
691         }
692         return 0;
693 }
694
695 void path_exclude_check_init(struct path_exclude_check *check,
696                              struct dir_struct *dir)
697 {
698         check->dir = dir;
699         strbuf_init(&check->path, 256);
700 }
701
702 void path_exclude_check_clear(struct path_exclude_check *check)
703 {
704         strbuf_release(&check->path);
705 }
706
707 /*
708  * Is this name excluded?  This is for a caller like show_files() that
709  * do not honor directory hierarchy and iterate through paths that are
710  * possibly in an ignored directory.
711  *
712  * A path to a directory known to be excluded is left in check->path to
713  * optimize for repeated checks for files in the same excluded directory.
714  */
715 int path_excluded(struct path_exclude_check *check,
716                   const char *name, int namelen, int *dtype)
717 {
718         int i;
719         struct strbuf *path = &check->path;
720
721         /*
722          * we allow the caller to pass namelen as an optimization; it
723          * must match the length of the name, as we eventually call
724          * excluded() on the whole name string.
725          */
726         if (namelen < 0)
727                 namelen = strlen(name);
728
729         if (path->len &&
730             path->len <= namelen &&
731             !memcmp(name, path->buf, path->len) &&
732             (!name[path->len] || name[path->len] == '/'))
733                 return 1;
734
735         strbuf_setlen(path, 0);
736         for (i = 0; name[i]; i++) {
737                 int ch = name[i];
738
739                 if (ch == '/') {
740                         int dt = DT_DIR;
741                         if (excluded(check->dir, path->buf, &dt))
742                                 return 1;
743                 }
744                 strbuf_addch(path, ch);
745         }
746
747         /* An entry in the index; cannot be a directory with subentries */
748         strbuf_setlen(path, 0);
749
750         return excluded(check->dir, name, dtype);
751 }
752
753 static struct dir_entry *dir_entry_new(const char *pathname, int len)
754 {
755         struct dir_entry *ent;
756
757         ent = xmalloc(sizeof(*ent) + len + 1);
758         ent->len = len;
759         memcpy(ent->name, pathname, len);
760         ent->name[len] = 0;
761         return ent;
762 }
763
764 static struct dir_entry *dir_add_name(struct dir_struct *dir, const char *pathname, int len)
765 {
766         if (cache_name_exists(pathname, len, ignore_case))
767                 return NULL;
768
769         ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
770         return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
771 }
772
773 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len)
774 {
775         if (!cache_name_is_other(pathname, len))
776                 return NULL;
777
778         ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
779         return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
780 }
781
782 enum exist_status {
783         index_nonexistent = 0,
784         index_directory,
785         index_gitdir
786 };
787
788 /*
789  * Do not use the alphabetically stored index to look up
790  * the directory name; instead, use the case insensitive
791  * name hash.
792  */
793 static enum exist_status directory_exists_in_index_icase(const char *dirname, int len)
794 {
795         struct cache_entry *ce = index_name_exists(&the_index, dirname, len + 1, ignore_case);
796         unsigned char endchar;
797
798         if (!ce)
799                 return index_nonexistent;
800         endchar = ce->name[len];
801
802         /*
803          * The cache_entry structure returned will contain this dirname
804          * and possibly additional path components.
805          */
806         if (endchar == '/')
807                 return index_directory;
808
809         /*
810          * If there are no additional path components, then this cache_entry
811          * represents a submodule.  Submodules, despite being directories,
812          * are stored in the cache without a closing slash.
813          */
814         if (!endchar && S_ISGITLINK(ce->ce_mode))
815                 return index_gitdir;
816
817         /* This should never be hit, but it exists just in case. */
818         return index_nonexistent;
819 }
820
821 /*
822  * The index sorts alphabetically by entry name, which
823  * means that a gitlink sorts as '\0' at the end, while
824  * a directory (which is defined not as an entry, but as
825  * the files it contains) will sort with the '/' at the
826  * end.
827  */
828 static enum exist_status directory_exists_in_index(const char *dirname, int len)
829 {
830         int pos;
831
832         if (ignore_case)
833                 return directory_exists_in_index_icase(dirname, len);
834
835         pos = cache_name_pos(dirname, len);
836         if (pos < 0)
837                 pos = -pos-1;
838         while (pos < active_nr) {
839                 struct cache_entry *ce = active_cache[pos++];
840                 unsigned char endchar;
841
842                 if (strncmp(ce->name, dirname, len))
843                         break;
844                 endchar = ce->name[len];
845                 if (endchar > '/')
846                         break;
847                 if (endchar == '/')
848                         return index_directory;
849                 if (!endchar && S_ISGITLINK(ce->ce_mode))
850                         return index_gitdir;
851         }
852         return index_nonexistent;
853 }
854
855 /*
856  * When we find a directory when traversing the filesystem, we
857  * have three distinct cases:
858  *
859  *  - ignore it
860  *  - see it as a directory
861  *  - recurse into it
862  *
863  * and which one we choose depends on a combination of existing
864  * git index contents and the flags passed into the directory
865  * traversal routine.
866  *
867  * Case 1: If we *already* have entries in the index under that
868  * directory name, we always recurse into the directory to see
869  * all the files.
870  *
871  * Case 2: If we *already* have that directory name as a gitlink,
872  * we always continue to see it as a gitlink, regardless of whether
873  * there is an actual git directory there or not (it might not
874  * be checked out as a subproject!)
875  *
876  * Case 3: if we didn't have it in the index previously, we
877  * have a few sub-cases:
878  *
879  *  (a) if "show_other_directories" is true, we show it as
880  *      just a directory, unless "hide_empty_directories" is
881  *      also true and the directory is empty, in which case
882  *      we just ignore it entirely.
883  *  (b) if it looks like a git directory, and we don't have
884  *      'no_gitlinks' set we treat it as a gitlink, and show it
885  *      as a directory.
886  *  (c) otherwise, we recurse into it.
887  */
888 enum directory_treatment {
889         show_directory,
890         ignore_directory,
891         recurse_into_directory
892 };
893
894 static enum directory_treatment treat_directory(struct dir_struct *dir,
895         const char *dirname, int len,
896         const struct path_simplify *simplify)
897 {
898         /* The "len-1" is to strip the final '/' */
899         switch (directory_exists_in_index(dirname, len-1)) {
900         case index_directory:
901                 return recurse_into_directory;
902
903         case index_gitdir:
904                 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
905                         return ignore_directory;
906                 return show_directory;
907
908         case index_nonexistent:
909                 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
910                         break;
911                 if (!(dir->flags & DIR_NO_GITLINKS)) {
912                         unsigned char sha1[20];
913                         if (resolve_gitlink_ref(dirname, "HEAD", sha1) == 0)
914                                 return show_directory;
915                 }
916                 return recurse_into_directory;
917         }
918
919         /* This is the "show_other_directories" case */
920         if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
921                 return show_directory;
922         if (!read_directory_recursive(dir, dirname, len, 1, simplify))
923                 return ignore_directory;
924         return show_directory;
925 }
926
927 /*
928  * This is an inexact early pruning of any recursive directory
929  * reading - if the path cannot possibly be in the pathspec,
930  * return true, and we'll skip it early.
931  */
932 static int simplify_away(const char *path, int pathlen, const struct path_simplify *simplify)
933 {
934         if (simplify) {
935                 for (;;) {
936                         const char *match = simplify->path;
937                         int len = simplify->len;
938
939                         if (!match)
940                                 break;
941                         if (len > pathlen)
942                                 len = pathlen;
943                         if (!memcmp(path, match, len))
944                                 return 0;
945                         simplify++;
946                 }
947                 return 1;
948         }
949         return 0;
950 }
951
952 /*
953  * This function tells us whether an excluded path matches a
954  * list of "interesting" pathspecs. That is, whether a path matched
955  * by any of the pathspecs could possibly be ignored by excluding
956  * the specified path. This can happen if:
957  *
958  *   1. the path is mentioned explicitly in the pathspec
959  *
960  *   2. the path is a directory prefix of some element in the
961  *      pathspec
962  */
963 static int exclude_matches_pathspec(const char *path, int len,
964                 const struct path_simplify *simplify)
965 {
966         if (simplify) {
967                 for (; simplify->path; simplify++) {
968                         if (len == simplify->len
969                             && !memcmp(path, simplify->path, len))
970                                 return 1;
971                         if (len < simplify->len
972                             && simplify->path[len] == '/'
973                             && !memcmp(path, simplify->path, len))
974                                 return 1;
975                 }
976         }
977         return 0;
978 }
979
980 static int get_index_dtype(const char *path, int len)
981 {
982         int pos;
983         struct cache_entry *ce;
984
985         ce = cache_name_exists(path, len, 0);
986         if (ce) {
987                 if (!ce_uptodate(ce))
988                         return DT_UNKNOWN;
989                 if (S_ISGITLINK(ce->ce_mode))
990                         return DT_DIR;
991                 /*
992                  * Nobody actually cares about the
993                  * difference between DT_LNK and DT_REG
994                  */
995                 return DT_REG;
996         }
997
998         /* Try to look it up as a directory */
999         pos = cache_name_pos(path, len);
1000         if (pos >= 0)
1001                 return DT_UNKNOWN;
1002         pos = -pos-1;
1003         while (pos < active_nr) {
1004                 ce = active_cache[pos++];
1005                 if (strncmp(ce->name, path, len))
1006                         break;
1007                 if (ce->name[len] > '/')
1008                         break;
1009                 if (ce->name[len] < '/')
1010                         continue;
1011                 if (!ce_uptodate(ce))
1012                         break;  /* continue? */
1013                 return DT_DIR;
1014         }
1015         return DT_UNKNOWN;
1016 }
1017
1018 static int get_dtype(struct dirent *de, const char *path, int len)
1019 {
1020         int dtype = de ? DTYPE(de) : DT_UNKNOWN;
1021         struct stat st;
1022
1023         if (dtype != DT_UNKNOWN)
1024                 return dtype;
1025         dtype = get_index_dtype(path, len);
1026         if (dtype != DT_UNKNOWN)
1027                 return dtype;
1028         if (lstat(path, &st))
1029                 return dtype;
1030         if (S_ISREG(st.st_mode))
1031                 return DT_REG;
1032         if (S_ISDIR(st.st_mode))
1033                 return DT_DIR;
1034         if (S_ISLNK(st.st_mode))
1035                 return DT_LNK;
1036         return dtype;
1037 }
1038
1039 enum path_treatment {
1040         path_ignored,
1041         path_handled,
1042         path_recurse
1043 };
1044
1045 static enum path_treatment treat_one_path(struct dir_struct *dir,
1046                                           struct strbuf *path,
1047                                           const struct path_simplify *simplify,
1048                                           int dtype, struct dirent *de)
1049 {
1050         int exclude = excluded(dir, path->buf, &dtype);
1051         if (exclude && (dir->flags & DIR_COLLECT_IGNORED)
1052             && exclude_matches_pathspec(path->buf, path->len, simplify))
1053                 dir_add_ignored(dir, path->buf, path->len);
1054
1055         /*
1056          * Excluded? If we don't explicitly want to show
1057          * ignored files, ignore it
1058          */
1059         if (exclude && !(dir->flags & DIR_SHOW_IGNORED))
1060                 return path_ignored;
1061
1062         if (dtype == DT_UNKNOWN)
1063                 dtype = get_dtype(de, path->buf, path->len);
1064
1065         /*
1066          * Do we want to see just the ignored files?
1067          * We still need to recurse into directories,
1068          * even if we don't ignore them, since the
1069          * directory may contain files that we do..
1070          */
1071         if (!exclude && (dir->flags & DIR_SHOW_IGNORED)) {
1072                 if (dtype != DT_DIR)
1073                         return path_ignored;
1074         }
1075
1076         switch (dtype) {
1077         default:
1078                 return path_ignored;
1079         case DT_DIR:
1080                 strbuf_addch(path, '/');
1081                 switch (treat_directory(dir, path->buf, path->len, simplify)) {
1082                 case show_directory:
1083                         if (exclude != !!(dir->flags
1084                                           & DIR_SHOW_IGNORED))
1085                                 return path_ignored;
1086                         break;
1087                 case recurse_into_directory:
1088                         return path_recurse;
1089                 case ignore_directory:
1090                         return path_ignored;
1091                 }
1092                 break;
1093         case DT_REG:
1094         case DT_LNK:
1095                 break;
1096         }
1097         return path_handled;
1098 }
1099
1100 static enum path_treatment treat_path(struct dir_struct *dir,
1101                                       struct dirent *de,
1102                                       struct strbuf *path,
1103                                       int baselen,
1104                                       const struct path_simplify *simplify)
1105 {
1106         int dtype;
1107
1108         if (is_dot_or_dotdot(de->d_name) || !strcmp(de->d_name, ".git"))
1109                 return path_ignored;
1110         strbuf_setlen(path, baselen);
1111         strbuf_addstr(path, de->d_name);
1112         if (simplify_away(path->buf, path->len, simplify))
1113                 return path_ignored;
1114
1115         dtype = DTYPE(de);
1116         return treat_one_path(dir, path, simplify, dtype, de);
1117 }
1118
1119 /*
1120  * Read a directory tree. We currently ignore anything but
1121  * directories, regular files and symlinks. That's because git
1122  * doesn't handle them at all yet. Maybe that will change some
1123  * day.
1124  *
1125  * Also, we ignore the name ".git" (even if it is not a directory).
1126  * That likely will not change.
1127  */
1128 static int read_directory_recursive(struct dir_struct *dir,
1129                                     const char *base, int baselen,
1130                                     int check_only,
1131                                     const struct path_simplify *simplify)
1132 {
1133         DIR *fdir;
1134         int contents = 0;
1135         struct dirent *de;
1136         struct strbuf path = STRBUF_INIT;
1137
1138         strbuf_add(&path, base, baselen);
1139
1140         fdir = opendir(path.len ? path.buf : ".");
1141         if (!fdir)
1142                 goto out;
1143
1144         while ((de = readdir(fdir)) != NULL) {
1145                 switch (treat_path(dir, de, &path, baselen, simplify)) {
1146                 case path_recurse:
1147                         contents += read_directory_recursive(dir, path.buf,
1148                                                              path.len, 0,
1149                                                              simplify);
1150                         continue;
1151                 case path_ignored:
1152                         continue;
1153                 case path_handled:
1154                         break;
1155                 }
1156                 contents++;
1157                 if (check_only)
1158                         break;
1159                 dir_add_name(dir, path.buf, path.len);
1160         }
1161         closedir(fdir);
1162  out:
1163         strbuf_release(&path);
1164
1165         return contents;
1166 }
1167
1168 static int cmp_name(const void *p1, const void *p2)
1169 {
1170         const struct dir_entry *e1 = *(const struct dir_entry **)p1;
1171         const struct dir_entry *e2 = *(const struct dir_entry **)p2;
1172
1173         return cache_name_compare(e1->name, e1->len,
1174                                   e2->name, e2->len);
1175 }
1176
1177 static struct path_simplify *create_simplify(const char **pathspec)
1178 {
1179         int nr, alloc = 0;
1180         struct path_simplify *simplify = NULL;
1181
1182         if (!pathspec)
1183                 return NULL;
1184
1185         for (nr = 0 ; ; nr++) {
1186                 const char *match;
1187                 if (nr >= alloc) {
1188                         alloc = alloc_nr(alloc);
1189                         simplify = xrealloc(simplify, alloc * sizeof(*simplify));
1190                 }
1191                 match = *pathspec++;
1192                 if (!match)
1193                         break;
1194                 simplify[nr].path = match;
1195                 simplify[nr].len = simple_length(match);
1196         }
1197         simplify[nr].path = NULL;
1198         simplify[nr].len = 0;
1199         return simplify;
1200 }
1201
1202 static void free_simplify(struct path_simplify *simplify)
1203 {
1204         free(simplify);
1205 }
1206
1207 static int treat_leading_path(struct dir_struct *dir,
1208                               const char *path, int len,
1209                               const struct path_simplify *simplify)
1210 {
1211         struct strbuf sb = STRBUF_INIT;
1212         int baselen, rc = 0;
1213         const char *cp;
1214
1215         while (len && path[len - 1] == '/')
1216                 len--;
1217         if (!len)
1218                 return 1;
1219         baselen = 0;
1220         while (1) {
1221                 cp = path + baselen + !!baselen;
1222                 cp = memchr(cp, '/', path + len - cp);
1223                 if (!cp)
1224                         baselen = len;
1225                 else
1226                         baselen = cp - path;
1227                 strbuf_setlen(&sb, 0);
1228                 strbuf_add(&sb, path, baselen);
1229                 if (!is_directory(sb.buf))
1230                         break;
1231                 if (simplify_away(sb.buf, sb.len, simplify))
1232                         break;
1233                 if (treat_one_path(dir, &sb, simplify,
1234                                    DT_DIR, NULL) == path_ignored)
1235                         break; /* do not recurse into it */
1236                 if (len <= baselen) {
1237                         rc = 1;
1238                         break; /* finished checking */
1239                 }
1240         }
1241         strbuf_release(&sb);
1242         return rc;
1243 }
1244
1245 int read_directory(struct dir_struct *dir, const char *path, int len, const char **pathspec)
1246 {
1247         struct path_simplify *simplify;
1248
1249         if (has_symlink_leading_path(path, len))
1250                 return dir->nr;
1251
1252         simplify = create_simplify(pathspec);
1253         if (!len || treat_leading_path(dir, path, len, simplify))
1254                 read_directory_recursive(dir, path, len, 0, simplify);
1255         free_simplify(simplify);
1256         qsort(dir->entries, dir->nr, sizeof(struct dir_entry *), cmp_name);
1257         qsort(dir->ignored, dir->ignored_nr, sizeof(struct dir_entry *), cmp_name);
1258         return dir->nr;
1259 }
1260
1261 int file_exists(const char *f)
1262 {
1263         struct stat sb;
1264         return lstat(f, &sb) == 0;
1265 }
1266
1267 /*
1268  * Given two normalized paths (a trailing slash is ok), if subdir is
1269  * outside dir, return -1.  Otherwise return the offset in subdir that
1270  * can be used as relative path to dir.
1271  */
1272 int dir_inside_of(const char *subdir, const char *dir)
1273 {
1274         int offset = 0;
1275
1276         assert(dir && subdir && *dir && *subdir);
1277
1278         while (*dir && *subdir && *dir == *subdir) {
1279                 dir++;
1280                 subdir++;
1281                 offset++;
1282         }
1283
1284         /* hel[p]/me vs hel[l]/yeah */
1285         if (*dir && *subdir)
1286                 return -1;
1287
1288         if (!*subdir)
1289                 return !*dir ? offset : -1; /* same dir */
1290
1291         /* foo/[b]ar vs foo/[] */
1292         if (is_dir_sep(dir[-1]))
1293                 return is_dir_sep(subdir[-1]) ? offset : -1;
1294
1295         /* foo[/]bar vs foo[] */
1296         return is_dir_sep(*subdir) ? offset + 1 : -1;
1297 }
1298
1299 int is_inside_dir(const char *dir)
1300 {
1301         char cwd[PATH_MAX];
1302         if (!dir)
1303                 return 0;
1304         if (!getcwd(cwd, sizeof(cwd)))
1305                 die_errno("can't find the current directory");
1306         return dir_inside_of(cwd, dir) >= 0;
1307 }
1308
1309 int is_empty_dir(const char *path)
1310 {
1311         DIR *dir = opendir(path);
1312         struct dirent *e;
1313         int ret = 1;
1314
1315         if (!dir)
1316                 return 0;
1317
1318         while ((e = readdir(dir)) != NULL)
1319                 if (!is_dot_or_dotdot(e->d_name)) {
1320                         ret = 0;
1321                         break;
1322                 }
1323
1324         closedir(dir);
1325         return ret;
1326 }
1327
1328 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
1329 {
1330         DIR *dir;
1331         struct dirent *e;
1332         int ret = 0, original_len = path->len, len, kept_down = 0;
1333         int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
1334         int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
1335         unsigned char submodule_head[20];
1336
1337         if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
1338             !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
1339                 /* Do not descend and nuke a nested git work tree. */
1340                 if (kept_up)
1341                         *kept_up = 1;
1342                 return 0;
1343         }
1344
1345         flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
1346         dir = opendir(path->buf);
1347         if (!dir) {
1348                 /* an empty dir could be removed even if it is unreadble */
1349                 if (!keep_toplevel)
1350                         return rmdir(path->buf);
1351                 else
1352                         return -1;
1353         }
1354         if (path->buf[original_len - 1] != '/')
1355                 strbuf_addch(path, '/');
1356
1357         len = path->len;
1358         while ((e = readdir(dir)) != NULL) {
1359                 struct stat st;
1360                 if (is_dot_or_dotdot(e->d_name))
1361                         continue;
1362
1363                 strbuf_setlen(path, len);
1364                 strbuf_addstr(path, e->d_name);
1365                 if (lstat(path->buf, &st))
1366                         ; /* fall thru */
1367                 else if (S_ISDIR(st.st_mode)) {
1368                         if (!remove_dir_recurse(path, flag, &kept_down))
1369                                 continue; /* happy */
1370                 } else if (!only_empty && !unlink(path->buf))
1371                         continue; /* happy, too */
1372
1373                 /* path too long, stat fails, or non-directory still exists */
1374                 ret = -1;
1375                 break;
1376         }
1377         closedir(dir);
1378
1379         strbuf_setlen(path, original_len);
1380         if (!ret && !keep_toplevel && !kept_down)
1381                 ret = rmdir(path->buf);
1382         else if (kept_up)
1383                 /*
1384                  * report the uplevel that it is not an error that we
1385                  * did not rmdir() our directory.
1386                  */
1387                 *kept_up = !ret;
1388         return ret;
1389 }
1390
1391 int remove_dir_recursively(struct strbuf *path, int flag)
1392 {
1393         return remove_dir_recurse(path, flag, NULL);
1394 }
1395
1396 void setup_standard_excludes(struct dir_struct *dir)
1397 {
1398         const char *path;
1399         char *xdg_path;
1400
1401         dir->exclude_per_dir = ".gitignore";
1402         path = git_path("info/exclude");
1403         if (!excludes_file) {
1404                 home_config_paths(NULL, &xdg_path, "ignore");
1405                 excludes_file = xdg_path;
1406         }
1407         if (!access_or_warn(path, R_OK))
1408                 add_excludes_from_file(dir, path);
1409         if (excludes_file && !access_or_warn(excludes_file, R_OK))
1410                 add_excludes_from_file(dir, excludes_file);
1411 }
1412
1413 int remove_path(const char *name)
1414 {
1415         char *slash;
1416
1417         if (unlink(name) && errno != ENOENT)
1418                 return -1;
1419
1420         slash = strrchr(name, '/');
1421         if (slash) {
1422                 char *dirs = xstrdup(name);
1423                 slash = dirs + (slash - name);
1424                 do {
1425                         *slash = '\0';
1426                 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
1427                 free(dirs);
1428         }
1429         return 0;
1430 }
1431
1432 static int pathspec_item_cmp(const void *a_, const void *b_)
1433 {
1434         struct pathspec_item *a, *b;
1435
1436         a = (struct pathspec_item *)a_;
1437         b = (struct pathspec_item *)b_;
1438         return strcmp(a->match, b->match);
1439 }
1440
1441 int init_pathspec(struct pathspec *pathspec, const char **paths)
1442 {
1443         const char **p = paths;
1444         int i;
1445
1446         memset(pathspec, 0, sizeof(*pathspec));
1447         if (!p)
1448                 return 0;
1449         while (*p)
1450                 p++;
1451         pathspec->raw = paths;
1452         pathspec->nr = p - paths;
1453         if (!pathspec->nr)
1454                 return 0;
1455
1456         pathspec->items = xmalloc(sizeof(struct pathspec_item)*pathspec->nr);
1457         for (i = 0; i < pathspec->nr; i++) {
1458                 struct pathspec_item *item = pathspec->items+i;
1459                 const char *path = paths[i];
1460
1461                 item->match = path;
1462                 item->len = strlen(path);
1463                 item->flags = 0;
1464                 if (limit_pathspec_to_literal()) {
1465                         item->nowildcard_len = item->len;
1466                 } else {
1467                         item->nowildcard_len = simple_length(path);
1468                         if (item->nowildcard_len < item->len) {
1469                                 pathspec->has_wildcard = 1;
1470                                 if (path[item->nowildcard_len] == '*' &&
1471                                     no_wildcard(path + item->nowildcard_len + 1))
1472                                         item->flags |= PATHSPEC_ONESTAR;
1473                         }
1474                 }
1475         }
1476
1477         qsort(pathspec->items, pathspec->nr,
1478               sizeof(struct pathspec_item), pathspec_item_cmp);
1479
1480         return 0;
1481 }
1482
1483 void free_pathspec(struct pathspec *pathspec)
1484 {
1485         free(pathspec->items);
1486         pathspec->items = NULL;
1487 }
1488
1489 int limit_pathspec_to_literal(void)
1490 {
1491         static int flag = -1;
1492         if (flag < 0)
1493                 flag = git_env_bool(GIT_LITERAL_PATHSPECS_ENVIRONMENT, 0);
1494         return flag;
1495 }