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