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