1 /*
2  * Copyright (c) 2018, 2019, 2020 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 	u_int8_t sha1[SHA1_DIGEST_LENGTH];
19 };
20 
21 struct got_object {
22 	int type;
23 
24 	int flags;
25 #define GOT_OBJ_FLAG_PACKED		0x01
26 #define GOT_OBJ_FLAG_DELTIFIED		0x02
27 
28 	size_t hdrlen;
29 	size_t size;
30 	struct got_object_id id;
31 
32 	int pack_idx;		/* if packed */
33 	off_t pack_offset;	/* if packed */
34 	struct got_delta_chain deltas; /* if deltified */
35 	int refcnt;		/* > 0 if open and/or cached */
36 };
37 
38 struct got_raw_object {
39 	FILE *f;
40 	uint8_t *data;
41 	off_t size;
42 	size_t hdrlen;
43 	size_t blocksize;
44 	uint8_t *read_buf;
45 };
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 	int refcnt;		/* > 0 if open and/or cached */
59 
60 	int flags;
61 #define GOT_COMMIT_FLAG_PACKED		0x01
62 };
63 
64 struct got_tree_entry {
65 	mode_t mode;
66 	char name[NAME_MAX + 1 /* NUL */];
67 	struct got_object_id id;
68 	int idx;
69 };
70 
71 struct got_tree_object {
72 	int nentries;
73 	struct got_tree_entry *entries;
74 	int refcnt;
75 };
76 
77 struct got_blob_object {
78 	FILE *f;
79 	uint8_t *data;
80 	size_t hdrlen;
81 	size_t blocksize;
82 	uint8_t *read_buf;
83 	struct got_object_id id;
84 };
85 
86 struct got_tag_object {
87 	struct got_object_id id;
88 	int obj_type;
89 	char *tag;
90 	time_t tagger_time;
91 	time_t tagger_gmtoff;
92 	char *tagger;
93 	char *tagmsg;
94 	int refcnt;		/* > 0 if open and/or cached */
95 };
96 
97 struct got_object_id *got_object_get_id(struct got_object *);
98 const struct got_error *got_object_get_id_str(char **, struct got_object *);
99 const struct got_error *got_object_get_path(char **, struct got_object_id *,
100     struct got_repository *);
101 const struct got_error *got_object_open_loose_fd(int *, struct got_object_id *,
102     struct got_repository *);
103 const struct got_error *got_object_open(struct got_object **,
104     struct got_repository *, struct got_object_id *);
105 const struct got_error *got_object_raw_open(struct got_raw_object **,
106     struct got_repository *, struct got_object_id *, size_t);
107 void got_object_raw_rewind(struct got_raw_object *);
108 size_t got_object_raw_get_hdrlen(struct got_raw_object *);
109 const uint8_t *got_object_raw_get_read_buf(struct got_raw_object *);
110 const struct got_error * got_object_raw_read_block(size_t *,
111     struct got_raw_object *);
112 const struct got_error *got_object_raw_close(struct got_raw_object *);
113 const struct got_error *got_object_open_by_id_str(struct got_object **,
114     struct got_repository *, const char *);
115 void got_object_close(struct got_object *);
116 const struct got_error *got_object_commit_open(struct got_commit_object **,
117     struct got_repository *, struct got_object *);
118 const struct got_error *got_object_tree_open(struct got_tree_object **,
119     struct got_repository *, struct got_object *);
120 const struct got_error *got_object_blob_open(struct got_blob_object **,
121     struct got_repository *, struct got_object *, size_t);
122 char *got_object_blob_id_str(struct got_blob_object*, char *, size_t);
123 const struct got_error *got_object_tag_open(struct got_tag_object **,
124     struct got_repository *, struct got_object *);
125 const struct got_error *got_object_tree_entry_dup(struct got_tree_entry **,
126     struct got_tree_entry *);
127 
128 const struct got_error *got_traverse_packed_commits(
129     struct got_object_id_queue *, struct got_object_id *, const char *,
130     struct got_repository *);