refs.c: spell NULL pointer as NULL
[git.git] / builtin / config.c
blob20e89fe4e0c7db50267e8e9358c38faea2259fab
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 const char *given_config_file;
25 static const char *given_config_blob;
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_file, N_("file"), N_("use given config file")),
59 OPT_STRING(0, "blob", &given_config_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_STRING(0, "get-color", &get_color_slot, N_("slot"), N_("find the color configured: [default]")),
74 OPT_STRING(0, "get-colorbool", &get_colorbool_slot, N_("slot"), N_("find the color setting: [stdout-is-tty]")),
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, "includes", &respect_includes, N_("respect include directives on lookup")),
83 OPT_END(),
86 static void check_argc(int argc, int min, int max) {
87 if (argc >= min && argc <= max)
88 return;
89 error("wrong number of arguments");
90 usage_with_options(builtin_config_usage, builtin_config_options);
93 static int show_all_config(const char *key_, const char *value_, void *cb)
95 if (value_)
96 printf("%s%c%s%c", key_, delim, value_, term);
97 else
98 printf("%s%c", key_, term);
99 return 0;
102 struct strbuf_list {
103 struct strbuf *items;
104 int nr;
105 int alloc;
108 static int format_config(struct strbuf *buf, const char *key_, const char *value_)
110 int must_free_vptr = 0;
111 int must_print_delim = 0;
112 char value[256];
113 const char *vptr = value;
115 strbuf_init(buf, 0);
117 if (show_keys) {
118 strbuf_addstr(buf, key_);
119 must_print_delim = 1;
121 if (types == TYPE_INT)
122 sprintf(value, "%"PRId64,
123 git_config_int64(key_, value_ ? value_ : ""));
124 else if (types == TYPE_BOOL)
125 vptr = git_config_bool(key_, value_) ? "true" : "false";
126 else if (types == TYPE_BOOL_OR_INT) {
127 int is_bool, v;
128 v = git_config_bool_or_int(key_, value_, &is_bool);
129 if (is_bool)
130 vptr = v ? "true" : "false";
131 else
132 sprintf(value, "%d", v);
133 } else if (types == TYPE_PATH) {
134 if (git_config_pathname(&vptr, key_, value_) < 0)
135 return -1;
136 must_free_vptr = 1;
137 } else if (value_) {
138 vptr = value_;
139 } else {
140 /* Just show the key name */
141 vptr = "";
142 must_print_delim = 0;
145 if (must_print_delim)
146 strbuf_addch(buf, key_delim);
147 strbuf_addstr(buf, vptr);
148 strbuf_addch(buf, term);
150 if (must_free_vptr)
151 free((char *)vptr);
152 return 0;
155 static int collect_config(const char *key_, const char *value_, void *cb)
157 struct strbuf_list *values = cb;
159 if (!use_key_regexp && strcmp(key_, key))
160 return 0;
161 if (use_key_regexp && regexec(key_regexp, key_, 0, NULL, 0))
162 return 0;
163 if (regexp != NULL &&
164 (do_not_match ^ !!regexec(regexp, (value_?value_:""), 0, NULL, 0)))
165 return 0;
167 ALLOC_GROW(values->items, values->nr + 1, values->alloc);
169 return format_config(&values->items[values->nr++], key_, value_);
172 static int get_value(const char *key_, const char *regex_)
174 int ret = CONFIG_GENERIC_ERROR;
175 struct strbuf_list values = {NULL};
176 int i;
178 if (use_key_regexp) {
179 char *tl;
182 * NEEDSWORK: this naive pattern lowercasing obviously does not
183 * work for more complex patterns like "^[^.]*Foo.*bar".
184 * Perhaps we should deprecate this altogether someday.
187 key = xstrdup(key_);
188 for (tl = key + strlen(key) - 1;
189 tl >= key && *tl != '.';
190 tl--)
191 *tl = tolower(*tl);
192 for (tl = key; *tl && *tl != '.'; tl++)
193 *tl = tolower(*tl);
195 key_regexp = (regex_t*)xmalloc(sizeof(regex_t));
196 if (regcomp(key_regexp, key, REG_EXTENDED)) {
197 fprintf(stderr, "Invalid key pattern: %s\n", key_);
198 free(key_regexp);
199 key_regexp = NULL;
200 ret = CONFIG_INVALID_PATTERN;
201 goto free_strings;
203 } else {
204 if (git_config_parse_key(key_, &key, NULL)) {
205 ret = CONFIG_INVALID_KEY;
206 goto free_strings;
210 if (regex_) {
211 if (regex_[0] == '!') {
212 do_not_match = 1;
213 regex_++;
216 regexp = (regex_t*)xmalloc(sizeof(regex_t));
217 if (regcomp(regexp, regex_, REG_EXTENDED)) {
218 fprintf(stderr, "Invalid pattern: %s\n", regex_);
219 free(regexp);
220 regexp = NULL;
221 ret = CONFIG_INVALID_PATTERN;
222 goto free_strings;
226 git_config_with_options(collect_config, &values,
227 given_config_file, given_config_blob,
228 respect_includes);
230 ret = !values.nr;
232 for (i = 0; i < values.nr; i++) {
233 struct strbuf *buf = values.items + i;
234 if (do_all || i == values.nr - 1)
235 fwrite(buf->buf, 1, buf->len, stdout);
236 strbuf_release(buf);
238 free(values.items);
240 free_strings:
241 free(key);
242 if (key_regexp) {
243 regfree(key_regexp);
244 free(key_regexp);
246 if (regexp) {
247 regfree(regexp);
248 free(regexp);
251 return ret;
254 static char *normalize_value(const char *key, const char *value)
256 char *normalized;
258 if (!value)
259 return NULL;
261 if (types == 0 || types == TYPE_PATH)
263 * We don't do normalization for TYPE_PATH here: If
264 * the path is like ~/foobar/, we prefer to store
265 * "~/foobar/" in the config file, and to expand the ~
266 * when retrieving the value.
268 normalized = xstrdup(value);
269 else {
270 normalized = xmalloc(64);
271 if (types == TYPE_INT) {
272 int64_t v = git_config_int64(key, value);
273 sprintf(normalized, "%"PRId64, v);
275 else if (types == TYPE_BOOL)
276 sprintf(normalized, "%s",
277 git_config_bool(key, value) ? "true" : "false");
278 else if (types == TYPE_BOOL_OR_INT) {
279 int is_bool, v;
280 v = git_config_bool_or_int(key, value, &is_bool);
281 if (!is_bool)
282 sprintf(normalized, "%d", v);
283 else
284 sprintf(normalized, "%s", v ? "true" : "false");
288 return normalized;
291 static int get_color_found;
292 static const char *get_color_slot;
293 static const char *get_colorbool_slot;
294 static char parsed_color[COLOR_MAXLEN];
296 static int git_get_color_config(const char *var, const char *value, void *cb)
298 if (!strcmp(var, get_color_slot)) {
299 if (!value)
300 config_error_nonbool(var);
301 color_parse(value, var, parsed_color);
302 get_color_found = 1;
304 return 0;
307 static void get_color(const char *def_color)
309 get_color_found = 0;
310 parsed_color[0] = '\0';
311 git_config_with_options(git_get_color_config, NULL,
312 given_config_file, given_config_blob,
313 respect_includes);
315 if (!get_color_found && def_color)
316 color_parse(def_color, "command line", parsed_color);
318 fputs(parsed_color, stdout);
321 static int get_colorbool_found;
322 static int get_diff_color_found;
323 static int get_color_ui_found;
324 static int git_get_colorbool_config(const char *var, const char *value,
325 void *cb)
327 if (!strcmp(var, get_colorbool_slot))
328 get_colorbool_found = git_config_colorbool(var, value);
329 else if (!strcmp(var, "diff.color"))
330 get_diff_color_found = git_config_colorbool(var, value);
331 else if (!strcmp(var, "color.ui"))
332 get_color_ui_found = git_config_colorbool(var, value);
333 return 0;
336 static int get_colorbool(int print)
338 get_colorbool_found = -1;
339 get_diff_color_found = -1;
340 get_color_ui_found = -1;
341 git_config_with_options(git_get_colorbool_config, NULL,
342 given_config_file, given_config_blob,
343 respect_includes);
345 if (get_colorbool_found < 0) {
346 if (!strcmp(get_colorbool_slot, "color.diff"))
347 get_colorbool_found = get_diff_color_found;
348 if (get_colorbool_found < 0)
349 get_colorbool_found = get_color_ui_found;
352 if (get_colorbool_found < 0)
353 /* default value if none found in config */
354 get_colorbool_found = GIT_COLOR_AUTO;
356 get_colorbool_found = want_color(get_colorbool_found);
358 if (print) {
359 printf("%s\n", get_colorbool_found ? "true" : "false");
360 return 0;
361 } else
362 return get_colorbool_found ? 0 : 1;
365 static void check_blob_write(void)
367 if (given_config_blob)
368 die("writing config blobs is not supported");
371 struct urlmatch_current_candidate_value {
372 char value_is_null;
373 struct strbuf value;
376 static int urlmatch_collect_fn(const char *var, const char *value, void *cb)
378 struct string_list *values = cb;
379 struct string_list_item *item = string_list_insert(values, var);
380 struct urlmatch_current_candidate_value *matched = item->util;
382 if (!matched) {
383 matched = xmalloc(sizeof(*matched));
384 strbuf_init(&matched->value, 0);
385 item->util = matched;
386 } else {
387 strbuf_reset(&matched->value);
390 if (value) {
391 strbuf_addstr(&matched->value, value);
392 matched->value_is_null = 0;
393 } else {
394 matched->value_is_null = 1;
396 return 0;
399 static char *dup_downcase(const char *string)
401 char *result;
402 size_t len, i;
404 len = strlen(string);
405 result = xmalloc(len + 1);
406 for (i = 0; i < len; i++)
407 result[i] = tolower(string[i]);
408 result[i] = '\0';
409 return result;
412 static int get_urlmatch(const char *var, const char *url)
414 char *section_tail;
415 struct string_list_item *item;
416 struct urlmatch_config config = { STRING_LIST_INIT_DUP };
417 struct string_list values = STRING_LIST_INIT_DUP;
419 config.collect_fn = urlmatch_collect_fn;
420 config.cascade_fn = NULL;
421 config.cb = &values;
423 if (!url_normalize(url, &config.url))
424 die("%s", config.url.err);
426 config.section = dup_downcase(var);
427 section_tail = strchr(config.section, '.');
428 if (section_tail) {
429 *section_tail = '\0';
430 config.key = section_tail + 1;
431 show_keys = 0;
432 } else {
433 config.key = NULL;
434 show_keys = 1;
437 git_config_with_options(urlmatch_config_entry, &config,
438 given_config_file, NULL, respect_includes);
440 for_each_string_list_item(item, &values) {
441 struct urlmatch_current_candidate_value *matched = item->util;
442 struct strbuf key = STRBUF_INIT;
443 struct strbuf buf = STRBUF_INIT;
445 strbuf_addstr(&key, item->string);
446 format_config(&buf, key.buf,
447 matched->value_is_null ? NULL : matched->value.buf);
448 fwrite(buf.buf, 1, buf.len, stdout);
449 strbuf_release(&key);
450 strbuf_release(&buf);
452 strbuf_release(&matched->value);
454 string_list_clear(&config.vars, 1);
455 string_list_clear(&values, 1);
456 free(config.url.url);
458 free((void *)config.section);
459 return 0;
462 int cmd_config(int argc, const char **argv, const char *prefix)
464 int nongit = !startup_info->have_repository;
465 char *value;
467 given_config_file = getenv(CONFIG_ENVIRONMENT);
469 argc = parse_options(argc, argv, prefix, builtin_config_options,
470 builtin_config_usage,
471 PARSE_OPT_STOP_AT_NON_OPTION);
473 if (use_global_config + use_system_config + use_local_config +
474 !!given_config_file + !!given_config_blob > 1) {
475 error("only one config file at a time.");
476 usage_with_options(builtin_config_usage, builtin_config_options);
479 if (use_global_config) {
480 char *user_config = NULL;
481 char *xdg_config = NULL;
483 home_config_paths(&user_config, &xdg_config, "config");
485 if (!user_config)
487 * It is unknown if HOME/.gitconfig exists, so
488 * we do not know if we should write to XDG
489 * location; error out even if XDG_CONFIG_HOME
490 * is set and points at a sane location.
492 die("$HOME not set");
494 if (access_or_warn(user_config, R_OK, 0) &&
495 xdg_config && !access_or_warn(xdg_config, R_OK, 0))
496 given_config_file = xdg_config;
497 else
498 given_config_file = user_config;
500 else if (use_system_config)
501 given_config_file = git_etc_gitconfig();
502 else if (use_local_config)
503 given_config_file = git_pathdup("config");
504 else if (given_config_file) {
505 if (!is_absolute_path(given_config_file) && prefix)
506 given_config_file =
507 xstrdup(prefix_filename(prefix,
508 strlen(prefix),
509 given_config_file));
512 if (respect_includes == -1)
513 respect_includes = !given_config_file;
515 if (end_null) {
516 term = '\0';
517 delim = '\n';
518 key_delim = '\n';
521 if (HAS_MULTI_BITS(types)) {
522 error("only one type at a time.");
523 usage_with_options(builtin_config_usage, builtin_config_options);
526 if (get_color_slot)
527 actions |= ACTION_GET_COLOR;
528 if (get_colorbool_slot)
529 actions |= ACTION_GET_COLORBOOL;
531 if ((get_color_slot || get_colorbool_slot) && types) {
532 error("--get-color and variable type are incoherent");
533 usage_with_options(builtin_config_usage, builtin_config_options);
536 if (HAS_MULTI_BITS(actions)) {
537 error("only one action at a time.");
538 usage_with_options(builtin_config_usage, builtin_config_options);
540 if (actions == 0)
541 switch (argc) {
542 case 1: actions = ACTION_GET; break;
543 case 2: actions = ACTION_SET; break;
544 case 3: actions = ACTION_SET_ALL; break;
545 default:
546 usage_with_options(builtin_config_usage, builtin_config_options);
549 if (actions == ACTION_LIST) {
550 check_argc(argc, 0, 0);
551 if (git_config_with_options(show_all_config, NULL,
552 given_config_file,
553 given_config_blob,
554 respect_includes) < 0) {
555 if (given_config_file)
556 die_errno("unable to read config file '%s'",
557 given_config_file);
558 else
559 die("error processing config file(s)");
562 else if (actions == ACTION_EDIT) {
563 check_argc(argc, 0, 0);
564 if (!given_config_file && nongit)
565 die("not in a git directory");
566 if (given_config_blob)
567 die("editing blobs is not supported");
568 git_config(git_default_config, NULL);
569 launch_editor(given_config_file ?
570 given_config_file : git_path("config"),
571 NULL, NULL);
573 else if (actions == ACTION_SET) {
574 int ret;
575 check_blob_write();
576 check_argc(argc, 2, 2);
577 value = normalize_value(argv[0], argv[1]);
578 ret = git_config_set_in_file(given_config_file, argv[0], value);
579 if (ret == CONFIG_NOTHING_SET)
580 error("cannot overwrite multiple values with a single value\n"
581 " Use a regexp, --add or --replace-all to change %s.", argv[0]);
582 return ret;
584 else if (actions == ACTION_SET_ALL) {
585 check_blob_write();
586 check_argc(argc, 2, 3);
587 value = normalize_value(argv[0], argv[1]);
588 return git_config_set_multivar_in_file(given_config_file,
589 argv[0], value, argv[2], 0);
591 else if (actions == ACTION_ADD) {
592 check_blob_write();
593 check_argc(argc, 2, 2);
594 value = normalize_value(argv[0], argv[1]);
595 return git_config_set_multivar_in_file(given_config_file,
596 argv[0], value, "^$", 0);
598 else if (actions == ACTION_REPLACE_ALL) {
599 check_blob_write();
600 check_argc(argc, 2, 3);
601 value = normalize_value(argv[0], argv[1]);
602 return git_config_set_multivar_in_file(given_config_file,
603 argv[0], value, argv[2], 1);
605 else if (actions == ACTION_GET) {
606 check_argc(argc, 1, 2);
607 return get_value(argv[0], argv[1]);
609 else if (actions == ACTION_GET_ALL) {
610 do_all = 1;
611 check_argc(argc, 1, 2);
612 return get_value(argv[0], argv[1]);
614 else if (actions == ACTION_GET_REGEXP) {
615 show_keys = 1;
616 use_key_regexp = 1;
617 do_all = 1;
618 check_argc(argc, 1, 2);
619 return get_value(argv[0], argv[1]);
621 else if (actions == ACTION_GET_URLMATCH) {
622 check_argc(argc, 2, 2);
623 return get_urlmatch(argv[0], argv[1]);
625 else if (actions == ACTION_UNSET) {
626 check_blob_write();
627 check_argc(argc, 1, 2);
628 if (argc == 2)
629 return git_config_set_multivar_in_file(given_config_file,
630 argv[0], NULL, argv[1], 0);
631 else
632 return git_config_set_in_file(given_config_file,
633 argv[0], NULL);
635 else if (actions == ACTION_UNSET_ALL) {
636 check_blob_write();
637 check_argc(argc, 1, 2);
638 return git_config_set_multivar_in_file(given_config_file,
639 argv[0], NULL, argv[1], 1);
641 else if (actions == ACTION_RENAME_SECTION) {
642 int ret;
643 check_blob_write();
644 check_argc(argc, 2, 2);
645 ret = git_config_rename_section_in_file(given_config_file,
646 argv[0], argv[1]);
647 if (ret < 0)
648 return ret;
649 if (ret == 0)
650 die("No such section!");
652 else if (actions == ACTION_REMOVE_SECTION) {
653 int ret;
654 check_blob_write();
655 check_argc(argc, 1, 1);
656 ret = git_config_rename_section_in_file(given_config_file,
657 argv[0], NULL);
658 if (ret < 0)
659 return ret;
660 if (ret == 0)
661 die("No such section!");
663 else if (actions == ACTION_GET_COLOR) {
664 get_color(argv[0]);
666 else if (actions == ACTION_GET_COLORBOOL) {
667 if (argc == 1)
668 color_stdout_is_tty = git_config_bool("command line", argv[0]);
669 return get_colorbool(argc != 0);
672 return 0;
675 int cmd_repo_config(int argc, const char **argv, const char *prefix)
677 fprintf(stderr, "WARNING: git repo-config is deprecated in favor of git config.\n");
678 return cmd_config(argc, argv, prefix);