git.oblomov.eu Git - git/blob - path.c

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