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