2 * Utilities for paths and pathnames
6 #include "string-list.h"
9 #include "submodule-config.h"
11 static int get_st_mode_bits(const char *path
, int *mode
)
14 if (lstat(path
, &st
) < 0)
20 static char bad_path
[] = "/bad-path/";
22 static struct strbuf
*get_pathname(void)
24 static struct strbuf pathname_array
[4] = {
25 STRBUF_INIT
, STRBUF_INIT
, STRBUF_INIT
, STRBUF_INIT
28 struct strbuf
*sb
= &pathname_array
[index
];
29 index
= (index
+ 1) % ARRAY_SIZE(pathname_array
);
34 static char *cleanup_path(char *path
)
37 if (!memcmp(path
, "./", 2)) {
45 static void strbuf_cleanup_path(struct strbuf
*sb
)
47 char *path
= cleanup_path(sb
->buf
);
49 strbuf_remove(sb
, 0, path
- sb
->buf
);
52 char *mksnpath(char *buf
, size_t n
, const char *fmt
, ...)
58 len
= vsnprintf(buf
, n
, fmt
, args
);
61 strlcpy(buf
, bad_path
, n
);
64 return cleanup_path(buf
);
67 static int dir_prefix(const char *buf
, const char *dir
)
69 int len
= strlen(dir
);
70 return !strncmp(buf
, dir
, len
) &&
71 (is_dir_sep(buf
[len
]) || buf
[len
] == '\0');
74 /* $buf =~ m|$dir/+$file| but without regex */
75 static int is_dir_file(const char *buf
, const char *dir
, const char *file
)
77 int len
= strlen(dir
);
78 if (strncmp(buf
, dir
, len
) || !is_dir_sep(buf
[len
]))
80 while (is_dir_sep(buf
[len
]))
82 return !strcmp(buf
+ len
, file
);
85 static void replace_dir(struct strbuf
*buf
, int len
, const char *newdir
)
87 int newlen
= strlen(newdir
);
88 int need_sep
= (buf
->buf
[len
] && !is_dir_sep(buf
->buf
[len
])) &&
89 !is_dir_sep(newdir
[newlen
- 1]);
91 len
--; /* keep one char, to be replaced with '/' */
92 strbuf_splice(buf
, 0, len
, newdir
, newlen
);
94 buf
->buf
[newlen
] = '/';
98 /* Not considered garbage for report_linked_checkout_garbage */
99 unsigned ignore_garbage
:1;
101 /* Not common even though its parent is */
106 static struct common_dir common_list
[] = {
107 { 0, 1, 0, "branches" },
108 { 0, 1, 0, "hooks" },
110 { 0, 0, 1, "info/sparse-checkout" },
112 { 1, 1, 1, "logs/HEAD" },
113 { 0, 1, 1, "logs/refs/bisect" },
114 { 0, 1, 0, "lost-found" },
115 { 0, 1, 0, "objects" },
117 { 0, 1, 1, "refs/bisect" },
118 { 0, 1, 0, "remotes" },
119 { 0, 1, 0, "worktrees" },
120 { 0, 1, 0, "rr-cache" },
122 { 0, 0, 0, "config" },
123 { 1, 0, 0, "gc.pid" },
124 { 0, 0, 0, "packed-refs" },
125 { 0, 0, 0, "shallow" },
130 * A compressed trie. A trie node consists of zero or more characters that
131 * are common to all elements with this prefix, optionally followed by some
132 * children. If value is not NULL, the trie node is a terminal node.
134 * For example, consider the following set of strings:
140 * The trie would look like:
141 * root: len = 0, children a and d non-NULL, value = NULL.
142 * a: len = 2, contents = bc, value = (data for "abc")
143 * d: len = 2, contents = ef, children i non-NULL, value = (data for "def")
144 * i: len = 3, contents = nit, children e and i non-NULL, value = NULL
145 * e: len = 0, children all NULL, value = (data for "definite")
146 * i: len = 2, contents = on, children all NULL,
147 * value = (data for "definition")
150 struct trie
*children
[256];
156 static struct trie
*make_trie_node(const char *key
, void *value
)
158 struct trie
*new_node
= xcalloc(1, sizeof(*new_node
));
159 new_node
->len
= strlen(key
);
161 new_node
->contents
= xmalloc(new_node
->len
);
162 memcpy(new_node
->contents
, key
, new_node
->len
);
164 new_node
->value
= value
;
169 * Add a key/value pair to a trie. The key is assumed to be \0-terminated.
170 * If there was an existing value for this key, return it.
172 static void *add_to_trie(struct trie
*root
, const char *key
, void *value
)
179 /* we have reached the end of the key */
185 for (i
= 0; i
< root
->len
; i
++) {
186 if (root
->contents
[i
] == key
[i
])
190 * Split this node: child will contain this node's
193 child
= malloc(sizeof(*child
));
194 memcpy(child
->children
, root
->children
, sizeof(root
->children
));
196 child
->len
= root
->len
- i
- 1;
198 child
->contents
= xstrndup(root
->contents
+ i
+ 1,
201 child
->value
= root
->value
;
205 memset(root
->children
, 0, sizeof(root
->children
));
206 root
->children
[(unsigned char)root
->contents
[i
]] = child
;
208 /* This is the newly-added child. */
209 root
->children
[(unsigned char)key
[i
]] =
210 make_trie_node(key
+ i
+ 1, value
);
214 /* We have matched the entire compressed section */
216 child
= root
->children
[(unsigned char)key
[root
->len
]];
218 return add_to_trie(child
, key
+ root
->len
+ 1, value
);
220 child
= make_trie_node(key
+ root
->len
+ 1, value
);
221 root
->children
[(unsigned char)key
[root
->len
]] = child
;
231 typedef int (*match_fn
)(const char *unmatched
, void *data
, void *baton
);
234 * Search a trie for some key. Find the longest /-or-\0-terminated
235 * prefix of the key for which the trie contains a value. Call fn
236 * with the unmatched portion of the key and the found value, and
237 * return its return value. If there is no such prefix, return -1.
239 * The key is partially normalized: consecutive slashes are skipped.
241 * For example, consider the trie containing only [refs,
242 * refs/worktree] (both with values).
244 * | key | unmatched | val from node | return value |
245 * |-----------------|------------|---------------|--------------|
246 * | a | not called | n/a | -1 |
247 * | refs | \0 | refs | as per fn |
248 * | refs/ | / | refs | as per fn |
249 * | refs/w | /w | refs | as per fn |
250 * | refs/worktree | \0 | refs/worktree | as per fn |
251 * | refs/worktree/ | / | refs/worktree | as per fn |
252 * | refs/worktree/a | /a | refs/worktree | as per fn |
253 * |-----------------|------------|---------------|--------------|
256 static int trie_find(struct trie
*root
, const char *key
, match_fn fn
,
264 /* we have reached the end of the key */
265 if (root
->value
&& !root
->len
)
266 return fn(key
, root
->value
, baton
);
271 for (i
= 0; i
< root
->len
; i
++) {
272 /* Partial path normalization: skip consecutive slashes. */
273 if (key
[i
] == '/' && key
[i
+1] == '/') {
277 if (root
->contents
[i
] != key
[i
])
281 /* Matched the entire compressed section */
285 return fn(key
, root
->value
, baton
);
287 /* Partial path normalization: skip consecutive slashes */
288 while (key
[0] == '/' && key
[1] == '/')
291 child
= root
->children
[(unsigned char)*key
];
293 result
= trie_find(child
, key
+ 1, fn
, baton
);
297 if (result
>= 0 || (*key
!= '/' && *key
!= 0))
300 return fn(key
, root
->value
, baton
);
305 static struct trie common_trie
;
306 static int common_trie_done_setup
;
308 static void init_common_trie(void)
310 struct common_dir
*p
;
312 if (common_trie_done_setup
)
315 for (p
= common_list
; p
->dirname
; p
++)
316 add_to_trie(&common_trie
, p
->dirname
, p
);
318 common_trie_done_setup
= 1;
322 * Helper function for update_common_dir: returns 1 if the dir
325 static int check_common(const char *unmatched
, void *value
, void *baton
)
327 struct common_dir
*dir
= value
;
332 if (dir
->is_dir
&& (unmatched
[0] == 0 || unmatched
[0] == '/'))
333 return !dir
->exclude
;
335 if (!dir
->is_dir
&& unmatched
[0] == 0)
336 return !dir
->exclude
;
341 static void update_common_dir(struct strbuf
*buf
, int git_dir_len
,
342 const char *common_dir
)
344 char *base
= buf
->buf
+ git_dir_len
;
347 common_dir
= get_git_common_dir();
348 if (trie_find(&common_trie
, base
, check_common
, NULL
) > 0)
349 replace_dir(buf
, git_dir_len
, common_dir
);
352 void report_linked_checkout_garbage(void)
354 struct strbuf sb
= STRBUF_INIT
;
355 const struct common_dir
*p
;
358 if (!git_common_dir_env
)
360 strbuf_addf(&sb
, "%s/", get_git_dir());
362 for (p
= common_list
; p
->dirname
; p
++) {
363 const char *path
= p
->dirname
;
364 if (p
->ignore_garbage
)
366 strbuf_setlen(&sb
, len
);
367 strbuf_addstr(&sb
, path
);
368 if (file_exists(sb
.buf
))
369 report_garbage(PACKDIR_FILE_GARBAGE
, sb
.buf
);
374 static void adjust_git_path(struct strbuf
*buf
, int git_dir_len
)
376 const char *base
= buf
->buf
+ git_dir_len
;
377 if (git_graft_env
&& is_dir_file(base
, "info", "grafts"))
378 strbuf_splice(buf
, 0, buf
->len
,
379 get_graft_file(), strlen(get_graft_file()));
380 else if (git_index_env
&& !strcmp(base
, "index"))
381 strbuf_splice(buf
, 0, buf
->len
,
382 get_index_file(), strlen(get_index_file()));
383 else if (git_db_env
&& dir_prefix(base
, "objects"))
384 replace_dir(buf
, git_dir_len
+ 7, get_object_directory());
385 else if (git_hooks_path
&& dir_prefix(base
, "hooks"))
386 replace_dir(buf
, git_dir_len
+ 5, git_hooks_path
);
387 else if (git_common_dir_env
)
388 update_common_dir(buf
, git_dir_len
, NULL
);
391 static void do_git_path(const struct worktree
*wt
, struct strbuf
*buf
,
392 const char *fmt
, va_list args
)
395 strbuf_addstr(buf
, get_worktree_git_dir(wt
));
396 if (buf
->len
&& !is_dir_sep(buf
->buf
[buf
->len
- 1]))
397 strbuf_addch(buf
, '/');
398 gitdir_len
= buf
->len
;
399 strbuf_vaddf(buf
, fmt
, args
);
400 adjust_git_path(buf
, gitdir_len
);
401 strbuf_cleanup_path(buf
);
404 char *git_path_buf(struct strbuf
*buf
, const char *fmt
, ...)
409 do_git_path(NULL
, buf
, fmt
, args
);
414 void strbuf_git_path(struct strbuf
*sb
, const char *fmt
, ...)
418 do_git_path(NULL
, sb
, fmt
, args
);
422 const char *git_path(const char *fmt
, ...)
424 struct strbuf
*pathname
= get_pathname();
427 do_git_path(NULL
, pathname
, fmt
, args
);
429 return pathname
->buf
;
432 char *git_pathdup(const char *fmt
, ...)
434 struct strbuf path
= STRBUF_INIT
;
437 do_git_path(NULL
, &path
, fmt
, args
);
439 return strbuf_detach(&path
, NULL
);
442 char *mkpathdup(const char *fmt
, ...)
444 struct strbuf sb
= STRBUF_INIT
;
447 strbuf_vaddf(&sb
, fmt
, args
);
449 strbuf_cleanup_path(&sb
);
450 return strbuf_detach(&sb
, NULL
);
453 const char *mkpath(const char *fmt
, ...)
456 struct strbuf
*pathname
= get_pathname();
458 strbuf_vaddf(pathname
, fmt
, args
);
460 return cleanup_path(pathname
->buf
);
463 const char *worktree_git_path(const struct worktree
*wt
, const char *fmt
, ...)
465 struct strbuf
*pathname
= get_pathname();
468 do_git_path(wt
, pathname
, fmt
, args
);
470 return pathname
->buf
;
473 /* Returns 0 on success, negative on failure. */
474 #define SUBMODULE_PATH_ERR_NOT_CONFIGURED -1
475 static int do_submodule_path(struct strbuf
*buf
, const char *path
,
476 const char *fmt
, va_list args
)
479 struct strbuf git_submodule_common_dir
= STRBUF_INIT
;
480 struct strbuf git_submodule_dir
= STRBUF_INIT
;
481 const struct submodule
*sub
;
484 strbuf_addstr(buf
, path
);
485 strbuf_complete(buf
, '/');
486 strbuf_addstr(buf
, ".git");
488 git_dir
= read_gitfile(buf
->buf
);
491 strbuf_addstr(buf
, git_dir
);
493 if (!is_git_directory(buf
->buf
)) {
495 sub
= submodule_from_path(null_sha1
, path
);
497 err
= SUBMODULE_PATH_ERR_NOT_CONFIGURED
;
501 strbuf_git_path(buf
, "%s/%s", "modules", sub
->name
);
504 strbuf_addch(buf
, '/');
505 strbuf_addbuf(&git_submodule_dir
, buf
);
507 strbuf_vaddf(buf
, fmt
, args
);
509 if (get_common_dir_noenv(&git_submodule_common_dir
, git_submodule_dir
.buf
))
510 update_common_dir(buf
, git_submodule_dir
.len
, git_submodule_common_dir
.buf
);
512 strbuf_cleanup_path(buf
);
515 strbuf_release(&git_submodule_dir
);
516 strbuf_release(&git_submodule_common_dir
);
521 char *git_pathdup_submodule(const char *path
, const char *fmt
, ...)
525 struct strbuf buf
= STRBUF_INIT
;
527 err
= do_submodule_path(&buf
, path
, fmt
, args
);
530 strbuf_release(&buf
);
533 return strbuf_detach(&buf
, NULL
);
536 int strbuf_git_path_submodule(struct strbuf
*buf
, const char *path
,
537 const char *fmt
, ...)
542 err
= do_submodule_path(buf
, path
, fmt
, args
);
548 static void do_git_common_path(struct strbuf
*buf
,
552 strbuf_addstr(buf
, get_git_common_dir());
553 if (buf
->len
&& !is_dir_sep(buf
->buf
[buf
->len
- 1]))
554 strbuf_addch(buf
, '/');
555 strbuf_vaddf(buf
, fmt
, args
);
556 strbuf_cleanup_path(buf
);
559 const char *git_common_path(const char *fmt
, ...)
561 struct strbuf
*pathname
= get_pathname();
564 do_git_common_path(pathname
, fmt
, args
);
566 return pathname
->buf
;
569 void strbuf_git_common_path(struct strbuf
*sb
, const char *fmt
, ...)
573 do_git_common_path(sb
, fmt
, args
);
577 int validate_headref(const char *path
)
580 char *buf
, buffer
[256];
581 unsigned char sha1
[20];
585 if (lstat(path
, &st
) < 0)
588 /* Make sure it is a "refs/.." symlink */
589 if (S_ISLNK(st
.st_mode
)) {
590 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
591 if (len
>= 5 && !memcmp("refs/", buffer
, 5))
597 * Anything else, just open it and try to see if it is a symbolic ref.
599 fd
= open(path
, O_RDONLY
);
602 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
606 * Is it a symbolic ref?
610 if (!memcmp("ref:", buffer
, 4)) {
613 while (len
&& isspace(*buf
))
615 if (len
>= 5 && !memcmp("refs/", buf
, 5))
620 * Is this a detached HEAD?
622 if (!get_sha1_hex(buffer
, sha1
))
628 static struct passwd
*getpw_str(const char *username
, size_t len
)
631 char *username_z
= xmemdupz(username
, len
);
632 pw
= getpwnam(username_z
);
638 * Return a string with ~ and ~user expanded via getpw*. If buf != NULL,
639 * then it is a newly allocated string. Returns NULL on getpw failure or
642 * If real_home is true, real_path($HOME) is used in the expansion.
644 char *expand_user_path(const char *path
, int real_home
)
646 struct strbuf user_path
= STRBUF_INIT
;
647 const char *to_copy
= path
;
651 if (path
[0] == '~') {
652 const char *first_slash
= strchrnul(path
, '/');
653 const char *username
= path
+ 1;
654 size_t username_len
= first_slash
- username
;
655 if (username_len
== 0) {
656 const char *home
= getenv("HOME");
660 strbuf_addstr(&user_path
, real_path(home
));
662 strbuf_addstr(&user_path
, home
);
663 #ifdef GIT_WINDOWS_NATIVE
664 convert_slashes(user_path
.buf
);
667 struct passwd
*pw
= getpw_str(username
, username_len
);
670 strbuf_addstr(&user_path
, pw
->pw_dir
);
672 to_copy
= first_slash
;
674 strbuf_addstr(&user_path
, to_copy
);
675 return strbuf_detach(&user_path
, NULL
);
677 strbuf_release(&user_path
);
682 * First, one directory to try is determined by the following algorithm.
684 * (0) If "strict" is given, the path is used as given and no DWIM is
686 * (1) "~/path" to mean path under the running user's home directory;
687 * (2) "~user/path" to mean path under named user's home directory;
688 * (3) "relative/path" to mean cwd relative directory; or
689 * (4) "/absolute/path" to mean absolute directory.
691 * Unless "strict" is given, we check "%s/.git", "%s", "%s.git/.git", "%s.git"
692 * in this order. We select the first one that is a valid git repository, and
693 * chdir() to it. If none match, or we fail to chdir, we return NULL.
695 * If all goes well, we return the directory we used to chdir() (but
696 * before ~user is expanded), avoiding getcwd() resolving symbolic
697 * links. User relative paths are also returned as they are given,
698 * except DWIM suffixing.
700 const char *enter_repo(const char *path
, int strict
)
702 static struct strbuf validated_path
= STRBUF_INIT
;
703 static struct strbuf used_path
= STRBUF_INIT
;
709 static const char *suffix
[] = {
710 "/.git", "", ".git/.git", ".git", NULL
,
713 int len
= strlen(path
);
715 while ((1 < len
) && (path
[len
-1] == '/'))
719 * We can handle arbitrary-sized buffers, but this remains as a
720 * sanity check on untrusted input.
725 strbuf_reset(&used_path
);
726 strbuf_reset(&validated_path
);
727 strbuf_add(&used_path
, path
, len
);
728 strbuf_add(&validated_path
, path
, len
);
730 if (used_path
.buf
[0] == '~') {
731 char *newpath
= expand_user_path(used_path
.buf
, 0);
734 strbuf_attach(&used_path
, newpath
, strlen(newpath
),
737 for (i
= 0; suffix
[i
]; i
++) {
739 size_t baselen
= used_path
.len
;
740 strbuf_addstr(&used_path
, suffix
[i
]);
741 if (!stat(used_path
.buf
, &st
) &&
742 (S_ISREG(st
.st_mode
) ||
743 (S_ISDIR(st
.st_mode
) && is_git_directory(used_path
.buf
)))) {
744 strbuf_addstr(&validated_path
, suffix
[i
]);
747 strbuf_setlen(&used_path
, baselen
);
751 gitfile
= read_gitfile(used_path
.buf
);
753 strbuf_reset(&used_path
);
754 strbuf_addstr(&used_path
, gitfile
);
756 if (chdir(used_path
.buf
))
758 path
= validated_path
.buf
;
761 const char *gitfile
= read_gitfile(path
);
768 if (is_git_directory(".")) {
770 check_repository_format();
777 static int calc_shared_perm(int mode
)
781 if (get_shared_repository() < 0)
782 tweak
= -get_shared_repository();
784 tweak
= get_shared_repository();
786 if (!(mode
& S_IWUSR
))
789 /* Copy read bits to execute bits */
790 tweak
|= (tweak
& 0444) >> 2;
791 if (get_shared_repository() < 0)
792 mode
= (mode
& ~0777) | tweak
;
800 int adjust_shared_perm(const char *path
)
802 int old_mode
, new_mode
;
804 if (!get_shared_repository())
806 if (get_st_mode_bits(path
, &old_mode
) < 0)
809 new_mode
= calc_shared_perm(old_mode
);
810 if (S_ISDIR(old_mode
)) {
811 /* Copy read bits to execute bits */
812 new_mode
|= (new_mode
& 0444) >> 2;
813 new_mode
|= FORCE_DIR_SET_GID
;
816 if (((old_mode
^ new_mode
) & ~S_IFMT
) &&
817 chmod(path
, (new_mode
& ~S_IFMT
)) < 0)
822 void safe_create_dir(const char *dir
, int share
)
824 if (mkdir(dir
, 0777) < 0) {
825 if (errno
!= EEXIST
) {
830 else if (share
&& adjust_shared_perm(dir
))
831 die(_("Could not make %s writable by group"), dir
);
834 static int have_same_root(const char *path1
, const char *path2
)
836 int is_abs1
, is_abs2
;
838 is_abs1
= is_absolute_path(path1
);
839 is_abs2
= is_absolute_path(path2
);
840 return (is_abs1
&& is_abs2
&& tolower(path1
[0]) == tolower(path2
[0])) ||
841 (!is_abs1
&& !is_abs2
);
845 * Give path as relative to prefix.
847 * The strbuf may or may not be used, so do not assume it contains the
850 const char *relative_path(const char *in
, const char *prefix
,
853 int in_len
= in
? strlen(in
) : 0;
854 int prefix_len
= prefix
? strlen(prefix
) : 0;
861 else if (!prefix_len
)
864 if (have_same_root(in
, prefix
))
865 /* bypass dos_drive, for "c:" is identical to "C:" */
866 i
= j
= has_dos_drive_prefix(in
);
871 while (i
< prefix_len
&& j
< in_len
&& prefix
[i
] == in
[j
]) {
872 if (is_dir_sep(prefix
[i
])) {
873 while (is_dir_sep(prefix
[i
]))
875 while (is_dir_sep(in
[j
]))
886 /* "prefix" seems like prefix of "in" */
889 * but "/foo" is not a prefix of "/foobar"
890 * (i.e. prefix not end with '/')
892 prefix_off
< prefix_len
) {
894 /* in="/a/b", prefix="/a/b" */
896 } else if (is_dir_sep(in
[j
])) {
897 /* in="/a/b/c", prefix="/a/b" */
898 while (is_dir_sep(in
[j
]))
902 /* in="/a/bbb/c", prefix="/a/b" */
906 /* "in" is short than "prefix" */
908 /* "in" not end with '/' */
910 if (is_dir_sep(prefix
[i
])) {
911 /* in="/a/b", prefix="/a/b/c/" */
912 while (is_dir_sep(prefix
[i
]))
920 if (i
>= prefix_len
) {
928 strbuf_grow(sb
, in_len
);
930 while (i
< prefix_len
) {
931 if (is_dir_sep(prefix
[i
])) {
932 strbuf_addstr(sb
, "../");
933 while (is_dir_sep(prefix
[i
]))
939 if (!is_dir_sep(prefix
[prefix_len
- 1]))
940 strbuf_addstr(sb
, "../");
942 strbuf_addstr(sb
, in
);
948 * A simpler implementation of relative_path
950 * Get relative path by removing "prefix" from "in". This function
951 * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
952 * to increase performance when traversing the path to work_tree.
954 const char *remove_leading_path(const char *in
, const char *prefix
)
956 static struct strbuf buf
= STRBUF_INIT
;
959 if (!prefix
|| !prefix
[0])
962 if (is_dir_sep(prefix
[i
])) {
963 if (!is_dir_sep(in
[j
]))
965 while (is_dir_sep(prefix
[i
]))
967 while (is_dir_sep(in
[j
]))
970 } else if (in
[j
] != prefix
[i
]) {
977 /* "/foo" is a prefix of "/foo" */
979 /* "/foo" is not a prefix of "/foobar" */
980 !is_dir_sep(prefix
[i
-1]) && !is_dir_sep(in
[j
])
983 while (is_dir_sep(in
[j
]))
988 strbuf_addstr(&buf
, ".");
990 strbuf_addstr(&buf
, in
+ j
);
995 * It is okay if dst == src, but they should not overlap otherwise.
997 * Performs the following normalizations on src, storing the result in dst:
998 * - Ensures that components are separated by '/' (Windows only)
999 * - Squashes sequences of '/' except "//server/share" on Windows
1000 * - Removes "." components.
1001 * - Removes ".." components, and the components the precede them.
1002 * Returns failure (non-zero) if a ".." component appears as first path
1003 * component anytime during the normalization. Otherwise, returns success (0).
1005 * Note that this function is purely textual. It does not follow symlinks,
1006 * verify the existence of the path, or make any system calls.
1008 * prefix_len != NULL is for a specific case of prefix_pathspec():
1009 * assume that src == dst and src[0..prefix_len-1] is already
1010 * normalized, any time "../" eats up to the prefix_len part,
1011 * prefix_len is reduced. In the end prefix_len is the remaining
1012 * prefix that has not been overridden by user pathspec.
1014 * NEEDSWORK: This function doesn't perform normalization w.r.t. trailing '/'.
1015 * For everything but the root folder itself, the normalized path should not
1016 * end with a '/', then the callers need to be fixed up accordingly.
1019 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
)
1025 * Copy initial part of absolute path: "/", "C:/", "//server/share/".
1027 end
= src
+ offset_1st_component(src
);
1036 while (is_dir_sep(*src
))
1043 * A path component that begins with . could be
1045 * (1) "." and ends -- ignore and terminate.
1046 * (2) "./" -- ignore them, eat slash and continue.
1047 * (3) ".." and ends -- strip one and terminate.
1048 * (4) "../" -- strip one, eat slash and continue.
1054 } else if (is_dir_sep(src
[1])) {
1057 while (is_dir_sep(*src
))
1060 } else if (src
[1] == '.') {
1065 } else if (is_dir_sep(src
[2])) {
1068 while (is_dir_sep(*src
))
1075 /* copy up to the next '/', and eat all '/' */
1076 while ((c
= *src
++) != '\0' && !is_dir_sep(c
))
1078 if (is_dir_sep(c
)) {
1080 while (is_dir_sep(c
))
1089 * dst0..dst is prefix portion, and dst[-1] is '/';
1092 dst
--; /* go to trailing '/' */
1095 /* Windows: dst[-1] cannot be backslash anymore */
1096 while (dst0
< dst
&& dst
[-1] != '/')
1098 if (prefix_len
&& *prefix_len
> dst
- dst0
)
1099 *prefix_len
= dst
- dst0
;
1105 int normalize_path_copy(char *dst
, const char *src
)
1107 return normalize_path_copy_len(dst
, src
, NULL
);
1111 * path = Canonical absolute path
1112 * prefixes = string_list containing normalized, absolute paths without
1113 * trailing slashes (except for the root directory, which is denoted by "/").
1115 * Determines, for each path in prefixes, whether the "prefix"
1116 * is an ancestor directory of path. Returns the length of the longest
1117 * ancestor directory, excluding any trailing slashes, or -1 if no prefix
1118 * is an ancestor. (Note that this means 0 is returned if prefixes is
1119 * ["/"].) "/foo" is not considered an ancestor of "/foobar". Directories
1120 * are not considered to be their own ancestors. path must be in a
1121 * canonical form: empty components, or "." or ".." components are not
1124 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
)
1126 int i
, max_len
= -1;
1128 if (!strcmp(path
, "/"))
1131 for (i
= 0; i
< prefixes
->nr
; i
++) {
1132 const char *ceil
= prefixes
->items
[i
].string
;
1133 int len
= strlen(ceil
);
1135 if (len
== 1 && ceil
[0] == '/')
1136 len
= 0; /* root matches anything, with length 0 */
1137 else if (!strncmp(path
, ceil
, len
) && path
[len
] == '/')
1138 ; /* match of length len */
1140 continue; /* no match */
1149 /* strip arbitrary amount of directory separators at end of path */
1150 static inline int chomp_trailing_dir_sep(const char *path
, int len
)
1152 while (len
&& is_dir_sep(path
[len
- 1]))
1158 * If path ends with suffix (complete path components), returns the
1159 * part before suffix (sans trailing directory separators).
1160 * Otherwise returns NULL.
1162 char *strip_path_suffix(const char *path
, const char *suffix
)
1164 int path_len
= strlen(path
), suffix_len
= strlen(suffix
);
1166 while (suffix_len
) {
1170 if (is_dir_sep(path
[path_len
- 1])) {
1171 if (!is_dir_sep(suffix
[suffix_len
- 1]))
1173 path_len
= chomp_trailing_dir_sep(path
, path_len
);
1174 suffix_len
= chomp_trailing_dir_sep(suffix
, suffix_len
);
1176 else if (path
[--path_len
] != suffix
[--suffix_len
])
1180 if (path_len
&& !is_dir_sep(path
[path_len
- 1]))
1182 return xstrndup(path
, chomp_trailing_dir_sep(path
, path_len
));
1185 int daemon_avoid_alias(const char *p
)
1190 * This resurrects the belts and suspenders paranoia check by HPA
1191 * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
1192 * does not do getcwd() based path canonicalization.
1194 * sl becomes true immediately after seeing '/' and continues to
1195 * be true as long as dots continue after that without intervening
1196 * non-dot character.
1198 if (!p
|| (*p
!= '/' && *p
!= '~'))
1208 else if (ch
== '/') {
1210 /* reject //, /./ and /../ */
1215 if (0 < ndot
&& ndot
< 3)
1216 /* reject /.$ and /..$ */
1225 else if (ch
== '/') {
1232 static int only_spaces_and_periods(const char *path
, size_t len
, size_t skip
)
1240 if (c
!= ' ' && c
!= '.')
1246 int is_ntfs_dotgit(const char *name
)
1250 for (len
= 0; ; len
++)
1251 if (!name
[len
] || name
[len
] == '\\' || is_dir_sep(name
[len
])) {
1252 if (only_spaces_and_periods(name
, len
, 4) &&
1253 !strncasecmp(name
, ".git", 4))
1255 if (only_spaces_and_periods(name
, len
, 5) &&
1256 !strncasecmp(name
, "git~1", 5))
1258 if (name
[len
] != '\\')
1265 char *xdg_config_home(const char *filename
)
1267 const char *home
, *config_home
;
1270 config_home
= getenv("XDG_CONFIG_HOME");
1271 if (config_home
&& *config_home
)
1272 return mkpathdup("%s/git/%s", config_home
, filename
);
1274 home
= getenv("HOME");
1276 return mkpathdup("%s/.config/git/%s", home
, filename
);
1280 GIT_PATH_FUNC(git_path_cherry_pick_head
, "CHERRY_PICK_HEAD")
1281 GIT_PATH_FUNC(git_path_revert_head
, "REVERT_HEAD")
1282 GIT_PATH_FUNC(git_path_squash_msg
, "SQUASH_MSG")
1283 GIT_PATH_FUNC(git_path_merge_msg
, "MERGE_MSG")
1284 GIT_PATH_FUNC(git_path_merge_rr
, "MERGE_RR")
1285 GIT_PATH_FUNC(git_path_merge_mode
, "MERGE_MODE")
1286 GIT_PATH_FUNC(git_path_merge_head
, "MERGE_HEAD")
1287 GIT_PATH_FUNC(git_path_fetch_head
, "FETCH_HEAD")
1288 GIT_PATH_FUNC(git_path_shallow
, "shallow")