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