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