3 #include "string-list.h"
5 static int inside_git_dir
= -1;
6 static int inside_work_tree
= -1;
9 * Normalize "path", prepending the "prefix" for relative paths. If
10 * remaining_prefix is not NULL, return the actual prefix still
11 * remains in the path. For example, prefix = sub1/sub2/ and path is
13 * foo -> sub1/sub2/foo (full prefix)
14 * ../foo -> sub1/foo (remaining prefix is sub1/)
15 * ../../bar -> bar (no remaining prefix)
16 * ../../sub1/sub2/foo -> sub1/sub2/foo (but no remaining prefix)
17 * `pwd`/../bar -> sub1/bar (no remaining prefix)
19 char *prefix_path_gently(const char *prefix
, int len
,
20 int *remaining_prefix
, const char *path
)
22 const char *orig
= path
;
24 if (is_absolute_path(orig
)) {
25 const char *temp
= real_path(path
);
26 sanitized
= xmalloc(len
+ strlen(temp
) + 1);
27 strcpy(sanitized
, temp
);
29 *remaining_prefix
= 0;
31 sanitized
= xmalloc(len
+ strlen(path
) + 1);
33 memcpy(sanitized
, prefix
, len
);
34 strcpy(sanitized
+ len
, path
);
36 *remaining_prefix
= len
;
38 if (normalize_path_copy_len(sanitized
, sanitized
, remaining_prefix
))
40 if (is_absolute_path(orig
)) {
41 size_t root_len
, len
, total
;
42 const char *work_tree
= get_git_work_tree();
45 len
= strlen(work_tree
);
46 root_len
= offset_1st_component(work_tree
);
47 total
= strlen(sanitized
) + 1;
48 if (strncmp(sanitized
, work_tree
, len
) ||
49 (len
> root_len
&& sanitized
[len
] != '\0' && sanitized
[len
] != '/')) {
54 if (sanitized
[len
] == '/')
56 memmove(sanitized
, sanitized
+ len
, total
- len
);
61 char *prefix_path(const char *prefix
, int len
, const char *path
)
63 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
65 die("'%s' is outside repository", path
);
69 int path_inside_repo(const char *prefix
, const char *path
)
71 int len
= prefix
? strlen(prefix
) : 0;
72 char *r
= prefix_path_gently(prefix
, len
, NULL
, path
);
80 int check_filename(const char *prefix
, const char *arg
)
85 if (starts_with(arg
, ":/")) {
86 if (arg
[2] == '\0') /* ":/" is root dir, always exists */
90 name
= prefix_filename(prefix
, strlen(prefix
), arg
);
93 if (!lstat(name
, &st
))
94 return 1; /* file exists */
95 if (errno
== ENOENT
|| errno
== ENOTDIR
)
96 return 0; /* file does not exist */
97 die_errno("failed to stat '%s'", arg
);
100 static void NORETURN
die_verify_filename(const char *prefix
,
102 int diagnose_misspelt_rev
)
104 if (!diagnose_misspelt_rev
)
105 die("%s: no such path in the working tree.\n"
106 "Use 'git <command> -- <path>...' to specify paths that do not exist locally.",
109 * Saying "'(icase)foo' does not exist in the index" when the
110 * user gave us ":(icase)foo" is just stupid. A magic pathspec
111 * begins with a colon and is followed by a non-alnum; do not
112 * let maybe_die_on_misspelt_object_name() even trigger.
114 if (!(arg
[0] == ':' && !isalnum(arg
[1])))
115 maybe_die_on_misspelt_object_name(arg
, prefix
);
117 /* ... or fall back the most general message. */
118 die("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
119 "Use '--' to separate paths from revisions, like this:\n"
120 "'git <command> [<revision>...] -- [<file>...]'", arg
);
125 * Verify a filename that we got as an argument for a pathspec
126 * entry. Note that a filename that begins with "-" never verifies
127 * as true, because even if such a filename were to exist, we want
128 * it to be preceded by the "--" marker (or we want the user to
129 * use a format like "./-filename")
131 * The "diagnose_misspelt_rev" is used to provide a user-friendly
132 * diagnosis when dying upon finding that "name" is not a pathname.
133 * If set to 1, the diagnosis will try to diagnose "name" as an
134 * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
135 * will only complain about an inexisting file.
137 * This function is typically called to check that a "file or rev"
138 * argument is unambiguous. In this case, the caller will want
139 * diagnose_misspelt_rev == 1 when verifying the first non-rev
140 * argument (which could have been a revision), and
141 * diagnose_misspelt_rev == 0 for the next ones (because we already
142 * saw a filename, there's not ambiguity anymore).
144 void verify_filename(const char *prefix
,
146 int diagnose_misspelt_rev
)
149 die("bad flag '%s' used after filename", arg
);
150 if (check_filename(prefix
, arg
))
152 die_verify_filename(prefix
, arg
, diagnose_misspelt_rev
);
156 * Opposite of the above: the command line did not have -- marker
157 * and we parsed the arg as a refname. It should not be interpretable
160 void verify_non_filename(const char *prefix
, const char *arg
)
162 if (!is_inside_work_tree() || is_inside_git_dir())
166 if (!check_filename(prefix
, arg
))
168 die("ambiguous argument '%s': both revision and filename\n"
169 "Use '--' to separate paths from revisions, like this:\n"
170 "'git <command> [<revision>...] -- [<file>...]'", arg
);
175 * Test if it looks like we're at a git directory.
178 * - either an objects/ directory _or_ the proper
179 * GIT_OBJECT_DIRECTORY environment variable
180 * - a refs/ directory
181 * - either a HEAD symlink or a HEAD file that is formatted as
182 * a proper "ref:", or a regular file HEAD that has a properly
183 * formatted sha1 object name.
185 int is_git_directory(const char *suspect
)
188 size_t len
= strlen(suspect
);
190 if (PATH_MAX
<= len
+ strlen("/objects"))
191 die("Too long path: %.*s", 60, suspect
);
192 strcpy(path
, suspect
);
193 if (getenv(DB_ENVIRONMENT
)) {
194 if (access(getenv(DB_ENVIRONMENT
), X_OK
))
198 strcpy(path
+ len
, "/objects");
199 if (access(path
, X_OK
))
203 strcpy(path
+ len
, "/refs");
204 if (access(path
, X_OK
))
207 strcpy(path
+ len
, "/HEAD");
208 if (validate_headref(path
))
214 int is_inside_git_dir(void)
216 if (inside_git_dir
< 0)
217 inside_git_dir
= is_inside_dir(get_git_dir());
218 return inside_git_dir
;
221 int is_inside_work_tree(void)
223 if (inside_work_tree
< 0)
224 inside_work_tree
= is_inside_dir(get_git_work_tree());
225 return inside_work_tree
;
228 void setup_work_tree(void)
230 const char *work_tree
, *git_dir
;
231 static int initialized
= 0;
235 work_tree
= get_git_work_tree();
236 git_dir
= get_git_dir();
237 if (!is_absolute_path(git_dir
))
238 git_dir
= real_path(get_git_dir());
239 if (!work_tree
|| chdir(work_tree
))
240 die("This operation must be run in a work tree");
243 * Make sure subsequent git processes find correct worktree
244 * if $GIT_WORK_TREE is set relative
246 if (getenv(GIT_WORK_TREE_ENVIRONMENT
))
247 setenv(GIT_WORK_TREE_ENVIRONMENT
, ".", 1);
249 set_git_dir(remove_leading_path(git_dir
, work_tree
));
253 static int check_repository_format_gently(const char *gitdir
, int *nongit_ok
)
255 char repo_config
[PATH_MAX
+1];
258 * git_config() can't be used here because it calls git_pathdup()
259 * to get $GIT_CONFIG/config. That call will make setup_git_env()
260 * set git_dir to ".git".
262 * We are in gitdir setup, no git dir has been found useable yet.
263 * Use a gentler version of git_config() to check if this repo
266 snprintf(repo_config
, PATH_MAX
, "%s/config", gitdir
);
267 git_config_early(check_repository_format_version
, NULL
, repo_config
);
268 if (GIT_REPO_VERSION
< repository_format_version
) {
270 die ("Expected git repo version <= %d, found %d",
271 GIT_REPO_VERSION
, repository_format_version
);
272 warning("Expected git repo version <= %d, found %d",
273 GIT_REPO_VERSION
, repository_format_version
);
274 warning("Please upgrade Git");
282 * Try to read the location of the git directory from the .git file,
283 * return path to git directory if found.
285 const char *read_gitfile(const char *path
)
296 if (!S_ISREG(st
.st_mode
))
298 fd
= open(path
, O_RDONLY
);
300 die_errno("Error opening '%s'", path
);
301 buf
= xmalloc(st
.st_size
+ 1);
302 len
= read_in_full(fd
, buf
, st
.st_size
);
304 if (len
!= st
.st_size
)
305 die("Error reading %s", path
);
307 if (!starts_with(buf
, "gitdir: "))
308 die("Invalid gitfile format: %s", path
);
309 while (buf
[len
- 1] == '\n' || buf
[len
- 1] == '\r')
312 die("No path in gitfile: %s", path
);
316 if (!is_absolute_path(dir
) && (slash
= strrchr(path
, '/'))) {
317 size_t pathlen
= slash
+1 - path
;
318 size_t dirlen
= pathlen
+ len
- 8;
319 dir
= xmalloc(dirlen
+ 1);
320 strncpy(dir
, path
, pathlen
);
321 strncpy(dir
+ pathlen
, buf
+ 8, len
- 8);
327 if (!is_git_directory(dir
))
328 die("Not a git repository: %s", dir
);
329 path
= real_path(dir
);
335 static const char *setup_explicit_git_dir(const char *gitdirenv
,
339 const char *work_tree_env
= getenv(GIT_WORK_TREE_ENVIRONMENT
);
340 const char *worktree
;
344 if (PATH_MAX
- 40 < strlen(gitdirenv
))
345 die("'$%s' too big", GIT_DIR_ENVIRONMENT
);
347 gitfile
= (char*)read_gitfile(gitdirenv
);
349 gitfile
= xstrdup(gitfile
);
353 if (!is_git_directory(gitdirenv
)) {
359 die("Not a git repository: '%s'", gitdirenv
);
362 if (check_repository_format_gently(gitdirenv
, nongit_ok
)) {
367 /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
369 set_git_work_tree(work_tree_env
);
370 else if (is_bare_repository_cfg
> 0) {
371 if (git_work_tree_cfg
) /* #22.2, #30 */
372 die("core.bare and core.worktree do not make sense");
375 set_git_dir(gitdirenv
);
379 else if (git_work_tree_cfg
) { /* #6, #14 */
380 if (is_absolute_path(git_work_tree_cfg
))
381 set_git_work_tree(git_work_tree_cfg
);
383 char core_worktree
[PATH_MAX
];
384 if (chdir(gitdirenv
))
385 die_errno("Could not chdir to '%s'", gitdirenv
);
386 if (chdir(git_work_tree_cfg
))
387 die_errno("Could not chdir to '%s'", git_work_tree_cfg
);
388 if (!getcwd(core_worktree
, PATH_MAX
))
389 die_errno("Could not get directory '%s'", git_work_tree_cfg
);
391 die_errno("Could not come back to cwd");
392 set_git_work_tree(core_worktree
);
395 else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, 1)) {
397 set_git_dir(gitdirenv
);
402 set_git_work_tree(".");
404 /* set_git_work_tree() must have been called by now */
405 worktree
= get_git_work_tree();
407 /* both get_git_work_tree() and cwd are already normalized */
408 if (!strcmp(cwd
, worktree
)) { /* cwd == worktree */
409 set_git_dir(gitdirenv
);
414 offset
= dir_inside_of(cwd
, worktree
);
415 if (offset
>= 0) { /* cwd inside worktree? */
416 set_git_dir(real_path(gitdirenv
));
418 die_errno("Could not chdir to '%s'", worktree
);
425 /* cwd outside worktree */
426 set_git_dir(gitdirenv
);
431 static const char *setup_discovered_git_dir(const char *gitdir
,
432 char *cwd
, int offset
, int len
,
435 if (check_repository_format_gently(gitdir
, nongit_ok
))
438 /* --work-tree is set without --git-dir; use discovered one */
439 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
440 if (offset
!= len
&& !is_absolute_path(gitdir
))
441 gitdir
= xstrdup(real_path(gitdir
));
443 die_errno("Could not come back to cwd");
444 return setup_explicit_git_dir(gitdir
, cwd
, len
, nongit_ok
);
447 /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
448 if (is_bare_repository_cfg
> 0) {
449 set_git_dir(offset
== len
? gitdir
: real_path(gitdir
));
451 die_errno("Could not come back to cwd");
455 /* #0, #1, #5, #8, #9, #12, #13 */
456 set_git_work_tree(".");
457 if (strcmp(gitdir
, DEFAULT_GIT_DIR_ENVIRONMENT
))
460 inside_work_tree
= 1;
464 /* Make "offset" point to past the '/', and add a '/' at the end */
471 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
472 static const char *setup_bare_git_dir(char *cwd
, int offset
, int len
, int *nongit_ok
)
476 if (check_repository_format_gently(".", nongit_ok
))
479 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, "0", 1);
481 /* --work-tree is set without --git-dir; use discovered one */
482 if (getenv(GIT_WORK_TREE_ENVIRONMENT
) || git_work_tree_cfg
) {
485 gitdir
= offset
== len
? "." : xmemdupz(cwd
, offset
);
487 die_errno("Could not come back to cwd");
488 return setup_explicit_git_dir(gitdir
, cwd
, len
, nongit_ok
);
492 inside_work_tree
= 0;
495 die_errno("Cannot come back to cwd");
496 root_len
= offset_1st_component(cwd
);
497 cwd
[offset
> root_len
? offset
: root_len
] = '\0';
505 static const char *setup_nongit(const char *cwd
, int *nongit_ok
)
508 die("Not a git repository (or any of the parent directories): %s", DEFAULT_GIT_DIR_ENVIRONMENT
);
510 die_errno("Cannot come back to cwd");
515 static dev_t
get_device_or_die(const char *path
, const char *prefix
, int prefix_len
)
518 if (stat(path
, &buf
)) {
519 die_errno("failed to stat '%*s%s%s'",
521 prefix
? prefix
: "",
522 prefix
? "/" : "", path
);
528 * A "string_list_each_func_t" function that canonicalizes an entry
529 * from GIT_CEILING_DIRECTORIES using real_path_if_valid(), or
530 * discards it if unusable. The presence of an empty entry in
531 * GIT_CEILING_DIRECTORIES turns off canonicalization for all
532 * subsequent entries.
534 static int canonicalize_ceiling_entry(struct string_list_item
*item
,
537 int *empty_entry_found
= cb_data
;
538 char *ceil
= item
->string
;
541 *empty_entry_found
= 1;
543 } else if (!is_absolute_path(ceil
)) {
545 } else if (*empty_entry_found
) {
546 /* Keep entry but do not canonicalize it */
549 const char *real_path
= real_path_if_valid(ceil
);
553 item
->string
= xstrdup(real_path
);
559 * We cannot decide in this function whether we are in the work tree or
560 * not, since the config can only be read _after_ this function was called.
562 static const char *setup_git_directory_gently_1(int *nongit_ok
)
564 const char *env_ceiling_dirs
= getenv(CEILING_DIRECTORIES_ENVIRONMENT
);
565 struct string_list ceiling_dirs
= STRING_LIST_INIT_DUP
;
566 static char cwd
[PATH_MAX
+ 1];
567 const char *gitdirenv
, *ret
;
569 int len
, offset
, offset_parent
, ceil_offset
= -1;
570 dev_t current_device
= 0;
571 int one_filesystem
= 1;
574 * Let's assume that we are in a git repository.
575 * If it turns out later that we are somewhere else, the value will be
576 * updated accordingly.
581 if (!getcwd(cwd
, sizeof(cwd
) - 1))
582 die_errno("Unable to read current working directory");
583 offset
= len
= strlen(cwd
);
586 * If GIT_DIR is set explicitly, we're not going
587 * to do any discovery, but we still do repository
590 gitdirenv
= getenv(GIT_DIR_ENVIRONMENT
);
592 return setup_explicit_git_dir(gitdirenv
, cwd
, len
, nongit_ok
);
594 if (env_ceiling_dirs
) {
595 int empty_entry_found
= 0;
597 string_list_split(&ceiling_dirs
, env_ceiling_dirs
, PATH_SEP
, -1);
598 filter_string_list(&ceiling_dirs
, 0,
599 canonicalize_ceiling_entry
, &empty_entry_found
);
600 ceil_offset
= longest_ancestor_length(cwd
, &ceiling_dirs
);
601 string_list_clear(&ceiling_dirs
, 0);
604 if (ceil_offset
< 0 && has_dos_drive_prefix(cwd
))
608 * Test in the following order (relative to the cwd):
609 * - .git (file containing "gitdir: <path>")
618 one_filesystem
= !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
620 current_device
= get_device_or_die(".", NULL
, 0);
622 gitfile
= (char*)read_gitfile(DEFAULT_GIT_DIR_ENVIRONMENT
);
624 gitdirenv
= gitfile
= xstrdup(gitfile
);
626 if (is_git_directory(DEFAULT_GIT_DIR_ENVIRONMENT
))
627 gitdirenv
= DEFAULT_GIT_DIR_ENVIRONMENT
;
631 ret
= setup_discovered_git_dir(gitdirenv
,
639 if (is_git_directory("."))
640 return setup_bare_git_dir(cwd
, offset
, len
, nongit_ok
);
642 offset_parent
= offset
;
643 while (--offset_parent
> ceil_offset
&& cwd
[offset_parent
] != '/');
644 if (offset_parent
<= ceil_offset
)
645 return setup_nongit(cwd
, nongit_ok
);
646 if (one_filesystem
) {
647 dev_t parent_device
= get_device_or_die("..", cwd
, offset
);
648 if (parent_device
!= current_device
) {
651 die_errno("Cannot come back to cwd");
656 die("Not a git repository (or any parent up to mount point %s)\n"
657 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).", cwd
);
662 die_errno("Cannot change to '%s/..'", cwd
);
664 offset
= offset_parent
;
668 const char *setup_git_directory_gently(int *nongit_ok
)
672 prefix
= setup_git_directory_gently_1(nongit_ok
);
674 setenv(GIT_PREFIX_ENVIRONMENT
, prefix
, 1);
676 setenv(GIT_PREFIX_ENVIRONMENT
, "", 1);
679 startup_info
->have_repository
= !nongit_ok
|| !*nongit_ok
;
680 startup_info
->prefix
= prefix
;
685 int git_config_perm(const char *var
, const char *value
)
693 if (!strcmp(value
, "umask"))
695 if (!strcmp(value
, "group"))
697 if (!strcmp(value
, "all") ||
698 !strcmp(value
, "world") ||
699 !strcmp(value
, "everybody"))
700 return PERM_EVERYBODY
;
702 /* Parse octal numbers */
703 i
= strtol(value
, &endptr
, 8);
705 /* If not an octal number, maybe true/false? */
707 return git_config_bool(var
, value
) ? PERM_GROUP
: PERM_UMASK
;
710 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
711 * a chmod value to restrict to.
714 case PERM_UMASK
: /* 0 */
716 case OLD_PERM_GROUP
: /* 1 */
718 case OLD_PERM_EVERYBODY
: /* 2 */
719 return PERM_EVERYBODY
;
722 /* A filemode value was given: 0xxx */
724 if ((i
& 0600) != 0600)
725 die("Problem with core.sharedRepository filemode value "
726 "(0%.3o).\nThe owner of files must always have "
727 "read and write permissions.", i
);
730 * Mask filemode value. Others can not get write permission.
731 * x flags for directories are handled separately.
736 int check_repository_format_version(const char *var
, const char *value
, void *cb
)
738 if (strcmp(var
, "core.repositoryformatversion") == 0)
739 repository_format_version
= git_config_int(var
, value
);
740 else if (strcmp(var
, "core.sharedrepository") == 0)
741 shared_repository
= git_config_perm(var
, value
);
742 else if (strcmp(var
, "core.bare") == 0) {
743 is_bare_repository_cfg
= git_config_bool(var
, value
);
744 if (is_bare_repository_cfg
== 1)
745 inside_work_tree
= -1;
746 } else if (strcmp(var
, "core.worktree") == 0) {
748 return config_error_nonbool(var
);
749 free(git_work_tree_cfg
);
750 git_work_tree_cfg
= xstrdup(value
);
751 inside_work_tree
= -1;
756 int check_repository_format(void)
758 return check_repository_format_gently(get_git_dir(), NULL
);
762 * Returns the "prefix", a path to the current working directory
763 * relative to the work tree root, or NULL, if the current working
764 * directory is not a strict subdirectory of the work tree root. The
765 * prefix always ends with a '/' character.
767 const char *setup_git_directory(void)
769 return setup_git_directory_gently(NULL
);
772 const char *resolve_gitdir(const char *suspect
)
774 if (is_git_directory(suspect
))
776 return read_gitfile(suspect
);
779 /* if any standard file descriptor is missing open it to /dev/null */
780 void sanitize_stdfds(void)
782 int fd
= open("/dev/null", O_RDWR
, 0);
783 while (fd
!= -1 && fd
< 2)
786 die_errno("open /dev/null or dup failed");