cf4d7629adc7cc5448028794e32cead56ed651cb
[vchess.git] / 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="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 @click-square="clickSquare"
25 )
26 #turnIndicator(v-if="showTurn") {{ turn }}
27 #controls.button-group
28 button(@click="gotoBegin()")
29 img.inline(src="/images/icons/fast-forward_rev.svg")
30 button(@click="undo()")
31 img.inline(src="/images/icons/play_rev.svg")
32 button(v-if="canFlip" @click="flip()")
33 img.inline(src="/images/icons/flip.svg")
34 button(
35 @click="runAutoplay()"
36 :class="{'in-autoplay': autoplay}"
37 )
38 img.inline(src="/images/icons/autoplay.svg")
39 button(@click="play()")
40 img.inline(src="/images/icons/play.svg")
41 button(@click="gotoEnd()")
42 img.inline(src="/images/icons/fast-forward.svg")
43 p(v-show="showFen") {{ (!!vr ? vr.getFen() : "") }}
44 #movesList
45 MoveList(
46 :show="showMoves"
47 :canAnalyze="canAnalyze"
48 :canDownload="allowDownloadPGN"
49 :score="game.score"
50 :message="game.scoreMsg"
51 :firstNum="firstMoveNumber"
52 :moves="moves"
53 :cursor="cursor"
54 @download="download"
55 @showrules="showRules"
56 @analyze="toggleAnalyze"
57 @goto-move="gotoMove"
58 @reset-arrows="resetArrows"
59 )
60 .clearer
61 </template>
62
63 <script>
64 import Board from "@/components/Board.vue";
65 import MoveList from "@/components/MoveList.vue";
66 import params from "@/parameters";
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 mode: "",
89 score: "*", //'*' means 'unfinished'
90 moves: [],
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 autoplay: false,
97 autoplayLoop: null,
98 inPlay: false,
99 stackToPlay: []
100 };
101 },
102 computed: {
103 turn: function() {
104 if (!this.vr) return "";
105 if (this.vr.showMoves != "all") {
106 return this.st.tr[
107 (this.vr.turn == 'w' ? "White" : "Black") + " to move"];
108 }
109 // Cannot flip: racing king or circular chess
110 return (
111 this.vr.movesCount == 0 && this.game.mycolor == "w"
112 ? this.st.tr["It's your turn!"]
113 : ""
114 );
115 },
116 showFen: function() {
117 return (
118 this.mode == "analyze" &&
119 this.$router.currentRoute.path.indexOf("/analyse") === -1
120 );
121 },
122 // TODO: is it OK to pass "computed" as properties?
123 // Also, some are seemingly not recomputed when vr is initialized.
124 showMoves: function() {
125 return this.game.score != "*"
126 ? "all"
127 : (!!this.vr ? this.vr.showMoves : "none");
128 },
129 showTurn: function() {
130 return (
131 this.game.score == '*' &&
132 !!this.vr && (this.vr.showMoves != "all" || !this.vr.canFlip)
133 );
134 },
135 canAnalyze: function() {
136 return (
137 this.game.mode != "analyze" &&
138 !!this.vr && this.vr.canAnalyze
139 );
140 },
141 canFlip: function() {
142 return !!this.vr && this.vr.canFlip;
143 },
144 allowDownloadPGN: function() {
145 return (
146 this.game.score != "*" ||
147 (!!this.vr && this.vr.showMoves == "all")
148 );
149 }
150 },
151 created: function() {
152 if (!!this.game.fenStart) this.re_setVariables();
153 },
154 mounted: function() {
155 if (!("ontouchstart" in window)) {
156 // Desktop browser:
157 const baseGameDiv = document.getElementById("baseGame");
158 baseGameDiv.tabIndex = 0;
159 baseGameDiv.addEventListener("click", this.focusBg);
160 baseGameDiv.addEventListener("keydown", this.handleKeys);
161 baseGameDiv.addEventListener("wheel", this.handleScroll);
162 }
163 document.getElementById("eogDiv")
164 .addEventListener("click", processModalClick);
165 },
166 beforeDestroy: function() {
167 if (!!this.autoplayLoop) clearInterval(this.autoplayLoop);
168 },
169 methods: {
170 focusBg: function() {
171 document.getElementById("baseGame").focus();
172 },
173 handleKeys: function(e) {
174 if ([32, 37, 38, 39, 40].includes(e.keyCode)) e.preventDefault();
175 switch (e.keyCode) {
176 case 37:
177 this.undo();
178 break;
179 case 39:
180 this.play();
181 break;
182 case 38:
183 this.gotoBegin();
184 break;
185 case 40:
186 this.gotoEnd();
187 break;
188 case 32:
189 this.flip();
190 break;
191 }
192 },
193 handleScroll: function(e) {
194 e.preventDefault();
195 if (e.deltaY < 0) this.undo();
196 else if (e.deltaY > 0) this.play();
197 },
198 resetArrows: function() {
199 // TODO: make arrows scale with board, and remove this
200 this.$refs["board"].cancelResetArrows();
201 },
202 showRules: function() {
203 // The button is here only on Game page:
204 document.getElementById("modalRules").checked = true;
205 },
206 re_setVariables: function(game) {
207 if (!game) game = this.game; //in case of...
208 this.endgameMessage = "";
209 // "w": default orientation for observed games
210 this.orientation = game.mycolor || "w";
211 this.mode = game.mode || game.type; //TODO: merge...
212 this.moves = JSON.parse(JSON.stringify(game.moves || []));
213 // Post-processing: decorate each move with notation and FEN
214 this.vr = new V(game.fenStart);
215 const parsedFen = V.ParseFen(game.fenStart);
216 const firstMoveColor = parsedFen.turn;
217 this.firstMoveNumber = Math.floor(parsedFen.movesCount / 2) + 1;
218 let L = this.moves.length;
219 this.moves.forEach((move,idx) => {
220 // Strategy working also for multi-moves:
221 if (!Array.isArray(move)) move = [move];
222 const Lm = move.length;
223 move.forEach((m,idxM) => {
224 m.notation = this.vr.getNotation(m);
225 m.unambiguous = V.GetUnambiguousNotation(m);
226 this.vr.play(m);
227 const checkSquares = this.vr.getCheckSquares();
228 if (checkSquares.length > 0) m.notation += "+";
229 if (idxM == Lm - 1) m.fen = this.vr.getFen();
230 if (idx == L - 1 && idxM == Lm - 1) {
231 this.incheck = checkSquares;
232 const score = this.vr.getCurrentScore();
233 if (["1-0", "0-1"].includes(score)) m.notation += "#";
234 }
235 });
236 });
237 if (firstMoveColor == "b") {
238 // 'start' & 'end' is required for Board component
239 this.moves.unshift({
240 notation: "...",
241 unambiguous: "...",
242 start: { x: -1, y: -1 },
243 end: { x: -1, y: -1 },
244 fen: game.fenStart
245 });
246 L++;
247 }
248 this.positionCursorTo(L - 1);
249 },
250 positionCursorTo: function(index) {
251 this.cursor = index;
252 // Note: last move in moves array might be a multi-move
253 if (index >= 0) this.lastMove = this.moves[index];
254 else this.lastMove = null;
255 },
256 toggleAnalyze: function() {
257 if (this.mode != "analyze") {
258 // Enter analyze mode:
259 this.gameMode = this.mode; //was not 'analyze'
260 this.mode = "analyze";
261 this.gameCursor = this.cursor;
262 this.gameMoves = JSON.parse(JSON.stringify(this.moves));
263 document.getElementById("analyzeBtn").classList.add("active");
264 }
265 else {
266 // Exit analyze mode:
267 this.mode = this.gameMode ;
268 this.cursor = this.gameCursor;
269 this.moves = this.gameMoves;
270 let fen = this.game.fenStart;
271 if (this.cursor >= 0) {
272 let mv = this.moves[this.cursor];
273 if (!Array.isArray(mv)) mv = [mv];
274 fen = mv[mv.length-1].fen;
275 }
276 this.vr = new V(fen);
277 this.incheck = this.vr.getCheckSquares();
278 if (this.cursor >= 0) this.lastMove = this.moves[this.cursor];
279 else this.lastMove = null;
280 document.getElementById("analyzeBtn").classList.remove("active");
281 }
282 },
283 download: function() {
284 const content = this.getPgn();
285 // Prepare and trigger download link
286 let downloadAnchor = document.getElementById("download");
287 downloadAnchor.setAttribute("download", "game.pgn");
288 downloadAnchor.href =
289 "data:text/plain;charset=utf-8," + encodeURIComponent(content);
290 downloadAnchor.click();
291 },
292 getPgn: function() {
293 let pgn = "";
294 pgn += '[Site "vchess.club"]\n';
295 pgn += '[Variant "' + this.game.vname + '"]\n';
296 const gdt = getDate(new Date(this.game.created || Date.now()));
297 pgn += '[Date "' + gdt + '"]\n';
298 pgn += '[White "' + this.game.players[0].name + '"]\n';
299 pgn += '[Black "' + this.game.players[1].name + '"]\n';
300 pgn += '[Fen "' + this.game.fenStart + '"]\n';
301 pgn += '[Result "' + this.game.score + '"]\n';
302 if (!!this.game.id)
303 pgn += '[Url "' + params.serverUrl + '/game/' + this.game.id + '"]\n';
304 if (!!this.game.cadence)
305 pgn += '[Cadence "' + this.game.cadence + '"]\n';
306 pgn += '\n';
307 for (let i = 0; i < this.moves.length; i += 2) {
308 if (i > 0) pgn += " ";
309 // Adjust dots notation for a better display:
310 let fullNotation = getFullNotation(this.moves[i]);
311 if (fullNotation == "...") fullNotation = "..";
312 pgn += (i / 2 + this.firstMoveNumber) + "." + fullNotation;
313 if (i+1 < this.moves.length)
314 pgn += " " + getFullNotation(this.moves[i+1]);
315 }
316 pgn += "\n\n";
317 for (let i = 0; i < this.moves.length; i += 2) {
318 const moveNumber = i / 2 + this.firstMoveNumber;
319 // Skip "dots move", useless for machine reading:
320 if (this.moves[i].notation != "...") {
321 pgn += moveNumber + ".w " +
322 getFullNotation(this.moves[i], "unambiguous") + "\n";
323 }
324 if (i+1 < this.moves.length) {
325 pgn += moveNumber + ".b " +
326 getFullNotation(this.moves[i+1], "unambiguous") + "\n";
327 }
328 }
329 return pgn;
330 },
331 showEndgameMsg: function(message) {
332 this.endgameMessage = message;
333 document.getElementById("modalEog").checked = true;
334 },
335 runAutoplay: function() {
336 const infinitePlay = () => {
337 if (this.cursor == this.moves.length - 1) {
338 clearInterval(this.autoplayLoop);
339 this.autoplayLoop = null;
340 this.autoplay = false;
341 return;
342 }
343 if (this.inPlay || this.inMultimove)
344 // Wait next tick
345 return;
346 this.play();
347 };
348 if (this.autoplay) {
349 this.autoplay = false;
350 clearInterval(this.autoplayLoop);
351 this.autoplayLoop = null;
352 } else {
353 this.autoplay = true;
354 setTimeout(
355 () => {
356 infinitePlay();
357 this.autoplayLoop = setInterval(infinitePlay, 1500);
358 },
359 // Small delay otherwise the first move is played too fast
360 500
361 );
362 }
363 },
364 // Animate an elementary move
365 animateMove: function(move, callback) {
366 let startSquare = document.getElementById(getSquareId(move.start));
367 if (!startSquare) return; //shouldn't happen but...
368 let endSquare = document.getElementById(getSquareId(move.end));
369 let rectStart = startSquare.getBoundingClientRect();
370 let rectEnd = endSquare.getBoundingClientRect();
371 let translation = {
372 x: rectEnd.x - rectStart.x,
373 y: rectEnd.y - rectStart.y
374 };
375 let movingPiece = document.querySelector(
376 "#" + getSquareId(move.start) + " > img.piece"
377 );
378 // For some unknown reasons Opera get "movingPiece == null" error
379 // TODO: is it calling 'animate()' twice ? One extra time ?
380 if (!movingPiece) return;
381 const squares = document.getElementsByClassName("board");
382 for (let i = 0; i < squares.length; i++) {
383 let square = squares.item(i);
384 if (square.id != getSquareId(move.start))
385 // HACK for animation:
386 // (with positive translate, image slides "under background")
387 square.style.zIndex = "-1";
388 }
389 movingPiece.style.transform =
390 "translate(" + translation.x + "px," + translation.y + "px)";
391 movingPiece.style.transitionDuration = "0.25s";
392 movingPiece.style.zIndex = "3000";
393 setTimeout(() => {
394 for (let i = 0; i < squares.length; i++)
395 squares.item(i).style.zIndex = "auto";
396 movingPiece.style = {}; //required e.g. for 0-0 with KR swap
397 callback();
398 }, 250);
399 },
400 // For Analyse mode:
401 emitFenIfAnalyze: function() {
402 if (this.game.mode == "analyze") {
403 let fen = this.game.fenStart;
404 if (!!this.lastMove) {
405 if (Array.isArray(this.lastMove)) {
406 const L = this.lastMove.length;
407 fen = this.lastMove[L-1].fen;
408 }
409 else fen = this.lastMove.fen;
410 }
411 this.$emit("fenchange", fen);
412 }
413 },
414 clickSquare: function(square) {
415 // Some variants make use of a single click at specific times:
416 const move = this.vr.doClick(square);
417 if (!!move) this.play(move);
418 },
419 // "light": if gotoMove() or gotoEnd()
420 play: function(move, received, light, noemit) {
421 // Freeze while choices are shown:
422 if (this.$refs["board"].choices.length > 0) return;
423 const navigate = !move;
424 // Forbid playing outside analyze mode, except if move is received.
425 // Sufficient condition because Board already knows which turn it is.
426 if (
427 this.mode != "analyze" &&
428 !navigate &&
429 !received &&
430 (this.game.score != "*" || this.cursor < this.moves.length - 1)
431 ) {
432 return;
433 }
434 if (!!received) {
435 if (this.mode == "analyze") this.toggleAnalyze();
436 if (this.cursor < this.moves.length - 1)
437 // To play a received move, cursor must be at the end of the game:
438 this.gotoEnd();
439 }
440 if (!!noemit) {
441 if (this.inPlay) {
442 // Received moves in observed games can arrive too fast:
443 this.stackToPlay.unshift(move);
444 return;
445 }
446 this.inPlay = true;
447 }
448 // The board may show some the possible moves: (TODO: bad solution)
449 this.$refs["board"].resetCurrentAttempt();
450 const playSubmove = (smove) => {
451 smove.notation = this.vr.getNotation(smove);
452 smove.unambiguous = V.GetUnambiguousNotation(smove);
453 this.vr.play(smove);
454 if (this.inMultimove && !!this.lastMove) {
455 if (!Array.isArray(this.lastMove))
456 this.lastMove = [this.lastMove, smove];
457 else this.lastMove.push(smove);
458 }
459 // Is opponent (or me) in check?
460 this.incheck = this.vr.getCheckSquares();
461 if (this.incheck.length > 0) smove.notation += "+";
462 if (!this.inMultimove) {
463 // First sub-move:
464 this.lastMove = smove;
465 // Condition is "!navigate" but we mean "!this.autoplay"
466 if (!navigate) {
467 if (this.cursor < this.moves.length - 1)
468 this.moves = this.moves.slice(0, this.cursor + 1);
469 this.moves.push(smove);
470 }
471 this.inMultimove = true; //potentially
472 this.cursor++;
473 } else if (!navigate) {
474 // Already in the middle of a multi-move
475 const L = this.moves.length;
476 if (!Array.isArray(this.moves[L-1]))
477 this.$set(this.moves, L-1, [this.moves[L-1], smove]);
478 else this.moves[L-1].push(smove);
479 }
480 };
481 const playMove = () => {
482 const animate = (
483 ["all", "highlight"].includes(V.ShowMoves) &&
484 (this.autoplay || !!received)
485 );
486 if (!Array.isArray(move)) move = [move];
487 let moveIdx = 0;
488 let self = this;
489 const initurn = this.vr.turn;
490 (function executeMove() {
491 const smove = move[moveIdx++];
492 // NOTE: condition "smove.start.x >= 0" required for Dynamo,
493 // because second move may be empty.
494 if (animate && smove.start.x >= 0) {
495 self.animateMove(smove, () => {
496 playSubmove(smove);
497 if (moveIdx < move.length)
498 setTimeout(executeMove, 500);
499 else afterMove(smove, initurn);
500 });
501 } else {
502 playSubmove(smove);
503 if (moveIdx < move.length) executeMove();
504 else afterMove(smove, initurn);
505 }
506 })();
507 };
508 const computeScore = () => {
509 const score = this.vr.getCurrentScore();
510 if (!navigate) {
511 if (["1-0","0-1"].includes(score)) {
512 if (Array.isArray(this.lastMove)) {
513 const L = this.lastMove.length;
514 this.lastMove[L - 1].notation += "#";
515 }
516 else this.lastMove.notation += "#";
517 }
518 }
519 if (score != "*" && this.mode == "analyze") {
520 const message = getScoreMessage(score);
521 // Just show score on screen (allow undo)
522 this.showEndgameMsg(score + " . " + this.st.tr[message]);
523 }
524 return score;
525 };
526 const afterMove = (smove, initurn) => {
527 if (this.vr.turn != initurn) {
528 // Turn has changed: move is complete
529 if (!smove.fen)
530 // NOTE: only FEN of last sub-move is required (=> setting it here)
531 smove.fen = this.vr.getFen();
532 this.emitFenIfAnalyze();
533 this.inMultimove = false;
534 this.score = computeScore();
535 if (this.mode != "analyze" && !navigate) {
536 if (!noemit && this.mode != "analyze") {
537 // Post-processing (e.g. computer play).
538 const L = this.moves.length;
539 // NOTE: always emit the score, even in unfinished,
540 // to tell Game::processMove() that it's not a received move.
541 this.$emit("newmove", this.moves[L-1], { score: this.score });
542 } else {
543 this.inPlay = false;
544 if (this.stackToPlay.length > 0)
545 // Move(s) arrived in-between
546 this.play(this.stackToPlay.pop(), received, light, noemit);
547 }
548 }
549 }
550 };
551 // NOTE: navigate and received are mutually exclusive
552 if (navigate) {
553 // The move to navigate to is necessarily full:
554 if (this.cursor == this.moves.length - 1) return; //no more moves
555 move = this.moves[this.cursor + 1];
556 if (!this.autoplay) {
557 // Just play the move:
558 if (!Array.isArray(move)) move = [move];
559 for (let i=0; i < move.length; i++) this.vr.play(move[i]);
560 if (!light) {
561 this.lastMove = move;
562 this.incheck = this.vr.getCheckSquares();
563 this.score = computeScore();
564 this.emitFenIfAnalyze();
565 }
566 this.cursor++;
567 return;
568 }
569 }
570 playMove();
571 },
572 cancelCurrentMultimove: function() {
573 const L = this.moves.length;
574 let move = this.moves[L-1];
575 if (!Array.isArray(move)) move = [move];
576 for (let i = move.length - 1; i >= 0; i--) this.vr.undo(move[i]);
577 this.moves.pop();
578 this.cursor--;
579 this.inMultimove = false;
580 },
581 cancelLastMove: function() {
582 // The last played move was canceled (corr game)
583 this.undo();
584 this.moves.pop();
585 },
586 // "light": if gotoMove() or gotoBegin()
587 undo: function(move, light) {
588 // Freeze while choices are shown:
589 if (this.$refs["board"].choices.length > 0) return;
590 this.$refs["board"].resetCurrentAttempt();
591 if (this.inMultimove) {
592 this.cancelCurrentMultimove();
593 this.incheck = this.vr.getCheckSquares();
594 } else {
595 if (!move) {
596 const minCursor =
597 this.moves.length > 0 && this.moves[0].notation == "..."
598 ? 1
599 : 0;
600 if (this.cursor < minCursor) return; //no more moves
601 move = this.moves[this.cursor];
602 }
603 this.$refs["board"].resetCurrentAttempt();
604 undoMove(move, this.vr);
605 if (light) this.cursor--;
606 else {
607 this.positionCursorTo(this.cursor - 1);
608 this.incheck = this.vr.getCheckSquares();
609 this.emitFenIfAnalyze();
610 }
611 }
612 },
613 gotoMove: function(index) {
614 if (this.$refs["board"].choices.length > 0) return;
615 this.$refs["board"].resetCurrentAttempt();
616 if (this.inMultimove) this.cancelCurrentMultimove();
617 if (index == this.cursor) return;
618 if (index < this.cursor) {
619 while (this.cursor > index)
620 this.undo(null, null, "light");
621 }
622 else {
623 // index > this.cursor)
624 while (this.cursor < index)
625 this.play(null, null, "light");
626 }
627 // NOTE: next line also re-assign cursor, but it's very light
628 this.positionCursorTo(index);
629 this.incheck = this.vr.getCheckSquares();
630 this.emitFenIfAnalyze();
631 },
632 gotoBegin: function() {
633 if (this.$refs["board"].choices.length > 0) return;
634 this.$refs["board"].resetCurrentAttempt();
635 if (this.inMultimove) this.cancelCurrentMultimove();
636 const minCursor =
637 this.moves.length > 0 && this.moves[0].notation == "..."
638 ? 1
639 : 0;
640 while (this.cursor >= minCursor) this.undo(null, null, "light");
641 this.lastMove = (minCursor == 1 ? this.moves[0] : null);
642 this.incheck = this.vr.getCheckSquares();
643 this.emitFenIfAnalyze();
644 },
645 gotoEnd: function() {
646 if (this.$refs["board"].choices.length > 0) return;
647 this.$refs["board"].resetCurrentAttempt();
648 if (this.cursor == this.moves.length - 1) return;
649 this.gotoMove(this.moves.length - 1);
650 this.emitFenIfAnalyze();
651 },
652 flip: function() {
653 if (this.$refs["board"].choices.length > 0) return;
654 this.orientation = V.GetOppCol(this.orientation);
655 }
656 }
657 };
658 </script>
659
660 <style lang="sass" scoped>
661 [type="checkbox"]#modalEog+div .card
662 min-height: 45px
663
664 #baseGame
665 width: 100%
666 &:focus
667 outline: none
668
669 #gameContainer
670 margin-left: auto
671 margin-right: auto
672
673 #downloadDiv
674 display: inline-block
675
676 #controls
677 user-select: none
678 button
679 border: none
680 margin: 0
681 padding-top: 5px
682 padding-bottom: 5px
683
684 .in-autoplay
685 background-color: #FACF8C
686
687 img.inline
688 height: 22px
689 padding-top: 5px
690 @media screen and (max-width: 767px)
691 height: 18px
692
693 #turnIndicator
694 text-align: center
695 font-weight: bold
696
697 #boardContainer
698 float: left
699 // TODO: later, maybe, allow movesList of variable width
700 // or e.g. between 250 and 350px (but more complicated)
701
702 #movesList
703 width: 280px
704 float: left
705
706 @media screen and (max-width: 767px)
707 #movesList
708 width: 100%
709 float: none
710 clear: both
711 </style>