Merge branch 'ye/doc-http-proto' into maint
[git.git] / builtin / config.c
blob5677c942b6936f3332b1b4ed12541f45c4228dfb
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 use_key_regexp;
17 static int do_all;
18 static int do_not_match;
19 static char delim = '=';
20 static char key_delim = ' ';
21 static char term = '\n';
23 static int use_global_config, use_system_config, use_local_config;
24 static struct git_config_source given_config_source;
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;
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 #define ACTION_GET_URLMATCH (1<<15)
47 #define TYPE_BOOL (1<<0)
48 #define TYPE_INT (1<<1)
49 #define TYPE_BOOL_OR_INT (1<<2)
50 #define TYPE_PATH (1<<3)
52 static struct option builtin_config_options[] = {
53 OPT_GROUP(N_("Config file location")),
54 OPT_BOOL(0, "global", &use_global_config, N_("use global config file")),
55 OPT_BOOL(0, "system", &use_system_config, N_("use system config file")),
56 OPT_BOOL(0, "local", &use_local_config, N_("use repository config file")),
57 OPT_STRING('f', "file", &given_config_source.file, N_("file"), N_("use given config file")),
58 OPT_STRING(0, "blob", &given_config_source.blob, N_("blob-id"), N_("read config from given blob object")),
59 OPT_GROUP(N_("Action")),
60 OPT_BIT(0, "get", &actions, N_("get value: name [value-regex]"), ACTION_GET),
61 OPT_BIT(0, "get-all", &actions, N_("get all values: key [value-regex]"), ACTION_GET_ALL),
62 OPT_BIT(0, "get-regexp", &actions, N_("get values for regexp: name-regex [value-regex]"), ACTION_GET_REGEXP),
63 OPT_BIT(0, "get-urlmatch", &actions, N_("get value specific for the URL: section[.var] URL"), ACTION_GET_URLMATCH),
64 OPT_BIT(0, "replace-all", &actions, N_("replace all matching variables: name value [value_regex]"), ACTION_REPLACE_ALL),
65 OPT_BIT(0, "add", &actions, N_("add a new variable: name value"), ACTION_ADD),
66 OPT_BIT(0, "unset", &actions, N_("remove a variable: name [value-regex]"), ACTION_UNSET),
67 OPT_BIT(0, "unset-all", &actions, N_("remove all matches: name [value-regex]"), ACTION_UNSET_ALL),
68 OPT_BIT(0, "rename-section", &actions, N_("rename section: old-name new-name"), ACTION_RENAME_SECTION),
69 OPT_BIT(0, "remove-section", &actions, N_("remove a section: name"), ACTION_REMOVE_SECTION),
70 OPT_BIT('l', "list", &actions, N_("list all"), ACTION_LIST),
71 OPT_BIT('e', "edit", &actions, N_("open an editor"), ACTION_EDIT),
72 OPT_STRING(0, "get-color", &get_color_slot, N_("slot"), N_("find the color configured: [default]")),
73 OPT_STRING(0, "get-colorbool", &get_colorbool_slot, N_("slot"), N_("find the color setting: [stdout-is-tty]")),
74 OPT_GROUP(N_("Type")),
75 OPT_BIT(0, "bool", &types, N_("value is \"true\" or \"false\""), TYPE_BOOL),
76 OPT_BIT(0, "int", &types, N_("value is decimal number"), TYPE_INT),
77 OPT_BIT(0, "bool-or-int", &types, N_("value is --bool or --int"), TYPE_BOOL_OR_INT),
78 OPT_BIT(0, "path", &types, N_("value is a path (file or directory name)"), TYPE_PATH),
79 OPT_GROUP(N_("Other")),
80 OPT_BOOL('z', "null", &end_null, N_("terminate values with NUL byte")),
81 OPT_BOOL(0, "includes", &respect_includes, N_("respect include directives on lookup")),
82 OPT_END(),
85 static void check_argc(int argc, int min, int max) {
86 if (argc >= min && argc <= max)
87 return;
88 error("wrong number of arguments");
89 usage_with_options(builtin_config_usage, builtin_config_options);
92 static int show_all_config(const char *key_, const char *value_, void *cb)
94 if (value_)
95 printf("%s%c%s%c", key_, delim, value_, term);
96 else
97 printf("%s%c", key_, term);
98 return 0;
101 struct strbuf_list {
102 struct strbuf *items;
103 int nr;
104 int alloc;
107 static int format_config(struct strbuf *buf, const char *key_, const char *value_)
109 int must_free_vptr = 0;
110 int must_print_delim = 0;
111 char value[256];
112 const char *vptr = value;
114 strbuf_init(buf, 0);
116 if (show_keys) {
117 strbuf_addstr(buf, key_);
118 must_print_delim = 1;
120 if (types == TYPE_INT)
121 sprintf(value, "%"PRId64,
122 git_config_int64(key_, value_ ? value_ : ""));
123 else if (types == TYPE_BOOL)
124 vptr = git_config_bool(key_, value_) ? "true" : "false";
125 else if (types == TYPE_BOOL_OR_INT) {
126 int is_bool, v;
127 v = git_config_bool_or_int(key_, value_, &is_bool);
128 if (is_bool)
129 vptr = v ? "true" : "false";
130 else
131 sprintf(value, "%d", v);
132 } else if (types == TYPE_PATH) {
133 if (git_config_pathname(&vptr, key_, value_) < 0)
134 return -1;
135 must_free_vptr = 1;
136 } else if (value_) {
137 vptr = value_;
138 } else {
139 /* Just show the key name */
140 vptr = "";
141 must_print_delim = 0;
144 if (must_print_delim)
145 strbuf_addch(buf, key_delim);
146 strbuf_addstr(buf, vptr);
147 strbuf_addch(buf, term);
149 if (must_free_vptr)
150 free((char *)vptr);
151 return 0;
154 static int collect_config(const char *key_, const char *value_, void *cb)
156 struct strbuf_list *values = cb;
158 if (!use_key_regexp && strcmp(key_, key))
159 return 0;
160 if (use_key_regexp && regexec(key_regexp, key_, 0, NULL, 0))
161 return 0;
162 if (regexp != NULL &&
163 (do_not_match ^ !!regexec(regexp, (value_?value_:""), 0, NULL, 0)))
164 return 0;
166 ALLOC_GROW(values->items, values->nr + 1, values->alloc);
168 return format_config(&values->items[values->nr++], key_, value_);
171 static int get_value(const char *key_, const char *regex_)
173 int ret = CONFIG_GENERIC_ERROR;
174 struct strbuf_list values = {NULL};
175 int i;
177 if (use_key_regexp) {
178 char *tl;
181 * NEEDSWORK: this naive pattern lowercasing obviously does not
182 * work for more complex patterns like "^[^.]*Foo.*bar".
183 * Perhaps we should deprecate this altogether someday.
186 key = xstrdup(key_);
187 for (tl = key + strlen(key) - 1;
188 tl >= key && *tl != '.';
189 tl--)
190 *tl = tolower(*tl);
191 for (tl = key; *tl && *tl != '.'; tl++)
192 *tl = tolower(*tl);
194 key_regexp = (regex_t*)xmalloc(sizeof(regex_t));
195 if (regcomp(key_regexp, key, REG_EXTENDED)) {
196 fprintf(stderr, "Invalid key pattern: %s\n", key_);
197 free(key_regexp);
198 key_regexp = NULL;
199 ret = CONFIG_INVALID_PATTERN;
200 goto free_strings;
202 } else {
203 if (git_config_parse_key(key_, &key, NULL)) {
204 ret = CONFIG_INVALID_KEY;
205 goto free_strings;
209 if (regex_) {
210 if (regex_[0] == '!') {
211 do_not_match = 1;
212 regex_++;
215 regexp = (regex_t*)xmalloc(sizeof(regex_t));
216 if (regcomp(regexp, regex_, REG_EXTENDED)) {
217 fprintf(stderr, "Invalid pattern: %s\n", regex_);
218 free(regexp);
219 regexp = NULL;
220 ret = CONFIG_INVALID_PATTERN;
221 goto free_strings;
225 git_config_with_options(collect_config, &values,
226 &given_config_source, respect_includes);
228 ret = !values.nr;
230 for (i = 0; i < values.nr; i++) {
231 struct strbuf *buf = values.items + i;
232 if (do_all || i == values.nr - 1)
233 fwrite(buf->buf, 1, buf->len, stdout);
234 strbuf_release(buf);
236 free(values.items);
238 free_strings:
239 free(key);
240 if (key_regexp) {
241 regfree(key_regexp);
242 free(key_regexp);
244 if (regexp) {
245 regfree(regexp);
246 free(regexp);
249 return ret;
252 static char *normalize_value(const char *key, const char *value)
254 char *normalized;
256 if (!value)
257 return NULL;
259 if (types == 0 || types == TYPE_PATH)
261 * We don't do normalization for TYPE_PATH here: If
262 * the path is like ~/foobar/, we prefer to store
263 * "~/foobar/" in the config file, and to expand the ~
264 * when retrieving the value.
266 normalized = xstrdup(value);
267 else {
268 normalized = xmalloc(64);
269 if (types == TYPE_INT) {
270 int64_t v = git_config_int64(key, value);
271 sprintf(normalized, "%"PRId64, v);
273 else if (types == TYPE_BOOL)
274 sprintf(normalized, "%s",
275 git_config_bool(key, value) ? "true" : "false");
276 else if (types == TYPE_BOOL_OR_INT) {
277 int is_bool, v;
278 v = git_config_bool_or_int(key, value, &is_bool);
279 if (!is_bool)
280 sprintf(normalized, "%d", v);
281 else
282 sprintf(normalized, "%s", v ? "true" : "false");
286 return normalized;
289 static int get_color_found;
290 static const char *get_color_slot;
291 static const char *get_colorbool_slot;
292 static char parsed_color[COLOR_MAXLEN];
294 static int git_get_color_config(const char *var, const char *value, void *cb)
296 if (!strcmp(var, get_color_slot)) {
297 if (!value)
298 config_error_nonbool(var);
299 color_parse(value, var, parsed_color);
300 get_color_found = 1;
302 return 0;
305 static void get_color(const char *def_color)
307 get_color_found = 0;
308 parsed_color[0] = '\0';
309 git_config_with_options(git_get_color_config, NULL,
310 &given_config_source, respect_includes);
312 if (!get_color_found && def_color)
313 color_parse(def_color, "command line", parsed_color);
315 fputs(parsed_color, stdout);
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)
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;
333 static int get_colorbool(int print)
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_source, respect_includes);
341 if (get_colorbool_found < 0) {
342 if (!strcmp(get_colorbool_slot, "color.diff"))
343 get_colorbool_found = get_diff_color_found;
344 if (get_colorbool_found < 0)
345 get_colorbool_found = get_color_ui_found;
348 if (get_colorbool_found < 0)
349 /* default value if none found in config */
350 get_colorbool_found = GIT_COLOR_AUTO;
352 get_colorbool_found = want_color(get_colorbool_found);
354 if (print) {
355 printf("%s\n", get_colorbool_found ? "true" : "false");
356 return 0;
357 } else
358 return get_colorbool_found ? 0 : 1;
361 static void check_write(void)
363 if (given_config_source.use_stdin)
364 die("writing to stdin is not supported");
366 if (given_config_source.blob)
367 die("writing config blobs is not supported");
370 struct urlmatch_current_candidate_value {
371 char value_is_null;
372 struct strbuf value;
375 static int urlmatch_collect_fn(const char *var, const char *value, void *cb)
377 struct string_list *values = cb;
378 struct string_list_item *item = string_list_insert(values, var);
379 struct urlmatch_current_candidate_value *matched = item->util;
381 if (!matched) {
382 matched = xmalloc(sizeof(*matched));
383 strbuf_init(&matched->value, 0);
384 item->util = matched;
385 } else {
386 strbuf_reset(&matched->value);
389 if (value) {
390 strbuf_addstr(&matched->value, value);
391 matched->value_is_null = 0;
392 } else {
393 matched->value_is_null = 1;
395 return 0;
398 static char *dup_downcase(const char *string)
400 char *result;
401 size_t len, i;
403 len = strlen(string);
404 result = xmalloc(len + 1);
405 for (i = 0; i < len; i++)
406 result[i] = tolower(string[i]);
407 result[i] = '\0';
408 return result;
411 static int get_urlmatch(const char *var, const char *url)
413 char *section_tail;
414 struct string_list_item *item;
415 struct urlmatch_config config = { STRING_LIST_INIT_DUP };
416 struct string_list values = STRING_LIST_INIT_DUP;
418 config.collect_fn = urlmatch_collect_fn;
419 config.cascade_fn = NULL;
420 config.cb = &values;
422 if (!url_normalize(url, &config.url))
423 die("%s", config.url.err);
425 config.section = dup_downcase(var);
426 section_tail = strchr(config.section, '.');
427 if (section_tail) {
428 *section_tail = '\0';
429 config.key = section_tail + 1;
430 show_keys = 0;
431 } else {
432 config.key = NULL;
433 show_keys = 1;
436 git_config_with_options(urlmatch_config_entry, &config,
437 &given_config_source, respect_includes);
439 for_each_string_list_item(item, &values) {
440 struct urlmatch_current_candidate_value *matched = item->util;
441 struct strbuf key = STRBUF_INIT;
442 struct strbuf buf = STRBUF_INIT;
444 strbuf_addstr(&key, item->string);
445 format_config(&buf, key.buf,
446 matched->value_is_null ? NULL : matched->value.buf);
447 fwrite(buf.buf, 1, buf.len, stdout);
448 strbuf_release(&key);
449 strbuf_release(&buf);
451 strbuf_release(&matched->value);
453 string_list_clear(&config.vars, 1);
454 string_list_clear(&values, 1);
455 free(config.url.url);
457 free((void *)config.section);
458 return 0;
461 int cmd_config(int argc, const char **argv, const char *prefix)
463 int nongit = !startup_info->have_repository;
464 char *value;
466 given_config_source.file = getenv(CONFIG_ENVIRONMENT);
468 argc = parse_options(argc, argv, prefix, builtin_config_options,
469 builtin_config_usage,
470 PARSE_OPT_STOP_AT_NON_OPTION);
472 if (use_global_config + use_system_config + use_local_config +
473 !!given_config_source.file + !!given_config_source.blob > 1) {
474 error("only one config file at a time.");
475 usage_with_options(builtin_config_usage, builtin_config_options);
478 if (given_config_source.file &&
479 !strcmp(given_config_source.file, "-")) {
480 given_config_source.file = NULL;
481 given_config_source.use_stdin = 1;
484 if (use_global_config) {
485 char *user_config = NULL;
486 char *xdg_config = NULL;
488 home_config_paths(&user_config, &xdg_config, "config");
490 if (!user_config)
492 * It is unknown if HOME/.gitconfig exists, so
493 * we do not know if we should write to XDG
494 * location; error out even if XDG_CONFIG_HOME
495 * is set and points at a sane location.
497 die("$HOME not set");
499 if (access_or_warn(user_config, R_OK, 0) &&
500 xdg_config && !access_or_warn(xdg_config, R_OK, 0))
501 given_config_source.file = xdg_config;
502 else
503 given_config_source.file = user_config;
505 else if (use_system_config)
506 given_config_source.file = git_etc_gitconfig();
507 else if (use_local_config)
508 given_config_source.file = git_pathdup("config");
509 else if (given_config_source.file) {
510 if (!is_absolute_path(given_config_source.file) && prefix)
511 given_config_source.file =
512 xstrdup(prefix_filename(prefix,
513 strlen(prefix),
514 given_config_source.file));
517 if (respect_includes == -1)
518 respect_includes = !given_config_source.file;
520 if (end_null) {
521 term = '\0';
522 delim = '\n';
523 key_delim = '\n';
526 if (HAS_MULTI_BITS(types)) {
527 error("only one type at a time.");
528 usage_with_options(builtin_config_usage, builtin_config_options);
531 if (get_color_slot)
532 actions |= ACTION_GET_COLOR;
533 if (get_colorbool_slot)
534 actions |= ACTION_GET_COLORBOOL;
536 if ((get_color_slot || get_colorbool_slot) && types) {
537 error("--get-color and variable type are incoherent");
538 usage_with_options(builtin_config_usage, builtin_config_options);
541 if (HAS_MULTI_BITS(actions)) {
542 error("only one action at a time.");
543 usage_with_options(builtin_config_usage, builtin_config_options);
545 if (actions == 0)
546 switch (argc) {
547 case 1: actions = ACTION_GET; break;
548 case 2: actions = ACTION_SET; break;
549 case 3: actions = ACTION_SET_ALL; break;
550 default:
551 usage_with_options(builtin_config_usage, builtin_config_options);
554 if (actions == ACTION_LIST) {
555 check_argc(argc, 0, 0);
556 if (git_config_with_options(show_all_config, NULL,
557 &given_config_source,
558 respect_includes) < 0) {
559 if (given_config_source.file)
560 die_errno("unable to read config file '%s'",
561 given_config_source.file);
562 else
563 die("error processing config file(s)");
566 else if (actions == ACTION_EDIT) {
567 check_argc(argc, 0, 0);
568 if (!given_config_source.file && nongit)
569 die("not in a git directory");
570 if (given_config_source.use_stdin)
571 die("editing stdin is not supported");
572 if (given_config_source.blob)
573 die("editing blobs is not supported");
574 git_config(git_default_config, NULL);
575 launch_editor(given_config_source.file ?
576 given_config_source.file : git_path("config"),
577 NULL, NULL);
579 else if (actions == ACTION_SET) {
580 int ret;
581 check_write();
582 check_argc(argc, 2, 2);
583 value = normalize_value(argv[0], argv[1]);
584 ret = git_config_set_in_file(given_config_source.file, argv[0], value);
585 if (ret == CONFIG_NOTHING_SET)
586 error("cannot overwrite multiple values with a single value\n"
587 " Use a regexp, --add or --replace-all to change %s.", argv[0]);
588 return ret;
590 else if (actions == ACTION_SET_ALL) {
591 check_write();
592 check_argc(argc, 2, 3);
593 value = normalize_value(argv[0], argv[1]);
594 return git_config_set_multivar_in_file(given_config_source.file,
595 argv[0], value, argv[2], 0);
597 else if (actions == ACTION_ADD) {
598 check_write();
599 check_argc(argc, 2, 2);
600 value = normalize_value(argv[0], argv[1]);
601 return git_config_set_multivar_in_file(given_config_source.file,
602 argv[0], value, "^$", 0);
604 else if (actions == ACTION_REPLACE_ALL) {
605 check_write();
606 check_argc(argc, 2, 3);
607 value = normalize_value(argv[0], argv[1]);
608 return git_config_set_multivar_in_file(given_config_source.file,
609 argv[0], value, argv[2], 1);
611 else if (actions == ACTION_GET) {
612 check_argc(argc, 1, 2);
613 return get_value(argv[0], argv[1]);
615 else if (actions == ACTION_GET_ALL) {
616 do_all = 1;
617 check_argc(argc, 1, 2);
618 return get_value(argv[0], argv[1]);
620 else if (actions == ACTION_GET_REGEXP) {
621 show_keys = 1;
622 use_key_regexp = 1;
623 do_all = 1;
624 check_argc(argc, 1, 2);
625 return get_value(argv[0], argv[1]);
627 else if (actions == ACTION_GET_URLMATCH) {
628 check_argc(argc, 2, 2);
629 return get_urlmatch(argv[0], argv[1]);
631 else if (actions == ACTION_UNSET) {
632 check_write();
633 check_argc(argc, 1, 2);
634 if (argc == 2)
635 return git_config_set_multivar_in_file(given_config_source.file,
636 argv[0], NULL, argv[1], 0);
637 else
638 return git_config_set_in_file(given_config_source.file,
639 argv[0], NULL);
641 else if (actions == ACTION_UNSET_ALL) {
642 check_write();
643 check_argc(argc, 1, 2);
644 return git_config_set_multivar_in_file(given_config_source.file,
645 argv[0], NULL, argv[1], 1);
647 else if (actions == ACTION_RENAME_SECTION) {
648 int ret;
649 check_write();
650 check_argc(argc, 2, 2);
651 ret = git_config_rename_section_in_file(given_config_source.file,
652 argv[0], argv[1]);
653 if (ret < 0)
654 return ret;
655 if (ret == 0)
656 die("No such section!");
658 else if (actions == ACTION_REMOVE_SECTION) {
659 int ret;
660 check_write();
661 check_argc(argc, 1, 1);
662 ret = git_config_rename_section_in_file(given_config_source.file,
663 argv[0], NULL);
664 if (ret < 0)
665 return ret;
666 if (ret == 0)
667 die("No such section!");
669 else if (actions == ACTION_GET_COLOR) {
670 get_color(argv[0]);
672 else if (actions == ACTION_GET_COLORBOOL) {
673 if (argc == 1)
674 color_stdout_is_tty = git_config_bool("command line", argv[0]);
675 return get_colorbool(argc != 0);
678 return 0;