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