setup: split off a function to handle hitting ceiling in repo search
[git/git.git] / setup.c
CommitLineData
d288a700 1#include "cache.h"
e90fdc39
JS
2#include "dir.h"
3
4static int inside_git_dir = -1;
5static int inside_work_tree = -1;
d288a700 6
d089ebaa
JH
7const char *prefix_path(const char *prefix, int len, const char *path)
8{
9 const char *orig = path;
10 char *sanitized = xmalloc(len + strlen(path) + 1);
9a13ba1b 11 if (is_absolute_path(orig))
d089ebaa
JH
12 strcpy(sanitized, path);
13 else {
14 if (len)
15 memcpy(sanitized, prefix, len);
16 strcpy(sanitized + len, path);
f332726e 17 }
f3cad0ad 18 if (normalize_path_copy(sanitized, sanitized))
d089ebaa 19 goto error_out;
9a13ba1b 20 if (is_absolute_path(orig)) {
72ec8ba6 21 size_t root_len, len, total;
d089ebaa 22 const char *work_tree = get_git_work_tree();
b3100fd5
JH
23 if (!work_tree)
24 goto error_out;
25 len = strlen(work_tree);
72ec8ba6 26 root_len = offset_1st_component(work_tree);
b3100fd5 27 total = strlen(sanitized) + 1;
d089ebaa 28 if (strncmp(sanitized, work_tree, len) ||
72ec8ba6 29 (len > root_len && sanitized[len] != '\0' && sanitized[len] != '/')) {
d089ebaa 30 error_out:
62525ef7 31 die("'%s' is outside repository", orig);
d089ebaa
JH
32 }
33 if (sanitized[len] == '/')
34 len++;
35 memmove(sanitized, sanitized + len, total - len);
36 }
37 return sanitized;
f332726e
LT
38}
39
a6080a0a 40/*
4ca06608
JH
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.
44 */
45const char *prefix_filename(const char *pfx, int pfx_len, const char *arg)
46{
47 static char path[PATH_MAX];
71064e3f 48#ifndef WIN32
ecf4831d 49 if (!pfx || !*pfx || is_absolute_path(arg))
4ca06608
JH
50 return arg;
51 memcpy(path, pfx, pfx_len);
52 strcpy(path + pfx_len, arg);
25fe217b
JS
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
4ca06608
JH
65 return path;
66}
67
c6e8c800
JH
68int check_filename(const char *prefix, const char *arg)
69{
70 const char *name;
71 struct stat st;
72
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);
79}
80
009fee47
MM
81static void NORETURN die_verify_filename(const char *prefix, const char *arg)
82{
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);
90
91}
92
e23d0b4a
LT
93/*
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")
99 */
100void verify_filename(const char *prefix, const char *arg)
101{
e23d0b4a
LT
102 if (*arg == '-')
103 die("bad flag '%s' used after filename", arg);
c6e8c800 104 if (check_filename(prefix, arg))
e23d0b4a 105 return;
009fee47 106 die_verify_filename(prefix, arg);
e23d0b4a
LT
107}
108
ea92f41f
JH
109/*
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.
113 */
114void verify_non_filename(const char *prefix, const char *arg)
115{
7ae3df8c 116 if (!is_inside_work_tree() || is_inside_git_dir())
68025633 117 return;
ea92f41f
JH
118 if (*arg == '-')
119 return; /* flag */
c6e8c800
JH
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);
ea92f41f
JH
124}
125
6b5ee137 126const char **get_pathspec(const char *prefix, const char **pathspec)
d288a700 127{
6b5ee137 128 const char *entry = *pathspec;
d089ebaa 129 const char **src, **dst;
d288a700
LT
130 int prefixlen;
131
f332726e
LT
132 if (!prefix && !entry)
133 return NULL;
d288a700
LT
134
135 if (!entry) {
136 static const char *spec[2];
137 spec[0] = prefix;
138 spec[1] = NULL;
139 return spec;
140 }
141
142 /* Otherwise we have to re-write the entries.. */
d089ebaa
JH
143 src = pathspec;
144 dst = pathspec;
f332726e 145 prefixlen = prefix ? strlen(prefix) : 0;
d089ebaa
JH
146 while (*src) {
147 const char *p = prefix_path(prefix, prefixlen, *src);
62525ef7 148 *(dst++) = p;
d089ebaa
JH
149 src++;
150 }
151 *dst = NULL;
152 if (!*pathspec)
153 return NULL;
154 return pathspec;
d288a700
LT
155}
156
5f5608bc 157/*
ad1a382f 158 * Test if it looks like we're at a git directory.
5e7bfe25 159 * We want to see:
5f5608bc 160 *
790296fd 161 * - either an objects/ directory _or_ the proper
5f5608bc 162 * GIT_OBJECT_DIRECTORY environment variable
ad1a382f 163 * - a refs/ directory
8098a178 164 * - either a HEAD symlink or a HEAD file that is formatted as
c847f537
JH
165 * a proper "ref:", or a regular file HEAD that has a properly
166 * formatted sha1 object name.
5f5608bc 167 */
ad1a382f 168static int is_git_directory(const char *suspect)
5f5608bc 169{
ad1a382f
SP
170 char path[PATH_MAX];
171 size_t len = strlen(suspect);
172
3c9d0414
GB
173 if (PATH_MAX <= len + strlen("/objects"))
174 die("Too long path: %.*s", 60, suspect);
ad1a382f
SP
175 strcpy(path, suspect);
176 if (getenv(DB_ENVIRONMENT)) {
177 if (access(getenv(DB_ENVIRONMENT), X_OK))
178 return 0;
179 }
180 else {
181 strcpy(path + len, "/objects");
182 if (access(path, X_OK))
183 return 0;
184 }
185
186 strcpy(path + len, "/refs");
187 if (access(path, X_OK))
8098a178 188 return 0;
ad1a382f
SP
189
190 strcpy(path + len, "/HEAD");
c847f537 191 if (validate_headref(path))
ad1a382f
SP
192 return 0;
193
8098a178 194 return 1;
5f5608bc
LT
195}
196
68025633
JS
197int is_inside_git_dir(void)
198{
e90fdc39
JS
199 if (inside_git_dir < 0)
200 inside_git_dir = is_inside_dir(get_git_dir());
201 return inside_git_dir;
892c41b9
ML
202}
203
892c41b9
ML
204int is_inside_work_tree(void)
205{
e90fdc39
JS
206 if (inside_work_tree < 0)
207 inside_work_tree = is_inside_dir(get_git_work_tree());
208 return inside_work_tree;
892c41b9
ML
209}
210
e90fdc39 211/*
9517e6b8 212 * set_work_tree() is only ever called if you set GIT_DIR explicitly.
7efeb8f0
JS
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.
e90fdc39 216 */
7efeb8f0 217static const char *set_work_tree(const char *dir)
892c41b9 218{
7efeb8f0 219 char buffer[PATH_MAX + 1];
e90fdc39 220
7efeb8f0
JS
221 if (!getcwd(buffer, sizeof(buffer)))
222 die ("Could not get the current working directory");
223 git_work_tree_cfg = xstrdup(buffer);
e90fdc39
JS
224 inside_work_tree = 1;
225
7efeb8f0 226 return NULL;
68025633
JS
227}
228
f3fa1838
JH
229void setup_work_tree(void)
230{
354e6534
JS
231 const char *work_tree, *git_dir;
232 static int initialized = 0;
233
234 if (initialized)
235 return;
236 work_tree = get_git_work_tree();
237 git_dir = get_git_dir();
59f0f2f3 238 if (!is_absolute_path(git_dir))
044bbbcb 239 git_dir = make_absolute_path(git_dir);
59f0f2f3
MH
240 if (!work_tree || chdir(work_tree))
241 die("This operation must be run in a work tree");
044bbbcb 242 set_git_dir(make_relative_path(git_dir, work_tree));
354e6534 243 initialized = 1;
59f0f2f3
MH
244}
245
9459aa77
NTND
246static int check_repository_format_gently(int *nongit_ok)
247{
ef90d6d4 248 git_config(check_repository_format_version, NULL);
9459aa77
NTND
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;
258 }
259 return 0;
260}
261
b44ebb19
LH
262/*
263 * Try to read the location of the git directory from the .git file,
264 * return path to git directory if found.
265 */
266const char *read_gitfile_gently(const char *path)
267{
268 char *buf;
40c813e0
BK
269 char *dir;
270 const char *slash;
b44ebb19
LH
271 struct stat st;
272 int fd;
273 size_t len;
274
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)
d824cbba 281 die_errno("Error opening '%s'", path);
b44ebb19
LH
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';
40c813e0
BK
295 dir = buf + 8;
296
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;
306 }
307
308 if (!is_git_directory(dir))
309 die("Not a git repository: %s", dir);
310 path = make_absolute_path(dir);
311
b44ebb19
LH
312 free(buf);
313 return path;
314}
315
e4e30347
JN
316static const char *setup_explicit_git_dir(const char *gitdirenv,
317 const char *work_tree_env, int *nongit_ok)
318{
319 static char buffer[1024 + 1];
320 const char *retval;
321
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;
328 }
329 die("Not a git repository: '%s'", gitdirenv);
330 }
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;
337 }
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;
349}
350
93a00542
JN
351static int cwd_contains_git_dir(const char **gitfile_dirp)
352{
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;
359 }
360 return is_git_directory(DEFAULT_GIT_DIR_ENVIRONMENT);
361}
362
68698da5
JN
363static const char *setup_bare_git_dir(const char *work_tree_env,
364 int offset, int len, char *cwd, int *nongit_ok)
365{
366 int root_len;
367
368 inside_git_dir = 1;
369 if (!work_tree_env)
370 inside_work_tree = 0;
371 if (offset != len) {
372 root_len = offset_1st_component(cwd);
373 cwd[offset > root_len ? offset : root_len] = '\0';
374 set_git_dir(cwd);
375 } else
376 set_git_dir(".");
377 check_repository_format_gently(nongit_ok);
378 return NULL;
379}
380
f161edeb
JN
381static const char *setup_nongit(const char *cwd, int *nongit_ok)
382{
383 if (!nongit_ok)
384 die("Not a git repository (or any of the parent directories): %s", DEFAULT_GIT_DIR_ENVIRONMENT);
385 if (chdir(cwd))
386 die_errno("Cannot come back to cwd");
387 *nongit_ok = 1;
388 return NULL;
389}
390
e90fdc39
JS
391/*
392 * We cannot decide in this function whether we are in the work tree or
393 * not, since the config can only be read _after_ this function was called.
394 */
4ca06608 395const char *setup_git_directory_gently(int *nongit_ok)
d288a700 396{
e90fdc39 397 const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
0454dd93 398 const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
d288a700 399 static char cwd[PATH_MAX+1];
e90fdc39 400 const char *gitdirenv;
b44ebb19 401 const char *gitfile_dir;
72ec8ba6 402 int len, offset, ceil_offset, root_len;
c7d1d1b1
RH
403 dev_t current_device = 0;
404 int one_filesystem = 1;
8030e442 405 struct stat buf;
d288a700 406
af05d679
SG
407 /*
408 * Let's assume that we are in a git repository.
409 * If it turns out later that we are somewhere else, the value will be
410 * updated accordingly.
411 */
412 if (nongit_ok)
413 *nongit_ok = 0;
414
e90fdc39
JS
415 /*
416 * If GIT_DIR is set explicitly, we're not going
417 * to do any discovery, but we still do repository
418 * validation.
419 */
ad1a382f 420 gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
e4e30347
JN
421 if (gitdirenv)
422 return setup_explicit_git_dir(gitdirenv, work_tree_env, nongit_ok);
d288a700 423
f66a4d68 424 if (!getcwd(cwd, sizeof(cwd)-1))
0721c314 425 die_errno("Unable to read current working directory");
d288a700 426
0454dd93 427 ceil_offset = longest_ancestor_length(cwd, env_ceiling_dirs);
17d778e7
JH
428 if (ceil_offset < 0 && has_dos_drive_prefix(cwd))
429 ceil_offset = 1;
d288a700 430
892c41b9 431 /*
e90fdc39 432 * Test in the following order (relative to the cwd):
b44ebb19 433 * - .git (file containing "gitdir: <path>")
e90fdc39
JS
434 * - .git/
435 * - ./ (bare)
b44ebb19 436 * - ../.git
e90fdc39
JS
437 * - ../.git/
438 * - ../ (bare)
439 * - ../../.git/
440 * etc.
892c41b9 441 */
e90fdc39 442 offset = len = strlen(cwd);
cf87463e 443 one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
8030e442
LD
444 if (one_filesystem) {
445 if (stat(".", &buf))
446 die_errno("failed to stat '.'");
447 current_device = buf.st_dev;
448 }
e90fdc39 449 for (;;) {
93a00542 450 if (cwd_contains_git_dir(&gitfile_dir))
e90fdc39 451 break;
68698da5
JN
452 if (is_git_directory("."))
453 return setup_bare_git_dir(work_tree_env, offset,
454 len, cwd, nongit_ok);
0454dd93 455 while (--offset > ceil_offset && cwd[offset] != '/');
f161edeb
JN
456 if (offset <= ceil_offset)
457 return setup_nongit(cwd, nongit_ok);
8030e442
LD
458 if (one_filesystem) {
459 if (stat("..", &buf)) {
460 cwd[offset] = '\0';
461 die_errno("failed to stat '%s/..'", cwd);
462 }
463 if (buf.st_dev != current_device) {
464 if (nongit_ok) {
465 if (chdir(cwd))
466 die_errno("Cannot come back to cwd");
467 *nongit_ok = 1;
468 return NULL;
469 }
470 cwd[offset] = '\0';
471 die("Not a git repository (or any parent up to mount parent %s)\n"
cf87463e 472 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).", cwd);
8030e442
LD
473 }
474 }
502ffe34
LD
475 if (chdir("..")) {
476 cwd[offset] = '\0';
d824cbba 477 die_errno("Cannot change to '%s/..'", cwd);
502ffe34 478 }
892c41b9
ML
479 }
480
e90fdc39
JS
481 inside_git_dir = 0;
482 if (!work_tree_env)
483 inside_work_tree = 1;
72ec8ba6
NTND
484 root_len = offset_1st_component(cwd);
485 git_work_tree_cfg = xstrndup(cwd, offset > root_len ? offset : root_len);
9459aa77
NTND
486 if (check_repository_format_gently(nongit_ok))
487 return NULL;
e90fdc39 488 if (offset == len)
d288a700
LT
489 return NULL;
490
e90fdc39
JS
491 /* Make "offset" point to past the '/', and add a '/' at the end */
492 offset++;
493 cwd[len++] = '/';
494 cwd[len] = 0;
495 return cwd + offset;
d288a700 496}
5e7bfe25 497
94df2506
JH
498int git_config_perm(const char *var, const char *value)
499{
06cbe855
HO
500 int i;
501 char *endptr;
502
503 if (value == NULL)
504 return PERM_GROUP;
505
506 if (!strcmp(value, "umask"))
507 return PERM_UMASK;
508 if (!strcmp(value, "group"))
509 return PERM_GROUP;
510 if (!strcmp(value, "all") ||
511 !strcmp(value, "world") ||
512 !strcmp(value, "everybody"))
513 return PERM_EVERYBODY;
514
515 /* Parse octal numbers */
516 i = strtol(value, &endptr, 8);
517
518 /* If not an octal number, maybe true/false? */
519 if (*endptr != 0)
520 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
521
522 /*
523 * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
5a688fe4 524 * a chmod value to restrict to.
06cbe855
HO
525 */
526 switch (i) {
527 case PERM_UMASK: /* 0 */
528 return PERM_UMASK;
529 case OLD_PERM_GROUP: /* 1 */
530 return PERM_GROUP;
531 case OLD_PERM_EVERYBODY: /* 2 */
532 return PERM_EVERYBODY;
94df2506 533 }
06cbe855
HO
534
535 /* A filemode value was given: 0xxx */
536
537 if ((i & 0600) != 0600)
538 die("Problem with core.sharedRepository filemode value "
539 "(0%.3o).\nThe owner of files must always have "
540 "read and write permissions.", i);
541
542 /*
543 * Mask filemode value. Others can not get write permission.
544 * x flags for directories are handled separately.
545 */
5a688fe4 546 return -(i & 0666);
94df2506
JH
547}
548
ef90d6d4 549int check_repository_format_version(const char *var, const char *value, void *cb)
ab9cb76f 550{
299726d5
JS
551 if (strcmp(var, "core.repositoryformatversion") == 0)
552 repository_format_version = git_config_int(var, value);
457f06d6 553 else if (strcmp(var, "core.sharedrepository") == 0)
94df2506 554 shared_repository = git_config_perm(var, value);
e90fdc39
JS
555 else if (strcmp(var, "core.bare") == 0) {
556 is_bare_repository_cfg = git_config_bool(var, value);
557 if (is_bare_repository_cfg == 1)
558 inside_work_tree = -1;
559 } else if (strcmp(var, "core.worktree") == 0) {
180483c5
JH
560 if (!value)
561 return config_error_nonbool(var);
8e0f7003 562 free(git_work_tree_cfg);
e90fdc39
JS
563 git_work_tree_cfg = xstrdup(value);
564 inside_work_tree = -1;
565 }
299726d5 566 return 0;
ab9cb76f
JH
567}
568
569int check_repository_format(void)
570{
9459aa77 571 return check_repository_format_gently(NULL);
ab9cb76f
JH
572}
573
e1e5ec86
CB
574/*
575 * Returns the "prefix", a path to the current working directory
576 * relative to the work tree root, or NULL, if the current working
577 * directory is not a strict subdirectory of the work tree root. The
578 * prefix always ends with a '/' character.
579 */
5e7bfe25
JH
580const char *setup_git_directory(void)
581{
4ca06608 582 const char *retval = setup_git_directory_gently(NULL);
e90fdc39
JS
583
584 /* If the work tree is not the default one, recompute prefix */
585 if (inside_work_tree < 0) {
586 static char buffer[PATH_MAX + 1];
587 char *rel;
588 if (retval && chdir(retval))
0721c314 589 die_errno ("Could not jump back into original cwd");
e90fdc39 590 rel = get_relative_cwd(buffer, PATH_MAX, get_git_work_tree());
bb528633 591 if (rel && *rel && chdir(get_git_work_tree()))
0721c314 592 die_errno ("Could not jump to working directory");
e90fdc39
JS
593 return rel && *rel ? strcat(rel, "/") : NULL;
594 }
595
5e7bfe25
JH
596 return retval;
597}