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 "git-compat-util.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-ll.h"
  24 #include "path.h"
  25 #include "replace-object.h"
  26 #include "tmp-objdir.h"
  27 #include "chdir-notify.h"
  28 #include "setup.h"
  29 #include "shallow.h"
  30 #include "trace.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 const char *git_commit_encoding;
  46 const char *git_log_output_encoding;
  47 char *apply_default_whitespace;
  48 char *apply_default_ignorewhitespace;
  49 const char *git_attributes_file;
  50 const char *git_hooks_path;
  51 int zlib_compression_level = Z_BEST_SPEED;
  52 int pack_compression_level = Z_DEFAULT_COMPRESSION;
  53 int fsync_object_files = -1;
  54 int use_fsync = -1;
  55 enum fsync_method fsync_method = FSYNC_METHOD_DEFAULT;
  56 enum fsync_component fsync_components = FSYNC_COMPONENTS_DEFAULT;
  57 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
  58 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
  59 size_t delta_base_cache_limit = 96 * 1024 * 1024;
  60 unsigned long big_file_threshold = 512 * 1024 * 1024;
  61 const char *editor_program;
  62 const char *askpass_program;
  63 const char *excludes_file;
  64 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
  65 enum eol core_eol = EOL_UNSET;
  66 int global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
  67 char *check_roundtrip_encoding = "SHIFT-JIS";
  68 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
  69 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
  70 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
  71 #ifndef OBJECT_CREATION_MODE
  72 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
  73 #endif
  74 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
  75 char *notes_ref_name;
  76 int grafts_replace_parents = 1;
  77 int core_apply_sparse_checkout;
  78 int core_sparse_checkout_cone;
  79 int sparse_expect_files_outside_of_patterns;
  80 int merge_log_config = -1;
  81 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
  82 unsigned long pack_size_limit_cfg;
  83 enum log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
  84
  85 #ifndef PROTECT_HFS_DEFAULT
  86 #define PROTECT_HFS_DEFAULT 0
  87 #endif
  88 int protect_hfs = PROTECT_HFS_DEFAULT;
  89
  90 #ifndef PROTECT_NTFS_DEFAULT
  91 #define PROTECT_NTFS_DEFAULT 1
  92 #endif
  93 int protect_ntfs = PROTECT_NTFS_DEFAULT;
  94
  95 /*
  96  * The character that begins a commented line in user-editable file
  97  * that is subject to stripspace.
  98  */
  99 char comment_line_char = '#';
 100 int auto_comment_line_char;
 101
 102 /* Parallel index stat data preload? */
 103 int core_preload_index = 1;
 104
 105 /* This is set by setup_git_dir_gently() and/or git_default_config() */
 106 char *git_work_tree_cfg;
 107
 108 static char *git_namespace;
 109
 110 /*
 111  * Repository-local GIT_* environment variables; see environment.h for details.
 112  */
 113 const char * const local_repo_env[] = {
 114         ALTERNATE_DB_ENVIRONMENT,
 115         CONFIG_ENVIRONMENT,
 116         CONFIG_DATA_ENVIRONMENT,
 117         CONFIG_COUNT_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_SHALLOW_FILE_ENVIRONMENT,
 128         GIT_COMMON_DIR_ENVIRONMENT,
 129         NULL
 130 };
 131
 132 static char *expand_namespace(const char *raw_namespace)
 133 {
 134         struct strbuf buf = STRBUF_INIT;
 135         struct strbuf **components, **c;
 136
 137         if (!raw_namespace || !*raw_namespace)
 138                 return xstrdup("");
 139
 140         strbuf_addstr(&buf, raw_namespace);
 141         components = strbuf_split(&buf, '/');
 142         strbuf_reset(&buf);
 143         for (c = components; *c; c++)
 144                 if (strcmp((*c)->buf, "/") != 0)
 145                         strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
 146         strbuf_list_free(components);
 147         if (check_refname_format(buf.buf, 0))
 148                 die(_("bad git namespace path \"%s\""), raw_namespace);
 149         strbuf_addch(&buf, '/');
 150         return strbuf_detach(&buf, NULL);
 151 }
 152
 153 const char *getenv_safe(struct strvec *argv, const char *name)
 154 {
 155         const char *value = getenv(name);
 156
 157         if (!value)
 158                 return NULL;
 159
 160         strvec_push(argv, value);
 161         return argv->v[argv->nr - 1];
 162 }
 163
 164 void setup_git_env(const char *git_dir)
 165 {
 166         char *git_replace_ref_base;
 167         const char *shallow_file;
 168         const char *replace_ref_base;
 169         struct set_gitdir_args args = { NULL };
 170         struct strvec to_free = STRVEC_INIT;
 171
 172         args.commondir = getenv_safe(&to_free, GIT_COMMON_DIR_ENVIRONMENT);
 173         args.object_dir = getenv_safe(&to_free, DB_ENVIRONMENT);
 174         args.graft_file = getenv_safe(&to_free, GRAFT_ENVIRONMENT);
 175         args.index_file = getenv_safe(&to_free, INDEX_ENVIRONMENT);
 176         args.alternate_db = getenv_safe(&to_free, ALTERNATE_DB_ENVIRONMENT);
 177         if (getenv(GIT_QUARANTINE_ENVIRONMENT)) {
 178                 args.disable_ref_updates = 1;
 179         }
 180
 181         repo_set_gitdir(the_repository, git_dir, &args);
 182         strvec_clear(&to_free);
 183
 184         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
 185                 disable_replace_refs();
 186         replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
 187         git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
 188                                                           : "refs/replace/");
 189         update_ref_namespace(NAMESPACE_REPLACE, git_replace_ref_base);
 190
 191         free(git_namespace);
 192         git_namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
 193         shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
 194         if (shallow_file)
 195                 set_alternate_shallow_file(the_repository, shallow_file, 0);
 196 }
 197
 198 int is_bare_repository(void)
 199 {
 200         /* if core.bare is not 'false', let's see if there is a work tree */
 201         return is_bare_repository_cfg && !get_git_work_tree();
 202 }
 203
 204 int have_git_dir(void)
 205 {
 206         return startup_info->have_repository
 207                 || the_repository->gitdir;
 208 }
 209
 210 const char *get_git_dir(void)
 211 {
 212         if (!the_repository->gitdir)
 213                 BUG("git environment hasn't been setup");
 214         return the_repository->gitdir;
 215 }
 216
 217 const char *get_git_common_dir(void)
 218 {
 219         if (!the_repository->commondir)
 220                 BUG("git environment hasn't been setup");
 221         return the_repository->commondir;
 222 }
 223
 224 const char *get_git_namespace(void)
 225 {
 226         if (!git_namespace)
 227                 BUG("git environment hasn't been setup");
 228         return git_namespace;
 229 }
 230
 231 const char *strip_namespace(const char *namespaced_ref)
 232 {
 233         const char *out;
 234         if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
 235                 return out;
 236         return NULL;
 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 const 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 UNUSED,
 330                                    const char *old_cwd,
 331                                    const char *new_cwd,
 332                                    void *data UNUSED)
 333 {
 334         char *path = reparent_relative_path(old_cwd, new_cwd, get_git_dir());
 335         struct tmp_objdir *tmp_objdir = tmp_objdir_unapply_primary_odb();
 336
 337         trace_printf_key(&trace_setup_key,
 338                          "setup: move $GIT_DIR to '%s'",
 339                          path);
 340         set_git_dir_1(path);
 341         if (tmp_objdir)
 342                 tmp_objdir_reapply_primary_odb(tmp_objdir, old_cwd, new_cwd);
 343         free(path);
 344 }
 345
 346 void set_git_dir(const char *path, int make_realpath)
 347 {
 348         struct strbuf realpath = STRBUF_INIT;
 349
 350         if (make_realpath) {
 351                 strbuf_realpath(&realpath, path, 1);
 352                 path = realpath.buf;
 353         }
 354
 355         set_git_dir_1(path);
 356         if (!is_absolute_path(path))
 357                 chdir_notify_register(NULL, update_relative_gitdir, NULL);
 358
 359         strbuf_release(&realpath);
 360 }
 361
 362 const char *get_log_output_encoding(void)
 363 {
 364         return git_log_output_encoding ? git_log_output_encoding
 365                 : get_commit_output_encoding();
 366 }
 367
 368 const char *get_commit_output_encoding(void)
 369 {
 370         return git_commit_encoding ? git_commit_encoding : "UTF-8";
 371 }
 372
 373 static int the_shared_repository = PERM_UMASK;
 374 static int need_shared_repository_from_config = 1;
 375
 376 void set_shared_repository(int value)
 377 {
 378         the_shared_repository = value;
 379         need_shared_repository_from_config = 0;
 380 }
 381
 382 int get_shared_repository(void)
 383 {
 384         if (need_shared_repository_from_config) {
 385                 const char *var = "core.sharedrepository";
 386                 const char *value;
 387                 if (!git_config_get_value(var, &value))
 388                         the_shared_repository = git_config_perm(var, value);
 389                 need_shared_repository_from_config = 0;
 390         }
 391         return the_shared_repository;
 392 }
 393
 394 void reset_shared_repository(void)
 395 {
 396         need_shared_repository_from_config = 1;
 397 }
 398
 399 int use_optional_locks(void)
 400 {
 401         return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
 402 }
 403
 404 int print_sha1_ellipsis(void)
 405 {
 406         /*
 407          * Determine if the calling environment contains the variable
 408          * GIT_PRINT_SHA1_ELLIPSIS set to "yes".
 409          */
 410         static int cached_result = -1; /* unknown */
 411
 412         if (cached_result < 0) {
 413                 const char *v = getenv("GIT_PRINT_SHA1_ELLIPSIS");
 414                 cached_result = (v && !strcasecmp(v, "yes"));
 415         }
 416         return cached_result;
 417 }