oj_serdes 0.4.0

Serializable API types for OpenJam servers
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
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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
use serde::{Serialize, Deserialize};
use quick_xml::{reader::Reader, writer::Writer, errors::Result as XmlResult};

const SERVERS_TAG: &str = "servers";
const SERVERS_TAG_B: &[u8] = b"servers";

const SETTING_TAG: &str = "setting";
const SETTING_TAG_B: &[u8] = b"setting";

const NAME_ATTR: &str = "name";
const NAME_ATTR_B: &[u8] = b"name";

const CURRENT_GROUP_TAG: &str = "currentgroup";
const CURRENT_GROUP_TAG_B: &[u8] = b"currentgroup";

const CURRENT_SKU_TAG: &str = "currentsku";
const CURRENT_SKU_TAG_B: &[u8] = b"currentsku";

//#[derive(Serialize, Deserialize, Clone, Debug)]
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct RobocraftServers {
    //#[serde(rename = "currentgroup")]
    pub current_group: String,
    //#[serde(rename = "currentsku")]
    pub current_sku: String,
    //#[serde(flatten)]
    pub skus: std::collections::HashMap<String, RobocraftSku>,
}

impl RobocraftServers {
    pub fn from_str(s: &str) -> XmlResult<Self> {
        let mut current_group = None;
        let mut current_sku = None;
        let mut skus = std::collections::HashMap::new();
        let mut reader = Reader::from_str(s);
        reader.config_mut().trim_text(true);
        if let quick_xml::events::Event::Start(e) = reader.read_event()? {
            if e.name().0 != SERVERS_TAG_B {
                return Err(quick_xml::Error::IllFormed(quick_xml::errors::IllFormedError::MismatchedEndTag {
                    expected: SERVERS_TAG.to_owned(),
                    found: String::from_utf8_lossy(e.name().0).to_string(),
                }));
            }
        } else {
            return Err(quick_xml::Error::IllFormed(quick_xml::errors::IllFormedError::MismatchedEndTag {
                expected: SERVERS_TAG.to_owned(),
                found: "".to_owned(),
            }));
        }
        loop {
            match reader.read_event()? {
                quick_xml::events::Event::Start(e) => {
                    match e.name().0 {
                        CURRENT_GROUP_TAG_B => {
                            let text = reader.read_text(e.name())?;
                            current_group = Some(text.to_string());
                        },
                        CURRENT_SKU_TAG_B => {
                            let text = reader.read_text(e.name())?;
                            current_sku = Some(text.to_string());
                        },
                        _ => {
                            let sku = RobocraftSku::from_reader(&mut reader, e.name())?;
                            skus.insert(String::from_utf8_lossy(e.name().0).to_string(), sku);
                        }
                    }
                },
                quick_xml::events::Event::End(e) => {
                    if e.name().0 == SERVERS_TAG_B { break; }
                },
                //quick_xml::events::Event::Text(e) => txt.push(e.decode().unwrap().into_owned()),
                quick_xml::events::Event::Eof => {
                    break;
                },
                _ => {},
            }
        }
        if current_group.is_none() {
            return Err(quick_xml::Error::IllFormed(quick_xml::errors::IllFormedError::MismatchedEndTag {
                expected: CURRENT_GROUP_TAG.to_owned(),
                found: "".to_owned(),
            }));
        }
        if current_sku.is_none() {
            return Err(quick_xml::Error::IllFormed(quick_xml::errors::IllFormedError::MismatchedEndTag {
                expected: CURRENT_SKU_TAG.to_owned(),
                found: "".to_owned(),
            }));
        }
        Ok(Self {
            current_group: current_group.unwrap(),
            current_sku: current_sku.unwrap(),
            skus,
        })
    }

    pub fn to_writer<W: std::io::Write>(&self, writer: &mut Writer<W>) -> XmlResult<()> {
        writer.write_event(quick_xml::events::Event::Start(quick_xml::events::BytesStart::new(SERVERS_TAG)))?;
        writer.write_event(quick_xml::events::Event::Start(quick_xml::events::BytesStart::new(CURRENT_GROUP_TAG)))?;
        writer.write_event(quick_xml::events::Event::Text(quick_xml::events::BytesText::new(&self.current_group)))?;
        writer.write_event(quick_xml::events::Event::End(quick_xml::events::BytesEnd::new(CURRENT_GROUP_TAG)))?;
        writer.write_event(quick_xml::events::Event::Start(quick_xml::events::BytesStart::new(CURRENT_SKU_TAG)))?;
        writer.write_event(quick_xml::events::Event::Text(quick_xml::events::BytesText::new(&self.current_sku)))?;
        writer.write_event(quick_xml::events::Event::End(quick_xml::events::BytesEnd::new(CURRENT_SKU_TAG)))?;
        //let mut sorted_skus: Vec<_> = self.skus.keys().collect();
        //sorted_skus.sort_by_key(|s| s.to_lowercase());
        //for name in sorted_skus {
        //    let sku = self.skus.get(name).unwrap();
        for (name, sku) in self.skus.iter() {
            writer.write_event(quick_xml::events::Event::Start(quick_xml::events::BytesStart::new(name)))?;
            sku.to_writer(writer)?;
            writer.write_event(quick_xml::events::Event::End(quick_xml::events::BytesEnd::new(name)))?;
        }
        writer.write_event(quick_xml::events::Event::End(quick_xml::events::BytesEnd::new(SERVERS_TAG)))?;
        Ok(())
    }

    pub fn as_xml_str(&self, indent: usize) -> XmlResult<String> {
        let mut buf = Vec::new();
        let mut writer = if indent != 0 {
            Writer::new_with_indent(&mut buf, ' ' as u8, indent)
        } else {
            Writer::new(&mut buf)
        };
        self.to_writer(&mut writer)?;
        Ok(String::from_utf8_lossy(&buf).into())
    }
}

//#[derive(Serialize, Deserialize, Clone, Debug)]
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct RobocraftSku {
    //#[serde(flatten)]
    pub groups: std::collections::HashMap<String, GroupConfig>,
}

impl RobocraftSku {
    fn from_reader(reader: &mut Reader<&[u8]>, until: quick_xml::name::QName<'_>) -> XmlResult<Self> {
        let mut groups = std::collections::HashMap::new();
        loop {
            match reader.read_event()? {
                quick_xml::events::Event::Start(e) => {
                    let group = GroupConfig::from_reader(reader, e.name())?;
                    groups.insert(String::from_utf8_lossy(e.name().0).to_string(), group);
                },
                quick_xml::events::Event::End(e) => {
                    if e.name().0 == until.0 { break; }
                },
                quick_xml::events::Event::Eof => {
                    break;
                },
                _ => {},
            }
        }
        Ok(Self {
            groups,
        })
    }

    fn to_writer<W: std::io::Write>(&self, writer: &mut Writer<W>) -> XmlResult<()> {
        for (name, group) in self.groups.iter() {
            writer.write_event(quick_xml::events::Event::Start(quick_xml::events::BytesStart::new(name)))?;
            group.to_writer(writer)?;
            writer.write_event(quick_xml::events::Event::End(quick_xml::events::BytesEnd::new(name)))?;
        }
        Ok(())
    }
}

//#[derive(Serialize, Deserialize, Clone, Debug)]
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct RobocraftRoyaleServers {
    //#[serde(rename = "currentgroup")]
    pub current_group: String,
    //#[serde(flatten)]
    pub groups: std::collections::HashMap<String, GroupConfig>,
}

impl RobocraftRoyaleServers {
    pub fn from_str(s: &str) -> XmlResult<Self> {
        let mut current_group = None;
        let mut groups = std::collections::HashMap::new();
        let mut reader = Reader::from_str(s);
        reader.config_mut().trim_text(true);
        if let quick_xml::events::Event::Start(e) = reader.read_event()? {
            if e.name().0 != SERVERS_TAG_B {
                return Err(quick_xml::Error::IllFormed(quick_xml::errors::IllFormedError::MismatchedEndTag {
                    expected: SERVERS_TAG.to_owned(),
                    found: String::from_utf8_lossy(e.name().0).to_string(),
                }));
            }
        } else {
            return Err(quick_xml::Error::IllFormed(quick_xml::errors::IllFormedError::MismatchedEndTag {
                expected: SERVERS_TAG.to_owned(),
                found: "".to_owned(),
            }));
        }
        loop {
            match reader.read_event()? {
                quick_xml::events::Event::Start(e) => {
                    match e.name().0 {
                        CURRENT_GROUP_TAG_B => {
                            let text = reader.read_text(e.name())?;
                            current_group = Some(text.to_string());
                        },
                        _ => {
                            let group = GroupConfig::from_reader(&mut reader, e.name())?;
                            groups.insert(String::from_utf8_lossy(e.name().0).to_string(), group);
                        }
                    }
                },
                quick_xml::events::Event::End(e) => {
                    if e.name().0 == SERVERS_TAG_B { break; }
                },
                quick_xml::events::Event::Eof => {
                    break;
                },
                _ => {},
            }
        }
        if current_group.is_none() {
            return Err(quick_xml::Error::IllFormed(quick_xml::errors::IllFormedError::MismatchedEndTag {
                expected: CURRENT_GROUP_TAG.to_owned(),
                found: "".to_owned(),
            }));
        }
        Ok(Self {
            current_group: current_group.unwrap(),
            groups,
        })
    }

    pub fn to_writer<W: std::io::Write>(&self, writer: &mut Writer<W>) -> XmlResult<()> {
        writer.write_event(quick_xml::events::Event::Start(quick_xml::events::BytesStart::new(SERVERS_TAG)))?;
        writer.write_event(quick_xml::events::Event::Start(quick_xml::events::BytesStart::new(CURRENT_GROUP_TAG)))?;
        writer.write_event(quick_xml::events::Event::Text(quick_xml::events::BytesText::new(&self.current_group)))?;
        writer.write_event(quick_xml::events::Event::End(quick_xml::events::BytesEnd::new(CURRENT_GROUP_TAG)))?;
        //let mut sorted_groups: Vec<_> = self.groups.keys().collect();
        //sorted_groups.sort_by_key(|s| s.to_lowercase());
        //for name in sorted_groups {
        //    let group = self.groups.get(name).unwrap();
        for (name, group) in self.groups.iter() {
            writer.write_event(quick_xml::events::Event::Start(quick_xml::events::BytesStart::new(name)))?;
            group.to_writer(writer)?;
            writer.write_event(quick_xml::events::Event::End(quick_xml::events::BytesEnd::new(name)))?;
        }
        writer.write_event(quick_xml::events::Event::End(quick_xml::events::BytesEnd::new(SERVERS_TAG)))?;
        Ok(())
    }

    pub fn as_xml_str(&self, indent: usize) -> XmlResult<String> {
        let mut buf = Vec::new();
        let mut writer = if indent != 0 {
            Writer::new_with_indent(&mut buf, ' ' as u8, indent)
        } else {
            Writer::new(&mut buf)
        };
        self.to_writer(&mut writer)?;
        Ok(String::from_utf8_lossy(&buf).into())
    }
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct GroupConfig {
    #[serde(rename = "setting")]
    pub settings: Vec<GroupSetting>,
}

impl GroupConfig {
    fn from_reader(reader: &mut Reader<&[u8]>, until: quick_xml::name::QName<'_>) -> XmlResult<Self> {
        let mut settings = Vec::new();
        loop {
            match reader.read_event()? {
                quick_xml::events::Event::Start(e) => {
                    if e.name().0 == SETTING_TAG_B {
                        let group = GroupSetting::from_reader(reader, e)?;
                        settings.push(group);
                    } else {
                        return Err(quick_xml::Error::IllFormed(quick_xml::errors::IllFormedError::MismatchedEndTag {
                            expected: SETTING_TAG.to_owned(),
                            found: String::from_utf8_lossy(e.name().0).to_string(),
                        }));
                    }
                },
                quick_xml::events::Event::End(e) => {
                    if e.name().0 == until.0 { break; }
                },
                quick_xml::events::Event::Eof => {
                    break;
                },
                _ => {},
            }
        }
        Ok(Self {
            settings,
        })
    }

    fn to_writer<W: std::io::Write>(&self, writer: &mut Writer<W>) -> XmlResult<()> {
        //let mut settings = self.settings.clone();
        //settings.sort_by_key(|s| s.name.to_lowercase());
        //for setting in settings {
        for setting in self.settings.iter() {
            setting.to_writer(writer)?;
        }
        Ok(())
    }
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct GroupSetting {
    #[serde(rename = "@name")]
    pub name: String,
    #[serde(rename = "#text")]
    pub content: String,
}

impl GroupSetting {
    fn from_reader(reader: &mut Reader<&[u8]>, start: quick_xml::events::BytesStart<'_>) -> XmlResult<Self> {
        if let quick_xml::events::Event::Text(t) = reader.read_event()? {
            if let quick_xml::events::Event::End(_e) = reader.read_event()? {
                if let Some(name) = start.try_get_attribute(NAME_ATTR_B)? {
                    Ok(Self {
                        name: String::from_utf8_lossy(&name.value).to_string(),
                        content: String::from_utf8_lossy(&t).to_string(),
                    })
                } else {
                    Err(quick_xml::errors::Error::InvalidAttr(quick_xml::events::attributes::AttrError::ExpectedValue(0)))
                }
            } else {
                Err(quick_xml::errors::Error::InvalidAttr(quick_xml::events::attributes::AttrError::ExpectedValue(0)))
            }
        } else {
            Err(quick_xml::errors::Error::InvalidAttr(quick_xml::events::attributes::AttrError::ExpectedValue(0)))
        }
    }

    fn to_writer<W: std::io::Write>(&self, writer: &mut Writer<W>) -> XmlResult<()> {
        let start = quick_xml::events::BytesStart::new(SETTING_TAG)
            .with_attributes([
                (NAME_ATTR, &self.name as &str),
            ]);
        writer.write_event(quick_xml::events::Event::Start(start))?;
        writer.write_event(quick_xml::events::Event::Text(quick_xml::events::BytesText::new(&self.content)))?;
        writer.write_event(quick_xml::events::Event::End(quick_xml::events::BytesEnd::new(SETTING_TAG)))?;
        Ok(())
    }
}

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

    const RCR_CONFIG: &str = r#"<servers>
    <currentgroup>ngram</currentgroup>
    <dev>
        <setting name="WebServicesServerAddress">127.0.0.1:4532</setting>
        <setting name="WebServicesServerAddress__note__forwardedTo">127.0.0.1:4533</setting>
        <setting name="SocialServerAddress">127.0.0.1:4534</setting>
        <setting name="SocialServerAddress__note__forwardedTo">127.0.0.1:4535</setting>
        <setting name="ChatServerAddress">127.0.0.1:4536</setting>
        <setting name="ChatServerAddress__note__forwardedTo">127.0.0.1:4537</setting>
        <setting name="SinglePlayerServerAddress">127.0.0.1:4538</setting>
        <setting name="SinglePlayerServerAddress__note__forwardedTo">127.0.0.1:4539</setting>
        <setting name="LobbyServerAddress">127.0.0.1:4540</setting>
        <setting name="LobbyServerAddress__note__forwardedTo">127.0.0.1:4541</setting>
        <setting name="authUrl">http://127.0.0.1:8001/</setting>
        <setting name="S3URL">http://127.0.0.1:8010/royalejson/data.json</setting>
        <setting name="UserMode">Dev</setting>
    </dev>
    <ngram>
        <setting name="WebServicesServerAddress">ws.services.rcr.ngram.ca:4632</setting>
        <setting name="WebServicesServerAddress__note__forwardedTo">:4633</setting>
        <setting name="LobbyServerAddress">lobby.services.rcr.ngram.ca:4640</setting>
        <setting name="LobbyServerAddress__note__forwardedTo">:4641</setting>
        <setting name="authUrl">https://auth.rcr.ngram.ca/</setting>
        <setting name="S3URL">https://static.rcr.ngram.ca/royalejson/data.json</setting>
        <setting name="Payment__note__notUsedHere">https://pay.rcr.ngram.ca/</setting>
        <setting name="Multiplayer__note__notUsedHere">mp.rcr.ngram.ca:4642</setting>
        <setting name="UserMode">Dev</setting>
    </ngram>
    <mynewgroup>
        <setting name="WebServicesServerAddress">domain_or_ip_address:4532</setting>
        <setting name="WebServicesServerAddress__note__forwardedTo">:4533</setting>
        <setting name="LobbyServerAddress">domain_or_ip_address:4540</setting>
        <setting name="LobbyServerAddress__note__forwardedTo">:4541</setting>
        <setting name="authUrl">http://domain_or_ip_address:8001/</setting>
        <setting name="S3URL">http://domain_or_ip_address:8010/royalejson/data.json</setting>
        <setting name="Multiplayer__note__notUsedHere">domain_or_ip_address:4542</setting>
    </mynewgroup>
</servers>
"#;

    const RC_CONFIG: &str = r#"<servers>
    <currentgroup>ngram</currentgroup>
    <currentsku>robocraft</currentsku>
    <robocraft>
        <dev>
            <setting name="WebServicesServerAddress">127.0.0.1:4532</setting>
            <setting name="WebServicesServerAddress__note__forwardedTo">127.0.0.1:4533</setting>
            <setting name="SocialServerAddress">127.0.0.1:4534</setting>
            <setting name="SocialServerAddress__note__forwardedTo">127.0.0.1:4535</setting>
            <setting name="ChatServerAddress">127.0.0.1:4536</setting>
            <setting name="ChatServerAddress__note__forwardedTo">127.0.0.1:4537</setting>
            <setting name="SinglePlayerServerAddress">127.0.0.1:4538</setting>
            <setting name="SinglePlayerServerAddress__note__forwardedTo">127.0.0.1:4539</setting>
            <setting name="LobbyServerAddress">127.0.0.1:4540</setting>
            <setting name="LobbyServerAddress__note__forwardedTo">127.0.0.1:4541</setting>
            <setting name="authUrl">http://127.0.0.1:8001/</setting>
            <setting name="S3URL">http://127.0.0.1:8010/live/data.json</setting>
        </dev>
        <ngram>
            <setting name="WebServicesServerAddress">ws.services.rc.ngram.ca:4532</setting>
            <setting name="WebServicesServerAddress__note__forwardedTo">:4533</setting>
            <setting name="SocialServerAddress">s.services.rc.ngram.ca:4534</setting>
            <setting name="SocialServerAddress__note__forwardedTo">:4535</setting>
            <setting name="ChatServerAddress">c.services.rc.ngram.ca:4536</setting>
            <setting name="ChatServerAddress__note__forwardedTo">:4537</setting>
            <setting name="SinglePlayerServerAddress">sp.services.rc.ngram.ca:4538</setting>
            <setting name="SinglePlayerServerAddress__note__forwardedTo">:4539</setting>
            <setting name="LobbyServerAddress">lobby.services.rc.ngram.ca:4540</setting>
            <setting name="LobbyServerAddress__note__forwardedTo">:4541</setting>
            <setting name="authUrl">https://live-auth.rc.ngram.ca/</setting>
            <setting name="S3URL">https://static.rc.ngram.ca/live/data.json</setting>
            <setting name="Payment__note__notUsedHere">https://pay.rc.ngram.ca/</setting>
            <setting name="Multiplayer__note__notUsedHere">mp.rc.ngram.ca:4542</setting>
        </ngram>
        <mynewgroup>
            <setting name="WebServicesServerAddress">domain_or_ip_address:4532</setting>
            <setting name="WebServicesServerAddress__note__forwardedTo">:4533</setting>
            <setting name="SocialServerAddress">domain_or_ip_address:4534</setting>
            <setting name="SocialServerAddress__note__forwardedTo">:4535</setting>
            <setting name="ChatServerAddress">domain_or_ip_address:4536</setting>
            <setting name="ChatServerAddress__note__forwardedTo">:4537</setting>
            <setting name="SinglePlayerServerAddress">domain_or_ip_address:4538</setting>
            <setting name="SinglePlayerServerAddress__note__forwardedTo">:4539</setting>
            <setting name="LobbyServerAddress">domain_or_ip_address:4540</setting>
            <setting name="LobbyServerAddress__note__forwardedTo">:4541</setting>
            <setting name="authUrl">http://domain_or_ip_address:8001/</setting>
            <setting name="S3URL">http://domain_or_ip_address:8010/live/data.json</setting>
            <setting name="Payment__note__notUsedHere">http://domain_or_ip_address:8011/</setting>
            <setting name="Multiplayer__note__notUsedHere">domain_or_ip_address:4542</setting>
        </mynewgroup>
    </robocraft>
</servers>
"#;

    #[test]
    fn test_rc_servenvmulti_full_des() {
        let conf = RobocraftServers::from_str(RC_CONFIG).expect("Failed to parse embedded RC servenvmulti.config");
        println!("Parsed RC config: {:?}", conf);
    }

    #[test]
    fn test_rcr_servenvmulti_full_des() {
        let conf = RobocraftRoyaleServers::from_str(RCR_CONFIG).expect("Failed to parse embedded RCR servenvmulti.config");
        println!("Parsed RCR config: {:?}", conf);
    }

    #[test]
    fn test_rc_servenvmulti_indempotence() {
        let conf = RobocraftServers::from_str(RC_CONFIG).expect("Failed to parse embedded RC servenvmulti.config");
        let xml = conf.as_xml_str(4).expect("Failed to serialize RC servenvmulti.config");
        println!("Dumped RC config:\n{}", xml);
        //assert_eq!(RC_CONFIG, xml);
        let conf2 = RobocraftServers::from_str(&xml).expect("Failed to re-parse RC servenvmulti.config");
        assert_eq!(conf, conf2);
    }

    #[test]
    fn test_rcr_servenvmulti_indempotence() {
        let conf = RobocraftRoyaleServers::from_str(RCR_CONFIG).expect("Failed to parse embedded RCR servenvmulti.config");
        let xml = conf.as_xml_str(4).expect("Failed to serialize RCR servenvmulti.config");
        println!("Dumped RCR config:\n{}", xml);
        //assert_eq!(RCR_CONFIG, xml);
        let conf2 = RobocraftRoyaleServers::from_str(&xml).expect("Failed to re-parse RCR servenvmulti.config");
        assert_eq!(conf, conf2);
    }
}