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