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"
21 static int inside_git_dir
= -1;
22 static int inside_work_tree
= -1;
23 static int work_tree_config_is_bogus
;
24 enum allowed_bare_repo
{
25 ALLOWED_BARE_REPO_EXPLICIT
= 0,
26 ALLOWED_BARE_REPO_ALL
,
29 static struct startup_info the_startup_info
;
30 struct startup_info
*startup_info
= &the_startup_info
;
31 const char *tmp_original_cwd
;
34 * The input parameter must contain an absolute path, and it must already be
37 * Find the part of an absolute path that lies inside the work tree by
38 * dereferencing symlinks outside the work tree, for example:
39 * /dir1/repo/dir2/file (work tree is /dir1/repo) -> dir2/file
40 * /dir/file (work tree is /) -> dir/file
41 * /dir/symlink1/symlink2 (symlink1 points to work tree) -> symlink2
42 * /dir/repolink/file (repolink points to /dir/repo) -> file
43 * /dir/repo (exactly equal to work tree) -> (empty string)
45 static int abspath_part_inside_repo(char *path
)
51 const char *work_tree
= get_git_work_tree();
52 struct strbuf realpath
= STRBUF_INIT
;
56 wtlen
= strlen(work_tree
);
58 off
= offset_1st_component(path
);
60 /* check if work tree is already the prefix */
61 if (wtlen
<= len
&& !fspathncmp(path
, work_tree
, wtlen
)) {
62 if (path
[wtlen
] == '/') {
63 memmove(path
, path
+ wtlen
+ 1, len
- wtlen
);
65 } else if (path
[wtlen
- 1] == '/' || path
[wtlen
] == '\0') {
66 /* work tree is the root, or the whole path */
67 memmove(path
, path
+ wtlen
, len
- wtlen
+ 1);
70 /* work tree might match beginning of a symlink to work tree */
76 /* check each '/'-terminated level */
81 strbuf_realpath(&realpath
, path0
, 1);
82 if (fspathcmp(realpath
.buf
, work_tree
) == 0) {
83 memmove(path0
, path
+ 1, len
- (path
- path0
));
84 strbuf_release(&realpath
);
91 /* check whole path */
92 strbuf_realpath(&realpath
, path0
, 1);
93 if (fspathcmp(realpath
.buf
, work_tree
) == 0) {
95 strbuf_release(&realpath
);
99 strbuf_release(&realpath
);
104 * Normalize "path", prepending the "prefix" for relative paths. If
105 * remaining_prefix is not NULL, return the actual prefix still
106 * remains in the path. For example, prefix = sub1/sub2/ and path is
108 * foo -> sub1/sub2/foo (full prefix)
109 * ../foo -> sub1/foo (remaining prefix is sub1/)
110 * ../../bar -> bar (no remaining prefix)
111 * ../../sub1/sub2/foo -> sub1/sub2/foo (but no remaining prefix)
112 * `pwd`/../bar -> sub1/bar (no remaining prefix)
114 char *prefix_path_gently(const char *prefix
, int len
,
115 int *remaining_prefix
, const char *path
)
117 const char *orig
= path
;
119 if (is_absolute_path(orig
)) {
120 sanitized
= xmallocz(strlen(path
));
121 if (remaining_prefix
)
122 *remaining_prefix
= 0;
123 if (normalize_path_copy_len(sanitized
, path
, remaining_prefix
)) {
127 if (abspath_part_inside_repo(sanitized
)) {
132 sanitized
= xstrfmt("%.*s%s", len
, len
? prefix
: "", path
);
133 if (remaining_prefix
)
134 *remaining_prefix
= len
;
135 if (normalize_path_copy_len(sanitized
, sanitized
, remaining_prefix
)) {
143 char *prefix_path(const char *prefix
, int len
, const char *path
)
145 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
147 const char *hint_path
= get_git_work_tree();
149 hint_path
= get_git_dir();
150 die(_("'%s' is outside repository at '%s'"), path
,
151 absolute_path(hint_path
));
156 int path_inside_repo(const char *prefix
, const char *path
)
158 int len
= prefix
? strlen(prefix
) : 0;
159 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
167 int check_filename(const char *prefix
, const char *arg
)
169 char *to_free
= NULL
;
172 if (skip_prefix(arg
, ":/", &arg
)) {
173 if (!*arg
) /* ":/" is root dir, always exists */
176 } else if (skip_prefix(arg
, ":!", &arg
) ||
177 skip_prefix(arg
, ":^", &arg
)) {
178 if (!*arg
) /* excluding everything is silly, but allowed */
183 arg
= to_free
= prefix_filename(prefix
, arg
);
185 if (!lstat(arg
, &st
)) {
187 return 1; /* file exists */
189 if (is_missing_file_error(errno
)) {
191 return 0; /* file does not exist */
193 die_errno(_("failed to stat '%s'"), arg
);
196 static void NORETURN
die_verify_filename(struct repository
*r
,
199 int diagnose_misspelt_rev
)
201 if (!diagnose_misspelt_rev
)
202 die(_("%s: no such path in the working tree.\n"
203 "Use 'git <command> -- <path>...' to specify paths that do not exist locally."),
206 * Saying "'(icase)foo' does not exist in the index" when the
207 * user gave us ":(icase)foo" is just stupid. A magic pathspec
208 * begins with a colon and is followed by a non-alnum; do not
209 * let maybe_die_on_misspelt_object_name() even trigger.
211 if (!(arg
[0] == ':' && !isalnum(arg
[1])))
212 maybe_die_on_misspelt_object_name(r
, arg
, prefix
);
214 /* ... or fall back the most general message. */
215 die(_("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
216 "Use '--' to separate paths from revisions, like this:\n"
217 "'git <command> [<revision>...] -- [<file>...]'"), arg
);
222 * Check for arguments that don't resolve as actual files,
223 * but which look sufficiently like pathspecs that we'll consider
224 * them such for the purposes of rev/pathspec DWIM parsing.
226 static int looks_like_pathspec(const char *arg
)
232 * Wildcard characters imply the user is looking to match pathspecs
233 * that aren't in the filesystem. Note that this doesn't include
234 * backslash even though it's a glob special; by itself it doesn't
235 * cause any increase in the match. Likewise ignore backslash-escaped
236 * wildcard characters.
238 for (p
= arg
; *p
; p
++) {
241 } else if (is_glob_special(*p
)) {
249 /* long-form pathspec magic */
250 if (starts_with(arg
, ":("))
257 * Verify a filename that we got as an argument for a pathspec
258 * entry. Note that a filename that begins with "-" never verifies
259 * as true, because even if such a filename were to exist, we want
260 * it to be preceded by the "--" marker (or we want the user to
261 * use a format like "./-filename")
263 * The "diagnose_misspelt_rev" is used to provide a user-friendly
264 * diagnosis when dying upon finding that "name" is not a pathname.
265 * If set to 1, the diagnosis will try to diagnose "name" as an
266 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
267 * will only complain about an inexisting file.
269 * This function is typically called to check that a "file or rev"
270 * argument is unambiguous. In this case, the caller will want
271 * diagnose_misspelt_rev == 1 when verifying the first non-rev
272 * argument (which could have been a revision), and
273 * diagnose_misspelt_rev == 0 for the next ones (because we already
274 * saw a filename, there's not ambiguity anymore).
276 void verify_filename(const char *prefix
,
278 int diagnose_misspelt_rev
)
281 die(_("option '%s' must come before non-option arguments"), arg
);
282 if (looks_like_pathspec(arg
) || check_filename(prefix
, arg
))
284 die_verify_filename(the_repository
, prefix
, arg
, diagnose_misspelt_rev
);
288 * Opposite of the above: the command line did not have -- marker
289 * and we parsed the arg as a refname. It should not be interpretable
292 void verify_non_filename(const char *prefix
, const char *arg
)
294 if (!is_inside_work_tree() || is_inside_git_dir())
298 if (!check_filename(prefix
, arg
))
300 die(_("ambiguous argument '%s': both revision and filename\n"
301 "Use '--' to separate paths from revisions, like this:\n"
302 "'git <command> [<revision>...] -- [<file>...]'"), arg
);
305 int get_common_dir(struct strbuf
*sb
, const char *gitdir
)
307 const char *git_env_common_dir
= getenv(GIT_COMMON_DIR_ENVIRONMENT
);
308 if (git_env_common_dir
) {
309 strbuf_addstr(sb
, git_env_common_dir
);
312 return get_common_dir_noenv(sb
, gitdir
);
316 int get_common_dir_noenv(struct strbuf
*sb
, const char *gitdir
)
318 struct strbuf data
= STRBUF_INIT
;
319 struct strbuf path
= STRBUF_INIT
;
322 strbuf_addf(&path
, "%s/commondir", gitdir
);
323 if (file_exists(path
.buf
)) {
324 if (strbuf_read_file(&data
, path
.buf
, 0) <= 0)
325 die_errno(_("failed to read %s"), path
.buf
);
326 while (data
.len
&& (data
.buf
[data
.len
- 1] == '\n' ||
327 data
.buf
[data
.len
- 1] == '\r'))
329 data
.buf
[data
.len
] = '\0';
331 if (!is_absolute_path(data
.buf
))
332 strbuf_addf(&path
, "%s/", gitdir
);
333 strbuf_addbuf(&path
, &data
);
334 strbuf_add_real_path(sb
, path
.buf
);
337 strbuf_addstr(sb
, gitdir
);
340 strbuf_release(&data
);
341 strbuf_release(&path
);
346 * Test if it looks like we're at a git directory.
349 * - either an objects/ directory _or_ the proper
350 * GIT_OBJECT_DIRECTORY environment variable
351 * - a refs/ directory
352 * - either a HEAD symlink or a HEAD file that is formatted as
353 * a proper "ref:", or a regular file HEAD that has a properly
354 * formatted sha1 object name.
356 int is_git_directory(const char *suspect
)
358 struct strbuf path
= STRBUF_INIT
;
362 /* Check worktree-related signatures */
363 strbuf_addstr(&path
, suspect
);
364 strbuf_complete(&path
, '/');
365 strbuf_addstr(&path
, "HEAD");
366 if (validate_headref(path
.buf
))
370 get_common_dir(&path
, suspect
);
373 /* Check non-worktree-related signatures */
374 if (getenv(DB_ENVIRONMENT
)) {
375 if (access(getenv(DB_ENVIRONMENT
), X_OK
))
379 strbuf_setlen(&path
, len
);
380 strbuf_addstr(&path
, "/objects");
381 if (access(path
.buf
, X_OK
))
385 strbuf_setlen(&path
, len
);
386 strbuf_addstr(&path
, "/refs");
387 if (access(path
.buf
, X_OK
))
392 strbuf_release(&path
);
396 int is_nonbare_repository_dir(struct strbuf
*path
)
400 size_t orig_path_len
= path
->len
;
401 assert(orig_path_len
!= 0);
402 strbuf_complete(path
, '/');
403 strbuf_addstr(path
, ".git");
404 if (read_gitfile_gently(path
->buf
, &gitfile_error
) || is_git_directory(path
->buf
))
406 if (gitfile_error
== READ_GITFILE_ERR_OPEN_FAILED
||
407 gitfile_error
== READ_GITFILE_ERR_READ_FAILED
)
409 strbuf_setlen(path
, orig_path_len
);
413 int is_inside_git_dir(void)
415 if (inside_git_dir
< 0)
416 inside_git_dir
= is_inside_dir(get_git_dir());
417 return inside_git_dir
;
420 int is_inside_work_tree(void)
422 if (inside_work_tree
< 0)
423 inside_work_tree
= is_inside_dir(get_git_work_tree());
424 return inside_work_tree
;
427 void setup_work_tree(void)
429 const char *work_tree
;
430 static int initialized
= 0;
435 if (work_tree_config_is_bogus
)
436 die(_("unable to set up work tree using invalid config"));
438 work_tree
= get_git_work_tree();
439 if (!work_tree
|| chdir_notify(work_tree
))
440 die(_("this operation must be run in a work tree"));
443 * Make sure subsequent git processes find correct worktree
444 * if $GIT_WORK_TREE is set relative
446 if (getenv(GIT_WORK_TREE_ENVIRONMENT
))
447 setenv(GIT_WORK_TREE_ENVIRONMENT
, ".", 1);
452 static void setup_original_cwd(void)
454 struct strbuf tmp
= STRBUF_INIT
;
455 const char *worktree
= NULL
;
458 if (!tmp_original_cwd
)
462 * startup_info->original_cwd points to the current working
463 * directory we inherited from our parent process, which is a
464 * directory we want to avoid removing.
466 * For convience, we would like to have the path relative to the
467 * worktree instead of an absolute path.
469 * Yes, startup_info->original_cwd is usually the same as 'prefix',
470 * but differs in two ways:
471 * - prefix has a trailing '/'
472 * - if the user passes '-C' to git, that modifies the prefix but
473 * not startup_info->original_cwd.
476 /* Normalize the directory */
477 if (!strbuf_realpath(&tmp
, tmp_original_cwd
, 0)) {
478 trace2_data_string("setup", the_repository
,
479 "realpath-path", tmp_original_cwd
);
480 trace2_data_string("setup", the_repository
,
481 "realpath-failure", strerror(errno
));
482 free((char*)tmp_original_cwd
);
483 tmp_original_cwd
= NULL
;
487 free((char*)tmp_original_cwd
);
488 tmp_original_cwd
= NULL
;
489 startup_info
->original_cwd
= strbuf_detach(&tmp
, NULL
);
492 * Get our worktree; we only protect the current working directory
493 * if it's in the worktree.
495 worktree
= get_git_work_tree();
497 goto no_prevention_needed
;
499 offset
= dir_inside_of(startup_info
->original_cwd
, worktree
);
502 * If startup_info->original_cwd == worktree, that is already
503 * protected and we don't need original_cwd as a secondary
504 * protection measure.
506 if (!*(startup_info
->original_cwd
+ offset
))
507 goto no_prevention_needed
;
510 * original_cwd was inside worktree; precompose it just as
511 * we do prefix so that built up paths will match
513 startup_info
->original_cwd
= \
514 precompose_string_if_needed(startup_info
->original_cwd
519 no_prevention_needed
:
520 free((char*)startup_info
->original_cwd
);
521 startup_info
->original_cwd
= NULL
;
524 static int read_worktree_config(const char *var
, const char *value
,
525 const struct config_context
*ctx UNUSED
,
528 struct repository_format
*data
= vdata
;
530 if (strcmp(var
, "core.bare") == 0) {
531 data
->is_bare
= git_config_bool(var
, value
);
532 } else if (strcmp(var
, "core.worktree") == 0) {
534 return config_error_nonbool(var
);
535 free(data
->work_tree
);
536 data
->work_tree
= xstrdup(value
);
541 enum extension_result
{
542 EXTENSION_ERROR
= -1, /* compatible with error(), etc */
543 EXTENSION_UNKNOWN
= 0,
548 * Do not add new extensions to this function. It handles extensions which are
549 * respected even in v0-format repositories for historical compatibility.
551 static enum extension_result
handle_extension_v0(const char *var
,
554 struct repository_format
*data
)
556 if (!strcmp(ext
, "noop")) {
558 } else if (!strcmp(ext
, "preciousobjects")) {
559 data
->precious_objects
= git_config_bool(var
, value
);
561 } else if (!strcmp(ext
, "partialclone")) {
563 return config_error_nonbool(var
);
564 data
->partial_clone
= xstrdup(value
);
566 } else if (!strcmp(ext
, "worktreeconfig")) {
567 data
->worktree_config
= git_config_bool(var
, value
);
571 return EXTENSION_UNKNOWN
;
575 * Record any new extensions in this function.
577 static enum extension_result
handle_extension(const char *var
,
580 struct repository_format
*data
)
582 if (!strcmp(ext
, "noop-v1")) {
584 } else if (!strcmp(ext
, "objectformat")) {
588 return config_error_nonbool(var
);
589 format
= hash_algo_by_name(value
);
590 if (format
== GIT_HASH_UNKNOWN
)
591 return error(_("invalid value for '%s': '%s'"),
592 "extensions.objectformat", value
);
593 data
->hash_algo
= format
;
595 } else if (!strcmp(ext
, "compatobjectformat")) {
596 struct string_list_item
*item
;
600 return config_error_nonbool(var
);
601 format
= hash_algo_by_name(value
);
602 if (format
== GIT_HASH_UNKNOWN
)
603 return error(_("invalid value for '%s': '%s'"),
604 "extensions.compatobjectformat", value
);
605 /* For now only support compatObjectFormat being specified once. */
606 for_each_string_list_item(item
, &data
->v1_only_extensions
) {
607 if (!strcmp(item
->string
, "compatobjectformat"))
608 return error(_("'%s' already specified as '%s'"),
609 "extensions.compatobjectformat",
610 hash_algos
[data
->compat_hash_algo
].name
);
612 data
->compat_hash_algo
= format
;
614 } else if (!strcmp(ext
, "refstorage")) {
618 return config_error_nonbool(var
);
619 format
= ref_storage_format_by_name(value
);
620 if (format
== REF_STORAGE_FORMAT_UNKNOWN
)
621 return error(_("invalid value for '%s': '%s'"),
622 "extensions.refstorage", value
);
623 data
->ref_storage_format
= format
;
626 return EXTENSION_UNKNOWN
;
629 static int check_repo_format(const char *var
, const char *value
,
630 const struct config_context
*ctx
, void *vdata
)
632 struct repository_format
*data
= vdata
;
635 if (strcmp(var
, "core.repositoryformatversion") == 0)
636 data
->version
= git_config_int(var
, value
, ctx
->kvi
);
637 else if (skip_prefix(var
, "extensions.", &ext
)) {
638 switch (handle_extension_v0(var
, value
, ext
, data
)) {
639 case EXTENSION_ERROR
:
643 case EXTENSION_UNKNOWN
:
647 switch (handle_extension(var
, value
, ext
, data
)) {
648 case EXTENSION_ERROR
:
651 string_list_append(&data
->v1_only_extensions
, ext
);
653 case EXTENSION_UNKNOWN
:
654 string_list_append(&data
->unknown_extensions
, ext
);
659 return read_worktree_config(var
, value
, ctx
, vdata
);
662 static int check_repository_format_gently(const char *gitdir
, struct repository_format
*candidate
, int *nongit_ok
)
664 struct strbuf sb
= STRBUF_INIT
;
665 struct strbuf err
= STRBUF_INIT
;
668 has_common
= get_common_dir(&sb
, gitdir
);
669 strbuf_addstr(&sb
, "/config");
670 read_repository_format(candidate
, sb
.buf
);
674 * For historical use of check_repository_format() in git-init,
675 * we treat a missing config as a silent "ok", even when nongit_ok
678 if (candidate
->version
< 0)
681 if (verify_repository_format(candidate
, &err
) < 0) {
683 warning("%s", err
.buf
);
684 strbuf_release(&err
);
691 repository_format_precious_objects
= candidate
->precious_objects
;
692 string_list_clear(&candidate
->unknown_extensions
, 0);
693 string_list_clear(&candidate
->v1_only_extensions
, 0);
695 if (candidate
->worktree_config
) {
697 * pick up core.bare and core.worktree from per-worktree
700 strbuf_addf(&sb
, "%s/config.worktree", gitdir
);
701 git_config_from_file(read_worktree_config
, sb
.buf
, candidate
);
707 if (candidate
->is_bare
!= -1) {
708 is_bare_repository_cfg
= candidate
->is_bare
;
709 if (is_bare_repository_cfg
== 1)
710 inside_work_tree
= -1;
712 if (candidate
->work_tree
) {
713 free(git_work_tree_cfg
);
714 git_work_tree_cfg
= xstrdup(candidate
->work_tree
);
715 inside_work_tree
= -1;
722 int upgrade_repository_format(int target_version
)
724 struct strbuf sb
= STRBUF_INIT
;
725 struct strbuf err
= STRBUF_INIT
;
726 struct strbuf repo_version
= STRBUF_INIT
;
727 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
730 strbuf_git_common_path(&sb
, the_repository
, "config");
731 read_repository_format(&repo_fmt
, sb
.buf
);
734 if (repo_fmt
.version
>= target_version
) {
739 if (verify_repository_format(&repo_fmt
, &err
) < 0) {
740 ret
= error("cannot upgrade repository format from %d to %d: %s",
741 repo_fmt
.version
, target_version
, err
.buf
);
744 if (!repo_fmt
.version
&& repo_fmt
.unknown_extensions
.nr
) {
745 ret
= error("cannot upgrade repository format: "
746 "unknown extension %s",
747 repo_fmt
.unknown_extensions
.items
[0].string
);
751 strbuf_addf(&repo_version
, "%d", target_version
);
752 git_config_set("core.repositoryformatversion", repo_version
.buf
);
757 clear_repository_format(&repo_fmt
);
758 strbuf_release(&repo_version
);
759 strbuf_release(&err
);
763 static void init_repository_format(struct repository_format
*format
)
765 const struct repository_format fresh
= REPOSITORY_FORMAT_INIT
;
767 memcpy(format
, &fresh
, sizeof(fresh
));
770 int read_repository_format(struct repository_format
*format
, const char *path
)
772 clear_repository_format(format
);
773 git_config_from_file(check_repo_format
, path
, format
);
774 if (format
->version
== -1)
775 clear_repository_format(format
);
776 return format
->version
;
779 void clear_repository_format(struct repository_format
*format
)
781 string_list_clear(&format
->unknown_extensions
, 0);
782 string_list_clear(&format
->v1_only_extensions
, 0);
783 free(format
->work_tree
);
784 free(format
->partial_clone
);
785 init_repository_format(format
);
788 int verify_repository_format(const struct repository_format
*format
,
791 if (GIT_REPO_VERSION_READ
< format
->version
) {
792 strbuf_addf(err
, _("Expected git repo version <= %d, found %d"),
793 GIT_REPO_VERSION_READ
, format
->version
);
797 if (format
->version
>= 1 && format
->unknown_extensions
.nr
) {
800 strbuf_addstr(err
, Q_("unknown repository extension found:",
801 "unknown repository extensions found:",
802 format
->unknown_extensions
.nr
));
804 for (i
= 0; i
< format
->unknown_extensions
.nr
; i
++)
805 strbuf_addf(err
, "\n\t%s",
806 format
->unknown_extensions
.items
[i
].string
);
810 if (format
->version
== 0 && format
->v1_only_extensions
.nr
) {
814 Q_("repo version is 0, but v1-only extension found:",
815 "repo version is 0, but v1-only extensions found:",
816 format
->v1_only_extensions
.nr
));
818 for (i
= 0; i
< format
->v1_only_extensions
.nr
; i
++)
819 strbuf_addf(err
, "\n\t%s",
820 format
->v1_only_extensions
.items
[i
].string
);
827 void read_gitfile_error_die(int error_code
, const char *path
, const char *dir
)
829 switch (error_code
) {
830 case READ_GITFILE_ERR_STAT_FAILED
:
831 case READ_GITFILE_ERR_NOT_A_FILE
:
832 /* non-fatal; follow return path */
834 case READ_GITFILE_ERR_OPEN_FAILED
:
835 die_errno(_("error opening '%s'"), path
);
836 case READ_GITFILE_ERR_TOO_LARGE
:
837 die(_("too large to be a .git file: '%s'"), path
);
838 case READ_GITFILE_ERR_READ_FAILED
:
839 die(_("error reading %s"), path
);
840 case READ_GITFILE_ERR_INVALID_FORMAT
:
841 die(_("invalid gitfile format: %s"), path
);
842 case READ_GITFILE_ERR_NO_PATH
:
843 die(_("no path in gitfile: %s"), path
);
844 case READ_GITFILE_ERR_NOT_A_REPO
:
845 die(_("not a git repository: %s"), dir
);
847 BUG("unknown error code");
852 * Try to read the location of the git directory from the .git file,
853 * return path to git directory if found. The return value comes from
856 * On failure, if return_error_code is not NULL, return_error_code
857 * will be set to an error code and NULL will be returned. If
858 * return_error_code is NULL the function will die instead (for most
861 const char *read_gitfile_gently(const char *path
, int *return_error_code
)
863 const int max_file_size
= 1 << 20; /* 1MB */
871 static struct strbuf realpath
= STRBUF_INIT
;
873 if (stat(path
, &st
)) {
874 /* NEEDSWORK: discern between ENOENT vs other errors */
875 error_code
= READ_GITFILE_ERR_STAT_FAILED
;
878 if (!S_ISREG(st
.st_mode
)) {
879 error_code
= READ_GITFILE_ERR_NOT_A_FILE
;
882 if (st
.st_size
> max_file_size
) {
883 error_code
= READ_GITFILE_ERR_TOO_LARGE
;
886 fd
= open(path
, O_RDONLY
);
888 error_code
= READ_GITFILE_ERR_OPEN_FAILED
;
891 buf
= xmallocz(st
.st_size
);
892 len
= read_in_full(fd
, buf
, st
.st_size
);
894 if (len
!= st
.st_size
) {
895 error_code
= READ_GITFILE_ERR_READ_FAILED
;
898 if (!starts_with(buf
, "gitdir: ")) {
899 error_code
= READ_GITFILE_ERR_INVALID_FORMAT
;
902 while (buf
[len
- 1] == '\n' || buf
[len
- 1] == '\r')
905 error_code
= READ_GITFILE_ERR_NO_PATH
;
911 if (!is_absolute_path(dir
) && (slash
= strrchr(path
, '/'))) {
912 size_t pathlen
= slash
+1 - path
;
913 dir
= xstrfmt("%.*s%.*s", (int)pathlen
, path
,
914 (int)(len
- 8), buf
+ 8);
918 if (!is_git_directory(dir
)) {
919 error_code
= READ_GITFILE_ERR_NOT_A_REPO
;
923 strbuf_realpath(&realpath
, dir
, 1);
927 if (return_error_code
)
928 *return_error_code
= error_code
;
930 read_gitfile_error_die(error_code
, path
, dir
);
933 return error_code
? NULL
: path
;
936 static const char *setup_explicit_git_dir(const char *gitdirenv
,
938 struct repository_format
*repo_fmt
,
941 const char *work_tree_env
= getenv(GIT_WORK_TREE_ENVIRONMENT
);
942 const char *worktree
;
946 if (PATH_MAX
- 40 < strlen(gitdirenv
))
947 die(_("'$%s' too big"), GIT_DIR_ENVIRONMENT
);
949 gitfile
= (char*)read_gitfile(gitdirenv
);
951 gitfile
= xstrdup(gitfile
);
955 if (!is_git_directory(gitdirenv
)) {
961 die(_("not a git repository: '%s'"), gitdirenv
);
964 if (check_repository_format_gently(gitdirenv
, repo_fmt
, nongit_ok
)) {
969 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
971 set_git_work_tree(work_tree_env
);
972 else if (is_bare_repository_cfg
> 0) {
973 if (git_work_tree_cfg
) {
975 warning("core.bare and core.worktree do not make sense");
976 work_tree_config_is_bogus
= 1;
980 set_git_dir(gitdirenv
, 0);
984 else if (git_work_tree_cfg
) { /* #6, #14 */
985 if (is_absolute_path(git_work_tree_cfg
))
986 set_git_work_tree(git_work_tree_cfg
);
989 if (chdir(gitdirenv
))
990 die_errno(_("cannot chdir to '%s'"), gitdirenv
);
991 if (chdir(git_work_tree_cfg
))
992 die_errno(_("cannot chdir to '%s'"), git_work_tree_cfg
);
993 core_worktree
= xgetcwd();
995 die_errno(_("cannot come back to cwd"));
996 set_git_work_tree(core_worktree
);
1000 else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, 1)) {
1002 set_git_dir(gitdirenv
, 0);
1007 set_git_work_tree(".");
1009 /* set_git_work_tree() must have been called by now */
1010 worktree
= get_git_work_tree();
1012 /* both get_git_work_tree() and cwd are already normalized */
1013 if (!strcmp(cwd
->buf
, worktree
)) { /* cwd == worktree */
1014 set_git_dir(gitdirenv
, 0);
1019 offset
= dir_inside_of(cwd
->buf
, worktree
);
1020 if (offset
>= 0) { /* cwd inside worktree? */
1021 set_git_dir(gitdirenv
, 1);
1022 if (chdir(worktree
))
1023 die_errno(_("cannot chdir to '%s'"), worktree
);
1024 strbuf_addch(cwd
, '/');
1026 return cwd
->buf
+ offset
;
1029 /* cwd outside worktree */
1030 set_git_dir(gitdirenv
, 0);
1035 static const char *setup_discovered_git_dir(const char *gitdir
,
1036 struct strbuf
*cwd
, int offset
,
1037 struct repository_format
*repo_fmt
,
1040 if (check_repository_format_gently(gitdir
, repo_fmt
, nongit_ok
))
1043 /* --work-tree is set without --git-dir; use discovered one */
1044 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
1045 char *to_free
= NULL
;
1048 if (offset
!= cwd
->len
&& !is_absolute_path(gitdir
))
1049 gitdir
= to_free
= real_pathdup(gitdir
, 1);
1050 if (chdir(cwd
->buf
))
1051 die_errno(_("cannot come back to cwd"));
1052 ret
= setup_explicit_git_dir(gitdir
, cwd
, repo_fmt
, nongit_ok
);
1057 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
1058 if (is_bare_repository_cfg
> 0) {
1059 set_git_dir(gitdir
, (offset
!= cwd
->len
));
1060 if (chdir(cwd
->buf
))
1061 die_errno(_("cannot come back to cwd"));
1065 /* #0, #1, #5, #8, #9, #12, #13 */
1066 set_git_work_tree(".");
1067 if (strcmp(gitdir
, DEFAULT_GIT_DIR_ENVIRONMENT
))
1068 set_git_dir(gitdir
, 0);
1070 inside_work_tree
= 1;
1071 if (offset
>= cwd
->len
)
1074 /* Make "offset" point past the '/' (already the case for root dirs) */
1075 if (offset
!= offset_1st_component(cwd
->buf
))
1077 /* Add a '/' at the end */
1078 strbuf_addch(cwd
, '/');
1079 return cwd
->buf
+ offset
;
1082 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
1083 static const char *setup_bare_git_dir(struct strbuf
*cwd
, int offset
,
1084 struct repository_format
*repo_fmt
,
1089 if (check_repository_format_gently(".", repo_fmt
, nongit_ok
))
1092 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, "0", 1);
1094 /* --work-tree is set without --git-dir; use discovered one */
1095 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
1096 static const char *gitdir
;
1098 gitdir
= offset
== cwd
->len
? "." : xmemdupz(cwd
->buf
, offset
);
1099 if (chdir(cwd
->buf
))
1100 die_errno(_("cannot come back to cwd"));
1101 return setup_explicit_git_dir(gitdir
, cwd
, repo_fmt
, nongit_ok
);
1105 inside_work_tree
= 0;
1106 if (offset
!= cwd
->len
) {
1107 if (chdir(cwd
->buf
))
1108 die_errno(_("cannot come back to cwd"));
1109 root_len
= offset_1st_component(cwd
->buf
);
1110 strbuf_setlen(cwd
, offset
> root_len
? offset
: root_len
);
1111 set_git_dir(cwd
->buf
, 0);
1114 set_git_dir(".", 0);
1118 static dev_t
get_device_or_die(const char *path
, const char *prefix
, int prefix_len
)
1121 if (stat(path
, &buf
)) {
1122 die_errno(_("failed to stat '%*s%s%s'"),
1124 prefix
? prefix
: "",
1125 prefix
? "/" : "", path
);
1131 * A "string_list_each_func_t" function that canonicalizes an entry
1132 * from GIT_CEILING_DIRECTORIES using real_pathdup(), or
1133 * discards it if unusable. The presence of an empty entry in
1134 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
1135 * subsequent entries.
1137 static int canonicalize_ceiling_entry(struct string_list_item
*item
,
1140 int *empty_entry_found
= cb_data
;
1141 char *ceil
= item
->string
;
1144 *empty_entry_found
= 1;
1146 } else if (!is_absolute_path(ceil
)) {
1148 } else if (*empty_entry_found
) {
1149 /* Keep entry but do not canonicalize it */
1152 char *real_path
= real_pathdup(ceil
, 0);
1157 item
->string
= real_path
;
1162 struct safe_directory_data
{
1167 static int safe_directory_cb(const char *key
, const char *value
,
1168 const struct config_context
*ctx UNUSED
, void *d
)
1170 struct safe_directory_data
*data
= d
;
1172 if (strcmp(key
, "safe.directory"))
1175 if (!value
|| !*value
) {
1177 } else if (!strcmp(value
, "*")) {
1180 char *interpolated
= NULL
;
1182 if (!git_config_pathname(&interpolated
, key
, value
) &&
1183 !fspathcmp(data
->path
, interpolated
? interpolated
: value
))
1193 * Check if a repository is safe, by verifying the ownership of the
1194 * worktree (if any), the git directory, and the gitfile (if any).
1196 * Exemptions for known-safe repositories can be added via `safe.directory`
1197 * config settings; for non-bare repositories, their worktree needs to be
1198 * added, for bare ones their git directory.
1200 static int ensure_valid_ownership(const char *gitfile
,
1201 const char *worktree
, const char *gitdir
,
1202 struct strbuf
*report
)
1204 struct safe_directory_data data
= {
1205 .path
= worktree
? worktree
: gitdir
1208 if (!git_env_bool("GIT_TEST_ASSUME_DIFFERENT_OWNER", 0) &&
1209 (!gitfile
|| is_path_owned_by_current_user(gitfile
, report
)) &&
1210 (!worktree
|| is_path_owned_by_current_user(worktree
, report
)) &&
1211 (!gitdir
|| is_path_owned_by_current_user(gitdir
, report
)))
1215 * data.path is the "path" that identifies the repository and it is
1216 * constant regardless of what failed above. data.is_safe should be
1217 * initialized to false, and might be changed by the callback.
1219 git_protected_config(safe_directory_cb
, &data
);
1221 return data
.is_safe
;
1224 void die_upon_dubious_ownership(const char *gitfile
, const char *worktree
,
1227 struct strbuf report
= STRBUF_INIT
, quoted
= STRBUF_INIT
;
1230 if (ensure_valid_ownership(gitfile
, worktree
, gitdir
, &report
))
1233 strbuf_complete(&report
, '\n');
1234 path
= gitfile
? gitfile
: gitdir
;
1235 sq_quote_buf_pretty("ed
, path
);
1237 die(_("detected dubious ownership in repository at '%s'\n"
1239 "To add an exception for this directory, call:\n"
1241 "\tgit config --global --add safe.directory %s"),
1242 path
, report
.buf
, quoted
.buf
);
1245 static int allowed_bare_repo_cb(const char *key
, const char *value
,
1246 const struct config_context
*ctx UNUSED
,
1249 enum allowed_bare_repo
*allowed_bare_repo
= d
;
1251 if (strcasecmp(key
, "safe.bareRepository"))
1254 if (!strcmp(value
, "explicit")) {
1255 *allowed_bare_repo
= ALLOWED_BARE_REPO_EXPLICIT
;
1258 if (!strcmp(value
, "all")) {
1259 *allowed_bare_repo
= ALLOWED_BARE_REPO_ALL
;
1265 static enum allowed_bare_repo
get_allowed_bare_repo(void)
1267 enum allowed_bare_repo result
= ALLOWED_BARE_REPO_ALL
;
1268 git_protected_config(allowed_bare_repo_cb
, &result
);
1272 static const char *allowed_bare_repo_to_string(
1273 enum allowed_bare_repo allowed_bare_repo
)
1275 switch (allowed_bare_repo
) {
1276 case ALLOWED_BARE_REPO_EXPLICIT
:
1278 case ALLOWED_BARE_REPO_ALL
:
1281 BUG("invalid allowed_bare_repo %d",
1287 static int is_implicit_bare_repo(const char *path
)
1290 * what we found is a ".git" directory at the root of
1293 if (ends_with_path_components(path
, ".git"))
1297 * we are inside $GIT_DIR of a secondary worktree of a
1298 * non-bare repository.
1300 if (strstr(path
, "/.git/worktrees/"))
1304 * we are inside $GIT_DIR of a worktree of a non-embedded
1305 * submodule, whose superproject is not a bare repository.
1307 if (strstr(path
, "/.git/modules/"))
1314 * We cannot decide in this function whether we are in the work tree or
1315 * not, since the config can only be read _after_ this function was called.
1317 * Also, we avoid changing any global state (such as the current working
1318 * directory) to allow early callers.
1320 * The directory where the search should start needs to be passed in via the
1321 * `dir` parameter; upon return, the `dir` buffer will contain the path of
1322 * the directory where the search ended, and `gitdir` will contain the path of
1323 * the discovered .git/ directory, if any. If `gitdir` is not absolute, it
1324 * is relative to `dir` (i.e. *not* necessarily the cwd).
1326 static enum discovery_result
setup_git_directory_gently_1(struct strbuf
*dir
,
1327 struct strbuf
*gitdir
,
1328 struct strbuf
*report
,
1331 const char *env_ceiling_dirs
= getenv(CEILING_DIRECTORIES_ENVIRONMENT
);
1332 struct string_list ceiling_dirs
= STRING_LIST_INIT_DUP
;
1333 const char *gitdirenv
;
1334 int ceil_offset
= -1, min_offset
= offset_1st_component(dir
->buf
);
1335 dev_t current_device
= 0;
1336 int one_filesystem
= 1;
1339 * If GIT_DIR is set explicitly, we're not going
1340 * to do any discovery, but we still do repository
1343 gitdirenv
= getenv(GIT_DIR_ENVIRONMENT
);
1345 strbuf_addstr(gitdir
, gitdirenv
);
1346 return GIT_DIR_EXPLICIT
;
1349 if (env_ceiling_dirs
) {
1350 int empty_entry_found
= 0;
1352 string_list_split(&ceiling_dirs
, env_ceiling_dirs
, PATH_SEP
, -1);
1353 filter_string_list(&ceiling_dirs
, 0,
1354 canonicalize_ceiling_entry
, &empty_entry_found
);
1355 ceil_offset
= longest_ancestor_length(dir
->buf
, &ceiling_dirs
);
1356 string_list_clear(&ceiling_dirs
, 0);
1359 if (ceil_offset
< 0)
1360 ceil_offset
= min_offset
- 2;
1362 if (min_offset
&& min_offset
== dir
->len
&&
1363 !is_dir_sep(dir
->buf
[min_offset
- 1])) {
1364 strbuf_addch(dir
, '/');
1369 * Test in the following order (relative to the dir):
1370 * - .git (file containing "gitdir: <path>")
1379 one_filesystem
= !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
1381 current_device
= get_device_or_die(dir
->buf
, NULL
, 0);
1383 int offset
= dir
->len
, error_code
= 0;
1384 char *gitdir_path
= NULL
;
1385 char *gitfile
= NULL
;
1387 if (offset
> min_offset
)
1388 strbuf_addch(dir
, '/');
1389 strbuf_addstr(dir
, DEFAULT_GIT_DIR_ENVIRONMENT
);
1390 gitdirenv
= read_gitfile_gently(dir
->buf
, die_on_error
?
1391 NULL
: &error_code
);
1394 error_code
== READ_GITFILE_ERR_NOT_A_FILE
) {
1395 /* NEEDSWORK: fail if .git is not file nor dir */
1396 if (is_git_directory(dir
->buf
)) {
1397 gitdirenv
= DEFAULT_GIT_DIR_ENVIRONMENT
;
1398 gitdir_path
= xstrdup(dir
->buf
);
1400 } else if (error_code
!= READ_GITFILE_ERR_STAT_FAILED
)
1401 return GIT_DIR_INVALID_GITFILE
;
1403 gitfile
= xstrdup(dir
->buf
);
1405 * Earlier, we tentatively added DEFAULT_GIT_DIR_ENVIRONMENT
1406 * to check that directory for a repository.
1407 * Now trim that tentative addition away, because we want to
1408 * focus on the real directory we are in.
1410 strbuf_setlen(dir
, offset
);
1412 enum discovery_result ret
;
1413 const char *gitdir_candidate
=
1414 gitdir_path
? gitdir_path
: gitdirenv
;
1416 if (ensure_valid_ownership(gitfile
, dir
->buf
,
1417 gitdir_candidate
, report
)) {
1418 strbuf_addstr(gitdir
, gitdirenv
);
1419 ret
= GIT_DIR_DISCOVERED
;
1421 ret
= GIT_DIR_INVALID_OWNERSHIP
;
1424 * Earlier, during discovery, we might have allocated
1425 * string copies for gitdir_path or gitfile so make
1426 * sure we don't leak by freeing them now, before
1427 * leaving the loop and function.
1429 * Note: gitdirenv will be non-NULL whenever these are
1430 * allocated, therefore we need not take care of releasing
1431 * them outside of this conditional block.
1439 if (is_git_directory(dir
->buf
)) {
1440 trace2_data_string("setup", NULL
, "implicit-bare-repository", dir
->buf
);
1441 if (get_allowed_bare_repo() == ALLOWED_BARE_REPO_EXPLICIT
&&
1442 !is_implicit_bare_repo(dir
->buf
))
1443 return GIT_DIR_DISALLOWED_BARE
;
1444 if (!ensure_valid_ownership(NULL
, NULL
, dir
->buf
, report
))
1445 return GIT_DIR_INVALID_OWNERSHIP
;
1446 strbuf_addstr(gitdir
, ".");
1447 return GIT_DIR_BARE
;
1450 if (offset
<= min_offset
)
1451 return GIT_DIR_HIT_CEILING
;
1453 while (--offset
> ceil_offset
&& !is_dir_sep(dir
->buf
[offset
]))
1455 if (offset
<= ceil_offset
)
1456 return GIT_DIR_HIT_CEILING
;
1458 strbuf_setlen(dir
, offset
> min_offset
? offset
: min_offset
);
1459 if (one_filesystem
&&
1460 current_device
!= get_device_or_die(dir
->buf
, NULL
, offset
))
1461 return GIT_DIR_HIT_MOUNT_POINT
;
1465 enum discovery_result
discover_git_directory_reason(struct strbuf
*commondir
,
1466 struct strbuf
*gitdir
)
1468 struct strbuf dir
= STRBUF_INIT
, err
= STRBUF_INIT
;
1469 size_t gitdir_offset
= gitdir
->len
, cwd_len
;
1470 size_t commondir_offset
= commondir
->len
;
1471 struct repository_format candidate
= REPOSITORY_FORMAT_INIT
;
1472 enum discovery_result result
;
1474 if (strbuf_getcwd(&dir
))
1475 return GIT_DIR_CWD_FAILURE
;
1478 result
= setup_git_directory_gently_1(&dir
, gitdir
, NULL
, 0);
1480 strbuf_release(&dir
);
1485 * The returned gitdir is relative to dir, and if dir does not reflect
1486 * the current working directory, we simply make the gitdir absolute.
1488 if (dir
.len
< cwd_len
&& !is_absolute_path(gitdir
->buf
+ gitdir_offset
)) {
1489 /* Avoid a trailing "/." */
1490 if (!strcmp(".", gitdir
->buf
+ gitdir_offset
))
1491 strbuf_setlen(gitdir
, gitdir_offset
);
1493 strbuf_addch(&dir
, '/');
1494 strbuf_insert(gitdir
, gitdir_offset
, dir
.buf
, dir
.len
);
1497 get_common_dir(commondir
, gitdir
->buf
+ gitdir_offset
);
1500 strbuf_addf(&dir
, "%s/config", commondir
->buf
+ commondir_offset
);
1501 read_repository_format(&candidate
, dir
.buf
);
1502 strbuf_release(&dir
);
1504 if (verify_repository_format(&candidate
, &err
) < 0) {
1505 warning("ignoring git dir '%s': %s",
1506 gitdir
->buf
+ gitdir_offset
, err
.buf
);
1507 strbuf_release(&err
);
1508 strbuf_setlen(commondir
, commondir_offset
);
1509 strbuf_setlen(gitdir
, gitdir_offset
);
1510 clear_repository_format(&candidate
);
1511 return GIT_DIR_INVALID_FORMAT
;
1514 clear_repository_format(&candidate
);
1518 const char *setup_git_directory_gently(int *nongit_ok
)
1520 static struct strbuf cwd
= STRBUF_INIT
;
1521 struct strbuf dir
= STRBUF_INIT
, gitdir
= STRBUF_INIT
, report
= STRBUF_INIT
;
1522 const char *prefix
= NULL
;
1523 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
1526 * We may have read an incomplete configuration before
1527 * setting-up the git directory. If so, clear the cache so
1528 * that the next queries to the configuration reload complete
1529 * configuration (including the per-repo config file that we
1530 * ignored previously).
1535 * Let's assume that we are in a git repository.
1536 * If it turns out later that we are somewhere else, the value will be
1537 * updated accordingly.
1542 if (strbuf_getcwd(&cwd
))
1543 die_errno(_("Unable to read current working directory"));
1544 strbuf_addbuf(&dir
, &cwd
);
1546 switch (setup_git_directory_gently_1(&dir
, &gitdir
, &report
, 1)) {
1547 case GIT_DIR_EXPLICIT
:
1548 prefix
= setup_explicit_git_dir(gitdir
.buf
, &cwd
, &repo_fmt
, nongit_ok
);
1550 case GIT_DIR_DISCOVERED
:
1551 if (dir
.len
< cwd
.len
&& chdir(dir
.buf
))
1552 die(_("cannot change to '%s'"), dir
.buf
);
1553 prefix
= setup_discovered_git_dir(gitdir
.buf
, &cwd
, dir
.len
,
1554 &repo_fmt
, nongit_ok
);
1557 if (dir
.len
< cwd
.len
&& chdir(dir
.buf
))
1558 die(_("cannot change to '%s'"), dir
.buf
);
1559 prefix
= setup_bare_git_dir(&cwd
, dir
.len
, &repo_fmt
, nongit_ok
);
1561 case GIT_DIR_HIT_CEILING
:
1563 die(_("not a git repository (or any of the parent directories): %s"),
1564 DEFAULT_GIT_DIR_ENVIRONMENT
);
1567 case GIT_DIR_HIT_MOUNT_POINT
:
1569 die(_("not a git repository (or any parent up to mount point %s)\n"
1570 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set)."),
1574 case GIT_DIR_INVALID_OWNERSHIP
:
1576 struct strbuf quoted
= STRBUF_INIT
;
1578 strbuf_complete(&report
, '\n');
1579 sq_quote_buf_pretty("ed
, dir
.buf
);
1580 die(_("detected dubious ownership in repository at '%s'\n"
1582 "To add an exception for this directory, call:\n"
1584 "\tgit config --global --add safe.directory %s"),
1585 dir
.buf
, report
.buf
, quoted
.buf
);
1589 case GIT_DIR_DISALLOWED_BARE
:
1591 die(_("cannot use bare repository '%s' (safe.bareRepository is '%s')"),
1593 allowed_bare_repo_to_string(get_allowed_bare_repo()));
1597 case GIT_DIR_CWD_FAILURE
:
1598 case GIT_DIR_INVALID_FORMAT
:
1600 * As a safeguard against setup_git_directory_gently_1 returning
1601 * these values, fallthrough to BUG. Otherwise it is possible to
1602 * set startup_info->have_repository to 1 when we did nothing to
1603 * find a repository.
1606 BUG("unhandled setup_git_directory_gently_1() result");
1610 * At this point, nongit_ok is stable. If it is non-NULL and points
1611 * to a non-zero value, then this means that we haven't found a
1612 * repository and that the caller expects startup_info to reflect
1615 * Regardless of the state of nongit_ok, startup_info->prefix and
1616 * the GIT_PREFIX environment variable must always match. For details
1617 * see Documentation/config/alias.txt.
1619 if (nongit_ok
&& *nongit_ok
)
1620 startup_info
->have_repository
= 0;
1622 startup_info
->have_repository
= 1;
1625 * Not all paths through the setup code will call 'set_git_dir()' (which
1626 * directly sets up the environment) so in order to guarantee that the
1627 * environment is in a consistent state after setup, explicitly setup
1628 * the environment if we have a repository.
1630 * NEEDSWORK: currently we allow bogus GIT_DIR values to be set in some
1631 * code paths so we also need to explicitly setup the environment if
1632 * the user has set GIT_DIR. It may be beneficial to disallow bogus
1633 * GIT_DIR values at some point in the future.
1635 if (/* GIT_DIR_EXPLICIT, GIT_DIR_DISCOVERED, GIT_DIR_BARE */
1636 startup_info
->have_repository
||
1637 /* GIT_DIR_EXPLICIT */
1638 getenv(GIT_DIR_ENVIRONMENT
)) {
1639 if (!the_repository
->gitdir
) {
1640 const char *gitdir
= getenv(GIT_DIR_ENVIRONMENT
);
1642 gitdir
= DEFAULT_GIT_DIR_ENVIRONMENT
;
1643 setup_git_env(gitdir
);
1645 if (startup_info
->have_repository
) {
1646 repo_set_hash_algo(the_repository
, repo_fmt
.hash_algo
);
1647 repo_set_compat_hash_algo(the_repository
,
1648 repo_fmt
.compat_hash_algo
);
1649 repo_set_ref_storage_format(the_repository
,
1650 repo_fmt
.ref_storage_format
);
1651 the_repository
->repository_format_worktree_config
=
1652 repo_fmt
.worktree_config
;
1653 /* take ownership of repo_fmt.partial_clone */
1654 the_repository
->repository_format_partial_clone
=
1655 repo_fmt
.partial_clone
;
1656 repo_fmt
.partial_clone
= NULL
;
1660 * Since precompose_string_if_needed() needs to look at
1661 * the core.precomposeunicode configuration, this
1662 * has to happen after the above block that finds
1663 * out where the repository is, i.e. a preparation
1664 * for calling git_config_get_bool().
1667 prefix
= precompose_string_if_needed(prefix
);
1668 startup_info
->prefix
= prefix
;
1669 setenv(GIT_PREFIX_ENVIRONMENT
, prefix
, 1);
1671 startup_info
->prefix
= NULL
;
1672 setenv(GIT_PREFIX_ENVIRONMENT
, "", 1);
1675 setup_original_cwd();
1677 strbuf_release(&dir
);
1678 strbuf_release(&gitdir
);
1679 strbuf_release(&report
);
1680 clear_repository_format(&repo_fmt
);
1685 int git_config_perm(const char *var
, const char *value
)
1693 if (!strcmp(value
, "umask"))
1695 if (!strcmp(value
, "group"))
1697 if (!strcmp(value
, "all") ||
1698 !strcmp(value
, "world") ||
1699 !strcmp(value
, "everybody"))
1700 return PERM_EVERYBODY
;
1702 /* Parse octal numbers */
1703 i
= strtol(value
, &endptr
, 8);
1705 /* If not an octal number, maybe true/false? */
1707 return git_config_bool(var
, value
) ? PERM_GROUP
: PERM_UMASK
;
1710 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
1711 * a chmod value to restrict to.
1714 case PERM_UMASK
: /* 0 */
1716 case OLD_PERM_GROUP
: /* 1 */
1718 case OLD_PERM_EVERYBODY
: /* 2 */
1719 return PERM_EVERYBODY
;
1722 /* A filemode value was given: 0xxx */
1724 if ((i
& 0600) != 0600)
1725 die(_("problem with core.sharedRepository filemode value "
1726 "(0%.3o).\nThe owner of files must always have "
1727 "read and write permissions."), i
);
1730 * Mask filemode value. Others can not get write permission.
1731 * x flags for directories are handled separately.
1736 void check_repository_format(struct repository_format
*fmt
)
1738 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
1741 check_repository_format_gently(get_git_dir(), fmt
, NULL
);
1742 startup_info
->have_repository
= 1;
1743 repo_set_hash_algo(the_repository
, fmt
->hash_algo
);
1744 repo_set_compat_hash_algo(the_repository
, fmt
->compat_hash_algo
);
1745 repo_set_ref_storage_format(the_repository
,
1746 fmt
->ref_storage_format
);
1747 the_repository
->repository_format_worktree_config
=
1748 fmt
->worktree_config
;
1749 the_repository
->repository_format_partial_clone
=
1750 xstrdup_or_null(fmt
->partial_clone
);
1751 clear_repository_format(&repo_fmt
);
1755 * Returns the "prefix", a path to the current working directory
1756 * relative to the work tree root, or NULL, if the current working
1757 * directory is not a strict subdirectory of the work tree root. The
1758 * prefix always ends with a '/' character.
1760 const char *setup_git_directory(void)
1762 return setup_git_directory_gently(NULL
);
1765 const char *resolve_gitdir_gently(const char *suspect
, int *return_error_code
)
1767 if (is_git_directory(suspect
))
1769 return read_gitfile_gently(suspect
, return_error_code
);
1772 /* if any standard file descriptor is missing open it to /dev/null */
1773 void sanitize_stdfds(void)
1775 int fd
= xopen("/dev/null", O_RDWR
);
1784 #ifdef NO_POSIX_GOODIES
1792 die_errno(_("fork failed"));
1797 die_errno(_("setsid failed"));
1806 struct template_dir_cb_data
{
1811 static int template_dir_cb(const char *key
, const char *value
,
1812 const struct config_context
*ctx
, void *d
)
1814 struct template_dir_cb_data
*data
= d
;
1816 if (strcmp(key
, "init.templatedir"))
1824 FREE_AND_NULL(data
->path
);
1825 if (!git_config_pathname(&path
, key
, value
))
1826 data
->path
= path
? path
: xstrdup(value
);
1832 const char *get_template_dir(const char *option_template
)
1834 const char *template_dir
= option_template
;
1837 template_dir
= getenv(TEMPLATE_DIR_ENVIRONMENT
);
1838 if (!template_dir
) {
1839 static struct template_dir_cb_data data
;
1841 if (!data
.initialized
) {
1842 git_protected_config(template_dir_cb
, &data
);
1843 data
.initialized
= 1;
1845 template_dir
= data
.path
;
1847 if (!template_dir
) {
1851 dir
= system_path(DEFAULT_GIT_TEMPLATE_DIR
);
1854 return template_dir
;
1857 #ifdef NO_TRUSTABLE_FILEMODE
1858 #define TEST_FILEMODE 0
1860 #define TEST_FILEMODE 1
1863 #define GIT_DEFAULT_HASH_ENVIRONMENT "GIT_DEFAULT_HASH"
1865 static void copy_templates_1(struct strbuf
*path
, struct strbuf
*template_path
,
1868 size_t path_baselen
= path
->len
;
1869 size_t template_baselen
= template_path
->len
;
1872 /* Note: if ".git/hooks" file exists in the repository being
1873 * re-initialized, /etc/core-git/templates/hooks/update would
1874 * cause "git init" to fail here. I think this is sane but
1875 * it means that the set of templates we ship by default, along
1876 * with the way the namespace under .git/ is organized, should
1877 * be really carefully chosen.
1879 safe_create_dir(path
->buf
, 1);
1880 while ((de
= readdir(dir
)) != NULL
) {
1881 struct stat st_git
, st_template
;
1884 strbuf_setlen(path
, path_baselen
);
1885 strbuf_setlen(template_path
, template_baselen
);
1887 if (de
->d_name
[0] == '.')
1889 strbuf_addstr(path
, de
->d_name
);
1890 strbuf_addstr(template_path
, de
->d_name
);
1891 if (lstat(path
->buf
, &st_git
)) {
1892 if (errno
!= ENOENT
)
1893 die_errno(_("cannot stat '%s'"), path
->buf
);
1898 if (lstat(template_path
->buf
, &st_template
))
1899 die_errno(_("cannot stat template '%s'"), template_path
->buf
);
1901 if (S_ISDIR(st_template
.st_mode
)) {
1902 DIR *subdir
= opendir(template_path
->buf
);
1904 die_errno(_("cannot opendir '%s'"), template_path
->buf
);
1905 strbuf_addch(path
, '/');
1906 strbuf_addch(template_path
, '/');
1907 copy_templates_1(path
, template_path
, subdir
);
1912 else if (S_ISLNK(st_template
.st_mode
)) {
1913 struct strbuf lnk
= STRBUF_INIT
;
1914 if (strbuf_readlink(&lnk
, template_path
->buf
,
1915 st_template
.st_size
) < 0)
1916 die_errno(_("cannot readlink '%s'"), template_path
->buf
);
1917 if (symlink(lnk
.buf
, path
->buf
))
1918 die_errno(_("cannot symlink '%s' '%s'"),
1919 lnk
.buf
, path
->buf
);
1920 strbuf_release(&lnk
);
1922 else if (S_ISREG(st_template
.st_mode
)) {
1923 if (copy_file(path
->buf
, template_path
->buf
, st_template
.st_mode
))
1924 die_errno(_("cannot copy '%s' to '%s'"),
1925 template_path
->buf
, path
->buf
);
1928 error(_("ignoring template %s"), template_path
->buf
);
1932 static void copy_templates(const char *option_template
)
1934 const char *template_dir
= get_template_dir(option_template
);
1935 struct strbuf path
= STRBUF_INIT
;
1936 struct strbuf template_path
= STRBUF_INIT
;
1937 size_t template_len
;
1938 struct repository_format template_format
= REPOSITORY_FORMAT_INIT
;
1939 struct strbuf err
= STRBUF_INIT
;
1941 char *to_free
= NULL
;
1943 if (!template_dir
|| !*template_dir
)
1946 strbuf_addstr(&template_path
, template_dir
);
1947 strbuf_complete(&template_path
, '/');
1948 template_len
= template_path
.len
;
1950 dir
= opendir(template_path
.buf
);
1952 warning(_("templates not found in %s"), template_dir
);
1956 /* Make sure that template is from the correct vintage */
1957 strbuf_addstr(&template_path
, "config");
1958 read_repository_format(&template_format
, template_path
.buf
);
1959 strbuf_setlen(&template_path
, template_len
);
1962 * No mention of version at all is OK, but anything else should be
1965 if (template_format
.version
>= 0 &&
1966 verify_repository_format(&template_format
, &err
) < 0) {
1967 warning(_("not copying templates from '%s': %s"),
1968 template_dir
, err
.buf
);
1969 strbuf_release(&err
);
1970 goto close_free_return
;
1973 strbuf_addstr(&path
, get_git_common_dir());
1974 strbuf_complete(&path
, '/');
1975 copy_templates_1(&path
, &template_path
, dir
);
1980 strbuf_release(&path
);
1981 strbuf_release(&template_path
);
1982 clear_repository_format(&template_format
);
1986 * If the git_dir is not directly inside the working tree, then git will not
1987 * find it by default, and we need to set the worktree explicitly.
1989 static int needs_work_tree_config(const char *git_dir
, const char *work_tree
)
1991 if (!strcmp(work_tree
, "/") && !strcmp(git_dir
, "/.git"))
1993 if (skip_prefix(git_dir
, work_tree
, &git_dir
) &&
1994 !strcmp(git_dir
, "/.git"))
1999 void initialize_repository_version(int hash_algo
,
2000 unsigned int ref_storage_format
,
2003 char repo_version_string
[10];
2004 int repo_version
= GIT_REPO_VERSION
;
2007 * Note that we initialize the repository version to 1 when the ref
2008 * storage format is unknown. This is on purpose so that we can add the
2009 * correct object format to the config during git-clone(1). The format
2010 * version will get adjusted by git-clone(1) once it has learned about
2011 * the remote repository's format.
2013 if (hash_algo
!= GIT_HASH_SHA1
||
2014 ref_storage_format
!= REF_STORAGE_FORMAT_FILES
)
2015 repo_version
= GIT_REPO_VERSION_READ
;
2017 /* This forces creation of new config file */
2018 xsnprintf(repo_version_string
, sizeof(repo_version_string
),
2019 "%d", repo_version
);
2020 git_config_set("core.repositoryformatversion", repo_version_string
);
2022 if (hash_algo
!= GIT_HASH_SHA1
&& hash_algo
!= GIT_HASH_UNKNOWN
)
2023 git_config_set("extensions.objectformat",
2024 hash_algos
[hash_algo
].name
);
2026 git_config_set_gently("extensions.objectformat", NULL
);
2028 if (ref_storage_format
!= REF_STORAGE_FORMAT_FILES
)
2029 git_config_set("extensions.refstorage",
2030 ref_storage_format_to_name(ref_storage_format
));
2033 static int is_reinit(void)
2035 struct strbuf buf
= STRBUF_INIT
;
2039 git_path_buf(&buf
, "HEAD");
2040 ret
= !access(buf
.buf
, R_OK
) || readlink(buf
.buf
, junk
, sizeof(junk
) - 1) != -1;
2041 strbuf_release(&buf
);
2045 void create_reference_database(unsigned int ref_storage_format
,
2046 const char *initial_branch
, int quiet
)
2048 struct strbuf err
= STRBUF_INIT
;
2049 int reinit
= is_reinit();
2051 repo_set_ref_storage_format(the_repository
, ref_storage_format
);
2052 if (refs_init_db(get_main_ref_store(the_repository
), 0, &err
))
2053 die("failed to set up refs db: %s", err
.buf
);
2056 * Point the HEAD symref to the initial branch with if HEAD does
2062 if (!initial_branch
)
2063 initial_branch
= git_default_branch_name(quiet
);
2065 ref
= xstrfmt("refs/heads/%s", initial_branch
);
2066 if (check_refname_format(ref
, 0) < 0)
2067 die(_("invalid initial branch name: '%s'"),
2070 if (refs_update_symref(get_main_ref_store(the_repository
), "HEAD", ref
, NULL
) < 0)
2075 if (reinit
&& initial_branch
)
2076 warning(_("re-init: ignored --initial-branch=%s"),
2079 strbuf_release(&err
);
2082 static int create_default_files(const char *template_path
,
2083 const char *original_git_dir
,
2084 const struct repository_format
*fmt
,
2085 int init_shared_repository
)
2088 struct strbuf buf
= STRBUF_INIT
;
2092 const char *work_tree
= get_git_work_tree();
2095 * First copy the templates -- we might have the default
2096 * config file there, in which case we would want to read
2097 * from it after installing.
2099 * Before reading that config, we also need to clear out any cached
2100 * values (since we've just potentially changed what's available on
2103 copy_templates(template_path
);
2105 reset_shared_repository();
2106 git_config(git_default_config
, NULL
);
2108 reinit
= is_reinit();
2111 * We must make sure command-line options continue to override any
2112 * values we might have just re-read from the config.
2114 if (init_shared_repository
!= -1)
2115 set_shared_repository(init_shared_repository
);
2117 is_bare_repository_cfg
= !work_tree
;
2120 * We would have created the above under user's umask -- under
2121 * shared-repository settings, we would need to fix them up.
2123 if (get_shared_repository()) {
2124 adjust_shared_perm(get_git_dir());
2127 initialize_repository_version(fmt
->hash_algo
, fmt
->ref_storage_format
, 0);
2129 /* Check filemode trustability */
2130 path
= git_path_buf(&buf
, "config");
2131 filemode
= TEST_FILEMODE
;
2132 if (TEST_FILEMODE
&& !lstat(path
, &st1
)) {
2134 filemode
= (!chmod(path
, st1
.st_mode
^ S_IXUSR
) &&
2135 !lstat(path
, &st2
) &&
2136 st1
.st_mode
!= st2
.st_mode
&&
2137 !chmod(path
, st1
.st_mode
));
2138 if (filemode
&& !reinit
&& (st1
.st_mode
& S_IXUSR
))
2141 git_config_set("core.filemode", filemode
? "true" : "false");
2143 if (is_bare_repository())
2144 git_config_set("core.bare", "true");
2146 git_config_set("core.bare", "false");
2147 /* allow template config file to override the default */
2148 if (log_all_ref_updates
== LOG_REFS_UNSET
)
2149 git_config_set("core.logallrefupdates", "true");
2150 if (needs_work_tree_config(original_git_dir
, work_tree
))
2151 git_config_set("core.worktree", work_tree
);
2155 /* Check if symlink is supported in the work tree */
2156 path
= git_path_buf(&buf
, "tXXXXXX");
2157 if (!close(xmkstemp(path
)) &&
2159 !symlink("testing", path
) &&
2160 !lstat(path
, &st1
) &&
2161 S_ISLNK(st1
.st_mode
))
2162 unlink(path
); /* good */
2164 git_config_set("core.symlinks", "false");
2166 /* Check if the filesystem is case-insensitive */
2167 path
= git_path_buf(&buf
, "CoNfIg");
2168 if (!access(path
, F_OK
))
2169 git_config_set("core.ignorecase", "true");
2170 probe_utf8_pathname_composition();
2173 strbuf_release(&buf
);
2177 static void create_object_directory(void)
2179 struct strbuf path
= STRBUF_INIT
;
2182 strbuf_addstr(&path
, get_object_directory());
2185 safe_create_dir(path
.buf
, 1);
2187 strbuf_setlen(&path
, baselen
);
2188 strbuf_addstr(&path
, "/pack");
2189 safe_create_dir(path
.buf
, 1);
2191 strbuf_setlen(&path
, baselen
);
2192 strbuf_addstr(&path
, "/info");
2193 safe_create_dir(path
.buf
, 1);
2195 strbuf_release(&path
);
2198 static void separate_git_dir(const char *git_dir
, const char *git_link
)
2202 if (!stat(git_link
, &st
)) {
2205 if (S_ISREG(st
.st_mode
))
2206 src
= read_gitfile(git_link
);
2207 else if (S_ISDIR(st
.st_mode
))
2210 die(_("unable to handle file type %d"), (int)st
.st_mode
);
2212 if (rename(src
, git_dir
))
2213 die_errno(_("unable to move %s to %s"), src
, git_dir
);
2214 repair_worktrees(NULL
, NULL
);
2217 write_file(git_link
, "gitdir: %s", git_dir
);
2220 static void validate_hash_algorithm(struct repository_format
*repo_fmt
, int hash
)
2222 const char *env
= getenv(GIT_DEFAULT_HASH_ENVIRONMENT
);
2224 * If we already have an initialized repo, don't allow the user to
2225 * specify a different algorithm, as that could cause corruption.
2226 * Otherwise, if the user has specified one on the command line, use it.
2228 if (repo_fmt
->version
>= 0 && hash
!= GIT_HASH_UNKNOWN
&& hash
!= repo_fmt
->hash_algo
)
2229 die(_("attempt to reinitialize repository with different hash"));
2230 else if (hash
!= GIT_HASH_UNKNOWN
)
2231 repo_fmt
->hash_algo
= hash
;
2233 int env_algo
= hash_algo_by_name(env
);
2234 if (env_algo
== GIT_HASH_UNKNOWN
)
2235 die(_("unknown hash algorithm '%s'"), env
);
2236 repo_fmt
->hash_algo
= env_algo
;
2240 static void validate_ref_storage_format(struct repository_format
*repo_fmt
,
2241 unsigned int format
)
2243 const char *name
= getenv("GIT_DEFAULT_REF_FORMAT");
2245 if (repo_fmt
->version
>= 0 &&
2246 format
!= REF_STORAGE_FORMAT_UNKNOWN
&&
2247 format
!= repo_fmt
->ref_storage_format
) {
2248 die(_("attempt to reinitialize repository with different reference storage format"));
2249 } else if (format
!= REF_STORAGE_FORMAT_UNKNOWN
) {
2250 repo_fmt
->ref_storage_format
= format
;
2252 format
= ref_storage_format_by_name(name
);
2253 if (format
== REF_STORAGE_FORMAT_UNKNOWN
)
2254 die(_("unknown ref storage format '%s'"), name
);
2255 repo_fmt
->ref_storage_format
= format
;
2259 int init_db(const char *git_dir
, const char *real_git_dir
,
2260 const char *template_dir
, int hash
,
2261 unsigned int ref_storage_format
,
2262 const char *initial_branch
,
2263 int init_shared_repository
, unsigned int flags
)
2266 int exist_ok
= flags
& INIT_DB_EXIST_OK
;
2267 char *original_git_dir
= real_pathdup(git_dir
, 1);
2268 struct repository_format repo_fmt
= REPOSITORY_FORMAT_INIT
;
2273 if (!exist_ok
&& !stat(git_dir
, &st
))
2274 die(_("%s already exists"), git_dir
);
2276 if (!exist_ok
&& !stat(real_git_dir
, &st
))
2277 die(_("%s already exists"), real_git_dir
);
2279 set_git_dir(real_git_dir
, 1);
2280 git_dir
= get_git_dir();
2281 separate_git_dir(git_dir
, original_git_dir
);
2284 set_git_dir(git_dir
, 1);
2285 git_dir
= get_git_dir();
2287 startup_info
->have_repository
= 1;
2289 /* Ensure `core.hidedotfiles` is processed */
2290 git_config(platform_core_config
, NULL
);
2292 safe_create_dir(git_dir
, 0);
2295 /* Check to see if the repository version is right.
2296 * Note that a newly created repository does not have
2297 * config file, so this will not fail. What we are catching
2298 * is an attempt to reinitialize new repository with an old tool.
2300 check_repository_format(&repo_fmt
);
2302 validate_hash_algorithm(&repo_fmt
, hash
);
2303 validate_ref_storage_format(&repo_fmt
, ref_storage_format
);
2305 reinit
= create_default_files(template_dir
, original_git_dir
,
2306 &repo_fmt
, init_shared_repository
);
2309 * Now that we have set up both the hash algorithm and the ref storage
2310 * format we can update the repository's settings accordingly.
2312 repo_set_hash_algo(the_repository
, repo_fmt
.hash_algo
);
2313 repo_set_ref_storage_format(the_repository
, repo_fmt
.ref_storage_format
);
2315 if (!(flags
& INIT_DB_SKIP_REFDB
))
2316 create_reference_database(repo_fmt
.ref_storage_format
,
2317 initial_branch
, flags
& INIT_DB_QUIET
);
2318 create_object_directory();
2320 if (get_shared_repository()) {
2322 /* We do not spell "group" and such, so that
2323 * the configuration can be read by older version
2324 * of git. Note, we use octal numbers for new share modes,
2325 * and compatibility values for PERM_GROUP and
2328 if (get_shared_repository() < 0)
2329 /* force to the mode value */
2330 xsnprintf(buf
, sizeof(buf
), "0%o", -get_shared_repository());
2331 else if (get_shared_repository() == PERM_GROUP
)
2332 xsnprintf(buf
, sizeof(buf
), "%d", OLD_PERM_GROUP
);
2333 else if (get_shared_repository() == PERM_EVERYBODY
)
2334 xsnprintf(buf
, sizeof(buf
), "%d", OLD_PERM_EVERYBODY
);
2336 BUG("invalid value for shared_repository");
2337 git_config_set("core.sharedrepository", buf
);
2338 git_config_set("receive.denyNonFastforwards", "true");
2341 if (!(flags
& INIT_DB_QUIET
)) {
2342 int len
= strlen(git_dir
);
2345 printf(get_shared_repository()
2346 ? _("Reinitialized existing shared Git repository in %s%s\n")
2347 : _("Reinitialized existing Git repository in %s%s\n"),
2348 git_dir
, len
&& git_dir
[len
-1] != '/' ? "/" : "");
2350 printf(get_shared_repository()
2351 ? _("Initialized empty shared Git repository in %s%s\n")
2352 : _("Initialized empty Git repository in %s%s\n"),
2353 git_dir
, len
&& git_dir
[len
-1] != '/' ? "/" : "");
2356 clear_repository_format(&repo_fmt
);
2357 free(original_git_dir
);