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