Andrew's git / gitweb.git / config.c
?
config.con commit tests: scrub environment of GIT_* variables (95a1d12)
   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.bare")) {
 503                is_bare_repository_cfg = git_config_bool(var, value);
 504                return 0;
 505        }
 506
 507        if (!strcmp(var, "core.ignorestat")) {
 508                assume_unchanged = git_config_bool(var, value);
 509                return 0;
 510        }
 511
 512        if (!strcmp(var, "core.prefersymlinkrefs")) {
 513                prefer_symlink_refs = git_config_bool(var, value);
 514                return 0;
 515        }
 516
 517        if (!strcmp(var, "core.logallrefupdates")) {
 518                log_all_ref_updates = git_config_bool(var, value);
 519                return 0;
 520        }
 521
 522        if (!strcmp(var, "core.warnambiguousrefs")) {
 523                warn_ambiguous_refs = git_config_bool(var, value);
 524                return 0;
 525        }
 526
 527        if (!strcmp(var, "core.loosecompression")) {
 528                int level = git_config_int(var, value);
 529                if (level == -1)
 530                        level = Z_DEFAULT_COMPRESSION;
 531                else if (level < 0 || level > Z_BEST_COMPRESSION)
 532                        die("bad zlib compression level %d", level);
 533                zlib_compression_level = level;
 534                zlib_compression_seen = 1;
 535                return 0;
 536        }
 537
 538        if (!strcmp(var, "core.compression")) {
 539                int level = git_config_int(var, value);
 540                if (level == -1)
 541                        level = Z_DEFAULT_COMPRESSION;
 542                else if (level < 0 || level > Z_BEST_COMPRESSION)
 543                        die("bad zlib compression level %d", level);
 544                core_compression_level = level;
 545                core_compression_seen = 1;
 546                if (!zlib_compression_seen)
 547                        zlib_compression_level = level;
 548                return 0;
 549        }
 550
 551        if (!strcmp(var, "core.packedgitwindowsize")) {
 552                int pgsz_x2 = getpagesize() * 2;
 553                packed_git_window_size = git_config_int(var, value);
 554
 555                /* This value must be multiple of (pagesize * 2) */
 556                packed_git_window_size /= pgsz_x2;
 557                if (packed_git_window_size < 1)
 558                        packed_git_window_size = 1;
 559                packed_git_window_size *= pgsz_x2;
 560                return 0;
 561        }
 562
 563        if (!strcmp(var, "core.packedgitlimit")) {
 564                packed_git_limit = git_config_int(var, value);
 565                return 0;
 566        }
 567
 568        if (!strcmp(var, "core.deltabasecachelimit")) {
 569                delta_base_cache_limit = git_config_int(var, value);
 570                return 0;
 571        }
 572
 573        if (!strcmp(var, "core.autocrlf")) {
 574                if (value && !strcasecmp(value, "input")) {
 575                        if (eol == EOL_CRLF)
 576                                return error("core.autocrlf=input conflicts with core.eol=crlf");
 577                        auto_crlf = AUTO_CRLF_INPUT;
 578                        return 0;
 579                }
 580                auto_crlf = git_config_bool(var, value);
 581                return 0;
 582        }
 583
 584        if (!strcmp(var, "core.safecrlf")) {
 585                if (value && !strcasecmp(value, "warn")) {
 586                        safe_crlf = SAFE_CRLF_WARN;
 587                        return 0;
 588                }
 589                safe_crlf = git_config_bool(var, value);
 590                return 0;
 591        }
 592
 593        if (!strcmp(var, "core.eol")) {
 594                if (value && !strcasecmp(value, "lf"))
 595                        eol = EOL_LF;
 596                else if (value && !strcasecmp(value, "crlf"))
 597                        eol = EOL_CRLF;
 598                else if (value && !strcasecmp(value, "native"))
 599                        eol = EOL_NATIVE;
 600                else
 601                        eol = EOL_UNSET;
 602                if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
 603                        return error("core.autocrlf=input conflicts with core.eol=crlf");
 604                return 0;
 605        }
 606
 607        if (!strcmp(var, "core.notesref")) {
 608                notes_ref_name = xstrdup(value);
 609                return 0;
 610        }
 611
 612        if (!strcmp(var, "core.pager"))
 613                return git_config_string(&pager_program, var, value);
 614
 615        if (!strcmp(var, "core.editor"))
 616                return git_config_string(&editor_program, var, value);
 617
 618        if (!strcmp(var, "core.askpass"))
 619                return git_config_string(&askpass_program, var, value);
 620
 621        if (!strcmp(var, "core.excludesfile"))
 622                return git_config_pathname(&excludes_file, var, value);
 623
 624        if (!strcmp(var, "core.whitespace")) {
 625                if (!value)
 626                        return config_error_nonbool(var);
 627                whitespace_rule_cfg = parse_whitespace_rule(value);
 628                return 0;
 629        }
 630
 631        if (!strcmp(var, "core.fsyncobjectfiles")) {
 632                fsync_object_files = git_config_bool(var, value);
 633                return 0;
 634        }
 635
 636        if (!strcmp(var, "core.preloadindex")) {
 637                core_preload_index = git_config_bool(var, value);
 638                return 0;
 639        }
 640
 641        if (!strcmp(var, "core.createobject")) {
 642                if (!strcmp(value, "rename"))
 643                        object_creation_mode = OBJECT_CREATION_USES_RENAMES;
 644                else if (!strcmp(value, "link"))
 645                        object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
 646                else
 647                        die("Invalid mode for object creation: %s", value);
 648                return 0;
 649        }
 650
 651        if (!strcmp(var, "core.sparsecheckout")) {
 652                core_apply_sparse_checkout = git_config_bool(var, value);
 653                return 0;
 654        }
 655
 656        /* Add other config variables here and to Documentation/config.txt. */
 657        return 0;
 658}
 659
 660static int git_default_user_config(const char *var, const char *value)
 661{
 662        if (!strcmp(var, "user.name")) {
 663                if (!value)
 664                        return config_error_nonbool(var);
 665                strlcpy(git_default_name, value, sizeof(git_default_name));
 666                user_ident_explicitly_given |= IDENT_NAME_GIVEN;
 667                return 0;
 668        }
 669
 670        if (!strcmp(var, "user.email")) {
 671                if (!value)
 672                        return config_error_nonbool(var);
 673                strlcpy(git_default_email, value, sizeof(git_default_email));
 674                user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
 675                return 0;
 676        }
 677
 678        /* Add other config variables here and to Documentation/config.txt. */
 679        return 0;
 680}
 681
 682static int git_default_i18n_config(const char *var, const char *value)
 683{
 684        if (!strcmp(var, "i18n.commitencoding"))
 685                return git_config_string(&git_commit_encoding, var, value);
 686
 687        if (!strcmp(var, "i18n.logoutputencoding"))
 688                return git_config_string(&git_log_output_encoding, var, value);
 689
 690        /* Add other config variables here and to Documentation/config.txt. */
 691        return 0;
 692}
 693
 694static int git_default_branch_config(const char *var, const char *value)
 695{
 696        if (!strcmp(var, "branch.autosetupmerge")) {
 697                if (value && !strcasecmp(value, "always")) {
 698                        git_branch_track = BRANCH_TRACK_ALWAYS;
 699                        return 0;
 700                }
 701                git_branch_track = git_config_bool(var, value);
 702                return 0;
 703        }
 704        if (!strcmp(var, "branch.autosetuprebase")) {
 705                if (!value)
 706                        return config_error_nonbool(var);
 707                else if (!strcmp(value, "never"))
 708                        autorebase = AUTOREBASE_NEVER;
 709                else if (!strcmp(value, "local"))
 710                        autorebase = AUTOREBASE_LOCAL;
 711                else if (!strcmp(value, "remote"))
 712                        autorebase = AUTOREBASE_REMOTE;
 713                else if (!strcmp(value, "always"))
 714                        autorebase = AUTOREBASE_ALWAYS;
 715                else
 716                        return error("Malformed value for %s", var);
 717                return 0;
 718        }
 719
 720        /* Add other config variables here and to Documentation/config.txt. */
 721        return 0;
 722}
 723
 724static int git_default_push_config(const char *var, const char *value)
 725{
 726        if (!strcmp(var, "push.default")) {
 727                if (!value)
 728                        return config_error_nonbool(var);
 729                else if (!strcmp(value, "nothing"))
 730                        push_default = PUSH_DEFAULT_NOTHING;
 731                else if (!strcmp(value, "matching"))
 732                        push_default = PUSH_DEFAULT_MATCHING;
 733                else if (!strcmp(value, "upstream"))
 734                        push_default = PUSH_DEFAULT_UPSTREAM;
 735                else if (!strcmp(value, "tracking")) /* deprecated */
 736                        push_default = PUSH_DEFAULT_UPSTREAM;
 737                else if (!strcmp(value, "current"))
 738                        push_default = PUSH_DEFAULT_CURRENT;
 739                else {
 740                        error("Malformed value for %s: %s", var, value);
 741                        return error("Must be one of nothing, matching, "
 742                                     "tracking or current.");
 743                }
 744                return 0;
 745        }
 746
 747        /* Add other config variables here and to Documentation/config.txt. */
 748        return 0;
 749}
 750
 751static int git_default_mailmap_config(const char *var, const char *value)
 752{
 753        if (!strcmp(var, "mailmap.file"))
 754                return git_config_string(&git_mailmap_file, var, value);
 755
 756        /* Add other config variables here and to Documentation/config.txt. */
 757        return 0;
 758}
 759
 760int git_default_config(const char *var, const char *value, void *dummy)
 761{
 762        if (!prefixcmp(var, "core."))
 763                return git_default_core_config(var, value);
 764
 765        if (!prefixcmp(var, "user."))
 766                return git_default_user_config(var, value);
 767
 768        if (!prefixcmp(var, "i18n."))
 769                return git_default_i18n_config(var, value);
 770
 771        if (!prefixcmp(var, "branch."))
 772                return git_default_branch_config(var, value);
 773
 774        if (!prefixcmp(var, "push."))
 775                return git_default_push_config(var, value);
 776
 777        if (!prefixcmp(var, "mailmap."))
 778                return git_default_mailmap_config(var, value);
 779
 780        if (!prefixcmp(var, "advice."))
 781                return git_default_advice_config(var, value);
 782
 783        if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
 784                pager_use_color = git_config_bool(var,value);
 785                return 0;
 786        }
 787
 788        /* Add other config variables here and to Documentation/config.txt. */
 789        return 0;
 790}
 791
 792int git_config_from_file(config_fn_t fn, const char *filename, void *data)
 793{
 794        int ret;
 795        FILE *f = fopen(filename, "r");
 796
 797        ret = -1;
 798        if (f) {
 799                config_file = f;
 800                config_file_name = filename;
 801                config_linenr = 1;
 802                config_file_eof = 0;
 803                ret = git_parse_file(fn, data);
 804                fclose(f);
 805                config_file_name = NULL;
 806        }
 807        return ret;
 808}
 809
 810const char *git_etc_gitconfig(void)
 811{
 812        static const char *system_wide;
 813        if (!system_wide)
 814                system_wide = system_path(ETC_GITCONFIG);
 815        return system_wide;
 816}
 817
 818int git_env_bool(const char *k, int def)
 819{
 820        const char *v = getenv(k);
 821        return v ? git_config_bool(k, v) : def;
 822}
 823
 824int git_config_system(void)
 825{
 826        return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
 827}
 828
 829int git_config_from_parameters(config_fn_t fn, void *data)
 830{
 831        static int loaded_environment;
 832        const struct config_item *ct;
 833
 834        if (!loaded_environment) {
 835                if (git_config_parse_environment() < 0)
 836                        return -1;
 837                loaded_environment = 1;
 838        }
 839        for (ct = config_parameters; ct; ct = ct->next)
 840                if (fn(ct->name, ct->value, data) < 0)
 841                        return -1;
 842        return 0;
 843}
 844
 845int git_config_early(config_fn_t fn, void *data, const char *repo_config)
 846{
 847        int ret = 0, found = 0;
 848        const char *home = NULL;
 849
 850        /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
 851        if (config_exclusive_filename)
 852                return git_config_from_file(fn, config_exclusive_filename, data);
 853        if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
 854                ret += git_config_from_file(fn, git_etc_gitconfig(),
 855                                            data);
 856                found += 1;
 857        }
 858
 859        home = getenv("HOME");
 860        if (home) {
 861                char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
 862                if (!access(user_config, R_OK)) {
 863                        ret += git_config_from_file(fn, user_config, data);
 864                        found += 1;
 865                }
 866                free(user_config);
 867        }
 868
 869        if (repo_config && !access(repo_config, R_OK)) {
 870                ret += git_config_from_file(fn, repo_config, data);
 871                found += 1;
 872        }
 873
 874        ret += git_config_from_parameters(fn, data);
 875        if (config_parameters)
 876                found += 1;
 877
 878        return ret == 0 ? found : ret;
 879}
 880
 881int git_config(config_fn_t fn, void *data)
 882{
 883        char *repo_config = NULL;
 884        int ret;
 885
 886        repo_config = git_pathdup("config");
 887        ret = git_config_early(fn, data, repo_config);
 888        if (repo_config)
 889                free(repo_config);
 890        return ret;
 891}
 892
 893/*
 894 * Find all the stuff for git_config_set() below.
 895 */
 896
 897#define MAX_MATCHES 512
 898
 899static struct {
 900        int baselen;
 901        char *key;
 902        int do_not_match;
 903        regex_t *value_regex;
 904        int multi_replace;
 905        size_t offset[MAX_MATCHES];
 906        enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
 907        int seen;
 908} store;
 909
 910static int matches(const char *key, const char *value)
 911{
 912        return !strcmp(key, store.key) &&
 913                (store.value_regex == NULL ||
 914                 (store.do_not_match ^
 915                  !regexec(store.value_regex, value, 0, NULL, 0)));
 916}
 917
 918static int store_aux(const char *key, const char *value, void *cb)
 919{
 920        const char *ep;
 921        size_t section_len;
 922
 923        switch (store.state) {
 924        case KEY_SEEN:
 925                if (matches(key, value)) {
 926                        if (store.seen == 1 && store.multi_replace == 0) {
 927                                warning("%s has multiple values", key);
 928                        } else if (store.seen >= MAX_MATCHES) {
 929                                error("too many matches for %s", key);
 930                                return 1;
 931                        }
 932
 933                        store.offset[store.seen] = ftell(config_file);
 934                        store.seen++;
 935                }
 936                break;
 937        case SECTION_SEEN:
 938                /*
 939                 * What we are looking for is in store.key (both
 940                 * section and var), and its section part is baselen
 941                 * long.  We found key (again, both section and var).
 942                 * We would want to know if this key is in the same
 943                 * section as what we are looking for.  We already
 944                 * know we are in the same section as what should
 945                 * hold store.key.
 946                 */
 947                ep = strrchr(key, '.');
 948                section_len = ep - key;
 949
 950                if ((section_len != store.baselen) ||
 951                    memcmp(key, store.key, section_len+1)) {
 952                        store.state = SECTION_END_SEEN;
 953                        break;
 954                }
 955
 956                /*
 957                 * Do not increment matches: this is no match, but we
 958                 * just made sure we are in the desired section.
 959                 */
 960                store.offset[store.seen] = ftell(config_file);
 961                /* fallthru */
 962        case SECTION_END_SEEN:
 963        case START:
 964                if (matches(key, value)) {
 965                        store.offset[store.seen] = ftell(config_file);
 966                        store.state = KEY_SEEN;
 967                        store.seen++;
 968                } else {
 969                        if (strrchr(key, '.') - key == store.baselen &&
 970                              !strncmp(key, store.key, store.baselen)) {
 971                                        store.state = SECTION_SEEN;
 972                                        store.offset[store.seen] = ftell(config_file);
 973                        }
 974                }
 975        }
 976        return 0;
 977}
 978
 979static int write_error(const char *filename)
 980{
 981        error("failed to write new configuration file %s", filename);
 982
 983        /* Same error code as "failed to rename". */
 984        return 4;
 985}
 986
 987static int store_write_section(int fd, const char *key)
 988{
 989        const char *dot;
 990        int i, success;
 991        struct strbuf sb = STRBUF_INIT;
 992
 993        dot = memchr(key, '.', store.baselen);
 994        if (dot) {
 995                strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
 996                for (i = dot - key + 1; i < store.baselen; i++) {
 997                        if (key[i] == '"' || key[i] == '\\')
 998                                strbuf_addch(&sb, '\\');
 999                        strbuf_addch(&sb, key[i]);
1000                }
1001                strbuf_addstr(&sb, "\"]\n");
1002        } else {
1003                strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1004        }
1005
1006        success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1007        strbuf_release(&sb);
1008
1009        return success;
1010}
1011
1012static int store_write_pair(int fd, const char *key, const char *value)
1013{
1014        int i, success;
1015        int length = strlen(key + store.baselen + 1);
1016        const char *quote = "";
1017        struct strbuf sb = STRBUF_INIT;
1018
1019        /*
1020         * Check to see if the value needs to be surrounded with a dq pair.
1021         * Note that problematic characters are always backslash-quoted; this
1022         * check is about not losing leading or trailing SP and strings that
1023         * follow beginning-of-comment characters (i.e. ';' and '#') by the
1024         * configuration parser.
1025         */
1026        if (value[0] == ' ')
1027                quote = "\"";
1028        for (i = 0; value[i]; i++)
1029                if (value[i] == ';' || value[i] == '#')
1030                        quote = "\"";
1031        if (i && value[i - 1] == ' ')
1032                quote = "\"";
1033
1034        strbuf_addf(&sb, "\t%.*s = %s",
1035                    length, key + store.baselen + 1, quote);
1036
1037        for (i = 0; value[i]; i++)
1038                switch (value[i]) {
1039                case '\n':
1040                        strbuf_addstr(&sb, "\\n");
1041                        break;
1042                case '\t':
1043                        strbuf_addstr(&sb, "\\t");
1044                        break;
1045                case '"':
1046                case '\\':
1047                        strbuf_addch(&sb, '\\');
1048                default:
1049                        strbuf_addch(&sb, value[i]);
1050                        break;
1051                }
1052        strbuf_addf(&sb, "%s\n", quote);
1053
1054        success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1055        strbuf_release(&sb);
1056
1057        return success;
1058}
1059
1060static ssize_t find_beginning_of_line(const char *contents, size_t size,
1061        size_t offset_, int *found_bracket)
1062{
1063        size_t equal_offset = size, bracket_offset = size;
1064        ssize_t offset;
1065
1066contline:
1067        for (offset = offset_-2; offset > 0
1068                        && contents[offset] != '\n'; offset--)
1069                switch (contents[offset]) {
1070                        case '=': equal_offset = offset; break;
1071                        case ']': bracket_offset = offset; break;
1072                }
1073        if (offset > 0 && contents[offset-1] == '\\') {
1074                offset_ = offset;
1075                goto contline;
1076        }
1077        if (bracket_offset < equal_offset) {
1078                *found_bracket = 1;
1079                offset = bracket_offset+1;
1080        } else
1081                offset++;
1082
1083        return offset;
1084}
1085
1086int git_config_set(const char *key, const char *value)
1087{
1088        return git_config_set_multivar(key, value, NULL, 0);
1089}
1090
1091/*
1092 * Auxiliary function to sanity-check and split the key into the section
1093 * identifier and variable name.
1094 *
1095 * Returns 0 on success, -1 when there is an invalid character in the key and
1096 * -2 if there is no section name in the key.
1097 *
1098 * store_key - pointer to char* which will hold a copy of the key with
1099 *             lowercase section and variable name
1100 * baselen - pointer to int which will hold the length of the
1101 *           section + subsection part, can be NULL
1102 */
1103int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1104{
1105        int i, dot, baselen;
1106        const char *last_dot = strrchr(key, '.');
1107
1108        /*
1109         * Since "key" actually contains the section name and the real
1110         * key name separated by a dot, we have to know where the dot is.
1111         */
1112
1113        if (last_dot == NULL || last_dot == key) {
1114                error("key does not contain a section: %s", key);
1115                return -2;
1116        }
1117
1118        if (!last_dot[1]) {
1119                error("key does not contain variable name: %s", key);
1120                return -2;
1121        }
1122
1123        baselen = last_dot - key;
1124        if (baselen_)
1125                *baselen_ = baselen;
1126
1127        /*
1128         * Validate the key and while at it, lower case it for matching.
1129         */
1130        *store_key = xmalloc(strlen(key) + 1);
1131
1132        dot = 0;
1133        for (i = 0; key[i]; i++) {
1134                unsigned char c = key[i];
1135                if (c == '.')
1136                        dot = 1;
1137                /* Leave the extended basename untouched.. */
1138                if (!dot || i > baselen) {
1139                        if (!iskeychar(c) ||
1140                            (i == baselen + 1 && !isalpha(c))) {
1141                                error("invalid key: %s", key);
1142                                goto out_free_ret_1;
1143                        }
1144                        c = tolower(c);
1145                } else if (c == '\n') {
1146                        error("invalid key (newline): %s", key);
1147                        goto out_free_ret_1;
1148                }
1149                (*store_key)[i] = c;
1150        }
1151        (*store_key)[i] = 0;
1152
1153        return 0;
1154
1155out_free_ret_1:
1156        free(*store_key);
1157        return -1;
1158}
1159
1160/*
1161 * If value==NULL, unset in (remove from) config,
1162 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1163 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1164 *     else all matching key/values (regardless how many) are removed,
1165 *     before the new pair is written.
1166 *
1167 * Returns 0 on success.
1168 *
1169 * This function does this:
1170 *
1171 * - it locks the config file by creating ".git/config.lock"
1172 *
1173 * - it then parses the config using store_aux() as validator to find
1174 *   the position on the key/value pair to replace. If it is to be unset,
1175 *   it must be found exactly once.
1176 *
1177 * - the config file is mmap()ed and the part before the match (if any) is
1178 *   written to the lock file, then the changed part and the rest.
1179 *
1180 * - the config file is removed and the lock file rename()d to it.
1181 *
1182 */
1183int git_config_set_multivar(const char *key, const char *value,
1184        const char *value_regex, int multi_replace)
1185{
1186        int fd = -1, in_fd;
1187        int ret;
1188        char *config_filename;
1189        struct lock_file *lock = NULL;
1190
1191        if (config_exclusive_filename)
1192                config_filename = xstrdup(config_exclusive_filename);
1193        else
1194                config_filename = git_pathdup("config");
1195
1196        /* parse-key returns negative; flip the sign to feed exit(3) */
1197        ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1198        if (ret)
1199                goto out_free;
1200
1201        store.multi_replace = multi_replace;
1202
1203
1204        /*
1205         * The lock serves a purpose in addition to locking: the new
1206         * contents of .git/config will be written into it.
1207         */
1208        lock = xcalloc(sizeof(struct lock_file), 1);
1209        fd = hold_lock_file_for_update(lock, config_filename, 0);
1210        if (fd < 0) {
1211                error("could not lock config file %s: %s", config_filename, strerror(errno));
1212                free(store.key);
1213                ret = -1;
1214                goto out_free;
1215        }
1216
1217        /*
1218         * If .git/config does not exist yet, write a minimal version.
1219         */
1220        in_fd = open(config_filename, O_RDONLY);
1221        if ( in_fd < 0 ) {
1222                free(store.key);
1223
1224                if ( ENOENT != errno ) {
1225                        error("opening %s: %s", config_filename,
1226                              strerror(errno));
1227                        ret = 3; /* same as "invalid config file" */
1228                        goto out_free;
1229                }
1230                /* if nothing to unset, error out */
1231                if (value == NULL) {
1232                        ret = 5;
1233                        goto out_free;
1234                }
1235
1236                store.key = (char *)key;
1237                if (!store_write_section(fd, key) ||
1238                    !store_write_pair(fd, key, value))
1239                        goto write_err_out;
1240        } else {
1241                struct stat st;
1242                char *contents;
1243                size_t contents_sz, copy_begin, copy_end;
1244                int i, new_line = 0;
1245
1246                if (value_regex == NULL)
1247                        store.value_regex = NULL;
1248                else {
1249                        if (value_regex[0] == '!') {
1250                                store.do_not_match = 1;
1251                                value_regex++;
1252                        } else
1253                                store.do_not_match = 0;
1254
1255                        store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1256                        if (regcomp(store.value_regex, value_regex,
1257                                        REG_EXTENDED)) {
1258                                error("invalid pattern: %s", value_regex);
1259                                free(store.value_regex);
1260                                ret = 6;
1261                                goto out_free;
1262                        }
1263                }
1264
1265                store.offset[0] = 0;
1266                store.state = START;
1267                store.seen = 0;
1268
1269                /*
1270                 * After this, store.offset will contain the *end* offset
1271                 * of the last match, or remain at 0 if no match was found.
1272                 * As a side effect, we make sure to transform only a valid
1273                 * existing config file.
1274                 */
1275                if (git_config_from_file(store_aux, config_filename, NULL)) {
1276                        error("invalid config file %s", config_filename);
1277                        free(store.key);
1278                        if (store.value_regex != NULL) {
1279                                regfree(store.value_regex);
1280                                free(store.value_regex);
1281                        }
1282                        ret = 3;
1283                        goto out_free;
1284                }
1285
1286                free(store.key);
1287                if (store.value_regex != NULL) {
1288                        regfree(store.value_regex);
1289                        free(store.value_regex);
1290                }
1291
1292                /* if nothing to unset, or too many matches, error out */
1293                if ((store.seen == 0 && value == NULL) ||
1294                                (store.seen > 1 && multi_replace == 0)) {
1295                        ret = 5;
1296                        goto out_free;
1297                }
1298
1299                fstat(in_fd, &st);
1300                contents_sz = xsize_t(st.st_size);
1301                contents = xmmap(NULL, contents_sz, PROT_READ,
1302                        MAP_PRIVATE, in_fd, 0);
1303                close(in_fd);
1304
1305                if (store.seen == 0)
1306                        store.seen = 1;
1307
1308                for (i = 0, copy_begin = 0; i < store.seen; i++) {
1309                        if (store.offset[i] == 0) {
1310                                store.offset[i] = copy_end = contents_sz;
1311                        } else if (store.state != KEY_SEEN) {
1312                                copy_end = store.offset[i];
1313                        } else
1314                                copy_end = find_beginning_of_line(
1315                                        contents, contents_sz,
1316                                        store.offset[i]-2, &new_line);
1317
1318                        if (copy_end > 0 && contents[copy_end-1] != '\n')
1319                                new_line = 1;
1320
1321                        /* write the first part of the config */
1322                        if (copy_end > copy_begin) {
1323                                if (write_in_full(fd, contents + copy_begin,
1324                                                  copy_end - copy_begin) <
1325                                    copy_end - copy_begin)
1326                                        goto write_err_out;
1327                                if (new_line &&
1328                                    write_str_in_full(fd, "\n") != 1)
1329                                        goto write_err_out;
1330                        }
1331                        copy_begin = store.offset[i];
1332                }
1333
1334                /* write the pair (value == NULL means unset) */
1335                if (value != NULL) {
1336                        if (store.state == START) {
1337                                if (!store_write_section(fd, key))
1338                                        goto write_err_out;
1339                        }
1340                        if (!store_write_pair(fd, key, value))
1341                                goto write_err_out;
1342                }
1343
1344                /* write the rest of the config */
1345                if (copy_begin < contents_sz)
1346                        if (write_in_full(fd, contents + copy_begin,
1347                                          contents_sz - copy_begin) <
1348                            contents_sz - copy_begin)
1349                                goto write_err_out;
1350
1351                munmap(contents, contents_sz);
1352        }
1353
1354        if (commit_lock_file(lock) < 0) {
1355                error("could not commit config file %s", config_filename);
1356                ret = 4;
1357                goto out_free;
1358        }
1359
1360        /*
1361         * lock is committed, so don't try to roll it back below.
1362         * NOTE: Since lockfile.c keeps a linked list of all created
1363         * lock_file structures, it isn't safe to free(lock).  It's
1364         * better to just leave it hanging around.
1365         */
1366        lock = NULL;
1367        ret = 0;
1368
1369out_free:
1370        if (lock)
1371                rollback_lock_file(lock);
1372        free(config_filename);
1373        return ret;
1374
1375write_err_out:
1376        ret = write_error(lock->filename);
1377        goto out_free;
1378
1379}
1380
1381static int section_name_match (const char *buf, const char *name)
1382{
1383        int i = 0, j = 0, dot = 0;
1384        if (buf[i] != '[')
1385                return 0;
1386        for (i = 1; buf[i] && buf[i] != ']'; i++) {
1387                if (!dot && isspace(buf[i])) {
1388                        dot = 1;
1389                        if (name[j++] != '.')
1390                                break;
1391                        for (i++; isspace(buf[i]); i++)
1392                                ; /* do nothing */
1393                        if (buf[i] != '"')
1394                                break;
1395                        continue;
1396                }
1397                if (buf[i] == '\\' && dot)
1398                        i++;
1399                else if (buf[i] == '"' && dot) {
1400                        for (i++; isspace(buf[i]); i++)
1401                                ; /* do_nothing */
1402                        break;
1403                }
1404                if (buf[i] != name[j++])
1405                        break;
1406        }
1407        if (buf[i] == ']' && name[j] == 0) {
1408                /*
1409                 * We match, now just find the right length offset by
1410                 * gobbling up any whitespace after it, as well
1411                 */
1412                i++;
1413                for (; buf[i] && isspace(buf[i]); i++)
1414                        ; /* do nothing */
1415                return i;
1416        }
1417        return 0;
1418}
1419
1420/* if new_name == NULL, the section is removed instead */
1421int git_config_rename_section(const char *old_name, const char *new_name)
1422{
1423        int ret = 0, remove = 0;
1424        char *config_filename;
1425        struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1426        int out_fd;
1427        char buf[1024];
1428
1429        if (config_exclusive_filename)
1430                config_filename = xstrdup(config_exclusive_filename);
1431        else
1432                config_filename = git_pathdup("config");
1433        out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1434        if (out_fd < 0) {
1435                ret = error("could not lock config file %s", config_filename);
1436                goto out;
1437        }
1438
1439        if (!(config_file = fopen(config_filename, "rb"))) {
1440                /* no config file means nothing to rename, no error */
1441                goto unlock_and_out;
1442        }
1443
1444        while (fgets(buf, sizeof(buf), config_file)) {
1445                int i;
1446                int length;
1447                char *output = buf;
1448                for (i = 0; buf[i] && isspace(buf[i]); i++)
1449                        ; /* do nothing */
1450                if (buf[i] == '[') {
1451                        /* it's a section */
1452                        int offset = section_name_match(&buf[i], old_name);
1453                        if (offset > 0) {
1454                                ret++;
1455                                if (new_name == NULL) {
1456                                        remove = 1;
1457                                        continue;
1458                                }
1459                                store.baselen = strlen(new_name);
1460                                if (!store_write_section(out_fd, new_name)) {
1461                                        ret = write_error(lock->filename);
1462                                        goto out;
1463                                }
1464                                /*
1465                                 * We wrote out the new section, with
1466                                 * a newline, now skip the old
1467                                 * section's length
1468                                 */
1469                                output += offset + i;
1470                                if (strlen(output) > 0) {
1471                                        /*
1472                                         * More content means there's
1473                                         * a declaration to put on the
1474                                         * next line; indent with a
1475                                         * tab
1476                                         */
1477                                        output -= 1;
1478                                        output[0] = '\t';
1479                                }
1480                        }
1481                        remove = 0;
1482                }
1483                if (remove)
1484                        continue;
1485                length = strlen(output);
1486                if (write_in_full(out_fd, output, length) != length) {
1487                        ret = write_error(lock->filename);
1488                        goto out;
1489                }
1490        }
1491        fclose(config_file);
1492 unlock_and_out:
1493        if (commit_lock_file(lock) < 0)
1494                ret = error("could not commit config file %s", config_filename);
1495 out:
1496        free(config_filename);
1497        return ret;
1498}
1499
1500/*
1501 * Call this to report error for your variable that should not
1502 * get a boolean value (i.e. "[my] var" means "true").
1503 */
1504int config_error_nonbool(const char *var)
1505{
1506        return error("Missing value for '%s'", var);
1507}