mirror of
https://github.com/Corfirean/coa-server-manager.git
synced 2026-11-18 19:25:56 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
277ebba847 | ||
|
|
9a0b815937 | ||
|
|
78b84e11c2 | ||
|
|
6aea9011f9 | ||
|
|
171d9a2bf8 | ||
|
|
0d6d8a0db8 | ||
|
|
3940506987 | ||
|
|
654b7cddd3 | ||
|
|
f8301d7394 | ||
|
|
cd3a963f70 | ||
|
|
6c771fae20 | ||
|
|
cfe0889a4f | ||
|
|
07ec22798f | ||
|
|
5d865fcaea | ||
|
|
a67d51804b | ||
|
|
7c096a4844 | ||
|
|
b90b377fc3 | ||
|
|
a02130f587 | ||
|
|
f4e36f21eb | ||
|
|
65c9945626 | ||
|
|
f13398bbd7 | ||
|
|
f05f94ba01 | ||
|
|
c39a7a0ac7 | ||
|
|
e8367354ef | ||
|
|
461fa035d0 | ||
|
|
3edc600f97 | ||
|
|
c3d87e1ff2 | ||
|
|
d2496603e7 | ||
|
|
2eea0e117c | ||
|
|
2e3fb24e1a | ||
|
|
146b1c50b9 | ||
|
|
c02c635463 | ||
|
|
58b5ddeb07 | ||
|
|
162bfd1e04 | ||
|
|
85963b0bf0 | ||
|
|
79d293e120 | ||
|
|
46ba3fa3dc | ||
|
|
beb3b03010 | ||
|
|
3da9628b79 | ||
|
|
e7113f3ceb | ||
|
|
50b48e8af5 | ||
|
|
c0c414f5a8 | ||
|
|
e889e0a789 | ||
|
|
d638bf3304 |
No files matched your search
@@ -0,0 +1,28 @@
|
||||
name: check
|
||||
on:
|
||||
push:
|
||||
branches: [master, 'release/**']
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
permissions:
|
||||
contents: read
|
||||
jobs:
|
||||
test:
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [windows-latest, ubuntu-latest]
|
||||
runs-on: ${{ matrix.os }}
|
||||
timeout-minutes: 40
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
- name: Linux build dependencies
|
||||
if: runner.os == 'Linux'
|
||||
run: sudo apt-get update && sudo apt-get install -y libwebkit2gtk-4.1-dev build-essential libxdo-dev libssl-dev librsvg2-dev libayatana-appindicator3-dev
|
||||
- run: npm ci
|
||||
- run: node tools/check-i18n.mjs
|
||||
- run: npm run build
|
||||
- run: cargo test --workspace --locked
|
||||
@@ -21,7 +21,7 @@ jobs:
|
||||
node-version: 22
|
||||
- run: npm ci
|
||||
- name: Tests
|
||||
run: cargo test --workspace
|
||||
run: cargo test --workspace -- --test-threads=1
|
||||
- name: Build, sign and publish
|
||||
uses: tauri-apps/tauri-action@v0
|
||||
env:
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# CoA Server Manager changelog
|
||||
|
||||
## 0.6.1 — 2026-10-04
|
||||
|
||||
- PLAY launches only the client with the selected realmlist; starting the local server remains a separate action.
|
||||
- Server multipliers accept decimals typed with a dot or comma. Talent and rested experience descriptions now explain their actual behavior.
|
||||
- Added database and file checks, and Repair with backups and signed package verification. Unresolved schema damage is reported instead of guessed repairs.
|
||||
- Fixed character database rebuilds retaining migration history that could skip required SQL. Applied migration hash changes are now rejected.
|
||||
- Added optional simultaneous CoA and Wildcard worlds on Windows, with separate processes, ports and status indicators.
|
||||
|
||||
## 0.6.0 — 2026-10-03
|
||||
|
||||
- Added Simplified Chinese for the interface and all server and bot settings.
|
||||
- The closed game client now follows the selected CoA or Wildcard realm. Play checks the saved realm before launching; existing settings are preserved and backed up.
|
||||
- Fixed GitHub reports opening Windows Explorer instead of the default browser. Long reports use the clipboard fallback.
|
||||
- Fixed configuration snapshots created in the same millisecond overwriting each other during restore.
|
||||
- Added experimental Linux startup: persistent state uses the XDG data folder, Tailscale detection supports Linux, and a Wayland rendering workaround respects existing user settings.
|
||||
- Added experimental start, stop and status controls for manually prepared Docker servers, with private database networking and a remote console bound to localhost.
|
||||
- Linux extraction restores executable permissions for ELF binaries and scripts, and paths retain case-sensitive filesystem semantics.
|
||||
|
||||
### Availability
|
||||
|
||||
This release ships the Windows installer and signed updater assets. Linux support is a development preview, not a one-click installation flow. Docker installation/database setup, SQL operations and backups, updates, Wildcard realm profiles, and Wine/Proton client launching remain unfinished. Servers must be prepared manually and use Linux binaries built with the packaged configuration layout.
|
||||
|
||||
Server shutdown and starting-zone scaling issues require separate server releases and are not fixed by updating the Manager alone.
|
||||
Generated
+448
-3
@@ -56,6 +56,137 @@ dependencies = [
|
||||
"derive_arbitrary",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-broadcast"
|
||||
version = "0.7.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "435a87a52755b8f27fcf321ac4f04b2802e337c8c4872923137471ec39c37532"
|
||||
dependencies = [
|
||||
"event-listener",
|
||||
"event-listener-strategy",
|
||||
"futures-core",
|
||||
"pin-project-lite",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-channel"
|
||||
version = "2.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "924ed96dd52d1b75e9c1a3e6275715fd320f5f9439fb5a4a11fa51f4221158d2"
|
||||
dependencies = [
|
||||
"concurrent-queue",
|
||||
"event-listener-strategy",
|
||||
"futures-core",
|
||||
"pin-project-lite",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-executor"
|
||||
version = "1.14.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c96bf972d85afc50bf5ab8fe2d54d1586b4e0b46c97c50a0c9e71e2f7bcd812a"
|
||||
dependencies = [
|
||||
"async-task",
|
||||
"concurrent-queue",
|
||||
"fastrand",
|
||||
"futures-lite",
|
||||
"pin-project-lite",
|
||||
"slab",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-io"
|
||||
version = "2.6.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "456b8a8feb6f42d237746d4b3e9a178494627745c3c56c6ea55d92ba50d026fc"
|
||||
dependencies = [
|
||||
"autocfg",
|
||||
"cfg-if",
|
||||
"concurrent-queue",
|
||||
"futures-io",
|
||||
"futures-lite",
|
||||
"parking",
|
||||
"polling",
|
||||
"rustix",
|
||||
"slab",
|
||||
"windows-sys 0.61.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-lock"
|
||||
version = "3.4.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "290f7f2596bd5b78a9fec8088ccd89180d7f9f55b94b0576823bbbdc72ee8311"
|
||||
dependencies = [
|
||||
"event-listener",
|
||||
"event-listener-strategy",
|
||||
"pin-project-lite",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-process"
|
||||
version = "2.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "fc50921ec0055cdd8a16de48773bfeec5c972598674347252c0399676be7da75"
|
||||
dependencies = [
|
||||
"async-channel",
|
||||
"async-io",
|
||||
"async-lock",
|
||||
"async-signal",
|
||||
"async-task",
|
||||
"blocking",
|
||||
"cfg-if",
|
||||
"event-listener",
|
||||
"futures-lite",
|
||||
"rustix",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-recursion"
|
||||
version = "1.1.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3b43422f69d8ff38f95f1b2bb76517c91589a924d1559a0e935d7c8ce0274c11"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn 2.0.119",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-signal"
|
||||
version = "0.2.14"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "52b5aaafa020cf5053a01f2a60e8ff5dccf550f0f77ec54a4e47285ac2bab485"
|
||||
dependencies = [
|
||||
"async-io",
|
||||
"async-lock",
|
||||
"atomic-waker",
|
||||
"cfg-if",
|
||||
"futures-core",
|
||||
"futures-io",
|
||||
"rustix",
|
||||
"signal-hook-registry",
|
||||
"slab",
|
||||
"windows-sys 0.61.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-task"
|
||||
version = "4.7.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8b75356056920673b02621b35afd0f7dda9306d03c79a30f5c56c44cf256e3de"
|
||||
|
||||
[[package]]
|
||||
name = "async-trait"
|
||||
version = "0.1.92"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "82f6aeea286b8eb4dd3431a1be1b59d290ace00f5bfd8e2a159bc2a05e2c1667"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn 3.0.6",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "atk"
|
||||
version = "0.18.2"
|
||||
@@ -163,6 +294,19 @@ dependencies = [
|
||||
"objc2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "blocking"
|
||||
version = "1.7.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a70e4329df6cb94385eed412ec92375c3cdd8a6e502493d1229b6414e4036dfa"
|
||||
dependencies = [
|
||||
"async-channel",
|
||||
"async-task",
|
||||
"futures-io",
|
||||
"futures-lite",
|
||||
"piper",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "brotli"
|
||||
version = "9.0.0"
|
||||
@@ -347,7 +491,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "coa-core"
|
||||
version = "0.5.0"
|
||||
version = "0.6.5"
|
||||
dependencies = [
|
||||
"base64 0.22.1",
|
||||
"chrono",
|
||||
@@ -375,7 +519,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "coa-release"
|
||||
version = "0.5.0"
|
||||
version = "0.6.5"
|
||||
dependencies = [
|
||||
"chrono",
|
||||
"coa-core",
|
||||
@@ -384,7 +528,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "coa-server-manager"
|
||||
version = "0.5.0"
|
||||
version = "0.6.5"
|
||||
dependencies = [
|
||||
"coa-core",
|
||||
"serde",
|
||||
@@ -392,6 +536,7 @@ dependencies = [
|
||||
"tauri",
|
||||
"tauri-build",
|
||||
"tauri-plugin-dialog",
|
||||
"tauri-plugin-opener",
|
||||
"tauri-plugin-process",
|
||||
"tauri-plugin-updater",
|
||||
"tracing",
|
||||
@@ -407,6 +552,15 @@ dependencies = [
|
||||
"memchr",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "concurrent-queue"
|
||||
version = "2.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4ca0197aee26d1ae37445ee532fefce43251d24cc7c166799f4d46817f1d3973"
|
||||
dependencies = [
|
||||
"crossbeam-utils",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "const-oid"
|
||||
version = "0.9.6"
|
||||
@@ -872,6 +1026,33 @@ version = "1.2.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4ef6b89e5b37196644d8796de5268852ff179b44e96276cf4290264843743bb7"
|
||||
|
||||
[[package]]
|
||||
name = "endi"
|
||||
version = "1.1.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "66b7e2430c6dff6a955451e2cfc438f09cea1965a9d6f87f7e3b90decc014099"
|
||||
|
||||
[[package]]
|
||||
name = "enumflags2"
|
||||
version = "0.7.12"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1027f7680c853e056ebcec683615fb6fbbc07dbaa13b4d5d9442b146ded4ecef"
|
||||
dependencies = [
|
||||
"enumflags2_derive",
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "enumflags2_derive"
|
||||
version = "0.7.12"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "67c78a4d8fdf9953a5c9d458f9efe940fd97a0cab0941c075a813ac594733827"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn 2.0.119",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "equivalent"
|
||||
version = "1.0.2"
|
||||
@@ -899,6 +1080,26 @@ dependencies = [
|
||||
"windows-sys 0.61.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "event-listener"
|
||||
version = "5.4.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5a23add41df1562121a9393cb065eab5146a1242410f23a644851e90cfd669d2"
|
||||
dependencies = [
|
||||
"parking",
|
||||
"pin-project-lite",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "event-listener-strategy"
|
||||
version = "0.5.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8be9f3dfaaffdae2972880079a491a1a8bb7cbed0b8dd7a347f668b4150a3b93"
|
||||
dependencies = [
|
||||
"event-listener",
|
||||
"pin-project-lite",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "fastrand"
|
||||
version = "2.5.0"
|
||||
@@ -1063,6 +1264,19 @@ version = "0.3.34"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "53c0fa8157de1303bfffdaa1cc2a673bfffb60102f76b0ef4441659124373fed"
|
||||
|
||||
[[package]]
|
||||
name = "futures-lite"
|
||||
version = "2.6.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f78e10609fe0e0b3f4157ffab1876319b5b0db102a2c60dc4626306dc46b44ad"
|
||||
dependencies = [
|
||||
"fastrand",
|
||||
"futures-core",
|
||||
"futures-io",
|
||||
"parking",
|
||||
"pin-project-lite",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "futures-macro"
|
||||
version = "0.3.34"
|
||||
@@ -1417,6 +1631,12 @@ version = "0.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
|
||||
|
||||
[[package]]
|
||||
name = "hermit-abi"
|
||||
version = "0.5.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e17592d60ebacc7d5e169f4663c5f84f9161cc90328abcfe8456f41e4dfcb284"
|
||||
|
||||
[[package]]
|
||||
name = "hex"
|
||||
version = "0.4.3"
|
||||
@@ -1731,6 +1951,25 @@ version = "2.12.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "791930b43c0d5973160d90a8f3894509f2b273430f5c5c73b668636d0287c5c0"
|
||||
|
||||
[[package]]
|
||||
name = "is-docker"
|
||||
version = "0.2.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "928bae27f42bc99b60d9ac7334e3a21d10ad8f1835a4e12ec3ec0464765ed1b3"
|
||||
dependencies = [
|
||||
"once_cell",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "is-wsl"
|
||||
version = "0.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "173609498df190136aa7dea1a91db051746d339e18476eed5ca40521f02d7aa5"
|
||||
dependencies = [
|
||||
"is-docker",
|
||||
"once_cell",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "itoa"
|
||||
version = "1.0.18"
|
||||
@@ -2446,6 +2685,17 @@ version = "1.21.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
|
||||
|
||||
[[package]]
|
||||
name = "open"
|
||||
version = "5.4.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "aa576c76302b7b808eecc68061e67336c47833ef9d22caa74dda10fa9675eebc"
|
||||
dependencies = [
|
||||
"dunce",
|
||||
"is-wsl",
|
||||
"libc",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "openssl"
|
||||
version = "0.10.81"
|
||||
@@ -2495,6 +2745,16 @@ version = "0.2.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d"
|
||||
|
||||
[[package]]
|
||||
name = "ordered-stream"
|
||||
version = "0.2.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9aa2b01e1d916879f73a53d01d1d6cee68adbb31d6d9177a8cfce093cced1d50"
|
||||
dependencies = [
|
||||
"futures-core",
|
||||
"pin-project-lite",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "osakit"
|
||||
version = "0.3.1"
|
||||
@@ -2534,6 +2794,12 @@ dependencies = [
|
||||
"system-deps",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "parking"
|
||||
version = "2.2.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f38d5652c16fde515bb1ecef450ab0f6a219d619a7274976324d5e377f7dceba"
|
||||
|
||||
[[package]]
|
||||
name = "parking_lot"
|
||||
version = "0.12.5"
|
||||
@@ -2622,6 +2888,17 @@ version = "0.2.17"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd"
|
||||
|
||||
[[package]]
|
||||
name = "piper"
|
||||
version = "0.2.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c835479a4443ded371d6c535cbfd8d31ad92c5d23ae9770a61bc155e4992a3c1"
|
||||
dependencies = [
|
||||
"atomic-waker",
|
||||
"fastrand",
|
||||
"futures-io",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "pkcs8"
|
||||
version = "0.10.2"
|
||||
@@ -2677,6 +2954,20 @@ dependencies = [
|
||||
"miniz_oxide 0.8.9",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "polling"
|
||||
version = "3.11.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5d0e4f59085d47d8241c88ead0f274e8a0cb551f3625263c05eb8dd897c34218"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"concurrent-queue",
|
||||
"hermit-abi",
|
||||
"pin-project-lite",
|
||||
"rustix",
|
||||
"windows-sys 0.61.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "portable-atomic"
|
||||
version = "1.15.0"
|
||||
@@ -3451,6 +3742,16 @@ version = "2.0.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba"
|
||||
|
||||
[[package]]
|
||||
name = "signal-hook-registry"
|
||||
version = "1.4.8"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c4db69cba1110affc0e9f7bcd48bbf87b3f4fc7c61fc9155afd4c469eb3d6c1b"
|
||||
dependencies = [
|
||||
"errno",
|
||||
"libc",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "signature"
|
||||
version = "2.2.0"
|
||||
@@ -3946,6 +4247,28 @@ dependencies = [
|
||||
"url",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tauri-plugin-opener"
|
||||
version = "2.7.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d39404b2572927e0d3ed30a7ca226037f7508d22e79c96ee6ef0d42b6a4b3345"
|
||||
dependencies = [
|
||||
"dunce",
|
||||
"glob",
|
||||
"objc2-app-kit",
|
||||
"objc2-foundation",
|
||||
"open",
|
||||
"schemars 0.8.22",
|
||||
"serde",
|
||||
"serde_json",
|
||||
"tauri",
|
||||
"tauri-plugin",
|
||||
"thiserror 2.0.21",
|
||||
"url",
|
||||
"windows",
|
||||
"zbus",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tauri-plugin-process"
|
||||
version = "2.4.0"
|
||||
@@ -4476,6 +4799,17 @@ version = "1.20.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20"
|
||||
|
||||
[[package]]
|
||||
name = "uds_windows"
|
||||
version = "1.2.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f2f6fb2847f6742cd76af783a2a2c49e9375d0a111c7bef6f71cd9e738c72d6e"
|
||||
dependencies = [
|
||||
"memoffset",
|
||||
"tempfile",
|
||||
"windows-sys 0.61.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "unicode-ident"
|
||||
version = "1.0.26"
|
||||
@@ -5343,6 +5677,76 @@ dependencies = [
|
||||
"synstructure",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "zbus"
|
||||
version = "5.19.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5db4be7c075cb421e4b7ee645541604239bd243ba7c357511f4ff3a74b555907"
|
||||
dependencies = [
|
||||
"async-broadcast",
|
||||
"async-executor",
|
||||
"async-io",
|
||||
"async-lock",
|
||||
"async-process",
|
||||
"async-recursion",
|
||||
"async-task",
|
||||
"async-trait",
|
||||
"blocking",
|
||||
"enumflags2",
|
||||
"event-listener",
|
||||
"futures-core",
|
||||
"futures-lite",
|
||||
"hex",
|
||||
"libc",
|
||||
"ordered-stream",
|
||||
"rustix",
|
||||
"serde",
|
||||
"serde_repr",
|
||||
"tracing",
|
||||
"uds_windows",
|
||||
"uuid",
|
||||
"windows-sys 0.61.2",
|
||||
"winnow 1.0.4",
|
||||
"zbus_macros",
|
||||
"zbus_names",
|
||||
"zvariant",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "zbus_macros"
|
||||
version = "5.19.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2990635d09ade6df1868f72f8cac69a876a90981e8bd3c40b1be413f8dc88f40"
|
||||
dependencies = [
|
||||
"proc-macro-crate 3.5.0",
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn 3.0.6",
|
||||
"zbus_names",
|
||||
"zvariant",
|
||||
"zvariant_utils",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "zbus_names"
|
||||
version = "4.3.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d8bf88b4a3ff53e883001e0e0115b297a9d53c31b9c1edd2bfdd853e3428624e"
|
||||
dependencies = [
|
||||
"serde",
|
||||
"winnow 1.0.4",
|
||||
"zvariant",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "zcheapstr"
|
||||
version = "1.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d1afec51604565183aeb5c54c20aeab286120d4e4460f7f76e3e8bb8c0d99473"
|
||||
dependencies = [
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "zerofrom"
|
||||
version = "0.1.8"
|
||||
@@ -5483,3 +5887,44 @@ dependencies = [
|
||||
"cc",
|
||||
"pkg-config",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "zvariant"
|
||||
version = "5.15.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c1d34c27cc6cdd1f458427519dd6b8612f7b7e3f7b9a0b2355d041dda9869147"
|
||||
dependencies = [
|
||||
"endi",
|
||||
"enumflags2",
|
||||
"serde",
|
||||
"winnow 1.0.4",
|
||||
"zcheapstr",
|
||||
"zvariant_derive",
|
||||
"zvariant_utils",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "zvariant_derive"
|
||||
version = "5.15.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "864155e69b4352db0c7f374917bf45d1e0c8d17659c8b3dbf9795f3673f8c497"
|
||||
dependencies = [
|
||||
"proc-macro-crate 3.5.0",
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn 3.0.6",
|
||||
"zvariant_utils",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "zvariant_utils"
|
||||
version = "4.2.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "bad0294361a320b694a328460dc73add56c306150f5cb6bfafc44446120008a3"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"serde",
|
||||
"syn 3.0.6",
|
||||
"winnow 1.0.4",
|
||||
]
|
||||
+1
-1
@@ -3,7 +3,7 @@ resolver = "2"
|
||||
members = ["crates/coa-core", "crates/coa-release", "src-tauri"]
|
||||
|
||||
[workspace.package]
|
||||
version = "0.5.0"
|
||||
version = "0.6.5"
|
||||
edition = "2021"
|
||||
license = "AGPL-3.0-only"
|
||||
|
||||
|
||||
@@ -0,0 +1,104 @@
|
||||
# Urgent update hotfix
|
||||
|
||||
Deadline: 2026-10-06. This checkout starts at the exact v0.6.4 tag, commit
|
||||
6c771fa, and excludes the ongoing isolated-trial/recovery redesign.
|
||||
|
||||
The client accepts checksum compatibility only from a verified signed manifest and only
|
||||
for an Applied migration. It never updates the historical checksum, reruns historical
|
||||
SQL, or excuses a Running/Failed ledger row. A server package must explicitly list the
|
||||
verified published variants and append corrections under new migration IDs.
|
||||
|
||||
Current local evidence: the locked workspace tests passed, including 252 core tests
|
||||
run serially. Six frontend logic tests and the frontend production build passed.
|
||||
The hotfix runtime was tested against the exact signed candidate manifest on the marked
|
||||
CoA/Wildcard fixture. Both published repair checksums were accepted independently in
|
||||
both worlds, with zero migration executions, unchanged historical checksums, and unchanged
|
||||
account, character and inventory counts. The original ledger rows were restored after
|
||||
the test, and all fixture processes were stopped. A real Running or Failed repair row in
|
||||
either world was rejected before staging or creating a transaction, with unchanged world
|
||||
executable and installation metadata. Tests use independent hotfix metadata so experimental
|
||||
transaction formats are not confused with the 0.6.4 upgrade path. Windows journal writes also use flushed
|
||||
atomic replacement with long-path support. Changelog validation passed.
|
||||
|
||||
Additional guards implemented:
|
||||
|
||||
- Read migration history without creating its ledger before downloading or replacing files.
|
||||
- Reject missing journals, invalid identities, paths, hashes and inconsistent operations.
|
||||
Durable completed-cleanup markers distinguish interrupted pruning from a lost journal.
|
||||
- Preserve all backups while an update is unfinished or its journal is damaged.
|
||||
- Verify saved-file hashes and the complete database/configuration recovery point before
|
||||
stopping services or changing files/databases. New snapshots include configuration hashes;
|
||||
update journals bind their backup metadata to a hash.
|
||||
- Surface state-reading errors in Settings and disable applying until the disk state is
|
||||
successfully read. Checking again refreshes that state.
|
||||
- Verify every extracted SQL artifact before taking the update snapshot or replacing
|
||||
server files; missing files, invalid IDs, duplicate migrations and checksum disagreements
|
||||
reject the update early. SQL application repeats the integrity check immediately before use.
|
||||
- Count unapplied migrations in the active and secondary realms, counting shared auth once.
|
||||
Matching versions and files do not hide remaining database work. Preview reads history
|
||||
under the installation lock; a stopped database is temporarily started for inspection
|
||||
and stopped again when no game services are running.
|
||||
- Reread the disk state after every update/recovery attempt, including failed attempts and
|
||||
background updates. Unfinished or unreadable state blocks another application in the UI.
|
||||
- Acquire the installation lock before checking and deleting a backup.
|
||||
|
||||
Latest real-runtime test used the independently copied, doubly marked fixture
|
||||
`C:\games\coa-schema-fixture-chaos-20261005-v1` and signed candidate `0.261005.24`, manifest SHA-256
|
||||
`1284b1273815209c9621b6d173a2211bae316f33462ccbe8b578e53b8d26fb5b`.
|
||||
All 1748 SQL artifacts passed verification after authenticated archive extraction.
|
||||
Removing one repair record separately in CoA and Wildcard increased the pending count
|
||||
by exactly one; restoring its original record restored the original count. No migrations
|
||||
were executed, player counts were preserved and fixture services were stopped afterward.
|
||||
The source checkout remains uncommitted; these results are not an installer acceptance report.
|
||||
|
||||
Additional acceptance on 2026-10-06: a new independent installation/database copy at
|
||||
`C:\games\coa-schema-fixture-chaos-064-transition-20261006` received the authenticated
|
||||
published `0.261005.22` program files, original CRLF repair checksum, and a deliberately
|
||||
missing Wildcard table in both realms. The production hotfix update pipeline committed
|
||||
signed candidate `0.261005.24`, repaired both realms, passed schema checks and actual
|
||||
bundled-Python server startup, and preserved the selected account, character, item and
|
||||
inventory fields byte-for-byte. The fixture was stopped afterward. The harness explicitly
|
||||
instruments the launcher to prevent relay submissions and bind to localhost; this is not
|
||||
proof of packaged UI behavior or operating-system network containment.
|
||||
|
||||
Local installer `C:\games\source\manager-065-local-installer-20261006\CoA Server Manager_0.6.5_x64-setup.exe`
|
||||
has SHA-256 `520ee0391d923b92da0a20591e30006c048cdb60156275d7a829918bf1b77491`.
|
||||
Its updater signature and the published 0.6.4 installer's signature passed independent
|
||||
verification with the configured updater public key. Both executables extracted from
|
||||
their exact NSIS packages started, created responsive windows, and were stopped using
|
||||
an independent application/WebView profile. No installer was executed over a user's
|
||||
installation, and no UI update operation was exercised.
|
||||
|
||||
Legacy limitation: old 0.6.4 transaction copies and configuration snapshots without recorded
|
||||
hashes can be checked for presence and declared database hashes, but their original file
|
||||
contents cannot be authenticated retroactively. Missing copies block restoration. This
|
||||
hotfix does not claim that old unchecksummed copies received full integrity verification.
|
||||
|
||||
Remaining release requirements: reproduce the existing-user failures through the published
|
||||
0.6.4 interface, verify legacy unfinished transaction handling on real-runtime fixtures,
|
||||
and execute the exact installer over 0.6.4 in an isolated Windows environment with UI
|
||||
state/settings/server-list verification. Windows native UI automation is unavailable in
|
||||
this session. Packaged startup and signature checks do not satisfy that installer gate.
|
||||
No public release has been made.
|
||||
|
||||
The user subsequently exercised the packaged UI: candidate 0.261005.24 committed and
|
||||
both CoA and Wildcard were shown running. Repeat-check/restart acceptance is still pending.
|
||||
The screenshots exposed an older published package being offered after the local candidate
|
||||
was installed. Follow-up changes reject older packages before preview/database inspection
|
||||
and application and clear a cached offer after a failed recheck. All 253 core tests and
|
||||
seven frontend tests passed. The earlier installer hash above does not include this follow-up;
|
||||
a separately recorded revision is required. Native UI control was subsequently initialized
|
||||
through the deferred node_repl tool, then the user stopped automation with Escape and
|
||||
performed the UI check manually.
|
||||
|
||||
Another user repeat-check exposed the already installed launcher being offered again.
|
||||
The preview now verifies canonical launcher bytes against the current signed package,
|
||||
caches those bytes by SHA-256, and compares only recognized Manager transformations.
|
||||
The actual disposable fixture's repeat preview passed with all 104 files skipped and
|
||||
zero pending SQL. User edits, recorded custom content, and a package with different
|
||||
launcher bytes are not mistaken for that integration. All 254 core tests passed;
|
||||
the strengthened regression test and seven frontend tests also passed. The first
|
||||
preview of a managed launcher may download/extract its authenticated package to build
|
||||
the optional canonical cache. Earlier installer revisions do not include this fix.
|
||||
|
||||
Do not recommend deleting an installation or replacing its player databases.
|
||||
@@ -21,6 +21,8 @@ no console, no config files, no database tools. Tauri 2 + Rust + React.
|
||||
* **CoA / Wildcard realms.** Choose the active realm on Overview. A server build with Wildcard support is required;
|
||||
the first switch copies world data and creates an empty character database. Accounts are shared, characters and
|
||||
module settings are separate, and only one world runs. Switching a running server saves characters and restarts it.
|
||||
The closed client's saved realm follows this selection and is checked again before PLAY. If the client is open,
|
||||
the change is applied on the next launch through the Manager.
|
||||
CoA companions are unavailable on Wildcard; other optional modules are experimental. Backups include both realms,
|
||||
and database updates apply to both.
|
||||
See [realm profiles and validation](docs/WILDCARD.md).
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: players
|
||||
title: The game client follows the realm selected in the Manager
|
||||
---
|
||||
Switching realms updates the closed client's saved realm automatically. Play checks it again before launch, preventing login attempts to the previous realm. If the client is running, the update waits until the next launch.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Configuration snapshots no longer overwrite each other
|
||||
---
|
||||
Snapshots created close together keep separate copies, so restoring a configuration reliably restores the selected snapshot.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Experimental Linux startup and Docker server controls
|
||||
---
|
||||
The Manager can start on Linux and control manually prepared Docker servers. One-click installation, updates, backups and Wine or Proton client launch are not available yet.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Problem reports open in the default browser
|
||||
---
|
||||
GitHub reports open in the default browser instead of Windows Explorer. Long reports use the clipboard fallback.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Simplified Chinese is available in the Manager
|
||||
---
|
||||
The interface and server and bot settings are now available in Simplified Chinese. Choose Simplified Chinese in the language selector.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Choose which item types the auction bot sells
|
||||
---
|
||||
Switch 15 item categories on or off and adjust listing frequency by quality. Labels and descriptions are translated into all six languages. Changes affect new listings; existing auctions remain.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Server multipliers now accept decimals typed with a dot or comma
|
||||
---
|
||||
Talent settings now explain that the multiplier does not affect CoA talents. The rested experience setting now correctly describes bonus accumulation.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Play launches only the game client without starting your local server
|
||||
---
|
||||
Use the left button to start the server and PLAY to launch the client with your selected realmlist, including connections to other servers.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: Module settings now offer translated controls and an enemy damage slider
|
||||
---
|
||||
Configure scaling, auctions and enchantments with translated controls. Module switches no longer appear twice. Modules without settings hide their settings button; short lists need no search. New server builds support dungeon and raid damage from 25% to 200%.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Failed server updates restore databases and files together
|
||||
---
|
||||
Updates save a full backup and recover databases and files together. Interrupted SQL is not replayed. Checks cover Wildcard tables and every supported race/class pair, including existing characters. Unfinished updates block startup until recovered.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Check database structure and repair server files with a safety backup
|
||||
---
|
||||
Settings can check both realm databases and restore official files plus pending SQL. Installation and updates check character-save columns. Clean packages no longer keep old character migration records when rebuilding their database.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Configure partial dungeon parties and open-world life steal in module settings
|
||||
---
|
||||
Choose whether Dungeon Finder enters with the current party and enable open-world life steal with a healing percentage from 0 to 100. Available on server builds that support these options.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Start CoA and Wildcard together from Settings
|
||||
---
|
||||
Both worlds can run on separate ports with their own characters, settings and logs, sharing accounts. Stop saves both worlds before shutting down the shared database.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Configure SQUID Playerbots and prevent conflicting bot systems
|
||||
---
|
||||
The Bots tab shows translated settings for the active bot system. Bot module cards keep enable switches without duplicate settings. Enable one bot system at a time; the Manager checks manual config changes before starting the server. Recovery points also include the SQUID database when installed.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: players
|
||||
title: Download and update the game client without installing a server
|
||||
---
|
||||
Choose to host a server or connect to someone else's. Players joining a friend can download, update and launch the client, save the host's address and use the Manager without installing a local server.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Imported SquidBots servers warn before replacing their original binary
|
||||
---
|
||||
Imports explain that the original launcher and updater check the server binary hash. Updating that binary requires an explicit choice to keep or replace it.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: players
|
||||
title: Start your installed server or client without downloading an available update
|
||||
---
|
||||
Choose to update later and keep playing with your installed version. Interrupted server updates still require recovery before startup.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Finish a server update that was blocked by a startup failure
|
||||
---
|
||||
The Manager repairs the launcher import path and lets you retry startup for an already applied update. Successful validation finishes the update without replaying SQL or restoring old databases. Failure details are preserved and rollback remains available.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: SquidBots settings follow the options shipped by the module
|
||||
---
|
||||
New settings use the module's descriptions, groups, defaults and value limits while retaining existing translations. Unknown formats or invalid fields use built-in controls so the settings page remains available.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: SquidBots shows its bundled release and includes it in problem reports
|
||||
---
|
||||
The Bots and Modules pages and problem reports include the release identifiers. Imported repacks use their recorded bot revision; empty tags are hidden. The settings file's source commit is not presented as the build revision.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Server updates accept verified published migration variants without rerunning them
|
||||
---
|
||||
Signed updates can recognise known published checksums without changing your migration history. Interrupted or failed SQL still requires recovery before retrying.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Server updates replace older launchers adapted by the Manager for Wildcard
|
||||
---
|
||||
Updates recognize the Manager’s own realm and import adjustments even when older metadata still records the original launcher. New server binaries receive their matching launcher; genuine custom edits still require your decision.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Server packages must include a complete database schema check
|
||||
---
|
||||
Release tools generate the expected database structure on an isolated copy of the signed base, verify all archive files and refuse packages without the schema check. Corrective SQL can restore missing Wildcard tables without replaying old updates.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Older server packages cannot replace a newer installation
|
||||
---
|
||||
Update checks stop offering stale packages after an update. To undo an update, use its recovery point instead of applying an older server package.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Checking again no longer offers an already installed launcher update
|
||||
---
|
||||
The Manager recognizes its own launcher integration while still detecting user edits and changes in newer signed packages.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Large SQUID database imports have more time to finish on first startup
|
||||
---
|
||||
The Manager allows up to 45 minutes when SQUID Playerbots is enabled, covering its initial database import and bot creation. Ordinary server startup and shutdown keep their existing deadlines.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Update history conflicts are detected before server files change
|
||||
---
|
||||
Damaged update records block changes and remain visible. Recovery checks saved copies before restoring, and unfinished updates protect backups from deletion and cleanup.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Pending database updates remain visible when the server version matches
|
||||
---
|
||||
SQL files are checked before replacing server files. Update and recovery attempts refresh their saved status, including errors. Backup deletion cannot race with an update.
|
||||
@@ -24,14 +24,14 @@ num-bigint = "0.4"
|
||||
zip = { version = "2", default-features = false, features = ["deflate"] }
|
||||
sha1 = "0.10"
|
||||
tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt", "std"] }
|
||||
tempfile = "3"
|
||||
|
||||
[dev-dependencies]
|
||||
tempfile = "3"
|
||||
rand_core = { version = "0.6", features = ["getrandom"] }
|
||||
ed25519-dalek = { version = "2", features = ["rand_core"] }
|
||||
|
||||
[target.'cfg(windows)'.dependencies]
|
||||
windows-sys = { version = "0.60", features = ["Win32_Foundation", "Win32_System_Threading", "Win32_System_SystemInformation", "Win32_System_Diagnostics_ToolHelp", "Win32_NetworkManagement_IpHelper", "Win32_Networking_WinSock"] }
|
||||
windows-sys = { version = "0.60", features = ["Win32_Foundation", "Win32_Storage_FileSystem", "Win32_System_Threading", "Win32_System_SystemInformation", "Win32_System_Diagnostics_ToolHelp", "Win32_NetworkManagement_IpHelper", "Win32_Networking_WinSock"] }
|
||||
|
||||
[features]
|
||||
testkit = []
|
||||
@@ -0,0 +1,38 @@
|
||||
use std::{fs, path::PathBuf};
|
||||
use coa_core::{manifest::{Kind, Manifest}, package::{self, BuildOptions}, pkgsource::{self, Source}, release, signing, Result};
|
||||
|
||||
fn main() -> Result<()> {
|
||||
let args: Vec<String> = std::env::args().skip(1).collect();
|
||||
let source = Source::Dir(args[1].clone().into());
|
||||
let (previous, _) = pkgsource::fetch_manifest(&source, signing::EMBEDDED_PUBLIC_KEY)?;
|
||||
let tree = PathBuf::from(&args[2]);
|
||||
if args[0] == "extract" {
|
||||
assert!(!tree.exists(), "Use a new release tree");
|
||||
package::extract(&PathBuf::from(&args[1]), &previous, &tree, &|_, _| {})?;
|
||||
println!("Verified and extracted {}: {} historical migrations", previous.version, previous.migrations.len());
|
||||
return Ok(());
|
||||
}
|
||||
assert_eq!(args[0], "pack");
|
||||
let out = PathBuf::from(&args[3]);
|
||||
assert!(!out.exists(), "Release addresses must be immutable");
|
||||
for migration in &previous.migrations {
|
||||
let entry = previous.files.iter().find(|file| file.path.starts_with("_migrations/") && file.sha256 == migration.sha256).expect("Historical SQL entry");
|
||||
assert_eq!(coa_core::fsx::sha256_file(&tree.join(&entry.path))?, entry.sha256, "Historical SQL changed: {}", migration.id);
|
||||
}
|
||||
let mut manifest = package::build(&tree, &out, &BuildOptions {
|
||||
kind: Kind::Update, version: args[4].clone(), core_commit: Some(args[5].clone()),
|
||||
bots_commit: previous.bots.and_then(|revision| revision.commit),
|
||||
built_at: chrono::Utc::now().to_rfc3339(), part_size: package::DEFAULT_PART_SIZE,
|
||||
migrations: previous.migrations.clone(),
|
||||
}, &|line| println!("{line}"))?;
|
||||
manifest.min_manager_version = "0.6.5".into();
|
||||
manifest.validate()?;
|
||||
coa_core::fsx::atomic_write(&out.join("manifest.json"), &serde_json::to_vec_pretty(&manifest)?)?;
|
||||
let key_path = PathBuf::from(std::env::var("USERPROFILE").unwrap()).join(".coa-manager/signing/manifest-signing.key");
|
||||
release::sign_manifest(&out, &fs::read_to_string(key_path)?)?;
|
||||
coa_core::release_schema::verify_package(&out, signing::EMBEDDED_PUBLIC_KEY)?;
|
||||
let reread: Manifest = serde_json::from_slice(&fs::read(out.join("manifest.json"))?)?;
|
||||
assert_eq!(serde_json::to_value(reread.migrations)?, serde_json::to_value(previous.migrations)?);
|
||||
println!("PASS: signed {}; all historical migration bytes, checksums, aliases and order preserved", manifest.version);
|
||||
Ok(())
|
||||
}
|
||||
@@ -0,0 +1,70 @@
|
||||
use std::path::{Path, PathBuf};
|
||||
use coa_core::{backup, driver, fsx, Result};
|
||||
|
||||
fn set(root: &Path, filename: &str, values: &[(&str, &str)]) -> Result<()> {
|
||||
let path = root.join("Core/configs/modules").join(filename);
|
||||
let mut config = coa_core::config::parser::ConfFile::parse_bytes(&std::fs::read(&path)?)?;
|
||||
for (key, value) in values { config.set(key, value, &[]); }
|
||||
fsx::atomic_write(&path, config.to_text().as_bytes())
|
||||
}
|
||||
|
||||
fn ledgers(root: &Path) -> Result<Vec<String>> {
|
||||
backup::with_database(root, |db| ["acore_playerbots", "acore_world", "acore_characters"].into_iter()
|
||||
.map(|schema| db.query(&format!("SELECT path,sha256 FROM `{schema}`.coa_squid_migrations ORDER BY path;"))).collect())
|
||||
}
|
||||
|
||||
fn exercise(root: &Path) -> Result<()> {
|
||||
let meta = coa_core::registry::metadata_dir_for(root)?;
|
||||
let point = backup::create(root, &meta, backup::Kind::Full, backup::Trigger::Manual, Some("Disposable SQUID acceptance".into()), &|stage| println!("{stage}"))?;
|
||||
assert!(backup::verify(&meta, &point.id)?.ok);
|
||||
let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| -> Result<()> {
|
||||
backup::with_database(root, |db| db.query("DROP DATABASE IF EXISTS acore_playerbots;").map(|_| ()))?;
|
||||
assert!(driver::run(root, driver::Verb::StartAll)?.ok, "Disabled SQUID must start without its database");
|
||||
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
|
||||
coa_core::multiworld::set_enabled(root, false)?;
|
||||
coa_core::realms::select(root, coa_core::realms::Mode::Coa)?;
|
||||
set(root, "mod_coa_playerbots.conf", &[("CoaBots.Enable", "0")])?;
|
||||
set(root, "playerbots.conf", &[("AiPlayerbot.Enabled", "1"), ("AiPlayerbot.RandomBotAutologin", "0"), ("AiPlayerbot.MinRandomBots", "0"), ("AiPlayerbot.MaxRandomBots", "0"), ("AiPlayerbot.RandomBotGuildCount", "0"), ("AiPlayerbot.RandomBotAccountCount", "0")])?;
|
||||
let started = driver::run(root, driver::Verb::StartAll)?;
|
||||
assert!(started.ok, "Fresh SQUID startup: {}", coa_core::diag::redact(&started.output));
|
||||
let before = ledgers(root)?;
|
||||
assert!(!before[0].is_empty(), "Fresh SQUID history missing");
|
||||
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
|
||||
let started = driver::run(root, driver::Verb::StartAll)?;
|
||||
assert!(started.ok, "Repeated SQUID startup: {}", coa_core::diag::redact(&started.output));
|
||||
assert_eq!(ledgers(root)?, before, "SQUID replay changed its migration history");
|
||||
println!("PASS: SQUID-disabled dual startup without its database; fresh enabled SQUID import and startup; repeated startup preserves all three histories");
|
||||
Ok(())
|
||||
}));
|
||||
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
|
||||
restore(root, &meta, &point)?;
|
||||
result.map_err(|_| coa_core::Error::Invalid("SQUID acceptance failed; disposable databases and configurations restored".into()))?
|
||||
}
|
||||
|
||||
fn restore(root: &Path, meta: &Path, point: &backup::RecoveryPoint) -> Result<()> {
|
||||
assert!(backup::verify(meta, &point.id)?.ok);
|
||||
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
|
||||
coa_core::realms::select(root, point.realm)?;
|
||||
for component in point.components.iter().filter(|component| component.name != "configs") {
|
||||
backup::restore_database(root, meta, &point.id, &component.name)?;
|
||||
}
|
||||
backup::restore_configs(root, meta, &point.id)?;
|
||||
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
|
||||
println!("PASS: disposable SQUID acceptance databases and original realm configurations restored");
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn main() -> Result<()> {
|
||||
let root = PathBuf::from(std::env::args().nth(1).unwrap());
|
||||
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-chaos-064-transition-"));
|
||||
assert_eq!(std::fs::read(root.join(".transition-fixture"))?, b"disposable published-064 transition fixture");
|
||||
assert!(!root.join("Data").symlink_metadata()?.file_type().is_symlink());
|
||||
assert!(driver::run(&root, driver::Verb::StopAll)?.ok);
|
||||
if let Some(id) = std::env::args().nth(2) {
|
||||
let meta = coa_core::registry::metadata_dir_for(&root)?;
|
||||
return restore(&root, &meta, &backup::get(&meta, &id)?);
|
||||
}
|
||||
let result = exercise(&root);
|
||||
assert!(driver::run(&root, driver::Verb::StopAll)?.ok);
|
||||
result
|
||||
}
|
||||
@@ -0,0 +1,54 @@
|
||||
use std::{collections::BTreeMap, path::PathBuf};
|
||||
use coa_core::{backup, driver, registry::MetaDir, update::{self, RepackEnv}, Result};
|
||||
|
||||
fn players(db: &coa_core::db::Db) -> Result<String> {
|
||||
db.query("SELECT CONCAT(id,':',username,':',HEX(salt),':',HEX(verifier)) FROM acore_auth.account WHERE id=900001; SELECT CONCAT(guid,':',account,':',name,':',level,':',money) FROM acore_characters.characters WHERE guid=900001; SELECT CONCAT(guid,':',itemEntry,':',owner_guid,':',enchantments) FROM acore_characters.item_instance WHERE guid=900001; SELECT CONCAT(guid,':',bag,':',slot,':',item) FROM acore_characters.character_inventory WHERE guid=900001;")
|
||||
}
|
||||
|
||||
fn exercise(root: &std::path::Path, package: &str) -> Result<()> {
|
||||
let meta_dir = coa_core::registry::metadata_dir_for(root)?;
|
||||
let (_, meta) = MetaDir::open(&meta_dir)?;
|
||||
let expected = backup::with_database(root, |db| [coa_core::realms::Mode::Coa, coa_core::realms::Mode::Wildcard].into_iter().map(|mode| players(&db.clone().for_realm(mode))).collect::<Result<Vec<_>>>())?;
|
||||
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
|
||||
let source = coa_core::pkgsource::Source::Dir(package.into());
|
||||
let preview = update::preview(root, &meta, &source, coa_core::signing::EMBEDDED_PUBLIC_KEY, &BTreeMap::new())?;
|
||||
assert_eq!(preview.pending_migrations, 0, "Historical SQL must not replay");
|
||||
assert!(!preview.items.iter().any(|item| item.action == update::Action::Conflict), "Unresolved candidate files: {:?}", preview.items);
|
||||
let environment = RepackEnv { root, meta_dir: &meta_dir };
|
||||
let outcome = update::apply(&update::Params {
|
||||
root, meta_dir: &meta_dir, source, trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY,
|
||||
resolutions: BTreeMap::new(), cancel: Default::default(), env: &environment, fail_after_ops: None,
|
||||
}, &|stage, progress| println!("{progress}% {stage}"))?;
|
||||
assert_eq!(outcome.txn.state, update::State::Committed, "{:?}", outcome.txn);
|
||||
backup::with_database(root, |db| {
|
||||
for (index, mode) in [coa_core::realms::Mode::Coa, coa_core::realms::Mode::Wildcard].into_iter().enumerate() {
|
||||
let realm = db.clone().for_realm(mode);
|
||||
assert_eq!(players(&realm)?, expected[index], "Player data changed in {mode:?}");
|
||||
let problems = coa_core::schema_check::check(&realm, root)?;
|
||||
assert!(problems.is_empty(), "{problems:?}");
|
||||
}
|
||||
Ok(())
|
||||
})?;
|
||||
let release = coa_core::squid::release(root).expect("SQUID release metadata");
|
||||
println!("SQUID metadata: {release:?}");
|
||||
assert_eq!(coa_core::squid::fields(root)?.len(), 40);
|
||||
let (_, installed) = MetaDir::open(&meta_dir)?;
|
||||
let repeated = update::preview(root, &installed, &coa_core::pkgsource::Source::Dir(package.into()), coa_core::signing::EMBEDDED_PUBLIC_KEY, &BTreeMap::new())?;
|
||||
assert_eq!(repeated.pending_migrations, 0);
|
||||
assert!(repeated.items.iter().all(|item| item.action == update::Action::Skip), "{:?}", repeated.items);
|
||||
println!("PASS: coordinated update committed, both realms started, player fields preserved, historical SQL skipped, repeated preview clean");
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn main() -> Result<()> {
|
||||
let args: Vec<String> = std::env::args().skip(1).collect();
|
||||
let root = PathBuf::from(&args[0]);
|
||||
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-chaos-064-transition-"));
|
||||
assert_eq!(std::fs::read(root.join(".transition-fixture"))?, b"disposable published-064 transition fixture");
|
||||
assert_eq!(std::fs::read(root.join(".release-schema-fixture"))?, b"disposable release-schema fixture");
|
||||
assert!(!root.join("Data").symlink_metadata()?.file_type().is_symlink());
|
||||
assert!(driver::run(&root, driver::Verb::StopAll)?.ok);
|
||||
let outcome = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| exercise(&root, &args[1])));
|
||||
assert!(driver::run(&root, driver::Verb::StopAll)?.ok, "Fixture shutdown failed");
|
||||
outcome.map_err(|_| coa_core::Error::Invalid("Disposable coordinated acceptance failed; stopped services and retained recovery copies".into()))?
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
//! Verify published checksum compatibility on a disposable real database, without running SQL migrations.
|
||||
use std::{path::{Path, PathBuf}, sync::atomic::{AtomicUsize, Ordering}};
|
||||
use coa_core::{backup, db::Db, migrations::{self, LedgerRow, Status, Store}, pkgsource::{self, Source}, Result};
|
||||
|
||||
struct Observed<'a> { db: &'a Db, executions: AtomicUsize }
|
||||
impl Store for Observed<'_> {
|
||||
fn load(&self) -> Result<Vec<LedgerRow>> { self.db.load() }
|
||||
fn put(&self, row: &LedgerRow) -> Result<()> { self.db.put(row) }
|
||||
fn run_file(&self, _: &str, _: &Path) -> Result<()> {
|
||||
self.executions.fetch_add(1, Ordering::SeqCst);
|
||||
panic!("Historical SQL must never be replayed");
|
||||
}
|
||||
}
|
||||
|
||||
fn main() -> Result<()> {
|
||||
let args: Vec<_> = std::env::args().skip(1).collect();
|
||||
let root = PathBuf::from(&args[0]);
|
||||
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-chaos-"));
|
||||
assert_eq!(std::fs::read(root.join(".coa-chaos-fixture"))?, b"disposable update chaos fixture");
|
||||
assert_eq!(std::fs::read(root.join(".release-schema-fixture"))?, b"disposable release-schema fixture");
|
||||
let source = Source::Dir(PathBuf::from(&args[1]));
|
||||
let package = pkgsource::fetch_manifest(&source, coa_core::signing::EMBEDDED_PUBLIC_KEY)?.0;
|
||||
let staging = tempfile::tempdir()?;
|
||||
let parts = pkgsource::fetch_parts(&source, &package, &staging.path().join("download"), &Default::default(), &|_, _| {})?;
|
||||
coa_core::package::extract(&parts, &package, &staging.path().join("tree"), &|_, _| {})?;
|
||||
migrations::verify_files(&package.migrations, &staging.path().join("tree/_migrations"))?;
|
||||
println!("PASS: all {} signed-package SQL artifacts verified before any database mutation", package.migrations.len());
|
||||
let migration = package.migrations.iter().find(|m| m.id == "manager_repair__20261005_missing_wildcard_tables").unwrap();
|
||||
let hashes = ["c1d8dbf2271234283a48a39e4b4aea1106b83b70581f1e3c4aa9fff438e8e4d2", "9e4a36245c3f83255415c122c01f08ceb3e3b83898d3d427ac4e2fbcf61e9638"];
|
||||
for hash in hashes { assert!(migration.sha256 == hash || migration.compatible_sha256.iter().any(|h| h == hash)); }
|
||||
let fixture_meta = coa_core::registry::metadata_dir_for(&root)?;
|
||||
let test_meta = tempfile::tempdir()?;
|
||||
coa_core::fsx::atomic_write(&test_meta.path().join("install.json"), &std::fs::read(fixture_meta.join("install.json"))?)?;
|
||||
coa_core::registry::MetaDir::open(test_meta.path())?;
|
||||
std::fs::create_dir_all(test_meta.path().join("updates"))?;
|
||||
let result = backup::with_database(&root, |db| {
|
||||
let mut modes = vec![coa_core::realms::Mode::Coa];
|
||||
if coa_core::realms::state(&root)?.wildcard_created { modes.push(coa_core::realms::Mode::Wildcard); }
|
||||
for mode in modes {
|
||||
let db = db.clone().for_realm(mode);
|
||||
let saved = db.load()?.into_iter().find(|row| row.id == migration.id && row.db == migration.db).expect("Published repair must already be applied");
|
||||
assert_eq!(saved.status, Status::Applied);
|
||||
let counts = db.query("SELECT CONCAT((SELECT COUNT(*) FROM acore_characters.characters),':',(SELECT COUNT(*) FROM acore_characters.item_instance),':',(SELECT COUNT(*) FROM acore_auth.account));")?;
|
||||
let check = || -> Result<()> {
|
||||
for hash in hashes {
|
||||
db.put(&LedgerRow { sha256: hash.into(), ..saved.clone() })?;
|
||||
let observed = Observed { db: &db, executions: AtomicUsize::new(0) };
|
||||
migrations::preflight(&db, std::slice::from_ref(migration))?;
|
||||
let report = migrations::apply_pending(&observed, std::slice::from_ref(migration), &root.join(".unused-hotfix-sql"), &|| panic!("Already applied SQL needs no snapshot"))?;
|
||||
assert!(report.applied.is_empty());
|
||||
assert_eq!(observed.executions.load(Ordering::SeqCst), 0);
|
||||
assert_eq!(db.load()?.into_iter().find(|r| r.id == migration.id && r.db == migration.db).unwrap().sha256, hash);
|
||||
}
|
||||
let meta = test_meta.path();
|
||||
let file_hash = coa_core::fsx::sha256_file(&root.join("Core/worldserver.exe"))?;
|
||||
let install_hash = coa_core::fsx::sha256_file(&meta.join("install.json"))?;
|
||||
let transaction_count = std::fs::read_dir(meta.join("updates"))?.count();
|
||||
for status in [Status::Running, Status::Failed] {
|
||||
db.put(&LedgerRow { status, ..saved.clone() })?;
|
||||
let env = coa_core::update::RepackEnv { root: &root, meta_dir: meta };
|
||||
let rejected = coa_core::update::apply(&coa_core::update::Params {
|
||||
root: &root, meta_dir: meta, source: Source::Dir(PathBuf::from(&args[1])),
|
||||
trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY, cancel: Default::default(),
|
||||
resolutions: Default::default(), env: &env, fail_after_ops: None,
|
||||
}, &|_, _| {});
|
||||
let message = rejected.unwrap_err().to_string();
|
||||
assert!(message.contains("partially applied"), "Unexpected rejection: {message}");
|
||||
assert_eq!(std::fs::read_dir(meta.join("updates"))?.count(), transaction_count);
|
||||
assert_eq!(coa_core::fsx::sha256_file(&root.join("Core/worldserver.exe"))?, file_hash);
|
||||
assert_eq!(coa_core::fsx::sha256_file(&meta.join("install.json"))?, install_hash);
|
||||
}
|
||||
db.put(&saved)?;
|
||||
let env = coa_core::update::RepackEnv { root: &root, meta_dir: meta };
|
||||
let pending_before = env.pending_migrations(&package)?;
|
||||
db.query("DELETE FROM acore_world.coa_manager_migrations WHERE db='characters' AND id='manager_repair__20261005_missing_wildcard_tables';")?;
|
||||
assert_eq!(env.pending_migrations(&package)?, pending_before + 1,
|
||||
"Missing history in either realm must remain visible even with identical server files");
|
||||
db.put(&saved)?;
|
||||
assert_eq!(env.pending_migrations(&package)?, pending_before);
|
||||
Ok(())
|
||||
};
|
||||
let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(check));
|
||||
db.put(&saved)?;
|
||||
result.map_err(|_| coa_core::Error::Invalid("History regression assertion failed; the injected ledger row was restored.".into()))??;
|
||||
assert_eq!(db.query("SELECT CONCAT((SELECT COUNT(*) FROM acore_characters.characters),':',(SELECT COUNT(*) FROM acore_characters.item_instance),':',(SELECT COUNT(*) FROM acore_auth.account));")?, counts);
|
||||
println!("PASS: {} published checksums; Running/Failed rejected before staging; missing migration counted; zero SQL replays; history and player counts preserved", mode.name());
|
||||
}
|
||||
Ok(())
|
||||
});
|
||||
assert!(coa_core::driver::run(&root, coa_core::driver::Verb::StopAll)?.ok);
|
||||
result?;
|
||||
Ok(())
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
//! Read-only update preview against the marked disposable acceptance fixture.
|
||||
use std::{collections::BTreeMap,path::PathBuf};
|
||||
fn main()->coa_core::Result<()> {
|
||||
let args:Vec<_>=std::env::args().skip(1).collect();
|
||||
let root=PathBuf::from(&args[0]);
|
||||
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-chaos-064-transition-"));
|
||||
assert_eq!(std::fs::read(root.join(".transition-fixture"))?,b"disposable published-064 transition fixture");
|
||||
let meta_dir=coa_core::registry::metadata_dir_for(&root)?;
|
||||
let (_,meta)=coa_core::registry::MetaDir::open(&meta_dir)?;
|
||||
let preview=coa_core::update::preview(&root,&meta,&coa_core::pkgsource::Source::Dir(args[1].clone().into()),coa_core::signing::EMBEDDED_PUBLIC_KEY,&BTreeMap::new())?;
|
||||
assert_eq!(preview.from_version.as_deref(),Some(preview.to_version.as_str()));
|
||||
assert_eq!(preview.pending_migrations,0);
|
||||
assert!(preview.items.iter().all(|item|item.action==coa_core::update::Action::Skip),"{:?}",preview.items.iter().filter(|item|item.action!=coa_core::update::Action::Skip).collect::<Vec<_>>());
|
||||
println!("PASS: real fixture repeated preview: {} files unchanged, zero pending SQL, no update offered",preview.items.len());
|
||||
Ok(())
|
||||
}
|
||||
@@ -0,0 +1,165 @@
|
||||
//! Real signed-package transition on an independent, explicitly marked disposable copy.
|
||||
//! The Env wrapper instruments only launcher isolation; migration/backup/update code is production code.
|
||||
use std::{collections::BTreeMap, path::{Path, PathBuf}};
|
||||
use coa_core::{backup, driver, fsx, migrations, pkgsource::{self, Source}, registry::{InstallMeta, MetaDir}, update::{self, Env, RepackEnv}, Result};
|
||||
|
||||
struct Offline<'a>(RepackEnv<'a>);
|
||||
impl Env for Offline<'_> {
|
||||
fn ensure_stopped(&self) -> Result<()> { self.0.ensure_stopped() }
|
||||
fn preflight(&self, m: &coa_core::manifest::Manifest) -> Result<()> { self.0.preflight(m) }
|
||||
fn verify_snapshot(&self, id: &str) -> Result<()> { self.0.verify_snapshot(id) }
|
||||
fn snapshot(&self) -> Result<String> { self.0.snapshot() }
|
||||
fn restore_snapshot(&self, id: &str) -> Result<()> { self.0.restore_snapshot(id) }
|
||||
fn migrate(&self, m: &coa_core::manifest::Manifest, p: &Path) -> Result<migrations::ApplyReport> { self.0.migrate(m,p) }
|
||||
fn validate(&self) -> Result<()> {
|
||||
let path=self.0.root.join("Scripts/manage.py");
|
||||
let source=std::fs::read_to_string(&path)?.replace("\r\n", "\n");
|
||||
// Explicit test instrumentation prevents relay transmissions and binds services locally.
|
||||
let guarded=source.replace("def spawn(name, command, cwd, log):\n", "def spawn(name, command, cwd, log):\n for filename in ('worldserver.conf', 'authserver.conf'):\n path = ROOT / 'Core/configs' / filename\n if path.exists():\n text = path.read_text(encoding='utf-8-sig')\n for key, value in (('BindIP', '\"127.0.0.1\"'), ('Ra.IP', '\"127.0.0.1\"'), ('SOAP.Enabled', '0')):\n text = re.sub(r'(?m)^\\s*' + re.escape(key) + r'\\s*=.*$', '', text)\n text += '\\n' + key + ' = ' + value + '\\n'\n path.write_text(text, encoding='utf-8')\n").replace("def relay_worker():\n", "def relay_worker():\n save_process('relay-ready', os.getpid())\n while not (STATE / 'stop-relay').exists():\n time.sleep(0.5)\n return\n");
|
||||
assert_ne!(source,guarded,"Fixture launcher isolation failed");
|
||||
fsx::atomic_write(&path,guarded.as_bytes())?;
|
||||
self.0.validate()
|
||||
}
|
||||
}
|
||||
fn players(db: &coa_core::db::Db) -> Result<String> {
|
||||
db.query("SELECT CONCAT(id,':',username,':',HEX(salt),':',HEX(verifier)) FROM acore_auth.account WHERE id=900001; SELECT CONCAT(guid,':',account,':',name,':',level,':',money) FROM acore_characters.characters WHERE guid=900001; SELECT CONCAT(guid,':',itemEntry,':',owner_guid,':',enchantments) FROM acore_characters.item_instance WHERE guid=900001; SELECT CONCAT(guid,':',bag,':',slot,':',item) FROM acore_characters.character_inventory WHERE guid=900001;")
|
||||
}
|
||||
fn main() -> Result<()> {
|
||||
let args:Vec<_>=std::env::args().skip(1).collect();
|
||||
let root=PathBuf::from(&args[0]);
|
||||
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-chaos-064-transition-"));
|
||||
assert_eq!(std::fs::read(root.join(".transition-fixture"))?,b"disposable published-064 transition fixture");
|
||||
if args.get(3).is_some_and(|mode| mode=="legacy-recovery") {
|
||||
return run_fixture(&root,||legacy_recovery(&root));
|
||||
}
|
||||
assert!(!root.join(".transition-started").exists(),"Use a new independent fixture");
|
||||
fsx::atomic_write(&root.join(".transition-started"),b"started")?;
|
||||
let meta=coa_core::registry::metadata_dir_for(&root)?;
|
||||
assert!(!meta.exists(),"Do not reuse experimental or user metadata");
|
||||
run_fixture(&root,||exercise(&root,&meta,&args[1],&args[2]))
|
||||
}
|
||||
fn run_fixture(root:&Path,operation:impl FnOnce()->Result<()>)->Result<()> {
|
||||
let result=std::panic::catch_unwind(std::panic::AssertUnwindSafe(operation));
|
||||
assert!(driver::run(root,driver::Verb::StopAll)?.ok,"Fixture shutdown failed");
|
||||
result.map_err(|_|coa_core::Error::Invalid("Disposable acceptance assertion failed; services were stopped and recovery copies retained.".into()))?
|
||||
}
|
||||
fn legacy_recovery(root:&Path)->Result<()> {
|
||||
let meta=coa_core::registry::metadata_dir_for(root)?;
|
||||
assert!(driver::run(root,driver::Verb::StopAll)?.ok);
|
||||
let expected=backup::with_database(root,|db| [coa_core::realms::Mode::Coa,coa_core::realms::Mode::Wildcard].into_iter().map(|mode|players(&db.clone().for_realm(mode))).collect::<Result<Vec<_>>>())?;
|
||||
assert!(driver::run(root,driver::Verb::StopAll)?.ok);
|
||||
let dirs=std::fs::read_dir(meta.join("updates"))?.collect::<std::io::Result<Vec<_>>>()?;
|
||||
assert_eq!(dirs.len(),1,"Requires exactly the preceding successful disposable transition");
|
||||
let txn_dir=dirs[0].path();
|
||||
let journal=txn_dir.join("txn.json");
|
||||
let mut legacy:serde_json::Value=fsx::read_json(&journal)?;
|
||||
assert_eq!(legacy["state"],"committed");
|
||||
let point=legacy["recovery_point"].as_str().unwrap().to_string();
|
||||
let point_path=meta.join("backups").join(&point).join("backup.json");
|
||||
let mut point_json:serde_json::Value=fsx::read_json(&point_path)?;
|
||||
point_json["manager_version"]="0.6.4".into();
|
||||
for component in point_json["components"].as_array_mut().unwrap() { component.as_object_mut().unwrap().remove("file_sha256"); }
|
||||
fsx::atomic_write_json(&point_path,&point_json)?;
|
||||
legacy.as_object_mut().unwrap().remove("recovery_hashes");
|
||||
legacy.as_object_mut().unwrap().remove("databases_started");
|
||||
legacy["state"]="applied".into();
|
||||
fsx::atomic_write_json(&journal,&legacy)?;
|
||||
assert!(update::ensure_recovered(&meta).is_err(),"Legacy unfinished update must block startup");
|
||||
let id=legacy["id"].as_str().unwrap();
|
||||
let env=RepackEnv {root,meta_dir:&meta};
|
||||
println!("Recovering legacy-format transaction and recovery point on disposable installation");
|
||||
assert_eq!(update::rollback(root,&meta,id,&env)?.state,update::State::RolledBack);
|
||||
for op in legacy["ops"].as_array().unwrap() {
|
||||
let relative=op["path"].as_str().unwrap();
|
||||
if op["had_previous"]==true {
|
||||
assert_eq!(fsx::sha256_file(&fsx::safe_join(root,relative)?)?,fsx::sha256_file(&fsx::safe_join(&txn_dir.join("before"),relative)?)?,"Legacy file restoration mismatch: {relative}");
|
||||
} else { assert!(!fsx::safe_join(root,relative)?.exists()); }
|
||||
}
|
||||
assert_eq!(std::fs::read(meta.join("install.json"))?,std::fs::read(txn_dir.join("before/manager-install.json"))?);
|
||||
backup::with_database(root,|db| {
|
||||
for (index,mode) in [coa_core::realms::Mode::Coa,coa_core::realms::Mode::Wildcard].into_iter().enumerate() {
|
||||
let db=db.clone().for_realm(mode);
|
||||
assert_eq!(players(&db)?,expected[index]);
|
||||
assert_eq!(db.query("SELECT COUNT(*) FROM acore_world.coa_manager_migrations WHERE id IN ('manager_repair__20261005_reconcile_wildcard_tables','manager_repair__20261005_reconcile_missing_class_starts');")?,"0");
|
||||
assert_eq!(db.query("SELECT sha256 FROM acore_world.coa_manager_migrations WHERE id='manager_repair__20261005_missing_wildcard_tables';")?,"9e4a36245c3f83255415c122c01f08ceb3e3b83898d3d427ac4e2fbcf61e9638");
|
||||
}
|
||||
Ok(())
|
||||
})?;
|
||||
assert!(driver::run(root,driver::Verb::StopAll)?.ok);
|
||||
assert!(update::pending_checked(&meta)?.is_none());
|
||||
assert!(update::rollback(root,&meta,id,&env).is_err(),"Completed recovery must not run again");
|
||||
println!("PASS: legacy journal blocked startup; old files, metadata, migration histories and player fields restored; completed recovery rejects replay. Original baseline had a missing table, so healthy startup is not claimed after rollback.");
|
||||
Ok(())
|
||||
}
|
||||
fn exercise(root:&Path,meta:&Path,baseline:&str,candidate:&str)->Result<()> {
|
||||
let mut install:InstallMeta=fsx::read_json(&PathBuf::from("C:/games/coa-schema-fixture-chaos-20261005-v1.manager/install.json"))?;
|
||||
install.server_path=root.to_string_lossy().into_owned();
|
||||
install.id=uuid::Uuid::new_v4().to_string();
|
||||
install.manager_version="0.6.4".into();
|
||||
MetaDir::create(root,&install)?;
|
||||
// Private ports, and no inherited PID records or paths to the source database.
|
||||
let mut cfg:serde_json::Value=fsx::read_json(&root.join("Settings/repack.json"))?;
|
||||
let mut listeners=Vec::new();
|
||||
for key in ["mysqlPort","authPort","worldPort","raPort"] {
|
||||
let listener=std::net::TcpListener::bind("127.0.0.1:0")?;
|
||||
cfg[key]=listener.local_addr()?.port().into(); listeners.push(listener);
|
||||
}
|
||||
fsx::atomic_write_json(&root.join("Settings/repack.json"),&cfg)?;
|
||||
let mut profile:serde_json::Value=fsx::read_json(&root.join("Settings/realm-profile.json"))?;
|
||||
for key in ["secondary_world_port","secondary_ra_port"] {
|
||||
let listener=std::net::TcpListener::bind("127.0.0.1:0")?;
|
||||
profile[key]=listener.local_addr()?.port().into(); listeners.push(listener);
|
||||
}
|
||||
fsx::atomic_write_json(&root.join("Settings/realm-profile.json"),&profile)?;
|
||||
drop(listeners);
|
||||
let state=root.join(".state");
|
||||
if state.exists() { std::fs::remove_dir_all(&state)?; }
|
||||
let secondary_state=root.join(".realms/secondary/.state");
|
||||
if secondary_state.exists() { std::fs::remove_dir_all(&secondary_state)?; }
|
||||
let source=Source::Dir(baseline.into());
|
||||
let (manifest,_)=pkgsource::fetch_manifest(&source,coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
|
||||
let temp=tempfile::tempdir()?;
|
||||
let parts=pkgsource::fetch_parts(&source,&manifest,&temp.path().join("download"),&Default::default(),&|_,_|{})?;
|
||||
let tree=temp.path().join("tree");
|
||||
coa_core::package::extract(&parts,&manifest,&tree,&|_,_|{})?;
|
||||
for file in &manifest.files {
|
||||
if file.path.starts_with("_migrations/") {continue;}
|
||||
fsx::atomic_write(&fsx::safe_join(root,&file.path)?,&std::fs::read(fsx::safe_join(&tree,&file.path)?)?)?;
|
||||
install.original_hashes.insert(file.path.clone(),file.sha256.clone());
|
||||
}
|
||||
install.core.version=Some(manifest.version);
|
||||
fsx::atomic_write_json(&meta.join("install.json"),&install)?;
|
||||
// Both worlds must remain local, including generated secondary configuration.
|
||||
for relative in ["Settings/worldserver.conf.template","Settings/authserver.conf.template"] {
|
||||
let p=root.join(relative);
|
||||
let mut conf=coa_core::config::parser::ConfFile::parse_bytes(&std::fs::read(&p)?)?;
|
||||
conf.set("BindIP","\"127.0.0.1\"",&[]); conf.set("Ra.IP","\"127.0.0.1\"",&[]); conf.set("SOAP.Enabled","0",&[]);
|
||||
fsx::atomic_write(&p,conf.to_text().as_bytes())?;
|
||||
}
|
||||
let expected=backup::with_database(root,|db| {
|
||||
let mut saved=Vec::new();
|
||||
for mode in [coa_core::realms::Mode::Coa,coa_core::realms::Mode::Wildcard] {
|
||||
let db=db.clone().for_realm(mode);
|
||||
saved.push(players(&db)?);
|
||||
db.query("DROP TABLE IF EXISTS acore_characters.coa_wildcard_skill_card; DELETE FROM acore_world.coa_manager_migrations WHERE id IN ('manager_repair__20261005_reconcile_wildcard_tables','manager_repair__20261005_reconcile_missing_class_starts'); UPDATE acore_world.coa_manager_migrations SET sha256='9e4a36245c3f83255415c122c01f08ceb3e3b83898d3d427ac4e2fbcf61e9638' WHERE id='manager_repair__20261005_missing_wildcard_tables' AND status='applied';")?;
|
||||
}
|
||||
Ok(saved)
|
||||
})?;
|
||||
let source=Source::Dir(candidate.into());
|
||||
let candidate_manifest=pkgsource::fetch_manifest(&source,coa_core::signing::EMBEDDED_PUBLIC_KEY)?.0;
|
||||
let choices:BTreeMap<_,_>=update::plan(root,&install,&candidate_manifest,&BTreeMap::new(),None)?.into_iter().filter(|p|p.action==update::Action::Conflict).map(|p|(p.path,update::Resolution::Replace)).collect();
|
||||
let env=Offline(RepackEnv{root,meta_dir:meta});
|
||||
let outcome=update::apply(&update::Params {root,meta_dir:meta,source,trusted_key:coa_core::signing::EMBEDDED_PUBLIC_KEY,cancel:Default::default(),resolutions:choices,env:&env,fail_after_ops:None},&|stage,pct|println!("{pct}% {stage}"))?;
|
||||
assert_eq!(outcome.txn.state,update::State::Committed,"{:?}",outcome.txn.message);
|
||||
backup::with_database(root,|db| {
|
||||
for (index,mode) in [coa_core::realms::Mode::Coa,coa_core::realms::Mode::Wildcard].into_iter().enumerate() {
|
||||
let db=db.clone().for_realm(mode);
|
||||
assert_eq!(players(&db)?,expected[index],"Player data changed in {}",mode.name());
|
||||
assert!(coa_core::schema_check::check(&db,root)?.is_empty());
|
||||
assert_eq!(migrations::pending_count(&db,&candidate_manifest.migrations)?,0);
|
||||
}
|
||||
Ok(())
|
||||
})?;
|
||||
println!("PASS: signed historical package to candidate; missing Wildcard table repaired in both realms; player fields and inventory preserved; schema and startup verified. Launcher isolation was test instrumentation, not packaged UI acceptance.");
|
||||
Ok(())
|
||||
}
|
||||
@@ -29,7 +29,7 @@ fn main() {
|
||||
let dst = staging.join(db).join(format!("{id}.sql"));
|
||||
std::fs::create_dir_all(dst.parent().unwrap()).unwrap();
|
||||
std::fs::write(&dst, &bytes).unwrap();
|
||||
list.push(Migration { id, db: db.into(), sha256: fsx::sha256_bytes(&bytes), destructive: false });
|
||||
list.push(Migration { compatible_sha256: vec![], id, db: db.into(), sha256: fsx::sha256_bytes(&bytes), destructive: false });
|
||||
};
|
||||
for (kind, dirs) in [("auth", ["db_auth", "pending_db_auth"]), ("characters", ["db_characters", "pending_db_characters"]), ("world", ["db_world", "pending_db_world"])] {
|
||||
for d in dirs {
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
//! Probe only a disposable fixture: enable both worlds, verify isolation, gracefully stop both.
|
||||
use coa_core::{Error, Result, driver::{self, Verb}, realms::{self, Mode}, multiworld, process::{self, ServiceState}};
|
||||
use std::path::PathBuf;
|
||||
|
||||
fn main() -> Result<()> {
|
||||
let root = PathBuf::from(std::env::args().nth(1).ok_or_else(|| Error::Invalid("fixture path required".into()))?);
|
||||
if !root.file_name().is_some_and(|n| n.to_string_lossy().contains("fixture")) { return Err(Error::Invalid("Refusing a non-fixture server.".into())); }
|
||||
let action = std::env::args().nth(2).unwrap_or_else(|| "smoke".into());
|
||||
if action == "stop" { driver::run(&root, Verb::StopAll)?; return Ok(()); }
|
||||
driver::run(&root, Verb::StopAll)?;
|
||||
if action == "wildcard" { realms::select(&root, Mode::Wildcard)?; }
|
||||
multiworld::set_enabled(&root, true)?;
|
||||
let result = (|| {
|
||||
let out = driver::run(&root, Verb::StartAll)?;
|
||||
if !out.ok { return Err(Error::Invalid(out.output)); }
|
||||
let first = process::observe(&root, &coa_core::layout::read_ports(&root));
|
||||
let second_root = multiworld::root(&root);
|
||||
let second = process::observe(&second_root, &coa_core::layout::read_ports(&second_root));
|
||||
assert_eq!(first.world.state, ServiceState::Running);
|
||||
assert_eq!(second.world.state, ServiceState::Running);
|
||||
assert_ne!(first.world.pid, second.world.pid);
|
||||
assert_ne!(first.world.port, second.world.port);
|
||||
assert!(second.mysql.pid.is_none() && second.auth.pid.is_none());
|
||||
let db = coa_core::db::Db::from_repack(&root, coa_core::db::Account::Admin)?;
|
||||
let realms = db.query("SELECT id,port,flag FROM acore_auth.realmlist WHERE id IN (1,2) ORDER BY id;")?;
|
||||
println!("Two distinct world PIDs; shared auth/MySQL; realm rows:\n{realms}");
|
||||
for mode in [Mode::Coa, Mode::Wildcard] {
|
||||
let problems = coa_core::schema_check::check(&db.clone().for_realm(mode), &root)?;
|
||||
println!("{}: {} database problems", mode.name(), problems.len());
|
||||
for p in problems.iter().take(5) { println!("{}.{}.{}: {}", p.database, p.table, p.column, p.detail); }
|
||||
}
|
||||
assert!(multiworld::set_enabled(&root, false).is_err());
|
||||
assert!(realms::select(&root, Mode::Wildcard).is_err());
|
||||
Ok(())
|
||||
})();
|
||||
let stopped = driver::run(&root, Verb::StopAll)?;
|
||||
if !stopped.ok { return Err(Error::Invalid(stopped.output)); }
|
||||
assert!(!multiworld::is_running(&root));
|
||||
assert_eq!(process::observe(&root, &coa_core::layout::read_ports(&root)).mysql.state, ServiceState::Stopped);
|
||||
result?;
|
||||
println!("Both worlds shut down before the shared database.");
|
||||
Ok(())
|
||||
}
|
||||
@@ -58,7 +58,7 @@ fn main() -> Result<()> {
|
||||
let path = staged.join(format!("{kind}/manager_realm_fixture.sql"));
|
||||
std::fs::create_dir_all(path.parent().unwrap())?;
|
||||
std::fs::write(&path, sql)?;
|
||||
manifest.migrations.push(Migration { id: "manager_realm_fixture".into(), db: kind.into(), sha256: coa_core::fsx::sha256_file(&path)?, destructive: false });
|
||||
manifest.migrations.push(Migration { compatible_sha256: vec![], id: "manager_realm_fixture".into(), db: kind.into(), sha256: coa_core::fsx::sha256_file(&path)?, destructive: false });
|
||||
}
|
||||
let result = env.migrate(&manifest, &staged)?;
|
||||
assert!(result.failed.is_none());
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
//! Signed-package repair smoke test. Only a disposable fixture may be used.
|
||||
use std::path::PathBuf;
|
||||
use base64::{engine::general_purpose::STANDARD, Engine};
|
||||
use ed25519_dalek::{Signer, SigningKey};
|
||||
use coa_core::{Result, Error, fsx, package::{self, BuildOptions}, manifest::{Kind, Migration}, registry::{InstallKind, InstallMeta, MetaDir, metadata_dir_for}, pkgsource::Source, realms::Mode};
|
||||
|
||||
fn main() -> Result<()> {
|
||||
let root = PathBuf::from(std::env::args().nth(1).ok_or_else(|| Error::Invalid("fixture path required".into()))?);
|
||||
if !root.file_name().is_some_and(|n| n.to_string_lossy().contains("fixture")) { return Err(Error::Invalid("Refusing a non-fixture server.".into())); }
|
||||
let work = tempfile::tempdir()?;
|
||||
let base_tree = work.path().join("base-tree");
|
||||
let update_tree = work.path().join("update-tree");
|
||||
let base_pkg = work.path().join("base-pkg");
|
||||
let update_pkg = work.path().join("update-pkg");
|
||||
let probe = "Core/reference/repair-e2e.txt";
|
||||
fsx::atomic_write(&base_tree.join(probe), b"base")?;
|
||||
fsx::atomic_write(&update_tree.join(probe), b"correct official file")?;
|
||||
let sql = "CREATE TABLE IF NOT EXISTS acore_world.manager_repair_probe (id INT PRIMARY KEY); INSERT IGNORE INTO acore_world.manager_repair_probe VALUES (42);";
|
||||
let id = "20261004_repair_e2e";
|
||||
fsx::atomic_write(&update_tree.join(format!("_migrations/world/{id}.sql")), sql.as_bytes())?;
|
||||
let options = |kind, version: &str, migrations| BuildOptions { kind, version: version.into(), core_commit: None, built_at: "fixture".into(), part_size: 1 << 20, bots_commit: None, migrations };
|
||||
let base = package::build(&base_tree, &base_pkg, &options(Kind::Base, "1.0.0", vec![]), &|_| {})?;
|
||||
let update = package::build(&update_tree, &update_pkg, &options(Kind::Update, "1.0.1", vec![Migration { compatible_sha256: vec![], id: id.into(), db: "world".into(), sha256: fsx::sha256_bytes(sql.as_bytes()), destructive: false }]), &|_| {})?;
|
||||
// A test-only trust key, unrelated to production signing material.
|
||||
let key = SigningKey::from_bytes(&[23; 32]);
|
||||
let public = STANDARD.encode(key.verifying_key().as_bytes());
|
||||
for pkg in [&base_pkg, &update_pkg] {
|
||||
fsx::atomic_write(&pkg.join("manifest.json.sig"), STANDARD.encode(key.sign(&std::fs::read(pkg.join("manifest.json"))?).to_bytes()).as_bytes())?;
|
||||
}
|
||||
let dir = metadata_dir_for(&root)?;
|
||||
let mut meta = InstallMeta::new(InstallKind::New, &root);
|
||||
meta.core.version = Some(update.version.clone());
|
||||
MetaDir::create(&root, &meta)?;
|
||||
fsx::atomic_write_json(&dir.join("manifests/base.json"), &base)?;
|
||||
fsx::atomic_write_json(&dir.join("manifests/update-1.0.1.json"), &update)?;
|
||||
fsx::atomic_write(&root.join(probe), b"corrupted")?;
|
||||
let settings = std::fs::read(root.join("Settings/repack.json"))?;
|
||||
let counts = coa_core::backup::with_database(&root, |db| db.query("SELECT COUNT(*) FROM acore_auth.account; SELECT COUNT(*) FROM acore_characters.characters; SELECT COUNT(*) FROM acore_characters_wildcard.characters;"))?;
|
||||
let report = coa_core::repair::run(&root, &dir, &Source::Dir(base_pkg), &Source::Dir(update_pkg), &public, &|s,p| println!("{p}% {s}"))?;
|
||||
assert_eq!(std::fs::read(root.join(probe))?, b"correct official file");
|
||||
assert!(report.error.is_none(), "{:?}", report.error);
|
||||
assert_eq!(report.applied.len(), 2, "Migration must run in both worlds");
|
||||
assert!(report.database.iter().all(|d| d.problems.is_empty() && d.migrations.iter().all(|m| m.status == coa_core::migrations::Status::Applied)));
|
||||
assert_eq!(std::fs::read(root.join("Settings/repack.json"))?, settings);
|
||||
assert!(coa_core::backup::verify(&dir, &report.backup)?.ok);
|
||||
coa_core::backup::with_database(&root, |db| {
|
||||
assert_eq!(db.query("SELECT COUNT(*) FROM acore_auth.account; SELECT COUNT(*) FROM acore_characters.characters; SELECT COUNT(*) FROM acore_characters_wildcard.characters;")?, counts);
|
||||
for mode in [Mode::Coa, Mode::Wildcard] {
|
||||
assert_eq!(db.clone().for_realm(mode).query("SELECT id FROM acore_world.manager_repair_probe;")?, "42");
|
||||
}
|
||||
// Corrupt only the second realm, proving that checks read its actual schema.
|
||||
let wildcard = db.clone().for_realm(Mode::Wildcard);
|
||||
wildcard.query("ALTER TABLE acore_characters.character_action DROP COLUMN type;")?;
|
||||
let problems = coa_core::schema_check::check(&wildcard, &root)?;
|
||||
assert!(problems.iter().any(|p| p.table == "character_action" && p.column == "type"));
|
||||
assert!(coa_core::schema_check::check(&db.clone().for_realm(Mode::Coa), &root)?.is_empty());
|
||||
wildcard.query("ALTER TABLE acore_characters.character_action ADD COLUMN type TINYINT UNSIGNED NOT NULL DEFAULT 0;")?;
|
||||
Ok(())
|
||||
})?;
|
||||
println!("Repair verified: signed file restored, both realms migrated, backup valid, accounts/characters/settings preserved, missing column isolated to its realm.");
|
||||
Ok(())
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
//! Check full schema contracts and blocking custom columns, only against a disposable fixture.
|
||||
use coa_core::{Result, Error, backup, schema_check, realms::Mode};
|
||||
use std::path::PathBuf;
|
||||
fn main() -> Result<()> {
|
||||
let root = PathBuf::from(std::env::args().nth(1).ok_or_else(|| Error::Invalid("fixture path required".into()))?);
|
||||
if !root.file_name().is_some_and(|n| n.to_string_lossy().contains("fixture")) { return Err(Error::Invalid("Refusing a non-fixture server.".into())); }
|
||||
backup::with_database(&root, |db| {
|
||||
let coa = db.clone().for_realm(Mode::Coa);
|
||||
let wildcard = db.clone().for_realm(Mode::Wildcard);
|
||||
assert!(schema_check::check(&coa, &root)?.is_empty());
|
||||
assert!(schema_check::check(&wildcard, &root)?.is_empty());
|
||||
let reference = tempfile::tempdir()?;
|
||||
schema_check::capture(&coa, reference.path())?;
|
||||
assert!(schema_check::check(&coa, reference.path())?.is_empty());
|
||||
wildcard.query("ALTER TABLE acore_characters.character_action ADD COLUMN manager_required INT NOT NULL;")?;
|
||||
let result = (|| {
|
||||
assert!(schema_check::check(&wildcard, &root)?.iter().any(|p| p.table == "character_action" && p.column == "manager_required"));
|
||||
assert!(schema_check::check(&coa, &root)?.is_empty());
|
||||
Ok(())
|
||||
})();
|
||||
wildcard.query("ALTER TABLE acore_characters.character_action DROP COLUMN manager_required;")?;
|
||||
result
|
||||
})?;
|
||||
println!("Full schema contract and a blocking NOT NULL column verified; second-realm corruption does not affect CoA checks.");
|
||||
Ok(())
|
||||
}
|
||||
@@ -33,7 +33,7 @@ fn main() {
|
||||
let sql = "CREATE TABLE IF NOT EXISTS coa_manager_update_test (id INT PRIMARY KEY); INSERT IGNORE INTO coa_manager_update_test VALUES (1);";
|
||||
put(&src, "_migrations/world/2026_09_30_00_update_e2e.sql", sql);
|
||||
let mut m = build(&src, &pkg, &BuildOptions { kind: Kind::Update, version: "0.2.0".into(), core_commit: None, built_at: chrono::Utc::now().to_rfc3339(), part_size: 1 << 20, bots_commit: None, migrations: vec![] }, &|_| {}).unwrap();
|
||||
m.migrations.push(Migration { id: "2026_09_30_00_update_e2e".into(), db: "world".into(), sha256: fsx::sha256_bytes(sql.as_bytes()), destructive: false });
|
||||
m.migrations.push(Migration { compatible_sha256: vec![], id: "2026_09_30_00_update_e2e".into(), db: "world".into(), sha256: fsx::sha256_bytes(sql.as_bytes()), destructive: false });
|
||||
std::fs::write(pkg.join("manifest.json"), serde_json::to_vec_pretty(&m).unwrap()).unwrap();
|
||||
let key = format!("{}/.coa-manager/signing/manifest-signing.key", std::env::var("USERPROFILE").unwrap());
|
||||
let seed: [u8; 32] = STANDARD.decode(std::fs::read_to_string(key).unwrap().trim()).unwrap().try_into().unwrap();
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
//! Failure injection on a NEW disposable fixture created by tools/make-fixture.ps1.
|
||||
//! Uses real MySQL dumps, SQL execution, signed packages and update rollback.
|
||||
use std::{collections::BTreeMap, path::{Path, PathBuf}};
|
||||
use coa_core::{backup, db::{Account, Db}, download::Cancel, driver::{self, Verb}, fsx,
|
||||
manifest::{Kind, Migration}, package::{self, BuildOptions}, pkgsource::Source,
|
||||
registry::{InstallKind, InstallMeta, MetaDir},
|
||||
update::{self, Env, RepackEnv}, Error, Result};
|
||||
use base64::Engine;
|
||||
use ed25519_dalek::{Signer, SigningKey};
|
||||
|
||||
fn main() -> Result<()> {
|
||||
let arg = std::env::args().nth(1).expect("usage: update_recovery_e2e <new fixture>");
|
||||
let root = PathBuf::from(arg);
|
||||
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-update-recovery-fixture-"));
|
||||
assert!(!root.join("recovery-e2e-started").exists(), "Use a new fixture; never reuse an owned server");
|
||||
fsx::atomic_write(&root.join("recovery-e2e-started"), b"disposable fixture")?;
|
||||
let result = exercise(&root);
|
||||
let stopped = driver::run(&root, Verb::StopAll)?;
|
||||
assert!(stopped.ok);
|
||||
result
|
||||
}
|
||||
|
||||
fn exercise(root: &Path) -> Result<()> {
|
||||
let meta = coa_core::registry::metadata_dir_for(root)?;
|
||||
let mut installed = InstallMeta::new(InstallKind::New, root);
|
||||
installed.core.version = Some("1.0.0".into());
|
||||
MetaDir::create(root, &installed)?;
|
||||
backup::with_database(root, |db| {
|
||||
db.query("CREATE TABLE acore_characters.manager_recovery_probe (id INT); INSERT INTO acore_characters.manager_recovery_probe VALUES (42); CREATE TABLE acore_world.manager_recovery_probe (id INT); INSERT INTO acore_world.manager_recovery_probe VALUES (43);")?;
|
||||
Ok(())
|
||||
})?;
|
||||
let source = root.join("fixture-update-source");
|
||||
fsx::atomic_write(&source.join("Core/recovery-probe.txt"), b"updated")?;
|
||||
let mut migrations = Vec::new();
|
||||
for (db, id, sql) in [
|
||||
("characters", "probe_chars", "UPDATE manager_recovery_probe SET id=999;"),
|
||||
("world", "probe_world", "DROP TABLE manager_recovery_probe; THIS IS INTENTIONALLY INVALID SQL;"),
|
||||
] {
|
||||
fsx::atomic_write(&source.join(format!("_migrations/{db}/{id}.sql")), sql.as_bytes())?;
|
||||
migrations.push(Migration { compatible_sha256: vec![], db: db.into(), id: id.into(), sha256: fsx::sha256_bytes(sql.as_bytes()), destructive: false });
|
||||
}
|
||||
let pkg = root.join("fixture-package");
|
||||
let manifest = package::build(&source, &pkg, &BuildOptions {
|
||||
kind: Kind::Update, version: "2.0.0".into(), core_commit: None, bots_commit: None,
|
||||
built_at: "fixture".into(), part_size: 1 << 20, migrations,
|
||||
}, &|_| {})?;
|
||||
let key = SigningKey::generate(&mut rand_core::OsRng);
|
||||
let signature = base64::engine::general_purpose::STANDARD.encode(key.sign(&std::fs::read(pkg.join("manifest.json"))?).to_bytes());
|
||||
fsx::atomic_write(&pkg.join("manifest.json.sig"), signature.as_bytes())?;
|
||||
let trusted = base64::engine::general_purpose::STANDARD.encode(key.verifying_key().to_bytes());
|
||||
let env = RepackEnv { root, meta_dir: &meta };
|
||||
let error = update::apply(&update::Params {
|
||||
root, meta_dir: &meta, source: Source::Dir(pkg), trusted_key: &trusted,
|
||||
cancel: Cancel::default(), resolutions: BTreeMap::new(), env: &env, fail_after_ops: None,
|
||||
}, &|step, pct| println!("{pct}% {step}" )).unwrap_err();
|
||||
assert!(error.to_string().contains("probe_world"), "{error}");
|
||||
assert!(error.to_string().contains("were restored"), "{error}");
|
||||
assert!(!root.join("Core/recovery-probe.txt").exists());
|
||||
assert!(update::unfinished(&meta).is_none());
|
||||
assert_eq!(MetaDir::open(&meta)?.1.core.version.as_deref(), Some("1.0.0"));
|
||||
backup::with_database(root, |db| {
|
||||
assert_eq!(db.query("SELECT id FROM acore_characters.manager_recovery_probe;")?, "42");
|
||||
assert_eq!(db.query("SELECT id FROM acore_world.manager_recovery_probe;")?, "43");
|
||||
assert!(!coa_core::migrations::status(db, &manifest.migrations)?.iter().any(|m| m.status == coa_core::migrations::Status::Applied));
|
||||
Ok(())
|
||||
})?;
|
||||
// A recovery point can be reused if the process died midway through restoring multiple schemas.
|
||||
let point = backup::list(&meta).into_iter().find(|p| p.trigger == backup::Trigger::BeforeUpdate).ok_or_else(|| Error::Invalid("missing backup".into()))?;
|
||||
env.restore_snapshot(&point.id)?;
|
||||
assert_eq!(Db::from_repack(root, Account::Admin)?.realm(), coa_core::realms::Mode::Coa);
|
||||
println!("PASS: failed SQL restored world, characters, ledger, files and version; repeated recovery succeeded");
|
||||
Ok(())
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
use coa_core::update::{Env, RepackEnv};
|
||||
use std::path::PathBuf;
|
||||
|
||||
fn main() {
|
||||
let root = PathBuf::from(std::env::args().nth(1).expect("disposable fixture path"));
|
||||
assert_eq!(std::fs::read(root.join(".release-schema-fixture")).unwrap(), b"disposable release-schema fixture");
|
||||
let meta = coa_core::registry::metadata_dir_for(&root).unwrap();
|
||||
let env = RepackEnv { root: &root, meta_dir: &meta };
|
||||
let result = env.validate();
|
||||
let _ = coa_core::driver::run(&root, coa_core::driver::Verb::StopAll);
|
||||
if let Err(error) = result {
|
||||
eprintln!("{}", error);
|
||||
for log in ["Core/Logs/auth-console.log", "Core/Logs/world-console.log", "Core/Logs/supervisor.log"] {
|
||||
eprintln!("{log}:\n{}", coa_core::diag::redact(&coa_core::health::tail(&root.join(log), 8192)));
|
||||
}
|
||||
std::process::exit(1);
|
||||
}
|
||||
println!("Published server startup validation passed on the disposable fixture");
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
//! Reproduce applied migration history with five missing tables on a disposable MySQL fixture.
|
||||
use std::path::PathBuf;
|
||||
use coa_core::{backup, fsx, manifest::Migration, migrations::{self, LedgerRow, Status, Store}, release_schema, schema_check, Error, Result};
|
||||
|
||||
fn main() -> Result<()> {
|
||||
let mut args = std::env::args().skip(1);
|
||||
let root = PathBuf::from(args.next().ok_or_else(|| Error::Invalid("fixture path required".into()))?);
|
||||
let old_sql = PathBuf::from(args.next().ok_or_else(|| Error::Invalid("core SQL directory required".into()))?);
|
||||
let repairs = PathBuf::from(args.next().ok_or_else(|| Error::Invalid("repair SQL directory required".into()))?);
|
||||
if !root.file_name().is_some_and(|n| n.to_string_lossy().starts_with("coa-update-recovery-fixture-"))
|
||||
|| !root.join("recovery-e2e-started").exists() {
|
||||
return Err(Error::Invalid("Refusing a non-disposable recovery fixture.".into()));
|
||||
}
|
||||
let tree = tempfile::tempdir()?;
|
||||
backup::with_database(&root, |db| {
|
||||
let db = db.clone().for_realm(coa_core::realms::Mode::Coa);
|
||||
let characters = db.query("SELECT COUNT(*) FROM acore_characters.characters;")?;
|
||||
db.load()?;
|
||||
// Record exactly the old file hashes, as in the user's all-applied report.
|
||||
let mut migrations = Vec::new();
|
||||
for name in ["rev_20260929_92_coa_wildcard_skill_cards", "rev_20260929_93_coa_wildcard_skill_card_duplicates", "rev_20260929_94_coa_wildcard_specialization_cache"] {
|
||||
let path = old_sql.join(format!("{name}.sql"));
|
||||
let hash = fsx::sha256_file(&path)?;
|
||||
db.put(&LedgerRow { db: "characters".into(), id: name.into(), sha256: hash.clone(), status: Status::Applied, error: None, baseline: false })?;
|
||||
migrations.push(Migration { compatible_sha256: vec![], db: "characters".into(), id: name.into(), sha256: hash, destructive: false });
|
||||
}
|
||||
for (_, tables) in schema_check::WILDCARD_TABLES.iter().filter(|(kind,_)| *kind == "characters") {
|
||||
for table in *tables { db.query(&format!("DROP TABLE IF EXISTS acore_characters.`{table}`;"))?; }
|
||||
}
|
||||
assert!(migrations::status(&db, &migrations)?.iter().all(|m| m.status == Status::Applied));
|
||||
assert!(!db.tables("acore_characters")?.iter().any(|t| t == "coa_wildcard_skill_card"));
|
||||
let empty_core = tempfile::tempdir()?;
|
||||
let files = release_schema::collect(empty_core.path(), None, Some(&repairs))?;
|
||||
assert_eq!(files.len(), 1);
|
||||
let repair = &files[0];
|
||||
migrations.push(Migration { compatible_sha256: vec![], db: repair.db.clone(), id: repair.id.clone(), sha256: repair.sha256.clone(), destructive: false });
|
||||
let staged = tree.path().join("sql/characters");
|
||||
fsx::atomic_write(&staged.join(format!("{}.sql", repair.id)), &std::fs::read(&repair.abs)?)?;
|
||||
let report = migrations::apply_pending(&db, &migrations, &tree.path().join("sql"), &|| Ok("disposable fixture".into()))?;
|
||||
assert!(report.failed.is_none());
|
||||
assert_eq!(report.applied, [repair.id.clone()]);
|
||||
assert_eq!(db.query("SELECT COUNT(*) FROM acore_characters.characters;")?, characters);
|
||||
db.query("INSERT INTO acore_characters.coa_wildcard_skill_card VALUES (77,123,456);")?;
|
||||
db.run_sql_file("acore_characters", &repair.abs)?;
|
||||
assert_eq!(db.query("SELECT progress FROM acore_characters.coa_wildcard_skill_card WHERE account=77 AND card=123;")?, "456");
|
||||
assert!(migrations::apply_pending(&db, &migrations, &tree.path().join("sql"), &|| Ok("disposable fixture".into()))?.applied.is_empty());
|
||||
schema_check::capture(&db, tree.path())?;
|
||||
db.query("DROP TABLE acore_characters.coa_wildcard_skill_card_purchase;")?;
|
||||
assert!(schema_check::check(&db, tree.path())?.iter().any(|p| p.table == "coa_wildcard_skill_card_purchase" && p.detail == "Missing table"));
|
||||
db.run_sql_file("acore_characters", &repair.abs)?;
|
||||
db.query("ALTER TABLE acore_characters.coa_wildcard_skill_card DROP COLUMN progress;")?;
|
||||
assert!(schema_check::check(&db, tree.path())?.iter().any(|p| p.table == "coa_wildcard_skill_card" && p.column == "progress"));
|
||||
db.query("ALTER TABLE acore_characters.coa_wildcard_skill_card ADD COLUMN progress INT UNSIGNED NOT NULL DEFAULT 0;")?;
|
||||
Ok(())
|
||||
})?;
|
||||
println!("Applied history with all five tables missing repaired; characters and existing card rows preserved; full contract detects missing tables and columns.");
|
||||
Ok(())
|
||||
}
|
||||
@@ -51,6 +51,8 @@ pub struct Component {
|
||||
pub sha256: Option<String>,
|
||||
pub tables: Option<usize>,
|
||||
pub files: Option<Vec<String>>,
|
||||
#[serde(default)]
|
||||
pub file_sha256: std::collections::BTreeMap<String, String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
@@ -91,7 +93,9 @@ pub fn list(meta: &Path) -> Vec<RecoveryPoint> {
|
||||
}
|
||||
|
||||
pub fn get(meta: &Path, id: &str) -> Result<RecoveryPoint> {
|
||||
fsx::read_json(&point_dir(meta, id)?.join("backup.json")).map_err(|_| Error::Invalid(format!("backup {id} was not found")))
|
||||
let point: RecoveryPoint = fsx::read_json(&fsx::ensure_within(meta, &point_dir(meta, id)?.join("backup.json"))?).map_err(|_| Error::Invalid(format!("backup {id} was not found or its metadata is damaged")))?;
|
||||
if point.id != id || point.schema != 1 { return Err(Error::Invalid(format!("Backup {id} has inconsistent identity or an unsupported schema."))); }
|
||||
Ok(point)
|
||||
}
|
||||
|
||||
/// Files that make up "configuration": everything a user or the Manager may have changed, minus secrets.
|
||||
@@ -139,13 +143,16 @@ fn copy_configs(root: &Path, dir: &Path) -> Result<Component> {
|
||||
let files = config_files(root);
|
||||
let target = dir.join("files");
|
||||
let mut bytes = 0;
|
||||
let mut file_sha256 = std::collections::BTreeMap::new();
|
||||
for rel in &files {
|
||||
let src = fsx::safe_join(root, rel)?;
|
||||
let dst = fsx::safe_join(&target, rel)?;
|
||||
fs::create_dir_all(dst.parent().unwrap())?;
|
||||
bytes += fs::copy(&src, &dst)?;
|
||||
let content = fs::read(&src)?;
|
||||
fsx::atomic_write(&dst, &content)?;
|
||||
bytes += content.len() as u64;
|
||||
file_sha256.insert(rel.clone(), fsx::sha256_bytes(&content));
|
||||
}
|
||||
Ok(Component { name: "configs".into(), path: "files".into(), bytes, sha256: None, tables: None, files: Some(files) })
|
||||
Ok(Component { name: "configs".into(), path: "files".into(), bytes, sha256: None, tables: None, files: Some(files), file_sha256 })
|
||||
}
|
||||
|
||||
/// Make sure the database is up for `f`. If we had to start it (and nothing else is running), stop it again.
|
||||
@@ -162,7 +169,7 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
|
||||
let result = f(&db);
|
||||
if !mysql_was_up {
|
||||
let now = process::observe(root, &read_ports(root));
|
||||
if now.world.state == ServiceState::Stopped && now.auth.state == ServiceState::Stopped {
|
||||
if now.world.state == ServiceState::Stopped && now.auth.state == ServiceState::Stopped && !crate::multiworld::is_running(root) {
|
||||
let _ = driver::run(root, Verb::StopAll);
|
||||
}
|
||||
}
|
||||
@@ -179,7 +186,7 @@ fn wanted_databases(kind: Kind) -> &'static [&'static str] {
|
||||
|
||||
/// Create a recovery point. The server may be running: dumps are consistent snapshots (`--single-transaction`).
|
||||
pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Option<String>, progress: &dyn Fn(&str)) -> Result<RecoveryPoint> {
|
||||
let id = format!("{}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S"), match trigger {
|
||||
let id = format!("{}-{}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S"), match trigger {
|
||||
Trigger::Manual => "manual",
|
||||
Trigger::Automatic => "auto",
|
||||
Trigger::BeforeUpdate => "before-update",
|
||||
@@ -188,7 +195,7 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
|
||||
Trigger::BeforeBots => "before-bots",
|
||||
Trigger::BeforeRepair => "before-repair",
|
||||
Trigger::BeforeDangerousChange => "before-change",
|
||||
});
|
||||
}, uuid::Uuid::new_v4().simple());
|
||||
let final_dir = point_dir(meta, &id)?;
|
||||
let partial = backups_dir(meta).join(format!("{id}.partial"));
|
||||
fs::create_dir_all(&partial)?;
|
||||
@@ -203,6 +210,9 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
|
||||
databases.push((format!("{}-characters", other.name()), other.schema("characters")?));
|
||||
if kind == Kind::Full { databases.push((format!("{}-world", other.name()), other.schema("world")?)); }
|
||||
}
|
||||
if kind != Kind::Config && with_database(root, |db| db.schema_exists("acore_playerbots"))? {
|
||||
databases.push(("playerbots".into(), "acore_playerbots"));
|
||||
}
|
||||
for (name, schema) in databases {
|
||||
progress(&format!("Backing up {name} database"));
|
||||
let component = with_database(root, |db| {
|
||||
@@ -212,7 +222,7 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
|
||||
let tables = db.tables(schema)?.len();
|
||||
let file = format!("{name}.sql.zst");
|
||||
let (bytes, sha) = db.dump_to(schema, &partial.join(&file))?;
|
||||
Ok(Component { name, path: file, bytes, sha256: Some(sha), tables: Some(tables), files: None })
|
||||
Ok(Component { name, path: file, bytes, sha256: Some(sha), tables: Some(tables), files: None, file_sha256: Default::default() })
|
||||
})?;
|
||||
components.push(component);
|
||||
}
|
||||
@@ -252,6 +262,7 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
|
||||
|
||||
/// Keep the newest `keep` automatic recovery points; manual and safety ones are never pruned.
|
||||
pub fn prune_automatic(meta: &Path, keep: usize) {
|
||||
if crate::update::ensure_recovered(meta).is_err() { return; }
|
||||
let autos: Vec<_> = list(meta).into_iter().filter(|p| p.trigger == Trigger::Automatic).collect();
|
||||
for p in autos.into_iter().skip(keep) {
|
||||
if let Ok(dir) = point_dir(meta, &p.id) {
|
||||
@@ -270,8 +281,21 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
|
||||
let point = get(meta, id)?;
|
||||
let dir = point_dir(meta, id)?;
|
||||
let mut problems = Vec::new();
|
||||
let mut names = std::collections::BTreeSet::new();
|
||||
let mut schemas = std::collections::BTreeSet::new();
|
||||
for c in &point.components {
|
||||
let path = dir.join(&c.path);
|
||||
if !names.insert(&c.name) { problems.push(format!("{} appears more than once", c.name)); }
|
||||
let path = fsx::ensure_within(&dir, &fsx::safe_join(&dir, &c.path)?)?;
|
||||
if c.name != "configs" && (c.sha256.is_none() || c.tables.is_none()) { problems.push(format!("{} lacks database integrity metadata", c.name)); }
|
||||
if c.name == "configs" {
|
||||
if c.sha256.is_some() || c.files.is_none() { problems.push("configuration integrity metadata is inconsistent".into()); }
|
||||
} else {
|
||||
let schema = if c.name.contains('-') || c.name == "playerbots" { db::schema_of(&c.name) } else { point.realm.schema(&c.name) };
|
||||
match schema {
|
||||
Ok(schema) if schemas.insert(schema) => {}
|
||||
_ => problems.push(format!("{} has an unknown or duplicate database target", c.name)),
|
||||
}
|
||||
}
|
||||
match (&c.sha256, &c.files) {
|
||||
(Some(sha), _) => match fsx::sha256_file(&path) {
|
||||
Ok(actual) if actual.eq_ignore_ascii_case(sha) => {}
|
||||
@@ -280,12 +304,16 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
|
||||
},
|
||||
(None, Some(files)) => {
|
||||
for f in files {
|
||||
if !c.file_sha256.is_empty() && !c.file_sha256.contains_key(f) { problems.push(format!("configuration file {f} lacks its checksum")); }
|
||||
if !fsx::safe_join(&path, f).map(|p| p.is_file()).unwrap_or(false) {
|
||||
problems.push(format!("configuration file {f} is missing"));
|
||||
} else if let Some(expected) = c.file_sha256.get(f) {
|
||||
let file = fsx::ensure_within(&dir, &fsx::safe_join(&path, f)?)?;
|
||||
if fsx::sha256_file(&file)?.as_str() != expected { problems.push(format!("configuration file {f} is damaged")); }
|
||||
}
|
||||
}
|
||||
}
|
||||
_ => {}
|
||||
_ => problems.push(format!("{} lacks an integrity inventory", c.name)),
|
||||
}
|
||||
}
|
||||
Ok(VerifyReport { ok: problems.is_empty(), problems })
|
||||
@@ -293,6 +321,11 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
|
||||
|
||||
/// Delete one recovery point (its own folder only).
|
||||
pub fn delete(meta: &Path, id: &str) -> Result<()> {
|
||||
let _lock = crate::update::operation_lock(meta)?;
|
||||
crate::update::ensure_recovered(meta)?;
|
||||
if crate::update::unfinished(meta).is_some_and(|t| t.recovery_point.as_deref() == Some(id)) {
|
||||
return Err(Error::Invalid("This recovery point is required by an unfinished update and cannot be deleted.".into()));
|
||||
}
|
||||
let dir = point_dir(meta, id)?;
|
||||
get(meta, id)?; // must be a real recovery point
|
||||
fs::remove_dir_all(dir)?;
|
||||
@@ -338,13 +371,13 @@ pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Resul
|
||||
return Err(Error::Invalid("This backup is damaged and cannot be restored.".into()));
|
||||
}
|
||||
let now = process::observe(root, &read_ports(root));
|
||||
if now.world.state != ServiceState::Stopped || now.auth.state != ServiceState::Stopped {
|
||||
if now.world.state != ServiceState::Stopped || now.auth.state != ServiceState::Stopped || crate::multiworld::is_running(root) {
|
||||
return Err(Error::Invalid("Stop the server before restoring a database.".into()));
|
||||
}
|
||||
let live = if name.contains('-') { db::schema_of(name)? } else { point.realm.schema(name)? };
|
||||
let live = if name.contains('-') || name == "playerbots" { db::schema_of(name)? } else { point.realm.schema(name)? };
|
||||
let expected_tables = comp.tables.unwrap_or(0);
|
||||
let dump = point_dir(meta, id)?.join(&comp.path);
|
||||
let stamp = chrono::Utc::now().format("%Y%m%d%H%M%S").to_string();
|
||||
let stamp = uuid::Uuid::new_v4().simple().to_string()[..16].to_string();
|
||||
|
||||
// 1. Safety copy of the current state, so even a wrong restore is reversible.
|
||||
let safety = create(root, meta, Kind::Database, Trigger::BeforeRestore, Some(format!("before restoring {name} from {id}")), &|_| {})?;
|
||||
@@ -361,7 +394,7 @@ pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Resul
|
||||
db.import_from(&staging, &dump)?;
|
||||
// 3. Sanity checks.
|
||||
let staged = db.tables(&staging)?;
|
||||
if staged.is_empty() || (expected_tables > 0 && staged.len() != expected_tables) {
|
||||
if comp.tables.is_some_and(|expected| staged.len() != expected) || (comp.tables.is_none() && staged.is_empty()) {
|
||||
return Err(Error::Invalid(format!("The restored copy looks incomplete ({} of {expected_tables} tables); nothing was changed.", staged.len())));
|
||||
}
|
||||
if db.extra_objects(&staging)? > 0 || db.extra_objects(live)? > 0 {
|
||||
@@ -377,7 +410,7 @@ pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Resul
|
||||
for t in &staged {
|
||||
renames.push(format!("`{staging}`.`{t}` TO `{live}`.`{t}`"));
|
||||
}
|
||||
db.query(&format!("RENAME TABLE {};", renames.join(", ")))?;
|
||||
if !renames.is_empty() { db.query(&format!("RENAME TABLE {};", renames.join(", ")))?; }
|
||||
Ok(DbRestore { previous_schema: old, safety_backup: safety.id.clone(), tables_restored: staged.len() })
|
||||
})
|
||||
}
|
||||
@@ -399,6 +432,36 @@ mod tests {
|
||||
(dir, root, meta)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_deletion_obeys_the_installation_lock() {
|
||||
let (_d, root, meta) = setup();
|
||||
let point = create(&root, &meta, Kind::Config, Trigger::Manual, None, &|_| {}).unwrap();
|
||||
let lock = crate::update::operation_lock(&meta).unwrap();
|
||||
assert!(delete(&meta, &point.id).is_err());
|
||||
assert!(get(&meta, &point.id).is_ok());
|
||||
drop(lock);
|
||||
delete(&meta, &point.id).unwrap();
|
||||
assert!(get(&meta, &point.id).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn damaged_configuration_is_detected_before_restore_and_copies_are_retained() {
|
||||
let (_d, root, meta) = setup();
|
||||
let point = create(&root, &meta, Kind::Config, Trigger::Automatic, None, &|_| {}).unwrap();
|
||||
let file = point_dir(&meta, &point.id).unwrap().join("files/Core/configs/worldserver.conf");
|
||||
fs::write(&file, b"corrupted").unwrap();
|
||||
assert!(!verify(&meta, &point.id).unwrap().ok);
|
||||
let original = fs::read(root.join("Core/configs/worldserver.conf")).unwrap();
|
||||
assert!(restore_configs(&root, &meta, &point.id).is_err());
|
||||
assert_eq!(fs::read(root.join("Core/configs/worldserver.conf")).unwrap(), original);
|
||||
assert_eq!(list(&meta).len(), 1);
|
||||
fs::create_dir_all(meta.join("updates/broken")).unwrap();
|
||||
fs::write(meta.join("updates/broken/txn.json"), b"{damaged").unwrap();
|
||||
assert!(delete(&meta, &point.id).is_err());
|
||||
prune_automatic(&meta, 0);
|
||||
assert!(file.exists());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn config_backup_excludes_secrets_and_clutter_and_restores_byte_exact() {
|
||||
let (_d, root, meta) = setup();
|
||||
|
||||
@@ -0,0 +1,170 @@
|
||||
{
|
||||
"character_inventory": [
|
||||
"guid",
|
||||
"bag",
|
||||
"slot",
|
||||
"item"
|
||||
],
|
||||
"characters": [
|
||||
"guid",
|
||||
"account",
|
||||
"name",
|
||||
"race",
|
||||
"class",
|
||||
"gender",
|
||||
"level",
|
||||
"xp",
|
||||
"money",
|
||||
"skin",
|
||||
"face",
|
||||
"hairStyle",
|
||||
"hairColor",
|
||||
"facialStyle",
|
||||
"bankSlots",
|
||||
"restState",
|
||||
"playerFlags",
|
||||
"map",
|
||||
"instance_id",
|
||||
"instance_mode_mask",
|
||||
"position_x",
|
||||
"position_y",
|
||||
"position_z",
|
||||
"orientation",
|
||||
"trans_x",
|
||||
"trans_y",
|
||||
"trans_z",
|
||||
"trans_o",
|
||||
"transguid",
|
||||
"taximask",
|
||||
"cinematic",
|
||||
"totaltime",
|
||||
"leveltime",
|
||||
"rest_bonus",
|
||||
"logout_time",
|
||||
"is_logout_resting",
|
||||
"resettalents_cost",
|
||||
"resettalents_time",
|
||||
"extra_flags",
|
||||
"stable_slots",
|
||||
"at_login",
|
||||
"zone",
|
||||
"death_expire_time",
|
||||
"taxi_path",
|
||||
"arenaPoints",
|
||||
"totalHonorPoints",
|
||||
"todayHonorPoints",
|
||||
"yesterdayHonorPoints",
|
||||
"totalKills",
|
||||
"todayKills",
|
||||
"yesterdayKills",
|
||||
"chosenTitle",
|
||||
"knownCurrencies",
|
||||
"watchedFaction",
|
||||
"drunk",
|
||||
"health",
|
||||
"power1",
|
||||
"power2",
|
||||
"power3",
|
||||
"power4",
|
||||
"power5",
|
||||
"power6",
|
||||
"power7",
|
||||
"latency",
|
||||
"talentGroupsCount",
|
||||
"activeTalentGroup",
|
||||
"exploredZones",
|
||||
"equipmentCache",
|
||||
"ammoId",
|
||||
"knownTitles",
|
||||
"actionBars",
|
||||
"grantableLevels",
|
||||
"innTriggerId",
|
||||
"extraBonusTalentCount"
|
||||
],
|
||||
"character_spell": [
|
||||
"guid",
|
||||
"spell",
|
||||
"specMask"
|
||||
],
|
||||
"character_skills": [
|
||||
"guid",
|
||||
"skill",
|
||||
"value",
|
||||
"max"
|
||||
],
|
||||
"character_homebind": [
|
||||
"guid",
|
||||
"mapId",
|
||||
"zoneId",
|
||||
"posX",
|
||||
"posY",
|
||||
"posZ"
|
||||
],
|
||||
"character_reputation": [
|
||||
"guid",
|
||||
"faction",
|
||||
"standing",
|
||||
"flags"
|
||||
],
|
||||
"character_action": [
|
||||
"guid",
|
||||
"spec",
|
||||
"button",
|
||||
"action",
|
||||
"type"
|
||||
],
|
||||
"character_talent": [
|
||||
"guid",
|
||||
"spell",
|
||||
"specMask"
|
||||
],
|
||||
"item_instance": [
|
||||
"itemEntry",
|
||||
"owner_guid",
|
||||
"creatorGuid",
|
||||
"giftCreatorGuid",
|
||||
"count",
|
||||
"duration",
|
||||
"charges",
|
||||
"flags",
|
||||
"enchantments",
|
||||
"randomPropertyId",
|
||||
"durability",
|
||||
"playedTime",
|
||||
"text",
|
||||
"guid"
|
||||
],
|
||||
"character_stats": [
|
||||
"guid",
|
||||
"maxhealth",
|
||||
"maxpower1",
|
||||
"maxpower2",
|
||||
"maxpower3",
|
||||
"maxpower4",
|
||||
"maxpower5",
|
||||
"maxpower6",
|
||||
"maxpower7",
|
||||
"strength",
|
||||
"agility",
|
||||
"stamina",
|
||||
"intellect",
|
||||
"spirit",
|
||||
"armor",
|
||||
"resHoly",
|
||||
"resFire",
|
||||
"resNature",
|
||||
"resFrost",
|
||||
"resShadow",
|
||||
"resArcane",
|
||||
"blockPct",
|
||||
"dodgePct",
|
||||
"parryPct",
|
||||
"critPct",
|
||||
"rangedCritPct",
|
||||
"spellCritPct",
|
||||
"attackPower",
|
||||
"rangedAttackPower",
|
||||
"spellPower",
|
||||
"resilience"
|
||||
]
|
||||
}
|
||||
@@ -181,7 +181,7 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
|
||||
if let Some(b) = p.bots {
|
||||
sql.extend(collect_bots_sql(b)?);
|
||||
}
|
||||
let migrations: Vec<_> = sql.iter().map(|f| crate::manifest::Migration { id: f.id.clone(), db: f.db.clone(), sha256: f.sha256.clone(), destructive: false }).collect();
|
||||
let migrations: Vec<_> = sql.iter().map(|f| crate::manifest::Migration { compatible_sha256: vec![], id: f.id.clone(), db: f.db.clone(), sha256: f.sha256.clone(), destructive: false }).collect();
|
||||
let staging = std::env::temp_dir().join("coa-cleanbase-sql");
|
||||
let _ = fs::remove_dir_all(&staging);
|
||||
for f in &sql {
|
||||
@@ -218,12 +218,17 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
|
||||
db.query(&sql)?;
|
||||
// 2. characters: a brand-new schema from the core's base scripts
|
||||
db.query("DROP DATABASE IF EXISTS `acore_characters`; CREATE DATABASE `acore_characters` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;")?;
|
||||
// The ledger lives in world, so dropping characters does not clear its migration history.
|
||||
// Never carry that history into a freshly rebuilt character database.
|
||||
if db.tables("acore_world")?.iter().any(|t| t == "coa_manager_migrations") {
|
||||
db.query("DELETE FROM acore_world.coa_manager_migrations WHERE `db`='characters';")?;
|
||||
}
|
||||
for f in &base_chars {
|
||||
db.run_sql_file("acore_characters", f)?;
|
||||
}
|
||||
// 3. every migration up to the core commit (already-recorded ones are skipped)
|
||||
let before = status(db, &migrations)?;
|
||||
let pending: Vec<_> = migrations.iter().zip(&before).filter(|(_, i)| i.status == Status::Pending).map(|(m, _)| m.clone()).collect();
|
||||
let pending: Vec<_> = migrations.iter().zip(&before).filter(|(_, i)| i.status != Status::Applied).map(|(m, _)| m.clone()).collect();
|
||||
say(&format!("Applying {} database updates", pending.len()));
|
||||
let report = apply_pending(db, &pending, &staging, &|| Ok("(scratch database)".into()))?;
|
||||
if let Some((id, why)) = report.failed {
|
||||
@@ -251,6 +256,10 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
|
||||
if accounts != "0" || chars != "0" || templates != 21 {
|
||||
return Err(Error::Invalid(format!("The database is not clean ({accounts} accounts, {chars} player characters, {templates} templates).")));
|
||||
}
|
||||
if let Some(p) = crate::schema_check::check(db, p.tree)?.first() {
|
||||
return Err(Error::Invalid(format!("The rebuilt base database is incomplete: {}.{}.{}: {}", p.database, p.table, p.column, p.detail)));
|
||||
}
|
||||
crate::schema_check::capture(db, out)?;
|
||||
Ok(())
|
||||
})?;
|
||||
|
||||
@@ -270,7 +279,7 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
|
||||
fsx::atomic_write_json(&repack_json, &shipped)?;
|
||||
|
||||
say("Adding the release files");
|
||||
copy_dir(p.tree, p.out, &|_| false, p.tree)?;
|
||||
copy_dir(p.tree, p.out, &|rel| rel == crate::schema_check::CONTRACT, p.tree)?;
|
||||
if let Some(data) = p.data {
|
||||
say("Copying game data");
|
||||
fs::create_dir_all(p.out.join("Data"))?;
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
//! The game client is a separate object: detected read-only, and touched only in two narrow ways -
|
||||
//! The game client is a separate object: detected read-only, with targeted updates to
|
||||
//! `realmlist.wtf` (backed up first) and the `Interface/AddOns/CoABotUI` folder (backed up when it differs).
|
||||
//! WTF, Cache, other addons and the executable are never modified.
|
||||
//! The selected realm in WTF/Config.wtf is synchronized while the client is closed.
|
||||
//! Cache, other addons and the executable are never modified.
|
||||
|
||||
use std::collections::BTreeMap;
|
||||
use std::fs;
|
||||
@@ -15,6 +16,67 @@ use crate::fsx;
|
||||
pub const ADDON_NAME: &str = "CoABotUI";
|
||||
const EXECUTABLES: [&str; 3] = ["Ascension.exe", "Wow.exe", "WoW.exe"];
|
||||
|
||||
pub fn is_running(client: &Path) -> bool {
|
||||
EXECUTABLES.iter().any(|exe| {
|
||||
let path = client.join(exe);
|
||||
let path = dunce::canonicalize(&path).unwrap_or(path);
|
||||
!crate::process::find_by_exe(&path).is_empty()
|
||||
})
|
||||
}
|
||||
|
||||
fn realm_config(old: &[u8], realm: &str) -> Vec<u8> {
|
||||
let eol: &[u8] = if old.windows(2).any(|w| w == b"\r\n") { b"\r\n" } else { b"\n" };
|
||||
let mut out = Vec::new();
|
||||
let mut replaced = false;
|
||||
for line in old.split_inclusive(|b| *b == b'\n') {
|
||||
let body = line.strip_prefix(b"\xef\xbb\xbf").unwrap_or(line);
|
||||
let mut words = body.split(|b| b.is_ascii_whitespace()).filter(|w| !w.is_empty());
|
||||
let matches = words.next().is_some_and(|w| w.eq_ignore_ascii_case(b"SET"))
|
||||
&& words.next().is_some_and(|w| w.eq_ignore_ascii_case(b"realmName"));
|
||||
if matches {
|
||||
if line.starts_with(b"\xef\xbb\xbf") { out.extend_from_slice(b"\xef\xbb\xbf"); }
|
||||
out.extend_from_slice(format!("SET realmName \"{realm}\"").as_bytes());
|
||||
if line.ends_with(b"\r\n") { out.extend_from_slice(b"\r\n"); }
|
||||
else if line.ends_with(b"\n") { out.push(b'\n'); }
|
||||
replaced = true;
|
||||
} else {
|
||||
out.extend_from_slice(line);
|
||||
}
|
||||
}
|
||||
if !replaced {
|
||||
if !out.is_empty() && !out.ends_with(b"\n") { out.extend_from_slice(eol); }
|
||||
out.extend_from_slice(format!("SET realmName \"{realm}\"").as_bytes());
|
||||
out.extend_from_slice(eol);
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
pub fn sync_realm(client: &Path, meta: &Path, mode: crate::realms::Mode) -> Result<bool> {
|
||||
sync_realm_when_closed(client, meta, mode, is_running(client))
|
||||
}
|
||||
|
||||
fn sync_realm_when_closed(client: &Path, meta: &Path, mode: crate::realms::Mode, running: bool) -> Result<bool> {
|
||||
if running { return Ok(false); }
|
||||
let file = client.join("WTF/Config.wtf");
|
||||
let old = match fs::read(&file) {
|
||||
Ok(bytes) => bytes,
|
||||
Err(e) if e.kind() == std::io::ErrorKind::NotFound => Vec::new(),
|
||||
Err(e) => return Err(e.into()),
|
||||
};
|
||||
let realm = match mode {
|
||||
crate::realms::Mode::Coa => "Conquest of Azeroth",
|
||||
crate::realms::Mode::Wildcard => "Wildcard",
|
||||
};
|
||||
let new = realm_config(&old, realm);
|
||||
if new == old { return Ok(true); }
|
||||
if file.exists() {
|
||||
let saved = backup_dir(meta).join(format!("config-realm-{}.wtf", uuid::Uuid::new_v4()));
|
||||
fsx::atomic_write(&saved, &old)?;
|
||||
}
|
||||
fsx::atomic_write(&file, &new)?;
|
||||
Ok(true)
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize)]
|
||||
pub struct Realmlist {
|
||||
pub path: String,
|
||||
@@ -118,7 +180,7 @@ fn backup_dir(meta: &Path) -> PathBuf {
|
||||
meta.join("backups").join("client")
|
||||
}
|
||||
|
||||
fn host_ok(h: &str) -> bool {
|
||||
pub fn host_ok(h: &str) -> bool {
|
||||
!h.is_empty() && h.len() <= 253 && h.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '-' | ':')) && !h.starts_with('-')
|
||||
}
|
||||
|
||||
@@ -253,6 +315,45 @@ pub fn launch(client: &Path) -> Result<u32> {
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn realm_selection_preserves_other_settings_bytes_and_line_endings() {
|
||||
let old = b"\xef\xbb\xbfSET realmName \"Wildcard\"\r\nSET accountName \"\xff\"\r\nset REALMNAME \"old\"\r\nSET realmList \"127.0.0.1\"";
|
||||
let expected = b"\xef\xbb\xbfSET realmName \"Conquest of Azeroth\"\r\nSET accountName \"\xff\"\r\nSET realmName \"Conquest of Azeroth\"\r\nSET realmList \"127.0.0.1\"";
|
||||
assert_eq!(realm_config(old, "Conquest of Azeroth"), expected);
|
||||
assert_eq!(realm_config(b"SET sound 1", "Wildcard"), b"SET sound 1\nSET realmName \"Wildcard\"\n");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn realm_sync_backs_up_config_and_is_idempotent() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let c = fake_client(d.path());
|
||||
let meta = d.path().join("meta");
|
||||
let original = b"SET sound 1\r\nSET realmName \"Wildcard\"\r\n";
|
||||
fs::write(c.join("WTF/Config.wtf"), original).unwrap();
|
||||
assert!(sync_realm(&c, &meta, crate::realms::Mode::Coa).unwrap());
|
||||
let backups: Vec<_> = fs::read_dir(backup_dir(&meta)).unwrap().flatten().collect();
|
||||
assert_eq!(backups.len(), 1);
|
||||
assert_eq!(fs::read(backups[0].path()).unwrap(), original);
|
||||
assert!(sync_realm(&c, &meta, crate::realms::Mode::Coa).unwrap());
|
||||
assert_eq!(fs::read_dir(backup_dir(&meta)).unwrap().count(), 1);
|
||||
assert!(sync_realm(&c, &meta, crate::realms::Mode::Wildcard).unwrap());
|
||||
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), original);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn running_client_defers_realm_update_until_closed() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let c = fake_client(d.path());
|
||||
let meta = d.path().join("meta");
|
||||
let original = b"SET realmName \"Wildcard\"\n";
|
||||
fs::write(c.join("WTF/Config.wtf"), original).unwrap();
|
||||
assert!(!sync_realm_when_closed(&c, &meta, crate::realms::Mode::Coa, true).unwrap());
|
||||
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), original);
|
||||
assert!(!backup_dir(&meta).exists());
|
||||
assert!(sync_realm_when_closed(&c, &meta, crate::realms::Mode::Coa, false).unwrap());
|
||||
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), b"SET realmName \"Conquest of Azeroth\"\n");
|
||||
}
|
||||
|
||||
fn fake_client(d: &Path) -> PathBuf {
|
||||
let c = d.join("wow");
|
||||
fs::create_dir_all(c.join("Data/enUS")).unwrap();
|
||||
|
||||
@@ -341,9 +341,23 @@ pub struct SnapshotInfo {
|
||||
}
|
||||
|
||||
pub(crate) fn take_snapshot(meta_dir: &Path, scope: Scope, reason: &str, files: &[(PathBuf, Vec<u8>)]) -> Result<String> {
|
||||
let id = format!("{}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S%3f"), scope.name());
|
||||
let dir = snapshot_root(meta_dir).join(&id);
|
||||
fs::create_dir_all(&dir)?;
|
||||
let root = snapshot_root(meta_dir);
|
||||
fs::create_dir_all(&root)?;
|
||||
// The id is a timestamp to the millisecond. Two snapshots of the same scope can land in the same one (a restore
|
||||
// snapshots the current state just before reading the snapshot it restores), and reusing the folder would overwrite
|
||||
// the files about to be restored. Take a fresh folder, with a numeric suffix when the name is already used.
|
||||
let base = format!("{}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S%3f"), scope.name());
|
||||
let (id, dir) = (1u32..)
|
||||
.map(|n| if n == 1 { base.clone() } else { format!("{base}-{n}") })
|
||||
.find_map(|id| {
|
||||
let dir = root.join(&id);
|
||||
match fs::create_dir(&dir) {
|
||||
Ok(()) => Some(Ok((id, dir))),
|
||||
Err(e) if e.kind() == std::io::ErrorKind::AlreadyExists => None,
|
||||
Err(e) => Some(Err(e)),
|
||||
}
|
||||
})
|
||||
.expect("the suffix range is unbounded")?;
|
||||
let mut entries = Vec::new();
|
||||
for (i, (path, bytes)) in files.iter().enumerate() {
|
||||
let stored = format!("{i}_{}", path.file_name().map(|n| n.to_string_lossy().into_owned()).unwrap_or_default());
|
||||
@@ -748,6 +762,21 @@ Spellbook.New = 5
|
||||
assert!(restore_snapshot(&meta, "../evil").is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn snapshots_taken_in_the_same_millisecond_keep_their_own_files() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let mut ids = std::collections::HashSet::new();
|
||||
for i in 0..40 {
|
||||
let path = dir.path().join("worldserver.conf");
|
||||
let id = take_snapshot(dir.path(), Scope::Server, "test", &[(path, format!("version {i}").into_bytes())]).unwrap();
|
||||
assert!(ids.insert(id.clone()), "snapshot id {id} was handed out twice");
|
||||
}
|
||||
for info in list_snapshots(dir.path()) {
|
||||
assert_eq!(info.files.len(), 1);
|
||||
}
|
||||
assert_eq!(list_snapshots(dir.path()).len(), 40.min(KEEP_SNAPSHOTS));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_repeated_key_with_the_same_effective_value_is_not_drift() {
|
||||
let (_d, root, _m) = fixture();
|
||||
|
||||
+124
-4
@@ -1,4 +1,5 @@
|
||||
//! Database access through the MySQL client tools bundled with the repack (`mysql`, `mysqldump`, `mysqladmin`).
|
||||
//! Database access through the MySQL client tools bundled with the repack (`mysql`, `mysqldump`, `mysqladmin`), or,
|
||||
//! for a Docker installation, the same tools run inside the database container with `docker exec`.
|
||||
//!
|
||||
//! Passwords travel only in the child's environment (`MYSQL_PWD`), never on a command line or in a log.
|
||||
|
||||
@@ -45,6 +46,8 @@ pub struct Db {
|
||||
user: &'static str,
|
||||
password: Secret,
|
||||
realm: crate::realms::Mode,
|
||||
/// Name of the database container of a Docker installation; the client tools then run inside it.
|
||||
container: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Deserialize)]
|
||||
@@ -68,6 +71,7 @@ fn no_window(cmd: &mut Command) {
|
||||
pub const SCHEMAS: [(&str, &str); 3] = [("characters", "acore_characters"), ("auth", "acore_auth"), ("world", "acore_world")];
|
||||
|
||||
pub fn schema_of(kind: &str) -> Result<&'static str> {
|
||||
if kind == "playerbots" { return Ok("acore_playerbots"); }
|
||||
if let Some(kind) = kind.strip_prefix("wildcard-") { return crate::realms::Mode::Wildcard.schema(kind); }
|
||||
if let Some(kind) = kind.strip_prefix("coa-") { return crate::realms::Mode::Coa.schema(kind); }
|
||||
SCHEMAS.iter().find(|(k, _)| *k == kind).map(|(_, s)| *s).ok_or_else(|| Error::Invalid(format!("unknown database {kind}")))
|
||||
@@ -77,11 +81,21 @@ fn ident_ok(name: &str) -> bool {
|
||||
!name.is_empty() && name.len() <= 64 && name.chars().all(|c| c.is_ascii_alphanumeric() || c == '_')
|
||||
}
|
||||
|
||||
/// (root password, application password) from `Settings/database.json`.
|
||||
pub(crate) fn credentials(root: &Path) -> Result<(String, String)> {
|
||||
let c: Credentials = fsx::read_json(&root.join("Settings/database.json"))
|
||||
.map_err(|_| Error::Invalid("The database settings of this server could not be read.".into()))?;
|
||||
Ok((c.root_password, c.app_password))
|
||||
}
|
||||
|
||||
impl Db {
|
||||
pub fn from_repack(root: &Path, account: Account) -> Result<Db> {
|
||||
let creds: Credentials = fsx::read_json(&root.join("Settings/database.json"))
|
||||
.map_err(|_| Error::Invalid("The database settings of this server could not be read.".into()))?;
|
||||
let ports: Ports = read_ports(root);
|
||||
if crate::docker::is_docker(root) {
|
||||
return Db::in_container(root, creds, account);
|
||||
}
|
||||
let bin = root.join("mysql/bin");
|
||||
if !bin.join("mysqldump.exe").is_file() || !bin.join("mysql.exe").is_file() {
|
||||
return Err(Error::Invalid("The bundled database tools are missing.".into()));
|
||||
@@ -90,10 +104,24 @@ impl Db {
|
||||
Account::Admin => ("root", creds.root_password),
|
||||
Account::App => ("acore", creds.app_password),
|
||||
};
|
||||
Ok(Db { bin, port: ports.mysql, user, password: Secret(password), realm: crate::realms::state(root)?.active })
|
||||
Ok(Db { bin, port: ports.mysql, user, password: Secret(password), realm: crate::realms::state(root)?.active, container: None })
|
||||
}
|
||||
|
||||
/// The database of a Docker installation: the client tools of the database image, run with `docker exec`. The
|
||||
/// database is not published on the host, so nothing about this depends on a port or on tools installed here.
|
||||
fn in_container(root: &Path, creds: Credentials, account: Account) -> Result<Db> {
|
||||
let container = crate::docker::Config::load(root)?.database_container();
|
||||
let (user, password) = match account {
|
||||
Account::Admin => ("root", creds.root_password),
|
||||
Account::App => ("acore", creds.app_password),
|
||||
};
|
||||
// Inside the container the server listens on its standard port; the commands below connect to it over TCP on
|
||||
// the container's own loopback, exactly like the commands of a repack do on the host.
|
||||
Ok(Db { bin: PathBuf::new(), port: 3306, user, password: Secret(password), realm: crate::realms::state(root)?.active, container: Some(container) })
|
||||
}
|
||||
|
||||
pub fn for_realm(mut self, realm: crate::realms::Mode) -> Self { self.realm = realm; self }
|
||||
pub fn realm(&self) -> crate::realms::Mode { self.realm }
|
||||
|
||||
pub fn realm_schema<'a>(&self, name: &'a str) -> &'a str {
|
||||
if self.realm == crate::realms::Mode::Wildcard {
|
||||
@@ -125,7 +153,15 @@ impl Db {
|
||||
}
|
||||
|
||||
fn command(&self, tool: &str) -> Command {
|
||||
let mut c = Command::new(self.bin.join(tool));
|
||||
let mut c = match &self.container {
|
||||
None => Command::new(self.bin.join(tool)),
|
||||
Some(name) => {
|
||||
// `-e MYSQL_PWD` without a value takes it from this process's environment: never on a command line.
|
||||
let mut c = Command::new("docker");
|
||||
c.args(["exec", "-i", "-e", "MYSQL_PWD", name, tool.trim_end_matches(".exe")]);
|
||||
c
|
||||
}
|
||||
};
|
||||
c.env("MYSQL_PWD", self.password.expose())
|
||||
.arg("--protocol=tcp")
|
||||
.arg("--host=127.0.0.1")
|
||||
@@ -140,7 +176,8 @@ impl Db {
|
||||
|
||||
fn fail(&self, stderr: &[u8]) -> Error {
|
||||
let text = String::from_utf8_lossy(stderr);
|
||||
let code = if text.contains("2003") || text.contains("Can't connect") { ErrorCode::DatabaseNotRunning } else { ErrorCode::Unknown };
|
||||
let down = text.contains("2003") || text.contains("Can't connect") || text.contains("is not running") || text.contains("No such container");
|
||||
let code = if down { ErrorCode::DatabaseNotRunning } else { ErrorCode::Unknown };
|
||||
match code {
|
||||
ErrorCode::DatabaseNotRunning => Error::Invalid("The database is not running. Start the server first.".into()),
|
||||
_ => Error::Invalid(format!("database command failed: {}", text.trim().lines().last().unwrap_or(""))),
|
||||
@@ -372,3 +409,86 @@ mod realm_tests {
|
||||
assert_eq!(route_sql(sql, crate::realms::Mode::Wildcard), "SELECT * FROM `acore_characters_wildcard`.characters WHERE name='acore_world' AND x=\"acore_characters\"; -- acore_world\nSELECT * FROM acore_world_wildcard.items;");
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::ffi::OsStr;
|
||||
|
||||
const ROOT_PW: &str = "rootpw-ZZ1";
|
||||
const APP_PW: &str = "apppw-QQ2";
|
||||
|
||||
fn folder(docker: bool) -> (tempfile::TempDir, PathBuf) {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("srv");
|
||||
std::fs::create_dir_all(root.join("Settings")).unwrap();
|
||||
std::fs::write(root.join("Settings/database.json"), format!(r#"{{"rootPassword":"{ROOT_PW}","appPassword":"{APP_PW}"}}"#)).unwrap();
|
||||
if docker {
|
||||
std::fs::write(root.join("Settings/docker.json"), r#"{"project":"t1"}"#).unwrap();
|
||||
}
|
||||
(d, root)
|
||||
}
|
||||
|
||||
fn args(c: &Command) -> Vec<String> {
|
||||
c.get_args().map(|a| a.to_string_lossy().into_owned()).collect()
|
||||
}
|
||||
|
||||
fn env_of(c: &Command, key: &str) -> Option<String> {
|
||||
c.get_envs().find(|(k, _)| *k == OsStr::new(key)).and_then(|(_, v)| v.map(|v| v.to_string_lossy().into_owned()))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_docker_installation_runs_the_client_tools_inside_the_database_container() {
|
||||
let (_d, root) = folder(true);
|
||||
let db = Db::from_repack(&root, Account::Admin).unwrap();
|
||||
for (tool, program) in [("mysql.exe", "mysql"), ("mysqldump.exe", "mysqldump"), ("mysqladmin.exe", "mysqladmin")] {
|
||||
let c = db.command(tool);
|
||||
assert_eq!(c.get_program(), "docker");
|
||||
let a = args(&c);
|
||||
assert_eq!(&a[..6], ["exec", "-i", "-e", "MYSQL_PWD", "coa-t1-db", program]);
|
||||
assert!(a.contains(&"--protocol=tcp".to_string()) && a.contains(&"--host=127.0.0.1".to_string()) && a.contains(&"--port=3306".to_string()));
|
||||
assert!(a.contains(&"--user=root".to_string()));
|
||||
assert!(a.iter().all(|x| !x.contains(ROOT_PW)), "the password must not be on the command line");
|
||||
assert_eq!(env_of(&c, "MYSQL_PWD").as_deref(), Some(ROOT_PW));
|
||||
}
|
||||
let app = Db::from_repack(&root, Account::App).unwrap().command("mysql.exe");
|
||||
assert!(args(&app).contains(&"--user=acore".to_string()));
|
||||
assert_eq!(env_of(&app, "MYSQL_PWD").as_deref(), Some(APP_PW));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_repack_still_uses_its_bundled_tools_on_the_host() {
|
||||
let (_d, root) = folder(false);
|
||||
std::fs::create_dir_all(root.join("mysql/bin")).unwrap();
|
||||
for f in ["mysql.exe", "mysqldump.exe"] {
|
||||
std::fs::write(root.join("mysql/bin").join(f), b"x").unwrap();
|
||||
}
|
||||
std::fs::write(root.join("Settings/repack.json"), r#"{"mysqlPort":3999}"#).unwrap();
|
||||
let c = Db::from_repack(&root, Account::Admin).unwrap().command("mysql.exe");
|
||||
assert_eq!(c.get_program(), root.join("mysql/bin").join("mysql.exe").as_os_str());
|
||||
let a = args(&c);
|
||||
assert!(!a.contains(&"exec".to_string()));
|
||||
assert!(a.contains(&"--port=3999".to_string()) && a.contains(&"--host=127.0.0.1".to_string()));
|
||||
assert_eq!(env_of(&c, "MYSQL_PWD").as_deref(), Some(ROOT_PW));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_docker_installation_does_not_need_tools_in_the_server_folder() {
|
||||
let (_d, root) = folder(true);
|
||||
assert!(!root.join("mysql").exists());
|
||||
assert!(Db::from_repack(&root, Account::Admin).is_ok());
|
||||
// ...but a broken Docker settings file is reported, not ignored.
|
||||
std::fs::write(root.join("Settings/docker.json"), r#"{"project":"Bad Name"}"#).unwrap();
|
||||
assert!(Db::from_repack(&root, Account::Admin).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_stopped_database_container_is_reported_as_a_database_that_is_not_running() {
|
||||
let (_d, root) = folder(true);
|
||||
let db = Db::from_repack(&root, Account::Admin).unwrap();
|
||||
for text in ["Error response from daemon: container abc is not running", "Error response from daemon: No such container: coa-t1-db", "ERROR 2003 (HY000): Can't connect to MySQL server"] {
|
||||
assert!(db.fail(text.as_bytes()).to_string().contains("not running"), "{text}");
|
||||
}
|
||||
assert!(db.fail(b"ERROR 1045 (28000): Access denied for user 'root'").to_string().contains("Access denied"));
|
||||
}
|
||||
}
|
||||
@@ -64,7 +64,9 @@ pub fn run(root: &Path, meta: &InstallMeta) -> Report {
|
||||
|
||||
let ports = layout::read_ports(root);
|
||||
let o = process::observe(root, &ports);
|
||||
for (title, s) in [("Database", &o.mysql), ("Login server", &o.auth), ("World server", &o.world)] {
|
||||
let mut services = vec![("Database", &o.mysql), ("Login server", &o.auth), ("World server", &o.world)];
|
||||
if let Some(second) = &o.secondary_world { services.push(("Second world", second)); }
|
||||
for (title, s) in services {
|
||||
let (lvl, text) = match (s.state, &s.conflict) {
|
||||
(ServiceState::Running, _) => (Level::Ok, "Running".to_string()),
|
||||
(_, Some(conf)) => (Level::Fail, format!("Port {} is used by another program (process {}).", conf.port, conf.pid)),
|
||||
@@ -124,6 +126,8 @@ pub struct FileProblem {
|
||||
pub fn verify_managed(root: &Path, meta: &InstallMeta) -> Vec<FileProblem> {
|
||||
let mut out = Vec::new();
|
||||
for (rel, want) in &meta.original_hashes {
|
||||
let lower = rel.replace('\\', "/").to_lowercase();
|
||||
if lower.starts_with("mysql/data/") || lower.starts_with("settings/") || lower.starts_with("core/configs/") && !lower.ends_with(".dist") { continue; }
|
||||
let Ok(p) = fsx::safe_join(root, rel) else { continue };
|
||||
match fsx::sha256_file(&p) {
|
||||
Err(_) => out.push(FileProblem { path: rel.clone(), kind: "missing" }),
|
||||
@@ -195,6 +199,7 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
|
||||
"manager": crate::MANAGER_VERSION,
|
||||
"core": meta.core,
|
||||
"bots": meta.bots,
|
||||
"squid_bots": crate::squid::release(root),
|
||||
"kind": meta.kind,
|
||||
"layout": meta.layout,
|
||||
"checks": report.checks,
|
||||
@@ -241,6 +246,9 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
|
||||
if let Ok(b) = fs::read(root.join("RELEASE.json")) {
|
||||
add("RELEASE.json", redact(&String::from_utf8_lossy(&b)).as_bytes())?;
|
||||
}
|
||||
if let Ok(b) = fs::read(meta_dir.join("logs/database-checks.json")) {
|
||||
add("database-checks.json", redact(&String::from_utf8_lossy(&b)).as_bytes())?;
|
||||
}
|
||||
zip.finish().map_err(|e| Error::Invalid(e.to_string()))?;
|
||||
Ok(n)
|
||||
}
|
||||
@@ -316,6 +324,8 @@ real error
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("srv");
|
||||
layout::testkit::fake_repack(&root);
|
||||
fs::create_dir_all(root.join("Extras/SquidPlayerbots")).unwrap();
|
||||
fs::write(root.join("Extras/SquidPlayerbots/release.json"), r#"{"tag":"v1.8","commit":"48c4786a","password":"upstream-secret"}"#).unwrap();
|
||||
fs::write(root.join("Core/Logs/Errors.log"), "boom\nDatabase password=hunter2 rejected\n").unwrap();
|
||||
fs::write(root.join("Core/configs/worldserver.conf"), "LoginDatabaseInfo = \"127.0.0.1;3307;acore;SECRETPW;auth\"\nRate.XP.Kill = 1\n").unwrap();
|
||||
let meta_dir = d.path().join("srv.manager");
|
||||
@@ -333,6 +343,7 @@ real error
|
||||
all.push_str(&s);
|
||||
}
|
||||
assert!(all.contains("boom") && all.contains("Rate.XP.Kill"), "keys and ordinary log lines are included");
|
||||
assert!(!all.contains("hunter2") && !all.contains("SECRETPW"));
|
||||
assert!(all.contains("v1.8") && all.contains("48c4786a"));
|
||||
assert!(!all.contains("hunter2") && !all.contains("SECRETPW") && !all.contains("upstream-secret"));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
# Runtime image of the CoA server. It holds only the shared libraries the server binaries need (checked with ldd on
|
||||
# Ubuntu 26.04: libmysqlclient24, ICU 78, ncurses 6 and readline 8); the binaries themselves are mounted from the
|
||||
# server folder, so an update replaces files and does not rebuild this image.
|
||||
FROM ubuntu:26.04
|
||||
RUN apt-get update \
|
||||
&& apt-get install -y --no-install-recommends libmysqlclient24 libicu78 libncurses6 libreadline8t64 \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
@@ -0,0 +1,151 @@
|
||||
//! The one place that runs the `docker` command line. Everything else talks to the `Docker` trait, so the logic can
|
||||
//! be tested without Docker. Only the `docker` client is needed on the computer (no `docker compose`).
|
||||
|
||||
use std::io::{Read, Write};
|
||||
use std::net::{SocketAddr, TcpStream};
|
||||
use std::process::{Command, Stdio};
|
||||
use std::time::{Duration, Instant};
|
||||
|
||||
use crate::error::{Error, Result};
|
||||
|
||||
#[derive(Debug, Clone, Default)]
|
||||
pub struct Output {
|
||||
/// None when the command timed out.
|
||||
pub code: Option<i32>,
|
||||
pub stdout: String,
|
||||
pub stderr: String,
|
||||
}
|
||||
|
||||
impl Output {
|
||||
pub fn ok(&self) -> bool {
|
||||
self.code == Some(0)
|
||||
}
|
||||
|
||||
/// stdout and stderr, trimmed, for the technical details shown to the user.
|
||||
pub fn text(&self) -> String {
|
||||
format!("{}\n{}", self.stdout.trim(), self.stderr.trim()).trim().to_string()
|
||||
}
|
||||
}
|
||||
|
||||
/// What to run. `env` is where secrets go: a container option `-e NAME` (without a value) copies it from the
|
||||
/// environment of the docker client, so a password never appears on a command line.
|
||||
pub struct Call<'a> {
|
||||
pub args: Vec<String>,
|
||||
pub env: Vec<(String, String)>,
|
||||
pub stdin: Option<&'a [u8]>,
|
||||
pub timeout: Duration,
|
||||
}
|
||||
|
||||
impl<'a> Call<'a> {
|
||||
pub fn new(args: &[&str], timeout: Duration) -> Call<'a> {
|
||||
Call { args: args.iter().map(|a| a.to_string()).collect(), env: Vec::new(), stdin: None, timeout }
|
||||
}
|
||||
}
|
||||
|
||||
pub trait Docker {
|
||||
/// Err only when `docker` cannot be started at all (not installed).
|
||||
fn run(&self, call: &Call) -> Result<Output>;
|
||||
|
||||
/// Is a server really listening on this address? Docker's own proxy accepts connections on a published port even
|
||||
/// when nothing listens inside the container, and closes them at once; so a connection that stays open (or gets
|
||||
/// data, as the world server's greeting) is the proof, a connect alone is not.
|
||||
fn port_open(&self, addr: SocketAddr) -> bool {
|
||||
let Ok(mut s) = TcpStream::connect_timeout(&addr, Duration::from_millis(400)) else { return false };
|
||||
let _ = s.set_read_timeout(Some(Duration::from_millis(300)));
|
||||
match s.read(&mut [0u8; 1]) {
|
||||
Ok(0) => false,
|
||||
Ok(_) => true,
|
||||
Err(e) => matches!(e.kind(), std::io::ErrorKind::WouldBlock | std::io::ErrorKind::TimedOut),
|
||||
}
|
||||
}
|
||||
|
||||
fn pause(&self, d: Duration) {
|
||||
std::thread::sleep(d);
|
||||
}
|
||||
}
|
||||
|
||||
pub struct SystemDocker;
|
||||
|
||||
impl Docker for SystemDocker {
|
||||
fn run(&self, call: &Call) -> Result<Output> {
|
||||
let mut cmd = Command::new("docker");
|
||||
cmd.args(&call.args).envs(call.env.iter().map(|(k, v)| (k, v))).stdout(Stdio::piped()).stderr(Stdio::piped());
|
||||
cmd.stdin(if call.stdin.is_some() { Stdio::piped() } else { Stdio::null() });
|
||||
#[cfg(windows)]
|
||||
{
|
||||
use std::os::windows::process::CommandExt;
|
||||
cmd.creation_flags(0x0800_0000); // CREATE_NO_WINDOW
|
||||
}
|
||||
let mut child = cmd.spawn().map_err(|e| Error::Invalid(format!("docker could not be started: {e}")))?;
|
||||
if let (Some(data), Some(mut stdin)) = (call.stdin, child.stdin.take()) {
|
||||
// Closing stdin at the end of this block tells docker the input is complete.
|
||||
let _ = stdin.write_all(data);
|
||||
}
|
||||
let mut out = child.stdout.take().expect("piped");
|
||||
let mut err = child.stderr.take().expect("piped");
|
||||
let out_t = std::thread::spawn(move || {
|
||||
let mut s = String::new();
|
||||
let _ = out.read_to_string(&mut s);
|
||||
s
|
||||
});
|
||||
let err_t = std::thread::spawn(move || {
|
||||
let mut s = String::new();
|
||||
let _ = err.read_to_string(&mut s);
|
||||
s
|
||||
});
|
||||
let deadline = Instant::now() + call.timeout;
|
||||
let code = loop {
|
||||
if let Some(st) = child.try_wait()? {
|
||||
break st.code();
|
||||
}
|
||||
if Instant::now() > deadline {
|
||||
// Only the docker client is stopped; the containers it started keep running.
|
||||
let _ = child.kill();
|
||||
let _ = child.wait();
|
||||
break None;
|
||||
}
|
||||
std::thread::sleep(Duration::from_millis(50));
|
||||
};
|
||||
Ok(Output { code, stdout: out_t.join().unwrap_or_default(), stderr: err_t.join().unwrap_or_default() })
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::net::TcpListener;
|
||||
|
||||
#[test]
|
||||
fn a_published_port_with_nothing_behind_it_does_not_count_as_open() {
|
||||
let sys = SystemDocker;
|
||||
// Closed port.
|
||||
let closed = TcpListener::bind("127.0.0.1:0").unwrap();
|
||||
let closed_addr = closed.local_addr().unwrap();
|
||||
drop(closed);
|
||||
assert!(!sys.port_open(closed_addr));
|
||||
// Like docker-proxy without a backend: accepts, then closes at once.
|
||||
let proxy = TcpListener::bind("127.0.0.1:0").unwrap();
|
||||
let proxy_addr = proxy.local_addr().unwrap();
|
||||
let t = std::thread::spawn(move || drop(proxy.accept().unwrap()));
|
||||
assert!(!sys.port_open(proxy_addr));
|
||||
t.join().unwrap();
|
||||
// A server that waits for the client (auth server) and one that greets first (world server).
|
||||
let quiet = TcpListener::bind("127.0.0.1:0").unwrap();
|
||||
let quiet_addr = quiet.local_addr().unwrap();
|
||||
let t = std::thread::spawn(move || {
|
||||
let (_s, _) = quiet.accept().unwrap();
|
||||
std::thread::sleep(Duration::from_millis(700));
|
||||
});
|
||||
assert!(sys.port_open(quiet_addr));
|
||||
t.join().unwrap();
|
||||
let greeter = TcpListener::bind("127.0.0.1:0").unwrap();
|
||||
let greeter_addr = greeter.local_addr().unwrap();
|
||||
let t = std::thread::spawn(move || {
|
||||
let (mut s, _) = greeter.accept().unwrap();
|
||||
s.write_all(b"hello").unwrap();
|
||||
std::thread::sleep(Duration::from_millis(400));
|
||||
});
|
||||
assert!(sys.port_open(greeter_addr));
|
||||
t.join().unwrap();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,913 @@
|
||||
//! Start, stop and observe the three containers of a Docker installation.
|
||||
//!
|
||||
//! Start order matters: the database must be healthy before the game servers, and the world server must be listening
|
||||
//! before the auth server, because the auth server refuses to run while no realm is online.
|
||||
|
||||
use std::collections::HashMap;
|
||||
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
|
||||
use std::path::Path;
|
||||
use std::time::Duration;
|
||||
|
||||
use serde_json::Value;
|
||||
|
||||
use super::cli::{Call, Docker, SystemDocker};
|
||||
use super::{runtime_image, Config, Names, RUNTIME_DOCKERFILE};
|
||||
use crate::driver::{DriverOutcome, Verb};
|
||||
use crate::error::{ErrorCode, Result};
|
||||
use crate::layout::{read_ports, Ports};
|
||||
use crate::process::{Observed, ServiceState, ServiceStatus};
|
||||
|
||||
/// Where the server folder and the game data appear inside the containers.
|
||||
const CORE: &str = "/srv/core";
|
||||
const DATA: &str = "/srv/data";
|
||||
/// Fixed ports inside the containers; the host side comes from `Settings/repack.json`.
|
||||
const AUTH_PORT: u16 = 3724;
|
||||
const WORLD_PORT: u16 = 8085;
|
||||
const RA_PORT: u16 = 3443;
|
||||
|
||||
const QUICK: Duration = Duration::from_secs(20);
|
||||
const POLL: Duration = Duration::from_secs(1);
|
||||
const DB_WAIT: u32 = 120;
|
||||
const WORLD_WAIT: u32 = 300;
|
||||
const AUTH_WAIT: u32 = 60;
|
||||
|
||||
struct Failure {
|
||||
code: ErrorCode,
|
||||
output: String,
|
||||
}
|
||||
|
||||
type Step<T> = std::result::Result<T, Failure>;
|
||||
|
||||
#[derive(Default)]
|
||||
struct Log(Vec<String>);
|
||||
|
||||
impl Log {
|
||||
fn say(&mut self, line: impl Into<String>) {
|
||||
self.0.push(line.into());
|
||||
}
|
||||
}
|
||||
|
||||
fn fail<T>(code: ErrorCode, output: impl Into<String>) -> Step<T> {
|
||||
Err(Failure { code, output: output.into() })
|
||||
}
|
||||
|
||||
pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
|
||||
run_with(&SystemDocker, root, verb)
|
||||
}
|
||||
|
||||
pub fn run_with(d: &dyn Docker, root: &Path, verb: Verb) -> Result<DriverOutcome> {
|
||||
let cfg = Config::load(root)?;
|
||||
let mut log = Log::default();
|
||||
let result = match verb {
|
||||
Verb::StartWorld => return Err(crate::Error::Invalid("Starting a secondary world is not supported for Docker servers.".into())),
|
||||
Verb::StartAll => start(d, root, &cfg, true, &mut log),
|
||||
Verb::StartMysql => start(d, root, &cfg, false, &mut log),
|
||||
Verb::StopAll => stop(d, &cfg, &mut log),
|
||||
};
|
||||
Ok(match result {
|
||||
Ok(()) => DriverOutcome { ok: true, exit_code: Some(0), code: None, human: None, output: log.0.join("\n") },
|
||||
Err(f) => {
|
||||
log.say(f.output);
|
||||
DriverOutcome { ok: false, exit_code: None, code: Some(f.code), human: Some(f.code.human()), output: log.0.join("\n") }
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------------------------------- docker calls
|
||||
|
||||
/// Run docker; only "docker cannot be started" is an error here, a non-zero exit is returned for the caller to judge.
|
||||
fn docker(d: &dyn Docker, args: &[&str], timeout: Duration) -> Step<super::cli::Output> {
|
||||
d.run(&Call::new(args, timeout)).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))
|
||||
}
|
||||
|
||||
fn preflight(d: &dyn Docker, log: &mut Log) -> Step<()> {
|
||||
let o = docker(d, &["version", "--format", "{{.Server.Version}}"], QUICK)?;
|
||||
if !o.ok() {
|
||||
// Typical causes: the service is stopped, or the user is not allowed to talk to it.
|
||||
return fail(ErrorCode::DockerUnavailable, o.text());
|
||||
}
|
||||
log.say(format!("docker {}", o.stdout.trim()));
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq)]
|
||||
pub(crate) struct Container {
|
||||
pub status: String,
|
||||
pub exit_code: i64,
|
||||
pub oom_killed: bool,
|
||||
pub pid: Option<u32>,
|
||||
pub started_at: Option<String>,
|
||||
/// "healthy", "unhealthy" or "starting" when the container has a health check.
|
||||
pub health: Option<String>,
|
||||
}
|
||||
|
||||
impl Container {
|
||||
fn running(&self) -> bool {
|
||||
self.status == "running"
|
||||
}
|
||||
}
|
||||
|
||||
/// State of the named containers that exist (the others are simply absent from the result).
|
||||
fn inspect(d: &dyn Docker, names: &[&str]) -> Step<HashMap<String, Container>> {
|
||||
let mut args = vec!["inspect"];
|
||||
args.extend_from_slice(names);
|
||||
let o = docker(d, &args, QUICK)?;
|
||||
// docker prints what it found and complains about the rest with a non-zero exit code.
|
||||
let found = parse_inspect(&o.stdout);
|
||||
if !o.ok() && found.is_empty() && !o.stderr.contains("No such object") && !o.stderr.contains("no such object") {
|
||||
return fail(ErrorCode::DockerUnavailable, o.text());
|
||||
}
|
||||
Ok(found)
|
||||
}
|
||||
|
||||
pub(crate) fn parse_inspect(json: &str) -> HashMap<String, Container> {
|
||||
let Ok(Value::Array(items)) = serde_json::from_str::<Value>(json) else { return HashMap::new() };
|
||||
items
|
||||
.iter()
|
||||
.filter_map(|v| {
|
||||
let name = v["Name"].as_str()?.trim_start_matches('/').to_string();
|
||||
let s = &v["State"];
|
||||
Some((
|
||||
name,
|
||||
Container {
|
||||
status: s["Status"].as_str()?.to_string(),
|
||||
exit_code: s["ExitCode"].as_i64().unwrap_or(0),
|
||||
oom_killed: s["OOMKilled"].as_bool().unwrap_or(false),
|
||||
pid: s["Pid"].as_u64().filter(|p| *p > 0).map(|p| p as u32),
|
||||
started_at: s["StartedAt"].as_str().map(str::to_string),
|
||||
health: s["Health"]["Status"].as_str().map(str::to_string),
|
||||
},
|
||||
))
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
fn strip_ansi(s: &str) -> String {
|
||||
let mut out = String::with_capacity(s.len());
|
||||
let mut chars = s.chars().peekable();
|
||||
while let Some(c) = chars.next() {
|
||||
if c == '\u{1b}' && chars.peek() == Some(&'[') {
|
||||
for n in chars.by_ref() {
|
||||
if n.is_ascii_alphabetic() {
|
||||
break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
out.push(c);
|
||||
}
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
/// Last lines a container wrote, as the technical details of a failure, and the cause they point to.
|
||||
fn why_stopped(d: &dyn Docker, name: &str) -> (ErrorCode, String) {
|
||||
let text = d.run(&Call::new(&["logs", "--tail", "60", name], QUICK)).map(|o| strip_ansi(&o.text())).unwrap_or_default();
|
||||
(crate::health::diagnose(&text).unwrap_or(ErrorCode::StartupFailed), format!("--- last lines of {name}\n{text}"))
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------------------------------------------ start
|
||||
|
||||
struct Secrets {
|
||||
root: String,
|
||||
app: String,
|
||||
}
|
||||
|
||||
fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut Log) -> Step<()> {
|
||||
preflight(d, log)?;
|
||||
let n = cfg.names();
|
||||
let secrets = crate::db::credentials(root).map(|(root, app)| Secrets { root, app }).or_else(|e| fail(ErrorCode::ServerFilesIncomplete, e.to_string()))?;
|
||||
let ports = read_ports(root);
|
||||
let state = inspect(d, &[&n.db, &n.world, &n.auth])?;
|
||||
|
||||
if !docker(d, &["network", "inspect", &n.network], QUICK)?.ok() {
|
||||
let o = docker(d, &["network", "create", &n.network], QUICK)?;
|
||||
if !o.ok() {
|
||||
return fail(ErrorCode::StartupFailed, o.text());
|
||||
}
|
||||
log.say(format!("created network {}", n.network));
|
||||
}
|
||||
|
||||
if !state.get(&n.db).is_some_and(Container::running) {
|
||||
remove(d, &n.db);
|
||||
let mut call = Call::new(&[], Duration::from_secs(120));
|
||||
call.args = db_args(cfg, &n);
|
||||
call.env = vec![("MYSQL_ROOT_PASSWORD".into(), secrets.root.clone())];
|
||||
let o = d.run(&call).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))?;
|
||||
if !o.ok() {
|
||||
return fail(ErrorCode::StartupFailed, o.text());
|
||||
}
|
||||
log.say(format!("started {}", n.db));
|
||||
}
|
||||
wait_database(d, &n, log)?;
|
||||
if !with_game {
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
ensure_image(d, log)?;
|
||||
std::fs::create_dir_all(root.join("Core/Logs")).map_err(|e| Failure { code: ErrorCode::ServerFilesIncomplete, output: e.to_string() })?;
|
||||
let owner = owner_of(root);
|
||||
let host = std::fs::canonicalize(root).unwrap_or_else(|_| root.to_path_buf());
|
||||
let host = crate::fsx::canonicalize_lenient(&host).unwrap_or(host);
|
||||
|
||||
if !state.get(&n.world).is_some_and(Container::running) {
|
||||
remove(d, &n.world);
|
||||
let mut call = Call::new(&[], Duration::from_secs(60));
|
||||
call.args = game_args(cfg, &n, GameKind::World, &host, ports.world, ports.ra, owner.as_deref());
|
||||
call.env = database_env(&secrets, true);
|
||||
run_container(d, &call, &n.world, log)?;
|
||||
}
|
||||
wait_listening(d, cfg, &n.world, ports.world, WORLD_WAIT, log)?;
|
||||
|
||||
if !state.get(&n.auth).is_some_and(Container::running) {
|
||||
remove(d, &n.auth);
|
||||
let mut call = Call::new(&[], Duration::from_secs(60));
|
||||
call.args = game_args(cfg, &n, GameKind::Auth, &host, ports.auth, 0, owner.as_deref());
|
||||
call.env = database_env(&secrets, false);
|
||||
run_container(d, &call, &n.auth, log)?;
|
||||
}
|
||||
wait_listening(d, cfg, &n.auth, ports.auth, AUTH_WAIT, log)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn remove(d: &dyn Docker, name: &str) {
|
||||
// A stopped container of the same name is replaced, so its settings always match the files on disk.
|
||||
let _ = d.run(&Call::new(&["rm", "-f", name], QUICK));
|
||||
}
|
||||
|
||||
fn run_container(d: &dyn Docker, call: &Call, name: &str, log: &mut Log) -> Step<()> {
|
||||
let o = d.run(call).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))?;
|
||||
if !o.ok() {
|
||||
let text = o.text();
|
||||
let code = if text.contains("port is already allocated") || text.contains("address already in use") { ErrorCode::PortInUse } else { ErrorCode::StartupFailed };
|
||||
return fail(code, text);
|
||||
}
|
||||
log.say(format!("started {name}"));
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn ensure_image(d: &dyn Docker, log: &mut Log) -> Step<()> {
|
||||
let image = runtime_image();
|
||||
if docker(d, &["image", "inspect", &image], QUICK)?.ok() {
|
||||
return Ok(());
|
||||
}
|
||||
log.say(format!("building {image} (first start only)"));
|
||||
let mut call = Call::new(&["build", "--tag", &image, "-"], Duration::from_secs(900));
|
||||
call.stdin = Some(RUNTIME_DOCKERFILE.as_bytes());
|
||||
let o = d.run(&call).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))?;
|
||||
if !o.ok() {
|
||||
return fail(ErrorCode::StartupFailed, o.text());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn wait_database(d: &dyn Docker, n: &Names, log: &mut Log) -> Step<()> {
|
||||
for _ in 0..DB_WAIT {
|
||||
let state = inspect(d, &[&n.db])?;
|
||||
match state.get(&n.db) {
|
||||
Some(c) if c.running() && c.health.as_deref() == Some("healthy") => {
|
||||
log.say("database is ready");
|
||||
return Ok(());
|
||||
}
|
||||
Some(c) if !c.running() => {
|
||||
let (code, text) = why_stopped(d, &n.db);
|
||||
return fail(if code == ErrorCode::StartupFailed { ErrorCode::DatabaseNotRunning } else { code }, text);
|
||||
}
|
||||
None => return fail(ErrorCode::DatabaseNotRunning, "the database container does not exist"),
|
||||
_ => d.pause(POLL),
|
||||
}
|
||||
}
|
||||
fail(ErrorCode::DatabaseNotRunning, "the database did not become ready in time")
|
||||
}
|
||||
|
||||
/// Wait until the container accepts connections on its published port; give up when it stops or on timeout.
|
||||
fn wait_listening(d: &dyn Docker, cfg: &Config, name: &str, port: u16, seconds: u32, log: &mut Log) -> Step<()> {
|
||||
let addr = SocketAddr::new(connect_ip(cfg), port);
|
||||
for _ in 0..seconds {
|
||||
let state = inspect(d, &[name])?;
|
||||
match state.get(name) {
|
||||
Some(c) if c.running() => {
|
||||
if d.port_open(addr) {
|
||||
log.say(format!("{name} is listening on port {port}"));
|
||||
return Ok(());
|
||||
}
|
||||
d.pause(POLL);
|
||||
}
|
||||
_ => {
|
||||
let (code, text) = why_stopped(d, name);
|
||||
return fail(code, text);
|
||||
}
|
||||
}
|
||||
}
|
||||
let (code, text) = why_stopped(d, name);
|
||||
fail(code, format!("{name} was not listening on port {port} after {seconds} seconds\n{text}"))
|
||||
}
|
||||
|
||||
/// Address to test a published port on from this computer.
|
||||
fn connect_ip(cfg: &Config) -> IpAddr {
|
||||
match cfg.bind_address.parse::<IpAddr>() {
|
||||
Ok(ip) if !ip.is_unspecified() => ip,
|
||||
_ => IpAddr::V4(Ipv4Addr::LOCALHOST),
|
||||
}
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------------------------------- argument lists
|
||||
|
||||
fn db_args(cfg: &Config, n: &Names) -> Vec<String> {
|
||||
let mut a: Vec<String> = ["run", "--detach", "--name"].iter().map(|s| s.to_string()).collect();
|
||||
a.push(n.db.clone());
|
||||
a.extend(["--network".into(), n.network.clone(), "--network-alias".into(), "db".into()]);
|
||||
a.extend(["--label".into(), format!("coa.project={}", cfg.project)]);
|
||||
a.extend(["--volume".into(), format!("{}:/var/lib/mysql", n.volume)]);
|
||||
// The password comes from the environment of the docker client, not from this command line.
|
||||
a.extend(["--env".into(), "MYSQL_ROOT_PASSWORD".into()]);
|
||||
// "mysqladmin ping" succeeds as soon as the server answers, with or without a login.
|
||||
a.extend(["--health-cmd".into(), "mysqladmin ping --silent".into()]);
|
||||
a.extend(["--health-interval".into(), "5s".into(), "--health-timeout".into(), "5s".into(), "--health-retries".into(), "40".into()]);
|
||||
a.extend(["--stop-timeout".into(), "60".into()]);
|
||||
a.push(cfg.mysql_image.clone());
|
||||
a
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, PartialEq)]
|
||||
enum GameKind {
|
||||
World,
|
||||
Auth,
|
||||
}
|
||||
|
||||
/// Connection strings: host;port;user;password;database. They hold the password, so they travel by environment.
|
||||
fn database_env(s: &Secrets, world: bool) -> Vec<(String, String)> {
|
||||
let info = |db: &str| format!("db;3306;acore;{};{db}", s.app);
|
||||
let mut env = vec![("AC_LOGIN_DATABASE_INFO".to_string(), info("acore_auth"))];
|
||||
if world {
|
||||
env.push(("AC_WORLD_DATABASE_INFO".into(), info("acore_world")));
|
||||
env.push(("AC_CHARACTER_DATABASE_INFO".into(), info("acore_characters")));
|
||||
}
|
||||
env
|
||||
}
|
||||
|
||||
fn game_args(cfg: &Config, n: &Names, kind: GameKind, host: &Path, port: u16, ra_port: u16, owner: Option<&str>) -> Vec<String> {
|
||||
let (name, alias, binary, conf, inner_port) = match kind {
|
||||
GameKind::World => (&n.world, "world", "./worldserver", "configs/worldserver.conf", WORLD_PORT),
|
||||
GameKind::Auth => (&n.auth, "auth", "./authserver", "configs/authserver.conf", AUTH_PORT),
|
||||
};
|
||||
let mut a: Vec<String> = vec!["run".into(), "--detach".into(), "--name".into(), name.clone()];
|
||||
a.extend(["--network".into(), n.network.clone(), "--network-alias".into(), alias.into()]);
|
||||
a.extend(["--label".into(), format!("coa.project={}", cfg.project)]);
|
||||
if let Some(o) = owner {
|
||||
// The server writes logs and configuration into the folder: do it as the person who owns it.
|
||||
a.extend(["--user".into(), o.into()]);
|
||||
}
|
||||
a.extend(["--workdir".into(), CORE.into()]);
|
||||
a.extend(["--volume".into(), format!("{}:{CORE}", host.join("Core").display())]);
|
||||
a.extend(["--publish".into(), format!("{}:{port}:{inner_port}", cfg.bind_address)]);
|
||||
// Settings that must not depend on the configuration files: where things are inside the container, and listening
|
||||
// on every interface of the container (the published address decides who can connect).
|
||||
let env = |k: &str, v: &str| ["--env".to_string(), format!("{k}={v}")];
|
||||
a.extend(env("AC_BIND_IP", "0.0.0.0"));
|
||||
a.extend(env(if kind == GameKind::World { "AC_WORLD_SERVER_PORT" } else { "AC_REALM_SERVER_PORT" }, &inner_port.to_string()));
|
||||
a.extend(env("AC_LOGS_DIR", &format!("{CORE}/Logs")));
|
||||
// The Manager applies database updates itself. The server's own updater would need a `mysql` client program inside
|
||||
// the container and stops the server when it cannot find one.
|
||||
a.extend(env("AC_UPDATES_ENABLE_DATABASES", "0"));
|
||||
if kind == GameKind::World {
|
||||
a.extend(["--volume".into(), format!("{}:{DATA}:ro", host.join("Data").display())]);
|
||||
a.extend(env("AC_DATA_DIR", DATA));
|
||||
// The remote console is only ever reachable from this computer.
|
||||
a.extend(["--publish".into(), format!("127.0.0.1:{ra_port}:{RA_PORT}")]);
|
||||
a.extend(env("AC_RA_ENABLE", "1"));
|
||||
a.extend(env("AC_RA_IP", "0.0.0.0"));
|
||||
a.extend(env("AC_RA_PORT", &RA_PORT.to_string()));
|
||||
// Saving every character can take a while.
|
||||
a.extend(["--stop-timeout".into(), "180".into()]);
|
||||
a.extend(["--env".into(), "AC_WORLD_DATABASE_INFO".into(), "--env".into(), "AC_CHARACTER_DATABASE_INFO".into()]);
|
||||
} else {
|
||||
a.extend(["--restart".into(), "on-failure:3".into(), "--stop-timeout".into(), "30".into()]);
|
||||
}
|
||||
a.extend(["--env".into(), "AC_LOGIN_DATABASE_INFO".into()]);
|
||||
a.push(runtime_image());
|
||||
a.extend([binary.to_string(), "-c".into(), conf.into()]);
|
||||
a
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
fn owner_of(root: &Path) -> Option<String> {
|
||||
use std::os::unix::fs::MetadataExt;
|
||||
let m = std::fs::metadata(root).ok()?;
|
||||
Some(format!("{}:{}", m.uid(), m.gid()))
|
||||
}
|
||||
|
||||
#[cfg(not(unix))]
|
||||
fn owner_of(_root: &Path) -> Option<String> {
|
||||
None
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------------------------------------------- stop
|
||||
|
||||
fn stop(d: &dyn Docker, cfg: &Config, log: &mut Log) -> Step<()> {
|
||||
preflight(d, log)?;
|
||||
let n = cfg.names();
|
||||
let state = inspect(d, &[&n.db, &n.world, &n.auth])?;
|
||||
// Game servers first, the database last. The world server gets time to save every character.
|
||||
for (name, seconds) in [(&n.world, 180u64), (&n.auth, 30), (&n.db, 60)] {
|
||||
if state.get(name).is_some_and(Container::running) {
|
||||
let t = seconds.to_string();
|
||||
let o = docker(d, &["stop", "--time", &t, name], Duration::from_secs(seconds + 30))?;
|
||||
if !o.ok() {
|
||||
return fail(ErrorCode::StartupFailed, o.text());
|
||||
}
|
||||
log.say(format!("stopped {name}"));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------------------------------------- observe
|
||||
|
||||
pub fn observe(root: &Path, ports: &Ports) -> Observed {
|
||||
observe_with(&SystemDocker, root, ports)
|
||||
}
|
||||
|
||||
pub fn observe_with(d: &dyn Docker, root: &Path, ports: &Ports) -> Observed {
|
||||
let unknown = |name: &'static str, port: u16| ServiceStatus { name, state: ServiceState::Unknown, pid: None, port, port_ready: false, conflict: None, uptime_secs: None };
|
||||
let Ok(cfg) = Config::load(root) else {
|
||||
return Observed { mysql: unknown("mysql", ports.mysql), auth: unknown("auth", ports.auth), world: unknown("world", ports.world), secondary_world: None };
|
||||
};
|
||||
let n = cfg.names();
|
||||
let Ok(state) = inspect(d, &[&n.db, &n.world, &n.auth]) else {
|
||||
return Observed { mysql: unknown("mysql", ports.mysql), auth: unknown("auth", ports.auth), world: unknown("world", ports.world), secondary_world: None };
|
||||
};
|
||||
let ip = connect_ip(&cfg);
|
||||
let listening = |c: Option<&Container>, port: u16| c.is_some_and(Container::running) && d.port_open(SocketAddr::new(ip, port));
|
||||
Observed {
|
||||
mysql: status("mysql", state.get(&n.db), ports.mysql, state.get(&n.db).is_some_and(|c| c.health.as_deref() == Some("healthy"))),
|
||||
auth: status("auth", state.get(&n.auth), ports.auth, listening(state.get(&n.auth), ports.auth)),
|
||||
world: status("world", state.get(&n.world), ports.world, listening(state.get(&n.world), ports.world)),
|
||||
secondary_world: None,
|
||||
}
|
||||
}
|
||||
|
||||
fn status(name: &'static str, c: Option<&Container>, port: u16, ready: bool) -> ServiceStatus {
|
||||
let Some(c) = c else {
|
||||
return ServiceStatus { name, state: ServiceState::Stopped, pid: None, port, port_ready: false, conflict: None, uptime_secs: None };
|
||||
};
|
||||
let state = match c.status.as_str() {
|
||||
"running" if ready => ServiceState::Running,
|
||||
"running" | "created" | "restarting" => ServiceState::Starting,
|
||||
// Stopped by `docker stop` (SIGTERM, then SIGKILL after the grace period) is a normal stop; anything else is a crash.
|
||||
"exited" if c.exit_code == 0 || ((c.exit_code == 137 || c.exit_code == 143) && !c.oom_killed) => ServiceState::Stopped,
|
||||
"exited" => ServiceState::Crashed,
|
||||
_ => ServiceState::Unknown,
|
||||
};
|
||||
let running = c.running();
|
||||
ServiceStatus {
|
||||
name,
|
||||
state,
|
||||
pid: if running { c.pid } else { None },
|
||||
port,
|
||||
port_ready: running && ready,
|
||||
conflict: None,
|
||||
uptime_secs: if running { c.started_at.as_deref().and_then(uptime_since) } else { None },
|
||||
}
|
||||
}
|
||||
|
||||
fn uptime_since(started: &str) -> Option<u64> {
|
||||
let t = chrono::DateTime::parse_from_rfc3339(started).ok()?;
|
||||
u64::try_from((chrono::Utc::now() - t.with_timezone(&chrono::Utc)).num_seconds()).ok()
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::docker::cli::Output;
|
||||
use std::cell::RefCell;
|
||||
use std::collections::{BTreeMap, HashSet};
|
||||
use std::fs;
|
||||
|
||||
const ROOT_PW: &str = "rootpw-ZZ1";
|
||||
const APP_PW: &str = "apppw-QQ2";
|
||||
|
||||
/// A tiny in-memory Docker: containers, one network, one image. It answers the few commands the backend uses.
|
||||
struct Sim {
|
||||
calls: RefCell<Vec<Call2>>,
|
||||
running: RefCell<HashSet<String>>,
|
||||
exited: RefCell<BTreeMap<String, (i64, bool)>>,
|
||||
network: RefCell<bool>,
|
||||
image: RefCell<bool>,
|
||||
logs: RefCell<String>,
|
||||
unavailable: bool,
|
||||
daemon_error: Option<String>,
|
||||
/// `docker run` of this container fails with this message.
|
||||
run_error: Option<(String, String)>,
|
||||
/// A container that stops right after it was created, with this exit code.
|
||||
dies: Option<(String, i64)>,
|
||||
port_open: bool,
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
struct Call2 {
|
||||
args: Vec<String>,
|
||||
env: Vec<(String, String)>,
|
||||
stdin: bool,
|
||||
}
|
||||
|
||||
impl Sim {
|
||||
fn new() -> Sim {
|
||||
Sim {
|
||||
calls: Default::default(),
|
||||
running: Default::default(),
|
||||
exited: Default::default(),
|
||||
network: RefCell::new(false),
|
||||
image: RefCell::new(false),
|
||||
logs: Default::default(),
|
||||
unavailable: false,
|
||||
daemon_error: None,
|
||||
run_error: None,
|
||||
dies: None,
|
||||
port_open: true,
|
||||
}
|
||||
}
|
||||
|
||||
fn verbs(&self) -> Vec<String> {
|
||||
self.calls.borrow().iter().map(|c| c.args.iter().take(2).cloned().collect::<Vec<_>>().join(" ")).collect()
|
||||
}
|
||||
|
||||
fn calls_of(&self, verb: &str) -> Vec<Call2> {
|
||||
self.calls.borrow().iter().filter(|c| c.args[0] == verb).cloned().collect()
|
||||
}
|
||||
|
||||
fn inspect_json(&self, names: &[String]) -> (String, bool) {
|
||||
let mut items = Vec::new();
|
||||
let mut missing = false;
|
||||
for n in names {
|
||||
if self.running.borrow().contains(n) {
|
||||
let health = if n.ends_with("-db") { r#","Health":{"Status":"healthy"}"# } else { "" };
|
||||
items.push(format!(
|
||||
r#"{{"Name":"/{n}","State":{{"Status":"running","Running":true,"ExitCode":0,"OOMKilled":false,"Pid":4242,"StartedAt":"2026-10-02T12:27:26.892949316Z"{health}}}}}"#
|
||||
));
|
||||
} else if let Some((code, oom)) = self.exited.borrow().get(n) {
|
||||
items.push(format!(
|
||||
r#"{{"Name":"/{n}","State":{{"Status":"exited","Running":false,"ExitCode":{code},"OOMKilled":{oom},"Pid":0,"StartedAt":"2026-10-02T12:27:26.892949316Z"}}}}"#
|
||||
));
|
||||
} else {
|
||||
missing = true;
|
||||
}
|
||||
}
|
||||
(format!("[{}]", items.join(",")), missing)
|
||||
}
|
||||
}
|
||||
|
||||
fn out(code: i32, stdout: &str, stderr: &str) -> Output {
|
||||
Output { code: Some(code), stdout: stdout.into(), stderr: stderr.into() }
|
||||
}
|
||||
|
||||
impl Docker for Sim {
|
||||
fn run(&self, call: &Call) -> Result<Output> {
|
||||
self.calls.borrow_mut().push(Call2 { args: call.args.clone(), env: call.env.clone(), stdin: call.stdin.is_some() });
|
||||
if self.unavailable {
|
||||
return Err(crate::error::Error::Invalid("docker could not be started: No such file or directory".into()));
|
||||
}
|
||||
let a: Vec<&str> = call.args.iter().map(String::as_str).collect();
|
||||
Ok(match a.as_slice() {
|
||||
["version", ..] => match &self.daemon_error {
|
||||
Some(e) => out(1, "", e),
|
||||
None => out(0, "27.3.1\n", ""),
|
||||
},
|
||||
["network", "inspect", ..] => if *self.network.borrow() { out(0, "[]", "") } else { out(1, "[]", "Error: No such network") },
|
||||
["network", "create", ..] => {
|
||||
*self.network.borrow_mut() = true;
|
||||
out(0, "id\n", "")
|
||||
}
|
||||
["image", "inspect", ..] => if *self.image.borrow() { out(0, "[]", "") } else { out(1, "[]", "Error: No such image") },
|
||||
["build", ..] => {
|
||||
*self.image.borrow_mut() = true;
|
||||
out(0, "built", "")
|
||||
}
|
||||
["inspect", names @ ..] => {
|
||||
let names: Vec<String> = names.iter().map(|s| s.to_string()).collect();
|
||||
let (json, missing) = self.inspect_json(&names);
|
||||
if missing { out(1, &json, "Error: No such object: x") } else { out(0, &json, "") }
|
||||
}
|
||||
["rm", "-f", name] => {
|
||||
self.running.borrow_mut().remove(*name);
|
||||
self.exited.borrow_mut().remove(*name);
|
||||
out(0, "", "")
|
||||
}
|
||||
["run", ..] => {
|
||||
let name = call.args[call.args.iter().position(|x| x == "--name").unwrap() + 1].clone();
|
||||
if let Some((n, e)) = &self.run_error {
|
||||
if *n == name {
|
||||
return Ok(out(125, "", e));
|
||||
}
|
||||
}
|
||||
match &self.dies {
|
||||
Some((n, code)) if *n == name => {
|
||||
self.exited.borrow_mut().insert(name, (*code, false));
|
||||
}
|
||||
_ => {
|
||||
self.running.borrow_mut().insert(name);
|
||||
}
|
||||
}
|
||||
out(0, "containerid\n", "")
|
||||
}
|
||||
["stop", "--time", _, name] => {
|
||||
self.running.borrow_mut().remove(*name);
|
||||
self.exited.borrow_mut().insert(name.to_string(), (0, false));
|
||||
out(0, "", "")
|
||||
}
|
||||
["logs", ..] => out(0, &self.logs.borrow(), ""),
|
||||
other => panic!("unexpected docker call: {other:?}"),
|
||||
})
|
||||
}
|
||||
|
||||
fn port_open(&self, _addr: SocketAddr) -> bool {
|
||||
self.port_open
|
||||
}
|
||||
|
||||
fn pause(&self, _d: Duration) {}
|
||||
}
|
||||
|
||||
fn server(project: &str) -> (tempfile::TempDir, std::path::PathBuf) {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("srv");
|
||||
fs::create_dir_all(root.join("Settings")).unwrap();
|
||||
fs::write(root.join("Settings/docker.json"), format!(r#"{{"project":"{project}"}}"#)).unwrap();
|
||||
fs::write(root.join("Settings/database.json"), format!(r#"{{"rootPassword":"{ROOT_PW}","appPassword":"{APP_PW}"}}"#)).unwrap();
|
||||
(d, root)
|
||||
}
|
||||
|
||||
fn start_all(sim: &Sim, root: &Path) -> DriverOutcome {
|
||||
run_with(sim, root, Verb::StartAll).unwrap()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_first_start_creates_the_network_the_image_and_the_containers_in_order() {
|
||||
let (_d, root) = server("t1");
|
||||
let sim = Sim::new();
|
||||
let o = start_all(&sim, &root);
|
||||
assert!(o.ok, "{}", o.output);
|
||||
let verbs = sim.verbs();
|
||||
let at = |needle: &str| verbs.iter().position(|v| v.starts_with(needle)).unwrap_or_else(|| panic!("{needle} not called: {verbs:?}"));
|
||||
assert!(at("version") < at("network create"));
|
||||
assert!(at("network create") < at("run --detach"), "database comes first");
|
||||
let runs: Vec<String> = sim.calls_of("run").iter().map(|c| c.args[c.args.iter().position(|x| x == "--name").unwrap() + 1].clone()).collect();
|
||||
assert_eq!(runs, ["coa-t1-db", "coa-t1-world", "coa-t1-auth"], "database, then world, then auth");
|
||||
assert!(at("build") < verbs.iter().rposition(|v| v.starts_with("run")).unwrap(), "the runtime image exists before the game servers");
|
||||
assert!(sim.calls_of("build")[0].stdin, "the Dockerfile travels on stdin");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn passwords_travel_by_environment_and_never_on_a_command_line() {
|
||||
let (_d, root) = server("t1");
|
||||
let sim = Sim::new();
|
||||
assert!(start_all(&sim, &root).ok);
|
||||
for c in sim.calls.borrow().iter() {
|
||||
for arg in &c.args {
|
||||
assert!(!arg.contains(ROOT_PW) && !arg.contains(APP_PW), "secret on a command line: {arg}");
|
||||
}
|
||||
}
|
||||
let runs = sim.calls_of("run");
|
||||
assert!(runs[0].env.contains(&("MYSQL_ROOT_PASSWORD".into(), ROOT_PW.into())));
|
||||
assert!(runs[1].env.iter().any(|(k, v)| k == "AC_LOGIN_DATABASE_INFO" && v == &format!("db;3306;acore;{APP_PW};acore_auth")));
|
||||
assert!(runs[1].env.iter().any(|(k, _)| k == "AC_CHARACTER_DATABASE_INFO"));
|
||||
assert!(runs[2].env.iter().any(|(k, _)| k == "AC_LOGIN_DATABASE_INFO"));
|
||||
assert!(!runs[2].env.iter().any(|(k, _)| k == "AC_WORLD_DATABASE_INFO"), "auth does not need the world database");
|
||||
assert!(runs[1].args.windows(2).any(|w| w == ["--env", "AC_WORLD_DATABASE_INFO"]), "name only, the value is in the environment");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_world_container_is_wired_like_the_repack_layout() {
|
||||
let (_d, root) = server("t1");
|
||||
let sim = Sim::new();
|
||||
assert!(start_all(&sim, &root).ok);
|
||||
let world = &sim.calls_of("run")[1].args;
|
||||
let has = |s: &str| world.iter().any(|a| a == s);
|
||||
assert!(has("127.0.0.1:8085:8085"), "game port on this computer only by default");
|
||||
assert!(has("127.0.0.1:3443:3443"), "the remote console is never exposed beyond this computer");
|
||||
assert!(has("AC_BIND_IP=0.0.0.0") && has("AC_RA_ENABLE=1") && has("AC_RA_IP=0.0.0.0"));
|
||||
assert!(has("AC_UPDATES_ENABLE_DATABASES=0"), "the server's own database updater needs a mysql client the image does not have");
|
||||
assert!(sim.calls_of("run")[2].args.iter().any(|a| a == "AC_UPDATES_ENABLE_DATABASES=0"));
|
||||
assert!(has("AC_DATA_DIR=/srv/data") && has("AC_LOGS_DIR=/srv/core/Logs"));
|
||||
assert!(world.iter().any(|a| a.ends_with(":/srv/data:ro")), "game data is read-only");
|
||||
assert!(world.iter().any(|a| a.ends_with(":/srv/core") && a.contains("Core")));
|
||||
assert!(world.windows(2).any(|w| w == ["--workdir", "/srv/core"]));
|
||||
assert!(world.windows(2).any(|w| w == ["--stop-timeout", "180"]));
|
||||
let n = world.len();
|
||||
assert_eq!(&world[n - 3..], ["./worldserver", "-c", "configs/worldserver.conf"]);
|
||||
assert!(world[n - 4].starts_with("coa-runtime:"));
|
||||
assert!(root.join("Core/Logs").is_dir(), "created by the Manager so it belongs to the user");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_published_address_follows_the_setting() {
|
||||
let (_d, root) = server("t1");
|
||||
fs::write(root.join("Settings/docker.json"), r#"{"project":"t1","bindAddress":"0.0.0.0"}"#).unwrap();
|
||||
let sim = Sim::new();
|
||||
assert!(start_all(&sim, &root).ok);
|
||||
let runs = sim.calls_of("run");
|
||||
assert!(runs[1].args.iter().any(|a| a == "0.0.0.0:8085:8085"));
|
||||
assert!(runs[1].args.iter().any(|a| a == "127.0.0.1:3443:3443"), "the console stays private");
|
||||
assert!(runs[2].args.iter().any(|a| a == "0.0.0.0:3724:3724"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn custom_host_ports_keep_the_container_listeners_on_the_mapped_ports() {
|
||||
let (_d, root) = server("ports");
|
||||
let cfg = Config::load(&root).unwrap();
|
||||
let n = cfg.names();
|
||||
let world = game_args(&cfg, &n, GameKind::World, &root, 18085, 13443, None);
|
||||
let auth = game_args(&cfg, &n, GameKind::Auth, &root, 13724, 0, None);
|
||||
assert!(world.iter().any(|a| a == "127.0.0.1:18085:8085"));
|
||||
assert!(world.iter().any(|a| a == "127.0.0.1:13443:3443"));
|
||||
assert!(world.iter().any(|a| a == "AC_WORLD_SERVER_PORT=8085"));
|
||||
assert!(world.iter().any(|a| a == "AC_RA_PORT=3443"));
|
||||
assert!(auth.iter().any(|a| a == "127.0.0.1:13724:3724"));
|
||||
assert!(auth.iter().any(|a| a == "AC_REALM_SERVER_PORT=3724"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_second_start_leaves_running_containers_alone() {
|
||||
let (_d, root) = server("t1");
|
||||
let sim = Sim::new();
|
||||
assert!(start_all(&sim, &root).ok);
|
||||
let before = sim.calls_of("run").len();
|
||||
assert!(start_all(&sim, &root).ok);
|
||||
assert_eq!(sim.calls_of("run").len(), before, "nothing was recreated");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn start_database_only_does_not_touch_the_game_servers() {
|
||||
let (_d, root) = server("t1");
|
||||
let sim = Sim::new();
|
||||
assert!(run_with(&sim, &root, Verb::StartMysql).unwrap().ok);
|
||||
assert_eq!(sim.calls_of("run").len(), 1);
|
||||
assert!(sim.calls_of("build").is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn secondary_world_start_is_rejected_without_touching_containers() {
|
||||
let (_d, root) = server("t1");
|
||||
let sim = Sim::new();
|
||||
assert!(run_with(&sim, &root, Verb::StartWorld).is_err());
|
||||
assert!(sim.calls.borrow().is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn stop_goes_world_then_auth_then_database_with_time_to_save() {
|
||||
let (_d, root) = server("t1");
|
||||
let sim = Sim::new();
|
||||
assert!(start_all(&sim, &root).ok);
|
||||
sim.calls.borrow_mut().clear();
|
||||
let o = run_with(&sim, &root, Verb::StopAll).unwrap();
|
||||
assert!(o.ok, "{}", o.output);
|
||||
let stops: Vec<(String, String)> = sim.calls_of("stop").iter().map(|c| (c.args[3].clone(), c.args[2].clone())).collect();
|
||||
assert_eq!(stops, [("coa-t1-world".into(), "180".into()), ("coa-t1-auth".into(), "30".into()), ("coa-t1-db".into(), "60".into())]);
|
||||
assert!(sim.running.borrow().is_empty());
|
||||
// Stopping what is already stopped is fine.
|
||||
sim.calls.borrow_mut().clear();
|
||||
assert!(run_with(&sim, &root, Verb::StopAll).unwrap().ok);
|
||||
assert!(sim.calls_of("stop").is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn docker_not_installed_is_reported_as_unavailable() {
|
||||
let (_d, root) = server("t1");
|
||||
let mut sim = Sim::new();
|
||||
sim.unavailable = true;
|
||||
let o = start_all(&sim, &root);
|
||||
assert!(!o.ok);
|
||||
assert_eq!(o.code, Some(ErrorCode::DockerUnavailable));
|
||||
assert!(o.output.contains("could not be started"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_refused_connection_to_the_docker_service_shows_docker_own_words() {
|
||||
let (_d, root) = server("t1");
|
||||
let mut sim = Sim::new();
|
||||
sim.daemon_error = Some("permission denied while trying to connect to the Docker daemon socket".into());
|
||||
let o = start_all(&sim, &root);
|
||||
assert_eq!(o.code, Some(ErrorCode::DockerUnavailable));
|
||||
assert!(o.output.contains("permission denied"), "{}", o.output);
|
||||
assert!(sim.calls_of("run").is_empty(), "nothing is started when docker is not usable");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_world_server_that_stops_while_starting_reports_the_cause_found_in_its_log() {
|
||||
let (_d, root) = server("t1");
|
||||
let mut sim = Sim::new();
|
||||
sim.dies = Some(("coa-t1-world".into(), 1));
|
||||
*sim.logs.borrow_mut() = "\u{1b}[31mCould not connect to MySQL database at db: Can't connect to MySQL server on 'db:3306' (111)\u{1b}[0m".into();
|
||||
let o = start_all(&sim, &root);
|
||||
assert!(!o.ok);
|
||||
assert_eq!(o.code, Some(ErrorCode::DatabaseNotRunning));
|
||||
assert!(o.output.contains("Can't connect to MySQL server"), "{}", o.output);
|
||||
assert!(!o.output.contains('\u{1b}'), "colour codes are removed");
|
||||
assert!(sim.calls_of("run").len() == 2, "auth is not started after a failed world");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_port_that_is_taken_is_reported_as_such() {
|
||||
let (_d, root) = server("t1");
|
||||
let mut sim = Sim::new();
|
||||
sim.run_error = Some(("coa-t1-world".into(), "Bind for 127.0.0.1:8085 failed: port is already allocated".into()));
|
||||
let o = start_all(&sim, &root);
|
||||
assert_eq!(o.code, Some(ErrorCode::PortInUse));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_server_that_never_listens_times_out_with_its_log() {
|
||||
let (_d, root) = server("t1");
|
||||
let mut sim = Sim::new();
|
||||
sim.port_open = false;
|
||||
*sim.logs.borrow_mut() = "still loading".into();
|
||||
let o = start_all(&sim, &root);
|
||||
assert!(!o.ok);
|
||||
assert!(o.output.contains("was not listening on port 8085") && o.output.contains("still loading"), "{}", o.output);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn invalid_settings_are_refused_before_anything_runs() {
|
||||
for (project, bind, image) in [("Bad Name", "127.0.0.1", "mysql:8.4"), ("", "127.0.0.1", "mysql:8.4"), ("ok", "not-an-ip", "mysql:8.4"), ("ok", "127.0.0.1", "mysql:8.4; rm -rf /"), ("-lead", "127.0.0.1", "mysql:8.4")] {
|
||||
let (_d, root) = server("t1");
|
||||
fs::write(root.join("Settings/docker.json"), format!(r#"{{"project":"{project}","bindAddress":"{bind}","mysqlImage":"{image}"}}"#)).unwrap();
|
||||
let sim = Sim::new();
|
||||
assert!(run_with(&sim, &root, Verb::StartAll).is_err(), "{project} / {bind} / {image}");
|
||||
assert!(sim.calls.borrow().is_empty());
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn inspect_output_is_read_like_docker_prints_it() {
|
||||
// Shape taken from `docker inspect` on a stopped database container and a world server.
|
||||
let json = r#"[{"Id":"abc","Name":"/coa-t1-db","State":{"Status":"running","Running":true,"Paused":false,"Restarting":false,"OOMKilled":false,"Dead":false,"Pid":2402,"ExitCode":0,"Error":"","StartedAt":"2026-10-02T12:27:26.892949316Z","FinishedAt":"0001-01-01T00:00:00Z","Health":{"Status":"healthy","FailingStreak":0,"Log":[]}}},
|
||||
{"Name":"/coa-t1-world","State":{"Status":"exited","Running":false,"OOMKilled":false,"Pid":0,"ExitCode":137,"StartedAt":"2026-10-02T12:40:06.76552263Z"}}]"#;
|
||||
let m = parse_inspect(json);
|
||||
assert_eq!(m["coa-t1-db"].pid, Some(2402));
|
||||
assert_eq!(m["coa-t1-db"].health.as_deref(), Some("healthy"));
|
||||
assert_eq!(m["coa-t1-world"].exit_code, 137);
|
||||
assert_eq!(m["coa-t1-world"].pid, None);
|
||||
assert!(parse_inspect("[]").is_empty() && parse_inspect("").is_empty() && parse_inspect("nonsense").is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn observation_maps_container_states_to_service_states() {
|
||||
let ports = Ports::default();
|
||||
let (_d, root) = server("t1");
|
||||
|
||||
// Nothing created yet.
|
||||
let sim = Sim::new();
|
||||
let o = observe_with(&sim, &root, &ports);
|
||||
assert!([o.mysql.state, o.auth.state, o.world.state].iter().all(|s| *s == ServiceState::Stopped));
|
||||
|
||||
// Everything up.
|
||||
assert!(start_all(&sim, &root).ok);
|
||||
let o = observe_with(&sim, &root, &ports);
|
||||
assert_eq!((o.mysql.state, o.auth.state, o.world.state), (ServiceState::Running, ServiceState::Running, ServiceState::Running));
|
||||
assert!(o.world.port_ready && o.world.pid == Some(4242) && o.world.uptime_secs.is_some());
|
||||
assert_eq!(o.world.port, ports.world);
|
||||
|
||||
// Running but not listening yet.
|
||||
let mut slow = Sim::new();
|
||||
slow.port_open = false;
|
||||
slow.running.borrow_mut().insert("coa-t1-world".into());
|
||||
let o = observe_with(&slow, &root, &ports);
|
||||
assert_eq!(o.world.state, ServiceState::Starting);
|
||||
assert!(!o.world.port_ready);
|
||||
|
||||
// Stopped cleanly, killed after the grace period, crashed, killed for lack of memory.
|
||||
let mut sim = Sim::new();
|
||||
for (name, code, oom) in [("coa-t1-db", 0, false), ("coa-t1-auth", 137, false), ("coa-t1-world", 1, false)] {
|
||||
sim.exited.borrow_mut().insert(name.into(), (code, oom));
|
||||
}
|
||||
let o = observe_with(&sim, &root, &ports);
|
||||
assert_eq!((o.mysql.state, o.auth.state, o.world.state), (ServiceState::Stopped, ServiceState::Stopped, ServiceState::Crashed));
|
||||
sim.exited.borrow_mut().insert("coa-t1-auth".into(), (137, true));
|
||||
assert_eq!(observe_with(&sim, &root, &ports).auth.state, ServiceState::Crashed);
|
||||
sim.unavailable = true;
|
||||
assert_eq!(observe_with(&sim, &root, &ports).world.state, ServiceState::Unknown, "docker unreachable: unknown, not stopped");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_runtime_image_is_named_after_its_dockerfile() {
|
||||
let name = runtime_image();
|
||||
assert!(name.starts_with("coa-runtime:") && name.len() == "coa-runtime:".len() + 12, "{name}");
|
||||
assert!(RUNTIME_DOCKERFILE.contains("libmysqlclient24") && RUNTIME_DOCKERFILE.contains("libreadline8t64"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_docker_folder_is_scanned_without_the_repack_files() {
|
||||
let (_d, root) = server("t1");
|
||||
assert!(crate::docker::is_docker(&root));
|
||||
for f in ["Core/worldserver", "Core/authserver", "Core/configs/worldserver.conf", "Core/configs/authserver.conf", "Data/dbc/x", "Data/maps/x"] {
|
||||
let p = root.join(f);
|
||||
fs::create_dir_all(p.parent().unwrap()).unwrap();
|
||||
fs::write(p, "x").unwrap();
|
||||
}
|
||||
let r = crate::layout::scan(&root).unwrap();
|
||||
assert_eq!(r.classification, crate::layout::Classification::Healthy);
|
||||
assert!(r.worldserver.is_some() && r.authserver.is_some() && !r.modifies_files);
|
||||
fs::remove_file(root.join("Core/authserver")).unwrap();
|
||||
assert_eq!(crate::layout::scan(&root).unwrap().classification, crate::layout::Classification::Partial);
|
||||
fs::remove_file(root.join("Settings/docker.json")).unwrap();
|
||||
assert!(!crate::docker::is_docker(&root), "without the marker it is scanned as a repack");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,164 @@
|
||||
//! Docker backend. The three services (MySQL, authserver, worldserver) run in containers that the Manager creates
|
||||
//! and controls through the `docker` command line; the server folder keeps the same shape as a repack where it
|
||||
//! matters (`Core/configs`, `Core/Logs`, `Settings/*.json`, `Data/`) so configuration, logs and the RA console work
|
||||
//! unchanged. This is the only runtime available on Linux. The Windows repack path is not touched: an
|
||||
//! installation is a Docker one only when `Settings/docker.json` exists.
|
||||
//!
|
||||
//! ```text
|
||||
//! <server>/
|
||||
//! Core/worldserver, authserver mounted at /srv/core (working directory of both containers)
|
||||
//! Core/configs/ Core/Logs/ read and written by the Manager as usual
|
||||
//! Data/ mounted read-only at /srv/data
|
||||
//! Settings/docker.json marks the installation and names its containers
|
||||
//! Settings/repack.json ports and RA login (same file as a repack)
|
||||
//! Settings/database.json database passwords (same file as a repack)
|
||||
//! ```
|
||||
|
||||
mod cli;
|
||||
mod lifecycle;
|
||||
|
||||
pub use cli::{Call, Docker, Output, SystemDocker};
|
||||
pub use lifecycle::{observe, observe_with, run, run_with};
|
||||
|
||||
use std::net::IpAddr;
|
||||
use std::path::Path;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use crate::error::{Error, Result};
|
||||
use crate::fsx;
|
||||
use crate::layout::{self, Classification, ScanReport};
|
||||
|
||||
/// Present in a Docker installation, absent from a repack.
|
||||
pub const MARKER: &str = "Settings/docker.json";
|
||||
const MYSQL_IMAGE: &str = "mysql:8.4";
|
||||
const RUNTIME_DOCKERFILE: &str = include_str!("Dockerfile.runtime");
|
||||
|
||||
pub fn is_docker(root: &Path) -> bool {
|
||||
root.join(MARKER).is_file()
|
||||
}
|
||||
|
||||
fn loopback() -> String {
|
||||
"127.0.0.1".into()
|
||||
}
|
||||
|
||||
fn mysql_image() -> String {
|
||||
MYSQL_IMAGE.into()
|
||||
}
|
||||
|
||||
/// `Settings/docker.json`.
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Config {
|
||||
/// Short unique name of this installation; part of every container, network and volume name.
|
||||
pub project: String,
|
||||
/// Host address the game ports are published on: `127.0.0.1` (this computer only) or `0.0.0.0` / a LAN address.
|
||||
#[serde(default = "loopback")]
|
||||
pub bind_address: String,
|
||||
#[serde(default = "mysql_image")]
|
||||
pub mysql_image: String,
|
||||
}
|
||||
|
||||
pub(crate) struct Names {
|
||||
pub network: String,
|
||||
pub volume: String,
|
||||
pub db: String,
|
||||
pub world: String,
|
||||
pub auth: String,
|
||||
}
|
||||
|
||||
impl Config {
|
||||
pub fn load(root: &Path) -> Result<Config> {
|
||||
let cfg: Config = fsx::read_json(&root.join(MARKER)).map_err(|_| Error::Invalid("The Docker settings of this server could not be read.".into()))?;
|
||||
cfg.validate()?;
|
||||
Ok(cfg)
|
||||
}
|
||||
|
||||
fn validate(&self) -> Result<()> {
|
||||
let name_ok = !self.project.is_empty()
|
||||
&& self.project.len() <= 32
|
||||
&& self.project.starts_with(|c: char| c.is_ascii_lowercase() || c.is_ascii_digit())
|
||||
&& self.project.chars().all(|c| c.is_ascii_lowercase() || c.is_ascii_digit() || c == '-');
|
||||
if !name_ok {
|
||||
return Err(Error::Invalid("The Docker project name must be 1-32 characters: lower-case letters, digits and dashes.".into()));
|
||||
}
|
||||
if self.bind_address.parse::<IpAddr>().is_err() {
|
||||
return Err(Error::Invalid(format!("{} is not an IP address.", self.bind_address)));
|
||||
}
|
||||
let image_ok = !self.mysql_image.is_empty() && self.mysql_image.chars().all(|c| c.is_ascii_alphanumeric() || "._/:@-".contains(c));
|
||||
if !image_ok {
|
||||
return Err(Error::Invalid("The database image name is not valid.".into()));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Name of the database container (the one `docker exec` talks to).
|
||||
pub(crate) fn database_container(&self) -> String {
|
||||
self.names().db
|
||||
}
|
||||
|
||||
pub(crate) fn names(&self) -> Names {
|
||||
let p = &self.project;
|
||||
Names { network: format!("coa-{p}"), volume: format!("coa-{p}-db"), db: format!("coa-{p}-db"), world: format!("coa-{p}-world"), auth: format!("coa-{p}-auth") }
|
||||
}
|
||||
}
|
||||
|
||||
/// Name of the runtime image: it follows the content of its Dockerfile, so changing the libraries builds a new image.
|
||||
pub(crate) fn runtime_image() -> String {
|
||||
format!("coa-runtime:{}", &fsx::sha256_bytes(RUNTIME_DOCKERFILE.as_bytes())[..12])
|
||||
}
|
||||
|
||||
/// Read-only description of a Docker installation, shaped like the scan of a repack so the screens that list what a
|
||||
/// server holds work for both.
|
||||
pub(crate) fn scan(root: &Path) -> Result<ScanReport> {
|
||||
let cfg = Config::load(root);
|
||||
let world = layout::hash_exe(&root.join("Core/worldserver"), None, "worldserver");
|
||||
let auth = layout::hash_exe(&root.join("Core/authserver"), None, "authserver");
|
||||
let modules_dir = root.join("Core/configs/modules");
|
||||
let mut module_configs: Vec<String> = std::fs::read_dir(&modules_dir)
|
||||
.map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| e.file_name().into_string().ok()).filter(|n| n.ends_with(".conf")).collect())
|
||||
.unwrap_or_default();
|
||||
module_configs.sort();
|
||||
|
||||
let bot_active = modules_dir.join("mod_coa_playerbots.conf");
|
||||
let bot_conf = if bot_active.is_file() { bot_active } else { modules_dir.join("mod_coa_playerbots.conf.dist") };
|
||||
let bot_config_keys = layout::count_bot_keys(&bot_conf);
|
||||
let has_data = layout::exists(root, "Data/dbc") && layout::exists(root, "Data/maps");
|
||||
let has_confs = layout::exists(root, "Core/configs/worldserver.conf") && layout::exists(root, "Core/configs/authserver.conf");
|
||||
|
||||
let items = vec![
|
||||
layout::item("worldserver", "World server", world.is_some(), None),
|
||||
layout::item("authserver", "Auth server", auth.is_some(), None),
|
||||
layout::item("worldserver_conf", "World server configuration", layout::exists(root, "Core/configs/worldserver.conf"), None),
|
||||
layout::item("authserver_conf", "Auth server configuration", layout::exists(root, "Core/configs/authserver.conf"), None),
|
||||
layout::item("modules_conf", "Module configuration", modules_dir.is_dir(), Some(format!("{} files", module_configs.len()))),
|
||||
layout::item("game_data", "Game data (maps, DBC)", has_data, None),
|
||||
layout::item("database_runtime", "Database runtime", cfg.is_ok(), cfg.as_ref().ok().map(|c| c.mysql_image.clone())),
|
||||
layout::item("launcher", "Docker settings", cfg.is_ok(), cfg.as_ref().ok().map(|c| c.project.clone())),
|
||||
layout::item("companions", "CoA Companions (bots)", bot_conf.is_file(), (bot_config_keys > 0).then(|| format!("{bot_config_keys} settings"))),
|
||||
];
|
||||
let mut notes = Vec::new();
|
||||
if let Err(e) = &cfg {
|
||||
notes.push(e.to_string());
|
||||
}
|
||||
let healthy = cfg.is_ok() && world.is_some() && auth.is_some() && has_data && has_confs;
|
||||
Ok(ScanReport {
|
||||
path: root.to_string_lossy().into_owned(),
|
||||
classification: if healthy { Classification::Healthy } else { Classification::Partial },
|
||||
items,
|
||||
worldserver: world,
|
||||
authserver: auth,
|
||||
release: None,
|
||||
banner_revision: layout::banner_revision_in_log(&root.join("Core/Logs/Server.log")),
|
||||
module_configs,
|
||||
bot_config_keys,
|
||||
ports: layout::read_ports(root),
|
||||
database_schemas: Vec::new(),
|
||||
client: ["Client", "client"].iter().find_map(|d| layout::detect_client(&root.join(d))),
|
||||
notes,
|
||||
suggested_path: None,
|
||||
hint: None,
|
||||
modifies_files: false,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -17,6 +17,7 @@ use crate::fsx;
|
||||
pub enum Verb {
|
||||
StartAll,
|
||||
StartMysql,
|
||||
StartWorld,
|
||||
StopAll,
|
||||
}
|
||||
|
||||
@@ -25,19 +26,29 @@ impl Verb {
|
||||
match self {
|
||||
Verb::StartAll => "start-all",
|
||||
Verb::StartMysql => "start-mysql",
|
||||
Verb::StartWorld => "start-world",
|
||||
Verb::StopAll => "stop-all",
|
||||
}
|
||||
}
|
||||
|
||||
fn timeout(self) -> Duration {
|
||||
fn timeout(self, root: &Path) -> Duration {
|
||||
match self {
|
||||
Verb::StartAll => Duration::from_secs(420),
|
||||
Verb::StartAll | Verb::StartWorld if squid_enabled(root) => Duration::from_secs(2700),
|
||||
Verb::StartAll | Verb::StartWorld => Duration::from_secs(420),
|
||||
Verb::StartMysql => Duration::from_secs(120),
|
||||
Verb::StopAll => Duration::from_secs(240),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn squid_enabled(root: &Path) -> bool {
|
||||
let active = root.join("Core/configs/modules/playerbots.conf");
|
||||
let path = if active.exists() { active } else { root.join("Core/configs/modules/playerbots.conf.dist") };
|
||||
std::fs::read(path).ok().and_then(|bytes| crate::config::parser::ConfFile::parse_bytes(&bytes).ok())
|
||||
.is_some_and(|config| config.get("AiPlayerbot.Enabled").is_none_or(|value|
|
||||
!matches!(value.trim().trim_matches('"').to_ascii_lowercase().as_str(), "0" | "false" | "no" | "off")))
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize)]
|
||||
pub struct DriverOutcome {
|
||||
pub ok: bool,
|
||||
@@ -79,7 +90,26 @@ fn launcher(root: &Path) -> Result<(PathBuf, PathBuf)> {
|
||||
|
||||
/// Run a launcher verb to completion (blocking; call from a worker thread).
|
||||
pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
|
||||
run_inner(root, verb, false)
|
||||
}
|
||||
|
||||
pub(crate) fn validate_update(root: &Path) -> Result<DriverOutcome> {
|
||||
run_inner(root, Verb::StartAll, true)
|
||||
}
|
||||
|
||||
fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverOutcome> {
|
||||
let root = fsx::canonicalize_lenient(root)?;
|
||||
let _update_lock = if !validating_update && matches!(verb, Verb::StartAll | Verb::StartWorld) {
|
||||
Some(crate::update::operation_lock(&crate::registry::metadata_dir_for(&root)?)?)
|
||||
} else { None };
|
||||
if !validating_update && matches!(verb, Verb::StartAll | Verb::StartWorld) {
|
||||
crate::update::ensure_recovered(&crate::registry::metadata_dir_for(&root)?)?;
|
||||
}
|
||||
if matches!(verb, Verb::StartAll | Verb::StartWorld) { crate::modules::ensure_bot_exclusivity(&root)?; }
|
||||
if crate::docker::is_docker(&root) {
|
||||
return crate::docker::run(&root, verb);
|
||||
}
|
||||
if verb == Verb::StopAll { crate::multiworld::stop(&root)?; }
|
||||
if verb == Verb::StartAll {
|
||||
crate::realms::before_start(&root)?;
|
||||
if root.join("Settings/realm-profile.json").exists() {
|
||||
@@ -91,9 +121,24 @@ pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
|
||||
crate::realms::setup_realmlist(&root)?;
|
||||
}
|
||||
}
|
||||
if matches!(verb, Verb::StartAll | Verb::StartWorld) { crate::modules::ensure_bot_exclusivity(&root)?; }
|
||||
let (python, script) = launcher(&root)?;
|
||||
let original = std::fs::read_to_string(&script)?;
|
||||
let patched = patch_launcher_imports(&original)?;
|
||||
if original != patched {
|
||||
fsx::atomic_write(&script, patched.as_bytes())?;
|
||||
if let Ok(dir) = crate::registry::metadata_dir_for(&root) {
|
||||
if let Ok((_, mut meta)) = crate::registry::MetaDir::open(&dir) {
|
||||
if meta.original_hashes.get("Scripts/manage.py") == Some(&fsx::sha256_bytes(original.as_bytes())) {
|
||||
meta.original_hashes.insert("Scripts/manage.py".into(), fsx::sha256_bytes(patched.as_bytes()));
|
||||
fsx::atomic_write_json(&dir.join("install.json"), &meta)?;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
let mut cmd = Command::new(&python);
|
||||
cmd.arg("-B").arg(&script).arg(verb.arg()).current_dir(&root).stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::piped());
|
||||
cmd.arg("-B").arg("-c").arg(LAUNCH_SCRIPT).arg(&script).arg(verb.arg())
|
||||
.current_dir(&root).stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::piped());
|
||||
#[cfg(windows)]
|
||||
{
|
||||
use std::os::windows::process::CommandExt;
|
||||
@@ -113,7 +158,7 @@ pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
|
||||
let _ = stderr.read_to_string(&mut s);
|
||||
s
|
||||
});
|
||||
let deadline = Instant::now() + verb.timeout();
|
||||
let deadline = Instant::now() + verb.timeout(&root);
|
||||
let status = loop {
|
||||
if let Some(st) = child.try_wait()? {
|
||||
break Some(st);
|
||||
@@ -143,13 +188,69 @@ pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
|
||||
}
|
||||
};
|
||||
tracing::info!(?verb, ok, ?code, "driver: launcher verb finished");
|
||||
if ok && verb == Verb::StartAll { crate::multiworld::start(&root)?; }
|
||||
Ok(DriverOutcome { ok, exit_code, code, human: code.map(ErrorCode::human), output })
|
||||
}
|
||||
|
||||
const LAUNCH_SCRIPT: &str = "import runpy,sys;from pathlib import Path;script=sys.argv[1];sys.path.insert(0,str(Path(script).resolve().parent));sys.argv=sys.argv[1:];runpy.run_path(script,run_name='__main__')";
|
||||
|
||||
pub(crate) fn patch_launcher_imports(text: &str) -> Result<String> {
|
||||
let line = "sys.path.insert(0, str(Path(__file__).resolve().parent))";
|
||||
if !text.contains("from squid_playerbots import") || text.contains(line) { return Ok(text.into()); }
|
||||
let root = "ROOT = Path(__file__).resolve().parents[1]";
|
||||
if !text.contains(root) || !text.lines().any(|line| line.trim() == "import sys") {
|
||||
return Err(Error::Invalid("The server launcher cannot load its integration scripts. Repair its program files.".into()));
|
||||
}
|
||||
Ok(text.replacen(root, &format!("{root}\n{line}"), 1))
|
||||
}
|
||||
|
||||
pub(crate) fn launcher_matches(signed: &str, actual: &[u8]) -> bool {
|
||||
if signed.as_bytes() == actual { return true; }
|
||||
if patch_launcher_imports(signed).is_ok_and(|s| s.as_bytes() == actual) { return true; }
|
||||
crate::realms::patch_launcher(signed).is_ok_and(|s| s.as_bytes() == actual
|
||||
|| patch_launcher_imports(&s).is_ok_and(|p| p.as_bytes() == actual))
|
||||
}
|
||||
|
||||
/// Recover legacy metadata only when undoing supported Manager edits reproduces the recorded hash.
|
||||
pub(crate) fn launcher_matches_recorded(recorded: &str, actual: &[u8]) -> bool {
|
||||
let Ok(text) = std::str::from_utf8(actual) else { return false; };
|
||||
let without_import = text.replacen(
|
||||
"ROOT = Path(__file__).resolve().parents[1]\nsys.path.insert(0, str(Path(__file__).resolve().parent))",
|
||||
"ROOT = Path(__file__).resolve().parents[1]", 1,
|
||||
);
|
||||
for candidate in [Some(without_import.clone()), crate::realms::unpatch_launcher(&without_import)].into_iter().flatten() {
|
||||
if crate::fsx::sha256_bytes(candidate.as_bytes()).eq_ignore_ascii_case(recorded)
|
||||
&& launcher_matches(&candidate, actual) { return true; }
|
||||
}
|
||||
false
|
||||
}
|
||||
|
||||
pub(crate) fn startup_failure(root: &Path, started: &DriverOutcome) -> String {
|
||||
let code = started.code.filter(|c| *c != ErrorCode::Unknown)
|
||||
.or_else(|| crate::health::diagnose_installation(root));
|
||||
let title = code.map(|c| c.human().title).unwrap_or("The server did not become ready");
|
||||
let output = crate::diag::redact(&started.output);
|
||||
let lines: Vec<_> = output.lines().rev().take(12).collect();
|
||||
if lines.is_empty() { title.into() }
|
||||
else { format!("{title}\n{}", lines.into_iter().rev().collect::<Vec<_>>().join("\n")) }
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn large_squid_provisioning_has_time_to_finish_without_extending_shutdown() {
|
||||
let folder = tempfile::tempdir().unwrap();
|
||||
let modules = folder.path().join("Core/configs/modules");
|
||||
std::fs::create_dir_all(&modules).unwrap();
|
||||
std::fs::write(modules.join("playerbots.conf.dist"), "AiPlayerbot.Enabled = 1\n").unwrap();
|
||||
assert_eq!(Verb::StartAll.timeout(folder.path()), Duration::from_secs(2700));
|
||||
assert_eq!(Verb::StopAll.timeout(folder.path()), Duration::from_secs(240));
|
||||
std::fs::write(modules.join("playerbots.conf"), "AiPlayerbot.Enabled = 0\n").unwrap();
|
||||
assert_eq!(Verb::StartWorld.timeout(folder.path()), Duration::from_secs(420));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn translates_known_launcher_messages() {
|
||||
assert_eq!(translate("RuntimeError: Port 8085 is already used. Stop the other server"), ErrorCode::PortInUse);
|
||||
@@ -164,4 +265,25 @@ mod tests {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
assert!(run(dir.path(), Verb::StartAll).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn startup_failure_keeps_the_launcher_reason_without_secrets() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let started = DriverOutcome { ok: false, exit_code: Some(1), code: Some(ErrorCode::Unknown),
|
||||
human: Some(ErrorCode::Unknown.human()),
|
||||
output: "appPassword=private\nModuleNotFoundError: No module named 'squid_playerbots'".into() };
|
||||
let reason = startup_failure(dir.path(), &started);
|
||||
assert!(reason.contains("ModuleNotFoundError"));
|
||||
assert!(!reason.contains("private"));
|
||||
assert!(!reason.contains("Something went wrong"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn launcher_import_fix_is_idempotent_and_retains_other_code() {
|
||||
let text = "import sys\nROOT = Path(__file__).resolve().parents[1]\nfrom squid_playerbots import validate_bots\ncustom = 42\n";
|
||||
let fixed = patch_launcher_imports(text).unwrap();
|
||||
assert!(fixed.contains("sys.path.insert(0, str(Path(__file__).resolve().parent))"));
|
||||
assert!(fixed.ends_with("custom = 42\n"));
|
||||
assert_eq!(patch_launcher_imports(&fixed).unwrap(), fixed);
|
||||
}
|
||||
}
|
||||
@@ -26,6 +26,8 @@ pub enum Error {
|
||||
NetworkUnreachable(String),
|
||||
#[error("the bot module found no level 80 template characters")]
|
||||
CompanionTemplatesMissing,
|
||||
#[error("CoA Companions and SQUID Playerbots cannot both be enabled. Disable one bot module.")]
|
||||
BotModulesConflict,
|
||||
#[error("this server's bot module does not have that command yet")]
|
||||
CompanionCommandUnsupported,
|
||||
#[error("invalid values: {}", .0.iter().map(|f| format!("{}: {}", f.key, f.message)).collect::<Vec<_>>().join("; "))]
|
||||
@@ -52,11 +54,13 @@ pub enum ErrorCode {
|
||||
DiskFull,
|
||||
OperationInProgress,
|
||||
StartupFailed,
|
||||
DockerUnavailable,
|
||||
HashMismatch,
|
||||
PathRejected,
|
||||
PackageNotPublished,
|
||||
NetworkUnreachable,
|
||||
CompanionTemplatesMissing,
|
||||
BotModulesConflict,
|
||||
CompanionCommandUnsupported,
|
||||
Unknown,
|
||||
}
|
||||
@@ -83,6 +87,7 @@ impl ErrorCode {
|
||||
pub fn human(self) -> Human {
|
||||
use FixAction::*;
|
||||
let (title, message, actions): (&str, &str, &'static [FixAction]) = match self {
|
||||
ErrorCode::BotModulesConflict => ("Two bot modules are enabled", "Disable CoA Companions or SQUID Playerbots in Modules before starting the server.", &[ShowDetails]),
|
||||
ErrorCode::DatabaseNotRunning => (
|
||||
"Database isn't running",
|
||||
"The server needs its database to start. Start the database first.",
|
||||
@@ -128,6 +133,11 @@ impl ErrorCode {
|
||||
"A service stopped while starting. Check the details for the cause.",
|
||||
&[FixAutomatically, ShowDetails],
|
||||
),
|
||||
ErrorCode::DockerUnavailable => (
|
||||
"Docker is not available",
|
||||
"This server runs in Docker. Install Docker, start it, and make sure your user account may use it, then try again.",
|
||||
&[Retry, ShowDetails],
|
||||
),
|
||||
ErrorCode::HashMismatch => (
|
||||
"A downloaded file is damaged",
|
||||
"The file did not match its checksum and was not used.",
|
||||
@@ -173,6 +183,7 @@ impl Error {
|
||||
Error::Validation(_) => ErrorCode::InvalidConfigValue,
|
||||
Error::PackageNotPublished(_) => ErrorCode::PackageNotPublished,
|
||||
Error::NetworkUnreachable(_) => ErrorCode::NetworkUnreachable,
|
||||
Error::BotModulesConflict => ErrorCode::BotModulesConflict,
|
||||
Error::CompanionTemplatesMissing => ErrorCode::CompanionTemplatesMissing,
|
||||
Error::CompanionCommandUnsupported => ErrorCode::CompanionCommandUnsupported,
|
||||
_ => ErrorCode::Unknown,
|
||||
|
||||
@@ -78,13 +78,21 @@ fn run_elevated(commands: &[String]) -> Result<()> {
|
||||
|
||||
/// Make sure both rules exist (adds only the missing ones) and confirm afterwards.
|
||||
pub fn ensure_rules(ports: &Ports) -> Result<Status> {
|
||||
ensure_rules_with_secondary(ports, None)
|
||||
}
|
||||
|
||||
pub fn ensure_rules_with_secondary(ports: &Ports, secondary: Option<u16>) -> Result<Status> {
|
||||
let have = status();
|
||||
let cmds = plan(ports, &have);
|
||||
let mut cmds = plan(ports, &have);
|
||||
let second_name = secondary.map(|port| format!("CoA Server Manager - Second World {port}"));
|
||||
if let (Some(port), Some(name)) = (secondary, &second_name) {
|
||||
if !rule_exists(name) { cmds.push(add_cmd(name, port)); }
|
||||
}
|
||||
if !cmds.is_empty() {
|
||||
run_elevated(&cmds)?;
|
||||
}
|
||||
let now = status();
|
||||
if now.auth && now.world {
|
||||
if now.auth && now.world && second_name.as_ref().is_none_or(|name| rule_exists(name)) {
|
||||
Ok(now)
|
||||
} else {
|
||||
Err(Error::Invalid("The firewall rules could not be confirmed after the change.".into()))
|
||||
|
||||
@@ -118,7 +118,8 @@ pub fn apply_realm_address(root: &Path, host: &str) -> Result<()> {
|
||||
}
|
||||
let db = Db::from_repack(root, Account::Admin)?;
|
||||
let realm = crate::realms::state(root)?.active.realm_id();
|
||||
db.query(&format!("UPDATE acore_auth.realmlist SET address='{host}', localAddress='{host}' WHERE id={realm};"))?;
|
||||
let where_realms = if crate::realms::state(root)?.simultaneous { "id IN (1,2)".into() } else { format!("id={realm}") };
|
||||
db.query(&format!("UPDATE acore_auth.realmlist SET address='{host}', localAddress='{host}' WHERE {where_realms};"))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
||||
@@ -27,11 +27,14 @@ pub fn normalize_lexical(path: &Path) -> PathBuf {
|
||||
|
||||
fn key(path: &Path) -> Vec<String> {
|
||||
path.components()
|
||||
.map(|c| c.as_os_str().to_string_lossy().to_lowercase())
|
||||
.map(|c| {
|
||||
let c = c.as_os_str().to_string_lossy();
|
||||
if cfg!(windows) { c.to_lowercase() } else { c.into_owned() }
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Case-insensitive component-wise prefix test (Windows semantics).
|
||||
/// Component-wise prefix test: case-insensitive on Windows, exact elsewhere (`/srv/CoA` and `/srv/coa` are two folders).
|
||||
pub fn starts_with_ci(path: &Path, prefix: &Path) -> bool {
|
||||
let (p, q) = (key(path), key(prefix));
|
||||
p.len() >= q.len() && p[..q.len()] == q[..]
|
||||
@@ -120,7 +123,7 @@ pub fn atomic_write(path: &Path, bytes: &[u8]) -> Result<()> {
|
||||
let tmp = parent.join(format!(
|
||||
".{}.{}.tmp",
|
||||
path.file_name().map(|n| n.to_string_lossy().into_owned()).unwrap_or_default(),
|
||||
std::process::id()
|
||||
uuid::Uuid::new_v4().simple()
|
||||
));
|
||||
let write = || -> std::io::Result<()> {
|
||||
let mut f = OpenOptions::new().write(true).create_new(true).open(&tmp)?;
|
||||
@@ -132,13 +135,41 @@ pub fn atomic_write(path: &Path, bytes: &[u8]) -> Result<()> {
|
||||
let _ = fs::remove_file(&tmp);
|
||||
return Err(e.into());
|
||||
}
|
||||
if let Err(e) = fs::rename(&tmp, path) {
|
||||
if let Err(e) = durable_replace(&tmp, path) {
|
||||
let _ = fs::remove_file(&tmp);
|
||||
return Err(e.into());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// The temporary file must already be flushed, on the same volume as the destination.
|
||||
pub(crate) fn durable_replace(from: &Path, to: &Path) -> std::io::Result<()> {
|
||||
#[cfg(windows)]
|
||||
{
|
||||
use std::os::windows::ffi::OsStrExt;
|
||||
use windows_sys::Win32::Storage::FileSystem::{MoveFileExW, MOVEFILE_REPLACE_EXISTING, MOVEFILE_WRITE_THROUGH};
|
||||
fn wide(path: &Path) -> std::io::Result<Vec<u16>> {
|
||||
let absolute = std::path::absolute(path)?;
|
||||
let text = absolute.as_os_str().to_string_lossy().replace('/', "\\");
|
||||
let extended = if text.starts_with("\\\\?\\") { text }
|
||||
else if let Some(unc) = text.strip_prefix("\\\\") { format!("\\\\?\\UNC\\{unc}") }
|
||||
else { format!("\\\\?\\{text}") };
|
||||
Ok(std::ffi::OsStr::new(&extended).encode_wide().chain(Some(0)).collect())
|
||||
}
|
||||
let src = wide(from)?;
|
||||
let dst = wide(to)?;
|
||||
if unsafe { MoveFileExW(src.as_ptr(), dst.as_ptr(), MOVEFILE_REPLACE_EXISTING | MOVEFILE_WRITE_THROUGH) } == 0 {
|
||||
return Err(std::io::Error::last_os_error());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
#[cfg(not(windows))]
|
||||
{
|
||||
fs::rename(from, to)?;
|
||||
File::open(to.parent().unwrap())?.sync_all()
|
||||
}
|
||||
}
|
||||
|
||||
pub fn atomic_write_json<T: serde::Serialize>(path: &Path, value: &T) -> Result<()> {
|
||||
let mut bytes = serde_json::to_vec_pretty(value)?;
|
||||
bytes.push(b'\n');
|
||||
@@ -171,7 +202,8 @@ pub fn sha256_bytes(bytes: &[u8]) -> String {
|
||||
|
||||
/// Free bytes on the volume that holds `path` (or its nearest existing ancestor).
|
||||
pub fn free_space(path: &Path) -> Result<u64> {
|
||||
let mut cursor = Some(path);
|
||||
let path = std::path::absolute(path)?;
|
||||
let mut cursor = Some(path.as_path());
|
||||
while let Some(p) = cursor {
|
||||
if p.exists() {
|
||||
return Ok(fs4::available_space(p)?);
|
||||
@@ -195,6 +227,16 @@ pub fn require_space(path: &Path, needed: u64) -> Result<()> {
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn durable_replacement_handles_long_transaction_backup_paths() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let parent = dir.path().join("a".repeat(90)).join("b".repeat(90));
|
||||
let path = parent.join("configuration-with-a-long-name.template");
|
||||
atomic_write(&path, b"old").unwrap();
|
||||
atomic_write(&path, b"new").unwrap();
|
||||
assert_eq!(fs::read(&path).unwrap(), b"new");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn safe_join_accepts_normal_and_rejects_traversal() {
|
||||
let root = Path::new("C:/srv");
|
||||
@@ -278,4 +320,11 @@ mod tests {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
assert!(matches!(require_space(dir.path(), u64::MAX / 2), Err(Error::InsufficientSpace { .. })));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn free_space_resolves_a_new_relative_directory() {
|
||||
let path = Path::new("coa-schema-fixture-not-created").join("nested");
|
||||
assert!(!path.exists());
|
||||
assert!(free_space(&path).unwrap() > 0);
|
||||
}
|
||||
}
|
||||
@@ -144,7 +144,7 @@ fn random_hex(n: usize) -> String {
|
||||
|
||||
/// Rotate the database users' passwords away from the packaged bootstrap values and write the launcher's
|
||||
/// `Settings/database.json`. MySQL is started from `root` and stopped again before returning.
|
||||
fn bootstrap_database(root: &Path) -> Result<()> {
|
||||
pub(crate) fn bootstrap_database(root: &Path) -> Result<()> {
|
||||
with_scratch_ports(root, || bootstrap_database_inner(root))
|
||||
}
|
||||
|
||||
@@ -154,7 +154,7 @@ fn free_port() -> Result<u16> {
|
||||
|
||||
/// Run `f` with the staging copy listening on unused ports, so an installation never collides with a server (or any
|
||||
/// other program) already using the shipped ports. The shipped ports are put back afterwards.
|
||||
fn with_scratch_ports<T>(root: &Path, f: impl FnOnce() -> Result<T>) -> Result<T> {
|
||||
pub(crate) fn with_scratch_ports<T>(root: &Path, f: impl FnOnce() -> Result<T>) -> Result<T> {
|
||||
const KEYS: [&str; 4] = ["mysqlPort", "authPort", "worldPort", "raPort"];
|
||||
let path = root.join("Settings/repack.json");
|
||||
let original: serde_json::Value = fsx::read_json(&path)?;
|
||||
@@ -261,6 +261,13 @@ pub fn install_base(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
|
||||
package::extract(&parts_dir, &m, &staging_root, &|done, total| say("Unpacking", 50 + (done * 30 / total.max(1)) as u8, None))?;
|
||||
say("Preparing database", 82, None);
|
||||
bootstrap_database(&staging_root)?;
|
||||
crate::backup::with_database(&staging_root, |db| {
|
||||
let problems = crate::schema_check::check(db, &staging_root)?;
|
||||
if let Some(p) = problems.first() {
|
||||
return Err(Error::Invalid(format!("The packaged database is incomplete: {}.{}.{}: {}.", p.database, p.table, p.column, p.detail)));
|
||||
}
|
||||
Ok(())
|
||||
})?;
|
||||
fs::remove_file(staging_root.join(MARKER))?;
|
||||
|
||||
// 4. Commit: the only moment the destination changes.
|
||||
|
||||
@@ -110,15 +110,15 @@ pub struct ScanReport {
|
||||
pub modifies_files: bool,
|
||||
}
|
||||
|
||||
fn exists(root: &Path, rel: &str) -> bool {
|
||||
pub(crate) fn exists(root: &Path, rel: &str) -> bool {
|
||||
root.join(rel).exists()
|
||||
}
|
||||
|
||||
fn item(key: &'static str, label: &'static str, present: bool, detail: Option<String>) -> Item {
|
||||
pub(crate) fn item(key: &'static str, label: &'static str, present: bool, detail: Option<String>) -> Item {
|
||||
Item { key, label, status: if present { Status::Found } else { Status::Missing }, detail }
|
||||
}
|
||||
|
||||
fn hash_exe(path: &Path, release: Option<&ReleaseJson>, name: &str) -> Option<ExeInfo> {
|
||||
pub(crate) fn hash_exe(path: &Path, release: Option<&ReleaseJson>, name: &str) -> Option<ExeInfo> {
|
||||
let meta = fs::metadata(path).ok()?;
|
||||
if !meta.is_file() {
|
||||
return None;
|
||||
@@ -192,7 +192,7 @@ pub fn detect_client(dir: &Path) -> Option<ClientInfo> {
|
||||
None
|
||||
}
|
||||
|
||||
fn count_bot_keys(conf: &Path) -> usize {
|
||||
pub(crate) fn count_bot_keys(conf: &Path) -> usize {
|
||||
fs::read_to_string(conf)
|
||||
.map(|t| t.lines().filter(|l| l.trim_start().starts_with("CoaBots.")).count())
|
||||
.unwrap_or(0)
|
||||
@@ -204,6 +204,9 @@ pub fn scan(root: &Path) -> Result<ScanReport> {
|
||||
return Err(crate::error::Error::Invalid(format!("{} is not a folder", root.display())));
|
||||
}
|
||||
let root = fsx::canonicalize_lenient(root)?;
|
||||
if crate::docker::is_docker(&root) {
|
||||
return crate::docker::scan(&root);
|
||||
}
|
||||
let mut notes = Vec::new();
|
||||
|
||||
let release: Option<ReleaseJson> = fsx::read_json(&root.join("RELEASE.json")).ok();
|
||||
@@ -312,6 +315,7 @@ pub fn scan(root: &Path) -> Result<ScanReport> {
|
||||
(None, None)
|
||||
};
|
||||
|
||||
if crate::squid::imported_repack(&root) { notes.push("import.squidRepackWarning".into()); }
|
||||
Ok(ScanReport {
|
||||
path: root.to_string_lossy().into_owned(),
|
||||
classification,
|
||||
|
||||
@@ -3,11 +3,13 @@ pub mod backup;
|
||||
pub mod cleanbase;
|
||||
pub mod companions;
|
||||
pub mod client;
|
||||
pub mod remote_client;
|
||||
pub mod clientdl;
|
||||
pub mod config;
|
||||
pub mod console;
|
||||
pub mod db;
|
||||
pub mod diag;
|
||||
pub mod docker;
|
||||
pub mod download;
|
||||
pub mod driver;
|
||||
pub mod error;
|
||||
@@ -23,6 +25,9 @@ pub mod population;
|
||||
pub mod process;
|
||||
pub mod manifest;
|
||||
pub mod migrations;
|
||||
pub mod multiworld;
|
||||
pub mod repair;
|
||||
pub mod schema_check;
|
||||
pub mod net;
|
||||
pub mod package;
|
||||
pub mod ra;
|
||||
@@ -32,6 +37,7 @@ pub mod realmlist;
|
||||
pub mod realms;
|
||||
pub mod registry;
|
||||
pub mod release;
|
||||
pub mod release_schema;
|
||||
pub mod update;
|
||||
pub mod upnp;
|
||||
pub mod signing;
|
||||
@@ -40,3 +46,5 @@ pub mod srp6;
|
||||
pub use error::{Error, ErrorCode, Result};
|
||||
|
||||
pub const MANAGER_VERSION: &str = env!("CARGO_PKG_VERSION");
|
||||
|
||||
pub mod squid;
|
||||
@@ -48,6 +48,8 @@ pub struct FileEntry {
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct Migration {
|
||||
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
||||
pub compatible_sha256: Vec<String>,
|
||||
pub id: String,
|
||||
pub db: String,
|
||||
pub sha256: String,
|
||||
@@ -134,6 +136,11 @@ impl Manifest {
|
||||
if parse_version(&self.min_manager_version).is_none() {
|
||||
return bad(format!("bad minManagerVersion {:?}", self.min_manager_version));
|
||||
}
|
||||
for migration in &self.migrations {
|
||||
if !is_sha256(&migration.sha256) || migration.compatible_sha256.iter().any(|h| !is_sha256(h) || h == &"0".repeat(64)) {
|
||||
return bad(format!("{}: invalid migration checksum compatibility", migration.id));
|
||||
}
|
||||
}
|
||||
for (label, rev) in [("core", Some(&self.core)), ("bots", self.bots.as_ref())] {
|
||||
if let Some(Revision { commit: Some(c) }) = rev {
|
||||
if !is_commit(c) {
|
||||
|
||||
@@ -19,6 +19,7 @@ pub enum Status {
|
||||
Applied,
|
||||
Pending,
|
||||
Failed,
|
||||
Running,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
@@ -34,6 +35,7 @@ pub struct LedgerRow {
|
||||
/// Storage for the ledger and the ability to run a SQL file; implemented by the real database and by tests.
|
||||
pub trait Store {
|
||||
fn load(&self) -> Result<Vec<LedgerRow>>;
|
||||
fn load_readonly(&self) -> Result<Vec<LedgerRow>> { self.load() }
|
||||
fn put(&self, row: &LedgerRow) -> Result<()>;
|
||||
fn run_file(&self, schema: &str, file: &Path) -> Result<()>;
|
||||
}
|
||||
@@ -51,11 +53,18 @@ impl Store for Db {
|
||||
self.query(&format!(
|
||||
"CREATE TABLE IF NOT EXISTS `{LEDGER_SCHEMA}`.`{LEDGER_TABLE}` (`db` VARCHAR(32) NOT NULL, `id` VARCHAR(190) NOT NULL, `sha256` CHAR(64) NOT NULL, `status` VARCHAR(16) NOT NULL, `applied_at` DATETIME NOT NULL, `error` TEXT NULL, `baseline` TINYINT NOT NULL DEFAULT 0, PRIMARY KEY (`db`,`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;"
|
||||
))?;
|
||||
let out = self.query(&format!("SELECT `db`,`id`,`sha256`,`status`,`baseline`,COALESCE(HEX(`error`),'') FROM `{LEDGER_SCHEMA}`.`{LEDGER_TABLE}` ORDER BY `db`,`id`;"))?;
|
||||
self.load_readonly()
|
||||
}
|
||||
|
||||
fn load_readonly(&self) -> Result<Vec<LedgerRow>> {
|
||||
let out = if self.tables(LEDGER_SCHEMA)?.iter().any(|name| name == LEDGER_TABLE) {
|
||||
self.query(&format!("SELECT `db`,`id`,`sha256`,`status`,`baseline`,COALESCE(HEX(`error`),'') FROM `{LEDGER_SCHEMA}`.`{LEDGER_TABLE}` ORDER BY `db`,`id`;"))?
|
||||
} else { String::new() };
|
||||
let mut rows = Vec::new();
|
||||
// Files the core's own updater (or whoever prepared this database) already recorded count as applied.
|
||||
for (kind, schema) in db::SCHEMAS {
|
||||
if let Ok(names) = self.query(&format!("SELECT name FROM `{schema}`.`updates`;")) {
|
||||
if self.tables(schema)?.iter().any(|name| name == "updates") {
|
||||
let names = self.query(&format!("SELECT name FROM `{schema}`.`updates`;"))?;
|
||||
for name in names.lines().filter(|n| n.ends_with(".sql")) {
|
||||
rows.push(LedgerRow { db: kind.into(), id: name.trim_end_matches(".sql").into(), sha256: "0".repeat(64), status: Status::Applied, error: None, baseline: true });
|
||||
}
|
||||
@@ -64,14 +73,17 @@ impl Store for Db {
|
||||
for line in out.lines().filter(|l| !l.is_empty()) {
|
||||
let f: Vec<&str> = line.split('\t').collect();
|
||||
if f.len() < 5 {
|
||||
continue;
|
||||
return Err(Error::Invalid("The database migration history is malformed; no SQL was replayed.".into()));
|
||||
}
|
||||
if !matches!(f[3], "applied" | "failed" | "running") || !ident_ok(f[1]) || f[2].len() != 64 || !f[2].chars().all(|c| c.is_ascii_hexdigit()) {
|
||||
return Err(Error::Invalid("The database migration history is invalid; no SQL was replayed.".into()));
|
||||
}
|
||||
let err = f.get(5).filter(|h| !h.is_empty()).and_then(|h| hex::decode(h).ok()).map(|b| String::from_utf8_lossy(&b).into_owned());
|
||||
rows.push(LedgerRow {
|
||||
db: f[0].into(),
|
||||
id: f[1].into(),
|
||||
sha256: f[2].into(),
|
||||
status: if f[3] == "applied" { Status::Applied } else { Status::Failed },
|
||||
status: match f[3] { "applied" => Status::Applied, "running" => Status::Running, _ => Status::Failed },
|
||||
baseline: f[4] == "1",
|
||||
error: err,
|
||||
});
|
||||
@@ -83,7 +95,7 @@ impl Store for Db {
|
||||
if !ident_ok(&r.id) || !ident_ok(&r.db) || r.sha256.len() != 64 || !r.sha256.chars().all(|c| c.is_ascii_hexdigit()) {
|
||||
return Err(Error::Invalid("migration record has an invalid identifier".into()));
|
||||
}
|
||||
let status = if r.status == Status::Applied { "applied" } else { "failed" };
|
||||
let status = match r.status { Status::Applied => "applied", Status::Running => "running", _ => "failed" };
|
||||
let err = r.error.as_deref().map(|e| format!("UNHEX('{}')", hex_of(e))).unwrap_or_else(|| "NULL".into());
|
||||
self.query(&format!(
|
||||
"REPLACE INTO `{LEDGER_SCHEMA}`.`{LEDGER_TABLE}` (`db`,`id`,`sha256`,`status`,`applied_at`,`error`,`baseline`) VALUES ('{}','{}','{}','{status}',NOW(),{err},{});",
|
||||
@@ -123,19 +135,73 @@ pub fn status(store: &dyn Store, list: &[Migration]) -> Result<Vec<Item>> {
|
||||
Ok(list
|
||||
.iter()
|
||||
.map(|m| {
|
||||
let row = rows.iter().find(|r| r.db == m.db && r.id == m.id);
|
||||
// Manager records are appended after the core's updates table and are authoritative.
|
||||
let row = recorded(&rows, m);
|
||||
let changed = row.is_some_and(|r| hash_changed(r, m));
|
||||
Item {
|
||||
id: m.id.clone(),
|
||||
db: m.db.clone(),
|
||||
status: row.map(|r| r.status).unwrap_or(Status::Pending),
|
||||
status: if changed || row.is_some_and(|r| r.status == Status::Running) { Status::Failed } else { row.map(|r| r.status).unwrap_or(Status::Pending) },
|
||||
destructive: m.destructive,
|
||||
baseline: row.map(|r| r.baseline).unwrap_or(false),
|
||||
error: row.and_then(|r| r.error.clone()),
|
||||
error: if changed { Some("An already applied SQL file changed. Publish a new migration instead of replaying it.".into()) } else { row.and_then(|r| r.error.clone()) },
|
||||
}
|
||||
})
|
||||
.collect())
|
||||
}
|
||||
|
||||
fn recorded<'a>(rows: &'a [LedgerRow], m: &Migration) -> Option<&'a LedgerRow> {
|
||||
rows.iter().rev().find(|r| r.db == m.db && r.id == m.id)
|
||||
}
|
||||
|
||||
fn hash_changed(row: &LedgerRow, m: &Migration) -> bool {
|
||||
row.status == Status::Applied && row.sha256 != "0".repeat(64) && !row.sha256.eq_ignore_ascii_case(&m.sha256)
|
||||
&& !m.compatible_sha256.iter().any(|hash| hash.eq_ignore_ascii_case(&row.sha256))
|
||||
}
|
||||
|
||||
/// Inspect recorded history without creating a ledger or executing migrations.
|
||||
pub fn preflight(store: &dyn Store, list: &[Migration]) -> Result<()> {
|
||||
check_history(&store.load_readonly()?, list)
|
||||
}
|
||||
|
||||
pub fn pending_count(store: &dyn Store, list: &[Migration]) -> Result<usize> {
|
||||
let rows = store.load_readonly()?;
|
||||
check_history(&rows, list)?;
|
||||
Ok(list.iter().filter(|m| recorded(&rows, m).is_none_or(|r| r.status != Status::Applied)).count())
|
||||
}
|
||||
|
||||
fn verified_file(m: &Migration, dir: &Path) -> Result<(&'static str, std::path::PathBuf, bool)> {
|
||||
if !ident_ok(&m.id) { return Err(Error::InvalidManifest(format!("migration id {:?} is not allowed", m.id))); }
|
||||
let schema = db::schema_of(&m.db)?;
|
||||
let path = fsx::safe_join(dir, &format!("{}/{}.sql", m.db, m.id))?;
|
||||
let bytes = std::fs::read(&path).map_err(|_| Error::Invalid(format!("migration file {} is missing", m.id)))?;
|
||||
let actual = fsx::sha256_bytes(&bytes);
|
||||
if !actual.eq_ignore_ascii_case(&m.sha256) { return Err(Error::HashMismatch { path: path.display().to_string(), expected: m.sha256.clone(), actual }); }
|
||||
Ok((schema, path, m.destructive || looks_destructive(&String::from_utf8_lossy(&bytes))))
|
||||
}
|
||||
|
||||
/// Check every migration artifact, including applied history, before replacing server files.
|
||||
pub fn verify_files(list: &[Migration], dir: &Path) -> Result<()> {
|
||||
let mut seen = std::collections::BTreeSet::new();
|
||||
for m in list {
|
||||
if !seen.insert((&m.db, &m.id)) { return Err(Error::InvalidManifest(format!("duplicate migration {} ({})", m.id, m.db))); }
|
||||
verified_file(m, dir)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn check_history(rows: &[LedgerRow], list: &[Migration]) -> Result<()> {
|
||||
for m in list {
|
||||
if recorded(rows, m).is_some_and(|r| matches!(r.status, Status::Running | Status::Failed)) {
|
||||
return Err(Error::Invalid(format!("Database update {} ({}) failed or was interrupted and may be partially applied. Restore its recovery point before retrying.", m.id, m.db)));
|
||||
}
|
||||
if recorded(rows, m).is_some_and(|r| hash_changed(r, m)) {
|
||||
return Err(Error::Invalid(format!("Applied database update {} ({}) has a different checksum. A new migration is required; it was not replayed.", m.id, m.db)));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Record migrations as already present without running them (adopting an existing server whose database
|
||||
/// was brought up to date by hand).
|
||||
pub fn baseline(store: &dyn Store, list: &[Migration]) -> Result<usize> {
|
||||
@@ -163,23 +229,16 @@ pub struct ApplyReport {
|
||||
pub fn apply_pending(store: &dyn Store, list: &[Migration], dir: &Path, snapshot: &dyn Fn() -> Result<String>) -> Result<ApplyReport> {
|
||||
let rows = store.load()?;
|
||||
// The list order is the release's order of application (released updates, then pending, then modules).
|
||||
let todo: Vec<&Migration> = list.iter().filter(|m| !rows.iter().any(|r| r.db == m.db && r.id == m.id && r.status == Status::Applied)).collect();
|
||||
check_history(&rows, list)?;
|
||||
let todo: Vec<&Migration> = list.iter().filter(|m| recorded(&rows, m).is_none_or(|r| r.status != Status::Applied)).collect();
|
||||
tracing::info!(total = list.len(), pending = todo.len(), skipped = list.len() - todo.len(), "database migration plan");
|
||||
|
||||
// Resolve and verify every file before running anything.
|
||||
let mut files = Vec::new();
|
||||
let mut any_destructive = false;
|
||||
for m in &todo {
|
||||
if !ident_ok(&m.id) {
|
||||
return Err(Error::InvalidManifest(format!("migration id {:?} is not allowed", m.id)));
|
||||
}
|
||||
let schema = db::schema_of(&m.db)?;
|
||||
let path = fsx::safe_join(dir, &format!("{}/{}.sql", m.db, m.id))?;
|
||||
let bytes = std::fs::read(&path).map_err(|_| Error::Invalid(format!("migration file {} is missing", m.id)))?;
|
||||
let actual = fsx::sha256_bytes(&bytes);
|
||||
if !actual.eq_ignore_ascii_case(&m.sha256) {
|
||||
return Err(Error::HashMismatch { path: path.display().to_string(), expected: m.sha256.clone(), actual });
|
||||
}
|
||||
any_destructive |= m.destructive || looks_destructive(&String::from_utf8_lossy(&bytes));
|
||||
let (schema, path, destructive) = verified_file(m, dir)?;
|
||||
any_destructive |= destructive;
|
||||
files.push((*m, schema, path));
|
||||
}
|
||||
|
||||
@@ -191,12 +250,16 @@ pub fn apply_pending(store: &dyn Store, list: &[Migration], dir: &Path, snapshot
|
||||
report.snapshot = Some(snapshot().map_err(|e| Error::Invalid(format!("No database update was applied because the safety backup failed: {e}")))?);
|
||||
}
|
||||
for (m, schema, path) in files {
|
||||
tracing::info!(migration = %m.id, database = %m.db, "database migration starting");
|
||||
store.put(&LedgerRow { db: m.db.clone(), id: m.id.clone(), sha256: m.sha256.clone(), status: Status::Running, error: Some("Interrupted SQL must be recovered before replay.".into()), baseline: false })?;
|
||||
match store.run_file(schema, &path) {
|
||||
Ok(()) => {
|
||||
store.put(&LedgerRow { db: m.db.clone(), id: m.id.clone(), sha256: m.sha256.clone(), status: Status::Applied, error: None, baseline: false })?;
|
||||
report.applied.push(m.id.clone());
|
||||
tracing::info!(migration = %m.id, database = %m.db, "database migration applied");
|
||||
}
|
||||
Err(e) => {
|
||||
tracing::error!(migration = %m.id, database = %m.db, "database migration failed; details saved in migration history");
|
||||
let msg = e.to_string();
|
||||
let _ = store.put(&LedgerRow { db: m.db.clone(), id: m.id.clone(), sha256: m.sha256.clone(), status: Status::Failed, error: Some(msg.clone()), baseline: false });
|
||||
report.failed = Some((m.id.clone(), msg));
|
||||
@@ -245,7 +308,7 @@ mod tests {
|
||||
for (db, id, sql) in files {
|
||||
std::fs::create_dir_all(d.path().join(db)).unwrap();
|
||||
std::fs::write(d.path().join(db).join(format!("{id}.sql")), sql).unwrap();
|
||||
list.push(Migration { id: id.to_string(), db: db.to_string(), sha256: fsx::sha256_bytes(sql.as_bytes()), destructive: false });
|
||||
list.push(Migration { compatible_sha256: vec![], id: id.to_string(), db: db.to_string(), sha256: fsx::sha256_bytes(sql.as_bytes()), destructive: false });
|
||||
}
|
||||
(d, list)
|
||||
}
|
||||
@@ -254,6 +317,82 @@ mod tests {
|
||||
panic!("no snapshot expected")
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn manager_failure_overrides_an_old_core_update_record() {
|
||||
let (d, list) = setup(&[("characters", "same_id", "SELECT 1;")]);
|
||||
let store = Mem::default();
|
||||
let old = LedgerRow { db: "characters".into(), id: "same_id".into(), sha256: "0".repeat(64), status: Status::Applied, error: None, baseline: true };
|
||||
let failed = LedgerRow { sha256: list[0].sha256.clone(), status: Status::Failed, error: Some("previous failure".into()), baseline: false, ..old.clone() };
|
||||
store.rows.borrow_mut().extend([old, failed]);
|
||||
assert_eq!(status(&store, &list).unwrap()[0].status, Status::Failed);
|
||||
assert!(apply_pending(&store, &list, d.path(), &no_snapshot).unwrap_err().to_string().contains("partially applied"));
|
||||
assert!(store.ran.borrow().is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn changed_applied_sql_is_reported_and_never_replayed() {
|
||||
let (d, list) = setup(&[("characters", "same_id", "SELECT 1;")]);
|
||||
let store = Mem::default();
|
||||
store.rows.borrow_mut().push(LedgerRow { db: "characters".into(), id: "same_id".into(), sha256: "a".repeat(64), status: Status::Applied, error: None, baseline: false });
|
||||
assert_eq!(status(&store, &list).unwrap()[0].status, Status::Failed);
|
||||
assert!(apply_pending(&store, &list, d.path(), &no_snapshot).is_err());
|
||||
assert!(store.ran.borrow().is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn staged_files_reject_missing_corrupt_duplicate_and_invalid_migrations() {
|
||||
let (dir, list) = setup(&[("characters", "repair", "SELECT 1;\n")]);
|
||||
verify_files(&list, dir.path()).unwrap();
|
||||
let mut bad = list.clone();
|
||||
bad[0].id = "../outside".into();
|
||||
assert!(verify_files(&bad, dir.path()).is_err());
|
||||
bad = list.clone();
|
||||
bad.push(list[0].clone());
|
||||
assert!(verify_files(&bad, dir.path()).is_err());
|
||||
std::fs::write(dir.path().join("characters/repair.sql"), b"SELECT 2;\n").unwrap();
|
||||
assert!(verify_files(&list, dir.path()).is_err());
|
||||
std::fs::remove_file(dir.path().join("characters/repair.sql")).unwrap();
|
||||
assert!(verify_files(&list, dir.path()).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn preflight_uses_readonly_history_and_rejects_conflicts_without_writes() {
|
||||
struct ReadOnly<'a>(&'a Mem);
|
||||
impl Store for ReadOnly<'_> {
|
||||
fn load(&self) -> Result<Vec<LedgerRow>> { panic!("preflight must use readonly access") }
|
||||
fn load_readonly(&self) -> Result<Vec<LedgerRow>> { self.0.load() }
|
||||
fn put(&self, _: &LedgerRow) -> Result<()> { panic!("preflight must not rewrite history") }
|
||||
fn run_file(&self, _: &str, _: &Path) -> Result<()> { panic!("preflight must not run SQL") }
|
||||
}
|
||||
let (_d, list) = setup(&[("characters", "repair", "SELECT 1;\n")]);
|
||||
for state in [Status::Applied, Status::Running, Status::Failed] {
|
||||
let store = Mem::default();
|
||||
store.rows.borrow_mut().push(LedgerRow { db: "characters".into(), id: "repair".into(), sha256: "a".repeat(64), status: state, error: None, baseline: false });
|
||||
assert!(preflight(&ReadOnly(&store), &list).is_err());
|
||||
assert_eq!(store.rows.borrow()[0].sha256, "a".repeat(64));
|
||||
assert_eq!(store.rows.borrow()[0].status, state);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn published_compatibility_preserves_history_and_never_replays_sql() {
|
||||
let (d, mut list) = setup(&[("characters", "repair", "SELECT 1;\n")]);
|
||||
let store = Mem::default();
|
||||
let old = fsx::sha256_bytes(b"SELECT 1;\r\n");
|
||||
store.rows.borrow_mut().push(LedgerRow { db: "characters".into(), id: "repair".into(), sha256: old.clone(), status: Status::Applied, error: None, baseline: false });
|
||||
assert!(apply_pending(&store, &list, d.path(), &no_snapshot).is_err());
|
||||
list[0].compatible_sha256.push(old.clone());
|
||||
assert_eq!(status(&store, &list).unwrap()[0].status, Status::Applied);
|
||||
assert!(apply_pending(&store, &list, d.path(), &no_snapshot).unwrap().applied.is_empty());
|
||||
assert!(store.ran.borrow().is_empty());
|
||||
assert_eq!(store.rows.borrow()[0].sha256, old);
|
||||
store.rows.borrow_mut()[0].status = Status::Running;
|
||||
assert!(apply_pending(&store, &list, d.path(), &no_snapshot).is_err());
|
||||
store.rows.borrow_mut()[0].status = Status::Failed;
|
||||
assert!(apply_pending(&store, &list, d.path(), &no_snapshot).is_err());
|
||||
assert!(store.ran.borrow().is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn applies_in_order_once_and_records_the_ledger() {
|
||||
let (d, list) = setup(&[("world", "2026_09_01_00_a", "CREATE TABLE t (id INT);"), ("world", "2026_09_02_00_b", "ALTER TABLE t ADD c INT;")]);
|
||||
@@ -304,6 +443,16 @@ mod tests {
|
||||
assert!(apply_pending(&store, &list[..1], d.path(), &no_snapshot).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn interrupted_sql_is_reported_and_never_automatically_replayed() {
|
||||
let (d, list) = setup(&[("world", "partial", "DROP TABLE valuable;")]);
|
||||
let store = Mem::default();
|
||||
store.rows.borrow_mut().push(LedgerRow { db: "world".into(), id: "partial".into(), sha256: list[0].sha256.clone(), status: Status::Running, error: Some("interrupted".into()), baseline: false });
|
||||
assert_eq!(status(&store, &list).unwrap()[0].status, Status::Failed);
|
||||
assert!(apply_pending(&store, &list, d.path(), &no_snapshot).unwrap_err().to_string().contains("interrupted"));
|
||||
assert!(store.ran.borrow().is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn baseline_marks_without_running_and_hostile_ids_are_rejected() {
|
||||
let (d, list) = setup(&[("world", "b1", "SELECT 1;")]);
|
||||
|
||||
+281
-10
@@ -87,10 +87,13 @@ fn truthy(v: &str) -> bool {
|
||||
pub struct ModuleView {
|
||||
pub id: String,
|
||||
pub name: String,
|
||||
pub version: Option<String>,
|
||||
pub description: BTreeMap<String, String>,
|
||||
pub repo: String,
|
||||
/// The module's configuration is present on this server (otherwise it is not part of this server build).
|
||||
pub installed: bool,
|
||||
/// At least one editable setting besides the master switch exists in this server build.
|
||||
pub has_settings: bool,
|
||||
pub enabled: bool,
|
||||
pub switchable: bool,
|
||||
pub status: String,
|
||||
@@ -125,17 +128,28 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
||||
let conf = dir(root).join(&name);
|
||||
let dist = dir(root).join(format!("{name}.dist"));
|
||||
let installed = conf.is_file() || dist.is_file();
|
||||
let has_settings = installed && settings_in(cat, root, &e.id)
|
||||
.map(|settings| settings.iter().any(|s| s.key != e.enable_key))
|
||||
.unwrap_or(false);
|
||||
// the active file decides; without one the documented default is what the server will use
|
||||
let enabled = !e.switchable
|
||||
|| read(&conf).or_else(|| read(&dist)).and_then(|c| c.get(&e.enable_key).map(truthy)).unwrap_or(e.default_on);
|
||||
let enabled = if matches!(e.id.as_str(), "companions" | "playerbots") {
|
||||
bot_enabled(root, &e).unwrap_or(true)
|
||||
} else {
|
||||
!e.switchable || read(&conf).or_else(|| read(&dist)).and_then(|c| c.get(&e.enable_key).map(truthy)).unwrap_or(e.default_on)
|
||||
};
|
||||
let blocked = wildcard && matches!(e.id.as_str(), "companions" | "playerbots");
|
||||
let version = if e.id == "playerbots" { crate::squid::release(root).map(|release| {
|
||||
[release.tag, release.commit.map(|commit| commit.chars().take(8).collect())].into_iter().flatten().collect::<Vec<_>>().join(" · ")
|
||||
}) } else { None };
|
||||
ModuleView {
|
||||
version,
|
||||
compatibility: if blocked { "unsupported" } else if wildcard && e.id != "client-compat" { "experimental" } else { "compatible" }.into(),
|
||||
id: e.id,
|
||||
name: e.name,
|
||||
description: e.description,
|
||||
repo: e.repo,
|
||||
installed,
|
||||
has_settings,
|
||||
enabled: enabled && !blocked,
|
||||
switchable: e.switchable && !blocked,
|
||||
status: e.status,
|
||||
@@ -167,16 +181,61 @@ fn backup(meta: &Path, conf: &Path) -> Result<()> {
|
||||
fsx::atomic_write(&to, &fs::read(conf)?)
|
||||
}
|
||||
|
||||
fn require_bot_server_stopped(root: &Path) -> Result<()> {
|
||||
let observed = crate::process::observe(root, &crate::layout::read_ports(root));
|
||||
if observed.world.state != crate::process::ServiceState::Stopped || crate::multiworld::is_running(root) {
|
||||
return Err(Error::Invalid("Stop the server before changing the bot system.".into()));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
|
||||
let _update_lock = crate::update::operation_lock(meta)?;
|
||||
crate::update::ensure_recovered(meta)?;
|
||||
let _lock = if matches!(id, "companions" | "playerbots") {
|
||||
require_bot_server_stopped(root)?;
|
||||
fs::create_dir_all(root.join(".state"))?;
|
||||
let lock = fs::OpenOptions::new().read(true).write(true).create(true).truncate(false).open(root.join(".state/control.lock"))?;
|
||||
if !fs4::fs_std::FileExt::try_lock_exclusive(&lock)? {
|
||||
return Err(Error::Invalid("Another start/stop action is in progress.".into()));
|
||||
}
|
||||
require_bot_server_stopped(root)?;
|
||||
Some(lock)
|
||||
} else { None };
|
||||
if on { crate::realms::guard_module(root, id)?; }
|
||||
set_enabled_in(&catalog(), root, meta, id, on)
|
||||
}
|
||||
|
||||
fn bot_enabled(root: &Path, e: &Entry) -> Result<bool> {
|
||||
let name = conf_name(root, e);
|
||||
let conf = dir(root).join(&name);
|
||||
let dist = dir(root).join(format!("{name}.dist"));
|
||||
let path = if conf.exists() { conf } else { dist };
|
||||
if !path.exists() { return Ok(false); }
|
||||
let file = ConfFile::parse_bytes(&fs::read(path)?)?;
|
||||
// Invalid booleans use the modules' enabled compiled default: fail closed.
|
||||
Ok(file.get(&e.enable_key).map(|v| !matches!(v.trim().trim_matches('"').to_ascii_lowercase().as_str(), "0" | "false" | "no" | "off")).unwrap_or(true))
|
||||
}
|
||||
|
||||
pub fn ensure_bot_exclusivity(root: &Path) -> Result<()> {
|
||||
let cat = catalog();
|
||||
if bot_enabled(root, &entry_in(&cat, "companions")?)? && bot_enabled(root, &entry_in(&cat, "playerbots")?)? {
|
||||
return Err(Error::BotModulesConflict);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
|
||||
let e = entry_in(cat, id)?;
|
||||
if !e.switchable || e.enable_key.is_empty() {
|
||||
return Err(Error::Invalid("This part cannot be switched off.".into()));
|
||||
}
|
||||
if on && matches!(id, "companions" | "playerbots") {
|
||||
let other = if id == "companions" { "playerbots" } else { "companions" };
|
||||
if let Some(other) = cat.iter().find(|e| e.id == other) {
|
||||
if bot_enabled(root, other)? { return Err(Error::BotModulesConflict); }
|
||||
}
|
||||
}
|
||||
let conf = active_file(root, &e)?;
|
||||
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
|
||||
if file.get(&e.enable_key).map(truthy).unwrap_or(e.default_on) == on && file.get(&e.enable_key).is_some() {
|
||||
@@ -189,13 +248,14 @@ fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, PartialEq, Eq)]
|
||||
#[derive(Debug, Serialize, PartialEq)]
|
||||
pub struct Setting {
|
||||
pub key: String,
|
||||
pub value: String,
|
||||
pub default: Option<String>,
|
||||
/// The documentation the module ships above the setting.
|
||||
pub doc: String,
|
||||
pub field: Option<crate::squid::Field>,
|
||||
}
|
||||
|
||||
/// Every active setting of the module with its current value, its documented default and its description.
|
||||
@@ -209,12 +269,22 @@ fn settings_in(cat: &[Entry], root: &Path, id: &str) -> Result<Vec<Setting>> {
|
||||
let conf = dir(root).join(&name);
|
||||
let dist = read(&dir(root).join(format!("{name}.dist")));
|
||||
let active = read(&conf).or_else(|| dist.clone()).ok_or_else(|| Error::Invalid("This module is not part of this server.".into()))?;
|
||||
Ok(active
|
||||
let fields = if id == "playerbots" { crate::squid::fields(root)? } else { Default::default() };
|
||||
let mut effective = active.clone();
|
||||
if let Some(defaults) = &dist {
|
||||
for (key, value) in defaults.entries() {
|
||||
if effective.get(key).is_none() {
|
||||
effective.set(key, value, &[]);
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(effective
|
||||
.entries()
|
||||
.map(|(k, v)| Setting {
|
||||
key: k.to_string(),
|
||||
value: v.to_string(),
|
||||
default: dist.as_ref().and_then(|d| d.get(k)).map(str::to_string),
|
||||
value: fields.get(k).and_then(|field| field.default_if_missing.as_ref()).filter(|_| active.get(k).is_none()).and_then(crate::squid::scalar).unwrap_or_else(|| v.to_string()),
|
||||
default: fields.get(k).and_then(|field| crate::squid::scalar(&field.default)).or_else(|| dist.as_ref().and_then(|d| d.get(k)).map(str::to_string)),
|
||||
field: fields.get(k).cloned(),
|
||||
doc: dist.as_ref().map(|d| d.doc_for(k)).filter(|d| !d.is_empty()).unwrap_or_else(|| active.doc_for(k)).join(" "),
|
||||
})
|
||||
.collect())
|
||||
@@ -230,13 +300,41 @@ fn save_settings_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, changes:
|
||||
let e = entry_in(cat, id)?;
|
||||
let conf = active_file(root, &e)?;
|
||||
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
|
||||
let dist = read(&dir(root).join(format!("{}.dist", conf_name(root, &e))));
|
||||
let fields = if id == "playerbots" { crate::squid::fields(root)? } else { Default::default() };
|
||||
let mut changed = Vec::new();
|
||||
for (key, value) in changes {
|
||||
let value = value.trim();
|
||||
if file.get(key).is_none() {
|
||||
if let Some(field) = fields.get(key) { crate::squid::validate(field, value)?; }
|
||||
if e.switchable && key == &e.enable_key {
|
||||
return Err(Error::Invalid("Use the module switch to turn this module on or off.".into()));
|
||||
}
|
||||
if id == "content-scaling" && key == "CoAContentScaling.Difficulty.DamageMultiplier" {
|
||||
let multiplier = value.parse::<f32>().map_err(|_| Error::Invalid("Enemy damage must be a number from 0.25 to 2.0.".into()))?;
|
||||
if !multiplier.is_finite() || !(0.25..=2.0).contains(&multiplier) {
|
||||
return Err(Error::Invalid("Enemy damage must be a number from 0.25 to 2.0.".into()));
|
||||
}
|
||||
}
|
||||
if id == "content-scaling" && key == "CoAContentScaling.World.Leech.Percent" {
|
||||
let percent = value.parse::<f32>().map_err(|_| Error::Invalid("Life steal must be a number from 0 to 100 percent.".into()))?;
|
||||
if !percent.is_finite() || !(0.0..=100.0).contains(&percent) {
|
||||
return Err(Error::Invalid("Life steal must be a number from 0 to 100 percent.".into()));
|
||||
}
|
||||
}
|
||||
if id == "content-scaling" && matches!(key.as_str(), "CoAContentScaling.LFG.AllowPartialGroups" | "CoAContentScaling.World.Leech.Enable") && !matches!(value, "0" | "1") {
|
||||
return Err(Error::Invalid(format!("{key} must be 0 or 1.")));
|
||||
}
|
||||
if id == "ah-bot" && key.starts_with("AuctionHouseBot.ListProportion.Category") && key.contains(".Quality") {
|
||||
let weight = value.parse::<u32>().map_err(|_| Error::Invalid("Auction listing weights must be whole numbers from 0 to 1000.".into()))?;
|
||||
if weight > 1000 {
|
||||
return Err(Error::Invalid("Auction listing weights must be whole numbers from 0 to 1000.".into()));
|
||||
}
|
||||
}
|
||||
if file.get(key).is_none() && dist.as_ref().and_then(|d| d.get(key)).is_none() {
|
||||
return Err(Error::Invalid(format!("{key} is not a setting of this module.")));
|
||||
}
|
||||
if value.is_empty() || value.len() > 500 || value.chars().any(char::is_control) {
|
||||
let documented_empty = dist.as_ref().and_then(|d| d.get(key)).map(str::trim) == Some("");
|
||||
if (value.is_empty() && !documented_empty) || value.len() > 500 || value.chars().any(char::is_control) {
|
||||
return Err(Error::Invalid(format!("The value of {key} must be one line of text.")));
|
||||
}
|
||||
if file.get(key).map(str::trim) != Some(value) {
|
||||
@@ -286,6 +384,61 @@ mod tests {
|
||||
(root, meta)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn squid_missing_keys_use_code_defaults_and_saves_enforce_json_ranges() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path();
|
||||
fs::create_dir_all(dir(root)).unwrap();
|
||||
fs::write(dir(root).join("playerbots.conf"), "AiPlayerbot.Enabled = 0\n").unwrap();
|
||||
fs::write(dir(root).join("playerbots.conf.dist"), "AiPlayerbot.Enabled = 0\nAiPlayerbot.MinRandomBots = 500\n").unwrap();
|
||||
fs::write(dir(root).join("playerbots.conf.settings.json"), r#"{"format":1,"groups":{"population":"Population"},"settings":[{"key":"AiPlayerbot.MinRandomBots","type":"int","group":"population","title":"Minimum bots","description":"Lower bound","default":500,"default_if_missing":50,"min":0,"max":5000}]}"#).unwrap();
|
||||
let cat = catalog();
|
||||
let options = settings_in(&cat, root, "playerbots").unwrap();
|
||||
let option = options.iter().find(|setting| setting.key == "AiPlayerbot.MinRandomBots").unwrap();
|
||||
assert_eq!(option.value, "50");
|
||||
assert_eq!(option.default.as_deref(), Some("500"));
|
||||
assert_eq!(option.field.as_ref().unwrap().group_title.as_deref(), Some("Population"));
|
||||
let before = fs::read(dir(root).join("playerbots.conf")).unwrap();
|
||||
assert!(save_settings_in(&cat, root, root, "playerbots", &BTreeMap::from([("AiPlayerbot.MinRandomBots".into(), "5001".into())])).is_err());
|
||||
assert_eq!(fs::read(dir(root).join("playerbots.conf")).unwrap(), before);
|
||||
save_settings_in(&cat, root, root, "playerbots", &BTreeMap::from([("AiPlayerbot.MinRandomBots".into(), "42".into())])).unwrap();
|
||||
assert_eq!(settings_in(&cat, root, "playerbots").unwrap().iter().find(|setting| setting.key == "AiPlayerbot.MinRandomBots").unwrap().value, "42");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bot_systems_are_mutually_exclusive_in_both_directions_and_manual_configs() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path();
|
||||
fs::create_dir_all(dir(root)).unwrap();
|
||||
let a = dir(root).join("mod_coa_playerbots.conf");
|
||||
let b = dir(root).join("playerbots.conf");
|
||||
fs::write(&a, "CoaBots.Enable = 1\n").unwrap();
|
||||
fs::write(&b, "AiPlayerbot.Enabled = 0\n").unwrap();
|
||||
assert!(ensure_bot_exclusivity(root).is_ok());
|
||||
assert!(matches!(set_enabled_in(&catalog(), root, root, "playerbots", true), Err(Error::BotModulesConflict)));
|
||||
assert_eq!(fs::read_to_string(&b).unwrap(), "AiPlayerbot.Enabled = 0\n");
|
||||
fs::write(&a, "CoaBots.Enable = 0\n").unwrap();
|
||||
set_enabled_in(&catalog(), root, root, "playerbots", true).unwrap();
|
||||
assert!(matches!(set_enabled_in(&catalog(), root, root, "companions", true), Err(Error::BotModulesConflict)));
|
||||
fs::write(&a, "CoaBots.Enable = true\n").unwrap();
|
||||
assert!(matches!(ensure_bot_exclusivity(root), Err(Error::BotModulesConflict)));
|
||||
fs::write(&b, "# missing key uses the compiled enabled default\n").unwrap();
|
||||
assert!(matches!(ensure_bot_exclusivity(root), Err(Error::BotModulesConflict)));
|
||||
set_enabled_in(&catalog(), root, root, "companions", false).unwrap();
|
||||
assert!(ensure_bot_exclusivity(root).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn startup_rejects_conflicting_bots_before_launching_any_service() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
fs::create_dir_all(dir(d.path())).unwrap();
|
||||
fs::write(dir(d.path()).join("mod_coa_playerbots.conf"), "CoaBots.Enable = 1").unwrap();
|
||||
fs::write(dir(d.path()).join("playerbots.conf"), "AiPlayerbot.Enabled = 1").unwrap();
|
||||
for verb in [crate::driver::Verb::StartAll, crate::driver::Verb::StartWorld] {
|
||||
assert!(matches!(crate::driver::run(d.path(), verb), Err(Error::BotModulesConflict)));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_bundled_catalog_is_valid() {
|
||||
let c = catalog();
|
||||
@@ -293,7 +446,7 @@ mod tests {
|
||||
for e in &c {
|
||||
assert!(e.description.contains_key("en") && e.description.len() == 5, "{} has all five descriptions", e.id);
|
||||
assert!(e.repo.starts_with("https://github.com/") && e.conf.ends_with(".conf"), "{}", e.id);
|
||||
assert!(!e.switchable || e.enable_key.ends_with(".Enable"), "{} needs the setting that switches it", e.id);
|
||||
assert!(!e.switchable || (e.enable_key.ends_with(".Enable") || e.enable_key.ends_with(".Enabled")), "{} needs the setting that switches it", e.id);
|
||||
assert!(["soon", "early", "beta", "release"].contains(&e.status.as_str()), "{} has an unknown status", e.id);
|
||||
assert!(e.status != "soon" || !e.switchable, "{} is only announced, so it cannot be switched", e.id);
|
||||
}
|
||||
@@ -334,7 +487,7 @@ mod tests {
|
||||
let (root, meta) = server(d.path());
|
||||
let s = settings_in(&test_catalog(), &root, "war-games").unwrap();
|
||||
assert_eq!(s.len(), 2);
|
||||
assert_eq!(s[1], Setting { key: "WarGames.ChallengeSeconds".into(), value: "60".into(), default: Some("60".into()), doc: "How long a challenge stays open.".into() });
|
||||
assert_eq!(s[1], Setting { key: "WarGames.ChallengeSeconds".into(), value: "60".into(), default: Some("60".into()), doc: "How long a challenge stays open.".into(), field: None });
|
||||
assert_eq!(s[0].doc, "Turns War Games on. Second line.");
|
||||
|
||||
let ok = BTreeMap::from([("WarGames.ChallengeSeconds".to_string(), "90".to_string())]);
|
||||
@@ -348,6 +501,124 @@ mod tests {
|
||||
assert!(!fs::read_to_string(dir(&root).join("war_games.conf")).unwrap().contains("Injected"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn updated_module_defaults_are_visible_and_can_be_saved_in_an_existing_config() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let (root, meta) = server(d.path());
|
||||
fs::write(dir(&root).join("war_games.conf"), "WarGames.Enable = 0\n").unwrap();
|
||||
let cat = test_catalog();
|
||||
let values = settings_in(&cat, &root, "war-games").unwrap();
|
||||
assert_eq!(values.iter().find(|s| s.key == "WarGames.Enable").unwrap().value, "0");
|
||||
assert_eq!(values.iter().find(|s| s.key == "WarGames.ChallengeSeconds").unwrap().value, "60");
|
||||
let changes = BTreeMap::from([("WarGames.ChallengeSeconds".to_string(), "90".to_string())]);
|
||||
save_settings_in(&cat, &root, &meta, "war-games", &changes).unwrap();
|
||||
let text = fs::read_to_string(dir(&root).join("war_games.conf")).unwrap();
|
||||
assert!(text.contains("WarGames.Enable = 0") && text.contains("WarGames.ChallengeSeconds = 90"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn module_enable_cannot_be_changed_through_the_settings_editor() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let (root, meta) = server(d.path());
|
||||
let changes = BTreeMap::from([("WarGames.Enable".into(), "0".into())]);
|
||||
assert!(save_settings_in(&test_catalog(), &root, &meta, "war-games", &changes).is_err());
|
||||
assert_eq!(settings_in(&test_catalog(), &root, "war-games").unwrap()[0].value, "1");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn settings_button_requires_more_than_the_master_switch() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let (root, _) = server(d.path());
|
||||
let cat = test_catalog();
|
||||
assert!(list_in(&cat, &root).iter().find(|m| m.id == "war-games").unwrap().has_settings);
|
||||
fs::write(dir(&root).join("war_games.conf.dist"), "WarGames.Enable = 1\n").unwrap();
|
||||
assert!(!list_in(&cat, &root).iter().find(|m| m.id == "war-games").unwrap().has_settings);
|
||||
fs::write(dir(&root).join("war_games.conf"), "WarGames.Enable = 0\nWarGames.ChallengeSeconds = 90\n").unwrap();
|
||||
assert!(list_in(&cat, &root).iter().find(|m| m.id == "war-games").unwrap().has_settings, "custom active settings remain editable");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn documented_empty_lists_can_be_restored() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let (root, meta) = server(d.path());
|
||||
fs::write(dir(&root).join("war_games.conf.dist"), "WarGames.Enable = 1\nWarGames.ExcludedItems = \n").unwrap();
|
||||
fs::write(dir(&root).join("war_games.conf"), "WarGames.Enable = 1\nWarGames.ExcludedItems = 42\n").unwrap();
|
||||
let changes = BTreeMap::from([("WarGames.ExcludedItems".into(), "".into())]);
|
||||
save_settings_in(&test_catalog(), &root, &meta, "war-games", &changes).unwrap();
|
||||
assert_eq!(settings_in(&test_catalog(), &root, "war-games").unwrap().iter().find(|s| s.key == "WarGames.ExcludedItems").unwrap().value, "");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn auction_type_weights_are_validated_before_any_setting_is_written() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let (root, meta) = server(d.path());
|
||||
let cat = catalog();
|
||||
let key = "AuctionHouseBot.ListProportion.CategoryWeapon.QualityNormal";
|
||||
let conf = dir(&root).join("mod_ahbot.conf");
|
||||
fs::write(&conf, format!("AuctionHouseBot.Enable = true\nAuctionHouseBot.ItemsPerCycle = 150\n{key} = 20\n")).unwrap();
|
||||
let original = fs::read(&conf).unwrap();
|
||||
for bad in ["-1", "1.5", "NaN", "1001", "", "4294967296"] {
|
||||
let changes = BTreeMap::from([("AuctionHouseBot.ItemsPerCycle".into(), "25".into()), (key.into(), bad.into())]);
|
||||
assert!(save_settings_in(&cat, &root, &meta, "ah-bot", &changes).is_err(), "{bad}");
|
||||
assert_eq!(fs::read(&conf).unwrap(), original, "no partial save for {bad}");
|
||||
}
|
||||
let off = BTreeMap::from([(key.into(), "0".into())]);
|
||||
save_settings_in(&cat, &root, &meta, "ah-bot", &off).unwrap();
|
||||
assert_eq!(settings_in(&cat, &root, "ah-bot").unwrap().iter().find(|s| s.key == key).unwrap().value, "0");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn partial_lfg_and_world_leech_settings_round_trip_and_reject_invalid_values() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let (root, meta) = server(d.path());
|
||||
let cat = catalog();
|
||||
let conf = dir(&root).join("mod-coa-content-scaling.conf.dist");
|
||||
let partial = "CoAContentScaling.LFG.AllowPartialGroups";
|
||||
let enable = "CoAContentScaling.World.Leech.Enable";
|
||||
let percent = "CoAContentScaling.World.Leech.Percent";
|
||||
let change = |k: &str, v: &str| BTreeMap::from([(k.into(), v.into())]);
|
||||
fs::write(&conf, "CoAContentScaling.Enable = 1\n").unwrap();
|
||||
for key in [partial, enable, percent] {
|
||||
assert!(save_settings_in(&cat, &root, &meta, "content-scaling", &change(key, "1")).is_err());
|
||||
}
|
||||
fs::write(&conf, format!("CoAContentScaling.Enable = 1\n{partial} = 1\n{enable} = 0\n{percent} = 5.0\n")).unwrap();
|
||||
for bad in ["NaN", "inf", "-0.1", "100.1", "abc"] {
|
||||
assert!(save_settings_in(&cat, &root, &meta, "content-scaling", &change(percent, bad)).is_err());
|
||||
}
|
||||
for key in [partial, enable] {
|
||||
for bad in ["2", "-1", "true", "abc"] {
|
||||
assert!(save_settings_in(&cat, &root, &meta, "content-scaling", &change(key, bad)).is_err());
|
||||
}
|
||||
for good in ["0", "1"] {
|
||||
save_settings_in(&cat, &root, &meta, "content-scaling", &change(key, good)).unwrap();
|
||||
}
|
||||
}
|
||||
for good in ["0", "10.5", "100"] {
|
||||
save_settings_in(&cat, &root, &meta, "content-scaling", &change(percent, good)).unwrap();
|
||||
let settings = settings_in(&cat, &root, "content-scaling").unwrap();
|
||||
assert_eq!(settings.iter().find(|s| s.key == percent).unwrap().value, good);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn damage_difficulty_is_validated_and_older_server_builds_do_not_accept_it() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let (root, meta) = server(d.path());
|
||||
let cat = catalog();
|
||||
let conf = dir(&root).join("mod-coa-content-scaling.conf.dist");
|
||||
fs::write(&conf, "CoAContentScaling.Enable = 1\n").unwrap();
|
||||
let key = "CoAContentScaling.Difficulty.DamageMultiplier";
|
||||
let changes = |v: &str| BTreeMap::from([(key.into(), v.into())]);
|
||||
assert!(save_settings_in(&cat, &root, &meta, "content-scaling", &changes("0.5")).is_err());
|
||||
fs::write(&conf, format!("CoAContentScaling.Enable = 1\n{key} = 1.0\n")).unwrap();
|
||||
for bad in ["NaN", "inf", "0", "0.24", "2.01", "abc"] {
|
||||
assert!(save_settings_in(&cat, &root, &meta, "content-scaling", &changes(bad)).is_err(), "{bad}");
|
||||
}
|
||||
assert_eq!(save_settings_in(&cat, &root, &meta, "content-scaling", &changes("0.25")).unwrap(), [key]);
|
||||
assert_eq!(save_settings_in(&cat, &root, &meta, "content-scaling", &changes("2")).unwrap(), [key]);
|
||||
assert_eq!(settings_in(&cat, &root, "content-scaling").unwrap().iter().find(|s| s.key == key).unwrap().value, "2");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_older_file_name_is_used_when_the_current_one_is_missing_and_a_part_that_cannot_be_switched_stays_on() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
|
||||
@@ -0,0 +1,164 @@
|
||||
//! A second supervised world with isolated configs, logs and ports; auth and MySQL remain shared.
|
||||
use std::{collections::BTreeMap, fs, path::{Path, PathBuf}};
|
||||
use crate::{Error, Result, fsx, realms::{self, Mode, RealmState}, driver::{self, Verb}, process::{self, ServiceState}};
|
||||
|
||||
pub fn root(main: &Path) -> PathBuf { main.join(".realms/secondary") }
|
||||
|
||||
pub fn is_running(main: &Path) -> bool {
|
||||
let second = root(main);
|
||||
if !second.exists() { return false; }
|
||||
let status = process::observe(&second, &crate::layout::read_ports(&second));
|
||||
status.world.state != ServiceState::Stopped
|
||||
|| ["supervisor", "relay"].iter().any(|n| process::read_state_record(&second, n).is_some_and(|p| process::is_alive(&p)))
|
||||
}
|
||||
|
||||
fn copy_tree(from: &Path, to: &Path) -> Result<()> {
|
||||
fs::create_dir_all(to)?;
|
||||
for entry in fs::read_dir(from)? {
|
||||
let entry = entry?;
|
||||
if entry.file_name() == "Logs" || entry.file_name() == "reports" || entry.file_name() == "__pycache__" { continue; }
|
||||
if entry.file_type()?.is_symlink() { return Err(Error::Invalid("A linked runtime file cannot be used for a second realm.".into())); }
|
||||
let target = fsx::ensure_within(to, &to.join(entry.file_name()))?;
|
||||
if entry.file_type()?.is_dir() { copy_tree(&entry.path(), &target)?; }
|
||||
else if !target.is_file() || fsx::sha256_file(&entry.path())? != fsx::sha256_file(&target)? { fs::copy(entry.path(), target)?; }
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn set_enabled(main: &Path, enabled: bool) -> Result<realms::View> {
|
||||
if enabled && !cfg!(windows) { return Err(Error::Invalid("Simultaneous realms currently require Windows.".into())); }
|
||||
if enabled {
|
||||
if !realms::view(main)?.supported { return Err(Error::Invalid("Update the server to a build with Wildcard support first.".into())); }
|
||||
secondary_launcher(&fs::read_to_string(main.join("Scripts/manage.py"))?)?;
|
||||
}
|
||||
let status = process::observe(main, &crate::layout::read_ports(main));
|
||||
if status.world.state != ServiceState::Stopped || status.auth.state != ServiceState::Stopped || is_running(main) {
|
||||
return Err(Error::Invalid("Stop both realms before changing simultaneous startup.".into()));
|
||||
}
|
||||
let original = realms::state(main)?.active;
|
||||
if enabled && !realms::state(main)?.wildcard_created {
|
||||
realms::select(main, Mode::Wildcard)?;
|
||||
if original != Mode::Wildcard { realms::select(main, original)?; }
|
||||
}
|
||||
let mut s = realms::state(main)?;
|
||||
if enabled {
|
||||
let p = crate::layout::read_ports(main);
|
||||
let mut reserved = vec![p.mysql, p.auth, p.world, p.ra];
|
||||
let mut choose = |saved: Option<u16>, near: u16| -> Result<u16> {
|
||||
if let Some(port) = saved.filter(|p| *p > 0 && !reserved.contains(p)) { reserved.push(port); return Ok(port); }
|
||||
let port = (near.saturating_add(1)..=u16::MAX).find(|p| !reserved.contains(p) && std::net::TcpListener::bind(("127.0.0.1", *p)).is_ok())
|
||||
.ok_or_else(|| Error::Invalid("No free port for the second realm.".into()))?;
|
||||
reserved.push(port); Ok(port)
|
||||
};
|
||||
s.secondary_world_port = Some(choose(s.secondary_world_port, p.world)?);
|
||||
s.secondary_ra_port = Some(choose(s.secondary_ra_port, p.ra)?);
|
||||
}
|
||||
s.simultaneous = enabled;
|
||||
fsx::atomic_write_json(&main.join("Settings/realm-profile.json"), &s)?;
|
||||
realms::view(main)
|
||||
}
|
||||
|
||||
fn prepare(main: &Path) -> Result<PathBuf> {
|
||||
if is_running(main) { return Err(Error::Invalid("The second realm is still running; stop it before preparing its files.".into())); }
|
||||
let s = realms::state(main)?;
|
||||
let mode = if s.active == Mode::Coa { Mode::Wildcard } else { Mode::Coa };
|
||||
let second = fsx::ensure_within(main, &root(main))?;
|
||||
for folder in ["Runtime", "BugReport", "mysql/bin"] { copy_tree(&main.join(folder), &fsx::ensure_within(&second, &second.join(folder))?)?; }
|
||||
if main.join("Scripts/squid_playerbots.py").is_file() {
|
||||
fs::create_dir_all(second.join("Scripts"))?;
|
||||
fs::copy(main.join("Scripts/squid_playerbots.py"), second.join("Scripts/squid_playerbots.py"))?;
|
||||
}
|
||||
if main.join("Core/reference").is_dir() { copy_tree(&main.join("Core/reference"), &fsx::ensure_within(&second, &second.join("Core/reference"))?)?; }
|
||||
for entry in fs::read_dir(main.join("Core"))? {
|
||||
let entry = entry?;
|
||||
if entry.file_type()?.is_file() && (entry.file_name() == "worldserver.exe" || entry.path().extension().is_some_and(|x| x == "dll")) {
|
||||
fs::create_dir_all(second.join("Core"))?;
|
||||
fs::copy(entry.path(), fsx::ensure_within(&second, &second.join("Core").join(entry.file_name()))?)?;
|
||||
}
|
||||
}
|
||||
let files: BTreeMap<String, Vec<u8>> = fsx::read_json(&main.join(format!("Settings/realm-profiles/{}.json", mode.name())))?;
|
||||
// A previous secondary run may have used the other realm's module files.
|
||||
for path in crate::backup::config_files(&second) {
|
||||
if path.starts_with("Core/configs/") && path.ends_with(".conf") && !files.contains_key(&path) {
|
||||
fs::remove_file(fsx::ensure_within(&second, &fsx::safe_join(&second, &path)?)?)?;
|
||||
}
|
||||
}
|
||||
for (path, bytes) in files {
|
||||
if !(path.starts_with("Core/configs/") && path.ends_with(".conf") || path.starts_with("Settings/") && path.ends_with(".template")) {
|
||||
return Err(Error::Invalid("Invalid secondary realm configuration path.".into()));
|
||||
}
|
||||
let text = String::from_utf8(bytes).map_err(|_| Error::Invalid("Invalid realm config encoding.".into()))?;
|
||||
let shared = main.to_string_lossy().replace('\\', "/");
|
||||
let text = text.replace("@DATA@", &format!("{shared}/Data"))
|
||||
.replace("@ASCENSION_DBC@", &format!("{shared}/Data/dbc/Ascension"))
|
||||
.replace("@MYSQL_EXE@", &format!("{shared}/mysql/bin/mysql.exe"));
|
||||
let text = if path == "Settings/worldserver.conf.template" {
|
||||
let main_conf = crate::config::parser::ConfFile::parse_bytes(&fs::read(main.join(&path))?)?;
|
||||
let mut other_conf = crate::config::parser::ConfFile::parse_bytes(text.as_bytes())?;
|
||||
if let Some(bind) = main_conf.get("BindIP") { other_conf.set("BindIP", bind, &[]); }
|
||||
other_conf.set("Ra.IP", "\"127.0.0.1\"", &[]);
|
||||
other_conf.to_text()
|
||||
} else if path == "Core/configs/modules/coa.conf" {
|
||||
let mut conf = crate::config::parser::ConfFile::parse_bytes(text.as_bytes())?;
|
||||
if crate::friends::bind_is_open(main) { conf.set("CoA.AllowRemoteClients", "1", &[]); }
|
||||
conf.to_text()
|
||||
} else { text };
|
||||
fsx::atomic_write(&fsx::ensure_within(&second, &fsx::safe_join(&second, &path)?)?, text.as_bytes())?;
|
||||
}
|
||||
let mut cfg: serde_json::Value = fsx::read_json(&main.join("Settings/repack.json"))?;
|
||||
cfg["worldPort"] = s.secondary_world_port.ok_or_else(|| Error::Invalid("Second realm world port is missing.".into()))?.into();
|
||||
cfg["raPort"] = s.secondary_ra_port.ok_or_else(|| Error::Invalid("Second realm console port is missing.".into()))?.into();
|
||||
fsx::atomic_write_json(&second.join("Settings/repack.json"), &cfg)?;
|
||||
fsx::atomic_write(&second.join("Settings/database.json"), &fs::read(main.join("Settings/database.json"))?)?;
|
||||
fsx::atomic_write_json(&second.join("Settings/realm-profile.json"), &RealmState { active: mode, wildcard_created: true, ..Default::default() })?;
|
||||
let source = fs::read_to_string(main.join("Scripts/manage.py"))?;
|
||||
let source = secondary_launcher(&source)?;
|
||||
fsx::atomic_write(&second.join("Scripts/manage.py"), source.as_bytes())?;
|
||||
Ok(second)
|
||||
}
|
||||
|
||||
fn secondary_launcher(source: &str) -> Result<String> {
|
||||
let marker = "def start_world(config, offset):\n start_mysql(config)";
|
||||
let source = source.replace("\r\n", "\n");
|
||||
if !source.contains(marker) { return Err(Error::Invalid("The launcher does not support a shared database world. Update the server first.".into())); }
|
||||
Ok(source.replace(marker, "def start_world(config, offset):\n mysql(admin=\"ping\")"))
|
||||
}
|
||||
|
||||
pub fn start(main: &Path) -> Result<()> {
|
||||
if !realms::state(main)?.simultaneous { return Ok(()); }
|
||||
if is_running(main) {
|
||||
let second = root(main);
|
||||
if process::observe(&second, &crate::layout::read_ports(&second)).world.state == ServiceState::Running { return Ok(()); }
|
||||
return Err(Error::Invalid("The second realm is still starting or stopping.".into()));
|
||||
}
|
||||
let second = prepare(main)?;
|
||||
let out = driver::run(&second, Verb::StartWorld)?;
|
||||
if !out.ok { return Err(Error::Invalid(format!("The second realm did not start: {}", out.output))); }
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn stop(main: &Path) -> Result<()> {
|
||||
let second = root(main);
|
||||
if !second.join("Scripts/manage.py").exists() {
|
||||
if is_running(main) { return Err(Error::Invalid("The running second realm's launcher is missing. The shared database was left running.".into())); }
|
||||
return Ok(());
|
||||
}
|
||||
// Its state has no auth/MySQL records: the shared database remains up until the primary world stops.
|
||||
if is_running(main) {
|
||||
let out = driver::run(&second, Verb::StopAll)?;
|
||||
if !out.ok || is_running(main) { return Err(Error::Invalid(format!("The second realm could not stop; the database was left running: {}", out.output))); }
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
#[test]
|
||||
fn secondary_never_starts_the_shared_database() {
|
||||
let patched = secondary_launcher("def start_world(config, offset):\r\n start_mysql(config)\r\n wait_ready('world', 8086)\r\n").unwrap();
|
||||
assert!(patched.contains("mysql(admin=\"ping\")"));
|
||||
assert!(!patched.contains("start_mysql(config)"));
|
||||
assert!(secondary_launcher("def start_world(): pass").is_err());
|
||||
}
|
||||
}
|
||||
@@ -88,10 +88,16 @@ pub struct Tailscale {
|
||||
pub connected: bool,
|
||||
}
|
||||
|
||||
#[cfg(windows)]
|
||||
fn tailscale_exe() -> Option<PathBuf> {
|
||||
["C:/Program Files/Tailscale/tailscale.exe", "C:/Program Files (x86)/Tailscale/tailscale.exe"].iter().map(PathBuf::from).find(|p| p.is_file())
|
||||
}
|
||||
|
||||
#[cfg(not(windows))]
|
||||
fn tailscale_exe() -> Option<PathBuf> {
|
||||
["/usr/bin/tailscale", "/usr/local/bin/tailscale", "/usr/sbin/tailscale"].iter().map(PathBuf::from).find(|p| p.is_file())
|
||||
}
|
||||
|
||||
pub fn parse_tailscale_ip(out: &str) -> Option<String> {
|
||||
out.lines().map(str::trim).find(|l| l.parse::<Ipv4Addr>().map(is_cgnat_range).unwrap_or(false)).map(str::to_string)
|
||||
}
|
||||
|
||||
@@ -23,6 +23,7 @@ pub const BOOTSTRAP_CREDENTIALS: &str = "Settings/database.bootstrap.json";
|
||||
|
||||
/// Files that never belong in a shipped package: per-install state, logs, secrets, old binaries.
|
||||
pub fn excluded(rel: &str) -> bool {
|
||||
if rel.replace('\\', "/").to_lowercase().starts_with(".realms/") { return true; }
|
||||
let l = rel.to_lowercase();
|
||||
let name = l.rsplit('/').next().unwrap_or("");
|
||||
l.starts_with(".state/")
|
||||
@@ -40,7 +41,7 @@ pub fn excluded(rel: &str) -> bool {
|
||||
|| l == "mysql/my.ini"
|
||||
|| l == "mysql/mysql.pid"
|
||||
|| l == "mysql/data.7z"
|
||||
|| l.starts_with("core/configs/") && !l.ends_with(".dist") // generated at first start from Settings templates
|
||||
|| l.starts_with("core/configs/") && !l.ends_with(".dist") && l != "core/configs/modules/playerbots.conf.settings.json" // generated at first start from Settings templates
|
||||
|| name.ends_with(".pdb")
|
||||
|| name.ends_with(".bak")
|
||||
|| name.ends_with(".log")
|
||||
@@ -55,7 +56,7 @@ fn policy_for(rel: &str) -> (Owner, ReplacePolicy) {
|
||||
let l = rel.to_lowercase();
|
||||
if l.starts_with("_migrations/") {
|
||||
(Owner::Core, ReplacePolicy::NeverTouch) // staged for the migration runner, never copied into the server
|
||||
} else if l.ends_with(".dist") {
|
||||
} else if l.ends_with(".dist") || l == "core/configs/modules/playerbots.conf.settings.json" {
|
||||
(Owner::Core, ReplacePolicy::Replace)
|
||||
} else if l.starts_with("mysql/data/") {
|
||||
(Owner::User, ReplacePolicy::NeverTouch)
|
||||
@@ -256,6 +257,11 @@ impl Read for PartsReader {
|
||||
/// Unpack verified `parts_dir` into `dest` (an empty or new staging folder). Every file must be listed in the
|
||||
/// manifest with the recorded size and hash; anything else aborts the extraction.
|
||||
pub fn extract(parts_dir: &Path, manifest: &Manifest, dest: &Path, progress: &dyn Fn(u64, u64)) -> Result<()> {
|
||||
extract_selected(parts_dir, manifest, dest, &|_| true, progress)
|
||||
}
|
||||
|
||||
/// Verify the entire archive, writing only selected files for a disposable release-schema fixture.
|
||||
pub fn extract_selected(parts_dir: &Path, manifest: &Manifest, dest: &Path, select: &dyn Fn(&str) -> bool, progress: &dyn Fn(u64, u64)) -> Result<()> {
|
||||
let archive = manifest.archive.as_ref().ok_or_else(|| Error::InvalidManifest("manifest has no archive".into()))?;
|
||||
let mut paths = Vec::new();
|
||||
for part in &archive.parts {
|
||||
@@ -270,7 +276,8 @@ pub fn extract(parts_dir: &Path, manifest: &Manifest, dest: &Path, progress: &dy
|
||||
}
|
||||
paths.push(p);
|
||||
}
|
||||
fsx::require_space(dest, archive.unpacked_size)?;
|
||||
let selected_size = manifest.files.iter().filter(|f| select(&f.path)).map(|f| f.size).sum();
|
||||
fsx::require_space(dest, selected_size)?;
|
||||
fs::create_dir_all(dest)?;
|
||||
|
||||
let expected: HashMap<String, &FileEntry> = manifest.files.iter().map(|f| (f.path.replace('\\', "/").to_lowercase(), f)).collect();
|
||||
@@ -293,28 +300,42 @@ pub fn extract(parts_dir: &Path, manifest: &Manifest, dest: &Path, progress: &dy
|
||||
return Err(Error::PathRejected(format!("{rel}: appears twice in the archive")));
|
||||
}
|
||||
let target = fsx::safe_join(dest, &want.path)?;
|
||||
fs::create_dir_all(target.parent().unwrap())?;
|
||||
let mut out = BufWriter::new(File::create(&target)?);
|
||||
let selected = select(&want.path);
|
||||
let mut out = if selected {
|
||||
fs::create_dir_all(target.parent().unwrap())?;
|
||||
Some(BufWriter::new(File::create(&target)?))
|
||||
} else { None };
|
||||
let mut hasher = Sha256::new();
|
||||
let mut buf = vec![0u8; 1 << 20];
|
||||
let mut size = 0u64;
|
||||
let mut head = Vec::with_capacity(4);
|
||||
loop {
|
||||
let n = entry.read(&mut buf)?;
|
||||
if n == 0 {
|
||||
break;
|
||||
}
|
||||
if head.len() < 4 {
|
||||
head.extend_from_slice(&buf[..n.min(4 - head.len())]);
|
||||
}
|
||||
size += n as u64;
|
||||
if size > want.size {
|
||||
return Err(Error::HashMismatch { path: rel, expected: format!("{} bytes", want.size), actual: "more".into() });
|
||||
}
|
||||
hasher.update(&buf[..n]);
|
||||
out.write_all(&buf[..n])?;
|
||||
if let Some(out) = out.as_mut() { out.write_all(&buf[..n])?; }
|
||||
}
|
||||
out.flush()?;
|
||||
if let Some(out) = out.as_mut() { out.flush()?; }
|
||||
let actual = hex::encode(hasher.finalize());
|
||||
if size != want.size || !actual.eq_ignore_ascii_case(&want.sha256) {
|
||||
return Err(Error::HashMismatch { path: rel, expected: want.sha256.clone(), actual });
|
||||
}
|
||||
// The archive does not carry per-file modes, so a Linux binary or script would be extracted unusable.
|
||||
// Recognise them by content (ELF header or `#!`); Windows has no execute bit and ignores this.
|
||||
#[cfg(unix)]
|
||||
if selected && (head.starts_with(b"\x7fELF") || head.starts_with(b"#!")) {
|
||||
use std::os::unix::fs::PermissionsExt;
|
||||
fs::set_permissions(&target, fs::Permissions::from_mode(0o755))?;
|
||||
}
|
||||
done += size;
|
||||
progress(done, archive.unpacked_size);
|
||||
}
|
||||
@@ -349,6 +370,20 @@ mod tests {
|
||||
v
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn upstream_settings_metadata_ships_and_updates_but_active_configs_stay_private() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let src = d.path().join("src");
|
||||
fs::create_dir_all(src.join("Core/configs/modules")).unwrap();
|
||||
fs::write(src.join("Core/configs/modules/playerbots.conf.settings.json"), "{}\n").unwrap();
|
||||
fs::write(src.join("Core/configs/modules/playerbots.conf"), "PlayerbotsDatabaseInfo = private\n").unwrap();
|
||||
let out = d.path().join("package");
|
||||
let manifest = build(&src, &out, &BuildOptions { kind: Kind::Update, version: "1.0.0".into(), core_commit: None, built_at: "test".into(), part_size: 1 << 20, bots_commit: None, migrations: vec![] }, &|_| {}).unwrap();
|
||||
assert_eq!(manifest.files.len(), 1);
|
||||
assert_eq!(manifest.files[0].path, "Core/configs/modules/playerbots.conf.settings.json");
|
||||
assert_eq!(manifest.files[0].policy, ReplacePolicy::Replace);
|
||||
}
|
||||
|
||||
fn source() -> (tempfile::TempDir, PathBuf) {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let src = d.path().join("src");
|
||||
@@ -373,6 +408,44 @@ mod tests {
|
||||
(d, src)
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn extract_makes_binaries_and_scripts_executable_and_nothing_else() {
|
||||
use std::os::unix::fs::PermissionsExt;
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let src = d.path().join("src");
|
||||
for (p, c) in [
|
||||
("Core/worldserver", &b"\x7fELF\x02\x01\x01 binary"[..]),
|
||||
("Scripts/tool.sh", &b"#!/bin/sh\necho hi\n"[..]),
|
||||
("Core/configs/worldserver.conf.dist", &b"Setting = 1\n"[..]),
|
||||
] {
|
||||
let f = src.join(p);
|
||||
fs::create_dir_all(f.parent().unwrap()).unwrap();
|
||||
fs::write(f, c).unwrap();
|
||||
}
|
||||
let out = d.path().join("out");
|
||||
let m = build(&src, &out, &opts(64 * 1024), &|_| {}).unwrap();
|
||||
let dest = d.path().join("dest");
|
||||
extract(&out, &m, &dest, &|_, _| {}).unwrap();
|
||||
let mode = |p: &str| fs::metadata(dest.join(p)).unwrap().permissions().mode() & 0o111;
|
||||
assert_ne!(mode("Core/worldserver"), 0, "ELF binary must be executable");
|
||||
assert_ne!(mode("Scripts/tool.sh"), 0, "script with a shebang must be executable");
|
||||
assert_eq!(mode("Core/configs/worldserver.conf.dist"), 0, "plain files stay non-executable");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn selective_extraction_still_validates_unselected_files() {
|
||||
let (d, src) = source();
|
||||
let out = d.path().join("out");
|
||||
let mut manifest = build(&src, &out, &opts(64 * 1024), &|_| {}).unwrap();
|
||||
let dest = d.path().join("selected");
|
||||
extract_selected(&out, &manifest, &dest, &|p| p.starts_with("Core/"), &|_, _| {}).unwrap();
|
||||
assert!(dest.join("Core/worldserver.exe").exists());
|
||||
assert!(!dest.join("Data").exists());
|
||||
manifest.files.iter_mut().find(|f| f.path.starts_with("Data/")).unwrap().sha256 = "f".repeat(64);
|
||||
assert!(matches!(extract_selected(&out, &manifest, &d.path().join("bad"), &|_| false, &|_, _| {}), Err(Error::HashMismatch { .. })));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn build_split_extract_roundtrip_excludes_noise_and_secrets() {
|
||||
let (d, src) = source();
|
||||
|
||||
@@ -61,6 +61,7 @@ pub struct Observed {
|
||||
pub mysql: ServiceStatus,
|
||||
pub auth: ServiceStatus,
|
||||
pub world: ServiceStatus,
|
||||
pub secondary_world: Option<ServiceStatus>,
|
||||
}
|
||||
|
||||
pub fn read_state_record(root: &Path, name: &str) -> Option<ProcessIdentity> {
|
||||
@@ -293,12 +294,20 @@ fn service(root: &Path, name: &'static str, exe: PathBuf, port: u16, listen: &[(
|
||||
|
||||
/// Snapshot the three services of an installation without touching anything.
|
||||
pub fn observe(root: &Path, ports: &Ports) -> Observed {
|
||||
if crate::docker::is_docker(root) {
|
||||
return crate::docker::observe(root, ports);
|
||||
}
|
||||
let listen = listeners();
|
||||
let (world, auth, mysql) = crate::layout::executables(root);
|
||||
let secondary = crate::multiworld::root(root);
|
||||
let secondary_world = if crate::realms::state(root).is_ok_and(|s| s.simultaneous) || crate::multiworld::is_running(root) {
|
||||
Some(service(&secondary, "world-secondary", secondary.join("Core/worldserver.exe"), crate::layout::read_ports(&secondary).world, &listen))
|
||||
} else { None };
|
||||
Observed {
|
||||
mysql: service(root, "mysql", mysql, ports.mysql, &listen),
|
||||
auth: service(root, "auth", auth, ports.auth, &listen),
|
||||
world: service(root, "world", world, ports.world, &listen),
|
||||
secondary_world,
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -41,6 +41,12 @@ impl Mode {
|
||||
pub struct RealmState {
|
||||
pub active: Mode,
|
||||
pub wildcard_created: bool,
|
||||
#[serde(default)]
|
||||
pub simultaneous: bool,
|
||||
#[serde(default)]
|
||||
pub secondary_world_port: Option<u16>,
|
||||
#[serde(default)]
|
||||
pub secondary_ra_port: Option<u16>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize)]
|
||||
@@ -49,6 +55,9 @@ pub struct View {
|
||||
pub wildcard_created: bool,
|
||||
pub supported: bool,
|
||||
pub recovery_pending: bool,
|
||||
pub simultaneous: bool,
|
||||
pub secondary_world_port: Option<u16>,
|
||||
pub secondary_running: bool,
|
||||
}
|
||||
|
||||
pub fn state(root: &Path) -> Result<RealmState> {
|
||||
@@ -61,7 +70,7 @@ pub fn view(root: &Path) -> Result<View> {
|
||||
// Inspect the binary itself; templates or an old log cannot prove installed support.
|
||||
let supported = fs::read(root.join("Core/worldserver.exe"))?
|
||||
.windows(b"Wildcard synergy settings".len()).any(|w| w == b"Wildcard synergy settings");
|
||||
Ok(View { active: s.active, wildcard_created: s.wildcard_created, supported, recovery_pending: root.join(JOURNAL).exists() })
|
||||
Ok(View { active: s.active, wildcard_created: s.wildcard_created, supported, recovery_pending: root.join(JOURNAL).exists(), simultaneous: s.simultaneous, secondary_world_port: s.secondary_world_port, secondary_running: crate::multiworld::is_running(root) })
|
||||
}
|
||||
|
||||
pub fn guard_module(root: &Path, id: &str) -> Result<()> {
|
||||
@@ -138,7 +147,7 @@ struct Journal { before: RealmState, files: Files }
|
||||
|
||||
fn require_world_stopped(root: &Path) -> Result<()> {
|
||||
let observed = process::observe(root, &layout::read_ports(root));
|
||||
if observed.world.state != process::ServiceState::Stopped || observed.auth.state != process::ServiceState::Stopped {
|
||||
if observed.world.state != process::ServiceState::Stopped || observed.auth.state != process::ServiceState::Stopped || crate::multiworld::is_running(root) {
|
||||
return Err(Error::Invalid("Stop the server before switching realms. Your characters will be saved.".into()));
|
||||
}
|
||||
Ok(())
|
||||
@@ -170,13 +179,13 @@ fn create_databases(root: &Path) -> Result<()> {
|
||||
return Err(Error::Invalid("Realm creation does not support databases with routines, triggers or views.".into()));
|
||||
}
|
||||
}
|
||||
for (schema, tables) in [
|
||||
("acore_world", &["ascension_wildcard_boss_marks", "ascension_wildcard_tooltip_links"][..]),
|
||||
("acore_characters", &["coa_wildcard_skill_card", "coa_wildcard_skill_card_pending", "coa_wildcard_skill_card_account", "coa_wildcard_skill_card_purchase", "coa_wildcard_specialization_cache"][..]),
|
||||
] {
|
||||
for (kind, tables) in crate::schema_check::WILDCARD_TABLES {
|
||||
let schema = crate::db::schema_of(kind)?;
|
||||
let present = db.tables(schema)?;
|
||||
if tables.iter().any(|table| !present.iter().any(|p| p == table)) {
|
||||
return Err(Error::Invalid("Wildcard database migrations are missing. Update the server database before creating this realm.".into()));
|
||||
let missing: Vec<_> = tables.iter().filter(|table| !present.iter().any(|p| p == **table)).copied().collect();
|
||||
if !missing.is_empty() {
|
||||
tracing::error!(root = %root.display(), database = schema, missing_tables = ?missing, "Wildcard realm creation blocked by missing database tables");
|
||||
return Err(Error::Invalid(format!("Cannot create Wildcard: {schema} is missing tables: {}. Run Check files and database and include its report when requesting support.", missing.join(", "))));
|
||||
}
|
||||
}
|
||||
let cache = root.join("Settings/realm-profiles/staging");
|
||||
@@ -217,6 +226,9 @@ fn create_databases(root: &Path) -> Result<()> {
|
||||
}
|
||||
|
||||
pub fn select(root: &Path, mode: Mode) -> Result<View> {
|
||||
let meta = crate::registry::metadata_dir_for(root)?;
|
||||
let _update_lock = crate::update::operation_lock(&meta)?;
|
||||
crate::update::ensure_recovered(&meta)?;
|
||||
require_world_stopped(root)?;
|
||||
recover(root)?;
|
||||
let mut s = state(root)?;
|
||||
@@ -238,7 +250,9 @@ pub fn select(root: &Path, mode: Mode) -> Result<View> {
|
||||
// The launcher and batch files share this lock; recheck after the potentially long database copy.
|
||||
fs::create_dir_all(root.join(".state"))?;
|
||||
let lock = fs::OpenOptions::new().read(true).write(true).create(true).truncate(false).open(root.join(".state/control.lock"))?;
|
||||
fs4::fs_std::FileExt::try_lock_exclusive(&lock).map_err(|_| Error::Invalid("Another start/stop action is in progress.".into()))?;
|
||||
if !fs4::fs_std::FileExt::try_lock_exclusive(&lock)? {
|
||||
return Err(Error::Invalid("Another start/stop action is in progress.".into()));
|
||||
}
|
||||
require_world_stopped(root)?;
|
||||
let original = state(root)?;
|
||||
fsx::atomic_write_json(&root.join(JOURNAL), &Journal { before: original, files: before })?;
|
||||
@@ -258,29 +272,50 @@ pub fn prepare_launcher(root: &Path) -> Result<()> {
|
||||
let path = root.join("Scripts/manage.py");
|
||||
let source = fs::read_to_string(&path)?;
|
||||
let patched = patch_launcher(&source)?;
|
||||
if patched != source { fsx::atomic_write(&path, patched.as_bytes())?; }
|
||||
if patched != source {
|
||||
fsx::atomic_write(&path, patched.as_bytes())?;
|
||||
// A Manager-owned transformation is still pristine for subsequent updates and file checks.
|
||||
if let Ok(dir) = crate::registry::metadata_dir_for(root) {
|
||||
if let Ok((_, mut meta)) = crate::registry::MetaDir::open(&dir) {
|
||||
if meta.original_hashes.get("Scripts/manage.py").is_some_and(|hash| hash == &fsx::sha256_bytes(source.as_bytes())) {
|
||||
meta.original_hashes.insert("Scripts/manage.py".into(), fsx::sha256_bytes(patched.as_bytes()));
|
||||
fsx::atomic_write_json(&dir.join("install.json"), &meta)?;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn patch_launcher(source: &str) -> Result<String> {
|
||||
const LAUNCHER_REALM_REPLACEMENTS: &[(&str, &str)] = &[
|
||||
("(\"WorldDatabaseInfo\", \"acore_world\")", "(\"WorldDatabaseInfo\", \"acore_world_wildcard\" if coa_realm() == 'wildcard' else \"acore_world\")"),
|
||||
("(\"CharacterDatabaseInfo\", \"acore_characters\")", "(\"CharacterDatabaseInfo\", \"acore_characters_wildcard\" if coa_realm() == 'wildcard' else \"acore_characters\")"),
|
||||
("SET name='AzerothCore',address=", "SET name='{coa_realm_name()}',address="),
|
||||
("WHERE id=1;", "WHERE id={coa_realm_id()};"),
|
||||
("mysql(\"UPDATE acore_auth.realmlist SET flag=0", "mysql(f\"UPDATE acore_auth.realmlist SET flag=0"),
|
||||
];
|
||||
|
||||
const LAUNCHER_REALM_INSERT: &str = "# coa-manager-realm-profiles-v1\ndef coa_realm():\n path = ROOT / 'Settings/realm-profile.json'\n return json.loads(path.read_text(encoding='utf-8')).get('active', 'coa') if path.exists() else 'coa'\n\ndef coa_realm_id():\n return 2 if coa_realm() == 'wildcard' else 1\n\ndef coa_realm_name():\n return 'Wildcard' if coa_realm() == 'wildcard' else 'Conquest of Azeroth'\n\n";
|
||||
|
||||
pub(crate) fn patch_launcher(source: &str) -> Result<String> {
|
||||
if source.contains("# coa-manager-realm-profiles-v1") { return Ok(source.into()); }
|
||||
let replacements = [
|
||||
("(\"WorldDatabaseInfo\", \"acore_world\")", "(\"WorldDatabaseInfo\", \"acore_world_wildcard\" if coa_realm() == 'wildcard' else \"acore_world\")"),
|
||||
("(\"CharacterDatabaseInfo\", \"acore_characters\")", "(\"CharacterDatabaseInfo\", \"acore_characters_wildcard\" if coa_realm() == 'wildcard' else \"acore_characters\")"),
|
||||
("SET name='AzerothCore',address=", "SET name='{coa_realm_name()}',address="),
|
||||
("WHERE id=1;", "WHERE id={coa_realm_id()};"),
|
||||
("mysql(\"UPDATE acore_auth.realmlist SET flag=0", "mysql(f\"UPDATE acore_auth.realmlist SET flag=0"),
|
||||
];
|
||||
let mut out = source.to_string();
|
||||
for (from, to) in replacements {
|
||||
for &(from, to) in LAUNCHER_REALM_REPLACEMENTS {
|
||||
if !out.contains(from) { return Err(Error::Invalid("This launcher does not support realm profiles. Update the server package first.".into())); }
|
||||
out = out.replace(from, to);
|
||||
}
|
||||
let insert = "# coa-manager-realm-profiles-v1\ndef coa_realm():\n path = ROOT / 'Settings/realm-profile.json'\n return json.loads(path.read_text(encoding='utf-8')).get('active', 'coa') if path.exists() else 'coa'\n\ndef coa_realm_id():\n return 2 if coa_realm() == 'wildcard' else 1\n\ndef coa_realm_name():\n return 'Wildcard' if coa_realm() == 'wildcard' else 'Conquest of Azeroth'\n\n";
|
||||
// Insert before the entry point so ROOT, json and functions are all defined when called.
|
||||
let marker = "if __name__ == \"__main__\":";
|
||||
if !out.contains(marker) { return Err(Error::Invalid("Unrecognised server launcher entry point.".into())); }
|
||||
Ok(out.replace(marker, &format!("{insert}{marker}")))
|
||||
Ok(out.replace(marker, &format!("{LAUNCHER_REALM_INSERT}{marker}")))
|
||||
}
|
||||
|
||||
/// Reverse only our exact realm transformation; callers must verify the recovered original hash.
|
||||
pub(crate) fn unpatch_launcher(source: &str) -> Option<String> {
|
||||
if !source.contains(LAUNCHER_REALM_INSERT) { return None; }
|
||||
let mut original = source.replacen(LAUNCHER_REALM_INSERT, "", 1);
|
||||
for &(from, to) in LAUNCHER_REALM_REPLACEMENTS { original = original.replace(to, from); }
|
||||
patch_launcher(&original).ok().filter(|patched| patched == source).map(|_| original)
|
||||
}
|
||||
|
||||
pub fn before_start(root: &Path) -> Result<()> {
|
||||
@@ -288,6 +323,8 @@ pub fn before_start(root: &Path) -> Result<()> {
|
||||
let s = state(root)?;
|
||||
if !root.join(STATE).exists() { return Ok(()); }
|
||||
prepare_launcher(root)?;
|
||||
if s.simultaneous && !view(root)?.supported { return Err(Error::Invalid("The installed server build does not support simultaneous Wildcard startup.".into())); }
|
||||
if s.simultaneous { fsx::atomic_write_json(&snapshot(root, s.active), &configs(root)?)?; }
|
||||
if s.active == Mode::Wildcard {
|
||||
if !view(root)?.supported { return Err(Error::Invalid("The installed server build does not support Wildcard.".into())); }
|
||||
let path = root.join("Core/configs/modules/mod_coa_playerbots.conf");
|
||||
@@ -304,6 +341,11 @@ pub fn setup_realmlist(root: &Path) -> Result<()> {
|
||||
let db = Db::from_repack(root, Account::Admin)?;
|
||||
let port = layout::read_ports(root).world;
|
||||
db.query(&format!("INSERT INTO acore_auth.realmlist (id,name,address,localAddress,localSubnetMask,port,icon,flag,timezone,gamebuild) SELECT 2,'Wildcard',address,localAddress,localSubnetMask,{port},icon,2,timezone,gamebuild FROM acore_auth.realmlist WHERE id=1 ON DUPLICATE KEY UPDATE port={port}; UPDATE acore_auth.realmlist SET flag=2 WHERE id IN (1,2) AND id<>{};", s.active.realm_id()))?;
|
||||
if s.simultaneous {
|
||||
let second = s.secondary_world_port.ok_or_else(|| Error::Invalid("Second realm port is missing.".into()))?;
|
||||
let (coa, wildcard) = if s.active == Mode::Coa { (port, second) } else { (second, port) };
|
||||
db.query(&format!("UPDATE acore_auth.realmlist SET port=CASE id WHEN 1 THEN {coa} ELSE {wildcard} END,flag=0 WHERE id IN (1,2);"))?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@@ -358,7 +400,7 @@ mod tests {
|
||||
#[test]
|
||||
fn wildcard_blocks_bot_settings_and_enable_calls() {
|
||||
let t = tempfile::tempdir().unwrap();
|
||||
fsx::atomic_write_json(&t.path().join(STATE), &RealmState { active: Mode::Wildcard, wildcard_created: true }).unwrap();
|
||||
fsx::atomic_write_json(&t.path().join(STATE), &RealmState { active: Mode::Wildcard, wildcard_created: true, ..Default::default() }).unwrap();
|
||||
assert!(crate::modules::set_enabled(t.path(), t.path(), "companions", true).is_err());
|
||||
assert!(crate::config::save(t.path(), t.path(), crate::config::Scope::Bots, &BTreeMap::new()).is_err());
|
||||
assert!(guard_module(t.path(), "content-scaling").is_ok());
|
||||
@@ -368,4 +410,28 @@ mod tests {
|
||||
fn unknown_launcher_is_refused_without_partial_patching() {
|
||||
assert!(patch_launcher("print('custom launcher')").is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn managed_launcher_patch_remains_pristine_but_external_edits_conflict() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("server");
|
||||
let source = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n";
|
||||
fsx::atomic_write(&root.join("Scripts/manage.py"), source.as_bytes()).unwrap();
|
||||
let mut meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, &root);
|
||||
meta.original_hashes.insert("Scripts/manage.py".into(), fsx::sha256_bytes(source.as_bytes()));
|
||||
let dir = crate::registry::MetaDir::create(&root, &meta).unwrap();
|
||||
prepare_launcher(&root).unwrap();
|
||||
let (_, meta) = crate::registry::MetaDir::open(&dir.root).unwrap();
|
||||
assert!(crate::diag::verify_managed(&root, &meta).is_empty());
|
||||
let manifest: crate::manifest::Manifest = serde_json::from_value(serde_json::json!({
|
||||
"schema": 1, "kind": "update", "version": "2.0.0", "core": {"commit": null}, "builtAt": "fixture", "minManagerVersion": "0.1.0",
|
||||
"files": [{"path":"Scripts/manage.py","sha256":fsx::sha256_bytes(b"next release"),"size":12,"owner":"core","policy":"replace"}]
|
||||
})).unwrap();
|
||||
assert_eq!(crate::update::plan(&root, &meta, &manifest, &BTreeMap::new(), None).unwrap()[0].action, crate::update::Action::Replace);
|
||||
let mut modified = fs::read(root.join("Scripts/manage.py")).unwrap();
|
||||
modified.extend_from_slice(b"# custom edit\n");
|
||||
fsx::atomic_write(&root.join("Scripts/manage.py"), &modified).unwrap();
|
||||
prepare_launcher(&root).unwrap();
|
||||
assert_eq!(crate::update::plan(&root, &meta, &manifest, &BTreeMap::new(), None).unwrap()[0].action, crate::update::Action::Conflict);
|
||||
}
|
||||
}
|
||||
@@ -267,6 +267,7 @@ mod tests {
|
||||
fn drive_root_and_missing_folder_are_rejected() {
|
||||
let meta = InstallMeta::new(InstallKind::New, Path::new("C:/nope"));
|
||||
assert!(MetaDir::create(Path::new("C:/definitely/missing/folder"), &meta).is_err());
|
||||
assert!(metadata_dir_for(Path::new("C:/")).is_err());
|
||||
let root = if cfg!(windows) { "C:/" } else { "/" };
|
||||
assert!(metadata_dir_for(Path::new(root)).is_err());
|
||||
}
|
||||
}
|
||||
@@ -98,7 +98,7 @@ pub fn collect_bots_sql(bots: &Path) -> Result<Vec<SqlFile>> {
|
||||
}
|
||||
|
||||
fn to_migrations(files: &[SqlFile]) -> Vec<Migration> {
|
||||
files.iter().map(|f| Migration { id: f.id.clone(), db: f.db.clone(), sha256: f.sha256.clone(), destructive: false }).collect()
|
||||
files.iter().map(|f| Migration { compatible_sha256: vec![], id: f.id.clone(), db: f.db.clone(), sha256: f.sha256.clone(), destructive: false }).collect()
|
||||
}
|
||||
|
||||
pub struct UpdateParams<'a> {
|
||||
@@ -139,7 +139,7 @@ pub fn pack_update(p: &UpdateParams, progress: &dyn Fn(&str)) -> Result<Manifest
|
||||
let mut changed = 0;
|
||||
for rel in &rels {
|
||||
let src = fsx::safe_join(p.tree, rel)?;
|
||||
if base.get(&rel.to_lowercase()).map(|h| h.eq_ignore_ascii_case(&fsx::sha256_file(&src).unwrap_or_default())).unwrap_or(false) {
|
||||
if rel != crate::schema_check::CONTRACT && base.get(&rel.to_lowercase()).map(|h| h.eq_ignore_ascii_case(&fsx::sha256_file(&src).unwrap_or_default())).unwrap_or(false) {
|
||||
continue;
|
||||
}
|
||||
let dst = fsx::safe_join(&work, rel)?;
|
||||
@@ -219,10 +219,12 @@ mod tests {
|
||||
let (base_src, base_out, tree, upd_out, sqldir) = (d.path().join("bs"), d.path().join("bo"), d.path().join("tree"), d.path().join("uo"), d.path().join("sql"));
|
||||
write(&base_src, "Core/worldserver.exe", "v1");
|
||||
write(&base_src, "Core/authserver.exe", "same");
|
||||
write(&base_src, crate::schema_check::CONTRACT, "same contract");
|
||||
let base = package::build(&base_src, &base_out, &BuildOptions { kind: Kind::Base, version: "1.0.0".into(), core_commit: None, built_at: "x".into(), part_size: 1 << 20, bots_commit: None, migrations: vec![] }, &|_| {}).unwrap();
|
||||
write(&tree, "Core/worldserver.exe", "v2");
|
||||
write(&tree, "Core/authserver.exe", "same");
|
||||
write(&tree, "Core/newlib.dll", "n");
|
||||
write(&tree, crate::schema_check::CONTRACT, "same contract");
|
||||
write(&sqldir, "world.sql", "SELECT 1;");
|
||||
let sql = vec![SqlFile { db: "world".into(), id: "m1".into(), origin: "x".into(), abs: sqldir.join("world.sql"), sha256: fsx::sha256_file(&sqldir.join("world.sql")).unwrap() }];
|
||||
let m = pack_update(&UpdateParams { tree: &tree, base_manifest: &base, sql: &sql, out: &upd_out, version: "1.1.0".into(), core_commit: Some("a".repeat(40)), bots_commit: Some("b".repeat(40)), part_size: 1 << 20 }, &|_| {}).unwrap();
|
||||
@@ -230,6 +232,7 @@ mod tests {
|
||||
assert!(paths.contains(&"Core/worldserver.exe") && paths.contains(&"Core/newlib.dll"));
|
||||
assert!(!paths.contains(&"Core/authserver.exe"), "identical to the base: not shipped");
|
||||
assert!(paths.contains(&"_migrations/world/m1.sql"));
|
||||
assert!(paths.contains(&crate::schema_check::CONTRACT), "the contract ships even when identical to the base");
|
||||
assert_eq!(m.kind, Kind::Update);
|
||||
assert_eq!(m.migrations.len(), 1);
|
||||
assert_eq!(m.bots.as_ref().and_then(|b| b.commit.clone()), Some("b".repeat(40)));
|
||||
|
||||
@@ -0,0 +1,127 @@
|
||||
//! Database acceptance for release packages, using a freshly extracted signed base fixture.
|
||||
use std::collections::HashSet;
|
||||
use std::path::Path;
|
||||
use crate::{backup, fsx, install, manifest::{Kind, Migration}, migrations, package, pkgsource, release::{self, SqlFile}, schema_check, Error, Result};
|
||||
|
||||
const MARKER: &str = ".release-schema-fixture";
|
||||
|
||||
pub fn collect(core: &Path, bots: Option<&Path>, repairs: Option<&Path>) -> Result<Vec<SqlFile>> {
|
||||
let mut files = release::collect_core_sql(core)?;
|
||||
if let Some(bots) = bots { files.extend(release::collect_bots_sql(bots)?); }
|
||||
if let Some(repairs) = repairs {
|
||||
for kind in ["auth", "characters", "world"] {
|
||||
let dir = repairs.join(kind);
|
||||
if !dir.exists() { continue; }
|
||||
let mut paths: Vec<_> = std::fs::read_dir(&dir)?.map(|e| e.map(|e| e.path())).collect::<std::io::Result<_>>()?;
|
||||
paths.sort();
|
||||
for path in paths.into_iter().filter(|p| p.extension().is_some_and(|e| e == "sql")) {
|
||||
let stem = path.file_stem().unwrap().to_string_lossy();
|
||||
files.push(SqlFile { db: kind.into(), id: format!("manager_repair__{stem}"), origin: format!("{kind}/{stem}.sql"), sha256: fsx::sha256_file(&path)?, abs: path });
|
||||
}
|
||||
}
|
||||
}
|
||||
let mut seen = HashSet::new();
|
||||
for file in &files {
|
||||
if !seen.insert((&file.db, &file.id)) { return Err(Error::Invalid(format!("Duplicate release migration: {} / {}", file.db, file.id))); }
|
||||
}
|
||||
Ok(files)
|
||||
}
|
||||
|
||||
pub fn extract_base(source: &Path, fixture: &Path, trusted_key: &str) -> Result<()> {
|
||||
if fixture.exists() || !fixture.file_name().is_some_and(|n| n.to_string_lossy().starts_with("coa-schema-fixture-")) {
|
||||
return Err(Error::Invalid("Use a new coa-schema-fixture-* directory for release validation.".into()));
|
||||
}
|
||||
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(source.into()), trusted_key)?;
|
||||
if manifest.kind != Kind::Base { return Err(Error::Invalid("Release schema validation needs a signed base package.".into())); }
|
||||
package::extract_selected(source, &manifest, fixture, &|path| {
|
||||
let path = path.to_ascii_lowercase();
|
||||
["mysql/", "settings/", "runtime/", "scripts/", "core/", "bugreport/"].iter().any(|prefix| path.starts_with(prefix))
|
||||
}, &|_, _| {})?;
|
||||
fsx::atomic_write(&fixture.join(MARKER), b"disposable release-schema fixture")?;
|
||||
install::bootstrap_database(fixture)
|
||||
}
|
||||
|
||||
pub fn capture_release(fixture: &Path, tree: &Path, sql: &[SqlFile]) -> Result<()> {
|
||||
if !fixture.file_name().is_some_and(|n| n.to_string_lossy().starts_with("coa-schema-fixture-"))
|
||||
|| std::fs::read(fixture.join(MARKER)).ok().as_deref() != Some(b"disposable release-schema fixture") {
|
||||
return Err(Error::Invalid("Refusing to apply release SQL to a non-fixture server.".into()));
|
||||
}
|
||||
let staging = tempfile::tempdir()?;
|
||||
let migrations: Vec<_> = sql.iter().map(|f| Migration { compatible_sha256: vec![], db: f.db.clone(), id: f.id.clone(), sha256: f.sha256.clone(), destructive: false }).collect();
|
||||
for file in sql {
|
||||
let path = fsx::safe_join(staging.path(), &format!("{}/{}.sql", file.db, file.id))?;
|
||||
fsx::atomic_write(&path, &std::fs::read(&file.abs)?)?;
|
||||
}
|
||||
install::with_scratch_ports(fixture, || backup::with_database(fixture, |db| {
|
||||
let db = db.clone().for_realm(crate::realms::Mode::Coa);
|
||||
let report = migrations::apply_pending(&db, &migrations, staging.path(), &|| Ok("disposable release fixture".into()))?;
|
||||
if let Some((id, why)) = report.failed { return Err(Error::Invalid(format!("Release migration {id} failed: {why}"))); }
|
||||
// Validate known critical feature effects before capturing; history may be stale in the base.
|
||||
let previous = tree.join(schema_check::CONTRACT);
|
||||
if previous.exists() { return Err(Error::Invalid("Release tree already contains a schema contract; generate it from a fresh tree.".into())); }
|
||||
let problems = schema_check::check(&db, tree)?;
|
||||
if let Some(p) = problems.first() { return Err(Error::Invalid(format!("Release database failed validation: {}.{}.{}: {}", p.database, p.table, p.column, p.detail))); }
|
||||
schema_check::capture(&db, tree)?;
|
||||
schema_check::require_release_contract(tree)?;
|
||||
Ok(())
|
||||
}))
|
||||
}
|
||||
|
||||
pub fn verify_package(dir: &Path, trusted_key: &str) -> Result<()> {
|
||||
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(dir.into()), trusted_key)?;
|
||||
if !manifest.files.iter().any(|f| f.path == schema_check::CONTRACT && f.size > 0) {
|
||||
return Err(Error::Invalid("The release is missing its database schema contract.".into()));
|
||||
}
|
||||
let scratch = tempfile::tempdir()?;
|
||||
package::extract_selected(dir, &manifest, scratch.path(), &|p| p == schema_check::CONTRACT, &|_, _| {})?;
|
||||
schema_check::require_release_contract(scratch.path())?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use base64::{engine::general_purpose::STANDARD, Engine};
|
||||
use ed25519_dalek::{Signer, SigningKey};
|
||||
|
||||
#[test]
|
||||
fn signed_packages_must_carry_a_real_complete_schema_contract() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let tree = dir.path().join("tree");
|
||||
let out = dir.path().join("out");
|
||||
fsx::atomic_write(&tree.join("Core/worldserver.exe"), b"fixture").unwrap();
|
||||
let key = SigningKey::from_bytes(&[7; 32]);
|
||||
let public = STANDARD.encode(key.verifying_key().as_bytes());
|
||||
let opts = package::BuildOptions { kind: Kind::Update, version: "1.0.0".into(), core_commit: None, bots_commit: None, built_at: "test".into(), part_size: 1024 * 1024, migrations: vec![] };
|
||||
let sign = || {
|
||||
let bytes = std::fs::read(out.join("manifest.json")).unwrap();
|
||||
fsx::atomic_write(&out.join("manifest.json.sig"), STANDARD.encode(key.sign(&bytes).to_bytes()).as_bytes()).unwrap();
|
||||
};
|
||||
package::build(&tree, &out, &opts, &|_| {}).unwrap(); sign();
|
||||
assert!(verify_package(&out, &public).is_err());
|
||||
fsx::atomic_write(&tree.join(schema_check::CONTRACT), br#"{"schema":1,"columns":{}}"#).unwrap();
|
||||
package::build(&tree, &out, &opts, &|_| {}).unwrap(); sign();
|
||||
assert!(verify_package(&out, &public).is_err());
|
||||
fsx::atomic_write(&tree.join(schema_check::CONTRACT), br#"{"schema":1,"columns":{"auth":{"account":{"id":"int"}},"characters":{"characters":{"guid":"int"}},"world":{"creature":{"id":"int"}}}}"#).unwrap();
|
||||
package::build(&tree, &out, &opts, &|_| {}).unwrap(); sign();
|
||||
verify_package(&out, &public).unwrap();
|
||||
}
|
||||
#[test]
|
||||
fn repair_sql_has_new_ids_and_runs_after_original_sql() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let core = dir.path().join("core");
|
||||
let repairs = dir.path().join("repairs");
|
||||
fsx::atomic_write(&core.join("data/sql/updates/pending_db_characters/old.sql"), b"SELECT 1;").unwrap();
|
||||
fsx::atomic_write(&repairs.join("characters/20261005_wildcard.sql"), b"SELECT 2;").unwrap();
|
||||
let files = collect(&core, None, Some(&repairs)).unwrap();
|
||||
assert_eq!(files.iter().map(|f| f.id.as_str()).collect::<Vec<_>>(), ["old", "manager_repair__20261005_wildcard"]);
|
||||
assert_eq!(files[1].db, "characters");
|
||||
}
|
||||
#[test]
|
||||
fn existing_server_cannot_be_used_for_schema_generation() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
assert!(extract_base(dir.path(), dir.path(), "irrelevant").is_err());
|
||||
assert!(capture_release(dir.path(), dir.path(), &[]).is_err());
|
||||
assert!(!dir.path().join(schema_check::CONTRACT).exists());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
//! A player's client connection, independent of any local server installation.
|
||||
use std::path::{Path, PathBuf};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use crate::{client, fsx, Error, Result};
|
||||
|
||||
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
||||
pub struct Profile {
|
||||
pub host: String,
|
||||
pub client_path: Option<String>,
|
||||
}
|
||||
|
||||
pub fn load(dir: &Path) -> Result<Profile> {
|
||||
match std::fs::read(dir.join("connection.json")) {
|
||||
Ok(bytes) => Ok(serde_json::from_slice(&bytes)?),
|
||||
Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(Profile::default()),
|
||||
Err(e) => Err(e.into()),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn save(dir: &Path, profile: &Profile) -> Result<()> {
|
||||
if !profile.host.is_empty() && !client::host_ok(&profile.host) {
|
||||
return Err(Error::Invalid("Enter a server IP address or hostname, without a URL or port.".into()));
|
||||
}
|
||||
if let Some(path) = &profile.client_path {
|
||||
let client = PathBuf::from(path);
|
||||
if client::detect(&client, None).is_none() {
|
||||
return Err(Error::Invalid("This folder does not look like a game client (it needs Data and the game executable).".into()));
|
||||
}
|
||||
if client::is_running(&client) {
|
||||
return Err(Error::Invalid("Close the game before changing its connection.".into()));
|
||||
}
|
||||
if !profile.host.is_empty() { client::set_realmlist(&client, dir, &profile.host)?; }
|
||||
}
|
||||
fsx::atomic_write_json(&dir.join("connection.json"), profile)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
#[test]
|
||||
fn connection_needs_no_server_and_survives_restart() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let profile = Profile { host: "192.168.1.10".into(), client_path: None };
|
||||
save(dir.path(), &profile).unwrap();
|
||||
assert_eq!(load(dir.path()).unwrap().host, profile.host);
|
||||
assert!(!dir.path().join("install.json").exists());
|
||||
}
|
||||
#[test]
|
||||
fn linking_client_sets_host_without_touching_other_game_settings() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let game = dir.path().join("game");
|
||||
std::fs::create_dir_all(game.join("Data/enUS")).unwrap();
|
||||
std::fs::write(game.join("Wow.exe"), b"fixture").unwrap();
|
||||
std::fs::write(game.join("Data/enUS/realmlist.wtf"), "set realmlist 127.0.0.1\n").unwrap();
|
||||
std::fs::create_dir_all(game.join("WTF")).unwrap();
|
||||
std::fs::write(game.join("WTF/Config.wtf"), "SET realmName \"My realm\"\n").unwrap();
|
||||
let profile = Profile { host: "192.168.1.10".into(), client_path: Some(game.to_string_lossy().into()) };
|
||||
save(dir.path(), &profile).unwrap();
|
||||
assert!(std::fs::read_to_string(game.join("Data/enUS/realmlist.wtf")).unwrap().contains(&profile.host));
|
||||
assert_eq!(std::fs::read_to_string(game.join("WTF/Config.wtf")).unwrap(), "SET realmName \"My realm\"\n");
|
||||
assert!(save(dir.path(), &Profile { host: "bad\nset realmlist other".into(), ..profile }).is_err());
|
||||
assert_eq!(load(dir.path()).unwrap().host, "192.168.1.10");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,194 @@
|
||||
//! Repair official files and pending SQL from signed packages without replacing player databases or settings.
|
||||
use std::{collections::BTreeMap, fs, path::Path};
|
||||
use serde::Serialize;
|
||||
use crate::{Error, Result, fsx, manifest::{Manifest, Kind, FileEntry, ReplacePolicy}, pkgsource::{self, Source}, registry::{InstallMeta, MetaDir}, update::{Env, RepackEnv}, download::Cancel};
|
||||
|
||||
#[derive(Debug, Serialize)]
|
||||
pub struct DatabaseCheck {
|
||||
pub realm: crate::realms::Mode,
|
||||
pub migrations: Vec<crate::migrations::Item>,
|
||||
pub problems: Vec<crate::schema_check::Problem>,
|
||||
pub full_schema: bool,
|
||||
}
|
||||
|
||||
fn installed_manifest(meta: &InstallMeta, dir: &Path) -> Result<Manifest> {
|
||||
let version = meta.core.version.as_deref().ok_or_else(|| Error::Invalid("This imported server has no verified package version. Install an official server package first.".into()))?;
|
||||
let update = dir.join("manifests").join(format!("update-{version}.json"));
|
||||
let bytes = fs::read(if update.exists() { update } else { dir.join("manifests/base.json") })?;
|
||||
let m = Manifest::parse(&bytes)?;
|
||||
if m.version != version { return Err(Error::Invalid("The installed package manifest is missing. Update the server to restore its package information.".into())); }
|
||||
Ok(m)
|
||||
}
|
||||
|
||||
pub fn check(root: &Path, dir: &Path) -> Result<Vec<DatabaseCheck>> {
|
||||
let (_, meta) = MetaDir::open(dir)?;
|
||||
let m = installed_manifest(&meta, dir)?;
|
||||
let checks = crate::backup::with_database(root, |db| {
|
||||
let mut modes = vec![crate::realms::Mode::Coa];
|
||||
if crate::realms::state(root)?.wildcard_created { modes.push(crate::realms::Mode::Wildcard); }
|
||||
let mut checks = Vec::new();
|
||||
for mode in modes {
|
||||
let db = db.clone().for_realm(mode);
|
||||
let migrations: Vec<_> = m.migrations.iter().filter(|m| mode == crate::realms::Mode::Coa || m.db != "auth").cloned().collect();
|
||||
checks.push(DatabaseCheck { realm: mode, migrations: crate::migrations::status(&db, &migrations)?, problems: crate::schema_check::check(&db, root)?, full_schema: root.join(crate::schema_check::CONTRACT).exists() });
|
||||
}
|
||||
Ok(checks)
|
||||
})?;
|
||||
fsx::atomic_write_json(&dir.join("logs/database-checks.json"), &checks)?;
|
||||
Ok(checks)
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize)]
|
||||
pub struct Report {
|
||||
pub restored: Vec<String>,
|
||||
pub applied: Vec<String>,
|
||||
pub backup: String,
|
||||
pub database: Vec<DatabaseCheck>,
|
||||
pub error: Option<String>,
|
||||
}
|
||||
|
||||
fn repairable(f: &FileEntry) -> bool {
|
||||
let path = f.path.to_lowercase();
|
||||
f.owner != crate::manifest::Owner::User && matches!(f.policy, ReplacePolicy::Replace | ReplacePolicy::ReplaceIfPristine)
|
||||
&& !path.starts_with("settings/") && !path.starts_with("core/configs/")
|
||||
&& !path.starts_with("mysql/data/") && !path.starts_with("_migrations/")
|
||||
}
|
||||
|
||||
fn restore_files(root: &Path, work: &Path, before: &Path, broken: &[(&FileEntry, bool)]) -> Result<Vec<String>> {
|
||||
let mut plan = Vec::new();
|
||||
// Back up every target before changing the first one, and retain a crash-recovery inventory.
|
||||
for (entry, _) in broken {
|
||||
let target = fsx::ensure_within(root, &fsx::safe_join(root, &entry.path)?)?;
|
||||
let existed = target.is_file();
|
||||
if existed {
|
||||
let saved = fsx::safe_join(before, &entry.path)?;
|
||||
fs::create_dir_all(saved.parent().unwrap())?;
|
||||
fs::copy(&target, saved)?;
|
||||
}
|
||||
plan.push((entry.path.clone(), existed));
|
||||
}
|
||||
fsx::atomic_write_json(&before.join("files.json"), &plan)?;
|
||||
let mut restored = Vec::new();
|
||||
let result: Result<()> = (|| {
|
||||
for (entry, latest) in broken {
|
||||
let target = fsx::ensure_within(root, &fsx::safe_join(root, &entry.path)?)?;
|
||||
let source = fsx::safe_join(&work.join(if *latest { "update" } else { "base" }), &entry.path)?;
|
||||
fsx::atomic_write(&target, &fs::read(&source)?)?;
|
||||
restored.push(entry.path.clone());
|
||||
}
|
||||
Ok(())
|
||||
})();
|
||||
if let Err(e) = result {
|
||||
for (path, existed) in &plan {
|
||||
let target = fsx::ensure_within(root, &fsx::safe_join(root, path)?)?;
|
||||
if *existed { fsx::atomic_write(&target, &fs::read(fsx::safe_join(before, path)?)?)?; }
|
||||
else if target.is_file() { fs::remove_file(target)?; }
|
||||
}
|
||||
return Err(e);
|
||||
}
|
||||
Ok(restored)
|
||||
}
|
||||
|
||||
pub fn run(root: &Path, dir: &Path, base_source: &Source, update_source: &Source, key: &str, progress: &dyn Fn(&str, u8)) -> Result<Report> {
|
||||
let _lock = crate::update::operation_lock(dir)?;
|
||||
let env = RepackEnv { root, meta_dir: dir };
|
||||
env.ensure_stopped()?;
|
||||
crate::update::ensure_recovered(dir)?;
|
||||
let (_, mut meta) = MetaDir::open(dir)?;
|
||||
progress("Checking signed packages", 2);
|
||||
let (update, _) = pkgsource::fetch_manifest(update_source, key)?;
|
||||
if update.kind != Kind::Update || !update.compatible_with_manager(crate::MANAGER_VERSION) || meta.core.version.as_deref() != Some(&update.version) {
|
||||
return Err(Error::Invalid("Update the server to the latest compatible package before repairing it. Repair never changes its version.".into()));
|
||||
}
|
||||
let (base, _) = pkgsource::fetch_manifest(base_source, key)?;
|
||||
let installed_base = Manifest::parse(&fs::read(dir.join("manifests/base.json"))?)?;
|
||||
if base.kind != Kind::Base || base.version != installed_base.version || base.core.commit != installed_base.core.commit {
|
||||
return Err(Error::Invalid("The matching base package is no longer available. Your server was left unchanged.".into()));
|
||||
}
|
||||
let work = dir.join("staging").join(format!("repair-{}", uuid::Uuid::new_v4()));
|
||||
fs::create_dir_all(&work)?;
|
||||
let result = (|| {
|
||||
let mut files: BTreeMap<String, (&FileEntry, bool)> = base.files.iter().filter(|f| repairable(f)).map(|f| (f.path.clone(), (f, false))).collect();
|
||||
for f in update.files.iter().filter(|f| repairable(f)) { files.insert(f.path.clone(), (f, true)); }
|
||||
let mut broken = Vec::new();
|
||||
for (path, (entry, latest)) in files {
|
||||
let target = fsx::ensure_within(root, &fsx::safe_join(root, &path)?)?;
|
||||
if fsx::sha256_file(&target).ok().as_deref() != Some(&entry.sha256) { broken.push((entry, latest)); }
|
||||
}
|
||||
let cancel = Cancel::default();
|
||||
let update_parts = pkgsource::fetch_parts(update_source, &update, &dir.join("staging/download"), &cancel, &|f,_| progress("Downloading repair files", 5 + (f * 30.0) as u8))?;
|
||||
crate::package::extract(&update_parts, &update, &work.join("update"), &|_,_| {})?;
|
||||
if broken.iter().any(|(_,latest)| !latest) {
|
||||
let base_parts = pkgsource::fetch_parts(base_source, &base, &dir.join("staging/repair-base-download"), &cancel, &|f,_| progress("Downloading base files", 35 + (f * 25.0) as u8))?;
|
||||
crate::package::extract(&base_parts, &base, &work.join("base"), &|_,_| {})?;
|
||||
}
|
||||
// Verify all sources before taking a backup or replacing any target.
|
||||
for (entry, latest) in &broken {
|
||||
let src = fsx::safe_join(&work.join(if *latest { "update" } else { "base" }), &entry.path)?;
|
||||
if fsx::sha256_file(&src)? != entry.sha256 { return Err(Error::Invalid("A repair file failed verification.".into())); }
|
||||
}
|
||||
progress("Backing up before repair", 65);
|
||||
let backup = crate::backup::create(root, dir, crate::backup::Kind::Full, crate::backup::Trigger::Manual, Some("before repair".into()), &|_| {})?.id;
|
||||
env.verify_recovery_point(&crate::backup::get(dir, &backup)?)?;
|
||||
let repair_files: Vec<_> = broken.iter().map(|(file, _)| (*file).clone()).collect();
|
||||
let mut txn = crate::update::begin_repair(root, dir, &update.version, &backup, &repair_files)?;
|
||||
let before = dir.join("repairs").join(&backup);
|
||||
fs::create_dir_all(&before)?;
|
||||
fsx::require_space(root, broken.iter().map(|(e,_)| e.size.saturating_mul(2)).sum())?;
|
||||
let restored = restore_files(root, &work, &before, &broken)?;
|
||||
for (entry, _) in &broken {
|
||||
meta.original_hashes.insert(entry.path.clone(), entry.sha256.clone());
|
||||
}
|
||||
fsx::atomic_write_json(&dir.join("install.json"), &meta)?;
|
||||
progress("Repairing pending database updates", 80);
|
||||
crate::update::repair_migrating(dir, &mut txn)?;
|
||||
let (applied, error) = match env.migrate(&update, &work.join("update/_migrations")) {
|
||||
Ok(r) => (r.applied, r.failed.map(|(id,why)| format!("{id}: {why}"))),
|
||||
Err(e) => (Vec::new(), Some(e.to_string())),
|
||||
};
|
||||
if error.is_some() {
|
||||
crate::update::finish_repair(root, dir, &mut txn, false, &env)?;
|
||||
let report = Report { restored: Vec::new(), applied: Vec::new(), backup, database: check(root, dir)?, error };
|
||||
fsx::atomic_write_json(&before.join("report.json"), &report)?;
|
||||
return Ok(report);
|
||||
}
|
||||
crate::config::create_missing_module_configs(root)?;
|
||||
progress("Checking database after repair", 95);
|
||||
let database = check(root, dir)?;
|
||||
let report = Report { restored, applied, backup, database, error };
|
||||
fsx::atomic_write_json(&before.join("report.json"), &report)?;
|
||||
crate::update::finish_repair(root, dir, &mut txn, true, &env)?;
|
||||
progress("Done", 100);
|
||||
Ok(report)
|
||||
})();
|
||||
// Only the UUID staging directory created above is discarded; backups are retained.
|
||||
let _ = fs::remove_dir_all(work);
|
||||
result
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
#[test]
|
||||
fn repair_never_replaces_player_data_or_settings() {
|
||||
for path in ["mysql/data/acore_characters/characters.ibd", "Settings/repack.json", "Core/configs/worldserver.conf", "_migrations/world/x.sql"] {
|
||||
let entry = FileEntry { path: path.into(), sha256: "a".repeat(64), size: 1, owner: crate::manifest::Owner::Core, policy: ReplacePolicy::Replace };
|
||||
assert!(!repairable(&entry));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn file_failure_restores_every_original_and_keeps_recovery_inventory() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("server");
|
||||
let work = d.path().join("work");
|
||||
let before = d.path().join("before");
|
||||
fsx::atomic_write(&root.join("Core/a.dll"), b"original").unwrap();
|
||||
fsx::atomic_write(&work.join("update/Core/a.dll"), b"repaired").unwrap();
|
||||
let entries: Vec<_> = ["Core/a.dll", "Core/missing.dll"].into_iter().map(|path| FileEntry { path: path.into(), sha256: "a".repeat(64), size: 1, owner: crate::manifest::Owner::Core, policy: ReplacePolicy::Replace }).collect();
|
||||
assert!(restore_files(&root, &work, &before, &[(&entries[0], true), (&entries[1], true)]).is_err());
|
||||
assert_eq!(fs::read(root.join("Core/a.dll")).unwrap(), b"original");
|
||||
assert!(!root.join("Core/missing.dll").exists());
|
||||
assert!(before.join("files.json").is_file());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,176 @@
|
||||
//! Read-only database structure checks. A release can ship a contract captured from its clean database.
|
||||
use std::collections::{BTreeMap, BTreeSet};
|
||||
use std::path::Path;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use crate::{db::Db, error::Result, fsx};
|
||||
|
||||
pub const CONTRACT: &str = "Scripts/database-schema.json";
|
||||
pub const WILDCARD_TABLES: &[(&str, &[&str])] = &[
|
||||
("world", &["ascension_wildcard_boss_marks", "ascension_wildcard_tooltip_links"]),
|
||||
("characters", &["coa_wildcard_skill_card", "coa_wildcard_skill_card_pending", "coa_wildcard_skill_card_account", "coa_wildcard_skill_card_purchase", "coa_wildcard_specialization_cache"]),
|
||||
];
|
||||
const WILDCARD_COLUMNS: &[(&str, &str, &[&str])] = &[
|
||||
("world", "ascension_wildcard_boss_marks", &["CreatureEntry", "Amount"]),
|
||||
("world", "ascension_wildcard_tooltip_links", &["Talent", "Ability"]),
|
||||
("characters", "coa_wildcard_skill_card", &["account", "card", "progress"]),
|
||||
("characters", "coa_wildcard_skill_card_pending", &["account", "id", "card"]),
|
||||
("characters", "coa_wildcard_skill_card_account", &["account", "bonus_progress"]),
|
||||
("characters", "coa_wildcard_skill_card_purchase", &["account", "type", "count"]),
|
||||
("characters", "coa_wildcard_specialization_cache", &["account", "claimed_at"]),
|
||||
];
|
||||
type Columns = BTreeMap<String, BTreeMap<String, BTreeMap<String, String>>>;
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize)]
|
||||
pub struct Contract {
|
||||
pub schema: u32,
|
||||
pub columns: Columns,
|
||||
}
|
||||
|
||||
pub fn require_release_contract(root: &Path) -> Result<Contract> {
|
||||
let contract: Contract = fsx::read_json(&root.join(CONTRACT))?;
|
||||
if contract.schema != 1 || ["auth", "characters", "world"].iter().any(|kind| {
|
||||
contract.columns.get(*kind).is_none_or(|tables| tables.is_empty() || tables.values().any(|columns| columns.is_empty()))
|
||||
}) {
|
||||
return Err(crate::Error::Invalid("The release must include a complete supported database schema contract.".into()));
|
||||
}
|
||||
Ok(contract)
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize)]
|
||||
pub struct Problem { pub database: String, pub table: String, pub column: String, pub detail: String }
|
||||
|
||||
fn read_columns(db: &Db, kind: &str) -> Result<BTreeMap<String, BTreeMap<String, String>>> {
|
||||
let schema = db.realm_schema(crate::db::schema_of(kind)?);
|
||||
let text = db.query(&format!("SELECT TABLE_NAME,COLUMN_NAME,CONCAT(COLUMN_TYPE,'|',IS_NULLABLE,'|',IF(COLUMN_DEFAULT IS NULL,'<NULL>',HEX(COLUMN_DEFAULT)),'|',IF(EXTRA='','<NONE>',HEX(EXTRA))) FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='{schema}' ORDER BY TABLE_NAME,ORDINAL_POSITION;"))?;
|
||||
let mut tables: BTreeMap<String, BTreeMap<String, String>> = BTreeMap::new();
|
||||
for line in text.lines() {
|
||||
let fields: Vec<_> = line.split('\t').collect();
|
||||
if fields.len() == 3 { tables.entry(fields[0].into()).or_default().insert(fields[1].into(), fields[2].into()); }
|
||||
}
|
||||
Ok(tables)
|
||||
}
|
||||
|
||||
pub fn capture(db: &Db, root: &Path) -> Result<()> {
|
||||
let mut columns = Columns::new();
|
||||
for kind in ["auth", "characters", "world"] { columns.insert(kind.into(), read_columns(db, kind)?); }
|
||||
fsx::atomic_write_json(&root.join(CONTRACT), &Contract { schema: 1, columns })
|
||||
}
|
||||
|
||||
pub fn check(db: &Db, root: &Path) -> Result<Vec<Problem>> {
|
||||
let contract = if root.join(CONTRACT).is_file() {
|
||||
let contract: Contract = fsx::read_json(&root.join(CONTRACT))?;
|
||||
if contract.schema != 1 { return Err(crate::Error::Invalid("Unsupported database schema contract.".into())); }
|
||||
contract
|
||||
} else {
|
||||
// Older packages have no full contract. Check the columns used by initial character saves.
|
||||
let tables: BTreeMap<String, Vec<String>> = serde_json::from_str(include_str!("character-save-columns.json"))?;
|
||||
Contract { schema: 1, columns: BTreeMap::from([("characters".into(), tables.into_iter().map(|(t, cols)| (t, cols.into_iter().map(|c| (c, String::new())).collect())).collect())]) }
|
||||
};
|
||||
let mut problems = Vec::new();
|
||||
// Older releases omit a schema contract. Still verify the feature's actual tables,
|
||||
// independently of its migration history, before declaring an update healthy.
|
||||
if std::fs::read(root.join("Core/worldserver.exe")).is_ok_and(|bytes| bytes.windows(b"Wildcard synergy settings".len()).any(|w| w == b"Wildcard synergy settings")) {
|
||||
for (kind, tables) in WILDCARD_TABLES {
|
||||
let actual = read_columns(db, kind)?;
|
||||
for table in *tables {
|
||||
if !actual.contains_key(*table) {
|
||||
problems.push(Problem { database: (*kind).into(), table: (*table).into(), column: String::new(), detail: "Missing required Wildcard table; migration history is not proof of its presence".into() });
|
||||
} else {
|
||||
for (_, _, columns) in WILDCARD_COLUMNS.iter().filter(|(k, t, _)| k == kind && t == table) {
|
||||
for column in *columns {
|
||||
if !actual[*table].contains_key(*column) {
|
||||
problems.push(Problem { database: (*kind).into(), table: (*table).into(), column: (*column).into(), detail: "Missing required Wildcard column".into() });
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
for (kind, expected) in &contract.columns {
|
||||
let actual = read_columns(db, kind)?;
|
||||
for (table, cols) in expected {
|
||||
if matches!(table.as_str(), "updates" | "updates_include" | "coa_manager_migrations") { continue; }
|
||||
if !actual.contains_key(table) {
|
||||
problems.push(Problem { database: kind.clone(), table: table.clone(), column: String::new(), detail: "Missing table".into() });
|
||||
continue;
|
||||
}
|
||||
for (column, want) in cols {
|
||||
let found = actual[table].get(column);
|
||||
if found.is_none() || (!want.is_empty() && found != Some(want)) {
|
||||
problems.push(Problem { database: kind.clone(), table: table.clone(), column: column.clone(), detail: found.map(|s| format!("Expected {want}, found {s}")).unwrap_or_else(|| "Missing column".into()) });
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// A custom NOT NULL column without a default can reject every INSERT even when all standard columns exist.
|
||||
let supplied: BTreeMap<String, Vec<String>> = serde_json::from_str(include_str!("character-save-columns.json"))?;
|
||||
let schema = db.realm_schema("acore_characters");
|
||||
let required = db.query(&format!("SELECT TABLE_NAME,COLUMN_NAME FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='{schema}' AND IS_NULLABLE='NO' AND COLUMN_DEFAULT IS NULL AND EXTRA NOT LIKE '%auto_increment%' AND EXTRA NOT LIKE '%GENERATED%';"))?;
|
||||
for (table, column) in required.lines().filter_map(|l| l.split_once('\t')) {
|
||||
if supplied.get(table).is_some_and(|cols| !cols.iter().any(|c| c == column)) {
|
||||
problems.push(Problem { database: "characters".into(), table: table.into(), column: column.into(), detail: "Required column has no default and is not supplied by character creation".into() });
|
||||
}
|
||||
}
|
||||
// The any-race/class migration supports every standard playable race for all CoA classes.
|
||||
// A class existing for just one race does not protect character creation or enumeration.
|
||||
if db.realm() == crate::realms::Mode::Coa {
|
||||
let rows = db.query("SELECT race,class FROM acore_world.playercreateinfo;")?;
|
||||
problems.extend(missing_coa_starts(&rows));
|
||||
}
|
||||
// Check owned characters too, including legacy classes and Wildcard characters. Their rows
|
||||
// must not silently disappear from character selection after an otherwise healthy update.
|
||||
let missing = db.query("SELECT c.race,c.class,COUNT(*) FROM acore_characters.characters c LEFT JOIN acore_world.playercreateinfo p ON p.race=c.race AND p.class=c.class WHERE p.race IS NULL GROUP BY c.race,c.class;")?;
|
||||
for row in missing.lines() {
|
||||
let fields: Vec<_> = row.split('\t').collect();
|
||||
if fields.len() == 3 {
|
||||
problems.push(Problem { database: "world".into(), table: "playercreateinfo".into(), column: String::new(), detail: format!("{} existing characters have no starting data for race {} / class {} and would be hidden from character selection", fields[2], fields[0], fields[1]) });
|
||||
}
|
||||
}
|
||||
Ok(problems)
|
||||
}
|
||||
|
||||
fn missing_coa_starts(rows: &str) -> Vec<Problem> {
|
||||
let pairs: BTreeSet<_> = rows.lines().filter_map(|l| l.split_once('\t')).map(|(a,b)| (a.to_owned(),b.to_owned())).collect();
|
||||
let mut problems = Vec::new();
|
||||
for race in [1, 2, 3, 4, 5, 6, 7, 8, 10, 11] {
|
||||
for class in 12..=32 {
|
||||
if !pairs.contains(&(race.to_string(), class.to_string())) {
|
||||
problems.push(Problem { database: "world".into(), table: "playercreateinfo".into(), column: String::new(), detail: format!("No starting data for CoA race {race} / class {class}") });
|
||||
}
|
||||
}
|
||||
}
|
||||
problems
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn a_release_cannot_use_a_partial_or_empty_schema_contract() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
assert!(require_release_contract(dir.path()).is_err());
|
||||
fsx::atomic_write_json(&dir.path().join(CONTRACT), &Contract { schema: 1, columns: Columns::new() }).unwrap();
|
||||
assert!(require_release_contract(dir.path()).is_err());
|
||||
let mut columns = Columns::new();
|
||||
for kind in ["auth", "characters", "world"] {
|
||||
columns.insert(kind.into(), BTreeMap::from([("table".into(), BTreeMap::from([("id".into(), "int|NO|<NULL>|<NONE>".into())]))]));
|
||||
}
|
||||
fsx::atomic_write_json(&dir.path().join(CONTRACT), &Contract { schema: 1, columns }).unwrap();
|
||||
assert!(require_release_contract(dir.path()).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn detects_a_missing_orc_class_pair_even_when_the_class_exists_for_other_races() {
|
||||
let mut rows = String::new();
|
||||
for race in [1, 2, 3, 4, 5, 6, 7, 8, 10, 11] {
|
||||
for class in 12..=32 { rows.push_str(&format!("{race}\t{class}\n")); }
|
||||
}
|
||||
assert!(missing_coa_starts(&rows).is_empty());
|
||||
let incomplete = rows.lines().filter(|line| *line != "2\t30").collect::<Vec<_>>().join("\n");
|
||||
let problems = missing_coa_starts(&incomplete);
|
||||
assert_eq!(problems.len(), 1);
|
||||
assert!(problems[0].detail.contains("race 2 / class 30"));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,155 @@
|
||||
use std::path::Path;
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, PartialEq, Eq)]
|
||||
pub struct Release {
|
||||
pub tag: Option<String>,
|
||||
pub commit: Option<String>,
|
||||
}
|
||||
|
||||
pub fn imported_repack(root: &Path) -> bool {
|
||||
root.join("CoA-Bots/release.json").is_file()
|
||||
}
|
||||
|
||||
pub fn release(root: &Path) -> Option<Release> {
|
||||
for name in ["Extras/SquidPlayerbots/release.json", "Core/configs/modules/playerbots.conf.settings.json", "CoA-Bots/release.json"] {
|
||||
let Ok(bytes) = std::fs::read(root.join(name)) else { continue; };
|
||||
if bytes.len() > 1024 * 1024 { continue; }
|
||||
let Ok(json) = serde_json::from_slice::<serde_json::Value>(&bytes) else { continue; };
|
||||
let safe = |key: &str| json.get(key).and_then(|value| value.as_str())
|
||||
.filter(|value| !value.is_empty() && value.len() <= 80 && value.chars().all(|c| c.is_ascii_alphanumeric() || "._-".contains(c))).map(str::to_owned);
|
||||
let tag = safe("tag").or_else(|| safe("version"));
|
||||
let revision = if name == "CoA-Bots/release.json" {
|
||||
json.get("botsModuleRevision").and_then(|value| value.as_str()).and_then(|value| value.split_whitespace().next()).map(str::to_owned).or_else(|| safe("commit"))
|
||||
} else if name.ends_with(".settings.json") { None } else { safe("commit") };
|
||||
let commit = revision.filter(|value| value.len() >= 7 && value.len() <= 40 && value.chars().all(|c| c.is_ascii_hexdigit()));
|
||||
if tag.is_some() || commit.is_some() { return Some(Release { tag, commit }); }
|
||||
}
|
||||
None
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
|
||||
pub struct Field {
|
||||
pub key: String,
|
||||
#[serde(rename = "type")]
|
||||
pub kind: String,
|
||||
pub title: String,
|
||||
pub description: String,
|
||||
#[serde(default)]
|
||||
pub group: String,
|
||||
#[serde(default)]
|
||||
pub group_title: Option<String>,
|
||||
pub default: serde_json::Value,
|
||||
#[serde(default)]
|
||||
pub default_if_missing: Option<serde_json::Value>,
|
||||
pub min: Option<f64>,
|
||||
pub max: Option<f64>,
|
||||
}
|
||||
|
||||
#[derive(Deserialize)]
|
||||
struct Settings {
|
||||
format: u32,
|
||||
settings: Vec<serde_json::Value>,
|
||||
#[serde(default)]
|
||||
groups: std::collections::BTreeMap<String, String>,
|
||||
}
|
||||
|
||||
pub fn fields(root: &Path) -> crate::Result<std::collections::BTreeMap<String, Field>> {
|
||||
let path = root.join("Core/configs/modules/playerbots.conf.settings.json");
|
||||
if !path.is_file() { return Ok(Default::default()); }
|
||||
let Ok(bytes) = std::fs::read(path) else { return Ok(Default::default()); };
|
||||
if bytes.len() > 1024 * 1024 { return Ok(Default::default()); }
|
||||
let Ok(settings) = serde_json::from_slice::<Settings>(&bytes) else { return Ok(Default::default()); };
|
||||
if settings.format != 1 { return Ok(Default::default()); }
|
||||
let mut fields = std::collections::BTreeMap::new();
|
||||
for value in settings.settings {
|
||||
let Ok(mut field) = serde_json::from_value::<Field>(value) else { continue; };
|
||||
field.group_title = settings.groups.get(&field.group).cloned();
|
||||
if !matches!(field.kind.as_str(), "bool" | "int" | "float" | "string")
|
||||
|| field.key.len() > 200 || field.key.is_empty()
|
||||
|| !field.key.chars().all(|c| c.is_ascii_alphanumeric() || "._".contains(c))
|
||||
|| field.min.zip(field.max).is_some_and(|(min,max)| min > max)
|
||||
|| !default_type(&field.kind, &field.default)
|
||||
|| field.default_if_missing.as_ref().is_some_and(|value| !default_type(&field.kind, value))
|
||||
|| fields.contains_key(&field.key) { continue; }
|
||||
fields.insert(field.key.clone(), field);
|
||||
}
|
||||
Ok(fields)
|
||||
}
|
||||
|
||||
fn default_type(kind: &str, value: &serde_json::Value) -> bool {
|
||||
match kind {
|
||||
"bool" => value.is_boolean(),
|
||||
"int" => value.is_i64() || value.is_u64(),
|
||||
"float" => value.is_number(),
|
||||
"string" => value.is_string(),
|
||||
_ => false,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn scalar(value: &serde_json::Value) -> Option<String> {
|
||||
match value {
|
||||
serde_json::Value::Bool(value) => Some(if *value { "1" } else { "0" }.into()),
|
||||
serde_json::Value::String(value) => Some(value.clone()),
|
||||
serde_json::Value::Number(value) => Some(value.to_string()),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn validate(field: &Field, value: &str) -> crate::Result<()> {
|
||||
let valid = match field.kind.as_str() {
|
||||
"bool" => matches!(value, "0" | "1"),
|
||||
"int" | "float" => value.parse::<f64>().is_ok_and(|number| number.is_finite()
|
||||
&& (field.kind != "int" || number.fract() == 0.0)
|
||||
&& field.min.is_none_or(|min| number >= min) && field.max.is_none_or(|max| number <= max)),
|
||||
"string" => true,
|
||||
_ => false,
|
||||
};
|
||||
if valid { Ok(()) } else { Err(crate::Error::Invalid(format!("{} must match its documented SquidBots type and range.", field.key))) }
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
#[test]
|
||||
fn upstream_settings_preserve_types_ranges_and_distinct_defaults() {
|
||||
let root = tempfile::tempdir().unwrap();
|
||||
crate::fsx::atomic_write(&root.path().join("Core/configs/modules/playerbots.conf.settings.json"), br#"{"format":1,"settings":[{"key":"AiPlayerbot.MinRandomBots","type":"int","group":"population","title":"Minimum bots","description":"Lower bound","default":500,"default_if_missing":50,"min":0,"max":5000}]}"#).unwrap();
|
||||
let fields = fields(root.path()).unwrap();
|
||||
let field = &fields["AiPlayerbot.MinRandomBots"];
|
||||
assert_eq!(scalar(&field.default).as_deref(), Some("500"));
|
||||
assert_eq!(scalar(field.default_if_missing.as_ref().unwrap()).as_deref(), Some("50"));
|
||||
assert!(validate(field, "5000").is_ok());
|
||||
for value in ["5001", "-1", "0.5", "NaN"] { assert!(validate(field, value).is_err()); }
|
||||
}
|
||||
#[test]
|
||||
fn unsupported_metadata_falls_back_and_bad_entries_do_not_hide_valid_fields() {
|
||||
let root = tempfile::tempdir().unwrap();
|
||||
let path = root.path().join("Core/configs/modules/playerbots.conf.settings.json");
|
||||
for data in [r#"{"format":99,"settings":[]}"#, "invalid json", r#"{"format":1,"settings":{}}"#] {
|
||||
crate::fsx::atomic_write(&path, data.as_bytes()).unwrap();
|
||||
assert!(fields(root.path()).unwrap().is_empty());
|
||||
}
|
||||
crate::fsx::atomic_write(&path, br#"{"format":1,"settings":[{"key":"Broken","type":"enum","title":"Broken","description":"Unknown type","default":1},{"key":"Malformed"},{"key":"WrongDefault","type":"int","title":"Wrong","description":"Bad default","default":"oops"},{"key":"Good","type":"bool","title":"Good","description":"Good field","default":true}]}"#).unwrap();
|
||||
let parsed = fields(root.path()).unwrap();
|
||||
assert_eq!(parsed.len(), 1);
|
||||
assert!(parsed.contains_key("Good"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn imported_revision_uses_its_first_word_and_empty_tags_are_hidden() {
|
||||
let root = tempfile::tempdir().unwrap();
|
||||
crate::fsx::atomic_write(&root.path().join("CoA-Bots/release.json"), br#"{"tag":"","botsModuleRevision":"48c4786a 2026-10-01 (coa branch)","commit":"abcdef01"}"#).unwrap();
|
||||
assert_eq!(release(root.path()).unwrap(), Release { tag: None, commit: Some("48c4786a".into()) });
|
||||
crate::fsx::atomic_write(&root.path().join("Core/configs/modules/playerbots.conf.settings.json"), br#"{"tag":"v1.8.1","commit":"11111111"}"#).unwrap();
|
||||
assert_eq!(release(root.path()).unwrap(), Release { tag: Some("v1.8.1".into()), commit: None });
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn diagnostics_only_expose_release_identifiers() {
|
||||
let root = tempfile::tempdir().unwrap();
|
||||
crate::fsx::atomic_write(&root.path().join("CoA-Bots/release.json"), br#"{"tag":"v1.8","commit":"48c4786a","password":"secret"}"#).unwrap();
|
||||
assert!(imported_repack(root.path()));
|
||||
assert_eq!(release(root.path()).unwrap(), Release { tag: Some("v1.8".into()), commit: Some("48c4786a".into()) });
|
||||
}
|
||||
}
|
||||
+763
-66
File diff suppressed because it is too large.
Load diff
@@ -2,7 +2,9 @@
|
||||
//!
|
||||
//! coa-release pack-base --tree DIR --out DIR --version X [--core-commit SHA] [--part-size BYTES]
|
||||
//! coa-release pack-update --tree DIR --base-manifest FILE --core DIR --out DIR --version X
|
||||
//! [--bots DIR] [--core-commit SHA] [--bots-commit SHA] [--part-size BYTES]
|
||||
//! [--bots DIR] [--repairs DIR] [--core-commit SHA] [--bots-commit SHA] [--part-size BYTES]
|
||||
//! coa-release extract-schema-base --package DIR --fixture NEW-coa-schema-fixture-DIR
|
||||
//! coa-release schema-contract --repack FIXTURE --tree DIR --core DIR [--bots DIR] [--repairs DIR]
|
||||
//! coa-release clean-base --repack DIR --core DIR --tree DIR --out DIR [--bots DIR] [--data DIR]
|
||||
//! coa-release sign --dir DIR (key: env COA_SIGNING_KEY, or ~/.coa-manager/signing/manifest-signing.key)
|
||||
//! coa-release verify --dir DIR (against the public key built into this tool)
|
||||
@@ -12,7 +14,7 @@ use std::path::PathBuf;
|
||||
|
||||
use coa_core::manifest::{Kind, Manifest};
|
||||
use coa_core::package::{build, BuildOptions, DEFAULT_PART_SIZE};
|
||||
use coa_core::release::{collect_bots_sql, collect_core_sql, pack_update, sign_manifest, UpdateParams};
|
||||
use coa_core::release::{pack_update, sign_manifest, UpdateParams};
|
||||
|
||||
fn args(rest: &[String]) -> HashMap<String, String> {
|
||||
let mut m = HashMap::new();
|
||||
@@ -44,17 +46,38 @@ fn run() -> Result<(), String> {
|
||||
let e = |x: coa_core::Error| x.to_string();
|
||||
let part = a.get("part-size").and_then(|v| v.parse().ok()).unwrap_or(DEFAULT_PART_SIZE);
|
||||
match cmd.as_str() {
|
||||
"extract-schema-base" => {
|
||||
coa_core::release_schema::extract_base(
|
||||
&PathBuf::from(need(&a, "package")?), &PathBuf::from(need(&a, "fixture")?),
|
||||
coa_core::signing::EMBEDDED_PUBLIC_KEY,
|
||||
).map_err(e)?;
|
||||
println!("signed base extracted into a disposable database fixture");
|
||||
}
|
||||
"schema-contract" => {
|
||||
let repack = PathBuf::from(need(&a, "repack")?);
|
||||
let tree = PathBuf::from(need(&a, "tree")?);
|
||||
if let Some(core) = a.get("core") {
|
||||
let bots = a.get("bots").map(PathBuf::from);
|
||||
let repairs = a.get("repairs").map(PathBuf::from);
|
||||
let sql = coa_core::release_schema::collect(&PathBuf::from(core), bots.as_deref(), repairs.as_deref()).map_err(e)?;
|
||||
coa_core::release_schema::capture_release(&repack, &tree, &sql).map_err(e)?;
|
||||
} else {
|
||||
coa_core::backup::with_database(&repack, |db| coa_core::schema_check::capture(db, &tree)).map_err(e)?;
|
||||
}
|
||||
println!("database schema contract captured");
|
||||
}
|
||||
"pack-base" => {
|
||||
coa_core::schema_check::require_release_contract(&PathBuf::from(need(&a, "tree")?)).map_err(e)?;
|
||||
let opts = BuildOptions { kind: Kind::Base, version: need(&a, "version")?.clone(), core_commit: a.get("core-commit").cloned(), built_at: chrono_now(), part_size: part, bots_commit: a.get("bots-commit").cloned(), migrations: vec![] };
|
||||
let m = build(&PathBuf::from(need(&a, "tree")?), &PathBuf::from(need(&a, "out")?), &opts, &|s| eprintln!("{s}")).map_err(e)?;
|
||||
println!("base {}: {} files, {} parts", m.version, m.files.len(), m.archive.as_ref().map(|x| x.parts.len()).unwrap_or(0));
|
||||
}
|
||||
"pack-update" => {
|
||||
let base: Manifest = Manifest::parse(&std::fs::read(need(&a, "base-manifest")?).map_err(|x| x.to_string())?).map_err(e)?;
|
||||
let mut sql = collect_core_sql(&PathBuf::from(need(&a, "core")?)).map_err(e)?;
|
||||
if let Some(b) = a.get("bots") {
|
||||
sql.extend(collect_bots_sql(&PathBuf::from(b)).map_err(e)?);
|
||||
}
|
||||
coa_core::schema_check::require_release_contract(&PathBuf::from(need(&a, "tree")?)).map_err(e)?;
|
||||
let bots = a.get("bots").map(PathBuf::from);
|
||||
let repairs = a.get("repairs").map(PathBuf::from);
|
||||
let sql = coa_core::release_schema::collect(&PathBuf::from(need(&a, "core")?), bots.as_deref(), repairs.as_deref()).map_err(e)?;
|
||||
let out = PathBuf::from(need(&a, "out")?);
|
||||
let m = pack_update(
|
||||
&UpdateParams { tree: &PathBuf::from(need(&a, "tree")?), base_manifest: &base, sql: &sql, out: &out, version: need(&a, "version")?.clone(), core_commit: a.get("core-commit").cloned(), bots_commit: a.get("bots-commit").cloned(), part_size: part },
|
||||
@@ -72,22 +95,29 @@ fn run() -> Result<(), String> {
|
||||
}
|
||||
"sign" => {
|
||||
let dir = PathBuf::from(need(&a, "dir")?);
|
||||
require_contract_entry(&dir)?;
|
||||
sign_manifest(&dir, &signing_key()?).map_err(e)?;
|
||||
coa_core::release_schema::verify_package(&dir, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
|
||||
println!("signed {}", dir.join("manifest.json").display());
|
||||
}
|
||||
"verify" => {
|
||||
let dir = PathBuf::from(need(&a, "dir")?);
|
||||
let bytes = std::fs::read(dir.join("manifest.json")).map_err(|x| x.to_string())?;
|
||||
let sig = std::fs::read_to_string(dir.join("manifest.json.sig")).map_err(|x| x.to_string())?;
|
||||
coa_core::signing::verify_embedded(&bytes, &sig).map_err(e)?;
|
||||
Manifest::parse(&bytes).map_err(e)?;
|
||||
println!("signature and manifest OK");
|
||||
coa_core::release_schema::verify_package(&dir, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
|
||||
println!("signature, archive contents and database schema contract OK");
|
||||
}
|
||||
other => return Err(format!("unknown command {other}")),
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn require_contract_entry(dir: &std::path::Path) -> Result<(), String> {
|
||||
let manifest = Manifest::parse(&std::fs::read(dir.join("manifest.json")).map_err(|e| e.to_string())?).map_err(|e| e.to_string())?;
|
||||
if !manifest.files.iter().any(|f| f.path == coa_core::schema_check::CONTRACT && f.size > 0) {
|
||||
return Err("The release is missing its database schema contract; refusing to sign or publish it.".into());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn chrono_now() -> String {
|
||||
chrono::Utc::now().to_rfc3339()
|
||||
}
|
||||
|
||||
+58
-10
@@ -233,18 +233,21 @@ hash**: current == recorded → safe to replace; current ≠ recorded → *modif
|
||||
2. **Download** to `staging\<txid>\dl\` with `.part` files, HTTP Range resume, retry/backoff, cancel, progress.
|
||||
3. **Verify** — SHA-256 of every artefact; nothing is executed or extracted into the live tree before this.
|
||||
4. **Snapshot** — server must be stopped (never copy over a running worldserver); create recovery point:
|
||||
replaced binaries, changed managed configs, module state, `characters`+`auth` dump (world optional);
|
||||
replaced binaries, changed managed configs, module state, full dumps of every managed realm database;
|
||||
write `txn.json {state: Snapshotted}`.
|
||||
5. **Apply** into `staging\<txid>\tree\`, resolve ownership conflicts, merge configs, then swap file-by-file with
|
||||
same-volume atomic renames, journaling each step (`txn.json` lists done/undone operations).
|
||||
6. **Migrate** — run pending SQL through the tracked runner (D7); failure ⇒ stop, keep DB backup, offer restore.
|
||||
7. **Validate** — start server, health check (D3) with timeout.
|
||||
6. **Migrate** — durably mark SQL as running before execution. Failure restores the full database recovery point
|
||||
before restoring files. Interrupted SQL is never automatically replayed.
|
||||
7. **Validate** — check database structure, start server, require ten seconds of continuous readiness with timeout.
|
||||
8. **Commit** — ownership table + `install.json` version bump, mark txn `Committed`, prune staging.
|
||||
Any crash before Commit leaves `txn.json` in a non-terminal state; on next launch the Manager detects it and
|
||||
offers *Roll forward* or *Roll back* — the install is "recoverable" by construction.
|
||||
|
||||
Rollback = binaries + managed config state + module state only. Database restore is a **separate explicit
|
||||
action** (spec §19–20).
|
||||
Rollback restores files, configuration and installation metadata. Once migrations started, it also restores all
|
||||
databases from the full pre-update recovery point. Failed recovery remains unfinished and blocks startup and another
|
||||
update. The same journal protects Repair. Old transactions without a full recovery point cannot roll back database
|
||||
changes automatically. Independent database restore remains available for other recovery points.
|
||||
|
||||
### D7. Database strategy (`db` module)
|
||||
|
||||
@@ -253,14 +256,15 @@ action** (spec §19–20).
|
||||
native Rust client (`mysql_async`) is used for health pings and migration ledger reads.
|
||||
* Ledger: table `acore_world.coa_manager_migrations(id, db, sha256, applied_at, status, error)` (created by the
|
||||
Manager, in a dedicated table — no core schema is changed) mirrored to `.manager\migrations\`.
|
||||
Statuses `Applied | Pending | Failed`. Each file runs in a single connection; DDL is not transactional, so
|
||||
Statuses `Applied | Pending | Failed | Running`. Each file runs in a single connection; DDL is not transactional, so
|
||||
"destructive" migrations (flag in manifest, or heuristic scan for `DROP|TRUNCATE|DELETE|ALTER ... DROP`) force
|
||||
a fresh DB backup first and require explicit confirmation.
|
||||
* Backups: `mysqldump --single-transaction --routines --quick` per DB. Quick = characters + auth + configs +
|
||||
metadata; Full adds world (large); Config-only; DB-only. Compressed with zstd. Restore is always to a
|
||||
staging schema first (`…_restore`), swapped only after a row-count sanity check, with the current DB dumped
|
||||
beforehand.
|
||||
* Never: `DROP DATABASE`, resetting characters, overwriting DBs, or restoring DB on a binary rollback. Delete/
|
||||
* Never: `DROP DATABASE` or resetting characters. Update recovery restores databases into staging schemas and
|
||||
keeps the replaced tables in separate schemas. Delete/
|
||||
reset lives only in **Settings → Advanced → Danger Zone**, deletes tracked files only, and refuses to remove a
|
||||
directory that still contains untracked files.
|
||||
* Clean install: extract `mysql\data.7z` (packaged data dir), then **rotate** root/app passwords to fresh random
|
||||
@@ -337,6 +341,42 @@ Base package (≈3.2 GB; Data 3.8 GB + mysql data) is split into ≤ 1.9 GB part
|
||||
with a parts manifest. Reproducibility: pinned runner image label, recorded compiler/vcpkg versions, source SHAs,
|
||||
build timestamp written into RELEASE.json.
|
||||
|
||||
### D13. Linux: the servers run in Docker (experimental)
|
||||
|
||||
Linux has no repack launcher and no Win32 process API, and the host should need nothing but Docker. A server folder
|
||||
that contains `Settings/docker.json` is a **Docker installation**; every other folder is a repack, handled by the
|
||||
code above without any change. `driver::run`, `process::observe` and `layout::scan` check for the marker first and
|
||||
hand over to `coa_core::docker`; nothing else needed to change for start, stop, status and the server list.
|
||||
|
||||
* **Containers** (`docker/lifecycle.rs`): `coa-<project>-db` (official `mysql:8.4`, data in a named volume, not
|
||||
published on the host), `-world` and `-auth` (a small runtime image holding only the shared libraries; the
|
||||
binaries are mounted from `Core/`, so an update replaces files and never rebuilds an image). The image tag is a
|
||||
hash of its Dockerfile.
|
||||
* **Why the `docker` command line and not `docker compose`**: the compose plugin is missing from some distributions'
|
||||
Docker packages, and the plan is to ask for as little as possible on the host. The command line is wrapped by a
|
||||
`Docker` trait (`docker/cli.rs`), so the logic is tested with an in-memory fake.
|
||||
* **Same folder shape as a repack where it matters**: `Core/configs`, `Core/Logs`, `Settings/repack.json`
|
||||
(ports, RA login), `Settings/database.json` and `Data/`. Configuration editing, log tailing and the RA console
|
||||
therefore work as they do on Windows. The container runs as the owner of the folder and starts in `Core/`.
|
||||
* **Settings forced by environment** (the core reads `AC_<KEY>` before the `.conf`): `AC_BIND_IP=0.0.0.0` (the
|
||||
published address, `bindAddress`, decides who can connect), `AC_DATA_DIR`, `AC_LOGS_DIR`, `AC_RA_ENABLE`,
|
||||
`AC_RA_IP`, and `AC_UPDATES_ENABLE_DATABASES=0`: the server's own database updater needs a `mysql` client program and
|
||||
stops the server without one; the Manager applies database updates itself (section 1.4). The remote console is published
|
||||
on `127.0.0.1` only.
|
||||
* **Secrets** go to `docker` by environment (`--env NAME` without a value), never on a command line.
|
||||
* **Order**: database healthy, then world listening, then auth. The auth server exits when no realm is online.
|
||||
Readiness is a connection that stays open: Docker's proxy accepts connections on a published port before the server
|
||||
inside listens, so a plain connect proves nothing.
|
||||
* **Configuration path in the binaries**: Linux builds must use `-DCONF_DIR=configs` (see `coa-server-build`),
|
||||
otherwise the core looks for module configs in a path baked in at build time.
|
||||
* **Database access** (`db.rs`): for a Docker installation `Db` runs `mysql`, `mysqldump` and `mysqladmin` inside the
|
||||
database container with `docker exec -i`, connecting over TCP on the container's loopback exactly as the repack's
|
||||
commands do on the host (password through `MYSQL_PWD`, never on a command line). Nothing else changes: accounts,
|
||||
backups, the population query, migrations and the RA service account all go through `Db`, and the host needs no
|
||||
MySQL client. A repack keeps using its bundled tools.
|
||||
* **Not done yet**: installation and the database setup (schemas, `acore` user), updates, port conflict detection,
|
||||
the firewall and exposure checks, the Wildcard realm profiles, and the client under Wine/Proton.
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
## 3. Flows
|
||||
@@ -361,8 +401,11 @@ files the running server itself changes, diffed before/after.
|
||||
disk-full at write n, network cut at byte n, migration returns error, new worldserver exits non-zero, port
|
||||
taken, exe quarantined (file vanishes), folder moved, user-modified managed file, unknown config keys.
|
||||
|
||||
### 3.4 Rollback — restore recovery point's binaries/configs/module state; database untouched unless the user
|
||||
picks "Restore database" separately (shows dump timestamp and warns that progress since then is lost).
|
||||
### 3.4 Rollback — restore the pre-update databases when migrations started, followed by files and metadata
|
||||
|
||||
The UI explains that progress after the recovery point is lost. SQL failures before startup recover automatically;
|
||||
failed health checks keep the installation blocked until the owner chooses recovery. Every recovery point and staging
|
||||
schema has a unique identifier, and corrupt update journals fail closed.
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
@@ -535,6 +578,11 @@ The reference install classifies as **Healthy (customised)**: repack shape, bina
|
||||
* **UI:** PLAY becomes **UPDATE CLIENT** when a tracked client is outdated (with "Play without updating"); with no client linked it
|
||||
becomes **Set up game client** (choose an existing folder, or download into `<chosen folder>/CoA Client` with a free-space check).
|
||||
An existing client that is not tracked can be adopted from Settings > Game client ("Keep this client up to date").
|
||||
A fresh download gets `realmlist.wtf` for each installed locale (the manifest has none) and the companion addon.
|
||||
A fresh download gets `realmlist.wtf` for each installed locale (the manifest has none) and, for local hosts, the companion addon.
|
||||
* **Joining another server:** the welcome screen offers hosting or joining. Joining uses a separate player profile in
|
||||
the Manager's `remote-client/connection.json`, storing the host address and client folder without a server registry entry,
|
||||
installation metadata, database or server processes. Only Overview and application Settings appear in the sidebar.
|
||||
Downloading, adopting and updating clients use the same verified downloader; Play applies the saved realmlist without
|
||||
forcing a local realm selection. The player can return to hosting without removing their saved connection.
|
||||
* **Open points:** ask the launcher maintainers before putting heavy load on their API; DBCs live inside the MPQ patch archives
|
||||
(extracting them would need an MPQ reader), so the server's `Data\dbc` still comes from our `base` package for now.
|
||||
@@ -0,0 +1,44 @@
|
||||
# Database checks, repair and simultaneous worlds
|
||||
|
||||
Settings includes **Check files and database**, **Repair**, and **Start CoA and Wildcard together**.
|
||||
|
||||
Database checks inspect both realm schemas when Wildcard exists, the migration ledger, character-save columns and CoA starting class data. Results are saved in the installation metadata's `logs/database-checks.json` and included in exported diagnostics. Hash checks skip mutable MySQL data and configuration files.
|
||||
|
||||
Repair requires both worlds and auth to be stopped, no unfinished update, and the installed version to match the currently published signed update. The signed base must match the installed base as well. It verifies packages before changing files, creates a full database/config backup, saves every replaced file and a recovery inventory under `<server>.manager/repairs/<backup-id>/`, then restores official files and applies pending migrations to both worlds. Settings and player databases are not replaced. A failure during file replacement restores the original files. Interrupted repair can be retried; its file inventory and backups remain available.
|
||||
|
||||
Repair reports unresolved schema damage. It does not guess ALTER statements or replay already applied SQL: those cases need a new corrective migration. Applied SQL whose recorded SHA-256 changed is reported and rejected. Manager failure records take precedence over the core's old `updates` entries.
|
||||
|
||||
## Release schema contracts
|
||||
|
||||
`clean-base` clears the character migration ledger after rebuilding the character database and captures `Scripts/database-schema.json`. It contains expected table/column names and column types. Installation and migration validation inspect this contract; older packages receive the narrower character-save checks, clearly labelled in the UI.
|
||||
|
||||
For each update, capture a fresh contract **from a disposable database already migrated to the exact packaged core**, into the release tree before `pack-update`:
|
||||
|
||||
```powershell
|
||||
cargo run -p coa-release -- extract-schema-base --package C:\games\signed-base --fixture C:\games\coa-schema-fixture-build
|
||||
cargo run -p coa-release -- schema-contract --repack C:\games\coa-schema-fixture-build --tree C:\games\release-tree --core C:\games\release-core --bots C:\games\release-bots --repairs C:\games\release-repairs
|
||||
```
|
||||
|
||||
The first command verifies every entry in the signed base archive and extracts only the runtime needed for a disposable database. The second applies the release SQL with temporary ports, checks critical feature tables independently of migration history, and captures the resulting schema. It requires the disposable fixture marker and never starts a world server.
|
||||
|
||||
Base and update packaging require a complete contract for all three databases. Cumulative updates always carry it, even when unchanged. Signing and verification check the archive contents and contract before publication. Never capture it from a user's server or from an unmigrated previous release database.
|
||||
|
||||
Corrective SQL under `repairs/{auth,characters,world}` receives new `manager_repair__` migration IDs and runs after historical SQL. Missing Wildcard tables can therefore be restored without replaying historical data deletion. Existing malformed tables still fail schema checks; creating a missing table does not recover its lost rows.
|
||||
|
||||
## Simultaneous worlds
|
||||
|
||||
On Windows the checkbox creates Wildcard when needed and saves distinct secondary world/RA ports. Both worlds start with one shared authserver/MySQL and separate world/character databases. The second world has its own executable copy, config, supervisor, logs and report spool in `.realms/secondary`; Data is read through the primary installation's absolute path. This runtime folder is excluded from packages.
|
||||
|
||||
The selected realm remains the primary world used by the Manager's console, companions, settings and Play. Selecting another realm still stops/restarts both to preserve that relationship. CoA companion restrictions on Wildcard remain in force. Both world statuses are shown on Overview.
|
||||
|
||||
Stop shuts down the secondary supervisor/world before the primary launcher may stop the shared database. Database restores, updates and profile changes reject a running secondary world. Each start refreshes its executable/config copies, so server updates cannot leave an old secondary binary behind. The secondary world inherits the primary network bind setting; its RA console remains on loopback. Enabling friends networking opens/maps both world ports. If networking was enabled before the second realm, enable it again to add the second port's rule/mapping.
|
||||
|
||||
## Disposable probes
|
||||
|
||||
```powershell
|
||||
cargo run -p coa-core --example multiworld_e2e -- C:\games\your-fixture
|
||||
cargo run -p coa-core --example repair_e2e -- C:\games\your-fixture
|
||||
cargo run -p coa-core --example schema_e2e -- C:\games\your-fixture
|
||||
```
|
||||
|
||||
The first checks both processes, ports, shared services and graceful shutdown. The second uses a test-only signing key, corrupts a fixture file, applies SQL to both worlds, verifies backups and account/character counts, and drops a column only in Wildcard to prove schema checks are isolated. These probes modify the fixture; never use a real server.
|
||||
+11
-6
@@ -76,10 +76,12 @@
|
||||
"fr": "Remplit l'hôtel des ventes d'annonces réalistes et réglables.",
|
||||
"es": "Llena la casa de subastas con ofertas realistas y ajustables."
|
||||
},
|
||||
"repo": "https://github.com/NathanHandley/mod-ah-bot-plus",
|
||||
"repo": "https://github.com/Corfirean/azerothcore-wotlk-coa/tree/coa-bots/modules/mod-ah-bot-plus",
|
||||
"conf": "mod_ahbot.conf",
|
||||
"switchable": false,
|
||||
"status": "soon",
|
||||
"enable_key": "AuctionHouseBot.Enable",
|
||||
"default_on": false,
|
||||
"switchable": true,
|
||||
"status": "early",
|
||||
"icon": "gavel"
|
||||
},
|
||||
{
|
||||
@@ -112,9 +114,12 @@
|
||||
},
|
||||
"repo": "https://github.com/Zyth45/mod-playerbots",
|
||||
"conf": "playerbots.conf",
|
||||
"switchable": false,
|
||||
"status": "soon",
|
||||
"icon": "swords"
|
||||
"switchable": true,
|
||||
"status": "early",
|
||||
"icon": "swords",
|
||||
"enable_key": "AiPlayerbot.Enabled",
|
||||
"default_on": false,
|
||||
"page": "bots"
|
||||
},
|
||||
{
|
||||
"id": "client-compat",
|
||||
|
||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "coa-server-manager",
|
||||
"version": "0.5.0",
|
||||
"version": "0.6.5",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "coa-server-manager",
|
||||
"version": "0.5.0",
|
||||
"version": "0.6.5",
|
||||
"dependencies": {
|
||||
"@tauri-apps/api": "^2.12.0",
|
||||
"@tauri-apps/plugin-dialog": "^2.8.0",
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "coa-server-manager",
|
||||
"private": true,
|
||||
"version": "0.5.0",
|
||||
"version": "0.6.5",
|
||||
"license": "AGPL-3.0-only",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
|
||||
+3
-3
@@ -157,7 +157,7 @@
|
||||
"type": "float",
|
||||
"category": "rates",
|
||||
"title": "Rested bonus while playing",
|
||||
"description": "Speed at which rested experience is used up while you play.",
|
||||
"description": "Speed at which rested experience accumulates while online in a rest area.",
|
||||
"default": 1,
|
||||
"advanced": true,
|
||||
"restartRequired": "world",
|
||||
@@ -637,8 +637,8 @@
|
||||
"key": "Rate.Talent",
|
||||
"type": "float",
|
||||
"category": "rates",
|
||||
"title": "Talent points",
|
||||
"description": "Multiplier for the talent points a character earns per level.",
|
||||
"title": "Standard talent points (AzerothCore)",
|
||||
"description": "Only affects standard AzerothCore talents. CoA class and specialization points come from client data and ignore this multiplier.",
|
||||
"default": 1,
|
||||
"advanced": true,
|
||||
"restartRequired": "world",
|
||||
|
||||
@@ -16,6 +16,7 @@ tauri = { version = "2", features = [] }
|
||||
tauri-plugin-dialog = "2"
|
||||
tauri-plugin-updater = "2"
|
||||
tauri-plugin-process = "2"
|
||||
tauri-plugin-opener = "2"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
serde_json = "1"
|
||||
coa-core = { path = "../crates/coa-core" }
|
||||
|
||||
+203
-47
@@ -70,11 +70,24 @@ struct StatusView {
|
||||
path_exists: bool,
|
||||
}
|
||||
|
||||
/// Where the Manager keeps its own state (server list, logs). `%LOCALAPPDATA%` on Windows, the XDG data folder elsewhere.
|
||||
fn data_dir() -> PathBuf {
|
||||
#[cfg(windows)]
|
||||
let base = std::env::var_os("LOCALAPPDATA").map(PathBuf::from).unwrap_or_else(std::env::temp_dir);
|
||||
#[cfg(not(windows))]
|
||||
let base = unix_data_home(std::env::var_os("XDG_DATA_HOME"), std::env::var_os("HOME"));
|
||||
base.join("CoAServerManager")
|
||||
}
|
||||
|
||||
/// `$XDG_DATA_HOME` when it is an absolute path (the spec says to ignore relative ones), else `~/.local/share`.
|
||||
#[cfg(not(windows))]
|
||||
fn unix_data_home(xdg: Option<std::ffi::OsString>, home: Option<std::ffi::OsString>) -> PathBuf {
|
||||
xdg.map(PathBuf::from)
|
||||
.filter(|p| p.is_absolute())
|
||||
.or_else(|| home.map(|h| PathBuf::from(h).join(".local/share")))
|
||||
.unwrap_or_else(std::env::temp_dir)
|
||||
}
|
||||
|
||||
fn path_of(state: &AppState, id: &str) -> Result<PathBuf> {
|
||||
state
|
||||
.registry
|
||||
@@ -532,6 +545,10 @@ async fn realm_select(state: State<'_, AppState>, id: String, mode: coa_core::re
|
||||
if !out.ok { return Err(Error::Invalid(out.output)); }
|
||||
}
|
||||
let view = coa_core::realms::select(&root, mode)?;
|
||||
let (dir, meta) = install_meta(&root)?;
|
||||
if let Some(client) = meta.client_path {
|
||||
coa_core::client::sync_realm(std::path::Path::new(&client), &dir, view.active)?;
|
||||
}
|
||||
if restart {
|
||||
let out = driver::run(&root, Verb::StartAll)?;
|
||||
if !out.ok { return Err(Error::Invalid(format!("Realm selected, but startup failed: {}", out.output))); }
|
||||
@@ -541,6 +558,32 @@ async fn realm_select(state: State<'_, AppState>, id: String, mode: coa_core::re
|
||||
result
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
async fn realm_simultaneous(state: State<'_, AppState>, id: String, enabled: bool) -> std::result::Result<coa_core::realms::View, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||
blocking(move || coa_core::multiworld::set_enabled(&root, enabled)).await
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
async fn check_database(state: State<'_, AppState>, id: String) -> std::result::Result<Vec<coa_core::repair::DatabaseCheck>, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||
blocking(move || coa_core::repair::check(&root, &meta_dir(&root)?)).await
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
async fn repair_server(app: AppHandle, state: State<'_, AppState>, id: String) -> std::result::Result<coa_core::repair::Report, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||
blocking(move || {
|
||||
let dir = meta_dir(&root)?;
|
||||
coa_core::repair::run(&root, &dir, &package_source(None), &update_source(None), coa_core::signing::EMBEDDED_PUBLIC_KEY, &|step,percent| {
|
||||
let _ = app.emit("repair-progress", serde_json::json!({ "id": id, "step": step, "percent": percent }));
|
||||
})
|
||||
}).await
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
async fn module_set_enabled(state: State<'_, AppState>, id: String, module: String, enabled: bool) -> std::result::Result<(), UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
@@ -654,7 +697,7 @@ async fn check_update(state: State<'_, AppState>, id: String, source: Option<Str
|
||||
#[tauri::command]
|
||||
fn pending_update(state: State<'_, AppState>, id: String) -> std::result::Result<Option<update::Txn>, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
Ok(update::unfinished(&meta_dir(&root)?))
|
||||
Ok(update::pending_checked(&meta_dir(&root)?)?)
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
@@ -672,7 +715,7 @@ async fn apply_update(
|
||||
let (dir, _) = install_meta(&root)?;
|
||||
// Files cannot be replaced while the server runs: stop it first (gracefully), like the Stop button.
|
||||
let observed = coa_core::process::observe(&root, &layout::read_ports(&root));
|
||||
if observed.world.state != coa_core::process::ServiceState::Stopped || observed.auth.state != coa_core::process::ServiceState::Stopped {
|
||||
if observed.world.state != coa_core::process::ServiceState::Stopped || observed.auth.state != coa_core::process::ServiceState::Stopped || coa_core::multiworld::is_running(&root) {
|
||||
let out = driver::run(&root, Verb::StopAll)?;
|
||||
if !out.ok {
|
||||
return Err(Error::Invalid("The server could not be stopped, so the update was not started.".into()));
|
||||
@@ -701,6 +744,19 @@ async fn rollback_update(state: State<'_, AppState>, id: String, txn: String) ->
|
||||
.await
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
async fn retry_update_validation(state: State<'_, AppState>, id: String, txn: String) -> std::result::Result<update::Txn, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||
blocking(move || {
|
||||
let dir = meta_dir(&root)?;
|
||||
let pending = update::load(&dir, &txn)?;
|
||||
let source = coa_core::pkgsource::Source::Url(format!("https://github.com/Corfirean/coa-server-build/releases/download/server-{}/", pending.to_version));
|
||||
let env = update::RepackEnv { root: &root, meta_dir: &dir };
|
||||
update::retry_validation(&root, &dir, &txn, &source, coa_core::signing::EMBEDDED_PUBLIC_KEY, &env)
|
||||
}).await
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
async fn get_population(state: State<'_, AppState>, id: String) -> std::result::Result<Option<coa_core::population::Population>, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
@@ -886,6 +942,68 @@ async fn add_companions(state: State<'_, AppState>, id: String, count: u32) -> s
|
||||
.await
|
||||
}
|
||||
|
||||
const REMOTE_CLIENT_ID: &str = "@remote-client";
|
||||
|
||||
fn remote_dir() -> PathBuf { data_dir().join("remote-client") }
|
||||
|
||||
#[tauri::command]
|
||||
fn remote_connection() -> std::result::Result<coa_core::remote_client::Profile, UiError> {
|
||||
Ok(coa_core::remote_client::load(&remote_dir())?)
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
fn remote_connect(state: State<'_, AppState>, host: String) -> std::result::Result<coa_core::remote_client::Profile, UiError> {
|
||||
let job = state.client_cancel.lock().unwrap();
|
||||
if job.is_some() { return Err(Error::Invalid("Wait for the client operation to finish.".into()).into()); }
|
||||
let dir = remote_dir();
|
||||
let mut profile = coa_core::remote_client::load(&dir)?;
|
||||
let host = host.trim();
|
||||
if host.is_empty() { return Err(Error::Invalid("Enter the host's IP address or hostname.".into()).into()); }
|
||||
profile.host = host.into();
|
||||
coa_core::remote_client::save(&dir, &profile)?;
|
||||
Ok(profile)
|
||||
}
|
||||
|
||||
struct ClientContext {
|
||||
dir: PathBuf,
|
||||
path: Option<PathBuf>,
|
||||
source: Option<PathBuf>,
|
||||
host: String,
|
||||
root: Option<PathBuf>,
|
||||
}
|
||||
|
||||
fn client_context(state: &AppState, id: &str) -> Result<ClientContext> {
|
||||
if id == REMOTE_CLIENT_ID {
|
||||
let dir = remote_dir();
|
||||
let profile = coa_core::remote_client::load(&dir)?;
|
||||
return Ok(ClientContext { dir, path: profile.client_path.map(PathBuf::from), source: None, host: profile.host, root: None });
|
||||
}
|
||||
let root = path_of(state, id)?;
|
||||
let (dir, meta) = install_meta(&root)?;
|
||||
let source = coa_core::client::addon_source(&root);
|
||||
Ok(ClientContext { dir, path: meta.client_path.map(PathBuf::from), source, host: "127.0.0.1".into(), root: Some(root) })
|
||||
}
|
||||
|
||||
impl ClientContext {
|
||||
fn linked(&self) -> Option<PathBuf> {
|
||||
self.path.clone().filter(|p| coa_core::client::detect(p, None).is_some())
|
||||
}
|
||||
fn require(&self) -> Result<PathBuf> {
|
||||
self.linked().ok_or_else(|| Error::Invalid("Set up a game client first.".into()))
|
||||
}
|
||||
fn link(&self, path: &str) -> Result<()> {
|
||||
if let Some(root) = &self.root {
|
||||
let (_, mut meta) = install_meta(root)?;
|
||||
meta.client_path = Some(path.into());
|
||||
coa_core::fsx::atomic_write_json(&self.dir.join("install.json"), &meta)
|
||||
} else {
|
||||
let mut profile = coa_core::remote_client::load(&self.dir)?;
|
||||
profile.client_path = Some(path.into());
|
||||
coa_core::remote_client::save(&self.dir, &profile)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn client_of(root: &std::path::Path) -> Result<(PathBuf, InstallMeta, Option<PathBuf>)> {
|
||||
let (dir, meta) = install_meta(root)?;
|
||||
let client = meta.client_path.clone().map(PathBuf::from).ok_or_else(|| Error::Invalid("No game client is set up for this server yet.".into()))?;
|
||||
@@ -894,22 +1012,19 @@ fn client_of(root: &std::path::Path) -> Result<(PathBuf, InstallMeta, Option<Pat
|
||||
|
||||
#[tauri::command]
|
||||
fn client_info(state: State<'_, AppState>, id: String) -> std::result::Result<Option<coa_core::client::ClientInfo>, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let (_, meta) = install_meta(&root)?;
|
||||
let source = coa_core::client::addon_source(&root);
|
||||
Ok(meta.client_path.and_then(|p| coa_core::client::detect(std::path::Path::new(&p), source.as_deref())))
|
||||
let ctx = client_context(&state, &id)?;
|
||||
Ok(ctx.path.and_then(|p| coa_core::client::detect(&p, ctx.source.as_deref())))
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
fn set_client(state: State<'_, AppState>, id: String, path: String) -> std::result::Result<coa_core::client::ClientInfo, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let (dir, mut meta) = install_meta(&root)?;
|
||||
let source = coa_core::client::addon_source(&root);
|
||||
let info = coa_core::client::detect(std::path::Path::new(&path), source.as_deref())
|
||||
let job = state.client_cancel.lock().unwrap();
|
||||
if job.is_some() { return Err(Error::Invalid("Wait for the client operation to finish.".into()).into()); }
|
||||
let ctx = client_context(&state, &id)?;
|
||||
let info = coa_core::client::detect(std::path::Path::new(&path), ctx.source.as_deref())
|
||||
.ok_or_else(|| Error::Invalid("This folder does not look like a game client (it needs Data and the game executable).".into()))?;
|
||||
meta.client_path = Some(info.path.clone());
|
||||
coa_core::fsx::atomic_write_json(&dir.join("install.json"), &meta).map_err(UiError::from)?;
|
||||
Ok(info)
|
||||
ctx.link(&info.path)?;
|
||||
Ok(coa_core::client::detect(std::path::Path::new(&info.path), ctx.source.as_deref()).unwrap_or(info))
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
@@ -948,9 +1063,9 @@ fn linked_client(root: &std::path::Path) -> Result<Option<PathBuf>> {
|
||||
/// Cheap: one small manifest request and the local state file; no game file is read.
|
||||
#[tauri::command]
|
||||
async fn client_status(state: State<'_, AppState>, id: String) -> std::result::Result<ClientStatus, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let ctx = client_context(&state, &id)?;
|
||||
blocking(move || {
|
||||
let client = linked_client(&root)?;
|
||||
let client = ctx.linked();
|
||||
let latest = coa_core::clientdl::fetch_latest().ok();
|
||||
let local = client.as_deref().map(coa_core::clientdl::local);
|
||||
let managed = local.as_ref().map(|l| l.managed).unwrap_or(false);
|
||||
@@ -997,10 +1112,10 @@ async fn client_download_check(parent: String) -> std::result::Result<ClientDown
|
||||
/// Compare the linked client with the published one. Hashes files only where the recorded state cannot vouch for them.
|
||||
#[tauri::command]
|
||||
async fn client_plan(app: AppHandle, state: State<'_, AppState>, id: String) -> std::result::Result<coa_core::clientdl::Plan, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let ctx = client_context(&state, &id)?;
|
||||
let cancel = begin_client_job(&state)?;
|
||||
let result = blocking(move || {
|
||||
let client = linked_client(&root)?.ok_or_else(|| Error::Invalid("No game client is set up for this server yet.".into()))?;
|
||||
let client = ctx.require()?;
|
||||
let manifest = coa_core::clientdl::fetch_latest()?;
|
||||
let current = coa_core::clientdl::load_state(&client).unwrap_or_default();
|
||||
coa_core::clientdl::plan(&client, &manifest, ¤t, &cancel, &|s| {
|
||||
@@ -1015,11 +1130,13 @@ async fn client_plan(app: AppHandle, state: State<'_, AppState>, id: String) ->
|
||||
/// Bring the linked client to the published version. `keep_modified` leaves files the player changed alone.
|
||||
#[tauri::command]
|
||||
async fn client_sync(app: AppHandle, state: State<'_, AppState>, id: String, keep_modified: bool) -> std::result::Result<(), UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let ctx = client_context(&state, &id)?;
|
||||
let cancel = begin_client_job(&state)?;
|
||||
let result = blocking(move || {
|
||||
let client = linked_client(&root)?.ok_or_else(|| Error::Invalid("No game client is set up for this server yet.".into()))?;
|
||||
run_client_sync(&app, &client, keep_modified, &cancel)
|
||||
let client = ctx.require()?;
|
||||
run_client_sync(&app, &client, keep_modified, &cancel)?;
|
||||
if ctx.root.is_none() && !ctx.host.is_empty() { coa_core::client::set_realmlist(&client, &ctx.dir, &ctx.host)?; }
|
||||
Ok(())
|
||||
})
|
||||
.await;
|
||||
end_client_job(&state);
|
||||
@@ -1043,13 +1160,12 @@ fn run_client_sync(app: &AppHandle, client: &std::path::Path, keep_modified: boo
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Download the whole client into `<parent>/CoA Client`, then link it to this server.
|
||||
/// Download the client into `<parent>/CoA Client`, then link it to a host or player profile.
|
||||
#[tauri::command]
|
||||
async fn client_download(app: AppHandle, state: State<'_, AppState>, id: String, parent: String) -> std::result::Result<coa_core::client::ClientInfo, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let ctx = client_context(&state, &id)?;
|
||||
let cancel = begin_client_job(&state)?;
|
||||
let result = blocking(move || {
|
||||
let (dir, mut meta) = install_meta(&root)?;
|
||||
let parent = PathBuf::from(&parent);
|
||||
if !parent.is_dir() {
|
||||
return Err(Error::Invalid("Choose an existing folder to put the game client in.".into()));
|
||||
@@ -1062,16 +1178,11 @@ async fn client_download(app: AppHandle, state: State<'_, AppState>, id: String,
|
||||
}
|
||||
std::fs::create_dir_all(&dest)?;
|
||||
run_client_sync(&app, &dest, false, &cancel)?;
|
||||
let source = coa_core::client::addon_source(&root);
|
||||
let info = coa_core::client::detect(&dest, source.as_deref()).ok_or_else(|| Error::Invalid("The downloaded client looks incomplete.".into()))?;
|
||||
meta.client_path = Some(info.path.clone());
|
||||
coa_core::fsx::atomic_write_json(&dir.join("install.json"), &meta)?;
|
||||
// a fresh client has no realmlist; this server is on this computer
|
||||
coa_core::client::set_realmlist(&dest, &dir, "127.0.0.1")?;
|
||||
if let Some(src) = source {
|
||||
coa_core::client::install_addon(&dest, &dir, &src)?;
|
||||
}
|
||||
Ok(coa_core::client::detect(&dest, coa_core::client::addon_source(&root).as_deref()).unwrap_or(info))
|
||||
let info = coa_core::client::detect(&dest, ctx.source.as_deref()).ok_or_else(|| Error::Invalid("The downloaded client looks incomplete.".into()))?;
|
||||
ctx.link(&info.path)?;
|
||||
if !ctx.host.is_empty() { coa_core::client::set_realmlist(&dest, &ctx.dir, &ctx.host)?; }
|
||||
if let Some(src) = &ctx.source { coa_core::client::install_addon(&dest, &ctx.dir, src)?; }
|
||||
Ok(coa_core::client::detect(&dest, ctx.source.as_deref()).unwrap_or(info))
|
||||
})
|
||||
.await;
|
||||
end_client_job(&state);
|
||||
@@ -1103,23 +1214,31 @@ fn end_client_job(state: &AppState) {
|
||||
}
|
||||
}
|
||||
|
||||
/// Start the server if needed, wait until it is ready, then launch the game client.
|
||||
/// Launch the game client independently of the local server.
|
||||
#[tauri::command]
|
||||
async fn play(state: State<'_, AppState>, id: String) -> std::result::Result<DriverOutcome, UiError> {
|
||||
if id == REMOTE_CLIENT_ID {
|
||||
let ctx = client_context(&state, &id)?;
|
||||
let client = ctx.require()?;
|
||||
return blocking(move || {
|
||||
if ctx.host.is_empty() { return Err(Error::Invalid("Enter the host's IP address or hostname first.".into())); }
|
||||
if coa_core::client::is_running(&client) { return Err(Error::Invalid("The game is already running.".into())); }
|
||||
coa_core::client::set_realmlist(&client, &ctx.dir, &ctx.host)?;
|
||||
coa_core::client::launch(&client)?;
|
||||
Ok(DriverOutcome { ok: true, exit_code: None, code: None, human: None, output: String::new() })
|
||||
}).await;
|
||||
}
|
||||
let root = path_of(&state, &id)?;
|
||||
let (_, _, client) = client_of(&root)?;
|
||||
let (dir, _, client) = client_of(&root)?;
|
||||
let client = client.unwrap();
|
||||
let ready = {
|
||||
let o = coa_core::process::observe(&root, &layout::read_ports(&root));
|
||||
[&o.mysql, &o.auth, &o.world].iter().all(|s| s.state == coa_core::process::ServiceState::Running)
|
||||
};
|
||||
if !ready {
|
||||
let out = run_verb(&state, id, Verb::StartAll).await?;
|
||||
if !out.ok {
|
||||
return Ok(out);
|
||||
}
|
||||
if coa_core::client::is_running(&client) {
|
||||
return Err(Error::Invalid("Close the game client before pressing Play so its selected realm can be updated.".into()).into());
|
||||
}
|
||||
blocking(move || {
|
||||
let mode = coa_core::realms::state(&root)?.active;
|
||||
if !coa_core::client::sync_realm(&client, &dir, mode)? {
|
||||
return Err(Error::Invalid("Close the game client before pressing Play so its selected realm can be updated.".into()));
|
||||
}
|
||||
coa_core::client::launch(&client)?;
|
||||
Ok(DriverOutcome { ok: true, exit_code: None, code: None, human: None, output: String::new() })
|
||||
})
|
||||
@@ -1138,6 +1257,7 @@ struct FriendsStatus {
|
||||
server_running: bool,
|
||||
auth_port: u16,
|
||||
world_port: u16,
|
||||
secondary_world_port: Option<u16>,
|
||||
}
|
||||
|
||||
/// Open one of a few known help pages in the default browser. Anything else is refused, so a page can never ask the
|
||||
@@ -1155,8 +1275,7 @@ fn open_link(url: String) -> std::result::Result<(), UiError> {
|
||||
if !(issue || catalog || ALLOWED.iter().any(|p| url.starts_with(p))) || !chars_ok || url.len() > 12_000 {
|
||||
return Err(Error::Invalid("That link is not allowed.".into()).into());
|
||||
}
|
||||
// explorer.exe opens the address in the default browser without going through a shell.
|
||||
std::process::Command::new("explorer.exe").arg(&url).spawn().map_err(|e| Error::Invalid(e.to_string()))?;
|
||||
tauri_plugin_opener::open_url(&url, None::<&str>).map_err(|e| Error::Invalid(e.to_string()))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@@ -1219,6 +1338,7 @@ async fn friends_status(state: State<'_, AppState>, id: String) -> std::result::
|
||||
server_running: coa_core::process::observe(&root, &ports).world.state == coa_core::process::ServiceState::Running,
|
||||
auth_port: ports.auth,
|
||||
world_port: ports.world,
|
||||
secondary_world_port: coa_core::realms::state(&root)?.secondary_world_port.filter(|_| coa_core::realms::state(&root).is_ok_and(|s| s.simultaneous)),
|
||||
})
|
||||
})
|
||||
.await
|
||||
@@ -1272,6 +1392,8 @@ async fn friends_enable(
|
||||
let meta = meta_dir(&root)?;
|
||||
let ports = layout::read_ports(&root);
|
||||
let mut note = None;
|
||||
let realms = coa_core::realms::state(&root)?;
|
||||
let secondary = realms.secondary_world_port.filter(|_| realms.simultaneous);
|
||||
let host = match mode {
|
||||
Mode::Local => "127.0.0.1".to_string(),
|
||||
Mode::Lan => coa_core::net::lan_ip().ok_or_else(|| Error::Invalid("This computer has no network address.".into()))?.to_string(),
|
||||
@@ -1281,7 +1403,7 @@ async fn friends_enable(
|
||||
let open = mode != Mode::Local;
|
||||
let changed = friends::set_open(&root, &meta, open)?;
|
||||
if open {
|
||||
coa_core::firewall::ensure_rules(&ports)?;
|
||||
coa_core::firewall::ensure_rules_with_secondary(&ports, secondary)?;
|
||||
}
|
||||
if mode == Mode::Direct && use_upnp {
|
||||
match coa_core::upnp::discover() {
|
||||
@@ -1289,6 +1411,7 @@ async fn friends_enable(
|
||||
let lan = coa_core::net::lan_ip().ok_or_else(|| Error::Invalid("No local address.".into()))?;
|
||||
coa_core::upnp::add_mapping(&gw, ports.auth, lan, "Auth")?;
|
||||
coa_core::upnp::add_mapping(&gw, ports.world, lan, "World")?;
|
||||
if let Some(port) = secondary { coa_core::upnp::add_mapping(&gw, port, lan, "Second world")?; }
|
||||
note = Some("Your router was asked to forward the game ports.".to_string());
|
||||
}
|
||||
None => note = Some("Your router does not support automatic setup; forward the two game ports by hand or use the private network.".to_string()),
|
||||
@@ -1429,6 +1552,9 @@ pub fn run() {
|
||||
modules_list,
|
||||
realm_profiles,
|
||||
realm_select,
|
||||
realm_simultaneous,
|
||||
check_database,
|
||||
repair_server,
|
||||
module_set_enabled,
|
||||
module_settings,
|
||||
module_save_settings,
|
||||
@@ -1445,6 +1571,7 @@ pub fn run() {
|
||||
pending_update,
|
||||
apply_update,
|
||||
rollback_update,
|
||||
retry_update_validation,
|
||||
get_population,
|
||||
get_performance,
|
||||
companions_stop_spawning,
|
||||
@@ -1454,6 +1581,8 @@ pub fn run() {
|
||||
open_link,
|
||||
companion_sizes,
|
||||
add_companions,
|
||||
remote_connection,
|
||||
remote_connect,
|
||||
client_info,
|
||||
set_client,
|
||||
client_realmlist,
|
||||
@@ -1479,3 +1608,30 @@ pub fn run() {
|
||||
.run(tauri::generate_context!())
|
||||
.expect("error while running CoA Server Manager");
|
||||
}
|
||||
|
||||
#[cfg(all(test, not(windows)))]
|
||||
mod tests {
|
||||
use super::unix_data_home;
|
||||
use std::ffi::OsString;
|
||||
use std::path::PathBuf;
|
||||
|
||||
fn os(s: &str) -> Option<OsString> {
|
||||
Some(s.into())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn data_home_prefers_an_absolute_xdg_folder() {
|
||||
assert_eq!(unix_data_home(os("/data/xdg"), os("/home/u")), PathBuf::from("/data/xdg"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn data_home_ignores_a_relative_xdg_folder_and_falls_back_to_home() {
|
||||
assert_eq!(unix_data_home(os("relative/dir"), os("/home/u")), PathBuf::from("/home/u/.local/share"));
|
||||
assert_eq!(unix_data_home(None, os("/home/u")), PathBuf::from("/home/u/.local/share"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn data_home_without_any_variable_uses_the_temp_folder() {
|
||||
assert_eq!(unix_data_home(None, None), std::env::temp_dir());
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,11 @@
|
||||
#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
|
||||
|
||||
fn main() {
|
||||
// WebKitGTK's DMA-BUF renderer ends the process with a Wayland "Protocol error" on some graphics stacks (seen with
|
||||
// an NVIDIA card on Wayland). The path without it works everywhere; a value set by the user is left alone.
|
||||
#[cfg(target_os = "linux")]
|
||||
if std::env::var_os("WEBKIT_DISABLE_DMABUF_RENDERER").is_none() {
|
||||
std::env::set_var("WEBKIT_DISABLE_DMABUF_RENDERER", "1");
|
||||
}
|
||||
coa_server_manager_lib::run()
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"$schema": "https://schema.tauri.app/config/2",
|
||||
"productName": "CoA Server Manager",
|
||||
"version": "0.5.0",
|
||||
"version": "0.6.5",
|
||||
"identifier": "com.coa.servermanager",
|
||||
"build": {
|
||||
"beforeDevCommand": "npm run dev",
|
||||
|
||||
+17
-2
@@ -4,14 +4,20 @@ import { Welcome } from "@/screens/Welcome";
|
||||
import { ImportServer } from "@/screens/ImportServer";
|
||||
import { Shell } from "@/screens/Shell";
|
||||
import { InstallServer } from "@/screens/InstallServer";
|
||||
import { RemoteClient } from "@/screens/RemoteClient";
|
||||
import { UpdateBanner } from "@/components/UpdateBanner";
|
||||
import { autoUpdateEnabled, installOnClose, lookForUpdate } from "@/lib/selfUpdate";
|
||||
|
||||
type View = "welcome" | "add" | "import" | "install";
|
||||
type View = "welcome" | "add" | "import" | "install" | "remote";
|
||||
|
||||
function initialView(): View {
|
||||
try { return localStorage.getItem("coa-play-mode") === "remote" ? "remote" : "welcome"; }
|
||||
catch { return "welcome"; }
|
||||
}
|
||||
|
||||
function Main() {
|
||||
const [servers, setServers] = useState<ServerSummary[] | null>(null);
|
||||
const [view, setView] = useState<View>("welcome");
|
||||
const [view, setView] = useState<View>(initialView);
|
||||
const [activeId, setActiveId] = useState<string | null>(null);
|
||||
|
||||
const refresh = useCallback(async () => {
|
||||
@@ -26,6 +32,11 @@ function Main() {
|
||||
|
||||
if (servers === null) return null;
|
||||
|
||||
if (view === "remote") return <RemoteClient onHost={() => {
|
||||
try { localStorage.setItem("coa-play-mode", "host"); } catch { /* storage unavailable */ }
|
||||
setView(servers.length ? "welcome" : "add");
|
||||
}} />;
|
||||
|
||||
if (servers.length > 0 && view === "welcome" && activeId) {
|
||||
return (
|
||||
<Shell
|
||||
@@ -71,6 +82,10 @@ function Main() {
|
||||
|
||||
return (
|
||||
<Welcome
|
||||
onConnect={() => {
|
||||
try { localStorage.setItem("coa-play-mode", "remote"); } catch { /* storage unavailable */ }
|
||||
setView("remote");
|
||||
}}
|
||||
onImport={() => setView("import")}
|
||||
onInstall={() => setView("install")}
|
||||
onBack={servers.length > 0 ? () => setView("welcome") : undefined}
|
||||
|
||||
+23
-11
@@ -1,4 +1,5 @@
|
||||
// Dev-only: lets the UI run in a plain browser for visual review. Never bundled in production builds.
|
||||
import { auctionCategories, auctionQualities } from "../lib/moduleSettings";
|
||||
import botsSchema from "../../schemas/bots.json";
|
||||
import serverSchema from "../../schemas/server.json";
|
||||
import botsPresets from "../../schemas/presets/bots.json";
|
||||
@@ -8,6 +9,9 @@ export {};
|
||||
(() => {
|
||||
let added = new URLSearchParams(location.search).has("demo"), running = false;
|
||||
let realm: "coa" | "wildcard" = "coa", wildcardCreated = false;
|
||||
let simultaneous = false;
|
||||
let remoteHost = localStorage.getItem("demo-remote-host") ?? "";
|
||||
const moduleEdits: Record<string, Record<string, string>> = {};
|
||||
const modState: Record<string, boolean> = { "companions": true, "content-scaling": true, "client-compat": true, "tbc-content": true, "wotlk-content": true, "npc-enchanter": true };
|
||||
const report = {path:"C:\\games\\CoA-Repack",classification:"healthy",items:[
|
||||
{key:"worldserver",label:"World server",status:"found",detail:null},
|
||||
@@ -22,12 +26,18 @@ export {};
|
||||
(window as any).__TAURI_INTERNALS__ = {
|
||||
transformCallback: (cb: unknown)=>cb, unregisterCallback(){}, convertFileSrc:(x: unknown)=>x,
|
||||
invoke: async (cmd: string, args?: any)=>{
|
||||
if(cmd==="realm_profiles") return {active:realm,wildcard_created:wildcardCreated,supported:true,recovery_pending:false};
|
||||
if(cmd==="realm_select"){await new Promise(r=>setTimeout(r,600));realm=args.mode;wildcardCreated ||= realm==="wildcard";modState.companions=realm==="coa";return {active:realm,wildcard_created:wildcardCreated,supported:true,recovery_pending:false};}
|
||||
if(cmd==="realm_profiles") return {active:realm,wildcard_created:wildcardCreated,supported:true,recovery_pending:false,simultaneous,secondary_world_port:simultaneous?8086:null,secondary_running:simultaneous&&running};
|
||||
if(cmd==="realm_simultaneous") { if(running) throw new Error("Stop both realms before changing simultaneous startup."); simultaneous=args.enabled; wildcardCreated ||= simultaneous; return {active:realm,wildcard_created:wildcardCreated,supported:true,recovery_pending:false,simultaneous,secondary_world_port:simultaneous?8086:null,secondary_running:false}; }
|
||||
if(cmd==="check_database") return [{realm, migrations:[],problems:[],full_schema:false}];
|
||||
if(cmd==="repair_server") { if(running) throw new Error("Stop the server before repairing it."); return {restored:[],applied:[],backup:"demo-before-repair",database:[{realm,migrations:[],problems:[],full_schema:false}],error:null}; }
|
||||
if(cmd==="realm_select"){await new Promise(r=>setTimeout(r,600));realm=args.mode;wildcardCreated ||= realm==="wildcard";modState.companions=realm==="coa";return {active:realm,wildcard_created:wildcardCreated,supported:true,recovery_pending:false,simultaneous,secondary_world_port:simultaneous?8086:null,secondary_running:simultaneous&&running};}
|
||||
if(cmd==="remote_connection") return {host:remoteHost,client_path:null};
|
||||
if(cmd==="remote_connect") { remoteHost=args.host.trim(); localStorage.setItem("demo-remote-host",remoteHost); return {host:remoteHost,client_path:null}; }
|
||||
if(cmd==="play") return {ok:true,exit_code:null,code:null,human:null,output:""};
|
||||
if(cmd==="list_servers") return added?[{id:"1",name:"CoA-Repack",path:report.path}]:[];
|
||||
if(cmd==="scan_server") return report;
|
||||
if(cmd==="add_server"){added=true;return {id:"1",name:"CoA-Repack",path:report.path};}
|
||||
if(cmd==="server_status"){const s=running?"running":"stopped";return {observed:{mysql:svc("mysql",3307,s),auth:svc("auth",3724,s),world:svc("world",8085,s)},busy:false,path_exists:true};}
|
||||
if(cmd==="server_status"){const s=running?"running":"stopped";return {observed:{mysql:svc("mysql",3307,s),auth:svc("auth",3724,s),world:svc("world",8085,s),secondary_world:simultaneous?svc("world-secondary",8086,s):null},busy:false,path_exists:true};}
|
||||
if(cmd==="start_server"){await new Promise((r: any)=>setTimeout(r,1500));running=true;return {ok:true,exit_code:0,code:null,human:null,output:""};}
|
||||
if(cmd==="stop_server"){await new Promise((r: any)=>setTimeout(r,1500));running=false;return {ok:true,exit_code:0,code:null,human:null,output:""};}
|
||||
if(cmd.startsWith("plugin:dialog")) return "C:\\games\\CoA-Repack";
|
||||
@@ -36,7 +46,7 @@ export {};
|
||||
if(cmd==="preview_preset"){const a=args;const sc=a.scope==="server"?serverSchema:botsSchema;const pr=(a.scope==="server"?serverPresets:botsPresets).presets as any[];const p=pr.find(x=>x.id===a.preset)??{id:a.preset??"defaults",title:"Recommended defaults",description:"Every setting returns to its default value."};const st=(sc.settings as any[]).filter(x=>x.type==="int"||x.type==="float"||x.type==="enum").slice(0,3);return {id:p.id,title:p.title,description:p.description,changes:st.map(x=>({key:x.key,title:x.title,from:x.default,to:x.type==="enum"?(x.options?.[1]?.value??x.default):(Number(x.default)||1)*2,dangerous:false}))};}
|
||||
if(cmd==="companion_sizes") return {hardware:{cores:16,ram_gb:31,free_ram_gb:12},sizes:[{id:"small",title:"Small",bots:50,warning:null},{id:"medium",title:"Medium",bots:250,warning:null},{id:"large",title:"Large",bots:500,warning:"500 companions may need more CPU and memory than this computer has (8 cores, 16 GB)."}]};
|
||||
if(cmd==="add_companions"){const base=(window as any).__bots??85;(window as any).__target=base+args.count;return {spawned:"queued",created:null,baseline:base};}
|
||||
if(cmd==="check_update") return {from_version:(window as any).__updated?"0.261001.8":"0.260930.5",to_version:"0.261001.8",items:[],conflicts:[],migrations:5,download_bytes:6000000};
|
||||
if(cmd==="check_update") return {from_version:(window as any).__updated?"0.261001.8":"0.260930.5",to_version:"0.261001.8",items:[],conflicts:[],migrations:5,pending_migrations:(window as any).__updated?0:5,download_bytes:6000000};
|
||||
if(cmd==="apply_update"){const w=window as any;for(let i=1;i<=8;i++){await new Promise((r: any)=>setTimeout(r,700));(w.__handlers?.["update-progress"]??[]).forEach((h: any)=>h({event:"update-progress",id:1,payload:{step:i<4?"Downloading the update":i<7?"Applying the update":"Finishing",percent:i*12}}));}(window as any).__updated=true;return {txn:{state:"committed",to_version:"0.261001.8"},migrations:null};}
|
||||
if(cmd==="get_population"){if(!running) return null;let b=(window as any).__bots??85;const t=(window as any).__target??0;if(t>b){b=Math.min(t,b+25);(window as any).__bots=b;}return {online_total:b,bots_online:Math.max(0,b-7),players_online:0,bots_total:b};}
|
||||
if(cmd==="get_performance") return running?{mean_ms:14,median_ms:15,p95_ms:24,p99_ms:30,max_ms:61,ticks_per_sec:71.4}:null;
|
||||
@@ -59,22 +69,24 @@ export {};
|
||||
if(cmd==="realmlist_save"){const w=window as any;const rl=w.__rl;if(args.profileId){const p=rl.profiles.find((x: any)=>x.id===args.profileId);p.name=args.name;p.data=args.data;return p;}if(rl.profiles.some((x: any)=>x.name.toLowerCase()===String(args.name).toLowerCase()))throw {human:{code:"unknown",title:"",message:"",actions:[]},technical:"A realmlist with that name already exists."};const p={id:String(args.name).toLowerCase().replace(/[^a-z0-9]+/g,"-"),name:args.name,data:(/\s/.test(args.data.trim())?args.data.trim():"set realmlist "+args.data.trim())+"\r\n"};rl.profiles.push(p);return p;}
|
||||
if(cmd==="realmlist_delete"){const rl=(window as any).__rl;rl.profiles=rl.profiles.filter((x: any)=>x.id!==args.profileId);return null;}
|
||||
if(cmd==="account_delete") return null;
|
||||
if(cmd==="modules_list") return [{id:"companions",name:"CoA Companions",description:{en:"Companion bots for groups, dungeons and your guild.",ru:"Боты-компаньоны для групп, подземелий и гильдии."},repo:"https://github.com/Corfirean/mod-coa-playerbots",installed:true,enabled:modState["companions"],switchable:true,status:"beta",icon:"bot",page:"bots"},{id:"content-scaling",name:"Content Scaling",description:{en:"Scales dungeons and raids to your group, with solo modes.",ru:"Подстраивает подземелья и рейды под вашу группу, есть соло-режимы."},repo:"https://github.com/Corfirean/mod-coa-content-scaling",installed:true,enabled:modState["content-scaling"],switchable:true,status:"early",icon:"scaling",page:null},{id:"tbc-content",name:"TBC Content",description:{en:"Outland dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Запределья, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-tbc-content",installed:true,enabled:modState["tbc-content"],switchable:true,status:"early",icon:"tbc",page:null},{id:"wotlk-content",name:"WotLK Content",description:{en:"Northrend dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Нордскола, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-wotlk-content",installed:true,enabled:modState["wotlk-content"],switchable:true,status:"early",icon:"wotlk",page:null},{id:"ah-bot",name:"Auction House Bot",description:{en:"Fills the auction house with realistic, adjustable listings.",ru:"Наполняет аукцион реалистичными настраиваемыми лотами."},repo:"https://github.com/NathanHandley/mod-ah-bot-plus",installed:false,enabled:false,switchable:false,status:"soon",icon:"gavel",page:null,hidden:false},{id:"npc-enchanter",name:"NPC Enchanter",description:{en:"An NPC that enchants your gear for you.",ru:"НПС, который зачаровывает ваше снаряжение."},repo:"https://github.com/azerothcore/mod-npc-enchanter",installed:true,enabled:modState["npc-enchanter"],switchable:true,status:"early",icon:"sparkles",page:null,hidden:false},{id:"playerbots",name:"SQUID's Playerbots",description:{en:"An alternative bot system with random bots and full AI.",ru:"Альтернативная система ботов со случайными ботами и полным ИИ."},repo:"https://github.com/Zyth45/mod-playerbots",installed:false,enabled:false,switchable:false,status:"soon",icon:"swords",page:null,hidden:false},{id:"client-compat",name:"Client compatibility",description:{en:"Client-server link and appearance unlocks.",ru:"Связь клиента с сервером и разблокировка внешних видов."},repo:"https://github.com/Corfirean/azerothcore-wotlk-coa",installed:true,enabled:modState["client-compat"],switchable:false,status:"release",icon:"plug",page:null,hidden:true}].map(m => ({...m, compatibility: realm === "wildcard" ? (["companions", "playerbots"].includes(m.id) ? "unsupported" : m.id === "client-compat" ? "compatible" : "experimental") : "compatible", switchable: realm === "wildcard" && ["companions", "playerbots"].includes(m.id) ? false : m.switchable}));
|
||||
if(cmd==="module_set_enabled"){ modState[args.module]=args.enabled; return null; }
|
||||
if(cmd==="modules_list") return [{id:"companions",name:"CoA Companions",description:{en:"Companion bots for groups, dungeons and your guild.",ru:"Боты-компаньоны для групп, подземелий и гильдии."},repo:"https://github.com/Corfirean/mod-coa-playerbots",installed:true,enabled:modState["companions"],switchable:true,status:"beta",icon:"bot",page:"bots"},{id:"content-scaling",name:"Content Scaling",description:{en:"Scales dungeons and raids to your group, with solo modes.",ru:"Подстраивает подземелья и рейды под вашу группу, есть соло-режимы."},repo:"https://github.com/Corfirean/mod-coa-content-scaling",installed:true,enabled:modState["content-scaling"],switchable:true,status:"early",icon:"scaling",page:null},{id:"tbc-content",name:"TBC Content",description:{en:"Outland dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Запределья, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-tbc-content",installed:true,enabled:modState["tbc-content"],switchable:true,status:"early",icon:"tbc",page:null},{id:"wotlk-content",name:"WotLK Content",description:{en:"Northrend dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Нордскола, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-wotlk-content",installed:true,enabled:modState["wotlk-content"],switchable:true,status:"early",icon:"wotlk",page:null},{id:"ah-bot",name:"Auction House Bot",description:{en:"Fills the auction house with realistic, adjustable listings.",ru:"Наполняет аукцион реалистичными настраиваемыми лотами."},repo:"https://github.com/Corfirean/azerothcore-wotlk-coa",installed:true,enabled:modState["ah-bot"] ?? false,switchable:true,status:"early",icon:"gavel",page:null,hidden:false},{id:"npc-enchanter",name:"NPC Enchanter",description:{en:"An NPC that enchants your gear for you.",ru:"НПС, который зачаровывает ваше снаряжение."},repo:"https://github.com/azerothcore/mod-npc-enchanter",installed:true,enabled:modState["npc-enchanter"],switchable:true,status:"early",icon:"sparkles",page:null,hidden:false},{id:"playerbots",name:"SQUID's Playerbots",description:{en:"An alternative bot system with random bots and full AI.",ru:"Альтернативная система ботов со случайными ботами и полным ИИ."},repo:"https://github.com/Zyth45/mod-playerbots",installed:true,enabled:modState["playerbots"] ?? false,switchable:true,status:"early",icon:"swords",page:"bots",hidden:false},{id:"client-compat",name:"Client compatibility",description:{en:"Client-server link and appearance unlocks.",ru:"Связь клиента с сервером и разблокировка внешних видов."},repo:"https://github.com/Corfirean/azerothcore-wotlk-coa",installed:true,enabled:modState["client-compat"],switchable:false,status:"release",icon:"plug",page:null,hidden:true}].map(m => ({...m, has_settings: !["tbc-content", "wotlk-content"].includes(m.id), compatibility: realm === "wildcard" ? (["companions", "playerbots"].includes(m.id) ? "unsupported" : m.id === "client-compat" ? "compatible" : "experimental") : "compatible", switchable: realm === "wildcard" && ["companions", "playerbots"].includes(m.id) ? false : m.switchable}));
|
||||
if(cmd==="module_set_enabled"){ if(args.enabled && ["companions","playerbots"].includes(args.module) && modState[args.module === "companions" ? "playerbots" : "companions"]) throw {human:{code:"bot_modules_conflict",title:"",message:"",actions:[]},technical:"Only one bot system may be enabled."}; modState[args.module]=args.enabled; return null; }
|
||||
if(cmd==="all_settings") return [{key:"Visibility.Distance.Continents",value:"100",default:"90",doc:"Description: Visibility distance on continents. Range: 45-250 Default: 90",changed:true},{key:"Death.SicknessLevel",value:"11",default:"11",doc:"Description: Character level up to which characters get resurrection sickness. Default: 11",changed:false},{key:"Rate.Drop.Item.Epic",value:"3",default:"1",doc:"Description: Drop rates for money and items based on quality. Default: 1",changed:true},{key:"Instance.ResetTimeHour",value:"4",default:"4",doc:"Description: Hour of the day when the global instance reset occurs. Range: 0-23 Default: 4 - (04:00 AM)",changed:false},{key:"PlayerLimit",value:"1000",default:"1000",doc:"Description: Maximum number of players in the world.",changed:false}];
|
||||
if(cmd==="all_settings_save") return Object.keys(args&&args.changes||{});
|
||||
if(cmd==="module_settings" && args.module==="client-compat") return [{key:"CoA.UnlockLocalAppearanceCatalog",value:"1",default:"1",doc:""},{key:"CoA.UnlockAllVanity",value:"1",default:"1",doc:""},{key:"CoA.AutoCollectAppearances",value:"0",default:"1",doc:""},{key:"CoA.LearnOwnedCompanions",value:"1",default:"1",doc:""},{key:"CoA.MaxRidingFromStart",value:"1",default:"1",doc:""}];
|
||||
if(cmd==="module_settings"){
|
||||
const S:Record<string,{key:string;value:string;default:string;doc:string}[]>={
|
||||
"npc-enchanter":[{key:"Enchanter.Enable",value:"1",default:"1",doc:"Enable the module."},{key:"Enchanter.Announce",value:"0",default:"0",doc:"Announce the module when the player logs in."},{key:"Enchanter.CostCopper",value:"0",default:"0",doc:"What one enchantment costs, in copper (10000 = 1 gold). 0 = free."},{key:"Enchanter.MessageTimer",value:"60000",default:"60000",doc:"How often the NPC emotes, in milliseconds."}],
|
||||
"companions":[{key:"CoaBots.Enable",value:"1",default:"1",doc:"Master switch of the companion bots."},{key:"CoaBots.MaxPerPlayer",value:"4",default:"4",doc:"How many bots one player can have at a time."}],
|
||||
"content-scaling":[{key:"CoAContentScaling.Enable",value:"1",default:"1",doc:"Scale dungeons and raids to the group."}],
|
||||
"playerbots":[{"key": "AiPlayerbot.RandomBotAutologin", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.MinRandomBots", "value": "500", "default": "500", "doc": ""}, {"key": "AiPlayerbot.MaxRandomBots", "value": "500", "default": "500", "doc": ""}, {"key": "AiPlayerbot.RandomBotAccountCount", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotMinLevel", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotMaxLevel", "value": "60", "default": "60", "doc": ""}, {"key": "AiPlayerbot.SyncLevelWithPlayers", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotInvitePlayer", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotJoinLfg", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotJoinBG", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotAutoJoinBG", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotTalk", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotEmote", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotSuggestDungeons", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaClassesOnly", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaSmartHeal", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaSmartTank", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaSpecRotations", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaInterruptCoordination", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.MaxAddedBots", "value": "40", "default": "40", "doc": ""}, {"key": "AiPlayerbot.BotAutologin", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.DisabledWithoutRealPlayer", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.AddClassCommand", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.KeepAltsInGroup", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.CoaRecruitSameFaction", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaLfgBots", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotXPRate", "value": "1.0", "default": "1.0", "doc": ""}, {"key": "AiPlayerbot.FollowDistance", "value": "1.5", "default": "1.5", "doc": ""}, {"key": "AiPlayerbot.Enabled", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotAccountPrefix", "value": "\"rndbot\"", "default": "\"rndbot\"", "doc": ""}, {"key": "AiPlayerbot.RandomBotUpdateInterval", "value": "20", "default": "20", "doc": ""}],
|
||||
"companions":[{key:"CoaBots.Enable",value:"1",default:"1",doc:"Master switch of the companion bots."},{key:"CoaBots.RandomSpawn.DefaultCount",value:"10",default:"10",doc:""}],
|
||||
"content-scaling":[{key:"CoAContentScaling.Enable",value:"1",default:"1",doc:"Scale dungeons and raids to the group."}, ...[{key:"CoAContentScaling.LFG.AllowPartialGroups",value:"1"},{key:"CoAContentScaling.World.Leech.Enable",value:"0"},{key:"CoAContentScaling.World.Leech.Percent",value:"5.0"},{key:"CoAContentScaling.Difficulty.DamageMultiplier",value:"1.0"},{key:"CoAContentScaling.SoloAssist.Mode",value:"1"},{key:"CoAContentScaling.GroupScaling.Enable",value:"1"},{key:"CoAContentScaling.LFG.DefaultMode",value:"CurrentParty"},{key:"CoAContentScaling.LFG.DefaultChallengeSize",value:"0"},{key:"CoAContentScaling.Debug",value:"0"}].map(s=>({...s,default:s.value,doc:""}))],
|
||||
"ah-bot":[...Object.keys(auctionCategories).flatMap(category => Object.keys(auctionQualities).map(quality => ({key:`AuctionHouseBot.ListProportion.Category${category}.Quality${quality}`,value:String(quality === "Normal" && !["Quest","Key","Generic","Reagent"].includes(category) ? 50 : quality === "Rare" && ["Armor","Weapon"].includes(category) ? 5 : 0),default:String(quality === "Normal" && !["Quest","Key","Generic","Reagent"].includes(category) ? 50 : quality === "Rare" && ["Armor","Weapon"].includes(category) ? 5 : 0),doc:""}))), {key:"AuctionHouseBot.Enable",value:"false",default:"false",doc:""}, ...[{key:"AuctionHouseBot.GUIDs",value:"0"},{key:"AuctionHouseBot.EnableSeller",value:"true"},{key:"AuctionHouseBot.CoA.ObtainableItemsOnly",value:"true"},{key:"AuctionHouseBot.ItemsPerCycle",value:"150"},{key:"AuctionHouseBot.MinutesBetweenSellCycle",value:"1"},{key:"AuctionHouseBot.Alliance.MinItems",value:"15000"},{key:"AuctionHouseBot.Alliance.MaxItems",value:"15000"}].map(s=>({...s,default:s.value,doc:""}))],
|
||||
"tbc-content":[{key:"CoATBC.Enable",value:"1",default:"1",doc:"Outland dungeons and raids."}],
|
||||
"wotlk-content":[{key:"CoAWotLK.Enable",value:"1",default:"1",doc:"Northrend dungeons and raids."}],
|
||||
};
|
||||
return S[args.module]??[];
|
||||
return (S[args.module]??[]).map(s => ({...s, value: moduleEdits[args.module]?.[s.key] ?? s.value}));
|
||||
}
|
||||
if(cmd==="module_save_settings") return Object.keys(args.changes);
|
||||
if(cmd==="module_save_settings") { moduleEdits[args.module] = {...moduleEdits[args.module], ...args.changes}; return Object.keys(args.changes); }
|
||||
if(cmd==="report_context") return {manager_version:"0.3.1",windows:"Windows 11 (build 26200)",install_kind:"new",server_version:"0.261001.10"};
|
||||
if(cmd==="open_link"){(window as any).__lastLink=args.url;return null;}
|
||||
if(cmd==="export_diagnostics") return "C:\\Users\\you\\Desktop\\CoA-Diagnostics-20261001-140000.zip";
|
||||
@@ -84,7 +96,7 @@ export {};
|
||||
if(cmd==="account_set_access"){const a=(window as any).__acc.find((x: any)=>x.name===args.name);if(a)a.access=args.level;return null;}
|
||||
if(cmd==="account_set_password") return null;
|
||||
if(cmd==="account_rename"){const a=(window as any).__acc.find((x: any)=>x.name===args.name);if(a)a.name=String(args.newName).toUpperCase();return null;}
|
||||
if(cmd==="client_info"){const c=(window as any).__client??"none";return c==="none"?null:{path:"C:\\games\\CoA Client",executable:"Ascension.exe",realmlists:[{path:"x",host:"127.0.0.1"}],addon:{installed:true,version:"1",up_to_date:true},other_addons:2};}
|
||||
if(cmd==="client_info"){const c=(window as any).__client??"none";return c==="none"?null:{path:"C:\\games\\CoA Client",executable:"Ascension.exe",realmlists:[{path:"x",host:args.id==="@remote-client"?remoteHost:"127.0.0.1"}],addon:{installed:true,version:"1",up_to_date:true},other_addons:2};}
|
||||
if(cmd==="set_client"){(window as any).__client="foreign";return {path:args.path,executable:"Ascension.exe",realmlists:[],addon:{installed:false,version:null,up_to_date:null},other_addons:0};}
|
||||
if(cmd==="plugin:event|listen"){const w=window as any;(w.__handlers??={})[args.event]=[...(w.__handlers[args.event]??[]),args.handler];return 1;}
|
||||
if(cmd==="plugin:event|unlisten") return null;
|
||||
|
||||
+6
-3
@@ -4,12 +4,14 @@ import ru from "./locales/ru";
|
||||
import de from "./locales/de";
|
||||
import fr from "./locales/fr";
|
||||
import es from "./locales/es";
|
||||
import zh from "./locales/zh";
|
||||
import ruSchema from "./schema/ru.json";
|
||||
import deSchema from "./schema/de.json";
|
||||
import frSchema from "./schema/fr.json";
|
||||
import esSchema from "./schema/es.json";
|
||||
import zhSchema from "./schema/zh.json";
|
||||
|
||||
export type Locale = "en" | "ru" | "de" | "fr" | "es";
|
||||
export type Locale = "en" | "ru" | "de" | "fr" | "es" | "zh";
|
||||
export type Key = keyof typeof en;
|
||||
type Vars = Record<string, string | number>;
|
||||
|
||||
@@ -19,9 +21,10 @@ export const LOCALES: { id: Locale; name: string }[] = [
|
||||
{ id: "de", name: "Deutsch" },
|
||||
{ id: "fr", name: "Français" },
|
||||
{ id: "es", name: "Español" },
|
||||
{ id: "zh", name: "简体中文" },
|
||||
];
|
||||
|
||||
const DICTS: Record<Locale, Partial<Record<Key, string>>> = { en, ru, de, fr, es };
|
||||
const DICTS: Record<Locale, Partial<Record<Key, string>>> = { en, ru, de, fr, es, zh };
|
||||
const STORAGE_KEY = "coa-locale";
|
||||
|
||||
function initialLocale(): Locale {
|
||||
@@ -95,7 +98,7 @@ interface SchemaOverlay {
|
||||
options: Record<string, string>;
|
||||
presets: Record<string, { t: string; d: string }>;
|
||||
}
|
||||
const SCHEMA: Partial<Record<Locale, SchemaOverlay>> = { ru: ruSchema, de: deSchema, fr: frSchema, es: esSchema };
|
||||
const SCHEMA: Partial<Record<Locale, SchemaOverlay>> = { ru: ruSchema, de: deSchema, fr: frSchema, es: esSchema, zh: zhSchema };
|
||||
|
||||
export function useSchemaText() {
|
||||
const { locale } = useContext(I18n);
|
||||
|
||||
Loaded 100 of 139 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user