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