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", "/modules",
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 return; /* keep this in $GIT_DIR */
108 for (p
= common_list
; *p
; p
++) {
109 const char *path
= *p
;
117 if (is_dir
&& dir_prefix(base
, path
)) {
118 replace_dir(buf
, git_dir_len
, get_git_common_dir());
121 if (!is_dir
&& !strcmp(base
, path
)) {
122 replace_dir(buf
, git_dir_len
, get_git_common_dir());
128 void report_linked_checkout_garbage(void)
130 struct strbuf sb
= STRBUF_INIT
;
134 if (!git_common_dir_env
)
136 strbuf_addf(&sb
, "%s/", get_git_dir());
138 for (p
= common_list
; *p
; p
++) {
139 const char *path
= *p
;
142 strbuf_setlen(&sb
, len
);
143 strbuf_addstr(&sb
, path
);
144 if (file_exists(sb
.buf
))
145 report_garbage("unused in linked checkout", sb
.buf
);
150 static void adjust_git_path(struct strbuf
*buf
, int git_dir_len
)
152 const char *base
= buf
->buf
+ git_dir_len
;
153 if (git_graft_env
&& is_dir_file(base
, "info", "grafts"))
154 strbuf_splice(buf
, 0, buf
->len
,
155 get_graft_file(), strlen(get_graft_file()));
156 else if (git_index_env
&& !strcmp(base
, "index"))
157 strbuf_splice(buf
, 0, buf
->len
,
158 get_index_file(), strlen(get_index_file()));
159 else if (git_db_env
&& dir_prefix(base
, "objects"))
160 replace_dir(buf
, git_dir_len
+ 7, get_object_directory());
161 else if (git_common_dir_env
)
162 update_common_dir(buf
, git_dir_len
);
165 static void do_git_path(struct strbuf
*buf
, const char *fmt
, va_list args
)
168 strbuf_addstr(buf
, get_git_dir());
169 if (buf
->len
&& !is_dir_sep(buf
->buf
[buf
->len
- 1]))
170 strbuf_addch(buf
, '/');
171 gitdir_len
= buf
->len
;
172 strbuf_vaddf(buf
, fmt
, args
);
173 adjust_git_path(buf
, gitdir_len
);
174 strbuf_cleanup_path(buf
);
177 void strbuf_git_path(struct strbuf
*sb
, const char *fmt
, ...)
181 do_git_path(sb
, fmt
, args
);
185 const char *git_path(const char *fmt
, ...)
187 struct strbuf
*pathname
= get_pathname();
190 do_git_path(pathname
, fmt
, args
);
192 return pathname
->buf
;
195 char *git_pathdup(const char *fmt
, ...)
197 struct strbuf path
= STRBUF_INIT
;
200 do_git_path(&path
, fmt
, args
);
202 return strbuf_detach(&path
, NULL
);
205 char *mkpathdup(const char *fmt
, ...)
207 struct strbuf sb
= STRBUF_INIT
;
210 strbuf_vaddf(&sb
, fmt
, args
);
212 strbuf_cleanup_path(&sb
);
213 return strbuf_detach(&sb
, NULL
);
216 const char *mkpath(const char *fmt
, ...)
219 struct strbuf
*pathname
= get_pathname();
221 strbuf_vaddf(pathname
, fmt
, args
);
223 return cleanup_path(pathname
->buf
);
226 void home_config_paths(char **global
, char **xdg
, char *file
)
228 char *xdg_home
= getenv("XDG_CONFIG_HOME");
229 char *home
= getenv("HOME");
230 char *to_free
= NULL
;
237 to_free
= mkpathdup("%s/.config", home
);
241 *global
= mkpathdup("%s/.gitconfig", home
);
248 *xdg
= mkpathdup("%s/git/%s", xdg_home
, file
);
254 const char *git_path_submodule(const char *path
, const char *fmt
, ...)
256 struct strbuf
*buf
= get_pathname();
260 strbuf_addstr(buf
, path
);
261 if (buf
->len
&& buf
->buf
[buf
->len
- 1] != '/')
262 strbuf_addch(buf
, '/');
263 strbuf_addstr(buf
, ".git");
265 git_dir
= read_gitfile(buf
->buf
);
268 strbuf_addstr(buf
, git_dir
);
270 strbuf_addch(buf
, '/');
273 strbuf_vaddf(buf
, fmt
, args
);
275 strbuf_cleanup_path(buf
);
279 int validate_headref(const char *path
)
282 char *buf
, buffer
[256];
283 unsigned char sha1
[20];
287 if (lstat(path
, &st
) < 0)
290 /* Make sure it is a "refs/.." symlink */
291 if (S_ISLNK(st
.st_mode
)) {
292 len
= readlink(path
, buffer
, sizeof(buffer
)-1);
293 if (len
>= 5 && !memcmp("refs/", buffer
, 5))
299 * Anything else, just open it and try to see if it is a symbolic ref.
301 fd
= open(path
, O_RDONLY
);
304 len
= read_in_full(fd
, buffer
, sizeof(buffer
)-1);
308 * Is it a symbolic ref?
312 if (!memcmp("ref:", buffer
, 4)) {
315 while (len
&& isspace(*buf
))
317 if (len
>= 5 && !memcmp("refs/", buf
, 5))
322 * Is this a detached HEAD?
324 if (!get_sha1_hex(buffer
, sha1
))
330 static struct passwd
*getpw_str(const char *username
, size_t len
)
333 char *username_z
= xmemdupz(username
, len
);
334 pw
= getpwnam(username_z
);
340 * Return a string with ~ and ~user expanded via getpw*. If buf != NULL,
341 * then it is a newly allocated string. Returns NULL on getpw failure or
344 char *expand_user_path(const char *path
)
346 struct strbuf user_path
= STRBUF_INIT
;
347 const char *to_copy
= path
;
351 if (path
[0] == '~') {
352 const char *first_slash
= strchrnul(path
, '/');
353 const char *username
= path
+ 1;
354 size_t username_len
= first_slash
- username
;
355 if (username_len
== 0) {
356 const char *home
= getenv("HOME");
359 strbuf_addstr(&user_path
, home
);
361 struct passwd
*pw
= getpw_str(username
, username_len
);
364 strbuf_addstr(&user_path
, pw
->pw_dir
);
366 to_copy
= first_slash
;
368 strbuf_addstr(&user_path
, to_copy
);
369 return strbuf_detach(&user_path
, NULL
);
371 strbuf_release(&user_path
);
376 * First, one directory to try is determined by the following algorithm.
378 * (0) If "strict" is given, the path is used as given and no DWIM is
380 * (1) "~/path" to mean path under the running user's home directory;
381 * (2) "~user/path" to mean path under named user's home directory;
382 * (3) "relative/path" to mean cwd relative directory; or
383 * (4) "/absolute/path" to mean absolute directory.
385 * Unless "strict" is given, we try access() for existence of "%s.git/.git",
386 * "%s/.git", "%s.git", "%s" in this order. The first one that exists is
389 * Second, we try chdir() to that. Upon failure, we return NULL.
391 * Then, we try if the current directory is a valid git repository.
392 * Upon failure, we return NULL.
394 * If all goes well, we return the directory we used to chdir() (but
395 * before ~user is expanded), avoiding getcwd() resolving symbolic
396 * links. User relative paths are also returned as they are given,
397 * except DWIM suffixing.
399 const char *enter_repo(const char *path
, int strict
)
401 static char used_path
[PATH_MAX
];
402 static char validated_path
[PATH_MAX
];
408 static const char *suffix
[] = {
409 "/.git", "", ".git/.git", ".git", NULL
,
412 int len
= strlen(path
);
414 while ((1 < len
) && (path
[len
-1] == '/'))
419 strncpy(used_path
, path
, len
); used_path
[len
] = 0 ;
420 strcpy(validated_path
, used_path
);
422 if (used_path
[0] == '~') {
423 char *newpath
= expand_user_path(used_path
);
424 if (!newpath
|| (PATH_MAX
- 10 < strlen(newpath
))) {
429 * Copy back into the static buffer. A pity
430 * since newpath was not bounded, but other
431 * branches of the if are limited by PATH_MAX
434 strcpy(used_path
, newpath
); free(newpath
);
436 else if (PATH_MAX
- 10 < len
)
438 len
= strlen(used_path
);
439 for (i
= 0; suffix
[i
]; i
++) {
441 strcpy(used_path
+ len
, suffix
[i
]);
442 if (!stat(used_path
, &st
) &&
443 (S_ISREG(st
.st_mode
) ||
444 (S_ISDIR(st
.st_mode
) && is_git_directory(used_path
)))) {
445 strcat(validated_path
, suffix
[i
]);
451 gitfile
= read_gitfile(used_path
) ;
453 strcpy(used_path
, gitfile
);
454 if (chdir(used_path
))
456 path
= validated_path
;
458 else if (chdir(path
))
461 if (access("objects", X_OK
) == 0 && access("refs", X_OK
) == 0 &&
462 validate_headref("HEAD") == 0) {
464 check_repository_format();
471 static int calc_shared_perm(int mode
)
475 if (shared_repository
< 0)
476 tweak
= -shared_repository
;
478 tweak
= shared_repository
;
480 if (!(mode
& S_IWUSR
))
483 /* Copy read bits to execute bits */
484 tweak
|= (tweak
& 0444) >> 2;
485 if (shared_repository
< 0)
486 mode
= (mode
& ~0777) | tweak
;
494 int adjust_shared_perm(const char *path
)
496 int old_mode
, new_mode
;
498 if (!shared_repository
)
500 if (get_st_mode_bits(path
, &old_mode
) < 0)
503 new_mode
= calc_shared_perm(old_mode
);
504 if (S_ISDIR(old_mode
)) {
505 /* Copy read bits to execute bits */
506 new_mode
|= (new_mode
& 0444) >> 2;
507 new_mode
|= FORCE_DIR_SET_GID
;
510 if (((old_mode
^ new_mode
) & ~S_IFMT
) &&
511 chmod(path
, (new_mode
& ~S_IFMT
)) < 0)
516 static int have_same_root(const char *path1
, const char *path2
)
518 int is_abs1
, is_abs2
;
520 is_abs1
= is_absolute_path(path1
);
521 is_abs2
= is_absolute_path(path2
);
522 return (is_abs1
&& is_abs2
&& tolower(path1
[0]) == tolower(path2
[0])) ||
523 (!is_abs1
&& !is_abs2
);
527 * Give path as relative to prefix.
529 * The strbuf may or may not be used, so do not assume it contains the
532 const char *relative_path(const char *in
, const char *prefix
,
535 int in_len
= in
? strlen(in
) : 0;
536 int prefix_len
= prefix
? strlen(prefix
) : 0;
543 else if (!prefix_len
)
546 if (have_same_root(in
, prefix
)) {
547 /* bypass dos_drive, for "c:" is identical to "C:" */
548 if (has_dos_drive_prefix(in
)) {
556 while (i
< prefix_len
&& j
< in_len
&& prefix
[i
] == in
[j
]) {
557 if (is_dir_sep(prefix
[i
])) {
558 while (is_dir_sep(prefix
[i
]))
560 while (is_dir_sep(in
[j
]))
571 /* "prefix" seems like prefix of "in" */
574 * but "/foo" is not a prefix of "/foobar"
575 * (i.e. prefix not end with '/')
577 prefix_off
< prefix_len
) {
579 /* in="/a/b", prefix="/a/b" */
581 } else if (is_dir_sep(in
[j
])) {
582 /* in="/a/b/c", prefix="/a/b" */
583 while (is_dir_sep(in
[j
]))
587 /* in="/a/bbb/c", prefix="/a/b" */
591 /* "in" is short than "prefix" */
593 /* "in" not end with '/' */
595 if (is_dir_sep(prefix
[i
])) {
596 /* in="/a/b", prefix="/a/b/c/" */
597 while (is_dir_sep(prefix
[i
]))
605 if (i
>= prefix_len
) {
613 strbuf_grow(sb
, in_len
);
615 while (i
< prefix_len
) {
616 if (is_dir_sep(prefix
[i
])) {
617 strbuf_addstr(sb
, "../");
618 while (is_dir_sep(prefix
[i
]))
624 if (!is_dir_sep(prefix
[prefix_len
- 1]))
625 strbuf_addstr(sb
, "../");
627 strbuf_addstr(sb
, in
);
633 * A simpler implementation of relative_path
635 * Get relative path by removing "prefix" from "in". This function
636 * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
637 * to increase performance when traversing the path to work_tree.
639 const char *remove_leading_path(const char *in
, const char *prefix
)
641 static char buf
[PATH_MAX
+ 1];
644 if (!prefix
|| !prefix
[0])
647 if (is_dir_sep(prefix
[i
])) {
648 if (!is_dir_sep(in
[j
]))
650 while (is_dir_sep(prefix
[i
]))
652 while (is_dir_sep(in
[j
]))
655 } else if (in
[j
] != prefix
[i
]) {
662 /* "/foo" is a prefix of "/foo" */
664 /* "/foo" is not a prefix of "/foobar" */
665 !is_dir_sep(prefix
[i
-1]) && !is_dir_sep(in
[j
])
668 while (is_dir_sep(in
[j
]))
678 * It is okay if dst == src, but they should not overlap otherwise.
680 * Performs the following normalizations on src, storing the result in dst:
681 * - Ensures that components are separated by '/' (Windows only)
682 * - Squashes sequences of '/'.
683 * - Removes "." components.
684 * - Removes ".." components, and the components the precede them.
685 * Returns failure (non-zero) if a ".." component appears as first path
686 * component anytime during the normalization. Otherwise, returns success (0).
688 * Note that this function is purely textual. It does not follow symlinks,
689 * verify the existence of the path, or make any system calls.
691 * prefix_len != NULL is for a specific case of prefix_pathspec():
692 * assume that src == dst and src[0..prefix_len-1] is already
693 * normalized, any time "../" eats up to the prefix_len part,
694 * prefix_len is reduced. In the end prefix_len is the remaining
695 * prefix that has not been overridden by user pathspec.
697 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
)
701 if (has_dos_drive_prefix(src
)) {
707 if (is_dir_sep(*src
)) {
709 while (is_dir_sep(*src
))
717 * A path component that begins with . could be
719 * (1) "." and ends -- ignore and terminate.
720 * (2) "./" -- ignore them, eat slash and continue.
721 * (3) ".." and ends -- strip one and terminate.
722 * (4) "../" -- strip one, eat slash and continue.
728 } else if (is_dir_sep(src
[1])) {
731 while (is_dir_sep(*src
))
734 } else if (src
[1] == '.') {
739 } else if (is_dir_sep(src
[2])) {
742 while (is_dir_sep(*src
))
749 /* copy up to the next '/', and eat all '/' */
750 while ((c
= *src
++) != '\0' && !is_dir_sep(c
))
754 while (is_dir_sep(c
))
763 * dst0..dst is prefix portion, and dst[-1] is '/';
766 dst
--; /* go to trailing '/' */
769 /* Windows: dst[-1] cannot be backslash anymore */
770 while (dst0
< dst
&& dst
[-1] != '/')
772 if (prefix_len
&& *prefix_len
> dst
- dst0
)
773 *prefix_len
= dst
- dst0
;
779 int normalize_path_copy(char *dst
, const char *src
)
781 return normalize_path_copy_len(dst
, src
, NULL
);
785 * path = Canonical absolute path
786 * prefixes = string_list containing normalized, absolute paths without
787 * trailing slashes (except for the root directory, which is denoted by "/").
789 * Determines, for each path in prefixes, whether the "prefix"
790 * is an ancestor directory of path. Returns the length of the longest
791 * ancestor directory, excluding any trailing slashes, or -1 if no prefix
792 * is an ancestor. (Note that this means 0 is returned if prefixes is
793 * ["/"].) "/foo" is not considered an ancestor of "/foobar". Directories
794 * are not considered to be their own ancestors. path must be in a
795 * canonical form: empty components, or "." or ".." components are not
798 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
)
802 if (!strcmp(path
, "/"))
805 for (i
= 0; i
< prefixes
->nr
; i
++) {
806 const char *ceil
= prefixes
->items
[i
].string
;
807 int len
= strlen(ceil
);
809 if (len
== 1 && ceil
[0] == '/')
810 len
= 0; /* root matches anything, with length 0 */
811 else if (!strncmp(path
, ceil
, len
) && path
[len
] == '/')
812 ; /* match of length len */
814 continue; /* no match */
823 /* strip arbitrary amount of directory separators at end of path */
824 static inline int chomp_trailing_dir_sep(const char *path
, int len
)
826 while (len
&& is_dir_sep(path
[len
- 1]))
832 * If path ends with suffix (complete path components), returns the
833 * part before suffix (sans trailing directory separators).
834 * Otherwise returns NULL.
836 char *strip_path_suffix(const char *path
, const char *suffix
)
838 int path_len
= strlen(path
), suffix_len
= strlen(suffix
);
844 if (is_dir_sep(path
[path_len
- 1])) {
845 if (!is_dir_sep(suffix
[suffix_len
- 1]))
847 path_len
= chomp_trailing_dir_sep(path
, path_len
);
848 suffix_len
= chomp_trailing_dir_sep(suffix
, suffix_len
);
850 else if (path
[--path_len
] != suffix
[--suffix_len
])
854 if (path_len
&& !is_dir_sep(path
[path_len
- 1]))
856 return xstrndup(path
, chomp_trailing_dir_sep(path
, path_len
));
859 int daemon_avoid_alias(const char *p
)
864 * This resurrects the belts and suspenders paranoia check by HPA
865 * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
866 * does not do getcwd() based path canonicalization.
868 * sl becomes true immediately after seeing '/' and continues to
869 * be true as long as dots continue after that without intervening
872 if (!p
|| (*p
!= '/' && *p
!= '~'))
882 else if (ch
== '/') {
884 /* reject //, /./ and /../ */
889 if (0 < ndot
&& ndot
< 3)
890 /* reject /.$ and /..$ */
899 else if (ch
== '/') {