4 static int inside_git_dir = -1;
5 static int inside_work_tree = -1;
7 static char *prefix_path_gently(const char *prefix, int len, const char *path)
9 const char *orig = path;
11 if (is_absolute_path(orig)) {
12 const char *temp = real_path(path);
13 sanitized = xmalloc(len + strlen(temp) + 1);
14 strcpy(sanitized, temp);
16 sanitized = xmalloc(len + strlen(path) + 1);
18 memcpy(sanitized, prefix, len);
19 strcpy(sanitized + len, path);
21 if (normalize_path_copy(sanitized, sanitized))
23 if (is_absolute_path(orig)) {
24 size_t root_len, len, total;
25 const char *work_tree = get_git_work_tree();
28 len = strlen(work_tree);
29 root_len = offset_1st_component(work_tree);
30 total = strlen(sanitized) + 1;
31 if (strncmp(sanitized, work_tree, len) ||
32 (len > root_len && sanitized[len] != '\0' && sanitized[len] != '/')) {
37 if (sanitized[len] == '/')
39 memmove(sanitized, sanitized + len, total - len);
44 char *prefix_path(const char *prefix, int len, const char *path)
46 char *r = prefix_path_gently(prefix, len, path);
48 die("'%s' is outside repository", path);
52 int path_inside_repo(const char *prefix, const char *path)
54 int len = prefix ? strlen(prefix) : 0;
55 char *r = prefix_path_gently(prefix, len, path);
63 int check_filename(const char *prefix, const char *arg)
68 name = prefix ? prefix_filename(prefix, strlen(prefix), arg) : arg;
69 if (!lstat(name, &st))
70 return 1; /* file exists */
71 if (errno == ENOENT || errno == ENOTDIR)
72 return 0; /* file does not exist */
73 die_errno("failed to stat '%s'", arg);
76 static void NORETURN die_verify_filename(const char *prefix,
78 int diagnose_misspelt_rev)
80 unsigned char sha1[20];
83 if (!diagnose_misspelt_rev)
84 die("%s: no such path in the working tree.\n"
85 "Use 'git <command> -- <path>...' to specify paths that do not exist locally.",
88 * Saying "'(icase)foo' does not exist in the index" when the
89 * user gave us ":(icase)foo" is just stupid. A magic pathspec
90 * begins with a colon and is followed by a non-alnum; do not
91 * let get_sha1_with_mode_1(only_to_die=1) to even trigger.
93 if (!(arg[0] == ':' && !isalnum(arg[1])))
94 /* try a detailed diagnostic ... */
95 get_sha1_with_mode_1(arg, sha1, &mode, 1, prefix);
97 /* ... or fall back the most general message. */
98 die("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
99 "Use '--' to separate paths from revisions, like this:\n"
100 "'git <command> [<revision>...] -- [<file>...]'", arg);
105 * Verify a filename that we got as an argument for a pathspec
106 * entry. Note that a filename that begins with "-" never verifies
107 * as true, because even if such a filename were to exist, we want
108 * it to be preceded by the "--" marker (or we want the user to
109 * use a format like "./-filename")
111 * The "diagnose_misspelt_rev" is used to provide a user-friendly
112 * diagnosis when dying upon finding that "name" is not a pathname.
113 * If set to 1, the diagnosis will try to diagnose "name" as an
114 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
115 * will only complain about an inexisting file.
117 * This function is typically called to check that a "file or rev"
118 * argument is unambiguous. In this case, the caller will want
119 * diagnose_misspelt_rev == 1 when verifying the first non-rev
120 * argument (which could have been a revision), and
121 * diagnose_misspelt_rev == 0 for the next ones (because we already
122 * saw a filename, there's not ambiguity anymore).
124 void verify_filename(const char *prefix,
126 int diagnose_misspelt_rev)
129 die("bad flag '%s' used after filename", arg);
130 if (check_filename(prefix, arg))
132 die_verify_filename(prefix, arg, diagnose_misspelt_rev);
136 * Opposite of the above: the command line did not have -- marker
137 * and we parsed the arg as a refname. It should not be interpretable
140 void verify_non_filename(const char *prefix, const char *arg)
142 if (!is_inside_work_tree() || is_inside_git_dir())
146 if (!check_filename(prefix, arg))
148 die("ambiguous argument '%s': both revision and filename\n"
149 "Use '--' to separate paths from revisions, like this:\n"
150 "'git <command> [<revision>...] -- [<file>...]'", arg);
156 * NEEDSWORK: These need to be moved to dir.h or even to a new
157 * pathspec.h when we restructure get_pathspec() users to use the
158 * "struct pathspec" interface.
160 * Possible future magic semantics include stuff like:
162 * { PATHSPEC_NOGLOB, '!', "noglob" },
163 * { PATHSPEC_ICASE, '\0', "icase" },
164 * { PATHSPEC_RECURSIVE, '*', "recursive" },
165 * { PATHSPEC_REGEXP, '\0', "regexp" },
168 #define PATHSPEC_FROMTOP (1<<0)
170 static struct pathspec_magic {
172 char mnemonic; /* this cannot be ':'! */
174 } pathspec_magic[] = {
175 { PATHSPEC_FROMTOP, '/', "top" },
179 * Take an element of a pathspec and check for magic signatures.
180 * Append the result to the prefix.
182 * For now, we only parse the syntax and throw out anything other than
185 * NEEDSWORK: This needs to be rewritten when we start migrating
186 * get_pathspec() users to use the "struct pathspec" interface. For
187 * example, a pathspec element may be marked as case-insensitive, but
188 * the prefix part must always match literally, and a single stupid
189 * string cannot express such a case.
191 static const char *prefix_pathspec(const char *prefix, int prefixlen, const char *elt)
194 const char *copyfrom = elt;
198 ; /* nothing to do */
199 } else if (elt[1] == '(') {
202 for (copyfrom = elt + 2;
203 *copyfrom && *copyfrom != ')';
205 size_t len = strcspn(copyfrom, ",)");
206 if (copyfrom[len] == ')')
207 nextat = copyfrom + len;
209 nextat = copyfrom + len + 1;
212 for (i = 0; i < ARRAY_SIZE(pathspec_magic); i++)
213 if (strlen(pathspec_magic[i].name) == len &&
214 !strncmp(pathspec_magic[i].name, copyfrom, len)) {
215 magic |= pathspec_magic[i].bit;
218 if (ARRAY_SIZE(pathspec_magic) <= i)
219 die("Invalid pathspec magic '%.*s' in '%s'",
220 (int) len, copyfrom, elt);
222 if (*copyfrom == ')')
226 for (copyfrom = elt + 1;
227 *copyfrom && *copyfrom != ':';
231 if (!is_pathspec_magic(ch))
233 for (i = 0; i < ARRAY_SIZE(pathspec_magic); i++)
234 if (pathspec_magic[i].mnemonic == ch) {
235 magic |= pathspec_magic[i].bit;
238 if (ARRAY_SIZE(pathspec_magic) <= i)
239 die("Unimplemented pathspec magic '%c' in '%s'",
242 if (*copyfrom == ':')
246 if (magic & PATHSPEC_FROMTOP)
247 return xstrdup(copyfrom);
249 return prefix_path(prefix, prefixlen, copyfrom);
252 const char **get_pathspec(const char *prefix, const char **pathspec)
254 const char *entry = *pathspec;
255 const char **src, **dst;
258 if (!prefix && !entry)
262 static const char *spec[2];
268 /* Otherwise we have to re-write the entries.. */
271 prefixlen = prefix ? strlen(prefix) : 0;
273 *(dst++) = prefix_pathspec(prefix, prefixlen, *src);
283 * Test if it looks like we're at a git directory.
286 * - either an objects/ directory _or_ the proper
287 * GIT_OBJECT_DIRECTORY environment variable
288 * - a refs/ directory
289 * - either a HEAD symlink or a HEAD file that is formatted as
290 * a proper "ref:", or a regular file HEAD that has a properly
291 * formatted sha1 object name.
293 int is_git_directory(const char *suspect)
296 size_t len = strlen(suspect);
298 if (PATH_MAX <= len + strlen("/objects"))
299 die("Too long path: %.*s", 60, suspect);
300 strcpy(path, suspect);
301 if (getenv(DB_ENVIRONMENT)) {
302 if (access(getenv(DB_ENVIRONMENT), X_OK))
306 strcpy(path + len, "/objects");
307 if (access(path, X_OK))
311 strcpy(path + len, "/refs");
312 if (access(path, X_OK))
315 strcpy(path + len, "/HEAD");
316 if (validate_headref(path))
322 int is_inside_git_dir(void)
324 if (inside_git_dir < 0)
325 inside_git_dir = is_inside_dir(get_git_dir());
326 return inside_git_dir;
329 int is_inside_work_tree(void)
331 if (inside_work_tree < 0)
332 inside_work_tree = is_inside_dir(get_git_work_tree());
333 return inside_work_tree;
336 void setup_work_tree(void)
338 const char *work_tree, *git_dir;
339 static int initialized = 0;
343 work_tree = get_git_work_tree();
344 git_dir = get_git_dir();
345 if (!is_absolute_path(git_dir))
346 git_dir = real_path(get_git_dir());
347 if (!work_tree || chdir(work_tree))
348 die("This operation must be run in a work tree");
351 * Make sure subsequent git processes find correct worktree
352 * if $GIT_WORK_TREE is set relative
354 if (getenv(GIT_WORK_TREE_ENVIRONMENT))
355 setenv(GIT_WORK_TREE_ENVIRONMENT, ".", 1);
357 set_git_dir(relative_path(git_dir, work_tree));
361 static int check_repository_format_gently(const char *gitdir, int *nongit_ok)
363 char repo_config[PATH_MAX+1];
366 * git_config() can't be used here because it calls git_pathdup()
367 * to get $GIT_CONFIG/config. That call will make setup_git_env()
368 * set git_dir to ".git".
370 * We are in gitdir setup, no git dir has been found useable yet.
371 * Use a gentler version of git_config() to check if this repo
374 snprintf(repo_config, PATH_MAX, "%s/config", gitdir);
375 git_config_early(check_repository_format_version, NULL, repo_config);
376 if (GIT_REPO_VERSION < repository_format_version) {
378 die ("Expected git repo version <= %d, found %d",
379 GIT_REPO_VERSION, repository_format_version);
380 warning("Expected git repo version <= %d, found %d",
381 GIT_REPO_VERSION, repository_format_version);
382 warning("Please upgrade Git");
390 * Try to read the location of the git directory from the .git file,
391 * return path to git directory if found.
393 const char *read_gitfile(const char *path)
404 if (!S_ISREG(st.st_mode))
406 fd = open(path, O_RDONLY);
408 die_errno("Error opening '%s'", path);
409 buf = xmalloc(st.st_size + 1);
410 len = read_in_full(fd, buf, st.st_size);
412 if (len != st.st_size)
413 die("Error reading %s", path);
415 if (prefixcmp(buf, "gitdir: "))
416 die("Invalid gitfile format: %s", path);
417 while (buf[len - 1] == '\n' || buf[len - 1] == '\r')
420 die("No path in gitfile: %s", path);
424 if (!is_absolute_path(dir) && (slash = strrchr(path, '/'))) {
425 size_t pathlen = slash+1 - path;
426 size_t dirlen = pathlen + len - 8;
427 dir = xmalloc(dirlen + 1);
428 strncpy(dir, path, pathlen);
429 strncpy(dir + pathlen, buf + 8, len - 8);
435 if (!is_git_directory(dir))
436 die("Not a git repository: %s", dir);
437 path = real_path(dir);
443 static const char *setup_explicit_git_dir(const char *gitdirenv,
447 const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
448 const char *worktree;
452 if (PATH_MAX - 40 < strlen(gitdirenv))
453 die("'$%s' too big", GIT_DIR_ENVIRONMENT);
455 gitfile = (char*)read_gitfile(gitdirenv);
457 gitfile = xstrdup(gitfile);
461 if (!is_git_directory(gitdirenv)) {
467 die("Not a git repository: '%s'", gitdirenv);
470 if (check_repository_format_gently(gitdirenv, nongit_ok)) {
475 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
477 set_git_work_tree(work_tree_env);
478 else if (is_bare_repository_cfg > 0) {
479 if (git_work_tree_cfg) /* #22.2, #30 */
480 die("core.bare and core.worktree do not make sense");
483 set_git_dir(gitdirenv);
487 else if (git_work_tree_cfg) { /* #6, #14 */
488 if (is_absolute_path(git_work_tree_cfg))
489 set_git_work_tree(git_work_tree_cfg);
491 char core_worktree[PATH_MAX];
492 if (chdir(gitdirenv))
493 die_errno("Could not chdir to '%s'", gitdirenv);
494 if (chdir(git_work_tree_cfg))
495 die_errno("Could not chdir to '%s'", git_work_tree_cfg);
496 if (!getcwd(core_worktree, PATH_MAX))
497 die_errno("Could not get directory '%s'", git_work_tree_cfg);
499 die_errno("Could not come back to cwd");
500 set_git_work_tree(core_worktree);
504 set_git_work_tree(".");
506 /* set_git_work_tree() must have been called by now */
507 worktree = get_git_work_tree();
509 /* both get_git_work_tree() and cwd are already normalized */
510 if (!strcmp(cwd, worktree)) { /* cwd == worktree */
511 set_git_dir(gitdirenv);
516 offset = dir_inside_of(cwd, worktree);
517 if (offset >= 0) { /* cwd inside worktree? */
518 set_git_dir(real_path(gitdirenv));
520 die_errno("Could not chdir to '%s'", worktree);
527 /* cwd outside worktree */
528 set_git_dir(gitdirenv);
533 static const char *setup_discovered_git_dir(const char *gitdir,
534 char *cwd, int offset, int len,
537 if (check_repository_format_gently(gitdir, nongit_ok))
540 /* --work-tree is set without --git-dir; use discovered one */
541 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
542 if (offset != len && !is_absolute_path(gitdir))
543 gitdir = xstrdup(real_path(gitdir));
545 die_errno("Could not come back to cwd");
546 return setup_explicit_git_dir(gitdir, cwd, len, nongit_ok);
549 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
550 if (is_bare_repository_cfg > 0) {
551 set_git_dir(offset == len ? gitdir : real_path(gitdir));
553 die_errno("Could not come back to cwd");
557 /* #0, #1, #5, #8, #9, #12, #13 */
558 set_git_work_tree(".");
559 if (strcmp(gitdir, DEFAULT_GIT_DIR_ENVIRONMENT))
562 inside_work_tree = 1;
566 /* Make "offset" point to past the '/', and add a '/' at the end */
573 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
574 static const char *setup_bare_git_dir(char *cwd, int offset, int len, int *nongit_ok)
578 if (check_repository_format_gently(".", nongit_ok))
581 /* --work-tree is set without --git-dir; use discovered one */
582 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
585 gitdir = offset == len ? "." : xmemdupz(cwd, offset);
587 die_errno("Could not come back to cwd");
588 return setup_explicit_git_dir(gitdir, cwd, len, nongit_ok);
592 inside_work_tree = 0;
595 die_errno("Cannot come back to cwd");
596 root_len = offset_1st_component(cwd);
597 cwd[offset > root_len ? offset : root_len] = '\0';
605 static const char *setup_nongit(const char *cwd, int *nongit_ok)
608 die("Not a git repository (or any of the parent directories): %s", DEFAULT_GIT_DIR_ENVIRONMENT);
610 die_errno("Cannot come back to cwd");
615 static dev_t get_device_or_die(const char *path, const char *prefix, int prefix_len)
618 if (stat(path, &buf)) {
619 die_errno("failed to stat '%*s%s%s'",
621 prefix ? prefix : "",
622 prefix ? "/" : "", path);
628 * We cannot decide in this function whether we are in the work tree or
629 * not, since the config can only be read _after_ this function was called.
631 static const char *setup_git_directory_gently_1(int *nongit_ok)
633 const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
634 static char cwd[PATH_MAX+1];
635 const char *gitdirenv, *ret;
637 int len, offset, offset_parent, ceil_offset;
638 dev_t current_device = 0;
639 int one_filesystem = 1;
642 * Let's assume that we are in a git repository.
643 * If it turns out later that we are somewhere else, the value will be
644 * updated accordingly.
649 if (!getcwd(cwd, sizeof(cwd)-1))
650 die_errno("Unable to read current working directory");
651 offset = len = strlen(cwd);
654 * If GIT_DIR is set explicitly, we're not going
655 * to do any discovery, but we still do repository
658 gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
660 return setup_explicit_git_dir(gitdirenv, cwd, len, nongit_ok);
662 ceil_offset = longest_ancestor_length(cwd, env_ceiling_dirs);
663 if (ceil_offset < 0 && has_dos_drive_prefix(cwd))
667 * Test in the following order (relative to the cwd):
668 * - .git (file containing "gitdir: <path>")
677 one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
679 current_device = get_device_or_die(".", NULL, 0);
681 gitfile = (char*)read_gitfile(DEFAULT_GIT_DIR_ENVIRONMENT);
683 gitdirenv = gitfile = xstrdup(gitfile);
685 if (is_git_directory(DEFAULT_GIT_DIR_ENVIRONMENT))
686 gitdirenv = DEFAULT_GIT_DIR_ENVIRONMENT;
690 ret = setup_discovered_git_dir(gitdirenv,
698 if (is_git_directory("."))
699 return setup_bare_git_dir(cwd, offset, len, nongit_ok);
701 offset_parent = offset;
702 while (--offset_parent > ceil_offset && cwd[offset_parent] != '/');
703 if (offset_parent <= ceil_offset)
704 return setup_nongit(cwd, nongit_ok);
705 if (one_filesystem) {
706 dev_t parent_device = get_device_or_die("..", cwd, offset);
707 if (parent_device != current_device) {
710 die_errno("Cannot come back to cwd");
715 die("Not a git repository (or any parent up to mount point %s)\n"
716 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).", cwd);
721 die_errno("Cannot change to '%s/..'", cwd);
723 offset = offset_parent;
727 const char *setup_git_directory_gently(int *nongit_ok)
731 prefix = setup_git_directory_gently_1(nongit_ok);
733 setenv("GIT_PREFIX", prefix, 1);
735 setenv("GIT_PREFIX", "", 1);
738 startup_info->have_repository = !nongit_ok || !*nongit_ok;
739 startup_info->prefix = prefix;
744 int git_config_perm(const char *var, const char *value)
752 if (!strcmp(value, "umask"))
754 if (!strcmp(value, "group"))
756 if (!strcmp(value, "all") ||
757 !strcmp(value, "world") ||
758 !strcmp(value, "everybody"))
759 return PERM_EVERYBODY;
761 /* Parse octal numbers */
762 i = strtol(value, &endptr, 8);
764 /* If not an octal number, maybe true/false? */
766 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
769 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
770 * a chmod value to restrict to.
773 case PERM_UMASK: /* 0 */
775 case OLD_PERM_GROUP: /* 1 */
777 case OLD_PERM_EVERYBODY: /* 2 */
778 return PERM_EVERYBODY;
781 /* A filemode value was given: 0xxx */
783 if ((i & 0600) != 0600)
784 die("Problem with core.sharedRepository filemode value "
785 "(0%.3o).\nThe owner of files must always have "
786 "read and write permissions.", i);
789 * Mask filemode value. Others can not get write permission.
790 * x flags for directories are handled separately.
795 int check_repository_format_version(const char *var, const char *value, void *cb)
797 if (strcmp(var, "core.repositoryformatversion") == 0)
798 repository_format_version = git_config_int(var, value);
799 else if (strcmp(var, "core.sharedrepository") == 0)
800 shared_repository = git_config_perm(var, value);
801 else if (strcmp(var, "core.bare") == 0) {
802 is_bare_repository_cfg = git_config_bool(var, value);
803 if (is_bare_repository_cfg == 1)
804 inside_work_tree = -1;
805 } else if (strcmp(var, "core.worktree") == 0) {
807 return config_error_nonbool(var);
808 free(git_work_tree_cfg);
809 git_work_tree_cfg = xstrdup(value);
810 inside_work_tree = -1;
815 int check_repository_format(void)
817 return check_repository_format_gently(get_git_dir(), NULL);
821 * Returns the "prefix", a path to the current working directory
822 * relative to the work tree root, or NULL, if the current working
823 * directory is not a strict subdirectory of the work tree root. The
824 * prefix always ends with a '/' character.
826 const char *setup_git_directory(void)
828 return setup_git_directory_gently(NULL);
831 const char *resolve_gitdir(const char *suspect)
833 if (is_git_directory(suspect))
835 return read_gitfile(suspect);