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