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
use crate::{tokens::TokenLookup, Eu4Date, Eu4Error, Eu4ErrorKind};
use jomini::{BinaryTape, BinaryToken, FailedResolveStrategy, TokenResolver};
use std::{
    collections::HashSet,
    io::{Cursor, Read, Write},
};

fn melter(
    writer: &mut Vec<u8>,
    unknown_tokens: &mut HashSet<u16>,
    tape: &BinaryTape,
    failed_resolver: FailedResolveStrategy,
    write_checksum: bool,
) -> Result<(), Eu4Error> {
    let mut depth = 0;
    let mut in_objects = Vec::new();
    let mut in_object = 1;
    let mut token_idx = 0;
    let mut known_number = false;
    let tokens = tape.tokens();

    while let Some(token) = tokens.get(token_idx) {
        let mut did_change = false;
        if in_object == 1 {
            let depth = match token {
                BinaryToken::End(_) => depth - 1,
                _ => depth,
            };

            for _ in 0..depth {
                writer.push(b' ');
            }
        }

        match token {
            BinaryToken::Object(_) => {
                did_change = true;
                writer.extend_from_slice(b"{\r\n");
                depth += 1;
                in_objects.push(in_object);
                in_object = 1;
            }
            BinaryToken::HiddenObject(_) => {
                did_change = true;
                depth += 1;
                in_objects.push(in_object);
                in_object = 1;
            }
            BinaryToken::Array(_) => {
                did_change = true;
                writer.push(b'{');
                depth += 1;
                in_objects.push(in_object);
                in_object = 0;
            }
            BinaryToken::End(x) => {
                if !matches!(tokens.get(*x), Some(BinaryToken::HiddenObject(_))) {
                    writer.push(b'}');
                }

                let obj = in_objects.pop();

                // The binary parser should already ensure that this will be something, but this is
                // just a sanity check
                debug_assert!(obj.is_some());
                in_object = obj.unwrap_or(1);
                depth -= 1;
            }
            BinaryToken::Bool(x) => match x {
                true => writer.extend_from_slice(b"yes"),
                false => writer.extend_from_slice(b"no"),
            },
            BinaryToken::U32(x) => writer.extend_from_slice(format!("{}", x).as_bytes()),
            BinaryToken::U64(x) => writer.extend_from_slice(format!("{}", x).as_bytes()),
            BinaryToken::I32(x) => {
                if known_number {
                    writer.extend_from_slice(format!("{}", x).as_bytes());
                    known_number = false;
                } else if let Some(date) = Eu4Date::from_binary(*x) {
                    writer.extend_from_slice(date.game_fmt().as_bytes());
                } else {
                    writer.extend_from_slice(format!("{}", x).as_bytes());
                }
            }
            BinaryToken::Quoted(x) => {
                let data = x.view_data();
                let end_idx = match data.last() {
                    Some(x) if *x == b'\n' => data.len() - 1,
                    Some(_x) => data.len(),
                    None => data.len(),
                };

                // quoted fields occuring as keys should remain unquoted
                if in_object == 1 {
                    writer.extend_from_slice(&data[..end_idx]);
                } else {
                    writer.push(b'"');
                    writer.extend_from_slice(&data[..end_idx]);
                    writer.push(b'"');
                }
            }
            BinaryToken::Unquoted(x) => {
                let data = x.view_data();
                writer.extend_from_slice(&data);
            }
            BinaryToken::F32_1(x) => write!(writer, "{}", x).map_err(Eu4ErrorKind::IoErr)?,
            BinaryToken::F32_2(x) => write!(writer, "{}", x).map_err(Eu4ErrorKind::IoErr)?,
            BinaryToken::Token(x) => match TokenLookup.resolve(*x) {
                Some(id)
                    if (id == "is_ironman" || (id == "checksum" && !write_checksum))
                        && in_object == 1 =>
                {
                    let skip = tokens
                        .get(token_idx + 1)
                        .map(|next_token| match next_token {
                            BinaryToken::Object(end) => end + 1,
                            BinaryToken::Array(end) => end + 1,
                            _ => token_idx + 2,
                        })
                        .unwrap_or(token_idx + 1);

                    token_idx = skip;
                    continue;
                }
                Some(id) => {
                    // There are certain tokens that we know are integers and will dupe the date heuristic
                    known_number = in_object == 1 && (id == "random" || id.ends_with("seed"));
                    writer.extend_from_slice(&id.as_bytes())
                }
                None => {
                    unknown_tokens.insert(*x);
                    match failed_resolver {
                        FailedResolveStrategy::Error => {
                            return Err(Eu4ErrorKind::UnknownToken { token_id: *x }.into());
                        }
                        FailedResolveStrategy::Ignore if in_object == 1 => {
                            let skip = tokens
                                .get(token_idx + 1)
                                .map(|next_token| match next_token {
                                    BinaryToken::Object(end) => end + 1,
                                    BinaryToken::Array(end) => end + 1,
                                    _ => token_idx + 2,
                                })
                                .unwrap_or(token_idx + 1);

                            token_idx = skip;
                            continue;
                        }
                        _ => {
                            let unknown = format!("__unknown_0x{:x}", x);
                            writer.extend_from_slice(unknown.as_bytes());
                        }
                    }
                }
            },
            BinaryToken::Rgb(color) => {
                writer.extend_from_slice(b"rgb {");
                writer.extend_from_slice(format!("{} ", color.r).as_bytes());
                writer.extend_from_slice(format!("{} ", color.g).as_bytes());
                writer.extend_from_slice(format!("{}", color.b).as_bytes());
                writer.push(b'}');
            }
        }

        if !did_change && in_object == 1 {
            writer.push(b'=');
            in_object = 2;
        } else if in_object == 2 {
            in_object = 1;
            writer.push(b'\r');
            writer.push(b'\n');
        } else if in_object != 1 {
            writer.push(b' ');
        }

        token_idx += 1;
    }

    Ok(())
}

fn melt_zip(
    mut out: &mut Vec<u8>,
    unknown_tokens: &mut HashSet<u16>,
    zip_data: &[u8],
    failed_resolver: FailedResolveStrategy,
) -> Result<(), Eu4Error> {
    let mut inflated_data = Vec::new();

    let zip_reader = Cursor::new(&zip_data);
    let mut zip = zip::ZipArchive::new(zip_reader).map_err(Eu4ErrorKind::ZipCentralDirectory)?;

    // Pre-allocate enough data in the inflated data based on the uncompressed size of the ironman
    // data
    let size = zip
        .by_name("gamestate")
        .map_err(|e| Eu4ErrorKind::ZipMissingEntry("gamestate", e))
        .map(|x| x.size())?;
    out.reserve((size as usize) * 2);

    for file in &["meta", "gamestate", "ai"] {
        inflated_data.clear();
        let mut zip_file = zip
            .by_name(file)
            .map_err(|e| Eu4ErrorKind::ZipMissingEntry(file, e))?;

        zip_file
            .read_to_end(&mut inflated_data)
            .map_err(|e| Eu4ErrorKind::ZipExtraction(file, e))?;

        let tape = BinaryTape::from_eu4(&inflated_data["EU4bin".len()..]).map_err(|e| {
            Eu4ErrorKind::Deserialize {
                part: Some(file.to_string()),
                err: e,
            }
        })?;

        let write_checksum = file == &"ai";
        melter(
            &mut out,
            unknown_tokens,
            &tape,
            failed_resolver,
            write_checksum,
        )?;
    }

    Ok(())
}

/// Convert ironman data to plaintext
pub fn melt(
    data: &[u8],
    failed_resolver: FailedResolveStrategy,
) -> Result<(Vec<u8>, HashSet<u16>), Eu4Error> {
    let mut out: Vec<u8> = b"EU4txt\r\n".to_vec();
    let mut unknown_tokens = HashSet::new();

    let is_zip = data
        .get(..4)
        .map_or(false, |x| x == &[0x50, 0x4b, 0x03, 0x04][..]);

    if is_zip {
        melt_zip(&mut out, &mut unknown_tokens, &data, failed_resolver)?;
    } else {
        out.reserve(data.len() * 2);
        let cut_header_len = if data
            .get(..b"EU4bin".len())
            .map_or(false, |x| x == &b"EU4bin"[..])
        {
            "EU4bin".len()
        } else {
            0
        };
        let tape = BinaryTape::from_eu4(&data[cut_header_len..])?;
        melter(&mut out, &mut unknown_tokens, &tape, failed_resolver, true)?;
    }

    Ok((out, unknown_tokens))
}

#[cfg(all(test, ironman_tokens))]
mod tests {
    use super::*;

    #[test]
    fn test_short_input_regression() {
        // Make sure it doesn't crash
        let _ = melt(&[], FailedResolveStrategy::Error);
    }

    #[test]
    fn test_rgb_regression() {
        let data = [
            45, 2, 1, 0, 1, 137, 1, 45, 1, 0, 67, 2, 0, 255, 255, 255, 255, 226, 2, 1, 0, 1, 137,
            1, 45, 1, 56, 226, 1, 255, 255, 255, 255, 255,
        ];
        let _ = melt(&data, FailedResolveStrategy::Ignore);
    }

    #[test]
    fn test_ironman_nonscalar() {
        let data = [137, 53, 3, 0, 4, 0];
        let expected = b"EU4txt\r\n";
        let out = melt(&data[..], FailedResolveStrategy::Error).unwrap();
        assert_eq!(out, &expected[..]);
    }

    #[test]
    fn test_melt_meta() {
        let meta = include_bytes!("../tests/fixtures/meta.bin");
        let expected = include_bytes!("../tests/fixtures/meta.bin.melted");
        let out = melt(&meta[..], FailedResolveStrategy::Error).unwrap();
        assert_eq!(out, &expected[..]);
    }

    #[test]
    fn test_melt_skip_ironman() {
        let data = [
            0x45, 0x55, 0x34, 0x62, 0x69, 0x6e, 0x4d, 0x28, 0x01, 0x00, 0x0c, 0x00, 0x70, 0x98,
            0x8d, 0x03, 0x89, 0x35, 0x01, 0x00, 0x0e, 0x00, 0x01, 0x38, 0x2a, 0x01, 0x00, 0x0f,
            0x00, 0x03, 0x00, 0x42, 0x48, 0x41,
        ];

        let expected = b"EU4txt\r\ndate=1804.12.09\r\nplayer=\"BHA\"\r\n";
        let out = melt(&data[..], FailedResolveStrategy::Error).unwrap();
        assert_eq!(out, &expected[..]);
    }

    #[test]
    fn test_skip_quoting_keys() {
        let mut data = vec![];
        data.extend_from_slice(b"EU4bin");
        data.extend_from_slice(&[0xcc, 0x29, 0x01, 0x00, 0x03, 0x00, 0x0f, 0x00, 0x11, 0x00]);
        data.extend_from_slice(b"schools_initiated");
        data.extend_from_slice(&[0x01, 0x00, 0x0f, 0x00, 0x0b, 0x00]);
        data.extend_from_slice(b"1444.11.11\n");
        data.extend_from_slice(&0x0004u16.to_le_bytes());

        let expected = b"EU4txt\r\nflags={\r\n schools_initiated=\"1444.11.11\"\r\n}\r\n";
        let out = melt(&data[..], FailedResolveStrategy::Error).unwrap();
        assert_eq!(out, &expected[..]);
    }

    #[test]
    fn test_melt_skip_unknown_key() {
        let data = [
            0x45, 0x55, 0x34, 0x62, 0x69, 0x6e, 0xff, 0xff, 0x01, 0x00, 0x0c, 0x00, 0x70, 0x98,
            0x8d, 0x03, 0x89, 0x35, 0x01, 0x00, 0x0e, 0x00, 0x01, 0x38, 0x2a, 0x01, 0x00, 0x0f,
            0x00, 0x03, 0x00, 0x42, 0x48, 0x41,
        ];

        let expected = b"EU4txt\r\nplayer=\"BHA\"\r\n";
        let out = melt(&data[..], FailedResolveStrategy::Ignore).unwrap();
        assert_eq!(out, &expected[..]);
    }

    #[test]
    fn test_melt_skip_unknown_value() {
        let data = [
            0x45, 0x55, 0x34, 0x62, 0x69, 0x6e, 0x4d, 0x28, 0x01, 0x00, 0xff, 0xff, 0x89, 0x35,
            0x01, 0x00, 0x0e, 0x00, 0x01, 0x38, 0x2a, 0x01, 0x00, 0x0f, 0x00, 0x03, 0x00, 0x42,
            0x48, 0x41,
        ];

        let expected = b"EU4txt\r\ndate=__unknown_0xffff\r\nplayer=\"BHA\"\r\n";
        let out = melt(&data[..], FailedResolveStrategy::Ignore).unwrap();
        assert_eq!(out, &expected[..]);
    }
}