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 char *git_path_submodule(const char *path, const char *fmt, ...)
135 char *pathname = get_pathname();
136 struct strbuf buf = STRBUF_INIT;
142 if (len > PATH_MAX-100)
145 strbuf_addstr(&buf, path);
146 if (len && path[len-1] != '/')
147 strbuf_addch(&buf, '/');
148 strbuf_addstr(&buf, ".git");
150 git_dir = read_gitfile(buf.buf);
153 strbuf_addstr(&buf, git_dir);
155 strbuf_addch(&buf, '/');
157 if (buf.len >= PATH_MAX)
159 memcpy(pathname, buf.buf, buf.len + 1);
161 strbuf_release(&buf);
162 len = strlen(pathname);
165 len += vsnprintf(pathname + len, PATH_MAX - len, fmt, args);
169 return cleanup_path(pathname);
172 int validate_headref(const char *path)
175 char *buf, buffer[256];
176 unsigned char sha1[20];
180 if (lstat(path, &st) < 0)
183 /* Make sure it is a "refs/.." symlink */
184 if (S_ISLNK(st.st_mode)) {
185 len = readlink(path, buffer, sizeof(buffer)-1);
186 if (len >= 5 && !memcmp("refs/", buffer, 5))
192 * Anything else, just open it and try to see if it is a symbolic ref.
194 fd = open(path, O_RDONLY);
197 len = read_in_full(fd, buffer, sizeof(buffer)-1);
201 * Is it a symbolic ref?
205 if (!memcmp("ref:", buffer, 4)) {
208 while (len && isspace(*buf))
210 if (len >= 5 && !memcmp("refs/", buf, 5))
215 * Is this a detached HEAD?
217 if (!get_sha1_hex(buffer, sha1))
223 static struct passwd *getpw_str(const char *username, size_t len)
226 char *username_z = xmemdupz(username, len);
227 pw = getpwnam(username_z);
233 * Return a string with ~ and ~user expanded via getpw*. If buf != NULL,
234 * then it is a newly allocated string. Returns NULL on getpw failure or
237 char *expand_user_path(const char *path)
239 struct strbuf user_path = STRBUF_INIT;
240 const char *to_copy = path;
244 if (path[0] == '~') {
245 const char *first_slash = strchrnul(path, '/');
246 const char *username = path + 1;
247 size_t username_len = first_slash - username;
248 if (username_len == 0) {
249 const char *home = getenv("HOME");
252 strbuf_addstr(&user_path, home);
254 struct passwd *pw = getpw_str(username, username_len);
257 strbuf_addstr(&user_path, pw->pw_dir);
259 to_copy = first_slash;
261 strbuf_addstr(&user_path, to_copy);
262 return strbuf_detach(&user_path, NULL);
264 strbuf_release(&user_path);
269 * First, one directory to try is determined by the following algorithm.
271 * (0) If "strict" is given, the path is used as given and no DWIM is
273 * (1) "~/path" to mean path under the running user's home directory;
274 * (2) "~user/path" to mean path under named user's home directory;
275 * (3) "relative/path" to mean cwd relative directory; or
276 * (4) "/absolute/path" to mean absolute directory.
278 * Unless "strict" is given, we try access() for existence of "%s.git/.git",
279 * "%s/.git", "%s.git", "%s" in this order. The first one that exists is
282 * Second, we try chdir() to that. Upon failure, we return NULL.
284 * Then, we try if the current directory is a valid git repository.
285 * Upon failure, we return NULL.
287 * If all goes well, we return the directory we used to chdir() (but
288 * before ~user is expanded), avoiding getcwd() resolving symbolic
289 * links. User relative paths are also returned as they are given,
290 * except DWIM suffixing.
292 const char *enter_repo(const char *path, int strict)
294 static char used_path[PATH_MAX];
295 static char validated_path[PATH_MAX];
301 static const char *suffix[] = {
302 "/.git", "", ".git/.git", ".git", NULL,
305 int len = strlen(path);
307 while ((1 < len) && (path[len-1] == '/'))
312 strncpy(used_path, path, len); used_path[len] = 0 ;
313 strcpy(validated_path, used_path);
315 if (used_path[0] == '~') {
316 char *newpath = expand_user_path(used_path);
317 if (!newpath || (PATH_MAX - 10 < strlen(newpath))) {
322 * Copy back into the static buffer. A pity
323 * since newpath was not bounded, but other
324 * branches of the if are limited by PATH_MAX
327 strcpy(used_path, newpath); free(newpath);
329 else if (PATH_MAX - 10 < len)
331 len = strlen(used_path);
332 for (i = 0; suffix[i]; i++) {
334 strcpy(used_path + len, suffix[i]);
335 if (!stat(used_path, &st) &&
336 (S_ISREG(st.st_mode) ||
337 (S_ISDIR(st.st_mode) && is_git_directory(used_path)))) {
338 strcat(validated_path, suffix[i]);
344 gitfile = read_gitfile(used_path) ;
346 strcpy(used_path, gitfile);
347 if (chdir(used_path))
349 path = validated_path;
351 else if (chdir(path))
354 if (access("objects", X_OK) == 0 && access("refs", X_OK) == 0 &&
355 validate_headref("HEAD") == 0) {
357 check_repository_format();
364 static int calc_shared_perm(int mode)
368 if (shared_repository < 0)
369 tweak = -shared_repository;
371 tweak = shared_repository;
373 if (!(mode & S_IWUSR))
376 /* Copy read bits to execute bits */
377 tweak |= (tweak & 0444) >> 2;
378 if (shared_repository < 0)
379 mode = (mode & ~0777) | tweak;
387 int adjust_shared_perm(const char *path)
389 int old_mode, new_mode;
391 if (!shared_repository)
393 if (get_st_mode_bits(path, &old_mode) < 0)
396 new_mode = calc_shared_perm(old_mode);
397 if (S_ISDIR(old_mode)) {
398 /* Copy read bits to execute bits */
399 new_mode |= (new_mode & 0444) >> 2;
400 new_mode |= FORCE_DIR_SET_GID;
403 if (((old_mode ^ new_mode) & ~S_IFMT) &&
404 chmod(path, (new_mode & ~S_IFMT)) < 0)
409 static int have_same_root(const char *path1, const char *path2)
411 int is_abs1, is_abs2;
413 is_abs1 = is_absolute_path(path1);
414 is_abs2 = is_absolute_path(path2);
415 return (is_abs1 && is_abs2 && tolower(path1[0]) == tolower(path2[0])) ||
416 (!is_abs1 && !is_abs2);
420 * Give path as relative to prefix.
422 * The strbuf may or may not be used, so do not assume it contains the
425 const char *relative_path(const char *in, const char *prefix,
428 int in_len = in ? strlen(in) : 0;
429 int prefix_len = prefix ? strlen(prefix) : 0;
436 else if (!prefix_len)
439 if (have_same_root(in, prefix)) {
440 /* bypass dos_drive, for "c:" is identical to "C:" */
441 if (has_dos_drive_prefix(in)) {
449 while (i < prefix_len && j < in_len && prefix[i] == in[j]) {
450 if (is_dir_sep(prefix[i])) {
451 while (is_dir_sep(prefix[i]))
453 while (is_dir_sep(in[j]))
464 /* "prefix" seems like prefix of "in" */
467 * but "/foo" is not a prefix of "/foobar"
468 * (i.e. prefix not end with '/')
470 prefix_off < prefix_len) {
472 /* in="/a/b", prefix="/a/b" */
474 } else if (is_dir_sep(in[j])) {
475 /* in="/a/b/c", prefix="/a/b" */
476 while (is_dir_sep(in[j]))
480 /* in="/a/bbb/c", prefix="/a/b" */
484 /* "in" is short than "prefix" */
486 /* "in" not end with '/' */
488 if (is_dir_sep(prefix[i])) {
489 /* in="/a/b", prefix="/a/b/c/" */
490 while (is_dir_sep(prefix[i]))
498 if (i >= prefix_len) {
506 strbuf_grow(sb, in_len);
508 while (i < prefix_len) {
509 if (is_dir_sep(prefix[i])) {
510 strbuf_addstr(sb, "../");
511 while (is_dir_sep(prefix[i]))
517 if (!is_dir_sep(prefix[prefix_len - 1]))
518 strbuf_addstr(sb, "../");
520 strbuf_addstr(sb, in);
526 * A simpler implementation of relative_path
528 * Get relative path by removing "prefix" from "in". This function
529 * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
530 * to increase performance when traversing the path to work_tree.
532 const char *remove_leading_path(const char *in, const char *prefix)
534 static char buf[PATH_MAX + 1];
537 if (!prefix || !prefix[0])
540 if (is_dir_sep(prefix[i])) {
541 if (!is_dir_sep(in[j]))
543 while (is_dir_sep(prefix[i]))
545 while (is_dir_sep(in[j]))
548 } else if (in[j] != prefix[i]) {
555 /* "/foo" is a prefix of "/foo" */
557 /* "/foo" is not a prefix of "/foobar" */
558 !is_dir_sep(prefix[i-1]) && !is_dir_sep(in[j])
561 while (is_dir_sep(in[j]))
571 * It is okay if dst == src, but they should not overlap otherwise.
573 * Performs the following normalizations on src, storing the result in dst:
574 * - Ensures that components are separated by '/' (Windows only)
575 * - Squashes sequences of '/'.
576 * - Removes "." components.
577 * - Removes ".." components, and the components the precede them.
578 * Returns failure (non-zero) if a ".." component appears as first path
579 * component anytime during the normalization. Otherwise, returns success (0).
581 * Note that this function is purely textual. It does not follow symlinks,
582 * verify the existence of the path, or make any system calls.
584 * prefix_len != NULL is for a specific case of prefix_pathspec():
585 * assume that src == dst and src[0..prefix_len-1] is already
586 * normalized, any time "../" eats up to the prefix_len part,
587 * prefix_len is reduced. In the end prefix_len is the remaining
588 * prefix that has not been overridden by user pathspec.
590 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len)
594 if (has_dos_drive_prefix(src)) {
600 if (is_dir_sep(*src)) {
602 while (is_dir_sep(*src))
610 * A path component that begins with . could be
612 * (1) "." and ends -- ignore and terminate.
613 * (2) "./" -- ignore them, eat slash and continue.
614 * (3) ".." and ends -- strip one and terminate.
615 * (4) "../" -- strip one, eat slash and continue.
621 } else if (is_dir_sep(src[1])) {
624 while (is_dir_sep(*src))
627 } else if (src[1] == '.') {
632 } else if (is_dir_sep(src[2])) {
635 while (is_dir_sep(*src))
642 /* copy up to the next '/', and eat all '/' */
643 while ((c = *src++) != '\0' && !is_dir_sep(c))
647 while (is_dir_sep(c))
656 * dst0..dst is prefix portion, and dst[-1] is '/';
659 dst--; /* go to trailing '/' */
662 /* Windows: dst[-1] cannot be backslash anymore */
663 while (dst0 < dst && dst[-1] != '/')
665 if (prefix_len && *prefix_len > dst - dst0)
666 *prefix_len = dst - dst0;
672 int normalize_path_copy(char *dst, const char *src)
674 return normalize_path_copy_len(dst, src, NULL);
678 * path = Canonical absolute path
679 * prefixes = string_list containing normalized, absolute paths without
680 * trailing slashes (except for the root directory, which is denoted by "/").
682 * Determines, for each path in prefixes, whether the "prefix"
683 * is an ancestor directory of path. Returns the length of the longest
684 * ancestor directory, excluding any trailing slashes, or -1 if no prefix
685 * is an ancestor. (Note that this means 0 is returned if prefixes is
686 * ["/"].) "/foo" is not considered an ancestor of "/foobar". Directories
687 * are not considered to be their own ancestors. path must be in a
688 * canonical form: empty components, or "." or ".." components are not
691 int longest_ancestor_length(const char *path, struct string_list *prefixes)
695 if (!strcmp(path, "/"))
698 for (i = 0; i < prefixes->nr; i++) {
699 const char *ceil = prefixes->items[i].string;
700 int len = strlen(ceil);
702 if (len == 1 && ceil[0] == '/')
703 len = 0; /* root matches anything, with length 0 */
704 else if (!strncmp(path, ceil, len) && path[len] == '/')
705 ; /* match of length len */
707 continue; /* no match */
716 /* strip arbitrary amount of directory separators at end of path */
717 static inline int chomp_trailing_dir_sep(const char *path, int len)
719 while (len && is_dir_sep(path[len - 1]))
725 * If path ends with suffix (complete path components), returns the
726 * part before suffix (sans trailing directory separators).
727 * Otherwise returns NULL.
729 char *strip_path_suffix(const char *path, const char *suffix)
731 int path_len = strlen(path), suffix_len = strlen(suffix);
737 if (is_dir_sep(path[path_len - 1])) {
738 if (!is_dir_sep(suffix[suffix_len - 1]))
740 path_len = chomp_trailing_dir_sep(path, path_len);
741 suffix_len = chomp_trailing_dir_sep(suffix, suffix_len);
743 else if (path[--path_len] != suffix[--suffix_len])
747 if (path_len && !is_dir_sep(path[path_len - 1]))
749 return xstrndup(path, chomp_trailing_dir_sep(path, path_len));
752 int daemon_avoid_alias(const char *p)
757 * This resurrects the belts and suspenders paranoia check by HPA
758 * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
759 * does not do getcwd() based path canonicalization.
761 * sl becomes true immediately after seeing '/' and continues to
762 * be true as long as dots continue after that without intervening
765 if (!p || (*p != '/' && *p != '~'))
775 else if (ch == '/') {
777 /* reject //, /./ and /../ */
782 if (0 < ndot && ndot < 3)
783 /* reject /.$ and /..$ */
792 else if (ch == '/') {
799 static int only_spaces_and_periods(const char *path, size_t len, size_t skip)
807 if (c != ' ' && c != '.')
813 int is_ntfs_dotgit(const char *name)
817 for (len = 0; ; len++)
818 if (!name[len] || name[len] == '\\' || is_dir_sep(name[len])) {
819 if (only_spaces_and_periods(name, len, 4) &&
820 !strncasecmp(name, ".git", 4))
822 if (only_spaces_and_periods(name, len, 5) &&
823 !strncasecmp(name, "git~1", 5))
825 if (name[len] != '\\')
832 char *xdg_config_home(const char *filename)
834 const char *home, *config_home;
837 config_home = getenv("XDG_CONFIG_HOME");
838 if (config_home && *config_home)
839 return mkpathdup("%s/git/%s", config_home, filename);
841 home = getenv("HOME");
843 return mkpathdup("%s/.config/git/%s", home, filename);