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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
#![allow(non_snake_case, dead_code)]

use super::Blob;
use crate::create_error;
use anyhow::Result;
use brotli::{enc::BrotliEncoderParams, BrotliCompress, BrotliDecompress};
#[cfg(feature = "full")]
use clap::ValueEnum;
use enumset::{EnumSet, EnumSetType};
use flate2::bufread::{GzDecoder, GzEncoder};
use std::io::{Cursor, Read};

/// Enum representing possible compression algorithms
#[derive(Debug, EnumSetType)]
#[cfg_attr(feature = "full", derive(ValueEnum))]
pub enum Compression {
	None,
	Gzip,
	Brotli,
}

#[derive(Debug, PartialEq)]
pub struct TargetCompression {
	compressions: EnumSet<Compression>,
	best_compression: bool,
}
#[allow(dead_code)]
impl TargetCompression {
	pub fn from_set(compressions: EnumSet<Compression>) -> Self {
		TargetCompression {
			compressions,
			best_compression: true,
		}
	}
	pub fn from(compression: Compression) -> Self {
		Self::from_set(EnumSet::only(compression))
	}
	pub fn from_none() -> Self {
		Self::from(Compression::None)
	}
	pub fn set_best_compression(&mut self, best_compression: bool) {
		self.best_compression = best_compression;
	}
	pub fn contains(&self, compression: Compression) -> bool {
		self.compressions.contains(compression)
	}
	pub fn insert(&mut self, compression: Compression) {
		self.compressions.insert(compression);
	}
}

#[allow(dead_code)]
pub fn optimize_compression(data: Blob, input: &Compression, target: TargetCompression) -> Result<(Blob, Compression)> {
	if target.compressions.is_empty() {
		return create_error!("no compression allowed");
	}

	if !target.best_compression && target.compressions.contains(*input) {
		return Ok((data, *input));
	}

	match input {
		Compression::None => {
			if target.compressions.contains(Compression::Brotli) {
				return Ok((compress_brotli(data)?, Compression::Brotli));
			}

			if target.compressions.contains(Compression::Gzip) {
				return Ok((compress_gzip(data)?, Compression::Gzip));
			}

			Ok((data, Compression::None))
		}
		Compression::Gzip => {
			if target.compressions.contains(Compression::Brotli) {
				return Ok((compress_brotli(decompress_gzip(data)?)?, Compression::Brotli));
			}

			if target.compressions.contains(Compression::Gzip) {
				return Ok((data, Compression::Gzip));
			}

			Ok((decompress_gzip(data)?, Compression::None))
		}
		Compression::Brotli => {
			if target.compressions.contains(Compression::Brotli) {
				return Ok((data, Compression::Brotli));
			}
			let data = decompress_brotli(data)?;

			if target.compressions.contains(Compression::Gzip) {
				return Ok((compress_gzip(data)?, Compression::Gzip));
			}

			Ok((data, Compression::None))
		}
	}
}

/// Compresses data based on the given compression algorithm
///
/// # Arguments
///
/// * `data` - The blob of data to compress
/// * `compression` - The compression algorithm to use
pub fn compress(data: Blob, compression: &Compression) -> Result<Blob> {
	match compression {
		Compression::None => Ok(data),
		Compression::Gzip => compress_gzip(data),
		Compression::Brotli => compress_brotli(data),
	}
}

/// Decompresses data based on the given compression algorithm
///
/// # Arguments
///
/// * `data` - The blob of data to decompress
/// * `compression` - The compression algorithm used for compression
pub fn decompress(data: Blob, compression: &Compression) -> Result<Blob> {
	match compression {
		Compression::None => Ok(data),
		Compression::Gzip => decompress_gzip(data),
		Compression::Brotli => decompress_brotli(data),
	}
}

/// Compresses data using gzip
///
/// # Arguments
///
/// * `data` - The blob of data to compress
pub fn compress_gzip(data: Blob) -> Result<Blob> {
	let mut result: Vec<u8> = Vec::new();
	GzEncoder::new(data.as_slice(), flate2::Compression::best()).read_to_end(&mut result)?;

	Ok(Blob::from(result))
}

/// Decompresses data that was compressed using gzip
///
/// # Arguments
///
/// * `data` - The blob of data to decompress
pub fn decompress_gzip(data: Blob) -> Result<Blob> {
	let mut result: Vec<u8> = Vec::new();
	GzDecoder::new(data.as_slice()).read_to_end(&mut result)?;

	Ok(Blob::from(result))
}

/// Compresses data using Brotli
///
/// # Arguments
///
/// * `data` - The blob of data to compress
pub fn compress_brotli(data: Blob) -> Result<Blob> {
	let params = BrotliEncoderParams {
		quality: 10, // smallest
		lgwin: 19,   // smallest
		size_hint: data.len(),
		..Default::default()
	};
	let mut input = Cursor::new(data.as_slice());
	let mut output: Vec<u8> = Vec::new();
	BrotliCompress(&mut input, &mut output, &params)?;

	Ok(Blob::from(output))
}

/// Decompresses data that was compressed using Brotli
///
/// # Arguments
///
/// * `data` - The blob of data to decompress
pub fn decompress_brotli(data: Blob) -> Result<Blob> {
	let mut cursor = Cursor::new(data.as_slice());
	let mut result: Vec<u8> = Vec::new();
	BrotliDecompress(&mut cursor, &mut result)?;

	Ok(Blob::from(result))
}

#[cfg(test)]
mod tests {
	use super::*;
	use enumset::enum_set;

	#[test]
	/// Verify that the Brotli compression and decompression functions work correctly.
	fn verify_brotli() -> Result<()> {
		// Generate random data.
		let data1 = random_data(100000);

		// Compress and then decompress the data.
		let data2 = decompress_brotli(compress_brotli(data1.clone())?)?;

		// Check that the original and decompressed data match.
		assert_eq!(data1, data2);

		Ok(())
	}

	#[test]
	/// Verify that the Gzip compression and decompression functions work correctly.
	fn verify_gzip() -> Result<()> {
		// Generate random data.
		let data1 = random_data(100000);

		// Compress and then decompress the data.
		let data2 = decompress_gzip(compress_gzip(data1.clone())?)?;

		// Check that the original and decompressed data match.
		assert_eq!(data1, data2);

		Ok(())
	}

	#[test]
	/// Test optimize_compression and try all combinations
	fn test_optimize_compression() -> Result<()> {
		let blob = random_data(100);
		let blob_gzip = compress_gzip(blob.clone())?;
		let blob_brotli = compress_brotli(blob.clone())?;

		let test = |compression_in: Compression,
		            compressions_out: EnumSet<Compression>,
		            best_compression: bool,
		            compression_exp: Compression|
		 -> Result<()> {
			let target = TargetCompression {
				compressions: compressions_out,
				best_compression,
			};
			let data_in = match compression_in {
				Compression::None => blob.clone(),
				Compression::Gzip => blob_gzip.clone(),
				Compression::Brotli => blob_brotli.clone(),
			};
			let data_exp = match compression_exp {
				Compression::None => blob.clone(),
				Compression::Gzip => blob_gzip.clone(),
				Compression::Brotli => blob_brotli.clone(),
			};
			let (data_res, compression_res) = optimize_compression(data_in, &compression_in, target)?;
			assert_eq!(
				compression_res, compression_exp,
				"compressing from {compression_in:?} to {compressions_out:?} using best compression ({best_compression}) should result {compression_exp:?} and not {compression_res:?}"
			);

			assert_eq!(data_res, data_exp);
			Ok(())
		};

		let N = Compression::None;
		let G = Compression::Gzip;
		let B = Compression::Brotli;

		let sN = enum_set!(Compression::None);
		let sG = enum_set!(Compression::Gzip);
		let sB = enum_set!(Compression::Brotli);
		let sNG = enum_set!(Compression::None | Compression::Gzip);
		let sNB = enum_set!(Compression::None | Compression::Brotli);
		let sNGB = enum_set!(Compression::None | Compression::Gzip | Compression::Brotli);

		test(N, sN, true, N)?;
		test(N, sG, true, G)?;
		test(N, sB, true, B)?;
		test(N, sNG, true, G)?;
		test(N, sNB, true, B)?;
		test(N, sNGB, true, B)?;

		test(G, sN, true, N)?;
		test(G, sG, true, G)?;
		test(G, sB, true, B)?;
		test(G, sNG, true, G)?;
		test(G, sNB, true, B)?;
		test(G, sNGB, true, B)?;

		test(B, sN, true, N)?;
		test(B, sG, true, G)?;
		test(B, sB, true, B)?;
		test(B, sNG, true, G)?;
		test(B, sNB, true, B)?;
		test(B, sNGB, true, B)?;

		test(N, sN, false, N)?;
		test(N, sG, false, G)?;
		test(N, sB, false, B)?;
		test(N, sNG, false, N)?;
		test(N, sNB, false, N)?;
		test(N, sNGB, false, N)?;

		test(G, sN, false, N)?;
		test(G, sG, false, G)?;
		test(G, sB, false, B)?;
		test(G, sNG, false, G)?;
		test(G, sNB, false, B)?;
		test(G, sNGB, false, G)?;

		test(B, sN, false, N)?;
		test(B, sG, false, G)?;
		test(B, sB, false, B)?;
		test(B, sNG, false, G)?;
		test(B, sNB, false, B)?;
		test(B, sNGB, false, B)?;

		Ok(())
	}

	/// Generate random binary data of a specified size.
	fn random_data(size: usize) -> Blob {
		let mut vec: Vec<u8> = Vec::new();
		vec.resize(size, 0);
		(0..size).for_each(|i| {
			vec[i] = (((i as f64 + 1.78123).cos() * 6_513_814_013_423.454).fract() * 256f64) as u8;
		});

		Blob::from(vec)
	}

	/*
	#[test]
	fn bench_brotli() -> Result<()> {
		// Generate random data.
		let data1 = random_data(131072);

		let test = |quality: i32, lgwin: i32| {
			let data = data1.clone();

			let start = Instant::now();
			let params = BrotliEncoderParams {
				quality,
				lgwin,
				size_hint: data.len(),
				..Default::default()
			};
			let mut input = Cursor::new(data.as_slice());
			let mut output: Vec<u8> = Vec::new();
			let mut input_buffer: [u8; 4096] = [0; 4096];
			let mut output_buffer: [u8; 4096] = [0; 4096];
			let alloc = StandardAlloc::default();
			BrotliCompressCustomAlloc(
				&mut input,
				&mut output,
				&mut input_buffer[..],
				&mut output_buffer[..],
				&params,
				alloc,
			)
			.unwrap();
			let time = start.elapsed().as_micros();
			let size = output.len();

			println!("{quality}\t{lgwin}\t{size}\t{time}")
		};

		for quality in 1..=11 {
			for window in 10..=22 {
				test(quality, window);
			}
		}

		Ok(())
	}
	*/
}