Merge branch 'ky/branch-m-worktree' into maint
[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 "refs.h"
12 #include "fmt-merge-msg.h"
13 #include "commit.h"
14
15 int trust_executable_bit = 1;
16 int trust_ctime = 1;
17 int check_stat = 1;
18 int has_symlinks = 1;
19 int minimum_abbrev = 4, default_abbrev = 7;
20 int ignore_case;
21 int assume_unchanged;
22 int prefer_symlink_refs;
23 int is_bare_repository_cfg = -1; /* unspecified */
24 int log_all_ref_updates = -1; /* unspecified */
25 int warn_ambiguous_refs = 1;
26 int warn_on_object_refname_ambiguity = 1;
27 int ref_paranoia = -1;
28 int repository_format_precious_objects;
29 const char *git_commit_encoding;
30 const char *git_log_output_encoding;
31 const char *apply_default_whitespace;
32 const char *apply_default_ignorewhitespace;
33 const char *git_attributes_file;
34 int zlib_compression_level = Z_BEST_SPEED;
35 int core_compression_level;
36 int core_compression_seen;
37 int fsync_object_files;
38 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
39 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
40 size_t delta_base_cache_limit = 96 * 1024 * 1024;
41 unsigned long big_file_threshold = 512 * 1024 * 1024;
42 const char *pager_program;
43 int pager_use_color = 1;
44 const char *editor_program;
45 const char *askpass_program;
46 const char *excludes_file;
47 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
48 int check_replace_refs = 1;
49 char *git_replace_ref_base;
50 enum eol core_eol = EOL_UNSET;
51 enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
52 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
53 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
54 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
55 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
56 #ifndef OBJECT_CREATION_MODE
57 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
58 #endif
59 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
60 char *notes_ref_name;
61 int grafts_replace_parents = 1;
62 int core_apply_sparse_checkout;
63 int merge_log_config = -1;
64 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
65 unsigned long pack_size_limit_cfg;
66
67 #ifndef PROTECT_HFS_DEFAULT
68 #define PROTECT_HFS_DEFAULT 0
69 #endif
70 int protect_hfs = PROTECT_HFS_DEFAULT;
71
72 #ifndef PROTECT_NTFS_DEFAULT
73 #define PROTECT_NTFS_DEFAULT 0
74 #endif
75 int protect_ntfs = PROTECT_NTFS_DEFAULT;
76
77 /*
78  * The character that begins a commented line in user-editable file
79  * that is subject to stripspace.
80  */
81 char comment_line_char = '#';
82 int auto_comment_line_char;
83
84 /* Parallel index stat data preload? */
85 int core_preload_index = 1;
86
87 /*
88  * This is a hack for test programs like test-dump-untracked-cache to
89  * ensure that they do not modify the untracked cache when reading it.
90  * Do not use it otherwise!
91  */
92 int ignore_untracked_cache_config;
93
94 /* This is set by setup_git_dir_gently() and/or git_default_config() */
95 char *git_work_tree_cfg;
96 static char *work_tree;
97
98 static const char *namespace;
99 static size_t namespace_len;
100
101 static const char *git_dir, *git_common_dir;
102 static char *git_object_dir, *git_index_file, *git_graft_file;
103 int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
104
105 /*
106  * Repository-local GIT_* environment variables; see cache.h for details.
107  */
108 const char * const local_repo_env[] = {
109         ALTERNATE_DB_ENVIRONMENT,
110         CONFIG_ENVIRONMENT,
111         CONFIG_DATA_ENVIRONMENT,
112         DB_ENVIRONMENT,
113         GIT_DIR_ENVIRONMENT,
114         GIT_WORK_TREE_ENVIRONMENT,
115         GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
116         GRAFT_ENVIRONMENT,
117         INDEX_ENVIRONMENT,
118         NO_REPLACE_OBJECTS_ENVIRONMENT,
119         GIT_REPLACE_REF_BASE_ENVIRONMENT,
120         GIT_PREFIX_ENVIRONMENT,
121         GIT_SHALLOW_FILE_ENVIRONMENT,
122         GIT_COMMON_DIR_ENVIRONMENT,
123         NULL
124 };
125
126 static char *expand_namespace(const char *raw_namespace)
127 {
128         struct strbuf buf = STRBUF_INIT;
129         struct strbuf **components, **c;
130
131         if (!raw_namespace || !*raw_namespace)
132                 return xstrdup("");
133
134         strbuf_addstr(&buf, raw_namespace);
135         components = strbuf_split(&buf, '/');
136         strbuf_reset(&buf);
137         for (c = components; *c; c++)
138                 if (strcmp((*c)->buf, "/") != 0)
139                         strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
140         strbuf_list_free(components);
141         if (check_refname_format(buf.buf, 0))
142                 die("bad git namespace path \"%s\"", raw_namespace);
143         strbuf_addch(&buf, '/');
144         return strbuf_detach(&buf, NULL);
145 }
146
147 static char *git_path_from_env(const char *envvar, const char *git_dir,
148                                const char *path, int *fromenv)
149 {
150         const char *value = getenv(envvar);
151         if (!value)
152                 return xstrfmt("%s/%s", git_dir, path);
153         if (fromenv)
154                 *fromenv = 1;
155         return xstrdup(value);
156 }
157
158 static void setup_git_env(void)
159 {
160         struct strbuf sb = STRBUF_INIT;
161         const char *gitfile;
162         const char *shallow_file;
163         const char *replace_ref_base;
164
165         git_dir = getenv(GIT_DIR_ENVIRONMENT);
166         if (!git_dir)
167                 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
168         gitfile = read_gitfile(git_dir);
169         git_dir = xstrdup(gitfile ? gitfile : git_dir);
170         if (get_common_dir(&sb, git_dir))
171                 git_common_dir_env = 1;
172         git_common_dir = strbuf_detach(&sb, NULL);
173         git_object_dir = git_path_from_env(DB_ENVIRONMENT, git_common_dir,
174                                            "objects", &git_db_env);
175         git_index_file = git_path_from_env(INDEX_ENVIRONMENT, git_dir,
176                                            "index", &git_index_env);
177         git_graft_file = git_path_from_env(GRAFT_ENVIRONMENT, git_common_dir,
178                                            "info/grafts", &git_graft_env);
179         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
180                 check_replace_refs = 0;
181         replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
182         git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
183                                                           : "refs/replace/");
184         namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
185         namespace_len = strlen(namespace);
186         shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
187         if (shallow_file)
188                 set_alternate_shallow_file(shallow_file, 0);
189 }
190
191 int is_bare_repository(void)
192 {
193         /* if core.bare is not 'false', let's see if there is a work tree */
194         return is_bare_repository_cfg && !get_git_work_tree();
195 }
196
197 const char *get_git_dir(void)
198 {
199         if (!git_dir)
200                 setup_git_env();
201         return git_dir;
202 }
203
204 const char *get_git_common_dir(void)
205 {
206         return git_common_dir;
207 }
208
209 const char *get_git_namespace(void)
210 {
211         if (!namespace)
212                 setup_git_env();
213         return namespace;
214 }
215
216 const char *strip_namespace(const char *namespaced_ref)
217 {
218         if (!starts_with(namespaced_ref, get_git_namespace()))
219                 return NULL;
220         return namespaced_ref + namespace_len;
221 }
222
223 static int git_work_tree_initialized;
224
225 /*
226  * Note.  This works only before you used a work tree.  This was added
227  * primarily to support git-clone to work in a new repository it just
228  * created, and is not meant to flip between different work trees.
229  */
230 void set_git_work_tree(const char *new_work_tree)
231 {
232         if (git_work_tree_initialized) {
233                 new_work_tree = real_path(new_work_tree);
234                 if (strcmp(new_work_tree, work_tree))
235                         die("internal error: work tree has already been set\n"
236                             "Current worktree: %s\nNew worktree: %s",
237                             work_tree, new_work_tree);
238                 return;
239         }
240         git_work_tree_initialized = 1;
241         work_tree = xstrdup(real_path(new_work_tree));
242 }
243
244 const char *get_git_work_tree(void)
245 {
246         return work_tree;
247 }
248
249 char *get_object_directory(void)
250 {
251         if (!git_object_dir)
252                 setup_git_env();
253         return git_object_dir;
254 }
255
256 int odb_mkstemp(char *template, size_t limit, const char *pattern)
257 {
258         int fd;
259         /*
260          * we let the umask do its job, don't try to be more
261          * restrictive except to remove write permission.
262          */
263         int mode = 0444;
264         snprintf(template, limit, "%s/%s",
265                  get_object_directory(), pattern);
266         fd = git_mkstemp_mode(template, mode);
267         if (0 <= fd)
268                 return fd;
269
270         /* slow path */
271         /* some mkstemp implementations erase template on failure */
272         snprintf(template, limit, "%s/%s",
273                  get_object_directory(), pattern);
274         safe_create_leading_directories(template);
275         return xmkstemp_mode(template, mode);
276 }
277
278 int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1)
279 {
280         int fd;
281
282         snprintf(name, namesz, "%s/pack/pack-%s.keep",
283                  get_object_directory(), sha1_to_hex(sha1));
284         fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
285         if (0 <= fd)
286                 return fd;
287
288         /* slow path */
289         safe_create_leading_directories(name);
290         return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
291 }
292
293 char *get_index_file(void)
294 {
295         if (!git_index_file)
296                 setup_git_env();
297         return git_index_file;
298 }
299
300 char *get_graft_file(void)
301 {
302         if (!git_graft_file)
303                 setup_git_env();
304         return git_graft_file;
305 }
306
307 int set_git_dir(const char *path)
308 {
309         if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
310                 return error("Could not set GIT_DIR to '%s'", path);
311         setup_git_env();
312         return 0;
313 }
314
315 const char *get_log_output_encoding(void)
316 {
317         return git_log_output_encoding ? git_log_output_encoding
318                 : get_commit_output_encoding();
319 }
320
321 const char *get_commit_output_encoding(void)
322 {
323         return git_commit_encoding ? git_commit_encoding : "UTF-8";
324 }
325
326 static int the_shared_repository = PERM_UMASK;
327 static int need_shared_repository_from_config = 1;
328
329 void set_shared_repository(int value)
330 {
331         the_shared_repository = value;
332         need_shared_repository_from_config = 0;
333 }
334
335 int get_shared_repository(void)
336 {
337         if (need_shared_repository_from_config) {
338                 const char *var = "core.sharedrepository";
339                 const char *value;
340                 if (!git_config_get_value(var, &value))
341                         the_shared_repository = git_config_perm(var, value);
342                 need_shared_repository_from_config = 0;
343         }
344         return the_shared_repository;
345 }