1 #include "git-compat-util.h"
4 #include "environment.h"
7 #include "object-name.h"
9 #include "repository.h"
13 #include "string-list.h"
14 #include "chdir-notify.h"
20 static int inside_git_dir
= -1;
21 static int inside_work_tree
= -1;
22 static int work_tree_config_is_bogus
;
23 enum allowed_bare_repo
{
24 ALLOWED_BARE_REPO_EXPLICIT
= 0,
25 ALLOWED_BARE_REPO_ALL
,
28 static struct startup_info the_startup_info
;
29 struct startup_info
*startup_info
= &the_startup_info
;
30 const char *tmp_original_cwd
;
33 * The input parameter must contain an absolute path, and it must already be
36 * Find the part of an absolute path that lies inside the work tree by
37 * dereferencing symlinks outside the work tree, for example:
38 * /dir1/repo/dir2/file (work tree is /dir1/repo) -> dir2/file
39 * /dir/file (work tree is /) -> dir/file
40 * /dir/symlink1/symlink2 (symlink1 points to work tree) -> symlink2
41 * /dir/repolink/file (repolink points to /dir/repo) -> file
42 * /dir/repo (exactly equal to work tree) -> (empty string)
44 static int abspath_part_inside_repo(char *path
)
50 const char *work_tree
= get_git_work_tree();
51 struct strbuf realpath
= STRBUF_INIT
;
55 wtlen
= strlen(work_tree
);
57 off
= offset_1st_component(path
);
59 /* check if work tree is already the prefix */
60 if (wtlen
<= len
&& !fspathncmp(path
, work_tree
, wtlen
)) {
61 if (path
[wtlen
] == '/') {
62 memmove(path
, path
+ wtlen
+ 1, len
- wtlen
);
64 } else if (path
[wtlen
- 1] == '/' || path
[wtlen
] == '\0') {
65 /* work tree is the root, or the whole path */
66 memmove(path
, path
+ wtlen
, len
- wtlen
+ 1);
69 /* work tree might match beginning of a symlink to work tree */
75 /* check each '/'-terminated level */
80 strbuf_realpath(&realpath
, path0
, 1);
81 if (fspathcmp(realpath
.buf
, work_tree
) == 0) {
82 memmove(path0
, path
+ 1, len
- (path
- path0
));
83 strbuf_release(&realpath
);
90 /* check whole path */
91 strbuf_realpath(&realpath
, path0
, 1);
92 if (fspathcmp(realpath
.buf
, work_tree
) == 0) {
94 strbuf_release(&realpath
);
98 strbuf_release(&realpath
);
103 * Normalize "path", prepending the "prefix" for relative paths. If
104 * remaining_prefix is not NULL, return the actual prefix still
105 * remains in the path. For example, prefix = sub1/sub2/ and path is
107 * foo -> sub1/sub2/foo (full prefix)
108 * ../foo -> sub1/foo (remaining prefix is sub1/)
109 * ../../bar -> bar (no remaining prefix)
110 * ../../sub1/sub2/foo -> sub1/sub2/foo (but no remaining prefix)
111 * `pwd`/../bar -> sub1/bar (no remaining prefix)
113 char *prefix_path_gently(const char *prefix
, int len
,
114 int *remaining_prefix
, const char *path
)
116 const char *orig
= path
;
118 if (is_absolute_path(orig
)) {
119 sanitized
= xmallocz(strlen(path
));
120 if (remaining_prefix
)
121 *remaining_prefix
= 0;
122 if (normalize_path_copy_len(sanitized
, path
, remaining_prefix
)) {
126 if (abspath_part_inside_repo(sanitized
)) {
131 sanitized
= xstrfmt("%.*s%s", len
, len
? prefix
: "", path
);
132 if (remaining_prefix
)
133 *remaining_prefix
= len
;
134 if (normalize_path_copy_len(sanitized
, sanitized
, remaining_prefix
)) {
142 char *prefix_path(const char *prefix
, int len
, const char *path
)
144 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
146 const char *hint_path
= get_git_work_tree();
148 hint_path
= get_git_dir();
149 die(_("'%s' is outside repository at '%s'"), path
,
150 absolute_path(hint_path
));
155 int path_inside_repo(const char *prefix
, const char *path
)
157 int len
= prefix
? strlen(prefix
) : 0;
158 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
166 int check_filename(const char *prefix
, const char *arg
)
168 char *to_free
= NULL
;
171 if (skip_prefix(arg
, ":/", &arg
)) {
172 if (!*arg
) /* ":/" is root dir, always exists */
175 } else if (skip_prefix(arg
, ":!", &arg
) ||
176 skip_prefix(arg
, ":^", &arg
)) {
177 if (!*arg
) /* excluding everything is silly, but allowed */
182 arg
= to_free
= prefix_filename(prefix
, arg
);
184 if (!lstat(arg
, &st
)) {
186 return 1; /* file exists */
188 if (is_missing_file_error(errno
)) {
190 return 0; /* file does not exist */
192 die_errno(_("failed to stat '%s'"), arg
);
195 static void NORETURN
die_verify_filename(struct repository
*r
,
198 int diagnose_misspelt_rev
)
200 if (!diagnose_misspelt_rev
)
201 die(_("%s: no such path in the working tree.\n"
202 "Use 'git <command> -- <path>...' to specify paths that do not exist locally."),
205 * Saying "'(icase)foo' does not exist in the index" when the
206 * user gave us ":(icase)foo" is just stupid. A magic pathspec
207 * begins with a colon and is followed by a non-alnum; do not
208 * let maybe_die_on_misspelt_object_name() even trigger.
210 if (!(arg
[0] == ':' && !isalnum(arg
[1])))
211 maybe_die_on_misspelt_object_name(r
, arg
, prefix
);
213 /* ... or fall back the most general message. */
214 die(_("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
215 "Use '--' to separate paths from revisions, like this:\n"
216 "'git <command> [<revision>...] -- [<file>...]'"), arg
);
221 * Check for arguments that don't resolve as actual files,
222 * but which look sufficiently like pathspecs that we'll consider
223 * them such for the purposes of rev/pathspec DWIM parsing.
225 static int looks_like_pathspec(const char *arg
)
231 * Wildcard characters imply the user is looking to match pathspecs
232 * that aren't in the filesystem. Note that this doesn't include
233 * backslash even though it's a glob special; by itself it doesn't
234 * cause any increase in the match. Likewise ignore backslash-escaped
235 * wildcard characters.
237 for (p
= arg
; *p
; p
++) {
240 } else if (is_glob_special(*p
)) {
248 /* long-form pathspec magic */
249 if (starts_with(arg
, ":("))
256 * Verify a filename that we got as an argument for a pathspec
257 * entry. Note that a filename that begins with "-" never verifies
258 * as true, because even if such a filename were to exist, we want
259 * it to be preceded by the "--" marker (or we want the user to
260 * use a format like "./-filename")
262 * The "diagnose_misspelt_rev" is used to provide a user-friendly
263 * diagnosis when dying upon finding that "name" is not a pathname.
264 * If set to 1, the diagnosis will try to diagnose "name" as an
265 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
266 * will only complain about an inexisting file.
268 * This function is typically called to check that a "file or rev"
269 * argument is unambiguous. In this case, the caller will want
270 * diagnose_misspelt_rev == 1 when verifying the first non-rev
271 * argument (which could have been a revision), and
272 * diagnose_misspelt_rev == 0 for the next ones (because we already
273 * saw a filename, there's not ambiguity anymore).
275 void verify_filename(const char *prefix
,
277 int diagnose_misspelt_rev
)
280 die(_("option '%s' must come before non-option arguments"), arg
);
281 if (looks_like_pathspec(arg
) || check_filename(prefix
, arg
))
283 die_verify_filename(the_repository
, prefix
, arg
, diagnose_misspelt_rev
);
287 * Opposite of the above: the command line did not have -- marker
288 * and we parsed the arg as a refname. It should not be interpretable
291 void verify_non_filename(const char *prefix
, const char *arg
)
293 if (!is_inside_work_tree() || is_inside_git_dir())
297 if (!check_filename(prefix
, arg
))
299 die(_("ambiguous argument '%s': both revision and filename\n"
300 "Use '--' to separate paths from revisions, like this:\n"
301 "'git <command> [<revision>...] -- [<file>...]'"), arg
);
304 int get_common_dir(struct strbuf
*sb
, const char *gitdir
)
306 const char *git_env_common_dir
= getenv(GIT_COMMON_DIR_ENVIRONMENT
);
307 if (git_env_common_dir
) {
308 strbuf_addstr(sb
, git_env_common_dir
);
311 return get_common_dir_noenv(sb
, gitdir
);
315 int get_common_dir_noenv(struct strbuf
*sb
, const char *gitdir
)
317 struct strbuf data
= STRBUF_INIT
;
318 struct strbuf path
= STRBUF_INIT
;
321 strbuf_addf(&path
, "%s/commondir", gitdir
);
322 if (file_exists(path
.buf
)) {
323 if (strbuf_read_file(&data
, path
.buf
, 0) <= 0)
324 die_errno(_("failed to read %s"), path
.buf
);
325 while (data
.len
&& (data
.buf
[data
.len
- 1] == '\n' ||
326 data
.buf
[data
.len
- 1] == '\r'))
328 data
.buf
[data
.len
] = '\0';
330 if (!is_absolute_path(data
.buf
))
331 strbuf_addf(&path
, "%s/", gitdir
);
332 strbuf_addbuf(&path
, &data
);
333 strbuf_add_real_path(sb
, path
.buf
);
336 strbuf_addstr(sb
, gitdir
);
339 strbuf_release(&data
);
340 strbuf_release(&path
);
345 * Test if it looks like we're at a git directory.
348 * - either an objects/ directory _or_ the proper
349 * GIT_OBJECT_DIRECTORY environment variable
350 * - a refs/ directory
351 * - either a HEAD symlink or a HEAD file that is formatted as
352 * a proper "ref:", or a regular file HEAD that has a properly
353 * formatted sha1 object name.
355 int is_git_directory(const char *suspect
)
357 struct strbuf path
= STRBUF_INIT
;
361 /* Check worktree-related signatures */
362 strbuf_addstr(&path
, suspect
);
363 strbuf_complete(&path
, '/');
364 strbuf_addstr(&path
, "HEAD");
365 if (validate_headref(path
.buf
))
369 get_common_dir(&path
, suspect
);
372 /* Check non-worktree-related signatures */
373 if (getenv(DB_ENVIRONMENT
)) {
374 if (access(getenv(DB_ENVIRONMENT
), X_OK
))
378 strbuf_setlen(&path
, len
);
379 strbuf_addstr(&path
, "/objects");
380 if (access(path
.buf
, X_OK
))
384 strbuf_setlen(&path
, len
);
385 strbuf_addstr(&path
, "/refs");
386 if (access(path
.buf
, X_OK
))
391 strbuf_release(&path
);
395 int is_nonbare_repository_dir(struct strbuf
*path
)
399 size_t orig_path_len
= path
->len
;
400 assert(orig_path_len
!= 0);
401 strbuf_complete(path
, '/');
402 strbuf_addstr(path
, ".git");
403 if (read_gitfile_gently(path
->buf
, &gitfile_error
) || is_git_directory(path
->buf
))
405 if (gitfile_error
== READ_GITFILE_ERR_OPEN_FAILED
||
406 gitfile_error
== READ_GITFILE_ERR_READ_FAILED
)
408 strbuf_setlen(path
, orig_path_len
);
412 int is_inside_git_dir(void)
414 if (inside_git_dir
< 0)
415 inside_git_dir
= is_inside_dir(get_git_dir());
416 return inside_git_dir
;
419 int is_inside_work_tree(void)
421 if (inside_work_tree
< 0)
422 inside_work_tree
= is_inside_dir(get_git_work_tree());
423 return inside_work_tree
;
426 void setup_work_tree(void)
428 const char *work_tree
;
429 static int initialized
= 0;
434 if (work_tree_config_is_bogus
)
435 die(_("unable to set up work tree using invalid config"));
437 work_tree
= get_git_work_tree();
438 if (!work_tree
|| chdir_notify(work_tree
))
439 die(_("this operation must be run in a work tree"));
442 * Make sure subsequent git processes find correct worktree
443 * if $GIT_WORK_TREE is set relative
445 if (getenv(GIT_WORK_TREE_ENVIRONMENT
))
446 setenv(GIT_WORK_TREE_ENVIRONMENT
, ".", 1);
451 static void setup_original_cwd(void)
453 struct strbuf tmp
= STRBUF_INIT
;
454 const char *worktree
= NULL
;
457 if (!tmp_original_cwd
)
461 * startup_info->original_cwd points to the current working
462 * directory we inherited from our parent process, which is a
463 * directory we want to avoid removing.
465 * For convience, we would like to have the path relative to the
466 * worktree instead of an absolute path.
468 * Yes, startup_info->original_cwd is usually the same as 'prefix',
469 * but differs in two ways:
470 * - prefix has a trailing '/'
471 * - if the user passes '-C' to git, that modifies the prefix but
472 * not startup_info->original_cwd.
475 /* Normalize the directory */
476 if (!strbuf_realpath(&tmp
, tmp_original_cwd
, 0)) {
477 trace2_data_string("setup", the_repository
,
478 "realpath-path", tmp_original_cwd
);
479 trace2_data_string("setup", the_repository
,
480 "realpath-failure", strerror(errno
));
481 free((char*)tmp_original_cwd
);
482 tmp_original_cwd
= NULL
;
486 free((char*)tmp_original_cwd
);
487 tmp_original_cwd
= NULL
;
488 startup_info
->original_cwd
= strbuf_detach(&tmp
, NULL
);
491 * Get our worktree; we only protect the current working directory
492 * if it's in the worktree.
494 worktree
= get_git_work_tree();
496 goto no_prevention_needed
;
498 offset
= dir_inside_of(startup_info
->original_cwd
, worktree
);
501 * If startup_info->original_cwd == worktree, that is already
502 * protected and we don't need original_cwd as a secondary
503 * protection measure.
505 if (!*(startup_info
->original_cwd
+ offset
))
506 goto no_prevention_needed
;
509 * original_cwd was inside worktree; precompose it just as
510 * we do prefix so that built up paths will match
512 startup_info
->original_cwd
= \
513 precompose_string_if_needed(startup_info
->original_cwd
518 no_prevention_needed
:
519 free((char*)startup_info
->original_cwd
);
520 startup_info
->original_cwd
= NULL
;
523 static int read_worktree_config(const char *var
, const char *value
,
524 const struct config_context
*ctx UNUSED
,
527 struct repository_format
*data
= vdata
;
529 if (strcmp(var
, "core.bare") == 0) {
530 data
->is_bare
= git_config_bool(var
, value
);
531 } else if (strcmp(var
, "core.worktree") == 0) {
533 return config_error_nonbool(var
);
534 free(data
->work_tree
);
535 data
->work_tree
= xstrdup(value
);
540 enum extension_result
{
541 EXTENSION_ERROR
= -1, /* compatible with error(), etc */
542 EXTENSION_UNKNOWN
= 0,
547 * Do not add new extensions to this function. It handles extensions which are
548 * respected even in v0-format repositories for historical compatibility.
550 static enum extension_result
handle_extension_v0(const char *var
,
553 struct repository_format
*data
)
555 if (!strcmp(ext
, "noop")) {
557 } else if (!strcmp(ext
, "preciousobjects")) {
558 data
->precious_objects
= git_config_bool(var
, value
);
560 } else if (!strcmp(ext
, "partialclone")) {
562 return config_error_nonbool(var
);
563 data
->partial_clone
= xstrdup(value
);
565 } else if (!strcmp(ext
, "worktreeconfig")) {
566 data
->worktree_config
= git_config_bool(var
, value
);
570 return EXTENSION_UNKNOWN
;
574 * Record any new extensions in this function.
576 static enum extension_result
handle_extension(const char *var
,
579 struct repository_format
*data
)
581 if (!strcmp(ext
, "noop-v1")) {
583 } else if (!strcmp(ext
, "objectformat")) {
587 return config_error_nonbool(var
);
588 format
= hash_algo_by_name(value
);
589 if (format
== GIT_HASH_UNKNOWN
)
590 return error(_("invalid value for '%s': '%s'"),
591 "extensions.objectformat", value
);
592 data
->hash_algo
= format
;
594 } else if (!strcmp(ext
, "compatobjectformat")) {
595 struct string_list_item
*item
;
599 return config_error_nonbool(var
);
600 format
= hash_algo_by_name(value
);
601 if (format
== GIT_HASH_UNKNOWN
)
602 return error(_("invalid value for '%s': '%s'"),
603 "extensions.compatobjectformat", value
);
604 /* For now only support compatObjectFormat being specified once. */
605 for_each_string_list_item(item
, &data
->v1_only_extensions
) {
606 if (!strcmp(item
->string
, "compatobjectformat"))
607 return error(_("'%s' already specified as '%s'"),
608 "extensions.compatobjectformat",
609 hash_algos
[data
->compat_hash_algo
].name
);
611 data
->compat_hash_algo
= format
;
613 } else if (!strcmp(ext
, "refstorage")) {
617 return config_error_nonbool(var
);
618 format
= ref_storage_format_by_name(value
);
619 if (format
== REF_STORAGE_FORMAT_UNKNOWN
)
620 return error(_("invalid value for '%s': '%s'"),
621 "extensions.refstorage", value
);
622 data
->ref_storage_format
= format
;
625 return EXTENSION_UNKNOWN
;
628 static int check_repo_format(const char *var
, const char *value
,
629 const struct config_context
*ctx
, void *vdata
)
631 struct repository_format
*data
= vdata
;
634 if (strcmp(var
, "core.repositoryformatversion") == 0)
635 data
->version
= git_config_int(var
, value
, ctx
->kvi
);
636 else if (skip_prefix(var
, "extensions.", &ext
)) {
637 switch (handle_extension_v0(var
, value
, ext
, data
)) {
638 case EXTENSION_ERROR
:
642 case EXTENSION_UNKNOWN
:
646 switch (handle_extension(var
, value
, ext
, data
)) {
647 case EXTENSION_ERROR
:
650 string_list_append(&data
->v1_only_extensions
, ext
);
652 case EXTENSION_UNKNOWN
:
653 string_list_append(&data
->unknown_extensions
, ext
);
658 return read_worktree_config(var
, value
, ctx
, vdata
);
661 static int check_repository_format_gently(const char *gitdir
, struct repository_format
*candidate
, int *nongit_ok
)
663 struct strbuf sb
= STRBUF_INIT
;
664 struct strbuf err
= STRBUF_INIT
;
667 has_common
= get_common_dir(&sb
, gitdir
);
668 strbuf_addstr(&sb
, "/config");
669 read_repository_format(candidate
, sb
.buf
);
673 * For historical use of check_repository_format() in git-init,
674 * we treat a missing config as a silent "ok", even when nongit_ok
677 if (candidate
->version
< 0)
680 if (verify_repository_format(candidate
, &err
) < 0) {
682 warning("%s", err
.buf
);
683 strbuf_release(&err
);
690 repository_format_precious_objects
= candidate
->precious_objects
;
691 string_list_clear(&candidate
->unknown_extensions
, 0);
692 string_list_clear(&candidate
->v1_only_extensions
, 0);
694 if (candidate
->worktree_config
) {
696 * pick up core.bare and core.worktree from per-worktree
699 strbuf_addf(&sb
, "%s/config.worktree", gitdir
);
700 git_config_from_file(read_worktree_config
, sb
.buf
, candidate
);
706 if (candidate
->is_bare
!= -1) {
707 is_bare_repository_cfg
= candidate
->is_bare
;
708 if (is_bare_repository_cfg
== 1)
709 inside_work_tree
= -1;
711 if (candidate
->work_tree
) {
712 free(git_work_tree_cfg
);
713 git_work_tree_cfg
= xstrdup(candidate
->work_tree
);
714 inside_work_tree
= -1;
721 int upgrade_repository_format(int target_version
)
723 struct strbuf sb
= STRBUF_INIT
;
724 struct strbuf err
= STRBUF_INIT
;
725 struct strbuf repo_version
= STRBUF_INIT
;
726 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
729 strbuf_git_common_path(&sb
, the_repository
, "config");
730 read_repository_format(&repo_fmt
, sb
.buf
);
733 if (repo_fmt
.version
>= target_version
) {
738 if (verify_repository_format(&repo_fmt
, &err
) < 0) {
739 ret
= error("cannot upgrade repository format from %d to %d: %s",
740 repo_fmt
.version
, target_version
, err
.buf
);
743 if (!repo_fmt
.version
&& repo_fmt
.unknown_extensions
.nr
) {
744 ret
= error("cannot upgrade repository format: "
745 "unknown extension %s",
746 repo_fmt
.unknown_extensions
.items
[0].string
);
750 strbuf_addf(&repo_version
, "%d", target_version
);
751 git_config_set("core.repositoryformatversion", repo_version
.buf
);
756 clear_repository_format(&repo_fmt
);
757 strbuf_release(&repo_version
);
758 strbuf_release(&err
);
762 static void init_repository_format(struct repository_format
*format
)
764 const struct repository_format fresh
= REPOSITORY_FORMAT_INIT
;
766 memcpy(format
, &fresh
, sizeof(fresh
));
769 int read_repository_format(struct repository_format
*format
, const char *path
)
771 clear_repository_format(format
);
772 git_config_from_file(check_repo_format
, path
, format
);
773 if (format
->version
== -1)
774 clear_repository_format(format
);
775 return format
->version
;
778 void clear_repository_format(struct repository_format
*format
)
780 string_list_clear(&format
->unknown_extensions
, 0);
781 string_list_clear(&format
->v1_only_extensions
, 0);
782 free(format
->work_tree
);
783 free(format
->partial_clone
);
784 init_repository_format(format
);
787 int verify_repository_format(const struct repository_format
*format
,
790 if (GIT_REPO_VERSION_READ
< format
->version
) {
791 strbuf_addf(err
, _("Expected git repo version <= %d, found %d"),
792 GIT_REPO_VERSION_READ
, format
->version
);
796 if (format
->version
>= 1 && format
->unknown_extensions
.nr
) {
799 strbuf_addstr(err
, Q_("unknown repository extension found:",
800 "unknown repository extensions found:",
801 format
->unknown_extensions
.nr
));
803 for (i
= 0; i
< format
->unknown_extensions
.nr
; i
++)
804 strbuf_addf(err
, "\n\t%s",
805 format
->unknown_extensions
.items
[i
].string
);
809 if (format
->version
== 0 && format
->v1_only_extensions
.nr
) {
813 Q_("repo version is 0, but v1-only extension found:",
814 "repo version is 0, but v1-only extensions found:",
815 format
->v1_only_extensions
.nr
));
817 for (i
= 0; i
< format
->v1_only_extensions
.nr
; i
++)
818 strbuf_addf(err
, "\n\t%s",
819 format
->v1_only_extensions
.items
[i
].string
);
826 void read_gitfile_error_die(int error_code
, const char *path
, const char *dir
)
828 switch (error_code
) {
829 case READ_GITFILE_ERR_STAT_FAILED
:
830 case READ_GITFILE_ERR_NOT_A_FILE
:
831 /* non-fatal; follow return path */
833 case READ_GITFILE_ERR_OPEN_FAILED
:
834 die_errno(_("error opening '%s'"), path
);
835 case READ_GITFILE_ERR_TOO_LARGE
:
836 die(_("too large to be a .git file: '%s'"), path
);
837 case READ_GITFILE_ERR_READ_FAILED
:
838 die(_("error reading %s"), path
);
839 case READ_GITFILE_ERR_INVALID_FORMAT
:
840 die(_("invalid gitfile format: %s"), path
);
841 case READ_GITFILE_ERR_NO_PATH
:
842 die(_("no path in gitfile: %s"), path
);
843 case READ_GITFILE_ERR_NOT_A_REPO
:
844 die(_("not a git repository: %s"), dir
);
846 BUG("unknown error code");
851 * Try to read the location of the git directory from the .git file,
852 * return path to git directory if found. The return value comes from
855 * On failure, if return_error_code is not NULL, return_error_code
856 * will be set to an error code and NULL will be returned. If
857 * return_error_code is NULL the function will die instead (for most
860 const char *read_gitfile_gently(const char *path
, int *return_error_code
)
862 const int max_file_size
= 1 << 20; /* 1MB */
870 static struct strbuf realpath
= STRBUF_INIT
;
872 if (stat(path
, &st
)) {
873 /* NEEDSWORK: discern between ENOENT vs other errors */
874 error_code
= READ_GITFILE_ERR_STAT_FAILED
;
877 if (!S_ISREG(st
.st_mode
)) {
878 error_code
= READ_GITFILE_ERR_NOT_A_FILE
;
881 if (st
.st_size
> max_file_size
) {
882 error_code
= READ_GITFILE_ERR_TOO_LARGE
;
885 fd
= open(path
, O_RDONLY
);
887 error_code
= READ_GITFILE_ERR_OPEN_FAILED
;
890 buf
= xmallocz(st
.st_size
);
891 len
= read_in_full(fd
, buf
, st
.st_size
);
893 if (len
!= st
.st_size
) {
894 error_code
= READ_GITFILE_ERR_READ_FAILED
;
897 if (!starts_with(buf
, "gitdir: ")) {
898 error_code
= READ_GITFILE_ERR_INVALID_FORMAT
;
901 while (buf
[len
- 1] == '\n' || buf
[len
- 1] == '\r')
904 error_code
= READ_GITFILE_ERR_NO_PATH
;
910 if (!is_absolute_path(dir
) && (slash
= strrchr(path
, '/'))) {
911 size_t pathlen
= slash
+1 - path
;
912 dir
= xstrfmt("%.*s%.*s", (int)pathlen
, path
,
913 (int)(len
- 8), buf
+ 8);
917 if (!is_git_directory(dir
)) {
918 error_code
= READ_GITFILE_ERR_NOT_A_REPO
;
922 strbuf_realpath(&realpath
, dir
, 1);
926 if (return_error_code
)
927 *return_error_code
= error_code
;
929 read_gitfile_error_die(error_code
, path
, dir
);
932 return error_code
? NULL
: path
;
935 static const char *setup_explicit_git_dir(const char *gitdirenv
,
937 struct repository_format
*repo_fmt
,
940 const char *work_tree_env
= getenv(GIT_WORK_TREE_ENVIRONMENT
);
941 const char *worktree
;
945 if (PATH_MAX
- 40 < strlen(gitdirenv
))
946 die(_("'$%s' too big"), GIT_DIR_ENVIRONMENT
);
948 gitfile
= (char*)read_gitfile(gitdirenv
);
950 gitfile
= xstrdup(gitfile
);
954 if (!is_git_directory(gitdirenv
)) {
960 die(_("not a git repository: '%s'"), gitdirenv
);
963 if (check_repository_format_gently(gitdirenv
, repo_fmt
, nongit_ok
)) {
968 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
970 set_git_work_tree(work_tree_env
);
971 else if (is_bare_repository_cfg
> 0) {
972 if (git_work_tree_cfg
) {
974 warning("core.bare and core.worktree do not make sense");
975 work_tree_config_is_bogus
= 1;
979 set_git_dir(gitdirenv
, 0);
983 else if (git_work_tree_cfg
) { /* #6, #14 */
984 if (is_absolute_path(git_work_tree_cfg
))
985 set_git_work_tree(git_work_tree_cfg
);
988 if (chdir(gitdirenv
))
989 die_errno(_("cannot chdir to '%s'"), gitdirenv
);
990 if (chdir(git_work_tree_cfg
))
991 die_errno(_("cannot chdir to '%s'"), git_work_tree_cfg
);
992 core_worktree
= xgetcwd();
994 die_errno(_("cannot come back to cwd"));
995 set_git_work_tree(core_worktree
);
999 else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, 1)) {
1001 set_git_dir(gitdirenv
, 0);
1006 set_git_work_tree(".");
1008 /* set_git_work_tree() must have been called by now */
1009 worktree
= get_git_work_tree();
1011 /* both get_git_work_tree() and cwd are already normalized */
1012 if (!strcmp(cwd
->buf
, worktree
)) { /* cwd == worktree */
1013 set_git_dir(gitdirenv
, 0);
1018 offset
= dir_inside_of(cwd
->buf
, worktree
);
1019 if (offset
>= 0) { /* cwd inside worktree? */
1020 set_git_dir(gitdirenv
, 1);
1021 if (chdir(worktree
))
1022 die_errno(_("cannot chdir to '%s'"), worktree
);
1023 strbuf_addch(cwd
, '/');
1025 return cwd
->buf
+ offset
;
1028 /* cwd outside worktree */
1029 set_git_dir(gitdirenv
, 0);
1034 static const char *setup_discovered_git_dir(const char *gitdir
,
1035 struct strbuf
*cwd
, int offset
,
1036 struct repository_format
*repo_fmt
,
1039 if (check_repository_format_gently(gitdir
, repo_fmt
, nongit_ok
))
1042 /* --work-tree is set without --git-dir; use discovered one */
1043 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
1044 char *to_free
= NULL
;
1047 if (offset
!= cwd
->len
&& !is_absolute_path(gitdir
))
1048 gitdir
= to_free
= real_pathdup(gitdir
, 1);
1049 if (chdir(cwd
->buf
))
1050 die_errno(_("cannot come back to cwd"));
1051 ret
= setup_explicit_git_dir(gitdir
, cwd
, repo_fmt
, nongit_ok
);
1056 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
1057 if (is_bare_repository_cfg
> 0) {
1058 set_git_dir(gitdir
, (offset
!= cwd
->len
));
1059 if (chdir(cwd
->buf
))
1060 die_errno(_("cannot come back to cwd"));
1064 /* #0, #1, #5, #8, #9, #12, #13 */
1065 set_git_work_tree(".");
1066 if (strcmp(gitdir
, DEFAULT_GIT_DIR_ENVIRONMENT
))
1067 set_git_dir(gitdir
, 0);
1069 inside_work_tree
= 1;
1070 if (offset
>= cwd
->len
)
1073 /* Make "offset" point past the '/' (already the case for root dirs) */
1074 if (offset
!= offset_1st_component(cwd
->buf
))
1076 /* Add a '/' at the end */
1077 strbuf_addch(cwd
, '/');
1078 return cwd
->buf
+ offset
;
1081 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
1082 static const char *setup_bare_git_dir(struct strbuf
*cwd
, int offset
,
1083 struct repository_format
*repo_fmt
,
1088 if (check_repository_format_gently(".", repo_fmt
, nongit_ok
))
1091 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, "0", 1);
1093 /* --work-tree is set without --git-dir; use discovered one */
1094 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
1095 static const char *gitdir
;
1097 gitdir
= offset
== cwd
->len
? "." : xmemdupz(cwd
->buf
, offset
);
1098 if (chdir(cwd
->buf
))
1099 die_errno(_("cannot come back to cwd"));
1100 return setup_explicit_git_dir(gitdir
, cwd
, repo_fmt
, nongit_ok
);
1104 inside_work_tree
= 0;
1105 if (offset
!= cwd
->len
) {
1106 if (chdir(cwd
->buf
))
1107 die_errno(_("cannot come back to cwd"));
1108 root_len
= offset_1st_component(cwd
->buf
);
1109 strbuf_setlen(cwd
, offset
> root_len
? offset
: root_len
);
1110 set_git_dir(cwd
->buf
, 0);
1113 set_git_dir(".", 0);
1117 static dev_t
get_device_or_die(const char *path
, const char *prefix
, int prefix_len
)
1120 if (stat(path
, &buf
)) {
1121 die_errno(_("failed to stat '%*s%s%s'"),
1123 prefix
? prefix
: "",
1124 prefix
? "/" : "", path
);
1130 * A "string_list_each_func_t" function that canonicalizes an entry
1131 * from GIT_CEILING_DIRECTORIES using real_pathdup(), or
1132 * discards it if unusable. The presence of an empty entry in
1133 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
1134 * subsequent entries.
1136 static int canonicalize_ceiling_entry(struct string_list_item
*item
,
1139 int *empty_entry_found
= cb_data
;
1140 char *ceil
= item
->string
;
1143 *empty_entry_found
= 1;
1145 } else if (!is_absolute_path(ceil
)) {
1147 } else if (*empty_entry_found
) {
1148 /* Keep entry but do not canonicalize it */
1151 char *real_path
= real_pathdup(ceil
, 0);
1156 item
->string
= real_path
;
1161 struct safe_directory_data
{
1166 static int safe_directory_cb(const char *key
, const char *value
,
1167 const struct config_context
*ctx UNUSED
, void *d
)
1169 struct safe_directory_data
*data
= d
;
1171 if (strcmp(key
, "safe.directory"))
1174 if (!value
|| !*value
) {
1176 } else if (!strcmp(value
, "*")) {
1179 const char *interpolated
= NULL
;
1181 if (!git_config_pathname(&interpolated
, key
, value
) &&
1182 !fspathcmp(data
->path
, interpolated
? interpolated
: value
))
1185 free((char *)interpolated
);
1192 * Check if a repository is safe, by verifying the ownership of the
1193 * worktree (if any), the git directory, and the gitfile (if any).
1195 * Exemptions for known-safe repositories can be added via `safe.directory`
1196 * config settings; for non-bare repositories, their worktree needs to be
1197 * added, for bare ones their git directory.
1199 static int ensure_valid_ownership(const char *gitfile
,
1200 const char *worktree
, const char *gitdir
,
1201 struct strbuf
*report
)
1203 struct safe_directory_data data
= {
1204 .path
= worktree
? worktree
: gitdir
1207 if (!git_env_bool("GIT_TEST_ASSUME_DIFFERENT_OWNER", 0) &&
1208 (!gitfile
|| is_path_owned_by_current_user(gitfile
, report
)) &&
1209 (!worktree
|| is_path_owned_by_current_user(worktree
, report
)) &&
1210 (!gitdir
|| is_path_owned_by_current_user(gitdir
, report
)))
1214 * data.path is the "path" that identifies the repository and it is
1215 * constant regardless of what failed above. data.is_safe should be
1216 * initialized to false, and might be changed by the callback.
1218 git_protected_config(safe_directory_cb
, &data
);
1220 return data
.is_safe
;
1223 static int allowed_bare_repo_cb(const char *key
, const char *value
,
1224 const struct config_context
*ctx UNUSED
,
1227 enum allowed_bare_repo
*allowed_bare_repo
= d
;
1229 if (strcasecmp(key
, "safe.bareRepository"))
1232 if (!strcmp(value
, "explicit")) {
1233 *allowed_bare_repo
= ALLOWED_BARE_REPO_EXPLICIT
;
1236 if (!strcmp(value
, "all")) {
1237 *allowed_bare_repo
= ALLOWED_BARE_REPO_ALL
;
1243 static enum allowed_bare_repo
get_allowed_bare_repo(void)
1245 enum allowed_bare_repo result
= ALLOWED_BARE_REPO_ALL
;
1246 git_protected_config(allowed_bare_repo_cb
, &result
);
1250 static const char *allowed_bare_repo_to_string(
1251 enum allowed_bare_repo allowed_bare_repo
)
1253 switch (allowed_bare_repo
) {
1254 case ALLOWED_BARE_REPO_EXPLICIT
:
1256 case ALLOWED_BARE_REPO_ALL
:
1259 BUG("invalid allowed_bare_repo %d",
1265 static int is_implicit_bare_repo(const char *path
)
1268 * what we found is a ".git" directory at the root of
1271 if (ends_with_path_components(path
, ".git"))
1275 * we are inside $GIT_DIR of a secondary worktree of a
1276 * non-bare repository.
1278 if (strstr(path
, "/.git/worktrees/"))
1282 * we are inside $GIT_DIR of a worktree of a non-embedded
1283 * submodule, whose superproject is not a bare repository.
1285 if (strstr(path
, "/.git/modules/"))
1292 * We cannot decide in this function whether we are in the work tree or
1293 * not, since the config can only be read _after_ this function was called.
1295 * Also, we avoid changing any global state (such as the current working
1296 * directory) to allow early callers.
1298 * The directory where the search should start needs to be passed in via the
1299 * `dir` parameter; upon return, the `dir` buffer will contain the path of
1300 * the directory where the search ended, and `gitdir` will contain the path of
1301 * the discovered .git/ directory, if any. If `gitdir` is not absolute, it
1302 * is relative to `dir` (i.e. *not* necessarily the cwd).
1304 static enum discovery_result
setup_git_directory_gently_1(struct strbuf
*dir
,
1305 struct strbuf
*gitdir
,
1306 struct strbuf
*report
,
1309 const char *env_ceiling_dirs
= getenv(CEILING_DIRECTORIES_ENVIRONMENT
);
1310 struct string_list ceiling_dirs
= STRING_LIST_INIT_DUP
;
1311 const char *gitdirenv
;
1312 int ceil_offset
= -1, min_offset
= offset_1st_component(dir
->buf
);
1313 dev_t current_device
= 0;
1314 int one_filesystem
= 1;
1317 * If GIT_DIR is set explicitly, we're not going
1318 * to do any discovery, but we still do repository
1321 gitdirenv
= getenv(GIT_DIR_ENVIRONMENT
);
1323 strbuf_addstr(gitdir
, gitdirenv
);
1324 return GIT_DIR_EXPLICIT
;
1327 if (env_ceiling_dirs
) {
1328 int empty_entry_found
= 0;
1330 string_list_split(&ceiling_dirs
, env_ceiling_dirs
, PATH_SEP
, -1);
1331 filter_string_list(&ceiling_dirs
, 0,
1332 canonicalize_ceiling_entry
, &empty_entry_found
);
1333 ceil_offset
= longest_ancestor_length(dir
->buf
, &ceiling_dirs
);
1334 string_list_clear(&ceiling_dirs
, 0);
1337 if (ceil_offset
< 0)
1338 ceil_offset
= min_offset
- 2;
1340 if (min_offset
&& min_offset
== dir
->len
&&
1341 !is_dir_sep(dir
->buf
[min_offset
- 1])) {
1342 strbuf_addch(dir
, '/');
1347 * Test in the following order (relative to the dir):
1348 * - .git (file containing "gitdir: <path>")
1357 one_filesystem
= !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
1359 current_device
= get_device_or_die(dir
->buf
, NULL
, 0);
1361 int offset
= dir
->len
, error_code
= 0;
1362 char *gitdir_path
= NULL
;
1363 char *gitfile
= NULL
;
1365 if (offset
> min_offset
)
1366 strbuf_addch(dir
, '/');
1367 strbuf_addstr(dir
, DEFAULT_GIT_DIR_ENVIRONMENT
);
1368 gitdirenv
= read_gitfile_gently(dir
->buf
, die_on_error
?
1369 NULL
: &error_code
);
1372 error_code
== READ_GITFILE_ERR_NOT_A_FILE
) {
1373 /* NEEDSWORK: fail if .git is not file nor dir */
1374 if (is_git_directory(dir
->buf
)) {
1375 gitdirenv
= DEFAULT_GIT_DIR_ENVIRONMENT
;
1376 gitdir_path
= xstrdup(dir
->buf
);
1378 } else if (error_code
!= READ_GITFILE_ERR_STAT_FAILED
)
1379 return GIT_DIR_INVALID_GITFILE
;
1381 gitfile
= xstrdup(dir
->buf
);
1383 * Earlier, we tentatively added DEFAULT_GIT_DIR_ENVIRONMENT
1384 * to check that directory for a repository.
1385 * Now trim that tentative addition away, because we want to
1386 * focus on the real directory we are in.
1388 strbuf_setlen(dir
, offset
);
1390 enum discovery_result ret
;
1391 const char *gitdir_candidate
=
1392 gitdir_path
? gitdir_path
: gitdirenv
;
1394 if (ensure_valid_ownership(gitfile
, dir
->buf
,
1395 gitdir_candidate
, report
)) {
1396 strbuf_addstr(gitdir
, gitdirenv
);
1397 ret
= GIT_DIR_DISCOVERED
;
1399 ret
= GIT_DIR_INVALID_OWNERSHIP
;
1402 * Earlier, during discovery, we might have allocated
1403 * string copies for gitdir_path or gitfile so make
1404 * sure we don't leak by freeing them now, before
1405 * leaving the loop and function.
1407 * Note: gitdirenv will be non-NULL whenever these are
1408 * allocated, therefore we need not take care of releasing
1409 * them outside of this conditional block.
1417 if (is_git_directory(dir
->buf
)) {
1418 trace2_data_string("setup", NULL
, "implicit-bare-repository", dir
->buf
);
1419 if (get_allowed_bare_repo() == ALLOWED_BARE_REPO_EXPLICIT
&&
1420 !is_implicit_bare_repo(dir
->buf
))
1421 return GIT_DIR_DISALLOWED_BARE
;
1422 if (!ensure_valid_ownership(NULL
, NULL
, dir
->buf
, report
))
1423 return GIT_DIR_INVALID_OWNERSHIP
;
1424 strbuf_addstr(gitdir
, ".");
1425 return GIT_DIR_BARE
;
1428 if (offset
<= min_offset
)
1429 return GIT_DIR_HIT_CEILING
;
1431 while (--offset
> ceil_offset
&& !is_dir_sep(dir
->buf
[offset
]))
1433 if (offset
<= ceil_offset
)
1434 return GIT_DIR_HIT_CEILING
;
1436 strbuf_setlen(dir
, offset
> min_offset
? offset
: min_offset
);
1437 if (one_filesystem
&&
1438 current_device
!= get_device_or_die(dir
->buf
, NULL
, offset
))
1439 return GIT_DIR_HIT_MOUNT_POINT
;
1443 enum discovery_result
discover_git_directory_reason(struct strbuf
*commondir
,
1444 struct strbuf
*gitdir
)
1446 struct strbuf dir
= STRBUF_INIT
, err
= STRBUF_INIT
;
1447 size_t gitdir_offset
= gitdir
->len
, cwd_len
;
1448 size_t commondir_offset
= commondir
->len
;
1449 struct repository_format candidate
= REPOSITORY_FORMAT_INIT
;
1450 enum discovery_result result
;
1452 if (strbuf_getcwd(&dir
))
1453 return GIT_DIR_CWD_FAILURE
;
1456 result
= setup_git_directory_gently_1(&dir
, gitdir
, NULL
, 0);
1458 strbuf_release(&dir
);
1463 * The returned gitdir is relative to dir, and if dir does not reflect
1464 * the current working directory, we simply make the gitdir absolute.
1466 if (dir
.len
< cwd_len
&& !is_absolute_path(gitdir
->buf
+ gitdir_offset
)) {
1467 /* Avoid a trailing "/." */
1468 if (!strcmp(".", gitdir
->buf
+ gitdir_offset
))
1469 strbuf_setlen(gitdir
, gitdir_offset
);
1471 strbuf_addch(&dir
, '/');
1472 strbuf_insert(gitdir
, gitdir_offset
, dir
.buf
, dir
.len
);
1475 get_common_dir(commondir
, gitdir
->buf
+ gitdir_offset
);
1478 strbuf_addf(&dir
, "%s/config", commondir
->buf
+ commondir_offset
);
1479 read_repository_format(&candidate
, dir
.buf
);
1480 strbuf_release(&dir
);
1482 if (verify_repository_format(&candidate
, &err
) < 0) {
1483 warning("ignoring git dir '%s': %s",
1484 gitdir
->buf
+ gitdir_offset
, err
.buf
);
1485 strbuf_release(&err
);
1486 strbuf_setlen(commondir
, commondir_offset
);
1487 strbuf_setlen(gitdir
, gitdir_offset
);
1488 clear_repository_format(&candidate
);
1489 return GIT_DIR_INVALID_FORMAT
;
1492 clear_repository_format(&candidate
);
1496 const char *setup_git_directory_gently(int *nongit_ok
)
1498 static struct strbuf cwd
= STRBUF_INIT
;
1499 struct strbuf dir
= STRBUF_INIT
, gitdir
= STRBUF_INIT
, report
= STRBUF_INIT
;
1500 const char *prefix
= NULL
;
1501 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
1504 * We may have read an incomplete configuration before
1505 * setting-up the git directory. If so, clear the cache so
1506 * that the next queries to the configuration reload complete
1507 * configuration (including the per-repo config file that we
1508 * ignored previously).
1513 * Let's assume that we are in a git repository.
1514 * If it turns out later that we are somewhere else, the value will be
1515 * updated accordingly.
1520 if (strbuf_getcwd(&cwd
))
1521 die_errno(_("Unable to read current working directory"));
1522 strbuf_addbuf(&dir
, &cwd
);
1524 switch (setup_git_directory_gently_1(&dir
, &gitdir
, &report
, 1)) {
1525 case GIT_DIR_EXPLICIT
:
1526 prefix
= setup_explicit_git_dir(gitdir
.buf
, &cwd
, &repo_fmt
, nongit_ok
);
1528 case GIT_DIR_DISCOVERED
:
1529 if (dir
.len
< cwd
.len
&& chdir(dir
.buf
))
1530 die(_("cannot change to '%s'"), dir
.buf
);
1531 prefix
= setup_discovered_git_dir(gitdir
.buf
, &cwd
, dir
.len
,
1532 &repo_fmt
, nongit_ok
);
1535 if (dir
.len
< cwd
.len
&& chdir(dir
.buf
))
1536 die(_("cannot change to '%s'"), dir
.buf
);
1537 prefix
= setup_bare_git_dir(&cwd
, dir
.len
, &repo_fmt
, nongit_ok
);
1539 case GIT_DIR_HIT_CEILING
:
1541 die(_("not a git repository (or any of the parent directories): %s"),
1542 DEFAULT_GIT_DIR_ENVIRONMENT
);
1545 case GIT_DIR_HIT_MOUNT_POINT
:
1547 die(_("not a git repository (or any parent up to mount point %s)\n"
1548 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set)."),
1552 case GIT_DIR_INVALID_OWNERSHIP
:
1554 struct strbuf quoted
= STRBUF_INIT
;
1556 strbuf_complete(&report
, '\n');
1557 sq_quote_buf_pretty("ed
, dir
.buf
);
1558 die(_("detected dubious ownership in repository at '%s'\n"
1560 "To add an exception for this directory, call:\n"
1562 "\tgit config --global --add safe.directory %s"),
1563 dir
.buf
, report
.buf
, quoted
.buf
);
1567 case GIT_DIR_DISALLOWED_BARE
:
1569 die(_("cannot use bare repository '%s' (safe.bareRepository is '%s')"),
1571 allowed_bare_repo_to_string(get_allowed_bare_repo()));
1575 case GIT_DIR_CWD_FAILURE
:
1576 case GIT_DIR_INVALID_FORMAT
:
1578 * As a safeguard against setup_git_directory_gently_1 returning
1579 * these values, fallthrough to BUG. Otherwise it is possible to
1580 * set startup_info->have_repository to 1 when we did nothing to
1581 * find a repository.
1584 BUG("unhandled setup_git_directory_gently_1() result");
1588 * At this point, nongit_ok is stable. If it is non-NULL and points
1589 * to a non-zero value, then this means that we haven't found a
1590 * repository and that the caller expects startup_info to reflect
1593 * Regardless of the state of nongit_ok, startup_info->prefix and
1594 * the GIT_PREFIX environment variable must always match. For details
1595 * see Documentation/config/alias.txt.
1597 if (nongit_ok
&& *nongit_ok
)
1598 startup_info
->have_repository
= 0;
1600 startup_info
->have_repository
= 1;
1603 * Not all paths through the setup code will call 'set_git_dir()' (which
1604 * directly sets up the environment) so in order to guarantee that the
1605 * environment is in a consistent state after setup, explicitly setup
1606 * the environment if we have a repository.
1608 * NEEDSWORK: currently we allow bogus GIT_DIR values to be set in some
1609 * code paths so we also need to explicitly setup the environment if
1610 * the user has set GIT_DIR. It may be beneficial to disallow bogus
1611 * GIT_DIR values at some point in the future.
1613 if (/* GIT_DIR_EXPLICIT, GIT_DIR_DISCOVERED, GIT_DIR_BARE */
1614 startup_info
->have_repository
||
1615 /* GIT_DIR_EXPLICIT */
1616 getenv(GIT_DIR_ENVIRONMENT
)) {
1617 if (!the_repository
->gitdir
) {
1618 const char *gitdir
= getenv(GIT_DIR_ENVIRONMENT
);
1620 gitdir
= DEFAULT_GIT_DIR_ENVIRONMENT
;
1621 setup_git_env(gitdir
);
1623 if (startup_info
->have_repository
) {
1624 repo_set_hash_algo(the_repository
, repo_fmt
.hash_algo
);
1625 repo_set_compat_hash_algo(the_repository
,
1626 repo_fmt
.compat_hash_algo
);
1627 repo_set_ref_storage_format(the_repository
,
1628 repo_fmt
.ref_storage_format
);
1629 the_repository
->repository_format_worktree_config
=
1630 repo_fmt
.worktree_config
;
1631 /* take ownership of repo_fmt.partial_clone */
1632 the_repository
->repository_format_partial_clone
=
1633 repo_fmt
.partial_clone
;
1634 repo_fmt
.partial_clone
= NULL
;
1638 * Since precompose_string_if_needed() needs to look at
1639 * the core.precomposeunicode configuration, this
1640 * has to happen after the above block that finds
1641 * out where the repository is, i.e. a preparation
1642 * for calling git_config_get_bool().
1645 prefix
= precompose_string_if_needed(prefix
);
1646 startup_info
->prefix
= prefix
;
1647 setenv(GIT_PREFIX_ENVIRONMENT
, prefix
, 1);
1649 startup_info
->prefix
= NULL
;
1650 setenv(GIT_PREFIX_ENVIRONMENT
, "", 1);
1653 setup_original_cwd();
1655 strbuf_release(&dir
);
1656 strbuf_release(&gitdir
);
1657 strbuf_release(&report
);
1658 clear_repository_format(&repo_fmt
);
1663 int git_config_perm(const char *var
, const char *value
)
1671 if (!strcmp(value
, "umask"))
1673 if (!strcmp(value
, "group"))
1675 if (!strcmp(value
, "all") ||
1676 !strcmp(value
, "world") ||
1677 !strcmp(value
, "everybody"))
1678 return PERM_EVERYBODY
;
1680 /* Parse octal numbers */
1681 i
= strtol(value
, &endptr
, 8);
1683 /* If not an octal number, maybe true/false? */
1685 return git_config_bool(var
, value
) ? PERM_GROUP
: PERM_UMASK
;
1688 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
1689 * a chmod value to restrict to.
1692 case PERM_UMASK
: /* 0 */
1694 case OLD_PERM_GROUP
: /* 1 */
1696 case OLD_PERM_EVERYBODY
: /* 2 */
1697 return PERM_EVERYBODY
;
1700 /* A filemode value was given: 0xxx */
1702 if ((i
& 0600) != 0600)
1703 die(_("problem with core.sharedRepository filemode value "
1704 "(0%.3o).\nThe owner of files must always have "
1705 "read and write permissions."), i
);
1708 * Mask filemode value. Others can not get write permission.
1709 * x flags for directories are handled separately.
1714 void check_repository_format(struct repository_format
*fmt
)
1716 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
1719 check_repository_format_gently(get_git_dir(), fmt
, NULL
);
1720 startup_info
->have_repository
= 1;
1721 repo_set_hash_algo(the_repository
, fmt
->hash_algo
);
1722 repo_set_compat_hash_algo(the_repository
, fmt
->compat_hash_algo
);
1723 repo_set_ref_storage_format(the_repository
,
1724 fmt
->ref_storage_format
);
1725 the_repository
->repository_format_worktree_config
=
1726 fmt
->worktree_config
;
1727 the_repository
->repository_format_partial_clone
=
1728 xstrdup_or_null(fmt
->partial_clone
);
1729 clear_repository_format(&repo_fmt
);
1733 * Returns the "prefix", a path to the current working directory
1734 * relative to the work tree root, or NULL, if the current working
1735 * directory is not a strict subdirectory of the work tree root. The
1736 * prefix always ends with a '/' character.
1738 const char *setup_git_directory(void)
1740 return setup_git_directory_gently(NULL
);
1743 const char *resolve_gitdir_gently(const char *suspect
, int *return_error_code
)
1745 if (is_git_directory(suspect
))
1747 return read_gitfile_gently(suspect
, return_error_code
);
1750 /* if any standard file descriptor is missing open it to /dev/null */
1751 void sanitize_stdfds(void)
1753 int fd
= xopen("/dev/null", O_RDWR
);
1762 #ifdef NO_POSIX_GOODIES
1770 die_errno(_("fork failed"));
1775 die_errno(_("setsid failed"));
1784 #ifdef NO_TRUSTABLE_FILEMODE
1785 #define TEST_FILEMODE 0
1787 #define TEST_FILEMODE 1
1790 #define GIT_DEFAULT_HASH_ENVIRONMENT "GIT_DEFAULT_HASH"
1792 static void copy_templates_1(struct strbuf
*path
, struct strbuf
*template_path
,
1795 size_t path_baselen
= path
->len
;
1796 size_t template_baselen
= template_path
->len
;
1799 /* Note: if ".git/hooks" file exists in the repository being
1800 * re-initialized, /etc/core-git/templates/hooks/update would
1801 * cause "git init" to fail here. I think this is sane but
1802 * it means that the set of templates we ship by default, along
1803 * with the way the namespace under .git/ is organized, should
1804 * be really carefully chosen.
1806 safe_create_dir(path
->buf
, 1);
1807 while ((de
= readdir(dir
)) != NULL
) {
1808 struct stat st_git
, st_template
;
1811 strbuf_setlen(path
, path_baselen
);
1812 strbuf_setlen(template_path
, template_baselen
);
1814 if (de
->d_name
[0] == '.')
1816 strbuf_addstr(path
, de
->d_name
);
1817 strbuf_addstr(template_path
, de
->d_name
);
1818 if (lstat(path
->buf
, &st_git
)) {
1819 if (errno
!= ENOENT
)
1820 die_errno(_("cannot stat '%s'"), path
->buf
);
1825 if (lstat(template_path
->buf
, &st_template
))
1826 die_errno(_("cannot stat template '%s'"), template_path
->buf
);
1828 if (S_ISDIR(st_template
.st_mode
)) {
1829 DIR *subdir
= opendir(template_path
->buf
);
1831 die_errno(_("cannot opendir '%s'"), template_path
->buf
);
1832 strbuf_addch(path
, '/');
1833 strbuf_addch(template_path
, '/');
1834 copy_templates_1(path
, template_path
, subdir
);
1839 else if (S_ISLNK(st_template
.st_mode
)) {
1840 struct strbuf lnk
= STRBUF_INIT
;
1841 if (strbuf_readlink(&lnk
, template_path
->buf
,
1842 st_template
.st_size
) < 0)
1843 die_errno(_("cannot readlink '%s'"), template_path
->buf
);
1844 if (symlink(lnk
.buf
, path
->buf
))
1845 die_errno(_("cannot symlink '%s' '%s'"),
1846 lnk
.buf
, path
->buf
);
1847 strbuf_release(&lnk
);
1849 else if (S_ISREG(st_template
.st_mode
)) {
1850 if (copy_file(path
->buf
, template_path
->buf
, st_template
.st_mode
))
1851 die_errno(_("cannot copy '%s' to '%s'"),
1852 template_path
->buf
, path
->buf
);
1855 error(_("ignoring template %s"), template_path
->buf
);
1859 static void copy_templates(const char *template_dir
, const char *init_template_dir
)
1861 struct strbuf path
= STRBUF_INIT
;
1862 struct strbuf template_path
= STRBUF_INIT
;
1863 size_t template_len
;
1864 struct repository_format template_format
= REPOSITORY_FORMAT_INIT
;
1865 struct strbuf err
= STRBUF_INIT
;
1867 char *to_free
= NULL
;
1870 template_dir
= getenv(TEMPLATE_DIR_ENVIRONMENT
);
1872 template_dir
= init_template_dir
;
1874 template_dir
= to_free
= system_path(DEFAULT_GIT_TEMPLATE_DIR
);
1875 if (!template_dir
[0]) {
1880 strbuf_addstr(&template_path
, template_dir
);
1881 strbuf_complete(&template_path
, '/');
1882 template_len
= template_path
.len
;
1884 dir
= opendir(template_path
.buf
);
1886 warning(_("templates not found in %s"), template_dir
);
1890 /* Make sure that template is from the correct vintage */
1891 strbuf_addstr(&template_path
, "config");
1892 read_repository_format(&template_format
, template_path
.buf
);
1893 strbuf_setlen(&template_path
, template_len
);
1896 * No mention of version at all is OK, but anything else should be
1899 if (template_format
.version
>= 0 &&
1900 verify_repository_format(&template_format
, &err
) < 0) {
1901 warning(_("not copying templates from '%s': %s"),
1902 template_dir
, err
.buf
);
1903 strbuf_release(&err
);
1904 goto close_free_return
;
1907 strbuf_addstr(&path
, get_git_common_dir());
1908 strbuf_complete(&path
, '/');
1909 copy_templates_1(&path
, &template_path
, dir
);
1914 strbuf_release(&path
);
1915 strbuf_release(&template_path
);
1916 clear_repository_format(&template_format
);
1920 * If the git_dir is not directly inside the working tree, then git will not
1921 * find it by default, and we need to set the worktree explicitly.
1923 static int needs_work_tree_config(const char *git_dir
, const char *work_tree
)
1925 if (!strcmp(work_tree
, "/") && !strcmp(git_dir
, "/.git"))
1927 if (skip_prefix(git_dir
, work_tree
, &git_dir
) &&
1928 !strcmp(git_dir
, "/.git"))
1933 void initialize_repository_version(int hash_algo
,
1934 unsigned int ref_storage_format
,
1937 char repo_version_string
[10];
1938 int repo_version
= GIT_REPO_VERSION
;
1941 * Note that we initialize the repository version to 1 when the ref
1942 * storage format is unknown. This is on purpose so that we can add the
1943 * correct object format to the config during git-clone(1). The format
1944 * version will get adjusted by git-clone(1) once it has learned about
1945 * the remote repository's format.
1947 if (hash_algo
!= GIT_HASH_SHA1
||
1948 ref_storage_format
!= REF_STORAGE_FORMAT_FILES
)
1949 repo_version
= GIT_REPO_VERSION_READ
;
1951 /* This forces creation of new config file */
1952 xsnprintf(repo_version_string
, sizeof(repo_version_string
),
1953 "%d", repo_version
);
1954 git_config_set("core.repositoryformatversion", repo_version_string
);
1956 if (hash_algo
!= GIT_HASH_SHA1
&& hash_algo
!= GIT_HASH_UNKNOWN
)
1957 git_config_set("extensions.objectformat",
1958 hash_algos
[hash_algo
].name
);
1960 git_config_set_gently("extensions.objectformat", NULL
);
1962 if (ref_storage_format
!= REF_STORAGE_FORMAT_FILES
)
1963 git_config_set("extensions.refstorage",
1964 ref_storage_format_to_name(ref_storage_format
));
1967 static int is_reinit(void)
1969 struct strbuf buf
= STRBUF_INIT
;
1973 git_path_buf(&buf
, "HEAD");
1974 ret
= !access(buf
.buf
, R_OK
) || readlink(buf
.buf
, junk
, sizeof(junk
) - 1) != -1;
1975 strbuf_release(&buf
);
1979 void create_reference_database(unsigned int ref_storage_format
,
1980 const char *initial_branch
, int quiet
)
1982 struct strbuf err
= STRBUF_INIT
;
1983 int reinit
= is_reinit();
1985 repo_set_ref_storage_format(the_repository
, ref_storage_format
);
1986 if (refs_init_db(get_main_ref_store(the_repository
), 0, &err
))
1987 die("failed to set up refs db: %s", err
.buf
);
1990 * Point the HEAD symref to the initial branch with if HEAD does
1996 if (!initial_branch
)
1997 initial_branch
= git_default_branch_name(quiet
);
1999 ref
= xstrfmt("refs/heads/%s", initial_branch
);
2000 if (check_refname_format(ref
, 0) < 0)
2001 die(_("invalid initial branch name: '%s'"),
2004 if (create_symref("HEAD", ref
, NULL
) < 0)
2009 if (reinit
&& initial_branch
)
2010 warning(_("re-init: ignored --initial-branch=%s"),
2013 strbuf_release(&err
);
2016 static int create_default_files(const char *template_path
,
2017 const char *original_git_dir
,
2018 const struct repository_format
*fmt
,
2019 int init_shared_repository
)
2022 struct strbuf buf
= STRBUF_INIT
;
2026 const char *init_template_dir
= NULL
;
2027 const char *work_tree
= get_git_work_tree();
2030 * First copy the templates -- we might have the default
2031 * config file there, in which case we would want to read
2032 * from it after installing.
2034 * Before reading that config, we also need to clear out any cached
2035 * values (since we've just potentially changed what's available on
2038 git_config_get_pathname("init.templatedir", &init_template_dir
);
2039 copy_templates(template_path
, init_template_dir
);
2040 free((char *)init_template_dir
);
2042 reset_shared_repository();
2043 git_config(git_default_config
, NULL
);
2045 reinit
= is_reinit();
2048 * We must make sure command-line options continue to override any
2049 * values we might have just re-read from the config.
2051 if (init_shared_repository
!= -1)
2052 set_shared_repository(init_shared_repository
);
2054 is_bare_repository_cfg
= !work_tree
;
2057 * We would have created the above under user's umask -- under
2058 * shared-repository settings, we would need to fix them up.
2060 if (get_shared_repository()) {
2061 adjust_shared_perm(get_git_dir());
2064 initialize_repository_version(fmt
->hash_algo
, fmt
->ref_storage_format
, 0);
2066 /* Check filemode trustability */
2067 path
= git_path_buf(&buf
, "config");
2068 filemode
= TEST_FILEMODE
;
2069 if (TEST_FILEMODE
&& !lstat(path
, &st1
)) {
2071 filemode
= (!chmod(path
, st1
.st_mode
^ S_IXUSR
) &&
2072 !lstat(path
, &st2
) &&
2073 st1
.st_mode
!= st2
.st_mode
&&
2074 !chmod(path
, st1
.st_mode
));
2075 if (filemode
&& !reinit
&& (st1
.st_mode
& S_IXUSR
))
2078 git_config_set("core.filemode", filemode
? "true" : "false");
2080 if (is_bare_repository())
2081 git_config_set("core.bare", "true");
2083 git_config_set("core.bare", "false");
2084 /* allow template config file to override the default */
2085 if (log_all_ref_updates
== LOG_REFS_UNSET
)
2086 git_config_set("core.logallrefupdates", "true");
2087 if (needs_work_tree_config(original_git_dir
, work_tree
))
2088 git_config_set("core.worktree", work_tree
);
2092 /* Check if symlink is supported in the work tree */
2093 path
= git_path_buf(&buf
, "tXXXXXX");
2094 if (!close(xmkstemp(path
)) &&
2096 !symlink("testing", path
) &&
2097 !lstat(path
, &st1
) &&
2098 S_ISLNK(st1
.st_mode
))
2099 unlink(path
); /* good */
2101 git_config_set("core.symlinks", "false");
2103 /* Check if the filesystem is case-insensitive */
2104 path
= git_path_buf(&buf
, "CoNfIg");
2105 if (!access(path
, F_OK
))
2106 git_config_set("core.ignorecase", "true");
2107 probe_utf8_pathname_composition();
2110 strbuf_release(&buf
);
2114 static void create_object_directory(void)
2116 struct strbuf path
= STRBUF_INIT
;
2119 strbuf_addstr(&path
, get_object_directory());
2122 safe_create_dir(path
.buf
, 1);
2124 strbuf_setlen(&path
, baselen
);
2125 strbuf_addstr(&path
, "/pack");
2126 safe_create_dir(path
.buf
, 1);
2128 strbuf_setlen(&path
, baselen
);
2129 strbuf_addstr(&path
, "/info");
2130 safe_create_dir(path
.buf
, 1);
2132 strbuf_release(&path
);
2135 static void separate_git_dir(const char *git_dir
, const char *git_link
)
2139 if (!stat(git_link
, &st
)) {
2142 if (S_ISREG(st
.st_mode
))
2143 src
= read_gitfile(git_link
);
2144 else if (S_ISDIR(st
.st_mode
))
2147 die(_("unable to handle file type %d"), (int)st
.st_mode
);
2149 if (rename(src
, git_dir
))
2150 die_errno(_("unable to move %s to %s"), src
, git_dir
);
2151 repair_worktrees(NULL
, NULL
);
2154 write_file(git_link
, "gitdir: %s", git_dir
);
2157 static void validate_hash_algorithm(struct repository_format
*repo_fmt
, int hash
)
2159 const char *env
= getenv(GIT_DEFAULT_HASH_ENVIRONMENT
);
2161 * If we already have an initialized repo, don't allow the user to
2162 * specify a different algorithm, as that could cause corruption.
2163 * Otherwise, if the user has specified one on the command line, use it.
2165 if (repo_fmt
->version
>= 0 && hash
!= GIT_HASH_UNKNOWN
&& hash
!= repo_fmt
->hash_algo
)
2166 die(_("attempt to reinitialize repository with different hash"));
2167 else if (hash
!= GIT_HASH_UNKNOWN
)
2168 repo_fmt
->hash_algo
= hash
;
2170 int env_algo
= hash_algo_by_name(env
);
2171 if (env_algo
== GIT_HASH_UNKNOWN
)
2172 die(_("unknown hash algorithm '%s'"), env
);
2173 repo_fmt
->hash_algo
= env_algo
;
2177 static void validate_ref_storage_format(struct repository_format
*repo_fmt
,
2178 unsigned int format
)
2180 const char *name
= getenv("GIT_DEFAULT_REF_FORMAT");
2182 if (repo_fmt
->version
>= 0 &&
2183 format
!= REF_STORAGE_FORMAT_UNKNOWN
&&
2184 format
!= repo_fmt
->ref_storage_format
) {
2185 die(_("attempt to reinitialize repository with different reference storage format"));
2186 } else if (format
!= REF_STORAGE_FORMAT_UNKNOWN
) {
2187 repo_fmt
->ref_storage_format
= format
;
2189 format
= ref_storage_format_by_name(name
);
2190 if (format
== REF_STORAGE_FORMAT_UNKNOWN
)
2191 die(_("unknown ref storage format '%s'"), name
);
2192 repo_fmt
->ref_storage_format
= format
;
2196 int init_db(const char *git_dir
, const char *real_git_dir
,
2197 const char *template_dir
, int hash
,
2198 unsigned int ref_storage_format
,
2199 const char *initial_branch
,
2200 int init_shared_repository
, unsigned int flags
)
2203 int exist_ok
= flags
& INIT_DB_EXIST_OK
;
2204 char *original_git_dir
= real_pathdup(git_dir
, 1);
2205 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
2210 if (!exist_ok
&& !stat(git_dir
, &st
))
2211 die(_("%s already exists"), git_dir
);
2213 if (!exist_ok
&& !stat(real_git_dir
, &st
))
2214 die(_("%s already exists"), real_git_dir
);
2216 set_git_dir(real_git_dir
, 1);
2217 git_dir
= get_git_dir();
2218 separate_git_dir(git_dir
, original_git_dir
);
2221 set_git_dir(git_dir
, 1);
2222 git_dir
= get_git_dir();
2224 startup_info
->have_repository
= 1;
2226 /* Ensure `core.hidedotfiles` is processed */
2227 git_config(platform_core_config
, NULL
);
2229 safe_create_dir(git_dir
, 0);
2232 /* Check to see if the repository version is right.
2233 * Note that a newly created repository does not have
2234 * config file, so this will not fail. What we are catching
2235 * is an attempt to reinitialize new repository with an old tool.
2237 check_repository_format(&repo_fmt
);
2239 validate_hash_algorithm(&repo_fmt
, hash
);
2240 validate_ref_storage_format(&repo_fmt
, ref_storage_format
);
2242 reinit
= create_default_files(template_dir
, original_git_dir
,
2243 &repo_fmt
, init_shared_repository
);
2246 * Now that we have set up both the hash algorithm and the ref storage
2247 * format we can update the repository's settings accordingly.
2249 repo_set_hash_algo(the_repository
, repo_fmt
.hash_algo
);
2250 repo_set_ref_storage_format(the_repository
, repo_fmt
.ref_storage_format
);
2252 if (!(flags
& INIT_DB_SKIP_REFDB
))
2253 create_reference_database(repo_fmt
.ref_storage_format
,
2254 initial_branch
, flags
& INIT_DB_QUIET
);
2255 create_object_directory();
2257 if (get_shared_repository()) {
2259 /* We do not spell "group" and such, so that
2260 * the configuration can be read by older version
2261 * of git. Note, we use octal numbers for new share modes,
2262 * and compatibility values for PERM_GROUP and
2265 if (get_shared_repository() < 0)
2266 /* force to the mode value */
2267 xsnprintf(buf
, sizeof(buf
), "0%o", -get_shared_repository());
2268 else if (get_shared_repository() == PERM_GROUP
)
2269 xsnprintf(buf
, sizeof(buf
), "%d", OLD_PERM_GROUP
);
2270 else if (get_shared_repository() == PERM_EVERYBODY
)
2271 xsnprintf(buf
, sizeof(buf
), "%d", OLD_PERM_EVERYBODY
);
2273 BUG("invalid value for shared_repository");
2274 git_config_set("core.sharedrepository", buf
);
2275 git_config_set("receive.denyNonFastforwards", "true");
2278 if (!(flags
& INIT_DB_QUIET
)) {
2279 int len
= strlen(git_dir
);
2282 printf(get_shared_repository()
2283 ? _("Reinitialized existing shared Git repository in %s%s\n")
2284 : _("Reinitialized existing Git repository in %s%s\n"),
2285 git_dir
, len
&& git_dir
[len
-1] != '/' ? "/" : "");
2287 printf(get_shared_repository()
2288 ? _("Initialized empty shared Git repository in %s%s\n")
2289 : _("Initialized empty Git repository in %s%s\n"),
2290 git_dir
, len
&& git_dir
[len
-1] != '/' ? "/" : "");
2293 clear_repository_format(&repo_fmt
);
2294 free(original_git_dir
);