Merge branch 'ab/test-must-be-empty-for-master'
[git.git] / config.c
blob4446909229a0f7b14d7428ad9860c9a655c77df8
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 "config.h"
10 #include "repository.h"
11 #include "lockfile.h"
12 #include "exec-cmd.h"
13 #include "strbuf.h"
14 #include "quote.h"
15 #include "hashmap.h"
16 #include "string-list.h"
17 #include "object-store.h"
18 #include "utf8.h"
19 #include "dir.h"
20 #include "color.h"
22 struct config_source {
23 struct config_source *prev;
24 union {
25 FILE *file;
26 struct config_buf {
27 const char *buf;
28 size_t len;
29 size_t pos;
30 } buf;
31 } u;
32 enum config_origin_type origin_type;
33 const char *name;
34 const char *path;
35 enum config_error_action default_error_action;
36 int linenr;
37 int eof;
38 struct strbuf value;
39 struct strbuf var;
41 int (*do_fgetc)(struct config_source *c);
42 int (*do_ungetc)(int c, struct config_source *conf);
43 long (*do_ftell)(struct config_source *c);
47 * These variables record the "current" config source, which
48 * can be accessed by parsing callbacks.
50 * The "cf" variable will be non-NULL only when we are actually parsing a real
51 * config source (file, blob, cmdline, etc).
53 * The "current_config_kvi" variable will be non-NULL only when we are feeding
54 * cached config from a configset into a callback.
56 * They should generally never be non-NULL at the same time. If they are both
57 * NULL, then we aren't parsing anything (and depending on the function looking
58 * at the variables, it's either a bug for it to be called in the first place,
59 * or it's a function which can be reused for non-config purposes, and should
60 * fall back to some sane behavior).
62 static struct config_source *cf;
63 static struct key_value_info *current_config_kvi;
66 * Similar to the variables above, this gives access to the "scope" of the
67 * current value (repo, global, etc). For cached values, it can be found via
68 * the current_config_kvi as above. During parsing, the current value can be
69 * found in this variable. It's not part of "cf" because it transcends a single
70 * file (i.e., a file included from .git/config is still in "repo" scope).
72 static enum config_scope current_parsing_scope;
74 static int core_compression_seen;
75 static int pack_compression_seen;
76 static int zlib_compression_seen;
78 static int config_file_fgetc(struct config_source *conf)
80 return getc_unlocked(conf->u.file);
83 static int config_file_ungetc(int c, struct config_source *conf)
85 return ungetc(c, conf->u.file);
88 static long config_file_ftell(struct config_source *conf)
90 return ftell(conf->u.file);
94 static int config_buf_fgetc(struct config_source *conf)
96 if (conf->u.buf.pos < conf->u.buf.len)
97 return conf->u.buf.buf[conf->u.buf.pos++];
99 return EOF;
102 static int config_buf_ungetc(int c, struct config_source *conf)
104 if (conf->u.buf.pos > 0) {
105 conf->u.buf.pos--;
106 if (conf->u.buf.buf[conf->u.buf.pos] != c)
107 BUG("config_buf can only ungetc the same character");
108 return c;
111 return EOF;
114 static long config_buf_ftell(struct config_source *conf)
116 return conf->u.buf.pos;
119 #define MAX_INCLUDE_DEPTH 10
120 static const char include_depth_advice[] = N_(
121 "exceeded maximum include depth (%d) while including\n"
122 " %s\n"
123 "from\n"
124 " %s\n"
125 "Do you have circular includes?");
126 static int handle_path_include(const char *path, struct config_include_data *inc)
128 int ret = 0;
129 struct strbuf buf = STRBUF_INIT;
130 char *expanded;
132 if (!path)
133 return config_error_nonbool("include.path");
135 expanded = expand_user_path(path, 0);
136 if (!expanded)
137 return error(_("could not expand include path '%s'"), path);
138 path = expanded;
141 * Use an absolute path as-is, but interpret relative paths
142 * based on the including config file.
144 if (!is_absolute_path(path)) {
145 char *slash;
147 if (!cf || !cf->path)
148 return error(_("relative config includes must come from files"));
150 slash = find_last_dir_sep(cf->path);
151 if (slash)
152 strbuf_add(&buf, cf->path, slash - cf->path + 1);
153 strbuf_addstr(&buf, path);
154 path = buf.buf;
157 if (!access_or_die(path, R_OK, 0)) {
158 if (++inc->depth > MAX_INCLUDE_DEPTH)
159 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
160 !cf ? "<unknown>" :
161 cf->name ? cf->name :
162 "the command line");
163 ret = git_config_from_file(git_config_include, path, inc);
164 inc->depth--;
166 strbuf_release(&buf);
167 free(expanded);
168 return ret;
171 static int prepare_include_condition_pattern(struct strbuf *pat)
173 struct strbuf path = STRBUF_INIT;
174 char *expanded;
175 int prefix = 0;
177 expanded = expand_user_path(pat->buf, 1);
178 if (expanded) {
179 strbuf_reset(pat);
180 strbuf_addstr(pat, expanded);
181 free(expanded);
184 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
185 const char *slash;
187 if (!cf || !cf->path)
188 return error(_("relative config include "
189 "conditionals must come from files"));
191 strbuf_realpath(&path, cf->path, 1);
192 slash = find_last_dir_sep(path.buf);
193 if (!slash)
194 BUG("how is this possible?");
195 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
196 prefix = slash - path.buf + 1 /* slash */;
197 } else if (!is_absolute_path(pat->buf))
198 strbuf_insert(pat, 0, "**/", 3);
200 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
201 strbuf_addstr(pat, "**");
203 strbuf_release(&path);
204 return prefix;
207 static int include_by_gitdir(const struct config_options *opts,
208 const char *cond, size_t cond_len, int icase)
210 struct strbuf text = STRBUF_INIT;
211 struct strbuf pattern = STRBUF_INIT;
212 int ret = 0, prefix;
213 const char *git_dir;
214 int already_tried_absolute = 0;
216 if (opts->git_dir)
217 git_dir = opts->git_dir;
218 else
219 goto done;
221 strbuf_realpath(&text, git_dir, 1);
222 strbuf_add(&pattern, cond, cond_len);
223 prefix = prepare_include_condition_pattern(&pattern);
225 again:
226 if (prefix < 0)
227 goto done;
229 if (prefix > 0) {
231 * perform literal matching on the prefix part so that
232 * any wildcard character in it can't create side effects.
234 if (text.len < prefix)
235 goto done;
236 if (!icase && strncmp(pattern.buf, text.buf, prefix))
237 goto done;
238 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
239 goto done;
242 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
243 icase ? WM_CASEFOLD : 0);
245 if (!ret && !already_tried_absolute) {
247 * We've tried e.g. matching gitdir:~/work, but if
248 * ~/work is a symlink to /mnt/storage/work
249 * strbuf_realpath() will expand it, so the rule won't
250 * match. Let's match against a
251 * strbuf_add_absolute_path() version of the path,
252 * which'll do the right thing
254 strbuf_reset(&text);
255 strbuf_add_absolute_path(&text, git_dir);
256 already_tried_absolute = 1;
257 goto again;
259 done:
260 strbuf_release(&pattern);
261 strbuf_release(&text);
262 return ret;
265 static int include_condition_is_true(const struct config_options *opts,
266 const char *cond, size_t cond_len)
269 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
270 return include_by_gitdir(opts, cond, cond_len, 0);
271 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
272 return include_by_gitdir(opts, cond, cond_len, 1);
274 /* unknown conditionals are always false */
275 return 0;
278 int git_config_include(const char *var, const char *value, void *data)
280 struct config_include_data *inc = data;
281 const char *cond, *key;
282 int cond_len;
283 int ret;
286 * Pass along all values, including "include" directives; this makes it
287 * possible to query information on the includes themselves.
289 ret = inc->fn(var, value, inc->data);
290 if (ret < 0)
291 return ret;
293 if (!strcmp(var, "include.path"))
294 ret = handle_path_include(value, inc);
296 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
297 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
298 !strcmp(key, "path"))
299 ret = handle_path_include(value, inc);
301 return ret;
304 void git_config_push_parameter(const char *text)
306 struct strbuf env = STRBUF_INIT;
307 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
308 if (old && *old) {
309 strbuf_addstr(&env, old);
310 strbuf_addch(&env, ' ');
312 sq_quote_buf(&env, text);
313 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
314 strbuf_release(&env);
317 static inline int iskeychar(int c)
319 return isalnum(c) || c == '-';
323 * Auxiliary function to sanity-check and split the key into the section
324 * identifier and variable name.
326 * Returns 0 on success, -1 when there is an invalid character in the key and
327 * -2 if there is no section name in the key.
329 * store_key - pointer to char* which will hold a copy of the key with
330 * lowercase section and variable name
331 * baselen - pointer to int which will hold the length of the
332 * section + subsection part, can be NULL
334 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
336 int i, dot, baselen;
337 const char *last_dot = strrchr(key, '.');
340 * Since "key" actually contains the section name and the real
341 * key name separated by a dot, we have to know where the dot is.
344 if (last_dot == NULL || last_dot == key) {
345 if (!quiet)
346 error(_("key does not contain a section: %s"), key);
347 return -CONFIG_NO_SECTION_OR_NAME;
350 if (!last_dot[1]) {
351 if (!quiet)
352 error(_("key does not contain variable name: %s"), key);
353 return -CONFIG_NO_SECTION_OR_NAME;
356 baselen = last_dot - key;
357 if (baselen_)
358 *baselen_ = baselen;
361 * Validate the key and while at it, lower case it for matching.
363 if (store_key)
364 *store_key = xmallocz(strlen(key));
366 dot = 0;
367 for (i = 0; key[i]; i++) {
368 unsigned char c = key[i];
369 if (c == '.')
370 dot = 1;
371 /* Leave the extended basename untouched.. */
372 if (!dot || i > baselen) {
373 if (!iskeychar(c) ||
374 (i == baselen + 1 && !isalpha(c))) {
375 if (!quiet)
376 error(_("invalid key: %s"), key);
377 goto out_free_ret_1;
379 c = tolower(c);
380 } else if (c == '\n') {
381 if (!quiet)
382 error(_("invalid key (newline): %s"), key);
383 goto out_free_ret_1;
385 if (store_key)
386 (*store_key)[i] = c;
389 return 0;
391 out_free_ret_1:
392 if (store_key) {
393 FREE_AND_NULL(*store_key);
395 return -CONFIG_INVALID_KEY;
398 int git_config_parse_key(const char *key, char **store_key, int *baselen)
400 return git_config_parse_key_1(key, store_key, baselen, 0);
403 int git_config_key_is_valid(const char *key)
405 return !git_config_parse_key_1(key, NULL, NULL, 1);
408 int git_config_parse_parameter(const char *text,
409 config_fn_t fn, void *data)
411 const char *value;
412 char *canonical_name;
413 struct strbuf **pair;
414 int ret;
416 pair = strbuf_split_str(text, '=', 2);
417 if (!pair[0])
418 return error(_("bogus config parameter: %s"), text);
420 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
421 strbuf_setlen(pair[0], pair[0]->len - 1);
422 value = pair[1] ? pair[1]->buf : "";
423 } else {
424 value = NULL;
427 strbuf_trim(pair[0]);
428 if (!pair[0]->len) {
429 strbuf_list_free(pair);
430 return error(_("bogus config parameter: %s"), text);
433 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
434 ret = -1;
435 } else {
436 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
437 free(canonical_name);
439 strbuf_list_free(pair);
440 return ret;
443 int git_config_from_parameters(config_fn_t fn, void *data)
445 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
446 int ret = 0;
447 char *envw;
448 const char **argv = NULL;
449 int nr = 0, alloc = 0;
450 int i;
451 struct config_source source;
453 if (!env)
454 return 0;
456 memset(&source, 0, sizeof(source));
457 source.prev = cf;
458 source.origin_type = CONFIG_ORIGIN_CMDLINE;
459 cf = &source;
461 /* sq_dequote will write over it */
462 envw = xstrdup(env);
464 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
465 ret = error(_("bogus format in %s"), CONFIG_DATA_ENVIRONMENT);
466 goto out;
469 for (i = 0; i < nr; i++) {
470 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
471 ret = -1;
472 goto out;
476 out:
477 free(argv);
478 free(envw);
479 cf = source.prev;
480 return ret;
483 static int get_next_char(void)
485 int c = cf->do_fgetc(cf);
487 if (c == '\r') {
488 /* DOS like systems */
489 c = cf->do_fgetc(cf);
490 if (c != '\n') {
491 if (c != EOF)
492 cf->do_ungetc(c, cf);
493 c = '\r';
496 if (c == '\n')
497 cf->linenr++;
498 if (c == EOF) {
499 cf->eof = 1;
500 cf->linenr++;
501 c = '\n';
503 return c;
506 static char *parse_value(void)
508 int quote = 0, comment = 0, space = 0;
510 strbuf_reset(&cf->value);
511 for (;;) {
512 int c = get_next_char();
513 if (c == '\n') {
514 if (quote) {
515 cf->linenr--;
516 return NULL;
518 return cf->value.buf;
520 if (comment)
521 continue;
522 if (isspace(c) && !quote) {
523 if (cf->value.len)
524 space++;
525 continue;
527 if (!quote) {
528 if (c == ';' || c == '#') {
529 comment = 1;
530 continue;
533 for (; space; space--)
534 strbuf_addch(&cf->value, ' ');
535 if (c == '\\') {
536 c = get_next_char();
537 switch (c) {
538 case '\n':
539 continue;
540 case 't':
541 c = '\t';
542 break;
543 case 'b':
544 c = '\b';
545 break;
546 case 'n':
547 c = '\n';
548 break;
549 /* Some characters escape as themselves */
550 case '\\': case '"':
551 break;
552 /* Reject unknown escape sequences */
553 default:
554 return NULL;
556 strbuf_addch(&cf->value, c);
557 continue;
559 if (c == '"') {
560 quote = 1-quote;
561 continue;
563 strbuf_addch(&cf->value, c);
567 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
569 int c;
570 char *value;
571 int ret;
573 /* Get the full name */
574 for (;;) {
575 c = get_next_char();
576 if (cf->eof)
577 break;
578 if (!iskeychar(c))
579 break;
580 strbuf_addch(name, tolower(c));
583 while (c == ' ' || c == '\t')
584 c = get_next_char();
586 value = NULL;
587 if (c != '\n') {
588 if (c != '=')
589 return -1;
590 value = parse_value();
591 if (!value)
592 return -1;
595 * We already consumed the \n, but we need linenr to point to
596 * the line we just parsed during the call to fn to get
597 * accurate line number in error messages.
599 cf->linenr--;
600 ret = fn(name->buf, value, data);
601 if (ret >= 0)
602 cf->linenr++;
603 return ret;
606 static int get_extended_base_var(struct strbuf *name, int c)
608 do {
609 if (c == '\n')
610 goto error_incomplete_line;
611 c = get_next_char();
612 } while (isspace(c));
614 /* We require the format to be '[base "extension"]' */
615 if (c != '"')
616 return -1;
617 strbuf_addch(name, '.');
619 for (;;) {
620 int c = get_next_char();
621 if (c == '\n')
622 goto error_incomplete_line;
623 if (c == '"')
624 break;
625 if (c == '\\') {
626 c = get_next_char();
627 if (c == '\n')
628 goto error_incomplete_line;
630 strbuf_addch(name, c);
633 /* Final ']' */
634 if (get_next_char() != ']')
635 return -1;
636 return 0;
637 error_incomplete_line:
638 cf->linenr--;
639 return -1;
642 static int get_base_var(struct strbuf *name)
644 for (;;) {
645 int c = get_next_char();
646 if (cf->eof)
647 return -1;
648 if (c == ']')
649 return 0;
650 if (isspace(c))
651 return get_extended_base_var(name, c);
652 if (!iskeychar(c) && c != '.')
653 return -1;
654 strbuf_addch(name, tolower(c));
658 struct parse_event_data {
659 enum config_event_t previous_type;
660 size_t previous_offset;
661 const struct config_options *opts;
664 static int do_event(enum config_event_t type, struct parse_event_data *data)
666 size_t offset;
668 if (!data->opts || !data->opts->event_fn)
669 return 0;
671 if (type == CONFIG_EVENT_WHITESPACE &&
672 data->previous_type == type)
673 return 0;
675 offset = cf->do_ftell(cf);
677 * At EOF, the parser always "inserts" an extra '\n', therefore
678 * the end offset of the event is the current file position, otherwise
679 * we will already have advanced to the next event.
681 if (type != CONFIG_EVENT_EOF)
682 offset--;
684 if (data->previous_type != CONFIG_EVENT_EOF &&
685 data->opts->event_fn(data->previous_type, data->previous_offset,
686 offset, data->opts->event_fn_data) < 0)
687 return -1;
689 data->previous_type = type;
690 data->previous_offset = offset;
692 return 0;
695 static int git_parse_source(config_fn_t fn, void *data,
696 const struct config_options *opts)
698 int comment = 0;
699 int baselen = 0;
700 struct strbuf *var = &cf->var;
701 int error_return = 0;
702 char *error_msg = NULL;
704 /* U+FEFF Byte Order Mark in UTF8 */
705 const char *bomptr = utf8_bom;
707 /* For the parser event callback */
708 struct parse_event_data event_data = {
709 CONFIG_EVENT_EOF, 0, opts
712 for (;;) {
713 int c;
715 c = get_next_char();
716 if (bomptr && *bomptr) {
717 /* We are at the file beginning; skip UTF8-encoded BOM
718 * if present. Sane editors won't put this in on their
719 * own, but e.g. Windows Notepad will do it happily. */
720 if (c == (*bomptr & 0377)) {
721 bomptr++;
722 continue;
723 } else {
724 /* Do not tolerate partial BOM. */
725 if (bomptr != utf8_bom)
726 break;
727 /* No BOM at file beginning. Cool. */
728 bomptr = NULL;
731 if (c == '\n') {
732 if (cf->eof) {
733 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
734 return -1;
735 return 0;
737 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
738 return -1;
739 comment = 0;
740 continue;
742 if (comment)
743 continue;
744 if (isspace(c)) {
745 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
746 return -1;
747 continue;
749 if (c == '#' || c == ';') {
750 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
751 return -1;
752 comment = 1;
753 continue;
755 if (c == '[') {
756 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
757 return -1;
759 /* Reset prior to determining a new stem */
760 strbuf_reset(var);
761 if (get_base_var(var) < 0 || var->len < 1)
762 break;
763 strbuf_addch(var, '.');
764 baselen = var->len;
765 continue;
767 if (!isalpha(c))
768 break;
770 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
771 return -1;
774 * Truncate the var name back to the section header
775 * stem prior to grabbing the suffix part of the name
776 * and the value.
778 strbuf_setlen(var, baselen);
779 strbuf_addch(var, tolower(c));
780 if (get_value(fn, data, var) < 0)
781 break;
784 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
785 return -1;
787 switch (cf->origin_type) {
788 case CONFIG_ORIGIN_BLOB:
789 error_msg = xstrfmt(_("bad config line %d in blob %s"),
790 cf->linenr, cf->name);
791 break;
792 case CONFIG_ORIGIN_FILE:
793 error_msg = xstrfmt(_("bad config line %d in file %s"),
794 cf->linenr, cf->name);
795 break;
796 case CONFIG_ORIGIN_STDIN:
797 error_msg = xstrfmt(_("bad config line %d in standard input"),
798 cf->linenr);
799 break;
800 case CONFIG_ORIGIN_SUBMODULE_BLOB:
801 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
802 cf->linenr, cf->name);
803 break;
804 case CONFIG_ORIGIN_CMDLINE:
805 error_msg = xstrfmt(_("bad config line %d in command line %s"),
806 cf->linenr, cf->name);
807 break;
808 default:
809 error_msg = xstrfmt(_("bad config line %d in %s"),
810 cf->linenr, cf->name);
813 switch (opts && opts->error_action ?
814 opts->error_action :
815 cf->default_error_action) {
816 case CONFIG_ERROR_DIE:
817 die("%s", error_msg);
818 break;
819 case CONFIG_ERROR_ERROR:
820 error_return = error("%s", error_msg);
821 break;
822 case CONFIG_ERROR_SILENT:
823 error_return = -1;
824 break;
825 case CONFIG_ERROR_UNSET:
826 BUG("config error action unset");
829 free(error_msg);
830 return error_return;
833 static int parse_unit_factor(const char *end, uintmax_t *val)
835 if (!*end)
836 return 1;
837 else if (!strcasecmp(end, "k")) {
838 *val *= 1024;
839 return 1;
841 else if (!strcasecmp(end, "m")) {
842 *val *= 1024 * 1024;
843 return 1;
845 else if (!strcasecmp(end, "g")) {
846 *val *= 1024 * 1024 * 1024;
847 return 1;
849 return 0;
852 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
854 if (value && *value) {
855 char *end;
856 intmax_t val;
857 uintmax_t uval;
858 uintmax_t factor = 1;
860 errno = 0;
861 val = strtoimax(value, &end, 0);
862 if (errno == ERANGE)
863 return 0;
864 if (!parse_unit_factor(end, &factor)) {
865 errno = EINVAL;
866 return 0;
868 uval = labs(val);
869 uval *= factor;
870 if (uval > max || labs(val) > uval) {
871 errno = ERANGE;
872 return 0;
874 val *= factor;
875 *ret = val;
876 return 1;
878 errno = EINVAL;
879 return 0;
882 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
884 if (value && *value) {
885 char *end;
886 uintmax_t val;
887 uintmax_t oldval;
889 errno = 0;
890 val = strtoumax(value, &end, 0);
891 if (errno == ERANGE)
892 return 0;
893 oldval = val;
894 if (!parse_unit_factor(end, &val)) {
895 errno = EINVAL;
896 return 0;
898 if (val > max || oldval > val) {
899 errno = ERANGE;
900 return 0;
902 *ret = val;
903 return 1;
905 errno = EINVAL;
906 return 0;
909 static int git_parse_int(const char *value, int *ret)
911 intmax_t tmp;
912 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
913 return 0;
914 *ret = tmp;
915 return 1;
918 static int git_parse_int64(const char *value, int64_t *ret)
920 intmax_t tmp;
921 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
922 return 0;
923 *ret = tmp;
924 return 1;
927 int git_parse_ulong(const char *value, unsigned long *ret)
929 uintmax_t tmp;
930 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
931 return 0;
932 *ret = tmp;
933 return 1;
936 int git_parse_ssize_t(const char *value, ssize_t *ret)
938 intmax_t tmp;
939 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
940 return 0;
941 *ret = tmp;
942 return 1;
945 NORETURN
946 static void die_bad_number(const char *name, const char *value)
948 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
950 if (!value)
951 value = "";
953 if (!(cf && cf->name))
954 die(_("bad numeric config value '%s' for '%s': %s"),
955 value, name, error_type);
957 switch (cf->origin_type) {
958 case CONFIG_ORIGIN_BLOB:
959 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
960 value, name, cf->name, error_type);
961 case CONFIG_ORIGIN_FILE:
962 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
963 value, name, cf->name, error_type);
964 case CONFIG_ORIGIN_STDIN:
965 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
966 value, name, error_type);
967 case CONFIG_ORIGIN_SUBMODULE_BLOB:
968 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
969 value, name, cf->name, error_type);
970 case CONFIG_ORIGIN_CMDLINE:
971 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
972 value, name, cf->name, error_type);
973 default:
974 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
975 value, name, cf->name, error_type);
979 int git_config_int(const char *name, const char *value)
981 int ret;
982 if (!git_parse_int(value, &ret))
983 die_bad_number(name, value);
984 return ret;
987 int64_t git_config_int64(const char *name, const char *value)
989 int64_t ret;
990 if (!git_parse_int64(value, &ret))
991 die_bad_number(name, value);
992 return ret;
995 unsigned long git_config_ulong(const char *name, const char *value)
997 unsigned long ret;
998 if (!git_parse_ulong(value, &ret))
999 die_bad_number(name, value);
1000 return ret;
1003 ssize_t git_config_ssize_t(const char *name, const char *value)
1005 ssize_t ret;
1006 if (!git_parse_ssize_t(value, &ret))
1007 die_bad_number(name, value);
1008 return ret;
1011 static int git_parse_maybe_bool_text(const char *value)
1013 if (!value)
1014 return 1;
1015 if (!*value)
1016 return 0;
1017 if (!strcasecmp(value, "true")
1018 || !strcasecmp(value, "yes")
1019 || !strcasecmp(value, "on"))
1020 return 1;
1021 if (!strcasecmp(value, "false")
1022 || !strcasecmp(value, "no")
1023 || !strcasecmp(value, "off"))
1024 return 0;
1025 return -1;
1028 int git_parse_maybe_bool(const char *value)
1030 int v = git_parse_maybe_bool_text(value);
1031 if (0 <= v)
1032 return v;
1033 if (git_parse_int(value, &v))
1034 return !!v;
1035 return -1;
1038 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1040 int v = git_parse_maybe_bool_text(value);
1041 if (0 <= v) {
1042 *is_bool = 1;
1043 return v;
1045 *is_bool = 0;
1046 return git_config_int(name, value);
1049 int git_config_bool(const char *name, const char *value)
1051 int discard;
1052 return !!git_config_bool_or_int(name, value, &discard);
1055 int git_config_string(const char **dest, const char *var, const char *value)
1057 if (!value)
1058 return config_error_nonbool(var);
1059 *dest = xstrdup(value);
1060 return 0;
1063 int git_config_pathname(const char **dest, const char *var, const char *value)
1065 if (!value)
1066 return config_error_nonbool(var);
1067 *dest = expand_user_path(value, 0);
1068 if (!*dest)
1069 die(_("failed to expand user dir in: '%s'"), value);
1070 return 0;
1073 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1075 if (!value)
1076 return config_error_nonbool(var);
1077 if (parse_expiry_date(value, timestamp))
1078 return error(_("'%s' for '%s' is not a valid timestamp"),
1079 value, var);
1080 return 0;
1083 int git_config_color(char *dest, const char *var, const char *value)
1085 if (!value)
1086 return config_error_nonbool(var);
1087 if (color_parse(value, dest) < 0)
1088 return -1;
1089 return 0;
1092 static int git_default_core_config(const char *var, const char *value)
1094 /* This needs a better name */
1095 if (!strcmp(var, "core.filemode")) {
1096 trust_executable_bit = git_config_bool(var, value);
1097 return 0;
1099 if (!strcmp(var, "core.trustctime")) {
1100 trust_ctime = git_config_bool(var, value);
1101 return 0;
1103 if (!strcmp(var, "core.checkstat")) {
1104 if (!strcasecmp(value, "default"))
1105 check_stat = 1;
1106 else if (!strcasecmp(value, "minimal"))
1107 check_stat = 0;
1110 if (!strcmp(var, "core.quotepath")) {
1111 quote_path_fully = git_config_bool(var, value);
1112 return 0;
1115 if (!strcmp(var, "core.symlinks")) {
1116 has_symlinks = git_config_bool(var, value);
1117 return 0;
1120 if (!strcmp(var, "core.ignorecase")) {
1121 ignore_case = git_config_bool(var, value);
1122 return 0;
1125 if (!strcmp(var, "core.attributesfile"))
1126 return git_config_pathname(&git_attributes_file, var, value);
1128 if (!strcmp(var, "core.hookspath"))
1129 return git_config_pathname(&git_hooks_path, var, value);
1131 if (!strcmp(var, "core.bare")) {
1132 is_bare_repository_cfg = git_config_bool(var, value);
1133 return 0;
1136 if (!strcmp(var, "core.ignorestat")) {
1137 assume_unchanged = git_config_bool(var, value);
1138 return 0;
1141 if (!strcmp(var, "core.prefersymlinkrefs")) {
1142 prefer_symlink_refs = git_config_bool(var, value);
1143 return 0;
1146 if (!strcmp(var, "core.logallrefupdates")) {
1147 if (value && !strcasecmp(value, "always"))
1148 log_all_ref_updates = LOG_REFS_ALWAYS;
1149 else if (git_config_bool(var, value))
1150 log_all_ref_updates = LOG_REFS_NORMAL;
1151 else
1152 log_all_ref_updates = LOG_REFS_NONE;
1153 return 0;
1156 if (!strcmp(var, "core.warnambiguousrefs")) {
1157 warn_ambiguous_refs = git_config_bool(var, value);
1158 return 0;
1161 if (!strcmp(var, "core.abbrev")) {
1162 if (!value)
1163 return config_error_nonbool(var);
1164 if (!strcasecmp(value, "auto"))
1165 default_abbrev = -1;
1166 else {
1167 int abbrev = git_config_int(var, value);
1168 if (abbrev < minimum_abbrev || abbrev > 40)
1169 return error(_("abbrev length out of range: %d"), abbrev);
1170 default_abbrev = abbrev;
1172 return 0;
1175 if (!strcmp(var, "core.disambiguate"))
1176 return set_disambiguate_hint_config(var, value);
1178 if (!strcmp(var, "core.loosecompression")) {
1179 int level = git_config_int(var, value);
1180 if (level == -1)
1181 level = Z_DEFAULT_COMPRESSION;
1182 else if (level < 0 || level > Z_BEST_COMPRESSION)
1183 die(_("bad zlib compression level %d"), level);
1184 zlib_compression_level = level;
1185 zlib_compression_seen = 1;
1186 return 0;
1189 if (!strcmp(var, "core.compression")) {
1190 int level = git_config_int(var, value);
1191 if (level == -1)
1192 level = Z_DEFAULT_COMPRESSION;
1193 else if (level < 0 || level > Z_BEST_COMPRESSION)
1194 die(_("bad zlib compression level %d"), level);
1195 core_compression_level = level;
1196 core_compression_seen = 1;
1197 if (!zlib_compression_seen)
1198 zlib_compression_level = level;
1199 if (!pack_compression_seen)
1200 pack_compression_level = level;
1201 return 0;
1204 if (!strcmp(var, "core.packedgitwindowsize")) {
1205 int pgsz_x2 = getpagesize() * 2;
1206 packed_git_window_size = git_config_ulong(var, value);
1208 /* This value must be multiple of (pagesize * 2) */
1209 packed_git_window_size /= pgsz_x2;
1210 if (packed_git_window_size < 1)
1211 packed_git_window_size = 1;
1212 packed_git_window_size *= pgsz_x2;
1213 return 0;
1216 if (!strcmp(var, "core.bigfilethreshold")) {
1217 big_file_threshold = git_config_ulong(var, value);
1218 return 0;
1221 if (!strcmp(var, "core.packedgitlimit")) {
1222 packed_git_limit = git_config_ulong(var, value);
1223 return 0;
1226 if (!strcmp(var, "core.deltabasecachelimit")) {
1227 delta_base_cache_limit = git_config_ulong(var, value);
1228 return 0;
1231 if (!strcmp(var, "core.autocrlf")) {
1232 if (value && !strcasecmp(value, "input")) {
1233 auto_crlf = AUTO_CRLF_INPUT;
1234 return 0;
1236 auto_crlf = git_config_bool(var, value);
1237 return 0;
1240 if (!strcmp(var, "core.safecrlf")) {
1241 int eol_rndtrp_die;
1242 if (value && !strcasecmp(value, "warn")) {
1243 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1244 return 0;
1246 eol_rndtrp_die = git_config_bool(var, value);
1247 global_conv_flags_eol = eol_rndtrp_die ?
1248 CONV_EOL_RNDTRP_DIE : 0;
1249 return 0;
1252 if (!strcmp(var, "core.eol")) {
1253 if (value && !strcasecmp(value, "lf"))
1254 core_eol = EOL_LF;
1255 else if (value && !strcasecmp(value, "crlf"))
1256 core_eol = EOL_CRLF;
1257 else if (value && !strcasecmp(value, "native"))
1258 core_eol = EOL_NATIVE;
1259 else
1260 core_eol = EOL_UNSET;
1261 return 0;
1264 if (!strcmp(var, "core.checkroundtripencoding")) {
1265 check_roundtrip_encoding = xstrdup(value);
1266 return 0;
1269 if (!strcmp(var, "core.notesref")) {
1270 notes_ref_name = xstrdup(value);
1271 return 0;
1274 if (!strcmp(var, "core.editor"))
1275 return git_config_string(&editor_program, var, value);
1277 if (!strcmp(var, "core.commentchar")) {
1278 if (!value)
1279 return config_error_nonbool(var);
1280 else if (!strcasecmp(value, "auto"))
1281 auto_comment_line_char = 1;
1282 else if (value[0] && !value[1]) {
1283 comment_line_char = value[0];
1284 auto_comment_line_char = 0;
1285 } else
1286 return error(_("core.commentChar should only be one character"));
1287 return 0;
1290 if (!strcmp(var, "core.askpass"))
1291 return git_config_string(&askpass_program, var, value);
1293 if (!strcmp(var, "core.excludesfile"))
1294 return git_config_pathname(&excludes_file, var, value);
1296 if (!strcmp(var, "core.whitespace")) {
1297 if (!value)
1298 return config_error_nonbool(var);
1299 whitespace_rule_cfg = parse_whitespace_rule(value);
1300 return 0;
1303 if (!strcmp(var, "core.fsyncobjectfiles")) {
1304 fsync_object_files = git_config_bool(var, value);
1305 return 0;
1308 if (!strcmp(var, "core.preloadindex")) {
1309 core_preload_index = git_config_bool(var, value);
1310 return 0;
1313 if (!strcmp(var, "core.createobject")) {
1314 if (!strcmp(value, "rename"))
1315 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1316 else if (!strcmp(value, "link"))
1317 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1318 else
1319 die(_("invalid mode for object creation: %s"), value);
1320 return 0;
1323 if (!strcmp(var, "core.sparsecheckout")) {
1324 core_apply_sparse_checkout = git_config_bool(var, value);
1325 return 0;
1328 if (!strcmp(var, "core.precomposeunicode")) {
1329 precomposed_unicode = git_config_bool(var, value);
1330 return 0;
1333 if (!strcmp(var, "core.protecthfs")) {
1334 protect_hfs = git_config_bool(var, value);
1335 return 0;
1338 if (!strcmp(var, "core.protectntfs")) {
1339 protect_ntfs = git_config_bool(var, value);
1340 return 0;
1343 if (!strcmp(var, "core.hidedotfiles")) {
1344 if (value && !strcasecmp(value, "dotgitonly"))
1345 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1346 else
1347 hide_dotfiles = git_config_bool(var, value);
1348 return 0;
1351 if (!strcmp(var, "core.partialclonefilter")) {
1352 return git_config_string(&core_partial_clone_filter_default,
1353 var, value);
1356 if (!strcmp(var, "core.usereplacerefs")) {
1357 read_replace_refs = git_config_bool(var, value);
1358 return 0;
1361 /* Add other config variables here and to Documentation/config.txt. */
1362 return 0;
1365 static int git_default_i18n_config(const char *var, const char *value)
1367 if (!strcmp(var, "i18n.commitencoding"))
1368 return git_config_string(&git_commit_encoding, var, value);
1370 if (!strcmp(var, "i18n.logoutputencoding"))
1371 return git_config_string(&git_log_output_encoding, var, value);
1373 /* Add other config variables here and to Documentation/config.txt. */
1374 return 0;
1377 static int git_default_branch_config(const char *var, const char *value)
1379 if (!strcmp(var, "branch.autosetupmerge")) {
1380 if (value && !strcasecmp(value, "always")) {
1381 git_branch_track = BRANCH_TRACK_ALWAYS;
1382 return 0;
1384 git_branch_track = git_config_bool(var, value);
1385 return 0;
1387 if (!strcmp(var, "branch.autosetuprebase")) {
1388 if (!value)
1389 return config_error_nonbool(var);
1390 else if (!strcmp(value, "never"))
1391 autorebase = AUTOREBASE_NEVER;
1392 else if (!strcmp(value, "local"))
1393 autorebase = AUTOREBASE_LOCAL;
1394 else if (!strcmp(value, "remote"))
1395 autorebase = AUTOREBASE_REMOTE;
1396 else if (!strcmp(value, "always"))
1397 autorebase = AUTOREBASE_ALWAYS;
1398 else
1399 return error(_("malformed value for %s"), var);
1400 return 0;
1403 /* Add other config variables here and to Documentation/config.txt. */
1404 return 0;
1407 static int git_default_push_config(const char *var, const char *value)
1409 if (!strcmp(var, "push.default")) {
1410 if (!value)
1411 return config_error_nonbool(var);
1412 else if (!strcmp(value, "nothing"))
1413 push_default = PUSH_DEFAULT_NOTHING;
1414 else if (!strcmp(value, "matching"))
1415 push_default = PUSH_DEFAULT_MATCHING;
1416 else if (!strcmp(value, "simple"))
1417 push_default = PUSH_DEFAULT_SIMPLE;
1418 else if (!strcmp(value, "upstream"))
1419 push_default = PUSH_DEFAULT_UPSTREAM;
1420 else if (!strcmp(value, "tracking")) /* deprecated */
1421 push_default = PUSH_DEFAULT_UPSTREAM;
1422 else if (!strcmp(value, "current"))
1423 push_default = PUSH_DEFAULT_CURRENT;
1424 else {
1425 error(_("malformed value for %s: %s"), var, value);
1426 return error(_("must be one of nothing, matching, simple, "
1427 "upstream or current"));
1429 return 0;
1432 /* Add other config variables here and to Documentation/config.txt. */
1433 return 0;
1436 static int git_default_mailmap_config(const char *var, const char *value)
1438 if (!strcmp(var, "mailmap.file"))
1439 return git_config_pathname(&git_mailmap_file, var, value);
1440 if (!strcmp(var, "mailmap.blob"))
1441 return git_config_string(&git_mailmap_blob, var, value);
1443 /* Add other config variables here and to Documentation/config.txt. */
1444 return 0;
1447 int git_default_config(const char *var, const char *value, void *dummy)
1449 if (starts_with(var, "core."))
1450 return git_default_core_config(var, value);
1452 if (starts_with(var, "user."))
1453 return git_ident_config(var, value, dummy);
1455 if (starts_with(var, "i18n."))
1456 return git_default_i18n_config(var, value);
1458 if (starts_with(var, "branch."))
1459 return git_default_branch_config(var, value);
1461 if (starts_with(var, "push."))
1462 return git_default_push_config(var, value);
1464 if (starts_with(var, "mailmap."))
1465 return git_default_mailmap_config(var, value);
1467 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1468 return git_default_advice_config(var, value);
1470 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1471 pager_use_color = git_config_bool(var,value);
1472 return 0;
1475 if (!strcmp(var, "pack.packsizelimit")) {
1476 pack_size_limit_cfg = git_config_ulong(var, value);
1477 return 0;
1480 if (!strcmp(var, "pack.compression")) {
1481 int level = git_config_int(var, value);
1482 if (level == -1)
1483 level = Z_DEFAULT_COMPRESSION;
1484 else if (level < 0 || level > Z_BEST_COMPRESSION)
1485 die(_("bad pack compression level %d"), level);
1486 pack_compression_level = level;
1487 pack_compression_seen = 1;
1488 return 0;
1491 /* Add other config variables here and to Documentation/config.txt. */
1492 return 0;
1496 * All source specific fields in the union, die_on_error, name and the callbacks
1497 * fgetc, ungetc, ftell of top need to be initialized before calling
1498 * this function.
1500 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1501 const struct config_options *opts)
1503 int ret;
1505 /* push config-file parsing state stack */
1506 top->prev = cf;
1507 top->linenr = 1;
1508 top->eof = 0;
1509 strbuf_init(&top->value, 1024);
1510 strbuf_init(&top->var, 1024);
1511 cf = top;
1513 ret = git_parse_source(fn, data, opts);
1515 /* pop config-file parsing state stack */
1516 strbuf_release(&top->value);
1517 strbuf_release(&top->var);
1518 cf = top->prev;
1520 return ret;
1523 static int do_config_from_file(config_fn_t fn,
1524 const enum config_origin_type origin_type,
1525 const char *name, const char *path, FILE *f,
1526 void *data, const struct config_options *opts)
1528 struct config_source top;
1529 int ret;
1531 top.u.file = f;
1532 top.origin_type = origin_type;
1533 top.name = name;
1534 top.path = path;
1535 top.default_error_action = CONFIG_ERROR_DIE;
1536 top.do_fgetc = config_file_fgetc;
1537 top.do_ungetc = config_file_ungetc;
1538 top.do_ftell = config_file_ftell;
1540 flockfile(f);
1541 ret = do_config_from(&top, fn, data, opts);
1542 funlockfile(f);
1543 return ret;
1546 static int git_config_from_stdin(config_fn_t fn, void *data)
1548 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1549 data, NULL);
1552 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1553 void *data,
1554 const struct config_options *opts)
1556 int ret = -1;
1557 FILE *f;
1559 f = fopen_or_warn(filename, "r");
1560 if (f) {
1561 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1562 filename, f, data, opts);
1563 fclose(f);
1565 return ret;
1568 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1570 return git_config_from_file_with_options(fn, filename, data, NULL);
1573 int git_config_from_mem(config_fn_t fn,
1574 const enum config_origin_type origin_type,
1575 const char *name, const char *buf, size_t len,
1576 void *data, const struct config_options *opts)
1578 struct config_source top;
1580 top.u.buf.buf = buf;
1581 top.u.buf.len = len;
1582 top.u.buf.pos = 0;
1583 top.origin_type = origin_type;
1584 top.name = name;
1585 top.path = NULL;
1586 top.default_error_action = CONFIG_ERROR_ERROR;
1587 top.do_fgetc = config_buf_fgetc;
1588 top.do_ungetc = config_buf_ungetc;
1589 top.do_ftell = config_buf_ftell;
1591 return do_config_from(&top, fn, data, opts);
1594 int git_config_from_blob_oid(config_fn_t fn,
1595 const char *name,
1596 const struct object_id *oid,
1597 void *data)
1599 enum object_type type;
1600 char *buf;
1601 unsigned long size;
1602 int ret;
1604 buf = read_object_file(oid, &type, &size);
1605 if (!buf)
1606 return error(_("unable to load config blob object '%s'"), name);
1607 if (type != OBJ_BLOB) {
1608 free(buf);
1609 return error(_("reference '%s' does not point to a blob"), name);
1612 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1613 data, NULL);
1614 free(buf);
1616 return ret;
1619 static int git_config_from_blob_ref(config_fn_t fn,
1620 const char *name,
1621 void *data)
1623 struct object_id oid;
1625 if (get_oid(name, &oid) < 0)
1626 return error(_("unable to resolve config blob '%s'"), name);
1627 return git_config_from_blob_oid(fn, name, &oid, data);
1630 const char *git_etc_gitconfig(void)
1632 static const char *system_wide;
1633 if (!system_wide)
1634 system_wide = system_path(ETC_GITCONFIG);
1635 return system_wide;
1639 * Parse environment variable 'k' as a boolean (in various
1640 * possible spellings); if missing, use the default value 'def'.
1642 int git_env_bool(const char *k, int def)
1644 const char *v = getenv(k);
1645 return v ? git_config_bool(k, v) : def;
1649 * Parse environment variable 'k' as ulong with possibly a unit
1650 * suffix; if missing, use the default value 'val'.
1652 unsigned long git_env_ulong(const char *k, unsigned long val)
1654 const char *v = getenv(k);
1655 if (v && !git_parse_ulong(v, &val))
1656 die(_("failed to parse %s"), k);
1657 return val;
1660 int git_config_system(void)
1662 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1665 static int do_git_config_sequence(const struct config_options *opts,
1666 config_fn_t fn, void *data)
1668 int ret = 0;
1669 char *xdg_config = xdg_config_home("config");
1670 char *user_config = expand_user_path("~/.gitconfig", 0);
1671 char *repo_config;
1673 if (opts->commondir)
1674 repo_config = mkpathdup("%s/config", opts->commondir);
1675 else
1676 repo_config = NULL;
1678 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1679 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1680 ret += git_config_from_file(fn, git_etc_gitconfig(),
1681 data);
1683 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1684 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1685 ret += git_config_from_file(fn, xdg_config, data);
1687 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1688 ret += git_config_from_file(fn, user_config, data);
1690 current_parsing_scope = CONFIG_SCOPE_REPO;
1691 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1692 ret += git_config_from_file(fn, repo_config, data);
1694 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1695 if (git_config_from_parameters(fn, data) < 0)
1696 die(_("unable to parse command-line config"));
1698 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1699 free(xdg_config);
1700 free(user_config);
1701 free(repo_config);
1702 return ret;
1705 int config_with_options(config_fn_t fn, void *data,
1706 struct git_config_source *config_source,
1707 const struct config_options *opts)
1709 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1711 if (opts->respect_includes) {
1712 inc.fn = fn;
1713 inc.data = data;
1714 inc.opts = opts;
1715 fn = git_config_include;
1716 data = &inc;
1720 * If we have a specific filename, use it. Otherwise, follow the
1721 * regular lookup sequence.
1723 if (config_source && config_source->use_stdin)
1724 return git_config_from_stdin(fn, data);
1725 else if (config_source && config_source->file)
1726 return git_config_from_file(fn, config_source->file, data);
1727 else if (config_source && config_source->blob)
1728 return git_config_from_blob_ref(fn, config_source->blob, data);
1730 return do_git_config_sequence(opts, fn, data);
1733 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1735 int i, value_index;
1736 struct string_list *values;
1737 struct config_set_element *entry;
1738 struct configset_list *list = &cs->list;
1740 for (i = 0; i < list->nr; i++) {
1741 entry = list->items[i].e;
1742 value_index = list->items[i].value_index;
1743 values = &entry->value_list;
1745 current_config_kvi = values->items[value_index].util;
1747 if (fn(entry->key, values->items[value_index].string, data) < 0)
1748 git_die_config_linenr(entry->key,
1749 current_config_kvi->filename,
1750 current_config_kvi->linenr);
1752 current_config_kvi = NULL;
1756 void read_early_config(config_fn_t cb, void *data)
1758 struct config_options opts = {0};
1759 struct strbuf commondir = STRBUF_INIT;
1760 struct strbuf gitdir = STRBUF_INIT;
1762 opts.respect_includes = 1;
1764 if (have_git_dir()) {
1765 opts.commondir = get_git_common_dir();
1766 opts.git_dir = get_git_dir();
1768 * When setup_git_directory() was not yet asked to discover the
1769 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1770 * is any repository config we should use (but unlike
1771 * setup_git_directory_gently(), no global state is changed, most
1772 * notably, the current working directory is still the same after the
1773 * call).
1775 } else if (!discover_git_directory(&commondir, &gitdir)) {
1776 opts.commondir = commondir.buf;
1777 opts.git_dir = gitdir.buf;
1780 config_with_options(cb, data, NULL, &opts);
1782 strbuf_release(&commondir);
1783 strbuf_release(&gitdir);
1786 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1788 struct config_set_element k;
1789 struct config_set_element *found_entry;
1790 char *normalized_key;
1792 * `key` may come from the user, so normalize it before using it
1793 * for querying entries from the hashmap.
1795 if (git_config_parse_key(key, &normalized_key, NULL))
1796 return NULL;
1798 hashmap_entry_init(&k, strhash(normalized_key));
1799 k.key = normalized_key;
1800 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1801 free(normalized_key);
1802 return found_entry;
1805 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1807 struct config_set_element *e;
1808 struct string_list_item *si;
1809 struct configset_list_item *l_item;
1810 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1812 e = configset_find_element(cs, key);
1814 * Since the keys are being fed by git_config*() callback mechanism, they
1815 * are already normalized. So simply add them without any further munging.
1817 if (!e) {
1818 e = xmalloc(sizeof(*e));
1819 hashmap_entry_init(e, strhash(key));
1820 e->key = xstrdup(key);
1821 string_list_init(&e->value_list, 1);
1822 hashmap_add(&cs->config_hash, e);
1824 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1826 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1827 l_item = &cs->list.items[cs->list.nr++];
1828 l_item->e = e;
1829 l_item->value_index = e->value_list.nr - 1;
1831 if (!cf)
1832 BUG("configset_add_value has no source");
1833 if (cf->name) {
1834 kv_info->filename = strintern(cf->name);
1835 kv_info->linenr = cf->linenr;
1836 kv_info->origin_type = cf->origin_type;
1837 } else {
1838 /* for values read from `git_config_from_parameters()` */
1839 kv_info->filename = NULL;
1840 kv_info->linenr = -1;
1841 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1843 kv_info->scope = current_parsing_scope;
1844 si->util = kv_info;
1846 return 0;
1849 static int config_set_element_cmp(const void *unused_cmp_data,
1850 const void *entry,
1851 const void *entry_or_key,
1852 const void *unused_keydata)
1854 const struct config_set_element *e1 = entry;
1855 const struct config_set_element *e2 = entry_or_key;
1857 return strcmp(e1->key, e2->key);
1860 void git_configset_init(struct config_set *cs)
1862 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1863 cs->hash_initialized = 1;
1864 cs->list.nr = 0;
1865 cs->list.alloc = 0;
1866 cs->list.items = NULL;
1869 void git_configset_clear(struct config_set *cs)
1871 struct config_set_element *entry;
1872 struct hashmap_iter iter;
1873 if (!cs->hash_initialized)
1874 return;
1876 hashmap_iter_init(&cs->config_hash, &iter);
1877 while ((entry = hashmap_iter_next(&iter))) {
1878 free(entry->key);
1879 string_list_clear(&entry->value_list, 1);
1881 hashmap_free(&cs->config_hash, 1);
1882 cs->hash_initialized = 0;
1883 free(cs->list.items);
1884 cs->list.nr = 0;
1885 cs->list.alloc = 0;
1886 cs->list.items = NULL;
1889 static int config_set_callback(const char *key, const char *value, void *cb)
1891 struct config_set *cs = cb;
1892 configset_add_value(cs, key, value);
1893 return 0;
1896 int git_configset_add_file(struct config_set *cs, const char *filename)
1898 return git_config_from_file(config_set_callback, filename, cs);
1901 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1903 const struct string_list *values = NULL;
1905 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1906 * queried key in the files of the configset, the value returned will be the last
1907 * value in the value list for that key.
1909 values = git_configset_get_value_multi(cs, key);
1911 if (!values)
1912 return 1;
1913 assert(values->nr > 0);
1914 *value = values->items[values->nr - 1].string;
1915 return 0;
1918 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1920 struct config_set_element *e = configset_find_element(cs, key);
1921 return e ? &e->value_list : NULL;
1924 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1926 const char *value;
1927 if (!git_configset_get_value(cs, key, &value))
1928 return git_config_string(dest, key, value);
1929 else
1930 return 1;
1933 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1935 return git_configset_get_string_const(cs, key, (const char **)dest);
1938 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1940 const char *value;
1941 if (!git_configset_get_value(cs, key, &value)) {
1942 *dest = git_config_int(key, value);
1943 return 0;
1944 } else
1945 return 1;
1948 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1950 const char *value;
1951 if (!git_configset_get_value(cs, key, &value)) {
1952 *dest = git_config_ulong(key, value);
1953 return 0;
1954 } else
1955 return 1;
1958 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1960 const char *value;
1961 if (!git_configset_get_value(cs, key, &value)) {
1962 *dest = git_config_bool(key, value);
1963 return 0;
1964 } else
1965 return 1;
1968 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1969 int *is_bool, int *dest)
1971 const char *value;
1972 if (!git_configset_get_value(cs, key, &value)) {
1973 *dest = git_config_bool_or_int(key, value, is_bool);
1974 return 0;
1975 } else
1976 return 1;
1979 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1981 const char *value;
1982 if (!git_configset_get_value(cs, key, &value)) {
1983 *dest = git_parse_maybe_bool(value);
1984 if (*dest == -1)
1985 return -1;
1986 return 0;
1987 } else
1988 return 1;
1991 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1993 const char *value;
1994 if (!git_configset_get_value(cs, key, &value))
1995 return git_config_pathname(dest, key, value);
1996 else
1997 return 1;
2000 /* Functions use to read configuration from a repository */
2001 static void repo_read_config(struct repository *repo)
2003 struct config_options opts;
2005 opts.respect_includes = 1;
2006 opts.commondir = repo->commondir;
2007 opts.git_dir = repo->gitdir;
2009 if (!repo->config)
2010 repo->config = xcalloc(1, sizeof(struct config_set));
2011 else
2012 git_configset_clear(repo->config);
2014 git_configset_init(repo->config);
2016 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2018 * config_with_options() normally returns only
2019 * zero, as most errors are fatal, and
2020 * non-fatal potential errors are guarded by "if"
2021 * statements that are entered only when no error is
2022 * possible.
2024 * If we ever encounter a non-fatal error, it means
2025 * something went really wrong and we should stop
2026 * immediately.
2028 die(_("unknown error occurred while reading the configuration files"));
2031 static void git_config_check_init(struct repository *repo)
2033 if (repo->config && repo->config->hash_initialized)
2034 return;
2035 repo_read_config(repo);
2038 static void repo_config_clear(struct repository *repo)
2040 if (!repo->config || !repo->config->hash_initialized)
2041 return;
2042 git_configset_clear(repo->config);
2045 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2047 git_config_check_init(repo);
2048 configset_iter(repo->config, fn, data);
2051 int repo_config_get_value(struct repository *repo,
2052 const char *key, const char **value)
2054 git_config_check_init(repo);
2055 return git_configset_get_value(repo->config, key, value);
2058 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2059 const char *key)
2061 git_config_check_init(repo);
2062 return git_configset_get_value_multi(repo->config, key);
2065 int repo_config_get_string_const(struct repository *repo,
2066 const char *key, const char **dest)
2068 int ret;
2069 git_config_check_init(repo);
2070 ret = git_configset_get_string_const(repo->config, key, dest);
2071 if (ret < 0)
2072 git_die_config(key, NULL);
2073 return ret;
2076 int repo_config_get_string(struct repository *repo,
2077 const char *key, char **dest)
2079 git_config_check_init(repo);
2080 return repo_config_get_string_const(repo, key, (const char **)dest);
2083 int repo_config_get_int(struct repository *repo,
2084 const char *key, int *dest)
2086 git_config_check_init(repo);
2087 return git_configset_get_int(repo->config, key, dest);
2090 int repo_config_get_ulong(struct repository *repo,
2091 const char *key, unsigned long *dest)
2093 git_config_check_init(repo);
2094 return git_configset_get_ulong(repo->config, key, dest);
2097 int repo_config_get_bool(struct repository *repo,
2098 const char *key, int *dest)
2100 git_config_check_init(repo);
2101 return git_configset_get_bool(repo->config, key, dest);
2104 int repo_config_get_bool_or_int(struct repository *repo,
2105 const char *key, int *is_bool, int *dest)
2107 git_config_check_init(repo);
2108 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2111 int repo_config_get_maybe_bool(struct repository *repo,
2112 const char *key, int *dest)
2114 git_config_check_init(repo);
2115 return git_configset_get_maybe_bool(repo->config, key, dest);
2118 int repo_config_get_pathname(struct repository *repo,
2119 const char *key, const char **dest)
2121 int ret;
2122 git_config_check_init(repo);
2123 ret = git_configset_get_pathname(repo->config, key, dest);
2124 if (ret < 0)
2125 git_die_config(key, NULL);
2126 return ret;
2129 /* Functions used historically to read configuration from 'the_repository' */
2130 void git_config(config_fn_t fn, void *data)
2132 repo_config(the_repository, fn, data);
2135 void git_config_clear(void)
2137 repo_config_clear(the_repository);
2140 int git_config_get_value(const char *key, const char **value)
2142 return repo_config_get_value(the_repository, key, value);
2145 const struct string_list *git_config_get_value_multi(const char *key)
2147 return repo_config_get_value_multi(the_repository, key);
2150 int git_config_get_string_const(const char *key, const char **dest)
2152 return repo_config_get_string_const(the_repository, key, dest);
2155 int git_config_get_string(const char *key, char **dest)
2157 return repo_config_get_string(the_repository, key, dest);
2160 int git_config_get_int(const char *key, int *dest)
2162 return repo_config_get_int(the_repository, key, dest);
2165 int git_config_get_ulong(const char *key, unsigned long *dest)
2167 return repo_config_get_ulong(the_repository, key, dest);
2170 int git_config_get_bool(const char *key, int *dest)
2172 return repo_config_get_bool(the_repository, key, dest);
2175 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2177 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2180 int git_config_get_maybe_bool(const char *key, int *dest)
2182 return repo_config_get_maybe_bool(the_repository, key, dest);
2185 int git_config_get_pathname(const char *key, const char **dest)
2187 return repo_config_get_pathname(the_repository, key, dest);
2190 int git_config_get_expiry(const char *key, const char **output)
2192 int ret = git_config_get_string_const(key, output);
2193 if (ret)
2194 return ret;
2195 if (strcmp(*output, "now")) {
2196 timestamp_t now = approxidate("now");
2197 if (approxidate(*output) >= now)
2198 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2200 return ret;
2203 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2205 char *expiry_string;
2206 intmax_t days;
2207 timestamp_t when;
2209 if (git_config_get_string(key, &expiry_string))
2210 return 1; /* no such thing */
2212 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2213 const int scale = 86400;
2214 *expiry = now - days * scale;
2215 return 0;
2218 if (!parse_expiry_date(expiry_string, &when)) {
2219 *expiry = when;
2220 return 0;
2222 return -1; /* thing exists but cannot be parsed */
2225 int git_config_get_untracked_cache(void)
2227 int val = -1;
2228 const char *v;
2230 /* Hack for test programs like test-dump-untracked-cache */
2231 if (ignore_untracked_cache_config)
2232 return -1;
2234 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2235 return val;
2237 if (!git_config_get_value("core.untrackedcache", &v)) {
2238 if (!strcasecmp(v, "keep"))
2239 return -1;
2241 error(_("unknown core.untrackedCache value '%s'; "
2242 "using 'keep' default value"), v);
2243 return -1;
2246 return -1; /* default value */
2249 int git_config_get_split_index(void)
2251 int val;
2253 if (!git_config_get_maybe_bool("core.splitindex", &val))
2254 return val;
2256 return -1; /* default value */
2259 int git_config_get_max_percent_split_change(void)
2261 int val = -1;
2263 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2264 if (0 <= val && val <= 100)
2265 return val;
2267 return error(_("splitIndex.maxPercentChange value '%d' "
2268 "should be between 0 and 100"), val);
2271 return -1; /* default value */
2274 int git_config_get_fsmonitor(void)
2276 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2277 core_fsmonitor = getenv("GIT_FSMONITOR_TEST");
2279 if (core_fsmonitor && !*core_fsmonitor)
2280 core_fsmonitor = NULL;
2282 if (core_fsmonitor)
2283 return 1;
2285 return 0;
2288 NORETURN
2289 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2291 if (!filename)
2292 die(_("unable to parse '%s' from command-line config"), key);
2293 else
2294 die(_("bad config variable '%s' in file '%s' at line %d"),
2295 key, filename, linenr);
2298 NORETURN __attribute__((format(printf, 2, 3)))
2299 void git_die_config(const char *key, const char *err, ...)
2301 const struct string_list *values;
2302 struct key_value_info *kv_info;
2304 if (err) {
2305 va_list params;
2306 va_start(params, err);
2307 vreportf("error: ", err, params);
2308 va_end(params);
2310 values = git_config_get_value_multi(key);
2311 kv_info = values->items[values->nr - 1].util;
2312 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2316 * Find all the stuff for git_config_set() below.
2319 struct config_store_data {
2320 int baselen;
2321 char *key;
2322 int do_not_match;
2323 regex_t *value_regex;
2324 int multi_replace;
2325 struct {
2326 size_t begin, end;
2327 enum config_event_t type;
2328 int is_keys_section;
2329 } *parsed;
2330 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2331 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2334 static void config_store_data_clear(struct config_store_data *store)
2336 free(store->key);
2337 if (store->value_regex != NULL &&
2338 store->value_regex != CONFIG_REGEX_NONE) {
2339 regfree(store->value_regex);
2340 free(store->value_regex);
2342 free(store->parsed);
2343 free(store->seen);
2344 memset(store, 0, sizeof(*store));
2347 static int matches(const char *key, const char *value,
2348 const struct config_store_data *store)
2350 if (strcmp(key, store->key))
2351 return 0; /* not ours */
2352 if (!store->value_regex)
2353 return 1; /* always matches */
2354 if (store->value_regex == CONFIG_REGEX_NONE)
2355 return 0; /* never matches */
2357 return store->do_not_match ^
2358 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2361 static int store_aux_event(enum config_event_t type,
2362 size_t begin, size_t end, void *data)
2364 struct config_store_data *store = data;
2366 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2367 store->parsed[store->parsed_nr].begin = begin;
2368 store->parsed[store->parsed_nr].end = end;
2369 store->parsed[store->parsed_nr].type = type;
2371 if (type == CONFIG_EVENT_SECTION) {
2372 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2373 return error(_("invalid section name '%s'"), cf->var.buf);
2375 /* Is this the section we were looking for? */
2376 store->is_keys_section =
2377 store->parsed[store->parsed_nr].is_keys_section =
2378 cf->var.len - 1 == store->baselen &&
2379 !strncasecmp(cf->var.buf, store->key, store->baselen);
2380 if (store->is_keys_section) {
2381 store->section_seen = 1;
2382 ALLOC_GROW(store->seen, store->seen_nr + 1,
2383 store->seen_alloc);
2384 store->seen[store->seen_nr] = store->parsed_nr;
2388 store->parsed_nr++;
2390 return 0;
2393 static int store_aux(const char *key, const char *value, void *cb)
2395 struct config_store_data *store = cb;
2397 if (store->key_seen) {
2398 if (matches(key, value, store)) {
2399 if (store->seen_nr == 1 && store->multi_replace == 0) {
2400 warning(_("%s has multiple values"), key);
2403 ALLOC_GROW(store->seen, store->seen_nr + 1,
2404 store->seen_alloc);
2406 store->seen[store->seen_nr] = store->parsed_nr;
2407 store->seen_nr++;
2409 } else if (store->is_keys_section) {
2411 * Do not increment matches yet: this may not be a match, but we
2412 * are in the desired section.
2414 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2415 store->seen[store->seen_nr] = store->parsed_nr;
2416 store->section_seen = 1;
2418 if (matches(key, value, store)) {
2419 store->seen_nr++;
2420 store->key_seen = 1;
2424 return 0;
2427 static int write_error(const char *filename)
2429 error(_("failed to write new configuration file %s"), filename);
2431 /* Same error code as "failed to rename". */
2432 return 4;
2435 static struct strbuf store_create_section(const char *key,
2436 const struct config_store_data *store)
2438 const char *dot;
2439 int i;
2440 struct strbuf sb = STRBUF_INIT;
2442 dot = memchr(key, '.', store->baselen);
2443 if (dot) {
2444 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2445 for (i = dot - key + 1; i < store->baselen; i++) {
2446 if (key[i] == '"' || key[i] == '\\')
2447 strbuf_addch(&sb, '\\');
2448 strbuf_addch(&sb, key[i]);
2450 strbuf_addstr(&sb, "\"]\n");
2451 } else {
2452 strbuf_addf(&sb, "[%.*s]\n", store->baselen, key);
2455 return sb;
2458 static ssize_t write_section(int fd, const char *key,
2459 const struct config_store_data *store)
2461 struct strbuf sb = store_create_section(key, store);
2462 ssize_t ret;
2464 ret = write_in_full(fd, sb.buf, sb.len);
2465 strbuf_release(&sb);
2467 return ret;
2470 static ssize_t write_pair(int fd, const char *key, const char *value,
2471 const struct config_store_data *store)
2473 int i;
2474 ssize_t ret;
2475 int length = strlen(key + store->baselen + 1);
2476 const char *quote = "";
2477 struct strbuf sb = STRBUF_INIT;
2480 * Check to see if the value needs to be surrounded with a dq pair.
2481 * Note that problematic characters are always backslash-quoted; this
2482 * check is about not losing leading or trailing SP and strings that
2483 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2484 * configuration parser.
2486 if (value[0] == ' ')
2487 quote = "\"";
2488 for (i = 0; value[i]; i++)
2489 if (value[i] == ';' || value[i] == '#')
2490 quote = "\"";
2491 if (i && value[i - 1] == ' ')
2492 quote = "\"";
2494 strbuf_addf(&sb, "\t%.*s = %s",
2495 length, key + store->baselen + 1, quote);
2497 for (i = 0; value[i]; i++)
2498 switch (value[i]) {
2499 case '\n':
2500 strbuf_addstr(&sb, "\\n");
2501 break;
2502 case '\t':
2503 strbuf_addstr(&sb, "\\t");
2504 break;
2505 case '"':
2506 case '\\':
2507 strbuf_addch(&sb, '\\');
2508 /* fallthrough */
2509 default:
2510 strbuf_addch(&sb, value[i]);
2511 break;
2513 strbuf_addf(&sb, "%s\n", quote);
2515 ret = write_in_full(fd, sb.buf, sb.len);
2516 strbuf_release(&sb);
2518 return ret;
2522 * If we are about to unset the last key(s) in a section, and if there are
2523 * no comments surrounding (or included in) the section, we will want to
2524 * extend begin/end to remove the entire section.
2526 * Note: the parameter `seen_ptr` points to the index into the store.seen
2527 * array. * This index may be incremented if a section has more than one
2528 * entry (which all are to be removed).
2530 static void maybe_remove_section(struct config_store_data *store,
2531 const char *contents,
2532 size_t *begin_offset, size_t *end_offset,
2533 int *seen_ptr)
2535 size_t begin;
2536 int i, seen, section_seen = 0;
2539 * First, ensure that this is the first key, and that there are no
2540 * comments before the entry nor before the section header.
2542 seen = *seen_ptr;
2543 for (i = store->seen[seen]; i > 0; i--) {
2544 enum config_event_t type = store->parsed[i - 1].type;
2546 if (type == CONFIG_EVENT_COMMENT)
2547 /* There is a comment before this entry or section */
2548 return;
2549 if (type == CONFIG_EVENT_ENTRY) {
2550 if (!section_seen)
2551 /* This is not the section's first entry. */
2552 return;
2553 /* We encountered no comment before the section. */
2554 break;
2556 if (type == CONFIG_EVENT_SECTION) {
2557 if (!store->parsed[i - 1].is_keys_section)
2558 break;
2559 section_seen = 1;
2562 begin = store->parsed[i].begin;
2565 * Next, make sure that we are removing he last key(s) in the section,
2566 * and that there are no comments that are possibly about the current
2567 * section.
2569 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2570 enum config_event_t type = store->parsed[i].type;
2572 if (type == CONFIG_EVENT_COMMENT)
2573 return;
2574 if (type == CONFIG_EVENT_SECTION) {
2575 if (store->parsed[i].is_keys_section)
2576 continue;
2577 break;
2579 if (type == CONFIG_EVENT_ENTRY) {
2580 if (++seen < store->seen_nr &&
2581 i == store->seen[seen])
2582 /* We want to remove this entry, too */
2583 continue;
2584 /* There is another entry in this section. */
2585 return;
2590 * We are really removing the last entry/entries from this section, and
2591 * there are no enclosed or surrounding comments. Remove the entire,
2592 * now-empty section.
2594 *seen_ptr = seen;
2595 *begin_offset = begin;
2596 if (i < store->parsed_nr)
2597 *end_offset = store->parsed[i].begin;
2598 else
2599 *end_offset = store->parsed[store->parsed_nr - 1].end;
2602 int git_config_set_in_file_gently(const char *config_filename,
2603 const char *key, const char *value)
2605 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2608 void git_config_set_in_file(const char *config_filename,
2609 const char *key, const char *value)
2611 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2614 int git_config_set_gently(const char *key, const char *value)
2616 return git_config_set_multivar_gently(key, value, NULL, 0);
2619 void git_config_set(const char *key, const char *value)
2621 git_config_set_multivar(key, value, NULL, 0);
2625 * If value==NULL, unset in (remove from) config,
2626 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2627 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2628 * (only add a new one)
2629 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2630 * else all matching key/values (regardless how many) are removed,
2631 * before the new pair is written.
2633 * Returns 0 on success.
2635 * This function does this:
2637 * - it locks the config file by creating ".git/config.lock"
2639 * - it then parses the config using store_aux() as validator to find
2640 * the position on the key/value pair to replace. If it is to be unset,
2641 * it must be found exactly once.
2643 * - the config file is mmap()ed and the part before the match (if any) is
2644 * written to the lock file, then the changed part and the rest.
2646 * - the config file is removed and the lock file rename()d to it.
2649 int git_config_set_multivar_in_file_gently(const char *config_filename,
2650 const char *key, const char *value,
2651 const char *value_regex,
2652 int multi_replace)
2654 int fd = -1, in_fd = -1;
2655 int ret;
2656 struct lock_file lock = LOCK_INIT;
2657 char *filename_buf = NULL;
2658 char *contents = NULL;
2659 size_t contents_sz;
2660 struct config_store_data store;
2662 memset(&store, 0, sizeof(store));
2664 /* parse-key returns negative; flip the sign to feed exit(3) */
2665 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2666 if (ret)
2667 goto out_free;
2669 store.multi_replace = multi_replace;
2671 if (!config_filename)
2672 config_filename = filename_buf = git_pathdup("config");
2675 * The lock serves a purpose in addition to locking: the new
2676 * contents of .git/config will be written into it.
2678 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2679 if (fd < 0) {
2680 error_errno(_("could not lock config file %s"), config_filename);
2681 ret = CONFIG_NO_LOCK;
2682 goto out_free;
2686 * If .git/config does not exist yet, write a minimal version.
2688 in_fd = open(config_filename, O_RDONLY);
2689 if ( in_fd < 0 ) {
2690 if ( ENOENT != errno ) {
2691 error_errno(_("opening %s"), config_filename);
2692 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2693 goto out_free;
2695 /* if nothing to unset, error out */
2696 if (value == NULL) {
2697 ret = CONFIG_NOTHING_SET;
2698 goto out_free;
2701 free(store.key);
2702 store.key = xstrdup(key);
2703 if (write_section(fd, key, &store) < 0 ||
2704 write_pair(fd, key, value, &store) < 0)
2705 goto write_err_out;
2706 } else {
2707 struct stat st;
2708 size_t copy_begin, copy_end;
2709 int i, new_line = 0;
2710 struct config_options opts;
2712 if (value_regex == NULL)
2713 store.value_regex = NULL;
2714 else if (value_regex == CONFIG_REGEX_NONE)
2715 store.value_regex = CONFIG_REGEX_NONE;
2716 else {
2717 if (value_regex[0] == '!') {
2718 store.do_not_match = 1;
2719 value_regex++;
2720 } else
2721 store.do_not_match = 0;
2723 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2724 if (regcomp(store.value_regex, value_regex,
2725 REG_EXTENDED)) {
2726 error(_("invalid pattern: %s"), value_regex);
2727 FREE_AND_NULL(store.value_regex);
2728 ret = CONFIG_INVALID_PATTERN;
2729 goto out_free;
2733 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2734 store.parsed[0].end = 0;
2736 memset(&opts, 0, sizeof(opts));
2737 opts.event_fn = store_aux_event;
2738 opts.event_fn_data = &store;
2741 * After this, store.parsed will contain offsets of all the
2742 * parsed elements, and store.seen will contain a list of
2743 * matches, as indices into store.parsed.
2745 * As a side effect, we make sure to transform only a valid
2746 * existing config file.
2748 if (git_config_from_file_with_options(store_aux,
2749 config_filename,
2750 &store, &opts)) {
2751 error(_("invalid config file %s"), config_filename);
2752 ret = CONFIG_INVALID_FILE;
2753 goto out_free;
2756 /* if nothing to unset, or too many matches, error out */
2757 if ((store.seen_nr == 0 && value == NULL) ||
2758 (store.seen_nr > 1 && multi_replace == 0)) {
2759 ret = CONFIG_NOTHING_SET;
2760 goto out_free;
2763 if (fstat(in_fd, &st) == -1) {
2764 error_errno(_("fstat on %s failed"), config_filename);
2765 ret = CONFIG_INVALID_FILE;
2766 goto out_free;
2769 contents_sz = xsize_t(st.st_size);
2770 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2771 MAP_PRIVATE, in_fd, 0);
2772 if (contents == MAP_FAILED) {
2773 if (errno == ENODEV && S_ISDIR(st.st_mode))
2774 errno = EISDIR;
2775 error_errno(_("unable to mmap '%s'"), config_filename);
2776 ret = CONFIG_INVALID_FILE;
2777 contents = NULL;
2778 goto out_free;
2780 close(in_fd);
2781 in_fd = -1;
2783 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2784 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
2785 ret = CONFIG_NO_WRITE;
2786 goto out_free;
2789 if (store.seen_nr == 0) {
2790 if (!store.seen_alloc) {
2791 /* Did not see key nor section */
2792 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2793 store.seen[0] = store.parsed_nr
2794 - !!store.parsed_nr;
2796 store.seen_nr = 1;
2799 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2800 size_t replace_end;
2801 int j = store.seen[i];
2803 new_line = 0;
2804 if (!store.key_seen) {
2805 copy_end = store.parsed[j].end;
2806 /* include '\n' when copying section header */
2807 if (copy_end > 0 && copy_end < contents_sz &&
2808 contents[copy_end - 1] != '\n' &&
2809 contents[copy_end] == '\n')
2810 copy_end++;
2811 replace_end = copy_end;
2812 } else {
2813 replace_end = store.parsed[j].end;
2814 copy_end = store.parsed[j].begin;
2815 if (!value)
2816 maybe_remove_section(&store, contents,
2817 &copy_end,
2818 &replace_end, &i);
2820 * Swallow preceding white-space on the same
2821 * line.
2823 while (copy_end > 0 ) {
2824 char c = contents[copy_end - 1];
2826 if (isspace(c) && c != '\n')
2827 copy_end--;
2828 else
2829 break;
2833 if (copy_end > 0 && contents[copy_end-1] != '\n')
2834 new_line = 1;
2836 /* write the first part of the config */
2837 if (copy_end > copy_begin) {
2838 if (write_in_full(fd, contents + copy_begin,
2839 copy_end - copy_begin) < 0)
2840 goto write_err_out;
2841 if (new_line &&
2842 write_str_in_full(fd, "\n") < 0)
2843 goto write_err_out;
2845 copy_begin = replace_end;
2848 /* write the pair (value == NULL means unset) */
2849 if (value != NULL) {
2850 if (!store.section_seen) {
2851 if (write_section(fd, key, &store) < 0)
2852 goto write_err_out;
2854 if (write_pair(fd, key, value, &store) < 0)
2855 goto write_err_out;
2858 /* write the rest of the config */
2859 if (copy_begin < contents_sz)
2860 if (write_in_full(fd, contents + copy_begin,
2861 contents_sz - copy_begin) < 0)
2862 goto write_err_out;
2864 munmap(contents, contents_sz);
2865 contents = NULL;
2868 if (commit_lock_file(&lock) < 0) {
2869 error_errno(_("could not write config file %s"), config_filename);
2870 ret = CONFIG_NO_WRITE;
2871 goto out_free;
2874 ret = 0;
2876 /* Invalidate the config cache */
2877 git_config_clear();
2879 out_free:
2880 rollback_lock_file(&lock);
2881 free(filename_buf);
2882 if (contents)
2883 munmap(contents, contents_sz);
2884 if (in_fd >= 0)
2885 close(in_fd);
2886 config_store_data_clear(&store);
2887 return ret;
2889 write_err_out:
2890 ret = write_error(get_lock_file_path(&lock));
2891 goto out_free;
2895 void git_config_set_multivar_in_file(const char *config_filename,
2896 const char *key, const char *value,
2897 const char *value_regex, int multi_replace)
2899 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2900 value_regex, multi_replace))
2901 return;
2902 if (value)
2903 die(_("could not set '%s' to '%s'"), key, value);
2904 else
2905 die(_("could not unset '%s'"), key);
2908 int git_config_set_multivar_gently(const char *key, const char *value,
2909 const char *value_regex, int multi_replace)
2911 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2912 multi_replace);
2915 void git_config_set_multivar(const char *key, const char *value,
2916 const char *value_regex, int multi_replace)
2918 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2919 multi_replace);
2922 static int section_name_match (const char *buf, const char *name)
2924 int i = 0, j = 0, dot = 0;
2925 if (buf[i] != '[')
2926 return 0;
2927 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2928 if (!dot && isspace(buf[i])) {
2929 dot = 1;
2930 if (name[j++] != '.')
2931 break;
2932 for (i++; isspace(buf[i]); i++)
2933 ; /* do nothing */
2934 if (buf[i] != '"')
2935 break;
2936 continue;
2938 if (buf[i] == '\\' && dot)
2939 i++;
2940 else if (buf[i] == '"' && dot) {
2941 for (i++; isspace(buf[i]); i++)
2942 ; /* do_nothing */
2943 break;
2945 if (buf[i] != name[j++])
2946 break;
2948 if (buf[i] == ']' && name[j] == 0) {
2950 * We match, now just find the right length offset by
2951 * gobbling up any whitespace after it, as well
2953 i++;
2954 for (; buf[i] && isspace(buf[i]); i++)
2955 ; /* do nothing */
2956 return i;
2958 return 0;
2961 static int section_name_is_ok(const char *name)
2963 /* Empty section names are bogus. */
2964 if (!*name)
2965 return 0;
2968 * Before a dot, we must be alphanumeric or dash. After the first dot,
2969 * anything goes, so we can stop checking.
2971 for (; *name && *name != '.'; name++)
2972 if (*name != '-' && !isalnum(*name))
2973 return 0;
2974 return 1;
2977 /* if new_name == NULL, the section is removed instead */
2978 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
2979 const char *old_name,
2980 const char *new_name, int copy)
2982 int ret = 0, remove = 0;
2983 char *filename_buf = NULL;
2984 struct lock_file lock = LOCK_INIT;
2985 int out_fd;
2986 char buf[1024];
2987 FILE *config_file = NULL;
2988 struct stat st;
2989 struct strbuf copystr = STRBUF_INIT;
2990 struct config_store_data store;
2992 memset(&store, 0, sizeof(store));
2994 if (new_name && !section_name_is_ok(new_name)) {
2995 ret = error(_("invalid section name: %s"), new_name);
2996 goto out_no_rollback;
2999 if (!config_filename)
3000 config_filename = filename_buf = git_pathdup("config");
3002 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3003 if (out_fd < 0) {
3004 ret = error(_("could not lock config file %s"), config_filename);
3005 goto out;
3008 if (!(config_file = fopen(config_filename, "rb"))) {
3009 ret = warn_on_fopen_errors(config_filename);
3010 if (ret)
3011 goto out;
3012 /* no config file means nothing to rename, no error */
3013 goto commit_and_out;
3016 if (fstat(fileno(config_file), &st) == -1) {
3017 ret = error_errno(_("fstat on %s failed"), config_filename);
3018 goto out;
3021 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3022 ret = error_errno(_("chmod on %s failed"),
3023 get_lock_file_path(&lock));
3024 goto out;
3027 while (fgets(buf, sizeof(buf), config_file)) {
3028 int i;
3029 int length;
3030 int is_section = 0;
3031 char *output = buf;
3032 for (i = 0; buf[i] && isspace(buf[i]); i++)
3033 ; /* do nothing */
3034 if (buf[i] == '[') {
3035 /* it's a section */
3036 int offset;
3037 is_section = 1;
3040 * When encountering a new section under -c we
3041 * need to flush out any section we're already
3042 * coping and begin anew. There might be
3043 * multiple [branch "$name"] sections.
3045 if (copystr.len > 0) {
3046 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3047 ret = write_error(get_lock_file_path(&lock));
3048 goto out;
3050 strbuf_reset(&copystr);
3053 offset = section_name_match(&buf[i], old_name);
3054 if (offset > 0) {
3055 ret++;
3056 if (new_name == NULL) {
3057 remove = 1;
3058 continue;
3060 store.baselen = strlen(new_name);
3061 if (!copy) {
3062 if (write_section(out_fd, new_name, &store) < 0) {
3063 ret = write_error(get_lock_file_path(&lock));
3064 goto out;
3067 * We wrote out the new section, with
3068 * a newline, now skip the old
3069 * section's length
3071 output += offset + i;
3072 if (strlen(output) > 0) {
3074 * More content means there's
3075 * a declaration to put on the
3076 * next line; indent with a
3077 * tab
3079 output -= 1;
3080 output[0] = '\t';
3082 } else {
3083 copystr = store_create_section(new_name, &store);
3086 remove = 0;
3088 if (remove)
3089 continue;
3090 length = strlen(output);
3092 if (!is_section && copystr.len > 0) {
3093 strbuf_add(&copystr, output, length);
3096 if (write_in_full(out_fd, output, length) < 0) {
3097 ret = write_error(get_lock_file_path(&lock));
3098 goto out;
3103 * Copy a trailing section at the end of the config, won't be
3104 * flushed by the usual "flush because we have a new section
3105 * logic in the loop above.
3107 if (copystr.len > 0) {
3108 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3109 ret = write_error(get_lock_file_path(&lock));
3110 goto out;
3112 strbuf_reset(&copystr);
3115 fclose(config_file);
3116 config_file = NULL;
3117 commit_and_out:
3118 if (commit_lock_file(&lock) < 0)
3119 ret = error_errno(_("could not write config file %s"),
3120 config_filename);
3121 out:
3122 if (config_file)
3123 fclose(config_file);
3124 rollback_lock_file(&lock);
3125 out_no_rollback:
3126 free(filename_buf);
3127 config_store_data_clear(&store);
3128 return ret;
3131 int git_config_rename_section_in_file(const char *config_filename,
3132 const char *old_name, const char *new_name)
3134 return git_config_copy_or_rename_section_in_file(config_filename,
3135 old_name, new_name, 0);
3138 int git_config_rename_section(const char *old_name, const char *new_name)
3140 return git_config_rename_section_in_file(NULL, old_name, new_name);
3143 int git_config_copy_section_in_file(const char *config_filename,
3144 const char *old_name, const char *new_name)
3146 return git_config_copy_or_rename_section_in_file(config_filename,
3147 old_name, new_name, 1);
3150 int git_config_copy_section(const char *old_name, const char *new_name)
3152 return git_config_copy_section_in_file(NULL, old_name, new_name);
3156 * Call this to report error for your variable that should not
3157 * get a boolean value (i.e. "[my] var" means "true").
3159 #undef config_error_nonbool
3160 int config_error_nonbool(const char *var)
3162 return error(_("missing value for '%s'"), var);
3165 int parse_config_key(const char *var,
3166 const char *section,
3167 const char **subsection, int *subsection_len,
3168 const char **key)
3170 const char *dot;
3172 /* Does it start with "section." ? */
3173 if (!skip_prefix(var, section, &var) || *var != '.')
3174 return -1;
3177 * Find the key; we don't know yet if we have a subsection, but we must
3178 * parse backwards from the end, since the subsection may have dots in
3179 * it, too.
3181 dot = strrchr(var, '.');
3182 *key = dot + 1;
3184 /* Did we have a subsection at all? */
3185 if (dot == var) {
3186 if (subsection) {
3187 *subsection = NULL;
3188 *subsection_len = 0;
3191 else {
3192 if (!subsection)
3193 return -1;
3194 *subsection = var + 1;
3195 *subsection_len = dot - *subsection;
3198 return 0;
3201 const char *current_config_origin_type(void)
3203 int type;
3204 if (current_config_kvi)
3205 type = current_config_kvi->origin_type;
3206 else if(cf)
3207 type = cf->origin_type;
3208 else
3209 BUG("current_config_origin_type called outside config callback");
3211 switch (type) {
3212 case CONFIG_ORIGIN_BLOB:
3213 return "blob";
3214 case CONFIG_ORIGIN_FILE:
3215 return "file";
3216 case CONFIG_ORIGIN_STDIN:
3217 return "standard input";
3218 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3219 return "submodule-blob";
3220 case CONFIG_ORIGIN_CMDLINE:
3221 return "command line";
3222 default:
3223 BUG("unknown config origin type");
3227 const char *current_config_name(void)
3229 const char *name;
3230 if (current_config_kvi)
3231 name = current_config_kvi->filename;
3232 else if (cf)
3233 name = cf->name;
3234 else
3235 BUG("current_config_name called outside config callback");
3236 return name ? name : "";
3239 enum config_scope current_config_scope(void)
3241 if (current_config_kvi)
3242 return current_config_kvi->scope;
3243 else
3244 return current_parsing_scope;
3247 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3249 int i;
3251 for (i = 0; i < nr_mapping; i++) {
3252 const char *name = mapping[i];
3254 if (name && !strcasecmp(var, name))
3255 return i;
3257 return -1;