Code

SubmittingPathces: remove Cogito reference
[git.git] / config.c
1 /*
2  * GIT - The information manager from hell
3  *
4  * Copyright (C) Linus Torvalds, 2005
5  * Copyright (C) Johannes Schindelin, 2005
6  *
7  */
8 #include "cache.h"
9 #include "exec_cmd.h"
10 #include "strbuf.h"
11 #include "quote.h"
13 #define MAXNAME (256)
15 static FILE *config_file;
16 static const char *config_file_name;
17 static int config_linenr;
18 static int config_file_eof;
19 static int zlib_compression_seen;
21 const char *config_exclusive_filename = NULL;
23 static void lowercase(char *p)
24 {
25         for (; *p; p++)
26                 *p = tolower(*p);
27 }
29 void git_config_push_parameter(const char *text)
30 {
31         struct strbuf env = STRBUF_INIT;
32         const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
33         if (old) {
34                 strbuf_addstr(&env, old);
35                 strbuf_addch(&env, ' ');
36         }
37         sq_quote_buf(&env, text);
38         setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
39         strbuf_release(&env);
40 }
42 static int git_config_parse_parameter(const char *text,
43                                       config_fn_t fn, void *data)
44 {
45         struct strbuf tmp = STRBUF_INIT;
46         struct strbuf **pair;
47         strbuf_addstr(&tmp, text);
48         pair = strbuf_split(&tmp, '=');
49         if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
50                 strbuf_setlen(pair[0], pair[0]->len - 1);
51         strbuf_trim(pair[0]);
52         if (!pair[0]->len) {
53                 strbuf_list_free(pair);
54                 return error("bogus config parameter: %s", text);
55         }
56         lowercase(pair[0]->buf);
57         if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
58                 strbuf_list_free(pair);
59                 return -1;
60         }
61         strbuf_list_free(pair);
62         return 0;
63 }
65 int git_config_from_parameters(config_fn_t fn, void *data)
66 {
67         const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
68         char *envw;
69         const char **argv = NULL;
70         int nr = 0, alloc = 0;
71         int i;
73         if (!env)
74                 return 0;
75         /* sq_dequote will write over it */
76         envw = xstrdup(env);
78         if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
79                 free(envw);
80                 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
81         }
83         for (i = 0; i < nr; i++) {
84                 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
85                         free(argv);
86                         free(envw);
87                         return -1;
88                 }
89         }
91         free(argv);
92         free(envw);
93         return nr > 0;
94 }
96 static int get_next_char(void)
97 {
98         int c;
99         FILE *f;
101         c = '\n';
102         if ((f = config_file) != NULL) {
103                 c = fgetc(f);
104                 if (c == '\r') {
105                         /* DOS like systems */
106                         c = fgetc(f);
107                         if (c != '\n') {
108                                 ungetc(c, f);
109                                 c = '\r';
110                         }
111                 }
112                 if (c == '\n')
113                         config_linenr++;
114                 if (c == EOF) {
115                         config_file_eof = 1;
116                         c = '\n';
117                 }
118         }
119         return c;
122 static char *parse_value(void)
124         static struct strbuf value = STRBUF_INIT;
125         int quote = 0, comment = 0, space = 0;
127         strbuf_reset(&value);
128         for (;;) {
129                 int c = get_next_char();
130                 if (c == '\n') {
131                         if (quote)
132                                 return NULL;
133                         return value.buf;
134                 }
135                 if (comment)
136                         continue;
137                 if (isspace(c) && !quote) {
138                         if (value.len)
139                                 space++;
140                         continue;
141                 }
142                 if (!quote) {
143                         if (c == ';' || c == '#') {
144                                 comment = 1;
145                                 continue;
146                         }
147                 }
148                 for (; space; space--)
149                         strbuf_addch(&value, ' ');
150                 if (c == '\\') {
151                         c = get_next_char();
152                         switch (c) {
153                         case '\n':
154                                 continue;
155                         case 't':
156                                 c = '\t';
157                                 break;
158                         case 'b':
159                                 c = '\b';
160                                 break;
161                         case 'n':
162                                 c = '\n';
163                                 break;
164                         /* Some characters escape as themselves */
165                         case '\\': case '"':
166                                 break;
167                         /* Reject unknown escape sequences */
168                         default:
169                                 return NULL;
170                         }
171                         strbuf_addch(&value, c);
172                         continue;
173                 }
174                 if (c == '"') {
175                         quote = 1-quote;
176                         continue;
177                 }
178                 strbuf_addch(&value, c);
179         }
182 static inline int iskeychar(int c)
184         return isalnum(c) || c == '-';
187 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
189         int c;
190         char *value;
192         /* Get the full name */
193         for (;;) {
194                 c = get_next_char();
195                 if (config_file_eof)
196                         break;
197                 if (!iskeychar(c))
198                         break;
199                 name[len++] = tolower(c);
200                 if (len >= MAXNAME)
201                         return -1;
202         }
203         name[len] = 0;
204         while (c == ' ' || c == '\t')
205                 c = get_next_char();
207         value = NULL;
208         if (c != '\n') {
209                 if (c != '=')
210                         return -1;
211                 value = parse_value();
212                 if (!value)
213                         return -1;
214         }
215         return fn(name, value, data);
218 static int get_extended_base_var(char *name, int baselen, int c)
220         do {
221                 if (c == '\n')
222                         return -1;
223                 c = get_next_char();
224         } while (isspace(c));
226         /* We require the format to be '[base "extension"]' */
227         if (c != '"')
228                 return -1;
229         name[baselen++] = '.';
231         for (;;) {
232                 int c = get_next_char();
233                 if (c == '\n')
234                         return -1;
235                 if (c == '"')
236                         break;
237                 if (c == '\\') {
238                         c = get_next_char();
239                         if (c == '\n')
240                                 return -1;
241                 }
242                 name[baselen++] = c;
243                 if (baselen > MAXNAME / 2)
244                         return -1;
245         }
247         /* Final ']' */
248         if (get_next_char() != ']')
249                 return -1;
250         return baselen;
253 static int get_base_var(char *name)
255         int baselen = 0;
257         for (;;) {
258                 int c = get_next_char();
259                 if (config_file_eof)
260                         return -1;
261                 if (c == ']')
262                         return baselen;
263                 if (isspace(c))
264                         return get_extended_base_var(name, baselen, c);
265                 if (!iskeychar(c) && c != '.')
266                         return -1;
267                 if (baselen > MAXNAME / 2)
268                         return -1;
269                 name[baselen++] = tolower(c);
270         }
273 static int git_parse_file(config_fn_t fn, void *data)
275         int comment = 0;
276         int baselen = 0;
277         static char var[MAXNAME];
279         /* U+FEFF Byte Order Mark in UTF8 */
280         static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
281         const unsigned char *bomptr = utf8_bom;
283         for (;;) {
284                 int c = get_next_char();
285                 if (bomptr && *bomptr) {
286                         /* We are at the file beginning; skip UTF8-encoded BOM
287                          * if present. Sane editors won't put this in on their
288                          * own, but e.g. Windows Notepad will do it happily. */
289                         if ((unsigned char) c == *bomptr) {
290                                 bomptr++;
291                                 continue;
292                         } else {
293                                 /* Do not tolerate partial BOM. */
294                                 if (bomptr != utf8_bom)
295                                         break;
296                                 /* No BOM at file beginning. Cool. */
297                                 bomptr = NULL;
298                         }
299                 }
300                 if (c == '\n') {
301                         if (config_file_eof)
302                                 return 0;
303                         comment = 0;
304                         continue;
305                 }
306                 if (comment || isspace(c))
307                         continue;
308                 if (c == '#' || c == ';') {
309                         comment = 1;
310                         continue;
311                 }
312                 if (c == '[') {
313                         baselen = get_base_var(var);
314                         if (baselen <= 0)
315                                 break;
316                         var[baselen++] = '.';
317                         var[baselen] = 0;
318                         continue;
319                 }
320                 if (!isalpha(c))
321                         break;
322                 var[baselen] = tolower(c);
323                 if (get_value(fn, data, var, baselen+1) < 0)
324                         break;
325         }
326         die("bad config file line %d in %s", config_linenr, config_file_name);
329 static int parse_unit_factor(const char *end, unsigned long *val)
331         if (!*end)
332                 return 1;
333         else if (!strcasecmp(end, "k")) {
334                 *val *= 1024;
335                 return 1;
336         }
337         else if (!strcasecmp(end, "m")) {
338                 *val *= 1024 * 1024;
339                 return 1;
340         }
341         else if (!strcasecmp(end, "g")) {
342                 *val *= 1024 * 1024 * 1024;
343                 return 1;
344         }
345         return 0;
348 static int git_parse_long(const char *value, long *ret)
350         if (value && *value) {
351                 char *end;
352                 long val = strtol(value, &end, 0);
353                 unsigned long factor = 1;
354                 if (!parse_unit_factor(end, &factor))
355                         return 0;
356                 *ret = val * factor;
357                 return 1;
358         }
359         return 0;
362 int git_parse_ulong(const char *value, unsigned long *ret)
364         if (value && *value) {
365                 char *end;
366                 unsigned long val = strtoul(value, &end, 0);
367                 if (!parse_unit_factor(end, &val))
368                         return 0;
369                 *ret = val;
370                 return 1;
371         }
372         return 0;
375 static void die_bad_config(const char *name)
377         if (config_file_name)
378                 die("bad config value for '%s' in %s", name, config_file_name);
379         die("bad config value for '%s'", name);
382 int git_config_int(const char *name, const char *value)
384         long ret = 0;
385         if (!git_parse_long(value, &ret))
386                 die_bad_config(name);
387         return ret;
390 unsigned long git_config_ulong(const char *name, const char *value)
392         unsigned long ret;
393         if (!git_parse_ulong(value, &ret))
394                 die_bad_config(name);
395         return ret;
398 static int git_config_maybe_bool_text(const char *name, const char *value)
400         if (!value)
401                 return 1;
402         if (!*value)
403                 return 0;
404         if (!strcasecmp(value, "true")
405             || !strcasecmp(value, "yes")
406             || !strcasecmp(value, "on"))
407                 return 1;
408         if (!strcasecmp(value, "false")
409             || !strcasecmp(value, "no")
410             || !strcasecmp(value, "off"))
411                 return 0;
412         return -1;
415 int git_config_maybe_bool(const char *name, const char *value)
417         long v = git_config_maybe_bool_text(name, value);
418         if (0 <= v)
419                 return v;
420         if (git_parse_long(value, &v))
421                 return !!v;
422         return -1;
425 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
427         int v = git_config_maybe_bool_text(name, value);
428         if (0 <= v) {
429                 *is_bool = 1;
430                 return v;
431         }
432         *is_bool = 0;
433         return git_config_int(name, value);
436 int git_config_bool(const char *name, const char *value)
438         int discard;
439         return !!git_config_bool_or_int(name, value, &discard);
442 int git_config_string(const char **dest, const char *var, const char *value)
444         if (!value)
445                 return config_error_nonbool(var);
446         *dest = xstrdup(value);
447         return 0;
450 int git_config_pathname(const char **dest, const char *var, const char *value)
452         if (!value)
453                 return config_error_nonbool(var);
454         *dest = expand_user_path(value);
455         if (!*dest)
456                 die("Failed to expand user dir in: '%s'", value);
457         return 0;
460 static int git_default_core_config(const char *var, const char *value)
462         /* This needs a better name */
463         if (!strcmp(var, "core.filemode")) {
464                 trust_executable_bit = git_config_bool(var, value);
465                 return 0;
466         }
467         if (!strcmp(var, "core.trustctime")) {
468                 trust_ctime = git_config_bool(var, value);
469                 return 0;
470         }
472         if (!strcmp(var, "core.quotepath")) {
473                 quote_path_fully = git_config_bool(var, value);
474                 return 0;
475         }
477         if (!strcmp(var, "core.symlinks")) {
478                 has_symlinks = git_config_bool(var, value);
479                 return 0;
480         }
482         if (!strcmp(var, "core.ignorecase")) {
483                 ignore_case = git_config_bool(var, value);
484                 return 0;
485         }
487         if (!strcmp(var, "core.bare")) {
488                 is_bare_repository_cfg = git_config_bool(var, value);
489                 return 0;
490         }
492         if (!strcmp(var, "core.ignorestat")) {
493                 assume_unchanged = git_config_bool(var, value);
494                 return 0;
495         }
497         if (!strcmp(var, "core.prefersymlinkrefs")) {
498                 prefer_symlink_refs = git_config_bool(var, value);
499                 return 0;
500         }
502         if (!strcmp(var, "core.logallrefupdates")) {
503                 log_all_ref_updates = git_config_bool(var, value);
504                 return 0;
505         }
507         if (!strcmp(var, "core.warnambiguousrefs")) {
508                 warn_ambiguous_refs = git_config_bool(var, value);
509                 return 0;
510         }
512         if (!strcmp(var, "core.abbrev")) {
513                 int abbrev = git_config_int(var, value);
514                 if (abbrev < minimum_abbrev || abbrev > 40)
515                         return -1;
516                 default_abbrev = abbrev;
517                 return 0;
518         }
520         if (!strcmp(var, "core.loosecompression")) {
521                 int level = git_config_int(var, value);
522                 if (level == -1)
523                         level = Z_DEFAULT_COMPRESSION;
524                 else if (level < 0 || level > Z_BEST_COMPRESSION)
525                         die("bad zlib compression level %d", level);
526                 zlib_compression_level = level;
527                 zlib_compression_seen = 1;
528                 return 0;
529         }
531         if (!strcmp(var, "core.compression")) {
532                 int level = git_config_int(var, value);
533                 if (level == -1)
534                         level = Z_DEFAULT_COMPRESSION;
535                 else if (level < 0 || level > Z_BEST_COMPRESSION)
536                         die("bad zlib compression level %d", level);
537                 core_compression_level = level;
538                 core_compression_seen = 1;
539                 if (!zlib_compression_seen)
540                         zlib_compression_level = level;
541                 return 0;
542         }
544         if (!strcmp(var, "core.packedgitwindowsize")) {
545                 int pgsz_x2 = getpagesize() * 2;
546                 packed_git_window_size = git_config_int(var, value);
548                 /* This value must be multiple of (pagesize * 2) */
549                 packed_git_window_size /= pgsz_x2;
550                 if (packed_git_window_size < 1)
551                         packed_git_window_size = 1;
552                 packed_git_window_size *= pgsz_x2;
553                 return 0;
554         }
556         if (!strcmp(var, "core.bigfilethreshold")) {
557                 long n = git_config_int(var, value);
558                 big_file_threshold = 0 < n ? n : 0;
559                 return 0;
560         }
562         if (!strcmp(var, "core.packedgitlimit")) {
563                 packed_git_limit = git_config_int(var, value);
564                 return 0;
565         }
567         if (!strcmp(var, "core.deltabasecachelimit")) {
568                 delta_base_cache_limit = git_config_int(var, value);
569                 return 0;
570         }
572         if (!strcmp(var, "core.autocrlf")) {
573                 if (value && !strcasecmp(value, "input")) {
574                         if (core_eol == EOL_CRLF)
575                                 return error("core.autocrlf=input conflicts with core.eol=crlf");
576                         auto_crlf = AUTO_CRLF_INPUT;
577                         return 0;
578                 }
579                 auto_crlf = git_config_bool(var, value);
580                 return 0;
581         }
583         if (!strcmp(var, "core.safecrlf")) {
584                 if (value && !strcasecmp(value, "warn")) {
585                         safe_crlf = SAFE_CRLF_WARN;
586                         return 0;
587                 }
588                 safe_crlf = git_config_bool(var, value);
589                 return 0;
590         }
592         if (!strcmp(var, "core.eol")) {
593                 if (value && !strcasecmp(value, "lf"))
594                         core_eol = EOL_LF;
595                 else if (value && !strcasecmp(value, "crlf"))
596                         core_eol = EOL_CRLF;
597                 else if (value && !strcasecmp(value, "native"))
598                         core_eol = EOL_NATIVE;
599                 else
600                         core_eol = EOL_UNSET;
601                 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
602                         return error("core.autocrlf=input conflicts with core.eol=crlf");
603                 return 0;
604         }
606         if (!strcmp(var, "core.notesref")) {
607                 notes_ref_name = xstrdup(value);
608                 return 0;
609         }
611         if (!strcmp(var, "core.pager"))
612                 return git_config_string(&pager_program, var, value);
614         if (!strcmp(var, "core.editor"))
615                 return git_config_string(&editor_program, var, value);
617         if (!strcmp(var, "core.askpass"))
618                 return git_config_string(&askpass_program, var, value);
620         if (!strcmp(var, "core.excludesfile"))
621                 return git_config_pathname(&excludes_file, var, value);
623         if (!strcmp(var, "core.whitespace")) {
624                 if (!value)
625                         return config_error_nonbool(var);
626                 whitespace_rule_cfg = parse_whitespace_rule(value);
627                 return 0;
628         }
630         if (!strcmp(var, "core.fsyncobjectfiles")) {
631                 fsync_object_files = git_config_bool(var, value);
632                 return 0;
633         }
635         if (!strcmp(var, "core.preloadindex")) {
636                 core_preload_index = git_config_bool(var, value);
637                 return 0;
638         }
640         if (!strcmp(var, "core.createobject")) {
641                 if (!strcmp(value, "rename"))
642                         object_creation_mode = OBJECT_CREATION_USES_RENAMES;
643                 else if (!strcmp(value, "link"))
644                         object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
645                 else
646                         die("Invalid mode for object creation: %s", value);
647                 return 0;
648         }
650         if (!strcmp(var, "core.sparsecheckout")) {
651                 core_apply_sparse_checkout = git_config_bool(var, value);
652                 return 0;
653         }
655         /* Add other config variables here and to Documentation/config.txt. */
656         return 0;
659 static int git_default_user_config(const char *var, const char *value)
661         if (!strcmp(var, "user.name")) {
662                 if (!value)
663                         return config_error_nonbool(var);
664                 strlcpy(git_default_name, value, sizeof(git_default_name));
665                 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
666                 return 0;
667         }
669         if (!strcmp(var, "user.email")) {
670                 if (!value)
671                         return config_error_nonbool(var);
672                 strlcpy(git_default_email, value, sizeof(git_default_email));
673                 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
674                 return 0;
675         }
677         /* Add other config variables here and to Documentation/config.txt. */
678         return 0;
681 static int git_default_i18n_config(const char *var, const char *value)
683         if (!strcmp(var, "i18n.commitencoding"))
684                 return git_config_string(&git_commit_encoding, var, value);
686         if (!strcmp(var, "i18n.logoutputencoding"))
687                 return git_config_string(&git_log_output_encoding, var, value);
689         /* Add other config variables here and to Documentation/config.txt. */
690         return 0;
693 static int git_default_branch_config(const char *var, const char *value)
695         if (!strcmp(var, "branch.autosetupmerge")) {
696                 if (value && !strcasecmp(value, "always")) {
697                         git_branch_track = BRANCH_TRACK_ALWAYS;
698                         return 0;
699                 }
700                 git_branch_track = git_config_bool(var, value);
701                 return 0;
702         }
703         if (!strcmp(var, "branch.autosetuprebase")) {
704                 if (!value)
705                         return config_error_nonbool(var);
706                 else if (!strcmp(value, "never"))
707                         autorebase = AUTOREBASE_NEVER;
708                 else if (!strcmp(value, "local"))
709                         autorebase = AUTOREBASE_LOCAL;
710                 else if (!strcmp(value, "remote"))
711                         autorebase = AUTOREBASE_REMOTE;
712                 else if (!strcmp(value, "always"))
713                         autorebase = AUTOREBASE_ALWAYS;
714                 else
715                         return error("Malformed value for %s", var);
716                 return 0;
717         }
719         /* Add other config variables here and to Documentation/config.txt. */
720         return 0;
723 static int git_default_push_config(const char *var, const char *value)
725         if (!strcmp(var, "push.default")) {
726                 if (!value)
727                         return config_error_nonbool(var);
728                 else if (!strcmp(value, "nothing"))
729                         push_default = PUSH_DEFAULT_NOTHING;
730                 else if (!strcmp(value, "matching"))
731                         push_default = PUSH_DEFAULT_MATCHING;
732                 else if (!strcmp(value, "upstream"))
733                         push_default = PUSH_DEFAULT_UPSTREAM;
734                 else if (!strcmp(value, "tracking")) /* deprecated */
735                         push_default = PUSH_DEFAULT_UPSTREAM;
736                 else if (!strcmp(value, "current"))
737                         push_default = PUSH_DEFAULT_CURRENT;
738                 else {
739                         error("Malformed value for %s: %s", var, value);
740                         return error("Must be one of nothing, matching, "
741                                      "tracking or current.");
742                 }
743                 return 0;
744         }
746         /* Add other config variables here and to Documentation/config.txt. */
747         return 0;
750 static int git_default_mailmap_config(const char *var, const char *value)
752         if (!strcmp(var, "mailmap.file"))
753                 return git_config_string(&git_mailmap_file, var, value);
755         /* Add other config variables here and to Documentation/config.txt. */
756         return 0;
759 int git_default_config(const char *var, const char *value, void *dummy)
761         if (!prefixcmp(var, "core."))
762                 return git_default_core_config(var, value);
764         if (!prefixcmp(var, "user."))
765                 return git_default_user_config(var, value);
767         if (!prefixcmp(var, "i18n."))
768                 return git_default_i18n_config(var, value);
770         if (!prefixcmp(var, "branch."))
771                 return git_default_branch_config(var, value);
773         if (!prefixcmp(var, "push."))
774                 return git_default_push_config(var, value);
776         if (!prefixcmp(var, "mailmap."))
777                 return git_default_mailmap_config(var, value);
779         if (!prefixcmp(var, "advice."))
780                 return git_default_advice_config(var, value);
782         if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
783                 pager_use_color = git_config_bool(var,value);
784                 return 0;
785         }
787         /* Add other config variables here and to Documentation/config.txt. */
788         return 0;
791 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
793         int ret;
794         FILE *f = fopen(filename, "r");
796         ret = -1;
797         if (f) {
798                 config_file = f;
799                 config_file_name = filename;
800                 config_linenr = 1;
801                 config_file_eof = 0;
802                 ret = git_parse_file(fn, data);
803                 fclose(f);
804                 config_file_name = NULL;
805         }
806         return ret;
809 const char *git_etc_gitconfig(void)
811         static const char *system_wide;
812         if (!system_wide)
813                 system_wide = system_path(ETC_GITCONFIG);
814         return system_wide;
817 int git_env_bool(const char *k, int def)
819         const char *v = getenv(k);
820         return v ? git_config_bool(k, v) : def;
823 int git_config_system(void)
825         return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
828 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
830         int ret = 0, found = 0;
831         const char *home = NULL;
833         /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
834         if (config_exclusive_filename)
835                 return git_config_from_file(fn, config_exclusive_filename, data);
836         if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
837                 ret += git_config_from_file(fn, git_etc_gitconfig(),
838                                             data);
839                 found += 1;
840         }
842         home = getenv("HOME");
843         if (home) {
844                 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
845                 if (!access(user_config, R_OK)) {
846                         ret += git_config_from_file(fn, user_config, data);
847                         found += 1;
848                 }
849                 free(user_config);
850         }
852         if (repo_config && !access(repo_config, R_OK)) {
853                 ret += git_config_from_file(fn, repo_config, data);
854                 found += 1;
855         }
857         switch (git_config_from_parameters(fn, data)) {
858         case -1: /* error */
859                 ret--;
860                 break;
861         case 0: /* found nothing */
862                 break;
863         default: /* found at least one item */
864                 found++;
865                 break;
866         }
868         return ret == 0 ? found : ret;
871 int git_config(config_fn_t fn, void *data)
873         char *repo_config = NULL;
874         int ret;
876         repo_config = git_pathdup("config");
877         ret = git_config_early(fn, data, repo_config);
878         if (repo_config)
879                 free(repo_config);
880         return ret;
883 /*
884  * Find all the stuff for git_config_set() below.
885  */
887 #define MAX_MATCHES 512
889 static struct {
890         int baselen;
891         char *key;
892         int do_not_match;
893         regex_t *value_regex;
894         int multi_replace;
895         size_t offset[MAX_MATCHES];
896         enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
897         int seen;
898 } store;
900 static int matches(const char *key, const char *value)
902         return !strcmp(key, store.key) &&
903                 (store.value_regex == NULL ||
904                  (store.do_not_match ^
905                   !regexec(store.value_regex, value, 0, NULL, 0)));
908 static int store_aux(const char *key, const char *value, void *cb)
910         const char *ep;
911         size_t section_len;
913         switch (store.state) {
914         case KEY_SEEN:
915                 if (matches(key, value)) {
916                         if (store.seen == 1 && store.multi_replace == 0) {
917                                 warning("%s has multiple values", key);
918                         } else if (store.seen >= MAX_MATCHES) {
919                                 error("too many matches for %s", key);
920                                 return 1;
921                         }
923                         store.offset[store.seen] = ftell(config_file);
924                         store.seen++;
925                 }
926                 break;
927         case SECTION_SEEN:
928                 /*
929                  * What we are looking for is in store.key (both
930                  * section and var), and its section part is baselen
931                  * long.  We found key (again, both section and var).
932                  * We would want to know if this key is in the same
933                  * section as what we are looking for.  We already
934                  * know we are in the same section as what should
935                  * hold store.key.
936                  */
937                 ep = strrchr(key, '.');
938                 section_len = ep - key;
940                 if ((section_len != store.baselen) ||
941                     memcmp(key, store.key, section_len+1)) {
942                         store.state = SECTION_END_SEEN;
943                         break;
944                 }
946                 /*
947                  * Do not increment matches: this is no match, but we
948                  * just made sure we are in the desired section.
949                  */
950                 store.offset[store.seen] = ftell(config_file);
951                 /* fallthru */
952         case SECTION_END_SEEN:
953         case START:
954                 if (matches(key, value)) {
955                         store.offset[store.seen] = ftell(config_file);
956                         store.state = KEY_SEEN;
957                         store.seen++;
958                 } else {
959                         if (strrchr(key, '.') - key == store.baselen &&
960                               !strncmp(key, store.key, store.baselen)) {
961                                         store.state = SECTION_SEEN;
962                                         store.offset[store.seen] = ftell(config_file);
963                         }
964                 }
965         }
966         return 0;
969 static int write_error(const char *filename)
971         error("failed to write new configuration file %s", filename);
973         /* Same error code as "failed to rename". */
974         return 4;
977 static int store_write_section(int fd, const char *key)
979         const char *dot;
980         int i, success;
981         struct strbuf sb = STRBUF_INIT;
983         dot = memchr(key, '.', store.baselen);
984         if (dot) {
985                 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
986                 for (i = dot - key + 1; i < store.baselen; i++) {
987                         if (key[i] == '"' || key[i] == '\\')
988                                 strbuf_addch(&sb, '\\');
989                         strbuf_addch(&sb, key[i]);
990                 }
991                 strbuf_addstr(&sb, "\"]\n");
992         } else {
993                 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
994         }
996         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
997         strbuf_release(&sb);
999         return success;
1002 static int store_write_pair(int fd, const char *key, const char *value)
1004         int i, success;
1005         int length = strlen(key + store.baselen + 1);
1006         const char *quote = "";
1007         struct strbuf sb = STRBUF_INIT;
1009         /*
1010          * Check to see if the value needs to be surrounded with a dq pair.
1011          * Note that problematic characters are always backslash-quoted; this
1012          * check is about not losing leading or trailing SP and strings that
1013          * follow beginning-of-comment characters (i.e. ';' and '#') by the
1014          * configuration parser.
1015          */
1016         if (value[0] == ' ')
1017                 quote = "\"";
1018         for (i = 0; value[i]; i++)
1019                 if (value[i] == ';' || value[i] == '#')
1020                         quote = "\"";
1021         if (i && value[i - 1] == ' ')
1022                 quote = "\"";
1024         strbuf_addf(&sb, "\t%.*s = %s",
1025                     length, key + store.baselen + 1, quote);
1027         for (i = 0; value[i]; i++)
1028                 switch (value[i]) {
1029                 case '\n':
1030                         strbuf_addstr(&sb, "\\n");
1031                         break;
1032                 case '\t':
1033                         strbuf_addstr(&sb, "\\t");
1034                         break;
1035                 case '"':
1036                 case '\\':
1037                         strbuf_addch(&sb, '\\');
1038                 default:
1039                         strbuf_addch(&sb, value[i]);
1040                         break;
1041                 }
1042         strbuf_addf(&sb, "%s\n", quote);
1044         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1045         strbuf_release(&sb);
1047         return success;
1050 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1051         size_t offset_, int *found_bracket)
1053         size_t equal_offset = size, bracket_offset = size;
1054         ssize_t offset;
1056 contline:
1057         for (offset = offset_-2; offset > 0
1058                         && contents[offset] != '\n'; offset--)
1059                 switch (contents[offset]) {
1060                         case '=': equal_offset = offset; break;
1061                         case ']': bracket_offset = offset; break;
1062                 }
1063         if (offset > 0 && contents[offset-1] == '\\') {
1064                 offset_ = offset;
1065                 goto contline;
1066         }
1067         if (bracket_offset < equal_offset) {
1068                 *found_bracket = 1;
1069                 offset = bracket_offset+1;
1070         } else
1071                 offset++;
1073         return offset;
1076 int git_config_set(const char *key, const char *value)
1078         return git_config_set_multivar(key, value, NULL, 0);
1081 /*
1082  * Auxiliary function to sanity-check and split the key into the section
1083  * identifier and variable name.
1084  *
1085  * Returns 0 on success, -1 when there is an invalid character in the key and
1086  * -2 if there is no section name in the key.
1087  *
1088  * store_key - pointer to char* which will hold a copy of the key with
1089  *             lowercase section and variable name
1090  * baselen - pointer to int which will hold the length of the
1091  *           section + subsection part, can be NULL
1092  */
1093 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1095         int i, dot, baselen;
1096         const char *last_dot = strrchr(key, '.');
1098         /*
1099          * Since "key" actually contains the section name and the real
1100          * key name separated by a dot, we have to know where the dot is.
1101          */
1103         if (last_dot == NULL || last_dot == key) {
1104                 error("key does not contain a section: %s", key);
1105                 return -CONFIG_NO_SECTION_OR_NAME;
1106         }
1108         if (!last_dot[1]) {
1109                 error("key does not contain variable name: %s", key);
1110                 return -CONFIG_NO_SECTION_OR_NAME;
1111         }
1113         baselen = last_dot - key;
1114         if (baselen_)
1115                 *baselen_ = baselen;
1117         /*
1118          * Validate the key and while at it, lower case it for matching.
1119          */
1120         *store_key = xmalloc(strlen(key) + 1);
1122         dot = 0;
1123         for (i = 0; key[i]; i++) {
1124                 unsigned char c = key[i];
1125                 if (c == '.')
1126                         dot = 1;
1127                 /* Leave the extended basename untouched.. */
1128                 if (!dot || i > baselen) {
1129                         if (!iskeychar(c) ||
1130                             (i == baselen + 1 && !isalpha(c))) {
1131                                 error("invalid key: %s", key);
1132                                 goto out_free_ret_1;
1133                         }
1134                         c = tolower(c);
1135                 } else if (c == '\n') {
1136                         error("invalid key (newline): %s", key);
1137                         goto out_free_ret_1;
1138                 }
1139                 (*store_key)[i] = c;
1140         }
1141         (*store_key)[i] = 0;
1143         return 0;
1145 out_free_ret_1:
1146         free(*store_key);
1147         return -CONFIG_INVALID_KEY;
1150 /*
1151  * If value==NULL, unset in (remove from) config,
1152  * if value_regex!=NULL, disregard key/value pairs where value does not match.
1153  * if multi_replace==0, nothing, or only one matching key/value is replaced,
1154  *     else all matching key/values (regardless how many) are removed,
1155  *     before the new pair is written.
1156  *
1157  * Returns 0 on success.
1158  *
1159  * This function does this:
1160  *
1161  * - it locks the config file by creating ".git/config.lock"
1162  *
1163  * - it then parses the config using store_aux() as validator to find
1164  *   the position on the key/value pair to replace. If it is to be unset,
1165  *   it must be found exactly once.
1166  *
1167  * - the config file is mmap()ed and the part before the match (if any) is
1168  *   written to the lock file, then the changed part and the rest.
1169  *
1170  * - the config file is removed and the lock file rename()d to it.
1171  *
1172  */
1173 int git_config_set_multivar(const char *key, const char *value,
1174         const char *value_regex, int multi_replace)
1176         int fd = -1, in_fd;
1177         int ret;
1178         char *config_filename;
1179         struct lock_file *lock = NULL;
1181         if (config_exclusive_filename)
1182                 config_filename = xstrdup(config_exclusive_filename);
1183         else
1184                 config_filename = git_pathdup("config");
1186         /* parse-key returns negative; flip the sign to feed exit(3) */
1187         ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1188         if (ret)
1189                 goto out_free;
1191         store.multi_replace = multi_replace;
1194         /*
1195          * The lock serves a purpose in addition to locking: the new
1196          * contents of .git/config will be written into it.
1197          */
1198         lock = xcalloc(sizeof(struct lock_file), 1);
1199         fd = hold_lock_file_for_update(lock, config_filename, 0);
1200         if (fd < 0) {
1201                 error("could not lock config file %s: %s", config_filename, strerror(errno));
1202                 free(store.key);
1203                 ret = CONFIG_NO_LOCK;
1204                 goto out_free;
1205         }
1207         /*
1208          * If .git/config does not exist yet, write a minimal version.
1209          */
1210         in_fd = open(config_filename, O_RDONLY);
1211         if ( in_fd < 0 ) {
1212                 free(store.key);
1214                 if ( ENOENT != errno ) {
1215                         error("opening %s: %s", config_filename,
1216                               strerror(errno));
1217                         ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1218                         goto out_free;
1219                 }
1220                 /* if nothing to unset, error out */
1221                 if (value == NULL) {
1222                         ret = CONFIG_NOTHING_SET;
1223                         goto out_free;
1224                 }
1226                 store.key = (char *)key;
1227                 if (!store_write_section(fd, key) ||
1228                     !store_write_pair(fd, key, value))
1229                         goto write_err_out;
1230         } else {
1231                 struct stat st;
1232                 char *contents;
1233                 size_t contents_sz, copy_begin, copy_end;
1234                 int i, new_line = 0;
1236                 if (value_regex == NULL)
1237                         store.value_regex = NULL;
1238                 else {
1239                         if (value_regex[0] == '!') {
1240                                 store.do_not_match = 1;
1241                                 value_regex++;
1242                         } else
1243                                 store.do_not_match = 0;
1245                         store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1246                         if (regcomp(store.value_regex, value_regex,
1247                                         REG_EXTENDED)) {
1248                                 error("invalid pattern: %s", value_regex);
1249                                 free(store.value_regex);
1250                                 ret = CONFIG_INVALID_PATTERN;
1251                                 goto out_free;
1252                         }
1253                 }
1255                 store.offset[0] = 0;
1256                 store.state = START;
1257                 store.seen = 0;
1259                 /*
1260                  * After this, store.offset will contain the *end* offset
1261                  * of the last match, or remain at 0 if no match was found.
1262                  * As a side effect, we make sure to transform only a valid
1263                  * existing config file.
1264                  */
1265                 if (git_config_from_file(store_aux, config_filename, NULL)) {
1266                         error("invalid config file %s", config_filename);
1267                         free(store.key);
1268                         if (store.value_regex != NULL) {
1269                                 regfree(store.value_regex);
1270                                 free(store.value_regex);
1271                         }
1272                         ret = CONFIG_INVALID_FILE;
1273                         goto out_free;
1274                 }
1276                 free(store.key);
1277                 if (store.value_regex != NULL) {
1278                         regfree(store.value_regex);
1279                         free(store.value_regex);
1280                 }
1282                 /* if nothing to unset, or too many matches, error out */
1283                 if ((store.seen == 0 && value == NULL) ||
1284                                 (store.seen > 1 && multi_replace == 0)) {
1285                         ret = CONFIG_NOTHING_SET;
1286                         goto out_free;
1287                 }
1289                 fstat(in_fd, &st);
1290                 contents_sz = xsize_t(st.st_size);
1291                 contents = xmmap(NULL, contents_sz, PROT_READ,
1292                         MAP_PRIVATE, in_fd, 0);
1293                 close(in_fd);
1295                 if (store.seen == 0)
1296                         store.seen = 1;
1298                 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1299                         if (store.offset[i] == 0) {
1300                                 store.offset[i] = copy_end = contents_sz;
1301                         } else if (store.state != KEY_SEEN) {
1302                                 copy_end = store.offset[i];
1303                         } else
1304                                 copy_end = find_beginning_of_line(
1305                                         contents, contents_sz,
1306                                         store.offset[i]-2, &new_line);
1308                         if (copy_end > 0 && contents[copy_end-1] != '\n')
1309                                 new_line = 1;
1311                         /* write the first part of the config */
1312                         if (copy_end > copy_begin) {
1313                                 if (write_in_full(fd, contents + copy_begin,
1314                                                   copy_end - copy_begin) <
1315                                     copy_end - copy_begin)
1316                                         goto write_err_out;
1317                                 if (new_line &&
1318                                     write_str_in_full(fd, "\n") != 1)
1319                                         goto write_err_out;
1320                         }
1321                         copy_begin = store.offset[i];
1322                 }
1324                 /* write the pair (value == NULL means unset) */
1325                 if (value != NULL) {
1326                         if (store.state == START) {
1327                                 if (!store_write_section(fd, key))
1328                                         goto write_err_out;
1329                         }
1330                         if (!store_write_pair(fd, key, value))
1331                                 goto write_err_out;
1332                 }
1334                 /* write the rest of the config */
1335                 if (copy_begin < contents_sz)
1336                         if (write_in_full(fd, contents + copy_begin,
1337                                           contents_sz - copy_begin) <
1338                             contents_sz - copy_begin)
1339                                 goto write_err_out;
1341                 munmap(contents, contents_sz);
1342         }
1344         if (commit_lock_file(lock) < 0) {
1345                 error("could not commit config file %s", config_filename);
1346                 ret = CONFIG_NO_WRITE;
1347                 goto out_free;
1348         }
1350         /*
1351          * lock is committed, so don't try to roll it back below.
1352          * NOTE: Since lockfile.c keeps a linked list of all created
1353          * lock_file structures, it isn't safe to free(lock).  It's
1354          * better to just leave it hanging around.
1355          */
1356         lock = NULL;
1357         ret = 0;
1359 out_free:
1360         if (lock)
1361                 rollback_lock_file(lock);
1362         free(config_filename);
1363         return ret;
1365 write_err_out:
1366         ret = write_error(lock->filename);
1367         goto out_free;
1371 static int section_name_match (const char *buf, const char *name)
1373         int i = 0, j = 0, dot = 0;
1374         if (buf[i] != '[')
1375                 return 0;
1376         for (i = 1; buf[i] && buf[i] != ']'; i++) {
1377                 if (!dot && isspace(buf[i])) {
1378                         dot = 1;
1379                         if (name[j++] != '.')
1380                                 break;
1381                         for (i++; isspace(buf[i]); i++)
1382                                 ; /* do nothing */
1383                         if (buf[i] != '"')
1384                                 break;
1385                         continue;
1386                 }
1387                 if (buf[i] == '\\' && dot)
1388                         i++;
1389                 else if (buf[i] == '"' && dot) {
1390                         for (i++; isspace(buf[i]); i++)
1391                                 ; /* do_nothing */
1392                         break;
1393                 }
1394                 if (buf[i] != name[j++])
1395                         break;
1396         }
1397         if (buf[i] == ']' && name[j] == 0) {
1398                 /*
1399                  * We match, now just find the right length offset by
1400                  * gobbling up any whitespace after it, as well
1401                  */
1402                 i++;
1403                 for (; buf[i] && isspace(buf[i]); i++)
1404                         ; /* do nothing */
1405                 return i;
1406         }
1407         return 0;
1410 /* if new_name == NULL, the section is removed instead */
1411 int git_config_rename_section(const char *old_name, const char *new_name)
1413         int ret = 0, remove = 0;
1414         char *config_filename;
1415         struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1416         int out_fd;
1417         char buf[1024];
1419         if (config_exclusive_filename)
1420                 config_filename = xstrdup(config_exclusive_filename);
1421         else
1422                 config_filename = git_pathdup("config");
1423         out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1424         if (out_fd < 0) {
1425                 ret = error("could not lock config file %s", config_filename);
1426                 goto out;
1427         }
1429         if (!(config_file = fopen(config_filename, "rb"))) {
1430                 /* no config file means nothing to rename, no error */
1431                 goto unlock_and_out;
1432         }
1434         while (fgets(buf, sizeof(buf), config_file)) {
1435                 int i;
1436                 int length;
1437                 char *output = buf;
1438                 for (i = 0; buf[i] && isspace(buf[i]); i++)
1439                         ; /* do nothing */
1440                 if (buf[i] == '[') {
1441                         /* it's a section */
1442                         int offset = section_name_match(&buf[i], old_name);
1443                         if (offset > 0) {
1444                                 ret++;
1445                                 if (new_name == NULL) {
1446                                         remove = 1;
1447                                         continue;
1448                                 }
1449                                 store.baselen = strlen(new_name);
1450                                 if (!store_write_section(out_fd, new_name)) {
1451                                         ret = write_error(lock->filename);
1452                                         goto out;
1453                                 }
1454                                 /*
1455                                  * We wrote out the new section, with
1456                                  * a newline, now skip the old
1457                                  * section's length
1458                                  */
1459                                 output += offset + i;
1460                                 if (strlen(output) > 0) {
1461                                         /*
1462                                          * More content means there's
1463                                          * a declaration to put on the
1464                                          * next line; indent with a
1465                                          * tab
1466                                          */
1467                                         output -= 1;
1468                                         output[0] = '\t';
1469                                 }
1470                         }
1471                         remove = 0;
1472                 }
1473                 if (remove)
1474                         continue;
1475                 length = strlen(output);
1476                 if (write_in_full(out_fd, output, length) != length) {
1477                         ret = write_error(lock->filename);
1478                         goto out;
1479                 }
1480         }
1481         fclose(config_file);
1482 unlock_and_out:
1483         if (commit_lock_file(lock) < 0)
1484                 ret = error("could not commit config file %s", config_filename);
1485 out:
1486         free(config_filename);
1487         return ret;
1490 /*
1491  * Call this to report error for your variable that should not
1492  * get a boolean value (i.e. "[my] var" means "true").
1493  */
1494 int config_error_nonbool(const char *var)
1496         return error("Missing value for '%s'", var);