worktree: make high-level pruning re-usable
[git] / setup.c
1 #include "cache.h"
2 #include "repository.h"
3 #include "config.h"
4 #include "dir.h"
5 #include "string-list.h"
6 #include "chdir-notify.h"
7 #include "promisor-remote.h"
8
9 static int inside_git_dir = -1;
10 static int inside_work_tree = -1;
11 static int work_tree_config_is_bogus;
12
13 static struct startup_info the_startup_info;
14 struct startup_info *startup_info = &the_startup_info;
15
16 /*
17  * The input parameter must contain an absolute path, and it must already be
18  * normalized.
19  *
20  * Find the part of an absolute path that lies inside the work tree by
21  * dereferencing symlinks outside the work tree, for example:
22  * /dir1/repo/dir2/file   (work tree is /dir1/repo)      -> dir2/file
23  * /dir/file              (work tree is /)               -> dir/file
24  * /dir/symlink1/symlink2 (symlink1 points to work tree) -> symlink2
25  * /dir/repolink/file     (repolink points to /dir/repo) -> file
26  * /dir/repo              (exactly equal to work tree)   -> (empty string)
27  */
28 static int abspath_part_inside_repo(char *path)
29 {
30         size_t len;
31         size_t wtlen;
32         char *path0;
33         int off;
34         const char *work_tree = get_git_work_tree();
35
36         if (!work_tree)
37                 return -1;
38         wtlen = strlen(work_tree);
39         len = strlen(path);
40         off = offset_1st_component(path);
41
42         /* check if work tree is already the prefix */
43         if (wtlen <= len && !fspathncmp(path, work_tree, wtlen)) {
44                 if (path[wtlen] == '/') {
45                         memmove(path, path + wtlen + 1, len - wtlen);
46                         return 0;
47                 } else if (path[wtlen - 1] == '/' || path[wtlen] == '\0') {
48                         /* work tree is the root, or the whole path */
49                         memmove(path, path + wtlen, len - wtlen + 1);
50                         return 0;
51                 }
52                 /* work tree might match beginning of a symlink to work tree */
53                 off = wtlen;
54         }
55         path0 = path;
56         path += off;
57
58         /* check each '/'-terminated level */
59         while (*path) {
60                 path++;
61                 if (*path == '/') {
62                         *path = '\0';
63                         if (fspathcmp(real_path(path0), work_tree) == 0) {
64                                 memmove(path0, path + 1, len - (path - path0));
65                                 return 0;
66                         }
67                         *path = '/';
68                 }
69         }
70
71         /* check whole path */
72         if (fspathcmp(real_path(path0), work_tree) == 0) {
73                 *path0 = '\0';
74                 return 0;
75         }
76
77         return -1;
78 }
79
80 /*
81  * Normalize "path", prepending the "prefix" for relative paths. If
82  * remaining_prefix is not NULL, return the actual prefix still
83  * remains in the path. For example, prefix = sub1/sub2/ and path is
84  *
85  *  foo          -> sub1/sub2/foo  (full prefix)
86  *  ../foo       -> sub1/foo       (remaining prefix is sub1/)
87  *  ../../bar    -> bar            (no remaining prefix)
88  *  ../../sub1/sub2/foo -> sub1/sub2/foo (but no remaining prefix)
89  *  `pwd`/../bar -> sub1/bar       (no remaining prefix)
90  */
91 char *prefix_path_gently(const char *prefix, int len,
92                          int *remaining_prefix, const char *path)
93 {
94         const char *orig = path;
95         char *sanitized;
96         if (is_absolute_path(orig)) {
97                 sanitized = xmallocz(strlen(path));
98                 if (remaining_prefix)
99                         *remaining_prefix = 0;
100                 if (normalize_path_copy_len(sanitized, path, remaining_prefix)) {
101                         free(sanitized);
102                         return NULL;
103                 }
104                 if (abspath_part_inside_repo(sanitized)) {
105                         free(sanitized);
106                         return NULL;
107                 }
108         } else {
109                 sanitized = xstrfmt("%.*s%s", len, len ? prefix : "", path);
110                 if (remaining_prefix)
111                         *remaining_prefix = len;
112                 if (normalize_path_copy_len(sanitized, sanitized, remaining_prefix)) {
113                         free(sanitized);
114                         return NULL;
115                 }
116         }
117         return sanitized;
118 }
119
120 char *prefix_path(const char *prefix, int len, const char *path)
121 {
122         char *r = prefix_path_gently(prefix, len, NULL, path);
123         if (!r) {
124                 const char *hint_path = get_git_work_tree();
125                 if (!hint_path)
126                         hint_path = get_git_dir();
127                 die(_("'%s' is outside repository at '%s'"), path,
128                     absolute_path(hint_path));
129         }
130         return r;
131 }
132
133 int path_inside_repo(const char *prefix, const char *path)
134 {
135         int len = prefix ? strlen(prefix) : 0;
136         char *r = prefix_path_gently(prefix, len, NULL, path);
137         if (r) {
138                 free(r);
139                 return 1;
140         }
141         return 0;
142 }
143
144 int check_filename(const char *prefix, const char *arg)
145 {
146         char *to_free = NULL;
147         struct stat st;
148
149         if (skip_prefix(arg, ":/", &arg)) {
150                 if (!*arg) /* ":/" is root dir, always exists */
151                         return 1;
152                 prefix = NULL;
153         } else if (skip_prefix(arg, ":!", &arg) ||
154                    skip_prefix(arg, ":^", &arg)) {
155                 if (!*arg) /* excluding everything is silly, but allowed */
156                         return 1;
157         }
158
159         if (prefix)
160                 arg = to_free = prefix_filename(prefix, arg);
161
162         if (!lstat(arg, &st)) {
163                 free(to_free);
164                 return 1; /* file exists */
165         }
166         if (is_missing_file_error(errno)) {
167                 free(to_free);
168                 return 0; /* file does not exist */
169         }
170         die_errno(_("failed to stat '%s'"), arg);
171 }
172
173 static void NORETURN die_verify_filename(struct repository *r,
174                                          const char *prefix,
175                                          const char *arg,
176                                          int diagnose_misspelt_rev)
177 {
178         if (!diagnose_misspelt_rev)
179                 die(_("%s: no such path in the working tree.\n"
180                       "Use 'git <command> -- <path>...' to specify paths that do not exist locally."),
181                     arg);
182         /*
183          * Saying "'(icase)foo' does not exist in the index" when the
184          * user gave us ":(icase)foo" is just stupid.  A magic pathspec
185          * begins with a colon and is followed by a non-alnum; do not
186          * let maybe_die_on_misspelt_object_name() even trigger.
187          */
188         if (!(arg[0] == ':' && !isalnum(arg[1])))
189                 maybe_die_on_misspelt_object_name(r, arg, prefix);
190
191         /* ... or fall back the most general message. */
192         die(_("ambiguous argument '%s': unknown revision or path not in the working tree.\n"
193               "Use '--' to separate paths from revisions, like this:\n"
194               "'git <command> [<revision>...] -- [<file>...]'"), arg);
195
196 }
197
198 /*
199  * Check for arguments that don't resolve as actual files,
200  * but which look sufficiently like pathspecs that we'll consider
201  * them such for the purposes of rev/pathspec DWIM parsing.
202  */
203 static int looks_like_pathspec(const char *arg)
204 {
205         const char *p;
206         int escaped = 0;
207
208         /*
209          * Wildcard characters imply the user is looking to match pathspecs
210          * that aren't in the filesystem. Note that this doesn't include
211          * backslash even though it's a glob special; by itself it doesn't
212          * cause any increase in the match. Likewise ignore backslash-escaped
213          * wildcard characters.
214          */
215         for (p = arg; *p; p++) {
216                 if (escaped) {
217                         escaped = 0;
218                 } else if (is_glob_special(*p)) {
219                         if (*p == '\\')
220                                 escaped = 1;
221                         else
222                                 return 1;
223                 }
224         }
225
226         /* long-form pathspec magic */
227         if (starts_with(arg, ":("))
228                 return 1;
229
230         return 0;
231 }
232
233 /*
234  * Verify a filename that we got as an argument for a pathspec
235  * entry. Note that a filename that begins with "-" never verifies
236  * as true, because even if such a filename were to exist, we want
237  * it to be preceded by the "--" marker (or we want the user to
238  * use a format like "./-filename")
239  *
240  * The "diagnose_misspelt_rev" is used to provide a user-friendly
241  * diagnosis when dying upon finding that "name" is not a pathname.
242  * If set to 1, the diagnosis will try to diagnose "name" as an
243  * invalid object name (e.g. HEAD:foo). If set to 0, the diagnosis
244  * will only complain about an inexisting file.
245  *
246  * This function is typically called to check that a "file or rev"
247  * argument is unambiguous. In this case, the caller will want
248  * diagnose_misspelt_rev == 1 when verifying the first non-rev
249  * argument (which could have been a revision), and
250  * diagnose_misspelt_rev == 0 for the next ones (because we already
251  * saw a filename, there's not ambiguity anymore).
252  */
253 void verify_filename(const char *prefix,
254                      const char *arg,
255                      int diagnose_misspelt_rev)
256 {
257         if (*arg == '-')
258                 die(_("option '%s' must come before non-option arguments"), arg);
259         if (looks_like_pathspec(arg) || check_filename(prefix, arg))
260                 return;
261         die_verify_filename(the_repository, prefix, arg, diagnose_misspelt_rev);
262 }
263
264 /*
265  * Opposite of the above: the command line did not have -- marker
266  * and we parsed the arg as a refname.  It should not be interpretable
267  * as a filename.
268  */
269 void verify_non_filename(const char *prefix, const char *arg)
270 {
271         if (!is_inside_work_tree() || is_inside_git_dir())
272                 return;
273         if (*arg == '-')
274                 return; /* flag */
275         if (!check_filename(prefix, arg))
276                 return;
277         die(_("ambiguous argument '%s': both revision and filename\n"
278               "Use '--' to separate paths from revisions, like this:\n"
279               "'git <command> [<revision>...] -- [<file>...]'"), arg);
280 }
281
282 int get_common_dir(struct strbuf *sb, const char *gitdir)
283 {
284         const char *git_env_common_dir = getenv(GIT_COMMON_DIR_ENVIRONMENT);
285         if (git_env_common_dir) {
286                 strbuf_addstr(sb, git_env_common_dir);
287                 return 1;
288         } else {
289                 return get_common_dir_noenv(sb, gitdir);
290         }
291 }
292
293 int get_common_dir_noenv(struct strbuf *sb, const char *gitdir)
294 {
295         struct strbuf data = STRBUF_INIT;
296         struct strbuf path = STRBUF_INIT;
297         int ret = 0;
298
299         strbuf_addf(&path, "%s/commondir", gitdir);
300         if (file_exists(path.buf)) {
301                 if (strbuf_read_file(&data, path.buf, 0) <= 0)
302                         die_errno(_("failed to read %s"), path.buf);
303                 while (data.len && (data.buf[data.len - 1] == '\n' ||
304                                     data.buf[data.len - 1] == '\r'))
305                         data.len--;
306                 data.buf[data.len] = '\0';
307                 strbuf_reset(&path);
308                 if (!is_absolute_path(data.buf))
309                         strbuf_addf(&path, "%s/", gitdir);
310                 strbuf_addbuf(&path, &data);
311                 strbuf_add_real_path(sb, path.buf);
312                 ret = 1;
313         } else {
314                 strbuf_addstr(sb, gitdir);
315         }
316
317         strbuf_release(&data);
318         strbuf_release(&path);
319         return ret;
320 }
321
322 /*
323  * Test if it looks like we're at a git directory.
324  * We want to see:
325  *
326  *  - either an objects/ directory _or_ the proper
327  *    GIT_OBJECT_DIRECTORY environment variable
328  *  - a refs/ directory
329  *  - either a HEAD symlink or a HEAD file that is formatted as
330  *    a proper "ref:", or a regular file HEAD that has a properly
331  *    formatted sha1 object name.
332  */
333 int is_git_directory(const char *suspect)
334 {
335         struct strbuf path = STRBUF_INIT;
336         int ret = 0;
337         size_t len;
338
339         /* Check worktree-related signatures */
340         strbuf_addstr(&path, suspect);
341         strbuf_complete(&path, '/');
342         strbuf_addstr(&path, "HEAD");
343         if (validate_headref(path.buf))
344                 goto done;
345
346         strbuf_reset(&path);
347         get_common_dir(&path, suspect);
348         len = path.len;
349
350         /* Check non-worktree-related signatures */
351         if (getenv(DB_ENVIRONMENT)) {
352                 if (access(getenv(DB_ENVIRONMENT), X_OK))
353                         goto done;
354         }
355         else {
356                 strbuf_setlen(&path, len);
357                 strbuf_addstr(&path, "/objects");
358                 if (access(path.buf, X_OK))
359                         goto done;
360         }
361
362         strbuf_setlen(&path, len);
363         strbuf_addstr(&path, "/refs");
364         if (access(path.buf, X_OK))
365                 goto done;
366
367         ret = 1;
368 done:
369         strbuf_release(&path);
370         return ret;
371 }
372
373 int is_nonbare_repository_dir(struct strbuf *path)
374 {
375         int ret = 0;
376         int gitfile_error;
377         size_t orig_path_len = path->len;
378         assert(orig_path_len != 0);
379         strbuf_complete(path, '/');
380         strbuf_addstr(path, ".git");
381         if (read_gitfile_gently(path->buf, &gitfile_error) || is_git_directory(path->buf))
382                 ret = 1;
383         if (gitfile_error == READ_GITFILE_ERR_OPEN_FAILED ||
384             gitfile_error == READ_GITFILE_ERR_READ_FAILED)
385                 ret = 1;
386         strbuf_setlen(path, orig_path_len);
387         return ret;
388 }
389
390 int is_inside_git_dir(void)
391 {
392         if (inside_git_dir < 0)
393                 inside_git_dir = is_inside_dir(get_git_dir());
394         return inside_git_dir;
395 }
396
397 int is_inside_work_tree(void)
398 {
399         if (inside_work_tree < 0)
400                 inside_work_tree = is_inside_dir(get_git_work_tree());
401         return inside_work_tree;
402 }
403
404 void setup_work_tree(void)
405 {
406         const char *work_tree;
407         static int initialized = 0;
408
409         if (initialized)
410                 return;
411
412         if (work_tree_config_is_bogus)
413                 die(_("unable to set up work tree using invalid config"));
414
415         work_tree = get_git_work_tree();
416         if (!work_tree || chdir_notify(work_tree))
417                 die(_("this operation must be run in a work tree"));
418
419         /*
420          * Make sure subsequent git processes find correct worktree
421          * if $GIT_WORK_TREE is set relative
422          */
423         if (getenv(GIT_WORK_TREE_ENVIRONMENT))
424                 setenv(GIT_WORK_TREE_ENVIRONMENT, ".", 1);
425
426         initialized = 1;
427 }
428
429 static int read_worktree_config(const char *var, const char *value, void *vdata)
430 {
431         struct repository_format *data = vdata;
432
433         if (strcmp(var, "core.bare") == 0) {
434                 data->is_bare = git_config_bool(var, value);
435         } else if (strcmp(var, "core.worktree") == 0) {
436                 if (!value)
437                         return config_error_nonbool(var);
438                 free(data->work_tree);
439                 data->work_tree = xstrdup(value);
440         }
441         return 0;
442 }
443
444 static int check_repo_format(const char *var, const char *value, void *vdata)
445 {
446         struct repository_format *data = vdata;
447         const char *ext;
448
449         if (strcmp(var, "core.repositoryformatversion") == 0)
450                 data->version = git_config_int(var, value);
451         else if (skip_prefix(var, "extensions.", &ext)) {
452                 /*
453                  * record any known extensions here; otherwise,
454                  * we fall through to recording it as unknown, and
455                  * check_repository_format will complain
456                  */
457                 if (!strcmp(ext, "noop"))
458                         ;
459                 else if (!strcmp(ext, "preciousobjects"))
460                         data->precious_objects = git_config_bool(var, value);
461                 else if (!strcmp(ext, "partialclone")) {
462                         if (!value)
463                                 return config_error_nonbool(var);
464                         data->partial_clone = xstrdup(value);
465                 } else if (!strcmp(ext, "worktreeconfig"))
466                         data->worktree_config = git_config_bool(var, value);
467                 else
468                         string_list_append(&data->unknown_extensions, ext);
469         }
470
471         return read_worktree_config(var, value, vdata);
472 }
473
474 static int check_repository_format_gently(const char *gitdir, struct repository_format *candidate, int *nongit_ok)
475 {
476         struct strbuf sb = STRBUF_INIT;
477         struct strbuf err = STRBUF_INIT;
478         int has_common;
479
480         has_common = get_common_dir(&sb, gitdir);
481         strbuf_addstr(&sb, "/config");
482         read_repository_format(candidate, sb.buf);
483         strbuf_release(&sb);
484
485         /*
486          * For historical use of check_repository_format() in git-init,
487          * we treat a missing config as a silent "ok", even when nongit_ok
488          * is unset.
489          */
490         if (candidate->version < 0)
491                 return 0;
492
493         if (verify_repository_format(candidate, &err) < 0) {
494                 if (nongit_ok) {
495                         warning("%s", err.buf);
496                         strbuf_release(&err);
497                         *nongit_ok = -1;
498                         return -1;
499                 }
500                 die("%s", err.buf);
501         }
502
503         repository_format_precious_objects = candidate->precious_objects;
504         set_repository_format_partial_clone(candidate->partial_clone);
505         repository_format_worktree_config = candidate->worktree_config;
506         string_list_clear(&candidate->unknown_extensions, 0);
507
508         if (repository_format_worktree_config) {
509                 /*
510                  * pick up core.bare and core.worktree from per-worktree
511                  * config if present
512                  */
513                 strbuf_addf(&sb, "%s/config.worktree", gitdir);
514                 git_config_from_file(read_worktree_config, sb.buf, candidate);
515                 strbuf_release(&sb);
516                 has_common = 0;
517         }
518
519         if (!has_common) {
520                 if (candidate->is_bare != -1) {
521                         is_bare_repository_cfg = candidate->is_bare;
522                         if (is_bare_repository_cfg == 1)
523                                 inside_work_tree = -1;
524                 }
525                 if (candidate->work_tree) {
526                         free(git_work_tree_cfg);
527                         git_work_tree_cfg = xstrdup(candidate->work_tree);
528                         inside_work_tree = -1;
529                 }
530         }
531
532         return 0;
533 }
534
535 static void init_repository_format(struct repository_format *format)
536 {
537         const struct repository_format fresh = REPOSITORY_FORMAT_INIT;
538
539         memcpy(format, &fresh, sizeof(fresh));
540 }
541
542 int read_repository_format(struct repository_format *format, const char *path)
543 {
544         clear_repository_format(format);
545         git_config_from_file(check_repo_format, path, format);
546         if (format->version == -1)
547                 clear_repository_format(format);
548         return format->version;
549 }
550
551 void clear_repository_format(struct repository_format *format)
552 {
553         string_list_clear(&format->unknown_extensions, 0);
554         free(format->work_tree);
555         free(format->partial_clone);
556         init_repository_format(format);
557 }
558
559 int verify_repository_format(const struct repository_format *format,
560                              struct strbuf *err)
561 {
562         if (GIT_REPO_VERSION_READ < format->version) {
563                 strbuf_addf(err, _("Expected git repo version <= %d, found %d"),
564                             GIT_REPO_VERSION_READ, format->version);
565                 return -1;
566         }
567
568         if (format->version >= 1 && format->unknown_extensions.nr) {
569                 int i;
570
571                 strbuf_addstr(err, _("unknown repository extensions found:"));
572
573                 for (i = 0; i < format->unknown_extensions.nr; i++)
574                         strbuf_addf(err, "\n\t%s",
575                                     format->unknown_extensions.items[i].string);
576                 return -1;
577         }
578
579         return 0;
580 }
581
582 void read_gitfile_error_die(int error_code, const char *path, const char *dir)
583 {
584         switch (error_code) {
585         case READ_GITFILE_ERR_STAT_FAILED:
586         case READ_GITFILE_ERR_NOT_A_FILE:
587                 /* non-fatal; follow return path */
588                 break;
589         case READ_GITFILE_ERR_OPEN_FAILED:
590                 die_errno(_("error opening '%s'"), path);
591         case READ_GITFILE_ERR_TOO_LARGE:
592                 die(_("too large to be a .git file: '%s'"), path);
593         case READ_GITFILE_ERR_READ_FAILED:
594                 die(_("error reading %s"), path);
595         case READ_GITFILE_ERR_INVALID_FORMAT:
596                 die(_("invalid gitfile format: %s"), path);
597         case READ_GITFILE_ERR_NO_PATH:
598                 die(_("no path in gitfile: %s"), path);
599         case READ_GITFILE_ERR_NOT_A_REPO:
600                 die(_("not a git repository: %s"), dir);
601         default:
602                 BUG("unknown error code");
603         }
604 }
605
606 /*
607  * Try to read the location of the git directory from the .git file,
608  * return path to git directory if found. The return value comes from
609  * a shared buffer.
610  *
611  * On failure, if return_error_code is not NULL, return_error_code
612  * will be set to an error code and NULL will be returned. If
613  * return_error_code is NULL the function will die instead (for most
614  * cases).
615  */
616 const char *read_gitfile_gently(const char *path, int *return_error_code)
617 {
618         const int max_file_size = 1 << 20;  /* 1MB */
619         int error_code = 0;
620         char *buf = NULL;
621         char *dir = NULL;
622         const char *slash;
623         struct stat st;
624         int fd;
625         ssize_t len;
626
627         if (stat(path, &st)) {
628                 /* NEEDSWORK: discern between ENOENT vs other errors */
629                 error_code = READ_GITFILE_ERR_STAT_FAILED;
630                 goto cleanup_return;
631         }
632         if (!S_ISREG(st.st_mode)) {
633                 error_code = READ_GITFILE_ERR_NOT_A_FILE;
634                 goto cleanup_return;
635         }
636         if (st.st_size > max_file_size) {
637                 error_code = READ_GITFILE_ERR_TOO_LARGE;
638                 goto cleanup_return;
639         }
640         fd = open(path, O_RDONLY);
641         if (fd < 0) {
642                 error_code = READ_GITFILE_ERR_OPEN_FAILED;
643                 goto cleanup_return;
644         }
645         buf = xmallocz(st.st_size);
646         len = read_in_full(fd, buf, st.st_size);
647         close(fd);
648         if (len != st.st_size) {
649                 error_code = READ_GITFILE_ERR_READ_FAILED;
650                 goto cleanup_return;
651         }
652         if (!starts_with(buf, "gitdir: ")) {
653                 error_code = READ_GITFILE_ERR_INVALID_FORMAT;
654                 goto cleanup_return;
655         }
656         while (buf[len - 1] == '\n' || buf[len - 1] == '\r')
657                 len--;
658         if (len < 9) {
659                 error_code = READ_GITFILE_ERR_NO_PATH;
660                 goto cleanup_return;
661         }
662         buf[len] = '\0';
663         dir = buf + 8;
664
665         if (!is_absolute_path(dir) && (slash = strrchr(path, '/'))) {
666                 size_t pathlen = slash+1 - path;
667                 dir = xstrfmt("%.*s%.*s", (int)pathlen, path,
668                               (int)(len - 8), buf + 8);
669                 free(buf);
670                 buf = dir;
671         }
672         if (!is_git_directory(dir)) {
673                 error_code = READ_GITFILE_ERR_NOT_A_REPO;
674                 goto cleanup_return;
675         }
676         path = real_path(dir);
677
678 cleanup_return:
679         if (return_error_code)
680                 *return_error_code = error_code;
681         else if (error_code)
682                 read_gitfile_error_die(error_code, path, dir);
683
684         free(buf);
685         return error_code ? NULL : path;
686 }
687
688 static const char *setup_explicit_git_dir(const char *gitdirenv,
689                                           struct strbuf *cwd,
690                                           struct repository_format *repo_fmt,
691                                           int *nongit_ok)
692 {
693         const char *work_tree_env = getenv(GIT_WORK_TREE_ENVIRONMENT);
694         const char *worktree;
695         char *gitfile;
696         int offset;
697
698         if (PATH_MAX - 40 < strlen(gitdirenv))
699                 die(_("'$%s' too big"), GIT_DIR_ENVIRONMENT);
700
701         gitfile = (char*)read_gitfile(gitdirenv);
702         if (gitfile) {
703                 gitfile = xstrdup(gitfile);
704                 gitdirenv = gitfile;
705         }
706
707         if (!is_git_directory(gitdirenv)) {
708                 if (nongit_ok) {
709                         *nongit_ok = 1;
710                         free(gitfile);
711                         return NULL;
712                 }
713                 die(_("not a git repository: '%s'"), gitdirenv);
714         }
715
716         if (check_repository_format_gently(gitdirenv, repo_fmt, nongit_ok)) {
717                 free(gitfile);
718                 return NULL;
719         }
720
721         /* #3, #7, #11, #15, #19, #23, #27, #31 (see t1510) */
722         if (work_tree_env)
723                 set_git_work_tree(work_tree_env);
724         else if (is_bare_repository_cfg > 0) {
725                 if (git_work_tree_cfg) {
726                         /* #22.2, #30 */
727                         warning("core.bare and core.worktree do not make sense");
728                         work_tree_config_is_bogus = 1;
729                 }
730
731                 /* #18, #26 */
732                 set_git_dir(gitdirenv);
733                 free(gitfile);
734                 return NULL;
735         }
736         else if (git_work_tree_cfg) { /* #6, #14 */
737                 if (is_absolute_path(git_work_tree_cfg))
738                         set_git_work_tree(git_work_tree_cfg);
739                 else {
740                         char *core_worktree;
741                         if (chdir(gitdirenv))
742                                 die_errno(_("cannot chdir to '%s'"), gitdirenv);
743                         if (chdir(git_work_tree_cfg))
744                                 die_errno(_("cannot chdir to '%s'"), git_work_tree_cfg);
745                         core_worktree = xgetcwd();
746                         if (chdir(cwd->buf))
747                                 die_errno(_("cannot come back to cwd"));
748                         set_git_work_tree(core_worktree);
749                         free(core_worktree);
750                 }
751         }
752         else if (!git_env_bool(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, 1)) {
753                 /* #16d */
754                 set_git_dir(gitdirenv);
755                 free(gitfile);
756                 return NULL;
757         }
758         else /* #2, #10 */
759                 set_git_work_tree(".");
760
761         /* set_git_work_tree() must have been called by now */
762         worktree = get_git_work_tree();
763
764         /* both get_git_work_tree() and cwd are already normalized */
765         if (!strcmp(cwd->buf, worktree)) { /* cwd == worktree */
766                 set_git_dir(gitdirenv);
767                 free(gitfile);
768                 return NULL;
769         }
770
771         offset = dir_inside_of(cwd->buf, worktree);
772         if (offset >= 0) {      /* cwd inside worktree? */
773                 set_git_dir(real_path(gitdirenv));
774                 if (chdir(worktree))
775                         die_errno(_("cannot chdir to '%s'"), worktree);
776                 strbuf_addch(cwd, '/');
777                 free(gitfile);
778                 return cwd->buf + offset;
779         }
780
781         /* cwd outside worktree */
782         set_git_dir(gitdirenv);
783         free(gitfile);
784         return NULL;
785 }
786
787 static const char *setup_discovered_git_dir(const char *gitdir,
788                                             struct strbuf *cwd, int offset,
789                                             struct repository_format *repo_fmt,
790                                             int *nongit_ok)
791 {
792         if (check_repository_format_gently(gitdir, repo_fmt, nongit_ok))
793                 return NULL;
794
795         /* --work-tree is set without --git-dir; use discovered one */
796         if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
797                 char *to_free = NULL;
798                 const char *ret;
799
800                 if (offset != cwd->len && !is_absolute_path(gitdir))
801                         gitdir = to_free = real_pathdup(gitdir, 1);
802                 if (chdir(cwd->buf))
803                         die_errno(_("cannot come back to cwd"));
804                 ret = setup_explicit_git_dir(gitdir, cwd, repo_fmt, nongit_ok);
805                 free(to_free);
806                 return ret;
807         }
808
809         /* #16.2, #17.2, #20.2, #21.2, #24, #25, #28, #29 (see t1510) */
810         if (is_bare_repository_cfg > 0) {
811                 set_git_dir(offset == cwd->len ? gitdir : real_path(gitdir));
812                 if (chdir(cwd->buf))
813                         die_errno(_("cannot come back to cwd"));
814                 return NULL;
815         }
816
817         /* #0, #1, #5, #8, #9, #12, #13 */
818         set_git_work_tree(".");
819         if (strcmp(gitdir, DEFAULT_GIT_DIR_ENVIRONMENT))
820                 set_git_dir(gitdir);
821         inside_git_dir = 0;
822         inside_work_tree = 1;
823         if (offset >= cwd->len)
824                 return NULL;
825
826         /* Make "offset" point past the '/' (already the case for root dirs) */
827         if (offset != offset_1st_component(cwd->buf))
828                 offset++;
829         /* Add a '/' at the end */
830         strbuf_addch(cwd, '/');
831         return cwd->buf + offset;
832 }
833
834 /* #16.1, #17.1, #20.1, #21.1, #22.1 (see t1510) */
835 static const char *setup_bare_git_dir(struct strbuf *cwd, int offset,
836                                       struct repository_format *repo_fmt,
837                                       int *nongit_ok)
838 {
839         int root_len;
840
841         if (check_repository_format_gently(".", repo_fmt, nongit_ok))
842                 return NULL;
843
844         setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
845
846         /* --work-tree is set without --git-dir; use discovered one */
847         if (getenv(GIT_WORK_TREE_ENVIRONMENT) || git_work_tree_cfg) {
848                 static const char *gitdir;
849
850                 gitdir = offset == cwd->len ? "." : xmemdupz(cwd->buf, offset);
851                 if (chdir(cwd->buf))
852                         die_errno(_("cannot come back to cwd"));
853                 return setup_explicit_git_dir(gitdir, cwd, repo_fmt, nongit_ok);
854         }
855
856         inside_git_dir = 1;
857         inside_work_tree = 0;
858         if (offset != cwd->len) {
859                 if (chdir(cwd->buf))
860                         die_errno(_("cannot come back to cwd"));
861                 root_len = offset_1st_component(cwd->buf);
862                 strbuf_setlen(cwd, offset > root_len ? offset : root_len);
863                 set_git_dir(cwd->buf);
864         }
865         else
866                 set_git_dir(".");
867         return NULL;
868 }
869
870 static dev_t get_device_or_die(const char *path, const char *prefix, int prefix_len)
871 {
872         struct stat buf;
873         if (stat(path, &buf)) {
874                 die_errno(_("failed to stat '%*s%s%s'"),
875                                 prefix_len,
876                                 prefix ? prefix : "",
877                                 prefix ? "/" : "", path);
878         }
879         return buf.st_dev;
880 }
881
882 /*
883  * A "string_list_each_func_t" function that canonicalizes an entry
884  * from GIT_CEILING_DIRECTORIES using real_path_if_valid(), or
885  * discards it if unusable.  The presence of an empty entry in
886  * GIT_CEILING_DIRECTORIES turns off canonicalization for all
887  * subsequent entries.
888  */
889 static int canonicalize_ceiling_entry(struct string_list_item *item,
890                                       void *cb_data)
891 {
892         int *empty_entry_found = cb_data;
893         char *ceil = item->string;
894
895         if (!*ceil) {
896                 *empty_entry_found = 1;
897                 return 0;
898         } else if (!is_absolute_path(ceil)) {
899                 return 0;
900         } else if (*empty_entry_found) {
901                 /* Keep entry but do not canonicalize it */
902                 return 1;
903         } else {
904                 char *real_path = real_pathdup(ceil, 0);
905                 if (!real_path) {
906                         return 0;
907                 }
908                 free(item->string);
909                 item->string = real_path;
910                 return 1;
911         }
912 }
913
914 enum discovery_result {
915         GIT_DIR_NONE = 0,
916         GIT_DIR_EXPLICIT,
917         GIT_DIR_DISCOVERED,
918         GIT_DIR_BARE,
919         /* these are errors */
920         GIT_DIR_HIT_CEILING = -1,
921         GIT_DIR_HIT_MOUNT_POINT = -2,
922         GIT_DIR_INVALID_GITFILE = -3
923 };
924
925 /*
926  * We cannot decide in this function whether we are in the work tree or
927  * not, since the config can only be read _after_ this function was called.
928  *
929  * Also, we avoid changing any global state (such as the current working
930  * directory) to allow early callers.
931  *
932  * The directory where the search should start needs to be passed in via the
933  * `dir` parameter; upon return, the `dir` buffer will contain the path of
934  * the directory where the search ended, and `gitdir` will contain the path of
935  * the discovered .git/ directory, if any. If `gitdir` is not absolute, it
936  * is relative to `dir` (i.e. *not* necessarily the cwd).
937  */
938 static enum discovery_result setup_git_directory_gently_1(struct strbuf *dir,
939                                                           struct strbuf *gitdir,
940                                                           int die_on_error)
941 {
942         const char *env_ceiling_dirs = getenv(CEILING_DIRECTORIES_ENVIRONMENT);
943         struct string_list ceiling_dirs = STRING_LIST_INIT_DUP;
944         const char *gitdirenv;
945         int ceil_offset = -1, min_offset = offset_1st_component(dir->buf);
946         dev_t current_device = 0;
947         int one_filesystem = 1;
948
949         /*
950          * If GIT_DIR is set explicitly, we're not going
951          * to do any discovery, but we still do repository
952          * validation.
953          */
954         gitdirenv = getenv(GIT_DIR_ENVIRONMENT);
955         if (gitdirenv) {
956                 strbuf_addstr(gitdir, gitdirenv);
957                 return GIT_DIR_EXPLICIT;
958         }
959
960         if (env_ceiling_dirs) {
961                 int empty_entry_found = 0;
962
963                 string_list_split(&ceiling_dirs, env_ceiling_dirs, PATH_SEP, -1);
964                 filter_string_list(&ceiling_dirs, 0,
965                                    canonicalize_ceiling_entry, &empty_entry_found);
966                 ceil_offset = longest_ancestor_length(dir->buf, &ceiling_dirs);
967                 string_list_clear(&ceiling_dirs, 0);
968         }
969
970         if (ceil_offset < 0)
971                 ceil_offset = min_offset - 2;
972
973         if (min_offset && min_offset == dir->len &&
974             !is_dir_sep(dir->buf[min_offset - 1])) {
975                 strbuf_addch(dir, '/');
976                 min_offset++;
977         }
978
979         /*
980          * Test in the following order (relative to the dir):
981          * - .git (file containing "gitdir: <path>")
982          * - .git/
983          * - ./ (bare)
984          * - ../.git
985          * - ../.git/
986          * - ../ (bare)
987          * - ../../.git
988          *   etc.
989          */
990         one_filesystem = !git_env_bool("GIT_DISCOVERY_ACROSS_FILESYSTEM", 0);
991         if (one_filesystem)
992                 current_device = get_device_or_die(dir->buf, NULL, 0);
993         for (;;) {
994                 int offset = dir->len, error_code = 0;
995
996                 if (offset > min_offset)
997                         strbuf_addch(dir, '/');
998                 strbuf_addstr(dir, DEFAULT_GIT_DIR_ENVIRONMENT);
999                 gitdirenv = read_gitfile_gently(dir->buf, die_on_error ?
1000                                                 NULL : &error_code);
1001                 if (!gitdirenv) {
1002                         if (die_on_error ||
1003                             error_code == READ_GITFILE_ERR_NOT_A_FILE) {
1004                                 /* NEEDSWORK: fail if .git is not file nor dir */
1005                                 if (is_git_directory(dir->buf))
1006                                         gitdirenv = DEFAULT_GIT_DIR_ENVIRONMENT;
1007                         } else if (error_code != READ_GITFILE_ERR_STAT_FAILED)
1008                                 return GIT_DIR_INVALID_GITFILE;
1009                 }
1010                 strbuf_setlen(dir, offset);
1011                 if (gitdirenv) {
1012                         strbuf_addstr(gitdir, gitdirenv);
1013                         return GIT_DIR_DISCOVERED;
1014                 }
1015
1016                 if (is_git_directory(dir->buf)) {
1017                         strbuf_addstr(gitdir, ".");
1018                         return GIT_DIR_BARE;
1019                 }
1020
1021                 if (offset <= min_offset)
1022                         return GIT_DIR_HIT_CEILING;
1023
1024                 while (--offset > ceil_offset && !is_dir_sep(dir->buf[offset]))
1025                         ; /* continue */
1026                 if (offset <= ceil_offset)
1027                         return GIT_DIR_HIT_CEILING;
1028
1029                 strbuf_setlen(dir, offset > min_offset ?  offset : min_offset);
1030                 if (one_filesystem &&
1031                     current_device != get_device_or_die(dir->buf, NULL, offset))
1032                         return GIT_DIR_HIT_MOUNT_POINT;
1033         }
1034 }
1035
1036 int discover_git_directory(struct strbuf *commondir,
1037                            struct strbuf *gitdir)
1038 {
1039         struct strbuf dir = STRBUF_INIT, err = STRBUF_INIT;
1040         size_t gitdir_offset = gitdir->len, cwd_len;
1041         size_t commondir_offset = commondir->len;
1042         struct repository_format candidate = REPOSITORY_FORMAT_INIT;
1043
1044         if (strbuf_getcwd(&dir))
1045                 return -1;
1046
1047         cwd_len = dir.len;
1048         if (setup_git_directory_gently_1(&dir, gitdir, 0) <= 0) {
1049                 strbuf_release(&dir);
1050                 return -1;
1051         }
1052
1053         /*
1054          * The returned gitdir is relative to dir, and if dir does not reflect
1055          * the current working directory, we simply make the gitdir absolute.
1056          */
1057         if (dir.len < cwd_len && !is_absolute_path(gitdir->buf + gitdir_offset)) {
1058                 /* Avoid a trailing "/." */
1059                 if (!strcmp(".", gitdir->buf + gitdir_offset))
1060                         strbuf_setlen(gitdir, gitdir_offset);
1061                 else
1062                         strbuf_addch(&dir, '/');
1063                 strbuf_insert(gitdir, gitdir_offset, dir.buf, dir.len);
1064         }
1065
1066         get_common_dir(commondir, gitdir->buf + gitdir_offset);
1067
1068         strbuf_reset(&dir);
1069         strbuf_addf(&dir, "%s/config", commondir->buf + commondir_offset);
1070         read_repository_format(&candidate, dir.buf);
1071         strbuf_release(&dir);
1072
1073         if (verify_repository_format(&candidate, &err) < 0) {
1074                 warning("ignoring git dir '%s': %s",
1075                         gitdir->buf + gitdir_offset, err.buf);
1076                 strbuf_release(&err);
1077                 strbuf_setlen(commondir, commondir_offset);
1078                 strbuf_setlen(gitdir, gitdir_offset);
1079                 clear_repository_format(&candidate);
1080                 return -1;
1081         }
1082
1083         clear_repository_format(&candidate);
1084         return 0;
1085 }
1086
1087 const char *setup_git_directory_gently(int *nongit_ok)
1088 {
1089         static struct strbuf cwd = STRBUF_INIT;
1090         struct strbuf dir = STRBUF_INIT, gitdir = STRBUF_INIT;
1091         const char *prefix = NULL;
1092         struct repository_format repo_fmt = REPOSITORY_FORMAT_INIT;
1093
1094         /*
1095          * We may have read an incomplete configuration before
1096          * setting-up the git directory. If so, clear the cache so
1097          * that the next queries to the configuration reload complete
1098          * configuration (including the per-repo config file that we
1099          * ignored previously).
1100          */
1101         git_config_clear();
1102
1103         /*
1104          * Let's assume that we are in a git repository.
1105          * If it turns out later that we are somewhere else, the value will be
1106          * updated accordingly.
1107          */
1108         if (nongit_ok)
1109                 *nongit_ok = 0;
1110
1111         if (strbuf_getcwd(&cwd))
1112                 die_errno(_("Unable to read current working directory"));
1113         strbuf_addbuf(&dir, &cwd);
1114
1115         switch (setup_git_directory_gently_1(&dir, &gitdir, 1)) {
1116         case GIT_DIR_EXPLICIT:
1117                 prefix = setup_explicit_git_dir(gitdir.buf, &cwd, &repo_fmt, nongit_ok);
1118                 break;
1119         case GIT_DIR_DISCOVERED:
1120                 if (dir.len < cwd.len && chdir(dir.buf))
1121                         die(_("cannot change to '%s'"), dir.buf);
1122                 prefix = setup_discovered_git_dir(gitdir.buf, &cwd, dir.len,
1123                                                   &repo_fmt, nongit_ok);
1124                 break;
1125         case GIT_DIR_BARE:
1126                 if (dir.len < cwd.len && chdir(dir.buf))
1127                         die(_("cannot change to '%s'"), dir.buf);
1128                 prefix = setup_bare_git_dir(&cwd, dir.len, &repo_fmt, nongit_ok);
1129                 break;
1130         case GIT_DIR_HIT_CEILING:
1131                 if (!nongit_ok)
1132                         die(_("not a git repository (or any of the parent directories): %s"),
1133                             DEFAULT_GIT_DIR_ENVIRONMENT);
1134                 *nongit_ok = 1;
1135                 break;
1136         case GIT_DIR_HIT_MOUNT_POINT:
1137                 if (!nongit_ok)
1138                         die(_("not a git repository (or any parent up to mount point %s)\n"
1139                               "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set)."),
1140                             dir.buf);
1141                 *nongit_ok = 1;
1142                 break;
1143         case GIT_DIR_NONE:
1144                 /*
1145                  * As a safeguard against setup_git_directory_gently_1 returning
1146                  * this value, fallthrough to BUG. Otherwise it is possible to
1147                  * set startup_info->have_repository to 1 when we did nothing to
1148                  * find a repository.
1149                  */
1150         default:
1151                 BUG("unhandled setup_git_directory_1() result");
1152         }
1153
1154         /*
1155          * At this point, nongit_ok is stable. If it is non-NULL and points
1156          * to a non-zero value, then this means that we haven't found a
1157          * repository and that the caller expects startup_info to reflect
1158          * this.
1159          *
1160          * Regardless of the state of nongit_ok, startup_info->prefix and
1161          * the GIT_PREFIX environment variable must always match. For details
1162          * see Documentation/config/alias.txt.
1163          */
1164         if (nongit_ok && *nongit_ok) {
1165                 startup_info->have_repository = 0;
1166                 startup_info->prefix = NULL;
1167                 setenv(GIT_PREFIX_ENVIRONMENT, "", 1);
1168         } else {
1169                 startup_info->have_repository = 1;
1170                 startup_info->prefix = prefix;
1171                 if (prefix)
1172                         setenv(GIT_PREFIX_ENVIRONMENT, prefix, 1);
1173                 else
1174                         setenv(GIT_PREFIX_ENVIRONMENT, "", 1);
1175         }
1176
1177         /*
1178          * Not all paths through the setup code will call 'set_git_dir()' (which
1179          * directly sets up the environment) so in order to guarantee that the
1180          * environment is in a consistent state after setup, explicitly setup
1181          * the environment if we have a repository.
1182          *
1183          * NEEDSWORK: currently we allow bogus GIT_DIR values to be set in some
1184          * code paths so we also need to explicitly setup the environment if
1185          * the user has set GIT_DIR.  It may be beneficial to disallow bogus
1186          * GIT_DIR values at some point in the future.
1187          */
1188         if (/* GIT_DIR_EXPLICIT, GIT_DIR_DISCOVERED, GIT_DIR_BARE */
1189             startup_info->have_repository ||
1190             /* GIT_DIR_EXPLICIT */
1191             getenv(GIT_DIR_ENVIRONMENT)) {
1192                 if (!the_repository->gitdir) {
1193                         const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
1194                         if (!gitdir)
1195                                 gitdir = DEFAULT_GIT_DIR_ENVIRONMENT;
1196                         setup_git_env(gitdir);
1197                 }
1198                 if (startup_info->have_repository)
1199                         repo_set_hash_algo(the_repository, repo_fmt.hash_algo);
1200         }
1201
1202         strbuf_release(&dir);
1203         strbuf_release(&gitdir);
1204         clear_repository_format(&repo_fmt);
1205
1206         return prefix;
1207 }
1208
1209 int git_config_perm(const char *var, const char *value)
1210 {
1211         int i;
1212         char *endptr;
1213
1214         if (value == NULL)
1215                 return PERM_GROUP;
1216
1217         if (!strcmp(value, "umask"))
1218                 return PERM_UMASK;
1219         if (!strcmp(value, "group"))
1220                 return PERM_GROUP;
1221         if (!strcmp(value, "all") ||
1222             !strcmp(value, "world") ||
1223             !strcmp(value, "everybody"))
1224                 return PERM_EVERYBODY;
1225
1226         /* Parse octal numbers */
1227         i = strtol(value, &endptr, 8);
1228
1229         /* If not an octal number, maybe true/false? */
1230         if (*endptr != 0)
1231                 return git_config_bool(var, value) ? PERM_GROUP : PERM_UMASK;
1232
1233         /*
1234          * Treat values 0, 1 and 2 as compatibility cases, otherwise it is
1235          * a chmod value to restrict to.
1236          */
1237         switch (i) {
1238         case PERM_UMASK:               /* 0 */
1239                 return PERM_UMASK;
1240         case OLD_PERM_GROUP:           /* 1 */
1241                 return PERM_GROUP;
1242         case OLD_PERM_EVERYBODY:       /* 2 */
1243                 return PERM_EVERYBODY;
1244         }
1245
1246         /* A filemode value was given: 0xxx */
1247
1248         if ((i & 0600) != 0600)
1249                 die(_("problem with core.sharedRepository filemode value "
1250                     "(0%.3o).\nThe owner of files must always have "
1251                     "read and write permissions."), i);
1252
1253         /*
1254          * Mask filemode value. Others can not get write permission.
1255          * x flags for directories are handled separately.
1256          */
1257         return -(i & 0666);
1258 }
1259
1260 void check_repository_format(void)
1261 {
1262         struct repository_format repo_fmt = REPOSITORY_FORMAT_INIT;
1263         check_repository_format_gently(get_git_dir(), &repo_fmt, NULL);
1264         startup_info->have_repository = 1;
1265         clear_repository_format(&repo_fmt);
1266 }
1267
1268 /*
1269  * Returns the "prefix", a path to the current working directory
1270  * relative to the work tree root, or NULL, if the current working
1271  * directory is not a strict subdirectory of the work tree root. The
1272  * prefix always ends with a '/' character.
1273  */
1274 const char *setup_git_directory(void)
1275 {
1276         return setup_git_directory_gently(NULL);
1277 }
1278
1279 const char *resolve_gitdir_gently(const char *suspect, int *return_error_code)
1280 {
1281         if (is_git_directory(suspect))
1282                 return suspect;
1283         return read_gitfile_gently(suspect, return_error_code);
1284 }
1285
1286 /* if any standard file descriptor is missing open it to /dev/null */
1287 void sanitize_stdfds(void)
1288 {
1289         int fd = open("/dev/null", O_RDWR, 0);
1290         while (fd != -1 && fd < 2)
1291                 fd = dup(fd);
1292         if (fd == -1)
1293                 die_errno(_("open /dev/null or dup failed"));
1294         if (fd > 2)
1295                 close(fd);
1296 }
1297
1298 int daemonize(void)
1299 {
1300 #ifdef NO_POSIX_GOODIES
1301         errno = ENOSYS;
1302         return -1;
1303 #else
1304         switch (fork()) {
1305                 case 0:
1306                         break;
1307                 case -1:
1308                         die_errno(_("fork failed"));
1309                 default:
1310                         exit(0);
1311         }
1312         if (setsid() == -1)
1313                 die_errno(_("setsid failed"));
1314         close(0);
1315         close(1);
1316         close(2);
1317         sanitize_stdfds();
1318         return 0;
1319 #endif
1320 }