builtin/config.c

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