client/src/components/BaseGame.vue

   1 <template lang="pug">
   2 div#baseGame
   3   input#modalEog.modal(type="checkbox")
   4   div#eogDiv(
   5     role="dialog"
   6     data-checkbox="modalEog"
   7   )
   8     .card.text-center
   9       label.modal-close(for="modalEog")
  10       h3.section {{ endgameMessage }}
  11   #gameContainer
  12     #boardContainer
  13       Board(
  14         :vr="vr"
  15         :last-move="lastMove"
  16         :analyze="game.mode=='analyze'"
  17         :score="game.score"
  18         :user-color="game.mycolor"
  19         :orientation="orientation"
  20         :vname="game.vname"
  21         :incheck="incheck"
  22         @play-move="play"
  23       )
  24       #turnIndicator(v-if="showTurn") {{ turn }}
  25       #controls
  26         button(@click="gotoBegin()")
  27           img.inline(src="/images/icons/fast-forward_rev.svg")
  28         button(@click="undo()")
  29           img.inline(src="/images/icons/play_rev.svg")
  30         button(v-if="canFlip" @click="flip()")
  31           img.inline(src="/images/icons/flip.svg")
  32         button(@click="play()")
  33           img.inline(src="/images/icons/play.svg")
  34         button(@click="gotoEnd()")
  35           img.inline(src="/images/icons/fast-forward.svg")
  36       #belowControls
  37         #downloadDiv(v-if="allowDownloadPGN")
  38           a#download(href="#")
  39           button(@click="download()") {{ st.tr["Download"] }} PGN
  40         button(
  41           v-if="canAnalyze"
  42           @click="analyzePosition()"
  43         )
  44           | {{ st.tr["Analyse"] }}
  45         // NOTE: variants pages already have a "Rules" link on top
  46         button(
  47           v-if="!$route.path.match('/variants/')"
  48           @click="showRules()"
  49         )
  50           | {{ st.tr["Rules"] }}
  51     #movesList
  52       MoveList(
  53         :show="showMoves"
  54         :score="game.score"
  55         :message="game.scoreMsg"
  56         :firstNum="firstMoveNumber"
  57         :moves="moves"
  58         :cursor="cursor"
  59         @goto-move="gotoMove"
  60       )
  61     .clearer
  62 </template>
  63
  64 <script>
  65 import Board from "@/components/Board.vue";
  66 import MoveList from "@/components/MoveList.vue";
  67 import { store } from "@/store";
  68 import { getSquareId } from "@/utils/squareId";
  69 import { getDate } from "@/utils/datetime";
  70 import { processModalClick } from "@/utils/modalClick";
  71 import { getScoreMessage } from "@/utils/scoring";
  72 import { getFullNotation } from "@/utils/notation";
  73 import { undoMove } from "@/utils/playUndo";
  74 export default {
  75   name: "my-base-game",
  76   components: {
  77     Board,
  78     MoveList
  79   },
  80   props: ["game"],
  81   data: function() {
  82     return {
  83       st: store.state,
  84       // NOTE: all following variables must be reset at the beginning of a game
  85       vr: null, //VariantRules object, game state
  86       endgameMessage: "",
  87       orientation: "w",
  88       score: "*", //'*' means 'unfinished'
  89       moves: [],
  90       // TODO: later, use subCursor to navigate intra-multimoves?
  91       cursor: -1, //index of the move just played
  92       lastMove: null,
  93       firstMoveNumber: 0, //for printing
  94       incheck: [], //for Board
  95       inMultimove: false
  96     };
  97   },
  98   watch: {
  99     // game initial FEN changes when a new game starts
 100     "game.fenStart": function() {
 101       this.re_setVariables();
 102     },
 103   },
 104   computed: {
 105     showMoves: function() {
 106       return this.game.score != "*"
 107         ? "all"
 108         : (this.vr ? this.vr.showMoves : "none");
 109     },
 110     showTurn: function() {
 111       return (
 112         this.game.score == '*' &&
 113         this.vr &&
 114         (this.vr.showMoves != "all" || !this.vr.canFlip)
 115       );
 116     },
 117     turn: function() {
 118       if (!this.vr)
 119         return "";
 120       if (this.vr.showMoves != "all")
 121         return this.st.tr[(this.vr.turn == 'w' ? "White" : "Black") + " to move"]
 122       // Cannot flip: racing king or circular chess
 123       return this.vr.movesCount == 0 && this.game.mycolor == "w"
 124         ? this.st.tr["It's your turn!"]
 125         : "";
 126     },
 127     canAnalyze: function() {
 128       return this.game.mode != "analyze" && this.vr && this.vr.canAnalyze;
 129     },
 130     canFlip: function() {
 131       return this.vr && this.vr.canFlip;
 132     },
 133     allowDownloadPGN: function() {
 134       return this.game.score != "*" || (this.vr && this.vr.showMoves == "all");
 135     }
 136   },
 137   created: function() {
 138     if (this.game.fenStart) this.re_setVariables();
 139   },
 140   mounted: function() {
 141     if (!("ontouchstart" in window)) {
 142       // Desktop browser:
 143       const baseGameDiv = document.getElementById("baseGame");
 144       baseGameDiv.tabIndex = 0;
 145       baseGameDiv.addEventListener("click", this.focusBg);
 146       baseGameDiv.addEventListener("keydown", this.handleKeys);
 147       baseGameDiv.addEventListener("wheel", this.handleScroll);
 148     }
 149     document.getElementById("eogDiv").addEventListener(
 150       "click",
 151       processModalClick);
 152   },
 153   methods: {
 154     focusBg: function() {
 155       document.getElementById("baseGame").focus();
 156     },
 157     handleKeys: function(e) {
 158       if ([32, 37, 38, 39, 40].includes(e.keyCode)) e.preventDefault();
 159       switch (e.keyCode) {
 160         case 37:
 161           this.undo();
 162           break;
 163         case 39:
 164           this.play();
 165           break;
 166         case 38:
 167           this.gotoBegin();
 168           break;
 169         case 40:
 170           this.gotoEnd();
 171           break;
 172         case 32:
 173           this.flip();
 174           break;
 175       }
 176     },
 177     handleScroll: function(e) {
 178       e.preventDefault();
 179       if (e.deltaY < 0) this.undo();
 180       else if (e.deltaY > 0) this.play();
 181     },
 182     showRules: function() {
 183       //this.$router.push("/variants/" + this.game.vname);
 184       window.open("#/variants/" + this.game.vname, "_blank"); //better
 185     },
 186     re_setVariables: function() {
 187       this.endgameMessage = "";
 188       // "w": default orientation for observed games
 189       this.orientation = this.game.mycolor || "w";
 190       this.moves = JSON.parse(JSON.stringify(this.game.moves || []));
 191       // Post-processing: decorate each move with notation and FEN
 192       this.vr = new V(this.game.fenStart);
 193       const parsedFen = V.ParseFen(this.game.fenStart);
 194       const firstMoveColor = parsedFen.turn;
 195       this.firstMoveNumber = Math.floor(parsedFen.movesCount / 2);
 196       this.moves.forEach(move => {
 197         // Strategy working also for multi-moves:
 198         if (!Array.isArray(move)) move = [move];
 199         move.forEach(m => {
 200           m.notation = this.vr.getNotation(m);
 201           this.vr.play(m);
 202         });
 203       });
 204       if (firstMoveColor == "b") {
 205         // 'start' & 'end' is required for Board component
 206         this.moves.unshift({
 207           notation: "...",
 208           start: { x: -1, y: -1 },
 209           end: { x: -1, y: -1 }
 210         });
 211       }
 212       this.positionCursorTo(this.moves.length - 1);
 213       this.incheck = this.vr.getCheckSquares(this.vr.turn);
 214     },
 215     positionCursorTo: function(index) {
 216       this.cursor = index;
 217       // Caution: last move in moves array might be a multi-move
 218       if (index >= 0) {
 219         if (Array.isArray(this.moves[index])) {
 220           const L = this.moves[index].length;
 221           this.lastMove = this.moves[index][L - 1];
 222         } else {
 223           this.lastMove = this.moves[index];
 224         }
 225       }
 226       else
 227         this.lastMove = null;
 228     },
 229     analyzePosition: function() {
 230       let newUrl =
 231         "/analyse/" +
 232         this.game.vname +
 233         "/?fen=" +
 234         this.vr.getFen().replace(/ /g, "_");
 235       if (this.game.mycolor)
 236         newUrl += "&side=" + this.game.mycolor;
 237       // Open in same tab in live games (against cheating)
 238       if (this.game.type == "live") this.$router.push(newUrl);
 239       else window.open("#" + newUrl);
 240     },
 241     download: function() {
 242       const content = this.getPgn();
 243       // Prepare and trigger download link
 244       let downloadAnchor = document.getElementById("download");
 245       downloadAnchor.setAttribute("download", "game.pgn");
 246       downloadAnchor.href =
 247         "data:text/plain;charset=utf-8," + encodeURIComponent(content);
 248       downloadAnchor.click();
 249     },
 250     getPgn: function() {
 251       let pgn = "";
 252       pgn += '[Site "vchess.club"]\n';
 253       pgn += '[Variant "' + this.game.vname + '"]\n';
 254       pgn += '[Date "' + getDate(new Date()) + '"]\n';
 255       pgn += '[White "' + this.game.players[0].name + '"]\n';
 256       pgn += '[Black "' + this.game.players[1].name + '"]\n';
 257       pgn += '[Fen "' + this.game.fenStart + '"]\n';
 258       pgn += '[Result "' + this.game.score + '"]\n\n';
 259       for (let i = 0; i < this.moves.length; i += 2) {
 260         pgn += (i/2+1) + "." + getFullNotation(this.moves[i]) + " ";
 261         if (i+1 < this.moves.length)
 262           pgn += getFullNotation(this.moves[i+1]) + " ";
 263       }
 264       return pgn + "\n";
 265     },
 266     showEndgameMsg: function(message) {
 267       this.endgameMessage = message;
 268       let modalBox = document.getElementById("modalEog");
 269       modalBox.checked = true;
 270       setTimeout(() => {
 271         modalBox.checked = false;
 272       }, 2000);
 273     },
 274     // Animate an elementary move
 275     animateMove: function(move, callback) {
 276       let startSquare = document.getElementById(getSquareId(move.start));
 277       let endSquare = document.getElementById(getSquareId(move.end));
 278       let rectStart = startSquare.getBoundingClientRect();
 279       let rectEnd = endSquare.getBoundingClientRect();
 280       let translation = {
 281         x: rectEnd.x - rectStart.x,
 282         y: rectEnd.y - rectStart.y
 283       };
 284       let movingPiece = document.querySelector(
 285         "#" + getSquareId(move.start) + " > img.piece"
 286       );
 287       // For some unknown reasons Opera get "movingPiece == null" error
 288       // TOOO: is it calling 'animate()' twice ? One extra time ?
 289       if (!movingPiece) return;
 290       // HACK for animation (with positive translate, image slides "under background")
 291       // Possible improvement: just alter squares on the piece's way...
 292       const squares = document.getElementsByClassName("board");
 293       for (let i = 0; i < squares.length; i++) {
 294         let square = squares.item(i);
 295         if (square.id != getSquareId(move.start)) square.style.zIndex = "-1";
 296       }
 297       movingPiece.style.transform =
 298         "translate(" + translation.x + "px," + translation.y + "px)";
 299       movingPiece.style.transitionDuration = "0.25s";
 300       movingPiece.style.zIndex = "3000";
 301       setTimeout(() => {
 302         for (let i = 0; i < squares.length; i++)
 303           squares.item(i).style.zIndex = "auto";
 304         movingPiece.style = {}; //required e.g. for 0-0 with KR swap
 305         callback();
 306       }, 250);
 307     },
 308     // For Analyse mode:
 309     emitFenIfAnalyze: function() {
 310       if (this.game.mode == "analyze") {
 311         this.$emit(
 312           "fenchange",
 313           this.lastMove ? this.lastMove.fen : this.game.fenStart
 314         );
 315       }
 316     },
 317     // "light": if gotoMove() or gotoEnd()
 318     // data: some custom data (addTime) to be re-emitted
 319     play: function(move, received, light, data) {
 320       const navigate = !move;
 321       const playSubmove = (smove) => {
 322         if (!navigate) smove.notation = this.vr.getNotation(smove);
 323         this.vr.play(smove);
 324         this.lastMove = smove;
 325         // Is opponent in check?
 326         this.incheck = this.vr.getCheckSquares(this.vr.turn);
 327         if (!navigate) {
 328           if (!this.inMultimove) {
 329             if (this.cursor < this.moves.length - 1)
 330               this.moves = this.moves.slice(0, this.cursor + 1);
 331             this.moves.push(smove);
 332             this.inMultimove = true; //potentially
 333             this.cursor++;
 334           } else {
 335             // Already in the middle of a multi-move
 336             const L = this.moves.length;
 337             if (!Array.isArray(this.moves[L-1]))
 338               this.$set(this.moves, L-1, [this.moves[L-1], smove]);
 339             else
 340               this.$set(this.moves, L-1, this.moves.concat([smove]));
 341           }
 342         }
 343       };
 344       const playMove = () => {
 345         const animate = V.ShowMoves == "all" && (received || navigate);
 346         if (!Array.isArray(move)) move = [move];
 347         let moveIdx = 0;
 348         let self = this;
 349         const initurn = this.vr.turn;
 350         (function executeMove() {
 351           const smove = move[moveIdx++];
 352           if (animate) {
 353             self.animateMove(smove, () => {
 354               playSubmove(smove);
 355               if (moveIdx < move.length)
 356                 setTimeout(executeMove, 500);
 357               else afterMove(smove, initurn);
 358             });
 359           } else {
 360             playSubmove(smove);
 361             if (moveIdx < move.length) executeMove();
 362             else afterMove(smove, initurn);
 363           }
 364         })();
 365       };
 366       const afterMove = (smove, initurn) => {
 367         if (this.vr.turn != initurn) {
 368           // Turn has changed: move is complete
 369           if (!smove.fen) {
 370             // NOTE: only FEN of last sub-move is required (thus setting it here)
 371             smove.fen = this.vr.getFen();
 372             this.emitFenIfAnalyze();
 373           }
 374           this.inMultimove = false;
 375           const score = this.vr.getCurrentScore();
 376           if (score != "*") {
 377             const message = getScoreMessage(score);
 378             if (!navigate && this.game.mode != "analyze")
 379               this.$emit("gameover", score, message);
 380             else if (this.game.mode == "analyze")
 381               // Just show score on screen (allow undo)
 382               this.showEndgameMsg(score + " . " + this.st.tr[message]);
 383           }
 384           if (!navigate && this.game.mode != "analyze") {
 385             const L = this.moves.length;
 386             // Post-processing (e.g. computer play)
 387             this.$emit("newmove", this.moves[L-1], data);
 388           }
 389         }
 390       };
 391       // NOTE: navigate and received are mutually exclusive
 392       if (navigate) {
 393         // The move to navigate to is necessarily full:
 394         if (this.cursor == this.moves.length - 1) return; //no more moves
 395         move = this.moves[this.cursor + 1];
 396         if (light) {
 397           // Just play the move, nothing else:
 398           if (!Array.isArray(move)) move = [move];
 399           for (let i=0; i < move.length; i++) this.vr.play(move[i]);
 400         }
 401         else {
 402           playMove();
 403           this.emitFenIfAnalyze();
 404         }
 405         this.cursor++;
 406         return;
 407       }
 408       // Forbid playing outside analyze mode, except if move is received.
 409       // Sufficient condition because Board already knows which turn it is.
 410       if (
 411         this.game.mode != "analyze" &&
 412         !received &&
 413         (this.game.score != "*" || this.cursor < this.moves.length - 1)
 414       ) {
 415         return;
 416       }
 417       // To play a received move, cursor must be at the end of the game:
 418       if (received && this.cursor < this.moves.length - 1)
 419         this.gotoEnd();
 420       playMove();
 421     },
 422     cancelCurrentMultimove: function() {
 423       const L = this.moves.length;
 424       let move = this.moves[L-1];
 425       if (!Array.isArray(move)) move = [move];
 426       for (let i=move.length -1; i >= 0; i--) this.vr.undo(move[i]);
 427       this.moves.pop();
 428       this.cursor--;
 429       this.inMultimove = false;
 430     },
 431     cancelLastMove: function() {
 432       // The last played move was canceled (corr game)
 433       this.undo();
 434       this.moves.pop();
 435     },
 436     // "light": if gotoMove() or gotoBegin()
 437     undo: function(move, light) {
 438       if (this.inMultimove) {
 439         this.cancelCurrentMultimove();
 440         this.incheck = this.vr.getCheckSquares(this.vr.turn);
 441       } else {
 442         if (!move) {
 443           if (this.cursor < 0) return; //no more moves
 444           move = this.moves[this.cursor];
 445         }
 446         // Caution; if multi-move, undo all submoves from last to first
 447         undoMove(move, this.vr);
 448         if (light) this.cursor--;
 449         else {
 450           this.positionCursorTo(this.cursor - 1);
 451           this.incheck = this.vr.getCheckSquares(this.vr.turn);
 452           this.emitFenIfAnalyze();
 453         }
 454       }
 455     },
 456     gotoMove: function(index) {
 457       if (this.inMultimove) this.cancelCurrentMultimove();
 458       if (index == this.cursor) return;
 459       if (index < this.cursor) {
 460         while (this.cursor > index)
 461           this.undo(null, null, "light");
 462       }
 463       else {
 464         // index > this.cursor)
 465         while (this.cursor < index)
 466           this.play(null, null, "light");
 467       }
 468       // NOTE: next line also re-assign cursor, but it's very light
 469       this.positionCursorTo(index);
 470       this.incheck = this.vr.getCheckSquares(this.vr.turn);
 471       this.emitFenIfAnalyze();
 472     },
 473     gotoBegin: function() {
 474       if (this.inMultimove) this.cancelCurrentMultimove();
 475       while (this.cursor >= 0)
 476         this.undo(null, null, "light");
 477       if (this.moves.length > 0 && this.moves[0].notation == "...") {
 478         this.cursor = 0;
 479         this.lastMove = this.moves[0];
 480       } else {
 481         this.lastMove = null;
 482       }
 483       this.incheck = [];
 484       this.emitFenIfAnalyze();
 485     },
 486     gotoEnd: function() {
 487       if (this.cursor == this.moves.length - 1) return;
 488       this.gotoMove(this.moves.length - 1);
 489       this.emitFenIfAnalyze();
 490     },
 491     flip: function() {
 492       this.orientation = V.GetOppCol(this.orientation);
 493     }
 494   }
 495 };
 496 </script>
 497
 498 <style lang="sass" scoped>
 499 [type="checkbox"]#modalEog+div .card
 500   min-height: 45px
 501
 502 #baseGame
 503   width: 100%
 504   &:focus
 505     outline: none
 506
 507 #gameContainer
 508   margin-left: auto
 509   margin-right: auto
 510
 511 #downloadDiv
 512   display: inline-block
 513
 514 #controls
 515   margin: 0 auto
 516   text-align: center
 517   display: flex
 518   button
 519     display: inline-block
 520     width: 20%
 521     margin: 0
 522     img.inline
 523       height: 24px
 524       padding-top: 5px
 525     @media screen and (max-width: 767px)
 526       img.inline
 527         height: 18px
 528
 529 #turnIndicator
 530   text-align: center
 531   font-weight: bold
 532
 533 #belowControls
 534   border-top: 1px solid #2f4f4f
 535   text-align: center
 536   margin: 0 auto
 537   & > #downloadDiv
 538     margin: 0
 539     & > button
 540       margin: 0
 541   & > button
 542     border-left: 1px solid #2f4f4f
 543     margin: 0
 544
 545 #boardContainer
 546   float: left
 547 // TODO: later, maybe, allow movesList of variable width
 548 // or e.g. between 250 and 350px (but more complicated)
 549
 550 #movesList
 551   width: 280px
 552   float: left
 553
 554 @media screen and (max-width: 767px)
 555   #movesList
 556     width: 100%
 557     float: none
 558     clear: both
 559 </style>