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