2 #include "repository.h"
5 #include "string-list.h"
6 #include "chdir-notify.h"
7 #include "promisor-remote.h"
10 static int inside_git_dir
= -1;
11 static int inside_work_tree
= -1;
12 static int work_tree_config_is_bogus
;
14 static struct startup_info the_startup_info
;
15 struct startup_info
*startup_info
= &the_startup_info
;
18 * The input parameter must contain an absolute path, and it must already be
21 * Find the part of an absolute path that lies inside the work tree by
22 * dereferencing symlinks outside the work tree, for example:
23 * /dir1/repo/dir2/file (work tree is /dir1/repo) -> dir2/file
24 * /dir/file (work tree is /) -> dir/file
25 * /dir/symlink1/symlink2 (symlink1 points to work tree) -> symlink2
26 * /dir/repolink/file (repolink points to /dir/repo) -> file
27 * /dir/repo (exactly equal to work tree) -> (empty string)
29 static int abspath_part_inside_repo(char *path
)
35 const char *work_tree
= get_git_work_tree();
36 struct strbuf realpath
= STRBUF_INIT
;
40 wtlen
= strlen(work_tree
);
42 off
= offset_1st_component(path
);
44 /* check if work tree is already the prefix */
45 if (wtlen
<= len
&& !fspathncmp(path
, work_tree
, wtlen
)) {
46 if (path
[wtlen
] == '/') {
47 memmove(path
, path
+ wtlen
+ 1, len
- wtlen
);
49 } else if (path
[wtlen
- 1] == '/' || path
[wtlen
] == '\0') {
50 /* work tree is the root, or the whole path */
51 memmove(path
, path
+ wtlen
, len
- wtlen
+ 1);
54 /* work tree might match beginning of a symlink to work tree */
60 /* check each '/'-terminated level */
65 strbuf_realpath(&realpath
, path0
, 1);
66 if (fspathcmp(realpath
.buf
, work_tree
) == 0) {
67 memmove(path0
, path
+ 1, len
- (path
- path0
));
68 strbuf_release(&realpath
);
75 /* check whole path */
76 strbuf_realpath(&realpath
, path0
, 1);
77 if (fspathcmp(realpath
.buf
, work_tree
) == 0) {
79 strbuf_release(&realpath
);
83 strbuf_release(&realpath
);
88 * Normalize "path", prepending the "prefix" for relative paths. If
89 * remaining_prefix is not NULL, return the actual prefix still
90 * remains in the path. For example, prefix = sub1/sub2/ and path is
92 * foo -> sub1/sub2/foo (full prefix)
93 * ../foo -> sub1/foo (remaining prefix is sub1/)
94 * ../../bar -> bar (no remaining prefix)
95 * ../../sub1/sub2/foo -> sub1/sub2/foo (but no remaining prefix)
96 * `pwd`/../bar -> sub1/bar (no remaining prefix)
98 char *prefix_path_gently(const char *prefix
, int len
,
99 int *remaining_prefix
, const char *path
)
101 const char *orig
= path
;
103 if (is_absolute_path(orig
)) {
104 sanitized
= xmallocz(strlen(path
));
105 if (remaining_prefix
)
106 *remaining_prefix
= 0;
107 if (normalize_path_copy_len(sanitized
, path
, remaining_prefix
)) {
111 if (abspath_part_inside_repo(sanitized
)) {
116 sanitized
= xstrfmt("%.*s%s", len
, len
? prefix
: "", path
);
117 if (remaining_prefix
)
118 *remaining_prefix
= len
;
119 if (normalize_path_copy_len(sanitized
, sanitized
, remaining_prefix
)) {
127 char *prefix_path(const char *prefix
, int len
, const char *path
)
129 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
131 const char *hint_path
= get_git_work_tree();
133 hint_path
= get_git_dir();
134 die(_("'%s' is outside repository at '%s'"), path
,
135 absolute_path(hint_path
));
140 int path_inside_repo(const char *prefix
, const char *path
)
142 int len
= prefix
? strlen(prefix
) : 0;
143 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
151 int check_filename(const char *prefix
, const char *arg
)
153 char *to_free
= NULL
;
156 if (skip_prefix(arg
, ":/", &arg
)) {
157 if (!*arg
) /* ":/" is root dir, always exists */
160 } else if (skip_prefix(arg
, ":!", &arg
) ||
161 skip_prefix(arg
, ":^", &arg
)) {
162 if (!*arg
) /* excluding everything is silly, but allowed */
167 arg
= to_free
= prefix_filename(prefix
, arg
);
169 if (!lstat(arg
, &st
)) {
171 return 1; /* file exists */
173 if (is_missing_file_error(errno
)) {
175 return 0; /* file does not exist */
177 die_errno(_("failed to stat '%s'"), arg
);
180 static void NORETURN
die_verify_filename(struct repository
*r
,
183 int diagnose_misspelt_rev
)
185 if (!diagnose_misspelt_rev
)
186 die(_("%s: no such path in the working tree.\n"
187 "Use 'git <command> -- <path>...' to specify paths that do not exist locally."),
190 * Saying "'(icase)foo' does not exist in the index" when the
191 * user gave us ":(icase)foo" is just stupid. A magic pathspec
192 * begins with a colon and is followed by a non-alnum; do not
193 * let maybe_die_on_misspelt_object_name() even trigger.
195 if (!(arg
[0] == ':' && !isalnum(arg
[1])))
196 maybe_die_on_misspelt_object_name(r
, arg
, prefix
);
198 /* ... or fall back the most general message. */
199 die(_("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
200 "Use '--' to separate paths from revisions, like this:\n"
201 "'git <command> [<revision>...] -- [<file>...]'"), arg
);
206 * Check for arguments that don't resolve as actual files,
207 * but which look sufficiently like pathspecs that we'll consider
208 * them such for the purposes of rev/pathspec DWIM parsing.
210 static int looks_like_pathspec(const char *arg
)
216 * Wildcard characters imply the user is looking to match pathspecs
217 * that aren't in the filesystem. Note that this doesn't include
218 * backslash even though it's a glob special; by itself it doesn't
219 * cause any increase in the match. Likewise ignore backslash-escaped
220 * wildcard characters.
222 for (p
= arg
; *p
; p
++) {
225 } else if (is_glob_special(*p
)) {
233 /* long-form pathspec magic */
234 if (starts_with(arg
, ":("))
241 * Verify a filename that we got as an argument for a pathspec
242 * entry. Note that a filename that begins with "-" never verifies
243 * as true, because even if such a filename were to exist, we want
244 * it to be preceded by the "--" marker (or we want the user to
245 * use a format like "./-filename")
247 * The "diagnose_misspelt_rev" is used to provide a user-friendly
248 * diagnosis when dying upon finding that "name" is not a pathname.
249 * If set to 1, the diagnosis will try to diagnose "name" as an
250 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
251 * will only complain about an inexisting file.
253 * This function is typically called to check that a "file or rev"
254 * argument is unambiguous. In this case, the caller will want
255 * diagnose_misspelt_rev == 1 when verifying the first non-rev
256 * argument (which could have been a revision), and
257 * diagnose_misspelt_rev == 0 for the next ones (because we already
258 * saw a filename, there's not ambiguity anymore).
260 void verify_filename(const char *prefix
,
262 int diagnose_misspelt_rev
)
265 die(_("option '%s' must come before non-option arguments"), arg
);
266 if (looks_like_pathspec(arg
) || check_filename(prefix
, arg
))
268 die_verify_filename(the_repository
, prefix
, arg
, diagnose_misspelt_rev
);
272 * Opposite of the above: the command line did not have -- marker
273 * and we parsed the arg as a refname. It should not be interpretable
276 void verify_non_filename(const char *prefix
, const char *arg
)
278 if (!is_inside_work_tree() || is_inside_git_dir())
282 if (!check_filename(prefix
, arg
))
284 die(_("ambiguous argument '%s': both revision and filename\n"
285 "Use '--' to separate paths from revisions, like this:\n"
286 "'git <command> [<revision>...] -- [<file>...]'"), arg
);
289 int get_common_dir(struct strbuf
*sb
, const char *gitdir
)
291 const char *git_env_common_dir
= getenv(GIT_COMMON_DIR_ENVIRONMENT
);
292 if (git_env_common_dir
) {
293 strbuf_addstr(sb
, git_env_common_dir
);
296 return get_common_dir_noenv(sb
, gitdir
);
300 int get_common_dir_noenv(struct strbuf
*sb
, const char *gitdir
)
302 struct strbuf data
= STRBUF_INIT
;
303 struct strbuf path
= STRBUF_INIT
;
306 strbuf_addf(&path
, "%s/commondir", gitdir
);
307 if (file_exists(path
.buf
)) {
308 if (strbuf_read_file(&data
, path
.buf
, 0) <= 0)
309 die_errno(_("failed to read %s"), path
.buf
);
310 while (data
.len
&& (data
.buf
[data
.len
- 1] == '\n' ||
311 data
.buf
[data
.len
- 1] == '\r'))
313 data
.buf
[data
.len
] = '\0';
315 if (!is_absolute_path(data
.buf
))
316 strbuf_addf(&path
, "%s/", gitdir
);
317 strbuf_addbuf(&path
, &data
);
318 strbuf_add_real_path(sb
, path
.buf
);
321 strbuf_addstr(sb
, gitdir
);
324 strbuf_release(&data
);
325 strbuf_release(&path
);
330 * Test if it looks like we're at a git directory.
333 * - either an objects/ directory _or_ the proper
334 * GIT_OBJECT_DIRECTORY environment variable
335 * - a refs/ directory
336 * - either a HEAD symlink or a HEAD file that is formatted as
337 * a proper "ref:", or a regular file HEAD that has a properly
338 * formatted sha1 object name.
340 int is_git_directory(const char *suspect
)
342 struct strbuf path
= STRBUF_INIT
;
346 /* Check worktree-related signatures */
347 strbuf_addstr(&path
, suspect
);
348 strbuf_complete(&path
, '/');
349 strbuf_addstr(&path
, "HEAD");
350 if (validate_headref(path
.buf
))
354 get_common_dir(&path
, suspect
);
357 /* Check non-worktree-related signatures */
358 if (getenv(DB_ENVIRONMENT
)) {
359 if (access(getenv(DB_ENVIRONMENT
), X_OK
))
363 strbuf_setlen(&path
, len
);
364 strbuf_addstr(&path
, "/objects");
365 if (access(path
.buf
, X_OK
))
369 strbuf_setlen(&path
, len
);
370 strbuf_addstr(&path
, "/refs");
371 if (access(path
.buf
, X_OK
))
376 strbuf_release(&path
);
380 int is_nonbare_repository_dir(struct strbuf
*path
)
384 size_t orig_path_len
= path
->len
;
385 assert(orig_path_len
!= 0);
386 strbuf_complete(path
, '/');
387 strbuf_addstr(path
, ".git");
388 if (read_gitfile_gently(path
->buf
, &gitfile_error
) || is_git_directory(path
->buf
))
390 if (gitfile_error
== READ_GITFILE_ERR_OPEN_FAILED
||
391 gitfile_error
== READ_GITFILE_ERR_READ_FAILED
)
393 strbuf_setlen(path
, orig_path_len
);
397 int is_inside_git_dir(void)
399 if (inside_git_dir
< 0)
400 inside_git_dir
= is_inside_dir(get_git_dir());
401 return inside_git_dir
;
404 int is_inside_work_tree(void)
406 if (inside_work_tree
< 0)
407 inside_work_tree
= is_inside_dir(get_git_work_tree());
408 return inside_work_tree
;
411 void setup_work_tree(void)
413 const char *work_tree
;
414 static int initialized
= 0;
419 if (work_tree_config_is_bogus
)
420 die(_("unable to set up work tree using invalid config"));
422 work_tree
= get_git_work_tree();
423 if (!work_tree
|| chdir_notify(work_tree
))
424 die(_("this operation must be run in a work tree"));
427 * Make sure subsequent git processes find correct worktree
428 * if $GIT_WORK_TREE is set relative
430 if (getenv(GIT_WORK_TREE_ENVIRONMENT
))
431 setenv(GIT_WORK_TREE_ENVIRONMENT
, ".", 1);
436 static int read_worktree_config(const char *var
, const char *value
, void *vdata
)
438 struct repository_format
*data
= vdata
;
440 if (strcmp(var
, "core.bare") == 0) {
441 data
->is_bare
= git_config_bool(var
, value
);
442 } else if (strcmp(var
, "core.worktree") == 0) {
444 return config_error_nonbool(var
);
445 free(data
->work_tree
);
446 data
->work_tree
= xstrdup(value
);
451 enum extension_result
{
452 EXTENSION_ERROR
= -1, /* compatible with error(), etc */
453 EXTENSION_UNKNOWN
= 0,
458 * Do not add new extensions to this function. It handles extensions which are
459 * respected even in v0-format repositories for historical compatibility.
461 static enum extension_result
handle_extension_v0(const char *var
,
464 struct repository_format
*data
)
466 if (!strcmp(ext
, "noop")) {
468 } else if (!strcmp(ext
, "preciousobjects")) {
469 data
->precious_objects
= git_config_bool(var
, value
);
471 } else if (!strcmp(ext
, "partialclone")) {
472 data
->partial_clone
= xstrdup(value
);
474 } else if (!strcmp(ext
, "worktreeconfig")) {
475 data
->worktree_config
= git_config_bool(var
, value
);
479 return EXTENSION_UNKNOWN
;
483 * Record any new extensions in this function.
485 static enum extension_result
handle_extension(const char *var
,
488 struct repository_format
*data
)
490 if (!strcmp(ext
, "noop-v1")) {
492 } else if (!strcmp(ext
, "objectformat")) {
496 return config_error_nonbool(var
);
497 format
= hash_algo_by_name(value
);
498 if (format
== GIT_HASH_UNKNOWN
)
499 return error("invalid value for 'extensions.objectformat'");
500 data
->hash_algo
= format
;
503 return EXTENSION_UNKNOWN
;
506 static int check_repo_format(const char *var
, const char *value
, void *vdata
)
508 struct repository_format
*data
= vdata
;
511 if (strcmp(var
, "core.repositoryformatversion") == 0)
512 data
->version
= git_config_int(var
, value
);
513 else if (skip_prefix(var
, "extensions.", &ext
)) {
514 switch (handle_extension_v0(var
, value
, ext
, data
)) {
515 case EXTENSION_ERROR
:
519 case EXTENSION_UNKNOWN
:
523 switch (handle_extension(var
, value
, ext
, data
)) {
524 case EXTENSION_ERROR
:
527 string_list_append(&data
->v1_only_extensions
, ext
);
529 case EXTENSION_UNKNOWN
:
530 string_list_append(&data
->unknown_extensions
, ext
);
535 return read_worktree_config(var
, value
, vdata
);
538 static int check_repository_format_gently(const char *gitdir
, struct repository_format
*candidate
, int *nongit_ok
)
540 struct strbuf sb
= STRBUF_INIT
;
541 struct strbuf err
= STRBUF_INIT
;
544 has_common
= get_common_dir(&sb
, gitdir
);
545 strbuf_addstr(&sb
, "/config");
546 read_repository_format(candidate
, sb
.buf
);
550 * For historical use of check_repository_format() in git-init,
551 * we treat a missing config as a silent "ok", even when nongit_ok
554 if (candidate
->version
< 0)
557 if (verify_repository_format(candidate
, &err
) < 0) {
559 warning("%s", err
.buf
);
560 strbuf_release(&err
);
567 repository_format_precious_objects
= candidate
->precious_objects
;
568 repository_format_worktree_config
= candidate
->worktree_config
;
569 string_list_clear(&candidate
->unknown_extensions
, 0);
570 string_list_clear(&candidate
->v1_only_extensions
, 0);
572 if (repository_format_worktree_config
) {
574 * pick up core.bare and core.worktree from per-worktree
577 strbuf_addf(&sb
, "%s/config.worktree", gitdir
);
578 git_config_from_file(read_worktree_config
, sb
.buf
, candidate
);
584 if (candidate
->is_bare
!= -1) {
585 is_bare_repository_cfg
= candidate
->is_bare
;
586 if (is_bare_repository_cfg
== 1)
587 inside_work_tree
= -1;
589 if (candidate
->work_tree
) {
590 free(git_work_tree_cfg
);
591 git_work_tree_cfg
= xstrdup(candidate
->work_tree
);
592 inside_work_tree
= -1;
599 int upgrade_repository_format(int target_version
)
601 struct strbuf sb
= STRBUF_INIT
;
602 struct strbuf err
= STRBUF_INIT
;
603 struct strbuf repo_version
= STRBUF_INIT
;
604 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
606 strbuf_git_common_path(&sb
, the_repository
, "config");
607 read_repository_format(&repo_fmt
, sb
.buf
);
610 if (repo_fmt
.version
>= target_version
)
613 if (verify_repository_format(&repo_fmt
, &err
) < 0) {
614 error("cannot upgrade repository format from %d to %d: %s",
615 repo_fmt
.version
, target_version
, err
.buf
);
616 strbuf_release(&err
);
619 if (!repo_fmt
.version
&& repo_fmt
.unknown_extensions
.nr
)
620 return error("cannot upgrade repository format: "
621 "unknown extension %s",
622 repo_fmt
.unknown_extensions
.items
[0].string
);
624 strbuf_addf(&repo_version
, "%d", target_version
);
625 git_config_set("core.repositoryformatversion", repo_version
.buf
);
626 strbuf_release(&repo_version
);
630 static void init_repository_format(struct repository_format
*format
)
632 const struct repository_format fresh
= REPOSITORY_FORMAT_INIT
;
634 memcpy(format
, &fresh
, sizeof(fresh
));
637 int read_repository_format(struct repository_format
*format
, const char *path
)
639 clear_repository_format(format
);
640 git_config_from_file(check_repo_format
, path
, format
);
641 if (format
->version
== -1)
642 clear_repository_format(format
);
643 return format
->version
;
646 void clear_repository_format(struct repository_format
*format
)
648 string_list_clear(&format
->unknown_extensions
, 0);
649 string_list_clear(&format
->v1_only_extensions
, 0);
650 free(format
->work_tree
);
651 free(format
->partial_clone
);
652 init_repository_format(format
);
655 int verify_repository_format(const struct repository_format
*format
,
658 if (GIT_REPO_VERSION_READ
< format
->version
) {
659 strbuf_addf(err
, _("Expected git repo version <= %d, found %d"),
660 GIT_REPO_VERSION_READ
, format
->version
);
664 if (format
->version
>= 1 && format
->unknown_extensions
.nr
) {
667 strbuf_addstr(err
, Q_("unknown repository extension found:",
668 "unknown repository extensions found:",
669 format
->unknown_extensions
.nr
));
671 for (i
= 0; i
< format
->unknown_extensions
.nr
; i
++)
672 strbuf_addf(err
, "\n\t%s",
673 format
->unknown_extensions
.items
[i
].string
);
677 if (format
->version
== 0 && format
->v1_only_extensions
.nr
) {
681 Q_("repo version is 0, but v1-only extension found:",
682 "repo version is 0, but v1-only extensions found:",
683 format
->v1_only_extensions
.nr
));
685 for (i
= 0; i
< format
->v1_only_extensions
.nr
; i
++)
686 strbuf_addf(err
, "\n\t%s",
687 format
->v1_only_extensions
.items
[i
].string
);
694 void read_gitfile_error_die(int error_code
, const char *path
, const char *dir
)
696 switch (error_code
) {
697 case READ_GITFILE_ERR_STAT_FAILED
:
698 case READ_GITFILE_ERR_NOT_A_FILE
:
699 /* non-fatal; follow return path */
701 case READ_GITFILE_ERR_OPEN_FAILED
:
702 die_errno(_("error opening '%s'"), path
);
703 case READ_GITFILE_ERR_TOO_LARGE
:
704 die(_("too large to be a .git file: '%s'"), path
);
705 case READ_GITFILE_ERR_READ_FAILED
:
706 die(_("error reading %s"), path
);
707 case READ_GITFILE_ERR_INVALID_FORMAT
:
708 die(_("invalid gitfile format: %s"), path
);
709 case READ_GITFILE_ERR_NO_PATH
:
710 die(_("no path in gitfile: %s"), path
);
711 case READ_GITFILE_ERR_NOT_A_REPO
:
712 die(_("not a git repository: %s"), dir
);
714 BUG("unknown error code");
719 * Try to read the location of the git directory from the .git file,
720 * return path to git directory if found. The return value comes from
723 * On failure, if return_error_code is not NULL, return_error_code
724 * will be set to an error code and NULL will be returned. If
725 * return_error_code is NULL the function will die instead (for most
728 const char *read_gitfile_gently(const char *path
, int *return_error_code
)
730 const int max_file_size
= 1 << 20; /* 1MB */
738 static struct strbuf realpath
= STRBUF_INIT
;
740 if (stat(path
, &st
)) {
741 /* NEEDSWORK: discern between ENOENT vs other errors */
742 error_code
= READ_GITFILE_ERR_STAT_FAILED
;
745 if (!S_ISREG(st
.st_mode
)) {
746 error_code
= READ_GITFILE_ERR_NOT_A_FILE
;
749 if (st
.st_size
> max_file_size
) {
750 error_code
= READ_GITFILE_ERR_TOO_LARGE
;
753 fd
= open(path
, O_RDONLY
);
755 error_code
= READ_GITFILE_ERR_OPEN_FAILED
;
758 buf
= xmallocz(st
.st_size
);
759 len
= read_in_full(fd
, buf
, st
.st_size
);
761 if (len
!= st
.st_size
) {
762 error_code
= READ_GITFILE_ERR_READ_FAILED
;
765 if (!starts_with(buf
, "gitdir: ")) {
766 error_code
= READ_GITFILE_ERR_INVALID_FORMAT
;
769 while (buf
[len
- 1] == '\n' || buf
[len
- 1] == '\r')
772 error_code
= READ_GITFILE_ERR_NO_PATH
;
778 if (!is_absolute_path(dir
) && (slash
= strrchr(path
, '/'))) {
779 size_t pathlen
= slash
+1 - path
;
780 dir
= xstrfmt("%.*s%.*s", (int)pathlen
, path
,
781 (int)(len
- 8), buf
+ 8);
785 if (!is_git_directory(dir
)) {
786 error_code
= READ_GITFILE_ERR_NOT_A_REPO
;
790 strbuf_realpath(&realpath
, dir
, 1);
794 if (return_error_code
)
795 *return_error_code
= error_code
;
797 read_gitfile_error_die(error_code
, path
, dir
);
800 return error_code
? NULL
: path
;
803 static const char *setup_explicit_git_dir(const char *gitdirenv
,
805 struct repository_format
*repo_fmt
,
808 const char *work_tree_env
= getenv(GIT_WORK_TREE_ENVIRONMENT
);
809 const char *worktree
;
813 if (PATH_MAX
- 40 < strlen(gitdirenv
))
814 die(_("'$%s' too big"), GIT_DIR_ENVIRONMENT
);
816 gitfile
= (char*)read_gitfile(gitdirenv
);
818 gitfile
= xstrdup(gitfile
);
822 if (!is_git_directory(gitdirenv
)) {
828 die(_("not a git repository: '%s'"), gitdirenv
);
831 if (check_repository_format_gently(gitdirenv
, repo_fmt
, nongit_ok
)) {
836 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
838 set_git_work_tree(work_tree_env
);
839 else if (is_bare_repository_cfg
> 0) {
840 if (git_work_tree_cfg
) {
842 warning("core.bare and core.worktree do not make sense");
843 work_tree_config_is_bogus
= 1;
847 set_git_dir(gitdirenv
, 0);
851 else if (git_work_tree_cfg
) { /* #6, #14 */
852 if (is_absolute_path(git_work_tree_cfg
))
853 set_git_work_tree(git_work_tree_cfg
);
856 if (chdir(gitdirenv
))
857 die_errno(_("cannot chdir to '%s'"), gitdirenv
);
858 if (chdir(git_work_tree_cfg
))
859 die_errno(_("cannot chdir to '%s'"), git_work_tree_cfg
);
860 core_worktree
= xgetcwd();
862 die_errno(_("cannot come back to cwd"));
863 set_git_work_tree(core_worktree
);
867 else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, 1)) {
869 set_git_dir(gitdirenv
, 0);
874 set_git_work_tree(".");
876 /* set_git_work_tree() must have been called by now */
877 worktree
= get_git_work_tree();
879 /* both get_git_work_tree() and cwd are already normalized */
880 if (!strcmp(cwd
->buf
, worktree
)) { /* cwd == worktree */
881 set_git_dir(gitdirenv
, 0);
886 offset
= dir_inside_of(cwd
->buf
, worktree
);
887 if (offset
>= 0) { /* cwd inside worktree? */
888 set_git_dir(gitdirenv
, 1);
890 die_errno(_("cannot chdir to '%s'"), worktree
);
891 strbuf_addch(cwd
, '/');
893 return cwd
->buf
+ offset
;
896 /* cwd outside worktree */
897 set_git_dir(gitdirenv
, 0);
902 static const char *setup_discovered_git_dir(const char *gitdir
,
903 struct strbuf
*cwd
, int offset
,
904 struct repository_format
*repo_fmt
,
907 if (check_repository_format_gently(gitdir
, repo_fmt
, nongit_ok
))
910 /* --work-tree is set without --git-dir; use discovered one */
911 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
912 char *to_free
= NULL
;
915 if (offset
!= cwd
->len
&& !is_absolute_path(gitdir
))
916 gitdir
= to_free
= real_pathdup(gitdir
, 1);
918 die_errno(_("cannot come back to cwd"));
919 ret
= setup_explicit_git_dir(gitdir
, cwd
, repo_fmt
, nongit_ok
);
924 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
925 if (is_bare_repository_cfg
> 0) {
926 set_git_dir(gitdir
, (offset
!= cwd
->len
));
928 die_errno(_("cannot come back to cwd"));
932 /* #0, #1, #5, #8, #9, #12, #13 */
933 set_git_work_tree(".");
934 if (strcmp(gitdir
, DEFAULT_GIT_DIR_ENVIRONMENT
))
935 set_git_dir(gitdir
, 0);
937 inside_work_tree
= 1;
938 if (offset
>= cwd
->len
)
941 /* Make "offset" point past the '/' (already the case for root dirs) */
942 if (offset
!= offset_1st_component(cwd
->buf
))
944 /* Add a '/' at the end */
945 strbuf_addch(cwd
, '/');
946 return cwd
->buf
+ offset
;
949 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
950 static const char *setup_bare_git_dir(struct strbuf
*cwd
, int offset
,
951 struct repository_format
*repo_fmt
,
956 if (check_repository_format_gently(".", repo_fmt
, nongit_ok
))
959 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, "0", 1);
961 /* --work-tree is set without --git-dir; use discovered one */
962 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
963 static const char *gitdir
;
965 gitdir
= offset
== cwd
->len
? "." : xmemdupz(cwd
->buf
, offset
);
967 die_errno(_("cannot come back to cwd"));
968 return setup_explicit_git_dir(gitdir
, cwd
, repo_fmt
, nongit_ok
);
972 inside_work_tree
= 0;
973 if (offset
!= cwd
->len
) {
975 die_errno(_("cannot come back to cwd"));
976 root_len
= offset_1st_component(cwd
->buf
);
977 strbuf_setlen(cwd
, offset
> root_len
? offset
: root_len
);
978 set_git_dir(cwd
->buf
, 0);
985 static dev_t
get_device_or_die(const char *path
, const char *prefix
, int prefix_len
)
988 if (stat(path
, &buf
)) {
989 die_errno(_("failed to stat '%*s%s%s'"),
991 prefix
? prefix
: "",
992 prefix
? "/" : "", path
);
998 * A "string_list_each_func_t" function that canonicalizes an entry
999 * from GIT_CEILING_DIRECTORIES using real_pathdup(), or
1000 * discards it if unusable. The presence of an empty entry in
1001 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
1002 * subsequent entries.
1004 static int canonicalize_ceiling_entry(struct string_list_item
*item
,
1007 int *empty_entry_found
= cb_data
;
1008 char *ceil
= item
->string
;
1011 *empty_entry_found
= 1;
1013 } else if (!is_absolute_path(ceil
)) {
1015 } else if (*empty_entry_found
) {
1016 /* Keep entry but do not canonicalize it */
1019 char *real_path
= real_pathdup(ceil
, 0);
1024 item
->string
= real_path
;
1029 struct safe_directory_data
{
1034 static int safe_directory_cb(const char *key
, const char *value
, void *d
)
1036 struct safe_directory_data
*data
= d
;
1038 if (strcmp(key
, "safe.directory"))
1041 if (!value
|| !*value
) {
1043 } else if (!strcmp(value
, "*")) {
1046 const char *interpolated
= NULL
;
1048 if (!git_config_pathname(&interpolated
, key
, value
) &&
1049 !fspathcmp(data
->path
, interpolated
? interpolated
: value
))
1052 free((char *)interpolated
);
1059 * Check if a repository is safe, by verifying the ownership of the
1060 * worktree (if any), the git directory, and the gitfile (if any).
1062 * Exemptions for known-safe repositories can be added via `safe.directory`
1063 * config settings; for non-bare repositories, their worktree needs to be
1064 * added, for bare ones their git directory.
1066 static int ensure_valid_ownership(const char *gitfile
,
1067 const char *worktree
, const char *gitdir
)
1069 struct safe_directory_data data
= {
1070 .path
= worktree
? worktree
: gitdir
1073 if (!git_env_bool("GIT_TEST_ASSUME_DIFFERENT_OWNER", 0) &&
1074 (!gitfile
|| is_path_owned_by_current_user(gitfile
)) &&
1075 (!worktree
|| is_path_owned_by_current_user(worktree
)) &&
1076 (!gitdir
|| is_path_owned_by_current_user(gitdir
)))
1080 * data.path is the "path" that identifies the repository and it is
1081 * constant regardless of what failed above. data.is_safe should be
1082 * initialized to false, and might be changed by the callback.
1084 read_very_early_config(safe_directory_cb
, &data
);
1086 return data
.is_safe
;
1089 enum discovery_result
{
1094 /* these are errors */
1095 GIT_DIR_HIT_CEILING
= -1,
1096 GIT_DIR_HIT_MOUNT_POINT
= -2,
1097 GIT_DIR_INVALID_GITFILE
= -3,
1098 GIT_DIR_INVALID_OWNERSHIP
= -4
1102 * We cannot decide in this function whether we are in the work tree or
1103 * not, since the config can only be read _after_ this function was called.
1105 * Also, we avoid changing any global state (such as the current working
1106 * directory) to allow early callers.
1108 * The directory where the search should start needs to be passed in via the
1109 * `dir` parameter; upon return, the `dir` buffer will contain the path of
1110 * the directory where the search ended, and `gitdir` will contain the path of
1111 * the discovered .git/ directory, if any. If `gitdir` is not absolute, it
1112 * is relative to `dir` (i.e. *not* necessarily the cwd).
1114 static enum discovery_result
setup_git_directory_gently_1(struct strbuf
*dir
,
1115 struct strbuf
*gitdir
,
1118 const char *env_ceiling_dirs
= getenv(CEILING_DIRECTORIES_ENVIRONMENT
);
1119 struct string_list ceiling_dirs
= STRING_LIST_INIT_DUP
;
1120 const char *gitdirenv
;
1121 int ceil_offset
= -1, min_offset
= offset_1st_component(dir
->buf
);
1122 dev_t current_device
= 0;
1123 int one_filesystem
= 1;
1126 * If GIT_DIR is set explicitly, we're not going
1127 * to do any discovery, but we still do repository
1130 gitdirenv
= getenv(GIT_DIR_ENVIRONMENT
);
1132 strbuf_addstr(gitdir
, gitdirenv
);
1133 return GIT_DIR_EXPLICIT
;
1136 if (env_ceiling_dirs
) {
1137 int empty_entry_found
= 0;
1139 string_list_split(&ceiling_dirs
, env_ceiling_dirs
, PATH_SEP
, -1);
1140 filter_string_list(&ceiling_dirs
, 0,
1141 canonicalize_ceiling_entry
, &empty_entry_found
);
1142 ceil_offset
= longest_ancestor_length(dir
->buf
, &ceiling_dirs
);
1143 string_list_clear(&ceiling_dirs
, 0);
1146 if (ceil_offset
< 0)
1147 ceil_offset
= min_offset
- 2;
1149 if (min_offset
&& min_offset
== dir
->len
&&
1150 !is_dir_sep(dir
->buf
[min_offset
- 1])) {
1151 strbuf_addch(dir
, '/');
1156 * Test in the following order (relative to the dir):
1157 * - .git (file containing "gitdir: <path>")
1166 one_filesystem
= !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
1168 current_device
= get_device_or_die(dir
->buf
, NULL
, 0);
1170 int offset
= dir
->len
, error_code
= 0;
1171 char *gitdir_path
= NULL
;
1172 char *gitfile
= NULL
;
1174 if (offset
> min_offset
)
1175 strbuf_addch(dir
, '/');
1176 strbuf_addstr(dir
, DEFAULT_GIT_DIR_ENVIRONMENT
);
1177 gitdirenv
= read_gitfile_gently(dir
->buf
, die_on_error
?
1178 NULL
: &error_code
);
1181 error_code
== READ_GITFILE_ERR_NOT_A_FILE
) {
1182 /* NEEDSWORK: fail if .git is not file nor dir */
1183 if (is_git_directory(dir
->buf
)) {
1184 gitdirenv
= DEFAULT_GIT_DIR_ENVIRONMENT
;
1185 gitdir_path
= xstrdup(dir
->buf
);
1187 } else if (error_code
!= READ_GITFILE_ERR_STAT_FAILED
)
1188 return GIT_DIR_INVALID_GITFILE
;
1190 gitfile
= xstrdup(dir
->buf
);
1192 * Earlier, we tentatively added DEFAULT_GIT_DIR_ENVIRONMENT
1193 * to check that directory for a repository.
1194 * Now trim that tentative addition away, because we want to
1195 * focus on the real directory we are in.
1197 strbuf_setlen(dir
, offset
);
1199 enum discovery_result ret
;
1201 if (ensure_valid_ownership(gitfile
,
1203 (gitdir_path
? gitdir_path
: gitdirenv
))) {
1204 strbuf_addstr(gitdir
, gitdirenv
);
1205 ret
= GIT_DIR_DISCOVERED
;
1207 ret
= GIT_DIR_INVALID_OWNERSHIP
;
1210 * Earlier, during discovery, we might have allocated
1211 * string copies for gitdir_path or gitfile so make
1212 * sure we don't leak by freeing them now, before
1213 * leaving the loop and function.
1215 * Note: gitdirenv will be non-NULL whenever these are
1216 * allocated, therefore we need not take care of releasing
1217 * them outside of this conditional block.
1225 if (is_git_directory(dir
->buf
)) {
1226 if (!ensure_valid_ownership(NULL
, NULL
, dir
->buf
))
1227 return GIT_DIR_INVALID_OWNERSHIP
;
1228 strbuf_addstr(gitdir
, ".");
1229 return GIT_DIR_BARE
;
1232 if (offset
<= min_offset
)
1233 return GIT_DIR_HIT_CEILING
;
1235 while (--offset
> ceil_offset
&& !is_dir_sep(dir
->buf
[offset
]))
1237 if (offset
<= ceil_offset
)
1238 return GIT_DIR_HIT_CEILING
;
1240 strbuf_setlen(dir
, offset
> min_offset
? offset
: min_offset
);
1241 if (one_filesystem
&&
1242 current_device
!= get_device_or_die(dir
->buf
, NULL
, offset
))
1243 return GIT_DIR_HIT_MOUNT_POINT
;
1247 int discover_git_directory(struct strbuf
*commondir
,
1248 struct strbuf
*gitdir
)
1250 struct strbuf dir
= STRBUF_INIT
, err
= STRBUF_INIT
;
1251 size_t gitdir_offset
= gitdir
->len
, cwd_len
;
1252 size_t commondir_offset
= commondir
->len
;
1253 struct repository_format candidate
= REPOSITORY_FORMAT_INIT
;
1255 if (strbuf_getcwd(&dir
))
1259 if (setup_git_directory_gently_1(&dir
, gitdir
, 0) <= 0) {
1260 strbuf_release(&dir
);
1265 * The returned gitdir is relative to dir, and if dir does not reflect
1266 * the current working directory, we simply make the gitdir absolute.
1268 if (dir
.len
< cwd_len
&& !is_absolute_path(gitdir
->buf
+ gitdir_offset
)) {
1269 /* Avoid a trailing "/." */
1270 if (!strcmp(".", gitdir
->buf
+ gitdir_offset
))
1271 strbuf_setlen(gitdir
, gitdir_offset
);
1273 strbuf_addch(&dir
, '/');
1274 strbuf_insert(gitdir
, gitdir_offset
, dir
.buf
, dir
.len
);
1277 get_common_dir(commondir
, gitdir
->buf
+ gitdir_offset
);
1280 strbuf_addf(&dir
, "%s/config", commondir
->buf
+ commondir_offset
);
1281 read_repository_format(&candidate
, dir
.buf
);
1282 strbuf_release(&dir
);
1284 if (verify_repository_format(&candidate
, &err
) < 0) {
1285 warning("ignoring git dir '%s': %s",
1286 gitdir
->buf
+ gitdir_offset
, err
.buf
);
1287 strbuf_release(&err
);
1288 strbuf_setlen(commondir
, commondir_offset
);
1289 strbuf_setlen(gitdir
, gitdir_offset
);
1290 clear_repository_format(&candidate
);
1294 /* take ownership of candidate.partial_clone */
1295 the_repository
->repository_format_partial_clone
=
1296 candidate
.partial_clone
;
1297 candidate
.partial_clone
= NULL
;
1299 clear_repository_format(&candidate
);
1303 const char *setup_git_directory_gently(int *nongit_ok
)
1305 static struct strbuf cwd
= STRBUF_INIT
;
1306 struct strbuf dir
= STRBUF_INIT
, gitdir
= STRBUF_INIT
;
1307 const char *prefix
= NULL
;
1308 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
1311 * We may have read an incomplete configuration before
1312 * setting-up the git directory. If so, clear the cache so
1313 * that the next queries to the configuration reload complete
1314 * configuration (including the per-repo config file that we
1315 * ignored previously).
1320 * Let's assume that we are in a git repository.
1321 * If it turns out later that we are somewhere else, the value will be
1322 * updated accordingly.
1327 if (strbuf_getcwd(&cwd
))
1328 die_errno(_("Unable to read current working directory"));
1329 strbuf_addbuf(&dir
, &cwd
);
1331 switch (setup_git_directory_gently_1(&dir
, &gitdir
, 1)) {
1332 case GIT_DIR_EXPLICIT
:
1333 prefix
= setup_explicit_git_dir(gitdir
.buf
, &cwd
, &repo_fmt
, nongit_ok
);
1335 case GIT_DIR_DISCOVERED
:
1336 if (dir
.len
< cwd
.len
&& chdir(dir
.buf
))
1337 die(_("cannot change to '%s'"), dir
.buf
);
1338 prefix
= setup_discovered_git_dir(gitdir
.buf
, &cwd
, dir
.len
,
1339 &repo_fmt
, nongit_ok
);
1342 if (dir
.len
< cwd
.len
&& chdir(dir
.buf
))
1343 die(_("cannot change to '%s'"), dir
.buf
);
1344 prefix
= setup_bare_git_dir(&cwd
, dir
.len
, &repo_fmt
, nongit_ok
);
1346 case GIT_DIR_HIT_CEILING
:
1348 die(_("not a git repository (or any of the parent directories): %s"),
1349 DEFAULT_GIT_DIR_ENVIRONMENT
);
1352 case GIT_DIR_HIT_MOUNT_POINT
:
1354 die(_("not a git repository (or any parent up to mount point %s)\n"
1355 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set)."),
1359 case GIT_DIR_INVALID_OWNERSHIP
:
1361 struct strbuf quoted
= STRBUF_INIT
;
1363 sq_quote_buf_pretty("ed
, dir
.buf
);
1364 die(_("detected dubious ownership in repository at '%s'\n"
1365 "To add an exception for this directory, call:\n"
1367 "\tgit config --global --add safe.directory %s"),
1368 dir
.buf
, quoted
.buf
);
1374 * As a safeguard against setup_git_directory_gently_1 returning
1375 * this value, fallthrough to BUG. Otherwise it is possible to
1376 * set startup_info->have_repository to 1 when we did nothing to
1377 * find a repository.
1380 BUG("unhandled setup_git_directory_1() result");
1384 * At this point, nongit_ok is stable. If it is non-NULL and points
1385 * to a non-zero value, then this means that we haven't found a
1386 * repository and that the caller expects startup_info to reflect
1389 * Regardless of the state of nongit_ok, startup_info->prefix and
1390 * the GIT_PREFIX environment variable must always match. For details
1391 * see Documentation/config/alias.txt.
1393 if (nongit_ok
&& *nongit_ok
)
1394 startup_info
->have_repository
= 0;
1396 startup_info
->have_repository
= 1;
1399 * Not all paths through the setup code will call 'set_git_dir()' (which
1400 * directly sets up the environment) so in order to guarantee that the
1401 * environment is in a consistent state after setup, explicitly setup
1402 * the environment if we have a repository.
1404 * NEEDSWORK: currently we allow bogus GIT_DIR values to be set in some
1405 * code paths so we also need to explicitly setup the environment if
1406 * the user has set GIT_DIR. It may be beneficial to disallow bogus
1407 * GIT_DIR values at some point in the future.
1409 if (/* GIT_DIR_EXPLICIT, GIT_DIR_DISCOVERED, GIT_DIR_BARE */
1410 startup_info
->have_repository
||
1411 /* GIT_DIR_EXPLICIT */
1412 getenv(GIT_DIR_ENVIRONMENT
)) {
1413 if (!the_repository
->gitdir
) {
1414 const char *gitdir
= getenv(GIT_DIR_ENVIRONMENT
);
1416 gitdir
= DEFAULT_GIT_DIR_ENVIRONMENT
;
1417 setup_git_env(gitdir
);
1419 if (startup_info
->have_repository
) {
1420 repo_set_hash_algo(the_repository
, repo_fmt
.hash_algo
);
1421 /* take ownership of repo_fmt.partial_clone */
1422 the_repository
->repository_format_partial_clone
=
1423 repo_fmt
.partial_clone
;
1424 repo_fmt
.partial_clone
= NULL
;
1428 * Since precompose_string_if_needed() needs to look at
1429 * the core.precomposeunicode configuration, this
1430 * has to happen after the above block that finds
1431 * out where the repository is, i.e. a preparation
1432 * for calling git_config_get_bool().
1435 prefix
= precompose_string_if_needed(prefix
);
1436 startup_info
->prefix
= prefix
;
1437 setenv(GIT_PREFIX_ENVIRONMENT
, prefix
, 1);
1439 startup_info
->prefix
= NULL
;
1440 setenv(GIT_PREFIX_ENVIRONMENT
, "", 1);
1444 strbuf_release(&dir
);
1445 strbuf_release(&gitdir
);
1446 clear_repository_format(&repo_fmt
);
1451 int git_config_perm(const char *var
, const char *value
)
1459 if (!strcmp(value
, "umask"))
1461 if (!strcmp(value
, "group"))
1463 if (!strcmp(value
, "all") ||
1464 !strcmp(value
, "world") ||
1465 !strcmp(value
, "everybody"))
1466 return PERM_EVERYBODY
;
1468 /* Parse octal numbers */
1469 i
= strtol(value
, &endptr
, 8);
1471 /* If not an octal number, maybe true/false? */
1473 return git_config_bool(var
, value
) ? PERM_GROUP
: PERM_UMASK
;
1476 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
1477 * a chmod value to restrict to.
1480 case PERM_UMASK
: /* 0 */
1482 case OLD_PERM_GROUP
: /* 1 */
1484 case OLD_PERM_EVERYBODY
: /* 2 */
1485 return PERM_EVERYBODY
;
1488 /* A filemode value was given: 0xxx */
1490 if ((i
& 0600) != 0600)
1491 die(_("problem with core.sharedRepository filemode value "
1492 "(0%.3o).\nThe owner of files must always have "
1493 "read and write permissions."), i
);
1496 * Mask filemode value. Others can not get write permission.
1497 * x flags for directories are handled separately.
1502 void check_repository_format(struct repository_format
*fmt
)
1504 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
1507 check_repository_format_gently(get_git_dir(), fmt
, NULL
);
1508 startup_info
->have_repository
= 1;
1509 repo_set_hash_algo(the_repository
, fmt
->hash_algo
);
1510 the_repository
->repository_format_partial_clone
=
1511 xstrdup_or_null(fmt
->partial_clone
);
1512 clear_repository_format(&repo_fmt
);
1516 * Returns the "prefix", a path to the current working directory
1517 * relative to the work tree root, or NULL, if the current working
1518 * directory is not a strict subdirectory of the work tree root. The
1519 * prefix always ends with a '/' character.
1521 const char *setup_git_directory(void)
1523 return setup_git_directory_gently(NULL
);
1526 const char *resolve_gitdir_gently(const char *suspect
, int *return_error_code
)
1528 if (is_git_directory(suspect
))
1530 return read_gitfile_gently(suspect
, return_error_code
);
1533 /* if any standard file descriptor is missing open it to /dev/null */
1534 void sanitize_stdfds(void)
1536 int fd
= xopen("/dev/null", O_RDWR
);
1545 #ifdef NO_POSIX_GOODIES
1553 die_errno(_("fork failed"));
1558 die_errno(_("setsid failed"));