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