alloc: make allocate_alloc_state and clear_alloc_state more consistent
[git/git.git] / environment.c
CommitLineData
e1b10391
LT
1/*
2 * We put all the git config variables in this same object
3 * file, so that programs can link against the config parser
4 * without having to link against all the rest of git.
5 *
6 * In particular, no need to bring in libz etc unless needed,
7 * even if you might want to know where the git directory etc
8 * are.
9 */
10#include "cache.h"
c14c234f 11#include "repository.h"
b2141fc1 12#include "config.h"
a1bea2c1 13#include "refs.h"
273c7032 14#include "fmt-merge-msg.h"
069c0532 15#include "commit.h"
357a03eb 16#include "argv-array.h"
90c62155 17#include "object-store.h"
8500e0de 18#include "chdir-notify.h"
e1b10391 19
e1b10391 20int trust_executable_bit = 1;
1ce4790b 21int trust_ctime = 1;
c08e4d5b 22int check_stat = 1;
78a8d641 23int has_symlinks = 1;
e6c587c7 24int minimum_abbrev = 4, default_abbrev = -1;
0a9b88b7 25int ignore_case;
96f1e58f
DR
26int assume_unchanged;
27int prefer_symlink_refs;
7d1864ce 28int is_bare_repository_cfg = -1; /* unspecified */
1b371f56 29int warn_ambiguous_refs = 1;
25fba78d 30int warn_on_object_refname_ambiguity = 1;
49672f26 31int ref_paranoia = -1;
067fbd41 32int repository_format_precious_objects;
75b97fec 33char *repository_format_partial_clone;
1e1e39b3 34const char *core_partial_clone_filter_default;
1a8f2741 35const char *git_commit_encoding;
3a55602e 36const char *git_log_output_encoding;
96f1e58f 37const char *apply_default_whitespace;
86c91f91 38const char *apply_default_ignorewhitespace;
64589a03 39const char *git_attributes_file;
867ad08a 40const char *git_hooks_path;
960ccca6
DH
41int zlib_compression_level = Z_BEST_SPEED;
42int core_compression_level;
8de7eeb5 43int pack_compression_level = Z_DEFAULT_COMPRESSION;
aafe9fba 44int fsync_object_files;
8c82534d
SP
45size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
46size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
4874f544 47size_t delta_base_cache_limit = 96 * 1024 * 1024;
15366280 48unsigned long big_file_threshold = 512 * 1024 * 1024;
aa086eb8 49int pager_use_color = 1;
ee9601e6 50const char *editor_program;
d3e7da89 51const char *askpass_program;
dfb068be 52const char *excludes_file;
fd6cce9e 53enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
c3c36d7d 54int check_replace_refs = 1; /* NEEDSWORK: rename to read_replace_refs */
58d121b2 55char *git_replace_ref_base;
ec70f52f 56enum eol core_eol = EOL_UNSET;
8462ff43 57int global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
e92d6225 58char *check_roundtrip_encoding = "SHIFT-JIS";
cf1b7869 59unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
9ed36cfa 60enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
c998ae9b 61enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
f25950f3 62enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
348df166
JS
63#ifndef OBJECT_CREATION_MODE
64#define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
be66a6c4 65#endif
348df166 66enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
a97a7468 67char *notes_ref_name;
7f3140cd 68int grafts_replace_parents = 1;
08aefc9e 69int core_apply_sparse_checkout;
898eacd8 70int merge_log_config = -1;
76759c7d 71int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
568508e7 72unsigned long pack_size_limit_cfg;
f30afdab 73enum hide_dotfiles_type hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
341fb286 74enum log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
e1b10391 75
a42643aa
JK
76#ifndef PROTECT_HFS_DEFAULT
77#define PROTECT_HFS_DEFAULT 0
78#endif
79int protect_hfs = PROTECT_HFS_DEFAULT;
80
2b4c6efc
JS
81#ifndef PROTECT_NTFS_DEFAULT
82#define PROTECT_NTFS_DEFAULT 0
83#endif
84int protect_ntfs = PROTECT_NTFS_DEFAULT;
883e248b 85const char *core_fsmonitor;
2b4c6efc 86
eff80a9f
JH
87/*
88 * The character that begins a commented line in user-editable file
89 * that is subject to stripspace.
90 */
91char comment_line_char = '#';
84c9dc2c 92int auto_comment_line_char;
eff80a9f 93
671c9b7e 94/* Parallel index stat data preload? */
299e2987 95int core_preload_index = 1;
671c9b7e 96
dae6c322
CC
97/*
98 * This is a hack for test programs like test-dump-untracked-cache to
99 * ensure that they do not modify the untracked cache when reading it.
100 * Do not use it otherwise!
101 */
102int ignore_untracked_cache_config;
103
e90fdc39
JS
104/* This is set by setup_git_dir_gently() and/or git_default_config() */
105char *git_work_tree_cfg;
e90fdc39 106
38f3f094 107static char *git_namespace;
a1bea2c1 108
74866d75
BW
109static const char *super_prefix;
110
48a7c1c4 111/*
2163e5db 112 * Repository-local GIT_* environment variables; see cache.h for details.
48a7c1c4 113 */
2163e5db 114const char * const local_repo_env[] = {
48a7c1c4
GB
115 ALTERNATE_DB_ENVIRONMENT,
116 CONFIG_ENVIRONMENT,
655e8d9c 117 CONFIG_DATA_ENVIRONMENT,
48a7c1c4
GB
118 DB_ENVIRONMENT,
119 GIT_DIR_ENVIRONMENT,
120 GIT_WORK_TREE_ENVIRONMENT,
2cd83d10 121 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
48a7c1c4
GB
122 GRAFT_ENVIRONMENT,
123 INDEX_ENVIRONMENT,
124 NO_REPLACE_OBJECTS_ENVIRONMENT,
58d121b2 125 GIT_REPLACE_REF_BASE_ENVIRONMENT,
a6f7f9a3 126 GIT_PREFIX_ENVIRONMENT,
74866d75 127 GIT_SUPER_PREFIX_ENVIRONMENT,
069c0532 128 GIT_SHALLOW_FILE_ENVIRONMENT,
c7b3a3d2 129 GIT_COMMON_DIR_ENVIRONMENT,
48a7c1c4
GB
130 NULL
131};
132
a1bea2c1
JT
133static char *expand_namespace(const char *raw_namespace)
134{
135 struct strbuf buf = STRBUF_INIT;
136 struct strbuf **components, **c;
137
138 if (!raw_namespace || !*raw_namespace)
139 return xstrdup("");
140
141 strbuf_addstr(&buf, raw_namespace);
142 components = strbuf_split(&buf, '/');
143 strbuf_reset(&buf);
144 for (c = components; *c; c++)
145 if (strcmp((*c)->buf, "/") != 0)
146 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
147 strbuf_list_free(components);
8d9c5010 148 if (check_refname_format(buf.buf, 0))
a1bea2c1
JT
149 die("bad git namespace path \"%s\"", raw_namespace);
150 strbuf_addch(&buf, '/');
151 return strbuf_detach(&buf, NULL);
152}
153
357a03eb
NTND
154/*
155 * Wrapper of getenv() that returns a strdup value. This value is kept
156 * in argv to be freed later.
157 */
158static const char *getenv_safe(struct argv_array *argv, const char *name)
159{
160 const char *value = getenv(name);
161
162 if (!value)
163 return NULL;
164
165 argv_array_push(argv, value);
166 return argv->argv[argv->argc - 1];
167}
168
169void setup_git_env(const char *git_dir)
e1b10391 170{
069c0532 171 const char *shallow_file;
58d121b2 172 const char *replace_ref_base;
357a03eb
NTND
173 struct set_gitdir_args args = { NULL };
174 struct argv_array to_free = ARGV_ARRAY_INIT;
175
176 args.commondir = getenv_safe(&to_free, GIT_COMMON_DIR_ENVIRONMENT);
177 args.object_dir = getenv_safe(&to_free, DB_ENVIRONMENT);
178 args.graft_file = getenv_safe(&to_free, GRAFT_ENVIRONMENT);
179 args.index_file = getenv_safe(&to_free, INDEX_ENVIRONMENT);
7bc0dcaa 180 args.alternate_db = getenv_safe(&to_free, ALTERNATE_DB_ENVIRONMENT);
357a03eb
NTND
181 repo_set_gitdir(the_repository, git_dir, &args);
182 argv_array_clear(&to_free);
487a2b73 183
6476b38b 184 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
afc711b8 185 check_replace_refs = 0;
58d121b2 186 replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
f9b7573f 187 free(git_replace_ref_base);
58d121b2
MH
188 git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
189 : "refs/replace/");
38f3f094
BW
190 free(git_namespace);
191 git_namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
069c0532
NTND
192 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
193 if (shallow_file)
6a2df51c 194 set_alternate_shallow_file(the_repository, shallow_file, 0);
0bee5918
SP
195}
196
7d1864ce 197int is_bare_repository(void)
0bee5918 198{
e90fdc39
JS
199 /* if core.bare is not 'false', let's see if there is a work tree */
200 return is_bare_repository_cfg && !get_git_work_tree();
e1b10391
LT
201}
202
b9605bc4
JK
203int have_git_dir(void)
204{
205 return startup_info->have_repository
c14c234f 206 || the_repository->gitdir;
b9605bc4
JK
207}
208
c5fba16c 209const char *get_git_dir(void)
e1b10391 210{
c14c234f 211 if (!the_repository->gitdir)
73f192c9 212 BUG("git environment hasn't been setup");
c14c234f 213 return the_repository->gitdir;
e1b10391
LT
214}
215
c7b3a3d2
NTND
216const char *get_git_common_dir(void)
217{
c14c234f 218 if (!the_repository->commondir)
73f192c9 219 BUG("git environment hasn't been setup");
c14c234f 220 return the_repository->commondir;
c7b3a3d2
NTND
221}
222
a1bea2c1
JT
223const char *get_git_namespace(void)
224{
38f3f094 225 if (!git_namespace)
73f192c9 226 BUG("git environment hasn't been setup");
38f3f094 227 return git_namespace;
a1bea2c1
JT
228}
229
230const char *strip_namespace(const char *namespaced_ref)
231{
bf08c8cf
BW
232 const char *out;
233 if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
234 return out;
235 return NULL;
a1bea2c1
JT
236}
237
74866d75
BW
238const char *get_super_prefix(void)
239{
240 static int initialized;
241 if (!initialized) {
242 super_prefix = getenv(GIT_SUPER_PREFIX_ENVIRONMENT);
243 initialized = 1;
244 }
245 return super_prefix;
246}
247
19757d80
DB
248static int git_work_tree_initialized;
249
250/*
251 * Note. This works only before you used a work tree. This was added
252 * primarily to support git-clone to work in a new repository it just
253 * created, and is not meant to flip between different work trees.
254 */
255void set_git_work_tree(const char *new_work_tree)
256{
83518360 257 if (git_work_tree_initialized) {
e2a57aac 258 new_work_tree = real_path(new_work_tree);
b4158732 259 if (strcmp(new_work_tree, the_repository->worktree))
83518360
NTND
260 die("internal error: work tree has already been set\n"
261 "Current worktree: %s\nNew worktree: %s",
b4158732 262 the_repository->worktree, new_work_tree);
83518360
NTND
263 return;
264 }
19757d80 265 git_work_tree_initialized = 1;
b4158732 266 repo_set_worktree(the_repository, new_work_tree);
19757d80
DB
267}
268
e90fdc39
JS
269const char *get_git_work_tree(void)
270{
b4158732 271 return the_repository->worktree;
e90fdc39
JS
272}
273
e1b10391
LT
274char *get_object_directory(void)
275{
90c62155 276 if (!the_repository->objects->objectdir)
73f192c9 277 BUG("git environment hasn't been setup");
90c62155 278 return the_repository->objects->objectdir;
e1b10391
LT
279}
280
a63b5fca 281int odb_mkstemp(struct strbuf *temp_filename, const char *pattern)
463db9b1
JN
282{
283 int fd;
284 /*
285 * we let the umask do its job, don't try to be more
286 * restrictive except to remove write permission.
287 */
288 int mode = 0444;
a63b5fca
BW
289 git_path_buf(temp_filename, "objects/%s", pattern);
290 fd = git_mkstemp_mode(temp_filename->buf, mode);
463db9b1
JN
291 if (0 <= fd)
292 return fd;
293
294 /* slow path */
a63b5fca
BW
295 /* some mkstemp implementations erase temp_filename on failure */
296 git_path_buf(temp_filename, "objects/%s", pattern);
297 safe_create_leading_directories(temp_filename->buf);
298 return xmkstemp_mode(temp_filename->buf, mode);
463db9b1
JN
299}
300
eaeefc32 301int odb_pack_keep(const char *name)
463db9b1
JN
302{
303 int fd;
304
463db9b1
JN
305 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
306 if (0 <= fd)
307 return fd;
308
309 /* slow path */
eaeefc32 310 safe_create_leading_directories_const(name);
463db9b1
JN
311 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
312}
313
e1b10391
LT
314char *get_index_file(void)
315{
c14c234f 316 if (!the_repository->index_file)
73f192c9 317 BUG("git environment hasn't been setup");
c14c234f 318 return the_repository->index_file;
e1b10391
LT
319}
320
0437a2e3 321char *get_graft_file(struct repository *r)
e1b10391 322{
0437a2e3 323 if (!r->graft_file)
73f192c9 324 BUG("git environment hasn't been setup");
0437a2e3 325 return r->graft_file;
e1b10391 326}
d7ac12b2 327
8500e0de 328static void set_git_dir_1(const char *path)
d7ac12b2
JS
329{
330 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
48988c4d 331 die("could not set GIT_DIR to '%s'", path);
357a03eb 332 setup_git_env(path);
d7ac12b2 333}
a6fa5992 334
8500e0de
JK
335static void update_relative_gitdir(const char *name,
336 const char *old_cwd,
337 const char *new_cwd,
338 void *data)
339{
340 char *path = reparent_relative_path(old_cwd, new_cwd, get_git_dir());
341 trace_printf_key(&trace_setup_key,
342 "setup: move $GIT_DIR to '%s'",
343 path);
344 set_git_dir_1(path);
345 free(path);
346}
347
348void set_git_dir(const char *path)
349{
350 set_git_dir_1(path);
351 if (!is_absolute_path(path))
352 chdir_notify_register(NULL, update_relative_gitdir, NULL);
d7ac12b2 353}
a6fa5992
PN
354
355const char *get_log_output_encoding(void)
356{
357 return git_log_output_encoding ? git_log_output_encoding
358 : get_commit_output_encoding();
359}
360
361const char *get_commit_output_encoding(void)
362{
363 return git_commit_encoding ? git_commit_encoding : "UTF-8";
364}
7875acb6
JK
365
366static int the_shared_repository = PERM_UMASK;
ae5f6776 367static int need_shared_repository_from_config = 1;
7875acb6
JK
368
369void set_shared_repository(int value)
370{
371 the_shared_repository = value;
ae5f6776 372 need_shared_repository_from_config = 0;
7875acb6
JK
373}
374
375int get_shared_repository(void)
376{
ae5f6776
JK
377 if (need_shared_repository_from_config) {
378 const char *var = "core.sharedrepository";
379 const char *value;
380 if (!git_config_get_value(var, &value))
381 the_shared_repository = git_config_perm(var, value);
382 need_shared_repository_from_config = 0;
383 }
7875acb6
JK
384 return the_shared_repository;
385}
4543926b
JK
386
387void reset_shared_repository(void)
388{
389 need_shared_repository_from_config = 1;
390}
27344d6a
JK
391
392int use_optional_locks(void)
393{
394 return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
395}
a2cd709d
AR
396
397int print_sha1_ellipsis(void)
398{
399 /*
400 * Determine if the calling environment contains the variable
401 * GIT_PRINT_SHA1_ELLIPSIS set to "yes".
402 */
403 static int cached_result = -1; /* unknown */
404
405 if (cached_result < 0) {
406 const char *v = getenv("GIT_PRINT_SHA1_ELLIPSIS");
407 cached_result = (v && !strcasecmp(v, "yes"));
408 }
409 return cached_result;
410}