notes.c: Use two newlines (instead of one) when concatenating notes
[git/jrn.git] / config.c
blobcdcf5836c6c374eb59e80f89dbcf525fd6bf780f
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"
12 #define MAXNAME (256)
14 static FILE *config_file;
15 static const char *config_file_name;
16 static int config_linenr;
17 static int config_file_eof;
18 static int zlib_compression_seen;
20 const char *config_exclusive_filename = NULL;
22 struct config_item
24 struct config_item *next;
25 char *name;
26 char *value;
28 static struct config_item *config_parameters;
29 static struct config_item **config_parameters_tail = &config_parameters;
31 static void lowercase(char *p)
33 for (; *p; p++)
34 *p = tolower(*p);
37 int git_config_parse_parameter(const char *text)
39 struct config_item *ct;
40 struct strbuf tmp = STRBUF_INIT;
41 struct strbuf **pair;
42 strbuf_addstr(&tmp, text);
43 pair = strbuf_split(&tmp, '=');
44 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
45 strbuf_setlen(pair[0], pair[0]->len - 1);
46 strbuf_trim(pair[0]);
47 if (!pair[0]->len) {
48 strbuf_list_free(pair);
49 return -1;
51 ct = xcalloc(1, sizeof(struct config_item));
52 ct->name = strbuf_detach(pair[0], NULL);
53 if (pair[1]) {
54 strbuf_trim(pair[1]);
55 ct->value = strbuf_detach(pair[1], NULL);
57 strbuf_list_free(pair);
58 lowercase(ct->name);
59 *config_parameters_tail = ct;
60 config_parameters_tail = &ct->next;
61 return 0;
64 static int get_next_char(void)
66 int c;
67 FILE *f;
69 c = '\n';
70 if ((f = config_file) != NULL) {
71 c = fgetc(f);
72 if (c == '\r') {
73 /* DOS like systems */
74 c = fgetc(f);
75 if (c != '\n') {
76 ungetc(c, f);
77 c = '\r';
80 if (c == '\n')
81 config_linenr++;
82 if (c == EOF) {
83 config_file_eof = 1;
84 c = '\n';
87 return c;
90 static char *parse_value(void)
92 static char value[1024];
93 int quote = 0, comment = 0, len = 0, space = 0;
95 for (;;) {
96 int c = get_next_char();
97 if (len >= sizeof(value) - 1)
98 return NULL;
99 if (c == '\n') {
100 if (quote)
101 return NULL;
102 value[len] = 0;
103 return value;
105 if (comment)
106 continue;
107 if (isspace(c) && !quote) {
108 if (len)
109 space++;
110 continue;
112 if (!quote) {
113 if (c == ';' || c == '#') {
114 comment = 1;
115 continue;
118 for (; space; space--)
119 value[len++] = ' ';
120 if (c == '\\') {
121 c = get_next_char();
122 switch (c) {
123 case '\n':
124 continue;
125 case 't':
126 c = '\t';
127 break;
128 case 'b':
129 c = '\b';
130 break;
131 case 'n':
132 c = '\n';
133 break;
134 /* Some characters escape as themselves */
135 case '\\': case '"':
136 break;
137 /* Reject unknown escape sequences */
138 default:
139 return NULL;
141 value[len++] = c;
142 continue;
144 if (c == '"') {
145 quote = 1-quote;
146 continue;
148 value[len++] = c;
152 static inline int iskeychar(int c)
154 return isalnum(c) || c == '-';
157 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
159 int c;
160 char *value;
162 /* Get the full name */
163 for (;;) {
164 c = get_next_char();
165 if (config_file_eof)
166 break;
167 if (!iskeychar(c))
168 break;
169 name[len++] = tolower(c);
170 if (len >= MAXNAME)
171 return -1;
173 name[len] = 0;
174 while (c == ' ' || c == '\t')
175 c = get_next_char();
177 value = NULL;
178 if (c != '\n') {
179 if (c != '=')
180 return -1;
181 value = parse_value();
182 if (!value)
183 return -1;
185 return fn(name, value, data);
188 static int get_extended_base_var(char *name, int baselen, int c)
190 do {
191 if (c == '\n')
192 return -1;
193 c = get_next_char();
194 } while (isspace(c));
196 /* We require the format to be '[base "extension"]' */
197 if (c != '"')
198 return -1;
199 name[baselen++] = '.';
201 for (;;) {
202 int c = get_next_char();
203 if (c == '\n')
204 return -1;
205 if (c == '"')
206 break;
207 if (c == '\\') {
208 c = get_next_char();
209 if (c == '\n')
210 return -1;
212 name[baselen++] = c;
213 if (baselen > MAXNAME / 2)
214 return -1;
217 /* Final ']' */
218 if (get_next_char() != ']')
219 return -1;
220 return baselen;
223 static int get_base_var(char *name)
225 int baselen = 0;
227 for (;;) {
228 int c = get_next_char();
229 if (config_file_eof)
230 return -1;
231 if (c == ']')
232 return baselen;
233 if (isspace(c))
234 return get_extended_base_var(name, baselen, c);
235 if (!iskeychar(c) && c != '.')
236 return -1;
237 if (baselen > MAXNAME / 2)
238 return -1;
239 name[baselen++] = tolower(c);
243 static int git_parse_file(config_fn_t fn, void *data)
245 int comment = 0;
246 int baselen = 0;
247 static char var[MAXNAME];
249 /* U+FEFF Byte Order Mark in UTF8 */
250 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
251 const unsigned char *bomptr = utf8_bom;
253 for (;;) {
254 int c = get_next_char();
255 if (bomptr && *bomptr) {
256 /* We are at the file beginning; skip UTF8-encoded BOM
257 * if present. Sane editors won't put this in on their
258 * own, but e.g. Windows Notepad will do it happily. */
259 if ((unsigned char) c == *bomptr) {
260 bomptr++;
261 continue;
262 } else {
263 /* Do not tolerate partial BOM. */
264 if (bomptr != utf8_bom)
265 break;
266 /* No BOM at file beginning. Cool. */
267 bomptr = NULL;
270 if (c == '\n') {
271 if (config_file_eof)
272 return 0;
273 comment = 0;
274 continue;
276 if (comment || isspace(c))
277 continue;
278 if (c == '#' || c == ';') {
279 comment = 1;
280 continue;
282 if (c == '[') {
283 baselen = get_base_var(var);
284 if (baselen <= 0)
285 break;
286 var[baselen++] = '.';
287 var[baselen] = 0;
288 continue;
290 if (!isalpha(c))
291 break;
292 var[baselen] = tolower(c);
293 if (get_value(fn, data, var, baselen+1) < 0)
294 break;
296 die("bad config file line %d in %s", config_linenr, config_file_name);
299 static int parse_unit_factor(const char *end, unsigned long *val)
301 if (!*end)
302 return 1;
303 else if (!strcasecmp(end, "k")) {
304 *val *= 1024;
305 return 1;
307 else if (!strcasecmp(end, "m")) {
308 *val *= 1024 * 1024;
309 return 1;
311 else if (!strcasecmp(end, "g")) {
312 *val *= 1024 * 1024 * 1024;
313 return 1;
315 return 0;
318 static int git_parse_long(const char *value, long *ret)
320 if (value && *value) {
321 char *end;
322 long val = strtol(value, &end, 0);
323 unsigned long factor = 1;
324 if (!parse_unit_factor(end, &factor))
325 return 0;
326 *ret = val * factor;
327 return 1;
329 return 0;
332 int git_parse_ulong(const char *value, unsigned long *ret)
334 if (value && *value) {
335 char *end;
336 unsigned long val = strtoul(value, &end, 0);
337 if (!parse_unit_factor(end, &val))
338 return 0;
339 *ret = val;
340 return 1;
342 return 0;
345 static void die_bad_config(const char *name)
347 if (config_file_name)
348 die("bad config value for '%s' in %s", name, config_file_name);
349 die("bad config value for '%s'", name);
352 int git_config_int(const char *name, const char *value)
354 long ret = 0;
355 if (!git_parse_long(value, &ret))
356 die_bad_config(name);
357 return ret;
360 unsigned long git_config_ulong(const char *name, const char *value)
362 unsigned long ret;
363 if (!git_parse_ulong(value, &ret))
364 die_bad_config(name);
365 return ret;
368 int git_config_maybe_bool(const char *name, const char *value)
370 if (!value)
371 return 1;
372 if (!*value)
373 return 0;
374 if (!strcasecmp(value, "true")
375 || !strcasecmp(value, "yes")
376 || !strcasecmp(value, "on"))
377 return 1;
378 if (!strcasecmp(value, "false")
379 || !strcasecmp(value, "no")
380 || !strcasecmp(value, "off"))
381 return 0;
382 return -1;
385 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
387 int v = git_config_maybe_bool(name, value);
388 if (0 <= v) {
389 *is_bool = 1;
390 return v;
392 *is_bool = 0;
393 return git_config_int(name, value);
396 int git_config_bool(const char *name, const char *value)
398 int discard;
399 return !!git_config_bool_or_int(name, value, &discard);
402 int git_config_string(const char **dest, const char *var, const char *value)
404 if (!value)
405 return config_error_nonbool(var);
406 *dest = xstrdup(value);
407 return 0;
410 int git_config_pathname(const char **dest, const char *var, const char *value)
412 if (!value)
413 return config_error_nonbool(var);
414 *dest = expand_user_path(value);
415 if (!*dest)
416 die("Failed to expand user dir in: '%s'", value);
417 return 0;
420 static int git_default_core_config(const char *var, const char *value)
422 /* This needs a better name */
423 if (!strcmp(var, "core.filemode")) {
424 trust_executable_bit = git_config_bool(var, value);
425 return 0;
427 if (!strcmp(var, "core.trustctime")) {
428 trust_ctime = git_config_bool(var, value);
429 return 0;
432 if (!strcmp(var, "core.quotepath")) {
433 quote_path_fully = git_config_bool(var, value);
434 return 0;
437 if (!strcmp(var, "core.symlinks")) {
438 has_symlinks = git_config_bool(var, value);
439 return 0;
442 if (!strcmp(var, "core.ignorecase")) {
443 ignore_case = git_config_bool(var, value);
444 return 0;
447 if (!strcmp(var, "core.bare")) {
448 is_bare_repository_cfg = git_config_bool(var, value);
449 return 0;
452 if (!strcmp(var, "core.ignorestat")) {
453 assume_unchanged = git_config_bool(var, value);
454 return 0;
457 if (!strcmp(var, "core.prefersymlinkrefs")) {
458 prefer_symlink_refs = git_config_bool(var, value);
459 return 0;
462 if (!strcmp(var, "core.logallrefupdates")) {
463 log_all_ref_updates = git_config_bool(var, value);
464 return 0;
467 if (!strcmp(var, "core.warnambiguousrefs")) {
468 warn_ambiguous_refs = git_config_bool(var, value);
469 return 0;
472 if (!strcmp(var, "core.loosecompression")) {
473 int level = git_config_int(var, value);
474 if (level == -1)
475 level = Z_DEFAULT_COMPRESSION;
476 else if (level < 0 || level > Z_BEST_COMPRESSION)
477 die("bad zlib compression level %d", level);
478 zlib_compression_level = level;
479 zlib_compression_seen = 1;
480 return 0;
483 if (!strcmp(var, "core.compression")) {
484 int level = git_config_int(var, value);
485 if (level == -1)
486 level = Z_DEFAULT_COMPRESSION;
487 else if (level < 0 || level > Z_BEST_COMPRESSION)
488 die("bad zlib compression level %d", level);
489 core_compression_level = level;
490 core_compression_seen = 1;
491 if (!zlib_compression_seen)
492 zlib_compression_level = level;
493 return 0;
496 if (!strcmp(var, "core.packedgitwindowsize")) {
497 int pgsz_x2 = getpagesize() * 2;
498 packed_git_window_size = git_config_int(var, value);
500 /* This value must be multiple of (pagesize * 2) */
501 packed_git_window_size /= pgsz_x2;
502 if (packed_git_window_size < 1)
503 packed_git_window_size = 1;
504 packed_git_window_size *= pgsz_x2;
505 return 0;
508 if (!strcmp(var, "core.packedgitlimit")) {
509 packed_git_limit = git_config_int(var, value);
510 return 0;
513 if (!strcmp(var, "core.deltabasecachelimit")) {
514 delta_base_cache_limit = git_config_int(var, value);
515 return 0;
518 if (!strcmp(var, "core.autocrlf")) {
519 if (value && !strcasecmp(value, "input")) {
520 if (eol == EOL_CRLF)
521 return error("core.autocrlf=input conflicts with core.eol=crlf");
522 auto_crlf = AUTO_CRLF_INPUT;
523 return 0;
525 auto_crlf = git_config_bool(var, value);
526 return 0;
529 if (!strcmp(var, "core.safecrlf")) {
530 if (value && !strcasecmp(value, "warn")) {
531 safe_crlf = SAFE_CRLF_WARN;
532 return 0;
534 safe_crlf = git_config_bool(var, value);
535 return 0;
538 if (!strcmp(var, "core.eol")) {
539 if (value && !strcasecmp(value, "lf"))
540 eol = EOL_LF;
541 else if (value && !strcasecmp(value, "crlf"))
542 eol = EOL_CRLF;
543 else if (value && !strcasecmp(value, "native"))
544 eol = EOL_NATIVE;
545 else
546 eol = EOL_UNSET;
547 if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
548 return error("core.autocrlf=input conflicts with core.eol=crlf");
549 return 0;
552 if (!strcmp(var, "core.notesref")) {
553 notes_ref_name = xstrdup(value);
554 return 0;
557 if (!strcmp(var, "core.pager"))
558 return git_config_string(&pager_program, var, value);
560 if (!strcmp(var, "core.editor"))
561 return git_config_string(&editor_program, var, value);
563 if (!strcmp(var, "core.excludesfile"))
564 return git_config_pathname(&excludes_file, var, value);
566 if (!strcmp(var, "core.whitespace")) {
567 if (!value)
568 return config_error_nonbool(var);
569 whitespace_rule_cfg = parse_whitespace_rule(value);
570 return 0;
573 if (!strcmp(var, "core.fsyncobjectfiles")) {
574 fsync_object_files = git_config_bool(var, value);
575 return 0;
578 if (!strcmp(var, "core.preloadindex")) {
579 core_preload_index = git_config_bool(var, value);
580 return 0;
583 if (!strcmp(var, "core.createobject")) {
584 if (!strcmp(value, "rename"))
585 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
586 else if (!strcmp(value, "link"))
587 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
588 else
589 die("Invalid mode for object creation: %s", value);
590 return 0;
593 if (!strcmp(var, "core.sparsecheckout")) {
594 core_apply_sparse_checkout = git_config_bool(var, value);
595 return 0;
598 /* Add other config variables here and to Documentation/config.txt. */
599 return 0;
602 static int git_default_user_config(const char *var, const char *value)
604 if (!strcmp(var, "user.name")) {
605 if (!value)
606 return config_error_nonbool(var);
607 strlcpy(git_default_name, value, sizeof(git_default_name));
608 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
609 return 0;
612 if (!strcmp(var, "user.email")) {
613 if (!value)
614 return config_error_nonbool(var);
615 strlcpy(git_default_email, value, sizeof(git_default_email));
616 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
617 return 0;
620 /* Add other config variables here and to Documentation/config.txt. */
621 return 0;
624 static int git_default_i18n_config(const char *var, const char *value)
626 if (!strcmp(var, "i18n.commitencoding"))
627 return git_config_string(&git_commit_encoding, var, value);
629 if (!strcmp(var, "i18n.logoutputencoding"))
630 return git_config_string(&git_log_output_encoding, var, value);
632 /* Add other config variables here and to Documentation/config.txt. */
633 return 0;
636 static int git_default_branch_config(const char *var, const char *value)
638 if (!strcmp(var, "branch.autosetupmerge")) {
639 if (value && !strcasecmp(value, "always")) {
640 git_branch_track = BRANCH_TRACK_ALWAYS;
641 return 0;
643 git_branch_track = git_config_bool(var, value);
644 return 0;
646 if (!strcmp(var, "branch.autosetuprebase")) {
647 if (!value)
648 return config_error_nonbool(var);
649 else if (!strcmp(value, "never"))
650 autorebase = AUTOREBASE_NEVER;
651 else if (!strcmp(value, "local"))
652 autorebase = AUTOREBASE_LOCAL;
653 else if (!strcmp(value, "remote"))
654 autorebase = AUTOREBASE_REMOTE;
655 else if (!strcmp(value, "always"))
656 autorebase = AUTOREBASE_ALWAYS;
657 else
658 return error("Malformed value for %s", var);
659 return 0;
662 /* Add other config variables here and to Documentation/config.txt. */
663 return 0;
666 static int git_default_push_config(const char *var, const char *value)
668 if (!strcmp(var, "push.default")) {
669 if (!value)
670 return config_error_nonbool(var);
671 else if (!strcmp(value, "nothing"))
672 push_default = PUSH_DEFAULT_NOTHING;
673 else if (!strcmp(value, "matching"))
674 push_default = PUSH_DEFAULT_MATCHING;
675 else if (!strcmp(value, "tracking"))
676 push_default = PUSH_DEFAULT_TRACKING;
677 else if (!strcmp(value, "current"))
678 push_default = PUSH_DEFAULT_CURRENT;
679 else {
680 error("Malformed value for %s: %s", var, value);
681 return error("Must be one of nothing, matching, "
682 "tracking or current.");
684 return 0;
687 /* Add other config variables here and to Documentation/config.txt. */
688 return 0;
691 static int git_default_mailmap_config(const char *var, const char *value)
693 if (!strcmp(var, "mailmap.file"))
694 return git_config_string(&git_mailmap_file, var, value);
696 /* Add other config variables here and to Documentation/config.txt. */
697 return 0;
700 int git_default_config(const char *var, const char *value, void *dummy)
702 if (!prefixcmp(var, "core."))
703 return git_default_core_config(var, value);
705 if (!prefixcmp(var, "user."))
706 return git_default_user_config(var, value);
708 if (!prefixcmp(var, "i18n."))
709 return git_default_i18n_config(var, value);
711 if (!prefixcmp(var, "branch."))
712 return git_default_branch_config(var, value);
714 if (!prefixcmp(var, "push."))
715 return git_default_push_config(var, value);
717 if (!prefixcmp(var, "mailmap."))
718 return git_default_mailmap_config(var, value);
720 if (!prefixcmp(var, "advice."))
721 return git_default_advice_config(var, value);
723 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
724 pager_use_color = git_config_bool(var,value);
725 return 0;
728 /* Add other config variables here and to Documentation/config.txt. */
729 return 0;
732 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
734 int ret;
735 FILE *f = fopen(filename, "r");
737 ret = -1;
738 if (f) {
739 config_file = f;
740 config_file_name = filename;
741 config_linenr = 1;
742 config_file_eof = 0;
743 ret = git_parse_file(fn, data);
744 fclose(f);
745 config_file_name = NULL;
747 return ret;
750 const char *git_etc_gitconfig(void)
752 static const char *system_wide;
753 if (!system_wide)
754 system_wide = system_path(ETC_GITCONFIG);
755 return system_wide;
758 int git_env_bool(const char *k, int def)
760 const char *v = getenv(k);
761 return v ? git_config_bool(k, v) : def;
764 int git_config_system(void)
766 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
769 int git_config_global(void)
771 return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
774 int git_config_from_parameters(config_fn_t fn, void *data)
776 const struct config_item *ct;
777 for (ct = config_parameters; ct; ct = ct->next)
778 if (fn(ct->name, ct->value, data) < 0)
779 return -1;
780 return 0;
783 int git_config(config_fn_t fn, void *data)
785 int ret = 0, found = 0;
786 char *repo_config = NULL;
787 const char *home = NULL;
789 /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
790 if (config_exclusive_filename)
791 return git_config_from_file(fn, config_exclusive_filename, data);
792 if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
793 ret += git_config_from_file(fn, git_etc_gitconfig(),
794 data);
795 found += 1;
798 home = getenv("HOME");
799 if (git_config_global() && home) {
800 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
801 if (!access(user_config, R_OK)) {
802 ret += git_config_from_file(fn, user_config, data);
803 found += 1;
805 free(user_config);
808 repo_config = git_pathdup("config");
809 if (!access(repo_config, R_OK)) {
810 ret += git_config_from_file(fn, repo_config, data);
811 found += 1;
813 free(repo_config);
815 if (config_parameters) {
816 ret += git_config_from_parameters(fn, data);
817 found += 1;
820 if (found == 0)
821 return -1;
822 return ret;
826 * Find all the stuff for git_config_set() below.
829 #define MAX_MATCHES 512
831 static struct {
832 int baselen;
833 char *key;
834 int do_not_match;
835 regex_t *value_regex;
836 int multi_replace;
837 size_t offset[MAX_MATCHES];
838 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
839 int seen;
840 } store;
842 static int matches(const char *key, const char *value)
844 return !strcmp(key, store.key) &&
845 (store.value_regex == NULL ||
846 (store.do_not_match ^
847 !regexec(store.value_regex, value, 0, NULL, 0)));
850 static int store_aux(const char *key, const char *value, void *cb)
852 const char *ep;
853 size_t section_len;
855 switch (store.state) {
856 case KEY_SEEN:
857 if (matches(key, value)) {
858 if (store.seen == 1 && store.multi_replace == 0) {
859 warning("%s has multiple values", key);
860 } else if (store.seen >= MAX_MATCHES) {
861 error("too many matches for %s", key);
862 return 1;
865 store.offset[store.seen] = ftell(config_file);
866 store.seen++;
868 break;
869 case SECTION_SEEN:
871 * What we are looking for is in store.key (both
872 * section and var), and its section part is baselen
873 * long. We found key (again, both section and var).
874 * We would want to know if this key is in the same
875 * section as what we are looking for. We already
876 * know we are in the same section as what should
877 * hold store.key.
879 ep = strrchr(key, '.');
880 section_len = ep - key;
882 if ((section_len != store.baselen) ||
883 memcmp(key, store.key, section_len+1)) {
884 store.state = SECTION_END_SEEN;
885 break;
889 * Do not increment matches: this is no match, but we
890 * just made sure we are in the desired section.
892 store.offset[store.seen] = ftell(config_file);
893 /* fallthru */
894 case SECTION_END_SEEN:
895 case START:
896 if (matches(key, value)) {
897 store.offset[store.seen] = ftell(config_file);
898 store.state = KEY_SEEN;
899 store.seen++;
900 } else {
901 if (strrchr(key, '.') - key == store.baselen &&
902 !strncmp(key, store.key, store.baselen)) {
903 store.state = SECTION_SEEN;
904 store.offset[store.seen] = ftell(config_file);
908 return 0;
911 static int write_error(const char *filename)
913 error("failed to write new configuration file %s", filename);
915 /* Same error code as "failed to rename". */
916 return 4;
919 static int store_write_section(int fd, const char *key)
921 const char *dot;
922 int i, success;
923 struct strbuf sb = STRBUF_INIT;
925 dot = memchr(key, '.', store.baselen);
926 if (dot) {
927 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
928 for (i = dot - key + 1; i < store.baselen; i++) {
929 if (key[i] == '"' || key[i] == '\\')
930 strbuf_addch(&sb, '\\');
931 strbuf_addch(&sb, key[i]);
933 strbuf_addstr(&sb, "\"]\n");
934 } else {
935 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
938 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
939 strbuf_release(&sb);
941 return success;
944 static int store_write_pair(int fd, const char *key, const char *value)
946 int i, success;
947 int length = strlen(key + store.baselen + 1);
948 const char *quote = "";
949 struct strbuf sb = STRBUF_INIT;
952 * Check to see if the value needs to be surrounded with a dq pair.
953 * Note that problematic characters are always backslash-quoted; this
954 * check is about not losing leading or trailing SP and strings that
955 * follow beginning-of-comment characters (i.e. ';' and '#') by the
956 * configuration parser.
958 if (value[0] == ' ')
959 quote = "\"";
960 for (i = 0; value[i]; i++)
961 if (value[i] == ';' || value[i] == '#')
962 quote = "\"";
963 if (i && value[i - 1] == ' ')
964 quote = "\"";
966 strbuf_addf(&sb, "\t%.*s = %s",
967 length, key + store.baselen + 1, quote);
969 for (i = 0; value[i]; i++)
970 switch (value[i]) {
971 case '\n':
972 strbuf_addstr(&sb, "\\n");
973 break;
974 case '\t':
975 strbuf_addstr(&sb, "\\t");
976 break;
977 case '"':
978 case '\\':
979 strbuf_addch(&sb, '\\');
980 default:
981 strbuf_addch(&sb, value[i]);
982 break;
984 strbuf_addf(&sb, "%s\n", quote);
986 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
987 strbuf_release(&sb);
989 return success;
992 static ssize_t find_beginning_of_line(const char *contents, size_t size,
993 size_t offset_, int *found_bracket)
995 size_t equal_offset = size, bracket_offset = size;
996 ssize_t offset;
998 contline:
999 for (offset = offset_-2; offset > 0
1000 && contents[offset] != '\n'; offset--)
1001 switch (contents[offset]) {
1002 case '=': equal_offset = offset; break;
1003 case ']': bracket_offset = offset; break;
1005 if (offset > 0 && contents[offset-1] == '\\') {
1006 offset_ = offset;
1007 goto contline;
1009 if (bracket_offset < equal_offset) {
1010 *found_bracket = 1;
1011 offset = bracket_offset+1;
1012 } else
1013 offset++;
1015 return offset;
1018 int git_config_set(const char *key, const char *value)
1020 return git_config_set_multivar(key, value, NULL, 0);
1024 * If value==NULL, unset in (remove from) config,
1025 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1026 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1027 * else all matching key/values (regardless how many) are removed,
1028 * before the new pair is written.
1030 * Returns 0 on success.
1032 * This function does this:
1034 * - it locks the config file by creating ".git/config.lock"
1036 * - it then parses the config using store_aux() as validator to find
1037 * the position on the key/value pair to replace. If it is to be unset,
1038 * it must be found exactly once.
1040 * - the config file is mmap()ed and the part before the match (if any) is
1041 * written to the lock file, then the changed part and the rest.
1043 * - the config file is removed and the lock file rename()d to it.
1046 int git_config_set_multivar(const char *key, const char *value,
1047 const char *value_regex, int multi_replace)
1049 int i, dot;
1050 int fd = -1, in_fd;
1051 int ret;
1052 char *config_filename;
1053 struct lock_file *lock = NULL;
1054 const char *last_dot = strrchr(key, '.');
1056 if (config_exclusive_filename)
1057 config_filename = xstrdup(config_exclusive_filename);
1058 else
1059 config_filename = git_pathdup("config");
1062 * Since "key" actually contains the section name and the real
1063 * key name separated by a dot, we have to know where the dot is.
1066 if (last_dot == NULL) {
1067 error("key does not contain a section: %s", key);
1068 ret = 2;
1069 goto out_free;
1071 store.baselen = last_dot - key;
1073 store.multi_replace = multi_replace;
1076 * Validate the key and while at it, lower case it for matching.
1078 store.key = xmalloc(strlen(key) + 1);
1079 dot = 0;
1080 for (i = 0; key[i]; i++) {
1081 unsigned char c = key[i];
1082 if (c == '.')
1083 dot = 1;
1084 /* Leave the extended basename untouched.. */
1085 if (!dot || i > store.baselen) {
1086 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
1087 error("invalid key: %s", key);
1088 free(store.key);
1089 ret = 1;
1090 goto out_free;
1092 c = tolower(c);
1093 } else if (c == '\n') {
1094 error("invalid key (newline): %s", key);
1095 free(store.key);
1096 ret = 1;
1097 goto out_free;
1099 store.key[i] = c;
1101 store.key[i] = 0;
1104 * The lock serves a purpose in addition to locking: the new
1105 * contents of .git/config will be written into it.
1107 lock = xcalloc(sizeof(struct lock_file), 1);
1108 fd = hold_lock_file_for_update(lock, config_filename, 0);
1109 if (fd < 0) {
1110 error("could not lock config file %s: %s", config_filename, strerror(errno));
1111 free(store.key);
1112 ret = -1;
1113 goto out_free;
1117 * If .git/config does not exist yet, write a minimal version.
1119 in_fd = open(config_filename, O_RDONLY);
1120 if ( in_fd < 0 ) {
1121 free(store.key);
1123 if ( ENOENT != errno ) {
1124 error("opening %s: %s", config_filename,
1125 strerror(errno));
1126 ret = 3; /* same as "invalid config file" */
1127 goto out_free;
1129 /* if nothing to unset, error out */
1130 if (value == NULL) {
1131 ret = 5;
1132 goto out_free;
1135 store.key = (char *)key;
1136 if (!store_write_section(fd, key) ||
1137 !store_write_pair(fd, key, value))
1138 goto write_err_out;
1139 } else {
1140 struct stat st;
1141 char *contents;
1142 size_t contents_sz, copy_begin, copy_end;
1143 int i, new_line = 0;
1145 if (value_regex == NULL)
1146 store.value_regex = NULL;
1147 else {
1148 if (value_regex[0] == '!') {
1149 store.do_not_match = 1;
1150 value_regex++;
1151 } else
1152 store.do_not_match = 0;
1154 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1155 if (regcomp(store.value_regex, value_regex,
1156 REG_EXTENDED)) {
1157 error("invalid pattern: %s", value_regex);
1158 free(store.value_regex);
1159 ret = 6;
1160 goto out_free;
1164 store.offset[0] = 0;
1165 store.state = START;
1166 store.seen = 0;
1169 * After this, store.offset will contain the *end* offset
1170 * of the last match, or remain at 0 if no match was found.
1171 * As a side effect, we make sure to transform only a valid
1172 * existing config file.
1174 if (git_config_from_file(store_aux, config_filename, NULL)) {
1175 error("invalid config file %s", config_filename);
1176 free(store.key);
1177 if (store.value_regex != NULL) {
1178 regfree(store.value_regex);
1179 free(store.value_regex);
1181 ret = 3;
1182 goto out_free;
1185 free(store.key);
1186 if (store.value_regex != NULL) {
1187 regfree(store.value_regex);
1188 free(store.value_regex);
1191 /* if nothing to unset, or too many matches, error out */
1192 if ((store.seen == 0 && value == NULL) ||
1193 (store.seen > 1 && multi_replace == 0)) {
1194 ret = 5;
1195 goto out_free;
1198 fstat(in_fd, &st);
1199 contents_sz = xsize_t(st.st_size);
1200 contents = xmmap(NULL, contents_sz, PROT_READ,
1201 MAP_PRIVATE, in_fd, 0);
1202 close(in_fd);
1204 if (store.seen == 0)
1205 store.seen = 1;
1207 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1208 if (store.offset[i] == 0) {
1209 store.offset[i] = copy_end = contents_sz;
1210 } else if (store.state != KEY_SEEN) {
1211 copy_end = store.offset[i];
1212 } else
1213 copy_end = find_beginning_of_line(
1214 contents, contents_sz,
1215 store.offset[i]-2, &new_line);
1217 if (copy_end > 0 && contents[copy_end-1] != '\n')
1218 new_line = 1;
1220 /* write the first part of the config */
1221 if (copy_end > copy_begin) {
1222 if (write_in_full(fd, contents + copy_begin,
1223 copy_end - copy_begin) <
1224 copy_end - copy_begin)
1225 goto write_err_out;
1226 if (new_line &&
1227 write_str_in_full(fd, "\n") != 1)
1228 goto write_err_out;
1230 copy_begin = store.offset[i];
1233 /* write the pair (value == NULL means unset) */
1234 if (value != NULL) {
1235 if (store.state == START) {
1236 if (!store_write_section(fd, key))
1237 goto write_err_out;
1239 if (!store_write_pair(fd, key, value))
1240 goto write_err_out;
1243 /* write the rest of the config */
1244 if (copy_begin < contents_sz)
1245 if (write_in_full(fd, contents + copy_begin,
1246 contents_sz - copy_begin) <
1247 contents_sz - copy_begin)
1248 goto write_err_out;
1250 munmap(contents, contents_sz);
1253 if (commit_lock_file(lock) < 0) {
1254 error("could not commit config file %s", config_filename);
1255 ret = 4;
1256 goto out_free;
1260 * lock is committed, so don't try to roll it back below.
1261 * NOTE: Since lockfile.c keeps a linked list of all created
1262 * lock_file structures, it isn't safe to free(lock). It's
1263 * better to just leave it hanging around.
1265 lock = NULL;
1266 ret = 0;
1268 out_free:
1269 if (lock)
1270 rollback_lock_file(lock);
1271 free(config_filename);
1272 return ret;
1274 write_err_out:
1275 ret = write_error(lock->filename);
1276 goto out_free;
1280 static int section_name_match (const char *buf, const char *name)
1282 int i = 0, j = 0, dot = 0;
1283 if (buf[i] != '[')
1284 return 0;
1285 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1286 if (!dot && isspace(buf[i])) {
1287 dot = 1;
1288 if (name[j++] != '.')
1289 break;
1290 for (i++; isspace(buf[i]); i++)
1291 ; /* do nothing */
1292 if (buf[i] != '"')
1293 break;
1294 continue;
1296 if (buf[i] == '\\' && dot)
1297 i++;
1298 else if (buf[i] == '"' && dot) {
1299 for (i++; isspace(buf[i]); i++)
1300 ; /* do_nothing */
1301 break;
1303 if (buf[i] != name[j++])
1304 break;
1306 if (buf[i] == ']' && name[j] == 0) {
1308 * We match, now just find the right length offset by
1309 * gobbling up any whitespace after it, as well
1311 i++;
1312 for (; buf[i] && isspace(buf[i]); i++)
1313 ; /* do nothing */
1314 return i;
1316 return 0;
1319 /* if new_name == NULL, the section is removed instead */
1320 int git_config_rename_section(const char *old_name, const char *new_name)
1322 int ret = 0, remove = 0;
1323 char *config_filename;
1324 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1325 int out_fd;
1326 char buf[1024];
1328 if (config_exclusive_filename)
1329 config_filename = xstrdup(config_exclusive_filename);
1330 else
1331 config_filename = git_pathdup("config");
1332 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1333 if (out_fd < 0) {
1334 ret = error("could not lock config file %s", config_filename);
1335 goto out;
1338 if (!(config_file = fopen(config_filename, "rb"))) {
1339 /* no config file means nothing to rename, no error */
1340 goto unlock_and_out;
1343 while (fgets(buf, sizeof(buf), config_file)) {
1344 int i;
1345 int length;
1346 char *output = buf;
1347 for (i = 0; buf[i] && isspace(buf[i]); i++)
1348 ; /* do nothing */
1349 if (buf[i] == '[') {
1350 /* it's a section */
1351 int offset = section_name_match(&buf[i], old_name);
1352 if (offset > 0) {
1353 ret++;
1354 if (new_name == NULL) {
1355 remove = 1;
1356 continue;
1358 store.baselen = strlen(new_name);
1359 if (!store_write_section(out_fd, new_name)) {
1360 ret = write_error(lock->filename);
1361 goto out;
1364 * We wrote out the new section, with
1365 * a newline, now skip the old
1366 * section's length
1368 output += offset + i;
1369 if (strlen(output) > 0) {
1371 * More content means there's
1372 * a declaration to put on the
1373 * next line; indent with a
1374 * tab
1376 output -= 1;
1377 output[0] = '\t';
1380 remove = 0;
1382 if (remove)
1383 continue;
1384 length = strlen(output);
1385 if (write_in_full(out_fd, output, length) != length) {
1386 ret = write_error(lock->filename);
1387 goto out;
1390 fclose(config_file);
1391 unlock_and_out:
1392 if (commit_lock_file(lock) < 0)
1393 ret = error("could not commit config file %s", config_filename);
1394 out:
1395 free(config_filename);
1396 return ret;
1400 * Call this to report error for your variable that should not
1401 * get a boolean value (i.e. "[my] var" means "true").
1403 int config_error_nonbool(const char *var)
1405 return error("Missing value for '%s'", var);