Code

i18n: add infrastructure for translating Git with gettext
[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 typedef struct config_file {
16         struct config_file *prev;
17         FILE *f;
18         const char *name;
19         int linenr;
20         int eof;
21         struct strbuf value;
22         char var[MAXNAME];
23 } config_file;
25 static config_file *cf;
27 static int zlib_compression_seen;
29 const char *config_exclusive_filename = NULL;
31 static void lowercase(char *p)
32 {
33         for (; *p; p++)
34                 *p = tolower(*p);
35 }
37 void git_config_push_parameter(const char *text)
38 {
39         struct strbuf env = STRBUF_INIT;
40         const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
41         if (old) {
42                 strbuf_addstr(&env, old);
43                 strbuf_addch(&env, ' ');
44         }
45         sq_quote_buf(&env, text);
46         setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
47         strbuf_release(&env);
48 }
50 int git_config_parse_parameter(const char *text,
51                                config_fn_t fn, void *data)
52 {
53         struct strbuf **pair;
54         pair = strbuf_split_str(text, '=', 2);
55         if (!pair[0])
56                 return error("bogus config parameter: %s", text);
57         if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
58                 strbuf_setlen(pair[0], pair[0]->len - 1);
59         strbuf_trim(pair[0]);
60         if (!pair[0]->len) {
61                 strbuf_list_free(pair);
62                 return error("bogus config parameter: %s", text);
63         }
64         lowercase(pair[0]->buf);
65         if (fn(pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
66                 strbuf_list_free(pair);
67                 return -1;
68         }
69         strbuf_list_free(pair);
70         return 0;
71 }
73 int git_config_from_parameters(config_fn_t fn, void *data)
74 {
75         const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
76         char *envw;
77         const char **argv = NULL;
78         int nr = 0, alloc = 0;
79         int i;
81         if (!env)
82                 return 0;
83         /* sq_dequote will write over it */
84         envw = xstrdup(env);
86         if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
87                 free(envw);
88                 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
89         }
91         for (i = 0; i < nr; i++) {
92                 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
93                         free(argv);
94                         free(envw);
95                         return -1;
96                 }
97         }
99         free(argv);
100         free(envw);
101         return nr > 0;
104 static int get_next_char(void)
106         int c;
107         FILE *f;
109         c = '\n';
110         if (cf && ((f = cf->f) != NULL)) {
111                 c = fgetc(f);
112                 if (c == '\r') {
113                         /* DOS like systems */
114                         c = fgetc(f);
115                         if (c != '\n') {
116                                 ungetc(c, f);
117                                 c = '\r';
118                         }
119                 }
120                 if (c == '\n')
121                         cf->linenr++;
122                 if (c == EOF) {
123                         cf->eof = 1;
124                         c = '\n';
125                 }
126         }
127         return c;
130 static char *parse_value(void)
132         int quote = 0, comment = 0, space = 0;
134         strbuf_reset(&cf->value);
135         for (;;) {
136                 int c = get_next_char();
137                 if (c == '\n') {
138                         if (quote)
139                                 return NULL;
140                         return cf->value.buf;
141                 }
142                 if (comment)
143                         continue;
144                 if (isspace(c) && !quote) {
145                         if (cf->value.len)
146                                 space++;
147                         continue;
148                 }
149                 if (!quote) {
150                         if (c == ';' || c == '#') {
151                                 comment = 1;
152                                 continue;
153                         }
154                 }
155                 for (; space; space--)
156                         strbuf_addch(&cf->value, ' ');
157                 if (c == '\\') {
158                         c = get_next_char();
159                         switch (c) {
160                         case '\n':
161                                 continue;
162                         case 't':
163                                 c = '\t';
164                                 break;
165                         case 'b':
166                                 c = '\b';
167                                 break;
168                         case 'n':
169                                 c = '\n';
170                                 break;
171                         /* Some characters escape as themselves */
172                         case '\\': case '"':
173                                 break;
174                         /* Reject unknown escape sequences */
175                         default:
176                                 return NULL;
177                         }
178                         strbuf_addch(&cf->value, c);
179                         continue;
180                 }
181                 if (c == '"') {
182                         quote = 1-quote;
183                         continue;
184                 }
185                 strbuf_addch(&cf->value, c);
186         }
189 static inline int iskeychar(int c)
191         return isalnum(c) || c == '-';
194 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
196         int c;
197         char *value;
199         /* Get the full name */
200         for (;;) {
201                 c = get_next_char();
202                 if (cf->eof)
203                         break;
204                 if (!iskeychar(c))
205                         break;
206                 name[len++] = tolower(c);
207                 if (len >= MAXNAME)
208                         return -1;
209         }
210         name[len] = 0;
211         while (c == ' ' || c == '\t')
212                 c = get_next_char();
214         value = NULL;
215         if (c != '\n') {
216                 if (c != '=')
217                         return -1;
218                 value = parse_value();
219                 if (!value)
220                         return -1;
221         }
222         return fn(name, value, data);
225 static int get_extended_base_var(char *name, int baselen, int c)
227         do {
228                 if (c == '\n')
229                         return -1;
230                 c = get_next_char();
231         } while (isspace(c));
233         /* We require the format to be '[base "extension"]' */
234         if (c != '"')
235                 return -1;
236         name[baselen++] = '.';
238         for (;;) {
239                 int c = get_next_char();
240                 if (c == '\n')
241                         return -1;
242                 if (c == '"')
243                         break;
244                 if (c == '\\') {
245                         c = get_next_char();
246                         if (c == '\n')
247                                 return -1;
248                 }
249                 name[baselen++] = c;
250                 if (baselen > MAXNAME / 2)
251                         return -1;
252         }
254         /* Final ']' */
255         if (get_next_char() != ']')
256                 return -1;
257         return baselen;
260 static int get_base_var(char *name)
262         int baselen = 0;
264         for (;;) {
265                 int c = get_next_char();
266                 if (cf->eof)
267                         return -1;
268                 if (c == ']')
269                         return baselen;
270                 if (isspace(c))
271                         return get_extended_base_var(name, baselen, c);
272                 if (!iskeychar(c) && c != '.')
273                         return -1;
274                 if (baselen > MAXNAME / 2)
275                         return -1;
276                 name[baselen++] = tolower(c);
277         }
280 static int git_parse_file(config_fn_t fn, void *data)
282         int comment = 0;
283         int baselen = 0;
284         char *var = cf->var;
286         /* U+FEFF Byte Order Mark in UTF8 */
287         static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
288         const unsigned char *bomptr = utf8_bom;
290         for (;;) {
291                 int c = get_next_char();
292                 if (bomptr && *bomptr) {
293                         /* We are at the file beginning; skip UTF8-encoded BOM
294                          * if present. Sane editors won't put this in on their
295                          * own, but e.g. Windows Notepad will do it happily. */
296                         if ((unsigned char) c == *bomptr) {
297                                 bomptr++;
298                                 continue;
299                         } else {
300                                 /* Do not tolerate partial BOM. */
301                                 if (bomptr != utf8_bom)
302                                         break;
303                                 /* No BOM at file beginning. Cool. */
304                                 bomptr = NULL;
305                         }
306                 }
307                 if (c == '\n') {
308                         if (cf->eof)
309                                 return 0;
310                         comment = 0;
311                         continue;
312                 }
313                 if (comment || isspace(c))
314                         continue;
315                 if (c == '#' || c == ';') {
316                         comment = 1;
317                         continue;
318                 }
319                 if (c == '[') {
320                         baselen = get_base_var(var);
321                         if (baselen <= 0)
322                                 break;
323                         var[baselen++] = '.';
324                         var[baselen] = 0;
325                         continue;
326                 }
327                 if (!isalpha(c))
328                         break;
329                 var[baselen] = tolower(c);
330                 if (get_value(fn, data, var, baselen+1) < 0)
331                         break;
332         }
333         die("bad config file line %d in %s", cf->linenr, cf->name);
336 static int parse_unit_factor(const char *end, unsigned long *val)
338         if (!*end)
339                 return 1;
340         else if (!strcasecmp(end, "k")) {
341                 *val *= 1024;
342                 return 1;
343         }
344         else if (!strcasecmp(end, "m")) {
345                 *val *= 1024 * 1024;
346                 return 1;
347         }
348         else if (!strcasecmp(end, "g")) {
349                 *val *= 1024 * 1024 * 1024;
350                 return 1;
351         }
352         return 0;
355 static int git_parse_long(const char *value, long *ret)
357         if (value && *value) {
358                 char *end;
359                 long val = strtol(value, &end, 0);
360                 unsigned long factor = 1;
361                 if (!parse_unit_factor(end, &factor))
362                         return 0;
363                 *ret = val * factor;
364                 return 1;
365         }
366         return 0;
369 int git_parse_ulong(const char *value, unsigned long *ret)
371         if (value && *value) {
372                 char *end;
373                 unsigned long val = strtoul(value, &end, 0);
374                 if (!parse_unit_factor(end, &val))
375                         return 0;
376                 *ret = val;
377                 return 1;
378         }
379         return 0;
382 static void die_bad_config(const char *name)
384         if (cf && cf->name)
385                 die("bad config value for '%s' in %s", name, cf->name);
386         die("bad config value for '%s'", name);
389 int git_config_int(const char *name, const char *value)
391         long ret = 0;
392         if (!git_parse_long(value, &ret))
393                 die_bad_config(name);
394         return ret;
397 unsigned long git_config_ulong(const char *name, const char *value)
399         unsigned long ret;
400         if (!git_parse_ulong(value, &ret))
401                 die_bad_config(name);
402         return ret;
405 static int git_config_maybe_bool_text(const char *name, const char *value)
407         if (!value)
408                 return 1;
409         if (!*value)
410                 return 0;
411         if (!strcasecmp(value, "true")
412             || !strcasecmp(value, "yes")
413             || !strcasecmp(value, "on"))
414                 return 1;
415         if (!strcasecmp(value, "false")
416             || !strcasecmp(value, "no")
417             || !strcasecmp(value, "off"))
418                 return 0;
419         return -1;
422 int git_config_maybe_bool(const char *name, const char *value)
424         long v = git_config_maybe_bool_text(name, value);
425         if (0 <= v)
426                 return v;
427         if (git_parse_long(value, &v))
428                 return !!v;
429         return -1;
432 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
434         int v = git_config_maybe_bool_text(name, value);
435         if (0 <= v) {
436                 *is_bool = 1;
437                 return v;
438         }
439         *is_bool = 0;
440         return git_config_int(name, value);
443 int git_config_bool(const char *name, const char *value)
445         int discard;
446         return !!git_config_bool_or_int(name, value, &discard);
449 int git_config_string(const char **dest, const char *var, const char *value)
451         if (!value)
452                 return config_error_nonbool(var);
453         *dest = xstrdup(value);
454         return 0;
457 int git_config_pathname(const char **dest, const char *var, const char *value)
459         if (!value)
460                 return config_error_nonbool(var);
461         *dest = expand_user_path(value);
462         if (!*dest)
463                 die("Failed to expand user dir in: '%s'", value);
464         return 0;
467 static int git_default_core_config(const char *var, const char *value)
469         /* This needs a better name */
470         if (!strcmp(var, "core.filemode")) {
471                 trust_executable_bit = git_config_bool(var, value);
472                 return 0;
473         }
474         if (!strcmp(var, "core.trustctime")) {
475                 trust_ctime = git_config_bool(var, value);
476                 return 0;
477         }
479         if (!strcmp(var, "core.quotepath")) {
480                 quote_path_fully = git_config_bool(var, value);
481                 return 0;
482         }
484         if (!strcmp(var, "core.symlinks")) {
485                 has_symlinks = git_config_bool(var, value);
486                 return 0;
487         }
489         if (!strcmp(var, "core.ignorecase")) {
490                 ignore_case = git_config_bool(var, value);
491                 return 0;
492         }
494         if (!strcmp(var, "core.attributesfile"))
495                 return git_config_pathname(&git_attributes_file, var, value);
497         if (!strcmp(var, "core.bare")) {
498                 is_bare_repository_cfg = git_config_bool(var, value);
499                 return 0;
500         }
502         if (!strcmp(var, "core.ignorestat")) {
503                 assume_unchanged = git_config_bool(var, value);
504                 return 0;
505         }
507         if (!strcmp(var, "core.prefersymlinkrefs")) {
508                 prefer_symlink_refs = git_config_bool(var, value);
509                 return 0;
510         }
512         if (!strcmp(var, "core.logallrefupdates")) {
513                 log_all_ref_updates = git_config_bool(var, value);
514                 return 0;
515         }
517         if (!strcmp(var, "core.warnambiguousrefs")) {
518                 warn_ambiguous_refs = git_config_bool(var, value);
519                 return 0;
520         }
522         if (!strcmp(var, "core.abbrev")) {
523                 int abbrev = git_config_int(var, value);
524                 if (abbrev < minimum_abbrev || abbrev > 40)
525                         return -1;
526                 default_abbrev = abbrev;
527                 return 0;
528         }
530         if (!strcmp(var, "core.loosecompression")) {
531                 int level = git_config_int(var, value);
532                 if (level == -1)
533                         level = Z_DEFAULT_COMPRESSION;
534                 else if (level < 0 || level > Z_BEST_COMPRESSION)
535                         die("bad zlib compression level %d", level);
536                 zlib_compression_level = level;
537                 zlib_compression_seen = 1;
538                 return 0;
539         }
541         if (!strcmp(var, "core.compression")) {
542                 int level = git_config_int(var, value);
543                 if (level == -1)
544                         level = Z_DEFAULT_COMPRESSION;
545                 else if (level < 0 || level > Z_BEST_COMPRESSION)
546                         die("bad zlib compression level %d", level);
547                 core_compression_level = level;
548                 core_compression_seen = 1;
549                 if (!zlib_compression_seen)
550                         zlib_compression_level = level;
551                 return 0;
552         }
554         if (!strcmp(var, "core.packedgitwindowsize")) {
555                 int pgsz_x2 = getpagesize() * 2;
556                 packed_git_window_size = git_config_int(var, value);
558                 /* This value must be multiple of (pagesize * 2) */
559                 packed_git_window_size /= pgsz_x2;
560                 if (packed_git_window_size < 1)
561                         packed_git_window_size = 1;
562                 packed_git_window_size *= pgsz_x2;
563                 return 0;
564         }
566         if (!strcmp(var, "core.bigfilethreshold")) {
567                 long n = git_config_int(var, value);
568                 big_file_threshold = 0 < n ? n : 0;
569                 return 0;
570         }
572         if (!strcmp(var, "core.packedgitlimit")) {
573                 packed_git_limit = git_config_int(var, value);
574                 return 0;
575         }
577         if (!strcmp(var, "core.deltabasecachelimit")) {
578                 delta_base_cache_limit = git_config_int(var, value);
579                 return 0;
580         }
582         if (!strcmp(var, "core.logpackaccess"))
583                 return git_config_string(&log_pack_access, var, value);
585         if (!strcmp(var, "core.autocrlf")) {
586                 if (value && !strcasecmp(value, "input")) {
587                         if (core_eol == EOL_CRLF)
588                                 return error("core.autocrlf=input conflicts with core.eol=crlf");
589                         auto_crlf = AUTO_CRLF_INPUT;
590                         return 0;
591                 }
592                 auto_crlf = git_config_bool(var, value);
593                 return 0;
594         }
596         if (!strcmp(var, "core.safecrlf")) {
597                 if (value && !strcasecmp(value, "warn")) {
598                         safe_crlf = SAFE_CRLF_WARN;
599                         return 0;
600                 }
601                 safe_crlf = git_config_bool(var, value);
602                 return 0;
603         }
605         if (!strcmp(var, "core.eol")) {
606                 if (value && !strcasecmp(value, "lf"))
607                         core_eol = EOL_LF;
608                 else if (value && !strcasecmp(value, "crlf"))
609                         core_eol = EOL_CRLF;
610                 else if (value && !strcasecmp(value, "native"))
611                         core_eol = EOL_NATIVE;
612                 else
613                         core_eol = EOL_UNSET;
614                 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
615                         return error("core.autocrlf=input conflicts with core.eol=crlf");
616                 return 0;
617         }
619         if (!strcmp(var, "core.notesref")) {
620                 notes_ref_name = xstrdup(value);
621                 return 0;
622         }
624         if (!strcmp(var, "core.pager"))
625                 return git_config_string(&pager_program, var, value);
627         if (!strcmp(var, "core.editor"))
628                 return git_config_string(&editor_program, var, value);
630         if (!strcmp(var, "core.askpass"))
631                 return git_config_string(&askpass_program, var, value);
633         if (!strcmp(var, "core.excludesfile"))
634                 return git_config_pathname(&excludes_file, var, value);
636         if (!strcmp(var, "core.whitespace")) {
637                 if (!value)
638                         return config_error_nonbool(var);
639                 whitespace_rule_cfg = parse_whitespace_rule(value);
640                 return 0;
641         }
643         if (!strcmp(var, "core.fsyncobjectfiles")) {
644                 fsync_object_files = git_config_bool(var, value);
645                 return 0;
646         }
648         if (!strcmp(var, "core.preloadindex")) {
649                 core_preload_index = git_config_bool(var, value);
650                 return 0;
651         }
653         if (!strcmp(var, "core.createobject")) {
654                 if (!strcmp(value, "rename"))
655                         object_creation_mode = OBJECT_CREATION_USES_RENAMES;
656                 else if (!strcmp(value, "link"))
657                         object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
658                 else
659                         die("Invalid mode for object creation: %s", value);
660                 return 0;
661         }
663         if (!strcmp(var, "core.sparsecheckout")) {
664                 core_apply_sparse_checkout = git_config_bool(var, value);
665                 return 0;
666         }
668         /* Add other config variables here and to Documentation/config.txt. */
669         return 0;
672 static int git_default_user_config(const char *var, const char *value)
674         if (!strcmp(var, "user.name")) {
675                 if (!value)
676                         return config_error_nonbool(var);
677                 strlcpy(git_default_name, value, sizeof(git_default_name));
678                 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
679                 return 0;
680         }
682         if (!strcmp(var, "user.email")) {
683                 if (!value)
684                         return config_error_nonbool(var);
685                 strlcpy(git_default_email, value, sizeof(git_default_email));
686                 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
687                 return 0;
688         }
690         /* Add other config variables here and to Documentation/config.txt. */
691         return 0;
694 static int git_default_i18n_config(const char *var, const char *value)
696         if (!strcmp(var, "i18n.commitencoding"))
697                 return git_config_string(&git_commit_encoding, var, value);
699         if (!strcmp(var, "i18n.logoutputencoding"))
700                 return git_config_string(&git_log_output_encoding, var, value);
702         /* Add other config variables here and to Documentation/config.txt. */
703         return 0;
706 static int git_default_branch_config(const char *var, const char *value)
708         if (!strcmp(var, "branch.autosetupmerge")) {
709                 if (value && !strcasecmp(value, "always")) {
710                         git_branch_track = BRANCH_TRACK_ALWAYS;
711                         return 0;
712                 }
713                 git_branch_track = git_config_bool(var, value);
714                 return 0;
715         }
716         if (!strcmp(var, "branch.autosetuprebase")) {
717                 if (!value)
718                         return config_error_nonbool(var);
719                 else if (!strcmp(value, "never"))
720                         autorebase = AUTOREBASE_NEVER;
721                 else if (!strcmp(value, "local"))
722                         autorebase = AUTOREBASE_LOCAL;
723                 else if (!strcmp(value, "remote"))
724                         autorebase = AUTOREBASE_REMOTE;
725                 else if (!strcmp(value, "always"))
726                         autorebase = AUTOREBASE_ALWAYS;
727                 else
728                         return error("Malformed value for %s", var);
729                 return 0;
730         }
732         /* Add other config variables here and to Documentation/config.txt. */
733         return 0;
736 static int git_default_push_config(const char *var, const char *value)
738         if (!strcmp(var, "push.default")) {
739                 if (!value)
740                         return config_error_nonbool(var);
741                 else if (!strcmp(value, "nothing"))
742                         push_default = PUSH_DEFAULT_NOTHING;
743                 else if (!strcmp(value, "matching"))
744                         push_default = PUSH_DEFAULT_MATCHING;
745                 else if (!strcmp(value, "upstream"))
746                         push_default = PUSH_DEFAULT_UPSTREAM;
747                 else if (!strcmp(value, "tracking")) /* deprecated */
748                         push_default = PUSH_DEFAULT_UPSTREAM;
749                 else if (!strcmp(value, "current"))
750                         push_default = PUSH_DEFAULT_CURRENT;
751                 else {
752                         error("Malformed value for %s: %s", var, value);
753                         return error("Must be one of nothing, matching, "
754                                      "tracking or current.");
755                 }
756                 return 0;
757         }
759         /* Add other config variables here and to Documentation/config.txt. */
760         return 0;
763 static int git_default_mailmap_config(const char *var, const char *value)
765         if (!strcmp(var, "mailmap.file"))
766                 return git_config_string(&git_mailmap_file, var, value);
768         /* Add other config variables here and to Documentation/config.txt. */
769         return 0;
772 int git_default_config(const char *var, const char *value, void *dummy)
774         if (!prefixcmp(var, "core."))
775                 return git_default_core_config(var, value);
777         if (!prefixcmp(var, "user."))
778                 return git_default_user_config(var, value);
780         if (!prefixcmp(var, "i18n."))
781                 return git_default_i18n_config(var, value);
783         if (!prefixcmp(var, "branch."))
784                 return git_default_branch_config(var, value);
786         if (!prefixcmp(var, "push."))
787                 return git_default_push_config(var, value);
789         if (!prefixcmp(var, "mailmap."))
790                 return git_default_mailmap_config(var, value);
792         if (!prefixcmp(var, "advice."))
793                 return git_default_advice_config(var, value);
795         if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
796                 pager_use_color = git_config_bool(var,value);
797                 return 0;
798         }
800         /* Add other config variables here and to Documentation/config.txt. */
801         return 0;
804 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
806         int ret;
807         FILE *f = fopen(filename, "r");
809         ret = -1;
810         if (f) {
811                 config_file top;
813                 /* push config-file parsing state stack */
814                 top.prev = cf;
815                 top.f = f;
816                 top.name = filename;
817                 top.linenr = 1;
818                 top.eof = 0;
819                 strbuf_init(&top.value, 1024);
820                 cf = &top;
822                 ret = git_parse_file(fn, data);
824                 /* pop config-file parsing state stack */
825                 strbuf_release(&top.value);
826                 cf = top.prev;
828                 fclose(f);
829         }
830         return ret;
833 const char *git_etc_gitconfig(void)
835         static const char *system_wide;
836         if (!system_wide)
837                 system_wide = system_path(ETC_GITCONFIG);
838         return system_wide;
841 int git_env_bool(const char *k, int def)
843         const char *v = getenv(k);
844         return v ? git_config_bool(k, v) : def;
847 int git_config_system(void)
849         return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
852 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
854         int ret = 0, found = 0;
855         const char *home = NULL;
857         /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
858         if (config_exclusive_filename)
859                 return git_config_from_file(fn, config_exclusive_filename, data);
860         if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
861                 ret += git_config_from_file(fn, git_etc_gitconfig(),
862                                             data);
863                 found += 1;
864         }
866         home = getenv("HOME");
867         if (home) {
868                 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
869                 if (!access(user_config, R_OK)) {
870                         ret += git_config_from_file(fn, user_config, data);
871                         found += 1;
872                 }
873                 free(user_config);
874         }
876         if (repo_config && !access(repo_config, R_OK)) {
877                 ret += git_config_from_file(fn, repo_config, data);
878                 found += 1;
879         }
881         switch (git_config_from_parameters(fn, data)) {
882         case -1: /* error */
883                 die("unable to parse command-line config");
884                 break;
885         case 0: /* found nothing */
886                 break;
887         default: /* found at least one item */
888                 found++;
889                 break;
890         }
892         return ret == 0 ? found : ret;
895 int git_config(config_fn_t fn, void *data)
897         char *repo_config = NULL;
898         int ret;
900         repo_config = git_pathdup("config");
901         ret = git_config_early(fn, data, repo_config);
902         if (repo_config)
903                 free(repo_config);
904         return ret;
907 /*
908  * Find all the stuff for git_config_set() below.
909  */
911 #define MAX_MATCHES 512
913 static struct {
914         int baselen;
915         char *key;
916         int do_not_match;
917         regex_t *value_regex;
918         int multi_replace;
919         size_t offset[MAX_MATCHES];
920         enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
921         int seen;
922 } store;
924 static int matches(const char *key, const char *value)
926         return !strcmp(key, store.key) &&
927                 (store.value_regex == NULL ||
928                  (store.do_not_match ^
929                   !regexec(store.value_regex, value, 0, NULL, 0)));
932 static int store_aux(const char *key, const char *value, void *cb)
934         const char *ep;
935         size_t section_len;
936         FILE *f = cf->f;
938         switch (store.state) {
939         case KEY_SEEN:
940                 if (matches(key, value)) {
941                         if (store.seen == 1 && store.multi_replace == 0) {
942                                 warning("%s has multiple values", key);
943                         } else if (store.seen >= MAX_MATCHES) {
944                                 error("too many matches for %s", key);
945                                 return 1;
946                         }
948                         store.offset[store.seen] = ftell(f);
949                         store.seen++;
950                 }
951                 break;
952         case SECTION_SEEN:
953                 /*
954                  * What we are looking for is in store.key (both
955                  * section and var), and its section part is baselen
956                  * long.  We found key (again, both section and var).
957                  * We would want to know if this key is in the same
958                  * section as what we are looking for.  We already
959                  * know we are in the same section as what should
960                  * hold store.key.
961                  */
962                 ep = strrchr(key, '.');
963                 section_len = ep - key;
965                 if ((section_len != store.baselen) ||
966                     memcmp(key, store.key, section_len+1)) {
967                         store.state = SECTION_END_SEEN;
968                         break;
969                 }
971                 /*
972                  * Do not increment matches: this is no match, but we
973                  * just made sure we are in the desired section.
974                  */
975                 store.offset[store.seen] = ftell(f);
976                 /* fallthru */
977         case SECTION_END_SEEN:
978         case START:
979                 if (matches(key, value)) {
980                         store.offset[store.seen] = ftell(f);
981                         store.state = KEY_SEEN;
982                         store.seen++;
983                 } else {
984                         if (strrchr(key, '.') - key == store.baselen &&
985                               !strncmp(key, store.key, store.baselen)) {
986                                         store.state = SECTION_SEEN;
987                                         store.offset[store.seen] = ftell(f);
988                         }
989                 }
990         }
991         return 0;
994 static int write_error(const char *filename)
996         error("failed to write new configuration file %s", filename);
998         /* Same error code as "failed to rename". */
999         return 4;
1002 static int store_write_section(int fd, const char *key)
1004         const char *dot;
1005         int i, success;
1006         struct strbuf sb = STRBUF_INIT;
1008         dot = memchr(key, '.', store.baselen);
1009         if (dot) {
1010                 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1011                 for (i = dot - key + 1; i < store.baselen; i++) {
1012                         if (key[i] == '"' || key[i] == '\\')
1013                                 strbuf_addch(&sb, '\\');
1014                         strbuf_addch(&sb, key[i]);
1015                 }
1016                 strbuf_addstr(&sb, "\"]\n");
1017         } else {
1018                 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1019         }
1021         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1022         strbuf_release(&sb);
1024         return success;
1027 static int store_write_pair(int fd, const char *key, const char *value)
1029         int i, success;
1030         int length = strlen(key + store.baselen + 1);
1031         const char *quote = "";
1032         struct strbuf sb = STRBUF_INIT;
1034         /*
1035          * Check to see if the value needs to be surrounded with a dq pair.
1036          * Note that problematic characters are always backslash-quoted; this
1037          * check is about not losing leading or trailing SP and strings that
1038          * follow beginning-of-comment characters (i.e. ';' and '#') by the
1039          * configuration parser.
1040          */
1041         if (value[0] == ' ')
1042                 quote = "\"";
1043         for (i = 0; value[i]; i++)
1044                 if (value[i] == ';' || value[i] == '#')
1045                         quote = "\"";
1046         if (i && value[i - 1] == ' ')
1047                 quote = "\"";
1049         strbuf_addf(&sb, "\t%.*s = %s",
1050                     length, key + store.baselen + 1, quote);
1052         for (i = 0; value[i]; i++)
1053                 switch (value[i]) {
1054                 case '\n':
1055                         strbuf_addstr(&sb, "\\n");
1056                         break;
1057                 case '\t':
1058                         strbuf_addstr(&sb, "\\t");
1059                         break;
1060                 case '"':
1061                 case '\\':
1062                         strbuf_addch(&sb, '\\');
1063                 default:
1064                         strbuf_addch(&sb, value[i]);
1065                         break;
1066                 }
1067         strbuf_addf(&sb, "%s\n", quote);
1069         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1070         strbuf_release(&sb);
1072         return success;
1075 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1076         size_t offset_, int *found_bracket)
1078         size_t equal_offset = size, bracket_offset = size;
1079         ssize_t offset;
1081 contline:
1082         for (offset = offset_-2; offset > 0
1083                         && contents[offset] != '\n'; offset--)
1084                 switch (contents[offset]) {
1085                         case '=': equal_offset = offset; break;
1086                         case ']': bracket_offset = offset; break;
1087                 }
1088         if (offset > 0 && contents[offset-1] == '\\') {
1089                 offset_ = offset;
1090                 goto contline;
1091         }
1092         if (bracket_offset < equal_offset) {
1093                 *found_bracket = 1;
1094                 offset = bracket_offset+1;
1095         } else
1096                 offset++;
1098         return offset;
1101 int git_config_set_in_file(const char *config_filename,
1102                         const char *key, const char *value)
1104         return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1107 int git_config_set(const char *key, const char *value)
1109         return git_config_set_multivar(key, value, NULL, 0);
1112 /*
1113  * Auxiliary function to sanity-check and split the key into the section
1114  * identifier and variable name.
1115  *
1116  * Returns 0 on success, -1 when there is an invalid character in the key and
1117  * -2 if there is no section name in the key.
1118  *
1119  * store_key - pointer to char* which will hold a copy of the key with
1120  *             lowercase section and variable name
1121  * baselen - pointer to int which will hold the length of the
1122  *           section + subsection part, can be NULL
1123  */
1124 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1126         int i, dot, baselen;
1127         const char *last_dot = strrchr(key, '.');
1129         /*
1130          * Since "key" actually contains the section name and the real
1131          * key name separated by a dot, we have to know where the dot is.
1132          */
1134         if (last_dot == NULL || last_dot == key) {
1135                 error("key does not contain a section: %s", key);
1136                 return -CONFIG_NO_SECTION_OR_NAME;
1137         }
1139         if (!last_dot[1]) {
1140                 error("key does not contain variable name: %s", key);
1141                 return -CONFIG_NO_SECTION_OR_NAME;
1142         }
1144         baselen = last_dot - key;
1145         if (baselen_)
1146                 *baselen_ = baselen;
1148         /*
1149          * Validate the key and while at it, lower case it for matching.
1150          */
1151         *store_key = xmalloc(strlen(key) + 1);
1153         dot = 0;
1154         for (i = 0; key[i]; i++) {
1155                 unsigned char c = key[i];
1156                 if (c == '.')
1157                         dot = 1;
1158                 /* Leave the extended basename untouched.. */
1159                 if (!dot || i > baselen) {
1160                         if (!iskeychar(c) ||
1161                             (i == baselen + 1 && !isalpha(c))) {
1162                                 error("invalid key: %s", key);
1163                                 goto out_free_ret_1;
1164                         }
1165                         c = tolower(c);
1166                 } else if (c == '\n') {
1167                         error("invalid key (newline): %s", key);
1168                         goto out_free_ret_1;
1169                 }
1170                 (*store_key)[i] = c;
1171         }
1172         (*store_key)[i] = 0;
1174         return 0;
1176 out_free_ret_1:
1177         free(*store_key);
1178         return -CONFIG_INVALID_KEY;
1181 /*
1182  * If value==NULL, unset in (remove from) config,
1183  * if value_regex!=NULL, disregard key/value pairs where value does not match.
1184  * if multi_replace==0, nothing, or only one matching key/value is replaced,
1185  *     else all matching key/values (regardless how many) are removed,
1186  *     before the new pair is written.
1187  *
1188  * Returns 0 on success.
1189  *
1190  * This function does this:
1191  *
1192  * - it locks the config file by creating ".git/config.lock"
1193  *
1194  * - it then parses the config using store_aux() as validator to find
1195  *   the position on the key/value pair to replace. If it is to be unset,
1196  *   it must be found exactly once.
1197  *
1198  * - the config file is mmap()ed and the part before the match (if any) is
1199  *   written to the lock file, then the changed part and the rest.
1200  *
1201  * - the config file is removed and the lock file rename()d to it.
1202  *
1203  */
1204 int git_config_set_multivar_in_file(const char *config_filename,
1205                                 const char *key, const char *value,
1206                                 const char *value_regex, int multi_replace)
1208         int fd = -1, in_fd;
1209         int ret;
1210         struct lock_file *lock = NULL;
1212         /* parse-key returns negative; flip the sign to feed exit(3) */
1213         ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1214         if (ret)
1215                 goto out_free;
1217         store.multi_replace = multi_replace;
1220         /*
1221          * The lock serves a purpose in addition to locking: the new
1222          * contents of .git/config will be written into it.
1223          */
1224         lock = xcalloc(sizeof(struct lock_file), 1);
1225         fd = hold_lock_file_for_update(lock, config_filename, 0);
1226         if (fd < 0) {
1227                 error("could not lock config file %s: %s", config_filename, strerror(errno));
1228                 free(store.key);
1229                 ret = CONFIG_NO_LOCK;
1230                 goto out_free;
1231         }
1233         /*
1234          * If .git/config does not exist yet, write a minimal version.
1235          */
1236         in_fd = open(config_filename, O_RDONLY);
1237         if ( in_fd < 0 ) {
1238                 free(store.key);
1240                 if ( ENOENT != errno ) {
1241                         error("opening %s: %s", config_filename,
1242                               strerror(errno));
1243                         ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1244                         goto out_free;
1245                 }
1246                 /* if nothing to unset, error out */
1247                 if (value == NULL) {
1248                         ret = CONFIG_NOTHING_SET;
1249                         goto out_free;
1250                 }
1252                 store.key = (char *)key;
1253                 if (!store_write_section(fd, key) ||
1254                     !store_write_pair(fd, key, value))
1255                         goto write_err_out;
1256         } else {
1257                 struct stat st;
1258                 char *contents;
1259                 size_t contents_sz, copy_begin, copy_end;
1260                 int i, new_line = 0;
1262                 if (value_regex == NULL)
1263                         store.value_regex = NULL;
1264                 else {
1265                         if (value_regex[0] == '!') {
1266                                 store.do_not_match = 1;
1267                                 value_regex++;
1268                         } else
1269                                 store.do_not_match = 0;
1271                         store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1272                         if (regcomp(store.value_regex, value_regex,
1273                                         REG_EXTENDED)) {
1274                                 error("invalid pattern: %s", value_regex);
1275                                 free(store.value_regex);
1276                                 ret = CONFIG_INVALID_PATTERN;
1277                                 goto out_free;
1278                         }
1279                 }
1281                 store.offset[0] = 0;
1282                 store.state = START;
1283                 store.seen = 0;
1285                 /*
1286                  * After this, store.offset will contain the *end* offset
1287                  * of the last match, or remain at 0 if no match was found.
1288                  * As a side effect, we make sure to transform only a valid
1289                  * existing config file.
1290                  */
1291                 if (git_config_from_file(store_aux, config_filename, NULL)) {
1292                         error("invalid config file %s", config_filename);
1293                         free(store.key);
1294                         if (store.value_regex != NULL) {
1295                                 regfree(store.value_regex);
1296                                 free(store.value_regex);
1297                         }
1298                         ret = CONFIG_INVALID_FILE;
1299                         goto out_free;
1300                 }
1302                 free(store.key);
1303                 if (store.value_regex != NULL) {
1304                         regfree(store.value_regex);
1305                         free(store.value_regex);
1306                 }
1308                 /* if nothing to unset, or too many matches, error out */
1309                 if ((store.seen == 0 && value == NULL) ||
1310                                 (store.seen > 1 && multi_replace == 0)) {
1311                         ret = CONFIG_NOTHING_SET;
1312                         goto out_free;
1313                 }
1315                 fstat(in_fd, &st);
1316                 contents_sz = xsize_t(st.st_size);
1317                 contents = xmmap(NULL, contents_sz, PROT_READ,
1318                         MAP_PRIVATE, in_fd, 0);
1319                 close(in_fd);
1321                 if (store.seen == 0)
1322                         store.seen = 1;
1324                 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1325                         if (store.offset[i] == 0) {
1326                                 store.offset[i] = copy_end = contents_sz;
1327                         } else if (store.state != KEY_SEEN) {
1328                                 copy_end = store.offset[i];
1329                         } else
1330                                 copy_end = find_beginning_of_line(
1331                                         contents, contents_sz,
1332                                         store.offset[i]-2, &new_line);
1334                         if (copy_end > 0 && contents[copy_end-1] != '\n')
1335                                 new_line = 1;
1337                         /* write the first part of the config */
1338                         if (copy_end > copy_begin) {
1339                                 if (write_in_full(fd, contents + copy_begin,
1340                                                   copy_end - copy_begin) <
1341                                     copy_end - copy_begin)
1342                                         goto write_err_out;
1343                                 if (new_line &&
1344                                     write_str_in_full(fd, "\n") != 1)
1345                                         goto write_err_out;
1346                         }
1347                         copy_begin = store.offset[i];
1348                 }
1350                 /* write the pair (value == NULL means unset) */
1351                 if (value != NULL) {
1352                         if (store.state == START) {
1353                                 if (!store_write_section(fd, key))
1354                                         goto write_err_out;
1355                         }
1356                         if (!store_write_pair(fd, key, value))
1357                                 goto write_err_out;
1358                 }
1360                 /* write the rest of the config */
1361                 if (copy_begin < contents_sz)
1362                         if (write_in_full(fd, contents + copy_begin,
1363                                           contents_sz - copy_begin) <
1364                             contents_sz - copy_begin)
1365                                 goto write_err_out;
1367                 munmap(contents, contents_sz);
1368         }
1370         if (commit_lock_file(lock) < 0) {
1371                 error("could not commit config file %s", config_filename);
1372                 ret = CONFIG_NO_WRITE;
1373                 goto out_free;
1374         }
1376         /*
1377          * lock is committed, so don't try to roll it back below.
1378          * NOTE: Since lockfile.c keeps a linked list of all created
1379          * lock_file structures, it isn't safe to free(lock).  It's
1380          * better to just leave it hanging around.
1381          */
1382         lock = NULL;
1383         ret = 0;
1385 out_free:
1386         if (lock)
1387                 rollback_lock_file(lock);
1388         return ret;
1390 write_err_out:
1391         ret = write_error(lock->filename);
1392         goto out_free;
1396 int git_config_set_multivar(const char *key, const char *value,
1397                         const char *value_regex, int multi_replace)
1399         const char *config_filename;
1400         char *buf = NULL;
1401         int ret;
1403         if (config_exclusive_filename)
1404                 config_filename = config_exclusive_filename;
1405         else
1406                 config_filename = buf = git_pathdup("config");
1408         ret = git_config_set_multivar_in_file(config_filename, key, value,
1409                                         value_regex, multi_replace);
1410         free(buf);
1411         return ret;
1414 static int section_name_match (const char *buf, const char *name)
1416         int i = 0, j = 0, dot = 0;
1417         if (buf[i] != '[')
1418                 return 0;
1419         for (i = 1; buf[i] && buf[i] != ']'; i++) {
1420                 if (!dot && isspace(buf[i])) {
1421                         dot = 1;
1422                         if (name[j++] != '.')
1423                                 break;
1424                         for (i++; isspace(buf[i]); i++)
1425                                 ; /* do nothing */
1426                         if (buf[i] != '"')
1427                                 break;
1428                         continue;
1429                 }
1430                 if (buf[i] == '\\' && dot)
1431                         i++;
1432                 else if (buf[i] == '"' && dot) {
1433                         for (i++; isspace(buf[i]); i++)
1434                                 ; /* do_nothing */
1435                         break;
1436                 }
1437                 if (buf[i] != name[j++])
1438                         break;
1439         }
1440         if (buf[i] == ']' && name[j] == 0) {
1441                 /*
1442                  * We match, now just find the right length offset by
1443                  * gobbling up any whitespace after it, as well
1444                  */
1445                 i++;
1446                 for (; buf[i] && isspace(buf[i]); i++)
1447                         ; /* do nothing */
1448                 return i;
1449         }
1450         return 0;
1453 /* if new_name == NULL, the section is removed instead */
1454 int git_config_rename_section(const char *old_name, const char *new_name)
1456         int ret = 0, remove = 0;
1457         char *config_filename;
1458         struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1459         int out_fd;
1460         char buf[1024];
1461         FILE *config_file;
1463         if (config_exclusive_filename)
1464                 config_filename = xstrdup(config_exclusive_filename);
1465         else
1466                 config_filename = git_pathdup("config");
1467         out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1468         if (out_fd < 0) {
1469                 ret = error("could not lock config file %s", config_filename);
1470                 goto out;
1471         }
1473         if (!(config_file = fopen(config_filename, "rb"))) {
1474                 /* no config file means nothing to rename, no error */
1475                 goto unlock_and_out;
1476         }
1478         while (fgets(buf, sizeof(buf), config_file)) {
1479                 int i;
1480                 int length;
1481                 char *output = buf;
1482                 for (i = 0; buf[i] && isspace(buf[i]); i++)
1483                         ; /* do nothing */
1484                 if (buf[i] == '[') {
1485                         /* it's a section */
1486                         int offset = section_name_match(&buf[i], old_name);
1487                         if (offset > 0) {
1488                                 ret++;
1489                                 if (new_name == NULL) {
1490                                         remove = 1;
1491                                         continue;
1492                                 }
1493                                 store.baselen = strlen(new_name);
1494                                 if (!store_write_section(out_fd, new_name)) {
1495                                         ret = write_error(lock->filename);
1496                                         goto out;
1497                                 }
1498                                 /*
1499                                  * We wrote out the new section, with
1500                                  * a newline, now skip the old
1501                                  * section's length
1502                                  */
1503                                 output += offset + i;
1504                                 if (strlen(output) > 0) {
1505                                         /*
1506                                          * More content means there's
1507                                          * a declaration to put on the
1508                                          * next line; indent with a
1509                                          * tab
1510                                          */
1511                                         output -= 1;
1512                                         output[0] = '\t';
1513                                 }
1514                         }
1515                         remove = 0;
1516                 }
1517                 if (remove)
1518                         continue;
1519                 length = strlen(output);
1520                 if (write_in_full(out_fd, output, length) != length) {
1521                         ret = write_error(lock->filename);
1522                         goto out;
1523                 }
1524         }
1525         fclose(config_file);
1526 unlock_and_out:
1527         if (commit_lock_file(lock) < 0)
1528                 ret = error("could not commit config file %s", config_filename);
1529 out:
1530         free(config_filename);
1531         return ret;
1534 /*
1535  * Call this to report error for your variable that should not
1536  * get a boolean value (i.e. "[my] var" means "true").
1537  */
1538 int config_error_nonbool(const char *var)
1540         return error("Missing value for '%s'", var);