sideband: highlight keywords in remote sideband output
[git.git] / config.c
blob66645047eb3f9f84f185e0339807548fd562ea7d
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[] =
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 " 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 static 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 /* Add other config variables here and to Documentation/config.txt. */
1357 return 0;
1360 static int git_default_i18n_config(const char *var, const char *value)
1362 if (!strcmp(var, "i18n.commitencoding"))
1363 return git_config_string(&git_commit_encoding, var, value);
1365 if (!strcmp(var, "i18n.logoutputencoding"))
1366 return git_config_string(&git_log_output_encoding, var, value);
1368 /* Add other config variables here and to Documentation/config.txt. */
1369 return 0;
1372 static int git_default_branch_config(const char *var, const char *value)
1374 if (!strcmp(var, "branch.autosetupmerge")) {
1375 if (value && !strcasecmp(value, "always")) {
1376 git_branch_track = BRANCH_TRACK_ALWAYS;
1377 return 0;
1379 git_branch_track = git_config_bool(var, value);
1380 return 0;
1382 if (!strcmp(var, "branch.autosetuprebase")) {
1383 if (!value)
1384 return config_error_nonbool(var);
1385 else if (!strcmp(value, "never"))
1386 autorebase = AUTOREBASE_NEVER;
1387 else if (!strcmp(value, "local"))
1388 autorebase = AUTOREBASE_LOCAL;
1389 else if (!strcmp(value, "remote"))
1390 autorebase = AUTOREBASE_REMOTE;
1391 else if (!strcmp(value, "always"))
1392 autorebase = AUTOREBASE_ALWAYS;
1393 else
1394 return error("malformed value for %s", var);
1395 return 0;
1398 /* Add other config variables here and to Documentation/config.txt. */
1399 return 0;
1402 static int git_default_push_config(const char *var, const char *value)
1404 if (!strcmp(var, "push.default")) {
1405 if (!value)
1406 return config_error_nonbool(var);
1407 else if (!strcmp(value, "nothing"))
1408 push_default = PUSH_DEFAULT_NOTHING;
1409 else if (!strcmp(value, "matching"))
1410 push_default = PUSH_DEFAULT_MATCHING;
1411 else if (!strcmp(value, "simple"))
1412 push_default = PUSH_DEFAULT_SIMPLE;
1413 else if (!strcmp(value, "upstream"))
1414 push_default = PUSH_DEFAULT_UPSTREAM;
1415 else if (!strcmp(value, "tracking")) /* deprecated */
1416 push_default = PUSH_DEFAULT_UPSTREAM;
1417 else if (!strcmp(value, "current"))
1418 push_default = PUSH_DEFAULT_CURRENT;
1419 else {
1420 error("malformed value for %s: %s", var, value);
1421 return error("Must be one of nothing, matching, simple, "
1422 "upstream or current.");
1424 return 0;
1427 /* Add other config variables here and to Documentation/config.txt. */
1428 return 0;
1431 static int git_default_mailmap_config(const char *var, const char *value)
1433 if (!strcmp(var, "mailmap.file"))
1434 return git_config_pathname(&git_mailmap_file, var, value);
1435 if (!strcmp(var, "mailmap.blob"))
1436 return git_config_string(&git_mailmap_blob, var, value);
1438 /* Add other config variables here and to Documentation/config.txt. */
1439 return 0;
1442 int git_default_config(const char *var, const char *value, void *dummy)
1444 if (starts_with(var, "core."))
1445 return git_default_core_config(var, value);
1447 if (starts_with(var, "user."))
1448 return git_ident_config(var, value, dummy);
1450 if (starts_with(var, "i18n."))
1451 return git_default_i18n_config(var, value);
1453 if (starts_with(var, "branch."))
1454 return git_default_branch_config(var, value);
1456 if (starts_with(var, "push."))
1457 return git_default_push_config(var, value);
1459 if (starts_with(var, "mailmap."))
1460 return git_default_mailmap_config(var, value);
1462 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1463 return git_default_advice_config(var, value);
1465 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1466 pager_use_color = git_config_bool(var,value);
1467 return 0;
1470 if (!strcmp(var, "pack.packsizelimit")) {
1471 pack_size_limit_cfg = git_config_ulong(var, value);
1472 return 0;
1475 if (!strcmp(var, "pack.compression")) {
1476 int level = git_config_int(var, value);
1477 if (level == -1)
1478 level = Z_DEFAULT_COMPRESSION;
1479 else if (level < 0 || level > Z_BEST_COMPRESSION)
1480 die(_("bad pack compression level %d"), level);
1481 pack_compression_level = level;
1482 pack_compression_seen = 1;
1483 return 0;
1486 /* Add other config variables here and to Documentation/config.txt. */
1487 return 0;
1491 * All source specific fields in the union, die_on_error, name and the callbacks
1492 * fgetc, ungetc, ftell of top need to be initialized before calling
1493 * this function.
1495 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1496 const struct config_options *opts)
1498 int ret;
1500 /* push config-file parsing state stack */
1501 top->prev = cf;
1502 top->linenr = 1;
1503 top->eof = 0;
1504 strbuf_init(&top->value, 1024);
1505 strbuf_init(&top->var, 1024);
1506 cf = top;
1508 ret = git_parse_source(fn, data, opts);
1510 /* pop config-file parsing state stack */
1511 strbuf_release(&top->value);
1512 strbuf_release(&top->var);
1513 cf = top->prev;
1515 return ret;
1518 static int do_config_from_file(config_fn_t fn,
1519 const enum config_origin_type origin_type,
1520 const char *name, const char *path, FILE *f,
1521 void *data, const struct config_options *opts)
1523 struct config_source top;
1524 int ret;
1526 top.u.file = f;
1527 top.origin_type = origin_type;
1528 top.name = name;
1529 top.path = path;
1530 top.default_error_action = CONFIG_ERROR_DIE;
1531 top.do_fgetc = config_file_fgetc;
1532 top.do_ungetc = config_file_ungetc;
1533 top.do_ftell = config_file_ftell;
1535 flockfile(f);
1536 ret = do_config_from(&top, fn, data, opts);
1537 funlockfile(f);
1538 return ret;
1541 static int git_config_from_stdin(config_fn_t fn, void *data)
1543 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1544 data, NULL);
1547 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1548 void *data,
1549 const struct config_options *opts)
1551 int ret = -1;
1552 FILE *f;
1554 f = fopen_or_warn(filename, "r");
1555 if (f) {
1556 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1557 filename, f, data, opts);
1558 fclose(f);
1560 return ret;
1563 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1565 return git_config_from_file_with_options(fn, filename, data, NULL);
1568 int git_config_from_mem(config_fn_t fn,
1569 const enum config_origin_type origin_type,
1570 const char *name, const char *buf, size_t len,
1571 void *data, const struct config_options *opts)
1573 struct config_source top;
1575 top.u.buf.buf = buf;
1576 top.u.buf.len = len;
1577 top.u.buf.pos = 0;
1578 top.origin_type = origin_type;
1579 top.name = name;
1580 top.path = NULL;
1581 top.default_error_action = CONFIG_ERROR_ERROR;
1582 top.do_fgetc = config_buf_fgetc;
1583 top.do_ungetc = config_buf_ungetc;
1584 top.do_ftell = config_buf_ftell;
1586 return do_config_from(&top, fn, data, opts);
1589 int git_config_from_blob_oid(config_fn_t fn,
1590 const char *name,
1591 const struct object_id *oid,
1592 void *data)
1594 enum object_type type;
1595 char *buf;
1596 unsigned long size;
1597 int ret;
1599 buf = read_object_file(oid, &type, &size);
1600 if (!buf)
1601 return error("unable to load config blob object '%s'", name);
1602 if (type != OBJ_BLOB) {
1603 free(buf);
1604 return error("reference '%s' does not point to a blob", name);
1607 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1608 data, NULL);
1609 free(buf);
1611 return ret;
1614 static int git_config_from_blob_ref(config_fn_t fn,
1615 const char *name,
1616 void *data)
1618 struct object_id oid;
1620 if (get_oid(name, &oid) < 0)
1621 return error("unable to resolve config blob '%s'", name);
1622 return git_config_from_blob_oid(fn, name, &oid, data);
1625 const char *git_etc_gitconfig(void)
1627 static const char *system_wide;
1628 if (!system_wide)
1629 system_wide = system_path(ETC_GITCONFIG);
1630 return system_wide;
1634 * Parse environment variable 'k' as a boolean (in various
1635 * possible spellings); if missing, use the default value 'def'.
1637 int git_env_bool(const char *k, int def)
1639 const char *v = getenv(k);
1640 return v ? git_config_bool(k, v) : def;
1644 * Parse environment variable 'k' as ulong with possibly a unit
1645 * suffix; if missing, use the default value 'val'.
1647 unsigned long git_env_ulong(const char *k, unsigned long val)
1649 const char *v = getenv(k);
1650 if (v && !git_parse_ulong(v, &val))
1651 die("failed to parse %s", k);
1652 return val;
1655 int git_config_system(void)
1657 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1660 static int do_git_config_sequence(const struct config_options *opts,
1661 config_fn_t fn, void *data)
1663 int ret = 0;
1664 char *xdg_config = xdg_config_home("config");
1665 char *user_config = expand_user_path("~/.gitconfig", 0);
1666 char *repo_config;
1668 if (opts->commondir)
1669 repo_config = mkpathdup("%s/config", opts->commondir);
1670 else
1671 repo_config = NULL;
1673 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1674 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1675 ret += git_config_from_file(fn, git_etc_gitconfig(),
1676 data);
1678 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1679 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1680 ret += git_config_from_file(fn, xdg_config, data);
1682 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1683 ret += git_config_from_file(fn, user_config, data);
1685 current_parsing_scope = CONFIG_SCOPE_REPO;
1686 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1687 ret += git_config_from_file(fn, repo_config, data);
1689 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1690 if (git_config_from_parameters(fn, data) < 0)
1691 die(_("unable to parse command-line config"));
1693 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1694 free(xdg_config);
1695 free(user_config);
1696 free(repo_config);
1697 return ret;
1700 int config_with_options(config_fn_t fn, void *data,
1701 struct git_config_source *config_source,
1702 const struct config_options *opts)
1704 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1706 if (opts->respect_includes) {
1707 inc.fn = fn;
1708 inc.data = data;
1709 inc.opts = opts;
1710 fn = git_config_include;
1711 data = &inc;
1715 * If we have a specific filename, use it. Otherwise, follow the
1716 * regular lookup sequence.
1718 if (config_source && config_source->use_stdin)
1719 return git_config_from_stdin(fn, data);
1720 else if (config_source && config_source->file)
1721 return git_config_from_file(fn, config_source->file, data);
1722 else if (config_source && config_source->blob)
1723 return git_config_from_blob_ref(fn, config_source->blob, data);
1725 return do_git_config_sequence(opts, fn, data);
1728 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1730 int i, value_index;
1731 struct string_list *values;
1732 struct config_set_element *entry;
1733 struct configset_list *list = &cs->list;
1735 for (i = 0; i < list->nr; i++) {
1736 entry = list->items[i].e;
1737 value_index = list->items[i].value_index;
1738 values = &entry->value_list;
1740 current_config_kvi = values->items[value_index].util;
1742 if (fn(entry->key, values->items[value_index].string, data) < 0)
1743 git_die_config_linenr(entry->key,
1744 current_config_kvi->filename,
1745 current_config_kvi->linenr);
1747 current_config_kvi = NULL;
1751 void read_early_config(config_fn_t cb, void *data)
1753 struct config_options opts = {0};
1754 struct strbuf commondir = STRBUF_INIT;
1755 struct strbuf gitdir = STRBUF_INIT;
1757 opts.respect_includes = 1;
1759 if (have_git_dir()) {
1760 opts.commondir = get_git_common_dir();
1761 opts.git_dir = get_git_dir();
1763 * When setup_git_directory() was not yet asked to discover the
1764 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1765 * is any repository config we should use (but unlike
1766 * setup_git_directory_gently(), no global state is changed, most
1767 * notably, the current working directory is still the same after the
1768 * call).
1770 } else if (!discover_git_directory(&commondir, &gitdir)) {
1771 opts.commondir = commondir.buf;
1772 opts.git_dir = gitdir.buf;
1775 config_with_options(cb, data, NULL, &opts);
1777 strbuf_release(&commondir);
1778 strbuf_release(&gitdir);
1781 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1783 struct config_set_element k;
1784 struct config_set_element *found_entry;
1785 char *normalized_key;
1787 * `key` may come from the user, so normalize it before using it
1788 * for querying entries from the hashmap.
1790 if (git_config_parse_key(key, &normalized_key, NULL))
1791 return NULL;
1793 hashmap_entry_init(&k, strhash(normalized_key));
1794 k.key = normalized_key;
1795 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1796 free(normalized_key);
1797 return found_entry;
1800 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1802 struct config_set_element *e;
1803 struct string_list_item *si;
1804 struct configset_list_item *l_item;
1805 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1807 e = configset_find_element(cs, key);
1809 * Since the keys are being fed by git_config*() callback mechanism, they
1810 * are already normalized. So simply add them without any further munging.
1812 if (!e) {
1813 e = xmalloc(sizeof(*e));
1814 hashmap_entry_init(e, strhash(key));
1815 e->key = xstrdup(key);
1816 string_list_init(&e->value_list, 1);
1817 hashmap_add(&cs->config_hash, e);
1819 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1821 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1822 l_item = &cs->list.items[cs->list.nr++];
1823 l_item->e = e;
1824 l_item->value_index = e->value_list.nr - 1;
1826 if (!cf)
1827 BUG("configset_add_value has no source");
1828 if (cf->name) {
1829 kv_info->filename = strintern(cf->name);
1830 kv_info->linenr = cf->linenr;
1831 kv_info->origin_type = cf->origin_type;
1832 } else {
1833 /* for values read from `git_config_from_parameters()` */
1834 kv_info->filename = NULL;
1835 kv_info->linenr = -1;
1836 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1838 kv_info->scope = current_parsing_scope;
1839 si->util = kv_info;
1841 return 0;
1844 static int config_set_element_cmp(const void *unused_cmp_data,
1845 const void *entry,
1846 const void *entry_or_key,
1847 const void *unused_keydata)
1849 const struct config_set_element *e1 = entry;
1850 const struct config_set_element *e2 = entry_or_key;
1852 return strcmp(e1->key, e2->key);
1855 void git_configset_init(struct config_set *cs)
1857 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
1858 cs->hash_initialized = 1;
1859 cs->list.nr = 0;
1860 cs->list.alloc = 0;
1861 cs->list.items = NULL;
1864 void git_configset_clear(struct config_set *cs)
1866 struct config_set_element *entry;
1867 struct hashmap_iter iter;
1868 if (!cs->hash_initialized)
1869 return;
1871 hashmap_iter_init(&cs->config_hash, &iter);
1872 while ((entry = hashmap_iter_next(&iter))) {
1873 free(entry->key);
1874 string_list_clear(&entry->value_list, 1);
1876 hashmap_free(&cs->config_hash, 1);
1877 cs->hash_initialized = 0;
1878 free(cs->list.items);
1879 cs->list.nr = 0;
1880 cs->list.alloc = 0;
1881 cs->list.items = NULL;
1884 static int config_set_callback(const char *key, const char *value, void *cb)
1886 struct config_set *cs = cb;
1887 configset_add_value(cs, key, value);
1888 return 0;
1891 int git_configset_add_file(struct config_set *cs, const char *filename)
1893 return git_config_from_file(config_set_callback, filename, cs);
1896 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1898 const struct string_list *values = NULL;
1900 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1901 * queried key in the files of the configset, the value returned will be the last
1902 * value in the value list for that key.
1904 values = git_configset_get_value_multi(cs, key);
1906 if (!values)
1907 return 1;
1908 assert(values->nr > 0);
1909 *value = values->items[values->nr - 1].string;
1910 return 0;
1913 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1915 struct config_set_element *e = configset_find_element(cs, key);
1916 return e ? &e->value_list : NULL;
1919 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1921 const char *value;
1922 if (!git_configset_get_value(cs, key, &value))
1923 return git_config_string(dest, key, value);
1924 else
1925 return 1;
1928 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1930 return git_configset_get_string_const(cs, key, (const char **)dest);
1933 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1935 const char *value;
1936 if (!git_configset_get_value(cs, key, &value)) {
1937 *dest = git_config_int(key, value);
1938 return 0;
1939 } else
1940 return 1;
1943 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1945 const char *value;
1946 if (!git_configset_get_value(cs, key, &value)) {
1947 *dest = git_config_ulong(key, value);
1948 return 0;
1949 } else
1950 return 1;
1953 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1955 const char *value;
1956 if (!git_configset_get_value(cs, key, &value)) {
1957 *dest = git_config_bool(key, value);
1958 return 0;
1959 } else
1960 return 1;
1963 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1964 int *is_bool, int *dest)
1966 const char *value;
1967 if (!git_configset_get_value(cs, key, &value)) {
1968 *dest = git_config_bool_or_int(key, value, is_bool);
1969 return 0;
1970 } else
1971 return 1;
1974 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1976 const char *value;
1977 if (!git_configset_get_value(cs, key, &value)) {
1978 *dest = git_parse_maybe_bool(value);
1979 if (*dest == -1)
1980 return -1;
1981 return 0;
1982 } else
1983 return 1;
1986 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1988 const char *value;
1989 if (!git_configset_get_value(cs, key, &value))
1990 return git_config_pathname(dest, key, value);
1991 else
1992 return 1;
1995 /* Functions use to read configuration from a repository */
1996 static void repo_read_config(struct repository *repo)
1998 struct config_options opts;
2000 opts.respect_includes = 1;
2001 opts.commondir = repo->commondir;
2002 opts.git_dir = repo->gitdir;
2004 if (!repo->config)
2005 repo->config = xcalloc(1, sizeof(struct config_set));
2006 else
2007 git_configset_clear(repo->config);
2009 git_configset_init(repo->config);
2011 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2013 * config_with_options() normally returns only
2014 * zero, as most errors are fatal, and
2015 * non-fatal potential errors are guarded by "if"
2016 * statements that are entered only when no error is
2017 * possible.
2019 * If we ever encounter a non-fatal error, it means
2020 * something went really wrong and we should stop
2021 * immediately.
2023 die(_("unknown error occurred while reading the configuration files"));
2026 static void git_config_check_init(struct repository *repo)
2028 if (repo->config && repo->config->hash_initialized)
2029 return;
2030 repo_read_config(repo);
2033 static void repo_config_clear(struct repository *repo)
2035 if (!repo->config || !repo->config->hash_initialized)
2036 return;
2037 git_configset_clear(repo->config);
2040 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2042 git_config_check_init(repo);
2043 configset_iter(repo->config, fn, data);
2046 int repo_config_get_value(struct repository *repo,
2047 const char *key, const char **value)
2049 git_config_check_init(repo);
2050 return git_configset_get_value(repo->config, key, value);
2053 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2054 const char *key)
2056 git_config_check_init(repo);
2057 return git_configset_get_value_multi(repo->config, key);
2060 int repo_config_get_string_const(struct repository *repo,
2061 const char *key, const char **dest)
2063 int ret;
2064 git_config_check_init(repo);
2065 ret = git_configset_get_string_const(repo->config, key, dest);
2066 if (ret < 0)
2067 git_die_config(key, NULL);
2068 return ret;
2071 int repo_config_get_string(struct repository *repo,
2072 const char *key, char **dest)
2074 git_config_check_init(repo);
2075 return repo_config_get_string_const(repo, key, (const char **)dest);
2078 int repo_config_get_int(struct repository *repo,
2079 const char *key, int *dest)
2081 git_config_check_init(repo);
2082 return git_configset_get_int(repo->config, key, dest);
2085 int repo_config_get_ulong(struct repository *repo,
2086 const char *key, unsigned long *dest)
2088 git_config_check_init(repo);
2089 return git_configset_get_ulong(repo->config, key, dest);
2092 int repo_config_get_bool(struct repository *repo,
2093 const char *key, int *dest)
2095 git_config_check_init(repo);
2096 return git_configset_get_bool(repo->config, key, dest);
2099 int repo_config_get_bool_or_int(struct repository *repo,
2100 const char *key, int *is_bool, int *dest)
2102 git_config_check_init(repo);
2103 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2106 int repo_config_get_maybe_bool(struct repository *repo,
2107 const char *key, int *dest)
2109 git_config_check_init(repo);
2110 return git_configset_get_maybe_bool(repo->config, key, dest);
2113 int repo_config_get_pathname(struct repository *repo,
2114 const char *key, const char **dest)
2116 int ret;
2117 git_config_check_init(repo);
2118 ret = git_configset_get_pathname(repo->config, key, dest);
2119 if (ret < 0)
2120 git_die_config(key, NULL);
2121 return ret;
2124 /* Functions used historically to read configuration from 'the_repository' */
2125 void git_config(config_fn_t fn, void *data)
2127 repo_config(the_repository, fn, data);
2130 void git_config_clear(void)
2132 repo_config_clear(the_repository);
2135 int git_config_get_value(const char *key, const char **value)
2137 return repo_config_get_value(the_repository, key, value);
2140 const struct string_list *git_config_get_value_multi(const char *key)
2142 return repo_config_get_value_multi(the_repository, key);
2145 int git_config_get_string_const(const char *key, const char **dest)
2147 return repo_config_get_string_const(the_repository, key, dest);
2150 int git_config_get_string(const char *key, char **dest)
2152 return repo_config_get_string(the_repository, key, dest);
2155 int git_config_get_int(const char *key, int *dest)
2157 return repo_config_get_int(the_repository, key, dest);
2160 int git_config_get_ulong(const char *key, unsigned long *dest)
2162 return repo_config_get_ulong(the_repository, key, dest);
2165 int git_config_get_bool(const char *key, int *dest)
2167 return repo_config_get_bool(the_repository, key, dest);
2170 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2172 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2175 int git_config_get_maybe_bool(const char *key, int *dest)
2177 return repo_config_get_maybe_bool(the_repository, key, dest);
2180 int git_config_get_pathname(const char *key, const char **dest)
2182 return repo_config_get_pathname(the_repository, key, dest);
2185 int git_config_get_expiry(const char *key, const char **output)
2187 int ret = git_config_get_string_const(key, output);
2188 if (ret)
2189 return ret;
2190 if (strcmp(*output, "now")) {
2191 timestamp_t now = approxidate("now");
2192 if (approxidate(*output) >= now)
2193 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2195 return ret;
2198 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2200 char *expiry_string;
2201 intmax_t days;
2202 timestamp_t when;
2204 if (git_config_get_string(key, &expiry_string))
2205 return 1; /* no such thing */
2207 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2208 const int scale = 86400;
2209 *expiry = now - days * scale;
2210 return 0;
2213 if (!parse_expiry_date(expiry_string, &when)) {
2214 *expiry = when;
2215 return 0;
2217 return -1; /* thing exists but cannot be parsed */
2220 int git_config_get_untracked_cache(void)
2222 int val = -1;
2223 const char *v;
2225 /* Hack for test programs like test-dump-untracked-cache */
2226 if (ignore_untracked_cache_config)
2227 return -1;
2229 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
2230 return val;
2232 if (!git_config_get_value("core.untrackedcache", &v)) {
2233 if (!strcasecmp(v, "keep"))
2234 return -1;
2236 error(_("unknown core.untrackedCache value '%s'; "
2237 "using 'keep' default value"), v);
2238 return -1;
2241 return -1; /* default value */
2244 int git_config_get_split_index(void)
2246 int val;
2248 if (!git_config_get_maybe_bool("core.splitindex", &val))
2249 return val;
2251 return -1; /* default value */
2254 int git_config_get_max_percent_split_change(void)
2256 int val = -1;
2258 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2259 if (0 <= val && val <= 100)
2260 return val;
2262 return error(_("splitIndex.maxPercentChange value '%d' "
2263 "should be between 0 and 100"), val);
2266 return -1; /* default value */
2269 int git_config_get_fsmonitor(void)
2271 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2272 core_fsmonitor = getenv("GIT_FSMONITOR_TEST");
2274 if (core_fsmonitor && !*core_fsmonitor)
2275 core_fsmonitor = NULL;
2277 if (core_fsmonitor)
2278 return 1;
2280 return 0;
2283 NORETURN
2284 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2286 if (!filename)
2287 die(_("unable to parse '%s' from command-line config"), key);
2288 else
2289 die(_("bad config variable '%s' in file '%s' at line %d"),
2290 key, filename, linenr);
2293 NORETURN __attribute__((format(printf, 2, 3)))
2294 void git_die_config(const char *key, const char *err, ...)
2296 const struct string_list *values;
2297 struct key_value_info *kv_info;
2299 if (err) {
2300 va_list params;
2301 va_start(params, err);
2302 vreportf("error: ", err, params);
2303 va_end(params);
2305 values = git_config_get_value_multi(key);
2306 kv_info = values->items[values->nr - 1].util;
2307 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2311 * Find all the stuff for git_config_set() below.
2314 struct config_store_data {
2315 int baselen;
2316 char *key;
2317 int do_not_match;
2318 regex_t *value_regex;
2319 int multi_replace;
2320 struct {
2321 size_t begin, end;
2322 enum config_event_t type;
2323 int is_keys_section;
2324 } *parsed;
2325 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2326 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2329 static void config_store_data_clear(struct config_store_data *store)
2331 free(store->key);
2332 if (store->value_regex != NULL &&
2333 store->value_regex != CONFIG_REGEX_NONE) {
2334 regfree(store->value_regex);
2335 free(store->value_regex);
2337 free(store->parsed);
2338 free(store->seen);
2339 memset(store, 0, sizeof(*store));
2342 static int matches(const char *key, const char *value,
2343 const struct config_store_data *store)
2345 if (strcmp(key, store->key))
2346 return 0; /* not ours */
2347 if (!store->value_regex)
2348 return 1; /* always matches */
2349 if (store->value_regex == CONFIG_REGEX_NONE)
2350 return 0; /* never matches */
2352 return store->do_not_match ^
2353 (value && !regexec(store->value_regex, value, 0, NULL, 0));
2356 static int store_aux_event(enum config_event_t type,
2357 size_t begin, size_t end, void *data)
2359 struct config_store_data *store = data;
2361 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2362 store->parsed[store->parsed_nr].begin = begin;
2363 store->parsed[store->parsed_nr].end = end;
2364 store->parsed[store->parsed_nr].type = type;
2366 if (type == CONFIG_EVENT_SECTION) {
2367 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2368 return error("invalid section name '%s'", cf->var.buf);
2370 /* Is this the section we were looking for? */
2371 store->is_keys_section =
2372 store->parsed[store->parsed_nr].is_keys_section =
2373 cf->var.len - 1 == store->baselen &&
2374 !strncasecmp(cf->var.buf, store->key, store->baselen);
2375 if (store->is_keys_section) {
2376 store->section_seen = 1;
2377 ALLOC_GROW(store->seen, store->seen_nr + 1,
2378 store->seen_alloc);
2379 store->seen[store->seen_nr] = store->parsed_nr;
2383 store->parsed_nr++;
2385 return 0;
2388 static int store_aux(const char *key, const char *value, void *cb)
2390 struct config_store_data *store = cb;
2392 if (store->key_seen) {
2393 if (matches(key, value, store)) {
2394 if (store->seen_nr == 1 && store->multi_replace == 0) {
2395 warning(_("%s has multiple values"), key);
2398 ALLOC_GROW(store->seen, store->seen_nr + 1,
2399 store->seen_alloc);
2401 store->seen[store->seen_nr] = store->parsed_nr;
2402 store->seen_nr++;
2404 } else if (store->is_keys_section) {
2406 * Do not increment matches yet: this may not be a match, but we
2407 * are in the desired section.
2409 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2410 store->seen[store->seen_nr] = store->parsed_nr;
2411 store->section_seen = 1;
2413 if (matches(key, value, store)) {
2414 store->seen_nr++;
2415 store->key_seen = 1;
2419 return 0;
2422 static int write_error(const char *filename)
2424 error("failed to write new configuration file %s", filename);
2426 /* Same error code as "failed to rename". */
2427 return 4;
2430 static struct strbuf store_create_section(const char *key,
2431 const struct config_store_data *store)
2433 const char *dot;
2434 int i;
2435 struct strbuf sb = STRBUF_INIT;
2437 dot = memchr(key, '.', store->baselen);
2438 if (dot) {
2439 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2440 for (i = dot - key + 1; i < store->baselen; i++) {
2441 if (key[i] == '"' || key[i] == '\\')
2442 strbuf_addch(&sb, '\\');
2443 strbuf_addch(&sb, key[i]);
2445 strbuf_addstr(&sb, "\"]\n");
2446 } else {
2447 strbuf_addf(&sb, "[%.*s]\n", store->baselen, key);
2450 return sb;
2453 static ssize_t write_section(int fd, const char *key,
2454 const struct config_store_data *store)
2456 struct strbuf sb = store_create_section(key, store);
2457 ssize_t ret;
2459 ret = write_in_full(fd, sb.buf, sb.len);
2460 strbuf_release(&sb);
2462 return ret;
2465 static ssize_t write_pair(int fd, const char *key, const char *value,
2466 const struct config_store_data *store)
2468 int i;
2469 ssize_t ret;
2470 int length = strlen(key + store->baselen + 1);
2471 const char *quote = "";
2472 struct strbuf sb = STRBUF_INIT;
2475 * Check to see if the value needs to be surrounded with a dq pair.
2476 * Note that problematic characters are always backslash-quoted; this
2477 * check is about not losing leading or trailing SP and strings that
2478 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2479 * configuration parser.
2481 if (value[0] == ' ')
2482 quote = "\"";
2483 for (i = 0; value[i]; i++)
2484 if (value[i] == ';' || value[i] == '#')
2485 quote = "\"";
2486 if (i && value[i - 1] == ' ')
2487 quote = "\"";
2489 strbuf_addf(&sb, "\t%.*s = %s",
2490 length, key + store->baselen + 1, quote);
2492 for (i = 0; value[i]; i++)
2493 switch (value[i]) {
2494 case '\n':
2495 strbuf_addstr(&sb, "\\n");
2496 break;
2497 case '\t':
2498 strbuf_addstr(&sb, "\\t");
2499 break;
2500 case '"':
2501 case '\\':
2502 strbuf_addch(&sb, '\\');
2503 /* fallthrough */
2504 default:
2505 strbuf_addch(&sb, value[i]);
2506 break;
2508 strbuf_addf(&sb, "%s\n", quote);
2510 ret = write_in_full(fd, sb.buf, sb.len);
2511 strbuf_release(&sb);
2513 return ret;
2517 * If we are about to unset the last key(s) in a section, and if there are
2518 * no comments surrounding (or included in) the section, we will want to
2519 * extend begin/end to remove the entire section.
2521 * Note: the parameter `seen_ptr` points to the index into the store.seen
2522 * array. * This index may be incremented if a section has more than one
2523 * entry (which all are to be removed).
2525 static void maybe_remove_section(struct config_store_data *store,
2526 const char *contents,
2527 size_t *begin_offset, size_t *end_offset,
2528 int *seen_ptr)
2530 size_t begin;
2531 int i, seen, section_seen = 0;
2534 * First, ensure that this is the first key, and that there are no
2535 * comments before the entry nor before the section header.
2537 seen = *seen_ptr;
2538 for (i = store->seen[seen]; i > 0; i--) {
2539 enum config_event_t type = store->parsed[i - 1].type;
2541 if (type == CONFIG_EVENT_COMMENT)
2542 /* There is a comment before this entry or section */
2543 return;
2544 if (type == CONFIG_EVENT_ENTRY) {
2545 if (!section_seen)
2546 /* This is not the section's first entry. */
2547 return;
2548 /* We encountered no comment before the section. */
2549 break;
2551 if (type == CONFIG_EVENT_SECTION) {
2552 if (!store->parsed[i - 1].is_keys_section)
2553 break;
2554 section_seen = 1;
2557 begin = store->parsed[i].begin;
2560 * Next, make sure that we are removing he last key(s) in the section,
2561 * and that there are no comments that are possibly about the current
2562 * section.
2564 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2565 enum config_event_t type = store->parsed[i].type;
2567 if (type == CONFIG_EVENT_COMMENT)
2568 return;
2569 if (type == CONFIG_EVENT_SECTION) {
2570 if (store->parsed[i].is_keys_section)
2571 continue;
2572 break;
2574 if (type == CONFIG_EVENT_ENTRY) {
2575 if (++seen < store->seen_nr &&
2576 i == store->seen[seen])
2577 /* We want to remove this entry, too */
2578 continue;
2579 /* There is another entry in this section. */
2580 return;
2585 * We are really removing the last entry/entries from this section, and
2586 * there are no enclosed or surrounding comments. Remove the entire,
2587 * now-empty section.
2589 *seen_ptr = seen;
2590 *begin_offset = begin;
2591 if (i < store->parsed_nr)
2592 *end_offset = store->parsed[i].begin;
2593 else
2594 *end_offset = store->parsed[store->parsed_nr - 1].end;
2597 int git_config_set_in_file_gently(const char *config_filename,
2598 const char *key, const char *value)
2600 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2603 void git_config_set_in_file(const char *config_filename,
2604 const char *key, const char *value)
2606 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2609 int git_config_set_gently(const char *key, const char *value)
2611 return git_config_set_multivar_gently(key, value, NULL, 0);
2614 void git_config_set(const char *key, const char *value)
2616 git_config_set_multivar(key, value, NULL, 0);
2620 * If value==NULL, unset in (remove from) config,
2621 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2622 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2623 * (only add a new one)
2624 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2625 * else all matching key/values (regardless how many) are removed,
2626 * before the new pair is written.
2628 * Returns 0 on success.
2630 * This function does this:
2632 * - it locks the config file by creating ".git/config.lock"
2634 * - it then parses the config using store_aux() as validator to find
2635 * the position on the key/value pair to replace. If it is to be unset,
2636 * it must be found exactly once.
2638 * - the config file is mmap()ed and the part before the match (if any) is
2639 * written to the lock file, then the changed part and the rest.
2641 * - the config file is removed and the lock file rename()d to it.
2644 int git_config_set_multivar_in_file_gently(const char *config_filename,
2645 const char *key, const char *value,
2646 const char *value_regex,
2647 int multi_replace)
2649 int fd = -1, in_fd = -1;
2650 int ret;
2651 struct lock_file lock = LOCK_INIT;
2652 char *filename_buf = NULL;
2653 char *contents = NULL;
2654 size_t contents_sz;
2655 struct config_store_data store;
2657 memset(&store, 0, sizeof(store));
2659 /* parse-key returns negative; flip the sign to feed exit(3) */
2660 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2661 if (ret)
2662 goto out_free;
2664 store.multi_replace = multi_replace;
2666 if (!config_filename)
2667 config_filename = filename_buf = git_pathdup("config");
2670 * The lock serves a purpose in addition to locking: the new
2671 * contents of .git/config will be written into it.
2673 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2674 if (fd < 0) {
2675 error_errno("could not lock config file %s", config_filename);
2676 ret = CONFIG_NO_LOCK;
2677 goto out_free;
2681 * If .git/config does not exist yet, write a minimal version.
2683 in_fd = open(config_filename, O_RDONLY);
2684 if ( in_fd < 0 ) {
2685 if ( ENOENT != errno ) {
2686 error_errno("opening %s", config_filename);
2687 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2688 goto out_free;
2690 /* if nothing to unset, error out */
2691 if (value == NULL) {
2692 ret = CONFIG_NOTHING_SET;
2693 goto out_free;
2696 free(store.key);
2697 store.key = xstrdup(key);
2698 if (write_section(fd, key, &store) < 0 ||
2699 write_pair(fd, key, value, &store) < 0)
2700 goto write_err_out;
2701 } else {
2702 struct stat st;
2703 size_t copy_begin, copy_end;
2704 int i, new_line = 0;
2705 struct config_options opts;
2707 if (value_regex == NULL)
2708 store.value_regex = NULL;
2709 else if (value_regex == CONFIG_REGEX_NONE)
2710 store.value_regex = CONFIG_REGEX_NONE;
2711 else {
2712 if (value_regex[0] == '!') {
2713 store.do_not_match = 1;
2714 value_regex++;
2715 } else
2716 store.do_not_match = 0;
2718 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2719 if (regcomp(store.value_regex, value_regex,
2720 REG_EXTENDED)) {
2721 error("invalid pattern: %s", value_regex);
2722 FREE_AND_NULL(store.value_regex);
2723 ret = CONFIG_INVALID_PATTERN;
2724 goto out_free;
2728 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
2729 store.parsed[0].end = 0;
2731 memset(&opts, 0, sizeof(opts));
2732 opts.event_fn = store_aux_event;
2733 opts.event_fn_data = &store;
2736 * After this, store.parsed will contain offsets of all the
2737 * parsed elements, and store.seen will contain a list of
2738 * matches, as indices into store.parsed.
2740 * As a side effect, we make sure to transform only a valid
2741 * existing config file.
2743 if (git_config_from_file_with_options(store_aux,
2744 config_filename,
2745 &store, &opts)) {
2746 error("invalid config file %s", config_filename);
2747 ret = CONFIG_INVALID_FILE;
2748 goto out_free;
2751 /* if nothing to unset, or too many matches, error out */
2752 if ((store.seen_nr == 0 && value == NULL) ||
2753 (store.seen_nr > 1 && multi_replace == 0)) {
2754 ret = CONFIG_NOTHING_SET;
2755 goto out_free;
2758 if (fstat(in_fd, &st) == -1) {
2759 error_errno(_("fstat on %s failed"), config_filename);
2760 ret = CONFIG_INVALID_FILE;
2761 goto out_free;
2764 contents_sz = xsize_t(st.st_size);
2765 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2766 MAP_PRIVATE, in_fd, 0);
2767 if (contents == MAP_FAILED) {
2768 if (errno == ENODEV && S_ISDIR(st.st_mode))
2769 errno = EISDIR;
2770 error_errno("unable to mmap '%s'", config_filename);
2771 ret = CONFIG_INVALID_FILE;
2772 contents = NULL;
2773 goto out_free;
2775 close(in_fd);
2776 in_fd = -1;
2778 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
2779 error_errno("chmod on %s failed", get_lock_file_path(&lock));
2780 ret = CONFIG_NO_WRITE;
2781 goto out_free;
2784 if (store.seen_nr == 0) {
2785 if (!store.seen_alloc) {
2786 /* Did not see key nor section */
2787 ALLOC_GROW(store.seen, 1, store.seen_alloc);
2788 store.seen[0] = store.parsed_nr
2789 - !!store.parsed_nr;
2791 store.seen_nr = 1;
2794 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
2795 size_t replace_end;
2796 int j = store.seen[i];
2798 new_line = 0;
2799 if (!store.key_seen) {
2800 copy_end = store.parsed[j].end;
2801 /* include '\n' when copying section header */
2802 if (copy_end > 0 && copy_end < contents_sz &&
2803 contents[copy_end - 1] != '\n' &&
2804 contents[copy_end] == '\n')
2805 copy_end++;
2806 replace_end = copy_end;
2807 } else {
2808 replace_end = store.parsed[j].end;
2809 copy_end = store.parsed[j].begin;
2810 if (!value)
2811 maybe_remove_section(&store, contents,
2812 &copy_end,
2813 &replace_end, &i);
2815 * Swallow preceding white-space on the same
2816 * line.
2818 while (copy_end > 0 ) {
2819 char c = contents[copy_end - 1];
2821 if (isspace(c) && c != '\n')
2822 copy_end--;
2823 else
2824 break;
2828 if (copy_end > 0 && contents[copy_end-1] != '\n')
2829 new_line = 1;
2831 /* write the first part of the config */
2832 if (copy_end > copy_begin) {
2833 if (write_in_full(fd, contents + copy_begin,
2834 copy_end - copy_begin) < 0)
2835 goto write_err_out;
2836 if (new_line &&
2837 write_str_in_full(fd, "\n") < 0)
2838 goto write_err_out;
2840 copy_begin = replace_end;
2843 /* write the pair (value == NULL means unset) */
2844 if (value != NULL) {
2845 if (!store.section_seen) {
2846 if (write_section(fd, key, &store) < 0)
2847 goto write_err_out;
2849 if (write_pair(fd, key, value, &store) < 0)
2850 goto write_err_out;
2853 /* write the rest of the config */
2854 if (copy_begin < contents_sz)
2855 if (write_in_full(fd, contents + copy_begin,
2856 contents_sz - copy_begin) < 0)
2857 goto write_err_out;
2859 munmap(contents, contents_sz);
2860 contents = NULL;
2863 if (commit_lock_file(&lock) < 0) {
2864 error_errno("could not write config file %s", config_filename);
2865 ret = CONFIG_NO_WRITE;
2866 goto out_free;
2869 ret = 0;
2871 /* Invalidate the config cache */
2872 git_config_clear();
2874 out_free:
2875 rollback_lock_file(&lock);
2876 free(filename_buf);
2877 if (contents)
2878 munmap(contents, contents_sz);
2879 if (in_fd >= 0)
2880 close(in_fd);
2881 config_store_data_clear(&store);
2882 return ret;
2884 write_err_out:
2885 ret = write_error(get_lock_file_path(&lock));
2886 goto out_free;
2890 void git_config_set_multivar_in_file(const char *config_filename,
2891 const char *key, const char *value,
2892 const char *value_regex, int multi_replace)
2894 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2895 value_regex, multi_replace))
2896 return;
2897 if (value)
2898 die(_("could not set '%s' to '%s'"), key, value);
2899 else
2900 die(_("could not unset '%s'"), key);
2903 int git_config_set_multivar_gently(const char *key, const char *value,
2904 const char *value_regex, int multi_replace)
2906 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2907 multi_replace);
2910 void git_config_set_multivar(const char *key, const char *value,
2911 const char *value_regex, int multi_replace)
2913 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2914 multi_replace);
2917 static int section_name_match (const char *buf, const char *name)
2919 int i = 0, j = 0, dot = 0;
2920 if (buf[i] != '[')
2921 return 0;
2922 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2923 if (!dot && isspace(buf[i])) {
2924 dot = 1;
2925 if (name[j++] != '.')
2926 break;
2927 for (i++; isspace(buf[i]); i++)
2928 ; /* do nothing */
2929 if (buf[i] != '"')
2930 break;
2931 continue;
2933 if (buf[i] == '\\' && dot)
2934 i++;
2935 else if (buf[i] == '"' && dot) {
2936 for (i++; isspace(buf[i]); i++)
2937 ; /* do_nothing */
2938 break;
2940 if (buf[i] != name[j++])
2941 break;
2943 if (buf[i] == ']' && name[j] == 0) {
2945 * We match, now just find the right length offset by
2946 * gobbling up any whitespace after it, as well
2948 i++;
2949 for (; buf[i] && isspace(buf[i]); i++)
2950 ; /* do nothing */
2951 return i;
2953 return 0;
2956 static int section_name_is_ok(const char *name)
2958 /* Empty section names are bogus. */
2959 if (!*name)
2960 return 0;
2963 * Before a dot, we must be alphanumeric or dash. After the first dot,
2964 * anything goes, so we can stop checking.
2966 for (; *name && *name != '.'; name++)
2967 if (*name != '-' && !isalnum(*name))
2968 return 0;
2969 return 1;
2972 /* if new_name == NULL, the section is removed instead */
2973 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
2974 const char *old_name,
2975 const char *new_name, int copy)
2977 int ret = 0, remove = 0;
2978 char *filename_buf = NULL;
2979 struct lock_file lock = LOCK_INIT;
2980 int out_fd;
2981 char buf[1024];
2982 FILE *config_file = NULL;
2983 struct stat st;
2984 struct strbuf copystr = STRBUF_INIT;
2985 struct config_store_data store;
2987 memset(&store, 0, sizeof(store));
2989 if (new_name && !section_name_is_ok(new_name)) {
2990 ret = error("invalid section name: %s", new_name);
2991 goto out_no_rollback;
2994 if (!config_filename)
2995 config_filename = filename_buf = git_pathdup("config");
2997 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
2998 if (out_fd < 0) {
2999 ret = error("could not lock config file %s", config_filename);
3000 goto out;
3003 if (!(config_file = fopen(config_filename, "rb"))) {
3004 ret = warn_on_fopen_errors(config_filename);
3005 if (ret)
3006 goto out;
3007 /* no config file means nothing to rename, no error */
3008 goto commit_and_out;
3011 if (fstat(fileno(config_file), &st) == -1) {
3012 ret = error_errno(_("fstat on %s failed"), config_filename);
3013 goto out;
3016 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3017 ret = error_errno("chmod on %s failed",
3018 get_lock_file_path(&lock));
3019 goto out;
3022 while (fgets(buf, sizeof(buf), config_file)) {
3023 int i;
3024 int length;
3025 int is_section = 0;
3026 char *output = buf;
3027 for (i = 0; buf[i] && isspace(buf[i]); i++)
3028 ; /* do nothing */
3029 if (buf[i] == '[') {
3030 /* it's a section */
3031 int offset;
3032 is_section = 1;
3035 * When encountering a new section under -c we
3036 * need to flush out any section we're already
3037 * coping and begin anew. There might be
3038 * multiple [branch "$name"] sections.
3040 if (copystr.len > 0) {
3041 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3042 ret = write_error(get_lock_file_path(&lock));
3043 goto out;
3045 strbuf_reset(&copystr);
3048 offset = section_name_match(&buf[i], old_name);
3049 if (offset > 0) {
3050 ret++;
3051 if (new_name == NULL) {
3052 remove = 1;
3053 continue;
3055 store.baselen = strlen(new_name);
3056 if (!copy) {
3057 if (write_section(out_fd, new_name, &store) < 0) {
3058 ret = write_error(get_lock_file_path(&lock));
3059 goto out;
3062 * We wrote out the new section, with
3063 * a newline, now skip the old
3064 * section's length
3066 output += offset + i;
3067 if (strlen(output) > 0) {
3069 * More content means there's
3070 * a declaration to put on the
3071 * next line; indent with a
3072 * tab
3074 output -= 1;
3075 output[0] = '\t';
3077 } else {
3078 copystr = store_create_section(new_name, &store);
3081 remove = 0;
3083 if (remove)
3084 continue;
3085 length = strlen(output);
3087 if (!is_section && copystr.len > 0) {
3088 strbuf_add(&copystr, output, length);
3091 if (write_in_full(out_fd, output, length) < 0) {
3092 ret = write_error(get_lock_file_path(&lock));
3093 goto out;
3098 * Copy a trailing section at the end of the config, won't be
3099 * flushed by the usual "flush because we have a new section
3100 * logic in the loop above.
3102 if (copystr.len > 0) {
3103 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3104 ret = write_error(get_lock_file_path(&lock));
3105 goto out;
3107 strbuf_reset(&copystr);
3110 fclose(config_file);
3111 config_file = NULL;
3112 commit_and_out:
3113 if (commit_lock_file(&lock) < 0)
3114 ret = error_errno("could not write config file %s",
3115 config_filename);
3116 out:
3117 if (config_file)
3118 fclose(config_file);
3119 rollback_lock_file(&lock);
3120 out_no_rollback:
3121 free(filename_buf);
3122 config_store_data_clear(&store);
3123 return ret;
3126 int git_config_rename_section_in_file(const char *config_filename,
3127 const char *old_name, const char *new_name)
3129 return git_config_copy_or_rename_section_in_file(config_filename,
3130 old_name, new_name, 0);
3133 int git_config_rename_section(const char *old_name, const char *new_name)
3135 return git_config_rename_section_in_file(NULL, old_name, new_name);
3138 int git_config_copy_section_in_file(const char *config_filename,
3139 const char *old_name, const char *new_name)
3141 return git_config_copy_or_rename_section_in_file(config_filename,
3142 old_name, new_name, 1);
3145 int git_config_copy_section(const char *old_name, const char *new_name)
3147 return git_config_copy_section_in_file(NULL, old_name, new_name);
3151 * Call this to report error for your variable that should not
3152 * get a boolean value (i.e. "[my] var" means "true").
3154 #undef config_error_nonbool
3155 int config_error_nonbool(const char *var)
3157 return error("missing value for '%s'", var);
3160 int parse_config_key(const char *var,
3161 const char *section,
3162 const char **subsection, int *subsection_len,
3163 const char **key)
3165 const char *dot;
3167 /* Does it start with "section." ? */
3168 if (!skip_prefix(var, section, &var) || *var != '.')
3169 return -1;
3172 * Find the key; we don't know yet if we have a subsection, but we must
3173 * parse backwards from the end, since the subsection may have dots in
3174 * it, too.
3176 dot = strrchr(var, '.');
3177 *key = dot + 1;
3179 /* Did we have a subsection at all? */
3180 if (dot == var) {
3181 if (subsection) {
3182 *subsection = NULL;
3183 *subsection_len = 0;
3186 else {
3187 if (!subsection)
3188 return -1;
3189 *subsection = var + 1;
3190 *subsection_len = dot - *subsection;
3193 return 0;
3196 const char *current_config_origin_type(void)
3198 int type;
3199 if (current_config_kvi)
3200 type = current_config_kvi->origin_type;
3201 else if(cf)
3202 type = cf->origin_type;
3203 else
3204 BUG("current_config_origin_type called outside config callback");
3206 switch (type) {
3207 case CONFIG_ORIGIN_BLOB:
3208 return "blob";
3209 case CONFIG_ORIGIN_FILE:
3210 return "file";
3211 case CONFIG_ORIGIN_STDIN:
3212 return "standard input";
3213 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3214 return "submodule-blob";
3215 case CONFIG_ORIGIN_CMDLINE:
3216 return "command line";
3217 default:
3218 BUG("unknown config origin type");
3222 const char *current_config_name(void)
3224 const char *name;
3225 if (current_config_kvi)
3226 name = current_config_kvi->filename;
3227 else if (cf)
3228 name = cf->name;
3229 else
3230 BUG("current_config_name called outside config callback");
3231 return name ? name : "";
3234 enum config_scope current_config_scope(void)
3236 if (current_config_kvi)
3237 return current_config_kvi->scope;
3238 else
3239 return current_parsing_scope;
3242 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3244 int i;
3246 for (i = 0; i < nr_mapping; i++) {
3247 const char *name = mapping[i];
3249 if (name && !strcasecmp(var, name))
3250 return i;
3252 return -1;