2 * Utilities for paths and pathnames
4 #include "git-compat-util.h"
6 #include "environment.h"
8 #include "repository.h"
10 #include "string-list.h"
14 #include "submodule-config.h"
17 #include "object-store-ll.h"
21 static int get_st_mode_bits(const char *path
, int *mode
)
24 if (lstat(path
, &st
) < 0)
30 static struct strbuf
*get_pathname(void)
32 static struct strbuf pathname_array
[4] = {
33 STRBUF_INIT
, STRBUF_INIT
, STRBUF_INIT
, STRBUF_INIT
36 struct strbuf
*sb
= &pathname_array
[index
];
37 index
= (index
+ 1) % ARRAY_SIZE(pathname_array
);
42 static const char *cleanup_path(const char *path
)
45 if (skip_prefix(path
, "./", &path
)) {
52 static void strbuf_cleanup_path(struct strbuf
*sb
)
54 const char *path
= cleanup_path(sb
->buf
);
56 strbuf_remove(sb
, 0, path
- sb
->buf
);
59 static int dir_prefix(const char *buf
, const char *dir
)
61 int len
= strlen(dir
);
62 return !strncmp(buf
, dir
, len
) &&
63 (is_dir_sep(buf
[len
]) || buf
[len
] == '\0');
66 /* $buf =~ m|$dir/+$file| but without regex */
67 static int is_dir_file(const char *buf
, const char *dir
, const char *file
)
69 int len
= strlen(dir
);
70 if (strncmp(buf
, dir
, len
) || !is_dir_sep(buf
[len
]))
72 while (is_dir_sep(buf
[len
]))
74 return !strcmp(buf
+ len
, file
);
77 static void replace_dir(struct strbuf
*buf
, int len
, const char *newdir
)
79 int newlen
= strlen(newdir
);
80 int need_sep
= (buf
->buf
[len
] && !is_dir_sep(buf
->buf
[len
])) &&
81 !is_dir_sep(newdir
[newlen
- 1]);
83 len
--; /* keep one char, to be replaced with '/' */
84 strbuf_splice(buf
, 0, len
, newdir
, newlen
);
86 buf
->buf
[newlen
] = '/';
90 /* Not considered garbage for report_linked_checkout_garbage */
91 unsigned ignore_garbage
:1;
93 /* Belongs to the common dir, though it may contain paths that don't */
98 static struct common_dir common_list
[] = {
99 { 0, 1, 1, "branches" },
100 { 0, 1, 1, "common" },
101 { 0, 1, 1, "hooks" },
103 { 0, 0, 0, "info/sparse-checkout" },
105 { 1, 0, 0, "logs/HEAD" },
106 { 0, 1, 0, "logs/refs/bisect" },
107 { 0, 1, 0, "logs/refs/rewritten" },
108 { 0, 1, 0, "logs/refs/worktree" },
109 { 0, 1, 1, "lost-found" },
110 { 0, 1, 1, "objects" },
112 { 0, 1, 0, "refs/bisect" },
113 { 0, 1, 0, "refs/rewritten" },
114 { 0, 1, 0, "refs/worktree" },
115 { 0, 1, 1, "remotes" },
116 { 0, 1, 1, "worktrees" },
117 { 0, 1, 1, "rr-cache" },
119 { 0, 0, 1, "config" },
120 { 1, 0, 1, "gc.pid" },
121 { 0, 0, 1, "packed-refs" },
122 { 0, 0, 1, "shallow" },
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.
131 * For example, consider the following set of strings:
137 * The trie would 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")
147 struct trie
*children
[256];
153 static struct trie
*make_trie_node(const char *key
, void *value
)
155 struct trie
*new_node
= xcalloc(1, sizeof(*new_node
));
156 new_node
->len
= strlen(key
);
158 new_node
->contents
= xmalloc(new_node
->len
);
159 memcpy(new_node
->contents
, key
, new_node
->len
);
161 new_node
->value
= value
;
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.
169 static void *add_to_trie(struct trie
*root
, const char *key
, void *value
)
176 /* we have reached the end of the key */
182 for (i
= 0; i
< root
->len
; i
++) {
183 if (root
->contents
[i
] == key
[i
])
187 * Split this node: child will contain this node's
190 child
= xmalloc(sizeof(*child
));
191 memcpy(child
->children
, root
->children
, sizeof(root
->children
));
193 child
->len
= root
->len
- i
- 1;
195 child
->contents
= xstrndup(root
->contents
+ i
+ 1,
198 child
->value
= root
->value
;
202 memset(root
->children
, 0, sizeof(root
->children
));
203 root
->children
[(unsigned char)root
->contents
[i
]] = child
;
205 /* This is the newly-added child. */
206 root
->children
[(unsigned char)key
[i
]] =
207 make_trie_node(key
+ i
+ 1, value
);
211 /* We have matched the entire compressed section */
213 child
= root
->children
[(unsigned char)key
[root
->len
]];
215 return add_to_trie(child
, key
+ root
->len
+ 1, value
);
217 child
= make_trie_node(key
+ root
->len
+ 1, value
);
218 root
->children
[(unsigned char)key
[root
->len
]] = child
;
228 typedef int (*match_fn
)(const char *unmatched
, void *value
, void *baton
);
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. If there is
233 * no such prefix, return -1. Otherwise call fn with the unmatched
234 * portion of the key and the found value. If fn returns 0 or
235 * positive, then return its return value. If fn returns negative,
236 * then call fn with the next-longest /-terminated prefix of the key
237 * (i.e. a parent directory) for which the trie contains a value, and
238 * handle its return value the same way. If there is no shorter
239 * /-terminated prefix with a value left, then return the negative
240 * return value of the most recent fn invocation.
242 * The key is partially normalized: consecutive slashes are skipped.
244 * For example, consider the trie containing only [logs,
245 * logs/refs/bisect], both with values, but not logs/refs.
247 * | key | unmatched | prefix to node | return value |
248 * |--------------------|----------------|------------------|--------------|
249 * | a | not called | n/a | -1 |
250 * | logstore | not called | n/a | -1 |
251 * | logs | \0 | logs | as per fn |
252 * | logs/ | / | logs | as per fn |
253 * | logs/refs | /refs | logs | as per fn |
254 * | logs/refs/ | /refs/ | logs | as per fn |
255 * | logs/refs/b | /refs/b | logs | as per fn |
256 * | logs/refs/bisected | /refs/bisected | logs | as per fn |
257 * | logs/refs/bisect | \0 | logs/refs/bisect | as per fn |
258 * | logs/refs/bisect/ | / | logs/refs/bisect | as per fn |
259 * | logs/refs/bisect/a | /a | logs/refs/bisect | as per fn |
260 * | (If fn in the previous line returns -1, then fn is called once more:) |
261 * | logs/refs/bisect/a | /refs/bisect/a | logs | as per fn |
262 * |--------------------|----------------|------------------|--------------|
264 static int trie_find(struct trie
*root
, const char *key
, match_fn fn
,
272 /* we have reached the end of the key */
273 if (root
->value
&& !root
->len
)
274 return fn(key
, root
->value
, baton
);
279 for (i
= 0; i
< root
->len
; i
++) {
280 /* Partial path normalization: skip consecutive slashes. */
281 if (key
[i
] == '/' && key
[i
+1] == '/') {
285 if (root
->contents
[i
] != key
[i
])
289 /* Matched the entire compressed section */
294 return fn(key
, root
->value
, baton
);
299 /* Partial path normalization: skip consecutive slashes */
300 while (key
[0] == '/' && key
[1] == '/')
303 child
= root
->children
[(unsigned char)*key
];
305 result
= trie_find(child
, key
+ 1, fn
, baton
);
309 if (result
>= 0 || (*key
!= '/' && *key
!= 0))
312 return fn(key
, root
->value
, baton
);
317 static struct trie common_trie
;
318 static int common_trie_done_setup
;
320 static void init_common_trie(void)
322 struct common_dir
*p
;
324 if (common_trie_done_setup
)
327 for (p
= common_list
; p
->path
; p
++)
328 add_to_trie(&common_trie
, p
->path
, p
);
330 common_trie_done_setup
= 1;
334 * Helper function for update_common_dir: returns 1 if the dir
337 static int check_common(const char *unmatched
, void *value
,
340 struct common_dir
*dir
= value
;
342 if (dir
->is_dir
&& (unmatched
[0] == 0 || unmatched
[0] == '/'))
343 return dir
->is_common
;
345 if (!dir
->is_dir
&& unmatched
[0] == 0)
346 return dir
->is_common
;
351 static void update_common_dir(struct strbuf
*buf
, int git_dir_len
,
352 const char *common_dir
)
354 char *base
= buf
->buf
+ git_dir_len
;
355 int has_lock_suffix
= strbuf_strip_suffix(buf
, LOCK_SUFFIX
);
358 if (trie_find(&common_trie
, base
, check_common
, NULL
) > 0)
359 replace_dir(buf
, git_dir_len
, common_dir
);
362 strbuf_addstr(buf
, LOCK_SUFFIX
);
365 void report_linked_checkout_garbage(void)
367 struct strbuf sb
= STRBUF_INIT
;
368 const struct common_dir
*p
;
371 if (!the_repository
->different_commondir
)
373 strbuf_addf(&sb
, "%s/", get_git_dir());
375 for (p
= common_list
; p
->path
; p
++) {
376 const char *path
= p
->path
;
377 if (p
->ignore_garbage
)
379 strbuf_setlen(&sb
, len
);
380 strbuf_addstr(&sb
, path
);
381 if (file_exists(sb
.buf
))
382 report_garbage(PACKDIR_FILE_GARBAGE
, sb
.buf
);
387 static void adjust_git_path(const struct repository
*repo
,
388 struct strbuf
*buf
, int git_dir_len
)
390 const char *base
= buf
->buf
+ git_dir_len
;
391 if (is_dir_file(base
, "info", "grafts"))
392 strbuf_splice(buf
, 0, buf
->len
,
393 repo
->graft_file
, strlen(repo
->graft_file
));
394 else if (!strcmp(base
, "index"))
395 strbuf_splice(buf
, 0, buf
->len
,
396 repo
->index_file
, strlen(repo
->index_file
));
397 else if (dir_prefix(base
, "objects"))
398 replace_dir(buf
, git_dir_len
+ 7, repo
->objects
->odb
->path
);
399 else if (git_hooks_path
&& dir_prefix(base
, "hooks"))
400 replace_dir(buf
, git_dir_len
+ 5, git_hooks_path
);
401 else if (repo
->different_commondir
)
402 update_common_dir(buf
, git_dir_len
, repo
->commondir
);
405 static void strbuf_worktree_gitdir(struct strbuf
*buf
,
406 const struct repository
*repo
,
407 const struct worktree
*wt
)
410 strbuf_addstr(buf
, repo
->gitdir
);
412 strbuf_addstr(buf
, repo
->commondir
);
414 strbuf_git_common_path(buf
, repo
, "worktrees/%s", wt
->id
);
417 static void do_git_path(const struct repository
*repo
,
418 const struct worktree
*wt
, struct strbuf
*buf
,
419 const char *fmt
, va_list args
)
422 strbuf_worktree_gitdir(buf
, repo
, wt
);
423 if (buf
->len
&& !is_dir_sep(buf
->buf
[buf
->len
- 1]))
424 strbuf_addch(buf
, '/');
425 gitdir_len
= buf
->len
;
426 strbuf_vaddf(buf
, fmt
, args
);
428 adjust_git_path(repo
, buf
, gitdir_len
);
429 strbuf_cleanup_path(buf
);
432 char *repo_git_path(const struct repository
*repo
,
433 const char *fmt
, ...)
435 struct strbuf path
= STRBUF_INIT
;
438 do_git_path(repo
, NULL
, &path
, fmt
, args
);
440 return strbuf_detach(&path
, NULL
);
443 void strbuf_repo_git_path(struct strbuf
*sb
,
444 const struct repository
*repo
,
445 const char *fmt
, ...)
449 do_git_path(repo
, NULL
, sb
, fmt
, args
);
453 char *git_path_buf(struct strbuf
*buf
, const char *fmt
, ...)
458 do_git_path(the_repository
, NULL
, buf
, fmt
, args
);
463 void strbuf_git_path(struct strbuf
*sb
, const char *fmt
, ...)
467 do_git_path(the_repository
, NULL
, sb
, fmt
, args
);
471 const char *git_path(const char *fmt
, ...)
473 struct strbuf
*pathname
= get_pathname();
476 do_git_path(the_repository
, NULL
, pathname
, fmt
, args
);
478 return pathname
->buf
;
481 char *git_pathdup(const char *fmt
, ...)
483 struct strbuf path
= STRBUF_INIT
;
486 do_git_path(the_repository
, NULL
, &path
, fmt
, args
);
488 return strbuf_detach(&path
, NULL
);
491 char *mkpathdup(const char *fmt
, ...)
493 struct strbuf sb
= STRBUF_INIT
;
496 strbuf_vaddf(&sb
, fmt
, args
);
498 strbuf_cleanup_path(&sb
);
499 return strbuf_detach(&sb
, NULL
);
502 const char *mkpath(const char *fmt
, ...)
505 struct strbuf
*pathname
= get_pathname();
507 strbuf_vaddf(pathname
, fmt
, args
);
509 return cleanup_path(pathname
->buf
);
512 const char *worktree_git_path(const struct worktree
*wt
, const char *fmt
, ...)
514 struct strbuf
*pathname
= get_pathname();
517 do_git_path(the_repository
, wt
, pathname
, fmt
, args
);
519 return pathname
->buf
;
522 static void do_worktree_path(const struct repository
*repo
,
524 const char *fmt
, va_list args
)
526 strbuf_addstr(buf
, repo
->worktree
);
527 if(buf
->len
&& !is_dir_sep(buf
->buf
[buf
->len
- 1]))
528 strbuf_addch(buf
, '/');
530 strbuf_vaddf(buf
, fmt
, args
);
531 strbuf_cleanup_path(buf
);
534 char *repo_worktree_path(const struct repository
*repo
, const char *fmt
, ...)
536 struct strbuf path
= STRBUF_INIT
;
543 do_worktree_path(repo
, &path
, fmt
, args
);
546 return strbuf_detach(&path
, NULL
);
549 void strbuf_repo_worktree_path(struct strbuf
*sb
,
550 const struct repository
*repo
,
551 const char *fmt
, ...)
559 do_worktree_path(repo
, sb
, fmt
, args
);
563 /* Returns 0 on success, negative on failure. */
564 static int do_submodule_path(struct strbuf
*buf
, const char *path
,
565 const char *fmt
, va_list args
)
567 struct strbuf git_submodule_common_dir
= STRBUF_INIT
;
568 struct strbuf git_submodule_dir
= STRBUF_INIT
;
571 ret
= submodule_to_gitdir(&git_submodule_dir
, path
);
575 strbuf_complete(&git_submodule_dir
, '/');
576 strbuf_addbuf(buf
, &git_submodule_dir
);
577 strbuf_vaddf(buf
, fmt
, args
);
579 if (get_common_dir_noenv(&git_submodule_common_dir
, git_submodule_dir
.buf
))
580 update_common_dir(buf
, git_submodule_dir
.len
, git_submodule_common_dir
.buf
);
582 strbuf_cleanup_path(buf
);
585 strbuf_release(&git_submodule_dir
);
586 strbuf_release(&git_submodule_common_dir
);
590 char *git_pathdup_submodule(const char *path
, const char *fmt
, ...)
594 struct strbuf buf
= STRBUF_INIT
;
596 err
= do_submodule_path(&buf
, path
, fmt
, args
);
599 strbuf_release(&buf
);
602 return strbuf_detach(&buf
, NULL
);
605 int strbuf_git_path_submodule(struct strbuf
*buf
, const char *path
,
606 const char *fmt
, ...)
611 err
= do_submodule_path(buf
, path
, fmt
, args
);
617 static void do_git_common_path(const struct repository
*repo
,
622 strbuf_addstr(buf
, repo
->commondir
);
623 if (buf
->len
&& !is_dir_sep(buf
->buf
[buf
->len
- 1]))
624 strbuf_addch(buf
, '/');
625 strbuf_vaddf(buf
, fmt
, args
);
626 strbuf_cleanup_path(buf
);
629 const char *git_common_path(const char *fmt
, ...)
631 struct strbuf
*pathname
= get_pathname();
634 do_git_common_path(the_repository
, pathname
, fmt
, args
);
636 return pathname
->buf
;
639 void strbuf_git_common_path(struct strbuf
*sb
,
640 const struct repository
*repo
,
641 const char *fmt
, ...)
645 do_git_common_path(repo
, sb
, fmt
, args
);
649 static struct passwd
*getpw_str(const char *username
, size_t len
)
652 char *username_z
= xmemdupz(username
, len
);
653 pw
= getpwnam(username_z
);
659 * Return a string with ~ and ~user expanded via getpw*. Returns NULL on getpw
660 * failure or if path is NULL.
662 * If real_home is true, strbuf_realpath($HOME) is used in the `~/` expansion.
664 * If the path starts with `%(prefix)/`, the remainder is interpreted as
665 * relative to where Git is installed, and expanded to the absolute path.
667 char *interpolate_path(const char *path
, int real_home
)
669 struct strbuf user_path
= STRBUF_INIT
;
670 const char *to_copy
= path
;
675 if (skip_prefix(path
, "%(prefix)/", &path
))
676 return system_path(path
);
678 if (path
[0] == '~') {
679 const char *first_slash
= strchrnul(path
, '/');
680 const char *username
= path
+ 1;
681 size_t username_len
= first_slash
- username
;
682 if (username_len
== 0) {
683 const char *home
= getenv("HOME");
687 strbuf_add_real_path(&user_path
, home
);
689 strbuf_addstr(&user_path
, home
);
690 #ifdef GIT_WINDOWS_NATIVE
691 convert_slashes(user_path
.buf
);
694 struct passwd
*pw
= getpw_str(username
, username_len
);
697 strbuf_addstr(&user_path
, pw
->pw_dir
);
699 to_copy
= first_slash
;
701 strbuf_addstr(&user_path
, to_copy
);
702 return strbuf_detach(&user_path
, NULL
);
704 strbuf_release(&user_path
);
709 * First, one directory to try is determined by the following algorithm.
711 * (0) If "strict" is given, the path is used as given and no DWIM is
713 * (1) "~/path" to mean path under the running user's home directory;
714 * (2) "~user/path" to mean path under named user's home directory;
715 * (3) "relative/path" to mean cwd relative directory; or
716 * (4) "/absolute/path" to mean absolute directory.
718 * Unless "strict" is given, we check "%s/.git", "%s", "%s.git/.git", "%s.git"
719 * in this order. We select the first one that is a valid git repository, and
720 * chdir() to it. If none match, or we fail to chdir, we return NULL.
722 * If all goes well, we return the directory we used to chdir() (but
723 * before ~user is expanded), avoiding getcwd() resolving symbolic
724 * links. User relative paths are also returned as they are given,
725 * except DWIM suffixing.
727 const char *enter_repo(const char *path
, int strict
)
729 static struct strbuf validated_path
= STRBUF_INIT
;
730 static struct strbuf used_path
= STRBUF_INIT
;
736 static const char *suffix
[] = {
737 "/.git", "", ".git/.git", ".git", NULL
,
740 int len
= strlen(path
);
742 while ((1 < len
) && (path
[len
-1] == '/'))
746 * We can handle arbitrary-sized buffers, but this remains as a
747 * sanity check on untrusted input.
752 strbuf_reset(&used_path
);
753 strbuf_reset(&validated_path
);
754 strbuf_add(&used_path
, path
, len
);
755 strbuf_add(&validated_path
, path
, len
);
757 if (used_path
.buf
[0] == '~') {
758 char *newpath
= interpolate_path(used_path
.buf
, 0);
761 strbuf_attach(&used_path
, newpath
, strlen(newpath
),
764 for (i
= 0; suffix
[i
]; i
++) {
766 size_t baselen
= used_path
.len
;
767 strbuf_addstr(&used_path
, suffix
[i
]);
768 if (!stat(used_path
.buf
, &st
) &&
769 (S_ISREG(st
.st_mode
) ||
770 (S_ISDIR(st
.st_mode
) && is_git_directory(used_path
.buf
)))) {
771 strbuf_addstr(&validated_path
, suffix
[i
]);
774 strbuf_setlen(&used_path
, baselen
);
778 gitfile
= read_gitfile(used_path
.buf
);
779 die_upon_dubious_ownership(gitfile
, NULL
, used_path
.buf
);
781 strbuf_reset(&used_path
);
782 strbuf_addstr(&used_path
, gitfile
);
784 if (chdir(used_path
.buf
))
786 path
= validated_path
.buf
;
789 const char *gitfile
= read_gitfile(path
);
790 die_upon_dubious_ownership(gitfile
, NULL
, path
);
797 if (is_git_directory(".")) {
799 check_repository_format(NULL
);
806 int calc_shared_perm(int mode
)
810 if (get_shared_repository() < 0)
811 tweak
= -get_shared_repository();
813 tweak
= get_shared_repository();
815 if (!(mode
& S_IWUSR
))
818 /* Copy read bits to execute bits */
819 tweak
|= (tweak
& 0444) >> 2;
820 if (get_shared_repository() < 0)
821 mode
= (mode
& ~0777) | tweak
;
829 int adjust_shared_perm(const char *path
)
831 int old_mode
, new_mode
;
833 if (!get_shared_repository())
835 if (get_st_mode_bits(path
, &old_mode
) < 0)
838 new_mode
= calc_shared_perm(old_mode
);
839 if (S_ISDIR(old_mode
)) {
840 /* Copy read bits to execute bits */
841 new_mode
|= (new_mode
& 0444) >> 2;
844 * g+s matters only if any extra access is granted
845 * based on group membership.
847 if (FORCE_DIR_SET_GID
&& (new_mode
& 060))
848 new_mode
|= FORCE_DIR_SET_GID
;
851 if (((old_mode
^ new_mode
) & ~S_IFMT
) &&
852 chmod(path
, (new_mode
& ~S_IFMT
)) < 0)
857 void safe_create_dir(const char *dir
, int share
)
859 if (mkdir(dir
, 0777) < 0) {
860 if (errno
!= EEXIST
) {
865 else if (share
&& adjust_shared_perm(dir
))
866 die(_("Could not make %s writable by group"), dir
);
869 static int have_same_root(const char *path1
, const char *path2
)
871 int is_abs1
, is_abs2
;
873 is_abs1
= is_absolute_path(path1
);
874 is_abs2
= is_absolute_path(path2
);
875 return (is_abs1
&& is_abs2
&& tolower(path1
[0]) == tolower(path2
[0])) ||
876 (!is_abs1
&& !is_abs2
);
880 * Give path as relative to prefix.
882 * The strbuf may or may not be used, so do not assume it contains the
885 const char *relative_path(const char *in
, const char *prefix
,
888 int in_len
= in
? strlen(in
) : 0;
889 int prefix_len
= prefix
? strlen(prefix
) : 0;
896 else if (!prefix_len
)
899 if (have_same_root(in
, prefix
))
900 /* bypass dos_drive, for "c:" is identical to "C:" */
901 i
= j
= has_dos_drive_prefix(in
);
906 while (i
< prefix_len
&& j
< in_len
&& prefix
[i
] == in
[j
]) {
907 if (is_dir_sep(prefix
[i
])) {
908 while (is_dir_sep(prefix
[i
]))
910 while (is_dir_sep(in
[j
]))
921 /* "prefix" seems like prefix of "in" */
924 * but "/foo" is not a prefix of "/foobar"
925 * (i.e. prefix not end with '/')
927 prefix_off
< prefix_len
) {
929 /* in="/a/b", prefix="/a/b" */
931 } else if (is_dir_sep(in
[j
])) {
932 /* in="/a/b/c", prefix="/a/b" */
933 while (is_dir_sep(in
[j
]))
937 /* in="/a/bbb/c", prefix="/a/b" */
941 /* "in" is short than "prefix" */
943 /* "in" not end with '/' */
945 if (is_dir_sep(prefix
[i
])) {
946 /* in="/a/b", prefix="/a/b/c/" */
947 while (is_dir_sep(prefix
[i
]))
955 if (i
>= prefix_len
) {
963 strbuf_grow(sb
, in_len
);
965 while (i
< prefix_len
) {
966 if (is_dir_sep(prefix
[i
])) {
967 strbuf_addstr(sb
, "../");
968 while (is_dir_sep(prefix
[i
]))
974 if (!is_dir_sep(prefix
[prefix_len
- 1]))
975 strbuf_addstr(sb
, "../");
977 strbuf_addstr(sb
, in
);
983 * A simpler implementation of relative_path
985 * Get relative path by removing "prefix" from "in". This function
986 * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
987 * to increase performance when traversing the path to work_tree.
989 const char *remove_leading_path(const char *in
, const char *prefix
)
991 static struct strbuf buf
= STRBUF_INIT
;
994 if (!prefix
|| !prefix
[0])
997 if (is_dir_sep(prefix
[i
])) {
998 if (!is_dir_sep(in
[j
]))
1000 while (is_dir_sep(prefix
[i
]))
1002 while (is_dir_sep(in
[j
]))
1005 } else if (in
[j
] != prefix
[i
]) {
1012 /* "/foo" is a prefix of "/foo" */
1014 /* "/foo" is not a prefix of "/foobar" */
1015 !is_dir_sep(prefix
[i
-1]) && !is_dir_sep(in
[j
])
1018 while (is_dir_sep(in
[j
]))
1023 strbuf_addstr(&buf
, ".");
1025 strbuf_addstr(&buf
, in
+ j
);
1030 * It is okay if dst == src, but they should not overlap otherwise.
1031 * The "dst" buffer must be at least as long as "src"; normalizing may shrink
1032 * the size of the path, but will never grow it.
1034 * Performs the following normalizations on src, storing the result in dst:
1035 * - Ensures that components are separated by '/' (Windows only)
1036 * - Squashes sequences of '/' except "//server/share" on Windows
1037 * - Removes "." components.
1038 * - Removes ".." components, and the components the precede them.
1039 * Returns failure (non-zero) if a ".." component appears as first path
1040 * component anytime during the normalization. Otherwise, returns success (0).
1042 * Note that this function is purely textual. It does not follow symlinks,
1043 * verify the existence of the path, or make any system calls.
1045 * prefix_len != NULL is for a specific case of prefix_pathspec():
1046 * assume that src == dst and src[0..prefix_len-1] is already
1047 * normalized, any time "../" eats up to the prefix_len part,
1048 * prefix_len is reduced. In the end prefix_len is the remaining
1049 * prefix that has not been overridden by user pathspec.
1051 * NEEDSWORK: This function doesn't perform normalization w.r.t. trailing '/'.
1052 * For everything but the root folder itself, the normalized path should not
1053 * end with a '/', then the callers need to be fixed up accordingly.
1056 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
)
1062 * Copy initial part of absolute path: "/", "C:/", "//server/share/".
1064 end
= src
+ offset_1st_component(src
);
1073 while (is_dir_sep(*src
))
1080 * A path component that begins with . could be
1082 * (1) "." and ends -- ignore and terminate.
1083 * (2) "./" -- ignore them, eat slash and continue.
1084 * (3) ".." and ends -- strip one and terminate.
1085 * (4) "../" -- strip one, eat slash and continue.
1091 } else if (is_dir_sep(src
[1])) {
1094 while (is_dir_sep(*src
))
1097 } else if (src
[1] == '.') {
1102 } else if (is_dir_sep(src
[2])) {
1105 while (is_dir_sep(*src
))
1112 /* copy up to the next '/', and eat all '/' */
1113 while ((c
= *src
++) != '\0' && !is_dir_sep(c
))
1115 if (is_dir_sep(c
)) {
1117 while (is_dir_sep(c
))
1126 * dst0..dst is prefix portion, and dst[-1] is '/';
1129 dst
--; /* go to trailing '/' */
1132 /* Windows: dst[-1] cannot be backslash anymore */
1133 while (dst0
< dst
&& dst
[-1] != '/')
1135 if (prefix_len
&& *prefix_len
> dst
- dst0
)
1136 *prefix_len
= dst
- dst0
;
1142 int normalize_path_copy(char *dst
, const char *src
)
1144 return normalize_path_copy_len(dst
, src
, NULL
);
1147 int strbuf_normalize_path(struct strbuf
*src
)
1149 struct strbuf dst
= STRBUF_INIT
;
1151 strbuf_grow(&dst
, src
->len
);
1152 if (normalize_path_copy(dst
.buf
, src
->buf
) < 0) {
1153 strbuf_release(&dst
);
1158 * normalize_path does not tell us the new length, so we have to
1159 * compute it by looking for the new NUL it placed
1161 strbuf_setlen(&dst
, strlen(dst
.buf
));
1162 strbuf_swap(src
, &dst
);
1163 strbuf_release(&dst
);
1168 * path = Canonical absolute path
1169 * prefixes = string_list containing normalized, absolute paths without
1170 * trailing slashes (except for the root directory, which is denoted by "/").
1172 * Determines, for each path in prefixes, whether the "prefix"
1173 * is an ancestor directory of path. Returns the length of the longest
1174 * ancestor directory, excluding any trailing slashes, or -1 if no prefix
1175 * is an ancestor. (Note that this means 0 is returned if prefixes is
1176 * ["/"].) "/foo" is not considered an ancestor of "/foobar". Directories
1177 * are not considered to be their own ancestors. path must be in a
1178 * canonical form: empty components, or "." or ".." components are not
1181 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
)
1183 int i
, max_len
= -1;
1185 if (!strcmp(path
, "/"))
1188 for (i
= 0; i
< prefixes
->nr
; i
++) {
1189 const char *ceil
= prefixes
->items
[i
].string
;
1190 int len
= strlen(ceil
);
1193 * For root directories (`/`, `C:/`, `//server/share/`)
1194 * adjust the length to exclude the trailing slash.
1196 if (len
> 0 && ceil
[len
- 1] == '/')
1199 if (strncmp(path
, ceil
, len
) ||
1200 path
[len
] != '/' || !path
[len
+ 1])
1201 continue; /* no match */
1210 /* strip arbitrary amount of directory separators at end of path */
1211 static inline int chomp_trailing_dir_sep(const char *path
, int len
)
1213 while (len
&& is_dir_sep(path
[len
- 1]))
1219 * If path ends with suffix (complete path components), returns the offset of
1220 * the last character in the path before the suffix (sans trailing directory
1221 * separators), and -1 otherwise.
1223 static ssize_t
stripped_path_suffix_offset(const char *path
, const char *suffix
)
1225 int path_len
= strlen(path
), suffix_len
= strlen(suffix
);
1227 while (suffix_len
) {
1231 if (is_dir_sep(path
[path_len
- 1])) {
1232 if (!is_dir_sep(suffix
[suffix_len
- 1]))
1234 path_len
= chomp_trailing_dir_sep(path
, path_len
);
1235 suffix_len
= chomp_trailing_dir_sep(suffix
, suffix_len
);
1237 else if (path
[--path_len
] != suffix
[--suffix_len
])
1241 if (path_len
&& !is_dir_sep(path
[path_len
- 1]))
1243 return chomp_trailing_dir_sep(path
, path_len
);
1247 * Returns true if the path ends with components, considering only complete path
1248 * components, and false otherwise.
1250 int ends_with_path_components(const char *path
, const char *components
)
1252 return stripped_path_suffix_offset(path
, components
) != -1;
1256 * If path ends with suffix (complete path components), returns the
1257 * part before suffix (sans trailing directory separators).
1258 * Otherwise returns NULL.
1260 char *strip_path_suffix(const char *path
, const char *suffix
)
1262 ssize_t offset
= stripped_path_suffix_offset(path
, suffix
);
1264 return offset
== -1 ? NULL
: xstrndup(path
, offset
);
1267 int daemon_avoid_alias(const char *p
)
1272 * This resurrects the belts and suspenders paranoia check by HPA
1273 * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
1274 * does not do getcwd() based path canonicalization.
1276 * sl becomes true immediately after seeing '/' and continues to
1277 * be true as long as dots continue after that without intervening
1278 * non-dot character.
1280 if (!p
|| (*p
!= '/' && *p
!= '~'))
1290 else if (ch
== '/') {
1292 /* reject //, /./ and /../ */
1297 if (0 < ndot
&& ndot
< 3)
1298 /* reject /.$ and /..$ */
1307 else if (ch
== '/') {
1315 * On NTFS, we need to be careful to disallow certain synonyms of the `.git/`
1318 * - For historical reasons, file names that end in spaces or periods are
1319 * automatically trimmed. Therefore, `.git . . ./` is a valid way to refer
1322 * - For other historical reasons, file names that do not conform to the 8.3
1323 * format (up to eight characters for the basename, three for the file
1324 * extension, certain characters not allowed such as `+`, etc) are associated
1325 * with a so-called "short name", at least on the `C:` drive by default.
1326 * Which means that `git~1/` is a valid way to refer to `.git/`.
1328 * Note: Technically, `.git/` could receive the short name `git~2` if the
1329 * short name `git~1` were already used. In Git, however, we guarantee that
1330 * `.git` is the first item in a directory, therefore it will be associated
1331 * with the short name `git~1` (unless short names are disabled).
1333 * - For yet other historical reasons, NTFS supports so-called "Alternate Data
1334 * Streams", i.e. metadata associated with a given file, referred to via
1335 * `<filename>:<stream-name>:<stream-type>`. There exists a default stream
1336 * type for directories, allowing `.git/` to be accessed via
1337 * `.git::$INDEX_ALLOCATION/`.
1339 * When this function returns 1, it indicates that the specified file/directory
1340 * name refers to a `.git` file or directory, or to any of these synonyms, and
1341 * Git should therefore not track it.
1343 * For performance reasons, _all_ Alternate Data Streams of `.git/` are
1344 * forbidden, not just `::$INDEX_ALLOCATION`.
1346 * This function is intended to be used by `git fsck` even on platforms where
1347 * the backslash is a regular filename character, therefore it needs to handle
1348 * backlash characters in the provided `name` specially: they are interpreted
1349 * as directory separators.
1351 int is_ntfs_dotgit(const char *name
)
1356 * Note that when we don't find `.git` or `git~1` we end up with `name`
1357 * advanced partway through the string. That's okay, though, as we
1358 * return immediately in those cases, without looking at `name` any
1364 if (((c
= *(name
++)) != 'g' && c
!= 'G') ||
1365 ((c
= *(name
++)) != 'i' && c
!= 'I') ||
1366 ((c
= *(name
++)) != 't' && c
!= 'T'))
1368 } else if (c
== 'g' || c
== 'G') {
1370 if (((c
= *(name
++)) != 'i' && c
!= 'I') ||
1371 ((c
= *(name
++)) != 't' && c
!= 'T') ||
1380 if (!c
|| is_xplatform_dir_sep(c
) || c
== ':')
1382 if (c
!= '.' && c
!= ' ')
1387 static int is_ntfs_dot_generic(const char *name
,
1388 const char *dotgit_name
,
1390 const char *dotgit_ntfs_shortname_prefix
)
1395 if ((name
[0] == '.' && !strncasecmp(name
+ 1, dotgit_name
, len
))) {
1397 only_spaces_and_periods
:
1402 if (c
!= ' ' && c
!= '.')
1408 * Is it a regular NTFS short name, i.e. shortened to 6 characters,
1409 * followed by ~1, ... ~4?
1411 if (!strncasecmp(name
, dotgit_name
, 6) && name
[6] == '~' &&
1412 name
[7] >= '1' && name
[7] <= '4') {
1414 goto only_spaces_and_periods
;
1418 * Is it a fall-back NTFS short name (for details, see
1419 * https://en.wikipedia.org/wiki/8.3_filename?
1421 for (i
= 0, saw_tilde
= 0; i
< 8; i
++)
1422 if (name
[i
] == '\0')
1424 else if (saw_tilde
) {
1425 if (name
[i
] < '0' || name
[i
] > '9')
1427 } else if (name
[i
] == '~') {
1428 if (name
[++i
] < '1' || name
[i
] > '9')
1433 else if (name
[i
] & 0x80) {
1435 * We know our needles contain only ASCII, so we clamp
1436 * here to make the results of tolower() sane.
1439 } else if (tolower(name
[i
]) != dotgit_ntfs_shortname_prefix
[i
])
1442 goto only_spaces_and_periods
;
1446 * Inline helper to make sure compiler resolves strlen() on literals at
1449 static inline int is_ntfs_dot_str(const char *name
, const char *dotgit_name
,
1450 const char *dotgit_ntfs_shortname_prefix
)
1452 return is_ntfs_dot_generic(name
, dotgit_name
, strlen(dotgit_name
),
1453 dotgit_ntfs_shortname_prefix
);
1456 int is_ntfs_dotgitmodules(const char *name
)
1458 return is_ntfs_dot_str(name
, "gitmodules", "gi7eba");
1461 int is_ntfs_dotgitignore(const char *name
)
1463 return is_ntfs_dot_str(name
, "gitignore", "gi250a");
1466 int is_ntfs_dotgitattributes(const char *name
)
1468 return is_ntfs_dot_str(name
, "gitattributes", "gi7d29");
1471 int is_ntfs_dotmailmap(const char *name
)
1473 return is_ntfs_dot_str(name
, "mailmap", "maba30");
1476 int looks_like_command_line_option(const char *str
)
1478 return str
&& str
[0] == '-';
1481 char *xdg_config_home_for(const char *subdir
, const char *filename
)
1483 const char *home
, *config_home
;
1487 config_home
= getenv("XDG_CONFIG_HOME");
1488 if (config_home
&& *config_home
)
1489 return mkpathdup("%s/%s/%s", config_home
, subdir
, filename
);
1491 home
= getenv("HOME");
1493 return mkpathdup("%s/.config/%s/%s", home
, subdir
, filename
);
1498 char *xdg_config_home(const char *filename
)
1500 return xdg_config_home_for("git", filename
);
1503 char *xdg_cache_home(const char *filename
)
1505 const char *home
, *cache_home
;
1508 cache_home
= getenv("XDG_CACHE_HOME");
1509 if (cache_home
&& *cache_home
)
1510 return mkpathdup("%s/git/%s", cache_home
, filename
);
1512 home
= getenv("HOME");
1514 return mkpathdup("%s/.cache/git/%s", home
, filename
);
1518 REPO_GIT_PATH_FUNC(squash_msg
, "SQUASH_MSG")
1519 REPO_GIT_PATH_FUNC(merge_msg
, "MERGE_MSG")
1520 REPO_GIT_PATH_FUNC(merge_rr
, "MERGE_RR")
1521 REPO_GIT_PATH_FUNC(merge_mode
, "MERGE_MODE")
1522 REPO_GIT_PATH_FUNC(merge_head
, "MERGE_HEAD")
1523 REPO_GIT_PATH_FUNC(fetch_head
, "FETCH_HEAD")
1524 REPO_GIT_PATH_FUNC(shallow
, "shallow")