Typo
[vchess.git] / server / models / Game.js
CommitLineData
c5c47010 1const db = require("../utils/database");
58e7b94e 2const UserModel = require("./User");
00f2759e
BA
3
4/*
5 * Structure table Games:
6 * id: game id (int)
7 * vid: integer (variant id)
ab4f4bf2
BA
8 * fenStart: varchar (initial position)
9 * fen: varchar (current position)
0234201f
BA
10 * white: integer
11 * black: integer
71468011 12 * cadence: string
00f2759e 13 * score: varchar (result)
dcd68c41 14 * scoreMsg: varchar ("Time", "Mutual agreement"...)
83494c7f 15 * created: datetime
dfeb96ea 16 * drawOffer: char ('w','b' or '' for none)
0234201f
BA
17 * rematchOffer: char (similar to drawOffer)
18 * randomness: integer
19 * deletedByWhite: boolean
20 * deletedByBlack: boolean
1ef65040
BA
21 * chatReadWhite: datetime
22 * chatReadBlack: datetime
00f2759e
BA
23 *
24 * Structure table Moves:
ab4f4bf2 25 * gid: ref game id
f41ce580 26 * squares: varchar (description)
00f2759e
BA
27 * played: datetime
28 * idx: integer
3837d4f7
BA
29 *
30 * Structure table Chats:
31 * gid: game id (int)
32 * msg: varchar
33 * name: varchar
3837d4f7 34 * added: datetime
00f2759e
BA
35 */
36
937c24ab
BA
37const GameModel = {
38
58e7b94e 39 checkGameInfo: function(g) {
866842c3
BA
40 return (
41 g.vid.toString().match(/^[0-9]+$/) &&
42 g.cadence.match(/^[0-9dhms +]+$/) &&
f14572c4 43 g.randomness.toString().match(/^[0-2]$/) &&
866842c3
BA
44 g.fen.match(/^[a-zA-Z0-9, /-]*$/) &&
45 g.players.length == 2 &&
f14572c4 46 g.players.every(p => p.id.toString().match(/^[0-9]+$/))
866842c3 47 );
58e7b94e
BA
48 },
49
4a209313
BA
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
0234201f 60 create: function(vid, fen, randomness, cadence, players, cb) {
dac39588
BA
61 db.serialize(function() {
62 let query =
71468011 63 "INSERT INTO Games " +
0234201f
BA
64 "(" +
65 "vid, fenStart, fen, randomness, " +
66 "white, black, " +
67 "cadence, created" +
68 ") " +
71468011 69 "VALUES " +
0234201f
BA
70 "(" +
71 vid + ",'" + fen + "','" + fen + "'," + randomness + "," +
f14572c4 72 players[0].id + "," + players[1].id + "," +
0234201f
BA
73 "'" + cadence + "'," + Date.now() +
74 ")";
8c564f46 75 db.run(query, function(err) {
f14572c4 76 cb(err, { id: this.lastID });
dac39588
BA
77 });
78 });
79 },
00f2759e 80
71468011 81 // TODO: some queries here could be async
0234201f 82 getOne: function(id, cb) {
866842c3 83 // NOTE: ignoring errors (shouldn't happen at this stage)
dac39588 84 db.serialize(function() {
dac39588 85 let query =
0234201f 86 "SELECT " +
eaa5ad3e
BA
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;
aae89b49 92 db.get(query, (err, gameInfo) => {
f14572c4
BA
93 if (!gameInfo) {
94 cb(err || { errmsg: "Game not found" }, undefined);
95 return;
96 }
dac39588 97 query =
f14572c4
BA
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"];
aae89b49 106 query =
f14572c4
BA
107 "SELECT squares, played, idx " +
108 "FROM Moves " +
aae89b49 109 "WHERE gid = " + id;
f14572c4
BA
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(
f14572c4
BA
117 {
118 players: players,
119 moves: moves,
120 chats: chats
eaa5ad3e
BA
121 },
122 gameInfo
f14572c4
BA
123 );
124 cb(null, game);
125 });
aae89b49 126 });
dac39588
BA
127 });
128 });
129 });
130 },
00f2759e 131
0234201f
BA
132 // For display on Hall: no need for moves or chats
133 getObserved: function(uid, cursor, cb) {
134 db.serialize(function() {
135 let query =
f14572c4 136 "SELECT id, vid, cadence, created, score, white, black " +
6c7cbfed
BA
137 "FROM Games " +
138 "WHERE created < " + cursor + " ";
139 if (uid > 0) {
140 query +=
141 " AND white <> " + uid + " " +
142 " AND black <> " + uid + " ";
143 }
0234201f
BA
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(
f14572c4 158 err,
0234201f
BA
159 games.map(
160 g => {
161 return {
162 id: g.id,
f14572c4 163 vid: g.vid,
0234201f 164 cadence: g.cadence,
0234201f
BA
165 created: g.created,
166 score: g.score,
f14572c4
BA
167 players: [
168 { id: g.white, name: names[g.white] },
169 { id: g.black, name: names[g.black] }
170 ]
0234201f
BA
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() {
aae89b49 183 let query =
eaa5ad3e
BA
184 "SELECT id, vid, cadence, created, white, black " +
185 "FROM Games " +
f14572c4 186 "WHERE score = '*' AND (white = " + uid + " OR black = " + uid + ")";
0234201f
BA
187 db.all(query, (err, games) => {
188 // Get movesCount (could be done in // with next query)
aae89b49 189 query =
0234201f
BA
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 });
f14572c4 203 UserModel.getByIds(Object.keys(pids), (err2, users) => {
0234201f
BA
204 let names = {};
205 users.forEach(u => { names[u.id] = u.name; });
206 cb(
f14572c4 207 null,
0234201f
BA
208 games.map(
209 g => {
210 return {
211 id: g.id,
d807470f 212 vid: g.vid,
f14572c4 213 cadence: g.cadence,
0234201f
BA
214 created: g.created,
215 score: g.score,
f14572c4
BA
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 ]
0234201f
BA
221 };
222 }
223 )
aae89b49 224 );
aae89b49
BA
225 });
226 });
227 });
0234201f
BA
228 });
229 },
230
231 // These games could be deleted on some side. movesCount not required
232 getCompleted: function(uid, cursor, cb) {
dac39588 233 db.serialize(function() {
0234201f 234 let query =
eaa5ad3e
BA
235 "SELECT id, vid, cadence, created, score, scoreMsg, " +
236 "white, black, deletedByWhite, deletedByBlack " +
237 "FROM Games " +
0234201f 238 "WHERE " +
11589e7c
BA
239 " score <> '*' AND" +
240 " created < " + cursor + " AND" +
0234201f 241 " (" +
11589e7c
BA
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 " )" +
0234201f
BA
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 });
f14572c4 262 UserModel.getByIds(Object.keys(pids), (err2, users) => {
0234201f
BA
263 let names = {};
264 users.forEach(u => { names[u.id] = u.name; });
265 cb(
f14572c4 266 null,
0234201f
BA
267 games.map(
268 g => {
269 return {
270 id: g.id,
eaa5ad3e 271 vid: g.vid,
f14572c4 272 cadence: g.cadence,
0234201f
BA
273 created: g.created,
274 score: g.score,
275 scoreMsg: g.scoreMsg,
f14572c4
BA
276 players: [
277 { id: g.white, name: names[g.white] },
278 { id: g.black, name: names[g.black] }
279 ],
0234201f
BA
280 deletedByWhite: g.deletedByWhite,
281 deletedByBlack: g.deletedByBlack
282 };
283 }
284 )
285 );
286 });
dac39588
BA
287 });
288 });
289 },
ab4f4bf2 290
0234201f 291 getPlayers: function(id, cb) {
411d23cd
BA
292 db.serialize(function() {
293 const query =
0234201f
BA
294 "SELECT white, black " +
295 "FROM Games " +
f14572c4
BA
296 "WHERE id = " + id;
297 db.get(query, (err, players) => {
411d23cd
BA
298 return cb(err, players);
299 });
300 });
301 },
302
0234201f 303 checkGameUpdate: function(obj) {
58e7b94e 304 // Check all that is possible (required) in obj:
866842c3
BA
305 return (
306 (
8be8238c 307 !obj.move || !!(obj.move.idx.toString().match(/^[0-9]+$/))
866842c3 308 ) && (
188b4a8f 309 !obj.drawOffer || !!(obj.drawOffer.match(/^[wbtn]$/))
c292ebb2
BA
310 ) && (
311 !obj.rematchOffer || !!(obj.rematchOffer.match(/^[wbn]$/))
866842c3 312 ) && (
5c4ea2bb 313 !obj.fen || !!(obj.fen.match(/^[a-zA-Z0-9,.:{}\[\]" /-]*$/))
866842c3 314 ) && (
188b4a8f 315 !obj.score || !!(obj.score.match(/^[012?*\/-]+$/))
1ef65040 316 ) && (
077ba344 317 !obj.chatRead || ['w','b'].includes(obj.chatRead)
866842c3 318 ) && (
188b4a8f 319 !obj.scoreMsg || !!(obj.scoreMsg.match(/^[a-zA-Z ]+$/))
866842c3
BA
320 ) && (
321 !obj.chat || UserModel.checkNameEmail({name: obj.chat.name})
322 )
323 );
58e7b94e
BA
324 },
325
866842c3 326 // obj can have fields move, chat, fen, drawOffer and/or score + message
0234201f 327 update: function(id, obj, cb) {
dac39588 328 db.parallelize(function() {
f14572c4 329 let updateQuery =
3d55deea
BA
330 "UPDATE Games " +
331 "SET ";
3837d4f7 332 let modifs = "";
633959bf 333 // NOTE: if drawOffer is set, we should check that it's player's turn
dfeb96ea 334 // A bit overcomplicated. Let's trust the client on that for now...
f14572c4
BA
335 if (!!obj.drawOffer) {
336 if (obj.drawOffer == "n")
337 // Special "None" update
633959bf
BA
338 obj.drawOffer = "";
339 modifs += "drawOffer = '" + obj.drawOffer + "',";
340 }
f14572c4
BA
341 if (!!obj.rematchOffer) {
342 if (obj.rematchOffer == "n")
343 // Special "None" update
c292ebb2
BA
344 obj.rematchOffer = "";
345 modifs += "rematchOffer = '" + obj.rematchOffer + "',";
346 }
f14572c4 347 if (!!obj.fen) modifs += "fen = '" + obj.fen + "',";
aae89b49
BA
348 if (!!obj.deletedBy) {
349 const myColor = obj.deletedBy == 'w' ? "White" : "Black";
350 modifs += "deletedBy" + myColor + " = true,";
351 }
1ef65040
BA
352 if (!!obj.chatRead) {
353 const myColor = obj.chatRead == 'w' ? "White" : "Black";
354 modifs += "chatRead" + myColor + " = " + Date.now() + ",";
355 }
f14572c4
BA
356 if (!!obj.score) {
357 modifs += "score = '" + obj.score + "'," +
358 "scoreMsg = '" + obj.scoreMsg + "',";
3837d4f7 359 }
f14572c4
BA
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 " +
fb68b0c2
BA
373 "FROM Moves " +
374 "WHERE gid = " + id;
f14572c4
BA
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();
58aedcd1
BA
383 }
384 else cb({ errmsg: "Wrong move index" });
385 }
386 else {
f14572c4
BA
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) => {
1112f1fd 395 const daysTc = parseInt(ret2.cadence.match(/^[0-9]+/)[0]);
f14572c4
BA
396 if (Date.now() - ret.lastPlayed > daysTc * 24 * 3600 * 1000)
397 finishAndSendQuery();
398 else cb({ errmsg: "Time not over" });
399 });
400 }
fb68b0c2 401 }
fb68b0c2 402 });
58aedcd1
BA
403 }
404 else finishAndSendQuery();
f14572c4
BA
405 // NOTE: chat and delchat are mutually exclusive
406 if (!!obj.chat) {
407 const query =
dac39588 408 "INSERT INTO Chats (gid, msg, name, added) VALUES ("
41c80bb6 409 + id + ",?,'" + obj.chat.name + "'," + Date.now() + ")";
58e7b94e 410 db.run(query, obj.chat.msg);
58aedcd1
BA
411 }
412 else if (obj.delchat) {
f14572c4 413 const query =
db1f1f9a
BA
414 "DELETE " +
415 "FROM Chats " +
416 "WHERE gid = " + id;
23ecf008 417 db.run(query);
db1f1f9a 418 }
aae89b49
BA
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";
f14572c4 425 const query =
aae89b49
BA
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 }
3d55deea
BA
434 });
435 },
436
0234201f
BA
437 remove: function(id_s) {
438 const suffix =
439 Array.isArray(id_s)
440 ? " IN (" + id_s.join(",") + ")"
441 : " = " + id_s;
dac39588
BA
442 db.parallelize(function() {
443 let query =
444 "DELETE FROM Games " +
0234201f 445 "WHERE id " + suffix;
dac39588
BA
446 db.run(query);
447 query =
448 "DELETE FROM Moves " +
0234201f 449 "WHERE gid " + suffix;
dac39588
BA
450 db.run(query);
451 query =
452 "DELETE FROM Chats " +
0234201f 453 "WHERE gid " + suffix;
dac39588
BA
454 db.run(query);
455 });
456 },
d431028c 457
0234201f 458 cleanGamesDb: function() {
d431028c
BA
459 const tsNow = Date.now();
460 // 86400000 = 24 hours in milliseconds
461 const day = 86400000;
462 db.serialize(function() {
463 let query =
7ec05c0e 464 "SELECT id, created, cadence, score " +
0234201f
BA
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";
6f2f9437 471 db.all(query, (err2, mstats) => {
0234201f
BA
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,
7ec05c0e 481 // with no action in the last 2 weeks, or result != '*':
0234201f 482 let toRemove = [];
7ec05c0e 483 let lostOnTime = [ [], [] ];
0234201f
BA
484 games.forEach(g => {
485 if (
486 (
487 !movesGroups[g.id] &&
7ec05c0e 488 (g.score != '*' || tsNow - g.created > 14*day)
0234201f
BA
489 )
490 ||
491 (
b49527c4 492 !!movesGroups[g.id] &&
0234201f 493 movesGroups[g.id].nbMoves == 1 &&
7ec05c0e 494 (g.score != '*' || tsNow - movesGroups[g.id].lastMaj > 14*day)
0234201f
BA
495 )
496 ) {
497 toRemove.push(g.id);
d431028c 498 }
7ec05c0e
BA
499 // Set score if lost on time and >= 2 moves:
500 else if (
b5ead37a 501 g.score == '*' &&
7ec05c0e
BA
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 }
d431028c 510 });
0234201f 511 if (toRemove.length > 0) GameModel.remove(toRemove);
7ec05c0e
BA
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 }
d431028c
BA
526 });
527 });
528 });
0234201f 529 }
937c24ab
BA
530
531};
ab4f4bf2
BA
532
533module.exports = GameModel;