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