2 a1fd68d8 2018-01-12 stsp * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
4 7b19e0f1 2017-11-05 stsp * Permission to use, copy, modify, and distribute this software for any
5 7b19e0f1 2017-11-05 stsp * purpose with or without fee is hereby granted, provided that the above
6 7b19e0f1 2017-11-05 stsp * copyright notice and this permission notice appear in all copies.
8 7b19e0f1 2017-11-05 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 7b19e0f1 2017-11-05 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 7b19e0f1 2017-11-05 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 7b19e0f1 2017-11-05 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 7b19e0f1 2017-11-05 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 7b19e0f1 2017-11-05 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 7b19e0f1 2017-11-05 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 ffcada43 2023-02-04 op #define GOT_OBJECT_ID_HEX_MAXLEN SHA256_DIGEST_STRING_LENGTH
19 94ef2557 2023-02-04 op enum got_hash_algorithm {
20 94ef2557 2023-02-04 op GOT_HASH_SHA1,
21 94ef2557 2023-02-04 op GOT_HASH_SHA256,
24 d7b5a0e8 2022-04-20 stsp struct got_object_id {
25 9c0abf71 2023-02-04 op u_int8_t hash[SHA256_DIGEST_LENGTH];
26 94ef2557 2023-02-04 op enum got_hash_algorithm algo;
29 f934cf2c 2018-02-12 stsp struct got_blob_object;
30 883f0469 2018-06-23 stsp struct got_tree_object;
31 56e0773d 2019-11-28 stsp struct got_tree_entry;
32 f4a881ce 2018-11-17 stsp struct got_tag_object;
33 45d799e2 2018-12-23 stsp struct got_commit_object;
35 79f35eb3 2018-06-11 stsp struct got_object_qid {
36 dbdddfee 2021-06-23 naddy STAILQ_ENTRY(got_object_qid) entry;
37 d7b5a0e8 2022-04-20 stsp struct got_object_id id;
38 74a2356f 2021-06-18 stsp void *data; /* managed by API user */
41 dbdddfee 2021-06-23 naddy STAILQ_HEAD(got_object_id_queue, got_object_qid);
43 dbc6a6b6 2018-07-12 stsp const struct got_error *got_object_qid_alloc(struct got_object_qid **,
44 dbc6a6b6 2018-07-12 stsp struct got_object_id *);
45 dbc6a6b6 2018-07-12 stsp void got_object_qid_free(struct got_object_qid *);
46 dd88155e 2019-06-29 stsp void got_object_id_queue_free(struct got_object_id_queue *);
49 9ca9aafb 2021-06-18 stsp * Deep-copy elements from ID queue src to ID queue dest. Do not copy any
50 9ca9aafb 2021-06-18 stsp * qid->data pointers! This is the caller's responsibility if needed.
52 9ca9aafb 2021-06-18 stsp const struct got_error *got_object_id_queue_copy(
53 9ca9aafb 2021-06-18 stsp const struct got_object_id_queue *src, struct got_object_id_queue *dest);
55 15a94983 2018-12-23 stsp /* Object types. */
56 dd88155e 2019-06-29 stsp #define GOT_OBJ_TYPE_ANY 0 /* wildcard value at run-time */
57 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_COMMIT 1
58 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_TREE 2
59 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_BLOB 3
60 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_TAG 4
61 f9a4270b 2017-12-03 stsp /* 5 is reserved */
62 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_OFFSET_DELTA 6
63 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_REF_DELTA 7
66 8aa93786 2019-08-22 stsp * Labels used in object data.
69 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_COMMIT "commit"
70 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_TREE "tree"
71 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_BLOB "blob"
72 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_TAG "tag"
74 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_TREE "tree "
75 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_PARENT "parent "
76 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_AUTHOR "author "
77 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_COMMITTER "committer "
79 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_OBJECT "object "
80 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_TYPE "type "
81 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_TAG "tag "
82 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_TAGGER "tagger "
84 ab9a70b2 2017-11-06 stsp struct got_repository;
87 0c60ce5a 2018-04-02 stsp * Obtain a string representation of an object ID. The output depends on
88 0c60ce5a 2018-04-02 stsp * the hash function used by the repository format (currently SHA1).
90 ef0981d5 2018-02-12 stsp const struct got_error *got_object_id_str(char **, struct got_object_id *);
93 0c60ce5a 2018-04-02 stsp * Compare two object IDs. Return value behaves like memcmp(3).
95 984e8a45 2018-11-05 stsp int got_object_id_cmp(const struct got_object_id *,
96 984e8a45 2018-11-05 stsp const struct got_object_id *);
99 0c60ce5a 2018-04-02 stsp * Created a newly allocated copy of an object ID.
100 0c60ce5a 2018-04-02 stsp * The caller should dispose of it with free(3).
102 8bf5b3c9 2018-03-17 stsp struct got_object_id *got_object_id_dup(struct got_object_id *);
105 27d434c2 2018-09-15 stsp * Get a newly allocated ID of the object which resides at the specified
106 67b631c9 2021-10-10 stsp * path in the specified tree.
107 67b631c9 2021-10-10 stsp * The caller should dispose of it with free(3).
109 67b631c9 2021-10-10 stsp const struct got_error *got_object_tree_find_path(struct got_object_id **id,
110 67b631c9 2021-10-10 stsp mode_t *mode, struct got_repository *repo, struct got_tree_object *tree,
111 67b631c9 2021-10-10 stsp const char *path);
114 67b631c9 2021-10-10 stsp * Get a newly allocated ID of the object which resides at the specified
115 27d434c2 2018-09-15 stsp * path in the tree of the specified commit.
116 27d434c2 2018-09-15 stsp * The caller should dispose of it with free(3).
118 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_id_by_path(struct got_object_id **,
119 a44927cc 2022-04-07 stsp struct got_repository *, struct got_commit_object *, const char *);
122 0c60ce5a 2018-04-02 stsp * Obtain the type of an object.
123 0c60ce5a 2018-04-02 stsp * Returns one of the GOT_OBJ_TYPE_x values (see above).
125 15a94983 2018-12-23 stsp const struct got_error *got_object_get_type(int *, struct got_repository *,
126 15a94983 2018-12-23 stsp struct got_object_id *);
129 15a94983 2018-12-23 stsp * Attempt to resolve the textual representation of an object ID
130 15a94983 2018-12-23 stsp * to the ID of an existing object in the repository.
131 15a94983 2018-12-23 stsp * The caller should dispose of the ID with free(3).
133 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_resolve_id_str(struct got_object_id **,
134 6c34b1aa 2019-03-18 stsp struct got_repository *, const char *);
137 0c60ce5a 2018-04-02 stsp * Attempt to open a commit object in a repository.
138 0c60ce5a 2018-04-02 stsp * The caller must dispose of the commit with got_object_commit_close().
140 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_open_as_commit(struct got_commit_object **,
141 15a94983 2018-12-23 stsp struct got_repository *, struct got_object_id *);
143 0c60ce5a 2018-04-02 stsp /* Dispose of a commit object. */
144 d1cda826 2017-11-06 stsp void got_object_commit_close(struct got_commit_object *);
146 45d799e2 2018-12-23 stsp /* Obtain the ID of the tree created in a commit. */
147 45d799e2 2018-12-23 stsp struct got_object_id *got_object_commit_get_tree_id(struct got_commit_object *);
149 45d799e2 2018-12-23 stsp /* Obtain the number of parent commits of a commit. */
150 45d799e2 2018-12-23 stsp int got_object_commit_get_nparents(struct got_commit_object *);
152 45d799e2 2018-12-23 stsp /* Obtain the list of parent commits of a commit. */
153 45d799e2 2018-12-23 stsp const struct got_object_id_queue *got_object_commit_get_parent_ids(
154 45d799e2 2018-12-23 stsp struct got_commit_object *);
156 45d799e2 2018-12-23 stsp /* Get the author's name and email address. */
157 45d799e2 2018-12-23 stsp const char *got_object_commit_get_author(struct got_commit_object *);
159 2df4e4ff 2018-12-23 stsp /* Get an author's commit timestamp in UTC. */
160 45d799e2 2018-12-23 stsp time_t got_object_commit_get_author_time(struct got_commit_object *);
162 45d799e2 2018-12-23 stsp /* Get an author's timezone offset. */
163 45d799e2 2018-12-23 stsp time_t got_object_commit_get_author_gmtoff(struct got_commit_object *);
165 45d799e2 2018-12-23 stsp /* Get the committer's name and email address. */
166 45d799e2 2018-12-23 stsp const char *got_object_commit_get_committer(struct got_commit_object *);
168 450eaa8b 2018-12-23 stsp /* Get a committer's commit timestamp in UTC. */
169 45d799e2 2018-12-23 stsp time_t got_object_commit_get_committer_time(struct got_commit_object *);
171 450eaa8b 2018-12-23 stsp /* Get a committer's timezone offset. */
172 45d799e2 2018-12-23 stsp time_t got_object_commit_get_committer_gmtoff(struct got_commit_object *);
175 24ea5512 2019-08-22 stsp * Get the commit log message.
176 24ea5512 2019-08-22 stsp * PGP-signatures contained in the log message will be stripped.
177 24ea5512 2019-08-22 stsp * The caller must dispose of it with free(3).
179 5943eee2 2019-08-13 stsp const struct got_error *got_object_commit_get_logmsg(char **,
180 5943eee2 2019-08-13 stsp struct got_commit_object *);
182 24ea5512 2019-08-22 stsp /* Get the raw commit log message.*/
183 24ea5512 2019-08-22 stsp const char *got_object_commit_get_logmsg_raw(struct got_commit_object *);
186 0c60ce5a 2018-04-02 stsp * Attempt to open a tree object in a repository.
187 0c60ce5a 2018-04-02 stsp * The caller must dispose of the tree with got_object_tree_close().
189 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_open_as_tree(struct got_tree_object **,
190 15a94983 2018-12-23 stsp struct got_repository *, struct got_object_id *);
192 0c60ce5a 2018-04-02 stsp /* Dispose of a tree object. */
193 0ffeb3c2 2017-11-26 stsp void got_object_tree_close(struct got_tree_object *);
195 56e0773d 2019-11-28 stsp /* Get the number of entries in this tree object. */
196 56e0773d 2019-11-28 stsp int got_object_tree_get_nentries(struct got_tree_object *);
198 56e0773d 2019-11-28 stsp /* Get the first tree entry from a tree, or NULL if there is none. */
199 c0df5966 2021-12-31 stsp struct got_tree_entry *got_object_tree_get_first_entry(
200 c0df5966 2021-12-31 stsp struct got_tree_object *);
202 56e0773d 2019-11-28 stsp /* Get the last tree entry from a tree, or NULL if there is none. */
203 56e0773d 2019-11-28 stsp struct got_tree_entry *got_object_tree_get_last_entry(struct got_tree_object *);
205 56e0773d 2019-11-28 stsp /* Get the entry with the specified index from a tree object. */
206 56e0773d 2019-11-28 stsp struct got_tree_entry *got_object_tree_get_entry(
207 56e0773d 2019-11-28 stsp struct got_tree_object *, int);
209 56e0773d 2019-11-28 stsp /* Find a particular entry in a tree by name. */
210 56e0773d 2019-11-28 stsp struct got_tree_entry *got_object_tree_find_entry(
211 a129376b 2019-03-28 stsp struct got_tree_object *, const char *);
213 56e0773d 2019-11-28 stsp /* Get the file permission mode of a tree entry. */
214 56e0773d 2019-11-28 stsp mode_t got_tree_entry_get_mode(struct got_tree_entry *);
216 56e0773d 2019-11-28 stsp /* Get the name of a tree entry. */
217 56e0773d 2019-11-28 stsp const char *got_tree_entry_get_name(struct got_tree_entry *);
219 56e0773d 2019-11-28 stsp /* Get the object ID of a tree entry. */
220 56e0773d 2019-11-28 stsp struct got_object_id *got_tree_entry_get_id(struct got_tree_entry *);
223 0d6c6ee3 2020-05-20 stsp * Get a string containing the target path of a given a symlink tree entry.
224 0d6c6ee3 2020-05-20 stsp * The caller should dispose of it with free(3).
226 0d6c6ee3 2020-05-20 stsp const struct got_error *got_tree_entry_get_symlink_target(char **,
227 0d6c6ee3 2020-05-20 stsp struct got_tree_entry *, struct got_repository *);
229 56e0773d 2019-11-28 stsp /* Get the index of a tree entry. */
230 56e0773d 2019-11-28 stsp int got_tree_entry_get_index(struct got_tree_entry *);
232 56e0773d 2019-11-28 stsp /* Get the next tree entry from a tree, or NULL if there is none. */
233 56e0773d 2019-11-28 stsp struct got_tree_entry *got_tree_entry_get_next(struct got_tree_object *,
234 56e0773d 2019-11-28 stsp struct got_tree_entry *);
236 56e0773d 2019-11-28 stsp /* Get the previous tree entry from a tree, or NULL if there is none. */
237 56e0773d 2019-11-28 stsp struct got_tree_entry *got_tree_entry_get_prev(struct got_tree_object *,
238 56e0773d 2019-11-28 stsp struct got_tree_entry *);
240 63c5ca5d 2019-08-24 stsp /* Return non-zero if the specified tree entry is a Git submodule. */
241 56e0773d 2019-11-28 stsp int got_object_tree_entry_is_submodule(struct got_tree_entry *);
243 e40622f4 2020-07-23 stsp /* Return non-zero if the specified tree entry is a symbolic link. */
244 e40622f4 2020-07-23 stsp int got_object_tree_entry_is_symlink(struct got_tree_entry *);
247 e40622f4 2020-07-23 stsp * Resolve an in-repository symlink at the specified path in the tree
248 e40622f4 2020-07-23 stsp * corresponding to the specified commit. If the specified path is not
249 e40622f4 2020-07-23 stsp * a symlink then set *link_target to NULL.
250 e40622f4 2020-07-23 stsp * Otherwise, resolve symlinks recursively and return the final link
251 5e91dae4 2022-08-30 stsp * target path. The caller must dispose of it with free(3).
253 e40622f4 2020-07-23 stsp const struct got_error *got_object_resolve_symlinks(char **, const char *,
254 a44927cc 2022-04-07 stsp struct got_commit_object *, struct got_repository *);
257 07862c20 2018-09-15 stsp * Compare two trees and indicate whether the entry at the specified path
258 31cedeaf 2018-09-15 stsp * differs between them. The path must not be the root path "/"; the function
259 31cedeaf 2018-09-15 stsp * got_object_id_cmp() should be used instead to compare the tree roots.
261 07862c20 2018-09-15 stsp const struct got_error *got_object_tree_path_changed(int *,
262 07862c20 2018-09-15 stsp struct got_tree_object *, struct got_tree_object *, const char *,
263 07862c20 2018-09-15 stsp struct got_repository *);
266 0c60ce5a 2018-04-02 stsp * Attempt to open a blob object in a repository.
267 0c60ce5a 2018-04-02 stsp * The size_t argument specifies the block size of an associated read buffer.
268 0c60ce5a 2018-04-02 stsp * The caller must dispose of the blob with got_object_blob_close().
270 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_open_as_blob(struct got_blob_object **,
271 eb81bc23 2022-06-28 tracey struct got_repository *, struct got_object_id *, size_t, int);
273 0c60ce5a 2018-04-02 stsp /* Dispose of a blob object. */
274 fb43ecf1 2019-02-11 stsp const struct got_error *got_object_blob_close(struct got_blob_object *);
277 0c60ce5a 2018-04-02 stsp * Get the length of header data at the beginning of the blob's read buffer.
278 0c60ce5a 2018-04-02 stsp * Note that header data is only present upon the first invocation of
279 0c60ce5a 2018-04-02 stsp * got_object_blob_read_block() after the blob is opened.
281 f934cf2c 2018-02-12 stsp size_t got_object_blob_get_hdrlen(struct got_blob_object *);
284 0c60ce5a 2018-04-02 stsp * Get a pointer to the blob's read buffer.
285 0c60ce5a 2018-04-02 stsp * The read buffer is filled by got_object_blob_read_block().
287 f934cf2c 2018-02-12 stsp const uint8_t *got_object_blob_get_read_buf(struct got_blob_object *);
290 0c60ce5a 2018-04-02 stsp * Read the next chunk of data from a blob, up to the blob's read buffer
291 0c60ce5a 2018-04-02 stsp * block size. The size_t output argument indicates how many bytes have
292 0c60ce5a 2018-04-02 stsp * been read into the blob's read buffer. Zero bytes will be reported if
293 0c60ce5a 2018-04-02 stsp * all data in the blob has been read.
295 eb651edf 2018-02-11 stsp const struct got_error *got_object_blob_read_block(size_t *,
296 eb651edf 2018-02-11 stsp struct got_blob_object *);
298 8ba819a3 2020-07-23 stsp /* Rewind an open blob's data stream back to the beginning. */
299 8ba819a3 2020-07-23 stsp void got_object_blob_rewind(struct got_blob_object *);
302 0d569390 2023-01-04 op * Heuristic to check whether the blob contains binary data. Rewinds
303 0d569390 2023-01-04 op * the blob's data stream back after the header.
305 0d569390 2023-01-04 op const struct got_error *got_object_blob_is_binary(int *,
306 0d569390 2023-01-04 op struct got_blob_object *);
309 389a68d8 2023-01-05 op * getline(3) for blobs.
311 389a68d8 2023-01-05 op const struct got_error *got_object_blob_getline(char **, ssize_t *,
312 389a68d8 2023-01-05 op size_t *, struct got_blob_object *);
315 35e9ba5d 2018-06-21 stsp * Read the entire content of a blob and write it to the specified file.
316 84451b3e 2018-07-10 stsp * Flush and rewind the file as well. Indicate the amount of bytes
317 6c4c42e0 2019-06-24 stsp * written in the size_t output argument, and the number of lines in the
318 0f6650ff 2019-08-14 stsp * file in the int argument, and line offsets in the off_t argument
319 6c4c42e0 2019-06-24 stsp * (NULL can be passed for any output argument).
321 be659d10 2020-11-18 stsp const struct got_error *got_object_blob_dump_to_file(off_t *, int *,
322 6c4c42e0 2019-06-24 stsp off_t **, FILE *, struct got_blob_object *);
325 af57b12a 2020-07-23 stsp * Read the entire content of a blob into a newly allocated string buffer
326 af57b12a 2020-07-23 stsp * and terminate it with '\0'. This is intended for blobs which contain a
327 af57b12a 2020-07-23 stsp * symlink target path. It should not be used to process arbitrary blobs.
328 af57b12a 2020-07-23 stsp * Use got_object_blob_dump_to_file() or got_tree_entry_get_symlink_target()
329 af57b12a 2020-07-23 stsp * instead if possible. The caller must dispose of the string with free(3).
331 af57b12a 2020-07-23 stsp const struct got_error *got_object_blob_read_to_str(char **,
332 af57b12a 2020-07-23 stsp struct got_blob_object *);
335 f4a881ce 2018-11-17 stsp * Attempt to open a tag object in a repository.
336 01073a5d 2019-08-22 stsp * The caller must dispose of the tree with got_tag_object_close().
338 15a94983 2018-12-23 stsp const struct got_error *got_object_open_as_tag(struct got_tag_object **,
339 15a94983 2018-12-23 stsp struct got_repository *, struct got_object_id *);
341 f4a881ce 2018-11-17 stsp /* Dispose of a tag object. */
342 f4a881ce 2018-11-17 stsp void got_object_tag_close(struct got_tag_object *);
344 d24820bf 2019-08-11 stsp /* Get the name of a tag. */
345 d24820bf 2019-08-11 stsp const char *got_object_tag_get_name(struct got_tag_object *);
347 0bd18d37 2019-02-01 stsp /* Get type of the object a tag points to. */
348 0bd18d37 2019-02-01 stsp int got_object_tag_get_object_type(struct got_tag_object *);
351 0bd18d37 2019-02-01 stsp * Get ID of the object a tag points to.
352 0bd18d37 2019-02-01 stsp * This must not be freed by the caller. Use got_object_id_dup() if needed.
354 0bd18d37 2019-02-01 stsp struct got_object_id *got_object_tag_get_object_id(struct got_tag_object *);
357 01073a5d 2019-08-22 stsp /* Get the timestamp of the tag. */
358 01073a5d 2019-08-22 stsp time_t got_object_tag_get_tagger_time(struct got_tag_object *);
360 01073a5d 2019-08-22 stsp /* Get the tag's timestamp's GMT offset. */
361 01073a5d 2019-08-22 stsp time_t got_object_tag_get_tagger_gmtoff(struct got_tag_object *);
363 01073a5d 2019-08-22 stsp /* Get the author of the tag. */
364 01073a5d 2019-08-22 stsp const char *got_object_tag_get_tagger(struct got_tag_object *);
366 01073a5d 2019-08-22 stsp /* Get the tag message associated with the tag. */
367 01073a5d 2019-08-22 stsp const char *got_object_tag_get_message(struct got_tag_object *);
369 bff6ca00 2018-04-23 stsp const struct got_error *got_object_commit_add_parent(struct got_commit_object *,
370 cf67c0d9 2023-02-04 op const char *, int);
372 8e7bd50a 2019-08-22 stsp /* Create a new tag object in the repository. */
373 8e7bd50a 2019-08-22 stsp const struct got_error *got_object_tag_create(struct got_object_id **,
374 8e7bd50a 2019-08-22 stsp const char *, struct got_object_id *, const char *,
375 4d5ee956 2022-07-02 jrick time_t, const char *, const char *, struct got_repository *, int verbosity);
377 34a842a4 2022-09-18 mark /* Increment commit object reference counter. */
378 34a842a4 2022-09-18 mark void got_object_commit_retain(struct got_commit_object *);
