Merge branch 'ja/doc-style-fix'
[git/debian.git] / config.c
blobff521eb27ad243b27c7bd95f3ad7a1b777a4ae00
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "branch.h"
10 #include "config.h"
11 #include "repository.h"
12 #include "lockfile.h"
13 #include "exec-cmd.h"
14 #include "strbuf.h"
15 #include "quote.h"
16 #include "hashmap.h"
17 #include "string-list.h"
18 #include "object-store.h"
19 #include "utf8.h"
20 #include "dir.h"
21 #include "color.h"
23 struct config_source {
24 struct config_source *prev;
25 union {
26 FILE *file;
27 struct config_buf {
28 const char *buf;
29 size_t len;
30 size_t pos;
31 } buf;
32 } u;
33 enum config_origin_type origin_type;
34 const char *name;
35 const char *path;
36 enum config_error_action default_error_action;
37 int linenr;
38 int eof;
39 struct strbuf value;
40 struct strbuf var;
41 unsigned subsection_case_sensitive : 1;
43 int (*do_fgetc)(struct config_source *c);
44 int (*do_ungetc)(int c, struct config_source *conf);
45 long (*do_ftell)(struct config_source *c);
49 * These variables record the "current" config source, which
50 * can be accessed by parsing callbacks.
52 * The "cf" variable will be non-NULL only when we are actually parsing a real
53 * config source (file, blob, cmdline, etc).
55 * The "current_config_kvi" variable will be non-NULL only when we are feeding
56 * cached config from a configset into a callback.
58 * They should generally never be non-NULL at the same time. If they are both
59 * NULL, then we aren't parsing anything (and depending on the function looking
60 * at the variables, it's either a bug for it to be called in the first place,
61 * or it's a function which can be reused for non-config purposes, and should
62 * fall back to some sane behavior).
64 static struct config_source *cf;
65 static struct key_value_info *current_config_kvi;
68 * Similar to the variables above, this gives access to the "scope" of the
69 * current value (repo, global, etc). For cached values, it can be found via
70 * the current_config_kvi as above. During parsing, the current value can be
71 * found in this variable. It's not part of "cf" because it transcends a single
72 * file (i.e., a file included from .git/config is still in "repo" scope).
74 static enum config_scope current_parsing_scope;
76 static int core_compression_seen;
77 static int pack_compression_seen;
78 static int zlib_compression_seen;
80 static int config_file_fgetc(struct config_source *conf)
82 return getc_unlocked(conf->u.file);
85 static int config_file_ungetc(int c, struct config_source *conf)
87 return ungetc(c, conf->u.file);
90 static long config_file_ftell(struct config_source *conf)
92 return ftell(conf->u.file);
96 static int config_buf_fgetc(struct config_source *conf)
98 if (conf->u.buf.pos < conf->u.buf.len)
99 return conf->u.buf.buf[conf->u.buf.pos++];
101 return EOF;
104 static int config_buf_ungetc(int c, struct config_source *conf)
106 if (conf->u.buf.pos > 0) {
107 conf->u.buf.pos--;
108 if (conf->u.buf.buf[conf->u.buf.pos] != c)
109 BUG("config_buf can only ungetc the same character");
110 return c;
113 return EOF;
116 static long config_buf_ftell(struct config_source *conf)
118 return conf->u.buf.pos;
121 #define MAX_INCLUDE_DEPTH 10
122 static const char include_depth_advice[] = N_(
123 "exceeded maximum include depth (%d) while including\n"
124 " %s\n"
125 "from\n"
126 " %s\n"
127 "This might be due to circular includes.");
128 static int handle_path_include(const char *path, struct config_include_data *inc)
130 int ret = 0;
131 struct strbuf buf = STRBUF_INIT;
132 char *expanded;
134 if (!path)
135 return config_error_nonbool("include.path");
137 expanded = expand_user_path(path, 0);
138 if (!expanded)
139 return error(_("could not expand include path '%s'"), path);
140 path = expanded;
143 * Use an absolute path as-is, but interpret relative paths
144 * based on the including config file.
146 if (!is_absolute_path(path)) {
147 char *slash;
149 if (!cf || !cf->path)
150 return error(_("relative config includes must come from files"));
152 slash = find_last_dir_sep(cf->path);
153 if (slash)
154 strbuf_add(&buf, cf->path, slash - cf->path + 1);
155 strbuf_addstr(&buf, path);
156 path = buf.buf;
159 if (!access_or_die(path, R_OK, 0)) {
160 if (++inc->depth > MAX_INCLUDE_DEPTH)
161 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
162 !cf ? "<unknown>" :
163 cf->name ? cf->name :
164 "the command line");
165 ret = git_config_from_file(git_config_include, path, inc);
166 inc->depth--;
168 strbuf_release(&buf);
169 free(expanded);
170 return ret;
173 static int prepare_include_condition_pattern(struct strbuf *pat)
175 struct strbuf path = STRBUF_INIT;
176 char *expanded;
177 int prefix = 0;
179 expanded = expand_user_path(pat->buf, 1);
180 if (expanded) {
181 strbuf_reset(pat);
182 strbuf_addstr(pat, expanded);
183 free(expanded);
186 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
187 const char *slash;
189 if (!cf || !cf->path)
190 return error(_("relative config include "
191 "conditionals must come from files"));
193 strbuf_realpath(&path, cf->path, 1);
194 slash = find_last_dir_sep(path.buf);
195 if (!slash)
196 BUG("how is this possible?");
197 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
198 prefix = slash - path.buf + 1 /* slash */;
199 } else if (!is_absolute_path(pat->buf))
200 strbuf_insert(pat, 0, "**/", 3);
202 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
203 strbuf_addstr(pat, "**");
205 strbuf_release(&path);
206 return prefix;
209 static int include_by_gitdir(const struct config_options *opts,
210 const char *cond, size_t cond_len, int icase)
212 struct strbuf text = STRBUF_INIT;
213 struct strbuf pattern = STRBUF_INIT;
214 int ret = 0, prefix;
215 const char *git_dir;
216 int already_tried_absolute = 0;
218 if (opts->git_dir)
219 git_dir = opts->git_dir;
220 else
221 goto done;
223 strbuf_realpath(&text, git_dir, 1);
224 strbuf_add(&pattern, cond, cond_len);
225 prefix = prepare_include_condition_pattern(&pattern);
227 again:
228 if (prefix < 0)
229 goto done;
231 if (prefix > 0) {
233 * perform literal matching on the prefix part so that
234 * any wildcard character in it can't create side effects.
236 if (text.len < prefix)
237 goto done;
238 if (!icase && strncmp(pattern.buf, text.buf, prefix))
239 goto done;
240 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
241 goto done;
244 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
245 icase ? WM_CASEFOLD : 0);
247 if (!ret && !already_tried_absolute) {
249 * We've tried e.g. matching gitdir:~/work, but if
250 * ~/work is a symlink to /mnt/storage/work
251 * strbuf_realpath() will expand it, so the rule won't
252 * match. Let's match against a
253 * strbuf_add_absolute_path() version of the path,
254 * which'll do the right thing
256 strbuf_reset(&text);
257 strbuf_add_absolute_path(&text, git_dir);
258 already_tried_absolute = 1;
259 goto again;
261 done:
262 strbuf_release(&pattern);
263 strbuf_release(&text);
264 return ret;
267 static int include_condition_is_true(const struct config_options *opts,
268 const char *cond, size_t cond_len)
271 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
272 return include_by_gitdir(opts, cond, cond_len, 0);
273 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
274 return include_by_gitdir(opts, cond, cond_len, 1);
276 /* unknown conditionals are always false */
277 return 0;
280 int git_config_include(const char *var, const char *value, void *data)
282 struct config_include_data *inc = data;
283 const char *cond, *key;
284 int cond_len;
285 int ret;
288 * Pass along all values, including "include" directives; this makes it
289 * possible to query information on the includes themselves.
291 ret = inc->fn(var, value, inc->data);
292 if (ret < 0)
293 return ret;
295 if (!strcmp(var, "include.path"))
296 ret = handle_path_include(value, inc);
298 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
299 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
300 !strcmp(key, "path"))
301 ret = handle_path_include(value, inc);
303 return ret;
306 void git_config_push_parameter(const char *text)
308 struct strbuf env = STRBUF_INIT;
309 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
310 if (old && *old) {
311 strbuf_addstr(&env, old);
312 strbuf_addch(&env, ' ');
314 sq_quote_buf(&env, text);
315 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
316 strbuf_release(&env);
319 static inline int iskeychar(int c)
321 return isalnum(c) || c == '-';
325 * Auxiliary function to sanity-check and split the key into the section
326 * identifier and variable name.
328 * Returns 0 on success, -1 when there is an invalid character in the key and
329 * -2 if there is no section name in the key.
331 * store_key - pointer to char* which will hold a copy of the key with
332 * lowercase section and variable name
333 * baselen - pointer to int which will hold the length of the
334 * section + subsection part, can be NULL
336 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
338 int i, dot, baselen;
339 const char *last_dot = strrchr(key, '.');
342 * Since "key" actually contains the section name and the real
343 * key name separated by a dot, we have to know where the dot is.
346 if (last_dot == NULL || last_dot == key) {
347 if (!quiet)
348 error(_("key does not contain a section: %s"), key);
349 return -CONFIG_NO_SECTION_OR_NAME;
352 if (!last_dot[1]) {
353 if (!quiet)
354 error(_("key does not contain variable name: %s"), key);
355 return -CONFIG_NO_SECTION_OR_NAME;
358 baselen = last_dot - key;
359 if (baselen_)
360 *baselen_ = baselen;
363 * Validate the key and while at it, lower case it for matching.
365 if (store_key)
366 *store_key = xmallocz(strlen(key));
368 dot = 0;
369 for (i = 0; key[i]; i++) {
370 unsigned char c = key[i];
371 if (c == '.')
372 dot = 1;
373 /* Leave the extended basename untouched.. */
374 if (!dot || i > baselen) {
375 if (!iskeychar(c) ||
376 (i == baselen + 1 && !isalpha(c))) {
377 if (!quiet)
378 error(_("invalid key: %s"), key);
379 goto out_free_ret_1;
381 c = tolower(c);
382 } else if (c == '\n') {
383 if (!quiet)
384 error(_("invalid key (newline): %s"), key);
385 goto out_free_ret_1;
387 if (store_key)
388 (*store_key)[i] = c;
391 return 0;
393 out_free_ret_1:
394 if (store_key) {
395 FREE_AND_NULL(*store_key);
397 return -CONFIG_INVALID_KEY;
400 int git_config_parse_key(const char *key, char **store_key, int *baselen)
402 return git_config_parse_key_1(key, store_key, baselen, 0);
405 int git_config_key_is_valid(const char *key)
407 return !git_config_parse_key_1(key, NULL, NULL, 1);
410 int git_config_parse_parameter(const char *text,
411 config_fn_t fn, void *data)
413 const char *value;
414 char *canonical_name;
415 struct strbuf **pair;
416 int ret;
418 pair = strbuf_split_str(text, '=', 2);
419 if (!pair[0])
420 return error(_("bogus config parameter: %s"), text);
422 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
423 strbuf_setlen(pair[0], pair[0]->len - 1);
424 value = pair[1] ? pair[1]->buf : "";
425 } else {
426 value = NULL;
429 strbuf_trim(pair[0]);
430 if (!pair[0]->len) {
431 strbuf_list_free(pair);
432 return error(_("bogus config parameter: %s"), text);
435 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
436 ret = -1;
437 } else {
438 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
439 free(canonical_name);
441 strbuf_list_free(pair);
442 return ret;
445 int git_config_from_parameters(config_fn_t fn, void *data)
447 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
448 int ret = 0;
449 char *envw;
450 const char **argv = NULL;
451 int nr = 0, alloc = 0;
452 int i;
453 struct config_source source;
455 if (!env)
456 return 0;
458 memset(&source, 0, sizeof(source));
459 source.prev = cf;
460 source.origin_type = CONFIG_ORIGIN_CMDLINE;
461 cf = &source;
463 /* sq_dequote will write over it */
464 envw = xstrdup(env);
466 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
467 ret = error(_("bogus format in %s"), CONFIG_DATA_ENVIRONMENT);
468 goto out;
471 for (i = 0; i < nr; i++) {
472 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
473 ret = -1;
474 goto out;
478 out:
479 free(argv);
480 free(envw);
481 cf = source.prev;
482 return ret;
485 static int get_next_char(void)
487 int c = cf->do_fgetc(cf);
489 if (c == '\r') {
490 /* DOS like systems */
491 c = cf->do_fgetc(cf);
492 if (c != '\n') {
493 if (c != EOF)
494 cf->do_ungetc(c, cf);
495 c = '\r';
498 if (c == '\n')
499 cf->linenr++;
500 if (c == EOF) {
501 cf->eof = 1;
502 cf->linenr++;
503 c = '\n';
505 return c;
508 static char *parse_value(void)
510 int quote = 0, comment = 0, space = 0;
512 strbuf_reset(&cf->value);
513 for (;;) {
514 int c = get_next_char();
515 if (c == '\n') {
516 if (quote) {
517 cf->linenr--;
518 return NULL;
520 return cf->value.buf;
522 if (comment)
523 continue;
524 if (isspace(c) && !quote) {
525 if (cf->value.len)
526 space++;
527 continue;
529 if (!quote) {
530 if (c == ';' || c == '#') {
531 comment = 1;
532 continue;
535 for (; space; space--)
536 strbuf_addch(&cf->value, ' ');
537 if (c == '\\') {
538 c = get_next_char();
539 switch (c) {
540 case '\n':
541 continue;
542 case 't':
543 c = '\t';
544 break;
545 case 'b':
546 c = '\b';
547 break;
548 case 'n':
549 c = '\n';
550 break;
551 /* Some characters escape as themselves */
552 case '\\': case '"':
553 break;
554 /* Reject unknown escape sequences */
555 default:
556 return NULL;
558 strbuf_addch(&cf->value, c);
559 continue;
561 if (c == '"') {
562 quote = 1-quote;
563 continue;
565 strbuf_addch(&cf->value, c);
569 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
571 int c;
572 char *value;
573 int ret;
575 /* Get the full name */
576 for (;;) {
577 c = get_next_char();
578 if (cf->eof)
579 break;
580 if (!iskeychar(c))
581 break;
582 strbuf_addch(name, tolower(c));
585 while (c == ' ' || c == '\t')
586 c = get_next_char();
588 value = NULL;
589 if (c != '\n') {
590 if (c != '=')
591 return -1;
592 value = parse_value();
593 if (!value)
594 return -1;
597 * We already consumed the \n, but we need linenr to point to
598 * the line we just parsed during the call to fn to get
599 * accurate line number in error messages.
601 cf->linenr--;
602 ret = fn(name->buf, value, data);
603 if (ret >= 0)
604 cf->linenr++;
605 return ret;
608 static int get_extended_base_var(struct strbuf *name, int c)
610 cf->subsection_case_sensitive = 0;
611 do {
612 if (c == '\n')
613 goto error_incomplete_line;
614 c = get_next_char();
615 } while (isspace(c));
617 /* We require the format to be '[base "extension"]' */
618 if (c != '"')
619 return -1;
620 strbuf_addch(name, '.');
622 for (;;) {
623 int c = get_next_char();
624 if (c == '\n')
625 goto error_incomplete_line;
626 if (c == '"')
627 break;
628 if (c == '\\') {
629 c = get_next_char();
630 if (c == '\n')
631 goto error_incomplete_line;
633 strbuf_addch(name, c);
636 /* Final ']' */
637 if (get_next_char() != ']')
638 return -1;
639 return 0;
640 error_incomplete_line:
641 cf->linenr--;
642 return -1;
645 static int get_base_var(struct strbuf *name)
647 cf->subsection_case_sensitive = 1;
648 for (;;) {
649 int c = get_next_char();
650 if (cf->eof)
651 return -1;
652 if (c == ']')
653 return 0;
654 if (isspace(c))
655 return get_extended_base_var(name, c);
656 if (!iskeychar(c) && c != '.')
657 return -1;
658 strbuf_addch(name, tolower(c));
662 struct parse_event_data {
663 enum config_event_t previous_type;
664 size_t previous_offset;
665 const struct config_options *opts;
668 static int do_event(enum config_event_t type, struct parse_event_data *data)
670 size_t offset;
672 if (!data->opts || !data->opts->event_fn)
673 return 0;
675 if (type == CONFIG_EVENT_WHITESPACE &&
676 data->previous_type == type)
677 return 0;
679 offset = cf->do_ftell(cf);
681 * At EOF, the parser always "inserts" an extra '\n', therefore
682 * the end offset of the event is the current file position, otherwise
683 * we will already have advanced to the next event.
685 if (type != CONFIG_EVENT_EOF)
686 offset--;
688 if (data->previous_type != CONFIG_EVENT_EOF &&
689 data->opts->event_fn(data->previous_type, data->previous_offset,
690 offset, data->opts->event_fn_data) < 0)
691 return -1;
693 data->previous_type = type;
694 data->previous_offset = offset;
696 return 0;
699 static int git_parse_source(config_fn_t fn, void *data,
700 const struct config_options *opts)
702 int comment = 0;
703 int baselen = 0;
704 struct strbuf *var = &cf->var;
705 int error_return = 0;
706 char *error_msg = NULL;
708 /* U+FEFF Byte Order Mark in UTF8 */
709 const char *bomptr = utf8_bom;
711 /* For the parser event callback */
712 struct parse_event_data event_data = {
713 CONFIG_EVENT_EOF, 0, opts
716 for (;;) {
717 int c;
719 c = get_next_char();
720 if (bomptr && *bomptr) {
721 /* We are at the file beginning; skip UTF8-encoded BOM
722 * if present. Sane editors won't put this in on their
723 * own, but e.g. Windows Notepad will do it happily. */
724 if (c == (*bomptr & 0377)) {
725 bomptr++;
726 continue;
727 } else {
728 /* Do not tolerate partial BOM. */
729 if (bomptr != utf8_bom)
730 break;
731 /* No BOM at file beginning. Cool. */
732 bomptr = NULL;
735 if (c == '\n') {
736 if (cf->eof) {
737 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
738 return -1;
739 return 0;
741 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
742 return -1;
743 comment = 0;
744 continue;
746 if (comment)
747 continue;
748 if (isspace(c)) {
749 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
750 return -1;
751 continue;
753 if (c == '#' || c == ';') {
754 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
755 return -1;
756 comment = 1;
757 continue;
759 if (c == '[') {
760 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
761 return -1;
763 /* Reset prior to determining a new stem */
764 strbuf_reset(var);
765 if (get_base_var(var) < 0 || var->len < 1)
766 break;
767 strbuf_addch(var, '.');
768 baselen = var->len;
769 continue;
771 if (!isalpha(c))
772 break;
774 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
775 return -1;
778 * Truncate the var name back to the section header
779 * stem prior to grabbing the suffix part of the name
780 * and the value.
782 strbuf_setlen(var, baselen);
783 strbuf_addch(var, tolower(c));
784 if (get_value(fn, data, var) < 0)
785 break;
788 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
789 return -1;
791 switch (cf->origin_type) {
792 case CONFIG_ORIGIN_BLOB:
793 error_msg = xstrfmt(_("bad config line %d in blob %s"),
794 cf->linenr, cf->name);
795 break;
796 case CONFIG_ORIGIN_FILE:
797 error_msg = xstrfmt(_("bad config line %d in file %s"),
798 cf->linenr, cf->name);
799 break;
800 case CONFIG_ORIGIN_STDIN:
801 error_msg = xstrfmt(_("bad config line %d in standard input"),
802 cf->linenr);
803 break;
804 case CONFIG_ORIGIN_SUBMODULE_BLOB:
805 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
806 cf->linenr, cf->name);
807 break;
808 case CONFIG_ORIGIN_CMDLINE:
809 error_msg = xstrfmt(_("bad config line %d in command line %s"),
810 cf->linenr, cf->name);
811 break;
812 default:
813 error_msg = xstrfmt(_("bad config line %d in %s"),
814 cf->linenr, cf->name);
817 switch (opts && opts->error_action ?
818 opts->error_action :
819 cf->default_error_action) {
820 case CONFIG_ERROR_DIE:
821 die("%s", error_msg);
822 break;
823 case CONFIG_ERROR_ERROR:
824 error_return = error("%s", error_msg);
825 break;
826 case CONFIG_ERROR_SILENT:
827 error_return = -1;
828 break;
829 case CONFIG_ERROR_UNSET:
830 BUG("config error action unset");
833 free(error_msg);
834 return error_return;
837 static int parse_unit_factor(const char *end, uintmax_t *val)
839 if (!*end)
840 return 1;
841 else if (!strcasecmp(end, "k")) {
842 *val *= 1024;
843 return 1;
845 else if (!strcasecmp(end, "m")) {
846 *val *= 1024 * 1024;
847 return 1;
849 else if (!strcasecmp(end, "g")) {
850 *val *= 1024 * 1024 * 1024;
851 return 1;
853 return 0;
856 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
858 if (value && *value) {
859 char *end;
860 intmax_t val;
861 uintmax_t uval;
862 uintmax_t factor = 1;
864 errno = 0;
865 val = strtoimax(value, &end, 0);
866 if (errno == ERANGE)
867 return 0;
868 if (!parse_unit_factor(end, &factor)) {
869 errno = EINVAL;
870 return 0;
872 uval = labs(val);
873 uval *= factor;
874 if (uval > max || labs(val) > uval) {
875 errno = ERANGE;
876 return 0;
878 val *= factor;
879 *ret = val;
880 return 1;
882 errno = EINVAL;
883 return 0;
886 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
888 if (value && *value) {
889 char *end;
890 uintmax_t val;
891 uintmax_t oldval;
893 errno = 0;
894 val = strtoumax(value, &end, 0);
895 if (errno == ERANGE)
896 return 0;
897 oldval = val;
898 if (!parse_unit_factor(end, &val)) {
899 errno = EINVAL;
900 return 0;
902 if (val > max || oldval > val) {
903 errno = ERANGE;
904 return 0;
906 *ret = val;
907 return 1;
909 errno = EINVAL;
910 return 0;
913 static int git_parse_int(const char *value, int *ret)
915 intmax_t tmp;
916 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
917 return 0;
918 *ret = tmp;
919 return 1;
922 static int git_parse_int64(const char *value, int64_t *ret)
924 intmax_t tmp;
925 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
926 return 0;
927 *ret = tmp;
928 return 1;
931 int git_parse_ulong(const char *value, unsigned long *ret)
933 uintmax_t tmp;
934 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
935 return 0;
936 *ret = tmp;
937 return 1;
940 int git_parse_ssize_t(const char *value, ssize_t *ret)
942 intmax_t tmp;
943 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
944 return 0;
945 *ret = tmp;
946 return 1;
949 NORETURN
950 static void die_bad_number(const char *name, const char *value)
952 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
954 if (!value)
955 value = "";
957 if (!(cf && cf->name))
958 die(_("bad numeric config value '%s' for '%s': %s"),
959 value, name, error_type);
961 switch (cf->origin_type) {
962 case CONFIG_ORIGIN_BLOB:
963 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
964 value, name, cf->name, error_type);
965 case CONFIG_ORIGIN_FILE:
966 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
967 value, name, cf->name, error_type);
968 case CONFIG_ORIGIN_STDIN:
969 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
970 value, name, error_type);
971 case CONFIG_ORIGIN_SUBMODULE_BLOB:
972 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
973 value, name, cf->name, error_type);
974 case CONFIG_ORIGIN_CMDLINE:
975 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
976 value, name, cf->name, error_type);
977 default:
978 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
979 value, name, cf->name, error_type);
983 int git_config_int(const char *name, const char *value)
985 int ret;
986 if (!git_parse_int(value, &ret))
987 die_bad_number(name, value);
988 return ret;
991 int64_t git_config_int64(const char *name, const char *value)
993 int64_t ret;
994 if (!git_parse_int64(value, &ret))
995 die_bad_number(name, value);
996 return ret;
999 unsigned long git_config_ulong(const char *name, const char *value)
1001 unsigned long ret;
1002 if (!git_parse_ulong(value, &ret))
1003 die_bad_number(name, value);
1004 return ret;
1007 ssize_t git_config_ssize_t(const char *name, const char *value)
1009 ssize_t ret;
1010 if (!git_parse_ssize_t(value, &ret))
1011 die_bad_number(name, value);
1012 return ret;
1015 static int git_parse_maybe_bool_text(const char *value)
1017 if (!value)
1018 return 1;
1019 if (!*value)
1020 return 0;
1021 if (!strcasecmp(value, "true")
1022 || !strcasecmp(value, "yes")
1023 || !strcasecmp(value, "on"))
1024 return 1;
1025 if (!strcasecmp(value, "false")
1026 || !strcasecmp(value, "no")
1027 || !strcasecmp(value, "off"))
1028 return 0;
1029 return -1;
1032 int git_parse_maybe_bool(const char *value)
1034 int v = git_parse_maybe_bool_text(value);
1035 if (0 <= v)
1036 return v;
1037 if (git_parse_int(value, &v))
1038 return !!v;
1039 return -1;
1042 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1044 int v = git_parse_maybe_bool_text(value);
1045 if (0 <= v) {
1046 *is_bool = 1;
1047 return v;
1049 *is_bool = 0;
1050 return git_config_int(name, value);
1053 int git_config_bool(const char *name, const char *value)
1055 int discard;
1056 return !!git_config_bool_or_int(name, value, &discard);
1059 int git_config_string(const char **dest, const char *var, const char *value)
1061 if (!value)
1062 return config_error_nonbool(var);
1063 *dest = xstrdup(value);
1064 return 0;
1067 int git_config_pathname(const char **dest, const char *var, const char *value)
1069 if (!value)
1070 return config_error_nonbool(var);
1071 *dest = expand_user_path(value, 0);
1072 if (!*dest)
1073 die(_("failed to expand user dir in: '%s'"), value);
1074 return 0;
1077 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1079 if (!value)
1080 return config_error_nonbool(var);
1081 if (parse_expiry_date(value, timestamp))
1082 return error(_("'%s' for '%s' is not a valid timestamp"),
1083 value, var);
1084 return 0;
1087 int git_config_color(char *dest, const char *var, const char *value)
1089 if (!value)
1090 return config_error_nonbool(var);
1091 if (color_parse(value, dest) < 0)
1092 return -1;
1093 return 0;
1096 static int git_default_core_config(const char *var, const char *value, void *cb)
1098 /* This needs a better name */
1099 if (!strcmp(var, "core.filemode")) {
1100 trust_executable_bit = git_config_bool(var, value);
1101 return 0;
1103 if (!strcmp(var, "core.trustctime")) {
1104 trust_ctime = git_config_bool(var, value);
1105 return 0;
1107 if (!strcmp(var, "core.checkstat")) {
1108 if (!strcasecmp(value, "default"))
1109 check_stat = 1;
1110 else if (!strcasecmp(value, "minimal"))
1111 check_stat = 0;
1114 if (!strcmp(var, "core.quotepath")) {
1115 quote_path_fully = git_config_bool(var, value);
1116 return 0;
1119 if (!strcmp(var, "core.symlinks")) {
1120 has_symlinks = git_config_bool(var, value);
1121 return 0;
1124 if (!strcmp(var, "core.ignorecase")) {
1125 ignore_case = git_config_bool(var, value);
1126 return 0;
1129 if (!strcmp(var, "core.attributesfile"))
1130 return git_config_pathname(&git_attributes_file, var, value);
1132 if (!strcmp(var, "core.hookspath"))
1133 return git_config_pathname(&git_hooks_path, var, value);
1135 if (!strcmp(var, "core.bare")) {
1136 is_bare_repository_cfg = git_config_bool(var, value);
1137 return 0;
1140 if (!strcmp(var, "core.ignorestat")) {
1141 assume_unchanged = git_config_bool(var, value);
1142 return 0;
1145 if (!strcmp(var, "core.prefersymlinkrefs")) {
1146 prefer_symlink_refs = git_config_bool(var, value);
1147 return 0;
1150 if (!strcmp(var, "core.logallrefupdates")) {
1151 if (value && !strcasecmp(value, "always"))
1152 log_all_ref_updates = LOG_REFS_ALWAYS;
1153 else if (git_config_bool(var, value))
1154 log_all_ref_updates = LOG_REFS_NORMAL;
1155 else
1156 log_all_ref_updates = LOG_REFS_NONE;
1157 return 0;
1160 if (!strcmp(var, "core.warnambiguousrefs")) {
1161 warn_ambiguous_refs = git_config_bool(var, value);
1162 return 0;
1165 if (!strcmp(var, "core.abbrev")) {
1166 if (!value)
1167 return config_error_nonbool(var);
1168 if (!strcasecmp(value, "auto"))
1169 default_abbrev = -1;
1170 else {
1171 int abbrev = git_config_int(var, value);
1172 if (abbrev < minimum_abbrev || abbrev > 40)
1173 return error(_("abbrev length out of range: %d"), abbrev);
1174 default_abbrev = abbrev;
1176 return 0;
1179 if (!strcmp(var, "core.disambiguate"))
1180 return set_disambiguate_hint_config(var, value);
1182 if (!strcmp(var, "core.loosecompression")) {
1183 int level = git_config_int(var, value);
1184 if (level == -1)
1185 level = Z_DEFAULT_COMPRESSION;
1186 else if (level < 0 || level > Z_BEST_COMPRESSION)
1187 die(_("bad zlib compression level %d"), level);
1188 zlib_compression_level = level;
1189 zlib_compression_seen = 1;
1190 return 0;
1193 if (!strcmp(var, "core.compression")) {
1194 int level = git_config_int(var, value);
1195 if (level == -1)
1196 level = Z_DEFAULT_COMPRESSION;
1197 else if (level < 0 || level > Z_BEST_COMPRESSION)
1198 die(_("bad zlib compression level %d"), level);
1199 core_compression_level = level;
1200 core_compression_seen = 1;
1201 if (!zlib_compression_seen)
1202 zlib_compression_level = level;
1203 if (!pack_compression_seen)
1204 pack_compression_level = level;
1205 return 0;
1208 if (!strcmp(var, "core.packedgitwindowsize")) {
1209 int pgsz_x2 = getpagesize() * 2;
1210 packed_git_window_size = git_config_ulong(var, value);
1212 /* This value must be multiple of (pagesize * 2) */
1213 packed_git_window_size /= pgsz_x2;
1214 if (packed_git_window_size < 1)
1215 packed_git_window_size = 1;
1216 packed_git_window_size *= pgsz_x2;
1217 return 0;
1220 if (!strcmp(var, "core.bigfilethreshold")) {
1221 big_file_threshold = git_config_ulong(var, value);
1222 return 0;
1225 if (!strcmp(var, "core.packedgitlimit")) {
1226 packed_git_limit = git_config_ulong(var, value);
1227 return 0;
1230 if (!strcmp(var, "core.deltabasecachelimit")) {
1231 delta_base_cache_limit = git_config_ulong(var, value);
1232 return 0;
1235 if (!strcmp(var, "core.autocrlf")) {
1236 if (value && !strcasecmp(value, "input")) {
1237 auto_crlf = AUTO_CRLF_INPUT;
1238 return 0;
1240 auto_crlf = git_config_bool(var, value);
1241 return 0;
1244 if (!strcmp(var, "core.safecrlf")) {
1245 int eol_rndtrp_die;
1246 if (value && !strcasecmp(value, "warn")) {
1247 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1248 return 0;
1250 eol_rndtrp_die = git_config_bool(var, value);
1251 global_conv_flags_eol = eol_rndtrp_die ?
1252 CONV_EOL_RNDTRP_DIE : 0;
1253 return 0;
1256 if (!strcmp(var, "core.eol")) {
1257 if (value && !strcasecmp(value, "lf"))
1258 core_eol = EOL_LF;
1259 else if (value && !strcasecmp(value, "crlf"))
1260 core_eol = EOL_CRLF;
1261 else if (value && !strcasecmp(value, "native"))
1262 core_eol = EOL_NATIVE;
1263 else
1264 core_eol = EOL_UNSET;
1265 return 0;
1268 if (!strcmp(var, "core.checkroundtripencoding")) {
1269 check_roundtrip_encoding = xstrdup(value);
1270 return 0;
1273 if (!strcmp(var, "core.notesref")) {
1274 notes_ref_name = xstrdup(value);
1275 return 0;
1278 if (!strcmp(var, "core.editor"))
1279 return git_config_string(&editor_program, var, value);
1281 if (!strcmp(var, "core.commentchar")) {
1282 if (!value)
1283 return config_error_nonbool(var);
1284 else if (!strcasecmp(value, "auto"))
1285 auto_comment_line_char = 1;
1286 else if (value[0] && !value[1]) {
1287 comment_line_char = value[0];
1288 auto_comment_line_char = 0;
1289 } else
1290 return error(_("core.commentChar should only be one character"));
1291 return 0;
1294 if (!strcmp(var, "core.askpass"))
1295 return git_config_string(&askpass_program, var, value);
1297 if (!strcmp(var, "core.excludesfile"))
1298 return git_config_pathname(&excludes_file, var, value);
1300 if (!strcmp(var, "core.whitespace")) {
1301 if (!value)
1302 return config_error_nonbool(var);
1303 whitespace_rule_cfg = parse_whitespace_rule(value);
1304 return 0;
1307 if (!strcmp(var, "core.fsyncobjectfiles")) {
1308 fsync_object_files = git_config_bool(var, value);
1309 return 0;
1312 if (!strcmp(var, "core.preloadindex")) {
1313 core_preload_index = git_config_bool(var, value);
1314 return 0;
1317 if (!strcmp(var, "core.createobject")) {
1318 if (!strcmp(value, "rename"))
1319 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1320 else if (!strcmp(value, "link"))
1321 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1322 else
1323 die(_("invalid mode for object creation: %s"), value);
1324 return 0;
1327 if (!strcmp(var, "core.sparsecheckout")) {
1328 core_apply_sparse_checkout = git_config_bool(var, value);
1329 return 0;
1332 if (!strcmp(var, "core.precomposeunicode")) {
1333 precomposed_unicode = git_config_bool(var, value);
1334 return 0;
1337 if (!strcmp(var, "core.protecthfs")) {
1338 protect_hfs = git_config_bool(var, value);
1339 return 0;
1342 if (!strcmp(var, "core.protectntfs")) {
1343 protect_ntfs = git_config_bool(var, value);
1344 return 0;
1347 if (!strcmp(var, "core.partialclonefilter")) {
1348 return git_config_string(&core_partial_clone_filter_default,
1349 var, value);
1352 if (!strcmp(var, "core.usereplacerefs")) {
1353 read_replace_refs = git_config_bool(var, value);
1354 return 0;
1357 /* Add other config variables here and to Documentation/config.txt. */
1358 return platform_core_config(var, value, cb);
1361 static int git_default_i18n_config(const char *var, const char *value)
1363 if (!strcmp(var, "i18n.commitencoding"))
1364 return git_config_string(&git_commit_encoding, var, value);
1366 if (!strcmp(var, "i18n.logoutputencoding"))
1367 return git_config_string(&git_log_output_encoding, var, value);
1369 /* Add other config variables here and to Documentation/config.txt. */
1370 return 0;
1373 static int git_default_branch_config(const char *var, const char *value)
1375 if (!strcmp(var, "branch.autosetupmerge")) {
1376 if (value && !strcasecmp(value, "always")) {
1377 git_branch_track = BRANCH_TRACK_ALWAYS;
1378 return 0;
1380 git_branch_track = git_config_bool(var, value);
1381 return 0;
1383 if (!strcmp(var, "branch.autosetuprebase")) {
1384 if (!value)
1385 return config_error_nonbool(var);
1386 else if (!strcmp(value, "never"))
1387 autorebase = AUTOREBASE_NEVER;
1388 else if (!strcmp(value, "local"))
1389 autorebase = AUTOREBASE_LOCAL;
1390 else if (!strcmp(value, "remote"))
1391 autorebase = AUTOREBASE_REMOTE;
1392 else if (!strcmp(value, "always"))
1393 autorebase = AUTOREBASE_ALWAYS;
1394 else
1395 return error(_("malformed value for %s"), var);
1396 return 0;
1399 /* Add other config variables here and to Documentation/config.txt. */
1400 return 0;
1403 static int git_default_push_config(const char *var, const char *value)
1405 if (!strcmp(var, "push.default")) {
1406 if (!value)
1407 return config_error_nonbool(var);
1408 else if (!strcmp(value, "nothing"))
1409 push_default = PUSH_DEFAULT_NOTHING;
1410 else if (!strcmp(value, "matching"))
1411 push_default = PUSH_DEFAULT_MATCHING;
1412 else if (!strcmp(value, "simple"))
1413 push_default = PUSH_DEFAULT_SIMPLE;
1414 else if (!strcmp(value, "upstream"))
1415 push_default = PUSH_DEFAULT_UPSTREAM;
1416 else if (!strcmp(value, "tracking")) /* deprecated */
1417 push_default = PUSH_DEFAULT_UPSTREAM;
1418 else if (!strcmp(value, "current"))
1419 push_default = PUSH_DEFAULT_CURRENT;
1420 else {
1421 error(_("malformed value for %s: %s"), var, value);
1422 return error(_("must be one of nothing, matching, simple, "
1423 "upstream or current"));
1425 return 0;
1428 /* Add other config variables here and to Documentation/config.txt. */
1429 return 0;
1432 static int git_default_mailmap_config(const char *var, const char *value)
1434 if (!strcmp(var, "mailmap.file"))
1435 return git_config_pathname(&git_mailmap_file, var, value);
1436 if (!strcmp(var, "mailmap.blob"))
1437 return git_config_string(&git_mailmap_blob, var, value);
1439 /* Add other config variables here and to Documentation/config.txt. */
1440 return 0;
1443 int git_default_config(const char *var, const char *value, void *cb)
1445 if (starts_with(var, "core."))
1446 return git_default_core_config(var, value, cb);
1448 if (starts_with(var, "user."))
1449 return git_ident_config(var, value, cb);
1451 if (starts_with(var, "i18n."))
1452 return git_default_i18n_config(var, value);
1454 if (starts_with(var, "branch."))
1455 return git_default_branch_config(var, value);
1457 if (starts_with(var, "push."))
1458 return git_default_push_config(var, value);
1460 if (starts_with(var, "mailmap."))
1461 return git_default_mailmap_config(var, value);
1463 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1464 return git_default_advice_config(var, value);
1466 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1467 pager_use_color = git_config_bool(var,value);
1468 return 0;
1471 if (!strcmp(var, "pack.packsizelimit")) {
1472 pack_size_limit_cfg = git_config_ulong(var, value);
1473 return 0;
1476 if (!strcmp(var, "pack.compression")) {
1477 int level = git_config_int(var, value);
1478 if (level == -1)
1479 level = Z_DEFAULT_COMPRESSION;
1480 else if (level < 0 || level > Z_BEST_COMPRESSION)
1481 die(_("bad pack compression level %d"), level);
1482 pack_compression_level = level;
1483 pack_compression_seen = 1;
1484 return 0;
1487 /* Add other config variables here and to Documentation/config.txt. */
1488 return 0;
1492 * All source specific fields in the union, die_on_error, name and the callbacks
1493 * fgetc, ungetc, ftell of top need to be initialized before calling
1494 * this function.
1496 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1497 const struct config_options *opts)
1499 int ret;
1501 /* push config-file parsing state stack */
1502 top->prev = cf;
1503 top->linenr = 1;
1504 top->eof = 0;
1505 strbuf_init(&top->value, 1024);
1506 strbuf_init(&top->var, 1024);
1507 cf = top;
1509 ret = git_parse_source(fn, data, opts);
1511 /* pop config-file parsing state stack */
1512 strbuf_release(&top->value);
1513 strbuf_release(&top->var);
1514 cf = top->prev;
1516 return ret;
1519 static int do_config_from_file(config_fn_t fn,
1520 const enum config_origin_type origin_type,
1521 const char *name, const char *path, FILE *f,
1522 void *data, const struct config_options *opts)
1524 struct config_source top;
1525 int ret;
1527 top.u.file = f;
1528 top.origin_type = origin_type;
1529 top.name = name;
1530 top.path = path;
1531 top.default_error_action = CONFIG_ERROR_DIE;
1532 top.do_fgetc = config_file_fgetc;
1533 top.do_ungetc = config_file_ungetc;
1534 top.do_ftell = config_file_ftell;
1536 flockfile(f);
1537 ret = do_config_from(&top, fn, data, opts);
1538 funlockfile(f);
1539 return ret;
1542 static int git_config_from_stdin(config_fn_t fn, void *data)
1544 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1545 data, NULL);
1548 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1549 void *data,
1550 const struct config_options *opts)
1552 int ret = -1;
1553 FILE *f;
1555 f = fopen_or_warn(filename, "r");
1556 if (f) {
1557 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1558 filename, f, data, opts);
1559 fclose(f);
1561 return ret;
1564 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1566 return git_config_from_file_with_options(fn, filename, data, NULL);
1569 int git_config_from_mem(config_fn_t fn,
1570 const enum config_origin_type origin_type,
1571 const char *name, const char *buf, size_t len,
1572 void *data, const struct config_options *opts)
1574 struct config_source top;
1576 top.u.buf.buf = buf;
1577 top.u.buf.len = len;
1578 top.u.buf.pos = 0;
1579 top.origin_type = origin_type;
1580 top.name = name;
1581 top.path = NULL;
1582 top.default_error_action = CONFIG_ERROR_ERROR;
1583 top.do_fgetc = config_buf_fgetc;
1584 top.do_ungetc = config_buf_ungetc;
1585 top.do_ftell = config_buf_ftell;
1587 return do_config_from(&top, fn, data, opts);
1590 int git_config_from_blob_oid(config_fn_t fn,
1591 const char *name,
1592 const struct object_id *oid,
1593 void *data)
1595 enum object_type type;
1596 char *buf;
1597 unsigned long size;
1598 int ret;
1600 buf = read_object_file(oid, &type, &size);
1601 if (!buf)
1602 return error(_("unable to load config blob object '%s'"), name);
1603 if (type != OBJ_BLOB) {
1604 free(buf);
1605 return error(_("reference '%s' does not point to a blob"), name);
1608 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1609 data, NULL);
1610 free(buf);
1612 return ret;
1615 static int git_config_from_blob_ref(config_fn_t fn,
1616 const char *name,
1617 void *data)
1619 struct object_id oid;
1621 if (get_oid(name, &oid) < 0)
1622 return error(_("unable to resolve config blob '%s'"), name);
1623 return git_config_from_blob_oid(fn, name, &oid, data);
1626 const char *git_etc_gitconfig(void)
1628 static const char *system_wide;
1629 if (!system_wide)
1630 system_wide = system_path(ETC_GITCONFIG);
1631 return system_wide;
1635 * Parse environment variable 'k' as a boolean (in various
1636 * possible spellings); if missing, use the default value 'def'.
1638 int git_env_bool(const char *k, int def)
1640 const char *v = getenv(k);
1641 return v ? git_config_bool(k, v) : def;
1645 * Parse environment variable 'k' as ulong with possibly a unit
1646 * suffix; if missing, use the default value 'val'.
1648 unsigned long git_env_ulong(const char *k, unsigned long val)
1650 const char *v = getenv(k);
1651 if (v && !git_parse_ulong(v, &val))
1652 die(_("failed to parse %s"), k);
1653 return val;
1656 int git_config_system(void)
1658 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1661 static int do_git_config_sequence(const struct config_options *opts,
1662 config_fn_t fn, void *data)
1664 int ret = 0;
1665 char *xdg_config = xdg_config_home("config");
1666 char *user_config = expand_user_path("~/.gitconfig", 0);
1667 char *repo_config;
1669 if (opts->commondir)
1670 repo_config = mkpathdup("%s/config", opts->commondir);
1671 else if (opts->git_dir)
1672 BUG("git_dir without commondir");
1673 else
1674 repo_config = NULL;
1676 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1677 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1678 ret += git_config_from_file(fn, git_etc_gitconfig(),
1679 data);
1681 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1682 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1683 ret += git_config_from_file(fn, xdg_config, data);
1685 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1686 ret += git_config_from_file(fn, user_config, data);
1688 current_parsing_scope = CONFIG_SCOPE_REPO;
1689 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1690 ret += git_config_from_file(fn, repo_config, data);
1693 * Note: this should have a new scope, CONFIG_SCOPE_WORKTREE.
1694 * But let's not complicate things before it's actually needed.
1696 if (repository_format_worktree_config) {
1697 char *path = git_pathdup("config.worktree");
1698 if (!access_or_die(path, R_OK, 0))
1699 ret += git_config_from_file(fn, path, data);
1700 free(path);
1703 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1704 if (git_config_from_parameters(fn, data) < 0)
1705 die(_("unable to parse command-line config"));
1707 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1708 free(xdg_config);
1709 free(user_config);
1710 free(repo_config);
1711 return ret;
1714 int config_with_options(config_fn_t fn, void *data,
1715 struct git_config_source *config_source,
1716 const struct config_options *opts)
1718 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1720 if (opts->respect_includes) {
1721 inc.fn = fn;
1722 inc.data = data;
1723 inc.opts = opts;
1724 fn = git_config_include;
1725 data = &inc;
1729 * If we have a specific filename, use it. Otherwise, follow the
1730 * regular lookup sequence.
1732 if (config_source && config_source->use_stdin)
1733 return git_config_from_stdin(fn, data);
1734 else if (config_source && config_source->file)
1735 return git_config_from_file(fn, config_source->file, data);
1736 else if (config_source && config_source->blob)
1737 return git_config_from_blob_ref(fn, config_source->blob, data);
1739 return do_git_config_sequence(opts, fn, data);
1742 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1744 int i, value_index;
1745 struct string_list *values;
1746 struct config_set_element *entry;
1747 struct configset_list *list = &cs->list;
1749 for (i = 0; i < list->nr; i++) {
1750 entry = list->items[i].e;
1751 value_index = list->items[i].value_index;
1752 values = &entry->value_list;
1754 current_config_kvi = values->items[value_index].util;
1756 if (fn(entry->key, values->items[value_index].string, data) < 0)
1757 git_die_config_linenr(entry->key,
1758 current_config_kvi->filename,
1759 current_config_kvi->linenr);
1761 current_config_kvi = NULL;
1765 void read_early_config(config_fn_t cb, void *data)
1767 struct config_options opts = {0};
1768 struct strbuf commondir = STRBUF_INIT;
1769 struct strbuf gitdir = STRBUF_INIT;
1771 opts.respect_includes = 1;
1773 if (have_git_dir()) {
1774 opts.commondir = get_git_common_dir();
1775 opts.git_dir = get_git_dir();
1777 * When setup_git_directory() was not yet asked to discover the
1778 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1779 * is any repository config we should use (but unlike
1780 * setup_git_directory_gently(), no global state is changed, most
1781 * notably, the current working directory is still the same after the
1782 * call).
1784 } else if (!discover_git_directory(&commondir, &gitdir)) {
1785 opts.commondir = commondir.buf;
1786 opts.git_dir = gitdir.buf;
1789 config_with_options(cb, data, NULL, &opts);
1791 strbuf_release(&commondir);
1792 strbuf_release(&gitdir);
1795 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1797 struct config_set_element k;
1798 struct config_set_element *found_entry;
1799 char *normalized_key;
1801 * `key` may come from the user, so normalize it before using it
1802 * for querying entries from the hashmap.
1804 if (git_config_parse_key(key, &normalized_key, NULL))
1805 return NULL;
1807 hashmap_entry_init(&k, strhash(normalized_key));
1808 k.key = normalized_key;
1809 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1810 free(normalized_key);
1811 return found_entry;
1814 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1816 struct config_set_element *e;
1817 struct string_list_item *si;
1818 struct configset_list_item *l_item;
1819 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1821 e = configset_find_element(cs, key);
1823 * Since the keys are being fed by git_config*() callback mechanism, they
1824 * are already normalized. So simply add them without any further munging.
1826 if (!e) {
1827 e = xmalloc(sizeof(*e));
1828 hashmap_entry_init(e, strhash(key));
1829 e->key = xstrdup(key);
1830 string_list_init(&e->value_list, 1);
1831 hashmap_add(&cs->config_hash, e);
1833 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1835 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1836 l_item = &cs->list.items[cs->list.nr++];
1837 l_item->e = e;
1838 l_item->value_index = e->value_list.nr - 1;
1840 if (!cf)
1841 BUG("configset_add_value has no source");
1842 if (cf->name) {
1843 kv_info->filename = strintern(cf->name);
1844 kv_info->linenr = cf->linenr;
1845 kv_info->origin_type = cf->origin_type;
1846 } else {
1847 /* for values read from `git_config_from_parameters()` */
1848 kv_info->filename = NULL;
1849 kv_info->linenr = -1;
1850 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1852 kv_info->scope = current_parsing_scope;
1853 si->util = kv_info;
1855 return 0;
1858 static int config_set_element_cmp(const void *unused_cmp_data,
1859 const void *entry,
1860 const void *entry_or_key,
1861 const void *unused_keydata)
1863 const struct config_set_element *e1 = entry;
1864 const struct config_set_element *e2 = entry_or_key;
1866 return strcmp(e1->key, e2->key);
1869 void git_configset_init(struct config_set *cs)
1871 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1872 cs->hash_initialized = 1;
1873 cs->list.nr = 0;
1874 cs->list.alloc = 0;
1875 cs->list.items = NULL;
1878 void git_configset_clear(struct config_set *cs)
1880 struct config_set_element *entry;
1881 struct hashmap_iter iter;
1882 if (!cs->hash_initialized)
1883 return;
1885 hashmap_iter_init(&cs->config_hash, &iter);
1886 while ((entry = hashmap_iter_next(&iter))) {
1887 free(entry->key);
1888 string_list_clear(&entry->value_list, 1);
1890 hashmap_free(&cs->config_hash, 1);
1891 cs->hash_initialized = 0;
1892 free(cs->list.items);
1893 cs->list.nr = 0;
1894 cs->list.alloc = 0;
1895 cs->list.items = NULL;
1898 static int config_set_callback(const char *key, const char *value, void *cb)
1900 struct config_set *cs = cb;
1901 configset_add_value(cs, key, value);
1902 return 0;
1905 int git_configset_add_file(struct config_set *cs, const char *filename)
1907 return git_config_from_file(config_set_callback, filename, cs);
1910 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1912 const struct string_list *values = NULL;
1914 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1915 * queried key in the files of the configset, the value returned will be the last
1916 * value in the value list for that key.
1918 values = git_configset_get_value_multi(cs, key);
1920 if (!values)
1921 return 1;
1922 assert(values->nr > 0);
1923 *value = values->items[values->nr - 1].string;
1924 return 0;
1927 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1929 struct config_set_element *e = configset_find_element(cs, key);
1930 return e ? &e->value_list : NULL;
1933 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1935 const char *value;
1936 if (!git_configset_get_value(cs, key, &value))
1937 return git_config_string(dest, key, value);
1938 else
1939 return 1;
1942 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1944 return git_configset_get_string_const(cs, key, (const char **)dest);
1947 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1949 const char *value;
1950 if (!git_configset_get_value(cs, key, &value)) {
1951 *dest = git_config_int(key, value);
1952 return 0;
1953 } else
1954 return 1;
1957 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1959 const char *value;
1960 if (!git_configset_get_value(cs, key, &value)) {
1961 *dest = git_config_ulong(key, value);
1962 return 0;
1963 } else
1964 return 1;
1967 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1969 const char *value;
1970 if (!git_configset_get_value(cs, key, &value)) {
1971 *dest = git_config_bool(key, value);
1972 return 0;
1973 } else
1974 return 1;
1977 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1978 int *is_bool, int *dest)
1980 const char *value;
1981 if (!git_configset_get_value(cs, key, &value)) {
1982 *dest = git_config_bool_or_int(key, value, is_bool);
1983 return 0;
1984 } else
1985 return 1;
1988 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1990 const char *value;
1991 if (!git_configset_get_value(cs, key, &value)) {
1992 *dest = git_parse_maybe_bool(value);
1993 if (*dest == -1)
1994 return -1;
1995 return 0;
1996 } else
1997 return 1;
2000 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
2002 const char *value;
2003 if (!git_configset_get_value(cs, key, &value))
2004 return git_config_pathname(dest, key, value);
2005 else
2006 return 1;
2009 /* Functions use to read configuration from a repository */
2010 static void repo_read_config(struct repository *repo)
2012 struct config_options opts;
2014 opts.respect_includes = 1;
2015 opts.commondir = repo->commondir;
2016 opts.git_dir = repo->gitdir;
2018 if (!repo->config)
2019 repo->config = xcalloc(1, sizeof(struct config_set));
2020 else
2021 git_configset_clear(repo->config);
2023 git_configset_init(repo->config);
2025 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2027 * config_with_options() normally returns only
2028 * zero, as most errors are fatal, and
2029 * non-fatal potential errors are guarded by "if"
2030 * statements that are entered only when no error is
2031 * possible.
2033 * If we ever encounter a non-fatal error, it means
2034 * something went really wrong and we should stop
2035 * immediately.
2037 die(_("unknown error occurred while reading the configuration files"));
2040 static void git_config_check_init(struct repository *repo)
2042 if (repo->config && repo->config->hash_initialized)
2043 return;
2044 repo_read_config(repo);
2047 static void repo_config_clear(struct repository *repo)
2049 if (!repo->config || !repo->config->hash_initialized)
2050 return;
2051 git_configset_clear(repo->config);
2054 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2056 git_config_check_init(repo);
2057 configset_iter(repo->config, fn, data);
2060 int repo_config_get_value(struct repository *repo,
2061 const char *key, const char **value)
2063 git_config_check_init(repo);
2064 return git_configset_get_value(repo->config, key, value);
2067 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2068 const char *key)
2070 git_config_check_init(repo);
2071 return git_configset_get_value_multi(repo->config, key);
2074 int repo_config_get_string_const(struct repository *repo,
2075 const char *key, const char **dest)
2077 int ret;
2078 git_config_check_init(repo);
2079 ret = git_configset_get_string_const(repo->config, key, dest);
2080 if (ret < 0)
2081 git_die_config(key, NULL);
2082 return ret;
2085 int repo_config_get_string(struct repository *repo,
2086 const char *key, char **dest)
2088 git_config_check_init(repo);
2089 return repo_config_get_string_const(repo, key, (const char **)dest);
2092 int repo_config_get_int(struct repository *repo,
2093 const char *key, int *dest)
2095 git_config_check_init(repo);
2096 return git_configset_get_int(repo->config, key, dest);
2099 int repo_config_get_ulong(struct repository *repo,
2100 const char *key, unsigned long *dest)
2102 git_config_check_init(repo);
2103 return git_configset_get_ulong(repo->config, key, dest);
2106 int repo_config_get_bool(struct repository *repo,
2107 const char *key, int *dest)
2109 git_config_check_init(repo);
2110 return git_configset_get_bool(repo->config, key, dest);
2113 int repo_config_get_bool_or_int(struct repository *repo,
2114 const char *key, int *is_bool, int *dest)
2116 git_config_check_init(repo);
2117 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2120 int repo_config_get_maybe_bool(struct repository *repo,
2121 const char *key, int *dest)
2123 git_config_check_init(repo);
2124 return git_configset_get_maybe_bool(repo->config, key, dest);
2127 int repo_config_get_pathname(struct repository *repo,
2128 const char *key, const char **dest)
2130 int ret;
2131 git_config_check_init(repo);
2132 ret = git_configset_get_pathname(repo->config, key, dest);
2133 if (ret < 0)
2134 git_die_config(key, NULL);
2135 return ret;
2138 /* Functions used historically to read configuration from 'the_repository' */
2139 void git_config(config_fn_t fn, void *data)
2141 repo_config(the_repository, fn, data);
2144 void git_config_clear(void)
2146 repo_config_clear(the_repository);
2149 int git_config_get_value(const char *key, const char **value)
2151 return repo_config_get_value(the_repository, key, value);
2154 const struct string_list *git_config_get_value_multi(const char *key)
2156 return repo_config_get_value_multi(the_repository, key);
2159 int git_config_get_string_const(const char *key, const char **dest)
2161 return repo_config_get_string_const(the_repository, key, dest);
2164 int git_config_get_string(const char *key, char **dest)
2166 return repo_config_get_string(the_repository, key, dest);
2169 int git_config_get_int(const char *key, int *dest)
2171 return repo_config_get_int(the_repository, key, dest);
2174 int git_config_get_ulong(const char *key, unsigned long *dest)
2176 return repo_config_get_ulong(the_repository, key, dest);
2179 int git_config_get_bool(const char *key, int *dest)
2181 return repo_config_get_bool(the_repository, key, dest);
2184 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2186 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2189 int git_config_get_maybe_bool(const char *key, int *dest)
2191 return repo_config_get_maybe_bool(the_repository, key, dest);
2194 int git_config_get_pathname(const char *key, const char **dest)
2196 return repo_config_get_pathname(the_repository, key, dest);
2199 int git_config_get_expiry(const char *key, const char **output)
2201 int ret = git_config_get_string_const(key, output);
2202 if (ret)
2203 return ret;
2204 if (strcmp(*output, "now")) {
2205 timestamp_t now = approxidate("now");
2206 if (approxidate(*output) >= now)
2207 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2209 return ret;
2212 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2214 char *expiry_string;
2215 intmax_t days;
2216 timestamp_t when;
2218 if (git_config_get_string(key, &expiry_string))
2219 return 1; /* no such thing */
2221 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2222 const int scale = 86400;
2223 *expiry = now - days * scale;
2224 return 0;
2227 if (!parse_expiry_date(expiry_string, &when)) {
2228 *expiry = when;
2229 return 0;
2231 return -1; /* thing exists but cannot be parsed */
2234 int git_config_get_untracked_cache(void)
2236 int val = -1;
2237 const char *v;
2239 /* Hack for test programs like test-dump-untracked-cache */
2240 if (ignore_untracked_cache_config)
2241 return -1;
2243 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2244 return val;
2246 if (!git_config_get_value("core.untrackedcache", &v)) {
2247 if (!strcasecmp(v, "keep"))
2248 return -1;
2250 error(_("unknown core.untrackedCache value '%s'; "
2251 "using 'keep' default value"), v);
2252 return -1;
2255 return -1; /* default value */
2258 int git_config_get_split_index(void)
2260 int val;
2262 if (!git_config_get_maybe_bool("core.splitindex", &val))
2263 return val;
2265 return -1; /* default value */
2268 int git_config_get_max_percent_split_change(void)
2270 int val = -1;
2272 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2273 if (0 <= val && val <= 100)
2274 return val;
2276 return error(_("splitIndex.maxPercentChange value '%d' "
2277 "should be between 0 and 100"), val);
2280 return -1; /* default value */
2283 int git_config_get_fsmonitor(void)
2285 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2286 core_fsmonitor = getenv("GIT_TEST_FSMONITOR");
2288 if (core_fsmonitor && !*core_fsmonitor)
2289 core_fsmonitor = NULL;
2291 if (core_fsmonitor)
2292 return 1;
2294 return 0;
2297 int git_config_get_index_threads(int *dest)
2299 int is_bool, val;
2301 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2302 if (val) {
2303 *dest = val;
2304 return 0;
2307 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2308 if (is_bool)
2309 *dest = val ? 0 : 1;
2310 else
2311 *dest = val;
2312 return 0;
2315 return 1;
2318 NORETURN
2319 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2321 if (!filename)
2322 die(_("unable to parse '%s' from command-line config"), key);
2323 else
2324 die(_("bad config variable '%s' in file '%s' at line %d"),
2325 key, filename, linenr);
2328 NORETURN __attribute__((format(printf, 2, 3)))
2329 void git_die_config(const char *key, const char *err, ...)
2331 const struct string_list *values;
2332 struct key_value_info *kv_info;
2334 if (err) {
2335 va_list params;
2336 va_start(params, err);
2337 vreportf("error: ", err, params);
2338 va_end(params);
2340 values = git_config_get_value_multi(key);
2341 kv_info = values->items[values->nr - 1].util;
2342 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2346 * Find all the stuff for git_config_set() below.
2349 struct config_store_data {
2350 int baselen;
2351 char *key;
2352 int do_not_match;
2353 regex_t *value_regex;
2354 int multi_replace;
2355 struct {
2356 size_t begin, end;
2357 enum config_event_t type;
2358 int is_keys_section;
2359 } *parsed;
2360 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2361 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2364 static void config_store_data_clear(struct config_store_data *store)
2366 free(store->key);
2367 if (store->value_regex != NULL &&
2368 store->value_regex != CONFIG_REGEX_NONE) {
2369 regfree(store->value_regex);
2370 free(store->value_regex);
2372 free(store->parsed);
2373 free(store->seen);
2374 memset(store, 0, sizeof(*store));
2377 static int matches(const char *key, const char *value,
2378 const struct config_store_data *store)
2380 if (strcmp(key, store->key))
2381 return 0; /* not ours */
2382 if (!store->value_regex)
2383 return 1; /* always matches */
2384 if (store->value_regex == CONFIG_REGEX_NONE)
2385 return 0; /* never matches */
2387 return store->do_not_match ^
2388 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2391 static int store_aux_event(enum config_event_t type,
2392 size_t begin, size_t end, void *data)
2394 struct config_store_data *store = data;
2396 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2397 store->parsed[store->parsed_nr].begin = begin;
2398 store->parsed[store->parsed_nr].end = end;
2399 store->parsed[store->parsed_nr].type = type;
2401 if (type == CONFIG_EVENT_SECTION) {
2402 int (*cmpfn)(const char *, const char *, size_t);
2404 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2405 return error(_("invalid section name '%s'"), cf->var.buf);
2407 if (cf->subsection_case_sensitive)
2408 cmpfn = strncasecmp;
2409 else
2410 cmpfn = strncmp;
2412 /* Is this the section we were looking for? */
2413 store->is_keys_section =
2414 store->parsed[store->parsed_nr].is_keys_section =
2415 cf->var.len - 1 == store->baselen &&
2416 !cmpfn(cf->var.buf, store->key, store->baselen);
2417 if (store->is_keys_section) {
2418 store->section_seen = 1;
2419 ALLOC_GROW(store->seen, store->seen_nr + 1,
2420 store->seen_alloc);
2421 store->seen[store->seen_nr] = store->parsed_nr;
2425 store->parsed_nr++;
2427 return 0;
2430 static int store_aux(const char *key, const char *value, void *cb)
2432 struct config_store_data *store = cb;
2434 if (store->key_seen) {
2435 if (matches(key, value, store)) {
2436 if (store->seen_nr == 1 && store->multi_replace == 0) {
2437 warning(_("%s has multiple values"), key);
2440 ALLOC_GROW(store->seen, store->seen_nr + 1,
2441 store->seen_alloc);
2443 store->seen[store->seen_nr] = store->parsed_nr;
2444 store->seen_nr++;
2446 } else if (store->is_keys_section) {
2448 * Do not increment matches yet: this may not be a match, but we
2449 * are in the desired section.
2451 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2452 store->seen[store->seen_nr] = store->parsed_nr;
2453 store->section_seen = 1;
2455 if (matches(key, value, store)) {
2456 store->seen_nr++;
2457 store->key_seen = 1;
2461 return 0;
2464 static int write_error(const char *filename)
2466 error(_("failed to write new configuration file %s"), filename);
2468 /* Same error code as "failed to rename". */
2469 return 4;
2472 static struct strbuf store_create_section(const char *key,
2473 const struct config_store_data *store)
2475 const char *dot;
2476 int i;
2477 struct strbuf sb = STRBUF_INIT;
2479 dot = memchr(key, '.', store->baselen);
2480 if (dot) {
2481 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2482 for (i = dot - key + 1; i < store->baselen; i++) {
2483 if (key[i] == '"' || key[i] == '\\')
2484 strbuf_addch(&sb, '\\');
2485 strbuf_addch(&sb, key[i]);
2487 strbuf_addstr(&sb, "\"]\n");
2488 } else {
2489 strbuf_addf(&sb, "[%.*s]\n", store->baselen, key);
2492 return sb;
2495 static ssize_t write_section(int fd, const char *key,
2496 const struct config_store_data *store)
2498 struct strbuf sb = store_create_section(key, store);
2499 ssize_t ret;
2501 ret = write_in_full(fd, sb.buf, sb.len);
2502 strbuf_release(&sb);
2504 return ret;
2507 static ssize_t write_pair(int fd, const char *key, const char *value,
2508 const struct config_store_data *store)
2510 int i;
2511 ssize_t ret;
2512 int length = strlen(key + store->baselen + 1);
2513 const char *quote = "";
2514 struct strbuf sb = STRBUF_INIT;
2517 * Check to see if the value needs to be surrounded with a dq pair.
2518 * Note that problematic characters are always backslash-quoted; this
2519 * check is about not losing leading or trailing SP and strings that
2520 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2521 * configuration parser.
2523 if (value[0] == ' ')
2524 quote = "\"";
2525 for (i = 0; value[i]; i++)
2526 if (value[i] == ';' || value[i] == '#')
2527 quote = "\"";
2528 if (i && value[i - 1] == ' ')
2529 quote = "\"";
2531 strbuf_addf(&sb, "\t%.*s = %s",
2532 length, key + store->baselen + 1, quote);
2534 for (i = 0; value[i]; i++)
2535 switch (value[i]) {
2536 case '\n':
2537 strbuf_addstr(&sb, "\\n");
2538 break;
2539 case '\t':
2540 strbuf_addstr(&sb, "\\t");
2541 break;
2542 case '"':
2543 case '\\':
2544 strbuf_addch(&sb, '\\');
2545 /* fallthrough */
2546 default:
2547 strbuf_addch(&sb, value[i]);
2548 break;
2550 strbuf_addf(&sb, "%s\n", quote);
2552 ret = write_in_full(fd, sb.buf, sb.len);
2553 strbuf_release(&sb);
2555 return ret;
2559 * If we are about to unset the last key(s) in a section, and if there are
2560 * no comments surrounding (or included in) the section, we will want to
2561 * extend begin/end to remove the entire section.
2563 * Note: the parameter `seen_ptr` points to the index into the store.seen
2564 * array. * This index may be incremented if a section has more than one
2565 * entry (which all are to be removed).
2567 static void maybe_remove_section(struct config_store_data *store,
2568 const char *contents,
2569 size_t *begin_offset, size_t *end_offset,
2570 int *seen_ptr)
2572 size_t begin;
2573 int i, seen, section_seen = 0;
2576 * First, ensure that this is the first key, and that there are no
2577 * comments before the entry nor before the section header.
2579 seen = *seen_ptr;
2580 for (i = store->seen[seen]; i > 0; i--) {
2581 enum config_event_t type = store->parsed[i - 1].type;
2583 if (type == CONFIG_EVENT_COMMENT)
2584 /* There is a comment before this entry or section */
2585 return;
2586 if (type == CONFIG_EVENT_ENTRY) {
2587 if (!section_seen)
2588 /* This is not the section's first entry. */
2589 return;
2590 /* We encountered no comment before the section. */
2591 break;
2593 if (type == CONFIG_EVENT_SECTION) {
2594 if (!store->parsed[i - 1].is_keys_section)
2595 break;
2596 section_seen = 1;
2599 begin = store->parsed[i].begin;
2602 * Next, make sure that we are removing he last key(s) in the section,
2603 * and that there are no comments that are possibly about the current
2604 * section.
2606 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2607 enum config_event_t type = store->parsed[i].type;
2609 if (type == CONFIG_EVENT_COMMENT)
2610 return;
2611 if (type == CONFIG_EVENT_SECTION) {
2612 if (store->parsed[i].is_keys_section)
2613 continue;
2614 break;
2616 if (type == CONFIG_EVENT_ENTRY) {
2617 if (++seen < store->seen_nr &&
2618 i == store->seen[seen])
2619 /* We want to remove this entry, too */
2620 continue;
2621 /* There is another entry in this section. */
2622 return;
2627 * We are really removing the last entry/entries from this section, and
2628 * there are no enclosed or surrounding comments. Remove the entire,
2629 * now-empty section.
2631 *seen_ptr = seen;
2632 *begin_offset = begin;
2633 if (i < store->parsed_nr)
2634 *end_offset = store->parsed[i].begin;
2635 else
2636 *end_offset = store->parsed[store->parsed_nr - 1].end;
2639 int git_config_set_in_file_gently(const char *config_filename,
2640 const char *key, const char *value)
2642 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2645 void git_config_set_in_file(const char *config_filename,
2646 const char *key, const char *value)
2648 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2651 int git_config_set_gently(const char *key, const char *value)
2653 return git_config_set_multivar_gently(key, value, NULL, 0);
2656 void git_config_set(const char *key, const char *value)
2658 git_config_set_multivar(key, value, NULL, 0);
2662 * If value==NULL, unset in (remove from) config,
2663 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2664 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2665 * (only add a new one)
2666 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2667 * else all matching key/values (regardless how many) are removed,
2668 * before the new pair is written.
2670 * Returns 0 on success.
2672 * This function does this:
2674 * - it locks the config file by creating ".git/config.lock"
2676 * - it then parses the config using store_aux() as validator to find
2677 * the position on the key/value pair to replace. If it is to be unset,
2678 * it must be found exactly once.
2680 * - the config file is mmap()ed and the part before the match (if any) is
2681 * written to the lock file, then the changed part and the rest.
2683 * - the config file is removed and the lock file rename()d to it.
2686 int git_config_set_multivar_in_file_gently(const char *config_filename,
2687 const char *key, const char *value,
2688 const char *value_regex,
2689 int multi_replace)
2691 int fd = -1, in_fd = -1;
2692 int ret;
2693 struct lock_file lock = LOCK_INIT;
2694 char *filename_buf = NULL;
2695 char *contents = NULL;
2696 size_t contents_sz;
2697 struct config_store_data store;
2699 memset(&store, 0, sizeof(store));
2701 /* parse-key returns negative; flip the sign to feed exit(3) */
2702 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2703 if (ret)
2704 goto out_free;
2706 store.multi_replace = multi_replace;
2708 if (!config_filename)
2709 config_filename = filename_buf = git_pathdup("config");
2712 * The lock serves a purpose in addition to locking: the new
2713 * contents of .git/config will be written into it.
2715 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2716 if (fd < 0) {
2717 error_errno(_("could not lock config file %s"), config_filename);
2718 ret = CONFIG_NO_LOCK;
2719 goto out_free;
2723 * If .git/config does not exist yet, write a minimal version.
2725 in_fd = open(config_filename, O_RDONLY);
2726 if ( in_fd < 0 ) {
2727 if ( ENOENT != errno ) {
2728 error_errno(_("opening %s"), config_filename);
2729 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2730 goto out_free;
2732 /* if nothing to unset, error out */
2733 if (value == NULL) {
2734 ret = CONFIG_NOTHING_SET;
2735 goto out_free;
2738 free(store.key);
2739 store.key = xstrdup(key);
2740 if (write_section(fd, key, &store) < 0 ||
2741 write_pair(fd, key, value, &store) < 0)
2742 goto write_err_out;
2743 } else {
2744 struct stat st;
2745 size_t copy_begin, copy_end;
2746 int i, new_line = 0;
2747 struct config_options opts;
2749 if (value_regex == NULL)
2750 store.value_regex = NULL;
2751 else if (value_regex == CONFIG_REGEX_NONE)
2752 store.value_regex = CONFIG_REGEX_NONE;
2753 else {
2754 if (value_regex[0] == '!') {
2755 store.do_not_match = 1;
2756 value_regex++;
2757 } else
2758 store.do_not_match = 0;
2760 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2761 if (regcomp(store.value_regex, value_regex,
2762 REG_EXTENDED)) {
2763 error(_("invalid pattern: %s"), value_regex);
2764 FREE_AND_NULL(store.value_regex);
2765 ret = CONFIG_INVALID_PATTERN;
2766 goto out_free;
2770 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2771 store.parsed[0].end = 0;
2773 memset(&opts, 0, sizeof(opts));
2774 opts.event_fn = store_aux_event;
2775 opts.event_fn_data = &store;
2778 * After this, store.parsed will contain offsets of all the
2779 * parsed elements, and store.seen will contain a list of
2780 * matches, as indices into store.parsed.
2782 * As a side effect, we make sure to transform only a valid
2783 * existing config file.
2785 if (git_config_from_file_with_options(store_aux,
2786 config_filename,
2787 &store, &opts)) {
2788 error(_("invalid config file %s"), config_filename);
2789 ret = CONFIG_INVALID_FILE;
2790 goto out_free;
2793 /* if nothing to unset, or too many matches, error out */
2794 if ((store.seen_nr == 0 && value == NULL) ||
2795 (store.seen_nr > 1 && multi_replace == 0)) {
2796 ret = CONFIG_NOTHING_SET;
2797 goto out_free;
2800 if (fstat(in_fd, &st) == -1) {
2801 error_errno(_("fstat on %s failed"), config_filename);
2802 ret = CONFIG_INVALID_FILE;
2803 goto out_free;
2806 contents_sz = xsize_t(st.st_size);
2807 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2808 MAP_PRIVATE, in_fd, 0);
2809 if (contents == MAP_FAILED) {
2810 if (errno == ENODEV && S_ISDIR(st.st_mode))
2811 errno = EISDIR;
2812 error_errno(_("unable to mmap '%s'"), config_filename);
2813 ret = CONFIG_INVALID_FILE;
2814 contents = NULL;
2815 goto out_free;
2817 close(in_fd);
2818 in_fd = -1;
2820 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2821 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
2822 ret = CONFIG_NO_WRITE;
2823 goto out_free;
2826 if (store.seen_nr == 0) {
2827 if (!store.seen_alloc) {
2828 /* Did not see key nor section */
2829 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2830 store.seen[0] = store.parsed_nr
2831 - !!store.parsed_nr;
2833 store.seen_nr = 1;
2836 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2837 size_t replace_end;
2838 int j = store.seen[i];
2840 new_line = 0;
2841 if (!store.key_seen) {
2842 copy_end = store.parsed[j].end;
2843 /* include '\n' when copying section header */
2844 if (copy_end > 0 && copy_end < contents_sz &&
2845 contents[copy_end - 1] != '\n' &&
2846 contents[copy_end] == '\n')
2847 copy_end++;
2848 replace_end = copy_end;
2849 } else {
2850 replace_end = store.parsed[j].end;
2851 copy_end = store.parsed[j].begin;
2852 if (!value)
2853 maybe_remove_section(&store, contents,
2854 &copy_end,
2855 &replace_end, &i);
2857 * Swallow preceding white-space on the same
2858 * line.
2860 while (copy_end > 0 ) {
2861 char c = contents[copy_end - 1];
2863 if (isspace(c) && c != '\n')
2864 copy_end--;
2865 else
2866 break;
2870 if (copy_end > 0 && contents[copy_end-1] != '\n')
2871 new_line = 1;
2873 /* write the first part of the config */
2874 if (copy_end > copy_begin) {
2875 if (write_in_full(fd, contents + copy_begin,
2876 copy_end - copy_begin) < 0)
2877 goto write_err_out;
2878 if (new_line &&
2879 write_str_in_full(fd, "\n") < 0)
2880 goto write_err_out;
2882 copy_begin = replace_end;
2885 /* write the pair (value == NULL means unset) */
2886 if (value != NULL) {
2887 if (!store.section_seen) {
2888 if (write_section(fd, key, &store) < 0)
2889 goto write_err_out;
2891 if (write_pair(fd, key, value, &store) < 0)
2892 goto write_err_out;
2895 /* write the rest of the config */
2896 if (copy_begin < contents_sz)
2897 if (write_in_full(fd, contents + copy_begin,
2898 contents_sz - copy_begin) < 0)
2899 goto write_err_out;
2901 munmap(contents, contents_sz);
2902 contents = NULL;
2905 if (commit_lock_file(&lock) < 0) {
2906 error_errno(_("could not write config file %s"), config_filename);
2907 ret = CONFIG_NO_WRITE;
2908 goto out_free;
2911 ret = 0;
2913 /* Invalidate the config cache */
2914 git_config_clear();
2916 out_free:
2917 rollback_lock_file(&lock);
2918 free(filename_buf);
2919 if (contents)
2920 munmap(contents, contents_sz);
2921 if (in_fd >= 0)
2922 close(in_fd);
2923 config_store_data_clear(&store);
2924 return ret;
2926 write_err_out:
2927 ret = write_error(get_lock_file_path(&lock));
2928 goto out_free;
2932 void git_config_set_multivar_in_file(const char *config_filename,
2933 const char *key, const char *value,
2934 const char *value_regex, int multi_replace)
2936 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2937 value_regex, multi_replace))
2938 return;
2939 if (value)
2940 die(_("could not set '%s' to '%s'"), key, value);
2941 else
2942 die(_("could not unset '%s'"), key);
2945 int git_config_set_multivar_gently(const char *key, const char *value,
2946 const char *value_regex, int multi_replace)
2948 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2949 multi_replace);
2952 void git_config_set_multivar(const char *key, const char *value,
2953 const char *value_regex, int multi_replace)
2955 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2956 multi_replace);
2959 static int section_name_match (const char *buf, const char *name)
2961 int i = 0, j = 0, dot = 0;
2962 if (buf[i] != '[')
2963 return 0;
2964 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2965 if (!dot && isspace(buf[i])) {
2966 dot = 1;
2967 if (name[j++] != '.')
2968 break;
2969 for (i++; isspace(buf[i]); i++)
2970 ; /* do nothing */
2971 if (buf[i] != '"')
2972 break;
2973 continue;
2975 if (buf[i] == '\\' && dot)
2976 i++;
2977 else if (buf[i] == '"' && dot) {
2978 for (i++; isspace(buf[i]); i++)
2979 ; /* do_nothing */
2980 break;
2982 if (buf[i] != name[j++])
2983 break;
2985 if (buf[i] == ']' && name[j] == 0) {
2987 * We match, now just find the right length offset by
2988 * gobbling up any whitespace after it, as well
2990 i++;
2991 for (; buf[i] && isspace(buf[i]); i++)
2992 ; /* do nothing */
2993 return i;
2995 return 0;
2998 static int section_name_is_ok(const char *name)
3000 /* Empty section names are bogus. */
3001 if (!*name)
3002 return 0;
3005 * Before a dot, we must be alphanumeric or dash. After the first dot,
3006 * anything goes, so we can stop checking.
3008 for (; *name && *name != '.'; name++)
3009 if (*name != '-' && !isalnum(*name))
3010 return 0;
3011 return 1;
3014 /* if new_name == NULL, the section is removed instead */
3015 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3016 const char *old_name,
3017 const char *new_name, int copy)
3019 int ret = 0, remove = 0;
3020 char *filename_buf = NULL;
3021 struct lock_file lock = LOCK_INIT;
3022 int out_fd;
3023 char buf[1024];
3024 FILE *config_file = NULL;
3025 struct stat st;
3026 struct strbuf copystr = STRBUF_INIT;
3027 struct config_store_data store;
3029 memset(&store, 0, sizeof(store));
3031 if (new_name && !section_name_is_ok(new_name)) {
3032 ret = error(_("invalid section name: %s"), new_name);
3033 goto out_no_rollback;
3036 if (!config_filename)
3037 config_filename = filename_buf = git_pathdup("config");
3039 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3040 if (out_fd < 0) {
3041 ret = error(_("could not lock config file %s"), config_filename);
3042 goto out;
3045 if (!(config_file = fopen(config_filename, "rb"))) {
3046 ret = warn_on_fopen_errors(config_filename);
3047 if (ret)
3048 goto out;
3049 /* no config file means nothing to rename, no error */
3050 goto commit_and_out;
3053 if (fstat(fileno(config_file), &st) == -1) {
3054 ret = error_errno(_("fstat on %s failed"), config_filename);
3055 goto out;
3058 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3059 ret = error_errno(_("chmod on %s failed"),
3060 get_lock_file_path(&lock));
3061 goto out;
3064 while (fgets(buf, sizeof(buf), config_file)) {
3065 int i;
3066 int length;
3067 int is_section = 0;
3068 char *output = buf;
3069 for (i = 0; buf[i] && isspace(buf[i]); i++)
3070 ; /* do nothing */
3071 if (buf[i] == '[') {
3072 /* it's a section */
3073 int offset;
3074 is_section = 1;
3077 * When encountering a new section under -c we
3078 * need to flush out any section we're already
3079 * coping and begin anew. There might be
3080 * multiple [branch "$name"] sections.
3082 if (copystr.len > 0) {
3083 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3084 ret = write_error(get_lock_file_path(&lock));
3085 goto out;
3087 strbuf_reset(&copystr);
3090 offset = section_name_match(&buf[i], old_name);
3091 if (offset > 0) {
3092 ret++;
3093 if (new_name == NULL) {
3094 remove = 1;
3095 continue;
3097 store.baselen = strlen(new_name);
3098 if (!copy) {
3099 if (write_section(out_fd, new_name, &store) < 0) {
3100 ret = write_error(get_lock_file_path(&lock));
3101 goto out;
3104 * We wrote out the new section, with
3105 * a newline, now skip the old
3106 * section's length
3108 output += offset + i;
3109 if (strlen(output) > 0) {
3111 * More content means there's
3112 * a declaration to put on the
3113 * next line; indent with a
3114 * tab
3116 output -= 1;
3117 output[0] = '\t';
3119 } else {
3120 copystr = store_create_section(new_name, &store);
3123 remove = 0;
3125 if (remove)
3126 continue;
3127 length = strlen(output);
3129 if (!is_section && copystr.len > 0) {
3130 strbuf_add(&copystr, output, length);
3133 if (write_in_full(out_fd, output, length) < 0) {
3134 ret = write_error(get_lock_file_path(&lock));
3135 goto out;
3140 * Copy a trailing section at the end of the config, won't be
3141 * flushed by the usual "flush because we have a new section
3142 * logic in the loop above.
3144 if (copystr.len > 0) {
3145 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3146 ret = write_error(get_lock_file_path(&lock));
3147 goto out;
3149 strbuf_reset(&copystr);
3152 fclose(config_file);
3153 config_file = NULL;
3154 commit_and_out:
3155 if (commit_lock_file(&lock) < 0)
3156 ret = error_errno(_("could not write config file %s"),
3157 config_filename);
3158 out:
3159 if (config_file)
3160 fclose(config_file);
3161 rollback_lock_file(&lock);
3162 out_no_rollback:
3163 free(filename_buf);
3164 config_store_data_clear(&store);
3165 return ret;
3168 int git_config_rename_section_in_file(const char *config_filename,
3169 const char *old_name, const char *new_name)
3171 return git_config_copy_or_rename_section_in_file(config_filename,
3172 old_name, new_name, 0);
3175 int git_config_rename_section(const char *old_name, const char *new_name)
3177 return git_config_rename_section_in_file(NULL, old_name, new_name);
3180 int git_config_copy_section_in_file(const char *config_filename,
3181 const char *old_name, const char *new_name)
3183 return git_config_copy_or_rename_section_in_file(config_filename,
3184 old_name, new_name, 1);
3187 int git_config_copy_section(const char *old_name, const char *new_name)
3189 return git_config_copy_section_in_file(NULL, old_name, new_name);
3193 * Call this to report error for your variable that should not
3194 * get a boolean value (i.e. "[my] var" means "true").
3196 #undef config_error_nonbool
3197 int config_error_nonbool(const char *var)
3199 return error(_("missing value for '%s'"), var);
3202 int parse_config_key(const char *var,
3203 const char *section,
3204 const char **subsection, int *subsection_len,
3205 const char **key)
3207 const char *dot;
3209 /* Does it start with "section." ? */
3210 if (!skip_prefix(var, section, &var) || *var != '.')
3211 return -1;
3214 * Find the key; we don't know yet if we have a subsection, but we must
3215 * parse backwards from the end, since the subsection may have dots in
3216 * it, too.
3218 dot = strrchr(var, '.');
3219 *key = dot + 1;
3221 /* Did we have a subsection at all? */
3222 if (dot == var) {
3223 if (subsection) {
3224 *subsection = NULL;
3225 *subsection_len = 0;
3228 else {
3229 if (!subsection)
3230 return -1;
3231 *subsection = var + 1;
3232 *subsection_len = dot - *subsection;
3235 return 0;
3238 const char *current_config_origin_type(void)
3240 int type;
3241 if (current_config_kvi)
3242 type = current_config_kvi->origin_type;
3243 else if(cf)
3244 type = cf->origin_type;
3245 else
3246 BUG("current_config_origin_type called outside config callback");
3248 switch (type) {
3249 case CONFIG_ORIGIN_BLOB:
3250 return "blob";
3251 case CONFIG_ORIGIN_FILE:
3252 return "file";
3253 case CONFIG_ORIGIN_STDIN:
3254 return "standard input";
3255 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3256 return "submodule-blob";
3257 case CONFIG_ORIGIN_CMDLINE:
3258 return "command line";
3259 default:
3260 BUG("unknown config origin type");
3264 const char *current_config_name(void)
3266 const char *name;
3267 if (current_config_kvi)
3268 name = current_config_kvi->filename;
3269 else if (cf)
3270 name = cf->name;
3271 else
3272 BUG("current_config_name called outside config callback");
3273 return name ? name : "";
3276 enum config_scope current_config_scope(void)
3278 if (current_config_kvi)
3279 return current_config_kvi->scope;
3280 else
3281 return current_parsing_scope;
3284 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3286 int i;
3288 for (i = 0; i < nr_mapping; i++) {
3289 const char *name = mapping[i];
3291 if (name && !strcasecmp(var, name))
3292 return i;
3294 return -1;