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 *repo_git_path(const struct repository *repo,
 420                     const char *fmt, ...)
 421 {
 422         struct strbuf path = STRBUF_INIT;
 423         va_list args;
 424         va_start(args, fmt);
 425         do_git_path(repo, NULL, &path, fmt, args);
 426         va_end(args);
 427         return strbuf_detach(&path, NULL);
 428 }
 429
 430 void strbuf_repo_git_path(struct strbuf *sb,
 431                           const struct repository *repo,
 432                           const char *fmt, ...)
 433 {
 434         va_list args;
 435         va_start(args, fmt);
 436         do_git_path(repo, NULL, sb, fmt, args);
 437         va_end(args);
 438 }
 439
 440 char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
 441 {
 442         va_list args;
 443         strbuf_reset(buf);
 444         va_start(args, fmt);
 445         do_git_path(the_repository, NULL, buf, fmt, args);
 446         va_end(args);
 447         return buf->buf;
 448 }
 449
 450 void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
 451 {
 452         va_list args;
 453         va_start(args, fmt);
 454         do_git_path(the_repository, NULL, sb, fmt, args);
 455         va_end(args);
 456 }
 457
 458 const char *git_path(const char *fmt, ...)
 459 {
 460         struct strbuf *pathname = get_pathname();
 461         va_list args;
 462         va_start(args, fmt);
 463         do_git_path(the_repository, NULL, pathname, fmt, args);
 464         va_end(args);
 465         return pathname->buf;
 466 }
 467
 468 char *git_pathdup(const char *fmt, ...)
 469 {
 470         struct strbuf path = STRBUF_INIT;
 471         va_list args;
 472         va_start(args, fmt);
 473         do_git_path(the_repository, NULL, &path, fmt, args);
 474         va_end(args);
 475         return strbuf_detach(&path, NULL);
 476 }
 477
 478 char *mkpathdup(const char *fmt, ...)
 479 {
 480         struct strbuf sb = STRBUF_INIT;
 481         va_list args;
 482         va_start(args, fmt);
 483         strbuf_vaddf(&sb, fmt, args);
 484         va_end(args);
 485         strbuf_cleanup_path(&sb);
 486         return strbuf_detach(&sb, NULL);
 487 }
 488
 489 const char *mkpath(const char *fmt, ...)
 490 {
 491         va_list args;
 492         struct strbuf *pathname = get_pathname();
 493         va_start(args, fmt);
 494         strbuf_vaddf(pathname, fmt, args);
 495         va_end(args);
 496         return cleanup_path(pathname->buf);
 497 }
 498
 499 const char *worktree_git_path(const struct worktree *wt, const char *fmt, ...)
 500 {
 501         struct strbuf *pathname = get_pathname();
 502         va_list args;
 503         va_start(args, fmt);
 504         do_git_path(the_repository, wt, pathname, fmt, args);
 505         va_end(args);
 506         return pathname->buf;
 507 }
 508
 509 /* Returns 0 on success, negative on failure. */
 510 static int do_submodule_path(struct strbuf *buf, const char *path,
 511                              const char *fmt, va_list args)
 512 {
 513         struct strbuf git_submodule_common_dir = STRBUF_INIT;
 514         struct strbuf git_submodule_dir = STRBUF_INIT;
 515         int ret;
 516
 517         ret = submodule_to_gitdir(&git_submodule_dir, path);
 518         if (ret)
 519                 goto cleanup;
 520
 521         strbuf_complete(&git_submodule_dir, '/');
 522         strbuf_addbuf(buf, &git_submodule_dir);
 523         strbuf_vaddf(buf, fmt, args);
 524
 525         if (get_common_dir_noenv(&git_submodule_common_dir, git_submodule_dir.buf))
 526                 update_common_dir(buf, git_submodule_dir.len, git_submodule_common_dir.buf);
 527
 528         strbuf_cleanup_path(buf);
 529
 530 cleanup:
 531         strbuf_release(&git_submodule_dir);
 532         strbuf_release(&git_submodule_common_dir);
 533         return ret;
 534 }
 535
 536 char *git_pathdup_submodule(const char *path, const char *fmt, ...)
 537 {
 538         int err;
 539         va_list args;
 540         struct strbuf buf = STRBUF_INIT;
 541         va_start(args, fmt);
 542         err = do_submodule_path(&buf, path, fmt, args);
 543         va_end(args);
 544         if (err) {
 545                 strbuf_release(&buf);
 546                 return NULL;
 547         }
 548         return strbuf_detach(&buf, NULL);
 549 }
 550
 551 int strbuf_git_path_submodule(struct strbuf *buf, const char *path,
 552                               const char *fmt, ...)
 553 {
 554         int err;
 555         va_list args;
 556         va_start(args, fmt);
 557         err = do_submodule_path(buf, path, fmt, args);
 558         va_end(args);
 559
 560         return err;
 561 }
 562
 563 static void do_git_common_path(const struct repository *repo,
 564                                struct strbuf *buf,
 565                                const char *fmt,
 566                                va_list args)
 567 {
 568         strbuf_addstr(buf, repo->commondir);
 569         if (buf->len && !is_dir_sep(buf->buf[buf->len - 1]))
 570                 strbuf_addch(buf, '/');
 571         strbuf_vaddf(buf, fmt, args);
 572         strbuf_cleanup_path(buf);
 573 }
 574
 575 const char *git_common_path(const char *fmt, ...)
 576 {
 577         struct strbuf *pathname = get_pathname();
 578         va_list args;
 579         va_start(args, fmt);
 580         do_git_common_path(the_repository, pathname, fmt, args);
 581         va_end(args);
 582         return pathname->buf;
 583 }
 584
 585 void strbuf_git_common_path(struct strbuf *sb,
 586                             const struct repository *repo,
 587                             const char *fmt, ...)
 588 {
 589         va_list args;
 590         va_start(args, fmt);
 591         do_git_common_path(repo, sb, fmt, args);
 592         va_end(args);
 593 }
 594
 595 int validate_headref(const char *path)
 596 {
 597         struct stat st;
 598         char *buf, buffer[256];
 599         unsigned char sha1[20];
 600         int fd;
 601         ssize_t len;
 602
 603         if (lstat(path, &st) < 0)
 604                 return -1;
 605
 606         /* Make sure it is a "refs/.." symlink */
 607         if (S_ISLNK(st.st_mode)) {
 608                 len = readlink(path, buffer, sizeof(buffer)-1);
 609                 if (len >= 5 && !memcmp("refs/", buffer, 5))
 610                         return 0;
 611                 return -1;
 612         }
 613
 614         /*
 615          * Anything else, just open it and try to see if it is a symbolic ref.
 616          */
 617         fd = open(path, O_RDONLY);
 618         if (fd < 0)
 619                 return -1;
 620         len = read_in_full(fd, buffer, sizeof(buffer)-1);
 621         close(fd);
 622
 623         /*
 624          * Is it a symbolic ref?
 625          */
 626         if (len < 4)
 627                 return -1;
 628         if (!memcmp("ref:", buffer, 4)) {
 629                 buf = buffer + 4;
 630                 len -= 4;
 631                 while (len && isspace(*buf))
 632                         buf++, len--;
 633                 if (len >= 5 && !memcmp("refs/", buf, 5))
 634                         return 0;
 635         }
 636
 637         /*
 638          * Is this a detached HEAD?
 639          */
 640         if (!get_sha1_hex(buffer, sha1))
 641                 return 0;
 642
 643         return -1;
 644 }
 645
 646 static struct passwd *getpw_str(const char *username, size_t len)
 647 {
 648         struct passwd *pw;
 649         char *username_z = xmemdupz(username, len);
 650         pw = getpwnam(username_z);
 651         free(username_z);
 652         return pw;
 653 }
 654
 655 /*
 656  * Return a string with ~ and ~user expanded via getpw*.  If buf != NULL,
 657  * then it is a newly allocated string. Returns NULL on getpw failure or
 658  * if path is NULL.
 659  *
 660  * If real_home is true, real_path($HOME) is used in the expansion.
 661  */
 662 char *expand_user_path(const char *path, int real_home)
 663 {
 664         struct strbuf user_path = STRBUF_INIT;
 665         const char *to_copy = path;
 666
 667         if (path == NULL)
 668                 goto return_null;
 669         if (path[0] == '~') {
 670                 const char *first_slash = strchrnul(path, '/');
 671                 const char *username = path + 1;
 672                 size_t username_len = first_slash - username;
 673                 if (username_len == 0) {
 674                         const char *home = getenv("HOME");
 675                         if (!home)
 676                                 goto return_null;
 677                         if (real_home)
 678                                 strbuf_addstr(&user_path, real_path(home));
 679                         else
 680                                 strbuf_addstr(&user_path, home);
 681 #ifdef GIT_WINDOWS_NATIVE
 682                         convert_slashes(user_path.buf);
 683 #endif
 684                 } else {
 685                         struct passwd *pw = getpw_str(username, username_len);
 686                         if (!pw)
 687                                 goto return_null;
 688                         strbuf_addstr(&user_path, pw->pw_dir);
 689                 }
 690                 to_copy = first_slash;
 691         }
 692         strbuf_addstr(&user_path, to_copy);
 693         return strbuf_detach(&user_path, NULL);
 694 return_null:
 695         strbuf_release(&user_path);
 696         return NULL;
 697 }
 698
 699 /*
 700  * First, one directory to try is determined by the following algorithm.
 701  *
 702  * (0) If "strict" is given, the path is used as given and no DWIM is
 703  *     done. Otherwise:
 704  * (1) "~/path" to mean path under the running user's home directory;
 705  * (2) "~user/path" to mean path under named user's home directory;
 706  * (3) "relative/path" to mean cwd relative directory; or
 707  * (4) "/absolute/path" to mean absolute directory.
 708  *
 709  * Unless "strict" is given, we check "%s/.git", "%s", "%s.git/.git", "%s.git"
 710  * in this order. We select the first one that is a valid git repository, and
 711  * chdir() to it. If none match, or we fail to chdir, we return NULL.
 712  *
 713  * If all goes well, we return the directory we used to chdir() (but
 714  * before ~user is expanded), avoiding getcwd() resolving symbolic
 715  * links.  User relative paths are also returned as they are given,
 716  * except DWIM suffixing.
 717  */
 718 const char *enter_repo(const char *path, int strict)
 719 {
 720         static struct strbuf validated_path = STRBUF_INIT;
 721         static struct strbuf used_path = STRBUF_INIT;
 722
 723         if (!path)
 724                 return NULL;
 725
 726         if (!strict) {
 727                 static const char *suffix[] = {
 728                         "/.git", "", ".git/.git", ".git", NULL,
 729                 };
 730                 const char *gitfile;
 731                 int len = strlen(path);
 732                 int i;
 733                 while ((1 < len) && (path[len-1] == '/'))
 734                         len--;
 735
 736                 /*
 737                  * We can handle arbitrary-sized buffers, but this remains as a
 738                  * sanity check on untrusted input.
 739                  */
 740                 if (PATH_MAX <= len)
 741                         return NULL;
 742
 743                 strbuf_reset(&used_path);
 744                 strbuf_reset(&validated_path);
 745                 strbuf_add(&used_path, path, len);
 746                 strbuf_add(&validated_path, path, len);
 747
 748                 if (used_path.buf[0] == '~') {
 749                         char *newpath = expand_user_path(used_path.buf, 0);
 750                         if (!newpath)
 751                                 return NULL;
 752                         strbuf_attach(&used_path, newpath, strlen(newpath),
 753                                       strlen(newpath));
 754                 }
 755                 for (i = 0; suffix[i]; i++) {
 756                         struct stat st;
 757                         size_t baselen = used_path.len;
 758                         strbuf_addstr(&used_path, suffix[i]);
 759                         if (!stat(used_path.buf, &st) &&
 760                             (S_ISREG(st.st_mode) ||
 761                             (S_ISDIR(st.st_mode) && is_git_directory(used_path.buf)))) {
 762                                 strbuf_addstr(&validated_path, suffix[i]);
 763                                 break;
 764                         }
 765                         strbuf_setlen(&used_path, baselen);
 766                 }
 767                 if (!suffix[i])
 768                         return NULL;
 769                 gitfile = read_gitfile(used_path.buf);
 770                 if (gitfile) {
 771                         strbuf_reset(&used_path);
 772                         strbuf_addstr(&used_path, gitfile);
 773                 }
 774                 if (chdir(used_path.buf))
 775                         return NULL;
 776                 path = validated_path.buf;
 777         }
 778         else {
 779                 const char *gitfile = read_gitfile(path);
 780                 if (gitfile)
 781                         path = gitfile;
 782                 if (chdir(path))
 783                         return NULL;
 784         }
 785
 786         if (is_git_directory(".")) {
 787                 set_git_dir(".");
 788                 check_repository_format();
 789                 return path;
 790         }
 791
 792         return NULL;
 793 }
 794
 795 static int calc_shared_perm(int mode)
 796 {
 797         int tweak;
 798
 799         if (get_shared_repository() < 0)
 800                 tweak = -get_shared_repository();
 801         else
 802                 tweak = get_shared_repository();
 803
 804         if (!(mode & S_IWUSR))
 805                 tweak &= ~0222;
 806         if (mode & S_IXUSR)
 807                 /* Copy read bits to execute bits */
 808                 tweak |= (tweak & 0444) >> 2;
 809         if (get_shared_repository() < 0)
 810                 mode = (mode & ~0777) | tweak;
 811         else
 812                 mode |= tweak;
 813
 814         return mode;
 815 }
 816
 817
 818 int adjust_shared_perm(const char *path)
 819 {
 820         int old_mode, new_mode;
 821
 822         if (!get_shared_repository())
 823                 return 0;
 824         if (get_st_mode_bits(path, &old_mode) < 0)
 825                 return -1;
 826
 827         new_mode = calc_shared_perm(old_mode);
 828         if (S_ISDIR(old_mode)) {
 829                 /* Copy read bits to execute bits */
 830                 new_mode |= (new_mode & 0444) >> 2;
 831                 new_mode |= FORCE_DIR_SET_GID;
 832         }
 833
 834         if (((old_mode ^ new_mode) & ~S_IFMT) &&
 835                         chmod(path, (new_mode & ~S_IFMT)) < 0)
 836                 return -2;
 837         return 0;
 838 }
 839
 840 void safe_create_dir(const char *dir, int share)
 841 {
 842         if (mkdir(dir, 0777) < 0) {
 843                 if (errno != EEXIST) {
 844                         perror(dir);
 845                         exit(1);
 846                 }
 847         }
 848         else if (share && adjust_shared_perm(dir))
 849                 die(_("Could not make %s writable by group"), dir);
 850 }
 851
 852 static int have_same_root(const char *path1, const char *path2)
 853 {
 854         int is_abs1, is_abs2;
 855
 856         is_abs1 = is_absolute_path(path1);
 857         is_abs2 = is_absolute_path(path2);
 858         return (is_abs1 && is_abs2 && tolower(path1[0]) == tolower(path2[0])) ||
 859                (!is_abs1 && !is_abs2);
 860 }
 861
 862 /*
 863  * Give path as relative to prefix.
 864  *
 865  * The strbuf may or may not be used, so do not assume it contains the
 866  * returned path.
 867  */
 868 const char *relative_path(const char *in, const char *prefix,
 869                           struct strbuf *sb)
 870 {
 871         int in_len = in ? strlen(in) : 0;
 872         int prefix_len = prefix ? strlen(prefix) : 0;
 873         int in_off = 0;
 874         int prefix_off = 0;
 875         int i = 0, j = 0;
 876
 877         if (!in_len)
 878                 return "./";
 879         else if (!prefix_len)
 880                 return in;
 881
 882         if (have_same_root(in, prefix))
 883                 /* bypass dos_drive, for "c:" is identical to "C:" */
 884                 i = j = has_dos_drive_prefix(in);
 885         else {
 886                 return in;
 887         }
 888
 889         while (i < prefix_len && j < in_len && prefix[i] == in[j]) {
 890                 if (is_dir_sep(prefix[i])) {
 891                         while (is_dir_sep(prefix[i]))
 892                                 i++;
 893                         while (is_dir_sep(in[j]))
 894                                 j++;
 895                         prefix_off = i;
 896                         in_off = j;
 897                 } else {
 898                         i++;
 899                         j++;
 900                 }
 901         }
 902
 903         if (
 904             /* "prefix" seems like prefix of "in" */
 905             i >= prefix_len &&
 906             /*
 907              * but "/foo" is not a prefix of "/foobar"
 908              * (i.e. prefix not end with '/')
 909              */
 910             prefix_off < prefix_len) {
 911                 if (j >= in_len) {
 912                         /* in="/a/b", prefix="/a/b" */
 913                         in_off = in_len;
 914                 } else if (is_dir_sep(in[j])) {
 915                         /* in="/a/b/c", prefix="/a/b" */
 916                         while (is_dir_sep(in[j]))
 917                                 j++;
 918                         in_off = j;
 919                 } else {
 920                         /* in="/a/bbb/c", prefix="/a/b" */
 921                         i = prefix_off;
 922                 }
 923         } else if (
 924                    /* "in" is short than "prefix" */
 925                    j >= in_len &&
 926                    /* "in" not end with '/' */
 927                    in_off < in_len) {
 928                 if (is_dir_sep(prefix[i])) {
 929                         /* in="/a/b", prefix="/a/b/c/" */
 930                         while (is_dir_sep(prefix[i]))
 931                                 i++;
 932                         in_off = in_len;
 933                 }
 934         }
 935         in += in_off;
 936         in_len -= in_off;
 937
 938         if (i >= prefix_len) {
 939                 if (!in_len)
 940                         return "./";
 941                 else
 942                         return in;
 943         }
 944
 945         strbuf_reset(sb);
 946         strbuf_grow(sb, in_len);
 947
 948         while (i < prefix_len) {
 949                 if (is_dir_sep(prefix[i])) {
 950                         strbuf_addstr(sb, "../");
 951                         while (is_dir_sep(prefix[i]))
 952                                 i++;
 953                         continue;
 954                 }
 955                 i++;
 956         }
 957         if (!is_dir_sep(prefix[prefix_len - 1]))
 958                 strbuf_addstr(sb, "../");
 959
 960         strbuf_addstr(sb, in);
 961
 962         return sb->buf;
 963 }
 964
 965 /*
 966  * A simpler implementation of relative_path
 967  *
 968  * Get relative path by removing "prefix" from "in". This function
 969  * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
 970  * to increase performance when traversing the path to work_tree.
 971  */
 972 const char *remove_leading_path(const char *in, const char *prefix)
 973 {
 974         static struct strbuf buf = STRBUF_INIT;
 975         int i = 0, j = 0;
 976
 977         if (!prefix || !prefix[0])
 978                 return in;
 979         while (prefix[i]) {
 980                 if (is_dir_sep(prefix[i])) {
 981                         if (!is_dir_sep(in[j]))
 982                                 return in;
 983                         while (is_dir_sep(prefix[i]))
 984                                 i++;
 985                         while (is_dir_sep(in[j]))
 986                                 j++;
 987                         continue;
 988                 } else if (in[j] != prefix[i]) {
 989                         return in;
 990                 }
 991                 i++;
 992                 j++;
 993         }
 994         if (
 995             /* "/foo" is a prefix of "/foo" */
 996             in[j] &&
 997             /* "/foo" is not a prefix of "/foobar" */
 998             !is_dir_sep(prefix[i-1]) && !is_dir_sep(in[j])
 999            )
1000                 return in;
1001         while (is_dir_sep(in[j]))
1002                 j++;
1003
1004         strbuf_reset(&buf);
1005         if (!in[j])
1006                 strbuf_addstr(&buf, ".");
1007         else
1008                 strbuf_addstr(&buf, in + j);
1009         return buf.buf;
1010 }
1011
1012 /*
1013  * It is okay if dst == src, but they should not overlap otherwise.
1014  *
1015  * Performs the following normalizations on src, storing the result in dst:
1016  * - Ensures that components are separated by '/' (Windows only)
1017  * - Squashes sequences of '/' except "//server/share" on Windows
1018  * - Removes "." components.
1019  * - Removes ".." components, and the components the precede them.
1020  * Returns failure (non-zero) if a ".." component appears as first path
1021  * component anytime during the normalization. Otherwise, returns success (0).
1022  *
1023  * Note that this function is purely textual.  It does not follow symlinks,
1024  * verify the existence of the path, or make any system calls.
1025  *
1026  * prefix_len != NULL is for a specific case of prefix_pathspec():
1027  * assume that src == dst and src[0..prefix_len-1] is already
1028  * normalized, any time "../" eats up to the prefix_len part,
1029  * prefix_len is reduced. In the end prefix_len is the remaining
1030  * prefix that has not been overridden by user pathspec.
1031  *
1032  * NEEDSWORK: This function doesn't perform normalization w.r.t. trailing '/'.
1033  * For everything but the root folder itself, the normalized path should not
1034  * end with a '/', then the callers need to be fixed up accordingly.
1035  *
1036  */
1037 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len)
1038 {
1039         char *dst0;
1040         const char *end;
1041
1042         /*
1043          * Copy initial part of absolute path: "/", "C:/", "//server/share/".
1044          */
1045         end = src + offset_1st_component(src);
1046         while (src < end) {
1047                 char c = *src++;
1048                 if (is_dir_sep(c))
1049                         c = '/';
1050                 *dst++ = c;
1051         }
1052         dst0 = dst;
1053
1054         while (is_dir_sep(*src))
1055                 src++;
1056
1057         for (;;) {
1058                 char c = *src;
1059
1060                 /*
1061                  * A path component that begins with . could be
1062                  * special:
1063                  * (1) "." and ends   -- ignore and terminate.
1064                  * (2) "./"           -- ignore them, eat slash and continue.
1065                  * (3) ".." and ends  -- strip one and terminate.
1066                  * (4) "../"          -- strip one, eat slash and continue.
1067                  */
1068                 if (c == '.') {
1069                         if (!src[1]) {
1070                                 /* (1) */
1071                                 src++;
1072                         } else if (is_dir_sep(src[1])) {
1073                                 /* (2) */
1074                                 src += 2;
1075                                 while (is_dir_sep(*src))
1076                                         src++;
1077                                 continue;
1078                         } else if (src[1] == '.') {
1079                                 if (!src[2]) {
1080                                         /* (3) */
1081                                         src += 2;
1082                                         goto up_one;
1083                                 } else if (is_dir_sep(src[2])) {
1084                                         /* (4) */
1085                                         src += 3;
1086                                         while (is_dir_sep(*src))
1087                                                 src++;
1088                                         goto up_one;
1089                                 }
1090                         }
1091                 }
1092
1093                 /* copy up to the next '/', and eat all '/' */
1094                 while ((c = *src++) != '\0' && !is_dir_sep(c))
1095                         *dst++ = c;
1096                 if (is_dir_sep(c)) {
1097                         *dst++ = '/';
1098                         while (is_dir_sep(c))
1099                                 c = *src++;
1100                         src--;
1101                 } else if (!c)
1102                         break;
1103                 continue;
1104
1105         up_one:
1106                 /*
1107                  * dst0..dst is prefix portion, and dst[-1] is '/';
1108                  * go up one level.
1109                  */
1110                 dst--;  /* go to trailing '/' */
1111                 if (dst <= dst0)
1112                         return -1;
1113                 /* Windows: dst[-1] cannot be backslash anymore */
1114                 while (dst0 < dst && dst[-1] != '/')
1115                         dst--;
1116                 if (prefix_len && *prefix_len > dst - dst0)
1117                         *prefix_len = dst - dst0;
1118         }
1119         *dst = '\0';
1120         return 0;
1121 }
1122
1123 int normalize_path_copy(char *dst, const char *src)
1124 {
1125         return normalize_path_copy_len(dst, src, NULL);
1126 }
1127
1128 /*
1129  * path = Canonical absolute path
1130  * prefixes = string_list containing normalized, absolute paths without
1131  * trailing slashes (except for the root directory, which is denoted by "/").
1132  *
1133  * Determines, for each path in prefixes, whether the "prefix"
1134  * is an ancestor directory of path.  Returns the length of the longest
1135  * ancestor directory, excluding any trailing slashes, or -1 if no prefix
1136  * is an ancestor.  (Note that this means 0 is returned if prefixes is
1137  * ["/"].) "/foo" is not considered an ancestor of "/foobar".  Directories
1138  * are not considered to be their own ancestors.  path must be in a
1139  * canonical form: empty components, or "." or ".." components are not
1140  * allowed.
1141  */
1142 int longest_ancestor_length(const char *path, struct string_list *prefixes)
1143 {
1144         int i, max_len = -1;
1145
1146         if (!strcmp(path, "/"))
1147                 return -1;
1148
1149         for (i = 0; i < prefixes->nr; i++) {
1150                 const char *ceil = prefixes->items[i].string;
1151                 int len = strlen(ceil);
1152
1153                 if (len == 1 && ceil[0] == '/')
1154                         len = 0; /* root matches anything, with length 0 */
1155                 else if (!strncmp(path, ceil, len) && path[len] == '/')
1156                         ; /* match of length len */
1157                 else
1158                         continue; /* no match */
1159
1160                 if (len > max_len)
1161                         max_len = len;
1162         }
1163
1164         return max_len;
1165 }
1166
1167 /* strip arbitrary amount of directory separators at end of path */
1168 static inline int chomp_trailing_dir_sep(const char *path, int len)
1169 {
1170         while (len && is_dir_sep(path[len - 1]))
1171                 len--;
1172         return len;
1173 }
1174
1175 /*
1176  * If path ends with suffix (complete path components), returns the
1177  * part before suffix (sans trailing directory separators).
1178  * Otherwise returns NULL.
1179  */
1180 char *strip_path_suffix(const char *path, const char *suffix)
1181 {
1182         int path_len = strlen(path), suffix_len = strlen(suffix);
1183
1184         while (suffix_len) {
1185                 if (!path_len)
1186                         return NULL;
1187
1188                 if (is_dir_sep(path[path_len - 1])) {
1189                         if (!is_dir_sep(suffix[suffix_len - 1]))
1190                                 return NULL;
1191                         path_len = chomp_trailing_dir_sep(path, path_len);
1192                         suffix_len = chomp_trailing_dir_sep(suffix, suffix_len);
1193                 }
1194                 else if (path[--path_len] != suffix[--suffix_len])
1195                         return NULL;
1196         }
1197
1198         if (path_len && !is_dir_sep(path[path_len - 1]))
1199                 return NULL;
1200         return xstrndup(path, chomp_trailing_dir_sep(path, path_len));
1201 }
1202
1203 int daemon_avoid_alias(const char *p)
1204 {
1205         int sl, ndot;
1206
1207         /*
1208          * This resurrects the belts and suspenders paranoia check by HPA
1209          * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
1210          * does not do getcwd() based path canonicalization.
1211          *
1212          * sl becomes true immediately after seeing '/' and continues to
1213          * be true as long as dots continue after that without intervening
1214          * non-dot character.
1215          */
1216         if (!p || (*p != '/' && *p != '~'))
1217                 return -1;
1218         sl = 1; ndot = 0;
1219         p++;
1220
1221         while (1) {
1222                 char ch = *p++;
1223                 if (sl) {
1224                         if (ch == '.')
1225                                 ndot++;
1226                         else if (ch == '/') {
1227                                 if (ndot < 3)
1228                                         /* reject //, /./ and /../ */
1229                                         return -1;
1230                                 ndot = 0;
1231                         }
1232                         else if (ch == 0) {
1233                                 if (0 < ndot && ndot < 3)
1234                                         /* reject /.$ and /..$ */
1235                                         return -1;
1236                                 return 0;
1237                         }
1238                         else
1239                                 sl = ndot = 0;
1240                 }
1241                 else if (ch == 0)
1242                         return 0;
1243                 else if (ch == '/') {
1244                         sl = 1;
1245                         ndot = 0;
1246                 }
1247         }
1248 }
1249
1250 static int only_spaces_and_periods(const char *path, size_t len, size_t skip)
1251 {
1252         if (len < skip)
1253                 return 0;
1254         len -= skip;
1255         path += skip;
1256         while (len-- > 0) {
1257                 char c = *(path++);
1258                 if (c != ' ' && c != '.')
1259                         return 0;
1260         }
1261         return 1;
1262 }
1263
1264 int is_ntfs_dotgit(const char *name)
1265 {
1266         int len;
1267
1268         for (len = 0; ; len++)
1269                 if (!name[len] || name[len] == '\\' || is_dir_sep(name[len])) {
1270                         if (only_spaces_and_periods(name, len, 4) &&
1271                                         !strncasecmp(name, ".git", 4))
1272                                 return 1;
1273                         if (only_spaces_and_periods(name, len, 5) &&
1274                                         !strncasecmp(name, "git~1", 5))
1275                                 return 1;
1276                         if (name[len] != '\\')
1277                                 return 0;
1278                         name += len + 1;
1279                         len = -1;
1280                 }
1281 }
1282
1283 char *xdg_config_home(const char *filename)
1284 {
1285         const char *home, *config_home;
1286
1287         assert(filename);
1288         config_home = getenv("XDG_CONFIG_HOME");
1289         if (config_home && *config_home)
1290                 return mkpathdup("%s/git/%s", config_home, filename);
1291
1292         home = getenv("HOME");
1293         if (home)
1294                 return mkpathdup("%s/.config/git/%s", home, filename);
1295         return NULL;
1296 }
1297
1298 char *xdg_cache_home(const char *filename)
1299 {
1300         const char *home, *cache_home;
1301
1302         assert(filename);
1303         cache_home = getenv("XDG_CACHE_HOME");
1304         if (cache_home && *cache_home)
1305                 return mkpathdup("%s/git/%s", cache_home, filename);
1306
1307         home = getenv("HOME");
1308         if (home)
1309                 return mkpathdup("%s/.cache/git/%s", home, filename);
1310         return NULL;
1311 }
1312
1313 GIT_PATH_FUNC(git_path_cherry_pick_head, "CHERRY_PICK_HEAD")
1314 GIT_PATH_FUNC(git_path_revert_head, "REVERT_HEAD")
1315 GIT_PATH_FUNC(git_path_squash_msg, "SQUASH_MSG")
1316 GIT_PATH_FUNC(git_path_merge_msg, "MERGE_MSG")
1317 GIT_PATH_FUNC(git_path_merge_rr, "MERGE_RR")
1318 GIT_PATH_FUNC(git_path_merge_mode, "MERGE_MODE")
1319 GIT_PATH_FUNC(git_path_merge_head, "MERGE_HEAD")
1320 GIT_PATH_FUNC(git_path_fetch_head, "FETCH_HEAD")
1321 GIT_PATH_FUNC(git_path_shallow, "shallow")