check_filename(): handle ":^" path magic
[git.git] / setup.c
blob86bb7c9a96a61ed6ed07aca8bc55bc2c078799c3
1 #include "cache.h"
2 #include "dir.h"
3 #include "string-list.h"
5 static int inside_git_dir = -1;
6 static int inside_work_tree = -1;
7 static int work_tree_config_is_bogus;
9 static struct startup_info the_startup_info;
10 struct startup_info *startup_info = &the_startup_info;
13 * The input parameter must contain an absolute path, and it must already be
14 * normalized.
16 * Find the part of an absolute path that lies inside the work tree by
17 * dereferencing symlinks outside the work tree, for example:
18 * /dir1/repo/dir2/file (work tree is /dir1/repo) -> dir2/file
19 * /dir/file (work tree is /) -> dir/file
20 * /dir/symlink1/symlink2 (symlink1 points to work tree) -> symlink2
21 * /dir/repolink/file (repolink points to /dir/repo) -> file
22 * /dir/repo (exactly equal to work tree) -> (empty string)
24 static int abspath_part_inside_repo(char *path)
26 size_t len;
27 size_t wtlen;
28 char *path0;
29 int off;
30 const char *work_tree = get_git_work_tree();
32 if (!work_tree)
33 return -1;
34 wtlen = strlen(work_tree);
35 len = strlen(path);
36 off = offset_1st_component(path);
38 /* check if work tree is already the prefix */
39 if (wtlen <= len && !strncmp(path, work_tree, wtlen)) {
40 if (path[wtlen] == '/') {
41 memmove(path, path + wtlen + 1, len - wtlen);
42 return 0;
43 } else if (path[wtlen - 1] == '/' || path[wtlen] == '\0') {
44 /* work tree is the root, or the whole path */
45 memmove(path, path + wtlen, len - wtlen + 1);
46 return 0;
48 /* work tree might match beginning of a symlink to work tree */
49 off = wtlen;
51 path0 = path;
52 path += off;
54 /* check each '/'-terminated level */
55 while (*path) {
56 path++;
57 if (*path == '/') {
58 *path = '\0';
59 if (strcmp(real_path(path0), work_tree) == 0) {
60 memmove(path0, path + 1, len - (path - path0));
61 return 0;
63 *path = '/';
67 /* check whole path */
68 if (strcmp(real_path(path0), work_tree) == 0) {
69 *path0 = '\0';
70 return 0;
73 return -1;
77 * Normalize "path", prepending the "prefix" for relative paths. If
78 * remaining_prefix is not NULL, return the actual prefix still
79 * remains in the path. For example, prefix = sub1/sub2/ and path is
81 * foo -> sub1/sub2/foo (full prefix)
82 * ../foo -> sub1/foo (remaining prefix is sub1/)
83 * ../../bar -> bar (no remaining prefix)
84 * ../../sub1/sub2/foo -> sub1/sub2/foo (but no remaining prefix)
85 * `pwd`/../bar -> sub1/bar (no remaining prefix)
87 char *prefix_path_gently(const char *prefix, int len,
88 int *remaining_prefix, const char *path)
90 const char *orig = path;
91 char *sanitized;
92 if (is_absolute_path(orig)) {
93 sanitized = xmallocz(strlen(path));
94 if (remaining_prefix)
95 *remaining_prefix = 0;
96 if (normalize_path_copy_len(sanitized, path, remaining_prefix)) {
97 free(sanitized);
98 return NULL;
100 if (abspath_part_inside_repo(sanitized)) {
101 free(sanitized);
102 return NULL;
104 } else {
105 sanitized = xstrfmt("%.*s%s", len, len ? prefix : "", path);
106 if (remaining_prefix)
107 *remaining_prefix = len;
108 if (normalize_path_copy_len(sanitized, sanitized, remaining_prefix)) {
109 free(sanitized);
110 return NULL;
113 return sanitized;
116 char *prefix_path(const char *prefix, int len, const char *path)
118 char *r = prefix_path_gently(prefix, len, NULL, path);
119 if (!r)
120 die("'%s' is outside repository", path);
121 return r;
124 int path_inside_repo(const char *prefix, const char *path)
126 int len = prefix ? strlen(prefix) : 0;
127 char *r = prefix_path_gently(prefix, len, NULL, path);
128 if (r) {
129 free(r);
130 return 1;
132 return 0;
135 int check_filename(const char *prefix, const char *arg)
137 char *to_free = NULL;
138 struct stat st;
140 if (skip_prefix(arg, ":/", &arg)) {
141 if (!*arg) /* ":/" is root dir, always exists */
142 return 1;
143 prefix = NULL;
144 } else if (skip_prefix(arg, ":!", &arg) ||
145 skip_prefix(arg, ":^", &arg)) {
146 if (!*arg) /* excluding everything is silly, but allowed */
147 return 1;
150 if (prefix)
151 arg = to_free = prefix_filename(prefix, arg);
153 if (!lstat(arg, &st)) {
154 free(to_free);
155 return 1; /* file exists */
157 if (errno == ENOENT || errno == ENOTDIR) {
158 free(to_free);
159 return 0; /* file does not exist */
161 die_errno("failed to stat '%s'", arg);
164 static void NORETURN die_verify_filename(const char *prefix,
165 const char *arg,
166 int diagnose_misspelt_rev)
168 if (!diagnose_misspelt_rev)
169 die(_("%s: no such path in the working tree.\n"
170 "Use 'git <command> -- <path>...' to specify paths that do not exist locally."),
171 arg);
173 * Saying "'(icase)foo' does not exist in the index" when the
174 * user gave us ":(icase)foo" is just stupid. A magic pathspec
175 * begins with a colon and is followed by a non-alnum; do not
176 * let maybe_die_on_misspelt_object_name() even trigger.
178 if (!(arg[0] == ':' && !isalnum(arg[1])))
179 maybe_die_on_misspelt_object_name(arg, prefix);
181 /* ... or fall back the most general message. */
182 die(_("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
183 "Use '--' to separate paths from revisions, like this:\n"
184 "'git <command> [<revision>...] -- [<file>...]'"), arg);
189 * Verify a filename that we got as an argument for a pathspec
190 * entry. Note that a filename that begins with "-" never verifies
191 * as true, because even if such a filename were to exist, we want
192 * it to be preceded by the "--" marker (or we want the user to
193 * use a format like "./-filename")
195 * The "diagnose_misspelt_rev" is used to provide a user-friendly
196 * diagnosis when dying upon finding that "name" is not a pathname.
197 * If set to 1, the diagnosis will try to diagnose "name" as an
198 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
199 * will only complain about an inexisting file.
201 * This function is typically called to check that a "file or rev"
202 * argument is unambiguous. In this case, the caller will want
203 * diagnose_misspelt_rev == 1 when verifying the first non-rev
204 * argument (which could have been a revision), and
205 * diagnose_misspelt_rev == 0 for the next ones (because we already
206 * saw a filename, there's not ambiguity anymore).
208 void verify_filename(const char *prefix,
209 const char *arg,
210 int diagnose_misspelt_rev)
212 if (*arg == '-')
213 die("bad flag '%s' used after filename", arg);
214 if (check_filename(prefix, arg) || !no_wildcard(arg))
215 return;
216 die_verify_filename(prefix, arg, diagnose_misspelt_rev);
220 * Opposite of the above: the command line did not have -- marker
221 * and we parsed the arg as a refname. It should not be interpretable
222 * as a filename.
224 void verify_non_filename(const char *prefix, const char *arg)
226 if (!is_inside_work_tree() || is_inside_git_dir())
227 return;
228 if (*arg == '-')
229 return; /* flag */
230 if (!check_filename(prefix, arg))
231 return;
232 die(_("ambiguous argument '%s': both revision and filename\n"
233 "Use '--' to separate paths from revisions, like this:\n"
234 "'git <command> [<revision>...] -- [<file>...]'"), arg);
237 int get_common_dir(struct strbuf *sb, const char *gitdir)
239 const char *git_env_common_dir = getenv(GIT_COMMON_DIR_ENVIRONMENT);
240 if (git_env_common_dir) {
241 strbuf_addstr(sb, git_env_common_dir);
242 return 1;
243 } else {
244 return get_common_dir_noenv(sb, gitdir);
248 int get_common_dir_noenv(struct strbuf *sb, const char *gitdir)
250 struct strbuf data = STRBUF_INIT;
251 struct strbuf path = STRBUF_INIT;
252 int ret = 0;
254 strbuf_addf(&path, "%s/commondir", gitdir);
255 if (file_exists(path.buf)) {
256 if (strbuf_read_file(&data, path.buf, 0) <= 0)
257 die_errno(_("failed to read %s"), path.buf);
258 while (data.len && (data.buf[data.len - 1] == '\n' ||
259 data.buf[data.len - 1] == '\r'))
260 data.len--;
261 data.buf[data.len] = '\0';
262 strbuf_reset(&path);
263 if (!is_absolute_path(data.buf))
264 strbuf_addf(&path, "%s/", gitdir);
265 strbuf_addbuf(&path, &data);
266 strbuf_add_real_path(sb, path.buf);
267 ret = 1;
268 } else {
269 strbuf_addstr(sb, gitdir);
272 strbuf_release(&data);
273 strbuf_release(&path);
274 return ret;
278 * Test if it looks like we're at a git directory.
279 * We want to see:
281 * - either an objects/ directory _or_ the proper
282 * GIT_OBJECT_DIRECTORY environment variable
283 * - a refs/ directory
284 * - either a HEAD symlink or a HEAD file that is formatted as
285 * a proper "ref:", or a regular file HEAD that has a properly
286 * formatted sha1 object name.
288 int is_git_directory(const char *suspect)
290 struct strbuf path = STRBUF_INIT;
291 int ret = 0;
292 size_t len;
294 /* Check worktree-related signatures */
295 strbuf_addf(&path, "%s/HEAD", suspect);
296 if (validate_headref(path.buf))
297 goto done;
299 strbuf_reset(&path);
300 get_common_dir(&path, suspect);
301 len = path.len;
303 /* Check non-worktree-related signatures */
304 if (getenv(DB_ENVIRONMENT)) {
305 if (access(getenv(DB_ENVIRONMENT), X_OK))
306 goto done;
308 else {
309 strbuf_setlen(&path, len);
310 strbuf_addstr(&path, "/objects");
311 if (access(path.buf, X_OK))
312 goto done;
315 strbuf_setlen(&path, len);
316 strbuf_addstr(&path, "/refs");
317 if (access(path.buf, X_OK))
318 goto done;
320 ret = 1;
321 done:
322 strbuf_release(&path);
323 return ret;
326 int is_nonbare_repository_dir(struct strbuf *path)
328 int ret = 0;
329 int gitfile_error;
330 size_t orig_path_len = path->len;
331 assert(orig_path_len != 0);
332 strbuf_complete(path, '/');
333 strbuf_addstr(path, ".git");
334 if (read_gitfile_gently(path->buf, &gitfile_error) || is_git_directory(path->buf))
335 ret = 1;
336 if (gitfile_error == READ_GITFILE_ERR_OPEN_FAILED ||
337 gitfile_error == READ_GITFILE_ERR_READ_FAILED)
338 ret = 1;
339 strbuf_setlen(path, orig_path_len);
340 return ret;
343 int is_inside_git_dir(void)
345 if (inside_git_dir < 0)
346 inside_git_dir = is_inside_dir(get_git_dir());
347 return inside_git_dir;
350 int is_inside_work_tree(void)
352 if (inside_work_tree < 0)
353 inside_work_tree = is_inside_dir(get_git_work_tree());
354 return inside_work_tree;
357 void setup_work_tree(void)
359 const char *work_tree, *git_dir;
360 static int initialized = 0;
362 if (initialized)
363 return;
365 if (work_tree_config_is_bogus)
366 die("unable to set up work tree using invalid config");
368 work_tree = get_git_work_tree();
369 git_dir = get_git_dir();
370 if (!is_absolute_path(git_dir))
371 git_dir = real_path(get_git_dir());
372 if (!work_tree || chdir(work_tree))
373 die("This operation must be run in a work tree");
376 * Make sure subsequent git processes find correct worktree
377 * if $GIT_WORK_TREE is set relative
379 if (getenv(GIT_WORK_TREE_ENVIRONMENT))
380 setenv(GIT_WORK_TREE_ENVIRONMENT, ".", 1);
382 set_git_dir(remove_leading_path(git_dir, work_tree));
383 initialized = 1;
386 static int check_repo_format(const char *var, const char *value, void *vdata)
388 struct repository_format *data = vdata;
389 const char *ext;
391 if (strcmp(var, "core.repositoryformatversion") == 0)
392 data->version = git_config_int(var, value);
393 else if (skip_prefix(var, "extensions.", &ext)) {
395 * record any known extensions here; otherwise,
396 * we fall through to recording it as unknown, and
397 * check_repository_format will complain
399 if (!strcmp(ext, "noop"))
401 else if (!strcmp(ext, "preciousobjects"))
402 data->precious_objects = git_config_bool(var, value);
403 else
404 string_list_append(&data->unknown_extensions, ext);
405 } else if (strcmp(var, "core.bare") == 0) {
406 data->is_bare = git_config_bool(var, value);
407 } else if (strcmp(var, "core.worktree") == 0) {
408 if (!value)
409 return config_error_nonbool(var);
410 data->work_tree = xstrdup(value);
412 return 0;
415 static int check_repository_format_gently(const char *gitdir, int *nongit_ok)
417 struct strbuf sb = STRBUF_INIT;
418 struct strbuf err = STRBUF_INIT;
419 struct repository_format candidate;
420 int has_common;
422 has_common = get_common_dir(&sb, gitdir);
423 strbuf_addstr(&sb, "/config");
424 read_repository_format(&candidate, sb.buf);
425 strbuf_release(&sb);
428 * For historical use of check_repository_format() in git-init,
429 * we treat a missing config as a silent "ok", even when nongit_ok
430 * is unset.
432 if (candidate.version < 0)
433 return 0;
435 if (verify_repository_format(&candidate, &err) < 0) {
436 if (nongit_ok) {
437 warning("%s", err.buf);
438 strbuf_release(&err);
439 *nongit_ok = -1;
440 return -1;
442 die("%s", err.buf);
445 repository_format_precious_objects = candidate.precious_objects;
446 string_list_clear(&candidate.unknown_extensions, 0);
447 if (!has_common) {
448 if (candidate.is_bare != -1) {
449 is_bare_repository_cfg = candidate.is_bare;
450 if (is_bare_repository_cfg == 1)
451 inside_work_tree = -1;
453 if (candidate.work_tree) {
454 free(git_work_tree_cfg);
455 git_work_tree_cfg = candidate.work_tree;
456 inside_work_tree = -1;
458 } else {
459 free(candidate.work_tree);
462 return 0;
465 int read_repository_format(struct repository_format *format, const char *path)
467 memset(format, 0, sizeof(*format));
468 format->version = -1;
469 format->is_bare = -1;
470 string_list_init(&format->unknown_extensions, 1);
471 git_config_from_file(check_repo_format, path, format);
472 return format->version;
475 int verify_repository_format(const struct repository_format *format,
476 struct strbuf *err)
478 if (GIT_REPO_VERSION_READ < format->version) {
479 strbuf_addf(err, _("Expected git repo version <= %d, found %d"),
480 GIT_REPO_VERSION_READ, format->version);
481 return -1;
484 if (format->version >= 1 && format->unknown_extensions.nr) {
485 int i;
487 strbuf_addstr(err, _("unknown repository extensions found:"));
489 for (i = 0; i < format->unknown_extensions.nr; i++)
490 strbuf_addf(err, "\n\t%s",
491 format->unknown_extensions.items[i].string);
492 return -1;
495 return 0;
498 void read_gitfile_error_die(int error_code, const char *path, const char *dir)
500 switch (error_code) {
501 case READ_GITFILE_ERR_STAT_FAILED:
502 case READ_GITFILE_ERR_NOT_A_FILE:
503 /* non-fatal; follow return path */
504 break;
505 case READ_GITFILE_ERR_OPEN_FAILED:
506 die_errno("Error opening '%s'", path);
507 case READ_GITFILE_ERR_TOO_LARGE:
508 die("Too large to be a .git file: '%s'", path);
509 case READ_GITFILE_ERR_READ_FAILED:
510 die("Error reading %s", path);
511 case READ_GITFILE_ERR_INVALID_FORMAT:
512 die("Invalid gitfile format: %s", path);
513 case READ_GITFILE_ERR_NO_PATH:
514 die("No path in gitfile: %s", path);
515 case READ_GITFILE_ERR_NOT_A_REPO:
516 die("Not a git repository: %s", dir);
517 default:
518 die("BUG: unknown error code");
523 * Try to read the location of the git directory from the .git file,
524 * return path to git directory if found.
526 * On failure, if return_error_code is not NULL, return_error_code
527 * will be set to an error code and NULL will be returned. If
528 * return_error_code is NULL the function will die instead (for most
529 * cases).
531 const char *read_gitfile_gently(const char *path, int *return_error_code)
533 const int max_file_size = 1 << 20; /* 1MB */
534 int error_code = 0;
535 char *buf = NULL;
536 char *dir = NULL;
537 const char *slash;
538 struct stat st;
539 int fd;
540 ssize_t len;
542 if (stat(path, &st)) {
543 /* NEEDSWORK: discern between ENOENT vs other errors */
544 error_code = READ_GITFILE_ERR_STAT_FAILED;
545 goto cleanup_return;
547 if (!S_ISREG(st.st_mode)) {
548 error_code = READ_GITFILE_ERR_NOT_A_FILE;
549 goto cleanup_return;
551 if (st.st_size > max_file_size) {
552 error_code = READ_GITFILE_ERR_TOO_LARGE;
553 goto cleanup_return;
555 fd = open(path, O_RDONLY);
556 if (fd < 0) {
557 error_code = READ_GITFILE_ERR_OPEN_FAILED;
558 goto cleanup_return;
560 buf = xmallocz(st.st_size);
561 len = read_in_full(fd, buf, st.st_size);
562 close(fd);
563 if (len != st.st_size) {
564 error_code = READ_GITFILE_ERR_READ_FAILED;
565 goto cleanup_return;
567 if (!starts_with(buf, "gitdir: ")) {
568 error_code = READ_GITFILE_ERR_INVALID_FORMAT;
569 goto cleanup_return;
571 while (buf[len - 1] == '\n' || buf[len - 1] == '\r')
572 len--;
573 if (len < 9) {
574 error_code = READ_GITFILE_ERR_NO_PATH;
575 goto cleanup_return;
577 buf[len] = '\0';
578 dir = buf + 8;
580 if (!is_absolute_path(dir) && (slash = strrchr(path, '/'))) {
581 size_t pathlen = slash+1 - path;
582 dir = xstrfmt("%.*s%.*s", (int)pathlen, path,
583 (int)(len - 8), buf + 8);
584 free(buf);
585 buf = dir;
587 if (!is_git_directory(dir)) {
588 error_code = READ_GITFILE_ERR_NOT_A_REPO;
589 goto cleanup_return;
591 path = real_path(dir);
593 cleanup_return:
594 if (return_error_code)
595 *return_error_code = error_code;
596 else if (error_code)
597 read_gitfile_error_die(error_code, path, dir);
599 free(buf);
600 return error_code ? NULL : path;
603 static const char *setup_explicit_git_dir(const char *gitdirenv,
604 struct strbuf *cwd,
605 int *nongit_ok)
607 const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
608 const char *worktree;
609 char *gitfile;
610 int offset;
612 if (PATH_MAX - 40 < strlen(gitdirenv))
613 die("'$%s' too big", GIT_DIR_ENVIRONMENT);
615 gitfile = (char*)read_gitfile(gitdirenv);
616 if (gitfile) {
617 gitfile = xstrdup(gitfile);
618 gitdirenv = gitfile;
621 if (!is_git_directory(gitdirenv)) {
622 if (nongit_ok) {
623 *nongit_ok = 1;
624 free(gitfile);
625 return NULL;
627 die("Not a git repository: '%s'", gitdirenv);
630 if (check_repository_format_gently(gitdirenv, nongit_ok)) {
631 free(gitfile);
632 return NULL;
635 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
636 if (work_tree_env)
637 set_git_work_tree(work_tree_env);
638 else if (is_bare_repository_cfg > 0) {
639 if (git_work_tree_cfg) {
640 /* #22.2, #30 */
641 warning("core.bare and core.worktree do not make sense");
642 work_tree_config_is_bogus = 1;
645 /* #18, #26 */
646 set_git_dir(gitdirenv);
647 free(gitfile);
648 return NULL;
650 else if (git_work_tree_cfg) { /* #6, #14 */
651 if (is_absolute_path(git_work_tree_cfg))
652 set_git_work_tree(git_work_tree_cfg);
653 else {
654 char *core_worktree;
655 if (chdir(gitdirenv))
656 die_errno("Could not chdir to '%s'", gitdirenv);
657 if (chdir(git_work_tree_cfg))
658 die_errno("Could not chdir to '%s'", git_work_tree_cfg);
659 core_worktree = xgetcwd();
660 if (chdir(cwd->buf))
661 die_errno("Could not come back to cwd");
662 set_git_work_tree(core_worktree);
663 free(core_worktree);
666 else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, 1)) {
667 /* #16d */
668 set_git_dir(gitdirenv);
669 free(gitfile);
670 return NULL;
672 else /* #2, #10 */
673 set_git_work_tree(".");
675 /* set_git_work_tree() must have been called by now */
676 worktree = get_git_work_tree();
678 /* both get_git_work_tree() and cwd are already normalized */
679 if (!strcmp(cwd->buf, worktree)) { /* cwd == worktree */
680 set_git_dir(gitdirenv);
681 free(gitfile);
682 return NULL;
685 offset = dir_inside_of(cwd->buf, worktree);
686 if (offset >= 0) { /* cwd inside worktree? */
687 set_git_dir(real_path(gitdirenv));
688 if (chdir(worktree))
689 die_errno("Could not chdir to '%s'", worktree);
690 strbuf_addch(cwd, '/');
691 free(gitfile);
692 return cwd->buf + offset;
695 /* cwd outside worktree */
696 set_git_dir(gitdirenv);
697 free(gitfile);
698 return NULL;
701 static const char *setup_discovered_git_dir(const char *gitdir,
702 struct strbuf *cwd, int offset,
703 int *nongit_ok)
705 if (check_repository_format_gently(gitdir, nongit_ok))
706 return NULL;
708 /* --work-tree is set without --git-dir; use discovered one */
709 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
710 if (offset != cwd->len && !is_absolute_path(gitdir))
711 gitdir = real_pathdup(gitdir, 1);
712 if (chdir(cwd->buf))
713 die_errno("Could not come back to cwd");
714 return setup_explicit_git_dir(gitdir, cwd, nongit_ok);
717 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
718 if (is_bare_repository_cfg > 0) {
719 set_git_dir(offset == cwd->len ? gitdir : real_path(gitdir));
720 if (chdir(cwd->buf))
721 die_errno("Could not come back to cwd");
722 return NULL;
725 /* #0, #1, #5, #8, #9, #12, #13 */
726 set_git_work_tree(".");
727 if (strcmp(gitdir, DEFAULT_GIT_DIR_ENVIRONMENT))
728 set_git_dir(gitdir);
729 inside_git_dir = 0;
730 inside_work_tree = 1;
731 if (offset == cwd->len)
732 return NULL;
734 /* Make "offset" point past the '/' (already the case for root dirs) */
735 if (offset != offset_1st_component(cwd->buf))
736 offset++;
737 /* Add a '/' at the end */
738 strbuf_addch(cwd, '/');
739 return cwd->buf + offset;
742 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
743 static const char *setup_bare_git_dir(struct strbuf *cwd, int offset,
744 int *nongit_ok)
746 int root_len;
748 if (check_repository_format_gently(".", nongit_ok))
749 return NULL;
751 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
753 /* --work-tree is set without --git-dir; use discovered one */
754 if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
755 const char *gitdir;
757 gitdir = offset == cwd->len ? "." : xmemdupz(cwd->buf, offset);
758 if (chdir(cwd->buf))
759 die_errno("Could not come back to cwd");
760 return setup_explicit_git_dir(gitdir, cwd, nongit_ok);
763 inside_git_dir = 1;
764 inside_work_tree = 0;
765 if (offset != cwd->len) {
766 if (chdir(cwd->buf))
767 die_errno("Cannot come back to cwd");
768 root_len = offset_1st_component(cwd->buf);
769 strbuf_setlen(cwd, offset > root_len ? offset : root_len);
770 set_git_dir(cwd->buf);
772 else
773 set_git_dir(".");
774 return NULL;
777 static const char *setup_nongit(const char *cwd, int *nongit_ok)
779 if (!nongit_ok)
780 die(_("Not a git repository (or any of the parent directories): %s"), DEFAULT_GIT_DIR_ENVIRONMENT);
781 if (chdir(cwd))
782 die_errno(_("Cannot come back to cwd"));
783 *nongit_ok = 1;
784 return NULL;
787 static dev_t get_device_or_die(const char *path, const char *prefix, int prefix_len)
789 struct stat buf;
790 if (stat(path, &buf)) {
791 die_errno("failed to stat '%*s%s%s'",
792 prefix_len,
793 prefix ? prefix : "",
794 prefix ? "/" : "", path);
796 return buf.st_dev;
800 * A "string_list_each_func_t" function that canonicalizes an entry
801 * from GIT_CEILING_DIRECTORIES using real_path_if_valid(), or
802 * discards it if unusable. The presence of an empty entry in
803 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
804 * subsequent entries.
806 static int canonicalize_ceiling_entry(struct string_list_item *item,
807 void *cb_data)
809 int *empty_entry_found = cb_data;
810 char *ceil = item->string;
812 if (!*ceil) {
813 *empty_entry_found = 1;
814 return 0;
815 } else if (!is_absolute_path(ceil)) {
816 return 0;
817 } else if (*empty_entry_found) {
818 /* Keep entry but do not canonicalize it */
819 return 1;
820 } else {
821 char *real_path = real_pathdup(ceil, 0);
822 if (!real_path) {
823 return 0;
825 free(item->string);
826 item->string = real_path;
827 return 1;
831 enum discovery_result {
832 GIT_DIR_NONE = 0,
833 GIT_DIR_EXPLICIT,
834 GIT_DIR_DISCOVERED,
835 GIT_DIR_BARE,
836 /* these are errors */
837 GIT_DIR_HIT_CEILING = -1,
838 GIT_DIR_HIT_MOUNT_POINT = -2,
839 GIT_DIR_INVALID_GITFILE = -3
843 * We cannot decide in this function whether we are in the work tree or
844 * not, since the config can only be read _after_ this function was called.
846 * Also, we avoid changing any global state (such as the current working
847 * directory) to allow early callers.
849 * The directory where the search should start needs to be passed in via the
850 * `dir` parameter; upon return, the `dir` buffer will contain the path of
851 * the directory where the search ended, and `gitdir` will contain the path of
852 * the discovered .git/ directory, if any. If `gitdir` is not absolute, it
853 * is relative to `dir` (i.e. *not* necessarily the cwd).
855 static enum discovery_result setup_git_directory_gently_1(struct strbuf *dir,
856 struct strbuf *gitdir,
857 int die_on_error)
859 const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
860 struct string_list ceiling_dirs = STRING_LIST_INIT_DUP;
861 const char *gitdirenv;
862 int ceil_offset = -1, min_offset = has_dos_drive_prefix(dir->buf) ? 3 : 1;
863 dev_t current_device = 0;
864 int one_filesystem = 1;
867 * If GIT_DIR is set explicitly, we're not going
868 * to do any discovery, but we still do repository
869 * validation.
871 gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
872 if (gitdirenv) {
873 strbuf_addstr(gitdir, gitdirenv);
874 return GIT_DIR_EXPLICIT;
877 if (env_ceiling_dirs) {
878 int empty_entry_found = 0;
880 string_list_split(&ceiling_dirs, env_ceiling_dirs, PATH_SEP, -1);
881 filter_string_list(&ceiling_dirs, 0,
882 canonicalize_ceiling_entry, &empty_entry_found);
883 ceil_offset = longest_ancestor_length(dir->buf, &ceiling_dirs);
884 string_list_clear(&ceiling_dirs, 0);
887 if (ceil_offset < 0)
888 ceil_offset = min_offset - 2;
891 * Test in the following order (relative to the dir):
892 * - .git (file containing "gitdir: <path>")
893 * - .git/
894 * - ./ (bare)
895 * - ../.git
896 * - ../.git/
897 * - ../ (bare)
898 * - ../../.git/
899 * etc.
901 one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
902 if (one_filesystem)
903 current_device = get_device_or_die(dir->buf, NULL, 0);
904 for (;;) {
905 int offset = dir->len, error_code = 0;
907 if (offset > min_offset)
908 strbuf_addch(dir, '/');
909 strbuf_addstr(dir, DEFAULT_GIT_DIR_ENVIRONMENT);
910 gitdirenv = read_gitfile_gently(dir->buf, die_on_error ?
911 NULL : &error_code);
912 if (!gitdirenv) {
913 if (die_on_error ||
914 error_code == READ_GITFILE_ERR_NOT_A_FILE) {
915 /* NEEDSWORK: fail if .git is not file nor dir */
916 if (is_git_directory(dir->buf))
917 gitdirenv = DEFAULT_GIT_DIR_ENVIRONMENT;
918 } else if (error_code != READ_GITFILE_ERR_STAT_FAILED)
919 return GIT_DIR_INVALID_GITFILE;
921 strbuf_setlen(dir, offset);
922 if (gitdirenv) {
923 strbuf_addstr(gitdir, gitdirenv);
924 return GIT_DIR_DISCOVERED;
927 if (is_git_directory(dir->buf)) {
928 strbuf_addstr(gitdir, ".");
929 return GIT_DIR_BARE;
932 if (offset <= min_offset)
933 return GIT_DIR_HIT_CEILING;
935 while (--offset > ceil_offset && !is_dir_sep(dir->buf[offset]))
936 ; /* continue */
937 if (offset <= ceil_offset)
938 return GIT_DIR_HIT_CEILING;
940 strbuf_setlen(dir, offset > min_offset ? offset : min_offset);
941 if (one_filesystem &&
942 current_device != get_device_or_die(dir->buf, NULL, offset))
943 return GIT_DIR_HIT_MOUNT_POINT;
947 const char *discover_git_directory(struct strbuf *gitdir)
949 struct strbuf dir = STRBUF_INIT, err = STRBUF_INIT;
950 size_t gitdir_offset = gitdir->len, cwd_len;
951 struct repository_format candidate;
953 if (strbuf_getcwd(&dir))
954 return NULL;
956 cwd_len = dir.len;
957 if (setup_git_directory_gently_1(&dir, gitdir, 0) <= 0) {
958 strbuf_release(&dir);
959 return NULL;
963 * The returned gitdir is relative to dir, and if dir does not reflect
964 * the current working directory, we simply make the gitdir absolute.
966 if (dir.len < cwd_len && !is_absolute_path(gitdir->buf + gitdir_offset)) {
967 /* Avoid a trailing "/." */
968 if (!strcmp(".", gitdir->buf + gitdir_offset))
969 strbuf_setlen(gitdir, gitdir_offset);
970 else
971 strbuf_addch(&dir, '/');
972 strbuf_insert(gitdir, gitdir_offset, dir.buf, dir.len);
975 strbuf_reset(&dir);
976 strbuf_addf(&dir, "%s/config", gitdir->buf + gitdir_offset);
977 read_repository_format(&candidate, dir.buf);
978 strbuf_release(&dir);
980 if (verify_repository_format(&candidate, &err) < 0) {
981 warning("ignoring git dir '%s': %s",
982 gitdir->buf + gitdir_offset, err.buf);
983 strbuf_release(&err);
984 return NULL;
987 return gitdir->buf + gitdir_offset;
990 const char *setup_git_directory_gently(int *nongit_ok)
992 static struct strbuf cwd = STRBUF_INIT;
993 struct strbuf dir = STRBUF_INIT, gitdir = STRBUF_INIT;
994 const char *prefix, *env_prefix;
997 * We may have read an incomplete configuration before
998 * setting-up the git directory. If so, clear the cache so
999 * that the next queries to the configuration reload complete
1000 * configuration (including the per-repo config file that we
1001 * ignored previously).
1003 git_config_clear();
1006 * Let's assume that we are in a git repository.
1007 * If it turns out later that we are somewhere else, the value will be
1008 * updated accordingly.
1010 if (nongit_ok)
1011 *nongit_ok = 0;
1013 if (strbuf_getcwd(&cwd))
1014 die_errno(_("Unable to read current working directory"));
1015 strbuf_addbuf(&dir, &cwd);
1017 switch (setup_git_directory_gently_1(&dir, &gitdir, 1)) {
1018 case GIT_DIR_NONE:
1019 prefix = NULL;
1020 break;
1021 case GIT_DIR_EXPLICIT:
1022 prefix = setup_explicit_git_dir(gitdir.buf, &cwd, nongit_ok);
1023 break;
1024 case GIT_DIR_DISCOVERED:
1025 if (dir.len < cwd.len && chdir(dir.buf))
1026 die(_("Cannot change to '%s'"), dir.buf);
1027 prefix = setup_discovered_git_dir(gitdir.buf, &cwd, dir.len,
1028 nongit_ok);
1029 break;
1030 case GIT_DIR_BARE:
1031 if (dir.len < cwd.len && chdir(dir.buf))
1032 die(_("Cannot change to '%s'"), dir.buf);
1033 prefix = setup_bare_git_dir(&cwd, dir.len, nongit_ok);
1034 break;
1035 case GIT_DIR_HIT_CEILING:
1036 prefix = setup_nongit(cwd.buf, nongit_ok);
1037 break;
1038 case GIT_DIR_HIT_MOUNT_POINT:
1039 if (nongit_ok) {
1040 *nongit_ok = 1;
1041 strbuf_release(&cwd);
1042 strbuf_release(&dir);
1043 return NULL;
1045 die(_("Not a git repository (or any parent up to mount point %s)\n"
1046 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set)."),
1047 dir.buf);
1048 default:
1049 die("BUG: unhandled setup_git_directory_1() result");
1052 env_prefix = getenv(GIT_TOPLEVEL_PREFIX_ENVIRONMENT);
1053 if (env_prefix)
1054 prefix = env_prefix;
1056 if (prefix)
1057 setenv(GIT_PREFIX_ENVIRONMENT, prefix, 1);
1058 else
1059 setenv(GIT_PREFIX_ENVIRONMENT, "", 1);
1061 startup_info->have_repository = !nongit_ok || !*nongit_ok;
1062 startup_info->prefix = prefix;
1064 strbuf_release(&dir);
1065 strbuf_release(&gitdir);
1067 return prefix;
1070 int git_config_perm(const char *var, const char *value)
1072 int i;
1073 char *endptr;
1075 if (value == NULL)
1076 return PERM_GROUP;
1078 if (!strcmp(value, "umask"))
1079 return PERM_UMASK;
1080 if (!strcmp(value, "group"))
1081 return PERM_GROUP;
1082 if (!strcmp(value, "all") ||
1083 !strcmp(value, "world") ||
1084 !strcmp(value, "everybody"))
1085 return PERM_EVERYBODY;
1087 /* Parse octal numbers */
1088 i = strtol(value, &endptr, 8);
1090 /* If not an octal number, maybe true/false? */
1091 if (*endptr != 0)
1092 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
1095 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
1096 * a chmod value to restrict to.
1098 switch (i) {
1099 case PERM_UMASK: /* 0 */
1100 return PERM_UMASK;
1101 case OLD_PERM_GROUP: /* 1 */
1102 return PERM_GROUP;
1103 case OLD_PERM_EVERYBODY: /* 2 */
1104 return PERM_EVERYBODY;
1107 /* A filemode value was given: 0xxx */
1109 if ((i & 0600) != 0600)
1110 die(_("Problem with core.sharedRepository filemode value "
1111 "(0%.3o).\nThe owner of files must always have "
1112 "read and write permissions."), i);
1115 * Mask filemode value. Others can not get write permission.
1116 * x flags for directories are handled separately.
1118 return -(i & 0666);
1121 void check_repository_format(void)
1123 check_repository_format_gently(get_git_dir(), NULL);
1124 startup_info->have_repository = 1;
1128 * Returns the "prefix", a path to the current working directory
1129 * relative to the work tree root, or NULL, if the current working
1130 * directory is not a strict subdirectory of the work tree root. The
1131 * prefix always ends with a '/' character.
1133 const char *setup_git_directory(void)
1135 return setup_git_directory_gently(NULL);
1138 const char *resolve_gitdir_gently(const char *suspect, int *return_error_code)
1140 if (is_git_directory(suspect))
1141 return suspect;
1142 return read_gitfile_gently(suspect, return_error_code);
1145 /* if any standard file descriptor is missing open it to /dev/null */
1146 void sanitize_stdfds(void)
1148 int fd = open("/dev/null", O_RDWR, 0);
1149 while (fd != -1 && fd < 2)
1150 fd = dup(fd);
1151 if (fd == -1)
1152 die_errno("open /dev/null or dup failed");
1153 if (fd > 2)
1154 close(fd);
1157 int daemonize(void)
1159 #ifdef NO_POSIX_GOODIES
1160 errno = ENOSYS;
1161 return -1;
1162 #else
1163 switch (fork()) {
1164 case 0:
1165 break;
1166 case -1:
1167 die_errno("fork failed");
1168 default:
1169 exit(0);
1171 if (setsid() == -1)
1172 die_errno("setsid failed");
1173 close(0);
1174 close(1);
1175 close(2);
1176 sanitize_stdfds();
1177 return 0;
1178 #endif