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