From fc3501382c2aa3ef5b692f4f55c2616f9cade3f5 Mon Sep 17 00:00:00 2001 From: Tor Andersson Date: Fri, 25 Apr 2025 12:18:00 +0200 Subject: Move toolbox scripts to a "bin" directory. Add a super "rtt" command to run the scripts. --- bin/rtt | 31 +++++ bin/rtt-archive-backup | 106 +++++++++++++++++ bin/rtt-archive-prune | 40 +++++++ bin/rtt-archive-restore | 35 ++++++ bin/rtt-backup | 4 + bin/rtt-export | 7 ++ bin/rtt-foreach | 17 +++ bin/rtt-fuzz | 16 +++ bin/rtt-help | 34 ++++++ bin/rtt-import | 80 +++++++++++++ bin/rtt-init | 13 +++ bin/rtt-patch | 291 ++++++++++++++++++++++++++++++++++++++++++++++ bin/rtt-run | 9 ++ bin/rtt-show-chat | 7 ++ bin/rtt-show-game | 7 ++ bin/rtt-show-replay | 7 ++ bin/rtt-tm-unban-tick | 32 +++++ bin/rtt-undo | 15 +++ bin/rtt-update-covers | 53 +++++++++ bin/rtt-update-elo | 66 +++++++++++ docs/index.md | 3 +- docs/server/install.md | 1 - docs/server/production.md | 4 +- docs/server/toolbox.md | 52 +++++++++ package.json | 1 + tools/archive.sql | 101 ---------------- tools/elo.js | 64 ---------- tools/export-game.sh | 8 -- tools/fuzz.js | 204 ++++++++++++++++++++++++++++++++ tools/fuzz.sh | 16 --- tools/gencovers.sh | 43 ------- tools/import-game.js | 80 ------------- tools/lift-bans.sh | 30 ----- tools/new-layout.js | 2 + tools/patchgame.js | 291 ---------------------------------------------- tools/purge.sql | 35 ------ tools/readgame.sh | 10 -- tools/rtt-fuzz.js | 204 -------------------------------- tools/run.sh | 7 -- tools/showgame.sh | 7 -- tools/showreplay.sh | 2 - tools/unarchive.sh | 35 ------ tools/undo.sh | 15 --- tools/writegame.sh | 7 -- 44 files changed, 1133 insertions(+), 959 deletions(-) create mode 100755 bin/rtt create mode 100755 bin/rtt-archive-backup create mode 100755 bin/rtt-archive-prune create mode 100755 bin/rtt-archive-restore create mode 100755 bin/rtt-backup create mode 100755 bin/rtt-export create mode 100755 bin/rtt-foreach create mode 100755 bin/rtt-fuzz create mode 100755 bin/rtt-help create mode 100755 bin/rtt-import create mode 100755 bin/rtt-init create mode 100755 bin/rtt-patch create mode 100755 bin/rtt-run create mode 100755 bin/rtt-show-chat create mode 100755 bin/rtt-show-game create mode 100755 bin/rtt-show-replay create mode 100755 bin/rtt-tm-unban-tick create mode 100755 bin/rtt-undo create mode 100755 bin/rtt-update-covers create mode 100755 bin/rtt-update-elo create mode 100644 docs/server/toolbox.md delete mode 100644 tools/archive.sql delete mode 100644 tools/elo.js delete mode 100644 tools/export-game.sh create mode 100644 tools/fuzz.js delete mode 100755 tools/fuzz.sh delete mode 100644 tools/gencovers.sh delete mode 100755 tools/import-game.js delete mode 100644 tools/lift-bans.sh mode change 100644 => 100755 tools/new-layout.js delete mode 100755 tools/patchgame.js delete mode 100644 tools/purge.sql delete mode 100644 tools/readgame.sh delete mode 100755 tools/rtt-fuzz.js delete mode 100644 tools/run.sh delete mode 100644 tools/showgame.sh delete mode 100644 tools/showreplay.sh delete mode 100644 tools/unarchive.sh delete mode 100644 tools/undo.sh delete mode 100644 tools/writegame.sh diff --git a/bin/rtt b/bin/rtt new file mode 100755 index 0000000..c6b9edc --- /dev/null +++ b/bin/rtt @@ -0,0 +1,31 @@ +#!/bin/bash + +cmd=$1 +shift + +bindir=$(dirname $(readlink -f $0)) + +if [ ! -n "$cmd" ] +then + cmd=help +fi + +if [ ! -f ./server.js ] +then + echo "rtt: command must run in the top-level server directory!" + exit 1 +fi + +if [ ! -f $bindir/rtt-$cmd ] +then + echo "rtt: '$cmd' is not an rtt command" + exit 1 +fi + +if [ ! -f ./db -a "$cmd" != init -a "$cmd" != "help" ] +then + echo "rtt: the database does not exist!" + exit 1 +fi + +exec $bindir/rtt-$cmd "$@" diff --git a/bin/rtt-archive-backup b/bin/rtt-archive-backup new file mode 100755 index 0000000..f1b63e5 --- /dev/null +++ b/bin/rtt-archive-backup @@ -0,0 +1,106 @@ +#!/bin/bash +sqlite3 < game.json" +fi diff --git a/bin/rtt-foreach b/bin/rtt-foreach new file mode 100755 index 0000000..22feb77 --- /dev/null +++ b/bin/rtt-foreach @@ -0,0 +1,17 @@ +#!/bin/bash + +if [ -z "$1" ] +then + echo "usage: rtt-foreach " + exit 1 +fi + +for M in $(sqlite3 db "select title_id from titles") +do + echo "Entering 'public/$M'" + if pushd public/$M >/dev/null + then + "$@" + popd >/dev/null + fi +done diff --git a/bin/rtt-fuzz b/bin/rtt-fuzz new file mode 100755 index 0000000..d7f2aef --- /dev/null +++ b/bin/rtt-fuzz @@ -0,0 +1,16 @@ +#!/bin/bash + +TITLE=$1 +shift + +if [ ! -f ./public/$TITLE/rules.js ] +then + echo usage: rtt-fuzz TITLE + exit 1 +fi + +mkdir -p fuzzer/corpus-$TITLE + +RULES=../public/$TITLE/rules.js \ + npx jazzer tools/fuzz.js --sync fuzzer/corpus-$TITLE "$@" -- -exact_artifact_path=/dev/null | \ + tee fuzzer/log-$TITLE.txt diff --git a/bin/rtt-help b/bin/rtt-help new file mode 100755 index 0000000..5f6815c --- /dev/null +++ b/bin/rtt-help @@ -0,0 +1,34 @@ +#!/bin/bash +cat < [ arguments... ] + +database management + init -- create database + run -- run server + backup -- backup database + +game management + export -- export game + import -- import game + patch -- patch game state (using replay) + undo -- rewind game state (using replay) + +module development + foreach -- run a command for each module + fuzz -- fuzz test a module + +game debugging + show-chat -- show game chat (for moderation) + show-game -- show game state object + show-replay -- show game replay log + +miscellaneous tools + update-covers -- generate cover thumbnails + update-elo -- recalculate Elo ratings + +archive database + archive-backup -- backup replay data into archive + archive-prune -- prune replay data from live database + archive-restore -- restore replay data from archive + +EOF diff --git a/bin/rtt-import b/bin/rtt-import new file mode 100755 index 0000000..2e4295b --- /dev/null +++ b/bin/rtt-import @@ -0,0 +1,80 @@ +#!/usr/bin/env -S node + +const fs = require("fs") +const sqlite3 = require("better-sqlite3") + +var options = {} +var input = [] + +for (let i = 2; i < process.argv.length; ++i) { + let opt = process.argv[i] + if (opt.includes("=")) { + let [key, val] = opt.split("=", 2) + options[key] = val + } else { + input.push(opt) + } +} + +if (input.length < 1) { + console.error("usage: rtt-import [title_id=value] [notice=value] game-dump.json") + process.exit(1) +} + +for (let file of input) { + var game = JSON.parse(fs.readFileSync(file, "utf8")) + + if (options.title_id) + game.setup.title_id = options.title_id + if (options.notice) + game.setup.notice = options.notice + + if (game.setup.notice === undefined) + game.setup.notice = "" + if (game.setup.options === undefined) + game.setup.options = "{}" + + game.setup.active = String(game.state.active) + game.setup.moves = game.snaps && game.snaps.length > 0 ? game.snaps.length - 1 : 0 + + let db = new sqlite3("db") + + let insert_game = db.prepare("insert into games(status,owner_id,title_id,scenario,options,player_count,active,moves,notice) values (1,1,:title_id,:scenario,:options,:player_count,:active,:moves,:notice) returning game_id").pluck() + let insert_player = db.prepare("insert into players(game_id,role,user_id,clock) values (?,?,?,21)") + let insert_state = db.prepare("insert into game_state(game_id,state) values (?,?)") + let update_active_trigger = db.prepare("update games set active=active where game_id=?") + + let select_user = db.prepare("select user_id from users where name=?").pluck() + + db.exec("begin") + + game.setup.options = JSON.stringify(game.setup.options) + + function find_user(name) { + return select_user.get(name) || 1 + } + + let game_id = insert_game.get(game.setup) + for (let p of game.players) + insert_player.run(game_id, p.role, find_user(p.name)) + insert_state.run(game_id, JSON.stringify(game.state)) + update_active_trigger.run(game_id) + + if (game.replay) { + let insert_replay = db.prepare("insert into game_replay(game_id,replay_id,role,action,arguments) values (?,?,?,?,?)") + game.replay.forEach(([role, action, args], i) => { + insert_replay.run(game_id, i+1, role, action, JSON.stringify(args)) + }) + } + + if (game.snaps) { + let insert_snap = db.prepare("insert into game_snap(game_id,snap_id,replay_id,state) values (?,?,?,?)") + game.snaps.forEach(([replay_id, state], i) => { + insert_snap.run(game_id, i+1, replay_id, JSON.stringify(state)) + }) + } + + console.log(game_id) + + db.exec("commit") +} diff --git a/bin/rtt-init b/bin/rtt-init new file mode 100755 index 0000000..02b9e9b --- /dev/null +++ b/bin/rtt-init @@ -0,0 +1,13 @@ +#!/bin/bash + +echo installing node packages +npm install -s + +echo creating database +sqlite3 db < schema.sql + +for M in public/*/title.sql +do + echo registering module $(basename $(dirname $M)) + sqlite3 db < $M +done diff --git a/bin/rtt-patch b/bin/rtt-patch new file mode 100755 index 0000000..19e9874 --- /dev/null +++ b/bin/rtt-patch @@ -0,0 +1,291 @@ +#!/usr/bin/env -S node + +const sqlite3 = require("better-sqlite3") + +let db = new sqlite3("db") + +let select_game = db.prepare("select * from games where game_id=?") + +let select_replay = db.prepare("select * from game_replay where game_id=?") +let delete_replay = db.prepare("delete from game_replay where game_id=?") +let insert_replay = db.prepare("insert into game_replay (game_id,replay_id,role,action,arguments) values (?,?,?,?,?)") + +let delete_snap = db.prepare("delete from game_snap where game_id=?") +let insert_snap = db.prepare("insert into game_snap(game_id,snap_id,replay_id,state) values (?,?,?,?)") + +let update_state = db.prepare("update game_state set state=? where game_id=?") +let update_active = db.prepare("update games set active=? where game_id=?") + +let update_result = db.prepare("update games set status=?, result=? where game_id=?") + +const CRC32C_TABLE = new Int32Array([ + 0x00000000, 0xf26b8303, 0xe13b70f7, 0x1350f3f4, 0xc79a971f, 0x35f1141c, 0x26a1e7e8, 0xd4ca64eb, + 0x8ad958cf, 0x78b2dbcc, 0x6be22838, 0x9989ab3b, 0x4d43cfd0, 0xbf284cd3, 0xac78bf27, 0x5e133c24, + 0x105ec76f, 0xe235446c, 0xf165b798, 0x030e349b, 0xd7c45070, 0x25afd373, 0x36ff2087, 0xc494a384, + 0x9a879fa0, 0x68ec1ca3, 0x7bbcef57, 0x89d76c54, 0x5d1d08bf, 0xaf768bbc, 0xbc267848, 0x4e4dfb4b, + 0x20bd8ede, 0xd2d60ddd, 0xc186fe29, 0x33ed7d2a, 0xe72719c1, 0x154c9ac2, 0x061c6936, 0xf477ea35, + 0xaa64d611, 0x580f5512, 0x4b5fa6e6, 0xb93425e5, 0x6dfe410e, 0x9f95c20d, 0x8cc531f9, 0x7eaeb2fa, + 0x30e349b1, 0xc288cab2, 0xd1d83946, 0x23b3ba45, 0xf779deae, 0x05125dad, 0x1642ae59, 0xe4292d5a, + 0xba3a117e, 0x4851927d, 0x5b016189, 0xa96ae28a, 0x7da08661, 0x8fcb0562, 0x9c9bf696, 0x6ef07595, + 0x417b1dbc, 0xb3109ebf, 0xa0406d4b, 0x522bee48, 0x86e18aa3, 0x748a09a0, 0x67dafa54, 0x95b17957, + 0xcba24573, 0x39c9c670, 0x2a993584, 0xd8f2b687, 0x0c38d26c, 0xfe53516f, 0xed03a29b, 0x1f682198, + 0x5125dad3, 0xa34e59d0, 0xb01eaa24, 0x42752927, 0x96bf4dcc, 0x64d4cecf, 0x77843d3b, 0x85efbe38, + 0xdbfc821c, 0x2997011f, 0x3ac7f2eb, 0xc8ac71e8, 0x1c661503, 0xee0d9600, 0xfd5d65f4, 0x0f36e6f7, + 0x61c69362, 0x93ad1061, 0x80fde395, 0x72966096, 0xa65c047d, 0x5437877e, 0x4767748a, 0xb50cf789, + 0xeb1fcbad, 0x197448ae, 0x0a24bb5a, 0xf84f3859, 0x2c855cb2, 0xdeeedfb1, 0xcdbe2c45, 0x3fd5af46, + 0x7198540d, 0x83f3d70e, 0x90a324fa, 0x62c8a7f9, 0xb602c312, 0x44694011, 0x5739b3e5, 0xa55230e6, + 0xfb410cc2, 0x092a8fc1, 0x1a7a7c35, 0xe811ff36, 0x3cdb9bdd, 0xceb018de, 0xdde0eb2a, 0x2f8b6829, + 0x82f63b78, 0x709db87b, 0x63cd4b8f, 0x91a6c88c, 0x456cac67, 0xb7072f64, 0xa457dc90, 0x563c5f93, + 0x082f63b7, 0xfa44e0b4, 0xe9141340, 0x1b7f9043, 0xcfb5f4a8, 0x3dde77ab, 0x2e8e845f, 0xdce5075c, + 0x92a8fc17, 0x60c37f14, 0x73938ce0, 0x81f80fe3, 0x55326b08, 0xa759e80b, 0xb4091bff, 0x466298fc, + 0x1871a4d8, 0xea1a27db, 0xf94ad42f, 0x0b21572c, 0xdfeb33c7, 0x2d80b0c4, 0x3ed04330, 0xccbbc033, + 0xa24bb5a6, 0x502036a5, 0x4370c551, 0xb11b4652, 0x65d122b9, 0x97baa1ba, 0x84ea524e, 0x7681d14d, + 0x2892ed69, 0xdaf96e6a, 0xc9a99d9e, 0x3bc21e9d, 0xef087a76, 0x1d63f975, 0x0e330a81, 0xfc588982, + 0xb21572c9, 0x407ef1ca, 0x532e023e, 0xa145813d, 0x758fe5d6, 0x87e466d5, 0x94b49521, 0x66df1622, + 0x38cc2a06, 0xcaa7a905, 0xd9f75af1, 0x2b9cd9f2, 0xff56bd19, 0x0d3d3e1a, 0x1e6dcdee, 0xec064eed, + 0xc38d26c4, 0x31e6a5c7, 0x22b65633, 0xd0ddd530, 0x0417b1db, 0xf67c32d8, 0xe52cc12c, 0x1747422f, + 0x49547e0b, 0xbb3ffd08, 0xa86f0efc, 0x5a048dff, 0x8ecee914, 0x7ca56a17, 0x6ff599e3, 0x9d9e1ae0, + 0xd3d3e1ab, 0x21b862a8, 0x32e8915c, 0xc083125f, 0x144976b4, 0xe622f5b7, 0xf5720643, 0x07198540, + 0x590ab964, 0xab613a67, 0xb831c993, 0x4a5a4a90, 0x9e902e7b, 0x6cfbad78, 0x7fab5e8c, 0x8dc0dd8f, + 0xe330a81a, 0x115b2b19, 0x020bd8ed, 0xf0605bee, 0x24aa3f05, 0xd6c1bc06, 0xc5914ff2, 0x37faccf1, + 0x69e9f0d5, 0x9b8273d6, 0x88d28022, 0x7ab90321, 0xae7367ca, 0x5c18e4c9, 0x4f48173d, 0xbd23943e, + 0xf36e6f75, 0x0105ec76, 0x12551f82, 0xe03e9c81, 0x34f4f86a, 0xc69f7b69, 0xd5cf889d, 0x27a40b9e, + 0x79b737ba, 0x8bdcb4b9, 0x988c474d, 0x6ae7c44e, 0xbe2da0a5, 0x4c4623a6, 0x5f16d052, 0xad7d5351 +]) + +function crc32c(data) { + let x = 0 + for (let i = 0, n = data.length; i < n; ++i) + x = CRC32C_TABLE[(x ^ data.charCodeAt(i)) & 0xff] ^ (x >>> 8) + return x ^ -1 +} + +function snapshot(state) { + let save_undo = state.undo + let save_log = state.log + state.undo = undefined + state.log = save_log.length + let snap = JSON.stringify(state) + state.undo = save_undo + state.log = save_log + return snap +} + +function is_role_active(active, role) { + return active === role || active === "Both" || active.includes(role) +} + +function is_nobody_active(active) { + return !active || active === "None" +} + +function is_multi_active(active) { + if (!active) + return false + if (Array.isArray(active)) + return true + return active === "Both" || active.includes(",") +} + +function is_changed_active(old_active, new_active) { + return String(old_active) !== String(new_active) +} + +function is_valid_action(rules, state, role, action, arg) { + if (action === "undo") // for jc, hots, r3, and cr compatibility + return true + if (!is_role_active(state.active, role)) + return false + let view = rules.view(state, role) + let va = view.actions[action] + if (va) { + if (Array.isArray(va) && va.includes(arg)) + return true + if (arg === undefined || arg === null || arg === 1 || Array.isArray(arg)) + return (va === 1 || va === true || typeof va === "string") + } + return false +} + +function dont_snap(rules, state, old_active) { + if (is_nobody_active(state.active)) + return true + if (is_multi_active(old_active) && is_multi_active(state.active)) + return true + if (!is_changed_active(old_active, state.active)) + return true + if (rules.dont_snap && rules.dont_snap(state)) + return true + return false +} + +function get_game_roles(rules, scenario, options) { + let roles = rules.roles + if (typeof roles === "function") { + if (typeof options === "string") + options = JSON.parse(options) + return roles(scenario, options) + } + return roles +} + +function get_resign_result(roles, role) { + return roles.filter(r => r !== role).join(", ") +} + +function finish_game(rules, state, result, message) { + if (typeof rules.finish === "function") { + state = RULES[title_id].finish(state, result, message) + } else { + state.state = "game_over" + state.active = "None" + state.result = result + state.victory = message + state.log.push("") + state.log.push(message) + } + return state +} + +function patch_game(game_id, {validate_actions=true, save_snaps=true, delete_undo=false, delete_invalid=false}, verbose) { + let game = select_game.get(game_id) + if (!game) { + console.error("game not found:", game_id) + return + } + + let title_id = game.title_id + let rules = require("../public/" + title_id + "/rules.js") + let roles = get_game_roles(rules, game.scenario, game.options) + + let replay = select_replay.all(game_id) + if (replay.length === 0) + return + + console.log("processing", game_id, title_id) + + try { + let state = null + let old_active = null + let need_to_rewrite = false + + for (let i = 0; i < replay.length; ++i) { + let item = replay[i] + + if (verbose) + console.log(item.replay_id, item.role, item.action, item.arguments) + + let args = JSON.parse(item.arguments) + switch (item.action) { + case ".setup": + state = rules.setup(...args) + break + case ".timeout": + finish_game(rules, state, "None", item.role + " timed out.") + break + case ".abandon": + finish_game(rules, state, "None", item.role + " abandoned the game.") + case ".resign": + finish_game(rules, state, get_resign_result(roles, item.role), item.role + " resigned.") + break + default: + if (validate_actions) { + if (!is_valid_action(rules, state, item.role, item.action, args)) { + console.error(`invalid action: ${item.role} ${item.action} ${item.arguments}`) + console.error("\t", state.state, state.active, JSON.stringify(rules.view(state, item.role).actions)) + if (i < replay.length) { + console.log("BROKEN ENTRIES: %d", replay.length-i) + console.log(`sqlite3 db "delete from game_replay where game_id=${game_id} and replay_id>=${replay[i].replay_id}"`) + } + throw "invalid action" + } + } + state = rules.action(state, item.role, item.action, args) + break + } + + item.state = snapshot(state) + item.checksum = crc32c(item.state) + if (!dont_snap(rules, state, old_active)) + item.save = 1 + old_active = state.active + + if (delete_undo) { + if (item.action === "undo") { + for (let k = i-1; k >= 0; --k) { + if (replay[k].checksum === item.checksum) { + need_to_rewrite = true + for (let z = k+1; z <= i; ++z) + replay[z].remove = 1 + break + } + } + } + } + } + + db.exec("begin") + + if (need_to_rewrite) { + delete_replay.run(game_id) + for (item of replay) + if (!item.remove) + insert_replay.run(game_id, item.replay_id, item.role, item.action, item.arguments) + } + + if (save_snaps) { + delete_snap.run(game_id) + let snap_id = 0 + for (item of replay) + if (item.save) + insert_snap.run(game_id, ++snap_id, item.replay_id, item.state) + } + + update_active.run(String(state.active), game_id) + update_state.run(JSON.stringify(state), game_id) + + if (state.state === "game_over") + update_result.run(2, state.result, game_id) + else + update_result.run(1, null, game_id) + + db.exec("commit") + + } catch (err) { + if (err !== "invalid action") + console.error("ERROR", game_id, title_id, err) + if (delete_invalid) { + delete_replay.run(game_id) + delete_snap.run(game_id) + } + } +} + +function patch_all(options) { + for (let game_id of db.prepare("select game_id from games where status=1").pluck().all()) + patch_game(game_id, options, false) +} + +function patch_title(title_id, options) { + for (let game_id of db.prepare("select game_id from games where status=1 and title_id=?").pluck().all(title_id)) + patch_game(game_id, options, false) +} + +if (process.argv.length < 3) { + process.stderr.write("usage: rtt-patch '{options}'\n") + process.stderr.write(" or: rtt-patch '{options}'\n") + process.stderr.write(" or: rtt-patch all '{options}'\n") + process.stderr.write('options: { "validate_actions":true, "delete_invalid":false, "save_snaps":true, "delete_undo":false }\n') + process.exit(1) +} + +let options = {} +if (process.argv.length === 4) + options = JSON.parse(process.argv[3]) + +if (process.argv[2] === 'all') + patch_all(options) +else if (isNaN(process.argv[2])) + patch_title(process.argv[2], options) +else + patch_game(parseInt(process.argv[2]), options, true) diff --git a/bin/rtt-run b/bin/rtt-run new file mode 100755 index 0000000..6873e2f --- /dev/null +++ b/bin/rtt-run @@ -0,0 +1,9 @@ +#!/bin/bash +while true +do + nodemon --exitcrash server.js + echo + echo "Restarting soon!" + echo "Hit Ctl-C to exit." + sleep 3 +done diff --git a/bin/rtt-show-chat b/bin/rtt-show-chat new file mode 100755 index 0000000..7d71718 --- /dev/null +++ b/bin/rtt-show-chat @@ -0,0 +1,7 @@ +#!/bin/bash +if [ -n "$1" ] +then + sqlite3 db ".mode column --wrap 40 -ww" "select time,name,message from game_chat_view where game_id=$1" | less -FX +else + echo "usage: rtt-show-chat GAME" +fi diff --git a/bin/rtt-show-game b/bin/rtt-show-game new file mode 100755 index 0000000..ece9e49 --- /dev/null +++ b/bin/rtt-show-game @@ -0,0 +1,7 @@ +#!/bin/bash +if [ -n "$1" ] +then + sqlite3 db "select json_remove(json_remove(state, '$.undo'), '$.log') from game_state where game_id = $1" +else + echo "usage: rtt-show-state GAME" +fi diff --git a/bin/rtt-show-replay b/bin/rtt-show-replay new file mode 100755 index 0000000..4bbbdce --- /dev/null +++ b/bin/rtt-show-replay @@ -0,0 +1,7 @@ +#!/bin/bash +if [ -n "$1" ] +then + sqlite3 db "select replay_id, role, action, arguments from game_replay where game_id=$1" +else + echo "usage: rtt-show-replay GAME" +fi diff --git a/bin/rtt-tm-unban-tick b/bin/rtt-tm-unban-tick new file mode 100755 index 0000000..7294e81 --- /dev/null +++ b/bin/rtt-tm-unban-tick @@ -0,0 +1,32 @@ +#!/bin/bash + +# Run this script in a cron job to lift tournament bans periodically. + +sqlite3 db < timeout_total) and (julianday() > julianday(timeout_last)+14) as lift_ban + from + user_profile_view + where + user_id in (select user_id from tm_banned) + order by lift_ban desc, timeout_last asc +; + +select * from tm_lift_ban_view; + +delete from tm_banned where user_id in (select user_id from tm_lift_ban_view where lift_ban) returning user_id; + +commit; + +EOF diff --git a/bin/rtt-undo b/bin/rtt-undo new file mode 100755 index 0000000..2f69eed --- /dev/null +++ b/bin/rtt-undo @@ -0,0 +1,15 @@ +#!/bin/bash +if [ -n "$1" ] +then + if [ -n "$2" ] + then + COUNT=$2 + else + COUNT=$(sqlite3 db "select coalesce(max(replay_id),0) from game_replay where game_id=$1") + echo Game has $COUNT actions. + fi + sqlite3 db "delete from game_replay where game_id=$1 and replay_id>=$COUNT" + ./bin/rtt-patch $1 '{"validate_actions":false}' +else + echo "usage: rtt-undo GAME" +fi diff --git a/bin/rtt-update-covers b/bin/rtt-update-covers new file mode 100755 index 0000000..0eae8e7 --- /dev/null +++ b/bin/rtt-update-covers @@ -0,0 +1,53 @@ +#!/bin/bash + +if command -v convert && command -v pngtopnm && command -v cjpeg +then + echo "Generating cover images and thumbnails!" +else + echo error: cannot find imagemagick, netpbm, and/or cjpeg + exit 1 +fi + +for F in public/*/cover.jpg public/*/cover.png +do + echo processing $F + B=$(echo $F | sed s/.jpg// | sed s/.png//) + D=$(dirname $F) + + if [ $F -nt $D/thumbnail.png ] + then + + PORTRAIT=$(convert $F -format '%[fx:w $D/thumbnail.jpg + pngtopnm $B.1x.png | cjpeg -progressive -optimize -sample 1x1 -quality 95 > $B.1x.jpg + pngtopnm $B.2x.png | cjpeg -progressive -optimize -sample 1x1 -quality 95 > $B.2x.jpg + +done diff --git a/bin/rtt-update-elo b/bin/rtt-update-elo new file mode 100755 index 0000000..538964a --- /dev/null +++ b/bin/rtt-update-elo @@ -0,0 +1,66 @@ +#!/usr/bin/env -S node + +// Recompute Elo ratings from scratch! + +const sqlite3 = require("better-sqlite3") + +const db = new sqlite3("db") + +const SQL_SELECT_GAMES = db.prepare("select * from rated_games_view order by mtime") +const SQL_SELECT_RATING = db.prepare("select * from player_rating_view where game_id=?") +const SQL_INSERT_RATING = db.prepare("insert or replace into ratings (title_id,user_id,rating,count,last) values (?,?,?,?,?)") + +function is_winner(role, result) { + // NOTE: uses substring matching for multiple winners instead of splitting result on comma. + return (result === "Draw" || result === role || result.includes(role)) +} + +function elo_k(n) { + return 30 +} + +function elo_ev(a, players) { + // Generalized formula for multiple players. + // https://arxiv.org/pdf/2104.05422.pdf + let sum = 0 + for (let p of players) + sum += Math.pow(10, p.rating / 400) + return Math.pow(10, a.rating / 400) / sum +} + +function elo_change(a, players, s) { + return Math.round(elo_k(a.count) * (s - elo_ev(a, players))) +} + +function update_elo_ratings(game) { + let players = SQL_SELECT_RATING.all(game.game_id) + + if (game.player_count !== players.length) + return + + if (!game.result || game.result === "None") + return + + let winners = 0 + for (let p of players) + if (is_winner(p.role, game.result)) + winners ++ + + if (winners === 0) + return + + for (let p of players) + if (is_winner(p.role, game.result)) + p.change = elo_change(p, players, 1 / winners) + else + p.change = elo_change(p, players, 0) + + for (let p of players) + SQL_INSERT_RATING.run(game.title_id, p.user_id, p.rating + p.change, p.count + 1, game.mtime) +} + +db.exec("begin transaction") +db.exec("delete from ratings") +for (let game of SQL_SELECT_GAMES.all()) + update_elo_ratings(game) +db.exec("commit") diff --git a/docs/index.md b/docs/index.md index 96c9a7b..254cc74 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,6 +13,7 @@ server instance and how to create new modules. * [Installing the server](/docs/server/install) * [Running a public server](/docs/server/production) +* [Toolbox](/docs/server/toolbox) ## System overview @@ -22,7 +23,7 @@ server instance and how to create new modules. ## Module implementation -* [Step by step guide](/docs/module/guide) +* [General tips and where to start](/docs/module/guide) * [Rules framework](/docs/module/rules) * [Script syntax](/docs/module/script) * [Utility library](/docs/module/library) diff --git a/docs/server/install.md b/docs/server/install.md index 86359bc..4e48440 100644 --- a/docs/server/install.md +++ b/docs/server/install.md @@ -43,4 +43,3 @@ Register it in the database: Open the browser to http://localhost:8080/ and create an account. The first account created will have administrator privileges. - diff --git a/docs/server/production.md b/docs/server/production.md index 9882a5a..4344630 100644 --- a/docs/server/production.md +++ b/docs/server/production.md @@ -91,11 +91,11 @@ Run the archive and purge scripts as part of the backup cron job. Copy game state data of finished games into archive database. - sqlite3 tools/archive.sql + sqlite3 < tools/archive.sql Delete game state data of finished games over a certain age. - sqlite3 tools/purge.sql + sqlite3 < tools/purge.sql Restore archived game state. diff --git a/docs/server/toolbox.md b/docs/server/toolbox.md new file mode 100644 index 0000000..ebbabaf --- /dev/null +++ b/docs/server/toolbox.md @@ -0,0 +1,52 @@ +# Toolbox + +There are a few programs that help maintain the database and are useful to +develop and debug modules. + +## Setup + +These programs can be invoked from the command line by running the "rtt" +command that is found in the "bin" directory. +I suggest creating a symlink to the "rtt" command somewhere in your PATH. + + ln -s ~/server/bin/rtt ~/.local/bin + +Alternatively, you can edit your .profile to add the server bin directory to your PATH. + + PATH=$PATH:$HOME/server/bin + +## Commands + +database management + + init -- create database + run -- run server + backup -- backup database + +game management + + export -- export game + import -- import game + patch -- patch game state (using replay) + undo -- rewind game state (using replay) + +module development + + foreach -- run a command for each module + fuzz -- fuzz test a module + +game debugging + + show-chat -- show game chat (for moderation) + show-game -- show game state object + show-replay -- show game replay log + +miscellaneous tools + + update-covers -- generate cover thumbnails + update-elo -- recalculate Elo ratings + +## Miscellaneous + +The "tools" directory holds various useful bits and bobs. + diff --git a/package.json b/package.json index 98e6b06..2ac0ce2 100644 --- a/package.json +++ b/package.json @@ -9,6 +9,7 @@ "express": "^4.18.2", "marked": "^15.0.10", "nodemailer": "^6.9.9", + "nodemon": "^3.1.10", "pug": "^3.0.2", "utf-8-validate": "^6.0.3", "ws": "^8.16.0" diff --git a/tools/archive.sql b/tools/archive.sql deleted file mode 100644 index e8b5458..0000000 --- a/tools/archive.sql +++ /dev/null @@ -1,101 +0,0 @@ --- Make a copy of finished games in a separate archive database. - -pragma busy_timeout=10000; - -attach database 'db' as live; -attach database 'archive.db' as archive; - --- List finished (and rated) games in live that are not in archive. -create temporary view candidates as - select - game_id - from - live.rated_games_view - where - game_id not in (select game_id from archive.games) -; - -create table if not exists archive.users ( - user_id integer primary key, - name text unique collate nocase -); - -create table if not exists archive.players ( - game_id integer, - role text, - user_id integer, - primary key (game_id, role) -) without rowid; - -create table if not exists archive.games ( - game_id integer primary key, - title_id text, - scenario text, - options text, - player_count integer, - ctime datetime, - mtime datetime, - moves integer, - result text -); - -create table if not exists archive.game_state ( - game_id integer primary key, - state text -); - -create table if not exists archive.game_replay ( - game_id integer, - replay_id integer, - role text, - action text, - arguments json, - primary key (game_id, replay_id) -) without rowid; - -create table if not exists archive.game_chat ( - game_id integer, - chat_id integer, - user_id integer, - time datetime, - message text, - primary key (game_id, chat_id) -) without rowid; - -drop trigger if exists archive.trigger_delete; -create trigger archive.trigger_delete after delete on archive.games -begin - delete from players where game_id = old.game_id; - delete from game_state where game_id = old.game_id; - delete from game_replay where game_id = old.game_id; - delete from game_chat where game_id = old.game_id; -end; - -begin immediate; - -select 'ARCHIVING ' || count(*) || ' GAMES' from candidates; - -insert or ignore into archive.users (user_id, name) select user_id, name - from live.users; - -insert into archive.players (game_id, role, user_id) - select game_id, role, user_id - from candidates join live.players using(game_id); - -insert into archive.game_state (game_id, state) - select game_id, state - from candidates join live.game_state using(game_id); - -insert into archive.game_replay (game_id, replay_id, role, action, arguments) - select game_id, replay_id, role, action, arguments - from candidates join live.game_replay using(game_id); - -insert into archive.game_chat (game_id, chat_id, user_id, time, message) - select game_id, chat_id, user_id, time, message - from candidates join live.game_chat using(game_id); - -insert into archive.games (game_id, title_id, scenario, options, player_count, ctime, mtime, moves, result) - select game_id, title_id, scenario, options, player_count, ctime, mtime, moves, result - from candidates join live.games using(game_id); - -commit; diff --git a/tools/elo.js b/tools/elo.js deleted file mode 100644 index f6064f1..0000000 --- a/tools/elo.js +++ /dev/null @@ -1,64 +0,0 @@ -#!/usr/bin/env -S node - -const sqlite3 = require("better-sqlite3") - -const db = new sqlite3("db") - -const SQL_SELECT_GAMES = db.prepare("select * from rated_games_view order by mtime") -const SQL_SELECT_RATING = db.prepare("select * from player_rating_view where game_id=?") -const SQL_INSERT_RATING = db.prepare("insert or replace into ratings (title_id,user_id,rating,count,last) values (?,?,?,?,?)") - -function is_winner(role, result) { - // NOTE: uses substring matching for multiple winners instead of splitting result on comma. - return (result === "Draw" || result === role || result.includes(role)) -} - -function elo_k(n) { - return 30 -} - -function elo_ev(a, players) { - // Generalized formula for multiple players. - // https://arxiv.org/pdf/2104.05422.pdf - let sum = 0 - for (let p of players) - sum += Math.pow(10, p.rating / 400) - return Math.pow(10, a.rating / 400) / sum -} - -function elo_change(a, players, s) { - return Math.round(elo_k(a.count) * (s - elo_ev(a, players))) -} - -function update_elo_ratings(game) { - let players = SQL_SELECT_RATING.all(game.game_id) - - if (game.player_count !== players.length) - return - - if (!game.result || game.result === "None") - return - - let winners = 0 - for (let p of players) - if (is_winner(p.role, game.result)) - winners ++ - - if (winners === 0) - return - - for (let p of players) - if (is_winner(p.role, game.result)) - p.change = elo_change(p, players, 1 / winners) - else - p.change = elo_change(p, players, 0) - - for (let p of players) - SQL_INSERT_RATING.run(game.title_id, p.user_id, p.rating + p.change, p.count + 1, game.mtime) -} - -db.exec("begin transaction") -db.exec("delete from ratings") -for (let game of SQL_SELECT_GAMES.all()) - update_elo_ratings(game) -db.exec("commit") diff --git a/tools/export-game.sh b/tools/export-game.sh deleted file mode 100644 index 19cd4e7..0000000 --- a/tools/export-game.sh +++ /dev/null @@ -1,8 +0,0 @@ -#!/bin/bash -if [ -n "$1" ] -then - sqlite3 db "select export from game_export_view where game_id=$1" -else - echo "usage: bash tools/export-game.sh GAME > game.json" -fi - diff --git a/tools/fuzz.js b/tools/fuzz.js new file mode 100644 index 0000000..0690697 --- /dev/null +++ b/tools/fuzz.js @@ -0,0 +1,204 @@ +"use strict" + +const crypto = require('crypto') +const fs = require("fs") +const path = require("path") +const { FuzzedDataProvider } = require("@jazzer.js/core") + +const RULES_JS_FILE = process.env.RULES || "rules.js" +const MAX_ERRORS = parseInt(process.env.MAX_ERRORS || 100) +const MAX_STEPS = parseInt(process.env.MAX_STEPS || 10000) +const TIMEOUT = parseInt(process.env.TIMEOUT || 250) + +console.log(`Loading fuzzer ${RULES_JS_FILE}`) + +const rules = require(RULES_JS_FILE) +const title_id = path.basename(path.dirname(RULES_JS_FILE)) + +var error_count = 0 + +globalThis.RTT_FUZZER = true + +exports.fuzz = function (fuzzerInputData) { + var data = new FuzzedDataProvider(fuzzerInputData) + if (data.remainingBytes < 16) { + // insufficient bytes to start + return + } + + var scenarios = Array.isArray(rules.scenarios) ? rules.scenarios : Object.values(rules.scenarios).flat() + var scenario = data.pickValue(scenarios) + if (scenario.startsWith("Random")) + return + + var timeout = Date.now() + TIMEOUT + + var options = {} // TODO: randomize options + + var roles = rules.roles + if (typeof roles === "function") + roles = roles(scenario, options) + + var seed = data.consumeIntegralInRange(1, 2 ** 35 - 31) + + var ctx = { + player_count: roles.length, + players: roles.map((r, ix) => ({ role: r, name: "rtt-fuzzer-" + (ix+1) })), + scenario, + options, + replay: [], + state: {}, + active: null, + step: 0, + } + + ctx.replay.push([ null, ".setup", [ seed, scenario, options ] ]) + ctx.state = rules.setup(seed, scenario, options) + + while (ctx.state.active && ctx.state.active !== "None") { + + // insufficient bytes to continue + if (data.remainingBytes < 16) + return + + ctx.active = ctx.state.active + + // If multiple players can act, we'll pick a random player to go first. + if (Array.isArray(ctx.active)) + ctx.active = data.pickValue(ctx.active) + if (ctx.active === "Both") + ctx.active = data.pickValue(roles) + + try { + ctx.view = rules.view(ctx.state, ctx.active) + } catch (e) { + return log_crash(e, ctx) + } + + if (ctx.step > MAX_STEPS) + return log_crash("MaxSteps", ctx) + if (Date.now() > timeout) + return log_crash("Timeout", ctx) + + if (ctx.view.prompt && ctx.view.prompt.startsWith("TODO:")) + return log_crash(ctx.view.prompt, ctx) + + if (!ctx.view.actions) + return log_crash("NoMoreActions", ctx) + + var actions = Object.entries(ctx.view.actions).filter(([ action, args ]) => { + // remove undo from action list (useful to test for dead-ends) + if (action === "undo") + return false + // remove disabled buttons from action list + if (args === 0 || args === false) + return false + return true + }) + + if (actions.length === 0) + return log_crash("NoMoreActions", ctx) + + var [ action, args ] = data.pickValue(actions) + var arg = undefined + if (Array.isArray(args)) { + for (arg of args) { + if (typeof arg !== "number") + return log_crash(`BadActionArgs: ${action} ${JSON.stringify(args)}`, ctx) + } + arg = data.pickValue(args) + } else if (args !== 1 && args !== true) { + return log_crash(`BadActionArgs: ${action} ${JSON.stringify(args)}`, ctx) + } + + var prev_state = object_copy(ctx.state) + + try { + ctx.state = rules.action(ctx.state, ctx.active, action, arg) + if (typeof rules.assert_state === "function") + rules.assert_state(ctx.state) + } catch (e) { + ctx.state = prev_state + return log_crash(e, ctx, action, arg) + } + + ctx.replay.push([ ctx.active, action, arg ]) + + if (ctx.state.undo.length > 0) { + if (String(prev_state.active) !== String(ctx.state.active)) + return log_crash("UndoAfterActiveChange", ctx, action, arg) + if (prev_state.seed !== ctx.state.seed) + return log_crash("UndoAfterRandom", ctx, action, arg) + } + + ctx.step += 1 + } +} + +function log_crash(message, ctx, action = undefined, arg = undefined) { + if (message instanceof Error) + message = message.stack + + var line = `ERROR=${message}` + line += `\n\tTITLE=${title_id} ACTIVE=${ctx.active} STATE=${ctx.state?.state ?? ctx.state?.L?.P} STEP=${ctx.step}` + line += "SETUP=" + JSON.stringify(ctx.replay[0][2]) + if (action !== undefined) { + line += `\n\t\tACTION=${action}` + if (arg !== undefined) + line += JSON.stringify(arg) + } + + var game = { + setup: { + title_id, + scenario: ctx.scenario, + options: ctx.options, + player_count: ctx.player_count, + }, + players: ctx.players, + state: ctx.state, + replay: ctx.replay, + } + + var json = JSON.stringify(game) + var hash = crypto.createHash("sha1").update(json).digest("hex") + var dump = `fuzzer/dump-${title_id}-${hash}.json` + + line += "\n\tDUMP=" + dump + + if (!fs.existsSync(dump)) { + console.log(line) + fs.writeFileSync(dump, json) + } else { + console.log(line) + } + + if (++error_count >= MAX_ERRORS) + throw new Error("too many errors") +} + +function object_copy(original) { + var copy, i, n, v + if (Array.isArray(original)) { + n = original.length + copy = new Array(n) + for (i = 0; i < n; ++i) { + v = original[i] + if (typeof v === "object" && v !== null) + copy[i] = object_copy(v) + else + copy[i] = v + } + return copy + } else { + copy = {} + for (i in original) { + v = original[i] + if (typeof v === "object" && v !== null) + copy[i] = object_copy(v) + else + copy[i] = v + } + return copy + } +} diff --git a/tools/fuzz.sh b/tools/fuzz.sh deleted file mode 100755 index fd2391b..0000000 --- a/tools/fuzz.sh +++ /dev/null @@ -1,16 +0,0 @@ -#!/bin/bash - -TITLE=$1 -shift - -if [ ! -f ./public/$TITLE/rules.js ] -then - echo usage: bash tools/fuzz.sh title_id - exit 1 -fi - -mkdir -p fuzzer/corpus-$TITLE - -RULES=../public/$TITLE/rules.js \ - npx jazzer tools/rtt-fuzz.js --sync fuzzer/corpus-$TITLE "$@" -- -exact_artifact_path=/dev/null | \ - tee fuzzer/log-$TITLE.txt diff --git a/tools/gencovers.sh b/tools/gencovers.sh deleted file mode 100644 index 454d69b..0000000 --- a/tools/gencovers.sh +++ /dev/null @@ -1,43 +0,0 @@ -for F in public/*/cover.jpg public/*/cover.png -do - echo Processing: $F - B=$(echo $F | sed s/.jpg// | sed s/.png//) - D=$(dirname $F) - - if [ $F -nt $D/thumbnail.png ] - then - - PORTRAIT=$(convert $F -format '%[fx:w $D/thumbnail.jpg - pngtopnm $B.1x.png | cjpeg -progressive -optimize -sample 1x1 -quality 95 > $B.1x.jpg - pngtopnm $B.2x.png | cjpeg -progressive -optimize -sample 1x1 -quality 95 > $B.2x.jpg - -done diff --git a/tools/import-game.js b/tools/import-game.js deleted file mode 100755 index 4380252..0000000 --- a/tools/import-game.js +++ /dev/null @@ -1,80 +0,0 @@ -#!/usr/bin/env -S node - -const fs = require("fs") -const sqlite3 = require("better-sqlite3") - -var options = {} -var input = [] - -for (let i = 2; i < process.argv.length; ++i) { - let opt = process.argv[i] - if (opt.includes("=")) { - let [key, val] = opt.split("=", 2) - options[key] = val - } else { - input.push(opt) - } -} - -if (input.length < 1) { - console.error("usage: node tools/import-game.js [title_id=value] [notice=value] game.json") - process.exit(1) -} - -for (let file of input) { - var game = JSON.parse(fs.readFileSync(file, "utf8")) - - if (options.title_id) - game.setup.title_id = options.title_id - if (options.notice) - game.setup.notice = options.notice - - if (game.setup.notice === undefined) - game.setup.notice = "" - if (game.setup.options === undefined) - game.setup.options = "{}" - - game.setup.active = String(game.state.active) - game.setup.moves = game.snaps && game.snaps.length > 0 ? game.snaps.length - 1 : 0 - - let db = new sqlite3("db") - - let insert_game = db.prepare("insert into games(status,owner_id,title_id,scenario,options,player_count,active,moves,notice) values (1,1,:title_id,:scenario,:options,:player_count,:active,:moves,:notice) returning game_id").pluck() - let insert_player = db.prepare("insert into players(game_id,role,user_id,clock) values (?,?,?,21)") - let insert_state = db.prepare("insert into game_state(game_id,state) values (?,?)") - let update_active_trigger = db.prepare("update games set active=active where game_id=?") - - let select_user = db.prepare("select user_id from users where name=?").pluck() - - db.exec("begin") - - game.setup.options = JSON.stringify(game.setup.options) - - function find_user(name) { - return select_user.get(name) || 1 - } - - let game_id = insert_game.get(game.setup) - for (let p of game.players) - insert_player.run(game_id, p.role, find_user(p.name)) - insert_state.run(game_id, JSON.stringify(game.state)) - update_active_trigger.run(game_id) - - if (game.replay) { - let insert_replay = db.prepare("insert into game_replay(game_id,replay_id,role,action,arguments) values (?,?,?,?,?)") - game.replay.forEach(([role, action, args], i) => { - insert_replay.run(game_id, i+1, role, action, JSON.stringify(args)) - }) - } - - if (game.snaps) { - let insert_snap = db.prepare("insert into game_snap(game_id,snap_id,replay_id,state) values (?,?,?,?)") - game.snaps.forEach(([replay_id, state], i) => { - insert_snap.run(game_id, i+1, replay_id, JSON.stringify(state)) - }) - } - - console.log(game_id) - - db.exec("commit") -} diff --git a/tools/lift-bans.sh b/tools/lift-bans.sh deleted file mode 100644 index e76f621..0000000 --- a/tools/lift-bans.sh +++ /dev/null @@ -1,30 +0,0 @@ -#!/bin/bash - -sqlite3 db < timeout_total) and (julianday() > julianday(timeout_last)+14) as lift_ban - from - user_profile_view - where - user_id in (select user_id from tm_banned) - order by lift_ban desc, timeout_last asc -; - -select * from tm_lift_ban_view; - -delete from tm_banned where user_id in (select user_id from tm_lift_ban_view where lift_ban) returning user_id; - -commit; - -EOF diff --git a/tools/new-layout.js b/tools/new-layout.js old mode 100644 new mode 100755 index ce0bb6e..238a257 --- a/tools/new-layout.js +++ b/tools/new-layout.js @@ -1,3 +1,5 @@ +#!/usr/bin/env -S node + const print = console.log if (process.argv.length < 4) { diff --git a/tools/patchgame.js b/tools/patchgame.js deleted file mode 100755 index de8721e..0000000 --- a/tools/patchgame.js +++ /dev/null @@ -1,291 +0,0 @@ -#!/usr/bin/env -S node - -const sqlite3 = require("better-sqlite3") - -let db = new sqlite3("db") - -let select_game = db.prepare("select * from games where game_id=?") - -let select_replay = db.prepare("select * from game_replay where game_id=?") -let delete_replay = db.prepare("delete from game_replay where game_id=?") -let insert_replay = db.prepare("insert into game_replay (game_id,replay_id,role,action,arguments) values (?,?,?,?,?)") - -let delete_snap = db.prepare("delete from game_snap where game_id=?") -let insert_snap = db.prepare("insert into game_snap(game_id,snap_id,replay_id,state) values (?,?,?,?)") - -let update_state = db.prepare("update game_state set state=? where game_id=?") -let update_active = db.prepare("update games set active=? where game_id=?") - -let update_result = db.prepare("update games set status=?, result=? where game_id=?") - -const CRC32C_TABLE = new Int32Array([ - 0x00000000, 0xf26b8303, 0xe13b70f7, 0x1350f3f4, 0xc79a971f, 0x35f1141c, 0x26a1e7e8, 0xd4ca64eb, - 0x8ad958cf, 0x78b2dbcc, 0x6be22838, 0x9989ab3b, 0x4d43cfd0, 0xbf284cd3, 0xac78bf27, 0x5e133c24, - 0x105ec76f, 0xe235446c, 0xf165b798, 0x030e349b, 0xd7c45070, 0x25afd373, 0x36ff2087, 0xc494a384, - 0x9a879fa0, 0x68ec1ca3, 0x7bbcef57, 0x89d76c54, 0x5d1d08bf, 0xaf768bbc, 0xbc267848, 0x4e4dfb4b, - 0x20bd8ede, 0xd2d60ddd, 0xc186fe29, 0x33ed7d2a, 0xe72719c1, 0x154c9ac2, 0x061c6936, 0xf477ea35, - 0xaa64d611, 0x580f5512, 0x4b5fa6e6, 0xb93425e5, 0x6dfe410e, 0x9f95c20d, 0x8cc531f9, 0x7eaeb2fa, - 0x30e349b1, 0xc288cab2, 0xd1d83946, 0x23b3ba45, 0xf779deae, 0x05125dad, 0x1642ae59, 0xe4292d5a, - 0xba3a117e, 0x4851927d, 0x5b016189, 0xa96ae28a, 0x7da08661, 0x8fcb0562, 0x9c9bf696, 0x6ef07595, - 0x417b1dbc, 0xb3109ebf, 0xa0406d4b, 0x522bee48, 0x86e18aa3, 0x748a09a0, 0x67dafa54, 0x95b17957, - 0xcba24573, 0x39c9c670, 0x2a993584, 0xd8f2b687, 0x0c38d26c, 0xfe53516f, 0xed03a29b, 0x1f682198, - 0x5125dad3, 0xa34e59d0, 0xb01eaa24, 0x42752927, 0x96bf4dcc, 0x64d4cecf, 0x77843d3b, 0x85efbe38, - 0xdbfc821c, 0x2997011f, 0x3ac7f2eb, 0xc8ac71e8, 0x1c661503, 0xee0d9600, 0xfd5d65f4, 0x0f36e6f7, - 0x61c69362, 0x93ad1061, 0x80fde395, 0x72966096, 0xa65c047d, 0x5437877e, 0x4767748a, 0xb50cf789, - 0xeb1fcbad, 0x197448ae, 0x0a24bb5a, 0xf84f3859, 0x2c855cb2, 0xdeeedfb1, 0xcdbe2c45, 0x3fd5af46, - 0x7198540d, 0x83f3d70e, 0x90a324fa, 0x62c8a7f9, 0xb602c312, 0x44694011, 0x5739b3e5, 0xa55230e6, - 0xfb410cc2, 0x092a8fc1, 0x1a7a7c35, 0xe811ff36, 0x3cdb9bdd, 0xceb018de, 0xdde0eb2a, 0x2f8b6829, - 0x82f63b78, 0x709db87b, 0x63cd4b8f, 0x91a6c88c, 0x456cac67, 0xb7072f64, 0xa457dc90, 0x563c5f93, - 0x082f63b7, 0xfa44e0b4, 0xe9141340, 0x1b7f9043, 0xcfb5f4a8, 0x3dde77ab, 0x2e8e845f, 0xdce5075c, - 0x92a8fc17, 0x60c37f14, 0x73938ce0, 0x81f80fe3, 0x55326b08, 0xa759e80b, 0xb4091bff, 0x466298fc, - 0x1871a4d8, 0xea1a27db, 0xf94ad42f, 0x0b21572c, 0xdfeb33c7, 0x2d80b0c4, 0x3ed04330, 0xccbbc033, - 0xa24bb5a6, 0x502036a5, 0x4370c551, 0xb11b4652, 0x65d122b9, 0x97baa1ba, 0x84ea524e, 0x7681d14d, - 0x2892ed69, 0xdaf96e6a, 0xc9a99d9e, 0x3bc21e9d, 0xef087a76, 0x1d63f975, 0x0e330a81, 0xfc588982, - 0xb21572c9, 0x407ef1ca, 0x532e023e, 0xa145813d, 0x758fe5d6, 0x87e466d5, 0x94b49521, 0x66df1622, - 0x38cc2a06, 0xcaa7a905, 0xd9f75af1, 0x2b9cd9f2, 0xff56bd19, 0x0d3d3e1a, 0x1e6dcdee, 0xec064eed, - 0xc38d26c4, 0x31e6a5c7, 0x22b65633, 0xd0ddd530, 0x0417b1db, 0xf67c32d8, 0xe52cc12c, 0x1747422f, - 0x49547e0b, 0xbb3ffd08, 0xa86f0efc, 0x5a048dff, 0x8ecee914, 0x7ca56a17, 0x6ff599e3, 0x9d9e1ae0, - 0xd3d3e1ab, 0x21b862a8, 0x32e8915c, 0xc083125f, 0x144976b4, 0xe622f5b7, 0xf5720643, 0x07198540, - 0x590ab964, 0xab613a67, 0xb831c993, 0x4a5a4a90, 0x9e902e7b, 0x6cfbad78, 0x7fab5e8c, 0x8dc0dd8f, - 0xe330a81a, 0x115b2b19, 0x020bd8ed, 0xf0605bee, 0x24aa3f05, 0xd6c1bc06, 0xc5914ff2, 0x37faccf1, - 0x69e9f0d5, 0x9b8273d6, 0x88d28022, 0x7ab90321, 0xae7367ca, 0x5c18e4c9, 0x4f48173d, 0xbd23943e, - 0xf36e6f75, 0x0105ec76, 0x12551f82, 0xe03e9c81, 0x34f4f86a, 0xc69f7b69, 0xd5cf889d, 0x27a40b9e, - 0x79b737ba, 0x8bdcb4b9, 0x988c474d, 0x6ae7c44e, 0xbe2da0a5, 0x4c4623a6, 0x5f16d052, 0xad7d5351 -]) - -function crc32c(data) { - let x = 0 - for (let i = 0, n = data.length; i < n; ++i) - x = CRC32C_TABLE[(x ^ data.charCodeAt(i)) & 0xff] ^ (x >>> 8) - return x ^ -1 -} - -function snapshot(state) { - let save_undo = state.undo - let save_log = state.log - state.undo = undefined - state.log = save_log.length - let snap = JSON.stringify(state) - state.undo = save_undo - state.log = save_log - return snap -} - -function is_role_active(active, role) { - return active === role || active === "Both" || active.includes(role) -} - -function is_nobody_active(active) { - return !active || active === "None" -} - -function is_multi_active(active) { - if (!active) - return false - if (Array.isArray(active)) - return true - return active === "Both" || active.includes(",") -} - -function is_changed_active(old_active, new_active) { - return String(old_active) !== String(new_active) -} - -function is_valid_action(rules, state, role, action, arg) { - if (action === "undo") // for jc, hots, r3, and cr compatibility - return true - if (!is_role_active(state.active, role)) - return false - let view = rules.view(state, role) - let va = view.actions[action] - if (va) { - if (Array.isArray(va) && va.includes(arg)) - return true - if (arg === undefined || arg === null || arg === 1 || Array.isArray(arg)) - return (va === 1 || va === true || typeof va === "string") - } - return false -} - -function dont_snap(rules, state, old_active) { - if (is_nobody_active(state.active)) - return true - if (is_multi_active(old_active) && is_multi_active(state.active)) - return true - if (!is_changed_active(old_active, state.active)) - return true - if (rules.dont_snap && rules.dont_snap(state)) - return true - return false -} - -function get_game_roles(rules, scenario, options) { - let roles = rules.roles - if (typeof roles === "function") { - if (typeof options === "string") - options = JSON.parse(options) - return roles(scenario, options) - } - return roles -} - -function get_resign_result(roles, role) { - return roles.filter(r => r !== role).join(", ") -} - -function finish_game(rules, state, result, message) { - if (typeof rules.finish === "function") { - state = RULES[title_id].finish(state, result, message) - } else { - state.state = "game_over" - state.active = "None" - state.result = result - state.victory = message - state.log.push("") - state.log.push(message) - } - return state -} - -function patch_game(game_id, {validate_actions=true, save_snaps=true, delete_undo=false, delete_invalid=false}, verbose) { - let game = select_game.get(game_id) - if (!game) { - console.error("game not found:", game_id) - return - } - - let title_id = game.title_id - let rules = require("../public/" + title_id + "/rules.js") - let roles = get_game_roles(rules, game.scenario, game.options) - - let replay = select_replay.all(game_id) - if (replay.length === 0) - return - - console.log("processing", game_id, title_id) - - try { - let state = null - let old_active = null - let need_to_rewrite = false - - for (let i = 0; i < replay.length; ++i) { - let item = replay[i] - - if (verbose) - console.log(item.replay_id, item.role, item.action, item.arguments) - - let args = JSON.parse(item.arguments) - switch (item.action) { - case ".setup": - state = rules.setup(...args) - break - case ".timeout": - finish_game(rules, state, "None", item.role + " timed out.") - break - case ".abandon": - finish_game(rules, state, "None", item.role + " abandoned the game.") - case ".resign": - finish_game(rules, state, get_resign_result(roles, item.role), item.role + " resigned.") - break - default: - if (validate_actions) { - if (!is_valid_action(rules, state, item.role, item.action, args)) { - console.error(`invalid action: ${item.role} ${item.action} ${item.arguments}`) - console.error("\t", state.state, state.active, JSON.stringify(rules.view(state, item.role).actions)) - if (i < replay.length) { - console.log("BROKEN ENTRIES: %d", replay.length-i) - console.log(`sqlite3 db "delete from game_replay where game_id=${game_id} and replay_id>=${replay[i].replay_id}"`) - } - throw "invalid action" - } - } - state = rules.action(state, item.role, item.action, args) - break - } - - item.state = snapshot(state) - item.checksum = crc32c(item.state) - if (!dont_snap(rules, state, old_active)) - item.save = 1 - old_active = state.active - - if (delete_undo) { - if (item.action === "undo") { - for (let k = i-1; k >= 0; --k) { - if (replay[k].checksum === item.checksum) { - need_to_rewrite = true - for (let z = k+1; z <= i; ++z) - replay[z].remove = 1 - break - } - } - } - } - } - - db.exec("begin") - - if (need_to_rewrite) { - delete_replay.run(game_id) - for (item of replay) - if (!item.remove) - insert_replay.run(game_id, item.replay_id, item.role, item.action, item.arguments) - } - - if (save_snaps) { - delete_snap.run(game_id) - let snap_id = 0 - for (item of replay) - if (item.save) - insert_snap.run(game_id, ++snap_id, item.replay_id, item.state) - } - - update_active.run(String(state.active), game_id) - update_state.run(JSON.stringify(state), game_id) - - if (state.state === "game_over") - update_result.run(2, state.result, game_id) - else - update_result.run(1, null, game_id) - - db.exec("commit") - - } catch (err) { - if (err !== "invalid action") - console.error("ERROR", game_id, title_id, err) - if (delete_invalid) { - delete_replay.run(game_id) - delete_snap.run(game_id) - } - } -} - -function patch_all(options) { - for (let game_id of db.prepare("select game_id from games where status=1").pluck().all()) - patch_game(game_id, options, false) -} - -function patch_title(title_id, options) { - for (let game_id of db.prepare("select game_id from games where status=1 and title_id=?").pluck().all(title_id)) - patch_game(game_id, options, false) -} - -if (process.argv.length < 3) { - process.stderr.write("usage: ./tools/patchgame.js '{options}'\n") - process.stderr.write(" or: ./tools/patchgame.js '{options}'\n") - process.stderr.write(" or: ./tools/patchgame.js all '{options}'\n") - process.stderr.write('options: { "validate_actions":true, "delete_invalid":false, "save_snaps":true, "delete_undo":false }\n') - process.exit(1) -} - -let options = {} -if (process.argv.length === 4) - options = JSON.parse(process.argv[3]) - -if (process.argv[2] === 'all') - patch_all(options) -else if (isNaN(process.argv[2])) - patch_title(process.argv[2], options) -else - patch_game(parseInt(process.argv[2]), options, true) diff --git a/tools/purge.sql b/tools/purge.sql deleted file mode 100644 index 2a95f01..0000000 --- a/tools/purge.sql +++ /dev/null @@ -1,35 +0,0 @@ --- Prune game snapshot and game state data to save database space. - -attach database 'db' as live; - -pragma live.busy_timeout=10000; - -create temporary view prune_snap_list as - select - distinct game_id - from - live.game_snap - where - game_id in ( - select game_id from live.games - where status=2 and date(mtime) < date('now', '-7 days') - ) - ; - -create temporary view prune_all_list as - select - distinct game_id - from - live.games - where - game_id in ( - select game_id from live.games - where status=2 and date(mtime) < date('now', '-28 days') - ) - ; - -select 'PURGE SNAPS FROM ' || count(1) from prune_snap_list; -delete from live.game_snap where game_id in (select game_id from prune_snap_list); - -select 'PURGE ALL FROM ' || count(1) from prune_all_list; -update live.games set status = 3 where game_id in (select game_id from prune_all_list); diff --git a/tools/readgame.sh b/tools/readgame.sh deleted file mode 100644 index 4a8fdbd..0000000 --- a/tools/readgame.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/bash -if [ -n "$1" -a -n "$2" ] -then - sqlite3 db "select writefile('$2',state) from game_state where game_id = $1" -elif [ -n "$1" ] -then - sqlite3 db "select state from game_state where game_id = $1" -else - echo "usage: bash tools/readgame.sh GAME [ state.json ]" -fi diff --git a/tools/rtt-fuzz.js b/tools/rtt-fuzz.js deleted file mode 100755 index 0690697..0000000 --- a/tools/rtt-fuzz.js +++ /dev/null @@ -1,204 +0,0 @@ -"use strict" - -const crypto = require('crypto') -const fs = require("fs") -const path = require("path") -const { FuzzedDataProvider } = require("@jazzer.js/core") - -const RULES_JS_FILE = process.env.RULES || "rules.js" -const MAX_ERRORS = parseInt(process.env.MAX_ERRORS || 100) -const MAX_STEPS = parseInt(process.env.MAX_STEPS || 10000) -const TIMEOUT = parseInt(process.env.TIMEOUT || 250) - -console.log(`Loading fuzzer ${RULES_JS_FILE}`) - -const rules = require(RULES_JS_FILE) -const title_id = path.basename(path.dirname(RULES_JS_FILE)) - -var error_count = 0 - -globalThis.RTT_FUZZER = true - -exports.fuzz = function (fuzzerInputData) { - var data = new FuzzedDataProvider(fuzzerInputData) - if (data.remainingBytes < 16) { - // insufficient bytes to start - return - } - - var scenarios = Array.isArray(rules.scenarios) ? rules.scenarios : Object.values(rules.scenarios).flat() - var scenario = data.pickValue(scenarios) - if (scenario.startsWith("Random")) - return - - var timeout = Date.now() + TIMEOUT - - var options = {} // TODO: randomize options - - var roles = rules.roles - if (typeof roles === "function") - roles = roles(scenario, options) - - var seed = data.consumeIntegralInRange(1, 2 ** 35 - 31) - - var ctx = { - player_count: roles.length, - players: roles.map((r, ix) => ({ role: r, name: "rtt-fuzzer-" + (ix+1) })), - scenario, - options, - replay: [], - state: {}, - active: null, - step: 0, - } - - ctx.replay.push([ null, ".setup", [ seed, scenario, options ] ]) - ctx.state = rules.setup(seed, scenario, options) - - while (ctx.state.active && ctx.state.active !== "None") { - - // insufficient bytes to continue - if (data.remainingBytes < 16) - return - - ctx.active = ctx.state.active - - // If multiple players can act, we'll pick a random player to go first. - if (Array.isArray(ctx.active)) - ctx.active = data.pickValue(ctx.active) - if (ctx.active === "Both") - ctx.active = data.pickValue(roles) - - try { - ctx.view = rules.view(ctx.state, ctx.active) - } catch (e) { - return log_crash(e, ctx) - } - - if (ctx.step > MAX_STEPS) - return log_crash("MaxSteps", ctx) - if (Date.now() > timeout) - return log_crash("Timeout", ctx) - - if (ctx.view.prompt && ctx.view.prompt.startsWith("TODO:")) - return log_crash(ctx.view.prompt, ctx) - - if (!ctx.view.actions) - return log_crash("NoMoreActions", ctx) - - var actions = Object.entries(ctx.view.actions).filter(([ action, args ]) => { - // remove undo from action list (useful to test for dead-ends) - if (action === "undo") - return false - // remove disabled buttons from action list - if (args === 0 || args === false) - return false - return true - }) - - if (actions.length === 0) - return log_crash("NoMoreActions", ctx) - - var [ action, args ] = data.pickValue(actions) - var arg = undefined - if (Array.isArray(args)) { - for (arg of args) { - if (typeof arg !== "number") - return log_crash(`BadActionArgs: ${action} ${JSON.stringify(args)}`, ctx) - } - arg = data.pickValue(args) - } else if (args !== 1 && args !== true) { - return log_crash(`BadActionArgs: ${action} ${JSON.stringify(args)}`, ctx) - } - - var prev_state = object_copy(ctx.state) - - try { - ctx.state = rules.action(ctx.state, ctx.active, action, arg) - if (typeof rules.assert_state === "function") - rules.assert_state(ctx.state) - } catch (e) { - ctx.state = prev_state - return log_crash(e, ctx, action, arg) - } - - ctx.replay.push([ ctx.active, action, arg ]) - - if (ctx.state.undo.length > 0) { - if (String(prev_state.active) !== String(ctx.state.active)) - return log_crash("UndoAfterActiveChange", ctx, action, arg) - if (prev_state.seed !== ctx.state.seed) - return log_crash("UndoAfterRandom", ctx, action, arg) - } - - ctx.step += 1 - } -} - -function log_crash(message, ctx, action = undefined, arg = undefined) { - if (message instanceof Error) - message = message.stack - - var line = `ERROR=${message}` - line += `\n\tTITLE=${title_id} ACTIVE=${ctx.active} STATE=${ctx.state?.state ?? ctx.state?.L?.P} STEP=${ctx.step}` - line += "SETUP=" + JSON.stringify(ctx.replay[0][2]) - if (action !== undefined) { - line += `\n\t\tACTION=${action}` - if (arg !== undefined) - line += JSON.stringify(arg) - } - - var game = { - setup: { - title_id, - scenario: ctx.scenario, - options: ctx.options, - player_count: ctx.player_count, - }, - players: ctx.players, - state: ctx.state, - replay: ctx.replay, - } - - var json = JSON.stringify(game) - var hash = crypto.createHash("sha1").update(json).digest("hex") - var dump = `fuzzer/dump-${title_id}-${hash}.json` - - line += "\n\tDUMP=" + dump - - if (!fs.existsSync(dump)) { - console.log(line) - fs.writeFileSync(dump, json) - } else { - console.log(line) - } - - if (++error_count >= MAX_ERRORS) - throw new Error("too many errors") -} - -function object_copy(original) { - var copy, i, n, v - if (Array.isArray(original)) { - n = original.length - copy = new Array(n) - for (i = 0; i < n; ++i) { - v = original[i] - if (typeof v === "object" && v !== null) - copy[i] = object_copy(v) - else - copy[i] = v - } - return copy - } else { - copy = {} - for (i in original) { - v = original[i] - if (typeof v === "object" && v !== null) - copy[i] = object_copy(v) - else - copy[i] = v - } - return copy - } -} diff --git a/tools/run.sh b/tools/run.sh deleted file mode 100644 index efadfe7..0000000 --- a/tools/run.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash -while true -do - nodemon --exitcrash server.js - echo Restarting soon... - sleep 3 -done diff --git a/tools/showgame.sh b/tools/showgame.sh deleted file mode 100644 index f45be78..0000000 --- a/tools/showgame.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash -if [ -n "$1" ] -then - sqlite3 db "select json_remove(json_remove(state, '$.undo'), '$.log') from game_state where game_id = $1" -else - echo "usage: bash tools/showgame.sh GAME" -fi diff --git a/tools/showreplay.sh b/tools/showreplay.sh deleted file mode 100644 index 413e12f..0000000 --- a/tools/showreplay.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/bash -sqlite3 db "select * from game_replay where game_id=$1" diff --git a/tools/unarchive.sh b/tools/unarchive.sh deleted file mode 100644 index 6adb300..0000000 --- a/tools/unarchive.sh +++ /dev/null @@ -1,35 +0,0 @@ -#!/bin/bash -# Restore purged game state from archive. - -if [ -z "$1" ] -then - echo 'usage: bash tools/unarchive.sh ' - exit 1 -fi - -sqlite3 db << EOF - -attach database 'archive.db' as archive; - -begin; - -select 'RESTORE ' || $1 || ' FROM ARCHIVE'; - -.mode table -select * from archive.games where game_id = $1; - -insert or replace into game_state (game_id, state) - select game_id, state - from archive.game_state where game_id = $1; - -insert or replace into game_replay (game_id, replay_id, role, action, arguments) - select game_id, replay_id, role, action, arguments - from archive.game_replay where game_id = $1; - -insert or replace into game_chat (game_id, chat_id, user_id, time, message) - select game_id, chat_id, user_id, time, message - from archive.game_chat where game_id = $1; - -commit; - -EOF diff --git a/tools/undo.sh b/tools/undo.sh deleted file mode 100644 index b75182f..0000000 --- a/tools/undo.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/bin/bash -if [ -n "$1" ] -then - if [ -n "$2" ] - then - COUNT=$2 - else - COUNT=$(sqlite3 db "select coalesce(max(replay_id),0) from game_replay where game_id=$1") - echo Game has $COUNT actions. - fi - sqlite3 db "delete from game_replay where game_id=$1 and replay_id>=$COUNT" - node tools/patchgame.js $1 '{"validate_actions":false}' -else - echo "usage: bash tools/undo.sh GAME" -fi diff --git a/tools/writegame.sh b/tools/writegame.sh deleted file mode 100644 index ea0f599..0000000 --- a/tools/writegame.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash -if [ -n "$1" -a -f "$2" ] -then - sqlite3 db "update game_state set state=readfile('$2') where game_id = $1" -else - echo "usage: bash tools/writegame.sh GAME state.json" -fi -- cgit v1.2.3