4 #include "parse-options.h"
8 static const char *const builtin_config_usage[] = {
9 N_("git config [<options>]"),
14 static regex_t *key_regexp;
15 static regex_t *regexp;
17 static int omit_values;
18 static int use_key_regexp;
20 static int do_not_match;
21 static char delim = '=';
22 static char key_delim = ' ';
23 static char term = '\n';
25 static int use_global_config, use_system_config, use_local_config;
26 static struct git_config_source given_config_source;
27 static int actions, types;
29 static int respect_includes_opt = -1;
30 static struct config_options config_options;
31 static int show_origin;
33 #define ACTION_GET (1<<0)
34 #define ACTION_GET_ALL (1<<1)
35 #define ACTION_GET_REGEXP (1<<2)
36 #define ACTION_REPLACE_ALL (1<<3)
37 #define ACTION_ADD (1<<4)
38 #define ACTION_UNSET (1<<5)
39 #define ACTION_UNSET_ALL (1<<6)
40 #define ACTION_RENAME_SECTION (1<<7)
41 #define ACTION_REMOVE_SECTION (1<<8)
42 #define ACTION_LIST (1<<9)
43 #define ACTION_EDIT (1<<10)
44 #define ACTION_SET (1<<11)
45 #define ACTION_SET_ALL (1<<12)
46 #define ACTION_GET_COLOR (1<<13)
47 #define ACTION_GET_COLORBOOL (1<<14)
48 #define ACTION_GET_URLMATCH (1<<15)
50 #define TYPE_BOOL (1<<0)
51 #define TYPE_INT (1<<1)
52 #define TYPE_BOOL_OR_INT (1<<2)
53 #define TYPE_PATH (1<<3)
55 static struct option builtin_config_options[] = {
56 OPT_GROUP(N_("Config file location")),
57 OPT_BOOL(0, "global", &use_global_config, N_("use global config file")),
58 OPT_BOOL(0, "system", &use_system_config, N_("use system config file")),
59 OPT_BOOL(0, "local", &use_local_config, N_("use repository config file")),
60 OPT_STRING('f', "file", &given_config_source.file, N_("file"), N_("use given config file")),
61 OPT_STRING(0, "blob", &given_config_source.blob, N_("blob-id"), N_("read config from given blob object")),
62 OPT_GROUP(N_("Action")),
63 OPT_BIT(0, "get", &actions, N_("get value: name [value-regex]"), ACTION_GET),
64 OPT_BIT(0, "get-all", &actions, N_("get all values: key [value-regex]"), ACTION_GET_ALL),
65 OPT_BIT(0, "get-regexp", &actions, N_("get values for regexp: name-regex [value-regex]"), ACTION_GET_REGEXP),
66 OPT_BIT(0, "get-urlmatch", &actions, N_("get value specific for the URL: section[.var] URL"), ACTION_GET_URLMATCH),
67 OPT_BIT(0, "replace-all", &actions, N_("replace all matching variables: name value [value_regex]"), ACTION_REPLACE_ALL),
68 OPT_BIT(0, "add", &actions, N_("add a new variable: name value"), ACTION_ADD),
69 OPT_BIT(0, "unset", &actions, N_("remove a variable: name [value-regex]"), ACTION_UNSET),
70 OPT_BIT(0, "unset-all", &actions, N_("remove all matches: name [value-regex]"), ACTION_UNSET_ALL),
71 OPT_BIT(0, "rename-section", &actions, N_("rename section: old-name new-name"), ACTION_RENAME_SECTION),
72 OPT_BIT(0, "remove-section", &actions, N_("remove a section: name"), ACTION_REMOVE_SECTION),
73 OPT_BIT('l', "list", &actions, N_("list all"), ACTION_LIST),
74 OPT_BIT('e', "edit", &actions, N_("open an editor"), ACTION_EDIT),
75 OPT_BIT(0, "get-color", &actions, N_("find the color configured: slot [default]"), ACTION_GET_COLOR),
76 OPT_BIT(0, "get-colorbool", &actions, N_("find the color setting: slot [stdout-is-tty]"), ACTION_GET_COLORBOOL),
77 OPT_GROUP(N_("Type")),
78 OPT_BIT(0, "bool", &types, N_("value is \"true\" or \"false\""), TYPE_BOOL),
79 OPT_BIT(0, "int", &types, N_("value is decimal number"), TYPE_INT),
80 OPT_BIT(0, "bool-or-int", &types, N_("value is --bool or --int"), TYPE_BOOL_OR_INT),
81 OPT_BIT(0, "path", &types, N_("value is a path (file or directory name)"), TYPE_PATH),
82 OPT_GROUP(N_("Other")),
83 OPT_BOOL('z', "null", &end_null, N_("terminate values with NUL byte")),
84 OPT_BOOL(0, "name-only", &omit_values, N_("show variable names only")),
85 OPT_BOOL(0, "includes", &respect_includes_opt, N_("respect include directives on lookup")),
86 OPT_BOOL(0, "show-origin", &show_origin, N_("show origin of config (file, standard input, blob, command line)")),
90 static void check_argc(int argc, int min, int max) {
91 if (argc >= min && argc <= max)
93 error("wrong number of arguments");
94 usage_with_options(builtin_config_usage, builtin_config_options);
97 static void show_config_origin(struct strbuf *buf)
99 const char term = end_null ? '\0' : '\t';
101 strbuf_addstr(buf, current_config_origin_type());
102 strbuf_addch(buf, ':');
104 strbuf_addstr(buf, current_config_name());
106 quote_c_style(current_config_name(), buf, NULL, 0);
107 strbuf_addch(buf, term);
110 static int show_all_config(const char *key_, const char *value_, void *cb)
113 struct strbuf buf = STRBUF_INIT;
114 show_config_origin(&buf);
115 /* Use fwrite as "buf" can contain \0's if "end_null" is set. */
116 fwrite(buf.buf, 1, buf.len, stdout);
117 strbuf_release(&buf);
119 if (!omit_values && value_)
120 printf("%s%c%s%c", key_, delim, value_, term);
122 printf("%s%c", key_, term);
127 struct strbuf *items;
132 static int format_config(struct strbuf *buf, const char *key_, const char *value_)
135 show_config_origin(buf);
137 strbuf_addstr(buf, key_);
140 strbuf_addch(buf, key_delim);
142 if (types == TYPE_INT)
143 strbuf_addf(buf, "%"PRId64,
144 git_config_int64(key_, value_ ? value_ : ""));
145 else if (types == TYPE_BOOL)
146 strbuf_addstr(buf, git_config_bool(key_, value_) ?
148 else if (types == TYPE_BOOL_OR_INT) {
150 v = git_config_bool_or_int(key_, value_, &is_bool);
152 strbuf_addstr(buf, v ? "true" : "false");
154 strbuf_addf(buf, "%d", v);
155 } else if (types == TYPE_PATH) {
157 if (git_config_pathname(&v, key_, value_) < 0)
159 strbuf_addstr(buf, v);
162 strbuf_addstr(buf, value_);
164 /* Just show the key name; back out delimiter */
166 strbuf_setlen(buf, buf->len - 1);
169 strbuf_addch(buf, term);
173 static int collect_config(const char *key_, const char *value_, void *cb)
175 struct strbuf_list *values = cb;
177 if (!use_key_regexp && strcmp(key_, key))
179 if (use_key_regexp && regexec(key_regexp, key_, 0, NULL, 0))
181 if (regexp != NULL &&
182 (do_not_match ^ !!regexec(regexp, (value_?value_:""), 0, NULL, 0)))
185 ALLOC_GROW(values->items, values->nr + 1, values->alloc);
186 strbuf_init(&values->items[values->nr], 0);
188 return format_config(&values->items[values->nr++], key_, value_);
191 static int get_value(const char *key_, const char *regex_)
193 int ret = CONFIG_GENERIC_ERROR;
194 struct strbuf_list values = {NULL};
197 if (use_key_regexp) {
201 * NEEDSWORK: this naive pattern lowercasing obviously does not
202 * work for more complex patterns like "^[^.]*Foo.*bar".
203 * Perhaps we should deprecate this altogether someday.
207 for (tl = key + strlen(key) - 1;
208 tl >= key && *tl != '.';
211 for (tl = key; *tl && *tl != '.'; tl++)
214 key_regexp = (regex_t*)xmalloc(sizeof(regex_t));
215 if (regcomp(key_regexp, key, REG_EXTENDED)) {
216 error("invalid key pattern: %s", key_);
217 FREE_AND_NULL(key_regexp);
218 ret = CONFIG_INVALID_PATTERN;
222 if (git_config_parse_key(key_, &key, NULL)) {
223 ret = CONFIG_INVALID_KEY;
229 if (regex_[0] == '!') {
234 regexp = (regex_t*)xmalloc(sizeof(regex_t));
235 if (regcomp(regexp, regex_, REG_EXTENDED)) {
236 error("invalid pattern: %s", regex_);
237 FREE_AND_NULL(regexp);
238 ret = CONFIG_INVALID_PATTERN;
243 git_config_with_options(collect_config, &values,
244 &given_config_source, &config_options);
248 for (i = 0; i < values.nr; i++) {
249 struct strbuf *buf = values.items + i;
250 if (do_all || i == values.nr - 1)
251 fwrite(buf->buf, 1, buf->len, stdout);
270 static char *normalize_value(const char *key, const char *value)
275 if (types == 0 || types == TYPE_PATH)
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.
282 return xstrdup(value);
283 if (types == TYPE_INT)
284 return xstrfmt("%"PRId64, git_config_int64(key, value));
285 if (types == TYPE_BOOL)
286 return xstrdup(git_config_bool(key, value) ? "true" : "false");
287 if (types == TYPE_BOOL_OR_INT) {
289 v = git_config_bool_or_int(key, value, &is_bool);
291 return xstrfmt("%d", v);
293 return xstrdup(v ? "true" : "false");
296 die("BUG: cannot normalize type %d", types);
299 static int get_color_found;
300 static const char *get_color_slot;
301 static const char *get_colorbool_slot;
302 static char parsed_color[COLOR_MAXLEN];
304 static int git_get_color_config(const char *var, const char *value, void *cb)
306 if (!strcmp(var, get_color_slot)) {
308 config_error_nonbool(var);
309 if (color_parse(value, parsed_color) < 0)
316 static void get_color(const char *var, const char *def_color)
318 get_color_slot = var;
320 parsed_color[0] = '\0';
321 git_config_with_options(git_get_color_config, NULL,
322 &given_config_source, &config_options);
324 if (!get_color_found && def_color) {
325 if (color_parse(def_color, parsed_color) < 0)
326 die(_("unable to parse default color value"));
329 fputs(parsed_color, stdout);
332 static int get_colorbool_found;
333 static int get_diff_color_found;
334 static int get_color_ui_found;
335 static int git_get_colorbool_config(const char *var, const char *value,
338 if (!strcmp(var, get_colorbool_slot))
339 get_colorbool_found = git_config_colorbool(var, value);
340 else if (!strcmp(var, "diff.color"))
341 get_diff_color_found = git_config_colorbool(var, value);
342 else if (!strcmp(var, "color.ui"))
343 get_color_ui_found = git_config_colorbool(var, value);
347 static int get_colorbool(const char *var, int print)
349 get_colorbool_slot = var;
350 get_colorbool_found = -1;
351 get_diff_color_found = -1;
352 get_color_ui_found = -1;
353 git_config_with_options(git_get_colorbool_config, NULL,
354 &given_config_source, &config_options);
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;
363 if (get_colorbool_found < 0)
364 /* default value if none found in config */
365 get_colorbool_found = GIT_COLOR_AUTO;
367 get_colorbool_found = want_color(get_colorbool_found);
370 printf("%s\n", get_colorbool_found ? "true" : "false");
373 return get_colorbool_found ? 0 : 1;
376 static void check_write(void)
378 if (!given_config_source.file && !startup_info->have_repository)
379 die("not in a git directory");
381 if (given_config_source.use_stdin)
382 die("writing to stdin is not supported");
384 if (given_config_source.blob)
385 die("writing config blobs is not supported");
388 struct urlmatch_current_candidate_value {
393 static int urlmatch_collect_fn(const char *var, const char *value, void *cb)
395 struct string_list *values = cb;
396 struct string_list_item *item = string_list_insert(values, var);
397 struct urlmatch_current_candidate_value *matched = item->util;
400 matched = xmalloc(sizeof(*matched));
401 strbuf_init(&matched->value, 0);
402 item->util = matched;
404 strbuf_reset(&matched->value);
408 strbuf_addstr(&matched->value, value);
409 matched->value_is_null = 0;
411 matched->value_is_null = 1;
416 static int get_urlmatch(const char *var, const char *url)
420 struct string_list_item *item;
421 struct urlmatch_config config = { STRING_LIST_INIT_DUP };
422 struct string_list values = STRING_LIST_INIT_DUP;
424 config.collect_fn = urlmatch_collect_fn;
425 config.cascade_fn = NULL;
428 if (!url_normalize(url, &config.url))
429 die("%s", config.url.err);
431 config.section = xstrdup_tolower(var);
432 section_tail = strchr(config.section, '.');
434 *section_tail = '\0';
435 config.key = section_tail + 1;
442 git_config_with_options(urlmatch_config_entry, &config,
443 &given_config_source, &config_options);
447 for_each_string_list_item(item, &values) {
448 struct urlmatch_current_candidate_value *matched = item->util;
449 struct strbuf buf = STRBUF_INIT;
451 format_config(&buf, item->string,
452 matched->value_is_null ? NULL : matched->value.buf);
453 fwrite(buf.buf, 1, buf.len, stdout);
454 strbuf_release(&buf);
456 strbuf_release(&matched->value);
458 string_list_clear(&config.vars, 1);
459 string_list_clear(&values, 1);
460 free(config.url.url);
462 free((void *)config.section);
466 static char *default_user_config(void)
468 struct strbuf buf = STRBUF_INIT;
470 _("# This is Git's per-user configuration file.\n"
472 "# Please adapt and uncomment the following lines:\n"
475 ident_default_name(),
476 ident_default_email());
477 return strbuf_detach(&buf, NULL);
480 int cmd_config(int argc, const char **argv, const char *prefix)
482 int nongit = !startup_info->have_repository;
485 given_config_source.file = getenv(CONFIG_ENVIRONMENT);
487 argc = parse_options(argc, argv, prefix, builtin_config_options,
488 builtin_config_usage,
489 PARSE_OPT_STOP_AT_NON_OPTION);
491 if (use_global_config + use_system_config + use_local_config +
492 !!given_config_source.file + !!given_config_source.blob > 1) {
493 error("only one config file at a time.");
494 usage_with_options(builtin_config_usage, builtin_config_options);
497 if (use_local_config && nongit)
498 die(_("--local can only be used inside a git repository"));
500 if (given_config_source.file &&
501 !strcmp(given_config_source.file, "-")) {
502 given_config_source.file = NULL;
503 given_config_source.use_stdin = 1;
506 if (use_global_config) {
507 char *user_config = expand_user_path("~/.gitconfig", 0);
508 char *xdg_config = xdg_config_home("config");
512 * It is unknown if HOME/.gitconfig exists, so
513 * we do not know if we should write to XDG
514 * location; error out even if XDG_CONFIG_HOME
515 * is set and points at a sane location.
517 die("$HOME not set");
519 if (access_or_warn(user_config, R_OK, 0) &&
520 xdg_config && !access_or_warn(xdg_config, R_OK, 0))
521 given_config_source.file = xdg_config;
523 given_config_source.file = user_config;
525 else if (use_system_config)
526 given_config_source.file = git_etc_gitconfig();
527 else if (use_local_config)
528 given_config_source.file = git_pathdup("config");
529 else if (given_config_source.file) {
530 if (!is_absolute_path(given_config_source.file) && prefix)
531 given_config_source.file =
532 prefix_filename(prefix, given_config_source.file);
535 if (respect_includes_opt == -1)
536 config_options.respect_includes = !given_config_source.file;
538 config_options.respect_includes = respect_includes_opt;
546 if (HAS_MULTI_BITS(types)) {
547 error("only one type at a time.");
548 usage_with_options(builtin_config_usage, builtin_config_options);
551 if ((actions & (ACTION_GET_COLOR|ACTION_GET_COLORBOOL)) && types) {
552 error("--get-color and variable type are incoherent");
553 usage_with_options(builtin_config_usage, builtin_config_options);
556 if (HAS_MULTI_BITS(actions)) {
557 error("only one action at a time.");
558 usage_with_options(builtin_config_usage, builtin_config_options);
562 case 1: actions = ACTION_GET; break;
563 case 2: actions = ACTION_SET; break;
564 case 3: actions = ACTION_SET_ALL; break;
566 usage_with_options(builtin_config_usage, builtin_config_options);
569 !(actions == ACTION_LIST || actions == ACTION_GET_REGEXP)) {
570 error("--name-only is only applicable to --list or --get-regexp");
571 usage_with_options(builtin_config_usage, builtin_config_options);
574 if (show_origin && !(actions &
575 (ACTION_GET|ACTION_GET_ALL|ACTION_GET_REGEXP|ACTION_LIST))) {
576 error("--show-origin is only applicable to --get, --get-all, "
577 "--get-regexp, and --list.");
578 usage_with_options(builtin_config_usage, builtin_config_options);
581 if (actions == ACTION_LIST) {
582 check_argc(argc, 0, 0);
583 if (git_config_with_options(show_all_config, NULL,
584 &given_config_source,
585 &config_options) < 0) {
586 if (given_config_source.file)
587 die_errno("unable to read config file '%s'",
588 given_config_source.file);
590 die("error processing config file(s)");
593 else if (actions == ACTION_EDIT) {
596 check_argc(argc, 0, 0);
597 if (!given_config_source.file && nongit)
598 die("not in a git directory");
599 if (given_config_source.use_stdin)
600 die("editing stdin is not supported");
601 if (given_config_source.blob)
602 die("editing blobs is not supported");
603 git_config(git_default_config, NULL);
604 config_file = given_config_source.file ?
605 xstrdup(given_config_source.file) :
606 git_pathdup("config");
607 if (use_global_config) {
608 int fd = open(config_file, O_CREAT | O_EXCL | O_WRONLY, 0666);
610 char *content = default_user_config();
611 write_str_in_full(fd, content);
615 else if (errno != EEXIST)
616 die_errno(_("cannot create configuration file %s"), config_file);
618 launch_editor(config_file, NULL, NULL);
621 else if (actions == ACTION_SET) {
624 check_argc(argc, 2, 2);
625 value = normalize_value(argv[0], argv[1]);
626 ret = git_config_set_in_file_gently(given_config_source.file, argv[0], value);
627 if (ret == CONFIG_NOTHING_SET)
628 error(_("cannot overwrite multiple values with a single value\n"
629 " Use a regexp, --add or --replace-all to change %s."), argv[0]);
632 else if (actions == ACTION_SET_ALL) {
634 check_argc(argc, 2, 3);
635 value = normalize_value(argv[0], argv[1]);
636 return git_config_set_multivar_in_file_gently(given_config_source.file,
637 argv[0], value, argv[2], 0);
639 else if (actions == ACTION_ADD) {
641 check_argc(argc, 2, 2);
642 value = normalize_value(argv[0], argv[1]);
643 return git_config_set_multivar_in_file_gently(given_config_source.file,
645 CONFIG_REGEX_NONE, 0);
647 else if (actions == ACTION_REPLACE_ALL) {
649 check_argc(argc, 2, 3);
650 value = normalize_value(argv[0], argv[1]);
651 return git_config_set_multivar_in_file_gently(given_config_source.file,
652 argv[0], value, argv[2], 1);
654 else if (actions == ACTION_GET) {
655 check_argc(argc, 1, 2);
656 return get_value(argv[0], argv[1]);
658 else if (actions == ACTION_GET_ALL) {
660 check_argc(argc, 1, 2);
661 return get_value(argv[0], argv[1]);
663 else if (actions == ACTION_GET_REGEXP) {
667 check_argc(argc, 1, 2);
668 return get_value(argv[0], argv[1]);
670 else if (actions == ACTION_GET_URLMATCH) {
671 check_argc(argc, 2, 2);
672 return get_urlmatch(argv[0], argv[1]);
674 else if (actions == ACTION_UNSET) {
676 check_argc(argc, 1, 2);
678 return git_config_set_multivar_in_file_gently(given_config_source.file,
679 argv[0], NULL, argv[1], 0);
681 return git_config_set_in_file_gently(given_config_source.file,
684 else if (actions == ACTION_UNSET_ALL) {
686 check_argc(argc, 1, 2);
687 return git_config_set_multivar_in_file_gently(given_config_source.file,
688 argv[0], NULL, argv[1], 1);
690 else if (actions == ACTION_RENAME_SECTION) {
693 check_argc(argc, 2, 2);
694 ret = git_config_rename_section_in_file(given_config_source.file,
699 die("No such section!");
701 else if (actions == ACTION_REMOVE_SECTION) {
704 check_argc(argc, 1, 1);
705 ret = git_config_rename_section_in_file(given_config_source.file,
710 die("No such section!");
712 else if (actions == ACTION_GET_COLOR) {
713 check_argc(argc, 1, 2);
714 get_color(argv[0], argv[1]);
716 else if (actions == ACTION_GET_COLORBOOL) {
717 check_argc(argc, 1, 2);
719 color_stdout_is_tty = git_config_bool("command line", argv[1]);
720 return get_colorbool(argv[0], argc == 2);