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 (cache_name_exists(pathname, len, ignore_case))
 676                 return NULL;
 677
 678         ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
 679         return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
 680 }
 681
 682 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len)
 683 {
 684         if (!cache_name_is_other(pathname, len))
 685                 return NULL;
 686
 687         ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
 688         return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
 689 }
 690
 691 enum exist_status {
 692         index_nonexistent = 0,
 693         index_directory,
 694         index_gitdir
 695 };
 696
 697 /*
 698  * Do not use the alphabetically stored index to look up
 699  * the directory name; instead, use the case insensitive
 700  * name hash.
 701  */
 702 static enum exist_status directory_exists_in_index_icase(const char *dirname, int len)
 703 {
 704         struct cache_entry *ce = index_name_exists(&the_index, dirname, len + 1, ignore_case);
 705         unsigned char endchar;
 706
 707         if (!ce)
 708                 return index_nonexistent;
 709         endchar = ce->name[len];
 710
 711         /*
 712          * The cache_entry structure returned will contain this dirname
 713          * and possibly additional path components.
 714          */
 715         if (endchar == '/')
 716                 return index_directory;
 717
 718         /*
 719          * If there are no additional path components, then this cache_entry
 720          * represents a submodule.  Submodules, despite being directories,
 721          * are stored in the cache without a closing slash.
 722          */
 723         if (!endchar && S_ISGITLINK(ce->ce_mode))
 724                 return index_gitdir;
 725
 726         /* This should never be hit, but it exists just in case. */
 727         return index_nonexistent;
 728 }
 729
 730 /*
 731  * The index sorts alphabetically by entry name, which
 732  * means that a gitlink sorts as '\0' at the end, while
 733  * a directory (which is defined not as an entry, but as
 734  * the files it contains) will sort with the '/' at the
 735  * end.
 736  */
 737 static enum exist_status directory_exists_in_index(const char *dirname, int len)
 738 {
 739         int pos;
 740
 741         if (ignore_case)
 742                 return directory_exists_in_index_icase(dirname, len);
 743
 744         pos = cache_name_pos(dirname, len);
 745         if (pos < 0)
 746                 pos = -pos-1;
 747         while (pos < active_nr) {
 748                 struct cache_entry *ce = active_cache[pos++];
 749                 unsigned char endchar;
 750
 751                 if (strncmp(ce->name, dirname, len))
 752                         break;
 753                 endchar = ce->name[len];
 754                 if (endchar > '/')
 755                         break;
 756                 if (endchar == '/')
 757                         return index_directory;
 758                 if (!endchar && S_ISGITLINK(ce->ce_mode))
 759                         return index_gitdir;
 760         }
 761         return index_nonexistent;
 762 }
 763
 764 /*
 765  * When we find a directory when traversing the filesystem, we
 766  * have three distinct cases:
 767  *
 768  *  - ignore it
 769  *  - see it as a directory
 770  *  - recurse into it
 771  *
 772  * and which one we choose depends on a combination of existing
 773  * git index contents and the flags passed into the directory
 774  * traversal routine.
 775  *
 776  * Case 1: If we *already* have entries in the index under that
 777  * directory name, we recurse into the directory to see all the files,
 778  * unless the directory is excluded and we want to show ignored
 779  * directories
 780  *
 781  * Case 2: If we *already* have that directory name as a gitlink,
 782  * we always continue to see it as a gitlink, regardless of whether
 783  * there is an actual git directory there or not (it might not
 784  * be checked out as a subproject!)
 785  *
 786  * Case 3: if we didn't have it in the index previously, we
 787  * have a few sub-cases:
 788  *
 789  *  (a) if "show_other_directories" is true, we show it as
 790  *      just a directory, unless "hide_empty_directories" is
 791  *      also true and the directory is empty, in which case
 792  *      we just ignore it entirely.
 793  *      if we are looking for ignored directories, look if it
 794  *      contains only ignored files to decide if it must be shown as
 795  *      ignored or not.
 796  *  (b) if it looks like a git directory, and we don't have
 797  *      'no_gitlinks' set we treat it as a gitlink, and show it
 798  *      as a directory.
 799  *  (c) otherwise, we recurse into it.
 800  */
 801 enum directory_treatment {
 802         show_directory,
 803         ignore_directory,
 804         recurse_into_directory
 805 };
 806
 807 static enum directory_treatment treat_directory(struct dir_struct *dir,
 808         const char *dirname, int len, int exclude,
 809         const struct path_simplify *simplify)
 810 {
 811         /* The "len-1" is to strip the final '/' */
 812         switch (directory_exists_in_index(dirname, len-1)) {
 813         case index_directory:
 814                 if ((dir->flags & DIR_SHOW_OTHER_DIRECTORIES) && exclude)
 815                         break;
 816
 817                 return recurse_into_directory;
 818
 819         case index_gitdir:
 820                 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
 821                         return ignore_directory;
 822                 return show_directory;
 823
 824         case index_nonexistent:
 825                 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
 826                         break;
 827                 if (!(dir->flags & DIR_NO_GITLINKS)) {
 828                         unsigned char sha1[20];
 829                         if (resolve_gitlink_ref(dirname, "HEAD", sha1) == 0)
 830                                 return show_directory;
 831                 }
 832                 return recurse_into_directory;
 833         }
 834
 835         /* This is the "show_other_directories" case */
 836
 837         /*
 838          * We are looking for ignored files and our directory is not ignored,
 839          * check if it contains only ignored files
 840          */
 841         if ((dir->flags & DIR_SHOW_IGNORED) && !exclude) {
 842                 int ignored;
 843                 dir->flags &= ~DIR_SHOW_IGNORED;
 844                 dir->flags |= DIR_HIDE_EMPTY_DIRECTORIES;
 845                 ignored = read_directory_recursive(dir, dirname, len, 1, simplify);
 846                 dir->flags &= ~DIR_HIDE_EMPTY_DIRECTORIES;
 847                 dir->flags |= DIR_SHOW_IGNORED;
 848
 849                 return ignored ? ignore_directory : show_directory;
 850         }
 851         if (!(dir->flags & DIR_SHOW_IGNORED) &&
 852             !(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
 853                 return show_directory;
 854         if (!read_directory_recursive(dir, dirname, len, 1, simplify))
 855                 return ignore_directory;
 856         return show_directory;
 857 }
 858
 859 /*
 860  * Decide what to do when we find a file while traversing the
 861  * filesystem. Mostly two cases:
 862  *
 863  *  1. We are looking for ignored files
 864  *   (a) File is ignored, include it
 865  *   (b) File is in ignored path, include it
 866  *   (c) File is not ignored, exclude it
 867  *
 868  *  2. Other scenarios, include the file if not excluded
 869  *
 870  * Return 1 for exclude, 0 for include.
 871  */
 872 static int treat_file(struct dir_struct *dir, struct strbuf *path, int exclude, int *dtype)
 873 {
 874         struct path_exclude_check check;
 875         int exclude_file = 0;
 876
 877         if (exclude)
 878                 exclude_file = !(dir->flags & DIR_SHOW_IGNORED);
 879         else if (dir->flags & DIR_SHOW_IGNORED) {
 880                 /*
 881                  * Optimization:
 882                  * Don't spend time on indexed files, they won't be
 883                  * added to the list anyway
 884                  */
 885                 struct cache_entry *ce = index_name_exists(&the_index,
 886                     path->buf, path->len, ignore_case);
 887
 888                 if (ce)
 889                         return 1;
 890
 891                 path_exclude_check_init(&check, dir);
 892
 893                 if (!path_excluded(&check, path->buf, path->len, dtype))
 894                         exclude_file = 1;
 895
 896                 path_exclude_check_clear(&check);
 897         }
 898
 899         return exclude_file;
 900 }
 901
 902 /*
 903  * This is an inexact early pruning of any recursive directory
 904  * reading - if the path cannot possibly be in the pathspec,
 905  * return true, and we'll skip it early.
 906  */
 907 static int simplify_away(const char *path, int pathlen, const struct path_simplify *simplify)
 908 {
 909         if (simplify) {
 910                 for (;;) {
 911                         const char *match = simplify->path;
 912                         int len = simplify->len;
 913
 914                         if (!match)
 915                                 break;
 916                         if (len > pathlen)
 917                                 len = pathlen;
 918                         if (!memcmp(path, match, len))
 919                                 return 0;
 920                         simplify++;
 921                 }
 922                 return 1;
 923         }
 924         return 0;
 925 }
 926
 927 /*
 928  * This function tells us whether an excluded path matches a
 929  * list of "interesting" pathspecs. That is, whether a path matched
 930  * by any of the pathspecs could possibly be ignored by excluding
 931  * the specified path. This can happen if:
 932  *
 933  *   1. the path is mentioned explicitly in the pathspec
 934  *
 935  *   2. the path is a directory prefix of some element in the
 936  *      pathspec
 937  */
 938 static int exclude_matches_pathspec(const char *path, int len,
 939                 const struct path_simplify *simplify)
 940 {
 941         if (simplify) {
 942                 for (; simplify->path; simplify++) {
 943                         if (len == simplify->len
 944                             && !memcmp(path, simplify->path, len))
 945                                 return 1;
 946                         if (len < simplify->len
 947                             && simplify->path[len] == '/'
 948                             && !memcmp(path, simplify->path, len))
 949                                 return 1;
 950                 }
 951         }
 952         return 0;
 953 }
 954
 955 static int get_index_dtype(const char *path, int len)
 956 {
 957         int pos;
 958         struct cache_entry *ce;
 959
 960         ce = cache_name_exists(path, len, 0);
 961         if (ce) {
 962                 if (!ce_uptodate(ce))
 963                         return DT_UNKNOWN;
 964                 if (S_ISGITLINK(ce->ce_mode))
 965                         return DT_DIR;
 966                 /*
 967                  * Nobody actually cares about the
 968                  * difference between DT_LNK and DT_REG
 969                  */
 970                 return DT_REG;
 971         }
 972
 973         /* Try to look it up as a directory */
 974         pos = cache_name_pos(path, len);
 975         if (pos >= 0)
 976                 return DT_UNKNOWN;
 977         pos = -pos-1;
 978         while (pos < active_nr) {
 979                 ce = active_cache[pos++];
 980                 if (strncmp(ce->name, path, len))
 981                         break;
 982                 if (ce->name[len] > '/')
 983                         break;
 984                 if (ce->name[len] < '/')
 985                         continue;
 986                 if (!ce_uptodate(ce))
 987                         break;  /* continue? */
 988                 return DT_DIR;
 989         }
 990         return DT_UNKNOWN;
 991 }
 992
 993 static int get_dtype(struct dirent *de, const char *path, int len)
 994 {
 995         int dtype = de ? DTYPE(de) : DT_UNKNOWN;
 996         struct stat st;
 997
 998         if (dtype != DT_UNKNOWN)
 999                 return dtype;
1000         dtype = get_index_dtype(path, len);
1001         if (dtype != DT_UNKNOWN)
1002                 return dtype;
1003         if (lstat(path, &st))
1004                 return dtype;
1005         if (S_ISREG(st.st_mode))
1006                 return DT_REG;
1007         if (S_ISDIR(st.st_mode))
1008                 return DT_DIR;
1009         if (S_ISLNK(st.st_mode))
1010                 return DT_LNK;
1011         return dtype;
1012 }
1013
1014 enum path_treatment {
1015         path_ignored,
1016         path_handled,
1017         path_recurse
1018 };
1019
1020 static enum path_treatment treat_one_path(struct dir_struct *dir,
1021                                           struct strbuf *path,
1022                                           const struct path_simplify *simplify,
1023                                           int dtype, struct dirent *de)
1024 {
1025         int exclude = excluded(dir, path->buf, &dtype);
1026         if (exclude && (dir->flags & DIR_COLLECT_IGNORED)
1027             && exclude_matches_pathspec(path->buf, path->len, simplify))
1028                 dir_add_ignored(dir, path->buf, path->len);
1029
1030         /*
1031          * Excluded? If we don't explicitly want to show
1032          * ignored files, ignore it
1033          */
1034         if (exclude && !(dir->flags & DIR_SHOW_IGNORED))
1035                 return path_ignored;
1036
1037         if (dtype == DT_UNKNOWN)
1038                 dtype = get_dtype(de, path->buf, path->len);
1039
1040         switch (dtype) {
1041         default:
1042                 return path_ignored;
1043         case DT_DIR:
1044                 strbuf_addch(path, '/');
1045
1046                 switch (treat_directory(dir, path->buf, path->len, exclude, simplify)) {
1047                 case show_directory:
1048                         break;
1049                 case recurse_into_directory:
1050                         return path_recurse;
1051                 case ignore_directory:
1052                         return path_ignored;
1053                 }
1054                 break;
1055         case DT_REG:
1056         case DT_LNK:
1057                 switch (treat_file(dir, path, exclude, &dtype)) {
1058                 case 1:
1059                         return path_ignored;
1060                 default:
1061                         break;
1062                 }
1063         }
1064         return path_handled;
1065 }
1066
1067 static enum path_treatment treat_path(struct dir_struct *dir,
1068                                       struct dirent *de,
1069                                       struct strbuf *path,
1070                                       int baselen,
1071                                       const struct path_simplify *simplify)
1072 {
1073         int dtype;
1074
1075         if (is_dot_or_dotdot(de->d_name) || !strcmp(de->d_name, ".git"))
1076                 return path_ignored;
1077         strbuf_setlen(path, baselen);
1078         strbuf_addstr(path, de->d_name);
1079         if (simplify_away(path->buf, path->len, simplify))
1080                 return path_ignored;
1081
1082         dtype = DTYPE(de);
1083         return treat_one_path(dir, path, simplify, dtype, de);
1084 }
1085
1086 /*
1087  * Read a directory tree. We currently ignore anything but
1088  * directories, regular files and symlinks. That's because git
1089  * doesn't handle them at all yet. Maybe that will change some
1090  * day.
1091  *
1092  * Also, we ignore the name ".git" (even if it is not a directory).
1093  * That likely will not change.
1094  */
1095 static int read_directory_recursive(struct dir_struct *dir,
1096                                     const char *base, int baselen,
1097                                     int check_only,
1098                                     const struct path_simplify *simplify)
1099 {
1100         DIR *fdir;
1101         int contents = 0;
1102         struct dirent *de;
1103         struct strbuf path = STRBUF_INIT;
1104
1105         strbuf_add(&path, base, baselen);
1106
1107         fdir = opendir(path.len ? path.buf : ".");
1108         if (!fdir)
1109                 goto out;
1110
1111         while ((de = readdir(fdir)) != NULL) {
1112                 switch (treat_path(dir, de, &path, baselen, simplify)) {
1113                 case path_recurse:
1114                         contents += read_directory_recursive(dir, path.buf,
1115                                                              path.len, 0,
1116                                                              simplify);
1117                         continue;
1118                 case path_ignored:
1119                         continue;
1120                 case path_handled:
1121                         break;
1122                 }
1123                 contents++;
1124                 if (check_only)
1125                         break;
1126                 dir_add_name(dir, path.buf, path.len);
1127         }
1128         closedir(fdir);
1129  out:
1130         strbuf_release(&path);
1131
1132         return contents;
1133 }
1134
1135 static int cmp_name(const void *p1, const void *p2)
1136 {
1137         const struct dir_entry *e1 = *(const struct dir_entry **)p1;
1138         const struct dir_entry *e2 = *(const struct dir_entry **)p2;
1139
1140         return cache_name_compare(e1->name, e1->len,
1141                                   e2->name, e2->len);
1142 }
1143
1144 static struct path_simplify *create_simplify(const char **pathspec)
1145 {
1146         int nr, alloc = 0;
1147         struct path_simplify *simplify = NULL;
1148
1149         if (!pathspec)
1150                 return NULL;
1151
1152         for (nr = 0 ; ; nr++) {
1153                 const char *match;
1154                 if (nr >= alloc) {
1155                         alloc = alloc_nr(alloc);
1156                         simplify = xrealloc(simplify, alloc * sizeof(*simplify));
1157                 }
1158                 match = *pathspec++;
1159                 if (!match)
1160                         break;
1161                 simplify[nr].path = match;
1162                 simplify[nr].len = simple_length(match);
1163         }
1164         simplify[nr].path = NULL;
1165         simplify[nr].len = 0;
1166         return simplify;
1167 }
1168
1169 static void free_simplify(struct path_simplify *simplify)
1170 {
1171         free(simplify);
1172 }
1173
1174 static int treat_leading_path(struct dir_struct *dir,
1175                               const char *path, int len,
1176                               const struct path_simplify *simplify)
1177 {
1178         struct strbuf sb = STRBUF_INIT;
1179         int baselen, rc = 0;
1180         const char *cp;
1181
1182         while (len && path[len - 1] == '/')
1183                 len--;
1184         if (!len)
1185                 return 1;
1186         baselen = 0;
1187         while (1) {
1188                 cp = path + baselen + !!baselen;
1189                 cp = memchr(cp, '/', path + len - cp);
1190                 if (!cp)
1191                         baselen = len;
1192                 else
1193                         baselen = cp - path;
1194                 strbuf_setlen(&sb, 0);
1195                 strbuf_add(&sb, path, baselen);
1196                 if (!is_directory(sb.buf))
1197                         break;
1198                 if (simplify_away(sb.buf, sb.len, simplify))
1199                         break;
1200                 if (treat_one_path(dir, &sb, simplify,
1201                                    DT_DIR, NULL) == path_ignored)
1202                         break; /* do not recurse into it */
1203                 if (len <= baselen) {
1204                         rc = 1;
1205                         break; /* finished checking */
1206                 }
1207         }
1208         strbuf_release(&sb);
1209         return rc;
1210 }
1211
1212 int read_directory(struct dir_struct *dir, const char *path, int len, const char **pathspec)
1213 {
1214         struct path_simplify *simplify;
1215
1216         if (has_symlink_leading_path(path, len))
1217                 return dir->nr;
1218
1219         simplify = create_simplify(pathspec);
1220         if (!len || treat_leading_path(dir, path, len, simplify))
1221                 read_directory_recursive(dir, path, len, 0, simplify);
1222         free_simplify(simplify);
1223         qsort(dir->entries, dir->nr, sizeof(struct dir_entry *), cmp_name);
1224         qsort(dir->ignored, dir->ignored_nr, sizeof(struct dir_entry *), cmp_name);
1225         return dir->nr;
1226 }
1227
1228 int file_exists(const char *f)
1229 {
1230         struct stat sb;
1231         return lstat(f, &sb) == 0;
1232 }
1233
1234 /*
1235  * Given two normalized paths (a trailing slash is ok), if subdir is
1236  * outside dir, return -1.  Otherwise return the offset in subdir that
1237  * can be used as relative path to dir.
1238  */
1239 int dir_inside_of(const char *subdir, const char *dir)
1240 {
1241         int offset = 0;
1242
1243         assert(dir && subdir && *dir && *subdir);
1244
1245         while (*dir && *subdir && *dir == *subdir) {
1246                 dir++;
1247                 subdir++;
1248                 offset++;
1249         }
1250
1251         /* hel[p]/me vs hel[l]/yeah */
1252         if (*dir && *subdir)
1253                 return -1;
1254
1255         if (!*subdir)
1256                 return !*dir ? offset : -1; /* same dir */
1257
1258         /* foo/[b]ar vs foo/[] */
1259         if (is_dir_sep(dir[-1]))
1260                 return is_dir_sep(subdir[-1]) ? offset : -1;
1261
1262         /* foo[/]bar vs foo[] */
1263         return is_dir_sep(*subdir) ? offset + 1 : -1;
1264 }
1265
1266 int is_inside_dir(const char *dir)
1267 {
1268         char cwd[PATH_MAX];
1269         if (!dir)
1270                 return 0;
1271         if (!getcwd(cwd, sizeof(cwd)))
1272                 die_errno("can't find the current directory");
1273         return dir_inside_of(cwd, dir) >= 0;
1274 }
1275
1276 int is_empty_dir(const char *path)
1277 {
1278         DIR *dir = opendir(path);
1279         struct dirent *e;
1280         int ret = 1;
1281
1282         if (!dir)
1283                 return 0;
1284
1285         while ((e = readdir(dir)) != NULL)
1286                 if (!is_dot_or_dotdot(e->d_name)) {
1287                         ret = 0;
1288                         break;
1289                 }
1290
1291         closedir(dir);
1292         return ret;
1293 }
1294
1295 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
1296 {
1297         DIR *dir;
1298         struct dirent *e;
1299         int ret = 0, original_len = path->len, len, kept_down = 0;
1300         int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
1301         int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
1302         unsigned char submodule_head[20];
1303
1304         if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
1305             !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
1306                 /* Do not descend and nuke a nested git work tree. */
1307                 if (kept_up)
1308                         *kept_up = 1;
1309                 return 0;
1310         }
1311
1312         flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
1313         dir = opendir(path->buf);
1314         if (!dir) {
1315                 /* an empty dir could be removed even if it is unreadble */
1316                 if (!keep_toplevel)
1317                         return rmdir(path->buf);
1318                 else
1319                         return -1;
1320         }
1321         if (path->buf[original_len - 1] != '/')
1322                 strbuf_addch(path, '/');
1323
1324         len = path->len;
1325         while ((e = readdir(dir)) != NULL) {
1326                 struct stat st;
1327                 if (is_dot_or_dotdot(e->d_name))
1328                         continue;
1329
1330                 strbuf_setlen(path, len);
1331                 strbuf_addstr(path, e->d_name);
1332                 if (lstat(path->buf, &st))
1333                         ; /* fall thru */
1334                 else if (S_ISDIR(st.st_mode)) {
1335                         if (!remove_dir_recurse(path, flag, &kept_down))
1336                                 continue; /* happy */
1337                 } else if (!only_empty && !unlink(path->buf))
1338                         continue; /* happy, too */
1339
1340                 /* path too long, stat fails, or non-directory still exists */
1341                 ret = -1;
1342                 break;
1343         }
1344         closedir(dir);
1345
1346         strbuf_setlen(path, original_len);
1347         if (!ret && !keep_toplevel && !kept_down)
1348                 ret = rmdir(path->buf);
1349         else if (kept_up)
1350                 /*
1351                  * report the uplevel that it is not an error that we
1352                  * did not rmdir() our directory.
1353                  */
1354                 *kept_up = !ret;
1355         return ret;
1356 }
1357
1358 int remove_dir_recursively(struct strbuf *path, int flag)
1359 {
1360         return remove_dir_recurse(path, flag, NULL);
1361 }
1362
1363 void setup_standard_excludes(struct dir_struct *dir)
1364 {
1365         const char *path;
1366         char *xdg_path;
1367
1368         dir->exclude_per_dir = ".gitignore";
1369         path = git_path("info/exclude");
1370         if (!excludes_file) {
1371                 home_config_paths(NULL, &xdg_path, "ignore");
1372                 excludes_file = xdg_path;
1373         }
1374         if (!access_or_warn(path, R_OK))
1375                 add_excludes_from_file(dir, path);
1376         if (excludes_file && !access_or_warn(excludes_file, R_OK))
1377                 add_excludes_from_file(dir, excludes_file);
1378 }
1379
1380 int remove_path(const char *name)
1381 {
1382         char *slash;
1383
1384         if (unlink(name) && errno != ENOENT)
1385                 return -1;
1386
1387         slash = strrchr(name, '/');
1388         if (slash) {
1389                 char *dirs = xstrdup(name);
1390                 slash = dirs + (slash - name);
1391                 do {
1392                         *slash = '\0';
1393                 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
1394                 free(dirs);
1395         }
1396         return 0;
1397 }
1398
1399 static int pathspec_item_cmp(const void *a_, const void *b_)
1400 {
1401         struct pathspec_item *a, *b;
1402
1403         a = (struct pathspec_item *)a_;
1404         b = (struct pathspec_item *)b_;
1405         return strcmp(a->match, b->match);
1406 }
1407
1408 int init_pathspec(struct pathspec *pathspec, const char **paths)
1409 {
1410         const char **p = paths;
1411         int i;
1412
1413         memset(pathspec, 0, sizeof(*pathspec));
1414         if (!p)
1415                 return 0;
1416         while (*p)
1417                 p++;
1418         pathspec->raw = paths;
1419         pathspec->nr = p - paths;
1420         if (!pathspec->nr)
1421                 return 0;
1422
1423         pathspec->items = xmalloc(sizeof(struct pathspec_item)*pathspec->nr);
1424         for (i = 0; i < pathspec->nr; i++) {
1425                 struct pathspec_item *item = pathspec->items+i;
1426                 const char *path = paths[i];
1427
1428                 item->match = path;
1429                 item->len = strlen(path);
1430                 item->use_wildcard = !no_wildcard(path);
1431                 if (item->use_wildcard)
1432                         pathspec->has_wildcard = 1;
1433         }
1434
1435         qsort(pathspec->items, pathspec->nr,
1436               sizeof(struct pathspec_item), pathspec_item_cmp);
1437
1438         return 0;
1439 }
1440
1441 void free_pathspec(struct pathspec *pathspec)
1442 {
1443         free(pathspec->items);
1444         pathspec->items = NULL;
1445 }