Merge branch 'sb/object-store-replace'
[git/git.git] / environment.c
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"
11 #include "repository.h"
12 #include "config.h"
13 #include "refs.h"
14 #include "fmt-merge-msg.h"
15 #include "commit.h"
16 #include "argv-array.h"
17 #include "object-store.h"
18 #include "chdir-notify.h"
19
20 int trust_executable_bit = 1;
21 int trust_ctime = 1;
22 int check_stat = 1;
23 int has_symlinks = 1;
24 int minimum_abbrev = 4, default_abbrev = -1;
25 int ignore_case;
26 int assume_unchanged;
27 int prefer_symlink_refs;
28 int is_bare_repository_cfg = -1; /* unspecified */
29 int warn_ambiguous_refs = 1;
30 int warn_on_object_refname_ambiguity = 1;
31 int ref_paranoia = -1;
32 int repository_format_precious_objects;
33 char *repository_format_partial_clone;
34 const char *core_partial_clone_filter_default;
35 const char *git_commit_encoding;
36 const char *git_log_output_encoding;
37 const char *apply_default_whitespace;
38 const char *apply_default_ignorewhitespace;
39 const char *git_attributes_file;
40 const char *git_hooks_path;
41 int zlib_compression_level = Z_BEST_SPEED;
42 int core_compression_level;
43 int pack_compression_level = Z_DEFAULT_COMPRESSION;
44 int fsync_object_files;
45 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
46 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
47 size_t delta_base_cache_limit = 96 * 1024 * 1024;
48 unsigned long big_file_threshold = 512 * 1024 * 1024;
49 int pager_use_color = 1;
50 const char *editor_program;
51 const char *askpass_program;
52 const char *excludes_file;
53 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
54 int check_replace_refs = 1; /* NEEDSWORK: rename to read_replace_refs */
55 char *git_replace_ref_base;
56 enum eol core_eol = EOL_UNSET;
57 int global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
58 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
59 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
60 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
61 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
62 #ifndef OBJECT_CREATION_MODE
63 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
64 #endif
65 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
66 char *notes_ref_name;
67 int grafts_replace_parents = 1;
68 int core_commit_graph;
69 int core_apply_sparse_checkout;
70 int merge_log_config = -1;
71 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
72 unsigned long pack_size_limit_cfg;
73 enum hide_dotfiles_type hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
74 enum log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
75
76 #ifndef PROTECT_HFS_DEFAULT
77 #define PROTECT_HFS_DEFAULT 0
78 #endif
79 int protect_hfs = PROTECT_HFS_DEFAULT;
80
81 #ifndef PROTECT_NTFS_DEFAULT
82 #define PROTECT_NTFS_DEFAULT 0
83 #endif
84 int protect_ntfs = PROTECT_NTFS_DEFAULT;
85 const char *core_fsmonitor;
86
87 /*
88 * The character that begins a commented line in user-editable file
89 * that is subject to stripspace.
90 */
91 char comment_line_char = '#';
92 int auto_comment_line_char;
93
94 /* Parallel index stat data preload? */
95 int core_preload_index = 1;
96
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 */
102 int ignore_untracked_cache_config;
103
104 /* This is set by setup_git_dir_gently() and/or git_default_config() */
105 char *git_work_tree_cfg;
106
107 static char *git_namespace;
108
109 static const char *super_prefix;
110
111 /*
112 * Repository-local GIT_* environment variables; see cache.h for details.
113 */
114 const char * const local_repo_env[] = {
115 ALTERNATE_DB_ENVIRONMENT,
116 CONFIG_ENVIRONMENT,
117 CONFIG_DATA_ENVIRONMENT,
118 DB_ENVIRONMENT,
119 GIT_DIR_ENVIRONMENT,
120 GIT_WORK_TREE_ENVIRONMENT,
121 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
122 GRAFT_ENVIRONMENT,
123 INDEX_ENVIRONMENT,
124 NO_REPLACE_OBJECTS_ENVIRONMENT,
125 GIT_REPLACE_REF_BASE_ENVIRONMENT,
126 GIT_PREFIX_ENVIRONMENT,
127 GIT_SUPER_PREFIX_ENVIRONMENT,
128 GIT_SHALLOW_FILE_ENVIRONMENT,
129 GIT_COMMON_DIR_ENVIRONMENT,
130 NULL
131 };
132
133 static 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);
148 if (check_refname_format(buf.buf, 0))
149 die("bad git namespace path \"%s\"", raw_namespace);
150 strbuf_addch(&buf, '/');
151 return strbuf_detach(&buf, NULL);
152 }
153
154 /*
155 * Wrapper of getenv() that returns a strdup value. This value is kept
156 * in argv to be freed later.
157 */
158 static 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
169 void setup_git_env(const char *git_dir)
170 {
171 const char *shallow_file;
172 const char *replace_ref_base;
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);
180 args.alternate_db = getenv_safe(&to_free, ALTERNATE_DB_ENVIRONMENT);
181 repo_set_gitdir(the_repository, git_dir, &args);
182 argv_array_clear(&to_free);
183
184 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
185 check_replace_refs = 0;
186 replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
187 free(git_replace_ref_base);
188 git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
189 : "refs/replace/");
190 free(git_namespace);
191 git_namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
192 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
193 if (shallow_file)
194 set_alternate_shallow_file(shallow_file, 0);
195 }
196
197 int is_bare_repository(void)
198 {
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();
201 }
202
203 int have_git_dir(void)
204 {
205 return startup_info->have_repository
206 || the_repository->gitdir;
207 }
208
209 const char *get_git_dir(void)
210 {
211 if (!the_repository->gitdir)
212 BUG("git environment hasn't been setup");
213 return the_repository->gitdir;
214 }
215
216 const char *get_git_common_dir(void)
217 {
218 if (!the_repository->commondir)
219 BUG("git environment hasn't been setup");
220 return the_repository->commondir;
221 }
222
223 const char *get_git_namespace(void)
224 {
225 if (!git_namespace)
226 BUG("git environment hasn't been setup");
227 return git_namespace;
228 }
229
230 const char *strip_namespace(const char *namespaced_ref)
231 {
232 const char *out;
233 if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
234 return out;
235 return NULL;
236 }
237
238 const 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
248 static 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 */
255 void set_git_work_tree(const char *new_work_tree)
256 {
257 if (git_work_tree_initialized) {
258 new_work_tree = real_path(new_work_tree);
259 if (strcmp(new_work_tree, the_repository->worktree))
260 die("internal error: work tree has already been set\n"
261 "Current worktree: %s\nNew worktree: %s",
262 the_repository->worktree, new_work_tree);
263 return;
264 }
265 git_work_tree_initialized = 1;
266 repo_set_worktree(the_repository, new_work_tree);
267 }
268
269 const char *get_git_work_tree(void)
270 {
271 return the_repository->worktree;
272 }
273
274 char *get_object_directory(void)
275 {
276 if (!the_repository->objects->objectdir)
277 BUG("git environment hasn't been setup");
278 return the_repository->objects->objectdir;
279 }
280
281 int odb_mkstemp(struct strbuf *temp_filename, const char *pattern)
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;
289 git_path_buf(temp_filename, "objects/%s", pattern);
290 fd = git_mkstemp_mode(temp_filename->buf, mode);
291 if (0 <= fd)
292 return fd;
293
294 /* slow path */
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);
299 }
300
301 int odb_pack_keep(const char *name)
302 {
303 int fd;
304
305 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
306 if (0 <= fd)
307 return fd;
308
309 /* slow path */
310 safe_create_leading_directories_const(name);
311 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
312 }
313
314 char *get_index_file(void)
315 {
316 if (!the_repository->index_file)
317 BUG("git environment hasn't been setup");
318 return the_repository->index_file;
319 }
320
321 char *get_graft_file(void)
322 {
323 if (!the_repository->graft_file)
324 BUG("git environment hasn't been setup");
325 return the_repository->graft_file;
326 }
327
328 static void set_git_dir_1(const char *path)
329 {
330 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
331 die("could not set GIT_DIR to '%s'", path);
332 setup_git_env(path);
333 }
334
335 static 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
348 void 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);
353 }
354
355 const char *get_log_output_encoding(void)
356 {
357 return git_log_output_encoding ? git_log_output_encoding
358 : get_commit_output_encoding();
359 }
360
361 const char *get_commit_output_encoding(void)
362 {
363 return git_commit_encoding ? git_commit_encoding : "UTF-8";
364 }
365
366 static int the_shared_repository = PERM_UMASK;
367 static int need_shared_repository_from_config = 1;
368
369 void set_shared_repository(int value)
370 {
371 the_shared_repository = value;
372 need_shared_repository_from_config = 0;
373 }
374
375 int get_shared_repository(void)
376 {
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 }
384 return the_shared_repository;
385 }
386
387 void reset_shared_repository(void)
388 {
389 need_shared_repository_from_config = 1;
390 }
391
392 int use_optional_locks(void)
393 {
394 return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
395 }
396
397 int 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 }