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