]> git.ipfire.org Git - thirdparty/git.git/blob - builtin/config.c
submodule-config.c: strengthen URL fsck check
[thirdparty/git.git] / builtin / config.c
1 #include "builtin.h"
2 #include "abspath.h"
3 #include "config.h"
4 #include "color.h"
5 #include "editor.h"
6 #include "environment.h"
7 #include "repository.h"
8 #include "gettext.h"
9 #include "ident.h"
10 #include "parse-options.h"
11 #include "urlmatch.h"
12 #include "path.h"
13 #include "quote.h"
14 #include "setup.h"
15 #include "strbuf.h"
16 #include "worktree.h"
17
18 static const char *const builtin_config_usage[] = {
19 N_("git config [<options>]"),
20 NULL
21 };
22
23 static char *key;
24 static regex_t *key_regexp;
25 static const char *value_pattern;
26 static regex_t *regexp;
27 static int show_keys;
28 static int omit_values;
29 static int use_key_regexp;
30 static int do_all;
31 static int do_not_match;
32 static char delim = '=';
33 static char key_delim = ' ';
34 static char term = '\n';
35
36 static int use_global_config, use_system_config, use_local_config;
37 static int use_worktree_config;
38 static struct git_config_source given_config_source;
39 static int actions, type;
40 static char *default_value;
41 static int end_nul;
42 static int respect_includes_opt = -1;
43 static struct config_options config_options;
44 static int show_origin;
45 static int show_scope;
46 static int fixed_value;
47
48 #define ACTION_GET (1<<0)
49 #define ACTION_GET_ALL (1<<1)
50 #define ACTION_GET_REGEXP (1<<2)
51 #define ACTION_REPLACE_ALL (1<<3)
52 #define ACTION_ADD (1<<4)
53 #define ACTION_UNSET (1<<5)
54 #define ACTION_UNSET_ALL (1<<6)
55 #define ACTION_RENAME_SECTION (1<<7)
56 #define ACTION_REMOVE_SECTION (1<<8)
57 #define ACTION_LIST (1<<9)
58 #define ACTION_EDIT (1<<10)
59 #define ACTION_SET (1<<11)
60 #define ACTION_SET_ALL (1<<12)
61 #define ACTION_GET_COLOR (1<<13)
62 #define ACTION_GET_COLORBOOL (1<<14)
63 #define ACTION_GET_URLMATCH (1<<15)
64
65 /*
66 * The actions "ACTION_LIST | ACTION_GET_*" which may produce more than
67 * one line of output and which should therefore be paged.
68 */
69 #define PAGING_ACTIONS (ACTION_LIST | ACTION_GET_ALL | \
70 ACTION_GET_REGEXP | ACTION_GET_URLMATCH)
71
72 #define TYPE_BOOL 1
73 #define TYPE_INT 2
74 #define TYPE_BOOL_OR_INT 3
75 #define TYPE_PATH 4
76 #define TYPE_EXPIRY_DATE 5
77 #define TYPE_COLOR 6
78 #define TYPE_BOOL_OR_STR 7
79
80 #define OPT_CALLBACK_VALUE(s, l, v, h, i) \
81 { OPTION_CALLBACK, (s), (l), (v), NULL, (h), PARSE_OPT_NOARG | \
82 PARSE_OPT_NONEG, option_parse_type, (i) }
83
84 static NORETURN void usage_builtin_config(void);
85
86 static int option_parse_type(const struct option *opt, const char *arg,
87 int unset)
88 {
89 int new_type, *to_type;
90
91 if (unset) {
92 *((int *) opt->value) = 0;
93 return 0;
94 }
95
96 /*
97 * To support '--<type>' style flags, begin with new_type equal to
98 * opt->defval.
99 */
100 new_type = opt->defval;
101 if (!new_type) {
102 if (!strcmp(arg, "bool"))
103 new_type = TYPE_BOOL;
104 else if (!strcmp(arg, "int"))
105 new_type = TYPE_INT;
106 else if (!strcmp(arg, "bool-or-int"))
107 new_type = TYPE_BOOL_OR_INT;
108 else if (!strcmp(arg, "bool-or-str"))
109 new_type = TYPE_BOOL_OR_STR;
110 else if (!strcmp(arg, "path"))
111 new_type = TYPE_PATH;
112 else if (!strcmp(arg, "expiry-date"))
113 new_type = TYPE_EXPIRY_DATE;
114 else if (!strcmp(arg, "color"))
115 new_type = TYPE_COLOR;
116 else
117 die(_("unrecognized --type argument, %s"), arg);
118 }
119
120 to_type = opt->value;
121 if (*to_type && *to_type != new_type) {
122 /*
123 * Complain when there is a new type not equal to the old type.
124 * This allows for combinations like '--int --type=int' and
125 * '--type=int --type=int', but disallows ones like '--type=bool
126 * --int' and '--type=bool
127 * --type=int'.
128 */
129 error(_("only one type at a time"));
130 usage_builtin_config();
131 }
132 *to_type = new_type;
133
134 return 0;
135 }
136
137 static struct option builtin_config_options[] = {
138 OPT_GROUP(N_("Config file location")),
139 OPT_BOOL(0, "global", &use_global_config, N_("use global config file")),
140 OPT_BOOL(0, "system", &use_system_config, N_("use system config file")),
141 OPT_BOOL(0, "local", &use_local_config, N_("use repository config file")),
142 OPT_BOOL(0, "worktree", &use_worktree_config, N_("use per-worktree config file")),
143 OPT_STRING('f', "file", &given_config_source.file, N_("file"), N_("use given config file")),
144 OPT_STRING(0, "blob", &given_config_source.blob, N_("blob-id"), N_("read config from given blob object")),
145 OPT_GROUP(N_("Action")),
146 OPT_BIT(0, "get", &actions, N_("get value: name [value-pattern]"), ACTION_GET),
147 OPT_BIT(0, "get-all", &actions, N_("get all values: key [value-pattern]"), ACTION_GET_ALL),
148 OPT_BIT(0, "get-regexp", &actions, N_("get values for regexp: name-regex [value-pattern]"), ACTION_GET_REGEXP),
149 OPT_BIT(0, "get-urlmatch", &actions, N_("get value specific for the URL: section[.var] URL"), ACTION_GET_URLMATCH),
150 OPT_BIT(0, "replace-all", &actions, N_("replace all matching variables: name value [value-pattern]"), ACTION_REPLACE_ALL),
151 OPT_BIT(0, "add", &actions, N_("add a new variable: name value"), ACTION_ADD),
152 OPT_BIT(0, "unset", &actions, N_("remove a variable: name [value-pattern]"), ACTION_UNSET),
153 OPT_BIT(0, "unset-all", &actions, N_("remove all matches: name [value-pattern]"), ACTION_UNSET_ALL),
154 OPT_BIT(0, "rename-section", &actions, N_("rename section: old-name new-name"), ACTION_RENAME_SECTION),
155 OPT_BIT(0, "remove-section", &actions, N_("remove a section: name"), ACTION_REMOVE_SECTION),
156 OPT_BIT('l', "list", &actions, N_("list all"), ACTION_LIST),
157 OPT_BOOL(0, "fixed-value", &fixed_value, N_("use string equality when comparing values to 'value-pattern'")),
158 OPT_BIT('e', "edit", &actions, N_("open an editor"), ACTION_EDIT),
159 OPT_BIT(0, "get-color", &actions, N_("find the color configured: slot [default]"), ACTION_GET_COLOR),
160 OPT_BIT(0, "get-colorbool", &actions, N_("find the color setting: slot [stdout-is-tty]"), ACTION_GET_COLORBOOL),
161 OPT_GROUP(N_("Type")),
162 OPT_CALLBACK('t', "type", &type, N_("type"), N_("value is given this type"), option_parse_type),
163 OPT_CALLBACK_VALUE(0, "bool", &type, N_("value is \"true\" or \"false\""), TYPE_BOOL),
164 OPT_CALLBACK_VALUE(0, "int", &type, N_("value is decimal number"), TYPE_INT),
165 OPT_CALLBACK_VALUE(0, "bool-or-int", &type, N_("value is --bool or --int"), TYPE_BOOL_OR_INT),
166 OPT_CALLBACK_VALUE(0, "bool-or-str", &type, N_("value is --bool or string"), TYPE_BOOL_OR_STR),
167 OPT_CALLBACK_VALUE(0, "path", &type, N_("value is a path (file or directory name)"), TYPE_PATH),
168 OPT_CALLBACK_VALUE(0, "expiry-date", &type, N_("value is an expiry date"), TYPE_EXPIRY_DATE),
169 OPT_GROUP(N_("Other")),
170 OPT_BOOL('z', "null", &end_nul, N_("terminate values with NUL byte")),
171 OPT_BOOL(0, "name-only", &omit_values, N_("show variable names only")),
172 OPT_BOOL(0, "includes", &respect_includes_opt, N_("respect include directives on lookup")),
173 OPT_BOOL(0, "show-origin", &show_origin, N_("show origin of config (file, standard input, blob, command line)")),
174 OPT_BOOL(0, "show-scope", &show_scope, N_("show scope of config (worktree, local, global, system, command)")),
175 OPT_STRING(0, "default", &default_value, N_("value"), N_("with --get, use default value when missing entry")),
176 OPT_END(),
177 };
178
179 static NORETURN void usage_builtin_config(void)
180 {
181 usage_with_options(builtin_config_usage, builtin_config_options);
182 }
183
184 static void check_argc(int argc, int min, int max)
185 {
186 if (argc >= min && argc <= max)
187 return;
188 if (min == max)
189 error(_("wrong number of arguments, should be %d"), min);
190 else
191 error(_("wrong number of arguments, should be from %d to %d"),
192 min, max);
193 usage_builtin_config();
194 }
195
196 static void show_config_origin(const struct key_value_info *kvi,
197 struct strbuf *buf)
198 {
199 const char term = end_nul ? '\0' : '\t';
200
201 strbuf_addstr(buf, config_origin_type_name(kvi->origin_type));
202 strbuf_addch(buf, ':');
203 if (end_nul)
204 strbuf_addstr(buf, kvi->filename ? kvi->filename : "");
205 else
206 quote_c_style(kvi->filename ? kvi->filename : "", buf, NULL, 0);
207 strbuf_addch(buf, term);
208 }
209
210 static void show_config_scope(const struct key_value_info *kvi,
211 struct strbuf *buf)
212 {
213 const char term = end_nul ? '\0' : '\t';
214 const char *scope = config_scope_name(kvi->scope);
215
216 strbuf_addstr(buf, N_(scope));
217 strbuf_addch(buf, term);
218 }
219
220 static int show_all_config(const char *key_, const char *value_,
221 const struct config_context *ctx,
222 void *cb UNUSED)
223 {
224 const struct key_value_info *kvi = ctx->kvi;
225
226 if (show_origin || show_scope) {
227 struct strbuf buf = STRBUF_INIT;
228 if (show_scope)
229 show_config_scope(kvi, &buf);
230 if (show_origin)
231 show_config_origin(kvi, &buf);
232 /* Use fwrite as "buf" can contain \0's if "end_null" is set. */
233 fwrite(buf.buf, 1, buf.len, stdout);
234 strbuf_release(&buf);
235 }
236 if (!omit_values && value_)
237 printf("%s%c%s%c", key_, delim, value_, term);
238 else
239 printf("%s%c", key_, term);
240 return 0;
241 }
242
243 struct strbuf_list {
244 struct strbuf *items;
245 int nr;
246 int alloc;
247 };
248
249 static int format_config(struct strbuf *buf, const char *key_,
250 const char *value_, const struct key_value_info *kvi)
251 {
252 if (show_scope)
253 show_config_scope(kvi, buf);
254 if (show_origin)
255 show_config_origin(kvi, buf);
256 if (show_keys)
257 strbuf_addstr(buf, key_);
258 if (!omit_values) {
259 if (show_keys)
260 strbuf_addch(buf, key_delim);
261
262 if (type == TYPE_INT)
263 strbuf_addf(buf, "%"PRId64,
264 git_config_int64(key_, value_ ? value_ : "", kvi));
265 else if (type == TYPE_BOOL)
266 strbuf_addstr(buf, git_config_bool(key_, value_) ?
267 "true" : "false");
268 else if (type == TYPE_BOOL_OR_INT) {
269 int is_bool, v;
270 v = git_config_bool_or_int(key_, value_, kvi,
271 &is_bool);
272 if (is_bool)
273 strbuf_addstr(buf, v ? "true" : "false");
274 else
275 strbuf_addf(buf, "%d", v);
276 } else if (type == TYPE_BOOL_OR_STR) {
277 int v = git_parse_maybe_bool(value_);
278 if (v < 0)
279 strbuf_addstr(buf, value_);
280 else
281 strbuf_addstr(buf, v ? "true" : "false");
282 } else if (type == TYPE_PATH) {
283 const char *v;
284 if (git_config_pathname(&v, key_, value_) < 0)
285 return -1;
286 strbuf_addstr(buf, v);
287 free((char *)v);
288 } else if (type == TYPE_EXPIRY_DATE) {
289 timestamp_t t;
290 if (git_config_expiry_date(&t, key_, value_) < 0)
291 return -1;
292 strbuf_addf(buf, "%"PRItime, t);
293 } else if (type == TYPE_COLOR) {
294 char v[COLOR_MAXLEN];
295 if (git_config_color(v, key_, value_) < 0)
296 return -1;
297 strbuf_addstr(buf, v);
298 } else if (value_) {
299 strbuf_addstr(buf, value_);
300 } else {
301 /* Just show the key name; back out delimiter */
302 if (show_keys)
303 strbuf_setlen(buf, buf->len - 1);
304 }
305 }
306 strbuf_addch(buf, term);
307 return 0;
308 }
309
310 static int collect_config(const char *key_, const char *value_,
311 const struct config_context *ctx, void *cb)
312 {
313 struct strbuf_list *values = cb;
314 const struct key_value_info *kvi = ctx->kvi;
315
316 if (!use_key_regexp && strcmp(key_, key))
317 return 0;
318 if (use_key_regexp && regexec(key_regexp, key_, 0, NULL, 0))
319 return 0;
320 if (fixed_value && strcmp(value_pattern, (value_?value_:"")))
321 return 0;
322 if (regexp != NULL &&
323 (do_not_match ^ !!regexec(regexp, (value_?value_:""), 0, NULL, 0)))
324 return 0;
325
326 ALLOC_GROW(values->items, values->nr + 1, values->alloc);
327 strbuf_init(&values->items[values->nr], 0);
328
329 return format_config(&values->items[values->nr++], key_, value_, kvi);
330 }
331
332 static int get_value(const char *key_, const char *regex_, unsigned flags)
333 {
334 int ret = CONFIG_GENERIC_ERROR;
335 struct strbuf_list values = {NULL};
336 int i;
337
338 if (use_key_regexp) {
339 char *tl;
340
341 /*
342 * NEEDSWORK: this naive pattern lowercasing obviously does not
343 * work for more complex patterns like "^[^.]*Foo.*bar".
344 * Perhaps we should deprecate this altogether someday.
345 */
346
347 key = xstrdup(key_);
348 for (tl = key + strlen(key) - 1;
349 tl >= key && *tl != '.';
350 tl--)
351 *tl = tolower(*tl);
352 for (tl = key; *tl && *tl != '.'; tl++)
353 *tl = tolower(*tl);
354
355 key_regexp = (regex_t*)xmalloc(sizeof(regex_t));
356 if (regcomp(key_regexp, key, REG_EXTENDED)) {
357 error(_("invalid key pattern: %s"), key_);
358 FREE_AND_NULL(key_regexp);
359 ret = CONFIG_INVALID_PATTERN;
360 goto free_strings;
361 }
362 } else {
363 if (git_config_parse_key(key_, &key, NULL)) {
364 ret = CONFIG_INVALID_KEY;
365 goto free_strings;
366 }
367 }
368
369 if (regex_ && (flags & CONFIG_FLAGS_FIXED_VALUE))
370 value_pattern = regex_;
371 else if (regex_) {
372 if (regex_[0] == '!') {
373 do_not_match = 1;
374 regex_++;
375 }
376
377 regexp = (regex_t*)xmalloc(sizeof(regex_t));
378 if (regcomp(regexp, regex_, REG_EXTENDED)) {
379 error(_("invalid pattern: %s"), regex_);
380 FREE_AND_NULL(regexp);
381 ret = CONFIG_INVALID_PATTERN;
382 goto free_strings;
383 }
384 }
385
386 config_with_options(collect_config, &values,
387 &given_config_source, the_repository,
388 &config_options);
389
390 if (!values.nr && default_value) {
391 struct key_value_info kvi = KVI_INIT;
392 struct strbuf *item;
393
394 kvi_from_param(&kvi);
395 ALLOC_GROW(values.items, values.nr + 1, values.alloc);
396 item = &values.items[values.nr++];
397 strbuf_init(item, 0);
398 if (format_config(item, key_, default_value, &kvi) < 0)
399 die(_("failed to format default config value: %s"),
400 default_value);
401 }
402
403 ret = !values.nr;
404
405 for (i = 0; i < values.nr; i++) {
406 struct strbuf *buf = values.items + i;
407 if (do_all || i == values.nr - 1)
408 fwrite(buf->buf, 1, buf->len, stdout);
409 strbuf_release(buf);
410 }
411 free(values.items);
412
413 free_strings:
414 free(key);
415 if (key_regexp) {
416 regfree(key_regexp);
417 free(key_regexp);
418 }
419 if (regexp) {
420 regfree(regexp);
421 free(regexp);
422 }
423
424 return ret;
425 }
426
427 static char *normalize_value(const char *key, const char *value,
428 struct key_value_info *kvi)
429 {
430 if (!value)
431 return NULL;
432
433 if (type == 0 || type == TYPE_PATH || type == TYPE_EXPIRY_DATE)
434 /*
435 * We don't do normalization for TYPE_PATH here: If
436 * the path is like ~/foobar/, we prefer to store
437 * "~/foobar/" in the config file, and to expand the ~
438 * when retrieving the value.
439 * Also don't do normalization for expiry dates.
440 */
441 return xstrdup(value);
442 if (type == TYPE_INT)
443 return xstrfmt("%"PRId64, git_config_int64(key, value, kvi));
444 if (type == TYPE_BOOL)
445 return xstrdup(git_config_bool(key, value) ? "true" : "false");
446 if (type == TYPE_BOOL_OR_INT) {
447 int is_bool, v;
448 v = git_config_bool_or_int(key, value, kvi, &is_bool);
449 if (!is_bool)
450 return xstrfmt("%d", v);
451 else
452 return xstrdup(v ? "true" : "false");
453 }
454 if (type == TYPE_BOOL_OR_STR) {
455 int v = git_parse_maybe_bool(value);
456 if (v < 0)
457 return xstrdup(value);
458 else
459 return xstrdup(v ? "true" : "false");
460 }
461 if (type == TYPE_COLOR) {
462 char v[COLOR_MAXLEN];
463 if (git_config_color(v, key, value))
464 die(_("cannot parse color '%s'"), value);
465
466 /*
467 * The contents of `v` now contain an ANSI escape
468 * sequence, not suitable for including within a
469 * configuration file. Treat the above as a
470 * "sanity-check", and return the given value, which we
471 * know is representable as valid color code.
472 */
473 return xstrdup(value);
474 }
475
476 BUG("cannot normalize type %d", type);
477 }
478
479 static int get_color_found;
480 static const char *get_color_slot;
481 static const char *get_colorbool_slot;
482 static char parsed_color[COLOR_MAXLEN];
483
484 static int git_get_color_config(const char *var, const char *value,
485 const struct config_context *ctx UNUSED,
486 void *cb UNUSED)
487 {
488 if (!strcmp(var, get_color_slot)) {
489 if (!value)
490 config_error_nonbool(var);
491 if (color_parse(value, parsed_color) < 0)
492 return -1;
493 get_color_found = 1;
494 }
495 return 0;
496 }
497
498 static void get_color(const char *var, const char *def_color)
499 {
500 get_color_slot = var;
501 get_color_found = 0;
502 parsed_color[0] = '\0';
503 config_with_options(git_get_color_config, NULL,
504 &given_config_source, the_repository,
505 &config_options);
506
507 if (!get_color_found && def_color) {
508 if (color_parse(def_color, parsed_color) < 0)
509 die(_("unable to parse default color value"));
510 }
511
512 fputs(parsed_color, stdout);
513 }
514
515 static int get_colorbool_found;
516 static int get_diff_color_found;
517 static int get_color_ui_found;
518 static int git_get_colorbool_config(const char *var, const char *value,
519 const struct config_context *ctx UNUSED,
520 void *data UNUSED)
521 {
522 if (!strcmp(var, get_colorbool_slot))
523 get_colorbool_found = git_config_colorbool(var, value);
524 else if (!strcmp(var, "diff.color"))
525 get_diff_color_found = git_config_colorbool(var, value);
526 else if (!strcmp(var, "color.ui"))
527 get_color_ui_found = git_config_colorbool(var, value);
528 return 0;
529 }
530
531 static int get_colorbool(const char *var, int print)
532 {
533 get_colorbool_slot = var;
534 get_colorbool_found = -1;
535 get_diff_color_found = -1;
536 get_color_ui_found = -1;
537 config_with_options(git_get_colorbool_config, NULL,
538 &given_config_source, the_repository,
539 &config_options);
540
541 if (get_colorbool_found < 0) {
542 if (!strcmp(get_colorbool_slot, "color.diff"))
543 get_colorbool_found = get_diff_color_found;
544 if (get_colorbool_found < 0)
545 get_colorbool_found = get_color_ui_found;
546 }
547
548 if (get_colorbool_found < 0)
549 /* default value if none found in config */
550 get_colorbool_found = GIT_COLOR_AUTO;
551
552 get_colorbool_found = want_color(get_colorbool_found);
553
554 if (print) {
555 printf("%s\n", get_colorbool_found ? "true" : "false");
556 return 0;
557 } else
558 return get_colorbool_found ? 0 : 1;
559 }
560
561 static void check_write(void)
562 {
563 if (!given_config_source.file && !startup_info->have_repository)
564 die(_("not in a git directory"));
565
566 if (given_config_source.use_stdin)
567 die(_("writing to stdin is not supported"));
568
569 if (given_config_source.blob)
570 die(_("writing config blobs is not supported"));
571 }
572
573 struct urlmatch_current_candidate_value {
574 char value_is_null;
575 struct strbuf value;
576 struct key_value_info kvi;
577 };
578
579 static int urlmatch_collect_fn(const char *var, const char *value,
580 const struct config_context *ctx,
581 void *cb)
582 {
583 struct string_list *values = cb;
584 struct string_list_item *item = string_list_insert(values, var);
585 struct urlmatch_current_candidate_value *matched = item->util;
586 const struct key_value_info *kvi = ctx->kvi;
587
588 if (!matched) {
589 matched = xmalloc(sizeof(*matched));
590 strbuf_init(&matched->value, 0);
591 item->util = matched;
592 } else {
593 strbuf_reset(&matched->value);
594 }
595 matched->kvi = *kvi;
596
597 if (value) {
598 strbuf_addstr(&matched->value, value);
599 matched->value_is_null = 0;
600 } else {
601 matched->value_is_null = 1;
602 }
603 return 0;
604 }
605
606 static int get_urlmatch(const char *var, const char *url)
607 {
608 int ret;
609 char *section_tail;
610 struct string_list_item *item;
611 struct urlmatch_config config = URLMATCH_CONFIG_INIT;
612 struct string_list values = STRING_LIST_INIT_DUP;
613
614 config.collect_fn = urlmatch_collect_fn;
615 config.cascade_fn = NULL;
616 config.cb = &values;
617
618 if (!url_normalize(url, &config.url))
619 die("%s", config.url.err);
620
621 config.section = xstrdup_tolower(var);
622 section_tail = strchr(config.section, '.');
623 if (section_tail) {
624 *section_tail = '\0';
625 config.key = section_tail + 1;
626 show_keys = 0;
627 } else {
628 config.key = NULL;
629 show_keys = 1;
630 }
631
632 config_with_options(urlmatch_config_entry, &config,
633 &given_config_source, the_repository,
634 &config_options);
635
636 ret = !values.nr;
637
638 for_each_string_list_item(item, &values) {
639 struct urlmatch_current_candidate_value *matched = item->util;
640 struct strbuf buf = STRBUF_INIT;
641
642 format_config(&buf, item->string,
643 matched->value_is_null ? NULL : matched->value.buf,
644 &matched->kvi);
645 fwrite(buf.buf, 1, buf.len, stdout);
646 strbuf_release(&buf);
647
648 strbuf_release(&matched->value);
649 }
650 urlmatch_config_release(&config);
651 string_list_clear(&values, 1);
652 free(config.url.url);
653
654 free((void *)config.section);
655 return ret;
656 }
657
658 static char *default_user_config(void)
659 {
660 struct strbuf buf = STRBUF_INIT;
661 strbuf_addf(&buf,
662 _("# This is Git's per-user configuration file.\n"
663 "[user]\n"
664 "# Please adapt and uncomment the following lines:\n"
665 "# name = %s\n"
666 "# email = %s\n"),
667 ident_default_name(),
668 ident_default_email());
669 return strbuf_detach(&buf, NULL);
670 }
671
672 int cmd_config(int argc, const char **argv, const char *prefix)
673 {
674 int nongit = !startup_info->have_repository;
675 char *value = NULL;
676 int flags = 0;
677 int ret = 0;
678 struct key_value_info default_kvi = KVI_INIT;
679
680 given_config_source.file = xstrdup_or_null(getenv(CONFIG_ENVIRONMENT));
681
682 argc = parse_options(argc, argv, prefix, builtin_config_options,
683 builtin_config_usage,
684 PARSE_OPT_STOP_AT_NON_OPTION);
685
686 if (use_global_config + use_system_config + use_local_config +
687 use_worktree_config +
688 !!given_config_source.file + !!given_config_source.blob > 1) {
689 error(_("only one config file at a time"));
690 usage_builtin_config();
691 }
692
693 if (nongit) {
694 if (use_local_config)
695 die(_("--local can only be used inside a git repository"));
696 if (given_config_source.blob)
697 die(_("--blob can only be used inside a git repository"));
698 if (use_worktree_config)
699 die(_("--worktree can only be used inside a git repository"));
700
701 }
702
703 if (given_config_source.file &&
704 !strcmp(given_config_source.file, "-")) {
705 given_config_source.file = NULL;
706 given_config_source.use_stdin = 1;
707 given_config_source.scope = CONFIG_SCOPE_COMMAND;
708 }
709
710 if (use_global_config) {
711 char *user_config, *xdg_config;
712
713 git_global_config(&user_config, &xdg_config);
714 if (!user_config)
715 /*
716 * It is unknown if HOME/.gitconfig exists, so
717 * we do not know if we should write to XDG
718 * location; error out even if XDG_CONFIG_HOME
719 * is set and points at a sane location.
720 */
721 die(_("$HOME not set"));
722
723 given_config_source.scope = CONFIG_SCOPE_GLOBAL;
724
725 if (access_or_warn(user_config, R_OK, 0) &&
726 xdg_config && !access_or_warn(xdg_config, R_OK, 0)) {
727 given_config_source.file = xdg_config;
728 free(user_config);
729 } else {
730 given_config_source.file = user_config;
731 free(xdg_config);
732 }
733 }
734 else if (use_system_config) {
735 given_config_source.file = git_system_config();
736 given_config_source.scope = CONFIG_SCOPE_SYSTEM;
737 } else if (use_local_config) {
738 given_config_source.file = git_pathdup("config");
739 given_config_source.scope = CONFIG_SCOPE_LOCAL;
740 } else if (use_worktree_config) {
741 struct worktree **worktrees = get_worktrees();
742 if (the_repository->repository_format_worktree_config)
743 given_config_source.file = git_pathdup("config.worktree");
744 else if (worktrees[0] && worktrees[1])
745 die(_("--worktree cannot be used with multiple "
746 "working trees unless the config\n"
747 "extension worktreeConfig is enabled. "
748 "Please read \"CONFIGURATION FILE\"\n"
749 "section in \"git help worktree\" for details"));
750 else
751 given_config_source.file = git_pathdup("config");
752 given_config_source.scope = CONFIG_SCOPE_LOCAL;
753 free_worktrees(worktrees);
754 } else if (given_config_source.file) {
755 if (!is_absolute_path(given_config_source.file) && prefix)
756 given_config_source.file =
757 prefix_filename(prefix, given_config_source.file);
758 given_config_source.scope = CONFIG_SCOPE_COMMAND;
759 } else if (given_config_source.blob) {
760 given_config_source.scope = CONFIG_SCOPE_COMMAND;
761 }
762
763
764 if (respect_includes_opt == -1)
765 config_options.respect_includes = !given_config_source.file;
766 else
767 config_options.respect_includes = respect_includes_opt;
768 if (!nongit) {
769 config_options.commondir = get_git_common_dir();
770 config_options.git_dir = get_git_dir();
771 }
772
773 if (end_nul) {
774 term = '\0';
775 delim = '\n';
776 key_delim = '\n';
777 }
778
779 if ((actions & (ACTION_GET_COLOR|ACTION_GET_COLORBOOL)) && type) {
780 error(_("--get-color and variable type are incoherent"));
781 usage_builtin_config();
782 }
783
784 if (HAS_MULTI_BITS(actions)) {
785 error(_("only one action at a time"));
786 usage_builtin_config();
787 }
788 if (actions == 0)
789 switch (argc) {
790 case 1: actions = ACTION_GET; break;
791 case 2: actions = ACTION_SET; break;
792 case 3: actions = ACTION_SET_ALL; break;
793 default:
794 usage_builtin_config();
795 }
796 if (omit_values &&
797 !(actions == ACTION_LIST || actions == ACTION_GET_REGEXP)) {
798 error(_("--name-only is only applicable to --list or --get-regexp"));
799 usage_builtin_config();
800 }
801
802 if (show_origin && !(actions &
803 (ACTION_GET|ACTION_GET_ALL|ACTION_GET_REGEXP|ACTION_LIST))) {
804 error(_("--show-origin is only applicable to --get, --get-all, "
805 "--get-regexp, and --list"));
806 usage_builtin_config();
807 }
808
809 if (default_value && !(actions & ACTION_GET)) {
810 error(_("--default is only applicable to --get"));
811 usage_builtin_config();
812 }
813
814 /* check usage of --fixed-value */
815 if (fixed_value) {
816 int allowed_usage = 0;
817
818 switch (actions) {
819 /* git config --get <name> <value-pattern> */
820 case ACTION_GET:
821 /* git config --get-all <name> <value-pattern> */
822 case ACTION_GET_ALL:
823 /* git config --get-regexp <name-pattern> <value-pattern> */
824 case ACTION_GET_REGEXP:
825 /* git config --unset <name> <value-pattern> */
826 case ACTION_UNSET:
827 /* git config --unset-all <name> <value-pattern> */
828 case ACTION_UNSET_ALL:
829 allowed_usage = argc > 1 && !!argv[1];
830 break;
831
832 /* git config <name> <value> <value-pattern> */
833 case ACTION_SET_ALL:
834 /* git config --replace-all <name> <value> <value-pattern> */
835 case ACTION_REPLACE_ALL:
836 allowed_usage = argc > 2 && !!argv[2];
837 break;
838
839 /* other options don't allow --fixed-value */
840 }
841
842 if (!allowed_usage) {
843 error(_("--fixed-value only applies with 'value-pattern'"));
844 usage_builtin_config();
845 }
846
847 flags |= CONFIG_FLAGS_FIXED_VALUE;
848 }
849
850 if (actions & PAGING_ACTIONS)
851 setup_auto_pager("config", 1);
852
853 if (actions == ACTION_LIST) {
854 check_argc(argc, 0, 0);
855 if (config_with_options(show_all_config, NULL,
856 &given_config_source, the_repository,
857 &config_options) < 0) {
858 if (given_config_source.file)
859 die_errno(_("unable to read config file '%s'"),
860 given_config_source.file);
861 else
862 die(_("error processing config file(s)"));
863 }
864 }
865 else if (actions == ACTION_EDIT) {
866 char *config_file;
867
868 check_argc(argc, 0, 0);
869 if (!given_config_source.file && nongit)
870 die(_("not in a git directory"));
871 if (given_config_source.use_stdin)
872 die(_("editing stdin is not supported"));
873 if (given_config_source.blob)
874 die(_("editing blobs is not supported"));
875 git_config(git_default_config, NULL);
876 config_file = given_config_source.file ?
877 xstrdup(given_config_source.file) :
878 git_pathdup("config");
879 if (use_global_config) {
880 int fd = open(config_file, O_CREAT | O_EXCL | O_WRONLY, 0666);
881 if (fd >= 0) {
882 char *content = default_user_config();
883 write_str_in_full(fd, content);
884 free(content);
885 close(fd);
886 }
887 else if (errno != EEXIST)
888 die_errno(_("cannot create configuration file %s"), config_file);
889 }
890 launch_editor(config_file, NULL, NULL);
891 free(config_file);
892 }
893 else if (actions == ACTION_SET) {
894 check_write();
895 check_argc(argc, 2, 2);
896 value = normalize_value(argv[0], argv[1], &default_kvi);
897 ret = git_config_set_in_file_gently(given_config_source.file, argv[0], value);
898 if (ret == CONFIG_NOTHING_SET)
899 error(_("cannot overwrite multiple values with a single value\n"
900 " Use a regexp, --add or --replace-all to change %s."), argv[0]);
901 }
902 else if (actions == ACTION_SET_ALL) {
903 check_write();
904 check_argc(argc, 2, 3);
905 value = normalize_value(argv[0], argv[1], &default_kvi);
906 ret = git_config_set_multivar_in_file_gently(given_config_source.file,
907 argv[0], value, argv[2],
908 flags);
909 }
910 else if (actions == ACTION_ADD) {
911 check_write();
912 check_argc(argc, 2, 2);
913 value = normalize_value(argv[0], argv[1], &default_kvi);
914 ret = git_config_set_multivar_in_file_gently(given_config_source.file,
915 argv[0], value,
916 CONFIG_REGEX_NONE,
917 flags);
918 }
919 else if (actions == ACTION_REPLACE_ALL) {
920 check_write();
921 check_argc(argc, 2, 3);
922 value = normalize_value(argv[0], argv[1], &default_kvi);
923 ret = git_config_set_multivar_in_file_gently(given_config_source.file,
924 argv[0], value, argv[2],
925 flags | CONFIG_FLAGS_MULTI_REPLACE);
926 }
927 else if (actions == ACTION_GET) {
928 check_argc(argc, 1, 2);
929 return get_value(argv[0], argv[1], flags);
930 }
931 else if (actions == ACTION_GET_ALL) {
932 do_all = 1;
933 check_argc(argc, 1, 2);
934 return get_value(argv[0], argv[1], flags);
935 }
936 else if (actions == ACTION_GET_REGEXP) {
937 show_keys = 1;
938 use_key_regexp = 1;
939 do_all = 1;
940 check_argc(argc, 1, 2);
941 return get_value(argv[0], argv[1], flags);
942 }
943 else if (actions == ACTION_GET_URLMATCH) {
944 check_argc(argc, 2, 2);
945 return get_urlmatch(argv[0], argv[1]);
946 }
947 else if (actions == ACTION_UNSET) {
948 check_write();
949 check_argc(argc, 1, 2);
950 if (argc == 2)
951 return git_config_set_multivar_in_file_gently(given_config_source.file,
952 argv[0], NULL, argv[1],
953 flags);
954 else
955 return git_config_set_in_file_gently(given_config_source.file,
956 argv[0], NULL);
957 }
958 else if (actions == ACTION_UNSET_ALL) {
959 check_write();
960 check_argc(argc, 1, 2);
961 return git_config_set_multivar_in_file_gently(given_config_source.file,
962 argv[0], NULL, argv[1],
963 flags | CONFIG_FLAGS_MULTI_REPLACE);
964 }
965 else if (actions == ACTION_RENAME_SECTION) {
966 check_write();
967 check_argc(argc, 2, 2);
968 ret = git_config_rename_section_in_file(given_config_source.file,
969 argv[0], argv[1]);
970 if (ret < 0)
971 return ret;
972 else if (!ret)
973 die(_("no such section: %s"), argv[0]);
974 else
975 ret = 0;
976 }
977 else if (actions == ACTION_REMOVE_SECTION) {
978 check_write();
979 check_argc(argc, 1, 1);
980 ret = git_config_rename_section_in_file(given_config_source.file,
981 argv[0], NULL);
982 if (ret < 0)
983 return ret;
984 else if (!ret)
985 die(_("no such section: %s"), argv[0]);
986 else
987 ret = 0;
988 }
989 else if (actions == ACTION_GET_COLOR) {
990 check_argc(argc, 1, 2);
991 get_color(argv[0], argv[1]);
992 }
993 else if (actions == ACTION_GET_COLORBOOL) {
994 check_argc(argc, 1, 2);
995 if (argc == 2)
996 color_stdout_is_tty = git_config_bool("command line", argv[1]);
997 return get_colorbool(argv[0], argc == 2);
998 }
999
1000 free(value);
1001 return ret;
1002 }