exclude: fix a bug in prefix compare optimization
[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 add_exclude(const char *string, const char *base,
312                  int baselen, struct exclude_list *which)
313 {
314         struct exclude *x;
315         size_t len;
316         int to_exclude = 1;
317         int flags = 0;
318
319         if (*string == '!') {
320                 to_exclude = 0;
321                 string++;
322         }
323         len = strlen(string);
324         if (len && string[len - 1] == '/') {
325                 char *s;
326                 x = xmalloc(sizeof(*x) + len);
327                 s = (char *)(x+1);
328                 memcpy(s, string, len - 1);
329                 s[len - 1] = '\0';
330                 string = s;
331                 x->pattern = s;
332                 flags = EXC_FLAG_MUSTBEDIR;
333         } else {
334                 x = xmalloc(sizeof(*x));
335                 x->pattern = string;
336         }
337         x->to_exclude = to_exclude;
338         x->patternlen = strlen(string);
339         x->base = base;
340         x->baselen = baselen;
341         x->flags = flags;
342         if (!strchr(string, '/'))
343                 x->flags |= EXC_FLAG_NODIR;
344         x->nowildcardlen = simple_length(string);
345         if (*string == '*' && no_wildcard(string+1))
346                 x->flags |= EXC_FLAG_ENDSWITH;
347         ALLOC_GROW(which->excludes, which->nr + 1, which->alloc);
348         which->excludes[which->nr++] = x;
349 }
350
351 static void *read_skip_worktree_file_from_index(const char *path, size_t *size)
352 {
353         int pos, len;
354         unsigned long sz;
355         enum object_type type;
356         void *data;
357         struct index_state *istate = &the_index;
358
359         len = strlen(path);
360         pos = index_name_pos(istate, path, len);
361         if (pos < 0)
362                 return NULL;
363         if (!ce_skip_worktree(istate->cache[pos]))
364                 return NULL;
365         data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
366         if (!data || type != OBJ_BLOB) {
367                 free(data);
368                 return NULL;
369         }
370         *size = xsize_t(sz);
371         return data;
372 }
373
374 void free_excludes(struct exclude_list *el)
375 {
376         int i;
377
378         for (i = 0; i < el->nr; i++)
379                 free(el->excludes[i]);
380         free(el->excludes);
381
382         el->nr = 0;
383         el->excludes = NULL;
384 }
385
386 int add_excludes_from_file_to_list(const char *fname,
387                                    const char *base,
388                                    int baselen,
389                                    char **buf_p,
390                                    struct exclude_list *which,
391                                    int check_index)
392 {
393         struct stat st;
394         int fd, i;
395         size_t size = 0;
396         char *buf, *entry;
397
398         fd = open(fname, O_RDONLY);
399         if (fd < 0 || fstat(fd, &st) < 0) {
400                 if (0 <= fd)
401                         close(fd);
402                 if (!check_index ||
403                     (buf = read_skip_worktree_file_from_index(fname, &size)) == NULL)
404                         return -1;
405                 if (size == 0) {
406                         free(buf);
407                         return 0;
408                 }
409                 if (buf[size-1] != '\n') {
410                         buf = xrealloc(buf, size+1);
411                         buf[size++] = '\n';
412                 }
413         }
414         else {
415                 size = xsize_t(st.st_size);
416                 if (size == 0) {
417                         close(fd);
418                         return 0;
419                 }
420                 buf = xmalloc(size+1);
421                 if (read_in_full(fd, buf, size) != size) {
422                         free(buf);
423                         close(fd);
424                         return -1;
425                 }
426                 buf[size++] = '\n';
427                 close(fd);
428         }
429
430         if (buf_p)
431                 *buf_p = buf;
432         entry = buf;
433         for (i = 0; i < size; i++) {
434                 if (buf[i] == '\n') {
435                         if (entry != buf + i && entry[0] != '#') {
436                                 buf[i - (i && buf[i-1] == '\r')] = 0;
437                                 add_exclude(entry, base, baselen, which);
438                         }
439                         entry = buf + i + 1;
440                 }
441         }
442         return 0;
443 }
444
445 void add_excludes_from_file(struct dir_struct *dir, const char *fname)
446 {
447         if (add_excludes_from_file_to_list(fname, "", 0, NULL,
448                                            &dir->exclude_list[EXC_FILE], 0) < 0)
449                 die("cannot use %s as an exclude file", fname);
450 }
451
452 static void prep_exclude(struct dir_struct *dir, const char *base, int baselen)
453 {
454         struct exclude_list *el;
455         struct exclude_stack *stk = NULL;
456         int current;
457
458         if ((!dir->exclude_per_dir) ||
459             (baselen + strlen(dir->exclude_per_dir) >= PATH_MAX))
460                 return; /* too long a path -- ignore */
461
462         /* Pop the ones that are not the prefix of the path being checked. */
463         el = &dir->exclude_list[EXC_DIRS];
464         while ((stk = dir->exclude_stack) != NULL) {
465                 if (stk->baselen <= baselen &&
466                     !strncmp(dir->basebuf, base, stk->baselen))
467                         break;
468                 dir->exclude_stack = stk->prev;
469                 while (stk->exclude_ix < el->nr)
470                         free(el->excludes[--el->nr]);
471                 free(stk->filebuf);
472                 free(stk);
473         }
474
475         /* Read from the parent directories and push them down. */
476         current = stk ? stk->baselen : -1;
477         while (current < baselen) {
478                 struct exclude_stack *stk = xcalloc(1, sizeof(*stk));
479                 const char *cp;
480
481                 if (current < 0) {
482                         cp = base;
483                         current = 0;
484                 }
485                 else {
486                         cp = strchr(base + current + 1, '/');
487                         if (!cp)
488                                 die("oops in prep_exclude");
489                         cp++;
490                 }
491                 stk->prev = dir->exclude_stack;
492                 stk->baselen = cp - base;
493                 stk->exclude_ix = el->nr;
494                 memcpy(dir->basebuf + current, base + current,
495                        stk->baselen - current);
496                 strcpy(dir->basebuf + stk->baselen, dir->exclude_per_dir);
497                 add_excludes_from_file_to_list(dir->basebuf,
498                                                dir->basebuf, stk->baselen,
499                                                &stk->filebuf, el, 1);
500                 dir->exclude_stack = stk;
501                 current = stk->baselen;
502         }
503         dir->basebuf[baselen] = '\0';
504 }
505
506 static int match_basename(const char *basename, int basenamelen,
507                           const char *pattern, int prefix, int patternlen,
508                           int flags)
509 {
510         if (prefix == patternlen) {
511                 if (!strcmp_icase(pattern, basename))
512                         return 1;
513         } else if (flags & EXC_FLAG_ENDSWITH) {
514                 if (patternlen - 1 <= basenamelen &&
515                     !strcmp_icase(pattern + 1,
516                                   basename + basenamelen - patternlen + 1))
517                         return 1;
518         } else {
519                 if (fnmatch_icase(pattern, basename, 0) == 0)
520                         return 1;
521         }
522         return 0;
523 }
524
525 /* Scan the list and let the last match determine the fate.
526  * Return 1 for exclude, 0 for include and -1 for undecided.
527  */
528 int excluded_from_list(const char *pathname,
529                        int pathlen, const char *basename, int *dtype,
530                        struct exclude_list *el)
531 {
532         int i;
533
534         if (!el->nr)
535                 return -1;      /* undefined */
536
537         for (i = el->nr - 1; 0 <= i; i--) {
538                 struct exclude *x = el->excludes[i];
539                 const char *name, *exclude = x->pattern;
540                 int to_exclude = x->to_exclude;
541                 int namelen, prefix = x->nowildcardlen;
542
543                 if (x->flags & EXC_FLAG_MUSTBEDIR) {
544                         if (*dtype == DT_UNKNOWN)
545                                 *dtype = get_dtype(NULL, pathname, pathlen);
546                         if (*dtype != DT_DIR)
547                                 continue;
548                 }
549
550                 if (x->flags & EXC_FLAG_NODIR) {
551                         if (match_basename(basename,
552                                            pathlen - (basename - pathname),
553                                            exclude, prefix, x->patternlen,
554                                            x->flags))
555                                 return to_exclude;
556                         continue;
557                 }
558
559                 /* match with FNM_PATHNAME:
560                  * exclude has base (baselen long) implicitly in front of it.
561                  */
562                 if (*exclude == '/') {
563                         exclude++;
564                         prefix--;
565                 }
566
567                 if (pathlen < x->baselen ||
568                     (x->baselen && pathname[x->baselen-1] != '/') ||
569                     strncmp_icase(pathname, x->base, x->baselen))
570                         continue;
571
572                 namelen = x->baselen ? pathlen - x->baselen : pathlen;
573                 name = pathname + pathlen  - namelen;
574
575                 /* if the non-wildcard part is longer than the
576                    remaining pathname, surely it cannot match */
577                 if (prefix > namelen)
578                         continue;
579
580                 if (prefix) {
581                         if (strncmp_icase(exclude, name, prefix))
582                                 continue;
583                         exclude += prefix;
584                         name    += prefix;
585                         namelen -= prefix;
586                 }
587
588                 if (!fnmatch_icase(exclude, name, FNM_PATHNAME))
589                         return to_exclude;
590         }
591         return -1; /* undecided */
592 }
593
594 static int excluded(struct dir_struct *dir, const char *pathname, int *dtype_p)
595 {
596         int pathlen = strlen(pathname);
597         int st;
598         const char *basename = strrchr(pathname, '/');
599         basename = (basename) ? basename+1 : pathname;
600
601         prep_exclude(dir, pathname, basename-pathname);
602         for (st = EXC_CMDL; st <= EXC_FILE; st++) {
603                 switch (excluded_from_list(pathname, pathlen, basename,
604                                            dtype_p, &dir->exclude_list[st])) {
605                 case 0:
606                         return 0;
607                 case 1:
608                         return 1;
609                 }
610         }
611         return 0;
612 }
613
614 void path_exclude_check_init(struct path_exclude_check *check,
615                              struct dir_struct *dir)
616 {
617         check->dir = dir;
618         strbuf_init(&check->path, 256);
619 }
620
621 void path_exclude_check_clear(struct path_exclude_check *check)
622 {
623         strbuf_release(&check->path);
624 }
625
626 /*
627  * Is this name excluded?  This is for a caller like show_files() that
628  * do not honor directory hierarchy and iterate through paths that are
629  * possibly in an ignored directory.
630  *
631  * A path to a directory known to be excluded is left in check->path to
632  * optimize for repeated checks for files in the same excluded directory.
633  */
634 int path_excluded(struct path_exclude_check *check,
635                   const char *name, int namelen, int *dtype)
636 {
637         int i;
638         struct strbuf *path = &check->path;
639
640         /*
641          * we allow the caller to pass namelen as an optimization; it
642          * must match the length of the name, as we eventually call
643          * excluded() on the whole name string.
644          */
645         if (namelen < 0)
646                 namelen = strlen(name);
647
648         if (path->len &&
649             path->len <= namelen &&
650             !memcmp(name, path->buf, path->len) &&
651             (!name[path->len] || name[path->len] == '/'))
652                 return 1;
653
654         strbuf_setlen(path, 0);
655         for (i = 0; name[i]; i++) {
656                 int ch = name[i];
657
658                 if (ch == '/') {
659                         int dt = DT_DIR;
660                         if (excluded(check->dir, path->buf, &dt))
661                                 return 1;
662                 }
663                 strbuf_addch(path, ch);
664         }
665
666         /* An entry in the index; cannot be a directory with subentries */
667         strbuf_setlen(path, 0);
668
669         return excluded(check->dir, name, dtype);
670 }
671
672 static struct dir_entry *dir_entry_new(const char *pathname, int len)
673 {
674         struct dir_entry *ent;
675
676         ent = xmalloc(sizeof(*ent) + len + 1);
677         ent->len = len;
678         memcpy(ent->name, pathname, len);
679         ent->name[len] = 0;
680         return ent;
681 }
682
683 static struct dir_entry *dir_add_name(struct dir_struct *dir, const char *pathname, int len)
684 {
685         if (cache_name_exists(pathname, len, ignore_case))
686                 return NULL;
687
688         ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
689         return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
690 }
691
692 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len)
693 {
694         if (!cache_name_is_other(pathname, len))
695                 return NULL;
696
697         ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
698         return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
699 }
700
701 enum exist_status {
702         index_nonexistent = 0,
703         index_directory,
704         index_gitdir
705 };
706
707 /*
708  * Do not use the alphabetically stored index to look up
709  * the directory name; instead, use the case insensitive
710  * name hash.
711  */
712 static enum exist_status directory_exists_in_index_icase(const char *dirname, int len)
713 {
714         struct cache_entry *ce = index_name_exists(&the_index, dirname, len + 1, ignore_case);
715         unsigned char endchar;
716
717         if (!ce)
718                 return index_nonexistent;
719         endchar = ce->name[len];
720
721         /*
722          * The cache_entry structure returned will contain this dirname
723          * and possibly additional path components.
724          */
725         if (endchar == '/')
726                 return index_directory;
727
728         /*
729          * If there are no additional path components, then this cache_entry
730          * represents a submodule.  Submodules, despite being directories,
731          * are stored in the cache without a closing slash.
732          */
733         if (!endchar && S_ISGITLINK(ce->ce_mode))
734                 return index_gitdir;
735
736         /* This should never be hit, but it exists just in case. */
737         return index_nonexistent;
738 }
739
740 /*
741  * The index sorts alphabetically by entry name, which
742  * means that a gitlink sorts as '\0' at the end, while
743  * a directory (which is defined not as an entry, but as
744  * the files it contains) will sort with the '/' at the
745  * end.
746  */
747 static enum exist_status directory_exists_in_index(const char *dirname, int len)
748 {
749         int pos;
750
751         if (ignore_case)
752                 return directory_exists_in_index_icase(dirname, len);
753
754         pos = cache_name_pos(dirname, len);
755         if (pos < 0)
756                 pos = -pos-1;
757         while (pos < active_nr) {
758                 struct cache_entry *ce = active_cache[pos++];
759                 unsigned char endchar;
760
761                 if (strncmp(ce->name, dirname, len))
762                         break;
763                 endchar = ce->name[len];
764                 if (endchar > '/')
765                         break;
766                 if (endchar == '/')
767                         return index_directory;
768                 if (!endchar && S_ISGITLINK(ce->ce_mode))
769                         return index_gitdir;
770         }
771         return index_nonexistent;
772 }
773
774 /*
775  * When we find a directory when traversing the filesystem, we
776  * have three distinct cases:
777  *
778  *  - ignore it
779  *  - see it as a directory
780  *  - recurse into it
781  *
782  * and which one we choose depends on a combination of existing
783  * git index contents and the flags passed into the directory
784  * traversal routine.
785  *
786  * Case 1: If we *already* have entries in the index under that
787  * directory name, we always recurse into the directory to see
788  * all the files.
789  *
790  * Case 2: If we *already* have that directory name as a gitlink,
791  * we always continue to see it as a gitlink, regardless of whether
792  * there is an actual git directory there or not (it might not
793  * be checked out as a subproject!)
794  *
795  * Case 3: if we didn't have it in the index previously, we
796  * have a few sub-cases:
797  *
798  *  (a) if "show_other_directories" is true, we show it as
799  *      just a directory, unless "hide_empty_directories" is
800  *      also true and the directory is empty, in which case
801  *      we just ignore it entirely.
802  *  (b) if it looks like a git directory, and we don't have
803  *      'no_gitlinks' set we treat it as a gitlink, and show it
804  *      as a directory.
805  *  (c) otherwise, we recurse into it.
806  */
807 enum directory_treatment {
808         show_directory,
809         ignore_directory,
810         recurse_into_directory
811 };
812
813 static enum directory_treatment treat_directory(struct dir_struct *dir,
814         const char *dirname, int len,
815         const struct path_simplify *simplify)
816 {
817         /* The "len-1" is to strip the final '/' */
818         switch (directory_exists_in_index(dirname, len-1)) {
819         case index_directory:
820                 return recurse_into_directory;
821
822         case index_gitdir:
823                 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
824                         return ignore_directory;
825                 return show_directory;
826
827         case index_nonexistent:
828                 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
829                         break;
830                 if (!(dir->flags & DIR_NO_GITLINKS)) {
831                         unsigned char sha1[20];
832                         if (resolve_gitlink_ref(dirname, "HEAD", sha1) == 0)
833                                 return show_directory;
834                 }
835                 return recurse_into_directory;
836         }
837
838         /* This is the "show_other_directories" case */
839         if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
840                 return show_directory;
841         if (!read_directory_recursive(dir, dirname, len, 1, simplify))
842                 return ignore_directory;
843         return show_directory;
844 }
845
846 /*
847  * This is an inexact early pruning of any recursive directory
848  * reading - if the path cannot possibly be in the pathspec,
849  * return true, and we'll skip it early.
850  */
851 static int simplify_away(const char *path, int pathlen, const struct path_simplify *simplify)
852 {
853         if (simplify) {
854                 for (;;) {
855                         const char *match = simplify->path;
856                         int len = simplify->len;
857
858                         if (!match)
859                                 break;
860                         if (len > pathlen)
861                                 len = pathlen;
862                         if (!memcmp(path, match, len))
863                                 return 0;
864                         simplify++;
865                 }
866                 return 1;
867         }
868         return 0;
869 }
870
871 /*
872  * This function tells us whether an excluded path matches a
873  * list of "interesting" pathspecs. That is, whether a path matched
874  * by any of the pathspecs could possibly be ignored by excluding
875  * the specified path. This can happen if:
876  *
877  *   1. the path is mentioned explicitly in the pathspec
878  *
879  *   2. the path is a directory prefix of some element in the
880  *      pathspec
881  */
882 static int exclude_matches_pathspec(const char *path, int len,
883                 const struct path_simplify *simplify)
884 {
885         if (simplify) {
886                 for (; simplify->path; simplify++) {
887                         if (len == simplify->len
888                             && !memcmp(path, simplify->path, len))
889                                 return 1;
890                         if (len < simplify->len
891                             && simplify->path[len] == '/'
892                             && !memcmp(path, simplify->path, len))
893                                 return 1;
894                 }
895         }
896         return 0;
897 }
898
899 static int get_index_dtype(const char *path, int len)
900 {
901         int pos;
902         struct cache_entry *ce;
903
904         ce = cache_name_exists(path, len, 0);
905         if (ce) {
906                 if (!ce_uptodate(ce))
907                         return DT_UNKNOWN;
908                 if (S_ISGITLINK(ce->ce_mode))
909                         return DT_DIR;
910                 /*
911                  * Nobody actually cares about the
912                  * difference between DT_LNK and DT_REG
913                  */
914                 return DT_REG;
915         }
916
917         /* Try to look it up as a directory */
918         pos = cache_name_pos(path, len);
919         if (pos >= 0)
920                 return DT_UNKNOWN;
921         pos = -pos-1;
922         while (pos < active_nr) {
923                 ce = active_cache[pos++];
924                 if (strncmp(ce->name, path, len))
925                         break;
926                 if (ce->name[len] > '/')
927                         break;
928                 if (ce->name[len] < '/')
929                         continue;
930                 if (!ce_uptodate(ce))
931                         break;  /* continue? */
932                 return DT_DIR;
933         }
934         return DT_UNKNOWN;
935 }
936
937 static int get_dtype(struct dirent *de, const char *path, int len)
938 {
939         int dtype = de ? DTYPE(de) : DT_UNKNOWN;
940         struct stat st;
941
942         if (dtype != DT_UNKNOWN)
943                 return dtype;
944         dtype = get_index_dtype(path, len);
945         if (dtype != DT_UNKNOWN)
946                 return dtype;
947         if (lstat(path, &st))
948                 return dtype;
949         if (S_ISREG(st.st_mode))
950                 return DT_REG;
951         if (S_ISDIR(st.st_mode))
952                 return DT_DIR;
953         if (S_ISLNK(st.st_mode))
954                 return DT_LNK;
955         return dtype;
956 }
957
958 enum path_treatment {
959         path_ignored,
960         path_handled,
961         path_recurse
962 };
963
964 static enum path_treatment treat_one_path(struct dir_struct *dir,
965                                           struct strbuf *path,
966                                           const struct path_simplify *simplify,
967                                           int dtype, struct dirent *de)
968 {
969         int exclude = excluded(dir, path->buf, &dtype);
970         if (exclude && (dir->flags & DIR_COLLECT_IGNORED)
971             && exclude_matches_pathspec(path->buf, path->len, simplify))
972                 dir_add_ignored(dir, path->buf, path->len);
973
974         /*
975          * Excluded? If we don't explicitly want to show
976          * ignored files, ignore it
977          */
978         if (exclude && !(dir->flags & DIR_SHOW_IGNORED))
979                 return path_ignored;
980
981         if (dtype == DT_UNKNOWN)
982                 dtype = get_dtype(de, path->buf, path->len);
983
984         /*
985          * Do we want to see just the ignored files?
986          * We still need to recurse into directories,
987          * even if we don't ignore them, since the
988          * directory may contain files that we do..
989          */
990         if (!exclude && (dir->flags & DIR_SHOW_IGNORED)) {
991                 if (dtype != DT_DIR)
992                         return path_ignored;
993         }
994
995         switch (dtype) {
996         default:
997                 return path_ignored;
998         case DT_DIR:
999                 strbuf_addch(path, '/');
1000                 switch (treat_directory(dir, path->buf, path->len, simplify)) {
1001                 case show_directory:
1002                         if (exclude != !!(dir->flags
1003                                           & DIR_SHOW_IGNORED))
1004                                 return path_ignored;
1005                         break;
1006                 case recurse_into_directory:
1007                         return path_recurse;
1008                 case ignore_directory:
1009                         return path_ignored;
1010                 }
1011                 break;
1012         case DT_REG:
1013         case DT_LNK:
1014                 break;
1015         }
1016         return path_handled;
1017 }
1018
1019 static enum path_treatment treat_path(struct dir_struct *dir,
1020                                       struct dirent *de,
1021                                       struct strbuf *path,
1022                                       int baselen,
1023                                       const struct path_simplify *simplify)
1024 {
1025         int dtype;
1026
1027         if (is_dot_or_dotdot(de->d_name) || !strcmp(de->d_name, ".git"))
1028                 return path_ignored;
1029         strbuf_setlen(path, baselen);
1030         strbuf_addstr(path, de->d_name);
1031         if (simplify_away(path->buf, path->len, simplify))
1032                 return path_ignored;
1033
1034         dtype = DTYPE(de);
1035         return treat_one_path(dir, path, simplify, dtype, de);
1036 }
1037
1038 /*
1039  * Read a directory tree. We currently ignore anything but
1040  * directories, regular files and symlinks. That's because git
1041  * doesn't handle them at all yet. Maybe that will change some
1042  * day.
1043  *
1044  * Also, we ignore the name ".git" (even if it is not a directory).
1045  * That likely will not change.
1046  */
1047 static int read_directory_recursive(struct dir_struct *dir,
1048                                     const char *base, int baselen,
1049                                     int check_only,
1050                                     const struct path_simplify *simplify)
1051 {
1052         DIR *fdir;
1053         int contents = 0;
1054         struct dirent *de;
1055         struct strbuf path = STRBUF_INIT;
1056
1057         strbuf_add(&path, base, baselen);
1058
1059         fdir = opendir(path.len ? path.buf : ".");
1060         if (!fdir)
1061                 goto out;
1062
1063         while ((de = readdir(fdir)) != NULL) {
1064                 switch (treat_path(dir, de, &path, baselen, simplify)) {
1065                 case path_recurse:
1066                         contents += read_directory_recursive(dir, path.buf,
1067                                                              path.len, 0,
1068                                                              simplify);
1069                         continue;
1070                 case path_ignored:
1071                         continue;
1072                 case path_handled:
1073                         break;
1074                 }
1075                 contents++;
1076                 if (check_only)
1077                         break;
1078                 dir_add_name(dir, path.buf, path.len);
1079         }
1080         closedir(fdir);
1081  out:
1082         strbuf_release(&path);
1083
1084         return contents;
1085 }
1086
1087 static int cmp_name(const void *p1, const void *p2)
1088 {
1089         const struct dir_entry *e1 = *(const struct dir_entry **)p1;
1090         const struct dir_entry *e2 = *(const struct dir_entry **)p2;
1091
1092         return cache_name_compare(e1->name, e1->len,
1093                                   e2->name, e2->len);
1094 }
1095
1096 static struct path_simplify *create_simplify(const char **pathspec)
1097 {
1098         int nr, alloc = 0;
1099         struct path_simplify *simplify = NULL;
1100
1101         if (!pathspec)
1102                 return NULL;
1103
1104         for (nr = 0 ; ; nr++) {
1105                 const char *match;
1106                 if (nr >= alloc) {
1107                         alloc = alloc_nr(alloc);
1108                         simplify = xrealloc(simplify, alloc * sizeof(*simplify));
1109                 }
1110                 match = *pathspec++;
1111                 if (!match)
1112                         break;
1113                 simplify[nr].path = match;
1114                 simplify[nr].len = simple_length(match);
1115         }
1116         simplify[nr].path = NULL;
1117         simplify[nr].len = 0;
1118         return simplify;
1119 }
1120
1121 static void free_simplify(struct path_simplify *simplify)
1122 {
1123         free(simplify);
1124 }
1125
1126 static int treat_leading_path(struct dir_struct *dir,
1127                               const char *path, int len,
1128                               const struct path_simplify *simplify)
1129 {
1130         struct strbuf sb = STRBUF_INIT;
1131         int baselen, rc = 0;
1132         const char *cp;
1133
1134         while (len && path[len - 1] == '/')
1135                 len--;
1136         if (!len)
1137                 return 1;
1138         baselen = 0;
1139         while (1) {
1140                 cp = path + baselen + !!baselen;
1141                 cp = memchr(cp, '/', path + len - cp);
1142                 if (!cp)
1143                         baselen = len;
1144                 else
1145                         baselen = cp - path;
1146                 strbuf_setlen(&sb, 0);
1147                 strbuf_add(&sb, path, baselen);
1148                 if (!is_directory(sb.buf))
1149                         break;
1150                 if (simplify_away(sb.buf, sb.len, simplify))
1151                         break;
1152                 if (treat_one_path(dir, &sb, simplify,
1153                                    DT_DIR, NULL) == path_ignored)
1154                         break; /* do not recurse into it */
1155                 if (len <= baselen) {
1156                         rc = 1;
1157                         break; /* finished checking */
1158                 }
1159         }
1160         strbuf_release(&sb);
1161         return rc;
1162 }
1163
1164 int read_directory(struct dir_struct *dir, const char *path, int len, const char **pathspec)
1165 {
1166         struct path_simplify *simplify;
1167
1168         if (has_symlink_leading_path(path, len))
1169                 return dir->nr;
1170
1171         simplify = create_simplify(pathspec);
1172         if (!len || treat_leading_path(dir, path, len, simplify))
1173                 read_directory_recursive(dir, path, len, 0, simplify);
1174         free_simplify(simplify);
1175         qsort(dir->entries, dir->nr, sizeof(struct dir_entry *), cmp_name);
1176         qsort(dir->ignored, dir->ignored_nr, sizeof(struct dir_entry *), cmp_name);
1177         return dir->nr;
1178 }
1179
1180 int file_exists(const char *f)
1181 {
1182         struct stat sb;
1183         return lstat(f, &sb) == 0;
1184 }
1185
1186 /*
1187  * Given two normalized paths (a trailing slash is ok), if subdir is
1188  * outside dir, return -1.  Otherwise return the offset in subdir that
1189  * can be used as relative path to dir.
1190  */
1191 int dir_inside_of(const char *subdir, const char *dir)
1192 {
1193         int offset = 0;
1194
1195         assert(dir && subdir && *dir && *subdir);
1196
1197         while (*dir && *subdir && *dir == *subdir) {
1198                 dir++;
1199                 subdir++;
1200                 offset++;
1201         }
1202
1203         /* hel[p]/me vs hel[l]/yeah */
1204         if (*dir && *subdir)
1205                 return -1;
1206
1207         if (!*subdir)
1208                 return !*dir ? offset : -1; /* same dir */
1209
1210         /* foo/[b]ar vs foo/[] */
1211         if (is_dir_sep(dir[-1]))
1212                 return is_dir_sep(subdir[-1]) ? offset : -1;
1213
1214         /* foo[/]bar vs foo[] */
1215         return is_dir_sep(*subdir) ? offset + 1 : -1;
1216 }
1217
1218 int is_inside_dir(const char *dir)
1219 {
1220         char cwd[PATH_MAX];
1221         if (!dir)
1222                 return 0;
1223         if (!getcwd(cwd, sizeof(cwd)))
1224                 die_errno("can't find the current directory");
1225         return dir_inside_of(cwd, dir) >= 0;
1226 }
1227
1228 int is_empty_dir(const char *path)
1229 {
1230         DIR *dir = opendir(path);
1231         struct dirent *e;
1232         int ret = 1;
1233
1234         if (!dir)
1235                 return 0;
1236
1237         while ((e = readdir(dir)) != NULL)
1238                 if (!is_dot_or_dotdot(e->d_name)) {
1239                         ret = 0;
1240                         break;
1241                 }
1242
1243         closedir(dir);
1244         return ret;
1245 }
1246
1247 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
1248 {
1249         DIR *dir;
1250         struct dirent *e;
1251         int ret = 0, original_len = path->len, len, kept_down = 0;
1252         int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
1253         int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
1254         unsigned char submodule_head[20];
1255
1256         if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
1257             !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
1258                 /* Do not descend and nuke a nested git work tree. */
1259                 if (kept_up)
1260                         *kept_up = 1;
1261                 return 0;
1262         }
1263
1264         flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
1265         dir = opendir(path->buf);
1266         if (!dir) {
1267                 /* an empty dir could be removed even if it is unreadble */
1268                 if (!keep_toplevel)
1269                         return rmdir(path->buf);
1270                 else
1271                         return -1;
1272         }
1273         if (path->buf[original_len - 1] != '/')
1274                 strbuf_addch(path, '/');
1275
1276         len = path->len;
1277         while ((e = readdir(dir)) != NULL) {
1278                 struct stat st;
1279                 if (is_dot_or_dotdot(e->d_name))
1280                         continue;
1281
1282                 strbuf_setlen(path, len);
1283                 strbuf_addstr(path, e->d_name);
1284                 if (lstat(path->buf, &st))
1285                         ; /* fall thru */
1286                 else if (S_ISDIR(st.st_mode)) {
1287                         if (!remove_dir_recurse(path, flag, &kept_down))
1288                                 continue; /* happy */
1289                 } else if (!only_empty && !unlink(path->buf))
1290                         continue; /* happy, too */
1291
1292                 /* path too long, stat fails, or non-directory still exists */
1293                 ret = -1;
1294                 break;
1295         }
1296         closedir(dir);
1297
1298         strbuf_setlen(path, original_len);
1299         if (!ret && !keep_toplevel && !kept_down)
1300                 ret = rmdir(path->buf);
1301         else if (kept_up)
1302                 /*
1303                  * report the uplevel that it is not an error that we
1304                  * did not rmdir() our directory.
1305                  */
1306                 *kept_up = !ret;
1307         return ret;
1308 }
1309
1310 int remove_dir_recursively(struct strbuf *path, int flag)
1311 {
1312         return remove_dir_recurse(path, flag, NULL);
1313 }
1314
1315 void setup_standard_excludes(struct dir_struct *dir)
1316 {
1317         const char *path;
1318
1319         dir->exclude_per_dir = ".gitignore";
1320         path = git_path("info/exclude");
1321         if (!access(path, R_OK))
1322                 add_excludes_from_file(dir, path);
1323         if (excludes_file && !access(excludes_file, R_OK))
1324                 add_excludes_from_file(dir, excludes_file);
1325 }
1326
1327 int remove_path(const char *name)
1328 {
1329         char *slash;
1330
1331         if (unlink(name) && errno != ENOENT)
1332                 return -1;
1333
1334         slash = strrchr(name, '/');
1335         if (slash) {
1336                 char *dirs = xstrdup(name);
1337                 slash = dirs + (slash - name);
1338                 do {
1339                         *slash = '\0';
1340                 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
1341                 free(dirs);
1342         }
1343         return 0;
1344 }
1345
1346 static int pathspec_item_cmp(const void *a_, const void *b_)
1347 {
1348         struct pathspec_item *a, *b;
1349
1350         a = (struct pathspec_item *)a_;
1351         b = (struct pathspec_item *)b_;
1352         return strcmp(a->match, b->match);
1353 }
1354
1355 int init_pathspec(struct pathspec *pathspec, const char **paths)
1356 {
1357         const char **p = paths;
1358         int i;
1359
1360         memset(pathspec, 0, sizeof(*pathspec));
1361         if (!p)
1362                 return 0;
1363         while (*p)
1364                 p++;
1365         pathspec->raw = paths;
1366         pathspec->nr = p - paths;
1367         if (!pathspec->nr)
1368                 return 0;
1369
1370         pathspec->items = xmalloc(sizeof(struct pathspec_item)*pathspec->nr);
1371         for (i = 0; i < pathspec->nr; i++) {
1372                 struct pathspec_item *item = pathspec->items+i;
1373                 const char *path = paths[i];
1374
1375                 item->match = path;
1376                 item->len = strlen(path);
1377                 item->use_wildcard = !no_wildcard(path);
1378                 if (item->use_wildcard)
1379                         pathspec->has_wildcard = 1;
1380         }
1381
1382         qsort(pathspec->items, pathspec->nr,
1383               sizeof(struct pathspec_item), pathspec_item_cmp);
1384
1385         return 0;
1386 }
1387
1388 void free_pathspec(struct pathspec *pathspec)
1389 {
1390         free(pathspec->items);
1391         pathspec->items = NULL;
1392 }