client/src/utils/storage.js

   1 import { extractTime } from "@/utils/timeControl";
   2
   3 // TODO: show game structure
   4 //const newItem = [
   5 //  { gameId: "", players: [], timeControl: "", clocks: [] }
   6 //];
   7
   8 function dbOperation(callback)
   9 {
  10   let db = null;
  11   let DBOpenRequest = window.indexedDB.open("vchess", 4);
  12
  13   DBOpenRequest.onerror = function(event) {
  14     alert("Database error: " + event.target.errorCode);
  15   };
  16
  17   DBOpenRequest.onsuccess = function(event) {
  18     db = DBOpenRequest.result;
  19     callback(db);
  20     db.close();
  21   };
  22
  23   DBOpenRequest.onupgradeneeded = function(event) {
  24     let db = event.target.result;
  25     db.onerror = function(event) {
  26       alert("Error while loading database: " + event.target.errorCode);
  27     };
  28     // Create objectStore for vchess->games
  29     db.createObjectStore("games", { keyPath: "gameId" });
  30   }
  31 }
  32
  33 // Optional callback to get error status
  34 function addGame(game, callback)
  35 {
  36   dbOperation((db) => {
  37     let transaction = db.transaction(["games"], "readwrite");
  38     if (callback)
  39     {
  40       transaction.oncomplete = function() {
  41         callback({}); //everything's fine
  42       }
  43       transaction.onerror = function() {
  44         callback({errmsg: "addGame failed: " + transaction.error});
  45       };
  46     }
  47     let objectStore = transaction.objectStore("games");
  48     objectStore.add(game);
  49   });
  50 }
  51
  52 // Clear current live game from localStorage
  53 function clear() {
  54   localStorage.removeItem("gameInfo");
  55   localStorage.removeItem("gameState");
  56 }
  57
  58 // Current live game:
  59 function getCurrent()
  60 {
  61   return Object.assign({},
  62     JSON.parse(localStorage.getItem("gameInfo")),
  63     JSON.parse(localStorage.getItem("gameState")));
  64 }
  65
  66 // Only called internally after a score update
  67 function transferToDb()
  68 {
  69   addGame(getCurrent(), (err) => {
  70     if (!!err.errmsg)
  71       return err;
  72     clear();
  73   });
  74 }
  75
  76 export const GameStorage =
  77 {
  78   // localStorage:
  79   init: function(o)
  80   {
  81     // Extract times (in [milli]seconds), set clocks, store in localStorage
  82     const tc = extractTime(o.timeControl);
  83
  84     // game infos: constant
  85     const gameInfo =
  86     {
  87       gameId: o.gameId,
  88       vname: o.vname,
  89       fenStart: o.fenStart,
  90       players: o.players,
  91       timeControl: o.timeControl,
  92       increment: tc.increment,
  93       mode: "live", //function for live games only
  94     };
  95
  96     // game state: will be updated
  97     const gameState =
  98     {
  99       fen: o.fenStart,
 100       moves: [],
 101       clocks: [...Array(o.players.length)].fill(tc.mainTime),
 102       initime: (o.initime ? Date.now() : undefined),
 103       score: "*",
 104     };
 105
 106     localStorage.setItem("gameInfo", JSON.stringify(gameInfo));
 107     localStorage.setItem("gameState", JSON.stringify(gameState));
 108   },
 109
 110   getInitime: function()
 111   {
 112     const gameState = JSON.parse(localStorage.getItem("gameState"));
 113     return gameState.initime;
 114   },
 115
 116   // localStorage:
 117   // TODO: also option to takeback a move ?
 118   // NOTE: for live games only (all on server for corr)
 119   update: function(o) //colorIdx, move, fen, addTime, initime, score
 120   {
 121     let gameState = JSON.parse(localStorage.getItem("gameState"));
 122     if (!!o.move)
 123     {
 124       gameState.moves.push(o.move);
 125       gameState.fen = o.fen;
 126       if (!!o.addTime) //NaN if first move in game
 127         gameState.clocks[o.colorIdx] += o.addTime;
 128     }
 129     if (!!o.initime) //just a flag (true)
 130       gameState.initime = Date.now();
 131     if (!!o.score)
 132       gameState.score = o.score;
 133     localStorage.setItem("gameState", JSON.stringify(gameState));
 134     if (!!o.score && o.score != "*")
 135       transferToDb(); //game is over
 136   },
 137
 138   // indexedDB:
 139   // Since DB requests are asynchronous, require a callback using the result
 140   // TODO: option for remote retrieval (third arg, or just "gameRef")
 141   getLocal: function(gameId, callback)
 142   {
 143     dbOperation((db) => {
 144       let objectStore = db.transaction('games').objectStore('games');
 145       if (!gameId) //retrieve all
 146       {
 147         let games = [];
 148         objectStore.openCursor().onsuccess = function(event) {
 149           let cursor = event.target.result;
 150           // if there is still another cursor to go, keep running this code
 151           if (cursor)
 152           {
 153             games.push(cursor.value);
 154             cursor.continue();
 155           }
 156           else
 157             callback(games);
 158         }
 159       }
 160       else //just one game
 161       {
 162         objectStore.get(gameId).onsuccess = function(event) {
 163           callback(event.target.result);
 164         }
 165       }
 166     });
 167   },
 168
 169   // Delete a game in indexedDB
 170   remove: function(gameId, callback)
 171   {
 172     dbOperation((db) => {
 173       let transaction = db.transaction(["games"], "readwrite");
 174       if (callback)
 175       {
 176         transaction.oncomplete = function() {
 177           callback({}); //everything's fine
 178         }
 179         transaction.onerror = function() {
 180           callback({errmsg: "game removal failed: " + transaction.error});
 181         };
 182       }
 183       transaction.objectStore("games").delete(gameId);
 184     });
 185   },
 186
 187   // Retrieve any live game from its identifiers (remote or not, running or not)
 188   // NOTE: need callback because result might be obtained asynchronously
 189   get: function(gameRef, callback)
 190   {
 191     const gid = gameRef.id;
 192     const rid = gameRef.rid; //may be blank
 193     if (!!rid)
 194     {
 195       // TODO: send request to server which forward to user sid == rid,
 196       // need to listen to "remote game" event in main hall ?
 197       return callback({}); //means "the game will arrive later" (TODO...)
 198     }
 199
 200     const gameInfoStr = localStorage.getItem("gameInfo");
 201     if (gameInfoStr)
 202     {
 203       const gameInfo = JSON.parse(gameInfoStr);
 204       if (gameInfo.gameId == gid)
 205       {
 206         const gameState = JSON.parse(localStorage.getItem("gameState"));
 207         return callback(Object.assign({}, gameInfo, gameState));
 208       }
 209     }
 210
 211     // Game is local and not running
 212     GameStorage.getLocal(gid, callback);
 213   },
 214 };