builtin / config.con commit Merge branch 'sb/mailmap-updates' (3717c73)
   1#include "builtin.h"
   2#include "cache.h"
   3#include "color.h"
   4#include "parse-options.h"
   5
   6static const char *const builtin_config_usage[] = {
   7        N_("git config [options]"),
   8        NULL
   9};
  10
  11static char *key;
  12static regex_t *key_regexp;
  13static regex_t *regexp;
  14static int show_keys;
  15static int use_key_regexp;
  16static int do_all;
  17static int do_not_match;
  18static char delim = '=';
  19static char key_delim = ' ';
  20static char term = '\n';
  21
  22static int use_global_config, use_system_config, use_local_config;
  23static const char *given_config_file;
  24static const char *given_config_blob;
  25static int actions, types;
  26static const char *get_color_slot, *get_colorbool_slot;
  27static int end_null;
  28static int respect_includes = -1;
  29
  30#define ACTION_GET (1<<0)
  31#define ACTION_GET_ALL (1<<1)
  32#define ACTION_GET_REGEXP (1<<2)
  33#define ACTION_REPLACE_ALL (1<<3)
  34#define ACTION_ADD (1<<4)
  35#define ACTION_UNSET (1<<5)
  36#define ACTION_UNSET_ALL (1<<6)
  37#define ACTION_RENAME_SECTION (1<<7)
  38#define ACTION_REMOVE_SECTION (1<<8)
  39#define ACTION_LIST (1<<9)
  40#define ACTION_EDIT (1<<10)
  41#define ACTION_SET (1<<11)
  42#define ACTION_SET_ALL (1<<12)
  43#define ACTION_GET_COLOR (1<<13)
  44#define ACTION_GET_COLORBOOL (1<<14)
  45
  46#define TYPE_BOOL (1<<0)
  47#define TYPE_INT (1<<1)
  48#define TYPE_BOOL_OR_INT (1<<2)
  49#define TYPE_PATH (1<<3)
  50
  51static struct option builtin_config_options[] = {
  52        OPT_GROUP(N_("Config file location")),
  53        OPT_BOOLEAN(0, "global", &use_global_config, N_("use global config file")),
  54        OPT_BOOLEAN(0, "system", &use_system_config, N_("use system config file")),
  55        OPT_BOOLEAN(0, "local", &use_local_config, N_("use repository config file")),
  56        OPT_STRING('f', "file", &given_config_file, N_("file"), N_("use given config file")),
  57        OPT_STRING(0, "blob", &given_config_blob, N_("blob-id"), N_("read config from given blob object")),
  58        OPT_GROUP(N_("Action")),
  59        OPT_BIT(0, "get", &actions, N_("get value: name [value-regex]"), ACTION_GET),
  60        OPT_BIT(0, "get-all", &actions, N_("get all values: key [value-regex]"), ACTION_GET_ALL),
  61        OPT_BIT(0, "get-regexp", &actions, N_("get values for regexp: name-regex [value-regex]"), ACTION_GET_REGEXP),
  62        OPT_BIT(0, "replace-all", &actions, N_("replace all matching variables: name value [value_regex]"), ACTION_REPLACE_ALL),
  63        OPT_BIT(0, "add", &actions, N_("add a new variable: name value"), ACTION_ADD),
  64        OPT_BIT(0, "unset", &actions, N_("remove a variable: name [value-regex]"), ACTION_UNSET),
  65        OPT_BIT(0, "unset-all", &actions, N_("remove all matches: name [value-regex]"), ACTION_UNSET_ALL),
  66        OPT_BIT(0, "rename-section", &actions, N_("rename section: old-name new-name"), ACTION_RENAME_SECTION),
  67        OPT_BIT(0, "remove-section", &actions, N_("remove a section: name"), ACTION_REMOVE_SECTION),
  68        OPT_BIT('l', "list", &actions, N_("list all"), ACTION_LIST),
  69        OPT_BIT('e', "edit", &actions, N_("open an editor"), ACTION_EDIT),
  70        OPT_STRING(0, "get-color", &get_color_slot, N_("slot"), N_("find the color configured: [default]")),
  71        OPT_STRING(0, "get-colorbool", &get_colorbool_slot, N_("slot"), N_("find the color setting: [stdout-is-tty]")),
  72        OPT_GROUP(N_("Type")),
  73        OPT_BIT(0, "bool", &types, N_("value is \"true\" or \"false\""), TYPE_BOOL),
  74        OPT_BIT(0, "int", &types, N_("value is decimal number"), TYPE_INT),
  75        OPT_BIT(0, "bool-or-int", &types, N_("value is --bool or --int"), TYPE_BOOL_OR_INT),
  76        OPT_BIT(0, "path", &types, N_("value is a path (file or directory name)"), TYPE_PATH),
  77        OPT_GROUP(N_("Other")),
  78        OPT_BOOLEAN('z', "null", &end_null, N_("terminate values with NUL byte")),
  79        OPT_BOOL(0, "includes", &respect_includes, N_("respect include directives on lookup")),
  80        OPT_END(),
  81};
  82
  83static void check_argc(int argc, int min, int max) {
  84        if (argc >= min && argc <= max)
  85                return;
  86        error("wrong number of arguments");
  87        usage_with_options(builtin_config_usage, builtin_config_options);
  88}
  89
  90static int show_all_config(const char *key_, const char *value_, void *cb)
  91{
  92        if (value_)
  93                printf("%s%c%s%c", key_, delim, value_, term);
  94        else
  95                printf("%s%c", key_, term);
  96        return 0;
  97}
  98
  99struct strbuf_list {
 100        struct strbuf *items;
 101        int nr;
 102        int alloc;
 103};
 104
 105static int collect_config(const char *key_, const char *value_, void *cb)
 106{
 107        struct strbuf_list *values = cb;
 108        struct strbuf *buf;
 109        char value[256];
 110        const char *vptr = value;
 111        int must_free_vptr = 0;
 112        int must_print_delim = 0;
 113
 114        if (!use_key_regexp && strcmp(key_, key))
 115                return 0;
 116        if (use_key_regexp && regexec(key_regexp, key_, 0, NULL, 0))
 117                return 0;
 118        if (regexp != NULL &&
 119            (do_not_match ^ !!regexec(regexp, (value_?value_:""), 0, NULL, 0)))
 120                return 0;
 121
 122        ALLOC_GROW(values->items, values->nr + 1, values->alloc);
 123        buf = &values->items[values->nr++];
 124        strbuf_init(buf, 0);
 125
 126        if (show_keys) {
 127                strbuf_addstr(buf, key_);
 128                must_print_delim = 1;
 129        }
 130        if (types == TYPE_INT)
 131                sprintf(value, "%d", git_config_int(key_, value_?value_:""));
 132        else if (types == TYPE_BOOL)
 133                vptr = git_config_bool(key_, value_) ? "true" : "false";
 134        else if (types == TYPE_BOOL_OR_INT) {
 135                int is_bool, v;
 136                v = git_config_bool_or_int(key_, value_, &is_bool);
 137                if (is_bool)
 138                        vptr = v ? "true" : "false";
 139                else
 140                        sprintf(value, "%d", v);
 141        } else if (types == TYPE_PATH) {
 142                if (git_config_pathname(&vptr, key_, value_) < 0)
 143                        return -1;
 144                must_free_vptr = 1;
 145        } else if (value_) {
 146                vptr = value_;
 147        } else {
 148                /* Just show the key name */
 149                vptr = "";
 150                must_print_delim = 0;
 151        }
 152
 153        if (must_print_delim)
 154                strbuf_addch(buf, key_delim);
 155        strbuf_addstr(buf, vptr);
 156        strbuf_addch(buf, term);
 157
 158        if (must_free_vptr)
 159                /* If vptr must be freed, it's a pointer to a
 160                 * dynamically allocated buffer, it's safe to cast to
 161                 * const.
 162                */
 163                free((char *)vptr);
 164
 165        return 0;
 166}
 167
 168static int get_value(const char *key_, const char *regex_)
 169{
 170        int ret = CONFIG_GENERIC_ERROR;
 171        struct strbuf_list values = {NULL};
 172        int i;
 173
 174        if (use_key_regexp) {
 175                char *tl;
 176
 177                /*
 178                 * NEEDSWORK: this naive pattern lowercasing obviously does not
 179                 * work for more complex patterns like "^[^.]*Foo.*bar".
 180                 * Perhaps we should deprecate this altogether someday.
 181                 */
 182
 183                key = xstrdup(key_);
 184                for (tl = key + strlen(key) - 1;
 185                     tl >= key && *tl != '.';
 186                     tl--)
 187                        *tl = tolower(*tl);
 188                for (tl = key; *tl && *tl != '.'; tl++)
 189                        *tl = tolower(*tl);
 190
 191                key_regexp = (regex_t*)xmalloc(sizeof(regex_t));
 192                if (regcomp(key_regexp, key, REG_EXTENDED)) {
 193                        fprintf(stderr, "Invalid key pattern: %s\n", key_);
 194                        free(key_regexp);
 195                        key_regexp = NULL;
 196                        ret = CONFIG_INVALID_PATTERN;
 197                        goto free_strings;
 198                }
 199        } else {
 200                if (git_config_parse_key(key_, &key, NULL)) {
 201                        ret = CONFIG_INVALID_KEY;
 202                        goto free_strings;
 203                }
 204        }
 205
 206        if (regex_) {
 207                if (regex_[0] == '!') {
 208                        do_not_match = 1;
 209                        regex_++;
 210                }
 211
 212                regexp = (regex_t*)xmalloc(sizeof(regex_t));
 213                if (regcomp(regexp, regex_, REG_EXTENDED)) {
 214                        fprintf(stderr, "Invalid pattern: %s\n", regex_);
 215                        free(regexp);
 216                        regexp = NULL;
 217                        ret = CONFIG_INVALID_PATTERN;
 218                        goto free_strings;
 219                }
 220        }
 221
 222        git_config_with_options(collect_config, &values,
 223                                given_config_file, given_config_blob,
 224                                respect_includes);
 225
 226        ret = !values.nr;
 227
 228        for (i = 0; i < values.nr; i++) {
 229                struct strbuf *buf = values.items + i;
 230                if (do_all || i == values.nr - 1)
 231                        fwrite(buf->buf, 1, buf->len, stdout);
 232                strbuf_release(buf);
 233        }
 234        free(values.items);
 235
 236free_strings:
 237        free(key);
 238        if (key_regexp) {
 239                regfree(key_regexp);
 240                free(key_regexp);
 241        }
 242        if (regexp) {
 243                regfree(regexp);
 244                free(regexp);
 245        }
 246
 247        return ret;
 248}
 249
 250static char *normalize_value(const char *key, const char *value)
 251{
 252        char *normalized;
 253
 254        if (!value)
 255                return NULL;
 256
 257        if (types == 0 || types == TYPE_PATH)
 258                /*
 259                 * We don't do normalization for TYPE_PATH here: If
 260                 * the path is like ~/foobar/, we prefer to store
 261                 * "~/foobar/" in the config file, and to expand the ~
 262                 * when retrieving the value.
 263                 */
 264                normalized = xstrdup(value);
 265        else {
 266                normalized = xmalloc(64);
 267                if (types == TYPE_INT) {
 268                        int v = git_config_int(key, value);
 269                        sprintf(normalized, "%d", v);
 270                }
 271                else if (types == TYPE_BOOL)
 272                        sprintf(normalized, "%s",
 273                                git_config_bool(key, value) ? "true" : "false");
 274                else if (types == TYPE_BOOL_OR_INT) {
 275                        int is_bool, v;
 276                        v = git_config_bool_or_int(key, value, &is_bool);
 277                        if (!is_bool)
 278                                sprintf(normalized, "%d", v);
 279                        else
 280                                sprintf(normalized, "%s", v ? "true" : "false");
 281                }
 282        }
 283
 284        return normalized;
 285}
 286
 287static int get_color_found;
 288static const char *get_color_slot;
 289static const char *get_colorbool_slot;
 290static char parsed_color[COLOR_MAXLEN];
 291
 292static int git_get_color_config(const char *var, const char *value, void *cb)
 293{
 294        if (!strcmp(var, get_color_slot)) {
 295                if (!value)
 296                        config_error_nonbool(var);
 297                color_parse(value, var, parsed_color);
 298                get_color_found = 1;
 299        }
 300        return 0;
 301}
 302
 303static void get_color(const char *def_color)
 304{
 305        get_color_found = 0;
 306        parsed_color[0] = '\0';
 307        git_config_with_options(git_get_color_config, NULL,
 308                                given_config_file, given_config_blob,
 309                                respect_includes);
 310
 311        if (!get_color_found && def_color)
 312                color_parse(def_color, "command line", parsed_color);
 313
 314        fputs(parsed_color, stdout);
 315}
 316
 317static int get_colorbool_found;
 318static int get_diff_color_found;
 319static int get_color_ui_found;
 320static int git_get_colorbool_config(const char *var, const char *value,
 321                void *cb)
 322{
 323        if (!strcmp(var, get_colorbool_slot))
 324                get_colorbool_found = git_config_colorbool(var, value);
 325        else if (!strcmp(var, "diff.color"))
 326                get_diff_color_found = git_config_colorbool(var, value);
 327        else if (!strcmp(var, "color.ui"))
 328                get_color_ui_found = git_config_colorbool(var, value);
 329        return 0;
 330}
 331
 332static int get_colorbool(int print)
 333{
 334        get_colorbool_found = -1;
 335        get_diff_color_found = -1;
 336        get_color_ui_found = -1;
 337        git_config_with_options(git_get_colorbool_config, NULL,
 338                                given_config_file, given_config_blob,
 339                                respect_includes);
 340
 341        if (get_colorbool_found < 0) {
 342                if (!strcmp(get_colorbool_slot, "color.diff"))
 343                        get_colorbool_found = get_diff_color_found;
 344                if (get_colorbool_found < 0)
 345                        get_colorbool_found = get_color_ui_found;
 346        }
 347
 348        if (get_colorbool_found < 0)
 349                /* default value if none found in config */
 350                get_colorbool_found = GIT_COLOR_AUTO;
 351
 352        get_colorbool_found = want_color(get_colorbool_found);
 353
 354        if (print) {
 355                printf("%s\n", get_colorbool_found ? "true" : "false");
 356                return 0;
 357        } else
 358                return get_colorbool_found ? 0 : 1;
 359}
 360
 361static void check_blob_write(void)
 362{
 363        if (given_config_blob)
 364                die("writing config blobs is not supported");
 365}
 366
 367int cmd_config(int argc, const char **argv, const char *prefix)
 368{
 369        int nongit = !startup_info->have_repository;
 370        char *value;
 371
 372        given_config_file = getenv(CONFIG_ENVIRONMENT);
 373
 374        argc = parse_options(argc, argv, prefix, builtin_config_options,
 375                             builtin_config_usage,
 376                             PARSE_OPT_STOP_AT_NON_OPTION);
 377
 378        if (use_global_config + use_system_config + use_local_config +
 379            !!given_config_file + !!given_config_blob > 1) {
 380                error("only one config file at a time.");
 381                usage_with_options(builtin_config_usage, builtin_config_options);
 382        }
 383
 384        if (use_global_config) {
 385                char *user_config = NULL;
 386                char *xdg_config = NULL;
 387
 388                home_config_paths(&user_config, &xdg_config, "config");
 389
 390                if (!user_config)
 391                        /*
 392                         * It is unknown if HOME/.gitconfig exists, so
 393                         * we do not know if we should write to XDG
 394                         * location; error out even if XDG_CONFIG_HOME
 395                         * is set and points at a sane location.
 396                         */
 397                        die("$HOME not set");
 398
 399                if (access_or_warn(user_config, R_OK, 0) &&
 400                    xdg_config && !access_or_warn(xdg_config, R_OK, 0))
 401                        given_config_file = xdg_config;
 402                else
 403                        given_config_file = user_config;
 404        }
 405        else if (use_system_config)
 406                given_config_file = git_etc_gitconfig();
 407        else if (use_local_config)
 408                given_config_file = git_pathdup("config");
 409        else if (given_config_file) {
 410                if (!is_absolute_path(given_config_file) && prefix)
 411                        given_config_file =
 412                                xstrdup(prefix_filename(prefix,
 413                                                        strlen(prefix),
 414                                                        given_config_file));
 415        }
 416
 417        if (respect_includes == -1)
 418                respect_includes = !given_config_file;
 419
 420        if (end_null) {
 421                term = '\0';
 422                delim = '\n';
 423                key_delim = '\n';
 424        }
 425
 426        if (HAS_MULTI_BITS(types)) {
 427                error("only one type at a time.");
 428                usage_with_options(builtin_config_usage, builtin_config_options);
 429        }
 430
 431        if (get_color_slot)
 432            actions |= ACTION_GET_COLOR;
 433        if (get_colorbool_slot)
 434            actions |= ACTION_GET_COLORBOOL;
 435
 436        if ((get_color_slot || get_colorbool_slot) && types) {
 437                error("--get-color and variable type are incoherent");
 438                usage_with_options(builtin_config_usage, builtin_config_options);
 439        }
 440
 441        if (HAS_MULTI_BITS(actions)) {
 442                error("only one action at a time.");
 443                usage_with_options(builtin_config_usage, builtin_config_options);
 444        }
 445        if (actions == 0)
 446                switch (argc) {
 447                case 1: actions = ACTION_GET; break;
 448                case 2: actions = ACTION_SET; break;
 449                case 3: actions = ACTION_SET_ALL; break;
 450                default:
 451                        usage_with_options(builtin_config_usage, builtin_config_options);
 452                }
 453
 454        if (actions == ACTION_LIST) {
 455                check_argc(argc, 0, 0);
 456                if (git_config_with_options(show_all_config, NULL,
 457                                            given_config_file,
 458                                            given_config_blob,
 459                                            respect_includes) < 0) {
 460                        if (given_config_file)
 461                                die_errno("unable to read config file '%s'",
 462                                          given_config_file);
 463                        else
 464                                die("error processing config file(s)");
 465                }
 466        }
 467        else if (actions == ACTION_EDIT) {
 468                check_argc(argc, 0, 0);
 469                if (!given_config_file && nongit)
 470                        die("not in a git directory");
 471                if (given_config_blob)
 472                        die("editing blobs is not supported");
 473                git_config(git_default_config, NULL);
 474                launch_editor(given_config_file ?
 475                              given_config_file : git_path("config"),
 476                              NULL, NULL);
 477        }
 478        else if (actions == ACTION_SET) {
 479                int ret;
 480                check_blob_write();
 481                check_argc(argc, 2, 2);
 482                value = normalize_value(argv[0], argv[1]);
 483                ret = git_config_set_in_file(given_config_file, argv[0], value);
 484                if (ret == CONFIG_NOTHING_SET)
 485                        error("cannot overwrite multiple values with a single value\n"
 486                        "       Use a regexp, --add or --replace-all to change %s.", argv[0]);
 487                return ret;
 488        }
 489        else if (actions == ACTION_SET_ALL) {
 490                check_blob_write();
 491                check_argc(argc, 2, 3);
 492                value = normalize_value(argv[0], argv[1]);
 493                return git_config_set_multivar_in_file(given_config_file,
 494                                                       argv[0], value, argv[2], 0);
 495        }
 496        else if (actions == ACTION_ADD) {
 497                check_blob_write();
 498                check_argc(argc, 2, 2);
 499                value = normalize_value(argv[0], argv[1]);
 500                return git_config_set_multivar_in_file(given_config_file,
 501                                                       argv[0], value, "^$", 0);
 502        }
 503        else if (actions == ACTION_REPLACE_ALL) {
 504                check_blob_write();
 505                check_argc(argc, 2, 3);
 506                value = normalize_value(argv[0], argv[1]);
 507                return git_config_set_multivar_in_file(given_config_file,
 508                                                       argv[0], value, argv[2], 1);
 509        }
 510        else if (actions == ACTION_GET) {
 511                check_argc(argc, 1, 2);
 512                return get_value(argv[0], argv[1]);
 513        }
 514        else if (actions == ACTION_GET_ALL) {
 515                do_all = 1;
 516                check_argc(argc, 1, 2);
 517                return get_value(argv[0], argv[1]);
 518        }
 519        else if (actions == ACTION_GET_REGEXP) {
 520                show_keys = 1;
 521                use_key_regexp = 1;
 522                do_all = 1;
 523                check_argc(argc, 1, 2);
 524                return get_value(argv[0], argv[1]);
 525        }
 526        else if (actions == ACTION_UNSET) {
 527                check_blob_write();
 528                check_argc(argc, 1, 2);
 529                if (argc == 2)
 530                        return git_config_set_multivar_in_file(given_config_file,
 531                                                               argv[0], NULL, argv[1], 0);
 532                else
 533                        return git_config_set_in_file(given_config_file,
 534                                                      argv[0], NULL);
 535        }
 536        else if (actions == ACTION_UNSET_ALL) {
 537                check_blob_write();
 538                check_argc(argc, 1, 2);
 539                return git_config_set_multivar_in_file(given_config_file,
 540                                                       argv[0], NULL, argv[1], 1);
 541        }
 542        else if (actions == ACTION_RENAME_SECTION) {
 543                int ret;
 544                check_blob_write();
 545                check_argc(argc, 2, 2);
 546                ret = git_config_rename_section_in_file(given_config_file,
 547                                                        argv[0], argv[1]);
 548                if (ret < 0)
 549                        return ret;
 550                if (ret == 0)
 551                        die("No such section!");
 552        }
 553        else if (actions == ACTION_REMOVE_SECTION) {
 554                int ret;
 555                check_blob_write();
 556                check_argc(argc, 1, 1);
 557                ret = git_config_rename_section_in_file(given_config_file,
 558                                                        argv[0], NULL);
 559                if (ret < 0)
 560                        return ret;
 561                if (ret == 0)
 562                        die("No such section!");
 563        }
 564        else if (actions == ACTION_GET_COLOR) {
 565                get_color(argv[0]);
 566        }
 567        else if (actions == ACTION_GET_COLORBOOL) {
 568                if (argc == 1)
 569                        color_stdout_is_tty = git_config_bool("command line", argv[0]);
 570                return get_colorbool(argc != 0);
 571        }
 572
 573        return 0;
 574}
 575
 576int cmd_repo_config(int argc, const char **argv, const char *prefix)
 577{
 578        fprintf(stderr, "WARNING: git repo-config is deprecated in favor of git config.\n");
 579        return cmd_config(argc, argv, prefix);
 580}