New: initial author_results

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Pavel Perestoronin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -26,11 +26,11 @@ fn main() -> Result<()> {
 
     assert_eq!(battle_results.players[0].account_id, 520886428);
     assert_eq!(battle_results.players[0].info.nickname, "77mmmr");
-    assert_eq!(battle_results.players[0].info.team_number(), TeamNumber::Two);
+    assert_eq!(battle_results.players[0].info.team(), TeamNumber::Two);
     assert_eq!(battle_results.players[0].info.platoon_id, None);
 
     assert_eq!(battle_results.players[1].info.nickname, "SNAK_THE_RIPPER");
-    assert_eq!(battle_results.players[1].info.team_number(), TeamNumber::One);
+    assert_eq!(battle_results.players[1].info.team(), TeamNumber::One);
     assert_eq!(battle_results.players[1].info.platoon_id, Some(547466834));
 
     Ok(())

src/models/battle_results.rs

@@ -1,5 +1,6 @@
 use prost::bytes::Buf;
 use prost::Message;
+use serde::Serialize;
 
 use crate::error::Error;
 use crate::result::Result;
@@ -14,12 +15,23 @@ impl BattleResults {
 }
 
 /// Parsed battle results.
-#[derive(Message)]
+#[derive(Message, Serialize)]
 pub struct BattleResults {
     /// Battle timestamp.
     #[prost(int64, tag = "2")]
     pub timestamp: i64,
 
+    #[prost(enumeration = "TeamNumber", tag = "3")]
+    pub winning_team: i32,
+
+    /// Replay's author results.
+    #[prost(message, required, tag = "8")]
+    pub author_results: AuthorResults,
+
+    /// Author's free XP, including premium.
+    #[prost(uint32, tag = "137")]
+    pub free_xp: u32,
+
     /// Players in the battle.
     #[prost(message, repeated, tag = "201")]
     pub players: Vec<Player>,
@@ -30,7 +42,7 @@ pub struct BattleResults {
 }
 
 /// Battle player.
-#[derive(Message)]
+#[derive(Message, Serialize)]
 pub struct Player {
     /// Player's account ID.
     #[prost(uint32, tag = "1")]
@@ -42,7 +54,7 @@ pub struct Player {
 }
 
 /// Player's extended information.
-#[derive(Message)]
+#[derive(Message, Serialize)]
 pub struct PlayerInfo {
     /// Player's nickname.
     #[prost(string, tag = "1")]
@@ -56,13 +68,15 @@ pub struct PlayerInfo {
 
     /// Player's team assignment.
     #[prost(enumeration = "TeamNumber", tag = "3")]
-    pub team_number: i32,
+    pub team: i32,
 
     #[prost(string, optional, tag = "5")]
     pub clan_tag: Option<String>,
 }
 
-#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, prost::Enumeration)]
+#[derive(
+    Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, prost::Enumeration, Serialize,
+)]
 #[repr(i32)]
 pub enum TeamNumber {
     One = 1,
@@ -70,7 +84,7 @@ pub enum TeamNumber {
 }
 
 /// Player's battle results.
-#[derive(Message)]
+#[derive(Message, Serialize)]
 pub struct PlayerResults {
     /// Looks like some sort of sequential result ID. They reference each other,
     /// but I haven't figured this out yet.
@@ -83,11 +97,11 @@ pub struct PlayerResults {
 }
 
 /// Extended player's results information.
-#[derive(Message)]
+#[derive(Message, Serialize)]
 pub struct PlayerResultsInfo {
     /// Credits earned – without special awards and medals and premium account excluded.
     #[prost(uint32, tag = "2")]
-    pub credits: u32,
+    pub credits_earned: u32,
 
     /// Base XP (the total without multipliers).
     #[prost(uint32, tag = "3")]
@@ -160,3 +174,17 @@ impl PlayerResultsInfo {
             .map(|mm_rating| (mm_rating * 10.0 + 3000.0) as u32)
     }
 }
+
+#[derive(Message, Serialize)]
+pub struct AuthorResults {
+    /// Earned credits, including premium and special awards and medals.
+    #[prost(uint32, tag = "2")]
+    pub credits_earned: u32,
+
+    /// Combat XP, including premium.
+    #[prost(uint32, tag = "3")]
+    pub combat_xp: u32,
+
+    #[prost(uint32, tag = "8")]
+    pub damage_dealt: u32,
+}

src/models/battle_results_dat.rs

@@ -11,9 +11,11 @@ use crate::{Error, Result};
 #[derive(Debug, Deserialize)]
 pub struct BattleResultsDat(
     /// No idea what this is.
-    u64,
+    /// My best guess – some kind of checksum,
+    /// but none of MD5, SHA1, SHA224, SHA256, SHA384, SHA512, nor CRC64 over the buffer have matched.
+    pub u64,
     /// Protobuf-serialized battle results.
-    ByteBuf,
+    pub ByteBuf,
 );
 
 impl BattleResultsDat {

src/replay.rs

@@ -19,10 +19,15 @@ impl<R: Read + Seek> Replay<R> {
 
     /// Reads and parses the battle results from the replay.
     pub fn read_battle_results(&mut self) -> Result<BattleResults> {
+        self.read_battle_results_dat()?.decode_battle_results()
+    }
+
+    /// Reads and parses the included `battle_results.dat`.
+    pub fn read_battle_results_dat(&mut self) -> Result<BattleResultsDat> {
         let pickled_battle_results = self
             .0
             .by_name("battle_results.dat")
             .map_err(Error::OpenBattleResultsFailed)?;
-        BattleResultsDat::from_reader(pickled_battle_results)?.decode_battle_results()
+        BattleResultsDat::from_reader(pickled_battle_results)
     }
 }

tests/battle_results.rs

@@ -1,6 +1,7 @@
 use std::fs::File;
 
 use anyhow::Result;
+use wotbreplay_parser::models::TeamNumber;
 use wotbreplay_parser::Replay;
 
 #[test]
@@ -37,7 +38,7 @@ fn player_results_ok() -> Result<()> {
     assert_eq!(zeekrab_info.victory_points_earned, 40);
     assert_eq!(zeekrab_info.victory_points_seized, 40);
     assert_eq!(zeekrab_info.tank_id, 26657);
-    assert_eq!(zeekrab_info.credits, 37679);
+    assert_eq!(zeekrab_info.credits_earned, 37679);
     assert_eq!(zeekrab_info.n_enemies_damaged, 2);
     assert_eq!(zeekrab_info.n_enemies_destroyed, 1);
 
@@ -94,3 +95,26 @@ fn victory_points_ok() -> Result<()> {
 
     Ok(())
 }
+
+#[test]
+fn winning_team_ok() -> Result<()> {
+    let battle_results = Replay::open(File::open("tests/replays/winning_team.wotbreplay")?)?
+        .read_battle_results()?;
+
+    assert_eq!(battle_results.winning_team(), TeamNumber::One);
+
+    Ok(())
+}
+
+#[test]
+fn author_results_ok() -> Result<()> {
+    let battle_results = Replay::open(File::open("tests/replays/author_results.wotbreplay")?)?
+        .read_battle_results()?;
+
+    assert_eq!(battle_results.author_results.credits_earned, 53623);
+    assert_eq!(battle_results.author_results.combat_xp, 2370);
+    assert_eq!(battle_results.author_results.damage_dealt, 1738);
+    assert_eq!(battle_results.free_xp, 116);
+
+    Ok(())
+}

tests/replays/.gitattributes

@@ -0,0 +1 @@
+*.wotbreplay linguist-generated