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