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 = -1;
 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                         goto free_strings;
 202                 }
 203         } else {
 204                 if (git_config_parse_key(key_, &key, NULL))
 205                         goto free_strings;
 206         }
 207
 208         if (regex_) {
 209                 if (regex_[0] == '!') {
 210                         do_not_match = 1;
 211                         regex_++;
 212                 }
 213
 214                 regexp = (regex_t*)xmalloc(sizeof(regex_t));
 215                 if (regcomp(regexp, regex_, REG_EXTENDED)) {
 216                         fprintf(stderr, "Invalid pattern: %s\n", regex_);
 217                         goto free_strings;
 218                 }
 219         }
 220
 221         fn = show_config;
 222         data = NULL;
 223         if (respect_includes) {
 224                 inc.fn = fn;
 225                 inc.data = data;
 226                 fn = git_config_include;
 227                 data = &inc;
 228         }
 229
 230         if (do_all && system_wide)
 231                 git_config_from_file(fn, system_wide, data);
 232         if (do_all && global)
 233                 git_config_from_file(fn, global, data);
 234         if (do_all)
 235                 git_config_from_file(fn, local, data);
 236         git_config_from_parameters(fn, data);
 237         if (!do_all && !seen)
 238                 git_config_from_file(fn, local, data);
 239         if (!do_all && !seen && global)
 240                 git_config_from_file(fn, global, data);
 241         if (!do_all && !seen && system_wide)
 242                 git_config_from_file(fn, system_wide, data);
 243
 244         free(key);
 245         if (regexp) {
 246                 regfree(regexp);
 247                 free(regexp);
 248         }
 249
 250         if (do_all)
 251                 ret = !seen;
 252         else
 253                 ret = (seen == 1) ? 0 : seen > 1 ? 2 : 1;
 254
 255 free_strings:
 256         free(repo_config);
 257         free(global);
 258         return ret;
 259 }
 260
 261 static char *normalize_value(const char *key, const char *value)
 262 {
 263         char *normalized;
 264
 265         if (!value)
 266                 return NULL;
 267
 268         if (types == 0 || types == TYPE_PATH)
 269                 /*
 270                  * We don't do normalization for TYPE_PATH here: If
 271                  * the path is like ~/foobar/, we prefer to store
 272                  * "~/foobar/" in the config file, and to expand the ~
 273                  * when retrieving the value.
 274                  */
 275                 normalized = xstrdup(value);
 276         else {
 277                 normalized = xmalloc(64);
 278                 if (types == TYPE_INT) {
 279                         int v = git_config_int(key, value);
 280                         sprintf(normalized, "%d", v);
 281                 }
 282                 else if (types == TYPE_BOOL)
 283                         sprintf(normalized, "%s",
 284                                 git_config_bool(key, value) ? "true" : "false");
 285                 else if (types == TYPE_BOOL_OR_INT) {
 286                         int is_bool, v;
 287                         v = git_config_bool_or_int(key, value, &is_bool);
 288                         if (!is_bool)
 289                                 sprintf(normalized, "%d", v);
 290                         else
 291                                 sprintf(normalized, "%s", v ? "true" : "false");
 292                 }
 293         }
 294
 295         return normalized;
 296 }
 297
 298 static int get_color_found;
 299 static const char *get_color_slot;
 300 static const char *get_colorbool_slot;
 301 static char parsed_color[COLOR_MAXLEN];
 302
 303 static int git_get_color_config(const char *var, const char *value, void *cb)
 304 {
 305         if (!strcmp(var, get_color_slot)) {
 306                 if (!value)
 307                         config_error_nonbool(var);
 308                 color_parse(value, var, parsed_color);
 309                 get_color_found = 1;
 310         }
 311         return 0;
 312 }
 313
 314 static void get_color(const char *def_color)
 315 {
 316         get_color_found = 0;
 317         parsed_color[0] = '\0';
 318         git_config_with_options(git_get_color_config, NULL,
 319                                 given_config_file, respect_includes);
 320
 321         if (!get_color_found && def_color)
 322                 color_parse(def_color, "command line", parsed_color);
 323
 324         fputs(parsed_color, stdout);
 325 }
 326
 327 static int get_colorbool_found;
 328 static int get_diff_color_found;
 329 static int get_color_ui_found;
 330 static int git_get_colorbool_config(const char *var, const char *value,
 331                 void *cb)
 332 {
 333         if (!strcmp(var, get_colorbool_slot))
 334                 get_colorbool_found = git_config_colorbool(var, value);
 335         else if (!strcmp(var, "diff.color"))
 336                 get_diff_color_found = git_config_colorbool(var, value);
 337         else if (!strcmp(var, "color.ui"))
 338                 get_color_ui_found = git_config_colorbool(var, value);
 339         return 0;
 340 }
 341
 342 static int get_colorbool(int print)
 343 {
 344         get_colorbool_found = -1;
 345         get_diff_color_found = -1;
 346         git_config_with_options(git_get_colorbool_config, NULL,
 347                                 given_config_file, respect_includes);
 348
 349         if (get_colorbool_found < 0) {
 350                 if (!strcmp(get_colorbool_slot, "color.diff"))
 351                         get_colorbool_found = get_diff_color_found;
 352                 if (get_colorbool_found < 0)
 353                         get_colorbool_found = get_color_ui_found;
 354         }
 355
 356         get_colorbool_found = want_color(get_colorbool_found);
 357
 358         if (print) {
 359                 printf("%s\n", get_colorbool_found ? "true" : "false");
 360                 return 0;
 361         } else
 362                 return get_colorbool_found ? 0 : 1;
 363 }
 364
 365 int cmd_config(int argc, const char **argv, const char *prefix)
 366 {
 367         int nongit = !startup_info->have_repository;
 368         char *value;
 369
 370         given_config_file = getenv(CONFIG_ENVIRONMENT);
 371
 372         argc = parse_options(argc, argv, prefix, builtin_config_options,
 373                              builtin_config_usage,
 374                              PARSE_OPT_STOP_AT_NON_OPTION);
 375
 376         if (use_global_config + use_system_config + use_local_config + !!given_config_file > 1) {
 377                 error("only one config file at a time.");
 378                 usage_with_options(builtin_config_usage, builtin_config_options);
 379         }
 380
 381         if (use_global_config) {
 382                 char *home = getenv("HOME");
 383                 if (home) {
 384                         char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
 385                         given_config_file = user_config;
 386                 } else {
 387                         die("$HOME not set");
 388                 }
 389         }
 390         else if (use_system_config)
 391                 given_config_file = git_etc_gitconfig();
 392         else if (use_local_config)
 393                 given_config_file = git_pathdup("config");
 394         else if (given_config_file) {
 395                 if (!is_absolute_path(given_config_file) && prefix)
 396                         given_config_file =
 397                                 xstrdup(prefix_filename(prefix,
 398                                                         strlen(prefix),
 399                                                         given_config_file));
 400                 else
 401                         given_config_file = given_config_file;
 402         }
 403
 404         if (respect_includes == -1)
 405                 respect_includes = !given_config_file;
 406
 407         if (end_null) {
 408                 term = '\0';
 409                 delim = '\n';
 410                 key_delim = '\n';
 411         }
 412
 413         if (HAS_MULTI_BITS(types)) {
 414                 error("only one type at a time.");
 415                 usage_with_options(builtin_config_usage, builtin_config_options);
 416         }
 417
 418         if (get_color_slot)
 419             actions |= ACTION_GET_COLOR;
 420         if (get_colorbool_slot)
 421             actions |= ACTION_GET_COLORBOOL;
 422
 423         if ((get_color_slot || get_colorbool_slot) && types) {
 424                 error("--get-color and variable type are incoherent");
 425                 usage_with_options(builtin_config_usage, builtin_config_options);
 426         }
 427
 428         if (HAS_MULTI_BITS(actions)) {
 429                 error("only one action at a time.");
 430                 usage_with_options(builtin_config_usage, builtin_config_options);
 431         }
 432         if (actions == 0)
 433                 switch (argc) {
 434                 case 1: actions = ACTION_GET; break;
 435                 case 2: actions = ACTION_SET; break;
 436                 case 3: actions = ACTION_SET_ALL; break;
 437                 default:
 438                         usage_with_options(builtin_config_usage, builtin_config_options);
 439                 }
 440
 441         if (actions == ACTION_LIST) {
 442                 check_argc(argc, 0, 0);
 443                 if (git_config_with_options(show_all_config, NULL,
 444                                             given_config_file,
 445                                             respect_includes) < 0) {
 446                         if (given_config_file)
 447                                 die_errno("unable to read config file '%s'",
 448                                           given_config_file);
 449                         else
 450                                 die("error processing config file(s)");
 451                 }
 452         }
 453         else if (actions == ACTION_EDIT) {
 454                 check_argc(argc, 0, 0);
 455                 if (!given_config_file && nongit)
 456                         die("not in a git directory");
 457                 git_config(git_default_config, NULL);
 458                 launch_editor(given_config_file ?
 459                               given_config_file : git_path("config"),
 460                               NULL, NULL);
 461         }
 462         else if (actions == ACTION_SET) {
 463                 int ret;
 464                 check_argc(argc, 2, 2);
 465                 value = normalize_value(argv[0], argv[1]);
 466                 ret = git_config_set_in_file(given_config_file, argv[0], value);
 467                 if (ret == CONFIG_NOTHING_SET)
 468                         error("cannot overwrite multiple values with a single value\n"
 469                         "       Use a regexp, --add or --replace-all to change %s.", argv[0]);
 470                 return ret;
 471         }
 472         else if (actions == ACTION_SET_ALL) {
 473                 check_argc(argc, 2, 3);
 474                 value = normalize_value(argv[0], argv[1]);
 475                 return git_config_set_multivar_in_file(given_config_file,
 476                                                        argv[0], value, argv[2], 0);
 477         }
 478         else if (actions == ACTION_ADD) {
 479                 check_argc(argc, 2, 2);
 480                 value = normalize_value(argv[0], argv[1]);
 481                 return git_config_set_multivar_in_file(given_config_file,
 482                                                        argv[0], value, "^$", 0);
 483         }
 484         else if (actions == ACTION_REPLACE_ALL) {
 485                 check_argc(argc, 2, 3);
 486                 value = normalize_value(argv[0], argv[1]);
 487                 return git_config_set_multivar_in_file(given_config_file,
 488                                                        argv[0], value, argv[2], 1);
 489         }
 490         else if (actions == ACTION_GET) {
 491                 check_argc(argc, 1, 2);
 492                 return get_value(argv[0], argv[1]);
 493         }
 494         else if (actions == ACTION_GET_ALL) {
 495                 do_all = 1;
 496                 check_argc(argc, 1, 2);
 497                 return get_value(argv[0], argv[1]);
 498         }
 499         else if (actions == ACTION_GET_REGEXP) {
 500                 show_keys = 1;
 501                 use_key_regexp = 1;
 502                 do_all = 1;
 503                 check_argc(argc, 1, 2);
 504                 return get_value(argv[0], argv[1]);
 505         }
 506         else if (actions == ACTION_UNSET) {
 507                 check_argc(argc, 1, 2);
 508                 if (argc == 2)
 509                         return git_config_set_multivar_in_file(given_config_file,
 510                                                                argv[0], NULL, argv[1], 0);
 511                 else
 512                         return git_config_set_in_file(given_config_file,
 513                                                       argv[0], NULL);
 514         }
 515         else if (actions == ACTION_UNSET_ALL) {
 516                 check_argc(argc, 1, 2);
 517                 return git_config_set_multivar_in_file(given_config_file,
 518                                                        argv[0], NULL, argv[1], 1);
 519         }
 520         else if (actions == ACTION_RENAME_SECTION) {
 521                 int ret;
 522                 check_argc(argc, 2, 2);
 523                 ret = git_config_rename_section_in_file(given_config_file,
 524                                                         argv[0], argv[1]);
 525                 if (ret < 0)
 526                         return ret;
 527                 if (ret == 0)
 528                         die("No such section!");
 529         }
 530         else if (actions == ACTION_REMOVE_SECTION) {
 531                 int ret;
 532                 check_argc(argc, 1, 1);
 533                 ret = git_config_rename_section_in_file(given_config_file,
 534                                                         argv[0], NULL);
 535                 if (ret < 0)
 536                         return ret;
 537                 if (ret == 0)
 538                         die("No such section!");
 539         }
 540         else if (actions == ACTION_GET_COLOR) {
 541                 get_color(argv[0]);
 542         }
 543         else if (actions == ACTION_GET_COLORBOOL) {
 544                 if (argc == 1)
 545                         color_stdout_is_tty = git_config_bool("command line", argv[0]);
 546                 return get_colorbool(argc != 0);
 547         }
 548
 549         return 0;
 550 }
 551
 552 int cmd_repo_config(int argc, const char **argv, const char *prefix)
 553 {
 554         fprintf(stderr, "WARNING: git repo-config is deprecated in favor of git config.\n");
 555         return cmd_config(argc, argv, prefix);
 556 }