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