3 #include "string-list.h"
5 static int inside_git_dir
= -1;
6 static int inside_work_tree
= -1;
9 * The input parameter must contain an absolute path, and it must already be
12 * Find the part of an absolute path that lies inside the work tree by
13 * dereferencing symlinks outside the work tree, for example:
14 * /dir1/repo/dir2/file (work tree is /dir1/repo) -> dir2/file
15 * /dir/file (work tree is /) -> dir/file
16 * /dir/symlink1/symlink2 (symlink1 points to work tree) -> symlink2
17 * /dir/repolink/file (repolink points to /dir/repo) -> file
18 * /dir/repo (exactly equal to work tree) -> (empty string)
20 static int abspath_part_inside_repo(char *path
)
26 const char *work_tree
= get_git_work_tree();
30 wtlen
= strlen(work_tree
);
32 off
= offset_1st_component(path
);
34 /* check if work tree is already the prefix */
35 if (wtlen
<= len
&& !strncmp(path
, work_tree
, wtlen
)) {
36 if (path
[wtlen
] == '/') {
37 memmove(path
, path
+ wtlen
+ 1, len
- wtlen
);
39 } else if (path
[wtlen
- 1] == '/' || path
[wtlen
] == '\0') {
40 /* work tree is the root, or the whole path */
41 memmove(path
, path
+ wtlen
, len
- wtlen
+ 1);
44 /* work tree might match beginning of a symlink to work tree */
50 /* check each '/'-terminated level */
55 if (strcmp(real_path(path0
), work_tree
) == 0) {
56 memmove(path0
, path
+ 1, len
- (path
- path0
));
63 /* check whole path */
64 if (strcmp(real_path(path0
), work_tree
) == 0) {
73 * Normalize "path", prepending the "prefix" for relative paths. If
74 * remaining_prefix is not NULL, return the actual prefix still
75 * remains in the path. For example, prefix = sub1/sub2/ and path is
77 * foo -> sub1/sub2/foo (full prefix)
78 * ../foo -> sub1/foo (remaining prefix is sub1/)
79 * ../../bar -> bar (no remaining prefix)
80 * ../../sub1/sub2/foo -> sub1/sub2/foo (but no remaining prefix)
81 * `pwd`/../bar -> sub1/bar (no remaining prefix)
83 char *prefix_path_gently(const char *prefix
, int len
,
84 int *remaining_prefix
, const char *path
)
86 const char *orig
= path
;
88 if (is_absolute_path(orig
)) {
89 sanitized
= xmalloc(strlen(path
) + 1);
91 *remaining_prefix
= 0;
92 if (normalize_path_copy_len(sanitized
, path
, remaining_prefix
)) {
96 if (abspath_part_inside_repo(sanitized
)) {
101 sanitized
= xmalloc(len
+ strlen(path
) + 1);
103 memcpy(sanitized
, prefix
, len
);
104 strcpy(sanitized
+ len
, path
);
105 if (remaining_prefix
)
106 *remaining_prefix
= len
;
107 if (normalize_path_copy_len(sanitized
, sanitized
, remaining_prefix
)) {
115 char *prefix_path(const char *prefix
, int len
, const char *path
)
117 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
119 die("'%s' is outside repository", path
);
123 int path_inside_repo(const char *prefix
, const char *path
)
125 int len
= prefix
? strlen(prefix
) : 0;
126 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
134 int check_filename(const char *prefix
, const char *arg
)
139 if (starts_with(arg
, ":/")) {
140 if (arg
[2] == '\0') /* ":/" is root dir, always exists */
144 name
= prefix_filename(prefix
, strlen(prefix
), arg
);
147 if (!lstat(name
, &st
))
148 return 1; /* file exists */
149 if (errno
== ENOENT
|| errno
== ENOTDIR
)
150 return 0; /* file does not exist */
151 die_errno("failed to stat '%s'", arg
);
154 static void NORETURN
die_verify_filename(const char *prefix
,
156 int diagnose_misspelt_rev
)
158 if (!diagnose_misspelt_rev
)
159 die("%s: no such path in the working tree.\n"
160 "Use 'git <command> -- <path>...' to specify paths that do not exist locally.",
163 * Saying "'(icase)foo' does not exist in the index" when the
164 * user gave us ":(icase)foo" is just stupid. A magic pathspec
165 * begins with a colon and is followed by a non-alnum; do not
166 * let maybe_die_on_misspelt_object_name() even trigger.
168 if (!(arg
[0] == ':' && !isalnum(arg
[1])))
169 maybe_die_on_misspelt_object_name(arg
, prefix
);
171 /* ... or fall back the most general message. */
172 die("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
173 "Use '--' to separate paths from revisions, like this:\n"
174 "'git <command> [<revision>...] -- [<file>...]'", arg
);
179 * Verify a filename that we got as an argument for a pathspec
180 * entry. Note that a filename that begins with "-" never verifies
181 * as true, because even if such a filename were to exist, we want
182 * it to be preceded by the "--" marker (or we want the user to
183 * use a format like "./-filename")
185 * The "diagnose_misspelt_rev" is used to provide a user-friendly
186 * diagnosis when dying upon finding that "name" is not a pathname.
187 * If set to 1, the diagnosis will try to diagnose "name" as an
188 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
189 * will only complain about an inexisting file.
191 * This function is typically called to check that a "file or rev"
192 * argument is unambiguous. In this case, the caller will want
193 * diagnose_misspelt_rev == 1 when verifying the first non-rev
194 * argument (which could have been a revision), and
195 * diagnose_misspelt_rev == 0 for the next ones (because we already
196 * saw a filename, there's not ambiguity anymore).
198 void verify_filename(const char *prefix
,
200 int diagnose_misspelt_rev
)
203 die("bad flag '%s' used after filename", arg
);
204 if (check_filename(prefix
, arg
) || !no_wildcard(arg
))
206 die_verify_filename(prefix
, arg
, diagnose_misspelt_rev
);
210 * Opposite of the above: the command line did not have -- marker
211 * and we parsed the arg as a refname. It should not be interpretable
214 void verify_non_filename(const char *prefix
, const char *arg
)
216 if (!is_inside_work_tree() || is_inside_git_dir())
220 if (!check_filename(prefix
, arg
))
222 die("ambiguous argument '%s': both revision and filename\n"
223 "Use '--' to separate paths from revisions, like this:\n"
224 "'git <command> [<revision>...] -- [<file>...]'", arg
);
229 * Test if it looks like we're at a git directory.
232 * - either an objects/ directory _or_ the proper
233 * GIT_OBJECT_DIRECTORY environment variable
234 * - a refs/ directory
235 * - either a HEAD symlink or a HEAD file that is formatted as
236 * a proper "ref:", or a regular file HEAD that has a properly
237 * formatted sha1 object name.
239 int is_git_directory(const char *suspect
)
242 size_t len
= strlen(suspect
);
244 if (PATH_MAX
<= len
+ strlen("/objects"))
245 die("Too long path: %.*s", 60, suspect
);
246 strcpy(path
, suspect
);
247 if (getenv(DB_ENVIRONMENT
)) {
248 if (access(getenv(DB_ENVIRONMENT
), X_OK
))
252 strcpy(path
+ len
, "/objects");
253 if (access(path
, X_OK
))
257 strcpy(path
+ len
, "/refs");
258 if (access(path
, X_OK
))
261 strcpy(path
+ len
, "/HEAD");
262 if (validate_headref(path
))
268 int is_inside_git_dir(void)
270 if (inside_git_dir
< 0)
271 inside_git_dir
= is_inside_dir(get_git_dir());
272 return inside_git_dir
;
275 int is_inside_work_tree(void)
277 if (inside_work_tree
< 0)
278 inside_work_tree
= is_inside_dir(get_git_work_tree());
279 return inside_work_tree
;
282 void setup_work_tree(void)
284 const char *work_tree
, *git_dir
;
285 static int initialized
= 0;
289 work_tree
= get_git_work_tree();
290 git_dir
= get_git_dir();
291 if (!is_absolute_path(git_dir
))
292 git_dir
= real_path(get_git_dir());
293 if (!work_tree
|| chdir(work_tree
))
294 die("This operation must be run in a work tree");
297 * Make sure subsequent git processes find correct worktree
298 * if $GIT_WORK_TREE is set relative
300 if (getenv(GIT_WORK_TREE_ENVIRONMENT
))
301 setenv(GIT_WORK_TREE_ENVIRONMENT
, ".", 1);
303 set_git_dir(remove_leading_path(git_dir
, work_tree
));
307 static int check_repository_format_gently(const char *gitdir
, int *nongit_ok
)
309 char repo_config
[PATH_MAX
+1];
312 * git_config() can't be used here because it calls git_pathdup()
313 * to get $GIT_CONFIG/config. That call will make setup_git_env()
314 * set git_dir to ".git".
316 * We are in gitdir setup, no git dir has been found useable yet.
317 * Use a gentler version of git_config() to check if this repo
320 snprintf(repo_config
, PATH_MAX
, "%s/config", gitdir
);
321 git_config_early(check_repository_format_version
, NULL
, repo_config
);
322 if (GIT_REPO_VERSION
< repository_format_version
) {
324 die ("Expected git repo version <= %d, found %d",
325 GIT_REPO_VERSION
, repository_format_version
);
326 warning("Expected git repo version <= %d, found %d",
327 GIT_REPO_VERSION
, repository_format_version
);
328 warning("Please upgrade Git");
336 * Try to read the location of the git directory from the .git file,
337 * return path to git directory if found.
339 const char *read_gitfile(const char *path
)
350 if (!S_ISREG(st
.st_mode
))
352 fd
= open(path
, O_RDONLY
);
354 die_errno("Error opening '%s'", path
);
355 buf
= xmalloc(st
.st_size
+ 1);
356 len
= read_in_full(fd
, buf
, st
.st_size
);
358 if (len
!= st
.st_size
)
359 die("Error reading %s", path
);
361 if (!starts_with(buf
, "gitdir: "))
362 die("Invalid gitfile format: %s", path
);
363 while (buf
[len
- 1] == '\n' || buf
[len
- 1] == '\r')
366 die("No path in gitfile: %s", path
);
370 if (!is_absolute_path(dir
) && (slash
= strrchr(path
, '/'))) {
371 size_t pathlen
= slash
+1 - path
;
372 size_t dirlen
= pathlen
+ len
- 8;
373 dir
= xmalloc(dirlen
+ 1);
374 strncpy(dir
, path
, pathlen
);
375 strncpy(dir
+ pathlen
, buf
+ 8, len
- 8);
381 if (!is_git_directory(dir
))
382 die("Not a git repository: %s", dir
);
383 path
= real_path(dir
);
389 static const char *setup_explicit_git_dir(const char *gitdirenv
,
393 const char *work_tree_env
= getenv(GIT_WORK_TREE_ENVIRONMENT
);
394 const char *worktree
;
398 if (PATH_MAX
- 40 < strlen(gitdirenv
))
399 die("'$%s' too big", GIT_DIR_ENVIRONMENT
);
401 gitfile
= (char*)read_gitfile(gitdirenv
);
403 gitfile
= xstrdup(gitfile
);
407 if (!is_git_directory(gitdirenv
)) {
413 die("Not a git repository: '%s'", gitdirenv
);
416 if (check_repository_format_gently(gitdirenv
, nongit_ok
)) {
421 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
423 set_git_work_tree(work_tree_env
);
424 else if (is_bare_repository_cfg
> 0) {
425 if (git_work_tree_cfg
) /* #22.2, #30 */
426 die("core.bare and core.worktree do not make sense");
429 set_git_dir(gitdirenv
);
433 else if (git_work_tree_cfg
) { /* #6, #14 */
434 if (is_absolute_path(git_work_tree_cfg
))
435 set_git_work_tree(git_work_tree_cfg
);
438 if (chdir(gitdirenv
))
439 die_errno("Could not chdir to '%s'", gitdirenv
);
440 if (chdir(git_work_tree_cfg
))
441 die_errno("Could not chdir to '%s'", git_work_tree_cfg
);
442 core_worktree
= xgetcwd();
444 die_errno("Could not come back to cwd");
445 set_git_work_tree(core_worktree
);
449 else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, 1)) {
451 set_git_dir(gitdirenv
);
456 set_git_work_tree(".");
458 /* set_git_work_tree() must have been called by now */
459 worktree
= get_git_work_tree();
461 /* both get_git_work_tree() and cwd are already normalized */
462 if (!strcmp(cwd
->buf
, worktree
)) { /* cwd == worktree */
463 set_git_dir(gitdirenv
);
468 offset
= dir_inside_of(cwd
->buf
, worktree
);
469 if (offset
>= 0) { /* cwd inside worktree? */
470 set_git_dir(real_path(gitdirenv
));
472 die_errno("Could not chdir to '%s'", worktree
);
473 strbuf_addch(cwd
, '/');
475 return cwd
->buf
+ offset
;
478 /* cwd outside worktree */
479 set_git_dir(gitdirenv
);
484 static const char *setup_discovered_git_dir(const char *gitdir
,
485 struct strbuf
*cwd
, int offset
,
488 if (check_repository_format_gently(gitdir
, nongit_ok
))
491 /* --work-tree is set without --git-dir; use discovered one */
492 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
493 if (offset
!= cwd
->len
&& !is_absolute_path(gitdir
))
494 gitdir
= xstrdup(real_path(gitdir
));
496 die_errno("Could not come back to cwd");
497 return setup_explicit_git_dir(gitdir
, cwd
, nongit_ok
);
500 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
501 if (is_bare_repository_cfg
> 0) {
502 set_git_dir(offset
== cwd
->len
? gitdir
: real_path(gitdir
));
504 die_errno("Could not come back to cwd");
508 /* #0, #1, #5, #8, #9, #12, #13 */
509 set_git_work_tree(".");
510 if (strcmp(gitdir
, DEFAULT_GIT_DIR_ENVIRONMENT
))
513 inside_work_tree
= 1;
514 if (offset
== cwd
->len
)
517 /* Make "offset" point to past the '/', and add a '/' at the end */
519 strbuf_addch(cwd
, '/');
520 return cwd
->buf
+ offset
;
523 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
524 static const char *setup_bare_git_dir(struct strbuf
*cwd
, int offset
,
529 if (check_repository_format_gently(".", nongit_ok
))
532 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, "0", 1);
534 /* --work-tree is set without --git-dir; use discovered one */
535 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
538 gitdir
= offset
== cwd
->len
? "." : xmemdupz(cwd
->buf
, offset
);
540 die_errno("Could not come back to cwd");
541 return setup_explicit_git_dir(gitdir
, cwd
, nongit_ok
);
545 inside_work_tree
= 0;
546 if (offset
!= cwd
->len
) {
548 die_errno("Cannot come back to cwd");
549 root_len
= offset_1st_component(cwd
->buf
);
550 strbuf_setlen(cwd
, offset
> root_len
? offset
: root_len
);
551 set_git_dir(cwd
->buf
);
558 static const char *setup_nongit(const char *cwd
, int *nongit_ok
)
561 die("Not a git repository (or any of the parent directories): %s", DEFAULT_GIT_DIR_ENVIRONMENT
);
563 die_errno("Cannot come back to cwd");
568 static dev_t
get_device_or_die(const char *path
, const char *prefix
, int prefix_len
)
571 if (stat(path
, &buf
)) {
572 die_errno("failed to stat '%*s%s%s'",
574 prefix
? prefix
: "",
575 prefix
? "/" : "", path
);
581 * A "string_list_each_func_t" function that canonicalizes an entry
582 * from GIT_CEILING_DIRECTORIES using real_path_if_valid(), or
583 * discards it if unusable. The presence of an empty entry in
584 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
585 * subsequent entries.
587 static int canonicalize_ceiling_entry(struct string_list_item
*item
,
590 int *empty_entry_found
= cb_data
;
591 char *ceil
= item
->string
;
594 *empty_entry_found
= 1;
596 } else if (!is_absolute_path(ceil
)) {
598 } else if (*empty_entry_found
) {
599 /* Keep entry but do not canonicalize it */
602 const char *real_path
= real_path_if_valid(ceil
);
606 item
->string
= xstrdup(real_path
);
612 * We cannot decide in this function whether we are in the work tree or
613 * not, since the config can only be read _after_ this function was called.
615 static const char *setup_git_directory_gently_1(int *nongit_ok
)
617 const char *env_ceiling_dirs
= getenv(CEILING_DIRECTORIES_ENVIRONMENT
);
618 struct string_list ceiling_dirs
= STRING_LIST_INIT_DUP
;
619 static struct strbuf cwd
= STRBUF_INIT
;
620 const char *gitdirenv
, *ret
;
622 int offset
, offset_parent
, ceil_offset
= -1;
623 dev_t current_device
= 0;
624 int one_filesystem
= 1;
627 * We may have read an incomplete configuration before
628 * setting-up the git directory. If so, clear the cache so
629 * that the next queries to the configuration reload complete
630 * configuration (including the per-repo config file that we
631 * ignored previously).
636 * Let's assume that we are in a git repository.
637 * If it turns out later that we are somewhere else, the value will be
638 * updated accordingly.
643 if (strbuf_getcwd(&cwd
))
644 die_errno("Unable to read current working directory");
648 * If GIT_DIR is set explicitly, we're not going
649 * to do any discovery, but we still do repository
652 gitdirenv
= getenv(GIT_DIR_ENVIRONMENT
);
654 return setup_explicit_git_dir(gitdirenv
, &cwd
, nongit_ok
);
656 if (env_ceiling_dirs
) {
657 int empty_entry_found
= 0;
659 string_list_split(&ceiling_dirs
, env_ceiling_dirs
, PATH_SEP
, -1);
660 filter_string_list(&ceiling_dirs
, 0,
661 canonicalize_ceiling_entry
, &empty_entry_found
);
662 ceil_offset
= longest_ancestor_length(cwd
.buf
, &ceiling_dirs
);
663 string_list_clear(&ceiling_dirs
, 0);
666 if (ceil_offset
< 0 && has_dos_drive_prefix(cwd
.buf
))
670 * Test in the following order (relative to the cwd):
671 * - .git (file containing "gitdir: <path>")
680 one_filesystem
= !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
682 current_device
= get_device_or_die(".", NULL
, 0);
684 gitfile
= (char*)read_gitfile(DEFAULT_GIT_DIR_ENVIRONMENT
);
686 gitdirenv
= gitfile
= xstrdup(gitfile
);
688 if (is_git_directory(DEFAULT_GIT_DIR_ENVIRONMENT
))
689 gitdirenv
= DEFAULT_GIT_DIR_ENVIRONMENT
;
693 ret
= setup_discovered_git_dir(gitdirenv
,
701 if (is_git_directory("."))
702 return setup_bare_git_dir(&cwd
, offset
, nongit_ok
);
704 offset_parent
= offset
;
705 while (--offset_parent
> ceil_offset
&& cwd
.buf
[offset_parent
] != '/');
706 if (offset_parent
<= ceil_offset
)
707 return setup_nongit(cwd
.buf
, nongit_ok
);
708 if (one_filesystem
) {
709 dev_t parent_device
= get_device_or_die("..", cwd
.buf
,
711 if (parent_device
!= current_device
) {
714 die_errno("Cannot come back to cwd");
718 strbuf_setlen(&cwd
, offset
);
719 die("Not a git repository (or any parent up to mount point %s)\n"
720 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).",
725 strbuf_setlen(&cwd
, offset
);
726 die_errno("Cannot change to '%s/..'", cwd
.buf
);
728 offset
= offset_parent
;
732 const char *setup_git_directory_gently(int *nongit_ok
)
736 prefix
= setup_git_directory_gently_1(nongit_ok
);
738 setenv(GIT_PREFIX_ENVIRONMENT
, prefix
, 1);
740 setenv(GIT_PREFIX_ENVIRONMENT
, "", 1);
743 startup_info
->have_repository
= !nongit_ok
|| !*nongit_ok
;
744 startup_info
->prefix
= prefix
;
749 int git_config_perm(const char *var
, const char *value
)
757 if (!strcmp(value
, "umask"))
759 if (!strcmp(value
, "group"))
761 if (!strcmp(value
, "all") ||
762 !strcmp(value
, "world") ||
763 !strcmp(value
, "everybody"))
764 return PERM_EVERYBODY
;
766 /* Parse octal numbers */
767 i
= strtol(value
, &endptr
, 8);
769 /* If not an octal number, maybe true/false? */
771 return git_config_bool(var
, value
) ? PERM_GROUP
: PERM_UMASK
;
774 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
775 * a chmod value to restrict to.
778 case PERM_UMASK
: /* 0 */
780 case OLD_PERM_GROUP
: /* 1 */
782 case OLD_PERM_EVERYBODY
: /* 2 */
783 return PERM_EVERYBODY
;
786 /* A filemode value was given: 0xxx */
788 if ((i
& 0600) != 0600)
789 die("Problem with core.sharedRepository filemode value "
790 "(0%.3o).\nThe owner of files must always have "
791 "read and write permissions.", i
);
794 * Mask filemode value. Others can not get write permission.
795 * x flags for directories are handled separately.
800 int check_repository_format_version(const char *var
, const char *value
, void *cb
)
802 if (strcmp(var
, "core.repositoryformatversion") == 0)
803 repository_format_version
= git_config_int(var
, value
);
804 else if (strcmp(var
, "core.sharedrepository") == 0)
805 shared_repository
= git_config_perm(var
, value
);
806 else if (strcmp(var
, "core.bare") == 0) {
807 is_bare_repository_cfg
= git_config_bool(var
, value
);
808 if (is_bare_repository_cfg
== 1)
809 inside_work_tree
= -1;
810 } else if (strcmp(var
, "core.worktree") == 0) {
812 return config_error_nonbool(var
);
813 free(git_work_tree_cfg
);
814 git_work_tree_cfg
= xstrdup(value
);
815 inside_work_tree
= -1;
820 int check_repository_format(void)
822 return check_repository_format_gently(get_git_dir(), NULL
);
826 * Returns the "prefix", a path to the current working directory
827 * relative to the work tree root, or NULL, if the current working
828 * directory is not a strict subdirectory of the work tree root. The
829 * prefix always ends with a '/' character.
831 const char *setup_git_directory(void)
833 return setup_git_directory_gently(NULL
);
836 const char *resolve_gitdir(const char *suspect
)
838 if (is_git_directory(suspect
))
840 return read_gitfile(suspect
);
843 /* if any standard file descriptor is missing open it to /dev/null */
844 void sanitize_stdfds(void)
846 int fd
= open("/dev/null", O_RDWR
, 0);
847 while (fd
!= -1 && fd
< 2)
850 die_errno("open /dev/null or dup failed");
857 #ifdef NO_POSIX_GOODIES
865 die_errno("fork failed");
870 die_errno("setsid failed");