Code

Refactor print-functions in builtin-branch
[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"
10 #define MAXNAME (256)
12 static FILE *config_file;
13 static const char *config_file_name;
14 static int config_linenr;
15 static int get_next_char(void)
16 {
17         int c;
18         FILE *f;
20         c = '\n';
21         if ((f = config_file) != NULL) {
22                 c = fgetc(f);
23                 if (c == '\r') {
24                         /* DOS like systems */
25                         c = fgetc(f);
26                         if (c != '\n') {
27                                 ungetc(c, f);
28                                 c = '\r';
29                         }
30                 }
31                 if (c == '\n')
32                         config_linenr++;
33                 if (c == EOF) {
34                         config_file = NULL;
35                         c = '\n';
36                 }
37         }
38         return c;
39 }
41 static char *parse_value(void)
42 {
43         static char value[1024];
44         int quote = 0, comment = 0, len = 0, space = 0;
46         for (;;) {
47                 int c = get_next_char();
48                 if (len >= sizeof(value))
49                         return NULL;
50                 if (c == '\n') {
51                         if (quote)
52                                 return NULL;
53                         value[len] = 0;
54                         return value;
55                 }
56                 if (comment)
57                         continue;
58                 if (isspace(c) && !quote) {
59                         space = 1;
60                         continue;
61                 }
62                 if (!quote) {
63                         if (c == ';' || c == '#') {
64                                 comment = 1;
65                                 continue;
66                         }
67                 }
68                 if (space) {
69                         if (len)
70                                 value[len++] = ' ';
71                         space = 0;
72                 }
73                 if (c == '\\') {
74                         c = get_next_char();
75                         switch (c) {
76                         case '\n':
77                                 continue;
78                         case 't':
79                                 c = '\t';
80                                 break;
81                         case 'b':
82                                 c = '\b';
83                                 break;
84                         case 'n':
85                                 c = '\n';
86                                 break;
87                         /* Some characters escape as themselves */
88                         case '\\': case '"':
89                                 break;
90                         /* Reject unknown escape sequences */
91                         default:
92                                 return NULL;
93                         }
94                         value[len++] = c;
95                         continue;
96                 }
97                 if (c == '"') {
98                         quote = 1-quote;
99                         continue;
100                 }
101                 value[len++] = c;
102         }
105 static inline int iskeychar(int c)
107         return isalnum(c) || c == '-';
110 static int get_value(config_fn_t fn, char *name, unsigned int len)
112         int c;
113         char *value;
115         /* Get the full name */
116         for (;;) {
117                 c = get_next_char();
118                 if (c == EOF)
119                         break;
120                 if (!iskeychar(c))
121                         break;
122                 name[len++] = tolower(c);
123                 if (len >= MAXNAME)
124                         return -1;
125         }
126         name[len] = 0;
127         while (c == ' ' || c == '\t')
128                 c = get_next_char();
130         value = NULL;
131         if (c != '\n') {
132                 if (c != '=')
133                         return -1;
134                 value = parse_value();
135                 if (!value)
136                         return -1;
137         }
138         return fn(name, value);
141 static int get_extended_base_var(char *name, int baselen, int c)
143         do {
144                 if (c == '\n')
145                         return -1;
146                 c = get_next_char();
147         } while (isspace(c));
149         /* We require the format to be '[base "extension"]' */
150         if (c != '"')
151                 return -1;
152         name[baselen++] = '.';
154         for (;;) {
155                 int c = get_next_char();
156                 if (c == '\n')
157                         return -1;
158                 if (c == '"')
159                         break;
160                 if (c == '\\') {
161                         c = get_next_char();
162                         if (c == '\n')
163                                 return -1;
164                 }
165                 name[baselen++] = c;
166                 if (baselen > MAXNAME / 2)
167                         return -1;
168         }
170         /* Final ']' */
171         if (get_next_char() != ']')
172                 return -1;
173         return baselen;
176 static int get_base_var(char *name)
178         int baselen = 0;
180         for (;;) {
181                 int c = get_next_char();
182                 if (c == EOF)
183                         return -1;
184                 if (c == ']')
185                         return baselen;
186                 if (isspace(c))
187                         return get_extended_base_var(name, baselen, c);
188                 if (!iskeychar(c) && c != '.')
189                         return -1;
190                 if (baselen > MAXNAME / 2)
191                         return -1;
192                 name[baselen++] = tolower(c);
193         }
196 static int git_parse_file(config_fn_t fn)
198         int comment = 0;
199         int baselen = 0;
200         static char var[MAXNAME];
202         for (;;) {
203                 int c = get_next_char();
204                 if (c == '\n') {
205                         /* EOF? */
206                         if (!config_file)
207                                 return 0;
208                         comment = 0;
209                         continue;
210                 }
211                 if (comment || isspace(c))
212                         continue;
213                 if (c == '#' || c == ';') {
214                         comment = 1;
215                         continue;
216                 }
217                 if (c == '[') {
218                         baselen = get_base_var(var);
219                         if (baselen <= 0)
220                                 break;
221                         var[baselen++] = '.';
222                         var[baselen] = 0;
223                         continue;
224                 }
225                 if (!isalpha(c))
226                         break;
227                 var[baselen] = tolower(c);
228                 if (get_value(fn, var, baselen+1) < 0)
229                         break;
230         }
231         die("bad config file line %d in %s", config_linenr, config_file_name);
234 int git_config_int(const char *name, const char *value)
236         if (value && *value) {
237                 char *end;
238                 int val = strtol(value, &end, 0);
239                 if (!*end)
240                         return val;
241                 if (!strcasecmp(end, "k"))
242                         return val * 1024;
243                 if (!strcasecmp(end, "m"))
244                         return val * 1024 * 1024;
245                 if (!strcasecmp(end, "g"))
246                         return val * 1024 * 1024 * 1024;
247         }
248         die("bad config value for '%s' in %s", name, config_file_name);
251 int git_config_bool(const char *name, const char *value)
253         if (!value)
254                 return 1;
255         if (!*value)
256                 return 0;
257         if (!strcasecmp(value, "true") || !strcasecmp(value, "yes"))
258                 return 1;
259         if (!strcasecmp(value, "false") || !strcasecmp(value, "no"))
260                 return 0;
261         return git_config_int(name, value) != 0;
264 int git_default_config(const char *var, const char *value)
266         /* This needs a better name */
267         if (!strcmp(var, "core.filemode")) {
268                 trust_executable_bit = git_config_bool(var, value);
269                 return 0;
270         }
272         if (!strcmp(var, "core.ignorestat")) {
273                 assume_unchanged = git_config_bool(var, value);
274                 return 0;
275         }
277         if (!strcmp(var, "core.prefersymlinkrefs")) {
278                 prefer_symlink_refs = git_config_bool(var, value);
279                 return 0;
280         }
282         if (!strcmp(var, "core.logallrefupdates")) {
283                 log_all_ref_updates = git_config_bool(var, value);
284                 return 0;
285         }
287         if (!strcmp(var, "core.warnambiguousrefs")) {
288                 warn_ambiguous_refs = git_config_bool(var, value);
289                 return 0;
290         }
292         if (!strcmp(var, "core.legacyheaders")) {
293                 use_legacy_headers = git_config_bool(var, value);
294                 return 0;
295         }
297         if (!strcmp(var, "core.compression")) {
298                 int level = git_config_int(var, value);
299                 if (level == -1)
300                         level = Z_DEFAULT_COMPRESSION;
301                 else if (level < 0 || level > Z_BEST_COMPRESSION)
302                         die("bad zlib compression level %d", level);
303                 zlib_compression_level = level;
304                 return 0;
305         }
307         if (!strcmp(var, "user.name")) {
308                 strlcpy(git_default_name, value, sizeof(git_default_name));
309                 return 0;
310         }
312         if (!strcmp(var, "user.email")) {
313                 strlcpy(git_default_email, value, sizeof(git_default_email));
314                 return 0;
315         }
317         if (!strcmp(var, "i18n.commitencoding")) {
318                 git_commit_encoding = strdup(value);
319                 return 0;
320         }
322         if (!strcmp(var, "i18n.logoutputencoding")) {
323                 git_log_output_encoding = strdup(value);
324                 return 0;
325         }
328         if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
329                 pager_use_color = git_config_bool(var,value);
330                 return 0;
331         }
333         /* Add other config variables here and to Documentation/config.txt. */
334         return 0;
337 int git_config_from_file(config_fn_t fn, const char *filename)
339         int ret;
340         FILE *f = fopen(filename, "r");
342         ret = -1;
343         if (f) {
344                 config_file = f;
345                 config_file_name = filename;
346                 config_linenr = 1;
347                 ret = git_parse_file(fn);
348                 fclose(f);
349                 config_file_name = NULL;
350         }
351         return ret;
354 int git_config(config_fn_t fn)
356         int ret = 0;
357         char *repo_config = NULL;
358         const char *home = NULL, *filename;
360         /* $GIT_CONFIG makes git read _only_ the given config file,
361          * $GIT_CONFIG_LOCAL will make it process it in addition to the
362          * global config file, the same way it would the per-repository
363          * config file otherwise. */
364         filename = getenv(CONFIG_ENVIRONMENT);
365         if (!filename) {
366                 home = getenv("HOME");
367                 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
368                 if (!filename)
369                         filename = repo_config = xstrdup(git_path("config"));
370         }
372         if (home) {
373                 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
374                 if (!access(user_config, R_OK))
375                         ret = git_config_from_file(fn, user_config);
376                 free(user_config);
377         }
379         ret += git_config_from_file(fn, filename);
380         free(repo_config);
381         return ret;
384 /*
385  * Find all the stuff for git_config_set() below.
386  */
388 #define MAX_MATCHES 512
390 static struct {
391         int baselen;
392         char* key;
393         int do_not_match;
394         regex_t* value_regex;
395         int multi_replace;
396         off_t offset[MAX_MATCHES];
397         enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
398         int seen;
399 } store;
401 static int matches(const char* key, const char* value)
403         return !strcmp(key, store.key) &&
404                 (store.value_regex == NULL ||
405                  (store.do_not_match ^
406                   !regexec(store.value_regex, value, 0, NULL, 0)));
409 static int store_aux(const char* key, const char* value)
411         switch (store.state) {
412         case KEY_SEEN:
413                 if (matches(key, value)) {
414                         if (store.seen == 1 && store.multi_replace == 0) {
415                                 fprintf(stderr,
416                                         "Warning: %s has multiple values\n",
417                                         key);
418                         } else if (store.seen >= MAX_MATCHES) {
419                                 fprintf(stderr, "Too many matches\n");
420                                 return 1;
421                         }
423                         store.offset[store.seen] = ftell(config_file);
424                         store.seen++;
425                 }
426                 break;
427         case SECTION_SEEN:
428                 if (strncmp(key, store.key, store.baselen+1)) {
429                         store.state = SECTION_END_SEEN;
430                         break;
431                 } else
432                         /* do not increment matches: this is no match */
433                         store.offset[store.seen] = ftell(config_file);
434                 /* fallthru */
435         case SECTION_END_SEEN:
436         case START:
437                 if (matches(key, value)) {
438                         store.offset[store.seen] = ftell(config_file);
439                         store.state = KEY_SEEN;
440                         store.seen++;
441                 } else {
442                         if (strrchr(key, '.') - key == store.baselen &&
443                               !strncmp(key, store.key, store.baselen)) {
444                                         store.state = SECTION_SEEN;
445                                         store.offset[store.seen] = ftell(config_file);
446                         }
447                 }
448         }
449         return 0;
452 static void store_write_section(int fd, const char* key)
454         const char *dot = strchr(key, '.');
455         int len1 = store.baselen, len2 = -1;
457         dot = strchr(key, '.');
458         if (dot) {
459                 int dotlen = dot - key;
460                 if (dotlen < len1) {
461                         len2 = len1 - dotlen - 1;
462                         len1 = dotlen;
463                 }
464         }
466         write(fd, "[", 1);
467         write(fd, key, len1);
468         if (len2 >= 0) {
469                 write(fd, " \"", 2);
470                 while (--len2 >= 0) {
471                         unsigned char c = *++dot;
472                         if (c == '"')
473                                 write(fd, "\\", 1);
474                         write(fd, &c, 1);
475                 }
476                 write(fd, "\"", 1);
477         }
478         write(fd, "]\n", 2);
481 static void store_write_pair(int fd, const char* key, const char* value)
483         int i;
485         write(fd, "\t", 1);
486         write(fd, key+store.baselen+1,
487                 strlen(key+store.baselen+1));
488         write(fd, " = ", 3);
489         for (i = 0; value[i]; i++)
490                 switch (value[i]) {
491                 case '\n': write(fd, "\\n", 2); break;
492                 case '\t': write(fd, "\\t", 2); break;
493                 case '"': case '\\': write(fd, "\\", 1);
494                 default: write(fd, value+i, 1);
495         }
496         write(fd, "\n", 1);
499 static int find_beginning_of_line(const char* contents, int size,
500         int offset_, int* found_bracket)
502         int equal_offset = size, bracket_offset = size;
503         int offset;
505         for (offset = offset_-2; offset > 0 
506                         && contents[offset] != '\n'; offset--)
507                 switch (contents[offset]) {
508                         case '=': equal_offset = offset; break;
509                         case ']': bracket_offset = offset; break;
510                 }
511         if (bracket_offset < equal_offset) {
512                 *found_bracket = 1;
513                 offset = bracket_offset+1;
514         } else
515                 offset++;
517         return offset;
520 int git_config_set(const char* key, const char* value)
522         return git_config_set_multivar(key, value, NULL, 0);
525 /*
526  * If value==NULL, unset in (remove from) config,
527  * if value_regex!=NULL, disregard key/value pairs where value does not match.
528  * if multi_replace==0, nothing, or only one matching key/value is replaced,
529  *     else all matching key/values (regardless how many) are removed,
530  *     before the new pair is written.
531  *
532  * Returns 0 on success.
533  *
534  * This function does this:
535  *
536  * - it locks the config file by creating ".git/config.lock"
537  *
538  * - it then parses the config using store_aux() as validator to find
539  *   the position on the key/value pair to replace. If it is to be unset,
540  *   it must be found exactly once.
541  *
542  * - the config file is mmap()ed and the part before the match (if any) is
543  *   written to the lock file, then the changed part and the rest.
544  *
545  * - the config file is removed and the lock file rename()d to it.
546  *
547  */
548 int git_config_set_multivar(const char* key, const char* value,
549         const char* value_regex, int multi_replace)
551         int i, dot;
552         int fd = -1, in_fd;
553         int ret;
554         char* config_filename;
555         char* lock_file;
556         const char* last_dot = strrchr(key, '.');
558         config_filename = getenv(CONFIG_ENVIRONMENT);
559         if (!config_filename) {
560                 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
561                 if (!config_filename)
562                         config_filename  = git_path("config");
563         }
564         config_filename = xstrdup(config_filename);
565         lock_file = xstrdup(mkpath("%s.lock", config_filename));
567         /*
568          * Since "key" actually contains the section name and the real
569          * key name separated by a dot, we have to know where the dot is.
570          */
572         if (last_dot == NULL) {
573                 fprintf(stderr, "key does not contain a section: %s\n", key);
574                 ret = 2;
575                 goto out_free;
576         }
577         store.baselen = last_dot - key;
579         store.multi_replace = multi_replace;
581         /*
582          * Validate the key and while at it, lower case it for matching.
583          */
584         store.key = xmalloc(strlen(key) + 1);
585         dot = 0;
586         for (i = 0; key[i]; i++) {
587                 unsigned char c = key[i];
588                 if (c == '.')
589                         dot = 1;
590                 /* Leave the extended basename untouched.. */
591                 if (!dot || i > store.baselen) {
592                         if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
593                                 fprintf(stderr, "invalid key: %s\n", key);
594                                 free(store.key);
595                                 ret = 1;
596                                 goto out_free;
597                         }
598                         c = tolower(c);
599                 }
600                 store.key[i] = c;
601         }
602         store.key[i] = 0;
604         /*
605          * The lock_file serves a purpose in addition to locking: the new
606          * contents of .git/config will be written into it.
607          */
608         fd = open(lock_file, O_WRONLY | O_CREAT | O_EXCL, 0666);
609         if (fd < 0 || adjust_shared_perm(lock_file)) {
610                 fprintf(stderr, "could not lock config file\n");
611                 free(store.key);
612                 ret = -1;
613                 goto out_free;
614         }
616         /*
617          * If .git/config does not exist yet, write a minimal version.
618          */
619         in_fd = open(config_filename, O_RDONLY);
620         if ( in_fd < 0 ) {
621                 free(store.key);
623                 if ( ENOENT != errno ) {
624                         error("opening %s: %s", config_filename,
625                               strerror(errno));
626                         ret = 3; /* same as "invalid config file" */
627                         goto out_free;
628                 }
629                 /* if nothing to unset, error out */
630                 if (value == NULL) {
631                         ret = 5;
632                         goto out_free;
633                 }
635                 store.key = (char*)key;
636                 store_write_section(fd, key);
637                 store_write_pair(fd, key, value);
638         } else{
639                 struct stat st;
640                 char* contents;
641                 int i, copy_begin, copy_end, new_line = 0;
643                 if (value_regex == NULL)
644                         store.value_regex = NULL;
645                 else {
646                         if (value_regex[0] == '!') {
647                                 store.do_not_match = 1;
648                                 value_regex++;
649                         } else
650                                 store.do_not_match = 0;
652                         store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
653                         if (regcomp(store.value_regex, value_regex,
654                                         REG_EXTENDED)) {
655                                 fprintf(stderr, "Invalid pattern: %s\n",
656                                         value_regex);
657                                 free(store.value_regex);
658                                 ret = 6;
659                                 goto out_free;
660                         }
661                 }
663                 store.offset[0] = 0;
664                 store.state = START;
665                 store.seen = 0;
667                 /*
668                  * After this, store.offset will contain the *end* offset
669                  * of the last match, or remain at 0 if no match was found.
670                  * As a side effect, we make sure to transform only a valid
671                  * existing config file.
672                  */
673                 if (git_config_from_file(store_aux, config_filename)) {
674                         fprintf(stderr, "invalid config file\n");
675                         free(store.key);
676                         if (store.value_regex != NULL) {
677                                 regfree(store.value_regex);
678                                 free(store.value_regex);
679                         }
680                         ret = 3;
681                         goto out_free;
682                 }
684                 free(store.key);
685                 if (store.value_regex != NULL) {
686                         regfree(store.value_regex);
687                         free(store.value_regex);
688                 }
690                 /* if nothing to unset, or too many matches, error out */
691                 if ((store.seen == 0 && value == NULL) ||
692                                 (store.seen > 1 && multi_replace == 0)) {
693                         ret = 5;
694                         goto out_free;
695                 }
697                 fstat(in_fd, &st);
698                 contents = mmap(NULL, st.st_size, PROT_READ,
699                         MAP_PRIVATE, in_fd, 0);
700                 close(in_fd);
702                 if (store.seen == 0)
703                         store.seen = 1;
705                 for (i = 0, copy_begin = 0; i < store.seen; i++) {
706                         if (store.offset[i] == 0) {
707                                 store.offset[i] = copy_end = st.st_size;
708                         } else if (store.state != KEY_SEEN) {
709                                 copy_end = store.offset[i];
710                         } else
711                                 copy_end = find_beginning_of_line(
712                                         contents, st.st_size,
713                                         store.offset[i]-2, &new_line);
715                         /* write the first part of the config */
716                         if (copy_end > copy_begin) {
717                                 write(fd, contents + copy_begin,
718                                 copy_end - copy_begin);
719                                 if (new_line)
720                                         write(fd, "\n", 1);
721                         }
722                         copy_begin = store.offset[i];
723                 }
725                 /* write the pair (value == NULL means unset) */
726                 if (value != NULL) {
727                         if (store.state == START)
728                                 store_write_section(fd, key);
729                         store_write_pair(fd, key, value);
730                 }
732                 /* write the rest of the config */
733                 if (copy_begin < st.st_size)
734                         write(fd, contents + copy_begin,
735                                 st.st_size - copy_begin);
737                 munmap(contents, st.st_size);
738                 unlink(config_filename);
739         }
741         if (rename(lock_file, config_filename) < 0) {
742                 fprintf(stderr, "Could not rename the lock file?\n");
743                 ret = 4;
744                 goto out_free;
745         }
747         ret = 0;
749 out_free:
750         if (0 <= fd)
751                 close(fd);
752         free(config_filename);
753         if (lock_file) {
754                 unlink(lock_file);
755                 free(lock_file);
756         }
757         return ret;
760 int git_config_rename_section(const char *old_name, const char *new_name)
762         int ret = 0;
763         char *config_filename;
764         struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
765         int out_fd;
766         char buf[1024];
768         config_filename = getenv(CONFIG_ENVIRONMENT);
769         if (!config_filename) {
770                 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
771                 if (!config_filename)
772                         config_filename  = git_path("config");
773         }
774         config_filename = xstrdup(config_filename);
775         out_fd = hold_lock_file_for_update(lock, config_filename, 0);
776         if (out_fd < 0) {
777                 ret = error("Could not lock config file!");
778                 goto out;
779         }
781         if (!(config_file = fopen(config_filename, "rb"))) {
782                 ret = error("Could not open config file!");
783                 goto out;
784         }
786         while (fgets(buf, sizeof(buf), config_file)) {
787                 int i;
788                 for (i = 0; buf[i] && isspace(buf[i]); i++)
789                         ; /* do nothing */
790                 if (buf[i] == '[') {
791                         /* it's a section */
792                         int j = 0, dot = 0;
793                         for (i++; buf[i] && buf[i] != ']'; i++) {
794                                 if (!dot && isspace(buf[i])) {
795                                         dot = 1;
796                                         if (old_name[j++] != '.')
797                                                 break;
798                                         for (i++; isspace(buf[i]); i++)
799                                                 ; /* do nothing */
800                                         if (buf[i] != '"')
801                                                 break;
802                                         continue;
803                                 }
804                                 if (buf[i] == '\\' && dot)
805                                         i++;
806                                 else if (buf[i] == '"' && dot) {
807                                         for (i++; isspace(buf[i]); i++)
808                                                 ; /* do_nothing */
809                                         break;
810                                 }
811                                 if (buf[i] != old_name[j++])
812                                         break;
813                         }
814                         if (buf[i] == ']') {
815                                 /* old_name matches */
816                                 ret++;
817                                 store.baselen = strlen(new_name);
818                                 store_write_section(out_fd, new_name);
819                                 continue;
820                         }
821                 }
822                 write(out_fd, buf, strlen(buf));
823         }
824         fclose(config_file);
825         if (close(out_fd) || commit_lock_file(lock) < 0)
826                 ret = error("Cannot commit config file!");
827  out:
828         free(config_filename);
829         return ret;