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