2 * Utilities for paths and pathnames
5 #include "repository.h"
7 #include "string-list.h"
10 #include "submodule-config.h"
13 static int get_st_mode_bits(const char *path, int *mode)
16 if (lstat(path, &st) < 0)
22 static char bad_path[] = "/bad-path/";
24 static struct strbuf *get_pathname(void)
26 static struct strbuf pathname_array[4] = {
27 STRBUF_INIT, STRBUF_INIT, STRBUF_INIT, STRBUF_INIT
30 struct strbuf *sb = &pathname_array[index];
31 index = (index + 1) % ARRAY_SIZE(pathname_array);
36 static const char *cleanup_path(const char *path)
39 if (skip_prefix(path, "./", &path)) {
46 static void strbuf_cleanup_path(struct strbuf *sb)
48 const char *path = cleanup_path(sb->buf);
50 strbuf_remove(sb, 0, path - sb->buf);
53 char *mksnpath(char *buf, size_t n, const char *fmt, ...)
59 len = vsnprintf(buf, n, fmt, args);
62 strlcpy(buf, bad_path, n);
65 return (char *)cleanup_path(buf);
68 static int dir_prefix(const char *buf, const char *dir)
70 int len = strlen(dir);
71 return !strncmp(buf, dir, len) &&
72 (is_dir_sep(buf[len]) || buf[len] == '\0');
75 /* $buf =~ m|$dir/+$file| but without regex */
76 static int is_dir_file(const char *buf, const char *dir, const char *file)
78 int len = strlen(dir);
79 if (strncmp(buf, dir, len) || !is_dir_sep(buf[len]))
81 while (is_dir_sep(buf[len]))
83 return !strcmp(buf + len, file);
86 static void replace_dir(struct strbuf *buf, int len, const char *newdir)
88 int newlen = strlen(newdir);
89 int need_sep = (buf->buf[len] && !is_dir_sep(buf->buf[len])) &&
90 !is_dir_sep(newdir[newlen - 1]);
92 len--; /* keep one char, to be replaced with '/' */
93 strbuf_splice(buf, 0, len, newdir, newlen);
95 buf->buf[newlen] = '/';
99 /* Not considered garbage for report_linked_checkout_garbage */
100 unsigned ignore_garbage:1;
102 /* Not common even though its parent is */
107 static struct common_dir common_list[] = {
108 { 0, 1, 0, "branches" },
109 { 0, 1, 0, "hooks" },
111 { 0, 0, 1, "info/sparse-checkout" },
113 { 1, 1, 1, "logs/HEAD" },
114 { 0, 1, 1, "logs/refs/bisect" },
115 { 0, 1, 0, "lost-found" },
116 { 0, 1, 0, "objects" },
118 { 0, 1, 1, "refs/bisect" },
119 { 0, 1, 0, "remotes" },
120 { 0, 1, 0, "worktrees" },
121 { 0, 1, 0, "rr-cache" },
123 { 0, 0, 0, "config" },
124 { 1, 0, 0, "gc.pid" },
125 { 0, 0, 0, "packed-refs" },
126 { 0, 0, 0, "shallow" },
131 * A compressed trie. A trie node consists of zero or more characters that
132 * are common to all elements with this prefix, optionally followed by some
133 * children. If value is not NULL, the trie node is a terminal node.
135 * For example, consider the following set of strings:
141 * The trie would look like:
142 * root: len = 0, children a and d non-NULL, value = NULL.
143 * a: len = 2, contents = bc, value = (data for "abc")
144 * d: len = 2, contents = ef, children i non-NULL, value = (data for "def")
145 * i: len = 3, contents = nit, children e and i non-NULL, value = NULL
146 * e: len = 0, children all NULL, value = (data for "definite")
147 * i: len = 2, contents = on, children all NULL,
148 * value = (data for "definition")
151 struct trie *children[256];
157 static struct trie *make_trie_node(const char *key, void *value)
159 struct trie *new_node = xcalloc(1, sizeof(*new_node));
160 new_node->len = strlen(key);
162 new_node->contents = xmalloc(new_node->len);
163 memcpy(new_node->contents, key, new_node->len);
165 new_node->value = value;
170 * Add a key/value pair to a trie. The key is assumed to be \0-terminated.
171 * If there was an existing value for this key, return it.
173 static void *add_to_trie(struct trie *root, const char *key, void *value)
180 /* we have reached the end of the key */
186 for (i = 0; i < root->len; i++) {
187 if (root->contents[i] == key[i])
191 * Split this node: child will contain this node's
194 child = malloc(sizeof(*child));
195 memcpy(child->children, root->children, sizeof(root->children));
197 child->len = root->len - i - 1;
199 child->contents = xstrndup(root->contents + i + 1,
202 child->value = root->value;
206 memset(root->children, 0, sizeof(root->children));
207 root->children[(unsigned char)root->contents[i]] = child;
209 /* This is the newly-added child. */
210 root->children[(unsigned char)key[i]] =
211 make_trie_node(key + i + 1, value);
215 /* We have matched the entire compressed section */
217 child = root->children[(unsigned char)key[root->len]];
219 return add_to_trie(child, key + root->len + 1, value);
221 child = make_trie_node(key + root->len + 1, value);
222 root->children[(unsigned char)key[root->len]] = child;
232 typedef int (*match_fn)(const char *unmatched, void *data, void *baton);
235 * Search a trie for some key. Find the longest /-or-\0-terminated
236 * prefix of the key for which the trie contains a value. Call fn
237 * with the unmatched portion of the key and the found value, and
238 * return its return value. If there is no such prefix, return -1.
240 * The key is partially normalized: consecutive slashes are skipped.
242 * For example, consider the trie containing only [refs,
243 * refs/worktree] (both with values).
245 * | key | unmatched | val from node | return value |
246 * |-----------------|------------|---------------|--------------|
247 * | a | not called | n/a | -1 |
248 * | refs | \0 | refs | as per fn |
249 * | refs/ | / | refs | as per fn |
250 * | refs/w | /w | refs | as per fn |
251 * | refs/worktree | \0 | refs/worktree | as per fn |
252 * | refs/worktree/ | / | refs/worktree | as per fn |
253 * | refs/worktree/a | /a | refs/worktree | as per fn |
254 * |-----------------|------------|---------------|--------------|
257 static int trie_find(struct trie *root, const char *key, match_fn fn,
265 /* we have reached the end of the key */
266 if (root->value && !root->len)
267 return fn(key, root->value, baton);
272 for (i = 0; i < root->len; i++) {
273 /* Partial path normalization: skip consecutive slashes. */
274 if (key[i] == '/' && key[i+1] == '/') {
278 if (root->contents[i] != key[i])
282 /* Matched the entire compressed section */
286 return fn(key, root->value, baton);
288 /* Partial path normalization: skip consecutive slashes */
289 while (key[0] == '/' && key[1] == '/')
292 child = root->children[(unsigned char)*key];
294 result = trie_find(child, key + 1, fn, baton);
298 if (result >= 0 || (*key != '/' && *key != 0))
301 return fn(key, root->value, baton);
306 static struct trie common_trie;
307 static int common_trie_done_setup;
309 static void init_common_trie(void)
311 struct common_dir *p;
313 if (common_trie_done_setup)
316 for (p = common_list; p->dirname; p++)
317 add_to_trie(&common_trie, p->dirname, p);
319 common_trie_done_setup = 1;
323 * Helper function for update_common_dir: returns 1 if the dir
326 static int check_common(const char *unmatched, void *value, void *baton)
328 struct common_dir *dir = value;
333 if (dir->is_dir && (unmatched[0] == 0 || unmatched[0] == '/'))
334 return !dir->exclude;
336 if (!dir->is_dir && unmatched[0] == 0)
337 return !dir->exclude;
342 static void update_common_dir(struct strbuf *buf, int git_dir_len,
343 const char *common_dir)
345 char *base = buf->buf + git_dir_len;
347 if (trie_find(&common_trie, base, check_common, NULL) > 0)
348 replace_dir(buf, git_dir_len, common_dir);
351 void report_linked_checkout_garbage(void)
353 struct strbuf sb = STRBUF_INIT;
354 const struct common_dir *p;
357 if (!the_repository->different_commondir)
359 strbuf_addf(&sb, "%s/", get_git_dir());
361 for (p = common_list; p->dirname; p++) {
362 const char *path = p->dirname;
363 if (p->ignore_garbage)
365 strbuf_setlen(&sb, len);
366 strbuf_addstr(&sb, path);
367 if (file_exists(sb.buf))
368 report_garbage(PACKDIR_FILE_GARBAGE, sb.buf);
373 static void adjust_git_path(const struct repository *repo,
374 struct strbuf *buf, int git_dir_len)
376 const char *base = buf->buf + git_dir_len;
377 if (is_dir_file(base, "info", "grafts"))
378 strbuf_splice(buf, 0, buf->len,
379 repo->graft_file, strlen(repo->graft_file));
380 else if (!strcmp(base, "index"))
381 strbuf_splice(buf, 0, buf->len,
382 repo->index_file, strlen(repo->index_file));
383 else if (dir_prefix(base, "objects"))
384 replace_dir(buf, git_dir_len + 7, repo->objectdir);
385 else if (git_hooks_path && dir_prefix(base, "hooks"))
386 replace_dir(buf, git_dir_len + 5, git_hooks_path);
387 else if (repo->different_commondir)
388 update_common_dir(buf, git_dir_len, repo->commondir);
391 static void strbuf_worktree_gitdir(struct strbuf *buf,
392 const struct repository *repo,
393 const struct worktree *wt)
396 strbuf_addstr(buf, repo->gitdir);
398 strbuf_addstr(buf, repo->commondir);
400 strbuf_git_common_path(buf, repo, "worktrees/%s", wt->id);
403 static void do_git_path(const struct repository *repo,
404 const struct worktree *wt, struct strbuf *buf,
405 const char *fmt, va_list args)
408 strbuf_worktree_gitdir(buf, repo, wt);
409 if (buf->len && !is_dir_sep(buf->buf[buf->len - 1]))
410 strbuf_addch(buf, '/');
411 gitdir_len = buf->len;
412 strbuf_vaddf(buf, fmt, args);
414 adjust_git_path(repo, buf, gitdir_len);
415 strbuf_cleanup_path(buf);
418 char *repo_git_path(const struct repository *repo,
419 const char *fmt, ...)
421 struct strbuf path = STRBUF_INIT;
424 do_git_path(repo, NULL, &path, fmt, args);
426 return strbuf_detach(&path, NULL);
429 void strbuf_repo_git_path(struct strbuf *sb,
430 const struct repository *repo,
431 const char *fmt, ...)
435 do_git_path(repo, NULL, sb, fmt, args);
439 char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
444 do_git_path(the_repository, NULL, buf, fmt, args);
449 void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
453 do_git_path(the_repository, NULL, sb, fmt, args);
457 const char *git_path(const char *fmt, ...)
459 struct strbuf *pathname = get_pathname();
462 do_git_path(the_repository, NULL, pathname, fmt, args);
464 return pathname->buf;
467 char *git_pathdup(const char *fmt, ...)
469 struct strbuf path = STRBUF_INIT;
472 do_git_path(the_repository, NULL, &path, fmt, args);
474 return strbuf_detach(&path, NULL);
477 char *mkpathdup(const char *fmt, ...)
479 struct strbuf sb = STRBUF_INIT;
482 strbuf_vaddf(&sb, fmt, args);
484 strbuf_cleanup_path(&sb);
485 return strbuf_detach(&sb, NULL);
488 const char *mkpath(const char *fmt, ...)
491 struct strbuf *pathname = get_pathname();
493 strbuf_vaddf(pathname, fmt, args);
495 return cleanup_path(pathname->buf);
498 const char *worktree_git_path(const struct worktree *wt, const char *fmt, ...)
500 struct strbuf *pathname = get_pathname();
503 do_git_path(the_repository, wt, pathname, fmt, args);
505 return pathname->buf;
508 static void do_worktree_path(const struct repository *repo,
510 const char *fmt, va_list args)
512 strbuf_addstr(buf, repo->worktree);
513 if(buf->len && !is_dir_sep(buf->buf[buf->len - 1]))
514 strbuf_addch(buf, '/');
516 strbuf_vaddf(buf, fmt, args);
517 strbuf_cleanup_path(buf);
520 char *repo_worktree_path(const struct repository *repo, const char *fmt, ...)
522 struct strbuf path = STRBUF_INIT;
529 do_worktree_path(repo, &path, fmt, args);
532 return strbuf_detach(&path, NULL);
535 void strbuf_repo_worktree_path(struct strbuf *sb,
536 const struct repository *repo,
537 const char *fmt, ...)
545 do_worktree_path(repo, sb, fmt, args);
549 /* Returns 0 on success, negative on failure. */
550 static int do_submodule_path(struct strbuf *buf, const char *path,
551 const char *fmt, va_list args)
553 struct strbuf git_submodule_common_dir = STRBUF_INIT;
554 struct strbuf git_submodule_dir = STRBUF_INIT;
557 ret = submodule_to_gitdir(&git_submodule_dir, path);
561 strbuf_complete(&git_submodule_dir, '/');
562 strbuf_addbuf(buf, &git_submodule_dir);
563 strbuf_vaddf(buf, fmt, args);
565 if (get_common_dir_noenv(&git_submodule_common_dir, git_submodule_dir.buf))
566 update_common_dir(buf, git_submodule_dir.len, git_submodule_common_dir.buf);
568 strbuf_cleanup_path(buf);
571 strbuf_release(&git_submodule_dir);
572 strbuf_release(&git_submodule_common_dir);
576 char *git_pathdup_submodule(const char *path, const char *fmt, ...)
580 struct strbuf buf = STRBUF_INIT;
582 err = do_submodule_path(&buf, path, fmt, args);
585 strbuf_release(&buf);
588 return strbuf_detach(&buf, NULL);
591 int strbuf_git_path_submodule(struct strbuf *buf, const char *path,
592 const char *fmt, ...)
597 err = do_submodule_path(buf, path, fmt, args);
603 static void do_git_common_path(const struct repository *repo,
608 strbuf_addstr(buf, repo->commondir);
609 if (buf->len && !is_dir_sep(buf->buf[buf->len - 1]))
610 strbuf_addch(buf, '/');
611 strbuf_vaddf(buf, fmt, args);
612 strbuf_cleanup_path(buf);
615 const char *git_common_path(const char *fmt, ...)
617 struct strbuf *pathname = get_pathname();
620 do_git_common_path(the_repository, pathname, fmt, args);
622 return pathname->buf;
625 void strbuf_git_common_path(struct strbuf *sb,
626 const struct repository *repo,
627 const char *fmt, ...)
631 do_git_common_path(repo, sb, fmt, args);
635 int validate_headref(const char *path)
640 struct object_id oid;
644 if (lstat(path, &st) < 0)
647 /* Make sure it is a "refs/.." symlink */
648 if (S_ISLNK(st.st_mode)) {
649 len = readlink(path, buffer, sizeof(buffer)-1);
650 if (len >= 5 && !memcmp("refs/", buffer, 5))
656 * Anything else, just open it and try to see if it is a symbolic ref.
658 fd = open(path, O_RDONLY);
661 len = read_in_full(fd, buffer, sizeof(buffer)-1);
669 * Is it a symbolic ref?
671 if (skip_prefix(buffer, "ref:", &refname)) {
672 while (isspace(*refname))
674 if (starts_with(refname, "refs/"))
679 * Is this a detached HEAD?
681 if (!get_oid_hex(buffer, &oid))
687 static struct passwd *getpw_str(const char *username, size_t len)
690 char *username_z = xmemdupz(username, len);
691 pw = getpwnam(username_z);
697 * Return a string with ~ and ~user expanded via getpw*. If buf != NULL,
698 * then it is a newly allocated string. Returns NULL on getpw failure or
701 * If real_home is true, real_path($HOME) is used in the expansion.
703 char *expand_user_path(const char *path, int real_home)
705 struct strbuf user_path = STRBUF_INIT;
706 const char *to_copy = path;
710 if (path[0] == '~') {
711 const char *first_slash = strchrnul(path, '/');
712 const char *username = path + 1;
713 size_t username_len = first_slash - username;
714 if (username_len == 0) {
715 const char *home = getenv("HOME");
719 strbuf_addstr(&user_path, real_path(home));
721 strbuf_addstr(&user_path, home);
722 #ifdef GIT_WINDOWS_NATIVE
723 convert_slashes(user_path.buf);
726 struct passwd *pw = getpw_str(username, username_len);
729 strbuf_addstr(&user_path, pw->pw_dir);
731 to_copy = first_slash;
733 strbuf_addstr(&user_path, to_copy);
734 return strbuf_detach(&user_path, NULL);
736 strbuf_release(&user_path);
741 * First, one directory to try is determined by the following algorithm.
743 * (0) If "strict" is given, the path is used as given and no DWIM is
745 * (1) "~/path" to mean path under the running user's home directory;
746 * (2) "~user/path" to mean path under named user's home directory;
747 * (3) "relative/path" to mean cwd relative directory; or
748 * (4) "/absolute/path" to mean absolute directory.
750 * Unless "strict" is given, we check "%s/.git", "%s", "%s.git/.git", "%s.git"
751 * in this order. We select the first one that is a valid git repository, and
752 * chdir() to it. If none match, or we fail to chdir, we return NULL.
754 * If all goes well, we return the directory we used to chdir() (but
755 * before ~user is expanded), avoiding getcwd() resolving symbolic
756 * links. User relative paths are also returned as they are given,
757 * except DWIM suffixing.
759 const char *enter_repo(const char *path, int strict)
761 static struct strbuf validated_path = STRBUF_INIT;
762 static struct strbuf used_path = STRBUF_INIT;
768 static const char *suffix[] = {
769 "/.git", "", ".git/.git", ".git", NULL,
772 int len = strlen(path);
774 while ((1 < len) && (path[len-1] == '/'))
778 * We can handle arbitrary-sized buffers, but this remains as a
779 * sanity check on untrusted input.
784 strbuf_reset(&used_path);
785 strbuf_reset(&validated_path);
786 strbuf_add(&used_path, path, len);
787 strbuf_add(&validated_path, path, len);
789 if (used_path.buf[0] == '~') {
790 char *newpath = expand_user_path(used_path.buf, 0);
793 strbuf_attach(&used_path, newpath, strlen(newpath),
796 for (i = 0; suffix[i]; i++) {
798 size_t baselen = used_path.len;
799 strbuf_addstr(&used_path, suffix[i]);
800 if (!stat(used_path.buf, &st) &&
801 (S_ISREG(st.st_mode) ||
802 (S_ISDIR(st.st_mode) && is_git_directory(used_path.buf)))) {
803 strbuf_addstr(&validated_path, suffix[i]);
806 strbuf_setlen(&used_path, baselen);
810 gitfile = read_gitfile(used_path.buf);
812 strbuf_reset(&used_path);
813 strbuf_addstr(&used_path, gitfile);
815 if (chdir(used_path.buf))
817 path = validated_path.buf;
820 const char *gitfile = read_gitfile(path);
827 if (is_git_directory(".")) {
829 check_repository_format();
836 static int calc_shared_perm(int mode)
840 if (get_shared_repository() < 0)
841 tweak = -get_shared_repository();
843 tweak = get_shared_repository();
845 if (!(mode & S_IWUSR))
848 /* Copy read bits to execute bits */
849 tweak |= (tweak & 0444) >> 2;
850 if (get_shared_repository() < 0)
851 mode = (mode & ~0777) | tweak;
859 int adjust_shared_perm(const char *path)
861 int old_mode, new_mode;
863 if (!get_shared_repository())
865 if (get_st_mode_bits(path, &old_mode) < 0)
868 new_mode = calc_shared_perm(old_mode);
869 if (S_ISDIR(old_mode)) {
870 /* Copy read bits to execute bits */
871 new_mode |= (new_mode & 0444) >> 2;
872 new_mode |= FORCE_DIR_SET_GID;
875 if (((old_mode ^ new_mode) & ~S_IFMT) &&
876 chmod(path, (new_mode & ~S_IFMT)) < 0)
881 void safe_create_dir(const char *dir, int share)
883 if (mkdir(dir, 0777) < 0) {
884 if (errno != EEXIST) {
889 else if (share && adjust_shared_perm(dir))
890 die(_("Could not make %s writable by group"), dir);
893 static int have_same_root(const char *path1, const char *path2)
895 int is_abs1, is_abs2;
897 is_abs1 = is_absolute_path(path1);
898 is_abs2 = is_absolute_path(path2);
899 return (is_abs1 && is_abs2 && tolower(path1[0]) == tolower(path2[0])) ||
900 (!is_abs1 && !is_abs2);
904 * Give path as relative to prefix.
906 * The strbuf may or may not be used, so do not assume it contains the
909 const char *relative_path(const char *in, const char *prefix,
912 int in_len = in ? strlen(in) : 0;
913 int prefix_len = prefix ? strlen(prefix) : 0;
920 else if (!prefix_len)
923 if (have_same_root(in, prefix))
924 /* bypass dos_drive, for "c:" is identical to "C:" */
925 i = j = has_dos_drive_prefix(in);
930 while (i < prefix_len && j < in_len && prefix[i] == in[j]) {
931 if (is_dir_sep(prefix[i])) {
932 while (is_dir_sep(prefix[i]))
934 while (is_dir_sep(in[j]))
945 /* "prefix" seems like prefix of "in" */
948 * but "/foo" is not a prefix of "/foobar"
949 * (i.e. prefix not end with '/')
951 prefix_off < prefix_len) {
953 /* in="/a/b", prefix="/a/b" */
955 } else if (is_dir_sep(in[j])) {
956 /* in="/a/b/c", prefix="/a/b" */
957 while (is_dir_sep(in[j]))
961 /* in="/a/bbb/c", prefix="/a/b" */
965 /* "in" is short than "prefix" */
967 /* "in" not end with '/' */
969 if (is_dir_sep(prefix[i])) {
970 /* in="/a/b", prefix="/a/b/c/" */
971 while (is_dir_sep(prefix[i]))
979 if (i >= prefix_len) {
987 strbuf_grow(sb, in_len);
989 while (i < prefix_len) {
990 if (is_dir_sep(prefix[i])) {
991 strbuf_addstr(sb, "../");
992 while (is_dir_sep(prefix[i]))
998 if (!is_dir_sep(prefix[prefix_len - 1]))
999 strbuf_addstr(sb, "../");
1001 strbuf_addstr(sb, in);
1007 * A simpler implementation of relative_path
1009 * Get relative path by removing "prefix" from "in". This function
1010 * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
1011 * to increase performance when traversing the path to work_tree.
1013 const char *remove_leading_path(const char *in, const char *prefix)
1015 static struct strbuf buf = STRBUF_INIT;
1018 if (!prefix || !prefix[0])
1021 if (is_dir_sep(prefix[i])) {
1022 if (!is_dir_sep(in[j]))
1024 while (is_dir_sep(prefix[i]))
1026 while (is_dir_sep(in[j]))
1029 } else if (in[j] != prefix[i]) {
1036 /* "/foo" is a prefix of "/foo" */
1038 /* "/foo" is not a prefix of "/foobar" */
1039 !is_dir_sep(prefix[i-1]) && !is_dir_sep(in[j])
1042 while (is_dir_sep(in[j]))
1047 strbuf_addstr(&buf, ".");
1049 strbuf_addstr(&buf, in + j);
1054 * It is okay if dst == src, but they should not overlap otherwise.
1056 * Performs the following normalizations on src, storing the result in dst:
1057 * - Ensures that components are separated by '/' (Windows only)
1058 * - Squashes sequences of '/' except "//server/share" on Windows
1059 * - Removes "." components.
1060 * - Removes ".." components, and the components the precede them.
1061 * Returns failure (non-zero) if a ".." component appears as first path
1062 * component anytime during the normalization. Otherwise, returns success (0).
1064 * Note that this function is purely textual. It does not follow symlinks,
1065 * verify the existence of the path, or make any system calls.
1067 * prefix_len != NULL is for a specific case of prefix_pathspec():
1068 * assume that src == dst and src[0..prefix_len-1] is already
1069 * normalized, any time "../" eats up to the prefix_len part,
1070 * prefix_len is reduced. In the end prefix_len is the remaining
1071 * prefix that has not been overridden by user pathspec.
1073 * NEEDSWORK: This function doesn't perform normalization w.r.t. trailing '/'.
1074 * For everything but the root folder itself, the normalized path should not
1075 * end with a '/', then the callers need to be fixed up accordingly.
1078 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len)
1084 * Copy initial part of absolute path: "/", "C:/", "//server/share/".
1086 end = src + offset_1st_component(src);
1095 while (is_dir_sep(*src))
1102 * A path component that begins with . could be
1104 * (1) "." and ends -- ignore and terminate.
1105 * (2) "./" -- ignore them, eat slash and continue.
1106 * (3) ".." and ends -- strip one and terminate.
1107 * (4) "../" -- strip one, eat slash and continue.
1113 } else if (is_dir_sep(src[1])) {
1116 while (is_dir_sep(*src))
1119 } else if (src[1] == '.') {
1124 } else if (is_dir_sep(src[2])) {
1127 while (is_dir_sep(*src))
1134 /* copy up to the next '/', and eat all '/' */
1135 while ((c = *src++) != '\0' && !is_dir_sep(c))
1137 if (is_dir_sep(c)) {
1139 while (is_dir_sep(c))
1148 * dst0..dst is prefix portion, and dst[-1] is '/';
1151 dst--; /* go to trailing '/' */
1154 /* Windows: dst[-1] cannot be backslash anymore */
1155 while (dst0 < dst && dst[-1] != '/')
1157 if (prefix_len && *prefix_len > dst - dst0)
1158 *prefix_len = dst - dst0;
1164 int normalize_path_copy(char *dst, const char *src)
1166 return normalize_path_copy_len(dst, src, NULL);
1170 * path = Canonical absolute path
1171 * prefixes = string_list containing normalized, absolute paths without
1172 * trailing slashes (except for the root directory, which is denoted by "/").
1174 * Determines, for each path in prefixes, whether the "prefix"
1175 * is an ancestor directory of path. Returns the length of the longest
1176 * ancestor directory, excluding any trailing slashes, or -1 if no prefix
1177 * is an ancestor. (Note that this means 0 is returned if prefixes is
1178 * ["/"].) "/foo" is not considered an ancestor of "/foobar". Directories
1179 * are not considered to be their own ancestors. path must be in a
1180 * canonical form: empty components, or "." or ".." components are not
1183 int longest_ancestor_length(const char *path, struct string_list *prefixes)
1185 int i, max_len = -1;
1187 if (!strcmp(path, "/"))
1190 for (i = 0; i < prefixes->nr; i++) {
1191 const char *ceil = prefixes->items[i].string;
1192 int len = strlen(ceil);
1194 if (len == 1 && ceil[0] == '/')
1195 len = 0; /* root matches anything, with length 0 */
1196 else if (!strncmp(path, ceil, len) && path[len] == '/')
1197 ; /* match of length len */
1199 continue; /* no match */
1208 /* strip arbitrary amount of directory separators at end of path */
1209 static inline int chomp_trailing_dir_sep(const char *path, int len)
1211 while (len && is_dir_sep(path[len - 1]))
1217 * If path ends with suffix (complete path components), returns the
1218 * part before suffix (sans trailing directory separators).
1219 * Otherwise returns NULL.
1221 char *strip_path_suffix(const char *path, const char *suffix)
1223 int path_len = strlen(path), suffix_len = strlen(suffix);
1225 while (suffix_len) {
1229 if (is_dir_sep(path[path_len - 1])) {
1230 if (!is_dir_sep(suffix[suffix_len - 1]))
1232 path_len = chomp_trailing_dir_sep(path, path_len);
1233 suffix_len = chomp_trailing_dir_sep(suffix, suffix_len);
1235 else if (path[--path_len] != suffix[--suffix_len])
1239 if (path_len && !is_dir_sep(path[path_len - 1]))
1241 return xstrndup(path, chomp_trailing_dir_sep(path, path_len));
1244 int daemon_avoid_alias(const char *p)
1249 * This resurrects the belts and suspenders paranoia check by HPA
1250 * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
1251 * does not do getcwd() based path canonicalization.
1253 * sl becomes true immediately after seeing '/' and continues to
1254 * be true as long as dots continue after that without intervening
1255 * non-dot character.
1257 if (!p || (*p != '/' && *p != '~'))
1267 else if (ch == '/') {
1269 /* reject //, /./ and /../ */
1274 if (0 < ndot && ndot < 3)
1275 /* reject /.$ and /..$ */
1284 else if (ch == '/') {
1292 * On NTFS, we need to be careful to disallow certain synonyms of the `.git/`
1295 * - For historical reasons, file names that end in spaces or periods are
1296 * automatically trimmed. Therefore, `.git . . ./` is a valid way to refer
1299 * - For other historical reasons, file names that do not conform to the 8.3
1300 * format (up to eight characters for the basename, three for the file
1301 * extension, certain characters not allowed such as `+`, etc) are associated
1302 * with a so-called "short name", at least on the `C:` drive by default.
1303 * Which means that `git~1/` is a valid way to refer to `.git/`.
1305 * Note: Technically, `.git/` could receive the short name `git~2` if the
1306 * short name `git~1` were already used. In Git, however, we guarantee that
1307 * `.git` is the first item in a directory, therefore it will be associated
1308 * with the short name `git~1` (unless short names are disabled).
1310 * - For yet other historical reasons, NTFS supports so-called "Alternate Data
1311 * Streams", i.e. metadata associated with a given file, referred to via
1312 * `<filename>:<stream-name>:<stream-type>`. There exists a default stream
1313 * type for directories, allowing `.git/` to be accessed via
1314 * `.git::$INDEX_ALLOCATION/`.
1316 * When this function returns 1, it indicates that the specified file/directory
1317 * name refers to a `.git` file or directory, or to any of these synonyms, and
1318 * Git should therefore not track it.
1320 * For performance reasons, _all_ Alternate Data Streams of `.git/` are
1321 * forbidden, not just `::$INDEX_ALLOCATION`.
1323 * This function is intended to be used by `git fsck` even on platforms where
1324 * the backslash is a regular filename character, therefore it needs to handle
1325 * backlash characters in the provided `name` specially: they are interpreted
1326 * as directory separators.
1328 int is_ntfs_dotgit(const char *name)
1333 * Note that when we don't find `.git` or `git~1` we end up with `name`
1334 * advanced partway through the string. That's okay, though, as we
1335 * return immediately in those cases, without looking at `name` any
1341 if (((c = *(name++)) != 'g' && c != 'G') ||
1342 ((c = *(name++)) != 'i' && c != 'I') ||
1343 ((c = *(name++)) != 't' && c != 'T'))
1345 } else if (c == 'g' || c == 'G') {
1347 if (((c = *(name++)) != 'i' && c != 'I') ||
1348 ((c = *(name++)) != 't' && c != 'T') ||
1357 if (!c || c == '\\' || c == '/' || c == ':')
1359 if (c != '.' && c != ' ')
1364 static int is_ntfs_dot_generic(const char *name,
1365 const char *dotgit_name,
1367 const char *dotgit_ntfs_shortname_prefix)
1372 if ((name[0] == '.' && !strncasecmp(name + 1, dotgit_name, len))) {
1374 only_spaces_and_periods:
1379 if (c != ' ' && c != '.')
1385 * Is it a regular NTFS short name, i.e. shortened to 6 characters,
1386 * followed by ~1, ... ~4?
1388 if (!strncasecmp(name, dotgit_name, 6) && name[6] == '~' &&
1389 name[7] >= '1' && name[7] <= '4') {
1391 goto only_spaces_and_periods;
1395 * Is it a fall-back NTFS short name (for details, see
1396 * https://en.wikipedia.org/wiki/8.3_filename?
1398 for (i = 0, saw_tilde = 0; i < 8; i++)
1399 if (name[i] == '\0')
1401 else if (saw_tilde) {
1402 if (name[i] < '0' || name[i] > '9')
1404 } else if (name[i] == '~') {
1405 if (name[++i] < '1' || name[i] > '9')
1410 else if (name[i] < 0) {
1412 * We know our needles contain only ASCII, so we clamp
1413 * here to make the results of tolower() sane.
1416 } else if (tolower(name[i]) != dotgit_ntfs_shortname_prefix[i])
1419 goto only_spaces_and_periods;
1423 * Inline helper to make sure compiler resolves strlen() on literals at
1426 static inline int is_ntfs_dot_str(const char *name, const char *dotgit_name,
1427 const char *dotgit_ntfs_shortname_prefix)
1429 return is_ntfs_dot_generic(name, dotgit_name, strlen(dotgit_name),
1430 dotgit_ntfs_shortname_prefix);
1433 int is_ntfs_dotgitmodules(const char *name)
1435 return is_ntfs_dot_str(name, "gitmodules", "gi7eba");
1438 int is_ntfs_dotgitignore(const char *name)
1440 return is_ntfs_dot_str(name, "gitignore", "gi250a");
1443 int is_ntfs_dotgitattributes(const char *name)
1445 return is_ntfs_dot_str(name, "gitattributes", "gi7d29");
1448 int looks_like_command_line_option(const char *str)
1450 return str && str[0] == '-';
1453 char *xdg_config_home(const char *filename)
1455 const char *home, *config_home;
1458 config_home = getenv("XDG_CONFIG_HOME");
1459 if (config_home && *config_home)
1460 return mkpathdup("%s/git/%s", config_home, filename);
1462 home = getenv("HOME");
1464 return mkpathdup("%s/.config/git/%s", home, filename);
1468 char *xdg_cache_home(const char *filename)
1470 const char *home, *cache_home;
1473 cache_home = getenv("XDG_CACHE_HOME");
1474 if (cache_home && *cache_home)
1475 return mkpathdup("%s/git/%s", cache_home, filename);
1477 home = getenv("HOME");
1479 return mkpathdup("%s/.cache/git/%s", home, filename);
1483 GIT_PATH_FUNC(git_path_cherry_pick_head, "CHERRY_PICK_HEAD")
1484 GIT_PATH_FUNC(git_path_revert_head, "REVERT_HEAD")
1485 GIT_PATH_FUNC(git_path_squash_msg, "SQUASH_MSG")
1486 GIT_PATH_FUNC(git_path_merge_msg, "MERGE_MSG")
1487 GIT_PATH_FUNC(git_path_merge_rr, "MERGE_RR")
1488 GIT_PATH_FUNC(git_path_merge_mode, "MERGE_MODE")
1489 GIT_PATH_FUNC(git_path_merge_head, "MERGE_HEAD")
1490 GIT_PATH_FUNC(git_path_fetch_head, "FETCH_HEAD")
1491 GIT_PATH_FUNC(git_path_shallow, "shallow")