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