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