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 "config.h"
  12 #include "refs.h"
  13 #include "fmt-merge-msg.h"
  14 #include "commit.h"
  15
  16 int trust_executable_bit = 1;
  17 int trust_ctime = 1;
  18 int check_stat = 1;
  19 int has_symlinks = 1;
  20 int minimum_abbrev = 4, default_abbrev = -1;
  21 int ignore_case;
  22 int assume_unchanged;
  23 int prefer_symlink_refs;
  24 int is_bare_repository_cfg = -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_precious_objects;
  29 const char *git_commit_encoding;
  30 const char *git_log_output_encoding;
  31 const char *apply_default_whitespace;
  32 const char *apply_default_ignorewhitespace;
  33 const char *git_attributes_file;
  34 const char *git_hooks_path;
  35 int zlib_compression_level = Z_BEST_SPEED;
  36 int core_compression_level;
  37 int pack_compression_level = Z_DEFAULT_COMPRESSION;
  38 int fsync_object_files;
  39 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
  40 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
  41 size_t delta_base_cache_limit = 96 * 1024 * 1024;
  42 unsigned long big_file_threshold = 512 * 1024 * 1024;
  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 char *git_replace_ref_base;
  50 enum eol core_eol = EOL_UNSET;
  51 enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
  52 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
  53 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
  54 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
  55 enum push_default_type push_default = PUSH_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 unsigned long pack_size_limit_cfg;
  66 enum hide_dotfiles_type hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
  67 enum log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
  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 /*
  90  * This is a hack for test programs like test-dump-untracked-cache to
  91  * ensure that they do not modify the untracked cache when reading it.
  92  * Do not use it otherwise!
  93  */
  94 int ignore_untracked_cache_config;
  95
  96 /* This is set by setup_git_dir_gently() and/or git_default_config() */
  97 char *git_work_tree_cfg;
  98 static char *work_tree;
  99
 100 static const char *namespace;
 101 static size_t namespace_len;
 102
 103 static const char *super_prefix;
 104
 105 static const char *git_dir, *git_common_dir;
 106 static char *git_object_dir, *git_index_file, *git_graft_file;
 107 int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
 108
 109 /*
 110  * Repository-local GIT_* environment variables; see cache.h for details.
 111  */
 112 const char * const local_repo_env[] = {
 113         ALTERNATE_DB_ENVIRONMENT,
 114         CONFIG_ENVIRONMENT,
 115         CONFIG_DATA_ENVIRONMENT,
 116         DB_ENVIRONMENT,
 117         GIT_DIR_ENVIRONMENT,
 118         GIT_WORK_TREE_ENVIRONMENT,
 119         GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
 120         GRAFT_ENVIRONMENT,
 121         INDEX_ENVIRONMENT,
 122         NO_REPLACE_OBJECTS_ENVIRONMENT,
 123         GIT_REPLACE_REF_BASE_ENVIRONMENT,
 124         GIT_PREFIX_ENVIRONMENT,
 125         GIT_SUPER_PREFIX_ENVIRONMENT,
 126         GIT_SHALLOW_FILE_ENVIRONMENT,
 127         GIT_COMMON_DIR_ENVIRONMENT,
 128         NULL
 129 };
 130
 131 static char *expand_namespace(const char *raw_namespace)
 132 {
 133         struct strbuf buf = STRBUF_INIT;
 134         struct strbuf **components, **c;
 135
 136         if (!raw_namespace || !*raw_namespace)
 137                 return xstrdup("");
 138
 139         strbuf_addstr(&buf, raw_namespace);
 140         components = strbuf_split(&buf, '/');
 141         strbuf_reset(&buf);
 142         for (c = components; *c; c++)
 143                 if (strcmp((*c)->buf, "/") != 0)
 144                         strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
 145         strbuf_list_free(components);
 146         if (check_refname_format(buf.buf, 0))
 147                 die("bad git namespace path \"%s\"", raw_namespace);
 148         strbuf_addch(&buf, '/');
 149         return strbuf_detach(&buf, NULL);
 150 }
 151
 152 static char *git_path_from_env(const char *envvar, const char *git_dir,
 153                                const char *path, int *fromenv)
 154 {
 155         const char *value = getenv(envvar);
 156         if (!value)
 157                 return xstrfmt("%s/%s", git_dir, path);
 158         if (fromenv)
 159                 *fromenv = 1;
 160         return xstrdup(value);
 161 }
 162
 163 static void setup_git_env(void)
 164 {
 165         struct strbuf sb = STRBUF_INIT;
 166         const char *gitfile;
 167         const char *shallow_file;
 168         const char *replace_ref_base;
 169
 170         git_dir = getenv(GIT_DIR_ENVIRONMENT);
 171         if (!git_dir) {
 172                 if (!startup_info->have_repository)
 173                         BUG("setup_git_env called without repository");
 174                 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
 175         }
 176         gitfile = read_gitfile(git_dir);
 177         git_dir = xstrdup(gitfile ? gitfile : git_dir);
 178         if (get_common_dir(&sb, git_dir))
 179                 git_common_dir_env = 1;
 180         git_common_dir = strbuf_detach(&sb, NULL);
 181         git_object_dir = git_path_from_env(DB_ENVIRONMENT, git_common_dir,
 182                                            "objects", &git_db_env);
 183         git_index_file = git_path_from_env(INDEX_ENVIRONMENT, git_dir,
 184                                            "index", &git_index_env);
 185         git_graft_file = git_path_from_env(GRAFT_ENVIRONMENT, git_common_dir,
 186                                            "info/grafts", &git_graft_env);
 187         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
 188                 check_replace_refs = 0;
 189         replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
 190         git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
 191                                                           : "refs/replace/");
 192         namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
 193         namespace_len = strlen(namespace);
 194         shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
 195         if (shallow_file)
 196                 set_alternate_shallow_file(shallow_file, 0);
 197 }
 198
 199 int is_bare_repository(void)
 200 {
 201         /* if core.bare is not 'false', let's see if there is a work tree */
 202         return is_bare_repository_cfg && !get_git_work_tree();
 203 }
 204
 205 int have_git_dir(void)
 206 {
 207         return startup_info->have_repository
 208                 || git_dir
 209                 || getenv(GIT_DIR_ENVIRONMENT);
 210 }
 211
 212 const char *get_git_dir(void)
 213 {
 214         if (!git_dir)
 215                 setup_git_env();
 216         return git_dir;
 217 }
 218
 219 const char *get_git_common_dir(void)
 220 {
 221         if (!git_dir)
 222                 setup_git_env();
 223         return git_common_dir;
 224 }
 225
 226 const char *get_git_namespace(void)
 227 {
 228         if (!namespace)
 229                 setup_git_env();
 230         return namespace;
 231 }
 232
 233 const char *strip_namespace(const char *namespaced_ref)
 234 {
 235         if (!starts_with(namespaced_ref, get_git_namespace()))
 236                 return NULL;
 237         return namespaced_ref + namespace_len;
 238 }
 239
 240 const char *get_super_prefix(void)
 241 {
 242         static int initialized;
 243         if (!initialized) {
 244                 super_prefix = getenv(GIT_SUPER_PREFIX_ENVIRONMENT);
 245                 initialized = 1;
 246         }
 247         return super_prefix;
 248 }
 249
 250 static int git_work_tree_initialized;
 251
 252 /*
 253  * Note.  This works only before you used a work tree.  This was added
 254  * primarily to support git-clone to work in a new repository it just
 255  * created, and is not meant to flip between different work trees.
 256  */
 257 void set_git_work_tree(const char *new_work_tree)
 258 {
 259         if (git_work_tree_initialized) {
 260                 new_work_tree = real_path(new_work_tree);
 261                 if (strcmp(new_work_tree, work_tree))
 262                         die("internal error: work tree has already been set\n"
 263                             "Current worktree: %s\nNew worktree: %s",
 264                             work_tree, new_work_tree);
 265                 return;
 266         }
 267         git_work_tree_initialized = 1;
 268         work_tree = real_pathdup(new_work_tree, 1);
 269 }
 270
 271 const char *get_git_work_tree(void)
 272 {
 273         return work_tree;
 274 }
 275
 276 char *get_object_directory(void)
 277 {
 278         if (!git_object_dir)
 279                 setup_git_env();
 280         return git_object_dir;
 281 }
 282
 283 int odb_mkstemp(struct strbuf *template, const char *pattern)
 284 {
 285         int fd;
 286         /*
 287          * we let the umask do its job, don't try to be more
 288          * restrictive except to remove write permission.
 289          */
 290         int mode = 0444;
 291         git_path_buf(template, "objects/%s", pattern);
 292         fd = git_mkstemp_mode(template->buf, mode);
 293         if (0 <= fd)
 294                 return fd;
 295
 296         /* slow path */
 297         /* some mkstemp implementations erase template on failure */
 298         git_path_buf(template, "objects/%s", pattern);
 299         safe_create_leading_directories(template->buf);
 300         return xmkstemp_mode(template->buf, mode);
 301 }
 302
 303 int odb_pack_keep(const char *name)
 304 {
 305         int fd;
 306
 307         fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 308         if (0 <= fd)
 309                 return fd;
 310
 311         /* slow path */
 312         safe_create_leading_directories_const(name);
 313         return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 314 }
 315
 316 char *get_index_file(void)
 317 {
 318         if (!git_index_file)
 319                 setup_git_env();
 320         return git_index_file;
 321 }
 322
 323 char *get_graft_file(void)
 324 {
 325         if (!git_graft_file)
 326                 setup_git_env();
 327         return git_graft_file;
 328 }
 329
 330 int set_git_dir(const char *path)
 331 {
 332         if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
 333                 return error("Could not set GIT_DIR to '%s'", path);
 334         setup_git_env();
 335         return 0;
 336 }
 337
 338 const char *get_log_output_encoding(void)
 339 {
 340         return git_log_output_encoding ? git_log_output_encoding
 341                 : get_commit_output_encoding();
 342 }
 343
 344 const char *get_commit_output_encoding(void)
 345 {
 346         return git_commit_encoding ? git_commit_encoding : "UTF-8";
 347 }
 348
 349 static int the_shared_repository = PERM_UMASK;
 350 static int need_shared_repository_from_config = 1;
 351
 352 void set_shared_repository(int value)
 353 {
 354         the_shared_repository = value;
 355         need_shared_repository_from_config = 0;
 356 }
 357
 358 int get_shared_repository(void)
 359 {
 360         if (need_shared_repository_from_config) {
 361                 const char *var = "core.sharedrepository";
 362                 const char *value;
 363                 if (!git_config_get_value(var, &value))
 364                         the_shared_repository = git_config_perm(var, value);
 365                 need_shared_repository_from_config = 0;
 366         }
 367         return the_shared_repository;
 368 }
 369
 370 void reset_shared_repository(void)
 371 {
 372         need_shared_repository_from_config = 1;
 373 }