Merge branch 'dl/cocci-everywhere'
[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 "branch.h"
12 #include "repository.h"
13 #include "config.h"
14 #include "refs.h"
15 #include "fmt-merge-msg.h"
16 #include "commit.h"
17 #include "argv-array.h"
18 #include "object-store.h"
19 #include "chdir-notify.h"
20
21 int trust_executable_bit = 1;
22 int trust_ctime = 1;
23 int check_stat = 1;
24 int has_symlinks = 1;
25 int minimum_abbrev = 4, default_abbrev = -1;
26 int ignore_case;
27 int assume_unchanged;
28 int prefer_symlink_refs;
29 int is_bare_repository_cfg = -1; /* unspecified */
30 int warn_ambiguous_refs = 1;
31 int warn_on_object_refname_ambiguity = 1;
32 int ref_paranoia = -1;
33 int repository_format_precious_objects;
34 int repository_format_worktree_config;
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 read_replace_refs = 1;
55 char *git_replace_ref_base;
56 enum eol core_eol = EOL_UNSET;
57 int global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
58 char *check_roundtrip_encoding = "SHIFT-JIS";
59 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
60 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
61 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
62 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
63 #ifndef OBJECT_CREATION_MODE
64 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
65 #endif
66 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
67 char *notes_ref_name;
68 int grafts_replace_parents = 1;
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 log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
74
75 #ifndef PROTECT_HFS_DEFAULT
76 #define PROTECT_HFS_DEFAULT 0
77 #endif
78 int protect_hfs = PROTECT_HFS_DEFAULT;
79
80 #ifndef PROTECT_NTFS_DEFAULT
81 #define PROTECT_NTFS_DEFAULT 0
82 #endif
83 int protect_ntfs = PROTECT_NTFS_DEFAULT;
84 const char *core_fsmonitor;
85
86 /*
87 * The character that begins a commented line in user-editable file
88 * that is subject to stripspace.
89 */
90 char comment_line_char = '#';
91 int auto_comment_line_char;
92
93 /* Parallel index stat data preload? */
94 int core_preload_index = 1;
95
96 /*
97 * This is a hack for test programs like test-dump-untracked-cache to
98 * ensure that they do not modify the untracked cache when reading it.
99 * Do not use it otherwise!
100 */
101 int ignore_untracked_cache_config;
102
103 /* This is set by setup_git_dir_gently() and/or git_default_config() */
104 char *git_work_tree_cfg;
105
106 static char *git_namespace;
107
108 static char *super_prefix;
109
110 /*
111 * Repository-local GIT_* environment variables; see cache.h for details.
112 */
113 const char * const local_repo_env[] = {
114 ALTERNATE_DB_ENVIRONMENT,
115 CONFIG_ENVIRONMENT,
116 CONFIG_DATA_ENVIRONMENT,
117 DB_ENVIRONMENT,
118 GIT_DIR_ENVIRONMENT,
119 GIT_WORK_TREE_ENVIRONMENT,
120 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
121 GRAFT_ENVIRONMENT,
122 INDEX_ENVIRONMENT,
123 NO_REPLACE_OBJECTS_ENVIRONMENT,
124 GIT_REPLACE_REF_BASE_ENVIRONMENT,
125 GIT_PREFIX_ENVIRONMENT,
126 GIT_SUPER_PREFIX_ENVIRONMENT,
127 GIT_SHALLOW_FILE_ENVIRONMENT,
128 GIT_COMMON_DIR_ENVIRONMENT,
129 NULL
130 };
131
132 static char *expand_namespace(const char *raw_namespace)
133 {
134 struct strbuf buf = STRBUF_INIT;
135 struct strbuf **components, **c;
136
137 if (!raw_namespace || !*raw_namespace)
138 return xstrdup("");
139
140 strbuf_addstr(&buf, raw_namespace);
141 components = strbuf_split(&buf, '/');
142 strbuf_reset(&buf);
143 for (c = components; *c; c++)
144 if (strcmp((*c)->buf, "/") != 0)
145 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
146 strbuf_list_free(components);
147 if (check_refname_format(buf.buf, 0))
148 die(_("bad git namespace path \"%s\""), raw_namespace);
149 strbuf_addch(&buf, '/');
150 return strbuf_detach(&buf, NULL);
151 }
152
153 /*
154 * Wrapper of getenv() that returns a strdup value. This value is kept
155 * in argv to be freed later.
156 */
157 static const char *getenv_safe(struct argv_array *argv, const char *name)
158 {
159 const char *value = getenv(name);
160
161 if (!value)
162 return NULL;
163
164 argv_array_push(argv, value);
165 return argv->argv[argv->argc - 1];
166 }
167
168 void setup_git_env(const char *git_dir)
169 {
170 const char *shallow_file;
171 const char *replace_ref_base;
172 struct set_gitdir_args args = { NULL };
173 struct argv_array to_free = ARGV_ARRAY_INIT;
174
175 args.commondir = getenv_safe(&to_free, GIT_COMMON_DIR_ENVIRONMENT);
176 args.object_dir = getenv_safe(&to_free, DB_ENVIRONMENT);
177 args.graft_file = getenv_safe(&to_free, GRAFT_ENVIRONMENT);
178 args.index_file = getenv_safe(&to_free, INDEX_ENVIRONMENT);
179 args.alternate_db = getenv_safe(&to_free, ALTERNATE_DB_ENVIRONMENT);
180 repo_set_gitdir(the_repository, git_dir, &args);
181 argv_array_clear(&to_free);
182
183 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
184 read_replace_refs = 0;
185 replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
186 free(git_replace_ref_base);
187 git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
188 : "refs/replace/");
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);
194 }
195
196 int is_bare_repository(void)
197 {
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();
200 }
201
202 int have_git_dir(void)
203 {
204 return startup_info->have_repository
205 || the_repository->gitdir;
206 }
207
208 const char *get_git_dir(void)
209 {
210 if (!the_repository->gitdir)
211 BUG("git environment hasn't been setup");
212 return the_repository->gitdir;
213 }
214
215 const char *get_git_common_dir(void)
216 {
217 if (!the_repository->commondir)
218 BUG("git environment hasn't been setup");
219 return the_repository->commondir;
220 }
221
222 const char *get_git_namespace(void)
223 {
224 if (!git_namespace)
225 BUG("git environment hasn't been setup");
226 return git_namespace;
227 }
228
229 const char *strip_namespace(const char *namespaced_ref)
230 {
231 const char *out;
232 if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
233 return out;
234 return NULL;
235 }
236
237 const char *get_super_prefix(void)
238 {
239 static int initialized;
240 if (!initialized) {
241 super_prefix = xstrdup_or_null(getenv(GIT_SUPER_PREFIX_ENVIRONMENT));
242 initialized = 1;
243 }
244 return super_prefix;
245 }
246
247 static int git_work_tree_initialized;
248
249 /*
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.
253 */
254 void set_git_work_tree(const char *new_work_tree)
255 {
256 if (git_work_tree_initialized) {
257 new_work_tree = real_path(new_work_tree);
258 if (strcmp(new_work_tree, the_repository->worktree))
259 die("internal error: work tree has already been set\n"
260 "Current worktree: %s\nNew worktree: %s",
261 the_repository->worktree, new_work_tree);
262 return;
263 }
264 git_work_tree_initialized = 1;
265 repo_set_worktree(the_repository, new_work_tree);
266 }
267
268 const char *get_git_work_tree(void)
269 {
270 return the_repository->worktree;
271 }
272
273 char *get_object_directory(void)
274 {
275 if (!the_repository->objects->odb)
276 BUG("git environment hasn't been setup");
277 return the_repository->objects->odb->path;
278 }
279
280 int odb_mkstemp(struct strbuf *temp_filename, const char *pattern)
281 {
282 int fd;
283 /*
284 * we let the umask do its job, don't try to be more
285 * restrictive except to remove write permission.
286 */
287 int mode = 0444;
288 git_path_buf(temp_filename, "objects/%s", pattern);
289 fd = git_mkstemp_mode(temp_filename->buf, mode);
290 if (0 <= fd)
291 return fd;
292
293 /* slow path */
294 /* some mkstemp implementations erase temp_filename on failure */
295 git_path_buf(temp_filename, "objects/%s", pattern);
296 safe_create_leading_directories(temp_filename->buf);
297 return xmkstemp_mode(temp_filename->buf, mode);
298 }
299
300 int odb_pack_keep(const char *name)
301 {
302 int fd;
303
304 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
305 if (0 <= fd)
306 return fd;
307
308 /* slow path */
309 safe_create_leading_directories_const(name);
310 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
311 }
312
313 char *get_index_file(void)
314 {
315 if (!the_repository->index_file)
316 BUG("git environment hasn't been setup");
317 return the_repository->index_file;
318 }
319
320 char *get_graft_file(struct repository *r)
321 {
322 if (!r->graft_file)
323 BUG("git environment hasn't been setup");
324 return r->graft_file;
325 }
326
327 static void set_git_dir_1(const char *path)
328 {
329 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
330 die(_("could not set GIT_DIR to '%s'"), path);
331 setup_git_env(path);
332 }
333
334 static void update_relative_gitdir(const char *name,
335 const char *old_cwd,
336 const char *new_cwd,
337 void *data)
338 {
339 char *path = reparent_relative_path(old_cwd, new_cwd, get_git_dir());
340 trace_printf_key(&trace_setup_key,
341 "setup: move $GIT_DIR to '%s'",
342 path);
343 set_git_dir_1(path);
344 free(path);
345 }
346
347 void set_git_dir(const char *path)
348 {
349 set_git_dir_1(path);
350 if (!is_absolute_path(path))
351 chdir_notify_register(NULL, update_relative_gitdir, NULL);
352 }
353
354 const char *get_log_output_encoding(void)
355 {
356 return git_log_output_encoding ? git_log_output_encoding
357 : get_commit_output_encoding();
358 }
359
360 const char *get_commit_output_encoding(void)
361 {
362 return git_commit_encoding ? git_commit_encoding : "UTF-8";
363 }
364
365 static int the_shared_repository = PERM_UMASK;
366 static int need_shared_repository_from_config = 1;
367
368 void set_shared_repository(int value)
369 {
370 the_shared_repository = value;
371 need_shared_repository_from_config = 0;
372 }
373
374 int get_shared_repository(void)
375 {
376 if (need_shared_repository_from_config) {
377 const char *var = "core.sharedrepository";
378 const char *value;
379 if (!git_config_get_value(var, &value))
380 the_shared_repository = git_config_perm(var, value);
381 need_shared_repository_from_config = 0;
382 }
383 return the_shared_repository;
384 }
385
386 void reset_shared_repository(void)
387 {
388 need_shared_repository_from_config = 1;
389 }
390
391 int use_optional_locks(void)
392 {
393 return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
394 }
395
396 int print_sha1_ellipsis(void)
397 {
398 /*
399 * Determine if the calling environment contains the variable
400 * GIT_PRINT_SHA1_ELLIPSIS set to "yes".
401 */
402 static int cached_result = -1; /* unknown */
403
404 if (cached_result < 0) {
405 const char *v = getenv("GIT_PRINT_SHA1_ELLIPSIS");
406 cached_result = (v && !strcasecmp(v, "yes"));
407 }
408 return cached_result;
409 }