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