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)
52 * The actions "ACTION_LIST | ACTION_GET_*" which may produce more than
53 * one line of output and which should therefore be paged.
55 #define PAGING_ACTIONS (ACTION_LIST | ACTION_GET_ALL | \
56 ACTION_GET_REGEXP | ACTION_GET_URLMATCH)
58 #define TYPE_BOOL (1<<0)
59 #define TYPE_INT (1<<1)
60 #define TYPE_BOOL_OR_INT (1<<2)
61 #define TYPE_PATH (1<<3)
62 #define TYPE_EXPIRY_DATE (1<<4)
64 static struct option builtin_config_options
[] = {
65 OPT_GROUP(N_("Config file location")),
66 OPT_BOOL(0, "global", &use_global_config
, N_("use global config file")),
67 OPT_BOOL(0, "system", &use_system_config
, N_("use system config file")),
68 OPT_BOOL(0, "local", &use_local_config
, N_("use repository config file")),
69 OPT_STRING('f', "file", &given_config_source
.file
, N_("file"), N_("use given config file")),
70 OPT_STRING(0, "blob", &given_config_source
.blob
, N_("blob-id"), N_("read config from given blob object")),
71 OPT_GROUP(N_("Action")),
72 OPT_BIT(0, "get", &actions
, N_("get value: name [value-regex]"), ACTION_GET
),
73 OPT_BIT(0, "get-all", &actions
, N_("get all values: key [value-regex]"), ACTION_GET_ALL
),
74 OPT_BIT(0, "get-regexp", &actions
, N_("get values for regexp: name-regex [value-regex]"), ACTION_GET_REGEXP
),
75 OPT_BIT(0, "get-urlmatch", &actions
, N_("get value specific for the URL: section[.var] URL"), ACTION_GET_URLMATCH
),
76 OPT_BIT(0, "replace-all", &actions
, N_("replace all matching variables: name value [value_regex]"), ACTION_REPLACE_ALL
),
77 OPT_BIT(0, "add", &actions
, N_("add a new variable: name value"), ACTION_ADD
),
78 OPT_BIT(0, "unset", &actions
, N_("remove a variable: name [value-regex]"), ACTION_UNSET
),
79 OPT_BIT(0, "unset-all", &actions
, N_("remove all matches: name [value-regex]"), ACTION_UNSET_ALL
),
80 OPT_BIT(0, "rename-section", &actions
, N_("rename section: old-name new-name"), ACTION_RENAME_SECTION
),
81 OPT_BIT(0, "remove-section", &actions
, N_("remove a section: name"), ACTION_REMOVE_SECTION
),
82 OPT_BIT('l', "list", &actions
, N_("list all"), ACTION_LIST
),
83 OPT_BIT('e', "edit", &actions
, N_("open an editor"), ACTION_EDIT
),
84 OPT_BIT(0, "get-color", &actions
, N_("find the color configured: slot [default]"), ACTION_GET_COLOR
),
85 OPT_BIT(0, "get-colorbool", &actions
, N_("find the color setting: slot [stdout-is-tty]"), ACTION_GET_COLORBOOL
),
86 OPT_GROUP(N_("Type")),
87 OPT_BIT(0, "bool", &types
, N_("value is \"true\" or \"false\""), TYPE_BOOL
),
88 OPT_BIT(0, "int", &types
, N_("value is decimal number"), TYPE_INT
),
89 OPT_BIT(0, "bool-or-int", &types
, N_("value is --bool or --int"), TYPE_BOOL_OR_INT
),
90 OPT_BIT(0, "path", &types
, N_("value is a path (file or directory name)"), TYPE_PATH
),
91 OPT_BIT(0, "expiry-date", &types
, N_("value is an expiry date"), TYPE_EXPIRY_DATE
),
92 OPT_GROUP(N_("Other")),
93 OPT_BOOL('z', "null", &end_null
, N_("terminate values with NUL byte")),
94 OPT_BOOL(0, "name-only", &omit_values
, N_("show variable names only")),
95 OPT_BOOL(0, "includes", &respect_includes_opt
, N_("respect include directives on lookup")),
96 OPT_BOOL(0, "show-origin", &show_origin
, N_("show origin of config (file, standard input, blob, command line)")),
100 static void check_argc(int argc
, int min
, int max
) {
101 if (argc
>= min
&& argc
<= max
)
103 error("wrong number of arguments");
104 usage_with_options(builtin_config_usage
, builtin_config_options
);
107 static void show_config_origin(struct strbuf
*buf
)
109 const char term
= end_null
? '\0' : '\t';
111 strbuf_addstr(buf
, current_config_origin_type());
112 strbuf_addch(buf
, ':');
114 strbuf_addstr(buf
, current_config_name());
116 quote_c_style(current_config_name(), buf
, NULL
, 0);
117 strbuf_addch(buf
, term
);
120 static int show_all_config(const char *key_
, const char *value_
, void *cb
)
123 struct strbuf buf
= STRBUF_INIT
;
124 show_config_origin(&buf
);
125 /* Use fwrite as "buf" can contain \0's if "end_null" is set. */
126 fwrite(buf
.buf
, 1, buf
.len
, stdout
);
127 strbuf_release(&buf
);
129 if (!omit_values
&& value_
)
130 printf("%s%c%s%c", key_
, delim
, value_
, term
);
132 printf("%s%c", key_
, term
);
137 struct strbuf
*items
;
142 static int format_config(struct strbuf
*buf
, const char *key_
, const char *value_
)
145 show_config_origin(buf
);
147 strbuf_addstr(buf
, key_
);
150 strbuf_addch(buf
, key_delim
);
152 if (types
== TYPE_INT
)
153 strbuf_addf(buf
, "%"PRId64
,
154 git_config_int64(key_
, value_
? value_
: ""));
155 else if (types
== TYPE_BOOL
)
156 strbuf_addstr(buf
, git_config_bool(key_
, value_
) ?
158 else if (types
== TYPE_BOOL_OR_INT
) {
160 v
= git_config_bool_or_int(key_
, value_
, &is_bool
);
162 strbuf_addstr(buf
, v
? "true" : "false");
164 strbuf_addf(buf
, "%d", v
);
165 } else if (types
== TYPE_PATH
) {
167 if (git_config_pathname(&v
, key_
, value_
) < 0)
169 strbuf_addstr(buf
, v
);
171 } else if (types
== TYPE_EXPIRY_DATE
) {
173 if (git_config_expiry_date(&t
, key_
, value_
) < 0)
175 strbuf_addf(buf
, "%"PRItime
, t
);
177 strbuf_addstr(buf
, value_
);
179 /* Just show the key name; back out delimiter */
181 strbuf_setlen(buf
, buf
->len
- 1);
184 strbuf_addch(buf
, term
);
188 static int collect_config(const char *key_
, const char *value_
, void *cb
)
190 struct strbuf_list
*values
= cb
;
192 if (!use_key_regexp
&& strcmp(key_
, key
))
194 if (use_key_regexp
&& regexec(key_regexp
, key_
, 0, NULL
, 0))
196 if (regexp
!= NULL
&&
197 (do_not_match
^ !!regexec(regexp
, (value_
?value_
:""), 0, NULL
, 0)))
200 ALLOC_GROW(values
->items
, values
->nr
+ 1, values
->alloc
);
201 strbuf_init(&values
->items
[values
->nr
], 0);
203 return format_config(&values
->items
[values
->nr
++], key_
, value_
);
206 static int get_value(const char *key_
, const char *regex_
)
208 int ret
= CONFIG_GENERIC_ERROR
;
209 struct strbuf_list values
= {NULL
};
212 if (use_key_regexp
) {
216 * NEEDSWORK: this naive pattern lowercasing obviously does not
217 * work for more complex patterns like "^[^.]*Foo.*bar".
218 * Perhaps we should deprecate this altogether someday.
222 for (tl
= key
+ strlen(key
) - 1;
223 tl
>= key
&& *tl
!= '.';
226 for (tl
= key
; *tl
&& *tl
!= '.'; tl
++)
229 key_regexp
= (regex_t
*)xmalloc(sizeof(regex_t
));
230 if (regcomp(key_regexp
, key
, REG_EXTENDED
)) {
231 error("invalid key pattern: %s", key_
);
232 FREE_AND_NULL(key_regexp
);
233 ret
= CONFIG_INVALID_PATTERN
;
237 if (git_config_parse_key(key_
, &key
, NULL
)) {
238 ret
= CONFIG_INVALID_KEY
;
244 if (regex_
[0] == '!') {
249 regexp
= (regex_t
*)xmalloc(sizeof(regex_t
));
250 if (regcomp(regexp
, regex_
, REG_EXTENDED
)) {
251 error("invalid pattern: %s", regex_
);
252 FREE_AND_NULL(regexp
);
253 ret
= CONFIG_INVALID_PATTERN
;
258 config_with_options(collect_config
, &values
,
259 &given_config_source
, &config_options
);
263 for (i
= 0; i
< values
.nr
; i
++) {
264 struct strbuf
*buf
= values
.items
+ i
;
265 if (do_all
|| i
== values
.nr
- 1)
266 fwrite(buf
->buf
, 1, buf
->len
, stdout
);
285 static char *normalize_value(const char *key
, const char *value
)
290 if (types
== 0 || types
== TYPE_PATH
|| types
== TYPE_EXPIRY_DATE
)
292 * We don't do normalization for TYPE_PATH here: If
293 * the path is like ~/foobar/, we prefer to store
294 * "~/foobar/" in the config file, and to expand the ~
295 * when retrieving the value.
296 * Also don't do normalization for expiry dates.
298 return xstrdup(value
);
299 if (types
== TYPE_INT
)
300 return xstrfmt("%"PRId64
, git_config_int64(key
, value
));
301 if (types
== TYPE_BOOL
)
302 return xstrdup(git_config_bool(key
, value
) ? "true" : "false");
303 if (types
== TYPE_BOOL_OR_INT
) {
305 v
= git_config_bool_or_int(key
, value
, &is_bool
);
307 return xstrfmt("%d", v
);
309 return xstrdup(v
? "true" : "false");
312 die("BUG: cannot normalize type %d", types
);
315 static int get_color_found
;
316 static const char *get_color_slot
;
317 static const char *get_colorbool_slot
;
318 static char parsed_color
[COLOR_MAXLEN
];
320 static int git_get_color_config(const char *var
, const char *value
, void *cb
)
322 if (!strcmp(var
, get_color_slot
)) {
324 config_error_nonbool(var
);
325 if (color_parse(value
, parsed_color
) < 0)
332 static void get_color(const char *var
, const char *def_color
)
334 get_color_slot
= var
;
336 parsed_color
[0] = '\0';
337 config_with_options(git_get_color_config
, NULL
,
338 &given_config_source
, &config_options
);
340 if (!get_color_found
&& def_color
) {
341 if (color_parse(def_color
, parsed_color
) < 0)
342 die(_("unable to parse default color value"));
345 fputs(parsed_color
, stdout
);
348 static int get_colorbool_found
;
349 static int get_diff_color_found
;
350 static int get_color_ui_found
;
351 static int git_get_colorbool_config(const char *var
, const char *value
,
354 if (!strcmp(var
, get_colorbool_slot
))
355 get_colorbool_found
= git_config_colorbool(var
, value
);
356 else if (!strcmp(var
, "diff.color"))
357 get_diff_color_found
= git_config_colorbool(var
, value
);
358 else if (!strcmp(var
, "color.ui"))
359 get_color_ui_found
= git_config_colorbool(var
, value
);
363 static int get_colorbool(const char *var
, int print
)
365 get_colorbool_slot
= var
;
366 get_colorbool_found
= -1;
367 get_diff_color_found
= -1;
368 get_color_ui_found
= -1;
369 config_with_options(git_get_colorbool_config
, NULL
,
370 &given_config_source
, &config_options
);
372 if (get_colorbool_found
< 0) {
373 if (!strcmp(get_colorbool_slot
, "color.diff"))
374 get_colorbool_found
= get_diff_color_found
;
375 if (get_colorbool_found
< 0)
376 get_colorbool_found
= get_color_ui_found
;
379 if (get_colorbool_found
< 0)
380 /* default value if none found in config */
381 get_colorbool_found
= GIT_COLOR_AUTO
;
383 get_colorbool_found
= want_color(get_colorbool_found
);
386 printf("%s\n", get_colorbool_found
? "true" : "false");
389 return get_colorbool_found
? 0 : 1;
392 static void check_write(void)
394 if (!given_config_source
.file
&& !startup_info
->have_repository
)
395 die("not in a git directory");
397 if (given_config_source
.use_stdin
)
398 die("writing to stdin is not supported");
400 if (given_config_source
.blob
)
401 die("writing config blobs is not supported");
404 struct urlmatch_current_candidate_value
{
409 static int urlmatch_collect_fn(const char *var
, const char *value
, void *cb
)
411 struct string_list
*values
= cb
;
412 struct string_list_item
*item
= string_list_insert(values
, var
);
413 struct urlmatch_current_candidate_value
*matched
= item
->util
;
416 matched
= xmalloc(sizeof(*matched
));
417 strbuf_init(&matched
->value
, 0);
418 item
->util
= matched
;
420 strbuf_reset(&matched
->value
);
424 strbuf_addstr(&matched
->value
, value
);
425 matched
->value_is_null
= 0;
427 matched
->value_is_null
= 1;
432 static int get_urlmatch(const char *var
, const char *url
)
436 struct string_list_item
*item
;
437 struct urlmatch_config config
= { STRING_LIST_INIT_DUP
};
438 struct string_list values
= STRING_LIST_INIT_DUP
;
440 config
.collect_fn
= urlmatch_collect_fn
;
441 config
.cascade_fn
= NULL
;
444 if (!url_normalize(url
, &config
.url
))
445 die("%s", config
.url
.err
);
447 config
.section
= xstrdup_tolower(var
);
448 section_tail
= strchr(config
.section
, '.');
450 *section_tail
= '\0';
451 config
.key
= section_tail
+ 1;
458 config_with_options(urlmatch_config_entry
, &config
,
459 &given_config_source
, &config_options
);
463 for_each_string_list_item(item
, &values
) {
464 struct urlmatch_current_candidate_value
*matched
= item
->util
;
465 struct strbuf buf
= STRBUF_INIT
;
467 format_config(&buf
, item
->string
,
468 matched
->value_is_null
? NULL
: matched
->value
.buf
);
469 fwrite(buf
.buf
, 1, buf
.len
, stdout
);
470 strbuf_release(&buf
);
472 strbuf_release(&matched
->value
);
474 string_list_clear(&config
.vars
, 1);
475 string_list_clear(&values
, 1);
476 free(config
.url
.url
);
478 free((void *)config
.section
);
482 static char *default_user_config(void)
484 struct strbuf buf
= STRBUF_INIT
;
486 _("# This is Git's per-user configuration file.\n"
488 "# Please adapt and uncomment the following lines:\n"
491 ident_default_name(),
492 ident_default_email());
493 return strbuf_detach(&buf
, NULL
);
496 int cmd_config(int argc
, const char **argv
, const char *prefix
)
498 int nongit
= !startup_info
->have_repository
;
501 given_config_source
.file
= getenv(CONFIG_ENVIRONMENT
);
503 argc
= parse_options(argc
, argv
, prefix
, builtin_config_options
,
504 builtin_config_usage
,
505 PARSE_OPT_STOP_AT_NON_OPTION
);
507 if (use_global_config
+ use_system_config
+ use_local_config
+
508 !!given_config_source
.file
+ !!given_config_source
.blob
> 1) {
509 error("only one config file at a time.");
510 usage_with_options(builtin_config_usage
, builtin_config_options
);
513 if (use_local_config
&& nongit
)
514 die(_("--local can only be used inside a git repository"));
516 if (given_config_source
.file
&&
517 !strcmp(given_config_source
.file
, "-")) {
518 given_config_source
.file
= NULL
;
519 given_config_source
.use_stdin
= 1;
522 if (use_global_config
) {
523 char *user_config
= expand_user_path("~/.gitconfig", 0);
524 char *xdg_config
= xdg_config_home("config");
528 * It is unknown if HOME/.gitconfig exists, so
529 * we do not know if we should write to XDG
530 * location; error out even if XDG_CONFIG_HOME
531 * is set and points at a sane location.
533 die("$HOME not set");
535 if (access_or_warn(user_config
, R_OK
, 0) &&
536 xdg_config
&& !access_or_warn(xdg_config
, R_OK
, 0)) {
537 given_config_source
.file
= xdg_config
;
540 given_config_source
.file
= user_config
;
544 else if (use_system_config
)
545 given_config_source
.file
= git_etc_gitconfig();
546 else if (use_local_config
)
547 given_config_source
.file
= git_pathdup("config");
548 else if (given_config_source
.file
) {
549 if (!is_absolute_path(given_config_source
.file
) && prefix
)
550 given_config_source
.file
=
551 prefix_filename(prefix
, given_config_source
.file
);
554 if (respect_includes_opt
== -1)
555 config_options
.respect_includes
= !given_config_source
.file
;
557 config_options
.respect_includes
= respect_includes_opt
;
559 config_options
.commondir
= get_git_common_dir();
560 config_options
.git_dir
= get_git_dir();
569 if (HAS_MULTI_BITS(types
)) {
570 error("only one type at a time.");
571 usage_with_options(builtin_config_usage
, builtin_config_options
);
574 if ((actions
& (ACTION_GET_COLOR
|ACTION_GET_COLORBOOL
)) && types
) {
575 error("--get-color and variable type are incoherent");
576 usage_with_options(builtin_config_usage
, builtin_config_options
);
579 if (HAS_MULTI_BITS(actions
)) {
580 error("only one action at a time.");
581 usage_with_options(builtin_config_usage
, builtin_config_options
);
585 case 1: actions
= ACTION_GET
; break;
586 case 2: actions
= ACTION_SET
; break;
587 case 3: actions
= ACTION_SET_ALL
; break;
589 usage_with_options(builtin_config_usage
, builtin_config_options
);
592 !(actions
== ACTION_LIST
|| actions
== ACTION_GET_REGEXP
)) {
593 error("--name-only is only applicable to --list or --get-regexp");
594 usage_with_options(builtin_config_usage
, builtin_config_options
);
597 if (show_origin
&& !(actions
&
598 (ACTION_GET
|ACTION_GET_ALL
|ACTION_GET_REGEXP
|ACTION_LIST
))) {
599 error("--show-origin is only applicable to --get, --get-all, "
600 "--get-regexp, and --list.");
601 usage_with_options(builtin_config_usage
, builtin_config_options
);
604 if (actions
& PAGING_ACTIONS
)
605 setup_auto_pager("config", 1);
607 if (actions
== ACTION_LIST
) {
608 check_argc(argc
, 0, 0);
609 if (config_with_options(show_all_config
, NULL
,
610 &given_config_source
,
611 &config_options
) < 0) {
612 if (given_config_source
.file
)
613 die_errno("unable to read config file '%s'",
614 given_config_source
.file
);
616 die("error processing config file(s)");
619 else if (actions
== ACTION_EDIT
) {
622 check_argc(argc
, 0, 0);
623 if (!given_config_source
.file
&& nongit
)
624 die("not in a git directory");
625 if (given_config_source
.use_stdin
)
626 die("editing stdin is not supported");
627 if (given_config_source
.blob
)
628 die("editing blobs is not supported");
629 git_config(git_default_config
, NULL
);
630 config_file
= given_config_source
.file
?
631 xstrdup(given_config_source
.file
) :
632 git_pathdup("config");
633 if (use_global_config
) {
634 int fd
= open(config_file
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666);
636 char *content
= default_user_config();
637 write_str_in_full(fd
, content
);
641 else if (errno
!= EEXIST
)
642 die_errno(_("cannot create configuration file %s"), config_file
);
644 launch_editor(config_file
, NULL
, NULL
);
647 else if (actions
== ACTION_SET
) {
650 check_argc(argc
, 2, 2);
651 value
= normalize_value(argv
[0], argv
[1]);
653 ret
= git_config_set_in_file_gently(given_config_source
.file
, argv
[0], value
);
654 if (ret
== CONFIG_NOTHING_SET
)
655 error(_("cannot overwrite multiple values with a single value\n"
656 " Use a regexp, --add or --replace-all to change %s."), argv
[0]);
659 else if (actions
== ACTION_SET_ALL
) {
661 check_argc(argc
, 2, 3);
662 value
= normalize_value(argv
[0], argv
[1]);
664 return git_config_set_multivar_in_file_gently(given_config_source
.file
,
665 argv
[0], value
, argv
[2], 0);
667 else if (actions
== ACTION_ADD
) {
669 check_argc(argc
, 2, 2);
670 value
= normalize_value(argv
[0], argv
[1]);
672 return git_config_set_multivar_in_file_gently(given_config_source
.file
,
674 CONFIG_REGEX_NONE
, 0);
676 else if (actions
== ACTION_REPLACE_ALL
) {
678 check_argc(argc
, 2, 3);
679 value
= normalize_value(argv
[0], argv
[1]);
681 return git_config_set_multivar_in_file_gently(given_config_source
.file
,
682 argv
[0], value
, argv
[2], 1);
684 else if (actions
== ACTION_GET
) {
685 check_argc(argc
, 1, 2);
686 return get_value(argv
[0], argv
[1]);
688 else if (actions
== ACTION_GET_ALL
) {
690 check_argc(argc
, 1, 2);
691 return get_value(argv
[0], argv
[1]);
693 else if (actions
== ACTION_GET_REGEXP
) {
697 check_argc(argc
, 1, 2);
698 return get_value(argv
[0], argv
[1]);
700 else if (actions
== ACTION_GET_URLMATCH
) {
701 check_argc(argc
, 2, 2);
702 return get_urlmatch(argv
[0], argv
[1]);
704 else if (actions
== ACTION_UNSET
) {
706 check_argc(argc
, 1, 2);
708 return git_config_set_multivar_in_file_gently(given_config_source
.file
,
709 argv
[0], NULL
, argv
[1], 0);
711 return git_config_set_in_file_gently(given_config_source
.file
,
714 else if (actions
== ACTION_UNSET_ALL
) {
716 check_argc(argc
, 1, 2);
717 return git_config_set_multivar_in_file_gently(given_config_source
.file
,
718 argv
[0], NULL
, argv
[1], 1);
720 else if (actions
== ACTION_RENAME_SECTION
) {
723 check_argc(argc
, 2, 2);
724 ret
= git_config_rename_section_in_file(given_config_source
.file
,
729 die("No such section!");
731 else if (actions
== ACTION_REMOVE_SECTION
) {
734 check_argc(argc
, 1, 1);
735 ret
= git_config_rename_section_in_file(given_config_source
.file
,
740 die("No such section!");
742 else if (actions
== ACTION_GET_COLOR
) {
743 check_argc(argc
, 1, 2);
744 get_color(argv
[0], argv
[1]);
746 else if (actions
== ACTION_GET_COLORBOOL
) {
747 check_argc(argc
, 1, 2);
749 color_stdout_is_tty
= git_config_bool("command line", argv
[1]);
750 return get_colorbool(argv
[0], argc
== 2);