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