cab 0.6.0

Read/write Windows cabinet (CAB) files
Documentation 
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

use std::io::{Cursor, Read, Write};
use time::macros::datetime;

// ========================================================================= //

#[test]
fn cabinet_with_one_small_uncompressed_text_file() {
    let original = lipsum::lipsum(500);
    let datetime = datetime!(2063-04-05 23:14:38);

    let mut cab_builder = cab::CabinetBuilder::new();
    {
        let folder_builder =
            cab_builder.add_folder(cab::CompressionType::None);
        let file_builder = folder_builder.add_file("lorem_ipsum.txt");
        file_builder.set_datetime(datetime);
        file_builder.set_is_read_only(true);
        file_builder.set_is_system(true);
        file_builder.set_is_archive(false);
    }
    let mut cab_writer = cab_builder.build(Cursor::new(Vec::new())).unwrap();
    while let Some(mut file_writer) = cab_writer.next_file().unwrap() {
        file_writer.write_all(original.as_bytes()).unwrap();
    }
    let cab_file = cab_writer.finish().unwrap().into_inner();

    let mut cabinet = cab::Cabinet::new(Cursor::new(cab_file)).unwrap();
    {
        let file_entry = cabinet.get_file_entry("lorem_ipsum.txt").unwrap();
        assert_eq!(file_entry.datetime(), Some(datetime));
        assert!(file_entry.is_read_only());
        assert!(!file_entry.is_hidden());
        assert!(file_entry.is_system());
        assert!(!file_entry.is_archive());
    }
    let mut output = Vec::new();
    let mut file_reader = cabinet.read_file("lorem_ipsum.txt").unwrap();
    file_reader.read_to_end(&mut output).unwrap();
    assert_eq!(String::from_utf8_lossy(&output), original);
}

#[test]
fn cabinet_with_one_small_mszipped_text_file() {
    let original = lipsum::lipsum(500);

    let mut cab_builder = cab::CabinetBuilder::new();
    cab_builder
        .add_folder(cab::CompressionType::MsZip)
        .add_file("lorem_ipsum.txt");
    let mut cab_writer = cab_builder.build(Cursor::new(Vec::new())).unwrap();
    while let Some(mut file_writer) = cab_writer.next_file().unwrap() {
        file_writer.write_all(original.as_bytes()).unwrap();
    }
    let cab_file = cab_writer.finish().unwrap().into_inner();

    let mut cabinet = cab::Cabinet::new(Cursor::new(cab_file)).unwrap();
    assert_eq!(
        cabinet.folder_entries().nth(0).unwrap().compression_type(),
        cab::CompressionType::MsZip
    );
    let mut output = Vec::new();
    let mut file_reader = cabinet.read_file("lorem_ipsum.txt").unwrap();
    file_reader.read_to_end(&mut output).unwrap();
    assert_eq!(String::from_utf8_lossy(&output), original);
}

#[test]
fn cabinet_with_one_big_uncompressed_text_file() {
    let original = lipsum::lipsum(30000);

    let mut cab_builder = cab::CabinetBuilder::new();
    cab_builder
        .add_folder(cab::CompressionType::None)
        .add_file("lorem_ipsum.txt");
    let mut cab_writer = cab_builder.build(Cursor::new(Vec::new())).unwrap();
    while let Some(mut file_writer) = cab_writer.next_file().unwrap() {
        file_writer.write_all(original.as_bytes()).unwrap();
    }
    let cab_file = cab_writer.finish().unwrap().into_inner();
    assert!(cab_file.len() > original.len());

    let mut cabinet = cab::Cabinet::new(Cursor::new(cab_file)).unwrap();
    {
        let folder = cabinet.folder_entries().nth(0).unwrap();
        assert_eq!(folder.compression_type(), cab::CompressionType::None);
        assert!(folder.num_data_blocks() > 1);
        let file = folder.file_entries().nth(0).unwrap();
        assert_eq!(file.uncompressed_size() as usize, original.len());
    }
    let mut output = Vec::new();
    let mut file_reader = cabinet.read_file("lorem_ipsum.txt").unwrap();
    file_reader.read_to_end(&mut output).unwrap();
    assert_eq!(output.len(), original.len());
    assert_eq!(String::from_utf8_lossy(&output), original);
}

#[test]
fn cabinet_with_one_big_mszipped_text_file() {
    let original = lipsum::lipsum(30000);

    let mut cab_builder = cab::CabinetBuilder::new();
    cab_builder
        .add_folder(cab::CompressionType::MsZip)
        .add_file("lorem_ipsum.txt");
    let mut cab_writer = cab_builder.build(Cursor::new(Vec::new())).unwrap();
    while let Some(mut file_writer) = cab_writer.next_file().unwrap() {
        file_writer.write_all(original.as_bytes()).unwrap();
    }
    let cab_file = cab_writer.finish().unwrap().into_inner();
    assert!(cab_file.len() < original.len());

    let mut cabinet = cab::Cabinet::new(Cursor::new(cab_file)).unwrap();
    {
        let folder = cabinet.folder_entries().nth(0).unwrap();
        assert_eq!(folder.compression_type(), cab::CompressionType::MsZip);
        let file = folder.file_entries().nth(0).unwrap();
        assert_eq!(file.uncompressed_size() as usize, original.len());
    }
    let mut output = Vec::new();
    let mut file_reader = cabinet.read_file("lorem_ipsum.txt").unwrap();
    file_reader.read_to_end(&mut output).unwrap();
    assert_eq!(output.len(), original.len());
    assert_eq!(String::from_utf8_lossy(&output), original);
}

// ========================================================================= //

fn random_data_roundtrip(num_bytes: usize, ctype: cab::CompressionType) {
    use rand::{RngCore, SeedableRng};

    let mut original = vec![0; num_bytes];
    rand::rngs::SmallRng::from_entropy().fill_bytes(&mut original);

    let mut cab_builder = cab::CabinetBuilder::new();
    cab_builder.add_folder(ctype).add_file("binary");
    let mut cab_writer = cab_builder.build(Cursor::new(Vec::new())).unwrap();
    while let Some(mut file_writer) = cab_writer.next_file().unwrap() {
        file_writer.write_all(&original).unwrap();
    }
    let cab_file = cab_writer.finish().unwrap().into_inner();

    let mut cabinet = cab::Cabinet::new(Cursor::new(cab_file)).unwrap();
    {
        let folder = cabinet.folder_entries().nth(0).unwrap();
        assert_eq!(folder.compression_type(), ctype);
        assert!((folder.num_data_blocks() as usize) >= (num_bytes / 0x8000));
        let file = folder.file_entries().nth(0).unwrap();
        assert_eq!(file.name(), "binary");
        assert_eq!(file.uncompressed_size() as usize, original.len());
    }
    let mut output = Vec::<u8>::new();
    let mut file_reader = cabinet.read_file("binary").unwrap();
    file_reader.read_to_end(&mut output).unwrap();
    assert_eq!(output, original);
}

#[test]
fn cabinet_with_one_small_uncompressed_binary_file() {
    random_data_roundtrip(10_000, cab::CompressionType::None);
}

#[test]
fn cabinet_with_one_small_mszipped_binary_file() {
    random_data_roundtrip(10_000, cab::CompressionType::MsZip);
}

#[test]
fn cabinet_with_one_big_uncompressed_binary_file() {
    random_data_roundtrip(1_000_000, cab::CompressionType::None);
}

#[test]
fn cabinet_with_one_big_mszipped_binary_file() {
    random_data_roundtrip(1_000_000, cab::CompressionType::MsZip);
}

// ========================================================================= //