Merge branch 'ja/doc-markup-cleanup'
[git.git] / config.c
blobd75f88ca0ce31f1a9b6b3a8a2198c4f94a4196b5
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"
22 #include "refs.h"
24 struct config_source {
25 struct config_source *prev;
26 union {
27 FILE *file;
28 struct config_buf {
29 const char *buf;
30 size_t len;
31 size_t pos;
32 } buf;
33 } u;
34 enum config_origin_type origin_type;
35 const char *name;
36 const char *path;
37 enum config_error_action default_error_action;
38 int linenr;
39 int eof;
40 struct strbuf value;
41 struct strbuf var;
42 unsigned subsection_case_sensitive : 1;
44 int (*do_fgetc)(struct config_source *c);
45 int (*do_ungetc)(int c, struct config_source *conf);
46 long (*do_ftell)(struct config_source *c);
50 * These variables record the "current" config source, which
51 * can be accessed by parsing callbacks.
53 * The "cf" variable will be non-NULL only when we are actually parsing a real
54 * config source (file, blob, cmdline, etc).
56 * The "current_config_kvi" variable will be non-NULL only when we are feeding
57 * cached config from a configset into a callback.
59 * They should generally never be non-NULL at the same time. If they are both
60 * NULL, then we aren't parsing anything (and depending on the function looking
61 * at the variables, it's either a bug for it to be called in the first place,
62 * or it's a function which can be reused for non-config purposes, and should
63 * fall back to some sane behavior).
65 static struct config_source *cf;
66 static struct key_value_info *current_config_kvi;
69 * Similar to the variables above, this gives access to the "scope" of the
70 * current value (repo, global, etc). For cached values, it can be found via
71 * the current_config_kvi as above. During parsing, the current value can be
72 * found in this variable. It's not part of "cf" because it transcends a single
73 * file (i.e., a file included from .git/config is still in "repo" scope).
75 static enum config_scope current_parsing_scope;
77 static int core_compression_seen;
78 static int pack_compression_seen;
79 static int zlib_compression_seen;
81 static int config_file_fgetc(struct config_source *conf)
83 return getc_unlocked(conf->u.file);
86 static int config_file_ungetc(int c, struct config_source *conf)
88 return ungetc(c, conf->u.file);
91 static long config_file_ftell(struct config_source *conf)
93 return ftell(conf->u.file);
97 static int config_buf_fgetc(struct config_source *conf)
99 if (conf->u.buf.pos < conf->u.buf.len)
100 return conf->u.buf.buf[conf->u.buf.pos++];
102 return EOF;
105 static int config_buf_ungetc(int c, struct config_source *conf)
107 if (conf->u.buf.pos > 0) {
108 conf->u.buf.pos--;
109 if (conf->u.buf.buf[conf->u.buf.pos] != c)
110 BUG("config_buf can only ungetc the same character");
111 return c;
114 return EOF;
117 static long config_buf_ftell(struct config_source *conf)
119 return conf->u.buf.pos;
122 #define MAX_INCLUDE_DEPTH 10
123 static const char include_depth_advice[] = N_(
124 "exceeded maximum include depth (%d) while including\n"
125 " %s\n"
126 "from\n"
127 " %s\n"
128 "This might be due to circular includes.");
129 static int handle_path_include(const char *path, struct config_include_data *inc)
131 int ret = 0;
132 struct strbuf buf = STRBUF_INIT;
133 char *expanded;
135 if (!path)
136 return config_error_nonbool("include.path");
138 expanded = expand_user_path(path, 0);
139 if (!expanded)
140 return error(_("could not expand include path '%s'"), path);
141 path = expanded;
144 * Use an absolute path as-is, but interpret relative paths
145 * based on the including config file.
147 if (!is_absolute_path(path)) {
148 char *slash;
150 if (!cf || !cf->path)
151 return error(_("relative config includes must come from files"));
153 slash = find_last_dir_sep(cf->path);
154 if (slash)
155 strbuf_add(&buf, cf->path, slash - cf->path + 1);
156 strbuf_addstr(&buf, path);
157 path = buf.buf;
160 if (!access_or_die(path, R_OK, 0)) {
161 if (++inc->depth > MAX_INCLUDE_DEPTH)
162 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
163 !cf ? "<unknown>" :
164 cf->name ? cf->name :
165 "the command line");
166 ret = git_config_from_file(git_config_include, path, inc);
167 inc->depth--;
169 strbuf_release(&buf);
170 free(expanded);
171 return ret;
174 static void add_trailing_starstar_for_dir(struct strbuf *pat)
176 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
177 strbuf_addstr(pat, "**");
180 static int prepare_include_condition_pattern(struct strbuf *pat)
182 struct strbuf path = STRBUF_INIT;
183 char *expanded;
184 int prefix = 0;
186 expanded = expand_user_path(pat->buf, 1);
187 if (expanded) {
188 strbuf_reset(pat);
189 strbuf_addstr(pat, expanded);
190 free(expanded);
193 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
194 const char *slash;
196 if (!cf || !cf->path)
197 return error(_("relative config include "
198 "conditionals must come from files"));
200 strbuf_realpath(&path, cf->path, 1);
201 slash = find_last_dir_sep(path.buf);
202 if (!slash)
203 BUG("how is this possible?");
204 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
205 prefix = slash - path.buf + 1 /* slash */;
206 } else if (!is_absolute_path(pat->buf))
207 strbuf_insert(pat, 0, "**/", 3);
209 add_trailing_starstar_for_dir(pat);
211 strbuf_release(&path);
212 return prefix;
215 static int include_by_gitdir(const struct config_options *opts,
216 const char *cond, size_t cond_len, int icase)
218 struct strbuf text = STRBUF_INIT;
219 struct strbuf pattern = STRBUF_INIT;
220 int ret = 0, prefix;
221 const char *git_dir;
222 int already_tried_absolute = 0;
224 if (opts->git_dir)
225 git_dir = opts->git_dir;
226 else
227 goto done;
229 strbuf_realpath(&text, git_dir, 1);
230 strbuf_add(&pattern, cond, cond_len);
231 prefix = prepare_include_condition_pattern(&pattern);
233 again:
234 if (prefix < 0)
235 goto done;
237 if (prefix > 0) {
239 * perform literal matching on the prefix part so that
240 * any wildcard character in it can't create side effects.
242 if (text.len < prefix)
243 goto done;
244 if (!icase && strncmp(pattern.buf, text.buf, prefix))
245 goto done;
246 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
247 goto done;
250 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
251 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
253 if (!ret && !already_tried_absolute) {
255 * We've tried e.g. matching gitdir:~/work, but if
256 * ~/work is a symlink to /mnt/storage/work
257 * strbuf_realpath() will expand it, so the rule won't
258 * match. Let's match against a
259 * strbuf_add_absolute_path() version of the path,
260 * which'll do the right thing
262 strbuf_reset(&text);
263 strbuf_add_absolute_path(&text, git_dir);
264 already_tried_absolute = 1;
265 goto again;
267 done:
268 strbuf_release(&pattern);
269 strbuf_release(&text);
270 return ret;
273 static int include_by_branch(const char *cond, size_t cond_len)
275 int flags;
276 int ret;
277 struct strbuf pattern = STRBUF_INIT;
278 const char *refname = !the_repository->gitdir ?
279 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
280 const char *shortname;
282 if (!refname || !(flags & REF_ISSYMREF) ||
283 !skip_prefix(refname, "refs/heads/", &shortname))
284 return 0;
286 strbuf_add(&pattern, cond, cond_len);
287 add_trailing_starstar_for_dir(&pattern);
288 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
289 strbuf_release(&pattern);
290 return ret;
293 static int include_condition_is_true(const struct config_options *opts,
294 const char *cond, size_t cond_len)
297 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
298 return include_by_gitdir(opts, cond, cond_len, 0);
299 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
300 return include_by_gitdir(opts, cond, cond_len, 1);
301 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
302 return include_by_branch(cond, cond_len);
304 /* unknown conditionals are always false */
305 return 0;
308 int git_config_include(const char *var, const char *value, void *data)
310 struct config_include_data *inc = data;
311 const char *cond, *key;
312 int cond_len;
313 int ret;
316 * Pass along all values, including "include" directives; this makes it
317 * possible to query information on the includes themselves.
319 ret = inc->fn(var, value, inc->data);
320 if (ret < 0)
321 return ret;
323 if (!strcmp(var, "include.path"))
324 ret = handle_path_include(value, inc);
326 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
327 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
328 !strcmp(key, "path"))
329 ret = handle_path_include(value, inc);
331 return ret;
334 void git_config_push_parameter(const char *text)
336 struct strbuf env = STRBUF_INIT;
337 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
338 if (old && *old) {
339 strbuf_addstr(&env, old);
340 strbuf_addch(&env, ' ');
342 sq_quote_buf(&env, text);
343 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
344 strbuf_release(&env);
347 static inline int iskeychar(int c)
349 return isalnum(c) || c == '-';
353 * Auxiliary function to sanity-check and split the key into the section
354 * identifier and variable name.
356 * Returns 0 on success, -1 when there is an invalid character in the key and
357 * -2 if there is no section name in the key.
359 * store_key - pointer to char* which will hold a copy of the key with
360 * lowercase section and variable name
361 * baselen - pointer to int which will hold the length of the
362 * section + subsection part, can be NULL
364 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
366 int i, dot, baselen;
367 const char *last_dot = strrchr(key, '.');
370 * Since "key" actually contains the section name and the real
371 * key name separated by a dot, we have to know where the dot is.
374 if (last_dot == NULL || last_dot == key) {
375 if (!quiet)
376 error(_("key does not contain a section: %s"), key);
377 return -CONFIG_NO_SECTION_OR_NAME;
380 if (!last_dot[1]) {
381 if (!quiet)
382 error(_("key does not contain variable name: %s"), key);
383 return -CONFIG_NO_SECTION_OR_NAME;
386 baselen = last_dot - key;
387 if (baselen_)
388 *baselen_ = baselen;
391 * Validate the key and while at it, lower case it for matching.
393 if (store_key)
394 *store_key = xmallocz(strlen(key));
396 dot = 0;
397 for (i = 0; key[i]; i++) {
398 unsigned char c = key[i];
399 if (c == '.')
400 dot = 1;
401 /* Leave the extended basename untouched.. */
402 if (!dot || i > baselen) {
403 if (!iskeychar(c) ||
404 (i == baselen + 1 && !isalpha(c))) {
405 if (!quiet)
406 error(_("invalid key: %s"), key);
407 goto out_free_ret_1;
409 c = tolower(c);
410 } else if (c == '\n') {
411 if (!quiet)
412 error(_("invalid key (newline): %s"), key);
413 goto out_free_ret_1;
415 if (store_key)
416 (*store_key)[i] = c;
419 return 0;
421 out_free_ret_1:
422 if (store_key) {
423 FREE_AND_NULL(*store_key);
425 return -CONFIG_INVALID_KEY;
428 int git_config_parse_key(const char *key, char **store_key, int *baselen)
430 return git_config_parse_key_1(key, store_key, baselen, 0);
433 int git_config_key_is_valid(const char *key)
435 return !git_config_parse_key_1(key, NULL, NULL, 1);
438 int git_config_parse_parameter(const char *text,
439 config_fn_t fn, void *data)
441 const char *value;
442 char *canonical_name;
443 struct strbuf **pair;
444 int ret;
446 pair = strbuf_split_str(text, '=', 2);
447 if (!pair[0])
448 return error(_("bogus config parameter: %s"), text);
450 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
451 strbuf_setlen(pair[0], pair[0]->len - 1);
452 value = pair[1] ? pair[1]->buf : "";
453 } else {
454 value = NULL;
457 strbuf_trim(pair[0]);
458 if (!pair[0]->len) {
459 strbuf_list_free(pair);
460 return error(_("bogus config parameter: %s"), text);
463 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
464 ret = -1;
465 } else {
466 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
467 free(canonical_name);
469 strbuf_list_free(pair);
470 return ret;
473 int git_config_from_parameters(config_fn_t fn, void *data)
475 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
476 int ret = 0;
477 char *envw;
478 const char **argv = NULL;
479 int nr = 0, alloc = 0;
480 int i;
481 struct config_source source;
483 if (!env)
484 return 0;
486 memset(&source, 0, sizeof(source));
487 source.prev = cf;
488 source.origin_type = CONFIG_ORIGIN_CMDLINE;
489 cf = &source;
491 /* sq_dequote will write over it */
492 envw = xstrdup(env);
494 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
495 ret = error(_("bogus format in %s"), CONFIG_DATA_ENVIRONMENT);
496 goto out;
499 for (i = 0; i < nr; i++) {
500 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
501 ret = -1;
502 goto out;
506 out:
507 free(argv);
508 free(envw);
509 cf = source.prev;
510 return ret;
513 static int get_next_char(void)
515 int c = cf->do_fgetc(cf);
517 if (c == '\r') {
518 /* DOS like systems */
519 c = cf->do_fgetc(cf);
520 if (c != '\n') {
521 if (c != EOF)
522 cf->do_ungetc(c, cf);
523 c = '\r';
526 if (c == '\n')
527 cf->linenr++;
528 if (c == EOF) {
529 cf->eof = 1;
530 cf->linenr++;
531 c = '\n';
533 return c;
536 static char *parse_value(void)
538 int quote = 0, comment = 0, space = 0;
540 strbuf_reset(&cf->value);
541 for (;;) {
542 int c = get_next_char();
543 if (c == '\n') {
544 if (quote) {
545 cf->linenr--;
546 return NULL;
548 return cf->value.buf;
550 if (comment)
551 continue;
552 if (isspace(c) && !quote) {
553 if (cf->value.len)
554 space++;
555 continue;
557 if (!quote) {
558 if (c == ';' || c == '#') {
559 comment = 1;
560 continue;
563 for (; space; space--)
564 strbuf_addch(&cf->value, ' ');
565 if (c == '\\') {
566 c = get_next_char();
567 switch (c) {
568 case '\n':
569 continue;
570 case 't':
571 c = '\t';
572 break;
573 case 'b':
574 c = '\b';
575 break;
576 case 'n':
577 c = '\n';
578 break;
579 /* Some characters escape as themselves */
580 case '\\': case '"':
581 break;
582 /* Reject unknown escape sequences */
583 default:
584 return NULL;
586 strbuf_addch(&cf->value, c);
587 continue;
589 if (c == '"') {
590 quote = 1-quote;
591 continue;
593 strbuf_addch(&cf->value, c);
597 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
599 int c;
600 char *value;
601 int ret;
603 /* Get the full name */
604 for (;;) {
605 c = get_next_char();
606 if (cf->eof)
607 break;
608 if (!iskeychar(c))
609 break;
610 strbuf_addch(name, tolower(c));
613 while (c == ' ' || c == '\t')
614 c = get_next_char();
616 value = NULL;
617 if (c != '\n') {
618 if (c != '=')
619 return -1;
620 value = parse_value();
621 if (!value)
622 return -1;
625 * We already consumed the \n, but we need linenr to point to
626 * the line we just parsed during the call to fn to get
627 * accurate line number in error messages.
629 cf->linenr--;
630 ret = fn(name->buf, value, data);
631 if (ret >= 0)
632 cf->linenr++;
633 return ret;
636 static int get_extended_base_var(struct strbuf *name, int c)
638 cf->subsection_case_sensitive = 0;
639 do {
640 if (c == '\n')
641 goto error_incomplete_line;
642 c = get_next_char();
643 } while (isspace(c));
645 /* We require the format to be '[base "extension"]' */
646 if (c != '"')
647 return -1;
648 strbuf_addch(name, '.');
650 for (;;) {
651 int c = get_next_char();
652 if (c == '\n')
653 goto error_incomplete_line;
654 if (c == '"')
655 break;
656 if (c == '\\') {
657 c = get_next_char();
658 if (c == '\n')
659 goto error_incomplete_line;
661 strbuf_addch(name, c);
664 /* Final ']' */
665 if (get_next_char() != ']')
666 return -1;
667 return 0;
668 error_incomplete_line:
669 cf->linenr--;
670 return -1;
673 static int get_base_var(struct strbuf *name)
675 cf->subsection_case_sensitive = 1;
676 for (;;) {
677 int c = get_next_char();
678 if (cf->eof)
679 return -1;
680 if (c == ']')
681 return 0;
682 if (isspace(c))
683 return get_extended_base_var(name, c);
684 if (!iskeychar(c) && c != '.')
685 return -1;
686 strbuf_addch(name, tolower(c));
690 struct parse_event_data {
691 enum config_event_t previous_type;
692 size_t previous_offset;
693 const struct config_options *opts;
696 static int do_event(enum config_event_t type, struct parse_event_data *data)
698 size_t offset;
700 if (!data->opts || !data->opts->event_fn)
701 return 0;
703 if (type == CONFIG_EVENT_WHITESPACE &&
704 data->previous_type == type)
705 return 0;
707 offset = cf->do_ftell(cf);
709 * At EOF, the parser always "inserts" an extra '\n', therefore
710 * the end offset of the event is the current file position, otherwise
711 * we will already have advanced to the next event.
713 if (type != CONFIG_EVENT_EOF)
714 offset--;
716 if (data->previous_type != CONFIG_EVENT_EOF &&
717 data->opts->event_fn(data->previous_type, data->previous_offset,
718 offset, data->opts->event_fn_data) < 0)
719 return -1;
721 data->previous_type = type;
722 data->previous_offset = offset;
724 return 0;
727 static int git_parse_source(config_fn_t fn, void *data,
728 const struct config_options *opts)
730 int comment = 0;
731 int baselen = 0;
732 struct strbuf *var = &cf->var;
733 int error_return = 0;
734 char *error_msg = NULL;
736 /* U+FEFF Byte Order Mark in UTF8 */
737 const char *bomptr = utf8_bom;
739 /* For the parser event callback */
740 struct parse_event_data event_data = {
741 CONFIG_EVENT_EOF, 0, opts
744 for (;;) {
745 int c;
747 c = get_next_char();
748 if (bomptr && *bomptr) {
749 /* We are at the file beginning; skip UTF8-encoded BOM
750 * if present. Sane editors won't put this in on their
751 * own, but e.g. Windows Notepad will do it happily. */
752 if (c == (*bomptr & 0377)) {
753 bomptr++;
754 continue;
755 } else {
756 /* Do not tolerate partial BOM. */
757 if (bomptr != utf8_bom)
758 break;
759 /* No BOM at file beginning. Cool. */
760 bomptr = NULL;
763 if (c == '\n') {
764 if (cf->eof) {
765 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
766 return -1;
767 return 0;
769 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
770 return -1;
771 comment = 0;
772 continue;
774 if (comment)
775 continue;
776 if (isspace(c)) {
777 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
778 return -1;
779 continue;
781 if (c == '#' || c == ';') {
782 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
783 return -1;
784 comment = 1;
785 continue;
787 if (c == '[') {
788 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
789 return -1;
791 /* Reset prior to determining a new stem */
792 strbuf_reset(var);
793 if (get_base_var(var) < 0 || var->len < 1)
794 break;
795 strbuf_addch(var, '.');
796 baselen = var->len;
797 continue;
799 if (!isalpha(c))
800 break;
802 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
803 return -1;
806 * Truncate the var name back to the section header
807 * stem prior to grabbing the suffix part of the name
808 * and the value.
810 strbuf_setlen(var, baselen);
811 strbuf_addch(var, tolower(c));
812 if (get_value(fn, data, var) < 0)
813 break;
816 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
817 return -1;
819 switch (cf->origin_type) {
820 case CONFIG_ORIGIN_BLOB:
821 error_msg = xstrfmt(_("bad config line %d in blob %s"),
822 cf->linenr, cf->name);
823 break;
824 case CONFIG_ORIGIN_FILE:
825 error_msg = xstrfmt(_("bad config line %d in file %s"),
826 cf->linenr, cf->name);
827 break;
828 case CONFIG_ORIGIN_STDIN:
829 error_msg = xstrfmt(_("bad config line %d in standard input"),
830 cf->linenr);
831 break;
832 case CONFIG_ORIGIN_SUBMODULE_BLOB:
833 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
834 cf->linenr, cf->name);
835 break;
836 case CONFIG_ORIGIN_CMDLINE:
837 error_msg = xstrfmt(_("bad config line %d in command line %s"),
838 cf->linenr, cf->name);
839 break;
840 default:
841 error_msg = xstrfmt(_("bad config line %d in %s"),
842 cf->linenr, cf->name);
845 switch (opts && opts->error_action ?
846 opts->error_action :
847 cf->default_error_action) {
848 case CONFIG_ERROR_DIE:
849 die("%s", error_msg);
850 break;
851 case CONFIG_ERROR_ERROR:
852 error_return = error("%s", error_msg);
853 break;
854 case CONFIG_ERROR_SILENT:
855 error_return = -1;
856 break;
857 case CONFIG_ERROR_UNSET:
858 BUG("config error action unset");
861 free(error_msg);
862 return error_return;
865 static uintmax_t get_unit_factor(const char *end)
867 if (!*end)
868 return 1;
869 else if (!strcasecmp(end, "k"))
870 return 1024;
871 else if (!strcasecmp(end, "m"))
872 return 1024 * 1024;
873 else if (!strcasecmp(end, "g"))
874 return 1024 * 1024 * 1024;
875 return 0;
878 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
880 if (value && *value) {
881 char *end;
882 intmax_t val;
883 uintmax_t uval;
884 uintmax_t factor;
886 errno = 0;
887 val = strtoimax(value, &end, 0);
888 if (errno == ERANGE)
889 return 0;
890 factor = get_unit_factor(end);
891 if (!factor) {
892 errno = EINVAL;
893 return 0;
895 uval = val < 0 ? -val : val;
896 if (unsigned_mult_overflows(factor, uval) ||
897 factor * uval > max) {
898 errno = ERANGE;
899 return 0;
901 val *= factor;
902 *ret = val;
903 return 1;
905 errno = EINVAL;
906 return 0;
909 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
911 if (value && *value) {
912 char *end;
913 uintmax_t val;
914 uintmax_t factor;
916 errno = 0;
917 val = strtoumax(value, &end, 0);
918 if (errno == ERANGE)
919 return 0;
920 factor = get_unit_factor(end);
921 if (!factor) {
922 errno = EINVAL;
923 return 0;
925 if (unsigned_mult_overflows(factor, val) ||
926 factor * val > max) {
927 errno = ERANGE;
928 return 0;
930 val *= factor;
931 *ret = val;
932 return 1;
934 errno = EINVAL;
935 return 0;
938 static int git_parse_int(const char *value, int *ret)
940 intmax_t tmp;
941 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
942 return 0;
943 *ret = tmp;
944 return 1;
947 static int git_parse_int64(const char *value, int64_t *ret)
949 intmax_t tmp;
950 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
951 return 0;
952 *ret = tmp;
953 return 1;
956 int git_parse_ulong(const char *value, unsigned long *ret)
958 uintmax_t tmp;
959 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
960 return 0;
961 *ret = tmp;
962 return 1;
965 int git_parse_ssize_t(const char *value, ssize_t *ret)
967 intmax_t tmp;
968 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
969 return 0;
970 *ret = tmp;
971 return 1;
974 NORETURN
975 static void die_bad_number(const char *name, const char *value)
977 const char *error_type = (errno == ERANGE) ?
978 N_("out of range") : N_("invalid unit");
979 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
981 if (!value)
982 value = "";
984 if (!strcmp(name, "GIT_TEST_GETTEXT_POISON"))
986 * We explicitly *don't* use _() here since it would
987 * cause an infinite loop with _() needing to call
988 * use_gettext_poison(). This is why marked up
989 * translations with N_() above.
991 die(bad_numeric, value, name, error_type);
993 if (!(cf && cf->name))
994 die(_(bad_numeric), value, name, _(error_type));
996 switch (cf->origin_type) {
997 case CONFIG_ORIGIN_BLOB:
998 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
999 value, name, cf->name, _(error_type));
1000 case CONFIG_ORIGIN_FILE:
1001 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1002 value, name, cf->name, _(error_type));
1003 case CONFIG_ORIGIN_STDIN:
1004 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1005 value, name, _(error_type));
1006 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1007 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1008 value, name, cf->name, _(error_type));
1009 case CONFIG_ORIGIN_CMDLINE:
1010 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1011 value, name, cf->name, _(error_type));
1012 default:
1013 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1014 value, name, cf->name, _(error_type));
1018 int git_config_int(const char *name, const char *value)
1020 int ret;
1021 if (!git_parse_int(value, &ret))
1022 die_bad_number(name, value);
1023 return ret;
1026 int64_t git_config_int64(const char *name, const char *value)
1028 int64_t ret;
1029 if (!git_parse_int64(value, &ret))
1030 die_bad_number(name, value);
1031 return ret;
1034 unsigned long git_config_ulong(const char *name, const char *value)
1036 unsigned long ret;
1037 if (!git_parse_ulong(value, &ret))
1038 die_bad_number(name, value);
1039 return ret;
1042 ssize_t git_config_ssize_t(const char *name, const char *value)
1044 ssize_t ret;
1045 if (!git_parse_ssize_t(value, &ret))
1046 die_bad_number(name, value);
1047 return ret;
1050 static int git_parse_maybe_bool_text(const char *value)
1052 if (!value)
1053 return 1;
1054 if (!*value)
1055 return 0;
1056 if (!strcasecmp(value, "true")
1057 || !strcasecmp(value, "yes")
1058 || !strcasecmp(value, "on"))
1059 return 1;
1060 if (!strcasecmp(value, "false")
1061 || !strcasecmp(value, "no")
1062 || !strcasecmp(value, "off"))
1063 return 0;
1064 return -1;
1067 int git_parse_maybe_bool(const char *value)
1069 int v = git_parse_maybe_bool_text(value);
1070 if (0 <= v)
1071 return v;
1072 if (git_parse_int(value, &v))
1073 return !!v;
1074 return -1;
1077 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1079 int v = git_parse_maybe_bool_text(value);
1080 if (0 <= v) {
1081 *is_bool = 1;
1082 return v;
1084 *is_bool = 0;
1085 return git_config_int(name, value);
1088 int git_config_bool(const char *name, const char *value)
1090 int discard;
1091 return !!git_config_bool_or_int(name, value, &discard);
1094 int git_config_string(const char **dest, const char *var, const char *value)
1096 if (!value)
1097 return config_error_nonbool(var);
1098 *dest = xstrdup(value);
1099 return 0;
1102 int git_config_pathname(const char **dest, const char *var, const char *value)
1104 if (!value)
1105 return config_error_nonbool(var);
1106 *dest = expand_user_path(value, 0);
1107 if (!*dest)
1108 die(_("failed to expand user dir in: '%s'"), value);
1109 return 0;
1112 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1114 if (!value)
1115 return config_error_nonbool(var);
1116 if (parse_expiry_date(value, timestamp))
1117 return error(_("'%s' for '%s' is not a valid timestamp"),
1118 value, var);
1119 return 0;
1122 int git_config_color(char *dest, const char *var, const char *value)
1124 if (!value)
1125 return config_error_nonbool(var);
1126 if (color_parse(value, dest) < 0)
1127 return -1;
1128 return 0;
1131 static int git_default_core_config(const char *var, const char *value, void *cb)
1133 /* This needs a better name */
1134 if (!strcmp(var, "core.filemode")) {
1135 trust_executable_bit = git_config_bool(var, value);
1136 return 0;
1138 if (!strcmp(var, "core.trustctime")) {
1139 trust_ctime = git_config_bool(var, value);
1140 return 0;
1142 if (!strcmp(var, "core.checkstat")) {
1143 if (!strcasecmp(value, "default"))
1144 check_stat = 1;
1145 else if (!strcasecmp(value, "minimal"))
1146 check_stat = 0;
1149 if (!strcmp(var, "core.quotepath")) {
1150 quote_path_fully = git_config_bool(var, value);
1151 return 0;
1154 if (!strcmp(var, "core.symlinks")) {
1155 has_symlinks = git_config_bool(var, value);
1156 return 0;
1159 if (!strcmp(var, "core.ignorecase")) {
1160 ignore_case = git_config_bool(var, value);
1161 return 0;
1164 if (!strcmp(var, "core.attributesfile"))
1165 return git_config_pathname(&git_attributes_file, var, value);
1167 if (!strcmp(var, "core.hookspath"))
1168 return git_config_pathname(&git_hooks_path, var, value);
1170 if (!strcmp(var, "core.bare")) {
1171 is_bare_repository_cfg = git_config_bool(var, value);
1172 return 0;
1175 if (!strcmp(var, "core.ignorestat")) {
1176 assume_unchanged = git_config_bool(var, value);
1177 return 0;
1180 if (!strcmp(var, "core.prefersymlinkrefs")) {
1181 prefer_symlink_refs = git_config_bool(var, value);
1182 return 0;
1185 if (!strcmp(var, "core.logallrefupdates")) {
1186 if (value && !strcasecmp(value, "always"))
1187 log_all_ref_updates = LOG_REFS_ALWAYS;
1188 else if (git_config_bool(var, value))
1189 log_all_ref_updates = LOG_REFS_NORMAL;
1190 else
1191 log_all_ref_updates = LOG_REFS_NONE;
1192 return 0;
1195 if (!strcmp(var, "core.warnambiguousrefs")) {
1196 warn_ambiguous_refs = git_config_bool(var, value);
1197 return 0;
1200 if (!strcmp(var, "core.abbrev")) {
1201 if (!value)
1202 return config_error_nonbool(var);
1203 if (!strcasecmp(value, "auto"))
1204 default_abbrev = -1;
1205 else {
1206 int abbrev = git_config_int(var, value);
1207 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1208 return error(_("abbrev length out of range: %d"), abbrev);
1209 default_abbrev = abbrev;
1211 return 0;
1214 if (!strcmp(var, "core.disambiguate"))
1215 return set_disambiguate_hint_config(var, value);
1217 if (!strcmp(var, "core.loosecompression")) {
1218 int level = git_config_int(var, value);
1219 if (level == -1)
1220 level = Z_DEFAULT_COMPRESSION;
1221 else if (level < 0 || level > Z_BEST_COMPRESSION)
1222 die(_("bad zlib compression level %d"), level);
1223 zlib_compression_level = level;
1224 zlib_compression_seen = 1;
1225 return 0;
1228 if (!strcmp(var, "core.compression")) {
1229 int level = git_config_int(var, value);
1230 if (level == -1)
1231 level = Z_DEFAULT_COMPRESSION;
1232 else if (level < 0 || level > Z_BEST_COMPRESSION)
1233 die(_("bad zlib compression level %d"), level);
1234 core_compression_level = level;
1235 core_compression_seen = 1;
1236 if (!zlib_compression_seen)
1237 zlib_compression_level = level;
1238 if (!pack_compression_seen)
1239 pack_compression_level = level;
1240 return 0;
1243 if (!strcmp(var, "core.packedgitwindowsize")) {
1244 int pgsz_x2 = getpagesize() * 2;
1245 packed_git_window_size = git_config_ulong(var, value);
1247 /* This value must be multiple of (pagesize * 2) */
1248 packed_git_window_size /= pgsz_x2;
1249 if (packed_git_window_size < 1)
1250 packed_git_window_size = 1;
1251 packed_git_window_size *= pgsz_x2;
1252 return 0;
1255 if (!strcmp(var, "core.bigfilethreshold")) {
1256 big_file_threshold = git_config_ulong(var, value);
1257 return 0;
1260 if (!strcmp(var, "core.packedgitlimit")) {
1261 packed_git_limit = git_config_ulong(var, value);
1262 return 0;
1265 if (!strcmp(var, "core.deltabasecachelimit")) {
1266 delta_base_cache_limit = git_config_ulong(var, value);
1267 return 0;
1270 if (!strcmp(var, "core.autocrlf")) {
1271 if (value && !strcasecmp(value, "input")) {
1272 auto_crlf = AUTO_CRLF_INPUT;
1273 return 0;
1275 auto_crlf = git_config_bool(var, value);
1276 return 0;
1279 if (!strcmp(var, "core.safecrlf")) {
1280 int eol_rndtrp_die;
1281 if (value && !strcasecmp(value, "warn")) {
1282 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1283 return 0;
1285 eol_rndtrp_die = git_config_bool(var, value);
1286 global_conv_flags_eol = eol_rndtrp_die ?
1287 CONV_EOL_RNDTRP_DIE : 0;
1288 return 0;
1291 if (!strcmp(var, "core.eol")) {
1292 if (value && !strcasecmp(value, "lf"))
1293 core_eol = EOL_LF;
1294 else if (value && !strcasecmp(value, "crlf"))
1295 core_eol = EOL_CRLF;
1296 else if (value && !strcasecmp(value, "native"))
1297 core_eol = EOL_NATIVE;
1298 else
1299 core_eol = EOL_UNSET;
1300 return 0;
1303 if (!strcmp(var, "core.checkroundtripencoding")) {
1304 check_roundtrip_encoding = xstrdup(value);
1305 return 0;
1308 if (!strcmp(var, "core.notesref")) {
1309 notes_ref_name = xstrdup(value);
1310 return 0;
1313 if (!strcmp(var, "core.editor"))
1314 return git_config_string(&editor_program, var, value);
1316 if (!strcmp(var, "core.commentchar")) {
1317 if (!value)
1318 return config_error_nonbool(var);
1319 else if (!strcasecmp(value, "auto"))
1320 auto_comment_line_char = 1;
1321 else if (value[0] && !value[1]) {
1322 comment_line_char = value[0];
1323 auto_comment_line_char = 0;
1324 } else
1325 return error(_("core.commentChar should only be one character"));
1326 return 0;
1329 if (!strcmp(var, "core.askpass"))
1330 return git_config_string(&askpass_program, var, value);
1332 if (!strcmp(var, "core.excludesfile"))
1333 return git_config_pathname(&excludes_file, var, value);
1335 if (!strcmp(var, "core.whitespace")) {
1336 if (!value)
1337 return config_error_nonbool(var);
1338 whitespace_rule_cfg = parse_whitespace_rule(value);
1339 return 0;
1342 if (!strcmp(var, "core.fsyncobjectfiles")) {
1343 fsync_object_files = git_config_bool(var, value);
1344 return 0;
1347 if (!strcmp(var, "core.preloadindex")) {
1348 core_preload_index = git_config_bool(var, value);
1349 return 0;
1352 if (!strcmp(var, "core.createobject")) {
1353 if (!strcmp(value, "rename"))
1354 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1355 else if (!strcmp(value, "link"))
1356 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1357 else
1358 die(_("invalid mode for object creation: %s"), value);
1359 return 0;
1362 if (!strcmp(var, "core.sparsecheckout")) {
1363 core_apply_sparse_checkout = git_config_bool(var, value);
1364 return 0;
1367 if (!strcmp(var, "core.sparsecheckoutcone")) {
1368 core_sparse_checkout_cone = git_config_bool(var, value);
1369 return 0;
1372 if (!strcmp(var, "core.precomposeunicode")) {
1373 precomposed_unicode = git_config_bool(var, value);
1374 return 0;
1377 if (!strcmp(var, "core.protecthfs")) {
1378 protect_hfs = git_config_bool(var, value);
1379 return 0;
1382 if (!strcmp(var, "core.protectntfs")) {
1383 protect_ntfs = git_config_bool(var, value);
1384 return 0;
1387 if (!strcmp(var, "core.usereplacerefs")) {
1388 read_replace_refs = git_config_bool(var, value);
1389 return 0;
1392 /* Add other config variables here and to Documentation/config.txt. */
1393 return platform_core_config(var, value, cb);
1396 static int git_default_i18n_config(const char *var, const char *value)
1398 if (!strcmp(var, "i18n.commitencoding"))
1399 return git_config_string(&git_commit_encoding, var, value);
1401 if (!strcmp(var, "i18n.logoutputencoding"))
1402 return git_config_string(&git_log_output_encoding, var, value);
1404 /* Add other config variables here and to Documentation/config.txt. */
1405 return 0;
1408 static int git_default_branch_config(const char *var, const char *value)
1410 if (!strcmp(var, "branch.autosetupmerge")) {
1411 if (value && !strcasecmp(value, "always")) {
1412 git_branch_track = BRANCH_TRACK_ALWAYS;
1413 return 0;
1415 git_branch_track = git_config_bool(var, value);
1416 return 0;
1418 if (!strcmp(var, "branch.autosetuprebase")) {
1419 if (!value)
1420 return config_error_nonbool(var);
1421 else if (!strcmp(value, "never"))
1422 autorebase = AUTOREBASE_NEVER;
1423 else if (!strcmp(value, "local"))
1424 autorebase = AUTOREBASE_LOCAL;
1425 else if (!strcmp(value, "remote"))
1426 autorebase = AUTOREBASE_REMOTE;
1427 else if (!strcmp(value, "always"))
1428 autorebase = AUTOREBASE_ALWAYS;
1429 else
1430 return error(_("malformed value for %s"), var);
1431 return 0;
1434 /* Add other config variables here and to Documentation/config.txt. */
1435 return 0;
1438 static int git_default_push_config(const char *var, const char *value)
1440 if (!strcmp(var, "push.default")) {
1441 if (!value)
1442 return config_error_nonbool(var);
1443 else if (!strcmp(value, "nothing"))
1444 push_default = PUSH_DEFAULT_NOTHING;
1445 else if (!strcmp(value, "matching"))
1446 push_default = PUSH_DEFAULT_MATCHING;
1447 else if (!strcmp(value, "simple"))
1448 push_default = PUSH_DEFAULT_SIMPLE;
1449 else if (!strcmp(value, "upstream"))
1450 push_default = PUSH_DEFAULT_UPSTREAM;
1451 else if (!strcmp(value, "tracking")) /* deprecated */
1452 push_default = PUSH_DEFAULT_UPSTREAM;
1453 else if (!strcmp(value, "current"))
1454 push_default = PUSH_DEFAULT_CURRENT;
1455 else {
1456 error(_("malformed value for %s: %s"), var, value);
1457 return error(_("must be one of nothing, matching, simple, "
1458 "upstream or current"));
1460 return 0;
1463 /* Add other config variables here and to Documentation/config.txt. */
1464 return 0;
1467 static int git_default_mailmap_config(const char *var, const char *value)
1469 if (!strcmp(var, "mailmap.file"))
1470 return git_config_pathname(&git_mailmap_file, var, value);
1471 if (!strcmp(var, "mailmap.blob"))
1472 return git_config_string(&git_mailmap_blob, var, value);
1474 /* Add other config variables here and to Documentation/config.txt. */
1475 return 0;
1478 int git_default_config(const char *var, const char *value, void *cb)
1480 if (starts_with(var, "core."))
1481 return git_default_core_config(var, value, cb);
1483 if (starts_with(var, "user.") ||
1484 starts_with(var, "author.") ||
1485 starts_with(var, "committer."))
1486 return git_ident_config(var, value, cb);
1488 if (starts_with(var, "i18n."))
1489 return git_default_i18n_config(var, value);
1491 if (starts_with(var, "branch."))
1492 return git_default_branch_config(var, value);
1494 if (starts_with(var, "push."))
1495 return git_default_push_config(var, value);
1497 if (starts_with(var, "mailmap."))
1498 return git_default_mailmap_config(var, value);
1500 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1501 return git_default_advice_config(var, value);
1503 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1504 pager_use_color = git_config_bool(var,value);
1505 return 0;
1508 if (!strcmp(var, "pack.packsizelimit")) {
1509 pack_size_limit_cfg = git_config_ulong(var, value);
1510 return 0;
1513 if (!strcmp(var, "pack.compression")) {
1514 int level = git_config_int(var, value);
1515 if (level == -1)
1516 level = Z_DEFAULT_COMPRESSION;
1517 else if (level < 0 || level > Z_BEST_COMPRESSION)
1518 die(_("bad pack compression level %d"), level);
1519 pack_compression_level = level;
1520 pack_compression_seen = 1;
1521 return 0;
1524 /* Add other config variables here and to Documentation/config.txt. */
1525 return 0;
1529 * All source specific fields in the union, die_on_error, name and the callbacks
1530 * fgetc, ungetc, ftell of top need to be initialized before calling
1531 * this function.
1533 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1534 const struct config_options *opts)
1536 int ret;
1538 /* push config-file parsing state stack */
1539 top->prev = cf;
1540 top->linenr = 1;
1541 top->eof = 0;
1542 strbuf_init(&top->value, 1024);
1543 strbuf_init(&top->var, 1024);
1544 cf = top;
1546 ret = git_parse_source(fn, data, opts);
1548 /* pop config-file parsing state stack */
1549 strbuf_release(&top->value);
1550 strbuf_release(&top->var);
1551 cf = top->prev;
1553 return ret;
1556 static int do_config_from_file(config_fn_t fn,
1557 const enum config_origin_type origin_type,
1558 const char *name, const char *path, FILE *f,
1559 void *data, const struct config_options *opts)
1561 struct config_source top;
1562 int ret;
1564 top.u.file = f;
1565 top.origin_type = origin_type;
1566 top.name = name;
1567 top.path = path;
1568 top.default_error_action = CONFIG_ERROR_DIE;
1569 top.do_fgetc = config_file_fgetc;
1570 top.do_ungetc = config_file_ungetc;
1571 top.do_ftell = config_file_ftell;
1573 flockfile(f);
1574 ret = do_config_from(&top, fn, data, opts);
1575 funlockfile(f);
1576 return ret;
1579 static int git_config_from_stdin(config_fn_t fn, void *data)
1581 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1582 data, NULL);
1585 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1586 void *data,
1587 const struct config_options *opts)
1589 int ret = -1;
1590 FILE *f;
1592 f = fopen_or_warn(filename, "r");
1593 if (f) {
1594 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1595 filename, f, data, opts);
1596 fclose(f);
1598 return ret;
1601 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1603 return git_config_from_file_with_options(fn, filename, data, NULL);
1606 int git_config_from_mem(config_fn_t fn,
1607 const enum config_origin_type origin_type,
1608 const char *name, const char *buf, size_t len,
1609 void *data, const struct config_options *opts)
1611 struct config_source top;
1613 top.u.buf.buf = buf;
1614 top.u.buf.len = len;
1615 top.u.buf.pos = 0;
1616 top.origin_type = origin_type;
1617 top.name = name;
1618 top.path = NULL;
1619 top.default_error_action = CONFIG_ERROR_ERROR;
1620 top.do_fgetc = config_buf_fgetc;
1621 top.do_ungetc = config_buf_ungetc;
1622 top.do_ftell = config_buf_ftell;
1624 return do_config_from(&top, fn, data, opts);
1627 int git_config_from_blob_oid(config_fn_t fn,
1628 const char *name,
1629 const struct object_id *oid,
1630 void *data)
1632 enum object_type type;
1633 char *buf;
1634 unsigned long size;
1635 int ret;
1637 buf = read_object_file(oid, &type, &size);
1638 if (!buf)
1639 return error(_("unable to load config blob object '%s'"), name);
1640 if (type != OBJ_BLOB) {
1641 free(buf);
1642 return error(_("reference '%s' does not point to a blob"), name);
1645 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1646 data, NULL);
1647 free(buf);
1649 return ret;
1652 static int git_config_from_blob_ref(config_fn_t fn,
1653 const char *name,
1654 void *data)
1656 struct object_id oid;
1658 if (get_oid(name, &oid) < 0)
1659 return error(_("unable to resolve config blob '%s'"), name);
1660 return git_config_from_blob_oid(fn, name, &oid, data);
1663 const char *git_etc_gitconfig(void)
1665 static const char *system_wide;
1666 if (!system_wide)
1667 system_wide = system_path(ETC_GITCONFIG);
1668 return system_wide;
1672 * Parse environment variable 'k' as a boolean (in various
1673 * possible spellings); if missing, use the default value 'def'.
1675 int git_env_bool(const char *k, int def)
1677 const char *v = getenv(k);
1678 return v ? git_config_bool(k, v) : def;
1682 * Parse environment variable 'k' as ulong with possibly a unit
1683 * suffix; if missing, use the default value 'val'.
1685 unsigned long git_env_ulong(const char *k, unsigned long val)
1687 const char *v = getenv(k);
1688 if (v && !git_parse_ulong(v, &val))
1689 die(_("failed to parse %s"), k);
1690 return val;
1693 int git_config_system(void)
1695 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1698 static int do_git_config_sequence(const struct config_options *opts,
1699 config_fn_t fn, void *data)
1701 int ret = 0;
1702 char *xdg_config = xdg_config_home("config");
1703 char *user_config = expand_user_path("~/.gitconfig", 0);
1704 char *repo_config;
1706 if (opts->commondir)
1707 repo_config = mkpathdup("%s/config", opts->commondir);
1708 else if (opts->git_dir)
1709 BUG("git_dir without commondir");
1710 else
1711 repo_config = NULL;
1713 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1714 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK,
1715 opts->system_gently ?
1716 ACCESS_EACCES_OK : 0))
1717 ret += git_config_from_file(fn, git_etc_gitconfig(),
1718 data);
1720 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1721 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1722 ret += git_config_from_file(fn, xdg_config, data);
1724 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1725 ret += git_config_from_file(fn, user_config, data);
1727 current_parsing_scope = CONFIG_SCOPE_REPO;
1728 if (!opts->ignore_repo && repo_config &&
1729 !access_or_die(repo_config, R_OK, 0))
1730 ret += git_config_from_file(fn, repo_config, data);
1733 * Note: this should have a new scope, CONFIG_SCOPE_WORKTREE.
1734 * But let's not complicate things before it's actually needed.
1736 if (!opts->ignore_worktree && repository_format_worktree_config) {
1737 char *path = git_pathdup("config.worktree");
1738 if (!access_or_die(path, R_OK, 0))
1739 ret += git_config_from_file(fn, path, data);
1740 free(path);
1743 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1744 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
1745 die(_("unable to parse command-line config"));
1747 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1748 free(xdg_config);
1749 free(user_config);
1750 free(repo_config);
1751 return ret;
1754 int config_with_options(config_fn_t fn, void *data,
1755 struct git_config_source *config_source,
1756 const struct config_options *opts)
1758 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1760 if (opts->respect_includes) {
1761 inc.fn = fn;
1762 inc.data = data;
1763 inc.opts = opts;
1764 fn = git_config_include;
1765 data = &inc;
1769 * If we have a specific filename, use it. Otherwise, follow the
1770 * regular lookup sequence.
1772 if (config_source && config_source->use_stdin)
1773 return git_config_from_stdin(fn, data);
1774 else if (config_source && config_source->file)
1775 return git_config_from_file(fn, config_source->file, data);
1776 else if (config_source && config_source->blob)
1777 return git_config_from_blob_ref(fn, config_source->blob, data);
1779 return do_git_config_sequence(opts, fn, data);
1782 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1784 int i, value_index;
1785 struct string_list *values;
1786 struct config_set_element *entry;
1787 struct configset_list *list = &cs->list;
1789 for (i = 0; i < list->nr; i++) {
1790 entry = list->items[i].e;
1791 value_index = list->items[i].value_index;
1792 values = &entry->value_list;
1794 current_config_kvi = values->items[value_index].util;
1796 if (fn(entry->key, values->items[value_index].string, data) < 0)
1797 git_die_config_linenr(entry->key,
1798 current_config_kvi->filename,
1799 current_config_kvi->linenr);
1801 current_config_kvi = NULL;
1805 void read_early_config(config_fn_t cb, void *data)
1807 struct config_options opts = {0};
1808 struct strbuf commondir = STRBUF_INIT;
1809 struct strbuf gitdir = STRBUF_INIT;
1811 opts.respect_includes = 1;
1813 if (have_git_dir()) {
1814 opts.commondir = get_git_common_dir();
1815 opts.git_dir = get_git_dir();
1817 * When setup_git_directory() was not yet asked to discover the
1818 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1819 * is any repository config we should use (but unlike
1820 * setup_git_directory_gently(), no global state is changed, most
1821 * notably, the current working directory is still the same after the
1822 * call).
1824 } else if (!discover_git_directory(&commondir, &gitdir)) {
1825 opts.commondir = commondir.buf;
1826 opts.git_dir = gitdir.buf;
1829 config_with_options(cb, data, NULL, &opts);
1831 strbuf_release(&commondir);
1832 strbuf_release(&gitdir);
1836 * Read config but only enumerate system and global settings.
1837 * Omit any repo-local, worktree-local, or command-line settings.
1839 void read_very_early_config(config_fn_t cb, void *data)
1841 struct config_options opts = { 0 };
1843 opts.respect_includes = 1;
1844 opts.ignore_repo = 1;
1845 opts.ignore_worktree = 1;
1846 opts.ignore_cmdline = 1;
1847 opts.system_gently = 1;
1849 config_with_options(cb, data, NULL, &opts);
1852 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1854 struct config_set_element k;
1855 struct config_set_element *found_entry;
1856 char *normalized_key;
1858 * `key` may come from the user, so normalize it before using it
1859 * for querying entries from the hashmap.
1861 if (git_config_parse_key(key, &normalized_key, NULL))
1862 return NULL;
1864 hashmap_entry_init(&k.ent, strhash(normalized_key));
1865 k.key = normalized_key;
1866 found_entry = hashmap_get_entry(&cs->config_hash, &k, ent, NULL);
1867 free(normalized_key);
1868 return found_entry;
1871 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1873 struct config_set_element *e;
1874 struct string_list_item *si;
1875 struct configset_list_item *l_item;
1876 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1878 e = configset_find_element(cs, key);
1880 * Since the keys are being fed by git_config*() callback mechanism, they
1881 * are already normalized. So simply add them without any further munging.
1883 if (!e) {
1884 e = xmalloc(sizeof(*e));
1885 hashmap_entry_init(&e->ent, strhash(key));
1886 e->key = xstrdup(key);
1887 string_list_init(&e->value_list, 1);
1888 hashmap_add(&cs->config_hash, &e->ent);
1890 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1892 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1893 l_item = &cs->list.items[cs->list.nr++];
1894 l_item->e = e;
1895 l_item->value_index = e->value_list.nr - 1;
1897 if (!cf)
1898 BUG("configset_add_value has no source");
1899 if (cf->name) {
1900 kv_info->filename = strintern(cf->name);
1901 kv_info->linenr = cf->linenr;
1902 kv_info->origin_type = cf->origin_type;
1903 } else {
1904 /* for values read from `git_config_from_parameters()` */
1905 kv_info->filename = NULL;
1906 kv_info->linenr = -1;
1907 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1909 kv_info->scope = current_parsing_scope;
1910 si->util = kv_info;
1912 return 0;
1915 static int config_set_element_cmp(const void *unused_cmp_data,
1916 const struct hashmap_entry *eptr,
1917 const struct hashmap_entry *entry_or_key,
1918 const void *unused_keydata)
1920 const struct config_set_element *e1, *e2;
1922 e1 = container_of(eptr, const struct config_set_element, ent);
1923 e2 = container_of(entry_or_key, const struct config_set_element, ent);
1925 return strcmp(e1->key, e2->key);
1928 void git_configset_init(struct config_set *cs)
1930 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1931 cs->hash_initialized = 1;
1932 cs->list.nr = 0;
1933 cs->list.alloc = 0;
1934 cs->list.items = NULL;
1937 void git_configset_clear(struct config_set *cs)
1939 struct config_set_element *entry;
1940 struct hashmap_iter iter;
1941 if (!cs->hash_initialized)
1942 return;
1944 hashmap_for_each_entry(&cs->config_hash, &iter, entry,
1945 ent /* member name */) {
1946 free(entry->key);
1947 string_list_clear(&entry->value_list, 1);
1949 hashmap_free_entries(&cs->config_hash, struct config_set_element, ent);
1950 cs->hash_initialized = 0;
1951 free(cs->list.items);
1952 cs->list.nr = 0;
1953 cs->list.alloc = 0;
1954 cs->list.items = NULL;
1957 static int config_set_callback(const char *key, const char *value, void *cb)
1959 struct config_set *cs = cb;
1960 configset_add_value(cs, key, value);
1961 return 0;
1964 int git_configset_add_file(struct config_set *cs, const char *filename)
1966 return git_config_from_file(config_set_callback, filename, cs);
1969 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1971 const struct string_list *values = NULL;
1973 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1974 * queried key in the files of the configset, the value returned will be the last
1975 * value in the value list for that key.
1977 values = git_configset_get_value_multi(cs, key);
1979 if (!values)
1980 return 1;
1981 assert(values->nr > 0);
1982 *value = values->items[values->nr - 1].string;
1983 return 0;
1986 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1988 struct config_set_element *e = configset_find_element(cs, key);
1989 return e ? &e->value_list : NULL;
1992 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1994 const char *value;
1995 if (!git_configset_get_value(cs, key, &value))
1996 return git_config_string(dest, key, value);
1997 else
1998 return 1;
2001 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
2003 return git_configset_get_string_const(cs, key, (const char **)dest);
2006 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
2008 const char *value;
2009 if (!git_configset_get_value(cs, key, &value)) {
2010 *dest = git_config_int(key, value);
2011 return 0;
2012 } else
2013 return 1;
2016 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
2018 const char *value;
2019 if (!git_configset_get_value(cs, key, &value)) {
2020 *dest = git_config_ulong(key, value);
2021 return 0;
2022 } else
2023 return 1;
2026 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
2028 const char *value;
2029 if (!git_configset_get_value(cs, key, &value)) {
2030 *dest = git_config_bool(key, value);
2031 return 0;
2032 } else
2033 return 1;
2036 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
2037 int *is_bool, int *dest)
2039 const char *value;
2040 if (!git_configset_get_value(cs, key, &value)) {
2041 *dest = git_config_bool_or_int(key, value, is_bool);
2042 return 0;
2043 } else
2044 return 1;
2047 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
2049 const char *value;
2050 if (!git_configset_get_value(cs, key, &value)) {
2051 *dest = git_parse_maybe_bool(value);
2052 if (*dest == -1)
2053 return -1;
2054 return 0;
2055 } else
2056 return 1;
2059 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
2061 const char *value;
2062 if (!git_configset_get_value(cs, key, &value))
2063 return git_config_pathname(dest, key, value);
2064 else
2065 return 1;
2068 /* Functions use to read configuration from a repository */
2069 static void repo_read_config(struct repository *repo)
2071 struct config_options opts = { 0 };
2073 opts.respect_includes = 1;
2074 opts.commondir = repo->commondir;
2075 opts.git_dir = repo->gitdir;
2077 if (!repo->config)
2078 repo->config = xcalloc(1, sizeof(struct config_set));
2079 else
2080 git_configset_clear(repo->config);
2082 git_configset_init(repo->config);
2084 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2086 * config_with_options() normally returns only
2087 * zero, as most errors are fatal, and
2088 * non-fatal potential errors are guarded by "if"
2089 * statements that are entered only when no error is
2090 * possible.
2092 * If we ever encounter a non-fatal error, it means
2093 * something went really wrong and we should stop
2094 * immediately.
2096 die(_("unknown error occurred while reading the configuration files"));
2099 static void git_config_check_init(struct repository *repo)
2101 if (repo->config && repo->config->hash_initialized)
2102 return;
2103 repo_read_config(repo);
2106 static void repo_config_clear(struct repository *repo)
2108 if (!repo->config || !repo->config->hash_initialized)
2109 return;
2110 git_configset_clear(repo->config);
2113 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2115 git_config_check_init(repo);
2116 configset_iter(repo->config, fn, data);
2119 int repo_config_get_value(struct repository *repo,
2120 const char *key, const char **value)
2122 git_config_check_init(repo);
2123 return git_configset_get_value(repo->config, key, value);
2126 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2127 const char *key)
2129 git_config_check_init(repo);
2130 return git_configset_get_value_multi(repo->config, key);
2133 int repo_config_get_string_const(struct repository *repo,
2134 const char *key, const char **dest)
2136 int ret;
2137 git_config_check_init(repo);
2138 ret = git_configset_get_string_const(repo->config, key, dest);
2139 if (ret < 0)
2140 git_die_config(key, NULL);
2141 return ret;
2144 int repo_config_get_string(struct repository *repo,
2145 const char *key, char **dest)
2147 git_config_check_init(repo);
2148 return repo_config_get_string_const(repo, key, (const char **)dest);
2151 int repo_config_get_int(struct repository *repo,
2152 const char *key, int *dest)
2154 git_config_check_init(repo);
2155 return git_configset_get_int(repo->config, key, dest);
2158 int repo_config_get_ulong(struct repository *repo,
2159 const char *key, unsigned long *dest)
2161 git_config_check_init(repo);
2162 return git_configset_get_ulong(repo->config, key, dest);
2165 int repo_config_get_bool(struct repository *repo,
2166 const char *key, int *dest)
2168 git_config_check_init(repo);
2169 return git_configset_get_bool(repo->config, key, dest);
2172 int repo_config_get_bool_or_int(struct repository *repo,
2173 const char *key, int *is_bool, int *dest)
2175 git_config_check_init(repo);
2176 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2179 int repo_config_get_maybe_bool(struct repository *repo,
2180 const char *key, int *dest)
2182 git_config_check_init(repo);
2183 return git_configset_get_maybe_bool(repo->config, key, dest);
2186 int repo_config_get_pathname(struct repository *repo,
2187 const char *key, const char **dest)
2189 int ret;
2190 git_config_check_init(repo);
2191 ret = git_configset_get_pathname(repo->config, key, dest);
2192 if (ret < 0)
2193 git_die_config(key, NULL);
2194 return ret;
2197 /* Functions used historically to read configuration from 'the_repository' */
2198 void git_config(config_fn_t fn, void *data)
2200 repo_config(the_repository, fn, data);
2203 void git_config_clear(void)
2205 repo_config_clear(the_repository);
2208 int git_config_get_value(const char *key, const char **value)
2210 return repo_config_get_value(the_repository, key, value);
2213 const struct string_list *git_config_get_value_multi(const char *key)
2215 return repo_config_get_value_multi(the_repository, key);
2218 int git_config_get_string_const(const char *key, const char **dest)
2220 return repo_config_get_string_const(the_repository, key, dest);
2223 int git_config_get_string(const char *key, char **dest)
2225 return repo_config_get_string(the_repository, key, dest);
2228 int git_config_get_int(const char *key, int *dest)
2230 return repo_config_get_int(the_repository, key, dest);
2233 int git_config_get_ulong(const char *key, unsigned long *dest)
2235 return repo_config_get_ulong(the_repository, key, dest);
2238 int git_config_get_bool(const char *key, int *dest)
2240 return repo_config_get_bool(the_repository, key, dest);
2243 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2245 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2248 int git_config_get_maybe_bool(const char *key, int *dest)
2250 return repo_config_get_maybe_bool(the_repository, key, dest);
2253 int git_config_get_pathname(const char *key, const char **dest)
2255 return repo_config_get_pathname(the_repository, key, dest);
2258 int git_config_get_expiry(const char *key, const char **output)
2260 int ret = git_config_get_string_const(key, output);
2261 if (ret)
2262 return ret;
2263 if (strcmp(*output, "now")) {
2264 timestamp_t now = approxidate("now");
2265 if (approxidate(*output) >= now)
2266 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2268 return ret;
2271 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2273 char *expiry_string;
2274 intmax_t days;
2275 timestamp_t when;
2277 if (git_config_get_string(key, &expiry_string))
2278 return 1; /* no such thing */
2280 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2281 const int scale = 86400;
2282 *expiry = now - days * scale;
2283 return 0;
2286 if (!parse_expiry_date(expiry_string, &when)) {
2287 *expiry = when;
2288 return 0;
2290 return -1; /* thing exists but cannot be parsed */
2293 int git_config_get_split_index(void)
2295 int val;
2297 if (!git_config_get_maybe_bool("core.splitindex", &val))
2298 return val;
2300 return -1; /* default value */
2303 int git_config_get_max_percent_split_change(void)
2305 int val = -1;
2307 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2308 if (0 <= val && val <= 100)
2309 return val;
2311 return error(_("splitIndex.maxPercentChange value '%d' "
2312 "should be between 0 and 100"), val);
2315 return -1; /* default value */
2318 int git_config_get_fsmonitor(void)
2320 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2321 core_fsmonitor = getenv("GIT_TEST_FSMONITOR");
2323 if (core_fsmonitor && !*core_fsmonitor)
2324 core_fsmonitor = NULL;
2326 if (core_fsmonitor)
2327 return 1;
2329 return 0;
2332 int git_config_get_index_threads(int *dest)
2334 int is_bool, val;
2336 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2337 if (val) {
2338 *dest = val;
2339 return 0;
2342 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2343 if (is_bool)
2344 *dest = val ? 0 : 1;
2345 else
2346 *dest = val;
2347 return 0;
2350 return 1;
2353 NORETURN
2354 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2356 if (!filename)
2357 die(_("unable to parse '%s' from command-line config"), key);
2358 else
2359 die(_("bad config variable '%s' in file '%s' at line %d"),
2360 key, filename, linenr);
2363 NORETURN __attribute__((format(printf, 2, 3)))
2364 void git_die_config(const char *key, const char *err, ...)
2366 const struct string_list *values;
2367 struct key_value_info *kv_info;
2369 if (err) {
2370 va_list params;
2371 va_start(params, err);
2372 vreportf("error: ", err, params);
2373 va_end(params);
2375 values = git_config_get_value_multi(key);
2376 kv_info = values->items[values->nr - 1].util;
2377 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2381 * Find all the stuff for git_config_set() below.
2384 struct config_store_data {
2385 int baselen;
2386 char *key;
2387 int do_not_match;
2388 regex_t *value_regex;
2389 int multi_replace;
2390 struct {
2391 size_t begin, end;
2392 enum config_event_t type;
2393 int is_keys_section;
2394 } *parsed;
2395 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2396 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2399 static void config_store_data_clear(struct config_store_data *store)
2401 free(store->key);
2402 if (store->value_regex != NULL &&
2403 store->value_regex != CONFIG_REGEX_NONE) {
2404 regfree(store->value_regex);
2405 free(store->value_regex);
2407 free(store->parsed);
2408 free(store->seen);
2409 memset(store, 0, sizeof(*store));
2412 static int matches(const char *key, const char *value,
2413 const struct config_store_data *store)
2415 if (strcmp(key, store->key))
2416 return 0; /* not ours */
2417 if (!store->value_regex)
2418 return 1; /* always matches */
2419 if (store->value_regex == CONFIG_REGEX_NONE)
2420 return 0; /* never matches */
2422 return store->do_not_match ^
2423 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2426 static int store_aux_event(enum config_event_t type,
2427 size_t begin, size_t end, void *data)
2429 struct config_store_data *store = data;
2431 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2432 store->parsed[store->parsed_nr].begin = begin;
2433 store->parsed[store->parsed_nr].end = end;
2434 store->parsed[store->parsed_nr].type = type;
2436 if (type == CONFIG_EVENT_SECTION) {
2437 int (*cmpfn)(const char *, const char *, size_t);
2439 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2440 return error(_("invalid section name '%s'"), cf->var.buf);
2442 if (cf->subsection_case_sensitive)
2443 cmpfn = strncasecmp;
2444 else
2445 cmpfn = strncmp;
2447 /* Is this the section we were looking for? */
2448 store->is_keys_section =
2449 store->parsed[store->parsed_nr].is_keys_section =
2450 cf->var.len - 1 == store->baselen &&
2451 !cmpfn(cf->var.buf, store->key, store->baselen);
2452 if (store->is_keys_section) {
2453 store->section_seen = 1;
2454 ALLOC_GROW(store->seen, store->seen_nr + 1,
2455 store->seen_alloc);
2456 store->seen[store->seen_nr] = store->parsed_nr;
2460 store->parsed_nr++;
2462 return 0;
2465 static int store_aux(const char *key, const char *value, void *cb)
2467 struct config_store_data *store = cb;
2469 if (store->key_seen) {
2470 if (matches(key, value, store)) {
2471 if (store->seen_nr == 1 && store->multi_replace == 0) {
2472 warning(_("%s has multiple values"), key);
2475 ALLOC_GROW(store->seen, store->seen_nr + 1,
2476 store->seen_alloc);
2478 store->seen[store->seen_nr] = store->parsed_nr;
2479 store->seen_nr++;
2481 } else if (store->is_keys_section) {
2483 * Do not increment matches yet: this may not be a match, but we
2484 * are in the desired section.
2486 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2487 store->seen[store->seen_nr] = store->parsed_nr;
2488 store->section_seen = 1;
2490 if (matches(key, value, store)) {
2491 store->seen_nr++;
2492 store->key_seen = 1;
2496 return 0;
2499 static int write_error(const char *filename)
2501 error(_("failed to write new configuration file %s"), filename);
2503 /* Same error code as "failed to rename". */
2504 return 4;
2507 static struct strbuf store_create_section(const char *key,
2508 const struct config_store_data *store)
2510 const char *dot;
2511 int i;
2512 struct strbuf sb = STRBUF_INIT;
2514 dot = memchr(key, '.', store->baselen);
2515 if (dot) {
2516 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2517 for (i = dot - key + 1; i < store->baselen; i++) {
2518 if (key[i] == '"' || key[i] == '\\')
2519 strbuf_addch(&sb, '\\');
2520 strbuf_addch(&sb, key[i]);
2522 strbuf_addstr(&sb, "\"]\n");
2523 } else {
2524 strbuf_addf(&sb, "[%.*s]\n", store->baselen, key);
2527 return sb;
2530 static ssize_t write_section(int fd, const char *key,
2531 const struct config_store_data *store)
2533 struct strbuf sb = store_create_section(key, store);
2534 ssize_t ret;
2536 ret = write_in_full(fd, sb.buf, sb.len);
2537 strbuf_release(&sb);
2539 return ret;
2542 static ssize_t write_pair(int fd, const char *key, const char *value,
2543 const struct config_store_data *store)
2545 int i;
2546 ssize_t ret;
2547 int length = strlen(key + store->baselen + 1);
2548 const char *quote = "";
2549 struct strbuf sb = STRBUF_INIT;
2552 * Check to see if the value needs to be surrounded with a dq pair.
2553 * Note that problematic characters are always backslash-quoted; this
2554 * check is about not losing leading or trailing SP and strings that
2555 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2556 * configuration parser.
2558 if (value[0] == ' ')
2559 quote = "\"";
2560 for (i = 0; value[i]; i++)
2561 if (value[i] == ';' || value[i] == '#')
2562 quote = "\"";
2563 if (i && value[i - 1] == ' ')
2564 quote = "\"";
2566 strbuf_addf(&sb, "\t%.*s = %s",
2567 length, key + store->baselen + 1, quote);
2569 for (i = 0; value[i]; i++)
2570 switch (value[i]) {
2571 case '\n':
2572 strbuf_addstr(&sb, "\\n");
2573 break;
2574 case '\t':
2575 strbuf_addstr(&sb, "\\t");
2576 break;
2577 case '"':
2578 case '\\':
2579 strbuf_addch(&sb, '\\');
2580 /* fallthrough */
2581 default:
2582 strbuf_addch(&sb, value[i]);
2583 break;
2585 strbuf_addf(&sb, "%s\n", quote);
2587 ret = write_in_full(fd, sb.buf, sb.len);
2588 strbuf_release(&sb);
2590 return ret;
2594 * If we are about to unset the last key(s) in a section, and if there are
2595 * no comments surrounding (or included in) the section, we will want to
2596 * extend begin/end to remove the entire section.
2598 * Note: the parameter `seen_ptr` points to the index into the store.seen
2599 * array. * This index may be incremented if a section has more than one
2600 * entry (which all are to be removed).
2602 static void maybe_remove_section(struct config_store_data *store,
2603 size_t *begin_offset, size_t *end_offset,
2604 int *seen_ptr)
2606 size_t begin;
2607 int i, seen, section_seen = 0;
2610 * First, ensure that this is the first key, and that there are no
2611 * comments before the entry nor before the section header.
2613 seen = *seen_ptr;
2614 for (i = store->seen[seen]; i > 0; i--) {
2615 enum config_event_t type = store->parsed[i - 1].type;
2617 if (type == CONFIG_EVENT_COMMENT)
2618 /* There is a comment before this entry or section */
2619 return;
2620 if (type == CONFIG_EVENT_ENTRY) {
2621 if (!section_seen)
2622 /* This is not the section's first entry. */
2623 return;
2624 /* We encountered no comment before the section. */
2625 break;
2627 if (type == CONFIG_EVENT_SECTION) {
2628 if (!store->parsed[i - 1].is_keys_section)
2629 break;
2630 section_seen = 1;
2633 begin = store->parsed[i].begin;
2636 * Next, make sure that we are removing he last key(s) in the section,
2637 * and that there are no comments that are possibly about the current
2638 * section.
2640 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2641 enum config_event_t type = store->parsed[i].type;
2643 if (type == CONFIG_EVENT_COMMENT)
2644 return;
2645 if (type == CONFIG_EVENT_SECTION) {
2646 if (store->parsed[i].is_keys_section)
2647 continue;
2648 break;
2650 if (type == CONFIG_EVENT_ENTRY) {
2651 if (++seen < store->seen_nr &&
2652 i == store->seen[seen])
2653 /* We want to remove this entry, too */
2654 continue;
2655 /* There is another entry in this section. */
2656 return;
2661 * We are really removing the last entry/entries from this section, and
2662 * there are no enclosed or surrounding comments. Remove the entire,
2663 * now-empty section.
2665 *seen_ptr = seen;
2666 *begin_offset = begin;
2667 if (i < store->parsed_nr)
2668 *end_offset = store->parsed[i].begin;
2669 else
2670 *end_offset = store->parsed[store->parsed_nr - 1].end;
2673 int git_config_set_in_file_gently(const char *config_filename,
2674 const char *key, const char *value)
2676 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2679 void git_config_set_in_file(const char *config_filename,
2680 const char *key, const char *value)
2682 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2685 int git_config_set_gently(const char *key, const char *value)
2687 return git_config_set_multivar_gently(key, value, NULL, 0);
2690 void git_config_set(const char *key, const char *value)
2692 git_config_set_multivar(key, value, NULL, 0);
2694 trace2_cmd_set_config(key, value);
2698 * If value==NULL, unset in (remove from) config,
2699 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2700 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2701 * (only add a new one)
2702 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2703 * else all matching key/values (regardless how many) are removed,
2704 * before the new pair is written.
2706 * Returns 0 on success.
2708 * This function does this:
2710 * - it locks the config file by creating ".git/config.lock"
2712 * - it then parses the config using store_aux() as validator to find
2713 * the position on the key/value pair to replace. If it is to be unset,
2714 * it must be found exactly once.
2716 * - the config file is mmap()ed and the part before the match (if any) is
2717 * written to the lock file, then the changed part and the rest.
2719 * - the config file is removed and the lock file rename()d to it.
2722 int git_config_set_multivar_in_file_gently(const char *config_filename,
2723 const char *key, const char *value,
2724 const char *value_regex,
2725 int multi_replace)
2727 int fd = -1, in_fd = -1;
2728 int ret;
2729 struct lock_file lock = LOCK_INIT;
2730 char *filename_buf = NULL;
2731 char *contents = NULL;
2732 size_t contents_sz;
2733 struct config_store_data store;
2735 memset(&store, 0, sizeof(store));
2737 /* parse-key returns negative; flip the sign to feed exit(3) */
2738 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2739 if (ret)
2740 goto out_free;
2742 store.multi_replace = multi_replace;
2744 if (!config_filename)
2745 config_filename = filename_buf = git_pathdup("config");
2748 * The lock serves a purpose in addition to locking: the new
2749 * contents of .git/config will be written into it.
2751 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2752 if (fd < 0) {
2753 error_errno(_("could not lock config file %s"), config_filename);
2754 ret = CONFIG_NO_LOCK;
2755 goto out_free;
2759 * If .git/config does not exist yet, write a minimal version.
2761 in_fd = open(config_filename, O_RDONLY);
2762 if ( in_fd < 0 ) {
2763 if ( ENOENT != errno ) {
2764 error_errno(_("opening %s"), config_filename);
2765 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2766 goto out_free;
2768 /* if nothing to unset, error out */
2769 if (value == NULL) {
2770 ret = CONFIG_NOTHING_SET;
2771 goto out_free;
2774 free(store.key);
2775 store.key = xstrdup(key);
2776 if (write_section(fd, key, &store) < 0 ||
2777 write_pair(fd, key, value, &store) < 0)
2778 goto write_err_out;
2779 } else {
2780 struct stat st;
2781 size_t copy_begin, copy_end;
2782 int i, new_line = 0;
2783 struct config_options opts;
2785 if (value_regex == NULL)
2786 store.value_regex = NULL;
2787 else if (value_regex == CONFIG_REGEX_NONE)
2788 store.value_regex = CONFIG_REGEX_NONE;
2789 else {
2790 if (value_regex[0] == '!') {
2791 store.do_not_match = 1;
2792 value_regex++;
2793 } else
2794 store.do_not_match = 0;
2796 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2797 if (regcomp(store.value_regex, value_regex,
2798 REG_EXTENDED)) {
2799 error(_("invalid pattern: %s"), value_regex);
2800 FREE_AND_NULL(store.value_regex);
2801 ret = CONFIG_INVALID_PATTERN;
2802 goto out_free;
2806 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2807 store.parsed[0].end = 0;
2809 memset(&opts, 0, sizeof(opts));
2810 opts.event_fn = store_aux_event;
2811 opts.event_fn_data = &store;
2814 * After this, store.parsed will contain offsets of all the
2815 * parsed elements, and store.seen will contain a list of
2816 * matches, as indices into store.parsed.
2818 * As a side effect, we make sure to transform only a valid
2819 * existing config file.
2821 if (git_config_from_file_with_options(store_aux,
2822 config_filename,
2823 &store, &opts)) {
2824 error(_("invalid config file %s"), config_filename);
2825 ret = CONFIG_INVALID_FILE;
2826 goto out_free;
2829 /* if nothing to unset, or too many matches, error out */
2830 if ((store.seen_nr == 0 && value == NULL) ||
2831 (store.seen_nr > 1 && multi_replace == 0)) {
2832 ret = CONFIG_NOTHING_SET;
2833 goto out_free;
2836 if (fstat(in_fd, &st) == -1) {
2837 error_errno(_("fstat on %s failed"), config_filename);
2838 ret = CONFIG_INVALID_FILE;
2839 goto out_free;
2842 contents_sz = xsize_t(st.st_size);
2843 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2844 MAP_PRIVATE, in_fd, 0);
2845 if (contents == MAP_FAILED) {
2846 if (errno == ENODEV && S_ISDIR(st.st_mode))
2847 errno = EISDIR;
2848 error_errno(_("unable to mmap '%s'"), config_filename);
2849 ret = CONFIG_INVALID_FILE;
2850 contents = NULL;
2851 goto out_free;
2853 close(in_fd);
2854 in_fd = -1;
2856 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2857 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
2858 ret = CONFIG_NO_WRITE;
2859 goto out_free;
2862 if (store.seen_nr == 0) {
2863 if (!store.seen_alloc) {
2864 /* Did not see key nor section */
2865 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2866 store.seen[0] = store.parsed_nr
2867 - !!store.parsed_nr;
2869 store.seen_nr = 1;
2872 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2873 size_t replace_end;
2874 int j = store.seen[i];
2876 new_line = 0;
2877 if (!store.key_seen) {
2878 copy_end = store.parsed[j].end;
2879 /* include '\n' when copying section header */
2880 if (copy_end > 0 && copy_end < contents_sz &&
2881 contents[copy_end - 1] != '\n' &&
2882 contents[copy_end] == '\n')
2883 copy_end++;
2884 replace_end = copy_end;
2885 } else {
2886 replace_end = store.parsed[j].end;
2887 copy_end = store.parsed[j].begin;
2888 if (!value)
2889 maybe_remove_section(&store,
2890 &copy_end,
2891 &replace_end, &i);
2893 * Swallow preceding white-space on the same
2894 * line.
2896 while (copy_end > 0 ) {
2897 char c = contents[copy_end - 1];
2899 if (isspace(c) && c != '\n')
2900 copy_end--;
2901 else
2902 break;
2906 if (copy_end > 0 && contents[copy_end-1] != '\n')
2907 new_line = 1;
2909 /* write the first part of the config */
2910 if (copy_end > copy_begin) {
2911 if (write_in_full(fd, contents + copy_begin,
2912 copy_end - copy_begin) < 0)
2913 goto write_err_out;
2914 if (new_line &&
2915 write_str_in_full(fd, "\n") < 0)
2916 goto write_err_out;
2918 copy_begin = replace_end;
2921 /* write the pair (value == NULL means unset) */
2922 if (value != NULL) {
2923 if (!store.section_seen) {
2924 if (write_section(fd, key, &store) < 0)
2925 goto write_err_out;
2927 if (write_pair(fd, key, value, &store) < 0)
2928 goto write_err_out;
2931 /* write the rest of the config */
2932 if (copy_begin < contents_sz)
2933 if (write_in_full(fd, contents + copy_begin,
2934 contents_sz - copy_begin) < 0)
2935 goto write_err_out;
2937 munmap(contents, contents_sz);
2938 contents = NULL;
2941 if (commit_lock_file(&lock) < 0) {
2942 error_errno(_("could not write config file %s"), config_filename);
2943 ret = CONFIG_NO_WRITE;
2944 goto out_free;
2947 ret = 0;
2949 /* Invalidate the config cache */
2950 git_config_clear();
2952 out_free:
2953 rollback_lock_file(&lock);
2954 free(filename_buf);
2955 if (contents)
2956 munmap(contents, contents_sz);
2957 if (in_fd >= 0)
2958 close(in_fd);
2959 config_store_data_clear(&store);
2960 return ret;
2962 write_err_out:
2963 ret = write_error(get_lock_file_path(&lock));
2964 goto out_free;
2968 void git_config_set_multivar_in_file(const char *config_filename,
2969 const char *key, const char *value,
2970 const char *value_regex, int multi_replace)
2972 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2973 value_regex, multi_replace))
2974 return;
2975 if (value)
2976 die(_("could not set '%s' to '%s'"), key, value);
2977 else
2978 die(_("could not unset '%s'"), key);
2981 int git_config_set_multivar_gently(const char *key, const char *value,
2982 const char *value_regex, int multi_replace)
2984 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2985 multi_replace);
2988 void git_config_set_multivar(const char *key, const char *value,
2989 const char *value_regex, int multi_replace)
2991 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2992 multi_replace);
2995 static int section_name_match (const char *buf, const char *name)
2997 int i = 0, j = 0, dot = 0;
2998 if (buf[i] != '[')
2999 return 0;
3000 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3001 if (!dot && isspace(buf[i])) {
3002 dot = 1;
3003 if (name[j++] != '.')
3004 break;
3005 for (i++; isspace(buf[i]); i++)
3006 ; /* do nothing */
3007 if (buf[i] != '"')
3008 break;
3009 continue;
3011 if (buf[i] == '\\' && dot)
3012 i++;
3013 else if (buf[i] == '"' && dot) {
3014 for (i++; isspace(buf[i]); i++)
3015 ; /* do_nothing */
3016 break;
3018 if (buf[i] != name[j++])
3019 break;
3021 if (buf[i] == ']' && name[j] == 0) {
3023 * We match, now just find the right length offset by
3024 * gobbling up any whitespace after it, as well
3026 i++;
3027 for (; buf[i] && isspace(buf[i]); i++)
3028 ; /* do nothing */
3029 return i;
3031 return 0;
3034 static int section_name_is_ok(const char *name)
3036 /* Empty section names are bogus. */
3037 if (!*name)
3038 return 0;
3041 * Before a dot, we must be alphanumeric or dash. After the first dot,
3042 * anything goes, so we can stop checking.
3044 for (; *name && *name != '.'; name++)
3045 if (*name != '-' && !isalnum(*name))
3046 return 0;
3047 return 1;
3050 /* if new_name == NULL, the section is removed instead */
3051 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3052 const char *old_name,
3053 const char *new_name, int copy)
3055 int ret = 0, remove = 0;
3056 char *filename_buf = NULL;
3057 struct lock_file lock = LOCK_INIT;
3058 int out_fd;
3059 char buf[1024];
3060 FILE *config_file = NULL;
3061 struct stat st;
3062 struct strbuf copystr = STRBUF_INIT;
3063 struct config_store_data store;
3065 memset(&store, 0, sizeof(store));
3067 if (new_name && !section_name_is_ok(new_name)) {
3068 ret = error(_("invalid section name: %s"), new_name);
3069 goto out_no_rollback;
3072 if (!config_filename)
3073 config_filename = filename_buf = git_pathdup("config");
3075 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3076 if (out_fd < 0) {
3077 ret = error(_("could not lock config file %s"), config_filename);
3078 goto out;
3081 if (!(config_file = fopen(config_filename, "rb"))) {
3082 ret = warn_on_fopen_errors(config_filename);
3083 if (ret)
3084 goto out;
3085 /* no config file means nothing to rename, no error */
3086 goto commit_and_out;
3089 if (fstat(fileno(config_file), &st) == -1) {
3090 ret = error_errno(_("fstat on %s failed"), config_filename);
3091 goto out;
3094 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3095 ret = error_errno(_("chmod on %s failed"),
3096 get_lock_file_path(&lock));
3097 goto out;
3100 while (fgets(buf, sizeof(buf), config_file)) {
3101 int i;
3102 int length;
3103 int is_section = 0;
3104 char *output = buf;
3105 for (i = 0; buf[i] && isspace(buf[i]); i++)
3106 ; /* do nothing */
3107 if (buf[i] == '[') {
3108 /* it's a section */
3109 int offset;
3110 is_section = 1;
3113 * When encountering a new section under -c we
3114 * need to flush out any section we're already
3115 * coping and begin anew. There might be
3116 * multiple [branch "$name"] sections.
3118 if (copystr.len > 0) {
3119 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3120 ret = write_error(get_lock_file_path(&lock));
3121 goto out;
3123 strbuf_reset(&copystr);
3126 offset = section_name_match(&buf[i], old_name);
3127 if (offset > 0) {
3128 ret++;
3129 if (new_name == NULL) {
3130 remove = 1;
3131 continue;
3133 store.baselen = strlen(new_name);
3134 if (!copy) {
3135 if (write_section(out_fd, new_name, &store) < 0) {
3136 ret = write_error(get_lock_file_path(&lock));
3137 goto out;
3140 * We wrote out the new section, with
3141 * a newline, now skip the old
3142 * section's length
3144 output += offset + i;
3145 if (strlen(output) > 0) {
3147 * More content means there's
3148 * a declaration to put on the
3149 * next line; indent with a
3150 * tab
3152 output -= 1;
3153 output[0] = '\t';
3155 } else {
3156 copystr = store_create_section(new_name, &store);
3159 remove = 0;
3161 if (remove)
3162 continue;
3163 length = strlen(output);
3165 if (!is_section && copystr.len > 0) {
3166 strbuf_add(&copystr, output, length);
3169 if (write_in_full(out_fd, output, length) < 0) {
3170 ret = write_error(get_lock_file_path(&lock));
3171 goto out;
3176 * Copy a trailing section at the end of the config, won't be
3177 * flushed by the usual "flush because we have a new section
3178 * logic in the loop above.
3180 if (copystr.len > 0) {
3181 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3182 ret = write_error(get_lock_file_path(&lock));
3183 goto out;
3185 strbuf_reset(&copystr);
3188 fclose(config_file);
3189 config_file = NULL;
3190 commit_and_out:
3191 if (commit_lock_file(&lock) < 0)
3192 ret = error_errno(_("could not write config file %s"),
3193 config_filename);
3194 out:
3195 if (config_file)
3196 fclose(config_file);
3197 rollback_lock_file(&lock);
3198 out_no_rollback:
3199 free(filename_buf);
3200 config_store_data_clear(&store);
3201 return ret;
3204 int git_config_rename_section_in_file(const char *config_filename,
3205 const char *old_name, const char *new_name)
3207 return git_config_copy_or_rename_section_in_file(config_filename,
3208 old_name, new_name, 0);
3211 int git_config_rename_section(const char *old_name, const char *new_name)
3213 return git_config_rename_section_in_file(NULL, old_name, new_name);
3216 int git_config_copy_section_in_file(const char *config_filename,
3217 const char *old_name, const char *new_name)
3219 return git_config_copy_or_rename_section_in_file(config_filename,
3220 old_name, new_name, 1);
3223 int git_config_copy_section(const char *old_name, const char *new_name)
3225 return git_config_copy_section_in_file(NULL, old_name, new_name);
3229 * Call this to report error for your variable that should not
3230 * get a boolean value (i.e. "[my] var" means "true").
3232 #undef config_error_nonbool
3233 int config_error_nonbool(const char *var)
3235 return error(_("missing value for '%s'"), var);
3238 int parse_config_key(const char *var,
3239 const char *section,
3240 const char **subsection, int *subsection_len,
3241 const char **key)
3243 const char *dot;
3245 /* Does it start with "section." ? */
3246 if (!skip_prefix(var, section, &var) || *var != '.')
3247 return -1;
3250 * Find the key; we don't know yet if we have a subsection, but we must
3251 * parse backwards from the end, since the subsection may have dots in
3252 * it, too.
3254 dot = strrchr(var, '.');
3255 *key = dot + 1;
3257 /* Did we have a subsection at all? */
3258 if (dot == var) {
3259 if (subsection) {
3260 *subsection = NULL;
3261 *subsection_len = 0;
3264 else {
3265 if (!subsection)
3266 return -1;
3267 *subsection = var + 1;
3268 *subsection_len = dot - *subsection;
3271 return 0;
3274 const char *current_config_origin_type(void)
3276 int type;
3277 if (current_config_kvi)
3278 type = current_config_kvi->origin_type;
3279 else if(cf)
3280 type = cf->origin_type;
3281 else
3282 BUG("current_config_origin_type called outside config callback");
3284 switch (type) {
3285 case CONFIG_ORIGIN_BLOB:
3286 return "blob";
3287 case CONFIG_ORIGIN_FILE:
3288 return "file";
3289 case CONFIG_ORIGIN_STDIN:
3290 return "standard input";
3291 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3292 return "submodule-blob";
3293 case CONFIG_ORIGIN_CMDLINE:
3294 return "command line";
3295 default:
3296 BUG("unknown config origin type");
3300 const char *current_config_name(void)
3302 const char *name;
3303 if (current_config_kvi)
3304 name = current_config_kvi->filename;
3305 else if (cf)
3306 name = cf->name;
3307 else
3308 BUG("current_config_name called outside config callback");
3309 return name ? name : "";
3312 enum config_scope current_config_scope(void)
3314 if (current_config_kvi)
3315 return current_config_kvi->scope;
3316 else
3317 return current_parsing_scope;
3320 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3322 int i;
3324 for (i = 0; i < nr_mapping; i++) {
3325 const char *name = mapping[i];
3327 if (name && !strcasecmp(var, name))
3328 return i;
3330 return -1;