config.con commit Sanity-check config variable names (b09c53a)
   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 "exec_cmd.h"
  10#include "strbuf.h"
  11#include "quote.h"
  12
  13#define MAXNAME (256)
  14
  15static FILE *config_file;
  16static const char *config_file_name;
  17static int config_linenr;
  18static int config_file_eof;
  19static int zlib_compression_seen;
  20
  21const char *config_exclusive_filename = NULL;
  22
  23struct config_item
  24{
  25        struct config_item *next;
  26        char *name;
  27        char *value;
  28};
  29static struct config_item *config_parameters;
  30static struct config_item **config_parameters_tail = &config_parameters;
  31
  32static void lowercase(char *p)
  33{
  34        for (; *p; p++)
  35                *p = tolower(*p);
  36}
  37
  38void git_config_push_parameter(const char *text)
  39{
  40        struct strbuf env = STRBUF_INIT;
  41        const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
  42        if (old) {
  43                strbuf_addstr(&env, old);
  44                strbuf_addch(&env, ' ');
  45        }
  46        sq_quote_buf(&env, text);
  47        setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
  48        strbuf_release(&env);
  49}
  50
  51int git_config_parse_parameter(const char *text)
  52{
  53        struct config_item *ct;
  54        struct strbuf tmp = STRBUF_INIT;
  55        struct strbuf **pair;
  56        strbuf_addstr(&tmp, text);
  57        pair = strbuf_split(&tmp, '=');
  58        if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
  59                strbuf_setlen(pair[0], pair[0]->len - 1);
  60        strbuf_trim(pair[0]);
  61        if (!pair[0]->len) {
  62                strbuf_list_free(pair);
  63                return -1;
  64        }
  65        ct = xcalloc(1, sizeof(struct config_item));
  66        ct->name = strbuf_detach(pair[0], NULL);
  67        if (pair[1]) {
  68                strbuf_trim(pair[1]);
  69                ct->value = strbuf_detach(pair[1], NULL);
  70        }
  71        strbuf_list_free(pair);
  72        lowercase(ct->name);
  73        *config_parameters_tail = ct;
  74        config_parameters_tail = &ct->next;
  75        return 0;
  76}
  77
  78int git_config_parse_environment(void) {
  79        const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
  80        char *envw;
  81        const char **argv = NULL;
  82        int nr = 0, alloc = 0;
  83        int i;
  84
  85        if (!env)
  86                return 0;
  87        /* sq_dequote will write over it */
  88        envw = xstrdup(env);
  89
  90        if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
  91                free(envw);
  92                return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
  93        }
  94
  95        for (i = 0; i < nr; i++) {
  96                if (git_config_parse_parameter(argv[i]) < 0) {
  97                        error("bogus config parameter: %s", argv[i]);
  98                        free(argv);
  99                        free(envw);
 100                        return -1;
 101                }
 102        }
 103
 104        free(argv);
 105        free(envw);
 106        return 0;
 107}
 108
 109static int get_next_char(void)
 110{
 111        int c;
 112        FILE *f;
 113
 114        c = '\n';
 115        if ((f = config_file) != NULL) {
 116                c = fgetc(f);
 117                if (c == '\r') {
 118                        /* DOS like systems */
 119                        c = fgetc(f);
 120                        if (c != '\n') {
 121                                ungetc(c, f);
 122                                c = '\r';
 123                        }
 124                }
 125                if (c == '\n')
 126                        config_linenr++;
 127                if (c == EOF) {
 128                        config_file_eof = 1;
 129                        c = '\n';
 130                }
 131        }
 132        return c;
 133}
 134
 135static char *parse_value(void)
 136{
 137        static char value[1024];
 138        int quote = 0, comment = 0, len = 0, space = 0;
 139
 140        for (;;) {
 141                int c = get_next_char();
 142                if (len >= sizeof(value) - 1)
 143                        return NULL;
 144                if (c == '\n') {
 145                        if (quote)
 146                                return NULL;
 147                        value[len] = 0;
 148                        return value;
 149                }
 150                if (comment)
 151                        continue;
 152                if (isspace(c) && !quote) {
 153                        if (len)
 154                                space++;
 155                        continue;
 156                }
 157                if (!quote) {
 158                        if (c == ';' || c == '#') {
 159                                comment = 1;
 160                                continue;
 161                        }
 162                }
 163                for (; space; space--)
 164                        value[len++] = ' ';
 165                if (c == '\\') {
 166                        c = get_next_char();
 167                        switch (c) {
 168                        case '\n':
 169                                continue;
 170                        case 't':
 171                                c = '\t';
 172                                break;
 173                        case 'b':
 174                                c = '\b';
 175                                break;
 176                        case 'n':
 177                                c = '\n';
 178                                break;
 179                        /* Some characters escape as themselves */
 180                        case '\\': case '"':
 181                                break;
 182                        /* Reject unknown escape sequences */
 183                        default:
 184                                return NULL;
 185                        }
 186                        value[len++] = c;
 187                        continue;
 188                }
 189                if (c == '"') {
 190                        quote = 1-quote;
 191                        continue;
 192                }
 193                value[len++] = c;
 194        }
 195}
 196
 197static inline int iskeychar(int c)
 198{
 199        return isalnum(c) || c == '-';
 200}
 201
 202static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
 203{
 204        int c;
 205        char *value;
 206
 207        /* Get the full name */
 208        for (;;) {
 209                c = get_next_char();
 210                if (config_file_eof)
 211                        break;
 212                if (!iskeychar(c))
 213                        break;
 214                name[len++] = tolower(c);
 215                if (len >= MAXNAME)
 216                        return -1;
 217        }
 218        name[len] = 0;
 219        while (c == ' ' || c == '\t')
 220                c = get_next_char();
 221
 222        value = NULL;
 223        if (c != '\n') {
 224                if (c != '=')
 225                        return -1;
 226                value = parse_value();
 227                if (!value)
 228                        return -1;
 229        }
 230        return fn(name, value, data);
 231}
 232
 233static int get_extended_base_var(char *name, int baselen, int c)
 234{
 235        do {
 236                if (c == '\n')
 237                        return -1;
 238                c = get_next_char();
 239        } while (isspace(c));
 240
 241        /* We require the format to be '[base "extension"]' */
 242        if (c != '"')
 243                return -1;
 244        name[baselen++] = '.';
 245
 246        for (;;) {
 247                int c = get_next_char();
 248                if (c == '\n')
 249                        return -1;
 250                if (c == '"')
 251                        break;
 252                if (c == '\\') {
 253                        c = get_next_char();
 254                        if (c == '\n')
 255                                return -1;
 256                }
 257                name[baselen++] = c;
 258                if (baselen > MAXNAME / 2)
 259                        return -1;
 260        }
 261
 262        /* Final ']' */
 263        if (get_next_char() != ']')
 264                return -1;
 265        return baselen;
 266}
 267
 268static int get_base_var(char *name)
 269{
 270        int baselen = 0;
 271
 272        for (;;) {
 273                int c = get_next_char();
 274                if (config_file_eof)
 275                        return -1;
 276                if (c == ']')
 277                        return baselen;
 278                if (isspace(c))
 279                        return get_extended_base_var(name, baselen, c);
 280                if (!iskeychar(c) && c != '.')
 281                        return -1;
 282                if (baselen > MAXNAME / 2)
 283                        return -1;
 284                name[baselen++] = tolower(c);
 285        }
 286}
 287
 288static int git_parse_file(config_fn_t fn, void *data)
 289{
 290        int comment = 0;
 291        int baselen = 0;
 292        static char var[MAXNAME];
 293
 294        /* U+FEFF Byte Order Mark in UTF8 */
 295        static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
 296        const unsigned char *bomptr = utf8_bom;
 297
 298        for (;;) {
 299                int c = get_next_char();
 300                if (bomptr && *bomptr) {
 301                        /* We are at the file beginning; skip UTF8-encoded BOM
 302                         * if present. Sane editors won't put this in on their
 303                         * own, but e.g. Windows Notepad will do it happily. */
 304                        if ((unsigned char) c == *bomptr) {
 305                                bomptr++;
 306                                continue;
 307                        } else {
 308                                /* Do not tolerate partial BOM. */
 309                                if (bomptr != utf8_bom)
 310                                        break;
 311                                /* No BOM at file beginning. Cool. */
 312                                bomptr = NULL;
 313                        }
 314                }
 315                if (c == '\n') {
 316                        if (config_file_eof)
 317                                return 0;
 318                        comment = 0;
 319                        continue;
 320                }
 321                if (comment || isspace(c))
 322                        continue;
 323                if (c == '#' || c == ';') {
 324                        comment = 1;
 325                        continue;
 326                }
 327                if (c == '[') {
 328                        baselen = get_base_var(var);
 329                        if (baselen <= 0)
 330                                break;
 331                        var[baselen++] = '.';
 332                        var[baselen] = 0;
 333                        continue;
 334                }
 335                if (!isalpha(c))
 336                        break;
 337                var[baselen] = tolower(c);
 338                if (get_value(fn, data, var, baselen+1) < 0)
 339                        break;
 340        }
 341        die("bad config file line %d in %s", config_linenr, config_file_name);
 342}
 343
 344static int parse_unit_factor(const char *end, unsigned long *val)
 345{
 346        if (!*end)
 347                return 1;
 348        else if (!strcasecmp(end, "k")) {
 349                *val *= 1024;
 350                return 1;
 351        }
 352        else if (!strcasecmp(end, "m")) {
 353                *val *= 1024 * 1024;
 354                return 1;
 355        }
 356        else if (!strcasecmp(end, "g")) {
 357                *val *= 1024 * 1024 * 1024;
 358                return 1;
 359        }
 360        return 0;
 361}
 362
 363static int git_parse_long(const char *value, long *ret)
 364{
 365        if (value && *value) {
 366                char *end;
 367                long val = strtol(value, &end, 0);
 368                unsigned long factor = 1;
 369                if (!parse_unit_factor(end, &factor))
 370                        return 0;
 371                *ret = val * factor;
 372                return 1;
 373        }
 374        return 0;
 375}
 376
 377int git_parse_ulong(const char *value, unsigned long *ret)
 378{
 379        if (value && *value) {
 380                char *end;
 381                unsigned long val = strtoul(value, &end, 0);
 382                if (!parse_unit_factor(end, &val))
 383                        return 0;
 384                *ret = val;
 385                return 1;
 386        }
 387        return 0;
 388}
 389
 390static void die_bad_config(const char *name)
 391{
 392        if (config_file_name)
 393                die("bad config value for '%s' in %s", name, config_file_name);
 394        die("bad config value for '%s'", name);
 395}
 396
 397int git_config_int(const char *name, const char *value)
 398{
 399        long ret = 0;
 400        if (!git_parse_long(value, &ret))
 401                die_bad_config(name);
 402        return ret;
 403}
 404
 405unsigned long git_config_ulong(const char *name, const char *value)
 406{
 407        unsigned long ret;
 408        if (!git_parse_ulong(value, &ret))
 409                die_bad_config(name);
 410        return ret;
 411}
 412
 413static int git_config_maybe_bool_text(const char *name, const char *value)
 414{
 415        if (!value)
 416                return 1;
 417        if (!*value)
 418                return 0;
 419        if (!strcasecmp(value, "true")
 420            || !strcasecmp(value, "yes")
 421            || !strcasecmp(value, "on"))
 422                return 1;
 423        if (!strcasecmp(value, "false")
 424            || !strcasecmp(value, "no")
 425            || !strcasecmp(value, "off"))
 426                return 0;
 427        return -1;
 428}
 429
 430int git_config_maybe_bool(const char *name, const char *value)
 431{
 432        long v = git_config_maybe_bool_text(name, value);
 433        if (0 <= v)
 434                return v;
 435        if (git_parse_long(value, &v))
 436                return !!v;
 437        return -1;
 438}
 439
 440int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
 441{
 442        int v = git_config_maybe_bool_text(name, value);
 443        if (0 <= v) {
 444                *is_bool = 1;
 445                return v;
 446        }
 447        *is_bool = 0;
 448        return git_config_int(name, value);
 449}
 450
 451int git_config_bool(const char *name, const char *value)
 452{
 453        int discard;
 454        return !!git_config_bool_or_int(name, value, &discard);
 455}
 456
 457int git_config_string(const char **dest, const char *var, const char *value)
 458{
 459        if (!value)
 460                return config_error_nonbool(var);
 461        *dest = xstrdup(value);
 462        return 0;
 463}
 464
 465int git_config_pathname(const char **dest, const char *var, const char *value)
 466{
 467        if (!value)
 468                return config_error_nonbool(var);
 469        *dest = expand_user_path(value);
 470        if (!*dest)
 471                die("Failed to expand user dir in: '%s'", value);
 472        return 0;
 473}
 474
 475static int git_default_core_config(const char *var, const char *value)
 476{
 477        /* This needs a better name */
 478        if (!strcmp(var, "core.filemode")) {
 479                trust_executable_bit = git_config_bool(var, value);
 480                return 0;
 481        }
 482        if (!strcmp(var, "core.trustctime")) {
 483                trust_ctime = git_config_bool(var, value);
 484                return 0;
 485        }
 486
 487        if (!strcmp(var, "core.quotepath")) {
 488                quote_path_fully = git_config_bool(var, value);
 489                return 0;
 490        }
 491
 492        if (!strcmp(var, "core.symlinks")) {
 493                has_symlinks = git_config_bool(var, value);
 494                return 0;
 495        }
 496
 497        if (!strcmp(var, "core.ignorecase")) {
 498                ignore_case = git_config_bool(var, value);
 499                return 0;
 500        }
 501
 502        if (!strcmp(var, "core.abbrevguard")) {
 503                unique_abbrev_extra_length = git_config_int(var, value);
 504                if (unique_abbrev_extra_length < 0)
 505                        unique_abbrev_extra_length = 0;
 506                return 0;
 507        }
 508
 509        if (!strcmp(var, "core.bare")) {
 510                is_bare_repository_cfg = git_config_bool(var, value);
 511                return 0;
 512        }
 513
 514        if (!strcmp(var, "core.ignorestat")) {
 515                assume_unchanged = git_config_bool(var, value);
 516                return 0;
 517        }
 518
 519        if (!strcmp(var, "core.prefersymlinkrefs")) {
 520                prefer_symlink_refs = git_config_bool(var, value);
 521                return 0;
 522        }
 523
 524        if (!strcmp(var, "core.logallrefupdates")) {
 525                log_all_ref_updates = git_config_bool(var, value);
 526                return 0;
 527        }
 528
 529        if (!strcmp(var, "core.warnambiguousrefs")) {
 530                warn_ambiguous_refs = git_config_bool(var, value);
 531                return 0;
 532        }
 533
 534        if (!strcmp(var, "core.loosecompression")) {
 535                int level = git_config_int(var, value);
 536                if (level == -1)
 537                        level = Z_DEFAULT_COMPRESSION;
 538                else if (level < 0 || level > Z_BEST_COMPRESSION)
 539                        die("bad zlib compression level %d", level);
 540                zlib_compression_level = level;
 541                zlib_compression_seen = 1;
 542                return 0;
 543        }
 544
 545        if (!strcmp(var, "core.compression")) {
 546                int level = git_config_int(var, value);
 547                if (level == -1)
 548                        level = Z_DEFAULT_COMPRESSION;
 549                else if (level < 0 || level > Z_BEST_COMPRESSION)
 550                        die("bad zlib compression level %d", level);
 551                core_compression_level = level;
 552                core_compression_seen = 1;
 553                if (!zlib_compression_seen)
 554                        zlib_compression_level = level;
 555                return 0;
 556        }
 557
 558        if (!strcmp(var, "core.packedgitwindowsize")) {
 559                int pgsz_x2 = getpagesize() * 2;
 560                packed_git_window_size = git_config_int(var, value);
 561
 562                /* This value must be multiple of (pagesize * 2) */
 563                packed_git_window_size /= pgsz_x2;
 564                if (packed_git_window_size < 1)
 565                        packed_git_window_size = 1;
 566                packed_git_window_size *= pgsz_x2;
 567                return 0;
 568        }
 569
 570        if (!strcmp(var, "core.packedgitlimit")) {
 571                packed_git_limit = git_config_int(var, value);
 572                return 0;
 573        }
 574
 575        if (!strcmp(var, "core.deltabasecachelimit")) {
 576                delta_base_cache_limit = git_config_int(var, value);
 577                return 0;
 578        }
 579
 580        if (!strcmp(var, "core.autocrlf")) {
 581                if (value && !strcasecmp(value, "input")) {
 582                        if (eol == EOL_CRLF)
 583                                return error("core.autocrlf=input conflicts with core.eol=crlf");
 584                        auto_crlf = AUTO_CRLF_INPUT;
 585                        return 0;
 586                }
 587                auto_crlf = git_config_bool(var, value);
 588                return 0;
 589        }
 590
 591        if (!strcmp(var, "core.safecrlf")) {
 592                if (value && !strcasecmp(value, "warn")) {
 593                        safe_crlf = SAFE_CRLF_WARN;
 594                        return 0;
 595                }
 596                safe_crlf = git_config_bool(var, value);
 597                return 0;
 598        }
 599
 600        if (!strcmp(var, "core.eol")) {
 601                if (value && !strcasecmp(value, "lf"))
 602                        eol = EOL_LF;
 603                else if (value && !strcasecmp(value, "crlf"))
 604                        eol = EOL_CRLF;
 605                else if (value && !strcasecmp(value, "native"))
 606                        eol = EOL_NATIVE;
 607                else
 608                        eol = EOL_UNSET;
 609                if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
 610                        return error("core.autocrlf=input conflicts with core.eol=crlf");
 611                return 0;
 612        }
 613
 614        if (!strcmp(var, "core.notesref")) {
 615                notes_ref_name = xstrdup(value);
 616                return 0;
 617        }
 618
 619        if (!strcmp(var, "core.pager"))
 620                return git_config_string(&pager_program, var, value);
 621
 622        if (!strcmp(var, "core.editor"))
 623                return git_config_string(&editor_program, var, value);
 624
 625        if (!strcmp(var, "core.askpass"))
 626                return git_config_string(&askpass_program, var, value);
 627
 628        if (!strcmp(var, "core.excludesfile"))
 629                return git_config_pathname(&excludes_file, var, value);
 630
 631        if (!strcmp(var, "core.whitespace")) {
 632                if (!value)
 633                        return config_error_nonbool(var);
 634                whitespace_rule_cfg = parse_whitespace_rule(value);
 635                return 0;
 636        }
 637
 638        if (!strcmp(var, "core.fsyncobjectfiles")) {
 639                fsync_object_files = git_config_bool(var, value);
 640                return 0;
 641        }
 642
 643        if (!strcmp(var, "core.preloadindex")) {
 644                core_preload_index = git_config_bool(var, value);
 645                return 0;
 646        }
 647
 648        if (!strcmp(var, "core.createobject")) {
 649                if (!strcmp(value, "rename"))
 650                        object_creation_mode = OBJECT_CREATION_USES_RENAMES;
 651                else if (!strcmp(value, "link"))
 652                        object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
 653                else
 654                        die("Invalid mode for object creation: %s", value);
 655                return 0;
 656        }
 657
 658        if (!strcmp(var, "core.sparsecheckout")) {
 659                core_apply_sparse_checkout = git_config_bool(var, value);
 660                return 0;
 661        }
 662
 663        /* Add other config variables here and to Documentation/config.txt. */
 664        return 0;
 665}
 666
 667static int git_default_user_config(const char *var, const char *value)
 668{
 669        if (!strcmp(var, "user.name")) {
 670                if (!value)
 671                        return config_error_nonbool(var);
 672                strlcpy(git_default_name, value, sizeof(git_default_name));
 673                user_ident_explicitly_given |= IDENT_NAME_GIVEN;
 674                return 0;
 675        }
 676
 677        if (!strcmp(var, "user.email")) {
 678                if (!value)
 679                        return config_error_nonbool(var);
 680                strlcpy(git_default_email, value, sizeof(git_default_email));
 681                user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
 682                return 0;
 683        }
 684
 685        /* Add other config variables here and to Documentation/config.txt. */
 686        return 0;
 687}
 688
 689static int git_default_i18n_config(const char *var, const char *value)
 690{
 691        if (!strcmp(var, "i18n.commitencoding"))
 692                return git_config_string(&git_commit_encoding, var, value);
 693
 694        if (!strcmp(var, "i18n.logoutputencoding"))
 695                return git_config_string(&git_log_output_encoding, var, value);
 696
 697        /* Add other config variables here and to Documentation/config.txt. */
 698        return 0;
 699}
 700
 701static int git_default_branch_config(const char *var, const char *value)
 702{
 703        if (!strcmp(var, "branch.autosetupmerge")) {
 704                if (value && !strcasecmp(value, "always")) {
 705                        git_branch_track = BRANCH_TRACK_ALWAYS;
 706                        return 0;
 707                }
 708                git_branch_track = git_config_bool(var, value);
 709                return 0;
 710        }
 711        if (!strcmp(var, "branch.autosetuprebase")) {
 712                if (!value)
 713                        return config_error_nonbool(var);
 714                else if (!strcmp(value, "never"))
 715                        autorebase = AUTOREBASE_NEVER;
 716                else if (!strcmp(value, "local"))
 717                        autorebase = AUTOREBASE_LOCAL;
 718                else if (!strcmp(value, "remote"))
 719                        autorebase = AUTOREBASE_REMOTE;
 720                else if (!strcmp(value, "always"))
 721                        autorebase = AUTOREBASE_ALWAYS;
 722                else
 723                        return error("Malformed value for %s", var);
 724                return 0;
 725        }
 726
 727        /* Add other config variables here and to Documentation/config.txt. */
 728        return 0;
 729}
 730
 731static int git_default_push_config(const char *var, const char *value)
 732{
 733        if (!strcmp(var, "push.default")) {
 734                if (!value)
 735                        return config_error_nonbool(var);
 736                else if (!strcmp(value, "nothing"))
 737                        push_default = PUSH_DEFAULT_NOTHING;
 738                else if (!strcmp(value, "matching"))
 739                        push_default = PUSH_DEFAULT_MATCHING;
 740                else if (!strcmp(value, "tracking"))
 741                        push_default = PUSH_DEFAULT_TRACKING;
 742                else if (!strcmp(value, "current"))
 743                        push_default = PUSH_DEFAULT_CURRENT;
 744                else {
 745                        error("Malformed value for %s: %s", var, value);
 746                        return error("Must be one of nothing, matching, "
 747                                     "tracking or current.");
 748                }
 749                return 0;
 750        }
 751
 752        /* Add other config variables here and to Documentation/config.txt. */
 753        return 0;
 754}
 755
 756static int git_default_mailmap_config(const char *var, const char *value)
 757{
 758        if (!strcmp(var, "mailmap.file"))
 759                return git_config_string(&git_mailmap_file, var, value);
 760
 761        /* Add other config variables here and to Documentation/config.txt. */
 762        return 0;
 763}
 764
 765int git_default_config(const char *var, const char *value, void *dummy)
 766{
 767        if (!prefixcmp(var, "core."))
 768                return git_default_core_config(var, value);
 769
 770        if (!prefixcmp(var, "user."))
 771                return git_default_user_config(var, value);
 772
 773        if (!prefixcmp(var, "i18n."))
 774                return git_default_i18n_config(var, value);
 775
 776        if (!prefixcmp(var, "branch."))
 777                return git_default_branch_config(var, value);
 778
 779        if (!prefixcmp(var, "push."))
 780                return git_default_push_config(var, value);
 781
 782        if (!prefixcmp(var, "mailmap."))
 783                return git_default_mailmap_config(var, value);
 784
 785        if (!prefixcmp(var, "advice."))
 786                return git_default_advice_config(var, value);
 787
 788        if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
 789                pager_use_color = git_config_bool(var,value);
 790                return 0;
 791        }
 792
 793        /* Add other config variables here and to Documentation/config.txt. */
 794        return 0;
 795}
 796
 797int git_config_from_file(config_fn_t fn, const char *filename, void *data)
 798{
 799        int ret;
 800        FILE *f = fopen(filename, "r");
 801
 802        ret = -1;
 803        if (f) {
 804                config_file = f;
 805                config_file_name = filename;
 806                config_linenr = 1;
 807                config_file_eof = 0;
 808                ret = git_parse_file(fn, data);
 809                fclose(f);
 810                config_file_name = NULL;
 811        }
 812        return ret;
 813}
 814
 815const char *git_etc_gitconfig(void)
 816{
 817        static const char *system_wide;
 818        if (!system_wide)
 819                system_wide = system_path(ETC_GITCONFIG);
 820        return system_wide;
 821}
 822
 823int git_env_bool(const char *k, int def)
 824{
 825        const char *v = getenv(k);
 826        return v ? git_config_bool(k, v) : def;
 827}
 828
 829int git_config_system(void)
 830{
 831        return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
 832}
 833
 834int git_config_global(void)
 835{
 836        return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
 837}
 838
 839int git_config_from_parameters(config_fn_t fn, void *data)
 840{
 841        static int loaded_environment;
 842        const struct config_item *ct;
 843
 844        if (!loaded_environment) {
 845                if (git_config_parse_environment() < 0)
 846                        return -1;
 847                loaded_environment = 1;
 848        }
 849        for (ct = config_parameters; ct; ct = ct->next)
 850                if (fn(ct->name, ct->value, data) < 0)
 851                        return -1;
 852        return 0;
 853}
 854
 855int git_config_early(config_fn_t fn, void *data, const char *repo_config)
 856{
 857        int ret = 0, found = 0;
 858        const char *home = NULL;
 859
 860        /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
 861        if (config_exclusive_filename)
 862                return git_config_from_file(fn, config_exclusive_filename, data);
 863        if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
 864                ret += git_config_from_file(fn, git_etc_gitconfig(),
 865                                            data);
 866                found += 1;
 867        }
 868
 869        home = getenv("HOME");
 870        if (git_config_global() && home) {
 871                char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
 872                if (!access(user_config, R_OK)) {
 873                        ret += git_config_from_file(fn, user_config, data);
 874                        found += 1;
 875                }
 876                free(user_config);
 877        }
 878
 879        if (repo_config && !access(repo_config, R_OK)) {
 880                ret += git_config_from_file(fn, repo_config, data);
 881                found += 1;
 882        }
 883
 884        ret += git_config_from_parameters(fn, data);
 885        if (config_parameters)
 886                found += 1;
 887
 888        return ret == 0 ? found : ret;
 889}
 890
 891int git_config(config_fn_t fn, void *data)
 892{
 893        char *repo_config = NULL;
 894        int ret;
 895
 896        repo_config = git_pathdup("config");
 897        ret = git_config_early(fn, data, repo_config);
 898        if (repo_config)
 899                free(repo_config);
 900        return ret;
 901}
 902
 903/*
 904 * Find all the stuff for git_config_set() below.
 905 */
 906
 907#define MAX_MATCHES 512
 908
 909static struct {
 910        int baselen;
 911        char *key;
 912        int do_not_match;
 913        regex_t *value_regex;
 914        int multi_replace;
 915        size_t offset[MAX_MATCHES];
 916        enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
 917        int seen;
 918} store;
 919
 920static int matches(const char *key, const char *value)
 921{
 922        return !strcmp(key, store.key) &&
 923                (store.value_regex == NULL ||
 924                 (store.do_not_match ^
 925                  !regexec(store.value_regex, value, 0, NULL, 0)));
 926}
 927
 928static int store_aux(const char *key, const char *value, void *cb)
 929{
 930        const char *ep;
 931        size_t section_len;
 932
 933        switch (store.state) {
 934        case KEY_SEEN:
 935                if (matches(key, value)) {
 936                        if (store.seen == 1 && store.multi_replace == 0) {
 937                                warning("%s has multiple values", key);
 938                        } else if (store.seen >= MAX_MATCHES) {
 939                                error("too many matches for %s", key);
 940                                return 1;
 941                        }
 942
 943                        store.offset[store.seen] = ftell(config_file);
 944                        store.seen++;
 945                }
 946                break;
 947        case SECTION_SEEN:
 948                /*
 949                 * What we are looking for is in store.key (both
 950                 * section and var), and its section part is baselen
 951                 * long.  We found key (again, both section and var).
 952                 * We would want to know if this key is in the same
 953                 * section as what we are looking for.  We already
 954                 * know we are in the same section as what should
 955                 * hold store.key.
 956                 */
 957                ep = strrchr(key, '.');
 958                section_len = ep - key;
 959
 960                if ((section_len != store.baselen) ||
 961                    memcmp(key, store.key, section_len+1)) {
 962                        store.state = SECTION_END_SEEN;
 963                        break;
 964                }
 965
 966                /*
 967                 * Do not increment matches: this is no match, but we
 968                 * just made sure we are in the desired section.
 969                 */
 970                store.offset[store.seen] = ftell(config_file);
 971                /* fallthru */
 972        case SECTION_END_SEEN:
 973        case START:
 974                if (matches(key, value)) {
 975                        store.offset[store.seen] = ftell(config_file);
 976                        store.state = KEY_SEEN;
 977                        store.seen++;
 978                } else {
 979                        if (strrchr(key, '.') - key == store.baselen &&
 980                              !strncmp(key, store.key, store.baselen)) {
 981                                        store.state = SECTION_SEEN;
 982                                        store.offset[store.seen] = ftell(config_file);
 983                        }
 984                }
 985        }
 986        return 0;
 987}
 988
 989static int write_error(const char *filename)
 990{
 991        error("failed to write new configuration file %s", filename);
 992
 993        /* Same error code as "failed to rename". */
 994        return 4;
 995}
 996
 997static int store_write_section(int fd, const char *key)
 998{
 999        const char *dot;
1000        int i, success;
1001        struct strbuf sb = STRBUF_INIT;
1002
1003        dot = memchr(key, '.', store.baselen);
1004        if (dot) {
1005                strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1006                for (i = dot - key + 1; i < store.baselen; i++) {
1007                        if (key[i] == '"' || key[i] == '\\')
1008                                strbuf_addch(&sb, '\\');
1009                        strbuf_addch(&sb, key[i]);
1010                }
1011                strbuf_addstr(&sb, "\"]\n");
1012        } else {
1013                strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1014        }
1015
1016        success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1017        strbuf_release(&sb);
1018
1019        return success;
1020}
1021
1022static int store_write_pair(int fd, const char *key, const char *value)
1023{
1024        int i, success;
1025        int length = strlen(key + store.baselen + 1);
1026        const char *quote = "";
1027        struct strbuf sb = STRBUF_INIT;
1028
1029        /*
1030         * Check to see if the value needs to be surrounded with a dq pair.
1031         * Note that problematic characters are always backslash-quoted; this
1032         * check is about not losing leading or trailing SP and strings that
1033         * follow beginning-of-comment characters (i.e. ';' and '#') by the
1034         * configuration parser.
1035         */
1036        if (value[0] == ' ')
1037                quote = "\"";
1038        for (i = 0; value[i]; i++)
1039                if (value[i] == ';' || value[i] == '#')
1040                        quote = "\"";
1041        if (i && value[i - 1] == ' ')
1042                quote = "\"";
1043
1044        strbuf_addf(&sb, "\t%.*s = %s",
1045                    length, key + store.baselen + 1, quote);
1046
1047        for (i = 0; value[i]; i++)
1048                switch (value[i]) {
1049                case '\n':
1050                        strbuf_addstr(&sb, "\\n");
1051                        break;
1052                case '\t':
1053                        strbuf_addstr(&sb, "\\t");
1054                        break;
1055                case '"':
1056                case '\\':
1057                        strbuf_addch(&sb, '\\');
1058                default:
1059                        strbuf_addch(&sb, value[i]);
1060                        break;
1061                }
1062        strbuf_addf(&sb, "%s\n", quote);
1063
1064        success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1065        strbuf_release(&sb);
1066
1067        return success;
1068}
1069
1070static ssize_t find_beginning_of_line(const char *contents, size_t size,
1071        size_t offset_, int *found_bracket)
1072{
1073        size_t equal_offset = size, bracket_offset = size;
1074        ssize_t offset;
1075
1076contline:
1077        for (offset = offset_-2; offset > 0
1078                        && contents[offset] != '\n'; offset--)
1079                switch (contents[offset]) {
1080                        case '=': equal_offset = offset; break;
1081                        case ']': bracket_offset = offset; break;
1082                }
1083        if (offset > 0 && contents[offset-1] == '\\') {
1084                offset_ = offset;
1085                goto contline;
1086        }
1087        if (bracket_offset < equal_offset) {
1088                *found_bracket = 1;
1089                offset = bracket_offset+1;
1090        } else
1091                offset++;
1092
1093        return offset;
1094}
1095
1096int git_config_set(const char *key, const char *value)
1097{
1098        return git_config_set_multivar(key, value, NULL, 0);
1099}
1100
1101/*
1102 * Auxiliary function to sanity-check and split the key into the section
1103 * identifier and variable name.
1104 *
1105 * Returns 0 on success, -1 when there is an invalid character in the key and
1106 * -2 if there is no section name in the key.
1107 *
1108 * store_key - pointer to char* which will hold a copy of the key with
1109 *             lowercase section and variable name
1110 * baselen - pointer to int which will hold the length of the
1111 *           section + subsection part, can be NULL
1112 */
1113int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1114{
1115        int i, dot, baselen;
1116        const char *last_dot = strrchr(key, '.');
1117
1118        /*
1119         * Since "key" actually contains the section name and the real
1120         * key name separated by a dot, we have to know where the dot is.
1121         */
1122
1123        if (last_dot == NULL) {
1124                error("key does not contain a section: %s", key);
1125                return -2;
1126        }
1127
1128        baselen = last_dot - key;
1129        if (baselen_)
1130                *baselen_ = baselen;
1131
1132        /*
1133         * Validate the key and while at it, lower case it for matching.
1134         */
1135        *store_key = xmalloc(strlen(key) + 1);
1136
1137        dot = 0;
1138        for (i = 0; key[i]; i++) {
1139                unsigned char c = key[i];
1140                if (c == '.')
1141                        dot = 1;
1142                /* Leave the extended basename untouched.. */
1143                if (!dot || i > baselen) {
1144                        if (!iskeychar(c) ||
1145                            (i == baselen + 1 && !isalpha(c))) {
1146                                error("invalid key: %s", key);
1147                                goto out_free_ret_1;
1148                        }
1149                        c = tolower(c);
1150                } else if (c == '\n') {
1151                        error("invalid key (newline): %s", key);
1152                        goto out_free_ret_1;
1153                }
1154                (*store_key)[i] = c;
1155        }
1156        (*store_key)[i] = 0;
1157
1158        return 0;
1159
1160out_free_ret_1:
1161        free(*store_key);
1162        return -1;
1163}
1164
1165/*
1166 * If value==NULL, unset in (remove from) config,
1167 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1168 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1169 *     else all matching key/values (regardless how many) are removed,
1170 *     before the new pair is written.
1171 *
1172 * Returns 0 on success.
1173 *
1174 * This function does this:
1175 *
1176 * - it locks the config file by creating ".git/config.lock"
1177 *
1178 * - it then parses the config using store_aux() as validator to find
1179 *   the position on the key/value pair to replace. If it is to be unset,
1180 *   it must be found exactly once.
1181 *
1182 * - the config file is mmap()ed and the part before the match (if any) is
1183 *   written to the lock file, then the changed part and the rest.
1184 *
1185 * - the config file is removed and the lock file rename()d to it.
1186 *
1187 */
1188int git_config_set_multivar(const char *key, const char *value,
1189        const char *value_regex, int multi_replace)
1190{
1191        int fd = -1, in_fd;
1192        int ret;
1193        char *config_filename;
1194        struct lock_file *lock = NULL;
1195
1196        if (config_exclusive_filename)
1197                config_filename = xstrdup(config_exclusive_filename);
1198        else
1199                config_filename = git_pathdup("config");
1200
1201        /* parse-key returns negative; flip the sign to feed exit(3) */
1202        ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1203        if (ret)
1204                goto out_free;
1205
1206        store.multi_replace = multi_replace;
1207
1208
1209        /*
1210         * The lock serves a purpose in addition to locking: the new
1211         * contents of .git/config will be written into it.
1212         */
1213        lock = xcalloc(sizeof(struct lock_file), 1);
1214        fd = hold_lock_file_for_update(lock, config_filename, 0);
1215        if (fd < 0) {
1216                error("could not lock config file %s: %s", config_filename, strerror(errno));
1217                free(store.key);
1218                ret = -1;
1219                goto out_free;
1220        }
1221
1222        /*
1223         * If .git/config does not exist yet, write a minimal version.
1224         */
1225        in_fd = open(config_filename, O_RDONLY);
1226        if ( in_fd < 0 ) {
1227                free(store.key);
1228
1229                if ( ENOENT != errno ) {
1230                        error("opening %s: %s", config_filename,
1231                              strerror(errno));
1232                        ret = 3; /* same as "invalid config file" */
1233                        goto out_free;
1234                }
1235                /* if nothing to unset, error out */
1236                if (value == NULL) {
1237                        ret = 5;
1238                        goto out_free;
1239                }
1240
1241                store.key = (char *)key;
1242                if (!store_write_section(fd, key) ||
1243                    !store_write_pair(fd, key, value))
1244                        goto write_err_out;
1245        } else {
1246                struct stat st;
1247                char *contents;
1248                size_t contents_sz, copy_begin, copy_end;
1249                int i, new_line = 0;
1250
1251                if (value_regex == NULL)
1252                        store.value_regex = NULL;
1253                else {
1254                        if (value_regex[0] == '!') {
1255                                store.do_not_match = 1;
1256                                value_regex++;
1257                        } else
1258                                store.do_not_match = 0;
1259
1260                        store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1261                        if (regcomp(store.value_regex, value_regex,
1262                                        REG_EXTENDED)) {
1263                                error("invalid pattern: %s", value_regex);
1264                                free(store.value_regex);
1265                                ret = 6;
1266                                goto out_free;
1267                        }
1268                }
1269
1270                store.offset[0] = 0;
1271                store.state = START;
1272                store.seen = 0;
1273
1274                /*
1275                 * After this, store.offset will contain the *end* offset
1276                 * of the last match, or remain at 0 if no match was found.
1277                 * As a side effect, we make sure to transform only a valid
1278                 * existing config file.
1279                 */
1280                if (git_config_from_file(store_aux, config_filename, NULL)) {
1281                        error("invalid config file %s", config_filename);
1282                        free(store.key);
1283                        if (store.value_regex != NULL) {
1284                                regfree(store.value_regex);
1285                                free(store.value_regex);
1286                        }
1287                        ret = 3;
1288                        goto out_free;
1289                }
1290
1291                free(store.key);
1292                if (store.value_regex != NULL) {
1293                        regfree(store.value_regex);
1294                        free(store.value_regex);
1295                }
1296
1297                /* if nothing to unset, or too many matches, error out */
1298                if ((store.seen == 0 && value == NULL) ||
1299                                (store.seen > 1 && multi_replace == 0)) {
1300                        ret = 5;
1301                        goto out_free;
1302                }
1303
1304                fstat(in_fd, &st);
1305                contents_sz = xsize_t(st.st_size);
1306                contents = xmmap(NULL, contents_sz, PROT_READ,
1307                        MAP_PRIVATE, in_fd, 0);
1308                close(in_fd);
1309
1310                if (store.seen == 0)
1311                        store.seen = 1;
1312
1313                for (i = 0, copy_begin = 0; i < store.seen; i++) {
1314                        if (store.offset[i] == 0) {
1315                                store.offset[i] = copy_end = contents_sz;
1316                        } else if (store.state != KEY_SEEN) {
1317                                copy_end = store.offset[i];
1318                        } else
1319                                copy_end = find_beginning_of_line(
1320                                        contents, contents_sz,
1321                                        store.offset[i]-2, &new_line);
1322
1323                        if (copy_end > 0 && contents[copy_end-1] != '\n')
1324                                new_line = 1;
1325
1326                        /* write the first part of the config */
1327                        if (copy_end > copy_begin) {
1328                                if (write_in_full(fd, contents + copy_begin,
1329                                                  copy_end - copy_begin) <
1330                                    copy_end - copy_begin)
1331                                        goto write_err_out;
1332                                if (new_line &&
1333                                    write_str_in_full(fd, "\n") != 1)
1334                                        goto write_err_out;
1335                        }
1336                        copy_begin = store.offset[i];
1337                }
1338
1339                /* write the pair (value == NULL means unset) */
1340                if (value != NULL) {
1341                        if (store.state == START) {
1342                                if (!store_write_section(fd, key))
1343                                        goto write_err_out;
1344                        }
1345                        if (!store_write_pair(fd, key, value))
1346                                goto write_err_out;
1347                }
1348
1349                /* write the rest of the config */
1350                if (copy_begin < contents_sz)
1351                        if (write_in_full(fd, contents + copy_begin,
1352                                          contents_sz - copy_begin) <
1353                            contents_sz - copy_begin)
1354                                goto write_err_out;
1355
1356                munmap(contents, contents_sz);
1357        }
1358
1359        if (commit_lock_file(lock) < 0) {
1360                error("could not commit config file %s", config_filename);
1361                ret = 4;
1362                goto out_free;
1363        }
1364
1365        /*
1366         * lock is committed, so don't try to roll it back below.
1367         * NOTE: Since lockfile.c keeps a linked list of all created
1368         * lock_file structures, it isn't safe to free(lock).  It's
1369         * better to just leave it hanging around.
1370         */
1371        lock = NULL;
1372        ret = 0;
1373
1374out_free:
1375        if (lock)
1376                rollback_lock_file(lock);
1377        free(config_filename);
1378        return ret;
1379
1380write_err_out:
1381        ret = write_error(lock->filename);
1382        goto out_free;
1383
1384}
1385
1386static int section_name_match (const char *buf, const char *name)
1387{
1388        int i = 0, j = 0, dot = 0;
1389        if (buf[i] != '[')
1390                return 0;
1391        for (i = 1; buf[i] && buf[i] != ']'; i++) {
1392                if (!dot && isspace(buf[i])) {
1393                        dot = 1;
1394                        if (name[j++] != '.')
1395                                break;
1396                        for (i++; isspace(buf[i]); i++)
1397                                ; /* do nothing */
1398                        if (buf[i] != '"')
1399                                break;
1400                        continue;
1401                }
1402                if (buf[i] == '\\' && dot)
1403                        i++;
1404                else if (buf[i] == '"' && dot) {
1405                        for (i++; isspace(buf[i]); i++)
1406                                ; /* do_nothing */
1407                        break;
1408                }
1409                if (buf[i] != name[j++])
1410                        break;
1411        }
1412        if (buf[i] == ']' && name[j] == 0) {
1413                /*
1414                 * We match, now just find the right length offset by
1415                 * gobbling up any whitespace after it, as well
1416                 */
1417                i++;
1418                for (; buf[i] && isspace(buf[i]); i++)
1419                        ; /* do nothing */
1420                return i;
1421        }
1422        return 0;
1423}
1424
1425/* if new_name == NULL, the section is removed instead */
1426int git_config_rename_section(const char *old_name, const char *new_name)
1427{
1428        int ret = 0, remove = 0;
1429        char *config_filename;
1430        struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1431        int out_fd;
1432        char buf[1024];
1433
1434        if (config_exclusive_filename)
1435                config_filename = xstrdup(config_exclusive_filename);
1436        else
1437                config_filename = git_pathdup("config");
1438        out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1439        if (out_fd < 0) {
1440                ret = error("could not lock config file %s", config_filename);
1441                goto out;
1442        }
1443
1444        if (!(config_file = fopen(config_filename, "rb"))) {
1445                /* no config file means nothing to rename, no error */
1446                goto unlock_and_out;
1447        }
1448
1449        while (fgets(buf, sizeof(buf), config_file)) {
1450                int i;
1451                int length;
1452                char *output = buf;
1453                for (i = 0; buf[i] && isspace(buf[i]); i++)
1454                        ; /* do nothing */
1455                if (buf[i] == '[') {
1456                        /* it's a section */
1457                        int offset = section_name_match(&buf[i], old_name);
1458                        if (offset > 0) {
1459                                ret++;
1460                                if (new_name == NULL) {
1461                                        remove = 1;
1462                                        continue;
1463                                }
1464                                store.baselen = strlen(new_name);
1465                                if (!store_write_section(out_fd, new_name)) {
1466                                        ret = write_error(lock->filename);
1467                                        goto out;
1468                                }
1469                                /*
1470                                 * We wrote out the new section, with
1471                                 * a newline, now skip the old
1472                                 * section's length
1473                                 */
1474                                output += offset + i;
1475                                if (strlen(output) > 0) {
1476                                        /*
1477                                         * More content means there's
1478                                         * a declaration to put on the
1479                                         * next line; indent with a
1480                                         * tab
1481                                         */
1482                                        output -= 1;
1483                                        output[0] = '\t';
1484                                }
1485                        }
1486                        remove = 0;
1487                }
1488                if (remove)
1489                        continue;
1490                length = strlen(output);
1491                if (write_in_full(out_fd, output, length) != length) {
1492                        ret = write_error(lock->filename);
1493                        goto out;
1494                }
1495        }
1496        fclose(config_file);
1497 unlock_and_out:
1498        if (commit_lock_file(lock) < 0)
1499                ret = error("could not commit config file %s", config_filename);
1500 out:
1501        free(config_filename);
1502        return ret;
1503}
1504
1505/*
1506 * Call this to report error for your variable that should not
1507 * get a boolean value (i.e. "[my] var" means "true").
1508 */
1509int config_error_nonbool(const char *var)
1510{
1511        return error("Missing value for '%s'", var);
1512}