urlmatch.h: fix include guard
[git.git] / config.c
blob66dca7978a85a60edcc9a97c14efeab235715ab9
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;
42 int (*do_fgetc)(struct config_source *c);
43 int (*do_ungetc)(int c, struct config_source *conf);
44 long (*do_ftell)(struct config_source *c);
48 * These variables record the "current" config source, which
49 * can be accessed by parsing callbacks.
51 * The "cf" variable will be non-NULL only when we are actually parsing a real
52 * config source (file, blob, cmdline, etc).
54 * The "current_config_kvi" variable will be non-NULL only when we are feeding
55 * cached config from a configset into a callback.
57 * They should generally never be non-NULL at the same time. If they are both
58 * NULL, then we aren't parsing anything (and depending on the function looking
59 * at the variables, it's either a bug for it to be called in the first place,
60 * or it's a function which can be reused for non-config purposes, and should
61 * fall back to some sane behavior).
63 static struct config_source *cf;
64 static struct key_value_info *current_config_kvi;
67 * Similar to the variables above, this gives access to the "scope" of the
68 * current value (repo, global, etc). For cached values, it can be found via
69 * the current_config_kvi as above. During parsing, the current value can be
70 * found in this variable. It's not part of "cf" because it transcends a single
71 * file (i.e., a file included from .git/config is still in "repo" scope).
73 static enum config_scope current_parsing_scope;
75 static int core_compression_seen;
76 static int pack_compression_seen;
77 static int zlib_compression_seen;
79 static int config_file_fgetc(struct config_source *conf)
81 return getc_unlocked(conf->u.file);
84 static int config_file_ungetc(int c, struct config_source *conf)
86 return ungetc(c, conf->u.file);
89 static long config_file_ftell(struct config_source *conf)
91 return ftell(conf->u.file);
95 static int config_buf_fgetc(struct config_source *conf)
97 if (conf->u.buf.pos < conf->u.buf.len)
98 return conf->u.buf.buf[conf->u.buf.pos++];
100 return EOF;
103 static int config_buf_ungetc(int c, struct config_source *conf)
105 if (conf->u.buf.pos > 0) {
106 conf->u.buf.pos--;
107 if (conf->u.buf.buf[conf->u.buf.pos] != c)
108 BUG("config_buf can only ungetc the same character");
109 return c;
112 return EOF;
115 static long config_buf_ftell(struct config_source *conf)
117 return conf->u.buf.pos;
120 #define MAX_INCLUDE_DEPTH 10
121 static const char include_depth_advice[] =
122 "exceeded maximum include depth (%d) while including\n"
123 " %s\n"
124 "from\n"
125 " %s\n"
126 "Do you have circular includes?";
127 static int handle_path_include(const char *path, struct config_include_data *inc)
129 int ret = 0;
130 struct strbuf buf = STRBUF_INIT;
131 char *expanded;
133 if (!path)
134 return config_error_nonbool("include.path");
136 expanded = expand_user_path(path, 0);
137 if (!expanded)
138 return error("could not expand include path '%s'", path);
139 path = expanded;
142 * Use an absolute path as-is, but interpret relative paths
143 * based on the including config file.
145 if (!is_absolute_path(path)) {
146 char *slash;
148 if (!cf || !cf->path)
149 return error("relative config includes must come from files");
151 slash = find_last_dir_sep(cf->path);
152 if (slash)
153 strbuf_add(&buf, cf->path, slash - cf->path + 1);
154 strbuf_addstr(&buf, path);
155 path = buf.buf;
158 if (!access_or_die(path, R_OK, 0)) {
159 if (++inc->depth > MAX_INCLUDE_DEPTH)
160 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
161 !cf ? "<unknown>" :
162 cf->name ? cf->name :
163 "the command line");
164 ret = git_config_from_file(git_config_include, path, inc);
165 inc->depth--;
167 strbuf_release(&buf);
168 free(expanded);
169 return ret;
172 static int prepare_include_condition_pattern(struct strbuf *pat)
174 struct strbuf path = STRBUF_INIT;
175 char *expanded;
176 int prefix = 0;
178 expanded = expand_user_path(pat->buf, 1);
179 if (expanded) {
180 strbuf_reset(pat);
181 strbuf_addstr(pat, expanded);
182 free(expanded);
185 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
186 const char *slash;
188 if (!cf || !cf->path)
189 return error(_("relative config include "
190 "conditionals must come from files"));
192 strbuf_realpath(&path, cf->path, 1);
193 slash = find_last_dir_sep(path.buf);
194 if (!slash)
195 BUG("how is this possible?");
196 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
197 prefix = slash - path.buf + 1 /* slash */;
198 } else if (!is_absolute_path(pat->buf))
199 strbuf_insert(pat, 0, "**/", 3);
201 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
202 strbuf_addstr(pat, "**");
204 strbuf_release(&path);
205 return prefix;
208 static int include_by_gitdir(const struct config_options *opts,
209 const char *cond, size_t cond_len, int icase)
211 struct strbuf text = STRBUF_INIT;
212 struct strbuf pattern = STRBUF_INIT;
213 int ret = 0, prefix;
214 const char *git_dir;
215 int already_tried_absolute = 0;
217 if (opts->git_dir)
218 git_dir = opts->git_dir;
219 else
220 goto done;
222 strbuf_realpath(&text, git_dir, 1);
223 strbuf_add(&pattern, cond, cond_len);
224 prefix = prepare_include_condition_pattern(&pattern);
226 again:
227 if (prefix < 0)
228 goto done;
230 if (prefix > 0) {
232 * perform literal matching on the prefix part so that
233 * any wildcard character in it can't create side effects.
235 if (text.len < prefix)
236 goto done;
237 if (!icase && strncmp(pattern.buf, text.buf, prefix))
238 goto done;
239 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
240 goto done;
243 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
244 icase ? WM_CASEFOLD : 0);
246 if (!ret && !already_tried_absolute) {
248 * We've tried e.g. matching gitdir:~/work, but if
249 * ~/work is a symlink to /mnt/storage/work
250 * strbuf_realpath() will expand it, so the rule won't
251 * match. Let's match against a
252 * strbuf_add_absolute_path() version of the path,
253 * which'll do the right thing
255 strbuf_reset(&text);
256 strbuf_add_absolute_path(&text, git_dir);
257 already_tried_absolute = 1;
258 goto again;
260 done:
261 strbuf_release(&pattern);
262 strbuf_release(&text);
263 return ret;
266 static int include_condition_is_true(const struct config_options *opts,
267 const char *cond, size_t cond_len)
270 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
271 return include_by_gitdir(opts, cond, cond_len, 0);
272 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
273 return include_by_gitdir(opts, cond, cond_len, 1);
275 /* unknown conditionals are always false */
276 return 0;
279 int git_config_include(const char *var, const char *value, void *data)
281 struct config_include_data *inc = data;
282 const char *cond, *key;
283 int cond_len;
284 int ret;
287 * Pass along all values, including "include" directives; this makes it
288 * possible to query information on the includes themselves.
290 ret = inc->fn(var, value, inc->data);
291 if (ret < 0)
292 return ret;
294 if (!strcmp(var, "include.path"))
295 ret = handle_path_include(value, inc);
297 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
298 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
299 !strcmp(key, "path"))
300 ret = handle_path_include(value, inc);
302 return ret;
305 void git_config_push_parameter(const char *text)
307 struct strbuf env = STRBUF_INIT;
308 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
309 if (old && *old) {
310 strbuf_addstr(&env, old);
311 strbuf_addch(&env, ' ');
313 sq_quote_buf(&env, text);
314 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
315 strbuf_release(&env);
318 static inline int iskeychar(int c)
320 return isalnum(c) || c == '-';
324 * Auxiliary function to sanity-check and split the key into the section
325 * identifier and variable name.
327 * Returns 0 on success, -1 when there is an invalid character in the key and
328 * -2 if there is no section name in the key.
330 * store_key - pointer to char* which will hold a copy of the key with
331 * lowercase section and variable name
332 * baselen - pointer to int which will hold the length of the
333 * section + subsection part, can be NULL
335 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
337 int i, dot, baselen;
338 const char *last_dot = strrchr(key, '.');
341 * Since "key" actually contains the section name and the real
342 * key name separated by a dot, we have to know where the dot is.
345 if (last_dot == NULL || last_dot == key) {
346 if (!quiet)
347 error("key does not contain a section: %s", key);
348 return -CONFIG_NO_SECTION_OR_NAME;
351 if (!last_dot[1]) {
352 if (!quiet)
353 error("key does not contain variable name: %s", key);
354 return -CONFIG_NO_SECTION_OR_NAME;
357 baselen = last_dot - key;
358 if (baselen_)
359 *baselen_ = baselen;
362 * Validate the key and while at it, lower case it for matching.
364 if (store_key)
365 *store_key = xmallocz(strlen(key));
367 dot = 0;
368 for (i = 0; key[i]; i++) {
369 unsigned char c = key[i];
370 if (c == '.')
371 dot = 1;
372 /* Leave the extended basename untouched.. */
373 if (!dot || i > baselen) {
374 if (!iskeychar(c) ||
375 (i == baselen + 1 && !isalpha(c))) {
376 if (!quiet)
377 error("invalid key: %s", key);
378 goto out_free_ret_1;
380 c = tolower(c);
381 } else if (c == '\n') {
382 if (!quiet)
383 error("invalid key (newline): %s", key);
384 goto out_free_ret_1;
386 if (store_key)
387 (*store_key)[i] = c;
390 return 0;
392 out_free_ret_1:
393 if (store_key) {
394 FREE_AND_NULL(*store_key);
396 return -CONFIG_INVALID_KEY;
399 int git_config_parse_key(const char *key, char **store_key, int *baselen)
401 return git_config_parse_key_1(key, store_key, baselen, 0);
404 int git_config_key_is_valid(const char *key)
406 return !git_config_parse_key_1(key, NULL, NULL, 1);
409 int git_config_parse_parameter(const char *text,
410 config_fn_t fn, void *data)
412 const char *value;
413 char *canonical_name;
414 struct strbuf **pair;
415 int ret;
417 pair = strbuf_split_str(text, '=', 2);
418 if (!pair[0])
419 return error("bogus config parameter: %s", text);
421 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
422 strbuf_setlen(pair[0], pair[0]->len - 1);
423 value = pair[1] ? pair[1]->buf : "";
424 } else {
425 value = NULL;
428 strbuf_trim(pair[0]);
429 if (!pair[0]->len) {
430 strbuf_list_free(pair);
431 return error("bogus config parameter: %s", text);
434 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
435 ret = -1;
436 } else {
437 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
438 free(canonical_name);
440 strbuf_list_free(pair);
441 return ret;
444 int git_config_from_parameters(config_fn_t fn, void *data)
446 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
447 int ret = 0;
448 char *envw;
449 const char **argv = NULL;
450 int nr = 0, alloc = 0;
451 int i;
452 struct config_source source;
454 if (!env)
455 return 0;
457 memset(&source, 0, sizeof(source));
458 source.prev = cf;
459 source.origin_type = CONFIG_ORIGIN_CMDLINE;
460 cf = &source;
462 /* sq_dequote will write over it */
463 envw = xstrdup(env);
465 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
466 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
467 goto out;
470 for (i = 0; i < nr; i++) {
471 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
472 ret = -1;
473 goto out;
477 out:
478 free(argv);
479 free(envw);
480 cf = source.prev;
481 return ret;
484 static int get_next_char(void)
486 int c = cf->do_fgetc(cf);
488 if (c == '\r') {
489 /* DOS like systems */
490 c = cf->do_fgetc(cf);
491 if (c != '\n') {
492 if (c != EOF)
493 cf->do_ungetc(c, cf);
494 c = '\r';
497 if (c == '\n')
498 cf->linenr++;
499 if (c == EOF) {
500 cf->eof = 1;
501 cf->linenr++;
502 c = '\n';
504 return c;
507 static char *parse_value(void)
509 int quote = 0, comment = 0, space = 0;
511 strbuf_reset(&cf->value);
512 for (;;) {
513 int c = get_next_char();
514 if (c == '\n') {
515 if (quote) {
516 cf->linenr--;
517 return NULL;
519 return cf->value.buf;
521 if (comment)
522 continue;
523 if (isspace(c) && !quote) {
524 if (cf->value.len)
525 space++;
526 continue;
528 if (!quote) {
529 if (c == ';' || c == '#') {
530 comment = 1;
531 continue;
534 for (; space; space--)
535 strbuf_addch(&cf->value, ' ');
536 if (c == '\\') {
537 c = get_next_char();
538 switch (c) {
539 case '\n':
540 continue;
541 case 't':
542 c = '\t';
543 break;
544 case 'b':
545 c = '\b';
546 break;
547 case 'n':
548 c = '\n';
549 break;
550 /* Some characters escape as themselves */
551 case '\\': case '"':
552 break;
553 /* Reject unknown escape sequences */
554 default:
555 return NULL;
557 strbuf_addch(&cf->value, c);
558 continue;
560 if (c == '"') {
561 quote = 1-quote;
562 continue;
564 strbuf_addch(&cf->value, c);
568 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
570 int c;
571 char *value;
572 int ret;
574 /* Get the full name */
575 for (;;) {
576 c = get_next_char();
577 if (cf->eof)
578 break;
579 if (!iskeychar(c))
580 break;
581 strbuf_addch(name, tolower(c));
584 while (c == ' ' || c == '\t')
585 c = get_next_char();
587 value = NULL;
588 if (c != '\n') {
589 if (c != '=')
590 return -1;
591 value = parse_value();
592 if (!value)
593 return -1;
596 * We already consumed the \n, but we need linenr to point to
597 * the line we just parsed during the call to fn to get
598 * accurate line number in error messages.
600 cf->linenr--;
601 ret = fn(name->buf, value, data);
602 if (ret >= 0)
603 cf->linenr++;
604 return ret;
607 static int get_extended_base_var(struct strbuf *name, int c)
609 do {
610 if (c == '\n')
611 goto error_incomplete_line;
612 c = get_next_char();
613 } while (isspace(c));
615 /* We require the format to be '[base "extension"]' */
616 if (c != '"')
617 return -1;
618 strbuf_addch(name, '.');
620 for (;;) {
621 int c = get_next_char();
622 if (c == '\n')
623 goto error_incomplete_line;
624 if (c == '"')
625 break;
626 if (c == '\\') {
627 c = get_next_char();
628 if (c == '\n')
629 goto error_incomplete_line;
631 strbuf_addch(name, c);
634 /* Final ']' */
635 if (get_next_char() != ']')
636 return -1;
637 return 0;
638 error_incomplete_line:
639 cf->linenr--;
640 return -1;
643 static int get_base_var(struct strbuf *name)
645 for (;;) {
646 int c = get_next_char();
647 if (cf->eof)
648 return -1;
649 if (c == ']')
650 return 0;
651 if (isspace(c))
652 return get_extended_base_var(name, c);
653 if (!iskeychar(c) && c != '.')
654 return -1;
655 strbuf_addch(name, tolower(c));
659 struct parse_event_data {
660 enum config_event_t previous_type;
661 size_t previous_offset;
662 const struct config_options *opts;
665 static int do_event(enum config_event_t type, struct parse_event_data *data)
667 size_t offset;
669 if (!data->opts || !data->opts->event_fn)
670 return 0;
672 if (type == CONFIG_EVENT_WHITESPACE &&
673 data->previous_type == type)
674 return 0;
676 offset = cf->do_ftell(cf);
678 * At EOF, the parser always "inserts" an extra '\n', therefore
679 * the end offset of the event is the current file position, otherwise
680 * we will already have advanced to the next event.
682 if (type != CONFIG_EVENT_EOF)
683 offset--;
685 if (data->previous_type != CONFIG_EVENT_EOF &&
686 data->opts->event_fn(data->previous_type, data->previous_offset,
687 offset, data->opts->event_fn_data) < 0)
688 return -1;
690 data->previous_type = type;
691 data->previous_offset = offset;
693 return 0;
696 static int git_parse_source(config_fn_t fn, void *data,
697 const struct config_options *opts)
699 int comment = 0;
700 int baselen = 0;
701 struct strbuf *var = &cf->var;
702 int error_return = 0;
703 char *error_msg = NULL;
705 /* U+FEFF Byte Order Mark in UTF8 */
706 const char *bomptr = utf8_bom;
708 /* For the parser event callback */
709 struct parse_event_data event_data = {
710 CONFIG_EVENT_EOF, 0, opts
713 for (;;) {
714 int c;
716 c = get_next_char();
717 if (bomptr && *bomptr) {
718 /* We are at the file beginning; skip UTF8-encoded BOM
719 * if present. Sane editors won't put this in on their
720 * own, but e.g. Windows Notepad will do it happily. */
721 if (c == (*bomptr & 0377)) {
722 bomptr++;
723 continue;
724 } else {
725 /* Do not tolerate partial BOM. */
726 if (bomptr != utf8_bom)
727 break;
728 /* No BOM at file beginning. Cool. */
729 bomptr = NULL;
732 if (c == '\n') {
733 if (cf->eof) {
734 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
735 return -1;
736 return 0;
738 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
739 return -1;
740 comment = 0;
741 continue;
743 if (comment)
744 continue;
745 if (isspace(c)) {
746 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
747 return -1;
748 continue;
750 if (c == '#' || c == ';') {
751 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
752 return -1;
753 comment = 1;
754 continue;
756 if (c == '[') {
757 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
758 return -1;
760 /* Reset prior to determining a new stem */
761 strbuf_reset(var);
762 if (get_base_var(var) < 0 || var->len < 1)
763 break;
764 strbuf_addch(var, '.');
765 baselen = var->len;
766 continue;
768 if (!isalpha(c))
769 break;
771 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
772 return -1;
775 * Truncate the var name back to the section header
776 * stem prior to grabbing the suffix part of the name
777 * and the value.
779 strbuf_setlen(var, baselen);
780 strbuf_addch(var, tolower(c));
781 if (get_value(fn, data, var) < 0)
782 break;
785 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
786 return -1;
788 switch (cf->origin_type) {
789 case CONFIG_ORIGIN_BLOB:
790 error_msg = xstrfmt(_("bad config line %d in blob %s"),
791 cf->linenr, cf->name);
792 break;
793 case CONFIG_ORIGIN_FILE:
794 error_msg = xstrfmt(_("bad config line %d in file %s"),
795 cf->linenr, cf->name);
796 break;
797 case CONFIG_ORIGIN_STDIN:
798 error_msg = xstrfmt(_("bad config line %d in standard input"),
799 cf->linenr);
800 break;
801 case CONFIG_ORIGIN_SUBMODULE_BLOB:
802 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
803 cf->linenr, cf->name);
804 break;
805 case CONFIG_ORIGIN_CMDLINE:
806 error_msg = xstrfmt(_("bad config line %d in command line %s"),
807 cf->linenr, cf->name);
808 break;
809 default:
810 error_msg = xstrfmt(_("bad config line %d in %s"),
811 cf->linenr, cf->name);
814 switch (opts && opts->error_action ?
815 opts->error_action :
816 cf->default_error_action) {
817 case CONFIG_ERROR_DIE:
818 die("%s", error_msg);
819 break;
820 case CONFIG_ERROR_ERROR:
821 error_return = error("%s", error_msg);
822 break;
823 case CONFIG_ERROR_SILENT:
824 error_return = -1;
825 break;
826 case CONFIG_ERROR_UNSET:
827 BUG("config error action unset");
830 free(error_msg);
831 return error_return;
834 static int parse_unit_factor(const char *end, uintmax_t *val)
836 if (!*end)
837 return 1;
838 else if (!strcasecmp(end, "k")) {
839 *val *= 1024;
840 return 1;
842 else if (!strcasecmp(end, "m")) {
843 *val *= 1024 * 1024;
844 return 1;
846 else if (!strcasecmp(end, "g")) {
847 *val *= 1024 * 1024 * 1024;
848 return 1;
850 return 0;
853 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
855 if (value && *value) {
856 char *end;
857 intmax_t val;
858 uintmax_t uval;
859 uintmax_t factor = 1;
861 errno = 0;
862 val = strtoimax(value, &end, 0);
863 if (errno == ERANGE)
864 return 0;
865 if (!parse_unit_factor(end, &factor)) {
866 errno = EINVAL;
867 return 0;
869 uval = labs(val);
870 uval *= factor;
871 if (uval > max || labs(val) > uval) {
872 errno = ERANGE;
873 return 0;
875 val *= factor;
876 *ret = val;
877 return 1;
879 errno = EINVAL;
880 return 0;
883 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
885 if (value && *value) {
886 char *end;
887 uintmax_t val;
888 uintmax_t oldval;
890 errno = 0;
891 val = strtoumax(value, &end, 0);
892 if (errno == ERANGE)
893 return 0;
894 oldval = val;
895 if (!parse_unit_factor(end, &val)) {
896 errno = EINVAL;
897 return 0;
899 if (val > max || oldval > val) {
900 errno = ERANGE;
901 return 0;
903 *ret = val;
904 return 1;
906 errno = EINVAL;
907 return 0;
910 static int git_parse_int(const char *value, int *ret)
912 intmax_t tmp;
913 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
914 return 0;
915 *ret = tmp;
916 return 1;
919 static int git_parse_int64(const char *value, int64_t *ret)
921 intmax_t tmp;
922 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
923 return 0;
924 *ret = tmp;
925 return 1;
928 int git_parse_ulong(const char *value, unsigned long *ret)
930 uintmax_t tmp;
931 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
932 return 0;
933 *ret = tmp;
934 return 1;
937 static int git_parse_ssize_t(const char *value, ssize_t *ret)
939 intmax_t tmp;
940 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
941 return 0;
942 *ret = tmp;
943 return 1;
946 NORETURN
947 static void die_bad_number(const char *name, const char *value)
949 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
951 if (!value)
952 value = "";
954 if (!(cf && cf->name))
955 die(_("bad numeric config value '%s' for '%s': %s"),
956 value, name, error_type);
958 switch (cf->origin_type) {
959 case CONFIG_ORIGIN_BLOB:
960 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
961 value, name, cf->name, error_type);
962 case CONFIG_ORIGIN_FILE:
963 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
964 value, name, cf->name, error_type);
965 case CONFIG_ORIGIN_STDIN:
966 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
967 value, name, error_type);
968 case CONFIG_ORIGIN_SUBMODULE_BLOB:
969 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
970 value, name, cf->name, error_type);
971 case CONFIG_ORIGIN_CMDLINE:
972 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
973 value, name, cf->name, error_type);
974 default:
975 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
976 value, name, cf->name, error_type);
980 int git_config_int(const char *name, const char *value)
982 int ret;
983 if (!git_parse_int(value, &ret))
984 die_bad_number(name, value);
985 return ret;
988 int64_t git_config_int64(const char *name, const char *value)
990 int64_t ret;
991 if (!git_parse_int64(value, &ret))
992 die_bad_number(name, value);
993 return ret;
996 unsigned long git_config_ulong(const char *name, const char *value)
998 unsigned long ret;
999 if (!git_parse_ulong(value, &ret))
1000 die_bad_number(name, value);
1001 return ret;
1004 ssize_t git_config_ssize_t(const char *name, const char *value)
1006 ssize_t ret;
1007 if (!git_parse_ssize_t(value, &ret))
1008 die_bad_number(name, value);
1009 return ret;
1012 static int git_parse_maybe_bool_text(const char *value)
1014 if (!value)
1015 return 1;
1016 if (!*value)
1017 return 0;
1018 if (!strcasecmp(value, "true")
1019 || !strcasecmp(value, "yes")
1020 || !strcasecmp(value, "on"))
1021 return 1;
1022 if (!strcasecmp(value, "false")
1023 || !strcasecmp(value, "no")
1024 || !strcasecmp(value, "off"))
1025 return 0;
1026 return -1;
1029 int git_parse_maybe_bool(const char *value)
1031 int v = git_parse_maybe_bool_text(value);
1032 if (0 <= v)
1033 return v;
1034 if (git_parse_int(value, &v))
1035 return !!v;
1036 return -1;
1039 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1041 int v = git_parse_maybe_bool_text(value);
1042 if (0 <= v) {
1043 *is_bool = 1;
1044 return v;
1046 *is_bool = 0;
1047 return git_config_int(name, value);
1050 int git_config_bool(const char *name, const char *value)
1052 int discard;
1053 return !!git_config_bool_or_int(name, value, &discard);
1056 int git_config_string(const char **dest, const char *var, const char *value)
1058 if (!value)
1059 return config_error_nonbool(var);
1060 *dest = xstrdup(value);
1061 return 0;
1064 int git_config_pathname(const char **dest, const char *var, const char *value)
1066 if (!value)
1067 return config_error_nonbool(var);
1068 *dest = expand_user_path(value, 0);
1069 if (!*dest)
1070 die(_("failed to expand user dir in: '%s'"), value);
1071 return 0;
1074 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1076 if (!value)
1077 return config_error_nonbool(var);
1078 if (parse_expiry_date(value, timestamp))
1079 return error(_("'%s' for '%s' is not a valid timestamp"),
1080 value, var);
1081 return 0;
1084 int git_config_color(char *dest, const char *var, const char *value)
1086 if (!value)
1087 return config_error_nonbool(var);
1088 if (color_parse(value, dest) < 0)
1089 return -1;
1090 return 0;
1093 static int git_default_core_config(const char *var, const char *value)
1095 /* This needs a better name */
1096 if (!strcmp(var, "core.filemode")) {
1097 trust_executable_bit = git_config_bool(var, value);
1098 return 0;
1100 if (!strcmp(var, "core.trustctime")) {
1101 trust_ctime = git_config_bool(var, value);
1102 return 0;
1104 if (!strcmp(var, "core.checkstat")) {
1105 if (!strcasecmp(value, "default"))
1106 check_stat = 1;
1107 else if (!strcasecmp(value, "minimal"))
1108 check_stat = 0;
1111 if (!strcmp(var, "core.quotepath")) {
1112 quote_path_fully = git_config_bool(var, value);
1113 return 0;
1116 if (!strcmp(var, "core.symlinks")) {
1117 has_symlinks = git_config_bool(var, value);
1118 return 0;
1121 if (!strcmp(var, "core.ignorecase")) {
1122 ignore_case = git_config_bool(var, value);
1123 return 0;
1126 if (!strcmp(var, "core.attributesfile"))
1127 return git_config_pathname(&git_attributes_file, var, value);
1129 if (!strcmp(var, "core.hookspath"))
1130 return git_config_pathname(&git_hooks_path, var, value);
1132 if (!strcmp(var, "core.bare")) {
1133 is_bare_repository_cfg = git_config_bool(var, value);
1134 return 0;
1137 if (!strcmp(var, "core.ignorestat")) {
1138 assume_unchanged = git_config_bool(var, value);
1139 return 0;
1142 if (!strcmp(var, "core.prefersymlinkrefs")) {
1143 prefer_symlink_refs = git_config_bool(var, value);
1144 return 0;
1147 if (!strcmp(var, "core.logallrefupdates")) {
1148 if (value && !strcasecmp(value, "always"))
1149 log_all_ref_updates = LOG_REFS_ALWAYS;
1150 else if (git_config_bool(var, value))
1151 log_all_ref_updates = LOG_REFS_NORMAL;
1152 else
1153 log_all_ref_updates = LOG_REFS_NONE;
1154 return 0;
1157 if (!strcmp(var, "core.warnambiguousrefs")) {
1158 warn_ambiguous_refs = git_config_bool(var, value);
1159 return 0;
1162 if (!strcmp(var, "core.abbrev")) {
1163 if (!value)
1164 return config_error_nonbool(var);
1165 if (!strcasecmp(value, "auto"))
1166 default_abbrev = -1;
1167 else {
1168 int abbrev = git_config_int(var, value);
1169 if (abbrev < minimum_abbrev || abbrev > 40)
1170 return error("abbrev length out of range: %d", abbrev);
1171 default_abbrev = abbrev;
1173 return 0;
1176 if (!strcmp(var, "core.disambiguate"))
1177 return set_disambiguate_hint_config(var, value);
1179 if (!strcmp(var, "core.loosecompression")) {
1180 int level = git_config_int(var, value);
1181 if (level == -1)
1182 level = Z_DEFAULT_COMPRESSION;
1183 else if (level < 0 || level > Z_BEST_COMPRESSION)
1184 die(_("bad zlib compression level %d"), level);
1185 zlib_compression_level = level;
1186 zlib_compression_seen = 1;
1187 return 0;
1190 if (!strcmp(var, "core.compression")) {
1191 int level = git_config_int(var, value);
1192 if (level == -1)
1193 level = Z_DEFAULT_COMPRESSION;
1194 else if (level < 0 || level > Z_BEST_COMPRESSION)
1195 die(_("bad zlib compression level %d"), level);
1196 core_compression_level = level;
1197 core_compression_seen = 1;
1198 if (!zlib_compression_seen)
1199 zlib_compression_level = level;
1200 if (!pack_compression_seen)
1201 pack_compression_level = level;
1202 return 0;
1205 if (!strcmp(var, "core.packedgitwindowsize")) {
1206 int pgsz_x2 = getpagesize() * 2;
1207 packed_git_window_size = git_config_ulong(var, value);
1209 /* This value must be multiple of (pagesize * 2) */
1210 packed_git_window_size /= pgsz_x2;
1211 if (packed_git_window_size < 1)
1212 packed_git_window_size = 1;
1213 packed_git_window_size *= pgsz_x2;
1214 return 0;
1217 if (!strcmp(var, "core.bigfilethreshold")) {
1218 big_file_threshold = git_config_ulong(var, value);
1219 return 0;
1222 if (!strcmp(var, "core.packedgitlimit")) {
1223 packed_git_limit = git_config_ulong(var, value);
1224 return 0;
1227 if (!strcmp(var, "core.deltabasecachelimit")) {
1228 delta_base_cache_limit = git_config_ulong(var, value);
1229 return 0;
1232 if (!strcmp(var, "core.autocrlf")) {
1233 if (value && !strcasecmp(value, "input")) {
1234 auto_crlf = AUTO_CRLF_INPUT;
1235 return 0;
1237 auto_crlf = git_config_bool(var, value);
1238 return 0;
1241 if (!strcmp(var, "core.safecrlf")) {
1242 int eol_rndtrp_die;
1243 if (value && !strcasecmp(value, "warn")) {
1244 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1245 return 0;
1247 eol_rndtrp_die = git_config_bool(var, value);
1248 global_conv_flags_eol = eol_rndtrp_die ?
1249 CONV_EOL_RNDTRP_DIE : 0;
1250 return 0;
1253 if (!strcmp(var, "core.eol")) {
1254 if (value && !strcasecmp(value, "lf"))
1255 core_eol = EOL_LF;
1256 else if (value && !strcasecmp(value, "crlf"))
1257 core_eol = EOL_CRLF;
1258 else if (value && !strcasecmp(value, "native"))
1259 core_eol = EOL_NATIVE;
1260 else
1261 core_eol = EOL_UNSET;
1262 return 0;
1265 if (!strcmp(var, "core.checkroundtripencoding")) {
1266 check_roundtrip_encoding = xstrdup(value);
1267 return 0;
1270 if (!strcmp(var, "core.notesref")) {
1271 notes_ref_name = xstrdup(value);
1272 return 0;
1275 if (!strcmp(var, "core.editor"))
1276 return git_config_string(&editor_program, var, value);
1278 if (!strcmp(var, "core.commentchar")) {
1279 if (!value)
1280 return config_error_nonbool(var);
1281 else if (!strcasecmp(value, "auto"))
1282 auto_comment_line_char = 1;
1283 else if (value[0] && !value[1]) {
1284 comment_line_char = value[0];
1285 auto_comment_line_char = 0;
1286 } else
1287 return error("core.commentChar should only be one character");
1288 return 0;
1291 if (!strcmp(var, "core.askpass"))
1292 return git_config_string(&askpass_program, var, value);
1294 if (!strcmp(var, "core.excludesfile"))
1295 return git_config_pathname(&excludes_file, var, value);
1297 if (!strcmp(var, "core.whitespace")) {
1298 if (!value)
1299 return config_error_nonbool(var);
1300 whitespace_rule_cfg = parse_whitespace_rule(value);
1301 return 0;
1304 if (!strcmp(var, "core.fsyncobjectfiles")) {
1305 fsync_object_files = git_config_bool(var, value);
1306 return 0;
1309 if (!strcmp(var, "core.preloadindex")) {
1310 core_preload_index = git_config_bool(var, value);
1311 return 0;
1314 if (!strcmp(var, "core.createobject")) {
1315 if (!strcmp(value, "rename"))
1316 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1317 else if (!strcmp(value, "link"))
1318 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1319 else
1320 die(_("invalid mode for object creation: %s"), value);
1321 return 0;
1324 if (!strcmp(var, "core.sparsecheckout")) {
1325 core_apply_sparse_checkout = git_config_bool(var, value);
1326 return 0;
1329 if (!strcmp(var, "core.precomposeunicode")) {
1330 precomposed_unicode = git_config_bool(var, value);
1331 return 0;
1334 if (!strcmp(var, "core.protecthfs")) {
1335 protect_hfs = git_config_bool(var, value);
1336 return 0;
1339 if (!strcmp(var, "core.protectntfs")) {
1340 protect_ntfs = git_config_bool(var, value);
1341 return 0;
1344 if (!strcmp(var, "core.hidedotfiles")) {
1345 if (value && !strcasecmp(value, "dotgitonly"))
1346 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1347 else
1348 hide_dotfiles = git_config_bool(var, value);
1349 return 0;
1352 if (!strcmp(var, "core.partialclonefilter")) {
1353 return git_config_string(&core_partial_clone_filter_default,
1354 var, value);
1357 /* Add other config variables here and to Documentation/config.txt. */
1358 return 0;
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 *dummy)
1445 if (starts_with(var, "core."))
1446 return git_default_core_config(var, value);
1448 if (starts_with(var, "user."))
1449 return git_ident_config(var, value, dummy);
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
1672 repo_config = NULL;
1674 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1675 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1676 ret += git_config_from_file(fn, git_etc_gitconfig(),
1677 data);
1679 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1680 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1681 ret += git_config_from_file(fn, xdg_config, data);
1683 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1684 ret += git_config_from_file(fn, user_config, data);
1686 current_parsing_scope = CONFIG_SCOPE_REPO;
1687 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1688 ret += git_config_from_file(fn, repo_config, data);
1690 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1691 if (git_config_from_parameters(fn, data) < 0)
1692 die(_("unable to parse command-line config"));
1694 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1695 free(xdg_config);
1696 free(user_config);
1697 free(repo_config);
1698 return ret;
1701 int config_with_options(config_fn_t fn, void *data,
1702 struct git_config_source *config_source,
1703 const struct config_options *opts)
1705 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1707 if (opts->respect_includes) {
1708 inc.fn = fn;
1709 inc.data = data;
1710 inc.opts = opts;
1711 fn = git_config_include;
1712 data = &inc;
1716 * If we have a specific filename, use it. Otherwise, follow the
1717 * regular lookup sequence.
1719 if (config_source && config_source->use_stdin)
1720 return git_config_from_stdin(fn, data);
1721 else if (config_source && config_source->file)
1722 return git_config_from_file(fn, config_source->file, data);
1723 else if (config_source && config_source->blob)
1724 return git_config_from_blob_ref(fn, config_source->blob, data);
1726 return do_git_config_sequence(opts, fn, data);
1729 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1731 int i, value_index;
1732 struct string_list *values;
1733 struct config_set_element *entry;
1734 struct configset_list *list = &cs->list;
1736 for (i = 0; i < list->nr; i++) {
1737 entry = list->items[i].e;
1738 value_index = list->items[i].value_index;
1739 values = &entry->value_list;
1741 current_config_kvi = values->items[value_index].util;
1743 if (fn(entry->key, values->items[value_index].string, data) < 0)
1744 git_die_config_linenr(entry->key,
1745 current_config_kvi->filename,
1746 current_config_kvi->linenr);
1748 current_config_kvi = NULL;
1752 void read_early_config(config_fn_t cb, void *data)
1754 struct config_options opts = {0};
1755 struct strbuf commondir = STRBUF_INIT;
1756 struct strbuf gitdir = STRBUF_INIT;
1758 opts.respect_includes = 1;
1760 if (have_git_dir()) {
1761 opts.commondir = get_git_common_dir();
1762 opts.git_dir = get_git_dir();
1764 * When setup_git_directory() was not yet asked to discover the
1765 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1766 * is any repository config we should use (but unlike
1767 * setup_git_directory_gently(), no global state is changed, most
1768 * notably, the current working directory is still the same after the
1769 * call).
1771 } else if (!discover_git_directory(&commondir, &gitdir)) {
1772 opts.commondir = commondir.buf;
1773 opts.git_dir = gitdir.buf;
1776 config_with_options(cb, data, NULL, &opts);
1778 strbuf_release(&commondir);
1779 strbuf_release(&gitdir);
1782 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1784 struct config_set_element k;
1785 struct config_set_element *found_entry;
1786 char *normalized_key;
1788 * `key` may come from the user, so normalize it before using it
1789 * for querying entries from the hashmap.
1791 if (git_config_parse_key(key, &normalized_key, NULL))
1792 return NULL;
1794 hashmap_entry_init(&k, strhash(normalized_key));
1795 k.key = normalized_key;
1796 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1797 free(normalized_key);
1798 return found_entry;
1801 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1803 struct config_set_element *e;
1804 struct string_list_item *si;
1805 struct configset_list_item *l_item;
1806 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1808 e = configset_find_element(cs, key);
1810 * Since the keys are being fed by git_config*() callback mechanism, they
1811 * are already normalized. So simply add them without any further munging.
1813 if (!e) {
1814 e = xmalloc(sizeof(*e));
1815 hashmap_entry_init(e, strhash(key));
1816 e->key = xstrdup(key);
1817 string_list_init(&e->value_list, 1);
1818 hashmap_add(&cs->config_hash, e);
1820 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1822 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1823 l_item = &cs->list.items[cs->list.nr++];
1824 l_item->e = e;
1825 l_item->value_index = e->value_list.nr - 1;
1827 if (!cf)
1828 BUG("configset_add_value has no source");
1829 if (cf->name) {
1830 kv_info->filename = strintern(cf->name);
1831 kv_info->linenr = cf->linenr;
1832 kv_info->origin_type = cf->origin_type;
1833 } else {
1834 /* for values read from `git_config_from_parameters()` */
1835 kv_info->filename = NULL;
1836 kv_info->linenr = -1;
1837 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1839 kv_info->scope = current_parsing_scope;
1840 si->util = kv_info;
1842 return 0;
1845 static int config_set_element_cmp(const void *unused_cmp_data,
1846 const void *entry,
1847 const void *entry_or_key,
1848 const void *unused_keydata)
1850 const struct config_set_element *e1 = entry;
1851 const struct config_set_element *e2 = entry_or_key;
1853 return strcmp(e1->key, e2->key);
1856 void git_configset_init(struct config_set *cs)
1858 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1859 cs->hash_initialized = 1;
1860 cs->list.nr = 0;
1861 cs->list.alloc = 0;
1862 cs->list.items = NULL;
1865 void git_configset_clear(struct config_set *cs)
1867 struct config_set_element *entry;
1868 struct hashmap_iter iter;
1869 if (!cs->hash_initialized)
1870 return;
1872 hashmap_iter_init(&cs->config_hash, &iter);
1873 while ((entry = hashmap_iter_next(&iter))) {
1874 free(entry->key);
1875 string_list_clear(&entry->value_list, 1);
1877 hashmap_free(&cs->config_hash, 1);
1878 cs->hash_initialized = 0;
1879 free(cs->list.items);
1880 cs->list.nr = 0;
1881 cs->list.alloc = 0;
1882 cs->list.items = NULL;
1885 static int config_set_callback(const char *key, const char *value, void *cb)
1887 struct config_set *cs = cb;
1888 configset_add_value(cs, key, value);
1889 return 0;
1892 int git_configset_add_file(struct config_set *cs, const char *filename)
1894 return git_config_from_file(config_set_callback, filename, cs);
1897 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1899 const struct string_list *values = NULL;
1901 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1902 * queried key in the files of the configset, the value returned will be the last
1903 * value in the value list for that key.
1905 values = git_configset_get_value_multi(cs, key);
1907 if (!values)
1908 return 1;
1909 assert(values->nr > 0);
1910 *value = values->items[values->nr - 1].string;
1911 return 0;
1914 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1916 struct config_set_element *e = configset_find_element(cs, key);
1917 return e ? &e->value_list : NULL;
1920 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1922 const char *value;
1923 if (!git_configset_get_value(cs, key, &value))
1924 return git_config_string(dest, key, value);
1925 else
1926 return 1;
1929 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1931 return git_configset_get_string_const(cs, key, (const char **)dest);
1934 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1936 const char *value;
1937 if (!git_configset_get_value(cs, key, &value)) {
1938 *dest = git_config_int(key, value);
1939 return 0;
1940 } else
1941 return 1;
1944 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1946 const char *value;
1947 if (!git_configset_get_value(cs, key, &value)) {
1948 *dest = git_config_ulong(key, value);
1949 return 0;
1950 } else
1951 return 1;
1954 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1956 const char *value;
1957 if (!git_configset_get_value(cs, key, &value)) {
1958 *dest = git_config_bool(key, value);
1959 return 0;
1960 } else
1961 return 1;
1964 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1965 int *is_bool, int *dest)
1967 const char *value;
1968 if (!git_configset_get_value(cs, key, &value)) {
1969 *dest = git_config_bool_or_int(key, value, is_bool);
1970 return 0;
1971 } else
1972 return 1;
1975 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1977 const char *value;
1978 if (!git_configset_get_value(cs, key, &value)) {
1979 *dest = git_parse_maybe_bool(value);
1980 if (*dest == -1)
1981 return -1;
1982 return 0;
1983 } else
1984 return 1;
1987 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1989 const char *value;
1990 if (!git_configset_get_value(cs, key, &value))
1991 return git_config_pathname(dest, key, value);
1992 else
1993 return 1;
1996 /* Functions use to read configuration from a repository */
1997 static void repo_read_config(struct repository *repo)
1999 struct config_options opts;
2001 opts.respect_includes = 1;
2002 opts.commondir = repo->commondir;
2003 opts.git_dir = repo->gitdir;
2005 if (!repo->config)
2006 repo->config = xcalloc(1, sizeof(struct config_set));
2007 else
2008 git_configset_clear(repo->config);
2010 git_configset_init(repo->config);
2012 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2014 * config_with_options() normally returns only
2015 * zero, as most errors are fatal, and
2016 * non-fatal potential errors are guarded by "if"
2017 * statements that are entered only when no error is
2018 * possible.
2020 * If we ever encounter a non-fatal error, it means
2021 * something went really wrong and we should stop
2022 * immediately.
2024 die(_("unknown error occurred while reading the configuration files"));
2027 static void git_config_check_init(struct repository *repo)
2029 if (repo->config && repo->config->hash_initialized)
2030 return;
2031 repo_read_config(repo);
2034 static void repo_config_clear(struct repository *repo)
2036 if (!repo->config || !repo->config->hash_initialized)
2037 return;
2038 git_configset_clear(repo->config);
2041 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2043 git_config_check_init(repo);
2044 configset_iter(repo->config, fn, data);
2047 int repo_config_get_value(struct repository *repo,
2048 const char *key, const char **value)
2050 git_config_check_init(repo);
2051 return git_configset_get_value(repo->config, key, value);
2054 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2055 const char *key)
2057 git_config_check_init(repo);
2058 return git_configset_get_value_multi(repo->config, key);
2061 int repo_config_get_string_const(struct repository *repo,
2062 const char *key, const char **dest)
2064 int ret;
2065 git_config_check_init(repo);
2066 ret = git_configset_get_string_const(repo->config, key, dest);
2067 if (ret < 0)
2068 git_die_config(key, NULL);
2069 return ret;
2072 int repo_config_get_string(struct repository *repo,
2073 const char *key, char **dest)
2075 git_config_check_init(repo);
2076 return repo_config_get_string_const(repo, key, (const char **)dest);
2079 int repo_config_get_int(struct repository *repo,
2080 const char *key, int *dest)
2082 git_config_check_init(repo);
2083 return git_configset_get_int(repo->config, key, dest);
2086 int repo_config_get_ulong(struct repository *repo,
2087 const char *key, unsigned long *dest)
2089 git_config_check_init(repo);
2090 return git_configset_get_ulong(repo->config, key, dest);
2093 int repo_config_get_bool(struct repository *repo,
2094 const char *key, int *dest)
2096 git_config_check_init(repo);
2097 return git_configset_get_bool(repo->config, key, dest);
2100 int repo_config_get_bool_or_int(struct repository *repo,
2101 const char *key, int *is_bool, int *dest)
2103 git_config_check_init(repo);
2104 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2107 int repo_config_get_maybe_bool(struct repository *repo,
2108 const char *key, int *dest)
2110 git_config_check_init(repo);
2111 return git_configset_get_maybe_bool(repo->config, key, dest);
2114 int repo_config_get_pathname(struct repository *repo,
2115 const char *key, const char **dest)
2117 int ret;
2118 git_config_check_init(repo);
2119 ret = git_configset_get_pathname(repo->config, key, dest);
2120 if (ret < 0)
2121 git_die_config(key, NULL);
2122 return ret;
2125 /* Functions used historically to read configuration from 'the_repository' */
2126 void git_config(config_fn_t fn, void *data)
2128 repo_config(the_repository, fn, data);
2131 void git_config_clear(void)
2133 repo_config_clear(the_repository);
2136 int git_config_get_value(const char *key, const char **value)
2138 return repo_config_get_value(the_repository, key, value);
2141 const struct string_list *git_config_get_value_multi(const char *key)
2143 return repo_config_get_value_multi(the_repository, key);
2146 int git_config_get_string_const(const char *key, const char **dest)
2148 return repo_config_get_string_const(the_repository, key, dest);
2151 int git_config_get_string(const char *key, char **dest)
2153 return repo_config_get_string(the_repository, key, dest);
2156 int git_config_get_int(const char *key, int *dest)
2158 return repo_config_get_int(the_repository, key, dest);
2161 int git_config_get_ulong(const char *key, unsigned long *dest)
2163 return repo_config_get_ulong(the_repository, key, dest);
2166 int git_config_get_bool(const char *key, int *dest)
2168 return repo_config_get_bool(the_repository, key, dest);
2171 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2173 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2176 int git_config_get_maybe_bool(const char *key, int *dest)
2178 return repo_config_get_maybe_bool(the_repository, key, dest);
2181 int git_config_get_pathname(const char *key, const char **dest)
2183 return repo_config_get_pathname(the_repository, key, dest);
2186 int git_config_get_expiry(const char *key, const char **output)
2188 int ret = git_config_get_string_const(key, output);
2189 if (ret)
2190 return ret;
2191 if (strcmp(*output, "now")) {
2192 timestamp_t now = approxidate("now");
2193 if (approxidate(*output) >= now)
2194 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2196 return ret;
2199 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2201 char *expiry_string;
2202 intmax_t days;
2203 timestamp_t when;
2205 if (git_config_get_string(key, &expiry_string))
2206 return 1; /* no such thing */
2208 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2209 const int scale = 86400;
2210 *expiry = now - days * scale;
2211 return 0;
2214 if (!parse_expiry_date(expiry_string, &when)) {
2215 *expiry = when;
2216 return 0;
2218 return -1; /* thing exists but cannot be parsed */
2221 int git_config_get_untracked_cache(void)
2223 int val = -1;
2224 const char *v;
2226 /* Hack for test programs like test-dump-untracked-cache */
2227 if (ignore_untracked_cache_config)
2228 return -1;
2230 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2231 return val;
2233 if (!git_config_get_value("core.untrackedcache", &v)) {
2234 if (!strcasecmp(v, "keep"))
2235 return -1;
2237 error(_("unknown core.untrackedCache value '%s'; "
2238 "using 'keep' default value"), v);
2239 return -1;
2242 return -1; /* default value */
2245 int git_config_get_split_index(void)
2247 int val;
2249 if (!git_config_get_maybe_bool("core.splitindex", &val))
2250 return val;
2252 return -1; /* default value */
2255 int git_config_get_max_percent_split_change(void)
2257 int val = -1;
2259 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2260 if (0 <= val && val <= 100)
2261 return val;
2263 return error(_("splitIndex.maxPercentChange value '%d' "
2264 "should be between 0 and 100"), val);
2267 return -1; /* default value */
2270 int git_config_get_fsmonitor(void)
2272 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2273 core_fsmonitor = getenv("GIT_FSMONITOR_TEST");
2275 if (core_fsmonitor && !*core_fsmonitor)
2276 core_fsmonitor = NULL;
2278 if (core_fsmonitor)
2279 return 1;
2281 return 0;
2284 NORETURN
2285 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2287 if (!filename)
2288 die(_("unable to parse '%s' from command-line config"), key);
2289 else
2290 die(_("bad config variable '%s' in file '%s' at line %d"),
2291 key, filename, linenr);
2294 NORETURN __attribute__((format(printf, 2, 3)))
2295 void git_die_config(const char *key, const char *err, ...)
2297 const struct string_list *values;
2298 struct key_value_info *kv_info;
2300 if (err) {
2301 va_list params;
2302 va_start(params, err);
2303 vreportf("error: ", err, params);
2304 va_end(params);
2306 values = git_config_get_value_multi(key);
2307 kv_info = values->items[values->nr - 1].util;
2308 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2312 * Find all the stuff for git_config_set() below.
2315 struct config_store_data {
2316 int baselen;
2317 char *key;
2318 int do_not_match;
2319 regex_t *value_regex;
2320 int multi_replace;
2321 struct {
2322 size_t begin, end;
2323 enum config_event_t type;
2324 int is_keys_section;
2325 } *parsed;
2326 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2327 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2330 static void config_store_data_clear(struct config_store_data *store)
2332 free(store->key);
2333 if (store->value_regex != NULL &&
2334 store->value_regex != CONFIG_REGEX_NONE) {
2335 regfree(store->value_regex);
2336 free(store->value_regex);
2338 free(store->parsed);
2339 free(store->seen);
2340 memset(store, 0, sizeof(*store));
2343 static int matches(const char *key, const char *value,
2344 const struct config_store_data *store)
2346 if (strcmp(key, store->key))
2347 return 0; /* not ours */
2348 if (!store->value_regex)
2349 return 1; /* always matches */
2350 if (store->value_regex == CONFIG_REGEX_NONE)
2351 return 0; /* never matches */
2353 return store->do_not_match ^
2354 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2357 static int store_aux_event(enum config_event_t type,
2358 size_t begin, size_t end, void *data)
2360 struct config_store_data *store = data;
2362 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2363 store->parsed[store->parsed_nr].begin = begin;
2364 store->parsed[store->parsed_nr].end = end;
2365 store->parsed[store->parsed_nr].type = type;
2367 if (type == CONFIG_EVENT_SECTION) {
2368 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2369 return error("invalid section name '%s'", cf->var.buf);
2371 /* Is this the section we were looking for? */
2372 store->is_keys_section =
2373 store->parsed[store->parsed_nr].is_keys_section =
2374 cf->var.len - 1 == store->baselen &&
2375 !strncasecmp(cf->var.buf, store->key, store->baselen);
2376 if (store->is_keys_section) {
2377 store->section_seen = 1;
2378 ALLOC_GROW(store->seen, store->seen_nr + 1,
2379 store->seen_alloc);
2380 store->seen[store->seen_nr] = store->parsed_nr;
2384 store->parsed_nr++;
2386 return 0;
2389 static int store_aux(const char *key, const char *value, void *cb)
2391 struct config_store_data *store = cb;
2393 if (store->key_seen) {
2394 if (matches(key, value, store)) {
2395 if (store->seen_nr == 1 && store->multi_replace == 0) {
2396 warning(_("%s has multiple values"), key);
2399 ALLOC_GROW(store->seen, store->seen_nr + 1,
2400 store->seen_alloc);
2402 store->seen[store->seen_nr] = store->parsed_nr;
2403 store->seen_nr++;
2405 } else if (store->is_keys_section) {
2407 * Do not increment matches yet: this may not be a match, but we
2408 * are in the desired section.
2410 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2411 store->seen[store->seen_nr] = store->parsed_nr;
2412 store->section_seen = 1;
2414 if (matches(key, value, store)) {
2415 store->seen_nr++;
2416 store->key_seen = 1;
2420 return 0;
2423 static int write_error(const char *filename)
2425 error("failed to write new configuration file %s", filename);
2427 /* Same error code as "failed to rename". */
2428 return 4;
2431 static struct strbuf store_create_section(const char *key,
2432 const struct config_store_data *store)
2434 const char *dot;
2435 int i;
2436 struct strbuf sb = STRBUF_INIT;
2438 dot = memchr(key, '.', store->baselen);
2439 if (dot) {
2440 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2441 for (i = dot - key + 1; i < store->baselen; i++) {
2442 if (key[i] == '"' || key[i] == '\\')
2443 strbuf_addch(&sb, '\\');
2444 strbuf_addch(&sb, key[i]);
2446 strbuf_addstr(&sb, "\"]\n");
2447 } else {
2448 strbuf_addf(&sb, "[%.*s]\n", store->baselen, key);
2451 return sb;
2454 static ssize_t write_section(int fd, const char *key,
2455 const struct config_store_data *store)
2457 struct strbuf sb = store_create_section(key, store);
2458 ssize_t ret;
2460 ret = write_in_full(fd, sb.buf, sb.len);
2461 strbuf_release(&sb);
2463 return ret;
2466 static ssize_t write_pair(int fd, const char *key, const char *value,
2467 const struct config_store_data *store)
2469 int i;
2470 ssize_t ret;
2471 int length = strlen(key + store->baselen + 1);
2472 const char *quote = "";
2473 struct strbuf sb = STRBUF_INIT;
2476 * Check to see if the value needs to be surrounded with a dq pair.
2477 * Note that problematic characters are always backslash-quoted; this
2478 * check is about not losing leading or trailing SP and strings that
2479 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2480 * configuration parser.
2482 if (value[0] == ' ')
2483 quote = "\"";
2484 for (i = 0; value[i]; i++)
2485 if (value[i] == ';' || value[i] == '#')
2486 quote = "\"";
2487 if (i && value[i - 1] == ' ')
2488 quote = "\"";
2490 strbuf_addf(&sb, "\t%.*s = %s",
2491 length, key + store->baselen + 1, quote);
2493 for (i = 0; value[i]; i++)
2494 switch (value[i]) {
2495 case '\n':
2496 strbuf_addstr(&sb, "\\n");
2497 break;
2498 case '\t':
2499 strbuf_addstr(&sb, "\\t");
2500 break;
2501 case '"':
2502 case '\\':
2503 strbuf_addch(&sb, '\\');
2504 /* fallthrough */
2505 default:
2506 strbuf_addch(&sb, value[i]);
2507 break;
2509 strbuf_addf(&sb, "%s\n", quote);
2511 ret = write_in_full(fd, sb.buf, sb.len);
2512 strbuf_release(&sb);
2514 return ret;
2518 * If we are about to unset the last key(s) in a section, and if there are
2519 * no comments surrounding (or included in) the section, we will want to
2520 * extend begin/end to remove the entire section.
2522 * Note: the parameter `seen_ptr` points to the index into the store.seen
2523 * array. * This index may be incremented if a section has more than one
2524 * entry (which all are to be removed).
2526 static void maybe_remove_section(struct config_store_data *store,
2527 const char *contents,
2528 size_t *begin_offset, size_t *end_offset,
2529 int *seen_ptr)
2531 size_t begin;
2532 int i, seen, section_seen = 0;
2535 * First, ensure that this is the first key, and that there are no
2536 * comments before the entry nor before the section header.
2538 seen = *seen_ptr;
2539 for (i = store->seen[seen]; i > 0; i--) {
2540 enum config_event_t type = store->parsed[i - 1].type;
2542 if (type == CONFIG_EVENT_COMMENT)
2543 /* There is a comment before this entry or section */
2544 return;
2545 if (type == CONFIG_EVENT_ENTRY) {
2546 if (!section_seen)
2547 /* This is not the section's first entry. */
2548 return;
2549 /* We encountered no comment before the section. */
2550 break;
2552 if (type == CONFIG_EVENT_SECTION) {
2553 if (!store->parsed[i - 1].is_keys_section)
2554 break;
2555 section_seen = 1;
2558 begin = store->parsed[i].begin;
2561 * Next, make sure that we are removing he last key(s) in the section,
2562 * and that there are no comments that are possibly about the current
2563 * section.
2565 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2566 enum config_event_t type = store->parsed[i].type;
2568 if (type == CONFIG_EVENT_COMMENT)
2569 return;
2570 if (type == CONFIG_EVENT_SECTION) {
2571 if (store->parsed[i].is_keys_section)
2572 continue;
2573 break;
2575 if (type == CONFIG_EVENT_ENTRY) {
2576 if (++seen < store->seen_nr &&
2577 i == store->seen[seen])
2578 /* We want to remove this entry, too */
2579 continue;
2580 /* There is another entry in this section. */
2581 return;
2586 * We are really removing the last entry/entries from this section, and
2587 * there are no enclosed or surrounding comments. Remove the entire,
2588 * now-empty section.
2590 *seen_ptr = seen;
2591 *begin_offset = begin;
2592 if (i < store->parsed_nr)
2593 *end_offset = store->parsed[i].begin;
2594 else
2595 *end_offset = store->parsed[store->parsed_nr - 1].end;
2598 int git_config_set_in_file_gently(const char *config_filename,
2599 const char *key, const char *value)
2601 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2604 void git_config_set_in_file(const char *config_filename,
2605 const char *key, const char *value)
2607 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2610 int git_config_set_gently(const char *key, const char *value)
2612 return git_config_set_multivar_gently(key, value, NULL, 0);
2615 void git_config_set(const char *key, const char *value)
2617 git_config_set_multivar(key, value, NULL, 0);
2621 * If value==NULL, unset in (remove from) config,
2622 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2623 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2624 * (only add a new one)
2625 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2626 * else all matching key/values (regardless how many) are removed,
2627 * before the new pair is written.
2629 * Returns 0 on success.
2631 * This function does this:
2633 * - it locks the config file by creating ".git/config.lock"
2635 * - it then parses the config using store_aux() as validator to find
2636 * the position on the key/value pair to replace. If it is to be unset,
2637 * it must be found exactly once.
2639 * - the config file is mmap()ed and the part before the match (if any) is
2640 * written to the lock file, then the changed part and the rest.
2642 * - the config file is removed and the lock file rename()d to it.
2645 int git_config_set_multivar_in_file_gently(const char *config_filename,
2646 const char *key, const char *value,
2647 const char *value_regex,
2648 int multi_replace)
2650 int fd = -1, in_fd = -1;
2651 int ret;
2652 struct lock_file lock = LOCK_INIT;
2653 char *filename_buf = NULL;
2654 char *contents = NULL;
2655 size_t contents_sz;
2656 struct config_store_data store;
2658 memset(&store, 0, sizeof(store));
2660 /* parse-key returns negative; flip the sign to feed exit(3) */
2661 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2662 if (ret)
2663 goto out_free;
2665 store.multi_replace = multi_replace;
2667 if (!config_filename)
2668 config_filename = filename_buf = git_pathdup("config");
2671 * The lock serves a purpose in addition to locking: the new
2672 * contents of .git/config will be written into it.
2674 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2675 if (fd < 0) {
2676 error_errno("could not lock config file %s", config_filename);
2677 ret = CONFIG_NO_LOCK;
2678 goto out_free;
2682 * If .git/config does not exist yet, write a minimal version.
2684 in_fd = open(config_filename, O_RDONLY);
2685 if ( in_fd < 0 ) {
2686 if ( ENOENT != errno ) {
2687 error_errno("opening %s", config_filename);
2688 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2689 goto out_free;
2691 /* if nothing to unset, error out */
2692 if (value == NULL) {
2693 ret = CONFIG_NOTHING_SET;
2694 goto out_free;
2697 free(store.key);
2698 store.key = xstrdup(key);
2699 if (write_section(fd, key, &store) < 0 ||
2700 write_pair(fd, key, value, &store) < 0)
2701 goto write_err_out;
2702 } else {
2703 struct stat st;
2704 size_t copy_begin, copy_end;
2705 int i, new_line = 0;
2706 struct config_options opts;
2708 if (value_regex == NULL)
2709 store.value_regex = NULL;
2710 else if (value_regex == CONFIG_REGEX_NONE)
2711 store.value_regex = CONFIG_REGEX_NONE;
2712 else {
2713 if (value_regex[0] == '!') {
2714 store.do_not_match = 1;
2715 value_regex++;
2716 } else
2717 store.do_not_match = 0;
2719 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2720 if (regcomp(store.value_regex, value_regex,
2721 REG_EXTENDED)) {
2722 error("invalid pattern: %s", value_regex);
2723 FREE_AND_NULL(store.value_regex);
2724 ret = CONFIG_INVALID_PATTERN;
2725 goto out_free;
2729 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2730 store.parsed[0].end = 0;
2732 memset(&opts, 0, sizeof(opts));
2733 opts.event_fn = store_aux_event;
2734 opts.event_fn_data = &store;
2737 * After this, store.parsed will contain offsets of all the
2738 * parsed elements, and store.seen will contain a list of
2739 * matches, as indices into store.parsed.
2741 * As a side effect, we make sure to transform only a valid
2742 * existing config file.
2744 if (git_config_from_file_with_options(store_aux,
2745 config_filename,
2746 &store, &opts)) {
2747 error("invalid config file %s", config_filename);
2748 ret = CONFIG_INVALID_FILE;
2749 goto out_free;
2752 /* if nothing to unset, or too many matches, error out */
2753 if ((store.seen_nr == 0 && value == NULL) ||
2754 (store.seen_nr > 1 && multi_replace == 0)) {
2755 ret = CONFIG_NOTHING_SET;
2756 goto out_free;
2759 if (fstat(in_fd, &st) == -1) {
2760 error_errno(_("fstat on %s failed"), config_filename);
2761 ret = CONFIG_INVALID_FILE;
2762 goto out_free;
2765 contents_sz = xsize_t(st.st_size);
2766 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2767 MAP_PRIVATE, in_fd, 0);
2768 if (contents == MAP_FAILED) {
2769 if (errno == ENODEV && S_ISDIR(st.st_mode))
2770 errno = EISDIR;
2771 error_errno("unable to mmap '%s'", config_filename);
2772 ret = CONFIG_INVALID_FILE;
2773 contents = NULL;
2774 goto out_free;
2776 close(in_fd);
2777 in_fd = -1;
2779 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2780 error_errno("chmod on %s failed", get_lock_file_path(&lock));
2781 ret = CONFIG_NO_WRITE;
2782 goto out_free;
2785 if (store.seen_nr == 0) {
2786 if (!store.seen_alloc) {
2787 /* Did not see key nor section */
2788 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2789 store.seen[0] = store.parsed_nr
2790 - !!store.parsed_nr;
2792 store.seen_nr = 1;
2795 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2796 size_t replace_end;
2797 int j = store.seen[i];
2799 new_line = 0;
2800 if (!store.key_seen) {
2801 copy_end = store.parsed[j].end;
2802 /* include '\n' when copying section header */
2803 if (copy_end > 0 && copy_end < contents_sz &&
2804 contents[copy_end - 1] != '\n' &&
2805 contents[copy_end] == '\n')
2806 copy_end++;
2807 replace_end = copy_end;
2808 } else {
2809 replace_end = store.parsed[j].end;
2810 copy_end = store.parsed[j].begin;
2811 if (!value)
2812 maybe_remove_section(&store, contents,
2813 &copy_end,
2814 &replace_end, &i);
2816 * Swallow preceding white-space on the same
2817 * line.
2819 while (copy_end > 0 ) {
2820 char c = contents[copy_end - 1];
2822 if (isspace(c) && c != '\n')
2823 copy_end--;
2824 else
2825 break;
2829 if (copy_end > 0 && contents[copy_end-1] != '\n')
2830 new_line = 1;
2832 /* write the first part of the config */
2833 if (copy_end > copy_begin) {
2834 if (write_in_full(fd, contents + copy_begin,
2835 copy_end - copy_begin) < 0)
2836 goto write_err_out;
2837 if (new_line &&
2838 write_str_in_full(fd, "\n") < 0)
2839 goto write_err_out;
2841 copy_begin = replace_end;
2844 /* write the pair (value == NULL means unset) */
2845 if (value != NULL) {
2846 if (!store.section_seen) {
2847 if (write_section(fd, key, &store) < 0)
2848 goto write_err_out;
2850 if (write_pair(fd, key, value, &store) < 0)
2851 goto write_err_out;
2854 /* write the rest of the config */
2855 if (copy_begin < contents_sz)
2856 if (write_in_full(fd, contents + copy_begin,
2857 contents_sz - copy_begin) < 0)
2858 goto write_err_out;
2860 munmap(contents, contents_sz);
2861 contents = NULL;
2864 if (commit_lock_file(&lock) < 0) {
2865 error_errno("could not write config file %s", config_filename);
2866 ret = CONFIG_NO_WRITE;
2867 goto out_free;
2870 ret = 0;
2872 /* Invalidate the config cache */
2873 git_config_clear();
2875 out_free:
2876 rollback_lock_file(&lock);
2877 free(filename_buf);
2878 if (contents)
2879 munmap(contents, contents_sz);
2880 if (in_fd >= 0)
2881 close(in_fd);
2882 config_store_data_clear(&store);
2883 return ret;
2885 write_err_out:
2886 ret = write_error(get_lock_file_path(&lock));
2887 goto out_free;
2891 void git_config_set_multivar_in_file(const char *config_filename,
2892 const char *key, const char *value,
2893 const char *value_regex, int multi_replace)
2895 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2896 value_regex, multi_replace))
2897 return;
2898 if (value)
2899 die(_("could not set '%s' to '%s'"), key, value);
2900 else
2901 die(_("could not unset '%s'"), key);
2904 int git_config_set_multivar_gently(const char *key, const char *value,
2905 const char *value_regex, int multi_replace)
2907 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2908 multi_replace);
2911 void git_config_set_multivar(const char *key, const char *value,
2912 const char *value_regex, int multi_replace)
2914 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2915 multi_replace);
2918 static int section_name_match (const char *buf, const char *name)
2920 int i = 0, j = 0, dot = 0;
2921 if (buf[i] != '[')
2922 return 0;
2923 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2924 if (!dot && isspace(buf[i])) {
2925 dot = 1;
2926 if (name[j++] != '.')
2927 break;
2928 for (i++; isspace(buf[i]); i++)
2929 ; /* do nothing */
2930 if (buf[i] != '"')
2931 break;
2932 continue;
2934 if (buf[i] == '\\' && dot)
2935 i++;
2936 else if (buf[i] == '"' && dot) {
2937 for (i++; isspace(buf[i]); i++)
2938 ; /* do_nothing */
2939 break;
2941 if (buf[i] != name[j++])
2942 break;
2944 if (buf[i] == ']' && name[j] == 0) {
2946 * We match, now just find the right length offset by
2947 * gobbling up any whitespace after it, as well
2949 i++;
2950 for (; buf[i] && isspace(buf[i]); i++)
2951 ; /* do nothing */
2952 return i;
2954 return 0;
2957 static int section_name_is_ok(const char *name)
2959 /* Empty section names are bogus. */
2960 if (!*name)
2961 return 0;
2964 * Before a dot, we must be alphanumeric or dash. After the first dot,
2965 * anything goes, so we can stop checking.
2967 for (; *name && *name != '.'; name++)
2968 if (*name != '-' && !isalnum(*name))
2969 return 0;
2970 return 1;
2973 /* if new_name == NULL, the section is removed instead */
2974 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
2975 const char *old_name,
2976 const char *new_name, int copy)
2978 int ret = 0, remove = 0;
2979 char *filename_buf = NULL;
2980 struct lock_file lock = LOCK_INIT;
2981 int out_fd;
2982 char buf[1024];
2983 FILE *config_file = NULL;
2984 struct stat st;
2985 struct strbuf copystr = STRBUF_INIT;
2986 struct config_store_data store;
2988 memset(&store, 0, sizeof(store));
2990 if (new_name && !section_name_is_ok(new_name)) {
2991 ret = error("invalid section name: %s", new_name);
2992 goto out_no_rollback;
2995 if (!config_filename)
2996 config_filename = filename_buf = git_pathdup("config");
2998 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
2999 if (out_fd < 0) {
3000 ret = error("could not lock config file %s", config_filename);
3001 goto out;
3004 if (!(config_file = fopen(config_filename, "rb"))) {
3005 ret = warn_on_fopen_errors(config_filename);
3006 if (ret)
3007 goto out;
3008 /* no config file means nothing to rename, no error */
3009 goto commit_and_out;
3012 if (fstat(fileno(config_file), &st) == -1) {
3013 ret = error_errno(_("fstat on %s failed"), config_filename);
3014 goto out;
3017 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3018 ret = error_errno("chmod on %s failed",
3019 get_lock_file_path(&lock));
3020 goto out;
3023 while (fgets(buf, sizeof(buf), config_file)) {
3024 int i;
3025 int length;
3026 int is_section = 0;
3027 char *output = buf;
3028 for (i = 0; buf[i] && isspace(buf[i]); i++)
3029 ; /* do nothing */
3030 if (buf[i] == '[') {
3031 /* it's a section */
3032 int offset;
3033 is_section = 1;
3036 * When encountering a new section under -c we
3037 * need to flush out any section we're already
3038 * coping and begin anew. There might be
3039 * multiple [branch "$name"] sections.
3041 if (copystr.len > 0) {
3042 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3043 ret = write_error(get_lock_file_path(&lock));
3044 goto out;
3046 strbuf_reset(&copystr);
3049 offset = section_name_match(&buf[i], old_name);
3050 if (offset > 0) {
3051 ret++;
3052 if (new_name == NULL) {
3053 remove = 1;
3054 continue;
3056 store.baselen = strlen(new_name);
3057 if (!copy) {
3058 if (write_section(out_fd, new_name, &store) < 0) {
3059 ret = write_error(get_lock_file_path(&lock));
3060 goto out;
3063 * We wrote out the new section, with
3064 * a newline, now skip the old
3065 * section's length
3067 output += offset + i;
3068 if (strlen(output) > 0) {
3070 * More content means there's
3071 * a declaration to put on the
3072 * next line; indent with a
3073 * tab
3075 output -= 1;
3076 output[0] = '\t';
3078 } else {
3079 copystr = store_create_section(new_name, &store);
3082 remove = 0;
3084 if (remove)
3085 continue;
3086 length = strlen(output);
3088 if (!is_section && copystr.len > 0) {
3089 strbuf_add(&copystr, output, length);
3092 if (write_in_full(out_fd, output, length) < 0) {
3093 ret = write_error(get_lock_file_path(&lock));
3094 goto out;
3099 * Copy a trailing section at the end of the config, won't be
3100 * flushed by the usual "flush because we have a new section
3101 * logic in the loop above.
3103 if (copystr.len > 0) {
3104 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3105 ret = write_error(get_lock_file_path(&lock));
3106 goto out;
3108 strbuf_reset(&copystr);
3111 fclose(config_file);
3112 config_file = NULL;
3113 commit_and_out:
3114 if (commit_lock_file(&lock) < 0)
3115 ret = error_errno("could not write config file %s",
3116 config_filename);
3117 out:
3118 if (config_file)
3119 fclose(config_file);
3120 rollback_lock_file(&lock);
3121 out_no_rollback:
3122 free(filename_buf);
3123 config_store_data_clear(&store);
3124 return ret;
3127 int git_config_rename_section_in_file(const char *config_filename,
3128 const char *old_name, const char *new_name)
3130 return git_config_copy_or_rename_section_in_file(config_filename,
3131 old_name, new_name, 0);
3134 int git_config_rename_section(const char *old_name, const char *new_name)
3136 return git_config_rename_section_in_file(NULL, old_name, new_name);
3139 int git_config_copy_section_in_file(const char *config_filename,
3140 const char *old_name, const char *new_name)
3142 return git_config_copy_or_rename_section_in_file(config_filename,
3143 old_name, new_name, 1);
3146 int git_config_copy_section(const char *old_name, const char *new_name)
3148 return git_config_copy_section_in_file(NULL, old_name, new_name);
3152 * Call this to report error for your variable that should not
3153 * get a boolean value (i.e. "[my] var" means "true").
3155 #undef config_error_nonbool
3156 int config_error_nonbool(const char *var)
3158 return error("missing value for '%s'", var);
3161 int parse_config_key(const char *var,
3162 const char *section,
3163 const char **subsection, int *subsection_len,
3164 const char **key)
3166 const char *dot;
3168 /* Does it start with "section." ? */
3169 if (!skip_prefix(var, section, &var) || *var != '.')
3170 return -1;
3173 * Find the key; we don't know yet if we have a subsection, but we must
3174 * parse backwards from the end, since the subsection may have dots in
3175 * it, too.
3177 dot = strrchr(var, '.');
3178 *key = dot + 1;
3180 /* Did we have a subsection at all? */
3181 if (dot == var) {
3182 if (subsection) {
3183 *subsection = NULL;
3184 *subsection_len = 0;
3187 else {
3188 if (!subsection)
3189 return -1;
3190 *subsection = var + 1;
3191 *subsection_len = dot - *subsection;
3194 return 0;
3197 const char *current_config_origin_type(void)
3199 int type;
3200 if (current_config_kvi)
3201 type = current_config_kvi->origin_type;
3202 else if(cf)
3203 type = cf->origin_type;
3204 else
3205 BUG("current_config_origin_type called outside config callback");
3207 switch (type) {
3208 case CONFIG_ORIGIN_BLOB:
3209 return "blob";
3210 case CONFIG_ORIGIN_FILE:
3211 return "file";
3212 case CONFIG_ORIGIN_STDIN:
3213 return "standard input";
3214 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3215 return "submodule-blob";
3216 case CONFIG_ORIGIN_CMDLINE:
3217 return "command line";
3218 default:
3219 BUG("unknown config origin type");
3223 const char *current_config_name(void)
3225 const char *name;
3226 if (current_config_kvi)
3227 name = current_config_kvi->filename;
3228 else if (cf)
3229 name = cf->name;
3230 else
3231 BUG("current_config_name called outside config callback");
3232 return name ? name : "";
3235 enum config_scope current_config_scope(void)
3237 if (current_config_kvi)
3238 return current_config_kvi->scope;
3239 else
3240 return current_parsing_scope;
3243 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3245 int i;
3247 for (i = 0; i < nr_mapping; i++) {
3248 const char *name = mapping[i];
3250 if (name && !strcasecmp(var, name))
3251 return i;
3253 return -1;