Code

Documentation: explain how to check for patch corruption
[git.git] / config.c
1 /*
2  * GIT - The information manager from hell
3  *
4  * Copyright (C) Linus Torvalds, 2005
5  * Copyright (C) Johannes Schindelin, 2005
6  *
7  */
8 #include "cache.h"
9 #include "exec_cmd.h"
10 #include "strbuf.h"
11 #include "quote.h"
13 #define MAXNAME (256)
15 static FILE *config_file;
16 static const char *config_file_name;
17 static int config_linenr;
18 static int config_file_eof;
19 static int zlib_compression_seen;
21 const char *config_exclusive_filename = NULL;
23 struct config_item {
24         struct config_item *next;
25         char *name;
26         char *value;
27 };
28 static struct config_item *config_parameters;
29 static struct config_item **config_parameters_tail = &config_parameters;
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 {
52         struct config_item *ct;
53         struct strbuf tmp = STRBUF_INIT;
54         struct strbuf **pair;
55         strbuf_addstr(&tmp, text);
56         pair = strbuf_split(&tmp, '=');
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 -1;
63         }
64         ct = xcalloc(1, sizeof(struct config_item));
65         ct->name = strbuf_detach(pair[0], NULL);
66         if (pair[1]) {
67                 strbuf_trim(pair[1]);
68                 ct->value = strbuf_detach(pair[1], NULL);
69         }
70         strbuf_list_free(pair);
71         lowercase(ct->name);
72         *config_parameters_tail = ct;
73         config_parameters_tail = &ct->next;
74         return 0;
75 }
77 int git_config_parse_environment(void) {
78         const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
79         char *envw;
80         const char **argv = NULL;
81         int nr = 0, alloc = 0;
82         int i;
84         if (!env)
85                 return 0;
86         /* sq_dequote will write over it */
87         envw = xstrdup(env);
89         if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
90                 free(envw);
91                 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
92         }
94         for (i = 0; i < nr; i++) {
95                 if (git_config_parse_parameter(argv[i]) < 0) {
96                         error("bogus config parameter: %s", argv[i]);
97                         free(argv);
98                         free(envw);
99                         return -1;
100                 }
101         }
103         free(argv);
104         free(envw);
105         return 0;
108 static int get_next_char(void)
110         int c;
111         FILE *f;
113         c = '\n';
114         if ((f = config_file) != NULL) {
115                 c = fgetc(f);
116                 if (c == '\r') {
117                         /* DOS like systems */
118                         c = fgetc(f);
119                         if (c != '\n') {
120                                 ungetc(c, f);
121                                 c = '\r';
122                         }
123                 }
124                 if (c == '\n')
125                         config_linenr++;
126                 if (c == EOF) {
127                         config_file_eof = 1;
128                         c = '\n';
129                 }
130         }
131         return c;
134 static char *parse_value(void)
136         static char value[1024];
137         int quote = 0, comment = 0, len = 0, space = 0;
139         for (;;) {
140                 int c = get_next_char();
141                 if (len >= sizeof(value) - 1)
142                         return NULL;
143                 if (c == '\n') {
144                         if (quote)
145                                 return NULL;
146                         value[len] = 0;
147                         return value;
148                 }
149                 if (comment)
150                         continue;
151                 if (isspace(c) && !quote) {
152                         if (len)
153                                 space++;
154                         continue;
155                 }
156                 if (!quote) {
157                         if (c == ';' || c == '#') {
158                                 comment = 1;
159                                 continue;
160                         }
161                 }
162                 for (; space; space--)
163                         value[len++] = ' ';
164                 if (c == '\\') {
165                         c = get_next_char();
166                         switch (c) {
167                         case '\n':
168                                 continue;
169                         case 't':
170                                 c = '\t';
171                                 break;
172                         case 'b':
173                                 c = '\b';
174                                 break;
175                         case 'n':
176                                 c = '\n';
177                                 break;
178                         /* Some characters escape as themselves */
179                         case '\\': case '"':
180                                 break;
181                         /* Reject unknown escape sequences */
182                         default:
183                                 return NULL;
184                         }
185                         value[len++] = c;
186                         continue;
187                 }
188                 if (c == '"') {
189                         quote = 1-quote;
190                         continue;
191                 }
192                 value[len++] = c;
193         }
196 static inline int iskeychar(int c)
198         return isalnum(c) || c == '-';
201 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
203         int c;
204         char *value;
206         /* Get the full name */
207         for (;;) {
208                 c = get_next_char();
209                 if (config_file_eof)
210                         break;
211                 if (!iskeychar(c))
212                         break;
213                 name[len++] = tolower(c);
214                 if (len >= MAXNAME)
215                         return -1;
216         }
217         name[len] = 0;
218         while (c == ' ' || c == '\t')
219                 c = get_next_char();
221         value = NULL;
222         if (c != '\n') {
223                 if (c != '=')
224                         return -1;
225                 value = parse_value();
226                 if (!value)
227                         return -1;
228         }
229         return fn(name, value, data);
232 static int get_extended_base_var(char *name, int baselen, int c)
234         do {
235                 if (c == '\n')
236                         return -1;
237                 c = get_next_char();
238         } while (isspace(c));
240         /* We require the format to be '[base "extension"]' */
241         if (c != '"')
242                 return -1;
243         name[baselen++] = '.';
245         for (;;) {
246                 int c = get_next_char();
247                 if (c == '\n')
248                         return -1;
249                 if (c == '"')
250                         break;
251                 if (c == '\\') {
252                         c = get_next_char();
253                         if (c == '\n')
254                                 return -1;
255                 }
256                 name[baselen++] = c;
257                 if (baselen > MAXNAME / 2)
258                         return -1;
259         }
261         /* Final ']' */
262         if (get_next_char() != ']')
263                 return -1;
264         return baselen;
267 static int get_base_var(char *name)
269         int baselen = 0;
271         for (;;) {
272                 int c = get_next_char();
273                 if (config_file_eof)
274                         return -1;
275                 if (c == ']')
276                         return baselen;
277                 if (isspace(c))
278                         return get_extended_base_var(name, baselen, c);
279                 if (!iskeychar(c) && c != '.')
280                         return -1;
281                 if (baselen > MAXNAME / 2)
282                         return -1;
283                 name[baselen++] = tolower(c);
284         }
287 static int git_parse_file(config_fn_t fn, void *data)
289         int comment = 0;
290         int baselen = 0;
291         static char var[MAXNAME];
293         /* U+FEFF Byte Order Mark in UTF8 */
294         static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
295         const unsigned char *bomptr = utf8_bom;
297         for (;;) {
298                 int c = get_next_char();
299                 if (bomptr && *bomptr) {
300                         /* We are at the file beginning; skip UTF8-encoded BOM
301                          * if present. Sane editors won't put this in on their
302                          * own, but e.g. Windows Notepad will do it happily. */
303                         if ((unsigned char) c == *bomptr) {
304                                 bomptr++;
305                                 continue;
306                         } else {
307                                 /* Do not tolerate partial BOM. */
308                                 if (bomptr != utf8_bom)
309                                         break;
310                                 /* No BOM at file beginning. Cool. */
311                                 bomptr = NULL;
312                         }
313                 }
314                 if (c == '\n') {
315                         if (config_file_eof)
316                                 return 0;
317                         comment = 0;
318                         continue;
319                 }
320                 if (comment || isspace(c))
321                         continue;
322                 if (c == '#' || c == ';') {
323                         comment = 1;
324                         continue;
325                 }
326                 if (c == '[') {
327                         baselen = get_base_var(var);
328                         if (baselen <= 0)
329                                 break;
330                         var[baselen++] = '.';
331                         var[baselen] = 0;
332                         continue;
333                 }
334                 if (!isalpha(c))
335                         break;
336                 var[baselen] = tolower(c);
337                 if (get_value(fn, data, var, baselen+1) < 0)
338                         break;
339         }
340         die("bad config file line %d in %s", config_linenr, config_file_name);
343 static int parse_unit_factor(const char *end, unsigned long *val)
345         if (!*end)
346                 return 1;
347         else if (!strcasecmp(end, "k")) {
348                 *val *= 1024;
349                 return 1;
350         }
351         else if (!strcasecmp(end, "m")) {
352                 *val *= 1024 * 1024;
353                 return 1;
354         }
355         else if (!strcasecmp(end, "g")) {
356                 *val *= 1024 * 1024 * 1024;
357                 return 1;
358         }
359         return 0;
362 static int git_parse_long(const char *value, long *ret)
364         if (value && *value) {
365                 char *end;
366                 long val = strtol(value, &end, 0);
367                 unsigned long factor = 1;
368                 if (!parse_unit_factor(end, &factor))
369                         return 0;
370                 *ret = val * factor;
371                 return 1;
372         }
373         return 0;
376 int git_parse_ulong(const char *value, unsigned long *ret)
378         if (value && *value) {
379                 char *end;
380                 unsigned long val = strtoul(value, &end, 0);
381                 if (!parse_unit_factor(end, &val))
382                         return 0;
383                 *ret = val;
384                 return 1;
385         }
386         return 0;
389 static void die_bad_config(const char *name)
391         if (config_file_name)
392                 die("bad config value for '%s' in %s", name, config_file_name);
393         die("bad config value for '%s'", name);
396 int git_config_int(const char *name, const char *value)
398         long ret = 0;
399         if (!git_parse_long(value, &ret))
400                 die_bad_config(name);
401         return ret;
404 unsigned long git_config_ulong(const char *name, const char *value)
406         unsigned long ret;
407         if (!git_parse_ulong(value, &ret))
408                 die_bad_config(name);
409         return ret;
412 static int git_config_maybe_bool_text(const char *name, const char *value)
414         if (!value)
415                 return 1;
416         if (!*value)
417                 return 0;
418         if (!strcasecmp(value, "true")
419             || !strcasecmp(value, "yes")
420             || !strcasecmp(value, "on"))
421                 return 1;
422         if (!strcasecmp(value, "false")
423             || !strcasecmp(value, "no")
424             || !strcasecmp(value, "off"))
425                 return 0;
426         return -1;
429 int git_config_maybe_bool(const char *name, const char *value)
431         long v = git_config_maybe_bool_text(name, value);
432         if (0 <= v)
433                 return v;
434         if (git_parse_long(value, &v))
435                 return !!v;
436         return -1;
439 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
441         int v = git_config_maybe_bool_text(name, value);
442         if (0 <= v) {
443                 *is_bool = 1;
444                 return v;
445         }
446         *is_bool = 0;
447         return git_config_int(name, value);
450 int git_config_bool(const char *name, const char *value)
452         int discard;
453         return !!git_config_bool_or_int(name, value, &discard);
456 int git_config_string(const char **dest, const char *var, const char *value)
458         if (!value)
459                 return config_error_nonbool(var);
460         *dest = xstrdup(value);
461         return 0;
464 int git_config_pathname(const char **dest, const char *var, const char *value)
466         if (!value)
467                 return config_error_nonbool(var);
468         *dest = expand_user_path(value);
469         if (!*dest)
470                 die("Failed to expand user dir in: '%s'", value);
471         return 0;
474 static int git_default_core_config(const char *var, const char *value)
476         /* This needs a better name */
477         if (!strcmp(var, "core.filemode")) {
478                 trust_executable_bit = git_config_bool(var, value);
479                 return 0;
480         }
481         if (!strcmp(var, "core.trustctime")) {
482                 trust_ctime = git_config_bool(var, value);
483                 return 0;
484         }
486         if (!strcmp(var, "core.quotepath")) {
487                 quote_path_fully = git_config_bool(var, value);
488                 return 0;
489         }
491         if (!strcmp(var, "core.symlinks")) {
492                 has_symlinks = git_config_bool(var, value);
493                 return 0;
494         }
496         if (!strcmp(var, "core.ignorecase")) {
497                 ignore_case = git_config_bool(var, value);
498                 return 0;
499         }
501         if (!strcmp(var, "core.bare")) {
502                 is_bare_repository_cfg = git_config_bool(var, value);
503                 return 0;
504         }
506         if (!strcmp(var, "core.ignorestat")) {
507                 assume_unchanged = git_config_bool(var, value);
508                 return 0;
509         }
511         if (!strcmp(var, "core.prefersymlinkrefs")) {
512                 prefer_symlink_refs = git_config_bool(var, value);
513                 return 0;
514         }
516         if (!strcmp(var, "core.logallrefupdates")) {
517                 log_all_ref_updates = git_config_bool(var, value);
518                 return 0;
519         }
521         if (!strcmp(var, "core.warnambiguousrefs")) {
522                 warn_ambiguous_refs = git_config_bool(var, value);
523                 return 0;
524         }
526         if (!strcmp(var, "core.abbrev")) {
527                 int abbrev = git_config_int(var, value);
528                 if (abbrev < minimum_abbrev || abbrev > 40)
529                         return -1;
530                 default_abbrev = abbrev;
531                 return 0;
532         }
534         if (!strcmp(var, "core.loosecompression")) {
535                 int level = git_config_int(var, value);
536                 if (level == -1)
537                         level = Z_DEFAULT_COMPRESSION;
538                 else if (level < 0 || level > Z_BEST_COMPRESSION)
539                         die("bad zlib compression level %d", level);
540                 zlib_compression_level = level;
541                 zlib_compression_seen = 1;
542                 return 0;
543         }
545         if (!strcmp(var, "core.compression")) {
546                 int level = git_config_int(var, value);
547                 if (level == -1)
548                         level = Z_DEFAULT_COMPRESSION;
549                 else if (level < 0 || level > Z_BEST_COMPRESSION)
550                         die("bad zlib compression level %d", level);
551                 core_compression_level = level;
552                 core_compression_seen = 1;
553                 if (!zlib_compression_seen)
554                         zlib_compression_level = level;
555                 return 0;
556         }
558         if (!strcmp(var, "core.packedgitwindowsize")) {
559                 int pgsz_x2 = getpagesize() * 2;
560                 packed_git_window_size = git_config_int(var, value);
562                 /* This value must be multiple of (pagesize * 2) */
563                 packed_git_window_size /= pgsz_x2;
564                 if (packed_git_window_size < 1)
565                         packed_git_window_size = 1;
566                 packed_git_window_size *= pgsz_x2;
567                 return 0;
568         }
570         if (!strcmp(var, "core.packedgitlimit")) {
571                 packed_git_limit = git_config_int(var, value);
572                 return 0;
573         }
575         if (!strcmp(var, "core.deltabasecachelimit")) {
576                 delta_base_cache_limit = git_config_int(var, value);
577                 return 0;
578         }
580         if (!strcmp(var, "core.autocrlf")) {
581                 if (value && !strcasecmp(value, "input")) {
582                         if (eol == EOL_CRLF)
583                                 return error("core.autocrlf=input conflicts with core.eol=crlf");
584                         auto_crlf = AUTO_CRLF_INPUT;
585                         return 0;
586                 }
587                 auto_crlf = git_config_bool(var, value);
588                 return 0;
589         }
591         if (!strcmp(var, "core.safecrlf")) {
592                 if (value && !strcasecmp(value, "warn")) {
593                         safe_crlf = SAFE_CRLF_WARN;
594                         return 0;
595                 }
596                 safe_crlf = git_config_bool(var, value);
597                 return 0;
598         }
600         if (!strcmp(var, "core.eol")) {
601                 if (value && !strcasecmp(value, "lf"))
602                         eol = EOL_LF;
603                 else if (value && !strcasecmp(value, "crlf"))
604                         eol = EOL_CRLF;
605                 else if (value && !strcasecmp(value, "native"))
606                         eol = EOL_NATIVE;
607                 else
608                         eol = EOL_UNSET;
609                 if (eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
610                         return error("core.autocrlf=input conflicts with core.eol=crlf");
611                 return 0;
612         }
614         if (!strcmp(var, "core.notesref")) {
615                 notes_ref_name = xstrdup(value);
616                 return 0;
617         }
619         if (!strcmp(var, "core.pager"))
620                 return git_config_string(&pager_program, var, value);
622         if (!strcmp(var, "core.editor"))
623                 return git_config_string(&editor_program, var, value);
625         if (!strcmp(var, "core.askpass"))
626                 return git_config_string(&askpass_program, var, value);
628         if (!strcmp(var, "core.excludesfile"))
629                 return git_config_pathname(&excludes_file, var, value);
631         if (!strcmp(var, "core.whitespace")) {
632                 if (!value)
633                         return config_error_nonbool(var);
634                 whitespace_rule_cfg = parse_whitespace_rule(value);
635                 return 0;
636         }
638         if (!strcmp(var, "core.fsyncobjectfiles")) {
639                 fsync_object_files = git_config_bool(var, value);
640                 return 0;
641         }
643         if (!strcmp(var, "core.preloadindex")) {
644                 core_preload_index = git_config_bool(var, value);
645                 return 0;
646         }
648         if (!strcmp(var, "core.createobject")) {
649                 if (!strcmp(value, "rename"))
650                         object_creation_mode = OBJECT_CREATION_USES_RENAMES;
651                 else if (!strcmp(value, "link"))
652                         object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
653                 else
654                         die("Invalid mode for object creation: %s", value);
655                 return 0;
656         }
658         if (!strcmp(var, "core.sparsecheckout")) {
659                 core_apply_sparse_checkout = git_config_bool(var, value);
660                 return 0;
661         }
663         /* Add other config variables here and to Documentation/config.txt. */
664         return 0;
667 static int git_default_user_config(const char *var, const char *value)
669         if (!strcmp(var, "user.name")) {
670                 if (!value)
671                         return config_error_nonbool(var);
672                 strlcpy(git_default_name, value, sizeof(git_default_name));
673                 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
674                 return 0;
675         }
677         if (!strcmp(var, "user.email")) {
678                 if (!value)
679                         return config_error_nonbool(var);
680                 strlcpy(git_default_email, value, sizeof(git_default_email));
681                 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
682                 return 0;
683         }
685         /* Add other config variables here and to Documentation/config.txt. */
686         return 0;
689 static int git_default_i18n_config(const char *var, const char *value)
691         if (!strcmp(var, "i18n.commitencoding"))
692                 return git_config_string(&git_commit_encoding, var, value);
694         if (!strcmp(var, "i18n.logoutputencoding"))
695                 return git_config_string(&git_log_output_encoding, var, value);
697         /* Add other config variables here and to Documentation/config.txt. */
698         return 0;
701 static int git_default_branch_config(const char *var, const char *value)
703         if (!strcmp(var, "branch.autosetupmerge")) {
704                 if (value && !strcasecmp(value, "always")) {
705                         git_branch_track = BRANCH_TRACK_ALWAYS;
706                         return 0;
707                 }
708                 git_branch_track = git_config_bool(var, value);
709                 return 0;
710         }
711         if (!strcmp(var, "branch.autosetuprebase")) {
712                 if (!value)
713                         return config_error_nonbool(var);
714                 else if (!strcmp(value, "never"))
715                         autorebase = AUTOREBASE_NEVER;
716                 else if (!strcmp(value, "local"))
717                         autorebase = AUTOREBASE_LOCAL;
718                 else if (!strcmp(value, "remote"))
719                         autorebase = AUTOREBASE_REMOTE;
720                 else if (!strcmp(value, "always"))
721                         autorebase = AUTOREBASE_ALWAYS;
722                 else
723                         return error("Malformed value for %s", var);
724                 return 0;
725         }
727         /* Add other config variables here and to Documentation/config.txt. */
728         return 0;
731 static int git_default_push_config(const char *var, const char *value)
733         if (!strcmp(var, "push.default")) {
734                 if (!value)
735                         return config_error_nonbool(var);
736                 else if (!strcmp(value, "nothing"))
737                         push_default = PUSH_DEFAULT_NOTHING;
738                 else if (!strcmp(value, "matching"))
739                         push_default = PUSH_DEFAULT_MATCHING;
740                 else if (!strcmp(value, "upstream"))
741                         push_default = PUSH_DEFAULT_UPSTREAM;
742                 else if (!strcmp(value, "tracking")) /* deprecated */
743                         push_default = PUSH_DEFAULT_UPSTREAM;
744                 else if (!strcmp(value, "current"))
745                         push_default = PUSH_DEFAULT_CURRENT;
746                 else {
747                         error("Malformed value for %s: %s", var, value);
748                         return error("Must be one of nothing, matching, "
749                                      "tracking or current.");
750                 }
751                 return 0;
752         }
754         /* Add other config variables here and to Documentation/config.txt. */
755         return 0;
758 static int git_default_mailmap_config(const char *var, const char *value)
760         if (!strcmp(var, "mailmap.file"))
761                 return git_config_string(&git_mailmap_file, var, value);
763         /* Add other config variables here and to Documentation/config.txt. */
764         return 0;
767 int git_default_config(const char *var, const char *value, void *dummy)
769         if (!prefixcmp(var, "core."))
770                 return git_default_core_config(var, value);
772         if (!prefixcmp(var, "user."))
773                 return git_default_user_config(var, value);
775         if (!prefixcmp(var, "i18n."))
776                 return git_default_i18n_config(var, value);
778         if (!prefixcmp(var, "branch."))
779                 return git_default_branch_config(var, value);
781         if (!prefixcmp(var, "push."))
782                 return git_default_push_config(var, value);
784         if (!prefixcmp(var, "mailmap."))
785                 return git_default_mailmap_config(var, value);
787         if (!prefixcmp(var, "advice."))
788                 return git_default_advice_config(var, value);
790         if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
791                 pager_use_color = git_config_bool(var,value);
792                 return 0;
793         }
795         /* Add other config variables here and to Documentation/config.txt. */
796         return 0;
799 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
801         int ret;
802         FILE *f = fopen(filename, "r");
804         ret = -1;
805         if (f) {
806                 config_file = f;
807                 config_file_name = filename;
808                 config_linenr = 1;
809                 config_file_eof = 0;
810                 ret = git_parse_file(fn, data);
811                 fclose(f);
812                 config_file_name = NULL;
813         }
814         return ret;
817 const char *git_etc_gitconfig(void)
819         static const char *system_wide;
820         if (!system_wide)
821                 system_wide = system_path(ETC_GITCONFIG);
822         return system_wide;
825 int git_env_bool(const char *k, int def)
827         const char *v = getenv(k);
828         return v ? git_config_bool(k, v) : def;
831 int git_config_system(void)
833         return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
836 int git_config_from_parameters(config_fn_t fn, void *data)
838         static int loaded_environment;
839         const struct config_item *ct;
841         if (!loaded_environment) {
842                 if (git_config_parse_environment() < 0)
843                         return -1;
844                 loaded_environment = 1;
845         }
846         for (ct = config_parameters; ct; ct = ct->next)
847                 if (fn(ct->name, ct->value, data) < 0)
848                         return -1;
849         return 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         ret += git_config_from_parameters(fn, data);
882         if (config_parameters)
883                 found += 1;
885         return ret == 0 ? found : ret;
888 int git_config(config_fn_t fn, void *data)
890         char *repo_config = NULL;
891         int ret;
893         repo_config = git_pathdup("config");
894         ret = git_config_early(fn, data, repo_config);
895         if (repo_config)
896                 free(repo_config);
897         return ret;
900 /*
901  * Find all the stuff for git_config_set() below.
902  */
904 #define MAX_MATCHES 512
906 static struct {
907         int baselen;
908         char *key;
909         int do_not_match;
910         regex_t *value_regex;
911         int multi_replace;
912         size_t offset[MAX_MATCHES];
913         enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
914         int seen;
915 } store;
917 static int matches(const char *key, const char *value)
919         return !strcmp(key, store.key) &&
920                 (store.value_regex == NULL ||
921                  (store.do_not_match ^
922                   !regexec(store.value_regex, value, 0, NULL, 0)));
925 static int store_aux(const char *key, const char *value, void *cb)
927         const char *ep;
928         size_t section_len;
930         switch (store.state) {
931         case KEY_SEEN:
932                 if (matches(key, value)) {
933                         if (store.seen == 1 && store.multi_replace == 0) {
934                                 warning("%s has multiple values", key);
935                         } else if (store.seen >= MAX_MATCHES) {
936                                 error("too many matches for %s", key);
937                                 return 1;
938                         }
940                         store.offset[store.seen] = ftell(config_file);
941                         store.seen++;
942                 }
943                 break;
944         case SECTION_SEEN:
945                 /*
946                  * What we are looking for is in store.key (both
947                  * section and var), and its section part is baselen
948                  * long.  We found key (again, both section and var).
949                  * We would want to know if this key is in the same
950                  * section as what we are looking for.  We already
951                  * know we are in the same section as what should
952                  * hold store.key.
953                  */
954                 ep = strrchr(key, '.');
955                 section_len = ep - key;
957                 if ((section_len != store.baselen) ||
958                     memcmp(key, store.key, section_len+1)) {
959                         store.state = SECTION_END_SEEN;
960                         break;
961                 }
963                 /*
964                  * Do not increment matches: this is no match, but we
965                  * just made sure we are in the desired section.
966                  */
967                 store.offset[store.seen] = ftell(config_file);
968                 /* fallthru */
969         case SECTION_END_SEEN:
970         case START:
971                 if (matches(key, value)) {
972                         store.offset[store.seen] = ftell(config_file);
973                         store.state = KEY_SEEN;
974                         store.seen++;
975                 } else {
976                         if (strrchr(key, '.') - key == store.baselen &&
977                               !strncmp(key, store.key, store.baselen)) {
978                                         store.state = SECTION_SEEN;
979                                         store.offset[store.seen] = ftell(config_file);
980                         }
981                 }
982         }
983         return 0;
986 static int write_error(const char *filename)
988         error("failed to write new configuration file %s", filename);
990         /* Same error code as "failed to rename". */
991         return 4;
994 static int store_write_section(int fd, const char *key)
996         const char *dot;
997         int i, success;
998         struct strbuf sb = STRBUF_INIT;
1000         dot = memchr(key, '.', store.baselen);
1001         if (dot) {
1002                 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1003                 for (i = dot - key + 1; i < store.baselen; i++) {
1004                         if (key[i] == '"' || key[i] == '\\')
1005                                 strbuf_addch(&sb, '\\');
1006                         strbuf_addch(&sb, key[i]);
1007                 }
1008                 strbuf_addstr(&sb, "\"]\n");
1009         } else {
1010                 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1011         }
1013         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1014         strbuf_release(&sb);
1016         return success;
1019 static int store_write_pair(int fd, const char *key, const char *value)
1021         int i, success;
1022         int length = strlen(key + store.baselen + 1);
1023         const char *quote = "";
1024         struct strbuf sb = STRBUF_INIT;
1026         /*
1027          * Check to see if the value needs to be surrounded with a dq pair.
1028          * Note that problematic characters are always backslash-quoted; this
1029          * check is about not losing leading or trailing SP and strings that
1030          * follow beginning-of-comment characters (i.e. ';' and '#') by the
1031          * configuration parser.
1032          */
1033         if (value[0] == ' ')
1034                 quote = "\"";
1035         for (i = 0; value[i]; i++)
1036                 if (value[i] == ';' || value[i] == '#')
1037                         quote = "\"";
1038         if (i && value[i - 1] == ' ')
1039                 quote = "\"";
1041         strbuf_addf(&sb, "\t%.*s = %s",
1042                     length, key + store.baselen + 1, quote);
1044         for (i = 0; value[i]; i++)
1045                 switch (value[i]) {
1046                 case '\n':
1047                         strbuf_addstr(&sb, "\\n");
1048                         break;
1049                 case '\t':
1050                         strbuf_addstr(&sb, "\\t");
1051                         break;
1052                 case '"':
1053                 case '\\':
1054                         strbuf_addch(&sb, '\\');
1055                 default:
1056                         strbuf_addch(&sb, value[i]);
1057                         break;
1058                 }
1059         strbuf_addf(&sb, "%s\n", quote);
1061         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1062         strbuf_release(&sb);
1064         return success;
1067 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1068         size_t offset_, int *found_bracket)
1070         size_t equal_offset = size, bracket_offset = size;
1071         ssize_t offset;
1073 contline:
1074         for (offset = offset_-2; offset > 0
1075                         && contents[offset] != '\n'; offset--)
1076                 switch (contents[offset]) {
1077                         case '=': equal_offset = offset; break;
1078                         case ']': bracket_offset = offset; break;
1079                 }
1080         if (offset > 0 && contents[offset-1] == '\\') {
1081                 offset_ = offset;
1082                 goto contline;
1083         }
1084         if (bracket_offset < equal_offset) {
1085                 *found_bracket = 1;
1086                 offset = bracket_offset+1;
1087         } else
1088                 offset++;
1090         return offset;
1093 int git_config_set(const char *key, const char *value)
1095         return git_config_set_multivar(key, value, NULL, 0);
1098 /*
1099  * Auxiliary function to sanity-check and split the key into the section
1100  * identifier and variable name.
1101  *
1102  * Returns 0 on success, -1 when there is an invalid character in the key and
1103  * -2 if there is no section name in the key.
1104  *
1105  * store_key - pointer to char* which will hold a copy of the key with
1106  *             lowercase section and variable name
1107  * baselen - pointer to int which will hold the length of the
1108  *           section + subsection part, can be NULL
1109  */
1110 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1112         int i, dot, baselen;
1113         const char *last_dot = strrchr(key, '.');
1115         /*
1116          * Since "key" actually contains the section name and the real
1117          * key name separated by a dot, we have to know where the dot is.
1118          */
1120         if (last_dot == NULL || last_dot == key) {
1121                 error("key does not contain a section: %s", key);
1122                 return -2;
1123         }
1125         if (!last_dot[1]) {
1126                 error("key does not contain variable name: %s", key);
1127                 return -2;
1128         }
1130         baselen = last_dot - key;
1131         if (baselen_)
1132                 *baselen_ = baselen;
1134         /*
1135          * Validate the key and while at it, lower case it for matching.
1136          */
1137         *store_key = xmalloc(strlen(key) + 1);
1139         dot = 0;
1140         for (i = 0; key[i]; i++) {
1141                 unsigned char c = key[i];
1142                 if (c == '.')
1143                         dot = 1;
1144                 /* Leave the extended basename untouched.. */
1145                 if (!dot || i > baselen) {
1146                         if (!iskeychar(c) ||
1147                             (i == baselen + 1 && !isalpha(c))) {
1148                                 error("invalid key: %s", key);
1149                                 goto out_free_ret_1;
1150                         }
1151                         c = tolower(c);
1152                 } else if (c == '\n') {
1153                         error("invalid key (newline): %s", key);
1154                         goto out_free_ret_1;
1155                 }
1156                 (*store_key)[i] = c;
1157         }
1158         (*store_key)[i] = 0;
1160         return 0;
1162 out_free_ret_1:
1163         free(*store_key);
1164         return -1;
1167 /*
1168  * If value==NULL, unset in (remove from) config,
1169  * if value_regex!=NULL, disregard key/value pairs where value does not match.
1170  * if multi_replace==0, nothing, or only one matching key/value is replaced,
1171  *     else all matching key/values (regardless how many) are removed,
1172  *     before the new pair is written.
1173  *
1174  * Returns 0 on success.
1175  *
1176  * This function does this:
1177  *
1178  * - it locks the config file by creating ".git/config.lock"
1179  *
1180  * - it then parses the config using store_aux() as validator to find
1181  *   the position on the key/value pair to replace. If it is to be unset,
1182  *   it must be found exactly once.
1183  *
1184  * - the config file is mmap()ed and the part before the match (if any) is
1185  *   written to the lock file, then the changed part and the rest.
1186  *
1187  * - the config file is removed and the lock file rename()d to it.
1188  *
1189  */
1190 int git_config_set_multivar(const char *key, const char *value,
1191         const char *value_regex, int multi_replace)
1193         int fd = -1, in_fd;
1194         int ret;
1195         char *config_filename;
1196         struct lock_file *lock = NULL;
1198         if (config_exclusive_filename)
1199                 config_filename = xstrdup(config_exclusive_filename);
1200         else
1201                 config_filename = git_pathdup("config");
1203         /* parse-key returns negative; flip the sign to feed exit(3) */
1204         ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1205         if (ret)
1206                 goto out_free;
1208         store.multi_replace = multi_replace;
1211         /*
1212          * The lock serves a purpose in addition to locking: the new
1213          * contents of .git/config will be written into it.
1214          */
1215         lock = xcalloc(sizeof(struct lock_file), 1);
1216         fd = hold_lock_file_for_update(lock, config_filename, 0);
1217         if (fd < 0) {
1218                 error("could not lock config file %s: %s", config_filename, strerror(errno));
1219                 free(store.key);
1220                 ret = -1;
1221                 goto out_free;
1222         }
1224         /*
1225          * If .git/config does not exist yet, write a minimal version.
1226          */
1227         in_fd = open(config_filename, O_RDONLY);
1228         if ( in_fd < 0 ) {
1229                 free(store.key);
1231                 if ( ENOENT != errno ) {
1232                         error("opening %s: %s", config_filename,
1233                               strerror(errno));
1234                         ret = 3; /* same as "invalid config file" */
1235                         goto out_free;
1236                 }
1237                 /* if nothing to unset, error out */
1238                 if (value == NULL) {
1239                         ret = 5;
1240                         goto out_free;
1241                 }
1243                 store.key = (char *)key;
1244                 if (!store_write_section(fd, key) ||
1245                     !store_write_pair(fd, key, value))
1246                         goto write_err_out;
1247         } else {
1248                 struct stat st;
1249                 char *contents;
1250                 size_t contents_sz, copy_begin, copy_end;
1251                 int i, new_line = 0;
1253                 if (value_regex == NULL)
1254                         store.value_regex = NULL;
1255                 else {
1256                         if (value_regex[0] == '!') {
1257                                 store.do_not_match = 1;
1258                                 value_regex++;
1259                         } else
1260                                 store.do_not_match = 0;
1262                         store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1263                         if (regcomp(store.value_regex, value_regex,
1264                                         REG_EXTENDED)) {
1265                                 error("invalid pattern: %s", value_regex);
1266                                 free(store.value_regex);
1267                                 ret = 6;
1268                                 goto out_free;
1269                         }
1270                 }
1272                 store.offset[0] = 0;
1273                 store.state = START;
1274                 store.seen = 0;
1276                 /*
1277                  * After this, store.offset will contain the *end* offset
1278                  * of the last match, or remain at 0 if no match was found.
1279                  * As a side effect, we make sure to transform only a valid
1280                  * existing config file.
1281                  */
1282                 if (git_config_from_file(store_aux, config_filename, NULL)) {
1283                         error("invalid config file %s", config_filename);
1284                         free(store.key);
1285                         if (store.value_regex != NULL) {
1286                                 regfree(store.value_regex);
1287                                 free(store.value_regex);
1288                         }
1289                         ret = 3;
1290                         goto out_free;
1291                 }
1293                 free(store.key);
1294                 if (store.value_regex != NULL) {
1295                         regfree(store.value_regex);
1296                         free(store.value_regex);
1297                 }
1299                 /* if nothing to unset, or too many matches, error out */
1300                 if ((store.seen == 0 && value == NULL) ||
1301                                 (store.seen > 1 && multi_replace == 0)) {
1302                         ret = 5;
1303                         goto out_free;
1304                 }
1306                 fstat(in_fd, &st);
1307                 contents_sz = xsize_t(st.st_size);
1308                 contents = xmmap(NULL, contents_sz, PROT_READ,
1309                         MAP_PRIVATE, in_fd, 0);
1310                 close(in_fd);
1312                 if (store.seen == 0)
1313                         store.seen = 1;
1315                 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1316                         if (store.offset[i] == 0) {
1317                                 store.offset[i] = copy_end = contents_sz;
1318                         } else if (store.state != KEY_SEEN) {
1319                                 copy_end = store.offset[i];
1320                         } else
1321                                 copy_end = find_beginning_of_line(
1322                                         contents, contents_sz,
1323                                         store.offset[i]-2, &new_line);
1325                         if (copy_end > 0 && contents[copy_end-1] != '\n')
1326                                 new_line = 1;
1328                         /* write the first part of the config */
1329                         if (copy_end > copy_begin) {
1330                                 if (write_in_full(fd, contents + copy_begin,
1331                                                   copy_end - copy_begin) <
1332                                     copy_end - copy_begin)
1333                                         goto write_err_out;
1334                                 if (new_line &&
1335                                     write_str_in_full(fd, "\n") != 1)
1336                                         goto write_err_out;
1337                         }
1338                         copy_begin = store.offset[i];
1339                 }
1341                 /* write the pair (value == NULL means unset) */
1342                 if (value != NULL) {
1343                         if (store.state == START) {
1344                                 if (!store_write_section(fd, key))
1345                                         goto write_err_out;
1346                         }
1347                         if (!store_write_pair(fd, key, value))
1348                                 goto write_err_out;
1349                 }
1351                 /* write the rest of the config */
1352                 if (copy_begin < contents_sz)
1353                         if (write_in_full(fd, contents + copy_begin,
1354                                           contents_sz - copy_begin) <
1355                             contents_sz - copy_begin)
1356                                 goto write_err_out;
1358                 munmap(contents, contents_sz);
1359         }
1361         if (commit_lock_file(lock) < 0) {
1362                 error("could not commit config file %s", config_filename);
1363                 ret = 4;
1364                 goto out_free;
1365         }
1367         /*
1368          * lock is committed, so don't try to roll it back below.
1369          * NOTE: Since lockfile.c keeps a linked list of all created
1370          * lock_file structures, it isn't safe to free(lock).  It's
1371          * better to just leave it hanging around.
1372          */
1373         lock = NULL;
1374         ret = 0;
1376 out_free:
1377         if (lock)
1378                 rollback_lock_file(lock);
1379         free(config_filename);
1380         return ret;
1382 write_err_out:
1383         ret = write_error(lock->filename);
1384         goto out_free;
1388 static int section_name_match (const char *buf, const char *name)
1390         int i = 0, j = 0, dot = 0;
1391         if (buf[i] != '[')
1392                 return 0;
1393         for (i = 1; buf[i] && buf[i] != ']'; i++) {
1394                 if (!dot && isspace(buf[i])) {
1395                         dot = 1;
1396                         if (name[j++] != '.')
1397                                 break;
1398                         for (i++; isspace(buf[i]); i++)
1399                                 ; /* do nothing */
1400                         if (buf[i] != '"')
1401                                 break;
1402                         continue;
1403                 }
1404                 if (buf[i] == '\\' && dot)
1405                         i++;
1406                 else if (buf[i] == '"' && dot) {
1407                         for (i++; isspace(buf[i]); i++)
1408                                 ; /* do_nothing */
1409                         break;
1410                 }
1411                 if (buf[i] != name[j++])
1412                         break;
1413         }
1414         if (buf[i] == ']' && name[j] == 0) {
1415                 /*
1416                  * We match, now just find the right length offset by
1417                  * gobbling up any whitespace after it, as well
1418                  */
1419                 i++;
1420                 for (; buf[i] && isspace(buf[i]); i++)
1421                         ; /* do nothing */
1422                 return i;
1423         }
1424         return 0;
1427 /* if new_name == NULL, the section is removed instead */
1428 int git_config_rename_section(const char *old_name, const char *new_name)
1430         int ret = 0, remove = 0;
1431         char *config_filename;
1432         struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1433         int out_fd;
1434         char buf[1024];
1436         if (config_exclusive_filename)
1437                 config_filename = xstrdup(config_exclusive_filename);
1438         else
1439                 config_filename = git_pathdup("config");
1440         out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1441         if (out_fd < 0) {
1442                 ret = error("could not lock config file %s", config_filename);
1443                 goto out;
1444         }
1446         if (!(config_file = fopen(config_filename, "rb"))) {
1447                 /* no config file means nothing to rename, no error */
1448                 goto unlock_and_out;
1449         }
1451         while (fgets(buf, sizeof(buf), config_file)) {
1452                 int i;
1453                 int length;
1454                 char *output = buf;
1455                 for (i = 0; buf[i] && isspace(buf[i]); i++)
1456                         ; /* do nothing */
1457                 if (buf[i] == '[') {
1458                         /* it's a section */
1459                         int offset = section_name_match(&buf[i], old_name);
1460                         if (offset > 0) {
1461                                 ret++;
1462                                 if (new_name == NULL) {
1463                                         remove = 1;
1464                                         continue;
1465                                 }
1466                                 store.baselen = strlen(new_name);
1467                                 if (!store_write_section(out_fd, new_name)) {
1468                                         ret = write_error(lock->filename);
1469                                         goto out;
1470                                 }
1471                                 /*
1472                                  * We wrote out the new section, with
1473                                  * a newline, now skip the old
1474                                  * section's length
1475                                  */
1476                                 output += offset + i;
1477                                 if (strlen(output) > 0) {
1478                                         /*
1479                                          * More content means there's
1480                                          * a declaration to put on the
1481                                          * next line; indent with a
1482                                          * tab
1483                                          */
1484                                         output -= 1;
1485                                         output[0] = '\t';
1486                                 }
1487                         }
1488                         remove = 0;
1489                 }
1490                 if (remove)
1491                         continue;
1492                 length = strlen(output);
1493                 if (write_in_full(out_fd, output, length) != length) {
1494                         ret = write_error(lock->filename);
1495                         goto out;
1496                 }
1497         }
1498         fclose(config_file);
1499  unlock_and_out:
1500         if (commit_lock_file(lock) < 0)
1501                 ret = error("could not commit config file %s", config_filename);
1502  out:
1503         free(config_filename);
1504         return ret;
1507 /*
1508  * Call this to report error for your variable that should not
1509  * get a boolean value (i.e. "[my] var" means "true").
1510  */
1511 int config_error_nonbool(const char *var)
1513         return error("Missing value for '%s'", var);