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 repository_format_precious_objects;
  35 int repository_format_worktree_config;
  36 const char *git_commit_encoding;
  37 const char *git_log_output_encoding;
  38 char *apply_default_whitespace;
  39 char *apply_default_ignorewhitespace;
  40 const char *git_attributes_file;
  41 const char *git_hooks_path;
  42 int zlib_compression_level = Z_BEST_SPEED;
  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 /* This is set by setup_git_dir_gently() and/or git_default_config() */
  98 char *git_work_tree_cfg;
  99
 100 static char *git_namespace;
 101
 102 static char *super_prefix;
 103
 104 /*
 105  * Repository-local GIT_* environment variables; see cache.h for details.
 106  */
 107 const char * const local_repo_env[] = {
 108         ALTERNATE_DB_ENVIRONMENT,
 109         CONFIG_ENVIRONMENT,
 110         CONFIG_DATA_ENVIRONMENT,
 111         CONFIG_COUNT_ENVIRONMENT,
 112         DB_ENVIRONMENT,
 113         GIT_DIR_ENVIRONMENT,
 114         GIT_WORK_TREE_ENVIRONMENT,
 115         GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
 116         GRAFT_ENVIRONMENT,
 117         INDEX_ENVIRONMENT,
 118         NO_REPLACE_OBJECTS_ENVIRONMENT,
 119         GIT_REPLACE_REF_BASE_ENVIRONMENT,
 120         GIT_PREFIX_ENVIRONMENT,
 121         GIT_SUPER_PREFIX_ENVIRONMENT,
 122         GIT_SHALLOW_FILE_ENVIRONMENT,
 123         GIT_COMMON_DIR_ENVIRONMENT,
 124         NULL
 125 };
 126
 127 static char *expand_namespace(const char *raw_namespace)
 128 {
 129         struct strbuf buf = STRBUF_INIT;
 130         struct strbuf **components, **c;
 131
 132         if (!raw_namespace || !*raw_namespace)
 133                 return xstrdup("");
 134
 135         strbuf_addstr(&buf, raw_namespace);
 136         components = strbuf_split(&buf, '/');
 137         strbuf_reset(&buf);
 138         for (c = components; *c; c++)
 139                 if (strcmp((*c)->buf, "/") != 0)
 140                         strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
 141         strbuf_list_free(components);
 142         if (check_refname_format(buf.buf, 0))
 143                 die(_("bad git namespace path \"%s\""), raw_namespace);
 144         strbuf_addch(&buf, '/');
 145         return strbuf_detach(&buf, NULL);
 146 }
 147
 148 const char *getenv_safe(struct strvec *argv, const char *name)
 149 {
 150         const char *value = getenv(name);
 151
 152         if (!value)
 153                 return NULL;
 154
 155         strvec_push(argv, value);
 156         return argv->v[argv->nr - 1];
 157 }
 158
 159 void setup_git_env(const char *git_dir)
 160 {
 161         const char *shallow_file;
 162         const char *replace_ref_base;
 163         struct set_gitdir_args args = { NULL };
 164         struct strvec to_free = STRVEC_INIT;
 165
 166         args.commondir = getenv_safe(&to_free, GIT_COMMON_DIR_ENVIRONMENT);
 167         args.object_dir = getenv_safe(&to_free, DB_ENVIRONMENT);
 168         args.graft_file = getenv_safe(&to_free, GRAFT_ENVIRONMENT);
 169         args.index_file = getenv_safe(&to_free, INDEX_ENVIRONMENT);
 170         args.alternate_db = getenv_safe(&to_free, ALTERNATE_DB_ENVIRONMENT);
 171         repo_set_gitdir(the_repository, git_dir, &args);
 172         strvec_clear(&to_free);
 173
 174         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
 175                 read_replace_refs = 0;
 176         replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
 177         free(git_replace_ref_base);
 178         git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
 179                                                           : "refs/replace/");
 180         free(git_namespace);
 181         git_namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
 182         shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
 183         if (shallow_file)
 184                 set_alternate_shallow_file(the_repository, shallow_file, 0);
 185 }
 186
 187 int is_bare_repository(void)
 188 {
 189         /* if core.bare is not 'false', let's see if there is a work tree */
 190         return is_bare_repository_cfg && !get_git_work_tree();
 191 }
 192
 193 int have_git_dir(void)
 194 {
 195         return startup_info->have_repository
 196                 || the_repository->gitdir;
 197 }
 198
 199 const char *get_git_dir(void)
 200 {
 201         if (!the_repository->gitdir)
 202                 BUG("git environment hasn't been setup");
 203         return the_repository->gitdir;
 204 }
 205
 206 const char *get_git_common_dir(void)
 207 {
 208         if (!the_repository->commondir)
 209                 BUG("git environment hasn't been setup");
 210         return the_repository->commondir;
 211 }
 212
 213 const char *get_git_namespace(void)
 214 {
 215         if (!git_namespace)
 216                 BUG("git environment hasn't been setup");
 217         return git_namespace;
 218 }
 219
 220 const char *strip_namespace(const char *namespaced_ref)
 221 {
 222         const char *out;
 223         if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
 224                 return out;
 225         return NULL;
 226 }
 227
 228 const char *get_super_prefix(void)
 229 {
 230         static int initialized;
 231         if (!initialized) {
 232                 super_prefix = xstrdup_or_null(getenv(GIT_SUPER_PREFIX_ENVIRONMENT));
 233                 initialized = 1;
 234         }
 235         return super_prefix;
 236 }
 237
 238 static int git_work_tree_initialized;
 239
 240 /*
 241  * Note.  This works only before you used a work tree.  This was added
 242  * primarily to support git-clone to work in a new repository it just
 243  * created, and is not meant to flip between different work trees.
 244  */
 245 void set_git_work_tree(const char *new_work_tree)
 246 {
 247         if (git_work_tree_initialized) {
 248                 struct strbuf realpath = STRBUF_INIT;
 249
 250                 strbuf_realpath(&realpath, new_work_tree, 1);
 251                 new_work_tree = realpath.buf;
 252                 if (strcmp(new_work_tree, the_repository->worktree))
 253                         die("internal error: work tree has already been set\n"
 254                             "Current worktree: %s\nNew worktree: %s",
 255                             the_repository->worktree, new_work_tree);
 256                 strbuf_release(&realpath);
 257                 return;
 258         }
 259         git_work_tree_initialized = 1;
 260         repo_set_worktree(the_repository, new_work_tree);
 261 }
 262
 263 const char *get_git_work_tree(void)
 264 {
 265         return the_repository->worktree;
 266 }
 267
 268 char *get_object_directory(void)
 269 {
 270         if (!the_repository->objects->odb)
 271                 BUG("git environment hasn't been setup");
 272         return the_repository->objects->odb->path;
 273 }
 274
 275 int odb_mkstemp(struct strbuf *temp_filename, const char *pattern)
 276 {
 277         int fd;
 278         /*
 279          * we let the umask do its job, don't try to be more
 280          * restrictive except to remove write permission.
 281          */
 282         int mode = 0444;
 283         git_path_buf(temp_filename, "objects/%s", pattern);
 284         fd = git_mkstemp_mode(temp_filename->buf, mode);
 285         if (0 <= fd)
 286                 return fd;
 287
 288         /* slow path */
 289         /* some mkstemp implementations erase temp_filename on failure */
 290         git_path_buf(temp_filename, "objects/%s", pattern);
 291         safe_create_leading_directories(temp_filename->buf);
 292         return xmkstemp_mode(temp_filename->buf, mode);
 293 }
 294
 295 int odb_pack_keep(const char *name)
 296 {
 297         int fd;
 298
 299         fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 300         if (0 <= fd)
 301                 return fd;
 302
 303         /* slow path */
 304         safe_create_leading_directories_const(name);
 305         return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
 306 }
 307
 308 char *get_index_file(void)
 309 {
 310         if (!the_repository->index_file)
 311                 BUG("git environment hasn't been setup");
 312         return the_repository->index_file;
 313 }
 314
 315 char *get_graft_file(struct repository *r)
 316 {
 317         if (!r->graft_file)
 318                 BUG("git environment hasn't been setup");
 319         return r->graft_file;
 320 }
 321
 322 static void set_git_dir_1(const char *path)
 323 {
 324         xsetenv(GIT_DIR_ENVIRONMENT, path, 1);
 325         setup_git_env(path);
 326 }
 327
 328 static void update_relative_gitdir(const char *name,
 329                                    const char *old_cwd,
 330                                    const char *new_cwd,
 331                                    void *data)
 332 {
 333         char *path = reparent_relative_path(old_cwd, new_cwd, get_git_dir());
 334         trace_printf_key(&trace_setup_key,
 335                          "setup: move $GIT_DIR to '%s'",
 336                          path);
 337         set_git_dir_1(path);
 338         free(path);
 339 }
 340
 341 void set_git_dir(const char *path, int make_realpath)
 342 {
 343         struct strbuf realpath = STRBUF_INIT;
 344
 345         if (make_realpath) {
 346                 strbuf_realpath(&realpath, path, 1);
 347                 path = realpath.buf;
 348         }
 349
 350         set_git_dir_1(path);
 351         if (!is_absolute_path(path))
 352                 chdir_notify_register(NULL, update_relative_gitdir, NULL);
 353
 354         strbuf_release(&realpath);
 355 }
 356
 357 const char *get_log_output_encoding(void)
 358 {
 359         return git_log_output_encoding ? git_log_output_encoding
 360                 : get_commit_output_encoding();
 361 }
 362
 363 const char *get_commit_output_encoding(void)
 364 {
 365         return git_commit_encoding ? git_commit_encoding : "UTF-8";
 366 }
 367
 368 static int the_shared_repository = PERM_UMASK;
 369 static int need_shared_repository_from_config = 1;
 370
 371 void set_shared_repository(int value)
 372 {
 373         the_shared_repository = value;
 374         need_shared_repository_from_config = 0;
 375 }
 376
 377 int get_shared_repository(void)
 378 {
 379         if (need_shared_repository_from_config) {
 380                 const char *var = "core.sharedrepository";
 381                 const char *value;
 382                 if (!git_config_get_value(var, &value))
 383                         the_shared_repository = git_config_perm(var, value);
 384                 need_shared_repository_from_config = 0;
 385         }
 386         return the_shared_repository;
 387 }
 388
 389 void reset_shared_repository(void)
 390 {
 391         need_shared_repository_from_config = 1;
 392 }
 393
 394 int use_optional_locks(void)
 395 {
 396         return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
 397 }
 398
 399 int print_sha1_ellipsis(void)
 400 {
 401         /*
 402          * Determine if the calling environment contains the variable
 403          * GIT_PRINT_SHA1_ELLIPSIS set to "yes".
 404          */
 405         static int cached_result = -1; /* unknown */
 406
 407         if (cached_result < 0) {
 408                 const char *v = getenv("GIT_PRINT_SHA1_ELLIPSIS");
 409                 cached_result = (v && !strcasecmp(v, "yes"));
 410         }
 411         return cached_result;
 412 }