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