server/models/Game.js

   1 const db = require("../utils/database");
   2 const UserModel = require("./User");
   3
   4 /*
   5  * Structure table Games:
   6  *   id: game id (int)
   7  *   vid: integer (variant id)
   8  *   fenStart: varchar (initial position)
   9  *   fen: varchar (current position)
  10  *   white: integer
  11  *   black: integer
  12  *   cadence: string
  13  *   score: varchar (result)
  14  *   scoreMsg: varchar ("Time", "Mutual agreement"...)
  15  *   created: datetime
  16  *   drawOffer: char ('w','b' or '' for none)
  17  *   rematchOffer: char (similar to drawOffer)
  18  *   randomness: integer
  19  *   deletedByWhite: boolean
  20  *   deletedByBlack: boolean
  21  *   chatReadWhite: datetime
  22  *   chatReadBlack: datetime
  23  *
  24  * Structure table Moves:
  25  *   gid: ref game id
  26  *   squares: varchar (description)
  27  *   played: datetime
  28  *   idx: integer
  29  *
  30  * Structure table Chats:
  31  *   gid: game id (int)
  32  *   msg: varchar
  33  *   name: varchar
  34  *   added: datetime
  35  */
  36
  37 const GameModel = {
  38
  39   checkGameInfo: function(g) {
  40     return (
  41       g.vid.toString().match(/^[0-9]+$/) &&
  42       g.cadence.match(/^[0-9dhms +]+$/) &&
  43       g.randomness.toString().match(/^[0-2]$/) &&
  44       g.fen.match(/^[a-zA-Z0-9, /-]*$/) &&
  45       g.players.length == 2 &&
  46       g.players.every(p => p.id.toString().match(/^[0-9]+$/))
  47     );
  48   },
  49
  50   incrementCounter: function(vid, cb) {
  51     db.serialize(function() {
  52       let query =
  53         "UPDATE GameStat " +
  54         "SET total = total + 1 " +
  55         "WHERE vid = " + vid;
  56       db.run(query, cb);
  57     });
  58   },
  59
  60   create: function(vid, fen, randomness, cadence, players, cb) {
  61     db.serialize(function() {
  62       let query =
  63         "INSERT INTO Games " +
  64         "(" +
  65           "vid, fenStart, fen, randomness, " +
  66           "white, black, " +
  67           "cadence, created" +
  68         ") " +
  69         "VALUES " +
  70         "(" +
  71           vid + ",'" + fen + "','" + fen + "'," + randomness + "," +
  72           players[0].id + "," + players[1].id + "," +
  73           "'" + cadence + "'," + Date.now() +
  74         ")";
  75       db.run(query, function(err) {
  76         cb(err, { id: this.lastID });
  77       });
  78     });
  79   },
  80
  81   // TODO: some queries here could be async
  82   getOne: function(id, cb) {
  83     // NOTE: ignoring errors (shouldn't happen at this stage)
  84     db.serialize(function() {
  85       let query =
  86         "SELECT " +
  87           "id, vid, fen, fenStart, cadence, created, " +
  88           "white, black, randomness, score, scoreMsg, " +
  89           "chatReadWhite, chatReadBlack, drawOffer, rematchOffer " +
  90         "FROM Games " +
  91         "WHERE id = " + id;
  92       db.get(query, (err, gameInfo) => {
  93         if (!gameInfo) {
  94           cb(err || { errmsg: "Game not found" }, undefined);
  95           return;
  96         }
  97         query =
  98           "SELECT id, name " +
  99           "FROM Users " +
 100           "WHERE id IN (" + gameInfo.white + "," + gameInfo.black + ")";
 101         db.all(query, (err2, players) => {
 102           if (players[0].id == gameInfo.black) players = players.reverse();
 103           // The original players' IDs info isn't required anymore
 104           delete gameInfo["white"];
 105           delete gameInfo["black"];
 106           query =
 107             "SELECT squares, played, idx " +
 108             "FROM Moves " +
 109             "WHERE gid = " + id;
 110           db.all(query, (err3, moves) => {
 111             query =
 112               "SELECT msg, name, added " +
 113               "FROM Chats " +
 114               "WHERE gid = " + id;
 115             db.all(query, (err4, chats) => {
 116               const game = Object.assign(
 117                 {
 118                   players: players,
 119                   moves: moves,
 120                   chats: chats
 121                 },
 122                 gameInfo
 123               );
 124               cb(null, game);
 125             });
 126           });
 127         });
 128       });
 129     });
 130   },
 131
 132   // For display on Hall: no need for moves or chats
 133   getObserved: function(uid, cursor, cb) {
 134     db.serialize(function() {
 135       let query =
 136         "SELECT id, vid, cadence, created, score, white, black " +
 137         "FROM Games " +
 138         "WHERE created < " + cursor + " ";
 139       if (uid > 0) {
 140         query +=
 141           "  AND white <> " + uid + " " +
 142           "  AND black <> " + uid + " ";
 143       }
 144       query +=
 145         "ORDER BY created DESC " +
 146         "LIMIT 20"; //TODO: 20 hard-coded...
 147       db.all(query, (err, games) => {
 148         // Query players names
 149         let pids = {};
 150         games.forEach(g => {
 151           if (!pids[g.white]) pids[g.white] = true;
 152           if (!pids[g.black]) pids[g.black] = true;
 153         });
 154         UserModel.getByIds(Object.keys(pids), (err2, users) => {
 155           let names = {};
 156           users.forEach(u => { names[u.id] = u.name; });
 157           cb(
 158             err,
 159             games.map(
 160               g => {
 161                 return {
 162                   id: g.id,
 163                   vid: g.vid,
 164                   cadence: g.cadence,
 165                   created: g.created,
 166                   score: g.score,
 167                   players: [
 168                     { id: g.white, name: names[g.white] },
 169                     { id: g.black, name: names[g.black] }
 170                   ]
 171                 };
 172               }
 173             )
 174           );
 175         });
 176       });
 177     });
 178   },
 179
 180   // For display on MyGames: registered user only
 181   getRunning: function(uid, cb) {
 182     db.serialize(function() {
 183       let query =
 184         "SELECT id, vid, cadence, created, white, black " +
 185         "FROM Games " +
 186         "WHERE score = '*' AND (white = " + uid + " OR black = " + uid + ")";
 187       db.all(query, (err, games) => {
 188         // Get movesCount (could be done in // with next query)
 189         query =
 190           "SELECT gid, COUNT(*) AS nbMoves " +
 191           "FROM Moves " +
 192           "WHERE gid IN " + "(" + games.map(g => g.id).join(",") + ") " +
 193           "GROUP BY gid";
 194         db.all(query, (err, mstats) => {
 195           let movesCounts = {};
 196           mstats.forEach(ms => { movesCounts[ms.gid] = ms.nbMoves; });
 197           // Query player names
 198           let pids = {};
 199           games.forEach(g => {
 200             if (!pids[g.white]) pids[g.white] = true;
 201             if (!pids[g.black]) pids[g.black] = true;
 202           });
 203           UserModel.getByIds(Object.keys(pids), (err2, users) => {
 204             let names = {};
 205             users.forEach(u => { names[u.id] = u.name; });
 206             cb(
 207               null,
 208               games.map(
 209                 g => {
 210                   return {
 211                     id: g.id,
 212                     vid: g.vid,
 213                     cadence: g.cadence,
 214                     created: g.created,
 215                     score: g.score,
 216                     movesCount: movesCounts[g.id] || 0,
 217                     players: [
 218                       { id: g.white, name: names[g.white] },
 219                       { id: g.black, name: names[g.black] }
 220                     ]
 221                   };
 222                 }
 223               )
 224             );
 225           });
 226         });
 227       });
 228     });
 229   },
 230
 231   // These games could be deleted on some side. movesCount not required
 232   getCompleted: function(uid, cursor, cb) {
 233     db.serialize(function() {
 234       let query =
 235         "SELECT id, vid, cadence, created, score, scoreMsg, " +
 236           "white, black, deletedByWhite, deletedByBlack " +
 237         "FROM Games " +
 238         "WHERE " +
 239         "  score <> '*' AND" +
 240         "  created < " + cursor + " AND" +
 241         "  (" +
 242         "    (" +
 243         "      white = " + uid + " AND" +
 244         "      (deletedByWhite IS NULL OR NOT deletedByWhite)" +
 245         "    )" +
 246         "    OR " +
 247         "    (" +
 248         "      black = " + uid + " AND" +
 249         "      (deletedByBlack IS NULL OR NOT deletedByBlack)" +
 250         "    )" +
 251         "  ) ";
 252       query +=
 253         "ORDER BY created DESC " +
 254         "LIMIT 20";
 255       db.all(query, (err, games) => {
 256         // Query player names
 257         let pids = {};
 258         games.forEach(g => {
 259           if (!pids[g.white]) pids[g.white] = true;
 260           if (!pids[g.black]) pids[g.black] = true;
 261         });
 262         UserModel.getByIds(Object.keys(pids), (err2, users) => {
 263           let names = {};
 264           users.forEach(u => { names[u.id] = u.name; });
 265           cb(
 266             null,
 267             games.map(
 268               g => {
 269                 return {
 270                   id: g.id,
 271                   vid: g.vid,
 272                   cadence: g.cadence,
 273                   created: g.created,
 274                   score: g.score,
 275                   scoreMsg: g.scoreMsg,
 276                   players: [
 277                     { id: g.white, name: names[g.white] },
 278                     { id: g.black, name: names[g.black] }
 279                   ],
 280                   deletedByWhite: g.deletedByWhite,
 281                   deletedByBlack: g.deletedByBlack
 282                 };
 283               }
 284             )
 285           );
 286         });
 287       });
 288     });
 289   },
 290
 291   getPlayers: function(id, cb) {
 292     db.serialize(function() {
 293       const query =
 294         "SELECT white, black " +
 295         "FROM Games " +
 296         "WHERE id = " + id;
 297       db.get(query, (err, players) => {
 298         return cb(err, players);
 299       });
 300     });
 301   },
 302
 303   checkGameUpdate: function(obj) {
 304     // Check all that is possible (required) in obj:
 305     return (
 306       (
 307         !obj.move || !!(obj.move.idx.toString().match(/^[0-9]+$/))
 308       ) && (
 309         !obj.drawOffer || !!(obj.drawOffer.match(/^[wbtn]$/))
 310       ) && (
 311         !obj.rematchOffer || !!(obj.rematchOffer.match(/^[wbn]$/))
 312       ) && (
 313         !obj.fen || !!(obj.fen.match(/^[a-zA-Z0-9,.:{}\[\]" /-]*$/))
 314       ) && (
 315         !obj.score || !!(obj.score.match(/^[012?*\/-]+$/))
 316       ) && (
 317         !obj.chatRead || ['w','b'].includes(obj.chatRead)
 318       ) && (
 319         !obj.scoreMsg || !!(obj.scoreMsg.match(/^[a-zA-Z ]+$/))
 320       ) && (
 321         !obj.chat || UserModel.checkNameEmail({name: obj.chat.name})
 322       )
 323     );
 324   },
 325
 326   // obj can have fields move, chat, fen, drawOffer and/or score + message
 327   update: function(id, obj, cb) {
 328     db.parallelize(function() {
 329       let updateQuery =
 330         "UPDATE Games " +
 331         "SET ";
 332       let modifs = "";
 333       // NOTE: if drawOffer is set, we should check that it's player's turn
 334       // A bit overcomplicated. Let's trust the client on that for now...
 335       if (!!obj.drawOffer) {
 336         if (obj.drawOffer == "n")
 337           // Special "None" update
 338           obj.drawOffer = "";
 339         modifs += "drawOffer = '" + obj.drawOffer + "',";
 340       }
 341       if (!!obj.rematchOffer) {
 342         if (obj.rematchOffer == "n")
 343           // Special "None" update
 344           obj.rematchOffer = "";
 345         modifs += "rematchOffer = '" + obj.rematchOffer + "',";
 346       }
 347       if (!!obj.fen) modifs += "fen = '" + obj.fen + "',";
 348       if (!!obj.deletedBy) {
 349         const myColor = obj.deletedBy == 'w' ? "White" : "Black";
 350         modifs += "deletedBy" + myColor + " = true,";
 351       }
 352       if (!!obj.chatRead) {
 353         const myColor = obj.chatRead == 'w' ? "White" : "Black";
 354         modifs += "chatRead" + myColor + " = " + Date.now() + ",";
 355       }
 356       if (!!obj.score) {
 357         modifs += "score = '" + obj.score + "'," +
 358                   "scoreMsg = '" + obj.scoreMsg + "',";
 359       }
 360       const finishAndSendQuery = () => {
 361         modifs = modifs.slice(0, -1); //remove last comma
 362         if (modifs.length > 0) {
 363           updateQuery += modifs + " WHERE id = " + id;
 364           db.run(updateQuery);
 365         }
 366         cb(null);
 367       };
 368       if (!!obj.move || (!!obj.score && obj.scoreMsg == "Time")) {
 369         // Security: only update moves if index is right,
 370         // and score with scoreMsg "Time" if really lost on time.
 371         let query =
 372           "SELECT MAX(idx) AS maxIdx, MAX(played) AS lastPlayed " +
 373           "FROM Moves " +
 374           "WHERE gid = " + id;
 375         db.get(query, (err, ret) => {
 376           if (!!obj.move ) {
 377             if (!ret.maxIdx || ret.maxIdx + 1 == obj.move.idx) {
 378               query =
 379                 "INSERT INTO Moves (gid, squares, played, idx) VALUES " +
 380                 "(" + id + ",?," + Date.now() + "," + obj.move.idx + ")";
 381               db.run(query, JSON.stringify(obj.move.squares));
 382               finishAndSendQuery();
 383             }
 384             else cb({ errmsg: "Wrong move index" });
 385           }
 386           else {
 387             if (ret.maxIdx < 2) cb({ errmsg: "Time not over" });
 388             else {
 389               // We also need the game cadence
 390               query =
 391                 "SELECT cadence " +
 392                 "FROM Games " +
 393                 "WHERE id = " + id;
 394               db.get(query, (err2, ret2) => {
 395                 const daysTc = parseInt(ret2.cadence.match(/^[0-9]+/)[0]);
 396                 if (Date.now() - ret.lastPlayed > daysTc * 24 * 3600 * 1000)
 397                   finishAndSendQuery();
 398                 else cb({ errmsg: "Time not over" });
 399               });
 400             }
 401           }
 402         });
 403       }
 404       else finishAndSendQuery();
 405       // NOTE: chat and delchat are mutually exclusive
 406       if (!!obj.chat) {
 407         const query =
 408           "INSERT INTO Chats (gid, msg, name, added) VALUES ("
 409             + id + ",?,'" + obj.chat.name + "'," + Date.now() + ")";
 410         db.run(query, obj.chat.msg);
 411       }
 412       else if (obj.delchat) {
 413         const query =
 414           "DELETE " +
 415           "FROM Chats " +
 416           "WHERE gid = " + id;
 417         db.run(query);
 418       }
 419       if (!!obj.deletedBy) {
 420         // Did my opponent delete it too?
 421         let selection =
 422           "deletedBy" +
 423           (obj.deletedBy == 'w' ? "Black" : "White") +
 424           " AS deletedByOpp";
 425         const query =
 426           "SELECT " + selection + " " +
 427           "FROM Games " +
 428           "WHERE id = " + id;
 429         db.get(query, (err,ret) => {
 430           // If yes: just remove game
 431           if (!!ret.deletedByOpp) GameModel.remove(id);
 432         });
 433       }
 434     });
 435   },
 436
 437   remove: function(id_s) {
 438     const suffix =
 439       Array.isArray(id_s)
 440         ? " IN (" + id_s.join(",") + ")"
 441         : " = " + id_s;
 442     db.parallelize(function() {
 443       let query =
 444         "DELETE FROM Games " +
 445         "WHERE id " + suffix;
 446       db.run(query);
 447       query =
 448         "DELETE FROM Moves " +
 449         "WHERE gid " + suffix;
 450       db.run(query);
 451       query =
 452         "DELETE FROM Chats " +
 453         "WHERE gid " + suffix;
 454       db.run(query);
 455     });
 456   },
 457
 458   cleanGamesDb: function() {
 459     const tsNow = Date.now();
 460     // 86400000 = 24 hours in milliseconds
 461     const day = 86400000;
 462     db.serialize(function() {
 463       let query =
 464         "SELECT id, created, cadence, score " +
 465         "FROM Games";
 466       db.all(query, (err, games) => {
 467         query =
 468           "SELECT gid, count(*) AS nbMoves, MAX(played) AS lastMaj " +
 469           "FROM Moves " +
 470           "GROUP BY gid";
 471         db.all(query, (err2, mstats) => {
 472           // Reorganize moves data to avoid too many array lookups:
 473           let movesGroups = {};
 474           mstats.forEach(ms => {
 475             movesGroups[ms.gid] = {
 476               nbMoves: ms.nbMoves,
 477               lastMaj: ms.lastMaj
 478             };
 479           });
 480           // Remove games still not really started,
 481           // with no action in the last 2 weeks, or result != '*':
 482           let toRemove = [];
 483           let lostOnTime = [ [], [] ];
 484           games.forEach(g => {
 485             if (
 486               (
 487                 !movesGroups[g.id] &&
 488                 (g.score != '*' || tsNow - g.created > 14*day)
 489               )
 490               ||
 491               (
 492                 !!movesGroups[g.id] &&
 493                 movesGroups[g.id].nbMoves == 1 &&
 494                 (g.score != '*' || tsNow - movesGroups[g.id].lastMaj > 14*day)
 495               )
 496             ) {
 497               toRemove.push(g.id);
 498             }
 499             // Set score if lost on time and >= 2 moves:
 500             else if (
 501               g.score == '*' &&
 502               !!movesGroups[g.id] &&
 503               movesGroups[g.id].nbMoves >= 2 &&
 504               tsNow - movesGroups[g.id].lastMaj >
 505                 // cadence in days * nb seconds per day:
 506                 parseInt(g.cadence.slice(0, -1), 10) * day
 507             ) {
 508               lostOnTime[movesGroups[g.id].nbMoves % 2].push(g.id);
 509             }
 510           });
 511           if (toRemove.length > 0) GameModel.remove(toRemove);
 512           if (lostOnTime.some(l => l.length > 0)) {
 513             db.parallelize(function() {
 514               for (let i of [0, 1]) {
 515                 if (lostOnTime[i].length > 0) {
 516                   const score = (i == 0 ? "0-1" : "1-0");
 517                   const query =
 518                     "UPDATE Games " +
 519                     "SET score = '" + score + "', scoreMsg = 'Time' " +
 520                     "WHERE id IN (" + lostOnTime[i].join(',') + ")";
 521                   db.run(query);
 522                 }
 523               }
 524             });
 525           }
 526         });
 527       });
 528     });
 529   }
 530
 531 };
 532
 533 module.exports = GameModel;