gitweb: Show project's README.html if available
[git/repo.git] / config.c
blobe8f0caf7cf674ff44b23e0182420988e9672cc69
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include <regex.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 get_next_char(void)
18 int c;
19 FILE *f;
21 c = '\n';
22 if ((f = config_file) != NULL) {
23 c = fgetc(f);
24 if (c == '\r') {
25 /* DOS like systems */
26 c = fgetc(f);
27 if (c != '\n') {
28 ungetc(c, f);
29 c = '\r';
32 if (c == '\n')
33 config_linenr++;
34 if (c == EOF) {
35 config_file = NULL;
36 c = '\n';
39 return c;
42 static char *parse_value(void)
44 static char value[1024];
45 int quote = 0, comment = 0, len = 0, space = 0;
47 for (;;) {
48 int c = get_next_char();
49 if (len >= sizeof(value))
50 return NULL;
51 if (c == '\n') {
52 if (quote)
53 return NULL;
54 value[len] = 0;
55 return value;
57 if (comment)
58 continue;
59 if (isspace(c) && !quote) {
60 space = 1;
61 continue;
63 if (!quote) {
64 if (c == ';' || c == '#') {
65 comment = 1;
66 continue;
69 if (space) {
70 if (len)
71 value[len++] = ' ';
72 space = 0;
74 if (c == '\\') {
75 c = get_next_char();
76 switch (c) {
77 case '\n':
78 continue;
79 case 't':
80 c = '\t';
81 break;
82 case 'b':
83 c = '\b';
84 break;
85 case 'n':
86 c = '\n';
87 break;
88 /* Some characters escape as themselves */
89 case '\\': case '"':
90 break;
91 /* Reject unknown escape sequences */
92 default:
93 return NULL;
95 value[len++] = c;
96 continue;
98 if (c == '"') {
99 quote = 1-quote;
100 continue;
102 value[len++] = c;
106 static int get_value(config_fn_t fn, char *name, unsigned int len)
108 int c;
109 char *value;
111 /* Get the full name */
112 for (;;) {
113 c = get_next_char();
114 if (c == EOF)
115 break;
116 if (!isalnum(c))
117 break;
118 name[len++] = tolower(c);
119 if (len >= MAXNAME)
120 return -1;
122 name[len] = 0;
123 while (c == ' ' || c == '\t')
124 c = get_next_char();
126 value = NULL;
127 if (c != '\n') {
128 if (c != '=')
129 return -1;
130 value = parse_value();
131 if (!value)
132 return -1;
134 return fn(name, value);
137 static int get_extended_base_var(char *name, int baselen, int c)
139 do {
140 if (c == '\n')
141 return -1;
142 c = get_next_char();
143 } while (isspace(c));
145 /* We require the format to be '[base "extension"]' */
146 if (c != '"')
147 return -1;
148 name[baselen++] = '.';
150 for (;;) {
151 int c = get_next_char();
152 if (c == '\n')
153 return -1;
154 if (c == '"')
155 break;
156 if (c == '\\') {
157 c = get_next_char();
158 if (c == '\n')
159 return -1;
161 name[baselen++] = c;
162 if (baselen > MAXNAME / 2)
163 return -1;
166 /* Final ']' */
167 if (get_next_char() != ']')
168 return -1;
169 return baselen;
172 static int get_base_var(char *name)
174 int baselen = 0;
176 for (;;) {
177 int c = get_next_char();
178 if (c == EOF)
179 return -1;
180 if (c == ']')
181 return baselen;
182 if (isspace(c))
183 return get_extended_base_var(name, baselen, c);
184 if (!isalnum(c) && c != '.')
185 return -1;
186 if (baselen > MAXNAME / 2)
187 return -1;
188 name[baselen++] = tolower(c);
192 static int git_parse_file(config_fn_t fn)
194 int comment = 0;
195 int baselen = 0;
196 static char var[MAXNAME];
198 for (;;) {
199 int c = get_next_char();
200 if (c == '\n') {
201 /* EOF? */
202 if (!config_file)
203 return 0;
204 comment = 0;
205 continue;
207 if (comment || isspace(c))
208 continue;
209 if (c == '#' || c == ';') {
210 comment = 1;
211 continue;
213 if (c == '[') {
214 baselen = get_base_var(var);
215 if (baselen <= 0)
216 break;
217 var[baselen++] = '.';
218 var[baselen] = 0;
219 continue;
221 if (!isalpha(c))
222 break;
223 var[baselen] = tolower(c);
224 if (get_value(fn, var, baselen+1) < 0)
225 break;
227 die("bad config file line %d in %s", config_linenr, config_file_name);
230 int git_config_int(const char *name, const char *value)
232 if (value && *value) {
233 char *end;
234 int val = strtol(value, &end, 0);
235 if (!*end)
236 return val;
238 die("bad config value for '%s' in %s", name, config_file_name);
241 int git_config_bool(const char *name, const char *value)
243 if (!value)
244 return 1;
245 if (!*value)
246 return 0;
247 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes"))
248 return 1;
249 if (!strcasecmp(value, "false") || !strcasecmp(value, "no"))
250 return 0;
251 return git_config_int(name, value) != 0;
254 int git_default_config(const char *var, const char *value)
256 /* This needs a better name */
257 if (!strcmp(var, "core.filemode")) {
258 trust_executable_bit = git_config_bool(var, value);
259 return 0;
262 if (!strcmp(var, "core.ignorestat")) {
263 assume_unchanged = git_config_bool(var, value);
264 return 0;
267 if (!strcmp(var, "core.prefersymlinkrefs")) {
268 prefer_symlink_refs = git_config_bool(var, value);
269 return 0;
272 if (!strcmp(var, "core.logallrefupdates")) {
273 log_all_ref_updates = git_config_bool(var, value);
274 return 0;
277 if (!strcmp(var, "core.warnambiguousrefs")) {
278 warn_ambiguous_refs = git_config_bool(var, value);
279 return 0;
282 if (!strcmp(var, "core.legacyheaders")) {
283 use_legacy_headers = git_config_bool(var, value);
284 return 0;
287 if (!strcmp(var, "core.compression")) {
288 int level = git_config_int(var, value);
289 if (level == -1)
290 level = Z_DEFAULT_COMPRESSION;
291 else if (level < 0 || level > Z_BEST_COMPRESSION)
292 die("bad zlib compression level %d", level);
293 zlib_compression_level = level;
294 return 0;
297 if (!strcmp(var, "user.name")) {
298 strlcpy(git_default_name, value, sizeof(git_default_name));
299 return 0;
302 if (!strcmp(var, "user.email")) {
303 strlcpy(git_default_email, value, sizeof(git_default_email));
304 return 0;
307 if (!strcmp(var, "i18n.commitencoding")) {
308 strlcpy(git_commit_encoding, value, sizeof(git_commit_encoding));
309 return 0;
312 if (!strcmp(var, "pager.color")) {
313 pager_use_color = git_config_bool(var,value);
314 return 0;
317 /* Add other config variables here and to Documentation/config.txt. */
318 return 0;
321 int git_config_from_file(config_fn_t fn, const char *filename)
323 int ret;
324 FILE *f = fopen(filename, "r");
326 ret = -1;
327 if (f) {
328 config_file = f;
329 config_file_name = filename;
330 config_linenr = 1;
331 ret = git_parse_file(fn);
332 fclose(f);
333 config_file_name = NULL;
335 return ret;
338 int git_config(config_fn_t fn)
340 int ret = 0;
341 char *repo_config = NULL;
342 const char *home = NULL, *filename;
344 /* $GIT_CONFIG makes git read _only_ the given config file,
345 * $GIT_CONFIG_LOCAL will make it process it in addition to the
346 * global config file, the same way it would the per-repository
347 * config file otherwise. */
348 filename = getenv("GIT_CONFIG");
349 if (!filename) {
350 home = getenv("HOME");
351 filename = getenv("GIT_CONFIG_LOCAL");
352 if (!filename)
353 filename = repo_config = xstrdup(git_path("config"));
356 if (home) {
357 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
358 if (!access(user_config, R_OK))
359 ret = git_config_from_file(fn, user_config);
360 free(user_config);
363 ret += git_config_from_file(fn, filename);
364 free(repo_config);
365 return ret;
369 * Find all the stuff for git_config_set() below.
372 #define MAX_MATCHES 512
374 static struct {
375 int baselen;
376 char* key;
377 int do_not_match;
378 regex_t* value_regex;
379 int multi_replace;
380 off_t offset[MAX_MATCHES];
381 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
382 int seen;
383 } store;
385 static int matches(const char* key, const char* value)
387 return !strcmp(key, store.key) &&
388 (store.value_regex == NULL ||
389 (store.do_not_match ^
390 !regexec(store.value_regex, value, 0, NULL, 0)));
393 static int store_aux(const char* key, const char* value)
395 switch (store.state) {
396 case KEY_SEEN:
397 if (matches(key, value)) {
398 if (store.seen == 1 && store.multi_replace == 0) {
399 fprintf(stderr,
400 "Warning: %s has multiple values\n",
401 key);
402 } else if (store.seen >= MAX_MATCHES) {
403 fprintf(stderr, "Too many matches\n");
404 return 1;
407 store.offset[store.seen] = ftell(config_file);
408 store.seen++;
410 break;
411 case SECTION_SEEN:
412 if (strncmp(key, store.key, store.baselen+1)) {
413 store.state = SECTION_END_SEEN;
414 break;
415 } else
416 /* do not increment matches: this is no match */
417 store.offset[store.seen] = ftell(config_file);
418 /* fallthru */
419 case SECTION_END_SEEN:
420 case START:
421 if (matches(key, value)) {
422 store.offset[store.seen] = ftell(config_file);
423 store.state = KEY_SEEN;
424 store.seen++;
425 } else {
426 if (strrchr(key, '.') - key == store.baselen &&
427 !strncmp(key, store.key, store.baselen)) {
428 store.state = SECTION_SEEN;
429 store.offset[store.seen] = ftell(config_file);
433 return 0;
436 static void store_write_section(int fd, const char* key)
438 const char *dot = strchr(key, '.');
439 int len1 = store.baselen, len2 = -1;
441 dot = strchr(key, '.');
442 if (dot) {
443 int dotlen = dot - key;
444 if (dotlen < len1) {
445 len2 = len1 - dotlen - 1;
446 len1 = dotlen;
450 write(fd, "[", 1);
451 write(fd, key, len1);
452 if (len2 >= 0) {
453 write(fd, " \"", 2);
454 while (--len2 >= 0) {
455 unsigned char c = *++dot;
456 if (c == '"')
457 write(fd, "\\", 1);
458 write(fd, &c, 1);
460 write(fd, "\"", 1);
462 write(fd, "]\n", 2);
465 static void store_write_pair(int fd, const char* key, const char* value)
467 int i;
469 write(fd, "\t", 1);
470 write(fd, key+store.baselen+1,
471 strlen(key+store.baselen+1));
472 write(fd, " = ", 3);
473 for (i = 0; value[i]; i++)
474 switch (value[i]) {
475 case '\n': write(fd, "\\n", 2); break;
476 case '\t': write(fd, "\\t", 2); break;
477 case '"': case '\\': write(fd, "\\", 1);
478 default: write(fd, value+i, 1);
480 write(fd, "\n", 1);
483 static int find_beginning_of_line(const char* contents, int size,
484 int offset_, int* found_bracket)
486 int equal_offset = size, bracket_offset = size;
487 int offset;
489 for (offset = offset_-2; offset > 0
490 && contents[offset] != '\n'; offset--)
491 switch (contents[offset]) {
492 case '=': equal_offset = offset; break;
493 case ']': bracket_offset = offset; break;
495 if (bracket_offset < equal_offset) {
496 *found_bracket = 1;
497 offset = bracket_offset+1;
498 } else
499 offset++;
501 return offset;
504 int git_config_set(const char* key, const char* value)
506 return git_config_set_multivar(key, value, NULL, 0);
510 * If value==NULL, unset in (remove from) config,
511 * if value_regex!=NULL, disregard key/value pairs where value does not match.
512 * if multi_replace==0, nothing, or only one matching key/value is replaced,
513 * else all matching key/values (regardless how many) are removed,
514 * before the new pair is written.
516 * Returns 0 on success.
518 * This function does this:
520 * - it locks the config file by creating ".git/config.lock"
522 * - it then parses the config using store_aux() as validator to find
523 * the position on the key/value pair to replace. If it is to be unset,
524 * it must be found exactly once.
526 * - the config file is mmap()ed and the part before the match (if any) is
527 * written to the lock file, then the changed part and the rest.
529 * - the config file is removed and the lock file rename()d to it.
532 int git_config_set_multivar(const char* key, const char* value,
533 const char* value_regex, int multi_replace)
535 int i, dot;
536 int fd = -1, in_fd;
537 int ret;
538 char* config_filename;
539 char* lock_file;
540 const char* last_dot = strrchr(key, '.');
542 config_filename = getenv("GIT_CONFIG");
543 if (!config_filename) {
544 config_filename = getenv("GIT_CONFIG_LOCAL");
545 if (!config_filename)
546 config_filename = git_path("config");
548 config_filename = xstrdup(config_filename);
549 lock_file = xstrdup(mkpath("%s.lock", config_filename));
552 * Since "key" actually contains the section name and the real
553 * key name separated by a dot, we have to know where the dot is.
556 if (last_dot == NULL) {
557 fprintf(stderr, "key does not contain a section: %s\n", key);
558 ret = 2;
559 goto out_free;
561 store.baselen = last_dot - key;
563 store.multi_replace = multi_replace;
566 * Validate the key and while at it, lower case it for matching.
568 store.key = xmalloc(strlen(key) + 1);
569 dot = 0;
570 for (i = 0; key[i]; i++) {
571 unsigned char c = key[i];
572 if (c == '.')
573 dot = 1;
574 /* Leave the extended basename untouched.. */
575 if (!dot || i > store.baselen) {
576 if (!isalnum(c) || (i == store.baselen+1 && !isalpha(c))) {
577 fprintf(stderr, "invalid key: %s\n", key);
578 free(store.key);
579 ret = 1;
580 goto out_free;
582 c = tolower(c);
584 store.key[i] = c;
586 store.key[i] = 0;
589 * The lock_file serves a purpose in addition to locking: the new
590 * contents of .git/config will be written into it.
592 fd = open(lock_file, O_WRONLY | O_CREAT | O_EXCL, 0666);
593 if (fd < 0 || adjust_shared_perm(lock_file)) {
594 fprintf(stderr, "could not lock config file\n");
595 free(store.key);
596 ret = -1;
597 goto out_free;
601 * If .git/config does not exist yet, write a minimal version.
603 in_fd = open(config_filename, O_RDONLY);
604 if ( in_fd < 0 ) {
605 free(store.key);
607 if ( ENOENT != errno ) {
608 error("opening %s: %s", config_filename,
609 strerror(errno));
610 ret = 3; /* same as "invalid config file" */
611 goto out_free;
613 /* if nothing to unset, error out */
614 if (value == NULL) {
615 ret = 5;
616 goto out_free;
619 store.key = (char*)key;
620 store_write_section(fd, key);
621 store_write_pair(fd, key, value);
622 } else{
623 struct stat st;
624 char* contents;
625 int i, copy_begin, copy_end, new_line = 0;
627 if (value_regex == NULL)
628 store.value_regex = NULL;
629 else {
630 if (value_regex[0] == '!') {
631 store.do_not_match = 1;
632 value_regex++;
633 } else
634 store.do_not_match = 0;
636 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
637 if (regcomp(store.value_regex, value_regex,
638 REG_EXTENDED)) {
639 fprintf(stderr, "Invalid pattern: %s\n",
640 value_regex);
641 free(store.value_regex);
642 ret = 6;
643 goto out_free;
647 store.offset[0] = 0;
648 store.state = START;
649 store.seen = 0;
652 * After this, store.offset will contain the *end* offset
653 * of the last match, or remain at 0 if no match was found.
654 * As a side effect, we make sure to transform only a valid
655 * existing config file.
657 if (git_config_from_file(store_aux, config_filename)) {
658 fprintf(stderr, "invalid config file\n");
659 free(store.key);
660 if (store.value_regex != NULL) {
661 regfree(store.value_regex);
662 free(store.value_regex);
664 ret = 3;
665 goto out_free;
668 free(store.key);
669 if (store.value_regex != NULL) {
670 regfree(store.value_regex);
671 free(store.value_regex);
674 /* if nothing to unset, or too many matches, error out */
675 if ((store.seen == 0 && value == NULL) ||
676 (store.seen > 1 && multi_replace == 0)) {
677 ret = 5;
678 goto out_free;
681 fstat(in_fd, &st);
682 contents = mmap(NULL, st.st_size, PROT_READ,
683 MAP_PRIVATE, in_fd, 0);
684 close(in_fd);
686 if (store.seen == 0)
687 store.seen = 1;
689 for (i = 0, copy_begin = 0; i < store.seen; i++) {
690 if (store.offset[i] == 0) {
691 store.offset[i] = copy_end = st.st_size;
692 } else if (store.state != KEY_SEEN) {
693 copy_end = store.offset[i];
694 } else
695 copy_end = find_beginning_of_line(
696 contents, st.st_size,
697 store.offset[i]-2, &new_line);
699 /* write the first part of the config */
700 if (copy_end > copy_begin) {
701 write(fd, contents + copy_begin,
702 copy_end - copy_begin);
703 if (new_line)
704 write(fd, "\n", 1);
706 copy_begin = store.offset[i];
709 /* write the pair (value == NULL means unset) */
710 if (value != NULL) {
711 if (store.state == START)
712 store_write_section(fd, key);
713 store_write_pair(fd, key, value);
716 /* write the rest of the config */
717 if (copy_begin < st.st_size)
718 write(fd, contents + copy_begin,
719 st.st_size - copy_begin);
721 munmap(contents, st.st_size);
722 unlink(config_filename);
725 if (rename(lock_file, config_filename) < 0) {
726 fprintf(stderr, "Could not rename the lock file?\n");
727 ret = 4;
728 goto out_free;
731 ret = 0;
733 out_free:
734 if (0 <= fd)
735 close(fd);
736 free(config_filename);
737 if (lock_file) {
738 unlink(lock_file);
739 free(lock_file);
741 return ret;