feat: move loading GameState from file from Game into SDK

Author: xeruf

plugin/src/server/sc/plugin2021/Game.kt

@@ -76,18 +76,6 @@ class Game(override val currentState: GameState = GameState()): AbstractGame<Pla
         }
     }
 
-    override fun loadGameInfo(gameInfo: Any) {
-        TODO("Not yet implemented")
-    }
-    
-    override fun loadFromFile(file: String) {
-        TODO("Not yet implemented")
-    }
-    
-    override fun loadFromFile(file: String, turn: Int) {
-        TODO("Not yet implemented")
-    }
-    
     override fun getScoreFor(player: Player): PlayerScore {
         val team = player.color as Team
         logger.debug("Get score for player $team (violated: ${if (player.hasViolated()) "yes" else "no"})")

sdk/src/server-api/sc/api/plugins/IGameInstance.kt

@@ -38,30 +38,6 @@ interface IGameInstance {
      */
     fun destroy()
 
-    /**
-     * The game is requested to load itself from a file.
-     * Similar to a replay but with actual clients.
-     *
-     * @param file File the game should be loaded from
-     */
-    fun loadFromFile(file: String)
-
-    /**
-     * The game is requested to load itself from a file.
-     * Similar to a replay but with actual clients.
-     *
-     * @param file File where the game should be loaded from
-     * @param turn The turn to load from the replay
-     */
-    fun loadFromFile(file: String, turn: Int)
-
-    /**
-     * The game is requested to load itself from a given game information object.
-     *
-     * @param gameInfo the stored gameInformation
-     */
-    fun loadGameInfo(gameInfo: Any)
-
     /**
      * Returns the players that have won the game, empty if the game has no winners,
      * or null if the game has not yet finished.

server/src/sc/server/gaming/GameRoomManager.java

@@ -2,8 +2,12 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import sc.api.plugins.IGameInstance;
+import sc.api.plugins.IGamePlugin;
+import sc.api.plugins.IGameState;
 import sc.api.plugins.exceptions.GameRoomException;
 import sc.api.plugins.exceptions.RescuableClientException;
+import sc.api.plugins.host.GameLoader;
 import sc.networking.InvalidScoreDefinitionException;
 import sc.protocol.requests.PrepareGameRequest;
 import sc.protocol.responses.GamePreparedResponse;
@@ -15,14 +19,16 @@
 import sc.server.plugins.UnknownGameTypeException;
 import sc.shared.*;
 
+import java.io.File;
+import java.io.IOException;
 import java.math.BigDecimal;
 import java.math.MathContext;
 import java.util.*;
 
 /**
  * The GameManager is responsible to keep all games alive and kill them once
- * they are done. Additionally the GameManager has to detect and kill games,
- * which seem to be dead-locked or have caused a timeout.
+ * they are done. Additionally the GameManager has to detect and kill games
+ * which seem dead-locked or have caused a timeout.
  */
 public class GameRoomManager {
   private Map<String, GameRoom> rooms;
@@ -46,66 +52,67 @@ private synchronized void add(GameRoom room) {
     this.rooms.put(room.getId(), room);
   }
 
+  public IGamePlugin findPlugin(String gameType) throws RescuableClientException {
+    GamePluginInstance plugin = this.gamePluginManager.getPlugin(gameType);
+
+    if (plugin == null) {
+      logger.warn("Couldn't find a game of type " + gameType);
+      throw new UnknownGameTypeException(gameType, this.gamePluginManager.getPluginUUIDs());
+    }
+
+    return plugin.getPlugin();
+  }
+
   /**
-   * Create a not prepared {@link GameRoom GameRoom} of given type
-   *
-   * @param gameType String of current Game
+   * Create a not prepared {@link GameRoom GameRoom} of given type.
    *
    * @return Newly created GameRoom
    *
    * @throws RescuableClientException if creation of game failed
    */
-  public synchronized GameRoom createGame(String gameType) throws RescuableClientException {
-    return createGame(gameType, false);
+  public synchronized GameRoom createGameRoom(String gameType) throws RescuableClientException {
+    IGamePlugin plugin = findPlugin(gameType);
+    IGameInstance game;
+
+    String gameFileLocation = Configuration.get(Configuration.GAMELOADFILE);
+    if (gameFileLocation != null && !gameFileLocation.equals("")) {
+      File gameFile = new File(gameFileLocation);
+      Integer turn = null;
+      try {
+        turn = Integer.parseInt(Configuration.get(Configuration.TURN_TO_LOAD));
+      } catch(NumberFormatException ignored) {
+      }
+
+      // TODO skip to turn
+      // TODO implement tests
+      logger.info("Loading game from file '{}' at turn {}", gameFile, turn);
+      try {
+        game = plugin.createGameFromState((IGameState) new GameLoader(IGameState.class).loadGame(gameFile));
+      } catch(IOException e) {
+        logger.error("Failed to load game from file", e);
+        game = plugin.createGame();
+      }
+    } else {
+      game = plugin.createGame();
+    }
+
+    return createGameRoom(plugin.getScoreDefinition(), game, false);
   }
 
   /**
-   * Create a new GameRoom from the matching plugin.
-   * If gameFile is set, load gameState from file.
+   * Create a new GameRoom with the given Game.
    *
-   * @param gameType id of the game plugin to use
-   * @param prepared signals whether the game was prepared by gui or ..., false if player has to send JoinRoomRequest
+   * @param prepared signals whether the game was prepared by an administrative client,
+   *                 false if from a JoinRoomRequest
    *
    * @return newly created GameRoom
-   *
-   * @throws UnknownGameTypeException if no matching GamePlugin was found
    */
-  public GameRoom createGame(String gameType, boolean prepared) throws RescuableClientException {
-    GamePluginInstance plugin = this.gamePluginManager.getPlugin(gameType);
-
-    if (plugin == null) {
-      logger.warn("Couldn't find a game of type " + gameType);
-      throw new UnknownGameTypeException(gameType, this.gamePluginManager.getPluginUUIDs());
-    }
-
-    logger.info("Creating new game of type " + gameType);
-
-    String roomId = generateRoomId();
-    GameRoom room = new GameRoom(roomId, this, plugin.getPlugin().getScoreDefinition(), plugin.createGame(), prepared);
+  public GameRoom createGameRoom(ScoreDefinition scoreDefinition, IGameInstance game, boolean prepared) {
+    GameRoom room = new GameRoom(generateRoomId(), this, scoreDefinition, game, prepared);
     // pause room if specified in server.properties on joinRoomRequest
     if (!prepared) {
       boolean paused = Boolean.parseBoolean(Configuration.get(Configuration.PAUSED));
       room.pause(paused);
-      logger.info("Pause is set to {}", paused);
-    }
-
-    String gameFile = Configuration.get(Configuration.GAMELOADFILE);
-    if (gameFile != null && !gameFile.equals("")) {
-      logger.info("Request plugin to load game from file: " + gameFile);
-      int turn;
-      if (Configuration.get(Configuration.TURN_TO_LOAD) != null) {
-        turn = Integer.parseInt(Configuration.get(Configuration.TURN_TO_LOAD));
-      } else {
-        turn = 0;
-      }
-      logger.debug("Turns is to load is: " + turn);
-      if (turn > 0) {
-        logger.debug("Loading from non default turn");
-        room.game.loadFromFile(gameFile, turn);
-      } else {
-        logger.debug("Loading first gameState found");
-        room.game.loadFromFile(gameFile);
-      }
     }
 
     this.add(room);
@@ -126,7 +133,7 @@ private static synchronized String generateRoomId() {
    */
   public synchronized RoomWasJoinedEvent createAndJoinGame(Client client, String gameType)
           throws RescuableClientException {
-    GameRoom room = createGame(gameType);
+    GameRoom room = createGameRoom(gameType);
     if (room.join(client)) {
       return roomJoined(room);
     }
@@ -164,23 +171,22 @@ public GamePluginManager getPluginManager() {
   }
 
   /**
-   * Creates a new GameRoom through {@link #createGame(String) createGame} with reserved PlayerSlots according to the
+   * Creates a new GameRoom with reserved PlayerSlots according to the
    * descriptors and loads a game state from a file if provided.
    *
    * @return new PrepareGameProtocolMessage with roomId and slot reservations
    *
    * @throws RescuableClientException if game could not be created
    */
-  public synchronized GamePreparedResponse prepareGame(String gameType, boolean paused, SlotDescriptor[] descriptors, Object loadGameInfo)
+  public synchronized GamePreparedResponse prepareGame(String gameType, boolean paused, SlotDescriptor[] descriptors, IGameState loadGameInfo)
           throws RescuableClientException {
-    GameRoom room = createGame(gameType, true);
+    IGamePlugin plugin = findPlugin(gameType);
+    IGameInstance game = loadGameInfo != null ? plugin.createGameFromState(loadGameInfo) : plugin.createGame();
+
+    GameRoom room = createGameRoom(plugin.getScoreDefinition(), game, true);
     room.pause(paused);
     room.openSlots(descriptors);
 
-    if (loadGameInfo != null) {
-      room.game.loadGameInfo(loadGameInfo);
-    }
-
     return new GamePreparedResponse(room.getId(), room.reserveAllSlots());
   }
 

server/test/sc/server/plugins/TestGame.kt

@@ -52,10 +52,6 @@ data class TestGame(
         return PlayerScore(true, "Spieler hat gewonnen.")
     }
 
-    override fun loadFromFile(file: String) {}
-    override fun loadFromFile(file: String, turn: Int) {}
-    override fun loadGameInfo(gameInfo: Any) {}
-    
     override fun getTimeoutFor(player: Player): ActionTimeout =
             ActionTimeout(false)