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