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