Store received savegames in save folder

Author: DevOpsOfChaos

libs/s25main/network/GameClient.cpp

@@ -928,7 +928,10 @@ bool GameClient::OnGameMessage(const GameMessage_Map_Info& msg)
         OnError(ClientError::InvalidMap);
         return true;
     }
-    mapinfo.filepath = RTTRCONFIG.ExpandPath(s25::folders::mapsPlayed) / portFilename;
+    const auto targetFolder = (msg.mt == MapType::Savegame) ? s25::folders::save : s25::folders::mapsPlayed;
+    const auto targetPath = RTTRCONFIG.ExpandPath(targetFolder);
+    bfs::create_directories(targetPath);
+    mapinfo.filepath = targetPath / portFilename;
     mapinfo.type = msg.mt;
 
     // lua script file path

tests/s25Main/network/testGameClient.cpp

@@ -244,6 +244,65 @@ BOOST_DATA_TEST_CASE(ClientFollowsConnectProtocol, usesLuaScriptValues, usesLuaS
     }
 }
 
+BOOST_AUTO_TEST_CASE(ClientStoresReceivedSavegamesInSaveFolder)
+{
+    GameClient client;
+    GameMessageInterface& clientMsgInterface = client;
+    MockClientInterface callbacks;
+    client.SetInterface(&callbacks);
+    TestServer server;
+    const auto serverPort = server.tryListen();
+    BOOST_TEST_REQUIRE(serverPort >= 0);
+    const auto pw = rttr::test::randString(10);
+    const auto serverType = rttr::test::randomEnum<ServerType>();
+
+    mock::sequence s;
+    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::Initiated).once();
+    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::VerifyServer).once();
+    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::QueryPw).once();
+    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::QueryMapInfo).once();
+    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::ReceiveMap).once();
+
+    BOOST_TEST_REQUIRE(client.Connect("localhost", pw, serverType, serverPort, false, false));
+    clientMsgInterface.OnGameMessage(GameMessage_Player_Id(1));
+    BOOST_TEST_REQUIRE(boost::dynamic_pointer_cast<GameMessage_Server_Type>(client.GetMainPlayer().sendQueue.pop()));
+
+    clientMsgInterface.OnGameMessage(GameMessage_Server_TypeOK(GameMessage_Server_TypeOK::StatusCode::Ok, ""));
+    BOOST_TEST_REQUIRE(boost::dynamic_pointer_cast<GameMessage_Server_Password>(client.GetMainPlayer().sendQueue.pop()));
+
+    clientMsgInterface.OnGameMessage(GameMessage_Server_Password("true"));
+    BOOST_TEST_REQUIRE(dynamic_cast<GameMessage_Player_Name*>(client.GetMainPlayer().sendQueue.pop().get()));
+    BOOST_TEST_REQUIRE(dynamic_cast<GameMessage_Player_Portrait*>(client.GetMainPlayer().sendQueue.pop().get()));
+    const auto infoRequest = boost::dynamic_pointer_cast<GameMessage_MapRequest>(client.GetMainPlayer().sendQueue.pop());
+    BOOST_TEST_REQUIRE(infoRequest);
+    BOOST_TEST(infoRequest->requestInfo);
+
+    const boost::filesystem::path testMapPath =
+      rttr::test::rttrBaseDir / "tests" / "testData" / "maps" / "LuaFunctions.SWD";
+    MapInfo mapInfo;
+    mapInfo.mapData.CompressFromFile(testMapPath, &mapInfo.mapChecksum);
+    const auto mapDataSize = mapInfo.mapData.data.size();
+
+    clientMsgInterface.OnGameMessage(GameMessage_Map_Info("received.sav", MapType::Savegame,
+                                                          mapInfo.mapData.uncompressedLength, mapDataSize, 0, 0));
+
+    const auto expectedSavePath = RTTRCONFIG.ExpandPath(s25::folders::save) / "received.sav";
+    const auto unexpectedMapsPath = RTTRCONFIG.ExpandPath(s25::folders::mapsPlayed) / "received.sav";
+    BOOST_TEST(client.GetMapType() == MapType::Savegame);
+    BOOST_TEST(client.GetMapPath() == expectedSavePath);
+    BOOST_TEST(client.GetMapPath() != unexpectedMapsPath);
+
+    const auto transferRequest = boost::dynamic_pointer_cast<GameMessage_MapRequest>(client.GetMainPlayer().sendQueue.pop());
+    BOOST_TEST_REQUIRE(transferRequest);
+    BOOST_TEST(!transferRequest->requestInfo);
+
+    MOCK_EXPECT(callbacks.CI_MapPartReceived).with(mapDataSize, mapDataSize).once();
+    MOCK_EXPECT(callbacks.CI_Error).once();
+    clientMsgInterface.OnGameMessage(GameMessage_Map_Data(true, 0, mapInfo.mapData.data.data(), mapDataSize));
+
+    BOOST_TEST(bfs::exists(expectedSavePath));
+    BOOST_TEST(!bfs::exists(unexpectedMapsPath));
+}
 BOOST_AUTO_TEST_CASE(ClientDetectsMapBufferOverflow)
 {
     rttr::test::LogAccessor _suppressLogOutput;