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 char *comment_line_str_to_free;
 118 int auto_comment_line_char;
 119
 120 /* Parallel index stat data preload? */
 121 int core_preload_index = 1;
 122
 123 /* This is set by setup_git_dir_gently() and/or git_default_config() */
 124 char *git_work_tree_cfg;
 125
 126 static char *git_namespace;
 127
 128 /*
 129  * Repository-local GIT_* environment variables; see environment.h for details.
 130  */
 131 const char * const local_repo_env[] = {
 132         ALTERNATE_DB_ENVIRONMENT,
 133         CONFIG_ENVIRONMENT,
 134         CONFIG_DATA_ENVIRONMENT,
 135         CONFIG_COUNT_ENVIRONMENT,
 136         DB_ENVIRONMENT,
 137         GIT_DIR_ENVIRONMENT,
 138         GIT_WORK_TREE_ENVIRONMENT,
 139         GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
 140         GRAFT_ENVIRONMENT,
 141         INDEX_ENVIRONMENT,
 142         NO_REPLACE_OBJECTS_ENVIRONMENT,
 143         GIT_REPLACE_REF_BASE_ENVIRONMENT,
 144         GIT_PREFIX_ENVIRONMENT,
 145         GIT_SHALLOW_FILE_ENVIRONMENT,
 146         GIT_COMMON_DIR_ENVIRONMENT,
 147         NULL
 148 };
 149
 150 static char *expand_namespace(const char *raw_namespace)
 151 {
 152         struct strbuf buf = STRBUF_INIT;
 153         struct strbuf **components, **c;
 154
 155         if (!raw_namespace || !*raw_namespace)
 156                 return xstrdup("");
 157
 158         strbuf_addstr(&buf, raw_namespace);
 159         components = strbuf_split(&buf, '/');
 160         strbuf_reset(&buf);
 161         for (c = components; *c; c++)
 162                 if (strcmp((*c)->buf, "/") != 0)
 163                         strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
 164         strbuf_list_free(components);
 165         if (check_refname_format(buf.buf, 0))
 166                 die(_("bad git namespace path \"%s\""), raw_namespace);
 167         strbuf_addch(&buf, '/');
 168         return strbuf_detach(&buf, NULL);
 169 }
 170
 171 const char *getenv_safe(struct strvec *argv, const char *name)
 172 {
 173         const char *value = getenv(name);
 174
 175         if (!value)
 176                 return NULL;
 177
 178         strvec_push(argv, value);
 179         return argv->v[argv->nr - 1];
 180 }
 181
 182 void setup_git_env(const char *git_dir)
 183 {
 184         char *git_replace_ref_base;
 185         const char *shallow_file;
 186         const char *replace_ref_base;
 187         struct set_gitdir_args args = { NULL };
 188         struct strvec to_free = STRVEC_INIT;
 189
 190         args.commondir = getenv_safe(&to_free, GIT_COMMON_DIR_ENVIRONMENT);
 191         args.object_dir = getenv_safe(&to_free, DB_ENVIRONMENT);
 192         args.graft_file = getenv_safe(&to_free, GRAFT_ENVIRONMENT);
 193         args.index_file = getenv_safe(&to_free, INDEX_ENVIRONMENT);
 194         args.alternate_db = getenv_safe(&to_free, ALTERNATE_DB_ENVIRONMENT);
 195         if (getenv(GIT_QUARANTINE_ENVIRONMENT)) {
 196                 args.disable_ref_updates = 1;
 197         }
 198
 199         repo_set_gitdir(the_repository, git_dir, &args);
 200         strvec_clear(&to_free);
 201
 202         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
 203                 disable_replace_refs();
 204         replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
 205         git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
 206                                                           : "refs/replace/");
 207         update_ref_namespace(NAMESPACE_REPLACE, git_replace_ref_base);
 208
 209         free(git_namespace);
 210         git_namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
 211         shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
 212         if (shallow_file)
 213                 set_alternate_shallow_file(the_repository, shallow_file, 0);
 214
 215         if (git_env_bool(NO_LAZY_FETCH_ENVIRONMENT, 0))
 216                 fetch_if_missing = 0;
 217 }
 218
 219 int is_bare_repository(void)
 220 {
 221         /* if core.bare is not 'false', let's see if there is a work tree */
 222         return is_bare_repository_cfg && !get_git_work_tree();
 223 }
 224
 225 int have_git_dir(void)
 226 {
 227         return startup_info->have_repository
 228                 || the_repository->gitdir;
 229 }
 230
 231 const char *get_git_dir(void)
 232 {
 233         if (!the_repository->gitdir)
 234                 BUG("git environment hasn't been setup");
 235         return the_repository->gitdir;
 236 }
 237
 238 const char *get_git_common_dir(void)
 239 {
 240         if (!the_repository->commondir)
 241                 BUG("git environment hasn't been setup");
 242         return the_repository->commondir;
 243 }
 244
 245 const char *get_git_namespace(void)
 246 {
 247         if (!git_namespace)
 248                 BUG("git environment hasn't been setup");
 249         return git_namespace;
 250 }
 251
 252 const char *strip_namespace(const char *namespaced_ref)
 253 {
 254         const char *out;
 255         if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
 256                 return out;
 257         return NULL;
 258 }
 259
 260 static int git_work_tree_initialized;
 261
 262 /*
 263  * Note.  This works only before you used a work tree.  This was added
 264  * primarily to support git-clone to work in a new repository it just
 265  * created, and is not meant to flip between different work trees.
 266  */
 267 void set_git_work_tree(const char *new_work_tree)
 268 {
 269         if (git_work_tree_initialized) {
 270                 struct strbuf realpath = STRBUF_INIT;
 271
 272                 strbuf_realpath(&realpath, new_work_tree, 1);
 273                 new_work_tree = realpath.buf;
 274                 if (strcmp(new_work_tree, the_repository->worktree))
 275                         die("internal error: work tree has already been set\n"
 276                             "Current worktree: %s\nNew worktree: %s",
 277                             the_repository->worktree, new_work_tree);
 278                 strbuf_release(&realpath);
 279                 return;
 280         }
 281         git_work_tree_initialized = 1;
 282         repo_set_worktree(the_repository, new_work_tree);
 283 }
 284
 285 const char *get_git_work_tree(void)
 286 {
 287         return the_repository->worktree;
 288 }
 289
 290 const char *get_object_directory(void)
 291 {
 292         if (!the_repository->objects->odb)
 293                 BUG("git environment hasn't been setup");
 294         return the_repository->objects->odb->path;
 295 }
 296
 297 int odb_mkstemp(struct strbuf *temp_filename, const char *pattern)
 298 {
 299         int fd;
 300         /*
 301          * we let the umask do its job, don't try to be more
 302          * restrictive except to remove write permission.
 303          */
 304         int mode = 0444;
 305         git_path_buf(temp_filename, "objects/%s", pattern);
 306         fd = git_mkstemp_mode(temp_filename->buf, mode);
 307         if (0 <= fd)
 308                 return fd;
 309
 310         /* slow path */
 311         /* some mkstemp implementations erase temp_filename on failure */
 312         git_path_buf(temp_filename, "objects/%s", pattern);
 313         safe_create_leading_directories(temp_filename->buf);
 314         return xmkstemp_mode(temp_filename->buf, mode);
 315 }
 316
 317 int odb_pack_keep(const char *name)
 318 {
 319         int fd;
 320
 321         fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 322         if (0 <= fd)
 323                 return fd;
 324
 325         /* slow path */
 326         safe_create_leading_directories_const(name);
 327         return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 328 }
 329
 330 char *get_index_file(void)
 331 {
 332         if (!the_repository->index_file)
 333                 BUG("git environment hasn't been setup");
 334         return the_repository->index_file;
 335 }
 336
 337 char *get_graft_file(struct repository *r)
 338 {
 339         if (!r->graft_file)
 340                 BUG("git environment hasn't been setup");
 341         return r->graft_file;
 342 }
 343
 344 static void set_git_dir_1(const char *path)
 345 {
 346         xsetenv(GIT_DIR_ENVIRONMENT, path, 1);
 347         setup_git_env(path);
 348 }
 349
 350 static void update_relative_gitdir(const char *name UNUSED,
 351                                    const char *old_cwd,
 352                                    const char *new_cwd,
 353                                    void *data UNUSED)
 354 {
 355         char *path = reparent_relative_path(old_cwd, new_cwd, get_git_dir());
 356         struct tmp_objdir *tmp_objdir = tmp_objdir_unapply_primary_odb();
 357
 358         trace_printf_key(&trace_setup_key,
 359                          "setup: move $GIT_DIR to '%s'",
 360                          path);
 361         set_git_dir_1(path);
 362         if (tmp_objdir)
 363                 tmp_objdir_reapply_primary_odb(tmp_objdir, old_cwd, new_cwd);
 364         free(path);
 365 }
 366
 367 void set_git_dir(const char *path, int make_realpath)
 368 {
 369         struct strbuf realpath = STRBUF_INIT;
 370
 371         if (make_realpath) {
 372                 strbuf_realpath(&realpath, path, 1);
 373                 path = realpath.buf;
 374         }
 375
 376         set_git_dir_1(path);
 377         if (!is_absolute_path(path))
 378                 chdir_notify_register(NULL, update_relative_gitdir, NULL);
 379
 380         strbuf_release(&realpath);
 381 }
 382
 383 const char *get_log_output_encoding(void)
 384 {
 385         return git_log_output_encoding ? git_log_output_encoding
 386                 : get_commit_output_encoding();
 387 }
 388
 389 const char *get_commit_output_encoding(void)
 390 {
 391         return git_commit_encoding ? git_commit_encoding : "UTF-8";
 392 }
 393
 394 static int the_shared_repository = PERM_UMASK;
 395 static int need_shared_repository_from_config = 1;
 396
 397 void set_shared_repository(int value)
 398 {
 399         the_shared_repository = value;
 400         need_shared_repository_from_config = 0;
 401 }
 402
 403 int get_shared_repository(void)
 404 {
 405         if (need_shared_repository_from_config) {
 406                 const char *var = "core.sharedrepository";
 407                 const char *value;
 408                 if (!git_config_get_value(var, &value))
 409                         the_shared_repository = git_config_perm(var, value);
 410                 need_shared_repository_from_config = 0;
 411         }
 412         return the_shared_repository;
 413 }
 414
 415 void reset_shared_repository(void)
 416 {
 417         need_shared_repository_from_config = 1;
 418 }
 419
 420 int use_optional_locks(void)
 421 {
 422         return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
 423 }
 424
 425 int print_sha1_ellipsis(void)
 426 {
 427         /*
 428          * Determine if the calling environment contains the variable
 429          * GIT_PRINT_SHA1_ELLIPSIS set to "yes".
 430          */
 431         static int cached_result = -1; /* unknown */
 432
 433         if (cached_result < 0) {
 434                 const char *v = getenv("GIT_PRINT_SHA1_ELLIPSIS");
 435                 cached_result = (v && !strcasecmp(v, "yes"));
 436         }
 437         return cached_result;
 438 }