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