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