Merge pull request #98 from Mind-Sports-Games/pla-827-support-sgf-download-in-analysis

support sgf format for analysis and studies

Author: JamesHeppell

build.sbt

@@ -19,7 +19,7 @@ libraryDependencies += "io.lettuce"                  % "lettuce-core"
 libraryDependencies += "io.netty"                    % "netty-handler"                % nettyVersion
 libraryDependencies += "io.netty"                    % "netty-codec-http"             % nettyVersion
 libraryDependencies += "io.netty"                    % "netty-transport-native-epoll" % nettyVersion classifier "linux-x86_64"
-libraryDependencies += "org.playstrategy"           %% "strategygames"                % "10.2.1-pstrat124"
+libraryDependencies += "org.playstrategy"           %% "strategygames"                % "10.2.1-pstrat134"
 libraryDependencies += "com.typesafe.akka"          %% "akka-actor-typed"             % akkaVersion
 libraryDependencies += "com.typesafe.akka"          %% "akka-slf4j"                   % akkaVersion
 libraryDependencies += "com.typesafe.scala-logging" %% "scala-logging"                % "3.9.3"

src/main/scala/Chess.scala

@@ -6,7 +6,7 @@ import scala.util.chaining._
 import play.api.libs.json._
 import strategygames.format.{ FEN, Forsyth, Uci, UciCharPair }
 import strategygames.opening.{ FullOpening, FullOpeningDB }
-import strategygames.{ Game, GameLogic, MoveMetrics, Pocket, PocketData, Pos, Role, Situation }
+import strategygames.{ Game, GameFamily, GameLogic, MoveMetrics, Pocket, PocketData, Pos, Role, Situation }
 import strategygames.variant.Variant
 import strategygames.draughts
 import com.typesafe.scalalogging.Logger
@@ -39,9 +39,13 @@ object Chess {
           captures = fullCaptureFields,
           partialCaptures = req.fullCapture.getOrElse(false)
         ).toOption.flatMap { case (game, move) =>
-          //Get the san of the last action
-          game.actionStrs.flatten.lastOption.map { san =>
+          //Get the game record notation (san/sgf) of the last action
+          game.actionStrs.flatten.lastOption.map { lastAction =>
             {
+              val gameRecordNotation =
+                if (isSgf(req.variant))
+                  strategygames.format.sgf.Dumper(req.variant, Vector(Vector(lastAction)))
+                else lastAction
               val movable = game.situation.playable(false)
               val captLen = (game.situation, req.dest) match {
                 case (Situation.Draughts(sit), Pos.Draughts(dest)) =>
@@ -75,7 +79,7 @@ object Chess {
                       case _                    => false
                     }
                   ),
-                  san
+                  gameRecordNotation
                 ),
                 req.path,
                 req.chapterId,
@@ -128,15 +132,25 @@ object Chess {
         g.drop(req.role, req.pos)
           .toOption
           .flatMap({ case (game, drop) =>
-            //Get the san of the last action
-            game.actionStrs.flatten.lastOption map { san =>
-              makeNode(
-                game,
-                Uci.WithSan(req.variant.gameLogic, Uci(req.variant.gameLogic, drop), san),
-                req.path,
-                req.chapterId,
-                if (game.situation.playable(false)) game.situation.destinations else Map.empty
-              )
+            //Get the game record notation (san/sgf) of the last action
+            game.actionStrs.flatten.lastOption map { lastAction =>
+              {
+                val gameRecordNotation =
+                  if (isSgf(req.variant))
+                    strategygames.format.sgf.Dumper(req.variant, Vector(Vector(lastAction)))
+                  else lastAction
+                makeNode(
+                  game,
+                  Uci.WithSan(
+                    req.variant.gameLogic,
+                    Uci(req.variant.gameLogic, drop),
+                    gameRecordNotation
+                  ),
+                  req.path,
+                  req.chapterId,
+                  if (game.situation.playable(false)) game.situation.destinations else Map.empty
+                )
+              }
             }
           })
           .getOrElse(ClientIn.StepFailure)
@@ -274,6 +288,12 @@ object Chess {
     )
   }
 
+  private def isSgf(variant: Variant): Boolean = {
+    variant.gameLogic == GameLogic.FairySF() || variant.gameLogic == GameLogic
+      .Go() || variant.gameLogic == GameLogic
+      .Backgammon() || (variant.gameFamily == GameFamily.LinesOfAction())
+  }
+
   //TODO: push this into strategygames. So much copy/paste from lila.socket.AnaDests
   //this continues until `object json`
   private val initialChessDests    = "iqy muC gvx ltB bqs pxF jrz nvD ksA owE"

src/main/scala/ipc/ClientIn.scala

@@ -182,7 +182,7 @@ object ClientIn {
             "node" -> Json
               .obj(
                 "ply" -> ply,
-                //TODO verify if this is actually being used and where receives this
+                //This is used within analysis actions
                 "turnCount"   -> turnCount,
                 "fen"         -> fen,
                 "id"          -> id,