Merge branch 'jc/help'
[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
14 int trust_executable_bit = 1;
15 int trust_ctime = 1;
16 int has_symlinks = 1;
17 int minimum_abbrev = 4, default_abbrev = 7;
18 int ignore_case;
19 int assume_unchanged;
20 int prefer_symlink_refs;
21 int is_bare_repository_cfg = -1; /* unspecified */
22 int log_all_ref_updates = -1; /* unspecified */
23 int warn_ambiguous_refs = 1;
24 int repository_format_version;
25 const char *git_commit_encoding;
26 const char *git_log_output_encoding;
27 int shared_repository = PERM_UMASK;
28 const char *apply_default_whitespace;
29 const char *apply_default_ignorewhitespace;
30 const char *git_attributes_file;
31 int zlib_compression_level = Z_BEST_SPEED;
32 int core_compression_level;
33 int core_compression_seen;
34 int fsync_object_files;
35 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
36 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
37 size_t delta_base_cache_limit = 16 * 1024 * 1024;
38 unsigned long big_file_threshold = 512 * 1024 * 1024;
39 const char *log_pack_access;
40 const char *pager_program;
41 int pager_use_color = 1;
42 const char *editor_program;
43 const char *askpass_program;
44 const char *excludes_file;
45 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
46 int read_replace_refs = 1; /* NEEDSWORK: rename to use_replace_refs */
47 enum eol core_eol = EOL_UNSET;
48 enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
49 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
50 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
51 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
52 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
53 #ifndef OBJECT_CREATION_MODE
54 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
55 #endif
56 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
57 char *notes_ref_name;
58 int grafts_replace_parents = 1;
59 int core_apply_sparse_checkout;
60 int merge_log_config = -1;
61 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
62 struct startup_info *startup_info;
63 unsigned long pack_size_limit_cfg;
64
65 /* Parallel index stat data preload? */
66 int core_preload_index = 0;
67
68 /* This is set by setup_git_dir_gently() and/or git_default_config() */
69 char *git_work_tree_cfg;
70 static char *work_tree;
71
72 static const char *namespace;
73 static size_t namespace_len;
74
75 static const char *git_dir;
76 static char *git_object_dir, *git_index_file, *git_graft_file;
77
78 /*
79  * Repository-local GIT_* environment variables
80  * Remember to update local_repo_env_size in cache.h when
81  * the size of the list changes
82  */
83 const char * const local_repo_env[LOCAL_REPO_ENV_SIZE + 1] = {
84         ALTERNATE_DB_ENVIRONMENT,
85         CONFIG_ENVIRONMENT,
86         CONFIG_DATA_ENVIRONMENT,
87         DB_ENVIRONMENT,
88         GIT_DIR_ENVIRONMENT,
89         GIT_WORK_TREE_ENVIRONMENT,
90         GRAFT_ENVIRONMENT,
91         INDEX_ENVIRONMENT,
92         NO_REPLACE_OBJECTS_ENVIRONMENT,
93         NULL
94 };
95
96 static char *expand_namespace(const char *raw_namespace)
97 {
98         struct strbuf buf = STRBUF_INIT;
99         struct strbuf **components, **c;
100
101         if (!raw_namespace || !*raw_namespace)
102                 return xstrdup("");
103
104         strbuf_addstr(&buf, raw_namespace);
105         components = strbuf_split(&buf, '/');
106         strbuf_reset(&buf);
107         for (c = components; *c; c++)
108                 if (strcmp((*c)->buf, "/") != 0)
109                         strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
110         strbuf_list_free(components);
111         if (check_refname_format(buf.buf, 0))
112                 die("bad git namespace path \"%s\"", raw_namespace);
113         strbuf_addch(&buf, '/');
114         return strbuf_detach(&buf, NULL);
115 }
116
117 static void setup_git_env(void)
118 {
119         git_dir = getenv(GIT_DIR_ENVIRONMENT);
120         git_dir = git_dir ? xstrdup(git_dir) : NULL;
121         if (!git_dir) {
122                 git_dir = read_gitfile(DEFAULT_GIT_DIR_ENVIRONMENT);
123                 git_dir = git_dir ? xstrdup(git_dir) : NULL;
124         }
125         if (!git_dir)
126                 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
127         git_object_dir = getenv(DB_ENVIRONMENT);
128         if (!git_object_dir) {
129                 git_object_dir = xmalloc(strlen(git_dir) + 9);
130                 sprintf(git_object_dir, "%s/objects", git_dir);
131         }
132         git_index_file = getenv(INDEX_ENVIRONMENT);
133         if (!git_index_file) {
134                 git_index_file = xmalloc(strlen(git_dir) + 7);
135                 sprintf(git_index_file, "%s/index", git_dir);
136         }
137         git_graft_file = getenv(GRAFT_ENVIRONMENT);
138         if (!git_graft_file)
139                 git_graft_file = git_pathdup("info/grafts");
140         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
141                 read_replace_refs = 0;
142         namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
143         namespace_len = strlen(namespace);
144 }
145
146 int is_bare_repository(void)
147 {
148         /* if core.bare is not 'false', let's see if there is a work tree */
149         return is_bare_repository_cfg && !get_git_work_tree();
150 }
151
152 int have_git_dir(void)
153 {
154         return !!git_dir;
155 }
156
157 const char *get_git_dir(void)
158 {
159         if (!git_dir)
160                 setup_git_env();
161         return git_dir;
162 }
163
164 const char *get_git_namespace(void)
165 {
166         if (!namespace)
167                 setup_git_env();
168         return namespace;
169 }
170
171 const char *strip_namespace(const char *namespaced_ref)
172 {
173         if (prefixcmp(namespaced_ref, get_git_namespace()) != 0)
174                 return NULL;
175         return namespaced_ref + namespace_len;
176 }
177
178 static int git_work_tree_initialized;
179
180 /*
181  * Note.  This works only before you used a work tree.  This was added
182  * primarily to support git-clone to work in a new repository it just
183  * created, and is not meant to flip between different work trees.
184  */
185 void set_git_work_tree(const char *new_work_tree)
186 {
187         if (git_work_tree_initialized) {
188                 new_work_tree = real_path(new_work_tree);
189                 if (strcmp(new_work_tree, work_tree))
190                         die("internal error: work tree has already been set\n"
191                             "Current worktree: %s\nNew worktree: %s",
192                             work_tree, new_work_tree);
193                 return;
194         }
195         git_work_tree_initialized = 1;
196         work_tree = xstrdup(real_path(new_work_tree));
197 }
198
199 const char *get_git_work_tree(void)
200 {
201         return work_tree;
202 }
203
204 char *get_object_directory(void)
205 {
206         if (!git_object_dir)
207                 setup_git_env();
208         return git_object_dir;
209 }
210
211 int odb_mkstemp(char *template, size_t limit, const char *pattern)
212 {
213         int fd;
214         /*
215          * we let the umask do its job, don't try to be more
216          * restrictive except to remove write permission.
217          */
218         int mode = 0444;
219         snprintf(template, limit, "%s/%s",
220                  get_object_directory(), pattern);
221         fd = git_mkstemp_mode(template, mode);
222         if (0 <= fd)
223                 return fd;
224
225         /* slow path */
226         /* some mkstemp implementations erase template on failure */
227         snprintf(template, limit, "%s/%s",
228                  get_object_directory(), pattern);
229         safe_create_leading_directories(template);
230         return xmkstemp_mode(template, mode);
231 }
232
233 int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1)
234 {
235         int fd;
236
237         snprintf(name, namesz, "%s/pack/pack-%s.keep",
238                  get_object_directory(), sha1_to_hex(sha1));
239         fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
240         if (0 <= fd)
241                 return fd;
242
243         /* slow path */
244         safe_create_leading_directories(name);
245         return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
246 }
247
248 char *get_index_file(void)
249 {
250         if (!git_index_file)
251                 setup_git_env();
252         return git_index_file;
253 }
254
255 char *get_graft_file(void)
256 {
257         if (!git_graft_file)
258                 setup_git_env();
259         return git_graft_file;
260 }
261
262 int set_git_dir(const char *path)
263 {
264         if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
265                 return error("Could not set GIT_DIR to '%s'", path);
266         setup_git_env();
267         return 0;
268 }
269
270 const char *get_log_output_encoding(void)
271 {
272         return git_log_output_encoding ? git_log_output_encoding
273                 : get_commit_output_encoding();
274 }
275
276 const char *get_commit_output_encoding(void)
277 {
278         return git_commit_encoding ? git_commit_encoding : "UTF-8";
279 }