2 * Utilities for paths and pathnames
6 #include "string-list.h"
8 static int get_st_mode_bits(const char *path, int *mode)
11 if (lstat(path, &st) < 0)
17 static char bad_path[] = "/bad-path/";
19 static char *get_pathname(void)
21 static char pathname_array[4][PATH_MAX];
23 return pathname_array[3 & ++index];
26 static char *cleanup_path(char *path)
29 if (!memcmp(path, "./", 2)) {
37 char *mksnpath(char *buf, size_t n, const char *fmt, ...)
43 len = vsnprintf(buf, n, fmt, args);
46 strlcpy(buf, bad_path, n);
49 return cleanup_path(buf);
52 static char *vsnpath(char *buf, size_t n, const char *fmt, va_list args)
54 const char *git_dir = get_git_dir();
57 len = strlen(git_dir);
60 memcpy(buf, git_dir, len);
61 if (len && !is_dir_sep(git_dir[len-1]))
63 len += vsnprintf(buf + len, n - len, fmt, args);
66 return cleanup_path(buf);
68 strlcpy(buf, bad_path, n);
72 char *git_snpath(char *buf, size_t n, const char *fmt, ...)
77 ret = vsnpath(buf, n, fmt, args);
82 char *git_pathdup(const char *fmt, ...)
84 char path[PATH_MAX], *ret;
87 ret = vsnpath(path, sizeof(path), fmt, args);
92 char *mkpathdup(const char *fmt, ...)
95 struct strbuf sb = STRBUF_INIT;
99 strbuf_vaddf(&sb, fmt, args);
101 path = xstrdup(cleanup_path(sb.buf));
107 char *mkpath(const char *fmt, ...)
111 char *pathname = get_pathname();
114 len = vsnprintf(pathname, PATH_MAX, fmt, args);
118 return cleanup_path(pathname);
121 char *git_path(const char *fmt, ...)
123 char *pathname = get_pathname();
128 ret = vsnpath(pathname, PATH_MAX, fmt, args);
133 void home_config_paths(char **global, char **xdg, char *file)
135 char *xdg_home = getenv("XDG_CONFIG_HOME");
136 char *home = getenv("HOME");
137 char *to_free = NULL;
144 to_free = mkpathdup("%s/.config", home);
148 *global = mkpathdup("%s/.gitconfig", home);
154 *xdg = mkpathdup("%s/git/%s", xdg_home, file);
159 char *git_path_submodule(const char *path, const char *fmt, ...)
161 char *pathname = get_pathname();
162 struct strbuf buf = STRBUF_INIT;
168 if (len > PATH_MAX-100)
171 strbuf_addstr(&buf, path);
172 if (len && path[len-1] != '/')
173 strbuf_addch(&buf, '/');
174 strbuf_addstr(&buf, ".git");
176 git_dir = read_gitfile(buf.buf);
179 strbuf_addstr(&buf, git_dir);
181 strbuf_addch(&buf, '/');
183 if (buf.len >= PATH_MAX)
185 memcpy(pathname, buf.buf, buf.len + 1);
187 strbuf_release(&buf);
188 len = strlen(pathname);
191 len += vsnprintf(pathname + len, PATH_MAX - len, fmt, args);
195 return cleanup_path(pathname);
198 int validate_headref(const char *path)
201 char *buf, buffer[256];
202 unsigned char sha1[20];
206 if (lstat(path, &st) < 0)
209 /* Make sure it is a "refs/.." symlink */
210 if (S_ISLNK(st.st_mode)) {
211 len = readlink(path, buffer, sizeof(buffer)-1);
212 if (len >= 5 && !memcmp("refs/", buffer, 5))
218 * Anything else, just open it and try to see if it is a symbolic ref.
220 fd = open(path, O_RDONLY);
223 len = read_in_full(fd, buffer, sizeof(buffer)-1);
227 * Is it a symbolic ref?
231 if (!memcmp("ref:", buffer, 4)) {
234 while (len && isspace(*buf))
236 if (len >= 5 && !memcmp("refs/", buf, 5))
241 * Is this a detached HEAD?
243 if (!get_sha1_hex(buffer, sha1))
249 static struct passwd *getpw_str(const char *username, size_t len)
252 char *username_z = xmalloc(len + 1);
253 memcpy(username_z, username, len);
254 username_z[len] = '\0';
255 pw = getpwnam(username_z);
261 * Return a string with ~ and ~user expanded via getpw*. If buf != NULL,
262 * then it is a newly allocated string. Returns NULL on getpw failure or
265 char *expand_user_path(const char *path)
267 struct strbuf user_path = STRBUF_INIT;
268 const char *first_slash = strchrnul(path, '/');
269 const char *to_copy = path;
273 if (path[0] == '~') {
274 const char *username = path + 1;
275 size_t username_len = first_slash - username;
276 if (username_len == 0) {
277 const char *home = getenv("HOME");
280 strbuf_add(&user_path, home, strlen(home));
282 struct passwd *pw = getpw_str(username, username_len);
285 strbuf_add(&user_path, pw->pw_dir, strlen(pw->pw_dir));
287 to_copy = first_slash;
289 strbuf_add(&user_path, to_copy, strlen(to_copy));
290 return strbuf_detach(&user_path, NULL);
292 strbuf_release(&user_path);
297 * First, one directory to try is determined by the following algorithm.
299 * (0) If "strict" is given, the path is used as given and no DWIM is
301 * (1) "~/path" to mean path under the running user's home directory;
302 * (2) "~user/path" to mean path under named user's home directory;
303 * (3) "relative/path" to mean cwd relative directory; or
304 * (4) "/absolute/path" to mean absolute directory.
306 * Unless "strict" is given, we try access() for existence of "%s.git/.git",
307 * "%s/.git", "%s.git", "%s" in this order. The first one that exists is
310 * Second, we try chdir() to that. Upon failure, we return NULL.
312 * Then, we try if the current directory is a valid git repository.
313 * Upon failure, we return NULL.
315 * If all goes well, we return the directory we used to chdir() (but
316 * before ~user is expanded), avoiding getcwd() resolving symbolic
317 * links. User relative paths are also returned as they are given,
318 * except DWIM suffixing.
320 const char *enter_repo(const char *path, int strict)
322 static char used_path[PATH_MAX];
323 static char validated_path[PATH_MAX];
329 static const char *suffix[] = {
330 "/.git", "", ".git/.git", ".git", NULL,
333 int len = strlen(path);
335 while ((1 < len) && (path[len-1] == '/'))
340 strncpy(used_path, path, len); used_path[len] = 0 ;
341 strcpy(validated_path, used_path);
343 if (used_path[0] == '~') {
344 char *newpath = expand_user_path(used_path);
345 if (!newpath || (PATH_MAX - 10 < strlen(newpath))) {
350 * Copy back into the static buffer. A pity
351 * since newpath was not bounded, but other
352 * branches of the if are limited by PATH_MAX
355 strcpy(used_path, newpath); free(newpath);
357 else if (PATH_MAX - 10 < len)
359 len = strlen(used_path);
360 for (i = 0; suffix[i]; i++) {
362 strcpy(used_path + len, suffix[i]);
363 if (!stat(used_path, &st) &&
364 (S_ISREG(st.st_mode) ||
365 (S_ISDIR(st.st_mode) && is_git_directory(used_path)))) {
366 strcat(validated_path, suffix[i]);
372 gitfile = read_gitfile(used_path) ;
374 strcpy(used_path, gitfile);
375 if (chdir(used_path))
377 path = validated_path;
379 else if (chdir(path))
382 if (access("objects", X_OK) == 0 && access("refs", X_OK) == 0 &&
383 validate_headref("HEAD") == 0) {
385 check_repository_format();
392 static int calc_shared_perm(int mode)
396 if (shared_repository < 0)
397 tweak = -shared_repository;
399 tweak = shared_repository;
401 if (!(mode & S_IWUSR))
404 /* Copy read bits to execute bits */
405 tweak |= (tweak & 0444) >> 2;
406 if (shared_repository < 0)
407 mode = (mode & ~0777) | tweak;
415 int adjust_shared_perm(const char *path)
417 int old_mode, new_mode;
419 if (!shared_repository)
421 if (get_st_mode_bits(path, &old_mode) < 0)
424 new_mode = calc_shared_perm(old_mode);
425 if (S_ISDIR(old_mode)) {
426 /* Copy read bits to execute bits */
427 new_mode |= (new_mode & 0444) >> 2;
428 new_mode |= FORCE_DIR_SET_GID;
431 if (((old_mode ^ new_mode) & ~S_IFMT) &&
432 chmod(path, (new_mode & ~S_IFMT)) < 0)
437 static int have_same_root(const char *path1, const char *path2)
439 int is_abs1, is_abs2;
441 is_abs1 = is_absolute_path(path1);
442 is_abs2 = is_absolute_path(path2);
443 return (is_abs1 && is_abs2 && tolower(path1[0]) == tolower(path2[0])) ||
444 (!is_abs1 && !is_abs2);
448 * Give path as relative to prefix.
450 * The strbuf may or may not be used, so do not assume it contains the
453 const char *relative_path(const char *in, const char *prefix,
456 int in_len = in ? strlen(in) : 0;
457 int prefix_len = prefix ? strlen(prefix) : 0;
464 else if (!prefix_len)
467 if (have_same_root(in, prefix)) {
468 /* bypass dos_drive, for "c:" is identical to "C:" */
469 if (has_dos_drive_prefix(in)) {
477 while (i < prefix_len && j < in_len && prefix[i] == in[j]) {
478 if (is_dir_sep(prefix[i])) {
479 while (is_dir_sep(prefix[i]))
481 while (is_dir_sep(in[j]))
492 /* "prefix" seems like prefix of "in" */
495 * but "/foo" is not a prefix of "/foobar"
496 * (i.e. prefix not end with '/')
498 prefix_off < prefix_len) {
500 /* in="/a/b", prefix="/a/b" */
502 } else if (is_dir_sep(in[j])) {
503 /* in="/a/b/c", prefix="/a/b" */
504 while (is_dir_sep(in[j]))
508 /* in="/a/bbb/c", prefix="/a/b" */
512 /* "in" is short than "prefix" */
514 /* "in" not end with '/' */
516 if (is_dir_sep(prefix[i])) {
517 /* in="/a/b", prefix="/a/b/c/" */
518 while (is_dir_sep(prefix[i]))
526 if (i >= prefix_len) {
534 strbuf_grow(sb, in_len);
536 while (i < prefix_len) {
537 if (is_dir_sep(prefix[i])) {
538 strbuf_addstr(sb, "../");
539 while (is_dir_sep(prefix[i]))
545 if (!is_dir_sep(prefix[prefix_len - 1]))
546 strbuf_addstr(sb, "../");
548 strbuf_addstr(sb, in);
554 * A simpler implementation of relative_path
556 * Get relative path by removing "prefix" from "in". This function
557 * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
558 * to increase performance when traversing the path to work_tree.
560 const char *remove_leading_path(const char *in, const char *prefix)
562 static char buf[PATH_MAX + 1];
565 if (!prefix || !prefix[0])
568 if (is_dir_sep(prefix[i])) {
569 if (!is_dir_sep(in[j]))
571 while (is_dir_sep(prefix[i]))
573 while (is_dir_sep(in[j]))
576 } else if (in[j] != prefix[i]) {
583 /* "/foo" is a prefix of "/foo" */
585 /* "/foo" is not a prefix of "/foobar" */
586 !is_dir_sep(prefix[i-1]) && !is_dir_sep(in[j])
589 while (is_dir_sep(in[j]))
599 * It is okay if dst == src, but they should not overlap otherwise.
601 * Performs the following normalizations on src, storing the result in dst:
602 * - Ensures that components are separated by '/' (Windows only)
603 * - Squashes sequences of '/'.
604 * - Removes "." components.
605 * - Removes ".." components, and the components the precede them.
606 * Returns failure (non-zero) if a ".." component appears as first path
607 * component anytime during the normalization. Otherwise, returns success (0).
609 * Note that this function is purely textual. It does not follow symlinks,
610 * verify the existence of the path, or make any system calls.
612 * prefix_len != NULL is for a specific case of prefix_pathspec():
613 * assume that src == dst and src[0..prefix_len-1] is already
614 * normalized, any time "../" eats up to the prefix_len part,
615 * prefix_len is reduced. In the end prefix_len is the remaining
616 * prefix that has not been overridden by user pathspec.
618 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len)
622 if (has_dos_drive_prefix(src)) {
628 if (is_dir_sep(*src)) {
630 while (is_dir_sep(*src))
638 * A path component that begins with . could be
640 * (1) "." and ends -- ignore and terminate.
641 * (2) "./" -- ignore them, eat slash and continue.
642 * (3) ".." and ends -- strip one and terminate.
643 * (4) "../" -- strip one, eat slash and continue.
649 } else if (is_dir_sep(src[1])) {
652 while (is_dir_sep(*src))
655 } else if (src[1] == '.') {
660 } else if (is_dir_sep(src[2])) {
663 while (is_dir_sep(*src))
670 /* copy up to the next '/', and eat all '/' */
671 while ((c = *src++) != '\0' && !is_dir_sep(c))
675 while (is_dir_sep(c))
684 * dst0..dst is prefix portion, and dst[-1] is '/';
687 dst--; /* go to trailing '/' */
690 /* Windows: dst[-1] cannot be backslash anymore */
691 while (dst0 < dst && dst[-1] != '/')
693 if (prefix_len && *prefix_len > dst - dst0)
694 *prefix_len = dst - dst0;
700 int normalize_path_copy(char *dst, const char *src)
702 return normalize_path_copy_len(dst, src, NULL);
706 * path = Canonical absolute path
707 * prefixes = string_list containing normalized, absolute paths without
708 * trailing slashes (except for the root directory, which is denoted by "/").
710 * Determines, for each path in prefixes, whether the "prefix"
711 * is an ancestor directory of path. Returns the length of the longest
712 * ancestor directory, excluding any trailing slashes, or -1 if no prefix
713 * is an ancestor. (Note that this means 0 is returned if prefixes is
714 * ["/"].) "/foo" is not considered an ancestor of "/foobar". Directories
715 * are not considered to be their own ancestors. path must be in a
716 * canonical form: empty components, or "." or ".." components are not
719 int longest_ancestor_length(const char *path, struct string_list *prefixes)
723 if (!strcmp(path, "/"))
726 for (i = 0; i < prefixes->nr; i++) {
727 const char *ceil = prefixes->items[i].string;
728 int len = strlen(ceil);
730 if (len == 1 && ceil[0] == '/')
731 len = 0; /* root matches anything, with length 0 */
732 else if (!strncmp(path, ceil, len) && path[len] == '/')
733 ; /* match of length len */
735 continue; /* no match */
744 /* strip arbitrary amount of directory separators at end of path */
745 static inline int chomp_trailing_dir_sep(const char *path, int len)
747 while (len && is_dir_sep(path[len - 1]))
753 * If path ends with suffix (complete path components), returns the
754 * part before suffix (sans trailing directory separators).
755 * Otherwise returns NULL.
757 char *strip_path_suffix(const char *path, const char *suffix)
759 int path_len = strlen(path), suffix_len = strlen(suffix);
765 if (is_dir_sep(path[path_len - 1])) {
766 if (!is_dir_sep(suffix[suffix_len - 1]))
768 path_len = chomp_trailing_dir_sep(path, path_len);
769 suffix_len = chomp_trailing_dir_sep(suffix, suffix_len);
771 else if (path[--path_len] != suffix[--suffix_len])
775 if (path_len && !is_dir_sep(path[path_len - 1]))
777 return xstrndup(path, chomp_trailing_dir_sep(path, path_len));
780 int daemon_avoid_alias(const char *p)
785 * This resurrects the belts and suspenders paranoia check by HPA
786 * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
787 * does not do getcwd() based path canonicalization.
789 * sl becomes true immediately after seeing '/' and continues to
790 * be true as long as dots continue after that without intervening
793 if (!p || (*p != '/' && *p != '~'))
803 else if (ch == '/') {
805 /* reject //, /./ and /../ */
810 if (0 < ndot && ndot < 3)
811 /* reject /.$ and /..$ */
820 else if (ch == '/') {
827 int offset_1st_component(const char *path)
829 if (has_dos_drive_prefix(path))
830 return 2 + is_dir_sep(path[2]);
831 return is_dir_sep(path[0]);