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 if (!prefixcmp(arg, ":/")) {
70 if (arg[2] == '\0') /* ":/" is root dir, always exists */
74 name = prefix_filename(prefix, strlen(prefix), arg);
77 if (!lstat(name, &st))
78 return 1; /* file exists */
79 if (errno == ENOENT || errno == ENOTDIR)
80 return 0; /* file does not exist */
81 die_errno("failed to stat '%s'", arg);
84 static void NORETURN die_verify_filename(const char *prefix,
86 int diagnose_misspelt_rev)
88 if (!diagnose_misspelt_rev)
89 die("%s: no such path in the working tree.\n"
90 "Use 'git <command> -- <path>...' to specify paths that do not exist locally.",
93 * Saying "'(icase)foo' does not exist in the index" when the
94 * user gave us ":(icase)foo" is just stupid. A magic pathspec
95 * begins with a colon and is followed by a non-alnum; do not
96 * let maybe_die_on_misspelt_object_name() even trigger.
98 if (!(arg[0] == ':' && !isalnum(arg[1])))
99 maybe_die_on_misspelt_object_name(arg, prefix);
101 /* ... or fall back the most general message. */
102 die("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
103 "Use '--' to separate paths from revisions, like this:\n"
104 "'git <command> [<revision>...] -- [<file>...]'", arg);
109 * Verify a filename that we got as an argument for a pathspec
110 * entry. Note that a filename that begins with "-" never verifies
111 * as true, because even if such a filename were to exist, we want
112 * it to be preceded by the "--" marker (or we want the user to
113 * use a format like "./-filename")
115 * The "diagnose_misspelt_rev" is used to provide a user-friendly
116 * diagnosis when dying upon finding that "name" is not a pathname.
117 * If set to 1, the diagnosis will try to diagnose "name" as an
118 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
119 * will only complain about an inexisting file.
121 * This function is typically called to check that a "file or rev"
122 * argument is unambiguous. In this case, the caller will want
123 * diagnose_misspelt_rev == 1 when verifying the first non-rev
124 * argument (which could have been a revision), and
125 * diagnose_misspelt_rev == 0 for the next ones (because we already
126 * saw a filename, there's not ambiguity anymore).
128 void verify_filename(const char *prefix,
130 int diagnose_misspelt_rev)
133 die("bad flag '%s' used after filename", arg);
134 if (check_filename(prefix, arg))
136 die_verify_filename(prefix, arg, diagnose_misspelt_rev);
140 * Opposite of the above: the command line did not have -- marker
141 * and we parsed the arg as a refname. It should not be interpretable
144 void verify_non_filename(const char *prefix, const char *arg)
146 if (!is_inside_work_tree() || is_inside_git_dir())
150 if (!check_filename(prefix, arg))
152 die("ambiguous argument '%s': both revision and filename\n"
153 "Use '--' to separate paths from revisions, like this:\n"
154 "'git <command> [<revision>...] -- [<file>...]'", arg);
160 * NEEDSWORK: These need to be moved to dir.h or even to a new
161 * pathspec.h when we restructure get_pathspec() users to use the
162 * "struct pathspec" interface.
164 * Possible future magic semantics include stuff like:
166 * { PATHSPEC_NOGLOB, '!', "noglob" },
167 * { PATHSPEC_ICASE, '\0', "icase" },
168 * { PATHSPEC_RECURSIVE, '*', "recursive" },
169 * { PATHSPEC_REGEXP, '\0', "regexp" },
172 #define PATHSPEC_FROMTOP (1<<0)
174 static struct pathspec_magic {
176 char mnemonic; /* this cannot be ':'! */
178 } pathspec_magic[] = {
179 { PATHSPEC_FROMTOP, '/', "top" },
183 * Take an element of a pathspec and check for magic signatures.
184 * Append the result to the prefix.
186 * For now, we only parse the syntax and throw out anything other than
189 * NEEDSWORK: This needs to be rewritten when we start migrating
190 * get_pathspec() users to use the "struct pathspec" interface. For
191 * example, a pathspec element may be marked as case-insensitive, but
192 * the prefix part must always match literally, and a single stupid
193 * string cannot express such a case.
195 static const char *prefix_pathspec(const char *prefix, int prefixlen, const char *elt)
198 const char *copyfrom = elt;
202 ; /* nothing to do */
203 } else if (elt[1] == '(') {
206 for (copyfrom = elt + 2;
207 *copyfrom && *copyfrom != ')';
209 size_t len = strcspn(copyfrom, ",)");
210 if (copyfrom[len] == ')')
211 nextat = copyfrom + len;
213 nextat = copyfrom + len + 1;
216 for (i = 0; i < ARRAY_SIZE(pathspec_magic); i++)
217 if (strlen(pathspec_magic[i].name) == len &&
218 !strncmp(pathspec_magic[i].name, copyfrom, len)) {
219 magic |= pathspec_magic[i].bit;
222 if (ARRAY_SIZE(pathspec_magic) <= i)
223 die("Invalid pathspec magic '%.*s' in '%s'",
224 (int) len, copyfrom, elt);
226 if (*copyfrom == ')')
230 for (copyfrom = elt + 1;
231 *copyfrom && *copyfrom != ':';
235 if (!is_pathspec_magic(ch))
237 for (i = 0; i < ARRAY_SIZE(pathspec_magic); i++)
238 if (pathspec_magic[i].mnemonic == ch) {
239 magic |= pathspec_magic[i].bit;
242 if (ARRAY_SIZE(pathspec_magic) <= i)
243 die("Unimplemented pathspec magic '%c' in '%s'",
246 if (*copyfrom == ':')
250 if (magic & PATHSPEC_FROMTOP)
251 return xstrdup(copyfrom);
253 return prefix_path(prefix, prefixlen, copyfrom);
257 * N.B. get_pathspec() is deprecated in favor of the "struct pathspec"
258 * based interface - see pathspec_magic above.
261 * - prefix - a path relative to the root of the working tree
262 * - pathspec - a list of paths underneath the prefix path
264 * Iterates over pathspec, prepending each path with prefix,
265 * and return the resulting list.
267 * If pathspec is empty, return a singleton list containing prefix.
269 * If pathspec and prefix are both empty, return an empty list.
271 * This is typically used by built-in commands such as add.c, in order
272 * to normalize argv arguments provided to the built-in into a list of
273 * paths to process, all relative to the root of the working tree.
275 const char **get_pathspec(const char *prefix, const char **pathspec)
277 const char *entry = *pathspec;
278 const char **src, **dst;
281 if (!prefix && !entry)
285 static const char *spec[2];
291 /* Otherwise we have to re-write the entries.. */
294 prefixlen = prefix ? strlen(prefix) : 0;
296 *(dst++) = prefix_pathspec(prefix, prefixlen, *src);
306 * Test if it looks like we're at a git directory.
309 * - either an objects/ directory _or_ the proper
310 * GIT_OBJECT_DIRECTORY environment variable
311 * - a refs/ directory
312 * - either a HEAD symlink or a HEAD file that is formatted as
313 * a proper "ref:", or a regular file HEAD that has a properly
314 * formatted sha1 object name.
316 int is_git_directory(const char *suspect)
319 size_t len = strlen(suspect);
321 if (PATH_MAX <= len + strlen("/objects"))
322 die("Too long path: %.*s", 60, suspect);
323 strcpy(path, suspect);
324 if (getenv(DB_ENVIRONMENT)) {
325 if (access(getenv(DB_ENVIRONMENT), X_OK))
329 strcpy(path + len, "/objects");
330 if (access(path, X_OK))
334 strcpy(path + len, "/refs");
335 if (access(path, X_OK))
338 strcpy(path + len, "/HEAD");
339 if (validate_headref(path))
345 int is_inside_git_dir(void)
347 if (inside_git_dir < 0)
348 inside_git_dir = is_inside_dir(get_git_dir());
349 return inside_git_dir;
352 int is_inside_work_tree(void)
354 if (inside_work_tree < 0)
355 inside_work_tree = is_inside_dir(get_git_work_tree());
356 return inside_work_tree;
359 void setup_work_tree(void)
361 const char *work_tree, *git_dir;
362 static int initialized = 0;
366 work_tree = get_git_work_tree();
367 git_dir = get_git_dir();
368 if (!is_absolute_path(git_dir))
369 git_dir = real_path(get_git_dir());
370 if (!work_tree || chdir(work_tree))
371 die("This operation must be run in a work tree");
374 * Make sure subsequent git processes find correct worktree
375 * if $GIT_WORK_TREE is set relative
377 if (getenv(GIT_WORK_TREE_ENVIRONMENT))
378 setenv(GIT_WORK_TREE_ENVIRONMENT, ".", 1);
380 set_git_dir(relative_path(git_dir, work_tree));
384 static int check_repository_format_gently(const char *gitdir, int *nongit_ok)
386 char repo_config[PATH_MAX+1];
389 * git_config() can't be used here because it calls git_pathdup()
390 * to get $GIT_CONFIG/config. That call will make setup_git_env()
391 * set git_dir to ".git".
393 * We are in gitdir setup, no git dir has been found useable yet.
394 * Use a gentler version of git_config() to check if this repo
397 snprintf(repo_config, PATH_MAX, "%s/config", gitdir);
398 git_config_early(check_repository_format_version, NULL, repo_config);
399 if (GIT_REPO_VERSION < repository_format_version) {
401 die ("Expected git repo version <= %d, found %d",
402 GIT_REPO_VERSION, repository_format_version);
403 warning("Expected git repo version <= %d, found %d",
404 GIT_REPO_VERSION, repository_format_version);
405 warning("Please upgrade Git");
413 * Try to read the location of the git directory from the .git file,
414 * return path to git directory if found.
416 const char *read_gitfile(const char *path)
427 if (!S_ISREG(st.st_mode))
429 fd = open(path, O_RDONLY);
431 die_errno("Error opening '%s'", path);
432 buf = xmalloc(st.st_size + 1);
433 len = read_in_full(fd, buf, st.st_size);
435 if (len != st.st_size)
436 die("Error reading %s", path);
438 if (prefixcmp(buf, "gitdir: "))
439 die("Invalid gitfile format: %s", path);
440 while (buf[len - 1] == '\n' || buf[len - 1] == '\r')
443 die("No path in gitfile: %s", path);
447 if (!is_absolute_path(dir) && (slash = strrchr(path, '/'))) {
448 size_t pathlen = slash+1 - path;
449 size_t dirlen = pathlen + len - 8;
450 dir = xmalloc(dirlen + 1);
451 strncpy(dir, path, pathlen);
452 strncpy(dir + pathlen, buf + 8, len - 8);
458 if (!is_git_directory(dir))
459 die("Not a git repository: %s", dir);
460 path = real_path(dir);
466 static const char *setup_explicit_git_dir(const char *gitdirenv,
470 const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
471 const char *worktree;
475 if (PATH_MAX - 40 < strlen(gitdirenv))
476 die("'$%s' too big", GIT_DIR_ENVIRONMENT);
478 gitfile = (char*)read_gitfile(gitdirenv);
480 gitfile = xstrdup(gitfile);
484 if (!is_git_directory(gitdirenv)) {
490 die("Not a git repository: '%s'", gitdirenv);
493 if (check_repository_format_gently(gitdirenv, nongit_ok)) {
498 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
500 set_git_work_tree(work_tree_env);
501 else if (is_bare_repository_cfg > 0) {
502 if (git_work_tree_cfg) /* #22.2, #30 */
503 die("core.bare and core.worktree do not make sense");
506 set_git_dir(gitdirenv);
510 else if (git_work_tree_cfg) { /* #6, #14 */
511 if (is_absolute_path(git_work_tree_cfg))
512 set_git_work_tree(git_work_tree_cfg);
514 char core_worktree[PATH_MAX];
515 if (chdir(gitdirenv))
516 die_errno("Could not chdir to '%s'", gitdirenv);
517 if (chdir(git_work_tree_cfg))
518 die_errno("Could not chdir to '%s'", git_work_tree_cfg);
519 if (!getcwd(core_worktree, PATH_MAX))
520 die_errno("Could not get directory '%s'", git_work_tree_cfg);
522 die_errno("Could not come back to cwd");
523 set_git_work_tree(core_worktree);
527 set_git_work_tree(".");
529 /* set_git_work_tree() must have been called by now */
530 worktree = get_git_work_tree();
532 /* both get_git_work_tree() and cwd are already normalized */
533 if (!strcmp(cwd, worktree)) { /* cwd == worktree */
534 set_git_dir(gitdirenv);
539 offset = dir_inside_of(cwd, worktree);
540 if (offset >= 0) { /* cwd inside worktree? */
541 set_git_dir(real_path(gitdirenv));
543 die_errno("Could not chdir to '%s'", worktree);
550 /* cwd outside worktree */
551 set_git_dir(gitdirenv);
556 static const char *setup_discovered_git_dir(const char *gitdir,
557 char *cwd, int offset, int len,
560 if (check_repository_format_gently(gitdir, nongit_ok))
563 /* --work-tree is set without --git-dir; use discovered one */
564 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
565 if (offset != len && !is_absolute_path(gitdir))
566 gitdir = xstrdup(real_path(gitdir));
568 die_errno("Could not come back to cwd");
569 return setup_explicit_git_dir(gitdir, cwd, len, nongit_ok);
572 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
573 if (is_bare_repository_cfg > 0) {
574 set_git_dir(offset == len ? gitdir : real_path(gitdir));
576 die_errno("Could not come back to cwd");
580 /* #0, #1, #5, #8, #9, #12, #13 */
581 set_git_work_tree(".");
582 if (strcmp(gitdir, DEFAULT_GIT_DIR_ENVIRONMENT))
585 inside_work_tree = 1;
589 /* Make "offset" point to past the '/', and add a '/' at the end */
596 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
597 static const char *setup_bare_git_dir(char *cwd, int offset, int len, int *nongit_ok)
601 if (check_repository_format_gently(".", nongit_ok))
604 /* --work-tree is set without --git-dir; use discovered one */
605 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
608 gitdir = offset == len ? "." : xmemdupz(cwd, offset);
610 die_errno("Could not come back to cwd");
611 return setup_explicit_git_dir(gitdir, cwd, len, nongit_ok);
615 inside_work_tree = 0;
618 die_errno("Cannot come back to cwd");
619 root_len = offset_1st_component(cwd);
620 cwd[offset > root_len ? offset : root_len] = '\0';
628 static const char *setup_nongit(const char *cwd, int *nongit_ok)
631 die("Not a git repository (or any of the parent directories): %s", DEFAULT_GIT_DIR_ENVIRONMENT);
633 die_errno("Cannot come back to cwd");
638 static dev_t get_device_or_die(const char *path, const char *prefix, int prefix_len)
641 if (stat(path, &buf)) {
642 die_errno("failed to stat '%*s%s%s'",
644 prefix ? prefix : "",
645 prefix ? "/" : "", path);
651 * A "string_list_each_func_t" function that canonicalizes an entry
652 * from GIT_CEILING_DIRECTORIES using real_path_if_valid(), or
653 * discards it if unusable. The presence of an empty entry in
654 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
655 * subsequent entries.
657 static int canonicalize_ceiling_entry(struct string_list_item *item,
660 int *empty_entry_found = cb_data;
661 char *ceil = item->string;
664 *empty_entry_found = 1;
666 } else if (!is_absolute_path(ceil)) {
668 } else if (*empty_entry_found) {
669 /* Keep entry but do not canonicalize it */
672 const char *real_path = real_path_if_valid(ceil);
676 item->string = xstrdup(real_path);
682 * We cannot decide in this function whether we are in the work tree or
683 * not, since the config can only be read _after_ this function was called.
685 static const char *setup_git_directory_gently_1(int *nongit_ok)
687 const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
688 struct string_list ceiling_dirs = STRING_LIST_INIT_DUP;
689 static char cwd[PATH_MAX+1];
690 const char *gitdirenv, *ret;
692 int len, offset, offset_parent, ceil_offset = -1;
693 dev_t current_device = 0;
694 int one_filesystem = 1;
697 * Let's assume that we are in a git repository.
698 * If it turns out later that we are somewhere else, the value will be
699 * updated accordingly.
704 if (!getcwd(cwd, sizeof(cwd)-1))
705 die_errno("Unable to read current working directory");
706 offset = len = strlen(cwd);
709 * If GIT_DIR is set explicitly, we're not going
710 * to do any discovery, but we still do repository
713 gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
715 return setup_explicit_git_dir(gitdirenv, cwd, len, nongit_ok);
717 if (env_ceiling_dirs) {
718 int empty_entry_found = 0;
720 string_list_split(&ceiling_dirs, env_ceiling_dirs, PATH_SEP, -1);
721 filter_string_list(&ceiling_dirs, 0,
722 canonicalize_ceiling_entry, &empty_entry_found);
723 ceil_offset = longest_ancestor_length(cwd, &ceiling_dirs);
724 string_list_clear(&ceiling_dirs, 0);
727 if (ceil_offset < 0 && has_dos_drive_prefix(cwd))
731 * Test in the following order (relative to the cwd):
732 * - .git (file containing "gitdir: <path>")
741 one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
743 current_device = get_device_or_die(".", NULL, 0);
745 gitfile = (char*)read_gitfile(DEFAULT_GIT_DIR_ENVIRONMENT);
747 gitdirenv = gitfile = xstrdup(gitfile);
749 if (is_git_directory(DEFAULT_GIT_DIR_ENVIRONMENT))
750 gitdirenv = DEFAULT_GIT_DIR_ENVIRONMENT;
754 ret = setup_discovered_git_dir(gitdirenv,
762 if (is_git_directory("."))
763 return setup_bare_git_dir(cwd, offset, len, nongit_ok);
765 offset_parent = offset;
766 while (--offset_parent > ceil_offset && cwd[offset_parent] != '/');
767 if (offset_parent <= ceil_offset)
768 return setup_nongit(cwd, nongit_ok);
769 if (one_filesystem) {
770 dev_t parent_device = get_device_or_die("..", cwd, offset);
771 if (parent_device != current_device) {
774 die_errno("Cannot come back to cwd");
779 die("Not a git repository (or any parent up to mount point %s)\n"
780 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).", cwd);
785 die_errno("Cannot change to '%s/..'", cwd);
787 offset = offset_parent;
791 const char *setup_git_directory_gently(int *nongit_ok)
795 prefix = setup_git_directory_gently_1(nongit_ok);
797 setenv("GIT_PREFIX", prefix, 1);
799 setenv("GIT_PREFIX", "", 1);
802 startup_info->have_repository = !nongit_ok || !*nongit_ok;
803 startup_info->prefix = prefix;
808 int git_config_perm(const char *var, const char *value)
816 if (!strcmp(value, "umask"))
818 if (!strcmp(value, "group"))
820 if (!strcmp(value, "all") ||
821 !strcmp(value, "world") ||
822 !strcmp(value, "everybody"))
823 return PERM_EVERYBODY;
825 /* Parse octal numbers */
826 i = strtol(value, &endptr, 8);
828 /* If not an octal number, maybe true/false? */
830 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
833 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
834 * a chmod value to restrict to.
837 case PERM_UMASK: /* 0 */
839 case OLD_PERM_GROUP: /* 1 */
841 case OLD_PERM_EVERYBODY: /* 2 */
842 return PERM_EVERYBODY;
845 /* A filemode value was given: 0xxx */
847 if ((i & 0600) != 0600)
848 die("Problem with core.sharedRepository filemode value "
849 "(0%.3o).\nThe owner of files must always have "
850 "read and write permissions.", i);
853 * Mask filemode value. Others can not get write permission.
854 * x flags for directories are handled separately.
859 int check_repository_format_version(const char *var, const char *value, void *cb)
861 if (strcmp(var, "core.repositoryformatversion") == 0)
862 repository_format_version = git_config_int(var, value);
863 else if (strcmp(var, "core.sharedrepository") == 0)
864 shared_repository = git_config_perm(var, value);
865 else if (strcmp(var, "core.bare") == 0) {
866 is_bare_repository_cfg = git_config_bool(var, value);
867 if (is_bare_repository_cfg == 1)
868 inside_work_tree = -1;
869 } else if (strcmp(var, "core.worktree") == 0) {
871 return config_error_nonbool(var);
872 free(git_work_tree_cfg);
873 git_work_tree_cfg = xstrdup(value);
874 inside_work_tree = -1;
879 int check_repository_format(void)
881 return check_repository_format_gently(get_git_dir(), NULL);
885 * Returns the "prefix", a path to the current working directory
886 * relative to the work tree root, or NULL, if the current working
887 * directory is not a strict subdirectory of the work tree root. The
888 * prefix always ends with a '/' character.
890 const char *setup_git_directory(void)
892 return setup_git_directory_gently(NULL);
895 const char *resolve_gitdir(const char *suspect)
897 if (is_git_directory(suspect))
899 return read_gitfile(suspect);