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