Code

UTF-8: introduce i18n.logoutputencoding.
[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         }
242         die("bad config value for '%s' in %s", name, config_file_name);
245 int git_config_bool(const char *name, const char *value)
247         if (!value)
248                 return 1;
249         if (!*value)
250                 return 0;
251         if (!strcasecmp(value, "true") || !strcasecmp(value, "yes"))
252                 return 1;
253         if (!strcasecmp(value, "false") || !strcasecmp(value, "no"))
254                 return 0;
255         return git_config_int(name, value) != 0;
258 int git_default_config(const char *var, const char *value)
260         /* This needs a better name */
261         if (!strcmp(var, "core.filemode")) {
262                 trust_executable_bit = git_config_bool(var, value);
263                 return 0;
264         }
266         if (!strcmp(var, "core.ignorestat")) {
267                 assume_unchanged = git_config_bool(var, value);
268                 return 0;
269         }
271         if (!strcmp(var, "core.prefersymlinkrefs")) {
272                 prefer_symlink_refs = git_config_bool(var, value);
273                 return 0;
274         }
276         if (!strcmp(var, "core.logallrefupdates")) {
277                 log_all_ref_updates = git_config_bool(var, value);
278                 return 0;
279         }
281         if (!strcmp(var, "core.warnambiguousrefs")) {
282                 warn_ambiguous_refs = git_config_bool(var, value);
283                 return 0;
284         }
286         if (!strcmp(var, "core.legacyheaders")) {
287                 use_legacy_headers = git_config_bool(var, value);
288                 return 0;
289         }
291         if (!strcmp(var, "core.compression")) {
292                 int level = git_config_int(var, value);
293                 if (level == -1)
294                         level = Z_DEFAULT_COMPRESSION;
295                 else if (level < 0 || level > Z_BEST_COMPRESSION)
296                         die("bad zlib compression level %d", level);
297                 zlib_compression_level = level;
298                 return 0;
299         }
301         if (!strcmp(var, "user.name")) {
302                 strlcpy(git_default_name, value, sizeof(git_default_name));
303                 return 0;
304         }
306         if (!strcmp(var, "user.email")) {
307                 strlcpy(git_default_email, value, sizeof(git_default_email));
308                 return 0;
309         }
311         if (!strcmp(var, "i18n.commitencoding")) {
312                 git_commit_encoding = strdup(value);
313                 return 0;
314         }
316         if (!strcmp(var, "i18n.logoutputencoding")) {
317                 git_log_output_encoding = strdup(value);
318                 return 0;
319         }
322         if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
323                 pager_use_color = git_config_bool(var,value);
324                 return 0;
325         }
327         /* Add other config variables here and to Documentation/config.txt. */
328         return 0;
331 int git_config_from_file(config_fn_t fn, const char *filename)
333         int ret;
334         FILE *f = fopen(filename, "r");
336         ret = -1;
337         if (f) {
338                 config_file = f;
339                 config_file_name = filename;
340                 config_linenr = 1;
341                 ret = git_parse_file(fn);
342                 fclose(f);
343                 config_file_name = NULL;
344         }
345         return ret;
348 int git_config(config_fn_t fn)
350         int ret = 0;
351         char *repo_config = NULL;
352         const char *home = NULL, *filename;
354         /* $GIT_CONFIG makes git read _only_ the given config file,
355          * $GIT_CONFIG_LOCAL will make it process it in addition to the
356          * global config file, the same way it would the per-repository
357          * config file otherwise. */
358         filename = getenv(CONFIG_ENVIRONMENT);
359         if (!filename) {
360                 home = getenv("HOME");
361                 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
362                 if (!filename)
363                         filename = repo_config = xstrdup(git_path("config"));
364         }
366         if (home) {
367                 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
368                 if (!access(user_config, R_OK))
369                         ret = git_config_from_file(fn, user_config);
370                 free(user_config);
371         }
373         ret += git_config_from_file(fn, filename);
374         free(repo_config);
375         return ret;
378 /*
379  * Find all the stuff for git_config_set() below.
380  */
382 #define MAX_MATCHES 512
384 static struct {
385         int baselen;
386         char* key;
387         int do_not_match;
388         regex_t* value_regex;
389         int multi_replace;
390         off_t offset[MAX_MATCHES];
391         enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
392         int seen;
393 } store;
395 static int matches(const char* key, const char* value)
397         return !strcmp(key, store.key) &&
398                 (store.value_regex == NULL ||
399                  (store.do_not_match ^
400                   !regexec(store.value_regex, value, 0, NULL, 0)));
403 static int store_aux(const char* key, const char* value)
405         switch (store.state) {
406         case KEY_SEEN:
407                 if (matches(key, value)) {
408                         if (store.seen == 1 && store.multi_replace == 0) {
409                                 fprintf(stderr,
410                                         "Warning: %s has multiple values\n",
411                                         key);
412                         } else if (store.seen >= MAX_MATCHES) {
413                                 fprintf(stderr, "Too many matches\n");
414                                 return 1;
415                         }
417                         store.offset[store.seen] = ftell(config_file);
418                         store.seen++;
419                 }
420                 break;
421         case SECTION_SEEN:
422                 if (strncmp(key, store.key, store.baselen+1)) {
423                         store.state = SECTION_END_SEEN;
424                         break;
425                 } else
426                         /* do not increment matches: this is no match */
427                         store.offset[store.seen] = ftell(config_file);
428                 /* fallthru */
429         case SECTION_END_SEEN:
430         case START:
431                 if (matches(key, value)) {
432                         store.offset[store.seen] = ftell(config_file);
433                         store.state = KEY_SEEN;
434                         store.seen++;
435                 } else {
436                         if (strrchr(key, '.') - key == store.baselen &&
437                               !strncmp(key, store.key, store.baselen)) {
438                                         store.state = SECTION_SEEN;
439                                         store.offset[store.seen] = ftell(config_file);
440                         }
441                 }
442         }
443         return 0;
446 static void store_write_section(int fd, const char* key)
448         const char *dot = strchr(key, '.');
449         int len1 = store.baselen, len2 = -1;
451         dot = strchr(key, '.');
452         if (dot) {
453                 int dotlen = dot - key;
454                 if (dotlen < len1) {
455                         len2 = len1 - dotlen - 1;
456                         len1 = dotlen;
457                 }
458         }
460         write(fd, "[", 1);
461         write(fd, key, len1);
462         if (len2 >= 0) {
463                 write(fd, " \"", 2);
464                 while (--len2 >= 0) {
465                         unsigned char c = *++dot;
466                         if (c == '"')
467                                 write(fd, "\\", 1);
468                         write(fd, &c, 1);
469                 }
470                 write(fd, "\"", 1);
471         }
472         write(fd, "]\n", 2);
475 static void store_write_pair(int fd, const char* key, const char* value)
477         int i;
479         write(fd, "\t", 1);
480         write(fd, key+store.baselen+1,
481                 strlen(key+store.baselen+1));
482         write(fd, " = ", 3);
483         for (i = 0; value[i]; i++)
484                 switch (value[i]) {
485                 case '\n': write(fd, "\\n", 2); break;
486                 case '\t': write(fd, "\\t", 2); break;
487                 case '"': case '\\': write(fd, "\\", 1);
488                 default: write(fd, value+i, 1);
489         }
490         write(fd, "\n", 1);
493 static int find_beginning_of_line(const char* contents, int size,
494         int offset_, int* found_bracket)
496         int equal_offset = size, bracket_offset = size;
497         int offset;
499         for (offset = offset_-2; offset > 0 
500                         && contents[offset] != '\n'; offset--)
501                 switch (contents[offset]) {
502                         case '=': equal_offset = offset; break;
503                         case ']': bracket_offset = offset; break;
504                 }
505         if (bracket_offset < equal_offset) {
506                 *found_bracket = 1;
507                 offset = bracket_offset+1;
508         } else
509                 offset++;
511         return offset;
514 int git_config_set(const char* key, const char* value)
516         return git_config_set_multivar(key, value, NULL, 0);
519 /*
520  * If value==NULL, unset in (remove from) config,
521  * if value_regex!=NULL, disregard key/value pairs where value does not match.
522  * if multi_replace==0, nothing, or only one matching key/value is replaced,
523  *     else all matching key/values (regardless how many) are removed,
524  *     before the new pair is written.
525  *
526  * Returns 0 on success.
527  *
528  * This function does this:
529  *
530  * - it locks the config file by creating ".git/config.lock"
531  *
532  * - it then parses the config using store_aux() as validator to find
533  *   the position on the key/value pair to replace. If it is to be unset,
534  *   it must be found exactly once.
535  *
536  * - the config file is mmap()ed and the part before the match (if any) is
537  *   written to the lock file, then the changed part and the rest.
538  *
539  * - the config file is removed and the lock file rename()d to it.
540  *
541  */
542 int git_config_set_multivar(const char* key, const char* value,
543         const char* value_regex, int multi_replace)
545         int i, dot;
546         int fd = -1, in_fd;
547         int ret;
548         char* config_filename;
549         char* lock_file;
550         const char* last_dot = strrchr(key, '.');
552         config_filename = getenv(CONFIG_ENVIRONMENT);
553         if (!config_filename) {
554                 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
555                 if (!config_filename)
556                         config_filename  = git_path("config");
557         }
558         config_filename = xstrdup(config_filename);
559         lock_file = xstrdup(mkpath("%s.lock", config_filename));
561         /*
562          * Since "key" actually contains the section name and the real
563          * key name separated by a dot, we have to know where the dot is.
564          */
566         if (last_dot == NULL) {
567                 fprintf(stderr, "key does not contain a section: %s\n", key);
568                 ret = 2;
569                 goto out_free;
570         }
571         store.baselen = last_dot - key;
573         store.multi_replace = multi_replace;
575         /*
576          * Validate the key and while at it, lower case it for matching.
577          */
578         store.key = xmalloc(strlen(key) + 1);
579         dot = 0;
580         for (i = 0; key[i]; i++) {
581                 unsigned char c = key[i];
582                 if (c == '.')
583                         dot = 1;
584                 /* Leave the extended basename untouched.. */
585                 if (!dot || i > store.baselen) {
586                         if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
587                                 fprintf(stderr, "invalid key: %s\n", key);
588                                 free(store.key);
589                                 ret = 1;
590                                 goto out_free;
591                         }
592                         c = tolower(c);
593                 }
594                 store.key[i] = c;
595         }
596         store.key[i] = 0;
598         /*
599          * The lock_file serves a purpose in addition to locking: the new
600          * contents of .git/config will be written into it.
601          */
602         fd = open(lock_file, O_WRONLY | O_CREAT | O_EXCL, 0666);
603         if (fd < 0 || adjust_shared_perm(lock_file)) {
604                 fprintf(stderr, "could not lock config file\n");
605                 free(store.key);
606                 ret = -1;
607                 goto out_free;
608         }
610         /*
611          * If .git/config does not exist yet, write a minimal version.
612          */
613         in_fd = open(config_filename, O_RDONLY);
614         if ( in_fd < 0 ) {
615                 free(store.key);
617                 if ( ENOENT != errno ) {
618                         error("opening %s: %s", config_filename,
619                               strerror(errno));
620                         ret = 3; /* same as "invalid config file" */
621                         goto out_free;
622                 }
623                 /* if nothing to unset, error out */
624                 if (value == NULL) {
625                         ret = 5;
626                         goto out_free;
627                 }
629                 store.key = (char*)key;
630                 store_write_section(fd, key);
631                 store_write_pair(fd, key, value);
632         } else{
633                 struct stat st;
634                 char* contents;
635                 int i, copy_begin, copy_end, new_line = 0;
637                 if (value_regex == NULL)
638                         store.value_regex = NULL;
639                 else {
640                         if (value_regex[0] == '!') {
641                                 store.do_not_match = 1;
642                                 value_regex++;
643                         } else
644                                 store.do_not_match = 0;
646                         store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
647                         if (regcomp(store.value_regex, value_regex,
648                                         REG_EXTENDED)) {
649                                 fprintf(stderr, "Invalid pattern: %s\n",
650                                         value_regex);
651                                 free(store.value_regex);
652                                 ret = 6;
653                                 goto out_free;
654                         }
655                 }
657                 store.offset[0] = 0;
658                 store.state = START;
659                 store.seen = 0;
661                 /*
662                  * After this, store.offset will contain the *end* offset
663                  * of the last match, or remain at 0 if no match was found.
664                  * As a side effect, we make sure to transform only a valid
665                  * existing config file.
666                  */
667                 if (git_config_from_file(store_aux, config_filename)) {
668                         fprintf(stderr, "invalid config file\n");
669                         free(store.key);
670                         if (store.value_regex != NULL) {
671                                 regfree(store.value_regex);
672                                 free(store.value_regex);
673                         }
674                         ret = 3;
675                         goto out_free;
676                 }
678                 free(store.key);
679                 if (store.value_regex != NULL) {
680                         regfree(store.value_regex);
681                         free(store.value_regex);
682                 }
684                 /* if nothing to unset, or too many matches, error out */
685                 if ((store.seen == 0 && value == NULL) ||
686                                 (store.seen > 1 && multi_replace == 0)) {
687                         ret = 5;
688                         goto out_free;
689                 }
691                 fstat(in_fd, &st);
692                 contents = mmap(NULL, st.st_size, PROT_READ,
693                         MAP_PRIVATE, in_fd, 0);
694                 close(in_fd);
696                 if (store.seen == 0)
697                         store.seen = 1;
699                 for (i = 0, copy_begin = 0; i < store.seen; i++) {
700                         if (store.offset[i] == 0) {
701                                 store.offset[i] = copy_end = st.st_size;
702                         } else if (store.state != KEY_SEEN) {
703                                 copy_end = store.offset[i];
704                         } else
705                                 copy_end = find_beginning_of_line(
706                                         contents, st.st_size,
707                                         store.offset[i]-2, &new_line);
709                         /* write the first part of the config */
710                         if (copy_end > copy_begin) {
711                                 write(fd, contents + copy_begin,
712                                 copy_end - copy_begin);
713                                 if (new_line)
714                                         write(fd, "\n", 1);
715                         }
716                         copy_begin = store.offset[i];
717                 }
719                 /* write the pair (value == NULL means unset) */
720                 if (value != NULL) {
721                         if (store.state == START)
722                                 store_write_section(fd, key);
723                         store_write_pair(fd, key, value);
724                 }
726                 /* write the rest of the config */
727                 if (copy_begin < st.st_size)
728                         write(fd, contents + copy_begin,
729                                 st.st_size - copy_begin);
731                 munmap(contents, st.st_size);
732                 unlink(config_filename);
733         }
735         if (rename(lock_file, config_filename) < 0) {
736                 fprintf(stderr, "Could not rename the lock file?\n");
737                 ret = 4;
738                 goto out_free;
739         }
741         ret = 0;
743 out_free:
744         if (0 <= fd)
745                 close(fd);
746         free(config_filename);
747         if (lock_file) {
748                 unlink(lock_file);
749                 free(lock_file);
750         }
751         return ret;
754 int git_config_rename_section(const char *old_name, const char *new_name)
756         int ret = 0;
757         char *config_filename;
758         struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
759         int out_fd;
760         char buf[1024];
762         config_filename = getenv(CONFIG_ENVIRONMENT);
763         if (!config_filename) {
764                 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
765                 if (!config_filename)
766                         config_filename  = git_path("config");
767         }
768         config_filename = xstrdup(config_filename);
769         out_fd = hold_lock_file_for_update(lock, config_filename, 0);
770         if (out_fd < 0) {
771                 ret = error("Could not lock config file!");
772                 goto out;
773         }
775         if (!(config_file = fopen(config_filename, "rb"))) {
776                 ret = error("Could not open config file!");
777                 goto out;
778         }
780         while (fgets(buf, sizeof(buf), config_file)) {
781                 int i;
782                 for (i = 0; buf[i] && isspace(buf[i]); i++)
783                         ; /* do nothing */
784                 if (buf[i] == '[') {
785                         /* it's a section */
786                         int j = 0, dot = 0;
787                         for (i++; buf[i] && buf[i] != ']'; i++) {
788                                 if (!dot && isspace(buf[i])) {
789                                         dot = 1;
790                                         if (old_name[j++] != '.')
791                                                 break;
792                                         for (i++; isspace(buf[i]); i++)
793                                                 ; /* do nothing */
794                                         if (buf[i] != '"')
795                                                 break;
796                                         continue;
797                                 }
798                                 if (buf[i] == '\\' && dot)
799                                         i++;
800                                 else if (buf[i] == '"' && dot) {
801                                         for (i++; isspace(buf[i]); i++)
802                                                 ; /* do_nothing */
803                                         break;
804                                 }
805                                 if (buf[i] != old_name[j++])
806                                         break;
807                         }
808                         if (buf[i] == ']') {
809                                 /* old_name matches */
810                                 ret++;
811                                 store.baselen = strlen(new_name);
812                                 store_write_section(out_fd, new_name);
813                                 continue;
814                         }
815                 }
816                 write(out_fd, buf, strlen(buf));
817         }
818         fclose(config_file);
819         if (close(out_fd) || commit_lock_file(lock) < 0)
820                 ret = error("Cannot commit config file!");
821  out:
822         free(config_filename);
823         return ret;