blob: 13cf9eeb163c2663db8cea149fc4285740fe434b [file] [log] [blame]
Johannes Schindelin10bea152005-11-17 22:32:36 +01001/*
2 * GIT - The information manager from hell
3 *
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
6 *
7 */
Elijah Newren5e3f94d2023-04-22 20:17:23 +00008#include "git-compat-util.h"
Elijah Newren0b027f62023-03-21 06:25:58 +00009#include "abspath.h"
Elijah Newren6c6ddf92023-04-11 03:00:39 +000010#include "advice.h"
Ævar Arnfjörð Bjarmason88c7b4c2022-02-16 09:14:02 +010011#include "date.h"
Elijah Newrene730b812018-08-15 10:54:07 -070012#include "branch.h"
Brandon Williamsb2141fc2017-06-14 11:07:36 -070013#include "config.h"
Calvin Wanb1bda752023-09-29 14:20:51 -070014#include "parse.h"
Elijah Newren73359a92023-04-11 03:00:40 +000015#include "convert.h"
Patrick Steinhardtd8d77152021-01-12 13:27:14 +010016#include "environment.h"
Elijah Newrenf394e092023-03-21 06:25:54 +000017#include "gettext.h"
Elijah Newrenb5fa6082023-02-24 00:09:29 +000018#include "ident.h"
Brandon Williams3b256222017-06-22 11:43:42 -070019#include "repository.h"
Michael Haggerty697cc8e2014-10-01 12:28:42 +020020#include "lockfile.h"
Elijah Newren47115562023-04-11 00:42:04 -070021#include "mailmap.h"
John Cai9f9c40c2023-10-13 17:39:30 +000022#include "attr.h"
Stefan Bellerd807c4a2018-04-10 14:26:18 -070023#include "exec-cmd.h"
Alex Riesen572e4f62010-03-26 23:56:01 +010024#include "strbuf.h"
Jeff King2b64fc82010-08-23 15:16:00 -040025#include "quote.h"
Tanay Abhra3c8687a2014-07-28 03:10:38 -070026#include "hashmap.h"
27#include "string-list.h"
Elijah Newrendabab1d2023-04-11 00:41:49 -070028#include "object-name.h"
Elijah Newrena034e912023-05-16 06:34:06 +000029#include "object-store-ll.h"
Elijah Newrenca4eed72023-04-11 00:41:59 -070030#include "pager.h"
Elijah Newrenc3399322023-05-16 06:33:59 +000031#include "path.h"
Junio C Hamano599446d2015-04-16 10:47:45 -070032#include "utf8.h"
Taylor Blau6d2f9ac2018-04-09 17:18:28 -070033#include "color.h"
Denton Liu07b2c0e2019-06-05 17:21:59 -040034#include "refs.h"
Elijah Newrene38da482023-03-21 06:26:05 +000035#include "setup.h"
Elijah Newren08c46a42023-05-16 06:33:56 +000036#include "strvec.h"
Elijah Newren74ea5c92023-04-11 03:00:38 +000037#include "trace2.h"
Elijah Newrendd77d582023-05-16 06:34:03 +000038#include "wildmatch.h"
Elijah Newren64122312023-04-22 20:17:16 +000039#include "ws.h"
Elijah Newrend48be352023-03-21 06:26:07 +000040#include "write-or-die.h"
Linus Torvalds17712992005-10-10 16:31:08 -070041
Heiko Voigt4d8dd142013-07-12 00:44:39 +020042struct config_source {
43 struct config_source *prev;
44 union {
45 FILE *file;
Heiko Voigt1bc88812013-07-12 00:46:47 +020046 struct config_buf {
47 const char *buf;
48 size_t len;
49 size_t pos;
50 } buf;
Heiko Voigt4d8dd142013-07-12 00:44:39 +020051 } u;
Vasco Almeida1b8132d2016-07-28 13:14:03 +000052 enum config_origin_type origin_type;
Ramsay Jones924aaf32011-06-16 21:24:51 +010053 const char *name;
Jeff Kingd14d4242014-02-19 00:58:52 +020054 const char *path;
Jeff King66f97222018-06-28 18:05:00 -040055 enum config_error_action default_error_action;
Ramsay Jones924aaf32011-06-16 21:24:51 +010056 int linenr;
57 int eof;
Jeff King348482d2020-04-10 15:50:07 -040058 size_t total_len;
Ramsay Jones924aaf32011-06-16 21:24:51 +010059 struct strbuf value;
Ben Walton0971e992012-09-30 20:44:36 +010060 struct strbuf var;
Stefan Beller2d84f132018-08-08 12:50:19 -070061 unsigned subsection_case_sensitive : 1;
Ramsay Jones924aaf32011-06-16 21:24:51 +010062
Jeff King49d6cfa2013-08-26 17:57:18 -040063 int (*do_fgetc)(struct config_source *c);
64 int (*do_ungetc)(int c, struct config_source *conf);
65 long (*do_ftell)(struct config_source *c);
Heiko Voigt4d8dd142013-07-12 00:44:39 +020066};
Glen Chooc009bc82023-03-28 17:51:48 +000067#define CONFIG_SOURCE_INIT { 0 }
Heiko Voigt4d8dd142013-07-12 00:44:39 +020068
Junio C Hamano8de7eeb2016-11-15 17:42:40 -080069static int pack_compression_seen;
Dana How960ccca2007-05-09 13:56:50 -070070static int zlib_compression_seen;
71
Glen Choo5b3c6502022-07-14 21:27:59 +000072/*
73 * Config that comes from trusted scopes, namely:
74 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
75 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
76 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
77 *
78 * This is declared here for code cleanliness, but unlike the other
79 * static variables, this does not hold config parser state.
80 */
81static struct config_set protected_config;
82
Heiko Voigt4d8dd142013-07-12 00:44:39 +020083static int config_file_fgetc(struct config_source *conf)
84{
Jeff King260d4082015-04-16 04:51:18 -040085 return getc_unlocked(conf->u.file);
Heiko Voigt4d8dd142013-07-12 00:44:39 +020086}
87
88static int config_file_ungetc(int c, struct config_source *conf)
89{
90 return ungetc(c, conf->u.file);
91}
92
93static long config_file_ftell(struct config_source *conf)
94{
95 return ftell(conf->u.file);
96}
97
Heiko Voigt1bc88812013-07-12 00:46:47 +020098static int config_buf_fgetc(struct config_source *conf)
99{
100 if (conf->u.buf.pos < conf->u.buf.len)
101 return conf->u.buf.buf[conf->u.buf.pos++];
102
103 return EOF;
104}
105
106static int config_buf_ungetc(int c, struct config_source *conf)
107{
Jeff King1d0655c2015-02-05 16:00:24 -0500108 if (conf->u.buf.pos > 0) {
109 conf->u.buf.pos--;
110 if (conf->u.buf.buf[conf->u.buf.pos] != c)
Johannes Schindelin033abf92018-05-02 11:38:39 +0200111 BUG("config_buf can only ungetc the same character");
Jeff King1d0655c2015-02-05 16:00:24 -0500112 return c;
113 }
Heiko Voigt1bc88812013-07-12 00:46:47 +0200114
115 return EOF;
116}
117
118static long config_buf_ftell(struct config_source *conf)
119{
120 return conf->u.buf.pos;
121}
122
Jonathan Taned69e112022-01-18 09:47:39 -0800123struct config_include_data {
124 int depth;
125 config_fn_t fn;
126 void *data;
127 const struct config_options *opts;
Jonathan Tan399b1982022-01-18 09:47:40 -0800128 struct git_config_source *config_source;
Victoria Dye9b6b06c2023-05-26 01:32:59 +0000129 struct repository *repo;
Jonathan Tan399b1982022-01-18 09:47:40 -0800130
131 /*
132 * All remote URLs discovered when reading all config files.
133 */
134 struct string_list *remote_urls;
Jonathan Taned69e112022-01-18 09:47:39 -0800135};
136#define CONFIG_INCLUDE_INIT { 0 }
137
Glen Chooa4e7e312023-06-28 19:26:22 +0000138static int git_config_include(const char *var, const char *value,
139 const struct config_context *ctx, void *data);
Jonathan Taned69e112022-01-18 09:47:39 -0800140
Jeff King9b25a0b2012-02-06 04:54:04 -0500141#define MAX_INCLUDE_DEPTH 10
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +0200142static const char include_depth_advice[] = N_(
Jeff King9b25a0b2012-02-06 04:54:04 -0500143"exceeded maximum include depth (%d) while including\n"
144" %s\n"
145"from\n"
146" %s\n"
Jean-Noël Avila27c929e2018-08-23 23:00:56 +0200147"This might be due to circular includes.");
Glen Choo908857a2023-06-28 19:26:29 +0000148static int handle_path_include(const struct key_value_info *kvi,
Glen Choo26b66932023-06-28 19:26:25 +0000149 const char *path,
Glen Chooc97f3ed2023-03-28 17:51:47 +0000150 struct config_include_data *inc)
Jeff King9b25a0b2012-02-06 04:54:04 -0500151{
152 int ret = 0;
153 struct strbuf buf = STRBUF_INIT;
Jeff King67beb602014-01-27 20:37:30 -0500154 char *expanded;
Jeff King4c0a89f2012-04-25 08:00:36 -0400155
Jeff King67beb602014-01-27 20:37:30 -0500156 if (!path)
157 return config_error_nonbool("include.path");
158
Johannes Schindelina03b0972021-07-24 22:06:52 +0000159 expanded = interpolate_path(path, 0);
Jeff King4c0a89f2012-04-25 08:00:36 -0400160 if (!expanded)
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +0200161 return error(_("could not expand include path '%s'"), path);
Jeff King4c0a89f2012-04-25 08:00:36 -0400162 path = expanded;
Jeff King9b25a0b2012-02-06 04:54:04 -0500163
164 /*
165 * Use an absolute path as-is, but interpret relative paths
166 * based on the including config file.
167 */
168 if (!is_absolute_path(path)) {
169 char *slash;
170
Glen Choo908857a2023-06-28 19:26:29 +0000171 if (!kvi || !kvi->path) {
Ævar Arnfjörð Bjarmason25ad7222021-10-21 21:54:14 +0200172 ret = error(_("relative config includes must come from files"));
173 goto cleanup;
174 }
Jeff King9b25a0b2012-02-06 04:54:04 -0500175
Glen Choo908857a2023-06-28 19:26:29 +0000176 slash = find_last_dir_sep(kvi->path);
Jeff King9b25a0b2012-02-06 04:54:04 -0500177 if (slash)
Glen Choo908857a2023-06-28 19:26:29 +0000178 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
Jeff King9b25a0b2012-02-06 04:54:04 -0500179 strbuf_addstr(&buf, path);
180 path = buf.buf;
181 }
182
Jonathan Nieder4698c8f2013-04-12 14:03:18 -0700183 if (!access_or_die(path, R_OK, 0)) {
Jeff King9b25a0b2012-02-06 04:54:04 -0500184 if (++inc->depth > MAX_INCLUDE_DEPTH)
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +0200185 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
Glen Choo908857a2023-06-28 19:26:29 +0000186 !kvi ? "<unknown>" :
187 kvi->filename ? kvi->filename :
Jeff King32582582016-05-18 18:41:08 -0400188 "the command line");
Glen Choo809d8682023-06-28 19:26:24 +0000189 ret = git_config_from_file_with_options(git_config_include, path, inc,
Glen Choo26b66932023-06-28 19:26:25 +0000190 kvi->scope, NULL);
Jeff King9b25a0b2012-02-06 04:54:04 -0500191 inc->depth--;
192 }
Ævar Arnfjörð Bjarmason25ad7222021-10-21 21:54:14 +0200193cleanup:
Jeff King9b25a0b2012-02-06 04:54:04 -0500194 strbuf_release(&buf);
Jeff King4c0a89f2012-04-25 08:00:36 -0400195 free(expanded);
Jeff King9b25a0b2012-02-06 04:54:04 -0500196 return ret;
197}
198
Denton Liu07b2c0e2019-06-05 17:21:59 -0400199static void add_trailing_starstar_for_dir(struct strbuf *pat)
200{
201 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
202 strbuf_addstr(pat, "**");
203}
204
Glen Choo908857a2023-06-28 19:26:29 +0000205static int prepare_include_condition_pattern(const struct key_value_info *kvi,
Glen Chooc97f3ed2023-03-28 17:51:47 +0000206 struct strbuf *pat)
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700207{
208 struct strbuf path = STRBUF_INIT;
209 char *expanded;
210 int prefix = 0;
211
Johannes Schindelina03b0972021-07-24 22:06:52 +0000212 expanded = interpolate_path(pat->buf, 1);
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700213 if (expanded) {
214 strbuf_reset(pat);
215 strbuf_addstr(pat, expanded);
216 free(expanded);
217 }
218
219 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
220 const char *slash;
221
Glen Choo908857a2023-06-28 19:26:29 +0000222 if (!kvi || !kvi->path)
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700223 return error(_("relative config include "
224 "conditionals must come from files"));
225
Glen Choo908857a2023-06-28 19:26:29 +0000226 strbuf_realpath(&path, kvi->path, 1);
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700227 slash = find_last_dir_sep(path.buf);
228 if (!slash)
Johannes Schindelin033abf92018-05-02 11:38:39 +0200229 BUG("how is this possible?");
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700230 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
231 prefix = slash - path.buf + 1 /* slash */;
232 } else if (!is_absolute_path(pat->buf))
René Scharfea91cc7f2020-02-09 14:44:23 +0100233 strbuf_insertstr(pat, 0, "**/");
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700234
Denton Liu07b2c0e2019-06-05 17:21:59 -0400235 add_trailing_starstar_for_dir(pat);
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700236
237 strbuf_release(&path);
238 return prefix;
239}
240
Glen Choo908857a2023-06-28 19:26:29 +0000241static int include_by_gitdir(const struct key_value_info *kvi,
Glen Chooc97f3ed2023-03-28 17:51:47 +0000242 const struct config_options *opts,
Nguyễn Thái Ngọc Duy2185fde2017-04-17 17:10:01 +0700243 const char *cond, size_t cond_len, int icase)
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700244{
245 struct strbuf text = STRBUF_INIT;
246 struct strbuf pattern = STRBUF_INIT;
247 int ret = 0, prefix;
Nguyễn Thái Ngọc Duy2185fde2017-04-17 17:10:01 +0700248 const char *git_dir;
Ævar Arnfjörð Bjarmason0624c632017-05-16 08:28:46 +0000249 int already_tried_absolute = 0;
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700250
Nguyễn Thái Ngọc Duy2185fde2017-04-17 17:10:01 +0700251 if (opts->git_dir)
252 git_dir = opts->git_dir;
Nguyễn Thái Ngọc Duy2185fde2017-04-17 17:10:01 +0700253 else
254 goto done;
255
Junio C Hamanoc9672ba2017-04-26 15:39:05 +0900256 strbuf_realpath(&text, git_dir, 1);
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700257 strbuf_add(&pattern, cond, cond_len);
Glen Choo908857a2023-06-28 19:26:29 +0000258 prefix = prepare_include_condition_pattern(kvi, &pattern);
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700259
Ævar Arnfjörð Bjarmason0624c632017-05-16 08:28:46 +0000260again:
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700261 if (prefix < 0)
262 goto done;
263
264 if (prefix > 0) {
265 /*
266 * perform literal matching on the prefix part so that
267 * any wildcard character in it can't create side effects.
268 */
269 if (text.len < prefix)
270 goto done;
271 if (!icase && strncmp(pattern.buf, text.buf, prefix))
272 goto done;
273 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
274 goto done;
275 }
276
277 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
Nguyễn Thái Ngọc Duy19e7fda2019-03-26 16:41:01 +0700278 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700279
Ævar Arnfjörð Bjarmason0624c632017-05-16 08:28:46 +0000280 if (!ret && !already_tried_absolute) {
281 /*
282 * We've tried e.g. matching gitdir:~/work, but if
283 * ~/work is a symlink to /mnt/storage/work
284 * strbuf_realpath() will expand it, so the rule won't
285 * match. Let's match against a
286 * strbuf_add_absolute_path() version of the path,
287 * which'll do the right thing
288 */
289 strbuf_reset(&text);
290 strbuf_add_absolute_path(&text, git_dir);
291 already_tried_absolute = 1;
292 goto again;
293 }
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700294done:
295 strbuf_release(&pattern);
296 strbuf_release(&text);
297 return ret;
298}
299
Denton Liu07b2c0e2019-06-05 17:21:59 -0400300static int include_by_branch(const char *cond, size_t cond_len)
301{
302 int flags;
303 int ret;
304 struct strbuf pattern = STRBUF_INIT;
Jeff King22932d92019-08-06 08:27:58 -0400305 const char *refname = !the_repository->gitdir ?
Johannes Schindelin85fe0e82019-07-31 13:06:42 -0700306 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
Denton Liu07b2c0e2019-06-05 17:21:59 -0400307 const char *shortname;
308
309 if (!refname || !(flags & REF_ISSYMREF) ||
310 !skip_prefix(refname, "refs/heads/", &shortname))
311 return 0;
312
313 strbuf_add(&pattern, cond, cond_len);
314 add_trailing_starstar_for_dir(&pattern);
315 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
316 strbuf_release(&pattern);
317 return ret;
318}
319
Glen Chooa4e7e312023-06-28 19:26:22 +0000320static int add_remote_url(const char *var, const char *value,
321 const struct config_context *ctx UNUSED, void *data)
Jonathan Tan399b1982022-01-18 09:47:40 -0800322{
323 struct string_list *remote_urls = data;
324 const char *remote_name;
325 size_t remote_name_len;
326 const char *key;
327
328 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
329 &key) &&
330 remote_name &&
331 !strcmp(key, "url"))
332 string_list_append(remote_urls, value);
333 return 0;
334}
335
336static void populate_remote_urls(struct config_include_data *inc)
337{
338 struct config_options opts;
339
Jonathan Tan399b1982022-01-18 09:47:40 -0800340 opts = *inc->opts;
341 opts.unconditional_remote_url = 1;
342
Jonathan Tan399b1982022-01-18 09:47:40 -0800343 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
344 string_list_init_dup(inc->remote_urls);
Victoria Dye9b6b06c2023-05-26 01:32:59 +0000345 config_with_options(add_remote_url, inc->remote_urls,
346 inc->config_source, inc->repo, &opts);
Jonathan Tan399b1982022-01-18 09:47:40 -0800347}
348
Ævar Arnfjörð Bjarmason5cf88fd2022-08-25 19:09:48 +0200349static int forbid_remote_url(const char *var, const char *value UNUSED,
Glen Chooa4e7e312023-06-28 19:26:22 +0000350 const struct config_context *ctx UNUSED,
Ævar Arnfjörð Bjarmason5cf88fd2022-08-25 19:09:48 +0200351 void *data UNUSED)
Jonathan Tan399b1982022-01-18 09:47:40 -0800352{
353 const char *remote_name;
354 size_t remote_name_len;
355 const char *key;
356
357 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
358 &key) &&
359 remote_name &&
360 !strcmp(key, "url"))
361 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
362 return 0;
363}
364
365static int at_least_one_url_matches_glob(const char *glob, int glob_len,
366 struct string_list *remote_urls)
367{
368 struct strbuf pattern = STRBUF_INIT;
369 struct string_list_item *url_item;
370 int found = 0;
371
372 strbuf_add(&pattern, glob, glob_len);
373 for_each_string_list_item(url_item, remote_urls) {
374 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
375 found = 1;
376 break;
377 }
378 }
379 strbuf_release(&pattern);
380 return found;
381}
382
383static int include_by_remote_url(struct config_include_data *inc,
384 const char *cond, size_t cond_len)
385{
386 if (inc->opts->unconditional_remote_url)
387 return 1;
388 if (!inc->remote_urls)
389 populate_remote_urls(inc);
390 return at_least_one_url_matches_glob(cond, cond_len,
391 inc->remote_urls);
392}
393
Glen Choo908857a2023-06-28 19:26:29 +0000394static int include_condition_is_true(const struct key_value_info *kvi,
Glen Chooc97f3ed2023-03-28 17:51:47 +0000395 struct config_include_data *inc,
Nguyễn Thái Ngọc Duy2185fde2017-04-17 17:10:01 +0700396 const char *cond, size_t cond_len)
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700397{
Jonathan Tan399b1982022-01-18 09:47:40 -0800398 const struct config_options *opts = inc->opts;
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700399
400 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
Glen Choo908857a2023-06-28 19:26:29 +0000401 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700402 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
Glen Choo908857a2023-06-28 19:26:29 +0000403 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
Denton Liu07b2c0e2019-06-05 17:21:59 -0400404 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
405 return include_by_branch(cond, cond_len);
Jonathan Tan399b1982022-01-18 09:47:40 -0800406 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
407 &cond_len))
408 return include_by_remote_url(inc, cond, cond_len);
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700409
410 /* unknown conditionals are always false */
411 return 0;
412}
413
Glen Chooa4e7e312023-06-28 19:26:22 +0000414static int git_config_include(const char *var, const char *value,
415 const struct config_context *ctx,
416 void *data)
Jeff King9b25a0b2012-02-06 04:54:04 -0500417{
418 struct config_include_data *inc = data;
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700419 const char *cond, *key;
Jeff Kingf5914f42020-04-10 15:44:28 -0400420 size_t cond_len;
Jeff King9b25a0b2012-02-06 04:54:04 -0500421 int ret;
422
423 /*
424 * Pass along all values, including "include" directives; this makes it
425 * possible to query information on the includes themselves.
426 */
Glen Choo809d8682023-06-28 19:26:24 +0000427 ret = inc->fn(var, value, ctx, inc->data);
Jeff King9b25a0b2012-02-06 04:54:04 -0500428 if (ret < 0)
429 return ret;
430
René Scharfe37007c32014-08-30 18:07:05 +0200431 if (!strcmp(var, "include.path"))
Glen Choo908857a2023-06-28 19:26:29 +0000432 ret = handle_path_include(ctx->kvi, value, inc);
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700433
434 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
Glen Choo908857a2023-06-28 19:26:29 +0000435 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
Jonathan Tan399b1982022-01-18 09:47:40 -0800436 !strcmp(key, "path")) {
437 config_fn_t old_fn = inc->fn;
438
439 if (inc->opts->unconditional_remote_url)
440 inc->fn = forbid_remote_url;
Glen Choo908857a2023-06-28 19:26:29 +0000441 ret = handle_path_include(ctx->kvi, value, inc);
Jonathan Tan399b1982022-01-18 09:47:40 -0800442 inc->fn = old_fn;
443 }
Nguyễn Thái Ngọc Duy3efd0be2017-03-01 18:26:31 +0700444
Jeff King9b25a0b2012-02-06 04:54:04 -0500445 return ret;
446}
447
Patrick Steinhardt1ff21c02021-01-12 13:27:01 +0100448static void git_config_push_split_parameter(const char *key, const char *value)
Jeff King2b64fc82010-08-23 15:16:00 -0400449{
450 struct strbuf env = STRBUF_INIT;
451 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
Jeff Kingd1f88492016-03-22 15:50:51 -0400452 if (old && *old) {
Jeff King2b64fc82010-08-23 15:16:00 -0400453 strbuf_addstr(&env, old);
454 strbuf_addch(&env, ' ');
455 }
Patrick Steinhardt1ff21c02021-01-12 13:27:01 +0100456 sq_quote_buf(&env, key);
457 strbuf_addch(&env, '=');
458 if (value)
459 sq_quote_buf(&env, value);
Jeff King2b64fc82010-08-23 15:16:00 -0400460 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
461 strbuf_release(&env);
462}
463
Patrick Steinhardt1ff21c02021-01-12 13:27:01 +0100464void git_config_push_parameter(const char *text)
465{
466 const char *value;
467
468 /*
469 * When we see:
470 *
471 * section.subsection=with=equals.key=value
472 *
473 * we cannot tell if it means:
474 *
475 * [section "subsection=with=equals"]
476 * key = value
477 *
478 * or:
479 *
480 * [section]
481 * subsection = with=equals.key=value
482 *
483 * We parse left-to-right for the first "=", meaning we'll prefer to
484 * keep the value intact over the subsection. This is historical, but
485 * also sensible since values are more likely to contain odd or
486 * untrusted input than a section name.
487 *
488 * A missing equals is explicitly allowed (as a bool-only entry).
489 */
490 value = strchr(text, '=');
491 if (value) {
492 char *key = xmemdupz(text, value - text);
493 git_config_push_split_parameter(key, value + 1);
494 free(key);
495 } else {
496 git_config_push_split_parameter(text, NULL);
497 }
498}
499
Patrick Steinhardtce81b1d2021-01-12 13:26:45 +0100500void git_config_push_env(const char *spec)
501{
Patrick Steinhardt1ff21c02021-01-12 13:27:01 +0100502 char *key;
Patrick Steinhardtce81b1d2021-01-12 13:26:45 +0100503 const char *env_name;
504 const char *env_value;
505
506 env_name = strrchr(spec, '=');
507 if (!env_name)
508 die(_("invalid config format: %s"), spec);
Patrick Steinhardt1ff21c02021-01-12 13:27:01 +0100509 key = xmemdupz(spec, env_name - spec);
Patrick Steinhardtce81b1d2021-01-12 13:26:45 +0100510 env_name++;
511 if (!*env_name)
512 die(_("missing environment variable name for configuration '%.*s'"),
513 (int)(env_name - spec - 1), spec);
514
515 env_value = getenv(env_name);
516 if (!env_value)
517 die(_("missing environment variable '%s' for configuration '%.*s'"),
518 env_name, (int)(env_name - spec - 1), spec);
519
Patrick Steinhardt1ff21c02021-01-12 13:27:01 +0100520 git_config_push_split_parameter(key, env_value);
521 free(key);
Patrick Steinhardtce81b1d2021-01-12 13:26:45 +0100522}
523
Junio C Hamanoee98df32017-02-23 14:44:07 -0800524static inline int iskeychar(int c)
525{
526 return isalnum(c) || c == '-';
527}
528
529/*
530 * Auxiliary function to sanity-check and split the key into the section
531 * identifier and variable name.
532 *
533 * Returns 0 on success, -1 when there is an invalid character in the key and
534 * -2 if there is no section name in the key.
535 *
536 * store_key - pointer to char* which will hold a copy of the key with
537 * lowercase section and variable name
Jeff Kingf011a962020-04-10 15:46:07 -0400538 * baselen - pointer to size_t which will hold the length of the
Junio C Hamanoee98df32017-02-23 14:44:07 -0800539 * section + subsection part, can be NULL
540 */
Ævar Arnfjörð Bjarmason73c5f672021-09-28 14:56:03 +0200541int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
Junio C Hamanoee98df32017-02-23 14:44:07 -0800542{
Jeff Kingf011a962020-04-10 15:46:07 -0400543 size_t i, baselen;
544 int dot;
Junio C Hamanoee98df32017-02-23 14:44:07 -0800545 const char *last_dot = strrchr(key, '.');
546
547 /*
548 * Since "key" actually contains the section name and the real
549 * key name separated by a dot, we have to know where the dot is.
550 */
551
552 if (last_dot == NULL || last_dot == key) {
Ævar Arnfjörð Bjarmason73c5f672021-09-28 14:56:03 +0200553 error(_("key does not contain a section: %s"), key);
Junio C Hamanoee98df32017-02-23 14:44:07 -0800554 return -CONFIG_NO_SECTION_OR_NAME;
555 }
556
557 if (!last_dot[1]) {
Ævar Arnfjörð Bjarmason73c5f672021-09-28 14:56:03 +0200558 error(_("key does not contain variable name: %s"), key);
Junio C Hamanoee98df32017-02-23 14:44:07 -0800559 return -CONFIG_NO_SECTION_OR_NAME;
560 }
561
562 baselen = last_dot - key;
563 if (baselen_)
564 *baselen_ = baselen;
565
566 /*
567 * Validate the key and while at it, lower case it for matching.
568 */
Ævar Arnfjörð Bjarmason73c5f672021-09-28 14:56:03 +0200569 *store_key = xmallocz(strlen(key));
Junio C Hamanoee98df32017-02-23 14:44:07 -0800570
571 dot = 0;
572 for (i = 0; key[i]; i++) {
573 unsigned char c = key[i];
574 if (c == '.')
575 dot = 1;
576 /* Leave the extended basename untouched.. */
577 if (!dot || i > baselen) {
578 if (!iskeychar(c) ||
579 (i == baselen + 1 && !isalpha(c))) {
Ævar Arnfjörð Bjarmason73c5f672021-09-28 14:56:03 +0200580 error(_("invalid key: %s"), key);
Junio C Hamanoee98df32017-02-23 14:44:07 -0800581 goto out_free_ret_1;
582 }
583 c = tolower(c);
584 } else if (c == '\n') {
Ævar Arnfjörð Bjarmason73c5f672021-09-28 14:56:03 +0200585 error(_("invalid key (newline): %s"), key);
Junio C Hamanoee98df32017-02-23 14:44:07 -0800586 goto out_free_ret_1;
587 }
Ævar Arnfjörð Bjarmason73c5f672021-09-28 14:56:03 +0200588 (*store_key)[i] = c;
Junio C Hamanoee98df32017-02-23 14:44:07 -0800589 }
590
591 return 0;
592
593out_free_ret_1:
Ævar Arnfjörð Bjarmason73c5f672021-09-28 14:56:03 +0200594 FREE_AND_NULL(*store_key);
Junio C Hamanoee98df32017-02-23 14:44:07 -0800595 return -CONFIG_INVALID_KEY;
596}
597
Patrick Steinhardtb342ae62021-01-12 13:26:54 +0100598static int config_parse_pair(const char *key, const char *value,
Glen Choo26b66932023-06-28 19:26:25 +0000599 struct key_value_info *kvi,
600 config_fn_t fn, void *data)
Patrick Steinhardtb342ae62021-01-12 13:26:54 +0100601{
602 char *canonical_name;
603 int ret;
Glen Choo26b66932023-06-28 19:26:25 +0000604 struct config_context ctx = {
605 .kvi = kvi,
606 };
Patrick Steinhardtb342ae62021-01-12 13:26:54 +0100607
608 if (!strlen(key))
609 return error(_("empty config key"));
610 if (git_config_parse_key(key, &canonical_name, NULL))
611 return -1;
612
Glen Choo26b66932023-06-28 19:26:25 +0000613 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
Patrick Steinhardtb342ae62021-01-12 13:26:54 +0100614 free(canonical_name);
615 return ret;
616}
617
Glen Choo26b66932023-06-28 19:26:25 +0000618
619/* for values read from `git_config_from_parameters()` */
620void kvi_from_param(struct key_value_info *out)
621{
622 out->filename = NULL;
623 out->linenr = -1;
624 out->origin_type = CONFIG_ORIGIN_CMDLINE;
625 out->scope = CONFIG_SCOPE_COMMAND;
Glen Choo908857a2023-06-28 19:26:29 +0000626 out->path = NULL;
Glen Choo26b66932023-06-28 19:26:25 +0000627}
628
Jeff King24968442011-06-09 11:56:42 -0400629int git_config_parse_parameter(const char *text,
630 config_fn_t fn, void *data)
Alex Riesen8b1fa772010-03-26 23:53:57 +0100631{
Junio C Hamanoa789ca72014-08-04 15:40:19 -0700632 const char *value;
Alex Riesen572e4f62010-03-26 23:56:01 +0100633 struct strbuf **pair;
Junio C Hamano1274a152017-02-23 15:04:40 -0800634 int ret;
Glen Choo26b66932023-06-28 19:26:25 +0000635 struct key_value_info kvi = KVI_INIT;
636
637 kvi_from_param(&kvi);
Junio C Hamanoa789ca72014-08-04 15:40:19 -0700638
Jeff Kingf77bcca2011-06-09 11:55:09 -0400639 pair = strbuf_split_str(text, '=', 2);
Jeff Kingc5d63502011-06-09 11:52:43 -0400640 if (!pair[0])
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +0200641 return error(_("bogus config parameter: %s"), text);
Junio C Hamanoa789ca72014-08-04 15:40:19 -0700642
643 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
Alex Riesen572e4f62010-03-26 23:56:01 +0100644 strbuf_setlen(pair[0], pair[0]->len - 1);
Junio C Hamanoa789ca72014-08-04 15:40:19 -0700645 value = pair[1] ? pair[1]->buf : "";
646 } else {
647 value = NULL;
648 }
649
Alex Riesen572e4f62010-03-26 23:56:01 +0100650 strbuf_trim(pair[0]);
651 if (!pair[0]->len) {
652 strbuf_list_free(pair);
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +0200653 return error(_("bogus config parameter: %s"), text);
Jeff King06eb7082011-05-24 18:49:55 -0400654 }
Junio C Hamano1274a152017-02-23 15:04:40 -0800655
Glen Choo26b66932023-06-28 19:26:25 +0000656 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
Alex Riesen572e4f62010-03-26 23:56:01 +0100657 strbuf_list_free(pair);
Junio C Hamano1274a152017-02-23 15:04:40 -0800658 return ret;
Alex Riesen8b1fa772010-03-26 23:53:57 +0100659}
660
Glen Choo26b66932023-06-28 19:26:25 +0000661static int parse_config_env_list(char *env, struct key_value_info *kvi,
662 config_fn_t fn, void *data)
Jeff Kingf9dbb642021-01-12 13:27:06 +0100663{
664 char *cur = env;
665 while (cur && *cur) {
666 const char *key = sq_dequote_step(cur, &cur);
667 if (!key)
668 return error(_("bogus format in %s"),
669 CONFIG_DATA_ENVIRONMENT);
670
671 if (!cur || isspace(*cur)) {
672 /* old-style 'key=value' */
673 if (git_config_parse_parameter(key, fn, data) < 0)
674 return -1;
675 }
676 else if (*cur == '=') {
677 /* new-style 'key'='value' */
678 const char *value;
679
680 cur++;
681 if (*cur == '\'') {
682 /* quoted value */
683 value = sq_dequote_step(cur, &cur);
684 if (!value || (cur && !isspace(*cur))) {
685 return error(_("bogus format in %s"),
686 CONFIG_DATA_ENVIRONMENT);
687 }
688 } else if (!*cur || isspace(*cur)) {
689 /* implicit bool: 'key'= */
690 value = NULL;
691 } else {
692 return error(_("bogus format in %s"),
693 CONFIG_DATA_ENVIRONMENT);
694 }
695
Glen Choo26b66932023-06-28 19:26:25 +0000696 if (config_parse_pair(key, value, kvi, fn, data) < 0)
Jeff Kingf9dbb642021-01-12 13:27:06 +0100697 return -1;
698 }
699 else {
700 /* unknown format */
701 return error(_("bogus format in %s"),
702 CONFIG_DATA_ENVIRONMENT);
703 }
704
705 if (cur) {
706 while (isspace(*cur))
707 cur++;
708 }
709 }
710 return 0;
711}
712
Jeff King06eb7082011-05-24 18:49:55 -0400713int git_config_from_parameters(config_fn_t fn, void *data)
714{
Patrick Steinhardtd8d77152021-01-12 13:27:14 +0100715 const char *env;
716 struct strbuf envvar = STRBUF_INIT;
717 struct strvec to_free = STRVEC_INIT;
Jeff Kinga77d6db2016-05-18 18:39:49 -0400718 int ret = 0;
Patrick Steinhardtd8d77152021-01-12 13:27:14 +0100719 char *envw = NULL;
Glen Choo26b66932023-06-28 19:26:25 +0000720 struct key_value_info kvi = KVI_INIT;
Jeff King2b64fc82010-08-23 15:16:00 -0400721
Glen Choo26b66932023-06-28 19:26:25 +0000722 kvi_from_param(&kvi);
Patrick Steinhardtd8d77152021-01-12 13:27:14 +0100723 env = getenv(CONFIG_COUNT_ENVIRONMENT);
724 if (env) {
725 unsigned long count;
726 char *endp;
727 int i;
Jeff King2b64fc82010-08-23 15:16:00 -0400728
Patrick Steinhardtd8d77152021-01-12 13:27:14 +0100729 count = strtoul(env, &endp, 10);
730 if (*endp) {
731 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
732 goto out;
733 }
734 if (count > INT_MAX) {
735 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
736 goto out;
737 }
738
739 for (i = 0; i < count; i++) {
740 const char *key, *value;
741
742 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
743 key = getenv_safe(&to_free, envvar.buf);
744 if (!key) {
745 ret = error(_("missing config key %s"), envvar.buf);
746 goto out;
747 }
748 strbuf_reset(&envvar);
749
750 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
751 value = getenv_safe(&to_free, envvar.buf);
752 if (!value) {
753 ret = error(_("missing config value %s"), envvar.buf);
754 goto out;
755 }
756 strbuf_reset(&envvar);
757
Glen Choo26b66932023-06-28 19:26:25 +0000758 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
Patrick Steinhardtd8d77152021-01-12 13:27:14 +0100759 ret = -1;
760 goto out;
761 }
762 }
Jeff King2b64fc82010-08-23 15:16:00 -0400763 }
764
Patrick Steinhardtd8d77152021-01-12 13:27:14 +0100765 env = getenv(CONFIG_DATA_ENVIRONMENT);
766 if (env) {
767 /* sq_dequote will write over it */
768 envw = xstrdup(env);
Glen Choo26b66932023-06-28 19:26:25 +0000769 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
Jeff Kinga77d6db2016-05-18 18:39:49 -0400770 ret = -1;
771 goto out;
Jeff King2b64fc82010-08-23 15:16:00 -0400772 }
773 }
774
Jeff Kinga77d6db2016-05-18 18:39:49 -0400775out:
Patrick Steinhardtd8d77152021-01-12 13:27:14 +0100776 strbuf_release(&envvar);
777 strvec_clear(&to_free);
Jeff King2b64fc82010-08-23 15:16:00 -0400778 free(envw);
Jeff Kinga77d6db2016-05-18 18:39:49 -0400779 return ret;
Jeff King2b64fc82010-08-23 15:16:00 -0400780}
781
Glen Choo9b4a6552023-03-28 17:51:54 +0000782static int get_next_char(struct config_source *cs)
Linus Torvalds17712992005-10-10 16:31:08 -0700783{
Glen Choo9b4a6552023-03-28 17:51:54 +0000784 int c = cs->do_fgetc(cs);
Linus Torvalds17712992005-10-10 16:31:08 -0700785
Heiko Voigtdbb9a812013-05-11 15:19:29 +0200786 if (c == '\r') {
787 /* DOS like systems */
Glen Choo9b4a6552023-03-28 17:51:54 +0000788 c = cs->do_fgetc(cs);
Heiko Voigtdbb9a812013-05-11 15:19:29 +0200789 if (c != '\n') {
Jeff King5e0be132015-02-05 01:53:28 -0500790 if (c != EOF)
Glen Choo9b4a6552023-03-28 17:51:54 +0000791 cs->do_ungetc(c, cs);
Heiko Voigtdbb9a812013-05-11 15:19:29 +0200792 c = '\r';
Junio C Hamanodb2c0752005-11-02 13:02:57 -0800793 }
Heiko Voigtdbb9a812013-05-11 15:19:29 +0200794 }
Jeff King348482d2020-04-10 15:50:07 -0400795
Glen Choo9b4a6552023-03-28 17:51:54 +0000796 if (c != EOF && ++cs->total_len > INT_MAX) {
Jeff King348482d2020-04-10 15:50:07 -0400797 /*
798 * This is an absurdly long config file; refuse to parse
799 * further in order to protect downstream code from integer
800 * overflows. Note that we can't return an error specifically,
801 * but we can mark EOF and put trash in the return value,
802 * which will trigger a parse error.
803 */
Glen Choo9b4a6552023-03-28 17:51:54 +0000804 cs->eof = 1;
Jeff King348482d2020-04-10 15:50:07 -0400805 return 0;
806 }
807
Heiko Voigtdbb9a812013-05-11 15:19:29 +0200808 if (c == '\n')
Glen Choo9b4a6552023-03-28 17:51:54 +0000809 cs->linenr++;
Heiko Voigtdbb9a812013-05-11 15:19:29 +0200810 if (c == EOF) {
Glen Choo9b4a6552023-03-28 17:51:54 +0000811 cs->eof = 1;
812 cs->linenr++;
Heiko Voigtdbb9a812013-05-11 15:19:29 +0200813 c = '\n';
Linus Torvalds17712992005-10-10 16:31:08 -0700814 }
815 return c;
816}
817
Glen Choo9b4a6552023-03-28 17:51:54 +0000818static char *parse_value(struct config_source *cs)
Linus Torvalds17712992005-10-10 16:31:08 -0700819{
Dragan Simicf0b89442024-03-21 07:06:06 +0100820 int quote = 0, comment = 0;
821 size_t trim_len = 0;
Linus Torvalds17712992005-10-10 16:31:08 -0700822
Glen Choo9b4a6552023-03-28 17:51:54 +0000823 strbuf_reset(&cs->value);
Linus Torvalds17712992005-10-10 16:31:08 -0700824 for (;;) {
Glen Choo9b4a6552023-03-28 17:51:54 +0000825 int c = get_next_char(cs);
Linus Torvalds17712992005-10-10 16:31:08 -0700826 if (c == '\n') {
Martin Stenberg4b340592012-03-09 22:57:54 +0100827 if (quote) {
Glen Choo9b4a6552023-03-28 17:51:54 +0000828 cs->linenr--;
Linus Torvalds17712992005-10-10 16:31:08 -0700829 return NULL;
Martin Stenberg4b340592012-03-09 22:57:54 +0100830 }
Dragan Simicf0b89442024-03-21 07:06:06 +0100831 if (trim_len)
832 strbuf_setlen(&cs->value, trim_len);
Glen Choo9b4a6552023-03-28 17:51:54 +0000833 return cs->value.buf;
Linus Torvalds17712992005-10-10 16:31:08 -0700834 }
835 if (comment)
836 continue;
837 if (isspace(c) && !quote) {
Dragan Simicf0b89442024-03-21 07:06:06 +0100838 if (!trim_len)
839 trim_len = cs->value.len;
Glen Choo9b4a6552023-03-28 17:51:54 +0000840 if (cs->value.len)
Dragan Simicf0b89442024-03-21 07:06:06 +0100841 strbuf_addch(&cs->value, c);
Linus Torvalds17712992005-10-10 16:31:08 -0700842 continue;
843 }
Johannes Schindelin7ebdba62006-05-02 16:58:37 +0200844 if (!quote) {
845 if (c == ';' || c == '#') {
846 comment = 1;
847 continue;
848 }
849 }
Dragan Simicf0b89442024-03-21 07:06:06 +0100850 if (trim_len)
851 trim_len = 0;
Linus Torvalds17712992005-10-10 16:31:08 -0700852 if (c == '\\') {
Glen Choo9b4a6552023-03-28 17:51:54 +0000853 c = get_next_char(cs);
Linus Torvalds17712992005-10-10 16:31:08 -0700854 switch (c) {
855 case '\n':
856 continue;
857 case 't':
858 c = '\t';
859 break;
860 case 'b':
861 c = '\b';
862 break;
863 case 'n':
864 c = '\n';
865 break;
Linus Torvalds5cbb4012005-10-11 15:24:11 -0700866 /* Some characters escape as themselves */
867 case '\\': case '"':
868 break;
869 /* Reject unknown escape sequences */
870 default:
871 return NULL;
Linus Torvalds17712992005-10-10 16:31:08 -0700872 }
Glen Choo9b4a6552023-03-28 17:51:54 +0000873 strbuf_addch(&cs->value, c);
Linus Torvalds17712992005-10-10 16:31:08 -0700874 continue;
875 }
876 if (c == '"') {
Dragan Simic0d49b1e2024-03-21 07:06:05 +0100877 quote = 1 - quote;
Linus Torvalds17712992005-10-10 16:31:08 -0700878 continue;
879 }
Glen Choo9b4a6552023-03-28 17:51:54 +0000880 strbuf_addch(&cs->value, c);
Linus Torvalds17712992005-10-10 16:31:08 -0700881 }
882}
883
Glen Choo809d8682023-06-28 19:26:24 +0000884static int get_value(struct config_source *cs, struct key_value_info *kvi,
885 config_fn_t fn, void *data, struct strbuf *name)
Linus Torvalds17712992005-10-10 16:31:08 -0700886{
887 int c;
888 char *value;
Matthieu Moyb3b3f602014-08-07 04:59:13 -0700889 int ret;
Glen Choo809d8682023-06-28 19:26:24 +0000890 struct config_context ctx = {
891 .kvi = kvi,
892 };
Linus Torvalds17712992005-10-10 16:31:08 -0700893
894 /* Get the full name */
895 for (;;) {
Glen Choo9b4a6552023-03-28 17:51:54 +0000896 c = get_next_char(cs);
897 if (cs->eof)
Linus Torvalds17712992005-10-10 16:31:08 -0700898 break;
Linus Torvalds38c5afa2006-10-30 08:25:36 -0800899 if (!iskeychar(c))
Linus Torvalds17712992005-10-10 16:31:08 -0700900 break;
Ben Walton0971e992012-09-30 20:44:36 +0100901 strbuf_addch(name, tolower(c));
Linus Torvalds17712992005-10-10 16:31:08 -0700902 }
Ben Walton0971e992012-09-30 20:44:36 +0100903
Linus Torvalds17712992005-10-10 16:31:08 -0700904 while (c == ' ' || c == '\t')
Glen Choo9b4a6552023-03-28 17:51:54 +0000905 c = get_next_char(cs);
Linus Torvalds17712992005-10-10 16:31:08 -0700906
907 value = NULL;
908 if (c != '\n') {
909 if (c != '=')
910 return -1;
Glen Choo9b4a6552023-03-28 17:51:54 +0000911 value = parse_value(cs);
Linus Torvalds17712992005-10-10 16:31:08 -0700912 if (!value)
913 return -1;
914 }
Matthieu Moyb3b3f602014-08-07 04:59:13 -0700915 /*
916 * We already consumed the \n, but we need linenr to point to
917 * the line we just parsed during the call to fn to get
918 * accurate line number in error messages.
919 */
Glen Choo9b4a6552023-03-28 17:51:54 +0000920 cs->linenr--;
Glen Choo809d8682023-06-28 19:26:24 +0000921 kvi->linenr = cs->linenr;
922 ret = fn(name->buf, value, &ctx, data);
Johannes Schindeline2e14252017-06-14 13:35:46 +0200923 if (ret >= 0)
Glen Choo9b4a6552023-03-28 17:51:54 +0000924 cs->linenr++;
Matthieu Moyb3b3f602014-08-07 04:59:13 -0700925 return ret;
Linus Torvalds17712992005-10-10 16:31:08 -0700926}
927
Glen Choo9b4a6552023-03-28 17:51:54 +0000928static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
Glen Chooc97f3ed2023-03-28 17:51:47 +0000929 int c)
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700930{
Glen Choo9b4a6552023-03-28 17:51:54 +0000931 cs->subsection_case_sensitive = 0;
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700932 do {
933 if (c == '\n')
Martin Stenberg4b340592012-03-09 22:57:54 +0100934 goto error_incomplete_line;
Glen Choo9b4a6552023-03-28 17:51:54 +0000935 c = get_next_char(cs);
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700936 } while (isspace(c));
937
938 /* We require the format to be '[base "extension"]' */
939 if (c != '"')
940 return -1;
Ben Walton0971e992012-09-30 20:44:36 +0100941 strbuf_addch(name, '.');
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700942
943 for (;;) {
Glen Choo9b4a6552023-03-28 17:51:54 +0000944 int c = get_next_char(cs);
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700945 if (c == '\n')
Martin Stenberg4b340592012-03-09 22:57:54 +0100946 goto error_incomplete_line;
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700947 if (c == '"')
948 break;
949 if (c == '\\') {
Glen Choo9b4a6552023-03-28 17:51:54 +0000950 c = get_next_char(cs);
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700951 if (c == '\n')
Martin Stenberg4b340592012-03-09 22:57:54 +0100952 goto error_incomplete_line;
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700953 }
Ben Walton0971e992012-09-30 20:44:36 +0100954 strbuf_addch(name, c);
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700955 }
956
957 /* Final ']' */
Glen Choo9b4a6552023-03-28 17:51:54 +0000958 if (get_next_char(cs) != ']')
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700959 return -1;
Ben Walton0971e992012-09-30 20:44:36 +0100960 return 0;
Martin Stenberg4b340592012-03-09 22:57:54 +0100961error_incomplete_line:
Glen Choo9b4a6552023-03-28 17:51:54 +0000962 cs->linenr--;
Martin Stenberg4b340592012-03-09 22:57:54 +0100963 return -1;
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700964}
965
Glen Choo9b4a6552023-03-28 17:51:54 +0000966static int get_base_var(struct config_source *cs, struct strbuf *name)
Linus Torvalds17712992005-10-10 16:31:08 -0700967{
Glen Choo9b4a6552023-03-28 17:51:54 +0000968 cs->subsection_case_sensitive = 1;
Linus Torvalds17712992005-10-10 16:31:08 -0700969 for (;;) {
Glen Choo9b4a6552023-03-28 17:51:54 +0000970 int c = get_next_char(cs);
971 if (cs->eof)
Linus Torvalds17712992005-10-10 16:31:08 -0700972 return -1;
973 if (c == ']')
Ben Walton0971e992012-09-30 20:44:36 +0100974 return 0;
Linus Torvaldsd14f7762006-05-09 12:24:02 -0700975 if (isspace(c))
Glen Choo9b4a6552023-03-28 17:51:54 +0000976 return get_extended_base_var(cs, name, c);
Linus Torvalds38c5afa2006-10-30 08:25:36 -0800977 if (!iskeychar(c) && c != '.')
Linus Torvalds17712992005-10-10 16:31:08 -0700978 return -1;
Ben Walton0971e992012-09-30 20:44:36 +0100979 strbuf_addch(name, tolower(c));
Linus Torvalds17712992005-10-10 16:31:08 -0700980 }
981}
982
Johannes Schindelin8032cc42018-04-09 10:32:05 +0200983struct parse_event_data {
984 enum config_event_t previous_type;
985 size_t previous_offset;
986 const struct config_options *opts;
987};
988
Glen Choo9b4a6552023-03-28 17:51:54 +0000989static int do_event(struct config_source *cs, enum config_event_t type,
Glen Chooc97f3ed2023-03-28 17:51:47 +0000990 struct parse_event_data *data)
Johannes Schindelin8032cc42018-04-09 10:32:05 +0200991{
992 size_t offset;
993
994 if (!data->opts || !data->opts->event_fn)
995 return 0;
996
997 if (type == CONFIG_EVENT_WHITESPACE &&
998 data->previous_type == type)
999 return 0;
1000
Glen Choo9b4a6552023-03-28 17:51:54 +00001001 offset = cs->do_ftell(cs);
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001002 /*
1003 * At EOF, the parser always "inserts" an extra '\n', therefore
1004 * the end offset of the event is the current file position, otherwise
1005 * we will already have advanced to the next event.
1006 */
1007 if (type != CONFIG_EVENT_EOF)
1008 offset--;
1009
1010 if (data->previous_type != CONFIG_EVENT_EOF &&
1011 data->opts->event_fn(data->previous_type, data->previous_offset,
Glen Choo6e8e7982023-06-28 19:26:30 +00001012 offset, cs, data->opts->event_fn_data) < 0)
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001013 return -1;
1014
1015 data->previous_type = type;
1016 data->previous_offset = offset;
1017
1018 return 0;
1019}
1020
Glen Choo809d8682023-06-28 19:26:24 +00001021static void kvi_from_source(struct config_source *cs,
1022 enum config_scope scope,
1023 struct key_value_info *out)
1024{
1025 out->filename = strintern(cs->name);
1026 out->origin_type = cs->origin_type;
1027 out->linenr = cs->linenr;
1028 out->scope = scope;
Glen Choo908857a2023-06-28 19:26:29 +00001029 out->path = cs->path;
Glen Choo809d8682023-06-28 19:26:24 +00001030}
1031
Glen Choo9b4a6552023-03-28 17:51:54 +00001032static int git_parse_source(struct config_source *cs, config_fn_t fn,
Glen Choo809d8682023-06-28 19:26:24 +00001033 struct key_value_info *kvi, void *data,
1034 const struct config_options *opts)
Linus Torvalds17712992005-10-10 16:31:08 -07001035{
1036 int comment = 0;
Jeff King6a9c2352020-04-10 15:47:51 -04001037 size_t baselen = 0;
Glen Choo9b4a6552023-03-28 17:51:54 +00001038 struct strbuf *var = &cs->var;
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001039 int error_return = 0;
1040 char *error_msg = NULL;
Linus Torvalds17712992005-10-10 16:31:08 -07001041
Petr Baudisde056402008-10-01 22:13:02 +02001042 /* U+FEFF Byte Order Mark in UTF8 */
Junio C Hamano599446d2015-04-16 10:47:45 -07001043 const char *bomptr = utf8_bom;
Petr Baudisde056402008-10-01 22:13:02 +02001044
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001045 /* For the parser event callback */
1046 struct parse_event_data event_data = {
1047 CONFIG_EVENT_EOF, 0, opts
1048 };
1049
Linus Torvalds17712992005-10-10 16:31:08 -07001050 for (;;) {
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001051 int c;
1052
Glen Choo9b4a6552023-03-28 17:51:54 +00001053 c = get_next_char(cs);
Petr Baudisde056402008-10-01 22:13:02 +02001054 if (bomptr && *bomptr) {
1055 /* We are at the file beginning; skip UTF8-encoded BOM
1056 * if present. Sane editors won't put this in on their
1057 * own, but e.g. Windows Notepad will do it happily. */
Junio C Hamano599446d2015-04-16 10:47:45 -07001058 if (c == (*bomptr & 0377)) {
Petr Baudisde056402008-10-01 22:13:02 +02001059 bomptr++;
1060 continue;
1061 } else {
1062 /* Do not tolerate partial BOM. */
1063 if (bomptr != utf8_bom)
1064 break;
1065 /* No BOM at file beginning. Cool. */
1066 bomptr = NULL;
1067 }
1068 }
Linus Torvalds17712992005-10-10 16:31:08 -07001069 if (c == '\n') {
Glen Choo9b4a6552023-03-28 17:51:54 +00001070 if (cs->eof) {
1071 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001072 return -1;
Linus Torvalds17712992005-10-10 16:31:08 -07001073 return 0;
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001074 }
Glen Choo9b4a6552023-03-28 17:51:54 +00001075 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001076 return -1;
Linus Torvalds17712992005-10-10 16:31:08 -07001077 comment = 0;
1078 continue;
1079 }
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001080 if (comment)
Linus Torvalds17712992005-10-10 16:31:08 -07001081 continue;
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001082 if (isspace(c)) {
Glen Choo9b4a6552023-03-28 17:51:54 +00001083 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001084 return -1;
1085 continue;
1086 }
Linus Torvalds17712992005-10-10 16:31:08 -07001087 if (c == '#' || c == ';') {
Glen Choo9b4a6552023-03-28 17:51:54 +00001088 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001089 return -1;
Linus Torvalds17712992005-10-10 16:31:08 -07001090 comment = 1;
1091 continue;
1092 }
1093 if (c == '[') {
Glen Choo9b4a6552023-03-28 17:51:54 +00001094 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001095 return -1;
1096
Ben Walton0971e992012-09-30 20:44:36 +01001097 /* Reset prior to determining a new stem */
1098 strbuf_reset(var);
Glen Choo9b4a6552023-03-28 17:51:54 +00001099 if (get_base_var(cs, var) < 0 || var->len < 1)
Linus Torvalds17712992005-10-10 16:31:08 -07001100 break;
Ben Walton0971e992012-09-30 20:44:36 +01001101 strbuf_addch(var, '.');
1102 baselen = var->len;
Linus Torvalds17712992005-10-10 16:31:08 -07001103 continue;
1104 }
1105 if (!isalpha(c))
1106 break;
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001107
Glen Choo9b4a6552023-03-28 17:51:54 +00001108 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001109 return -1;
1110
Ben Walton0971e992012-09-30 20:44:36 +01001111 /*
1112 * Truncate the var name back to the section header
1113 * stem prior to grabbing the suffix part of the name
1114 * and the value.
1115 */
1116 strbuf_setlen(var, baselen);
1117 strbuf_addch(var, tolower(c));
Glen Choo809d8682023-06-28 19:26:24 +00001118 if (get_value(cs, kvi, fn, data, var) < 0)
Linus Torvalds17712992005-10-10 16:31:08 -07001119 break;
1120 }
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001121
Glen Choo9b4a6552023-03-28 17:51:54 +00001122 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001123 return -1;
1124
Glen Choo9b4a6552023-03-28 17:51:54 +00001125 switch (cs->origin_type) {
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001126 case CONFIG_ORIGIN_BLOB:
1127 error_msg = xstrfmt(_("bad config line %d in blob %s"),
Glen Choo9b4a6552023-03-28 17:51:54 +00001128 cs->linenr, cs->name);
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001129 break;
1130 case CONFIG_ORIGIN_FILE:
1131 error_msg = xstrfmt(_("bad config line %d in file %s"),
Glen Choo9b4a6552023-03-28 17:51:54 +00001132 cs->linenr, cs->name);
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001133 break;
1134 case CONFIG_ORIGIN_STDIN:
1135 error_msg = xstrfmt(_("bad config line %d in standard input"),
Glen Choo9b4a6552023-03-28 17:51:54 +00001136 cs->linenr);
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001137 break;
1138 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1139 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
Glen Choo9b4a6552023-03-28 17:51:54 +00001140 cs->linenr, cs->name);
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001141 break;
1142 case CONFIG_ORIGIN_CMDLINE:
1143 error_msg = xstrfmt(_("bad config line %d in command line %s"),
Glen Choo9b4a6552023-03-28 17:51:54 +00001144 cs->linenr, cs->name);
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001145 break;
1146 default:
1147 error_msg = xstrfmt(_("bad config line %d in %s"),
Glen Choo9b4a6552023-03-28 17:51:54 +00001148 cs->linenr, cs->name);
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001149 }
1150
Jeff King66f97222018-06-28 18:05:00 -04001151 switch (opts && opts->error_action ?
1152 opts->error_action :
Glen Choo9b4a6552023-03-28 17:51:54 +00001153 cs->default_error_action) {
Jeff King66f97222018-06-28 18:05:00 -04001154 case CONFIG_ERROR_DIE:
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001155 die("%s", error_msg);
Jeff King66f97222018-06-28 18:05:00 -04001156 break;
1157 case CONFIG_ERROR_ERROR:
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001158 error_return = error("%s", error_msg);
Jeff King66f97222018-06-28 18:05:00 -04001159 break;
Jeff King63583202018-06-28 18:05:09 -04001160 case CONFIG_ERROR_SILENT:
1161 error_return = -1;
1162 break;
Jeff King66f97222018-06-28 18:05:00 -04001163 case CONFIG_ERROR_UNSET:
1164 BUG("config error action unset");
1165 }
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001166
1167 free(error_msg);
1168 return error_return;
Linus Torvalds17712992005-10-10 16:31:08 -07001169}
1170
Jeff King06bdc232014-04-16 12:51:47 -04001171NORETURN
Glen Choo8868b1e2023-06-28 19:26:27 +00001172static void die_bad_number(const char *name, const char *value,
1173 const struct key_value_info *kvi)
Jeff Kingc1867ce2008-02-20 19:00:32 -05001174{
Ævar Arnfjörð Bjarmason2e43cd42019-06-21 12:18:07 +02001175 const char *error_type = (errno == ERANGE) ?
1176 N_("out of range") : N_("invalid unit");
1177 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
Glen Choo8868b1e2023-06-28 19:26:27 +00001178
1179 if (!kvi)
1180 BUG("kvi should not be NULL");
Jean-Noel Avila078fe302016-08-21 16:50:39 +02001181
Jeff King2f666582013-09-08 04:38:22 -04001182 if (!value)
1183 value = "";
1184
Glen Choo8868b1e2023-06-28 19:26:27 +00001185 if (!kvi->filename)
Ævar Arnfjörð Bjarmason2e43cd42019-06-21 12:18:07 +02001186 die(_(bad_numeric), value, name, _(error_type));
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001187
Glen Choo8868b1e2023-06-28 19:26:27 +00001188 switch (kvi->origin_type) {
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001189 case CONFIG_ORIGIN_BLOB:
Jean-Noel Avila078fe302016-08-21 16:50:39 +02001190 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
Glen Choo8868b1e2023-06-28 19:26:27 +00001191 value, name, kvi->filename, _(error_type));
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001192 case CONFIG_ORIGIN_FILE:
Jean-Noel Avila078fe302016-08-21 16:50:39 +02001193 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
Glen Choo8868b1e2023-06-28 19:26:27 +00001194 value, name, kvi->filename, _(error_type));
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001195 case CONFIG_ORIGIN_STDIN:
Jean-Noel Avila078fe302016-08-21 16:50:39 +02001196 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
Ævar Arnfjörð Bjarmason2e43cd42019-06-21 12:18:07 +02001197 value, name, _(error_type));
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001198 case CONFIG_ORIGIN_SUBMODULE_BLOB:
Jean-Noel Avila078fe302016-08-21 16:50:39 +02001199 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
Glen Choo8868b1e2023-06-28 19:26:27 +00001200 value, name, kvi->filename, _(error_type));
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001201 case CONFIG_ORIGIN_CMDLINE:
Jean-Noel Avila078fe302016-08-21 16:50:39 +02001202 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
Glen Choo8868b1e2023-06-28 19:26:27 +00001203 value, name, kvi->filename, _(error_type));
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001204 default:
Jean-Noel Avila078fe302016-08-21 16:50:39 +02001205 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
Glen Choo8868b1e2023-06-28 19:26:27 +00001206 value, name, kvi->filename, _(error_type));
Vasco Almeida1b8132d2016-07-28 13:14:03 +00001207 }
Jeff Kingc1867ce2008-02-20 19:00:32 -05001208}
1209
Glen Choo8868b1e2023-06-28 19:26:27 +00001210int git_config_int(const char *name, const char *value,
1211 const struct key_value_info *kvi)
Brian Downing0b87b6e2007-07-12 08:32:26 -05001212{
Jeff King42d194e2013-09-08 04:33:08 -04001213 int ret;
1214 if (!git_parse_int(value, &ret))
Glen Choo8868b1e2023-06-28 19:26:27 +00001215 die_bad_number(name, value, kvi);
Brian Downing0b87b6e2007-07-12 08:32:26 -05001216 return ret;
1217}
1218
Glen Choo8868b1e2023-06-28 19:26:27 +00001219int64_t git_config_int64(const char *name, const char *value,
1220 const struct key_value_info *kvi)
Jeff King00160242013-09-08 04:40:02 -04001221{
1222 int64_t ret;
1223 if (!git_parse_int64(value, &ret))
Glen Choo8868b1e2023-06-28 19:26:27 +00001224 die_bad_number(name, value, kvi);
Brian Downing0b87b6e2007-07-12 08:32:26 -05001225 return ret;
1226}
1227
Glen Choo8868b1e2023-06-28 19:26:27 +00001228unsigned long git_config_ulong(const char *name, const char *value,
1229 const struct key_value_info *kvi)
Brian Downing0b87b6e2007-07-12 08:32:26 -05001230{
1231 unsigned long ret;
1232 if (!git_parse_ulong(value, &ret))
Glen Choo8868b1e2023-06-28 19:26:27 +00001233 die_bad_number(name, value, kvi);
Brian Downing0b87b6e2007-07-12 08:32:26 -05001234 return ret;
Linus Torvalds17712992005-10-10 16:31:08 -07001235}
1236
Glen Choo8868b1e2023-06-28 19:26:27 +00001237ssize_t git_config_ssize_t(const char *name, const char *value,
1238 const struct key_value_info *kvi)
David Turner37ee6802017-04-11 14:13:57 -04001239{
1240 ssize_t ret;
1241 if (!git_parse_ssize_t(value, &ret))
Glen Choo8868b1e2023-06-28 19:26:27 +00001242 die_bad_number(name, value, kvi);
David Turner37ee6802017-04-11 14:13:57 -04001243 return ret;
1244}
1245
Neeraj Singh844a8ad2022-03-10 22:43:22 +00001246static const struct fsync_component_name {
1247 const char *name;
1248 enum fsync_component component_bits;
1249} fsync_component_names[] = {
1250 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1251 { "pack", FSYNC_COMPONENT_PACK },
1252 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1253 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
Neeraj Singhba95e962022-03-10 22:43:23 +00001254 { "index", FSYNC_COMPONENT_INDEX },
Neeraj Singhb9f5d032022-03-15 12:12:45 -07001255 { "objects", FSYNC_COMPONENTS_OBJECTS },
Patrick Steinhardtbc22d842022-03-11 10:58:59 +01001256 { "reference", FSYNC_COMPONENT_REFERENCE },
Neeraj Singhb9f5d032022-03-15 12:12:45 -07001257 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1258 { "committed", FSYNC_COMPONENTS_COMMITTED },
1259 { "added", FSYNC_COMPONENTS_ADDED },
1260 { "all", FSYNC_COMPONENTS_ALL },
Neeraj Singh844a8ad2022-03-10 22:43:22 +00001261};
1262
1263static enum fsync_component parse_fsync_components(const char *var, const char *string)
1264{
Neeraj Singh8a94d832022-04-04 22:20:14 -07001265 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
Neeraj Singh844a8ad2022-03-10 22:43:22 +00001266 enum fsync_component positive = 0, negative = 0;
1267
1268 while (string) {
1269 int i;
1270 size_t len;
1271 const char *ep;
1272 int negated = 0;
1273 int found = 0;
1274
1275 string = string + strspn(string, ", \t\n\r");
1276 ep = strchrnul(string, ',');
1277 len = ep - string;
1278 if (!strcmp(string, "none")) {
1279 current = FSYNC_COMPONENT_NONE;
1280 goto next_name;
1281 }
1282
1283 if (*string == '-') {
1284 negated = 1;
1285 string++;
1286 len--;
1287 if (!len)
1288 warning(_("invalid value for variable %s"), var);
1289 }
1290
1291 if (!len)
1292 break;
1293
1294 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1295 const struct fsync_component_name *n = &fsync_component_names[i];
1296
1297 if (strncmp(n->name, string, len))
1298 continue;
1299
1300 found = 1;
1301 if (negated)
1302 negative |= n->component_bits;
1303 else
1304 positive |= n->component_bits;
1305 }
1306
1307 if (!found) {
1308 char *component = xstrndup(string, len);
1309 warning(_("ignoring unknown core.fsync component '%s'"), component);
1310 free(component);
1311 }
1312
1313next_name:
1314 string = ep;
1315 }
1316
1317 return (current & ~negative) | positive;
1318}
1319
Glen Choo8868b1e2023-06-28 19:26:27 +00001320int git_config_bool_or_int(const char *name, const char *value,
1321 const struct key_value_info *kvi, int *is_bool)
Junio C Hamano8420ccd2010-02-16 23:59:46 -08001322{
Martin Ågren9be04d62017-08-07 20:20:47 +02001323 int v = git_parse_maybe_bool_text(value);
Junio C Hamano8420ccd2010-02-16 23:59:46 -08001324 if (0 <= v) {
1325 *is_bool = 1;
1326 return v;
1327 }
Junio C Hamanoa53f2ec2008-04-12 18:33:31 -07001328 *is_bool = 0;
Glen Choo8868b1e2023-06-28 19:26:27 +00001329 return git_config_int(name, value, kvi);
Linus Torvalds17712992005-10-10 16:31:08 -07001330}
1331
Junio C Hamanoa53f2ec2008-04-12 18:33:31 -07001332int git_config_bool(const char *name, const char *value)
1333{
Andrew Klotzf276e2a2021-02-11 20:30:53 +00001334 int v = git_parse_maybe_bool(value);
1335 if (v < 0)
Ævar Arnfjörð Bjarmason39e12652021-04-08 15:25:55 +02001336 die(_("bad boolean config value '%s' for '%s'"), value, name);
Andrew Klotzf276e2a2021-02-11 20:30:53 +00001337 return v;
Junio C Hamanoa53f2ec2008-04-12 18:33:31 -07001338}
1339
Christian Couderea5105a2008-02-16 06:00:24 +01001340int git_config_string(const char **dest, const char *var, const char *value)
1341{
1342 if (!value)
1343 return config_error_nonbool(var);
1344 *dest = xstrdup(value);
1345 return 0;
1346}
1347
Matthieu Moy395de252009-11-17 18:24:25 +01001348int git_config_pathname(const char **dest, const char *var, const char *value)
1349{
1350 if (!value)
1351 return config_error_nonbool(var);
Johannes Schindelina03b0972021-07-24 22:06:52 +00001352 *dest = interpolate_path(value, 0);
Matthieu Moy395de252009-11-17 18:24:25 +01001353 if (!*dest)
Matthieu Moy8262aaa2014-08-07 04:59:12 -07001354 die(_("failed to expand user dir in: '%s'"), value);
Matthieu Moy395de252009-11-17 18:24:25 +01001355 return 0;
1356}
1357
Haaris Mehmood5f967422017-11-18 02:27:27 +00001358int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1359{
1360 if (!value)
1361 return config_error_nonbool(var);
1362 if (parse_expiry_date(value, timestamp))
1363 return error(_("'%s' for '%s' is not a valid timestamp"),
1364 value, var);
1365 return 0;
1366}
1367
Taylor Blau6d2f9ac2018-04-09 17:18:28 -07001368int git_config_color(char *dest, const char *var, const char *value)
1369{
1370 if (!value)
1371 return config_error_nonbool(var);
1372 if (color_parse(value, dest) < 0)
1373 return -1;
1374 return 0;
1375}
1376
Glen Chooa4e7e312023-06-28 19:26:22 +00001377static int git_default_core_config(const char *var, const char *value,
1378 const struct config_context *ctx, void *cb)
Linus Torvalds17712992005-10-10 16:31:08 -07001379{
1380 /* This needs a better name */
1381 if (!strcmp(var, "core.filemode")) {
1382 trust_executable_bit = git_config_bool(var, value);
1383 return 0;
1384 }
Alex Riesen1ce47902008-07-28 08:31:28 +02001385 if (!strcmp(var, "core.trustctime")) {
1386 trust_ctime = git_config_bool(var, value);
1387 return 0;
1388 }
Junio C Hamanoc1b5d732013-05-06 22:32:58 -07001389 if (!strcmp(var, "core.checkstat")) {
Jeff Kingba176db2023-12-07 02:11:14 -05001390 if (!value)
1391 return config_error_nonbool(var);
Robin Rosenbergc08e4d52013-01-22 08:49:22 +01001392 if (!strcasecmp(value, "default"))
1393 check_stat = 1;
1394 else if (!strcasecmp(value, "minimal"))
1395 check_stat = 0;
Jeff King41f98fa2023-12-07 02:24:04 -05001396 else
1397 return error(_("invalid value for '%s': '%s'"),
1398 var, value);
Robin Rosenbergc08e4d52013-01-22 08:49:22 +01001399 }
Linus Torvalds17712992005-10-10 16:31:08 -07001400
Junio C Hamano9378c162007-06-24 15:11:24 -07001401 if (!strcmp(var, "core.quotepath")) {
1402 quote_path_fully = git_config_bool(var, value);
1403 return 0;
1404 }
1405
Johannes Sixt78a8d642007-03-02 22:11:30 +01001406 if (!strcmp(var, "core.symlinks")) {
1407 has_symlinks = git_config_bool(var, value);
1408 return 0;
1409 }
1410
Linus Torvalds0a9b88b2008-03-21 16:52:46 -07001411 if (!strcmp(var, "core.ignorecase")) {
1412 ignore_case = git_config_bool(var, value);
1413 return 0;
1414 }
1415
Junio C Hamano64589a02011-10-06 13:22:24 -05001416 if (!strcmp(var, "core.attributesfile"))
1417 return git_config_pathname(&git_attributes_file, var, value);
1418
Ævar Arnfjörð Bjarmason867ad082016-05-04 22:58:12 +00001419 if (!strcmp(var, "core.hookspath"))
1420 return git_config_pathname(&git_hooks_path, var, value);
1421
Junio C Hamano7d1864c2007-01-07 02:00:28 -08001422 if (!strcmp(var, "core.bare")) {
1423 is_bare_repository_cfg = git_config_bool(var, value);
1424 return 0;
1425 }
1426
Junio C Hamano5f730762006-02-08 21:15:24 -08001427 if (!strcmp(var, "core.ignorestat")) {
1428 assume_unchanged = git_config_bool(var, value);
1429 return 0;
1430 }
1431
Junio C Hamanoe388c732006-05-02 00:40:24 -07001432 if (!strcmp(var, "core.prefersymlinkrefs")) {
1433 prefer_symlink_refs = git_config_bool(var, value);
Johannes Schindelinf8348be2005-11-15 19:24:19 +01001434 return 0;
1435 }
1436
Shawn Pearce6de08ae2006-05-17 05:55:40 -04001437 if (!strcmp(var, "core.logallrefupdates")) {
Cornelius Weig341fb282017-01-27 11:09:47 +01001438 if (value && !strcasecmp(value, "always"))
1439 log_all_ref_updates = LOG_REFS_ALWAYS;
1440 else if (git_config_bool(var, value))
1441 log_all_ref_updates = LOG_REFS_NORMAL;
1442 else
1443 log_all_ref_updates = LOG_REFS_NONE;
Shawn Pearce6de08ae2006-05-17 05:55:40 -04001444 return 0;
1445 }
1446
Junio C Hamano2f8acdb2006-03-20 18:45:47 -08001447 if (!strcmp(var, "core.warnambiguousrefs")) {
1448 warn_ambiguous_refs = git_config_bool(var, value);
1449 return 0;
1450 }
1451
Junio C Hamanoa71f09f2011-03-20 22:26:24 -07001452 if (!strcmp(var, "core.abbrev")) {
Junio C Hamano48d50142016-11-01 18:34:07 -07001453 if (!value)
1454 return config_error_nonbool(var);
1455 if (!strcasecmp(value, "auto"))
1456 default_abbrev = -1;
Eric Wonga9ecaa02020-09-01 07:43:55 +00001457 else if (!git_parse_maybe_bool_text(value))
1458 default_abbrev = the_hash_algo->hexsz;
Junio C Hamano48d50142016-11-01 18:34:07 -07001459 else {
Glen Choo8868b1e2023-06-28 19:26:27 +00001460 int abbrev = git_config_int(var, value, ctx->kvi);
brian m. carlsonfe9fec42019-08-18 20:04:13 +00001461 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02001462 return error(_("abbrev length out of range: %d"), abbrev);
Junio C Hamano48d50142016-11-01 18:34:07 -07001463 default_abbrev = abbrev;
1464 }
Linus Torvaldsdce96482010-10-28 11:28:04 -07001465 return 0;
1466 }
1467
Jeff King5b33cb12016-09-27 08:38:01 -04001468 if (!strcmp(var, "core.disambiguate"))
1469 return set_disambiguate_hint_config(var, value);
1470
Dana How960ccca2007-05-09 13:56:50 -07001471 if (!strcmp(var, "core.loosecompression")) {
Glen Choo8868b1e2023-06-28 19:26:27 +00001472 int level = git_config_int(var, value, ctx->kvi);
Joachim B Haga12f6c302006-07-03 22:11:47 +02001473 if (level == -1)
1474 level = Z_DEFAULT_COMPRESSION;
1475 else if (level < 0 || level > Z_BEST_COMPRESSION)
Matthieu Moy8262aaa2014-08-07 04:59:12 -07001476 die(_("bad zlib compression level %d"), level);
Joachim B Haga12f6c302006-07-03 22:11:47 +02001477 zlib_compression_level = level;
Dana How960ccca2007-05-09 13:56:50 -07001478 zlib_compression_seen = 1;
1479 return 0;
1480 }
1481
1482 if (!strcmp(var, "core.compression")) {
Glen Choo8868b1e2023-06-28 19:26:27 +00001483 int level = git_config_int(var, value, ctx->kvi);
Dana How960ccca2007-05-09 13:56:50 -07001484 if (level == -1)
1485 level = Z_DEFAULT_COMPRESSION;
1486 else if (level < 0 || level > Z_BEST_COMPRESSION)
Matthieu Moy8262aaa2014-08-07 04:59:12 -07001487 die(_("bad zlib compression level %d"), level);
Dana How960ccca2007-05-09 13:56:50 -07001488 if (!zlib_compression_seen)
1489 zlib_compression_level = level;
Junio C Hamano8de7eeb2016-11-15 17:42:40 -08001490 if (!pack_compression_seen)
1491 pack_compression_level = level;
Joachim B Haga12f6c302006-07-03 22:11:47 +02001492 return 0;
1493 }
1494
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -05001495 if (!strcmp(var, "core.packedgitwindowsize")) {
Junio C Hamano5faaf242007-02-14 13:20:41 -08001496 int pgsz_x2 = getpagesize() * 2;
Glen Choo8868b1e2023-06-28 19:26:27 +00001497 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
Junio C Hamano5faaf242007-02-14 13:20:41 -08001498
1499 /* This value must be multiple of (pagesize * 2) */
1500 packed_git_window_size /= pgsz_x2;
1501 if (packed_git_window_size < 1)
1502 packed_git_window_size = 1;
1503 packed_git_window_size *= pgsz_x2;
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -05001504 return 0;
1505 }
1506
Junio C Hamano15366282011-04-05 10:44:11 -07001507 if (!strcmp(var, "core.bigfilethreshold")) {
Glen Choo8868b1e2023-06-28 19:26:27 +00001508 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
Junio C Hamano15366282011-04-05 10:44:11 -07001509 return 0;
1510 }
1511
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -05001512 if (!strcmp(var, "core.packedgitlimit")) {
Glen Choo8868b1e2023-06-28 19:26:27 +00001513 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -05001514 return 0;
1515 }
1516
Shawn O. Pearce18bdec12007-03-19 01:14:37 -04001517 if (!strcmp(var, "core.deltabasecachelimit")) {
Glen Choo8868b1e2023-06-28 19:26:27 +00001518 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
Shawn O. Pearce18bdec12007-03-19 01:14:37 -04001519 return 0;
1520 }
1521
Linus Torvalds6c510be2007-02-13 11:07:23 -08001522 if (!strcmp(var, "core.autocrlf")) {
Linus Torvaldsd7f46332007-02-13 18:16:12 -08001523 if (value && !strcasecmp(value, "input")) {
Eyvind Bernhardsenfd6cce92010-05-19 22:43:10 +02001524 auto_crlf = AUTO_CRLF_INPUT;
Linus Torvaldsd7f46332007-02-13 18:16:12 -08001525 return 0;
1526 }
Linus Torvalds6c510be2007-02-13 11:07:23 -08001527 auto_crlf = git_config_bool(var, value);
1528 return 0;
1529 }
1530
Steffen Prohaska21e5ad52008-02-06 12:25:58 +01001531 if (!strcmp(var, "core.safecrlf")) {
Torsten Bögershausen8462ff42018-01-13 23:49:31 +01001532 int eol_rndtrp_die;
Steffen Prohaska21e5ad52008-02-06 12:25:58 +01001533 if (value && !strcasecmp(value, "warn")) {
Torsten Bögershausen8462ff42018-01-13 23:49:31 +01001534 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
Steffen Prohaska21e5ad52008-02-06 12:25:58 +01001535 return 0;
1536 }
Torsten Bögershausen8462ff42018-01-13 23:49:31 +01001537 eol_rndtrp_die = git_config_bool(var, value);
1538 global_conv_flags_eol = eol_rndtrp_die ?
Anthony Sottile6cb09122018-06-04 13:17:42 -07001539 CONV_EOL_RNDTRP_DIE : 0;
Steffen Prohaska21e5ad52008-02-06 12:25:58 +01001540 return 0;
1541 }
1542
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +02001543 if (!strcmp(var, "core.eol")) {
1544 if (value && !strcasecmp(value, "lf"))
Junio C Hamanoec70f522011-05-09 12:52:12 -07001545 core_eol = EOL_LF;
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +02001546 else if (value && !strcasecmp(value, "crlf"))
Junio C Hamanoec70f522011-05-09 12:52:12 -07001547 core_eol = EOL_CRLF;
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +02001548 else if (value && !strcasecmp(value, "native"))
Junio C Hamanoec70f522011-05-09 12:52:12 -07001549 core_eol = EOL_NATIVE;
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +02001550 else
Junio C Hamanoec70f522011-05-09 12:52:12 -07001551 core_eol = EOL_UNSET;
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +02001552 return 0;
1553 }
1554
Jeff Kingbe6bc042023-12-07 02:26:11 -05001555 if (!strcmp(var, "core.checkroundtripencoding"))
1556 return git_config_string(&check_roundtrip_encoding, var, value);
Lars Schneidere92d6222018-04-15 20:16:10 +02001557
Johannes Schindelina97a7462009-10-09 12:21:57 +02001558 if (!strcmp(var, "core.notesref")) {
Jeff Kingba176db2023-12-07 02:11:14 -05001559 if (!value)
1560 return config_error_nonbool(var);
Johannes Schindelina97a7462009-10-09 12:21:57 +02001561 notes_ref_name = xstrdup(value);
1562 return 0;
1563 }
1564
Linus Torvalds806e2ad2008-06-18 14:37:18 -07001565 if (!strcmp(var, "core.editor"))
1566 return git_config_string(&editor_program, var, value);
1567
Jeff King9ccf3e92024-03-27 04:19:22 -04001568 if (!strcmp(var, "core.commentchar") ||
1569 !strcmp(var, "core.commentstring")) {
Jeff King649409b2014-07-24 00:42:39 -04001570 if (!value)
1571 return config_error_nonbool(var);
Junio C Hamanoad524f82014-07-28 11:30:41 -07001572 else if (!strcasecmp(value, "auto"))
Nguyễn Thái Ngọc Duy84c9dc22014-05-17 08:52:23 +07001573 auto_comment_line_char = 1;
Jeff King8b311472024-03-12 05:17:50 -04001574 else if (value[0]) {
1575 if (strchr(value, '\n'))
Jeff King9ccf3e92024-03-27 04:19:22 -04001576 return error(_("%s cannot contain newline"), var);
Jeff King8b311472024-03-12 05:17:50 -04001577 comment_line_str = xstrdup(value);
Nguyễn Thái Ngọc Duy84c9dc22014-05-17 08:52:23 +07001578 auto_comment_line_char = 0;
Nguyễn Thái Ngọc Duy50b54fd2014-05-17 08:52:22 +07001579 } else
Jeff King9ccf3e92024-03-27 04:19:22 -04001580 return error(_("%s must have at least one character"), var);
Nguyễn Thái Ngọc Duy50b54fd2014-05-17 08:52:22 +07001581 return 0;
Junio C Hamanoeff80a92013-01-16 20:18:48 +01001582 }
1583
Anselm Kruisd3e7da82010-08-30 15:38:38 +02001584 if (!strcmp(var, "core.askpass"))
1585 return git_config_string(&askpass_program, var, value);
1586
Junio C Hamano0e0fefb2024-04-06 11:11:12 -07001587 if (!strcmp(var, "core.excludesfile")) {
1588 free((char *)excludes_file);
Matthieu Moy395de252009-11-17 18:24:25 +01001589 return git_config_pathname(&excludes_file, var, value);
Junio C Hamano0e0fefb2024-04-06 11:11:12 -07001590 }
Linus Torvalds806e2ad2008-06-18 14:37:18 -07001591
1592 if (!strcmp(var, "core.whitespace")) {
1593 if (!value)
1594 return config_error_nonbool(var);
1595 whitespace_rule_cfg = parse_whitespace_rule(value);
1596 return 0;
1597 }
1598
Neeraj Singh844a8ad2022-03-10 22:43:22 +00001599 if (!strcmp(var, "core.fsync")) {
1600 if (!value)
1601 return config_error_nonbool(var);
1602 fsync_components = parse_fsync_components(var, value);
1603 return 0;
1604 }
1605
Neeraj Singhabf38ab2022-03-10 22:43:20 +00001606 if (!strcmp(var, "core.fsyncmethod")) {
1607 if (!value)
1608 return config_error_nonbool(var);
1609 if (!strcmp(value, "fsync"))
1610 fsync_method = FSYNC_METHOD_FSYNC;
1611 else if (!strcmp(value, "writeout-only"))
1612 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
Neeraj Singhc0f47522022-04-04 22:20:09 -07001613 else if (!strcmp(value, "batch"))
1614 fsync_method = FSYNC_METHOD_BATCH;
Neeraj Singhabf38ab2022-03-10 22:43:20 +00001615 else
1616 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1617
1618 }
1619
Linus Torvaldsaafe9fb2008-06-18 15:18:44 -07001620 if (!strcmp(var, "core.fsyncobjectfiles")) {
Neeraj Singh844a8ad2022-03-10 22:43:22 +00001621 if (fsync_object_files < 0)
Neeraj Singhf12f3b92022-03-30 18:08:36 +00001622 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
Linus Torvaldsaafe9fb2008-06-18 15:18:44 -07001623 fsync_object_files = git_config_bool(var, value);
1624 return 0;
1625 }
1626
Linus Torvalds671c9b72008-11-13 16:36:30 -08001627 if (!strcmp(var, "core.preloadindex")) {
1628 core_preload_index = git_config_bool(var, value);
1629 return 0;
1630 }
1631
Johannes Schindelin348df162009-04-28 00:32:25 +02001632 if (!strcmp(var, "core.createobject")) {
Jeff Kingba176db2023-12-07 02:11:14 -05001633 if (!value)
1634 return config_error_nonbool(var);
Johannes Schindelin348df162009-04-28 00:32:25 +02001635 if (!strcmp(value, "rename"))
1636 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1637 else if (!strcmp(value, "link"))
1638 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1639 else
Matthieu Moy8262aaa2014-08-07 04:59:12 -07001640 die(_("invalid mode for object creation: %s"), value);
Johannes Schindelinbe66a6c2009-04-25 11:57:14 +02001641 return 0;
1642 }
1643
Nguyễn Thái Ngọc Duy08aefc92009-08-20 20:47:08 +07001644 if (!strcmp(var, "core.sparsecheckout")) {
1645 core_apply_sparse_checkout = git_config_bool(var, value);
1646 return 0;
1647 }
1648
Derrick Stolee879321e2019-11-21 22:04:40 +00001649 if (!strcmp(var, "core.sparsecheckoutcone")) {
1650 core_sparse_checkout_cone = git_config_bool(var, value);
1651 return 0;
1652 }
1653
Torsten Bögershausen76759c72012-07-08 15:50:25 +02001654 if (!strcmp(var, "core.precomposeunicode")) {
1655 precomposed_unicode = git_config_bool(var, value);
1656 return 0;
1657 }
1658
Jeff Kinga42643a2014-12-15 18:15:20 -05001659 if (!strcmp(var, "core.protecthfs")) {
1660 protect_hfs = git_config_bool(var, value);
1661 return 0;
1662 }
1663
Johannes Schindelin2b4c6ef2014-12-16 23:46:59 +01001664 if (!strcmp(var, "core.protectntfs")) {
1665 protect_ntfs = git_config_bool(var, value);
1666 return 0;
1667 }
1668
Jeff Kingbe201282023-08-31 02:21:00 -04001669 if (!strcmp(var, "core.maxtreedepth")) {
1670 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1671 return 0;
1672 }
1673
Linus Torvalds806e2ad2008-06-18 14:37:18 -07001674 /* Add other config variables here and to Documentation/config.txt. */
Glen Chooa4e7e312023-06-28 19:26:22 +00001675 return platform_core_config(var, value, ctx, cb);
Linus Torvalds806e2ad2008-06-18 14:37:18 -07001676}
1677
Elijah Newrenecc7c882022-02-25 22:12:22 -08001678static int git_default_sparse_config(const char *var, const char *value)
1679{
1680 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1681 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1682 return 0;
1683 }
1684
1685 /* Add other config variables here and to Documentation/config/sparse.txt. */
1686 return 0;
1687}
1688
Linus Torvalds1141f492008-06-18 15:00:11 -07001689static int git_default_i18n_config(const char *var, const char *value)
Linus Torvaldsd1364522008-06-18 14:40:35 -07001690{
Christian Couderea5105a2008-02-16 06:00:24 +01001691 if (!strcmp(var, "i18n.commitencoding"))
1692 return git_config_string(&git_commit_encoding, var, value);
Junio C Hamano4e72dce2005-11-27 16:09:40 -08001693
Christian Couderea5105a2008-02-16 06:00:24 +01001694 if (!strcmp(var, "i18n.logoutputencoding"))
1695 return git_config_string(&git_log_output_encoding, var, value);
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001696
Linus Torvalds1141f492008-06-18 15:00:11 -07001697 /* Add other config variables here and to Documentation/config.txt. */
1698 return 0;
1699}
Matthias Lederhoferaa086eb2006-07-30 00:27:43 +02001700
Linus Torvalds1141f492008-06-18 15:00:11 -07001701static int git_default_branch_config(const char *var, const char *value)
1702{
Jay Soffian9ed36cf2008-02-19 11:24:37 -05001703 if (!strcmp(var, "branch.autosetupmerge")) {
Josh Steadmon44f14a92021-12-20 19:30:24 -08001704 if (value && !strcmp(value, "always")) {
Jay Soffian9ed36cf2008-02-19 11:24:37 -05001705 git_branch_track = BRANCH_TRACK_ALWAYS;
1706 return 0;
Josh Steadmond3115662021-12-20 19:30:23 -08001707 } else if (value && !strcmp(value, "inherit")) {
1708 git_branch_track = BRANCH_TRACK_INHERIT;
1709 return 0;
Tao Klerksbdaf1df2022-04-29 09:56:44 +00001710 } else if (value && !strcmp(value, "simple")) {
1711 git_branch_track = BRANCH_TRACK_SIMPLE;
1712 return 0;
Jay Soffian9ed36cf2008-02-19 11:24:37 -05001713 }
1714 git_branch_track = git_config_bool(var, value);
1715 return 0;
1716 }
Dustin Sallingsc998ae92008-05-10 15:36:29 -07001717 if (!strcmp(var, "branch.autosetuprebase")) {
1718 if (!value)
1719 return config_error_nonbool(var);
1720 else if (!strcmp(value, "never"))
1721 autorebase = AUTOREBASE_NEVER;
1722 else if (!strcmp(value, "local"))
1723 autorebase = AUTOREBASE_LOCAL;
1724 else if (!strcmp(value, "remote"))
1725 autorebase = AUTOREBASE_REMOTE;
1726 else if (!strcmp(value, "always"))
1727 autorebase = AUTOREBASE_ALWAYS;
1728 else
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02001729 return error(_("malformed value for %s"), var);
Dustin Sallingsc998ae92008-05-10 15:36:29 -07001730 return 0;
1731 }
Junio C Hamanoa9cc8572007-11-02 00:24:27 -07001732
Petr Baudis1ab661d2006-04-25 00:59:33 +02001733 /* Add other config variables here and to Documentation/config.txt. */
Linus Torvalds17712992005-10-10 16:31:08 -07001734 return 0;
1735}
1736
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001737static int git_default_push_config(const char *var, const char *value)
1738{
1739 if (!strcmp(var, "push.default")) {
1740 if (!value)
1741 return config_error_nonbool(var);
1742 else if (!strcmp(value, "nothing"))
1743 push_default = PUSH_DEFAULT_NOTHING;
1744 else if (!strcmp(value, "matching"))
1745 push_default = PUSH_DEFAULT_MATCHING;
Matthieu Moyb55e6772012-04-24 09:50:03 +02001746 else if (!strcmp(value, "simple"))
1747 push_default = PUSH_DEFAULT_SIMPLE;
Johan Herland53c40312011-02-16 01:54:24 +01001748 else if (!strcmp(value, "upstream"))
1749 push_default = PUSH_DEFAULT_UPSTREAM;
1750 else if (!strcmp(value, "tracking")) /* deprecated */
1751 push_default = PUSH_DEFAULT_UPSTREAM;
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001752 else if (!strcmp(value, "current"))
1753 push_default = PUSH_DEFAULT_CURRENT;
1754 else {
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02001755 error(_("malformed value for %s: %s"), var, value);
1756 return error(_("must be one of nothing, matching, simple, "
1757 "upstream or current"));
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001758 }
1759 return 0;
1760 }
1761
1762 /* Add other config variables here and to Documentation/config.txt. */
1763 return 0;
1764}
1765
Marius Storm-Olsend551a482009-02-08 15:34:27 +01001766static int git_default_mailmap_config(const char *var, const char *value)
1767{
1768 if (!strcmp(var, "mailmap.file"))
Øystein Walle9352fd52014-05-27 10:45:58 +02001769 return git_config_pathname(&git_mailmap_file, var, value);
Jeff King08610902012-12-12 06:04:04 -05001770 if (!strcmp(var, "mailmap.blob"))
1771 return git_config_string(&git_mailmap_blob, var, value);
Marius Storm-Olsend551a482009-02-08 15:34:27 +01001772
1773 /* Add other config variables here and to Documentation/config.txt. */
1774 return 0;
1775}
1776
John Cai9f9c40c2023-10-13 17:39:30 +00001777static int git_default_attr_config(const char *var, const char *value)
1778{
1779 if (!strcmp(var, "attr.tree"))
1780 return git_config_string(&git_attr_tree, var, value);
1781
1782 /*
1783 * Add other attribute related config variables here and to
1784 * Documentation/config/attr.txt.
1785 */
1786 return 0;
1787}
1788
Glen Chooa4e7e312023-06-28 19:26:22 +00001789int git_default_config(const char *var, const char *value,
1790 const struct config_context *ctx, void *cb)
Linus Torvalds1141f492008-06-18 15:00:11 -07001791{
Christian Couder59556542013-11-30 21:55:40 +01001792 if (starts_with(var, "core."))
Glen Chooa4e7e312023-06-28 19:26:22 +00001793 return git_default_core_config(var, value, ctx, cb);
Linus Torvalds1141f492008-06-18 15:00:11 -07001794
William Hubbs39ab4d02019-02-04 12:48:50 -06001795 if (starts_with(var, "user.") ||
1796 starts_with(var, "author.") ||
1797 starts_with(var, "committer."))
Glen Chooa4e7e312023-06-28 19:26:22 +00001798 return git_ident_config(var, value, ctx, cb);
Linus Torvalds1141f492008-06-18 15:00:11 -07001799
Christian Couder59556542013-11-30 21:55:40 +01001800 if (starts_with(var, "i18n."))
Linus Torvalds1141f492008-06-18 15:00:11 -07001801 return git_default_i18n_config(var, value);
1802
Christian Couder59556542013-11-30 21:55:40 +01001803 if (starts_with(var, "branch."))
Linus Torvalds1141f492008-06-18 15:00:11 -07001804 return git_default_branch_config(var, value);
1805
Christian Couder59556542013-11-30 21:55:40 +01001806 if (starts_with(var, "push."))
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001807 return git_default_push_config(var, value);
1808
Christian Couder59556542013-11-30 21:55:40 +01001809 if (starts_with(var, "mailmap."))
Marius Storm-Olsend551a482009-02-08 15:34:27 +01001810 return git_default_mailmap_config(var, value);
1811
John Cai9f9c40c2023-10-13 17:39:30 +00001812 if (starts_with(var, "attr."))
1813 return git_default_attr_config(var, value);
1814
Ryan Dammrose960786e2018-04-21 12:10:00 +02001815 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
Jeff King75194432009-09-09 07:38:58 -04001816 return git_default_advice_config(var, value);
1817
Linus Torvalds1141f492008-06-18 15:00:11 -07001818 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1819 pager_use_color = git_config_bool(var,value);
1820 return 0;
1821 }
1822
Junio C Hamano568508e2011-10-28 14:48:40 -07001823 if (!strcmp(var, "pack.packsizelimit")) {
Glen Choo8868b1e2023-06-28 19:26:27 +00001824 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
Junio C Hamano568508e2011-10-28 14:48:40 -07001825 return 0;
1826 }
Junio C Hamano8de7eeb2016-11-15 17:42:40 -08001827
1828 if (!strcmp(var, "pack.compression")) {
Glen Choo8868b1e2023-06-28 19:26:27 +00001829 int level = git_config_int(var, value, ctx->kvi);
Junio C Hamano8de7eeb2016-11-15 17:42:40 -08001830 if (level == -1)
1831 level = Z_DEFAULT_COMPRESSION;
1832 else if (level < 0 || level > Z_BEST_COMPRESSION)
1833 die(_("bad pack compression level %d"), level);
1834 pack_compression_level = level;
1835 pack_compression_seen = 1;
1836 return 0;
1837 }
1838
Elijah Newrenecc7c882022-02-25 22:12:22 -08001839 if (starts_with(var, "sparse."))
1840 return git_default_sparse_config(var, value);
1841
Linus Torvalds1141f492008-06-18 15:00:11 -07001842 /* Add other config variables here and to Documentation/config.txt. */
1843 return 0;
1844}
1845
Heiko Voigtca4b5de2013-05-11 15:18:52 +02001846/*
Heiko Voigtb2dc0942013-07-12 00:48:30 +02001847 * All source specific fields in the union, die_on_error, name and the callbacks
Heiko Voigt4d8dd142013-07-12 00:44:39 +02001848 * fgetc, ungetc, ftell of top need to be initialized before calling
Heiko Voigtca4b5de2013-05-11 15:18:52 +02001849 * this function.
1850 */
Glen Choo6e8e7982023-06-28 19:26:30 +00001851static int do_config_from(struct config_source *top, config_fn_t fn,
Glen Choo809d8682023-06-28 19:26:24 +00001852 void *data, enum config_scope scope,
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001853 const struct config_options *opts)
Heiko Voigtca4b5de2013-05-11 15:18:52 +02001854{
Glen Choo809d8682023-06-28 19:26:24 +00001855 struct key_value_info kvi = KVI_INIT;
Heiko Voigtca4b5de2013-05-11 15:18:52 +02001856 int ret;
1857
1858 /* push config-file parsing state stack */
Heiko Voigtca4b5de2013-05-11 15:18:52 +02001859 top->linenr = 1;
1860 top->eof = 0;
Jeff King348482d2020-04-10 15:50:07 -04001861 top->total_len = 0;
Heiko Voigtca4b5de2013-05-11 15:18:52 +02001862 strbuf_init(&top->value, 1024);
1863 strbuf_init(&top->var, 1024);
Glen Choo809d8682023-06-28 19:26:24 +00001864 kvi_from_source(top, scope, &kvi);
Heiko Voigtca4b5de2013-05-11 15:18:52 +02001865
Glen Choo809d8682023-06-28 19:26:24 +00001866 ret = git_parse_source(top, fn, &kvi, data, opts);
Heiko Voigtca4b5de2013-05-11 15:18:52 +02001867
Heiko Voigtca4b5de2013-05-11 15:18:52 +02001868 strbuf_release(&top->value);
1869 strbuf_release(&top->var);
Heiko Voigtca4b5de2013-05-11 15:18:52 +02001870
1871 return ret;
1872}
1873
Glen Choo6e8e7982023-06-28 19:26:30 +00001874static int do_config_from_file(config_fn_t fn,
Glen Choo0c602852023-03-28 17:51:49 +00001875 const enum config_origin_type origin_type,
1876 const char *name, const char *path, FILE *f,
Glen Choo809d8682023-06-28 19:26:24 +00001877 void *data, enum config_scope scope,
1878 const struct config_options *opts)
Kirill A. Shutemov3caec732014-02-19 00:58:55 +02001879{
Glen Chooc009bc82023-03-28 17:51:48 +00001880 struct config_source top = CONFIG_SOURCE_INIT;
Jeff King05e293c2018-03-30 15:26:15 -04001881 int ret;
Kirill A. Shutemov3caec732014-02-19 00:58:55 +02001882
1883 top.u.file = f;
Lars Schneider473166b2016-02-19 10:16:01 +01001884 top.origin_type = origin_type;
Kirill A. Shutemov3caec732014-02-19 00:58:55 +02001885 top.name = name;
1886 top.path = path;
Jeff King66f97222018-06-28 18:05:00 -04001887 top.default_error_action = CONFIG_ERROR_DIE;
Kirill A. Shutemov3caec732014-02-19 00:58:55 +02001888 top.do_fgetc = config_file_fgetc;
1889 top.do_ungetc = config_file_ungetc;
1890 top.do_ftell = config_file_ftell;
1891
Jeff King05e293c2018-03-30 15:26:15 -04001892 flockfile(f);
Glen Choo6e8e7982023-06-28 19:26:30 +00001893 ret = do_config_from(&top, fn, data, scope, opts);
Jeff King05e293c2018-03-30 15:26:15 -04001894 funlockfile(f);
1895 return ret;
Kirill A. Shutemov3caec732014-02-19 00:58:55 +02001896}
1897
Glen Choo809d8682023-06-28 19:26:24 +00001898static int git_config_from_stdin(config_fn_t fn, void *data,
1899 enum config_scope scope)
Kirill A. Shutemov3caec732014-02-19 00:58:55 +02001900{
Glen Choo6e8e7982023-06-28 19:26:30 +00001901 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1902 data, scope, NULL);
Kirill A. Shutemov3caec732014-02-19 00:58:55 +02001903}
1904
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001905int git_config_from_file_with_options(config_fn_t fn, const char *filename,
Glen Choo809d8682023-06-28 19:26:24 +00001906 void *data, enum config_scope scope,
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001907 const struct config_options *opts)
Linus Torvalds17712992005-10-10 16:31:08 -07001908{
Kirill A. Shutemov3caec732014-02-19 00:58:55 +02001909 int ret = -1;
1910 FILE *f;
Linus Torvalds17712992005-10-10 16:31:08 -07001911
Glen Choo776f1842022-07-26 22:21:06 +00001912 if (!filename)
1913 BUG("filename cannot be NULL");
Nguyễn Thái Ngọc Duye9d983f2017-05-03 17:16:50 +07001914 f = fopen_or_warn(filename, "r");
Linus Torvalds17712992005-10-10 16:31:08 -07001915 if (f) {
Glen Choo6e8e7982023-06-28 19:26:30 +00001916 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1917 filename, f, data, scope, opts);
Linus Torvalds17712992005-10-10 16:31:08 -07001918 fclose(f);
1919 }
1920 return ret;
1921}
Johannes Schindelin10bea152005-11-17 22:32:36 +01001922
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001923int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1924{
Glen Choo809d8682023-06-28 19:26:24 +00001925 return git_config_from_file_with_options(fn, filename, data,
1926 CONFIG_SCOPE_UNKNOWN, NULL);
Johannes Schindelin8032cc42018-04-09 10:32:05 +02001927}
1928
Jeff King4574f1a2018-06-28 18:05:24 -04001929int git_config_from_mem(config_fn_t fn,
1930 const enum config_origin_type origin_type,
1931 const char *name, const char *buf, size_t len,
Glen Choo809d8682023-06-28 19:26:24 +00001932 void *data, enum config_scope scope,
1933 const struct config_options *opts)
Heiko Voigt1bc88812013-07-12 00:46:47 +02001934{
Glen Chooc009bc82023-03-28 17:51:48 +00001935 struct config_source top = CONFIG_SOURCE_INIT;
Heiko Voigt1bc88812013-07-12 00:46:47 +02001936
1937 top.u.buf.buf = buf;
1938 top.u.buf.len = len;
1939 top.u.buf.pos = 0;
Lars Schneider473166b2016-02-19 10:16:01 +01001940 top.origin_type = origin_type;
Heiko Voigt1bc88812013-07-12 00:46:47 +02001941 top.name = name;
Jeff Kingd14d4242014-02-19 00:58:52 +02001942 top.path = NULL;
Jeff King66f97222018-06-28 18:05:00 -04001943 top.default_error_action = CONFIG_ERROR_ERROR;
Jeff King49d6cfa2013-08-26 17:57:18 -04001944 top.do_fgetc = config_buf_fgetc;
1945 top.do_ungetc = config_buf_ungetc;
1946 top.do_ftell = config_buf_ftell;
Heiko Voigt1bc88812013-07-12 00:46:47 +02001947
Glen Choo6e8e7982023-06-28 19:26:30 +00001948 return do_config_from(&top, fn, data, scope, opts);
Heiko Voigt1bc88812013-07-12 00:46:47 +02001949}
1950
brian m. carlsoncd73de42017-07-13 23:49:20 +00001951int git_config_from_blob_oid(config_fn_t fn,
Brandon Williams9ebf6892016-12-16 11:03:18 -08001952 const char *name,
Jonathan Tane3e8bf02021-08-16 14:09:57 -07001953 struct repository *repo,
brian m. carlsoncd73de42017-07-13 23:49:20 +00001954 const struct object_id *oid,
Glen Choo809d8682023-06-28 19:26:24 +00001955 void *data,
1956 enum config_scope scope)
Heiko Voigt1bc88812013-07-12 00:46:47 +02001957{
1958 enum object_type type;
1959 char *buf;
1960 unsigned long size;
1961 int ret;
1962
Jonathan Tane3e8bf02021-08-16 14:09:57 -07001963 buf = repo_read_object_file(repo, oid, &type, &size);
Heiko Voigt1bc88812013-07-12 00:46:47 +02001964 if (!buf)
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02001965 return error(_("unable to load config blob object '%s'"), name);
Heiko Voigt1bc88812013-07-12 00:46:47 +02001966 if (type != OBJ_BLOB) {
1967 free(buf);
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02001968 return error(_("reference '%s' does not point to a blob"), name);
Heiko Voigt1bc88812013-07-12 00:46:47 +02001969 }
1970
Jeff King4574f1a2018-06-28 18:05:24 -04001971 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
Glen Choo809d8682023-06-28 19:26:24 +00001972 data, scope, NULL);
Heiko Voigt1bc88812013-07-12 00:46:47 +02001973 free(buf);
1974
1975 return ret;
1976}
1977
1978static int git_config_from_blob_ref(config_fn_t fn,
Jonathan Tane3e8bf02021-08-16 14:09:57 -07001979 struct repository *repo,
Heiko Voigt1bc88812013-07-12 00:46:47 +02001980 const char *name,
Glen Choo809d8682023-06-28 19:26:24 +00001981 void *data,
1982 enum config_scope scope)
Heiko Voigt1bc88812013-07-12 00:46:47 +02001983{
brian m. carlsoncd73de42017-07-13 23:49:20 +00001984 struct object_id oid;
Heiko Voigt1bc88812013-07-12 00:46:47 +02001985
Jonathan Tane3e8bf02021-08-16 14:09:57 -07001986 if (repo_get_oid(repo, name, &oid) < 0)
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02001987 return error(_("unable to resolve config blob '%s'"), name);
Glen Choo809d8682023-06-28 19:26:24 +00001988 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
Heiko Voigt1bc88812013-07-12 00:46:47 +02001989}
1990
Patrick Steinhardtc62a9992021-04-19 14:31:08 +02001991char *git_system_config(void)
Johannes Sixt506b17b2007-11-13 21:05:05 +01001992{
Patrick Steinhardt4179b482021-04-19 14:31:16 +02001993 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
Johannes Schindeline3553072021-06-22 10:46:48 +00001994 if (!system_config)
1995 system_config = system_path(ETC_GITCONFIG);
1996 normalize_path_copy(system_config, system_config);
1997 return system_config;
Johannes Sixt506b17b2007-11-13 21:05:05 +01001998}
1999
Kristoffer Haugsbakkc15129b2024-01-18 17:12:51 +01002000char *git_global_config(void)
2001{
2002 char *user_config, *xdg_config;
2003
2004 git_global_config_paths(&user_config, &xdg_config);
2005 if (!user_config) {
2006 free(xdg_config);
2007 return NULL;
2008 }
2009
2010 if (access_or_warn(user_config, R_OK, 0) && xdg_config &&
2011 !access_or_warn(xdg_config, R_OK, 0)) {
2012 free(user_config);
2013 return xdg_config;
2014 } else {
2015 free(xdg_config);
2016 return user_config;
2017 }
2018}
2019
Kristoffer Haugsbakkecffa3e2024-01-18 17:12:50 +01002020void git_global_config_paths(char **user_out, char **xdg_out)
Patrick Steinhardt1e06eb92021-04-19 14:31:12 +02002021{
Patrick Steinhardt4179b482021-04-19 14:31:16 +02002022 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2023 char *xdg_config = NULL;
2024
2025 if (!user_config) {
Johannes Schindelina03b0972021-07-24 22:06:52 +00002026 user_config = interpolate_path("~/.gitconfig", 0);
Patrick Steinhardt4179b482021-04-19 14:31:16 +02002027 xdg_config = xdg_config_home("config");
2028 }
2029
2030 *user_out = user_config;
2031 *xdg_out = xdg_config;
Linus Torvalds17712992005-10-10 16:31:08 -07002032}
Johannes Schindelin10bea152005-11-17 22:32:36 +01002033
Jeff Kingab88c362008-02-06 05:11:18 -05002034int git_config_system(void)
2035{
2036 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2037}
2038
Glen Choo6e8e7982023-06-28 19:26:30 +00002039static int do_git_config_sequence(const struct config_options *opts,
Victoria Dye3867f6d2023-05-26 01:33:00 +00002040 const struct repository *repo,
Nguyễn Thái Ngọc Duye145a0b2017-04-17 17:10:02 +07002041 config_fn_t fn, void *data)
Junio C Hamano4f629532005-11-25 16:03:56 -08002042{
Jeff Kingc72ee442016-05-18 18:39:02 -04002043 int ret = 0;
Patrick Steinhardtc62a9992021-04-19 14:31:08 +02002044 char *system_config = git_system_config();
Patrick Steinhardt1e06eb92021-04-19 14:31:12 +02002045 char *xdg_config = NULL;
2046 char *user_config = NULL;
Nguyễn Thái Ngọc Duye145a0b2017-04-17 17:10:02 +07002047 char *repo_config;
Victoria Dye847d0022023-05-26 01:32:58 +00002048 char *worktree_config;
Nguyễn Thái Ngọc Duye145a0b2017-04-17 17:10:02 +07002049
Victoria Dye847d0022023-05-26 01:32:58 +00002050 /*
2051 * Ensure that either:
2052 * - the git_dir and commondir are both set, or
2053 * - the git_dir and commondir are both NULL
2054 */
2055 if (!opts->git_dir != !opts->commondir)
2056 BUG("only one of commondir and git_dir is non-NULL");
2057
2058 if (opts->commondir) {
Brandon Williamsa577fb52017-06-14 11:07:38 -07002059 repo_config = mkpathdup("%s/config", opts->commondir);
Victoria Dye847d0022023-05-26 01:32:58 +00002060 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2061 } else {
Nguyễn Thái Ngọc Duye145a0b2017-04-17 17:10:02 +07002062 repo_config = NULL;
Victoria Dye847d0022023-05-26 01:32:58 +00002063 worktree_config = NULL;
2064 }
Johannes Schindelin5f1a63e2006-06-20 01:48:03 +02002065
Patrick Steinhardtc62a9992021-04-19 14:31:08 +02002066 if (git_config_system() && system_config &&
2067 !access_or_die(system_config, R_OK,
2068 opts->system_gently ? ACCESS_EACCES_OK : 0))
Glen Choo809d8682023-06-28 19:26:24 +00002069 ret += git_config_from_file_with_options(fn, system_config,
2070 data, CONFIG_SCOPE_SYSTEM,
2071 NULL);
Johannes Schindelin5f1a63e2006-06-20 01:48:03 +02002072
Kristoffer Haugsbakkecffa3e2024-01-18 17:12:50 +01002073 git_global_config_paths(&user_config, &xdg_config);
Patrick Steinhardt1e06eb92021-04-19 14:31:12 +02002074
Jeff Kingc72ee442016-05-18 18:39:02 -04002075 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
Glen Choo809d8682023-06-28 19:26:24 +00002076 ret += git_config_from_file_with_options(fn, xdg_config, data,
2077 CONFIG_SCOPE_GLOBAL, NULL);
Huynh Khoi Nguyen Nguyen21cf3222012-06-22 11:03:23 +02002078
Jeff Kingc72ee442016-05-18 18:39:02 -04002079 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
Glen Choo809d8682023-06-28 19:26:24 +00002080 ret += git_config_from_file_with_options(fn, user_config, data,
2081 CONFIG_SCOPE_GLOBAL, NULL);
Johannes Schindelin5f1a63e2006-06-20 01:48:03 +02002082
Jeff Hostetler800a7f92019-04-15 13:39:46 -07002083 if (!opts->ignore_repo && repo_config &&
2084 !access_or_die(repo_config, R_OK, 0))
Glen Choo809d8682023-06-28 19:26:24 +00002085 ret += git_config_from_file_with_options(fn, repo_config, data,
2086 CONFIG_SCOPE_LOCAL, NULL);
Alex Riesen8b1fa772010-03-26 23:53:57 +01002087
Victoria Dye847d0022023-05-26 01:32:58 +00002088 if (!opts->ignore_worktree && worktree_config &&
Victoria Dye3867f6d2023-05-26 01:33:00 +00002089 repo && repo->repository_format_worktree_config &&
Victoria Dye847d0022023-05-26 01:32:58 +00002090 !access_or_die(worktree_config, R_OK, 0)) {
Glen Choo809d8682023-06-28 19:26:24 +00002091 ret += git_config_from_file_with_options(fn, worktree_config, data,
2092 CONFIG_SCOPE_WORKTREE,
2093 NULL);
Nguyễn Thái Ngọc Duy58b284a2018-10-21 16:02:28 +02002094 }
2095
Jeff Hostetler800a7f92019-04-15 13:39:46 -07002096 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
Matthieu Moy8262aaa2014-08-07 04:59:12 -07002097 die(_("unable to parse command-line config"));
Alex Riesen8b1fa772010-03-26 23:53:57 +01002098
Patrick Steinhardtc62a9992021-04-19 14:31:08 +02002099 free(system_config);
Huynh Khoi Nguyen Nguyen21cf3222012-06-22 11:03:23 +02002100 free(xdg_config);
2101 free(user_config);
Jeff King80181862016-03-11 17:37:03 -05002102 free(repo_config);
Victoria Dye847d0022023-05-26 01:32:58 +00002103 free(worktree_config);
Jeff Kingc72ee442016-05-18 18:39:02 -04002104 return ret;
Junio C Hamano4f629532005-11-25 16:03:56 -08002105}
2106
Brandon Williamsdc8441f2017-06-14 11:07:39 -07002107int config_with_options(config_fn_t fn, void *data,
2108 struct git_config_source *config_source,
Victoria Dye9b6b06c2023-05-26 01:32:59 +00002109 struct repository *repo,
Brandon Williamsdc8441f2017-06-14 11:07:39 -07002110 const struct config_options *opts)
Nguyễn Thái Ngọc Duydbdf5852010-11-26 22:32:33 +07002111{
Jeff King9b25a0b2012-02-06 04:54:04 -05002112 struct config_include_data inc = CONFIG_INCLUDE_INIT;
Jonathan Tan399b1982022-01-18 09:47:40 -08002113 int ret;
Jeff King9b25a0b2012-02-06 04:54:04 -05002114
Nguyễn Thái Ngọc Duyc48f4b32017-04-17 17:10:00 +07002115 if (opts->respect_includes) {
Jeff King9b25a0b2012-02-06 04:54:04 -05002116 inc.fn = fn;
2117 inc.data = data;
Nguyễn Thái Ngọc Duyc48f4b32017-04-17 17:10:00 +07002118 inc.opts = opts;
Victoria Dye9b6b06c2023-05-26 01:32:59 +00002119 inc.repo = repo;
Jonathan Tan399b1982022-01-18 09:47:40 -08002120 inc.config_source = config_source;
Jeff King9b25a0b2012-02-06 04:54:04 -05002121 fn = git_config_include;
2122 data = &inc;
2123 }
Nguyễn Thái Ngọc Duydbdf5852010-11-26 22:32:33 +07002124
Jeff Kingc9b5e2a2012-02-16 03:05:56 -05002125 /*
2126 * If we have a specific filename, use it. Otherwise, follow the
2127 * regular lookup sequence.
2128 */
Jonathan Tane3e8bf02021-08-16 14:09:57 -07002129 if (config_source && config_source->use_stdin) {
Glen Choo809d8682023-06-28 19:26:24 +00002130 ret = git_config_from_stdin(fn, data, config_source->scope);
Jonathan Tane3e8bf02021-08-16 14:09:57 -07002131 } else if (config_source && config_source->file) {
Glen Choo809d8682023-06-28 19:26:24 +00002132 ret = git_config_from_file_with_options(fn, config_source->file,
2133 data, config_source->scope,
2134 NULL);
Jonathan Tane3e8bf02021-08-16 14:09:57 -07002135 } else if (config_source && config_source->blob) {
Jonathan Tan399b1982022-01-18 09:47:40 -08002136 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
Glen Choo809d8682023-06-28 19:26:24 +00002137 data, config_source->scope);
Jonathan Tan399b1982022-01-18 09:47:40 -08002138 } else {
Glen Choo6e8e7982023-06-28 19:26:30 +00002139 ret = do_git_config_sequence(opts, repo, fn, data);
Jonathan Tane3e8bf02021-08-16 14:09:57 -07002140 }
Jeff Kingc9b5e2a2012-02-16 03:05:56 -05002141
Jonathan Tan399b1982022-01-18 09:47:40 -08002142 if (inc.remote_urls) {
2143 string_list_clear(inc.remote_urls, 0);
2144 FREE_AND_NULL(inc.remote_urls);
2145 }
2146 return ret;
Nguyễn Thái Ngọc Duydbdf5852010-11-26 22:32:33 +07002147}
2148
Glen Choof6c213a2023-06-28 19:26:28 +00002149static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
Tanay Abhra155ef252014-08-07 04:59:17 -07002150{
2151 int i, value_index;
2152 struct string_list *values;
2153 struct config_set_element *entry;
Glen Choo9b4a6552023-03-28 17:51:54 +00002154 struct configset_list *list = &set->list;
Glen Choo6021e1d2023-06-28 19:26:23 +00002155 struct config_context ctx = CONFIG_CONTEXT_INIT;
Tanay Abhra155ef252014-08-07 04:59:17 -07002156
2157 for (i = 0; i < list->nr; i++) {
2158 entry = list->items[i].e;
2159 value_index = list->items[i].value_index;
2160 values = &entry->value_list;
Jeff King0d44a2d2016-05-26 20:32:23 -04002161
Glen Choo6021e1d2023-06-28 19:26:23 +00002162 ctx.kvi = values->items[value_index].util;
2163 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
Jeff King0d44a2d2016-05-26 20:32:23 -04002164 git_die_config_linenr(entry->key,
Glen Choo6021e1d2023-06-28 19:26:23 +00002165 ctx.kvi->filename,
2166 ctx.kvi->linenr);
Tanay Abhra155ef252014-08-07 04:59:17 -07002167 }
2168}
2169
Johannes Schindelin0654aa52017-03-13 21:11:04 +01002170void read_early_config(config_fn_t cb, void *data)
2171{
Nguyễn Thái Ngọc Duyc48f4b32017-04-17 17:10:00 +07002172 struct config_options opts = {0};
Brandon Williamsd3fb71b2017-06-14 11:07:37 -07002173 struct strbuf commondir = STRBUF_INIT;
2174 struct strbuf gitdir = STRBUF_INIT;
Johannes Schindelin1a274092017-03-13 21:11:12 +01002175
Nguyễn Thái Ngọc Duyc48f4b32017-04-17 17:10:00 +07002176 opts.respect_includes = 1;
Johannes Schindelin0654aa52017-03-13 21:11:04 +01002177
Brandon Williamsa577fb52017-06-14 11:07:38 -07002178 if (have_git_dir()) {
2179 opts.commondir = get_git_common_dir();
Nguyễn Thái Ngọc Duy2185fde2017-04-17 17:10:01 +07002180 opts.git_dir = get_git_dir();
Johannes Schindelin0654aa52017-03-13 21:11:04 +01002181 /*
Johannes Schindelin1a274092017-03-13 21:11:12 +01002182 * When setup_git_directory() was not yet asked to discover the
2183 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2184 * is any repository config we should use (but unlike
2185 * setup_git_directory_gently(), no global state is changed, most
2186 * notably, the current working directory is still the same after the
2187 * call).
Johannes Schindelin0654aa52017-03-13 21:11:04 +01002188 */
Brandon Williamsa577fb52017-06-14 11:07:38 -07002189 } else if (!discover_git_directory(&commondir, &gitdir)) {
2190 opts.commondir = commondir.buf;
Brandon Williamsd3fb71b2017-06-14 11:07:37 -07002191 opts.git_dir = gitdir.buf;
Brandon Williamsa577fb52017-06-14 11:07:38 -07002192 }
Johannes Schindelin0654aa52017-03-13 21:11:04 +01002193
Victoria Dye9b6b06c2023-05-26 01:32:59 +00002194 config_with_options(cb, data, NULL, NULL, &opts);
Nguyễn Thái Ngọc Duy2185fde2017-04-17 17:10:01 +07002195
Brandon Williamsd3fb71b2017-06-14 11:07:37 -07002196 strbuf_release(&commondir);
2197 strbuf_release(&gitdir);
Johannes Schindelin0654aa52017-03-13 21:11:04 +01002198}
2199
Jeff Hostetler800a7f92019-04-15 13:39:46 -07002200/*
2201 * Read config but only enumerate system and global settings.
2202 * Omit any repo-local, worktree-local, or command-line settings.
2203 */
2204void read_very_early_config(config_fn_t cb, void *data)
2205{
2206 struct config_options opts = { 0 };
2207
2208 opts.respect_includes = 1;
2209 opts.ignore_repo = 1;
2210 opts.ignore_worktree = 1;
2211 opts.ignore_cmdline = 1;
Jeff Hostetlerf672dee2019-04-29 13:14:22 -07002212 opts.system_gently = 1;
Jeff Hostetler800a7f92019-04-15 13:39:46 -07002213
Victoria Dye9b6b06c2023-05-26 01:32:59 +00002214 config_with_options(cb, data, NULL, NULL, &opts);
Jeff Hostetler800a7f92019-04-15 13:39:46 -07002215}
2216
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002217RESULT_MUST_BE_USED
Junio C Hamano06e9e722023-04-06 13:38:29 -07002218static int configset_find_element(struct config_set *set, const char *key,
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002219 struct config_set_element **dest)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002220{
2221 struct config_set_element k;
2222 struct config_set_element *found_entry;
2223 char *normalized_key;
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002224 int ret;
2225
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002226 /*
2227 * `key` may come from the user, so normalize it before using it
2228 * for querying entries from the hashmap.
2229 */
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002230 ret = git_config_parse_key(key, &normalized_key, NULL);
2231 if (ret)
2232 return ret;
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002233
Eric Wongd22245a2019-10-06 23:30:27 +00002234 hashmap_entry_init(&k.ent, strhash(normalized_key));
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002235 k.key = normalized_key;
Glen Choo9b4a6552023-03-28 17:51:54 +00002236 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002237 free(normalized_key);
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002238 *dest = found_entry;
2239 return 0;
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002240}
2241
Glen Choo26b66932023-06-28 19:26:25 +00002242static int configset_add_value(const struct key_value_info *kvi_p,
Glen Choo9b4a6552023-03-28 17:51:54 +00002243 struct config_set *set, const char *key,
Glen Chooa798a562023-03-28 17:51:50 +00002244 const char *value)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002245{
2246 struct config_set_element *e;
Tanay Abhra3df8fd62014-08-07 04:59:14 -07002247 struct string_list_item *si;
Tanay Abhra155ef252014-08-07 04:59:17 -07002248 struct configset_list_item *l_item;
Tanay Abhra3df8fd62014-08-07 04:59:14 -07002249 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002250 int ret;
Tanay Abhra3df8fd62014-08-07 04:59:14 -07002251
Junio C Hamano06e9e722023-04-06 13:38:29 -07002252 ret = configset_find_element(set, key, &e);
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002253 if (ret)
2254 return ret;
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002255 /*
2256 * Since the keys are being fed by git_config*() callback mechanism, they
2257 * are already normalized. So simply add them without any further munging.
2258 */
2259 if (!e) {
2260 e = xmalloc(sizeof(*e));
Eric Wongd22245a2019-10-06 23:30:27 +00002261 hashmap_entry_init(&e->ent, strhash(key));
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002262 e->key = xstrdup(key);
Ævar Arnfjörð Bjarmasonbc40dfb2021-07-01 12:51:29 +02002263 string_list_init_dup(&e->value_list);
Glen Choo9b4a6552023-03-28 17:51:54 +00002264 hashmap_add(&set->config_hash, &e->ent);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002265 }
Jeff King8c53f072015-01-12 20:59:09 -05002266 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
Tanay Abhra155ef252014-08-07 04:59:17 -07002267
Glen Choo9b4a6552023-03-28 17:51:54 +00002268 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2269 l_item = &set->list.items[set->list.nr++];
Tanay Abhra155ef252014-08-07 04:59:17 -07002270 l_item->e = e;
2271 l_item->value_index = e->value_list.nr - 1;
2272
Glen Choof6c213a2023-06-28 19:26:28 +00002273 *kv_info = *kvi_p;
Tanay Abhra3df8fd62014-08-07 04:59:14 -07002274 si->util = kv_info;
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002275
2276 return 0;
2277}
2278
Ævar Arnfjörð Bjarmason5cf88fd2022-08-25 19:09:48 +02002279static int config_set_element_cmp(const void *cmp_data UNUSED,
Eric Wong939af162019-10-06 23:30:37 +00002280 const struct hashmap_entry *eptr,
2281 const struct hashmap_entry *entry_or_key,
Ævar Arnfjörð Bjarmason5cf88fd2022-08-25 19:09:48 +02002282 const void *keydata UNUSED)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002283{
Eric Wong939af162019-10-06 23:30:37 +00002284 const struct config_set_element *e1, *e2;
2285
2286 e1 = container_of(eptr, const struct config_set_element, ent);
2287 e2 = container_of(entry_or_key, const struct config_set_element, ent);
Stefan Beller77bdc092017-06-30 17:28:32 -07002288
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002289 return strcmp(e1->key, e2->key);
2290}
2291
Glen Choo9b4a6552023-03-28 17:51:54 +00002292void git_configset_init(struct config_set *set)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002293{
Glen Choo9b4a6552023-03-28 17:51:54 +00002294 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2295 set->hash_initialized = 1;
2296 set->list.nr = 0;
2297 set->list.alloc = 0;
2298 set->list.items = NULL;
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002299}
2300
Glen Choo9b4a6552023-03-28 17:51:54 +00002301void git_configset_clear(struct config_set *set)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002302{
2303 struct config_set_element *entry;
2304 struct hashmap_iter iter;
Glen Choo9b4a6552023-03-28 17:51:54 +00002305 if (!set->hash_initialized)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002306 return;
2307
Glen Choo9b4a6552023-03-28 17:51:54 +00002308 hashmap_for_each_entry(&set->config_hash, &iter, entry,
Eric Wong87571c32019-10-06 23:30:38 +00002309 ent /* member name */) {
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002310 free(entry->key);
Tanay Abhra3df8fd62014-08-07 04:59:14 -07002311 string_list_clear(&entry->value_list, 1);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002312 }
Glen Choo9b4a6552023-03-28 17:51:54 +00002313 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2314 set->hash_initialized = 0;
2315 free(set->list.items);
2316 set->list.nr = 0;
2317 set->list.alloc = 0;
2318 set->list.items = NULL;
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002319}
2320
Glen Chooa4e7e312023-06-28 19:26:22 +00002321static int config_set_callback(const char *key, const char *value,
Glen Choo26b66932023-06-28 19:26:25 +00002322 const struct config_context *ctx,
Glen Chooa4e7e312023-06-28 19:26:22 +00002323 void *cb)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002324{
Glen Choof6c213a2023-06-28 19:26:28 +00002325 struct config_set *set = cb;
2326 configset_add_value(ctx->kvi, set, key, value);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002327 return 0;
2328}
2329
Glen Choo9b4a6552023-03-28 17:51:54 +00002330int git_configset_add_file(struct config_set *set, const char *filename)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002331{
Glen Choof6c213a2023-06-28 19:26:28 +00002332 return git_config_from_file(config_set_callback, filename, set);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002333}
2334
Glen Choo8868b1e2023-06-28 19:26:27 +00002335int git_configset_get_value(struct config_set *set, const char *key,
2336 const char **value, struct key_value_info *kvi)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002337{
2338 const struct string_list *values = NULL;
Ævar Arnfjörð Bjarmasona4286192023-03-28 16:04:24 +02002339 int ret;
Glen Choo8868b1e2023-06-28 19:26:27 +00002340 struct string_list_item item;
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002341 /*
2342 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2343 * queried key in the files of the configset, the value returned will be the last
2344 * value in the value list for that key.
2345 */
Junio C Hamano06e9e722023-04-06 13:38:29 -07002346 if ((ret = git_configset_get_value_multi(set, key, &values)))
Ævar Arnfjörð Bjarmasona4286192023-03-28 16:04:24 +02002347 return ret;
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002348
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002349 assert(values->nr > 0);
Glen Choo8868b1e2023-06-28 19:26:27 +00002350 item = values->items[values->nr - 1];
2351 *value = item.string;
2352 if (kvi)
2353 *kvi = *((struct key_value_info *)item.util);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002354 return 0;
2355}
2356
Junio C Hamano06e9e722023-04-06 13:38:29 -07002357int git_configset_get_value_multi(struct config_set *set, const char *key,
Ævar Arnfjörð Bjarmasona4286192023-03-28 16:04:24 +02002358 const struct string_list **dest)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002359{
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002360 struct config_set_element *e;
Ævar Arnfjörð Bjarmasona4286192023-03-28 16:04:24 +02002361 int ret;
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002362
Junio C Hamano06e9e722023-04-06 13:38:29 -07002363 if ((ret = configset_find_element(set, key, &e)))
Ævar Arnfjörð Bjarmasona4286192023-03-28 16:04:24 +02002364 return ret;
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002365 else if (!e)
Ævar Arnfjörð Bjarmasona4286192023-03-28 16:04:24 +02002366 return 1;
2367 *dest = &e->value_list;
2368
2369 return 0;
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002370}
2371
Ævar Arnfjörð Bjarmason9e2d8842023-03-28 16:04:27 +02002372static int check_multi_string(struct string_list_item *item, void *util)
2373{
2374 return item->string ? 0 : config_error_nonbool(util);
2375}
2376
2377int git_configset_get_string_multi(struct config_set *cs, const char *key,
2378 const struct string_list **dest)
2379{
2380 int ret;
2381
2382 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2383 return ret;
2384 if ((ret = for_each_string_list((struct string_list *)*dest,
2385 check_multi_string, (void *)key)))
2386 return ret;
2387
2388 return 0;
2389}
2390
Junio C Hamano06e9e722023-04-06 13:38:29 -07002391int git_configset_get(struct config_set *set, const char *key)
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002392{
2393 struct config_set_element *e;
2394 int ret;
2395
Junio C Hamano06e9e722023-04-06 13:38:29 -07002396 if ((ret = configset_find_element(set, key, &e)))
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002397 return ret;
2398 else if (!e)
2399 return 1;
2400 return 0;
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002401}
2402
Glen Choo9b4a6552023-03-28 17:51:54 +00002403int git_configset_get_string(struct config_set *set, const char *key, char **dest)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002404{
2405 const char *value;
Glen Choo8868b1e2023-06-28 19:26:27 +00002406 if (!git_configset_get_value(set, key, &value, NULL))
Jeff King9a532192020-08-17 17:33:11 -04002407 return git_config_string((const char **)dest, key, value);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002408 else
2409 return 1;
2410}
2411
Glen Choo9b4a6552023-03-28 17:51:54 +00002412static int git_configset_get_string_tmp(struct config_set *set, const char *key,
Derrick Stolee3ce11382022-02-07 21:33:03 +00002413 const char **dest)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002414{
Jeff Kingf1de9812020-08-14 12:17:36 -04002415 const char *value;
Glen Choo8868b1e2023-06-28 19:26:27 +00002416 if (!git_configset_get_value(set, key, &value, NULL)) {
Jeff Kingf1de9812020-08-14 12:17:36 -04002417 if (!value)
2418 return config_error_nonbool(key);
2419 *dest = value;
2420 return 0;
2421 } else {
2422 return 1;
2423 }
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002424}
2425
Glen Choo9b4a6552023-03-28 17:51:54 +00002426int git_configset_get_int(struct config_set *set, const char *key, int *dest)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002427{
2428 const char *value;
Glen Choo8868b1e2023-06-28 19:26:27 +00002429 struct key_value_info kvi;
2430
2431 if (!git_configset_get_value(set, key, &value, &kvi)) {
2432 *dest = git_config_int(key, value, &kvi);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002433 return 0;
2434 } else
2435 return 1;
2436}
2437
Glen Choo9b4a6552023-03-28 17:51:54 +00002438int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002439{
2440 const char *value;
Glen Choo8868b1e2023-06-28 19:26:27 +00002441 struct key_value_info kvi;
2442
2443 if (!git_configset_get_value(set, key, &value, &kvi)) {
2444 *dest = git_config_ulong(key, value, &kvi);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002445 return 0;
2446 } else
2447 return 1;
2448}
2449
Glen Choo9b4a6552023-03-28 17:51:54 +00002450int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002451{
2452 const char *value;
Glen Choo8868b1e2023-06-28 19:26:27 +00002453 if (!git_configset_get_value(set, key, &value, NULL)) {
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002454 *dest = git_config_bool(key, value);
2455 return 0;
2456 } else
2457 return 1;
2458}
2459
Glen Choo9b4a6552023-03-28 17:51:54 +00002460int git_configset_get_bool_or_int(struct config_set *set, const char *key,
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002461 int *is_bool, int *dest)
2462{
2463 const char *value;
Glen Choo8868b1e2023-06-28 19:26:27 +00002464 struct key_value_info kvi;
2465
2466 if (!git_configset_get_value(set, key, &value, &kvi)) {
2467 *dest = git_config_bool_or_int(key, value, &kvi, is_bool);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002468 return 0;
2469 } else
2470 return 1;
2471}
2472
Glen Choo9b4a6552023-03-28 17:51:54 +00002473int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002474{
2475 const char *value;
Glen Choo8868b1e2023-06-28 19:26:27 +00002476 if (!git_configset_get_value(set, key, &value, NULL)) {
Martin Ågren89576612017-08-07 20:20:49 +02002477 *dest = git_parse_maybe_bool(value);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002478 if (*dest == -1)
2479 return -1;
2480 return 0;
2481 } else
2482 return 1;
2483}
2484
Glen Choo9b4a6552023-03-28 17:51:54 +00002485int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002486{
2487 const char *value;
Glen Choo8868b1e2023-06-28 19:26:27 +00002488 if (!git_configset_get_value(set, key, &value, NULL))
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002489 return git_config_pathname(dest, key, value);
2490 else
2491 return 1;
2492}
2493
Brandon Williams3b256222017-06-22 11:43:42 -07002494/* Functions use to read configuration from a repository */
2495static void repo_read_config(struct repository *repo)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002496{
Jeff Hostetler17037512019-04-15 13:39:42 -07002497 struct config_options opts = { 0 };
Brandon Williams3b256222017-06-22 11:43:42 -07002498
2499 opts.respect_includes = 1;
2500 opts.commondir = repo->commondir;
2501 opts.git_dir = repo->gitdir;
2502
2503 if (!repo->config)
René Scharfeca56dad2021-03-13 17:17:22 +01002504 CALLOC_ARRAY(repo->config, 1);
Brandon Williams3b256222017-06-22 11:43:42 -07002505 else
2506 git_configset_clear(repo->config);
2507
2508 git_configset_init(repo->config);
Glen Choof6c213a2023-06-28 19:26:28 +00002509 if (config_with_options(config_set_callback, repo->config, NULL,
2510 repo, &opts) < 0)
Brandon Williams3b256222017-06-22 11:43:42 -07002511 /*
2512 * config_with_options() normally returns only
2513 * zero, as most errors are fatal, and
2514 * non-fatal potential errors are guarded by "if"
2515 * statements that are entered only when no error is
2516 * possible.
2517 *
2518 * If we ever encounter a non-fatal error, it means
2519 * something went really wrong and we should stop
2520 * immediately.
2521 */
2522 die(_("unknown error occurred while reading the configuration files"));
2523}
2524
2525static void git_config_check_init(struct repository *repo)
2526{
2527 if (repo->config && repo->config->hash_initialized)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002528 return;
Brandon Williams3b256222017-06-22 11:43:42 -07002529 repo_read_config(repo);
2530}
2531
2532static void repo_config_clear(struct repository *repo)
2533{
2534 if (!repo->config || !repo->config->hash_initialized)
2535 return;
2536 git_configset_clear(repo->config);
2537}
2538
2539void repo_config(struct repository *repo, config_fn_t fn, void *data)
2540{
2541 git_config_check_init(repo);
Glen Choof6c213a2023-06-28 19:26:28 +00002542 configset_iter(repo->config, fn, data);
Brandon Williams3b256222017-06-22 11:43:42 -07002543}
2544
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002545int repo_config_get(struct repository *repo, const char *key)
2546{
2547 git_config_check_init(repo);
2548 return git_configset_get(repo->config, key);
2549}
2550
Brandon Williams3b256222017-06-22 11:43:42 -07002551int repo_config_get_value(struct repository *repo,
2552 const char *key, const char **value)
2553{
2554 git_config_check_init(repo);
Glen Choo8868b1e2023-06-28 19:26:27 +00002555 return git_configset_get_value(repo->config, key, value, NULL);
Brandon Williams3b256222017-06-22 11:43:42 -07002556}
2557
Ævar Arnfjörð Bjarmasona4286192023-03-28 16:04:24 +02002558int repo_config_get_value_multi(struct repository *repo, const char *key,
2559 const struct string_list **dest)
Brandon Williams3b256222017-06-22 11:43:42 -07002560{
2561 git_config_check_init(repo);
Ævar Arnfjörð Bjarmasona4286192023-03-28 16:04:24 +02002562 return git_configset_get_value_multi(repo->config, key, dest);
Brandon Williams3b256222017-06-22 11:43:42 -07002563}
2564
Ævar Arnfjörð Bjarmason9e2d8842023-03-28 16:04:27 +02002565int repo_config_get_string_multi(struct repository *repo, const char *key,
2566 const struct string_list **dest)
2567{
2568 git_config_check_init(repo);
2569 return git_configset_get_string_multi(repo->config, key, dest);
Brandon Williams3b256222017-06-22 11:43:42 -07002570}
2571
Brandon Williams3b256222017-06-22 11:43:42 -07002572int repo_config_get_string(struct repository *repo,
2573 const char *key, char **dest)
Brandon Williams3b256222017-06-22 11:43:42 -07002574{
2575 int ret;
2576 git_config_check_init(repo);
Jeff King9a532192020-08-17 17:33:11 -04002577 ret = git_configset_get_string(repo->config, key, dest);
Brandon Williams3b256222017-06-22 11:43:42 -07002578 if (ret < 0)
2579 git_die_config(key, NULL);
2580 return ret;
2581}
2582
Jeff Kingf1de9812020-08-14 12:17:36 -04002583int repo_config_get_string_tmp(struct repository *repo,
2584 const char *key, const char **dest)
Brandon Williams3b256222017-06-22 11:43:42 -07002585{
Jeff Kingf1de9812020-08-14 12:17:36 -04002586 int ret;
Brandon Williams3b256222017-06-22 11:43:42 -07002587 git_config_check_init(repo);
Jeff Kingf1de9812020-08-14 12:17:36 -04002588 ret = git_configset_get_string_tmp(repo->config, key, dest);
2589 if (ret < 0)
2590 git_die_config(key, NULL);
2591 return ret;
Brandon Williams3b256222017-06-22 11:43:42 -07002592}
2593
2594int repo_config_get_int(struct repository *repo,
2595 const char *key, int *dest)
2596{
2597 git_config_check_init(repo);
2598 return git_configset_get_int(repo->config, key, dest);
2599}
2600
2601int repo_config_get_ulong(struct repository *repo,
2602 const char *key, unsigned long *dest)
2603{
2604 git_config_check_init(repo);
2605 return git_configset_get_ulong(repo->config, key, dest);
2606}
2607
2608int repo_config_get_bool(struct repository *repo,
2609 const char *key, int *dest)
2610{
2611 git_config_check_init(repo);
2612 return git_configset_get_bool(repo->config, key, dest);
2613}
2614
2615int repo_config_get_bool_or_int(struct repository *repo,
2616 const char *key, int *is_bool, int *dest)
2617{
2618 git_config_check_init(repo);
2619 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2620}
2621
2622int repo_config_get_maybe_bool(struct repository *repo,
2623 const char *key, int *dest)
2624{
2625 git_config_check_init(repo);
2626 return git_configset_get_maybe_bool(repo->config, key, dest);
2627}
2628
2629int repo_config_get_pathname(struct repository *repo,
2630 const char *key, const char **dest)
2631{
2632 int ret;
2633 git_config_check_init(repo);
2634 ret = git_configset_get_pathname(repo->config, key, dest);
2635 if (ret < 0)
2636 git_die_config(key, NULL);
2637 return ret;
2638}
2639
Glen Choo5b3c6502022-07-14 21:27:59 +00002640/* Read values into protected_config. */
2641static void read_protected_config(void)
2642{
Glen Chooecec57b2022-10-13 17:43:47 +00002643 struct config_options opts = {
2644 .respect_includes = 1,
2645 .ignore_repo = 1,
2646 .ignore_worktree = 1,
2647 .system_gently = 1,
2648 };
Glen Chooa798a562023-03-28 17:51:50 +00002649
Glen Choo5b3c6502022-07-14 21:27:59 +00002650 git_configset_init(&protected_config);
Glen Choof6c213a2023-06-28 19:26:28 +00002651 config_with_options(config_set_callback, &protected_config, NULL,
2652 NULL, &opts);
Glen Choo5b3c6502022-07-14 21:27:59 +00002653}
2654
2655void git_protected_config(config_fn_t fn, void *data)
2656{
2657 if (!protected_config.hash_initialized)
2658 read_protected_config();
Glen Choof6c213a2023-06-28 19:26:28 +00002659 configset_iter(&protected_config, fn, data);
Glen Choo5b3c6502022-07-14 21:27:59 +00002660}
2661
Brandon Williams3b256222017-06-22 11:43:42 -07002662/* Functions used historically to read configuration from 'the_repository' */
2663void git_config(config_fn_t fn, void *data)
2664{
2665 repo_config(the_repository, fn, data);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002666}
2667
2668void git_config_clear(void)
2669{
Brandon Williams3b256222017-06-22 11:43:42 -07002670 repo_config_clear(the_repository);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002671}
2672
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 16:04:22 +02002673int git_config_get(const char *key)
2674{
2675 return repo_config_get(the_repository, key);
2676}
2677
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002678int git_config_get_value(const char *key, const char **value)
2679{
Brandon Williams3b256222017-06-22 11:43:42 -07002680 return repo_config_get_value(the_repository, key, value);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002681}
2682
Ævar Arnfjörð Bjarmasona4286192023-03-28 16:04:24 +02002683int git_config_get_value_multi(const char *key, const struct string_list **dest)
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002684{
Ævar Arnfjörð Bjarmasona4286192023-03-28 16:04:24 +02002685 return repo_config_get_value_multi(the_repository, key, dest);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002686}
2687
Ævar Arnfjörð Bjarmason9e2d8842023-03-28 16:04:27 +02002688int git_config_get_string_multi(const char *key,
2689 const struct string_list **dest)
2690{
2691 return repo_config_get_string_multi(the_repository, key, dest);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002692}
2693
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002694int git_config_get_string(const char *key, char **dest)
2695{
Brandon Williams3b256222017-06-22 11:43:42 -07002696 return repo_config_get_string(the_repository, key, dest);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002697}
2698
Jeff Kingf1de9812020-08-14 12:17:36 -04002699int git_config_get_string_tmp(const char *key, const char **dest)
2700{
2701 return repo_config_get_string_tmp(the_repository, key, dest);
2702}
2703
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002704int git_config_get_int(const char *key, int *dest)
2705{
Brandon Williams3b256222017-06-22 11:43:42 -07002706 return repo_config_get_int(the_repository, key, dest);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002707}
2708
2709int git_config_get_ulong(const char *key, unsigned long *dest)
2710{
Brandon Williams3b256222017-06-22 11:43:42 -07002711 return repo_config_get_ulong(the_repository, key, dest);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002712}
2713
2714int git_config_get_bool(const char *key, int *dest)
2715{
Brandon Williams3b256222017-06-22 11:43:42 -07002716 return repo_config_get_bool(the_repository, key, dest);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002717}
2718
2719int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2720{
Brandon Williams3b256222017-06-22 11:43:42 -07002721 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002722}
2723
2724int git_config_get_maybe_bool(const char *key, int *dest)
2725{
Brandon Williams3b256222017-06-22 11:43:42 -07002726 return repo_config_get_maybe_bool(the_repository, key, dest);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002727}
2728
2729int git_config_get_pathname(const char *key, const char **dest)
2730{
Brandon Williams3b256222017-06-22 11:43:42 -07002731 return repo_config_get_pathname(the_repository, key, dest);
Tanay Abhra5a80e972014-08-07 04:59:16 -07002732}
2733
Christian Couder77d67972017-02-27 19:00:13 +01002734int git_config_get_expiry(const char *key, const char **output)
2735{
Jeff King9a532192020-08-17 17:33:11 -04002736 int ret = git_config_get_string(key, (char **)output);
Christian Couder77d67972017-02-27 19:00:13 +01002737 if (ret)
2738 return ret;
2739 if (strcmp(*output, "now")) {
Johannes Schindelindddbad72017-04-26 21:29:31 +02002740 timestamp_t now = approxidate("now");
Christian Couder77d67972017-02-27 19:00:13 +01002741 if (approxidate(*output) >= now)
2742 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2743 }
2744 return ret;
2745}
2746
Junio C Hamano6e96cb52017-08-19 11:43:39 -07002747int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2748{
Jeff King1c890012020-08-17 17:33:13 -04002749 const char *expiry_string;
Junio C Hamano6e96cb52017-08-19 11:43:39 -07002750 intmax_t days;
2751 timestamp_t when;
2752
Jeff King1c890012020-08-17 17:33:13 -04002753 if (git_config_get_string_tmp(key, &expiry_string))
Junio C Hamano6e96cb52017-08-19 11:43:39 -07002754 return 1; /* no such thing */
2755
2756 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2757 const int scale = 86400;
2758 *expiry = now - days * scale;
2759 return 0;
2760 }
2761
2762 if (!parse_expiry_date(expiry_string, &when)) {
2763 *expiry = when;
2764 return 0;
2765 }
2766 return -1; /* thing exists but cannot be parsed */
2767}
2768
Christian Couder1f44b092017-02-27 19:00:00 +01002769int git_config_get_split_index(void)
2770{
2771 int val;
2772
2773 if (!git_config_get_maybe_bool("core.splitindex", &val))
2774 return val;
2775
2776 return -1; /* default value */
2777}
2778
Christian Couder72dcb7b2017-02-27 19:00:07 +01002779int git_config_get_max_percent_split_change(void)
2780{
2781 int val = -1;
2782
2783 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2784 if (0 <= val && val <= 100)
2785 return val;
2786
2787 return error(_("splitIndex.maxPercentChange value '%d' "
2788 "should be between 0 and 100"), val);
2789 }
2790
2791 return -1; /* default value */
2792}
2793
Jonathan Nieder2a9dede2018-11-19 22:14:26 -08002794int git_config_get_index_threads(int *dest)
Ben Peartc780b9c2018-10-10 11:59:35 -04002795{
Jonathan Nieder2a9dede2018-11-19 22:14:26 -08002796 int is_bool, val;
Ben Peartc780b9c2018-10-10 11:59:35 -04002797
2798 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
Jonathan Nieder2a9dede2018-11-19 22:14:26 -08002799 if (val) {
2800 *dest = val;
2801 return 0;
2802 }
Ben Peartc780b9c2018-10-10 11:59:35 -04002803
2804 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2805 if (is_bool)
Jonathan Nieder2a9dede2018-11-19 22:14:26 -08002806 *dest = val ? 0 : 1;
Ben Peartc780b9c2018-10-10 11:59:35 -04002807 else
Jonathan Nieder2a9dede2018-11-19 22:14:26 -08002808 *dest = val;
2809 return 0;
Ben Peartc780b9c2018-10-10 11:59:35 -04002810 }
2811
Jonathan Nieder2a9dede2018-11-19 22:14:26 -08002812 return 1;
Ben Peartc780b9c2018-10-10 11:59:35 -04002813}
2814
Tanay Abhra5a80e972014-08-07 04:59:16 -07002815NORETURN
2816void git_die_config_linenr(const char *key, const char *filename, int linenr)
2817{
2818 if (!filename)
2819 die(_("unable to parse '%s' from command-line config"), key);
2820 else
2821 die(_("bad config variable '%s' in file '%s' at line %d"),
2822 key, filename, linenr);
2823}
2824
2825NORETURN __attribute__((format(printf, 2, 3)))
2826void git_die_config(const char *key, const char *err, ...)
2827{
2828 const struct string_list *values;
2829 struct key_value_info *kv_info;
Ævar Arnfjörð Bjarmasonf5c39c32021-12-07 19:26:34 +01002830 report_fn error_fn = get_error_routine();
Tanay Abhra5a80e972014-08-07 04:59:16 -07002831
2832 if (err) {
2833 va_list params;
2834 va_start(params, err);
Ævar Arnfjörð Bjarmasonf5c39c32021-12-07 19:26:34 +01002835 error_fn(err, params);
Tanay Abhra5a80e972014-08-07 04:59:16 -07002836 va_end(params);
2837 }
Ævar Arnfjörð Bjarmasona4286192023-03-28 16:04:24 +02002838 if (git_config_get_value_multi(key, &values))
2839 BUG("for key '%s' we must have a value to report on", key);
Tanay Abhra5a80e972014-08-07 04:59:16 -07002840 kv_info = values->items[values->nr - 1].util;
2841 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
Tanay Abhra3c8687a2014-07-28 03:10:38 -07002842}
2843
Johannes Schindelin10bea152005-11-17 22:32:36 +01002844/*
2845 * Find all the stuff for git_config_set() below.
2846 */
Johannes Schindelin4ddba792005-11-20 06:52:22 +01002847
Johannes Schindelinfee85722018-04-09 10:32:09 +02002848struct config_store_data {
Jeff Kingf011a962020-04-10 15:46:07 -04002849 size_t baselen;
Felipe Contreras4b25d092009-05-01 12:06:36 +03002850 char *key;
Johannes Schindelinf98d8632005-11-20 13:24:18 +01002851 int do_not_match;
Derrick Stoleec90702a2020-11-25 22:12:54 +00002852 const char *fixed_value;
Derrick Stolee247e2f82020-11-25 22:12:50 +00002853 regex_t *value_pattern;
Johannes Schindelin4ddba792005-11-20 06:52:22 +01002854 int multi_replace;
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002855 struct {
2856 size_t begin, end;
2857 enum config_event_t type;
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02002858 int is_keys_section;
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002859 } *parsed;
2860 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
Johannes Schindelin5221c312018-04-09 10:32:17 +02002861 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
Johannes Schindelinfee85722018-04-09 10:32:09 +02002862};
Glen Chooa798a562023-03-28 17:51:50 +00002863#define CONFIG_STORE_INIT { 0 }
Johannes Schindelin10bea152005-11-17 22:32:36 +01002864
Martin Ågren2a00e592018-05-20 12:42:33 +02002865static void config_store_data_clear(struct config_store_data *store)
2866{
Martin Ågrene7347cb2018-05-20 12:42:35 +02002867 free(store->key);
Derrick Stolee247e2f82020-11-25 22:12:50 +00002868 if (store->value_pattern != NULL &&
2869 store->value_pattern != CONFIG_REGEX_NONE) {
2870 regfree(store->value_pattern);
2871 free(store->value_pattern);
Martin Ågren3b825422018-05-20 12:42:34 +02002872 }
Martin Ågren2a00e592018-05-20 12:42:33 +02002873 free(store->parsed);
2874 free(store->seen);
2875 memset(store, 0, sizeof(*store));
2876}
2877
Johannes Schindelinfee85722018-04-09 10:32:09 +02002878static int matches(const char *key, const char *value,
2879 const struct config_store_data *store)
Johannes Schindelinf98d8632005-11-20 13:24:18 +01002880{
Johannes Schindelinfee85722018-04-09 10:32:09 +02002881 if (strcmp(key, store->key))
Jeff Kingc1063be2014-08-19 02:20:00 -04002882 return 0; /* not ours */
Derrick Stoleec90702a2020-11-25 22:12:54 +00002883 if (store->fixed_value)
2884 return !strcmp(store->fixed_value, value);
Derrick Stolee247e2f82020-11-25 22:12:50 +00002885 if (!store->value_pattern)
Jeff Kingc1063be2014-08-19 02:20:00 -04002886 return 1; /* always matches */
Derrick Stolee247e2f82020-11-25 22:12:50 +00002887 if (store->value_pattern == CONFIG_REGEX_NONE)
Jeff Kingc1063be2014-08-19 02:20:00 -04002888 return 0; /* never matches */
2889
Johannes Schindelinfee85722018-04-09 10:32:09 +02002890 return store->do_not_match ^
Derrick Stolee247e2f82020-11-25 22:12:50 +00002891 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
Johannes Schindelinf98d8632005-11-20 13:24:18 +01002892}
2893
Glen Choo6e8e7982023-06-28 19:26:30 +00002894static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
2895 struct config_source *cs, void *data)
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002896{
2897 struct config_store_data *store = data;
2898
2899 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2900 store->parsed[store->parsed_nr].begin = begin;
2901 store->parsed[store->parsed_nr].end = end;
2902 store->parsed[store->parsed_nr].type = type;
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002903
2904 if (type == CONFIG_EVENT_SECTION) {
Stefan Beller2d84f132018-08-08 12:50:19 -07002905 int (*cmpfn)(const char *, const char *, size_t);
2906
Glen Choo9b4a6552023-03-28 17:51:54 +00002907 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
2908 return error(_("invalid section name '%s'"), cs->var.buf);
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002909
Glen Choo9b4a6552023-03-28 17:51:54 +00002910 if (cs->subsection_case_sensitive)
Stefan Beller2d84f132018-08-08 12:50:19 -07002911 cmpfn = strncasecmp;
2912 else
2913 cmpfn = strncmp;
2914
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002915 /* Is this the section we were looking for? */
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02002916 store->is_keys_section =
2917 store->parsed[store->parsed_nr].is_keys_section =
Glen Choo9b4a6552023-03-28 17:51:54 +00002918 cs->var.len - 1 == store->baselen &&
2919 !cmpfn(cs->var.buf, store->key, store->baselen);
Johannes Schindelinc71d8bb2018-04-09 10:32:29 +02002920 if (store->is_keys_section) {
2921 store->section_seen = 1;
2922 ALLOC_GROW(store->seen, store->seen_nr + 1,
2923 store->seen_alloc);
2924 store->seen[store->seen_nr] = store->parsed_nr;
2925 }
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002926 }
2927
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02002928 store->parsed_nr++;
2929
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002930 return 0;
Johannes Schindelin10bea152005-11-17 22:32:36 +01002931}
2932
Glen Chooa4e7e312023-06-28 19:26:22 +00002933static int store_aux(const char *key, const char *value,
2934 const struct config_context *ctx UNUSED, void *cb)
Johannes Schindelin10bea152005-11-17 22:32:36 +01002935{
Johannes Schindelinfee85722018-04-09 10:32:09 +02002936 struct config_store_data *store = cb;
Junio C Hamanoae9ee412007-05-12 21:49:33 -07002937
Johannes Schindelin5221c312018-04-09 10:32:17 +02002938 if (store->key_seen) {
Johannes Schindelinfee85722018-04-09 10:32:09 +02002939 if (matches(key, value, store)) {
Johannes Schindelin668b9ad2018-04-09 10:32:13 +02002940 if (store->seen_nr == 1 && store->multi_replace == 0) {
Matthieu Moy8262aaa2014-08-07 04:59:12 -07002941 warning(_("%s has multiple values"), key);
Johannes Schindelin10bea152005-11-17 22:32:36 +01002942 }
Johannes Schindelin4ddba792005-11-20 06:52:22 +01002943
Johannes Schindelin668b9ad2018-04-09 10:32:13 +02002944 ALLOC_GROW(store->seen, store->seen_nr + 1,
2945 store->seen_alloc);
Thomas Rast83786fa2013-11-13 11:19:00 +01002946
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002947 store->seen[store->seen_nr] = store->parsed_nr;
Johannes Schindelin668b9ad2018-04-09 10:32:13 +02002948 store->seen_nr++;
Johannes Schindelin10bea152005-11-17 22:32:36 +01002949 }
Johannes Schindelin5221c312018-04-09 10:32:17 +02002950 } else if (store->is_keys_section) {
Junio C Hamanoae9ee412007-05-12 21:49:33 -07002951 /*
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002952 * Do not increment matches yet: this may not be a match, but we
2953 * are in the desired section.
Junio C Hamanoae9ee412007-05-12 21:49:33 -07002954 */
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002955 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2956 store->seen[store->seen_nr] = store->parsed_nr;
Johannes Schindelin5221c312018-04-09 10:32:17 +02002957 store->section_seen = 1;
Junio C Hamanoae9ee412007-05-12 21:49:33 -07002958
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02002959 if (matches(key, value, store)) {
2960 store->seen_nr++;
2961 store->key_seen = 1;
seanbdf0ef02006-05-06 14:14:02 -04002962 }
Johannes Schindelin10bea152005-11-17 22:32:36 +01002963 }
Johannes Schindelin5221c312018-04-09 10:32:17 +02002964
Johannes Schindelin10bea152005-11-17 22:32:36 +01002965 return 0;
2966}
2967
Alex Riesen64c0d712008-05-12 23:41:04 +02002968static int write_error(const char *filename)
Andy Whitcroft480c9e52007-01-08 15:58:38 +00002969{
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02002970 error(_("failed to write new configuration file %s"), filename);
Andy Whitcroft480c9e52007-01-08 15:58:38 +00002971
2972 /* Same error code as "failed to rename". */
2973 return 4;
2974}
2975
Johannes Schindelinfee85722018-04-09 10:32:09 +02002976static struct strbuf store_create_section(const char *key,
2977 const struct config_store_data *store)
Johannes Schindelin10bea152005-11-17 22:32:36 +01002978{
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05002979 const char *dot;
Jeff Kingf011a962020-04-10 15:46:07 -04002980 size_t i;
Brandon Caseyf285a2d2008-10-09 14:12:12 -05002981 struct strbuf sb = STRBUF_INIT;
Linus Torvaldsd14f7762006-05-09 12:24:02 -07002982
Johannes Schindelinfee85722018-04-09 10:32:09 +02002983 dot = memchr(key, '.', store->baselen);
Linus Torvaldsd14f7762006-05-09 12:24:02 -07002984 if (dot) {
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05002985 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
Johannes Schindelinfee85722018-04-09 10:32:09 +02002986 for (i = dot - key + 1; i < store->baselen; i++) {
Bryan Donlane5c349b2008-05-04 01:37:52 -04002987 if (key[i] == '"' || key[i] == '\\')
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05002988 strbuf_addch(&sb, '\\');
2989 strbuf_addch(&sb, key[i]);
Linus Torvaldsd14f7762006-05-09 12:24:02 -07002990 }
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05002991 strbuf_addstr(&sb, "\"]\n");
2992 } else {
Jeff Kingf011a962020-04-10 15:46:07 -04002993 strbuf_addch(&sb, '[');
2994 strbuf_add(&sb, key, store->baselen);
2995 strbuf_addstr(&sb, "]\n");
Linus Torvaldsd14f7762006-05-09 12:24:02 -07002996 }
2997
Sahil Dua5463caa2017-06-18 23:16:31 +02002998 return sb;
2999}
3000
Johannes Schindelinfee85722018-04-09 10:32:09 +02003001static ssize_t write_section(int fd, const char *key,
3002 const struct config_store_data *store)
Sahil Dua5463caa2017-06-18 23:16:31 +02003003{
Johannes Schindelinfee85722018-04-09 10:32:09 +02003004 struct strbuf sb = store_create_section(key, store);
Junio C Hamano3b480452017-10-03 15:42:48 +09003005 ssize_t ret;
Sahil Dua5463caa2017-06-18 23:16:31 +02003006
René Scharfe782c0302017-11-18 11:20:04 +01003007 ret = write_in_full(fd, sb.buf, sb.len);
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05003008 strbuf_release(&sb);
Andy Whitcroft480c9e52007-01-08 15:58:38 +00003009
Jeff Kingd9bd4cb2017-09-13 13:17:57 -04003010 return ret;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003011}
3012
Johannes Schindelinfee85722018-04-09 10:32:09 +02003013static ssize_t write_pair(int fd, const char *key, const char *value,
Ralph Seichter42d5c032024-03-12 21:47:00 +00003014 const char *comment,
Johannes Schindelinfee85722018-04-09 10:32:09 +02003015 const struct config_store_data *store)
Johannes Schindelin10bea152005-11-17 22:32:36 +01003016{
Jeff Kingd9bd4cb2017-09-13 13:17:57 -04003017 int i;
3018 ssize_t ret;
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05003019 const char *quote = "";
Brandon Caseyf285a2d2008-10-09 14:12:12 -05003020 struct strbuf sb = STRBUF_INIT;
Brian Gernhardtcdd4fb12007-01-09 00:27:41 -05003021
Jim Meyering6281f392007-12-08 16:48:05 +01003022 /*
3023 * Check to see if the value needs to be surrounded with a dq pair.
3024 * Note that problematic characters are always backslash-quoted; this
3025 * check is about not losing leading or trailing SP and strings that
3026 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3027 * configuration parser.
3028 */
Brian Gernhardtcdd4fb12007-01-09 00:27:41 -05003029 if (value[0] == ' ')
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05003030 quote = "\"";
Brian Gernhardtcdd4fb12007-01-09 00:27:41 -05003031 for (i = 0; value[i]; i++)
3032 if (value[i] == ';' || value[i] == '#')
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05003033 quote = "\"";
3034 if (i && value[i - 1] == ' ')
3035 quote = "\"";
Johannes Schindelin10bea152005-11-17 22:32:36 +01003036
Jeff King6c7e6962020-04-10 15:44:45 -04003037 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05003038
Johannes Schindelin10bea152005-11-17 22:32:36 +01003039 for (i = 0; value[i]; i++)
3040 switch (value[i]) {
Andy Whitcroft480c9e52007-01-08 15:58:38 +00003041 case '\n':
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05003042 strbuf_addstr(&sb, "\\n");
Andy Whitcroft480c9e52007-01-08 15:58:38 +00003043 break;
3044 case '\t':
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05003045 strbuf_addstr(&sb, "\\t");
Andy Whitcroft480c9e52007-01-08 15:58:38 +00003046 break;
3047 case '"':
3048 case '\\':
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05003049 strbuf_addch(&sb, '\\');
Jeff King1cf01a32017-09-21 02:25:41 -04003050 /* fallthrough */
Andy Whitcroft480c9e52007-01-08 15:58:38 +00003051 default:
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05003052 strbuf_addch(&sb, value[i]);
Andy Whitcroft480c9e52007-01-08 15:58:38 +00003053 break;
3054 }
Ralph Seichter42d5c032024-03-12 21:47:00 +00003055
Junio C Hamanofbad3342024-03-15 12:43:58 -07003056 if (comment)
Junio C Hamano31399a62024-03-15 15:26:40 -07003057 strbuf_addf(&sb, "%s%s\n", quote, comment);
Junio C Hamanofbad3342024-03-15 12:43:58 -07003058 else
Ralph Seichter42d5c032024-03-12 21:47:00 +00003059 strbuf_addf(&sb, "%s\n", quote);
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05003060
Jeff Kingd9bd4cb2017-09-13 13:17:57 -04003061 ret = write_in_full(fd, sb.buf, sb.len);
Kristian Høgsbergcb891a52007-12-14 15:59:58 -05003062 strbuf_release(&sb);
3063
Jeff Kingd9bd4cb2017-09-13 13:17:57 -04003064 return ret;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003065}
3066
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02003067/*
3068 * If we are about to unset the last key(s) in a section, and if there are
3069 * no comments surrounding (or included in) the section, we will want to
3070 * extend begin/end to remove the entire section.
3071 *
3072 * Note: the parameter `seen_ptr` points to the index into the store.seen
3073 * array. * This index may be incremented if a section has more than one
3074 * entry (which all are to be removed).
3075 */
3076static void maybe_remove_section(struct config_store_data *store,
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02003077 size_t *begin_offset, size_t *end_offset,
3078 int *seen_ptr)
Johannes Schindelin4ddba792005-11-20 06:52:22 +01003079{
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02003080 size_t begin;
3081 int i, seen, section_seen = 0;
Johannes Schindelin4ddba792005-11-20 06:52:22 +01003082
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02003083 /*
3084 * First, ensure that this is the first key, and that there are no
3085 * comments before the entry nor before the section header.
3086 */
3087 seen = *seen_ptr;
3088 for (i = store->seen[seen]; i > 0; i--) {
3089 enum config_event_t type = store->parsed[i - 1].type;
3090
3091 if (type == CONFIG_EVENT_COMMENT)
3092 /* There is a comment before this entry or section */
3093 return;
3094 if (type == CONFIG_EVENT_ENTRY) {
3095 if (!section_seen)
3096 /* This is not the section's first entry. */
3097 return;
3098 /* We encountered no comment before the section. */
3099 break;
Johannes Schindelin4ddba792005-11-20 06:52:22 +01003100 }
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02003101 if (type == CONFIG_EVENT_SECTION) {
3102 if (!store->parsed[i - 1].is_keys_section)
3103 break;
3104 section_seen = 1;
3105 }
Frank Lichtenheld7a31cc02008-02-11 01:23:03 +01003106 }
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02003107 begin = store->parsed[i].begin;
Johannes Schindelin4ddba792005-11-20 06:52:22 +01003108
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02003109 /*
Derrick Stolee46a237f2021-06-15 14:11:11 +00003110 * Next, make sure that we are removing the last key(s) in the section,
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02003111 * and that there are no comments that are possibly about the current
3112 * section.
3113 */
3114 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3115 enum config_event_t type = store->parsed[i].type;
3116
3117 if (type == CONFIG_EVENT_COMMENT)
3118 return;
3119 if (type == CONFIG_EVENT_SECTION) {
3120 if (store->parsed[i].is_keys_section)
3121 continue;
3122 break;
3123 }
3124 if (type == CONFIG_EVENT_ENTRY) {
3125 if (++seen < store->seen_nr &&
3126 i == store->seen[seen])
3127 /* We want to remove this entry, too */
3128 continue;
3129 /* There is another entry in this section. */
3130 return;
3131 }
3132 }
3133
3134 /*
3135 * We are really removing the last entry/entries from this section, and
3136 * there are no enclosed or surrounding comments. Remove the entire,
3137 * now-empty section.
3138 */
3139 *seen_ptr = seen;
3140 *begin_offset = begin;
3141 if (i < store->parsed_nr)
3142 *end_offset = store->parsed[i].begin;
3143 else
3144 *end_offset = store->parsed[store->parsed_nr - 1].end;
Johannes Schindelin4ddba792005-11-20 06:52:22 +01003145}
3146
Patrick Steinhardt30598ad2016-02-22 12:23:35 +01003147int git_config_set_in_file_gently(const char *config_filename,
Ralph Seichter42d5c032024-03-12 21:47:00 +00003148 const char *key, const char *comment, const char *value)
Ramkumar Ramachandra5ec31182011-08-04 16:09:00 +05303149{
Ralph Seichter42d5c032024-03-12 21:47:00 +00003150 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, comment, 0);
Ramkumar Ramachandra5ec31182011-08-04 16:09:00 +05303151}
3152
Patrick Steinhardt3d180642016-02-22 12:23:36 +01003153void git_config_set_in_file(const char *config_filename,
3154 const char *key, const char *value)
Johannes Schindelin10bea152005-11-17 22:32:36 +01003155{
Patrick Steinhardt3d180642016-02-22 12:23:36 +01003156 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
Patrick Steinhardtb4c8aba2016-02-16 13:56:28 +01003157}
3158
Patrick Steinhardt30598ad2016-02-22 12:23:35 +01003159int git_config_set_gently(const char *key, const char *value)
Johannes Schindelin10bea152005-11-17 22:32:36 +01003160{
Patrick Steinhardt30598ad2016-02-22 12:23:35 +01003161 return git_config_set_multivar_gently(key, value, NULL, 0);
Johannes Schindelin10bea152005-11-17 22:32:36 +01003162}
3163
Derrick Stoleefe187332022-02-07 21:33:00 +00003164int repo_config_set_worktree_gently(struct repository *r,
3165 const char *key, const char *value)
3166{
Andrei Rybakb39a8412023-01-07 14:56:55 +01003167 /* Only use worktree-specific config if it is already enabled. */
Victoria Dye3867f6d2023-05-26 01:33:00 +00003168 if (r->repository_format_worktree_config) {
Derrick Stoleefe187332022-02-07 21:33:00 +00003169 char *file = repo_git_path(r, "config.worktree");
3170 int ret = git_config_set_multivar_in_file_gently(
Ralph Seichter42d5c032024-03-12 21:47:00 +00003171 file, key, value, NULL, NULL, 0);
Derrick Stoleefe187332022-02-07 21:33:00 +00003172 free(file);
3173 return ret;
3174 }
3175 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3176}
3177
Patrick Steinhardt3d180642016-02-22 12:23:36 +01003178void git_config_set(const char *key, const char *value)
Patrick Steinhardtb4c8aba2016-02-16 13:56:28 +01003179{
Patrick Steinhardt3d180642016-02-22 12:23:36 +01003180 git_config_set_multivar(key, value, NULL, 0);
Jeff Hostetleree4512e2019-02-22 14:25:01 -08003181
3182 trace2_cmd_set_config(key, value);
Johannes Schindelin10bea152005-11-17 22:32:36 +01003183}
3184
Patrick Steinhardta78b4622024-05-06 10:55:56 +02003185char *git_config_prepare_comment_string(const char *comment)
Junio C Hamano31399a62024-03-15 15:26:40 -07003186{
3187 size_t leading_blanks;
Patrick Steinhardta78b4622024-05-06 10:55:56 +02003188 char *prepared;
Junio C Hamano31399a62024-03-15 15:26:40 -07003189
3190 if (!comment)
3191 return NULL;
3192
3193 if (strchr(comment, '\n'))
3194 die(_("no multi-line comment allowed: '%s'"), comment);
3195
3196 /*
3197 * If it begins with one or more leading whitespace characters
3198 * followed by '#", the comment string is used as-is.
3199 *
3200 * If it begins with '#', a SP is inserted between the comment
3201 * and the value the comment is about.
3202 *
3203 * Otherwise, the value is followed by a SP followed by '#'
3204 * followed by SP and then the comment string comes.
3205 */
3206
3207 leading_blanks = strspn(comment, " \t");
3208 if (leading_blanks && comment[leading_blanks] == '#')
Patrick Steinhardta78b4622024-05-06 10:55:56 +02003209 prepared = xstrdup(comment); /* use it as-is */
Junio C Hamano31399a62024-03-15 15:26:40 -07003210 else if (comment[0] == '#')
Patrick Steinhardta78b4622024-05-06 10:55:56 +02003211 prepared = xstrfmt(" %s", comment);
Junio C Hamano31399a62024-03-15 15:26:40 -07003212 else
Patrick Steinhardta78b4622024-05-06 10:55:56 +02003213 prepared = xstrfmt(" # %s", comment);
Junio C Hamano31399a62024-03-15 15:26:40 -07003214
Patrick Steinhardta78b4622024-05-06 10:55:56 +02003215 return prepared;
Junio C Hamano31399a62024-03-15 15:26:40 -07003216}
3217
3218static void validate_comment_string(const char *comment)
3219{
3220 size_t leading_blanks;
3221
3222 if (!comment)
3223 return;
3224 /*
3225 * The front-end must have massaged the comment string
3226 * properly before calling us.
3227 */
3228 if (strchr(comment, '\n'))
3229 BUG("multi-line comments are not permitted: '%s'", comment);
3230
3231 leading_blanks = strspn(comment, " \t");
3232 if (!leading_blanks || comment[leading_blanks] != '#')
3233 BUG("comment must begin with one or more SP followed by '#': '%s'",
3234 comment);
3235}
3236
3237/*
Johannes Schindelin10bea152005-11-17 22:32:36 +01003238 * If value==NULL, unset in (remove from) config,
Derrick Stolee247e2f82020-11-25 22:12:50 +00003239 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3240 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
Jeff Kingc1063be2014-08-19 02:20:00 -04003241 * (only add a new one)
Derrick Stolee504ee122020-11-25 22:12:49 +00003242 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3243 * key/values are removed before a single new pair is written. If the
3244 * flag is not present, then replace only the first match.
Johannes Schindelin10bea152005-11-17 22:32:36 +01003245 *
3246 * Returns 0 on success.
3247 *
3248 * This function does this:
3249 *
3250 * - it locks the config file by creating ".git/config.lock"
3251 *
3252 * - it then parses the config using store_aux() as validator to find
3253 * the position on the key/value pair to replace. If it is to be unset,
3254 * it must be found exactly once.
3255 *
3256 * - the config file is mmap()ed and the part before the match (if any) is
3257 * written to the lock file, then the changed part and the rest.
3258 *
3259 * - the config file is removed and the lock file rename()d to it.
3260 *
3261 */
Patrick Steinhardt30598ad2016-02-22 12:23:35 +01003262int git_config_set_multivar_in_file_gently(const char *config_filename,
3263 const char *key, const char *value,
Derrick Stolee247e2f82020-11-25 22:12:50 +00003264 const char *value_pattern,
Ralph Seichter42d5c032024-03-12 21:47:00 +00003265 const char *comment,
Derrick Stolee504ee122020-11-25 22:12:49 +00003266 unsigned flags)
Johannes Schindelin10bea152005-11-17 22:32:36 +01003267{
Sven Strickroth54d160e2015-08-14 22:21:17 +02003268 int fd = -1, in_fd = -1;
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003269 int ret;
Jeff Kingbfffb482017-09-05 08:15:21 -04003270 struct lock_file lock = LOCK_INIT;
Jeff King0a5f5752012-02-16 03:04:05 -05003271 char *filename_buf = NULL;
Jeff King3a1b3122015-05-28 03:54:43 -04003272 char *contents = NULL;
3273 size_t contents_sz;
Glen Chooa798a562023-03-28 17:51:50 +00003274 struct config_store_data store = CONFIG_STORE_INIT;
Johannes Schindelinfee85722018-04-09 10:32:09 +02003275
Junio C Hamano31399a62024-03-15 15:26:40 -07003276 validate_comment_string(comment);
Junio C Hamanofbad3342024-03-15 12:43:58 -07003277
Libor Pechacekb09c53a2011-01-30 20:40:41 +01003278 /* parse-key returns negative; flip the sign to feed exit(3) */
3279 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3280 if (ret)
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003281 goto out_free;
Johannes Schindelinb17e6592005-11-20 21:22:19 +01003282
Derrick Stolee504ee122020-11-25 22:12:49 +00003283 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003284
Jeff King0a5f5752012-02-16 03:04:05 -05003285 if (!config_filename)
3286 config_filename = filename_buf = git_pathdup("config");
Johannes Schindelin10bea152005-11-17 22:32:36 +01003287
3288 /*
Bradford C. Smith6cbf9732007-07-26 12:55:28 -04003289 * The lock serves a purpose in addition to locking: the new
Johannes Schindelin10bea152005-11-17 22:32:36 +01003290 * contents of .git/config will be written into it.
3291 */
Jeff Kingbfffb482017-09-05 08:15:21 -04003292 fd = hold_lock_file_for_update(&lock, config_filename, 0);
Bradford C. Smith6cbf9732007-07-26 12:55:28 -04003293 if (fd < 0) {
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02003294 error_errno(_("could not lock config file %s"), config_filename);
Michael J Gruber7a397412011-05-17 17:38:52 +02003295 ret = CONFIG_NO_LOCK;
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003296 goto out_free;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003297 }
3298
3299 /*
3300 * If .git/config does not exist yet, write a minimal version.
3301 */
Alex Riesen88fb9582006-01-05 12:43:34 +01003302 in_fd = open(config_filename, O_RDONLY);
3303 if ( in_fd < 0 ) {
Alex Riesen88fb9582006-01-05 12:43:34 +01003304 if ( ENOENT != errno ) {
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02003305 error_errno(_("opening %s"), config_filename);
Michael J Gruber7a397412011-05-17 17:38:52 +02003306 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003307 goto out_free;
Alex Riesen88fb9582006-01-05 12:43:34 +01003308 }
Johannes Schindelin10bea152005-11-17 22:32:36 +01003309 /* if nothing to unset, error out */
Junio C Hamanoafe8a902022-05-02 09:50:37 -07003310 if (!value) {
Michael J Gruber7a397412011-05-17 17:38:52 +02003311 ret = CONFIG_NOTHING_SET;
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003312 goto out_free;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003313 }
3314
Martin Ågrene7347cb2018-05-20 12:42:35 +02003315 free(store.key);
3316 store.key = xstrdup(key);
Johannes Schindelinfee85722018-04-09 10:32:09 +02003317 if (write_section(fd, key, &store) < 0 ||
Ralph Seichter42d5c032024-03-12 21:47:00 +00003318 write_pair(fd, key, value, comment, &store) < 0)
Junio C Hamano93c1e072007-01-11 13:16:26 -08003319 goto write_err_out;
3320 } else {
Alex Riesen88fb9582006-01-05 12:43:34 +01003321 struct stat st;
Jeff King3a1b3122015-05-28 03:54:43 -04003322 size_t copy_begin, copy_end;
Shawn O. Pearcedc49cd72007-03-06 20:44:37 -05003323 int i, new_line = 0;
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02003324 struct config_options opts;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003325
Junio C Hamanoafe8a902022-05-02 09:50:37 -07003326 if (!value_pattern)
Derrick Stolee247e2f82020-11-25 22:12:50 +00003327 store.value_pattern = NULL;
3328 else if (value_pattern == CONFIG_REGEX_NONE)
3329 store.value_pattern = CONFIG_REGEX_NONE;
Derrick Stoleec90702a2020-11-25 22:12:54 +00003330 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3331 store.fixed_value = value_pattern;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003332 else {
Derrick Stolee247e2f82020-11-25 22:12:50 +00003333 if (value_pattern[0] == '!') {
Johannes Schindelinf98d8632005-11-20 13:24:18 +01003334 store.do_not_match = 1;
Derrick Stolee247e2f82020-11-25 22:12:50 +00003335 value_pattern++;
Johannes Schindelinf98d8632005-11-20 13:24:18 +01003336 } else
3337 store.do_not_match = 0;
3338
Derrick Stolee247e2f82020-11-25 22:12:50 +00003339 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3340 if (regcomp(store.value_pattern, value_pattern,
Johannes Schindelin10bea152005-11-17 22:32:36 +01003341 REG_EXTENDED)) {
Derrick Stolee247e2f82020-11-25 22:12:50 +00003342 error(_("invalid pattern: %s"), value_pattern);
3343 FREE_AND_NULL(store.value_pattern);
Michael J Gruber7a397412011-05-17 17:38:52 +02003344 ret = CONFIG_INVALID_PATTERN;
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003345 goto out_free;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003346 }
3347 }
3348
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02003349 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3350 store.parsed[0].end = 0;
3351
3352 memset(&opts, 0, sizeof(opts));
3353 opts.event_fn = store_aux_event;
3354 opts.event_fn_data = &store;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003355
3356 /*
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02003357 * After this, store.parsed will contain offsets of all the
3358 * parsed elements, and store.seen will contain a list of
3359 * matches, as indices into store.parsed.
3360 *
Johannes Schindelin10bea152005-11-17 22:32:36 +01003361 * As a side effect, we make sure to transform only a valid
3362 * existing config file.
3363 */
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02003364 if (git_config_from_file_with_options(store_aux,
3365 config_filename,
Glen Choo809d8682023-06-28 19:26:24 +00003366 &store, CONFIG_SCOPE_UNKNOWN,
3367 &opts)) {
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02003368 error(_("invalid config file %s"), config_filename);
Michael J Gruber7a397412011-05-17 17:38:52 +02003369 ret = CONFIG_INVALID_FILE;
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003370 goto out_free;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003371 }
3372
Johannes Schindelin4ddba792005-11-20 06:52:22 +01003373 /* if nothing to unset, or too many matches, error out */
Johannes Schindelin668b9ad2018-04-09 10:32:13 +02003374 if ((store.seen_nr == 0 && value == NULL) ||
Derrick Stolee504ee122020-11-25 22:12:49 +00003375 (store.seen_nr > 1 && !store.multi_replace)) {
Michael J Gruber7a397412011-05-17 17:38:52 +02003376 ret = CONFIG_NOTHING_SET;
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003377 goto out_free;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003378 }
3379
Nguyễn Thái Ngọc Duy29647d72016-12-19 16:21:55 +07003380 if (fstat(in_fd, &st) == -1) {
3381 error_errno(_("fstat on %s failed"), config_filename);
3382 ret = CONFIG_INVALID_FILE;
3383 goto out_free;
3384 }
3385
Shawn O. Pearcedc49cd72007-03-06 20:44:37 -05003386 contents_sz = xsize_t(st.st_size);
Jeff King15708562015-05-28 03:56:15 -04003387 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3388 MAP_PRIVATE, in_fd, 0);
3389 if (contents == MAP_FAILED) {
Jeff King0e8771f2015-05-28 04:03:01 -04003390 if (errno == ENODEV && S_ISDIR(st.st_mode))
3391 errno = EISDIR;
Eric Wongdc059292021-06-30 00:01:32 +00003392 error_errno(_("unable to mmap '%s'%s"),
3393 config_filename, mmap_os_err());
Jeff King15708562015-05-28 03:56:15 -04003394 ret = CONFIG_INVALID_FILE;
3395 contents = NULL;
3396 goto out_free;
3397 }
Johannes Schindelin10bea152005-11-17 22:32:36 +01003398 close(in_fd);
Sven Strickroth54d160e2015-08-14 22:21:17 +02003399 in_fd = -1;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003400
Jeff Kingbfffb482017-09-05 08:15:21 -04003401 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02003402 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
Eric Wongdaa22c62014-05-06 00:17:14 +00003403 ret = CONFIG_NO_WRITE;
3404 goto out_free;
3405 }
3406
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02003407 if (store.seen_nr == 0) {
3408 if (!store.seen_alloc) {
3409 /* Did not see key nor section */
3410 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3411 store.seen[0] = store.parsed_nr
3412 - !!store.parsed_nr;
3413 }
Johannes Schindelin668b9ad2018-04-09 10:32:13 +02003414 store.seen_nr = 1;
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02003415 }
Johannes Schindelin10bea152005-11-17 22:32:36 +01003416
Johannes Schindelin668b9ad2018-04-09 10:32:13 +02003417 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02003418 size_t replace_end;
3419 int j = store.seen[i];
3420
Johannes Schindelin46fc89c2018-04-03 18:28:14 +02003421 new_line = 0;
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02003422 if (!store.key_seen) {
Johannes Schindelinc71d8bb2018-04-09 10:32:29 +02003423 copy_end = store.parsed[j].end;
3424 /* include '\n' when copying section header */
3425 if (copy_end > 0 && copy_end < contents_sz &&
3426 contents[copy_end - 1] != '\n' &&
3427 contents[copy_end] == '\n')
3428 copy_end++;
3429 replace_end = copy_end;
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02003430 } else {
3431 replace_end = store.parsed[j].end;
3432 copy_end = store.parsed[j].begin;
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02003433 if (!value)
Jeff Kinga263ea82019-01-24 08:12:32 -05003434 maybe_remove_section(&store,
Johannes Schindelin22aedfc2018-04-09 10:32:24 +02003435 &copy_end,
3436 &replace_end, &i);
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02003437 /*
3438 * Swallow preceding white-space on the same
3439 * line.
3440 */
3441 while (copy_end > 0 ) {
3442 char c = contents[copy_end - 1];
3443
3444 if (isspace(c) && c != '\n')
3445 copy_end--;
3446 else
3447 break;
3448 }
3449 }
Johannes Schindelin10bea152005-11-17 22:32:36 +01003450
Jeff King02e5ba42008-01-01 01:17:34 -05003451 if (copy_end > 0 && contents[copy_end-1] != '\n')
3452 new_line = 1;
3453
Johannes Schindelin4ddba792005-11-20 06:52:22 +01003454 /* write the first part of the config */
3455 if (copy_end > copy_begin) {
Junio C Hamano93c1e072007-01-11 13:16:26 -08003456 if (write_in_full(fd, contents + copy_begin,
Jeff Kingefacf602017-09-13 14:15:16 -04003457 copy_end - copy_begin) < 0)
Junio C Hamano93c1e072007-01-11 13:16:26 -08003458 goto write_err_out;
3459 if (new_line &&
Jeff King06f46f22017-09-13 13:16:03 -04003460 write_str_in_full(fd, "\n") < 0)
Junio C Hamano93c1e072007-01-11 13:16:26 -08003461 goto write_err_out;
Johannes Schindelin4ddba792005-11-20 06:52:22 +01003462 }
Johannes Schindelin6ae996f2018-04-09 10:32:20 +02003463 copy_begin = replace_end;
Johannes Schindelin4ddba792005-11-20 06:52:22 +01003464 }
Johannes Schindelin10bea152005-11-17 22:32:36 +01003465
3466 /* write the pair (value == NULL means unset) */
Junio C Hamanoafe8a902022-05-02 09:50:37 -07003467 if (value) {
Johannes Schindelin5221c312018-04-09 10:32:17 +02003468 if (!store.section_seen) {
Johannes Schindelinfee85722018-04-09 10:32:09 +02003469 if (write_section(fd, key, &store) < 0)
Junio C Hamano93c1e072007-01-11 13:16:26 -08003470 goto write_err_out;
Andy Whitcroft480c9e52007-01-08 15:58:38 +00003471 }
Ralph Seichter42d5c032024-03-12 21:47:00 +00003472 if (write_pair(fd, key, value, comment, &store) < 0)
Junio C Hamano93c1e072007-01-11 13:16:26 -08003473 goto write_err_out;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003474 }
3475
3476 /* write the rest of the config */
Shawn O. Pearcedc49cd72007-03-06 20:44:37 -05003477 if (copy_begin < contents_sz)
Junio C Hamano93c1e072007-01-11 13:16:26 -08003478 if (write_in_full(fd, contents + copy_begin,
Jeff Kingefacf602017-09-13 14:15:16 -04003479 contents_sz - copy_begin) < 0)
Junio C Hamano93c1e072007-01-11 13:16:26 -08003480 goto write_err_out;
Karsten Blees7a645922015-06-30 16:34:13 +02003481
3482 munmap(contents, contents_sz);
3483 contents = NULL;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003484 }
3485
Jeff Kingbfffb482017-09-05 08:15:21 -04003486 if (commit_lock_file(&lock) < 0) {
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02003487 error_errno(_("could not write config file %s"), config_filename);
Michael J Gruber7a397412011-05-17 17:38:52 +02003488 ret = CONFIG_NO_WRITE;
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003489 goto out_free;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003490 }
3491
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003492 ret = 0;
3493
Tanay Abhra3c8687a2014-07-28 03:10:38 -07003494 /* Invalidate the config cache */
3495 git_config_clear();
3496
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003497out_free:
Jeff Kingbfffb482017-09-05 08:15:21 -04003498 rollback_lock_file(&lock);
Jeff King0a5f5752012-02-16 03:04:05 -05003499 free(filename_buf);
Jeff King3a1b3122015-05-28 03:54:43 -04003500 if (contents)
3501 munmap(contents, contents_sz);
Sven Strickroth54d160e2015-08-14 22:21:17 +02003502 if (in_fd >= 0)
3503 close(in_fd);
Martin Ågren2a00e592018-05-20 12:42:33 +02003504 config_store_data_clear(&store);
Serge E. Hallyndafc88b2006-04-17 10:14:48 -05003505 return ret;
Junio C Hamano93c1e072007-01-11 13:16:26 -08003506
3507write_err_out:
Jeff Kingbfffb482017-09-05 08:15:21 -04003508 ret = write_error(get_lock_file_path(&lock));
Junio C Hamano93c1e072007-01-11 13:16:26 -08003509 goto out_free;
Johannes Schindelin10bea152005-11-17 22:32:36 +01003510}
3511
Patrick Steinhardt3d180642016-02-22 12:23:36 +01003512void git_config_set_multivar_in_file(const char *config_filename,
3513 const char *key, const char *value,
Derrick Stolee247e2f82020-11-25 22:12:50 +00003514 const char *value_pattern, unsigned flags)
Ramkumar Ramachandra5ec31182011-08-04 16:09:00 +05303515{
Jeff King1cae4282016-04-09 13:43:54 -04003516 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
Ralph Seichter42d5c032024-03-12 21:47:00 +00003517 value_pattern, NULL, flags))
Jeff King1cae4282016-04-09 13:43:54 -04003518 return;
3519 if (value)
Jeff King8c3ca352016-04-09 13:42:31 -04003520 die(_("could not set '%s' to '%s'"), key, value);
Jeff King1cae4282016-04-09 13:43:54 -04003521 else
3522 die(_("could not unset '%s'"), key);
Patrick Steinhardtb4c8aba2016-02-16 13:56:28 +01003523}
3524
Patrick Steinhardt30598ad2016-02-22 12:23:35 +01003525int git_config_set_multivar_gently(const char *key, const char *value,
Derrick Stolee247e2f82020-11-25 22:12:50 +00003526 const char *value_pattern, unsigned flags)
Ramkumar Ramachandra5ec31182011-08-04 16:09:00 +05303527{
Derrick Stoleefe187332022-02-07 21:33:00 +00003528 return repo_config_set_multivar_gently(the_repository, key, value,
3529 value_pattern, flags);
3530}
3531
3532int repo_config_set_multivar_gently(struct repository *r, const char *key,
3533 const char *value,
3534 const char *value_pattern, unsigned flags)
3535{
3536 char *file = repo_git_path(r, "config");
3537 int res = git_config_set_multivar_in_file_gently(file,
3538 key, value,
3539 value_pattern,
Ralph Seichter42d5c032024-03-12 21:47:00 +00003540 NULL, flags);
Derrick Stoleefe187332022-02-07 21:33:00 +00003541 free(file);
3542 return res;
Ramkumar Ramachandra5ec31182011-08-04 16:09:00 +05303543}
3544
Patrick Steinhardt3d180642016-02-22 12:23:36 +01003545void git_config_set_multivar(const char *key, const char *value,
Derrick Stolee247e2f82020-11-25 22:12:50 +00003546 const char *value_pattern, unsigned flags)
Patrick Steinhardtb4c8aba2016-02-16 13:56:28 +01003547{
Derrick Stoleefe187332022-02-07 21:33:00 +00003548 git_config_set_multivar_in_file(git_path("config"),
3549 key, value, value_pattern,
Derrick Stolee504ee122020-11-25 22:12:49 +00003550 flags);
Paolo Bonzini118f8b22007-03-02 21:53:33 +01003551}
3552
Taylor Blaue91cfe62023-04-06 14:28:53 -04003553static size_t section_name_match (const char *buf, const char *name)
Linus Torvalds17712992005-10-10 16:31:08 -07003554{
Taylor Blaue91cfe62023-04-06 14:28:53 -04003555 size_t i = 0, j = 0;
3556 int dot = 0;
Paolo Bonzini118f8b22007-03-02 21:53:33 +01003557 if (buf[i] != '[')
3558 return 0;
3559 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3560 if (!dot && isspace(buf[i])) {
3561 dot = 1;
3562 if (name[j++] != '.')
3563 break;
3564 for (i++; isspace(buf[i]); i++)
3565 ; /* do nothing */
3566 if (buf[i] != '"')
3567 break;
3568 continue;
3569 }
3570 if (buf[i] == '\\' && dot)
3571 i++;
3572 else if (buf[i] == '"' && dot) {
3573 for (i++; isspace(buf[i]); i++)
3574 ; /* do_nothing */
3575 break;
3576 }
3577 if (buf[i] != name[j++])
3578 break;
3579 }
Alex Vandivera4c0d462009-07-24 17:21:43 -04003580 if (buf[i] == ']' && name[j] == 0) {
3581 /*
3582 * We match, now just find the right length offset by
3583 * gobbling up any whitespace after it, as well
3584 */
3585 i++;
3586 for (; buf[i] && isspace(buf[i]); i++)
3587 ; /* do nothing */
3588 return i;
3589 }
3590 return 0;
Paolo Bonzini118f8b22007-03-02 21:53:33 +01003591}
3592
Jeff King94a35b12012-04-25 21:47:14 -04003593static int section_name_is_ok(const char *name)
3594{
3595 /* Empty section names are bogus. */
3596 if (!*name)
3597 return 0;
3598
3599 /*
3600 * Before a dot, we must be alphanumeric or dash. After the first dot,
3601 * anything goes, so we can stop checking.
3602 */
3603 for (; *name && *name != '.'; name++)
3604 if (*name != '-' && !isalnum(*name))
3605 return 0;
3606 return 1;
3607}
3608
Taylor Blau3bb3d6b2023-04-12 19:18:28 -04003609#define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3610
Paolo Bonzini118f8b22007-03-02 21:53:33 +01003611/* if new_name == NULL, the section is removed instead */
Sahil Dua52d59cc2017-06-18 23:19:16 +02003612static int git_config_copy_or_rename_section_in_file(const char *config_filename,
Johannes Schindelinfee85722018-04-09 10:32:09 +02003613 const char *old_name,
3614 const char *new_name, int copy)
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003615{
Paolo Bonzini118f8b22007-03-02 21:53:33 +01003616 int ret = 0, remove = 0;
Jeff King42bd39b2012-02-16 03:04:25 -05003617 char *filename_buf = NULL;
Martin Ågren837e34e2017-10-05 22:32:04 +02003618 struct lock_file lock = LOCK_INIT;
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003619 int out_fd;
Taylor Blaua5bb10f2023-04-06 14:07:58 -04003620 struct strbuf buf = STRBUF_INIT;
Johannes Schindelin4db7dbd2017-05-04 15:55:41 +02003621 FILE *config_file = NULL;
Eric Wongdaa22c62014-05-06 00:17:14 +00003622 struct stat st;
Sahil Dua52d59cc2017-06-18 23:19:16 +02003623 struct strbuf copystr = STRBUF_INIT;
Johannes Schindelinfee85722018-04-09 10:32:09 +02003624 struct config_store_data store;
Taylor Blau3bb3d6b2023-04-12 19:18:28 -04003625 uint32_t line_nr = 0;
Johannes Schindelinfee85722018-04-09 10:32:09 +02003626
3627 memset(&store, 0, sizeof(store));
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003628
Jeff King94a35b12012-04-25 21:47:14 -04003629 if (new_name && !section_name_is_ok(new_name)) {
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02003630 ret = error(_("invalid section name: %s"), new_name);
Nguyễn Thái Ngọc Duyc06fa622016-12-20 16:48:36 +07003631 goto out_no_rollback;
Jeff King94a35b12012-04-25 21:47:14 -04003632 }
3633
Jeff King42bd39b2012-02-16 03:04:25 -05003634 if (!config_filename)
3635 config_filename = filename_buf = git_pathdup("config");
3636
Martin Ågren837e34e2017-10-05 22:32:04 +02003637 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
Junio C Hamanofc1905b2006-12-19 21:55:27 -08003638 if (out_fd < 0) {
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02003639 ret = error(_("could not lock config file %s"), config_filename);
Junio C Hamanofc1905b2006-12-19 21:55:27 -08003640 goto out;
3641 }
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003642
Junio C Hamanofc1905b2006-12-19 21:55:27 -08003643 if (!(config_file = fopen(config_filename, "rb"))) {
Nguyễn Thái Ngọc Duy11dc1fc2017-05-03 17:16:49 +07003644 ret = warn_on_fopen_errors(config_filename);
3645 if (ret)
3646 goto out;
Geert Bosch01ebb9d2007-04-05 10:20:55 -04003647 /* no config file means nothing to rename, no error */
Nguyễn Thái Ngọc Duy6e45b432016-12-20 16:48:35 +07003648 goto commit_and_out;
Junio C Hamanofc1905b2006-12-19 21:55:27 -08003649 }
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003650
Nguyễn Thái Ngọc Duy29647d72016-12-19 16:21:55 +07003651 if (fstat(fileno(config_file), &st) == -1) {
3652 ret = error_errno(_("fstat on %s failed"), config_filename);
3653 goto out;
3654 }
Eric Wongdaa22c62014-05-06 00:17:14 +00003655
Martin Ågren837e34e2017-10-05 22:32:04 +02003656 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02003657 ret = error_errno(_("chmod on %s failed"),
Martin Ågren837e34e2017-10-05 22:32:04 +02003658 get_lock_file_path(&lock));
Eric Wongdaa22c62014-05-06 00:17:14 +00003659 goto out;
3660 }
3661
Taylor Blaua5bb10f2023-04-06 14:07:58 -04003662 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
Taylor Blaue91cfe62023-04-06 14:28:53 -04003663 size_t i, length;
Sahil Dua52d59cc2017-06-18 23:19:16 +02003664 int is_section = 0;
Taylor Blaua5bb10f2023-04-06 14:07:58 -04003665 char *output = buf.buf;
Taylor Blau3bb3d6b2023-04-12 19:18:28 -04003666
3667 line_nr++;
3668
3669 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3670 ret = error(_("refusing to work with overly long line "
3671 "in '%s' on line %"PRIuMAX),
3672 config_filename, (uintmax_t)line_nr);
3673 goto out;
3674 }
3675
Taylor Blaua5bb10f2023-04-06 14:07:58 -04003676 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003677 ; /* do nothing */
Taylor Blaua5bb10f2023-04-06 14:07:58 -04003678 if (buf.buf[i] == '[') {
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003679 /* it's a section */
Taylor Blaue91cfe62023-04-06 14:28:53 -04003680 size_t offset;
Sahil Dua52d59cc2017-06-18 23:19:16 +02003681 is_section = 1;
3682
3683 /*
3684 * When encountering a new section under -c we
3685 * need to flush out any section we're already
3686 * coping and begin anew. There might be
3687 * multiple [branch "$name"] sections.
3688 */
3689 if (copystr.len > 0) {
Phillip Woodc5e3bc62017-11-15 12:40:43 +00003690 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
Junio C Hamano0b646bc2017-11-06 13:11:21 +09003691 ret = write_error(get_lock_file_path(&lock));
Sahil Dua52d59cc2017-06-18 23:19:16 +02003692 goto out;
3693 }
3694 strbuf_reset(&copystr);
3695 }
3696
Taylor Blaua5bb10f2023-04-06 14:07:58 -04003697 offset = section_name_match(&buf.buf[i], old_name);
Alex Vandivera4c0d462009-07-24 17:21:43 -04003698 if (offset > 0) {
Paolo Bonzini118f8b22007-03-02 21:53:33 +01003699 ret++;
Junio C Hamanoafe8a902022-05-02 09:50:37 -07003700 if (!new_name) {
Paolo Bonzini118f8b22007-03-02 21:53:33 +01003701 remove = 1;
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003702 continue;
3703 }
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003704 store.baselen = strlen(new_name);
Sahil Dua52d59cc2017-06-18 23:19:16 +02003705 if (!copy) {
Johannes Schindelinfee85722018-04-09 10:32:09 +02003706 if (write_section(out_fd, new_name, &store) < 0) {
Junio C Hamano0b646bc2017-11-06 13:11:21 +09003707 ret = write_error(get_lock_file_path(&lock));
Sahil Dua52d59cc2017-06-18 23:19:16 +02003708 goto out;
3709 }
Alex Vandiver9a5abfc2009-07-24 17:21:44 -04003710 /*
Sahil Dua52d59cc2017-06-18 23:19:16 +02003711 * We wrote out the new section, with
3712 * a newline, now skip the old
3713 * section's length
Alex Vandiver9a5abfc2009-07-24 17:21:44 -04003714 */
Sahil Dua52d59cc2017-06-18 23:19:16 +02003715 output += offset + i;
3716 if (strlen(output) > 0) {
3717 /*
3718 * More content means there's
3719 * a declaration to put on the
3720 * next line; indent with a
3721 * tab
3722 */
3723 output -= 1;
3724 output[0] = '\t';
3725 }
3726 } else {
Rubén Justo5e786ed2023-06-17 08:41:40 +02003727 strbuf_release(&copystr);
Johannes Schindelinfee85722018-04-09 10:32:09 +02003728 copystr = store_create_section(new_name, &store);
Alex Vandiver9a5abfc2009-07-24 17:21:44 -04003729 }
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003730 }
Paolo Bonzini118f8b22007-03-02 21:53:33 +01003731 remove = 0;
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003732 }
Paolo Bonzini118f8b22007-03-02 21:53:33 +01003733 if (remove)
3734 continue;
Alex Vandiver9a5abfc2009-07-24 17:21:44 -04003735 length = strlen(output);
Sahil Dua52d59cc2017-06-18 23:19:16 +02003736
3737 if (!is_section && copystr.len > 0) {
3738 strbuf_add(&copystr, output, length);
3739 }
3740
Jeff King06f46f22017-09-13 13:16:03 -04003741 if (write_in_full(out_fd, output, length) < 0) {
Martin Ågren837e34e2017-10-05 22:32:04 +02003742 ret = write_error(get_lock_file_path(&lock));
Andy Whitcroft480c9e52007-01-08 15:58:38 +00003743 goto out;
3744 }
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003745 }
Sahil Dua52d59cc2017-06-18 23:19:16 +02003746
3747 /*
3748 * Copy a trailing section at the end of the config, won't be
3749 * flushed by the usual "flush because we have a new section
3750 * logic in the loop above.
3751 */
3752 if (copystr.len > 0) {
Phillip Woodc5e3bc62017-11-15 12:40:43 +00003753 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
Junio C Hamano0b646bc2017-11-06 13:11:21 +09003754 ret = write_error(get_lock_file_path(&lock));
Sahil Dua52d59cc2017-06-18 23:19:16 +02003755 goto out;
3756 }
3757 strbuf_reset(&copystr);
3758 }
3759
Junio C Hamanofc1905b2006-12-19 21:55:27 -08003760 fclose(config_file);
Johannes Schindelin4db7dbd2017-05-04 15:55:41 +02003761 config_file = NULL;
Nguyễn Thái Ngọc Duy6e45b432016-12-20 16:48:35 +07003762commit_and_out:
Martin Ågren837e34e2017-10-05 22:32:04 +02003763 if (commit_lock_file(&lock) < 0)
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02003764 ret = error_errno(_("could not write config file %s"),
Nguyễn Thái Ngọc Duyf0658ec2016-05-08 16:47:38 +07003765 config_filename);
Pavan Kumar Sunkara8b590072011-07-17 03:25:52 +05303766out:
Johannes Schindelin4db7dbd2017-05-04 15:55:41 +02003767 if (config_file)
3768 fclose(config_file);
Martin Ågren837e34e2017-10-05 22:32:04 +02003769 rollback_lock_file(&lock);
Nguyễn Thái Ngọc Duyc06fa622016-12-20 16:48:36 +07003770out_no_rollback:
Jeff King42bd39b2012-02-16 03:04:25 -05003771 free(filename_buf);
Martin Ågren2a00e592018-05-20 12:42:33 +02003772 config_store_data_clear(&store);
Taylor Blaua5bb10f2023-04-06 14:07:58 -04003773 strbuf_release(&buf);
Rubén Justo003c1f12023-06-11 20:49:28 +02003774 strbuf_release(&copystr);
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01003775 return ret;
3776}
Junio C Hamano40ea4ed2008-02-11 10:41:18 -08003777
Sahil Dua52d59cc2017-06-18 23:19:16 +02003778int git_config_rename_section_in_file(const char *config_filename,
3779 const char *old_name, const char *new_name)
3780{
3781 return git_config_copy_or_rename_section_in_file(config_filename,
3782 old_name, new_name, 0);
3783}
3784
Jeff King42bd39b2012-02-16 03:04:25 -05003785int git_config_rename_section(const char *old_name, const char *new_name)
3786{
Jeff King4a7bb5b2012-02-16 03:09:32 -05003787 return git_config_rename_section_in_file(NULL, old_name, new_name);
Jeff King42bd39b2012-02-16 03:04:25 -05003788}
3789
Sahil Dua52d59cc2017-06-18 23:19:16 +02003790int git_config_copy_section_in_file(const char *config_filename,
3791 const char *old_name, const char *new_name)
3792{
3793 return git_config_copy_or_rename_section_in_file(config_filename,
3794 old_name, new_name, 1);
3795}
3796
3797int git_config_copy_section(const char *old_name, const char *new_name)
3798{
3799 return git_config_copy_section_in_file(NULL, old_name, new_name);
3800}
3801
Junio C Hamano40ea4ed2008-02-11 10:41:18 -08003802/*
3803 * Call this to report error for your variable that should not
3804 * get a boolean value (i.e. "[my] var" means "true").
3805 */
Jeff Kinga469a102012-12-15 12:42:10 -05003806#undef config_error_nonbool
Junio C Hamano40ea4ed2008-02-11 10:41:18 -08003807int config_error_nonbool(const char *var)
3808{
Nguyễn Thái Ngọc Duya769bfc2018-07-21 09:49:27 +02003809 return error(_("missing value for '%s'"), var);
Junio C Hamano40ea4ed2008-02-11 10:41:18 -08003810}
Jeff King1b86bbb2013-01-23 01:23:05 -05003811
3812int parse_config_key(const char *var,
3813 const char *section,
Jeff Kingf5914f42020-04-10 15:44:28 -04003814 const char **subsection, size_t *subsection_len,
Jeff King1b86bbb2013-01-23 01:23:05 -05003815 const char **key)
3816{
Jeff King1b86bbb2013-01-23 01:23:05 -05003817 const char *dot;
3818
3819 /* Does it start with "section." ? */
Jeff Kinge3394fd2017-02-24 16:07:19 -05003820 if (!skip_prefix(var, section, &var) || *var != '.')
Jeff King1b86bbb2013-01-23 01:23:05 -05003821 return -1;
3822
3823 /*
3824 * Find the key; we don't know yet if we have a subsection, but we must
3825 * parse backwards from the end, since the subsection may have dots in
3826 * it, too.
3827 */
3828 dot = strrchr(var, '.');
3829 *key = dot + 1;
3830
3831 /* Did we have a subsection at all? */
Jeff Kinge3394fd2017-02-24 16:07:19 -05003832 if (dot == var) {
Jeff King48f8d9f2017-02-24 16:08:02 -05003833 if (subsection) {
3834 *subsection = NULL;
3835 *subsection_len = 0;
3836 }
Jeff King1b86bbb2013-01-23 01:23:05 -05003837 }
3838 else {
Jeff King48f8d9f2017-02-24 16:08:02 -05003839 if (!subsection)
3840 return -1;
Jeff Kinge3394fd2017-02-24 16:07:19 -05003841 *subsection = var + 1;
Jeff King1b86bbb2013-01-23 01:23:05 -05003842 *subsection_len = dot - *subsection;
3843 }
3844
3845 return 0;
3846}
Lars Schneider473166b2016-02-19 10:16:01 +01003847
Glen Choo6021e1d2023-06-28 19:26:23 +00003848const char *config_origin_type_name(enum config_origin_type type)
Glen Chooe2016502023-03-28 17:51:53 +00003849{
Vasco Almeida1b8132d2016-07-28 13:14:03 +00003850 switch (type) {
3851 case CONFIG_ORIGIN_BLOB:
3852 return "blob";
3853 case CONFIG_ORIGIN_FILE:
3854 return "file";
3855 case CONFIG_ORIGIN_STDIN:
3856 return "standard input";
3857 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3858 return "submodule-blob";
3859 case CONFIG_ORIGIN_CMDLINE:
3860 return "command line";
3861 default:
Johannes Schindelin033abf92018-05-02 11:38:39 +02003862 BUG("unknown config origin type");
Vasco Almeida1b8132d2016-07-28 13:14:03 +00003863 }
Lars Schneider473166b2016-02-19 10:16:01 +01003864}
3865
Matthew Rogersa5cb4202020-02-10 00:30:53 +00003866const char *config_scope_name(enum config_scope scope)
3867{
3868 switch (scope) {
3869 case CONFIG_SCOPE_SYSTEM:
3870 return "system";
3871 case CONFIG_SCOPE_GLOBAL:
3872 return "global";
Matthew Rogers6dc905d2020-02-10 00:30:54 +00003873 case CONFIG_SCOPE_LOCAL:
3874 return "local";
3875 case CONFIG_SCOPE_WORKTREE:
3876 return "worktree";
Matthew Rogers6766e412020-02-10 00:30:55 +00003877 case CONFIG_SCOPE_COMMAND:
3878 return "command";
Matthew Rogers9a83d082020-02-10 00:30:58 +00003879 case CONFIG_SCOPE_SUBMODULE:
3880 return "submodule";
Matthew Rogersa5cb4202020-02-10 00:30:53 +00003881 default:
3882 return "unknown";
3883 }
3884}
3885
Nguyễn Thái Ngọc Duya73b3682018-05-26 15:55:21 +02003886int lookup_config(const char **mapping, int nr_mapping, const char *var)
3887{
3888 int i;
3889
3890 for (i = 0; i < nr_mapping; i++) {
3891 const char *name = mapping[i];
3892
3893 if (name && !strcasecmp(var, name))
3894 return i;
3895 }
3896 return -1;
3897}