3 #include "string-list.h"
5 static int inside_git_dir = -1;
6 static int inside_work_tree = -1;
7 static int work_tree_config_is_bogus;
10 * The input parameter must contain an absolute path, and it must already be
13 * Find the part of an absolute path that lies inside the work tree by
14 * dereferencing symlinks outside the work tree, for example:
15 * /dir1/repo/dir2/file (work tree is /dir1/repo) -> dir2/file
16 * /dir/file (work tree is /) -> dir/file
17 * /dir/symlink1/symlink2 (symlink1 points to work tree) -> symlink2
18 * /dir/repolink/file (repolink points to /dir/repo) -> file
19 * /dir/repo (exactly equal to work tree) -> (empty string)
21 static int abspath_part_inside_repo(char *path)
27 const char *work_tree = get_git_work_tree();
31 wtlen = strlen(work_tree);
33 off = offset_1st_component(path);
35 /* check if work tree is already the prefix */
36 if (wtlen <= len && !strncmp(path, work_tree, wtlen)) {
37 if (path[wtlen] == '/') {
38 memmove(path, path + wtlen + 1, len - wtlen);
40 } else if (path[wtlen - 1] == '/' || path[wtlen] == '\0') {
41 /* work tree is the root, or the whole path */
42 memmove(path, path + wtlen, len - wtlen + 1);
45 /* work tree might match beginning of a symlink to work tree */
51 /* check each '/'-terminated level */
56 if (strcmp(real_path(path0), work_tree) == 0) {
57 memmove(path0, path + 1, len - (path - path0));
64 /* check whole path */
65 if (strcmp(real_path(path0), work_tree) == 0) {
74 * Normalize "path", prepending the "prefix" for relative paths. If
75 * remaining_prefix is not NULL, return the actual prefix still
76 * remains in the path. For example, prefix = sub1/sub2/ and path is
78 * foo -> sub1/sub2/foo (full prefix)
79 * ../foo -> sub1/foo (remaining prefix is sub1/)
80 * ../../bar -> bar (no remaining prefix)
81 * ../../sub1/sub2/foo -> sub1/sub2/foo (but no remaining prefix)
82 * `pwd`/../bar -> sub1/bar (no remaining prefix)
84 char *prefix_path_gently(const char *prefix, int len,
85 int *remaining_prefix, const char *path)
87 const char *orig = path;
89 if (is_absolute_path(orig)) {
90 sanitized = xmalloc(strlen(path) + 1);
92 *remaining_prefix = 0;
93 if (normalize_path_copy_len(sanitized, path, remaining_prefix)) {
97 if (abspath_part_inside_repo(sanitized)) {
102 sanitized = xmalloc(len + strlen(path) + 1);
104 memcpy(sanitized, prefix, len);
105 strcpy(sanitized + len, path);
106 if (remaining_prefix)
107 *remaining_prefix = len;
108 if (normalize_path_copy_len(sanitized, sanitized, remaining_prefix)) {
116 char *prefix_path(const char *prefix, int len, const char *path)
118 char *r = prefix_path_gently(prefix, len, NULL, path);
120 die("'%s' is outside repository", path);
124 int path_inside_repo(const char *prefix, const char *path)
126 int len = prefix ? strlen(prefix) : 0;
127 char *r = prefix_path_gently(prefix, len, NULL, path);
135 int check_filename(const char *prefix, const char *arg)
140 if (starts_with(arg, ":/")) {
141 if (arg[2] == '\0') /* ":/" is root dir, always exists */
144 } else if (!no_wildcard(arg))
147 name = prefix_filename(prefix, strlen(prefix), arg);
150 if (!lstat(name, &st))
151 return 1; /* file exists */
152 if (errno == ENOENT || errno == ENOTDIR)
153 return 0; /* file does not exist */
154 die_errno("failed to stat '%s'", arg);
157 static void NORETURN die_verify_filename(const char *prefix,
159 int diagnose_misspelt_rev)
161 if (!diagnose_misspelt_rev)
162 die("%s: no such path in the working tree.\n"
163 "Use 'git <command> -- <path>...' to specify paths that do not exist locally.",
166 * Saying "'(icase)foo' does not exist in the index" when the
167 * user gave us ":(icase)foo" is just stupid. A magic pathspec
168 * begins with a colon and is followed by a non-alnum; do not
169 * let maybe_die_on_misspelt_object_name() even trigger.
171 if (!(arg[0] == ':' && !isalnum(arg[1])))
172 maybe_die_on_misspelt_object_name(arg, prefix);
174 /* ... or fall back the most general message. */
175 die("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
176 "Use '--' to separate paths from revisions, like this:\n"
177 "'git <command> [<revision>...] -- [<file>...]'", arg);
182 * Verify a filename that we got as an argument for a pathspec
183 * entry. Note that a filename that begins with "-" never verifies
184 * as true, because even if such a filename were to exist, we want
185 * it to be preceded by the "--" marker (or we want the user to
186 * use a format like "./-filename")
188 * The "diagnose_misspelt_rev" is used to provide a user-friendly
189 * diagnosis when dying upon finding that "name" is not a pathname.
190 * If set to 1, the diagnosis will try to diagnose "name" as an
191 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
192 * will only complain about an inexisting file.
194 * This function is typically called to check that a "file or rev"
195 * argument is unambiguous. In this case, the caller will want
196 * diagnose_misspelt_rev == 1 when verifying the first non-rev
197 * argument (which could have been a revision), and
198 * diagnose_misspelt_rev == 0 for the next ones (because we already
199 * saw a filename, there's not ambiguity anymore).
201 void verify_filename(const char *prefix,
203 int diagnose_misspelt_rev)
206 die("bad flag '%s' used after filename", arg);
207 if (check_filename(prefix, arg))
209 die_verify_filename(prefix, arg, diagnose_misspelt_rev);
213 * Opposite of the above: the command line did not have -- marker
214 * and we parsed the arg as a refname. It should not be interpretable
217 void verify_non_filename(const char *prefix, const char *arg)
219 if (!is_inside_work_tree() || is_inside_git_dir())
223 if (!check_filename(prefix, arg))
225 die("ambiguous argument '%s': both revision and filename\n"
226 "Use '--' to separate paths from revisions, like this:\n"
227 "'git <command> [<revision>...] -- [<file>...]'", arg);
230 int get_common_dir(struct strbuf *sb, const char *gitdir)
232 struct strbuf data = STRBUF_INIT;
233 struct strbuf path = STRBUF_INIT;
234 const char *git_common_dir = getenv(GIT_COMMON_DIR_ENVIRONMENT);
236 if (git_common_dir) {
237 strbuf_addstr(sb, git_common_dir);
240 strbuf_addf(&path, "%s/commondir", gitdir);
241 if (file_exists(path.buf)) {
242 if (strbuf_read_file(&data, path.buf, 0) <= 0)
243 die_errno(_("failed to read %s"), path.buf);
244 while (data.len && (data.buf[data.len - 1] == '\n' ||
245 data.buf[data.len - 1] == '\r'))
247 data.buf[data.len] = '\0';
249 if (!is_absolute_path(data.buf))
250 strbuf_addf(&path, "%s/", gitdir);
251 strbuf_addbuf(&path, &data);
252 strbuf_addstr(sb, real_path(path.buf));
255 strbuf_addstr(sb, gitdir);
256 strbuf_release(&data);
257 strbuf_release(&path);
262 * Test if it looks like we're at a git directory.
265 * - either an objects/ directory _or_ the proper
266 * GIT_OBJECT_DIRECTORY environment variable
267 * - a refs/ directory
268 * - either a HEAD symlink or a HEAD file that is formatted as
269 * a proper "ref:", or a regular file HEAD that has a properly
270 * formatted sha1 object name.
272 int is_git_directory(const char *suspect)
274 struct strbuf path = STRBUF_INIT;
278 /* Check worktree-related signatures */
279 strbuf_addf(&path, "%s/HEAD", suspect);
280 if (validate_headref(path.buf))
284 get_common_dir(&path, suspect);
287 /* Check non-worktree-related signatures */
288 if (getenv(DB_ENVIRONMENT)) {
289 if (access(getenv(DB_ENVIRONMENT), X_OK))
293 strbuf_setlen(&path, len);
294 strbuf_addstr(&path, "/objects");
295 if (access(path.buf, X_OK))
299 strbuf_setlen(&path, len);
300 strbuf_addstr(&path, "/refs");
301 if (access(path.buf, X_OK))
306 strbuf_release(&path);
310 int is_inside_git_dir(void)
312 if (inside_git_dir < 0)
313 inside_git_dir = is_inside_dir(get_git_dir());
314 return inside_git_dir;
317 int is_inside_work_tree(void)
319 if (inside_work_tree < 0)
320 inside_work_tree = is_inside_dir(get_git_work_tree());
321 return inside_work_tree;
324 void setup_work_tree(void)
326 const char *work_tree, *git_dir;
327 static int initialized = 0;
332 if (work_tree_config_is_bogus)
333 die("unable to set up work tree using invalid config");
335 work_tree = get_git_work_tree();
336 git_dir = get_git_dir();
337 if (!is_absolute_path(git_dir))
338 git_dir = real_path(get_git_dir());
339 if (!work_tree || chdir(work_tree))
340 die("This operation must be run in a work tree");
343 * Make sure subsequent git processes find correct worktree
344 * if $GIT_WORK_TREE is set relative
346 if (getenv(GIT_WORK_TREE_ENVIRONMENT))
347 setenv(GIT_WORK_TREE_ENVIRONMENT, ".", 1);
349 set_git_dir(remove_leading_path(git_dir, work_tree));
353 static int check_repo_format(const char *var, const char *value, void *cb)
355 if (strcmp(var, "core.repositoryformatversion") == 0)
356 repository_format_version = git_config_int(var, value);
357 else if (strcmp(var, "core.sharedrepository") == 0)
358 shared_repository = git_config_perm(var, value);
362 static int check_repository_format_gently(const char *gitdir, int *nongit_ok)
364 struct strbuf sb = STRBUF_INIT;
365 const char *repo_config;
369 if (get_common_dir(&sb, gitdir))
370 fn = check_repo_format;
372 fn = check_repository_format_version;
373 strbuf_addstr(&sb, "/config");
374 repo_config = sb.buf;
377 * git_config() can't be used here because it calls git_pathdup()
378 * to get $GIT_CONFIG/config. That call will make setup_git_env()
379 * set git_dir to ".git".
381 * We are in gitdir setup, no git dir has been found useable yet.
382 * Use a gentler version of git_config() to check if this repo
385 git_config_early(fn, NULL, repo_config);
386 if (GIT_REPO_VERSION < repository_format_version) {
388 die ("Expected git repo version <= %d, found %d",
389 GIT_REPO_VERSION, repository_format_version);
390 warning("Expected git repo version <= %d, found %d",
391 GIT_REPO_VERSION, repository_format_version);
392 warning("Please upgrade Git");
400 static void update_linked_gitdir(const char *gitfile, const char *gitdir)
402 struct strbuf path = STRBUF_INIT;
405 strbuf_addf(&path, "%s/gitfile", gitdir);
406 if (stat(path.buf, &st) || st.st_mtime + 24 * 3600 < time(NULL))
407 write_file(path.buf, 0, "%s\n", gitfile);
408 strbuf_release(&path);
412 * Try to read the location of the git directory from the .git file,
413 * return path to git directory if found.
415 const char *read_gitfile(const char *path)
426 if (!S_ISREG(st.st_mode))
428 fd = open(path, O_RDONLY);
430 die_errno("Error opening '%s'", path);
431 buf = xmalloc(st.st_size + 1);
432 len = read_in_full(fd, buf, st.st_size);
434 if (len != st.st_size)
435 die("Error reading %s", path);
437 if (!starts_with(buf, "gitdir: "))
438 die("Invalid gitfile format: %s", path);
439 while (buf[len - 1] == '\n' || buf[len - 1] == '\r')
442 die("No path in gitfile: %s", path);
446 if (!is_absolute_path(dir) && (slash = strrchr(path, '/'))) {
447 size_t pathlen = slash+1 - path;
448 size_t dirlen = pathlen + len - 8;
449 dir = xmalloc(dirlen + 1);
450 strncpy(dir, path, pathlen);
451 strncpy(dir + pathlen, buf + 8, len - 8);
457 if (!is_git_directory(dir))
458 die("Not a git repository: %s", dir);
460 update_linked_gitdir(path, dir);
461 path = real_path(dir);
467 static const char *setup_explicit_git_dir(const char *gitdirenv,
471 const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
472 const char *worktree;
476 if (PATH_MAX - 40 < strlen(gitdirenv))
477 die("'$%s' too big", GIT_DIR_ENVIRONMENT);
479 gitfile = (char*)read_gitfile(gitdirenv);
481 gitfile = xstrdup(gitfile);
485 if (!is_git_directory(gitdirenv)) {
491 die("Not a git repository: '%s'", gitdirenv);
494 if (check_repository_format_gently(gitdirenv, nongit_ok)) {
499 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
501 set_git_work_tree(work_tree_env);
502 else if (is_bare_repository_cfg > 0) {
503 if (git_work_tree_cfg) {
505 warning("core.bare and core.worktree do not make sense");
506 work_tree_config_is_bogus = 1;
510 set_git_dir(gitdirenv);
514 else if (git_work_tree_cfg) { /* #6, #14 */
515 if (is_absolute_path(git_work_tree_cfg))
516 set_git_work_tree(git_work_tree_cfg);
519 if (chdir(gitdirenv))
520 die_errno("Could not chdir to '%s'", gitdirenv);
521 if (chdir(git_work_tree_cfg))
522 die_errno("Could not chdir to '%s'", git_work_tree_cfg);
523 core_worktree = xgetcwd();
525 die_errno("Could not come back to cwd");
526 set_git_work_tree(core_worktree);
530 else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, 1)) {
532 set_git_dir(gitdirenv);
537 set_git_work_tree(".");
539 /* set_git_work_tree() must have been called by now */
540 worktree = get_git_work_tree();
542 /* both get_git_work_tree() and cwd are already normalized */
543 if (!strcmp(cwd->buf, worktree)) { /* cwd == worktree */
544 set_git_dir(gitdirenv);
549 offset = dir_inside_of(cwd->buf, worktree);
550 if (offset >= 0) { /* cwd inside worktree? */
551 set_git_dir(real_path(gitdirenv));
553 die_errno("Could not chdir to '%s'", worktree);
554 strbuf_addch(cwd, '/');
556 return cwd->buf + offset;
559 /* cwd outside worktree */
560 set_git_dir(gitdirenv);
565 static const char *setup_discovered_git_dir(const char *gitdir,
566 struct strbuf *cwd, int offset,
569 if (check_repository_format_gently(gitdir, nongit_ok))
572 /* --work-tree is set without --git-dir; use discovered one */
573 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
574 if (offset != cwd->len && !is_absolute_path(gitdir))
575 gitdir = xstrdup(real_path(gitdir));
577 die_errno("Could not come back to cwd");
578 return setup_explicit_git_dir(gitdir, cwd, nongit_ok);
581 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
582 if (is_bare_repository_cfg > 0) {
583 set_git_dir(offset == cwd->len ? gitdir : real_path(gitdir));
585 die_errno("Could not come back to cwd");
589 /* #0, #1, #5, #8, #9, #12, #13 */
590 set_git_work_tree(".");
591 if (strcmp(gitdir, DEFAULT_GIT_DIR_ENVIRONMENT))
594 inside_work_tree = 1;
595 if (offset == cwd->len)
598 /* Make "offset" point to past the '/', and add a '/' at the end */
600 strbuf_addch(cwd, '/');
601 return cwd->buf + offset;
604 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
605 static const char *setup_bare_git_dir(struct strbuf *cwd, int offset,
610 if (check_repository_format_gently(".", nongit_ok))
613 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
615 /* --work-tree is set without --git-dir; use discovered one */
616 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
619 gitdir = offset == cwd->len ? "." : xmemdupz(cwd->buf, offset);
621 die_errno("Could not come back to cwd");
622 return setup_explicit_git_dir(gitdir, cwd, nongit_ok);
626 inside_work_tree = 0;
627 if (offset != cwd->len) {
629 die_errno("Cannot come back to cwd");
630 root_len = offset_1st_component(cwd->buf);
631 strbuf_setlen(cwd, offset > root_len ? offset : root_len);
632 set_git_dir(cwd->buf);
639 static const char *setup_nongit(const char *cwd, int *nongit_ok)
642 die("Not a git repository (or any of the parent directories): %s", DEFAULT_GIT_DIR_ENVIRONMENT);
644 die_errno("Cannot come back to cwd");
649 static dev_t get_device_or_die(const char *path, const char *prefix, int prefix_len)
652 if (stat(path, &buf)) {
653 die_errno("failed to stat '%*s%s%s'",
655 prefix ? prefix : "",
656 prefix ? "/" : "", path);
662 * A "string_list_each_func_t" function that canonicalizes an entry
663 * from GIT_CEILING_DIRECTORIES using real_path_if_valid(), or
664 * discards it if unusable. The presence of an empty entry in
665 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
666 * subsequent entries.
668 static int canonicalize_ceiling_entry(struct string_list_item *item,
671 int *empty_entry_found = cb_data;
672 char *ceil = item->string;
675 *empty_entry_found = 1;
677 } else if (!is_absolute_path(ceil)) {
679 } else if (*empty_entry_found) {
680 /* Keep entry but do not canonicalize it */
683 const char *real_path = real_path_if_valid(ceil);
687 item->string = xstrdup(real_path);
693 * We cannot decide in this function whether we are in the work tree or
694 * not, since the config can only be read _after_ this function was called.
696 static const char *setup_git_directory_gently_1(int *nongit_ok)
698 const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
699 struct string_list ceiling_dirs = STRING_LIST_INIT_DUP;
700 static struct strbuf cwd = STRBUF_INIT;
701 const char *gitdirenv, *ret;
703 int offset, offset_parent, ceil_offset = -1;
704 dev_t current_device = 0;
705 int one_filesystem = 1;
708 * We may have read an incomplete configuration before
709 * setting-up the git directory. If so, clear the cache so
710 * that the next queries to the configuration reload complete
711 * configuration (including the per-repo config file that we
712 * ignored previously).
717 * Let's assume that we are in a git repository.
718 * If it turns out later that we are somewhere else, the value will be
719 * updated accordingly.
724 if (strbuf_getcwd(&cwd))
725 die_errno("Unable to read current working directory");
729 * If GIT_DIR is set explicitly, we're not going
730 * to do any discovery, but we still do repository
733 gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
735 return setup_explicit_git_dir(gitdirenv, &cwd, nongit_ok);
737 if (env_ceiling_dirs) {
738 int empty_entry_found = 0;
740 string_list_split(&ceiling_dirs, env_ceiling_dirs, PATH_SEP, -1);
741 filter_string_list(&ceiling_dirs, 0,
742 canonicalize_ceiling_entry, &empty_entry_found);
743 ceil_offset = longest_ancestor_length(cwd.buf, &ceiling_dirs);
744 string_list_clear(&ceiling_dirs, 0);
747 if (ceil_offset < 0 && has_dos_drive_prefix(cwd.buf))
751 * Test in the following order (relative to the cwd):
752 * - .git (file containing "gitdir: <path>")
761 one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
763 current_device = get_device_or_die(".", NULL, 0);
765 gitfile = (char*)read_gitfile(DEFAULT_GIT_DIR_ENVIRONMENT);
767 gitdirenv = gitfile = xstrdup(gitfile);
769 if (is_git_directory(DEFAULT_GIT_DIR_ENVIRONMENT))
770 gitdirenv = DEFAULT_GIT_DIR_ENVIRONMENT;
774 ret = setup_discovered_git_dir(gitdirenv,
782 if (is_git_directory("."))
783 return setup_bare_git_dir(&cwd, offset, nongit_ok);
785 offset_parent = offset;
786 while (--offset_parent > ceil_offset && cwd.buf[offset_parent] != '/');
787 if (offset_parent <= ceil_offset)
788 return setup_nongit(cwd.buf, nongit_ok);
789 if (one_filesystem) {
790 dev_t parent_device = get_device_or_die("..", cwd.buf,
792 if (parent_device != current_device) {
795 die_errno("Cannot come back to cwd");
799 strbuf_setlen(&cwd, offset);
800 die("Not a git repository (or any parent up to mount point %s)\n"
801 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).",
806 strbuf_setlen(&cwd, offset);
807 die_errno("Cannot change to '%s/..'", cwd.buf);
809 offset = offset_parent;
813 const char *setup_git_directory_gently(int *nongit_ok)
817 prefix = setup_git_directory_gently_1(nongit_ok);
819 setenv(GIT_PREFIX_ENVIRONMENT, prefix, 1);
821 setenv(GIT_PREFIX_ENVIRONMENT, "", 1);
824 startup_info->have_repository = !nongit_ok || !*nongit_ok;
825 startup_info->prefix = prefix;
830 int git_config_perm(const char *var, const char *value)
838 if (!strcmp(value, "umask"))
840 if (!strcmp(value, "group"))
842 if (!strcmp(value, "all") ||
843 !strcmp(value, "world") ||
844 !strcmp(value, "everybody"))
845 return PERM_EVERYBODY;
847 /* Parse octal numbers */
848 i = strtol(value, &endptr, 8);
850 /* If not an octal number, maybe true/false? */
852 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
855 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
856 * a chmod value to restrict to.
859 case PERM_UMASK: /* 0 */
861 case OLD_PERM_GROUP: /* 1 */
863 case OLD_PERM_EVERYBODY: /* 2 */
864 return PERM_EVERYBODY;
867 /* A filemode value was given: 0xxx */
869 if ((i & 0600) != 0600)
870 die("Problem with core.sharedRepository filemode value "
871 "(0%.3o).\nThe owner of files must always have "
872 "read and write permissions.", i);
875 * Mask filemode value. Others can not get write permission.
876 * x flags for directories are handled separately.
881 int check_repository_format_version(const char *var, const char *value, void *cb)
883 int ret = check_repo_format(var, value, cb);
886 if (strcmp(var, "core.bare") == 0) {
887 is_bare_repository_cfg = git_config_bool(var, value);
888 if (is_bare_repository_cfg == 1)
889 inside_work_tree = -1;
890 } else if (strcmp(var, "core.worktree") == 0) {
892 return config_error_nonbool(var);
893 free(git_work_tree_cfg);
894 git_work_tree_cfg = xstrdup(value);
895 inside_work_tree = -1;
900 int check_repository_format(void)
902 return check_repository_format_gently(get_git_dir(), NULL);
906 * Returns the "prefix", a path to the current working directory
907 * relative to the work tree root, or NULL, if the current working
908 * directory is not a strict subdirectory of the work tree root. The
909 * prefix always ends with a '/' character.
911 const char *setup_git_directory(void)
913 return setup_git_directory_gently(NULL);
916 const char *resolve_gitdir(const char *suspect)
918 if (is_git_directory(suspect))
920 return read_gitfile(suspect);
923 /* if any standard file descriptor is missing open it to /dev/null */
924 void sanitize_stdfds(void)
926 int fd = open("/dev/null", O_RDWR, 0);
927 while (fd != -1 && fd < 2)
930 die_errno("open /dev/null or dup failed");
937 #ifdef NO_POSIX_GOODIES
945 die_errno("fork failed");
950 die_errno("setsid failed");