Code

Merge branch 'fc/parseopt-config'
[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"
11 #define MAXNAME (256)
13 static FILE *config_file;
14 static const char *config_file_name;
15 static int config_linenr;
16 static int config_file_eof;
17 static int zlib_compression_seen;
19 const char *config_exclusive_filename = NULL;
21 static int get_next_char(void)
22 {
23         int c;
24         FILE *f;
26         c = '\n';
27         if ((f = config_file) != NULL) {
28                 c = fgetc(f);
29                 if (c == '\r') {
30                         /* DOS like systems */
31                         c = fgetc(f);
32                         if (c != '\n') {
33                                 ungetc(c, f);
34                                 c = '\r';
35                         }
36                 }
37                 if (c == '\n')
38                         config_linenr++;
39                 if (c == EOF) {
40                         config_file_eof = 1;
41                         c = '\n';
42                 }
43         }
44         return c;
45 }
47 static char *parse_value(void)
48 {
49         static char value[1024];
50         int quote = 0, comment = 0, len = 0, space = 0;
52         for (;;) {
53                 int c = get_next_char();
54                 if (len >= sizeof(value))
55                         return NULL;
56                 if (c == '\n') {
57                         if (quote)
58                                 return NULL;
59                         value[len] = 0;
60                         return value;
61                 }
62                 if (comment)
63                         continue;
64                 if (isspace(c) && !quote) {
65                         space = 1;
66                         continue;
67                 }
68                 if (!quote) {
69                         if (c == ';' || c == '#') {
70                                 comment = 1;
71                                 continue;
72                         }
73                 }
74                 if (space) {
75                         if (len)
76                                 value[len++] = ' ';
77                         space = 0;
78                 }
79                 if (c == '\\') {
80                         c = get_next_char();
81                         switch (c) {
82                         case '\n':
83                                 continue;
84                         case 't':
85                                 c = '\t';
86                                 break;
87                         case 'b':
88                                 c = '\b';
89                                 break;
90                         case 'n':
91                                 c = '\n';
92                                 break;
93                         /* Some characters escape as themselves */
94                         case '\\': case '"':
95                                 break;
96                         /* Reject unknown escape sequences */
97                         default:
98                                 return NULL;
99                         }
100                         value[len++] = c;
101                         continue;
102                 }
103                 if (c == '"') {
104                         quote = 1-quote;
105                         continue;
106                 }
107                 value[len++] = c;
108         }
111 static inline int iskeychar(int c)
113         return isalnum(c) || c == '-';
116 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
118         int c;
119         char *value;
121         /* Get the full name */
122         for (;;) {
123                 c = get_next_char();
124                 if (config_file_eof)
125                         break;
126                 if (!iskeychar(c))
127                         break;
128                 name[len++] = tolower(c);
129                 if (len >= MAXNAME)
130                         return -1;
131         }
132         name[len] = 0;
133         while (c == ' ' || c == '\t')
134                 c = get_next_char();
136         value = NULL;
137         if (c != '\n') {
138                 if (c != '=')
139                         return -1;
140                 value = parse_value();
141                 if (!value)
142                         return -1;
143         }
144         return fn(name, value, data);
147 static int get_extended_base_var(char *name, int baselen, int c)
149         do {
150                 if (c == '\n')
151                         return -1;
152                 c = get_next_char();
153         } while (isspace(c));
155         /* We require the format to be '[base "extension"]' */
156         if (c != '"')
157                 return -1;
158         name[baselen++] = '.';
160         for (;;) {
161                 int c = get_next_char();
162                 if (c == '\n')
163                         return -1;
164                 if (c == '"')
165                         break;
166                 if (c == '\\') {
167                         c = get_next_char();
168                         if (c == '\n')
169                                 return -1;
170                 }
171                 name[baselen++] = c;
172                 if (baselen > MAXNAME / 2)
173                         return -1;
174         }
176         /* Final ']' */
177         if (get_next_char() != ']')
178                 return -1;
179         return baselen;
182 static int get_base_var(char *name)
184         int baselen = 0;
186         for (;;) {
187                 int c = get_next_char();
188                 if (config_file_eof)
189                         return -1;
190                 if (c == ']')
191                         return baselen;
192                 if (isspace(c))
193                         return get_extended_base_var(name, baselen, c);
194                 if (!iskeychar(c) && c != '.')
195                         return -1;
196                 if (baselen > MAXNAME / 2)
197                         return -1;
198                 name[baselen++] = tolower(c);
199         }
202 static int git_parse_file(config_fn_t fn, void *data)
204         int comment = 0;
205         int baselen = 0;
206         static char var[MAXNAME];
208         /* U+FEFF Byte Order Mark in UTF8 */
209         static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
210         const unsigned char *bomptr = utf8_bom;
212         for (;;) {
213                 int c = get_next_char();
214                 if (bomptr && *bomptr) {
215                         /* We are at the file beginning; skip UTF8-encoded BOM
216                          * if present. Sane editors won't put this in on their
217                          * own, but e.g. Windows Notepad will do it happily. */
218                         if ((unsigned char) c == *bomptr) {
219                                 bomptr++;
220                                 continue;
221                         } else {
222                                 /* Do not tolerate partial BOM. */
223                                 if (bomptr != utf8_bom)
224                                         break;
225                                 /* No BOM at file beginning. Cool. */
226                                 bomptr = NULL;
227                         }
228                 }
229                 if (c == '\n') {
230                         if (config_file_eof)
231                                 return 0;
232                         comment = 0;
233                         continue;
234                 }
235                 if (comment || isspace(c))
236                         continue;
237                 if (c == '#' || c == ';') {
238                         comment = 1;
239                         continue;
240                 }
241                 if (c == '[') {
242                         baselen = get_base_var(var);
243                         if (baselen <= 0)
244                                 break;
245                         var[baselen++] = '.';
246                         var[baselen] = 0;
247                         continue;
248                 }
249                 if (!isalpha(c))
250                         break;
251                 var[baselen] = tolower(c);
252                 if (get_value(fn, data, var, baselen+1) < 0)
253                         break;
254         }
255         die("bad config file line %d in %s", config_linenr, config_file_name);
258 static int parse_unit_factor(const char *end, unsigned long *val)
260         if (!*end)
261                 return 1;
262         else if (!strcasecmp(end, "k")) {
263                 *val *= 1024;
264                 return 1;
265         }
266         else if (!strcasecmp(end, "m")) {
267                 *val *= 1024 * 1024;
268                 return 1;
269         }
270         else if (!strcasecmp(end, "g")) {
271                 *val *= 1024 * 1024 * 1024;
272                 return 1;
273         }
274         return 0;
277 static int git_parse_long(const char *value, long *ret)
279         if (value && *value) {
280                 char *end;
281                 long val = strtol(value, &end, 0);
282                 unsigned long factor = 1;
283                 if (!parse_unit_factor(end, &factor))
284                         return 0;
285                 *ret = val * factor;
286                 return 1;
287         }
288         return 0;
291 int git_parse_ulong(const char *value, unsigned long *ret)
293         if (value && *value) {
294                 char *end;
295                 unsigned long val = strtoul(value, &end, 0);
296                 if (!parse_unit_factor(end, &val))
297                         return 0;
298                 *ret = val;
299                 return 1;
300         }
301         return 0;
304 static void die_bad_config(const char *name)
306         if (config_file_name)
307                 die("bad config value for '%s' in %s", name, config_file_name);
308         die("bad config value for '%s'", name);
311 int git_config_int(const char *name, const char *value)
313         long ret = 0;
314         if (!git_parse_long(value, &ret))
315                 die_bad_config(name);
316         return ret;
319 unsigned long git_config_ulong(const char *name, const char *value)
321         unsigned long ret;
322         if (!git_parse_ulong(value, &ret))
323                 die_bad_config(name);
324         return ret;
327 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
329         *is_bool = 1;
330         if (!value)
331                 return 1;
332         if (!*value)
333                 return 0;
334         if (!strcasecmp(value, "true") || !strcasecmp(value, "yes"))
335                 return 1;
336         if (!strcasecmp(value, "false") || !strcasecmp(value, "no"))
337                 return 0;
338         *is_bool = 0;
339         return git_config_int(name, value);
342 int git_config_bool(const char *name, const char *value)
344         int discard;
345         return !!git_config_bool_or_int(name, value, &discard);
348 int git_config_string(const char **dest, const char *var, const char *value)
350         if (!value)
351                 return config_error_nonbool(var);
352         *dest = xstrdup(value);
353         return 0;
356 static int git_default_core_config(const char *var, const char *value)
358         /* This needs a better name */
359         if (!strcmp(var, "core.filemode")) {
360                 trust_executable_bit = git_config_bool(var, value);
361                 return 0;
362         }
363         if (!strcmp(var, "core.trustctime")) {
364                 trust_ctime = git_config_bool(var, value);
365                 return 0;
366         }
368         if (!strcmp(var, "core.quotepath")) {
369                 quote_path_fully = git_config_bool(var, value);
370                 return 0;
371         }
373         if (!strcmp(var, "core.symlinks")) {
374                 has_symlinks = git_config_bool(var, value);
375                 return 0;
376         }
378         if (!strcmp(var, "core.ignorecase")) {
379                 ignore_case = git_config_bool(var, value);
380                 return 0;
381         }
383         if (!strcmp(var, "core.bare")) {
384                 is_bare_repository_cfg = git_config_bool(var, value);
385                 return 0;
386         }
388         if (!strcmp(var, "core.ignorestat")) {
389                 assume_unchanged = git_config_bool(var, value);
390                 return 0;
391         }
393         if (!strcmp(var, "core.prefersymlinkrefs")) {
394                 prefer_symlink_refs = git_config_bool(var, value);
395                 return 0;
396         }
398         if (!strcmp(var, "core.logallrefupdates")) {
399                 log_all_ref_updates = git_config_bool(var, value);
400                 return 0;
401         }
403         if (!strcmp(var, "core.warnambiguousrefs")) {
404                 warn_ambiguous_refs = git_config_bool(var, value);
405                 return 0;
406         }
408         if (!strcmp(var, "core.loosecompression")) {
409                 int level = git_config_int(var, value);
410                 if (level == -1)
411                         level = Z_DEFAULT_COMPRESSION;
412                 else if (level < 0 || level > Z_BEST_COMPRESSION)
413                         die("bad zlib compression level %d", level);
414                 zlib_compression_level = level;
415                 zlib_compression_seen = 1;
416                 return 0;
417         }
419         if (!strcmp(var, "core.compression")) {
420                 int level = git_config_int(var, value);
421                 if (level == -1)
422                         level = Z_DEFAULT_COMPRESSION;
423                 else if (level < 0 || level > Z_BEST_COMPRESSION)
424                         die("bad zlib compression level %d", level);
425                 core_compression_level = level;
426                 core_compression_seen = 1;
427                 if (!zlib_compression_seen)
428                         zlib_compression_level = level;
429                 return 0;
430         }
432         if (!strcmp(var, "core.packedgitwindowsize")) {
433                 int pgsz_x2 = getpagesize() * 2;
434                 packed_git_window_size = git_config_int(var, value);
436                 /* This value must be multiple of (pagesize * 2) */
437                 packed_git_window_size /= pgsz_x2;
438                 if (packed_git_window_size < 1)
439                         packed_git_window_size = 1;
440                 packed_git_window_size *= pgsz_x2;
441                 return 0;
442         }
444         if (!strcmp(var, "core.packedgitlimit")) {
445                 packed_git_limit = git_config_int(var, value);
446                 return 0;
447         }
449         if (!strcmp(var, "core.deltabasecachelimit")) {
450                 delta_base_cache_limit = git_config_int(var, value);
451                 return 0;
452         }
454         if (!strcmp(var, "core.autocrlf")) {
455                 if (value && !strcasecmp(value, "input")) {
456                         auto_crlf = -1;
457                         return 0;
458                 }
459                 auto_crlf = git_config_bool(var, value);
460                 return 0;
461         }
463         if (!strcmp(var, "core.safecrlf")) {
464                 if (value && !strcasecmp(value, "warn")) {
465                         safe_crlf = SAFE_CRLF_WARN;
466                         return 0;
467                 }
468                 safe_crlf = git_config_bool(var, value);
469                 return 0;
470         }
472         if (!strcmp(var, "core.pager"))
473                 return git_config_string(&pager_program, var, value);
475         if (!strcmp(var, "core.editor"))
476                 return git_config_string(&editor_program, var, value);
478         if (!strcmp(var, "core.excludesfile"))
479                 return git_config_string(&excludes_file, var, value);
481         if (!strcmp(var, "core.whitespace")) {
482                 if (!value)
483                         return config_error_nonbool(var);
484                 whitespace_rule_cfg = parse_whitespace_rule(value);
485                 return 0;
486         }
488         if (!strcmp(var, "core.fsyncobjectfiles")) {
489                 fsync_object_files = git_config_bool(var, value);
490                 return 0;
491         }
493         if (!strcmp(var, "core.preloadindex")) {
494                 core_preload_index = git_config_bool(var, value);
495                 return 0;
496         }
498         /* Add other config variables here and to Documentation/config.txt. */
499         return 0;
502 static int git_default_user_config(const char *var, const char *value)
504         if (!strcmp(var, "user.name")) {
505                 if (!value)
506                         return config_error_nonbool(var);
507                 strlcpy(git_default_name, value, sizeof(git_default_name));
508                 if (git_default_email[0])
509                         user_ident_explicitly_given = 1;
510                 return 0;
511         }
513         if (!strcmp(var, "user.email")) {
514                 if (!value)
515                         return config_error_nonbool(var);
516                 strlcpy(git_default_email, value, sizeof(git_default_email));
517                 if (git_default_name[0])
518                         user_ident_explicitly_given = 1;
519                 return 0;
520         }
522         /* Add other config variables here and to Documentation/config.txt. */
523         return 0;
526 static int git_default_i18n_config(const char *var, const char *value)
528         if (!strcmp(var, "i18n.commitencoding"))
529                 return git_config_string(&git_commit_encoding, var, value);
531         if (!strcmp(var, "i18n.logoutputencoding"))
532                 return git_config_string(&git_log_output_encoding, var, value);
534         /* Add other config variables here and to Documentation/config.txt. */
535         return 0;
538 static int git_default_branch_config(const char *var, const char *value)
540         if (!strcmp(var, "branch.autosetupmerge")) {
541                 if (value && !strcasecmp(value, "always")) {
542                         git_branch_track = BRANCH_TRACK_ALWAYS;
543                         return 0;
544                 }
545                 git_branch_track = git_config_bool(var, value);
546                 return 0;
547         }
548         if (!strcmp(var, "branch.autosetuprebase")) {
549                 if (!value)
550                         return config_error_nonbool(var);
551                 else if (!strcmp(value, "never"))
552                         autorebase = AUTOREBASE_NEVER;
553                 else if (!strcmp(value, "local"))
554                         autorebase = AUTOREBASE_LOCAL;
555                 else if (!strcmp(value, "remote"))
556                         autorebase = AUTOREBASE_REMOTE;
557                 else if (!strcmp(value, "always"))
558                         autorebase = AUTOREBASE_ALWAYS;
559                 else
560                         return error("Malformed value for %s", var);
561                 return 0;
562         }
564         /* Add other config variables here and to Documentation/config.txt. */
565         return 0;
568 static int git_default_mailmap_config(const char *var, const char *value)
570         if (!strcmp(var, "mailmap.file"))
571                 return git_config_string(&git_mailmap_file, var, value);
573         /* Add other config variables here and to Documentation/config.txt. */
574         return 0;
577 int git_default_config(const char *var, const char *value, void *dummy)
579         if (!prefixcmp(var, "core."))
580                 return git_default_core_config(var, value);
582         if (!prefixcmp(var, "user."))
583                 return git_default_user_config(var, value);
585         if (!prefixcmp(var, "i18n."))
586                 return git_default_i18n_config(var, value);
588         if (!prefixcmp(var, "branch."))
589                 return git_default_branch_config(var, value);
591         if (!prefixcmp(var, "mailmap."))
592                 return git_default_mailmap_config(var, value);
594         if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
595                 pager_use_color = git_config_bool(var,value);
596                 return 0;
597         }
599         /* Add other config variables here and to Documentation/config.txt. */
600         return 0;
603 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
605         int ret;
606         FILE *f = fopen(filename, "r");
608         ret = -1;
609         if (f) {
610                 config_file = f;
611                 config_file_name = filename;
612                 config_linenr = 1;
613                 config_file_eof = 0;
614                 ret = git_parse_file(fn, data);
615                 fclose(f);
616                 config_file_name = NULL;
617         }
618         return ret;
621 const char *git_etc_gitconfig(void)
623         static const char *system_wide;
624         if (!system_wide)
625                 system_wide = system_path(ETC_GITCONFIG);
626         return system_wide;
629 static int git_env_bool(const char *k, int def)
631         const char *v = getenv(k);
632         return v ? git_config_bool(k, v) : def;
635 int git_config_system(void)
637         return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
640 int git_config_global(void)
642         return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
645 int git_config(config_fn_t fn, void *data)
647         int ret = 0, found = 0;
648         char *repo_config = NULL;
649         const char *home = NULL;
651         /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
652         if (config_exclusive_filename)
653                 return git_config_from_file(fn, config_exclusive_filename, data);
654         if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
655                 ret += git_config_from_file(fn, git_etc_gitconfig(),
656                                             data);
657                 found += 1;
658         }
660         home = getenv("HOME");
661         if (git_config_global() && home) {
662                 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
663                 if (!access(user_config, R_OK)) {
664                         ret += git_config_from_file(fn, user_config, data);
665                         found += 1;
666                 }
667                 free(user_config);
668         }
670         repo_config = git_pathdup("config");
671         if (!access(repo_config, R_OK)) {
672                 ret += git_config_from_file(fn, repo_config, data);
673                 found += 1;
674         }
675         free(repo_config);
676         if (found == 0)
677                 return -1;
678         return ret;
681 /*
682  * Find all the stuff for git_config_set() below.
683  */
685 #define MAX_MATCHES 512
687 static struct {
688         int baselen;
689         char* key;
690         int do_not_match;
691         regex_t* value_regex;
692         int multi_replace;
693         size_t offset[MAX_MATCHES];
694         enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
695         int seen;
696 } store;
698 static int matches(const char* key, const char* value)
700         return !strcmp(key, store.key) &&
701                 (store.value_regex == NULL ||
702                  (store.do_not_match ^
703                   !regexec(store.value_regex, value, 0, NULL, 0)));
706 static int store_aux(const char* key, const char* value, void *cb)
708         const char *ep;
709         size_t section_len;
711         switch (store.state) {
712         case KEY_SEEN:
713                 if (matches(key, value)) {
714                         if (store.seen == 1 && store.multi_replace == 0) {
715                                 warning("%s has multiple values", key);
716                         } else if (store.seen >= MAX_MATCHES) {
717                                 error("too many matches for %s", key);
718                                 return 1;
719                         }
721                         store.offset[store.seen] = ftell(config_file);
722                         store.seen++;
723                 }
724                 break;
725         case SECTION_SEEN:
726                 /*
727                  * What we are looking for is in store.key (both
728                  * section and var), and its section part is baselen
729                  * long.  We found key (again, both section and var).
730                  * We would want to know if this key is in the same
731                  * section as what we are looking for.  We already
732                  * know we are in the same section as what should
733                  * hold store.key.
734                  */
735                 ep = strrchr(key, '.');
736                 section_len = ep - key;
738                 if ((section_len != store.baselen) ||
739                     memcmp(key, store.key, section_len+1)) {
740                         store.state = SECTION_END_SEEN;
741                         break;
742                 }
744                 /*
745                  * Do not increment matches: this is no match, but we
746                  * just made sure we are in the desired section.
747                  */
748                 store.offset[store.seen] = ftell(config_file);
749                 /* fallthru */
750         case SECTION_END_SEEN:
751         case START:
752                 if (matches(key, value)) {
753                         store.offset[store.seen] = ftell(config_file);
754                         store.state = KEY_SEEN;
755                         store.seen++;
756                 } else {
757                         if (strrchr(key, '.') - key == store.baselen &&
758                               !strncmp(key, store.key, store.baselen)) {
759                                         store.state = SECTION_SEEN;
760                                         store.offset[store.seen] = ftell(config_file);
761                         }
762                 }
763         }
764         return 0;
767 static int write_error(const char *filename)
769         error("failed to write new configuration file %s", filename);
771         /* Same error code as "failed to rename". */
772         return 4;
775 static int store_write_section(int fd, const char* key)
777         const char *dot;
778         int i, success;
779         struct strbuf sb = STRBUF_INIT;
781         dot = memchr(key, '.', store.baselen);
782         if (dot) {
783                 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
784                 for (i = dot - key + 1; i < store.baselen; i++) {
785                         if (key[i] == '"' || key[i] == '\\')
786                                 strbuf_addch(&sb, '\\');
787                         strbuf_addch(&sb, key[i]);
788                 }
789                 strbuf_addstr(&sb, "\"]\n");
790         } else {
791                 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
792         }
794         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
795         strbuf_release(&sb);
797         return success;
800 static int store_write_pair(int fd, const char* key, const char* value)
802         int i, success;
803         int length = strlen(key + store.baselen + 1);
804         const char *quote = "";
805         struct strbuf sb = STRBUF_INIT;
807         /*
808          * Check to see if the value needs to be surrounded with a dq pair.
809          * Note that problematic characters are always backslash-quoted; this
810          * check is about not losing leading or trailing SP and strings that
811          * follow beginning-of-comment characters (i.e. ';' and '#') by the
812          * configuration parser.
813          */
814         if (value[0] == ' ')
815                 quote = "\"";
816         for (i = 0; value[i]; i++)
817                 if (value[i] == ';' || value[i] == '#')
818                         quote = "\"";
819         if (i && value[i - 1] == ' ')
820                 quote = "\"";
822         strbuf_addf(&sb, "\t%.*s = %s",
823                     length, key + store.baselen + 1, quote);
825         for (i = 0; value[i]; i++)
826                 switch (value[i]) {
827                 case '\n':
828                         strbuf_addstr(&sb, "\\n");
829                         break;
830                 case '\t':
831                         strbuf_addstr(&sb, "\\t");
832                         break;
833                 case '"':
834                 case '\\':
835                         strbuf_addch(&sb, '\\');
836                 default:
837                         strbuf_addch(&sb, value[i]);
838                         break;
839                 }
840         strbuf_addf(&sb, "%s\n", quote);
842         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
843         strbuf_release(&sb);
845         return success;
848 static ssize_t find_beginning_of_line(const char* contents, size_t size,
849         size_t offset_, int* found_bracket)
851         size_t equal_offset = size, bracket_offset = size;
852         ssize_t offset;
854 contline:
855         for (offset = offset_-2; offset > 0
856                         && contents[offset] != '\n'; offset--)
857                 switch (contents[offset]) {
858                         case '=': equal_offset = offset; break;
859                         case ']': bracket_offset = offset; break;
860                 }
861         if (offset > 0 && contents[offset-1] == '\\') {
862                 offset_ = offset;
863                 goto contline;
864         }
865         if (bracket_offset < equal_offset) {
866                 *found_bracket = 1;
867                 offset = bracket_offset+1;
868         } else
869                 offset++;
871         return offset;
874 int git_config_set(const char* key, const char* value)
876         return git_config_set_multivar(key, value, NULL, 0);
879 /*
880  * If value==NULL, unset in (remove from) config,
881  * if value_regex!=NULL, disregard key/value pairs where value does not match.
882  * if multi_replace==0, nothing, or only one matching key/value is replaced,
883  *     else all matching key/values (regardless how many) are removed,
884  *     before the new pair is written.
885  *
886  * Returns 0 on success.
887  *
888  * This function does this:
889  *
890  * - it locks the config file by creating ".git/config.lock"
891  *
892  * - it then parses the config using store_aux() as validator to find
893  *   the position on the key/value pair to replace. If it is to be unset,
894  *   it must be found exactly once.
895  *
896  * - the config file is mmap()ed and the part before the match (if any) is
897  *   written to the lock file, then the changed part and the rest.
898  *
899  * - the config file is removed and the lock file rename()d to it.
900  *
901  */
902 int git_config_set_multivar(const char* key, const char* value,
903         const char* value_regex, int multi_replace)
905         int i, dot;
906         int fd = -1, in_fd;
907         int ret;
908         char* config_filename;
909         struct lock_file *lock = NULL;
910         const char* last_dot = strrchr(key, '.');
912         if (config_exclusive_filename)
913                 config_filename = xstrdup(config_exclusive_filename);
914         else
915                 config_filename = git_pathdup("config");
917         /*
918          * Since "key" actually contains the section name and the real
919          * key name separated by a dot, we have to know where the dot is.
920          */
922         if (last_dot == NULL) {
923                 error("key does not contain a section: %s", key);
924                 ret = 2;
925                 goto out_free;
926         }
927         store.baselen = last_dot - key;
929         store.multi_replace = multi_replace;
931         /*
932          * Validate the key and while at it, lower case it for matching.
933          */
934         store.key = xmalloc(strlen(key) + 1);
935         dot = 0;
936         for (i = 0; key[i]; i++) {
937                 unsigned char c = key[i];
938                 if (c == '.')
939                         dot = 1;
940                 /* Leave the extended basename untouched.. */
941                 if (!dot || i > store.baselen) {
942                         if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
943                                 error("invalid key: %s", key);
944                                 free(store.key);
945                                 ret = 1;
946                                 goto out_free;
947                         }
948                         c = tolower(c);
949                 } else if (c == '\n') {
950                         error("invalid key (newline): %s", key);
951                         free(store.key);
952                         ret = 1;
953                         goto out_free;
954                 }
955                 store.key[i] = c;
956         }
957         store.key[i] = 0;
959         /*
960          * The lock serves a purpose in addition to locking: the new
961          * contents of .git/config will be written into it.
962          */
963         lock = xcalloc(sizeof(struct lock_file), 1);
964         fd = hold_lock_file_for_update(lock, config_filename, 0);
965         if (fd < 0) {
966                 error("could not lock config file %s", config_filename);
967                 free(store.key);
968                 ret = -1;
969                 goto out_free;
970         }
972         /*
973          * If .git/config does not exist yet, write a minimal version.
974          */
975         in_fd = open(config_filename, O_RDONLY);
976         if ( in_fd < 0 ) {
977                 free(store.key);
979                 if ( ENOENT != errno ) {
980                         error("opening %s: %s", config_filename,
981                               strerror(errno));
982                         ret = 3; /* same as "invalid config file" */
983                         goto out_free;
984                 }
985                 /* if nothing to unset, error out */
986                 if (value == NULL) {
987                         ret = 5;
988                         goto out_free;
989                 }
991                 store.key = (char*)key;
992                 if (!store_write_section(fd, key) ||
993                     !store_write_pair(fd, key, value))
994                         goto write_err_out;
995         } else {
996                 struct stat st;
997                 char* contents;
998                 size_t contents_sz, copy_begin, copy_end;
999                 int i, new_line = 0;
1001                 if (value_regex == NULL)
1002                         store.value_regex = NULL;
1003                 else {
1004                         if (value_regex[0] == '!') {
1005                                 store.do_not_match = 1;
1006                                 value_regex++;
1007                         } else
1008                                 store.do_not_match = 0;
1010                         store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1011                         if (regcomp(store.value_regex, value_regex,
1012                                         REG_EXTENDED)) {
1013                                 error("invalid pattern: %s", value_regex);
1014                                 free(store.value_regex);
1015                                 ret = 6;
1016                                 goto out_free;
1017                         }
1018                 }
1020                 store.offset[0] = 0;
1021                 store.state = START;
1022                 store.seen = 0;
1024                 /*
1025                  * After this, store.offset will contain the *end* offset
1026                  * of the last match, or remain at 0 if no match was found.
1027                  * As a side effect, we make sure to transform only a valid
1028                  * existing config file.
1029                  */
1030                 if (git_config_from_file(store_aux, config_filename, NULL)) {
1031                         error("invalid config file %s", config_filename);
1032                         free(store.key);
1033                         if (store.value_regex != NULL) {
1034                                 regfree(store.value_regex);
1035                                 free(store.value_regex);
1036                         }
1037                         ret = 3;
1038                         goto out_free;
1039                 }
1041                 free(store.key);
1042                 if (store.value_regex != NULL) {
1043                         regfree(store.value_regex);
1044                         free(store.value_regex);
1045                 }
1047                 /* if nothing to unset, or too many matches, error out */
1048                 if ((store.seen == 0 && value == NULL) ||
1049                                 (store.seen > 1 && multi_replace == 0)) {
1050                         ret = 5;
1051                         goto out_free;
1052                 }
1054                 fstat(in_fd, &st);
1055                 contents_sz = xsize_t(st.st_size);
1056                 contents = xmmap(NULL, contents_sz, PROT_READ,
1057                         MAP_PRIVATE, in_fd, 0);
1058                 close(in_fd);
1060                 if (store.seen == 0)
1061                         store.seen = 1;
1063                 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1064                         if (store.offset[i] == 0) {
1065                                 store.offset[i] = copy_end = contents_sz;
1066                         } else if (store.state != KEY_SEEN) {
1067                                 copy_end = store.offset[i];
1068                         } else
1069                                 copy_end = find_beginning_of_line(
1070                                         contents, contents_sz,
1071                                         store.offset[i]-2, &new_line);
1073                         if (copy_end > 0 && contents[copy_end-1] != '\n')
1074                                 new_line = 1;
1076                         /* write the first part of the config */
1077                         if (copy_end > copy_begin) {
1078                                 if (write_in_full(fd, contents + copy_begin,
1079                                                   copy_end - copy_begin) <
1080                                     copy_end - copy_begin)
1081                                         goto write_err_out;
1082                                 if (new_line &&
1083                                     write_in_full(fd, "\n", 1) != 1)
1084                                         goto write_err_out;
1085                         }
1086                         copy_begin = store.offset[i];
1087                 }
1089                 /* write the pair (value == NULL means unset) */
1090                 if (value != NULL) {
1091                         if (store.state == START) {
1092                                 if (!store_write_section(fd, key))
1093                                         goto write_err_out;
1094                         }
1095                         if (!store_write_pair(fd, key, value))
1096                                 goto write_err_out;
1097                 }
1099                 /* write the rest of the config */
1100                 if (copy_begin < contents_sz)
1101                         if (write_in_full(fd, contents + copy_begin,
1102                                           contents_sz - copy_begin) <
1103                             contents_sz - copy_begin)
1104                                 goto write_err_out;
1106                 munmap(contents, contents_sz);
1107         }
1109         if (commit_lock_file(lock) < 0) {
1110                 error("could not commit config file %s", config_filename);
1111                 ret = 4;
1112                 goto out_free;
1113         }
1115         /*
1116          * lock is committed, so don't try to roll it back below.
1117          * NOTE: Since lockfile.c keeps a linked list of all created
1118          * lock_file structures, it isn't safe to free(lock).  It's
1119          * better to just leave it hanging around.
1120          */
1121         lock = NULL;
1122         ret = 0;
1124 out_free:
1125         if (lock)
1126                 rollback_lock_file(lock);
1127         free(config_filename);
1128         return ret;
1130 write_err_out:
1131         ret = write_error(lock->filename);
1132         goto out_free;
1136 static int section_name_match (const char *buf, const char *name)
1138         int i = 0, j = 0, dot = 0;
1139         for (; buf[i] && buf[i] != ']'; i++) {
1140                 if (!dot && isspace(buf[i])) {
1141                         dot = 1;
1142                         if (name[j++] != '.')
1143                                 break;
1144                         for (i++; isspace(buf[i]); i++)
1145                                 ; /* do nothing */
1146                         if (buf[i] != '"')
1147                                 break;
1148                         continue;
1149                 }
1150                 if (buf[i] == '\\' && dot)
1151                         i++;
1152                 else if (buf[i] == '"' && dot) {
1153                         for (i++; isspace(buf[i]); i++)
1154                                 ; /* do_nothing */
1155                         break;
1156                 }
1157                 if (buf[i] != name[j++])
1158                         break;
1159         }
1160         return (buf[i] == ']' && name[j] == 0);
1163 /* if new_name == NULL, the section is removed instead */
1164 int git_config_rename_section(const char *old_name, const char *new_name)
1166         int ret = 0, remove = 0;
1167         char *config_filename;
1168         struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1169         int out_fd;
1170         char buf[1024];
1172         if (config_exclusive_filename)
1173                 config_filename = xstrdup(config_exclusive_filename);
1174         else
1175                 config_filename = git_pathdup("config");
1176         out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1177         if (out_fd < 0) {
1178                 ret = error("could not lock config file %s", config_filename);
1179                 goto out;
1180         }
1182         if (!(config_file = fopen(config_filename, "rb"))) {
1183                 /* no config file means nothing to rename, no error */
1184                 goto unlock_and_out;
1185         }
1187         while (fgets(buf, sizeof(buf), config_file)) {
1188                 int i;
1189                 int length;
1190                 for (i = 0; buf[i] && isspace(buf[i]); i++)
1191                         ; /* do nothing */
1192                 if (buf[i] == '[') {
1193                         /* it's a section */
1194                         if (section_name_match (&buf[i+1], old_name)) {
1195                                 ret++;
1196                                 if (new_name == NULL) {
1197                                         remove = 1;
1198                                         continue;
1199                                 }
1200                                 store.baselen = strlen(new_name);
1201                                 if (!store_write_section(out_fd, new_name)) {
1202                                         ret = write_error(lock->filename);
1203                                         goto out;
1204                                 }
1205                                 continue;
1206                         }
1207                         remove = 0;
1208                 }
1209                 if (remove)
1210                         continue;
1211                 length = strlen(buf);
1212                 if (write_in_full(out_fd, buf, length) != length) {
1213                         ret = write_error(lock->filename);
1214                         goto out;
1215                 }
1216         }
1217         fclose(config_file);
1218  unlock_and_out:
1219         if (commit_lock_file(lock) < 0)
1220                 ret = error("could not commit config file %s", config_filename);
1221  out:
1222         free(config_filename);
1223         return ret;
1226 /*
1227  * Call this to report error for your variable that should not
1228  * get a boolean value (i.e. "[my] var" means "true").
1229  */
1230 int config_error_nonbool(const char *var)
1232         return error("Missing value for '%s'", var);