tutorial: shorthand for remotes but show distributed nature of git
[git/jnareb-git.git] / config.c
blobb6082f597c118d75a9342d1e0bf5788c7a8257ee
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"
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)
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';
31 if (c == '\n')
32 config_linenr++;
33 if (c == EOF) {
34 config_file = NULL;
35 c = '\n';
38 return c;
41 static char *parse_value(void)
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;
56 if (comment)
57 continue;
58 if (isspace(c) && !quote) {
59 space = 1;
60 continue;
62 if (!quote) {
63 if (c == ';' || c == '#') {
64 comment = 1;
65 continue;
68 if (space) {
69 if (len)
70 value[len++] = ' ';
71 space = 0;
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;
94 value[len++] = c;
95 continue;
97 if (c == '"') {
98 quote = 1-quote;
99 continue;
101 value[len++] = c;
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;
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;
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;
165 name[baselen++] = c;
166 if (baselen > MAXNAME / 2)
167 return -1;
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);
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;
211 if (comment || isspace(c))
212 continue;
213 if (c == '#' || c == ';') {
214 comment = 1;
215 continue;
217 if (c == '[') {
218 baselen = get_base_var(var);
219 if (baselen <= 0)
220 break;
221 var[baselen++] = '.';
222 var[baselen] = 0;
223 continue;
225 if (!isalpha(c))
226 break;
227 var[baselen] = tolower(c);
228 if (get_value(fn, var, baselen+1) < 0)
229 break;
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;
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;
272 if (!strcmp(var, "core.bare")) {
273 is_bare_repository_cfg = git_config_bool(var, value);
274 return 0;
277 if (!strcmp(var, "core.ignorestat")) {
278 assume_unchanged = git_config_bool(var, value);
279 return 0;
282 if (!strcmp(var, "core.prefersymlinkrefs")) {
283 prefer_symlink_refs = git_config_bool(var, value);
284 return 0;
287 if (!strcmp(var, "core.logallrefupdates")) {
288 log_all_ref_updates = git_config_bool(var, value);
289 return 0;
292 if (!strcmp(var, "core.warnambiguousrefs")) {
293 warn_ambiguous_refs = git_config_bool(var, value);
294 return 0;
297 if (!strcmp(var, "core.legacyheaders")) {
298 use_legacy_headers = git_config_bool(var, value);
299 return 0;
302 if (!strcmp(var, "core.compression")) {
303 int level = git_config_int(var, value);
304 if (level == -1)
305 level = Z_DEFAULT_COMPRESSION;
306 else if (level < 0 || level > Z_BEST_COMPRESSION)
307 die("bad zlib compression level %d", level);
308 zlib_compression_level = level;
309 return 0;
312 if (!strcmp(var, "core.packedgitwindowsize")) {
313 int pgsz = getpagesize();
314 packed_git_window_size = git_config_int(var, value);
315 packed_git_window_size /= pgsz;
316 if (packed_git_window_size < 2)
317 packed_git_window_size = 2;
318 packed_git_window_size *= pgsz;
319 return 0;
322 if (!strcmp(var, "core.packedgitlimit")) {
323 packed_git_limit = git_config_int(var, value);
324 return 0;
327 if (!strcmp(var, "user.name")) {
328 strlcpy(git_default_name, value, sizeof(git_default_name));
329 return 0;
332 if (!strcmp(var, "user.email")) {
333 strlcpy(git_default_email, value, sizeof(git_default_email));
334 return 0;
337 if (!strcmp(var, "i18n.commitencoding")) {
338 git_commit_encoding = strdup(value);
339 return 0;
342 if (!strcmp(var, "i18n.logoutputencoding")) {
343 git_log_output_encoding = strdup(value);
344 return 0;
348 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
349 pager_use_color = git_config_bool(var,value);
350 return 0;
353 /* Add other config variables here and to Documentation/config.txt. */
354 return 0;
357 int git_config_from_file(config_fn_t fn, const char *filename)
359 int ret;
360 FILE *f = fopen(filename, "r");
362 ret = -1;
363 if (f) {
364 config_file = f;
365 config_file_name = filename;
366 config_linenr = 1;
367 ret = git_parse_file(fn);
368 fclose(f);
369 config_file_name = NULL;
371 return ret;
374 int git_config(config_fn_t fn)
376 int ret = 0;
377 char *repo_config = NULL;
378 const char *home = NULL, *filename;
380 /* $GIT_CONFIG makes git read _only_ the given config file,
381 * $GIT_CONFIG_LOCAL will make it process it in addition to the
382 * global config file, the same way it would the per-repository
383 * config file otherwise. */
384 filename = getenv(CONFIG_ENVIRONMENT);
385 if (!filename) {
386 home = getenv("HOME");
387 filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
388 if (!filename)
389 filename = repo_config = xstrdup(git_path("config"));
392 if (home) {
393 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
394 if (!access(user_config, R_OK))
395 ret = git_config_from_file(fn, user_config);
396 free(user_config);
399 ret += git_config_from_file(fn, filename);
400 free(repo_config);
401 return ret;
405 * Find all the stuff for git_config_set() below.
408 #define MAX_MATCHES 512
410 static struct {
411 int baselen;
412 char* key;
413 int do_not_match;
414 regex_t* value_regex;
415 int multi_replace;
416 off_t offset[MAX_MATCHES];
417 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
418 int seen;
419 } store;
421 static int matches(const char* key, const char* value)
423 return !strcmp(key, store.key) &&
424 (store.value_regex == NULL ||
425 (store.do_not_match ^
426 !regexec(store.value_regex, value, 0, NULL, 0)));
429 static int store_aux(const char* key, const char* value)
431 switch (store.state) {
432 case KEY_SEEN:
433 if (matches(key, value)) {
434 if (store.seen == 1 && store.multi_replace == 0) {
435 fprintf(stderr,
436 "Warning: %s has multiple values\n",
437 key);
438 } else if (store.seen >= MAX_MATCHES) {
439 fprintf(stderr, "Too many matches\n");
440 return 1;
443 store.offset[store.seen] = ftell(config_file);
444 store.seen++;
446 break;
447 case SECTION_SEEN:
448 if (strncmp(key, store.key, store.baselen+1)) {
449 store.state = SECTION_END_SEEN;
450 break;
451 } else
452 /* do not increment matches: this is no match */
453 store.offset[store.seen] = ftell(config_file);
454 /* fallthru */
455 case SECTION_END_SEEN:
456 case START:
457 if (matches(key, value)) {
458 store.offset[store.seen] = ftell(config_file);
459 store.state = KEY_SEEN;
460 store.seen++;
461 } else {
462 if (strrchr(key, '.') - key == store.baselen &&
463 !strncmp(key, store.key, store.baselen)) {
464 store.state = SECTION_SEEN;
465 store.offset[store.seen] = ftell(config_file);
469 return 0;
472 static int write_error()
474 fprintf(stderr, "Failed to write new configuration file\n");
476 /* Same error code as "failed to rename". */
477 return 4;
480 static int store_write_section(int fd, const char* key)
482 const char *dot = strchr(key, '.');
483 int len1 = store.baselen, len2 = -1;
485 dot = strchr(key, '.');
486 if (dot) {
487 int dotlen = dot - key;
488 if (dotlen < len1) {
489 len2 = len1 - dotlen - 1;
490 len1 = dotlen;
494 if (write_in_full(fd, "[", 1) != 1 ||
495 write_in_full(fd, key, len1) != len1)
496 return 0;
497 if (len2 >= 0) {
498 if (write_in_full(fd, " \"", 2) != 2)
499 return 0;
500 while (--len2 >= 0) {
501 unsigned char c = *++dot;
502 if (c == '"')
503 if (write_in_full(fd, "\\", 1) != 1)
504 return 0;
505 if (write_in_full(fd, &c, 1) != 1)
506 return 0;
508 if (write_in_full(fd, "\"", 1) != 1)
509 return 0;
511 if (write_in_full(fd, "]\n", 2) != 2)
512 return 0;
514 return 1;
517 static int store_write_pair(int fd, const char* key, const char* value)
519 int i;
520 int length = strlen(key+store.baselen+1);
521 int quote = 0;
523 /* Check to see if the value needs to be quoted. */
524 if (value[0] == ' ')
525 quote = 1;
526 for (i = 0; value[i]; i++)
527 if (value[i] == ';' || value[i] == '#')
528 quote = 1;
529 if (value[i-1] == ' ')
530 quote = 1;
532 if (write_in_full(fd, "\t", 1) != 1 ||
533 write_in_full(fd, key+store.baselen+1, length) != length ||
534 write_in_full(fd, " = ", 3) != 3)
535 return 0;
536 if (quote && write_in_full(fd, "\"", 1) != 1)
537 return 0;
538 for (i = 0; value[i]; i++)
539 switch (value[i]) {
540 case '\n':
541 if (write_in_full(fd, "\\n", 2) != 2)
542 return 0;
543 break;
544 case '\t':
545 if (write_in_full(fd, "\\t", 2) != 2)
546 return 0;
547 break;
548 case '"':
549 case '\\':
550 if (write_in_full(fd, "\\", 1) != 1)
551 return 0;
552 default:
553 if (write_in_full(fd, value+i, 1) != 1)
554 return 0;
555 break;
557 if (quote && write_in_full(fd, "\"", 1) != 1)
558 return 0;
559 if (write_in_full(fd, "\n", 1) != 1)
560 return 0;
561 return 1;
564 static int find_beginning_of_line(const char* contents, int size,
565 int offset_, int* found_bracket)
567 int equal_offset = size, bracket_offset = size;
568 int offset;
570 for (offset = offset_-2; offset > 0
571 && contents[offset] != '\n'; offset--)
572 switch (contents[offset]) {
573 case '=': equal_offset = offset; break;
574 case ']': bracket_offset = offset; break;
576 if (bracket_offset < equal_offset) {
577 *found_bracket = 1;
578 offset = bracket_offset+1;
579 } else
580 offset++;
582 return offset;
585 int git_config_set(const char* key, const char* value)
587 return git_config_set_multivar(key, value, NULL, 0);
591 * If value==NULL, unset in (remove from) config,
592 * if value_regex!=NULL, disregard key/value pairs where value does not match.
593 * if multi_replace==0, nothing, or only one matching key/value is replaced,
594 * else all matching key/values (regardless how many) are removed,
595 * before the new pair is written.
597 * Returns 0 on success.
599 * This function does this:
601 * - it locks the config file by creating ".git/config.lock"
603 * - it then parses the config using store_aux() as validator to find
604 * the position on the key/value pair to replace. If it is to be unset,
605 * it must be found exactly once.
607 * - the config file is mmap()ed and the part before the match (if any) is
608 * written to the lock file, then the changed part and the rest.
610 * - the config file is removed and the lock file rename()d to it.
613 int git_config_set_multivar(const char* key, const char* value,
614 const char* value_regex, int multi_replace)
616 int i, dot;
617 int fd = -1, in_fd;
618 int ret;
619 char* config_filename;
620 char* lock_file;
621 const char* last_dot = strrchr(key, '.');
623 config_filename = getenv(CONFIG_ENVIRONMENT);
624 if (!config_filename) {
625 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
626 if (!config_filename)
627 config_filename = git_path("config");
629 config_filename = xstrdup(config_filename);
630 lock_file = xstrdup(mkpath("%s.lock", config_filename));
633 * Since "key" actually contains the section name and the real
634 * key name separated by a dot, we have to know where the dot is.
637 if (last_dot == NULL) {
638 fprintf(stderr, "key does not contain a section: %s\n", key);
639 ret = 2;
640 goto out_free;
642 store.baselen = last_dot - key;
644 store.multi_replace = multi_replace;
647 * Validate the key and while at it, lower case it for matching.
649 store.key = xmalloc(strlen(key) + 1);
650 dot = 0;
651 for (i = 0; key[i]; i++) {
652 unsigned char c = key[i];
653 if (c == '.')
654 dot = 1;
655 /* Leave the extended basename untouched.. */
656 if (!dot || i > store.baselen) {
657 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
658 fprintf(stderr, "invalid key: %s\n", key);
659 free(store.key);
660 ret = 1;
661 goto out_free;
663 c = tolower(c);
665 store.key[i] = c;
667 store.key[i] = 0;
670 * The lock_file serves a purpose in addition to locking: the new
671 * contents of .git/config will be written into it.
673 fd = open(lock_file, O_WRONLY | O_CREAT | O_EXCL, 0666);
674 if (fd < 0 || adjust_shared_perm(lock_file)) {
675 fprintf(stderr, "could not lock config file\n");
676 free(store.key);
677 ret = -1;
678 goto out_free;
682 * If .git/config does not exist yet, write a minimal version.
684 in_fd = open(config_filename, O_RDONLY);
685 if ( in_fd < 0 ) {
686 free(store.key);
688 if ( ENOENT != errno ) {
689 error("opening %s: %s", config_filename,
690 strerror(errno));
691 ret = 3; /* same as "invalid config file" */
692 goto out_free;
694 /* if nothing to unset, error out */
695 if (value == NULL) {
696 ret = 5;
697 goto out_free;
700 store.key = (char*)key;
701 if (!store_write_section(fd, key) ||
702 !store_write_pair(fd, key, value))
703 goto write_err_out;
704 } else {
705 struct stat st;
706 char* contents;
707 int i, copy_begin, copy_end, new_line = 0;
709 if (value_regex == NULL)
710 store.value_regex = NULL;
711 else {
712 if (value_regex[0] == '!') {
713 store.do_not_match = 1;
714 value_regex++;
715 } else
716 store.do_not_match = 0;
718 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
719 if (regcomp(store.value_regex, value_regex,
720 REG_EXTENDED)) {
721 fprintf(stderr, "Invalid pattern: %s\n",
722 value_regex);
723 free(store.value_regex);
724 ret = 6;
725 goto out_free;
729 store.offset[0] = 0;
730 store.state = START;
731 store.seen = 0;
734 * After this, store.offset will contain the *end* offset
735 * of the last match, or remain at 0 if no match was found.
736 * As a side effect, we make sure to transform only a valid
737 * existing config file.
739 if (git_config_from_file(store_aux, config_filename)) {
740 fprintf(stderr, "invalid config file\n");
741 free(store.key);
742 if (store.value_regex != NULL) {
743 regfree(store.value_regex);
744 free(store.value_regex);
746 ret = 3;
747 goto out_free;
750 free(store.key);
751 if (store.value_regex != NULL) {
752 regfree(store.value_regex);
753 free(store.value_regex);
756 /* if nothing to unset, or too many matches, error out */
757 if ((store.seen == 0 && value == NULL) ||
758 (store.seen > 1 && multi_replace == 0)) {
759 ret = 5;
760 goto out_free;
763 fstat(in_fd, &st);
764 contents = xmmap(NULL, st.st_size, PROT_READ,
765 MAP_PRIVATE, in_fd, 0);
766 close(in_fd);
768 if (store.seen == 0)
769 store.seen = 1;
771 for (i = 0, copy_begin = 0; i < store.seen; i++) {
772 if (store.offset[i] == 0) {
773 store.offset[i] = copy_end = st.st_size;
774 } else if (store.state != KEY_SEEN) {
775 copy_end = store.offset[i];
776 } else
777 copy_end = find_beginning_of_line(
778 contents, st.st_size,
779 store.offset[i]-2, &new_line);
781 /* write the first part of the config */
782 if (copy_end > copy_begin) {
783 if (write_in_full(fd, contents + copy_begin,
784 copy_end - copy_begin) <
785 copy_end - copy_begin)
786 goto write_err_out;
787 if (new_line &&
788 write_in_full(fd, "\n", 1) != 1)
789 goto write_err_out;
791 copy_begin = store.offset[i];
794 /* write the pair (value == NULL means unset) */
795 if (value != NULL) {
796 if (store.state == START) {
797 if (!store_write_section(fd, key))
798 goto write_err_out;
800 if (!store_write_pair(fd, key, value))
801 goto write_err_out;
804 /* write the rest of the config */
805 if (copy_begin < st.st_size)
806 if (write_in_full(fd, contents + copy_begin,
807 st.st_size - copy_begin) <
808 st.st_size - copy_begin)
809 goto write_err_out;
811 munmap(contents, st.st_size);
812 unlink(config_filename);
815 if (rename(lock_file, config_filename) < 0) {
816 fprintf(stderr, "Could not rename the lock file?\n");
817 ret = 4;
818 goto out_free;
821 ret = 0;
823 out_free:
824 if (0 <= fd)
825 close(fd);
826 free(config_filename);
827 if (lock_file) {
828 unlink(lock_file);
829 free(lock_file);
831 return ret;
833 write_err_out:
834 ret = write_error();
835 goto out_free;
839 int git_config_rename_section(const char *old_name, const char *new_name)
841 int ret = 0;
842 char *config_filename;
843 struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
844 int out_fd;
845 char buf[1024];
847 config_filename = getenv(CONFIG_ENVIRONMENT);
848 if (!config_filename) {
849 config_filename = getenv(CONFIG_LOCAL_ENVIRONMENT);
850 if (!config_filename)
851 config_filename = git_path("config");
853 config_filename = xstrdup(config_filename);
854 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
855 if (out_fd < 0) {
856 ret = error("Could not lock config file!");
857 goto out;
860 if (!(config_file = fopen(config_filename, "rb"))) {
861 ret = error("Could not open config file!");
862 goto out;
865 while (fgets(buf, sizeof(buf), config_file)) {
866 int i;
867 int length;
868 for (i = 0; buf[i] && isspace(buf[i]); i++)
869 ; /* do nothing */
870 if (buf[i] == '[') {
871 /* it's a section */
872 int j = 0, dot = 0;
873 for (i++; buf[i] && buf[i] != ']'; i++) {
874 if (!dot && isspace(buf[i])) {
875 dot = 1;
876 if (old_name[j++] != '.')
877 break;
878 for (i++; isspace(buf[i]); i++)
879 ; /* do nothing */
880 if (buf[i] != '"')
881 break;
882 continue;
884 if (buf[i] == '\\' && dot)
885 i++;
886 else if (buf[i] == '"' && dot) {
887 for (i++; isspace(buf[i]); i++)
888 ; /* do_nothing */
889 break;
891 if (buf[i] != old_name[j++])
892 break;
894 if (buf[i] == ']') {
895 /* old_name matches */
896 ret++;
897 store.baselen = strlen(new_name);
898 if (!store_write_section(out_fd, new_name)) {
899 ret = write_error();
900 goto out;
902 continue;
905 length = strlen(buf);
906 if (write_in_full(out_fd, buf, length) != length) {
907 ret = write_error();
908 goto out;
911 fclose(config_file);
912 if (close(out_fd) || commit_lock_file(lock) < 0)
913 ret = error("Cannot commit config file!");
914 out:
915 free(config_filename);
916 return ret;