Merge branch 'main' of github.com:git/git
[alt-git.git] / environment.c
blob18d042b467d26a9cb3b228db1ef5afa2d903e72c
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.
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"
11 #include "branch.h"
12 #include "environment.h"
13 #include "repository.h"
14 #include "config.h"
15 #include "refs.h"
16 #include "fmt-merge-msg.h"
17 #include "commit.h"
18 #include "strvec.h"
19 #include "object-store.h"
20 #include "tmp-objdir.h"
21 #include "chdir-notify.h"
22 #include "shallow.h"
24 int trust_executable_bit = 1;
25 int trust_ctime = 1;
26 int check_stat = 1;
27 int has_symlinks = 1;
28 int minimum_abbrev = 4, default_abbrev = -1;
29 int ignore_case;
30 int assume_unchanged;
31 int prefer_symlink_refs;
32 int is_bare_repository_cfg = -1; /* unspecified */
33 int warn_ambiguous_refs = 1;
34 int warn_on_object_refname_ambiguity = 1;
35 int repository_format_precious_objects;
36 int repository_format_worktree_config;
37 const char *git_commit_encoding;
38 const char *git_log_output_encoding;
39 char *apply_default_whitespace;
40 char *apply_default_ignorewhitespace;
41 const char *git_attributes_file;
42 const char *git_hooks_path;
43 int zlib_compression_level = Z_BEST_SPEED;
44 int pack_compression_level = Z_DEFAULT_COMPRESSION;
45 int fsync_object_files = -1;
46 int use_fsync = -1;
47 enum fsync_method fsync_method = FSYNC_METHOD_DEFAULT;
48 enum fsync_component fsync_components = FSYNC_COMPONENTS_DEFAULT;
49 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
50 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
51 size_t delta_base_cache_limit = 96 * 1024 * 1024;
52 unsigned long big_file_threshold = 512 * 1024 * 1024;
53 int pager_use_color = 1;
54 const char *editor_program;
55 const char *askpass_program;
56 const char *excludes_file;
57 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
58 int read_replace_refs = 1;
59 enum eol core_eol = EOL_UNSET;
60 int global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
61 char *check_roundtrip_encoding = "SHIFT-JIS";
62 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
63 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
64 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
65 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
66 #ifndef OBJECT_CREATION_MODE
67 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
68 #endif
69 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
70 char *notes_ref_name;
71 int grafts_replace_parents = 1;
72 int core_apply_sparse_checkout;
73 int core_sparse_checkout_cone;
74 int sparse_expect_files_outside_of_patterns;
75 int merge_log_config = -1;
76 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
77 unsigned long pack_size_limit_cfg;
78 enum log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
80 #ifndef PROTECT_HFS_DEFAULT
81 #define PROTECT_HFS_DEFAULT 0
82 #endif
83 int protect_hfs = PROTECT_HFS_DEFAULT;
85 #ifndef PROTECT_NTFS_DEFAULT
86 #define PROTECT_NTFS_DEFAULT 1
87 #endif
88 int protect_ntfs = PROTECT_NTFS_DEFAULT;
91 * The character that begins a commented line in user-editable file
92 * that is subject to stripspace.
94 char comment_line_char = '#';
95 int auto_comment_line_char;
97 /* Parallel index stat data preload? */
98 int core_preload_index = 1;
100 /* This is set by setup_git_dir_gently() and/or git_default_config() */
101 char *git_work_tree_cfg;
103 static char *git_namespace;
105 static char *super_prefix;
108 * Repository-local GIT_* environment variables; see cache.h for details.
110 const char * const local_repo_env[] = {
111 ALTERNATE_DB_ENVIRONMENT,
112 CONFIG_ENVIRONMENT,
113 CONFIG_DATA_ENVIRONMENT,
114 CONFIG_COUNT_ENVIRONMENT,
115 DB_ENVIRONMENT,
116 GIT_DIR_ENVIRONMENT,
117 GIT_WORK_TREE_ENVIRONMENT,
118 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
119 GRAFT_ENVIRONMENT,
120 INDEX_ENVIRONMENT,
121 NO_REPLACE_OBJECTS_ENVIRONMENT,
122 GIT_REPLACE_REF_BASE_ENVIRONMENT,
123 GIT_PREFIX_ENVIRONMENT,
124 GIT_SUPER_PREFIX_ENVIRONMENT,
125 GIT_SHALLOW_FILE_ENVIRONMENT,
126 GIT_COMMON_DIR_ENVIRONMENT,
127 NULL
130 static char *expand_namespace(const char *raw_namespace)
132 struct strbuf buf = STRBUF_INIT;
133 struct strbuf **components, **c;
135 if (!raw_namespace || !*raw_namespace)
136 return xstrdup("");
138 strbuf_addstr(&buf, raw_namespace);
139 components = strbuf_split(&buf, '/');
140 strbuf_reset(&buf);
141 for (c = components; *c; c++)
142 if (strcmp((*c)->buf, "/") != 0)
143 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
144 strbuf_list_free(components);
145 if (check_refname_format(buf.buf, 0))
146 die(_("bad git namespace path \"%s\""), raw_namespace);
147 strbuf_addch(&buf, '/');
148 return strbuf_detach(&buf, NULL);
151 const char *getenv_safe(struct strvec *argv, const char *name)
153 const char *value = getenv(name);
155 if (!value)
156 return NULL;
158 strvec_push(argv, value);
159 return argv->v[argv->nr - 1];
162 void setup_git_env(const char *git_dir)
164 char *git_replace_ref_base;
165 const char *shallow_file;
166 const char *replace_ref_base;
167 struct set_gitdir_args args = { NULL };
168 struct strvec to_free = STRVEC_INIT;
170 args.commondir = getenv_safe(&to_free, GIT_COMMON_DIR_ENVIRONMENT);
171 args.object_dir = getenv_safe(&to_free, DB_ENVIRONMENT);
172 args.graft_file = getenv_safe(&to_free, GRAFT_ENVIRONMENT);
173 args.index_file = getenv_safe(&to_free, INDEX_ENVIRONMENT);
174 args.alternate_db = getenv_safe(&to_free, ALTERNATE_DB_ENVIRONMENT);
175 if (getenv(GIT_QUARANTINE_ENVIRONMENT)) {
176 args.disable_ref_updates = 1;
179 repo_set_gitdir(the_repository, git_dir, &args);
180 strvec_clear(&to_free);
182 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
183 read_replace_refs = 0;
184 replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
185 git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
186 : "refs/replace/");
187 update_ref_namespace(NAMESPACE_REPLACE, git_replace_ref_base);
189 free(git_namespace);
190 git_namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
191 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
192 if (shallow_file)
193 set_alternate_shallow_file(the_repository, shallow_file, 0);
196 int is_bare_repository(void)
198 /* if core.bare is not 'false', let's see if there is a work tree */
199 return is_bare_repository_cfg && !get_git_work_tree();
202 int have_git_dir(void)
204 return startup_info->have_repository
205 || the_repository->gitdir;
208 const char *get_git_dir(void)
210 if (!the_repository->gitdir)
211 BUG("git environment hasn't been setup");
212 return the_repository->gitdir;
215 const char *get_git_common_dir(void)
217 if (!the_repository->commondir)
218 BUG("git environment hasn't been setup");
219 return the_repository->commondir;
222 const char *get_git_namespace(void)
224 if (!git_namespace)
225 BUG("git environment hasn't been setup");
226 return git_namespace;
229 const char *strip_namespace(const char *namespaced_ref)
231 const char *out;
232 if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
233 return out;
234 return NULL;
237 const char *get_super_prefix(void)
239 static int initialized;
240 if (!initialized) {
241 super_prefix = xstrdup_or_null(getenv(GIT_SUPER_PREFIX_ENVIRONMENT));
242 initialized = 1;
244 return super_prefix;
247 static int git_work_tree_initialized;
250 * Note. This works only before you used a work tree. This was added
251 * primarily to support git-clone to work in a new repository it just
252 * created, and is not meant to flip between different work trees.
254 void set_git_work_tree(const char *new_work_tree)
256 if (git_work_tree_initialized) {
257 struct strbuf realpath = STRBUF_INIT;
259 strbuf_realpath(&realpath, new_work_tree, 1);
260 new_work_tree = realpath.buf;
261 if (strcmp(new_work_tree, the_repository->worktree))
262 die("internal error: work tree has already been set\n"
263 "Current worktree: %s\nNew worktree: %s",
264 the_repository->worktree, new_work_tree);
265 strbuf_release(&realpath);
266 return;
268 git_work_tree_initialized = 1;
269 repo_set_worktree(the_repository, new_work_tree);
272 const char *get_git_work_tree(void)
274 return the_repository->worktree;
277 const char *get_object_directory(void)
279 if (!the_repository->objects->odb)
280 BUG("git environment hasn't been setup");
281 return the_repository->objects->odb->path;
284 int odb_mkstemp(struct strbuf *temp_filename, const char *pattern)
286 int fd;
288 * we let the umask do its job, don't try to be more
289 * restrictive except to remove write permission.
291 int mode = 0444;
292 git_path_buf(temp_filename, "objects/%s", pattern);
293 fd = git_mkstemp_mode(temp_filename->buf, mode);
294 if (0 <= fd)
295 return fd;
297 /* slow path */
298 /* some mkstemp implementations erase temp_filename on failure */
299 git_path_buf(temp_filename, "objects/%s", pattern);
300 safe_create_leading_directories(temp_filename->buf);
301 return xmkstemp_mode(temp_filename->buf, mode);
304 int odb_pack_keep(const char *name)
306 int fd;
308 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
309 if (0 <= fd)
310 return fd;
312 /* slow path */
313 safe_create_leading_directories_const(name);
314 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
317 char *get_index_file(void)
319 if (!the_repository->index_file)
320 BUG("git environment hasn't been setup");
321 return the_repository->index_file;
324 char *get_graft_file(struct repository *r)
326 if (!r->graft_file)
327 BUG("git environment hasn't been setup");
328 return r->graft_file;
331 static void set_git_dir_1(const char *path)
333 xsetenv(GIT_DIR_ENVIRONMENT, path, 1);
334 setup_git_env(path);
337 static void update_relative_gitdir(const char *name UNUSED,
338 const char *old_cwd,
339 const char *new_cwd,
340 void *data UNUSED)
342 char *path = reparent_relative_path(old_cwd, new_cwd, get_git_dir());
343 struct tmp_objdir *tmp_objdir = tmp_objdir_unapply_primary_odb();
345 trace_printf_key(&trace_setup_key,
346 "setup: move $GIT_DIR to '%s'",
347 path);
348 set_git_dir_1(path);
349 if (tmp_objdir)
350 tmp_objdir_reapply_primary_odb(tmp_objdir, old_cwd, new_cwd);
351 free(path);
354 void set_git_dir(const char *path, int make_realpath)
356 struct strbuf realpath = STRBUF_INIT;
358 if (make_realpath) {
359 strbuf_realpath(&realpath, path, 1);
360 path = realpath.buf;
363 set_git_dir_1(path);
364 if (!is_absolute_path(path))
365 chdir_notify_register(NULL, update_relative_gitdir, NULL);
367 strbuf_release(&realpath);
370 const char *get_log_output_encoding(void)
372 return git_log_output_encoding ? git_log_output_encoding
373 : get_commit_output_encoding();
376 const char *get_commit_output_encoding(void)
378 return git_commit_encoding ? git_commit_encoding : "UTF-8";
381 static int the_shared_repository = PERM_UMASK;
382 static int need_shared_repository_from_config = 1;
384 void set_shared_repository(int value)
386 the_shared_repository = value;
387 need_shared_repository_from_config = 0;
390 int get_shared_repository(void)
392 if (need_shared_repository_from_config) {
393 const char *var = "core.sharedrepository";
394 const char *value;
395 if (!git_config_get_value(var, &value))
396 the_shared_repository = git_config_perm(var, value);
397 need_shared_repository_from_config = 0;
399 return the_shared_repository;
402 void reset_shared_repository(void)
404 need_shared_repository_from_config = 1;
407 int use_optional_locks(void)
409 return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
412 int print_sha1_ellipsis(void)
415 * Determine if the calling environment contains the variable
416 * GIT_PRINT_SHA1_ELLIPSIS set to "yes".
418 static int cached_result = -1; /* unknown */
420 if (cached_result < 0) {
421 const char *v = getenv("GIT_PRINT_SHA1_ELLIPSIS");
422 cached_result = (v && !strcasecmp(v, "yes"));
424 return cached_result;