Code

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