2 #include "repository.h"
5 #include "string-list.h"
6 #include "chdir-notify.h"
7 #include "promisor-remote.h"
9 static int inside_git_dir
= -1;
10 static int inside_work_tree
= -1;
11 static int work_tree_config_is_bogus
;
13 static struct startup_info the_startup_info
;
14 struct startup_info
*startup_info
= &the_startup_info
;
17 * The input parameter must contain an absolute path, and it must already be
20 * Find the part of an absolute path that lies inside the work tree by
21 * dereferencing symlinks outside the work tree, for example:
22 * /dir1/repo/dir2/file (work tree is /dir1/repo) -> dir2/file
23 * /dir/file (work tree is /) -> dir/file
24 * /dir/symlink1/symlink2 (symlink1 points to work tree) -> symlink2
25 * /dir/repolink/file (repolink points to /dir/repo) -> file
26 * /dir/repo (exactly equal to work tree) -> (empty string)
28 static int abspath_part_inside_repo(char *path
)
34 const char *work_tree
= get_git_work_tree();
38 wtlen
= strlen(work_tree
);
40 off
= offset_1st_component(path
);
42 /* check if work tree is already the prefix */
43 if (wtlen
<= len
&& !fspathncmp(path
, work_tree
, wtlen
)) {
44 if (path
[wtlen
] == '/') {
45 memmove(path
, path
+ wtlen
+ 1, len
- wtlen
);
47 } else if (path
[wtlen
- 1] == '/' || path
[wtlen
] == '\0') {
48 /* work tree is the root, or the whole path */
49 memmove(path
, path
+ wtlen
, len
- wtlen
+ 1);
52 /* work tree might match beginning of a symlink to work tree */
58 /* check each '/'-terminated level */
63 if (fspathcmp(real_path(path0
), work_tree
) == 0) {
64 memmove(path0
, path
+ 1, len
- (path
- path0
));
71 /* check whole path */
72 if (fspathcmp(real_path(path0
), work_tree
) == 0) {
81 * Normalize "path", prepending the "prefix" for relative paths. If
82 * remaining_prefix is not NULL, return the actual prefix still
83 * remains in the path. For example, prefix = sub1/sub2/ and path is
85 * foo -> sub1/sub2/foo (full prefix)
86 * ../foo -> sub1/foo (remaining prefix is sub1/)
87 * ../../bar -> bar (no remaining prefix)
88 * ../../sub1/sub2/foo -> sub1/sub2/foo (but no remaining prefix)
89 * `pwd`/../bar -> sub1/bar (no remaining prefix)
91 char *prefix_path_gently(const char *prefix
, int len
,
92 int *remaining_prefix
, const char *path
)
94 const char *orig
= path
;
96 if (is_absolute_path(orig
)) {
97 sanitized
= xmallocz(strlen(path
));
99 *remaining_prefix
= 0;
100 if (normalize_path_copy_len(sanitized
, path
, remaining_prefix
)) {
104 if (abspath_part_inside_repo(sanitized
)) {
109 sanitized
= xstrfmt("%.*s%s", len
, len
? prefix
: "", path
);
110 if (remaining_prefix
)
111 *remaining_prefix
= len
;
112 if (normalize_path_copy_len(sanitized
, sanitized
, remaining_prefix
)) {
120 char *prefix_path(const char *prefix
, int len
, const char *path
)
122 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
124 die(_("'%s' is outside repository at '%s'"), path
,
125 absolute_path(get_git_work_tree()));
129 int path_inside_repo(const char *prefix
, const char *path
)
131 int len
= prefix
? strlen(prefix
) : 0;
132 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
140 int check_filename(const char *prefix
, const char *arg
)
142 char *to_free
= NULL
;
145 if (skip_prefix(arg
, ":/", &arg
)) {
146 if (!*arg
) /* ":/" is root dir, always exists */
149 } else if (skip_prefix(arg
, ":!", &arg
) ||
150 skip_prefix(arg
, ":^", &arg
)) {
151 if (!*arg
) /* excluding everything is silly, but allowed */
156 arg
= to_free
= prefix_filename(prefix
, arg
);
158 if (!lstat(arg
, &st
)) {
160 return 1; /* file exists */
162 if (is_missing_file_error(errno
)) {
164 return 0; /* file does not exist */
166 die_errno(_("failed to stat '%s'"), arg
);
169 static void NORETURN
die_verify_filename(struct repository
*r
,
172 int diagnose_misspelt_rev
)
174 if (!diagnose_misspelt_rev
)
175 die(_("%s: no such path in the working tree.\n"
176 "Use 'git <command> -- <path>...' to specify paths that do not exist locally."),
179 * Saying "'(icase)foo' does not exist in the index" when the
180 * user gave us ":(icase)foo" is just stupid. A magic pathspec
181 * begins with a colon and is followed by a non-alnum; do not
182 * let maybe_die_on_misspelt_object_name() even trigger.
184 if (!(arg
[0] == ':' && !isalnum(arg
[1])))
185 maybe_die_on_misspelt_object_name(r
, arg
, prefix
);
187 /* ... or fall back the most general message. */
188 die(_("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
189 "Use '--' to separate paths from revisions, like this:\n"
190 "'git <command> [<revision>...] -- [<file>...]'"), arg
);
195 * Check for arguments that don't resolve as actual files,
196 * but which look sufficiently like pathspecs that we'll consider
197 * them such for the purposes of rev/pathspec DWIM parsing.
199 static int looks_like_pathspec(const char *arg
)
201 /* anything with a wildcard character */
202 if (!no_wildcard(arg
))
205 /* long-form pathspec magic */
206 if (starts_with(arg
, ":("))
213 * Verify a filename that we got as an argument for a pathspec
214 * entry. Note that a filename that begins with "-" never verifies
215 * as true, because even if such a filename were to exist, we want
216 * it to be preceded by the "--" marker (or we want the user to
217 * use a format like "./-filename")
219 * The "diagnose_misspelt_rev" is used to provide a user-friendly
220 * diagnosis when dying upon finding that "name" is not a pathname.
221 * If set to 1, the diagnosis will try to diagnose "name" as an
222 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
223 * will only complain about an inexisting file.
225 * This function is typically called to check that a "file or rev"
226 * argument is unambiguous. In this case, the caller will want
227 * diagnose_misspelt_rev == 1 when verifying the first non-rev
228 * argument (which could have been a revision), and
229 * diagnose_misspelt_rev == 0 for the next ones (because we already
230 * saw a filename, there's not ambiguity anymore).
232 void verify_filename(const char *prefix
,
234 int diagnose_misspelt_rev
)
237 die(_("option '%s' must come before non-option arguments"), arg
);
238 if (looks_like_pathspec(arg
) || check_filename(prefix
, arg
))
240 die_verify_filename(the_repository
, prefix
, arg
, diagnose_misspelt_rev
);
244 * Opposite of the above: the command line did not have -- marker
245 * and we parsed the arg as a refname. It should not be interpretable
248 void verify_non_filename(const char *prefix
, const char *arg
)
250 if (!is_inside_work_tree() || is_inside_git_dir())
254 if (!check_filename(prefix
, arg
))
256 die(_("ambiguous argument '%s': both revision and filename\n"
257 "Use '--' to separate paths from revisions, like this:\n"
258 "'git <command> [<revision>...] -- [<file>...]'"), arg
);
261 int get_common_dir(struct strbuf
*sb
, const char *gitdir
)
263 const char *git_env_common_dir
= getenv(GIT_COMMON_DIR_ENVIRONMENT
);
264 if (git_env_common_dir
) {
265 strbuf_addstr(sb
, git_env_common_dir
);
268 return get_common_dir_noenv(sb
, gitdir
);
272 int get_common_dir_noenv(struct strbuf
*sb
, const char *gitdir
)
274 struct strbuf data
= STRBUF_INIT
;
275 struct strbuf path
= STRBUF_INIT
;
278 strbuf_addf(&path
, "%s/commondir", gitdir
);
279 if (file_exists(path
.buf
)) {
280 if (strbuf_read_file(&data
, path
.buf
, 0) <= 0)
281 die_errno(_("failed to read %s"), path
.buf
);
282 while (data
.len
&& (data
.buf
[data
.len
- 1] == '\n' ||
283 data
.buf
[data
.len
- 1] == '\r'))
285 data
.buf
[data
.len
] = '\0';
287 if (!is_absolute_path(data
.buf
))
288 strbuf_addf(&path
, "%s/", gitdir
);
289 strbuf_addbuf(&path
, &data
);
290 strbuf_add_real_path(sb
, path
.buf
);
293 strbuf_addstr(sb
, gitdir
);
296 strbuf_release(&data
);
297 strbuf_release(&path
);
302 * Test if it looks like we're at a git directory.
305 * - either an objects/ directory _or_ the proper
306 * GIT_OBJECT_DIRECTORY environment variable
307 * - a refs/ directory
308 * - either a HEAD symlink or a HEAD file that is formatted as
309 * a proper "ref:", or a regular file HEAD that has a properly
310 * formatted sha1 object name.
312 int is_git_directory(const char *suspect
)
314 struct strbuf path
= STRBUF_INIT
;
318 /* Check worktree-related signatures */
319 strbuf_addstr(&path
, suspect
);
320 strbuf_complete(&path
, '/');
321 strbuf_addstr(&path
, "HEAD");
322 if (validate_headref(path
.buf
))
326 get_common_dir(&path
, suspect
);
329 /* Check non-worktree-related signatures */
330 if (getenv(DB_ENVIRONMENT
)) {
331 if (access(getenv(DB_ENVIRONMENT
), X_OK
))
335 strbuf_setlen(&path
, len
);
336 strbuf_addstr(&path
, "/objects");
337 if (access(path
.buf
, X_OK
))
341 strbuf_setlen(&path
, len
);
342 strbuf_addstr(&path
, "/refs");
343 if (access(path
.buf
, X_OK
))
348 strbuf_release(&path
);
352 int is_nonbare_repository_dir(struct strbuf
*path
)
356 size_t orig_path_len
= path
->len
;
357 assert(orig_path_len
!= 0);
358 strbuf_complete(path
, '/');
359 strbuf_addstr(path
, ".git");
360 if (read_gitfile_gently(path
->buf
, &gitfile_error
) || is_git_directory(path
->buf
))
362 if (gitfile_error
== READ_GITFILE_ERR_OPEN_FAILED
||
363 gitfile_error
== READ_GITFILE_ERR_READ_FAILED
)
365 strbuf_setlen(path
, orig_path_len
);
369 int is_inside_git_dir(void)
371 if (inside_git_dir
< 0)
372 inside_git_dir
= is_inside_dir(get_git_dir());
373 return inside_git_dir
;
376 int is_inside_work_tree(void)
378 if (inside_work_tree
< 0)
379 inside_work_tree
= is_inside_dir(get_git_work_tree());
380 return inside_work_tree
;
383 void setup_work_tree(void)
385 const char *work_tree
;
386 static int initialized
= 0;
391 if (work_tree_config_is_bogus
)
392 die(_("unable to set up work tree using invalid config"));
394 work_tree
= get_git_work_tree();
395 if (!work_tree
|| chdir_notify(work_tree
))
396 die(_("this operation must be run in a work tree"));
399 * Make sure subsequent git processes find correct worktree
400 * if $GIT_WORK_TREE is set relative
402 if (getenv(GIT_WORK_TREE_ENVIRONMENT
))
403 setenv(GIT_WORK_TREE_ENVIRONMENT
, ".", 1);
408 static int read_worktree_config(const char *var
, const char *value
, void *vdata
)
410 struct repository_format
*data
= vdata
;
412 if (strcmp(var
, "core.bare") == 0) {
413 data
->is_bare
= git_config_bool(var
, value
);
414 } else if (strcmp(var
, "core.worktree") == 0) {
416 return config_error_nonbool(var
);
417 free(data
->work_tree
);
418 data
->work_tree
= xstrdup(value
);
423 static int check_repo_format(const char *var
, const char *value
, void *vdata
)
425 struct repository_format
*data
= vdata
;
428 if (strcmp(var
, "core.repositoryformatversion") == 0)
429 data
->version
= git_config_int(var
, value
);
430 else if (skip_prefix(var
, "extensions.", &ext
)) {
432 * record any known extensions here; otherwise,
433 * we fall through to recording it as unknown, and
434 * check_repository_format will complain
436 if (!strcmp(ext
, "noop"))
438 else if (!strcmp(ext
, "preciousobjects"))
439 data
->precious_objects
= git_config_bool(var
, value
);
440 else if (!strcmp(ext
, "partialclone")) {
442 return config_error_nonbool(var
);
443 data
->partial_clone
= xstrdup(value
);
444 } else if (!strcmp(ext
, "worktreeconfig"))
445 data
->worktree_config
= git_config_bool(var
, value
);
447 string_list_append(&data
->unknown_extensions
, ext
);
450 return read_worktree_config(var
, value
, vdata
);
453 static int check_repository_format_gently(const char *gitdir
, struct repository_format
*candidate
, int *nongit_ok
)
455 struct strbuf sb
= STRBUF_INIT
;
456 struct strbuf err
= STRBUF_INIT
;
459 has_common
= get_common_dir(&sb
, gitdir
);
460 strbuf_addstr(&sb
, "/config");
461 read_repository_format(candidate
, sb
.buf
);
465 * For historical use of check_repository_format() in git-init,
466 * we treat a missing config as a silent "ok", even when nongit_ok
469 if (candidate
->version
< 0)
472 if (verify_repository_format(candidate
, &err
) < 0) {
474 warning("%s", err
.buf
);
475 strbuf_release(&err
);
482 repository_format_precious_objects
= candidate
->precious_objects
;
483 set_repository_format_partial_clone(candidate
->partial_clone
);
484 repository_format_worktree_config
= candidate
->worktree_config
;
485 string_list_clear(&candidate
->unknown_extensions
, 0);
487 if (repository_format_worktree_config
) {
489 * pick up core.bare and core.worktree from per-worktree
492 strbuf_addf(&sb
, "%s/config.worktree", gitdir
);
493 git_config_from_file(read_worktree_config
, sb
.buf
, candidate
);
499 if (candidate
->is_bare
!= -1) {
500 is_bare_repository_cfg
= candidate
->is_bare
;
501 if (is_bare_repository_cfg
== 1)
502 inside_work_tree
= -1;
504 if (candidate
->work_tree
) {
505 free(git_work_tree_cfg
);
506 git_work_tree_cfg
= xstrdup(candidate
->work_tree
);
507 inside_work_tree
= -1;
514 static void init_repository_format(struct repository_format
*format
)
516 const struct repository_format fresh
= REPOSITORY_FORMAT_INIT
;
518 memcpy(format
, &fresh
, sizeof(fresh
));
521 int read_repository_format(struct repository_format
*format
, const char *path
)
523 clear_repository_format(format
);
524 git_config_from_file(check_repo_format
, path
, format
);
525 if (format
->version
== -1)
526 clear_repository_format(format
);
527 return format
->version
;
530 void clear_repository_format(struct repository_format
*format
)
532 string_list_clear(&format
->unknown_extensions
, 0);
533 free(format
->work_tree
);
534 free(format
->partial_clone
);
535 init_repository_format(format
);
538 int verify_repository_format(const struct repository_format
*format
,
541 if (GIT_REPO_VERSION_READ
< format
->version
) {
542 strbuf_addf(err
, _("Expected git repo version <= %d, found %d"),
543 GIT_REPO_VERSION_READ
, format
->version
);
547 if (format
->version
>= 1 && format
->unknown_extensions
.nr
) {
550 strbuf_addstr(err
, _("unknown repository extensions found:"));
552 for (i
= 0; i
< format
->unknown_extensions
.nr
; i
++)
553 strbuf_addf(err
, "\n\t%s",
554 format
->unknown_extensions
.items
[i
].string
);
561 void read_gitfile_error_die(int error_code
, const char *path
, const char *dir
)
563 switch (error_code
) {
564 case READ_GITFILE_ERR_STAT_FAILED
:
565 case READ_GITFILE_ERR_NOT_A_FILE
:
566 /* non-fatal; follow return path */
568 case READ_GITFILE_ERR_OPEN_FAILED
:
569 die_errno(_("error opening '%s'"), path
);
570 case READ_GITFILE_ERR_TOO_LARGE
:
571 die(_("too large to be a .git file: '%s'"), path
);
572 case READ_GITFILE_ERR_READ_FAILED
:
573 die(_("error reading %s"), path
);
574 case READ_GITFILE_ERR_INVALID_FORMAT
:
575 die(_("invalid gitfile format: %s"), path
);
576 case READ_GITFILE_ERR_NO_PATH
:
577 die(_("no path in gitfile: %s"), path
);
578 case READ_GITFILE_ERR_NOT_A_REPO
:
579 die(_("not a git repository: %s"), dir
);
581 BUG("unknown error code");
586 * Try to read the location of the git directory from the .git file,
587 * return path to git directory if found. The return value comes from
590 * On failure, if return_error_code is not NULL, return_error_code
591 * will be set to an error code and NULL will be returned. If
592 * return_error_code is NULL the function will die instead (for most
595 const char *read_gitfile_gently(const char *path
, int *return_error_code
)
597 const int max_file_size
= 1 << 20; /* 1MB */
606 if (stat(path
, &st
)) {
607 /* NEEDSWORK: discern between ENOENT vs other errors */
608 error_code
= READ_GITFILE_ERR_STAT_FAILED
;
611 if (!S_ISREG(st
.st_mode
)) {
612 error_code
= READ_GITFILE_ERR_NOT_A_FILE
;
615 if (st
.st_size
> max_file_size
) {
616 error_code
= READ_GITFILE_ERR_TOO_LARGE
;
619 fd
= open(path
, O_RDONLY
);
621 error_code
= READ_GITFILE_ERR_OPEN_FAILED
;
624 buf
= xmallocz(st
.st_size
);
625 len
= read_in_full(fd
, buf
, st
.st_size
);
627 if (len
!= st
.st_size
) {
628 error_code
= READ_GITFILE_ERR_READ_FAILED
;
631 if (!starts_with(buf
, "gitdir: ")) {
632 error_code
= READ_GITFILE_ERR_INVALID_FORMAT
;
635 while (buf
[len
- 1] == '\n' || buf
[len
- 1] == '\r')
638 error_code
= READ_GITFILE_ERR_NO_PATH
;
644 if (!is_absolute_path(dir
) && (slash
= strrchr(path
, '/'))) {
645 size_t pathlen
= slash
+1 - path
;
646 dir
= xstrfmt("%.*s%.*s", (int)pathlen
, path
,
647 (int)(len
- 8), buf
+ 8);
651 if (!is_git_directory(dir
)) {
652 error_code
= READ_GITFILE_ERR_NOT_A_REPO
;
655 path
= real_path(dir
);
658 if (return_error_code
)
659 *return_error_code
= error_code
;
661 read_gitfile_error_die(error_code
, path
, dir
);
664 return error_code
? NULL
: path
;
667 static const char *setup_explicit_git_dir(const char *gitdirenv
,
669 struct repository_format
*repo_fmt
,
672 const char *work_tree_env
= getenv(GIT_WORK_TREE_ENVIRONMENT
);
673 const char *worktree
;
677 if (PATH_MAX
- 40 < strlen(gitdirenv
))
678 die(_("'$%s' too big"), GIT_DIR_ENVIRONMENT
);
680 gitfile
= (char*)read_gitfile(gitdirenv
);
682 gitfile
= xstrdup(gitfile
);
686 if (!is_git_directory(gitdirenv
)) {
692 die(_("not a git repository: '%s'"), gitdirenv
);
695 if (check_repository_format_gently(gitdirenv
, repo_fmt
, nongit_ok
)) {
700 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
702 set_git_work_tree(work_tree_env
);
703 else if (is_bare_repository_cfg
> 0) {
704 if (git_work_tree_cfg
) {
706 warning("core.bare and core.worktree do not make sense");
707 work_tree_config_is_bogus
= 1;
711 set_git_dir(gitdirenv
);
715 else if (git_work_tree_cfg
) { /* #6, #14 */
716 if (is_absolute_path(git_work_tree_cfg
))
717 set_git_work_tree(git_work_tree_cfg
);
720 if (chdir(gitdirenv
))
721 die_errno(_("cannot chdir to '%s'"), gitdirenv
);
722 if (chdir(git_work_tree_cfg
))
723 die_errno(_("cannot chdir to '%s'"), git_work_tree_cfg
);
724 core_worktree
= xgetcwd();
726 die_errno(_("cannot come back to cwd"));
727 set_git_work_tree(core_worktree
);
731 else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, 1)) {
733 set_git_dir(gitdirenv
);
738 set_git_work_tree(".");
740 /* set_git_work_tree() must have been called by now */
741 worktree
= get_git_work_tree();
743 /* both get_git_work_tree() and cwd are already normalized */
744 if (!strcmp(cwd
->buf
, worktree
)) { /* cwd == worktree */
745 set_git_dir(gitdirenv
);
750 offset
= dir_inside_of(cwd
->buf
, worktree
);
751 if (offset
>= 0) { /* cwd inside worktree? */
752 set_git_dir(real_path(gitdirenv
));
754 die_errno(_("cannot chdir to '%s'"), worktree
);
755 strbuf_addch(cwd
, '/');
757 return cwd
->buf
+ offset
;
760 /* cwd outside worktree */
761 set_git_dir(gitdirenv
);
766 static const char *setup_discovered_git_dir(const char *gitdir
,
767 struct strbuf
*cwd
, int offset
,
768 struct repository_format
*repo_fmt
,
771 if (check_repository_format_gently(gitdir
, repo_fmt
, nongit_ok
))
774 /* --work-tree is set without --git-dir; use discovered one */
775 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
776 char *to_free
= NULL
;
779 if (offset
!= cwd
->len
&& !is_absolute_path(gitdir
))
780 gitdir
= to_free
= real_pathdup(gitdir
, 1);
782 die_errno(_("cannot come back to cwd"));
783 ret
= setup_explicit_git_dir(gitdir
, cwd
, repo_fmt
, nongit_ok
);
788 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
789 if (is_bare_repository_cfg
> 0) {
790 set_git_dir(offset
== cwd
->len
? gitdir
: real_path(gitdir
));
792 die_errno(_("cannot come back to cwd"));
796 /* #0, #1, #5, #8, #9, #12, #13 */
797 set_git_work_tree(".");
798 if (strcmp(gitdir
, DEFAULT_GIT_DIR_ENVIRONMENT
))
801 inside_work_tree
= 1;
802 if (offset
>= cwd
->len
)
805 /* Make "offset" point past the '/' (already the case for root dirs) */
806 if (offset
!= offset_1st_component(cwd
->buf
))
808 /* Add a '/' at the end */
809 strbuf_addch(cwd
, '/');
810 return cwd
->buf
+ offset
;
813 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
814 static const char *setup_bare_git_dir(struct strbuf
*cwd
, int offset
,
815 struct repository_format
*repo_fmt
,
820 if (check_repository_format_gently(".", repo_fmt
, nongit_ok
))
823 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, "0", 1);
825 /* --work-tree is set without --git-dir; use discovered one */
826 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
827 static const char *gitdir
;
829 gitdir
= offset
== cwd
->len
? "." : xmemdupz(cwd
->buf
, offset
);
831 die_errno(_("cannot come back to cwd"));
832 return setup_explicit_git_dir(gitdir
, cwd
, repo_fmt
, nongit_ok
);
836 inside_work_tree
= 0;
837 if (offset
!= cwd
->len
) {
839 die_errno(_("cannot come back to cwd"));
840 root_len
= offset_1st_component(cwd
->buf
);
841 strbuf_setlen(cwd
, offset
> root_len
? offset
: root_len
);
842 set_git_dir(cwd
->buf
);
849 static dev_t
get_device_or_die(const char *path
, const char *prefix
, int prefix_len
)
852 if (stat(path
, &buf
)) {
853 die_errno(_("failed to stat '%*s%s%s'"),
855 prefix
? prefix
: "",
856 prefix
? "/" : "", path
);
862 * A "string_list_each_func_t" function that canonicalizes an entry
863 * from GIT_CEILING_DIRECTORIES using real_path_if_valid(), or
864 * discards it if unusable. The presence of an empty entry in
865 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
866 * subsequent entries.
868 static int canonicalize_ceiling_entry(struct string_list_item
*item
,
871 int *empty_entry_found
= cb_data
;
872 char *ceil
= item
->string
;
875 *empty_entry_found
= 1;
877 } else if (!is_absolute_path(ceil
)) {
879 } else if (*empty_entry_found
) {
880 /* Keep entry but do not canonicalize it */
883 char *real_path
= real_pathdup(ceil
, 0);
888 item
->string
= real_path
;
893 enum discovery_result
{
898 /* these are errors */
899 GIT_DIR_HIT_CEILING
= -1,
900 GIT_DIR_HIT_MOUNT_POINT
= -2,
901 GIT_DIR_INVALID_GITFILE
= -3
905 * We cannot decide in this function whether we are in the work tree or
906 * not, since the config can only be read _after_ this function was called.
908 * Also, we avoid changing any global state (such as the current working
909 * directory) to allow early callers.
911 * The directory where the search should start needs to be passed in via the
912 * `dir` parameter; upon return, the `dir` buffer will contain the path of
913 * the directory where the search ended, and `gitdir` will contain the path of
914 * the discovered .git/ directory, if any. If `gitdir` is not absolute, it
915 * is relative to `dir` (i.e. *not* necessarily the cwd).
917 static enum discovery_result
setup_git_directory_gently_1(struct strbuf
*dir
,
918 struct strbuf
*gitdir
,
921 const char *env_ceiling_dirs
= getenv(CEILING_DIRECTORIES_ENVIRONMENT
);
922 struct string_list ceiling_dirs
= STRING_LIST_INIT_DUP
;
923 const char *gitdirenv
;
924 int ceil_offset
= -1, min_offset
= offset_1st_component(dir
->buf
);
925 dev_t current_device
= 0;
926 int one_filesystem
= 1;
929 * If GIT_DIR is set explicitly, we're not going
930 * to do any discovery, but we still do repository
933 gitdirenv
= getenv(GIT_DIR_ENVIRONMENT
);
935 strbuf_addstr(gitdir
, gitdirenv
);
936 return GIT_DIR_EXPLICIT
;
939 if (env_ceiling_dirs
) {
940 int empty_entry_found
= 0;
942 string_list_split(&ceiling_dirs
, env_ceiling_dirs
, PATH_SEP
, -1);
943 filter_string_list(&ceiling_dirs
, 0,
944 canonicalize_ceiling_entry
, &empty_entry_found
);
945 ceil_offset
= longest_ancestor_length(dir
->buf
, &ceiling_dirs
);
946 string_list_clear(&ceiling_dirs
, 0);
950 ceil_offset
= min_offset
- 2;
952 if (min_offset
&& min_offset
== dir
->len
&&
953 !is_dir_sep(dir
->buf
[min_offset
- 1])) {
954 strbuf_addch(dir
, '/');
959 * Test in the following order (relative to the dir):
960 * - .git (file containing "gitdir: <path>")
969 one_filesystem
= !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
971 current_device
= get_device_or_die(dir
->buf
, NULL
, 0);
973 int offset
= dir
->len
, error_code
= 0;
975 if (offset
> min_offset
)
976 strbuf_addch(dir
, '/');
977 strbuf_addstr(dir
, DEFAULT_GIT_DIR_ENVIRONMENT
);
978 gitdirenv
= read_gitfile_gently(dir
->buf
, die_on_error
?
982 error_code
== READ_GITFILE_ERR_NOT_A_FILE
) {
983 /* NEEDSWORK: fail if .git is not file nor dir */
984 if (is_git_directory(dir
->buf
))
985 gitdirenv
= DEFAULT_GIT_DIR_ENVIRONMENT
;
986 } else if (error_code
!= READ_GITFILE_ERR_STAT_FAILED
)
987 return GIT_DIR_INVALID_GITFILE
;
989 strbuf_setlen(dir
, offset
);
991 strbuf_addstr(gitdir
, gitdirenv
);
992 return GIT_DIR_DISCOVERED
;
995 if (is_git_directory(dir
->buf
)) {
996 strbuf_addstr(gitdir
, ".");
1000 if (offset
<= min_offset
)
1001 return GIT_DIR_HIT_CEILING
;
1003 while (--offset
> ceil_offset
&& !is_dir_sep(dir
->buf
[offset
]))
1005 if (offset
<= ceil_offset
)
1006 return GIT_DIR_HIT_CEILING
;
1008 strbuf_setlen(dir
, offset
> min_offset
? offset
: min_offset
);
1009 if (one_filesystem
&&
1010 current_device
!= get_device_or_die(dir
->buf
, NULL
, offset
))
1011 return GIT_DIR_HIT_MOUNT_POINT
;
1015 int discover_git_directory(struct strbuf
*commondir
,
1016 struct strbuf
*gitdir
)
1018 struct strbuf dir
= STRBUF_INIT
, err
= STRBUF_INIT
;
1019 size_t gitdir_offset
= gitdir
->len
, cwd_len
;
1020 size_t commondir_offset
= commondir
->len
;
1021 struct repository_format candidate
= REPOSITORY_FORMAT_INIT
;
1023 if (strbuf_getcwd(&dir
))
1027 if (setup_git_directory_gently_1(&dir
, gitdir
, 0) <= 0) {
1028 strbuf_release(&dir
);
1033 * The returned gitdir is relative to dir, and if dir does not reflect
1034 * the current working directory, we simply make the gitdir absolute.
1036 if (dir
.len
< cwd_len
&& !is_absolute_path(gitdir
->buf
+ gitdir_offset
)) {
1037 /* Avoid a trailing "/." */
1038 if (!strcmp(".", gitdir
->buf
+ gitdir_offset
))
1039 strbuf_setlen(gitdir
, gitdir_offset
);
1041 strbuf_addch(&dir
, '/');
1042 strbuf_insert(gitdir
, gitdir_offset
, dir
.buf
, dir
.len
);
1045 get_common_dir(commondir
, gitdir
->buf
+ gitdir_offset
);
1048 strbuf_addf(&dir
, "%s/config", commondir
->buf
+ commondir_offset
);
1049 read_repository_format(&candidate
, dir
.buf
);
1050 strbuf_release(&dir
);
1052 if (verify_repository_format(&candidate
, &err
) < 0) {
1053 warning("ignoring git dir '%s': %s",
1054 gitdir
->buf
+ gitdir_offset
, err
.buf
);
1055 strbuf_release(&err
);
1056 strbuf_setlen(commondir
, commondir_offset
);
1057 strbuf_setlen(gitdir
, gitdir_offset
);
1058 clear_repository_format(&candidate
);
1062 clear_repository_format(&candidate
);
1066 const char *setup_git_directory_gently(int *nongit_ok
)
1068 static struct strbuf cwd
= STRBUF_INIT
;
1069 struct strbuf dir
= STRBUF_INIT
, gitdir
= STRBUF_INIT
;
1070 const char *prefix
= NULL
;
1071 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
1074 * We may have read an incomplete configuration before
1075 * setting-up the git directory. If so, clear the cache so
1076 * that the next queries to the configuration reload complete
1077 * configuration (including the per-repo config file that we
1078 * ignored previously).
1083 * Let's assume that we are in a git repository.
1084 * If it turns out later that we are somewhere else, the value will be
1085 * updated accordingly.
1090 if (strbuf_getcwd(&cwd
))
1091 die_errno(_("Unable to read current working directory"));
1092 strbuf_addbuf(&dir
, &cwd
);
1094 switch (setup_git_directory_gently_1(&dir
, &gitdir
, 1)) {
1095 case GIT_DIR_EXPLICIT
:
1096 prefix
= setup_explicit_git_dir(gitdir
.buf
, &cwd
, &repo_fmt
, nongit_ok
);
1098 case GIT_DIR_DISCOVERED
:
1099 if (dir
.len
< cwd
.len
&& chdir(dir
.buf
))
1100 die(_("cannot change to '%s'"), dir
.buf
);
1101 prefix
= setup_discovered_git_dir(gitdir
.buf
, &cwd
, dir
.len
,
1102 &repo_fmt
, nongit_ok
);
1105 if (dir
.len
< cwd
.len
&& chdir(dir
.buf
))
1106 die(_("cannot change to '%s'"), dir
.buf
);
1107 prefix
= setup_bare_git_dir(&cwd
, dir
.len
, &repo_fmt
, nongit_ok
);
1109 case GIT_DIR_HIT_CEILING
:
1111 die(_("not a git repository (or any of the parent directories): %s"),
1112 DEFAULT_GIT_DIR_ENVIRONMENT
);
1115 case GIT_DIR_HIT_MOUNT_POINT
:
1117 die(_("not a git repository (or any parent up to mount point %s)\n"
1118 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set)."),
1124 * As a safeguard against setup_git_directory_gently_1 returning
1125 * this value, fallthrough to BUG. Otherwise it is possible to
1126 * set startup_info->have_repository to 1 when we did nothing to
1127 * find a repository.
1130 BUG("unhandled setup_git_directory_1() result");
1134 * At this point, nongit_ok is stable. If it is non-NULL and points
1135 * to a non-zero value, then this means that we haven't found a
1136 * repository and that the caller expects startup_info to reflect
1139 * Regardless of the state of nongit_ok, startup_info->prefix and
1140 * the GIT_PREFIX environment variable must always match. For details
1141 * see Documentation/config/alias.txt.
1143 if (nongit_ok
&& *nongit_ok
) {
1144 startup_info
->have_repository
= 0;
1145 startup_info
->prefix
= NULL
;
1146 setenv(GIT_PREFIX_ENVIRONMENT
, "", 1);
1148 startup_info
->have_repository
= 1;
1149 startup_info
->prefix
= prefix
;
1151 setenv(GIT_PREFIX_ENVIRONMENT
, prefix
, 1);
1153 setenv(GIT_PREFIX_ENVIRONMENT
, "", 1);
1157 * Not all paths through the setup code will call 'set_git_dir()' (which
1158 * directly sets up the environment) so in order to guarantee that the
1159 * environment is in a consistent state after setup, explicitly setup
1160 * the environment if we have a repository.
1162 * NEEDSWORK: currently we allow bogus GIT_DIR values to be set in some
1163 * code paths so we also need to explicitly setup the environment if
1164 * the user has set GIT_DIR. It may be beneficial to disallow bogus
1165 * GIT_DIR values at some point in the future.
1167 if (/* GIT_DIR_EXPLICIT, GIT_DIR_DISCOVERED, GIT_DIR_BARE */
1168 startup_info
->have_repository
||
1169 /* GIT_DIR_EXPLICIT */
1170 getenv(GIT_DIR_ENVIRONMENT
)) {
1171 if (!the_repository
->gitdir
) {
1172 const char *gitdir
= getenv(GIT_DIR_ENVIRONMENT
);
1174 gitdir
= DEFAULT_GIT_DIR_ENVIRONMENT
;
1175 setup_git_env(gitdir
);
1177 if (startup_info
->have_repository
)
1178 repo_set_hash_algo(the_repository
, repo_fmt
.hash_algo
);
1181 strbuf_release(&dir
);
1182 strbuf_release(&gitdir
);
1183 clear_repository_format(&repo_fmt
);
1188 int git_config_perm(const char *var
, const char *value
)
1196 if (!strcmp(value
, "umask"))
1198 if (!strcmp(value
, "group"))
1200 if (!strcmp(value
, "all") ||
1201 !strcmp(value
, "world") ||
1202 !strcmp(value
, "everybody"))
1203 return PERM_EVERYBODY
;
1205 /* Parse octal numbers */
1206 i
= strtol(value
, &endptr
, 8);
1208 /* If not an octal number, maybe true/false? */
1210 return git_config_bool(var
, value
) ? PERM_GROUP
: PERM_UMASK
;
1213 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
1214 * a chmod value to restrict to.
1217 case PERM_UMASK
: /* 0 */
1219 case OLD_PERM_GROUP
: /* 1 */
1221 case OLD_PERM_EVERYBODY
: /* 2 */
1222 return PERM_EVERYBODY
;
1225 /* A filemode value was given: 0xxx */
1227 if ((i
& 0600) != 0600)
1228 die(_("problem with core.sharedRepository filemode value "
1229 "(0%.3o).\nThe owner of files must always have "
1230 "read and write permissions."), i
);
1233 * Mask filemode value. Others can not get write permission.
1234 * x flags for directories are handled separately.
1239 void check_repository_format(void)
1241 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
1242 check_repository_format_gently(get_git_dir(), &repo_fmt
, NULL
);
1243 startup_info
->have_repository
= 1;
1244 clear_repository_format(&repo_fmt
);
1248 * Returns the "prefix", a path to the current working directory
1249 * relative to the work tree root, or NULL, if the current working
1250 * directory is not a strict subdirectory of the work tree root. The
1251 * prefix always ends with a '/' character.
1253 const char *setup_git_directory(void)
1255 return setup_git_directory_gently(NULL
);
1258 const char *resolve_gitdir_gently(const char *suspect
, int *return_error_code
)
1260 if (is_git_directory(suspect
))
1262 return read_gitfile_gently(suspect
, return_error_code
);
1265 /* if any standard file descriptor is missing open it to /dev/null */
1266 void sanitize_stdfds(void)
1268 int fd
= open("/dev/null", O_RDWR
, 0);
1269 while (fd
!= -1 && fd
< 2)
1272 die_errno(_("open /dev/null or dup failed"));
1279 #ifdef NO_POSIX_GOODIES
1287 die_errno(_("fork failed"));
1292 die_errno(_("setsid failed"));