1 /*
2  * Copyright (c) 2018 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_object_id;
18 
19 struct got_blob_object;
20 struct got_tree_object;
21 struct got_tag_object;
22 struct got_commit_object;
23 
24 struct got_tree_entry {
25 	SIMPLEQ_ENTRY(got_tree_entry) entry;
26 	mode_t mode;
27 	char *name;
28 	struct got_object_id *id;
29 };
30 
31 SIMPLEQ_HEAD(got_tree_entries_queue, got_tree_entry);
32 
33 struct got_tree_entries {
34 	int nentries;
35 	struct got_tree_entries_queue head;
36 };
37 
38 struct got_object_qid {
39 	SIMPLEQ_ENTRY(got_object_qid) entry;
40 	struct got_object_id *id;
41 };
42 
43 SIMPLEQ_HEAD(got_object_id_queue, got_object_qid);
44 
45 const struct got_error *got_object_qid_alloc(struct got_object_qid **,
46     struct got_object_id *);
47 void got_object_qid_free(struct got_object_qid *);
48 
49 /* Object types. */
50 #define GOT_OBJ_TYPE_COMMIT		1
51 #define GOT_OBJ_TYPE_TREE		2
52 #define GOT_OBJ_TYPE_BLOB		3
53 #define GOT_OBJ_TYPE_TAG		4
54 /* 5 is reserved */
55 #define GOT_OBJ_TYPE_OFFSET_DELTA	6
56 #define GOT_OBJ_TYPE_REF_DELTA		7
57 
58 struct got_repository;
59 
60 /*
61  * Obtain a string representation of an object ID. The output depends on
62  * the hash function used by the repository format (currently SHA1).
63  */
64 const struct got_error *got_object_id_str(char **, struct got_object_id *);
65 
66 /*
67  * Compare two object IDs. Return value behaves like memcmp(3).
68  */
69 int got_object_id_cmp(const struct got_object_id *,
70     const struct got_object_id *);
71 
72 /*
73  * Created a newly allocated copy of an object ID.
74  * The caller should dispose of it with free(3).
75  */
76 struct got_object_id *got_object_id_dup(struct got_object_id *);
77 
78 /*
79  * Get a newly allocated ID of the object which resides at the specified
80  * path in the tree of the specified commit.
81  * The caller should dispose of it with free(3).
82  */
83 const struct got_error *got_object_id_by_path(struct got_object_id **,
84     struct got_repository *, struct got_object_id *, const char *);
85 
86 /*
87  * Obtain the type of an object.
88  * Returns one of the GOT_OBJ_TYPE_x values (see above).
89  */
90 const struct got_error *got_object_get_type(int *, struct got_repository *,
91     struct got_object_id *);
92 
93 /*
94  * Attempt to resolve the textual representation of an object ID
95  * to the ID of an existing object in the repository.
96  * The caller should dispose of the ID with free(3).
97  */
98 const struct got_error *got_object_resolve_id_str(struct got_object_id **,
99     struct got_repository *, const char *);
100 
101 /*
102  * Attempt to open a commit object in a repository.
103  * The caller must dispose of the commit with got_object_commit_close().
104  */
105 const struct got_error *got_object_open_as_commit(struct got_commit_object **,
106     struct got_repository *, struct got_object_id *);
107 
108 /* Dispose of a commit object. */
109 void got_object_commit_close(struct got_commit_object *);
110 
111 /* Obtain the ID of the tree created in a commit. */
112 struct got_object_id *got_object_commit_get_tree_id(struct got_commit_object *);
113 
114 /* Obtain the number of parent commits of a commit. */
115 int got_object_commit_get_nparents(struct got_commit_object *);
116 
117 /* Obtain the list of parent commits of a commit. */
118 const struct got_object_id_queue *got_object_commit_get_parent_ids(
119     struct got_commit_object *);
120 
121 /* Get the author's name and email address. */
122 const char *got_object_commit_get_author(struct got_commit_object *);
123 
124 /* Get an author's commit timestamp in UTC. */
125 time_t got_object_commit_get_author_time(struct got_commit_object *);
126 
127 /* Get an author's timezone offset. */
128 time_t got_object_commit_get_author_gmtoff(struct got_commit_object *);
129 
130 /* Get the committer's name and email address. */
131 const char *got_object_commit_get_committer(struct got_commit_object *);
132 
133 /* Get a committer's commit timestamp in UTC. */
134 time_t got_object_commit_get_committer_time(struct got_commit_object *);
135 
136 /* Get a committer's timezone offset. */
137 time_t got_object_commit_get_committer_gmtoff(struct got_commit_object *);
138 
139 /* Get the commit log message. */
140 const char *got_object_commit_get_logmsg(struct got_commit_object *);
141 
142 /*
143  * Attempt to open a tree object in a repository.
144  * The caller must dispose of the tree with got_object_tree_close().
145  */
146 const struct got_error *got_object_open_as_tree(struct got_tree_object **,
147     struct got_repository *, struct got_object_id *);
148 
149 /* Dispose of a tree object. */
150 void got_object_tree_close(struct got_tree_object *);
151 
152 /* Get the entries of a tree object. */
153 const struct got_tree_entries *got_object_tree_get_entries(
154     struct got_tree_object *);
155 
156 /*
157  * Compare two trees and indicate whether the entry at the specified path
158  * differs between them. The path must not be the root path "/"; the function
159  * got_object_id_cmp() should be used instead to compare the tree roots.
160  */
161 const struct got_error *got_object_tree_path_changed(int *,
162     struct got_tree_object *, struct got_tree_object *, const char *,
163     struct got_repository *);
164 
165 /*
166  * Attempt to open a blob object in a repository.
167  * The size_t argument specifies the block size of an associated read buffer.
168  * The caller must dispose of the blob with got_object_blob_close().
169  */
170 const struct got_error *got_object_open_as_blob(struct got_blob_object **,
171     struct got_repository *, struct got_object_id *, size_t);
172 
173 /* Dispose of a blob object. */
174 const struct got_error *got_object_blob_close(struct got_blob_object *);
175 
176 /*
177  * Get the length of header data at the beginning of the blob's read buffer.
178  * Note that header data is only present upon the first invocation of
179  * got_object_blob_read_block() after the blob is opened.
180  */
181 size_t got_object_blob_get_hdrlen(struct got_blob_object *);
182 
183 /*
184  * Get a pointer to the blob's read buffer.
185  * The read buffer is filled by got_object_blob_read_block().
186  */
187 const uint8_t *got_object_blob_get_read_buf(struct got_blob_object *);
188 
189 /*
190  * Read the next chunk of data from a blob, up to the blob's read buffer
191  * block size. The size_t output argument indicates how many bytes have
192  * been read into the blob's read buffer. Zero bytes will be reported if
193  * all data in the blob has been read.
194  */
195 const struct got_error *got_object_blob_read_block(size_t *,
196     struct got_blob_object *);
197 
198 /*
199  * Read the entire content of a blob and write it to the specified file.
200  * Flush and rewind the file as well. Indicate the amount of bytes
201  * written in the size_t output argument, and the number of lines in
202  * the file in int argument (NULL can be passed for either output argument).
203  */
204 const struct got_error *got_object_blob_dump_to_file(size_t *, int *,
205     FILE *, struct got_blob_object *);
206 
207 /*
208  * Attempt to open a tag object in a repository.
209  * The caller must dispose of the tree with got_object_tag_close().
210  */
211 const struct got_error *got_object_open_as_tag(struct got_tag_object **,
212     struct got_repository *, struct got_object_id *);
213 
214 /* Dispose of a tag object. */
215 void got_object_tag_close(struct got_tag_object *);
216 
217 /* Get type of the object a tag points to. */
218 int got_object_tag_get_object_type(struct got_tag_object *);
219 
220 /*
221  * Get ID of the object a tag points to.
222  * This must not be freed by the caller. Use got_object_id_dup() if needed.
223  */
224 struct got_object_id *got_object_tag_get_object_id(struct got_tag_object *);
225 
226 const struct got_error *got_object_commit_add_parent(struct got_commit_object *,
227     const char *);