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 
21 struct got_tree_entry {
22 	SIMPLEQ_ENTRY(got_tree_entry) entry;
23 	mode_t mode;
24 	char *name;
25 	struct got_object_id *id;
26 };
27 
28 struct got_tree_object {
29 	int nentries;
30 	SIMPLEQ_HEAD(, got_tree_entry) entries;
31 };
32 
33 struct got_parent_id {
34 	SIMPLEQ_ENTRY(got_parent_id) entry;
35 	struct got_object_id *id;
36 };
37 
38 struct got_commit_object {
39 	struct got_object_id *tree_id;
40 	unsigned int nparents;
41 	SIMPLEQ_HEAD(, got_parent_id) parent_ids;
42 	char *author;
43 	time_t author_time;	/* UTC */
44 	char *committer;
45 	time_t committer_time;	/* UTC */
46 	char *logmsg;
47 };
48 
49 /* A generic object. Used as a handle which holds an ID and an object type. */
50 struct got_object;
51 #define GOT_OBJ_TYPE_COMMIT		1
52 #define GOT_OBJ_TYPE_TREE		2
53 #define GOT_OBJ_TYPE_BLOB		3
54 #define GOT_OBJ_TYPE_TAG		4
55 /* 5 is reserved */
56 #define GOT_OBJ_TYPE_OFFSET_DELTA	6
57 #define GOT_OBJ_TYPE_REF_DELTA		7
58 
59 struct got_repository;
60 
61 /*
62  * Obtain a string representation of an object ID. The output depends on
63  * the hash function used by the repository format (currently SHA1).
64  */
65 const struct got_error *got_object_id_str(char **, struct got_object_id *);
66 
67 /*
68  * Compare two object IDs. Return value behaves like memcmp(3).
69  */
70 int got_object_id_cmp(struct got_object_id *, 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 copy of an object's ID.
80  * The caller should dispose of it with free(3).
81  */
82 struct got_object_id *got_object_get_id(struct got_object *);
83 
84 /*
85  * Get a newly allocated copy of an object's ID string.
86  * The caller should dispose of it with free(3).
87  */
88 const struct got_error *got_object_get_id_str(char **, struct got_object *);
89 
90 /*
91  * Obtain the type of an object.
92  * Returns one of the GOT_OBJ_TYPE_x values (see above).
93  */
94 int got_object_get_type(struct got_object *);
95 
96 /*
97  * Attempt to open the object in a repository with the provided ID.
98  * Caller must dispose of it with got_object_close().
99  */
100 const struct got_error *got_object_open(struct got_object **,
101     struct got_repository *, struct got_object_id *);
102 
103 /*
104  * Attempt to map the provided ID string to an object ID and then
105  * attempt to open the object in a repository with this ID.
106  * The form of an ID string depends on the hash function used by the
107  * repository format (currently SHA1).
108  * Caller must dispose of the object with got_object_close().
109  */
110 const struct got_error *got_object_open_by_id_str(struct got_object **,
111     struct got_repository *, const char *);
112 
113 /* Dispose of an object. */
114 void got_object_close(struct got_object *);
115 
116 /*
117  * Attempt to open a commit object in a repository.
118  * The provided object must be of type GOT_OBJ_TYPE_COMMIT.
119  * The caller must dispose of the commit with got_object_commit_close().
120  */
121 const struct got_error *got_object_commit_open(struct got_commit_object **,
122     struct got_repository *, struct got_object *);
123 
124 /* Dispose of a commit object. */
125 void got_object_commit_close(struct got_commit_object *);
126 
127 /*
128  * Attempt to open a tree object in a repository.
129  * The provided object must be of type GOT_OBJ_TYPE_TREE.
130  * The caller must dispose of the tree with got_object_tree_close().
131  */
132 const struct got_error *got_object_tree_open(struct got_tree_object **,
133     struct got_repository *, struct got_object *);
134 
135 /* Dispose of a tree object. */
136 void got_object_tree_close(struct got_tree_object *);
137 
138 /*
139  * Attempt to open a blob object in a repository.
140  * The provided object must be of type GOT_OBJ_TYPE_BLOB.
141  * The size_t argument specifies the block size of an associated read buffer.
142  * The caller must dispose of the blob with got_object_blob_close().
143  */
144 const struct got_error *got_object_blob_open(struct got_blob_object **,
145     struct got_repository *, struct got_object *, size_t);
146 
147 /* Dispose of a blob object. */
148 void got_object_blob_close(struct got_blob_object *);
149 
150 /*
151  * Write the string representation of the object ID of a blob to a buffer.
152  * The size_t argument speficies the size of the buffer. In the current
153  * implementation, it must be at least SHA1_DIGEST_STRING_LENGTH bytes.
154  * XXX This is a bad API, use got_object_id_str() instead.
155  */
156 char *got_object_blob_id_str(struct got_blob_object*, char *, size_t);
157 
158 /*
159  * Get the length of header data at the beginning of the blob's read buffer.
160  * Note that header data is only present upon the first invocation of
161  * got_object_blob_read_block() after the blob is opened.
162  */
163 size_t got_object_blob_get_hdrlen(struct got_blob_object *);
164 
165 /*
166  * Get a pointer to the blob's read buffer.
167  * The read buffer is filled by got_object_blob_read_block().
168  */
169 const uint8_t *got_object_blob_get_read_buf(struct got_blob_object *);
170 
171 /*
172  * Read the next chunk of data from a blob, up to the blob's read buffer
173  * block size. The size_t output argument indicates how many bytes have
174  * been read into the blob's read buffer. Zero bytes will be reported if
175  * all data in the blob has been read.
176  */
177 const struct got_error *got_object_blob_read_block(size_t *,
178     struct got_blob_object *);
179 const struct got_error *got_object_commit_add_parent(struct got_commit_object *,
180     const char *);