2 * Utilities for paths and pathnames
7 #include "repository.h"
9 #include "string-list.h"
12 #include "submodule-config.h"
15 #include "object-store.h"
19 static int get_st_mode_bits(const char *path
, int *mode
)
22 if (lstat(path
, &st
) < 0)
28 static char bad_path
[] = "/bad-path/";
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 char *mksnpath(char *buf
, size_t n
, const char *fmt
, ...)
65 len
= vsnprintf(buf
, n
, fmt
, args
);
68 strlcpy(buf
, bad_path
, n
);
71 return (char *)cleanup_path(buf
);
74 static int dir_prefix(const char *buf
, const char *dir
)
76 int len
= strlen(dir
);
77 return !strncmp(buf
, dir
, len
) &&
78 (is_dir_sep(buf
[len
]) || buf
[len
] == '\0');
81 /* $buf =~ m|$dir/+$file| but without regex */
82 static int is_dir_file(const char *buf
, const char *dir
, const char *file
)
84 int len
= strlen(dir
);
85 if (strncmp(buf
, dir
, len
) || !is_dir_sep(buf
[len
]))
87 while (is_dir_sep(buf
[len
]))
89 return !strcmp(buf
+ len
, file
);
92 static void replace_dir(struct strbuf
*buf
, int len
, const char *newdir
)
94 int newlen
= strlen(newdir
);
95 int need_sep
= (buf
->buf
[len
] && !is_dir_sep(buf
->buf
[len
])) &&
96 !is_dir_sep(newdir
[newlen
- 1]);
98 len
--; /* keep one char, to be replaced with '/' */
99 strbuf_splice(buf
, 0, len
, newdir
, newlen
);
101 buf
->buf
[newlen
] = '/';
105 /* Not considered garbage for report_linked_checkout_garbage */
106 unsigned ignore_garbage
:1;
108 /* Belongs to the common dir, though it may contain paths that don't */
109 unsigned is_common
:1;
113 static struct common_dir common_list
[] = {
114 { 0, 1, 1, "branches" },
115 { 0, 1, 1, "common" },
116 { 0, 1, 1, "hooks" },
118 { 0, 0, 0, "info/sparse-checkout" },
120 { 1, 0, 0, "logs/HEAD" },
121 { 0, 1, 0, "logs/refs/bisect" },
122 { 0, 1, 0, "logs/refs/rewritten" },
123 { 0, 1, 0, "logs/refs/worktree" },
124 { 0, 1, 1, "lost-found" },
125 { 0, 1, 1, "objects" },
127 { 0, 1, 0, "refs/bisect" },
128 { 0, 1, 0, "refs/rewritten" },
129 { 0, 1, 0, "refs/worktree" },
130 { 0, 1, 1, "remotes" },
131 { 0, 1, 1, "worktrees" },
132 { 0, 1, 1, "rr-cache" },
134 { 0, 0, 1, "config" },
135 { 1, 0, 1, "gc.pid" },
136 { 0, 0, 1, "packed-refs" },
137 { 0, 0, 1, "shallow" },
142 * A compressed trie. A trie node consists of zero or more characters that
143 * are common to all elements with this prefix, optionally followed by some
144 * children. If value is not NULL, the trie node is a terminal node.
146 * For example, consider the following set of strings:
152 * The trie would look like:
153 * root: len = 0, children a and d non-NULL, value = NULL.
154 * a: len = 2, contents = bc, value = (data for "abc")
155 * d: len = 2, contents = ef, children i non-NULL, value = (data for "def")
156 * i: len = 3, contents = nit, children e and i non-NULL, value = NULL
157 * e: len = 0, children all NULL, value = (data for "definite")
158 * i: len = 2, contents = on, children all NULL,
159 * value = (data for "definition")
162 struct trie
*children
[256];
168 static struct trie
*make_trie_node(const char *key
, void *value
)
170 struct trie
*new_node
= xcalloc(1, sizeof(*new_node
));
171 new_node
->len
= strlen(key
);
173 new_node
->contents
= xmalloc(new_node
->len
);
174 memcpy(new_node
->contents
, key
, new_node
->len
);
176 new_node
->value
= value
;
181 * Add a key/value pair to a trie. The key is assumed to be \0-terminated.
182 * If there was an existing value for this key, return it.
184 static void *add_to_trie(struct trie
*root
, const char *key
, void *value
)
191 /* we have reached the end of the key */
197 for (i
= 0; i
< root
->len
; i
++) {
198 if (root
->contents
[i
] == key
[i
])
202 * Split this node: child will contain this node's
205 child
= xmalloc(sizeof(*child
));
206 memcpy(child
->children
, root
->children
, sizeof(root
->children
));
208 child
->len
= root
->len
- i
- 1;
210 child
->contents
= xstrndup(root
->contents
+ i
+ 1,
213 child
->value
= root
->value
;
217 memset(root
->children
, 0, sizeof(root
->children
));
218 root
->children
[(unsigned char)root
->contents
[i
]] = child
;
220 /* This is the newly-added child. */
221 root
->children
[(unsigned char)key
[i
]] =
222 make_trie_node(key
+ i
+ 1, value
);
226 /* We have matched the entire compressed section */
228 child
= root
->children
[(unsigned char)key
[root
->len
]];
230 return add_to_trie(child
, key
+ root
->len
+ 1, value
);
232 child
= make_trie_node(key
+ root
->len
+ 1, value
);
233 root
->children
[(unsigned char)key
[root
->len
]] = child
;
243 typedef int (*match_fn
)(const char *unmatched
, void *value
, void *baton
);
246 * Search a trie for some key. Find the longest /-or-\0-terminated
247 * prefix of the key for which the trie contains a value. If there is
248 * no such prefix, return -1. Otherwise call fn with the unmatched
249 * portion of the key and the found value. If fn returns 0 or
250 * positive, then return its return value. If fn returns negative,
251 * then call fn with the next-longest /-terminated prefix of the key
252 * (i.e. a parent directory) for which the trie contains a value, and
253 * handle its return value the same way. If there is no shorter
254 * /-terminated prefix with a value left, then return the negative
255 * return value of the most recent fn invocation.
257 * The key is partially normalized: consecutive slashes are skipped.
259 * For example, consider the trie containing only [logs,
260 * logs/refs/bisect], both with values, but not logs/refs.
262 * | key | unmatched | prefix to node | return value |
263 * |--------------------|----------------|------------------|--------------|
264 * | a | not called | n/a | -1 |
265 * | logstore | not called | n/a | -1 |
266 * | logs | \0 | logs | as per fn |
267 * | logs/ | / | logs | as per fn |
268 * | logs/refs | /refs | logs | as per fn |
269 * | logs/refs/ | /refs/ | logs | as per fn |
270 * | logs/refs/b | /refs/b | logs | as per fn |
271 * | logs/refs/bisected | /refs/bisected | logs | as per fn |
272 * | logs/refs/bisect | \0 | logs/refs/bisect | as per fn |
273 * | logs/refs/bisect/ | / | logs/refs/bisect | as per fn |
274 * | logs/refs/bisect/a | /a | logs/refs/bisect | as per fn |
275 * | (If fn in the previous line returns -1, then fn is called once more:) |
276 * | logs/refs/bisect/a | /refs/bisect/a | logs | as per fn |
277 * |--------------------|----------------|------------------|--------------|
279 static int trie_find(struct trie
*root
, const char *key
, match_fn fn
,
287 /* we have reached the end of the key */
288 if (root
->value
&& !root
->len
)
289 return fn(key
, root
->value
, baton
);
294 for (i
= 0; i
< root
->len
; i
++) {
295 /* Partial path normalization: skip consecutive slashes. */
296 if (key
[i
] == '/' && key
[i
+1] == '/') {
300 if (root
->contents
[i
] != key
[i
])
304 /* Matched the entire compressed section */
309 return fn(key
, root
->value
, baton
);
314 /* Partial path normalization: skip consecutive slashes */
315 while (key
[0] == '/' && key
[1] == '/')
318 child
= root
->children
[(unsigned char)*key
];
320 result
= trie_find(child
, key
+ 1, fn
, baton
);
324 if (result
>= 0 || (*key
!= '/' && *key
!= 0))
327 return fn(key
, root
->value
, baton
);
332 static struct trie common_trie
;
333 static int common_trie_done_setup
;
335 static void init_common_trie(void)
337 struct common_dir
*p
;
339 if (common_trie_done_setup
)
342 for (p
= common_list
; p
->path
; p
++)
343 add_to_trie(&common_trie
, p
->path
, p
);
345 common_trie_done_setup
= 1;
349 * Helper function for update_common_dir: returns 1 if the dir
352 static int check_common(const char *unmatched
, void *value
,
355 struct common_dir
*dir
= value
;
357 if (dir
->is_dir
&& (unmatched
[0] == 0 || unmatched
[0] == '/'))
358 return dir
->is_common
;
360 if (!dir
->is_dir
&& unmatched
[0] == 0)
361 return dir
->is_common
;
366 static void update_common_dir(struct strbuf
*buf
, int git_dir_len
,
367 const char *common_dir
)
369 char *base
= buf
->buf
+ git_dir_len
;
370 int has_lock_suffix
= strbuf_strip_suffix(buf
, LOCK_SUFFIX
);
373 if (trie_find(&common_trie
, base
, check_common
, NULL
) > 0)
374 replace_dir(buf
, git_dir_len
, common_dir
);
377 strbuf_addstr(buf
, LOCK_SUFFIX
);
380 void report_linked_checkout_garbage(void)
382 struct strbuf sb
= STRBUF_INIT
;
383 const struct common_dir
*p
;
386 if (!the_repository
->different_commondir
)
388 strbuf_addf(&sb
, "%s/", get_git_dir());
390 for (p
= common_list
; p
->path
; p
++) {
391 const char *path
= p
->path
;
392 if (p
->ignore_garbage
)
394 strbuf_setlen(&sb
, len
);
395 strbuf_addstr(&sb
, path
);
396 if (file_exists(sb
.buf
))
397 report_garbage(PACKDIR_FILE_GARBAGE
, sb
.buf
);
402 static void adjust_git_path(const struct repository
*repo
,
403 struct strbuf
*buf
, int git_dir_len
)
405 const char *base
= buf
->buf
+ git_dir_len
;
406 if (is_dir_file(base
, "info", "grafts"))
407 strbuf_splice(buf
, 0, buf
->len
,
408 repo
->graft_file
, strlen(repo
->graft_file
));
409 else if (!strcmp(base
, "index"))
410 strbuf_splice(buf
, 0, buf
->len
,
411 repo
->index_file
, strlen(repo
->index_file
));
412 else if (dir_prefix(base
, "objects"))
413 replace_dir(buf
, git_dir_len
+ 7, repo
->objects
->odb
->path
);
414 else if (git_hooks_path
&& dir_prefix(base
, "hooks"))
415 replace_dir(buf
, git_dir_len
+ 5, git_hooks_path
);
416 else if (repo
->different_commondir
)
417 update_common_dir(buf
, git_dir_len
, repo
->commondir
);
420 static void strbuf_worktree_gitdir(struct strbuf
*buf
,
421 const struct repository
*repo
,
422 const struct worktree
*wt
)
425 strbuf_addstr(buf
, repo
->gitdir
);
427 strbuf_addstr(buf
, repo
->commondir
);
429 strbuf_git_common_path(buf
, repo
, "worktrees/%s", wt
->id
);
432 static void do_git_path(const struct repository
*repo
,
433 const struct worktree
*wt
, struct strbuf
*buf
,
434 const char *fmt
, va_list args
)
437 strbuf_worktree_gitdir(buf
, repo
, wt
);
438 if (buf
->len
&& !is_dir_sep(buf
->buf
[buf
->len
- 1]))
439 strbuf_addch(buf
, '/');
440 gitdir_len
= buf
->len
;
441 strbuf_vaddf(buf
, fmt
, args
);
443 adjust_git_path(repo
, buf
, gitdir_len
);
444 strbuf_cleanup_path(buf
);
447 char *repo_git_path(const struct repository
*repo
,
448 const char *fmt
, ...)
450 struct strbuf path
= STRBUF_INIT
;
453 do_git_path(repo
, NULL
, &path
, fmt
, args
);
455 return strbuf_detach(&path
, NULL
);
458 void strbuf_repo_git_path(struct strbuf
*sb
,
459 const struct repository
*repo
,
460 const char *fmt
, ...)
464 do_git_path(repo
, NULL
, sb
, fmt
, args
);
468 char *git_path_buf(struct strbuf
*buf
, const char *fmt
, ...)
473 do_git_path(the_repository
, NULL
, buf
, fmt
, args
);
478 void strbuf_git_path(struct strbuf
*sb
, const char *fmt
, ...)
482 do_git_path(the_repository
, NULL
, sb
, fmt
, args
);
486 const char *git_path(const char *fmt
, ...)
488 struct strbuf
*pathname
= get_pathname();
491 do_git_path(the_repository
, NULL
, pathname
, fmt
, args
);
493 return pathname
->buf
;
496 char *git_pathdup(const char *fmt
, ...)
498 struct strbuf path
= STRBUF_INIT
;
501 do_git_path(the_repository
, NULL
, &path
, fmt
, args
);
503 return strbuf_detach(&path
, NULL
);
506 char *mkpathdup(const char *fmt
, ...)
508 struct strbuf sb
= STRBUF_INIT
;
511 strbuf_vaddf(&sb
, fmt
, args
);
513 strbuf_cleanup_path(&sb
);
514 return strbuf_detach(&sb
, NULL
);
517 const char *mkpath(const char *fmt
, ...)
520 struct strbuf
*pathname
= get_pathname();
522 strbuf_vaddf(pathname
, fmt
, args
);
524 return cleanup_path(pathname
->buf
);
527 const char *worktree_git_path(const struct worktree
*wt
, const char *fmt
, ...)
529 struct strbuf
*pathname
= get_pathname();
532 do_git_path(the_repository
, wt
, pathname
, fmt
, args
);
534 return pathname
->buf
;
537 static void do_worktree_path(const struct repository
*repo
,
539 const char *fmt
, va_list args
)
541 strbuf_addstr(buf
, repo
->worktree
);
542 if(buf
->len
&& !is_dir_sep(buf
->buf
[buf
->len
- 1]))
543 strbuf_addch(buf
, '/');
545 strbuf_vaddf(buf
, fmt
, args
);
546 strbuf_cleanup_path(buf
);
549 char *repo_worktree_path(const struct repository
*repo
, const char *fmt
, ...)
551 struct strbuf path
= STRBUF_INIT
;
558 do_worktree_path(repo
, &path
, fmt
, args
);
561 return strbuf_detach(&path
, NULL
);
564 void strbuf_repo_worktree_path(struct strbuf
*sb
,
565 const struct repository
*repo
,
566 const char *fmt
, ...)
574 do_worktree_path(repo
, sb
, fmt
, args
);
578 /* Returns 0 on success, negative on failure. */
579 static int do_submodule_path(struct strbuf
*buf
, const char *path
,
580 const char *fmt
, va_list args
)
582 struct strbuf git_submodule_common_dir
= STRBUF_INIT
;
583 struct strbuf git_submodule_dir
= STRBUF_INIT
;
586 ret
= submodule_to_gitdir(&git_submodule_dir
, path
);
590 strbuf_complete(&git_submodule_dir
, '/');
591 strbuf_addbuf(buf
, &git_submodule_dir
);
592 strbuf_vaddf(buf
, fmt
, args
);
594 if (get_common_dir_noenv(&git_submodule_common_dir
, git_submodule_dir
.buf
))
595 update_common_dir(buf
, git_submodule_dir
.len
, git_submodule_common_dir
.buf
);
597 strbuf_cleanup_path(buf
);
600 strbuf_release(&git_submodule_dir
);
601 strbuf_release(&git_submodule_common_dir
);
605 char *git_pathdup_submodule(const char *path
, const char *fmt
, ...)
609 struct strbuf buf
= STRBUF_INIT
;
611 err
= do_submodule_path(&buf
, path
, fmt
, args
);
614 strbuf_release(&buf
);
617 return strbuf_detach(&buf
, NULL
);
620 int strbuf_git_path_submodule(struct strbuf
*buf
, const char *path
,
621 const char *fmt
, ...)
626 err
= do_submodule_path(buf
, path
, fmt
, args
);
632 static void do_git_common_path(const struct repository
*repo
,
637 strbuf_addstr(buf
, repo
->commondir
);
638 if (buf
->len
&& !is_dir_sep(buf
->buf
[buf
->len
- 1]))
639 strbuf_addch(buf
, '/');
640 strbuf_vaddf(buf
, fmt
, args
);
641 strbuf_cleanup_path(buf
);
644 const char *git_common_path(const char *fmt
, ...)
646 struct strbuf
*pathname
= get_pathname();
649 do_git_common_path(the_repository
, pathname
, fmt
, args
);
651 return pathname
->buf
;
654 void strbuf_git_common_path(struct strbuf
*sb
,
655 const struct repository
*repo
,
656 const char *fmt
, ...)
660 do_git_common_path(repo
, sb
, fmt
, args
);
664 int validate_headref(const char *path
)
669 struct object_id oid
;
673 if (lstat(path
, &st
) < 0)
676 /* Make sure it is a "refs/.." symlink */
677 if (S_ISLNK(st
.st_mode
)) {
678 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
679 if (len
>= 5 && !memcmp("refs/", buffer
, 5))
685 * Anything else, just open it and try to see if it is a symbolic ref.
687 fd
= open(path
, O_RDONLY
);
690 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
698 * Is it a symbolic ref?
700 if (skip_prefix(buffer
, "ref:", &refname
)) {
701 while (isspace(*refname
))
703 if (starts_with(refname
, "refs/"))
708 * Is this a detached HEAD?
710 if (!get_oid_hex(buffer
, &oid
))
716 static struct passwd
*getpw_str(const char *username
, size_t len
)
719 char *username_z
= xmemdupz(username
, len
);
720 pw
= getpwnam(username_z
);
726 * Return a string with ~ and ~user expanded via getpw*. Returns NULL on getpw
727 * failure or if path is NULL.
729 * If real_home is true, strbuf_realpath($HOME) is used in the `~/` expansion.
731 * If the path starts with `%(prefix)/`, the remainder is interpreted as
732 * relative to where Git is installed, and expanded to the absolute path.
734 char *interpolate_path(const char *path
, int real_home
)
736 struct strbuf user_path
= STRBUF_INIT
;
737 const char *to_copy
= path
;
742 if (skip_prefix(path
, "%(prefix)/", &path
))
743 return system_path(path
);
745 if (path
[0] == '~') {
746 const char *first_slash
= strchrnul(path
, '/');
747 const char *username
= path
+ 1;
748 size_t username_len
= first_slash
- username
;
749 if (username_len
== 0) {
750 const char *home
= getenv("HOME");
754 strbuf_add_real_path(&user_path
, home
);
756 strbuf_addstr(&user_path
, home
);
757 #ifdef GIT_WINDOWS_NATIVE
758 convert_slashes(user_path
.buf
);
761 struct passwd
*pw
= getpw_str(username
, username_len
);
764 strbuf_addstr(&user_path
, pw
->pw_dir
);
766 to_copy
= first_slash
;
768 strbuf_addstr(&user_path
, to_copy
);
769 return strbuf_detach(&user_path
, NULL
);
771 strbuf_release(&user_path
);
776 * First, one directory to try is determined by the following algorithm.
778 * (0) If "strict" is given, the path is used as given and no DWIM is
780 * (1) "~/path" to mean path under the running user's home directory;
781 * (2) "~user/path" to mean path under named user's home directory;
782 * (3) "relative/path" to mean cwd relative directory; or
783 * (4) "/absolute/path" to mean absolute directory.
785 * Unless "strict" is given, we check "%s/.git", "%s", "%s.git/.git", "%s.git"
786 * in this order. We select the first one that is a valid git repository, and
787 * chdir() to it. If none match, or we fail to chdir, we return NULL.
789 * If all goes well, we return the directory we used to chdir() (but
790 * before ~user is expanded), avoiding getcwd() resolving symbolic
791 * links. User relative paths are also returned as they are given,
792 * except DWIM suffixing.
794 const char *enter_repo(const char *path
, int strict
)
796 static struct strbuf validated_path
= STRBUF_INIT
;
797 static struct strbuf used_path
= STRBUF_INIT
;
803 static const char *suffix
[] = {
804 "/.git", "", ".git/.git", ".git", NULL
,
807 int len
= strlen(path
);
809 while ((1 < len
) && (path
[len
-1] == '/'))
813 * We can handle arbitrary-sized buffers, but this remains as a
814 * sanity check on untrusted input.
819 strbuf_reset(&used_path
);
820 strbuf_reset(&validated_path
);
821 strbuf_add(&used_path
, path
, len
);
822 strbuf_add(&validated_path
, path
, len
);
824 if (used_path
.buf
[0] == '~') {
825 char *newpath
= interpolate_path(used_path
.buf
, 0);
828 strbuf_attach(&used_path
, newpath
, strlen(newpath
),
831 for (i
= 0; suffix
[i
]; i
++) {
833 size_t baselen
= used_path
.len
;
834 strbuf_addstr(&used_path
, suffix
[i
]);
835 if (!stat(used_path
.buf
, &st
) &&
836 (S_ISREG(st
.st_mode
) ||
837 (S_ISDIR(st
.st_mode
) && is_git_directory(used_path
.buf
)))) {
838 strbuf_addstr(&validated_path
, suffix
[i
]);
841 strbuf_setlen(&used_path
, baselen
);
845 gitfile
= read_gitfile(used_path
.buf
);
847 strbuf_reset(&used_path
);
848 strbuf_addstr(&used_path
, gitfile
);
850 if (chdir(used_path
.buf
))
852 path
= validated_path
.buf
;
855 const char *gitfile
= read_gitfile(path
);
862 if (is_git_directory(".")) {
864 check_repository_format(NULL
);
871 static int calc_shared_perm(int mode
)
875 if (get_shared_repository() < 0)
876 tweak
= -get_shared_repository();
878 tweak
= get_shared_repository();
880 if (!(mode
& S_IWUSR
))
883 /* Copy read bits to execute bits */
884 tweak
|= (tweak
& 0444) >> 2;
885 if (get_shared_repository() < 0)
886 mode
= (mode
& ~0777) | tweak
;
894 int adjust_shared_perm(const char *path
)
896 int old_mode
, new_mode
;
898 if (!get_shared_repository())
900 if (get_st_mode_bits(path
, &old_mode
) < 0)
903 new_mode
= calc_shared_perm(old_mode
);
904 if (S_ISDIR(old_mode
)) {
905 /* Copy read bits to execute bits */
906 new_mode
|= (new_mode
& 0444) >> 2;
909 * g+s matters only if any extra access is granted
910 * based on group membership.
912 if (FORCE_DIR_SET_GID
&& (new_mode
& 060))
913 new_mode
|= FORCE_DIR_SET_GID
;
916 if (((old_mode
^ new_mode
) & ~S_IFMT
) &&
917 chmod(path
, (new_mode
& ~S_IFMT
)) < 0)
922 void safe_create_dir(const char *dir
, int share
)
924 if (mkdir(dir
, 0777) < 0) {
925 if (errno
!= EEXIST
) {
930 else if (share
&& adjust_shared_perm(dir
))
931 die(_("Could not make %s writable by group"), dir
);
934 static int have_same_root(const char *path1
, const char *path2
)
936 int is_abs1
, is_abs2
;
938 is_abs1
= is_absolute_path(path1
);
939 is_abs2
= is_absolute_path(path2
);
940 return (is_abs1
&& is_abs2
&& tolower(path1
[0]) == tolower(path2
[0])) ||
941 (!is_abs1
&& !is_abs2
);
945 * Give path as relative to prefix.
947 * The strbuf may or may not be used, so do not assume it contains the
950 const char *relative_path(const char *in
, const char *prefix
,
953 int in_len
= in
? strlen(in
) : 0;
954 int prefix_len
= prefix
? strlen(prefix
) : 0;
961 else if (!prefix_len
)
964 if (have_same_root(in
, prefix
))
965 /* bypass dos_drive, for "c:" is identical to "C:" */
966 i
= j
= has_dos_drive_prefix(in
);
971 while (i
< prefix_len
&& j
< in_len
&& prefix
[i
] == in
[j
]) {
972 if (is_dir_sep(prefix
[i
])) {
973 while (is_dir_sep(prefix
[i
]))
975 while (is_dir_sep(in
[j
]))
986 /* "prefix" seems like prefix of "in" */
989 * but "/foo" is not a prefix of "/foobar"
990 * (i.e. prefix not end with '/')
992 prefix_off
< prefix_len
) {
994 /* in="/a/b", prefix="/a/b" */
996 } else if (is_dir_sep(in
[j
])) {
997 /* in="/a/b/c", prefix="/a/b" */
998 while (is_dir_sep(in
[j
]))
1002 /* in="/a/bbb/c", prefix="/a/b" */
1006 /* "in" is short than "prefix" */
1008 /* "in" not end with '/' */
1010 if (is_dir_sep(prefix
[i
])) {
1011 /* in="/a/b", prefix="/a/b/c/" */
1012 while (is_dir_sep(prefix
[i
]))
1020 if (i
>= prefix_len
) {
1028 strbuf_grow(sb
, in_len
);
1030 while (i
< prefix_len
) {
1031 if (is_dir_sep(prefix
[i
])) {
1032 strbuf_addstr(sb
, "../");
1033 while (is_dir_sep(prefix
[i
]))
1039 if (!is_dir_sep(prefix
[prefix_len
- 1]))
1040 strbuf_addstr(sb
, "../");
1042 strbuf_addstr(sb
, in
);
1048 * A simpler implementation of relative_path
1050 * Get relative path by removing "prefix" from "in". This function
1051 * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
1052 * to increase performance when traversing the path to work_tree.
1054 const char *remove_leading_path(const char *in
, const char *prefix
)
1056 static struct strbuf buf
= STRBUF_INIT
;
1059 if (!prefix
|| !prefix
[0])
1062 if (is_dir_sep(prefix
[i
])) {
1063 if (!is_dir_sep(in
[j
]))
1065 while (is_dir_sep(prefix
[i
]))
1067 while (is_dir_sep(in
[j
]))
1070 } else if (in
[j
] != prefix
[i
]) {
1077 /* "/foo" is a prefix of "/foo" */
1079 /* "/foo" is not a prefix of "/foobar" */
1080 !is_dir_sep(prefix
[i
-1]) && !is_dir_sep(in
[j
])
1083 while (is_dir_sep(in
[j
]))
1088 strbuf_addstr(&buf
, ".");
1090 strbuf_addstr(&buf
, in
+ j
);
1095 * It is okay if dst == src, but they should not overlap otherwise.
1096 * The "dst" buffer must be at least as long as "src"; normalizing may shrink
1097 * the size of the path, but will never grow it.
1099 * Performs the following normalizations on src, storing the result in dst:
1100 * - Ensures that components are separated by '/' (Windows only)
1101 * - Squashes sequences of '/' except "//server/share" on Windows
1102 * - Removes "." components.
1103 * - Removes ".." components, and the components the precede them.
1104 * Returns failure (non-zero) if a ".." component appears as first path
1105 * component anytime during the normalization. Otherwise, returns success (0).
1107 * Note that this function is purely textual. It does not follow symlinks,
1108 * verify the existence of the path, or make any system calls.
1110 * prefix_len != NULL is for a specific case of prefix_pathspec():
1111 * assume that src == dst and src[0..prefix_len-1] is already
1112 * normalized, any time "../" eats up to the prefix_len part,
1113 * prefix_len is reduced. In the end prefix_len is the remaining
1114 * prefix that has not been overridden by user pathspec.
1116 * NEEDSWORK: This function doesn't perform normalization w.r.t. trailing '/'.
1117 * For everything but the root folder itself, the normalized path should not
1118 * end with a '/', then the callers need to be fixed up accordingly.
1121 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
)
1127 * Copy initial part of absolute path: "/", "C:/", "//server/share/".
1129 end
= src
+ offset_1st_component(src
);
1138 while (is_dir_sep(*src
))
1145 * A path component that begins with . could be
1147 * (1) "." and ends -- ignore and terminate.
1148 * (2) "./" -- ignore them, eat slash and continue.
1149 * (3) ".." and ends -- strip one and terminate.
1150 * (4) "../" -- strip one, eat slash and continue.
1156 } else if (is_dir_sep(src
[1])) {
1159 while (is_dir_sep(*src
))
1162 } else if (src
[1] == '.') {
1167 } else if (is_dir_sep(src
[2])) {
1170 while (is_dir_sep(*src
))
1177 /* copy up to the next '/', and eat all '/' */
1178 while ((c
= *src
++) != '\0' && !is_dir_sep(c
))
1180 if (is_dir_sep(c
)) {
1182 while (is_dir_sep(c
))
1191 * dst0..dst is prefix portion, and dst[-1] is '/';
1194 dst
--; /* go to trailing '/' */
1197 /* Windows: dst[-1] cannot be backslash anymore */
1198 while (dst0
< dst
&& dst
[-1] != '/')
1200 if (prefix_len
&& *prefix_len
> dst
- dst0
)
1201 *prefix_len
= dst
- dst0
;
1207 int normalize_path_copy(char *dst
, const char *src
)
1209 return normalize_path_copy_len(dst
, src
, NULL
);
1213 * path = Canonical absolute path
1214 * prefixes = string_list containing normalized, absolute paths without
1215 * trailing slashes (except for the root directory, which is denoted by "/").
1217 * Determines, for each path in prefixes, whether the "prefix"
1218 * is an ancestor directory of path. Returns the length of the longest
1219 * ancestor directory, excluding any trailing slashes, or -1 if no prefix
1220 * is an ancestor. (Note that this means 0 is returned if prefixes is
1221 * ["/"].) "/foo" is not considered an ancestor of "/foobar". Directories
1222 * are not considered to be their own ancestors. path must be in a
1223 * canonical form: empty components, or "." or ".." components are not
1226 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
)
1228 int i
, max_len
= -1;
1230 if (!strcmp(path
, "/"))
1233 for (i
= 0; i
< prefixes
->nr
; i
++) {
1234 const char *ceil
= prefixes
->items
[i
].string
;
1235 int len
= strlen(ceil
);
1238 * For root directories (`/`, `C:/`, `//server/share/`)
1239 * adjust the length to exclude the trailing slash.
1241 if (len
> 0 && ceil
[len
- 1] == '/')
1244 if (strncmp(path
, ceil
, len
) ||
1245 path
[len
] != '/' || !path
[len
+ 1])
1246 continue; /* no match */
1255 /* strip arbitrary amount of directory separators at end of path */
1256 static inline int chomp_trailing_dir_sep(const char *path
, int len
)
1258 while (len
&& is_dir_sep(path
[len
- 1]))
1264 * If path ends with suffix (complete path components), returns the offset of
1265 * the last character in the path before the suffix (sans trailing directory
1266 * separators), and -1 otherwise.
1268 static ssize_t
stripped_path_suffix_offset(const char *path
, const char *suffix
)
1270 int path_len
= strlen(path
), suffix_len
= strlen(suffix
);
1272 while (suffix_len
) {
1276 if (is_dir_sep(path
[path_len
- 1])) {
1277 if (!is_dir_sep(suffix
[suffix_len
- 1]))
1279 path_len
= chomp_trailing_dir_sep(path
, path_len
);
1280 suffix_len
= chomp_trailing_dir_sep(suffix
, suffix_len
);
1282 else if (path
[--path_len
] != suffix
[--suffix_len
])
1286 if (path_len
&& !is_dir_sep(path
[path_len
- 1]))
1288 return chomp_trailing_dir_sep(path
, path_len
);
1292 * Returns true if the path ends with components, considering only complete path
1293 * components, and false otherwise.
1295 int ends_with_path_components(const char *path
, const char *components
)
1297 return stripped_path_suffix_offset(path
, components
) != -1;
1301 * If path ends with suffix (complete path components), returns the
1302 * part before suffix (sans trailing directory separators).
1303 * Otherwise returns NULL.
1305 char *strip_path_suffix(const char *path
, const char *suffix
)
1307 ssize_t offset
= stripped_path_suffix_offset(path
, suffix
);
1309 return offset
== -1 ? NULL
: xstrndup(path
, offset
);
1312 int daemon_avoid_alias(const char *p
)
1317 * This resurrects the belts and suspenders paranoia check by HPA
1318 * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
1319 * does not do getcwd() based path canonicalization.
1321 * sl becomes true immediately after seeing '/' and continues to
1322 * be true as long as dots continue after that without intervening
1323 * non-dot character.
1325 if (!p
|| (*p
!= '/' && *p
!= '~'))
1335 else if (ch
== '/') {
1337 /* reject //, /./ and /../ */
1342 if (0 < ndot
&& ndot
< 3)
1343 /* reject /.$ and /..$ */
1352 else if (ch
== '/') {
1360 * On NTFS, we need to be careful to disallow certain synonyms of the `.git/`
1363 * - For historical reasons, file names that end in spaces or periods are
1364 * automatically trimmed. Therefore, `.git . . ./` is a valid way to refer
1367 * - For other historical reasons, file names that do not conform to the 8.3
1368 * format (up to eight characters for the basename, three for the file
1369 * extension, certain characters not allowed such as `+`, etc) are associated
1370 * with a so-called "short name", at least on the `C:` drive by default.
1371 * Which means that `git~1/` is a valid way to refer to `.git/`.
1373 * Note: Technically, `.git/` could receive the short name `git~2` if the
1374 * short name `git~1` were already used. In Git, however, we guarantee that
1375 * `.git` is the first item in a directory, therefore it will be associated
1376 * with the short name `git~1` (unless short names are disabled).
1378 * - For yet other historical reasons, NTFS supports so-called "Alternate Data
1379 * Streams", i.e. metadata associated with a given file, referred to via
1380 * `<filename>:<stream-name>:<stream-type>`. There exists a default stream
1381 * type for directories, allowing `.git/` to be accessed via
1382 * `.git::$INDEX_ALLOCATION/`.
1384 * When this function returns 1, it indicates that the specified file/directory
1385 * name refers to a `.git` file or directory, or to any of these synonyms, and
1386 * Git should therefore not track it.
1388 * For performance reasons, _all_ Alternate Data Streams of `.git/` are
1389 * forbidden, not just `::$INDEX_ALLOCATION`.
1391 * This function is intended to be used by `git fsck` even on platforms where
1392 * the backslash is a regular filename character, therefore it needs to handle
1393 * backlash characters in the provided `name` specially: they are interpreted
1394 * as directory separators.
1396 int is_ntfs_dotgit(const char *name
)
1401 * Note that when we don't find `.git` or `git~1` we end up with `name`
1402 * advanced partway through the string. That's okay, though, as we
1403 * return immediately in those cases, without looking at `name` any
1409 if (((c
= *(name
++)) != 'g' && c
!= 'G') ||
1410 ((c
= *(name
++)) != 'i' && c
!= 'I') ||
1411 ((c
= *(name
++)) != 't' && c
!= 'T'))
1413 } else if (c
== 'g' || c
== 'G') {
1415 if (((c
= *(name
++)) != 'i' && c
!= 'I') ||
1416 ((c
= *(name
++)) != 't' && c
!= 'T') ||
1425 if (!c
|| is_xplatform_dir_sep(c
) || c
== ':')
1427 if (c
!= '.' && c
!= ' ')
1432 static int is_ntfs_dot_generic(const char *name
,
1433 const char *dotgit_name
,
1435 const char *dotgit_ntfs_shortname_prefix
)
1440 if ((name
[0] == '.' && !strncasecmp(name
+ 1, dotgit_name
, len
))) {
1442 only_spaces_and_periods
:
1447 if (c
!= ' ' && c
!= '.')
1453 * Is it a regular NTFS short name, i.e. shortened to 6 characters,
1454 * followed by ~1, ... ~4?
1456 if (!strncasecmp(name
, dotgit_name
, 6) && name
[6] == '~' &&
1457 name
[7] >= '1' && name
[7] <= '4') {
1459 goto only_spaces_and_periods
;
1463 * Is it a fall-back NTFS short name (for details, see
1464 * https://en.wikipedia.org/wiki/8.3_filename?
1466 for (i
= 0, saw_tilde
= 0; i
< 8; i
++)
1467 if (name
[i
] == '\0')
1469 else if (saw_tilde
) {
1470 if (name
[i
] < '0' || name
[i
] > '9')
1472 } else if (name
[i
] == '~') {
1473 if (name
[++i
] < '1' || name
[i
] > '9')
1478 else if (name
[i
] & 0x80) {
1480 * We know our needles contain only ASCII, so we clamp
1481 * here to make the results of tolower() sane.
1484 } else if (tolower(name
[i
]) != dotgit_ntfs_shortname_prefix
[i
])
1487 goto only_spaces_and_periods
;
1491 * Inline helper to make sure compiler resolves strlen() on literals at
1494 static inline int is_ntfs_dot_str(const char *name
, const char *dotgit_name
,
1495 const char *dotgit_ntfs_shortname_prefix
)
1497 return is_ntfs_dot_generic(name
, dotgit_name
, strlen(dotgit_name
),
1498 dotgit_ntfs_shortname_prefix
);
1501 int is_ntfs_dotgitmodules(const char *name
)
1503 return is_ntfs_dot_str(name
, "gitmodules", "gi7eba");
1506 int is_ntfs_dotgitignore(const char *name
)
1508 return is_ntfs_dot_str(name
, "gitignore", "gi250a");
1511 int is_ntfs_dotgitattributes(const char *name
)
1513 return is_ntfs_dot_str(name
, "gitattributes", "gi7d29");
1516 int is_ntfs_dotmailmap(const char *name
)
1518 return is_ntfs_dot_str(name
, "mailmap", "maba30");
1521 int looks_like_command_line_option(const char *str
)
1523 return str
&& str
[0] == '-';
1526 char *xdg_config_home_for(const char *subdir
, const char *filename
)
1528 const char *home
, *config_home
;
1532 config_home
= getenv("XDG_CONFIG_HOME");
1533 if (config_home
&& *config_home
)
1534 return mkpathdup("%s/%s/%s", config_home
, subdir
, filename
);
1536 home
= getenv("HOME");
1538 return mkpathdup("%s/.config/%s/%s", home
, subdir
, filename
);
1543 char *xdg_config_home(const char *filename
)
1545 return xdg_config_home_for("git", filename
);
1548 char *xdg_cache_home(const char *filename
)
1550 const char *home
, *cache_home
;
1553 cache_home
= getenv("XDG_CACHE_HOME");
1554 if (cache_home
&& *cache_home
)
1555 return mkpathdup("%s/git/%s", cache_home
, filename
);
1557 home
= getenv("HOME");
1559 return mkpathdup("%s/.cache/git/%s", home
, filename
);
1563 REPO_GIT_PATH_FUNC(squash_msg
, "SQUASH_MSG")
1564 REPO_GIT_PATH_FUNC(merge_msg
, "MERGE_MSG")
1565 REPO_GIT_PATH_FUNC(merge_rr
, "MERGE_RR")
1566 REPO_GIT_PATH_FUNC(merge_mode
, "MERGE_MODE")
1567 REPO_GIT_PATH_FUNC(merge_head
, "MERGE_HEAD")
1568 REPO_GIT_PATH_FUNC(merge_autostash
, "MERGE_AUTOSTASH")
1569 REPO_GIT_PATH_FUNC(auto_merge
, "AUTO_MERGE")
1570 REPO_GIT_PATH_FUNC(fetch_head
, "FETCH_HEAD")
1571 REPO_GIT_PATH_FUNC(shallow
, "shallow")