Sanity-check config variable names
[git] / builtin / config.c
1 #include "builtin.h"
2 #include "cache.h"
3 #include "color.h"
4 #include "parse-options.h"
5
6 static const char *const builtin_config_usage[] = {
7         "git config [options]",
8         NULL
9 };
10
11 static char *key;
12 static regex_t *key_regexp;
13 static regex_t *regexp;
14 static int show_keys;
15 static int use_key_regexp;
16 static int do_all;
17 static int do_not_match;
18 static int seen;
19 static char delim = '=';
20 static char key_delim = ' ';
21 static char term = '\n';
22
23 static int use_global_config, use_system_config, use_local_config;
24 static const char *given_config_file;
25 static int actions, types;
26 static const char *get_color_slot, *get_colorbool_slot;
27 static int end_null;
28
29 #define ACTION_GET (1<<0)
30 #define ACTION_GET_ALL (1<<1)
31 #define ACTION_GET_REGEXP (1<<2)
32 #define ACTION_REPLACE_ALL (1<<3)
33 #define ACTION_ADD (1<<4)
34 #define ACTION_UNSET (1<<5)
35 #define ACTION_UNSET_ALL (1<<6)
36 #define ACTION_RENAME_SECTION (1<<7)
37 #define ACTION_REMOVE_SECTION (1<<8)
38 #define ACTION_LIST (1<<9)
39 #define ACTION_EDIT (1<<10)
40 #define ACTION_SET (1<<11)
41 #define ACTION_SET_ALL (1<<12)
42 #define ACTION_GET_COLOR (1<<13)
43 #define ACTION_GET_COLORBOOL (1<<14)
44
45 #define TYPE_BOOL (1<<0)
46 #define TYPE_INT (1<<1)
47 #define TYPE_BOOL_OR_INT (1<<2)
48 #define TYPE_PATH (1<<3)
49
50 static struct option builtin_config_options[] = {
51         OPT_GROUP("Config file location"),
52         OPT_BOOLEAN(0, "global", &use_global_config, "use global config file"),
53         OPT_BOOLEAN(0, "system", &use_system_config, "use system config file"),
54         OPT_BOOLEAN(0, "local", &use_local_config, "use repository config file"),
55         OPT_STRING('f', "file", &given_config_file, "FILE", "use given config file"),
56         OPT_GROUP("Action"),
57         OPT_BIT(0, "get", &actions, "get value: name [value-regex]", ACTION_GET),
58         OPT_BIT(0, "get-all", &actions, "get all values: key [value-regex]", ACTION_GET_ALL),
59         OPT_BIT(0, "get-regexp", &actions, "get values for regexp: name-regex [value-regex]", ACTION_GET_REGEXP),
60         OPT_BIT(0, "replace-all", &actions, "replace all matching variables: name value [value_regex]", ACTION_REPLACE_ALL),
61         OPT_BIT(0, "add", &actions, "adds a new variable: name value", ACTION_ADD),
62         OPT_BIT(0, "unset", &actions, "removes a variable: name [value-regex]", ACTION_UNSET),
63         OPT_BIT(0, "unset-all", &actions, "removes all matches: name [value-regex]", ACTION_UNSET_ALL),
64         OPT_BIT(0, "rename-section", &actions, "rename section: old-name new-name", ACTION_RENAME_SECTION),
65         OPT_BIT(0, "remove-section", &actions, "remove a section: name", ACTION_REMOVE_SECTION),
66         OPT_BIT('l', "list", &actions, "list all", ACTION_LIST),
67         OPT_BIT('e', "edit", &actions, "opens an editor", ACTION_EDIT),
68         OPT_STRING(0, "get-color", &get_color_slot, "slot", "find the color configured: [default]"),
69         OPT_STRING(0, "get-colorbool", &get_colorbool_slot, "slot", "find the color setting: [stdout-is-tty]"),
70         OPT_GROUP("Type"),
71         OPT_BIT(0, "bool", &types, "value is \"true\" or \"false\"", TYPE_BOOL),
72         OPT_BIT(0, "int", &types, "value is decimal number", TYPE_INT),
73         OPT_BIT(0, "bool-or-int", &types, "value is --bool or --int", TYPE_BOOL_OR_INT),
74         OPT_BIT(0, "path", &types, "value is a path (file or directory name)", TYPE_PATH),
75         OPT_GROUP("Other"),
76         OPT_BOOLEAN('z', "null", &end_null, "terminate values with NUL byte"),
77         OPT_END(),
78 };
79
80 static void check_argc(int argc, int min, int max) {
81         if (argc >= min && argc <= max)
82                 return;
83         error("wrong number of arguments");
84         usage_with_options(builtin_config_usage, builtin_config_options);
85 }
86
87 static int show_all_config(const char *key_, const char *value_, void *cb)
88 {
89         if (value_)
90                 printf("%s%c%s%c", key_, delim, value_, term);
91         else
92                 printf("%s%c", key_, term);
93         return 0;
94 }
95
96 static int show_config(const char *key_, const char *value_, void *cb)
97 {
98         char value[256];
99         const char *vptr = value;
100         int must_free_vptr = 0;
101         int dup_error = 0;
102
103         if (!use_key_regexp && strcmp(key_, key))
104                 return 0;
105         if (use_key_regexp && regexec(key_regexp, key_, 0, NULL, 0))
106                 return 0;
107         if (regexp != NULL &&
108             (do_not_match ^ !!regexec(regexp, (value_?value_:""), 0, NULL, 0)))
109                 return 0;
110
111         if (show_keys) {
112                 if (value_)
113                         printf("%s%c", key_, key_delim);
114                 else
115                         printf("%s", key_);
116         }
117         if (seen && !do_all)
118                 dup_error = 1;
119         if (types == TYPE_INT)
120                 sprintf(value, "%d", git_config_int(key_, value_?value_:""));
121         else if (types == TYPE_BOOL)
122                 vptr = git_config_bool(key_, value_) ? "true" : "false";
123         else if (types == TYPE_BOOL_OR_INT) {
124                 int is_bool, v;
125                 v = git_config_bool_or_int(key_, value_, &is_bool);
126                 if (is_bool)
127                         vptr = v ? "true" : "false";
128                 else
129                         sprintf(value, "%d", v);
130         } else if (types == TYPE_PATH) {
131                 git_config_pathname(&vptr, key_, value_);
132                 must_free_vptr = 1;
133         }
134         else
135                 vptr = value_?value_:"";
136         seen++;
137         if (dup_error) {
138                 error("More than one value for the key %s: %s",
139                                 key_, vptr);
140         }
141         else
142                 printf("%s%c", vptr, term);
143         if (must_free_vptr)
144                 /* If vptr must be freed, it's a pointer to a
145                  * dynamically allocated buffer, it's safe to cast to
146                  * const.
147                 */
148                 free((char *)vptr);
149
150         return 0;
151 }
152
153 static int get_value(const char *key_, const char *regex_)
154 {
155         int ret = -1;
156         char *global = NULL, *repo_config = NULL;
157         const char *system_wide = NULL, *local;
158
159         local = config_exclusive_filename;
160         if (!local) {
161                 const char *home = getenv("HOME");
162                 local = repo_config = git_pathdup("config");
163                 if (git_config_global() && home)
164                         global = xstrdup(mkpath("%s/.gitconfig", home));
165                 if (git_config_system())
166                         system_wide = git_etc_gitconfig();
167         }
168
169         if (use_key_regexp) {
170                 char *tl;
171
172                 /*
173                  * NEEDSWORK: this naive pattern lowercasing obviously does not
174                  * work for more complex patterns like "^[^.]*Foo.*bar".
175                  * Perhaps we should deprecate this altogether someday.
176                  */
177
178                 key = xstrdup(key_);
179                 for (tl = key + strlen(key) - 1;
180                      tl >= key && *tl != '.';
181                      tl--)
182                         *tl = tolower(*tl);
183                 for (tl = key; *tl && *tl != '.'; tl++)
184                         *tl = tolower(*tl);
185
186                 key_regexp = (regex_t*)xmalloc(sizeof(regex_t));
187                 if (regcomp(key_regexp, key, REG_EXTENDED)) {
188                         fprintf(stderr, "Invalid key pattern: %s\n", key_);
189                         free(key);
190                         goto free_strings;
191                 }
192         } else {
193                 if (git_config_parse_key(key_, &key, NULL))
194                         goto free_strings;
195         }
196
197         if (regex_) {
198                 if (regex_[0] == '!') {
199                         do_not_match = 1;
200                         regex_++;
201                 }
202
203                 regexp = (regex_t*)xmalloc(sizeof(regex_t));
204                 if (regcomp(regexp, regex_, REG_EXTENDED)) {
205                         fprintf(stderr, "Invalid pattern: %s\n", regex_);
206                         goto free_strings;
207                 }
208         }
209
210         if (do_all && system_wide)
211                 git_config_from_file(show_config, system_wide, NULL);
212         if (do_all && global)
213                 git_config_from_file(show_config, global, NULL);
214         if (do_all)
215                 git_config_from_file(show_config, local, NULL);
216         git_config_from_parameters(show_config, NULL);
217         if (!do_all && !seen)
218                 git_config_from_file(show_config, local, NULL);
219         if (!do_all && !seen && global)
220                 git_config_from_file(show_config, global, NULL);
221         if (!do_all && !seen && system_wide)
222                 git_config_from_file(show_config, system_wide, NULL);
223
224         free(key);
225         if (regexp) {
226                 regfree(regexp);
227                 free(regexp);
228         }
229
230         if (do_all)
231                 ret = !seen;
232         else
233                 ret = (seen == 1) ? 0 : seen > 1 ? 2 : 1;
234
235 free_strings:
236         free(repo_config);
237         free(global);
238         return ret;
239 }
240
241 static char *normalize_value(const char *key, const char *value)
242 {
243         char *normalized;
244
245         if (!value)
246                 return NULL;
247
248         if (types == 0 || types == TYPE_PATH)
249                 /*
250                  * We don't do normalization for TYPE_PATH here: If
251                  * the path is like ~/foobar/, we prefer to store
252                  * "~/foobar/" in the config file, and to expand the ~
253                  * when retrieving the value.
254                  */
255                 normalized = xstrdup(value);
256         else {
257                 normalized = xmalloc(64);
258                 if (types == TYPE_INT) {
259                         int v = git_config_int(key, value);
260                         sprintf(normalized, "%d", v);
261                 }
262                 else if (types == TYPE_BOOL)
263                         sprintf(normalized, "%s",
264                                 git_config_bool(key, value) ? "true" : "false");
265                 else if (types == TYPE_BOOL_OR_INT) {
266                         int is_bool, v;
267                         v = git_config_bool_or_int(key, value, &is_bool);
268                         if (!is_bool)
269                                 sprintf(normalized, "%d", v);
270                         else
271                                 sprintf(normalized, "%s", v ? "true" : "false");
272                 }
273         }
274
275         return normalized;
276 }
277
278 static int get_color_found;
279 static const char *get_color_slot;
280 static const char *get_colorbool_slot;
281 static char parsed_color[COLOR_MAXLEN];
282
283 static int git_get_color_config(const char *var, const char *value, void *cb)
284 {
285         if (!strcmp(var, get_color_slot)) {
286                 if (!value)
287                         config_error_nonbool(var);
288                 color_parse(value, var, parsed_color);
289                 get_color_found = 1;
290         }
291         return 0;
292 }
293
294 static void get_color(const char *def_color)
295 {
296         get_color_found = 0;
297         parsed_color[0] = '\0';
298         git_config(git_get_color_config, NULL);
299
300         if (!get_color_found && def_color)
301                 color_parse(def_color, "command line", parsed_color);
302
303         fputs(parsed_color, stdout);
304 }
305
306 static int stdout_is_tty;
307 static int get_colorbool_found;
308 static int get_diff_color_found;
309 static int git_get_colorbool_config(const char *var, const char *value,
310                 void *cb)
311 {
312         if (!strcmp(var, get_colorbool_slot)) {
313                 get_colorbool_found =
314                         git_config_colorbool(var, value, stdout_is_tty);
315         }
316         if (!strcmp(var, "diff.color")) {
317                 get_diff_color_found =
318                         git_config_colorbool(var, value, stdout_is_tty);
319         }
320         if (!strcmp(var, "color.ui")) {
321                 git_use_color_default = git_config_colorbool(var, value, stdout_is_tty);
322                 return 0;
323         }
324         return 0;
325 }
326
327 static int get_colorbool(int print)
328 {
329         get_colorbool_found = -1;
330         get_diff_color_found = -1;
331         git_config(git_get_colorbool_config, NULL);
332
333         if (get_colorbool_found < 0) {
334                 if (!strcmp(get_colorbool_slot, "color.diff"))
335                         get_colorbool_found = get_diff_color_found;
336                 if (get_colorbool_found < 0)
337                         get_colorbool_found = git_use_color_default;
338         }
339
340         if (print) {
341                 printf("%s\n", get_colorbool_found ? "true" : "false");
342                 return 0;
343         } else
344                 return get_colorbool_found ? 0 : 1;
345 }
346
347 int cmd_config(int argc, const char **argv, const char *prefix)
348 {
349         int nongit = !startup_info->have_repository;
350         char *value;
351
352         config_exclusive_filename = getenv(CONFIG_ENVIRONMENT);
353
354         argc = parse_options(argc, argv, prefix, builtin_config_options,
355                              builtin_config_usage,
356                              PARSE_OPT_STOP_AT_NON_OPTION);
357
358         if (use_global_config + use_system_config + use_local_config + !!given_config_file > 1) {
359                 error("only one config file at a time.");
360                 usage_with_options(builtin_config_usage, builtin_config_options);
361         }
362
363         if (use_global_config) {
364                 char *home = getenv("HOME");
365                 if (home) {
366                         char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
367                         config_exclusive_filename = user_config;
368                 } else {
369                         die("$HOME not set");
370                 }
371         }
372         else if (use_system_config)
373                 config_exclusive_filename = git_etc_gitconfig();
374         else if (use_local_config)
375                 config_exclusive_filename = git_pathdup("config");
376         else if (given_config_file) {
377                 if (!is_absolute_path(given_config_file) && prefix)
378                         config_exclusive_filename = prefix_filename(prefix,
379                                                                     strlen(prefix),
380                                                                     given_config_file);
381                 else
382                         config_exclusive_filename = given_config_file;
383         }
384
385         if (end_null) {
386                 term = '\0';
387                 delim = '\n';
388                 key_delim = '\n';
389         }
390
391         if (HAS_MULTI_BITS(types)) {
392                 error("only one type at a time.");
393                 usage_with_options(builtin_config_usage, builtin_config_options);
394         }
395
396         if (get_color_slot)
397             actions |= ACTION_GET_COLOR;
398         if (get_colorbool_slot)
399             actions |= ACTION_GET_COLORBOOL;
400
401         if ((get_color_slot || get_colorbool_slot) && types) {
402                 error("--get-color and variable type are incoherent");
403                 usage_with_options(builtin_config_usage, builtin_config_options);
404         }
405
406         if (HAS_MULTI_BITS(actions)) {
407                 error("only one action at a time.");
408                 usage_with_options(builtin_config_usage, builtin_config_options);
409         }
410         if (actions == 0)
411                 switch (argc) {
412                 case 1: actions = ACTION_GET; break;
413                 case 2: actions = ACTION_SET; break;
414                 case 3: actions = ACTION_SET_ALL; break;
415                 default:
416                         usage_with_options(builtin_config_usage, builtin_config_options);
417                 }
418
419         if (actions == ACTION_LIST) {
420                 check_argc(argc, 0, 0);
421                 if (git_config(show_all_config, NULL) < 0) {
422                         if (config_exclusive_filename)
423                                 die_errno("unable to read config file '%s'",
424                                           config_exclusive_filename);
425                         else
426                                 die("error processing config file(s)");
427                 }
428         }
429         else if (actions == ACTION_EDIT) {
430                 check_argc(argc, 0, 0);
431                 if (!config_exclusive_filename && nongit)
432                         die("not in a git directory");
433                 git_config(git_default_config, NULL);
434                 launch_editor(config_exclusive_filename ?
435                               config_exclusive_filename : git_path("config"),
436                               NULL, NULL);
437         }
438         else if (actions == ACTION_SET) {
439                 check_argc(argc, 2, 2);
440                 value = normalize_value(argv[0], argv[1]);
441                 return git_config_set(argv[0], value);
442         }
443         else if (actions == ACTION_SET_ALL) {
444                 check_argc(argc, 2, 3);
445                 value = normalize_value(argv[0], argv[1]);
446                 return git_config_set_multivar(argv[0], value, argv[2], 0);
447         }
448         else if (actions == ACTION_ADD) {
449                 check_argc(argc, 2, 2);
450                 value = normalize_value(argv[0], argv[1]);
451                 return git_config_set_multivar(argv[0], value, "^$", 0);
452         }
453         else if (actions == ACTION_REPLACE_ALL) {
454                 check_argc(argc, 2, 3);
455                 value = normalize_value(argv[0], argv[1]);
456                 return git_config_set_multivar(argv[0], value, argv[2], 1);
457         }
458         else if (actions == ACTION_GET) {
459                 check_argc(argc, 1, 2);
460                 return get_value(argv[0], argv[1]);
461         }
462         else if (actions == ACTION_GET_ALL) {
463                 do_all = 1;
464                 check_argc(argc, 1, 2);
465                 return get_value(argv[0], argv[1]);
466         }
467         else if (actions == ACTION_GET_REGEXP) {
468                 show_keys = 1;
469                 use_key_regexp = 1;
470                 do_all = 1;
471                 check_argc(argc, 1, 2);
472                 return get_value(argv[0], argv[1]);
473         }
474         else if (actions == ACTION_UNSET) {
475                 check_argc(argc, 1, 2);
476                 if (argc == 2)
477                         return git_config_set_multivar(argv[0], NULL, argv[1], 0);
478                 else
479                         return git_config_set(argv[0], NULL);
480         }
481         else if (actions == ACTION_UNSET_ALL) {
482                 check_argc(argc, 1, 2);
483                 return git_config_set_multivar(argv[0], NULL, argv[1], 1);
484         }
485         else if (actions == ACTION_RENAME_SECTION) {
486                 int ret;
487                 check_argc(argc, 2, 2);
488                 ret = git_config_rename_section(argv[0], argv[1]);
489                 if (ret < 0)
490                         return ret;
491                 if (ret == 0)
492                         die("No such section!");
493         }
494         else if (actions == ACTION_REMOVE_SECTION) {
495                 int ret;
496                 check_argc(argc, 1, 1);
497                 ret = git_config_rename_section(argv[0], NULL);
498                 if (ret < 0)
499                         return ret;
500                 if (ret == 0)
501                         die("No such section!");
502         }
503         else if (actions == ACTION_GET_COLOR) {
504                 get_color(argv[0]);
505         }
506         else if (actions == ACTION_GET_COLORBOOL) {
507                 if (argc == 1)
508                         stdout_is_tty = git_config_bool("command line", argv[0]);
509                 else if (argc == 0)
510                         stdout_is_tty = isatty(1);
511                 return get_colorbool(argc != 0);
512         }
513
514         return 0;
515 }