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