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, *xdg = 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                 local = repo_config = git_pathdup("config");
 173                 if (git_config_system())
 174                         system_wide = git_etc_gitconfig();
 175                 home_config_paths(&global, &xdg, "config");
 176         }
 177
 178         if (use_key_regexp) {
 179                 char *tl;
 180
 181                 /*
 182                  * NEEDSWORK: this naive pattern lowercasing obviously does not
 183                  * work for more complex patterns like "^[^.]*Foo.*bar".
 184                  * Perhaps we should deprecate this altogether someday.
 185                  */
 186
 187                 key = xstrdup(key_);
 188                 for (tl = key + strlen(key) - 1;
 189                      tl >= key && *tl != '.';
 190                      tl--)
 191                         *tl = tolower(*tl);
 192                 for (tl = key; *tl && *tl != '.'; tl++)
 193                         *tl = tolower(*tl);
 194
 195                 key_regexp = (regex_t*)xmalloc(sizeof(regex_t));
 196                 if (regcomp(key_regexp, key, REG_EXTENDED)) {
 197                         fprintf(stderr, "Invalid key pattern: %s\n", key_);
 198                         free(key);
 199                         goto free_strings;
 200                 }
 201         } else {
 202                 if (git_config_parse_key(key_, &key, NULL))
 203                         goto free_strings;
 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                         goto free_strings;
 216                 }
 217         }
 218
 219         fn = show_config;
 220         data = NULL;
 221         if (respect_includes) {
 222                 inc.fn = fn;
 223                 inc.data = data;
 224                 fn = git_config_include;
 225                 data = &inc;
 226         }
 227
 228         if (do_all && system_wide)
 229                 git_config_from_file(fn, system_wide, data);
 230         if (do_all && xdg)
 231                 git_config_from_file(fn, xdg, 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 && xdg)
 242                 git_config_from_file(fn, xdg, data);
 243         if (!do_all && !seen && system_wide)
 244                 git_config_from_file(fn, system_wide, data);
 245
 246         free(key);
 247         if (regexp) {
 248                 regfree(regexp);
 249                 free(regexp);
 250         }
 251
 252         if (do_all)
 253                 ret = !seen;
 254         else
 255                 ret = (seen == 1) ? 0 : seen > 1 ? 2 : 1;
 256
 257 free_strings:
 258         free(repo_config);
 259         free(global);
 260         free(xdg);
 261         return ret;
 262 }
 263
 264 static char *normalize_value(const char *key, const char *value)
 265 {
 266         char *normalized;
 267
 268         if (!value)
 269                 return NULL;
 270
 271         if (types == 0 || types == TYPE_PATH)
 272                 /*
 273                  * We don't do normalization for TYPE_PATH here: If
 274                  * the path is like ~/foobar/, we prefer to store
 275                  * "~/foobar/" in the config file, and to expand the ~
 276                  * when retrieving the value.
 277                  */
 278                 normalized = xstrdup(value);
 279         else {
 280                 normalized = xmalloc(64);
 281                 if (types == TYPE_INT) {
 282                         int v = git_config_int(key, value);
 283                         sprintf(normalized, "%d", v);
 284                 }
 285                 else if (types == TYPE_BOOL)
 286                         sprintf(normalized, "%s",
 287                                 git_config_bool(key, value) ? "true" : "false");
 288                 else if (types == TYPE_BOOL_OR_INT) {
 289                         int is_bool, v;
 290                         v = git_config_bool_or_int(key, value, &is_bool);
 291                         if (!is_bool)
 292                                 sprintf(normalized, "%d", v);
 293                         else
 294                                 sprintf(normalized, "%s", v ? "true" : "false");
 295                 }
 296         }
 297
 298         return normalized;
 299 }
 300
 301 static int get_color_found;
 302 static const char *get_color_slot;
 303 static const char *get_colorbool_slot;
 304 static char parsed_color[COLOR_MAXLEN];
 305
 306 static int git_get_color_config(const char *var, const char *value, void *cb)
 307 {
 308         if (!strcmp(var, get_color_slot)) {
 309                 if (!value)
 310                         config_error_nonbool(var);
 311                 color_parse(value, var, parsed_color);
 312                 get_color_found = 1;
 313         }
 314         return 0;
 315 }
 316
 317 static void get_color(const char *def_color)
 318 {
 319         get_color_found = 0;
 320         parsed_color[0] = '\0';
 321         git_config_with_options(git_get_color_config, NULL,
 322                                 given_config_file, respect_includes);
 323
 324         if (!get_color_found && def_color)
 325                 color_parse(def_color, "command line", parsed_color);
 326
 327         fputs(parsed_color, stdout);
 328 }
 329
 330 static int get_colorbool_found;
 331 static int get_diff_color_found;
 332 static int get_color_ui_found;
 333 static int git_get_colorbool_config(const char *var, const char *value,
 334                 void *cb)
 335 {
 336         if (!strcmp(var, get_colorbool_slot))
 337                 get_colorbool_found = git_config_colorbool(var, value);
 338         else if (!strcmp(var, "diff.color"))
 339                 get_diff_color_found = git_config_colorbool(var, value);
 340         else if (!strcmp(var, "color.ui"))
 341                 get_color_ui_found = git_config_colorbool(var, value);
 342         return 0;
 343 }
 344
 345 static int get_colorbool(int print)
 346 {
 347         get_colorbool_found = -1;
 348         get_diff_color_found = -1;
 349         git_config_with_options(git_get_colorbool_config, NULL,
 350                                 given_config_file, respect_includes);
 351
 352         if (get_colorbool_found < 0) {
 353                 if (!strcmp(get_colorbool_slot, "color.diff"))
 354                         get_colorbool_found = get_diff_color_found;
 355                 if (get_colorbool_found < 0)
 356                         get_colorbool_found = get_color_ui_found;
 357         }
 358
 359         get_colorbool_found = want_color(get_colorbool_found);
 360
 361         if (print) {
 362                 printf("%s\n", get_colorbool_found ? "true" : "false");
 363                 return 0;
 364         } else
 365                 return get_colorbool_found ? 0 : 1;
 366 }
 367
 368 int cmd_config(int argc, const char **argv, const char *prefix)
 369 {
 370         int nongit = !startup_info->have_repository;
 371         char *value;
 372
 373         given_config_file = getenv(CONFIG_ENVIRONMENT);
 374
 375         argc = parse_options(argc, argv, prefix, builtin_config_options,
 376                              builtin_config_usage,
 377                              PARSE_OPT_STOP_AT_NON_OPTION);
 378
 379         if (use_global_config + use_system_config + use_local_config + !!given_config_file > 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(user_config, R_OK) &&
 400                     xdg_config && !access(xdg_config, R_OK))
 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                                             respect_includes) < 0) {
 459                         if (given_config_file)
 460                                 die_errno("unable to read config file '%s'",
 461                                           given_config_file);
 462                         else
 463                                 die("error processing config file(s)");
 464                 }
 465         }
 466         else if (actions == ACTION_EDIT) {
 467                 check_argc(argc, 0, 0);
 468                 if (!given_config_file && nongit)
 469                         die("not in a git directory");
 470                 git_config(git_default_config, NULL);
 471                 launch_editor(given_config_file ?
 472                               given_config_file : git_path("config"),
 473                               NULL, NULL);
 474         }
 475         else if (actions == ACTION_SET) {
 476                 int ret;
 477                 check_argc(argc, 2, 2);
 478                 value = normalize_value(argv[0], argv[1]);
 479                 ret = git_config_set_in_file(given_config_file, argv[0], value);
 480                 if (ret == CONFIG_NOTHING_SET)
 481                         error("cannot overwrite multiple values with a single value\n"
 482                         "       Use a regexp, --add or --replace-all to change %s.", argv[0]);
 483                 return ret;
 484         }
 485         else if (actions == ACTION_SET_ALL) {
 486                 check_argc(argc, 2, 3);
 487                 value = normalize_value(argv[0], argv[1]);
 488                 return git_config_set_multivar_in_file(given_config_file,
 489                                                        argv[0], value, argv[2], 0);
 490         }
 491         else if (actions == ACTION_ADD) {
 492                 check_argc(argc, 2, 2);
 493                 value = normalize_value(argv[0], argv[1]);
 494                 return git_config_set_multivar_in_file(given_config_file,
 495                                                        argv[0], value, "^$", 0);
 496         }
 497         else if (actions == ACTION_REPLACE_ALL) {
 498                 check_argc(argc, 2, 3);
 499                 value = normalize_value(argv[0], argv[1]);
 500                 return git_config_set_multivar_in_file(given_config_file,
 501                                                        argv[0], value, argv[2], 1);
 502         }
 503         else if (actions == ACTION_GET) {
 504                 check_argc(argc, 1, 2);
 505                 return get_value(argv[0], argv[1]);
 506         }
 507         else if (actions == ACTION_GET_ALL) {
 508                 do_all = 1;
 509                 check_argc(argc, 1, 2);
 510                 return get_value(argv[0], argv[1]);
 511         }
 512         else if (actions == ACTION_GET_REGEXP) {
 513                 show_keys = 1;
 514                 use_key_regexp = 1;
 515                 do_all = 1;
 516                 check_argc(argc, 1, 2);
 517                 return get_value(argv[0], argv[1]);
 518         }
 519         else if (actions == ACTION_UNSET) {
 520                 check_argc(argc, 1, 2);
 521                 if (argc == 2)
 522                         return git_config_set_multivar_in_file(given_config_file,
 523                                                                argv[0], NULL, argv[1], 0);
 524                 else
 525                         return git_config_set_in_file(given_config_file,
 526                                                       argv[0], NULL);
 527         }
 528         else if (actions == ACTION_UNSET_ALL) {
 529                 check_argc(argc, 1, 2);
 530                 return git_config_set_multivar_in_file(given_config_file,
 531                                                        argv[0], NULL, argv[1], 1);
 532         }
 533         else if (actions == ACTION_RENAME_SECTION) {
 534                 int ret;
 535                 check_argc(argc, 2, 2);
 536                 ret = git_config_rename_section_in_file(given_config_file,
 537                                                         argv[0], argv[1]);
 538                 if (ret < 0)
 539                         return ret;
 540                 if (ret == 0)
 541                         die("No such section!");
 542         }
 543         else if (actions == ACTION_REMOVE_SECTION) {
 544                 int ret;
 545                 check_argc(argc, 1, 1);
 546                 ret = git_config_rename_section_in_file(given_config_file,
 547                                                         argv[0], NULL);
 548                 if (ret < 0)
 549                         return ret;
 550                 if (ret == 0)
 551                         die("No such section!");
 552         }
 553         else if (actions == ACTION_GET_COLOR) {
 554                 get_color(argv[0]);
 555         }
 556         else if (actions == ACTION_GET_COLORBOOL) {
 557                 if (argc == 1)
 558                         color_stdout_is_tty = git_config_bool("command line", argv[0]);
 559                 return get_colorbool(argc != 0);
 560         }
 561
 562         return 0;
 563 }
 564
 565 int cmd_repo_config(int argc, const char **argv, const char *prefix)
 566 {
 567         fprintf(stderr, "WARNING: git repo-config is deprecated in favor of git config.\n");
 568         return cmd_config(argc, argv, prefix);
 569 }