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