Merge branch 'master'

Author: xeruf

GUIDELINES.md

@@ -49,17 +49,27 @@ to make some year-specific implementations from the plugin accessible in the sdk
 Currently there are two interfaces, [IGamePlugin](sdk/src/server-api/sc/api/plugins/IGamePlugin.java) and [XStreamProvider]( sdk/src/server-api/sc/networking/XStreamProvider.kt), which are implemented in the plugin and then loaded through a ServiceLoader.
 The information which implementations to use resides in [resources/META-INF/services](plugin/src/resources/META-INF/services).
 
-## Protocol Message Classes
+## Networking Protocol Classes
 
-### [sdk/server-api/sc.protocol](sdk/src/server-api/sc/protocol)
+[ProtocolPacket](sdk/src/server-api/sc/protocol/ProtocolPacket.kt) is the common interface
+for objects sent via the XML Protocol.
 
-(*Request) Ask for an action or information  
-(? extends [AdminLobbyRequest](sdk/src/server-api/sc/protocol/requests/ILobbyRequest.kt)) Requires authentication
+### [Requests](sdk/src/server-api/sc/protocol/requests)
+- are all suffixed with `Request`
+- ask for an action or information  
+- any request that extends [AdminLobbyRequest](sdk/src/server-api/sc/protocol/requests/ILobbyRequest.kt)
+  requires authentication beforehand
 
 #### [Responses](sdk/src/server-api/sc/protocol/responses)
 
-If it extends `ProtocolMessage` directly, it is wrapped in a [RoomPacket](sdk/src/server-api/sc/protocol/responses/RoomPacket.kt)
-and sent to a specific room, otherwise it has to extend `ILobbyRequest` and is sent to LobbyListeners.
-
 (*Response) Response to a request  
 (*Event) Update to all observers
+
+#### [Room Messages](sdk/src/server-api/sc/protocol/room)
+
+Data sent to a specific room has to implement [RoomMessage](sdk/src/server-api/sc/protocol/room/RoomMessage.kt)
+and is then wrapped in a [RoomPacket](sdk/src/server-api/sc/protocol/room/RoomPacket.kt).
+
+The package contains a few standard messages,
+but most will be implemented in the corresponding plugin.
+

helpers/test-client/src/sc/TestClient.java

@@ -9,6 +9,8 @@
 import sc.api.plugins.IGamePlugin;
 import sc.framework.plugins.Player;
 import sc.networking.clients.XStreamClient;
+import sc.protocol.ProtocolPacket;
+import sc.protocol.room.RoomPacket;
 import sc.protocol.requests.*;
 import sc.protocol.responses.*;
 import sc.server.Configuration;
@@ -185,7 +187,7 @@ public TestClient(String host, int port, int totalTests) throws IOException {
   private boolean gameProgressing = false;
 
   @Override
-  protected void onObject(@NotNull ProtocolMessage message) {
+  protected void onObject(@NotNull ProtocolPacket message) {
     if (message == null) {
       logger.warn("Received null message");
       return;
@@ -335,8 +337,7 @@ private void prepareNewClients() {
 
   private static void exit(int status) {
     if (testclient != null) {
-      if (!testclient.isClosed())
-        testclient.send(new CloseConnection());
+      testclient.stop();
       testclient.waiter.shutdownNow();
     }
 

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

@@ -1,14 +1,15 @@
 package sc.plugin2021
 
 import org.slf4j.LoggerFactory
+import sc.api.plugins.exceptions.TooManyPlayersException
 import sc.framework.plugins.AbstractGame
 import sc.framework.plugins.ActionTimeout
 import sc.framework.plugins.Player
 import sc.plugin2021.util.Constants
 import sc.plugin2021.util.GameRuleLogic
 import sc.plugin2021.util.MoveMistake
 import sc.plugin2021.util.WinReason
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.room.RoomMessage
 import sc.shared.InvalidMoveException
 import sc.shared.PlayerScore
 import sc.shared.ScoreCause
@@ -22,7 +23,7 @@ class Game(override val currentState: GameState = GameState()): AbstractGame<Pla
     private val availableTeams = mutableListOf(Team.ONE, Team.TWO)
     override fun onPlayerJoined(): Player {
         if (availableTeams.isEmpty())
-            throw IllegalStateException("Too many players joined the game!")
+            throw TooManyPlayersException()
         val player = currentState.getPlayer(availableTeams.removeAt(0))
 
         players.add(player)
@@ -75,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"})")
@@ -137,7 +126,7 @@ class Game(override val currentState: GameState = GameState()): AbstractGame<Pla
             ActionTimeout(true, Constants.HARD_TIMEOUT, Constants.SOFT_TIMEOUT)
 
     @Throws(InvalidMoveException::class)
-    override fun onRoundBasedAction(fromPlayer: Player, data: ProtocolMessage) {
+    override fun onRoundBasedAction(fromPlayer: Player, data: RoomMessage) {
         if (data !is Move)
             throw InvalidMoveException(MoveMistake.INVALID_FORMAT)
 

sdk/src/framework/sc/shared/GameResult.kt

@@ -3,7 +3,7 @@ package sc.shared
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamImplicit
 import sc.framework.plugins.Player
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.room.RoomMessage
 
 /**
  * Das Endergebnis eines Spiels.
@@ -17,7 +17,7 @@ data class GameResult(
         val scores: List<PlayerScore>,
         @XStreamImplicit(itemFieldName = "winner")
         val winners: List<Player>?
-): ProtocolMessage {
+): RoomMessage {
 
     val isRegular: Boolean
         get() = scores.all { it.cause == ScoreCause.REGULAR }

sdk/src/framework/sc/shared/WelcomeMessage.kt

@@ -3,13 +3,13 @@ package sc.shared
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 import sc.api.plugins.ITeam
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.room.RoomMessage
 
 /** Nachricht, die zu Beginn eines Spiels an einen Client geschickt wird, um ihm seine Spielerfarbe mitzuteilen.  */
 @Suppress("DataClassPrivateConstructor")
 @XStreamAlias(value = "welcomeMessage")
 data class WelcomeMessage private constructor(
         @XStreamAsAttribute val color: String
-): ProtocolMessage {
+): RoomMessage {
     constructor(color: ITeam): this(color.name)
 }

sdk/src/player/sc/player/PlayerClient.kt

@@ -5,8 +5,8 @@ import sc.api.plugins.*
 import sc.framework.plugins.protocol.MoveRequest
 import sc.networking.clients.AbstractLobbyClientListener
 import sc.networking.clients.LobbyClient
-import sc.protocol.responses.ProtocolErrorMessage
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.room.ErrorMessage
+import sc.protocol.room.RoomMessage
 import sc.shared.GameResult
 import java.net.ConnectException
 import kotlin.system.exitProcess
@@ -42,23 +42,21 @@ class PlayerClient(
     private lateinit var roomId: String
 
     /** Called for any new message sent to the game room, e.g., move requests. */
-    override fun onRoomMessage(roomId: String, data: ProtocolMessage) {
+    override fun onRoomMessage(roomId: String, data: RoomMessage) {
         this.roomId = roomId
         when (data) {
             is MoveRequest -> sendMove(handler.calculateMove())
+            is ErrorMessage -> {
+                logger.debug("onError: Client $this received error ${data.message} in $roomId")
+                this.error = data.message
+            }
         }
     }
 
     /** Sends the selected move to the server. */
     fun sendMove(move: IMove) =
             client.sendMessageToRoom(roomId, move)
 
-    /** Called when an erroneous message is sent to the room. */
-    override fun onError(roomId: String?, error: ProtocolErrorMessage) {
-        logger.debug("onError: Client $this received error ${error.message} in $roomId")
-        this.error = error.message
-    }
-    
     /**
      * Called when game state has been received.
      * Happens after a client made a move.

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

@@ -1,22 +1,16 @@
 package sc.api.plugins
 
 import sc.api.plugins.exceptions.GameLogicException
-import sc.api.plugins.exceptions.TooManyPlayersException
 import sc.api.plugins.host.IGameListener
 import sc.framework.plugins.Player
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.room.RoomMessage
 import sc.shared.InvalidMoveException
 import sc.shared.PlayerScore
 import sc.shared.ScoreCause
 import kotlin.jvm.Throws
 
 interface IGameInstance {
-    /**
-     * @return the player that joined
-     *
-     * @throws TooManyPlayersException when game is already full
-     */
-    @Throws(TooManyPlayersException::class)
+    /** @return the player that joined. */
     fun onPlayerJoined(): Player
     fun onPlayerLeft(player: Player, cause: ScoreCause? = null)
 
@@ -30,7 +24,7 @@ interface IGameInstance {
      * @throws InvalidMoveException if the received move violates the rules
      */
     @Throws(GameLogicException::class, InvalidMoveException::class)
-    fun onAction(fromPlayer: Player, data: ProtocolMessage)
+    fun onAction(fromPlayer: Player, data: RoomMessage)
     fun addGameListener(listener: IGameListener)
     fun removeGameListener(listener: IGameListener)
 
@@ -44,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.

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

@@ -1,6 +1,6 @@
 package sc.api.plugins
 
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.room.RoomMessage
 
 /**
  * Ein `GameState` beinhaltet alle Informationen, die den Spielstand zu
@@ -25,7 +25,7 @@ import sc.protocol.responses.ProtocolMessage
  *
  * @author Niklas, Sören, Janek
  */
-interface IGameState : ProtocolMessage, Cloneable {
+interface IGameState : RoomMessage, Cloneable {
     /** Aktuelle Zugzahl  */
     val turn: Int
 

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

@@ -1,5 +1,5 @@
 package sc.api.plugins
 
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.room.RoomMessage
 
-interface IMove: ProtocolMessage
+interface IMove: RoomMessage

sdk/src/server-api/sc/api/plugins/exceptions/NotYourTurnException.kt

@@ -1,10 +1,10 @@
 package sc.api.plugins.exceptions
 
 import sc.framework.plugins.Player
-import sc.protocol.responses.ProtocolMessage
+import sc.protocol.room.RoomMessage
 
 data class NotYourTurnException(
         val expected: Player?,
         val actual: Player,
-        val data: ProtocolMessage):
-        GameLogicException("It's not your turn yet; expected: $expected, got $actual (msg was $data).")
+        val data: RoomMessage
+): GameLogicException("It's not your turn yet; expected: $expected, got $actual (msg was $data).")