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