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