Merge tag 'v2.3.0'
[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 repository_format_version;
28 const char *git_commit_encoding;
29 const char *git_log_output_encoding;
30 int shared_repository = PERM_UMASK;
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 enum eol core_eol = EOL_UNSET;
50 enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
51 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
52 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
53 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
54 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
55 enum fetch_default_type fetch_default = FETCH_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 struct startup_info *startup_info;
66 unsigned long pack_size_limit_cfg;
67
68 #ifndef PROTECT_HFS_DEFAULT
69 #define PROTECT_HFS_DEFAULT 0
70 #endif
71 int protect_hfs = PROTECT_HFS_DEFAULT;
72
73 #ifndef PROTECT_NTFS_DEFAULT
74 #define PROTECT_NTFS_DEFAULT 0
75 #endif
76 int protect_ntfs = PROTECT_NTFS_DEFAULT;
77 enum git_mode git_mode = MODE_CURRENT;
78
79 /*
80  * The character that begins a commented line in user-editable file
81  * that is subject to stripspace.
82  */
83 char comment_line_char = '#';
84 int auto_comment_line_char;
85
86 /* Parallel index stat data preload? */
87 int core_preload_index = 1;
88
89 /* This is set by setup_git_dir_gently() and/or git_default_config() */
90 char *git_work_tree_cfg;
91 static char *work_tree;
92
93 static const char *namespace;
94 static size_t namespace_len;
95
96 static const char *git_dir;
97 static char *git_object_dir, *git_index_file, *git_graft_file;
98
99 /*
100  * Repository-local GIT_* environment variables; see cache.h for details.
101  */
102 const char * const local_repo_env[] = {
103         ALTERNATE_DB_ENVIRONMENT,
104         CONFIG_ENVIRONMENT,
105         CONFIG_DATA_ENVIRONMENT,
106         DB_ENVIRONMENT,
107         GIT_DIR_ENVIRONMENT,
108         GIT_WORK_TREE_ENVIRONMENT,
109         GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
110         GRAFT_ENVIRONMENT,
111         INDEX_ENVIRONMENT,
112         NO_REPLACE_OBJECTS_ENVIRONMENT,
113         GIT_PREFIX_ENVIRONMENT,
114         GIT_SHALLOW_FILE_ENVIRONMENT,
115         NULL
116 };
117
118 static char *expand_namespace(const char *raw_namespace)
119 {
120         struct strbuf buf = STRBUF_INIT;
121         struct strbuf **components, **c;
122
123         if (!raw_namespace || !*raw_namespace)
124                 return xstrdup("");
125
126         strbuf_addstr(&buf, raw_namespace);
127         components = strbuf_split(&buf, '/');
128         strbuf_reset(&buf);
129         for (c = components; *c; c++)
130                 if (strcmp((*c)->buf, "/") != 0)
131                         strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
132         strbuf_list_free(components);
133         if (check_refname_format(buf.buf, 0))
134                 die("bad git namespace path \"%s\"", raw_namespace);
135         strbuf_addch(&buf, '/');
136         return strbuf_detach(&buf, NULL);
137 }
138
139 static char *git_path_from_env(const char *envvar, const char *path)
140 {
141         const char *value = getenv(envvar);
142         return value ? xstrdup(value) : git_pathdup("%s", path);
143 }
144
145 static void setup_git_env(void)
146 {
147         const char *gitfile;
148         const char *shallow_file;
149
150         git_dir = getenv(GIT_DIR_ENVIRONMENT);
151         if (!git_dir)
152                 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
153         gitfile = read_gitfile(git_dir);
154         git_dir = xstrdup(gitfile ? gitfile : git_dir);
155         git_object_dir = git_path_from_env(DB_ENVIRONMENT, "objects");
156         git_index_file = git_path_from_env(INDEX_ENVIRONMENT, "index");
157         git_graft_file = git_path_from_env(GRAFT_ENVIRONMENT, "info/grafts");
158         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
159                 check_replace_refs = 0;
160         namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
161         namespace_len = strlen(namespace);
162         shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
163         if (shallow_file)
164                 set_alternate_shallow_file(shallow_file, 0);
165 }
166
167 int is_bare_repository(void)
168 {
169         /* if core.bare is not 'false', let's see if there is a work tree */
170         return is_bare_repository_cfg && !get_git_work_tree();
171 }
172
173 const char *get_git_dir(void)
174 {
175         if (!git_dir)
176                 setup_git_env();
177         return git_dir;
178 }
179
180 const char *get_git_namespace(void)
181 {
182         if (!namespace)
183                 setup_git_env();
184         return namespace;
185 }
186
187 const char *strip_namespace(const char *namespaced_ref)
188 {
189         if (!starts_with(namespaced_ref, get_git_namespace()))
190                 return NULL;
191         return namespaced_ref + namespace_len;
192 }
193
194 static int git_work_tree_initialized;
195
196 /*
197  * Note.  This works only before you used a work tree.  This was added
198  * primarily to support git-clone to work in a new repository it just
199  * created, and is not meant to flip between different work trees.
200  */
201 void set_git_work_tree(const char *new_work_tree)
202 {
203         if (git_work_tree_initialized) {
204                 new_work_tree = real_path(new_work_tree);
205                 if (strcmp(new_work_tree, work_tree))
206                         die("internal error: work tree has already been set\n"
207                             "Current worktree: %s\nNew worktree: %s",
208                             work_tree, new_work_tree);
209                 return;
210         }
211         git_work_tree_initialized = 1;
212         work_tree = xstrdup(real_path(new_work_tree));
213 }
214
215 const char *get_git_work_tree(void)
216 {
217         return work_tree;
218 }
219
220 char *get_object_directory(void)
221 {
222         if (!git_object_dir)
223                 setup_git_env();
224         return git_object_dir;
225 }
226
227 int odb_mkstemp(char *template, size_t limit, const char *pattern)
228 {
229         int fd;
230         /*
231          * we let the umask do its job, don't try to be more
232          * restrictive except to remove write permission.
233          */
234         int mode = 0444;
235         snprintf(template, limit, "%s/%s",
236                  get_object_directory(), pattern);
237         fd = git_mkstemp_mode(template, mode);
238         if (0 <= fd)
239                 return fd;
240
241         /* slow path */
242         /* some mkstemp implementations erase template on failure */
243         snprintf(template, limit, "%s/%s",
244                  get_object_directory(), pattern);
245         safe_create_leading_directories(template);
246         return xmkstemp_mode(template, mode);
247 }
248
249 int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1)
250 {
251         int fd;
252
253         snprintf(name, namesz, "%s/pack/pack-%s.keep",
254                  get_object_directory(), sha1_to_hex(sha1));
255         fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
256         if (0 <= fd)
257                 return fd;
258
259         /* slow path */
260         safe_create_leading_directories(name);
261         return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
262 }
263
264 char *get_index_file(void)
265 {
266         if (!git_index_file)
267                 setup_git_env();
268         return git_index_file;
269 }
270
271 char *get_graft_file(void)
272 {
273         if (!git_graft_file)
274                 setup_git_env();
275         return git_graft_file;
276 }
277
278 int set_git_dir(const char *path)
279 {
280         if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
281                 return error("Could not set GIT_DIR to '%s'", path);
282         setup_git_env();
283         return 0;
284 }
285
286 const char *get_log_output_encoding(void)
287 {
288         return git_log_output_encoding ? git_log_output_encoding
289                 : get_commit_output_encoding();
290 }
291
292 const char *get_commit_output_encoding(void)
293 {
294         return git_commit_encoding ? git_commit_encoding : "UTF-8";
295 }