aboutsummaryrefslogtreecommitdiff
path: root/object/store/packed/reader.go
blob: cf433cfce85bbda46d0740bd3196c75cfdf52100 (about) (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
package packed

import (
	"bytes"
	"fmt"
	"io"

	"lindenii.org/go/furgit/internal/compress/zlib"
	"lindenii.org/go/furgit/internal/format/packfile"
	"lindenii.org/go/furgit/internal/iolimit"
	"lindenii.org/go/furgit/object/header"
	"lindenii.org/go/furgit/object/id"
	"lindenii.org/go/furgit/object/typ"
	"lindenii.org/go/lgo/intconv"
)

// ReadBytesContent reads an object's type and content bytes,
// fully resolving delta chains.
func (packed *Packed) ReadBytesContent(objectID id.ObjectID) (typ.Type, []byte, error) {
	p, offset, err := packed.lookup(objectID)
	if err != nil {
		return typ.Unknown, nil, err
	}

	entryType, content, err := packed.unpackEntry(p, offset)
	if err != nil {
		return typ.Unknown, nil, err
	}

	ty, err := objectTypeOf(entryType)
	if err != nil {
		return typ.Unknown, nil, err
	}

	return ty, content, nil
}

// ReadBytesFull reads a full serialized object as "type size\x00content",
// fully resolving delta chains.
func (packed *Packed) ReadBytesFull(objectID id.ObjectID) ([]byte, error) {
	ty, content, err := packed.ReadBytesContent(objectID)
	if err != nil {
		return nil, err
	}

	raw := header.Append(make([]byte, 0, len(content)+32), ty, len(content))

	return append(raw, content...), nil
}

// ReadHeader reads an object's type and declared content length.
//
// For delta entries this resolves the chained base type
// and the declared delta result size,
// without reconstructing content.
func (packed *Packed) ReadHeader(objectID id.ObjectID) (typ.Type, int, error) {
	p, offset, err := packed.lookup(objectID)
	if err != nil {
		return typ.Unknown, 0, err
	}

	entryHeader, payload, err := p.entryHeaderAt(offset, packed.objectFormat)
	if err != nil {
		return typ.Unknown, 0, err
	}

	var size int

	if entryHeader.Type.IsDelta() {
		size, err = deltaResultSize(payload, entryHeader.Size)
		if err != nil {
			return typ.Unknown, 0, fmt.Errorf("%w: pack %q: %w", ErrMalformedPackedStore, p.name, err)
		}
	} else {
		size, err = intconv.Uint64ToInt(entryHeader.Size)
		if err != nil {
			return typ.Unknown, 0, fmt.Errorf("%w: pack %q: object size overflows int: %w", ErrMalformedPackedStore, p.name, err)
		}
	}

	entryType, err := packed.resolveType(p, offset, entryHeader)
	if err != nil {
		return typ.Unknown, 0, err
	}

	ty, err := objectTypeOf(entryType)
	if err != nil {
		return typ.Unknown, 0, err
	}

	return ty, size, nil
}

// ReadSize reads an object's declared content length.
//
// Unlike ReadHeader,
// this never walks delta chains.
func (packed *Packed) ReadSize(objectID id.ObjectID) (int, error) {
	p, offset, err := packed.lookup(objectID)
	if err != nil {
		return 0, err
	}

	entryHeader, payload, err := p.entryHeaderAt(offset, packed.objectFormat)
	if err != nil {
		return 0, err
	}

	if !entryHeader.Type.IsDelta() {
		size, err := intconv.Uint64ToInt(entryHeader.Size)
		if err != nil {
			return 0, fmt.Errorf("%w: pack %q: object size overflows int: %w", ErrMalformedPackedStore, p.name, err)
		}

		return size, nil
	}

	size, err := deltaResultSize(payload, entryHeader.Size)
	if err != nil {
		return 0, fmt.Errorf("%w: pack %q: %w", ErrMalformedPackedStore, p.name, err)
	}

	return size, nil
}

// ReadReaderContent reads an object's type,
// declared content length, and content stream.
//
// Non-delta entries stream directly from the pack;
// delta entries are fully resolved in memory first.
// Close releases resources only
// and does not drain unread data for additional validation.
func (packed *Packed) ReadReaderContent(objectID id.ObjectID) (typ.Type, int, io.ReadCloser, error) {
	p, offset, err := packed.lookup(objectID)
	if err != nil {
		return typ.Unknown, 0, nil, err
	}

	entryHeader, payload, err := p.entryHeaderAt(offset, packed.objectFormat)
	if err != nil {
		return typ.Unknown, 0, nil, err
	}

	if !entryHeader.Type.IsBase() {
		entryType, content, err := packed.unpackEntry(p, offset)
		if err != nil {
			return typ.Unknown, 0, nil, err
		}

		ty, err := objectTypeOf(entryType)
		if err != nil {
			return typ.Unknown, 0, nil, err
		}

		return ty, len(content), io.NopCloser(bytes.NewReader(content)), nil
	}

	ty, err := objectTypeOf(entryHeader.Type)
	if err != nil {
		return typ.Unknown, 0, nil, err
	}

	size, err := intconv.Uint64ToInt(entryHeader.Size)
	if err != nil {
		return typ.Unknown, 0, nil, fmt.Errorf("%w: pack %q: object size overflows int: %w", ErrMalformedPackedStore, p.name, err)
	}

	zr, err := zlib.NewReaderBytes(payload)
	if err != nil {
		return typ.Unknown, 0, nil, fmt.Errorf("%w: pack %q: %w", ErrMalformedPackedStore, p.name, err)
	}

	return ty, size, &objectReader{
		reader: iolimit.ExpectLengthReader(zr, size),
		zr:     zr,
	}, nil
}

// ReadReaderFull reads a full serialized object stream
// as "type size\x00content".
//
// Non-delta entries stream directly from the pack;
// delta entries are fully resolved in memory first.
// Close releases resources only
// and does not drain unread data for additional validation.
func (packed *Packed) ReadReaderFull(objectID id.ObjectID) (io.ReadCloser, error) {
	ty, size, reader, err := packed.ReadReaderContent(objectID)
	if err != nil {
		return nil, err
	}

	headerBytes := header.Append(nil, ty, size)

	return &objectReader{
		reader: io.MultiReader(bytes.NewReader(headerBytes), reader),
		zr:     reader,
	}, nil
}

// objectTypeOf converts one packfile entry type
// into an ordinary object type.
func objectTypeOf(entryType packfile.EntryType) (typ.Type, error) {
	ty, err := entryType.ObjectType()
	if err != nil {
		return typ.Unknown, fmt.Errorf("%w: %w", ErrMalformedPackedStore, err)
	}

	return ty, nil
}

// objectReader streams one packed object payload
// and owns the underlying decompressor.
type objectReader struct {
	// reader is the stream exposed by Read.
	reader io.Reader
	// zr is closed by Close.
	zr io.Closer
}

func (reader *objectReader) Read(dst []byte) (int, error) {
	return reader.reader.Read(dst)
}

func (reader *objectReader) Close() error {
	return reader.zr.Close()
}