setup.h

   1 #ifndef SETUP_H
   2 #define SETUP_H
   3
   4 #include "string-list.h"
   5
   6 int is_inside_git_dir(void);
   7 int is_inside_work_tree(void);
   8 int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
   9 int get_common_dir(struct strbuf *sb, const char *gitdir);
  10
  11 /*
  12  * Return true if the given path is a git directory; note that this _just_
  13  * looks at the directory itself. If you want to know whether "foo/.git"
  14  * is a repository, you must feed that path, not just "foo".
  15  */
  16 int is_git_directory(const char *path);
  17
  18 /*
  19  * Return 1 if the given path is the root of a git repository or
  20  * submodule, else 0. Will not return 1 for bare repositories with the
  21  * exception of creating a bare repository in "foo/.git" and calling
  22  * is_git_repository("foo").
  23  *
  24  * If we run into read errors, we err on the side of saying "yes, it is",
  25  * as we usually consider sub-repos precious, and would prefer to err on the
  26  * side of not disrupting or deleting them.
  27  */
  28 int is_nonbare_repository_dir(struct strbuf *path);
  29
  30 #define READ_GITFILE_ERR_STAT_FAILED 1
  31 #define READ_GITFILE_ERR_NOT_A_FILE 2
  32 #define READ_GITFILE_ERR_OPEN_FAILED 3
  33 #define READ_GITFILE_ERR_READ_FAILED 4
  34 #define READ_GITFILE_ERR_INVALID_FORMAT 5
  35 #define READ_GITFILE_ERR_NO_PATH 6
  36 #define READ_GITFILE_ERR_NOT_A_REPO 7
  37 #define READ_GITFILE_ERR_TOO_LARGE 8
  38 void read_gitfile_error_die(int error_code, const char *path, const char *dir);
  39 const char *read_gitfile_gently(const char *path, int *return_error_code);
  40 #define read_gitfile(path) read_gitfile_gently((path), NULL)
  41 const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
  42 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
  43
  44 /*
  45  * Check if a repository is safe and die if it is not, by verifying the
  46  * ownership of the worktree (if any), the git directory, and the gitfile (if
  47  * any).
  48  *
  49  * Exemptions for known-safe repositories can be added via `safe.directory`
  50  * config settings; for non-bare repositories, their worktree needs to be
  51  * added, for bare ones their git directory.
  52  */
  53 void die_upon_dubious_ownership(const char *gitfile, const char *worktree,
  54                                 const char *gitdir);
  55
  56 void setup_work_tree(void);
  57 /*
  58  * Find the commondir and gitdir of the repository that contains the current
  59  * working directory, without changing the working directory or other global
  60  * state. The result is appended to commondir and gitdir.  If the discovered
  61  * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
  62  * both have the same result appended to the buffer.  The return value is
  63  * either 0 upon success and non-zero if no repository was found.
  64  */
  65 int discover_git_directory(struct strbuf *commondir,
  66                            struct strbuf *gitdir);
  67 const char *setup_git_directory_gently(int *);
  68 const char *setup_git_directory(void);
  69 char *prefix_path(const char *prefix, int len, const char *path);
  70 char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
  71
  72 int check_filename(const char *prefix, const char *name);
  73 void verify_filename(const char *prefix,
  74                      const char *name,
  75                      int diagnose_misspelt_rev);
  76 void verify_non_filename(const char *prefix, const char *name);
  77 int path_inside_repo(const char *prefix, const char *path);
  78
  79 void sanitize_stdfds(void);
  80 int daemonize(void);
  81
  82 /*
  83  * GIT_REPO_VERSION is the version we write by default. The
  84  * _READ variant is the highest number we know how to
  85  * handle.
  86  */
  87 #define GIT_REPO_VERSION 0
  88 #define GIT_REPO_VERSION_READ 1
  89
  90 /*
  91  * You _have_ to initialize a `struct repository_format` using
  92  * `= REPOSITORY_FORMAT_INIT` before calling `read_repository_format()`.
  93  */
  94 struct repository_format {
  95         int version;
  96         int precious_objects;
  97         char *partial_clone; /* value of extensions.partialclone */
  98         int worktree_config;
  99         int is_bare;
 100         int hash_algo;
 101         int sparse_index;
 102         char *work_tree;
 103         struct string_list unknown_extensions;
 104         struct string_list v1_only_extensions;
 105 };
 106
 107 /*
 108  * Always use this to initialize a `struct repository_format`
 109  * to a well-defined, default state before calling
 110  * `read_repository()`.
 111  */
 112 #define REPOSITORY_FORMAT_INIT \
 113 { \
 114         .version = -1, \
 115         .is_bare = -1, \
 116         .hash_algo = GIT_HASH_SHA1, \
 117         .unknown_extensions = STRING_LIST_INIT_DUP, \
 118         .v1_only_extensions = STRING_LIST_INIT_DUP, \
 119 }
 120
 121 /*
 122  * Read the repository format characteristics from the config file "path" into
 123  * "format" struct. Returns the numeric version. On error, or if no version is
 124  * found in the configuration, -1 is returned, format->version is set to -1,
 125  * and all other fields in the struct are set to the default configuration
 126  * (REPOSITORY_FORMAT_INIT). Always initialize the struct using
 127  * REPOSITORY_FORMAT_INIT before calling this function.
 128  */
 129 int read_repository_format(struct repository_format *format, const char *path);
 130
 131 /*
 132  * Free the memory held onto by `format`, but not the struct itself.
 133  * (No need to use this after `read_repository_format()` fails.)
 134  */
 135 void clear_repository_format(struct repository_format *format);
 136
 137 /*
 138  * Verify that the repository described by repository_format is something we
 139  * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
 140  * any errors encountered.
 141  */
 142 int verify_repository_format(const struct repository_format *format,
 143                              struct strbuf *err);
 144
 145 /*
 146  * Check the repository format version in the path found in get_git_dir(),
 147  * and die if it is a version we don't understand. Generally one would
 148  * set_git_dir() before calling this, and use it only for "are we in a valid
 149  * repo?".
 150  *
 151  * If successful and fmt is not NULL, fill fmt with data.
 152  */
 153 void check_repository_format(struct repository_format *fmt);
 154
 155 const char *get_template_dir(const char *option_template);
 156
 157 /*
 158  * NOTE NOTE NOTE!!
 159  *
 160  * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
 161  * not be changed. Old repositories have core.sharedrepository written in
 162  * numeric format, and therefore these values are preserved for compatibility
 163  * reasons.
 164  */
 165 enum sharedrepo {
 166         PERM_UMASK          = 0,
 167         OLD_PERM_GROUP      = 1,
 168         OLD_PERM_EVERYBODY  = 2,
 169         PERM_GROUP          = 0660,
 170         PERM_EVERYBODY      = 0664
 171 };
 172 int git_config_perm(const char *var, const char *value);
 173
 174 struct startup_info {
 175         int have_repository;
 176         const char *prefix;
 177         const char *original_cwd;
 178 };
 179 extern struct startup_info *startup_info;
 180 extern const char *tmp_original_cwd;
 181
 182 #endif /* SETUP_H */