From 0ead2da2da9d4aab9f85b3c547e66e808ee4a0b5 Mon Sep 17 00:00:00 2001 From: maru Date: Wed, 8 May 2024 15:47:56 -0400 Subject: [PATCH 01/47] Remove unused endpoint game/playercount --- api/common.go | 1 - api/endpoints.go | 4 ---- 2 files changed, 5 deletions(-) diff --git a/api/common.go b/api/common.go index 62ef843..920d41e 100644 --- a/api/common.go +++ b/api/common.go @@ -40,7 +40,6 @@ func Init(mux *http.ServeMux) { mux.HandleFunc("GET /account/logout", handleAccountLogout) // game - mux.HandleFunc("GET /game/playercount", handleGamePlayerCount) mux.HandleFunc("GET /game/titlestats", handleGameTitleStats) mux.HandleFunc("GET /game/classicsessioncount", handleGameClassicSessionCount) diff --git a/api/endpoints.go b/api/endpoints.go index fb41047..ee4f76d 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -144,10 +144,6 @@ func handleAccountLogout(w http.ResponseWriter, r *http.Request) { // game -func handleGamePlayerCount(w http.ResponseWriter, r *http.Request) { - w.Write([]byte(strconv.Itoa(playerCount))) -} - func handleGameTitleStats(w http.ResponseWriter, r *http.Request) { err := json.NewEncoder(w).Encode(defs.TitleStats{ PlayerCount: playerCount, From 7dbcb18ebf36ff738472be995f88a26ea41cb4c5 Mon Sep 17 00:00:00 2001 From: maru Date: Wed, 8 May 2024 17:23:07 -0400 Subject: [PATCH 02/47] Use INSERT instead of REPLACE for savedata storage functions --- db/savedata.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/db/savedata.go b/db/savedata.go index 881345f..dc2c860 100644 --- a/db/savedata.go +++ b/db/savedata.go @@ -65,7 +65,7 @@ func StoreSystemSaveData(uuid []byte, data defs.SystemSaveData) error { return err } - _, err = handle.Exec("REPLACE INTO systemSaveData (uuid, data, timestamp) VALUES (?, ?, UTC_TIMESTAMP())", uuid, buf.Bytes()) + _, err = handle.Exec("INSERT INTO systemSaveData (uuid, data, timestamp) VALUES (?, ?, UTC_TIMESTAMP()) ON DUPLICATE KEY UPDATE data = ?, timestamp = UTC_TIMESTAMP()", uuid, buf.Bytes(), buf.Bytes()) if err != nil { return err } @@ -116,7 +116,7 @@ func StoreSessionSaveData(uuid []byte, data defs.SessionSaveData, slot int) erro return err } - _, err = handle.Exec("REPLACE INTO sessionSaveData (uuid, slot, data, timestamp) VALUES (?, ?, ?, UTC_TIMESTAMP())", uuid, slot, buf.Bytes()) + _, err = handle.Exec("INSERT INTO sessionSaveData (uuid, slot, data, timestamp) VALUES (?, ?, ?, UTC_TIMESTAMP()) ON DUPLICATE KEY UPDATE data = ?, timestamp = UTC_TIMESTAMP()", uuid, slot, buf.Bytes(), buf.Bytes()) if err != nil { return err } From 192b777ac3e0c7b7c603f621637423de0467384a Mon Sep 17 00:00:00 2001 From: maru Date: Wed, 8 May 2024 20:08:10 -0400 Subject: [PATCH 03/47] Set ArgonMaxInstances to number of cores --- api/account/common.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/api/account/common.go b/api/account/common.go index 9102f4e..8e8c0ff 100644 --- a/api/account/common.go +++ b/api/account/common.go @@ -19,6 +19,7 @@ package account import ( "regexp" + "runtime" "golang.org/x/crypto/argon2" ) @@ -34,13 +35,13 @@ const ( ArgonKeySize = 32 ArgonSaltSize = 16 - ArgonMaxInstances = 16 - UUIDSize = 16 TokenSize = 32 ) var ( + ArgonMaxInstances = runtime.NumCPU() + isValidUsername = regexp.MustCompile(`^\w{1,16}$`).MatchString semaphore = make(chan bool, ArgonMaxInstances) ) From 4971ad9d42c7f9ad908d287f9abd7facf2f70e18 Mon Sep 17 00:00:00 2001 From: maru Date: Wed, 8 May 2024 20:19:33 -0400 Subject: [PATCH 04/47] Add new database limits --- db/db.go | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/db/db.go b/db/db.go index 05e92c4..31ad9a8 100644 --- a/db/db.go +++ b/db/db.go @@ -21,9 +21,11 @@ import ( "database/sql" "encoding/hex" "fmt" - _ "github.com/go-sql-driver/mysql" "log" "os" + "time" + + _ "github.com/go-sql-driver/mysql" ) var handle *sql.DB @@ -36,7 +38,10 @@ func Init(username, password, protocol, address, database string) error { return fmt.Errorf("failed to open database connection: %s", err) } - handle.SetMaxOpenConns(1000) + handle.SetMaxIdleConns(256) + handle.SetMaxOpenConns(256) + handle.SetConnMaxIdleTime(time.Second * 30) + handle.SetConnMaxLifetime(time.Minute) tx, err := handle.Begin() if err != nil { From b00321f5011f7101662156ba19d9bb91d0685cc6 Mon Sep 17 00:00:00 2001 From: ser3n1ty <36878537+cgnetsec@users.noreply.github.com> Date: Thu, 9 May 2024 00:51:44 -0700 Subject: [PATCH 05/47] Update README.md --- README.md | 103 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 102 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8cbd26b..ef4608c 100644 --- a/README.md +++ b/README.md @@ -1 +1,102 @@ -# rogueserver \ No newline at end of file +# rogueserver + +# Hosting in Docker +It is advised that you host this in a docker container as it will be much easier to manage. +There is a sample docker-compose file for setting up a docker container to setup this server. + +# Self Hosting outside of Docker: +Recommended Tools: +If using Windows: [Chocolatey](https://chocolatey.org/install) + +## Required Tools: +- Golang +- Node: **18.3.0** +- npm: [how to install](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) + +## Installation: + +Once you have all the prerequisites you will need to setup a database. +There are tons of database services you can choose from: +- mysql - [getting started](https://dev.mysql.com/doc/mysql-getting-started/en/) +- mariadb - [getting started](https://mariadb.com/get-started-with-mariadb/) +- etc + +I went with MySQL. Once the database is setup, make sure that you can authenticate to the database. +After being able to login to the database, create a database/schema called pokeroguedb. +Select it as the default database and then run the sql queries from sqlqueries.sql. You should now be able to see all of the empty tables. + +Edit the following files: +### rogueserver.go:34 +Change the 'false' after "debug" to 'true'. This will resolve CORS issues that many users have been having while trying to spin up their own servers. + +### rogueserver.go:37 +Change the default port if you need to, I set it to 8001. As of another pull request, this should _NOT_ be necessary. + +### rogueserver.go:41-43 +You can choose to specify a different dbaddr, dbproto, or dbname if you so choose, instead of passing a flag during execution. +It is advised that you do not store hardcoded credential sets, but rather pass them in as flags during execution like in the commands below. + +### src/utils.ts:224-225 (in pokerogue) +Replace both URLs (one on each line) with the local API server address from rogueserver.go (0.0.0.0:8001) (or whatever port you picked) + +# If you are on Windows + +Now that all of the files are configured: start up powershell as administrator: +``` +powershell -ep bypass +cd C:\api\server\location\ +go run . -dbuser [usernamehere] -dbpass [passhere] +``` + +Then in another run this the first time then run `npm run start` from the rogueserver location from then on: +``` +powershell -ep bypass +cd C:\rogue\server\location\ +npm install +npm run start +``` +You will need to allow the port youre running the API (8001) on and port 8000 to accept inbound connections through the [Windows Advanced Firewall](https://www.youtube.com/watch?v=9llH5_CON-Y). + +# If you are on Linux +In whatever shell you prefer, run the following: +``` +cd /api/server/location/ +go run . -dbuser [usernamehere] -dbpass [passhere] & +cd /rogue/server/location/ +npm run start & +``` +If you have a firewall running such as ufw on your linux machine, make sure to allow inbound connections on the ports youre running the API and the pokerogue server (8000,8001). +An example to allow incoming connections using UFW: +``` +sudo ufw allow 8000,8001/tcp +``` + +This should allow you to reach the game from other computers on the same network. + +## Tying to a Domain + +If you want to tie it to a domain like I did and make it publicly accessible, there is some extra work to be done. + +I setup caddy and would recommend using it as a reverse proxy. +[caddy installation](https://caddyserver.com/docs/install) +once its installed setup a config file for caddy: + +``` +pokerogue.exampledomain.com { + reverse_proxy localhost:8000 +} +pokeapi.exampledomain.com { + reverse_proxy localhost:8001 +} +``` +Preferably set up caddy as a service from [here.](https://caddyserver.com/docs/running) + +Once this is good to go, take your API url (https://pokeapi.exampledomain.com) and paste it on +### src/utils.ts:224-225 +in place of the previous 0.0.0.0:8001 address + +Make sure that both 8000 and 8001 are portforwarded on your router. + +Test that the server's game and game authentication works from other machines both in and outside of the network. Once this is complete, enjoy! + + From d5e7b438f3d4b4683bd67602fd1f5637663a8b02 Mon Sep 17 00:00:00 2001 From: ser3n1ty <36878537+cgnetsec@users.noreply.github.com> Date: Thu, 9 May 2024 00:57:07 -0700 Subject: [PATCH 06/47] Update README.md added updated information for the docker compose container that is being implemented --- README.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/README.md b/README.md index ef4608c..95becf0 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,7 @@ If using Windows: [Chocolatey](https://chocolatey.org/install) - npm: [how to install](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) ## Installation: - -Once you have all the prerequisites you will need to setup a database. -There are tons of database services you can choose from: -- mysql - [getting started](https://dev.mysql.com/doc/mysql-getting-started/en/) -- mariadb - [getting started](https://mariadb.com/get-started-with-mariadb/) -- etc - -I went with MySQL. Once the database is setup, make sure that you can authenticate to the database. -After being able to login to the database, create a database/schema called pokeroguedb. -Select it as the default database and then run the sql queries from sqlqueries.sql. You should now be able to see all of the empty tables. +The docker compose file should automatically implement a container with mariadb with an empty database and the default user and password combo of pokerogue:pokerogue Edit the following files: ### rogueserver.go:34 From e01364e1a6c6284f05ad44b68016ae04d23010f0 Mon Sep 17 00:00:00 2001 From: ser3n1ty <36878537+cgnetsec@users.noreply.github.com> Date: Thu, 9 May 2024 01:44:04 -0700 Subject: [PATCH 07/47] Update README.md --- README.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 95becf0..3c97821 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,6 @@ If using Windows: [Chocolatey](https://chocolatey.org/install) ## Installation: The docker compose file should automatically implement a container with mariadb with an empty database and the default user and password combo of pokerogue:pokerogue -Edit the following files: -### rogueserver.go:34 -Change the 'false' after "debug" to 'true'. This will resolve CORS issues that many users have been having while trying to spin up their own servers. - -### rogueserver.go:37 -Change the default port if you need to, I set it to 8001. As of another pull request, this should _NOT_ be necessary. - -### rogueserver.go:41-43 -You can choose to specify a different dbaddr, dbproto, or dbname if you so choose, instead of passing a flag during execution. -It is advised that you do not store hardcoded credential sets, but rather pass them in as flags during execution like in the commands below. - ### src/utils.ts:224-225 (in pokerogue) Replace both URLs (one on each line) with the local API server address from rogueserver.go (0.0.0.0:8001) (or whatever port you picked) @@ -36,13 +25,15 @@ Now that all of the files are configured: start up powershell as administrator: ``` powershell -ep bypass cd C:\api\server\location\ -go run . -dbuser [usernamehere] -dbpass [passhere] +go build . +.\rogueserver.exe --debug --dbuser yourusername --dbpass yourpassword ``` +The other available flags are located in rogueserver.go:34-43. Then in another run this the first time then run `npm run start` from the rogueserver location from then on: ``` powershell -ep bypass -cd C:\rogue\server\location\ +cd C:\server\location\ npm install npm run start ``` @@ -52,10 +43,13 @@ You will need to allow the port youre running the API (8001) on and port 8000 to In whatever shell you prefer, run the following: ``` cd /api/server/location/ -go run . -dbuser [usernamehere] -dbpass [passhere] & -cd /rogue/server/location/ +go build . +./rogueserver --debug --dbuser yourusername --dbpass yourpassword & + +cd /server/location/ npm run start & ``` + If you have a firewall running such as ufw on your linux machine, make sure to allow inbound connections on the ports youre running the API and the pokerogue server (8000,8001). An example to allow incoming connections using UFW: ``` From 59ea469fb68182b1ab1c3135e88f2e4aca4efb20 Mon Sep 17 00:00:00 2001 From: maru Date: Thu, 9 May 2024 05:59:48 -0400 Subject: [PATCH 08/47] Don't import legacy saves if system exists in database --- db/db.go | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/db/db.go b/db/db.go index 31ad9a8..e84f031 100644 --- a/db/db.go +++ b/db/db.go @@ -73,6 +73,12 @@ func Init(username, password, protocol, address, database string) error { continue } + var count int + err = handle.QueryRow("SELECT COUNT(*) FROM systemSaveData WHERE uuid = ?", uuid).Scan(&count) + if err != nil || count != 0 { + continue + } + // store new system data systemData, err := LegacyReadSystemSaveData(uuid) if err != nil { From de0bd74dc258f380284c75723b4a4f49fccfc068 Mon Sep 17 00:00:00 2001 From: maru Date: Thu, 9 May 2024 14:13:19 -0400 Subject: [PATCH 09/47] Update database limits --- db/db.go | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/db/db.go b/db/db.go index e84f031..3ab8c87 100644 --- a/db/db.go +++ b/db/db.go @@ -38,8 +38,12 @@ func Init(username, password, protocol, address, database string) error { return fmt.Errorf("failed to open database connection: %s", err) } - handle.SetMaxIdleConns(256) - handle.SetMaxOpenConns(256) + if protocol == "unix" { + handle.SetMaxOpenConns(1000) + } else { + handle.SetMaxOpenConns(200) + } + handle.SetConnMaxIdleTime(time.Second * 30) handle.SetConnMaxLifetime(time.Minute) From e4de7c2391885426ee60cb4e76a466128a38d7dd Mon Sep 17 00:00:00 2001 From: maru Date: Thu, 9 May 2024 14:22:20 -0400 Subject: [PATCH 10/47] Update database limiting code more --- db/db.go | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/db/db.go b/db/db.go index 3ab8c87..d927377 100644 --- a/db/db.go +++ b/db/db.go @@ -37,15 +37,16 @@ func Init(username, password, protocol, address, database string) error { if err != nil { return fmt.Errorf("failed to open database connection: %s", err) } - - if protocol == "unix" { - handle.SetMaxOpenConns(1000) - } else { - handle.SetMaxOpenConns(200) + + conns := 1024 + if protocol != "unix" { + conns = 256 } - handle.SetConnMaxIdleTime(time.Second * 30) - handle.SetConnMaxLifetime(time.Minute) + handle.SetMaxOpenConns(conns) + handle.SetMaxIdleConns(conns/4) + + handle.SetConnMaxIdleTime(time.Second * 10) tx, err := handle.Begin() if err != nil { From fadd10602afbcc451f830cde7099e7fc23c56b17 Mon Sep 17 00:00:00 2001 From: maru Date: Thu, 9 May 2024 14:26:54 -0400 Subject: [PATCH 11/47] Don't log ErrNoRows in savedata --- api/endpoints.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/api/endpoints.go b/api/endpoints.go index ee4f76d..3515f4f 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -18,6 +18,7 @@ package api import ( + "database/sql" "encoding/json" "fmt" "net/http" @@ -280,6 +281,10 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { switch r.URL.Path { case "/savedata/get": save, err = savedata.Get(uuid, datatype, slot) + if err == sql.ErrNoRows { + http.Error(w, err.Error(), http.StatusNotFound) + return + } case "/savedata/update": err = savedata.Update(uuid, slot, save) case "/savedata/delete": From 633142eb293a4fff81f2d5e27466654060bd0e70 Mon Sep 17 00:00:00 2001 From: maru Date: Fri, 10 May 2024 13:16:35 -0400 Subject: [PATCH 12/47] Allow serving HTTPS --- rogueserver.go | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/rogueserver.go b/rogueserver.go index f86185f..5659cae 100644 --- a/rogueserver.go +++ b/rogueserver.go @@ -42,6 +42,9 @@ func main() { dbaddr := flag.String("dbaddr", "localhost", "database address") dbname := flag.String("dbname", "pokeroguedb", "database name") + tlscert := flag.String("tlscert", "", "tls certificate path") + tlskey := flag.String("tlskey", "", "tls key path") + flag.Parse() // register gob types @@ -66,10 +69,15 @@ func main() { api.Init(mux) // start web server + handler := prodHandler(mux) if *debug { - err = http.Serve(listener, debugHandler(mux)) + handler = debugHandler(mux) + } + + if *tlscert == "" { + err = http.Serve(listener, handler) } else { - err = http.Serve(listener, mux) + err = http.ServeTLS(listener, handler, *tlscert, *tlskey) } if err != nil { log.Fatalf("failed to create http server or server errored: %s", err) @@ -107,3 +115,19 @@ func debugHandler(router *http.ServeMux) http.Handler { router.ServeHTTP(w, r) }) } + + +func prodHandler(router *http.ServeMux) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Access-Control-Allow-Headers", "Authorization, Content-Type") + w.Header().Set("Access-Control-Allow-Methods", "OPTIONS, GET, POST") + w.Header().Set("Access-Control-Allow-Origin", "https://pokerogue.net") + + if r.Method == "OPTIONS" { + w.WriteHeader(http.StatusOK) + return + } + + router.ServeHTTP(w, r) + }) +} From 8a32efeaa3985df9cdc7176ba6888e02146ae32e Mon Sep 17 00:00:00 2001 From: maru Date: Fri, 10 May 2024 13:40:00 -0400 Subject: [PATCH 13/47] Clean up rogueserver.go --- rogueserver.go | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/rogueserver.go b/rogueserver.go index 5659cae..42f2d7d 100644 --- a/rogueserver.go +++ b/rogueserver.go @@ -101,6 +101,21 @@ func createListener(proto, addr string) (net.Listener, error) { return listener, nil } +func prodHandler(router *http.ServeMux) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Access-Control-Allow-Headers", "Authorization, Content-Type") + w.Header().Set("Access-Control-Allow-Methods", "OPTIONS, GET, POST") + w.Header().Set("Access-Control-Allow-Origin", "https://pokerogue.net") + + if r.Method == "OPTIONS" { + w.WriteHeader(http.StatusOK) + return + } + + router.ServeHTTP(w, r) + }) +} + func debugHandler(router *http.ServeMux) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { w.Header().Set("Access-Control-Allow-Headers", "*") @@ -116,18 +131,3 @@ func debugHandler(router *http.ServeMux) http.Handler { }) } - -func prodHandler(router *http.ServeMux) http.Handler { - return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Access-Control-Allow-Headers", "Authorization, Content-Type") - w.Header().Set("Access-Control-Allow-Methods", "OPTIONS, GET, POST") - w.Header().Set("Access-Control-Allow-Origin", "https://pokerogue.net") - - if r.Method == "OPTIONS" { - w.WriteHeader(http.StatusOK) - return - } - - router.ServeHTTP(w, r) - }) -} From 3ed5f41d58840f8d6eafcf171eecc4e3dc087da4 Mon Sep 17 00:00:00 2001 From: Up <10714589+UpcraftLP@users.noreply.github.com> Date: Fri, 10 May 2024 21:30:47 +0200 Subject: [PATCH 14/47] make server automatically create DB schema if not exists (#5) * add default values for CLI args * add development docker compose file * prevent crash if userdata dir does not exist * accounts, acccountStats * account stats and create db indices * compensations and daily runs * ensure uniqueness of daily seed * start on port 8001 by default for client parity * make generated schema match production * sort imports --- .gitignore | 6 +++++- api/daily/common.go | 22 ++++++++++---------- api/endpoints.go | 25 +++++++++++++++++++++-- db/daily.go | 20 ++++++++++++++---- db/db.go | 37 ++++++++++++++++++++++++++++++++++ docker-compose.Development.yml | 14 +++++++++++++ rogueserver.go | 4 ++-- 7 files changed, 108 insertions(+), 20 deletions(-) create mode 100644 docker-compose.Development.yml diff --git a/.gitignore b/.gitignore index d61e22d..003f051 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,13 @@ # no extension on linux, .exe on windows rogueserver* -userdata/* +!/rogueserver/* +/userdata/* secret.key +# local testing +/.data/ + # Jetbrains IDEs /.idea/ *.iml diff --git a/api/daily/common.go b/api/daily/common.go index a1247b5..678e0fd 100644 --- a/api/daily/common.go +++ b/api/daily/common.go @@ -61,22 +61,27 @@ func Init() error { secret = newSecret } - err = recordNewDaily() + seed, err := recordNewDaily() if err != nil { log.Print(err) } - log.Printf("Daily Run Seed: %s", Seed()) + log.Printf("Daily Run Seed: %s", seed) - scheduler.AddFunc("@daily", func() { + _, err = scheduler.AddFunc("@daily", func() { time.Sleep(time.Second) - err := recordNewDaily() + seed, err = recordNewDaily() + log.Printf("Daily Run Seed: %s", seed) if err != nil { log.Printf("error while recording new daily: %s", err) } }) + if err != nil { + return err + } + scheduler.Start() return nil @@ -95,11 +100,6 @@ func deriveSeed(seedTime time.Time) []byte { return hashedSeed[:] } -func recordNewDaily() error { - err := db.TryAddDailyRun(Seed()) - if err != nil { - return err - } - - return nil +func recordNewDaily() (string, error) { + return db.TryAddDailyRun(Seed()) } diff --git a/api/endpoints.go b/api/endpoints.go index 3515f4f..a24da22 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -19,6 +19,7 @@ package api import ( "database/sql" + "encoding/base64" "encoding/json" "fmt" "net/http" @@ -303,7 +304,13 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { } // doesn't return a save, but it works - save, err = savedata.Clear(uuid, slot, daily.Seed(), s) + var seed string + seed, err = db.GetDailyRunSeed() + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + save, err = savedata.Clear(uuid, slot, seed, s) } if err != nil { httpError(w, r, err, http.StatusInternalServerError) @@ -327,7 +334,21 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { // daily func handleDailySeed(w http.ResponseWriter, r *http.Request) { - w.Write([]byte(daily.Seed())) + seed, err := db.GetDailyRunSeed() + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + bytes, err := base64.StdEncoding.DecodeString(seed) + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + _, err = w.Write(bytes) + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } } func handleDailyRankings(w http.ResponseWriter, r *http.Request) { diff --git a/db/daily.go b/db/daily.go index 55eb04e..4b0f953 100644 --- a/db/daily.go +++ b/db/daily.go @@ -23,13 +23,25 @@ import ( "github.com/pagefaultgames/rogueserver/defs" ) -func TryAddDailyRun(seed string) error { - _, err := handle.Exec("INSERT INTO dailyRuns (seed, date) VALUES (?, UTC_DATE()) ON DUPLICATE KEY UPDATE date = date", seed) +func TryAddDailyRun(seed string) (string, error) { + var actualSeed string + err := handle.QueryRow("INSERT INTO dailyRuns (seed, date) VALUES (?, UTC_DATE()) ON DUPLICATE KEY UPDATE date = date RETURNING seed", seed).Scan(&actualSeed) if err != nil { - return err + return "INVALID", err } - return nil + return actualSeed, nil +} + +func GetDailyRunSeed() (string, error) { + var seed string + err := handle.QueryRow("SELECT seed FROM dailyRuns WHERE date = UTC_DATE()").Scan(&seed) + if err != nil { + return "INVALID", err + } + + return seed, nil + } func AddOrUpdateAccountDailyRun(uuid []byte, score int, wave int) error { diff --git a/db/db.go b/db/db.go index d927377..f246267 100644 --- a/db/db.go +++ b/db/db.go @@ -52,14 +52,51 @@ func Init(username, password, protocol, address, database string) error { if err != nil { panic(err) } + + // accounts + tx.Exec("CREATE TABLE IF NOT EXISTS accounts (uuid BINARY(16) NOT NULL PRIMARY KEY, username VARCHAR(16) UNIQUE NOT NULL, hash BINARY(32) NOT NULL, salt BINARY(16) NOT NULL, registered TIMESTAMP NOT NULL, lastLoggedIn TIMESTAMP DEFAULT NULL, lastActivity TIMESTAMP DEFAULT NULL, banned TINYINT(1) NOT NULL DEFAULT 0, trainerId SMALLINT(5) UNSIGNED DEFAULT 0, secretId SMALLINT(5) UNSIGNED DEFAULT 0)") + + // sessions + tx.Exec("CREATE TABLE IF NOT EXISTS sessions (token BINARY(32) NOT NULL PRIMARY KEY, uuid BINARY(16) NOT NULL, active TINYINT(1) NOT NULL DEFAULT 0, expire TIMESTAMP DEFAULT NULL, CONSTRAINT sessions_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)") + tx.Exec("CREATE INDEX IF NOT EXISTS sessionsByUuid ON sessions (uuid)") + + // stats + tx.Exec("CREATE TABLE IF NOT EXISTS accountStats (uuid BINARY(16) NOT NULL PRIMARY KEY, playTime INT(11) NOT NULL DEFAULT 0, battles INT(11) NOT NULL DEFAULT 0, classicSessionsPlayed INT(11) NOT NULL DEFAULT 0, sessionsWon INT(11) NOT NULL DEFAULT 0, highestEndlessWave INT(11) NOT NULL DEFAULT 0, highestLevel INT(11) NOT NULL DEFAULT 0, pokemonSeen INT(11) NOT NULL DEFAULT 0, pokemonDefeated INT(11) NOT NULL DEFAULT 0, pokemonCaught INT(11) NOT NULL DEFAULT 0, pokemonHatched INT(11) NOT NULL DEFAULT 0, eggsPulled INT(11) NOT NULL DEFAULT 0, regularVouchers INT(11) NOT NULL DEFAULT 0, plusVouchers INT(11) NOT NULL DEFAULT 0, premiumVouchers INT(11) NOT NULL DEFAULT 0, goldenVouchers INT(11) NOT NULL DEFAULT 0, CONSTRAINT accountStats_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)") + + // compensations + tx.Exec("CREATE TABLE IF NOT EXISTS accountCompensations (id INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY, uuid BINARY(16) NOT NULL, voucherType INT(11) NOT NULL, count INT(11) NOT NULL DEFAULT 1, claimed BIT(1) NOT NULL DEFAULT b'0', CONSTRAINT accountCompensations_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)") + tx.Exec("CREATE INDEX IF NOT EXISTS accountCompensationsByUuid ON accountCompensations (uuid)") + + // daily runs + tx.Exec("CREATE TABLE IF NOT EXISTS dailyRuns (date DATE NOT NULL PRIMARY KEY, seed CHAR(24) CHARACTER SET ascii COLLATE ascii_bin NOT NULL)") + tx.Exec("CREATE INDEX IF NOT EXISTS dailyRunsByDateAndSeed ON dailyRuns (date, seed)") + + tx.Exec("CREATE TABLE IF NOT EXISTS dailyRunCompletions (uuid BINARY(16) NOT NULL, seed CHAR(24) CHARACTER SET ascii COLLATE ascii_bin NOT NULL, mode INT(11) NOT NULL DEFAULT 0, score INT(11) NOT NULL DEFAULT 0, timestamp TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, PRIMARY KEY (uuid, seed), CONSTRAINT dailyRunCompletions_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)") + tx.Exec("CREATE INDEX IF NOT EXISTS dailyRunCompletionsByUuidAndSeed ON dailyRunCompletions (uuid, seed)") + + tx.Exec("CREATE TABLE IF NOT EXISTS accountDailyRuns (uuid BINARY(16) NOT NULL, date DATE NOT NULL, score INT(11) NOT NULL DEFAULT 0, wave INT(11) NOT NULL DEFAULT 0, timestamp TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, PRIMARY KEY (uuid, date), CONSTRAINT accountDailyRuns_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE, CONSTRAINT accountDailyRuns_ibfk_2 FOREIGN KEY (date) REFERENCES dailyRuns (date) ON DELETE NO ACTION ON UPDATE NO ACTION)") + tx.Exec("CREATE INDEX IF NOT EXISTS accountDailyRunsByDate ON accountDailyRuns (date)") + + // save data tx.Exec("CREATE TABLE IF NOT EXISTS systemSaveData (uuid BINARY(16) PRIMARY KEY, data LONGBLOB, timestamp TIMESTAMP)") tx.Exec("CREATE TABLE IF NOT EXISTS sessionSaveData (uuid BINARY(16), slot TINYINT, data LONGBLOB, timestamp TIMESTAMP, PRIMARY KEY (uuid, slot))") + err = tx.Commit() if err != nil { panic(err) } // TODO temp code + _, err = os.Stat("userdata") + if err != nil { + if os.IsNotExist(err) { // not found, do not migrate + return nil + } else { + log.Fatalf("failed to stat userdata directory: %s", err) + return err + } + } + entries, err := os.ReadDir("userdata") if err != nil { log.Fatalln(err) diff --git a/docker-compose.Development.yml b/docker-compose.Development.yml new file mode 100644 index 0000000..84fd1d8 --- /dev/null +++ b/docker-compose.Development.yml @@ -0,0 +1,14 @@ +services: + db: + image: mariadb:11 + container_name: pokerogue-db-local + restart: on-failure + environment: + MYSQL_ROOT_PASSWORD: admin + MYSQL_DATABASE: pokeroguedb + MYSQL_USER: pokerogue + MYSQL_PASSWORD: pokerogue + ports: + - "3306:3306" + volumes: + - ./.data/db:/var/lib/mysql diff --git a/rogueserver.go b/rogueserver.go index 42f2d7d..91aa1a2 100644 --- a/rogueserver.go +++ b/rogueserver.go @@ -34,10 +34,10 @@ func main() { debug := flag.Bool("debug", false, "use debug mode") proto := flag.String("proto", "tcp", "protocol for api to use (tcp, unix)") - addr := flag.String("addr", "0.0.0.0", "network address for api to listen on") + addr := flag.String("addr", "0.0.0.0:8001", "network address for api to listen on") dbuser := flag.String("dbuser", "pokerogue", "database username") - dbpass := flag.String("dbpass", "", "database password") + dbpass := flag.String("dbpass", "pokerogue", "database password") dbproto := flag.String("dbproto", "tcp", "protocol for database connection") dbaddr := flag.String("dbaddr", "localhost", "database address") dbname := flag.String("dbname", "pokeroguedb", "database name") From b91c169b16b6f727f17e86dd829e38e12f8756d8 Mon Sep 17 00:00:00 2001 From: maru Date: Fri, 10 May 2024 15:33:37 -0400 Subject: [PATCH 15/47] endpoints.go consistency --- api/endpoints.go | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/api/endpoints.go b/api/endpoints.go index a24da22..9087d67 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -339,16 +339,14 @@ func handleDailySeed(w http.ResponseWriter, r *http.Request) { httpError(w, r, err, http.StatusInternalServerError) return } + bytes, err := base64.StdEncoding.DecodeString(seed) if err != nil { httpError(w, r, err, http.StatusInternalServerError) return } - _, err = w.Write(bytes) - if err != nil { - httpError(w, r, err, http.StatusInternalServerError) - return - } + + w.Write(bytes) } func handleDailyRankings(w http.ResponseWriter, r *http.Request) { From 17294e517996a971de5fbeba3084f1bfb69c2816 Mon Sep 17 00:00:00 2001 From: maru Date: Fri, 10 May 2024 15:37:24 -0400 Subject: [PATCH 16/47] Fix handleDailySeed --- api/endpoints.go | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/api/endpoints.go b/api/endpoints.go index 9087d67..2227fa6 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -19,7 +19,6 @@ package api import ( "database/sql" - "encoding/base64" "encoding/json" "fmt" "net/http" @@ -340,13 +339,7 @@ func handleDailySeed(w http.ResponseWriter, r *http.Request) { return } - bytes, err := base64.StdEncoding.DecodeString(seed) - if err != nil { - httpError(w, r, err, http.StatusInternalServerError) - return - } - - w.Write(bytes) + w.Write([]byte(seed)) } func handleDailyRankings(w http.ResponseWriter, r *http.Request) { From eea226692045e0cd05cab31a4b7c347bcee6344d Mon Sep 17 00:00:00 2001 From: maru Date: Fri, 10 May 2024 15:40:22 -0400 Subject: [PATCH 17/47] Remove unneeded assertion check in handleSaveData --- api/endpoints.go | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/api/endpoints.go b/api/endpoints.go index 2227fa6..26d8a23 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -296,20 +296,15 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { break } - s, ok := save.(defs.SessionSaveData) - if !ok { - err = fmt.Errorf("save data is not type SessionSaveData") - break - } - - // doesn't return a save, but it works var seed string seed, err = db.GetDailyRunSeed() if err != nil { httpError(w, r, err, http.StatusInternalServerError) return } - save, err = savedata.Clear(uuid, slot, seed, s) + + // doesn't return a save, but it works + save, err = savedata.Clear(uuid, slot, seed, save.(defs.SessionSaveData)) } if err != nil { httpError(w, r, err, http.StatusInternalServerError) From b5e809403999650b2387ca8e21a33fcb4941b500 Mon Sep 17 00:00:00 2001 From: maru Date: Fri, 10 May 2024 15:44:35 -0400 Subject: [PATCH 18/47] Don't return INVALID on seed-related function error --- api/daily/common.go | 4 ++-- db/daily.go | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api/daily/common.go b/api/daily/common.go index 678e0fd..c340917 100644 --- a/api/daily/common.go +++ b/api/daily/common.go @@ -72,12 +72,12 @@ func Init() error { time.Sleep(time.Second) seed, err = recordNewDaily() - log.Printf("Daily Run Seed: %s", seed) if err != nil { log.Printf("error while recording new daily: %s", err) + } else { + log.Printf("Daily Run Seed: %s", seed) } }) - if err != nil { return err } diff --git a/db/daily.go b/db/daily.go index 4b0f953..e30574a 100644 --- a/db/daily.go +++ b/db/daily.go @@ -27,7 +27,7 @@ func TryAddDailyRun(seed string) (string, error) { var actualSeed string err := handle.QueryRow("INSERT INTO dailyRuns (seed, date) VALUES (?, UTC_DATE()) ON DUPLICATE KEY UPDATE date = date RETURNING seed", seed).Scan(&actualSeed) if err != nil { - return "INVALID", err + return "", err } return actualSeed, nil @@ -37,7 +37,7 @@ func GetDailyRunSeed() (string, error) { var seed string err := handle.QueryRow("SELECT seed FROM dailyRuns WHERE date = UTC_DATE()").Scan(&seed) if err != nil { - return "INVALID", err + return "", err } return seed, nil From a8502fcd3f35c9472f5c903709f9357b76f700d3 Mon Sep 17 00:00:00 2001 From: Up <10714589+UpcraftLP@users.noreply.github.com> Date: Fri, 10 May 2024 21:47:22 +0200 Subject: [PATCH 19/47] add GitHub actions workflows and build docker image (#9) * add default values for CLI args * add development docker compose file * prevent crash if userdata dir does not exist * accounts, acccountStats * account stats and create db indices * compensations and daily runs * ensure uniqueness of daily seed * start on port 8001 by default for client parity * add GitHub actions scripts and dockerfile * add os architecture * only build docker image on main repo * add example compose file --- .dockerignore | 10 +++++++++ .github/workflows/ci.yml | 46 ++++++++++++++++++++++++++++++++++++++ .github/workflows/ghcr.yml | 38 +++++++++++++++++++++++++++++++ Dockerfile | 29 ++++++++++++++++++++++++ docker-compose.Example.yml | 27 ++++++++++++++++++++++ 5 files changed, 150 insertions(+) create mode 100644 .dockerignore create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/ghcr.yml create mode 100644 Dockerfile create mode 100644 docker-compose.Example.yml diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..cc9d25f --- /dev/null +++ b/.dockerignore @@ -0,0 +1,10 @@ +/.github/ + +Dockerfile* +docker-compose*.yml + +/.data/ +/secret.key + +/rogueserver* +!/rogueserver.go diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..a71cad6 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,46 @@ +name: Build + +on: + push: + pull_request: + +jobs: + build: + name: Build (${{ matrix.os_name }}) + env: + GO_VERSION: 1.22 + GOOS: ${{ matrix.os_name }} + GOARCH: ${{ matrix.arch }} + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + include: + - os: ubuntu-latest + os_name: linux + arch: amd64 + - os: windows-latest + os_name: windows + arch: amd64 +# TODO macos needs universal binary! +# - os: macos-latest +# os_name: macos + steps: + - uses: actions/checkout@v4 + - name: Set up Go ${{ env.GO_VERSION }} + uses: actions/setup-go@v5 + with: + go-version: ${{ env.GO_VERSION }} + - name: Install dependencies + run: go mod download + - name: Test + run: go test -v + - name: Build + run: go build -v + - name: Upload artifact + uses: actions/upload-artifact@v4 + with: + name: rogueserver-${{ matrix.os_name }}-${{ matrix.arch }}-${{ github.sha }} + path: | + rogueserver* + !rogueserver.go diff --git a/.github/workflows/ghcr.yml b/.github/workflows/ghcr.yml new file mode 100644 index 0000000..6b7eb3d --- /dev/null +++ b/.github/workflows/ghcr.yml @@ -0,0 +1,38 @@ +name: Publish to GHCR + +on: + push: + +jobs: + build: + name: Build and publish to GHCR + if: github.repository == 'pagefaultgames/rogueserver' + env: + GO_VERSION: 1.22 + runs-on: ubuntu-latest + steps: + - name: Setup Docker BuildX + uses: docker/setup-buildx-action@v2 + - name: Log into container registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.repository_owner }} + password: ${{ github.token }} + - name: Extract Docker metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ghcr.io/${{ github.repository }} + - name: Build Docker image + uses: docker/build-push-action@v5 + with: + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + build-args: | + GO_VERSION=${{ env.GO_VERSION }} + VERSION=${{ github.ref_name }}-SNAPSHOT + COMMIT_SHA=${{ env.GITHUB_SHA_SHORT }} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..8a07093 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,29 @@ +ARG GO_VERSION=1.22 + +FROM golang:${GO_VERSION} AS builder + +WORKDIR /src + +COPY ./go.mod /src/ +COPY ./go.sum /src/ + +RUN go mod download && go mod verify + +COPY . /src/ + +RUN CGO_ENABLED=0 \ + go build -o rogueserver + +RUN chmod +x /src/rogueserver + +# --------------------------------------------- + +FROM scratch + +WORKDIR /app + +COPY --from=builder /src/rogueserver . + +EXPOSE 8001 + +ENTRYPOINT ["./rogueserver"] diff --git a/docker-compose.Example.yml b/docker-compose.Example.yml new file mode 100644 index 0000000..b377d71 --- /dev/null +++ b/docker-compose.Example.yml @@ -0,0 +1,27 @@ +services: + server: + image: ghcr.io/pagefaultgames/pokerogue:latest + command: --debug --dbaddr db:3306 --dbuser pokerogue --dbpass pokerogue --dbname pokeroguedb + restart: unless-stopped + depends_on: + - db + networks: + - internal + ports: + - "8001:8001" + db: + image: mariadb:11 + restart: unless-stopped + environment: + MYSQL_ROOT_PASSWORD: admin + MYSQL_DATABASE: pokeroguedb + MYSQL_USER: pokerogue + MYSQL_PASSWORD: pokerogue + volumes: + - database:/var/lib/mysql + +volumes: + database: + +networks: + internal: From 693663103b7451cc03e263e21ac75035e58b1aac Mon Sep 17 00:00:00 2001 From: maru Date: Fri, 10 May 2024 15:49:26 -0400 Subject: [PATCH 20/47] Run formatter on files --- api/common.go | 2 +- db/db.go | 4 ++-- rogueserver.go | 3 +-- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/api/common.go b/api/common.go index 920d41e..8773357 100644 --- a/api/common.go +++ b/api/common.go @@ -89,4 +89,4 @@ func uuidFromRequest(r *http.Request) ([]byte, error) { func httpError(w http.ResponseWriter, r *http.Request, err error, code int) { log.Printf("%s: %s\n", r.URL.Path, err) http.Error(w, err.Error(), code) -} \ No newline at end of file +} diff --git a/db/db.go b/db/db.go index f246267..944b8fb 100644 --- a/db/db.go +++ b/db/db.go @@ -37,14 +37,14 @@ func Init(username, password, protocol, address, database string) error { if err != nil { return fmt.Errorf("failed to open database connection: %s", err) } - + conns := 1024 if protocol != "unix" { conns = 256 } handle.SetMaxOpenConns(conns) - handle.SetMaxIdleConns(conns/4) + handle.SetMaxIdleConns(conns / 4) handle.SetConnMaxIdleTime(time.Second * 10) diff --git a/rogueserver.go b/rogueserver.go index 91aa1a2..1fba0e7 100644 --- a/rogueserver.go +++ b/rogueserver.go @@ -43,7 +43,7 @@ func main() { dbname := flag.String("dbname", "pokeroguedb", "database name") tlscert := flag.String("tlscert", "", "tls certificate path") - tlskey := flag.String("tlskey", "", "tls key path") + tlskey := flag.String("tlskey", "", "tls key path") flag.Parse() @@ -130,4 +130,3 @@ func debugHandler(router *http.ServeMux) http.Handler { router.ServeHTTP(w, r) }) } - From d4a906a0f144bb041ed095f54fe4a3c7b61b541a Mon Sep 17 00:00:00 2001 From: maru Date: Fri, 10 May 2024 15:50:19 -0400 Subject: [PATCH 21/47] Move HTTPS-related flags in rogueserver.go --- rogueserver.go | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/rogueserver.go b/rogueserver.go index 1fba0e7..93789ae 100644 --- a/rogueserver.go +++ b/rogueserver.go @@ -35,6 +35,8 @@ func main() { proto := flag.String("proto", "tcp", "protocol for api to use (tcp, unix)") addr := flag.String("addr", "0.0.0.0:8001", "network address for api to listen on") + tlscert := flag.String("tlscert", "", "tls certificate path") + tlskey := flag.String("tlskey", "", "tls key path") dbuser := flag.String("dbuser", "pokerogue", "database username") dbpass := flag.String("dbpass", "pokerogue", "database password") @@ -42,9 +44,6 @@ func main() { dbaddr := flag.String("dbaddr", "localhost", "database address") dbname := flag.String("dbname", "pokeroguedb", "database name") - tlscert := flag.String("tlscert", "", "tls certificate path") - tlskey := flag.String("tlskey", "", "tls key path") - flag.Parse() // register gob types From e97e5f73d516cbf939830f3ecba79fa57b8c93c1 Mon Sep 17 00:00:00 2001 From: maru Date: Fri, 10 May 2024 16:00:47 -0400 Subject: [PATCH 22/47] Update ghcr.yml --- .github/workflows/ghcr.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ghcr.yml b/.github/workflows/ghcr.yml index 6b7eb3d..733e4f3 100644 --- a/.github/workflows/ghcr.yml +++ b/.github/workflows/ghcr.yml @@ -12,7 +12,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Setup Docker BuildX - uses: docker/setup-buildx-action@v2 + uses: docker/setup-buildx-action@v3 - name: Log into container registry uses: docker/login-action@v3 with: From 2704e64e38bdf52ebc54bc19f2b3a0c0f00579fa Mon Sep 17 00:00:00 2001 From: Flashfyre Date: Fri, 10 May 2024 18:07:14 -0400 Subject: [PATCH 23/47] Add newclear endpoint --- .gitignore | 1 + api/common.go | 1 + api/endpoints.go | 31 ++++++++++++++++++++++++++++ api/savedata/clear.go | 5 +++-- api/savedata/newclear.go | 44 ++++++++++++++++++++++++++++++++++++++++ db/savedata.go | 12 ++++++++++- 6 files changed, 91 insertions(+), 3 deletions(-) create mode 100644 api/savedata/newclear.go diff --git a/.gitignore b/.gitignore index 003f051..1f25c88 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,4 @@ secret.key *.iml *.ipr *.iws +.vscode/launch.json diff --git a/api/common.go b/api/common.go index 8773357..bbedf35 100644 --- a/api/common.go +++ b/api/common.go @@ -48,6 +48,7 @@ func Init(mux *http.ServeMux) { mux.HandleFunc("POST /savedata/update", handleSaveData) mux.HandleFunc("GET /savedata/delete", handleSaveData) mux.HandleFunc("POST /savedata/clear", handleSaveData) + mux.HandleFunc("GET /savedata/newclear", handleNewClear) // daily mux.HandleFunc("GET /daily/seed", handleDailySeed) diff --git a/api/endpoints.go b/api/endpoints.go index 26d8a23..5c4be06 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -325,6 +325,37 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/json") } +func handleNewClear(w http.ResponseWriter, r *http.Request) { + uuid, err := uuidFromRequest(r) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + + var slot int + if r.URL.Query().Has("slot") { + slot, err = strconv.Atoi(r.URL.Query().Get("slot")) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + } + + newClear, err := savedata.NewClear(uuid, slot) + if err != nil { + httpError(w, r, fmt.Errorf("failed to read new clear: %s", err), http.StatusInternalServerError) + return + } + + err = json.NewEncoder(w).Encode(newClear) + if err != nil { + httpError(w, r, fmt.Errorf("failed to encode response json: %s", err), http.StatusInternalServerError) + return + } + + w.Header().Set("Content-Type", "application/json") +} + // daily func handleDailySeed(w http.ResponseWriter, r *http.Request) { diff --git a/api/savedata/clear.go b/api/savedata/clear.go index 054896b..661ead7 100644 --- a/api/savedata/clear.go +++ b/api/savedata/clear.go @@ -19,9 +19,10 @@ package savedata import ( "fmt" + "log" + "github.com/pagefaultgames/rogueserver/db" "github.com/pagefaultgames/rogueserver/defs" - "log" ) type ClearResponse struct { @@ -56,7 +57,7 @@ func Clear(uuid []byte, slot int, seed string, save defs.SessionSaveData) (Clear } if sessionCompleted { - response.Success, err = db.TryAddDailyRunCompletion(uuid, save.Seed, int(save.GameMode)) + response.Success, err = db.TryAddSeedCompletion(uuid, save.Seed, int(save.GameMode)) if err != nil { log.Printf("failed to mark seed as completed: %s", err) } diff --git a/api/savedata/newclear.go b/api/savedata/newclear.go new file mode 100644 index 0000000..0c221c2 --- /dev/null +++ b/api/savedata/newclear.go @@ -0,0 +1,44 @@ +/* + Copyright (C) 2024 Pagefault Games + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . +*/ + +package savedata + +import ( + "fmt" + + "github.com/pagefaultgames/rogueserver/db" + "github.com/pagefaultgames/rogueserver/defs" +) + +// /savedata/newclear - return whether a session is a new clear for its seed +func NewClear(uuid []byte, slot int) (bool, error) { + if slot < 0 || slot >= defs.SessionSlotCount { + return false, fmt.Errorf("slot id %d out of range", slot) + } + + session, err := db.ReadSessionSaveData(uuid, slot) + if err != nil { + return false, err + } + + completed, err := db.ReadSeedCompleted(uuid, session.Seed) + if err != nil { + return false, fmt.Errorf("failed to read seed completed: %s", err) + } + + return !completed, nil +} diff --git a/db/savedata.go b/db/savedata.go index dc2c860..bb792c5 100644 --- a/db/savedata.go +++ b/db/savedata.go @@ -24,7 +24,7 @@ import ( "github.com/pagefaultgames/rogueserver/defs" ) -func TryAddDailyRunCompletion(uuid []byte, seed string, mode int) (bool, error) { +func TryAddSeedCompletion(uuid []byte, seed string, mode int) (bool, error) { var count int err := handle.QueryRow("SELECT COUNT(*) FROM dailyRunCompletions WHERE uuid = ? AND seed = ?", uuid, seed).Scan(&count) if err != nil { @@ -41,6 +41,16 @@ func TryAddDailyRunCompletion(uuid []byte, seed string, mode int) (bool, error) return true, nil } +func ReadSeedCompleted(uuid []byte, seed string) (bool, error) { + var count int + err := handle.QueryRow("SELECT COUNT(*) FROM dailyRunCompletions WHERE uuid = ? AND seed = ?", uuid, seed).Scan(&count) + if err != nil { + return false, err + } + + return count > 0, nil +} + func ReadSystemSaveData(uuid []byte) (defs.SystemSaveData, error) { var system defs.SystemSaveData From 1cec1d313d3872c3c805c7ff344ab0aeee7104a9 Mon Sep 17 00:00:00 2001 From: ser3n1ty <36878537+cgnetsec@users.noreply.github.com> Date: Fri, 10 May 2024 20:36:03 -0700 Subject: [PATCH 24/47] Update README.md --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 3c97821..c896a2d 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,6 @@ It is advised that you host this in a docker container as it will be much easier There is a sample docker-compose file for setting up a docker container to setup this server. # Self Hosting outside of Docker: -Recommended Tools: -If using Windows: [Chocolatey](https://chocolatey.org/install) - ## Required Tools: - Golang - Node: **18.3.0** @@ -47,7 +44,7 @@ go build . ./rogueserver --debug --dbuser yourusername --dbpass yourpassword & cd /server/location/ -npm run start & +npm run start ``` If you have a firewall running such as ufw on your linux machine, make sure to allow inbound connections on the ports youre running the API and the pokerogue server (8000,8001). From 8c209163db64162fa7627f8a8ae17b370fb59eb0 Mon Sep 17 00:00:00 2001 From: ser3n1ty <36878537+cgnetsec@users.noreply.github.com> Date: Fri, 10 May 2024 20:38:28 -0700 Subject: [PATCH 25/47] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index c896a2d..2040c8e 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,6 @@ Replace both URLs (one on each line) with the local API server address from rogu Now that all of the files are configured: start up powershell as administrator: ``` -powershell -ep bypass cd C:\api\server\location\ go build . .\rogueserver.exe --debug --dbuser yourusername --dbpass yourpassword From 5656fb96d14cbcb5a72077ec7962097002ff113a Mon Sep 17 00:00:00 2001 From: maru Date: Sat, 11 May 2024 02:24:20 -0400 Subject: [PATCH 26/47] Use log.Fatal isntead of panic --- db/db.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/db/db.go b/db/db.go index 944b8fb..4091137 100644 --- a/db/db.go +++ b/db/db.go @@ -50,7 +50,7 @@ func Init(username, password, protocol, address, database string) error { tx, err := handle.Begin() if err != nil { - panic(err) + log.Fatal(err) } // accounts @@ -83,7 +83,7 @@ func Init(username, password, protocol, address, database string) error { err = tx.Commit() if err != nil { - panic(err) + log.Fatal(err) } // TODO temp code @@ -99,7 +99,7 @@ func Init(username, password, protocol, address, database string) error { entries, err := os.ReadDir("userdata") if err != nil { - log.Fatalln(err) + log.Fatal(err) return nil } From 36f353b8a6d669e432f853121047f7a8871bf635 Mon Sep 17 00:00:00 2001 From: maru Date: Sat, 11 May 2024 02:30:20 -0400 Subject: [PATCH 27/47] Clean up db.go --- db/db.go | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/db/db.go b/db/db.go index 4091137..55214df 100644 --- a/db/db.go +++ b/db/db.go @@ -89,18 +89,16 @@ func Init(username, password, protocol, address, database string) error { // TODO temp code _, err = os.Stat("userdata") if err != nil { - if os.IsNotExist(err) { // not found, do not migrate - return nil - } else { + if !os.IsNotExist(err) { // not found, do not migrate log.Fatalf("failed to stat userdata directory: %s", err) - return err } + + return nil } entries, err := os.ReadDir("userdata") if err != nil { log.Fatal(err) - return nil } for _, entry := range entries { @@ -131,7 +129,6 @@ func Init(username, password, protocol, address, database string) error { err = StoreSystemSaveData(uuid, systemData) if err != nil { log.Fatalf("failed to store system save data for %v: %s\n", uuidString, err) - continue } // delete old system data From 03865f9b949a440c9b0a363f33a4d614f1e902bd Mon Sep 17 00:00:00 2001 From: Krystian Chmura Date: Sat, 11 May 2024 14:06:47 +0200 Subject: [PATCH 28/47] run golangci-lint in CI --- .github/workflows/ci.yml | 5 ++++ .golangci.yml | 0 api/common.go | 11 ++++++-- api/endpoints.go | 11 +++++--- api/savedata/update.go | 10 ------- api/stats.go | 8 ++++-- db/db.go | 61 ++++++++++++++++++++++------------------ rogueserver.go | 9 ++++-- 8 files changed, 66 insertions(+), 49 deletions(-) create mode 100644 .golangci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a71cad6..7309097 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -33,6 +33,11 @@ jobs: go-version: ${{ env.GO_VERSION }} - name: Install dependencies run: go mod download + - name: golangci-lint + uses: golangci/golangci-lint-action@v6 + with: + args: --timeout=10m + version: latest - name: Test run: go test -v - name: Build diff --git a/.golangci.yml b/.golangci.yml new file mode 100644 index 0000000..e69de29 diff --git a/api/common.go b/api/common.go index bbedf35..55e01bc 100644 --- a/api/common.go +++ b/api/common.go @@ -28,9 +28,13 @@ import ( "github.com/pagefaultgames/rogueserver/db" ) -func Init(mux *http.ServeMux) { - scheduleStatRefresh() - daily.Init() +func Init(mux *http.ServeMux) error { + if err := scheduleStatRefresh(); err != nil { + return err + } + if err := daily.Init(); err != nil { + return err + } // account mux.HandleFunc("GET /account/info", handleAccountInfo) @@ -54,6 +58,7 @@ func Init(mux *http.ServeMux) { mux.HandleFunc("GET /daily/seed", handleDailySeed) mux.HandleFunc("GET /daily/rankings", handleDailyRankings) mux.HandleFunc("GET /daily/rankingpagecount", handleDailyRankingPageCount) + return nil } func tokenFromRequest(r *http.Request) ([]byte, error) { diff --git a/api/endpoints.go b/api/endpoints.go index 5c4be06..7092c26 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -159,7 +159,7 @@ func handleGameTitleStats(w http.ResponseWriter, r *http.Request) { } func handleGameClassicSessionCount(w http.ResponseWriter, r *http.Request) { - w.Write([]byte(strconv.Itoa(classicSessionCount))) + _, _ = w.Write([]byte(strconv.Itoa(classicSessionCount))) } func handleSaveData(w http.ResponseWriter, r *http.Request) { @@ -274,7 +274,10 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { return } } else { - db.UpdateTrainerIds(trainerId, secretId, uuid) + if err := db.UpdateTrainerIds(trainerId, secretId, uuid); err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } } } @@ -365,7 +368,7 @@ func handleDailySeed(w http.ResponseWriter, r *http.Request) { return } - w.Write([]byte(seed)) + _, _ = w.Write([]byte(seed)) } func handleDailyRankings(w http.ResponseWriter, r *http.Request) { @@ -420,5 +423,5 @@ func handleDailyRankingPageCount(w http.ResponseWriter, r *http.Request) { httpError(w, r, err, http.StatusInternalServerError) } - w.Write([]byte(strconv.Itoa(count))) + _, _ = w.Write([]byte(strconv.Itoa(count))) } diff --git a/api/savedata/update.go b/api/savedata/update.go index 8bbac9f..6876b57 100644 --- a/api/savedata/update.go +++ b/api/savedata/update.go @@ -20,15 +20,11 @@ package savedata import ( "fmt" "log" - "strconv" - "github.com/klauspost/compress/zstd" "github.com/pagefaultgames/rogueserver/db" "github.com/pagefaultgames/rogueserver/defs" ) -var zstdEncoder, _ = zstd.NewWriter(nil) - // /savedata/update - update save data func Update(uuid []byte, slot int, save any) error { err := db.UpdateAccountLastActivity(uuid) @@ -62,12 +58,6 @@ func Update(uuid []byte, slot int, save any) error { if slot < 0 || slot >= defs.SessionSlotCount { return fmt.Errorf("slot id %d out of range", slot) } - - filename := "session" - if slot != 0 { - filename += strconv.Itoa(slot) - } - return db.StoreSessionSaveData(uuid, save, slot) default: diff --git a/api/stats.go b/api/stats.go index 70c99b1..5c6aafc 100644 --- a/api/stats.go +++ b/api/stats.go @@ -32,15 +32,19 @@ var ( classicSessionCount int ) -func scheduleStatRefresh() { - scheduler.AddFunc("@every 30s", func() { +func scheduleStatRefresh() error { + _, err := scheduler.AddFunc("@every 30s", func() { err := updateStats() if err != nil { log.Printf("failed to update stats: %s", err) } }) + if err != nil { + return err + } scheduler.Start() + return nil } func updateStats() error { diff --git a/db/db.go b/db/db.go index 55214df..7dbd176 100644 --- a/db/db.go +++ b/db/db.go @@ -53,33 +53,11 @@ func Init(username, password, protocol, address, database string) error { log.Fatal(err) } - // accounts - tx.Exec("CREATE TABLE IF NOT EXISTS accounts (uuid BINARY(16) NOT NULL PRIMARY KEY, username VARCHAR(16) UNIQUE NOT NULL, hash BINARY(32) NOT NULL, salt BINARY(16) NOT NULL, registered TIMESTAMP NOT NULL, lastLoggedIn TIMESTAMP DEFAULT NULL, lastActivity TIMESTAMP DEFAULT NULL, banned TINYINT(1) NOT NULL DEFAULT 0, trainerId SMALLINT(5) UNSIGNED DEFAULT 0, secretId SMALLINT(5) UNSIGNED DEFAULT 0)") - - // sessions - tx.Exec("CREATE TABLE IF NOT EXISTS sessions (token BINARY(32) NOT NULL PRIMARY KEY, uuid BINARY(16) NOT NULL, active TINYINT(1) NOT NULL DEFAULT 0, expire TIMESTAMP DEFAULT NULL, CONSTRAINT sessions_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)") - tx.Exec("CREATE INDEX IF NOT EXISTS sessionsByUuid ON sessions (uuid)") - - // stats - tx.Exec("CREATE TABLE IF NOT EXISTS accountStats (uuid BINARY(16) NOT NULL PRIMARY KEY, playTime INT(11) NOT NULL DEFAULT 0, battles INT(11) NOT NULL DEFAULT 0, classicSessionsPlayed INT(11) NOT NULL DEFAULT 0, sessionsWon INT(11) NOT NULL DEFAULT 0, highestEndlessWave INT(11) NOT NULL DEFAULT 0, highestLevel INT(11) NOT NULL DEFAULT 0, pokemonSeen INT(11) NOT NULL DEFAULT 0, pokemonDefeated INT(11) NOT NULL DEFAULT 0, pokemonCaught INT(11) NOT NULL DEFAULT 0, pokemonHatched INT(11) NOT NULL DEFAULT 0, eggsPulled INT(11) NOT NULL DEFAULT 0, regularVouchers INT(11) NOT NULL DEFAULT 0, plusVouchers INT(11) NOT NULL DEFAULT 0, premiumVouchers INT(11) NOT NULL DEFAULT 0, goldenVouchers INT(11) NOT NULL DEFAULT 0, CONSTRAINT accountStats_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)") - - // compensations - tx.Exec("CREATE TABLE IF NOT EXISTS accountCompensations (id INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY, uuid BINARY(16) NOT NULL, voucherType INT(11) NOT NULL, count INT(11) NOT NULL DEFAULT 1, claimed BIT(1) NOT NULL DEFAULT b'0', CONSTRAINT accountCompensations_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)") - tx.Exec("CREATE INDEX IF NOT EXISTS accountCompensationsByUuid ON accountCompensations (uuid)") - - // daily runs - tx.Exec("CREATE TABLE IF NOT EXISTS dailyRuns (date DATE NOT NULL PRIMARY KEY, seed CHAR(24) CHARACTER SET ascii COLLATE ascii_bin NOT NULL)") - tx.Exec("CREATE INDEX IF NOT EXISTS dailyRunsByDateAndSeed ON dailyRuns (date, seed)") - - tx.Exec("CREATE TABLE IF NOT EXISTS dailyRunCompletions (uuid BINARY(16) NOT NULL, seed CHAR(24) CHARACTER SET ascii COLLATE ascii_bin NOT NULL, mode INT(11) NOT NULL DEFAULT 0, score INT(11) NOT NULL DEFAULT 0, timestamp TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, PRIMARY KEY (uuid, seed), CONSTRAINT dailyRunCompletions_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)") - tx.Exec("CREATE INDEX IF NOT EXISTS dailyRunCompletionsByUuidAndSeed ON dailyRunCompletions (uuid, seed)") - - tx.Exec("CREATE TABLE IF NOT EXISTS accountDailyRuns (uuid BINARY(16) NOT NULL, date DATE NOT NULL, score INT(11) NOT NULL DEFAULT 0, wave INT(11) NOT NULL DEFAULT 0, timestamp TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, PRIMARY KEY (uuid, date), CONSTRAINT accountDailyRuns_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE, CONSTRAINT accountDailyRuns_ibfk_2 FOREIGN KEY (date) REFERENCES dailyRuns (date) ON DELETE NO ACTION ON UPDATE NO ACTION)") - tx.Exec("CREATE INDEX IF NOT EXISTS accountDailyRunsByDate ON accountDailyRuns (date)") - - // save data - tx.Exec("CREATE TABLE IF NOT EXISTS systemSaveData (uuid BINARY(16) PRIMARY KEY, data LONGBLOB, timestamp TIMESTAMP)") - tx.Exec("CREATE TABLE IF NOT EXISTS sessionSaveData (uuid BINARY(16), slot TINYINT, data LONGBLOB, timestamp TIMESTAMP, PRIMARY KEY (uuid, slot))") + err = setupDb(tx) + if err != nil { + _ = tx.Rollback() + log.Fatal(err) + } err = tx.Commit() if err != nil { @@ -92,7 +70,7 @@ func Init(username, password, protocol, address, database string) error { if !os.IsNotExist(err) { // not found, do not migrate log.Fatalf("failed to stat userdata directory: %s", err) } - + return nil } @@ -164,3 +142,30 @@ func Init(username, password, protocol, address, database string) error { return nil } + +func setupDb(tx *sql.Tx) error { + queries := []string{ + `CREATE TABLE IF NOT EXISTS accounts (uuid BINARY(16) NOT NULL PRIMARY KEY, username VARCHAR(16) UNIQUE NOT NULL, hash BINARY(32) NOT NULL, salt BINARY(16) NOT NULL, registered TIMESTAMP NOT NULL, lastLoggedIn TIMESTAMP DEFAULT NULL, lastActivity TIMESTAMP DEFAULT NULL, banned TINYINT(1) NOT NULL DEFAULT 0, trainerId SMALLINT(5) UNSIGNED DEFAULT 0, secretId SMALLINT(5) UNSIGNED DEFAULT 0)`, + `CREATE TABLE IF NOT EXISTS sessions (token BINARY(32) NOT NULL PRIMARY KEY, uuid BINARY(16) NOT NULL, active TINYINT(1) NOT NULL DEFAULT 0, expire TIMESTAMP DEFAULT NULL, CONSTRAINT sessions_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)`, + `CREATE INDEX IF NOT EXISTS sessionsByUuid ON sessions (uuid)`, + `CREATE TABLE IF NOT EXISTS accountStats (uuid BINARY(16) NOT NULL PRIMARY KEY, playTime INT(11) NOT NULL DEFAULT 0, battles INT(11) NOT NULL DEFAULT 0, classicSessionsPlayed INT(11) NOT NULL DEFAULT 0, sessionsWon INT(11) NOT NULL DEFAULT 0, highestEndlessWave INT(11) NOT NULL DEFAULT 0, highestLevel INT(11) NOT NULL DEFAULT 0, pokemonSeen INT(11) NOT NULL DEFAULT 0, pokemonDefeated INT(11) NOT NULL DEFAULT 0, pokemonCaught INT(11) NOT NULL DEFAULT 0, pokemonHatched INT(11) NOT NULL DEFAULT 0, eggsPulled INT(11) NOT NULL DEFAULT 0, regularVouchers INT(11) NOT NULL DEFAULT 0, plusVouchers INT(11) NOT NULL DEFAULT 0, premiumVouchers INT(11) NOT NULL DEFAULT 0, goldenVouchers INT(11) NOT NULL DEFAULT 0, CONSTRAINT accountStats_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)`, + `CREATE TABLE IF NOT EXISTS accountCompensations (id INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY, uuid BINARY(16) NOT NULL, voucherType INT(11) NOT NULL, count INT(11) NOT NULL DEFAULT 1, claimed BIT(1) NOT NULL DEFAULT b'0', CONSTRAINT accountCompensations_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)`, + `CREATE INDEX IF NOT EXISTS accountCompensationsByUuid ON accountCompensations (uuid)`, + `CREATE TABLE IF NOT EXISTS dailyRuns (date DATE NOT NULL PRIMARY KEY, seed CHAR(24) CHARACTER SET ascii COLLATE ascii_bin NOT NULL)`, + `CREATE INDEX IF NOT EXISTS dailyRunsByDateAndSeed ON dailyRuns (date, seed)`, + `CREATE TABLE IF NOT EXISTS dailyRunCompletions (uuid BINARY(16) NOT NULL, seed CHAR(24) CHARACTER SET ascii COLLATE ascii_bin NOT NULL, mode INT(11) NOT NULL DEFAULT 0, score INT(11) NOT NULL DEFAULT 0, timestamp TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, PRIMARY KEY (uuid, seed), CONSTRAINT dailyRunCompletions_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)`, + `CREATE INDEX IF NOT EXISTS dailyRunCompletionsByUuidAndSeed ON dailyRunCompletions (uuid, seed)`, + `CREATE TABLE IF NOT EXISTS accountDailyRuns (uuid BINARY(16) NOT NULL, date DATE NOT NULL, score INT(11) NOT NULL DEFAULT 0, wave INT(11) NOT NULL DEFAULT 0, timestamp TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, PRIMARY KEY (uuid, date), CONSTRAINT accountDailyRuns_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE, CONSTRAINT accountDailyRuns_ibfk_2 FOREIGN KEY (date) REFERENCES dailyRuns (date) ON DELETE NO ACTION ON UPDATE NO ACTION)`, + `CREATE INDEX IF NOT EXISTS accountDailyRunsByDate ON accountDailyRuns (date)`, + `CREATE TABLE IF NOT EXISTS systemSaveData (uuid BINARY(16) PRIMARY KEY, data LONGBLOB, timestamp TIMESTAMP)`, + `CREATE TABLE IF NOT EXISTS sessionSaveData (uuid BINARY(16), slot TINYINT, data LONGBLOB, timestamp TIMESTAMP, PRIMARY KEY (uuid, slot))`, + } + + for _, q := range queries { + _, err := tx.Exec(q) + if err != nil { + return fmt.Errorf("failed to execute query: %w, query: %s", err, q) + } + } + return nil +} diff --git a/rogueserver.go b/rogueserver.go index 93789ae..4b98dff 100644 --- a/rogueserver.go +++ b/rogueserver.go @@ -65,7 +65,9 @@ func main() { mux := http.NewServeMux() // init api - api.Init(mux) + if err := api.Init(mux); err != nil { + log.Fatal(err) + } // start web server handler := prodHandler(mux) @@ -94,7 +96,10 @@ func createListener(proto, addr string) (net.Listener, error) { } if proto == "unix" { - os.Chmod(addr, 0777) + if err := os.Chmod(addr, 0777); err != nil { + listener.Close() + return nil, err + } } return listener, nil From ab69d940e69bff1a1415dd1594d776301f0a7773 Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 01:23:29 +0200 Subject: [PATCH 29/47] update action step name --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7309097..df3d97e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -33,7 +33,7 @@ jobs: go-version: ${{ env.GO_VERSION }} - name: Install dependencies run: go mod download - - name: golangci-lint + - name: Lint Codebase uses: golangci/golangci-lint-action@v6 with: args: --timeout=10m From 884bb88cd33c7113cffb1956a27f4b8f55471ff9 Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 03:34:08 +0200 Subject: [PATCH 30/47] add combined update endpoint --- api/common.go | 3 ++ api/endpoints.go | 74 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+) diff --git a/api/common.go b/api/common.go index 55e01bc..4fdb0d7 100644 --- a/api/common.go +++ b/api/common.go @@ -54,6 +54,9 @@ func Init(mux *http.ServeMux) error { mux.HandleFunc("POST /savedata/clear", handleSaveData) mux.HandleFunc("GET /savedata/newclear", handleNewClear) + // new session + mux.HandleFunc("POST /savedata/update2", handleSaveData2) + // daily mux.HandleFunc("GET /daily/seed", handleDailySeed) mux.HandleFunc("GET /daily/rankings", handleDailyRankings) diff --git a/api/endpoints.go b/api/endpoints.go index 7092c26..1a4c327 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -328,6 +328,80 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/json") } +type CombinedSaveData struct { + System defs.SystemSaveData `json:"system"` + Session defs.SessionSaveData `json:"session"` + SessionSlotId int `json:"sessionSlotId"` +} + +func handleSaveData2(w http.ResponseWriter, r *http.Request) { + var token []byte + token, err := tokenFromRequest(r) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + + uuid, err := uuidFromRequest(r) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + + var data CombinedSaveData + err = json.NewDecoder(r.Body).Decode(&data) + if err != nil { + httpError(w, r, fmt.Errorf("failed to decode request body: %s", err), http.StatusBadRequest) + return + } + + var active bool + active, err = db.IsActiveSession(token) + if err != nil { + httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusBadRequest) + return + } + + if !active { + httpError(w, r, fmt.Errorf("session out of date"), http.StatusBadRequest) + return + } + + trainerId := data.System.TrainerId + secretId := data.System.SecretId + + storedTrainerId, storedSecretId, err := db.FetchTrainerIds(uuid) + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + + if storedTrainerId > 0 || storedSecretId > 0 { + if trainerId != storedTrainerId || secretId != storedSecretId { + httpError(w, r, fmt.Errorf("session out of date"), http.StatusBadRequest) + return + } + } else { + if err := db.UpdateTrainerIds(trainerId, secretId, uuid); err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + } + + err = savedata.Update(uuid, data.SessionSlotId, data.Session) + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + err = savedata.Update(uuid, 0, data.System) + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + w.WriteHeader(http.StatusOK) + return +} + func handleNewClear(w http.ResponseWriter, r *http.Request) { uuid, err := uuidFromRequest(r) if err != nil { From 94df201bf71a8f396e4e0759aed037777ab18e16 Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 03:42:35 +0200 Subject: [PATCH 31/47] update endpoint name --- api/common.go | 2 +- api/endpoints.go | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/api/common.go b/api/common.go index 4fdb0d7..f3c3fa9 100644 --- a/api/common.go +++ b/api/common.go @@ -55,7 +55,7 @@ func Init(mux *http.ServeMux) error { mux.HandleFunc("GET /savedata/newclear", handleNewClear) // new session - mux.HandleFunc("POST /savedata/update2", handleSaveData2) + mux.HandleFunc("POST /savedata/updateall", handleSaveData2) // daily mux.HandleFunc("GET /daily/seed", handleDailySeed) diff --git a/api/endpoints.go b/api/endpoints.go index 1a4c327..7347dd6 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -334,6 +334,7 @@ type CombinedSaveData struct { SessionSlotId int `json:"sessionSlotId"` } +// TODO wrap this in a transaction func handleSaveData2(w http.ResponseWriter, r *http.Request) { var token []byte token, err := tokenFromRequest(r) From 2700afafdb09bbdb5a1d2e3ba4b97a9b4bfc417e Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 04:41:56 +0200 Subject: [PATCH 32/47] cleanup --- api/endpoints.go | 1 - 1 file changed, 1 deletion(-) diff --git a/api/endpoints.go b/api/endpoints.go index 7347dd6..e305954 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -400,7 +400,6 @@ func handleSaveData2(w http.ResponseWriter, r *http.Request) { return } w.WriteHeader(http.StatusOK) - return } func handleNewClear(w http.ResponseWriter, r *http.Request) { From 5d6bfe0c22eca0adf1f21394add470620c3f4e17 Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 05:12:46 +0200 Subject: [PATCH 33/47] add accounts activity index --- db/db.go | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/db/db.go b/db/db.go index 7dbd176..874a48c 100644 --- a/db/db.go +++ b/db/db.go @@ -146,18 +146,27 @@ func Init(username, password, protocol, address, database string) error { func setupDb(tx *sql.Tx) error { queries := []string{ `CREATE TABLE IF NOT EXISTS accounts (uuid BINARY(16) NOT NULL PRIMARY KEY, username VARCHAR(16) UNIQUE NOT NULL, hash BINARY(32) NOT NULL, salt BINARY(16) NOT NULL, registered TIMESTAMP NOT NULL, lastLoggedIn TIMESTAMP DEFAULT NULL, lastActivity TIMESTAMP DEFAULT NULL, banned TINYINT(1) NOT NULL DEFAULT 0, trainerId SMALLINT(5) UNSIGNED DEFAULT 0, secretId SMALLINT(5) UNSIGNED DEFAULT 0)`, + `CREATE INDEX IF NOT EXISTS accountsByActivity ON accounts (lastActivity)`, + `CREATE TABLE IF NOT EXISTS sessions (token BINARY(32) NOT NULL PRIMARY KEY, uuid BINARY(16) NOT NULL, active TINYINT(1) NOT NULL DEFAULT 0, expire TIMESTAMP DEFAULT NULL, CONSTRAINT sessions_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)`, `CREATE INDEX IF NOT EXISTS sessionsByUuid ON sessions (uuid)`, + `CREATE TABLE IF NOT EXISTS accountStats (uuid BINARY(16) NOT NULL PRIMARY KEY, playTime INT(11) NOT NULL DEFAULT 0, battles INT(11) NOT NULL DEFAULT 0, classicSessionsPlayed INT(11) NOT NULL DEFAULT 0, sessionsWon INT(11) NOT NULL DEFAULT 0, highestEndlessWave INT(11) NOT NULL DEFAULT 0, highestLevel INT(11) NOT NULL DEFAULT 0, pokemonSeen INT(11) NOT NULL DEFAULT 0, pokemonDefeated INT(11) NOT NULL DEFAULT 0, pokemonCaught INT(11) NOT NULL DEFAULT 0, pokemonHatched INT(11) NOT NULL DEFAULT 0, eggsPulled INT(11) NOT NULL DEFAULT 0, regularVouchers INT(11) NOT NULL DEFAULT 0, plusVouchers INT(11) NOT NULL DEFAULT 0, premiumVouchers INT(11) NOT NULL DEFAULT 0, goldenVouchers INT(11) NOT NULL DEFAULT 0, CONSTRAINT accountStats_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)`, + `CREATE TABLE IF NOT EXISTS accountCompensations (id INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY, uuid BINARY(16) NOT NULL, voucherType INT(11) NOT NULL, count INT(11) NOT NULL DEFAULT 1, claimed BIT(1) NOT NULL DEFAULT b'0', CONSTRAINT accountCompensations_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)`, `CREATE INDEX IF NOT EXISTS accountCompensationsByUuid ON accountCompensations (uuid)`, + `CREATE TABLE IF NOT EXISTS dailyRuns (date DATE NOT NULL PRIMARY KEY, seed CHAR(24) CHARACTER SET ascii COLLATE ascii_bin NOT NULL)`, `CREATE INDEX IF NOT EXISTS dailyRunsByDateAndSeed ON dailyRuns (date, seed)`, + `CREATE TABLE IF NOT EXISTS dailyRunCompletions (uuid BINARY(16) NOT NULL, seed CHAR(24) CHARACTER SET ascii COLLATE ascii_bin NOT NULL, mode INT(11) NOT NULL DEFAULT 0, score INT(11) NOT NULL DEFAULT 0, timestamp TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, PRIMARY KEY (uuid, seed), CONSTRAINT dailyRunCompletions_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)`, `CREATE INDEX IF NOT EXISTS dailyRunCompletionsByUuidAndSeed ON dailyRunCompletions (uuid, seed)`, + `CREATE TABLE IF NOT EXISTS accountDailyRuns (uuid BINARY(16) NOT NULL, date DATE NOT NULL, score INT(11) NOT NULL DEFAULT 0, wave INT(11) NOT NULL DEFAULT 0, timestamp TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, PRIMARY KEY (uuid, date), CONSTRAINT accountDailyRuns_ibfk_1 FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE, CONSTRAINT accountDailyRuns_ibfk_2 FOREIGN KEY (date) REFERENCES dailyRuns (date) ON DELETE NO ACTION ON UPDATE NO ACTION)`, `CREATE INDEX IF NOT EXISTS accountDailyRunsByDate ON accountDailyRuns (date)`, + `CREATE TABLE IF NOT EXISTS systemSaveData (uuid BINARY(16) PRIMARY KEY, data LONGBLOB, timestamp TIMESTAMP)`, + `CREATE TABLE IF NOT EXISTS sessionSaveData (uuid BINARY(16), slot TINYINT, data LONGBLOB, timestamp TIMESTAMP, PRIMARY KEY (uuid, slot))`, } From 4430a18daefb48452096fb4b15e236cbdc3ef8f1 Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 08:05:40 +0200 Subject: [PATCH 34/47] update example compose file --- docker-compose.Example.yml | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/docker-compose.Example.yml b/docker-compose.Example.yml index b377d71..0279c86 100644 --- a/docker-compose.Example.yml +++ b/docker-compose.Example.yml @@ -1,10 +1,11 @@ services: server: - image: ghcr.io/pagefaultgames/pokerogue:latest - command: --debug --dbaddr db:3306 --dbuser pokerogue --dbpass pokerogue --dbname pokeroguedb + command: --debug --dbaddr db --dbuser pokerogue --dbpass pokerogue --dbname pokeroguedb + image: ghcr.io/pagefaultgames/rogueserver:master restart: unless-stopped depends_on: - - db + db: + condition: service_healthy networks: - internal ports: @@ -12,6 +13,13 @@ services: db: image: mariadb:11 restart: unless-stopped + healthcheck: + test: [ "CMD", "healthcheck.sh", "--su-mysql", "--connect", "--innodb_initialized" ] + start_period: 10s + start_interval: 10s + interval: 1m + timeout: 5s + retries: 3 environment: MYSQL_ROOT_PASSWORD: admin MYSQL_DATABASE: pokeroguedb @@ -19,6 +27,8 @@ services: MYSQL_PASSWORD: pokerogue volumes: - database:/var/lib/mysql + networks: + - internal volumes: database: From c06b1496a36b25d4b12520186e61dc945b9ddb58 Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 08:11:36 +0200 Subject: [PATCH 35/47] add watchtower in example compose file --- docker-compose.Example.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docker-compose.Example.yml b/docker-compose.Example.yml index 0279c86..f1bcb73 100644 --- a/docker-compose.Example.yml +++ b/docker-compose.Example.yml @@ -10,6 +10,7 @@ services: - internal ports: - "8001:8001" + db: image: mariadb:11 restart: unless-stopped @@ -30,6 +31,22 @@ services: networks: - internal + # Watchtower is a service that will automatically update your running containers + # when a new image is available. This is useful for keeping your server up-to-date. + # see https://containrrr.dev/watchtower/ for more information. + watchtower: + image: containrrr/watchtower + container_name: watchtower + restart: always + security_opt: + - no-new-privileges:true + environment: + WATCHTOWER_CLEANUP: true + WATCHTOWER_SCHEDULE: "@midnight" + volumes: + - /etc/localtime:/etc/localtime:ro + - /var/run/docker.sock:/var/run/docker.sock + volumes: database: From a44a6c382f6d8232b0bbf001ddc3207e05be684b Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 08:30:46 +0200 Subject: [PATCH 36/47] save data when applying vouchers --- api/savedata/get.go | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/api/savedata/get.go b/api/savedata/get.go index 7c844a9..8c71797 100644 --- a/api/savedata/get.go +++ b/api/savedata/get.go @@ -38,13 +38,25 @@ func Get(uuid []byte, datatype, slot int) (any, error) { return nil, err } + // TODO this should be a transaction compensations, err := db.FetchAndClaimAccountCompensations(uuid) if err != nil { return nil, fmt.Errorf("failed to fetch compensations: %s", err) } + needsUpdate := false for compensationType, amount := range compensations { system.VoucherCounts[strconv.Itoa(compensationType)] += amount + if amount > 0 { + needsUpdate = true + } + } + + if needsUpdate { + err = db.StoreSystemSaveData(uuid, system) + if err != nil { + return nil, fmt.Errorf("failed to update system save data: %s", err) + } } return system, nil From 81853b1863b2214066739fc622d20da76e158f30 Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 08:38:57 +0200 Subject: [PATCH 37/47] forgot to update stats column --- api/savedata/get.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/api/savedata/get.go b/api/savedata/get.go index 8c71797..1e5feeb 100644 --- a/api/savedata/get.go +++ b/api/savedata/get.go @@ -57,6 +57,11 @@ func Get(uuid []byte, datatype, slot int) (any, error) { if err != nil { return nil, fmt.Errorf("failed to update system save data: %s", err) } + + err = db.UpdateAccountStats(uuid, system.GameStats, system.VoucherCounts) + if err != nil { + return nil, fmt.Errorf("failed to update account stats: %s", err) + } } return system, nil From f0c283af4245010f1639a2ff11de1adae938d706 Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 19:44:04 +0200 Subject: [PATCH 38/47] merge token and uuid lookups to reduce roundtrips --- api/common.go | 11 ++++++++--- api/endpoints.go | 17 ++--------------- 2 files changed, 10 insertions(+), 18 deletions(-) diff --git a/api/common.go b/api/common.go index f3c3fa9..b355b92 100644 --- a/api/common.go +++ b/api/common.go @@ -82,17 +82,22 @@ func tokenFromRequest(r *http.Request) ([]byte, error) { } func uuidFromRequest(r *http.Request) ([]byte, error) { + _, uuid, err := tokenAndUuidFromRequest(r) + return uuid, err +} + +func tokenAndUuidFromRequest(r *http.Request) ([]byte, []byte, error) { token, err := tokenFromRequest(r) if err != nil { - return nil, err + return nil, nil, err } uuid, err := db.FetchUUIDFromToken(token) if err != nil { - return nil, fmt.Errorf("failed to validate token: %s", err) + return nil, nil, fmt.Errorf("failed to validate token: %s", err) } - return uuid, nil + return token, uuid, nil } func httpError(w http.ResponseWriter, r *http.Request, err error, code int) { diff --git a/api/endpoints.go b/api/endpoints.go index e305954..5402c3b 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -163,7 +163,7 @@ func handleGameClassicSessionCount(w http.ResponseWriter, r *http.Request) { } func handleSaveData(w http.ResponseWriter, r *http.Request) { - uuid, err := uuidFromRequest(r) + token, uuid, err := tokenAndUuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) return @@ -212,13 +212,6 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { } } - var token []byte - token, err = tokenFromRequest(r) - if err != nil { - httpError(w, r, err, http.StatusBadRequest) - return - } - var active bool if r.URL.Path == "/savedata/get" { if datatype == 0 { @@ -337,13 +330,7 @@ type CombinedSaveData struct { // TODO wrap this in a transaction func handleSaveData2(w http.ResponseWriter, r *http.Request) { var token []byte - token, err := tokenFromRequest(r) - if err != nil { - httpError(w, r, err, http.StatusBadRequest) - return - } - - uuid, err := uuidFromRequest(r) + token, uuid, err := tokenAndUuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) return From d70c082aa91350d8a88f6f0f9dd4a2128c876b80 Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 20:05:46 +0200 Subject: [PATCH 39/47] simplify json response writing --- api/common.go | 12 +++++- api/endpoints.go | 98 +++++++++++++++++++++++++++--------------------- 2 files changed, 67 insertions(+), 43 deletions(-) diff --git a/api/common.go b/api/common.go index b355b92..6b0a88b 100644 --- a/api/common.go +++ b/api/common.go @@ -19,6 +19,7 @@ package api import ( "encoding/base64" + "encoding/json" "fmt" "log" "net/http" @@ -48,7 +49,7 @@ func Init(mux *http.ServeMux) error { mux.HandleFunc("GET /game/classicsessioncount", handleGameClassicSessionCount) // savedata - mux.HandleFunc("GET /savedata/get", handleSaveData) + mux.HandleFunc("GET /savedata/get", getSaveData) mux.HandleFunc("POST /savedata/update", handleSaveData) mux.HandleFunc("GET /savedata/delete", handleSaveData) mux.HandleFunc("POST /savedata/clear", handleSaveData) @@ -104,3 +105,12 @@ func httpError(w http.ResponseWriter, r *http.Request, err error, code int) { log.Printf("%s: %s\n", r.URL.Path, err) http.Error(w, err.Error(), code) } + +func jsonResponse(w http.ResponseWriter, r *http.Request, data any) { + w.Header().Set("Content-Type", "application/json") + err := json.NewEncoder(w).Encode(data) + if err != nil { + httpError(w, r, fmt.Errorf("failed to encode response json: %s", err), http.StatusInternalServerError) + return + } +} diff --git a/api/endpoints.go b/api/endpoints.go index 5402c3b..ca10ddf 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -20,6 +20,7 @@ package api import ( "database/sql" "encoding/json" + "errors" "fmt" "net/http" "strconv" @@ -58,13 +59,7 @@ func handleAccountInfo(w http.ResponseWriter, r *http.Request) { return } - err = json.NewEncoder(w).Encode(response) - if err != nil { - httpError(w, r, fmt.Errorf("failed to encode response json: %s", err), http.StatusInternalServerError) - return - } - - w.Header().Set("Content-Type", "application/json") + jsonResponse(w, r, response) } func handleAccountRegister(w http.ResponseWriter, r *http.Request) { @@ -96,13 +91,7 @@ func handleAccountLogin(w http.ResponseWriter, r *http.Request) { return } - err = json.NewEncoder(w).Encode(response) - if err != nil { - httpError(w, r, fmt.Errorf("failed to encode response json: %s", err), http.StatusInternalServerError) - return - } - - w.Header().Set("Content-Type", "application/json") + jsonResponse(w, r, response) } func handleAccountChangePW(w http.ResponseWriter, r *http.Request) { @@ -144,24 +133,67 @@ func handleAccountLogout(w http.ResponseWriter, r *http.Request) { } // game - func handleGameTitleStats(w http.ResponseWriter, r *http.Request) { - err := json.NewEncoder(w).Encode(defs.TitleStats{ + stats := defs.TitleStats{ PlayerCount: playerCount, BattleCount: battleCount, - }) - if err != nil { - httpError(w, r, fmt.Errorf("failed to encode response json: %s", err), http.StatusInternalServerError) - return } - w.Header().Set("Content-Type", "application/json") + jsonResponse(w, r, stats) } func handleGameClassicSessionCount(w http.ResponseWriter, r *http.Request) { _, _ = w.Write([]byte(strconv.Itoa(classicSessionCount))) } +func getSaveData(w http.ResponseWriter, r *http.Request) { + token, uuid, err := tokenAndUuidFromRequest(r) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + + datatype := -1 + if r.URL.Query().Has("datatype") { + datatype, err = strconv.Atoi(r.URL.Query().Get("datatype")) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + } + + var slot int + if r.URL.Query().Has("slot") { + slot, err = strconv.Atoi(r.URL.Query().Get("slot")) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + } + + var save any + if datatype == 0 { + err = db.UpdateActiveSession(uuid, token) + if err != nil { + httpError(w, r, fmt.Errorf("failed to update active session: %s", err), http.StatusBadRequest) + return + } + } + + save, err = savedata.Get(uuid, datatype, slot) + if errors.Is(err, sql.ErrNoRows) { + http.Error(w, err.Error(), http.StatusNotFound) + return + } + + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + + jsonResponse(w, r, save) +} + func handleSaveData(w http.ResponseWriter, r *http.Request) { token, uuid, err := tokenAndUuidFromRequest(r) if err != nil { @@ -312,13 +344,7 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { return } - err = json.NewEncoder(w).Encode(save) - if err != nil { - httpError(w, r, fmt.Errorf("failed to encode response json: %s", err), http.StatusInternalServerError) - return - } - - w.Header().Set("Content-Type", "application/json") + jsonResponse(w, r, save) } type CombinedSaveData struct { @@ -411,13 +437,7 @@ func handleNewClear(w http.ResponseWriter, r *http.Request) { return } - err = json.NewEncoder(w).Encode(newClear) - if err != nil { - httpError(w, r, fmt.Errorf("failed to encode response json: %s", err), http.StatusInternalServerError) - return - } - - w.Header().Set("Content-Type", "application/json") + jsonResponse(w, r, newClear) } // daily @@ -459,13 +479,7 @@ func handleDailyRankings(w http.ResponseWriter, r *http.Request) { return } - err = json.NewEncoder(w).Encode(rankings) - if err != nil { - httpError(w, r, fmt.Errorf("failed to encode response json: %s", err), http.StatusInternalServerError) - return - } - - w.Header().Set("Content-Type", "application/json") + jsonResponse(w, r, rankings) } func handleDailyRankingPageCount(w http.ResponseWriter, r *http.Request) { From 8439519d8e78a3cd312974c40567f6477cd68176 Mon Sep 17 00:00:00 2001 From: Up Date: Sun, 12 May 2024 20:42:07 +0200 Subject: [PATCH 40/47] start on splitting api call handler function --- api/common.go | 8 +-- api/endpoints.go | 178 ++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 179 insertions(+), 7 deletions(-) diff --git a/api/common.go b/api/common.go index 6b0a88b..b1f11dd 100644 --- a/api/common.go +++ b/api/common.go @@ -49,14 +49,14 @@ func Init(mux *http.ServeMux) error { mux.HandleFunc("GET /game/classicsessioncount", handleGameClassicSessionCount) // savedata - mux.HandleFunc("GET /savedata/get", getSaveData) + mux.HandleFunc("GET /savedata/get", handleGetSaveData) mux.HandleFunc("POST /savedata/update", handleSaveData) - mux.HandleFunc("GET /savedata/delete", handleSaveData) - mux.HandleFunc("POST /savedata/clear", handleSaveData) + mux.HandleFunc("GET /savedata/delete", handleSaveData) // TODO use deleteSystemSave + mux.HandleFunc("POST /savedata/clear", handleSaveData) // TODO use clearSessionData mux.HandleFunc("GET /savedata/newclear", handleNewClear) // new session - mux.HandleFunc("POST /savedata/updateall", handleSaveData2) + mux.HandleFunc("POST /savedata/updateall", handleUpdateAll) // daily mux.HandleFunc("GET /daily/seed", handleDailySeed) diff --git a/api/endpoints.go b/api/endpoints.go index ca10ddf..be24e33 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -146,7 +146,7 @@ func handleGameClassicSessionCount(w http.ResponseWriter, r *http.Request) { _, _ = w.Write([]byte(strconv.Itoa(classicSessionCount))) } -func getSaveData(w http.ResponseWriter, r *http.Request) { +func handleGetSaveData(w http.ResponseWriter, r *http.Request) { token, uuid, err := tokenAndUuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) @@ -194,6 +194,175 @@ func getSaveData(w http.ResponseWriter, r *http.Request) { jsonResponse(w, r, save) } +// FIXME UNFINISHED!!! +func clearSessionData(w http.ResponseWriter, r *http.Request) { + token, uuid, err := tokenAndUuidFromRequest(r) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + + var slot int + if r.URL.Query().Has("slot") { + slot, err = strconv.Atoi(r.URL.Query().Get("slot")) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + } + + var save any + var session defs.SessionSaveData + err = json.NewDecoder(r.Body).Decode(&session) + if err != nil { + httpError(w, r, fmt.Errorf("failed to decode request body: %s", err), http.StatusBadRequest) + return + } + + save = session + + var active bool + active, err = db.IsActiveSession(token) + if err != nil { + httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusBadRequest) + return + } + + var trainerId, secretId int + if r.URL.Query().Has("trainerId") && r.URL.Query().Has("secretId") { + trainerId, err = strconv.Atoi(r.URL.Query().Get("trainerId")) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + + secretId, err = strconv.Atoi(r.URL.Query().Get("secretId")) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + } + + storedTrainerId, storedSecretId, err := db.FetchTrainerIds(uuid) + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + + if storedTrainerId > 0 || storedSecretId > 0 { + if trainerId != storedTrainerId || secretId != storedSecretId { + httpError(w, r, fmt.Errorf("session out of date"), http.StatusBadRequest) + return + } + } else { + err = db.UpdateTrainerIds(trainerId, secretId, uuid) + if err != nil { + httpError(w, r, fmt.Errorf("unable to update traienr ID: %s", err), http.StatusInternalServerError) + return + } + } + + if !active { + save = savedata.ClearResponse{Error: "session out of date"} + } + + var seed string + seed, err = db.GetDailyRunSeed() + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + + response, err := savedata.Clear(uuid, slot, seed, save.(defs.SessionSaveData)) + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + + jsonResponse(w, r, response) +} + +// FIXME UNFINISHED!!! +func deleteSystemSave(w http.ResponseWriter, r *http.Request) { + token, uuid, err := tokenAndUuidFromRequest(r) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + + datatype := 0 + if r.URL.Query().Has("datatype") { + datatype, err = strconv.Atoi(r.URL.Query().Get("datatype")) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + } + + var slot int + if r.URL.Query().Has("slot") { + slot, err = strconv.Atoi(r.URL.Query().Get("slot")) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + } + + var active bool + active, err = db.IsActiveSession(token) + if err != nil { + httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusInternalServerError) + return + } + + if !active { + httpError(w, r, fmt.Errorf("session out of date"), http.StatusBadRequest) + return + } + + var trainerId, secretId int + + if r.URL.Query().Has("trainerId") && r.URL.Query().Has("secretId") { + trainerId, err = strconv.Atoi(r.URL.Query().Get("trainerId")) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + + secretId, err = strconv.Atoi(r.URL.Query().Get("secretId")) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + } + + storedTrainerId, storedSecretId, err := db.FetchTrainerIds(uuid) + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + + if storedTrainerId > 0 || storedSecretId > 0 { + if trainerId != storedTrainerId || secretId != storedSecretId { + httpError(w, r, fmt.Errorf("session out of date"), http.StatusBadRequest) + return + } + } else { + if err := db.UpdateTrainerIds(trainerId, secretId, uuid); err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + } + + err = savedata.Delete(uuid, datatype, slot) + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + + w.WriteHeader(http.StatusOK) +} + func handleSaveData(w http.ResponseWriter, r *http.Request) { token, uuid, err := tokenAndUuidFromRequest(r) if err != nil { @@ -354,7 +523,7 @@ type CombinedSaveData struct { } // TODO wrap this in a transaction -func handleSaveData2(w http.ResponseWriter, r *http.Request) { +func handleUpdateAll(w http.ResponseWriter, r *http.Request) { var token []byte token, uuid, err := tokenAndUuidFromRequest(r) if err != nil { @@ -449,7 +618,10 @@ func handleDailySeed(w http.ResponseWriter, r *http.Request) { return } - _, _ = w.Write([]byte(seed)) + _, err = w.Write([]byte(seed)) + if err != nil { + httpError(w, r, fmt.Errorf("failed to write seed: %s", err), http.StatusInternalServerError) + } } func handleDailyRankings(w http.ResponseWriter, r *http.Request) { From 436fce875901474beb2d48d7ee5676579974c37d Mon Sep 17 00:00:00 2001 From: Up Date: Tue, 14 May 2024 12:54:06 +0200 Subject: [PATCH 41/47] add client session ID tokens --- api/common.go | 18 +++-- api/endpoints.go | 185 +++++++++++++++++++++++++++++++++++++++++++---- db/account.go | 24 +++--- db/db.go | 8 ++ 4 files changed, 203 insertions(+), 32 deletions(-) diff --git a/api/common.go b/api/common.go index b1f11dd..ec87644 100644 --- a/api/common.go +++ b/api/common.go @@ -21,12 +21,11 @@ import ( "encoding/base64" "encoding/json" "fmt" - "log" - "net/http" - "github.com/pagefaultgames/rogueserver/api/account" "github.com/pagefaultgames/rogueserver/api/daily" "github.com/pagefaultgames/rogueserver/db" + "log" + "net/http" ) func Init(mux *http.ServeMux) error { @@ -49,14 +48,17 @@ func Init(mux *http.ServeMux) error { mux.HandleFunc("GET /game/classicsessioncount", handleGameClassicSessionCount) // savedata - mux.HandleFunc("GET /savedata/get", handleGetSaveData) - mux.HandleFunc("POST /savedata/update", handleSaveData) - mux.HandleFunc("GET /savedata/delete", handleSaveData) // TODO use deleteSystemSave - mux.HandleFunc("POST /savedata/clear", handleSaveData) // TODO use clearSessionData - mux.HandleFunc("GET /savedata/newclear", handleNewClear) + mux.HandleFunc("GET /savedata/get", legacyHandleGetSaveData) + mux.HandleFunc("POST /savedata/update", legacyHandleSaveData) + mux.HandleFunc("GET /savedata/delete", legacyHandleSaveData) // TODO use deleteSystemSave + mux.HandleFunc("POST /savedata/clear", legacyHandleSaveData) // TODO use clearSessionData + mux.HandleFunc("GET /savedata/newclear", legacyHandleNewClear) // new session mux.HandleFunc("POST /savedata/updateall", handleUpdateAll) + mux.HandleFunc("POST /savedata/verify", handleSessionVerify) + mux.HandleFunc("GET /savedata/system", handleGetSystemData) + mux.HandleFunc("GET /savedata/session", handleGetSessionData) // daily mux.HandleFunc("GET /daily/seed", handleDailySeed) diff --git a/api/endpoints.go b/api/endpoints.go index be24e33..676570e 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -146,7 +146,53 @@ func handleGameClassicSessionCount(w http.ResponseWriter, r *http.Request) { _, _ = w.Write([]byte(strconv.Itoa(classicSessionCount))) } -func handleGetSaveData(w http.ResponseWriter, r *http.Request) { +func handleGetSessionData(w http.ResponseWriter, r *http.Request) { + token, uuid, err := tokenAndUuidFromRequest(r) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + + var slot int + if r.URL.Query().Has("slot") { + slot, err = strconv.Atoi(r.URL.Query().Get("slot")) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + } + + var clientSessionId string + if r.URL.Query().Has("clientSessionId") { + clientSessionId = r.URL.Query().Get("clientSessionId") + } else { + httpError(w, r, fmt.Errorf("missing clientSessionId"), http.StatusBadRequest) + } + + err = db.UpdateActiveSession(token, clientSessionId) + if err != nil { + httpError(w, r, fmt.Errorf("failed to update active session: %s", err), http.StatusBadRequest) + return + } + + var save any + save, err = savedata.Get(uuid, 1, slot) + if errors.Is(err, sql.ErrNoRows) { + http.Error(w, err.Error(), http.StatusNotFound) + return + } + + if err != nil { + httpError(w, r, err, http.StatusInternalServerError) + return + } + + jsonResponse(w, r, save) +} + +const legacyClientSessionId = "LEGACY_CLIENT" + +func legacyHandleGetSaveData(w http.ResponseWriter, r *http.Request) { token, uuid, err := tokenAndUuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) @@ -173,7 +219,7 @@ func handleGetSaveData(w http.ResponseWriter, r *http.Request) { var save any if datatype == 0 { - err = db.UpdateActiveSession(uuid, token) + err = db.UpdateActiveSession(token, legacyClientSessionId) // we dont have a client id if err != nil { httpError(w, r, fmt.Errorf("failed to update active session: %s", err), http.StatusBadRequest) return @@ -222,7 +268,7 @@ func clearSessionData(w http.ResponseWriter, r *http.Request) { save = session var active bool - active, err = db.IsActiveSession(token) + active, err = db.IsActiveSession(token, legacyClientSessionId) //TODO unfinished, read token from query if err != nil { httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusBadRequest) return @@ -309,7 +355,7 @@ func deleteSystemSave(w http.ResponseWriter, r *http.Request) { } var active bool - active, err = db.IsActiveSession(token) + active, err = db.IsActiveSession(token, legacyClientSessionId) //TODO unfinished, read token from query if err != nil { httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusInternalServerError) return @@ -363,7 +409,7 @@ func deleteSystemSave(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) } -func handleSaveData(w http.ResponseWriter, r *http.Request) { +func legacyHandleSaveData(w http.ResponseWriter, r *http.Request) { token, uuid, err := tokenAndUuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) @@ -388,6 +434,14 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { } } + var clientSessionId string + if r.URL.Query().Has("clientSessionId") { + clientSessionId = r.URL.Query().Get("clientSessionId") + } + if clientSessionId == "" { + clientSessionId = legacyClientSessionId + } + var save any // /savedata/get and /savedata/delete specify datatype, but don't expect data in body if r.URL.Path != "/savedata/get" && r.URL.Path != "/savedata/delete" { @@ -416,14 +470,14 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { var active bool if r.URL.Path == "/savedata/get" { if datatype == 0 { - err = db.UpdateActiveSession(uuid, token) + err = db.UpdateActiveSession(token, clientSessionId) if err != nil { httpError(w, r, fmt.Errorf("failed to update active session: %s", err), http.StatusBadRequest) return } } } else { - active, err = db.IsActiveSession(token) + active, err = db.IsActiveSession(token, clientSessionId) if err != nil { httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusBadRequest) return @@ -517,9 +571,10 @@ func handleSaveData(w http.ResponseWriter, r *http.Request) { } type CombinedSaveData struct { - System defs.SystemSaveData `json:"system"` - Session defs.SessionSaveData `json:"session"` - SessionSlotId int `json:"sessionSlotId"` + System defs.SystemSaveData `json:"system"` + Session defs.SessionSaveData `json:"session"` + SessionSlotId int `json:"sessionSlotId"` + ClientSessionId string `json:"clientSessionId"` } // TODO wrap this in a transaction @@ -531,6 +586,14 @@ func handleUpdateAll(w http.ResponseWriter, r *http.Request) { return } + var clientSessionId string + if r.URL.Query().Has("clientSessionId") { + clientSessionId = r.URL.Query().Get("clientSessionId") + } + if clientSessionId == "" { + clientSessionId = legacyClientSessionId + } + var data CombinedSaveData err = json.NewDecoder(r.Body).Decode(&data) if err != nil { @@ -539,7 +602,7 @@ func handleUpdateAll(w http.ResponseWriter, r *http.Request) { } var active bool - active, err = db.IsActiveSession(token) + active, err = db.IsActiveSession(token, clientSessionId) if err != nil { httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusBadRequest) return @@ -584,7 +647,104 @@ func handleUpdateAll(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) } -func handleNewClear(w http.ResponseWriter, r *http.Request) { +type SessionVerifyResponse struct { + Valid bool `json:"valid"` + SessionData *defs.SessionSaveData `json:"sessionData"` +} + +type SessionVerifyRequest struct { + ClientSessionId string `json:"clientSessionId"` + Slot int `json:"slot"` +} + +func handleSessionVerify(w http.ResponseWriter, r *http.Request) { + var token []byte + token, err := tokenFromRequest(r) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + + var input SessionVerifyRequest + err = json.NewDecoder(r.Body).Decode(&input) + if err != nil { + httpError(w, r, fmt.Errorf("failed to decode request body: %s", err), http.StatusBadRequest) + return + } + + var active bool + active, err = db.IsActiveSession(token, input.ClientSessionId) + if err != nil { + httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusBadRequest) + return + } + + response := SessionVerifyResponse{ + Valid: active, + } + + // not valid, send server state + if !active { + err = db.UpdateActiveSession(token, input.ClientSessionId) + if err != nil { + httpError(w, r, fmt.Errorf("failed to update active session: %s", err), http.StatusBadRequest) + return + } + + var uuid []byte + uuid, err = db.FetchUUIDFromToken(token) + if err != nil { + httpError(w, r, fmt.Errorf("failed to fetch UUID from token: %s", err), http.StatusInternalServerError) + } + var storedSaveData defs.SessionSaveData + storedSaveData, err = db.ReadSessionSaveData(uuid, input.Slot) + if err != nil { + httpError(w, r, fmt.Errorf("failed to read session save data: %s", err), http.StatusInternalServerError) + return + } + + response.SessionData = &storedSaveData + } + + jsonResponse(w, r, response) +} + +func handleGetSystemData(w http.ResponseWriter, r *http.Request) { + token, uuid, err := tokenAndUuidFromRequest(r) + if err != nil { + httpError(w, r, err, http.StatusBadRequest) + return + } + + var clientSessionId string + if r.URL.Query().Has("clientSessionId") { + clientSessionId = r.URL.Query().Get("clientSessionId") + } else { + httpError(w, r, fmt.Errorf("missing clientSessionId"), http.StatusBadRequest) + } + + err = db.UpdateActiveSession(token, clientSessionId) + if err != nil { + httpError(w, r, fmt.Errorf("failed to update active session: %s", err), http.StatusBadRequest) + return + } + + var save any //TODO this is always system save data + save, err = savedata.Get(uuid, 0, 0) + if err != nil { + if errors.Is(err, sql.ErrNoRows) { + http.Error(w, err.Error(), http.StatusNotFound) + } else { + httpError(w, r, err, http.StatusInternalServerError) + } + + return + } + + jsonResponse(w, r, save) +} + +func legacyHandleNewClear(w http.ResponseWriter, r *http.Request) { uuid, err := uuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) @@ -610,7 +770,6 @@ func handleNewClear(w http.ResponseWriter, r *http.Request) { } // daily - func handleDailySeed(w http.ResponseWriter, r *http.Request) { seed, err := db.GetDailyRunSeed() if err != nil { diff --git a/db/account.go b/db/account.go index a3dddd2..88b54db 100644 --- a/db/account.go +++ b/db/account.go @@ -40,11 +40,6 @@ func AddAccountSession(username string, token []byte) error { return err } - _, err = handle.Exec("UPDATE sessions s JOIN accounts a ON a.uuid = s.uuid SET s.active = 1 WHERE a.username = ? AND a.lastLoggedIn IS NULL", username) - if err != nil { - return err - } - _, err = handle.Exec("UPDATE accounts SET lastLoggedIn = UTC_TIMESTAMP() WHERE username = ?", username) if err != nil { return err @@ -213,18 +208,25 @@ func UpdateTrainerIds(trainerId, secretId int, uuid []byte) error { return nil } -func IsActiveSession(token []byte) (bool, error) { - var active int - err := handle.QueryRow("SELECT `active` FROM sessions WHERE token = ?", token).Scan(&active) +func IsActiveSession(token []byte, clientSessionId string) (bool, error) { + var storedId string + err := handle.QueryRow("SELECT `clientSessionId` FROM sessions WHERE token = ?", token).Scan(&storedId) if err != nil { return false, err } + if storedId == "" { + err = UpdateActiveSession(token, clientSessionId) + if err != nil { + return false, err + } + return true, nil + } - return active == 1, nil + return storedId == clientSessionId, nil } -func UpdateActiveSession(uuid []byte, token []byte) error { - _, err := handle.Exec("UPDATE sessions SET `active` = CASE WHEN token = ? THEN 1 ELSE 0 END WHERE uuid = ?", token, uuid) +func UpdateActiveSession(token []byte, clientSessionId string) error { + _, err := handle.Exec("UPDATE sessions SET clientSessionId = ? WHERE token = ?", clientSessionId, token) if err != nil { return err } diff --git a/db/db.go b/db/db.go index 874a48c..d4ddc88 100644 --- a/db/db.go +++ b/db/db.go @@ -145,6 +145,8 @@ func Init(username, password, protocol, address, database string) error { func setupDb(tx *sql.Tx) error { queries := []string{ + // MIGRATION 000 + `CREATE TABLE IF NOT EXISTS accounts (uuid BINARY(16) NOT NULL PRIMARY KEY, username VARCHAR(16) UNIQUE NOT NULL, hash BINARY(32) NOT NULL, salt BINARY(16) NOT NULL, registered TIMESTAMP NOT NULL, lastLoggedIn TIMESTAMP DEFAULT NULL, lastActivity TIMESTAMP DEFAULT NULL, banned TINYINT(1) NOT NULL DEFAULT 0, trainerId SMALLINT(5) UNSIGNED DEFAULT 0, secretId SMALLINT(5) UNSIGNED DEFAULT 0)`, `CREATE INDEX IF NOT EXISTS accountsByActivity ON accounts (lastActivity)`, @@ -168,6 +170,12 @@ func setupDb(tx *sql.Tx) error { `CREATE TABLE IF NOT EXISTS systemSaveData (uuid BINARY(16) PRIMARY KEY, data LONGBLOB, timestamp TIMESTAMP)`, `CREATE TABLE IF NOT EXISTS sessionSaveData (uuid BINARY(16), slot TINYINT, data LONGBLOB, timestamp TIMESTAMP, PRIMARY KEY (uuid, slot))`, + + // ---------------------------------- + // MIGRATION 001 + + `ALTER TABLE sessions DROP COLUMN IF EXISTS active`, + `ALTER TABLE sessions ADD COLUMN IF NOT EXISTS clientSessionId VARCHAR(32)`, } for _, q := range queries { From 12b0a0df0b5bcedfb88272ea17a102e1213e768f Mon Sep 17 00:00:00 2001 From: Up Date: Tue, 14 May 2024 13:01:29 +0200 Subject: [PATCH 42/47] try make linter ignore unused stuff --- .golangci.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.golangci.yml b/.golangci.yml index e69de29..66b438c 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -0,0 +1,6 @@ +severity: + default-severity: error + rules: + - linters: + - unused + severity: warning From c24d006f889f1aa296f184a7ea0a02ab5750c4cc Mon Sep 17 00:00:00 2001 From: Up Date: Tue, 14 May 2024 13:07:07 +0200 Subject: [PATCH 43/47] move linter args to config file --- .github/workflows/ci.yml | 1 - .golangci.yml | 4 +++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index df3d97e..1912464 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -36,7 +36,6 @@ jobs: - name: Lint Codebase uses: golangci/golangci-lint-action@v6 with: - args: --timeout=10m version: latest - name: Test run: go test -v diff --git a/.golangci.yml b/.golangci.yml index 66b438c..58c100b 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -1,6 +1,8 @@ +run: + timeout: 10m severity: default-severity: error rules: - linters: - unused - severity: warning + severity: info From b88b3f6fab37f1eeb7c195df698c27b104347741 Mon Sep 17 00:00:00 2001 From: Up Date: Tue, 14 May 2024 13:18:39 +0200 Subject: [PATCH 44/47] explicitly define linter config --- .github/workflows/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1912464..d2f0ba7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -37,6 +37,7 @@ jobs: uses: golangci/golangci-lint-action@v6 with: version: latest + args: --config .golangci.yml - name: Test run: go test -v - name: Build From 983e17c8945e541fdcbcb86373e3052824e1b833 Mon Sep 17 00:00:00 2001 From: Up Date: Tue, 14 May 2024 13:23:22 +0200 Subject: [PATCH 45/47] continue if linting fails --- .github/workflows/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d2f0ba7..a7a7b87 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -34,6 +34,7 @@ jobs: - name: Install dependencies run: go mod download - name: Lint Codebase + continue-on-error: true uses: golangci/golangci-lint-action@v6 with: version: latest From c0aade2e65952fd48e0b1d44894bf2b4621d0dae Mon Sep 17 00:00:00 2001 From: Up Date: Tue, 14 May 2024 14:30:04 +0200 Subject: [PATCH 46/47] simplify ID handling --- api/endpoints.go | 43 ++++++++++++++++++------------------------- db/account.go | 15 ++++++++++----- db/db.go | 2 +- 3 files changed, 29 insertions(+), 31 deletions(-) diff --git a/api/endpoints.go b/api/endpoints.go index 676570e..62a958d 100644 --- a/api/endpoints.go +++ b/api/endpoints.go @@ -147,7 +147,7 @@ func handleGameClassicSessionCount(w http.ResponseWriter, r *http.Request) { } func handleGetSessionData(w http.ResponseWriter, r *http.Request) { - token, uuid, err := tokenAndUuidFromRequest(r) + uuid, err := uuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) return @@ -169,7 +169,7 @@ func handleGetSessionData(w http.ResponseWriter, r *http.Request) { httpError(w, r, fmt.Errorf("missing clientSessionId"), http.StatusBadRequest) } - err = db.UpdateActiveSession(token, clientSessionId) + err = db.UpdateActiveSession(uuid, clientSessionId) if err != nil { httpError(w, r, fmt.Errorf("failed to update active session: %s", err), http.StatusBadRequest) return @@ -193,7 +193,7 @@ func handleGetSessionData(w http.ResponseWriter, r *http.Request) { const legacyClientSessionId = "LEGACY_CLIENT" func legacyHandleGetSaveData(w http.ResponseWriter, r *http.Request) { - token, uuid, err := tokenAndUuidFromRequest(r) + uuid, err := uuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) return @@ -219,7 +219,7 @@ func legacyHandleGetSaveData(w http.ResponseWriter, r *http.Request) { var save any if datatype == 0 { - err = db.UpdateActiveSession(token, legacyClientSessionId) // we dont have a client id + err = db.UpdateActiveSession(uuid, legacyClientSessionId) // we dont have a client id if err != nil { httpError(w, r, fmt.Errorf("failed to update active session: %s", err), http.StatusBadRequest) return @@ -242,7 +242,7 @@ func legacyHandleGetSaveData(w http.ResponseWriter, r *http.Request) { // FIXME UNFINISHED!!! func clearSessionData(w http.ResponseWriter, r *http.Request) { - token, uuid, err := tokenAndUuidFromRequest(r) + uuid, err := uuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) return @@ -268,7 +268,7 @@ func clearSessionData(w http.ResponseWriter, r *http.Request) { save = session var active bool - active, err = db.IsActiveSession(token, legacyClientSessionId) //TODO unfinished, read token from query + active, err = db.IsActiveSession(uuid, legacyClientSessionId) //TODO unfinished, read token from query if err != nil { httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusBadRequest) return @@ -330,7 +330,7 @@ func clearSessionData(w http.ResponseWriter, r *http.Request) { // FIXME UNFINISHED!!! func deleteSystemSave(w http.ResponseWriter, r *http.Request) { - token, uuid, err := tokenAndUuidFromRequest(r) + uuid, err := uuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) return @@ -355,7 +355,7 @@ func deleteSystemSave(w http.ResponseWriter, r *http.Request) { } var active bool - active, err = db.IsActiveSession(token, legacyClientSessionId) //TODO unfinished, read token from query + active, err = db.IsActiveSession(uuid, legacyClientSessionId) //TODO unfinished, read token from query if err != nil { httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusInternalServerError) return @@ -410,7 +410,7 @@ func deleteSystemSave(w http.ResponseWriter, r *http.Request) { } func legacyHandleSaveData(w http.ResponseWriter, r *http.Request) { - token, uuid, err := tokenAndUuidFromRequest(r) + uuid, err := uuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) return @@ -470,14 +470,14 @@ func legacyHandleSaveData(w http.ResponseWriter, r *http.Request) { var active bool if r.URL.Path == "/savedata/get" { if datatype == 0 { - err = db.UpdateActiveSession(token, clientSessionId) + err = db.UpdateActiveSession(uuid, clientSessionId) if err != nil { httpError(w, r, fmt.Errorf("failed to update active session: %s", err), http.StatusBadRequest) return } } } else { - active, err = db.IsActiveSession(token, clientSessionId) + active, err = db.IsActiveSession(uuid, clientSessionId) if err != nil { httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusBadRequest) return @@ -579,8 +579,7 @@ type CombinedSaveData struct { // TODO wrap this in a transaction func handleUpdateAll(w http.ResponseWriter, r *http.Request) { - var token []byte - token, uuid, err := tokenAndUuidFromRequest(r) + uuid, err := uuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) return @@ -602,7 +601,7 @@ func handleUpdateAll(w http.ResponseWriter, r *http.Request) { } var active bool - active, err = db.IsActiveSession(token, clientSessionId) + active, err = db.IsActiveSession(uuid, clientSessionId) if err != nil { httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusBadRequest) return @@ -658,8 +657,7 @@ type SessionVerifyRequest struct { } func handleSessionVerify(w http.ResponseWriter, r *http.Request) { - var token []byte - token, err := tokenFromRequest(r) + uuid, err := uuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) return @@ -673,7 +671,7 @@ func handleSessionVerify(w http.ResponseWriter, r *http.Request) { } var active bool - active, err = db.IsActiveSession(token, input.ClientSessionId) + active, err = db.IsActiveSession(uuid, input.ClientSessionId) if err != nil { httpError(w, r, fmt.Errorf("failed to check active session: %s", err), http.StatusBadRequest) return @@ -685,17 +683,12 @@ func handleSessionVerify(w http.ResponseWriter, r *http.Request) { // not valid, send server state if !active { - err = db.UpdateActiveSession(token, input.ClientSessionId) + err = db.UpdateActiveSession(uuid, input.ClientSessionId) if err != nil { httpError(w, r, fmt.Errorf("failed to update active session: %s", err), http.StatusBadRequest) return } - var uuid []byte - uuid, err = db.FetchUUIDFromToken(token) - if err != nil { - httpError(w, r, fmt.Errorf("failed to fetch UUID from token: %s", err), http.StatusInternalServerError) - } var storedSaveData defs.SessionSaveData storedSaveData, err = db.ReadSessionSaveData(uuid, input.Slot) if err != nil { @@ -710,7 +703,7 @@ func handleSessionVerify(w http.ResponseWriter, r *http.Request) { } func handleGetSystemData(w http.ResponseWriter, r *http.Request) { - token, uuid, err := tokenAndUuidFromRequest(r) + uuid, err := uuidFromRequest(r) if err != nil { httpError(w, r, err, http.StatusBadRequest) return @@ -723,7 +716,7 @@ func handleGetSystemData(w http.ResponseWriter, r *http.Request) { httpError(w, r, fmt.Errorf("missing clientSessionId"), http.StatusBadRequest) } - err = db.UpdateActiveSession(token, clientSessionId) + err = db.UpdateActiveSession(uuid, clientSessionId) if err != nil { httpError(w, r, fmt.Errorf("failed to update active session: %s", err), http.StatusBadRequest) return diff --git a/db/account.go b/db/account.go index 88b54db..e000122 100644 --- a/db/account.go +++ b/db/account.go @@ -18,6 +18,8 @@ package db import ( + "database/sql" + "errors" "fmt" "slices" @@ -208,14 +210,17 @@ func UpdateTrainerIds(trainerId, secretId int, uuid []byte) error { return nil } -func IsActiveSession(token []byte, clientSessionId string) (bool, error) { +func IsActiveSession(uuid []byte, clientSessionId string) (bool, error) { var storedId string - err := handle.QueryRow("SELECT `clientSessionId` FROM sessions WHERE token = ?", token).Scan(&storedId) + err := handle.QueryRow("SELECT clientSessionId FROM activeClientSessions WHERE sessions.uuid = ?", uuid).Scan(&storedId) if err != nil { + if errors.Is(err, sql.ErrNoRows) { + return false, nil + } return false, err } if storedId == "" { - err = UpdateActiveSession(token, clientSessionId) + err = UpdateActiveSession(uuid, clientSessionId) if err != nil { return false, err } @@ -225,8 +230,8 @@ func IsActiveSession(token []byte, clientSessionId string) (bool, error) { return storedId == clientSessionId, nil } -func UpdateActiveSession(token []byte, clientSessionId string) error { - _, err := handle.Exec("UPDATE sessions SET clientSessionId = ? WHERE token = ?", clientSessionId, token) +func UpdateActiveSession(uuid []byte, clientSessionId string) error { + _, err := handle.Exec("REPLACE INTO activeClientSessions VALUES (?, ?)", uuid, clientSessionId) if err != nil { return err } diff --git a/db/db.go b/db/db.go index d4ddc88..7aa881c 100644 --- a/db/db.go +++ b/db/db.go @@ -175,7 +175,7 @@ func setupDb(tx *sql.Tx) error { // MIGRATION 001 `ALTER TABLE sessions DROP COLUMN IF EXISTS active`, - `ALTER TABLE sessions ADD COLUMN IF NOT EXISTS clientSessionId VARCHAR(32)`, + `CREATE TABLE IF NOT EXISTS activeClientSessions (uuid BINARY(16) NOT NULL PRIMARY KEY, clientSessionId VARCHAR(32) NOT NULL)`, } for _, q := range queries { From 834d1e62a003ff8382a304438a7396977605ae37 Mon Sep 17 00:00:00 2001 From: Up Date: Tue, 14 May 2024 14:33:53 +0200 Subject: [PATCH 47/47] add foreign key constraint on client session table --- api/account/logout.go | 3 ++- db/db.go | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/api/account/logout.go b/api/account/logout.go index 7bfdb94..774d884 100644 --- a/api/account/logout.go +++ b/api/account/logout.go @@ -19,6 +19,7 @@ package account import ( "database/sql" + "errors" "fmt" "github.com/pagefaultgames/rogueserver/db" @@ -28,7 +29,7 @@ import ( func Logout(token []byte) error { err := db.RemoveSessionFromToken(token) if err != nil { - if err == sql.ErrNoRows { + if errors.Is(err, sql.ErrNoRows) { return fmt.Errorf("token not found") } diff --git a/db/db.go b/db/db.go index 7aa881c..4ee1a71 100644 --- a/db/db.go +++ b/db/db.go @@ -175,7 +175,7 @@ func setupDb(tx *sql.Tx) error { // MIGRATION 001 `ALTER TABLE sessions DROP COLUMN IF EXISTS active`, - `CREATE TABLE IF NOT EXISTS activeClientSessions (uuid BINARY(16) NOT NULL PRIMARY KEY, clientSessionId VARCHAR(32) NOT NULL)`, + `CREATE TABLE IF NOT EXISTS activeClientSessions (uuid BINARY(16) NOT NULL PRIMARY KEY, clientSessionId VARCHAR(32) NOT NULL, FOREIGN KEY (uuid) REFERENCES accounts (uuid) ON DELETE CASCADE ON UPDATE CASCADE)`, } for _, q := range queries {