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