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 "repository.h"
  12 #include "config.h"
  13 #include "refs.h"
  14 #include "fmt-merge-msg.h"
  15 #include "commit.h"
  16 #include "argv-array.h"
  17 #include "object-store.h"
  18
  19 int trust_executable_bit = 1;
  20 int trust_ctime = 1;
  21 int check_stat = 1;
  22 int has_symlinks = 1;
  23 int minimum_abbrev = 4, default_abbrev = -1;
  24 int ignore_case;
  25 int assume_unchanged;
  26 int prefer_symlink_refs;
  27 int is_bare_repository_cfg = -1; /* unspecified */
  28 int warn_ambiguous_refs = 1;
  29 int warn_on_object_refname_ambiguity = 1;
  30 int ref_paranoia = -1;
  31 int repository_format_precious_objects;
  32 char *repository_format_partial_clone;
  33 const char *core_partial_clone_filter_default;
  34 const char *git_commit_encoding;
  35 const char *git_log_output_encoding;
  36 const char *apply_default_whitespace;
  37 const char *apply_default_ignorewhitespace;
  38 const char *git_attributes_file;
  39 const char *git_hooks_path;
  40 int zlib_compression_level = Z_BEST_SPEED;
  41 int core_compression_level;
  42 int pack_compression_level = Z_DEFAULT_COMPRESSION;
  43 int fsync_object_files;
  44 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
  45 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
  46 size_t delta_base_cache_limit = 96 * 1024 * 1024;
  47 unsigned long big_file_threshold = 512 * 1024 * 1024;
  48 int pager_use_color = 1;
  49 const char *editor_program;
  50 const char *askpass_program;
  51 const char *excludes_file;
  52 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
  53 int check_replace_refs = 1; /* NEEDSWORK: rename to read_replace_refs */
  54 char *git_replace_ref_base;
  55 enum eol core_eol = EOL_UNSET;
  56 int global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
  57 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
  58 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
  59 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
  60 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
  61 #ifndef OBJECT_CREATION_MODE
  62 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
  63 #endif
  64 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
  65 char *notes_ref_name;
  66 int grafts_replace_parents = 1;
  67 int core_apply_sparse_checkout;
  68 int merge_log_config = -1;
  69 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
  70 unsigned long pack_size_limit_cfg;
  71 enum hide_dotfiles_type hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
  72 enum log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
  73
  74 #ifndef PROTECT_HFS_DEFAULT
  75 #define PROTECT_HFS_DEFAULT 0
  76 #endif
  77 int protect_hfs = PROTECT_HFS_DEFAULT;
  78
  79 #ifndef PROTECT_NTFS_DEFAULT
  80 #define PROTECT_NTFS_DEFAULT 0
  81 #endif
  82 int protect_ntfs = PROTECT_NTFS_DEFAULT;
  83 const char *core_fsmonitor;
  84
  85 /*
  86  * The character that begins a commented line in user-editable file
  87  * that is subject to stripspace.
  88  */
  89 char comment_line_char = '#';
  90 int auto_comment_line_char;
  91
  92 /* Parallel index stat data preload? */
  93 int core_preload_index = 1;
  94
  95 /*
  96  * This is a hack for test programs like test-dump-untracked-cache to
  97  * ensure that they do not modify the untracked cache when reading it.
  98  * Do not use it otherwise!
  99  */
 100 int ignore_untracked_cache_config;
 101
 102 /* This is set by setup_git_dir_gently() and/or git_default_config() */
 103 char *git_work_tree_cfg;
 104
 105 static char *git_namespace;
 106
 107 static const char *super_prefix;
 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 /*
 153  * Wrapper of getenv() that returns a strdup value. This value is kept
 154  * in argv to be freed later.
 155  */
 156 static const char *getenv_safe(struct argv_array *argv, const char *name)
 157 {
 158         const char *value = getenv(name);
 159
 160         if (!value)
 161                 return NULL;
 162
 163         argv_array_push(argv, value);
 164         return argv->argv[argv->argc - 1];
 165 }
 166
 167 void setup_git_env(const char *git_dir)
 168 {
 169         const char *shallow_file;
 170         const char *replace_ref_base;
 171         struct set_gitdir_args args = { NULL };
 172         struct argv_array to_free = ARGV_ARRAY_INIT;
 173
 174         args.commondir = getenv_safe(&to_free, GIT_COMMON_DIR_ENVIRONMENT);
 175         args.object_dir = getenv_safe(&to_free, DB_ENVIRONMENT);
 176         args.graft_file = getenv_safe(&to_free, GRAFT_ENVIRONMENT);
 177         args.index_file = getenv_safe(&to_free, INDEX_ENVIRONMENT);
 178         args.alternate_db = getenv_safe(&to_free, ALTERNATE_DB_ENVIRONMENT);
 179         repo_set_gitdir(the_repository, git_dir, &args);
 180         argv_array_clear(&to_free);
 181
 182         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
 183                 check_replace_refs = 0;
 184         replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
 185         free(git_replace_ref_base);
 186         git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
 187                                                           : "refs/replace/");
 188         free(git_namespace);
 189         git_namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
 190         shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
 191         if (shallow_file)
 192                 set_alternate_shallow_file(shallow_file, 0);
 193 }
 194
 195 int is_bare_repository(void)
 196 {
 197         /* if core.bare is not 'false', let's see if there is a work tree */
 198         return is_bare_repository_cfg && !get_git_work_tree();
 199 }
 200
 201 int have_git_dir(void)
 202 {
 203         return startup_info->have_repository
 204                 || the_repository->gitdir;
 205 }
 206
 207 const char *get_git_dir(void)
 208 {
 209         if (!the_repository->gitdir)
 210                 BUG("git environment hasn't been setup");
 211         return the_repository->gitdir;
 212 }
 213
 214 const char *get_git_common_dir(void)
 215 {
 216         if (!the_repository->commondir)
 217                 BUG("git environment hasn't been setup");
 218         return the_repository->commondir;
 219 }
 220
 221 const char *get_git_namespace(void)
 222 {
 223         if (!git_namespace)
 224                 BUG("git environment hasn't been setup");
 225         return git_namespace;
 226 }
 227
 228 const char *strip_namespace(const char *namespaced_ref)
 229 {
 230         const char *out;
 231         if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
 232                 return out;
 233         return NULL;
 234 }
 235
 236 const char *get_super_prefix(void)
 237 {
 238         static int initialized;
 239         if (!initialized) {
 240                 super_prefix = getenv(GIT_SUPER_PREFIX_ENVIRONMENT);
 241                 initialized = 1;
 242         }
 243         return super_prefix;
 244 }
 245
 246 static int git_work_tree_initialized;
 247
 248 /*
 249  * Note.  This works only before you used a work tree.  This was added
 250  * primarily to support git-clone to work in a new repository it just
 251  * created, and is not meant to flip between different work trees.
 252  */
 253 void set_git_work_tree(const char *new_work_tree)
 254 {
 255         if (git_work_tree_initialized) {
 256                 new_work_tree = real_path(new_work_tree);
 257                 if (strcmp(new_work_tree, the_repository->worktree))
 258                         die("internal error: work tree has already been set\n"
 259                             "Current worktree: %s\nNew worktree: %s",
 260                             the_repository->worktree, new_work_tree);
 261                 return;
 262         }
 263         git_work_tree_initialized = 1;
 264         repo_set_worktree(the_repository, new_work_tree);
 265 }
 266
 267 const char *get_git_work_tree(void)
 268 {
 269         return the_repository->worktree;
 270 }
 271
 272 char *get_object_directory(void)
 273 {
 274         if (!the_repository->objects->objectdir)
 275                 BUG("git environment hasn't been setup");
 276         return the_repository->objects->objectdir;
 277 }
 278
 279 int odb_mkstemp(struct strbuf *temp_filename, const char *pattern)
 280 {
 281         int fd;
 282         /*
 283          * we let the umask do its job, don't try to be more
 284          * restrictive except to remove write permission.
 285          */
 286         int mode = 0444;
 287         git_path_buf(temp_filename, "objects/%s", pattern);
 288         fd = git_mkstemp_mode(temp_filename->buf, mode);
 289         if (0 <= fd)
 290                 return fd;
 291
 292         /* slow path */
 293         /* some mkstemp implementations erase temp_filename on failure */
 294         git_path_buf(temp_filename, "objects/%s", pattern);
 295         safe_create_leading_directories(temp_filename->buf);
 296         return xmkstemp_mode(temp_filename->buf, mode);
 297 }
 298
 299 int odb_pack_keep(const char *name)
 300 {
 301         int fd;
 302
 303         fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 304         if (0 <= fd)
 305                 return fd;
 306
 307         /* slow path */
 308         safe_create_leading_directories_const(name);
 309         return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 310 }
 311
 312 char *get_index_file(void)
 313 {
 314         if (!the_repository->index_file)
 315                 BUG("git environment hasn't been setup");
 316         return the_repository->index_file;
 317 }
 318
 319 char *get_graft_file(void)
 320 {
 321         if (!the_repository->graft_file)
 322                 BUG("git environment hasn't been setup");
 323         return the_repository->graft_file;
 324 }
 325
 326 int set_git_dir(const char *path)
 327 {
 328         if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
 329                 return error("Could not set GIT_DIR to '%s'", path);
 330         setup_git_env(path);
 331         return 0;
 332 }
 333
 334 const char *get_log_output_encoding(void)
 335 {
 336         return git_log_output_encoding ? git_log_output_encoding
 337                 : get_commit_output_encoding();
 338 }
 339
 340 const char *get_commit_output_encoding(void)
 341 {
 342         return git_commit_encoding ? git_commit_encoding : "UTF-8";
 343 }
 344
 345 static int the_shared_repository = PERM_UMASK;
 346 static int need_shared_repository_from_config = 1;
 347
 348 void set_shared_repository(int value)
 349 {
 350         the_shared_repository = value;
 351         need_shared_repository_from_config = 0;
 352 }
 353
 354 int get_shared_repository(void)
 355 {
 356         if (need_shared_repository_from_config) {
 357                 const char *var = "core.sharedrepository";
 358                 const char *value;
 359                 if (!git_config_get_value(var, &value))
 360                         the_shared_repository = git_config_perm(var, value);
 361                 need_shared_repository_from_config = 0;
 362         }
 363         return the_shared_repository;
 364 }
 365
 366 void reset_shared_repository(void)
 367 {
 368         need_shared_repository_from_config = 1;
 369 }
 370
 371 int use_optional_locks(void)
 372 {
 373         return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
 374 }
 375
 376 int print_sha1_ellipsis(void)
 377 {
 378         /*
 379          * Determine if the calling environment contains the variable
 380          * GIT_PRINT_SHA1_ELLIPSIS set to "yes".
 381          */
 382         static int cached_result = -1; /* unknown */
 383
 384         if (cached_result < 0) {
 385                 const char *v = getenv("GIT_PRINT_SHA1_ELLIPSIS");
 386                 cached_result = (v && !strcasecmp(v, "yes"));
 387         }
 388         return cached_result;
 389 }