fsmonitor: teach git to optionally utilize a file system monitor to speed up detectin...
[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 "repository.h"
12 #include "config.h"
13 #include "refs.h"
14 #include "fmt-merge-msg.h"
15 #include "commit.h"
16
17 int trust_executable_bit = 1;
18 int trust_ctime = 1;
19 int check_stat = 1;
20 int has_symlinks = 1;
21 int minimum_abbrev = 4, default_abbrev = -1;
22 int ignore_case;
23 int assume_unchanged;
24 int prefer_symlink_refs;
25 int is_bare_repository_cfg = -1; /* unspecified */
26 int warn_ambiguous_refs = 1;
27 int warn_on_object_refname_ambiguity = 1;
28 int ref_paranoia = -1;
29 int repository_format_precious_objects;
30 const char *git_commit_encoding;
31 const char *git_log_output_encoding;
32 const char *apply_default_whitespace;
33 const char *apply_default_ignorewhitespace;
34 const char *git_attributes_file;
35 const char *git_hooks_path;
36 int zlib_compression_level = Z_BEST_SPEED;
37 int core_compression_level;
38 int pack_compression_level = Z_DEFAULT_COMPRESSION;
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 int pager_use_color = 1;
45 const char *editor_program;
46 const char *askpass_program;
47 const char *excludes_file;
48 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
49 int check_replace_refs = 1;
50 char *git_replace_ref_base;
51 enum eol core_eol = EOL_UNSET;
52 enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
53 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
54 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
55 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
56 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
57 #ifndef OBJECT_CREATION_MODE
58 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
59 #endif
60 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
61 char *notes_ref_name;
62 int grafts_replace_parents = 1;
63 int core_apply_sparse_checkout;
64 int merge_log_config = -1;
65 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
66 unsigned long pack_size_limit_cfg;
67 enum hide_dotfiles_type hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
68 enum log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
69
70 #ifndef PROTECT_HFS_DEFAULT
71 #define PROTECT_HFS_DEFAULT 0
72 #endif
73 int protect_hfs = PROTECT_HFS_DEFAULT;
74
75 #ifndef PROTECT_NTFS_DEFAULT
76 #define PROTECT_NTFS_DEFAULT 0
77 #endif
78 int protect_ntfs = PROTECT_NTFS_DEFAULT;
79 const char *core_fsmonitor;
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
101 static const char *namespace;
102
103 static const char *super_prefix;
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_SUPER_PREFIX_ENVIRONMENT,
122 GIT_SHALLOW_FILE_ENVIRONMENT,
123 GIT_COMMON_DIR_ENVIRONMENT,
124 NULL
125 };
126
127 static char *expand_namespace(const char *raw_namespace)
128 {
129 struct strbuf buf = STRBUF_INIT;
130 struct strbuf **components, **c;
131
132 if (!raw_namespace || !*raw_namespace)
133 return xstrdup("");
134
135 strbuf_addstr(&buf, raw_namespace);
136 components = strbuf_split(&buf, '/');
137 strbuf_reset(&buf);
138 for (c = components; *c; c++)
139 if (strcmp((*c)->buf, "/") != 0)
140 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
141 strbuf_list_free(components);
142 if (check_refname_format(buf.buf, 0))
143 die("bad git namespace path \"%s\"", raw_namespace);
144 strbuf_addch(&buf, '/');
145 return strbuf_detach(&buf, NULL);
146 }
147
148 void setup_git_env(void)
149 {
150 const char *shallow_file;
151 const char *replace_ref_base;
152
153 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
154 check_replace_refs = 0;
155 replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
156 git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
157 : "refs/replace/");
158 namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
159 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
160 if (shallow_file)
161 set_alternate_shallow_file(shallow_file, 0);
162 }
163
164 int is_bare_repository(void)
165 {
166 /* if core.bare is not 'false', let's see if there is a work tree */
167 return is_bare_repository_cfg && !get_git_work_tree();
168 }
169
170 int have_git_dir(void)
171 {
172 return startup_info->have_repository
173 || the_repository->gitdir;
174 }
175
176 const char *get_git_dir(void)
177 {
178 if (!the_repository->gitdir)
179 BUG("git environment hasn't been setup");
180 return the_repository->gitdir;
181 }
182
183 const char *get_git_common_dir(void)
184 {
185 if (!the_repository->commondir)
186 BUG("git environment hasn't been setup");
187 return the_repository->commondir;
188 }
189
190 const char *get_git_namespace(void)
191 {
192 if (!namespace)
193 BUG("git environment hasn't been setup");
194 return namespace;
195 }
196
197 const char *strip_namespace(const char *namespaced_ref)
198 {
199 const char *out;
200 if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
201 return out;
202 return NULL;
203 }
204
205 const char *get_super_prefix(void)
206 {
207 static int initialized;
208 if (!initialized) {
209 super_prefix = getenv(GIT_SUPER_PREFIX_ENVIRONMENT);
210 initialized = 1;
211 }
212 return super_prefix;
213 }
214
215 static int git_work_tree_initialized;
216
217 /*
218 * Note. This works only before you used a work tree. This was added
219 * primarily to support git-clone to work in a new repository it just
220 * created, and is not meant to flip between different work trees.
221 */
222 void set_git_work_tree(const char *new_work_tree)
223 {
224 if (git_work_tree_initialized) {
225 new_work_tree = real_path(new_work_tree);
226 if (strcmp(new_work_tree, the_repository->worktree))
227 die("internal error: work tree has already been set\n"
228 "Current worktree: %s\nNew worktree: %s",
229 the_repository->worktree, new_work_tree);
230 return;
231 }
232 git_work_tree_initialized = 1;
233 repo_set_worktree(the_repository, new_work_tree);
234 }
235
236 const char *get_git_work_tree(void)
237 {
238 return the_repository->worktree;
239 }
240
241 char *get_object_directory(void)
242 {
243 if (!the_repository->objectdir)
244 BUG("git environment hasn't been setup");
245 return the_repository->objectdir;
246 }
247
248 int odb_mkstemp(struct strbuf *template, const char *pattern)
249 {
250 int fd;
251 /*
252 * we let the umask do its job, don't try to be more
253 * restrictive except to remove write permission.
254 */
255 int mode = 0444;
256 git_path_buf(template, "objects/%s", pattern);
257 fd = git_mkstemp_mode(template->buf, mode);
258 if (0 <= fd)
259 return fd;
260
261 /* slow path */
262 /* some mkstemp implementations erase template on failure */
263 git_path_buf(template, "objects/%s", pattern);
264 safe_create_leading_directories(template->buf);
265 return xmkstemp_mode(template->buf, mode);
266 }
267
268 int odb_pack_keep(const char *name)
269 {
270 int fd;
271
272 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
273 if (0 <= fd)
274 return fd;
275
276 /* slow path */
277 safe_create_leading_directories_const(name);
278 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
279 }
280
281 char *get_index_file(void)
282 {
283 if (!the_repository->index_file)
284 BUG("git environment hasn't been setup");
285 return the_repository->index_file;
286 }
287
288 char *get_graft_file(void)
289 {
290 if (!the_repository->graft_file)
291 BUG("git environment hasn't been setup");
292 return the_repository->graft_file;
293 }
294
295 int set_git_dir(const char *path)
296 {
297 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
298 return error("Could not set GIT_DIR to '%s'", path);
299 repo_set_gitdir(the_repository, path);
300 setup_git_env();
301 return 0;
302 }
303
304 const char *get_log_output_encoding(void)
305 {
306 return git_log_output_encoding ? git_log_output_encoding
307 : get_commit_output_encoding();
308 }
309
310 const char *get_commit_output_encoding(void)
311 {
312 return git_commit_encoding ? git_commit_encoding : "UTF-8";
313 }
314
315 static int the_shared_repository = PERM_UMASK;
316 static int need_shared_repository_from_config = 1;
317
318 void set_shared_repository(int value)
319 {
320 the_shared_repository = value;
321 need_shared_repository_from_config = 0;
322 }
323
324 int get_shared_repository(void)
325 {
326 if (need_shared_repository_from_config) {
327 const char *var = "core.sharedrepository";
328 const char *value;
329 if (!git_config_get_value(var, &value))
330 the_shared_repository = git_config_perm(var, value);
331 need_shared_repository_from_config = 0;
332 }
333 return the_shared_repository;
334 }
335
336 void reset_shared_repository(void)
337 {
338 need_shared_repository_from_config = 1;
339 }