Merge branch 'jn/maint-setup-fix' (early part) into jn/paginate-fix
[alt-git.git] / setup.c
blob6ee1e28bd8650332aade03b78a2660abbde5478a
1 #include "cache.h"
2 #include "dir.h"
4 static int inside_git_dir = -1;
5 static int inside_work_tree = -1;
7 const char *prefix_path(const char *prefix, int len, const char *path)
9 const char *orig = path;
10 char *sanitized = xmalloc(len + strlen(path) + 1);
11 if (is_absolute_path(orig))
12 strcpy(sanitized, path);
13 else {
14 if (len)
15 memcpy(sanitized, prefix, len);
16 strcpy(sanitized + len, path);
18 if (normalize_path_copy(sanitized, sanitized))
19 goto error_out;
20 if (is_absolute_path(orig)) {
21 size_t root_len, len, total;
22 const char *work_tree = get_git_work_tree();
23 if (!work_tree)
24 goto error_out;
25 len = strlen(work_tree);
26 root_len = offset_1st_component(work_tree);
27 total = strlen(sanitized) + 1;
28 if (strncmp(sanitized, work_tree, len) ||
29 (len > root_len && sanitized[len] != '\0' && sanitized[len] != '/')) {
30 error_out:
31 die("'%s' is outside repository", orig);
33 if (sanitized[len] == '/')
34 len++;
35 memmove(sanitized, sanitized + len, total - len);
37 return sanitized;
41 * Unlike prefix_path, this should be used if the named file does
42 * not have to interact with index entry; i.e. name of a random file
43 * on the filesystem.
45 const char *prefix_filename(const char *pfx, int pfx_len, const char *arg)
47 static char path[PATH_MAX];
48 #ifndef WIN32
49 if (!pfx || !*pfx || is_absolute_path(arg))
50 return arg;
51 memcpy(path, pfx, pfx_len);
52 strcpy(path + pfx_len, arg);
53 #else
54 char *p;
55 /* don't add prefix to absolute paths, but still replace '\' by '/' */
56 if (is_absolute_path(arg))
57 pfx_len = 0;
58 else
59 memcpy(path, pfx, pfx_len);
60 strcpy(path + pfx_len, arg);
61 for (p = path + pfx_len; *p; p++)
62 if (*p == '\\')
63 *p = '/';
64 #endif
65 return path;
68 int check_filename(const char *prefix, const char *arg)
70 const char *name;
71 struct stat st;
73 name = prefix ? prefix_filename(prefix, strlen(prefix), arg) : arg;
74 if (!lstat(name, &st))
75 return 1; /* file exists */
76 if (errno == ENOENT || errno == ENOTDIR)
77 return 0; /* file does not exist */
78 die_errno("failed to stat '%s'", arg);
81 static void NORETURN die_verify_filename(const char *prefix, const char *arg)
83 unsigned char sha1[20];
84 unsigned mode;
85 /* try a detailed diagnostic ... */
86 get_sha1_with_mode_1(arg, sha1, &mode, 0, prefix);
87 /* ... or fall back the most general message. */
88 die("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
89 "Use '--' to separate paths from revisions", arg);
94 * Verify a filename that we got as an argument for a pathspec
95 * entry. Note that a filename that begins with "-" never verifies
96 * as true, because even if such a filename were to exist, we want
97 * it to be preceded by the "--" marker (or we want the user to
98 * use a format like "./-filename")
100 void verify_filename(const char *prefix, const char *arg)
102 if (*arg == '-')
103 die("bad flag '%s' used after filename", arg);
104 if (check_filename(prefix, arg))
105 return;
106 die_verify_filename(prefix, arg);
110 * Opposite of the above: the command line did not have -- marker
111 * and we parsed the arg as a refname. It should not be interpretable
112 * as a filename.
114 void verify_non_filename(const char *prefix, const char *arg)
116 if (!is_inside_work_tree() || is_inside_git_dir())
117 return;
118 if (*arg == '-')
119 return; /* flag */
120 if (!check_filename(prefix, arg))
121 return;
122 die("ambiguous argument '%s': both revision and filename\n"
123 "Use '--' to separate filenames from revisions", arg);
126 const char **get_pathspec(const char *prefix, const char **pathspec)
128 const char *entry = *pathspec;
129 const char **src, **dst;
130 int prefixlen;
132 if (!prefix && !entry)
133 return NULL;
135 if (!entry) {
136 static const char *spec[2];
137 spec[0] = prefix;
138 spec[1] = NULL;
139 return spec;
142 /* Otherwise we have to re-write the entries.. */
143 src = pathspec;
144 dst = pathspec;
145 prefixlen = prefix ? strlen(prefix) : 0;
146 while (*src) {
147 const char *p = prefix_path(prefix, prefixlen, *src);
148 *(dst++) = p;
149 src++;
151 *dst = NULL;
152 if (!*pathspec)
153 return NULL;
154 return pathspec;
158 * Test if it looks like we're at a git directory.
159 * We want to see:
161 * - either an objects/ directory _or_ the proper
162 * GIT_OBJECT_DIRECTORY environment variable
163 * - a refs/ directory
164 * - either a HEAD symlink or a HEAD file that is formatted as
165 * a proper "ref:", or a regular file HEAD that has a properly
166 * formatted sha1 object name.
168 static int is_git_directory(const char *suspect)
170 char path[PATH_MAX];
171 size_t len = strlen(suspect);
173 if (PATH_MAX <= len + strlen("/objects"))
174 die("Too long path: %.*s", 60, suspect);
175 strcpy(path, suspect);
176 if (getenv(DB_ENVIRONMENT)) {
177 if (access(getenv(DB_ENVIRONMENT), X_OK))
178 return 0;
180 else {
181 strcpy(path + len, "/objects");
182 if (access(path, X_OK))
183 return 0;
186 strcpy(path + len, "/refs");
187 if (access(path, X_OK))
188 return 0;
190 strcpy(path + len, "/HEAD");
191 if (validate_headref(path))
192 return 0;
194 return 1;
197 int is_inside_git_dir(void)
199 if (inside_git_dir < 0)
200 inside_git_dir = is_inside_dir(get_git_dir());
201 return inside_git_dir;
204 int is_inside_work_tree(void)
206 if (inside_work_tree < 0)
207 inside_work_tree = is_inside_dir(get_git_work_tree());
208 return inside_work_tree;
212 * set_work_tree() is only ever called if you set GIT_DIR explicitly.
213 * The old behaviour (which we retain here) is to set the work tree root
214 * to the cwd, unless overridden by the config, the command line, or
215 * GIT_WORK_TREE.
217 static const char *set_work_tree(const char *dir)
219 char buffer[PATH_MAX + 1];
221 if (!getcwd(buffer, sizeof(buffer)))
222 die ("Could not get the current working directory");
223 git_work_tree_cfg = xstrdup(buffer);
224 inside_work_tree = 1;
226 return NULL;
229 void setup_work_tree(void)
231 const char *work_tree, *git_dir;
232 static int initialized = 0;
234 if (initialized)
235 return;
236 work_tree = get_git_work_tree();
237 git_dir = get_git_dir();
238 if (!is_absolute_path(git_dir))
239 git_dir = make_absolute_path(git_dir);
240 if (!work_tree || chdir(work_tree))
241 die("This operation must be run in a work tree");
242 set_git_dir(make_relative_path(git_dir, work_tree));
243 initialized = 1;
246 static int check_repository_format_gently(int *nongit_ok)
248 git_config(check_repository_format_version, NULL);
249 if (GIT_REPO_VERSION < repository_format_version) {
250 if (!nongit_ok)
251 die ("Expected git repo version <= %d, found %d",
252 GIT_REPO_VERSION, repository_format_version);
253 warning("Expected git repo version <= %d, found %d",
254 GIT_REPO_VERSION, repository_format_version);
255 warning("Please upgrade Git");
256 *nongit_ok = -1;
257 return -1;
259 return 0;
263 * Try to read the location of the git directory from the .git file,
264 * return path to git directory if found.
266 const char *read_gitfile_gently(const char *path)
268 char *buf;
269 char *dir;
270 const char *slash;
271 struct stat st;
272 int fd;
273 size_t len;
275 if (stat(path, &st))
276 return NULL;
277 if (!S_ISREG(st.st_mode))
278 return NULL;
279 fd = open(path, O_RDONLY);
280 if (fd < 0)
281 die_errno("Error opening '%s'", path);
282 buf = xmalloc(st.st_size + 1);
283 len = read_in_full(fd, buf, st.st_size);
284 close(fd);
285 if (len != st.st_size)
286 die("Error reading %s", path);
287 buf[len] = '\0';
288 if (prefixcmp(buf, "gitdir: "))
289 die("Invalid gitfile format: %s", path);
290 while (buf[len - 1] == '\n' || buf[len - 1] == '\r')
291 len--;
292 if (len < 9)
293 die("No path in gitfile: %s", path);
294 buf[len] = '\0';
295 dir = buf + 8;
297 if (!is_absolute_path(dir) && (slash = strrchr(path, '/'))) {
298 size_t pathlen = slash+1 - path;
299 size_t dirlen = pathlen + len - 8;
300 dir = xmalloc(dirlen + 1);
301 strncpy(dir, path, pathlen);
302 strncpy(dir + pathlen, buf + 8, len - 8);
303 dir[dirlen] = '\0';
304 free(buf);
305 buf = dir;
308 if (!is_git_directory(dir))
309 die("Not a git repository: %s", dir);
310 path = make_absolute_path(dir);
312 free(buf);
313 return path;
316 static const char *setup_explicit_git_dir(const char *gitdirenv,
317 const char *work_tree_env, int *nongit_ok)
319 static char buffer[1024 + 1];
320 const char *retval;
322 if (PATH_MAX - 40 < strlen(gitdirenv))
323 die("'$%s' too big", GIT_DIR_ENVIRONMENT);
324 if (!is_git_directory(gitdirenv)) {
325 if (nongit_ok) {
326 *nongit_ok = 1;
327 return NULL;
329 die("Not a git repository: '%s'", gitdirenv);
331 if (!work_tree_env) {
332 retval = set_work_tree(gitdirenv);
333 /* config may override worktree */
334 if (check_repository_format_gently(nongit_ok))
335 return NULL;
336 return retval;
338 if (check_repository_format_gently(nongit_ok))
339 return NULL;
340 retval = get_relative_cwd(buffer, sizeof(buffer) - 1,
341 get_git_work_tree());
342 if (!retval || !*retval)
343 return NULL;
344 set_git_dir(make_absolute_path(gitdirenv));
345 if (chdir(work_tree_env) < 0)
346 die_errno ("Could not chdir to '%s'", work_tree_env);
347 strcat(buffer, "/");
348 return retval;
351 static int cwd_contains_git_dir(const char **gitfile_dirp)
353 const char *gitfile_dir = read_gitfile_gently(DEFAULT_GIT_DIR_ENVIRONMENT);
354 *gitfile_dirp = gitfile_dir;
355 if (gitfile_dir) {
356 if (set_git_dir(gitfile_dir))
357 die("Repository setup failed");
358 return 1;
360 return is_git_directory(DEFAULT_GIT_DIR_ENVIRONMENT);
363 static const char *setup_bare_git_dir(const char *work_tree_env,
364 int offset, int len, char *cwd, int *nongit_ok)
366 int root_len;
368 inside_git_dir = 1;
369 if (!work_tree_env)
370 inside_work_tree = 0;
371 if (offset != len) {
372 if (chdir(cwd))
373 die_errno("Cannot come back to cwd");
374 root_len = offset_1st_component(cwd);
375 cwd[offset > root_len ? offset : root_len] = '\0';
376 set_git_dir(cwd);
377 } else
378 set_git_dir(".");
379 check_repository_format_gently(nongit_ok);
380 return NULL;
383 static const char *setup_nongit(const char *cwd, int *nongit_ok)
385 if (!nongit_ok)
386 die("Not a git repository (or any of the parent directories): %s", DEFAULT_GIT_DIR_ENVIRONMENT);
387 if (chdir(cwd))
388 die_errno("Cannot come back to cwd");
389 *nongit_ok = 1;
390 return NULL;
393 static dev_t get_device_or_die(const char *path, const char *prefix)
395 struct stat buf;
396 if (stat(path, &buf))
397 die_errno("failed to stat '%s%s%s'",
398 prefix ? prefix : "",
399 prefix ? "/" : "", path);
400 return buf.st_dev;
404 * We cannot decide in this function whether we are in the work tree or
405 * not, since the config can only be read _after_ this function was called.
407 static const char *setup_git_directory_gently_1(int *nongit_ok)
409 const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
410 const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
411 static char cwd[PATH_MAX+1];
412 const char *gitdirenv;
413 const char *gitfile_dir;
414 int len, offset, ceil_offset, root_len;
415 dev_t current_device = 0;
416 int one_filesystem = 1;
419 * Let's assume that we are in a git repository.
420 * If it turns out later that we are somewhere else, the value will be
421 * updated accordingly.
423 if (nongit_ok)
424 *nongit_ok = 0;
427 * If GIT_DIR is set explicitly, we're not going
428 * to do any discovery, but we still do repository
429 * validation.
431 gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
432 if (gitdirenv)
433 return setup_explicit_git_dir(gitdirenv, work_tree_env, nongit_ok);
435 if (!getcwd(cwd, sizeof(cwd)-1))
436 die_errno("Unable to read current working directory");
438 ceil_offset = longest_ancestor_length(cwd, env_ceiling_dirs);
439 if (ceil_offset < 0 && has_dos_drive_prefix(cwd))
440 ceil_offset = 1;
443 * Test in the following order (relative to the cwd):
444 * - .git (file containing "gitdir: <path>")
445 * - .git/
446 * - ./ (bare)
447 * - ../.git
448 * - ../.git/
449 * - ../ (bare)
450 * - ../../.git/
451 * etc.
453 offset = len = strlen(cwd);
454 one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
455 if (one_filesystem)
456 current_device = get_device_or_die(".", NULL);
457 for (;;) {
458 if (cwd_contains_git_dir(&gitfile_dir))
459 break;
460 if (is_git_directory("."))
461 return setup_bare_git_dir(work_tree_env, offset,
462 len, cwd, nongit_ok);
463 while (--offset > ceil_offset && cwd[offset] != '/');
464 if (offset <= ceil_offset)
465 return setup_nongit(cwd, nongit_ok);
466 if (one_filesystem) {
467 dev_t parent_device = get_device_or_die("..", cwd);
468 if (parent_device != current_device) {
469 if (nongit_ok) {
470 if (chdir(cwd))
471 die_errno("Cannot come back to cwd");
472 *nongit_ok = 1;
473 return NULL;
475 cwd[offset] = '\0';
476 die("Not a git repository (or any parent up to mount parent %s)\n"
477 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).", cwd);
480 if (chdir("..")) {
481 cwd[offset] = '\0';
482 die_errno("Cannot change to '%s/..'", cwd);
486 inside_git_dir = 0;
487 if (!work_tree_env)
488 inside_work_tree = 1;
489 root_len = offset_1st_component(cwd);
490 git_work_tree_cfg = xstrndup(cwd, offset > root_len ? offset : root_len);
491 if (check_repository_format_gently(nongit_ok))
492 return NULL;
493 if (offset == len)
494 return NULL;
496 /* Make "offset" point to past the '/', and add a '/' at the end */
497 offset++;
498 cwd[len++] = '/';
499 cwd[len] = 0;
500 return cwd + offset;
503 const char *setup_git_directory_gently(int *nongit_ok)
505 const char *prefix;
507 prefix = setup_git_directory_gently_1(nongit_ok);
508 if (startup_info)
509 startup_info->have_repository = !nongit_ok || !*nongit_ok;
510 return prefix;
513 int git_config_perm(const char *var, const char *value)
515 int i;
516 char *endptr;
518 if (value == NULL)
519 return PERM_GROUP;
521 if (!strcmp(value, "umask"))
522 return PERM_UMASK;
523 if (!strcmp(value, "group"))
524 return PERM_GROUP;
525 if (!strcmp(value, "all") ||
526 !strcmp(value, "world") ||
527 !strcmp(value, "everybody"))
528 return PERM_EVERYBODY;
530 /* Parse octal numbers */
531 i = strtol(value, &endptr, 8);
533 /* If not an octal number, maybe true/false? */
534 if (*endptr != 0)
535 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
538 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
539 * a chmod value to restrict to.
541 switch (i) {
542 case PERM_UMASK: /* 0 */
543 return PERM_UMASK;
544 case OLD_PERM_GROUP: /* 1 */
545 return PERM_GROUP;
546 case OLD_PERM_EVERYBODY: /* 2 */
547 return PERM_EVERYBODY;
550 /* A filemode value was given: 0xxx */
552 if ((i & 0600) != 0600)
553 die("Problem with core.sharedRepository filemode value "
554 "(0%.3o).\nThe owner of files must always have "
555 "read and write permissions.", i);
558 * Mask filemode value. Others can not get write permission.
559 * x flags for directories are handled separately.
561 return -(i & 0666);
564 int check_repository_format_version(const char *var, const char *value, void *cb)
566 if (strcmp(var, "core.repositoryformatversion") == 0)
567 repository_format_version = git_config_int(var, value);
568 else if (strcmp(var, "core.sharedrepository") == 0)
569 shared_repository = git_config_perm(var, value);
570 else if (strcmp(var, "core.bare") == 0) {
571 is_bare_repository_cfg = git_config_bool(var, value);
572 if (is_bare_repository_cfg == 1)
573 inside_work_tree = -1;
574 } else if (strcmp(var, "core.worktree") == 0) {
575 if (!value)
576 return config_error_nonbool(var);
577 free(git_work_tree_cfg);
578 git_work_tree_cfg = xstrdup(value);
579 inside_work_tree = -1;
581 return 0;
584 int check_repository_format(void)
586 return check_repository_format_gently(NULL);
590 * Returns the "prefix", a path to the current working directory
591 * relative to the work tree root, or NULL, if the current working
592 * directory is not a strict subdirectory of the work tree root. The
593 * prefix always ends with a '/' character.
595 const char *setup_git_directory(void)
597 const char *retval = setup_git_directory_gently(NULL);
599 /* If the work tree is not the default one, recompute prefix */
600 if (inside_work_tree < 0) {
601 static char buffer[PATH_MAX + 1];
602 char *rel;
603 if (retval && chdir(retval))
604 die_errno ("Could not jump back into original cwd");
605 rel = get_relative_cwd(buffer, PATH_MAX, get_git_work_tree());
606 if (rel && *rel && chdir(get_git_work_tree()))
607 die_errno ("Could not jump to working directory");
608 return rel && *rel ? strcat(rel, "/") : NULL;
611 return retval;