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