1 /*
2  * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 struct got_repository;
18 struct got_pathlist_head;
19 struct got_tag_object;
20 
21 /* Open and close repositories. */
22 const struct got_error *got_repo_open(struct got_repository**, const char *,
23     const char *, int *);
24 const struct got_error *got_repo_close(struct got_repository*);
25 
26 /* Obtain the on-disk path to the repository. */
27 const char *got_repo_get_path(struct got_repository *);
28 
29 /*
30  * Obtain the path to a non-bare repository's .git directory.
31  * For bare repositories, this returns the same result as got_repo_get_path().
32  */
33 const char *got_repo_get_path_git_dir(struct got_repository *);
34 
35 /* Obtain the file descriptor of the repository's .git directory. */
36 int got_repo_get_fd(struct got_repository *);
37 
38 /* Obtain the object format */
39 enum got_hash_algorithm got_repo_get_hash_algorithm(struct got_repository *);
40 
41 /* Obtain the commit author name if parsed from gitconfig, else NULL. */
42 const char *got_repo_get_gitconfig_author_name(struct got_repository *);
43 
44 /* Obtain the commit author email if parsed from gitconfig, else NULL. */
45 const char *got_repo_get_gitconfig_author_email(struct got_repository *);
46 
47 /* Obtain global commit author name parsed ~/.gitconfig, else NULL. */
48 const char *got_repo_get_global_gitconfig_author_name(struct got_repository *);
49 
50 /* Obtain global commit author email parsed ~/.gitconfig, else NULL. */
51 const char *got_repo_get_global_gitconfig_author_email(struct got_repository *);
52 
53 /* Obtain repository owner name if parsed from gitconfig, else NULL. */
54 const char *got_repo_get_gitconfig_owner(struct got_repository *);
55 
56 /* Obtain the list of enabled Git extensions parsed from gitconfig. */
57 void got_repo_get_gitconfig_extensions(char ***, int *,
58     struct got_repository *);
59 
60 /* Information about one remote repository. */
61 struct got_remote_repo {
62 	char *name;
63 	char *fetch_url;
64 	char *send_url;
65 
66 	/*
67 	 * If set, fetched references are mirrored 1:1 into our repository.
68 	 * If not set, references are mapped into "refs/remotes/$name/".
69 	 */
70 	int mirror_references;
71 
72 	/*
73 	 * If set, fetch all branches by default and ignore the list of
74 	 * branches below.
75 	 */
76 	int fetch_all_branches;
77 
78 	/* Branches to fetch by default. */
79 	int nfetch_branches;
80 	char **fetch_branches;
81 
82 	/* Branches to send by default. */
83 	int nsend_branches;
84 	char **send_branches;
85 
86 	/* Other arbitrary references to fetch by default. */
87 	int nfetch_refs;
88 	char **fetch_refs;
89 };
90 
91 /*
92  * Free data allocated for the specified remote repository.
93  * Do not free the remote_repo pointer itself.
94  */
95 void got_repo_free_remote_repo_data(struct got_remote_repo *);
96 
97 /* Obtain the list of remote repositories parsed from gitconfig. */
98 void got_repo_get_gitconfig_remotes(int *, const struct got_remote_repo **,
99     struct got_repository *);
100 
101 /*
102  * Obtain a parsed representation of this repository's got.conf file.
103  * Return NULL if this configuration file could not be read.
104  */
105 const struct got_gotconfig *got_repo_get_gotconfig(struct got_repository *);
106 
107 /*
108  * Obtain paths to various directories within a repository.
109  * The caller must dispose of a path with free(3).
110  */
111 char *got_repo_get_path_objects(struct got_repository *);
112 char *got_repo_get_path_objects_pack(struct got_repository *);
113 char *got_repo_get_path_refs(struct got_repository *);
114 char *got_repo_get_path_packed_refs(struct got_repository *);
115 char *got_repo_get_path_gitconfig(struct got_repository *);
116 char *got_repo_get_path_gotconfig(struct got_repository *);
117 
118 struct got_reference;
119 struct got_reflist_head;
120 
121 /*
122  * Obtain a reference, by name, from a repository.
123  * The caller must dispose of it with got_ref_close().
124  */
125 const struct got_error *got_repo_get_reference(struct got_reference **,
126     struct got_repository *, const char *);
127 
128 
129 /* Indicate whether this is a bare repositiry (contains no git working tree). */
130 int got_repo_is_bare(struct got_repository *);
131 
132 /* Attempt to map an arbitrary path to a path within the repository. */
133 const struct got_error *got_repo_map_path(char **, struct got_repository *,
134     const char *);
135 
136 /*
137  * Create a new repository with optional specified
138  * HEAD ref in an empty directory at a specified path.
139  */
140 const struct got_error *got_repo_init(const char *, const char *);
141 
142 /* Attempt to find a unique object ID for a given ID string prefix. */
143 const struct got_error *got_repo_match_object_id_prefix(struct got_object_id **,
144     const char *, int, struct got_repository *);
145 
146 /*
147  * Given an object ID string or reference name, attempt to find a corresponding
148  * object.
149  * The object type may be restricted to commit, tree, blob, or tag.
150  * Tags will only be matched if a list of references is provided.
151  * GOT_OBJ_TYPE_ANY will match any type of object.
152  * A human-readable label can optionally be returned, which the caller should
153  * dispose of with free(3).
154  * Return GOT_ERR_NO_OBJ if no matching commit can be found.
155  */
156 const struct got_error *got_repo_match_object_id(struct got_object_id **,
157     char **, const char *, int, struct got_reflist_head *,
158     struct got_repository *);
159 
160 /*
161  * Search the provided list of references for a tag with a given name
162  * and target object type.
163  * Return GOT_ERR_NO_OBJ if no matching tag can be found.
164  */
165 const struct got_error *got_repo_object_match_tag(struct got_tag_object **,
166     const char *, int, struct got_reflist_head *, struct got_repository *);
167 
168 /* A callback function which is invoked when a path is imported. */
169 typedef const struct got_error *(*got_repo_import_cb)(void *, const char *);
170 
171 /*
172  * Import an unversioned directory tree into the repository.
173  * Creates a root commit, i.e. a commit with zero parents.
174  */
175 const struct got_error *got_repo_import(struct got_object_id **, const char *,
176     const char *, const char *, struct got_pathlist_head *,
177     struct got_repository *, got_repo_import_cb, void *);
178 
179 /* Obtain the number and size of loose objects in the repository. */
180 const struct got_error *got_repo_get_loose_object_info(int *nobjects,
181     off_t *ondisk_size, struct got_repository *);
182 
183 /* Obtain the number and size of packed objects in the repository. */
184 const struct got_error *got_repo_get_packfile_info(int *npackfiles,
185     int *nobjects, off_t *total_packsize, struct got_repository *);
186 
187 /* Create an array of file descriptors to hand over to got_repo_open for pack */
188 const struct got_error *got_repo_pack_fds_open(int **);
189 
190 /* Close the array of file descriptors handed over to got_repo_open for pack */
191 const struct got_error *got_repo_pack_fds_close(int *);
192 
193 /* Open/set/close temporary files for internal use. Needed by gotd(8). */
194 const struct got_error *got_repo_temp_fds_open(int **);
195 void got_repo_temp_fds_set(struct got_repository *, int *);
196 const struct got_error *got_repo_temp_fds_close(int *);