setup: limit get_git_work_tree()'s to explicit setup case only
[git.git] / setup.c
1 #include "cache.h"
2 #include "dir.h"
3
4 static int inside_git_dir = -1;
5 static int inside_work_tree = -1;
6
7 const 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);
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);
17         }
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);
32                 }
33                 if (sanitized[len] == '/')
34                         len++;
35                 memmove(sanitized, sanitized + len, total - len);
36         }
37         return sanitized;
38 }
39
40 /*
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  */
45 const char *prefix_filename(const char *pfx, int pfx_len, const char *arg)
46 {
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;
66 }
67
68 int 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
81 static 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
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  */
100 void verify_filename(const char *prefix, const char *arg)
101 {
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);
107 }
108
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  */
114 void verify_non_filename(const char *prefix, const char *arg)
115 {
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);
124 }
125
126 const char **get_pathspec(const char *prefix, const char **pathspec)
127 {
128         const char *entry = *pathspec;
129         const char **src, **dst;
130         int prefixlen;
131
132         if (!prefix && !entry)
133                 return NULL;
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.. */
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++;
150         }
151         *dst = NULL;
152         if (!*pathspec)
153                 return NULL;
154         return pathspec;
155 }
156
157 /*
158  * Test if it looks like we're at a git directory.
159  * We want to see:
160  *
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.
167  */
168 static int is_git_directory(const char *suspect)
169 {
170         char path[PATH_MAX];
171         size_t len = strlen(suspect);
172
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;
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))
188                 return 0;
189
190         strcpy(path + len, "/HEAD");
191         if (validate_headref(path))
192                 return 0;
193
194         return 1;
195 }
196
197 int is_inside_git_dir(void)
198 {
199         if (inside_git_dir < 0)
200                 inside_git_dir = is_inside_dir(get_git_dir());
201         return inside_git_dir;
202 }
203
204 int is_inside_work_tree(void)
205 {
206         if (inside_work_tree < 0)
207                 inside_work_tree = is_inside_dir(get_git_work_tree());
208         return inside_work_tree;
209 }
210
211 /*
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.
216  */
217 static const char *set_work_tree(const char *dir)
218 {
219         char buffer[PATH_MAX + 1];
220
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;
225
226         return NULL;
227 }
228
229 void setup_work_tree(void)
230 {
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();
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;
244 }
245
246 static int check_repository_format_gently(const char *gitdir, int *nongit_ok)
247 {
248         char repo_config[PATH_MAX+1];
249
250         /*
251          * git_config() can't be used here because it calls git_pathdup()
252          * to get $GIT_CONFIG/config. That call will make setup_git_env()
253          * set git_dir to ".git".
254          *
255          * We are in gitdir setup, no git dir has been found useable yet.
256          * Use a gentler version of git_config() to check if this repo
257          * is a good one.
258          */
259         snprintf(repo_config, PATH_MAX, "%s/config", gitdir);
260         git_config_early(check_repository_format_version, NULL, repo_config);
261         if (GIT_REPO_VERSION < repository_format_version) {
262                 if (!nongit_ok)
263                         die ("Expected git repo version <= %d, found %d",
264                              GIT_REPO_VERSION, repository_format_version);
265                 warning("Expected git repo version <= %d, found %d",
266                         GIT_REPO_VERSION, repository_format_version);
267                 warning("Please upgrade Git");
268                 *nongit_ok = -1;
269                 return -1;
270         }
271         return 0;
272 }
273
274 /*
275  * Try to read the location of the git directory from the .git file,
276  * return path to git directory if found.
277  */
278 const char *read_gitfile_gently(const char *path)
279 {
280         char *buf;
281         char *dir;
282         const char *slash;
283         struct stat st;
284         int fd;
285         size_t len;
286
287         if (stat(path, &st))
288                 return NULL;
289         if (!S_ISREG(st.st_mode))
290                 return NULL;
291         fd = open(path, O_RDONLY);
292         if (fd < 0)
293                 die_errno("Error opening '%s'", path);
294         buf = xmalloc(st.st_size + 1);
295         len = read_in_full(fd, buf, st.st_size);
296         close(fd);
297         if (len != st.st_size)
298                 die("Error reading %s", path);
299         buf[len] = '\0';
300         if (prefixcmp(buf, "gitdir: "))
301                 die("Invalid gitfile format: %s", path);
302         while (buf[len - 1] == '\n' || buf[len - 1] == '\r')
303                 len--;
304         if (len < 9)
305                 die("No path in gitfile: %s", path);
306         buf[len] = '\0';
307         dir = buf + 8;
308
309         if (!is_absolute_path(dir) && (slash = strrchr(path, '/'))) {
310                 size_t pathlen = slash+1 - path;
311                 size_t dirlen = pathlen + len - 8;
312                 dir = xmalloc(dirlen + 1);
313                 strncpy(dir, path, pathlen);
314                 strncpy(dir + pathlen, buf + 8, len - 8);
315                 dir[dirlen] = '\0';
316                 free(buf);
317                 buf = dir;
318         }
319
320         if (!is_git_directory(dir))
321                 die("Not a git repository: %s", dir);
322         path = make_absolute_path(dir);
323
324         free(buf);
325         return path;
326 }
327
328 static const char *setup_explicit_git_dir(const char *gitdirenv,
329                                 const char *work_tree_env, int *nongit_ok)
330 {
331         static char buffer[1024 + 1];
332         const char *retval;
333
334         if (startup_info)
335                 startup_info->setup_explicit = 1;
336         if (PATH_MAX - 40 < strlen(gitdirenv))
337                 die("'$%s' too big", GIT_DIR_ENVIRONMENT);
338         if (!is_git_directory(gitdirenv)) {
339                 if (nongit_ok) {
340                         *nongit_ok = 1;
341                         return NULL;
342                 }
343                 die("Not a git repository: '%s'", gitdirenv);
344         }
345         if (!work_tree_env) {
346                 retval = set_work_tree(gitdirenv);
347                 /* config may override worktree */
348                 if (check_repository_format_gently(gitdirenv, nongit_ok))
349                         return NULL;
350                 return retval;
351         }
352         if (check_repository_format_gently(gitdirenv, nongit_ok))
353                 return NULL;
354         retval = get_relative_cwd(buffer, sizeof(buffer) - 1,
355                         get_git_work_tree());
356         if (!retval || !*retval)
357                 return NULL;
358         set_git_dir(make_absolute_path(gitdirenv));
359         if (chdir(work_tree_env) < 0)
360                 die_errno ("Could not chdir to '%s'", work_tree_env);
361         strcat(buffer, "/");
362         return retval;
363 }
364
365 static int cwd_contains_git_dir(const char **gitfile_dirp)
366 {
367         const char *gitfile_dir = read_gitfile_gently(DEFAULT_GIT_DIR_ENVIRONMENT);
368         *gitfile_dirp = gitfile_dir;
369         if (gitfile_dir) {
370                 if (set_git_dir(gitfile_dir))
371                         die("Repository setup failed");
372                 return 1;
373         }
374         if (is_git_directory(DEFAULT_GIT_DIR_ENVIRONMENT)) {
375                 *gitfile_dirp = DEFAULT_GIT_DIR_ENVIRONMENT;
376                 return 1;
377         }
378         return 0;
379 }
380
381 static const char *setup_discovered_git_dir(const char *work_tree_env,
382                                             const char *gitdir,
383                                             int offset, int len,
384                                             char *cwd, int *nongit_ok)
385 {
386         int root_len;
387         char *work_tree;
388
389         inside_git_dir = 0;
390         if (!work_tree_env)
391                 inside_work_tree = 1;
392         root_len = offset_1st_component(cwd);
393         work_tree = xstrndup(cwd, offset > root_len ? offset : root_len);
394         set_git_work_tree(work_tree);
395         free(work_tree);
396         if (check_repository_format_gently(gitdir, nongit_ok))
397                 return NULL;
398         if (offset == len)
399                 return NULL;
400
401         /* Make "offset" point to past the '/', and add a '/' at the end */
402         offset++;
403         cwd[len++] = '/';
404         cwd[len] = 0;
405         return cwd + offset;
406 }
407
408 static const char *setup_bare_git_dir(const char *work_tree_env,
409                 int offset, int len, char *cwd, int *nongit_ok)
410 {
411         int root_len;
412
413         inside_git_dir = 1;
414         if (!work_tree_env)
415                 inside_work_tree = 0;
416         if (offset != len) {
417                 if (chdir(cwd))
418                         die_errno("Cannot come back to cwd");
419                 root_len = offset_1st_component(cwd);
420                 cwd[offset > root_len ? offset : root_len] = '\0';
421                 set_git_dir(cwd);
422                 check_repository_format_gently(cwd, nongit_ok);
423         }
424         else {
425                 set_git_dir(".");
426                 check_repository_format_gently(".", nongit_ok);
427         }
428         return NULL;
429 }
430
431 static const char *setup_nongit(const char *cwd, int *nongit_ok)
432 {
433         if (!nongit_ok)
434                 die("Not a git repository (or any of the parent directories): %s", DEFAULT_GIT_DIR_ENVIRONMENT);
435         if (chdir(cwd))
436                 die_errno("Cannot come back to cwd");
437         *nongit_ok = 1;
438         return NULL;
439 }
440
441 static dev_t get_device_or_die(const char *path, const char *prefix)
442 {
443         struct stat buf;
444         if (stat(path, &buf))
445                 die_errno("failed to stat '%s%s%s'",
446                                 prefix ? prefix : "",
447                                 prefix ? "/" : "", path);
448         return buf.st_dev;
449 }
450
451 /*
452  * We cannot decide in this function whether we are in the work tree or
453  * not, since the config can only be read _after_ this function was called.
454  */
455 static const char *setup_git_directory_gently_1(int *nongit_ok)
456 {
457         const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
458         const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
459         static char cwd[PATH_MAX+1];
460         const char *gitdirenv;
461         const char *gitfile_dir;
462         int len, offset, ceil_offset;
463         dev_t current_device = 0;
464         int one_filesystem = 1;
465
466         /*
467          * Let's assume that we are in a git repository.
468          * If it turns out later that we are somewhere else, the value will be
469          * updated accordingly.
470          */
471         if (nongit_ok)
472                 *nongit_ok = 0;
473
474         /*
475          * If GIT_DIR is set explicitly, we're not going
476          * to do any discovery, but we still do repository
477          * validation.
478          */
479         gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
480         if (gitdirenv)
481                 return setup_explicit_git_dir(gitdirenv, work_tree_env, nongit_ok);
482
483         if (!getcwd(cwd, sizeof(cwd)-1))
484                 die_errno("Unable to read current working directory");
485
486         ceil_offset = longest_ancestor_length(cwd, env_ceiling_dirs);
487         if (ceil_offset < 0 && has_dos_drive_prefix(cwd))
488                 ceil_offset = 1;
489
490         /*
491          * Test in the following order (relative to the cwd):
492          * - .git (file containing "gitdir: <path>")
493          * - .git/
494          * - ./ (bare)
495          * - ../.git
496          * - ../.git/
497          * - ../ (bare)
498          * - ../../.git/
499          *   etc.
500          */
501         offset = len = strlen(cwd);
502         one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
503         if (one_filesystem)
504                 current_device = get_device_or_die(".", NULL);
505         for (;;) {
506                 if (cwd_contains_git_dir(&gitfile_dir))
507                         return setup_discovered_git_dir(work_tree_env,
508                                                         gitfile_dir,
509                                                         offset, len,
510                                                         cwd, nongit_ok);
511                 if (is_git_directory("."))
512                         return setup_bare_git_dir(work_tree_env, offset,
513                                                         len, cwd, nongit_ok);
514                 while (--offset > ceil_offset && cwd[offset] != '/');
515                 if (offset <= ceil_offset)
516                         return setup_nongit(cwd, nongit_ok);
517                 if (one_filesystem) {
518                         dev_t parent_device = get_device_or_die("..", cwd);
519                         if (parent_device != current_device) {
520                                 if (nongit_ok) {
521                                         if (chdir(cwd))
522                                                 die_errno("Cannot come back to cwd");
523                                         *nongit_ok = 1;
524                                         return NULL;
525                                 }
526                                 cwd[offset] = '\0';
527                                 die("Not a git repository (or any parent up to mount parent %s)\n"
528                                 "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).", cwd);
529                         }
530                 }
531                 if (chdir("..")) {
532                         cwd[offset] = '\0';
533                         die_errno("Cannot change to '%s/..'", cwd);
534                 }
535         }
536 }
537
538 const char *setup_git_directory_gently(int *nongit_ok)
539 {
540         const char *prefix;
541
542         prefix = setup_git_directory_gently_1(nongit_ok);
543         if (startup_info)
544                 startup_info->have_repository = !nongit_ok || !*nongit_ok;
545         return prefix;
546 }
547
548 int git_config_perm(const char *var, const char *value)
549 {
550         int i;
551         char *endptr;
552
553         if (value == NULL)
554                 return PERM_GROUP;
555
556         if (!strcmp(value, "umask"))
557                 return PERM_UMASK;
558         if (!strcmp(value, "group"))
559                 return PERM_GROUP;
560         if (!strcmp(value, "all") ||
561             !strcmp(value, "world") ||
562             !strcmp(value, "everybody"))
563                 return PERM_EVERYBODY;
564
565         /* Parse octal numbers */
566         i = strtol(value, &endptr, 8);
567
568         /* If not an octal number, maybe true/false? */
569         if (*endptr != 0)
570                 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
571
572         /*
573          * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
574          * a chmod value to restrict to.
575          */
576         switch (i) {
577         case PERM_UMASK:               /* 0 */
578                 return PERM_UMASK;
579         case OLD_PERM_GROUP:           /* 1 */
580                 return PERM_GROUP;
581         case OLD_PERM_EVERYBODY:       /* 2 */
582                 return PERM_EVERYBODY;
583         }
584
585         /* A filemode value was given: 0xxx */
586
587         if ((i & 0600) != 0600)
588                 die("Problem with core.sharedRepository filemode value "
589                     "(0%.3o).\nThe owner of files must always have "
590                     "read and write permissions.", i);
591
592         /*
593          * Mask filemode value. Others can not get write permission.
594          * x flags for directories are handled separately.
595          */
596         return -(i & 0666);
597 }
598
599 int check_repository_format_version(const char *var, const char *value, void *cb)
600 {
601         if (strcmp(var, "core.repositoryformatversion") == 0)
602                 repository_format_version = git_config_int(var, value);
603         else if (strcmp(var, "core.sharedrepository") == 0)
604                 shared_repository = git_config_perm(var, value);
605         else if (strcmp(var, "core.bare") == 0) {
606                 is_bare_repository_cfg = git_config_bool(var, value);
607                 if (is_bare_repository_cfg == 1)
608                         inside_work_tree = -1;
609         } else if (strcmp(var, "core.worktree") == 0) {
610                 if (!value)
611                         return config_error_nonbool(var);
612                 free(git_work_tree_cfg);
613                 git_work_tree_cfg = xstrdup(value);
614                 inside_work_tree = -1;
615         }
616         return 0;
617 }
618
619 int check_repository_format(void)
620 {
621         return check_repository_format_gently(get_git_dir(), NULL);
622 }
623
624 /*
625  * Returns the "prefix", a path to the current working directory
626  * relative to the work tree root, or NULL, if the current working
627  * directory is not a strict subdirectory of the work tree root. The
628  * prefix always ends with a '/' character.
629  */
630 const char *setup_git_directory(void)
631 {
632         const char *retval = setup_git_directory_gently(NULL);
633
634         /* If the work tree is not the default one, recompute prefix */
635         if ((!startup_info || startup_info->setup_explicit) &&
636             inside_work_tree < 0) {
637                 static char buffer[PATH_MAX + 1];
638                 char *rel;
639                 if (retval && chdir(retval))
640                         die_errno ("Could not jump back into original cwd");
641                 rel = get_relative_cwd(buffer, PATH_MAX, get_git_work_tree());
642                 if (rel && *rel && chdir(get_git_work_tree()))
643                         die_errno ("Could not jump to working directory");
644                 return rel && *rel ? strcat(rel, "/") : NULL;
645         }
646
647         return retval;
648 }