lila/modules/relay/src/main/RelaySync.scala

package lila.relay

import org.joda.time.DateTime

import chess.format.pgn.{ Tag, Tags }
import lila.socket.Socket.Sri
import lila.study._

final private class RelaySync(
    studyApi: StudyApi,
    multiboard: StudyMultiBoard,
    chapterRepo: ChapterRepo,
    tourRepo: RelayTourRepo
)(implicit ec: scala.concurrent.ExecutionContext) {

  private type NbMoves = Int

  def apply(rt: RelayRound.WithTour, games: RelayGames): Fu[SyncResult.Ok] =
    studyApi byId rt.round.studyId orFail "Missing relay study!" flatMap { study =>
      chapterRepo orderedByStudy study.id flatMap { chapters =>
        RelayInputSanity(chapters, games) match {
          case Some(fail) => fufail(fail.msg)
          case None =>
            lila.common.Future.linear(games) { game =>
              findCorrespondingChapter(game, chapters, games.size) match {
                case Some(chapter) => updateChapter(rt.tour, study, chapter, game)
                case None =>
                  createChapter(study, game) flatMap { chapter =>
                    chapters.find(_.isEmptyInitial).ifTrue(chapter.order == 2).?? { initial =>
                      studyApi.deleteChapter(study.id, initial.id) {
                        actorApi.Who(study.ownerId, sri)
                      }
                    } inject SyncResult.ChapterResult(chapter.id, true, chapter.root.mainline.size)
                  }
              }
            } flatMap { chapterUpdates =>
              val result = SyncResult.Ok(chapterUpdates.toList, games)
              lila.common.Bus.publish(result, SyncResult busChannel rt.round.id)
              tourRepo.setSyncedNow(rt.tour) inject result
            }
        }
      }
    }

  /*
   * If the source contains several games, use their index to match them with the study chapter.
   * If the source contains only one game, use the player tags (and site) to match with the study chapter.
   * So the TCEC style - one game per file, reusing the file for all games - is supported.
   * lichess will create a new chapter when the game player tags differ.
   */
  private def findCorrespondingChapter(
      game: RelayGame,
      chapters: List[Chapter],
      nbGames: Int
  ): Option[Chapter] =
    if (nbGames == 1 || game.looksLikeLichess) chapters find game.staticTagsMatch
    else chapters.find(_.relay.exists(_.index == game.index))

  private def updateChapter(
      tour: RelayTour,
      study: Study,
      chapter: Chapter,
      game: RelayGame
  ): Fu[SyncResult.ChapterResult] =
    updateChapterTags(tour, study, chapter, game) zip
      updateChapterTree(study, chapter, game) map { case (tagUpdate, nbMoves) =>
        SyncResult.ChapterResult(chapter.id, tagUpdate, nbMoves)
      }

  private def updateChapterTree(study: Study, chapter: Chapter, game: RelayGame): Fu[NbMoves] = {
    val who = actorApi.Who(chapter.ownerId, sri)
    game.root.mainline.foldLeft(Path.root -> none[Node]) {
      case ((parentPath, None), gameNode) =>
        val path = parentPath + gameNode
        chapter.root.nodeAt(path) match {
          case None => parentPath -> gameNode.some
          case Some(existing) =>
            gameNode.clock.filter(c => !existing.clock.has(c)) ?? { c =>
              studyApi.setClock(
                studyId = study.id,
                position = Position(chapter, path).ref,
                clock = c.some
              )(who)
            }
            path -> none
        }
      case (found, _) => found
    } match {
      case (path, newNode) =>
        !Path.isMainline(chapter.root, path) ?? {
          logger.info(s"Change mainline ${showSC(study, chapter)} $path")
          studyApi.promote(
            studyId = study.id,
            position = Position(chapter, path).ref,
            toMainline = true
          )(who) >> chapterRepo.setRelayPath(chapter.id, path)
        } >> newNode.?? { node =>
          lila.common.Future.fold(node.mainline.toList)(Position(chapter, path).ref) { case (position, n) =>
            studyApi.addNode(
              studyId = study.id,
              position = position,
              node = n,
              opts = moveOpts.copy(clock = n.clock),
              relay = Chapter
                .Relay(
                  index = game.index,
                  path = position.path + n,
                  lastMoveAt = DateTime.now
                )
                .some
            )(who) inject position + n
          } inject {
            if (chapter.root.children.nodes.isEmpty && node.mainline.nonEmpty)
              studyApi.reloadChapters(study)
            node.mainline.size
          }
        }
    }
  }

  private def updateChapterTags(
      tour: RelayTour,
      study: Study,
      chapter: Chapter,
      game: RelayGame
  ): Fu[Boolean] = {
    val gameTags = game.tags.value.foldLeft(Tags(Nil)) { case (newTags, tag) =>
      if (!chapter.tags.value.has(tag)) newTags + tag
      else newTags
    }
    val newEndTag = game.end
      .ifFalse(gameTags(_.Result).isDefined)
      .filterNot(end => chapter.tags(_.Result).??(end.resultText ==))
      .map(end => Tag(_.Result, end.resultText))
    val tags = newEndTag.fold(gameTags)(gameTags + _)
    val chapterNewTags = tags.value.foldLeft(chapter.tags) { case (chapterTags, tag) =>
      PgnTags(chapterTags + tag)
    }
    (chapterNewTags != chapter.tags) ?? {
      if (vs(chapterNewTags) != vs(chapter.tags))
        logger.info(s"Update ${showSC(study, chapter)} tags '${vs(chapter.tags)}' -> '${vs(chapterNewTags)}'")
      studyApi.setTags(
        studyId = study.id,
        chapterId = chapter.id,
        tags = chapterNewTags
      )(actorApi.Who(chapter.ownerId, sri)) >> {
        val newEnd = chapter.tags.resultColor.isEmpty && tags.resultColor.isDefined
        newEnd ?? onChapterEnd(tour, study, chapter)
      } inject true
    }
  }

  private def onChapterEnd(tour: RelayTour, study: Study, chapter: Chapter): Funit =
    chapterRepo.setRelayPath(chapter.id, Path.root) >> {
      (tour.official && chapter.root.mainline.sizeIs > 10) ?? studyApi.analysisRequest(
        studyId = study.id,
        chapterId = chapter.id,
        userId = study.ownerId,
        unlimited = true
      )
    } >>- {
      multiboard.invalidate(study.id)
      studyApi.reloadChapters(study)
    }

  private def createChapter(study: Study, game: RelayGame): Fu[Chapter] =
    chapterRepo.nextOrderByStudy(study.id) flatMap { order =>
      val name = {
        for {
          w <- game.tags(_.White)
          b <- game.tags(_.Black)
        } yield s"$w - $b"
      } orElse game.tags("board") getOrElse "?"
      val chapter = Chapter.make(
        studyId = study.id,
        name = Chapter.Name(name),
        setup = Chapter.Setup(
          none,
          game.variant,
          chess.Color.White
        ),
        root = game.root,
        tags = game.tags,
        order = order,
        ownerId = study.ownerId,
        practice = false,
        gamebook = false,
        conceal = none,
        relay = Chapter
          .Relay(
            index = game.index,
            path = game.root.mainlinePath,
            lastMoveAt = DateTime.now
          )
          .some
      )
      studyApi.doAddChapter(study, chapter, sticky = false, actorApi.Who(study.ownerId, sri)) >>-
        multiboard.invalidate(study.id) inject chapter
    }

  private val moveOpts = MoveOpts(
    write = true,
    sticky = false,
    promoteToMainline = true,
    clock = none
  )

  private val sri = Sri("")

  private def vs(tags: Tags) = s"${tags(_.White) | "?"} - ${tags(_.Black) | "?"}"

  private def showSC(study: Study, chapter: Chapter) =
    s"#${study.id} chapter[${chapter.relay.fold("?")(_.index.toString)}]"
}

sealed trait SyncResult {
  val reportKey: String
}
object SyncResult {
  case class Ok(chapters: List[ChapterResult], games: RelayGames) extends SyncResult {
    def nbMoves   = chapters.foldLeft(0)(_ + _.newMoves)
    val reportKey = "ok"
  }
  case object Timeout extends Exception with SyncResult {
    val reportKey           = "timeout"
    override def getMessage = "In progress..."
  }
  case class Error(msg: String) extends SyncResult {
    val reportKey = "error"
  }

  case class ChapterResult(id: Chapter.Id, tagUpdate: Boolean, newMoves: Int)

  def busChannel(roundId: RelayRound.Id) = s"relaySyncResult:$roundId"
}