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 "abspath.h"
  12 #include "branch.h"
  13 #include "convert.h"
  14 #include "environment.h"
  15 #include "gettext.h"
  16 #include "repository.h"
  17 #include "config.h"
  18 #include "refs.h"
  19 #include "fmt-merge-msg.h"
  20 #include "commit.h"
  21 #include "strvec.h"
  22 #include "object-file.h"
  23 #include "object-store.h"
  24 #include "replace-object.h"
  25 #include "tmp-objdir.h"
  26 #include "chdir-notify.h"
  27 #include "setup.h"
  28 #include "shallow.h"
  29 #include "trace.h"
  30 #include "wrapper.h"
  31 #include "write-or-die.h"
  32
  33 int trust_executable_bit = 1;
  34 int trust_ctime = 1;
  35 int check_stat = 1;
  36 int has_symlinks = 1;
  37 int minimum_abbrev = 4, default_abbrev = -1;
  38 int ignore_case;
  39 int assume_unchanged;
  40 int prefer_symlink_refs;
  41 int is_bare_repository_cfg = -1; /* unspecified */
  42 int warn_ambiguous_refs = 1;
  43 int warn_on_object_refname_ambiguity = 1;
  44 int repository_format_precious_objects;
  45 int repository_format_worktree_config;
  46 const char *git_commit_encoding;
  47 const char *git_log_output_encoding;
  48 char *apply_default_whitespace;
  49 char *apply_default_ignorewhitespace;
  50 const char *git_attributes_file;
  51 const char *git_hooks_path;
  52 int zlib_compression_level = Z_BEST_SPEED;
  53 int pack_compression_level = Z_DEFAULT_COMPRESSION;
  54 int fsync_object_files = -1;
  55 int use_fsync = -1;
  56 enum fsync_method fsync_method = FSYNC_METHOD_DEFAULT;
  57 enum fsync_component fsync_components = FSYNC_COMPONENTS_DEFAULT;
  58 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
  59 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
  60 size_t delta_base_cache_limit = 96 * 1024 * 1024;
  61 unsigned long big_file_threshold = 512 * 1024 * 1024;
  62 int pager_use_color = 1;
  63 const char *editor_program;
  64 const char *askpass_program;
  65 const char *excludes_file;
  66 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
  67 int read_replace_refs = 1;
  68 enum eol core_eol = EOL_UNSET;
  69 int global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
  70 char *check_roundtrip_encoding = "SHIFT-JIS";
  71 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
  72 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
  73 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
  74 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
  75 #ifndef OBJECT_CREATION_MODE
  76 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
  77 #endif
  78 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
  79 char *notes_ref_name;
  80 int grafts_replace_parents = 1;
  81 int core_apply_sparse_checkout;
  82 int core_sparse_checkout_cone;
  83 int sparse_expect_files_outside_of_patterns;
  84 int merge_log_config = -1;
  85 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
  86 unsigned long pack_size_limit_cfg;
  87 enum log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
  88
  89 #ifndef PROTECT_HFS_DEFAULT
  90 #define PROTECT_HFS_DEFAULT 0
  91 #endif
  92 int protect_hfs = PROTECT_HFS_DEFAULT;
  93
  94 #ifndef PROTECT_NTFS_DEFAULT
  95 #define PROTECT_NTFS_DEFAULT 1
  96 #endif
  97 int protect_ntfs = PROTECT_NTFS_DEFAULT;
  98
  99 /*
 100  * The character that begins a commented line in user-editable file
 101  * that is subject to stripspace.
 102  */
 103 char comment_line_char = '#';
 104 int auto_comment_line_char;
 105
 106 /* Parallel index stat data preload? */
 107 int core_preload_index = 1;
 108
 109 /* This is set by setup_git_dir_gently() and/or git_default_config() */
 110 char *git_work_tree_cfg;
 111
 112 static char *git_namespace;
 113
 114 /*
 115  * Repository-local GIT_* environment variables; see cache.h for details.
 116  */
 117 const char * const local_repo_env[] = {
 118         ALTERNATE_DB_ENVIRONMENT,
 119         CONFIG_ENVIRONMENT,
 120         CONFIG_DATA_ENVIRONMENT,
 121         CONFIG_COUNT_ENVIRONMENT,
 122         DB_ENVIRONMENT,
 123         GIT_DIR_ENVIRONMENT,
 124         GIT_WORK_TREE_ENVIRONMENT,
 125         GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
 126         GRAFT_ENVIRONMENT,
 127         INDEX_ENVIRONMENT,
 128         NO_REPLACE_OBJECTS_ENVIRONMENT,
 129         GIT_REPLACE_REF_BASE_ENVIRONMENT,
 130         GIT_PREFIX_ENVIRONMENT,
 131         GIT_SHALLOW_FILE_ENVIRONMENT,
 132         GIT_COMMON_DIR_ENVIRONMENT,
 133         NULL
 134 };
 135
 136 static char *expand_namespace(const char *raw_namespace)
 137 {
 138         struct strbuf buf = STRBUF_INIT;
 139         struct strbuf **components, **c;
 140
 141         if (!raw_namespace || !*raw_namespace)
 142                 return xstrdup("");
 143
 144         strbuf_addstr(&buf, raw_namespace);
 145         components = strbuf_split(&buf, '/');
 146         strbuf_reset(&buf);
 147         for (c = components; *c; c++)
 148                 if (strcmp((*c)->buf, "/") != 0)
 149                         strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
 150         strbuf_list_free(components);
 151         if (check_refname_format(buf.buf, 0))
 152                 die(_("bad git namespace path \"%s\""), raw_namespace);
 153         strbuf_addch(&buf, '/');
 154         return strbuf_detach(&buf, NULL);
 155 }
 156
 157 const char *getenv_safe(struct strvec *argv, const char *name)
 158 {
 159         const char *value = getenv(name);
 160
 161         if (!value)
 162                 return NULL;
 163
 164         strvec_push(argv, value);
 165         return argv->v[argv->nr - 1];
 166 }
 167
 168 void setup_git_env(const char *git_dir)
 169 {
 170         char *git_replace_ref_base;
 171         const char *shallow_file;
 172         const char *replace_ref_base;
 173         struct set_gitdir_args args = { NULL };
 174         struct strvec to_free = STRVEC_INIT;
 175
 176         args.commondir = getenv_safe(&to_free, GIT_COMMON_DIR_ENVIRONMENT);
 177         args.object_dir = getenv_safe(&to_free, DB_ENVIRONMENT);
 178         args.graft_file = getenv_safe(&to_free, GRAFT_ENVIRONMENT);
 179         args.index_file = getenv_safe(&to_free, INDEX_ENVIRONMENT);
 180         args.alternate_db = getenv_safe(&to_free, ALTERNATE_DB_ENVIRONMENT);
 181         if (getenv(GIT_QUARANTINE_ENVIRONMENT)) {
 182                 args.disable_ref_updates = 1;
 183         }
 184
 185         repo_set_gitdir(the_repository, git_dir, &args);
 186         strvec_clear(&to_free);
 187
 188         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
 189                 read_replace_refs = 0;
 190         replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
 191         git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
 192                                                           : "refs/replace/");
 193         update_ref_namespace(NAMESPACE_REPLACE, git_replace_ref_base);
 194
 195         free(git_namespace);
 196         git_namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
 197         shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
 198         if (shallow_file)
 199                 set_alternate_shallow_file(the_repository, shallow_file, 0);
 200 }
 201
 202 int is_bare_repository(void)
 203 {
 204         /* if core.bare is not 'false', let's see if there is a work tree */
 205         return is_bare_repository_cfg && !get_git_work_tree();
 206 }
 207
 208 int have_git_dir(void)
 209 {
 210         return startup_info->have_repository
 211                 || the_repository->gitdir;
 212 }
 213
 214 const char *get_git_dir(void)
 215 {
 216         if (!the_repository->gitdir)
 217                 BUG("git environment hasn't been setup");
 218         return the_repository->gitdir;
 219 }
 220
 221 const char *get_git_common_dir(void)
 222 {
 223         if (!the_repository->commondir)
 224                 BUG("git environment hasn't been setup");
 225         return the_repository->commondir;
 226 }
 227
 228 const char *get_git_namespace(void)
 229 {
 230         if (!git_namespace)
 231                 BUG("git environment hasn't been setup");
 232         return git_namespace;
 233 }
 234
 235 const char *strip_namespace(const char *namespaced_ref)
 236 {
 237         const char *out;
 238         if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
 239                 return out;
 240         return NULL;
 241 }
 242
 243 static int git_work_tree_initialized;
 244
 245 /*
 246  * Note.  This works only before you used a work tree.  This was added
 247  * primarily to support git-clone to work in a new repository it just
 248  * created, and is not meant to flip between different work trees.
 249  */
 250 void set_git_work_tree(const char *new_work_tree)
 251 {
 252         if (git_work_tree_initialized) {
 253                 struct strbuf realpath = STRBUF_INIT;
 254
 255                 strbuf_realpath(&realpath, new_work_tree, 1);
 256                 new_work_tree = realpath.buf;
 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                 strbuf_release(&realpath);
 262                 return;
 263         }
 264         git_work_tree_initialized = 1;
 265         repo_set_worktree(the_repository, new_work_tree);
 266 }
 267
 268 const char *get_git_work_tree(void)
 269 {
 270         return the_repository->worktree;
 271 }
 272
 273 const char *get_object_directory(void)
 274 {
 275         if (!the_repository->objects->odb)
 276                 BUG("git environment hasn't been setup");
 277         return the_repository->objects->odb->path;
 278 }
 279
 280 int odb_mkstemp(struct strbuf *temp_filename, const char *pattern)
 281 {
 282         int fd;
 283         /*
 284          * we let the umask do its job, don't try to be more
 285          * restrictive except to remove write permission.
 286          */
 287         int mode = 0444;
 288         git_path_buf(temp_filename, "objects/%s", pattern);
 289         fd = git_mkstemp_mode(temp_filename->buf, mode);
 290         if (0 <= fd)
 291                 return fd;
 292
 293         /* slow path */
 294         /* some mkstemp implementations erase temp_filename on failure */
 295         git_path_buf(temp_filename, "objects/%s", pattern);
 296         safe_create_leading_directories(temp_filename->buf);
 297         return xmkstemp_mode(temp_filename->buf, mode);
 298 }
 299
 300 int odb_pack_keep(const char *name)
 301 {
 302         int fd;
 303
 304         fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 305         if (0 <= fd)
 306                 return fd;
 307
 308         /* slow path */
 309         safe_create_leading_directories_const(name);
 310         return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 311 }
 312
 313 char *get_index_file(void)
 314 {
 315         if (!the_repository->index_file)
 316                 BUG("git environment hasn't been setup");
 317         return the_repository->index_file;
 318 }
 319
 320 char *get_graft_file(struct repository *r)
 321 {
 322         if (!r->graft_file)
 323                 BUG("git environment hasn't been setup");
 324         return r->graft_file;
 325 }
 326
 327 static void set_git_dir_1(const char *path)
 328 {
 329         xsetenv(GIT_DIR_ENVIRONMENT, path, 1);
 330         setup_git_env(path);
 331 }
 332
 333 static void update_relative_gitdir(const char *name UNUSED,
 334                                    const char *old_cwd,
 335                                    const char *new_cwd,
 336                                    void *data UNUSED)
 337 {
 338         char *path = reparent_relative_path(old_cwd, new_cwd, get_git_dir());
 339         struct tmp_objdir *tmp_objdir = tmp_objdir_unapply_primary_odb();
 340
 341         trace_printf_key(&trace_setup_key,
 342                          "setup: move $GIT_DIR to '%s'",
 343                          path);
 344         set_git_dir_1(path);
 345         if (tmp_objdir)
 346                 tmp_objdir_reapply_primary_odb(tmp_objdir, old_cwd, new_cwd);
 347         free(path);
 348 }
 349
 350 void set_git_dir(const char *path, int make_realpath)
 351 {
 352         struct strbuf realpath = STRBUF_INIT;
 353
 354         if (make_realpath) {
 355                 strbuf_realpath(&realpath, path, 1);
 356                 path = realpath.buf;
 357         }
 358
 359         set_git_dir_1(path);
 360         if (!is_absolute_path(path))
 361                 chdir_notify_register(NULL, update_relative_gitdir, NULL);
 362
 363         strbuf_release(&realpath);
 364 }
 365
 366 const char *get_log_output_encoding(void)
 367 {
 368         return git_log_output_encoding ? git_log_output_encoding
 369                 : get_commit_output_encoding();
 370 }
 371
 372 const char *get_commit_output_encoding(void)
 373 {
 374         return git_commit_encoding ? git_commit_encoding : "UTF-8";
 375 }
 376
 377 static int the_shared_repository = PERM_UMASK;
 378 static int need_shared_repository_from_config = 1;
 379
 380 void set_shared_repository(int value)
 381 {
 382         the_shared_repository = value;
 383         need_shared_repository_from_config = 0;
 384 }
 385
 386 int get_shared_repository(void)
 387 {
 388         if (need_shared_repository_from_config) {
 389                 const char *var = "core.sharedrepository";
 390                 const char *value;
 391                 if (!git_config_get_value(var, &value))
 392                         the_shared_repository = git_config_perm(var, value);
 393                 need_shared_repository_from_config = 0;
 394         }
 395         return the_shared_repository;
 396 }
 397
 398 void reset_shared_repository(void)
 399 {
 400         need_shared_repository_from_config = 1;
 401 }
 402
 403 int use_optional_locks(void)
 404 {
 405         return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
 406 }
 407
 408 int print_sha1_ellipsis(void)
 409 {
 410         /*
 411          * Determine if the calling environment contains the variable
 412          * GIT_PRINT_SHA1_ELLIPSIS set to "yes".
 413          */
 414         static int cached_result = -1; /* unknown */
 415
 416         if (cached_result < 0) {
 417                 const char *v = getenv("GIT_PRINT_SHA1_ELLIPSIS");
 418                 cached_result = (v && !strcasecmp(v, "yes"));
 419         }
 420         return cached_result;
 421 }