File: base85.go

package info (click to toggle)
golang-github-dromara-dongle 1.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,440 kB
  • sloc: makefile: 4
file content (328 lines) | stat: -rw-r--r-- 9,714 bytes parent folder | download
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
// Package base85 implements base85 encoding and decoding with streaming support.
// It provides base85 encoding using Go's standard encoding/ascii85 package,
// which implements the ASCII85 encoding as specified in Adobe's PostScript and PDF specifications.
package base85

import (
	"encoding/ascii85"
	"io"
)

// StdEncoder represents a base85 encoder for standard encoding operations.
// It implements base85 encoding using Go's standard encoding/ascii85 package,
// providing efficient encoding of binary data to ASCII85 strings.
type StdEncoder struct {
	Error error // Error field for storing encoding errors
}

// NewStdEncoder creates a new base85 encoder using the standard ASCII85 alphabet.
func NewStdEncoder() *StdEncoder {
	return &StdEncoder{}
}

// Encode encodes the given byte slice using ASCII85 encoding.
// Uses Go's standard encoding/ascii85 package for reliable and efficient encoding.
func (e *StdEncoder) Encode(src []byte) (dst []byte) {
	if e.Error != nil {
		return
	}
	if len(src) == 0 {
		return
	}

	// Use Go's standard ascii85 encoding
	dst = make([]byte, ascii85.MaxEncodedLen(len(src)))
	n := ascii85.Encode(dst, src)
	return dst[:n]
}

// StdDecoder represents a base85 decoder for standard decoding operations.
// It implements base85 decoding using Go's standard encoding/ascii85 package,
// providing efficient decoding of ASCII85 strings back to binary data.
type StdDecoder struct {
	Error error // Error field for storing decoding errors
}

// NewStdDecoder creates a new base85 decoder using the standard ASCII85 alphabet.
func NewStdDecoder() *StdDecoder {
	return &StdDecoder{}
}

// Decode decodes the given ASCII85-encoded byte slice back to binary data.
// Uses Go's standard encoding/ascii85 package for reliable and efficient decoding.
// Handles special cases like "z" representing 4 zero bytes and incomplete groups.
func (d *StdDecoder) Decode(src []byte) (dst []byte, err error) {
	if d.Error != nil {
		err = d.Error
		return
	}
	if len(src) == 0 {
		return
	}

	// Handle special case: "z" represents 4 zero bytes
	if len(src) == 1 && src[0] == 'z' {
		return []byte{0, 0, 0, 0}, nil
	}

	// For incomplete groups, we need to pad to complete 5-character groups
	// Go's ascii85.Decode requires complete groups
	paddedSrc := src
	if len(src)%5 != 0 {
		// Pad with 'u' characters to complete the group
		padding := 5 - (len(src) % 5)
		paddedSrc = make([]byte, len(src)+padding)
		copy(paddedSrc, src)
		for i := len(src); i < len(paddedSrc); i++ {
			paddedSrc[i] = 'u'
		}
	}

	// Use Go's standard ascii85 decoding
	dst = make([]byte, len(paddedSrc)) // ASCII85 decoding can't produce more bytes than input
	n, _, err := ascii85.Decode(dst, paddedSrc, true)
	if err != nil {
		return nil, CorruptInputError(0)
	}

	// Calculate the actual number of bytes based on the original input length
	// For incomplete groups, we need to determine how many bytes were actually encoded
	actualBytes := d.calculateActualBytes(len(src))
	if actualBytes < n {
		return dst[:actualBytes], nil
	}

	return dst[:n], nil
}

// calculateActualBytes calculates the actual number of bytes that were encoded
// based on the number of ASCII85 characters
func (d *StdDecoder) calculateActualBytes(charCount int) int {
	// ASCII85 encoding: 4 bytes -> 5 characters
	// For incomplete groups at the end:
	// 1 char -> 1 byte
	// 2 chars -> 1 byte
	// 3 chars -> 2 bytes
	// 4 chars -> 3 bytes
	// 5 chars -> 4 bytes (complete group)

	// Calculate complete groups first
	completeGroups := charCount / 5
	remainder := charCount % 5

	// Each complete group of 5 chars represents 4 bytes
	totalBytes := completeGroups * 4

	// Add bytes for the remainder
	switch remainder {
	case 1, 2:
		totalBytes += 1
	case 3:
		totalBytes += 2
	case 4:
		totalBytes += 3
	}

	return totalBytes
}

// StreamEncoder represents a streaming base85 encoder that implements io.WriteCloser.
// It provides efficient encoding for large data streams by processing data
// in chunks and writing encoded output immediately.
type StreamEncoder struct {
	writer    io.Writer // Underlying writer for encoded output
	buffer    []byte    // Buffer for accumulating partial bytes (0-3 bytes)
	encodeBuf [5]byte   // Reusable buffer for encoding output (4 bytes -> 5 chars)
	Error     error     // Error field for storing encoding errors
}

// NewStreamEncoder creates a new streaming base85 encoder that writes encoded data
// to the provided io.Writer. The encoder uses the standard ASCII85 alphabet.
func NewStreamEncoder(w io.Writer) io.WriteCloser {
	return &StreamEncoder{
		writer: w,
	}
}

// Write implements the io.Writer interface for streaming base85 encoding.
// Processes data in chunks while maintaining minimal state for cross-Write calls.
// This is true streaming - processes data immediately without accumulating large buffers.
func (e *StreamEncoder) Write(p []byte) (n int, err error) {
	if e.Error != nil {
		return 0, e.Error
	}

	if len(p) == 0 {
		return 0, nil
	}

	// Combine any leftover bytes from previous write with new data
	// This is necessary for true streaming across multiple Write calls
	data := append(e.buffer, p...)
	e.buffer = nil // Clear buffer after combining

	// Process data in chunks of 4 bytes (optimal for base85 encoding)
	// Base85 encoding converts 4 bytes to 5 characters
	chunkSize := 4
	chunks := len(data) / chunkSize

	for i := 0; i < chunks*chunkSize; i += chunkSize {
		chunk := data[i : i+chunkSize]
		// Use reusable buffer for encoding to avoid allocations
		n := ascii85.Encode(e.encodeBuf[:], chunk)
		if _, err = e.writer.Write(e.encodeBuf[:n]); err != nil {
			return len(p), err
		}
	}

	// Buffer remaining 0-3 bytes for next write or close
	remainder := len(data) % chunkSize
	if remainder > 0 {
		e.buffer = data[len(data)-remainder:]
	}

	return len(p), nil
}

// Close implements the io.WriteCloser interface for streaming base85 encoding.
// Encodes any remaining buffered bytes from the last Write call.
// This is the only place where we handle cross-Write state.
func (e *StreamEncoder) Close() error {
	if e.Error != nil {
		return e.Error
	}

	// Encode any remaining bytes (1-3 bytes) from the last Write
	if len(e.buffer) > 0 {
		// Use reusable buffer for final encoding
		n := ascii85.Encode(e.encodeBuf[:], e.buffer)
		if _, err := e.writer.Write(e.encodeBuf[:n]); err != nil {
			return err
		}
		e.buffer = nil
	}

	return nil
}

// StreamDecoder represents a streaming base85 decoder that implements io.Reader.
// It provides efficient decoding for large data streams by processing data
// in chunks and maintaining an internal buffer for partial reads.
type StreamDecoder struct {
	reader  io.Reader  // Underlying reader for encoded input
	buffer  []byte     // Buffer for decoded data not yet read
	pos     int        // Current position in the decoded buffer
	readBuf [1024]byte // Reusable buffer for reading encoded data
	Error   error      // Error field for storing decoding errors
}

// NewStreamDecoder creates a new streaming base85 decoder that reads encoded data
// from the provided io.Reader. The decoder uses the standard ASCII85 alphabet.
func NewStreamDecoder(r io.Reader) io.Reader {
	return &StreamDecoder{
		reader: r,
	}
}

// Read implements the io.Reader interface for streaming base85 decoding.
// Reads and decodes ASCII85 data from the underlying reader in chunks.
// Maintains an internal buffer to handle partial reads efficiently.
func (d *StreamDecoder) Read(p []byte) (n int, err error) {
	if d.Error != nil {
		return 0, d.Error
	}

	// Return buffered data if available
	if d.pos < len(d.buffer) {
		n = copy(p, d.buffer[d.pos:])
		d.pos += n
		return n, nil
	}

	// Read encoded data in chunks using reusable buffer
	rn, err := d.reader.Read(d.readBuf[:])
	if err != nil && err != io.EOF {
		return 0, err
	}

	if rn == 0 {
		return 0, io.EOF
	}

	// Decode the data directly
	decoded, err := d.decode(d.readBuf[:rn])
	if err != nil {
		return 0, err
	}

	// Copy decoded data to the provided buffer
	copied := copy(p, decoded)
	if copied < len(decoded) {
		// Buffer remaining data for next read
		d.buffer = decoded[copied:]
		d.pos = 0
	}

	return copied, nil
}

// decode decodes ASCII85 data using Go's standard library
func (d *StreamDecoder) decode(src []byte) ([]byte, error) {
	if len(src) == 0 {
		return nil, nil
	}

	// Handle special case: "z" represents 4 zero bytes
	if len(src) == 1 && src[0] == 'z' {
		return []byte{0, 0, 0, 0}, nil
	}

	// For incomplete groups, we need to pad to complete 5-character groups
	paddedSrc := src
	if len(src)%5 != 0 {
		// Pad with 'u' characters to complete the group
		padding := 5 - (len(src) % 5)
		paddedSrc = make([]byte, len(src)+padding)
		copy(paddedSrc, src)
		for i := len(src); i < len(paddedSrc); i++ {
			paddedSrc[i] = 'u'
		}
	}

	// Use Go's standard ascii85 decoding
	dst := make([]byte, len(paddedSrc))
	n, _, err := ascii85.Decode(dst, paddedSrc, true)
	if err != nil {
		return nil, CorruptInputError(0)
	}

	// Calculate the actual number of bytes based on the original input length
	actualBytes := d.calculateActualBytes(len(src))
	if actualBytes < n {
		return dst[:actualBytes], nil
	}

	return dst[:n], nil
}

// calculateActualBytes calculates the actual number of bytes that were encoded
func (d *StreamDecoder) calculateActualBytes(charCount int) int {
	// ASCII85 encoding: 4 bytes -> 5 characters
	completeGroups := charCount / 5
	remainder := charCount % 5

	// Each complete group of 5 chars represents 4 bytes
	totalBytes := completeGroups * 4

	// Add bytes for the remainder
	switch remainder {
	case 1, 2:
		totalBytes += 1
	case 3:
		totalBytes += 2
	case 4:
		totalBytes += 3
	}

	return totalBytes
}