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);
155 *xdg = mkpathdup("%s/git/%s", xdg_home, file);
161 char *git_path_submodule(const char *path, const char *fmt, ...)
163 char *pathname = get_pathname();
164 struct strbuf buf = STRBUF_INIT;
170 if (len > PATH_MAX-100)
173 strbuf_addstr(&buf, path);
174 if (len && path[len-1] != '/')
175 strbuf_addch(&buf, '/');
176 strbuf_addstr(&buf, ".git");
178 git_dir = read_gitfile(buf.buf);
181 strbuf_addstr(&buf, git_dir);
183 strbuf_addch(&buf, '/');
185 if (buf.len >= PATH_MAX)
187 memcpy(pathname, buf.buf, buf.len + 1);
189 strbuf_release(&buf);
190 len = strlen(pathname);
193 len += vsnprintf(pathname + len, PATH_MAX - len, fmt, args);
197 return cleanup_path(pathname);
200 int validate_headref(const char *path)
203 char *buf, buffer[256];
204 unsigned char sha1[20];
208 if (lstat(path, &st) < 0)
211 /* Make sure it is a "refs/.." symlink */
212 if (S_ISLNK(st.st_mode)) {
213 len = readlink(path, buffer, sizeof(buffer)-1);
214 if (len >= 5 && !memcmp("refs/", buffer, 5))
220 * Anything else, just open it and try to see if it is a symbolic ref.
222 fd = open(path, O_RDONLY);
225 len = read_in_full(fd, buffer, sizeof(buffer)-1);
229 * Is it a symbolic ref?
233 if (!memcmp("ref:", buffer, 4)) {
236 while (len && isspace(*buf))
238 if (len >= 5 && !memcmp("refs/", buf, 5))
243 * Is this a detached HEAD?
245 if (!get_sha1_hex(buffer, sha1))
251 static struct passwd *getpw_str(const char *username, size_t len)
254 char *username_z = xmemdupz(username, len);
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 *to_copy = path;
272 if (path[0] == '~') {
273 const char *first_slash = strchrnul(path, '/');
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_addstr(&user_path, home);
282 struct passwd *pw = getpw_str(username, username_len);
285 strbuf_addstr(&user_path, pw->pw_dir);
287 to_copy = first_slash;
289 strbuf_addstr(&user_path, 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 check "%s/.git", "%s", "%s.git/.git", "%s.git"
307 * in this order. We select the first one that is a valid git repository, and
308 * chdir() to it. If none match, or we fail to chdir, we return NULL.
310 * If all goes well, we return the directory we used to chdir() (but
311 * before ~user is expanded), avoiding getcwd() resolving symbolic
312 * links. User relative paths are also returned as they are given,
313 * except DWIM suffixing.
315 const char *enter_repo(const char *path, int strict)
317 static char used_path[PATH_MAX];
318 static char validated_path[PATH_MAX];
324 static const char *suffix[] = {
325 "/.git", "", ".git/.git", ".git", NULL,
328 int len = strlen(path);
330 while ((1 < len) && (path[len-1] == '/'))
335 strncpy(used_path, path, len); used_path[len] = 0 ;
336 strcpy(validated_path, used_path);
338 if (used_path[0] == '~') {
339 char *newpath = expand_user_path(used_path);
340 if (!newpath || (PATH_MAX - 10 < strlen(newpath))) {
345 * Copy back into the static buffer. A pity
346 * since newpath was not bounded, but other
347 * branches of the if are limited by PATH_MAX
350 strcpy(used_path, newpath); free(newpath);
352 else if (PATH_MAX - 10 < len)
354 len = strlen(used_path);
355 for (i = 0; suffix[i]; i++) {
357 strcpy(used_path + len, suffix[i]);
358 if (!stat(used_path, &st) &&
359 (S_ISREG(st.st_mode) ||
360 (S_ISDIR(st.st_mode) && is_git_directory(used_path)))) {
361 strcat(validated_path, suffix[i]);
367 gitfile = read_gitfile(used_path) ;
369 strcpy(used_path, gitfile);
370 if (chdir(used_path))
372 path = validated_path;
374 else if (chdir(path))
377 if (access("objects", X_OK) == 0 && access("refs", X_OK) == 0 &&
378 validate_headref("HEAD") == 0) {
380 check_repository_format();
387 static int calc_shared_perm(int mode)
391 if (shared_repository < 0)
392 tweak = -shared_repository;
394 tweak = shared_repository;
396 if (!(mode & S_IWUSR))
399 /* Copy read bits to execute bits */
400 tweak |= (tweak & 0444) >> 2;
401 if (shared_repository < 0)
402 mode = (mode & ~0777) | tweak;
410 int adjust_shared_perm(const char *path)
412 int old_mode, new_mode;
414 if (!shared_repository)
416 if (get_st_mode_bits(path, &old_mode) < 0)
419 new_mode = calc_shared_perm(old_mode);
420 if (S_ISDIR(old_mode)) {
421 /* Copy read bits to execute bits */
422 new_mode |= (new_mode & 0444) >> 2;
423 new_mode |= FORCE_DIR_SET_GID;
426 if (((old_mode ^ new_mode) & ~S_IFMT) &&
427 chmod(path, (new_mode & ~S_IFMT)) < 0)
432 static int have_same_root(const char *path1, const char *path2)
434 int is_abs1, is_abs2;
436 is_abs1 = is_absolute_path(path1);
437 is_abs2 = is_absolute_path(path2);
438 return (is_abs1 && is_abs2 && tolower(path1[0]) == tolower(path2[0])) ||
439 (!is_abs1 && !is_abs2);
443 * Give path as relative to prefix.
445 * The strbuf may or may not be used, so do not assume it contains the
448 const char *relative_path(const char *in, const char *prefix,
451 int in_len = in ? strlen(in) : 0;
452 int prefix_len = prefix ? strlen(prefix) : 0;
459 else if (!prefix_len)
462 if (have_same_root(in, prefix)) {
463 /* bypass dos_drive, for "c:" is identical to "C:" */
464 if (has_dos_drive_prefix(in)) {
472 while (i < prefix_len && j < in_len && prefix[i] == in[j]) {
473 if (is_dir_sep(prefix[i])) {
474 while (is_dir_sep(prefix[i]))
476 while (is_dir_sep(in[j]))
487 /* "prefix" seems like prefix of "in" */
490 * but "/foo" is not a prefix of "/foobar"
491 * (i.e. prefix not end with '/')
493 prefix_off < prefix_len) {
495 /* in="/a/b", prefix="/a/b" */
497 } else if (is_dir_sep(in[j])) {
498 /* in="/a/b/c", prefix="/a/b" */
499 while (is_dir_sep(in[j]))
503 /* in="/a/bbb/c", prefix="/a/b" */
507 /* "in" is short than "prefix" */
509 /* "in" not end with '/' */
511 if (is_dir_sep(prefix[i])) {
512 /* in="/a/b", prefix="/a/b/c/" */
513 while (is_dir_sep(prefix[i]))
521 if (i >= prefix_len) {
529 strbuf_grow(sb, in_len);
531 while (i < prefix_len) {
532 if (is_dir_sep(prefix[i])) {
533 strbuf_addstr(sb, "../");
534 while (is_dir_sep(prefix[i]))
540 if (!is_dir_sep(prefix[prefix_len - 1]))
541 strbuf_addstr(sb, "../");
543 strbuf_addstr(sb, in);
549 * A simpler implementation of relative_path
551 * Get relative path by removing "prefix" from "in". This function
552 * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
553 * to increase performance when traversing the path to work_tree.
555 const char *remove_leading_path(const char *in, const char *prefix)
557 static char buf[PATH_MAX + 1];
560 if (!prefix || !prefix[0])
563 if (is_dir_sep(prefix[i])) {
564 if (!is_dir_sep(in[j]))
566 while (is_dir_sep(prefix[i]))
568 while (is_dir_sep(in[j]))
571 } else if (in[j] != prefix[i]) {
578 /* "/foo" is a prefix of "/foo" */
580 /* "/foo" is not a prefix of "/foobar" */
581 !is_dir_sep(prefix[i-1]) && !is_dir_sep(in[j])
584 while (is_dir_sep(in[j]))
594 * It is okay if dst == src, but they should not overlap otherwise.
596 * Performs the following normalizations on src, storing the result in dst:
597 * - Ensures that components are separated by '/' (Windows only)
598 * - Squashes sequences of '/'.
599 * - Removes "." components.
600 * - Removes ".." components, and the components the precede them.
601 * Returns failure (non-zero) if a ".." component appears as first path
602 * component anytime during the normalization. Otherwise, returns success (0).
604 * Note that this function is purely textual. It does not follow symlinks,
605 * verify the existence of the path, or make any system calls.
607 * prefix_len != NULL is for a specific case of prefix_pathspec():
608 * assume that src == dst and src[0..prefix_len-1] is already
609 * normalized, any time "../" eats up to the prefix_len part,
610 * prefix_len is reduced. In the end prefix_len is the remaining
611 * prefix that has not been overridden by user pathspec.
613 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len)
617 if (has_dos_drive_prefix(src)) {
623 if (is_dir_sep(*src)) {
625 while (is_dir_sep(*src))
633 * A path component that begins with . could be
635 * (1) "." and ends -- ignore and terminate.
636 * (2) "./" -- ignore them, eat slash and continue.
637 * (3) ".." and ends -- strip one and terminate.
638 * (4) "../" -- strip one, eat slash and continue.
644 } else if (is_dir_sep(src[1])) {
647 while (is_dir_sep(*src))
650 } else if (src[1] == '.') {
655 } else if (is_dir_sep(src[2])) {
658 while (is_dir_sep(*src))
665 /* copy up to the next '/', and eat all '/' */
666 while ((c = *src++) != '\0' && !is_dir_sep(c))
670 while (is_dir_sep(c))
679 * dst0..dst is prefix portion, and dst[-1] is '/';
682 dst--; /* go to trailing '/' */
685 /* Windows: dst[-1] cannot be backslash anymore */
686 while (dst0 < dst && dst[-1] != '/')
688 if (prefix_len && *prefix_len > dst - dst0)
689 *prefix_len = dst - dst0;
695 int normalize_path_copy(char *dst, const char *src)
697 return normalize_path_copy_len(dst, src, NULL);
701 * path = Canonical absolute path
702 * prefixes = string_list containing normalized, absolute paths without
703 * trailing slashes (except for the root directory, which is denoted by "/").
705 * Determines, for each path in prefixes, whether the "prefix"
706 * is an ancestor directory of path. Returns the length of the longest
707 * ancestor directory, excluding any trailing slashes, or -1 if no prefix
708 * is an ancestor. (Note that this means 0 is returned if prefixes is
709 * ["/"].) "/foo" is not considered an ancestor of "/foobar". Directories
710 * are not considered to be their own ancestors. path must be in a
711 * canonical form: empty components, or "." or ".." components are not
714 int longest_ancestor_length(const char *path, struct string_list *prefixes)
718 if (!strcmp(path, "/"))
721 for (i = 0; i < prefixes->nr; i++) {
722 const char *ceil = prefixes->items[i].string;
723 int len = strlen(ceil);
725 if (len == 1 && ceil[0] == '/')
726 len = 0; /* root matches anything, with length 0 */
727 else if (!strncmp(path, ceil, len) && path[len] == '/')
728 ; /* match of length len */
730 continue; /* no match */
739 /* strip arbitrary amount of directory separators at end of path */
740 static inline int chomp_trailing_dir_sep(const char *path, int len)
742 while (len && is_dir_sep(path[len - 1]))
748 * If path ends with suffix (complete path components), returns the
749 * part before suffix (sans trailing directory separators).
750 * Otherwise returns NULL.
752 char *strip_path_suffix(const char *path, const char *suffix)
754 int path_len = strlen(path), suffix_len = strlen(suffix);
760 if (is_dir_sep(path[path_len - 1])) {
761 if (!is_dir_sep(suffix[suffix_len - 1]))
763 path_len = chomp_trailing_dir_sep(path, path_len);
764 suffix_len = chomp_trailing_dir_sep(suffix, suffix_len);
766 else if (path[--path_len] != suffix[--suffix_len])
770 if (path_len && !is_dir_sep(path[path_len - 1]))
772 return xstrndup(path, chomp_trailing_dir_sep(path, path_len));
775 int daemon_avoid_alias(const char *p)
780 * This resurrects the belts and suspenders paranoia check by HPA
781 * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
782 * does not do getcwd() based path canonicalization.
784 * sl becomes true immediately after seeing '/' and continues to
785 * be true as long as dots continue after that without intervening
788 if (!p || (*p != '/' && *p != '~'))
798 else if (ch == '/') {
800 /* reject //, /./ and /../ */
805 if (0 < ndot && ndot < 3)
806 /* reject /.$ and /..$ */
815 else if (ch == '/') {
822 static int only_spaces_and_periods(const char *path, size_t len, size_t skip)
830 if (c != ' ' && c != '.')
836 int is_ntfs_dotgit(const char *name)
840 for (len = 0; ; len++)
841 if (!name[len] || name[len] == '\\' || is_dir_sep(name[len])) {
842 if (only_spaces_and_periods(name, len, 4) &&
843 !strncasecmp(name, ".git", 4))
845 if (only_spaces_and_periods(name, len, 5) &&
846 !strncasecmp(name, "git~1", 5))
848 if (name[len] != '\\')