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

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