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