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