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