path.c

   1 /*
   2  * Utilities for paths and pathnames
   3  */
   4 #include "cache.h"
   5 #include "strbuf.h"
   6 #include "string-list.h"
   7 #include "dir.h"
   8 #include "worktree.h"
   9 #include "submodule-config.h"
  10
  11 static int get_st_mode_bits(const char *path, int *mode)
  12 {
  13         struct stat st;
  14         if (lstat(path, &st) < 0)
  15                 return -1;
  16         *mode = st.st_mode;
  17         return 0;
  18 }
  19
  20 static char bad_path[] = "/bad-path/";
  21
  22 static struct strbuf *get_pathname(void)
  23 {
  24         static struct strbuf pathname_array[4] = {
  25                 STRBUF_INIT, STRBUF_INIT, STRBUF_INIT, STRBUF_INIT
  26         };
  27         static int index;
  28         struct strbuf *sb = &pathname_array[3 & ++index];
  29         strbuf_reset(sb);
  30         return sb;
  31 }
  32
  33 static char *cleanup_path(char *path)
  34 {
  35         /* Clean it up */
  36         if (!memcmp(path, "./", 2)) {
  37                 path += 2;
  38                 while (*path == '/')
  39                         path++;
  40         }
  41         return path;
  42 }
  43
  44 static void strbuf_cleanup_path(struct strbuf *sb)
  45 {
  46         char *path = cleanup_path(sb->buf);
  47         if (path > sb->buf)
  48                 strbuf_remove(sb, 0, path - sb->buf);
  49 }
  50
  51 char *mksnpath(char *buf, size_t n, const char *fmt, ...)
  52 {
  53         va_list args;
  54         unsigned len;
  55
  56         va_start(args, fmt);
  57         len = vsnprintf(buf, n, fmt, args);
  58         va_end(args);
  59         if (len >= n) {
  60                 strlcpy(buf, bad_path, n);
  61                 return buf;
  62         }
  63         return cleanup_path(buf);
  64 }
  65
  66 static int dir_prefix(const char *buf, const char *dir)
  67 {
  68         int len = strlen(dir);
  69         return !strncmp(buf, dir, len) &&
  70                 (is_dir_sep(buf[len]) || buf[len] == '\0');
  71 }
  72
  73 /* $buf =~ m|$dir/+$file| but without regex */
  74 static int is_dir_file(const char *buf, const char *dir, const char *file)
  75 {
  76         int len = strlen(dir);
  77         if (strncmp(buf, dir, len) || !is_dir_sep(buf[len]))
  78                 return 0;
  79         while (is_dir_sep(buf[len]))
  80                 len++;
  81         return !strcmp(buf + len, file);
  82 }
  83
  84 static void replace_dir(struct strbuf *buf, int len, const char *newdir)
  85 {
  86         int newlen = strlen(newdir);
  87         int need_sep = (buf->buf[len] && !is_dir_sep(buf->buf[len])) &&
  88                 !is_dir_sep(newdir[newlen - 1]);
  89         if (need_sep)
  90                 len--;   /* keep one char, to be replaced with '/'  */
  91         strbuf_splice(buf, 0, len, newdir, newlen);
  92         if (need_sep)
  93                 buf->buf[newlen] = '/';
  94 }
  95
  96 struct common_dir {
  97         /* Not considered garbage for report_linked_checkout_garbage */
  98         unsigned ignore_garbage:1;
  99         unsigned is_dir:1;
 100         /* Not common even though its parent is */
 101         unsigned exclude:1;
 102         const char *dirname;
 103 };
 104
 105 static struct common_dir common_list[] = {
 106         { 0, 1, 0, "branches" },
 107         { 0, 1, 0, "hooks" },
 108         { 0, 1, 0, "info" },
 109         { 0, 0, 1, "info/sparse-checkout" },
 110         { 1, 1, 0, "logs" },
 111         { 1, 1, 1, "logs/HEAD" },
 112         { 0, 1, 1, "logs/refs/bisect" },
 113         { 0, 1, 0, "lost-found" },
 114         { 0, 1, 0, "objects" },
 115         { 0, 1, 0, "refs" },
 116         { 0, 1, 1, "refs/bisect" },
 117         { 0, 1, 0, "remotes" },
 118         { 0, 1, 0, "worktrees" },
 119         { 0, 1, 0, "rr-cache" },
 120         { 0, 1, 0, "svn" },
 121         { 0, 0, 0, "config" },
 122         { 1, 0, 0, "gc.pid" },
 123         { 0, 0, 0, "packed-refs" },
 124         { 0, 0, 0, "shallow" },
 125         { 0, 0, 0, NULL }
 126 };
 127
 128 /*
 129  * A compressed trie.  A trie node consists of zero or more characters that
 130  * are common to all elements with this prefix, optionally followed by some
 131  * children.  If value is not NULL, the trie node is a terminal node.
 132  *
 133  * For example, consider the following set of strings:
 134  * abc
 135  * def
 136  * definite
 137  * definition
 138  *
 139  * The trie would look like:
 140  * root: len = 0, children a and d non-NULL, value = NULL.
 141  *    a: len = 2, contents = bc, value = (data for "abc")
 142  *    d: len = 2, contents = ef, children i non-NULL, value = (data for "def")
 143  *       i: len = 3, contents = nit, children e and i non-NULL, value = NULL
 144  *           e: len = 0, children all NULL, value = (data for "definite")
 145  *           i: len = 2, contents = on, children all NULL,
 146  *              value = (data for "definition")
 147  */
 148 struct trie {
 149         struct trie *children[256];
 150         int len;
 151         char *contents;
 152         void *value;
 153 };
 154
 155 static struct trie *make_trie_node(const char *key, void *value)
 156 {
 157         struct trie *new_node = xcalloc(1, sizeof(*new_node));
 158         new_node->len = strlen(key);
 159         if (new_node->len) {
 160                 new_node->contents = xmalloc(new_node->len);
 161                 memcpy(new_node->contents, key, new_node->len);
 162         }
 163         new_node->value = value;
 164         return new_node;
 165 }
 166
 167 /*
 168  * Add a key/value pair to a trie.  The key is assumed to be \0-terminated.
 169  * If there was an existing value for this key, return it.
 170  */
 171 static void *add_to_trie(struct trie *root, const char *key, void *value)
 172 {
 173         struct trie *child;
 174         void *old;
 175         int i;
 176
 177         if (!*key) {
 178                 /* we have reached the end of the key */
 179                 old = root->value;
 180                 root->value = value;
 181                 return old;
 182         }
 183
 184         for (i = 0; i < root->len; i++) {
 185                 if (root->contents[i] == key[i])
 186                         continue;
 187
 188                 /*
 189                  * Split this node: child will contain this node's
 190                  * existing children.
 191                  */
 192                 child = malloc(sizeof(*child));
 193                 memcpy(child->children, root->children, sizeof(root->children));
 194
 195                 child->len = root->len - i - 1;
 196                 if (child->len) {
 197                         child->contents = xstrndup(root->contents + i + 1,
 198                                                    child->len);
 199                 }
 200                 child->value = root->value;
 201                 root->value = NULL;
 202                 root->len = i;
 203
 204                 memset(root->children, 0, sizeof(root->children));
 205                 root->children[(unsigned char)root->contents[i]] = child;
 206
 207                 /* This is the newly-added child. */
 208                 root->children[(unsigned char)key[i]] =
 209                         make_trie_node(key + i + 1, value);
 210                 return NULL;
 211         }
 212
 213         /* We have matched the entire compressed section */
 214         if (key[i]) {
 215                 child = root->children[(unsigned char)key[root->len]];
 216                 if (child) {
 217                         return add_to_trie(child, key + root->len + 1, value);
 218                 } else {
 219                         child = make_trie_node(key + root->len + 1, value);
 220                         root->children[(unsigned char)key[root->len]] = child;
 221                         return NULL;
 222                 }
 223         }
 224
 225         old = root->value;
 226         root->value = value;
 227         return old;
 228 }
 229
 230 typedef int (*match_fn)(const char *unmatched, void *data, void *baton);
 231
 232 /*
 233  * Search a trie for some key.  Find the longest /-or-\0-terminated
 234  * prefix of the key for which the trie contains a value.  Call fn
 235  * with the unmatched portion of the key and the found value, and
 236  * return its return value.  If there is no such prefix, return -1.
 237  *
 238  * The key is partially normalized: consecutive slashes are skipped.
 239  *
 240  * For example, consider the trie containing only [refs,
 241  * refs/worktree] (both with values).
 242  *
 243  * | key             | unmatched  | val from node | return value |
 244  * |-----------------|------------|---------------|--------------|
 245  * | a               | not called | n/a           | -1           |
 246  * | refs            | \0         | refs          | as per fn    |
 247  * | refs/           | /          | refs          | as per fn    |
 248  * | refs/w          | /w         | refs          | as per fn    |
 249  * | refs/worktree   | \0         | refs/worktree | as per fn    |
 250  * | refs/worktree/  | /          | refs/worktree | as per fn    |
 251  * | refs/worktree/a | /a         | refs/worktree | as per fn    |
 252  * |-----------------|------------|---------------|--------------|
 253  *
 254  */
 255 static int trie_find(struct trie *root, const char *key, match_fn fn,
 256                      void *baton)
 257 {
 258         int i;
 259         int result;
 260         struct trie *child;
 261
 262         if (!*key) {
 263                 /* we have reached the end of the key */
 264                 if (root->value && !root->len)
 265                         return fn(key, root->value, baton);
 266                 else
 267                         return -1;
 268         }
 269
 270         for (i = 0; i < root->len; i++) {
 271                 /* Partial path normalization: skip consecutive slashes. */
 272                 if (key[i] == '/' && key[i+1] == '/') {
 273                         key++;
 274                         continue;
 275                 }
 276                 if (root->contents[i] != key[i])
 277                         return -1;
 278         }
 279
 280         /* Matched the entire compressed section */
 281         key += i;
 282         if (!*key)
 283                 /* End of key */
 284                 return fn(key, root->value, baton);
 285
 286         /* Partial path normalization: skip consecutive slashes */
 287         while (key[0] == '/' && key[1] == '/')
 288                 key++;
 289
 290         child = root->children[(unsigned char)*key];
 291         if (child)
 292                 result = trie_find(child, key + 1, fn, baton);
 293         else
 294                 result = -1;
 295
 296         if (result >= 0 || (*key != '/' && *key != 0))
 297                 return result;
 298         if (root->value)
 299                 return fn(key, root->value, baton);
 300         else
 301                 return -1;
 302 }
 303
 304 static struct trie common_trie;
 305 static int common_trie_done_setup;
 306
 307 static void init_common_trie(void)
 308 {
 309         struct common_dir *p;
 310
 311         if (common_trie_done_setup)
 312                 return;
 313
 314         for (p = common_list; p->dirname; p++)
 315                 add_to_trie(&common_trie, p->dirname, p);
 316
 317         common_trie_done_setup = 1;
 318 }
 319
 320 /*
 321  * Helper function for update_common_dir: returns 1 if the dir
 322  * prefix is common.
 323  */
 324 static int check_common(const char *unmatched, void *value, void *baton)
 325 {
 326         struct common_dir *dir = value;
 327
 328         if (!dir)
 329                 return 0;
 330
 331         if (dir->is_dir && (unmatched[0] == 0 || unmatched[0] == '/'))
 332                 return !dir->exclude;
 333
 334         if (!dir->is_dir && unmatched[0] == 0)
 335                 return !dir->exclude;
 336
 337         return 0;
 338 }
 339
 340 static void update_common_dir(struct strbuf *buf, int git_dir_len,
 341                               const char *common_dir)
 342 {
 343         char *base = buf->buf + git_dir_len;
 344         init_common_trie();
 345         if (!common_dir)
 346                 common_dir = get_git_common_dir();
 347         if (trie_find(&common_trie, base, check_common, NULL) > 0)
 348                 replace_dir(buf, git_dir_len, common_dir);
 349 }
 350
 351 void report_linked_checkout_garbage(void)
 352 {
 353         struct strbuf sb = STRBUF_INIT;
 354         const struct common_dir *p;
 355         int len;
 356
 357         if (!git_common_dir_env)
 358                 return;
 359         strbuf_addf(&sb, "%s/", get_git_dir());
 360         len = sb.len;
 361         for (p = common_list; p->dirname; p++) {
 362                 const char *path = p->dirname;
 363                 if (p->ignore_garbage)
 364                         continue;
 365                 strbuf_setlen(&sb, len);
 366                 strbuf_addstr(&sb, path);
 367                 if (file_exists(sb.buf))
 368                         report_garbage(PACKDIR_FILE_GARBAGE, sb.buf);
 369         }
 370         strbuf_release(&sb);
 371 }
 372
 373 static void adjust_git_path(struct strbuf *buf, int git_dir_len)
 374 {
 375         const char *base = buf->buf + git_dir_len;
 376         if (git_graft_env && is_dir_file(base, "info", "grafts"))
 377                 strbuf_splice(buf, 0, buf->len,
 378                               get_graft_file(), strlen(get_graft_file()));
 379         else if (git_index_env && !strcmp(base, "index"))
 380                 strbuf_splice(buf, 0, buf->len,
 381                               get_index_file(), strlen(get_index_file()));
 382         else if (git_db_env && dir_prefix(base, "objects"))
 383                 replace_dir(buf, git_dir_len + 7, get_object_directory());
 384         else if (git_common_dir_env)
 385                 update_common_dir(buf, git_dir_len, NULL);
 386 }
 387
 388 static void do_git_path(const struct worktree *wt, struct strbuf *buf,
 389                         const char *fmt, va_list args)
 390 {
 391         int gitdir_len;
 392         strbuf_addstr(buf, get_worktree_git_dir(wt));
 393         if (buf->len && !is_dir_sep(buf->buf[buf->len - 1]))
 394                 strbuf_addch(buf, '/');
 395         gitdir_len = buf->len;
 396         strbuf_vaddf(buf, fmt, args);
 397         adjust_git_path(buf, gitdir_len);
 398         strbuf_cleanup_path(buf);
 399 }
 400
 401 char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
 402 {
 403         va_list args;
 404         strbuf_reset(buf);
 405         va_start(args, fmt);
 406         do_git_path(NULL, buf, fmt, args);
 407         va_end(args);
 408         return buf->buf;
 409 }
 410
 411 void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
 412 {
 413         va_list args;
 414         va_start(args, fmt);
 415         do_git_path(NULL, sb, fmt, args);
 416         va_end(args);
 417 }
 418
 419 const char *git_path(const char *fmt, ...)
 420 {
 421         struct strbuf *pathname = get_pathname();
 422         va_list args;
 423         va_start(args, fmt);
 424         do_git_path(NULL, pathname, fmt, args);
 425         va_end(args);
 426         return pathname->buf;
 427 }
 428
 429 char *git_pathdup(const char *fmt, ...)
 430 {
 431         struct strbuf path = STRBUF_INIT;
 432         va_list args;
 433         va_start(args, fmt);
 434         do_git_path(NULL, &path, fmt, args);
 435         va_end(args);
 436         return strbuf_detach(&path, NULL);
 437 }
 438
 439 char *mkpathdup(const char *fmt, ...)
 440 {
 441         struct strbuf sb = STRBUF_INIT;
 442         va_list args;
 443         va_start(args, fmt);
 444         strbuf_vaddf(&sb, fmt, args);
 445         va_end(args);
 446         strbuf_cleanup_path(&sb);
 447         return strbuf_detach(&sb, NULL);
 448 }
 449
 450 const char *mkpath(const char *fmt, ...)
 451 {
 452         va_list args;
 453         struct strbuf *pathname = get_pathname();
 454         va_start(args, fmt);
 455         strbuf_vaddf(pathname, fmt, args);
 456         va_end(args);
 457         return cleanup_path(pathname->buf);
 458 }
 459
 460 const char *worktree_git_path(const struct worktree *wt, const char *fmt, ...)
 461 {
 462         struct strbuf *pathname = get_pathname();
 463         va_list args;
 464         va_start(args, fmt);
 465         do_git_path(wt, pathname, fmt, args);
 466         va_end(args);
 467         return pathname->buf;
 468 }
 469
 470 /* Returns 0 on success, negative on failure. */
 471 #define SUBMODULE_PATH_ERR_NOT_CONFIGURED -1
 472 static int do_submodule_path(struct strbuf *buf, const char *path,
 473                              const char *fmt, va_list args)
 474 {
 475         const char *git_dir;
 476         struct strbuf git_submodule_common_dir = STRBUF_INIT;
 477         struct strbuf git_submodule_dir = STRBUF_INIT;
 478         const struct submodule *sub;
 479         int err = 0;
 480
 481         strbuf_addstr(buf, path);
 482         strbuf_complete(buf, '/');
 483         strbuf_addstr(buf, ".git");
 484
 485         git_dir = read_gitfile(buf->buf);
 486         if (git_dir) {
 487                 strbuf_reset(buf);
 488                 strbuf_addstr(buf, git_dir);
 489         }
 490         if (!is_git_directory(buf->buf)) {
 491                 gitmodules_config();
 492                 sub = submodule_from_path(null_sha1, path);
 493                 if (!sub) {
 494                         err = SUBMODULE_PATH_ERR_NOT_CONFIGURED;
 495                         goto cleanup;
 496                 }
 497                 strbuf_reset(buf);
 498                 strbuf_git_path(buf, "%s/%s", "modules", sub->name);
 499         }
 500
 501         strbuf_addch(buf, '/');
 502         strbuf_addbuf(&git_submodule_dir, buf);
 503
 504         strbuf_vaddf(buf, fmt, args);
 505
 506         if (get_common_dir_noenv(&git_submodule_common_dir, git_submodule_dir.buf))
 507                 update_common_dir(buf, git_submodule_dir.len, git_submodule_common_dir.buf);
 508
 509         strbuf_cleanup_path(buf);
 510
 511 cleanup:
 512         strbuf_release(&git_submodule_dir);
 513         strbuf_release(&git_submodule_common_dir);
 514
 515         return err;
 516 }
 517
 518 char *git_pathdup_submodule(const char *path, const char *fmt, ...)
 519 {
 520         int err;
 521         va_list args;
 522         struct strbuf buf = STRBUF_INIT;
 523         va_start(args, fmt);
 524         err = do_submodule_path(&buf, path, fmt, args);
 525         va_end(args);
 526         if (err) {
 527                 strbuf_release(&buf);
 528                 return NULL;
 529         }
 530         return strbuf_detach(&buf, NULL);
 531 }
 532
 533 int strbuf_git_path_submodule(struct strbuf *buf, const char *path,
 534                               const char *fmt, ...)
 535 {
 536         int err;
 537         va_list args;
 538         va_start(args, fmt);
 539         err = do_submodule_path(buf, path, fmt, args);
 540         va_end(args);
 541
 542         return err;
 543 }
 544
 545 static void do_git_common_path(struct strbuf *buf,
 546                                const char *fmt,
 547                                va_list args)
 548 {
 549         strbuf_addstr(buf, get_git_common_dir());
 550         if (buf->len && !is_dir_sep(buf->buf[buf->len - 1]))
 551                 strbuf_addch(buf, '/');
 552         strbuf_vaddf(buf, fmt, args);
 553         strbuf_cleanup_path(buf);
 554 }
 555
 556 const char *git_common_path(const char *fmt, ...)
 557 {
 558         struct strbuf *pathname = get_pathname();
 559         va_list args;
 560         va_start(args, fmt);
 561         do_git_common_path(pathname, fmt, args);
 562         va_end(args);
 563         return pathname->buf;
 564 }
 565
 566 void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...)
 567 {
 568         va_list args;
 569         va_start(args, fmt);
 570         do_git_common_path(sb, fmt, args);
 571         va_end(args);
 572 }
 573
 574 int validate_headref(const char *path)
 575 {
 576         struct stat st;
 577         char *buf, buffer[256];
 578         unsigned char sha1[20];
 579         int fd;
 580         ssize_t len;
 581
 582         if (lstat(path, &st) < 0)
 583                 return -1;
 584
 585         /* Make sure it is a "refs/.." symlink */
 586         if (S_ISLNK(st.st_mode)) {
 587                 len = readlink(path, buffer, sizeof(buffer)-1);
 588                 if (len >= 5 && !memcmp("refs/", buffer, 5))
 589                         return 0;
 590                 return -1;
 591         }
 592
 593         /*
 594          * Anything else, just open it and try to see if it is a symbolic ref.
 595          */
 596         fd = open(path, O_RDONLY);
 597         if (fd < 0)
 598                 return -1;
 599         len = read_in_full(fd, buffer, sizeof(buffer)-1);
 600         close(fd);
 601
 602         /*
 603          * Is it a symbolic ref?
 604          */
 605         if (len < 4)
 606                 return -1;
 607         if (!memcmp("ref:", buffer, 4)) {
 608                 buf = buffer + 4;
 609                 len -= 4;
 610                 while (len && isspace(*buf))
 611                         buf++, len--;
 612                 if (len >= 5 && !memcmp("refs/", buf, 5))
 613                         return 0;
 614         }
 615
 616         /*
 617          * Is this a detached HEAD?
 618          */
 619         if (!get_sha1_hex(buffer, sha1))
 620                 return 0;
 621
 622         return -1;
 623 }
 624
 625 static struct passwd *getpw_str(const char *username, size_t len)
 626 {
 627         struct passwd *pw;
 628         char *username_z = xmemdupz(username, len);
 629         pw = getpwnam(username_z);
 630         free(username_z);
 631         return pw;
 632 }
 633
 634 /*
 635  * Return a string with ~ and ~user expanded via getpw*.  If buf != NULL,
 636  * then it is a newly allocated string. Returns NULL on getpw failure or
 637  * if path is NULL.
 638  */
 639 char *expand_user_path(const char *path)
 640 {
 641         struct strbuf user_path = STRBUF_INIT;
 642         const char *to_copy = path;
 643
 644         if (path == NULL)
 645                 goto return_null;
 646         if (path[0] == '~') {
 647                 const char *first_slash = strchrnul(path, '/');
 648                 const char *username = path + 1;
 649                 size_t username_len = first_slash - username;
 650                 if (username_len == 0) {
 651                         const char *home = getenv("HOME");
 652                         if (!home)
 653                                 goto return_null;
 654                         strbuf_addstr(&user_path, home);
 655 #ifdef GIT_WINDOWS_NATIVE
 656                         convert_slashes(user_path.buf);
 657 #endif
 658                 } else {
 659                         struct passwd *pw = getpw_str(username, username_len);
 660                         if (!pw)
 661                                 goto return_null;
 662                         strbuf_addstr(&user_path, pw->pw_dir);
 663                 }
 664                 to_copy = first_slash;
 665         }
 666         strbuf_addstr(&user_path, to_copy);
 667         return strbuf_detach(&user_path, NULL);
 668 return_null:
 669         strbuf_release(&user_path);
 670         return NULL;
 671 }
 672
 673 /*
 674  * First, one directory to try is determined by the following algorithm.
 675  *
 676  * (0) If "strict" is given, the path is used as given and no DWIM is
 677  *     done. Otherwise:
 678  * (1) "~/path" to mean path under the running user's home directory;
 679  * (2) "~user/path" to mean path under named user's home directory;
 680  * (3) "relative/path" to mean cwd relative directory; or
 681  * (4) "/absolute/path" to mean absolute directory.
 682  *
 683  * Unless "strict" is given, we check "%s/.git", "%s", "%s.git/.git", "%s.git"
 684  * in this order. We select the first one that is a valid git repository, and
 685  * chdir() to it. If none match, or we fail to chdir, we return NULL.
 686  *
 687  * If all goes well, we return the directory we used to chdir() (but
 688  * before ~user is expanded), avoiding getcwd() resolving symbolic
 689  * links.  User relative paths are also returned as they are given,
 690  * except DWIM suffixing.
 691  */
 692 const char *enter_repo(const char *path, int strict)
 693 {
 694         static struct strbuf validated_path = STRBUF_INIT;
 695         static struct strbuf used_path = STRBUF_INIT;
 696
 697         if (!path)
 698                 return NULL;
 699
 700         if (!strict) {
 701                 static const char *suffix[] = {
 702                         "/.git", "", ".git/.git", ".git", NULL,
 703                 };
 704                 const char *gitfile;
 705                 int len = strlen(path);
 706                 int i;
 707                 while ((1 < len) && (path[len-1] == '/'))
 708                         len--;
 709
 710                 /*
 711                  * We can handle arbitrary-sized buffers, but this remains as a
 712                  * sanity check on untrusted input.
 713                  */
 714                 if (PATH_MAX <= len)
 715                         return NULL;
 716
 717                 strbuf_reset(&used_path);
 718                 strbuf_reset(&validated_path);
 719                 strbuf_add(&used_path, path, len);
 720                 strbuf_add(&validated_path, path, len);
 721
 722                 if (used_path.buf[0] == '~') {
 723                         char *newpath = expand_user_path(used_path.buf);
 724                         if (!newpath)
 725                                 return NULL;
 726                         strbuf_attach(&used_path, newpath, strlen(newpath),
 727                                       strlen(newpath));
 728                 }
 729                 for (i = 0; suffix[i]; i++) {
 730                         struct stat st;
 731                         size_t baselen = used_path.len;
 732                         strbuf_addstr(&used_path, suffix[i]);
 733                         if (!stat(used_path.buf, &st) &&
 734                             (S_ISREG(st.st_mode) ||
 735                             (S_ISDIR(st.st_mode) && is_git_directory(used_path.buf)))) {
 736                                 strbuf_addstr(&validated_path, suffix[i]);
 737                                 break;
 738                         }
 739                         strbuf_setlen(&used_path, baselen);
 740                 }
 741                 if (!suffix[i])
 742                         return NULL;
 743                 gitfile = read_gitfile(used_path.buf);
 744                 if (gitfile) {
 745                         strbuf_reset(&used_path);
 746                         strbuf_addstr(&used_path, gitfile);
 747                 }
 748                 if (chdir(used_path.buf))
 749                         return NULL;
 750                 path = validated_path.buf;
 751         }
 752         else {
 753                 const char *gitfile = read_gitfile(path);
 754                 if (gitfile)
 755                         path = gitfile;
 756                 if (chdir(path))
 757                         return NULL;
 758         }
 759
 760         if (is_git_directory(".")) {
 761                 set_git_dir(".");
 762                 check_repository_format();
 763                 return path;
 764         }
 765
 766         return NULL;
 767 }
 768
 769 static int calc_shared_perm(int mode)
 770 {
 771         int tweak;
 772
 773         if (get_shared_repository() < 0)
 774                 tweak = -get_shared_repository();
 775         else
 776                 tweak = get_shared_repository();
 777
 778         if (!(mode & S_IWUSR))
 779                 tweak &= ~0222;
 780         if (mode & S_IXUSR)
 781                 /* Copy read bits to execute bits */
 782                 tweak |= (tweak & 0444) >> 2;
 783         if (get_shared_repository() < 0)
 784                 mode = (mode & ~0777) | tweak;
 785         else
 786                 mode |= tweak;
 787
 788         return mode;
 789 }
 790
 791
 792 int adjust_shared_perm(const char *path)
 793 {
 794         int old_mode, new_mode;
 795
 796         if (!get_shared_repository())
 797                 return 0;
 798         if (get_st_mode_bits(path, &old_mode) < 0)
 799                 return -1;
 800
 801         new_mode = calc_shared_perm(old_mode);
 802         if (S_ISDIR(old_mode)) {
 803                 /* Copy read bits to execute bits */
 804                 new_mode |= (new_mode & 0444) >> 2;
 805                 new_mode |= FORCE_DIR_SET_GID;
 806         }
 807
 808         if (((old_mode ^ new_mode) & ~S_IFMT) &&
 809                         chmod(path, (new_mode & ~S_IFMT)) < 0)
 810                 return -2;
 811         return 0;
 812 }
 813
 814 void safe_create_dir(const char *dir, int share)
 815 {
 816         if (mkdir(dir, 0777) < 0) {
 817                 if (errno != EEXIST) {
 818                         perror(dir);
 819                         exit(1);
 820                 }
 821         }
 822         else if (share && adjust_shared_perm(dir))
 823                 die(_("Could not make %s writable by group"), dir);
 824 }
 825
 826 static int have_same_root(const char *path1, const char *path2)
 827 {
 828         int is_abs1, is_abs2;
 829
 830         is_abs1 = is_absolute_path(path1);
 831         is_abs2 = is_absolute_path(path2);
 832         return (is_abs1 && is_abs2 && tolower(path1[0]) == tolower(path2[0])) ||
 833                (!is_abs1 && !is_abs2);
 834 }
 835
 836 /*
 837  * Give path as relative to prefix.
 838  *
 839  * The strbuf may or may not be used, so do not assume it contains the
 840  * returned path.
 841  */
 842 const char *relative_path(const char *in, const char *prefix,
 843                           struct strbuf *sb)
 844 {
 845         int in_len = in ? strlen(in) : 0;
 846         int prefix_len = prefix ? strlen(prefix) : 0;
 847         int in_off = 0;
 848         int prefix_off = 0;
 849         int i = 0, j = 0;
 850
 851         if (!in_len)
 852                 return "./";
 853         else if (!prefix_len)
 854                 return in;
 855
 856         if (have_same_root(in, prefix))
 857                 /* bypass dos_drive, for "c:" is identical to "C:" */
 858                 i = j = has_dos_drive_prefix(in);
 859         else {
 860                 return in;
 861         }
 862
 863         while (i < prefix_len && j < in_len && prefix[i] == in[j]) {
 864                 if (is_dir_sep(prefix[i])) {
 865                         while (is_dir_sep(prefix[i]))
 866                                 i++;
 867                         while (is_dir_sep(in[j]))
 868                                 j++;
 869                         prefix_off = i;
 870                         in_off = j;
 871                 } else {
 872                         i++;
 873                         j++;
 874                 }
 875         }
 876
 877         if (
 878             /* "prefix" seems like prefix of "in" */
 879             i >= prefix_len &&
 880             /*
 881              * but "/foo" is not a prefix of "/foobar"
 882              * (i.e. prefix not end with '/')
 883              */
 884             prefix_off < prefix_len) {
 885                 if (j >= in_len) {
 886                         /* in="/a/b", prefix="/a/b" */
 887                         in_off = in_len;
 888                 } else if (is_dir_sep(in[j])) {
 889                         /* in="/a/b/c", prefix="/a/b" */
 890                         while (is_dir_sep(in[j]))
 891                                 j++;
 892                         in_off = j;
 893                 } else {
 894                         /* in="/a/bbb/c", prefix="/a/b" */
 895                         i = prefix_off;
 896                 }
 897         } else if (
 898                    /* "in" is short than "prefix" */
 899                    j >= in_len &&
 900                    /* "in" not end with '/' */
 901                    in_off < in_len) {
 902                 if (is_dir_sep(prefix[i])) {
 903                         /* in="/a/b", prefix="/a/b/c/" */
 904                         while (is_dir_sep(prefix[i]))
 905                                 i++;
 906                         in_off = in_len;
 907                 }
 908         }
 909         in += in_off;
 910         in_len -= in_off;
 911
 912         if (i >= prefix_len) {
 913                 if (!in_len)
 914                         return "./";
 915                 else
 916                         return in;
 917         }
 918
 919         strbuf_reset(sb);
 920         strbuf_grow(sb, in_len);
 921
 922         while (i < prefix_len) {
 923                 if (is_dir_sep(prefix[i])) {
 924                         strbuf_addstr(sb, "../");
 925                         while (is_dir_sep(prefix[i]))
 926                                 i++;
 927                         continue;
 928                 }
 929                 i++;
 930         }
 931         if (!is_dir_sep(prefix[prefix_len - 1]))
 932                 strbuf_addstr(sb, "../");
 933
 934         strbuf_addstr(sb, in);
 935
 936         return sb->buf;
 937 }
 938
 939 /*
 940  * A simpler implementation of relative_path
 941  *
 942  * Get relative path by removing "prefix" from "in". This function
 943  * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
 944  * to increase performance when traversing the path to work_tree.
 945  */
 946 const char *remove_leading_path(const char *in, const char *prefix)
 947 {
 948         static struct strbuf buf = STRBUF_INIT;
 949         int i = 0, j = 0;
 950
 951         if (!prefix || !prefix[0])
 952                 return in;
 953         while (prefix[i]) {
 954                 if (is_dir_sep(prefix[i])) {
 955                         if (!is_dir_sep(in[j]))
 956                                 return in;
 957                         while (is_dir_sep(prefix[i]))
 958                                 i++;
 959                         while (is_dir_sep(in[j]))
 960                                 j++;
 961                         continue;
 962                 } else if (in[j] != prefix[i]) {
 963                         return in;
 964                 }
 965                 i++;
 966                 j++;
 967         }
 968         if (
 969             /* "/foo" is a prefix of "/foo" */
 970             in[j] &&
 971             /* "/foo" is not a prefix of "/foobar" */
 972             !is_dir_sep(prefix[i-1]) && !is_dir_sep(in[j])
 973            )
 974                 return in;
 975         while (is_dir_sep(in[j]))
 976                 j++;
 977
 978         strbuf_reset(&buf);
 979         if (!in[j])
 980                 strbuf_addstr(&buf, ".");
 981         else
 982                 strbuf_addstr(&buf, in + j);
 983         return buf.buf;
 984 }
 985
 986 /*
 987  * It is okay if dst == src, but they should not overlap otherwise.
 988  *
 989  * Performs the following normalizations on src, storing the result in dst:
 990  * - Ensures that components are separated by '/' (Windows only)
 991  * - Squashes sequences of '/'.
 992  * - Removes "." components.
 993  * - Removes ".." components, and the components the precede them.
 994  * Returns failure (non-zero) if a ".." component appears as first path
 995  * component anytime during the normalization. Otherwise, returns success (0).
 996  *
 997  * Note that this function is purely textual.  It does not follow symlinks,
 998  * verify the existence of the path, or make any system calls.
 999  *
1000  * prefix_len != NULL is for a specific case of prefix_pathspec():
1001  * assume that src == dst and src[0..prefix_len-1] is already
1002  * normalized, any time "../" eats up to the prefix_len part,
1003  * prefix_len is reduced. In the end prefix_len is the remaining
1004  * prefix that has not been overridden by user pathspec.
1005  *
1006  * NEEDSWORK: This function doesn't perform normalization w.r.t. trailing '/'.
1007  * For everything but the root folder itself, the normalized path should not
1008  * end with a '/', then the callers need to be fixed up accordingly.
1009  *
1010  */
1011 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len)
1012 {
1013         char *dst0;
1014         int i;
1015
1016         for (i = has_dos_drive_prefix(src); i > 0; i--)
1017                 *dst++ = *src++;
1018         dst0 = dst;
1019
1020         if (is_dir_sep(*src)) {
1021                 *dst++ = '/';
1022                 while (is_dir_sep(*src))
1023                         src++;
1024         }
1025
1026         for (;;) {
1027                 char c = *src;
1028
1029                 /*
1030                  * A path component that begins with . could be
1031                  * special:
1032                  * (1) "." and ends   -- ignore and terminate.
1033                  * (2) "./"           -- ignore them, eat slash and continue.
1034                  * (3) ".." and ends  -- strip one and terminate.
1035                  * (4) "../"          -- strip one, eat slash and continue.
1036                  */
1037                 if (c == '.') {
1038                         if (!src[1]) {
1039                                 /* (1) */
1040                                 src++;
1041                         } else if (is_dir_sep(src[1])) {
1042                                 /* (2) */
1043                                 src += 2;
1044                                 while (is_dir_sep(*src))
1045                                         src++;
1046                                 continue;
1047                         } else if (src[1] == '.') {
1048                                 if (!src[2]) {
1049                                         /* (3) */
1050                                         src += 2;
1051                                         goto up_one;
1052                                 } else if (is_dir_sep(src[2])) {
1053                                         /* (4) */
1054                                         src += 3;
1055                                         while (is_dir_sep(*src))
1056                                                 src++;
1057                                         goto up_one;
1058                                 }
1059                         }
1060                 }
1061
1062                 /* copy up to the next '/', and eat all '/' */
1063                 while ((c = *src++) != '\0' && !is_dir_sep(c))
1064                         *dst++ = c;
1065                 if (is_dir_sep(c)) {
1066                         *dst++ = '/';
1067                         while (is_dir_sep(c))
1068                                 c = *src++;
1069                         src--;
1070                 } else if (!c)
1071                         break;
1072                 continue;
1073
1074         up_one:
1075                 /*
1076                  * dst0..dst is prefix portion, and dst[-1] is '/';
1077                  * go up one level.
1078                  */
1079                 dst--;  /* go to trailing '/' */
1080                 if (dst <= dst0)
1081                         return -1;
1082                 /* Windows: dst[-1] cannot be backslash anymore */
1083                 while (dst0 < dst && dst[-1] != '/')
1084                         dst--;
1085                 if (prefix_len && *prefix_len > dst - dst0)
1086                         *prefix_len = dst - dst0;
1087         }
1088         *dst = '\0';
1089         return 0;
1090 }
1091
1092 int normalize_path_copy(char *dst, const char *src)
1093 {
1094         return normalize_path_copy_len(dst, src, NULL);
1095 }
1096
1097 /*
1098  * path = Canonical absolute path
1099  * prefixes = string_list containing normalized, absolute paths without
1100  * trailing slashes (except for the root directory, which is denoted by "/").
1101  *
1102  * Determines, for each path in prefixes, whether the "prefix"
1103  * is an ancestor directory of path.  Returns the length of the longest
1104  * ancestor directory, excluding any trailing slashes, or -1 if no prefix
1105  * is an ancestor.  (Note that this means 0 is returned if prefixes is
1106  * ["/"].) "/foo" is not considered an ancestor of "/foobar".  Directories
1107  * are not considered to be their own ancestors.  path must be in a
1108  * canonical form: empty components, or "." or ".." components are not
1109  * allowed.
1110  */
1111 int longest_ancestor_length(const char *path, struct string_list *prefixes)
1112 {
1113         int i, max_len = -1;
1114
1115         if (!strcmp(path, "/"))
1116                 return -1;
1117
1118         for (i = 0; i < prefixes->nr; i++) {
1119                 const char *ceil = prefixes->items[i].string;
1120                 int len = strlen(ceil);
1121
1122                 if (len == 1 && ceil[0] == '/')
1123                         len = 0; /* root matches anything, with length 0 */
1124                 else if (!strncmp(path, ceil, len) && path[len] == '/')
1125                         ; /* match of length len */
1126                 else
1127                         continue; /* no match */
1128
1129                 if (len > max_len)
1130                         max_len = len;
1131         }
1132
1133         return max_len;
1134 }
1135
1136 /* strip arbitrary amount of directory separators at end of path */
1137 static inline int chomp_trailing_dir_sep(const char *path, int len)
1138 {
1139         while (len && is_dir_sep(path[len - 1]))
1140                 len--;
1141         return len;
1142 }
1143
1144 /*
1145  * If path ends with suffix (complete path components), returns the
1146  * part before suffix (sans trailing directory separators).
1147  * Otherwise returns NULL.
1148  */
1149 char *strip_path_suffix(const char *path, const char *suffix)
1150 {
1151         int path_len = strlen(path), suffix_len = strlen(suffix);
1152
1153         while (suffix_len) {
1154                 if (!path_len)
1155                         return NULL;
1156
1157                 if (is_dir_sep(path[path_len - 1])) {
1158                         if (!is_dir_sep(suffix[suffix_len - 1]))
1159                                 return NULL;
1160                         path_len = chomp_trailing_dir_sep(path, path_len);
1161                         suffix_len = chomp_trailing_dir_sep(suffix, suffix_len);
1162                 }
1163                 else if (path[--path_len] != suffix[--suffix_len])
1164                         return NULL;
1165         }
1166
1167         if (path_len && !is_dir_sep(path[path_len - 1]))
1168                 return NULL;
1169         return xstrndup(path, chomp_trailing_dir_sep(path, path_len));
1170 }
1171
1172 int daemon_avoid_alias(const char *p)
1173 {
1174         int sl, ndot;
1175
1176         /*
1177          * This resurrects the belts and suspenders paranoia check by HPA
1178          * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
1179          * does not do getcwd() based path canonicalization.
1180          *
1181          * sl becomes true immediately after seeing '/' and continues to
1182          * be true as long as dots continue after that without intervening
1183          * non-dot character.
1184          */
1185         if (!p || (*p != '/' && *p != '~'))
1186                 return -1;
1187         sl = 1; ndot = 0;
1188         p++;
1189
1190         while (1) {
1191                 char ch = *p++;
1192                 if (sl) {
1193                         if (ch == '.')
1194                                 ndot++;
1195                         else if (ch == '/') {
1196                                 if (ndot < 3)
1197                                         /* reject //, /./ and /../ */
1198                                         return -1;
1199                                 ndot = 0;
1200                         }
1201                         else if (ch == 0) {
1202                                 if (0 < ndot && ndot < 3)
1203                                         /* reject /.$ and /..$ */
1204                                         return -1;
1205                                 return 0;
1206                         }
1207                         else
1208                                 sl = ndot = 0;
1209                 }
1210                 else if (ch == 0)
1211                         return 0;
1212                 else if (ch == '/') {
1213                         sl = 1;
1214                         ndot = 0;
1215                 }
1216         }
1217 }
1218
1219 static int only_spaces_and_periods(const char *path, size_t len, size_t skip)
1220 {
1221         if (len < skip)
1222                 return 0;
1223         len -= skip;
1224         path += skip;
1225         while (len-- > 0) {
1226                 char c = *(path++);
1227                 if (c != ' ' && c != '.')
1228                         return 0;
1229         }
1230         return 1;
1231 }
1232
1233 int is_ntfs_dotgit(const char *name)
1234 {
1235         int len;
1236
1237         for (len = 0; ; len++)
1238                 if (!name[len] || name[len] == '\\' || is_dir_sep(name[len])) {
1239                         if (only_spaces_and_periods(name, len, 4) &&
1240                                         !strncasecmp(name, ".git", 4))
1241                                 return 1;
1242                         if (only_spaces_and_periods(name, len, 5) &&
1243                                         !strncasecmp(name, "git~1", 5))
1244                                 return 1;
1245                         if (name[len] != '\\')
1246                                 return 0;
1247                         name += len + 1;
1248                         len = -1;
1249                 }
1250 }
1251
1252 char *xdg_config_home(const char *filename)
1253 {
1254         const char *home, *config_home;
1255
1256         assert(filename);
1257         config_home = getenv("XDG_CONFIG_HOME");
1258         if (config_home && *config_home)
1259                 return mkpathdup("%s/git/%s", config_home, filename);
1260
1261         home = getenv("HOME");
1262         if (home)
1263                 return mkpathdup("%s/.config/git/%s", home, filename);
1264         return NULL;
1265 }
1266
1267 GIT_PATH_FUNC(git_path_cherry_pick_head, "CHERRY_PICK_HEAD")
1268 GIT_PATH_FUNC(git_path_revert_head, "REVERT_HEAD")
1269 GIT_PATH_FUNC(git_path_squash_msg, "SQUASH_MSG")
1270 GIT_PATH_FUNC(git_path_merge_msg, "MERGE_MSG")
1271 GIT_PATH_FUNC(git_path_merge_rr, "MERGE_RR")
1272 GIT_PATH_FUNC(git_path_merge_mode, "MERGE_MODE")
1273 GIT_PATH_FUNC(git_path_merge_head, "MERGE_HEAD")
1274 GIT_PATH_FUNC(git_path_fetch_head, "FETCH_HEAD")
1275 GIT_PATH_FUNC(git_path_shallow, "shallow")