2 * Utilities for paths and pathnames
6 #include "string-list.h"
9 static int get_st_mode_bits(const char *path
, int *mode
)
12 if (lstat(path
, &st
) < 0)
18 static char bad_path
[] = "/bad-path/";
20 static struct strbuf
*get_pathname(void)
22 static struct strbuf pathname_array
[4] = {
23 STRBUF_INIT
, STRBUF_INIT
, STRBUF_INIT
, STRBUF_INIT
26 struct strbuf
*sb
= &pathname_array
[3 & ++index
];
31 static char *cleanup_path(char *path
)
34 if (!memcmp(path
, "./", 2)) {
42 static void strbuf_cleanup_path(struct strbuf
*sb
)
44 char *path
= cleanup_path(sb
->buf
);
46 strbuf_remove(sb
, 0, path
- sb
->buf
);
49 char *mksnpath(char *buf
, size_t n
, const char *fmt
, ...)
55 len
= vsnprintf(buf
, n
, fmt
, args
);
58 strlcpy(buf
, bad_path
, n
);
61 return cleanup_path(buf
);
64 static int dir_prefix(const char *buf
, const char *dir
)
66 int len
= strlen(dir
);
67 return !strncmp(buf
, dir
, len
) &&
68 (is_dir_sep(buf
[len
]) || buf
[len
] == '\0');
71 /* $buf =~ m|$dir/+$file| but without regex */
72 static int is_dir_file(const char *buf
, const char *dir
, const char *file
)
74 int len
= strlen(dir
);
75 if (strncmp(buf
, dir
, len
) || !is_dir_sep(buf
[len
]))
77 while (is_dir_sep(buf
[len
]))
79 return !strcmp(buf
+ len
, file
);
82 static void replace_dir(struct strbuf
*buf
, int len
, const char *newdir
)
84 int newlen
= strlen(newdir
);
85 int need_sep
= (buf
->buf
[len
] && !is_dir_sep(buf
->buf
[len
])) &&
86 !is_dir_sep(newdir
[newlen
- 1]);
88 len
--; /* keep one char, to be replaced with '/' */
89 strbuf_splice(buf
, 0, len
, newdir
, newlen
);
91 buf
->buf
[newlen
] = '/';
94 static const char *common_list
[] = {
95 "/branches", "/hooks", "/info", "!/logs", "/lost-found",
96 "/objects", "/refs", "/remotes", "/worktrees", "/rr-cache", "/svn",
97 "config", "!gc.pid", "packed-refs", "shallow",
101 static void update_common_dir(struct strbuf
*buf
, int git_dir_len
)
103 char *base
= buf
->buf
+ git_dir_len
;
106 if (is_dir_file(base
, "logs", "HEAD") ||
107 is_dir_file(base
, "info", "sparse-checkout"))
108 return; /* keep this in $GIT_DIR */
109 for (p
= common_list
; *p
; p
++) {
110 const char *path
= *p
;
118 if (is_dir
&& dir_prefix(base
, path
)) {
119 replace_dir(buf
, git_dir_len
, get_git_common_dir());
122 if (!is_dir
&& !strcmp(base
, path
)) {
123 replace_dir(buf
, git_dir_len
, get_git_common_dir());
129 void report_linked_checkout_garbage(void)
131 struct strbuf sb
= STRBUF_INIT
;
135 if (!git_common_dir_env
)
137 strbuf_addf(&sb
, "%s/", get_git_dir());
139 for (p
= common_list
; *p
; p
++) {
140 const char *path
= *p
;
143 strbuf_setlen(&sb
, len
);
144 strbuf_addstr(&sb
, path
);
145 if (file_exists(sb
.buf
))
146 report_garbage("unused in linked checkout", sb
.buf
);
151 static void adjust_git_path(struct strbuf
*buf
, int git_dir_len
)
153 const char *base
= buf
->buf
+ git_dir_len
;
154 if (git_graft_env
&& is_dir_file(base
, "info", "grafts"))
155 strbuf_splice(buf
, 0, buf
->len
,
156 get_graft_file(), strlen(get_graft_file()));
157 else if (git_index_env
&& !strcmp(base
, "index"))
158 strbuf_splice(buf
, 0, buf
->len
,
159 get_index_file(), strlen(get_index_file()));
160 else if (git_db_env
&& dir_prefix(base
, "objects"))
161 replace_dir(buf
, git_dir_len
+ 7, get_object_directory());
162 else if (git_common_dir_env
)
163 update_common_dir(buf
, git_dir_len
);
166 static void do_git_path(struct strbuf
*buf
, const char *fmt
, va_list args
)
169 strbuf_addstr(buf
, get_git_dir());
170 if (buf
->len
&& !is_dir_sep(buf
->buf
[buf
->len
- 1]))
171 strbuf_addch(buf
, '/');
172 gitdir_len
= buf
->len
;
173 strbuf_vaddf(buf
, fmt
, args
);
174 adjust_git_path(buf
, gitdir_len
);
175 strbuf_cleanup_path(buf
);
178 void strbuf_git_path(struct strbuf
*sb
, const char *fmt
, ...)
182 do_git_path(sb
, fmt
, args
);
186 const char *git_path(const char *fmt
, ...)
188 struct strbuf
*pathname
= get_pathname();
191 do_git_path(pathname
, fmt
, args
);
193 return pathname
->buf
;
196 char *git_pathdup(const char *fmt
, ...)
198 struct strbuf path
= STRBUF_INIT
;
201 do_git_path(&path
, fmt
, args
);
203 return strbuf_detach(&path
, NULL
);
206 char *mkpathdup(const char *fmt
, ...)
208 struct strbuf sb
= STRBUF_INIT
;
211 strbuf_vaddf(&sb
, fmt
, args
);
213 strbuf_cleanup_path(&sb
);
214 return strbuf_detach(&sb
, NULL
);
217 const char *mkpath(const char *fmt
, ...)
220 struct strbuf
*pathname
= get_pathname();
222 strbuf_vaddf(pathname
, fmt
, args
);
224 return cleanup_path(pathname
->buf
);
227 static void do_submodule_path(struct strbuf
*buf
, const char *path
,
228 const char *fmt
, va_list args
)
232 strbuf_addstr(buf
, path
);
233 if (buf
->len
&& buf
->buf
[buf
->len
- 1] != '/')
234 strbuf_addch(buf
, '/');
235 strbuf_addstr(buf
, ".git");
237 git_dir
= read_gitfile(buf
->buf
);
240 strbuf_addstr(buf
, git_dir
);
242 strbuf_addch(buf
, '/');
244 strbuf_vaddf(buf
, fmt
, args
);
245 strbuf_cleanup_path(buf
);
248 char *git_pathdup_submodule(const char *path
, const char *fmt
, ...)
251 struct strbuf buf
= STRBUF_INIT
;
253 do_submodule_path(&buf
, path
, fmt
, args
);
255 return strbuf_detach(&buf
, NULL
);
258 void strbuf_git_path_submodule(struct strbuf
*buf
, const char *path
,
259 const char *fmt
, ...)
263 do_submodule_path(buf
, path
, fmt
, args
);
267 int validate_headref(const char *path
)
270 char *buf
, buffer
[256];
271 unsigned char sha1
[20];
275 if (lstat(path
, &st
) < 0)
278 /* Make sure it is a "refs/.." symlink */
279 if (S_ISLNK(st
.st_mode
)) {
280 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
281 if (len
>= 5 && !memcmp("refs/", buffer
, 5))
287 * Anything else, just open it and try to see if it is a symbolic ref.
289 fd
= open(path
, O_RDONLY
);
292 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
296 * Is it a symbolic ref?
300 if (!memcmp("ref:", buffer
, 4)) {
303 while (len
&& isspace(*buf
))
305 if (len
>= 5 && !memcmp("refs/", buf
, 5))
310 * Is this a detached HEAD?
312 if (!get_sha1_hex(buffer
, sha1
))
318 static struct passwd
*getpw_str(const char *username
, size_t len
)
321 char *username_z
= xmemdupz(username
, len
);
322 pw
= getpwnam(username_z
);
328 * Return a string with ~ and ~user expanded via getpw*. If buf != NULL,
329 * then it is a newly allocated string. Returns NULL on getpw failure or
332 char *expand_user_path(const char *path
)
334 struct strbuf user_path
= STRBUF_INIT
;
335 const char *to_copy
= path
;
339 if (path
[0] == '~') {
340 const char *first_slash
= strchrnul(path
, '/');
341 const char *username
= path
+ 1;
342 size_t username_len
= first_slash
- username
;
343 if (username_len
== 0) {
344 const char *home
= getenv("HOME");
347 strbuf_addstr(&user_path
, home
);
349 struct passwd
*pw
= getpw_str(username
, username_len
);
352 strbuf_addstr(&user_path
, pw
->pw_dir
);
354 to_copy
= first_slash
;
356 strbuf_addstr(&user_path
, to_copy
);
357 return strbuf_detach(&user_path
, NULL
);
359 strbuf_release(&user_path
);
364 * First, one directory to try is determined by the following algorithm.
366 * (0) If "strict" is given, the path is used as given and no DWIM is
368 * (1) "~/path" to mean path under the running user's home directory;
369 * (2) "~user/path" to mean path under named user's home directory;
370 * (3) "relative/path" to mean cwd relative directory; or
371 * (4) "/absolute/path" to mean absolute directory.
373 * Unless "strict" is given, we check "%s/.git", "%s", "%s.git/.git", "%s.git"
374 * in this order. We select the first one that is a valid git repository, and
375 * chdir() to it. If none match, or we fail to chdir, we return NULL.
377 * If all goes well, we return the directory we used to chdir() (but
378 * before ~user is expanded), avoiding getcwd() resolving symbolic
379 * links. User relative paths are also returned as they are given,
380 * except DWIM suffixing.
382 const char *enter_repo(const char *path
, int strict
)
384 static char used_path
[PATH_MAX
];
385 static char validated_path
[PATH_MAX
];
391 static const char *suffix
[] = {
392 "/.git", "", ".git/.git", ".git", NULL
,
395 int len
= strlen(path
);
397 while ((1 < len
) && (path
[len
-1] == '/'))
402 strncpy(used_path
, path
, len
); used_path
[len
] = 0 ;
403 strcpy(validated_path
, used_path
);
405 if (used_path
[0] == '~') {
406 char *newpath
= expand_user_path(used_path
);
407 if (!newpath
|| (PATH_MAX
- 10 < strlen(newpath
))) {
412 * Copy back into the static buffer. A pity
413 * since newpath was not bounded, but other
414 * branches of the if are limited by PATH_MAX
417 strcpy(used_path
, newpath
); free(newpath
);
419 else if (PATH_MAX
- 10 < len
)
421 len
= strlen(used_path
);
422 for (i
= 0; suffix
[i
]; i
++) {
424 strcpy(used_path
+ len
, suffix
[i
]);
425 if (!stat(used_path
, &st
) &&
426 (S_ISREG(st
.st_mode
) ||
427 (S_ISDIR(st
.st_mode
) && is_git_directory(used_path
)))) {
428 strcat(validated_path
, suffix
[i
]);
434 gitfile
= read_gitfile(used_path
) ;
436 strcpy(used_path
, gitfile
);
437 if (chdir(used_path
))
439 path
= validated_path
;
441 else if (chdir(path
))
444 if (access("objects", X_OK
) == 0 && access("refs", X_OK
) == 0 &&
445 validate_headref("HEAD") == 0) {
447 check_repository_format();
454 static int calc_shared_perm(int mode
)
458 if (shared_repository
< 0)
459 tweak
= -shared_repository
;
461 tweak
= shared_repository
;
463 if (!(mode
& S_IWUSR
))
466 /* Copy read bits to execute bits */
467 tweak
|= (tweak
& 0444) >> 2;
468 if (shared_repository
< 0)
469 mode
= (mode
& ~0777) | tweak
;
477 int adjust_shared_perm(const char *path
)
479 int old_mode
, new_mode
;
481 if (!shared_repository
)
483 if (get_st_mode_bits(path
, &old_mode
) < 0)
486 new_mode
= calc_shared_perm(old_mode
);
487 if (S_ISDIR(old_mode
)) {
488 /* Copy read bits to execute bits */
489 new_mode
|= (new_mode
& 0444) >> 2;
490 new_mode
|= FORCE_DIR_SET_GID
;
493 if (((old_mode
^ new_mode
) & ~S_IFMT
) &&
494 chmod(path
, (new_mode
& ~S_IFMT
)) < 0)
499 static int have_same_root(const char *path1
, const char *path2
)
501 int is_abs1
, is_abs2
;
503 is_abs1
= is_absolute_path(path1
);
504 is_abs2
= is_absolute_path(path2
);
505 return (is_abs1
&& is_abs2
&& tolower(path1
[0]) == tolower(path2
[0])) ||
506 (!is_abs1
&& !is_abs2
);
510 * Give path as relative to prefix.
512 * The strbuf may or may not be used, so do not assume it contains the
515 const char *relative_path(const char *in
, const char *prefix
,
518 int in_len
= in
? strlen(in
) : 0;
519 int prefix_len
= prefix
? strlen(prefix
) : 0;
526 else if (!prefix_len
)
529 if (have_same_root(in
, prefix
)) {
530 /* bypass dos_drive, for "c:" is identical to "C:" */
531 if (has_dos_drive_prefix(in
)) {
539 while (i
< prefix_len
&& j
< in_len
&& prefix
[i
] == in
[j
]) {
540 if (is_dir_sep(prefix
[i
])) {
541 while (is_dir_sep(prefix
[i
]))
543 while (is_dir_sep(in
[j
]))
554 /* "prefix" seems like prefix of "in" */
557 * but "/foo" is not a prefix of "/foobar"
558 * (i.e. prefix not end with '/')
560 prefix_off
< prefix_len
) {
562 /* in="/a/b", prefix="/a/b" */
564 } else if (is_dir_sep(in
[j
])) {
565 /* in="/a/b/c", prefix="/a/b" */
566 while (is_dir_sep(in
[j
]))
570 /* in="/a/bbb/c", prefix="/a/b" */
574 /* "in" is short than "prefix" */
576 /* "in" not end with '/' */
578 if (is_dir_sep(prefix
[i
])) {
579 /* in="/a/b", prefix="/a/b/c/" */
580 while (is_dir_sep(prefix
[i
]))
588 if (i
>= prefix_len
) {
596 strbuf_grow(sb
, in_len
);
598 while (i
< prefix_len
) {
599 if (is_dir_sep(prefix
[i
])) {
600 strbuf_addstr(sb
, "../");
601 while (is_dir_sep(prefix
[i
]))
607 if (!is_dir_sep(prefix
[prefix_len
- 1]))
608 strbuf_addstr(sb
, "../");
610 strbuf_addstr(sb
, in
);
616 * A simpler implementation of relative_path
618 * Get relative path by removing "prefix" from "in". This function
619 * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
620 * to increase performance when traversing the path to work_tree.
622 const char *remove_leading_path(const char *in
, const char *prefix
)
624 static char buf
[PATH_MAX
+ 1];
627 if (!prefix
|| !prefix
[0])
630 if (is_dir_sep(prefix
[i
])) {
631 if (!is_dir_sep(in
[j
]))
633 while (is_dir_sep(prefix
[i
]))
635 while (is_dir_sep(in
[j
]))
638 } else if (in
[j
] != prefix
[i
]) {
645 /* "/foo" is a prefix of "/foo" */
647 /* "/foo" is not a prefix of "/foobar" */
648 !is_dir_sep(prefix
[i
-1]) && !is_dir_sep(in
[j
])
651 while (is_dir_sep(in
[j
]))
661 * It is okay if dst == src, but they should not overlap otherwise.
663 * Performs the following normalizations on src, storing the result in dst:
664 * - Ensures that components are separated by '/' (Windows only)
665 * - Squashes sequences of '/'.
666 * - Removes "." components.
667 * - Removes ".." components, and the components the precede them.
668 * Returns failure (non-zero) if a ".." component appears as first path
669 * component anytime during the normalization. Otherwise, returns success (0).
671 * Note that this function is purely textual. It does not follow symlinks,
672 * verify the existence of the path, or make any system calls.
674 * prefix_len != NULL is for a specific case of prefix_pathspec():
675 * assume that src == dst and src[0..prefix_len-1] is already
676 * normalized, any time "../" eats up to the prefix_len part,
677 * prefix_len is reduced. In the end prefix_len is the remaining
678 * prefix that has not been overridden by user pathspec.
680 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
)
684 if (has_dos_drive_prefix(src
)) {
690 if (is_dir_sep(*src
)) {
692 while (is_dir_sep(*src
))
700 * A path component that begins with . could be
702 * (1) "." and ends -- ignore and terminate.
703 * (2) "./" -- ignore them, eat slash and continue.
704 * (3) ".." and ends -- strip one and terminate.
705 * (4) "../" -- strip one, eat slash and continue.
711 } else if (is_dir_sep(src
[1])) {
714 while (is_dir_sep(*src
))
717 } else if (src
[1] == '.') {
722 } else if (is_dir_sep(src
[2])) {
725 while (is_dir_sep(*src
))
732 /* copy up to the next '/', and eat all '/' */
733 while ((c
= *src
++) != '\0' && !is_dir_sep(c
))
737 while (is_dir_sep(c
))
746 * dst0..dst is prefix portion, and dst[-1] is '/';
749 dst
--; /* go to trailing '/' */
752 /* Windows: dst[-1] cannot be backslash anymore */
753 while (dst0
< dst
&& dst
[-1] != '/')
755 if (prefix_len
&& *prefix_len
> dst
- dst0
)
756 *prefix_len
= dst
- dst0
;
762 int normalize_path_copy(char *dst
, const char *src
)
764 return normalize_path_copy_len(dst
, src
, NULL
);
768 * path = Canonical absolute path
769 * prefixes = string_list containing normalized, absolute paths without
770 * trailing slashes (except for the root directory, which is denoted by "/").
772 * Determines, for each path in prefixes, whether the "prefix"
773 * is an ancestor directory of path. Returns the length of the longest
774 * ancestor directory, excluding any trailing slashes, or -1 if no prefix
775 * is an ancestor. (Note that this means 0 is returned if prefixes is
776 * ["/"].) "/foo" is not considered an ancestor of "/foobar". Directories
777 * are not considered to be their own ancestors. path must be in a
778 * canonical form: empty components, or "." or ".." components are not
781 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
)
785 if (!strcmp(path
, "/"))
788 for (i
= 0; i
< prefixes
->nr
; i
++) {
789 const char *ceil
= prefixes
->items
[i
].string
;
790 int len
= strlen(ceil
);
792 if (len
== 1 && ceil
[0] == '/')
793 len
= 0; /* root matches anything, with length 0 */
794 else if (!strncmp(path
, ceil
, len
) && path
[len
] == '/')
795 ; /* match of length len */
797 continue; /* no match */
806 /* strip arbitrary amount of directory separators at end of path */
807 static inline int chomp_trailing_dir_sep(const char *path
, int len
)
809 while (len
&& is_dir_sep(path
[len
- 1]))
815 * If path ends with suffix (complete path components), returns the
816 * part before suffix (sans trailing directory separators).
817 * Otherwise returns NULL.
819 char *strip_path_suffix(const char *path
, const char *suffix
)
821 int path_len
= strlen(path
), suffix_len
= strlen(suffix
);
827 if (is_dir_sep(path
[path_len
- 1])) {
828 if (!is_dir_sep(suffix
[suffix_len
- 1]))
830 path_len
= chomp_trailing_dir_sep(path
, path_len
);
831 suffix_len
= chomp_trailing_dir_sep(suffix
, suffix_len
);
833 else if (path
[--path_len
] != suffix
[--suffix_len
])
837 if (path_len
&& !is_dir_sep(path
[path_len
- 1]))
839 return xstrndup(path
, chomp_trailing_dir_sep(path
, path_len
));
842 int daemon_avoid_alias(const char *p
)
847 * This resurrects the belts and suspenders paranoia check by HPA
848 * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
849 * does not do getcwd() based path canonicalization.
851 * sl becomes true immediately after seeing '/' and continues to
852 * be true as long as dots continue after that without intervening
855 if (!p
|| (*p
!= '/' && *p
!= '~'))
865 else if (ch
== '/') {
867 /* reject //, /./ and /../ */
872 if (0 < ndot
&& ndot
< 3)
873 /* reject /.$ and /..$ */
882 else if (ch
== '/') {
889 static int only_spaces_and_periods(const char *path
, size_t len
, size_t skip
)
897 if (c
!= ' ' && c
!= '.')
903 int is_ntfs_dotgit(const char *name
)
907 for (len
= 0; ; len
++)
908 if (!name
[len
] || name
[len
] == '\\' || is_dir_sep(name
[len
])) {
909 if (only_spaces_and_periods(name
, len
, 4) &&
910 !strncasecmp(name
, ".git", 4))
912 if (only_spaces_and_periods(name
, len
, 5) &&
913 !strncasecmp(name
, "git~1", 5))
915 if (name
[len
] != '\\')
922 char *xdg_config_home(const char *filename
)
924 const char *home
, *config_home
;
927 config_home
= getenv("XDG_CONFIG_HOME");
928 if (config_home
&& *config_home
)
929 return mkpathdup("%s/git/%s", config_home
, filename
);
931 home
= getenv("HOME");
933 return mkpathdup("%s/.config/git/%s", home
, filename
);
937 GIT_PATH_FUNC(git_path_cherry_pick_head
, "CHERRY_PICK_HEAD")
938 GIT_PATH_FUNC(git_path_revert_head
, "REVERT_HEAD")
939 GIT_PATH_FUNC(git_path_squash_msg
, "SQUASH_MSG")
940 GIT_PATH_FUNC(git_path_merge_msg
, "MERGE_MSG")
941 GIT_PATH_FUNC(git_path_merge_rr
, "MERGE_RR")
942 GIT_PATH_FUNC(git_path_merge_mode
, "MERGE_MODE")
943 GIT_PATH_FUNC(git_path_merge_head
, "MERGE_HEAD")
944 GIT_PATH_FUNC(git_path_fetch_head
, "FETCH_HEAD")
945 GIT_PATH_FUNC(git_path_shallow
, "shallow")