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