git-compat-util: add xstrdup_or_null helper
[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
87 /*
88  * Repository-local GIT_* environment variables; see cache.h for details.
89  */
90 const char * const local_repo_env[] = {
91         ALTERNATE_DB_ENVIRONMENT,
92         CONFIG_ENVIRONMENT,
93         CONFIG_DATA_ENVIRONMENT,
94         DB_ENVIRONMENT,
95         GIT_DIR_ENVIRONMENT,
96         GIT_WORK_TREE_ENVIRONMENT,
97         GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
98         GRAFT_ENVIRONMENT,
99         INDEX_ENVIRONMENT,
100         NO_REPLACE_OBJECTS_ENVIRONMENT,
101         GIT_PREFIX_ENVIRONMENT,
102         GIT_SHALLOW_FILE_ENVIRONMENT,
103         NULL
104 };
105
106 static char *expand_namespace(const char *raw_namespace)
107 {
108         struct strbuf buf = STRBUF_INIT;
109         struct strbuf **components, **c;
110
111         if (!raw_namespace || !*raw_namespace)
112                 return xstrdup("");
113
114         strbuf_addstr(&buf, raw_namespace);
115         components = strbuf_split(&buf, '/');
116         strbuf_reset(&buf);
117         for (c = components; *c; c++)
118                 if (strcmp((*c)->buf, "/") != 0)
119                         strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
120         strbuf_list_free(components);
121         if (check_refname_format(buf.buf, 0))
122                 die("bad git namespace path \"%s\"", raw_namespace);
123         strbuf_addch(&buf, '/');
124         return strbuf_detach(&buf, NULL);
125 }
126
127 static char *git_path_from_env(const char *envvar, const char *path)
128 {
129         const char *value = getenv(envvar);
130         return value ? xstrdup(value) : git_pathdup("%s", path);
131 }
132
133 static void setup_git_env(void)
134 {
135         const char *gitfile;
136         const char *shallow_file;
137
138         git_dir = getenv(GIT_DIR_ENVIRONMENT);
139         if (!git_dir)
140                 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
141         gitfile = read_gitfile(git_dir);
142         git_dir = xstrdup(gitfile ? gitfile : git_dir);
143         git_object_dir = git_path_from_env(DB_ENVIRONMENT, "objects");
144         git_index_file = git_path_from_env(INDEX_ENVIRONMENT, "index");
145         git_graft_file = git_path_from_env(GRAFT_ENVIRONMENT, "info/grafts");
146         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
147                 check_replace_refs = 0;
148         namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
149         namespace_len = strlen(namespace);
150         shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
151         if (shallow_file)
152                 set_alternate_shallow_file(shallow_file, 0);
153 }
154
155 int is_bare_repository(void)
156 {
157         /* if core.bare is not 'false', let's see if there is a work tree */
158         return is_bare_repository_cfg && !get_git_work_tree();
159 }
160
161 const char *get_git_dir(void)
162 {
163         if (!git_dir)
164                 setup_git_env();
165         return git_dir;
166 }
167
168 const char *get_git_namespace(void)
169 {
170         if (!namespace)
171                 setup_git_env();
172         return namespace;
173 }
174
175 const char *strip_namespace(const char *namespaced_ref)
176 {
177         if (!starts_with(namespaced_ref, get_git_namespace()))
178                 return NULL;
179         return namespaced_ref + namespace_len;
180 }
181
182 static int git_work_tree_initialized;
183
184 /*
185  * Note.  This works only before you used a work tree.  This was added
186  * primarily to support git-clone to work in a new repository it just
187  * created, and is not meant to flip between different work trees.
188  */
189 void set_git_work_tree(const char *new_work_tree)
190 {
191         if (git_work_tree_initialized) {
192                 new_work_tree = real_path(new_work_tree);
193                 if (strcmp(new_work_tree, work_tree))
194                         die("internal error: work tree has already been set\n"
195                             "Current worktree: %s\nNew worktree: %s",
196                             work_tree, new_work_tree);
197                 return;
198         }
199         git_work_tree_initialized = 1;
200         work_tree = xstrdup(real_path(new_work_tree));
201 }
202
203 const char *get_git_work_tree(void)
204 {
205         return work_tree;
206 }
207
208 char *get_object_directory(void)
209 {
210         if (!git_object_dir)
211                 setup_git_env();
212         return git_object_dir;
213 }
214
215 int odb_mkstemp(char *template, size_t limit, const char *pattern)
216 {
217         int fd;
218         /*
219          * we let the umask do its job, don't try to be more
220          * restrictive except to remove write permission.
221          */
222         int mode = 0444;
223         snprintf(template, limit, "%s/%s",
224                  get_object_directory(), pattern);
225         fd = git_mkstemp_mode(template, mode);
226         if (0 <= fd)
227                 return fd;
228
229         /* slow path */
230         /* some mkstemp implementations erase template on failure */
231         snprintf(template, limit, "%s/%s",
232                  get_object_directory(), pattern);
233         safe_create_leading_directories(template);
234         return xmkstemp_mode(template, mode);
235 }
236
237 int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1)
238 {
239         int fd;
240
241         snprintf(name, namesz, "%s/pack/pack-%s.keep",
242                  get_object_directory(), sha1_to_hex(sha1));
243         fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
244         if (0 <= fd)
245                 return fd;
246
247         /* slow path */
248         safe_create_leading_directories(name);
249         return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
250 }
251
252 char *get_index_file(void)
253 {
254         if (!git_index_file)
255                 setup_git_env();
256         return git_index_file;
257 }
258
259 char *get_graft_file(void)
260 {
261         if (!git_graft_file)
262                 setup_git_env();
263         return git_graft_file;
264 }
265
266 int set_git_dir(const char *path)
267 {
268         if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
269                 return error("Could not set GIT_DIR to '%s'", path);
270         setup_git_env();
271         return 0;
272 }
273
274 const char *get_log_output_encoding(void)
275 {
276         return git_log_output_encoding ? git_log_output_encoding
277                 : get_commit_output_encoding();
278 }
279
280 const char *get_commit_output_encoding(void)
281 {
282         return git_commit_encoding ? git_commit_encoding : "UTF-8";
283 }