Code

grep doc: add --break / --heading / -W to synopsis
[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, uintmax_t *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                 intmax_t val;
360                 uintmax_t uval;
361                 uintmax_t factor = 1;
363                 errno = 0;
364                 val = strtoimax(value, &end, 0);
365                 if (errno == ERANGE)
366                         return 0;
367                 if (!parse_unit_factor(end, &factor))
368                         return 0;
369                 uval = abs(val);
370                 uval *= factor;
371                 if ((uval > maximum_signed_value_of_type(long)) ||
372                     (abs(val) > uval))
373                         return 0;
374                 val *= factor;
375                 *ret = val;
376                 return 1;
377         }
378         return 0;
381 int git_parse_ulong(const char *value, unsigned long *ret)
383         if (value && *value) {
384                 char *end;
385                 uintmax_t val;
386                 uintmax_t oldval;
388                 errno = 0;
389                 val = strtoumax(value, &end, 0);
390                 if (errno == ERANGE)
391                         return 0;
392                 oldval = val;
393                 if (!parse_unit_factor(end, &val))
394                         return 0;
395                 if ((val > maximum_unsigned_value_of_type(long)) ||
396                     (oldval > val))
397                         return 0;
398                 *ret = val;
399                 return 1;
400         }
401         return 0;
404 static void die_bad_config(const char *name)
406         if (cf && cf->name)
407                 die("bad config value for '%s' in %s", name, cf->name);
408         die("bad config value for '%s'", name);
411 int git_config_int(const char *name, const char *value)
413         long ret = 0;
414         if (!git_parse_long(value, &ret))
415                 die_bad_config(name);
416         return ret;
419 unsigned long git_config_ulong(const char *name, const char *value)
421         unsigned long ret;
422         if (!git_parse_ulong(value, &ret))
423                 die_bad_config(name);
424         return ret;
427 static int git_config_maybe_bool_text(const char *name, const char *value)
429         if (!value)
430                 return 1;
431         if (!*value)
432                 return 0;
433         if (!strcasecmp(value, "true")
434             || !strcasecmp(value, "yes")
435             || !strcasecmp(value, "on"))
436                 return 1;
437         if (!strcasecmp(value, "false")
438             || !strcasecmp(value, "no")
439             || !strcasecmp(value, "off"))
440                 return 0;
441         return -1;
444 int git_config_maybe_bool(const char *name, const char *value)
446         long v = git_config_maybe_bool_text(name, value);
447         if (0 <= v)
448                 return v;
449         if (git_parse_long(value, &v))
450                 return !!v;
451         return -1;
454 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
456         int v = git_config_maybe_bool_text(name, value);
457         if (0 <= v) {
458                 *is_bool = 1;
459                 return v;
460         }
461         *is_bool = 0;
462         return git_config_int(name, value);
465 int git_config_bool(const char *name, const char *value)
467         int discard;
468         return !!git_config_bool_or_int(name, value, &discard);
471 int git_config_string(const char **dest, const char *var, const char *value)
473         if (!value)
474                 return config_error_nonbool(var);
475         *dest = xstrdup(value);
476         return 0;
479 int git_config_pathname(const char **dest, const char *var, const char *value)
481         if (!value)
482                 return config_error_nonbool(var);
483         *dest = expand_user_path(value);
484         if (!*dest)
485                 die("Failed to expand user dir in: '%s'", value);
486         return 0;
489 static int git_default_core_config(const char *var, const char *value)
491         /* This needs a better name */
492         if (!strcmp(var, "core.filemode")) {
493                 trust_executable_bit = git_config_bool(var, value);
494                 return 0;
495         }
496         if (!strcmp(var, "core.trustctime")) {
497                 trust_ctime = git_config_bool(var, value);
498                 return 0;
499         }
501         if (!strcmp(var, "core.quotepath")) {
502                 quote_path_fully = git_config_bool(var, value);
503                 return 0;
504         }
506         if (!strcmp(var, "core.symlinks")) {
507                 has_symlinks = git_config_bool(var, value);
508                 return 0;
509         }
511         if (!strcmp(var, "core.ignorecase")) {
512                 ignore_case = git_config_bool(var, value);
513                 return 0;
514         }
516         if (!strcmp(var, "core.attributesfile"))
517                 return git_config_pathname(&git_attributes_file, var, value);
519         if (!strcmp(var, "core.bare")) {
520                 is_bare_repository_cfg = git_config_bool(var, value);
521                 return 0;
522         }
524         if (!strcmp(var, "core.ignorestat")) {
525                 assume_unchanged = git_config_bool(var, value);
526                 return 0;
527         }
529         if (!strcmp(var, "core.prefersymlinkrefs")) {
530                 prefer_symlink_refs = git_config_bool(var, value);
531                 return 0;
532         }
534         if (!strcmp(var, "core.logallrefupdates")) {
535                 log_all_ref_updates = git_config_bool(var, value);
536                 return 0;
537         }
539         if (!strcmp(var, "core.warnambiguousrefs")) {
540                 warn_ambiguous_refs = git_config_bool(var, value);
541                 return 0;
542         }
544         if (!strcmp(var, "core.abbrev")) {
545                 int abbrev = git_config_int(var, value);
546                 if (abbrev < minimum_abbrev || abbrev > 40)
547                         return -1;
548                 default_abbrev = abbrev;
549                 return 0;
550         }
552         if (!strcmp(var, "core.loosecompression")) {
553                 int level = git_config_int(var, value);
554                 if (level == -1)
555                         level = Z_DEFAULT_COMPRESSION;
556                 else if (level < 0 || level > Z_BEST_COMPRESSION)
557                         die("bad zlib compression level %d", level);
558                 zlib_compression_level = level;
559                 zlib_compression_seen = 1;
560                 return 0;
561         }
563         if (!strcmp(var, "core.compression")) {
564                 int level = git_config_int(var, value);
565                 if (level == -1)
566                         level = Z_DEFAULT_COMPRESSION;
567                 else if (level < 0 || level > Z_BEST_COMPRESSION)
568                         die("bad zlib compression level %d", level);
569                 core_compression_level = level;
570                 core_compression_seen = 1;
571                 if (!zlib_compression_seen)
572                         zlib_compression_level = level;
573                 return 0;
574         }
576         if (!strcmp(var, "core.packedgitwindowsize")) {
577                 int pgsz_x2 = getpagesize() * 2;
578                 packed_git_window_size = git_config_ulong(var, value);
580                 /* This value must be multiple of (pagesize * 2) */
581                 packed_git_window_size /= pgsz_x2;
582                 if (packed_git_window_size < 1)
583                         packed_git_window_size = 1;
584                 packed_git_window_size *= pgsz_x2;
585                 return 0;
586         }
588         if (!strcmp(var, "core.bigfilethreshold")) {
589                 big_file_threshold = git_config_ulong(var, value);
590                 return 0;
591         }
593         if (!strcmp(var, "core.packedgitlimit")) {
594                 packed_git_limit = git_config_ulong(var, value);
595                 return 0;
596         }
598         if (!strcmp(var, "core.deltabasecachelimit")) {
599                 delta_base_cache_limit = git_config_ulong(var, value);
600                 return 0;
601         }
603         if (!strcmp(var, "core.logpackaccess"))
604                 return git_config_string(&log_pack_access, var, value);
606         if (!strcmp(var, "core.autocrlf")) {
607                 if (value && !strcasecmp(value, "input")) {
608                         if (core_eol == EOL_CRLF)
609                                 return error("core.autocrlf=input conflicts with core.eol=crlf");
610                         auto_crlf = AUTO_CRLF_INPUT;
611                         return 0;
612                 }
613                 auto_crlf = git_config_bool(var, value);
614                 return 0;
615         }
617         if (!strcmp(var, "core.safecrlf")) {
618                 if (value && !strcasecmp(value, "warn")) {
619                         safe_crlf = SAFE_CRLF_WARN;
620                         return 0;
621                 }
622                 safe_crlf = git_config_bool(var, value);
623                 return 0;
624         }
626         if (!strcmp(var, "core.eol")) {
627                 if (value && !strcasecmp(value, "lf"))
628                         core_eol = EOL_LF;
629                 else if (value && !strcasecmp(value, "crlf"))
630                         core_eol = EOL_CRLF;
631                 else if (value && !strcasecmp(value, "native"))
632                         core_eol = EOL_NATIVE;
633                 else
634                         core_eol = EOL_UNSET;
635                 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
636                         return error("core.autocrlf=input conflicts with core.eol=crlf");
637                 return 0;
638         }
640         if (!strcmp(var, "core.notesref")) {
641                 notes_ref_name = xstrdup(value);
642                 return 0;
643         }
645         if (!strcmp(var, "core.pager"))
646                 return git_config_string(&pager_program, var, value);
648         if (!strcmp(var, "core.editor"))
649                 return git_config_string(&editor_program, var, value);
651         if (!strcmp(var, "core.askpass"))
652                 return git_config_string(&askpass_program, var, value);
654         if (!strcmp(var, "core.excludesfile"))
655                 return git_config_pathname(&excludes_file, var, value);
657         if (!strcmp(var, "core.whitespace")) {
658                 if (!value)
659                         return config_error_nonbool(var);
660                 whitespace_rule_cfg = parse_whitespace_rule(value);
661                 return 0;
662         }
664         if (!strcmp(var, "core.fsyncobjectfiles")) {
665                 fsync_object_files = git_config_bool(var, value);
666                 return 0;
667         }
669         if (!strcmp(var, "core.preloadindex")) {
670                 core_preload_index = git_config_bool(var, value);
671                 return 0;
672         }
674         if (!strcmp(var, "core.createobject")) {
675                 if (!strcmp(value, "rename"))
676                         object_creation_mode = OBJECT_CREATION_USES_RENAMES;
677                 else if (!strcmp(value, "link"))
678                         object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
679                 else
680                         die("Invalid mode for object creation: %s", value);
681                 return 0;
682         }
684         if (!strcmp(var, "core.sparsecheckout")) {
685                 core_apply_sparse_checkout = git_config_bool(var, value);
686                 return 0;
687         }
689         /* Add other config variables here and to Documentation/config.txt. */
690         return 0;
693 static int git_default_user_config(const char *var, const char *value)
695         if (!strcmp(var, "user.name")) {
696                 if (!value)
697                         return config_error_nonbool(var);
698                 strlcpy(git_default_name, value, sizeof(git_default_name));
699                 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
700                 return 0;
701         }
703         if (!strcmp(var, "user.email")) {
704                 if (!value)
705                         return config_error_nonbool(var);
706                 strlcpy(git_default_email, value, sizeof(git_default_email));
707                 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
708                 return 0;
709         }
711         /* Add other config variables here and to Documentation/config.txt. */
712         return 0;
715 static int git_default_i18n_config(const char *var, const char *value)
717         if (!strcmp(var, "i18n.commitencoding"))
718                 return git_config_string(&git_commit_encoding, var, value);
720         if (!strcmp(var, "i18n.logoutputencoding"))
721                 return git_config_string(&git_log_output_encoding, var, value);
723         /* Add other config variables here and to Documentation/config.txt. */
724         return 0;
727 static int git_default_branch_config(const char *var, const char *value)
729         if (!strcmp(var, "branch.autosetupmerge")) {
730                 if (value && !strcasecmp(value, "always")) {
731                         git_branch_track = BRANCH_TRACK_ALWAYS;
732                         return 0;
733                 }
734                 git_branch_track = git_config_bool(var, value);
735                 return 0;
736         }
737         if (!strcmp(var, "branch.autosetuprebase")) {
738                 if (!value)
739                         return config_error_nonbool(var);
740                 else if (!strcmp(value, "never"))
741                         autorebase = AUTOREBASE_NEVER;
742                 else if (!strcmp(value, "local"))
743                         autorebase = AUTOREBASE_LOCAL;
744                 else if (!strcmp(value, "remote"))
745                         autorebase = AUTOREBASE_REMOTE;
746                 else if (!strcmp(value, "always"))
747                         autorebase = AUTOREBASE_ALWAYS;
748                 else
749                         return error("Malformed value for %s", var);
750                 return 0;
751         }
753         /* Add other config variables here and to Documentation/config.txt. */
754         return 0;
757 static int git_default_push_config(const char *var, const char *value)
759         if (!strcmp(var, "push.default")) {
760                 if (!value)
761                         return config_error_nonbool(var);
762                 else if (!strcmp(value, "nothing"))
763                         push_default = PUSH_DEFAULT_NOTHING;
764                 else if (!strcmp(value, "matching"))
765                         push_default = PUSH_DEFAULT_MATCHING;
766                 else if (!strcmp(value, "upstream"))
767                         push_default = PUSH_DEFAULT_UPSTREAM;
768                 else if (!strcmp(value, "tracking")) /* deprecated */
769                         push_default = PUSH_DEFAULT_UPSTREAM;
770                 else if (!strcmp(value, "current"))
771                         push_default = PUSH_DEFAULT_CURRENT;
772                 else {
773                         error("Malformed value for %s: %s", var, value);
774                         return error("Must be one of nothing, matching, "
775                                      "tracking or current.");
776                 }
777                 return 0;
778         }
780         /* Add other config variables here and to Documentation/config.txt. */
781         return 0;
784 static int git_default_mailmap_config(const char *var, const char *value)
786         if (!strcmp(var, "mailmap.file"))
787                 return git_config_string(&git_mailmap_file, var, value);
789         /* Add other config variables here and to Documentation/config.txt. */
790         return 0;
793 int git_default_config(const char *var, const char *value, void *dummy)
795         if (!prefixcmp(var, "core."))
796                 return git_default_core_config(var, value);
798         if (!prefixcmp(var, "user."))
799                 return git_default_user_config(var, value);
801         if (!prefixcmp(var, "i18n."))
802                 return git_default_i18n_config(var, value);
804         if (!prefixcmp(var, "branch."))
805                 return git_default_branch_config(var, value);
807         if (!prefixcmp(var, "push."))
808                 return git_default_push_config(var, value);
810         if (!prefixcmp(var, "mailmap."))
811                 return git_default_mailmap_config(var, value);
813         if (!prefixcmp(var, "advice."))
814                 return git_default_advice_config(var, value);
816         if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
817                 pager_use_color = git_config_bool(var,value);
818                 return 0;
819         }
821         if (!strcmp(var, "pack.packsizelimit")) {
822                 pack_size_limit_cfg = git_config_ulong(var, value);
823                 return 0;
824         }
825         /* Add other config variables here and to Documentation/config.txt. */
826         return 0;
829 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
831         int ret;
832         FILE *f = fopen(filename, "r");
834         ret = -1;
835         if (f) {
836                 config_file top;
838                 /* push config-file parsing state stack */
839                 top.prev = cf;
840                 top.f = f;
841                 top.name = filename;
842                 top.linenr = 1;
843                 top.eof = 0;
844                 strbuf_init(&top.value, 1024);
845                 cf = &top;
847                 ret = git_parse_file(fn, data);
849                 /* pop config-file parsing state stack */
850                 strbuf_release(&top.value);
851                 cf = top.prev;
853                 fclose(f);
854         }
855         return ret;
858 const char *git_etc_gitconfig(void)
860         static const char *system_wide;
861         if (!system_wide)
862                 system_wide = system_path(ETC_GITCONFIG);
863         return system_wide;
866 int git_env_bool(const char *k, int def)
868         const char *v = getenv(k);
869         return v ? git_config_bool(k, v) : def;
872 int git_config_system(void)
874         return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
877 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
879         int ret = 0, found = 0;
880         const char *home = NULL;
882         /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
883         if (config_exclusive_filename)
884                 return git_config_from_file(fn, config_exclusive_filename, data);
885         if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
886                 ret += git_config_from_file(fn, git_etc_gitconfig(),
887                                             data);
888                 found += 1;
889         }
891         home = getenv("HOME");
892         if (home) {
893                 char buf[PATH_MAX];
894                 char *user_config = mksnpath(buf, sizeof(buf), "%s/.gitconfig", home);
895                 if (!access(user_config, R_OK)) {
896                         ret += git_config_from_file(fn, user_config, data);
897                         found += 1;
898                 }
899         }
901         if (repo_config && !access(repo_config, R_OK)) {
902                 ret += git_config_from_file(fn, repo_config, data);
903                 found += 1;
904         }
906         switch (git_config_from_parameters(fn, data)) {
907         case -1: /* error */
908                 die("unable to parse command-line config");
909                 break;
910         case 0: /* found nothing */
911                 break;
912         default: /* found at least one item */
913                 found++;
914                 break;
915         }
917         return ret == 0 ? found : ret;
920 int git_config(config_fn_t fn, void *data)
922         char *repo_config = NULL;
923         int ret;
925         repo_config = git_pathdup("config");
926         ret = git_config_early(fn, data, repo_config);
927         if (repo_config)
928                 free(repo_config);
929         return ret;
932 /*
933  * Find all the stuff for git_config_set() below.
934  */
936 #define MAX_MATCHES 512
938 static struct {
939         int baselen;
940         char *key;
941         int do_not_match;
942         regex_t *value_regex;
943         int multi_replace;
944         size_t offset[MAX_MATCHES];
945         enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
946         int seen;
947 } store;
949 static int matches(const char *key, const char *value)
951         return !strcmp(key, store.key) &&
952                 (store.value_regex == NULL ||
953                  (store.do_not_match ^
954                   !regexec(store.value_regex, value, 0, NULL, 0)));
957 static int store_aux(const char *key, const char *value, void *cb)
959         const char *ep;
960         size_t section_len;
961         FILE *f = cf->f;
963         switch (store.state) {
964         case KEY_SEEN:
965                 if (matches(key, value)) {
966                         if (store.seen == 1 && store.multi_replace == 0) {
967                                 warning("%s has multiple values", key);
968                         } else if (store.seen >= MAX_MATCHES) {
969                                 error("too many matches for %s", key);
970                                 return 1;
971                         }
973                         store.offset[store.seen] = ftell(f);
974                         store.seen++;
975                 }
976                 break;
977         case SECTION_SEEN:
978                 /*
979                  * What we are looking for is in store.key (both
980                  * section and var), and its section part is baselen
981                  * long.  We found key (again, both section and var).
982                  * We would want to know if this key is in the same
983                  * section as what we are looking for.  We already
984                  * know we are in the same section as what should
985                  * hold store.key.
986                  */
987                 ep = strrchr(key, '.');
988                 section_len = ep - key;
990                 if ((section_len != store.baselen) ||
991                     memcmp(key, store.key, section_len+1)) {
992                         store.state = SECTION_END_SEEN;
993                         break;
994                 }
996                 /*
997                  * Do not increment matches: this is no match, but we
998                  * just made sure we are in the desired section.
999                  */
1000                 store.offset[store.seen] = ftell(f);
1001                 /* fallthru */
1002         case SECTION_END_SEEN:
1003         case START:
1004                 if (matches(key, value)) {
1005                         store.offset[store.seen] = ftell(f);
1006                         store.state = KEY_SEEN;
1007                         store.seen++;
1008                 } else {
1009                         if (strrchr(key, '.') - key == store.baselen &&
1010                               !strncmp(key, store.key, store.baselen)) {
1011                                         store.state = SECTION_SEEN;
1012                                         store.offset[store.seen] = ftell(f);
1013                         }
1014                 }
1015         }
1016         return 0;
1019 static int write_error(const char *filename)
1021         error("failed to write new configuration file %s", filename);
1023         /* Same error code as "failed to rename". */
1024         return 4;
1027 static int store_write_section(int fd, const char *key)
1029         const char *dot;
1030         int i, success;
1031         struct strbuf sb = STRBUF_INIT;
1033         dot = memchr(key, '.', store.baselen);
1034         if (dot) {
1035                 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1036                 for (i = dot - key + 1; i < store.baselen; i++) {
1037                         if (key[i] == '"' || key[i] == '\\')
1038                                 strbuf_addch(&sb, '\\');
1039                         strbuf_addch(&sb, key[i]);
1040                 }
1041                 strbuf_addstr(&sb, "\"]\n");
1042         } else {
1043                 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1044         }
1046         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1047         strbuf_release(&sb);
1049         return success;
1052 static int store_write_pair(int fd, const char *key, const char *value)
1054         int i, success;
1055         int length = strlen(key + store.baselen + 1);
1056         const char *quote = "";
1057         struct strbuf sb = STRBUF_INIT;
1059         /*
1060          * Check to see if the value needs to be surrounded with a dq pair.
1061          * Note that problematic characters are always backslash-quoted; this
1062          * check is about not losing leading or trailing SP and strings that
1063          * follow beginning-of-comment characters (i.e. ';' and '#') by the
1064          * configuration parser.
1065          */
1066         if (value[0] == ' ')
1067                 quote = "\"";
1068         for (i = 0; value[i]; i++)
1069                 if (value[i] == ';' || value[i] == '#')
1070                         quote = "\"";
1071         if (i && value[i - 1] == ' ')
1072                 quote = "\"";
1074         strbuf_addf(&sb, "\t%.*s = %s",
1075                     length, key + store.baselen + 1, quote);
1077         for (i = 0; value[i]; i++)
1078                 switch (value[i]) {
1079                 case '\n':
1080                         strbuf_addstr(&sb, "\\n");
1081                         break;
1082                 case '\t':
1083                         strbuf_addstr(&sb, "\\t");
1084                         break;
1085                 case '"':
1086                 case '\\':
1087                         strbuf_addch(&sb, '\\');
1088                 default:
1089                         strbuf_addch(&sb, value[i]);
1090                         break;
1091                 }
1092         strbuf_addf(&sb, "%s\n", quote);
1094         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1095         strbuf_release(&sb);
1097         return success;
1100 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1101         size_t offset_, int *found_bracket)
1103         size_t equal_offset = size, bracket_offset = size;
1104         ssize_t offset;
1106 contline:
1107         for (offset = offset_-2; offset > 0
1108                         && contents[offset] != '\n'; offset--)
1109                 switch (contents[offset]) {
1110                         case '=': equal_offset = offset; break;
1111                         case ']': bracket_offset = offset; break;
1112                 }
1113         if (offset > 0 && contents[offset-1] == '\\') {
1114                 offset_ = offset;
1115                 goto contline;
1116         }
1117         if (bracket_offset < equal_offset) {
1118                 *found_bracket = 1;
1119                 offset = bracket_offset+1;
1120         } else
1121                 offset++;
1123         return offset;
1126 int git_config_set_in_file(const char *config_filename,
1127                         const char *key, const char *value)
1129         return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1132 int git_config_set(const char *key, const char *value)
1134         return git_config_set_multivar(key, value, NULL, 0);
1137 /*
1138  * Auxiliary function to sanity-check and split the key into the section
1139  * identifier and variable name.
1140  *
1141  * Returns 0 on success, -1 when there is an invalid character in the key and
1142  * -2 if there is no section name in the key.
1143  *
1144  * store_key - pointer to char* which will hold a copy of the key with
1145  *             lowercase section and variable name
1146  * baselen - pointer to int which will hold the length of the
1147  *           section + subsection part, can be NULL
1148  */
1149 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1151         int i, dot, baselen;
1152         const char *last_dot = strrchr(key, '.');
1154         /*
1155          * Since "key" actually contains the section name and the real
1156          * key name separated by a dot, we have to know where the dot is.
1157          */
1159         if (last_dot == NULL || last_dot == key) {
1160                 error("key does not contain a section: %s", key);
1161                 return -CONFIG_NO_SECTION_OR_NAME;
1162         }
1164         if (!last_dot[1]) {
1165                 error("key does not contain variable name: %s", key);
1166                 return -CONFIG_NO_SECTION_OR_NAME;
1167         }
1169         baselen = last_dot - key;
1170         if (baselen_)
1171                 *baselen_ = baselen;
1173         /*
1174          * Validate the key and while at it, lower case it for matching.
1175          */
1176         *store_key = xmalloc(strlen(key) + 1);
1178         dot = 0;
1179         for (i = 0; key[i]; i++) {
1180                 unsigned char c = key[i];
1181                 if (c == '.')
1182                         dot = 1;
1183                 /* Leave the extended basename untouched.. */
1184                 if (!dot || i > baselen) {
1185                         if (!iskeychar(c) ||
1186                             (i == baselen + 1 && !isalpha(c))) {
1187                                 error("invalid key: %s", key);
1188                                 goto out_free_ret_1;
1189                         }
1190                         c = tolower(c);
1191                 } else if (c == '\n') {
1192                         error("invalid key (newline): %s", key);
1193                         goto out_free_ret_1;
1194                 }
1195                 (*store_key)[i] = c;
1196         }
1197         (*store_key)[i] = 0;
1199         return 0;
1201 out_free_ret_1:
1202         free(*store_key);
1203         return -CONFIG_INVALID_KEY;
1206 /*
1207  * If value==NULL, unset in (remove from) config,
1208  * if value_regex!=NULL, disregard key/value pairs where value does not match.
1209  * if multi_replace==0, nothing, or only one matching key/value is replaced,
1210  *     else all matching key/values (regardless how many) are removed,
1211  *     before the new pair is written.
1212  *
1213  * Returns 0 on success.
1214  *
1215  * This function does this:
1216  *
1217  * - it locks the config file by creating ".git/config.lock"
1218  *
1219  * - it then parses the config using store_aux() as validator to find
1220  *   the position on the key/value pair to replace. If it is to be unset,
1221  *   it must be found exactly once.
1222  *
1223  * - the config file is mmap()ed and the part before the match (if any) is
1224  *   written to the lock file, then the changed part and the rest.
1225  *
1226  * - the config file is removed and the lock file rename()d to it.
1227  *
1228  */
1229 int git_config_set_multivar_in_file(const char *config_filename,
1230                                 const char *key, const char *value,
1231                                 const char *value_regex, int multi_replace)
1233         int fd = -1, in_fd;
1234         int ret;
1235         struct lock_file *lock = NULL;
1237         /* parse-key returns negative; flip the sign to feed exit(3) */
1238         ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1239         if (ret)
1240                 goto out_free;
1242         store.multi_replace = multi_replace;
1245         /*
1246          * The lock serves a purpose in addition to locking: the new
1247          * contents of .git/config will be written into it.
1248          */
1249         lock = xcalloc(sizeof(struct lock_file), 1);
1250         fd = hold_lock_file_for_update(lock, config_filename, 0);
1251         if (fd < 0) {
1252                 error("could not lock config file %s: %s", config_filename, strerror(errno));
1253                 free(store.key);
1254                 ret = CONFIG_NO_LOCK;
1255                 goto out_free;
1256         }
1258         /*
1259          * If .git/config does not exist yet, write a minimal version.
1260          */
1261         in_fd = open(config_filename, O_RDONLY);
1262         if ( in_fd < 0 ) {
1263                 free(store.key);
1265                 if ( ENOENT != errno ) {
1266                         error("opening %s: %s", config_filename,
1267                               strerror(errno));
1268                         ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1269                         goto out_free;
1270                 }
1271                 /* if nothing to unset, error out */
1272                 if (value == NULL) {
1273                         ret = CONFIG_NOTHING_SET;
1274                         goto out_free;
1275                 }
1277                 store.key = (char *)key;
1278                 if (!store_write_section(fd, key) ||
1279                     !store_write_pair(fd, key, value))
1280                         goto write_err_out;
1281         } else {
1282                 struct stat st;
1283                 char *contents;
1284                 size_t contents_sz, copy_begin, copy_end;
1285                 int i, new_line = 0;
1287                 if (value_regex == NULL)
1288                         store.value_regex = NULL;
1289                 else {
1290                         if (value_regex[0] == '!') {
1291                                 store.do_not_match = 1;
1292                                 value_regex++;
1293                         } else
1294                                 store.do_not_match = 0;
1296                         store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1297                         if (regcomp(store.value_regex, value_regex,
1298                                         REG_EXTENDED)) {
1299                                 error("invalid pattern: %s", value_regex);
1300                                 free(store.value_regex);
1301                                 ret = CONFIG_INVALID_PATTERN;
1302                                 goto out_free;
1303                         }
1304                 }
1306                 store.offset[0] = 0;
1307                 store.state = START;
1308                 store.seen = 0;
1310                 /*
1311                  * After this, store.offset will contain the *end* offset
1312                  * of the last match, or remain at 0 if no match was found.
1313                  * As a side effect, we make sure to transform only a valid
1314                  * existing config file.
1315                  */
1316                 if (git_config_from_file(store_aux, config_filename, NULL)) {
1317                         error("invalid config file %s", config_filename);
1318                         free(store.key);
1319                         if (store.value_regex != NULL) {
1320                                 regfree(store.value_regex);
1321                                 free(store.value_regex);
1322                         }
1323                         ret = CONFIG_INVALID_FILE;
1324                         goto out_free;
1325                 }
1327                 free(store.key);
1328                 if (store.value_regex != NULL) {
1329                         regfree(store.value_regex);
1330                         free(store.value_regex);
1331                 }
1333                 /* if nothing to unset, or too many matches, error out */
1334                 if ((store.seen == 0 && value == NULL) ||
1335                                 (store.seen > 1 && multi_replace == 0)) {
1336                         ret = CONFIG_NOTHING_SET;
1337                         goto out_free;
1338                 }
1340                 fstat(in_fd, &st);
1341                 contents_sz = xsize_t(st.st_size);
1342                 contents = xmmap(NULL, contents_sz, PROT_READ,
1343                         MAP_PRIVATE, in_fd, 0);
1344                 close(in_fd);
1346                 if (store.seen == 0)
1347                         store.seen = 1;
1349                 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1350                         if (store.offset[i] == 0) {
1351                                 store.offset[i] = copy_end = contents_sz;
1352                         } else if (store.state != KEY_SEEN) {
1353                                 copy_end = store.offset[i];
1354                         } else
1355                                 copy_end = find_beginning_of_line(
1356                                         contents, contents_sz,
1357                                         store.offset[i]-2, &new_line);
1359                         if (copy_end > 0 && contents[copy_end-1] != '\n')
1360                                 new_line = 1;
1362                         /* write the first part of the config */
1363                         if (copy_end > copy_begin) {
1364                                 if (write_in_full(fd, contents + copy_begin,
1365                                                   copy_end - copy_begin) <
1366                                     copy_end - copy_begin)
1367                                         goto write_err_out;
1368                                 if (new_line &&
1369                                     write_str_in_full(fd, "\n") != 1)
1370                                         goto write_err_out;
1371                         }
1372                         copy_begin = store.offset[i];
1373                 }
1375                 /* write the pair (value == NULL means unset) */
1376                 if (value != NULL) {
1377                         if (store.state == START) {
1378                                 if (!store_write_section(fd, key))
1379                                         goto write_err_out;
1380                         }
1381                         if (!store_write_pair(fd, key, value))
1382                                 goto write_err_out;
1383                 }
1385                 /* write the rest of the config */
1386                 if (copy_begin < contents_sz)
1387                         if (write_in_full(fd, contents + copy_begin,
1388                                           contents_sz - copy_begin) <
1389                             contents_sz - copy_begin)
1390                                 goto write_err_out;
1392                 munmap(contents, contents_sz);
1393         }
1395         if (commit_lock_file(lock) < 0) {
1396                 error("could not commit config file %s", config_filename);
1397                 ret = CONFIG_NO_WRITE;
1398                 goto out_free;
1399         }
1401         /*
1402          * lock is committed, so don't try to roll it back below.
1403          * NOTE: Since lockfile.c keeps a linked list of all created
1404          * lock_file structures, it isn't safe to free(lock).  It's
1405          * better to just leave it hanging around.
1406          */
1407         lock = NULL;
1408         ret = 0;
1410 out_free:
1411         if (lock)
1412                 rollback_lock_file(lock);
1413         return ret;
1415 write_err_out:
1416         ret = write_error(lock->filename);
1417         goto out_free;
1421 int git_config_set_multivar(const char *key, const char *value,
1422                         const char *value_regex, int multi_replace)
1424         const char *config_filename;
1425         char *buf = NULL;
1426         int ret;
1428         if (config_exclusive_filename)
1429                 config_filename = config_exclusive_filename;
1430         else
1431                 config_filename = buf = git_pathdup("config");
1433         ret = git_config_set_multivar_in_file(config_filename, key, value,
1434                                         value_regex, multi_replace);
1435         free(buf);
1436         return ret;
1439 static int section_name_match (const char *buf, const char *name)
1441         int i = 0, j = 0, dot = 0;
1442         if (buf[i] != '[')
1443                 return 0;
1444         for (i = 1; buf[i] && buf[i] != ']'; i++) {
1445                 if (!dot && isspace(buf[i])) {
1446                         dot = 1;
1447                         if (name[j++] != '.')
1448                                 break;
1449                         for (i++; isspace(buf[i]); i++)
1450                                 ; /* do nothing */
1451                         if (buf[i] != '"')
1452                                 break;
1453                         continue;
1454                 }
1455                 if (buf[i] == '\\' && dot)
1456                         i++;
1457                 else if (buf[i] == '"' && dot) {
1458                         for (i++; isspace(buf[i]); i++)
1459                                 ; /* do_nothing */
1460                         break;
1461                 }
1462                 if (buf[i] != name[j++])
1463                         break;
1464         }
1465         if (buf[i] == ']' && name[j] == 0) {
1466                 /*
1467                  * We match, now just find the right length offset by
1468                  * gobbling up any whitespace after it, as well
1469                  */
1470                 i++;
1471                 for (; buf[i] && isspace(buf[i]); i++)
1472                         ; /* do nothing */
1473                 return i;
1474         }
1475         return 0;
1478 /* if new_name == NULL, the section is removed instead */
1479 int git_config_rename_section(const char *old_name, const char *new_name)
1481         int ret = 0, remove = 0;
1482         char *config_filename;
1483         struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1484         int out_fd;
1485         char buf[1024];
1486         FILE *config_file;
1488         if (config_exclusive_filename)
1489                 config_filename = xstrdup(config_exclusive_filename);
1490         else
1491                 config_filename = git_pathdup("config");
1492         out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1493         if (out_fd < 0) {
1494                 ret = error("could not lock config file %s", config_filename);
1495                 goto out;
1496         }
1498         if (!(config_file = fopen(config_filename, "rb"))) {
1499                 /* no config file means nothing to rename, no error */
1500                 goto unlock_and_out;
1501         }
1503         while (fgets(buf, sizeof(buf), config_file)) {
1504                 int i;
1505                 int length;
1506                 char *output = buf;
1507                 for (i = 0; buf[i] && isspace(buf[i]); i++)
1508                         ; /* do nothing */
1509                 if (buf[i] == '[') {
1510                         /* it's a section */
1511                         int offset = section_name_match(&buf[i], old_name);
1512                         if (offset > 0) {
1513                                 ret++;
1514                                 if (new_name == NULL) {
1515                                         remove = 1;
1516                                         continue;
1517                                 }
1518                                 store.baselen = strlen(new_name);
1519                                 if (!store_write_section(out_fd, new_name)) {
1520                                         ret = write_error(lock->filename);
1521                                         goto out;
1522                                 }
1523                                 /*
1524                                  * We wrote out the new section, with
1525                                  * a newline, now skip the old
1526                                  * section's length
1527                                  */
1528                                 output += offset + i;
1529                                 if (strlen(output) > 0) {
1530                                         /*
1531                                          * More content means there's
1532                                          * a declaration to put on the
1533                                          * next line; indent with a
1534                                          * tab
1535                                          */
1536                                         output -= 1;
1537                                         output[0] = '\t';
1538                                 }
1539                         }
1540                         remove = 0;
1541                 }
1542                 if (remove)
1543                         continue;
1544                 length = strlen(output);
1545                 if (write_in_full(out_fd, output, length) != length) {
1546                         ret = write_error(lock->filename);
1547                         goto out;
1548                 }
1549         }
1550         fclose(config_file);
1551 unlock_and_out:
1552         if (commit_lock_file(lock) < 0)
1553                 ret = error("could not commit config file %s", config_filename);
1554 out:
1555         free(config_filename);
1556         return ret;
1559 /*
1560  * Call this to report error for your variable that should not
1561  * get a boolean value (i.e. "[my] var" means "true").
1562  */
1563 int config_error_nonbool(const char *var)
1565         return error("Missing value for '%s'", var);