Git 2.22.2
[git.git] / config.c
blob26196bdccfbc268d7ee669546d39a15e14703494
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "branch.h"
10 #include "config.h"
11 #include "repository.h"
12 #include "lockfile.h"
13 #include "exec-cmd.h"
14 #include "strbuf.h"
15 #include "quote.h"
16 #include "hashmap.h"
17 #include "string-list.h"
18 #include "object-store.h"
19 #include "utf8.h"
20 #include "dir.h"
21 #include "color.h"
23 struct config_source {
24 struct config_source *prev;
25 union {
26 FILE *file;
27 struct config_buf {
28 const char *buf;
29 size_t len;
30 size_t pos;
31 } buf;
32 } u;
33 enum config_origin_type origin_type;
34 const char *name;
35 const char *path;
36 enum config_error_action default_error_action;
37 int linenr;
38 int eof;
39 struct strbuf value;
40 struct strbuf var;
41 unsigned subsection_case_sensitive : 1;
43 int (*do_fgetc)(struct config_source *c);
44 int (*do_ungetc)(int c, struct config_source *conf);
45 long (*do_ftell)(struct config_source *c);
49 * These variables record the "current" config source, which
50 * can be accessed by parsing callbacks.
52 * The "cf" variable will be non-NULL only when we are actually parsing a real
53 * config source (file, blob, cmdline, etc).
55 * The "current_config_kvi" variable will be non-NULL only when we are feeding
56 * cached config from a configset into a callback.
58 * They should generally never be non-NULL at the same time. If they are both
59 * NULL, then we aren't parsing anything (and depending on the function looking
60 * at the variables, it's either a bug for it to be called in the first place,
61 * or it's a function which can be reused for non-config purposes, and should
62 * fall back to some sane behavior).
64 static struct config_source *cf;
65 static struct key_value_info *current_config_kvi;
68 * Similar to the variables above, this gives access to the "scope" of the
69 * current value (repo, global, etc). For cached values, it can be found via
70 * the current_config_kvi as above. During parsing, the current value can be
71 * found in this variable. It's not part of "cf" because it transcends a single
72 * file (i.e., a file included from .git/config is still in "repo" scope).
74 static enum config_scope current_parsing_scope;
76 static int core_compression_seen;
77 static int pack_compression_seen;
78 static int zlib_compression_seen;
80 static int config_file_fgetc(struct config_source *conf)
82 return getc_unlocked(conf->u.file);
85 static int config_file_ungetc(int c, struct config_source *conf)
87 return ungetc(c, conf->u.file);
90 static long config_file_ftell(struct config_source *conf)
92 return ftell(conf->u.file);
96 static int config_buf_fgetc(struct config_source *conf)
98 if (conf->u.buf.pos < conf->u.buf.len)
99 return conf->u.buf.buf[conf->u.buf.pos++];
101 return EOF;
104 static int config_buf_ungetc(int c, struct config_source *conf)
106 if (conf->u.buf.pos > 0) {
107 conf->u.buf.pos--;
108 if (conf->u.buf.buf[conf->u.buf.pos] != c)
109 BUG("config_buf can only ungetc the same character");
110 return c;
113 return EOF;
116 static long config_buf_ftell(struct config_source *conf)
118 return conf->u.buf.pos;
121 #define MAX_INCLUDE_DEPTH 10
122 static const char include_depth_advice[] = N_(
123 "exceeded maximum include depth (%d) while including\n"
124 " %s\n"
125 "from\n"
126 " %s\n"
127 "This might be due to circular includes.");
128 static int handle_path_include(const char *path, struct config_include_data *inc)
130 int ret = 0;
131 struct strbuf buf = STRBUF_INIT;
132 char *expanded;
134 if (!path)
135 return config_error_nonbool("include.path");
137 expanded = expand_user_path(path, 0);
138 if (!expanded)
139 return error(_("could not expand include path '%s'"), path);
140 path = expanded;
143 * Use an absolute path as-is, but interpret relative paths
144 * based on the including config file.
146 if (!is_absolute_path(path)) {
147 char *slash;
149 if (!cf || !cf->path)
150 return error(_("relative config includes must come from files"));
152 slash = find_last_dir_sep(cf->path);
153 if (slash)
154 strbuf_add(&buf, cf->path, slash - cf->path + 1);
155 strbuf_addstr(&buf, path);
156 path = buf.buf;
159 if (!access_or_die(path, R_OK, 0)) {
160 if (++inc->depth > MAX_INCLUDE_DEPTH)
161 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
162 !cf ? "<unknown>" :
163 cf->name ? cf->name :
164 "the command line");
165 ret = git_config_from_file(git_config_include, path, inc);
166 inc->depth--;
168 strbuf_release(&buf);
169 free(expanded);
170 return ret;
173 static int prepare_include_condition_pattern(struct strbuf *pat)
175 struct strbuf path = STRBUF_INIT;
176 char *expanded;
177 int prefix = 0;
179 expanded = expand_user_path(pat->buf, 1);
180 if (expanded) {
181 strbuf_reset(pat);
182 strbuf_addstr(pat, expanded);
183 free(expanded);
186 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
187 const char *slash;
189 if (!cf || !cf->path)
190 return error(_("relative config include "
191 "conditionals must come from files"));
193 strbuf_realpath(&path, cf->path, 1);
194 slash = find_last_dir_sep(path.buf);
195 if (!slash)
196 BUG("how is this possible?");
197 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
198 prefix = slash - path.buf + 1 /* slash */;
199 } else if (!is_absolute_path(pat->buf))
200 strbuf_insert(pat, 0, "**/", 3);
202 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
203 strbuf_addstr(pat, "**");
205 strbuf_release(&path);
206 return prefix;
209 static int include_by_gitdir(const struct config_options *opts,
210 const char *cond, size_t cond_len, int icase)
212 struct strbuf text = STRBUF_INIT;
213 struct strbuf pattern = STRBUF_INIT;
214 int ret = 0, prefix;
215 const char *git_dir;
216 int already_tried_absolute = 0;
218 if (opts->git_dir)
219 git_dir = opts->git_dir;
220 else
221 goto done;
223 strbuf_realpath(&text, git_dir, 1);
224 strbuf_add(&pattern, cond, cond_len);
225 prefix = prepare_include_condition_pattern(&pattern);
227 again:
228 if (prefix < 0)
229 goto done;
231 if (prefix > 0) {
233 * perform literal matching on the prefix part so that
234 * any wildcard character in it can't create side effects.
236 if (text.len < prefix)
237 goto done;
238 if (!icase && strncmp(pattern.buf, text.buf, prefix))
239 goto done;
240 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
241 goto done;
244 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
245 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
247 if (!ret && !already_tried_absolute) {
249 * We've tried e.g. matching gitdir:~/work, but if
250 * ~/work is a symlink to /mnt/storage/work
251 * strbuf_realpath() will expand it, so the rule won't
252 * match. Let's match against a
253 * strbuf_add_absolute_path() version of the path,
254 * which'll do the right thing
256 strbuf_reset(&text);
257 strbuf_add_absolute_path(&text, git_dir);
258 already_tried_absolute = 1;
259 goto again;
261 done:
262 strbuf_release(&pattern);
263 strbuf_release(&text);
264 return ret;
267 static int include_condition_is_true(const struct config_options *opts,
268 const char *cond, size_t cond_len)
271 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
272 return include_by_gitdir(opts, cond, cond_len, 0);
273 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
274 return include_by_gitdir(opts, cond, cond_len, 1);
276 /* unknown conditionals are always false */
277 return 0;
280 int git_config_include(const char *var, const char *value, void *data)
282 struct config_include_data *inc = data;
283 const char *cond, *key;
284 int cond_len;
285 int ret;
288 * Pass along all values, including "include" directives; this makes it
289 * possible to query information on the includes themselves.
291 ret = inc->fn(var, value, inc->data);
292 if (ret < 0)
293 return ret;
295 if (!strcmp(var, "include.path"))
296 ret = handle_path_include(value, inc);
298 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
299 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
300 !strcmp(key, "path"))
301 ret = handle_path_include(value, inc);
303 return ret;
306 void git_config_push_parameter(const char *text)
308 struct strbuf env = STRBUF_INIT;
309 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
310 if (old && *old) {
311 strbuf_addstr(&env, old);
312 strbuf_addch(&env, ' ');
314 sq_quote_buf(&env, text);
315 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
316 strbuf_release(&env);
319 static inline int iskeychar(int c)
321 return isalnum(c) || c == '-';
325 * Auxiliary function to sanity-check and split the key into the section
326 * identifier and variable name.
328 * Returns 0 on success, -1 when there is an invalid character in the key and
329 * -2 if there is no section name in the key.
331 * store_key - pointer to char* which will hold a copy of the key with
332 * lowercase section and variable name
333 * baselen - pointer to int which will hold the length of the
334 * section + subsection part, can be NULL
336 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
338 int i, dot, baselen;
339 const char *last_dot = strrchr(key, '.');
342 * Since "key" actually contains the section name and the real
343 * key name separated by a dot, we have to know where the dot is.
346 if (last_dot == NULL || last_dot == key) {
347 if (!quiet)
348 error(_("key does not contain a section: %s"), key);
349 return -CONFIG_NO_SECTION_OR_NAME;
352 if (!last_dot[1]) {
353 if (!quiet)
354 error(_("key does not contain variable name: %s"), key);
355 return -CONFIG_NO_SECTION_OR_NAME;
358 baselen = last_dot - key;
359 if (baselen_)
360 *baselen_ = baselen;
363 * Validate the key and while at it, lower case it for matching.
365 if (store_key)
366 *store_key = xmallocz(strlen(key));
368 dot = 0;
369 for (i = 0; key[i]; i++) {
370 unsigned char c = key[i];
371 if (c == '.')
372 dot = 1;
373 /* Leave the extended basename untouched.. */
374 if (!dot || i > baselen) {
375 if (!iskeychar(c) ||
376 (i == baselen + 1 && !isalpha(c))) {
377 if (!quiet)
378 error(_("invalid key: %s"), key);
379 goto out_free_ret_1;
381 c = tolower(c);
382 } else if (c == '\n') {
383 if (!quiet)
384 error(_("invalid key (newline): %s"), key);
385 goto out_free_ret_1;
387 if (store_key)
388 (*store_key)[i] = c;
391 return 0;
393 out_free_ret_1:
394 if (store_key) {
395 FREE_AND_NULL(*store_key);
397 return -CONFIG_INVALID_KEY;
400 int git_config_parse_key(const char *key, char **store_key, int *baselen)
402 return git_config_parse_key_1(key, store_key, baselen, 0);
405 int git_config_key_is_valid(const char *key)
407 return !git_config_parse_key_1(key, NULL, NULL, 1);
410 int git_config_parse_parameter(const char *text,
411 config_fn_t fn, void *data)
413 const char *value;
414 char *canonical_name;
415 struct strbuf **pair;
416 int ret;
418 pair = strbuf_split_str(text, '=', 2);
419 if (!pair[0])
420 return error(_("bogus config parameter: %s"), text);
422 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
423 strbuf_setlen(pair[0], pair[0]->len - 1);
424 value = pair[1] ? pair[1]->buf : "";
425 } else {
426 value = NULL;
429 strbuf_trim(pair[0]);
430 if (!pair[0]->len) {
431 strbuf_list_free(pair);
432 return error(_("bogus config parameter: %s"), text);
435 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
436 ret = -1;
437 } else {
438 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
439 free(canonical_name);
441 strbuf_list_free(pair);
442 return ret;
445 int git_config_from_parameters(config_fn_t fn, void *data)
447 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
448 int ret = 0;
449 char *envw;
450 const char **argv = NULL;
451 int nr = 0, alloc = 0;
452 int i;
453 struct config_source source;
455 if (!env)
456 return 0;
458 memset(&source, 0, sizeof(source));
459 source.prev = cf;
460 source.origin_type = CONFIG_ORIGIN_CMDLINE;
461 cf = &source;
463 /* sq_dequote will write over it */
464 envw = xstrdup(env);
466 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
467 ret = error(_("bogus format in %s"), CONFIG_DATA_ENVIRONMENT);
468 goto out;
471 for (i = 0; i < nr; i++) {
472 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
473 ret = -1;
474 goto out;
478 out:
479 free(argv);
480 free(envw);
481 cf = source.prev;
482 return ret;
485 static int get_next_char(void)
487 int c = cf->do_fgetc(cf);
489 if (c == '\r') {
490 /* DOS like systems */
491 c = cf->do_fgetc(cf);
492 if (c != '\n') {
493 if (c != EOF)
494 cf->do_ungetc(c, cf);
495 c = '\r';
498 if (c == '\n')
499 cf->linenr++;
500 if (c == EOF) {
501 cf->eof = 1;
502 cf->linenr++;
503 c = '\n';
505 return c;
508 static char *parse_value(void)
510 int quote = 0, comment = 0, space = 0;
512 strbuf_reset(&cf->value);
513 for (;;) {
514 int c = get_next_char();
515 if (c == '\n') {
516 if (quote) {
517 cf->linenr--;
518 return NULL;
520 return cf->value.buf;
522 if (comment)
523 continue;
524 if (isspace(c) && !quote) {
525 if (cf->value.len)
526 space++;
527 continue;
529 if (!quote) {
530 if (c == ';' || c == '#') {
531 comment = 1;
532 continue;
535 for (; space; space--)
536 strbuf_addch(&cf->value, ' ');
537 if (c == '\\') {
538 c = get_next_char();
539 switch (c) {
540 case '\n':
541 continue;
542 case 't':
543 c = '\t';
544 break;
545 case 'b':
546 c = '\b';
547 break;
548 case 'n':
549 c = '\n';
550 break;
551 /* Some characters escape as themselves */
552 case '\\': case '"':
553 break;
554 /* Reject unknown escape sequences */
555 default:
556 return NULL;
558 strbuf_addch(&cf->value, c);
559 continue;
561 if (c == '"') {
562 quote = 1-quote;
563 continue;
565 strbuf_addch(&cf->value, c);
569 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
571 int c;
572 char *value;
573 int ret;
575 /* Get the full name */
576 for (;;) {
577 c = get_next_char();
578 if (cf->eof)
579 break;
580 if (!iskeychar(c))
581 break;
582 strbuf_addch(name, tolower(c));
585 while (c == ' ' || c == '\t')
586 c = get_next_char();
588 value = NULL;
589 if (c != '\n') {
590 if (c != '=')
591 return -1;
592 value = parse_value();
593 if (!value)
594 return -1;
597 * We already consumed the \n, but we need linenr to point to
598 * the line we just parsed during the call to fn to get
599 * accurate line number in error messages.
601 cf->linenr--;
602 ret = fn(name->buf, value, data);
603 if (ret >= 0)
604 cf->linenr++;
605 return ret;
608 static int get_extended_base_var(struct strbuf *name, int c)
610 cf->subsection_case_sensitive = 0;
611 do {
612 if (c == '\n')
613 goto error_incomplete_line;
614 c = get_next_char();
615 } while (isspace(c));
617 /* We require the format to be '[base "extension"]' */
618 if (c != '"')
619 return -1;
620 strbuf_addch(name, '.');
622 for (;;) {
623 int c = get_next_char();
624 if (c == '\n')
625 goto error_incomplete_line;
626 if (c == '"')
627 break;
628 if (c == '\\') {
629 c = get_next_char();
630 if (c == '\n')
631 goto error_incomplete_line;
633 strbuf_addch(name, c);
636 /* Final ']' */
637 if (get_next_char() != ']')
638 return -1;
639 return 0;
640 error_incomplete_line:
641 cf->linenr--;
642 return -1;
645 static int get_base_var(struct strbuf *name)
647 cf->subsection_case_sensitive = 1;
648 for (;;) {
649 int c = get_next_char();
650 if (cf->eof)
651 return -1;
652 if (c == ']')
653 return 0;
654 if (isspace(c))
655 return get_extended_base_var(name, c);
656 if (!iskeychar(c) && c != '.')
657 return -1;
658 strbuf_addch(name, tolower(c));
662 struct parse_event_data {
663 enum config_event_t previous_type;
664 size_t previous_offset;
665 const struct config_options *opts;
668 static int do_event(enum config_event_t type, struct parse_event_data *data)
670 size_t offset;
672 if (!data->opts || !data->opts->event_fn)
673 return 0;
675 if (type == CONFIG_EVENT_WHITESPACE &&
676 data->previous_type == type)
677 return 0;
679 offset = cf->do_ftell(cf);
681 * At EOF, the parser always "inserts" an extra '\n', therefore
682 * the end offset of the event is the current file position, otherwise
683 * we will already have advanced to the next event.
685 if (type != CONFIG_EVENT_EOF)
686 offset--;
688 if (data->previous_type != CONFIG_EVENT_EOF &&
689 data->opts->event_fn(data->previous_type, data->previous_offset,
690 offset, data->opts->event_fn_data) < 0)
691 return -1;
693 data->previous_type = type;
694 data->previous_offset = offset;
696 return 0;
699 static int git_parse_source(config_fn_t fn, void *data,
700 const struct config_options *opts)
702 int comment = 0;
703 int baselen = 0;
704 struct strbuf *var = &cf->var;
705 int error_return = 0;
706 char *error_msg = NULL;
708 /* U+FEFF Byte Order Mark in UTF8 */
709 const char *bomptr = utf8_bom;
711 /* For the parser event callback */
712 struct parse_event_data event_data = {
713 CONFIG_EVENT_EOF, 0, opts
716 for (;;) {
717 int c;
719 c = get_next_char();
720 if (bomptr && *bomptr) {
721 /* We are at the file beginning; skip UTF8-encoded BOM
722 * if present. Sane editors won't put this in on their
723 * own, but e.g. Windows Notepad will do it happily. */
724 if (c == (*bomptr & 0377)) {
725 bomptr++;
726 continue;
727 } else {
728 /* Do not tolerate partial BOM. */
729 if (bomptr != utf8_bom)
730 break;
731 /* No BOM at file beginning. Cool. */
732 bomptr = NULL;
735 if (c == '\n') {
736 if (cf->eof) {
737 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
738 return -1;
739 return 0;
741 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
742 return -1;
743 comment = 0;
744 continue;
746 if (comment)
747 continue;
748 if (isspace(c)) {
749 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
750 return -1;
751 continue;
753 if (c == '#' || c == ';') {
754 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
755 return -1;
756 comment = 1;
757 continue;
759 if (c == '[') {
760 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
761 return -1;
763 /* Reset prior to determining a new stem */
764 strbuf_reset(var);
765 if (get_base_var(var) < 0 || var->len < 1)
766 break;
767 strbuf_addch(var, '.');
768 baselen = var->len;
769 continue;
771 if (!isalpha(c))
772 break;
774 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
775 return -1;
778 * Truncate the var name back to the section header
779 * stem prior to grabbing the suffix part of the name
780 * and the value.
782 strbuf_setlen(var, baselen);
783 strbuf_addch(var, tolower(c));
784 if (get_value(fn, data, var) < 0)
785 break;
788 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
789 return -1;
791 switch (cf->origin_type) {
792 case CONFIG_ORIGIN_BLOB:
793 error_msg = xstrfmt(_("bad config line %d in blob %s"),
794 cf->linenr, cf->name);
795 break;
796 case CONFIG_ORIGIN_FILE:
797 error_msg = xstrfmt(_("bad config line %d in file %s"),
798 cf->linenr, cf->name);
799 break;
800 case CONFIG_ORIGIN_STDIN:
801 error_msg = xstrfmt(_("bad config line %d in standard input"),
802 cf->linenr);
803 break;
804 case CONFIG_ORIGIN_SUBMODULE_BLOB:
805 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
806 cf->linenr, cf->name);
807 break;
808 case CONFIG_ORIGIN_CMDLINE:
809 error_msg = xstrfmt(_("bad config line %d in command line %s"),
810 cf->linenr, cf->name);
811 break;
812 default:
813 error_msg = xstrfmt(_("bad config line %d in %s"),
814 cf->linenr, cf->name);
817 switch (opts && opts->error_action ?
818 opts->error_action :
819 cf->default_error_action) {
820 case CONFIG_ERROR_DIE:
821 die("%s", error_msg);
822 break;
823 case CONFIG_ERROR_ERROR:
824 error_return = error("%s", error_msg);
825 break;
826 case CONFIG_ERROR_SILENT:
827 error_return = -1;
828 break;
829 case CONFIG_ERROR_UNSET:
830 BUG("config error action unset");
833 free(error_msg);
834 return error_return;
837 static uintmax_t get_unit_factor(const char *end)
839 if (!*end)
840 return 1;
841 else if (!strcasecmp(end, "k"))
842 return 1024;
843 else if (!strcasecmp(end, "m"))
844 return 1024 * 1024;
845 else if (!strcasecmp(end, "g"))
846 return 1024 * 1024 * 1024;
847 return 0;
850 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
852 if (value && *value) {
853 char *end;
854 intmax_t val;
855 uintmax_t uval;
856 uintmax_t factor;
858 errno = 0;
859 val = strtoimax(value, &end, 0);
860 if (errno == ERANGE)
861 return 0;
862 factor = get_unit_factor(end);
863 if (!factor) {
864 errno = EINVAL;
865 return 0;
867 uval = val < 0 ? -val : val;
868 if (unsigned_mult_overflows(factor, uval) ||
869 factor * uval > max) {
870 errno = ERANGE;
871 return 0;
873 val *= factor;
874 *ret = val;
875 return 1;
877 errno = EINVAL;
878 return 0;
881 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
883 if (value && *value) {
884 char *end;
885 uintmax_t val;
886 uintmax_t factor;
888 errno = 0;
889 val = strtoumax(value, &end, 0);
890 if (errno == ERANGE)
891 return 0;
892 factor = get_unit_factor(end);
893 if (!factor) {
894 errno = EINVAL;
895 return 0;
897 if (unsigned_mult_overflows(factor, val) ||
898 factor * val > max) {
899 errno = ERANGE;
900 return 0;
902 val *= factor;
903 *ret = val;
904 return 1;
906 errno = EINVAL;
907 return 0;
910 static int git_parse_int(const char *value, int *ret)
912 intmax_t tmp;
913 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
914 return 0;
915 *ret = tmp;
916 return 1;
919 static int git_parse_int64(const char *value, int64_t *ret)
921 intmax_t tmp;
922 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
923 return 0;
924 *ret = tmp;
925 return 1;
928 int git_parse_ulong(const char *value, unsigned long *ret)
930 uintmax_t tmp;
931 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
932 return 0;
933 *ret = tmp;
934 return 1;
937 int git_parse_ssize_t(const char *value, ssize_t *ret)
939 intmax_t tmp;
940 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
941 return 0;
942 *ret = tmp;
943 return 1;
946 NORETURN
947 static void die_bad_number(const char *name, const char *value)
949 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
951 if (!value)
952 value = "";
954 if (!(cf && cf->name))
955 die(_("bad numeric config value '%s' for '%s': %s"),
956 value, name, error_type);
958 switch (cf->origin_type) {
959 case CONFIG_ORIGIN_BLOB:
960 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
961 value, name, cf->name, error_type);
962 case CONFIG_ORIGIN_FILE:
963 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
964 value, name, cf->name, error_type);
965 case CONFIG_ORIGIN_STDIN:
966 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
967 value, name, error_type);
968 case CONFIG_ORIGIN_SUBMODULE_BLOB:
969 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
970 value, name, cf->name, error_type);
971 case CONFIG_ORIGIN_CMDLINE:
972 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
973 value, name, cf->name, error_type);
974 default:
975 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
976 value, name, cf->name, error_type);
980 int git_config_int(const char *name, const char *value)
982 int ret;
983 if (!git_parse_int(value, &ret))
984 die_bad_number(name, value);
985 return ret;
988 int64_t git_config_int64(const char *name, const char *value)
990 int64_t ret;
991 if (!git_parse_int64(value, &ret))
992 die_bad_number(name, value);
993 return ret;
996 unsigned long git_config_ulong(const char *name, const char *value)
998 unsigned long ret;
999 if (!git_parse_ulong(value, &ret))
1000 die_bad_number(name, value);
1001 return ret;
1004 ssize_t git_config_ssize_t(const char *name, const char *value)
1006 ssize_t ret;
1007 if (!git_parse_ssize_t(value, &ret))
1008 die_bad_number(name, value);
1009 return ret;
1012 static int git_parse_maybe_bool_text(const char *value)
1014 if (!value)
1015 return 1;
1016 if (!*value)
1017 return 0;
1018 if (!strcasecmp(value, "true")
1019 || !strcasecmp(value, "yes")
1020 || !strcasecmp(value, "on"))
1021 return 1;
1022 if (!strcasecmp(value, "false")
1023 || !strcasecmp(value, "no")
1024 || !strcasecmp(value, "off"))
1025 return 0;
1026 return -1;
1029 int git_parse_maybe_bool(const char *value)
1031 int v = git_parse_maybe_bool_text(value);
1032 if (0 <= v)
1033 return v;
1034 if (git_parse_int(value, &v))
1035 return !!v;
1036 return -1;
1039 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1041 int v = git_parse_maybe_bool_text(value);
1042 if (0 <= v) {
1043 *is_bool = 1;
1044 return v;
1046 *is_bool = 0;
1047 return git_config_int(name, value);
1050 int git_config_bool(const char *name, const char *value)
1052 int discard;
1053 return !!git_config_bool_or_int(name, value, &discard);
1056 int git_config_string(const char **dest, const char *var, const char *value)
1058 if (!value)
1059 return config_error_nonbool(var);
1060 *dest = xstrdup(value);
1061 return 0;
1064 int git_config_pathname(const char **dest, const char *var, const char *value)
1066 if (!value)
1067 return config_error_nonbool(var);
1068 *dest = expand_user_path(value, 0);
1069 if (!*dest)
1070 die(_("failed to expand user dir in: '%s'"), value);
1071 return 0;
1074 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1076 if (!value)
1077 return config_error_nonbool(var);
1078 if (parse_expiry_date(value, timestamp))
1079 return error(_("'%s' for '%s' is not a valid timestamp"),
1080 value, var);
1081 return 0;
1084 int git_config_color(char *dest, const char *var, const char *value)
1086 if (!value)
1087 return config_error_nonbool(var);
1088 if (color_parse(value, dest) < 0)
1089 return -1;
1090 return 0;
1093 static int git_default_core_config(const char *var, const char *value, void *cb)
1095 /* This needs a better name */
1096 if (!strcmp(var, "core.filemode")) {
1097 trust_executable_bit = git_config_bool(var, value);
1098 return 0;
1100 if (!strcmp(var, "core.trustctime")) {
1101 trust_ctime = git_config_bool(var, value);
1102 return 0;
1104 if (!strcmp(var, "core.checkstat")) {
1105 if (!strcasecmp(value, "default"))
1106 check_stat = 1;
1107 else if (!strcasecmp(value, "minimal"))
1108 check_stat = 0;
1111 if (!strcmp(var, "core.quotepath")) {
1112 quote_path_fully = git_config_bool(var, value);
1113 return 0;
1116 if (!strcmp(var, "core.symlinks")) {
1117 has_symlinks = git_config_bool(var, value);
1118 return 0;
1121 if (!strcmp(var, "core.ignorecase")) {
1122 ignore_case = git_config_bool(var, value);
1123 return 0;
1126 if (!strcmp(var, "core.attributesfile"))
1127 return git_config_pathname(&git_attributes_file, var, value);
1129 if (!strcmp(var, "core.hookspath"))
1130 return git_config_pathname(&git_hooks_path, var, value);
1132 if (!strcmp(var, "core.bare")) {
1133 is_bare_repository_cfg = git_config_bool(var, value);
1134 return 0;
1137 if (!strcmp(var, "core.ignorestat")) {
1138 assume_unchanged = git_config_bool(var, value);
1139 return 0;
1142 if (!strcmp(var, "core.prefersymlinkrefs")) {
1143 prefer_symlink_refs = git_config_bool(var, value);
1144 return 0;
1147 if (!strcmp(var, "core.logallrefupdates")) {
1148 if (value && !strcasecmp(value, "always"))
1149 log_all_ref_updates = LOG_REFS_ALWAYS;
1150 else if (git_config_bool(var, value))
1151 log_all_ref_updates = LOG_REFS_NORMAL;
1152 else
1153 log_all_ref_updates = LOG_REFS_NONE;
1154 return 0;
1157 if (!strcmp(var, "core.warnambiguousrefs")) {
1158 warn_ambiguous_refs = git_config_bool(var, value);
1159 return 0;
1162 if (!strcmp(var, "core.abbrev")) {
1163 if (!value)
1164 return config_error_nonbool(var);
1165 if (!strcasecmp(value, "auto"))
1166 default_abbrev = -1;
1167 else {
1168 int abbrev = git_config_int(var, value);
1169 if (abbrev < minimum_abbrev || abbrev > 40)
1170 return error(_("abbrev length out of range: %d"), abbrev);
1171 default_abbrev = abbrev;
1173 return 0;
1176 if (!strcmp(var, "core.disambiguate"))
1177 return set_disambiguate_hint_config(var, value);
1179 if (!strcmp(var, "core.loosecompression")) {
1180 int level = git_config_int(var, value);
1181 if (level == -1)
1182 level = Z_DEFAULT_COMPRESSION;
1183 else if (level < 0 || level > Z_BEST_COMPRESSION)
1184 die(_("bad zlib compression level %d"), level);
1185 zlib_compression_level = level;
1186 zlib_compression_seen = 1;
1187 return 0;
1190 if (!strcmp(var, "core.compression")) {
1191 int level = git_config_int(var, value);
1192 if (level == -1)
1193 level = Z_DEFAULT_COMPRESSION;
1194 else if (level < 0 || level > Z_BEST_COMPRESSION)
1195 die(_("bad zlib compression level %d"), level);
1196 core_compression_level = level;
1197 core_compression_seen = 1;
1198 if (!zlib_compression_seen)
1199 zlib_compression_level = level;
1200 if (!pack_compression_seen)
1201 pack_compression_level = level;
1202 return 0;
1205 if (!strcmp(var, "core.packedgitwindowsize")) {
1206 int pgsz_x2 = getpagesize() * 2;
1207 packed_git_window_size = git_config_ulong(var, value);
1209 /* This value must be multiple of (pagesize * 2) */
1210 packed_git_window_size /= pgsz_x2;
1211 if (packed_git_window_size < 1)
1212 packed_git_window_size = 1;
1213 packed_git_window_size *= pgsz_x2;
1214 return 0;
1217 if (!strcmp(var, "core.bigfilethreshold")) {
1218 big_file_threshold = git_config_ulong(var, value);
1219 return 0;
1222 if (!strcmp(var, "core.packedgitlimit")) {
1223 packed_git_limit = git_config_ulong(var, value);
1224 return 0;
1227 if (!strcmp(var, "core.deltabasecachelimit")) {
1228 delta_base_cache_limit = git_config_ulong(var, value);
1229 return 0;
1232 if (!strcmp(var, "core.autocrlf")) {
1233 if (value && !strcasecmp(value, "input")) {
1234 auto_crlf = AUTO_CRLF_INPUT;
1235 return 0;
1237 auto_crlf = git_config_bool(var, value);
1238 return 0;
1241 if (!strcmp(var, "core.safecrlf")) {
1242 int eol_rndtrp_die;
1243 if (value && !strcasecmp(value, "warn")) {
1244 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1245 return 0;
1247 eol_rndtrp_die = git_config_bool(var, value);
1248 global_conv_flags_eol = eol_rndtrp_die ?
1249 CONV_EOL_RNDTRP_DIE : 0;
1250 return 0;
1253 if (!strcmp(var, "core.eol")) {
1254 if (value && !strcasecmp(value, "lf"))
1255 core_eol = EOL_LF;
1256 else if (value && !strcasecmp(value, "crlf"))
1257 core_eol = EOL_CRLF;
1258 else if (value && !strcasecmp(value, "native"))
1259 core_eol = EOL_NATIVE;
1260 else
1261 core_eol = EOL_UNSET;
1262 return 0;
1265 if (!strcmp(var, "core.checkroundtripencoding")) {
1266 check_roundtrip_encoding = xstrdup(value);
1267 return 0;
1270 if (!strcmp(var, "core.notesref")) {
1271 notes_ref_name = xstrdup(value);
1272 return 0;
1275 if (!strcmp(var, "core.editor"))
1276 return git_config_string(&editor_program, var, value);
1278 if (!strcmp(var, "core.commentchar")) {
1279 if (!value)
1280 return config_error_nonbool(var);
1281 else if (!strcasecmp(value, "auto"))
1282 auto_comment_line_char = 1;
1283 else if (value[0] && !value[1]) {
1284 comment_line_char = value[0];
1285 auto_comment_line_char = 0;
1286 } else
1287 return error(_("core.commentChar should only be one character"));
1288 return 0;
1291 if (!strcmp(var, "core.askpass"))
1292 return git_config_string(&askpass_program, var, value);
1294 if (!strcmp(var, "core.excludesfile"))
1295 return git_config_pathname(&excludes_file, var, value);
1297 if (!strcmp(var, "core.whitespace")) {
1298 if (!value)
1299 return config_error_nonbool(var);
1300 whitespace_rule_cfg = parse_whitespace_rule(value);
1301 return 0;
1304 if (!strcmp(var, "core.fsyncobjectfiles")) {
1305 fsync_object_files = git_config_bool(var, value);
1306 return 0;
1309 if (!strcmp(var, "core.preloadindex")) {
1310 core_preload_index = git_config_bool(var, value);
1311 return 0;
1314 if (!strcmp(var, "core.createobject")) {
1315 if (!strcmp(value, "rename"))
1316 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1317 else if (!strcmp(value, "link"))
1318 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1319 else
1320 die(_("invalid mode for object creation: %s"), value);
1321 return 0;
1324 if (!strcmp(var, "core.sparsecheckout")) {
1325 core_apply_sparse_checkout = git_config_bool(var, value);
1326 return 0;
1329 if (!strcmp(var, "core.precomposeunicode")) {
1330 precomposed_unicode = git_config_bool(var, value);
1331 return 0;
1334 if (!strcmp(var, "core.protecthfs")) {
1335 protect_hfs = git_config_bool(var, value);
1336 return 0;
1339 if (!strcmp(var, "core.protectntfs")) {
1340 protect_ntfs = git_config_bool(var, value);
1341 return 0;
1344 if (!strcmp(var, "core.partialclonefilter")) {
1345 return git_config_string(&core_partial_clone_filter_default,
1346 var, value);
1349 if (!strcmp(var, "core.usereplacerefs")) {
1350 read_replace_refs = git_config_bool(var, value);
1351 return 0;
1354 /* Add other config variables here and to Documentation/config.txt. */
1355 return platform_core_config(var, value, cb);
1358 static int git_default_i18n_config(const char *var, const char *value)
1360 if (!strcmp(var, "i18n.commitencoding"))
1361 return git_config_string(&git_commit_encoding, var, value);
1363 if (!strcmp(var, "i18n.logoutputencoding"))
1364 return git_config_string(&git_log_output_encoding, var, value);
1366 /* Add other config variables here and to Documentation/config.txt. */
1367 return 0;
1370 static int git_default_branch_config(const char *var, const char *value)
1372 if (!strcmp(var, "branch.autosetupmerge")) {
1373 if (value && !strcasecmp(value, "always")) {
1374 git_branch_track = BRANCH_TRACK_ALWAYS;
1375 return 0;
1377 git_branch_track = git_config_bool(var, value);
1378 return 0;
1380 if (!strcmp(var, "branch.autosetuprebase")) {
1381 if (!value)
1382 return config_error_nonbool(var);
1383 else if (!strcmp(value, "never"))
1384 autorebase = AUTOREBASE_NEVER;
1385 else if (!strcmp(value, "local"))
1386 autorebase = AUTOREBASE_LOCAL;
1387 else if (!strcmp(value, "remote"))
1388 autorebase = AUTOREBASE_REMOTE;
1389 else if (!strcmp(value, "always"))
1390 autorebase = AUTOREBASE_ALWAYS;
1391 else
1392 return error(_("malformed value for %s"), var);
1393 return 0;
1396 /* Add other config variables here and to Documentation/config.txt. */
1397 return 0;
1400 static int git_default_push_config(const char *var, const char *value)
1402 if (!strcmp(var, "push.default")) {
1403 if (!value)
1404 return config_error_nonbool(var);
1405 else if (!strcmp(value, "nothing"))
1406 push_default = PUSH_DEFAULT_NOTHING;
1407 else if (!strcmp(value, "matching"))
1408 push_default = PUSH_DEFAULT_MATCHING;
1409 else if (!strcmp(value, "simple"))
1410 push_default = PUSH_DEFAULT_SIMPLE;
1411 else if (!strcmp(value, "upstream"))
1412 push_default = PUSH_DEFAULT_UPSTREAM;
1413 else if (!strcmp(value, "tracking")) /* deprecated */
1414 push_default = PUSH_DEFAULT_UPSTREAM;
1415 else if (!strcmp(value, "current"))
1416 push_default = PUSH_DEFAULT_CURRENT;
1417 else {
1418 error(_("malformed value for %s: %s"), var, value);
1419 return error(_("must be one of nothing, matching, simple, "
1420 "upstream or current"));
1422 return 0;
1425 /* Add other config variables here and to Documentation/config.txt. */
1426 return 0;
1429 static int git_default_mailmap_config(const char *var, const char *value)
1431 if (!strcmp(var, "mailmap.file"))
1432 return git_config_pathname(&git_mailmap_file, var, value);
1433 if (!strcmp(var, "mailmap.blob"))
1434 return git_config_string(&git_mailmap_blob, var, value);
1436 /* Add other config variables here and to Documentation/config.txt. */
1437 return 0;
1440 int git_default_config(const char *var, const char *value, void *cb)
1442 if (starts_with(var, "core."))
1443 return git_default_core_config(var, value, cb);
1445 if (starts_with(var, "user.") ||
1446 starts_with(var, "author.") ||
1447 starts_with(var, "committer."))
1448 return git_ident_config(var, value, cb);
1450 if (starts_with(var, "i18n."))
1451 return git_default_i18n_config(var, value);
1453 if (starts_with(var, "branch."))
1454 return git_default_branch_config(var, value);
1456 if (starts_with(var, "push."))
1457 return git_default_push_config(var, value);
1459 if (starts_with(var, "mailmap."))
1460 return git_default_mailmap_config(var, value);
1462 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1463 return git_default_advice_config(var, value);
1465 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1466 pager_use_color = git_config_bool(var,value);
1467 return 0;
1470 if (!strcmp(var, "pack.packsizelimit")) {
1471 pack_size_limit_cfg = git_config_ulong(var, value);
1472 return 0;
1475 if (!strcmp(var, "pack.compression")) {
1476 int level = git_config_int(var, value);
1477 if (level == -1)
1478 level = Z_DEFAULT_COMPRESSION;
1479 else if (level < 0 || level > Z_BEST_COMPRESSION)
1480 die(_("bad pack compression level %d"), level);
1481 pack_compression_level = level;
1482 pack_compression_seen = 1;
1483 return 0;
1486 /* Add other config variables here and to Documentation/config.txt. */
1487 return 0;
1491 * All source specific fields in the union, die_on_error, name and the callbacks
1492 * fgetc, ungetc, ftell of top need to be initialized before calling
1493 * this function.
1495 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1496 const struct config_options *opts)
1498 int ret;
1500 /* push config-file parsing state stack */
1501 top->prev = cf;
1502 top->linenr = 1;
1503 top->eof = 0;
1504 strbuf_init(&top->value, 1024);
1505 strbuf_init(&top->var, 1024);
1506 cf = top;
1508 ret = git_parse_source(fn, data, opts);
1510 /* pop config-file parsing state stack */
1511 strbuf_release(&top->value);
1512 strbuf_release(&top->var);
1513 cf = top->prev;
1515 return ret;
1518 static int do_config_from_file(config_fn_t fn,
1519 const enum config_origin_type origin_type,
1520 const char *name, const char *path, FILE *f,
1521 void *data, const struct config_options *opts)
1523 struct config_source top;
1524 int ret;
1526 top.u.file = f;
1527 top.origin_type = origin_type;
1528 top.name = name;
1529 top.path = path;
1530 top.default_error_action = CONFIG_ERROR_DIE;
1531 top.do_fgetc = config_file_fgetc;
1532 top.do_ungetc = config_file_ungetc;
1533 top.do_ftell = config_file_ftell;
1535 flockfile(f);
1536 ret = do_config_from(&top, fn, data, opts);
1537 funlockfile(f);
1538 return ret;
1541 static int git_config_from_stdin(config_fn_t fn, void *data)
1543 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1544 data, NULL);
1547 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1548 void *data,
1549 const struct config_options *opts)
1551 int ret = -1;
1552 FILE *f;
1554 f = fopen_or_warn(filename, "r");
1555 if (f) {
1556 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1557 filename, f, data, opts);
1558 fclose(f);
1560 return ret;
1563 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1565 return git_config_from_file_with_options(fn, filename, data, NULL);
1568 int git_config_from_mem(config_fn_t fn,
1569 const enum config_origin_type origin_type,
1570 const char *name, const char *buf, size_t len,
1571 void *data, const struct config_options *opts)
1573 struct config_source top;
1575 top.u.buf.buf = buf;
1576 top.u.buf.len = len;
1577 top.u.buf.pos = 0;
1578 top.origin_type = origin_type;
1579 top.name = name;
1580 top.path = NULL;
1581 top.default_error_action = CONFIG_ERROR_ERROR;
1582 top.do_fgetc = config_buf_fgetc;
1583 top.do_ungetc = config_buf_ungetc;
1584 top.do_ftell = config_buf_ftell;
1586 return do_config_from(&top, fn, data, opts);
1589 int git_config_from_blob_oid(config_fn_t fn,
1590 const char *name,
1591 const struct object_id *oid,
1592 void *data)
1594 enum object_type type;
1595 char *buf;
1596 unsigned long size;
1597 int ret;
1599 buf = read_object_file(oid, &type, &size);
1600 if (!buf)
1601 return error(_("unable to load config blob object '%s'"), name);
1602 if (type != OBJ_BLOB) {
1603 free(buf);
1604 return error(_("reference '%s' does not point to a blob"), name);
1607 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1608 data, NULL);
1609 free(buf);
1611 return ret;
1614 static int git_config_from_blob_ref(config_fn_t fn,
1615 const char *name,
1616 void *data)
1618 struct object_id oid;
1620 if (get_oid(name, &oid) < 0)
1621 return error(_("unable to resolve config blob '%s'"), name);
1622 return git_config_from_blob_oid(fn, name, &oid, data);
1625 const char *git_etc_gitconfig(void)
1627 static const char *system_wide;
1628 if (!system_wide)
1629 system_wide = system_path(ETC_GITCONFIG);
1630 return system_wide;
1634 * Parse environment variable 'k' as a boolean (in various
1635 * possible spellings); if missing, use the default value 'def'.
1637 int git_env_bool(const char *k, int def)
1639 const char *v = getenv(k);
1640 return v ? git_config_bool(k, v) : def;
1644 * Parse environment variable 'k' as ulong with possibly a unit
1645 * suffix; if missing, use the default value 'val'.
1647 unsigned long git_env_ulong(const char *k, unsigned long val)
1649 const char *v = getenv(k);
1650 if (v && !git_parse_ulong(v, &val))
1651 die(_("failed to parse %s"), k);
1652 return val;
1655 int git_config_system(void)
1657 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1660 static int do_git_config_sequence(const struct config_options *opts,
1661 config_fn_t fn, void *data)
1663 int ret = 0;
1664 char *xdg_config = xdg_config_home("config");
1665 char *user_config = expand_user_path("~/.gitconfig", 0);
1666 char *repo_config;
1668 if (opts->commondir)
1669 repo_config = mkpathdup("%s/config", opts->commondir);
1670 else if (opts->git_dir)
1671 BUG("git_dir without commondir");
1672 else
1673 repo_config = NULL;
1675 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1676 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK,
1677 opts->system_gently ?
1678 ACCESS_EACCES_OK : 0))
1679 ret += git_config_from_file(fn, git_etc_gitconfig(),
1680 data);
1682 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1683 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1684 ret += git_config_from_file(fn, xdg_config, data);
1686 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1687 ret += git_config_from_file(fn, user_config, data);
1689 current_parsing_scope = CONFIG_SCOPE_REPO;
1690 if (!opts->ignore_repo && repo_config &&
1691 !access_or_die(repo_config, R_OK, 0))
1692 ret += git_config_from_file(fn, repo_config, data);
1695 * Note: this should have a new scope, CONFIG_SCOPE_WORKTREE.
1696 * But let's not complicate things before it's actually needed.
1698 if (!opts->ignore_worktree && repository_format_worktree_config) {
1699 char *path = git_pathdup("config.worktree");
1700 if (!access_or_die(path, R_OK, 0))
1701 ret += git_config_from_file(fn, path, data);
1702 free(path);
1705 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1706 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
1707 die(_("unable to parse command-line config"));
1709 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1710 free(xdg_config);
1711 free(user_config);
1712 free(repo_config);
1713 return ret;
1716 int config_with_options(config_fn_t fn, void *data,
1717 struct git_config_source *config_source,
1718 const struct config_options *opts)
1720 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1722 if (opts->respect_includes) {
1723 inc.fn = fn;
1724 inc.data = data;
1725 inc.opts = opts;
1726 fn = git_config_include;
1727 data = &inc;
1731 * If we have a specific filename, use it. Otherwise, follow the
1732 * regular lookup sequence.
1734 if (config_source && config_source->use_stdin)
1735 return git_config_from_stdin(fn, data);
1736 else if (config_source && config_source->file)
1737 return git_config_from_file(fn, config_source->file, data);
1738 else if (config_source && config_source->blob)
1739 return git_config_from_blob_ref(fn, config_source->blob, data);
1741 return do_git_config_sequence(opts, fn, data);
1744 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1746 int i, value_index;
1747 struct string_list *values;
1748 struct config_set_element *entry;
1749 struct configset_list *list = &cs->list;
1751 for (i = 0; i < list->nr; i++) {
1752 entry = list->items[i].e;
1753 value_index = list->items[i].value_index;
1754 values = &entry->value_list;
1756 current_config_kvi = values->items[value_index].util;
1758 if (fn(entry->key, values->items[value_index].string, data) < 0)
1759 git_die_config_linenr(entry->key,
1760 current_config_kvi->filename,
1761 current_config_kvi->linenr);
1763 current_config_kvi = NULL;
1767 void read_early_config(config_fn_t cb, void *data)
1769 struct config_options opts = {0};
1770 struct strbuf commondir = STRBUF_INIT;
1771 struct strbuf gitdir = STRBUF_INIT;
1773 opts.respect_includes = 1;
1775 if (have_git_dir()) {
1776 opts.commondir = get_git_common_dir();
1777 opts.git_dir = get_git_dir();
1779 * When setup_git_directory() was not yet asked to discover the
1780 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1781 * is any repository config we should use (but unlike
1782 * setup_git_directory_gently(), no global state is changed, most
1783 * notably, the current working directory is still the same after the
1784 * call).
1786 } else if (!discover_git_directory(&commondir, &gitdir)) {
1787 opts.commondir = commondir.buf;
1788 opts.git_dir = gitdir.buf;
1791 config_with_options(cb, data, NULL, &opts);
1793 strbuf_release(&commondir);
1794 strbuf_release(&gitdir);
1798 * Read config but only enumerate system and global settings.
1799 * Omit any repo-local, worktree-local, or command-line settings.
1801 void read_very_early_config(config_fn_t cb, void *data)
1803 struct config_options opts = { 0 };
1805 opts.respect_includes = 1;
1806 opts.ignore_repo = 1;
1807 opts.ignore_worktree = 1;
1808 opts.ignore_cmdline = 1;
1809 opts.system_gently = 1;
1811 config_with_options(cb, data, NULL, &opts);
1814 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1816 struct config_set_element k;
1817 struct config_set_element *found_entry;
1818 char *normalized_key;
1820 * `key` may come from the user, so normalize it before using it
1821 * for querying entries from the hashmap.
1823 if (git_config_parse_key(key, &normalized_key, NULL))
1824 return NULL;
1826 hashmap_entry_init(&k, strhash(normalized_key));
1827 k.key = normalized_key;
1828 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1829 free(normalized_key);
1830 return found_entry;
1833 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1835 struct config_set_element *e;
1836 struct string_list_item *si;
1837 struct configset_list_item *l_item;
1838 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1840 e = configset_find_element(cs, key);
1842 * Since the keys are being fed by git_config*() callback mechanism, they
1843 * are already normalized. So simply add them without any further munging.
1845 if (!e) {
1846 e = xmalloc(sizeof(*e));
1847 hashmap_entry_init(e, strhash(key));
1848 e->key = xstrdup(key);
1849 string_list_init(&e->value_list, 1);
1850 hashmap_add(&cs->config_hash, e);
1852 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1854 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1855 l_item = &cs->list.items[cs->list.nr++];
1856 l_item->e = e;
1857 l_item->value_index = e->value_list.nr - 1;
1859 if (!cf)
1860 BUG("configset_add_value has no source");
1861 if (cf->name) {
1862 kv_info->filename = strintern(cf->name);
1863 kv_info->linenr = cf->linenr;
1864 kv_info->origin_type = cf->origin_type;
1865 } else {
1866 /* for values read from `git_config_from_parameters()` */
1867 kv_info->filename = NULL;
1868 kv_info->linenr = -1;
1869 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1871 kv_info->scope = current_parsing_scope;
1872 si->util = kv_info;
1874 return 0;
1877 static int config_set_element_cmp(const void *unused_cmp_data,
1878 const void *entry,
1879 const void *entry_or_key,
1880 const void *unused_keydata)
1882 const struct config_set_element *e1 = entry;
1883 const struct config_set_element *e2 = entry_or_key;
1885 return strcmp(e1->key, e2->key);
1888 void git_configset_init(struct config_set *cs)
1890 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1891 cs->hash_initialized = 1;
1892 cs->list.nr = 0;
1893 cs->list.alloc = 0;
1894 cs->list.items = NULL;
1897 void git_configset_clear(struct config_set *cs)
1899 struct config_set_element *entry;
1900 struct hashmap_iter iter;
1901 if (!cs->hash_initialized)
1902 return;
1904 hashmap_iter_init(&cs->config_hash, &iter);
1905 while ((entry = hashmap_iter_next(&iter))) {
1906 free(entry->key);
1907 string_list_clear(&entry->value_list, 1);
1909 hashmap_free(&cs->config_hash, 1);
1910 cs->hash_initialized = 0;
1911 free(cs->list.items);
1912 cs->list.nr = 0;
1913 cs->list.alloc = 0;
1914 cs->list.items = NULL;
1917 static int config_set_callback(const char *key, const char *value, void *cb)
1919 struct config_set *cs = cb;
1920 configset_add_value(cs, key, value);
1921 return 0;
1924 int git_configset_add_file(struct config_set *cs, const char *filename)
1926 return git_config_from_file(config_set_callback, filename, cs);
1929 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1931 const struct string_list *values = NULL;
1933 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1934 * queried key in the files of the configset, the value returned will be the last
1935 * value in the value list for that key.
1937 values = git_configset_get_value_multi(cs, key);
1939 if (!values)
1940 return 1;
1941 assert(values->nr > 0);
1942 *value = values->items[values->nr - 1].string;
1943 return 0;
1946 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1948 struct config_set_element *e = configset_find_element(cs, key);
1949 return e ? &e->value_list : NULL;
1952 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1954 const char *value;
1955 if (!git_configset_get_value(cs, key, &value))
1956 return git_config_string(dest, key, value);
1957 else
1958 return 1;
1961 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1963 return git_configset_get_string_const(cs, key, (const char **)dest);
1966 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1968 const char *value;
1969 if (!git_configset_get_value(cs, key, &value)) {
1970 *dest = git_config_int(key, value);
1971 return 0;
1972 } else
1973 return 1;
1976 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1978 const char *value;
1979 if (!git_configset_get_value(cs, key, &value)) {
1980 *dest = git_config_ulong(key, value);
1981 return 0;
1982 } else
1983 return 1;
1986 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1988 const char *value;
1989 if (!git_configset_get_value(cs, key, &value)) {
1990 *dest = git_config_bool(key, value);
1991 return 0;
1992 } else
1993 return 1;
1996 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1997 int *is_bool, int *dest)
1999 const char *value;
2000 if (!git_configset_get_value(cs, key, &value)) {
2001 *dest = git_config_bool_or_int(key, value, is_bool);
2002 return 0;
2003 } else
2004 return 1;
2007 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
2009 const char *value;
2010 if (!git_configset_get_value(cs, key, &value)) {
2011 *dest = git_parse_maybe_bool(value);
2012 if (*dest == -1)
2013 return -1;
2014 return 0;
2015 } else
2016 return 1;
2019 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
2021 const char *value;
2022 if (!git_configset_get_value(cs, key, &value))
2023 return git_config_pathname(dest, key, value);
2024 else
2025 return 1;
2028 /* Functions use to read configuration from a repository */
2029 static void repo_read_config(struct repository *repo)
2031 struct config_options opts = { 0 };
2033 opts.respect_includes = 1;
2034 opts.commondir = repo->commondir;
2035 opts.git_dir = repo->gitdir;
2037 if (!repo->config)
2038 repo->config = xcalloc(1, sizeof(struct config_set));
2039 else
2040 git_configset_clear(repo->config);
2042 git_configset_init(repo->config);
2044 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2046 * config_with_options() normally returns only
2047 * zero, as most errors are fatal, and
2048 * non-fatal potential errors are guarded by "if"
2049 * statements that are entered only when no error is
2050 * possible.
2052 * If we ever encounter a non-fatal error, it means
2053 * something went really wrong and we should stop
2054 * immediately.
2056 die(_("unknown error occurred while reading the configuration files"));
2059 static void git_config_check_init(struct repository *repo)
2061 if (repo->config && repo->config->hash_initialized)
2062 return;
2063 repo_read_config(repo);
2066 static void repo_config_clear(struct repository *repo)
2068 if (!repo->config || !repo->config->hash_initialized)
2069 return;
2070 git_configset_clear(repo->config);
2073 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2075 git_config_check_init(repo);
2076 configset_iter(repo->config, fn, data);
2079 int repo_config_get_value(struct repository *repo,
2080 const char *key, const char **value)
2082 git_config_check_init(repo);
2083 return git_configset_get_value(repo->config, key, value);
2086 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2087 const char *key)
2089 git_config_check_init(repo);
2090 return git_configset_get_value_multi(repo->config, key);
2093 int repo_config_get_string_const(struct repository *repo,
2094 const char *key, const char **dest)
2096 int ret;
2097 git_config_check_init(repo);
2098 ret = git_configset_get_string_const(repo->config, key, dest);
2099 if (ret < 0)
2100 git_die_config(key, NULL);
2101 return ret;
2104 int repo_config_get_string(struct repository *repo,
2105 const char *key, char **dest)
2107 git_config_check_init(repo);
2108 return repo_config_get_string_const(repo, key, (const char **)dest);
2111 int repo_config_get_int(struct repository *repo,
2112 const char *key, int *dest)
2114 git_config_check_init(repo);
2115 return git_configset_get_int(repo->config, key, dest);
2118 int repo_config_get_ulong(struct repository *repo,
2119 const char *key, unsigned long *dest)
2121 git_config_check_init(repo);
2122 return git_configset_get_ulong(repo->config, key, dest);
2125 int repo_config_get_bool(struct repository *repo,
2126 const char *key, int *dest)
2128 git_config_check_init(repo);
2129 return git_configset_get_bool(repo->config, key, dest);
2132 int repo_config_get_bool_or_int(struct repository *repo,
2133 const char *key, int *is_bool, int *dest)
2135 git_config_check_init(repo);
2136 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2139 int repo_config_get_maybe_bool(struct repository *repo,
2140 const char *key, int *dest)
2142 git_config_check_init(repo);
2143 return git_configset_get_maybe_bool(repo->config, key, dest);
2146 int repo_config_get_pathname(struct repository *repo,
2147 const char *key, const char **dest)
2149 int ret;
2150 git_config_check_init(repo);
2151 ret = git_configset_get_pathname(repo->config, key, dest);
2152 if (ret < 0)
2153 git_die_config(key, NULL);
2154 return ret;
2157 /* Functions used historically to read configuration from 'the_repository' */
2158 void git_config(config_fn_t fn, void *data)
2160 repo_config(the_repository, fn, data);
2163 void git_config_clear(void)
2165 repo_config_clear(the_repository);
2168 int git_config_get_value(const char *key, const char **value)
2170 return repo_config_get_value(the_repository, key, value);
2173 const struct string_list *git_config_get_value_multi(const char *key)
2175 return repo_config_get_value_multi(the_repository, key);
2178 int git_config_get_string_const(const char *key, const char **dest)
2180 return repo_config_get_string_const(the_repository, key, dest);
2183 int git_config_get_string(const char *key, char **dest)
2185 return repo_config_get_string(the_repository, key, dest);
2188 int git_config_get_int(const char *key, int *dest)
2190 return repo_config_get_int(the_repository, key, dest);
2193 int git_config_get_ulong(const char *key, unsigned long *dest)
2195 return repo_config_get_ulong(the_repository, key, dest);
2198 int git_config_get_bool(const char *key, int *dest)
2200 return repo_config_get_bool(the_repository, key, dest);
2203 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2205 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2208 int git_config_get_maybe_bool(const char *key, int *dest)
2210 return repo_config_get_maybe_bool(the_repository, key, dest);
2213 int git_config_get_pathname(const char *key, const char **dest)
2215 return repo_config_get_pathname(the_repository, key, dest);
2218 int git_config_get_expiry(const char *key, const char **output)
2220 int ret = git_config_get_string_const(key, output);
2221 if (ret)
2222 return ret;
2223 if (strcmp(*output, "now")) {
2224 timestamp_t now = approxidate("now");
2225 if (approxidate(*output) >= now)
2226 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2228 return ret;
2231 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2233 char *expiry_string;
2234 intmax_t days;
2235 timestamp_t when;
2237 if (git_config_get_string(key, &expiry_string))
2238 return 1; /* no such thing */
2240 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2241 const int scale = 86400;
2242 *expiry = now - days * scale;
2243 return 0;
2246 if (!parse_expiry_date(expiry_string, &when)) {
2247 *expiry = when;
2248 return 0;
2250 return -1; /* thing exists but cannot be parsed */
2253 int git_config_get_untracked_cache(void)
2255 int val = -1;
2256 const char *v;
2258 /* Hack for test programs like test-dump-untracked-cache */
2259 if (ignore_untracked_cache_config)
2260 return -1;
2262 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2263 return val;
2265 if (!git_config_get_value("core.untrackedcache", &v)) {
2266 if (!strcasecmp(v, "keep"))
2267 return -1;
2269 error(_("unknown core.untrackedCache value '%s'; "
2270 "using 'keep' default value"), v);
2271 return -1;
2274 return -1; /* default value */
2277 int git_config_get_split_index(void)
2279 int val;
2281 if (!git_config_get_maybe_bool("core.splitindex", &val))
2282 return val;
2284 return -1; /* default value */
2287 int git_config_get_max_percent_split_change(void)
2289 int val = -1;
2291 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2292 if (0 <= val && val <= 100)
2293 return val;
2295 return error(_("splitIndex.maxPercentChange value '%d' "
2296 "should be between 0 and 100"), val);
2299 return -1; /* default value */
2302 int git_config_get_fsmonitor(void)
2304 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2305 core_fsmonitor = getenv("GIT_TEST_FSMONITOR");
2307 if (core_fsmonitor && !*core_fsmonitor)
2308 core_fsmonitor = NULL;
2310 if (core_fsmonitor)
2311 return 1;
2313 return 0;
2316 int git_config_get_index_threads(int *dest)
2318 int is_bool, val;
2320 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2321 if (val) {
2322 *dest = val;
2323 return 0;
2326 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2327 if (is_bool)
2328 *dest = val ? 0 : 1;
2329 else
2330 *dest = val;
2331 return 0;
2334 return 1;
2337 NORETURN
2338 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2340 if (!filename)
2341 die(_("unable to parse '%s' from command-line config"), key);
2342 else
2343 die(_("bad config variable '%s' in file '%s' at line %d"),
2344 key, filename, linenr);
2347 NORETURN __attribute__((format(printf, 2, 3)))
2348 void git_die_config(const char *key, const char *err, ...)
2350 const struct string_list *values;
2351 struct key_value_info *kv_info;
2353 if (err) {
2354 va_list params;
2355 va_start(params, err);
2356 vreportf("error: ", err, params);
2357 va_end(params);
2359 values = git_config_get_value_multi(key);
2360 kv_info = values->items[values->nr - 1].util;
2361 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2365 * Find all the stuff for git_config_set() below.
2368 struct config_store_data {
2369 int baselen;
2370 char *key;
2371 int do_not_match;
2372 regex_t *value_regex;
2373 int multi_replace;
2374 struct {
2375 size_t begin, end;
2376 enum config_event_t type;
2377 int is_keys_section;
2378 } *parsed;
2379 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2380 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2383 static void config_store_data_clear(struct config_store_data *store)
2385 free(store->key);
2386 if (store->value_regex != NULL &&
2387 store->value_regex != CONFIG_REGEX_NONE) {
2388 regfree(store->value_regex);
2389 free(store->value_regex);
2391 free(store->parsed);
2392 free(store->seen);
2393 memset(store, 0, sizeof(*store));
2396 static int matches(const char *key, const char *value,
2397 const struct config_store_data *store)
2399 if (strcmp(key, store->key))
2400 return 0; /* not ours */
2401 if (!store->value_regex)
2402 return 1; /* always matches */
2403 if (store->value_regex == CONFIG_REGEX_NONE)
2404 return 0; /* never matches */
2406 return store->do_not_match ^
2407 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2410 static int store_aux_event(enum config_event_t type,
2411 size_t begin, size_t end, void *data)
2413 struct config_store_data *store = data;
2415 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2416 store->parsed[store->parsed_nr].begin = begin;
2417 store->parsed[store->parsed_nr].end = end;
2418 store->parsed[store->parsed_nr].type = type;
2420 if (type == CONFIG_EVENT_SECTION) {
2421 int (*cmpfn)(const char *, const char *, size_t);
2423 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2424 return error(_("invalid section name '%s'"), cf->var.buf);
2426 if (cf->subsection_case_sensitive)
2427 cmpfn = strncasecmp;
2428 else
2429 cmpfn = strncmp;
2431 /* Is this the section we were looking for? */
2432 store->is_keys_section =
2433 store->parsed[store->parsed_nr].is_keys_section =
2434 cf->var.len - 1 == store->baselen &&
2435 !cmpfn(cf->var.buf, store->key, store->baselen);
2436 if (store->is_keys_section) {
2437 store->section_seen = 1;
2438 ALLOC_GROW(store->seen, store->seen_nr + 1,
2439 store->seen_alloc);
2440 store->seen[store->seen_nr] = store->parsed_nr;
2444 store->parsed_nr++;
2446 return 0;
2449 static int store_aux(const char *key, const char *value, void *cb)
2451 struct config_store_data *store = cb;
2453 if (store->key_seen) {
2454 if (matches(key, value, store)) {
2455 if (store->seen_nr == 1 && store->multi_replace == 0) {
2456 warning(_("%s has multiple values"), key);
2459 ALLOC_GROW(store->seen, store->seen_nr + 1,
2460 store->seen_alloc);
2462 store->seen[store->seen_nr] = store->parsed_nr;
2463 store->seen_nr++;
2465 } else if (store->is_keys_section) {
2467 * Do not increment matches yet: this may not be a match, but we
2468 * are in the desired section.
2470 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2471 store->seen[store->seen_nr] = store->parsed_nr;
2472 store->section_seen = 1;
2474 if (matches(key, value, store)) {
2475 store->seen_nr++;
2476 store->key_seen = 1;
2480 return 0;
2483 static int write_error(const char *filename)
2485 error(_("failed to write new configuration file %s"), filename);
2487 /* Same error code as "failed to rename". */
2488 return 4;
2491 static struct strbuf store_create_section(const char *key,
2492 const struct config_store_data *store)
2494 const char *dot;
2495 int i;
2496 struct strbuf sb = STRBUF_INIT;
2498 dot = memchr(key, '.', store->baselen);
2499 if (dot) {
2500 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2501 for (i = dot - key + 1; i < store->baselen; i++) {
2502 if (key[i] == '"' || key[i] == '\\')
2503 strbuf_addch(&sb, '\\');
2504 strbuf_addch(&sb, key[i]);
2506 strbuf_addstr(&sb, "\"]\n");
2507 } else {
2508 strbuf_addf(&sb, "[%.*s]\n", store->baselen, key);
2511 return sb;
2514 static ssize_t write_section(int fd, const char *key,
2515 const struct config_store_data *store)
2517 struct strbuf sb = store_create_section(key, store);
2518 ssize_t ret;
2520 ret = write_in_full(fd, sb.buf, sb.len);
2521 strbuf_release(&sb);
2523 return ret;
2526 static ssize_t write_pair(int fd, const char *key, const char *value,
2527 const struct config_store_data *store)
2529 int i;
2530 ssize_t ret;
2531 int length = strlen(key + store->baselen + 1);
2532 const char *quote = "";
2533 struct strbuf sb = STRBUF_INIT;
2536 * Check to see if the value needs to be surrounded with a dq pair.
2537 * Note that problematic characters are always backslash-quoted; this
2538 * check is about not losing leading or trailing SP and strings that
2539 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2540 * configuration parser.
2542 if (value[0] == ' ')
2543 quote = "\"";
2544 for (i = 0; value[i]; i++)
2545 if (value[i] == ';' || value[i] == '#')
2546 quote = "\"";
2547 if (i && value[i - 1] == ' ')
2548 quote = "\"";
2550 strbuf_addf(&sb, "\t%.*s = %s",
2551 length, key + store->baselen + 1, quote);
2553 for (i = 0; value[i]; i++)
2554 switch (value[i]) {
2555 case '\n':
2556 strbuf_addstr(&sb, "\\n");
2557 break;
2558 case '\t':
2559 strbuf_addstr(&sb, "\\t");
2560 break;
2561 case '"':
2562 case '\\':
2563 strbuf_addch(&sb, '\\');
2564 /* fallthrough */
2565 default:
2566 strbuf_addch(&sb, value[i]);
2567 break;
2569 strbuf_addf(&sb, "%s\n", quote);
2571 ret = write_in_full(fd, sb.buf, sb.len);
2572 strbuf_release(&sb);
2574 return ret;
2578 * If we are about to unset the last key(s) in a section, and if there are
2579 * no comments surrounding (or included in) the section, we will want to
2580 * extend begin/end to remove the entire section.
2582 * Note: the parameter `seen_ptr` points to the index into the store.seen
2583 * array. * This index may be incremented if a section has more than one
2584 * entry (which all are to be removed).
2586 static void maybe_remove_section(struct config_store_data *store,
2587 size_t *begin_offset, size_t *end_offset,
2588 int *seen_ptr)
2590 size_t begin;
2591 int i, seen, section_seen = 0;
2594 * First, ensure that this is the first key, and that there are no
2595 * comments before the entry nor before the section header.
2597 seen = *seen_ptr;
2598 for (i = store->seen[seen]; i > 0; i--) {
2599 enum config_event_t type = store->parsed[i - 1].type;
2601 if (type == CONFIG_EVENT_COMMENT)
2602 /* There is a comment before this entry or section */
2603 return;
2604 if (type == CONFIG_EVENT_ENTRY) {
2605 if (!section_seen)
2606 /* This is not the section's first entry. */
2607 return;
2608 /* We encountered no comment before the section. */
2609 break;
2611 if (type == CONFIG_EVENT_SECTION) {
2612 if (!store->parsed[i - 1].is_keys_section)
2613 break;
2614 section_seen = 1;
2617 begin = store->parsed[i].begin;
2620 * Next, make sure that we are removing he last key(s) in the section,
2621 * and that there are no comments that are possibly about the current
2622 * section.
2624 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2625 enum config_event_t type = store->parsed[i].type;
2627 if (type == CONFIG_EVENT_COMMENT)
2628 return;
2629 if (type == CONFIG_EVENT_SECTION) {
2630 if (store->parsed[i].is_keys_section)
2631 continue;
2632 break;
2634 if (type == CONFIG_EVENT_ENTRY) {
2635 if (++seen < store->seen_nr &&
2636 i == store->seen[seen])
2637 /* We want to remove this entry, too */
2638 continue;
2639 /* There is another entry in this section. */
2640 return;
2645 * We are really removing the last entry/entries from this section, and
2646 * there are no enclosed or surrounding comments. Remove the entire,
2647 * now-empty section.
2649 *seen_ptr = seen;
2650 *begin_offset = begin;
2651 if (i < store->parsed_nr)
2652 *end_offset = store->parsed[i].begin;
2653 else
2654 *end_offset = store->parsed[store->parsed_nr - 1].end;
2657 int git_config_set_in_file_gently(const char *config_filename,
2658 const char *key, const char *value)
2660 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2663 void git_config_set_in_file(const char *config_filename,
2664 const char *key, const char *value)
2666 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2669 int git_config_set_gently(const char *key, const char *value)
2671 return git_config_set_multivar_gently(key, value, NULL, 0);
2674 void git_config_set(const char *key, const char *value)
2676 git_config_set_multivar(key, value, NULL, 0);
2678 trace2_cmd_set_config(key, value);
2682 * If value==NULL, unset in (remove from) config,
2683 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2684 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2685 * (only add a new one)
2686 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2687 * else all matching key/values (regardless how many) are removed,
2688 * before the new pair is written.
2690 * Returns 0 on success.
2692 * This function does this:
2694 * - it locks the config file by creating ".git/config.lock"
2696 * - it then parses the config using store_aux() as validator to find
2697 * the position on the key/value pair to replace. If it is to be unset,
2698 * it must be found exactly once.
2700 * - the config file is mmap()ed and the part before the match (if any) is
2701 * written to the lock file, then the changed part and the rest.
2703 * - the config file is removed and the lock file rename()d to it.
2706 int git_config_set_multivar_in_file_gently(const char *config_filename,
2707 const char *key, const char *value,
2708 const char *value_regex,
2709 int multi_replace)
2711 int fd = -1, in_fd = -1;
2712 int ret;
2713 struct lock_file lock = LOCK_INIT;
2714 char *filename_buf = NULL;
2715 char *contents = NULL;
2716 size_t contents_sz;
2717 struct config_store_data store;
2719 memset(&store, 0, sizeof(store));
2721 /* parse-key returns negative; flip the sign to feed exit(3) */
2722 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2723 if (ret)
2724 goto out_free;
2726 store.multi_replace = multi_replace;
2728 if (!config_filename)
2729 config_filename = filename_buf = git_pathdup("config");
2732 * The lock serves a purpose in addition to locking: the new
2733 * contents of .git/config will be written into it.
2735 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2736 if (fd < 0) {
2737 error_errno(_("could not lock config file %s"), config_filename);
2738 ret = CONFIG_NO_LOCK;
2739 goto out_free;
2743 * If .git/config does not exist yet, write a minimal version.
2745 in_fd = open(config_filename, O_RDONLY);
2746 if ( in_fd < 0 ) {
2747 if ( ENOENT != errno ) {
2748 error_errno(_("opening %s"), config_filename);
2749 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2750 goto out_free;
2752 /* if nothing to unset, error out */
2753 if (value == NULL) {
2754 ret = CONFIG_NOTHING_SET;
2755 goto out_free;
2758 free(store.key);
2759 store.key = xstrdup(key);
2760 if (write_section(fd, key, &store) < 0 ||
2761 write_pair(fd, key, value, &store) < 0)
2762 goto write_err_out;
2763 } else {
2764 struct stat st;
2765 size_t copy_begin, copy_end;
2766 int i, new_line = 0;
2767 struct config_options opts;
2769 if (value_regex == NULL)
2770 store.value_regex = NULL;
2771 else if (value_regex == CONFIG_REGEX_NONE)
2772 store.value_regex = CONFIG_REGEX_NONE;
2773 else {
2774 if (value_regex[0] == '!') {
2775 store.do_not_match = 1;
2776 value_regex++;
2777 } else
2778 store.do_not_match = 0;
2780 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2781 if (regcomp(store.value_regex, value_regex,
2782 REG_EXTENDED)) {
2783 error(_("invalid pattern: %s"), value_regex);
2784 FREE_AND_NULL(store.value_regex);
2785 ret = CONFIG_INVALID_PATTERN;
2786 goto out_free;
2790 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2791 store.parsed[0].end = 0;
2793 memset(&opts, 0, sizeof(opts));
2794 opts.event_fn = store_aux_event;
2795 opts.event_fn_data = &store;
2798 * After this, store.parsed will contain offsets of all the
2799 * parsed elements, and store.seen will contain a list of
2800 * matches, as indices into store.parsed.
2802 * As a side effect, we make sure to transform only a valid
2803 * existing config file.
2805 if (git_config_from_file_with_options(store_aux,
2806 config_filename,
2807 &store, &opts)) {
2808 error(_("invalid config file %s"), config_filename);
2809 ret = CONFIG_INVALID_FILE;
2810 goto out_free;
2813 /* if nothing to unset, or too many matches, error out */
2814 if ((store.seen_nr == 0 && value == NULL) ||
2815 (store.seen_nr > 1 && multi_replace == 0)) {
2816 ret = CONFIG_NOTHING_SET;
2817 goto out_free;
2820 if (fstat(in_fd, &st) == -1) {
2821 error_errno(_("fstat on %s failed"), config_filename);
2822 ret = CONFIG_INVALID_FILE;
2823 goto out_free;
2826 contents_sz = xsize_t(st.st_size);
2827 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2828 MAP_PRIVATE, in_fd, 0);
2829 if (contents == MAP_FAILED) {
2830 if (errno == ENODEV && S_ISDIR(st.st_mode))
2831 errno = EISDIR;
2832 error_errno(_("unable to mmap '%s'"), config_filename);
2833 ret = CONFIG_INVALID_FILE;
2834 contents = NULL;
2835 goto out_free;
2837 close(in_fd);
2838 in_fd = -1;
2840 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2841 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
2842 ret = CONFIG_NO_WRITE;
2843 goto out_free;
2846 if (store.seen_nr == 0) {
2847 if (!store.seen_alloc) {
2848 /* Did not see key nor section */
2849 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2850 store.seen[0] = store.parsed_nr
2851 - !!store.parsed_nr;
2853 store.seen_nr = 1;
2856 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2857 size_t replace_end;
2858 int j = store.seen[i];
2860 new_line = 0;
2861 if (!store.key_seen) {
2862 copy_end = store.parsed[j].end;
2863 /* include '\n' when copying section header */
2864 if (copy_end > 0 && copy_end < contents_sz &&
2865 contents[copy_end - 1] != '\n' &&
2866 contents[copy_end] == '\n')
2867 copy_end++;
2868 replace_end = copy_end;
2869 } else {
2870 replace_end = store.parsed[j].end;
2871 copy_end = store.parsed[j].begin;
2872 if (!value)
2873 maybe_remove_section(&store,
2874 &copy_end,
2875 &replace_end, &i);
2877 * Swallow preceding white-space on the same
2878 * line.
2880 while (copy_end > 0 ) {
2881 char c = contents[copy_end - 1];
2883 if (isspace(c) && c != '\n')
2884 copy_end--;
2885 else
2886 break;
2890 if (copy_end > 0 && contents[copy_end-1] != '\n')
2891 new_line = 1;
2893 /* write the first part of the config */
2894 if (copy_end > copy_begin) {
2895 if (write_in_full(fd, contents + copy_begin,
2896 copy_end - copy_begin) < 0)
2897 goto write_err_out;
2898 if (new_line &&
2899 write_str_in_full(fd, "\n") < 0)
2900 goto write_err_out;
2902 copy_begin = replace_end;
2905 /* write the pair (value == NULL means unset) */
2906 if (value != NULL) {
2907 if (!store.section_seen) {
2908 if (write_section(fd, key, &store) < 0)
2909 goto write_err_out;
2911 if (write_pair(fd, key, value, &store) < 0)
2912 goto write_err_out;
2915 /* write the rest of the config */
2916 if (copy_begin < contents_sz)
2917 if (write_in_full(fd, contents + copy_begin,
2918 contents_sz - copy_begin) < 0)
2919 goto write_err_out;
2921 munmap(contents, contents_sz);
2922 contents = NULL;
2925 if (commit_lock_file(&lock) < 0) {
2926 error_errno(_("could not write config file %s"), config_filename);
2927 ret = CONFIG_NO_WRITE;
2928 goto out_free;
2931 ret = 0;
2933 /* Invalidate the config cache */
2934 git_config_clear();
2936 out_free:
2937 rollback_lock_file(&lock);
2938 free(filename_buf);
2939 if (contents)
2940 munmap(contents, contents_sz);
2941 if (in_fd >= 0)
2942 close(in_fd);
2943 config_store_data_clear(&store);
2944 return ret;
2946 write_err_out:
2947 ret = write_error(get_lock_file_path(&lock));
2948 goto out_free;
2952 void git_config_set_multivar_in_file(const char *config_filename,
2953 const char *key, const char *value,
2954 const char *value_regex, int multi_replace)
2956 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2957 value_regex, multi_replace))
2958 return;
2959 if (value)
2960 die(_("could not set '%s' to '%s'"), key, value);
2961 else
2962 die(_("could not unset '%s'"), key);
2965 int git_config_set_multivar_gently(const char *key, const char *value,
2966 const char *value_regex, int multi_replace)
2968 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2969 multi_replace);
2972 void git_config_set_multivar(const char *key, const char *value,
2973 const char *value_regex, int multi_replace)
2975 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2976 multi_replace);
2979 static int section_name_match (const char *buf, const char *name)
2981 int i = 0, j = 0, dot = 0;
2982 if (buf[i] != '[')
2983 return 0;
2984 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2985 if (!dot && isspace(buf[i])) {
2986 dot = 1;
2987 if (name[j++] != '.')
2988 break;
2989 for (i++; isspace(buf[i]); i++)
2990 ; /* do nothing */
2991 if (buf[i] != '"')
2992 break;
2993 continue;
2995 if (buf[i] == '\\' && dot)
2996 i++;
2997 else if (buf[i] == '"' && dot) {
2998 for (i++; isspace(buf[i]); i++)
2999 ; /* do_nothing */
3000 break;
3002 if (buf[i] != name[j++])
3003 break;
3005 if (buf[i] == ']' && name[j] == 0) {
3007 * We match, now just find the right length offset by
3008 * gobbling up any whitespace after it, as well
3010 i++;
3011 for (; buf[i] && isspace(buf[i]); i++)
3012 ; /* do nothing */
3013 return i;
3015 return 0;
3018 static int section_name_is_ok(const char *name)
3020 /* Empty section names are bogus. */
3021 if (!*name)
3022 return 0;
3025 * Before a dot, we must be alphanumeric or dash. After the first dot,
3026 * anything goes, so we can stop checking.
3028 for (; *name && *name != '.'; name++)
3029 if (*name != '-' && !isalnum(*name))
3030 return 0;
3031 return 1;
3034 /* if new_name == NULL, the section is removed instead */
3035 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3036 const char *old_name,
3037 const char *new_name, int copy)
3039 int ret = 0, remove = 0;
3040 char *filename_buf = NULL;
3041 struct lock_file lock = LOCK_INIT;
3042 int out_fd;
3043 char buf[1024];
3044 FILE *config_file = NULL;
3045 struct stat st;
3046 struct strbuf copystr = STRBUF_INIT;
3047 struct config_store_data store;
3049 memset(&store, 0, sizeof(store));
3051 if (new_name && !section_name_is_ok(new_name)) {
3052 ret = error(_("invalid section name: %s"), new_name);
3053 goto out_no_rollback;
3056 if (!config_filename)
3057 config_filename = filename_buf = git_pathdup("config");
3059 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3060 if (out_fd < 0) {
3061 ret = error(_("could not lock config file %s"), config_filename);
3062 goto out;
3065 if (!(config_file = fopen(config_filename, "rb"))) {
3066 ret = warn_on_fopen_errors(config_filename);
3067 if (ret)
3068 goto out;
3069 /* no config file means nothing to rename, no error */
3070 goto commit_and_out;
3073 if (fstat(fileno(config_file), &st) == -1) {
3074 ret = error_errno(_("fstat on %s failed"), config_filename);
3075 goto out;
3078 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3079 ret = error_errno(_("chmod on %s failed"),
3080 get_lock_file_path(&lock));
3081 goto out;
3084 while (fgets(buf, sizeof(buf), config_file)) {
3085 int i;
3086 int length;
3087 int is_section = 0;
3088 char *output = buf;
3089 for (i = 0; buf[i] && isspace(buf[i]); i++)
3090 ; /* do nothing */
3091 if (buf[i] == '[') {
3092 /* it's a section */
3093 int offset;
3094 is_section = 1;
3097 * When encountering a new section under -c we
3098 * need to flush out any section we're already
3099 * coping and begin anew. There might be
3100 * multiple [branch "$name"] sections.
3102 if (copystr.len > 0) {
3103 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3104 ret = write_error(get_lock_file_path(&lock));
3105 goto out;
3107 strbuf_reset(&copystr);
3110 offset = section_name_match(&buf[i], old_name);
3111 if (offset > 0) {
3112 ret++;
3113 if (new_name == NULL) {
3114 remove = 1;
3115 continue;
3117 store.baselen = strlen(new_name);
3118 if (!copy) {
3119 if (write_section(out_fd, new_name, &store) < 0) {
3120 ret = write_error(get_lock_file_path(&lock));
3121 goto out;
3124 * We wrote out the new section, with
3125 * a newline, now skip the old
3126 * section's length
3128 output += offset + i;
3129 if (strlen(output) > 0) {
3131 * More content means there's
3132 * a declaration to put on the
3133 * next line; indent with a
3134 * tab
3136 output -= 1;
3137 output[0] = '\t';
3139 } else {
3140 copystr = store_create_section(new_name, &store);
3143 remove = 0;
3145 if (remove)
3146 continue;
3147 length = strlen(output);
3149 if (!is_section && copystr.len > 0) {
3150 strbuf_add(&copystr, output, length);
3153 if (write_in_full(out_fd, output, length) < 0) {
3154 ret = write_error(get_lock_file_path(&lock));
3155 goto out;
3160 * Copy a trailing section at the end of the config, won't be
3161 * flushed by the usual "flush because we have a new section
3162 * logic in the loop above.
3164 if (copystr.len > 0) {
3165 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3166 ret = write_error(get_lock_file_path(&lock));
3167 goto out;
3169 strbuf_reset(&copystr);
3172 fclose(config_file);
3173 config_file = NULL;
3174 commit_and_out:
3175 if (commit_lock_file(&lock) < 0)
3176 ret = error_errno(_("could not write config file %s"),
3177 config_filename);
3178 out:
3179 if (config_file)
3180 fclose(config_file);
3181 rollback_lock_file(&lock);
3182 out_no_rollback:
3183 free(filename_buf);
3184 config_store_data_clear(&store);
3185 return ret;
3188 int git_config_rename_section_in_file(const char *config_filename,
3189 const char *old_name, const char *new_name)
3191 return git_config_copy_or_rename_section_in_file(config_filename,
3192 old_name, new_name, 0);
3195 int git_config_rename_section(const char *old_name, const char *new_name)
3197 return git_config_rename_section_in_file(NULL, old_name, new_name);
3200 int git_config_copy_section_in_file(const char *config_filename,
3201 const char *old_name, const char *new_name)
3203 return git_config_copy_or_rename_section_in_file(config_filename,
3204 old_name, new_name, 1);
3207 int git_config_copy_section(const char *old_name, const char *new_name)
3209 return git_config_copy_section_in_file(NULL, old_name, new_name);
3213 * Call this to report error for your variable that should not
3214 * get a boolean value (i.e. "[my] var" means "true").
3216 #undef config_error_nonbool
3217 int config_error_nonbool(const char *var)
3219 return error(_("missing value for '%s'"), var);
3222 int parse_config_key(const char *var,
3223 const char *section,
3224 const char **subsection, int *subsection_len,
3225 const char **key)
3227 const char *dot;
3229 /* Does it start with "section." ? */
3230 if (!skip_prefix(var, section, &var) || *var != '.')
3231 return -1;
3234 * Find the key; we don't know yet if we have a subsection, but we must
3235 * parse backwards from the end, since the subsection may have dots in
3236 * it, too.
3238 dot = strrchr(var, '.');
3239 *key = dot + 1;
3241 /* Did we have a subsection at all? */
3242 if (dot == var) {
3243 if (subsection) {
3244 *subsection = NULL;
3245 *subsection_len = 0;
3248 else {
3249 if (!subsection)
3250 return -1;
3251 *subsection = var + 1;
3252 *subsection_len = dot - *subsection;
3255 return 0;
3258 const char *current_config_origin_type(void)
3260 int type;
3261 if (current_config_kvi)
3262 type = current_config_kvi->origin_type;
3263 else if(cf)
3264 type = cf->origin_type;
3265 else
3266 BUG("current_config_origin_type called outside config callback");
3268 switch (type) {
3269 case CONFIG_ORIGIN_BLOB:
3270 return "blob";
3271 case CONFIG_ORIGIN_FILE:
3272 return "file";
3273 case CONFIG_ORIGIN_STDIN:
3274 return "standard input";
3275 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3276 return "submodule-blob";
3277 case CONFIG_ORIGIN_CMDLINE:
3278 return "command line";
3279 default:
3280 BUG("unknown config origin type");
3284 const char *current_config_name(void)
3286 const char *name;
3287 if (current_config_kvi)
3288 name = current_config_kvi->filename;
3289 else if (cf)
3290 name = cf->name;
3291 else
3292 BUG("current_config_name called outside config callback");
3293 return name ? name : "";
3296 enum config_scope current_config_scope(void)
3298 if (current_config_kvi)
3299 return current_config_kvi->scope;
3300 else
3301 return current_parsing_scope;
3304 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3306 int i;
3308 for (i = 0; i < nr_mapping; i++) {
3309 const char *name = mapping[i];
3311 if (name && !strcasecmp(var, name))
3312 return i;
3314 return -1;