The eighth batch
[git.git] / setup.c
blobc04cd25a30dfe0e97d93087c0e7f29910d1b46a5
1 #include "cache.h"
2 #include "repository.h"
3 #include "config.h"
4 #include "dir.h"
5 #include "string-list.h"
6 #include "chdir-notify.h"
7 #include "promisor-remote.h"
9 static int inside_git_dir = -1;
10 static int inside_work_tree = -1;
11 static int work_tree_config_is_bogus;
13 static struct startup_info the_startup_info;
14 struct startup_info *startup_info = &the_startup_info;
17 * The input parameter must contain an absolute path, and it must already be
18 * normalized.
20 * Find the part of an absolute path that lies inside the work tree by
21 * dereferencing symlinks outside the work tree, for example:
22 * /dir1/repo/dir2/file (work tree is /dir1/repo) -> dir2/file
23 * /dir/file (work tree is /) -> dir/file
24 * /dir/symlink1/symlink2 (symlink1 points to work tree) -> symlink2
25 * /dir/repolink/file (repolink points to /dir/repo) -> file
26 * /dir/repo (exactly equal to work tree) -> (empty string)
28 static int abspath_part_inside_repo(char *path)
30 size_t len;
31 size_t wtlen;
32 char *path0;
33 int off;
34 const char *work_tree = get_git_work_tree();
35 struct strbuf realpath = STRBUF_INIT;
37 if (!work_tree)
38 return -1;
39 wtlen = strlen(work_tree);
40 len = strlen(path);
41 off = offset_1st_component(path);
43 /* check if work tree is already the prefix */
44 if (wtlen <= len && !fspathncmp(path, work_tree, wtlen)) {
45 if (path[wtlen] == '/') {
46 memmove(path, path + wtlen + 1, len - wtlen);
47 return 0;
48 } else if (path[wtlen - 1] == '/' || path[wtlen] == '\0') {
49 /* work tree is the root, or the whole path */
50 memmove(path, path + wtlen, len - wtlen + 1);
51 return 0;
53 /* work tree might match beginning of a symlink to work tree */
54 off = wtlen;
56 path0 = path;
57 path += off;
59 /* check each '/'-terminated level */
60 while (*path) {
61 path++;
62 if (*path == '/') {
63 *path = '\0';
64 strbuf_realpath(&realpath, path0, 1);
65 if (fspathcmp(realpath.buf, work_tree) == 0) {
66 memmove(path0, path + 1, len - (path - path0));
67 strbuf_release(&realpath);
68 return 0;
70 *path = '/';
74 /* check whole path */
75 strbuf_realpath(&realpath, path0, 1);
76 if (fspathcmp(realpath.buf, work_tree) == 0) {
77 *path0 = '\0';
78 strbuf_release(&realpath);
79 return 0;
82 strbuf_release(&realpath);
83 return -1;
87 * Normalize "path", prepending the "prefix" for relative paths. If
88 * remaining_prefix is not NULL, return the actual prefix still
89 * remains in the path. For example, prefix = sub1/sub2/ and path is
91 * foo -> sub1/sub2/foo (full prefix)
92 * ../foo -> sub1/foo (remaining prefix is sub1/)
93 * ../../bar -> bar (no remaining prefix)
94 * ../../sub1/sub2/foo -> sub1/sub2/foo (but no remaining prefix)
95 * `pwd`/../bar -> sub1/bar (no remaining prefix)
97 char *prefix_path_gently(const char *prefix, int len,
98 int *remaining_prefix, const char *path)
100 const char *orig = path;
101 char *sanitized;
102 if (is_absolute_path(orig)) {
103 sanitized = xmallocz(strlen(path));
104 if (remaining_prefix)
105 *remaining_prefix = 0;
106 if (normalize_path_copy_len(sanitized, path, remaining_prefix)) {
107 free(sanitized);
108 return NULL;
110 if (abspath_part_inside_repo(sanitized)) {
111 free(sanitized);
112 return NULL;
114 } else {
115 sanitized = xstrfmt("%.*s%s", len, len ? prefix : "", path);
116 if (remaining_prefix)
117 *remaining_prefix = len;
118 if (normalize_path_copy_len(sanitized, sanitized, remaining_prefix)) {
119 free(sanitized);
120 return NULL;
123 return sanitized;
126 char *prefix_path(const char *prefix, int len, const char *path)
128 char *r = prefix_path_gently(prefix, len, NULL, path);
129 if (!r) {
130 const char *hint_path = get_git_work_tree();
131 if (!hint_path)
132 hint_path = get_git_dir();
133 die(_("'%s' is outside repository at '%s'"), path,
134 absolute_path(hint_path));
136 return r;
139 int path_inside_repo(const char *prefix, const char *path)
141 int len = prefix ? strlen(prefix) : 0;
142 char *r = prefix_path_gently(prefix, len, NULL, path);
143 if (r) {
144 free(r);
145 return 1;
147 return 0;
150 int check_filename(const char *prefix, const char *arg)
152 char *to_free = NULL;
153 struct stat st;
155 if (skip_prefix(arg, ":/", &arg)) {
156 if (!*arg) /* ":/" is root dir, always exists */
157 return 1;
158 prefix = NULL;
159 } else if (skip_prefix(arg, ":!", &arg) ||
160 skip_prefix(arg, ":^", &arg)) {
161 if (!*arg) /* excluding everything is silly, but allowed */
162 return 1;
165 if (prefix)
166 arg = to_free = prefix_filename(prefix, arg);
168 if (!lstat(arg, &st)) {
169 free(to_free);
170 return 1; /* file exists */
172 if (is_missing_file_error(errno)) {
173 free(to_free);
174 return 0; /* file does not exist */
176 die_errno(_("failed to stat '%s'"), arg);
179 static void NORETURN die_verify_filename(struct repository *r,
180 const char *prefix,
181 const char *arg,
182 int diagnose_misspelt_rev)
184 if (!diagnose_misspelt_rev)
185 die(_("%s: no such path in the working tree.\n"
186 "Use 'git <command> -- <path>...' to specify paths that do not exist locally."),
187 arg);
189 * Saying "'(icase)foo' does not exist in the index" when the
190 * user gave us ":(icase)foo" is just stupid. A magic pathspec
191 * begins with a colon and is followed by a non-alnum; do not
192 * let maybe_die_on_misspelt_object_name() even trigger.
194 if (!(arg[0] == ':' && !isalnum(arg[1])))
195 maybe_die_on_misspelt_object_name(r, arg, prefix);
197 /* ... or fall back the most general message. */
198 die(_("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
199 "Use '--' to separate paths from revisions, like this:\n"
200 "'git <command> [<revision>...] -- [<file>...]'"), arg);
205 * Check for arguments that don't resolve as actual files,
206 * but which look sufficiently like pathspecs that we'll consider
207 * them such for the purposes of rev/pathspec DWIM parsing.
209 static int looks_like_pathspec(const char *arg)
211 const char *p;
212 int escaped = 0;
215 * Wildcard characters imply the user is looking to match pathspecs
216 * that aren't in the filesystem. Note that this doesn't include
217 * backslash even though it's a glob special; by itself it doesn't
218 * cause any increase in the match. Likewise ignore backslash-escaped
219 * wildcard characters.
221 for (p = arg; *p; p++) {
222 if (escaped) {
223 escaped = 0;
224 } else if (is_glob_special(*p)) {
225 if (*p == '\\')
226 escaped = 1;
227 else
228 return 1;
232 /* long-form pathspec magic */
233 if (starts_with(arg, ":("))
234 return 1;
236 return 0;
240 * Verify a filename that we got as an argument for a pathspec
241 * entry. Note that a filename that begins with "-" never verifies
242 * as true, because even if such a filename were to exist, we want
243 * it to be preceded by the "--" marker (or we want the user to
244 * use a format like "./-filename")
246 * The "diagnose_misspelt_rev" is used to provide a user-friendly
247 * diagnosis when dying upon finding that "name" is not a pathname.
248 * If set to 1, the diagnosis will try to diagnose "name" as an
249 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
250 * will only complain about an inexisting file.
252 * This function is typically called to check that a "file or rev"
253 * argument is unambiguous. In this case, the caller will want
254 * diagnose_misspelt_rev == 1 when verifying the first non-rev
255 * argument (which could have been a revision), and
256 * diagnose_misspelt_rev == 0 for the next ones (because we already
257 * saw a filename, there's not ambiguity anymore).
259 void verify_filename(const char *prefix,
260 const char *arg,
261 int diagnose_misspelt_rev)
263 if (*arg == '-')
264 die(_("option '%s' must come before non-option arguments"), arg);
265 if (looks_like_pathspec(arg) || check_filename(prefix, arg))
266 return;
267 die_verify_filename(the_repository, prefix, arg, diagnose_misspelt_rev);
271 * Opposite of the above: the command line did not have -- marker
272 * and we parsed the arg as a refname. It should not be interpretable
273 * as a filename.
275 void verify_non_filename(const char *prefix, const char *arg)
277 if (!is_inside_work_tree() || is_inside_git_dir())
278 return;
279 if (*arg == '-')
280 return; /* flag */
281 if (!check_filename(prefix, arg))
282 return;
283 die(_("ambiguous argument '%s': both revision and filename\n"
284 "Use '--' to separate paths from revisions, like this:\n"
285 "'git <command> [<revision>...] -- [<file>...]'"), arg);
288 int get_common_dir(struct strbuf *sb, const char *gitdir)
290 const char *git_env_common_dir = getenv(GIT_COMMON_DIR_ENVIRONMENT);
291 if (git_env_common_dir) {
292 strbuf_addstr(sb, git_env_common_dir);
293 return 1;
294 } else {
295 return get_common_dir_noenv(sb, gitdir);
299 int get_common_dir_noenv(struct strbuf *sb, const char *gitdir)
301 struct strbuf data = STRBUF_INIT;
302 struct strbuf path = STRBUF_INIT;
303 int ret = 0;
305 strbuf_addf(&path, "%s/commondir", gitdir);
306 if (file_exists(path.buf)) {
307 if (strbuf_read_file(&data, path.buf, 0) <= 0)
308 die_errno(_("failed to read %s"), path.buf);
309 while (data.len && (data.buf[data.len - 1] == '\n' ||
310 data.buf[data.len - 1] == '\r'))
311 data.len--;
312 data.buf[data.len] = '\0';
313 strbuf_reset(&path);
314 if (!is_absolute_path(data.buf))
315 strbuf_addf(&path, "%s/", gitdir);
316 strbuf_addbuf(&path, &data);
317 strbuf_add_real_path(sb, path.buf);
318 ret = 1;
319 } else {
320 strbuf_addstr(sb, gitdir);
323 strbuf_release(&data);
324 strbuf_release(&path);
325 return ret;
329 * Test if it looks like we're at a git directory.
330 * We want to see:
332 * - either an objects/ directory _or_ the proper
333 * GIT_OBJECT_DIRECTORY environment variable
334 * - a refs/ directory
335 * - either a HEAD symlink or a HEAD file that is formatted as
336 * a proper "ref:", or a regular file HEAD that has a properly
337 * formatted sha1 object name.
339 int is_git_directory(const char *suspect)
341 struct strbuf path = STRBUF_INIT;
342 int ret = 0;
343 size_t len;
345 /* Check worktree-related signatures */
346 strbuf_addstr(&path, suspect);
347 strbuf_complete(&path, '/');
348 strbuf_addstr(&path, "HEAD");
349 if (validate_headref(path.buf))
350 goto done;
352 strbuf_reset(&path);
353 get_common_dir(&path, suspect);
354 len = path.len;
356 /* Check non-worktree-related signatures */
357 if (getenv(DB_ENVIRONMENT)) {
358 if (access(getenv(DB_ENVIRONMENT), X_OK))
359 goto done;
361 else {
362 strbuf_setlen(&path, len);
363 strbuf_addstr(&path, "/objects");
364 if (access(path.buf, X_OK))
365 goto done;
368 strbuf_setlen(&path, len);
369 strbuf_addstr(&path, "/refs");
370 if (access(path.buf, X_OK))
371 goto done;
373 ret = 1;
374 done:
375 strbuf_release(&path);
376 return ret;
379 int is_nonbare_repository_dir(struct strbuf *path)
381 int ret = 0;
382 int gitfile_error;
383 size_t orig_path_len = path->len;
384 assert(orig_path_len != 0);
385 strbuf_complete(path, '/');
386 strbuf_addstr(path, ".git");
387 if (read_gitfile_gently(path->buf, &gitfile_error) || is_git_directory(path->buf))
388 ret = 1;
389 if (gitfile_error == READ_GITFILE_ERR_OPEN_FAILED ||
390 gitfile_error == READ_GITFILE_ERR_READ_FAILED)
391 ret = 1;
392 strbuf_setlen(path, orig_path_len);
393 return ret;
396 int is_inside_git_dir(void)
398 if (inside_git_dir < 0)
399 inside_git_dir = is_inside_dir(get_git_dir());
400 return inside_git_dir;
403 int is_inside_work_tree(void)
405 if (inside_work_tree < 0)
406 inside_work_tree = is_inside_dir(get_git_work_tree());
407 return inside_work_tree;
410 void setup_work_tree(void)
412 const char *work_tree;
413 static int initialized = 0;
415 if (initialized)
416 return;
418 if (work_tree_config_is_bogus)
419 die(_("unable to set up work tree using invalid config"));
421 work_tree = get_git_work_tree();
422 if (!work_tree || chdir_notify(work_tree))
423 die(_("this operation must be run in a work tree"));
426 * Make sure subsequent git processes find correct worktree
427 * if $GIT_WORK_TREE is set relative
429 if (getenv(GIT_WORK_TREE_ENVIRONMENT))
430 setenv(GIT_WORK_TREE_ENVIRONMENT, ".", 1);
432 initialized = 1;
435 static int read_worktree_config(const char *var, const char *value, void *vdata)
437 struct repository_format *data = vdata;
439 if (strcmp(var, "core.bare") == 0) {
440 data->is_bare = git_config_bool(var, value);
441 } else if (strcmp(var, "core.worktree") == 0) {
442 if (!value)
443 return config_error_nonbool(var);
444 free(data->work_tree);
445 data->work_tree = xstrdup(value);
447 return 0;
450 enum extension_result {
451 EXTENSION_ERROR = -1, /* compatible with error(), etc */
452 EXTENSION_UNKNOWN = 0,
453 EXTENSION_OK = 1
457 * Do not add new extensions to this function. It handles extensions which are
458 * respected even in v0-format repositories for historical compatibility.
460 static enum extension_result handle_extension_v0(const char *var,
461 const char *value,
462 const char *ext,
463 struct repository_format *data)
465 if (!strcmp(ext, "noop")) {
466 return EXTENSION_OK;
467 } else if (!strcmp(ext, "preciousobjects")) {
468 data->precious_objects = git_config_bool(var, value);
469 return EXTENSION_OK;
470 } else if (!strcmp(ext, "partialclone")) {
471 if (!value)
472 return config_error_nonbool(var);
473 data->partial_clone = xstrdup(value);
474 return EXTENSION_OK;
475 } else if (!strcmp(ext, "worktreeconfig")) {
476 data->worktree_config = git_config_bool(var, value);
477 return EXTENSION_OK;
480 return EXTENSION_UNKNOWN;
484 * Record any new extensions in this function.
486 static enum extension_result handle_extension(const char *var,
487 const char *value,
488 const char *ext,
489 struct repository_format *data)
491 if (!strcmp(ext, "noop-v1")) {
492 return EXTENSION_OK;
493 } else if (!strcmp(ext, "objectformat")) {
494 int format;
496 if (!value)
497 return config_error_nonbool(var);
498 format = hash_algo_by_name(value);
499 if (format == GIT_HASH_UNKNOWN)
500 return error("invalid value for 'extensions.objectformat'");
501 data->hash_algo = format;
502 return EXTENSION_OK;
504 return EXTENSION_UNKNOWN;
507 static int check_repo_format(const char *var, const char *value, void *vdata)
509 struct repository_format *data = vdata;
510 const char *ext;
512 if (strcmp(var, "core.repositoryformatversion") == 0)
513 data->version = git_config_int(var, value);
514 else if (skip_prefix(var, "extensions.", &ext)) {
515 switch (handle_extension_v0(var, value, ext, data)) {
516 case EXTENSION_ERROR:
517 return -1;
518 case EXTENSION_OK:
519 return 0;
520 case EXTENSION_UNKNOWN:
521 break;
524 switch (handle_extension(var, value, ext, data)) {
525 case EXTENSION_ERROR:
526 return -1;
527 case EXTENSION_OK:
528 string_list_append(&data->v1_only_extensions, ext);
529 return 0;
530 case EXTENSION_UNKNOWN:
531 string_list_append(&data->unknown_extensions, ext);
532 return 0;
536 return read_worktree_config(var, value, vdata);
539 static int check_repository_format_gently(const char *gitdir, struct repository_format *candidate, int *nongit_ok)
541 struct strbuf sb = STRBUF_INIT;
542 struct strbuf err = STRBUF_INIT;
543 int has_common;
545 has_common = get_common_dir(&sb, gitdir);
546 strbuf_addstr(&sb, "/config");
547 read_repository_format(candidate, sb.buf);
548 strbuf_release(&sb);
551 * For historical use of check_repository_format() in git-init,
552 * we treat a missing config as a silent "ok", even when nongit_ok
553 * is unset.
555 if (candidate->version < 0)
556 return 0;
558 if (verify_repository_format(candidate, &err) < 0) {
559 if (nongit_ok) {
560 warning("%s", err.buf);
561 strbuf_release(&err);
562 *nongit_ok = -1;
563 return -1;
565 die("%s", err.buf);
568 repository_format_precious_objects = candidate->precious_objects;
569 set_repository_format_partial_clone(candidate->partial_clone);
570 repository_format_worktree_config = candidate->worktree_config;
571 string_list_clear(&candidate->unknown_extensions, 0);
572 string_list_clear(&candidate->v1_only_extensions, 0);
574 if (repository_format_worktree_config) {
576 * pick up core.bare and core.worktree from per-worktree
577 * config if present
579 strbuf_addf(&sb, "%s/config.worktree", gitdir);
580 git_config_from_file(read_worktree_config, sb.buf, candidate);
581 strbuf_release(&sb);
582 has_common = 0;
585 if (!has_common) {
586 if (candidate->is_bare != -1) {
587 is_bare_repository_cfg = candidate->is_bare;
588 if (is_bare_repository_cfg == 1)
589 inside_work_tree = -1;
591 if (candidate->work_tree) {
592 free(git_work_tree_cfg);
593 git_work_tree_cfg = xstrdup(candidate->work_tree);
594 inside_work_tree = -1;
598 return 0;
601 int upgrade_repository_format(int target_version)
603 struct strbuf sb = STRBUF_INIT;
604 struct strbuf err = STRBUF_INIT;
605 struct strbuf repo_version = STRBUF_INIT;
606 struct repository_format repo_fmt = REPOSITORY_FORMAT_INIT;
608 strbuf_git_common_path(&sb, the_repository, "config");
609 read_repository_format(&repo_fmt, sb.buf);
610 strbuf_release(&sb);
612 if (repo_fmt.version >= target_version)
613 return 0;
615 if (verify_repository_format(&repo_fmt, &err) < 0) {
616 error("cannot upgrade repository format from %d to %d: %s",
617 repo_fmt.version, target_version, err.buf);
618 strbuf_release(&err);
619 return -1;
621 if (!repo_fmt.version && repo_fmt.unknown_extensions.nr)
622 return error("cannot upgrade repository format: "
623 "unknown extension %s",
624 repo_fmt.unknown_extensions.items[0].string);
626 strbuf_addf(&repo_version, "%d", target_version);
627 git_config_set("core.repositoryformatversion", repo_version.buf);
628 strbuf_release(&repo_version);
629 return 1;
632 static void init_repository_format(struct repository_format *format)
634 const struct repository_format fresh = REPOSITORY_FORMAT_INIT;
636 memcpy(format, &fresh, sizeof(fresh));
639 int read_repository_format(struct repository_format *format, const char *path)
641 clear_repository_format(format);
642 git_config_from_file(check_repo_format, path, format);
643 if (format->version == -1)
644 clear_repository_format(format);
645 return format->version;
648 void clear_repository_format(struct repository_format *format)
650 string_list_clear(&format->unknown_extensions, 0);
651 string_list_clear(&format->v1_only_extensions, 0);
652 free(format->work_tree);
653 free(format->partial_clone);
654 init_repository_format(format);
657 int verify_repository_format(const struct repository_format *format,
658 struct strbuf *err)
660 if (GIT_REPO_VERSION_READ < format->version) {
661 strbuf_addf(err, _("Expected git repo version <= %d, found %d"),
662 GIT_REPO_VERSION_READ, format->version);
663 return -1;
666 if (format->version >= 1 && format->unknown_extensions.nr) {
667 int i;
669 strbuf_addstr(err, _("unknown repository extensions found:"));
671 for (i = 0; i < format->unknown_extensions.nr; i++)
672 strbuf_addf(err, "\n\t%s",
673 format->unknown_extensions.items[i].string);
674 return -1;
677 if (format->version == 0 && format->v1_only_extensions.nr) {
678 int i;
680 strbuf_addstr(err,
681 _("repo version is 0, but v1-only extensions found:"));
683 for (i = 0; i < format->v1_only_extensions.nr; i++)
684 strbuf_addf(err, "\n\t%s",
685 format->v1_only_extensions.items[i].string);
686 return -1;
689 return 0;
692 void read_gitfile_error_die(int error_code, const char *path, const char *dir)
694 switch (error_code) {
695 case READ_GITFILE_ERR_STAT_FAILED:
696 case READ_GITFILE_ERR_NOT_A_FILE:
697 /* non-fatal; follow return path */
698 break;
699 case READ_GITFILE_ERR_OPEN_FAILED:
700 die_errno(_("error opening '%s'"), path);
701 case READ_GITFILE_ERR_TOO_LARGE:
702 die(_("too large to be a .git file: '%s'"), path);
703 case READ_GITFILE_ERR_READ_FAILED:
704 die(_("error reading %s"), path);
705 case READ_GITFILE_ERR_INVALID_FORMAT:
706 die(_("invalid gitfile format: %s"), path);
707 case READ_GITFILE_ERR_NO_PATH:
708 die(_("no path in gitfile: %s"), path);
709 case READ_GITFILE_ERR_NOT_A_REPO:
710 die(_("not a git repository: %s"), dir);
711 default:
712 BUG("unknown error code");
717 * Try to read the location of the git directory from the .git file,
718 * return path to git directory if found. The return value comes from
719 * a shared buffer.
721 * On failure, if return_error_code is not NULL, return_error_code
722 * will be set to an error code and NULL will be returned. If
723 * return_error_code is NULL the function will die instead (for most
724 * cases).
726 const char *read_gitfile_gently(const char *path, int *return_error_code)
728 const int max_file_size = 1 << 20; /* 1MB */
729 int error_code = 0;
730 char *buf = NULL;
731 char *dir = NULL;
732 const char *slash;
733 struct stat st;
734 int fd;
735 ssize_t len;
736 static struct strbuf realpath = STRBUF_INIT;
738 if (stat(path, &st)) {
739 /* NEEDSWORK: discern between ENOENT vs other errors */
740 error_code = READ_GITFILE_ERR_STAT_FAILED;
741 goto cleanup_return;
743 if (!S_ISREG(st.st_mode)) {
744 error_code = READ_GITFILE_ERR_NOT_A_FILE;
745 goto cleanup_return;
747 if (st.st_size > max_file_size) {
748 error_code = READ_GITFILE_ERR_TOO_LARGE;
749 goto cleanup_return;
751 fd = open(path, O_RDONLY);
752 if (fd < 0) {
753 error_code = READ_GITFILE_ERR_OPEN_FAILED;
754 goto cleanup_return;
756 buf = xmallocz(st.st_size);
757 len = read_in_full(fd, buf, st.st_size);
758 close(fd);
759 if (len != st.st_size) {
760 error_code = READ_GITFILE_ERR_READ_FAILED;
761 goto cleanup_return;
763 if (!starts_with(buf, "gitdir: ")) {
764 error_code = READ_GITFILE_ERR_INVALID_FORMAT;
765 goto cleanup_return;
767 while (buf[len - 1] == '\n' || buf[len - 1] == '\r')
768 len--;
769 if (len < 9) {
770 error_code = READ_GITFILE_ERR_NO_PATH;
771 goto cleanup_return;
773 buf[len] = '\0';
774 dir = buf + 8;
776 if (!is_absolute_path(dir) && (slash = strrchr(path, '/'))) {
777 size_t pathlen = slash+1 - path;
778 dir = xstrfmt("%.*s%.*s", (int)pathlen, path,
779 (int)(len - 8), buf + 8);
780 free(buf);
781 buf = dir;
783 if (!is_git_directory(dir)) {
784 error_code = READ_GITFILE_ERR_NOT_A_REPO;
785 goto cleanup_return;
788 strbuf_realpath(&realpath, dir, 1);
789 path = realpath.buf;
791 cleanup_return:
792 if (return_error_code)
793 *return_error_code = error_code;
794 else if (error_code)
795 read_gitfile_error_die(error_code, path, dir);
797 free(buf);
798 return error_code ? NULL : path;
801 static const char *setup_explicit_git_dir(const char *gitdirenv,
802 struct strbuf *cwd,
803 struct repository_format *repo_fmt,
804 int *nongit_ok)
806 const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
807 const char *worktree;
808 char *gitfile;
809 int offset;
811 if (PATH_MAX - 40 < strlen(gitdirenv))
812 die(_("'$%s' too big"), GIT_DIR_ENVIRONMENT);
814 gitfile = (char*)read_gitfile(gitdirenv);
815 if (gitfile) {
816 gitfile = xstrdup(gitfile);
817 gitdirenv = gitfile;
820 if (!is_git_directory(gitdirenv)) {
821 if (nongit_ok) {
822 *nongit_ok = 1;
823 free(gitfile);
824 return NULL;
826 die(_("not a git repository: '%s'"), gitdirenv);
829 if (check_repository_format_gently(gitdirenv, repo_fmt, nongit_ok)) {
830 free(gitfile);
831 return NULL;
834 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
835 if (work_tree_env)
836 set_git_work_tree(work_tree_env);
837 else if (is_bare_repository_cfg > 0) {
838 if (git_work_tree_cfg) {
839 /* #22.2, #30 */
840 warning("core.bare and core.worktree do not make sense");
841 work_tree_config_is_bogus = 1;
844 /* #18, #26 */
845 set_git_dir(gitdirenv, 0);
846 free(gitfile);
847 return NULL;
849 else if (git_work_tree_cfg) { /* #6, #14 */
850 if (is_absolute_path(git_work_tree_cfg))
851 set_git_work_tree(git_work_tree_cfg);
852 else {
853 char *core_worktree;
854 if (chdir(gitdirenv))
855 die_errno(_("cannot chdir to '%s'"), gitdirenv);
856 if (chdir(git_work_tree_cfg))
857 die_errno(_("cannot chdir to '%s'"), git_work_tree_cfg);
858 core_worktree = xgetcwd();
859 if (chdir(cwd->buf))
860 die_errno(_("cannot come back to cwd"));
861 set_git_work_tree(core_worktree);
862 free(core_worktree);
865 else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, 1)) {
866 /* #16d */
867 set_git_dir(gitdirenv, 0);
868 free(gitfile);
869 return NULL;
871 else /* #2, #10 */
872 set_git_work_tree(".");
874 /* set_git_work_tree() must have been called by now */
875 worktree = get_git_work_tree();
877 /* both get_git_work_tree() and cwd are already normalized */
878 if (!strcmp(cwd->buf, worktree)) { /* cwd == worktree */
879 set_git_dir(gitdirenv, 0);
880 free(gitfile);
881 return NULL;
884 offset = dir_inside_of(cwd->buf, worktree);
885 if (offset >= 0) { /* cwd inside worktree? */
886 set_git_dir(gitdirenv, 1);
887 if (chdir(worktree))
888 die_errno(_("cannot chdir to '%s'"), worktree);
889 strbuf_addch(cwd, '/');
890 free(gitfile);
891 return cwd->buf + offset;
894 /* cwd outside worktree */
895 set_git_dir(gitdirenv, 0);
896 free(gitfile);
897 return NULL;
900 static const char *setup_discovered_git_dir(const char *gitdir,
901 struct strbuf *cwd, int offset,
902 struct repository_format *repo_fmt,
903 int *nongit_ok)
905 if (check_repository_format_gently(gitdir, repo_fmt, nongit_ok))
906 return NULL;
908 /* --work-tree is set without --git-dir; use discovered one */
909 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
910 char *to_free = NULL;
911 const char *ret;
913 if (offset != cwd->len && !is_absolute_path(gitdir))
914 gitdir = to_free = real_pathdup(gitdir, 1);
915 if (chdir(cwd->buf))
916 die_errno(_("cannot come back to cwd"));
917 ret = setup_explicit_git_dir(gitdir, cwd, repo_fmt, nongit_ok);
918 free(to_free);
919 return ret;
922 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
923 if (is_bare_repository_cfg > 0) {
924 set_git_dir(gitdir, (offset != cwd->len));
925 if (chdir(cwd->buf))
926 die_errno(_("cannot come back to cwd"));
927 return NULL;
930 /* #0, #1, #5, #8, #9, #12, #13 */
931 set_git_work_tree(".");
932 if (strcmp(gitdir, DEFAULT_GIT_DIR_ENVIRONMENT))
933 set_git_dir(gitdir, 0);
934 inside_git_dir = 0;
935 inside_work_tree = 1;
936 if (offset >= cwd->len)
937 return NULL;
939 /* Make "offset" point past the '/' (already the case for root dirs) */
940 if (offset != offset_1st_component(cwd->buf))
941 offset++;
942 /* Add a '/' at the end */
943 strbuf_addch(cwd, '/');
944 return cwd->buf + offset;
947 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
948 static const char *setup_bare_git_dir(struct strbuf *cwd, int offset,
949 struct repository_format *repo_fmt,
950 int *nongit_ok)
952 int root_len;
954 if (check_repository_format_gently(".", repo_fmt, nongit_ok))
955 return NULL;
957 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
959 /* --work-tree is set without --git-dir; use discovered one */
960 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
961 static const char *gitdir;
963 gitdir = offset == cwd->len ? "." : xmemdupz(cwd->buf, offset);
964 if (chdir(cwd->buf))
965 die_errno(_("cannot come back to cwd"));
966 return setup_explicit_git_dir(gitdir, cwd, repo_fmt, nongit_ok);
969 inside_git_dir = 1;
970 inside_work_tree = 0;
971 if (offset != cwd->len) {
972 if (chdir(cwd->buf))
973 die_errno(_("cannot come back to cwd"));
974 root_len = offset_1st_component(cwd->buf);
975 strbuf_setlen(cwd, offset > root_len ? offset : root_len);
976 set_git_dir(cwd->buf, 0);
978 else
979 set_git_dir(".", 0);
980 return NULL;
983 static dev_t get_device_or_die(const char *path, const char *prefix, int prefix_len)
985 struct stat buf;
986 if (stat(path, &buf)) {
987 die_errno(_("failed to stat '%*s%s%s'"),
988 prefix_len,
989 prefix ? prefix : "",
990 prefix ? "/" : "", path);
992 return buf.st_dev;
996 * A "string_list_each_func_t" function that canonicalizes an entry
997 * from GIT_CEILING_DIRECTORIES using real_pathdup(), or
998 * discards it if unusable. The presence of an empty entry in
999 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
1000 * subsequent entries.
1002 static int canonicalize_ceiling_entry(struct string_list_item *item,
1003 void *cb_data)
1005 int *empty_entry_found = cb_data;
1006 char *ceil = item->string;
1008 if (!*ceil) {
1009 *empty_entry_found = 1;
1010 return 0;
1011 } else if (!is_absolute_path(ceil)) {
1012 return 0;
1013 } else if (*empty_entry_found) {
1014 /* Keep entry but do not canonicalize it */
1015 return 1;
1016 } else {
1017 char *real_path = real_pathdup(ceil, 0);
1018 if (!real_path) {
1019 return 0;
1021 free(item->string);
1022 item->string = real_path;
1023 return 1;
1027 enum discovery_result {
1028 GIT_DIR_NONE = 0,
1029 GIT_DIR_EXPLICIT,
1030 GIT_DIR_DISCOVERED,
1031 GIT_DIR_BARE,
1032 /* these are errors */
1033 GIT_DIR_HIT_CEILING = -1,
1034 GIT_DIR_HIT_MOUNT_POINT = -2,
1035 GIT_DIR_INVALID_GITFILE = -3
1039 * We cannot decide in this function whether we are in the work tree or
1040 * not, since the config can only be read _after_ this function was called.
1042 * Also, we avoid changing any global state (such as the current working
1043 * directory) to allow early callers.
1045 * The directory where the search should start needs to be passed in via the
1046 * `dir` parameter; upon return, the `dir` buffer will contain the path of
1047 * the directory where the search ended, and `gitdir` will contain the path of
1048 * the discovered .git/ directory, if any. If `gitdir` is not absolute, it
1049 * is relative to `dir` (i.e. *not* necessarily the cwd).
1051 static enum discovery_result setup_git_directory_gently_1(struct strbuf *dir,
1052 struct strbuf *gitdir,
1053 int die_on_error)
1055 const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
1056 struct string_list ceiling_dirs = STRING_LIST_INIT_DUP;
1057 const char *gitdirenv;
1058 int ceil_offset = -1, min_offset = offset_1st_component(dir->buf);
1059 dev_t current_device = 0;
1060 int one_filesystem = 1;
1063 * If GIT_DIR is set explicitly, we're not going
1064 * to do any discovery, but we still do repository
1065 * validation.
1067 gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
1068 if (gitdirenv) {
1069 strbuf_addstr(gitdir, gitdirenv);
1070 return GIT_DIR_EXPLICIT;
1073 if (env_ceiling_dirs) {
1074 int empty_entry_found = 0;
1076 string_list_split(&ceiling_dirs, env_ceiling_dirs, PATH_SEP, -1);
1077 filter_string_list(&ceiling_dirs, 0,
1078 canonicalize_ceiling_entry, &empty_entry_found);
1079 ceil_offset = longest_ancestor_length(dir->buf, &ceiling_dirs);
1080 string_list_clear(&ceiling_dirs, 0);
1083 if (ceil_offset < 0)
1084 ceil_offset = min_offset - 2;
1086 if (min_offset && min_offset == dir->len &&
1087 !is_dir_sep(dir->buf[min_offset - 1])) {
1088 strbuf_addch(dir, '/');
1089 min_offset++;
1093 * Test in the following order (relative to the dir):
1094 * - .git (file containing "gitdir: <path>")
1095 * - .git/
1096 * - ./ (bare)
1097 * - ../.git
1098 * - ../.git/
1099 * - ../ (bare)
1100 * - ../../.git
1101 * etc.
1103 one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
1104 if (one_filesystem)
1105 current_device = get_device_or_die(dir->buf, NULL, 0);
1106 for (;;) {
1107 int offset = dir->len, error_code = 0;
1109 if (offset > min_offset)
1110 strbuf_addch(dir, '/');
1111 strbuf_addstr(dir, DEFAULT_GIT_DIR_ENVIRONMENT);
1112 gitdirenv = read_gitfile_gently(dir->buf, die_on_error ?
1113 NULL : &error_code);
1114 if (!gitdirenv) {
1115 if (die_on_error ||
1116 error_code == READ_GITFILE_ERR_NOT_A_FILE) {
1117 /* NEEDSWORK: fail if .git is not file nor dir */
1118 if (is_git_directory(dir->buf))
1119 gitdirenv = DEFAULT_GIT_DIR_ENVIRONMENT;
1120 } else if (error_code != READ_GITFILE_ERR_STAT_FAILED)
1121 return GIT_DIR_INVALID_GITFILE;
1123 strbuf_setlen(dir, offset);
1124 if (gitdirenv) {
1125 strbuf_addstr(gitdir, gitdirenv);
1126 return GIT_DIR_DISCOVERED;
1129 if (is_git_directory(dir->buf)) {
1130 strbuf_addstr(gitdir, ".");
1131 return GIT_DIR_BARE;
1134 if (offset <= min_offset)
1135 return GIT_DIR_HIT_CEILING;
1137 while (--offset > ceil_offset && !is_dir_sep(dir->buf[offset]))
1138 ; /* continue */
1139 if (offset <= ceil_offset)
1140 return GIT_DIR_HIT_CEILING;
1142 strbuf_setlen(dir, offset > min_offset ? offset : min_offset);
1143 if (one_filesystem &&
1144 current_device != get_device_or_die(dir->buf, NULL, offset))
1145 return GIT_DIR_HIT_MOUNT_POINT;
1149 int discover_git_directory(struct strbuf *commondir,
1150 struct strbuf *gitdir)
1152 struct strbuf dir = STRBUF_INIT, err = STRBUF_INIT;
1153 size_t gitdir_offset = gitdir->len, cwd_len;
1154 size_t commondir_offset = commondir->len;
1155 struct repository_format candidate = REPOSITORY_FORMAT_INIT;
1157 if (strbuf_getcwd(&dir))
1158 return -1;
1160 cwd_len = dir.len;
1161 if (setup_git_directory_gently_1(&dir, gitdir, 0) <= 0) {
1162 strbuf_release(&dir);
1163 return -1;
1167 * The returned gitdir is relative to dir, and if dir does not reflect
1168 * the current working directory, we simply make the gitdir absolute.
1170 if (dir.len < cwd_len && !is_absolute_path(gitdir->buf + gitdir_offset)) {
1171 /* Avoid a trailing "/." */
1172 if (!strcmp(".", gitdir->buf + gitdir_offset))
1173 strbuf_setlen(gitdir, gitdir_offset);
1174 else
1175 strbuf_addch(&dir, '/');
1176 strbuf_insert(gitdir, gitdir_offset, dir.buf, dir.len);
1179 get_common_dir(commondir, gitdir->buf + gitdir_offset);
1181 strbuf_reset(&dir);
1182 strbuf_addf(&dir, "%s/config", commondir->buf + commondir_offset);
1183 read_repository_format(&candidate, dir.buf);
1184 strbuf_release(&dir);
1186 if (verify_repository_format(&candidate, &err) < 0) {
1187 warning("ignoring git dir '%s': %s",
1188 gitdir->buf + gitdir_offset, err.buf);
1189 strbuf_release(&err);
1190 strbuf_setlen(commondir, commondir_offset);
1191 strbuf_setlen(gitdir, gitdir_offset);
1192 clear_repository_format(&candidate);
1193 return -1;
1196 clear_repository_format(&candidate);
1197 return 0;
1200 const char *setup_git_directory_gently(int *nongit_ok)
1202 static struct strbuf cwd = STRBUF_INIT;
1203 struct strbuf dir = STRBUF_INIT, gitdir = STRBUF_INIT;
1204 const char *prefix = NULL;
1205 struct repository_format repo_fmt = REPOSITORY_FORMAT_INIT;
1208 * We may have read an incomplete configuration before
1209 * setting-up the git directory. If so, clear the cache so
1210 * that the next queries to the configuration reload complete
1211 * configuration (including the per-repo config file that we
1212 * ignored previously).
1214 git_config_clear();
1217 * Let's assume that we are in a git repository.
1218 * If it turns out later that we are somewhere else, the value will be
1219 * updated accordingly.
1221 if (nongit_ok)
1222 *nongit_ok = 0;
1224 if (strbuf_getcwd(&cwd))
1225 die_errno(_("Unable to read current working directory"));
1226 strbuf_addbuf(&dir, &cwd);
1228 switch (setup_git_directory_gently_1(&dir, &gitdir, 1)) {
1229 case GIT_DIR_EXPLICIT:
1230 prefix = setup_explicit_git_dir(gitdir.buf, &cwd, &repo_fmt, nongit_ok);
1231 break;
1232 case GIT_DIR_DISCOVERED:
1233 if (dir.len < cwd.len && chdir(dir.buf))
1234 die(_("cannot change to '%s'"), dir.buf);
1235 prefix = setup_discovered_git_dir(gitdir.buf, &cwd, dir.len,
1236 &repo_fmt, nongit_ok);
1237 break;
1238 case GIT_DIR_BARE:
1239 if (dir.len < cwd.len && chdir(dir.buf))
1240 die(_("cannot change to '%s'"), dir.buf);
1241 prefix = setup_bare_git_dir(&cwd, dir.len, &repo_fmt, nongit_ok);
1242 break;
1243 case GIT_DIR_HIT_CEILING:
1244 if (!nongit_ok)
1245 die(_("not a git repository (or any of the parent directories): %s"),
1246 DEFAULT_GIT_DIR_ENVIRONMENT);
1247 *nongit_ok = 1;
1248 break;
1249 case GIT_DIR_HIT_MOUNT_POINT:
1250 if (!nongit_ok)
1251 die(_("not a git repository (or any parent up to mount point %s)\n"
1252 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set)."),
1253 dir.buf);
1254 *nongit_ok = 1;
1255 break;
1256 case GIT_DIR_NONE:
1258 * As a safeguard against setup_git_directory_gently_1 returning
1259 * this value, fallthrough to BUG. Otherwise it is possible to
1260 * set startup_info->have_repository to 1 when we did nothing to
1261 * find a repository.
1263 default:
1264 BUG("unhandled setup_git_directory_1() result");
1268 * At this point, nongit_ok is stable. If it is non-NULL and points
1269 * to a non-zero value, then this means that we haven't found a
1270 * repository and that the caller expects startup_info to reflect
1271 * this.
1273 * Regardless of the state of nongit_ok, startup_info->prefix and
1274 * the GIT_PREFIX environment variable must always match. For details
1275 * see Documentation/config/alias.txt.
1277 if (nongit_ok && *nongit_ok) {
1278 startup_info->have_repository = 0;
1279 startup_info->prefix = NULL;
1280 setenv(GIT_PREFIX_ENVIRONMENT, "", 1);
1281 } else {
1282 startup_info->have_repository = 1;
1283 startup_info->prefix = prefix;
1284 if (prefix)
1285 setenv(GIT_PREFIX_ENVIRONMENT, prefix, 1);
1286 else
1287 setenv(GIT_PREFIX_ENVIRONMENT, "", 1);
1291 * Not all paths through the setup code will call 'set_git_dir()' (which
1292 * directly sets up the environment) so in order to guarantee that the
1293 * environment is in a consistent state after setup, explicitly setup
1294 * the environment if we have a repository.
1296 * NEEDSWORK: currently we allow bogus GIT_DIR values to be set in some
1297 * code paths so we also need to explicitly setup the environment if
1298 * the user has set GIT_DIR. It may be beneficial to disallow bogus
1299 * GIT_DIR values at some point in the future.
1301 if (/* GIT_DIR_EXPLICIT, GIT_DIR_DISCOVERED, GIT_DIR_BARE */
1302 startup_info->have_repository ||
1303 /* GIT_DIR_EXPLICIT */
1304 getenv(GIT_DIR_ENVIRONMENT)) {
1305 if (!the_repository->gitdir) {
1306 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
1307 if (!gitdir)
1308 gitdir = DEFAULT_GIT_DIR_ENVIRONMENT;
1309 setup_git_env(gitdir);
1311 if (startup_info->have_repository)
1312 repo_set_hash_algo(the_repository, repo_fmt.hash_algo);
1315 strbuf_release(&dir);
1316 strbuf_release(&gitdir);
1317 clear_repository_format(&repo_fmt);
1319 return prefix;
1322 int git_config_perm(const char *var, const char *value)
1324 int i;
1325 char *endptr;
1327 if (value == NULL)
1328 return PERM_GROUP;
1330 if (!strcmp(value, "umask"))
1331 return PERM_UMASK;
1332 if (!strcmp(value, "group"))
1333 return PERM_GROUP;
1334 if (!strcmp(value, "all") ||
1335 !strcmp(value, "world") ||
1336 !strcmp(value, "everybody"))
1337 return PERM_EVERYBODY;
1339 /* Parse octal numbers */
1340 i = strtol(value, &endptr, 8);
1342 /* If not an octal number, maybe true/false? */
1343 if (*endptr != 0)
1344 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
1347 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
1348 * a chmod value to restrict to.
1350 switch (i) {
1351 case PERM_UMASK: /* 0 */
1352 return PERM_UMASK;
1353 case OLD_PERM_GROUP: /* 1 */
1354 return PERM_GROUP;
1355 case OLD_PERM_EVERYBODY: /* 2 */
1356 return PERM_EVERYBODY;
1359 /* A filemode value was given: 0xxx */
1361 if ((i & 0600) != 0600)
1362 die(_("problem with core.sharedRepository filemode value "
1363 "(0%.3o).\nThe owner of files must always have "
1364 "read and write permissions."), i);
1367 * Mask filemode value. Others can not get write permission.
1368 * x flags for directories are handled separately.
1370 return -(i & 0666);
1373 void check_repository_format(struct repository_format *fmt)
1375 struct repository_format repo_fmt = REPOSITORY_FORMAT_INIT;
1376 if (!fmt)
1377 fmt = &repo_fmt;
1378 check_repository_format_gently(get_git_dir(), fmt, NULL);
1379 startup_info->have_repository = 1;
1380 repo_set_hash_algo(the_repository, fmt->hash_algo);
1381 clear_repository_format(&repo_fmt);
1385 * Returns the "prefix", a path to the current working directory
1386 * relative to the work tree root, or NULL, if the current working
1387 * directory is not a strict subdirectory of the work tree root. The
1388 * prefix always ends with a '/' character.
1390 const char *setup_git_directory(void)
1392 return setup_git_directory_gently(NULL);
1395 const char *resolve_gitdir_gently(const char *suspect, int *return_error_code)
1397 if (is_git_directory(suspect))
1398 return suspect;
1399 return read_gitfile_gently(suspect, return_error_code);
1402 /* if any standard file descriptor is missing open it to /dev/null */
1403 void sanitize_stdfds(void)
1405 int fd = open("/dev/null", O_RDWR, 0);
1406 while (fd != -1 && fd < 2)
1407 fd = dup(fd);
1408 if (fd == -1)
1409 die_errno(_("open /dev/null or dup failed"));
1410 if (fd > 2)
1411 close(fd);
1414 int daemonize(void)
1416 #ifdef NO_POSIX_GOODIES
1417 errno = ENOSYS;
1418 return -1;
1419 #else
1420 switch (fork()) {
1421 case 0:
1422 break;
1423 case -1:
1424 die_errno(_("fork failed"));
1425 default:
1426 exit(0);
1428 if (setsid() == -1)
1429 die_errno(_("setsid failed"));
1430 close(0);
1431 close(1);
1432 close(2);
1433 sanitize_stdfds();
1434 return 0;
1435 #endif