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