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