config.con commit Merge branch 'jt/doc-pack-objects-fix' (138e52e)
   1/*
   2 * GIT - The information manager from hell
   3 *
   4 * Copyright (C) Linus Torvalds, 2005
   5 * Copyright (C) Johannes Schindelin, 2005
   6 *
   7 */
   8#include "cache.h"
   9#include "config.h"
  10#include "repository.h"
  11#include "lockfile.h"
  12#include "exec_cmd.h"
  13#include "strbuf.h"
  14#include "quote.h"
  15#include "hashmap.h"
  16#include "string-list.h"
  17#include "utf8.h"
  18#include "dir.h"
  19#include "color.h"
  20
  21struct config_source {
  22        struct config_source *prev;
  23        union {
  24                FILE *file;
  25                struct config_buf {
  26                        const char *buf;
  27                        size_t len;
  28                        size_t pos;
  29                } buf;
  30        } u;
  31        enum config_origin_type origin_type;
  32        const char *name;
  33        const char *path;
  34        int die_on_error;
  35        int linenr;
  36        int eof;
  37        struct strbuf value;
  38        struct strbuf var;
  39
  40        int (*do_fgetc)(struct config_source *c);
  41        int (*do_ungetc)(int c, struct config_source *conf);
  42        long (*do_ftell)(struct config_source *c);
  43};
  44
  45/*
  46 * These variables record the "current" config source, which
  47 * can be accessed by parsing callbacks.
  48 *
  49 * The "cf" variable will be non-NULL only when we are actually parsing a real
  50 * config source (file, blob, cmdline, etc).
  51 *
  52 * The "current_config_kvi" variable will be non-NULL only when we are feeding
  53 * cached config from a configset into a callback.
  54 *
  55 * They should generally never be non-NULL at the same time. If they are both
  56 * NULL, then we aren't parsing anything (and depending on the function looking
  57 * at the variables, it's either a bug for it to be called in the first place,
  58 * or it's a function which can be reused for non-config purposes, and should
  59 * fall back to some sane behavior).
  60 */
  61static struct config_source *cf;
  62static struct key_value_info *current_config_kvi;
  63
  64/*
  65 * Similar to the variables above, this gives access to the "scope" of the
  66 * current value (repo, global, etc). For cached values, it can be found via
  67 * the current_config_kvi as above. During parsing, the current value can be
  68 * found in this variable. It's not part of "cf" because it transcends a single
  69 * file (i.e., a file included from .git/config is still in "repo" scope).
  70 */
  71static enum config_scope current_parsing_scope;
  72
  73static int core_compression_seen;
  74static int pack_compression_seen;
  75static int zlib_compression_seen;
  76
  77static int config_file_fgetc(struct config_source *conf)
  78{
  79        return getc_unlocked(conf->u.file);
  80}
  81
  82static int config_file_ungetc(int c, struct config_source *conf)
  83{
  84        return ungetc(c, conf->u.file);
  85}
  86
  87static long config_file_ftell(struct config_source *conf)
  88{
  89        return ftell(conf->u.file);
  90}
  91
  92
  93static int config_buf_fgetc(struct config_source *conf)
  94{
  95        if (conf->u.buf.pos < conf->u.buf.len)
  96                return conf->u.buf.buf[conf->u.buf.pos++];
  97
  98        return EOF;
  99}
 100
 101static int config_buf_ungetc(int c, struct config_source *conf)
 102{
 103        if (conf->u.buf.pos > 0) {
 104                conf->u.buf.pos--;
 105                if (conf->u.buf.buf[conf->u.buf.pos] != c)
 106                        die("BUG: config_buf can only ungetc the same character");
 107                return c;
 108        }
 109
 110        return EOF;
 111}
 112
 113static long config_buf_ftell(struct config_source *conf)
 114{
 115        return conf->u.buf.pos;
 116}
 117
 118#define MAX_INCLUDE_DEPTH 10
 119static const char include_depth_advice[] =
 120"exceeded maximum include depth (%d) while including\n"
 121"       %s\n"
 122"from\n"
 123"       %s\n"
 124"Do you have circular includes?";
 125static int handle_path_include(const char *path, struct config_include_data *inc)
 126{
 127        int ret = 0;
 128        struct strbuf buf = STRBUF_INIT;
 129        char *expanded;
 130
 131        if (!path)
 132                return config_error_nonbool("include.path");
 133
 134        expanded = expand_user_path(path, 0);
 135        if (!expanded)
 136                return error("could not expand include path '%s'", path);
 137        path = expanded;
 138
 139        /*
 140         * Use an absolute path as-is, but interpret relative paths
 141         * based on the including config file.
 142         */
 143        if (!is_absolute_path(path)) {
 144                char *slash;
 145
 146                if (!cf || !cf->path)
 147                        return error("relative config includes must come from files");
 148
 149                slash = find_last_dir_sep(cf->path);
 150                if (slash)
 151                        strbuf_add(&buf, cf->path, slash - cf->path + 1);
 152                strbuf_addstr(&buf, path);
 153                path = buf.buf;
 154        }
 155
 156        if (!access_or_die(path, R_OK, 0)) {
 157                if (++inc->depth > MAX_INCLUDE_DEPTH)
 158                        die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
 159                            !cf ? "<unknown>" :
 160                            cf->name ? cf->name :
 161                            "the command line");
 162                ret = git_config_from_file(git_config_include, path, inc);
 163                inc->depth--;
 164        }
 165        strbuf_release(&buf);
 166        free(expanded);
 167        return ret;
 168}
 169
 170static int prepare_include_condition_pattern(struct strbuf *pat)
 171{
 172        struct strbuf path = STRBUF_INIT;
 173        char *expanded;
 174        int prefix = 0;
 175
 176        expanded = expand_user_path(pat->buf, 1);
 177        if (expanded) {
 178                strbuf_reset(pat);
 179                strbuf_addstr(pat, expanded);
 180                free(expanded);
 181        }
 182
 183        if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
 184                const char *slash;
 185
 186                if (!cf || !cf->path)
 187                        return error(_("relative config include "
 188                                       "conditionals must come from files"));
 189
 190                strbuf_realpath(&path, cf->path, 1);
 191                slash = find_last_dir_sep(path.buf);
 192                if (!slash)
 193                        die("BUG: how is this possible?");
 194                strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
 195                prefix = slash - path.buf + 1 /* slash */;
 196        } else if (!is_absolute_path(pat->buf))
 197                strbuf_insert(pat, 0, "**/", 3);
 198
 199        if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
 200                strbuf_addstr(pat, "**");
 201
 202        strbuf_release(&path);
 203        return prefix;
 204}
 205
 206static int include_by_gitdir(const struct config_options *opts,
 207                             const char *cond, size_t cond_len, int icase)
 208{
 209        struct strbuf text = STRBUF_INIT;
 210        struct strbuf pattern = STRBUF_INIT;
 211        int ret = 0, prefix;
 212        const char *git_dir;
 213        int already_tried_absolute = 0;
 214
 215        if (opts->git_dir)
 216                git_dir = opts->git_dir;
 217        else
 218                goto done;
 219
 220        strbuf_realpath(&text, git_dir, 1);
 221        strbuf_add(&pattern, cond, cond_len);
 222        prefix = prepare_include_condition_pattern(&pattern);
 223
 224again:
 225        if (prefix < 0)
 226                goto done;
 227
 228        if (prefix > 0) {
 229                /*
 230                 * perform literal matching on the prefix part so that
 231                 * any wildcard character in it can't create side effects.
 232                 */
 233                if (text.len < prefix)
 234                        goto done;
 235                if (!icase && strncmp(pattern.buf, text.buf, prefix))
 236                        goto done;
 237                if (icase && strncasecmp(pattern.buf, text.buf, prefix))
 238                        goto done;
 239        }
 240
 241        ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
 242                         icase ? WM_CASEFOLD : 0);
 243
 244        if (!ret && !already_tried_absolute) {
 245                /*
 246                 * We've tried e.g. matching gitdir:~/work, but if
 247                 * ~/work is a symlink to /mnt/storage/work
 248                 * strbuf_realpath() will expand it, so the rule won't
 249                 * match. Let's match against a
 250                 * strbuf_add_absolute_path() version of the path,
 251                 * which'll do the right thing
 252                 */
 253                strbuf_reset(&text);
 254                strbuf_add_absolute_path(&text, git_dir);
 255                already_tried_absolute = 1;
 256                goto again;
 257        }
 258done:
 259        strbuf_release(&pattern);
 260        strbuf_release(&text);
 261        return ret;
 262}
 263
 264static int include_condition_is_true(const struct config_options *opts,
 265                                     const char *cond, size_t cond_len)
 266{
 267
 268        if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
 269                return include_by_gitdir(opts, cond, cond_len, 0);
 270        else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
 271                return include_by_gitdir(opts, cond, cond_len, 1);
 272
 273        /* unknown conditionals are always false */
 274        return 0;
 275}
 276
 277int git_config_include(const char *var, const char *value, void *data)
 278{
 279        struct config_include_data *inc = data;
 280        const char *cond, *key;
 281        int cond_len;
 282        int ret;
 283
 284        /*
 285         * Pass along all values, including "include" directives; this makes it
 286         * possible to query information on the includes themselves.
 287         */
 288        ret = inc->fn(var, value, inc->data);
 289        if (ret < 0)
 290                return ret;
 291
 292        if (!strcmp(var, "include.path"))
 293                ret = handle_path_include(value, inc);
 294
 295        if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
 296            (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
 297            !strcmp(key, "path"))
 298                ret = handle_path_include(value, inc);
 299
 300        return ret;
 301}
 302
 303void git_config_push_parameter(const char *text)
 304{
 305        struct strbuf env = STRBUF_INIT;
 306        const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
 307        if (old && *old) {
 308                strbuf_addstr(&env, old);
 309                strbuf_addch(&env, ' ');
 310        }
 311        sq_quote_buf(&env, text);
 312        setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
 313        strbuf_release(&env);
 314}
 315
 316static inline int iskeychar(int c)
 317{
 318        return isalnum(c) || c == '-';
 319}
 320
 321/*
 322 * Auxiliary function to sanity-check and split the key into the section
 323 * identifier and variable name.
 324 *
 325 * Returns 0 on success, -1 when there is an invalid character in the key and
 326 * -2 if there is no section name in the key.
 327 *
 328 * store_key - pointer to char* which will hold a copy of the key with
 329 *             lowercase section and variable name
 330 * baselen - pointer to int which will hold the length of the
 331 *           section + subsection part, can be NULL
 332 */
 333static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
 334{
 335        int i, dot, baselen;
 336        const char *last_dot = strrchr(key, '.');
 337
 338        /*
 339         * Since "key" actually contains the section name and the real
 340         * key name separated by a dot, we have to know where the dot is.
 341         */
 342
 343        if (last_dot == NULL || last_dot == key) {
 344                if (!quiet)
 345                        error("key does not contain a section: %s", key);
 346                return -CONFIG_NO_SECTION_OR_NAME;
 347        }
 348
 349        if (!last_dot[1]) {
 350                if (!quiet)
 351                        error("key does not contain variable name: %s", key);
 352                return -CONFIG_NO_SECTION_OR_NAME;
 353        }
 354
 355        baselen = last_dot - key;
 356        if (baselen_)
 357                *baselen_ = baselen;
 358
 359        /*
 360         * Validate the key and while at it, lower case it for matching.
 361         */
 362        if (store_key)
 363                *store_key = xmallocz(strlen(key));
 364
 365        dot = 0;
 366        for (i = 0; key[i]; i++) {
 367                unsigned char c = key[i];
 368                if (c == '.')
 369                        dot = 1;
 370                /* Leave the extended basename untouched.. */
 371                if (!dot || i > baselen) {
 372                        if (!iskeychar(c) ||
 373                            (i == baselen + 1 && !isalpha(c))) {
 374                                if (!quiet)
 375                                        error("invalid key: %s", key);
 376                                goto out_free_ret_1;
 377                        }
 378                        c = tolower(c);
 379                } else if (c == '\n') {
 380                        if (!quiet)
 381                                error("invalid key (newline): %s", key);
 382                        goto out_free_ret_1;
 383                }
 384                if (store_key)
 385                        (*store_key)[i] = c;
 386        }
 387
 388        return 0;
 389
 390out_free_ret_1:
 391        if (store_key) {
 392                FREE_AND_NULL(*store_key);
 393        }
 394        return -CONFIG_INVALID_KEY;
 395}
 396
 397int git_config_parse_key(const char *key, char **store_key, int *baselen)
 398{
 399        return git_config_parse_key_1(key, store_key, baselen, 0);
 400}
 401
 402int git_config_key_is_valid(const char *key)
 403{
 404        return !git_config_parse_key_1(key, NULL, NULL, 1);
 405}
 406
 407int git_config_parse_parameter(const char *text,
 408                               config_fn_t fn, void *data)
 409{
 410        const char *value;
 411        char *canonical_name;
 412        struct strbuf **pair;
 413        int ret;
 414
 415        pair = strbuf_split_str(text, '=', 2);
 416        if (!pair[0])
 417                return error("bogus config parameter: %s", text);
 418
 419        if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
 420                strbuf_setlen(pair[0], pair[0]->len - 1);
 421                value = pair[1] ? pair[1]->buf : "";
 422        } else {
 423                value = NULL;
 424        }
 425
 426        strbuf_trim(pair[0]);
 427        if (!pair[0]->len) {
 428                strbuf_list_free(pair);
 429                return error("bogus config parameter: %s", text);
 430        }
 431
 432        if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
 433                ret = -1;
 434        } else {
 435                ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
 436                free(canonical_name);
 437        }
 438        strbuf_list_free(pair);
 439        return ret;
 440}
 441
 442int git_config_from_parameters(config_fn_t fn, void *data)
 443{
 444        const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
 445        int ret = 0;
 446        char *envw;
 447        const char **argv = NULL;
 448        int nr = 0, alloc = 0;
 449        int i;
 450        struct config_source source;
 451
 452        if (!env)
 453                return 0;
 454
 455        memset(&source, 0, sizeof(source));
 456        source.prev = cf;
 457        source.origin_type = CONFIG_ORIGIN_CMDLINE;
 458        cf = &source;
 459
 460        /* sq_dequote will write over it */
 461        envw = xstrdup(env);
 462
 463        if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
 464                ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
 465                goto out;
 466        }
 467
 468        for (i = 0; i < nr; i++) {
 469                if (git_config_parse_parameter(argv[i], fn, data) < 0) {
 470                        ret = -1;
 471                        goto out;
 472                }
 473        }
 474
 475out:
 476        free(argv);
 477        free(envw);
 478        cf = source.prev;
 479        return ret;
 480}
 481
 482static int get_next_char(void)
 483{
 484        int c = cf->do_fgetc(cf);
 485
 486        if (c == '\r') {
 487                /* DOS like systems */
 488                c = cf->do_fgetc(cf);
 489                if (c != '\n') {
 490                        if (c != EOF)
 491                                cf->do_ungetc(c, cf);
 492                        c = '\r';
 493                }
 494        }
 495        if (c == '\n')
 496                cf->linenr++;
 497        if (c == EOF) {
 498                cf->eof = 1;
 499                cf->linenr++;
 500                c = '\n';
 501        }
 502        return c;
 503}
 504
 505static char *parse_value(void)
 506{
 507        int quote = 0, comment = 0, space = 0;
 508
 509        strbuf_reset(&cf->value);
 510        for (;;) {
 511                int c = get_next_char();
 512                if (c == '\n') {
 513                        if (quote) {
 514                                cf->linenr--;
 515                                return NULL;
 516                        }
 517                        return cf->value.buf;
 518                }
 519                if (comment)
 520                        continue;
 521                if (isspace(c) && !quote) {
 522                        if (cf->value.len)
 523                                space++;
 524                        continue;
 525                }
 526                if (!quote) {
 527                        if (c == ';' || c == '#') {
 528                                comment = 1;
 529                                continue;
 530                        }
 531                }
 532                for (; space; space--)
 533                        strbuf_addch(&cf->value, ' ');
 534                if (c == '\\') {
 535                        c = get_next_char();
 536                        switch (c) {
 537                        case '\n':
 538                                continue;
 539                        case 't':
 540                                c = '\t';
 541                                break;
 542                        case 'b':
 543                                c = '\b';
 544                                break;
 545                        case 'n':
 546                                c = '\n';
 547                                break;
 548                        /* Some characters escape as themselves */
 549                        case '\\': case '"':
 550                                break;
 551                        /* Reject unknown escape sequences */
 552                        default:
 553                                return NULL;
 554                        }
 555                        strbuf_addch(&cf->value, c);
 556                        continue;
 557                }
 558                if (c == '"') {
 559                        quote = 1-quote;
 560                        continue;
 561                }
 562                strbuf_addch(&cf->value, c);
 563        }
 564}
 565
 566static int get_value(config_fn_t fn, void *data, struct strbuf *name)
 567{
 568        int c;
 569        char *value;
 570        int ret;
 571
 572        /* Get the full name */
 573        for (;;) {
 574                c = get_next_char();
 575                if (cf->eof)
 576                        break;
 577                if (!iskeychar(c))
 578                        break;
 579                strbuf_addch(name, tolower(c));
 580        }
 581
 582        while (c == ' ' || c == '\t')
 583                c = get_next_char();
 584
 585        value = NULL;
 586        if (c != '\n') {
 587                if (c != '=')
 588                        return -1;
 589                value = parse_value();
 590                if (!value)
 591                        return -1;
 592        }
 593        /*
 594         * We already consumed the \n, but we need linenr to point to
 595         * the line we just parsed during the call to fn to get
 596         * accurate line number in error messages.
 597         */
 598        cf->linenr--;
 599        ret = fn(name->buf, value, data);
 600        if (ret >= 0)
 601                cf->linenr++;
 602        return ret;
 603}
 604
 605static int get_extended_base_var(struct strbuf *name, int c)
 606{
 607        do {
 608                if (c == '\n')
 609                        goto error_incomplete_line;
 610                c = get_next_char();
 611        } while (isspace(c));
 612
 613        /* We require the format to be '[base "extension"]' */
 614        if (c != '"')
 615                return -1;
 616        strbuf_addch(name, '.');
 617
 618        for (;;) {
 619                int c = get_next_char();
 620                if (c == '\n')
 621                        goto error_incomplete_line;
 622                if (c == '"')
 623                        break;
 624                if (c == '\\') {
 625                        c = get_next_char();
 626                        if (c == '\n')
 627                                goto error_incomplete_line;
 628                }
 629                strbuf_addch(name, c);
 630        }
 631
 632        /* Final ']' */
 633        if (get_next_char() != ']')
 634                return -1;
 635        return 0;
 636error_incomplete_line:
 637        cf->linenr--;
 638        return -1;
 639}
 640
 641static int get_base_var(struct strbuf *name)
 642{
 643        for (;;) {
 644                int c = get_next_char();
 645                if (cf->eof)
 646                        return -1;
 647                if (c == ']')
 648                        return 0;
 649                if (isspace(c))
 650                        return get_extended_base_var(name, c);
 651                if (!iskeychar(c) && c != '.')
 652                        return -1;
 653                strbuf_addch(name, tolower(c));
 654        }
 655}
 656
 657static int git_parse_source(config_fn_t fn, void *data)
 658{
 659        int comment = 0;
 660        int baselen = 0;
 661        struct strbuf *var = &cf->var;
 662        int error_return = 0;
 663        char *error_msg = NULL;
 664
 665        /* U+FEFF Byte Order Mark in UTF8 */
 666        const char *bomptr = utf8_bom;
 667
 668        for (;;) {
 669                int c = get_next_char();
 670                if (bomptr && *bomptr) {
 671                        /* We are at the file beginning; skip UTF8-encoded BOM
 672                         * if present. Sane editors won't put this in on their
 673                         * own, but e.g. Windows Notepad will do it happily. */
 674                        if (c == (*bomptr & 0377)) {
 675                                bomptr++;
 676                                continue;
 677                        } else {
 678                                /* Do not tolerate partial BOM. */
 679                                if (bomptr != utf8_bom)
 680                                        break;
 681                                /* No BOM at file beginning. Cool. */
 682                                bomptr = NULL;
 683                        }
 684                }
 685                if (c == '\n') {
 686                        if (cf->eof)
 687                                return 0;
 688                        comment = 0;
 689                        continue;
 690                }
 691                if (comment || isspace(c))
 692                        continue;
 693                if (c == '#' || c == ';') {
 694                        comment = 1;
 695                        continue;
 696                }
 697                if (c == '[') {
 698                        /* Reset prior to determining a new stem */
 699                        strbuf_reset(var);
 700                        if (get_base_var(var) < 0 || var->len < 1)
 701                                break;
 702                        strbuf_addch(var, '.');
 703                        baselen = var->len;
 704                        continue;
 705                }
 706                if (!isalpha(c))
 707                        break;
 708                /*
 709                 * Truncate the var name back to the section header
 710                 * stem prior to grabbing the suffix part of the name
 711                 * and the value.
 712                 */
 713                strbuf_setlen(var, baselen);
 714                strbuf_addch(var, tolower(c));
 715                if (get_value(fn, data, var) < 0)
 716                        break;
 717        }
 718
 719        switch (cf->origin_type) {
 720        case CONFIG_ORIGIN_BLOB:
 721                error_msg = xstrfmt(_("bad config line %d in blob %s"),
 722                                      cf->linenr, cf->name);
 723                break;
 724        case CONFIG_ORIGIN_FILE:
 725                error_msg = xstrfmt(_("bad config line %d in file %s"),
 726                                      cf->linenr, cf->name);
 727                break;
 728        case CONFIG_ORIGIN_STDIN:
 729                error_msg = xstrfmt(_("bad config line %d in standard input"),
 730                                      cf->linenr);
 731                break;
 732        case CONFIG_ORIGIN_SUBMODULE_BLOB:
 733                error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
 734                                       cf->linenr, cf->name);
 735                break;
 736        case CONFIG_ORIGIN_CMDLINE:
 737                error_msg = xstrfmt(_("bad config line %d in command line %s"),
 738                                       cf->linenr, cf->name);
 739                break;
 740        default:
 741                error_msg = xstrfmt(_("bad config line %d in %s"),
 742                                      cf->linenr, cf->name);
 743        }
 744
 745        if (cf->die_on_error)
 746                die("%s", error_msg);
 747        else
 748                error_return = error("%s", error_msg);
 749
 750        free(error_msg);
 751        return error_return;
 752}
 753
 754static int parse_unit_factor(const char *end, uintmax_t *val)
 755{
 756        if (!*end)
 757                return 1;
 758        else if (!strcasecmp(end, "k")) {
 759                *val *= 1024;
 760                return 1;
 761        }
 762        else if (!strcasecmp(end, "m")) {
 763                *val *= 1024 * 1024;
 764                return 1;
 765        }
 766        else if (!strcasecmp(end, "g")) {
 767                *val *= 1024 * 1024 * 1024;
 768                return 1;
 769        }
 770        return 0;
 771}
 772
 773static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
 774{
 775        if (value && *value) {
 776                char *end;
 777                intmax_t val;
 778                uintmax_t uval;
 779                uintmax_t factor = 1;
 780
 781                errno = 0;
 782                val = strtoimax(value, &end, 0);
 783                if (errno == ERANGE)
 784                        return 0;
 785                if (!parse_unit_factor(end, &factor)) {
 786                        errno = EINVAL;
 787                        return 0;
 788                }
 789                uval = labs(val);
 790                uval *= factor;
 791                if (uval > max || labs(val) > uval) {
 792                        errno = ERANGE;
 793                        return 0;
 794                }
 795                val *= factor;
 796                *ret = val;
 797                return 1;
 798        }
 799        errno = EINVAL;
 800        return 0;
 801}
 802
 803static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
 804{
 805        if (value && *value) {
 806                char *end;
 807                uintmax_t val;
 808                uintmax_t oldval;
 809
 810                errno = 0;
 811                val = strtoumax(value, &end, 0);
 812                if (errno == ERANGE)
 813                        return 0;
 814                oldval = val;
 815                if (!parse_unit_factor(end, &val)) {
 816                        errno = EINVAL;
 817                        return 0;
 818                }
 819                if (val > max || oldval > val) {
 820                        errno = ERANGE;
 821                        return 0;
 822                }
 823                *ret = val;
 824                return 1;
 825        }
 826        errno = EINVAL;
 827        return 0;
 828}
 829
 830static int git_parse_int(const char *value, int *ret)
 831{
 832        intmax_t tmp;
 833        if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
 834                return 0;
 835        *ret = tmp;
 836        return 1;
 837}
 838
 839static int git_parse_int64(const char *value, int64_t *ret)
 840{
 841        intmax_t tmp;
 842        if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
 843                return 0;
 844        *ret = tmp;
 845        return 1;
 846}
 847
 848int git_parse_ulong(const char *value, unsigned long *ret)
 849{
 850        uintmax_t tmp;
 851        if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
 852                return 0;
 853        *ret = tmp;
 854        return 1;
 855}
 856
 857static int git_parse_ssize_t(const char *value, ssize_t *ret)
 858{
 859        intmax_t tmp;
 860        if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
 861                return 0;
 862        *ret = tmp;
 863        return 1;
 864}
 865
 866NORETURN
 867static void die_bad_number(const char *name, const char *value)
 868{
 869        const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
 870
 871        if (!value)
 872                value = "";
 873
 874        if (!(cf && cf->name))
 875                die(_("bad numeric config value '%s' for '%s': %s"),
 876                    value, name, error_type);
 877
 878        switch (cf->origin_type) {
 879        case CONFIG_ORIGIN_BLOB:
 880                die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
 881                    value, name, cf->name, error_type);
 882        case CONFIG_ORIGIN_FILE:
 883                die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
 884                    value, name, cf->name, error_type);
 885        case CONFIG_ORIGIN_STDIN:
 886                die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
 887                    value, name, error_type);
 888        case CONFIG_ORIGIN_SUBMODULE_BLOB:
 889                die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
 890                    value, name, cf->name, error_type);
 891        case CONFIG_ORIGIN_CMDLINE:
 892                die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
 893                    value, name, cf->name, error_type);
 894        default:
 895                die(_("bad numeric config value '%s' for '%s' in %s: %s"),
 896                    value, name, cf->name, error_type);
 897        }
 898}
 899
 900int git_config_int(const char *name, const char *value)
 901{
 902        int ret;
 903        if (!git_parse_int(value, &ret))
 904                die_bad_number(name, value);
 905        return ret;
 906}
 907
 908int64_t git_config_int64(const char *name, const char *value)
 909{
 910        int64_t ret;
 911        if (!git_parse_int64(value, &ret))
 912                die_bad_number(name, value);
 913        return ret;
 914}
 915
 916unsigned long git_config_ulong(const char *name, const char *value)
 917{
 918        unsigned long ret;
 919        if (!git_parse_ulong(value, &ret))
 920                die_bad_number(name, value);
 921        return ret;
 922}
 923
 924ssize_t git_config_ssize_t(const char *name, const char *value)
 925{
 926        ssize_t ret;
 927        if (!git_parse_ssize_t(value, &ret))
 928                die_bad_number(name, value);
 929        return ret;
 930}
 931
 932static int git_parse_maybe_bool_text(const char *value)
 933{
 934        if (!value)
 935                return 1;
 936        if (!*value)
 937                return 0;
 938        if (!strcasecmp(value, "true")
 939            || !strcasecmp(value, "yes")
 940            || !strcasecmp(value, "on"))
 941                return 1;
 942        if (!strcasecmp(value, "false")
 943            || !strcasecmp(value, "no")
 944            || !strcasecmp(value, "off"))
 945                return 0;
 946        return -1;
 947}
 948
 949int git_parse_maybe_bool(const char *value)
 950{
 951        int v = git_parse_maybe_bool_text(value);
 952        if (0 <= v)
 953                return v;
 954        if (git_parse_int(value, &v))
 955                return !!v;
 956        return -1;
 957}
 958
 959int git_config_maybe_bool(const char *name, const char *value)
 960{
 961        return git_parse_maybe_bool(value);
 962}
 963
 964int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
 965{
 966        int v = git_parse_maybe_bool_text(value);
 967        if (0 <= v) {
 968                *is_bool = 1;
 969                return v;
 970        }
 971        *is_bool = 0;
 972        return git_config_int(name, value);
 973}
 974
 975int git_config_bool(const char *name, const char *value)
 976{
 977        int discard;
 978        return !!git_config_bool_or_int(name, value, &discard);
 979}
 980
 981int git_config_string(const char **dest, const char *var, const char *value)
 982{
 983        if (!value)
 984                return config_error_nonbool(var);
 985        *dest = xstrdup(value);
 986        return 0;
 987}
 988
 989int git_config_pathname(const char **dest, const char *var, const char *value)
 990{
 991        if (!value)
 992                return config_error_nonbool(var);
 993        *dest = expand_user_path(value, 0);
 994        if (!*dest)
 995                die(_("failed to expand user dir in: '%s'"), value);
 996        return 0;
 997}
 998
 999static int git_default_core_config(const char *var, const char *value)
1000{
1001        /* This needs a better name */
1002        if (!strcmp(var, "core.filemode")) {
1003                trust_executable_bit = git_config_bool(var, value);
1004                return 0;
1005        }
1006        if (!strcmp(var, "core.trustctime")) {
1007                trust_ctime = git_config_bool(var, value);
1008                return 0;
1009        }
1010        if (!strcmp(var, "core.checkstat")) {
1011                if (!strcasecmp(value, "default"))
1012                        check_stat = 1;
1013                else if (!strcasecmp(value, "minimal"))
1014                        check_stat = 0;
1015        }
1016
1017        if (!strcmp(var, "core.quotepath")) {
1018                quote_path_fully = git_config_bool(var, value);
1019                return 0;
1020        }
1021
1022        if (!strcmp(var, "core.symlinks")) {
1023                has_symlinks = git_config_bool(var, value);
1024                return 0;
1025        }
1026
1027        if (!strcmp(var, "core.ignorecase")) {
1028                ignore_case = git_config_bool(var, value);
1029                return 0;
1030        }
1031
1032        if (!strcmp(var, "core.attributesfile"))
1033                return git_config_pathname(&git_attributes_file, var, value);
1034
1035        if (!strcmp(var, "core.hookspath"))
1036                return git_config_pathname(&git_hooks_path, var, value);
1037
1038        if (!strcmp(var, "core.bare")) {
1039                is_bare_repository_cfg = git_config_bool(var, value);
1040                return 0;
1041        }
1042
1043        if (!strcmp(var, "core.ignorestat")) {
1044                assume_unchanged = git_config_bool(var, value);
1045                return 0;
1046        }
1047
1048        if (!strcmp(var, "core.prefersymlinkrefs")) {
1049                prefer_symlink_refs = git_config_bool(var, value);
1050                return 0;
1051        }
1052
1053        if (!strcmp(var, "core.logallrefupdates")) {
1054                if (value && !strcasecmp(value, "always"))
1055                        log_all_ref_updates = LOG_REFS_ALWAYS;
1056                else if (git_config_bool(var, value))
1057                        log_all_ref_updates = LOG_REFS_NORMAL;
1058                else
1059                        log_all_ref_updates = LOG_REFS_NONE;
1060                return 0;
1061        }
1062
1063        if (!strcmp(var, "core.warnambiguousrefs")) {
1064                warn_ambiguous_refs = git_config_bool(var, value);
1065                return 0;
1066        }
1067
1068        if (!strcmp(var, "core.abbrev")) {
1069                if (!value)
1070                        return config_error_nonbool(var);
1071                if (!strcasecmp(value, "auto"))
1072                        default_abbrev = -1;
1073                else {
1074                        int abbrev = git_config_int(var, value);
1075                        if (abbrev < minimum_abbrev || abbrev > 40)
1076                                return error("abbrev length out of range: %d", abbrev);
1077                        default_abbrev = abbrev;
1078                }
1079                return 0;
1080        }
1081
1082        if (!strcmp(var, "core.disambiguate"))
1083                return set_disambiguate_hint_config(var, value);
1084
1085        if (!strcmp(var, "core.loosecompression")) {
1086                int level = git_config_int(var, value);
1087                if (level == -1)
1088                        level = Z_DEFAULT_COMPRESSION;
1089                else if (level < 0 || level > Z_BEST_COMPRESSION)
1090                        die(_("bad zlib compression level %d"), level);
1091                zlib_compression_level = level;
1092                zlib_compression_seen = 1;
1093                return 0;
1094        }
1095
1096        if (!strcmp(var, "core.compression")) {
1097                int level = git_config_int(var, value);
1098                if (level == -1)
1099                        level = Z_DEFAULT_COMPRESSION;
1100                else if (level < 0 || level > Z_BEST_COMPRESSION)
1101                        die(_("bad zlib compression level %d"), level);
1102                core_compression_level = level;
1103                core_compression_seen = 1;
1104                if (!zlib_compression_seen)
1105                        zlib_compression_level = level;
1106                if (!pack_compression_seen)
1107                        pack_compression_level = level;
1108                return 0;
1109        }
1110
1111        if (!strcmp(var, "core.packedgitwindowsize")) {
1112                int pgsz_x2 = getpagesize() * 2;
1113                packed_git_window_size = git_config_ulong(var, value);
1114
1115                /* This value must be multiple of (pagesize * 2) */
1116                packed_git_window_size /= pgsz_x2;
1117                if (packed_git_window_size < 1)
1118                        packed_git_window_size = 1;
1119                packed_git_window_size *= pgsz_x2;
1120                return 0;
1121        }
1122
1123        if (!strcmp(var, "core.bigfilethreshold")) {
1124                big_file_threshold = git_config_ulong(var, value);
1125                return 0;
1126        }
1127
1128        if (!strcmp(var, "core.packedgitlimit")) {
1129                packed_git_limit = git_config_ulong(var, value);
1130                return 0;
1131        }
1132
1133        if (!strcmp(var, "core.deltabasecachelimit")) {
1134                delta_base_cache_limit = git_config_ulong(var, value);
1135                return 0;
1136        }
1137
1138        if (!strcmp(var, "core.autocrlf")) {
1139                if (value && !strcasecmp(value, "input")) {
1140                        auto_crlf = AUTO_CRLF_INPUT;
1141                        return 0;
1142                }
1143                auto_crlf = git_config_bool(var, value);
1144                return 0;
1145        }
1146
1147        if (!strcmp(var, "core.safecrlf")) {
1148                if (value && !strcasecmp(value, "warn")) {
1149                        safe_crlf = SAFE_CRLF_WARN;
1150                        return 0;
1151                }
1152                safe_crlf = git_config_bool(var, value);
1153                return 0;
1154        }
1155
1156        if (!strcmp(var, "core.eol")) {
1157                if (value && !strcasecmp(value, "lf"))
1158                        core_eol = EOL_LF;
1159                else if (value && !strcasecmp(value, "crlf"))
1160                        core_eol = EOL_CRLF;
1161                else if (value && !strcasecmp(value, "native"))
1162                        core_eol = EOL_NATIVE;
1163                else
1164                        core_eol = EOL_UNSET;
1165                return 0;
1166        }
1167
1168        if (!strcmp(var, "core.notesref")) {
1169                notes_ref_name = xstrdup(value);
1170                return 0;
1171        }
1172
1173        if (!strcmp(var, "core.editor"))
1174                return git_config_string(&editor_program, var, value);
1175
1176        if (!strcmp(var, "core.commentchar")) {
1177                if (!value)
1178                        return config_error_nonbool(var);
1179                else if (!strcasecmp(value, "auto"))
1180                        auto_comment_line_char = 1;
1181                else if (value[0] && !value[1]) {
1182                        comment_line_char = value[0];
1183                        auto_comment_line_char = 0;
1184                } else
1185                        return error("core.commentChar should only be one character");
1186                return 0;
1187        }
1188
1189        if (!strcmp(var, "core.askpass"))
1190                return git_config_string(&askpass_program, var, value);
1191
1192        if (!strcmp(var, "core.excludesfile"))
1193                return git_config_pathname(&excludes_file, var, value);
1194
1195        if (!strcmp(var, "core.whitespace")) {
1196                if (!value)
1197                        return config_error_nonbool(var);
1198                whitespace_rule_cfg = parse_whitespace_rule(value);
1199                return 0;
1200        }
1201
1202        if (!strcmp(var, "core.fsyncobjectfiles")) {
1203                fsync_object_files = git_config_bool(var, value);
1204                return 0;
1205        }
1206
1207        if (!strcmp(var, "core.preloadindex")) {
1208                core_preload_index = git_config_bool(var, value);
1209                return 0;
1210        }
1211
1212        if (!strcmp(var, "core.createobject")) {
1213                if (!strcmp(value, "rename"))
1214                        object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1215                else if (!strcmp(value, "link"))
1216                        object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1217                else
1218                        die(_("invalid mode for object creation: %s"), value);
1219                return 0;
1220        }
1221
1222        if (!strcmp(var, "core.sparsecheckout")) {
1223                core_apply_sparse_checkout = git_config_bool(var, value);
1224                return 0;
1225        }
1226
1227        if (!strcmp(var, "core.precomposeunicode")) {
1228                precomposed_unicode = git_config_bool(var, value);
1229                return 0;
1230        }
1231
1232        if (!strcmp(var, "core.protecthfs")) {
1233                protect_hfs = git_config_bool(var, value);
1234                return 0;
1235        }
1236
1237        if (!strcmp(var, "core.protectntfs")) {
1238                protect_ntfs = git_config_bool(var, value);
1239                return 0;
1240        }
1241
1242        if (!strcmp(var, "core.hidedotfiles")) {
1243                if (value && !strcasecmp(value, "dotgitonly"))
1244                        hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1245                else
1246                        hide_dotfiles = git_config_bool(var, value);
1247                return 0;
1248        }
1249
1250        /* Add other config variables here and to Documentation/config.txt. */
1251        return 0;
1252}
1253
1254static int git_default_i18n_config(const char *var, const char *value)
1255{
1256        if (!strcmp(var, "i18n.commitencoding"))
1257                return git_config_string(&git_commit_encoding, var, value);
1258
1259        if (!strcmp(var, "i18n.logoutputencoding"))
1260                return git_config_string(&git_log_output_encoding, var, value);
1261
1262        /* Add other config variables here and to Documentation/config.txt. */
1263        return 0;
1264}
1265
1266static int git_default_branch_config(const char *var, const char *value)
1267{
1268        if (!strcmp(var, "branch.autosetupmerge")) {
1269                if (value && !strcasecmp(value, "always")) {
1270                        git_branch_track = BRANCH_TRACK_ALWAYS;
1271                        return 0;
1272                }
1273                git_branch_track = git_config_bool(var, value);
1274                return 0;
1275        }
1276        if (!strcmp(var, "branch.autosetuprebase")) {
1277                if (!value)
1278                        return config_error_nonbool(var);
1279                else if (!strcmp(value, "never"))
1280                        autorebase = AUTOREBASE_NEVER;
1281                else if (!strcmp(value, "local"))
1282                        autorebase = AUTOREBASE_LOCAL;
1283                else if (!strcmp(value, "remote"))
1284                        autorebase = AUTOREBASE_REMOTE;
1285                else if (!strcmp(value, "always"))
1286                        autorebase = AUTOREBASE_ALWAYS;
1287                else
1288                        return error("malformed value for %s", var);
1289                return 0;
1290        }
1291
1292        /* Add other config variables here and to Documentation/config.txt. */
1293        return 0;
1294}
1295
1296static int git_default_push_config(const char *var, const char *value)
1297{
1298        if (!strcmp(var, "push.default")) {
1299                if (!value)
1300                        return config_error_nonbool(var);
1301                else if (!strcmp(value, "nothing"))
1302                        push_default = PUSH_DEFAULT_NOTHING;
1303                else if (!strcmp(value, "matching"))
1304                        push_default = PUSH_DEFAULT_MATCHING;
1305                else if (!strcmp(value, "simple"))
1306                        push_default = PUSH_DEFAULT_SIMPLE;
1307                else if (!strcmp(value, "upstream"))
1308                        push_default = PUSH_DEFAULT_UPSTREAM;
1309                else if (!strcmp(value, "tracking")) /* deprecated */
1310                        push_default = PUSH_DEFAULT_UPSTREAM;
1311                else if (!strcmp(value, "current"))
1312                        push_default = PUSH_DEFAULT_CURRENT;
1313                else {
1314                        error("malformed value for %s: %s", var, value);
1315                        return error("Must be one of nothing, matching, simple, "
1316                                     "upstream or current.");
1317                }
1318                return 0;
1319        }
1320
1321        /* Add other config variables here and to Documentation/config.txt. */
1322        return 0;
1323}
1324
1325static int git_default_mailmap_config(const char *var, const char *value)
1326{
1327        if (!strcmp(var, "mailmap.file"))
1328                return git_config_pathname(&git_mailmap_file, var, value);
1329        if (!strcmp(var, "mailmap.blob"))
1330                return git_config_string(&git_mailmap_blob, var, value);
1331
1332        /* Add other config variables here and to Documentation/config.txt. */
1333        return 0;
1334}
1335
1336int git_default_config(const char *var, const char *value, void *dummy)
1337{
1338        if (starts_with(var, "core."))
1339                return git_default_core_config(var, value);
1340
1341        if (starts_with(var, "user."))
1342                return git_ident_config(var, value, dummy);
1343
1344        if (starts_with(var, "i18n."))
1345                return git_default_i18n_config(var, value);
1346
1347        if (starts_with(var, "branch."))
1348                return git_default_branch_config(var, value);
1349
1350        if (starts_with(var, "push."))
1351                return git_default_push_config(var, value);
1352
1353        if (starts_with(var, "mailmap."))
1354                return git_default_mailmap_config(var, value);
1355
1356        if (starts_with(var, "advice."))
1357                return git_default_advice_config(var, value);
1358
1359        if (git_color_config(var, value, dummy) < 0)
1360                return -1;
1361
1362        if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1363                pager_use_color = git_config_bool(var,value);
1364                return 0;
1365        }
1366
1367        if (!strcmp(var, "pack.packsizelimit")) {
1368                pack_size_limit_cfg = git_config_ulong(var, value);
1369                return 0;
1370        }
1371
1372        if (!strcmp(var, "pack.compression")) {
1373                int level = git_config_int(var, value);
1374                if (level == -1)
1375                        level = Z_DEFAULT_COMPRESSION;
1376                else if (level < 0 || level > Z_BEST_COMPRESSION)
1377                        die(_("bad pack compression level %d"), level);
1378                pack_compression_level = level;
1379                pack_compression_seen = 1;
1380                return 0;
1381        }
1382
1383        /* Add other config variables here and to Documentation/config.txt. */
1384        return 0;
1385}
1386
1387/*
1388 * All source specific fields in the union, die_on_error, name and the callbacks
1389 * fgetc, ungetc, ftell of top need to be initialized before calling
1390 * this function.
1391 */
1392static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1393{
1394        int ret;
1395
1396        /* push config-file parsing state stack */
1397        top->prev = cf;
1398        top->linenr = 1;
1399        top->eof = 0;
1400        strbuf_init(&top->value, 1024);
1401        strbuf_init(&top->var, 1024);
1402        cf = top;
1403
1404        ret = git_parse_source(fn, data);
1405
1406        /* pop config-file parsing state stack */
1407        strbuf_release(&top->value);
1408        strbuf_release(&top->var);
1409        cf = top->prev;
1410
1411        return ret;
1412}
1413
1414static int do_config_from_file(config_fn_t fn,
1415                const enum config_origin_type origin_type,
1416                const char *name, const char *path, FILE *f,
1417                void *data)
1418{
1419        struct config_source top;
1420
1421        top.u.file = f;
1422        top.origin_type = origin_type;
1423        top.name = name;
1424        top.path = path;
1425        top.die_on_error = 1;
1426        top.do_fgetc = config_file_fgetc;
1427        top.do_ungetc = config_file_ungetc;
1428        top.do_ftell = config_file_ftell;
1429
1430        return do_config_from(&top, fn, data);
1431}
1432
1433static int git_config_from_stdin(config_fn_t fn, void *data)
1434{
1435        return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1436}
1437
1438int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1439{
1440        int ret = -1;
1441        FILE *f;
1442
1443        f = fopen_or_warn(filename, "r");
1444        if (f) {
1445                flockfile(f);
1446                ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1447                funlockfile(f);
1448                fclose(f);
1449        }
1450        return ret;
1451}
1452
1453int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1454                        const char *name, const char *buf, size_t len, void *data)
1455{
1456        struct config_source top;
1457
1458        top.u.buf.buf = buf;
1459        top.u.buf.len = len;
1460        top.u.buf.pos = 0;
1461        top.origin_type = origin_type;
1462        top.name = name;
1463        top.path = NULL;
1464        top.die_on_error = 0;
1465        top.do_fgetc = config_buf_fgetc;
1466        top.do_ungetc = config_buf_ungetc;
1467        top.do_ftell = config_buf_ftell;
1468
1469        return do_config_from(&top, fn, data);
1470}
1471
1472int git_config_from_blob_oid(config_fn_t fn,
1473                              const char *name,
1474                              const struct object_id *oid,
1475                              void *data)
1476{
1477        enum object_type type;
1478        char *buf;
1479        unsigned long size;
1480        int ret;
1481
1482        buf = read_sha1_file(oid->hash, &type, &size);
1483        if (!buf)
1484                return error("unable to load config blob object '%s'", name);
1485        if (type != OBJ_BLOB) {
1486                free(buf);
1487                return error("reference '%s' does not point to a blob", name);
1488        }
1489
1490        ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1491        free(buf);
1492
1493        return ret;
1494}
1495
1496static int git_config_from_blob_ref(config_fn_t fn,
1497                                    const char *name,
1498                                    void *data)
1499{
1500        struct object_id oid;
1501
1502        if (get_oid(name, &oid) < 0)
1503                return error("unable to resolve config blob '%s'", name);
1504        return git_config_from_blob_oid(fn, name, &oid, data);
1505}
1506
1507const char *git_etc_gitconfig(void)
1508{
1509        static const char *system_wide;
1510        if (!system_wide)
1511                system_wide = system_path(ETC_GITCONFIG);
1512        return system_wide;
1513}
1514
1515/*
1516 * Parse environment variable 'k' as a boolean (in various
1517 * possible spellings); if missing, use the default value 'def'.
1518 */
1519int git_env_bool(const char *k, int def)
1520{
1521        const char *v = getenv(k);
1522        return v ? git_config_bool(k, v) : def;
1523}
1524
1525/*
1526 * Parse environment variable 'k' as ulong with possibly a unit
1527 * suffix; if missing, use the default value 'val'.
1528 */
1529unsigned long git_env_ulong(const char *k, unsigned long val)
1530{
1531        const char *v = getenv(k);
1532        if (v && !git_parse_ulong(v, &val))
1533                die("failed to parse %s", k);
1534        return val;
1535}
1536
1537int git_config_system(void)
1538{
1539        return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1540}
1541
1542static int do_git_config_sequence(const struct config_options *opts,
1543                                  config_fn_t fn, void *data)
1544{
1545        int ret = 0;
1546        char *xdg_config = xdg_config_home("config");
1547        char *user_config = expand_user_path("~/.gitconfig", 0);
1548        char *repo_config;
1549
1550        if (opts->commondir)
1551                repo_config = mkpathdup("%s/config", opts->commondir);
1552        else
1553                repo_config = NULL;
1554
1555        current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1556        if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1557                ret += git_config_from_file(fn, git_etc_gitconfig(),
1558                                            data);
1559
1560        current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1561        if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1562                ret += git_config_from_file(fn, xdg_config, data);
1563
1564        if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1565                ret += git_config_from_file(fn, user_config, data);
1566
1567        current_parsing_scope = CONFIG_SCOPE_REPO;
1568        if (repo_config && !access_or_die(repo_config, R_OK, 0))
1569                ret += git_config_from_file(fn, repo_config, data);
1570
1571        current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1572        if (git_config_from_parameters(fn, data) < 0)
1573                die(_("unable to parse command-line config"));
1574
1575        current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1576        free(xdg_config);
1577        free(user_config);
1578        free(repo_config);
1579        return ret;
1580}
1581
1582int config_with_options(config_fn_t fn, void *data,
1583                        struct git_config_source *config_source,
1584                        const struct config_options *opts)
1585{
1586        struct config_include_data inc = CONFIG_INCLUDE_INIT;
1587
1588        if (opts->respect_includes) {
1589                inc.fn = fn;
1590                inc.data = data;
1591                inc.opts = opts;
1592                fn = git_config_include;
1593                data = &inc;
1594        }
1595
1596        /*
1597         * If we have a specific filename, use it. Otherwise, follow the
1598         * regular lookup sequence.
1599         */
1600        if (config_source && config_source->use_stdin)
1601                return git_config_from_stdin(fn, data);
1602        else if (config_source && config_source->file)
1603                return git_config_from_file(fn, config_source->file, data);
1604        else if (config_source && config_source->blob)
1605                return git_config_from_blob_ref(fn, config_source->blob, data);
1606
1607        return do_git_config_sequence(opts, fn, data);
1608}
1609
1610static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1611{
1612        int i, value_index;
1613        struct string_list *values;
1614        struct config_set_element *entry;
1615        struct configset_list *list = &cs->list;
1616
1617        for (i = 0; i < list->nr; i++) {
1618                entry = list->items[i].e;
1619                value_index = list->items[i].value_index;
1620                values = &entry->value_list;
1621
1622                current_config_kvi = values->items[value_index].util;
1623
1624                if (fn(entry->key, values->items[value_index].string, data) < 0)
1625                        git_die_config_linenr(entry->key,
1626                                              current_config_kvi->filename,
1627                                              current_config_kvi->linenr);
1628
1629                current_config_kvi = NULL;
1630        }
1631}
1632
1633void read_early_config(config_fn_t cb, void *data)
1634{
1635        struct config_options opts = {0};
1636        struct strbuf commondir = STRBUF_INIT;
1637        struct strbuf gitdir = STRBUF_INIT;
1638
1639        opts.respect_includes = 1;
1640
1641        if (have_git_dir()) {
1642                opts.commondir = get_git_common_dir();
1643                opts.git_dir = get_git_dir();
1644        /*
1645         * When setup_git_directory() was not yet asked to discover the
1646         * GIT_DIR, we ask discover_git_directory() to figure out whether there
1647         * is any repository config we should use (but unlike
1648         * setup_git_directory_gently(), no global state is changed, most
1649         * notably, the current working directory is still the same after the
1650         * call).
1651         */
1652        } else if (!discover_git_directory(&commondir, &gitdir)) {
1653                opts.commondir = commondir.buf;
1654                opts.git_dir = gitdir.buf;
1655        }
1656
1657        config_with_options(cb, data, NULL, &opts);
1658
1659        strbuf_release(&commondir);
1660        strbuf_release(&gitdir);
1661}
1662
1663static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1664{
1665        struct config_set_element k;
1666        struct config_set_element *found_entry;
1667        char *normalized_key;
1668        /*
1669         * `key` may come from the user, so normalize it before using it
1670         * for querying entries from the hashmap.
1671         */
1672        if (git_config_parse_key(key, &normalized_key, NULL))
1673                return NULL;
1674
1675        hashmap_entry_init(&k, strhash(normalized_key));
1676        k.key = normalized_key;
1677        found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1678        free(normalized_key);
1679        return found_entry;
1680}
1681
1682static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1683{
1684        struct config_set_element *e;
1685        struct string_list_item *si;
1686        struct configset_list_item *l_item;
1687        struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1688
1689        e = configset_find_element(cs, key);
1690        /*
1691         * Since the keys are being fed by git_config*() callback mechanism, they
1692         * are already normalized. So simply add them without any further munging.
1693         */
1694        if (!e) {
1695                e = xmalloc(sizeof(*e));
1696                hashmap_entry_init(e, strhash(key));
1697                e->key = xstrdup(key);
1698                string_list_init(&e->value_list, 1);
1699                hashmap_add(&cs->config_hash, e);
1700        }
1701        si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1702
1703        ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1704        l_item = &cs->list.items[cs->list.nr++];
1705        l_item->e = e;
1706        l_item->value_index = e->value_list.nr - 1;
1707
1708        if (!cf)
1709                die("BUG: configset_add_value has no source");
1710        if (cf->name) {
1711                kv_info->filename = strintern(cf->name);
1712                kv_info->linenr = cf->linenr;
1713                kv_info->origin_type = cf->origin_type;
1714        } else {
1715                /* for values read from `git_config_from_parameters()` */
1716                kv_info->filename = NULL;
1717                kv_info->linenr = -1;
1718                kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1719        }
1720        kv_info->scope = current_parsing_scope;
1721        si->util = kv_info;
1722
1723        return 0;
1724}
1725
1726static int config_set_element_cmp(const void *unused_cmp_data,
1727                                  const void *entry,
1728                                  const void *entry_or_key,
1729                                  const void *unused_keydata)
1730{
1731        const struct config_set_element *e1 = entry;
1732        const struct config_set_element *e2 = entry_or_key;
1733
1734        return strcmp(e1->key, e2->key);
1735}
1736
1737void git_configset_init(struct config_set *cs)
1738{
1739        hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1740        cs->hash_initialized = 1;
1741        cs->list.nr = 0;
1742        cs->list.alloc = 0;
1743        cs->list.items = NULL;
1744}
1745
1746void git_configset_clear(struct config_set *cs)
1747{
1748        struct config_set_element *entry;
1749        struct hashmap_iter iter;
1750        if (!cs->hash_initialized)
1751                return;
1752
1753        hashmap_iter_init(&cs->config_hash, &iter);
1754        while ((entry = hashmap_iter_next(&iter))) {
1755                free(entry->key);
1756                string_list_clear(&entry->value_list, 1);
1757        }
1758        hashmap_free(&cs->config_hash, 1);
1759        cs->hash_initialized = 0;
1760        free(cs->list.items);
1761        cs->list.nr = 0;
1762        cs->list.alloc = 0;
1763        cs->list.items = NULL;
1764}
1765
1766static int config_set_callback(const char *key, const char *value, void *cb)
1767{
1768        struct config_set *cs = cb;
1769        configset_add_value(cs, key, value);
1770        return 0;
1771}
1772
1773int git_configset_add_file(struct config_set *cs, const char *filename)
1774{
1775        return git_config_from_file(config_set_callback, filename, cs);
1776}
1777
1778int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1779{
1780        const struct string_list *values = NULL;
1781        /*
1782         * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1783         * queried key in the files of the configset, the value returned will be the last
1784         * value in the value list for that key.
1785         */
1786        values = git_configset_get_value_multi(cs, key);
1787
1788        if (!values)
1789                return 1;
1790        assert(values->nr > 0);
1791        *value = values->items[values->nr - 1].string;
1792        return 0;
1793}
1794
1795const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1796{
1797        struct config_set_element *e = configset_find_element(cs, key);
1798        return e ? &e->value_list : NULL;
1799}
1800
1801int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1802{
1803        const char *value;
1804        if (!git_configset_get_value(cs, key, &value))
1805                return git_config_string(dest, key, value);
1806        else
1807                return 1;
1808}
1809
1810int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1811{
1812        return git_configset_get_string_const(cs, key, (const char **)dest);
1813}
1814
1815int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1816{
1817        const char *value;
1818        if (!git_configset_get_value(cs, key, &value)) {
1819                *dest = git_config_int(key, value);
1820                return 0;
1821        } else
1822                return 1;
1823}
1824
1825int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1826{
1827        const char *value;
1828        if (!git_configset_get_value(cs, key, &value)) {
1829                *dest = git_config_ulong(key, value);
1830                return 0;
1831        } else
1832                return 1;
1833}
1834
1835int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1836{
1837        const char *value;
1838        if (!git_configset_get_value(cs, key, &value)) {
1839                *dest = git_config_bool(key, value);
1840                return 0;
1841        } else
1842                return 1;
1843}
1844
1845int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1846                                int *is_bool, int *dest)
1847{
1848        const char *value;
1849        if (!git_configset_get_value(cs, key, &value)) {
1850                *dest = git_config_bool_or_int(key, value, is_bool);
1851                return 0;
1852        } else
1853                return 1;
1854}
1855
1856int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1857{
1858        const char *value;
1859        if (!git_configset_get_value(cs, key, &value)) {
1860                *dest = git_parse_maybe_bool(value);
1861                if (*dest == -1)
1862                        return -1;
1863                return 0;
1864        } else
1865                return 1;
1866}
1867
1868int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1869{
1870        const char *value;
1871        if (!git_configset_get_value(cs, key, &value))
1872                return git_config_pathname(dest, key, value);
1873        else
1874                return 1;
1875}
1876
1877/* Functions use to read configuration from a repository */
1878static void repo_read_config(struct repository *repo)
1879{
1880        struct config_options opts;
1881
1882        opts.respect_includes = 1;
1883        opts.commondir = repo->commondir;
1884        opts.git_dir = repo->gitdir;
1885
1886        if (!repo->config)
1887                repo->config = xcalloc(1, sizeof(struct config_set));
1888        else
1889                git_configset_clear(repo->config);
1890
1891        git_configset_init(repo->config);
1892
1893        if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
1894                /*
1895                 * config_with_options() normally returns only
1896                 * zero, as most errors are fatal, and
1897                 * non-fatal potential errors are guarded by "if"
1898                 * statements that are entered only when no error is
1899                 * possible.
1900                 *
1901                 * If we ever encounter a non-fatal error, it means
1902                 * something went really wrong and we should stop
1903                 * immediately.
1904                 */
1905                die(_("unknown error occurred while reading the configuration files"));
1906}
1907
1908static void git_config_check_init(struct repository *repo)
1909{
1910        if (repo->config && repo->config->hash_initialized)
1911                return;
1912        repo_read_config(repo);
1913}
1914
1915static void repo_config_clear(struct repository *repo)
1916{
1917        if (!repo->config || !repo->config->hash_initialized)
1918                return;
1919        git_configset_clear(repo->config);
1920}
1921
1922void repo_config(struct repository *repo, config_fn_t fn, void *data)
1923{
1924        git_config_check_init(repo);
1925        configset_iter(repo->config, fn, data);
1926}
1927
1928int repo_config_get_value(struct repository *repo,
1929                          const char *key, const char **value)
1930{
1931        git_config_check_init(repo);
1932        return git_configset_get_value(repo->config, key, value);
1933}
1934
1935const struct string_list *repo_config_get_value_multi(struct repository *repo,
1936                                                      const char *key)
1937{
1938        git_config_check_init(repo);
1939        return git_configset_get_value_multi(repo->config, key);
1940}
1941
1942int repo_config_get_string_const(struct repository *repo,
1943                                 const char *key, const char **dest)
1944{
1945        int ret;
1946        git_config_check_init(repo);
1947        ret = git_configset_get_string_const(repo->config, key, dest);
1948        if (ret < 0)
1949                git_die_config(key, NULL);
1950        return ret;
1951}
1952
1953int repo_config_get_string(struct repository *repo,
1954                           const char *key, char **dest)
1955{
1956        git_config_check_init(repo);
1957        return repo_config_get_string_const(repo, key, (const char **)dest);
1958}
1959
1960int repo_config_get_int(struct repository *repo,
1961                        const char *key, int *dest)
1962{
1963        git_config_check_init(repo);
1964        return git_configset_get_int(repo->config, key, dest);
1965}
1966
1967int repo_config_get_ulong(struct repository *repo,
1968                          const char *key, unsigned long *dest)
1969{
1970        git_config_check_init(repo);
1971        return git_configset_get_ulong(repo->config, key, dest);
1972}
1973
1974int repo_config_get_bool(struct repository *repo,
1975                         const char *key, int *dest)
1976{
1977        git_config_check_init(repo);
1978        return git_configset_get_bool(repo->config, key, dest);
1979}
1980
1981int repo_config_get_bool_or_int(struct repository *repo,
1982                                const char *key, int *is_bool, int *dest)
1983{
1984        git_config_check_init(repo);
1985        return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
1986}
1987
1988int repo_config_get_maybe_bool(struct repository *repo,
1989                               const char *key, int *dest)
1990{
1991        git_config_check_init(repo);
1992        return git_configset_get_maybe_bool(repo->config, key, dest);
1993}
1994
1995int repo_config_get_pathname(struct repository *repo,
1996                             const char *key, const char **dest)
1997{
1998        int ret;
1999        git_config_check_init(repo);
2000        ret = git_configset_get_pathname(repo->config, key, dest);
2001        if (ret < 0)
2002                git_die_config(key, NULL);
2003        return ret;
2004}
2005
2006/* Functions used historically to read configuration from 'the_repository' */
2007void git_config(config_fn_t fn, void *data)
2008{
2009        repo_config(the_repository, fn, data);
2010}
2011
2012void git_config_clear(void)
2013{
2014        repo_config_clear(the_repository);
2015}
2016
2017int git_config_get_value(const char *key, const char **value)
2018{
2019        return repo_config_get_value(the_repository, key, value);
2020}
2021
2022const struct string_list *git_config_get_value_multi(const char *key)
2023{
2024        return repo_config_get_value_multi(the_repository, key);
2025}
2026
2027int git_config_get_string_const(const char *key, const char **dest)
2028{
2029        return repo_config_get_string_const(the_repository, key, dest);
2030}
2031
2032int git_config_get_string(const char *key, char **dest)
2033{
2034        return repo_config_get_string(the_repository, key, dest);
2035}
2036
2037int git_config_get_int(const char *key, int *dest)
2038{
2039        return repo_config_get_int(the_repository, key, dest);
2040}
2041
2042int git_config_get_ulong(const char *key, unsigned long *dest)
2043{
2044        return repo_config_get_ulong(the_repository, key, dest);
2045}
2046
2047int git_config_get_bool(const char *key, int *dest)
2048{
2049        return repo_config_get_bool(the_repository, key, dest);
2050}
2051
2052int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2053{
2054        return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2055}
2056
2057int git_config_get_maybe_bool(const char *key, int *dest)
2058{
2059        return repo_config_get_maybe_bool(the_repository, key, dest);
2060}
2061
2062int git_config_get_pathname(const char *key, const char **dest)
2063{
2064        return repo_config_get_pathname(the_repository, key, dest);
2065}
2066
2067/*
2068 * Note: This function exists solely to maintain backward compatibility with
2069 * 'fetch' and 'update_clone' storing configuration in '.gitmodules' and should
2070 * NOT be used anywhere else.
2071 *
2072 * Runs the provided config function on the '.gitmodules' file found in the
2073 * working directory.
2074 */
2075void config_from_gitmodules(config_fn_t fn, void *data)
2076{
2077        if (the_repository->worktree) {
2078                char *file = repo_worktree_path(the_repository, GITMODULES_FILE);
2079                git_config_from_file(fn, file, data);
2080                free(file);
2081        }
2082}
2083
2084int git_config_get_expiry(const char *key, const char **output)
2085{
2086        int ret = git_config_get_string_const(key, output);
2087        if (ret)
2088                return ret;
2089        if (strcmp(*output, "now")) {
2090                timestamp_t now = approxidate("now");
2091                if (approxidate(*output) >= now)
2092                        git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2093        }
2094        return ret;
2095}
2096
2097int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2098{
2099        char *expiry_string;
2100        intmax_t days;
2101        timestamp_t when;
2102
2103        if (git_config_get_string(key, &expiry_string))
2104                return 1; /* no such thing */
2105
2106        if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2107                const int scale = 86400;
2108                *expiry = now - days * scale;
2109                return 0;
2110        }
2111
2112        if (!parse_expiry_date(expiry_string, &when)) {
2113                *expiry = when;
2114                return 0;
2115        }
2116        return -1; /* thing exists but cannot be parsed */
2117}
2118
2119int git_config_get_untracked_cache(void)
2120{
2121        int val = -1;
2122        const char *v;
2123
2124        /* Hack for test programs like test-dump-untracked-cache */
2125        if (ignore_untracked_cache_config)
2126                return -1;
2127
2128        if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2129                return val;
2130
2131        if (!git_config_get_value("core.untrackedcache", &v)) {
2132                if (!strcasecmp(v, "keep"))
2133                        return -1;
2134
2135                error(_("unknown core.untrackedCache value '%s'; "
2136                        "using 'keep' default value"), v);
2137                return -1;
2138        }
2139
2140        return -1; /* default value */
2141}
2142
2143int git_config_get_split_index(void)
2144{
2145        int val;
2146
2147        if (!git_config_get_maybe_bool("core.splitindex", &val))
2148                return val;
2149
2150        return -1; /* default value */
2151}
2152
2153int git_config_get_max_percent_split_change(void)
2154{
2155        int val = -1;
2156
2157        if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2158                if (0 <= val && val <= 100)
2159                        return val;
2160
2161                return error(_("splitIndex.maxPercentChange value '%d' "
2162                               "should be between 0 and 100"), val);
2163        }
2164
2165        return -1; /* default value */
2166}
2167
2168NORETURN
2169void git_die_config_linenr(const char *key, const char *filename, int linenr)
2170{
2171        if (!filename)
2172                die(_("unable to parse '%s' from command-line config"), key);
2173        else
2174                die(_("bad config variable '%s' in file '%s' at line %d"),
2175                    key, filename, linenr);
2176}
2177
2178NORETURN __attribute__((format(printf, 2, 3)))
2179void git_die_config(const char *key, const char *err, ...)
2180{
2181        const struct string_list *values;
2182        struct key_value_info *kv_info;
2183
2184        if (err) {
2185                va_list params;
2186                va_start(params, err);
2187                vreportf("error: ", err, params);
2188                va_end(params);
2189        }
2190        values = git_config_get_value_multi(key);
2191        kv_info = values->items[values->nr - 1].util;
2192        git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2193}
2194
2195/*
2196 * Find all the stuff for git_config_set() below.
2197 */
2198
2199static struct {
2200        int baselen;
2201        char *key;
2202        int do_not_match;
2203        regex_t *value_regex;
2204        int multi_replace;
2205        size_t *offset;
2206        unsigned int offset_alloc;
2207        enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
2208        int seen;
2209} store;
2210
2211static int matches(const char *key, const char *value)
2212{
2213        if (strcmp(key, store.key))
2214                return 0; /* not ours */
2215        if (!store.value_regex)
2216                return 1; /* always matches */
2217        if (store.value_regex == CONFIG_REGEX_NONE)
2218                return 0; /* never matches */
2219
2220        return store.do_not_match ^
2221                (value && !regexec(store.value_regex, value, 0, NULL, 0));
2222}
2223
2224static int store_aux(const char *key, const char *value, void *cb)
2225{
2226        const char *ep;
2227        size_t section_len;
2228
2229        switch (store.state) {
2230        case KEY_SEEN:
2231                if (matches(key, value)) {
2232                        if (store.seen == 1 && store.multi_replace == 0) {
2233                                warning(_("%s has multiple values"), key);
2234                        }
2235
2236                        ALLOC_GROW(store.offset, store.seen + 1,
2237                                   store.offset_alloc);
2238
2239                        store.offset[store.seen] = cf->do_ftell(cf);
2240                        store.seen++;
2241                }
2242                break;
2243        case SECTION_SEEN:
2244                /*
2245                 * What we are looking for is in store.key (both
2246                 * section and var), and its section part is baselen
2247                 * long.  We found key (again, both section and var).
2248                 * We would want to know if this key is in the same
2249                 * section as what we are looking for.  We already
2250                 * know we are in the same section as what should
2251                 * hold store.key.
2252                 */
2253                ep = strrchr(key, '.');
2254                section_len = ep - key;
2255
2256                if ((section_len != store.baselen) ||
2257                    memcmp(key, store.key, section_len+1)) {
2258                        store.state = SECTION_END_SEEN;
2259                        break;
2260                }
2261
2262                /*
2263                 * Do not increment matches: this is no match, but we
2264                 * just made sure we are in the desired section.
2265                 */
2266                ALLOC_GROW(store.offset, store.seen + 1,
2267                           store.offset_alloc);
2268                store.offset[store.seen] = cf->do_ftell(cf);
2269                /* fallthru */
2270        case SECTION_END_SEEN:
2271        case START:
2272                if (matches(key, value)) {
2273                        ALLOC_GROW(store.offset, store.seen + 1,
2274                                   store.offset_alloc);
2275                        store.offset[store.seen] = cf->do_ftell(cf);
2276                        store.state = KEY_SEEN;
2277                        store.seen++;
2278                } else {
2279                        if (strrchr(key, '.') - key == store.baselen &&
2280                              !strncmp(key, store.key, store.baselen)) {
2281                                        store.state = SECTION_SEEN;
2282                                        ALLOC_GROW(store.offset,
2283                                                   store.seen + 1,
2284                                                   store.offset_alloc);
2285                                        store.offset[store.seen] = cf->do_ftell(cf);
2286                        }
2287                }
2288        }
2289        return 0;
2290}
2291
2292static int write_error(const char *filename)
2293{
2294        error("failed to write new configuration file %s", filename);
2295
2296        /* Same error code as "failed to rename". */
2297        return 4;
2298}
2299
2300static int store_write_section(int fd, const char *key)
2301{
2302        const char *dot;
2303        int i, success;
2304        struct strbuf sb = STRBUF_INIT;
2305
2306        dot = memchr(key, '.', store.baselen);
2307        if (dot) {
2308                strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2309                for (i = dot - key + 1; i < store.baselen; i++) {
2310                        if (key[i] == '"' || key[i] == '\\')
2311                                strbuf_addch(&sb, '\\');
2312                        strbuf_addch(&sb, key[i]);
2313                }
2314                strbuf_addstr(&sb, "\"]\n");
2315        } else {
2316                strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
2317        }
2318
2319        success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2320        strbuf_release(&sb);
2321
2322        return success;
2323}
2324
2325static int store_write_pair(int fd, const char *key, const char *value)
2326{
2327        int i, success;
2328        int length = strlen(key + store.baselen + 1);
2329        const char *quote = "";
2330        struct strbuf sb = STRBUF_INIT;
2331
2332        /*
2333         * Check to see if the value needs to be surrounded with a dq pair.
2334         * Note that problematic characters are always backslash-quoted; this
2335         * check is about not losing leading or trailing SP and strings that
2336         * follow beginning-of-comment characters (i.e. ';' and '#') by the
2337         * configuration parser.
2338         */
2339        if (value[0] == ' ')
2340                quote = "\"";
2341        for (i = 0; value[i]; i++)
2342                if (value[i] == ';' || value[i] == '#')
2343                        quote = "\"";
2344        if (i && value[i - 1] == ' ')
2345                quote = "\"";
2346
2347        strbuf_addf(&sb, "\t%.*s = %s",
2348                    length, key + store.baselen + 1, quote);
2349
2350        for (i = 0; value[i]; i++)
2351                switch (value[i]) {
2352                case '\n':
2353                        strbuf_addstr(&sb, "\\n");
2354                        break;
2355                case '\t':
2356                        strbuf_addstr(&sb, "\\t");
2357                        break;
2358                case '"':
2359                case '\\':
2360                        strbuf_addch(&sb, '\\');
2361                default:
2362                        strbuf_addch(&sb, value[i]);
2363                        break;
2364                }
2365        strbuf_addf(&sb, "%s\n", quote);
2366
2367        success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2368        strbuf_release(&sb);
2369
2370        return success;
2371}
2372
2373static ssize_t find_beginning_of_line(const char *contents, size_t size,
2374        size_t offset_, int *found_bracket)
2375{
2376        size_t equal_offset = size, bracket_offset = size;
2377        ssize_t offset;
2378
2379contline:
2380        for (offset = offset_-2; offset > 0
2381                        && contents[offset] != '\n'; offset--)
2382                switch (contents[offset]) {
2383                        case '=': equal_offset = offset; break;
2384                        case ']': bracket_offset = offset; break;
2385                }
2386        if (offset > 0 && contents[offset-1] == '\\') {
2387                offset_ = offset;
2388                goto contline;
2389        }
2390        if (bracket_offset < equal_offset) {
2391                *found_bracket = 1;
2392                offset = bracket_offset+1;
2393        } else
2394                offset++;
2395
2396        return offset;
2397}
2398
2399int git_config_set_in_file_gently(const char *config_filename,
2400                                  const char *key, const char *value)
2401{
2402        return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2403}
2404
2405void git_config_set_in_file(const char *config_filename,
2406                            const char *key, const char *value)
2407{
2408        git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2409}
2410
2411int git_config_set_gently(const char *key, const char *value)
2412{
2413        return git_config_set_multivar_gently(key, value, NULL, 0);
2414}
2415
2416void git_config_set(const char *key, const char *value)
2417{
2418        git_config_set_multivar(key, value, NULL, 0);
2419}
2420
2421/*
2422 * If value==NULL, unset in (remove from) config,
2423 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2424 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2425 *     (only add a new one)
2426 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2427 *     else all matching key/values (regardless how many) are removed,
2428 *     before the new pair is written.
2429 *
2430 * Returns 0 on success.
2431 *
2432 * This function does this:
2433 *
2434 * - it locks the config file by creating ".git/config.lock"
2435 *
2436 * - it then parses the config using store_aux() as validator to find
2437 *   the position on the key/value pair to replace. If it is to be unset,
2438 *   it must be found exactly once.
2439 *
2440 * - the config file is mmap()ed and the part before the match (if any) is
2441 *   written to the lock file, then the changed part and the rest.
2442 *
2443 * - the config file is removed and the lock file rename()d to it.
2444 *
2445 */
2446int git_config_set_multivar_in_file_gently(const char *config_filename,
2447                                           const char *key, const char *value,
2448                                           const char *value_regex,
2449                                           int multi_replace)
2450{
2451        int fd = -1, in_fd = -1;
2452        int ret;
2453        struct lock_file *lock = NULL;
2454        char *filename_buf = NULL;
2455        char *contents = NULL;
2456        size_t contents_sz;
2457
2458        /* parse-key returns negative; flip the sign to feed exit(3) */
2459        ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2460        if (ret)
2461                goto out_free;
2462
2463        store.multi_replace = multi_replace;
2464
2465        if (!config_filename)
2466                config_filename = filename_buf = git_pathdup("config");
2467
2468        /*
2469         * The lock serves a purpose in addition to locking: the new
2470         * contents of .git/config will be written into it.
2471         */
2472        lock = xcalloc(1, sizeof(struct lock_file));
2473        fd = hold_lock_file_for_update(lock, config_filename, 0);
2474        if (fd < 0) {
2475                error_errno("could not lock config file %s", config_filename);
2476                free(store.key);
2477                ret = CONFIG_NO_LOCK;
2478                goto out_free;
2479        }
2480
2481        /*
2482         * If .git/config does not exist yet, write a minimal version.
2483         */
2484        in_fd = open(config_filename, O_RDONLY);
2485        if ( in_fd < 0 ) {
2486                free(store.key);
2487
2488                if ( ENOENT != errno ) {
2489                        error_errno("opening %s", config_filename);
2490                        ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2491                        goto out_free;
2492                }
2493                /* if nothing to unset, error out */
2494                if (value == NULL) {
2495                        ret = CONFIG_NOTHING_SET;
2496                        goto out_free;
2497                }
2498
2499                store.key = (char *)key;
2500                if (!store_write_section(fd, key) ||
2501                    !store_write_pair(fd, key, value))
2502                        goto write_err_out;
2503        } else {
2504                struct stat st;
2505                size_t copy_begin, copy_end;
2506                int i, new_line = 0;
2507
2508                if (value_regex == NULL)
2509                        store.value_regex = NULL;
2510                else if (value_regex == CONFIG_REGEX_NONE)
2511                        store.value_regex = CONFIG_REGEX_NONE;
2512                else {
2513                        if (value_regex[0] == '!') {
2514                                store.do_not_match = 1;
2515                                value_regex++;
2516                        } else
2517                                store.do_not_match = 0;
2518
2519                        store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2520                        if (regcomp(store.value_regex, value_regex,
2521                                        REG_EXTENDED)) {
2522                                error("invalid pattern: %s", value_regex);
2523                                free(store.value_regex);
2524                                ret = CONFIG_INVALID_PATTERN;
2525                                goto out_free;
2526                        }
2527                }
2528
2529                ALLOC_GROW(store.offset, 1, store.offset_alloc);
2530                store.offset[0] = 0;
2531                store.state = START;
2532                store.seen = 0;
2533
2534                /*
2535                 * After this, store.offset will contain the *end* offset
2536                 * of the last match, or remain at 0 if no match was found.
2537                 * As a side effect, we make sure to transform only a valid
2538                 * existing config file.
2539                 */
2540                if (git_config_from_file(store_aux, config_filename, NULL)) {
2541                        error("invalid config file %s", config_filename);
2542                        free(store.key);
2543                        if (store.value_regex != NULL &&
2544                            store.value_regex != CONFIG_REGEX_NONE) {
2545                                regfree(store.value_regex);
2546                                free(store.value_regex);
2547                        }
2548                        ret = CONFIG_INVALID_FILE;
2549                        goto out_free;
2550                }
2551
2552                free(store.key);
2553                if (store.value_regex != NULL &&
2554                    store.value_regex != CONFIG_REGEX_NONE) {
2555                        regfree(store.value_regex);
2556                        free(store.value_regex);
2557                }
2558
2559                /* if nothing to unset, or too many matches, error out */
2560                if ((store.seen == 0 && value == NULL) ||
2561                                (store.seen > 1 && multi_replace == 0)) {
2562                        ret = CONFIG_NOTHING_SET;
2563                        goto out_free;
2564                }
2565
2566                if (fstat(in_fd, &st) == -1) {
2567                        error_errno(_("fstat on %s failed"), config_filename);
2568                        ret = CONFIG_INVALID_FILE;
2569                        goto out_free;
2570                }
2571
2572                contents_sz = xsize_t(st.st_size);
2573                contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2574                                        MAP_PRIVATE, in_fd, 0);
2575                if (contents == MAP_FAILED) {
2576                        if (errno == ENODEV && S_ISDIR(st.st_mode))
2577                                errno = EISDIR;
2578                        error_errno("unable to mmap '%s'", config_filename);
2579                        ret = CONFIG_INVALID_FILE;
2580                        contents = NULL;
2581                        goto out_free;
2582                }
2583                close(in_fd);
2584                in_fd = -1;
2585
2586                if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2587                        error_errno("chmod on %s failed", get_lock_file_path(lock));
2588                        ret = CONFIG_NO_WRITE;
2589                        goto out_free;
2590                }
2591
2592                if (store.seen == 0)
2593                        store.seen = 1;
2594
2595                for (i = 0, copy_begin = 0; i < store.seen; i++) {
2596                        if (store.offset[i] == 0) {
2597                                store.offset[i] = copy_end = contents_sz;
2598                        } else if (store.state != KEY_SEEN) {
2599                                copy_end = store.offset[i];
2600                        } else
2601                                copy_end = find_beginning_of_line(
2602                                        contents, contents_sz,
2603                                        store.offset[i]-2, &new_line);
2604
2605                        if (copy_end > 0 && contents[copy_end-1] != '\n')
2606                                new_line = 1;
2607
2608                        /* write the first part of the config */
2609                        if (copy_end > copy_begin) {
2610                                if (write_in_full(fd, contents + copy_begin,
2611                                                  copy_end - copy_begin) <
2612                                    copy_end - copy_begin)
2613                                        goto write_err_out;
2614                                if (new_line &&
2615                                    write_str_in_full(fd, "\n") != 1)
2616                                        goto write_err_out;
2617                        }
2618                        copy_begin = store.offset[i];
2619                }
2620
2621                /* write the pair (value == NULL means unset) */
2622                if (value != NULL) {
2623                        if (store.state == START) {
2624                                if (!store_write_section(fd, key))
2625                                        goto write_err_out;
2626                        }
2627                        if (!store_write_pair(fd, key, value))
2628                                goto write_err_out;
2629                }
2630
2631                /* write the rest of the config */
2632                if (copy_begin < contents_sz)
2633                        if (write_in_full(fd, contents + copy_begin,
2634                                          contents_sz - copy_begin) <
2635                            contents_sz - copy_begin)
2636                                goto write_err_out;
2637
2638                munmap(contents, contents_sz);
2639                contents = NULL;
2640        }
2641
2642        if (commit_lock_file(lock) < 0) {
2643                error_errno("could not write config file %s", config_filename);
2644                ret = CONFIG_NO_WRITE;
2645                lock = NULL;
2646                goto out_free;
2647        }
2648
2649        /*
2650         * lock is committed, so don't try to roll it back below.
2651         * NOTE: Since lockfile.c keeps a linked list of all created
2652         * lock_file structures, it isn't safe to free(lock).  It's
2653         * better to just leave it hanging around.
2654         */
2655        lock = NULL;
2656        ret = 0;
2657
2658        /* Invalidate the config cache */
2659        git_config_clear();
2660
2661out_free:
2662        if (lock)
2663                rollback_lock_file(lock);
2664        free(filename_buf);
2665        if (contents)
2666                munmap(contents, contents_sz);
2667        if (in_fd >= 0)
2668                close(in_fd);
2669        return ret;
2670
2671write_err_out:
2672        ret = write_error(get_lock_file_path(lock));
2673        goto out_free;
2674
2675}
2676
2677void git_config_set_multivar_in_file(const char *config_filename,
2678                                     const char *key, const char *value,
2679                                     const char *value_regex, int multi_replace)
2680{
2681        if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2682                                                    value_regex, multi_replace))
2683                return;
2684        if (value)
2685                die(_("could not set '%s' to '%s'"), key, value);
2686        else
2687                die(_("could not unset '%s'"), key);
2688}
2689
2690int git_config_set_multivar_gently(const char *key, const char *value,
2691                                   const char *value_regex, int multi_replace)
2692{
2693        return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2694                                                      multi_replace);
2695}
2696
2697void git_config_set_multivar(const char *key, const char *value,
2698                             const char *value_regex, int multi_replace)
2699{
2700        git_config_set_multivar_in_file(NULL, key, value, value_regex,
2701                                        multi_replace);
2702}
2703
2704static int section_name_match (const char *buf, const char *name)
2705{
2706        int i = 0, j = 0, dot = 0;
2707        if (buf[i] != '[')
2708                return 0;
2709        for (i = 1; buf[i] && buf[i] != ']'; i++) {
2710                if (!dot && isspace(buf[i])) {
2711                        dot = 1;
2712                        if (name[j++] != '.')
2713                                break;
2714                        for (i++; isspace(buf[i]); i++)
2715                                ; /* do nothing */
2716                        if (buf[i] != '"')
2717                                break;
2718                        continue;
2719                }
2720                if (buf[i] == '\\' && dot)
2721                        i++;
2722                else if (buf[i] == '"' && dot) {
2723                        for (i++; isspace(buf[i]); i++)
2724                                ; /* do_nothing */
2725                        break;
2726                }
2727                if (buf[i] != name[j++])
2728                        break;
2729        }
2730        if (buf[i] == ']' && name[j] == 0) {
2731                /*
2732                 * We match, now just find the right length offset by
2733                 * gobbling up any whitespace after it, as well
2734                 */
2735                i++;
2736                for (; buf[i] && isspace(buf[i]); i++)
2737                        ; /* do nothing */
2738                return i;
2739        }
2740        return 0;
2741}
2742
2743static int section_name_is_ok(const char *name)
2744{
2745        /* Empty section names are bogus. */
2746        if (!*name)
2747                return 0;
2748
2749        /*
2750         * Before a dot, we must be alphanumeric or dash. After the first dot,
2751         * anything goes, so we can stop checking.
2752         */
2753        for (; *name && *name != '.'; name++)
2754                if (*name != '-' && !isalnum(*name))
2755                        return 0;
2756        return 1;
2757}
2758
2759/* if new_name == NULL, the section is removed instead */
2760int git_config_rename_section_in_file(const char *config_filename,
2761                                      const char *old_name, const char *new_name)
2762{
2763        int ret = 0, remove = 0;
2764        char *filename_buf = NULL;
2765        struct lock_file *lock;
2766        int out_fd;
2767        char buf[1024];
2768        FILE *config_file = NULL;
2769        struct stat st;
2770
2771        if (new_name && !section_name_is_ok(new_name)) {
2772                ret = error("invalid section name: %s", new_name);
2773                goto out_no_rollback;
2774        }
2775
2776        if (!config_filename)
2777                config_filename = filename_buf = git_pathdup("config");
2778
2779        lock = xcalloc(1, sizeof(struct lock_file));
2780        out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2781        if (out_fd < 0) {
2782                ret = error("could not lock config file %s", config_filename);
2783                goto out;
2784        }
2785
2786        if (!(config_file = fopen(config_filename, "rb"))) {
2787                ret = warn_on_fopen_errors(config_filename);
2788                if (ret)
2789                        goto out;
2790                /* no config file means nothing to rename, no error */
2791                goto commit_and_out;
2792        }
2793
2794        if (fstat(fileno(config_file), &st) == -1) {
2795                ret = error_errno(_("fstat on %s failed"), config_filename);
2796                goto out;
2797        }
2798
2799        if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2800                ret = error_errno("chmod on %s failed",
2801                                  get_lock_file_path(lock));
2802                goto out;
2803        }
2804
2805        while (fgets(buf, sizeof(buf), config_file)) {
2806                int i;
2807                int length;
2808                char *output = buf;
2809                for (i = 0; buf[i] && isspace(buf[i]); i++)
2810                        ; /* do nothing */
2811                if (buf[i] == '[') {
2812                        /* it's a section */
2813                        int offset = section_name_match(&buf[i], old_name);
2814                        if (offset > 0) {
2815                                ret++;
2816                                if (new_name == NULL) {
2817                                        remove = 1;
2818                                        continue;
2819                                }
2820                                store.baselen = strlen(new_name);
2821                                if (!store_write_section(out_fd, new_name)) {
2822                                        ret = write_error(get_lock_file_path(lock));
2823                                        goto out;
2824                                }
2825                                /*
2826                                 * We wrote out the new section, with
2827                                 * a newline, now skip the old
2828                                 * section's length
2829                                 */
2830                                output += offset + i;
2831                                if (strlen(output) > 0) {
2832                                        /*
2833                                         * More content means there's
2834                                         * a declaration to put on the
2835                                         * next line; indent with a
2836                                         * tab
2837                                         */
2838                                        output -= 1;
2839                                        output[0] = '\t';
2840                                }
2841                        }
2842                        remove = 0;
2843                }
2844                if (remove)
2845                        continue;
2846                length = strlen(output);
2847                if (write_in_full(out_fd, output, length) != length) {
2848                        ret = write_error(get_lock_file_path(lock));
2849                        goto out;
2850                }
2851        }
2852        fclose(config_file);
2853        config_file = NULL;
2854commit_and_out:
2855        if (commit_lock_file(lock) < 0)
2856                ret = error_errno("could not write config file %s",
2857                                  config_filename);
2858out:
2859        if (config_file)
2860                fclose(config_file);
2861        rollback_lock_file(lock);
2862out_no_rollback:
2863        free(filename_buf);
2864        return ret;
2865}
2866
2867int git_config_rename_section(const char *old_name, const char *new_name)
2868{
2869        return git_config_rename_section_in_file(NULL, old_name, new_name);
2870}
2871
2872/*
2873 * Call this to report error for your variable that should not
2874 * get a boolean value (i.e. "[my] var" means "true").
2875 */
2876#undef config_error_nonbool
2877int config_error_nonbool(const char *var)
2878{
2879        return error("missing value for '%s'", var);
2880}
2881
2882int parse_config_key(const char *var,
2883                     const char *section,
2884                     const char **subsection, int *subsection_len,
2885                     const char **key)
2886{
2887        const char *dot;
2888
2889        /* Does it start with "section." ? */
2890        if (!skip_prefix(var, section, &var) || *var != '.')
2891                return -1;
2892
2893        /*
2894         * Find the key; we don't know yet if we have a subsection, but we must
2895         * parse backwards from the end, since the subsection may have dots in
2896         * it, too.
2897         */
2898        dot = strrchr(var, '.');
2899        *key = dot + 1;
2900
2901        /* Did we have a subsection at all? */
2902        if (dot == var) {
2903                if (subsection) {
2904                        *subsection = NULL;
2905                        *subsection_len = 0;
2906                }
2907        }
2908        else {
2909                if (!subsection)
2910                        return -1;
2911                *subsection = var + 1;
2912                *subsection_len = dot - *subsection;
2913        }
2914
2915        return 0;
2916}
2917
2918const char *current_config_origin_type(void)
2919{
2920        int type;
2921        if (current_config_kvi)
2922                type = current_config_kvi->origin_type;
2923        else if(cf)
2924                type = cf->origin_type;
2925        else
2926                die("BUG: current_config_origin_type called outside config callback");
2927
2928        switch (type) {
2929        case CONFIG_ORIGIN_BLOB:
2930                return "blob";
2931        case CONFIG_ORIGIN_FILE:
2932                return "file";
2933        case CONFIG_ORIGIN_STDIN:
2934                return "standard input";
2935        case CONFIG_ORIGIN_SUBMODULE_BLOB:
2936                return "submodule-blob";
2937        case CONFIG_ORIGIN_CMDLINE:
2938                return "command line";
2939        default:
2940                die("BUG: unknown config origin type");
2941        }
2942}
2943
2944const char *current_config_name(void)
2945{
2946        const char *name;
2947        if (current_config_kvi)
2948                name = current_config_kvi->filename;
2949        else if (cf)
2950                name = cf->name;
2951        else
2952                die("BUG: current_config_name called outside config callback");
2953        return name ? name : "";
2954}
2955
2956enum config_scope current_config_scope(void)
2957{
2958        if (current_config_kvi)
2959                return current_config_kvi->scope;
2960        else
2961                return current_parsing_scope;
2962}