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