config.c: mark error and warnings strings for translation
[git.git] / config.c
blob300d626018b18b87ad3d82a5926639d2207b7ada
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 "exec_cmd.h"
10 #include "strbuf.h"
11 #include "quote.h"
12 #include "hashmap.h"
13 #include "string-list.h"
15 struct config_source {
16 struct config_source *prev;
17 union {
18 FILE *file;
19 struct config_buf {
20 const char *buf;
21 size_t len;
22 size_t pos;
23 } buf;
24 } u;
25 const char *name;
26 const char *path;
27 int die_on_error;
28 int linenr;
29 int eof;
30 struct strbuf value;
31 struct strbuf var;
33 int (*do_fgetc)(struct config_source *c);
34 int (*do_ungetc)(int c, struct config_source *conf);
35 long (*do_ftell)(struct config_source *c);
38 struct config_set_element {
39 struct hashmap_entry ent;
40 char *key;
41 struct string_list value_list;
44 static struct config_source *cf;
46 static int zlib_compression_seen;
49 * Default config_set that contains key-value pairs from the usual set of config
50 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
51 * config file and the global /etc/gitconfig)
53 static struct config_set the_config_set;
55 static int config_file_fgetc(struct config_source *conf)
57 return fgetc(conf->u.file);
60 static int config_file_ungetc(int c, struct config_source *conf)
62 return ungetc(c, conf->u.file);
65 static long config_file_ftell(struct config_source *conf)
67 return ftell(conf->u.file);
71 static int config_buf_fgetc(struct config_source *conf)
73 if (conf->u.buf.pos < conf->u.buf.len)
74 return conf->u.buf.buf[conf->u.buf.pos++];
76 return EOF;
79 static int config_buf_ungetc(int c, struct config_source *conf)
81 if (conf->u.buf.pos > 0)
82 return conf->u.buf.buf[--conf->u.buf.pos];
84 return EOF;
87 static long config_buf_ftell(struct config_source *conf)
89 return conf->u.buf.pos;
92 #define MAX_INCLUDE_DEPTH 10
93 static const char include_depth_advice[] =
94 "exceeded maximum include depth (%d) while including\n"
95 " %s\n"
96 "from\n"
97 " %s\n"
98 "Do you have circular includes?";
99 static int handle_path_include(const char *path, struct config_include_data *inc)
101 int ret = 0;
102 struct strbuf buf = STRBUF_INIT;
103 char *expanded;
105 if (!path)
106 return config_error_nonbool("include.path");
108 expanded = expand_user_path(path);
109 if (!expanded)
110 return error("Could not expand include path '%s'", path);
111 path = expanded;
114 * Use an absolute path as-is, but interpret relative paths
115 * based on the including config file.
117 if (!is_absolute_path(path)) {
118 char *slash;
120 if (!cf || !cf->path)
121 return error("relative config includes must come from files");
123 slash = find_last_dir_sep(cf->path);
124 if (slash)
125 strbuf_add(&buf, cf->path, slash - cf->path + 1);
126 strbuf_addstr(&buf, path);
127 path = buf.buf;
130 if (!access_or_die(path, R_OK, 0)) {
131 if (++inc->depth > MAX_INCLUDE_DEPTH)
132 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
133 cf && cf->name ? cf->name : "the command line");
134 ret = git_config_from_file(git_config_include, path, inc);
135 inc->depth--;
137 strbuf_release(&buf);
138 free(expanded);
139 return ret;
142 int git_config_include(const char *var, const char *value, void *data)
144 struct config_include_data *inc = data;
145 const char *type;
146 int ret;
149 * Pass along all values, including "include" directives; this makes it
150 * possible to query information on the includes themselves.
152 ret = inc->fn(var, value, inc->data);
153 if (ret < 0)
154 return ret;
156 if (!skip_prefix(var, "include.", &type))
157 return ret;
159 if (!strcmp(type, "path"))
160 ret = handle_path_include(value, inc);
161 return ret;
164 void git_config_push_parameter(const char *text)
166 struct strbuf env = STRBUF_INIT;
167 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
168 if (old) {
169 strbuf_addstr(&env, old);
170 strbuf_addch(&env, ' ');
172 sq_quote_buf(&env, text);
173 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
174 strbuf_release(&env);
177 int git_config_parse_parameter(const char *text,
178 config_fn_t fn, void *data)
180 struct strbuf **pair;
181 pair = strbuf_split_str(text, '=', 2);
182 if (!pair[0])
183 return error("bogus config parameter: %s", text);
184 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
185 strbuf_setlen(pair[0], pair[0]->len - 1);
186 strbuf_trim(pair[0]);
187 if (!pair[0]->len) {
188 strbuf_list_free(pair);
189 return error("bogus config parameter: %s", text);
191 strbuf_tolower(pair[0]);
192 if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
193 strbuf_list_free(pair);
194 return -1;
196 strbuf_list_free(pair);
197 return 0;
200 int git_config_from_parameters(config_fn_t fn, void *data)
202 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
203 char *envw;
204 const char **argv = NULL;
205 int nr = 0, alloc = 0;
206 int i;
208 if (!env)
209 return 0;
210 /* sq_dequote will write over it */
211 envw = xstrdup(env);
213 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
214 free(envw);
215 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
218 for (i = 0; i < nr; i++) {
219 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
220 free(argv);
221 free(envw);
222 return -1;
226 free(argv);
227 free(envw);
228 return nr > 0;
231 static int get_next_char(void)
233 int c = cf->do_fgetc(cf);
235 if (c == '\r') {
236 /* DOS like systems */
237 c = cf->do_fgetc(cf);
238 if (c != '\n') {
239 cf->do_ungetc(c, cf);
240 c = '\r';
243 if (c == '\n')
244 cf->linenr++;
245 if (c == EOF) {
246 cf->eof = 1;
247 c = '\n';
249 return c;
252 static char *parse_value(void)
254 int quote = 0, comment = 0, space = 0;
256 strbuf_reset(&cf->value);
257 for (;;) {
258 int c = get_next_char();
259 if (c == '\n') {
260 if (quote) {
261 cf->linenr--;
262 return NULL;
264 return cf->value.buf;
266 if (comment)
267 continue;
268 if (isspace(c) && !quote) {
269 if (cf->value.len)
270 space++;
271 continue;
273 if (!quote) {
274 if (c == ';' || c == '#') {
275 comment = 1;
276 continue;
279 for (; space; space--)
280 strbuf_addch(&cf->value, ' ');
281 if (c == '\\') {
282 c = get_next_char();
283 switch (c) {
284 case '\n':
285 continue;
286 case 't':
287 c = '\t';
288 break;
289 case 'b':
290 c = '\b';
291 break;
292 case 'n':
293 c = '\n';
294 break;
295 /* Some characters escape as themselves */
296 case '\\': case '"':
297 break;
298 /* Reject unknown escape sequences */
299 default:
300 return NULL;
302 strbuf_addch(&cf->value, c);
303 continue;
305 if (c == '"') {
306 quote = 1-quote;
307 continue;
309 strbuf_addch(&cf->value, c);
313 static inline int iskeychar(int c)
315 return isalnum(c) || c == '-';
318 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
320 int c;
321 char *value;
323 /* Get the full name */
324 for (;;) {
325 c = get_next_char();
326 if (cf->eof)
327 break;
328 if (!iskeychar(c))
329 break;
330 strbuf_addch(name, tolower(c));
333 while (c == ' ' || c == '\t')
334 c = get_next_char();
336 value = NULL;
337 if (c != '\n') {
338 if (c != '=')
339 return -1;
340 value = parse_value();
341 if (!value)
342 return -1;
344 return fn(name->buf, value, data);
347 static int get_extended_base_var(struct strbuf *name, int c)
349 do {
350 if (c == '\n')
351 goto error_incomplete_line;
352 c = get_next_char();
353 } while (isspace(c));
355 /* We require the format to be '[base "extension"]' */
356 if (c != '"')
357 return -1;
358 strbuf_addch(name, '.');
360 for (;;) {
361 int c = get_next_char();
362 if (c == '\n')
363 goto error_incomplete_line;
364 if (c == '"')
365 break;
366 if (c == '\\') {
367 c = get_next_char();
368 if (c == '\n')
369 goto error_incomplete_line;
371 strbuf_addch(name, c);
374 /* Final ']' */
375 if (get_next_char() != ']')
376 return -1;
377 return 0;
378 error_incomplete_line:
379 cf->linenr--;
380 return -1;
383 static int get_base_var(struct strbuf *name)
385 for (;;) {
386 int c = get_next_char();
387 if (cf->eof)
388 return -1;
389 if (c == ']')
390 return 0;
391 if (isspace(c))
392 return get_extended_base_var(name, c);
393 if (!iskeychar(c) && c != '.')
394 return -1;
395 strbuf_addch(name, tolower(c));
399 static int git_parse_source(config_fn_t fn, void *data)
401 int comment = 0;
402 int baselen = 0;
403 struct strbuf *var = &cf->var;
405 /* U+FEFF Byte Order Mark in UTF8 */
406 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
407 const unsigned char *bomptr = utf8_bom;
409 for (;;) {
410 int c = get_next_char();
411 if (bomptr && *bomptr) {
412 /* We are at the file beginning; skip UTF8-encoded BOM
413 * if present. Sane editors won't put this in on their
414 * own, but e.g. Windows Notepad will do it happily. */
415 if ((unsigned char) c == *bomptr) {
416 bomptr++;
417 continue;
418 } else {
419 /* Do not tolerate partial BOM. */
420 if (bomptr != utf8_bom)
421 break;
422 /* No BOM at file beginning. Cool. */
423 bomptr = NULL;
426 if (c == '\n') {
427 if (cf->eof)
428 return 0;
429 comment = 0;
430 continue;
432 if (comment || isspace(c))
433 continue;
434 if (c == '#' || c == ';') {
435 comment = 1;
436 continue;
438 if (c == '[') {
439 /* Reset prior to determining a new stem */
440 strbuf_reset(var);
441 if (get_base_var(var) < 0 || var->len < 1)
442 break;
443 strbuf_addch(var, '.');
444 baselen = var->len;
445 continue;
447 if (!isalpha(c))
448 break;
450 * Truncate the var name back to the section header
451 * stem prior to grabbing the suffix part of the name
452 * and the value.
454 strbuf_setlen(var, baselen);
455 strbuf_addch(var, tolower(c));
456 if (get_value(fn, data, var) < 0)
457 break;
459 if (cf->die_on_error)
460 die(_("bad config file line %d in %s"), cf->linenr, cf->name);
461 else
462 return error(_("bad config file line %d in %s"), cf->linenr, cf->name);
465 static int parse_unit_factor(const char *end, uintmax_t *val)
467 if (!*end)
468 return 1;
469 else if (!strcasecmp(end, "k")) {
470 *val *= 1024;
471 return 1;
473 else if (!strcasecmp(end, "m")) {
474 *val *= 1024 * 1024;
475 return 1;
477 else if (!strcasecmp(end, "g")) {
478 *val *= 1024 * 1024 * 1024;
479 return 1;
481 return 0;
484 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
486 if (value && *value) {
487 char *end;
488 intmax_t val;
489 uintmax_t uval;
490 uintmax_t factor = 1;
492 errno = 0;
493 val = strtoimax(value, &end, 0);
494 if (errno == ERANGE)
495 return 0;
496 if (!parse_unit_factor(end, &factor)) {
497 errno = EINVAL;
498 return 0;
500 uval = abs(val);
501 uval *= factor;
502 if (uval > max || abs(val) > uval) {
503 errno = ERANGE;
504 return 0;
506 val *= factor;
507 *ret = val;
508 return 1;
510 errno = EINVAL;
511 return 0;
514 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
516 if (value && *value) {
517 char *end;
518 uintmax_t val;
519 uintmax_t oldval;
521 errno = 0;
522 val = strtoumax(value, &end, 0);
523 if (errno == ERANGE)
524 return 0;
525 oldval = val;
526 if (!parse_unit_factor(end, &val)) {
527 errno = EINVAL;
528 return 0;
530 if (val > max || oldval > val) {
531 errno = ERANGE;
532 return 0;
534 *ret = val;
535 return 1;
537 errno = EINVAL;
538 return 0;
541 static int git_parse_int(const char *value, int *ret)
543 intmax_t tmp;
544 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
545 return 0;
546 *ret = tmp;
547 return 1;
550 static int git_parse_int64(const char *value, int64_t *ret)
552 intmax_t tmp;
553 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
554 return 0;
555 *ret = tmp;
556 return 1;
559 int git_parse_ulong(const char *value, unsigned long *ret)
561 uintmax_t tmp;
562 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
563 return 0;
564 *ret = tmp;
565 return 1;
568 NORETURN
569 static void die_bad_number(const char *name, const char *value)
571 const char *reason = errno == ERANGE ?
572 "out of range" :
573 "invalid unit";
574 if (!value)
575 value = "";
577 if (cf && cf->name)
578 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
579 value, name, cf->name, reason);
580 die(_("bad numeric config value '%s' for '%s': %s"), value, name, reason);
583 int git_config_int(const char *name, const char *value)
585 int ret;
586 if (!git_parse_int(value, &ret))
587 die_bad_number(name, value);
588 return ret;
591 int64_t git_config_int64(const char *name, const char *value)
593 int64_t ret;
594 if (!git_parse_int64(value, &ret))
595 die_bad_number(name, value);
596 return ret;
599 unsigned long git_config_ulong(const char *name, const char *value)
601 unsigned long ret;
602 if (!git_parse_ulong(value, &ret))
603 die_bad_number(name, value);
604 return ret;
607 static int git_config_maybe_bool_text(const char *name, const char *value)
609 if (!value)
610 return 1;
611 if (!*value)
612 return 0;
613 if (!strcasecmp(value, "true")
614 || !strcasecmp(value, "yes")
615 || !strcasecmp(value, "on"))
616 return 1;
617 if (!strcasecmp(value, "false")
618 || !strcasecmp(value, "no")
619 || !strcasecmp(value, "off"))
620 return 0;
621 return -1;
624 int git_config_maybe_bool(const char *name, const char *value)
626 int v = git_config_maybe_bool_text(name, value);
627 if (0 <= v)
628 return v;
629 if (git_parse_int(value, &v))
630 return !!v;
631 return -1;
634 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
636 int v = git_config_maybe_bool_text(name, value);
637 if (0 <= v) {
638 *is_bool = 1;
639 return v;
641 *is_bool = 0;
642 return git_config_int(name, value);
645 int git_config_bool(const char *name, const char *value)
647 int discard;
648 return !!git_config_bool_or_int(name, value, &discard);
651 int git_config_string(const char **dest, const char *var, const char *value)
653 if (!value)
654 return config_error_nonbool(var);
655 *dest = xstrdup(value);
656 return 0;
659 int git_config_pathname(const char **dest, const char *var, const char *value)
661 if (!value)
662 return config_error_nonbool(var);
663 *dest = expand_user_path(value);
664 if (!*dest)
665 die(_("failed to expand user dir in: '%s'"), value);
666 return 0;
669 static int git_default_core_config(const char *var, const char *value)
671 /* This needs a better name */
672 if (!strcmp(var, "core.filemode")) {
673 trust_executable_bit = git_config_bool(var, value);
674 return 0;
676 if (!strcmp(var, "core.trustctime")) {
677 trust_ctime = git_config_bool(var, value);
678 return 0;
680 if (!strcmp(var, "core.checkstat")) {
681 if (!strcasecmp(value, "default"))
682 check_stat = 1;
683 else if (!strcasecmp(value, "minimal"))
684 check_stat = 0;
687 if (!strcmp(var, "core.quotepath")) {
688 quote_path_fully = git_config_bool(var, value);
689 return 0;
692 if (!strcmp(var, "core.symlinks")) {
693 has_symlinks = git_config_bool(var, value);
694 return 0;
697 if (!strcmp(var, "core.ignorecase")) {
698 ignore_case = git_config_bool(var, value);
699 return 0;
702 if (!strcmp(var, "core.attributesfile"))
703 return git_config_pathname(&git_attributes_file, var, value);
705 if (!strcmp(var, "core.bare")) {
706 is_bare_repository_cfg = git_config_bool(var, value);
707 return 0;
710 if (!strcmp(var, "core.ignorestat")) {
711 assume_unchanged = git_config_bool(var, value);
712 return 0;
715 if (!strcmp(var, "core.prefersymlinkrefs")) {
716 prefer_symlink_refs = git_config_bool(var, value);
717 return 0;
720 if (!strcmp(var, "core.logallrefupdates")) {
721 log_all_ref_updates = git_config_bool(var, value);
722 return 0;
725 if (!strcmp(var, "core.warnambiguousrefs")) {
726 warn_ambiguous_refs = git_config_bool(var, value);
727 return 0;
730 if (!strcmp(var, "core.abbrev")) {
731 int abbrev = git_config_int(var, value);
732 if (abbrev < minimum_abbrev || abbrev > 40)
733 return -1;
734 default_abbrev = abbrev;
735 return 0;
738 if (!strcmp(var, "core.loosecompression")) {
739 int level = git_config_int(var, value);
740 if (level == -1)
741 level = Z_DEFAULT_COMPRESSION;
742 else if (level < 0 || level > Z_BEST_COMPRESSION)
743 die(_("bad zlib compression level %d"), level);
744 zlib_compression_level = level;
745 zlib_compression_seen = 1;
746 return 0;
749 if (!strcmp(var, "core.compression")) {
750 int level = git_config_int(var, value);
751 if (level == -1)
752 level = Z_DEFAULT_COMPRESSION;
753 else if (level < 0 || level > Z_BEST_COMPRESSION)
754 die(_("bad zlib compression level %d"), level);
755 core_compression_level = level;
756 core_compression_seen = 1;
757 if (!zlib_compression_seen)
758 zlib_compression_level = level;
759 return 0;
762 if (!strcmp(var, "core.packedgitwindowsize")) {
763 int pgsz_x2 = getpagesize() * 2;
764 packed_git_window_size = git_config_ulong(var, value);
766 /* This value must be multiple of (pagesize * 2) */
767 packed_git_window_size /= pgsz_x2;
768 if (packed_git_window_size < 1)
769 packed_git_window_size = 1;
770 packed_git_window_size *= pgsz_x2;
771 return 0;
774 if (!strcmp(var, "core.bigfilethreshold")) {
775 big_file_threshold = git_config_ulong(var, value);
776 return 0;
779 if (!strcmp(var, "core.packedgitlimit")) {
780 packed_git_limit = git_config_ulong(var, value);
781 return 0;
784 if (!strcmp(var, "core.deltabasecachelimit")) {
785 delta_base_cache_limit = git_config_ulong(var, value);
786 return 0;
789 if (!strcmp(var, "core.autocrlf")) {
790 if (value && !strcasecmp(value, "input")) {
791 if (core_eol == EOL_CRLF)
792 return error("core.autocrlf=input conflicts with core.eol=crlf");
793 auto_crlf = AUTO_CRLF_INPUT;
794 return 0;
796 auto_crlf = git_config_bool(var, value);
797 return 0;
800 if (!strcmp(var, "core.safecrlf")) {
801 if (value && !strcasecmp(value, "warn")) {
802 safe_crlf = SAFE_CRLF_WARN;
803 return 0;
805 safe_crlf = git_config_bool(var, value);
806 return 0;
809 if (!strcmp(var, "core.eol")) {
810 if (value && !strcasecmp(value, "lf"))
811 core_eol = EOL_LF;
812 else if (value && !strcasecmp(value, "crlf"))
813 core_eol = EOL_CRLF;
814 else if (value && !strcasecmp(value, "native"))
815 core_eol = EOL_NATIVE;
816 else
817 core_eol = EOL_UNSET;
818 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
819 return error("core.autocrlf=input conflicts with core.eol=crlf");
820 return 0;
823 if (!strcmp(var, "core.notesref")) {
824 notes_ref_name = xstrdup(value);
825 return 0;
828 if (!strcmp(var, "core.pager"))
829 return git_config_string(&pager_program, var, value);
831 if (!strcmp(var, "core.editor"))
832 return git_config_string(&editor_program, var, value);
834 if (!strcmp(var, "core.commentchar")) {
835 const char *comment;
836 int ret = git_config_string(&comment, var, value);
837 if (ret)
838 return ret;
839 else if (!strcasecmp(comment, "auto"))
840 auto_comment_line_char = 1;
841 else if (comment[0] && !comment[1]) {
842 comment_line_char = comment[0];
843 auto_comment_line_char = 0;
844 } else
845 return error("core.commentChar should only be one character");
846 return 0;
849 if (!strcmp(var, "core.askpass"))
850 return git_config_string(&askpass_program, var, value);
852 if (!strcmp(var, "core.excludesfile"))
853 return git_config_pathname(&excludes_file, var, value);
855 if (!strcmp(var, "core.whitespace")) {
856 if (!value)
857 return config_error_nonbool(var);
858 whitespace_rule_cfg = parse_whitespace_rule(value);
859 return 0;
862 if (!strcmp(var, "core.fsyncobjectfiles")) {
863 fsync_object_files = git_config_bool(var, value);
864 return 0;
867 if (!strcmp(var, "core.preloadindex")) {
868 core_preload_index = git_config_bool(var, value);
869 return 0;
872 if (!strcmp(var, "core.createobject")) {
873 if (!strcmp(value, "rename"))
874 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
875 else if (!strcmp(value, "link"))
876 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
877 else
878 die(_("invalid mode for object creation: %s"), value);
879 return 0;
882 if (!strcmp(var, "core.sparsecheckout")) {
883 core_apply_sparse_checkout = git_config_bool(var, value);
884 return 0;
887 if (!strcmp(var, "core.precomposeunicode")) {
888 precomposed_unicode = git_config_bool(var, value);
889 return 0;
892 /* Add other config variables here and to Documentation/config.txt. */
893 return 0;
896 static int git_default_i18n_config(const char *var, const char *value)
898 if (!strcmp(var, "i18n.commitencoding"))
899 return git_config_string(&git_commit_encoding, var, value);
901 if (!strcmp(var, "i18n.logoutputencoding"))
902 return git_config_string(&git_log_output_encoding, var, value);
904 /* Add other config variables here and to Documentation/config.txt. */
905 return 0;
908 static int git_default_branch_config(const char *var, const char *value)
910 if (!strcmp(var, "branch.autosetupmerge")) {
911 if (value && !strcasecmp(value, "always")) {
912 git_branch_track = BRANCH_TRACK_ALWAYS;
913 return 0;
915 git_branch_track = git_config_bool(var, value);
916 return 0;
918 if (!strcmp(var, "branch.autosetuprebase")) {
919 if (!value)
920 return config_error_nonbool(var);
921 else if (!strcmp(value, "never"))
922 autorebase = AUTOREBASE_NEVER;
923 else if (!strcmp(value, "local"))
924 autorebase = AUTOREBASE_LOCAL;
925 else if (!strcmp(value, "remote"))
926 autorebase = AUTOREBASE_REMOTE;
927 else if (!strcmp(value, "always"))
928 autorebase = AUTOREBASE_ALWAYS;
929 else
930 return error("Malformed value for %s", var);
931 return 0;
934 /* Add other config variables here and to Documentation/config.txt. */
935 return 0;
938 static int git_default_push_config(const char *var, const char *value)
940 if (!strcmp(var, "push.default")) {
941 if (!value)
942 return config_error_nonbool(var);
943 else if (!strcmp(value, "nothing"))
944 push_default = PUSH_DEFAULT_NOTHING;
945 else if (!strcmp(value, "matching"))
946 push_default = PUSH_DEFAULT_MATCHING;
947 else if (!strcmp(value, "simple"))
948 push_default = PUSH_DEFAULT_SIMPLE;
949 else if (!strcmp(value, "upstream"))
950 push_default = PUSH_DEFAULT_UPSTREAM;
951 else if (!strcmp(value, "tracking")) /* deprecated */
952 push_default = PUSH_DEFAULT_UPSTREAM;
953 else if (!strcmp(value, "current"))
954 push_default = PUSH_DEFAULT_CURRENT;
955 else {
956 error("Malformed value for %s: %s", var, value);
957 return error("Must be one of nothing, matching, simple, "
958 "upstream or current.");
960 return 0;
963 /* Add other config variables here and to Documentation/config.txt. */
964 return 0;
967 static int git_default_mailmap_config(const char *var, const char *value)
969 if (!strcmp(var, "mailmap.file"))
970 return git_config_pathname(&git_mailmap_file, var, value);
971 if (!strcmp(var, "mailmap.blob"))
972 return git_config_string(&git_mailmap_blob, var, value);
974 /* Add other config variables here and to Documentation/config.txt. */
975 return 0;
978 int git_default_config(const char *var, const char *value, void *dummy)
980 if (starts_with(var, "core."))
981 return git_default_core_config(var, value);
983 if (starts_with(var, "user."))
984 return git_ident_config(var, value, dummy);
986 if (starts_with(var, "i18n."))
987 return git_default_i18n_config(var, value);
989 if (starts_with(var, "branch."))
990 return git_default_branch_config(var, value);
992 if (starts_with(var, "push."))
993 return git_default_push_config(var, value);
995 if (starts_with(var, "mailmap."))
996 return git_default_mailmap_config(var, value);
998 if (starts_with(var, "advice."))
999 return git_default_advice_config(var, value);
1001 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1002 pager_use_color = git_config_bool(var,value);
1003 return 0;
1006 if (!strcmp(var, "pack.packsizelimit")) {
1007 pack_size_limit_cfg = git_config_ulong(var, value);
1008 return 0;
1010 /* Add other config variables here and to Documentation/config.txt. */
1011 return 0;
1015 * All source specific fields in the union, die_on_error, name and the callbacks
1016 * fgetc, ungetc, ftell of top need to be initialized before calling
1017 * this function.
1019 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1021 int ret;
1023 /* push config-file parsing state stack */
1024 top->prev = cf;
1025 top->linenr = 1;
1026 top->eof = 0;
1027 strbuf_init(&top->value, 1024);
1028 strbuf_init(&top->var, 1024);
1029 cf = top;
1031 ret = git_parse_source(fn, data);
1033 /* pop config-file parsing state stack */
1034 strbuf_release(&top->value);
1035 strbuf_release(&top->var);
1036 cf = top->prev;
1038 return ret;
1041 static int do_config_from_file(config_fn_t fn,
1042 const char *name, const char *path, FILE *f, void *data)
1044 struct config_source top;
1046 top.u.file = f;
1047 top.name = name;
1048 top.path = path;
1049 top.die_on_error = 1;
1050 top.do_fgetc = config_file_fgetc;
1051 top.do_ungetc = config_file_ungetc;
1052 top.do_ftell = config_file_ftell;
1054 return do_config_from(&top, fn, data);
1057 static int git_config_from_stdin(config_fn_t fn, void *data)
1059 return do_config_from_file(fn, "<stdin>", NULL, stdin, data);
1062 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1064 int ret = -1;
1065 FILE *f;
1067 f = fopen(filename, "r");
1068 if (f) {
1069 ret = do_config_from_file(fn, filename, filename, f, data);
1070 fclose(f);
1072 return ret;
1075 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1076 size_t len, void *data)
1078 struct config_source top;
1080 top.u.buf.buf = buf;
1081 top.u.buf.len = len;
1082 top.u.buf.pos = 0;
1083 top.name = name;
1084 top.path = NULL;
1085 top.die_on_error = 0;
1086 top.do_fgetc = config_buf_fgetc;
1087 top.do_ungetc = config_buf_ungetc;
1088 top.do_ftell = config_buf_ftell;
1090 return do_config_from(&top, fn, data);
1093 static int git_config_from_blob_sha1(config_fn_t fn,
1094 const char *name,
1095 const unsigned char *sha1,
1096 void *data)
1098 enum object_type type;
1099 char *buf;
1100 unsigned long size;
1101 int ret;
1103 buf = read_sha1_file(sha1, &type, &size);
1104 if (!buf)
1105 return error("unable to load config blob object '%s'", name);
1106 if (type != OBJ_BLOB) {
1107 free(buf);
1108 return error("reference '%s' does not point to a blob", name);
1111 ret = git_config_from_buf(fn, name, buf, size, data);
1112 free(buf);
1114 return ret;
1117 static int git_config_from_blob_ref(config_fn_t fn,
1118 const char *name,
1119 void *data)
1121 unsigned char sha1[20];
1123 if (get_sha1(name, sha1) < 0)
1124 return error("unable to resolve config blob '%s'", name);
1125 return git_config_from_blob_sha1(fn, name, sha1, data);
1128 const char *git_etc_gitconfig(void)
1130 static const char *system_wide;
1131 if (!system_wide)
1132 system_wide = system_path(ETC_GITCONFIG);
1133 return system_wide;
1136 int git_env_bool(const char *k, int def)
1138 const char *v = getenv(k);
1139 return v ? git_config_bool(k, v) : def;
1142 int git_config_system(void)
1144 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1147 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1149 int ret = 0, found = 0;
1150 char *xdg_config = NULL;
1151 char *user_config = NULL;
1153 home_config_paths(&user_config, &xdg_config, "config");
1155 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1156 ret += git_config_from_file(fn, git_etc_gitconfig(),
1157 data);
1158 found += 1;
1161 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1162 ret += git_config_from_file(fn, xdg_config, data);
1163 found += 1;
1166 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1167 ret += git_config_from_file(fn, user_config, data);
1168 found += 1;
1171 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1172 ret += git_config_from_file(fn, repo_config, data);
1173 found += 1;
1176 switch (git_config_from_parameters(fn, data)) {
1177 case -1: /* error */
1178 die(_("unable to parse command-line config"));
1179 break;
1180 case 0: /* found nothing */
1181 break;
1182 default: /* found at least one item */
1183 found++;
1184 break;
1187 free(xdg_config);
1188 free(user_config);
1189 return ret == 0 ? found : ret;
1192 int git_config_with_options(config_fn_t fn, void *data,
1193 struct git_config_source *config_source,
1194 int respect_includes)
1196 char *repo_config = NULL;
1197 int ret;
1198 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1200 if (respect_includes) {
1201 inc.fn = fn;
1202 inc.data = data;
1203 fn = git_config_include;
1204 data = &inc;
1208 * If we have a specific filename, use it. Otherwise, follow the
1209 * regular lookup sequence.
1211 if (config_source && config_source->use_stdin)
1212 return git_config_from_stdin(fn, data);
1213 else if (config_source && config_source->file)
1214 return git_config_from_file(fn, config_source->file, data);
1215 else if (config_source && config_source->blob)
1216 return git_config_from_blob_ref(fn, config_source->blob, data);
1218 repo_config = git_pathdup("config");
1219 ret = git_config_early(fn, data, repo_config);
1220 if (repo_config)
1221 free(repo_config);
1222 return ret;
1225 int git_config(config_fn_t fn, void *data)
1227 return git_config_with_options(fn, data, NULL, 1);
1230 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1232 struct config_set_element k;
1233 struct config_set_element *found_entry;
1234 char *normalized_key;
1235 int ret;
1237 * `key` may come from the user, so normalize it before using it
1238 * for querying entries from the hashmap.
1240 ret = git_config_parse_key(key, &normalized_key, NULL);
1242 if (ret)
1243 return NULL;
1245 hashmap_entry_init(&k, strhash(normalized_key));
1246 k.key = normalized_key;
1247 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1248 free(normalized_key);
1249 return found_entry;
1252 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1254 struct config_set_element *e;
1255 e = configset_find_element(cs, key);
1257 * Since the keys are being fed by git_config*() callback mechanism, they
1258 * are already normalized. So simply add them without any further munging.
1260 if (!e) {
1261 e = xmalloc(sizeof(*e));
1262 hashmap_entry_init(e, strhash(key));
1263 e->key = xstrdup(key);
1264 string_list_init(&e->value_list, 1);
1265 hashmap_add(&cs->config_hash, e);
1267 string_list_append_nodup(&e->value_list, value ? xstrdup(value) : NULL);
1269 return 0;
1272 static int config_set_element_cmp(const struct config_set_element *e1,
1273 const struct config_set_element *e2, const void *unused)
1275 return strcmp(e1->key, e2->key);
1278 void git_configset_init(struct config_set *cs)
1280 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1281 cs->hash_initialized = 1;
1284 void git_configset_clear(struct config_set *cs)
1286 struct config_set_element *entry;
1287 struct hashmap_iter iter;
1288 if (!cs->hash_initialized)
1289 return;
1291 hashmap_iter_init(&cs->config_hash, &iter);
1292 while ((entry = hashmap_iter_next(&iter))) {
1293 free(entry->key);
1294 string_list_clear(&entry->value_list, 0);
1296 hashmap_free(&cs->config_hash, 1);
1297 cs->hash_initialized = 0;
1300 static int config_set_callback(const char *key, const char *value, void *cb)
1302 struct config_set *cs = cb;
1303 configset_add_value(cs, key, value);
1304 return 0;
1307 int git_configset_add_file(struct config_set *cs, const char *filename)
1309 return git_config_from_file(config_set_callback, filename, cs);
1312 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1314 const struct string_list *values = NULL;
1316 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1317 * queried key in the files of the configset, the value returned will be the last
1318 * value in the value list for that key.
1320 values = git_configset_get_value_multi(cs, key);
1322 if (!values)
1323 return 1;
1324 assert(values->nr > 0);
1325 *value = values->items[values->nr - 1].string;
1326 return 0;
1329 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1331 struct config_set_element *e = configset_find_element(cs, key);
1332 return e ? &e->value_list : NULL;
1335 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1337 const char *value;
1338 if (!git_configset_get_value(cs, key, &value))
1339 return git_config_string(dest, key, value);
1340 else
1341 return 1;
1344 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1346 return git_configset_get_string_const(cs, key, (const char **)dest);
1349 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1351 const char *value;
1352 if (!git_configset_get_value(cs, key, &value)) {
1353 *dest = git_config_int(key, value);
1354 return 0;
1355 } else
1356 return 1;
1359 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1361 const char *value;
1362 if (!git_configset_get_value(cs, key, &value)) {
1363 *dest = git_config_ulong(key, value);
1364 return 0;
1365 } else
1366 return 1;
1369 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1371 const char *value;
1372 if (!git_configset_get_value(cs, key, &value)) {
1373 *dest = git_config_bool(key, value);
1374 return 0;
1375 } else
1376 return 1;
1379 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1380 int *is_bool, int *dest)
1382 const char *value;
1383 if (!git_configset_get_value(cs, key, &value)) {
1384 *dest = git_config_bool_or_int(key, value, is_bool);
1385 return 0;
1386 } else
1387 return 1;
1390 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1392 const char *value;
1393 if (!git_configset_get_value(cs, key, &value)) {
1394 *dest = git_config_maybe_bool(key, value);
1395 if (*dest == -1)
1396 return -1;
1397 return 0;
1398 } else
1399 return 1;
1402 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1404 const char *value;
1405 if (!git_configset_get_value(cs, key, &value))
1406 return git_config_pathname(dest, key, value);
1407 else
1408 return 1;
1411 static void git_config_check_init(void)
1413 if (the_config_set.hash_initialized)
1414 return;
1415 git_configset_init(&the_config_set);
1416 git_config(config_set_callback, &the_config_set);
1419 void git_config_clear(void)
1421 if (!the_config_set.hash_initialized)
1422 return;
1423 git_configset_clear(&the_config_set);
1426 int git_config_get_value(const char *key, const char **value)
1428 git_config_check_init();
1429 return git_configset_get_value(&the_config_set, key, value);
1432 const struct string_list *git_config_get_value_multi(const char *key)
1434 git_config_check_init();
1435 return git_configset_get_value_multi(&the_config_set, key);
1438 int git_config_get_string_const(const char *key, const char **dest)
1440 git_config_check_init();
1441 return git_configset_get_string_const(&the_config_set, key, dest);
1444 int git_config_get_string(const char *key, char **dest)
1446 git_config_check_init();
1447 return git_config_get_string_const(key, (const char **)dest);
1450 int git_config_get_int(const char *key, int *dest)
1452 git_config_check_init();
1453 return git_configset_get_int(&the_config_set, key, dest);
1456 int git_config_get_ulong(const char *key, unsigned long *dest)
1458 git_config_check_init();
1459 return git_configset_get_ulong(&the_config_set, key, dest);
1462 int git_config_get_bool(const char *key, int *dest)
1464 git_config_check_init();
1465 return git_configset_get_bool(&the_config_set, key, dest);
1468 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1470 git_config_check_init();
1471 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1474 int git_config_get_maybe_bool(const char *key, int *dest)
1476 git_config_check_init();
1477 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1480 int git_config_get_pathname(const char *key, const char **dest)
1482 git_config_check_init();
1483 return git_configset_get_pathname(&the_config_set, key, dest);
1487 * Find all the stuff for git_config_set() below.
1490 static struct {
1491 int baselen;
1492 char *key;
1493 int do_not_match;
1494 regex_t *value_regex;
1495 int multi_replace;
1496 size_t *offset;
1497 unsigned int offset_alloc;
1498 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1499 int seen;
1500 } store;
1502 static int matches(const char *key, const char *value)
1504 return !strcmp(key, store.key) &&
1505 (store.value_regex == NULL ||
1506 (store.do_not_match ^
1507 !regexec(store.value_regex, value, 0, NULL, 0)));
1510 static int store_aux(const char *key, const char *value, void *cb)
1512 const char *ep;
1513 size_t section_len;
1515 switch (store.state) {
1516 case KEY_SEEN:
1517 if (matches(key, value)) {
1518 if (store.seen == 1 && store.multi_replace == 0) {
1519 warning(_("%s has multiple values"), key);
1522 ALLOC_GROW(store.offset, store.seen + 1,
1523 store.offset_alloc);
1525 store.offset[store.seen] = cf->do_ftell(cf);
1526 store.seen++;
1528 break;
1529 case SECTION_SEEN:
1531 * What we are looking for is in store.key (both
1532 * section and var), and its section part is baselen
1533 * long. We found key (again, both section and var).
1534 * We would want to know if this key is in the same
1535 * section as what we are looking for. We already
1536 * know we are in the same section as what should
1537 * hold store.key.
1539 ep = strrchr(key, '.');
1540 section_len = ep - key;
1542 if ((section_len != store.baselen) ||
1543 memcmp(key, store.key, section_len+1)) {
1544 store.state = SECTION_END_SEEN;
1545 break;
1549 * Do not increment matches: this is no match, but we
1550 * just made sure we are in the desired section.
1552 ALLOC_GROW(store.offset, store.seen + 1,
1553 store.offset_alloc);
1554 store.offset[store.seen] = cf->do_ftell(cf);
1555 /* fallthru */
1556 case SECTION_END_SEEN:
1557 case START:
1558 if (matches(key, value)) {
1559 ALLOC_GROW(store.offset, store.seen + 1,
1560 store.offset_alloc);
1561 store.offset[store.seen] = cf->do_ftell(cf);
1562 store.state = KEY_SEEN;
1563 store.seen++;
1564 } else {
1565 if (strrchr(key, '.') - key == store.baselen &&
1566 !strncmp(key, store.key, store.baselen)) {
1567 store.state = SECTION_SEEN;
1568 ALLOC_GROW(store.offset,
1569 store.seen + 1,
1570 store.offset_alloc);
1571 store.offset[store.seen] = cf->do_ftell(cf);
1575 return 0;
1578 static int write_error(const char *filename)
1580 error("failed to write new configuration file %s", filename);
1582 /* Same error code as "failed to rename". */
1583 return 4;
1586 static int store_write_section(int fd, const char *key)
1588 const char *dot;
1589 int i, success;
1590 struct strbuf sb = STRBUF_INIT;
1592 dot = memchr(key, '.', store.baselen);
1593 if (dot) {
1594 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1595 for (i = dot - key + 1; i < store.baselen; i++) {
1596 if (key[i] == '"' || key[i] == '\\')
1597 strbuf_addch(&sb, '\\');
1598 strbuf_addch(&sb, key[i]);
1600 strbuf_addstr(&sb, "\"]\n");
1601 } else {
1602 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1605 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1606 strbuf_release(&sb);
1608 return success;
1611 static int store_write_pair(int fd, const char *key, const char *value)
1613 int i, success;
1614 int length = strlen(key + store.baselen + 1);
1615 const char *quote = "";
1616 struct strbuf sb = STRBUF_INIT;
1619 * Check to see if the value needs to be surrounded with a dq pair.
1620 * Note that problematic characters are always backslash-quoted; this
1621 * check is about not losing leading or trailing SP and strings that
1622 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1623 * configuration parser.
1625 if (value[0] == ' ')
1626 quote = "\"";
1627 for (i = 0; value[i]; i++)
1628 if (value[i] == ';' || value[i] == '#')
1629 quote = "\"";
1630 if (i && value[i - 1] == ' ')
1631 quote = "\"";
1633 strbuf_addf(&sb, "\t%.*s = %s",
1634 length, key + store.baselen + 1, quote);
1636 for (i = 0; value[i]; i++)
1637 switch (value[i]) {
1638 case '\n':
1639 strbuf_addstr(&sb, "\\n");
1640 break;
1641 case '\t':
1642 strbuf_addstr(&sb, "\\t");
1643 break;
1644 case '"':
1645 case '\\':
1646 strbuf_addch(&sb, '\\');
1647 default:
1648 strbuf_addch(&sb, value[i]);
1649 break;
1651 strbuf_addf(&sb, "%s\n", quote);
1653 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1654 strbuf_release(&sb);
1656 return success;
1659 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1660 size_t offset_, int *found_bracket)
1662 size_t equal_offset = size, bracket_offset = size;
1663 ssize_t offset;
1665 contline:
1666 for (offset = offset_-2; offset > 0
1667 && contents[offset] != '\n'; offset--)
1668 switch (contents[offset]) {
1669 case '=': equal_offset = offset; break;
1670 case ']': bracket_offset = offset; break;
1672 if (offset > 0 && contents[offset-1] == '\\') {
1673 offset_ = offset;
1674 goto contline;
1676 if (bracket_offset < equal_offset) {
1677 *found_bracket = 1;
1678 offset = bracket_offset+1;
1679 } else
1680 offset++;
1682 return offset;
1685 int git_config_set_in_file(const char *config_filename,
1686 const char *key, const char *value)
1688 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1691 int git_config_set(const char *key, const char *value)
1693 return git_config_set_multivar(key, value, NULL, 0);
1697 * Auxiliary function to sanity-check and split the key into the section
1698 * identifier and variable name.
1700 * Returns 0 on success, -1 when there is an invalid character in the key and
1701 * -2 if there is no section name in the key.
1703 * store_key - pointer to char* which will hold a copy of the key with
1704 * lowercase section and variable name
1705 * baselen - pointer to int which will hold the length of the
1706 * section + subsection part, can be NULL
1708 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1710 int i, dot, baselen;
1711 const char *last_dot = strrchr(key, '.');
1714 * Since "key" actually contains the section name and the real
1715 * key name separated by a dot, we have to know where the dot is.
1718 if (last_dot == NULL || last_dot == key) {
1719 error("key does not contain a section: %s", key);
1720 return -CONFIG_NO_SECTION_OR_NAME;
1723 if (!last_dot[1]) {
1724 error("key does not contain variable name: %s", key);
1725 return -CONFIG_NO_SECTION_OR_NAME;
1728 baselen = last_dot - key;
1729 if (baselen_)
1730 *baselen_ = baselen;
1733 * Validate the key and while at it, lower case it for matching.
1735 *store_key = xmalloc(strlen(key) + 1);
1737 dot = 0;
1738 for (i = 0; key[i]; i++) {
1739 unsigned char c = key[i];
1740 if (c == '.')
1741 dot = 1;
1742 /* Leave the extended basename untouched.. */
1743 if (!dot || i > baselen) {
1744 if (!iskeychar(c) ||
1745 (i == baselen + 1 && !isalpha(c))) {
1746 error("invalid key: %s", key);
1747 goto out_free_ret_1;
1749 c = tolower(c);
1750 } else if (c == '\n') {
1751 error("invalid key (newline): %s", key);
1752 goto out_free_ret_1;
1754 (*store_key)[i] = c;
1756 (*store_key)[i] = 0;
1758 return 0;
1760 out_free_ret_1:
1761 free(*store_key);
1762 *store_key = NULL;
1763 return -CONFIG_INVALID_KEY;
1767 * If value==NULL, unset in (remove from) config,
1768 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1769 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1770 * else all matching key/values (regardless how many) are removed,
1771 * before the new pair is written.
1773 * Returns 0 on success.
1775 * This function does this:
1777 * - it locks the config file by creating ".git/config.lock"
1779 * - it then parses the config using store_aux() as validator to find
1780 * the position on the key/value pair to replace. If it is to be unset,
1781 * it must be found exactly once.
1783 * - the config file is mmap()ed and the part before the match (if any) is
1784 * written to the lock file, then the changed part and the rest.
1786 * - the config file is removed and the lock file rename()d to it.
1789 int git_config_set_multivar_in_file(const char *config_filename,
1790 const char *key, const char *value,
1791 const char *value_regex, int multi_replace)
1793 int fd = -1, in_fd;
1794 int ret;
1795 struct lock_file *lock = NULL;
1796 char *filename_buf = NULL;
1798 /* parse-key returns negative; flip the sign to feed exit(3) */
1799 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1800 if (ret)
1801 goto out_free;
1803 store.multi_replace = multi_replace;
1805 if (!config_filename)
1806 config_filename = filename_buf = git_pathdup("config");
1809 * The lock serves a purpose in addition to locking: the new
1810 * contents of .git/config will be written into it.
1812 lock = xcalloc(1, sizeof(struct lock_file));
1813 fd = hold_lock_file_for_update(lock, config_filename, 0);
1814 if (fd < 0) {
1815 error("could not lock config file %s: %s", config_filename, strerror(errno));
1816 free(store.key);
1817 ret = CONFIG_NO_LOCK;
1818 goto out_free;
1822 * If .git/config does not exist yet, write a minimal version.
1824 in_fd = open(config_filename, O_RDONLY);
1825 if ( in_fd < 0 ) {
1826 free(store.key);
1828 if ( ENOENT != errno ) {
1829 error("opening %s: %s", config_filename,
1830 strerror(errno));
1831 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1832 goto out_free;
1834 /* if nothing to unset, error out */
1835 if (value == NULL) {
1836 ret = CONFIG_NOTHING_SET;
1837 goto out_free;
1840 store.key = (char *)key;
1841 if (!store_write_section(fd, key) ||
1842 !store_write_pair(fd, key, value))
1843 goto write_err_out;
1844 } else {
1845 struct stat st;
1846 char *contents;
1847 size_t contents_sz, copy_begin, copy_end;
1848 int i, new_line = 0;
1850 if (value_regex == NULL)
1851 store.value_regex = NULL;
1852 else {
1853 if (value_regex[0] == '!') {
1854 store.do_not_match = 1;
1855 value_regex++;
1856 } else
1857 store.do_not_match = 0;
1859 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1860 if (regcomp(store.value_regex, value_regex,
1861 REG_EXTENDED)) {
1862 error("invalid pattern: %s", value_regex);
1863 free(store.value_regex);
1864 ret = CONFIG_INVALID_PATTERN;
1865 goto out_free;
1869 ALLOC_GROW(store.offset, 1, store.offset_alloc);
1870 store.offset[0] = 0;
1871 store.state = START;
1872 store.seen = 0;
1875 * After this, store.offset will contain the *end* offset
1876 * of the last match, or remain at 0 if no match was found.
1877 * As a side effect, we make sure to transform only a valid
1878 * existing config file.
1880 if (git_config_from_file(store_aux, config_filename, NULL)) {
1881 error("invalid config file %s", config_filename);
1882 free(store.key);
1883 if (store.value_regex != NULL) {
1884 regfree(store.value_regex);
1885 free(store.value_regex);
1887 ret = CONFIG_INVALID_FILE;
1888 goto out_free;
1891 free(store.key);
1892 if (store.value_regex != NULL) {
1893 regfree(store.value_regex);
1894 free(store.value_regex);
1897 /* if nothing to unset, or too many matches, error out */
1898 if ((store.seen == 0 && value == NULL) ||
1899 (store.seen > 1 && multi_replace == 0)) {
1900 ret = CONFIG_NOTHING_SET;
1901 goto out_free;
1904 fstat(in_fd, &st);
1905 contents_sz = xsize_t(st.st_size);
1906 contents = xmmap(NULL, contents_sz, PROT_READ,
1907 MAP_PRIVATE, in_fd, 0);
1908 close(in_fd);
1910 if (chmod(lock->filename, st.st_mode & 07777) < 0) {
1911 error("chmod on %s failed: %s",
1912 lock->filename, strerror(errno));
1913 ret = CONFIG_NO_WRITE;
1914 goto out_free;
1917 if (store.seen == 0)
1918 store.seen = 1;
1920 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1921 if (store.offset[i] == 0) {
1922 store.offset[i] = copy_end = contents_sz;
1923 } else if (store.state != KEY_SEEN) {
1924 copy_end = store.offset[i];
1925 } else
1926 copy_end = find_beginning_of_line(
1927 contents, contents_sz,
1928 store.offset[i]-2, &new_line);
1930 if (copy_end > 0 && contents[copy_end-1] != '\n')
1931 new_line = 1;
1933 /* write the first part of the config */
1934 if (copy_end > copy_begin) {
1935 if (write_in_full(fd, contents + copy_begin,
1936 copy_end - copy_begin) <
1937 copy_end - copy_begin)
1938 goto write_err_out;
1939 if (new_line &&
1940 write_str_in_full(fd, "\n") != 1)
1941 goto write_err_out;
1943 copy_begin = store.offset[i];
1946 /* write the pair (value == NULL means unset) */
1947 if (value != NULL) {
1948 if (store.state == START) {
1949 if (!store_write_section(fd, key))
1950 goto write_err_out;
1952 if (!store_write_pair(fd, key, value))
1953 goto write_err_out;
1956 /* write the rest of the config */
1957 if (copy_begin < contents_sz)
1958 if (write_in_full(fd, contents + copy_begin,
1959 contents_sz - copy_begin) <
1960 contents_sz - copy_begin)
1961 goto write_err_out;
1963 munmap(contents, contents_sz);
1966 if (commit_lock_file(lock) < 0) {
1967 error("could not commit config file %s", config_filename);
1968 ret = CONFIG_NO_WRITE;
1969 goto out_free;
1973 * lock is committed, so don't try to roll it back below.
1974 * NOTE: Since lockfile.c keeps a linked list of all created
1975 * lock_file structures, it isn't safe to free(lock). It's
1976 * better to just leave it hanging around.
1978 lock = NULL;
1979 ret = 0;
1981 /* Invalidate the config cache */
1982 git_config_clear();
1984 out_free:
1985 if (lock)
1986 rollback_lock_file(lock);
1987 free(filename_buf);
1988 return ret;
1990 write_err_out:
1991 ret = write_error(lock->filename);
1992 goto out_free;
1996 int git_config_set_multivar(const char *key, const char *value,
1997 const char *value_regex, int multi_replace)
1999 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
2000 multi_replace);
2003 static int section_name_match (const char *buf, const char *name)
2005 int i = 0, j = 0, dot = 0;
2006 if (buf[i] != '[')
2007 return 0;
2008 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2009 if (!dot && isspace(buf[i])) {
2010 dot = 1;
2011 if (name[j++] != '.')
2012 break;
2013 for (i++; isspace(buf[i]); i++)
2014 ; /* do nothing */
2015 if (buf[i] != '"')
2016 break;
2017 continue;
2019 if (buf[i] == '\\' && dot)
2020 i++;
2021 else if (buf[i] == '"' && dot) {
2022 for (i++; isspace(buf[i]); i++)
2023 ; /* do_nothing */
2024 break;
2026 if (buf[i] != name[j++])
2027 break;
2029 if (buf[i] == ']' && name[j] == 0) {
2031 * We match, now just find the right length offset by
2032 * gobbling up any whitespace after it, as well
2034 i++;
2035 for (; buf[i] && isspace(buf[i]); i++)
2036 ; /* do nothing */
2037 return i;
2039 return 0;
2042 static int section_name_is_ok(const char *name)
2044 /* Empty section names are bogus. */
2045 if (!*name)
2046 return 0;
2049 * Before a dot, we must be alphanumeric or dash. After the first dot,
2050 * anything goes, so we can stop checking.
2052 for (; *name && *name != '.'; name++)
2053 if (*name != '-' && !isalnum(*name))
2054 return 0;
2055 return 1;
2058 /* if new_name == NULL, the section is removed instead */
2059 int git_config_rename_section_in_file(const char *config_filename,
2060 const char *old_name, const char *new_name)
2062 int ret = 0, remove = 0;
2063 char *filename_buf = NULL;
2064 struct lock_file *lock;
2065 int out_fd;
2066 char buf[1024];
2067 FILE *config_file;
2068 struct stat st;
2070 if (new_name && !section_name_is_ok(new_name)) {
2071 ret = error("invalid section name: %s", new_name);
2072 goto out;
2075 if (!config_filename)
2076 config_filename = filename_buf = git_pathdup("config");
2078 lock = xcalloc(1, sizeof(struct lock_file));
2079 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2080 if (out_fd < 0) {
2081 ret = error("could not lock config file %s", config_filename);
2082 goto out;
2085 if (!(config_file = fopen(config_filename, "rb"))) {
2086 /* no config file means nothing to rename, no error */
2087 goto unlock_and_out;
2090 fstat(fileno(config_file), &st);
2092 if (chmod(lock->filename, st.st_mode & 07777) < 0) {
2093 ret = error("chmod on %s failed: %s",
2094 lock->filename, strerror(errno));
2095 goto out;
2098 while (fgets(buf, sizeof(buf), config_file)) {
2099 int i;
2100 int length;
2101 char *output = buf;
2102 for (i = 0; buf[i] && isspace(buf[i]); i++)
2103 ; /* do nothing */
2104 if (buf[i] == '[') {
2105 /* it's a section */
2106 int offset = section_name_match(&buf[i], old_name);
2107 if (offset > 0) {
2108 ret++;
2109 if (new_name == NULL) {
2110 remove = 1;
2111 continue;
2113 store.baselen = strlen(new_name);
2114 if (!store_write_section(out_fd, new_name)) {
2115 ret = write_error(lock->filename);
2116 goto out;
2119 * We wrote out the new section, with
2120 * a newline, now skip the old
2121 * section's length
2123 output += offset + i;
2124 if (strlen(output) > 0) {
2126 * More content means there's
2127 * a declaration to put on the
2128 * next line; indent with a
2129 * tab
2131 output -= 1;
2132 output[0] = '\t';
2135 remove = 0;
2137 if (remove)
2138 continue;
2139 length = strlen(output);
2140 if (write_in_full(out_fd, output, length) != length) {
2141 ret = write_error(lock->filename);
2142 goto out;
2145 fclose(config_file);
2146 unlock_and_out:
2147 if (commit_lock_file(lock) < 0)
2148 ret = error("could not commit config file %s", config_filename);
2149 out:
2150 free(filename_buf);
2151 return ret;
2154 int git_config_rename_section(const char *old_name, const char *new_name)
2156 return git_config_rename_section_in_file(NULL, old_name, new_name);
2160 * Call this to report error for your variable that should not
2161 * get a boolean value (i.e. "[my] var" means "true").
2163 #undef config_error_nonbool
2164 int config_error_nonbool(const char *var)
2166 return error("Missing value for '%s'", var);
2169 int parse_config_key(const char *var,
2170 const char *section,
2171 const char **subsection, int *subsection_len,
2172 const char **key)
2174 int section_len = strlen(section);
2175 const char *dot;
2177 /* Does it start with "section." ? */
2178 if (!starts_with(var, section) || var[section_len] != '.')
2179 return -1;
2182 * Find the key; we don't know yet if we have a subsection, but we must
2183 * parse backwards from the end, since the subsection may have dots in
2184 * it, too.
2186 dot = strrchr(var, '.');
2187 *key = dot + 1;
2189 /* Did we have a subsection at all? */
2190 if (dot == var + section_len) {
2191 *subsection = NULL;
2192 *subsection_len = 0;
2194 else {
2195 *subsection = var + section_len + 1;
2196 *subsection_len = dot - *subsection;
2199 return 0;