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