3 #include "string-list.h"
5 static int inside_git_dir = -1;
6 static int inside_work_tree = -1;
8 static char *prefix_path_gently(const char *prefix, int len, const char *path)
10 const char *orig = path;
12 if (is_absolute_path(orig)) {
13 const char *temp = real_path(path);
14 sanitized = xmalloc(len + strlen(temp) + 1);
15 strcpy(sanitized, temp);
17 sanitized = xmalloc(len + strlen(path) + 1);
19 memcpy(sanitized, prefix, len);
20 strcpy(sanitized + len, path);
22 if (normalize_path_copy(sanitized, sanitized))
24 if (is_absolute_path(orig)) {
25 size_t root_len, len, total;
26 const char *work_tree = get_git_work_tree();
29 len = strlen(work_tree);
30 root_len = offset_1st_component(work_tree);
31 total = strlen(sanitized) + 1;
32 if (strncmp(sanitized, work_tree, len) ||
33 (len > root_len && sanitized[len] != '\0' && sanitized[len] != '/')) {
38 if (sanitized[len] == '/')
40 memmove(sanitized, sanitized + len, total - len);
45 char *prefix_path(const char *prefix, int len, const char *path)
47 char *r = prefix_path_gently(prefix, len, path);
49 die("'%s' is outside repository", path);
53 int path_inside_repo(const char *prefix, const char *path)
55 int len = prefix ? strlen(prefix) : 0;
56 char *r = prefix_path_gently(prefix, len, path);
64 int check_filename(const char *prefix, const char *arg)
69 name = prefix ? prefix_filename(prefix, strlen(prefix), arg) : arg;
70 if (!lstat(name, &st))
71 return 1; /* file exists */
72 if (errno == ENOENT || errno == ENOTDIR)
73 return 0; /* file does not exist */
74 die_errno("failed to stat '%s'", arg);
77 static void NORETURN die_verify_filename(const char *prefix,
79 int diagnose_misspelt_rev)
81 if (!diagnose_misspelt_rev)
82 die("%s: no such path in the working tree.\n"
83 "Use 'git <command> -- <path>...' to specify paths that do not exist locally.",
86 * Saying "'(icase)foo' does not exist in the index" when the
87 * user gave us ":(icase)foo" is just stupid. A magic pathspec
88 * begins with a colon and is followed by a non-alnum; do not
89 * let maybe_die_on_misspelt_object_name() even trigger.
91 if (!(arg[0] == ':' && !isalnum(arg[1])))
92 maybe_die_on_misspelt_object_name(arg, prefix);
94 /* ... or fall back the most general message. */
95 die("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
96 "Use '--' to separate paths from revisions, like this:\n"
97 "'git <command> [<revision>...] -- [<file>...]'", arg);
102 * Verify a filename that we got as an argument for a pathspec
103 * entry. Note that a filename that begins with "-" never verifies
104 * as true, because even if such a filename were to exist, we want
105 * it to be preceded by the "--" marker (or we want the user to
106 * use a format like "./-filename")
108 * The "diagnose_misspelt_rev" is used to provide a user-friendly
109 * diagnosis when dying upon finding that "name" is not a pathname.
110 * If set to 1, the diagnosis will try to diagnose "name" as an
111 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
112 * will only complain about an inexisting file.
114 * This function is typically called to check that a "file or rev"
115 * argument is unambiguous. In this case, the caller will want
116 * diagnose_misspelt_rev == 1 when verifying the first non-rev
117 * argument (which could have been a revision), and
118 * diagnose_misspelt_rev == 0 for the next ones (because we already
119 * saw a filename, there's not ambiguity anymore).
121 void verify_filename(const char *prefix,
123 int diagnose_misspelt_rev)
126 die("bad flag '%s' used after filename", arg);
127 if (check_filename(prefix, arg))
129 die_verify_filename(prefix, arg, diagnose_misspelt_rev);
133 * Opposite of the above: the command line did not have -- marker
134 * and we parsed the arg as a refname. It should not be interpretable
137 void verify_non_filename(const char *prefix, const char *arg)
139 if (!is_inside_work_tree() || is_inside_git_dir())
143 if (!check_filename(prefix, arg))
145 die("ambiguous argument '%s': both revision and filename\n"
146 "Use '--' to separate paths from revisions, like this:\n"
147 "'git <command> [<revision>...] -- [<file>...]'", arg);
153 * NEEDSWORK: These need to be moved to dir.h or even to a new
154 * pathspec.h when we restructure get_pathspec() users to use the
155 * "struct pathspec" interface.
157 * Possible future magic semantics include stuff like:
159 * { PATHSPEC_NOGLOB, '!', "noglob" },
160 * { PATHSPEC_ICASE, '\0', "icase" },
161 * { PATHSPEC_RECURSIVE, '*', "recursive" },
162 * { PATHSPEC_REGEXP, '\0', "regexp" },
165 #define PATHSPEC_FROMTOP (1<<0)
167 static struct pathspec_magic {
169 char mnemonic; /* this cannot be ':'! */
171 } pathspec_magic[] = {
172 { PATHSPEC_FROMTOP, '/', "top" },
176 * Take an element of a pathspec and check for magic signatures.
177 * Append the result to the prefix.
179 * For now, we only parse the syntax and throw out anything other than
182 * NEEDSWORK: This needs to be rewritten when we start migrating
183 * get_pathspec() users to use the "struct pathspec" interface. For
184 * example, a pathspec element may be marked as case-insensitive, but
185 * the prefix part must always match literally, and a single stupid
186 * string cannot express such a case.
188 static const char *prefix_pathspec(const char *prefix, int prefixlen, const char *elt)
191 const char *copyfrom = elt;
195 ; /* nothing to do */
196 } else if (elt[1] == '(') {
199 for (copyfrom = elt + 2;
200 *copyfrom && *copyfrom != ')';
202 size_t len = strcspn(copyfrom, ",)");
203 if (copyfrom[len] == ')')
204 nextat = copyfrom + len;
206 nextat = copyfrom + len + 1;
209 for (i = 0; i < ARRAY_SIZE(pathspec_magic); i++)
210 if (strlen(pathspec_magic[i].name) == len &&
211 !strncmp(pathspec_magic[i].name, copyfrom, len)) {
212 magic |= pathspec_magic[i].bit;
215 if (ARRAY_SIZE(pathspec_magic) <= i)
216 die("Invalid pathspec magic '%.*s' in '%s'",
217 (int) len, copyfrom, elt);
219 if (*copyfrom == ')')
223 for (copyfrom = elt + 1;
224 *copyfrom && *copyfrom != ':';
228 if (!is_pathspec_magic(ch))
230 for (i = 0; i < ARRAY_SIZE(pathspec_magic); i++)
231 if (pathspec_magic[i].mnemonic == ch) {
232 magic |= pathspec_magic[i].bit;
235 if (ARRAY_SIZE(pathspec_magic) <= i)
236 die("Unimplemented pathspec magic '%c' in '%s'",
239 if (*copyfrom == ':')
243 if (magic & PATHSPEC_FROMTOP)
244 return xstrdup(copyfrom);
246 return prefix_path(prefix, prefixlen, copyfrom);
250 * N.B. get_pathspec() is deprecated in favor of the "struct pathspec"
251 * based interface - see pathspec_magic above.
254 * - prefix - a path relative to the root of the working tree
255 * - pathspec - a list of paths underneath the prefix path
257 * Iterates over pathspec, prepending each path with prefix,
258 * and return the resulting list.
260 * If pathspec is empty, return a singleton list containing prefix.
262 * If pathspec and prefix are both empty, return an empty list.
264 * This is typically used by built-in commands such as add.c, in order
265 * to normalize argv arguments provided to the built-in into a list of
266 * paths to process, all relative to the root of the working tree.
268 const char **get_pathspec(const char *prefix, const char **pathspec)
270 const char *entry = *pathspec;
271 const char **src, **dst;
274 if (!prefix && !entry)
278 static const char *spec[2];
284 /* Otherwise we have to re-write the entries.. */
287 prefixlen = prefix ? strlen(prefix) : 0;
289 *(dst++) = prefix_pathspec(prefix, prefixlen, *src);
299 * Test if it looks like we're at a git directory.
302 * - either an objects/ directory _or_ the proper
303 * GIT_OBJECT_DIRECTORY environment variable
304 * - a refs/ directory
305 * - either a HEAD symlink or a HEAD file that is formatted as
306 * a proper "ref:", or a regular file HEAD that has a properly
307 * formatted sha1 object name.
309 int is_git_directory(const char *suspect)
312 size_t len = strlen(suspect);
314 if (PATH_MAX <= len + strlen("/objects"))
315 die("Too long path: %.*s", 60, suspect);
316 strcpy(path, suspect);
317 if (getenv(DB_ENVIRONMENT)) {
318 if (access(getenv(DB_ENVIRONMENT), X_OK))
322 strcpy(path + len, "/objects");
323 if (access(path, X_OK))
327 strcpy(path + len, "/refs");
328 if (access(path, X_OK))
331 strcpy(path + len, "/HEAD");
332 if (validate_headref(path))
338 int is_inside_git_dir(void)
340 if (inside_git_dir < 0)
341 inside_git_dir = is_inside_dir(get_git_dir());
342 return inside_git_dir;
345 int is_inside_work_tree(void)
347 if (inside_work_tree < 0)
348 inside_work_tree = is_inside_dir(get_git_work_tree());
349 return inside_work_tree;
352 void setup_work_tree(void)
354 const char *work_tree, *git_dir;
355 static int initialized = 0;
359 work_tree = get_git_work_tree();
360 git_dir = get_git_dir();
361 if (!is_absolute_path(git_dir))
362 git_dir = real_path(get_git_dir());
363 if (!work_tree || chdir(work_tree))
364 die("This operation must be run in a work tree");
367 * Make sure subsequent git processes find correct worktree
368 * if $GIT_WORK_TREE is set relative
370 if (getenv(GIT_WORK_TREE_ENVIRONMENT))
371 setenv(GIT_WORK_TREE_ENVIRONMENT, ".", 1);
373 set_git_dir(relative_path(git_dir, work_tree));
377 static int check_repository_format_gently(const char *gitdir, int *nongit_ok)
379 char repo_config[PATH_MAX+1];
382 * git_config() can't be used here because it calls git_pathdup()
383 * to get $GIT_CONFIG/config. That call will make setup_git_env()
384 * set git_dir to ".git".
386 * We are in gitdir setup, no git dir has been found useable yet.
387 * Use a gentler version of git_config() to check if this repo
390 snprintf(repo_config, PATH_MAX, "%s/config", gitdir);
391 git_config_early(check_repository_format_version, NULL, repo_config);
392 if (GIT_REPO_VERSION < repository_format_version) {
394 die ("Expected git repo version <= %d, found %d",
395 GIT_REPO_VERSION, repository_format_version);
396 warning("Expected git repo version <= %d, found %d",
397 GIT_REPO_VERSION, repository_format_version);
398 warning("Please upgrade Git");
406 * Try to read the location of the git directory from the .git file,
407 * return path to git directory if found.
409 const char *read_gitfile(const char *path)
420 if (!S_ISREG(st.st_mode))
422 fd = open(path, O_RDONLY);
424 die_errno("Error opening '%s'", path);
425 buf = xmalloc(st.st_size + 1);
426 len = read_in_full(fd, buf, st.st_size);
428 if (len != st.st_size)
429 die("Error reading %s", path);
431 if (prefixcmp(buf, "gitdir: "))
432 die("Invalid gitfile format: %s", path);
433 while (buf[len - 1] == '\n' || buf[len - 1] == '\r')
436 die("No path in gitfile: %s", path);
440 if (!is_absolute_path(dir) && (slash = strrchr(path, '/'))) {
441 size_t pathlen = slash+1 - path;
442 size_t dirlen = pathlen + len - 8;
443 dir = xmalloc(dirlen + 1);
444 strncpy(dir, path, pathlen);
445 strncpy(dir + pathlen, buf + 8, len - 8);
451 if (!is_git_directory(dir))
452 die("Not a git repository: %s", dir);
453 path = real_path(dir);
459 static const char *setup_explicit_git_dir(const char *gitdirenv,
463 const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
464 const char *worktree;
468 if (PATH_MAX - 40 < strlen(gitdirenv))
469 die("'$%s' too big", GIT_DIR_ENVIRONMENT);
471 gitfile = (char*)read_gitfile(gitdirenv);
473 gitfile = xstrdup(gitfile);
477 if (!is_git_directory(gitdirenv)) {
483 die("Not a git repository: '%s'", gitdirenv);
486 if (check_repository_format_gently(gitdirenv, nongit_ok)) {
491 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
493 set_git_work_tree(work_tree_env);
494 else if (is_bare_repository_cfg > 0) {
495 if (git_work_tree_cfg) /* #22.2, #30 */
496 die("core.bare and core.worktree do not make sense");
499 set_git_dir(gitdirenv);
503 else if (git_work_tree_cfg) { /* #6, #14 */
504 if (is_absolute_path(git_work_tree_cfg))
505 set_git_work_tree(git_work_tree_cfg);
507 char core_worktree[PATH_MAX];
508 if (chdir(gitdirenv))
509 die_errno("Could not chdir to '%s'", gitdirenv);
510 if (chdir(git_work_tree_cfg))
511 die_errno("Could not chdir to '%s'", git_work_tree_cfg);
512 if (!getcwd(core_worktree, PATH_MAX))
513 die_errno("Could not get directory '%s'", git_work_tree_cfg);
515 die_errno("Could not come back to cwd");
516 set_git_work_tree(core_worktree);
520 set_git_work_tree(".");
522 /* set_git_work_tree() must have been called by now */
523 worktree = get_git_work_tree();
525 /* both get_git_work_tree() and cwd are already normalized */
526 if (!strcmp(cwd, worktree)) { /* cwd == worktree */
527 set_git_dir(gitdirenv);
532 offset = dir_inside_of(cwd, worktree);
533 if (offset >= 0) { /* cwd inside worktree? */
534 set_git_dir(real_path(gitdirenv));
536 die_errno("Could not chdir to '%s'", worktree);
543 /* cwd outside worktree */
544 set_git_dir(gitdirenv);
549 static const char *setup_discovered_git_dir(const char *gitdir,
550 char *cwd, int offset, int len,
553 if (check_repository_format_gently(gitdir, nongit_ok))
556 /* --work-tree is set without --git-dir; use discovered one */
557 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
558 if (offset != len && !is_absolute_path(gitdir))
559 gitdir = xstrdup(real_path(gitdir));
561 die_errno("Could not come back to cwd");
562 return setup_explicit_git_dir(gitdir, cwd, len, nongit_ok);
565 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
566 if (is_bare_repository_cfg > 0) {
567 set_git_dir(offset == len ? gitdir : real_path(gitdir));
569 die_errno("Could not come back to cwd");
573 /* #0, #1, #5, #8, #9, #12, #13 */
574 set_git_work_tree(".");
575 if (strcmp(gitdir, DEFAULT_GIT_DIR_ENVIRONMENT))
578 inside_work_tree = 1;
582 /* Make "offset" point to past the '/', and add a '/' at the end */
589 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
590 static const char *setup_bare_git_dir(char *cwd, int offset, int len, int *nongit_ok)
594 if (check_repository_format_gently(".", nongit_ok))
597 /* --work-tree is set without --git-dir; use discovered one */
598 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
601 gitdir = offset == len ? "." : xmemdupz(cwd, offset);
603 die_errno("Could not come back to cwd");
604 return setup_explicit_git_dir(gitdir, cwd, len, nongit_ok);
608 inside_work_tree = 0;
611 die_errno("Cannot come back to cwd");
612 root_len = offset_1st_component(cwd);
613 cwd[offset > root_len ? offset : root_len] = '\0';
621 static const char *setup_nongit(const char *cwd, int *nongit_ok)
624 die("Not a git repository (or any of the parent directories): %s", DEFAULT_GIT_DIR_ENVIRONMENT);
626 die_errno("Cannot come back to cwd");
631 static dev_t get_device_or_die(const char *path, const char *prefix, int prefix_len)
634 if (stat(path, &buf)) {
635 die_errno("failed to stat '%*s%s%s'",
637 prefix ? prefix : "",
638 prefix ? "/" : "", path);
644 * A "string_list_each_func_t" function that canonicalizes an entry
645 * from GIT_CEILING_DIRECTORIES using real_path_if_valid(), or
646 * discards it if unusable.
648 static int canonicalize_ceiling_entry(struct string_list_item *item,
651 char *ceil = item->string;
652 const char *real_path;
654 if (!*ceil || !is_absolute_path(ceil))
656 real_path = real_path_if_valid(ceil);
660 item->string = xstrdup(real_path);
665 * We cannot decide in this function whether we are in the work tree or
666 * not, since the config can only be read _after_ this function was called.
668 static const char *setup_git_directory_gently_1(int *nongit_ok)
670 const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
671 struct string_list ceiling_dirs = STRING_LIST_INIT_DUP;
672 static char cwd[PATH_MAX+1];
673 const char *gitdirenv, *ret;
675 int len, offset, offset_parent, ceil_offset = -1;
676 dev_t current_device = 0;
677 int one_filesystem = 1;
680 * Let's assume that we are in a git repository.
681 * If it turns out later that we are somewhere else, the value will be
682 * updated accordingly.
687 if (!getcwd(cwd, sizeof(cwd)-1))
688 die_errno("Unable to read current working directory");
689 offset = len = strlen(cwd);
692 * If GIT_DIR is set explicitly, we're not going
693 * to do any discovery, but we still do repository
696 gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
698 return setup_explicit_git_dir(gitdirenv, cwd, len, nongit_ok);
700 if (env_ceiling_dirs) {
701 string_list_split(&ceiling_dirs, env_ceiling_dirs, PATH_SEP, -1);
702 filter_string_list(&ceiling_dirs, 0,
703 canonicalize_ceiling_entry, NULL);
704 ceil_offset = longest_ancestor_length(cwd, &ceiling_dirs);
705 string_list_clear(&ceiling_dirs, 0);
708 if (ceil_offset < 0 && has_dos_drive_prefix(cwd))
712 * Test in the following order (relative to the cwd):
713 * - .git (file containing "gitdir: <path>")
722 one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
724 current_device = get_device_or_die(".", NULL, 0);
726 gitfile = (char*)read_gitfile(DEFAULT_GIT_DIR_ENVIRONMENT);
728 gitdirenv = gitfile = xstrdup(gitfile);
730 if (is_git_directory(DEFAULT_GIT_DIR_ENVIRONMENT))
731 gitdirenv = DEFAULT_GIT_DIR_ENVIRONMENT;
735 ret = setup_discovered_git_dir(gitdirenv,
743 if (is_git_directory("."))
744 return setup_bare_git_dir(cwd, offset, len, nongit_ok);
746 offset_parent = offset;
747 while (--offset_parent > ceil_offset && cwd[offset_parent] != '/');
748 if (offset_parent <= ceil_offset)
749 return setup_nongit(cwd, nongit_ok);
750 if (one_filesystem) {
751 dev_t parent_device = get_device_or_die("..", cwd, offset);
752 if (parent_device != current_device) {
755 die_errno("Cannot come back to cwd");
760 die("Not a git repository (or any parent up to mount point %s)\n"
761 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).", cwd);
766 die_errno("Cannot change to '%s/..'", cwd);
768 offset = offset_parent;
772 const char *setup_git_directory_gently(int *nongit_ok)
776 prefix = setup_git_directory_gently_1(nongit_ok);
778 setenv("GIT_PREFIX", prefix, 1);
780 setenv("GIT_PREFIX", "", 1);
783 startup_info->have_repository = !nongit_ok || !*nongit_ok;
784 startup_info->prefix = prefix;
789 int git_config_perm(const char *var, const char *value)
797 if (!strcmp(value, "umask"))
799 if (!strcmp(value, "group"))
801 if (!strcmp(value, "all") ||
802 !strcmp(value, "world") ||
803 !strcmp(value, "everybody"))
804 return PERM_EVERYBODY;
806 /* Parse octal numbers */
807 i = strtol(value, &endptr, 8);
809 /* If not an octal number, maybe true/false? */
811 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
814 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
815 * a chmod value to restrict to.
818 case PERM_UMASK: /* 0 */
820 case OLD_PERM_GROUP: /* 1 */
822 case OLD_PERM_EVERYBODY: /* 2 */
823 return PERM_EVERYBODY;
826 /* A filemode value was given: 0xxx */
828 if ((i & 0600) != 0600)
829 die("Problem with core.sharedRepository filemode value "
830 "(0%.3o).\nThe owner of files must always have "
831 "read and write permissions.", i);
834 * Mask filemode value. Others can not get write permission.
835 * x flags for directories are handled separately.
840 int check_repository_format_version(const char *var, const char *value, void *cb)
842 if (strcmp(var, "core.repositoryformatversion") == 0)
843 repository_format_version = git_config_int(var, value);
844 else if (strcmp(var, "core.sharedrepository") == 0)
845 shared_repository = git_config_perm(var, value);
846 else if (strcmp(var, "core.bare") == 0) {
847 is_bare_repository_cfg = git_config_bool(var, value);
848 if (is_bare_repository_cfg == 1)
849 inside_work_tree = -1;
850 } else if (strcmp(var, "core.worktree") == 0) {
852 return config_error_nonbool(var);
853 free(git_work_tree_cfg);
854 git_work_tree_cfg = xstrdup(value);
855 inside_work_tree = -1;
860 int check_repository_format(void)
862 return check_repository_format_gently(get_git_dir(), NULL);
866 * Returns the "prefix", a path to the current working directory
867 * relative to the work tree root, or NULL, if the current working
868 * directory is not a strict subdirectory of the work tree root. The
869 * prefix always ends with a '/' character.
871 const char *setup_git_directory(void)
873 return setup_git_directory_gently(NULL);
876 const char *resolve_gitdir(const char *suspect)
878 if (is_git_directory(suspect))
880 return read_gitfile(suspect);