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 01986ce9 2023-02-07 thomas #define GOT_OBJECT_ID_HEX_MAXLEN SHA1_DIGEST_STRING_LENGTH
19 ec242592 2022-04-22 thomas struct got_object_id {
20 ec242592 2022-04-22 thomas u_int8_t sha1[SHA1_DIGEST_LENGTH];
23 f934cf2c 2018-02-12 stsp struct got_blob_object;
24 883f0469 2018-06-23 stsp struct got_tree_object;
25 56e0773d 2019-11-28 stsp struct got_tree_entry;
26 f4a881ce 2018-11-17 stsp struct got_tag_object;
27 45d799e2 2018-12-23 stsp struct got_commit_object;
29 79f35eb3 2018-06-11 stsp struct got_object_qid {
30 dbdddfee 2021-06-23 naddy STAILQ_ENTRY(got_object_qid) entry;
31 ec242592 2022-04-22 thomas struct got_object_id id;
32 74a2356f 2021-06-18 stsp void *data; /* managed by API user */
35 dbdddfee 2021-06-23 naddy STAILQ_HEAD(got_object_id_queue, got_object_qid);
37 dbc6a6b6 2018-07-12 stsp const struct got_error *got_object_qid_alloc(struct got_object_qid **,
38 dbc6a6b6 2018-07-12 stsp struct got_object_id *);
39 dbc6a6b6 2018-07-12 stsp void got_object_qid_free(struct got_object_qid *);
40 dd88155e 2019-06-29 stsp void got_object_id_queue_free(struct got_object_id_queue *);
43 9ca9aafb 2021-06-18 stsp * Deep-copy elements from ID queue src to ID queue dest. Do not copy any
44 9ca9aafb 2021-06-18 stsp * qid->data pointers! This is the caller's responsibility if needed.
46 9ca9aafb 2021-06-18 stsp const struct got_error *got_object_id_queue_copy(
47 9ca9aafb 2021-06-18 stsp const struct got_object_id_queue *src, struct got_object_id_queue *dest);
49 15a94983 2018-12-23 stsp /* Object types. */
50 dd88155e 2019-06-29 stsp #define GOT_OBJ_TYPE_ANY 0 /* wildcard value at run-time */
51 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_COMMIT 1
52 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_TREE 2
53 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_BLOB 3
54 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_TAG 4
55 f9a4270b 2017-12-03 stsp /* 5 is reserved */
56 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_OFFSET_DELTA 6
57 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_REF_DELTA 7
60 8aa93786 2019-08-22 stsp * Labels used in object data.
63 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_COMMIT "commit"
64 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_TREE "tree"
65 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_BLOB "blob"
66 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_TAG "tag"
68 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_TREE "tree "
69 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_PARENT "parent "
70 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_AUTHOR "author "
71 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_COMMITTER "committer "
73 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_OBJECT "object "
74 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_TYPE "type "
75 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_TAG "tag "
76 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_TAGGER "tagger "
78 ab9a70b2 2017-11-06 stsp struct got_repository;
81 0c60ce5a 2018-04-02 stsp * Obtain a string representation of an object ID. The output depends on
82 0c60ce5a 2018-04-02 stsp * the hash function used by the repository format (currently SHA1).
84 ef0981d5 2018-02-12 stsp const struct got_error *got_object_id_str(char **, struct got_object_id *);
87 0c60ce5a 2018-04-02 stsp * Compare two object IDs. Return value behaves like memcmp(3).
89 984e8a45 2018-11-05 stsp int got_object_id_cmp(const struct got_object_id *,
90 984e8a45 2018-11-05 stsp const struct got_object_id *);
93 0c60ce5a 2018-04-02 stsp * Created a newly allocated copy of an object ID.
94 0c60ce5a 2018-04-02 stsp * The caller should dispose of it with free(3).
96 8bf5b3c9 2018-03-17 stsp struct got_object_id *got_object_id_dup(struct got_object_id *);
99 27d434c2 2018-09-15 stsp * Get a newly allocated ID of the object which resides at the specified
100 cc8021af 2021-10-12 thomas * path in the specified tree.
101 cc8021af 2021-10-12 thomas * The caller should dispose of it with free(3).
103 cc8021af 2021-10-12 thomas const struct got_error *got_object_tree_find_path(struct got_object_id **id,
104 cc8021af 2021-10-12 thomas mode_t *mode, struct got_repository *repo, struct got_tree_object *tree,
105 cc8021af 2021-10-12 thomas const char *path);
108 cc8021af 2021-10-12 thomas * Get a newly allocated ID of the object which resides at the specified
109 27d434c2 2018-09-15 stsp * path in the tree of the specified commit.
110 27d434c2 2018-09-15 stsp * The caller should dispose of it with free(3).
112 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_id_by_path(struct got_object_id **,
113 945f9229 2022-04-16 thomas struct got_repository *, struct got_commit_object *, const char *);
116 0c60ce5a 2018-04-02 stsp * Obtain the type of an object.
117 0c60ce5a 2018-04-02 stsp * Returns one of the GOT_OBJ_TYPE_x values (see above).
119 15a94983 2018-12-23 stsp const struct got_error *got_object_get_type(int *, struct got_repository *,
120 15a94983 2018-12-23 stsp struct got_object_id *);
123 15a94983 2018-12-23 stsp * Attempt to resolve the textual representation of an object ID
124 15a94983 2018-12-23 stsp * to the ID of an existing object in the repository.
125 15a94983 2018-12-23 stsp * The caller should dispose of the ID with free(3).
127 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_resolve_id_str(struct got_object_id **,
128 6c34b1aa 2019-03-18 stsp struct got_repository *, const char *);
131 0c60ce5a 2018-04-02 stsp * Attempt to open a commit object in a repository.
132 0c60ce5a 2018-04-02 stsp * The caller must dispose of the commit with got_object_commit_close().
134 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_open_as_commit(struct got_commit_object **,
135 15a94983 2018-12-23 stsp struct got_repository *, struct got_object_id *);
137 0c60ce5a 2018-04-02 stsp /* Dispose of a commit object. */
138 d1cda826 2017-11-06 stsp void got_object_commit_close(struct got_commit_object *);
140 45d799e2 2018-12-23 stsp /* Obtain the ID of the tree created in a commit. */
141 45d799e2 2018-12-23 stsp struct got_object_id *got_object_commit_get_tree_id(struct got_commit_object *);
143 45d799e2 2018-12-23 stsp /* Obtain the number of parent commits of a commit. */
144 45d799e2 2018-12-23 stsp int got_object_commit_get_nparents(struct got_commit_object *);
146 45d799e2 2018-12-23 stsp /* Obtain the list of parent commits of a commit. */
147 45d799e2 2018-12-23 stsp const struct got_object_id_queue *got_object_commit_get_parent_ids(
148 45d799e2 2018-12-23 stsp struct got_commit_object *);
150 45d799e2 2018-12-23 stsp /* Get the author's name and email address. */
151 45d799e2 2018-12-23 stsp const char *got_object_commit_get_author(struct got_commit_object *);
153 2df4e4ff 2018-12-23 stsp /* Get an author's commit timestamp in UTC. */
154 45d799e2 2018-12-23 stsp time_t got_object_commit_get_author_time(struct got_commit_object *);
156 45d799e2 2018-12-23 stsp /* Get an author's timezone offset. */
157 45d799e2 2018-12-23 stsp time_t got_object_commit_get_author_gmtoff(struct got_commit_object *);
159 45d799e2 2018-12-23 stsp /* Get the committer's name and email address. */
160 45d799e2 2018-12-23 stsp const char *got_object_commit_get_committer(struct got_commit_object *);
162 450eaa8b 2018-12-23 stsp /* Get a committer's commit timestamp in UTC. */
163 45d799e2 2018-12-23 stsp time_t got_object_commit_get_committer_time(struct got_commit_object *);
165 450eaa8b 2018-12-23 stsp /* Get a committer's timezone offset. */
166 45d799e2 2018-12-23 stsp time_t got_object_commit_get_committer_gmtoff(struct got_commit_object *);
169 24ea5512 2019-08-22 stsp * Get the commit log message.
170 24ea5512 2019-08-22 stsp * PGP-signatures contained in the log message will be stripped.
171 24ea5512 2019-08-22 stsp * The caller must dispose of it with free(3).
173 5943eee2 2019-08-13 stsp const struct got_error *got_object_commit_get_logmsg(char **,
174 5943eee2 2019-08-13 stsp struct got_commit_object *);
176 24ea5512 2019-08-22 stsp /* Get the raw commit log message.*/
177 24ea5512 2019-08-22 stsp const char *got_object_commit_get_logmsg_raw(struct got_commit_object *);
180 0c60ce5a 2018-04-02 stsp * Attempt to open a tree object in a repository.
181 0c60ce5a 2018-04-02 stsp * The caller must dispose of the tree with got_object_tree_close().
183 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_open_as_tree(struct got_tree_object **,
184 15a94983 2018-12-23 stsp struct got_repository *, struct got_object_id *);
186 0c60ce5a 2018-04-02 stsp /* Dispose of a tree object. */
187 0ffeb3c2 2017-11-26 stsp void got_object_tree_close(struct got_tree_object *);
189 56e0773d 2019-11-28 stsp /* Get the number of entries in this tree object. */
190 56e0773d 2019-11-28 stsp int got_object_tree_get_nentries(struct got_tree_object *);
192 56e0773d 2019-11-28 stsp /* Get the first tree entry from a tree, or NULL if there is none. */
193 48b4f239 2021-12-31 thomas struct got_tree_entry *got_object_tree_get_first_entry(
194 48b4f239 2021-12-31 thomas struct got_tree_object *);
196 56e0773d 2019-11-28 stsp /* Get the last tree entry from a tree, or NULL if there is none. */
197 56e0773d 2019-11-28 stsp struct got_tree_entry *got_object_tree_get_last_entry(struct got_tree_object *);
199 56e0773d 2019-11-28 stsp /* Get the entry with the specified index from a tree object. */
200 56e0773d 2019-11-28 stsp struct got_tree_entry *got_object_tree_get_entry(
201 56e0773d 2019-11-28 stsp struct got_tree_object *, int);
203 56e0773d 2019-11-28 stsp /* Find a particular entry in a tree by name. */
204 56e0773d 2019-11-28 stsp struct got_tree_entry *got_object_tree_find_entry(
205 a129376b 2019-03-28 stsp struct got_tree_object *, const char *);
207 56e0773d 2019-11-28 stsp /* Get the file permission mode of a tree entry. */
208 56e0773d 2019-11-28 stsp mode_t got_tree_entry_get_mode(struct got_tree_entry *);
210 56e0773d 2019-11-28 stsp /* Get the name of a tree entry. */
211 56e0773d 2019-11-28 stsp const char *got_tree_entry_get_name(struct got_tree_entry *);
213 56e0773d 2019-11-28 stsp /* Get the object ID of a tree entry. */
214 56e0773d 2019-11-28 stsp struct got_object_id *got_tree_entry_get_id(struct got_tree_entry *);
217 0d6c6ee3 2020-05-20 stsp * Get a string containing the target path of a given a symlink tree entry.
218 0d6c6ee3 2020-05-20 stsp * The caller should dispose of it with free(3).
220 0d6c6ee3 2020-05-20 stsp const struct got_error *got_tree_entry_get_symlink_target(char **,
221 0d6c6ee3 2020-05-20 stsp struct got_tree_entry *, struct got_repository *);
223 56e0773d 2019-11-28 stsp /* Get the index of a tree entry. */
224 56e0773d 2019-11-28 stsp int got_tree_entry_get_index(struct got_tree_entry *);
226 56e0773d 2019-11-28 stsp /* Get the next tree entry from a tree, or NULL if there is none. */
227 56e0773d 2019-11-28 stsp struct got_tree_entry *got_tree_entry_get_next(struct got_tree_object *,
228 56e0773d 2019-11-28 stsp struct got_tree_entry *);
230 56e0773d 2019-11-28 stsp /* Get the previous tree entry from a tree, or NULL if there is none. */
231 56e0773d 2019-11-28 stsp struct got_tree_entry *got_tree_entry_get_prev(struct got_tree_object *,
232 56e0773d 2019-11-28 stsp struct got_tree_entry *);
234 63c5ca5d 2019-08-24 stsp /* Return non-zero if the specified tree entry is a Git submodule. */
235 56e0773d 2019-11-28 stsp int got_object_tree_entry_is_submodule(struct got_tree_entry *);
237 e40622f4 2020-07-23 stsp /* Return non-zero if the specified tree entry is a symbolic link. */
238 e40622f4 2020-07-23 stsp int got_object_tree_entry_is_symlink(struct got_tree_entry *);
241 e40622f4 2020-07-23 stsp * Resolve an in-repository symlink at the specified path in the tree
242 e40622f4 2020-07-23 stsp * corresponding to the specified commit. If the specified path is not
243 e40622f4 2020-07-23 stsp * a symlink then set *link_target to NULL.
244 e40622f4 2020-07-23 stsp * Otherwise, resolve symlinks recursively and return the final link
245 b6b86fd1 2022-08-30 thomas * target path. The caller must dispose of it with free(3).
247 e40622f4 2020-07-23 stsp const struct got_error *got_object_resolve_symlinks(char **, const char *,
248 945f9229 2022-04-16 thomas struct got_commit_object *, struct got_repository *);
251 07862c20 2018-09-15 stsp * Compare two trees and indicate whether the entry at the specified path
252 31cedeaf 2018-09-15 stsp * differs between them. The path must not be the root path "/"; the function
253 31cedeaf 2018-09-15 stsp * got_object_id_cmp() should be used instead to compare the tree roots.
255 07862c20 2018-09-15 stsp const struct got_error *got_object_tree_path_changed(int *,
256 07862c20 2018-09-15 stsp struct got_tree_object *, struct got_tree_object *, const char *,
257 07862c20 2018-09-15 stsp struct got_repository *);
260 0c60ce5a 2018-04-02 stsp * Attempt to open a blob object in a repository.
261 0c60ce5a 2018-04-02 stsp * The size_t argument specifies the block size of an associated read buffer.
262 0c60ce5a 2018-04-02 stsp * The caller must dispose of the blob with got_object_blob_close().
264 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_open_as_blob(struct got_blob_object **,
265 f4ae6ddb 2022-07-01 thomas struct got_repository *, struct got_object_id *, size_t, int);
267 0c60ce5a 2018-04-02 stsp /* Dispose of a blob object. */
268 fb43ecf1 2019-02-11 stsp const struct got_error *got_object_blob_close(struct got_blob_object *);
271 0c60ce5a 2018-04-02 stsp * Get the length of header data at the beginning of the blob's read buffer.
272 0c60ce5a 2018-04-02 stsp * Note that header data is only present upon the first invocation of
273 0c60ce5a 2018-04-02 stsp * got_object_blob_read_block() after the blob is opened.
275 f934cf2c 2018-02-12 stsp size_t got_object_blob_get_hdrlen(struct got_blob_object *);
278 0c60ce5a 2018-04-02 stsp * Get a pointer to the blob's read buffer.
279 0c60ce5a 2018-04-02 stsp * The read buffer is filled by got_object_blob_read_block().
281 f934cf2c 2018-02-12 stsp const uint8_t *got_object_blob_get_read_buf(struct got_blob_object *);
284 0c60ce5a 2018-04-02 stsp * Read the next chunk of data from a blob, up to the blob's read buffer
285 0c60ce5a 2018-04-02 stsp * block size. The size_t output argument indicates how many bytes have
286 0c60ce5a 2018-04-02 stsp * been read into the blob's read buffer. Zero bytes will be reported if
287 0c60ce5a 2018-04-02 stsp * all data in the blob has been read.
289 eb651edf 2018-02-11 stsp const struct got_error *got_object_blob_read_block(size_t *,
290 eb651edf 2018-02-11 stsp struct got_blob_object *);
292 8ba819a3 2020-07-23 stsp /* Rewind an open blob's data stream back to the beginning. */
293 8ba819a3 2020-07-23 stsp void got_object_blob_rewind(struct got_blob_object *);
296 a5f70c45 2023-01-06 thomas * Heuristic to check whether the blob contains binary data. Rewinds
297 a5f70c45 2023-01-06 thomas * the blob's data stream back after the header.
299 a5f70c45 2023-01-06 thomas const struct got_error *got_object_blob_is_binary(int *,
300 a5f70c45 2023-01-06 thomas struct got_blob_object *);
303 ae30b714 2023-01-06 thomas * getline(3) for blobs.
305 ae30b714 2023-01-06 thomas const struct got_error *got_object_blob_getline(char **, ssize_t *,
306 ae30b714 2023-01-06 thomas size_t *, struct got_blob_object *);
309 35e9ba5d 2018-06-21 stsp * Read the entire content of a blob and write it to the specified file.
310 84451b3e 2018-07-10 stsp * Flush and rewind the file as well. Indicate the amount of bytes
311 6c4c42e0 2019-06-24 stsp * written in the size_t output argument, and the number of lines in the
312 0f6650ff 2019-08-14 stsp * file in the int argument, and line offsets in the off_t argument
313 6c4c42e0 2019-06-24 stsp * (NULL can be passed for any output argument).
315 be659d10 2020-11-18 stsp const struct got_error *got_object_blob_dump_to_file(off_t *, int *,
316 6c4c42e0 2019-06-24 stsp off_t **, FILE *, struct got_blob_object *);
319 af57b12a 2020-07-23 stsp * Read the entire content of a blob into a newly allocated string buffer
320 af57b12a 2020-07-23 stsp * and terminate it with '\0'. This is intended for blobs which contain a
321 af57b12a 2020-07-23 stsp * symlink target path. It should not be used to process arbitrary blobs.
322 af57b12a 2020-07-23 stsp * Use got_object_blob_dump_to_file() or got_tree_entry_get_symlink_target()
323 af57b12a 2020-07-23 stsp * instead if possible. The caller must dispose of the string with free(3).
325 af57b12a 2020-07-23 stsp const struct got_error *got_object_blob_read_to_str(char **,
326 af57b12a 2020-07-23 stsp struct got_blob_object *);
329 f4a881ce 2018-11-17 stsp * Attempt to open a tag object in a repository.
330 01073a5d 2019-08-22 stsp * The caller must dispose of the tree with got_tag_object_close().
332 15a94983 2018-12-23 stsp const struct got_error *got_object_open_as_tag(struct got_tag_object **,
333 15a94983 2018-12-23 stsp struct got_repository *, struct got_object_id *);
335 f4a881ce 2018-11-17 stsp /* Dispose of a tag object. */
336 f4a881ce 2018-11-17 stsp void got_object_tag_close(struct got_tag_object *);
338 d24820bf 2019-08-11 stsp /* Get the name of a tag. */
339 d24820bf 2019-08-11 stsp const char *got_object_tag_get_name(struct got_tag_object *);
341 0bd18d37 2019-02-01 stsp /* Get type of the object a tag points to. */
342 0bd18d37 2019-02-01 stsp int got_object_tag_get_object_type(struct got_tag_object *);
345 0bd18d37 2019-02-01 stsp * Get ID of the object a tag points to.
346 0bd18d37 2019-02-01 stsp * This must not be freed by the caller. Use got_object_id_dup() if needed.
348 0bd18d37 2019-02-01 stsp struct got_object_id *got_object_tag_get_object_id(struct got_tag_object *);
351 01073a5d 2019-08-22 stsp /* Get the timestamp of the tag. */
352 01073a5d 2019-08-22 stsp time_t got_object_tag_get_tagger_time(struct got_tag_object *);
354 01073a5d 2019-08-22 stsp /* Get the tag's timestamp's GMT offset. */
355 01073a5d 2019-08-22 stsp time_t got_object_tag_get_tagger_gmtoff(struct got_tag_object *);
357 01073a5d 2019-08-22 stsp /* Get the author of the tag. */
358 01073a5d 2019-08-22 stsp const char *got_object_tag_get_tagger(struct got_tag_object *);
360 01073a5d 2019-08-22 stsp /* Get the tag message associated with the tag. */
361 01073a5d 2019-08-22 stsp const char *got_object_tag_get_message(struct got_tag_object *);
363 bff6ca00 2018-04-23 stsp const struct got_error *got_object_commit_add_parent(struct got_commit_object *,
364 bff6ca00 2018-04-23 stsp const char *);
366 8e7bd50a 2019-08-22 stsp /* Create a new tag object in the repository. */
367 8e7bd50a 2019-08-22 stsp const struct got_error *got_object_tag_create(struct got_object_id **,
368 8e7bd50a 2019-08-22 stsp const char *, struct got_object_id *, const char *,
369 871bd038 2022-07-03 thomas time_t, const char *, const char *, struct got_repository *, int verbosity);
371 6f6c25d6 2022-09-18 thomas /* Increment commit object reference counter. */
372 6f6c25d6 2022-09-18 thomas void got_object_commit_retain(struct got_commit_object *);
