contrib/buildsystems: handle options starting with a slash
[git/raj.git] / config.c
blobfaa57e436cf4fc6d84580f3940bafdb4896c7658
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 = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
279 const char *shortname;
281 if (!refname || !(flags & REF_ISSYMREF) ||
282 !skip_prefix(refname, "refs/heads/", &shortname))
283 return 0;
285 strbuf_add(&pattern, cond, cond_len);
286 add_trailing_starstar_for_dir(&pattern);
287 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
288 strbuf_release(&pattern);
289 return ret;
292 static int include_condition_is_true(const struct config_options *opts,
293 const char *cond, size_t cond_len)
296 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
297 return include_by_gitdir(opts, cond, cond_len, 0);
298 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
299 return include_by_gitdir(opts, cond, cond_len, 1);
300 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
301 return include_by_branch(cond, cond_len);
303 /* unknown conditionals are always false */
304 return 0;
307 int git_config_include(const char *var, const char *value, void *data)
309 struct config_include_data *inc = data;
310 const char *cond, *key;
311 int cond_len;
312 int ret;
315 * Pass along all values, including "include" directives; this makes it
316 * possible to query information on the includes themselves.
318 ret = inc->fn(var, value, inc->data);
319 if (ret < 0)
320 return ret;
322 if (!strcmp(var, "include.path"))
323 ret = handle_path_include(value, inc);
325 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
326 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
327 !strcmp(key, "path"))
328 ret = handle_path_include(value, inc);
330 return ret;
333 void git_config_push_parameter(const char *text)
335 struct strbuf env = STRBUF_INIT;
336 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
337 if (old && *old) {
338 strbuf_addstr(&env, old);
339 strbuf_addch(&env, ' ');
341 sq_quote_buf(&env, text);
342 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
343 strbuf_release(&env);
346 static inline int iskeychar(int c)
348 return isalnum(c) || c == '-';
352 * Auxiliary function to sanity-check and split the key into the section
353 * identifier and variable name.
355 * Returns 0 on success, -1 when there is an invalid character in the key and
356 * -2 if there is no section name in the key.
358 * store_key - pointer to char* which will hold a copy of the key with
359 * lowercase section and variable name
360 * baselen - pointer to int which will hold the length of the
361 * section + subsection part, can be NULL
363 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
365 int i, dot, baselen;
366 const char *last_dot = strrchr(key, '.');
369 * Since "key" actually contains the section name and the real
370 * key name separated by a dot, we have to know where the dot is.
373 if (last_dot == NULL || last_dot == key) {
374 if (!quiet)
375 error(_("key does not contain a section: %s"), key);
376 return -CONFIG_NO_SECTION_OR_NAME;
379 if (!last_dot[1]) {
380 if (!quiet)
381 error(_("key does not contain variable name: %s"), key);
382 return -CONFIG_NO_SECTION_OR_NAME;
385 baselen = last_dot - key;
386 if (baselen_)
387 *baselen_ = baselen;
390 * Validate the key and while at it, lower case it for matching.
392 if (store_key)
393 *store_key = xmallocz(strlen(key));
395 dot = 0;
396 for (i = 0; key[i]; i++) {
397 unsigned char c = key[i];
398 if (c == '.')
399 dot = 1;
400 /* Leave the extended basename untouched.. */
401 if (!dot || i > baselen) {
402 if (!iskeychar(c) ||
403 (i == baselen + 1 && !isalpha(c))) {
404 if (!quiet)
405 error(_("invalid key: %s"), key);
406 goto out_free_ret_1;
408 c = tolower(c);
409 } else if (c == '\n') {
410 if (!quiet)
411 error(_("invalid key (newline): %s"), key);
412 goto out_free_ret_1;
414 if (store_key)
415 (*store_key)[i] = c;
418 return 0;
420 out_free_ret_1:
421 if (store_key) {
422 FREE_AND_NULL(*store_key);
424 return -CONFIG_INVALID_KEY;
427 int git_config_parse_key(const char *key, char **store_key, int *baselen)
429 return git_config_parse_key_1(key, store_key, baselen, 0);
432 int git_config_key_is_valid(const char *key)
434 return !git_config_parse_key_1(key, NULL, NULL, 1);
437 int git_config_parse_parameter(const char *text,
438 config_fn_t fn, void *data)
440 const char *value;
441 char *canonical_name;
442 struct strbuf **pair;
443 int ret;
445 pair = strbuf_split_str(text, '=', 2);
446 if (!pair[0])
447 return error(_("bogus config parameter: %s"), text);
449 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
450 strbuf_setlen(pair[0], pair[0]->len - 1);
451 value = pair[1] ? pair[1]->buf : "";
452 } else {
453 value = NULL;
456 strbuf_trim(pair[0]);
457 if (!pair[0]->len) {
458 strbuf_list_free(pair);
459 return error(_("bogus config parameter: %s"), text);
462 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
463 ret = -1;
464 } else {
465 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
466 free(canonical_name);
468 strbuf_list_free(pair);
469 return ret;
472 int git_config_from_parameters(config_fn_t fn, void *data)
474 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
475 int ret = 0;
476 char *envw;
477 const char **argv = NULL;
478 int nr = 0, alloc = 0;
479 int i;
480 struct config_source source;
482 if (!env)
483 return 0;
485 memset(&source, 0, sizeof(source));
486 source.prev = cf;
487 source.origin_type = CONFIG_ORIGIN_CMDLINE;
488 cf = &source;
490 /* sq_dequote will write over it */
491 envw = xstrdup(env);
493 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
494 ret = error(_("bogus format in %s"), CONFIG_DATA_ENVIRONMENT);
495 goto out;
498 for (i = 0; i < nr; i++) {
499 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
500 ret = -1;
501 goto out;
505 out:
506 free(argv);
507 free(envw);
508 cf = source.prev;
509 return ret;
512 static int get_next_char(void)
514 int c = cf->do_fgetc(cf);
516 if (c == '\r') {
517 /* DOS like systems */
518 c = cf->do_fgetc(cf);
519 if (c != '\n') {
520 if (c != EOF)
521 cf->do_ungetc(c, cf);
522 c = '\r';
525 if (c == '\n')
526 cf->linenr++;
527 if (c == EOF) {
528 cf->eof = 1;
529 cf->linenr++;
530 c = '\n';
532 return c;
535 static char *parse_value(void)
537 int quote = 0, comment = 0, space = 0;
539 strbuf_reset(&cf->value);
540 for (;;) {
541 int c = get_next_char();
542 if (c == '\n') {
543 if (quote) {
544 cf->linenr--;
545 return NULL;
547 return cf->value.buf;
549 if (comment)
550 continue;
551 if (isspace(c) && !quote) {
552 if (cf->value.len)
553 space++;
554 continue;
556 if (!quote) {
557 if (c == ';' || c == '#') {
558 comment = 1;
559 continue;
562 for (; space; space--)
563 strbuf_addch(&cf->value, ' ');
564 if (c == '\\') {
565 c = get_next_char();
566 switch (c) {
567 case '\n':
568 continue;
569 case 't':
570 c = '\t';
571 break;
572 case 'b':
573 c = '\b';
574 break;
575 case 'n':
576 c = '\n';
577 break;
578 /* Some characters escape as themselves */
579 case '\\': case '"':
580 break;
581 /* Reject unknown escape sequences */
582 default:
583 return NULL;
585 strbuf_addch(&cf->value, c);
586 continue;
588 if (c == '"') {
589 quote = 1-quote;
590 continue;
592 strbuf_addch(&cf->value, c);
596 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
598 int c;
599 char *value;
600 int ret;
602 /* Get the full name */
603 for (;;) {
604 c = get_next_char();
605 if (cf->eof)
606 break;
607 if (!iskeychar(c))
608 break;
609 strbuf_addch(name, tolower(c));
612 while (c == ' ' || c == '\t')
613 c = get_next_char();
615 value = NULL;
616 if (c != '\n') {
617 if (c != '=')
618 return -1;
619 value = parse_value();
620 if (!value)
621 return -1;
624 * We already consumed the \n, but we need linenr to point to
625 * the line we just parsed during the call to fn to get
626 * accurate line number in error messages.
628 cf->linenr--;
629 ret = fn(name->buf, value, data);
630 if (ret >= 0)
631 cf->linenr++;
632 return ret;
635 static int get_extended_base_var(struct strbuf *name, int c)
637 cf->subsection_case_sensitive = 0;
638 do {
639 if (c == '\n')
640 goto error_incomplete_line;
641 c = get_next_char();
642 } while (isspace(c));
644 /* We require the format to be '[base "extension"]' */
645 if (c != '"')
646 return -1;
647 strbuf_addch(name, '.');
649 for (;;) {
650 int c = get_next_char();
651 if (c == '\n')
652 goto error_incomplete_line;
653 if (c == '"')
654 break;
655 if (c == '\\') {
656 c = get_next_char();
657 if (c == '\n')
658 goto error_incomplete_line;
660 strbuf_addch(name, c);
663 /* Final ']' */
664 if (get_next_char() != ']')
665 return -1;
666 return 0;
667 error_incomplete_line:
668 cf->linenr--;
669 return -1;
672 static int get_base_var(struct strbuf *name)
674 cf->subsection_case_sensitive = 1;
675 for (;;) {
676 int c = get_next_char();
677 if (cf->eof)
678 return -1;
679 if (c == ']')
680 return 0;
681 if (isspace(c))
682 return get_extended_base_var(name, c);
683 if (!iskeychar(c) && c != '.')
684 return -1;
685 strbuf_addch(name, tolower(c));
689 struct parse_event_data {
690 enum config_event_t previous_type;
691 size_t previous_offset;
692 const struct config_options *opts;
695 static int do_event(enum config_event_t type, struct parse_event_data *data)
697 size_t offset;
699 if (!data->opts || !data->opts->event_fn)
700 return 0;
702 if (type == CONFIG_EVENT_WHITESPACE &&
703 data->previous_type == type)
704 return 0;
706 offset = cf->do_ftell(cf);
708 * At EOF, the parser always "inserts" an extra '\n', therefore
709 * the end offset of the event is the current file position, otherwise
710 * we will already have advanced to the next event.
712 if (type != CONFIG_EVENT_EOF)
713 offset--;
715 if (data->previous_type != CONFIG_EVENT_EOF &&
716 data->opts->event_fn(data->previous_type, data->previous_offset,
717 offset, data->opts->event_fn_data) < 0)
718 return -1;
720 data->previous_type = type;
721 data->previous_offset = offset;
723 return 0;
726 static int git_parse_source(config_fn_t fn, void *data,
727 const struct config_options *opts)
729 int comment = 0;
730 int baselen = 0;
731 struct strbuf *var = &cf->var;
732 int error_return = 0;
733 char *error_msg = NULL;
735 /* U+FEFF Byte Order Mark in UTF8 */
736 const char *bomptr = utf8_bom;
738 /* For the parser event callback */
739 struct parse_event_data event_data = {
740 CONFIG_EVENT_EOF, 0, opts
743 for (;;) {
744 int c;
746 c = get_next_char();
747 if (bomptr && *bomptr) {
748 /* We are at the file beginning; skip UTF8-encoded BOM
749 * if present. Sane editors won't put this in on their
750 * own, but e.g. Windows Notepad will do it happily. */
751 if (c == (*bomptr & 0377)) {
752 bomptr++;
753 continue;
754 } else {
755 /* Do not tolerate partial BOM. */
756 if (bomptr != utf8_bom)
757 break;
758 /* No BOM at file beginning. Cool. */
759 bomptr = NULL;
762 if (c == '\n') {
763 if (cf->eof) {
764 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
765 return -1;
766 return 0;
768 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
769 return -1;
770 comment = 0;
771 continue;
773 if (comment)
774 continue;
775 if (isspace(c)) {
776 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
777 return -1;
778 continue;
780 if (c == '#' || c == ';') {
781 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
782 return -1;
783 comment = 1;
784 continue;
786 if (c == '[') {
787 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
788 return -1;
790 /* Reset prior to determining a new stem */
791 strbuf_reset(var);
792 if (get_base_var(var) < 0 || var->len < 1)
793 break;
794 strbuf_addch(var, '.');
795 baselen = var->len;
796 continue;
798 if (!isalpha(c))
799 break;
801 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
802 return -1;
805 * Truncate the var name back to the section header
806 * stem prior to grabbing the suffix part of the name
807 * and the value.
809 strbuf_setlen(var, baselen);
810 strbuf_addch(var, tolower(c));
811 if (get_value(fn, data, var) < 0)
812 break;
815 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
816 return -1;
818 switch (cf->origin_type) {
819 case CONFIG_ORIGIN_BLOB:
820 error_msg = xstrfmt(_("bad config line %d in blob %s"),
821 cf->linenr, cf->name);
822 break;
823 case CONFIG_ORIGIN_FILE:
824 error_msg = xstrfmt(_("bad config line %d in file %s"),
825 cf->linenr, cf->name);
826 break;
827 case CONFIG_ORIGIN_STDIN:
828 error_msg = xstrfmt(_("bad config line %d in standard input"),
829 cf->linenr);
830 break;
831 case CONFIG_ORIGIN_SUBMODULE_BLOB:
832 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
833 cf->linenr, cf->name);
834 break;
835 case CONFIG_ORIGIN_CMDLINE:
836 error_msg = xstrfmt(_("bad config line %d in command line %s"),
837 cf->linenr, cf->name);
838 break;
839 default:
840 error_msg = xstrfmt(_("bad config line %d in %s"),
841 cf->linenr, cf->name);
844 switch (opts && opts->error_action ?
845 opts->error_action :
846 cf->default_error_action) {
847 case CONFIG_ERROR_DIE:
848 die("%s", error_msg);
849 break;
850 case CONFIG_ERROR_ERROR:
851 error_return = error("%s", error_msg);
852 break;
853 case CONFIG_ERROR_SILENT:
854 error_return = -1;
855 break;
856 case CONFIG_ERROR_UNSET:
857 BUG("config error action unset");
860 free(error_msg);
861 return error_return;
864 static uintmax_t get_unit_factor(const char *end)
866 if (!*end)
867 return 1;
868 else if (!strcasecmp(end, "k"))
869 return 1024;
870 else if (!strcasecmp(end, "m"))
871 return 1024 * 1024;
872 else if (!strcasecmp(end, "g"))
873 return 1024 * 1024 * 1024;
874 return 0;
877 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
879 if (value && *value) {
880 char *end;
881 intmax_t val;
882 uintmax_t uval;
883 uintmax_t factor;
885 errno = 0;
886 val = strtoimax(value, &end, 0);
887 if (errno == ERANGE)
888 return 0;
889 factor = get_unit_factor(end);
890 if (!factor) {
891 errno = EINVAL;
892 return 0;
894 uval = val < 0 ? -val : val;
895 if (unsigned_mult_overflows(factor, uval) ||
896 factor * uval > max) {
897 errno = ERANGE;
898 return 0;
900 val *= factor;
901 *ret = val;
902 return 1;
904 errno = EINVAL;
905 return 0;
908 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
910 if (value && *value) {
911 char *end;
912 uintmax_t val;
913 uintmax_t factor;
915 errno = 0;
916 val = strtoumax(value, &end, 0);
917 if (errno == ERANGE)
918 return 0;
919 factor = get_unit_factor(end);
920 if (!factor) {
921 errno = EINVAL;
922 return 0;
924 if (unsigned_mult_overflows(factor, val) ||
925 factor * val > max) {
926 errno = ERANGE;
927 return 0;
929 val *= factor;
930 *ret = val;
931 return 1;
933 errno = EINVAL;
934 return 0;
937 static int git_parse_int(const char *value, int *ret)
939 intmax_t tmp;
940 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
941 return 0;
942 *ret = tmp;
943 return 1;
946 static int git_parse_int64(const char *value, int64_t *ret)
948 intmax_t tmp;
949 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
950 return 0;
951 *ret = tmp;
952 return 1;
955 int git_parse_ulong(const char *value, unsigned long *ret)
957 uintmax_t tmp;
958 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
959 return 0;
960 *ret = tmp;
961 return 1;
964 int git_parse_ssize_t(const char *value, ssize_t *ret)
966 intmax_t tmp;
967 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
968 return 0;
969 *ret = tmp;
970 return 1;
973 NORETURN
974 static void die_bad_number(const char *name, const char *value)
976 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
978 if (!value)
979 value = "";
981 if (!(cf && cf->name))
982 die(_("bad numeric config value '%s' for '%s': %s"),
983 value, name, error_type);
985 switch (cf->origin_type) {
986 case CONFIG_ORIGIN_BLOB:
987 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
988 value, name, cf->name, error_type);
989 case CONFIG_ORIGIN_FILE:
990 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
991 value, name, cf->name, error_type);
992 case CONFIG_ORIGIN_STDIN:
993 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
994 value, name, error_type);
995 case CONFIG_ORIGIN_SUBMODULE_BLOB:
996 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
997 value, name, cf->name, error_type);
998 case CONFIG_ORIGIN_CMDLINE:
999 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1000 value, name, cf->name, error_type);
1001 default:
1002 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1003 value, name, cf->name, error_type);
1007 int git_config_int(const char *name, const char *value)
1009 int ret;
1010 if (!git_parse_int(value, &ret))
1011 die_bad_number(name, value);
1012 return ret;
1015 int64_t git_config_int64(const char *name, const char *value)
1017 int64_t ret;
1018 if (!git_parse_int64(value, &ret))
1019 die_bad_number(name, value);
1020 return ret;
1023 unsigned long git_config_ulong(const char *name, const char *value)
1025 unsigned long ret;
1026 if (!git_parse_ulong(value, &ret))
1027 die_bad_number(name, value);
1028 return ret;
1031 ssize_t git_config_ssize_t(const char *name, const char *value)
1033 ssize_t ret;
1034 if (!git_parse_ssize_t(value, &ret))
1035 die_bad_number(name, value);
1036 return ret;
1039 static int git_parse_maybe_bool_text(const char *value)
1041 if (!value)
1042 return 1;
1043 if (!*value)
1044 return 0;
1045 if (!strcasecmp(value, "true")
1046 || !strcasecmp(value, "yes")
1047 || !strcasecmp(value, "on"))
1048 return 1;
1049 if (!strcasecmp(value, "false")
1050 || !strcasecmp(value, "no")
1051 || !strcasecmp(value, "off"))
1052 return 0;
1053 return -1;
1056 int git_parse_maybe_bool(const char *value)
1058 int v = git_parse_maybe_bool_text(value);
1059 if (0 <= v)
1060 return v;
1061 if (git_parse_int(value, &v))
1062 return !!v;
1063 return -1;
1066 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1068 int v = git_parse_maybe_bool_text(value);
1069 if (0 <= v) {
1070 *is_bool = 1;
1071 return v;
1073 *is_bool = 0;
1074 return git_config_int(name, value);
1077 int git_config_bool(const char *name, const char *value)
1079 int discard;
1080 return !!git_config_bool_or_int(name, value, &discard);
1083 int git_config_string(const char **dest, const char *var, const char *value)
1085 if (!value)
1086 return config_error_nonbool(var);
1087 *dest = xstrdup(value);
1088 return 0;
1091 int git_config_pathname(const char **dest, const char *var, const char *value)
1093 if (!value)
1094 return config_error_nonbool(var);
1095 *dest = expand_user_path(value, 0);
1096 if (!*dest)
1097 die(_("failed to expand user dir in: '%s'"), value);
1098 return 0;
1101 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1103 if (!value)
1104 return config_error_nonbool(var);
1105 if (parse_expiry_date(value, timestamp))
1106 return error(_("'%s' for '%s' is not a valid timestamp"),
1107 value, var);
1108 return 0;
1111 int git_config_color(char *dest, const char *var, const char *value)
1113 if (!value)
1114 return config_error_nonbool(var);
1115 if (color_parse(value, dest) < 0)
1116 return -1;
1117 return 0;
1120 static int git_default_core_config(const char *var, const char *value, void *cb)
1122 /* This needs a better name */
1123 if (!strcmp(var, "core.filemode")) {
1124 trust_executable_bit = git_config_bool(var, value);
1125 return 0;
1127 if (!strcmp(var, "core.trustctime")) {
1128 trust_ctime = git_config_bool(var, value);
1129 return 0;
1131 if (!strcmp(var, "core.checkstat")) {
1132 if (!strcasecmp(value, "default"))
1133 check_stat = 1;
1134 else if (!strcasecmp(value, "minimal"))
1135 check_stat = 0;
1138 if (!strcmp(var, "core.quotepath")) {
1139 quote_path_fully = git_config_bool(var, value);
1140 return 0;
1143 if (!strcmp(var, "core.symlinks")) {
1144 has_symlinks = git_config_bool(var, value);
1145 return 0;
1148 if (!strcmp(var, "core.ignorecase")) {
1149 ignore_case = git_config_bool(var, value);
1150 return 0;
1153 if (!strcmp(var, "core.attributesfile"))
1154 return git_config_pathname(&git_attributes_file, var, value);
1156 if (!strcmp(var, "core.hookspath"))
1157 return git_config_pathname(&git_hooks_path, var, value);
1159 if (!strcmp(var, "core.bare")) {
1160 is_bare_repository_cfg = git_config_bool(var, value);
1161 return 0;
1164 if (!strcmp(var, "core.ignorestat")) {
1165 assume_unchanged = git_config_bool(var, value);
1166 return 0;
1169 if (!strcmp(var, "core.prefersymlinkrefs")) {
1170 prefer_symlink_refs = git_config_bool(var, value);
1171 return 0;
1174 if (!strcmp(var, "core.logallrefupdates")) {
1175 if (value && !strcasecmp(value, "always"))
1176 log_all_ref_updates = LOG_REFS_ALWAYS;
1177 else if (git_config_bool(var, value))
1178 log_all_ref_updates = LOG_REFS_NORMAL;
1179 else
1180 log_all_ref_updates = LOG_REFS_NONE;
1181 return 0;
1184 if (!strcmp(var, "core.warnambiguousrefs")) {
1185 warn_ambiguous_refs = git_config_bool(var, value);
1186 return 0;
1189 if (!strcmp(var, "core.abbrev")) {
1190 if (!value)
1191 return config_error_nonbool(var);
1192 if (!strcasecmp(value, "auto"))
1193 default_abbrev = -1;
1194 else {
1195 int abbrev = git_config_int(var, value);
1196 if (abbrev < minimum_abbrev || abbrev > 40)
1197 return error(_("abbrev length out of range: %d"), abbrev);
1198 default_abbrev = abbrev;
1200 return 0;
1203 if (!strcmp(var, "core.disambiguate"))
1204 return set_disambiguate_hint_config(var, value);
1206 if (!strcmp(var, "core.loosecompression")) {
1207 int level = git_config_int(var, value);
1208 if (level == -1)
1209 level = Z_DEFAULT_COMPRESSION;
1210 else if (level < 0 || level > Z_BEST_COMPRESSION)
1211 die(_("bad zlib compression level %d"), level);
1212 zlib_compression_level = level;
1213 zlib_compression_seen = 1;
1214 return 0;
1217 if (!strcmp(var, "core.compression")) {
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 core_compression_level = level;
1224 core_compression_seen = 1;
1225 if (!zlib_compression_seen)
1226 zlib_compression_level = level;
1227 if (!pack_compression_seen)
1228 pack_compression_level = level;
1229 return 0;
1232 if (!strcmp(var, "core.packedgitwindowsize")) {
1233 int pgsz_x2 = getpagesize() * 2;
1234 packed_git_window_size = git_config_ulong(var, value);
1236 /* This value must be multiple of (pagesize * 2) */
1237 packed_git_window_size /= pgsz_x2;
1238 if (packed_git_window_size < 1)
1239 packed_git_window_size = 1;
1240 packed_git_window_size *= pgsz_x2;
1241 return 0;
1244 if (!strcmp(var, "core.bigfilethreshold")) {
1245 big_file_threshold = git_config_ulong(var, value);
1246 return 0;
1249 if (!strcmp(var, "core.packedgitlimit")) {
1250 packed_git_limit = git_config_ulong(var, value);
1251 return 0;
1254 if (!strcmp(var, "core.deltabasecachelimit")) {
1255 delta_base_cache_limit = git_config_ulong(var, value);
1256 return 0;
1259 if (!strcmp(var, "core.autocrlf")) {
1260 if (value && !strcasecmp(value, "input")) {
1261 auto_crlf = AUTO_CRLF_INPUT;
1262 return 0;
1264 auto_crlf = git_config_bool(var, value);
1265 return 0;
1268 if (!strcmp(var, "core.safecrlf")) {
1269 int eol_rndtrp_die;
1270 if (value && !strcasecmp(value, "warn")) {
1271 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1272 return 0;
1274 eol_rndtrp_die = git_config_bool(var, value);
1275 global_conv_flags_eol = eol_rndtrp_die ?
1276 CONV_EOL_RNDTRP_DIE : 0;
1277 return 0;
1280 if (!strcmp(var, "core.eol")) {
1281 if (value && !strcasecmp(value, "lf"))
1282 core_eol = EOL_LF;
1283 else if (value && !strcasecmp(value, "crlf"))
1284 core_eol = EOL_CRLF;
1285 else if (value && !strcasecmp(value, "native"))
1286 core_eol = EOL_NATIVE;
1287 else
1288 core_eol = EOL_UNSET;
1289 return 0;
1292 if (!strcmp(var, "core.checkroundtripencoding")) {
1293 check_roundtrip_encoding = xstrdup(value);
1294 return 0;
1297 if (!strcmp(var, "core.notesref")) {
1298 notes_ref_name = xstrdup(value);
1299 return 0;
1302 if (!strcmp(var, "core.editor"))
1303 return git_config_string(&editor_program, var, value);
1305 if (!strcmp(var, "core.commentchar")) {
1306 if (!value)
1307 return config_error_nonbool(var);
1308 else if (!strcasecmp(value, "auto"))
1309 auto_comment_line_char = 1;
1310 else if (value[0] && !value[1]) {
1311 comment_line_char = value[0];
1312 auto_comment_line_char = 0;
1313 } else
1314 return error(_("core.commentChar should only be one character"));
1315 return 0;
1318 if (!strcmp(var, "core.askpass"))
1319 return git_config_string(&askpass_program, var, value);
1321 if (!strcmp(var, "core.excludesfile"))
1322 return git_config_pathname(&excludes_file, var, value);
1324 if (!strcmp(var, "core.whitespace")) {
1325 if (!value)
1326 return config_error_nonbool(var);
1327 whitespace_rule_cfg = parse_whitespace_rule(value);
1328 return 0;
1331 if (!strcmp(var, "core.fsyncobjectfiles")) {
1332 fsync_object_files = git_config_bool(var, value);
1333 return 0;
1336 if (!strcmp(var, "core.preloadindex")) {
1337 core_preload_index = git_config_bool(var, value);
1338 return 0;
1341 if (!strcmp(var, "core.createobject")) {
1342 if (!strcmp(value, "rename"))
1343 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1344 else if (!strcmp(value, "link"))
1345 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1346 else
1347 die(_("invalid mode for object creation: %s"), value);
1348 return 0;
1351 if (!strcmp(var, "core.sparsecheckout")) {
1352 core_apply_sparse_checkout = git_config_bool(var, value);
1353 return 0;
1356 if (!strcmp(var, "core.precomposeunicode")) {
1357 precomposed_unicode = git_config_bool(var, value);
1358 return 0;
1361 if (!strcmp(var, "core.protecthfs")) {
1362 protect_hfs = git_config_bool(var, value);
1363 return 0;
1366 if (!strcmp(var, "core.protectntfs")) {
1367 protect_ntfs = git_config_bool(var, value);
1368 return 0;
1371 if (!strcmp(var, "core.partialclonefilter")) {
1372 return git_config_string(&core_partial_clone_filter_default,
1373 var, value);
1376 if (!strcmp(var, "core.usereplacerefs")) {
1377 read_replace_refs = git_config_bool(var, value);
1378 return 0;
1381 /* Add other config variables here and to Documentation/config.txt. */
1382 return platform_core_config(var, value, cb);
1385 static int git_default_i18n_config(const char *var, const char *value)
1387 if (!strcmp(var, "i18n.commitencoding"))
1388 return git_config_string(&git_commit_encoding, var, value);
1390 if (!strcmp(var, "i18n.logoutputencoding"))
1391 return git_config_string(&git_log_output_encoding, var, value);
1393 /* Add other config variables here and to Documentation/config.txt. */
1394 return 0;
1397 static int git_default_branch_config(const char *var, const char *value)
1399 if (!strcmp(var, "branch.autosetupmerge")) {
1400 if (value && !strcasecmp(value, "always")) {
1401 git_branch_track = BRANCH_TRACK_ALWAYS;
1402 return 0;
1404 git_branch_track = git_config_bool(var, value);
1405 return 0;
1407 if (!strcmp(var, "branch.autosetuprebase")) {
1408 if (!value)
1409 return config_error_nonbool(var);
1410 else if (!strcmp(value, "never"))
1411 autorebase = AUTOREBASE_NEVER;
1412 else if (!strcmp(value, "local"))
1413 autorebase = AUTOREBASE_LOCAL;
1414 else if (!strcmp(value, "remote"))
1415 autorebase = AUTOREBASE_REMOTE;
1416 else if (!strcmp(value, "always"))
1417 autorebase = AUTOREBASE_ALWAYS;
1418 else
1419 return error(_("malformed value for %s"), var);
1420 return 0;
1423 /* Add other config variables here and to Documentation/config.txt. */
1424 return 0;
1427 static int git_default_push_config(const char *var, const char *value)
1429 if (!strcmp(var, "push.default")) {
1430 if (!value)
1431 return config_error_nonbool(var);
1432 else if (!strcmp(value, "nothing"))
1433 push_default = PUSH_DEFAULT_NOTHING;
1434 else if (!strcmp(value, "matching"))
1435 push_default = PUSH_DEFAULT_MATCHING;
1436 else if (!strcmp(value, "simple"))
1437 push_default = PUSH_DEFAULT_SIMPLE;
1438 else if (!strcmp(value, "upstream"))
1439 push_default = PUSH_DEFAULT_UPSTREAM;
1440 else if (!strcmp(value, "tracking")) /* deprecated */
1441 push_default = PUSH_DEFAULT_UPSTREAM;
1442 else if (!strcmp(value, "current"))
1443 push_default = PUSH_DEFAULT_CURRENT;
1444 else {
1445 error(_("malformed value for %s: %s"), var, value);
1446 return error(_("must be one of nothing, matching, simple, "
1447 "upstream or current"));
1449 return 0;
1452 /* Add other config variables here and to Documentation/config.txt. */
1453 return 0;
1456 static int git_default_mailmap_config(const char *var, const char *value)
1458 if (!strcmp(var, "mailmap.file"))
1459 return git_config_pathname(&git_mailmap_file, var, value);
1460 if (!strcmp(var, "mailmap.blob"))
1461 return git_config_string(&git_mailmap_blob, var, value);
1463 /* Add other config variables here and to Documentation/config.txt. */
1464 return 0;
1467 int git_default_config(const char *var, const char *value, void *cb)
1469 if (starts_with(var, "core."))
1470 return git_default_core_config(var, value, cb);
1472 if (starts_with(var, "user.") ||
1473 starts_with(var, "author.") ||
1474 starts_with(var, "committer."))
1475 return git_ident_config(var, value, cb);
1477 if (starts_with(var, "i18n."))
1478 return git_default_i18n_config(var, value);
1480 if (starts_with(var, "branch."))
1481 return git_default_branch_config(var, value);
1483 if (starts_with(var, "push."))
1484 return git_default_push_config(var, value);
1486 if (starts_with(var, "mailmap."))
1487 return git_default_mailmap_config(var, value);
1489 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1490 return git_default_advice_config(var, value);
1492 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1493 pager_use_color = git_config_bool(var,value);
1494 return 0;
1497 if (!strcmp(var, "pack.packsizelimit")) {
1498 pack_size_limit_cfg = git_config_ulong(var, value);
1499 return 0;
1502 if (!strcmp(var, "pack.compression")) {
1503 int level = git_config_int(var, value);
1504 if (level == -1)
1505 level = Z_DEFAULT_COMPRESSION;
1506 else if (level < 0 || level > Z_BEST_COMPRESSION)
1507 die(_("bad pack compression level %d"), level);
1508 pack_compression_level = level;
1509 pack_compression_seen = 1;
1510 return 0;
1513 /* Add other config variables here and to Documentation/config.txt. */
1514 return 0;
1518 * All source specific fields in the union, die_on_error, name and the callbacks
1519 * fgetc, ungetc, ftell of top need to be initialized before calling
1520 * this function.
1522 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1523 const struct config_options *opts)
1525 int ret;
1527 /* push config-file parsing state stack */
1528 top->prev = cf;
1529 top->linenr = 1;
1530 top->eof = 0;
1531 strbuf_init(&top->value, 1024);
1532 strbuf_init(&top->var, 1024);
1533 cf = top;
1535 ret = git_parse_source(fn, data, opts);
1537 /* pop config-file parsing state stack */
1538 strbuf_release(&top->value);
1539 strbuf_release(&top->var);
1540 cf = top->prev;
1542 return ret;
1545 static int do_config_from_file(config_fn_t fn,
1546 const enum config_origin_type origin_type,
1547 const char *name, const char *path, FILE *f,
1548 void *data, const struct config_options *opts)
1550 struct config_source top;
1551 int ret;
1553 top.u.file = f;
1554 top.origin_type = origin_type;
1555 top.name = name;
1556 top.path = path;
1557 top.default_error_action = CONFIG_ERROR_DIE;
1558 top.do_fgetc = config_file_fgetc;
1559 top.do_ungetc = config_file_ungetc;
1560 top.do_ftell = config_file_ftell;
1562 flockfile(f);
1563 ret = do_config_from(&top, fn, data, opts);
1564 funlockfile(f);
1565 return ret;
1568 static int git_config_from_stdin(config_fn_t fn, void *data)
1570 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1571 data, NULL);
1574 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1575 void *data,
1576 const struct config_options *opts)
1578 int ret = -1;
1579 FILE *f;
1581 f = fopen_or_warn(filename, "r");
1582 if (f) {
1583 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1584 filename, f, data, opts);
1585 fclose(f);
1587 return ret;
1590 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1592 return git_config_from_file_with_options(fn, filename, data, NULL);
1595 int git_config_from_mem(config_fn_t fn,
1596 const enum config_origin_type origin_type,
1597 const char *name, const char *buf, size_t len,
1598 void *data, const struct config_options *opts)
1600 struct config_source top;
1602 top.u.buf.buf = buf;
1603 top.u.buf.len = len;
1604 top.u.buf.pos = 0;
1605 top.origin_type = origin_type;
1606 top.name = name;
1607 top.path = NULL;
1608 top.default_error_action = CONFIG_ERROR_ERROR;
1609 top.do_fgetc = config_buf_fgetc;
1610 top.do_ungetc = config_buf_ungetc;
1611 top.do_ftell = config_buf_ftell;
1613 return do_config_from(&top, fn, data, opts);
1616 int git_config_from_blob_oid(config_fn_t fn,
1617 const char *name,
1618 const struct object_id *oid,
1619 void *data)
1621 enum object_type type;
1622 char *buf;
1623 unsigned long size;
1624 int ret;
1626 buf = read_object_file(oid, &type, &size);
1627 if (!buf)
1628 return error(_("unable to load config blob object '%s'"), name);
1629 if (type != OBJ_BLOB) {
1630 free(buf);
1631 return error(_("reference '%s' does not point to a blob"), name);
1634 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1635 data, NULL);
1636 free(buf);
1638 return ret;
1641 static int git_config_from_blob_ref(config_fn_t fn,
1642 const char *name,
1643 void *data)
1645 struct object_id oid;
1647 if (get_oid(name, &oid) < 0)
1648 return error(_("unable to resolve config blob '%s'"), name);
1649 return git_config_from_blob_oid(fn, name, &oid, data);
1652 const char *git_etc_gitconfig(void)
1654 static const char *system_wide;
1655 if (!system_wide)
1656 system_wide = system_path(ETC_GITCONFIG);
1657 return system_wide;
1661 * Parse environment variable 'k' as a boolean (in various
1662 * possible spellings); if missing, use the default value 'def'.
1664 int git_env_bool(const char *k, int def)
1666 const char *v = getenv(k);
1667 return v ? git_config_bool(k, v) : def;
1671 * Parse environment variable 'k' as ulong with possibly a unit
1672 * suffix; if missing, use the default value 'val'.
1674 unsigned long git_env_ulong(const char *k, unsigned long val)
1676 const char *v = getenv(k);
1677 if (v && !git_parse_ulong(v, &val))
1678 die(_("failed to parse %s"), k);
1679 return val;
1682 int git_config_system(void)
1684 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1687 static int do_git_config_sequence(const struct config_options *opts,
1688 config_fn_t fn, void *data)
1690 int ret = 0;
1691 char *xdg_config = xdg_config_home("config");
1692 char *user_config = expand_user_path("~/.gitconfig", 0);
1693 char *repo_config;
1695 if (opts->commondir)
1696 repo_config = mkpathdup("%s/config", opts->commondir);
1697 else if (opts->git_dir)
1698 BUG("git_dir without commondir");
1699 else
1700 repo_config = NULL;
1702 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1703 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK,
1704 opts->system_gently ?
1705 ACCESS_EACCES_OK : 0))
1706 ret += git_config_from_file(fn, git_etc_gitconfig(),
1707 data);
1709 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1710 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1711 ret += git_config_from_file(fn, xdg_config, data);
1713 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1714 ret += git_config_from_file(fn, user_config, data);
1716 current_parsing_scope = CONFIG_SCOPE_REPO;
1717 if (!opts->ignore_repo && repo_config &&
1718 !access_or_die(repo_config, R_OK, 0))
1719 ret += git_config_from_file(fn, repo_config, data);
1722 * Note: this should have a new scope, CONFIG_SCOPE_WORKTREE.
1723 * But let's not complicate things before it's actually needed.
1725 if (!opts->ignore_worktree && repository_format_worktree_config) {
1726 char *path = git_pathdup("config.worktree");
1727 if (!access_or_die(path, R_OK, 0))
1728 ret += git_config_from_file(fn, path, data);
1729 free(path);
1732 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1733 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
1734 die(_("unable to parse command-line config"));
1736 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1737 free(xdg_config);
1738 free(user_config);
1739 free(repo_config);
1740 return ret;
1743 int config_with_options(config_fn_t fn, void *data,
1744 struct git_config_source *config_source,
1745 const struct config_options *opts)
1747 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1749 if (opts->respect_includes) {
1750 inc.fn = fn;
1751 inc.data = data;
1752 inc.opts = opts;
1753 fn = git_config_include;
1754 data = &inc;
1758 * If we have a specific filename, use it. Otherwise, follow the
1759 * regular lookup sequence.
1761 if (config_source && config_source->use_stdin)
1762 return git_config_from_stdin(fn, data);
1763 else if (config_source && config_source->file)
1764 return git_config_from_file(fn, config_source->file, data);
1765 else if (config_source && config_source->blob)
1766 return git_config_from_blob_ref(fn, config_source->blob, data);
1768 return do_git_config_sequence(opts, fn, data);
1771 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1773 int i, value_index;
1774 struct string_list *values;
1775 struct config_set_element *entry;
1776 struct configset_list *list = &cs->list;
1778 for (i = 0; i < list->nr; i++) {
1779 entry = list->items[i].e;
1780 value_index = list->items[i].value_index;
1781 values = &entry->value_list;
1783 current_config_kvi = values->items[value_index].util;
1785 if (fn(entry->key, values->items[value_index].string, data) < 0)
1786 git_die_config_linenr(entry->key,
1787 current_config_kvi->filename,
1788 current_config_kvi->linenr);
1790 current_config_kvi = NULL;
1794 void read_early_config(config_fn_t cb, void *data)
1796 struct config_options opts = {0};
1797 struct strbuf commondir = STRBUF_INIT;
1798 struct strbuf gitdir = STRBUF_INIT;
1800 opts.respect_includes = 1;
1802 if (have_git_dir()) {
1803 opts.commondir = get_git_common_dir();
1804 opts.git_dir = get_git_dir();
1806 * When setup_git_directory() was not yet asked to discover the
1807 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1808 * is any repository config we should use (but unlike
1809 * setup_git_directory_gently(), no global state is changed, most
1810 * notably, the current working directory is still the same after the
1811 * call).
1813 } else if (!discover_git_directory(&commondir, &gitdir)) {
1814 opts.commondir = commondir.buf;
1815 opts.git_dir = gitdir.buf;
1818 config_with_options(cb, data, NULL, &opts);
1820 strbuf_release(&commondir);
1821 strbuf_release(&gitdir);
1825 * Read config but only enumerate system and global settings.
1826 * Omit any repo-local, worktree-local, or command-line settings.
1828 void read_very_early_config(config_fn_t cb, void *data)
1830 struct config_options opts = { 0 };
1832 opts.respect_includes = 1;
1833 opts.ignore_repo = 1;
1834 opts.ignore_worktree = 1;
1835 opts.ignore_cmdline = 1;
1836 opts.system_gently = 1;
1838 config_with_options(cb, data, NULL, &opts);
1841 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1843 struct config_set_element k;
1844 struct config_set_element *found_entry;
1845 char *normalized_key;
1847 * `key` may come from the user, so normalize it before using it
1848 * for querying entries from the hashmap.
1850 if (git_config_parse_key(key, &normalized_key, NULL))
1851 return NULL;
1853 hashmap_entry_init(&k, strhash(normalized_key));
1854 k.key = normalized_key;
1855 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1856 free(normalized_key);
1857 return found_entry;
1860 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1862 struct config_set_element *e;
1863 struct string_list_item *si;
1864 struct configset_list_item *l_item;
1865 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1867 e = configset_find_element(cs, key);
1869 * Since the keys are being fed by git_config*() callback mechanism, they
1870 * are already normalized. So simply add them without any further munging.
1872 if (!e) {
1873 e = xmalloc(sizeof(*e));
1874 hashmap_entry_init(e, strhash(key));
1875 e->key = xstrdup(key);
1876 string_list_init(&e->value_list, 1);
1877 hashmap_add(&cs->config_hash, e);
1879 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1881 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1882 l_item = &cs->list.items[cs->list.nr++];
1883 l_item->e = e;
1884 l_item->value_index = e->value_list.nr - 1;
1886 if (!cf)
1887 BUG("configset_add_value has no source");
1888 if (cf->name) {
1889 kv_info->filename = strintern(cf->name);
1890 kv_info->linenr = cf->linenr;
1891 kv_info->origin_type = cf->origin_type;
1892 } else {
1893 /* for values read from `git_config_from_parameters()` */
1894 kv_info->filename = NULL;
1895 kv_info->linenr = -1;
1896 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1898 kv_info->scope = current_parsing_scope;
1899 si->util = kv_info;
1901 return 0;
1904 static int config_set_element_cmp(const void *unused_cmp_data,
1905 const void *entry,
1906 const void *entry_or_key,
1907 const void *unused_keydata)
1909 const struct config_set_element *e1 = entry;
1910 const struct config_set_element *e2 = entry_or_key;
1912 return strcmp(e1->key, e2->key);
1915 void git_configset_init(struct config_set *cs)
1917 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1918 cs->hash_initialized = 1;
1919 cs->list.nr = 0;
1920 cs->list.alloc = 0;
1921 cs->list.items = NULL;
1924 void git_configset_clear(struct config_set *cs)
1926 struct config_set_element *entry;
1927 struct hashmap_iter iter;
1928 if (!cs->hash_initialized)
1929 return;
1931 hashmap_iter_init(&cs->config_hash, &iter);
1932 while ((entry = hashmap_iter_next(&iter))) {
1933 free(entry->key);
1934 string_list_clear(&entry->value_list, 1);
1936 hashmap_free(&cs->config_hash, 1);
1937 cs->hash_initialized = 0;
1938 free(cs->list.items);
1939 cs->list.nr = 0;
1940 cs->list.alloc = 0;
1941 cs->list.items = NULL;
1944 static int config_set_callback(const char *key, const char *value, void *cb)
1946 struct config_set *cs = cb;
1947 configset_add_value(cs, key, value);
1948 return 0;
1951 int git_configset_add_file(struct config_set *cs, const char *filename)
1953 return git_config_from_file(config_set_callback, filename, cs);
1956 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1958 const struct string_list *values = NULL;
1960 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1961 * queried key in the files of the configset, the value returned will be the last
1962 * value in the value list for that key.
1964 values = git_configset_get_value_multi(cs, key);
1966 if (!values)
1967 return 1;
1968 assert(values->nr > 0);
1969 *value = values->items[values->nr - 1].string;
1970 return 0;
1973 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1975 struct config_set_element *e = configset_find_element(cs, key);
1976 return e ? &e->value_list : NULL;
1979 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1981 const char *value;
1982 if (!git_configset_get_value(cs, key, &value))
1983 return git_config_string(dest, key, value);
1984 else
1985 return 1;
1988 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1990 return git_configset_get_string_const(cs, key, (const char **)dest);
1993 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1995 const char *value;
1996 if (!git_configset_get_value(cs, key, &value)) {
1997 *dest = git_config_int(key, value);
1998 return 0;
1999 } else
2000 return 1;
2003 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
2005 const char *value;
2006 if (!git_configset_get_value(cs, key, &value)) {
2007 *dest = git_config_ulong(key, value);
2008 return 0;
2009 } else
2010 return 1;
2013 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
2015 const char *value;
2016 if (!git_configset_get_value(cs, key, &value)) {
2017 *dest = git_config_bool(key, value);
2018 return 0;
2019 } else
2020 return 1;
2023 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
2024 int *is_bool, int *dest)
2026 const char *value;
2027 if (!git_configset_get_value(cs, key, &value)) {
2028 *dest = git_config_bool_or_int(key, value, is_bool);
2029 return 0;
2030 } else
2031 return 1;
2034 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
2036 const char *value;
2037 if (!git_configset_get_value(cs, key, &value)) {
2038 *dest = git_parse_maybe_bool(value);
2039 if (*dest == -1)
2040 return -1;
2041 return 0;
2042 } else
2043 return 1;
2046 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
2048 const char *value;
2049 if (!git_configset_get_value(cs, key, &value))
2050 return git_config_pathname(dest, key, value);
2051 else
2052 return 1;
2055 /* Functions use to read configuration from a repository */
2056 static void repo_read_config(struct repository *repo)
2058 struct config_options opts = { 0 };
2060 opts.respect_includes = 1;
2061 opts.commondir = repo->commondir;
2062 opts.git_dir = repo->gitdir;
2064 if (!repo->config)
2065 repo->config = xcalloc(1, sizeof(struct config_set));
2066 else
2067 git_configset_clear(repo->config);
2069 git_configset_init(repo->config);
2071 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2073 * config_with_options() normally returns only
2074 * zero, as most errors are fatal, and
2075 * non-fatal potential errors are guarded by "if"
2076 * statements that are entered only when no error is
2077 * possible.
2079 * If we ever encounter a non-fatal error, it means
2080 * something went really wrong and we should stop
2081 * immediately.
2083 die(_("unknown error occurred while reading the configuration files"));
2086 static void git_config_check_init(struct repository *repo)
2088 if (repo->config && repo->config->hash_initialized)
2089 return;
2090 repo_read_config(repo);
2093 static void repo_config_clear(struct repository *repo)
2095 if (!repo->config || !repo->config->hash_initialized)
2096 return;
2097 git_configset_clear(repo->config);
2100 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2102 git_config_check_init(repo);
2103 configset_iter(repo->config, fn, data);
2106 int repo_config_get_value(struct repository *repo,
2107 const char *key, const char **value)
2109 git_config_check_init(repo);
2110 return git_configset_get_value(repo->config, key, value);
2113 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2114 const char *key)
2116 git_config_check_init(repo);
2117 return git_configset_get_value_multi(repo->config, key);
2120 int repo_config_get_string_const(struct repository *repo,
2121 const char *key, const char **dest)
2123 int ret;
2124 git_config_check_init(repo);
2125 ret = git_configset_get_string_const(repo->config, key, dest);
2126 if (ret < 0)
2127 git_die_config(key, NULL);
2128 return ret;
2131 int repo_config_get_string(struct repository *repo,
2132 const char *key, char **dest)
2134 git_config_check_init(repo);
2135 return repo_config_get_string_const(repo, key, (const char **)dest);
2138 int repo_config_get_int(struct repository *repo,
2139 const char *key, int *dest)
2141 git_config_check_init(repo);
2142 return git_configset_get_int(repo->config, key, dest);
2145 int repo_config_get_ulong(struct repository *repo,
2146 const char *key, unsigned long *dest)
2148 git_config_check_init(repo);
2149 return git_configset_get_ulong(repo->config, key, dest);
2152 int repo_config_get_bool(struct repository *repo,
2153 const char *key, int *dest)
2155 git_config_check_init(repo);
2156 return git_configset_get_bool(repo->config, key, dest);
2159 int repo_config_get_bool_or_int(struct repository *repo,
2160 const char *key, int *is_bool, int *dest)
2162 git_config_check_init(repo);
2163 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2166 int repo_config_get_maybe_bool(struct repository *repo,
2167 const char *key, int *dest)
2169 git_config_check_init(repo);
2170 return git_configset_get_maybe_bool(repo->config, key, dest);
2173 int repo_config_get_pathname(struct repository *repo,
2174 const char *key, const char **dest)
2176 int ret;
2177 git_config_check_init(repo);
2178 ret = git_configset_get_pathname(repo->config, key, dest);
2179 if (ret < 0)
2180 git_die_config(key, NULL);
2181 return ret;
2184 /* Functions used historically to read configuration from 'the_repository' */
2185 void git_config(config_fn_t fn, void *data)
2187 repo_config(the_repository, fn, data);
2190 void git_config_clear(void)
2192 repo_config_clear(the_repository);
2195 int git_config_get_value(const char *key, const char **value)
2197 return repo_config_get_value(the_repository, key, value);
2200 const struct string_list *git_config_get_value_multi(const char *key)
2202 return repo_config_get_value_multi(the_repository, key);
2205 int git_config_get_string_const(const char *key, const char **dest)
2207 return repo_config_get_string_const(the_repository, key, dest);
2210 int git_config_get_string(const char *key, char **dest)
2212 return repo_config_get_string(the_repository, key, dest);
2215 int git_config_get_int(const char *key, int *dest)
2217 return repo_config_get_int(the_repository, key, dest);
2220 int git_config_get_ulong(const char *key, unsigned long *dest)
2222 return repo_config_get_ulong(the_repository, key, dest);
2225 int git_config_get_bool(const char *key, int *dest)
2227 return repo_config_get_bool(the_repository, key, dest);
2230 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2232 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2235 int git_config_get_maybe_bool(const char *key, int *dest)
2237 return repo_config_get_maybe_bool(the_repository, key, dest);
2240 int git_config_get_pathname(const char *key, const char **dest)
2242 return repo_config_get_pathname(the_repository, key, dest);
2245 int git_config_get_expiry(const char *key, const char **output)
2247 int ret = git_config_get_string_const(key, output);
2248 if (ret)
2249 return ret;
2250 if (strcmp(*output, "now")) {
2251 timestamp_t now = approxidate("now");
2252 if (approxidate(*output) >= now)
2253 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2255 return ret;
2258 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2260 char *expiry_string;
2261 intmax_t days;
2262 timestamp_t when;
2264 if (git_config_get_string(key, &expiry_string))
2265 return 1; /* no such thing */
2267 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2268 const int scale = 86400;
2269 *expiry = now - days * scale;
2270 return 0;
2273 if (!parse_expiry_date(expiry_string, &when)) {
2274 *expiry = when;
2275 return 0;
2277 return -1; /* thing exists but cannot be parsed */
2280 int git_config_get_untracked_cache(void)
2282 int val = -1;
2283 const char *v;
2285 /* Hack for test programs like test-dump-untracked-cache */
2286 if (ignore_untracked_cache_config)
2287 return -1;
2289 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2290 return val;
2292 if (!git_config_get_value("core.untrackedcache", &v)) {
2293 if (!strcasecmp(v, "keep"))
2294 return -1;
2296 error(_("unknown core.untrackedCache value '%s'; "
2297 "using 'keep' default value"), v);
2298 return -1;
2301 return -1; /* default value */
2304 int git_config_get_split_index(void)
2306 int val;
2308 if (!git_config_get_maybe_bool("core.splitindex", &val))
2309 return val;
2311 return -1; /* default value */
2314 int git_config_get_max_percent_split_change(void)
2316 int val = -1;
2318 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2319 if (0 <= val && val <= 100)
2320 return val;
2322 return error(_("splitIndex.maxPercentChange value '%d' "
2323 "should be between 0 and 100"), val);
2326 return -1; /* default value */
2329 int git_config_get_fsmonitor(void)
2331 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2332 core_fsmonitor = getenv("GIT_TEST_FSMONITOR");
2334 if (core_fsmonitor && !*core_fsmonitor)
2335 core_fsmonitor = NULL;
2337 if (core_fsmonitor)
2338 return 1;
2340 return 0;
2343 int git_config_get_index_threads(int *dest)
2345 int is_bool, val;
2347 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2348 if (val) {
2349 *dest = val;
2350 return 0;
2353 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2354 if (is_bool)
2355 *dest = val ? 0 : 1;
2356 else
2357 *dest = val;
2358 return 0;
2361 return 1;
2364 NORETURN
2365 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2367 if (!filename)
2368 die(_("unable to parse '%s' from command-line config"), key);
2369 else
2370 die(_("bad config variable '%s' in file '%s' at line %d"),
2371 key, filename, linenr);
2374 NORETURN __attribute__((format(printf, 2, 3)))
2375 void git_die_config(const char *key, const char *err, ...)
2377 const struct string_list *values;
2378 struct key_value_info *kv_info;
2380 if (err) {
2381 va_list params;
2382 va_start(params, err);
2383 vreportf("error: ", err, params);
2384 va_end(params);
2386 values = git_config_get_value_multi(key);
2387 kv_info = values->items[values->nr - 1].util;
2388 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2392 * Find all the stuff for git_config_set() below.
2395 struct config_store_data {
2396 int baselen;
2397 char *key;
2398 int do_not_match;
2399 regex_t *value_regex;
2400 int multi_replace;
2401 struct {
2402 size_t begin, end;
2403 enum config_event_t type;
2404 int is_keys_section;
2405 } *parsed;
2406 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2407 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2410 static void config_store_data_clear(struct config_store_data *store)
2412 free(store->key);
2413 if (store->value_regex != NULL &&
2414 store->value_regex != CONFIG_REGEX_NONE) {
2415 regfree(store->value_regex);
2416 free(store->value_regex);
2418 free(store->parsed);
2419 free(store->seen);
2420 memset(store, 0, sizeof(*store));
2423 static int matches(const char *key, const char *value,
2424 const struct config_store_data *store)
2426 if (strcmp(key, store->key))
2427 return 0; /* not ours */
2428 if (!store->value_regex)
2429 return 1; /* always matches */
2430 if (store->value_regex == CONFIG_REGEX_NONE)
2431 return 0; /* never matches */
2433 return store->do_not_match ^
2434 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2437 static int store_aux_event(enum config_event_t type,
2438 size_t begin, size_t end, void *data)
2440 struct config_store_data *store = data;
2442 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2443 store->parsed[store->parsed_nr].begin = begin;
2444 store->parsed[store->parsed_nr].end = end;
2445 store->parsed[store->parsed_nr].type = type;
2447 if (type == CONFIG_EVENT_SECTION) {
2448 int (*cmpfn)(const char *, const char *, size_t);
2450 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2451 return error(_("invalid section name '%s'"), cf->var.buf);
2453 if (cf->subsection_case_sensitive)
2454 cmpfn = strncasecmp;
2455 else
2456 cmpfn = strncmp;
2458 /* Is this the section we were looking for? */
2459 store->is_keys_section =
2460 store->parsed[store->parsed_nr].is_keys_section =
2461 cf->var.len - 1 == store->baselen &&
2462 !cmpfn(cf->var.buf, store->key, store->baselen);
2463 if (store->is_keys_section) {
2464 store->section_seen = 1;
2465 ALLOC_GROW(store->seen, store->seen_nr + 1,
2466 store->seen_alloc);
2467 store->seen[store->seen_nr] = store->parsed_nr;
2471 store->parsed_nr++;
2473 return 0;
2476 static int store_aux(const char *key, const char *value, void *cb)
2478 struct config_store_data *store = cb;
2480 if (store->key_seen) {
2481 if (matches(key, value, store)) {
2482 if (store->seen_nr == 1 && store->multi_replace == 0) {
2483 warning(_("%s has multiple values"), key);
2486 ALLOC_GROW(store->seen, store->seen_nr + 1,
2487 store->seen_alloc);
2489 store->seen[store->seen_nr] = store->parsed_nr;
2490 store->seen_nr++;
2492 } else if (store->is_keys_section) {
2494 * Do not increment matches yet: this may not be a match, but we
2495 * are in the desired section.
2497 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2498 store->seen[store->seen_nr] = store->parsed_nr;
2499 store->section_seen = 1;
2501 if (matches(key, value, store)) {
2502 store->seen_nr++;
2503 store->key_seen = 1;
2507 return 0;
2510 static int write_error(const char *filename)
2512 error(_("failed to write new configuration file %s"), filename);
2514 /* Same error code as "failed to rename". */
2515 return 4;
2518 static struct strbuf store_create_section(const char *key,
2519 const struct config_store_data *store)
2521 const char *dot;
2522 int i;
2523 struct strbuf sb = STRBUF_INIT;
2525 dot = memchr(key, '.', store->baselen);
2526 if (dot) {
2527 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2528 for (i = dot - key + 1; i < store->baselen; i++) {
2529 if (key[i] == '"' || key[i] == '\\')
2530 strbuf_addch(&sb, '\\');
2531 strbuf_addch(&sb, key[i]);
2533 strbuf_addstr(&sb, "\"]\n");
2534 } else {
2535 strbuf_addf(&sb, "[%.*s]\n", store->baselen, key);
2538 return sb;
2541 static ssize_t write_section(int fd, const char *key,
2542 const struct config_store_data *store)
2544 struct strbuf sb = store_create_section(key, store);
2545 ssize_t ret;
2547 ret = write_in_full(fd, sb.buf, sb.len);
2548 strbuf_release(&sb);
2550 return ret;
2553 static ssize_t write_pair(int fd, const char *key, const char *value,
2554 const struct config_store_data *store)
2556 int i;
2557 ssize_t ret;
2558 int length = strlen(key + store->baselen + 1);
2559 const char *quote = "";
2560 struct strbuf sb = STRBUF_INIT;
2563 * Check to see if the value needs to be surrounded with a dq pair.
2564 * Note that problematic characters are always backslash-quoted; this
2565 * check is about not losing leading or trailing SP and strings that
2566 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2567 * configuration parser.
2569 if (value[0] == ' ')
2570 quote = "\"";
2571 for (i = 0; value[i]; i++)
2572 if (value[i] == ';' || value[i] == '#')
2573 quote = "\"";
2574 if (i && value[i - 1] == ' ')
2575 quote = "\"";
2577 strbuf_addf(&sb, "\t%.*s = %s",
2578 length, key + store->baselen + 1, quote);
2580 for (i = 0; value[i]; i++)
2581 switch (value[i]) {
2582 case '\n':
2583 strbuf_addstr(&sb, "\\n");
2584 break;
2585 case '\t':
2586 strbuf_addstr(&sb, "\\t");
2587 break;
2588 case '"':
2589 case '\\':
2590 strbuf_addch(&sb, '\\');
2591 /* fallthrough */
2592 default:
2593 strbuf_addch(&sb, value[i]);
2594 break;
2596 strbuf_addf(&sb, "%s\n", quote);
2598 ret = write_in_full(fd, sb.buf, sb.len);
2599 strbuf_release(&sb);
2601 return ret;
2605 * If we are about to unset the last key(s) in a section, and if there are
2606 * no comments surrounding (or included in) the section, we will want to
2607 * extend begin/end to remove the entire section.
2609 * Note: the parameter `seen_ptr` points to the index into the store.seen
2610 * array. * This index may be incremented if a section has more than one
2611 * entry (which all are to be removed).
2613 static void maybe_remove_section(struct config_store_data *store,
2614 size_t *begin_offset, size_t *end_offset,
2615 int *seen_ptr)
2617 size_t begin;
2618 int i, seen, section_seen = 0;
2621 * First, ensure that this is the first key, and that there are no
2622 * comments before the entry nor before the section header.
2624 seen = *seen_ptr;
2625 for (i = store->seen[seen]; i > 0; i--) {
2626 enum config_event_t type = store->parsed[i - 1].type;
2628 if (type == CONFIG_EVENT_COMMENT)
2629 /* There is a comment before this entry or section */
2630 return;
2631 if (type == CONFIG_EVENT_ENTRY) {
2632 if (!section_seen)
2633 /* This is not the section's first entry. */
2634 return;
2635 /* We encountered no comment before the section. */
2636 break;
2638 if (type == CONFIG_EVENT_SECTION) {
2639 if (!store->parsed[i - 1].is_keys_section)
2640 break;
2641 section_seen = 1;
2644 begin = store->parsed[i].begin;
2647 * Next, make sure that we are removing he last key(s) in the section,
2648 * and that there are no comments that are possibly about the current
2649 * section.
2651 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2652 enum config_event_t type = store->parsed[i].type;
2654 if (type == CONFIG_EVENT_COMMENT)
2655 return;
2656 if (type == CONFIG_EVENT_SECTION) {
2657 if (store->parsed[i].is_keys_section)
2658 continue;
2659 break;
2661 if (type == CONFIG_EVENT_ENTRY) {
2662 if (++seen < store->seen_nr &&
2663 i == store->seen[seen])
2664 /* We want to remove this entry, too */
2665 continue;
2666 /* There is another entry in this section. */
2667 return;
2672 * We are really removing the last entry/entries from this section, and
2673 * there are no enclosed or surrounding comments. Remove the entire,
2674 * now-empty section.
2676 *seen_ptr = seen;
2677 *begin_offset = begin;
2678 if (i < store->parsed_nr)
2679 *end_offset = store->parsed[i].begin;
2680 else
2681 *end_offset = store->parsed[store->parsed_nr - 1].end;
2684 int git_config_set_in_file_gently(const char *config_filename,
2685 const char *key, const char *value)
2687 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2690 void git_config_set_in_file(const char *config_filename,
2691 const char *key, const char *value)
2693 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2696 int git_config_set_gently(const char *key, const char *value)
2698 return git_config_set_multivar_gently(key, value, NULL, 0);
2701 void git_config_set(const char *key, const char *value)
2703 git_config_set_multivar(key, value, NULL, 0);
2705 trace2_cmd_set_config(key, value);
2709 * If value==NULL, unset in (remove from) config,
2710 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2711 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2712 * (only add a new one)
2713 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2714 * else all matching key/values (regardless how many) are removed,
2715 * before the new pair is written.
2717 * Returns 0 on success.
2719 * This function does this:
2721 * - it locks the config file by creating ".git/config.lock"
2723 * - it then parses the config using store_aux() as validator to find
2724 * the position on the key/value pair to replace. If it is to be unset,
2725 * it must be found exactly once.
2727 * - the config file is mmap()ed and the part before the match (if any) is
2728 * written to the lock file, then the changed part and the rest.
2730 * - the config file is removed and the lock file rename()d to it.
2733 int git_config_set_multivar_in_file_gently(const char *config_filename,
2734 const char *key, const char *value,
2735 const char *value_regex,
2736 int multi_replace)
2738 int fd = -1, in_fd = -1;
2739 int ret;
2740 struct lock_file lock = LOCK_INIT;
2741 char *filename_buf = NULL;
2742 char *contents = NULL;
2743 size_t contents_sz;
2744 struct config_store_data store;
2746 memset(&store, 0, sizeof(store));
2748 /* parse-key returns negative; flip the sign to feed exit(3) */
2749 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2750 if (ret)
2751 goto out_free;
2753 store.multi_replace = multi_replace;
2755 if (!config_filename)
2756 config_filename = filename_buf = git_pathdup("config");
2759 * The lock serves a purpose in addition to locking: the new
2760 * contents of .git/config will be written into it.
2762 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2763 if (fd < 0) {
2764 error_errno(_("could not lock config file %s"), config_filename);
2765 ret = CONFIG_NO_LOCK;
2766 goto out_free;
2770 * If .git/config does not exist yet, write a minimal version.
2772 in_fd = open(config_filename, O_RDONLY);
2773 if ( in_fd < 0 ) {
2774 if ( ENOENT != errno ) {
2775 error_errno(_("opening %s"), config_filename);
2776 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2777 goto out_free;
2779 /* if nothing to unset, error out */
2780 if (value == NULL) {
2781 ret = CONFIG_NOTHING_SET;
2782 goto out_free;
2785 free(store.key);
2786 store.key = xstrdup(key);
2787 if (write_section(fd, key, &store) < 0 ||
2788 write_pair(fd, key, value, &store) < 0)
2789 goto write_err_out;
2790 } else {
2791 struct stat st;
2792 size_t copy_begin, copy_end;
2793 int i, new_line = 0;
2794 struct config_options opts;
2796 if (value_regex == NULL)
2797 store.value_regex = NULL;
2798 else if (value_regex == CONFIG_REGEX_NONE)
2799 store.value_regex = CONFIG_REGEX_NONE;
2800 else {
2801 if (value_regex[0] == '!') {
2802 store.do_not_match = 1;
2803 value_regex++;
2804 } else
2805 store.do_not_match = 0;
2807 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2808 if (regcomp(store.value_regex, value_regex,
2809 REG_EXTENDED)) {
2810 error(_("invalid pattern: %s"), value_regex);
2811 FREE_AND_NULL(store.value_regex);
2812 ret = CONFIG_INVALID_PATTERN;
2813 goto out_free;
2817 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2818 store.parsed[0].end = 0;
2820 memset(&opts, 0, sizeof(opts));
2821 opts.event_fn = store_aux_event;
2822 opts.event_fn_data = &store;
2825 * After this, store.parsed will contain offsets of all the
2826 * parsed elements, and store.seen will contain a list of
2827 * matches, as indices into store.parsed.
2829 * As a side effect, we make sure to transform only a valid
2830 * existing config file.
2832 if (git_config_from_file_with_options(store_aux,
2833 config_filename,
2834 &store, &opts)) {
2835 error(_("invalid config file %s"), config_filename);
2836 ret = CONFIG_INVALID_FILE;
2837 goto out_free;
2840 /* if nothing to unset, or too many matches, error out */
2841 if ((store.seen_nr == 0 && value == NULL) ||
2842 (store.seen_nr > 1 && multi_replace == 0)) {
2843 ret = CONFIG_NOTHING_SET;
2844 goto out_free;
2847 if (fstat(in_fd, &st) == -1) {
2848 error_errno(_("fstat on %s failed"), config_filename);
2849 ret = CONFIG_INVALID_FILE;
2850 goto out_free;
2853 contents_sz = xsize_t(st.st_size);
2854 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2855 MAP_PRIVATE, in_fd, 0);
2856 if (contents == MAP_FAILED) {
2857 if (errno == ENODEV && S_ISDIR(st.st_mode))
2858 errno = EISDIR;
2859 error_errno(_("unable to mmap '%s'"), config_filename);
2860 ret = CONFIG_INVALID_FILE;
2861 contents = NULL;
2862 goto out_free;
2864 close(in_fd);
2865 in_fd = -1;
2867 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2868 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
2869 ret = CONFIG_NO_WRITE;
2870 goto out_free;
2873 if (store.seen_nr == 0) {
2874 if (!store.seen_alloc) {
2875 /* Did not see key nor section */
2876 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2877 store.seen[0] = store.parsed_nr
2878 - !!store.parsed_nr;
2880 store.seen_nr = 1;
2883 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2884 size_t replace_end;
2885 int j = store.seen[i];
2887 new_line = 0;
2888 if (!store.key_seen) {
2889 copy_end = store.parsed[j].end;
2890 /* include '\n' when copying section header */
2891 if (copy_end > 0 && copy_end < contents_sz &&
2892 contents[copy_end - 1] != '\n' &&
2893 contents[copy_end] == '\n')
2894 copy_end++;
2895 replace_end = copy_end;
2896 } else {
2897 replace_end = store.parsed[j].end;
2898 copy_end = store.parsed[j].begin;
2899 if (!value)
2900 maybe_remove_section(&store,
2901 &copy_end,
2902 &replace_end, &i);
2904 * Swallow preceding white-space on the same
2905 * line.
2907 while (copy_end > 0 ) {
2908 char c = contents[copy_end - 1];
2910 if (isspace(c) && c != '\n')
2911 copy_end--;
2912 else
2913 break;
2917 if (copy_end > 0 && contents[copy_end-1] != '\n')
2918 new_line = 1;
2920 /* write the first part of the config */
2921 if (copy_end > copy_begin) {
2922 if (write_in_full(fd, contents + copy_begin,
2923 copy_end - copy_begin) < 0)
2924 goto write_err_out;
2925 if (new_line &&
2926 write_str_in_full(fd, "\n") < 0)
2927 goto write_err_out;
2929 copy_begin = replace_end;
2932 /* write the pair (value == NULL means unset) */
2933 if (value != NULL) {
2934 if (!store.section_seen) {
2935 if (write_section(fd, key, &store) < 0)
2936 goto write_err_out;
2938 if (write_pair(fd, key, value, &store) < 0)
2939 goto write_err_out;
2942 /* write the rest of the config */
2943 if (copy_begin < contents_sz)
2944 if (write_in_full(fd, contents + copy_begin,
2945 contents_sz - copy_begin) < 0)
2946 goto write_err_out;
2948 munmap(contents, contents_sz);
2949 contents = NULL;
2952 if (commit_lock_file(&lock) < 0) {
2953 error_errno(_("could not write config file %s"), config_filename);
2954 ret = CONFIG_NO_WRITE;
2955 goto out_free;
2958 ret = 0;
2960 /* Invalidate the config cache */
2961 git_config_clear();
2963 out_free:
2964 rollback_lock_file(&lock);
2965 free(filename_buf);
2966 if (contents)
2967 munmap(contents, contents_sz);
2968 if (in_fd >= 0)
2969 close(in_fd);
2970 config_store_data_clear(&store);
2971 return ret;
2973 write_err_out:
2974 ret = write_error(get_lock_file_path(&lock));
2975 goto out_free;
2979 void git_config_set_multivar_in_file(const char *config_filename,
2980 const char *key, const char *value,
2981 const char *value_regex, int multi_replace)
2983 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2984 value_regex, multi_replace))
2985 return;
2986 if (value)
2987 die(_("could not set '%s' to '%s'"), key, value);
2988 else
2989 die(_("could not unset '%s'"), key);
2992 int git_config_set_multivar_gently(const char *key, const char *value,
2993 const char *value_regex, int multi_replace)
2995 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2996 multi_replace);
2999 void git_config_set_multivar(const char *key, const char *value,
3000 const char *value_regex, int multi_replace)
3002 git_config_set_multivar_in_file(NULL, key, value, value_regex,
3003 multi_replace);
3006 static int section_name_match (const char *buf, const char *name)
3008 int i = 0, j = 0, dot = 0;
3009 if (buf[i] != '[')
3010 return 0;
3011 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3012 if (!dot && isspace(buf[i])) {
3013 dot = 1;
3014 if (name[j++] != '.')
3015 break;
3016 for (i++; isspace(buf[i]); i++)
3017 ; /* do nothing */
3018 if (buf[i] != '"')
3019 break;
3020 continue;
3022 if (buf[i] == '\\' && dot)
3023 i++;
3024 else if (buf[i] == '"' && dot) {
3025 for (i++; isspace(buf[i]); i++)
3026 ; /* do_nothing */
3027 break;
3029 if (buf[i] != name[j++])
3030 break;
3032 if (buf[i] == ']' && name[j] == 0) {
3034 * We match, now just find the right length offset by
3035 * gobbling up any whitespace after it, as well
3037 i++;
3038 for (; buf[i] && isspace(buf[i]); i++)
3039 ; /* do nothing */
3040 return i;
3042 return 0;
3045 static int section_name_is_ok(const char *name)
3047 /* Empty section names are bogus. */
3048 if (!*name)
3049 return 0;
3052 * Before a dot, we must be alphanumeric or dash. After the first dot,
3053 * anything goes, so we can stop checking.
3055 for (; *name && *name != '.'; name++)
3056 if (*name != '-' && !isalnum(*name))
3057 return 0;
3058 return 1;
3061 /* if new_name == NULL, the section is removed instead */
3062 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3063 const char *old_name,
3064 const char *new_name, int copy)
3066 int ret = 0, remove = 0;
3067 char *filename_buf = NULL;
3068 struct lock_file lock = LOCK_INIT;
3069 int out_fd;
3070 char buf[1024];
3071 FILE *config_file = NULL;
3072 struct stat st;
3073 struct strbuf copystr = STRBUF_INIT;
3074 struct config_store_data store;
3076 memset(&store, 0, sizeof(store));
3078 if (new_name && !section_name_is_ok(new_name)) {
3079 ret = error(_("invalid section name: %s"), new_name);
3080 goto out_no_rollback;
3083 if (!config_filename)
3084 config_filename = filename_buf = git_pathdup("config");
3086 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3087 if (out_fd < 0) {
3088 ret = error(_("could not lock config file %s"), config_filename);
3089 goto out;
3092 if (!(config_file = fopen(config_filename, "rb"))) {
3093 ret = warn_on_fopen_errors(config_filename);
3094 if (ret)
3095 goto out;
3096 /* no config file means nothing to rename, no error */
3097 goto commit_and_out;
3100 if (fstat(fileno(config_file), &st) == -1) {
3101 ret = error_errno(_("fstat on %s failed"), config_filename);
3102 goto out;
3105 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3106 ret = error_errno(_("chmod on %s failed"),
3107 get_lock_file_path(&lock));
3108 goto out;
3111 while (fgets(buf, sizeof(buf), config_file)) {
3112 int i;
3113 int length;
3114 int is_section = 0;
3115 char *output = buf;
3116 for (i = 0; buf[i] && isspace(buf[i]); i++)
3117 ; /* do nothing */
3118 if (buf[i] == '[') {
3119 /* it's a section */
3120 int offset;
3121 is_section = 1;
3124 * When encountering a new section under -c we
3125 * need to flush out any section we're already
3126 * coping and begin anew. There might be
3127 * multiple [branch "$name"] sections.
3129 if (copystr.len > 0) {
3130 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3131 ret = write_error(get_lock_file_path(&lock));
3132 goto out;
3134 strbuf_reset(&copystr);
3137 offset = section_name_match(&buf[i], old_name);
3138 if (offset > 0) {
3139 ret++;
3140 if (new_name == NULL) {
3141 remove = 1;
3142 continue;
3144 store.baselen = strlen(new_name);
3145 if (!copy) {
3146 if (write_section(out_fd, new_name, &store) < 0) {
3147 ret = write_error(get_lock_file_path(&lock));
3148 goto out;
3151 * We wrote out the new section, with
3152 * a newline, now skip the old
3153 * section's length
3155 output += offset + i;
3156 if (strlen(output) > 0) {
3158 * More content means there's
3159 * a declaration to put on the
3160 * next line; indent with a
3161 * tab
3163 output -= 1;
3164 output[0] = '\t';
3166 } else {
3167 copystr = store_create_section(new_name, &store);
3170 remove = 0;
3172 if (remove)
3173 continue;
3174 length = strlen(output);
3176 if (!is_section && copystr.len > 0) {
3177 strbuf_add(&copystr, output, length);
3180 if (write_in_full(out_fd, output, length) < 0) {
3181 ret = write_error(get_lock_file_path(&lock));
3182 goto out;
3187 * Copy a trailing section at the end of the config, won't be
3188 * flushed by the usual "flush because we have a new section
3189 * logic in the loop above.
3191 if (copystr.len > 0) {
3192 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3193 ret = write_error(get_lock_file_path(&lock));
3194 goto out;
3196 strbuf_reset(&copystr);
3199 fclose(config_file);
3200 config_file = NULL;
3201 commit_and_out:
3202 if (commit_lock_file(&lock) < 0)
3203 ret = error_errno(_("could not write config file %s"),
3204 config_filename);
3205 out:
3206 if (config_file)
3207 fclose(config_file);
3208 rollback_lock_file(&lock);
3209 out_no_rollback:
3210 free(filename_buf);
3211 config_store_data_clear(&store);
3212 return ret;
3215 int git_config_rename_section_in_file(const char *config_filename,
3216 const char *old_name, const char *new_name)
3218 return git_config_copy_or_rename_section_in_file(config_filename,
3219 old_name, new_name, 0);
3222 int git_config_rename_section(const char *old_name, const char *new_name)
3224 return git_config_rename_section_in_file(NULL, old_name, new_name);
3227 int git_config_copy_section_in_file(const char *config_filename,
3228 const char *old_name, const char *new_name)
3230 return git_config_copy_or_rename_section_in_file(config_filename,
3231 old_name, new_name, 1);
3234 int git_config_copy_section(const char *old_name, const char *new_name)
3236 return git_config_copy_section_in_file(NULL, old_name, new_name);
3240 * Call this to report error for your variable that should not
3241 * get a boolean value (i.e. "[my] var" means "true").
3243 #undef config_error_nonbool
3244 int config_error_nonbool(const char *var)
3246 return error(_("missing value for '%s'"), var);
3249 int parse_config_key(const char *var,
3250 const char *section,
3251 const char **subsection, int *subsection_len,
3252 const char **key)
3254 const char *dot;
3256 /* Does it start with "section." ? */
3257 if (!skip_prefix(var, section, &var) || *var != '.')
3258 return -1;
3261 * Find the key; we don't know yet if we have a subsection, but we must
3262 * parse backwards from the end, since the subsection may have dots in
3263 * it, too.
3265 dot = strrchr(var, '.');
3266 *key = dot + 1;
3268 /* Did we have a subsection at all? */
3269 if (dot == var) {
3270 if (subsection) {
3271 *subsection = NULL;
3272 *subsection_len = 0;
3275 else {
3276 if (!subsection)
3277 return -1;
3278 *subsection = var + 1;
3279 *subsection_len = dot - *subsection;
3282 return 0;
3285 const char *current_config_origin_type(void)
3287 int type;
3288 if (current_config_kvi)
3289 type = current_config_kvi->origin_type;
3290 else if(cf)
3291 type = cf->origin_type;
3292 else
3293 BUG("current_config_origin_type called outside config callback");
3295 switch (type) {
3296 case CONFIG_ORIGIN_BLOB:
3297 return "blob";
3298 case CONFIG_ORIGIN_FILE:
3299 return "file";
3300 case CONFIG_ORIGIN_STDIN:
3301 return "standard input";
3302 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3303 return "submodule-blob";
3304 case CONFIG_ORIGIN_CMDLINE:
3305 return "command line";
3306 default:
3307 BUG("unknown config origin type");
3311 const char *current_config_name(void)
3313 const char *name;
3314 if (current_config_kvi)
3315 name = current_config_kvi->filename;
3316 else if (cf)
3317 name = cf->name;
3318 else
3319 BUG("current_config_name called outside config callback");
3320 return name ? name : "";
3323 enum config_scope current_config_scope(void)
3325 if (current_config_kvi)
3326 return current_config_kvi->scope;
3327 else
3328 return current_parsing_scope;
3331 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3333 int i;
3335 for (i = 0; i < nr_mapping; i++) {
3336 const char *name = mapping[i];
3338 if (name && !strcasecmp(var, name))
3339 return i;
3341 return -1;