5 #include "parse-options.h"
9 static const char *const builtin_config_usage[] = {
10 N_("git config [<options>]"),
15 static regex_t *key_regexp;
16 static regex_t *regexp;
18 static int omit_values;
19 static int use_key_regexp;
21 static int do_not_match;
22 static char delim = '=';
23 static char key_delim = ' ';
24 static char term = '\n';
26 static int use_global_config, use_system_config, use_local_config;
27 static struct git_config_source given_config_source;
28 static int actions, types;
30 static int respect_includes_opt = -1;
31 static struct config_options config_options;
32 static int show_origin;
34 #define ACTION_GET (1<<0)
35 #define ACTION_GET_ALL (1<<1)
36 #define ACTION_GET_REGEXP (1<<2)
37 #define ACTION_REPLACE_ALL (1<<3)
38 #define ACTION_ADD (1<<4)
39 #define ACTION_UNSET (1<<5)
40 #define ACTION_UNSET_ALL (1<<6)
41 #define ACTION_RENAME_SECTION (1<<7)
42 #define ACTION_REMOVE_SECTION (1<<8)
43 #define ACTION_LIST (1<<9)
44 #define ACTION_EDIT (1<<10)
45 #define ACTION_SET (1<<11)
46 #define ACTION_SET_ALL (1<<12)
47 #define ACTION_GET_COLOR (1<<13)
48 #define ACTION_GET_COLORBOOL (1<<14)
49 #define ACTION_GET_URLMATCH (1<<15)
51 #define TYPE_BOOL (1<<0)
52 #define TYPE_INT (1<<1)
53 #define TYPE_BOOL_OR_INT (1<<2)
54 #define TYPE_PATH (1<<3)
55 #define TYPE_EXPIRY_DATE (1<<4)
57 static struct option builtin_config_options[] = {
58 OPT_GROUP(N_("Config file location")),
59 OPT_BOOL(0, "global", &use_global_config, N_("use global config file")),
60 OPT_BOOL(0, "system", &use_system_config, N_("use system config file")),
61 OPT_BOOL(0, "local", &use_local_config, N_("use repository config file")),
62 OPT_STRING('f', "file", &given_config_source.file, N_("file"), N_("use given config file")),
63 OPT_STRING(0, "blob", &given_config_source.blob, N_("blob-id"), N_("read config from given blob object")),
64 OPT_GROUP(N_("Action")),
65 OPT_BIT(0, "get", &actions, N_("get value: name [value-regex]"), ACTION_GET),
66 OPT_BIT(0, "get-all", &actions, N_("get all values: key [value-regex]"), ACTION_GET_ALL),
67 OPT_BIT(0, "get-regexp", &actions, N_("get values for regexp: name-regex [value-regex]"), ACTION_GET_REGEXP),
68 OPT_BIT(0, "get-urlmatch", &actions, N_("get value specific for the URL: section[.var] URL"), ACTION_GET_URLMATCH),
69 OPT_BIT(0, "replace-all", &actions, N_("replace all matching variables: name value [value_regex]"), ACTION_REPLACE_ALL),
70 OPT_BIT(0, "add", &actions, N_("add a new variable: name value"), ACTION_ADD),
71 OPT_BIT(0, "unset", &actions, N_("remove a variable: name [value-regex]"), ACTION_UNSET),
72 OPT_BIT(0, "unset-all", &actions, N_("remove all matches: name [value-regex]"), ACTION_UNSET_ALL),
73 OPT_BIT(0, "rename-section", &actions, N_("rename section: old-name new-name"), ACTION_RENAME_SECTION),
74 OPT_BIT(0, "remove-section", &actions, N_("remove a section: name"), ACTION_REMOVE_SECTION),
75 OPT_BIT('l', "list", &actions, N_("list all"), ACTION_LIST),
76 OPT_BIT('e', "edit", &actions, N_("open an editor"), ACTION_EDIT),
77 OPT_BIT(0, "get-color", &actions, N_("find the color configured: slot [default]"), ACTION_GET_COLOR),
78 OPT_BIT(0, "get-colorbool", &actions, N_("find the color setting: slot [stdout-is-tty]"), ACTION_GET_COLORBOOL),
79 OPT_GROUP(N_("Type")),
80 OPT_BIT(0, "bool", &types, N_("value is \"true\" or \"false\""), TYPE_BOOL),
81 OPT_BIT(0, "int", &types, N_("value is decimal number"), TYPE_INT),
82 OPT_BIT(0, "bool-or-int", &types, N_("value is --bool or --int"), TYPE_BOOL_OR_INT),
83 OPT_BIT(0, "path", &types, N_("value is a path (file or directory name)"), TYPE_PATH),
84 OPT_BIT(0, "expiry-date", &types, N_("value is an expiry date"), TYPE_EXPIRY_DATE),
85 OPT_GROUP(N_("Other")),
86 OPT_BOOL('z', "null", &end_null, N_("terminate values with NUL byte")),
87 OPT_BOOL(0, "name-only", &omit_values, N_("show variable names only")),
88 OPT_BOOL(0, "includes", &respect_includes_opt, N_("respect include directives on lookup")),
89 OPT_BOOL(0, "show-origin", &show_origin, N_("show origin of config (file, standard input, blob, command line)")),
93 static void check_argc(int argc, int min, int max) {
94 if (argc >= min && argc <= max)
96 error("wrong number of arguments");
97 usage_with_options(builtin_config_usage, builtin_config_options);
100 static void show_config_origin(struct strbuf *buf)
102 const char term = end_null ? '\0' : '\t';
104 strbuf_addstr(buf, current_config_origin_type());
105 strbuf_addch(buf, ':');
107 strbuf_addstr(buf, current_config_name());
109 quote_c_style(current_config_name(), buf, NULL, 0);
110 strbuf_addch(buf, term);
113 static int show_all_config(const char *key_, const char *value_, void *cb)
116 struct strbuf buf = STRBUF_INIT;
117 show_config_origin(&buf);
118 /* Use fwrite as "buf" can contain \0's if "end_null" is set. */
119 fwrite(buf.buf, 1, buf.len, stdout);
120 strbuf_release(&buf);
122 if (!omit_values && value_)
123 printf("%s%c%s%c", key_, delim, value_, term);
125 printf("%s%c", key_, term);
130 struct strbuf *items;
135 static int format_config(struct strbuf *buf, const char *key_, const char *value_)
138 show_config_origin(buf);
140 strbuf_addstr(buf, key_);
143 strbuf_addch(buf, key_delim);
145 if (types == TYPE_INT)
146 strbuf_addf(buf, "%"PRId64,
147 git_config_int64(key_, value_ ? value_ : ""));
148 else if (types == TYPE_BOOL)
149 strbuf_addstr(buf, git_config_bool(key_, value_) ?
151 else if (types == TYPE_BOOL_OR_INT) {
153 v = git_config_bool_or_int(key_, value_, &is_bool);
155 strbuf_addstr(buf, v ? "true" : "false");
157 strbuf_addf(buf, "%d", v);
158 } else if (types == TYPE_PATH) {
160 if (git_config_pathname(&v, key_, value_) < 0)
162 strbuf_addstr(buf, v);
164 } else if (types == TYPE_EXPIRY_DATE) {
166 if (git_config_expiry_date(&t, key_, value_) < 0)
168 strbuf_addf(buf, "%"PRItime, t);
170 strbuf_addstr(buf, value_);
172 /* Just show the key name; back out delimiter */
174 strbuf_setlen(buf, buf->len - 1);
177 strbuf_addch(buf, term);
181 static int collect_config(const char *key_, const char *value_, void *cb)
183 struct strbuf_list *values = cb;
185 if (!use_key_regexp && strcmp(key_, key))
187 if (use_key_regexp && regexec(key_regexp, key_, 0, NULL, 0))
189 if (regexp != NULL &&
190 (do_not_match ^ !!regexec(regexp, (value_?value_:""), 0, NULL, 0)))
193 ALLOC_GROW(values->items, values->nr + 1, values->alloc);
194 strbuf_init(&values->items[values->nr], 0);
196 return format_config(&values->items[values->nr++], key_, value_);
199 static int get_value(const char *key_, const char *regex_)
201 int ret = CONFIG_GENERIC_ERROR;
202 struct strbuf_list values = {NULL};
205 if (use_key_regexp) {
209 * NEEDSWORK: this naive pattern lowercasing obviously does not
210 * work for more complex patterns like "^[^.]*Foo.*bar".
211 * Perhaps we should deprecate this altogether someday.
215 for (tl = key + strlen(key) - 1;
216 tl >= key && *tl != '.';
219 for (tl = key; *tl && *tl != '.'; tl++)
222 key_regexp = (regex_t*)xmalloc(sizeof(regex_t));
223 if (regcomp(key_regexp, key, REG_EXTENDED)) {
224 error("invalid key pattern: %s", key_);
225 FREE_AND_NULL(key_regexp);
226 ret = CONFIG_INVALID_PATTERN;
230 if (git_config_parse_key(key_, &key, NULL)) {
231 ret = CONFIG_INVALID_KEY;
237 if (regex_[0] == '!') {
242 regexp = (regex_t*)xmalloc(sizeof(regex_t));
243 if (regcomp(regexp, regex_, REG_EXTENDED)) {
244 error("invalid pattern: %s", regex_);
245 FREE_AND_NULL(regexp);
246 ret = CONFIG_INVALID_PATTERN;
251 config_with_options(collect_config, &values,
252 &given_config_source, &config_options);
256 for (i = 0; i < values.nr; i++) {
257 struct strbuf *buf = values.items + i;
258 if (do_all || i == values.nr - 1)
259 fwrite(buf->buf, 1, buf->len, stdout);
278 static char *normalize_value(const char *key, const char *value)
283 if (types == 0 || types == TYPE_PATH || types == TYPE_EXPIRY_DATE)
285 * We don't do normalization for TYPE_PATH here: If
286 * the path is like ~/foobar/, we prefer to store
287 * "~/foobar/" in the config file, and to expand the ~
288 * when retrieving the value.
289 * Also don't do normalization for expiry dates.
291 return xstrdup(value);
292 if (types == TYPE_INT)
293 return xstrfmt("%"PRId64, git_config_int64(key, value));
294 if (types == TYPE_BOOL)
295 return xstrdup(git_config_bool(key, value) ? "true" : "false");
296 if (types == TYPE_BOOL_OR_INT) {
298 v = git_config_bool_or_int(key, value, &is_bool);
300 return xstrfmt("%d", v);
302 return xstrdup(v ? "true" : "false");
305 die("BUG: cannot normalize type %d", types);
308 static int get_color_found;
309 static const char *get_color_slot;
310 static const char *get_colorbool_slot;
311 static char parsed_color[COLOR_MAXLEN];
313 static int git_get_color_config(const char *var, const char *value, void *cb)
315 if (!strcmp(var, get_color_slot)) {
317 config_error_nonbool(var);
318 if (color_parse(value, parsed_color) < 0)
325 static void get_color(const char *var, const char *def_color)
327 get_color_slot = var;
329 parsed_color[0] = '\0';
330 config_with_options(git_get_color_config, NULL,
331 &given_config_source, &config_options);
333 if (!get_color_found && def_color) {
334 if (color_parse(def_color, parsed_color) < 0)
335 die(_("unable to parse default color value"));
338 fputs(parsed_color, stdout);
341 static int get_colorbool_found;
342 static int get_diff_color_found;
343 static int get_color_ui_found;
344 static int git_get_colorbool_config(const char *var, const char *value,
347 if (!strcmp(var, get_colorbool_slot))
348 get_colorbool_found = git_config_colorbool(var, value);
349 else if (!strcmp(var, "diff.color"))
350 get_diff_color_found = git_config_colorbool(var, value);
351 else if (!strcmp(var, "color.ui"))
352 get_color_ui_found = git_config_colorbool(var, value);
356 static int get_colorbool(const char *var, int print)
358 get_colorbool_slot = var;
359 get_colorbool_found = -1;
360 get_diff_color_found = -1;
361 get_color_ui_found = -1;
362 config_with_options(git_get_colorbool_config, NULL,
363 &given_config_source, &config_options);
365 if (get_colorbool_found < 0) {
366 if (!strcmp(get_colorbool_slot, "color.diff"))
367 get_colorbool_found = get_diff_color_found;
368 if (get_colorbool_found < 0)
369 get_colorbool_found = get_color_ui_found;
372 if (get_colorbool_found < 0)
373 /* default value if none found in config */
374 get_colorbool_found = GIT_COLOR_AUTO;
376 get_colorbool_found = want_color(get_colorbool_found);
379 printf("%s\n", get_colorbool_found ? "true" : "false");
382 return get_colorbool_found ? 0 : 1;
385 static void check_write(void)
387 if (!given_config_source.file && !startup_info->have_repository)
388 die("not in a git directory");
390 if (given_config_source.use_stdin)
391 die("writing to stdin is not supported");
393 if (given_config_source.blob)
394 die("writing config blobs is not supported");
397 struct urlmatch_current_candidate_value {
402 static int urlmatch_collect_fn(const char *var, const char *value, void *cb)
404 struct string_list *values = cb;
405 struct string_list_item *item = string_list_insert(values, var);
406 struct urlmatch_current_candidate_value *matched = item->util;
409 matched = xmalloc(sizeof(*matched));
410 strbuf_init(&matched->value, 0);
411 item->util = matched;
413 strbuf_reset(&matched->value);
417 strbuf_addstr(&matched->value, value);
418 matched->value_is_null = 0;
420 matched->value_is_null = 1;
425 static int get_urlmatch(const char *var, const char *url)
429 struct string_list_item *item;
430 struct urlmatch_config config = { STRING_LIST_INIT_DUP };
431 struct string_list values = STRING_LIST_INIT_DUP;
433 config.collect_fn = urlmatch_collect_fn;
434 config.cascade_fn = NULL;
437 if (!url_normalize(url, &config.url))
438 die("%s", config.url.err);
440 config.section = xstrdup_tolower(var);
441 section_tail = strchr(config.section, '.');
443 *section_tail = '\0';
444 config.key = section_tail + 1;
451 config_with_options(urlmatch_config_entry, &config,
452 &given_config_source, &config_options);
456 for_each_string_list_item(item, &values) {
457 struct urlmatch_current_candidate_value *matched = item->util;
458 struct strbuf buf = STRBUF_INIT;
460 format_config(&buf, item->string,
461 matched->value_is_null ? NULL : matched->value.buf);
462 fwrite(buf.buf, 1, buf.len, stdout);
463 strbuf_release(&buf);
465 strbuf_release(&matched->value);
467 string_list_clear(&config.vars, 1);
468 string_list_clear(&values, 1);
469 free(config.url.url);
471 free((void *)config.section);
475 static char *default_user_config(void)
477 struct strbuf buf = STRBUF_INIT;
479 _("# This is Git's per-user configuration file.\n"
481 "# Please adapt and uncomment the following lines:\n"
484 ident_default_name(),
485 ident_default_email());
486 return strbuf_detach(&buf, NULL);
489 int cmd_config(int argc, const char **argv, const char *prefix)
491 int nongit = !startup_info->have_repository;
494 given_config_source.file = getenv(CONFIG_ENVIRONMENT);
496 argc = parse_options(argc, argv, prefix, builtin_config_options,
497 builtin_config_usage,
498 PARSE_OPT_STOP_AT_NON_OPTION);
500 if (use_global_config + use_system_config + use_local_config +
501 !!given_config_source.file + !!given_config_source.blob > 1) {
502 error("only one config file at a time.");
503 usage_with_options(builtin_config_usage, builtin_config_options);
506 if (use_local_config && nongit)
507 die(_("--local can only be used inside a git repository"));
509 if (given_config_source.file &&
510 !strcmp(given_config_source.file, "-")) {
511 given_config_source.file = NULL;
512 given_config_source.use_stdin = 1;
515 if (use_global_config) {
516 char *user_config = expand_user_path("~/.gitconfig", 0);
517 char *xdg_config = xdg_config_home("config");
521 * It is unknown if HOME/.gitconfig exists, so
522 * we do not know if we should write to XDG
523 * location; error out even if XDG_CONFIG_HOME
524 * is set and points at a sane location.
526 die("$HOME not set");
528 if (access_or_warn(user_config, R_OK, 0) &&
529 xdg_config && !access_or_warn(xdg_config, R_OK, 0)) {
530 given_config_source.file = xdg_config;
533 given_config_source.file = user_config;
537 else if (use_system_config)
538 given_config_source.file = git_etc_gitconfig();
539 else if (use_local_config)
540 given_config_source.file = git_pathdup("config");
541 else if (given_config_source.file) {
542 if (!is_absolute_path(given_config_source.file) && prefix)
543 given_config_source.file =
544 prefix_filename(prefix, given_config_source.file);
547 if (respect_includes_opt == -1)
548 config_options.respect_includes = !given_config_source.file;
550 config_options.respect_includes = respect_includes_opt;
552 config_options.commondir = get_git_common_dir();
553 config_options.git_dir = get_git_dir();
562 if (HAS_MULTI_BITS(types)) {
563 error("only one type at a time.");
564 usage_with_options(builtin_config_usage, builtin_config_options);
567 if ((actions & (ACTION_GET_COLOR|ACTION_GET_COLORBOOL)) && types) {
568 error("--get-color and variable type are incoherent");
569 usage_with_options(builtin_config_usage, builtin_config_options);
572 if (HAS_MULTI_BITS(actions)) {
573 error("only one action at a time.");
574 usage_with_options(builtin_config_usage, builtin_config_options);
578 case 1: actions = ACTION_GET; break;
579 case 2: actions = ACTION_SET; break;
580 case 3: actions = ACTION_SET_ALL; break;
582 usage_with_options(builtin_config_usage, builtin_config_options);
585 !(actions == ACTION_LIST || actions == ACTION_GET_REGEXP)) {
586 error("--name-only is only applicable to --list or --get-regexp");
587 usage_with_options(builtin_config_usage, builtin_config_options);
590 if (show_origin && !(actions &
591 (ACTION_GET|ACTION_GET_ALL|ACTION_GET_REGEXP|ACTION_LIST))) {
592 error("--show-origin is only applicable to --get, --get-all, "
593 "--get-regexp, and --list.");
594 usage_with_options(builtin_config_usage, builtin_config_options);
597 if (actions == ACTION_LIST) {
598 check_argc(argc, 0, 0);
599 if (config_with_options(show_all_config, NULL,
600 &given_config_source,
601 &config_options) < 0) {
602 if (given_config_source.file)
603 die_errno("unable to read config file '%s'",
604 given_config_source.file);
606 die("error processing config file(s)");
609 else if (actions == ACTION_EDIT) {
612 check_argc(argc, 0, 0);
613 if (!given_config_source.file && nongit)
614 die("not in a git directory");
615 if (given_config_source.use_stdin)
616 die("editing stdin is not supported");
617 if (given_config_source.blob)
618 die("editing blobs is not supported");
619 git_config(git_default_config, NULL);
620 config_file = given_config_source.file ?
621 xstrdup(given_config_source.file) :
622 git_pathdup("config");
623 if (use_global_config) {
624 int fd = open(config_file, O_CREAT | O_EXCL | O_WRONLY, 0666);
626 char *content = default_user_config();
627 write_str_in_full(fd, content);
631 else if (errno != EEXIST)
632 die_errno(_("cannot create configuration file %s"), config_file);
634 launch_editor(config_file, NULL, NULL);
637 else if (actions == ACTION_SET) {
640 check_argc(argc, 2, 2);
641 value = normalize_value(argv[0], argv[1]);
643 ret = git_config_set_in_file_gently(given_config_source.file, argv[0], value);
644 if (ret == CONFIG_NOTHING_SET)
645 error(_("cannot overwrite multiple values with a single value\n"
646 " Use a regexp, --add or --replace-all to change %s."), argv[0]);
649 else if (actions == ACTION_SET_ALL) {
651 check_argc(argc, 2, 3);
652 value = normalize_value(argv[0], argv[1]);
654 return git_config_set_multivar_in_file_gently(given_config_source.file,
655 argv[0], value, argv[2], 0);
657 else if (actions == ACTION_ADD) {
659 check_argc(argc, 2, 2);
660 value = normalize_value(argv[0], argv[1]);
662 return git_config_set_multivar_in_file_gently(given_config_source.file,
664 CONFIG_REGEX_NONE, 0);
666 else if (actions == ACTION_REPLACE_ALL) {
668 check_argc(argc, 2, 3);
669 value = normalize_value(argv[0], argv[1]);
671 return git_config_set_multivar_in_file_gently(given_config_source.file,
672 argv[0], value, argv[2], 1);
674 else if (actions == ACTION_GET) {
675 check_argc(argc, 1, 2);
676 return get_value(argv[0], argv[1]);
678 else if (actions == ACTION_GET_ALL) {
680 check_argc(argc, 1, 2);
681 return get_value(argv[0], argv[1]);
683 else if (actions == ACTION_GET_REGEXP) {
687 check_argc(argc, 1, 2);
688 return get_value(argv[0], argv[1]);
690 else if (actions == ACTION_GET_URLMATCH) {
691 check_argc(argc, 2, 2);
692 return get_urlmatch(argv[0], argv[1]);
694 else if (actions == ACTION_UNSET) {
696 check_argc(argc, 1, 2);
698 return git_config_set_multivar_in_file_gently(given_config_source.file,
699 argv[0], NULL, argv[1], 0);
701 return git_config_set_in_file_gently(given_config_source.file,
704 else if (actions == ACTION_UNSET_ALL) {
706 check_argc(argc, 1, 2);
707 return git_config_set_multivar_in_file_gently(given_config_source.file,
708 argv[0], NULL, argv[1], 1);
710 else if (actions == ACTION_RENAME_SECTION) {
713 check_argc(argc, 2, 2);
714 ret = git_config_rename_section_in_file(given_config_source.file,
719 die("No such section!");
721 else if (actions == ACTION_REMOVE_SECTION) {
724 check_argc(argc, 1, 1);
725 ret = git_config_rename_section_in_file(given_config_source.file,
730 die("No such section!");
732 else if (actions == ACTION_GET_COLOR) {
733 check_argc(argc, 1, 2);
734 get_color(argv[0], argv[1]);
736 else if (actions == ACTION_GET_COLORBOOL) {
737 check_argc(argc, 1, 2);
739 color_stdout_is_tty = git_config_bool("command line", argv[1]);
740 return get_colorbool(argv[0], argc == 2);