git-shortlog(1): document behaviour of zero-width wrap
[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"
10
11 #define MAXNAME (256)
12
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;
18
19 const char *config_exclusive_filename = NULL;
20
21 static int get_next_char(void)
22 {
23         int c;
24         FILE *f;
25
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 }
46
47 static char *parse_value(void)
48 {
49         static char value[1024];
50         int quote = 0, comment = 0, len = 0, space = 0;
51
52         for (;;) {
53                 int c = get_next_char();
54                 if (len >= sizeof(value) - 1)
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                         if (len)
66                                 space++;
67                         continue;
68                 }
69                 if (!quote) {
70                         if (c == ';' || c == '#') {
71                                 comment = 1;
72                                 continue;
73                         }
74                 }
75                 for (; space; space--)
76                         value[len++] = ' ';
77                 if (c == '\\') {
78                         c = get_next_char();
79                         switch (c) {
80                         case '\n':
81                                 continue;
82                         case 't':
83                                 c = '\t';
84                                 break;
85                         case 'b':
86                                 c = '\b';
87                                 break;
88                         case 'n':
89                                 c = '\n';
90                                 break;
91                         /* Some characters escape as themselves */
92                         case '\\': case '"':
93                                 break;
94                         /* Reject unknown escape sequences */
95                         default:
96                                 return NULL;
97                         }
98                         value[len++] = c;
99                         continue;
100                 }
101                 if (c == '"') {
102                         quote = 1-quote;
103                         continue;
104                 }
105                 value[len++] = c;
106         }
107 }
108
109 static inline int iskeychar(int c)
110 {
111         return isalnum(c) || c == '-';
112 }
113
114 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
115 {
116         int c;
117         char *value;
118
119         /* Get the full name */
120         for (;;) {
121                 c = get_next_char();
122                 if (config_file_eof)
123                         break;
124                 if (!iskeychar(c))
125                         break;
126                 name[len++] = tolower(c);
127                 if (len >= MAXNAME)
128                         return -1;
129         }
130         name[len] = 0;
131         while (c == ' ' || c == '\t')
132                 c = get_next_char();
133
134         value = NULL;
135         if (c != '\n') {
136                 if (c != '=')
137                         return -1;
138                 value = parse_value();
139                 if (!value)
140                         return -1;
141         }
142         return fn(name, value, data);
143 }
144
145 static int get_extended_base_var(char *name, int baselen, int c)
146 {
147         do {
148                 if (c == '\n')
149                         return -1;
150                 c = get_next_char();
151         } while (isspace(c));
152
153         /* We require the format to be '[base "extension"]' */
154         if (c != '"')
155                 return -1;
156         name[baselen++] = '.';
157
158         for (;;) {
159                 int c = get_next_char();
160                 if (c == '\n')
161                         return -1;
162                 if (c == '"')
163                         break;
164                 if (c == '\\') {
165                         c = get_next_char();
166                         if (c == '\n')
167                                 return -1;
168                 }
169                 name[baselen++] = c;
170                 if (baselen > MAXNAME / 2)
171                         return -1;
172         }
173
174         /* Final ']' */
175         if (get_next_char() != ']')
176                 return -1;
177         return baselen;
178 }
179
180 static int get_base_var(char *name)
181 {
182         int baselen = 0;
183
184         for (;;) {
185                 int c = get_next_char();
186                 if (config_file_eof)
187                         return -1;
188                 if (c == ']')
189                         return baselen;
190                 if (isspace(c))
191                         return get_extended_base_var(name, baselen, c);
192                 if (!iskeychar(c) && c != '.')
193                         return -1;
194                 if (baselen > MAXNAME / 2)
195                         return -1;
196                 name[baselen++] = tolower(c);
197         }
198 }
199
200 static int git_parse_file(config_fn_t fn, void *data)
201 {
202         int comment = 0;
203         int baselen = 0;
204         static char var[MAXNAME];
205
206         /* U+FEFF Byte Order Mark in UTF8 */
207         static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
208         const unsigned char *bomptr = utf8_bom;
209
210         for (;;) {
211                 int c = get_next_char();
212                 if (bomptr && *bomptr) {
213                         /* We are at the file beginning; skip UTF8-encoded BOM
214                          * if present. Sane editors won't put this in on their
215                          * own, but e.g. Windows Notepad will do it happily. */
216                         if ((unsigned char) c == *bomptr) {
217                                 bomptr++;
218                                 continue;
219                         } else {
220                                 /* Do not tolerate partial BOM. */
221                                 if (bomptr != utf8_bom)
222                                         break;
223                                 /* No BOM at file beginning. Cool. */
224                                 bomptr = NULL;
225                         }
226                 }
227                 if (c == '\n') {
228                         if (config_file_eof)
229                                 return 0;
230                         comment = 0;
231                         continue;
232                 }
233                 if (comment || isspace(c))
234                         continue;
235                 if (c == '#' || c == ';') {
236                         comment = 1;
237                         continue;
238                 }
239                 if (c == '[') {
240                         baselen = get_base_var(var);
241                         if (baselen <= 0)
242                                 break;
243                         var[baselen++] = '.';
244                         var[baselen] = 0;
245                         continue;
246                 }
247                 if (!isalpha(c))
248                         break;
249                 var[baselen] = tolower(c);
250                 if (get_value(fn, data, var, baselen+1) < 0)
251                         break;
252         }
253         die("bad config file line %d in %s", config_linenr, config_file_name);
254 }
255
256 static int parse_unit_factor(const char *end, unsigned long *val)
257 {
258         if (!*end)
259                 return 1;
260         else if (!strcasecmp(end, "k")) {
261                 *val *= 1024;
262                 return 1;
263         }
264         else if (!strcasecmp(end, "m")) {
265                 *val *= 1024 * 1024;
266                 return 1;
267         }
268         else if (!strcasecmp(end, "g")) {
269                 *val *= 1024 * 1024 * 1024;
270                 return 1;
271         }
272         return 0;
273 }
274
275 static int git_parse_long(const char *value, long *ret)
276 {
277         if (value && *value) {
278                 char *end;
279                 long val = strtol(value, &end, 0);
280                 unsigned long factor = 1;
281                 if (!parse_unit_factor(end, &factor))
282                         return 0;
283                 *ret = val * factor;
284                 return 1;
285         }
286         return 0;
287 }
288
289 int git_parse_ulong(const char *value, unsigned long *ret)
290 {
291         if (value && *value) {
292                 char *end;
293                 unsigned long val = strtoul(value, &end, 0);
294                 if (!parse_unit_factor(end, &val))
295                         return 0;
296                 *ret = val;
297                 return 1;
298         }
299         return 0;
300 }
301
302 static void die_bad_config(const char *name)
303 {
304         if (config_file_name)
305                 die("bad config value for '%s' in %s", name, config_file_name);
306         die("bad config value for '%s'", name);
307 }
308
309 int git_config_int(const char *name, const char *value)
310 {
311         long ret = 0;
312         if (!git_parse_long(value, &ret))
313                 die_bad_config(name);
314         return ret;
315 }
316
317 unsigned long git_config_ulong(const char *name, const char *value)
318 {
319         unsigned long ret;
320         if (!git_parse_ulong(value, &ret))
321                 die_bad_config(name);
322         return ret;
323 }
324
325 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
326 {
327         *is_bool = 1;
328         if (!value)
329                 return 1;
330         if (!*value)
331                 return 0;
332         if (!strcasecmp(value, "true") || !strcasecmp(value, "yes") || !strcasecmp(value, "on"))
333                 return 1;
334         if (!strcasecmp(value, "false") || !strcasecmp(value, "no") || !strcasecmp(value, "off"))
335                 return 0;
336         *is_bool = 0;
337         return git_config_int(name, value);
338 }
339
340 int git_config_bool(const char *name, const char *value)
341 {
342         int discard;
343         return !!git_config_bool_or_int(name, value, &discard);
344 }
345
346 int git_config_string(const char **dest, const char *var, const char *value)
347 {
348         if (!value)
349                 return config_error_nonbool(var);
350         *dest = xstrdup(value);
351         return 0;
352 }
353
354 static int git_default_core_config(const char *var, const char *value)
355 {
356         /* This needs a better name */
357         if (!strcmp(var, "core.filemode")) {
358                 trust_executable_bit = git_config_bool(var, value);
359                 return 0;
360         }
361         if (!strcmp(var, "core.trustctime")) {
362                 trust_ctime = git_config_bool(var, value);
363                 return 0;
364         }
365
366         if (!strcmp(var, "core.quotepath")) {
367                 quote_path_fully = git_config_bool(var, value);
368                 return 0;
369         }
370
371         if (!strcmp(var, "core.symlinks")) {
372                 has_symlinks = git_config_bool(var, value);
373                 return 0;
374         }
375
376         if (!strcmp(var, "core.ignorecase")) {
377                 ignore_case = git_config_bool(var, value);
378                 return 0;
379         }
380
381         if (!strcmp(var, "core.bare")) {
382                 is_bare_repository_cfg = git_config_bool(var, value);
383                 return 0;
384         }
385
386         if (!strcmp(var, "core.ignorestat")) {
387                 assume_unchanged = git_config_bool(var, value);
388                 return 0;
389         }
390
391         if (!strcmp(var, "core.prefersymlinkrefs")) {
392                 prefer_symlink_refs = git_config_bool(var, value);
393                 return 0;
394         }
395
396         if (!strcmp(var, "core.logallrefupdates")) {
397                 log_all_ref_updates = git_config_bool(var, value);
398                 return 0;
399         }
400
401         if (!strcmp(var, "core.warnambiguousrefs")) {
402                 warn_ambiguous_refs = git_config_bool(var, value);
403                 return 0;
404         }
405
406         if (!strcmp(var, "core.loosecompression")) {
407                 int level = git_config_int(var, value);
408                 if (level == -1)
409                         level = Z_DEFAULT_COMPRESSION;
410                 else if (level < 0 || level > Z_BEST_COMPRESSION)
411                         die("bad zlib compression level %d", level);
412                 zlib_compression_level = level;
413                 zlib_compression_seen = 1;
414                 return 0;
415         }
416
417         if (!strcmp(var, "core.compression")) {
418                 int level = git_config_int(var, value);
419                 if (level == -1)
420                         level = Z_DEFAULT_COMPRESSION;
421                 else if (level < 0 || level > Z_BEST_COMPRESSION)
422                         die("bad zlib compression level %d", level);
423                 core_compression_level = level;
424                 core_compression_seen = 1;
425                 if (!zlib_compression_seen)
426                         zlib_compression_level = level;
427                 return 0;
428         }
429
430         if (!strcmp(var, "core.packedgitwindowsize")) {
431                 int pgsz_x2 = getpagesize() * 2;
432                 packed_git_window_size = git_config_int(var, value);
433
434                 /* This value must be multiple of (pagesize * 2) */
435                 packed_git_window_size /= pgsz_x2;
436                 if (packed_git_window_size < 1)
437                         packed_git_window_size = 1;
438                 packed_git_window_size *= pgsz_x2;
439                 return 0;
440         }
441
442         if (!strcmp(var, "core.packedgitlimit")) {
443                 packed_git_limit = git_config_int(var, value);
444                 return 0;
445         }
446
447         if (!strcmp(var, "core.deltabasecachelimit")) {
448                 delta_base_cache_limit = git_config_int(var, value);
449                 return 0;
450         }
451
452         if (!strcmp(var, "core.autocrlf")) {
453                 if (value && !strcasecmp(value, "input")) {
454                         auto_crlf = -1;
455                         return 0;
456                 }
457                 auto_crlf = git_config_bool(var, value);
458                 return 0;
459         }
460
461         if (!strcmp(var, "core.safecrlf")) {
462                 if (value && !strcasecmp(value, "warn")) {
463                         safe_crlf = SAFE_CRLF_WARN;
464                         return 0;
465                 }
466                 safe_crlf = git_config_bool(var, value);
467                 return 0;
468         }
469
470         if (!strcmp(var, "core.pager"))
471                 return git_config_string(&pager_program, var, value);
472
473         if (!strcmp(var, "core.editor"))
474                 return git_config_string(&editor_program, var, value);
475
476         if (!strcmp(var, "core.excludesfile"))
477                 return git_config_string(&excludes_file, var, value);
478
479         if (!strcmp(var, "core.whitespace")) {
480                 if (!value)
481                         return config_error_nonbool(var);
482                 whitespace_rule_cfg = parse_whitespace_rule(value);
483                 return 0;
484         }
485
486         if (!strcmp(var, "core.fsyncobjectfiles")) {
487                 fsync_object_files = git_config_bool(var, value);
488                 return 0;
489         }
490
491         if (!strcmp(var, "core.preloadindex")) {
492                 core_preload_index = git_config_bool(var, value);
493                 return 0;
494         }
495
496         if (!strcmp(var, "core.createobject")) {
497                 if (!strcmp(value, "rename"))
498                         object_creation_mode = OBJECT_CREATION_USES_RENAMES;
499                 else if (!strcmp(value, "link"))
500                         object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
501                 else
502                         die("Invalid mode for object creation: %s", value);
503                 return 0;
504         }
505
506         /* Add other config variables here and to Documentation/config.txt. */
507         return 0;
508 }
509
510 static int git_default_user_config(const char *var, const char *value)
511 {
512         if (!strcmp(var, "user.name")) {
513                 if (!value)
514                         return config_error_nonbool(var);
515                 strlcpy(git_default_name, value, sizeof(git_default_name));
516                 if (git_default_email[0])
517                         user_ident_explicitly_given = 1;
518                 return 0;
519         }
520
521         if (!strcmp(var, "user.email")) {
522                 if (!value)
523                         return config_error_nonbool(var);
524                 strlcpy(git_default_email, value, sizeof(git_default_email));
525                 if (git_default_name[0])
526                         user_ident_explicitly_given = 1;
527                 return 0;
528         }
529
530         /* Add other config variables here and to Documentation/config.txt. */
531         return 0;
532 }
533
534 static int git_default_i18n_config(const char *var, const char *value)
535 {
536         if (!strcmp(var, "i18n.commitencoding"))
537                 return git_config_string(&git_commit_encoding, var, value);
538
539         if (!strcmp(var, "i18n.logoutputencoding"))
540                 return git_config_string(&git_log_output_encoding, var, value);
541
542         /* Add other config variables here and to Documentation/config.txt. */
543         return 0;
544 }
545
546 static int git_default_branch_config(const char *var, const char *value)
547 {
548         if (!strcmp(var, "branch.autosetupmerge")) {
549                 if (value && !strcasecmp(value, "always")) {
550                         git_branch_track = BRANCH_TRACK_ALWAYS;
551                         return 0;
552                 }
553                 git_branch_track = git_config_bool(var, value);
554                 return 0;
555         }
556         if (!strcmp(var, "branch.autosetuprebase")) {
557                 if (!value)
558                         return config_error_nonbool(var);
559                 else if (!strcmp(value, "never"))
560                         autorebase = AUTOREBASE_NEVER;
561                 else if (!strcmp(value, "local"))
562                         autorebase = AUTOREBASE_LOCAL;
563                 else if (!strcmp(value, "remote"))
564                         autorebase = AUTOREBASE_REMOTE;
565                 else if (!strcmp(value, "always"))
566                         autorebase = AUTOREBASE_ALWAYS;
567                 else
568                         return error("Malformed value for %s", var);
569                 return 0;
570         }
571
572         /* Add other config variables here and to Documentation/config.txt. */
573         return 0;
574 }
575
576 static int git_default_push_config(const char *var, const char *value)
577 {
578         if (!strcmp(var, "push.default")) {
579                 if (!value)
580                         return config_error_nonbool(var);
581                 else if (!strcmp(value, "nothing"))
582                         push_default = PUSH_DEFAULT_NOTHING;
583                 else if (!strcmp(value, "matching"))
584                         push_default = PUSH_DEFAULT_MATCHING;
585                 else if (!strcmp(value, "tracking"))
586                         push_default = PUSH_DEFAULT_TRACKING;
587                 else if (!strcmp(value, "current"))
588                         push_default = PUSH_DEFAULT_CURRENT;
589                 else {
590                         error("Malformed value for %s: %s", var, value);
591                         return error("Must be one of nothing, matching, "
592                                      "tracking or current.");
593                 }
594                 return 0;
595         }
596
597         /* Add other config variables here and to Documentation/config.txt. */
598         return 0;
599 }
600
601 static int git_default_mailmap_config(const char *var, const char *value)
602 {
603         if (!strcmp(var, "mailmap.file"))
604                 return git_config_string(&git_mailmap_file, var, value);
605
606         /* Add other config variables here and to Documentation/config.txt. */
607         return 0;
608 }
609
610 int git_default_config(const char *var, const char *value, void *dummy)
611 {
612         if (!prefixcmp(var, "core."))
613                 return git_default_core_config(var, value);
614
615         if (!prefixcmp(var, "user."))
616                 return git_default_user_config(var, value);
617
618         if (!prefixcmp(var, "i18n."))
619                 return git_default_i18n_config(var, value);
620
621         if (!prefixcmp(var, "branch."))
622                 return git_default_branch_config(var, value);
623
624         if (!prefixcmp(var, "push."))
625                 return git_default_push_config(var, value);
626
627         if (!prefixcmp(var, "mailmap."))
628                 return git_default_mailmap_config(var, value);
629
630         if (!prefixcmp(var, "advice."))
631                 return git_default_advice_config(var, value);
632
633         if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
634                 pager_use_color = git_config_bool(var,value);
635                 return 0;
636         }
637
638         /* Add other config variables here and to Documentation/config.txt. */
639         return 0;
640 }
641
642 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
643 {
644         int ret;
645         FILE *f = fopen(filename, "r");
646
647         ret = -1;
648         if (f) {
649                 config_file = f;
650                 config_file_name = filename;
651                 config_linenr = 1;
652                 config_file_eof = 0;
653                 ret = git_parse_file(fn, data);
654                 fclose(f);
655                 config_file_name = NULL;
656         }
657         return ret;
658 }
659
660 const char *git_etc_gitconfig(void)
661 {
662         static const char *system_wide;
663         if (!system_wide)
664                 system_wide = system_path(ETC_GITCONFIG);
665         return system_wide;
666 }
667
668 static int git_env_bool(const char *k, int def)
669 {
670         const char *v = getenv(k);
671         return v ? git_config_bool(k, v) : def;
672 }
673
674 int git_config_system(void)
675 {
676         return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
677 }
678
679 int git_config_global(void)
680 {
681         return !git_env_bool("GIT_CONFIG_NOGLOBAL", 0);
682 }
683
684 int git_config(config_fn_t fn, void *data)
685 {
686         int ret = 0, found = 0;
687         char *repo_config = NULL;
688         const char *home = NULL;
689
690         /* Setting $GIT_CONFIG makes git read _only_ the given config file. */
691         if (config_exclusive_filename)
692                 return git_config_from_file(fn, config_exclusive_filename, data);
693         if (git_config_system() && !access(git_etc_gitconfig(), R_OK)) {
694                 ret += git_config_from_file(fn, git_etc_gitconfig(),
695                                             data);
696                 found += 1;
697         }
698
699         home = getenv("HOME");
700         if (git_config_global() && home) {
701                 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
702                 if (!access(user_config, R_OK)) {
703                         ret += git_config_from_file(fn, user_config, data);
704                         found += 1;
705                 }
706                 free(user_config);
707         }
708
709         repo_config = git_pathdup("config");
710         if (!access(repo_config, R_OK)) {
711                 ret += git_config_from_file(fn, repo_config, data);
712                 found += 1;
713         }
714         free(repo_config);
715         if (found == 0)
716                 return -1;
717         return ret;
718 }
719
720 /*
721  * Find all the stuff for git_config_set() below.
722  */
723
724 #define MAX_MATCHES 512
725
726 static struct {
727         int baselen;
728         char *key;
729         int do_not_match;
730         regex_t *value_regex;
731         int multi_replace;
732         size_t offset[MAX_MATCHES];
733         enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
734         int seen;
735 } store;
736
737 static int matches(const char *key, const char *value)
738 {
739         return !strcmp(key, store.key) &&
740                 (store.value_regex == NULL ||
741                  (store.do_not_match ^
742                   !regexec(store.value_regex, value, 0, NULL, 0)));
743 }
744
745 static int store_aux(const char *key, const char *value, void *cb)
746 {
747         const char *ep;
748         size_t section_len;
749
750         switch (store.state) {
751         case KEY_SEEN:
752                 if (matches(key, value)) {
753                         if (store.seen == 1 && store.multi_replace == 0) {
754                                 warning("%s has multiple values", key);
755                         } else if (store.seen >= MAX_MATCHES) {
756                                 error("too many matches for %s", key);
757                                 return 1;
758                         }
759
760                         store.offset[store.seen] = ftell(config_file);
761                         store.seen++;
762                 }
763                 break;
764         case SECTION_SEEN:
765                 /*
766                  * What we are looking for is in store.key (both
767                  * section and var), and its section part is baselen
768                  * long.  We found key (again, both section and var).
769                  * We would want to know if this key is in the same
770                  * section as what we are looking for.  We already
771                  * know we are in the same section as what should
772                  * hold store.key.
773                  */
774                 ep = strrchr(key, '.');
775                 section_len = ep - key;
776
777                 if ((section_len != store.baselen) ||
778                     memcmp(key, store.key, section_len+1)) {
779                         store.state = SECTION_END_SEEN;
780                         break;
781                 }
782
783                 /*
784                  * Do not increment matches: this is no match, but we
785                  * just made sure we are in the desired section.
786                  */
787                 store.offset[store.seen] = ftell(config_file);
788                 /* fallthru */
789         case SECTION_END_SEEN:
790         case START:
791                 if (matches(key, value)) {
792                         store.offset[store.seen] = ftell(config_file);
793                         store.state = KEY_SEEN;
794                         store.seen++;
795                 } else {
796                         if (strrchr(key, '.') - key == store.baselen &&
797                               !strncmp(key, store.key, store.baselen)) {
798                                         store.state = SECTION_SEEN;
799                                         store.offset[store.seen] = ftell(config_file);
800                         }
801                 }
802         }
803         return 0;
804 }
805
806 static int write_error(const char *filename)
807 {
808         error("failed to write new configuration file %s", filename);
809
810         /* Same error code as "failed to rename". */
811         return 4;
812 }
813
814 static int store_write_section(int fd, const char *key)
815 {
816         const char *dot;
817         int i, success;
818         struct strbuf sb = STRBUF_INIT;
819
820         dot = memchr(key, '.', store.baselen);
821         if (dot) {
822                 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
823                 for (i = dot - key + 1; i < store.baselen; i++) {
824                         if (key[i] == '"' || key[i] == '\\')
825                                 strbuf_addch(&sb, '\\');
826                         strbuf_addch(&sb, key[i]);
827                 }
828                 strbuf_addstr(&sb, "\"]\n");
829         } else {
830                 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
831         }
832
833         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
834         strbuf_release(&sb);
835
836         return success;
837 }
838
839 static int store_write_pair(int fd, const char *key, const char *value)
840 {
841         int i, success;
842         int length = strlen(key + store.baselen + 1);
843         const char *quote = "";
844         struct strbuf sb = STRBUF_INIT;
845
846         /*
847          * Check to see if the value needs to be surrounded with a dq pair.
848          * Note that problematic characters are always backslash-quoted; this
849          * check is about not losing leading or trailing SP and strings that
850          * follow beginning-of-comment characters (i.e. ';' and '#') by the
851          * configuration parser.
852          */
853         if (value[0] == ' ')
854                 quote = "\"";
855         for (i = 0; value[i]; i++)
856                 if (value[i] == ';' || value[i] == '#')
857                         quote = "\"";
858         if (i && value[i - 1] == ' ')
859                 quote = "\"";
860
861         strbuf_addf(&sb, "\t%.*s = %s",
862                     length, key + store.baselen + 1, quote);
863
864         for (i = 0; value[i]; i++)
865                 switch (value[i]) {
866                 case '\n':
867                         strbuf_addstr(&sb, "\\n");
868                         break;
869                 case '\t':
870                         strbuf_addstr(&sb, "\\t");
871                         break;
872                 case '"':
873                 case '\\':
874                         strbuf_addch(&sb, '\\');
875                 default:
876                         strbuf_addch(&sb, value[i]);
877                         break;
878                 }
879         strbuf_addf(&sb, "%s\n", quote);
880
881         success = write_in_full(fd, sb.buf, sb.len) == sb.len;
882         strbuf_release(&sb);
883
884         return success;
885 }
886
887 static ssize_t find_beginning_of_line(const char *contents, size_t size,
888         size_t offset_, int *found_bracket)
889 {
890         size_t equal_offset = size, bracket_offset = size;
891         ssize_t offset;
892
893 contline:
894         for (offset = offset_-2; offset > 0
895                         && contents[offset] != '\n'; offset--)
896                 switch (contents[offset]) {
897                         case '=': equal_offset = offset; break;
898                         case ']': bracket_offset = offset; break;
899                 }
900         if (offset > 0 && contents[offset-1] == '\\') {
901                 offset_ = offset;
902                 goto contline;
903         }
904         if (bracket_offset < equal_offset) {
905                 *found_bracket = 1;
906                 offset = bracket_offset+1;
907         } else
908                 offset++;
909
910         return offset;
911 }
912
913 int git_config_set(const char *key, const char *value)
914 {
915         return git_config_set_multivar(key, value, NULL, 0);
916 }
917
918 /*
919  * If value==NULL, unset in (remove from) config,
920  * if value_regex!=NULL, disregard key/value pairs where value does not match.
921  * if multi_replace==0, nothing, or only one matching key/value is replaced,
922  *     else all matching key/values (regardless how many) are removed,
923  *     before the new pair is written.
924  *
925  * Returns 0 on success.
926  *
927  * This function does this:
928  *
929  * - it locks the config file by creating ".git/config.lock"
930  *
931  * - it then parses the config using store_aux() as validator to find
932  *   the position on the key/value pair to replace. If it is to be unset,
933  *   it must be found exactly once.
934  *
935  * - the config file is mmap()ed and the part before the match (if any) is
936  *   written to the lock file, then the changed part and the rest.
937  *
938  * - the config file is removed and the lock file rename()d to it.
939  *
940  */
941 int git_config_set_multivar(const char *key, const char *value,
942         const char *value_regex, int multi_replace)
943 {
944         int i, dot;
945         int fd = -1, in_fd;
946         int ret;
947         char *config_filename;
948         struct lock_file *lock = NULL;
949         const char *last_dot = strrchr(key, '.');
950
951         if (config_exclusive_filename)
952                 config_filename = xstrdup(config_exclusive_filename);
953         else
954                 config_filename = git_pathdup("config");
955
956         /*
957          * Since "key" actually contains the section name and the real
958          * key name separated by a dot, we have to know where the dot is.
959          */
960
961         if (last_dot == NULL) {
962                 error("key does not contain a section: %s", key);
963                 ret = 2;
964                 goto out_free;
965         }
966         store.baselen = last_dot - key;
967
968         store.multi_replace = multi_replace;
969
970         /*
971          * Validate the key and while at it, lower case it for matching.
972          */
973         store.key = xmalloc(strlen(key) + 1);
974         dot = 0;
975         for (i = 0; key[i]; i++) {
976                 unsigned char c = key[i];
977                 if (c == '.')
978                         dot = 1;
979                 /* Leave the extended basename untouched.. */
980                 if (!dot || i > store.baselen) {
981                         if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
982                                 error("invalid key: %s", key);
983                                 free(store.key);
984                                 ret = 1;
985                                 goto out_free;
986                         }
987                         c = tolower(c);
988                 } else if (c == '\n') {
989                         error("invalid key (newline): %s", key);
990                         free(store.key);
991                         ret = 1;
992                         goto out_free;
993                 }
994                 store.key[i] = c;
995         }
996         store.key[i] = 0;
997
998         /*
999          * The lock serves a purpose in addition to locking: the new
1000          * contents of .git/config will be written into it.
1001          */
1002         lock = xcalloc(sizeof(struct lock_file), 1);
1003         fd = hold_lock_file_for_update(lock, config_filename, 0);
1004         if (fd < 0) {
1005                 error("could not lock config file %s: %s", config_filename, strerror(errno));
1006                 free(store.key);
1007                 ret = -1;
1008                 goto out_free;
1009         }
1010
1011         /*
1012          * If .git/config does not exist yet, write a minimal version.
1013          */
1014         in_fd = open(config_filename, O_RDONLY);
1015         if ( in_fd < 0 ) {
1016                 free(store.key);
1017
1018                 if ( ENOENT != errno ) {
1019                         error("opening %s: %s", config_filename,
1020                               strerror(errno));
1021                         ret = 3; /* same as "invalid config file" */
1022                         goto out_free;
1023                 }
1024                 /* if nothing to unset, error out */
1025                 if (value == NULL) {
1026                         ret = 5;
1027                         goto out_free;
1028                 }
1029
1030                 store.key = (char *)key;
1031                 if (!store_write_section(fd, key) ||
1032                     !store_write_pair(fd, key, value))
1033                         goto write_err_out;
1034         } else {
1035                 struct stat st;
1036                 char *contents;
1037                 size_t contents_sz, copy_begin, copy_end;
1038                 int i, new_line = 0;
1039
1040                 if (value_regex == NULL)
1041                         store.value_regex = NULL;
1042                 else {
1043                         if (value_regex[0] == '!') {
1044                                 store.do_not_match = 1;
1045                                 value_regex++;
1046                         } else
1047                                 store.do_not_match = 0;
1048
1049                         store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1050                         if (regcomp(store.value_regex, value_regex,
1051                                         REG_EXTENDED)) {
1052                                 error("invalid pattern: %s", value_regex);
1053                                 free(store.value_regex);
1054                                 ret = 6;
1055                                 goto out_free;
1056                         }
1057                 }
1058
1059                 store.offset[0] = 0;
1060                 store.state = START;
1061                 store.seen = 0;
1062
1063                 /*
1064                  * After this, store.offset will contain the *end* offset
1065                  * of the last match, or remain at 0 if no match was found.
1066                  * As a side effect, we make sure to transform only a valid
1067                  * existing config file.
1068                  */
1069                 if (git_config_from_file(store_aux, config_filename, NULL)) {
1070                         error("invalid config file %s", config_filename);
1071                         free(store.key);
1072                         if (store.value_regex != NULL) {
1073                                 regfree(store.value_regex);
1074                                 free(store.value_regex);
1075                         }
1076                         ret = 3;
1077                         goto out_free;
1078                 }
1079
1080                 free(store.key);
1081                 if (store.value_regex != NULL) {
1082                         regfree(store.value_regex);
1083                         free(store.value_regex);
1084                 }
1085
1086                 /* if nothing to unset, or too many matches, error out */
1087                 if ((store.seen == 0 && value == NULL) ||
1088                                 (store.seen > 1 && multi_replace == 0)) {
1089                         ret = 5;
1090                         goto out_free;
1091                 }
1092
1093                 fstat(in_fd, &st);
1094                 contents_sz = xsize_t(st.st_size);
1095                 contents = xmmap(NULL, contents_sz, PROT_READ,
1096                         MAP_PRIVATE, in_fd, 0);
1097                 close(in_fd);
1098
1099                 if (store.seen == 0)
1100                         store.seen = 1;
1101
1102                 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1103                         if (store.offset[i] == 0) {
1104                                 store.offset[i] = copy_end = contents_sz;
1105                         } else if (store.state != KEY_SEEN) {
1106                                 copy_end = store.offset[i];
1107                         } else
1108                                 copy_end = find_beginning_of_line(
1109                                         contents, contents_sz,
1110                                         store.offset[i]-2, &new_line);
1111
1112                         if (copy_end > 0 && contents[copy_end-1] != '\n')
1113                                 new_line = 1;
1114
1115                         /* write the first part of the config */
1116                         if (copy_end > copy_begin) {
1117                                 if (write_in_full(fd, contents + copy_begin,
1118                                                   copy_end - copy_begin) <
1119                                     copy_end - copy_begin)
1120                                         goto write_err_out;
1121                                 if (new_line &&
1122                                     write_str_in_full(fd, "\n") != 1)
1123                                         goto write_err_out;
1124                         }
1125                         copy_begin = store.offset[i];
1126                 }
1127
1128                 /* write the pair (value == NULL means unset) */
1129                 if (value != NULL) {
1130                         if (store.state == START) {
1131                                 if (!store_write_section(fd, key))
1132                                         goto write_err_out;
1133                         }
1134                         if (!store_write_pair(fd, key, value))
1135                                 goto write_err_out;
1136                 }
1137
1138                 /* write the rest of the config */
1139                 if (copy_begin < contents_sz)
1140                         if (write_in_full(fd, contents + copy_begin,
1141                                           contents_sz - copy_begin) <
1142                             contents_sz - copy_begin)
1143                                 goto write_err_out;
1144
1145                 munmap(contents, contents_sz);
1146         }
1147
1148         if (commit_lock_file(lock) < 0) {
1149                 error("could not commit config file %s", config_filename);
1150                 ret = 4;
1151                 goto out_free;
1152         }
1153
1154         /*
1155          * lock is committed, so don't try to roll it back below.
1156          * NOTE: Since lockfile.c keeps a linked list of all created
1157          * lock_file structures, it isn't safe to free(lock).  It's
1158          * better to just leave it hanging around.
1159          */
1160         lock = NULL;
1161         ret = 0;
1162
1163 out_free:
1164         if (lock)
1165                 rollback_lock_file(lock);
1166         free(config_filename);
1167         return ret;
1168
1169 write_err_out:
1170         ret = write_error(lock->filename);
1171         goto out_free;
1172
1173 }
1174
1175 static int section_name_match (const char *buf, const char *name)
1176 {
1177         int i = 0, j = 0, dot = 0;
1178         if (buf[i] != '[')
1179                 return 0;
1180         for (i = 1; buf[i] && buf[i] != ']'; i++) {
1181                 if (!dot && isspace(buf[i])) {
1182                         dot = 1;
1183                         if (name[j++] != '.')
1184                                 break;
1185                         for (i++; isspace(buf[i]); i++)
1186                                 ; /* do nothing */
1187                         if (buf[i] != '"')
1188                                 break;
1189                         continue;
1190                 }
1191                 if (buf[i] == '\\' && dot)
1192                         i++;
1193                 else if (buf[i] == '"' && dot) {
1194                         for (i++; isspace(buf[i]); i++)
1195                                 ; /* do_nothing */
1196                         break;
1197                 }
1198                 if (buf[i] != name[j++])
1199                         break;
1200         }
1201         if (buf[i] == ']' && name[j] == 0) {
1202                 /*
1203                  * We match, now just find the right length offset by
1204                  * gobbling up any whitespace after it, as well
1205                  */
1206                 i++;
1207                 for (; buf[i] && isspace(buf[i]); i++)
1208                         ; /* do nothing */
1209                 return i;
1210         }
1211         return 0;
1212 }
1213
1214 /* if new_name == NULL, the section is removed instead */
1215 int git_config_rename_section(const char *old_name, const char *new_name)
1216 {
1217         int ret = 0, remove = 0;
1218         char *config_filename;
1219         struct lock_file *lock = xcalloc(sizeof(struct lock_file), 1);
1220         int out_fd;
1221         char buf[1024];
1222
1223         if (config_exclusive_filename)
1224                 config_filename = xstrdup(config_exclusive_filename);
1225         else
1226                 config_filename = git_pathdup("config");
1227         out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1228         if (out_fd < 0) {
1229                 ret = error("could not lock config file %s", config_filename);
1230                 goto out;
1231         }
1232
1233         if (!(config_file = fopen(config_filename, "rb"))) {
1234                 /* no config file means nothing to rename, no error */
1235                 goto unlock_and_out;
1236         }
1237
1238         while (fgets(buf, sizeof(buf), config_file)) {
1239                 int i;
1240                 int length;
1241                 char *output = buf;
1242                 for (i = 0; buf[i] && isspace(buf[i]); i++)
1243                         ; /* do nothing */
1244                 if (buf[i] == '[') {
1245                         /* it's a section */
1246                         int offset = section_name_match(&buf[i], old_name);
1247                         if (offset > 0) {
1248                                 ret++;
1249                                 if (new_name == NULL) {
1250                                         remove = 1;
1251                                         continue;
1252                                 }
1253                                 store.baselen = strlen(new_name);
1254                                 if (!store_write_section(out_fd, new_name)) {
1255                                         ret = write_error(lock->filename);
1256                                         goto out;
1257                                 }
1258                                 /*
1259                                  * We wrote out the new section, with
1260                                  * a newline, now skip the old
1261                                  * section's length
1262                                  */
1263                                 output += offset + i;
1264                                 if (strlen(output) > 0) {
1265                                         /*
1266                                          * More content means there's
1267                                          * a declaration to put on the
1268                                          * next line; indent with a
1269                                          * tab
1270                                          */
1271                                         output -= 1;
1272                                         output[0] = '\t';
1273                                 }
1274                         }
1275                         remove = 0;
1276                 }
1277                 if (remove)
1278                         continue;
1279                 length = strlen(output);
1280                 if (write_in_full(out_fd, output, length) != length) {
1281                         ret = write_error(lock->filename);
1282                         goto out;
1283                 }
1284         }
1285         fclose(config_file);
1286  unlock_and_out:
1287         if (commit_lock_file(lock) < 0)
1288                 ret = error("could not commit config file %s", config_filename);
1289  out:
1290         free(config_filename);
1291         return ret;
1292 }
1293
1294 /*
1295  * Call this to report error for your variable that should not
1296  * get a boolean value (i.e. "[my] var" means "true").
1297  */
1298 int config_error_nonbool(const char *var)
1299 {
1300         return error("Missing value for '%s'", var);
1301 }