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;
  46 int use_fsync = -1;
  47 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
  48 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
  49 size_t delta_base_cache_limit = 96 * 1024 * 1024;
  50 unsigned long big_file_threshold = 512 * 1024 * 1024;
  51 int pager_use_color = 1;
  52 const char *editor_program;
  53 const char *askpass_program;
  54 const char *excludes_file;
  55 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
  56 int read_replace_refs = 1;
  57 char *git_replace_ref_base;
  58 enum eol core_eol = EOL_UNSET;
  59 int global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
  60 char *check_roundtrip_encoding = "SHIFT-JIS";
  61 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
  62 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
  63 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
  64 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
  65 #ifndef OBJECT_CREATION_MODE
  66 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
  67 #endif
  68 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
  69 char *notes_ref_name;
  70 int grafts_replace_parents = 1;
  71 int core_apply_sparse_checkout;
  72 int core_sparse_checkout_cone;
  73 int merge_log_config = -1;
  74 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
  75 unsigned long pack_size_limit_cfg;
  76 enum log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
  77
  78 #ifndef PROTECT_HFS_DEFAULT
  79 #define PROTECT_HFS_DEFAULT 0
  80 #endif
  81 int protect_hfs = PROTECT_HFS_DEFAULT;
  82
  83 #ifndef PROTECT_NTFS_DEFAULT
  84 #define PROTECT_NTFS_DEFAULT 1
  85 #endif
  86 int protect_ntfs = PROTECT_NTFS_DEFAULT;
  87 const char *core_fsmonitor;
  88
  89 /*
  90  * The character that begins a commented line in user-editable file
  91  * that is subject to stripspace.
  92  */
  93 char comment_line_char = '#';
  94 int auto_comment_line_char;
  95
  96 /* Parallel index stat data preload? */
  97 int core_preload_index = 1;
  98
  99 /* This is set by setup_git_dir_gently() and/or git_default_config() */
 100 char *git_work_tree_cfg;
 101
 102 static char *git_namespace;
 103
 104 static char *super_prefix;
 105
 106 /*
 107  * Repository-local GIT_* environment variables; see cache.h for details.
 108  */
 109 const char * const local_repo_env[] = {
 110         ALTERNATE_DB_ENVIRONMENT,
 111         CONFIG_ENVIRONMENT,
 112         CONFIG_DATA_ENVIRONMENT,
 113         CONFIG_COUNT_ENVIRONMENT,
 114         DB_ENVIRONMENT,
 115         GIT_DIR_ENVIRONMENT,
 116         GIT_WORK_TREE_ENVIRONMENT,
 117         GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
 118         GRAFT_ENVIRONMENT,
 119         INDEX_ENVIRONMENT,
 120         NO_REPLACE_OBJECTS_ENVIRONMENT,
 121         GIT_REPLACE_REF_BASE_ENVIRONMENT,
 122         GIT_PREFIX_ENVIRONMENT,
 123         GIT_SUPER_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         const char *shallow_file;
 164         const char *replace_ref_base;
 165         struct set_gitdir_args args = { NULL };
 166         struct strvec to_free = STRVEC_INIT;
 167
 168         args.commondir = getenv_safe(&to_free, GIT_COMMON_DIR_ENVIRONMENT);
 169         args.object_dir = getenv_safe(&to_free, DB_ENVIRONMENT);
 170         args.graft_file = getenv_safe(&to_free, GRAFT_ENVIRONMENT);
 171         args.index_file = getenv_safe(&to_free, INDEX_ENVIRONMENT);
 172         args.alternate_db = getenv_safe(&to_free, ALTERNATE_DB_ENVIRONMENT);
 173         if (getenv(GIT_QUARANTINE_ENVIRONMENT)) {
 174                 args.disable_ref_updates = 1;
 175         }
 176
 177         repo_set_gitdir(the_repository, git_dir, &args);
 178         strvec_clear(&to_free);
 179
 180         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
 181                 read_replace_refs = 0;
 182         replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
 183         free(git_replace_ref_base);
 184         git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
 185                                                           : "refs/replace/");
 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 const char *get_super_prefix(void)
 235 {
 236         static int initialized;
 237         if (!initialized) {
 238                 super_prefix = xstrdup_or_null(getenv(GIT_SUPER_PREFIX_ENVIRONMENT));
 239                 initialized = 1;
 240         }
 241         return super_prefix;
 242 }
 243
 244 static int git_work_tree_initialized;
 245
 246 /*
 247  * Note.  This works only before you used a work tree.  This was added
 248  * primarily to support git-clone to work in a new repository it just
 249  * created, and is not meant to flip between different work trees.
 250  */
 251 void set_git_work_tree(const char *new_work_tree)
 252 {
 253         if (git_work_tree_initialized) {
 254                 struct strbuf realpath = STRBUF_INIT;
 255
 256                 strbuf_realpath(&realpath, new_work_tree, 1);
 257                 new_work_tree = realpath.buf;
 258                 if (strcmp(new_work_tree, the_repository->worktree))
 259                         die("internal error: work tree has already been set\n"
 260                             "Current worktree: %s\nNew worktree: %s",
 261                             the_repository->worktree, new_work_tree);
 262                 strbuf_release(&realpath);
 263                 return;
 264         }
 265         git_work_tree_initialized = 1;
 266         repo_set_worktree(the_repository, new_work_tree);
 267 }
 268
 269 const char *get_git_work_tree(void)
 270 {
 271         return the_repository->worktree;
 272 }
 273
 274 char *get_object_directory(void)
 275 {
 276         if (!the_repository->objects->odb)
 277                 BUG("git environment hasn't been setup");
 278         return the_repository->objects->odb->path;
 279 }
 280
 281 int odb_mkstemp(struct strbuf *temp_filename, const char *pattern)
 282 {
 283         int fd;
 284         /*
 285          * we let the umask do its job, don't try to be more
 286          * restrictive except to remove write permission.
 287          */
 288         int mode = 0444;
 289         git_path_buf(temp_filename, "objects/%s", pattern);
 290         fd = git_mkstemp_mode(temp_filename->buf, mode);
 291         if (0 <= fd)
 292                 return fd;
 293
 294         /* slow path */
 295         /* some mkstemp implementations erase temp_filename on failure */
 296         git_path_buf(temp_filename, "objects/%s", pattern);
 297         safe_create_leading_directories(temp_filename->buf);
 298         return xmkstemp_mode(temp_filename->buf, mode);
 299 }
 300
 301 int odb_pack_keep(const char *name)
 302 {
 303         int fd;
 304
 305         fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 306         if (0 <= fd)
 307                 return fd;
 308
 309         /* slow path */
 310         safe_create_leading_directories_const(name);
 311         return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 312 }
 313
 314 char *get_index_file(void)
 315 {
 316         if (!the_repository->index_file)
 317                 BUG("git environment hasn't been setup");
 318         return the_repository->index_file;
 319 }
 320
 321 char *get_graft_file(struct repository *r)
 322 {
 323         if (!r->graft_file)
 324                 BUG("git environment hasn't been setup");
 325         return r->graft_file;
 326 }
 327
 328 static void set_git_dir_1(const char *path)
 329 {
 330         xsetenv(GIT_DIR_ENVIRONMENT, path, 1);
 331         setup_git_env(path);
 332 }
 333
 334 static void update_relative_gitdir(const char *name,
 335                                    const char *old_cwd,
 336                                    const char *new_cwd,
 337                                    void *data)
 338 {
 339         char *path = reparent_relative_path(old_cwd, new_cwd, get_git_dir());
 340         struct tmp_objdir *tmp_objdir = tmp_objdir_unapply_primary_odb();
 341
 342         trace_printf_key(&trace_setup_key,
 343                          "setup: move $GIT_DIR to '%s'",
 344                          path);
 345         set_git_dir_1(path);
 346         if (tmp_objdir)
 347                 tmp_objdir_reapply_primary_odb(tmp_objdir, old_cwd, new_cwd);
 348         free(path);
 349 }
 350
 351 void set_git_dir(const char *path, int make_realpath)
 352 {
 353         struct strbuf realpath = STRBUF_INIT;
 354
 355         if (make_realpath) {
 356                 strbuf_realpath(&realpath, path, 1);
 357                 path = realpath.buf;
 358         }
 359
 360         set_git_dir_1(path);
 361         if (!is_absolute_path(path))
 362                 chdir_notify_register(NULL, update_relative_gitdir, NULL);
 363
 364         strbuf_release(&realpath);
 365 }
 366
 367 const char *get_log_output_encoding(void)
 368 {
 369         return git_log_output_encoding ? git_log_output_encoding
 370                 : get_commit_output_encoding();
 371 }
 372
 373 const char *get_commit_output_encoding(void)
 374 {
 375         return git_commit_encoding ? git_commit_encoding : "UTF-8";
 376 }
 377
 378 static int the_shared_repository = PERM_UMASK;
 379 static int need_shared_repository_from_config = 1;
 380
 381 void set_shared_repository(int value)
 382 {
 383         the_shared_repository = value;
 384         need_shared_repository_from_config = 0;
 385 }
 386
 387 int get_shared_repository(void)
 388 {
 389         if (need_shared_repository_from_config) {
 390                 const char *var = "core.sharedrepository";
 391                 const char *value;
 392                 if (!git_config_get_value(var, &value))
 393                         the_shared_repository = git_config_perm(var, value);
 394                 need_shared_repository_from_config = 0;
 395         }
 396         return the_shared_repository;
 397 }
 398
 399 void reset_shared_repository(void)
 400 {
 401         need_shared_repository_from_config = 1;
 402 }
 403
 404 int use_optional_locks(void)
 405 {
 406         return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
 407 }
 408
 409 int print_sha1_ellipsis(void)
 410 {
 411         /*
 412          * Determine if the calling environment contains the variable
 413          * GIT_PRINT_SHA1_ELLIPSIS set to "yes".
 414          */
 415         static int cached_result = -1; /* unknown */
 416
 417         if (cached_result < 0) {
 418                 const char *v = getenv("GIT_PRINT_SHA1_ELLIPSIS");
 419                 cached_result = (v && !strcasecmp(v, "yes"));
 420         }
 421         return cached_result;
 422 }