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
use crate::{CPXVersion, CampaignHeader, ScenarioMeta};
use byteorder::{ReadBytesExt, LE};
use chardet::detect as detect_encoding;
use encoding_rs::Encoding;
use genie_scx::{self as scx, Scenario};
use std::io::{self, Cursor, Read, Seek, SeekFrom};
#[derive(Debug, thiserror::Error)]
pub enum ReadCampaignError {
#[error("invalid string")]
DecodeStringError,
#[error("{}", .0)]
IoError(#[from] io::Error),
#[error("campaign or scenario must have a name")]
MissingNameError,
#[error("scenario not fonud in campaign")]
NotFoundError,
#[error("{}", .0)]
ParseSCXError(#[from] scx::Error),
}
type Result<T> = std::result::Result<T, ReadCampaignError>;
fn decode_str(bytes: &[u8]) -> Result<String> {
if bytes.is_empty() {
return Ok("".to_string());
}
let (encoding_name, _confidence, _language) = detect_encoding(&bytes);
Encoding::for_label(encoding_name.as_bytes())
.ok_or(ReadCampaignError::DecodeStringError)
.and_then(|encoding| {
let (decoded, _enc, failed) = encoding.decode(&bytes);
if failed {
return Err(ReadCampaignError::DecodeStringError);
}
Ok(decoded.to_string())
})
}
pub fn read_fixed_str<R: Read>(input: &mut R, len: usize) -> Result<Option<String>> {
let mut bytes = vec![0; len];
input.read_exact(&mut bytes[0..len])?;
if let Some(end) = bytes.iter().position(|&byte| byte == 0) {
bytes.truncate(end);
}
if bytes.is_empty() {
Ok(None)
} else {
decode_str(&bytes).map(Some)
}
}
fn read_variable_str<R: Read>(input: &mut R) -> Result<Option<String>> {
let open = input.read_u16::<LE>()?;
if open != 0x0A60 {
return Err(ReadCampaignError::DecodeStringError);
}
let len = input.read_u16::<LE>()? as usize;
let mut bytes = vec![0; len];
input.read_exact(&mut bytes[0..len])?;
decode_str(&bytes).map(Some)
}
fn read_campaign_header<R: Read>(input: &mut R) -> Result<CampaignHeader> {
let mut version = [0; 4];
input.read_exact(&mut version)?;
let (name, num_scenarios) = if version == *b"1.10" {
let num_scenarios = input.read_i32::<LE>()? as usize;
(
read_variable_str(input)?.ok_or(ReadCampaignError::MissingNameError)?,
num_scenarios,
)
} else {
(
read_fixed_str(input, 256)?.ok_or(ReadCampaignError::MissingNameError)?,
input.read_i32::<LE>()? as usize,
)
};
Ok(CampaignHeader {
version,
name,
num_scenarios,
})
}
fn read_scenario_meta_de<R: Read>(input: &mut R) -> Result<ScenarioMeta> {
let size = input.read_u64::<LE>()? as usize;
let offset = input.read_u64::<LE>()? as usize;
let name = read_variable_str(input)?.ok_or(ReadCampaignError::MissingNameError)?;
let filename = read_variable_str(input)?.ok_or(ReadCampaignError::MissingNameError)?;
Ok(ScenarioMeta {
size,
offset,
name,
filename,
})
}
fn read_scenario_meta<R: Read>(input: &mut R) -> Result<ScenarioMeta> {
let size = input.read_i32::<LE>()? as usize;
let offset = input.read_i32::<LE>()? as usize;
let name = read_fixed_str(input, 255)?.ok_or(ReadCampaignError::MissingNameError)?;
let filename = read_fixed_str(input, 255)?.ok_or(ReadCampaignError::MissingNameError)?;
let mut padding = [0; 2];
input.read_exact(&mut padding)?;
Ok(ScenarioMeta {
size,
offset,
name,
filename,
})
}
#[derive(Debug, Clone)]
pub struct Campaign<R>
where
R: Read + Seek,
{
reader: R,
header: CampaignHeader,
entries: Vec<ScenarioMeta>,
}
impl<R> Campaign<R>
where
R: Read + Seek,
{
pub fn from(mut input: R) -> Result<Self> {
let header = read_campaign_header(&mut input)?;
let mut entries = vec![];
let read_entry = if header.version == *b"1.10" {
read_scenario_meta_de
} else {
read_scenario_meta
};
for _ in 0..header.num_scenarios {
entries.push(dbg!(read_entry(&mut input)?));
}
Ok(Self {
reader: input,
header,
entries,
})
}
pub fn into_inner(self) -> R {
self.reader
}
pub fn version(&self) -> CPXVersion {
self.header.version
}
pub fn name(&self) -> &str {
&self.header.name
}
pub fn entries(&self) -> impl Iterator<Item = &ScenarioMeta> {
self.entries.iter()
}
pub fn len(&self) -> usize {
self.entries.len()
}
pub fn is_empty(&self) -> bool {
self.entries.is_empty()
}
pub fn get_name(&self, id: usize) -> Option<&str> {
self.entries.get(id).map(|entry| entry.name.as_ref())
}
pub fn get_filename(&self, id: usize) -> Option<&str> {
self.entries.get(id).map(|entry| entry.filename.as_ref())
}
fn get_id(&self, filename: &str) -> Option<usize> {
self.entries
.iter()
.position(|entry| entry.filename == filename)
}
pub fn by_name(&mut self, filename: &str) -> Result<Scenario> {
self.by_name_raw(filename)
.map(Cursor::new)
.and_then(|buf| Scenario::read_from(buf).map_err(ReadCampaignError::ParseSCXError))
}
pub fn by_index(&mut self, index: usize) -> Result<Scenario> {
self.by_index_raw(index)
.map(Cursor::new)
.and_then(|buf| Scenario::read_from(buf).map_err(ReadCampaignError::ParseSCXError))
}
pub fn by_name_raw(&mut self, filename: &str) -> Result<Vec<u8>> {
self.get_id(filename)
.ok_or(ReadCampaignError::NotFoundError)
.and_then(|index| self.by_index_raw(index))
}
pub fn by_index_raw(&mut self, index: usize) -> Result<Vec<u8>> {
let entry = match self.entries.get(index) {
Some(entry) => entry,
None => return Err(ReadCampaignError::NotFoundError),
};
let mut result = vec![];
self.reader.seek(SeekFrom::Start(entry.offset as u64))?;
self.reader
.by_ref()
.take(entry.size as u64)
.read_to_end(&mut result)?;
Ok(result)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{AOE1_DE, AOE_AOK};
use anyhow::Context;
use std::fs::File;
#[test]
fn detect_encoding() -> anyhow::Result<()> {
let f = File::open("./test/campaigns/DER FALL VON SACSAHUAMAN - TEIL I.cpx")?;
let cpx = Campaign::from(f)?;
assert_eq!(cpx.version(), AOE_AOK);
assert_eq!(cpx.name(), "DER FALL VON SACSAHUAMÁN - TEIL I");
assert_eq!(cpx.len(), 1);
let names: Vec<_> = cpx.entries().map(|e| &e.name).collect();
assert_eq!(names, vec!["Der Weg nach Sacsahuamán"]);
let filenames: Vec<_> = cpx.entries().map(|e| &e.filename).collect();
assert_eq!(filenames, vec!["Der Weg nach Sacsahuamán.scx"]);
Ok(())
}
#[test]
fn aoe1_trial_cpn() -> anyhow::Result<()> {
let f = File::open("test/campaigns/Armies at War A Combat Showcase.cpn")?;
let mut c = Campaign::from(f).context("could not read meta")?;
assert_eq!(c.version(), AOE_AOK);
assert_eq!(c.name(), "Armies at War, A Combat Showcase");
assert_eq!(c.len(), 1);
let names: Vec<_> = c.entries().map(|e| &e.name).collect();
assert_eq!(names, vec!["Bronze Age Art of War"]);
let filenames: Vec<_> = c.entries().map(|e| &e.filename).collect();
assert_eq!(filenames, vec!["Bronze Age Art of War.scn"]);
c.by_index_raw(0).context("could not read raw file")?;
c.by_name_raw("Bronze Age Art of War.scn")
.context("could not read raw file")?;
Ok(())
}
#[test]
fn aoe1_beta_cpn() -> anyhow::Result<()> {
let f = File::open("test/campaigns/Rise of Egypt Learning Campaign.cpn")?;
let c = Campaign::from(f).context("could not read meta")?;
assert_eq!(c.version(), AOE_AOK);
assert_eq!(c.name(), "Rise of Egypt Learning Campaign");
assert_eq!(c.len(), 12);
let filenames: Vec<_> = c.entries().map(|e| &e.filename).collect();
assert_eq!(
filenames,
vec![
"HUNTING.scn",
"FORAGING.scn",
"Discoveries.scn",
"Dawn of a New Age.scn",
"SKIRMISH.scn",
"Lands Unknown.scn",
"FARMING.scn",
"TRADE.scn",
"CRUSADE.scn",
"Establish a Second Colony.scn",
"Naval Battle.scn",
"Siege Battle.scn",
]
);
Ok(())
}
#[test]
fn aoe_de() -> anyhow::Result<()> {
let f = File::open("test/campaigns/10 The First Punic War.aoecpn")?;
let c = Campaign::from(f)?;
assert_eq!(c.version(), AOE1_DE);
assert_eq!(c.name(), "10 The First Punic War");
assert_eq!(c.len(), 3);
let filenames: Vec<_> = c.entries().map(|e| &e.filename).collect();
assert_eq!(
filenames,
vec![
"Scxt1-01-The Battle of Agrigentum.aoescn",
"Scxt1-02-The Battle of Mylae.aoescn",
"Scxt1-03-The Battle of Tunis.aoescn",
]
);
Ok(())
}
}