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 *);
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 commit author name if parsed from gitconfig, else NULL. */
39 const char *got_repo_get_gitconfig_author_name(struct got_repository *);
40 
41 /* Obtain the commit author email if parsed from gitconfig, else NULL. */
42 const char *got_repo_get_gitconfig_author_email(struct got_repository *);
43 
44 /* Obtain global commit author name parsed ~/.gitconfig, else NULL. */
45 const char *got_repo_get_global_gitconfig_author_name(struct got_repository *);
46 
47 /* Obtain global commit author email parsed ~/.gitconfig, else NULL. */
48 const char *got_repo_get_global_gitconfig_author_email(struct got_repository *);
49 
50 /* Obtain repository owner name if parsed from gitconfig, else NULL. */
51 const char *got_repo_get_gitconfig_owner(struct got_repository *);
52 
53 /* Obtain the list of enabled Git extensions parsed from gitconfig. */
54 void got_repo_get_gitconfig_extensions(char ***, int *,
55     struct got_repository *);
56 
57 /* Information about one remote repository. */
58 struct got_remote_repo {
59 	char *name;
60 	char *fetch_url;
61 	char *send_url;
62 
63 	/*
64 	 * If set, fetched references are mirrored 1:1 into our repository.
65 	 * If not set, references are mapped into "refs/remotes/$name/".
66 	 */
67 	int mirror_references;
68 
69 	/*
70 	 * If set, fetch all branches by default and ignore the list of
71 	 * branches below.
72 	 */
73 	int fetch_all_branches;
74 
75 	/* Branches to fetch by default. */
76 	int nfetch_branches;
77 	char **fetch_branches;
78 
79 	/* Branches to send by default. */
80 	int nsend_branches;
81 	char **send_branches;
82 
83 	/* Other arbitrary references to fetch by default. */
84 	int nfetch_refs;
85 	char **fetch_refs;
86 };
87 
88 /*
89  * Free data allocated for the specified remote repository.
90  * Do not free the remote_repo pointer itself.
91  */
92 void got_repo_free_remote_repo_data(struct got_remote_repo *);
93 
94 /* Obtain the list of remote repositories parsed from gitconfig. */
95 void got_repo_get_gitconfig_remotes(int *, const struct got_remote_repo **,
96     struct got_repository *);
97 
98 /*
99  * Obtain a parsed representation of this repository's got.conf file.
100  * Return NULL if this configuration file could not be read.
101  */
102 const struct got_gotconfig *got_repo_get_gotconfig(struct got_repository *);
103 
104 /*
105  * Obtain paths to various directories within a repository.
106  * The caller must dispose of a path with free(3).
107  */
108 char *got_repo_get_path_objects(struct got_repository *);
109 char *got_repo_get_path_objects_pack(struct got_repository *);
110 char *got_repo_get_path_refs(struct got_repository *);
111 char *got_repo_get_path_packed_refs(struct got_repository *);
112 char *got_repo_get_path_gitconfig(struct got_repository *);
113 char *got_repo_get_path_gotconfig(struct got_repository *);
114 
115 struct got_reference;
116 struct got_reflist_head;
117 
118 /*
119  * Obtain a reference, by name, from a repository.
120  * The caller must dispose of it with got_ref_close().
121  */
122 const struct got_error *got_repo_get_reference(struct got_reference **,
123     struct got_repository *, const char *);
124 
125 
126 /* Indicate whether this is a bare repositiry (contains no git working tree). */
127 int got_repo_is_bare(struct got_repository *);
128 
129 /* Attempt to map an arbitrary path to a path within the repository. */
130 const struct got_error *got_repo_map_path(char **, struct got_repository *,
131     const char *);
132 
133 /* Create a new repository in an empty directory at a specified path. */
134 const struct got_error *got_repo_init(const char *);
135 
136 /* Attempt to find a unique object ID for a given ID string prefix. */
137 const struct got_error *got_repo_match_object_id_prefix(struct got_object_id **,
138     const char *, int, struct got_repository *);
139 
140 /*
141  * Given an object ID string or reference name, attempt to find a corresponding
142  * commit object.
143  * The object type may be restricted to commit, tree, blob, or tag.
144  * Tags will only be matched if a list of references is provided.
145  * GOT_OBJ_TYPE_ANY will match any type of object.
146  * A human-readable label can optionally be returned, which the caller should
147  * dispose of with free(3).
148  * Return GOT_ERR_NO_OBJ if no matching commit can be found.
149  */
150 const struct got_error *got_repo_match_object_id(struct got_object_id **,
151     char **, const char *, int, struct got_reflist_head *,
152     struct got_repository *);
153 
154 /*
155  * Search the provided list of references for a tag with a given name
156  * and target object type.
157  * Return GOT_ERR_NO_OBJ if no matching tag can be found.
158  */
159 const struct got_error *got_repo_object_match_tag(struct got_tag_object **,
160     const char *, int, struct got_reflist_head *, struct got_repository *);
161 
162 /* A callback function which is invoked when a path is imported. */
163 typedef const struct got_error *(*got_repo_import_cb)(void *, const char *);
164 
165 /*
166  * Import an unversioned directory tree into the repository.
167  * Creates a root commit, i.e. a commit with zero parents.
168  */
169 const struct got_error *got_repo_import(struct got_object_id **, const char *,
170     const char *, const char *, struct got_pathlist_head *,
171     struct got_repository *, got_repo_import_cb, void *);
172 
173 /* Obtain the number and size of loose objects in the repository. */
174 const struct got_error *got_repo_get_loose_object_info(int *nobjects,
175     off_t *ondisk_size, struct got_repository *);
176 
177 /* Obtain the number and size of packed objects in the repository. */
178 const struct got_error *got_repo_get_packfile_info(int *npackfiles,
179     int *nobjects, off_t *total_packsize, struct got_repository *);