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