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 */
145 name = prefix_filename(prefix, strlen(prefix), arg);
148 if (!lstat(name, &st))
149 return 1; /* file exists */
150 if (errno == ENOENT || errno == ENOTDIR)
151 return 0; /* file does not exist */
152 die_errno("failed to stat '%s'", arg);
155 static void NORETURN die_verify_filename(const char *prefix,
157 int diagnose_misspelt_rev)
159 if (!diagnose_misspelt_rev)
160 die("%s: no such path in the working tree.\n"
161 "Use 'git <command> -- <path>...' to specify paths that do not exist locally.",
164 * Saying "'(icase)foo' does not exist in the index" when the
165 * user gave us ":(icase)foo" is just stupid. A magic pathspec
166 * begins with a colon and is followed by a non-alnum; do not
167 * let maybe_die_on_misspelt_object_name() even trigger.
169 if (!(arg[0] == ':' && !isalnum(arg[1])))
170 maybe_die_on_misspelt_object_name(arg, prefix);
172 /* ... or fall back the most general message. */
173 die("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
174 "Use '--' to separate paths from revisions, like this:\n"
175 "'git <command> [<revision>...] -- [<file>...]'", arg);
180 * Verify a filename that we got as an argument for a pathspec
181 * entry. Note that a filename that begins with "-" never verifies
182 * as true, because even if such a filename were to exist, we want
183 * it to be preceded by the "--" marker (or we want the user to
184 * use a format like "./-filename")
186 * The "diagnose_misspelt_rev" is used to provide a user-friendly
187 * diagnosis when dying upon finding that "name" is not a pathname.
188 * If set to 1, the diagnosis will try to diagnose "name" as an
189 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
190 * will only complain about an inexisting file.
192 * This function is typically called to check that a "file or rev"
193 * argument is unambiguous. In this case, the caller will want
194 * diagnose_misspelt_rev == 1 when verifying the first non-rev
195 * argument (which could have been a revision), and
196 * diagnose_misspelt_rev == 0 for the next ones (because we already
197 * saw a filename, there's not ambiguity anymore).
199 void verify_filename(const char *prefix,
201 int diagnose_misspelt_rev)
204 die("bad flag '%s' used after filename", arg);
205 if (check_filename(prefix, arg))
207 die_verify_filename(prefix, arg, diagnose_misspelt_rev);
211 * Opposite of the above: the command line did not have -- marker
212 * and we parsed the arg as a refname. It should not be interpretable
215 void verify_non_filename(const char *prefix, const char *arg)
217 if (!is_inside_work_tree() || is_inside_git_dir())
221 if (!check_filename(prefix, arg))
223 die("ambiguous argument '%s': both revision and filename\n"
224 "Use '--' to separate paths from revisions, like this:\n"
225 "'git <command> [<revision>...] -- [<file>...]'", arg);
230 * Test if it looks like we're at a git directory.
233 * - either an objects/ directory _or_ the proper
234 * GIT_OBJECT_DIRECTORY environment variable
235 * - a refs/ directory
236 * - either a HEAD symlink or a HEAD file that is formatted as
237 * a proper "ref:", or a regular file HEAD that has a properly
238 * formatted sha1 object name.
240 int is_git_directory(const char *suspect)
243 size_t len = strlen(suspect);
245 if (PATH_MAX <= len + strlen("/objects"))
246 die("Too long path: %.*s", 60, suspect);
247 strcpy(path, suspect);
248 if (getenv(DB_ENVIRONMENT)) {
249 if (access(getenv(DB_ENVIRONMENT), X_OK))
253 strcpy(path + len, "/objects");
254 if (access(path, X_OK))
258 strcpy(path + len, "/refs");
259 if (access(path, X_OK))
262 strcpy(path + len, "/HEAD");
263 if (validate_headref(path))
269 int is_inside_git_dir(void)
271 if (inside_git_dir < 0)
272 inside_git_dir = is_inside_dir(get_git_dir());
273 return inside_git_dir;
276 int is_inside_work_tree(void)
278 if (inside_work_tree < 0)
279 inside_work_tree = is_inside_dir(get_git_work_tree());
280 return inside_work_tree;
283 void setup_work_tree(void)
285 const char *work_tree, *git_dir;
286 static int initialized = 0;
291 if (work_tree_config_is_bogus)
292 die("unable to set up work tree using invalid config");
294 work_tree = get_git_work_tree();
295 git_dir = get_git_dir();
296 if (!is_absolute_path(git_dir))
297 git_dir = real_path(get_git_dir());
298 if (!work_tree || chdir(work_tree))
299 die("This operation must be run in a work tree");
302 * Make sure subsequent git processes find correct worktree
303 * if $GIT_WORK_TREE is set relative
305 if (getenv(GIT_WORK_TREE_ENVIRONMENT))
306 setenv(GIT_WORK_TREE_ENVIRONMENT, ".", 1);
308 set_git_dir(remove_leading_path(git_dir, work_tree));
312 static int check_repository_format_gently(const char *gitdir, int *nongit_ok)
314 char repo_config[PATH_MAX+1];
317 * git_config() can't be used here because it calls git_pathdup()
318 * to get $GIT_CONFIG/config. That call will make setup_git_env()
319 * set git_dir to ".git".
321 * We are in gitdir setup, no git dir has been found useable yet.
322 * Use a gentler version of git_config() to check if this repo
325 snprintf(repo_config, PATH_MAX, "%s/config", gitdir);
326 git_config_early(check_repository_format_version, NULL, repo_config);
327 if (GIT_REPO_VERSION < repository_format_version) {
329 die ("Expected git repo version <= %d, found %d",
330 GIT_REPO_VERSION, repository_format_version);
331 warning("Expected git repo version <= %d, found %d",
332 GIT_REPO_VERSION, repository_format_version);
333 warning("Please upgrade Git");
341 * Try to read the location of the git directory from the .git file,
342 * return path to git directory if found.
344 const char *read_gitfile(const char *path)
355 if (!S_ISREG(st.st_mode))
357 fd = open(path, O_RDONLY);
359 die_errno("Error opening '%s'", path);
360 buf = xmalloc(st.st_size + 1);
361 len = read_in_full(fd, buf, st.st_size);
363 if (len != st.st_size)
364 die("Error reading %s", path);
366 if (!starts_with(buf, "gitdir: "))
367 die("Invalid gitfile format: %s", path);
368 while (buf[len - 1] == '\n' || buf[len - 1] == '\r')
371 die("No path in gitfile: %s", path);
375 if (!is_absolute_path(dir) && (slash = strrchr(path, '/'))) {
376 size_t pathlen = slash+1 - path;
377 size_t dirlen = pathlen + len - 8;
378 dir = xmalloc(dirlen + 1);
379 strncpy(dir, path, pathlen);
380 strncpy(dir + pathlen, buf + 8, len - 8);
386 if (!is_git_directory(dir))
387 die("Not a git repository: %s", dir);
388 path = real_path(dir);
394 static const char *setup_explicit_git_dir(const char *gitdirenv,
398 const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
399 const char *worktree;
403 if (PATH_MAX - 40 < strlen(gitdirenv))
404 die("'$%s' too big", GIT_DIR_ENVIRONMENT);
406 gitfile = (char*)read_gitfile(gitdirenv);
408 gitfile = xstrdup(gitfile);
412 if (!is_git_directory(gitdirenv)) {
418 die("Not a git repository: '%s'", gitdirenv);
421 if (check_repository_format_gently(gitdirenv, nongit_ok)) {
426 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
428 set_git_work_tree(work_tree_env);
429 else if (is_bare_repository_cfg > 0) {
430 if (git_work_tree_cfg) {
432 warning("core.bare and core.worktree do not make sense");
433 work_tree_config_is_bogus = 1;
437 set_git_dir(gitdirenv);
441 else if (git_work_tree_cfg) { /* #6, #14 */
442 if (is_absolute_path(git_work_tree_cfg))
443 set_git_work_tree(git_work_tree_cfg);
446 if (chdir(gitdirenv))
447 die_errno("Could not chdir to '%s'", gitdirenv);
448 if (chdir(git_work_tree_cfg))
449 die_errno("Could not chdir to '%s'", git_work_tree_cfg);
450 core_worktree = xgetcwd();
452 die_errno("Could not come back to cwd");
453 set_git_work_tree(core_worktree);
457 else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, 1)) {
459 set_git_dir(gitdirenv);
464 set_git_work_tree(".");
466 /* set_git_work_tree() must have been called by now */
467 worktree = get_git_work_tree();
469 /* both get_git_work_tree() and cwd are already normalized */
470 if (!strcmp(cwd->buf, worktree)) { /* cwd == worktree */
471 set_git_dir(gitdirenv);
476 offset = dir_inside_of(cwd->buf, worktree);
477 if (offset >= 0) { /* cwd inside worktree? */
478 set_git_dir(real_path(gitdirenv));
480 die_errno("Could not chdir to '%s'", worktree);
481 strbuf_addch(cwd, '/');
483 return cwd->buf + offset;
486 /* cwd outside worktree */
487 set_git_dir(gitdirenv);
492 static const char *setup_discovered_git_dir(const char *gitdir,
493 struct strbuf *cwd, int offset,
496 if (check_repository_format_gently(gitdir, nongit_ok))
499 /* --work-tree is set without --git-dir; use discovered one */
500 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
501 if (offset != cwd->len && !is_absolute_path(gitdir))
502 gitdir = xstrdup(real_path(gitdir));
504 die_errno("Could not come back to cwd");
505 return setup_explicit_git_dir(gitdir, cwd, nongit_ok);
508 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
509 if (is_bare_repository_cfg > 0) {
510 set_git_dir(offset == cwd->len ? gitdir : real_path(gitdir));
512 die_errno("Could not come back to cwd");
516 /* #0, #1, #5, #8, #9, #12, #13 */
517 set_git_work_tree(".");
518 if (strcmp(gitdir, DEFAULT_GIT_DIR_ENVIRONMENT))
521 inside_work_tree = 1;
522 if (offset == cwd->len)
525 /* Make "offset" point to past the '/', and add a '/' at the end */
527 strbuf_addch(cwd, '/');
528 return cwd->buf + offset;
531 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
532 static const char *setup_bare_git_dir(struct strbuf *cwd, int offset,
537 if (check_repository_format_gently(".", nongit_ok))
540 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
542 /* --work-tree is set without --git-dir; use discovered one */
543 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
546 gitdir = offset == cwd->len ? "." : xmemdupz(cwd->buf, offset);
548 die_errno("Could not come back to cwd");
549 return setup_explicit_git_dir(gitdir, cwd, nongit_ok);
553 inside_work_tree = 0;
554 if (offset != cwd->len) {
556 die_errno("Cannot come back to cwd");
557 root_len = offset_1st_component(cwd->buf);
558 strbuf_setlen(cwd, offset > root_len ? offset : root_len);
559 set_git_dir(cwd->buf);
566 static const char *setup_nongit(const char *cwd, int *nongit_ok)
569 die("Not a git repository (or any of the parent directories): %s", DEFAULT_GIT_DIR_ENVIRONMENT);
571 die_errno("Cannot come back to cwd");
576 static dev_t get_device_or_die(const char *path, const char *prefix, int prefix_len)
579 if (stat(path, &buf)) {
580 die_errno("failed to stat '%*s%s%s'",
582 prefix ? prefix : "",
583 prefix ? "/" : "", path);
589 * A "string_list_each_func_t" function that canonicalizes an entry
590 * from GIT_CEILING_DIRECTORIES using real_path_if_valid(), or
591 * discards it if unusable. The presence of an empty entry in
592 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
593 * subsequent entries.
595 static int canonicalize_ceiling_entry(struct string_list_item *item,
598 int *empty_entry_found = cb_data;
599 char *ceil = item->string;
602 *empty_entry_found = 1;
604 } else if (!is_absolute_path(ceil)) {
606 } else if (*empty_entry_found) {
607 /* Keep entry but do not canonicalize it */
610 const char *real_path = real_path_if_valid(ceil);
614 item->string = xstrdup(real_path);
620 * We cannot decide in this function whether we are in the work tree or
621 * not, since the config can only be read _after_ this function was called.
623 static const char *setup_git_directory_gently_1(int *nongit_ok)
625 const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
626 struct string_list ceiling_dirs = STRING_LIST_INIT_DUP;
627 static struct strbuf cwd = STRBUF_INIT;
628 const char *gitdirenv, *ret;
630 int offset, offset_parent, ceil_offset = -1;
631 dev_t current_device = 0;
632 int one_filesystem = 1;
635 * We may have read an incomplete configuration before
636 * setting-up the git directory. If so, clear the cache so
637 * that the next queries to the configuration reload complete
638 * configuration (including the per-repo config file that we
639 * ignored previously).
644 * Let's assume that we are in a git repository.
645 * If it turns out later that we are somewhere else, the value will be
646 * updated accordingly.
651 if (strbuf_getcwd(&cwd))
652 die_errno("Unable to read current working directory");
656 * If GIT_DIR is set explicitly, we're not going
657 * to do any discovery, but we still do repository
660 gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
662 return setup_explicit_git_dir(gitdirenv, &cwd, nongit_ok);
664 if (env_ceiling_dirs) {
665 int empty_entry_found = 0;
667 string_list_split(&ceiling_dirs, env_ceiling_dirs, PATH_SEP, -1);
668 filter_string_list(&ceiling_dirs, 0,
669 canonicalize_ceiling_entry, &empty_entry_found);
670 ceil_offset = longest_ancestor_length(cwd.buf, &ceiling_dirs);
671 string_list_clear(&ceiling_dirs, 0);
674 if (ceil_offset < 0 && has_dos_drive_prefix(cwd.buf))
678 * Test in the following order (relative to the cwd):
679 * - .git (file containing "gitdir: <path>")
688 one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
690 current_device = get_device_or_die(".", NULL, 0);
692 gitfile = (char*)read_gitfile(DEFAULT_GIT_DIR_ENVIRONMENT);
694 gitdirenv = gitfile = xstrdup(gitfile);
696 if (is_git_directory(DEFAULT_GIT_DIR_ENVIRONMENT))
697 gitdirenv = DEFAULT_GIT_DIR_ENVIRONMENT;
701 ret = setup_discovered_git_dir(gitdirenv,
709 if (is_git_directory("."))
710 return setup_bare_git_dir(&cwd, offset, nongit_ok);
712 offset_parent = offset;
713 while (--offset_parent > ceil_offset && cwd.buf[offset_parent] != '/');
714 if (offset_parent <= ceil_offset)
715 return setup_nongit(cwd.buf, nongit_ok);
716 if (one_filesystem) {
717 dev_t parent_device = get_device_or_die("..", cwd.buf,
719 if (parent_device != current_device) {
722 die_errno("Cannot come back to cwd");
726 strbuf_setlen(&cwd, offset);
727 die("Not a git repository (or any parent up to mount point %s)\n"
728 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).",
733 strbuf_setlen(&cwd, offset);
734 die_errno("Cannot change to '%s/..'", cwd.buf);
736 offset = offset_parent;
740 const char *setup_git_directory_gently(int *nongit_ok)
744 prefix = setup_git_directory_gently_1(nongit_ok);
746 setenv(GIT_PREFIX_ENVIRONMENT, prefix, 1);
748 setenv(GIT_PREFIX_ENVIRONMENT, "", 1);
751 startup_info->have_repository = !nongit_ok || !*nongit_ok;
752 startup_info->prefix = prefix;
757 int git_config_perm(const char *var, const char *value)
765 if (!strcmp(value, "umask"))
767 if (!strcmp(value, "group"))
769 if (!strcmp(value, "all") ||
770 !strcmp(value, "world") ||
771 !strcmp(value, "everybody"))
772 return PERM_EVERYBODY;
774 /* Parse octal numbers */
775 i = strtol(value, &endptr, 8);
777 /* If not an octal number, maybe true/false? */
779 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
782 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
783 * a chmod value to restrict to.
786 case PERM_UMASK: /* 0 */
788 case OLD_PERM_GROUP: /* 1 */
790 case OLD_PERM_EVERYBODY: /* 2 */
791 return PERM_EVERYBODY;
794 /* A filemode value was given: 0xxx */
796 if ((i & 0600) != 0600)
797 die("Problem with core.sharedRepository filemode value "
798 "(0%.3o).\nThe owner of files must always have "
799 "read and write permissions.", i);
802 * Mask filemode value. Others can not get write permission.
803 * x flags for directories are handled separately.
808 int check_repository_format_version(const char *var, const char *value, void *cb)
810 if (strcmp(var, "core.repositoryformatversion") == 0)
811 repository_format_version = git_config_int(var, value);
812 else if (strcmp(var, "core.sharedrepository") == 0)
813 shared_repository = git_config_perm(var, value);
814 else if (strcmp(var, "core.bare") == 0) {
815 is_bare_repository_cfg = git_config_bool(var, value);
816 if (is_bare_repository_cfg == 1)
817 inside_work_tree = -1;
818 } else if (strcmp(var, "core.worktree") == 0) {
820 return config_error_nonbool(var);
821 free(git_work_tree_cfg);
822 git_work_tree_cfg = xstrdup(value);
823 inside_work_tree = -1;
828 int check_repository_format(void)
830 return check_repository_format_gently(get_git_dir(), NULL);
834 * Returns the "prefix", a path to the current working directory
835 * relative to the work tree root, or NULL, if the current working
836 * directory is not a strict subdirectory of the work tree root. The
837 * prefix always ends with a '/' character.
839 const char *setup_git_directory(void)
841 return setup_git_directory_gently(NULL);
844 const char *resolve_gitdir(const char *suspect)
846 if (is_git_directory(suspect))
848 return read_gitfile(suspect);
851 /* if any standard file descriptor is missing open it to /dev/null */
852 void sanitize_stdfds(void)
854 int fd = open("/dev/null", O_RDWR, 0);
855 while (fd != -1 && fd < 2)
858 die_errno("open /dev/null or dup failed");
865 #ifdef NO_POSIX_GOODIES
873 die_errno("fork failed");
878 die_errno("setsid failed");