stash: remove now superfluos help for "stash push"
[git.git] / setup.c
blob03f51e056cd6e672ecd80ba94348173b9d496cc0
1 #include "cache.h"
2 #include "repository.h"
3 #include "config.h"
4 #include "dir.h"
5 #include "string-list.h"
7 static int inside_git_dir = -1;
8 static int inside_work_tree = -1;
9 static int work_tree_config_is_bogus;
11 static struct startup_info the_startup_info;
12 struct startup_info *startup_info = &the_startup_info;
15 * The input parameter must contain an absolute path, and it must already be
16 * normalized.
18 * Find the part of an absolute path that lies inside the work tree by
19 * dereferencing symlinks outside the work tree, for example:
20 * /dir1/repo/dir2/file (work tree is /dir1/repo) -> dir2/file
21 * /dir/file (work tree is /) -> dir/file
22 * /dir/symlink1/symlink2 (symlink1 points to work tree) -> symlink2
23 * /dir/repolink/file (repolink points to /dir/repo) -> file
24 * /dir/repo (exactly equal to work tree) -> (empty string)
26 static int abspath_part_inside_repo(char *path)
28 size_t len;
29 size_t wtlen;
30 char *path0;
31 int off;
32 const char *work_tree = get_git_work_tree();
34 if (!work_tree)
35 return -1;
36 wtlen = strlen(work_tree);
37 len = strlen(path);
38 off = offset_1st_component(path);
40 /* check if work tree is already the prefix */
41 if (wtlen <= len && !strncmp(path, work_tree, wtlen)) {
42 if (path[wtlen] == '/') {
43 memmove(path, path + wtlen + 1, len - wtlen);
44 return 0;
45 } else if (path[wtlen - 1] == '/' || path[wtlen] == '\0') {
46 /* work tree is the root, or the whole path */
47 memmove(path, path + wtlen, len - wtlen + 1);
48 return 0;
50 /* work tree might match beginning of a symlink to work tree */
51 off = wtlen;
53 path0 = path;
54 path += off;
56 /* check each '/'-terminated level */
57 while (*path) {
58 path++;
59 if (*path == '/') {
60 *path = '\0';
61 if (strcmp(real_path(path0), work_tree) == 0) {
62 memmove(path0, path + 1, len - (path - path0));
63 return 0;
65 *path = '/';
69 /* check whole path */
70 if (strcmp(real_path(path0), work_tree) == 0) {
71 *path0 = '\0';
72 return 0;
75 return -1;
79 * Normalize "path", prepending the "prefix" for relative paths. If
80 * remaining_prefix is not NULL, return the actual prefix still
81 * remains in the path. For example, prefix = sub1/sub2/ and path is
83 * foo -> sub1/sub2/foo (full prefix)
84 * ../foo -> sub1/foo (remaining prefix is sub1/)
85 * ../../bar -> bar (no remaining prefix)
86 * ../../sub1/sub2/foo -> sub1/sub2/foo (but no remaining prefix)
87 * `pwd`/../bar -> sub1/bar (no remaining prefix)
89 char *prefix_path_gently(const char *prefix, int len,
90 int *remaining_prefix, const char *path)
92 const char *orig = path;
93 char *sanitized;
94 if (is_absolute_path(orig)) {
95 sanitized = xmallocz(strlen(path));
96 if (remaining_prefix)
97 *remaining_prefix = 0;
98 if (normalize_path_copy_len(sanitized, path, remaining_prefix)) {
99 free(sanitized);
100 return NULL;
102 if (abspath_part_inside_repo(sanitized)) {
103 free(sanitized);
104 return NULL;
106 } else {
107 sanitized = xstrfmt("%.*s%s", len, len ? prefix : "", path);
108 if (remaining_prefix)
109 *remaining_prefix = len;
110 if (normalize_path_copy_len(sanitized, sanitized, remaining_prefix)) {
111 free(sanitized);
112 return NULL;
115 return sanitized;
118 char *prefix_path(const char *prefix, int len, const char *path)
120 char *r = prefix_path_gently(prefix, len, NULL, path);
121 if (!r)
122 die("'%s' is outside repository", path);
123 return r;
126 int path_inside_repo(const char *prefix, const char *path)
128 int len = prefix ? strlen(prefix) : 0;
129 char *r = prefix_path_gently(prefix, len, NULL, path);
130 if (r) {
131 free(r);
132 return 1;
134 return 0;
137 int check_filename(const char *prefix, const char *arg)
139 char *to_free = NULL;
140 struct stat st;
142 if (skip_prefix(arg, ":/", &arg)) {
143 if (!*arg) /* ":/" is root dir, always exists */
144 return 1;
145 prefix = NULL;
146 } else if (skip_prefix(arg, ":!", &arg) ||
147 skip_prefix(arg, ":^", &arg)) {
148 if (!*arg) /* excluding everything is silly, but allowed */
149 return 1;
152 if (prefix)
153 arg = to_free = prefix_filename(prefix, arg);
155 if (!lstat(arg, &st)) {
156 free(to_free);
157 return 1; /* file exists */
159 if (is_missing_file_error(errno)) {
160 free(to_free);
161 return 0; /* file does not exist */
163 die_errno("failed to stat '%s'", arg);
166 static void NORETURN die_verify_filename(const char *prefix,
167 const char *arg,
168 int diagnose_misspelt_rev)
170 if (!diagnose_misspelt_rev)
171 die(_("%s: no such path in the working tree.\n"
172 "Use 'git <command> -- <path>...' to specify paths that do not exist locally."),
173 arg);
175 * Saying "'(icase)foo' does not exist in the index" when the
176 * user gave us ":(icase)foo" is just stupid. A magic pathspec
177 * begins with a colon and is followed by a non-alnum; do not
178 * let maybe_die_on_misspelt_object_name() even trigger.
180 if (!(arg[0] == ':' && !isalnum(arg[1])))
181 maybe_die_on_misspelt_object_name(arg, prefix);
183 /* ... or fall back the most general message. */
184 die(_("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
185 "Use '--' to separate paths from revisions, like this:\n"
186 "'git <command> [<revision>...] -- [<file>...]'"), arg);
191 * Check for arguments that don't resolve as actual files,
192 * but which look sufficiently like pathspecs that we'll consider
193 * them such for the purposes of rev/pathspec DWIM parsing.
195 static int looks_like_pathspec(const char *arg)
197 /* anything with a wildcard character */
198 if (!no_wildcard(arg))
199 return 1;
201 /* long-form pathspec magic */
202 if (starts_with(arg, ":("))
203 return 1;
205 return 0;
209 * Verify a filename that we got as an argument for a pathspec
210 * entry. Note that a filename that begins with "-" never verifies
211 * as true, because even if such a filename were to exist, we want
212 * it to be preceded by the "--" marker (or we want the user to
213 * use a format like "./-filename")
215 * The "diagnose_misspelt_rev" is used to provide a user-friendly
216 * diagnosis when dying upon finding that "name" is not a pathname.
217 * If set to 1, the diagnosis will try to diagnose "name" as an
218 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
219 * will only complain about an inexisting file.
221 * This function is typically called to check that a "file or rev"
222 * argument is unambiguous. In this case, the caller will want
223 * diagnose_misspelt_rev == 1 when verifying the first non-rev
224 * argument (which could have been a revision), and
225 * diagnose_misspelt_rev == 0 for the next ones (because we already
226 * saw a filename, there's not ambiguity anymore).
228 void verify_filename(const char *prefix,
229 const char *arg,
230 int diagnose_misspelt_rev)
232 if (*arg == '-')
233 die("option '%s' must come before non-option arguments", arg);
234 if (looks_like_pathspec(arg) || check_filename(prefix, arg))
235 return;
236 die_verify_filename(prefix, arg, diagnose_misspelt_rev);
240 * Opposite of the above: the command line did not have -- marker
241 * and we parsed the arg as a refname. It should not be interpretable
242 * as a filename.
244 void verify_non_filename(const char *prefix, const char *arg)
246 if (!is_inside_work_tree() || is_inside_git_dir())
247 return;
248 if (*arg == '-')
249 return; /* flag */
250 if (!check_filename(prefix, arg))
251 return;
252 die(_("ambiguous argument '%s': both revision and filename\n"
253 "Use '--' to separate paths from revisions, like this:\n"
254 "'git <command> [<revision>...] -- [<file>...]'"), arg);
257 int get_common_dir(struct strbuf *sb, const char *gitdir)
259 const char *git_env_common_dir = getenv(GIT_COMMON_DIR_ENVIRONMENT);
260 if (git_env_common_dir) {
261 strbuf_addstr(sb, git_env_common_dir);
262 return 1;
263 } else {
264 return get_common_dir_noenv(sb, gitdir);
268 int get_common_dir_noenv(struct strbuf *sb, const char *gitdir)
270 struct strbuf data = STRBUF_INIT;
271 struct strbuf path = STRBUF_INIT;
272 int ret = 0;
274 strbuf_addf(&path, "%s/commondir", gitdir);
275 if (file_exists(path.buf)) {
276 if (strbuf_read_file(&data, path.buf, 0) <= 0)
277 die_errno(_("failed to read %s"), path.buf);
278 while (data.len && (data.buf[data.len - 1] == '\n' ||
279 data.buf[data.len - 1] == '\r'))
280 data.len--;
281 data.buf[data.len] = '\0';
282 strbuf_reset(&path);
283 if (!is_absolute_path(data.buf))
284 strbuf_addf(&path, "%s/", gitdir);
285 strbuf_addbuf(&path, &data);
286 strbuf_add_real_path(sb, path.buf);
287 ret = 1;
288 } else {
289 strbuf_addstr(sb, gitdir);
292 strbuf_release(&data);
293 strbuf_release(&path);
294 return ret;
298 * Test if it looks like we're at a git directory.
299 * We want to see:
301 * - either an objects/ directory _or_ the proper
302 * GIT_OBJECT_DIRECTORY environment variable
303 * - a refs/ directory
304 * - either a HEAD symlink or a HEAD file that is formatted as
305 * a proper "ref:", or a regular file HEAD that has a properly
306 * formatted sha1 object name.
308 int is_git_directory(const char *suspect)
310 struct strbuf path = STRBUF_INIT;
311 int ret = 0;
312 size_t len;
314 /* Check worktree-related signatures */
315 strbuf_addf(&path, "%s/HEAD", suspect);
316 if (validate_headref(path.buf))
317 goto done;
319 strbuf_reset(&path);
320 get_common_dir(&path, suspect);
321 len = path.len;
323 /* Check non-worktree-related signatures */
324 if (getenv(DB_ENVIRONMENT)) {
325 if (access(getenv(DB_ENVIRONMENT), X_OK))
326 goto done;
328 else {
329 strbuf_setlen(&path, len);
330 strbuf_addstr(&path, "/objects");
331 if (access(path.buf, X_OK))
332 goto done;
335 strbuf_setlen(&path, len);
336 strbuf_addstr(&path, "/refs");
337 if (access(path.buf, X_OK))
338 goto done;
340 ret = 1;
341 done:
342 strbuf_release(&path);
343 return ret;
346 int is_nonbare_repository_dir(struct strbuf *path)
348 int ret = 0;
349 int gitfile_error;
350 size_t orig_path_len = path->len;
351 assert(orig_path_len != 0);
352 strbuf_complete(path, '/');
353 strbuf_addstr(path, ".git");
354 if (read_gitfile_gently(path->buf, &gitfile_error) || is_git_directory(path->buf))
355 ret = 1;
356 if (gitfile_error == READ_GITFILE_ERR_OPEN_FAILED ||
357 gitfile_error == READ_GITFILE_ERR_READ_FAILED)
358 ret = 1;
359 strbuf_setlen(path, orig_path_len);
360 return ret;
363 int is_inside_git_dir(void)
365 if (inside_git_dir < 0)
366 inside_git_dir = is_inside_dir(get_git_dir());
367 return inside_git_dir;
370 int is_inside_work_tree(void)
372 if (inside_work_tree < 0)
373 inside_work_tree = is_inside_dir(get_git_work_tree());
374 return inside_work_tree;
377 void setup_work_tree(void)
379 const char *work_tree, *git_dir;
380 static int initialized = 0;
382 if (initialized)
383 return;
385 if (work_tree_config_is_bogus)
386 die("unable to set up work tree using invalid config");
388 work_tree = get_git_work_tree();
389 git_dir = get_git_dir();
390 if (!is_absolute_path(git_dir))
391 git_dir = real_path(get_git_dir());
392 if (!work_tree || chdir(work_tree))
393 die("This operation must be run in a work tree");
396 * Make sure subsequent git processes find correct worktree
397 * if $GIT_WORK_TREE is set relative
399 if (getenv(GIT_WORK_TREE_ENVIRONMENT))
400 setenv(GIT_WORK_TREE_ENVIRONMENT, ".", 1);
402 set_git_dir(remove_leading_path(git_dir, work_tree));
403 initialized = 1;
406 static int check_repo_format(const char *var, const char *value, void *vdata)
408 struct repository_format *data = vdata;
409 const char *ext;
411 if (strcmp(var, "core.repositoryformatversion") == 0)
412 data->version = git_config_int(var, value);
413 else if (skip_prefix(var, "extensions.", &ext)) {
415 * record any known extensions here; otherwise,
416 * we fall through to recording it as unknown, and
417 * check_repository_format will complain
419 if (!strcmp(ext, "noop"))
421 else if (!strcmp(ext, "preciousobjects"))
422 data->precious_objects = git_config_bool(var, value);
423 else
424 string_list_append(&data->unknown_extensions, ext);
425 } else if (strcmp(var, "core.bare") == 0) {
426 data->is_bare = git_config_bool(var, value);
427 } else if (strcmp(var, "core.worktree") == 0) {
428 if (!value)
429 return config_error_nonbool(var);
430 data->work_tree = xstrdup(value);
432 return 0;
435 static int check_repository_format_gently(const char *gitdir, int *nongit_ok)
437 struct strbuf sb = STRBUF_INIT;
438 struct strbuf err = STRBUF_INIT;
439 struct repository_format candidate;
440 int has_common;
442 has_common = get_common_dir(&sb, gitdir);
443 strbuf_addstr(&sb, "/config");
444 read_repository_format(&candidate, sb.buf);
445 strbuf_release(&sb);
448 * For historical use of check_repository_format() in git-init,
449 * we treat a missing config as a silent "ok", even when nongit_ok
450 * is unset.
452 if (candidate.version < 0)
453 return 0;
455 if (verify_repository_format(&candidate, &err) < 0) {
456 if (nongit_ok) {
457 warning("%s", err.buf);
458 strbuf_release(&err);
459 *nongit_ok = -1;
460 return -1;
462 die("%s", err.buf);
465 repository_format_precious_objects = candidate.precious_objects;
466 string_list_clear(&candidate.unknown_extensions, 0);
467 if (!has_common) {
468 if (candidate.is_bare != -1) {
469 is_bare_repository_cfg = candidate.is_bare;
470 if (is_bare_repository_cfg == 1)
471 inside_work_tree = -1;
473 if (candidate.work_tree) {
474 free(git_work_tree_cfg);
475 git_work_tree_cfg = candidate.work_tree;
476 inside_work_tree = -1;
478 } else {
479 free(candidate.work_tree);
482 return 0;
485 int read_repository_format(struct repository_format *format, const char *path)
487 memset(format, 0, sizeof(*format));
488 format->version = -1;
489 format->is_bare = -1;
490 string_list_init(&format->unknown_extensions, 1);
491 git_config_from_file(check_repo_format, path, format);
492 return format->version;
495 int verify_repository_format(const struct repository_format *format,
496 struct strbuf *err)
498 if (GIT_REPO_VERSION_READ < format->version) {
499 strbuf_addf(err, _("Expected git repo version <= %d, found %d"),
500 GIT_REPO_VERSION_READ, format->version);
501 return -1;
504 if (format->version >= 1 && format->unknown_extensions.nr) {
505 int i;
507 strbuf_addstr(err, _("unknown repository extensions found:"));
509 for (i = 0; i < format->unknown_extensions.nr; i++)
510 strbuf_addf(err, "\n\t%s",
511 format->unknown_extensions.items[i].string);
512 return -1;
515 return 0;
518 void read_gitfile_error_die(int error_code, const char *path, const char *dir)
520 switch (error_code) {
521 case READ_GITFILE_ERR_STAT_FAILED:
522 case READ_GITFILE_ERR_NOT_A_FILE:
523 /* non-fatal; follow return path */
524 break;
525 case READ_GITFILE_ERR_OPEN_FAILED:
526 die_errno("Error opening '%s'", path);
527 case READ_GITFILE_ERR_TOO_LARGE:
528 die("Too large to be a .git file: '%s'", path);
529 case READ_GITFILE_ERR_READ_FAILED:
530 die("Error reading %s", path);
531 case READ_GITFILE_ERR_INVALID_FORMAT:
532 die("Invalid gitfile format: %s", path);
533 case READ_GITFILE_ERR_NO_PATH:
534 die("No path in gitfile: %s", path);
535 case READ_GITFILE_ERR_NOT_A_REPO:
536 die("Not a git repository: %s", dir);
537 default:
538 die("BUG: unknown error code");
543 * Try to read the location of the git directory from the .git file,
544 * return path to git directory if found. The return value comes from
545 * a shared buffer.
547 * On failure, if return_error_code is not NULL, return_error_code
548 * will be set to an error code and NULL will be returned. If
549 * return_error_code is NULL the function will die instead (for most
550 * cases).
552 const char *read_gitfile_gently(const char *path, int *return_error_code)
554 const int max_file_size = 1 << 20; /* 1MB */
555 int error_code = 0;
556 char *buf = NULL;
557 char *dir = NULL;
558 const char *slash;
559 struct stat st;
560 int fd;
561 ssize_t len;
563 if (stat(path, &st)) {
564 /* NEEDSWORK: discern between ENOENT vs other errors */
565 error_code = READ_GITFILE_ERR_STAT_FAILED;
566 goto cleanup_return;
568 if (!S_ISREG(st.st_mode)) {
569 error_code = READ_GITFILE_ERR_NOT_A_FILE;
570 goto cleanup_return;
572 if (st.st_size > max_file_size) {
573 error_code = READ_GITFILE_ERR_TOO_LARGE;
574 goto cleanup_return;
576 fd = open(path, O_RDONLY);
577 if (fd < 0) {
578 error_code = READ_GITFILE_ERR_OPEN_FAILED;
579 goto cleanup_return;
581 buf = xmallocz(st.st_size);
582 len = read_in_full(fd, buf, st.st_size);
583 close(fd);
584 if (len != st.st_size) {
585 error_code = READ_GITFILE_ERR_READ_FAILED;
586 goto cleanup_return;
588 if (!starts_with(buf, "gitdir: ")) {
589 error_code = READ_GITFILE_ERR_INVALID_FORMAT;
590 goto cleanup_return;
592 while (buf[len - 1] == '\n' || buf[len - 1] == '\r')
593 len--;
594 if (len < 9) {
595 error_code = READ_GITFILE_ERR_NO_PATH;
596 goto cleanup_return;
598 buf[len] = '\0';
599 dir = buf + 8;
601 if (!is_absolute_path(dir) && (slash = strrchr(path, '/'))) {
602 size_t pathlen = slash+1 - path;
603 dir = xstrfmt("%.*s%.*s", (int)pathlen, path,
604 (int)(len - 8), buf + 8);
605 free(buf);
606 buf = dir;
608 if (!is_git_directory(dir)) {
609 error_code = READ_GITFILE_ERR_NOT_A_REPO;
610 goto cleanup_return;
612 path = real_path(dir);
614 cleanup_return:
615 if (return_error_code)
616 *return_error_code = error_code;
617 else if (error_code)
618 read_gitfile_error_die(error_code, path, dir);
620 free(buf);
621 return error_code ? NULL : path;
624 static const char *setup_explicit_git_dir(const char *gitdirenv,
625 struct strbuf *cwd,
626 int *nongit_ok)
628 const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
629 const char *worktree;
630 char *gitfile;
631 int offset;
633 if (PATH_MAX - 40 < strlen(gitdirenv))
634 die("'$%s' too big", GIT_DIR_ENVIRONMENT);
636 gitfile = (char*)read_gitfile(gitdirenv);
637 if (gitfile) {
638 gitfile = xstrdup(gitfile);
639 gitdirenv = gitfile;
642 if (!is_git_directory(gitdirenv)) {
643 if (nongit_ok) {
644 *nongit_ok = 1;
645 free(gitfile);
646 return NULL;
648 die("Not a git repository: '%s'", gitdirenv);
651 if (check_repository_format_gently(gitdirenv, nongit_ok)) {
652 free(gitfile);
653 return NULL;
656 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
657 if (work_tree_env)
658 set_git_work_tree(work_tree_env);
659 else if (is_bare_repository_cfg > 0) {
660 if (git_work_tree_cfg) {
661 /* #22.2, #30 */
662 warning("core.bare and core.worktree do not make sense");
663 work_tree_config_is_bogus = 1;
666 /* #18, #26 */
667 set_git_dir(gitdirenv);
668 free(gitfile);
669 return NULL;
671 else if (git_work_tree_cfg) { /* #6, #14 */
672 if (is_absolute_path(git_work_tree_cfg))
673 set_git_work_tree(git_work_tree_cfg);
674 else {
675 char *core_worktree;
676 if (chdir(gitdirenv))
677 die_errno("Could not chdir to '%s'", gitdirenv);
678 if (chdir(git_work_tree_cfg))
679 die_errno("Could not chdir to '%s'", git_work_tree_cfg);
680 core_worktree = xgetcwd();
681 if (chdir(cwd->buf))
682 die_errno("Could not come back to cwd");
683 set_git_work_tree(core_worktree);
684 free(core_worktree);
687 else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, 1)) {
688 /* #16d */
689 set_git_dir(gitdirenv);
690 free(gitfile);
691 return NULL;
693 else /* #2, #10 */
694 set_git_work_tree(".");
696 /* set_git_work_tree() must have been called by now */
697 worktree = get_git_work_tree();
699 /* both get_git_work_tree() and cwd are already normalized */
700 if (!strcmp(cwd->buf, worktree)) { /* cwd == worktree */
701 set_git_dir(gitdirenv);
702 free(gitfile);
703 return NULL;
706 offset = dir_inside_of(cwd->buf, worktree);
707 if (offset >= 0) { /* cwd inside worktree? */
708 set_git_dir(real_path(gitdirenv));
709 if (chdir(worktree))
710 die_errno("Could not chdir to '%s'", worktree);
711 strbuf_addch(cwd, '/');
712 free(gitfile);
713 return cwd->buf + offset;
716 /* cwd outside worktree */
717 set_git_dir(gitdirenv);
718 free(gitfile);
719 return NULL;
722 static const char *setup_discovered_git_dir(const char *gitdir,
723 struct strbuf *cwd, int offset,
724 int *nongit_ok)
726 if (check_repository_format_gently(gitdir, nongit_ok))
727 return NULL;
729 /* --work-tree is set without --git-dir; use discovered one */
730 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
731 char *to_free = NULL;
732 const char *ret;
734 if (offset != cwd->len && !is_absolute_path(gitdir))
735 gitdir = to_free = real_pathdup(gitdir, 1);
736 if (chdir(cwd->buf))
737 die_errno("Could not come back to cwd");
738 ret = setup_explicit_git_dir(gitdir, cwd, nongit_ok);
739 free(to_free);
740 return ret;
743 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
744 if (is_bare_repository_cfg > 0) {
745 set_git_dir(offset == cwd->len ? gitdir : real_path(gitdir));
746 if (chdir(cwd->buf))
747 die_errno("Could not come back to cwd");
748 return NULL;
751 /* #0, #1, #5, #8, #9, #12, #13 */
752 set_git_work_tree(".");
753 if (strcmp(gitdir, DEFAULT_GIT_DIR_ENVIRONMENT))
754 set_git_dir(gitdir);
755 inside_git_dir = 0;
756 inside_work_tree = 1;
757 if (offset == cwd->len)
758 return NULL;
760 /* Make "offset" point past the '/' (already the case for root dirs) */
761 if (offset != offset_1st_component(cwd->buf))
762 offset++;
763 /* Add a '/' at the end */
764 strbuf_addch(cwd, '/');
765 return cwd->buf + offset;
768 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
769 static const char *setup_bare_git_dir(struct strbuf *cwd, int offset,
770 int *nongit_ok)
772 int root_len;
774 if (check_repository_format_gently(".", nongit_ok))
775 return NULL;
777 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
779 /* --work-tree is set without --git-dir; use discovered one */
780 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
781 static const char *gitdir;
783 gitdir = offset == cwd->len ? "." : xmemdupz(cwd->buf, offset);
784 if (chdir(cwd->buf))
785 die_errno("Could not come back to cwd");
786 return setup_explicit_git_dir(gitdir, cwd, nongit_ok);
789 inside_git_dir = 1;
790 inside_work_tree = 0;
791 if (offset != cwd->len) {
792 if (chdir(cwd->buf))
793 die_errno("Cannot come back to cwd");
794 root_len = offset_1st_component(cwd->buf);
795 strbuf_setlen(cwd, offset > root_len ? offset : root_len);
796 set_git_dir(cwd->buf);
798 else
799 set_git_dir(".");
800 return NULL;
803 static const char *setup_nongit(const char *cwd, int *nongit_ok)
805 if (!nongit_ok)
806 die(_("Not a git repository (or any of the parent directories): %s"), DEFAULT_GIT_DIR_ENVIRONMENT);
807 if (chdir(cwd))
808 die_errno(_("Cannot come back to cwd"));
809 *nongit_ok = 1;
810 return NULL;
813 static dev_t get_device_or_die(const char *path, const char *prefix, int prefix_len)
815 struct stat buf;
816 if (stat(path, &buf)) {
817 die_errno("failed to stat '%*s%s%s'",
818 prefix_len,
819 prefix ? prefix : "",
820 prefix ? "/" : "", path);
822 return buf.st_dev;
826 * A "string_list_each_func_t" function that canonicalizes an entry
827 * from GIT_CEILING_DIRECTORIES using real_path_if_valid(), or
828 * discards it if unusable. The presence of an empty entry in
829 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
830 * subsequent entries.
832 static int canonicalize_ceiling_entry(struct string_list_item *item,
833 void *cb_data)
835 int *empty_entry_found = cb_data;
836 char *ceil = item->string;
838 if (!*ceil) {
839 *empty_entry_found = 1;
840 return 0;
841 } else if (!is_absolute_path(ceil)) {
842 return 0;
843 } else if (*empty_entry_found) {
844 /* Keep entry but do not canonicalize it */
845 return 1;
846 } else {
847 char *real_path = real_pathdup(ceil, 0);
848 if (!real_path) {
849 return 0;
851 free(item->string);
852 item->string = real_path;
853 return 1;
857 enum discovery_result {
858 GIT_DIR_NONE = 0,
859 GIT_DIR_EXPLICIT,
860 GIT_DIR_DISCOVERED,
861 GIT_DIR_BARE,
862 /* these are errors */
863 GIT_DIR_HIT_CEILING = -1,
864 GIT_DIR_HIT_MOUNT_POINT = -2,
865 GIT_DIR_INVALID_GITFILE = -3
869 * We cannot decide in this function whether we are in the work tree or
870 * not, since the config can only be read _after_ this function was called.
872 * Also, we avoid changing any global state (such as the current working
873 * directory) to allow early callers.
875 * The directory where the search should start needs to be passed in via the
876 * `dir` parameter; upon return, the `dir` buffer will contain the path of
877 * the directory where the search ended, and `gitdir` will contain the path of
878 * the discovered .git/ directory, if any. If `gitdir` is not absolute, it
879 * is relative to `dir` (i.e. *not* necessarily the cwd).
881 static enum discovery_result setup_git_directory_gently_1(struct strbuf *dir,
882 struct strbuf *gitdir,
883 int die_on_error)
885 const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
886 struct string_list ceiling_dirs = STRING_LIST_INIT_DUP;
887 const char *gitdirenv;
888 int ceil_offset = -1, min_offset = has_dos_drive_prefix(dir->buf) ? 3 : 1;
889 dev_t current_device = 0;
890 int one_filesystem = 1;
893 * If GIT_DIR is set explicitly, we're not going
894 * to do any discovery, but we still do repository
895 * validation.
897 gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
898 if (gitdirenv) {
899 strbuf_addstr(gitdir, gitdirenv);
900 return GIT_DIR_EXPLICIT;
903 if (env_ceiling_dirs) {
904 int empty_entry_found = 0;
906 string_list_split(&ceiling_dirs, env_ceiling_dirs, PATH_SEP, -1);
907 filter_string_list(&ceiling_dirs, 0,
908 canonicalize_ceiling_entry, &empty_entry_found);
909 ceil_offset = longest_ancestor_length(dir->buf, &ceiling_dirs);
910 string_list_clear(&ceiling_dirs, 0);
913 if (ceil_offset < 0)
914 ceil_offset = min_offset - 2;
917 * Test in the following order (relative to the dir):
918 * - .git (file containing "gitdir: <path>")
919 * - .git/
920 * - ./ (bare)
921 * - ../.git
922 * - ../.git/
923 * - ../ (bare)
924 * - ../../.git/
925 * etc.
927 one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
928 if (one_filesystem)
929 current_device = get_device_or_die(dir->buf, NULL, 0);
930 for (;;) {
931 int offset = dir->len, error_code = 0;
933 if (offset > min_offset)
934 strbuf_addch(dir, '/');
935 strbuf_addstr(dir, DEFAULT_GIT_DIR_ENVIRONMENT);
936 gitdirenv = read_gitfile_gently(dir->buf, die_on_error ?
937 NULL : &error_code);
938 if (!gitdirenv) {
939 if (die_on_error ||
940 error_code == READ_GITFILE_ERR_NOT_A_FILE) {
941 /* NEEDSWORK: fail if .git is not file nor dir */
942 if (is_git_directory(dir->buf))
943 gitdirenv = DEFAULT_GIT_DIR_ENVIRONMENT;
944 } else if (error_code != READ_GITFILE_ERR_STAT_FAILED)
945 return GIT_DIR_INVALID_GITFILE;
947 strbuf_setlen(dir, offset);
948 if (gitdirenv) {
949 strbuf_addstr(gitdir, gitdirenv);
950 return GIT_DIR_DISCOVERED;
953 if (is_git_directory(dir->buf)) {
954 strbuf_addstr(gitdir, ".");
955 return GIT_DIR_BARE;
958 if (offset <= min_offset)
959 return GIT_DIR_HIT_CEILING;
961 while (--offset > ceil_offset && !is_dir_sep(dir->buf[offset]))
962 ; /* continue */
963 if (offset <= ceil_offset)
964 return GIT_DIR_HIT_CEILING;
966 strbuf_setlen(dir, offset > min_offset ? offset : min_offset);
967 if (one_filesystem &&
968 current_device != get_device_or_die(dir->buf, NULL, offset))
969 return GIT_DIR_HIT_MOUNT_POINT;
973 int discover_git_directory(struct strbuf *commondir,
974 struct strbuf *gitdir)
976 struct strbuf dir = STRBUF_INIT, err = STRBUF_INIT;
977 size_t gitdir_offset = gitdir->len, cwd_len;
978 size_t commondir_offset = commondir->len;
979 struct repository_format candidate;
981 if (strbuf_getcwd(&dir))
982 return -1;
984 cwd_len = dir.len;
985 if (setup_git_directory_gently_1(&dir, gitdir, 0) <= 0) {
986 strbuf_release(&dir);
987 return -1;
991 * The returned gitdir is relative to dir, and if dir does not reflect
992 * the current working directory, we simply make the gitdir absolute.
994 if (dir.len < cwd_len && !is_absolute_path(gitdir->buf + gitdir_offset)) {
995 /* Avoid a trailing "/." */
996 if (!strcmp(".", gitdir->buf + gitdir_offset))
997 strbuf_setlen(gitdir, gitdir_offset);
998 else
999 strbuf_addch(&dir, '/');
1000 strbuf_insert(gitdir, gitdir_offset, dir.buf, dir.len);
1003 get_common_dir(commondir, gitdir->buf + gitdir_offset);
1005 strbuf_reset(&dir);
1006 strbuf_addf(&dir, "%s/config", commondir->buf + commondir_offset);
1007 read_repository_format(&candidate, dir.buf);
1008 strbuf_release(&dir);
1010 if (verify_repository_format(&candidate, &err) < 0) {
1011 warning("ignoring git dir '%s': %s",
1012 gitdir->buf + gitdir_offset, err.buf);
1013 strbuf_release(&err);
1014 strbuf_setlen(commondir, commondir_offset);
1015 strbuf_setlen(gitdir, gitdir_offset);
1016 return -1;
1019 return 0;
1022 const char *setup_git_directory_gently(int *nongit_ok)
1024 static struct strbuf cwd = STRBUF_INIT;
1025 struct strbuf dir = STRBUF_INIT, gitdir = STRBUF_INIT;
1026 const char *prefix;
1029 * We may have read an incomplete configuration before
1030 * setting-up the git directory. If so, clear the cache so
1031 * that the next queries to the configuration reload complete
1032 * configuration (including the per-repo config file that we
1033 * ignored previously).
1035 git_config_clear();
1038 * Let's assume that we are in a git repository.
1039 * If it turns out later that we are somewhere else, the value will be
1040 * updated accordingly.
1042 if (nongit_ok)
1043 *nongit_ok = 0;
1045 if (strbuf_getcwd(&cwd))
1046 die_errno(_("Unable to read current working directory"));
1047 strbuf_addbuf(&dir, &cwd);
1049 switch (setup_git_directory_gently_1(&dir, &gitdir, 1)) {
1050 case GIT_DIR_NONE:
1051 prefix = NULL;
1052 break;
1053 case GIT_DIR_EXPLICIT:
1054 prefix = setup_explicit_git_dir(gitdir.buf, &cwd, nongit_ok);
1055 break;
1056 case GIT_DIR_DISCOVERED:
1057 if (dir.len < cwd.len && chdir(dir.buf))
1058 die(_("Cannot change to '%s'"), dir.buf);
1059 prefix = setup_discovered_git_dir(gitdir.buf, &cwd, dir.len,
1060 nongit_ok);
1061 break;
1062 case GIT_DIR_BARE:
1063 if (dir.len < cwd.len && chdir(dir.buf))
1064 die(_("Cannot change to '%s'"), dir.buf);
1065 prefix = setup_bare_git_dir(&cwd, dir.len, nongit_ok);
1066 break;
1067 case GIT_DIR_HIT_CEILING:
1068 prefix = setup_nongit(cwd.buf, nongit_ok);
1069 break;
1070 case GIT_DIR_HIT_MOUNT_POINT:
1071 if (nongit_ok) {
1072 *nongit_ok = 1;
1073 strbuf_release(&cwd);
1074 strbuf_release(&dir);
1075 return NULL;
1077 die(_("Not a git repository (or any parent up to mount point %s)\n"
1078 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set)."),
1079 dir.buf);
1080 default:
1081 die("BUG: unhandled setup_git_directory_1() result");
1084 if (prefix)
1085 setenv(GIT_PREFIX_ENVIRONMENT, prefix, 1);
1086 else
1087 setenv(GIT_PREFIX_ENVIRONMENT, "", 1);
1089 startup_info->have_repository = !nongit_ok || !*nongit_ok;
1090 startup_info->prefix = prefix;
1093 * Not all paths through the setup code will call 'set_git_dir()' (which
1094 * directly sets up the environment) so in order to guarantee that the
1095 * environment is in a consistent state after setup, explicitly setup
1096 * the environment if we have a repository.
1098 * NEEDSWORK: currently we allow bogus GIT_DIR values to be set in some
1099 * code paths so we also need to explicitly setup the environment if
1100 * the user has set GIT_DIR. It may be beneficial to disallow bogus
1101 * GIT_DIR values at some point in the future.
1103 if (startup_info->have_repository || getenv(GIT_DIR_ENVIRONMENT)) {
1104 if (!the_repository->gitdir) {
1105 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
1106 if (!gitdir)
1107 gitdir = DEFAULT_GIT_DIR_ENVIRONMENT;
1108 repo_set_gitdir(the_repository, gitdir);
1109 setup_git_env();
1113 strbuf_release(&dir);
1114 strbuf_release(&gitdir);
1116 return prefix;
1119 int git_config_perm(const char *var, const char *value)
1121 int i;
1122 char *endptr;
1124 if (value == NULL)
1125 return PERM_GROUP;
1127 if (!strcmp(value, "umask"))
1128 return PERM_UMASK;
1129 if (!strcmp(value, "group"))
1130 return PERM_GROUP;
1131 if (!strcmp(value, "all") ||
1132 !strcmp(value, "world") ||
1133 !strcmp(value, "everybody"))
1134 return PERM_EVERYBODY;
1136 /* Parse octal numbers */
1137 i = strtol(value, &endptr, 8);
1139 /* If not an octal number, maybe true/false? */
1140 if (*endptr != 0)
1141 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
1144 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
1145 * a chmod value to restrict to.
1147 switch (i) {
1148 case PERM_UMASK: /* 0 */
1149 return PERM_UMASK;
1150 case OLD_PERM_GROUP: /* 1 */
1151 return PERM_GROUP;
1152 case OLD_PERM_EVERYBODY: /* 2 */
1153 return PERM_EVERYBODY;
1156 /* A filemode value was given: 0xxx */
1158 if ((i & 0600) != 0600)
1159 die(_("Problem with core.sharedRepository filemode value "
1160 "(0%.3o).\nThe owner of files must always have "
1161 "read and write permissions."), i);
1164 * Mask filemode value. Others can not get write permission.
1165 * x flags for directories are handled separately.
1167 return -(i & 0666);
1170 void check_repository_format(void)
1172 check_repository_format_gently(get_git_dir(), NULL);
1173 startup_info->have_repository = 1;
1177 * Returns the "prefix", a path to the current working directory
1178 * relative to the work tree root, or NULL, if the current working
1179 * directory is not a strict subdirectory of the work tree root. The
1180 * prefix always ends with a '/' character.
1182 const char *setup_git_directory(void)
1184 return setup_git_directory_gently(NULL);
1187 const char *resolve_gitdir_gently(const char *suspect, int *return_error_code)
1189 if (is_git_directory(suspect))
1190 return suspect;
1191 return read_gitfile_gently(suspect, return_error_code);
1194 /* if any standard file descriptor is missing open it to /dev/null */
1195 void sanitize_stdfds(void)
1197 int fd = open("/dev/null", O_RDWR, 0);
1198 while (fd != -1 && fd < 2)
1199 fd = dup(fd);
1200 if (fd == -1)
1201 die_errno("open /dev/null or dup failed");
1202 if (fd > 2)
1203 close(fd);
1206 int daemonize(void)
1208 #ifdef NO_POSIX_GOODIES
1209 errno = ENOSYS;
1210 return -1;
1211 #else
1212 switch (fork()) {
1213 case 0:
1214 break;
1215 case -1:
1216 die_errno("fork failed");
1217 default:
1218 exit(0);
1220 if (setsid() == -1)
1221 die_errno("setsid failed");
1222 close(0);
1223 close(1);
1224 close(2);
1225 sanitize_stdfds();
1226 return 0;
1227 #endif