git.spec.in: use README.md, not README
[git.git] / builtin / config.c
blobadc772786a7ddf9952aaccb7578b57d10396da93
1 #include "builtin.h"
2 #include "cache.h"
3 #include "color.h"
4 #include "parse-options.h"
5 #include "urlmatch.h"
7 static const char *const builtin_config_usage[] = {
8 N_("git config [<options>]"),
9 NULL
12 static char *key;
13 static regex_t *key_regexp;
14 static regex_t *regexp;
15 static int show_keys;
16 static int omit_values;
17 static int use_key_regexp;
18 static int do_all;
19 static int do_not_match;
20 static char delim = '=';
21 static char key_delim = ' ';
22 static char term = '\n';
24 static int use_global_config, use_system_config, use_local_config;
25 static struct git_config_source given_config_source;
26 static int actions, types;
27 static const char *get_color_slot, *get_colorbool_slot;
28 static int end_null;
29 static int respect_includes = -1;
31 #define ACTION_GET (1<<0)
32 #define ACTION_GET_ALL (1<<1)
33 #define ACTION_GET_REGEXP (1<<2)
34 #define ACTION_REPLACE_ALL (1<<3)
35 #define ACTION_ADD (1<<4)
36 #define ACTION_UNSET (1<<5)
37 #define ACTION_UNSET_ALL (1<<6)
38 #define ACTION_RENAME_SECTION (1<<7)
39 #define ACTION_REMOVE_SECTION (1<<8)
40 #define ACTION_LIST (1<<9)
41 #define ACTION_EDIT (1<<10)
42 #define ACTION_SET (1<<11)
43 #define ACTION_SET_ALL (1<<12)
44 #define ACTION_GET_COLOR (1<<13)
45 #define ACTION_GET_COLORBOOL (1<<14)
46 #define ACTION_GET_URLMATCH (1<<15)
48 #define TYPE_BOOL (1<<0)
49 #define TYPE_INT (1<<1)
50 #define TYPE_BOOL_OR_INT (1<<2)
51 #define TYPE_PATH (1<<3)
53 static struct option builtin_config_options[] = {
54 OPT_GROUP(N_("Config file location")),
55 OPT_BOOL(0, "global", &use_global_config, N_("use global config file")),
56 OPT_BOOL(0, "system", &use_system_config, N_("use system config file")),
57 OPT_BOOL(0, "local", &use_local_config, N_("use repository config file")),
58 OPT_STRING('f', "file", &given_config_source.file, N_("file"), N_("use given config file")),
59 OPT_STRING(0, "blob", &given_config_source.blob, N_("blob-id"), N_("read config from given blob object")),
60 OPT_GROUP(N_("Action")),
61 OPT_BIT(0, "get", &actions, N_("get value: name [value-regex]"), ACTION_GET),
62 OPT_BIT(0, "get-all", &actions, N_("get all values: key [value-regex]"), ACTION_GET_ALL),
63 OPT_BIT(0, "get-regexp", &actions, N_("get values for regexp: name-regex [value-regex]"), ACTION_GET_REGEXP),
64 OPT_BIT(0, "get-urlmatch", &actions, N_("get value specific for the URL: section[.var] URL"), ACTION_GET_URLMATCH),
65 OPT_BIT(0, "replace-all", &actions, N_("replace all matching variables: name value [value_regex]"), ACTION_REPLACE_ALL),
66 OPT_BIT(0, "add", &actions, N_("add a new variable: name value"), ACTION_ADD),
67 OPT_BIT(0, "unset", &actions, N_("remove a variable: name [value-regex]"), ACTION_UNSET),
68 OPT_BIT(0, "unset-all", &actions, N_("remove all matches: name [value-regex]"), ACTION_UNSET_ALL),
69 OPT_BIT(0, "rename-section", &actions, N_("rename section: old-name new-name"), ACTION_RENAME_SECTION),
70 OPT_BIT(0, "remove-section", &actions, N_("remove a section: name"), ACTION_REMOVE_SECTION),
71 OPT_BIT('l', "list", &actions, N_("list all"), ACTION_LIST),
72 OPT_BIT('e', "edit", &actions, N_("open an editor"), ACTION_EDIT),
73 OPT_BIT(0, "get-color", &actions, N_("find the color configured: slot [default]"), ACTION_GET_COLOR),
74 OPT_BIT(0, "get-colorbool", &actions, N_("find the color setting: slot [stdout-is-tty]"), ACTION_GET_COLORBOOL),
75 OPT_GROUP(N_("Type")),
76 OPT_BIT(0, "bool", &types, N_("value is \"true\" or \"false\""), TYPE_BOOL),
77 OPT_BIT(0, "int", &types, N_("value is decimal number"), TYPE_INT),
78 OPT_BIT(0, "bool-or-int", &types, N_("value is --bool or --int"), TYPE_BOOL_OR_INT),
79 OPT_BIT(0, "path", &types, N_("value is a path (file or directory name)"), TYPE_PATH),
80 OPT_GROUP(N_("Other")),
81 OPT_BOOL('z', "null", &end_null, N_("terminate values with NUL byte")),
82 OPT_BOOL(0, "name-only", &omit_values, N_("show variable names only")),
83 OPT_BOOL(0, "includes", &respect_includes, N_("respect include directives on lookup")),
84 OPT_END(),
87 static void check_argc(int argc, int min, int max) {
88 if (argc >= min && argc <= max)
89 return;
90 error("wrong number of arguments");
91 usage_with_options(builtin_config_usage, builtin_config_options);
94 static int show_all_config(const char *key_, const char *value_, void *cb)
96 if (!omit_values && value_)
97 printf("%s%c%s%c", key_, delim, value_, term);
98 else
99 printf("%s%c", key_, term);
100 return 0;
103 struct strbuf_list {
104 struct strbuf *items;
105 int nr;
106 int alloc;
109 static int format_config(struct strbuf *buf, const char *key_, const char *value_)
111 if (show_keys)
112 strbuf_addstr(buf, key_);
113 if (!omit_values) {
114 if (show_keys)
115 strbuf_addch(buf, key_delim);
117 if (types == TYPE_INT)
118 strbuf_addf(buf, "%"PRId64,
119 git_config_int64(key_, value_ ? value_ : ""));
120 else if (types == TYPE_BOOL)
121 strbuf_addstr(buf, git_config_bool(key_, value_) ?
122 "true" : "false");
123 else if (types == TYPE_BOOL_OR_INT) {
124 int is_bool, v;
125 v = git_config_bool_or_int(key_, value_, &is_bool);
126 if (is_bool)
127 strbuf_addstr(buf, v ? "true" : "false");
128 else
129 strbuf_addf(buf, "%d", v);
130 } else if (types == TYPE_PATH) {
131 const char *v;
132 if (git_config_pathname(&v, key_, value_) < 0)
133 return -1;
134 strbuf_addstr(buf, v);
135 free((char *)v);
136 } else if (value_) {
137 strbuf_addstr(buf, value_);
138 } else {
139 /* Just show the key name; back out delimiter */
140 if (show_keys)
141 strbuf_setlen(buf, buf->len - 1);
144 strbuf_addch(buf, term);
145 return 0;
148 static int collect_config(const char *key_, const char *value_, void *cb)
150 struct strbuf_list *values = cb;
152 if (!use_key_regexp && strcmp(key_, key))
153 return 0;
154 if (use_key_regexp && regexec(key_regexp, key_, 0, NULL, 0))
155 return 0;
156 if (regexp != NULL &&
157 (do_not_match ^ !!regexec(regexp, (value_?value_:""), 0, NULL, 0)))
158 return 0;
160 ALLOC_GROW(values->items, values->nr + 1, values->alloc);
161 strbuf_init(&values->items[values->nr], 0);
163 return format_config(&values->items[values->nr++], key_, value_);
166 static int get_value(const char *key_, const char *regex_)
168 int ret = CONFIG_GENERIC_ERROR;
169 struct strbuf_list values = {NULL};
170 int i;
172 if (use_key_regexp) {
173 char *tl;
176 * NEEDSWORK: this naive pattern lowercasing obviously does not
177 * work for more complex patterns like "^[^.]*Foo.*bar".
178 * Perhaps we should deprecate this altogether someday.
181 key = xstrdup(key_);
182 for (tl = key + strlen(key) - 1;
183 tl >= key && *tl != '.';
184 tl--)
185 *tl = tolower(*tl);
186 for (tl = key; *tl && *tl != '.'; tl++)
187 *tl = tolower(*tl);
189 key_regexp = (regex_t*)xmalloc(sizeof(regex_t));
190 if (regcomp(key_regexp, key, REG_EXTENDED)) {
191 error("invalid key pattern: %s", key_);
192 free(key_regexp);
193 key_regexp = NULL;
194 ret = CONFIG_INVALID_PATTERN;
195 goto free_strings;
197 } else {
198 if (git_config_parse_key(key_, &key, NULL)) {
199 ret = CONFIG_INVALID_KEY;
200 goto free_strings;
204 if (regex_) {
205 if (regex_[0] == '!') {
206 do_not_match = 1;
207 regex_++;
210 regexp = (regex_t*)xmalloc(sizeof(regex_t));
211 if (regcomp(regexp, regex_, REG_EXTENDED)) {
212 error("invalid pattern: %s", regex_);
213 free(regexp);
214 regexp = NULL;
215 ret = CONFIG_INVALID_PATTERN;
216 goto free_strings;
220 git_config_with_options(collect_config, &values,
221 &given_config_source, respect_includes);
223 ret = !values.nr;
225 for (i = 0; i < values.nr; i++) {
226 struct strbuf *buf = values.items + i;
227 if (do_all || i == values.nr - 1)
228 fwrite(buf->buf, 1, buf->len, stdout);
229 strbuf_release(buf);
231 free(values.items);
233 free_strings:
234 free(key);
235 if (key_regexp) {
236 regfree(key_regexp);
237 free(key_regexp);
239 if (regexp) {
240 regfree(regexp);
241 free(regexp);
244 return ret;
247 static char *normalize_value(const char *key, const char *value)
249 if (!value)
250 return NULL;
252 if (types == 0 || types == TYPE_PATH)
254 * We don't do normalization for TYPE_PATH here: If
255 * the path is like ~/foobar/, we prefer to store
256 * "~/foobar/" in the config file, and to expand the ~
257 * when retrieving the value.
259 return xstrdup(value);
260 if (types == TYPE_INT)
261 return xstrfmt("%"PRId64, git_config_int64(key, value));
262 if (types == TYPE_BOOL)
263 return xstrdup(git_config_bool(key, value) ? "true" : "false");
264 if (types == TYPE_BOOL_OR_INT) {
265 int is_bool, v;
266 v = git_config_bool_or_int(key, value, &is_bool);
267 if (!is_bool)
268 return xstrfmt("%d", v);
269 else
270 return xstrdup(v ? "true" : "false");
273 die("BUG: cannot normalize type %d", types);
276 static int get_color_found;
277 static const char *get_color_slot;
278 static const char *get_colorbool_slot;
279 static char parsed_color[COLOR_MAXLEN];
281 static int git_get_color_config(const char *var, const char *value, void *cb)
283 if (!strcmp(var, get_color_slot)) {
284 if (!value)
285 config_error_nonbool(var);
286 if (color_parse(value, parsed_color) < 0)
287 return -1;
288 get_color_found = 1;
290 return 0;
293 static void get_color(const char *var, const char *def_color)
295 get_color_slot = var;
296 get_color_found = 0;
297 parsed_color[0] = '\0';
298 git_config_with_options(git_get_color_config, NULL,
299 &given_config_source, respect_includes);
301 if (!get_color_found && def_color) {
302 if (color_parse(def_color, parsed_color) < 0)
303 die(_("unable to parse default color value"));
306 fputs(parsed_color, stdout);
309 static int get_colorbool_found;
310 static int get_diff_color_found;
311 static int get_color_ui_found;
312 static int git_get_colorbool_config(const char *var, const char *value,
313 void *cb)
315 if (!strcmp(var, get_colorbool_slot))
316 get_colorbool_found = git_config_colorbool(var, value);
317 else if (!strcmp(var, "diff.color"))
318 get_diff_color_found = git_config_colorbool(var, value);
319 else if (!strcmp(var, "color.ui"))
320 get_color_ui_found = git_config_colorbool(var, value);
321 return 0;
324 static int get_colorbool(const char *var, int print)
326 get_colorbool_slot = var;
327 get_colorbool_found = -1;
328 get_diff_color_found = -1;
329 get_color_ui_found = -1;
330 git_config_with_options(git_get_colorbool_config, NULL,
331 &given_config_source, respect_includes);
333 if (get_colorbool_found < 0) {
334 if (!strcmp(get_colorbool_slot, "color.diff"))
335 get_colorbool_found = get_diff_color_found;
336 if (get_colorbool_found < 0)
337 get_colorbool_found = get_color_ui_found;
340 if (get_colorbool_found < 0)
341 /* default value if none found in config */
342 get_colorbool_found = GIT_COLOR_AUTO;
344 get_colorbool_found = want_color(get_colorbool_found);
346 if (print) {
347 printf("%s\n", get_colorbool_found ? "true" : "false");
348 return 0;
349 } else
350 return get_colorbool_found ? 0 : 1;
353 static void check_write(void)
355 if (given_config_source.use_stdin)
356 die("writing to stdin is not supported");
358 if (given_config_source.blob)
359 die("writing config blobs is not supported");
362 struct urlmatch_current_candidate_value {
363 char value_is_null;
364 struct strbuf value;
367 static int urlmatch_collect_fn(const char *var, const char *value, void *cb)
369 struct string_list *values = cb;
370 struct string_list_item *item = string_list_insert(values, var);
371 struct urlmatch_current_candidate_value *matched = item->util;
373 if (!matched) {
374 matched = xmalloc(sizeof(*matched));
375 strbuf_init(&matched->value, 0);
376 item->util = matched;
377 } else {
378 strbuf_reset(&matched->value);
381 if (value) {
382 strbuf_addstr(&matched->value, value);
383 matched->value_is_null = 0;
384 } else {
385 matched->value_is_null = 1;
387 return 0;
390 static int get_urlmatch(const char *var, const char *url)
392 char *section_tail;
393 struct string_list_item *item;
394 struct urlmatch_config config = { STRING_LIST_INIT_DUP };
395 struct string_list values = STRING_LIST_INIT_DUP;
397 config.collect_fn = urlmatch_collect_fn;
398 config.cascade_fn = NULL;
399 config.cb = &values;
401 if (!url_normalize(url, &config.url))
402 die("%s", config.url.err);
404 config.section = xstrdup_tolower(var);
405 section_tail = strchr(config.section, '.');
406 if (section_tail) {
407 *section_tail = '\0';
408 config.key = section_tail + 1;
409 show_keys = 0;
410 } else {
411 config.key = NULL;
412 show_keys = 1;
415 git_config_with_options(urlmatch_config_entry, &config,
416 &given_config_source, respect_includes);
418 for_each_string_list_item(item, &values) {
419 struct urlmatch_current_candidate_value *matched = item->util;
420 struct strbuf buf = STRBUF_INIT;
422 format_config(&buf, item->string,
423 matched->value_is_null ? NULL : matched->value.buf);
424 fwrite(buf.buf, 1, buf.len, stdout);
425 strbuf_release(&buf);
427 strbuf_release(&matched->value);
429 string_list_clear(&config.vars, 1);
430 string_list_clear(&values, 1);
431 free(config.url.url);
433 free((void *)config.section);
434 return 0;
437 static char *default_user_config(void)
439 struct strbuf buf = STRBUF_INIT;
440 strbuf_addf(&buf,
441 _("# This is Git's per-user configuration file.\n"
442 "[user]\n"
443 "# Please adapt and uncomment the following lines:\n"
444 "# name = %s\n"
445 "# email = %s\n"),
446 ident_default_name(),
447 ident_default_email());
448 return strbuf_detach(&buf, NULL);
451 int cmd_config(int argc, const char **argv, const char *prefix)
453 int nongit = !startup_info->have_repository;
454 char *value;
456 given_config_source.file = getenv(CONFIG_ENVIRONMENT);
458 argc = parse_options(argc, argv, prefix, builtin_config_options,
459 builtin_config_usage,
460 PARSE_OPT_STOP_AT_NON_OPTION);
462 if (use_global_config + use_system_config + use_local_config +
463 !!given_config_source.file + !!given_config_source.blob > 1) {
464 error("only one config file at a time.");
465 usage_with_options(builtin_config_usage, builtin_config_options);
468 if (given_config_source.file &&
469 !strcmp(given_config_source.file, "-")) {
470 given_config_source.file = NULL;
471 given_config_source.use_stdin = 1;
474 if (use_global_config) {
475 char *user_config = expand_user_path("~/.gitconfig");
476 char *xdg_config = xdg_config_home("config");
478 if (!user_config)
480 * It is unknown if HOME/.gitconfig exists, so
481 * we do not know if we should write to XDG
482 * location; error out even if XDG_CONFIG_HOME
483 * is set and points at a sane location.
485 die("$HOME not set");
487 if (access_or_warn(user_config, R_OK, 0) &&
488 xdg_config && !access_or_warn(xdg_config, R_OK, 0))
489 given_config_source.file = xdg_config;
490 else
491 given_config_source.file = user_config;
493 else if (use_system_config)
494 given_config_source.file = git_etc_gitconfig();
495 else if (use_local_config)
496 given_config_source.file = git_pathdup("config");
497 else if (given_config_source.file) {
498 if (!is_absolute_path(given_config_source.file) && prefix)
499 given_config_source.file =
500 xstrdup(prefix_filename(prefix,
501 strlen(prefix),
502 given_config_source.file));
505 if (respect_includes == -1)
506 respect_includes = !given_config_source.file;
508 if (end_null) {
509 term = '\0';
510 delim = '\n';
511 key_delim = '\n';
514 if (HAS_MULTI_BITS(types)) {
515 error("only one type at a time.");
516 usage_with_options(builtin_config_usage, builtin_config_options);
519 if ((actions & (ACTION_GET_COLOR|ACTION_GET_COLORBOOL)) && types) {
520 error("--get-color and variable type are incoherent");
521 usage_with_options(builtin_config_usage, builtin_config_options);
524 if (HAS_MULTI_BITS(actions)) {
525 error("only one action at a time.");
526 usage_with_options(builtin_config_usage, builtin_config_options);
528 if (actions == 0)
529 switch (argc) {
530 case 1: actions = ACTION_GET; break;
531 case 2: actions = ACTION_SET; break;
532 case 3: actions = ACTION_SET_ALL; break;
533 default:
534 usage_with_options(builtin_config_usage, builtin_config_options);
536 if (omit_values &&
537 !(actions == ACTION_LIST || actions == ACTION_GET_REGEXP)) {
538 error("--name-only is only applicable to --list or --get-regexp");
539 usage_with_options(builtin_config_usage, builtin_config_options);
541 if (actions == ACTION_LIST) {
542 check_argc(argc, 0, 0);
543 if (git_config_with_options(show_all_config, NULL,
544 &given_config_source,
545 respect_includes) < 0) {
546 if (given_config_source.file)
547 die_errno("unable to read config file '%s'",
548 given_config_source.file);
549 else
550 die("error processing config file(s)");
553 else if (actions == ACTION_EDIT) {
554 char *config_file;
556 check_argc(argc, 0, 0);
557 if (!given_config_source.file && nongit)
558 die("not in a git directory");
559 if (given_config_source.use_stdin)
560 die("editing stdin is not supported");
561 if (given_config_source.blob)
562 die("editing blobs is not supported");
563 git_config(git_default_config, NULL);
564 config_file = xstrdup(given_config_source.file ?
565 given_config_source.file : git_path("config"));
566 if (use_global_config) {
567 int fd = open(config_file, O_CREAT | O_EXCL | O_WRONLY, 0666);
568 if (fd) {
569 char *content = default_user_config();
570 write_str_in_full(fd, content);
571 free(content);
572 close(fd);
574 else if (errno != EEXIST)
575 die_errno(_("cannot create configuration file %s"), config_file);
577 launch_editor(config_file, NULL, NULL);
578 free(config_file);
580 else if (actions == ACTION_SET) {
581 int ret;
582 check_write();
583 check_argc(argc, 2, 2);
584 value = normalize_value(argv[0], argv[1]);
585 ret = git_config_set_in_file(given_config_source.file, argv[0], value);
586 if (ret == CONFIG_NOTHING_SET)
587 error("cannot overwrite multiple values with a single value\n"
588 " Use a regexp, --add or --replace-all to change %s.", argv[0]);
589 return ret;
591 else if (actions == ACTION_SET_ALL) {
592 check_write();
593 check_argc(argc, 2, 3);
594 value = normalize_value(argv[0], argv[1]);
595 return git_config_set_multivar_in_file(given_config_source.file,
596 argv[0], value, argv[2], 0);
598 else if (actions == ACTION_ADD) {
599 check_write();
600 check_argc(argc, 2, 2);
601 value = normalize_value(argv[0], argv[1]);
602 return git_config_set_multivar_in_file(given_config_source.file,
603 argv[0], value,
604 CONFIG_REGEX_NONE, 0);
606 else if (actions == ACTION_REPLACE_ALL) {
607 check_write();
608 check_argc(argc, 2, 3);
609 value = normalize_value(argv[0], argv[1]);
610 return git_config_set_multivar_in_file(given_config_source.file,
611 argv[0], value, argv[2], 1);
613 else if (actions == ACTION_GET) {
614 check_argc(argc, 1, 2);
615 return get_value(argv[0], argv[1]);
617 else if (actions == ACTION_GET_ALL) {
618 do_all = 1;
619 check_argc(argc, 1, 2);
620 return get_value(argv[0], argv[1]);
622 else if (actions == ACTION_GET_REGEXP) {
623 show_keys = 1;
624 use_key_regexp = 1;
625 do_all = 1;
626 check_argc(argc, 1, 2);
627 return get_value(argv[0], argv[1]);
629 else if (actions == ACTION_GET_URLMATCH) {
630 check_argc(argc, 2, 2);
631 return get_urlmatch(argv[0], argv[1]);
633 else if (actions == ACTION_UNSET) {
634 check_write();
635 check_argc(argc, 1, 2);
636 if (argc == 2)
637 return git_config_set_multivar_in_file(given_config_source.file,
638 argv[0], NULL, argv[1], 0);
639 else
640 return git_config_set_in_file(given_config_source.file,
641 argv[0], NULL);
643 else if (actions == ACTION_UNSET_ALL) {
644 check_write();
645 check_argc(argc, 1, 2);
646 return git_config_set_multivar_in_file(given_config_source.file,
647 argv[0], NULL, argv[1], 1);
649 else if (actions == ACTION_RENAME_SECTION) {
650 int ret;
651 check_write();
652 check_argc(argc, 2, 2);
653 ret = git_config_rename_section_in_file(given_config_source.file,
654 argv[0], argv[1]);
655 if (ret < 0)
656 return ret;
657 if (ret == 0)
658 die("No such section!");
660 else if (actions == ACTION_REMOVE_SECTION) {
661 int ret;
662 check_write();
663 check_argc(argc, 1, 1);
664 ret = git_config_rename_section_in_file(given_config_source.file,
665 argv[0], NULL);
666 if (ret < 0)
667 return ret;
668 if (ret == 0)
669 die("No such section!");
671 else if (actions == ACTION_GET_COLOR) {
672 check_argc(argc, 1, 2);
673 get_color(argv[0], argv[1]);
675 else if (actions == ACTION_GET_COLORBOOL) {
676 check_argc(argc, 1, 2);
677 if (argc == 2)
678 color_stdout_is_tty = git_config_bool("command line", argv[1]);
679 return get_colorbool(argv[0], argc == 2);
682 return 0;