mirror of
https://github.com/Corfirean/coa-server-manager.git
synced 2026-11-19 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 | ||
|
|
1bcef5f8c2 | ||
|
|
e7113f3ceb | ||
|
|
831685dbd7 | ||
|
|
50b48e8af5 | ||
|
|
c0c414f5a8 | ||
|
|
5c21ef106d | ||
|
|
375be1b2c5 | ||
|
|
1181b920d3 | ||
|
|
42dbdeae1f | ||
|
|
dffb4811aa | ||
|
|
e889e0a789 | ||
|
|
d638bf3304 | ||
|
|
53aa117ec2 | ||
|
|
cc5363b385 | ||
|
|
209dbe37ac | ||
|
|
89be57b4e4 | ||
|
|
1f54fbf909 | ||
|
|
31c08934ad | ||
|
|
3b4cea7530 | ||
|
|
b091061cc5 | ||
|
|
726b089f42 | ||
|
|
14173d7d7e | ||
|
|
05397c4505 | ||
|
|
9444434734 | ||
|
|
8f2b585641 | ||
|
|
3281750104 |
No files matched your search
@@ -0,0 +1,14 @@
|
|||||||
|
name: changelog
|
||||||
|
# Checks the changelog.d/ fragment files with the shared rules (https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md).
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
paths: ['changelog.d/**']
|
||||||
|
pull_request:
|
||||||
|
paths: ['changelog.d/**']
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
check:
|
||||||
|
uses: Corfirean/coa-server-build/.github/workflows/changelog-check.yml@main
|
||||||
@@ -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
|
node-version: 22
|
||||||
- run: npm ci
|
- run: npm ci
|
||||||
- name: Tests
|
- name: Tests
|
||||||
run: cargo test --workspace
|
run: cargo test --workspace -- --test-threads=1
|
||||||
- name: Build, sign and publish
|
- name: Build, sign and publish
|
||||||
uses: tauri-apps/tauri-action@v0
|
uses: tauri-apps/tauri-action@v0
|
||||||
env:
|
env:
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
# AGENTS.md
|
||||||
|
|
||||||
|
<!-- changelog:start (managed by coa-server-build/changelog/changelog.py sync-instructions) -->
|
||||||
|
## Changelog (shared by all CoA repositories)
|
||||||
|
|
||||||
|
Every CoA project (server fork, bots, Content Scaling, Manager, renderer) feeds **one** changelog that is posted to the
|
||||||
|
community. When you finish a change that a **player** or a **server owner** would notice (a new feature, a changed
|
||||||
|
behaviour, a fix for something people ran into, a removed feature, a known issue), add **one small file to
|
||||||
|
`changelog.d/` in the same commit**. Do not add one for internal work (refactors, tests, CI, documentation).
|
||||||
|
|
||||||
|
File name: `YYYYMMDD-short-slug.md` (today's date). Content:
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
area: bots # server | bots | scaling | modules | manager | addon | client | renderer
|
||||||
|
type: fixed # added | changed | fixed | removed | known-issue
|
||||||
|
audience: players # players | admins (admins = people who run a server or use the Manager)
|
||||||
|
title: Bots no longer take Realm First achievements
|
||||||
|
---
|
||||||
|
Optional: one short paragraph in plain English for the reader (at most 300 characters).
|
||||||
|
```
|
||||||
|
|
||||||
|
- English only. The title says what changed **for the reader**, not how (at most 90 characters, starts with a capital,
|
||||||
|
no full stop). No code names, file names or commit language in the title.
|
||||||
|
- One file per change. Never edit or delete files that are already released; never write version numbers (the release
|
||||||
|
step adds them).
|
||||||
|
- Check your file: `python changelog.py check --dir changelog.d` (download the script from
|
||||||
|
https://raw.githubusercontent.com/Corfirean/coa-server-build/main/changelog/changelog.py ), or create it with
|
||||||
|
`python changelog.py new --area bots --type fixed --audience players --title "..."`.
|
||||||
|
- Full guide with examples: https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md
|
||||||
|
<!-- changelog:end -->
|
||||||
@@ -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",
|
"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]]
|
[[package]]
|
||||||
name = "atk"
|
name = "atk"
|
||||||
version = "0.18.2"
|
version = "0.18.2"
|
||||||
@@ -163,6 +294,19 @@ dependencies = [
|
|||||||
"objc2",
|
"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]]
|
[[package]]
|
||||||
name = "brotli"
|
name = "brotli"
|
||||||
version = "9.0.0"
|
version = "9.0.0"
|
||||||
@@ -347,7 +491,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "coa-core"
|
name = "coa-core"
|
||||||
version = "0.3.1"
|
version = "0.6.5"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"base64 0.22.1",
|
"base64 0.22.1",
|
||||||
"chrono",
|
"chrono",
|
||||||
@@ -375,7 +519,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "coa-release"
|
name = "coa-release"
|
||||||
version = "0.3.1"
|
version = "0.6.5"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"chrono",
|
"chrono",
|
||||||
"coa-core",
|
"coa-core",
|
||||||
@@ -384,7 +528,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "coa-server-manager"
|
name = "coa-server-manager"
|
||||||
version = "0.3.1"
|
version = "0.6.5"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"coa-core",
|
"coa-core",
|
||||||
"serde",
|
"serde",
|
||||||
@@ -392,6 +536,7 @@ dependencies = [
|
|||||||
"tauri",
|
"tauri",
|
||||||
"tauri-build",
|
"tauri-build",
|
||||||
"tauri-plugin-dialog",
|
"tauri-plugin-dialog",
|
||||||
|
"tauri-plugin-opener",
|
||||||
"tauri-plugin-process",
|
"tauri-plugin-process",
|
||||||
"tauri-plugin-updater",
|
"tauri-plugin-updater",
|
||||||
"tracing",
|
"tracing",
|
||||||
@@ -407,6 +552,15 @@ dependencies = [
|
|||||||
"memchr",
|
"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]]
|
[[package]]
|
||||||
name = "const-oid"
|
name = "const-oid"
|
||||||
version = "0.9.6"
|
version = "0.9.6"
|
||||||
@@ -872,6 +1026,33 @@ version = "1.2.2"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "4ef6b89e5b37196644d8796de5268852ff179b44e96276cf4290264843743bb7"
|
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]]
|
[[package]]
|
||||||
name = "equivalent"
|
name = "equivalent"
|
||||||
version = "1.0.2"
|
version = "1.0.2"
|
||||||
@@ -899,6 +1080,26 @@ dependencies = [
|
|||||||
"windows-sys 0.61.2",
|
"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]]
|
[[package]]
|
||||||
name = "fastrand"
|
name = "fastrand"
|
||||||
version = "2.5.0"
|
version = "2.5.0"
|
||||||
@@ -1063,6 +1264,19 @@ version = "0.3.34"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "53c0fa8157de1303bfffdaa1cc2a673bfffb60102f76b0ef4441659124373fed"
|
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]]
|
[[package]]
|
||||||
name = "futures-macro"
|
name = "futures-macro"
|
||||||
version = "0.3.34"
|
version = "0.3.34"
|
||||||
@@ -1417,6 +1631,12 @@ version = "0.5.0"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
|
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "hermit-abi"
|
||||||
|
version = "0.5.3"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "e17592d60ebacc7d5e169f4663c5f84f9161cc90328abcfe8456f41e4dfcb284"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "hex"
|
name = "hex"
|
||||||
version = "0.4.3"
|
version = "0.4.3"
|
||||||
@@ -1731,6 +1951,25 @@ version = "2.12.2"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "791930b43c0d5973160d90a8f3894509f2b273430f5c5c73b668636d0287c5c0"
|
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]]
|
[[package]]
|
||||||
name = "itoa"
|
name = "itoa"
|
||||||
version = "1.0.18"
|
version = "1.0.18"
|
||||||
@@ -2446,6 +2685,17 @@ version = "1.21.4"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
|
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]]
|
[[package]]
|
||||||
name = "openssl"
|
name = "openssl"
|
||||||
version = "0.10.81"
|
version = "0.10.81"
|
||||||
@@ -2495,6 +2745,16 @@ version = "0.2.0"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d"
|
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]]
|
[[package]]
|
||||||
name = "osakit"
|
name = "osakit"
|
||||||
version = "0.3.1"
|
version = "0.3.1"
|
||||||
@@ -2534,6 +2794,12 @@ dependencies = [
|
|||||||
"system-deps",
|
"system-deps",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "parking"
|
||||||
|
version = "2.2.1"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "f38d5652c16fde515bb1ecef450ab0f6a219d619a7274976324d5e377f7dceba"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "parking_lot"
|
name = "parking_lot"
|
||||||
version = "0.12.5"
|
version = "0.12.5"
|
||||||
@@ -2622,6 +2888,17 @@ version = "0.2.17"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd"
|
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]]
|
[[package]]
|
||||||
name = "pkcs8"
|
name = "pkcs8"
|
||||||
version = "0.10.2"
|
version = "0.10.2"
|
||||||
@@ -2677,6 +2954,20 @@ dependencies = [
|
|||||||
"miniz_oxide 0.8.9",
|
"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]]
|
[[package]]
|
||||||
name = "portable-atomic"
|
name = "portable-atomic"
|
||||||
version = "1.15.0"
|
version = "1.15.0"
|
||||||
@@ -3451,6 +3742,16 @@ version = "2.0.1"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba"
|
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]]
|
[[package]]
|
||||||
name = "signature"
|
name = "signature"
|
||||||
version = "2.2.0"
|
version = "2.2.0"
|
||||||
@@ -3946,6 +4247,28 @@ dependencies = [
|
|||||||
"url",
|
"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]]
|
[[package]]
|
||||||
name = "tauri-plugin-process"
|
name = "tauri-plugin-process"
|
||||||
version = "2.4.0"
|
version = "2.4.0"
|
||||||
@@ -4476,6 +4799,17 @@ version = "1.20.1"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20"
|
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]]
|
[[package]]
|
||||||
name = "unicode-ident"
|
name = "unicode-ident"
|
||||||
version = "1.0.26"
|
version = "1.0.26"
|
||||||
@@ -5343,6 +5677,76 @@ dependencies = [
|
|||||||
"synstructure",
|
"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]]
|
[[package]]
|
||||||
name = "zerofrom"
|
name = "zerofrom"
|
||||||
version = "0.1.8"
|
version = "0.1.8"
|
||||||
@@ -5483,3 +5887,44 @@ dependencies = [
|
|||||||
"cc",
|
"cc",
|
||||||
"pkg-config",
|
"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"]
|
members = ["crates/coa-core", "crates/coa-release", "src-tauri"]
|
||||||
|
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
version = "0.3.1"
|
version = "0.6.5"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
license = "AGPL-3.0-only"
|
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.
|
||||||
@@ -18,6 +18,14 @@ no console, no config files, no database tools. Tauri 2 + Rust + React.
|
|||||||
into **UPDATE**. Updates are authenticated (Ed25519), back up first, keep files you changed and can be rolled back.
|
into **UPDATE**. Updates are authenticated (Ed25519), back up first, keep files you changed and can be rolled back.
|
||||||
* **Backups.** Characters, accounts and settings on demand, automatically before every update; verify and restore
|
* **Backups.** Characters, accounts and settings on demand, automatically before every update; verify and restore
|
||||||
from the app.
|
from the app.
|
||||||
|
* **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).
|
||||||
* **Companions (bots).** Fill the world with level-appropriate bots, see progress, stop spawning, take them offline,
|
* **Companions (bots).** Fill the world with level-appropriate bots, see progress, stop spawning, take them offline,
|
||||||
despawn N to relieve the server, and choose how many log in at server start.
|
despawn N to relieve the server, and choose how many log in at server start.
|
||||||
* **Realmlist switcher.** Keep named realmlists (for example *Solo* and *PTR*) and switch the game client between them from a
|
* **Realmlist switcher.** Keep named realmlists (for example *Solo* and *PTR*) and switch the game client between them from a
|
||||||
|
|||||||
@@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: added
|
||||||
|
audience: admins
|
||||||
|
title: Collections tab with transmog, vanity, riding and companion switches
|
||||||
|
---
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Companion bots are recognised from their default config file
|
||||||
|
---
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: added
|
||||||
|
audience: admins
|
||||||
|
title: Delete an account from the Players page
|
||||||
|
---
|
||||||
|
You type the account name to confirm; online and system accounts are refused.
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: changed
|
||||||
|
audience: admins
|
||||||
|
title: Importing a server suggests the right folder when you pick the wrong one
|
||||||
|
---
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: added
|
||||||
|
audience: admins
|
||||||
|
title: Modules page with cards, status badges and per-module settings
|
||||||
|
---
|
||||||
|
Switch the companion bots and NPC Enchanter on and off; a module's settings open under its card.
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: changed
|
||||||
|
audience: admins
|
||||||
|
title: Report a problem collects more and ignores repeated config warnings
|
||||||
|
---
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: changed
|
||||||
|
audience: admins
|
||||||
|
title: Server settings in one panel with search, tabs and a single Save bar
|
||||||
|
---
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: The update check says you are up to date instead of offering the same version
|
||||||
|
---
|
||||||
@@ -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: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Imported servers get the module config files they lack
|
||||||
|
---
|
||||||
|
They are created at start and after an update; existing files are never changed.
|
||||||
@@ -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,6 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Modules marked Soon stay greyed out
|
||||||
|
---
|
||||||
@@ -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,6 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: The Bots page is hidden when the module is not on the server
|
||||||
|
---
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: changed
|
||||||
|
audience: admins
|
||||||
|
title: Updating the game client shows a progress bar on its button
|
||||||
|
---
|
||||||
|
No window covers the app while the client updates.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: added
|
||||||
|
audience: admins
|
||||||
|
title: Switch between CoA and Wildcard while keeping separate characters and module settings
|
||||||
|
---
|
||||||
|
Run one world at a time with shared accounts. Wildcard keeps its own progress; CoA companions are unavailable there, and other modules show experimental compatibility. Backups and server updates cover both realms.
|
||||||
@@ -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.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# changelog.d
|
||||||
|
|
||||||
|
One small Markdown file per change that a player or a server owner would notice. They are collected from every CoA
|
||||||
|
repository when a release is made. The rules and the file format are in `AGENTS.md` (section "Changelog") and, in full,
|
||||||
|
in https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md
|
||||||
|
|
||||||
|
This README is ignored by the collector.
|
||||||
@@ -24,14 +24,14 @@ num-bigint = "0.4"
|
|||||||
zip = { version = "2", default-features = false, features = ["deflate"] }
|
zip = { version = "2", default-features = false, features = ["deflate"] }
|
||||||
sha1 = "0.10"
|
sha1 = "0.10"
|
||||||
tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt", "std"] }
|
tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt", "std"] }
|
||||||
|
tempfile = "3"
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
tempfile = "3"
|
|
||||||
rand_core = { version = "0.6", features = ["getrandom"] }
|
rand_core = { version = "0.6", features = ["getrandom"] }
|
||||||
ed25519-dalek = { version = "2", features = ["rand_core"] }
|
ed25519-dalek = { version = "2", features = ["rand_core"] }
|
||||||
|
|
||||||
[target.'cfg(windows)'.dependencies]
|
[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]
|
[features]
|
||||||
testkit = []
|
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"));
|
let dst = staging.join(db).join(format!("{id}.sql"));
|
||||||
std::fs::create_dir_all(dst.parent().unwrap()).unwrap();
|
std::fs::create_dir_all(dst.parent().unwrap()).unwrap();
|
||||||
std::fs::write(&dst, &bytes).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 (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 {
|
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(())
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
//! Native smoke checks for the disposable fixture created by tools/make-fixture.ps1.
|
||||||
|
//! Never point these probes at an owned server.
|
||||||
|
use std::path::Path;
|
||||||
|
|
||||||
|
use coa_core::db::{Account, Db};
|
||||||
|
use coa_core::driver::{self, Verb};
|
||||||
|
use coa_core::realms::{self, Mode};
|
||||||
|
use coa_core::{Error, Result};
|
||||||
|
|
||||||
|
fn main() -> Result<()> {
|
||||||
|
let args: Vec<String> = std::env::args().collect();
|
||||||
|
let root = Path::new("C:/games/coa-wildcard-fixture");
|
||||||
|
let action = args.get(1).map(String::as_str).unwrap_or("view");
|
||||||
|
match action {
|
||||||
|
"select" => {
|
||||||
|
let mode = if args.get(2).map(String::as_str) == Some("wildcard") { Mode::Wildcard } else { Mode::Coa };
|
||||||
|
println!("{}", serde_json::to_string(&realms::select(root, mode)?)?);
|
||||||
|
}
|
||||||
|
"start" | "stop" => {
|
||||||
|
let out = driver::run(root, if action == "start" { Verb::StartAll } else { Verb::StopAll })?;
|
||||||
|
println!("{}", serde_json::to_string(&out)?);
|
||||||
|
if !out.ok { return Err(Error::Invalid("Fixture operation failed".into())); }
|
||||||
|
}
|
||||||
|
"probe" => {
|
||||||
|
let db = Db::from_repack(root, Account::Admin)?;
|
||||||
|
let s = realms::state(root)?;
|
||||||
|
println!("{}", db.query("SELECT * FROM acore_characters.manager_profile_probe;")?);
|
||||||
|
println!("active={} chars={} world={}", s.active.name(), s.active.schema("characters")?, s.active.schema("world")?);
|
||||||
|
}
|
||||||
|
"mark" => {
|
||||||
|
Db::from_repack(root, Account::Admin)?.query("INSERT INTO acore_characters.manager_profile_probe VALUES (22);")?;
|
||||||
|
}
|
||||||
|
"backup" => {
|
||||||
|
use coa_core::backup::{self, Kind, Trigger};
|
||||||
|
let meta = root.join("fixture-manager");
|
||||||
|
let point = backup::create(root, &meta, Kind::Full, Trigger::Manual, Some("realm isolation check".into()), &|step| println!("{step}"))?;
|
||||||
|
assert_eq!(point.realm, Mode::Wildcard);
|
||||||
|
for name in ["characters", "world", "auth", "coa-characters", "coa-world", "configs"] {
|
||||||
|
assert!(point.components.iter().any(|c| c.name == name), "Missing {name}");
|
||||||
|
}
|
||||||
|
assert!(backup::verify(&meta, &point.id)?.ok);
|
||||||
|
println!("Verified both realm backups: {}", point.id);
|
||||||
|
}
|
||||||
|
"database-checks" => {
|
||||||
|
use coa_core::backup::{self, Kind, Trigger};
|
||||||
|
use coa_core::manifest::{Manifest, Migration};
|
||||||
|
use coa_core::update::{Env, RepackEnv};
|
||||||
|
let meta = root.join("fixture-manager");
|
||||||
|
let env = RepackEnv { root, meta_dir: &meta };
|
||||||
|
env.ensure_stopped()?;
|
||||||
|
let staged = root.join("fixture-migrations");
|
||||||
|
let mut manifest: Manifest = serde_json::from_value(serde_json::json!({
|
||||||
|
"schema": 1, "kind": "update", "version": "0.5.0", "core": {"commit": null},
|
||||||
|
"builtAt": "fixture", "minManagerVersion": "0.5.0"
|
||||||
|
}))?;
|
||||||
|
for kind in ["characters", "world", "auth"] {
|
||||||
|
let sql = format!("CREATE TABLE acore_{kind}.manager_migration_probe (value INT); INSERT INTO acore_{kind}.manager_migration_probe VALUES (42);");
|
||||||
|
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 { 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());
|
||||||
|
backup::with_database(root, |db| {
|
||||||
|
for mode in [Mode::Coa, Mode::Wildcard] {
|
||||||
|
let realm = db.clone().for_realm(mode);
|
||||||
|
for kind in ["characters", "world", "auth"] {
|
||||||
|
assert_eq!(realm.query(&format!("SELECT COUNT(*) FROM acore_{kind}.manager_migration_probe;"))?, "1");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
assert!(env.migrate(&manifest, &staged)?.applied.is_empty());
|
||||||
|
let point = backup::create(root, &meta, Kind::Quick, Trigger::Manual, None, &|_| {})?;
|
||||||
|
backup::with_database(root, |db| {
|
||||||
|
db.query("INSERT INTO acore_characters.manager_profile_probe VALUES (22);")?;
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
backup::restore_database(root, &meta, &point.id, "characters")?;
|
||||||
|
backup::with_database(root, |db| {
|
||||||
|
assert_eq!(db.query("SELECT COUNT(*) FROM acore_characters.manager_profile_probe;")?, "0");
|
||||||
|
assert_eq!(db.clone().for_realm(Mode::Coa).query("SELECT value FROM acore_characters.manager_profile_probe;")?, "11");
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
println!("Both realms migrated once; shared auth migrated once; Wildcard restore left CoA intact.");
|
||||||
|
}
|
||||||
|
"view" => println!("{}", serde_json::to_string(&realms::view(root)?)?),
|
||||||
|
_ => return Err(Error::Invalid("Unknown fixture action".into())),
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
@@ -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);";
|
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);
|
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();
|
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();
|
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 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();
|
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(())
|
||||||
|
}
|
||||||
@@ -84,6 +84,32 @@ pub fn rename(root: &Path, ra: &mut Ra, old: &str, new: &str, password: &str) ->
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Accounts the Manager and the companions use themselves; they can never be deleted from here.
|
||||||
|
fn is_reserved(upper_name: &str) -> bool {
|
||||||
|
upper_name == "COAMANAGER" || upper_name.starts_with("COABOT")
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Delete an account and, with it, all of its characters. Needs the world console. Refuses the Manager's and the
|
||||||
|
/// companions' own accounts, an account that is not there and one that is logged in right now.
|
||||||
|
pub fn delete(root: &Path, ra: &mut Ra, name: &str) -> Result<()> {
|
||||||
|
let name = upper(name)?;
|
||||||
|
if is_reserved(&name) {
|
||||||
|
return Err(Error::Invalid("This account belongs to the Manager or the companions and cannot be deleted.".into()));
|
||||||
|
}
|
||||||
|
let db = Db::from_repack(root, Account::Admin)?;
|
||||||
|
match db.query(&format!("SELECT online FROM acore_auth.account WHERE username = '{name}';"))?.trim() {
|
||||||
|
"" => return Err(Error::Invalid("That account does not exist.".into())),
|
||||||
|
"0" => {}
|
||||||
|
_ => return Err(Error::Invalid("The account is logged in right now; log it out first.".into())),
|
||||||
|
}
|
||||||
|
ra.delete_account(&name)?;
|
||||||
|
if db.query(&format!("SELECT COUNT(*) FROM acore_auth.account WHERE username = '{name}';"))?.trim() != "0" {
|
||||||
|
return Err(Error::Invalid("The account was not deleted.".into()));
|
||||||
|
}
|
||||||
|
tracing::info!(%name, "account deleted");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
@@ -102,6 +128,16 @@ mod tests {
|
|||||||
assert!(LIST_SQL.contains("COABOTHOST%") && LIST_SQL.contains("COAMANAGER"));
|
assert!(LIST_SQL.contains("COABOTHOST%") && LIST_SQL.contains("COAMANAGER"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_managers_and_the_companions_accounts_are_never_deletable() {
|
||||||
|
for n in ["COAMANAGER", "COABOTHOST1", "COABOT12", "COABOTS"] {
|
||||||
|
assert!(is_reserved(n), "{n}");
|
||||||
|
}
|
||||||
|
for n in ["ALICE", "MYCOABOT", "BOT1"] {
|
||||||
|
assert!(!is_reserved(n), "{n}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn names_are_validated_and_stored_in_capitals() {
|
fn names_are_validated_and_stored_in_capitals() {
|
||||||
assert_eq!(upper("Alice1").unwrap(), "ALICE1");
|
assert_eq!(upper("Alice1").unwrap(), "ALICE1");
|
||||||
|
|||||||
@@ -0,0 +1,239 @@
|
|||||||
|
//! Every setting of the world server's configuration, for people who want more than the curated list: the documented
|
||||||
|
//! settings come from `worldserver.conf.dist` (the file that ships with the server and explains each one), the current
|
||||||
|
//! values from the configuration the next start will use. Anything that holds a password, a port, an address, a folder or
|
||||||
|
//! the database connection is left out; the Manager owns those.
|
||||||
|
|
||||||
|
use std::collections::BTreeMap;
|
||||||
|
use std::fs;
|
||||||
|
use std::path::Path;
|
||||||
|
|
||||||
|
use serde::Serialize;
|
||||||
|
|
||||||
|
use crate::config::parser::ConfFile;
|
||||||
|
use crate::config::{take_snapshot, targets, Scope};
|
||||||
|
use crate::error::{Error, Result};
|
||||||
|
use crate::fsx;
|
||||||
|
|
||||||
|
#[derive(Debug, Serialize, PartialEq, Eq)]
|
||||||
|
pub struct Item {
|
||||||
|
pub key: String,
|
||||||
|
/// What the server uses now (the documented default when the file does not mention the setting).
|
||||||
|
pub value: String,
|
||||||
|
pub default: String,
|
||||||
|
pub doc: String,
|
||||||
|
/// The file sets it to something other than the documented default.
|
||||||
|
pub changed: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Settings the Manager (or the launcher) owns.
|
||||||
|
fn hidden(key: &str) -> bool {
|
||||||
|
let k = key.to_ascii_lowercase();
|
||||||
|
k.contains("password")
|
||||||
|
|| k.contains("databaseinfo")
|
||||||
|
|| k.ends_with("port")
|
||||||
|
|| k.starts_with("ra.")
|
||||||
|
|| k.starts_with("logger.")
|
||||||
|
|| k.starts_with("appender.")
|
||||||
|
|| k.starts_with("updates.")
|
||||||
|
|| k.starts_with("logindatabase.")
|
||||||
|
|| k.starts_with("worlddatabase.")
|
||||||
|
|| k.starts_with("characterdatabase.")
|
||||||
|
|| ["bindip", "realmid", "datadir", "logsdir", "tempdir", "sourcedirectory", "mysqlexecutable", "cmakecommand", "builddirectory", "pidfile", "vmapdir", "mmapdir"].contains(&k.as_str())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn doc_of(block: &[String]) -> String {
|
||||||
|
let mut parts: Vec<String> = Vec::new();
|
||||||
|
for l in block {
|
||||||
|
let body = l.trim_start_matches('#').trim();
|
||||||
|
if body.is_empty() {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
// the lines that only name the settings the block describes
|
||||||
|
let named = l.starts_with("# ") && !l.starts_with("# ") && body.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '_' | '-'));
|
||||||
|
if named {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
parts.push(body.split_whitespace().collect::<Vec<_>>().join(" "));
|
||||||
|
}
|
||||||
|
let mut doc = parts.join(" ");
|
||||||
|
if doc.chars().count() > 900 {
|
||||||
|
doc = doc.chars().take(900).collect::<String>() + "…";
|
||||||
|
}
|
||||||
|
doc
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The documented settings of a `.dist` file: (key, default, description), in file order.
|
||||||
|
fn parse_dist(text: &str) -> Vec<(String, String, String)> {
|
||||||
|
let mut out = Vec::new();
|
||||||
|
let mut block: Vec<String> = Vec::new();
|
||||||
|
let mut in_comment = false;
|
||||||
|
let mut doc = String::new();
|
||||||
|
for line in text.lines() {
|
||||||
|
let t = line.trim();
|
||||||
|
if t.starts_with('#') {
|
||||||
|
if !in_comment {
|
||||||
|
block.clear();
|
||||||
|
in_comment = true;
|
||||||
|
}
|
||||||
|
block.push(line.trim_end().to_string());
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if in_comment {
|
||||||
|
doc = doc_of(&block);
|
||||||
|
in_comment = false;
|
||||||
|
}
|
||||||
|
if t.is_empty() || t.starts_with('[') {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if let Some((k, v)) = t.split_once('=') {
|
||||||
|
let k = k.trim();
|
||||||
|
if !k.is_empty() && k.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '_' | '-')) {
|
||||||
|
out.push((k.to_string(), v.trim().to_string(), doc.clone()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out
|
||||||
|
}
|
||||||
|
|
||||||
|
fn dist_path(root: &Path) -> std::path::PathBuf {
|
||||||
|
root.join("Core/configs/worldserver.conf.dist")
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn list(root: &Path) -> Result<Vec<Item>> {
|
||||||
|
let dist = fs::read_to_string(dist_path(root)).map_err(|_| Error::Invalid("The documented settings file (worldserver.conf.dist) was not found on this server.".into()))?;
|
||||||
|
let t = targets(root, Scope::Server)?;
|
||||||
|
let active = ConfFile::parse_bytes(&fs::read(&t.read)?)?;
|
||||||
|
Ok(parse_dist(&dist)
|
||||||
|
.into_iter()
|
||||||
|
.filter(|(k, _, _)| !hidden(k))
|
||||||
|
.map(|(key, default, doc)| {
|
||||||
|
let value = active.get(&key).map(|v| v.trim().to_string()).unwrap_or_else(|| default.clone());
|
||||||
|
let changed = value != default;
|
||||||
|
Item { key, value, default, doc, changed }
|
||||||
|
})
|
||||||
|
.collect())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Change settings that exist in the documented file. A value is one line of at most 500 characters. Returns the keys
|
||||||
|
/// that actually changed; the previous files are snapshotted first (and can be restored from Settings).
|
||||||
|
pub fn save(root: &Path, meta: &Path, changes: &BTreeMap<String, String>) -> Result<Vec<String>> {
|
||||||
|
let known: BTreeMap<String, String> = parse_dist(&fs::read_to_string(dist_path(root)).map_err(|_| Error::Invalid("worldserver.conf.dist was not found on this server.".into()))?)
|
||||||
|
.into_iter()
|
||||||
|
.map(|(k, d, _)| (k, d))
|
||||||
|
.collect();
|
||||||
|
let t = targets(root, Scope::Server)?;
|
||||||
|
let mut originals: Vec<(std::path::PathBuf, Vec<u8>)> = Vec::new();
|
||||||
|
let mut confs: Vec<ConfFile> = Vec::new();
|
||||||
|
for p in &t.writes {
|
||||||
|
let bytes = fs::read(p)?;
|
||||||
|
confs.push(ConfFile::parse_bytes(&bytes)?);
|
||||||
|
originals.push((p.clone(), bytes));
|
||||||
|
}
|
||||||
|
let mut changed = Vec::new();
|
||||||
|
for (key, value) in changes {
|
||||||
|
let value = value.trim();
|
||||||
|
if hidden(key) || !known.contains_key(key) {
|
||||||
|
return Err(Error::Invalid(format!("{key} is not a setting that can be changed here.")));
|
||||||
|
}
|
||||||
|
if value.is_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.")));
|
||||||
|
}
|
||||||
|
let same = confs.iter().all(|c| match c.get(key) {
|
||||||
|
Some(v) => v.trim() == value,
|
||||||
|
None => known[key] == value,
|
||||||
|
});
|
||||||
|
if !same {
|
||||||
|
changed.push((key.clone(), value.to_string()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if changed.is_empty() {
|
||||||
|
return Ok(Vec::new());
|
||||||
|
}
|
||||||
|
for c in &mut confs {
|
||||||
|
for (k, v) in &changed {
|
||||||
|
c.set(k, v, &["Added by CoA Server Manager"]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let texts: Vec<String> = confs.iter().map(ConfFile::to_text).collect();
|
||||||
|
for text in &texts {
|
||||||
|
let reread = ConfFile::parse(text);
|
||||||
|
for (k, v) in &changed {
|
||||||
|
if reread.get(k).map(str::trim) != Some(v.as_str()) {
|
||||||
|
return Err(Error::Invalid(format!("internal check failed for {k}")));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
take_snapshot(meta, Scope::Server, &format!("before changing {} setting(s) in the full list", changed.len()), &originals)?;
|
||||||
|
let mut written = 0;
|
||||||
|
for (i, (path, _)) in originals.iter().enumerate() {
|
||||||
|
if let Err(e) = fsx::atomic_write(path, texts[i].as_bytes()) {
|
||||||
|
for (p, bytes) in originals.iter().take(written) {
|
||||||
|
let _ = fsx::atomic_write(p, bytes);
|
||||||
|
}
|
||||||
|
return Err(e);
|
||||||
|
}
|
||||||
|
written += 1;
|
||||||
|
}
|
||||||
|
Ok(changed.into_iter().map(|(k, _)| k).collect())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
const DIST: &str = "[worldserver]\r\n\r\n###################\r\n# SECTION\r\n###################\r\n\r\n#\r\n# Rate.Drop.Item.Epic\r\n# Rate.Drop.Item.Rare\r\n# Description: Drop rates by quality.\r\n# Default: 1\r\n#\r\n\r\nRate.Drop.Item.Rare = 1\r\nRate.Drop.Item.Epic = 1\r\n\r\n#\r\n# LoginDatabaseInfo\r\n# Description: secret\r\n#\r\n\r\nLoginDatabaseInfo = \"127.0.0.1;3306;a;b;c\"\r\n\r\n#\r\n# Instance.ResetTimeHour\r\n# Description: Hour of the reset.\r\n# Important: Use 0-23.\r\n# Default: 4\r\n#\r\n\r\nInstance.ResetTimeHour = 4\r\n";
|
||||||
|
|
||||||
|
fn server(d: &Path) -> (std::path::PathBuf, std::path::PathBuf) {
|
||||||
|
let (root, meta) = (d.join("srv"), d.join("meta"));
|
||||||
|
fs::create_dir_all(root.join("Core/configs")).unwrap();
|
||||||
|
fs::create_dir_all(root.join("Settings")).unwrap();
|
||||||
|
fs::create_dir_all(&meta).unwrap();
|
||||||
|
fs::write(root.join("Core/configs/worldserver.conf.dist"), DIST).unwrap();
|
||||||
|
let conf = "[worldserver]\r\nRate.Drop.Item.Epic = 3\r\nLoginDatabaseInfo = \"x\"\r\n";
|
||||||
|
fs::write(root.join("Settings/worldserver.conf.template"), conf).unwrap();
|
||||||
|
fs::write(root.join("Core/configs/worldserver.conf"), conf).unwrap();
|
||||||
|
(root, meta)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_documentation_of_a_block_is_shared_by_its_settings_and_secrets_are_left_out() {
|
||||||
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
let (root, _) = server(d.path());
|
||||||
|
let items = list(&root).unwrap();
|
||||||
|
let keys: Vec<&str> = items.iter().map(|i| i.key.as_str()).collect();
|
||||||
|
assert_eq!(keys, ["Rate.Drop.Item.Rare", "Rate.Drop.Item.Epic", "Instance.ResetTimeHour"], "the database connection is hidden");
|
||||||
|
assert_eq!(items[0].doc, "Description: Drop rates by quality. Default: 1");
|
||||||
|
assert_eq!(items[0].doc, items[1].doc);
|
||||||
|
assert_eq!(items[2].doc, "Description: Hour of the reset. Important: Use 0-23. Default: 4");
|
||||||
|
assert!(!items[0].changed && items[0].value == "1", "absent from the file: documented default");
|
||||||
|
assert!(items[1].changed && items[1].value == "3");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn only_documented_visible_settings_with_one_line_values_can_be_saved_and_both_files_change() {
|
||||||
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
let (root, meta) = server(d.path());
|
||||||
|
let ok = BTreeMap::from([("Instance.ResetTimeHour".to_string(), "6".to_string())]);
|
||||||
|
assert_eq!(save(&root, &meta, &ok).unwrap(), ["Instance.ResetTimeHour"]);
|
||||||
|
for f in ["Settings/worldserver.conf.template", "Core/configs/worldserver.conf"] {
|
||||||
|
let t = fs::read_to_string(root.join(f)).unwrap();
|
||||||
|
assert!(t.contains("Instance.ResetTimeHour = 6") && t.contains("Rate.Drop.Item.Epic = 3"), "{f}: {t}");
|
||||||
|
}
|
||||||
|
assert!(save(&root, &meta, &ok).unwrap().is_empty(), "same value: nothing to do");
|
||||||
|
let same_as_default = BTreeMap::from([("Rate.Drop.Item.Rare".to_string(), "1".to_string())]);
|
||||||
|
assert!(save(&root, &meta, &same_as_default).unwrap().is_empty(), "the default is already in effect");
|
||||||
|
for bad in [("LoginDatabaseInfo", "\"evil\""), ("Nope.Key", "1"), ("Rate.Drop.Item.Rare", ""), ("Rate.Drop.Item.Rare", "1\n2")] {
|
||||||
|
assert!(save(&root, &meta, &BTreeMap::from([(bad.0.to_string(), bad.1.to_string())])).is_err(), "{bad:?}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn what_belongs_to_the_manager_is_hidden() {
|
||||||
|
for k in ["LoginDatabaseInfo", "WorldServerPort", "BindIP", "Ra.Enable", "Ra.Password", "Logger.root", "Appender.Console", "DataDir", "Updates.EnableDatabases", "LoginDatabase.WorkerThreads", "InstanceServerPort"] {
|
||||||
|
assert!(hidden(k), "{k}");
|
||||||
|
}
|
||||||
|
for k in ["Rate.XP.Kill", "PlayerLimit", "SupportEnabled", "Instance.ResetTimeHour", "Warden.Enabled", "CharacterCreating.Disabled"] {
|
||||||
|
assert!(!hidden(k), "{k}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+100
-17
@@ -51,6 +51,8 @@ pub struct Component {
|
|||||||
pub sha256: Option<String>,
|
pub sha256: Option<String>,
|
||||||
pub tables: Option<usize>,
|
pub tables: Option<usize>,
|
||||||
pub files: Option<Vec<String>>,
|
pub files: Option<Vec<String>>,
|
||||||
|
#[serde(default)]
|
||||||
|
pub file_sha256: std::collections::BTreeMap<String, String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||||
@@ -63,6 +65,8 @@ pub struct RecoveryPoint {
|
|||||||
pub created_at: String,
|
pub created_at: String,
|
||||||
pub manager_version: String,
|
pub manager_version: String,
|
||||||
pub components: Vec<Component>,
|
pub components: Vec<Component>,
|
||||||
|
#[serde(default)]
|
||||||
|
pub realm: crate::realms::Mode,
|
||||||
}
|
}
|
||||||
|
|
||||||
fn backups_dir(meta: &Path) -> PathBuf {
|
fn backups_dir(meta: &Path) -> PathBuf {
|
||||||
@@ -89,7 +93,9 @@ pub fn list(meta: &Path) -> Vec<RecoveryPoint> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn get(meta: &Path, id: &str) -> Result<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.
|
/// Files that make up "configuration": everything a user or the Manager may have changed, minus secrets.
|
||||||
@@ -127,6 +133,8 @@ pub fn config_files(root: &Path) -> Vec<String> {
|
|||||||
if root.join("RELEASE.json").is_file() {
|
if root.join("RELEASE.json").is_file() {
|
||||||
out.push("RELEASE.json".into());
|
out.push("RELEASE.json".into());
|
||||||
}
|
}
|
||||||
|
walk(root, &root.join("Settings/realm-profiles"), &mut out);
|
||||||
|
if root.join("Settings/realm-profile.json").is_file() { out.push("Settings/realm-profile.json".into()); }
|
||||||
out.sort();
|
out.sort();
|
||||||
out
|
out
|
||||||
}
|
}
|
||||||
@@ -135,13 +143,16 @@ fn copy_configs(root: &Path, dir: &Path) -> Result<Component> {
|
|||||||
let files = config_files(root);
|
let files = config_files(root);
|
||||||
let target = dir.join("files");
|
let target = dir.join("files");
|
||||||
let mut bytes = 0;
|
let mut bytes = 0;
|
||||||
|
let mut file_sha256 = std::collections::BTreeMap::new();
|
||||||
for rel in &files {
|
for rel in &files {
|
||||||
let src = fsx::safe_join(root, rel)?;
|
let src = fsx::safe_join(root, rel)?;
|
||||||
let dst = fsx::safe_join(&target, rel)?;
|
let dst = fsx::safe_join(&target, rel)?;
|
||||||
fs::create_dir_all(dst.parent().unwrap())?;
|
let content = fs::read(&src)?;
|
||||||
bytes += fs::copy(&src, &dst)?;
|
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.
|
/// Make sure the database is up for `f`. If we had to start it (and nothing else is running), stop it again.
|
||||||
@@ -158,7 +169,7 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
|
|||||||
let result = f(&db);
|
let result = f(&db);
|
||||||
if !mysql_was_up {
|
if !mysql_was_up {
|
||||||
let now = process::observe(root, &read_ports(root));
|
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);
|
let _ = driver::run(root, Verb::StopAll);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -175,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`).
|
/// 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> {
|
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::Manual => "manual",
|
||||||
Trigger::Automatic => "auto",
|
Trigger::Automatic => "auto",
|
||||||
Trigger::BeforeUpdate => "before-update",
|
Trigger::BeforeUpdate => "before-update",
|
||||||
@@ -184,23 +195,34 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
|
|||||||
Trigger::BeforeBots => "before-bots",
|
Trigger::BeforeBots => "before-bots",
|
||||||
Trigger::BeforeRepair => "before-repair",
|
Trigger::BeforeRepair => "before-repair",
|
||||||
Trigger::BeforeDangerousChange => "before-change",
|
Trigger::BeforeDangerousChange => "before-change",
|
||||||
});
|
}, uuid::Uuid::new_v4().simple());
|
||||||
let final_dir = point_dir(meta, &id)?;
|
let final_dir = point_dir(meta, &id)?;
|
||||||
let partial = backups_dir(meta).join(format!("{id}.partial"));
|
let partial = backups_dir(meta).join(format!("{id}.partial"));
|
||||||
fs::create_dir_all(&partial)?;
|
fs::create_dir_all(&partial)?;
|
||||||
|
|
||||||
let build = || -> Result<Vec<Component>> {
|
let build = || -> Result<Vec<Component>> {
|
||||||
let mut components = Vec::new();
|
let mut components = Vec::new();
|
||||||
for name in wanted_databases(kind) {
|
let realm = crate::realms::state(root)?;
|
||||||
let schema = db::schema_of(name)?;
|
let mut databases: Vec<(String, &str)> = wanted_databases(kind).iter()
|
||||||
|
.map(|name| Ok((name.to_string(), realm.active.schema(name)?))).collect::<Result<_>>()?;
|
||||||
|
if realm.wildcard_created && kind != Kind::Config {
|
||||||
|
let other = if realm.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa };
|
||||||
|
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"));
|
progress(&format!("Backing up {name} database"));
|
||||||
let component = with_database(root, |db| {
|
let component = with_database(root, |db| {
|
||||||
|
let db = db.clone().for_realm(crate::realms::Mode::Coa);
|
||||||
let size = db.schema_bytes(schema)?;
|
let size = db.schema_bytes(schema)?;
|
||||||
fsx::require_space(&partial, size / 2 + 32 * 1024 * 1024)?;
|
fsx::require_space(&partial, size / 2 + 32 * 1024 * 1024)?;
|
||||||
let tables = db.tables(schema)?.len();
|
let tables = db.tables(schema)?.len();
|
||||||
let file = format!("{name}.sql.zst");
|
let file = format!("{name}.sql.zst");
|
||||||
let (bytes, sha) = db.dump_to(schema, &partial.join(&file))?;
|
let (bytes, sha) = db.dump_to(schema, &partial.join(&file))?;
|
||||||
Ok(Component { name: (*name).into(), 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);
|
components.push(component);
|
||||||
}
|
}
|
||||||
@@ -219,6 +241,7 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
let point = RecoveryPoint {
|
let point = RecoveryPoint {
|
||||||
|
realm: crate::realms::state(root)?.active,
|
||||||
schema: 1,
|
schema: 1,
|
||||||
id: id.clone(),
|
id: id.clone(),
|
||||||
kind,
|
kind,
|
||||||
@@ -239,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.
|
/// Keep the newest `keep` automatic recovery points; manual and safety ones are never pruned.
|
||||||
pub fn prune_automatic(meta: &Path, keep: usize) {
|
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();
|
let autos: Vec<_> = list(meta).into_iter().filter(|p| p.trigger == Trigger::Automatic).collect();
|
||||||
for p in autos.into_iter().skip(keep) {
|
for p in autos.into_iter().skip(keep) {
|
||||||
if let Ok(dir) = point_dir(meta, &p.id) {
|
if let Ok(dir) = point_dir(meta, &p.id) {
|
||||||
@@ -257,8 +281,21 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
|
|||||||
let point = get(meta, id)?;
|
let point = get(meta, id)?;
|
||||||
let dir = point_dir(meta, id)?;
|
let dir = point_dir(meta, id)?;
|
||||||
let mut problems = Vec::new();
|
let mut problems = Vec::new();
|
||||||
|
let mut names = std::collections::BTreeSet::new();
|
||||||
|
let mut schemas = std::collections::BTreeSet::new();
|
||||||
for c in &point.components {
|
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) {
|
match (&c.sha256, &c.files) {
|
||||||
(Some(sha), _) => match fsx::sha256_file(&path) {
|
(Some(sha), _) => match fsx::sha256_file(&path) {
|
||||||
Ok(actual) if actual.eq_ignore_ascii_case(sha) => {}
|
Ok(actual) if actual.eq_ignore_ascii_case(sha) => {}
|
||||||
@@ -267,12 +304,16 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
|
|||||||
},
|
},
|
||||||
(None, Some(files)) => {
|
(None, Some(files)) => {
|
||||||
for f in 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) {
|
if !fsx::safe_join(&path, f).map(|p| p.is_file()).unwrap_or(false) {
|
||||||
problems.push(format!("configuration file {f} is missing"));
|
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 })
|
Ok(VerifyReport { ok: problems.is_empty(), problems })
|
||||||
@@ -280,6 +321,11 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
|
|||||||
|
|
||||||
/// Delete one recovery point (its own folder only).
|
/// Delete one recovery point (its own folder only).
|
||||||
pub fn delete(meta: &Path, id: &str) -> Result<()> {
|
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)?;
|
let dir = point_dir(meta, id)?;
|
||||||
get(meta, id)?; // must be a real recovery point
|
get(meta, id)?; // must be a real recovery point
|
||||||
fs::remove_dir_all(dir)?;
|
fs::remove_dir_all(dir)?;
|
||||||
@@ -289,6 +335,9 @@ pub fn delete(meta: &Path, id: &str) -> Result<()> {
|
|||||||
/// Put configuration files back. Files the backup does not contain are left alone. A safety point is taken first.
|
/// Put configuration files back. Files the backup does not contain are left alone. A safety point is taken first.
|
||||||
pub fn restore_configs(root: &Path, meta: &Path, id: &str) -> Result<RecoveryPoint> {
|
pub fn restore_configs(root: &Path, meta: &Path, id: &str) -> Result<RecoveryPoint> {
|
||||||
let point = get(meta, id)?;
|
let point = get(meta, id)?;
|
||||||
|
if point.realm != crate::realms::state(root)?.active {
|
||||||
|
return Err(Error::Invalid("Select the realm this backup belongs to before restoring it.".into()));
|
||||||
|
}
|
||||||
let comp = point.components.iter().find(|c| c.name == "configs").ok_or_else(|| Error::Invalid("this backup has no configuration".into()))?;
|
let comp = point.components.iter().find(|c| c.name == "configs").ok_or_else(|| Error::Invalid("this backup has no configuration".into()))?;
|
||||||
if !verify(meta, id)?.ok {
|
if !verify(meta, id)?.ok {
|
||||||
return Err(Error::Invalid("This backup is damaged and cannot be restored.".into()));
|
return Err(Error::Invalid("This backup is damaged and cannot be restored.".into()));
|
||||||
@@ -314,23 +363,27 @@ pub struct DbRestore {
|
|||||||
/// import into a staging schema, sanity-check it, then swap tables atomically and keep the old schema.
|
/// import into a staging schema, sanity-check it, then swap tables atomically and keep the old schema.
|
||||||
pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Result<DbRestore> {
|
pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Result<DbRestore> {
|
||||||
let point = get(meta, id)?;
|
let point = get(meta, id)?;
|
||||||
|
if point.realm != crate::realms::state(root)?.active {
|
||||||
|
return Err(Error::Invalid("Select the realm this backup belongs to before restoring it.".into()));
|
||||||
|
}
|
||||||
let comp = point.components.iter().find(|c| c.name == name && c.sha256.is_some()).ok_or_else(|| Error::Invalid(format!("this backup has no {name} database")))?;
|
let comp = point.components.iter().find(|c| c.name == name && c.sha256.is_some()).ok_or_else(|| Error::Invalid(format!("this backup has no {name} database")))?;
|
||||||
if !verify(meta, id)?.ok {
|
if !verify(meta, id)?.ok {
|
||||||
return Err(Error::Invalid("This backup is damaged and cannot be restored.".into()));
|
return Err(Error::Invalid("This backup is damaged and cannot be restored.".into()));
|
||||||
}
|
}
|
||||||
let now = process::observe(root, &read_ports(root));
|
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()));
|
return Err(Error::Invalid("Stop the server before restoring a database.".into()));
|
||||||
}
|
}
|
||||||
let live = db::schema_of(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 expected_tables = comp.tables.unwrap_or(0);
|
||||||
let dump = point_dir(meta, id)?.join(&comp.path);
|
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.
|
// 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}")), &|_| {})?;
|
let safety = create(root, meta, Kind::Database, Trigger::BeforeRestore, Some(format!("before restoring {name} from {id}")), &|_| {})?;
|
||||||
|
|
||||||
with_database(root, |db| {
|
with_database(root, |db| {
|
||||||
|
let db = db.clone().for_realm(crate::realms::Mode::Coa);
|
||||||
let staging = format!("{live}_restore_{stamp}");
|
let staging = format!("{live}_restore_{stamp}");
|
||||||
let old = format!("{live}_before_restore_{stamp}");
|
let old = format!("{live}_before_restore_{stamp}");
|
||||||
if db.schema_exists(&staging)? || db.schema_exists(&old)? {
|
if db.schema_exists(&staging)? || db.schema_exists(&old)? {
|
||||||
@@ -341,7 +394,7 @@ pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Resul
|
|||||||
db.import_from(&staging, &dump)?;
|
db.import_from(&staging, &dump)?;
|
||||||
// 3. Sanity checks.
|
// 3. Sanity checks.
|
||||||
let staged = db.tables(&staging)?;
|
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())));
|
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 {
|
if db.extra_objects(&staging)? > 0 || db.extra_objects(live)? > 0 {
|
||||||
@@ -357,7 +410,7 @@ pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Resul
|
|||||||
for t in &staged {
|
for t in &staged {
|
||||||
renames.push(format!("`{staging}`.`{t}` TO `{live}`.`{t}`"));
|
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() })
|
Ok(DbRestore { previous_schema: old, safety_backup: safety.id.clone(), tables_restored: staged.len() })
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -379,6 +432,36 @@ mod tests {
|
|||||||
(dir, root, meta)
|
(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]
|
#[test]
|
||||||
fn config_backup_excludes_secrets_and_clutter_and_restores_byte_exact() {
|
fn config_backup_excludes_secrets_and_clutter_and_restores_byte_exact() {
|
||||||
let (_d, root, meta) = setup();
|
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 {
|
if let Some(b) = p.bots {
|
||||||
sql.extend(collect_bots_sql(b)?);
|
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 staging = std::env::temp_dir().join("coa-cleanbase-sql");
|
||||||
let _ = fs::remove_dir_all(&staging);
|
let _ = fs::remove_dir_all(&staging);
|
||||||
for f in &sql {
|
for f in &sql {
|
||||||
@@ -218,12 +218,17 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
|
|||||||
db.query(&sql)?;
|
db.query(&sql)?;
|
||||||
// 2. characters: a brand-new schema from the core's base scripts
|
// 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;")?;
|
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 {
|
for f in &base_chars {
|
||||||
db.run_sql_file("acore_characters", f)?;
|
db.run_sql_file("acore_characters", f)?;
|
||||||
}
|
}
|
||||||
// 3. every migration up to the core commit (already-recorded ones are skipped)
|
// 3. every migration up to the core commit (already-recorded ones are skipped)
|
||||||
let before = status(db, &migrations)?;
|
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()));
|
say(&format!("Applying {} database updates", pending.len()));
|
||||||
let report = apply_pending(db, &pending, &staging, &|| Ok("(scratch database)".into()))?;
|
let report = apply_pending(db, &pending, &staging, &|| Ok("(scratch database)".into()))?;
|
||||||
if let Some((id, why)) = report.failed {
|
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 {
|
if accounts != "0" || chars != "0" || templates != 21 {
|
||||||
return Err(Error::Invalid(format!("The database is not clean ({accounts} accounts, {chars} player characters, {templates} templates).")));
|
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(())
|
Ok(())
|
||||||
})?;
|
})?;
|
||||||
|
|
||||||
@@ -270,7 +279,7 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
|
|||||||
fsx::atomic_write_json(&repack_json, &shipped)?;
|
fsx::atomic_write_json(&repack_json, &shipped)?;
|
||||||
|
|
||||||
say("Adding the release files");
|
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 {
|
if let Some(data) = p.data {
|
||||||
say("Copying game data");
|
say("Copying game data");
|
||||||
fs::create_dir_all(p.out.join("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).
|
//! `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::collections::BTreeMap;
|
||||||
use std::fs;
|
use std::fs;
|
||||||
@@ -15,6 +16,67 @@ use crate::fsx;
|
|||||||
pub const ADDON_NAME: &str = "CoABotUI";
|
pub const ADDON_NAME: &str = "CoABotUI";
|
||||||
const EXECUTABLES: [&str; 3] = ["Ascension.exe", "Wow.exe", "WoW.exe"];
|
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)]
|
#[derive(Debug, Clone, Serialize)]
|
||||||
pub struct Realmlist {
|
pub struct Realmlist {
|
||||||
pub path: String,
|
pub path: String,
|
||||||
@@ -118,7 +180,7 @@ fn backup_dir(meta: &Path) -> PathBuf {
|
|||||||
meta.join("backups").join("client")
|
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('-')
|
!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 {
|
mod tests {
|
||||||
use super::*;
|
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 {
|
fn fake_client(d: &Path) -> PathBuf {
|
||||||
let c = d.join("wow");
|
let c = d.join("wow");
|
||||||
fs::create_dir_all(c.join("Data/enUS")).unwrap();
|
fs::create_dir_all(c.join("Data/enUS")).unwrap();
|
||||||
|
|||||||
@@ -67,7 +67,12 @@ pub fn targets(root: &Path, scope: Scope) -> Result<Targets> {
|
|||||||
Scope::Bots => {
|
Scope::Bots => {
|
||||||
let conf = root.join("Core/configs/modules/mod_coa_playerbots.conf");
|
let conf = root.join("Core/configs/modules/mod_coa_playerbots.conf");
|
||||||
if !conf.is_file() {
|
if !conf.is_file() {
|
||||||
return Err(Error::Invalid("CoA Companions (bots) are not installed on this server.".into()));
|
// The server ships the documented defaults as `.dist` and uses them until an active file exists: make it.
|
||||||
|
let dist = root.join("Core/configs/modules/mod_coa_playerbots.conf.dist");
|
||||||
|
if !dist.is_file() {
|
||||||
|
return Err(Error::Invalid("CoA Companions (bots) are not installed on this server.".into()));
|
||||||
|
}
|
||||||
|
fsx::atomic_write(&conf, &fs::read(&dist)?)?;
|
||||||
}
|
}
|
||||||
Ok(Targets { read: conf.clone(), writes: vec![conf], generated: None })
|
Ok(Targets { read: conf.clone(), writes: vec![conf], generated: None })
|
||||||
}
|
}
|
||||||
@@ -126,6 +131,17 @@ pub struct SettingsView {
|
|||||||
/// so a server updated to a build with a new setting gets that setting's documented default. Files the launcher writes
|
/// so a server updated to a build with a new setting gets that setting's documented default. Files the launcher writes
|
||||||
/// itself are skipped. Returns what was created (`name.conf`) or extended (`name.conf (+n keys)`).
|
/// itself are skipped. Returns what was created (`name.conf`) or extended (`name.conf (+n keys)`).
|
||||||
pub fn materialize_module_configs(root: &Path) -> Result<Vec<String>> {
|
pub fn materialize_module_configs(root: &Path) -> Result<Vec<String>> {
|
||||||
|
materialize(root, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Only the missing active files, created from their `.dist`; a file that exists is not touched at all. This is what a
|
||||||
|
/// server the Manager imported (not installed) gets: without its file a module logs a "missing property" line for every
|
||||||
|
/// setting it reads, and some modules read them on every world tick.
|
||||||
|
pub fn create_missing_module_configs(root: &Path) -> Result<Vec<String>> {
|
||||||
|
materialize(root, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn materialize(root: &Path, extend_existing: bool) -> Result<Vec<String>> {
|
||||||
let dir = root.join("Core").join("configs").join("modules");
|
let dir = root.join("Core").join("configs").join("modules");
|
||||||
let mut created = Vec::new();
|
let mut created = Vec::new();
|
||||||
let Ok(entries) = fs::read_dir(&dir) else { return Ok(created) };
|
let Ok(entries) = fs::read_dir(&dir) else { return Ok(created) };
|
||||||
@@ -150,6 +166,8 @@ pub fn materialize_module_configs(root: &Path) -> Result<Vec<String>> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
created.push(format!("{stem}.conf"));
|
created.push(format!("{stem}.conf"));
|
||||||
|
} else if !extend_existing {
|
||||||
|
continue;
|
||||||
} else if let (Ok(have), Ok(dist)) = (fs::read(&active), fs::read(e.path())) {
|
} else if let (Ok(have), Ok(dist)) = (fs::read(&active), fs::read(e.path())) {
|
||||||
if let (Ok(mut conf), Ok(dist)) = (parser::ConfFile::parse_bytes(&have), parser::ConfFile::parse_bytes(&dist)) {
|
if let (Ok(mut conf), Ok(dist)) = (parser::ConfFile::parse_bytes(&have), parser::ConfFile::parse_bytes(&dist)) {
|
||||||
let plan = merge::apply(&mut conf, &dist);
|
let plan = merge::apply(&mut conf, &dist);
|
||||||
@@ -323,9 +341,23 @@ pub struct SnapshotInfo {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn take_snapshot(meta_dir: &Path, scope: Scope, reason: &str, files: &[(PathBuf, Vec<u8>)]) -> Result<String> {
|
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 root = snapshot_root(meta_dir);
|
||||||
let dir = snapshot_root(meta_dir).join(&id);
|
fs::create_dir_all(&root)?;
|
||||||
fs::create_dir_all(&dir)?;
|
// 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();
|
let mut entries = Vec::new();
|
||||||
for (i, (path, bytes)) in files.iter().enumerate() {
|
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());
|
let stored = format!("{i}_{}", path.file_name().map(|n| n.to_string_lossy().into_owned()).unwrap_or_default());
|
||||||
@@ -418,6 +450,7 @@ fn quiet_debug_loggers(root: &Path) -> Result<Vec<String>> {
|
|||||||
|
|
||||||
/// Apply validated `changes`. Nothing is written unless every change is valid; previous contents are snapshotted first.
|
/// Apply validated `changes`. Nothing is written unless every change is valid; previous contents are snapshotted first.
|
||||||
pub fn save(root: &Path, meta_dir: &Path, scope: Scope, changes: &BTreeMap<String, Value>) -> Result<SaveReport> {
|
pub fn save(root: &Path, meta_dir: &Path, scope: Scope, changes: &BTreeMap<String, Value>) -> Result<SaveReport> {
|
||||||
|
if scope == Scope::Bots { crate::realms::guard_module(root, "companions")?; }
|
||||||
let raws = validate(root, scope, changes)?;
|
let raws = validate(root, scope, changes)?;
|
||||||
let schema = scope.schema();
|
let schema = scope.schema();
|
||||||
let t = targets(root, scope)?;
|
let t = targets(root, scope)?;
|
||||||
@@ -625,6 +658,24 @@ Spellbook.New = 5
|
|||||||
assert!(materialize_module_configs(&root).unwrap().is_empty());
|
assert!(materialize_module_configs(&root).unwrap().is_empty());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn an_imported_server_only_gets_the_files_it_lacks() {
|
||||||
|
let (_d, root, _m) = fixture();
|
||||||
|
let m = root.join("Core/configs/modules");
|
||||||
|
fs::create_dir_all(&m).unwrap();
|
||||||
|
fs::write(m.join("dynamicxp.conf.dist"), "Dynamic.XP.Reminder.Interval = 40
|
||||||
|
").unwrap();
|
||||||
|
fs::write(m.join("spellbook.conf.dist"), "Spellbook.Enable = 1
|
||||||
|
Spellbook.New = 5
|
||||||
|
").unwrap();
|
||||||
|
fs::write(m.join("spellbook.conf"), "Spellbook.Enable = 0
|
||||||
|
").unwrap();
|
||||||
|
assert_eq!(create_missing_module_configs(&root).unwrap(), vec!["dynamicxp.conf".to_string()]);
|
||||||
|
assert!(fs::read_to_string(m.join("dynamicxp.conf")).unwrap().contains("Dynamic.XP.Reminder.Interval = 40"));
|
||||||
|
assert_eq!(fs::read_to_string(m.join("spellbook.conf")).unwrap(), "Spellbook.Enable = 0
|
||||||
|
", "an existing file stays byte for byte");
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn schemas_and_presets_are_self_consistent() {
|
fn schemas_and_presets_are_self_consistent() {
|
||||||
for scope in [Scope::Bots, Scope::Server] {
|
for scope in [Scope::Bots, Scope::Server] {
|
||||||
@@ -711,6 +762,21 @@ Spellbook.New = 5
|
|||||||
assert!(restore_snapshot(&meta, "../evil").is_err());
|
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]
|
#[test]
|
||||||
fn a_repeated_key_with_the_same_effective_value_is_not_drift() {
|
fn a_repeated_key_with_the_same_effective_value_is_not_drift() {
|
||||||
let (_d, root, _m) = fixture();
|
let (_d, root, _m) = fixture();
|
||||||
@@ -753,9 +819,15 @@ Logger.x=6,Console Server
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn bots_scope_requires_the_module_config() {
|
fn bots_scope_requires_the_module_config_or_its_default_file() {
|
||||||
let (_d, root, _m) = fixture();
|
let (_d, root, _m) = fixture();
|
||||||
fs::remove_file(root.join("Core/configs/modules/mod_coa_playerbots.conf")).unwrap();
|
let modules = root.join("Core/configs/modules");
|
||||||
assert!(load(&root, Scope::Bots).is_err());
|
let conf = modules.join("mod_coa_playerbots.conf");
|
||||||
|
let text = fs::read(&conf).unwrap();
|
||||||
|
fs::remove_file(&conf).unwrap();
|
||||||
|
assert!(load(&root, Scope::Bots).is_err(), "neither file: not installed");
|
||||||
|
fs::write(modules.join("mod_coa_playerbots.conf.dist"), &text).unwrap();
|
||||||
|
assert!(load(&root, Scope::Bots).is_ok(), "only the default file: it is made");
|
||||||
|
assert!(conf.is_file());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
+219
-5
@@ -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.
|
//! Passwords travel only in the child's environment (`MYSQL_PWD`), never on a command line or in a log.
|
||||||
|
|
||||||
@@ -44,6 +45,9 @@ pub struct Db {
|
|||||||
port: u16,
|
port: u16,
|
||||||
user: &'static str,
|
user: &'static str,
|
||||||
password: Secret,
|
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)]
|
#[derive(Deserialize)]
|
||||||
@@ -67,6 +71,9 @@ fn no_window(cmd: &mut Command) {
|
|||||||
pub const SCHEMAS: [(&str, &str); 3] = [("characters", "acore_characters"), ("auth", "acore_auth"), ("world", "acore_world")];
|
pub const SCHEMAS: [(&str, &str); 3] = [("characters", "acore_characters"), ("auth", "acore_auth"), ("world", "acore_world")];
|
||||||
|
|
||||||
pub fn schema_of(kind: &str) -> Result<&'static str> {
|
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}")))
|
SCHEMAS.iter().find(|(k, _)| *k == kind).map(|(_, s)| *s).ok_or_else(|| Error::Invalid(format!("unknown database {kind}")))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -74,11 +81,21 @@ fn ident_ok(name: &str) -> bool {
|
|||||||
!name.is_empty() && name.len() <= 64 && name.chars().all(|c| c.is_ascii_alphanumeric() || c == '_')
|
!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 {
|
impl Db {
|
||||||
pub fn from_repack(root: &Path, account: Account) -> Result<Db> {
|
pub fn from_repack(root: &Path, account: Account) -> Result<Db> {
|
||||||
let creds: Credentials = fsx::read_json(&root.join("Settings/database.json"))
|
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()))?;
|
.map_err(|_| Error::Invalid("The database settings of this server could not be read.".into()))?;
|
||||||
let ports: Ports = read_ports(root);
|
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");
|
let bin = root.join("mysql/bin");
|
||||||
if !bin.join("mysqldump.exe").is_file() || !bin.join("mysql.exe").is_file() {
|
if !bin.join("mysqldump.exe").is_file() || !bin.join("mysql.exe").is_file() {
|
||||||
return Err(Error::Invalid("The bundled database tools are missing.".into()));
|
return Err(Error::Invalid("The bundled database tools are missing.".into()));
|
||||||
@@ -87,11 +104,64 @@ impl Db {
|
|||||||
Account::Admin => ("root", creds.root_password),
|
Account::Admin => ("root", creds.root_password),
|
||||||
Account::App => ("acore", creds.app_password),
|
Account::App => ("acore", creds.app_password),
|
||||||
};
|
};
|
||||||
Ok(Db { bin, port: ports.mysql, user, password: Secret(password) })
|
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 {
|
||||||
|
match name {
|
||||||
|
"acore_world" => "acore_world_wildcard",
|
||||||
|
"acore_characters" => "acore_characters_wildcard",
|
||||||
|
_ => name,
|
||||||
|
}
|
||||||
|
} else { name }
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn clone_structure(&self, source: &str, dest: &str, cache: &Path) -> Result<()> {
|
||||||
|
if !ident_ok(source) || !ident_ok(dest) { return Err(Error::Invalid("Invalid schema name.".into())); }
|
||||||
|
let path = cache.join("characters-structure.sql");
|
||||||
|
self.dump_structure_to(source, &path)?;
|
||||||
|
self.run_sql_file(dest, &path)?;
|
||||||
|
std::fs::remove_file(path)?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn dump_structure_to(&self, source: &str, path: &Path) -> Result<()> {
|
||||||
|
if !ident_ok(source) { return Err(Error::Invalid("Invalid schema name.".into())); }
|
||||||
|
let mut c = self.command("mysqldump.exe");
|
||||||
|
c.args(["--no-data", "--no-tablespaces", "--skip-comments", "--default-character-set=utf8mb4", source]);
|
||||||
|
c.stdout(Stdio::from(File::create(&path)?));
|
||||||
|
let out = c.output()?;
|
||||||
|
if !out.status.success() { return Err(self.fail(&out.stderr)); }
|
||||||
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn command(&self, tool: &str) -> Command {
|
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())
|
c.env("MYSQL_PWD", self.password.expose())
|
||||||
.arg("--protocol=tcp")
|
.arg("--protocol=tcp")
|
||||||
.arg("--host=127.0.0.1")
|
.arg("--host=127.0.0.1")
|
||||||
@@ -106,7 +176,8 @@ impl Db {
|
|||||||
|
|
||||||
fn fail(&self, stderr: &[u8]) -> Error {
|
fn fail(&self, stderr: &[u8]) -> Error {
|
||||||
let text = String::from_utf8_lossy(stderr);
|
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 {
|
match code {
|
||||||
ErrorCode::DatabaseNotRunning => Error::Invalid("The database is not running. Start the server first.".into()),
|
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(""))),
|
_ => Error::Invalid(format!("database command failed: {}", text.trim().lines().last().unwrap_or(""))),
|
||||||
@@ -123,9 +194,10 @@ impl Db {
|
|||||||
pub fn query(&self, sql: &str) -> Result<String> {
|
pub fn query(&self, sql: &str) -> Result<String> {
|
||||||
let mut c = self.command("mysql.exe");
|
let mut c = self.command("mysql.exe");
|
||||||
c.args(["--batch", "--skip-column-names", "--connect-timeout=5"]);
|
c.args(["--batch", "--skip-column-names", "--connect-timeout=5"]);
|
||||||
|
c.args(["--default-character-set=utf8mb4", "--max-allowed-packet=128M"]);
|
||||||
c.stdin(Stdio::piped());
|
c.stdin(Stdio::piped());
|
||||||
let mut child = c.spawn()?;
|
let mut child = c.spawn()?;
|
||||||
child.stdin.take().expect("piped").write_all(sql.as_bytes())?;
|
child.stdin.take().expect("piped").write_all(route_sql(sql, self.realm).as_bytes())?;
|
||||||
let out = child.wait_with_output()?;
|
let out = child.wait_with_output()?;
|
||||||
if !out.status.success() {
|
if !out.status.success() {
|
||||||
return Err(self.fail(&out.stderr));
|
return Err(self.fail(&out.stderr));
|
||||||
@@ -134,6 +206,7 @@ impl Db {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn schema_exists(&self, name: &str) -> Result<bool> {
|
pub fn schema_exists(&self, name: &str) -> Result<bool> {
|
||||||
|
let name = self.realm_schema(name);
|
||||||
if !ident_ok(name) {
|
if !ident_ok(name) {
|
||||||
return Err(Error::Invalid("bad schema name".into()));
|
return Err(Error::Invalid("bad schema name".into()));
|
||||||
}
|
}
|
||||||
@@ -141,6 +214,7 @@ impl Db {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn tables(&self, schema: &str) -> Result<Vec<String>> {
|
pub fn tables(&self, schema: &str) -> Result<Vec<String>> {
|
||||||
|
let schema = self.realm_schema(schema);
|
||||||
if !ident_ok(schema) {
|
if !ident_ok(schema) {
|
||||||
return Err(Error::Invalid("bad schema name".into()));
|
return Err(Error::Invalid("bad schema name".into()));
|
||||||
}
|
}
|
||||||
@@ -150,6 +224,7 @@ impl Db {
|
|||||||
|
|
||||||
/// Bytes of data + index the schema occupies (used to estimate backup size).
|
/// Bytes of data + index the schema occupies (used to estimate backup size).
|
||||||
pub fn schema_bytes(&self, schema: &str) -> Result<u64> {
|
pub fn schema_bytes(&self, schema: &str) -> Result<u64> {
|
||||||
|
let schema = self.realm_schema(schema);
|
||||||
if !ident_ok(schema) {
|
if !ident_ok(schema) {
|
||||||
return Err(Error::Invalid("bad schema name".into()));
|
return Err(Error::Invalid("bad schema name".into()));
|
||||||
}
|
}
|
||||||
@@ -159,6 +234,7 @@ impl Db {
|
|||||||
|
|
||||||
/// Stored routines / triggers / views make a table-level swap unsafe; count them.
|
/// Stored routines / triggers / views make a table-level swap unsafe; count them.
|
||||||
pub fn extra_objects(&self, schema: &str) -> Result<u64> {
|
pub fn extra_objects(&self, schema: &str) -> Result<u64> {
|
||||||
|
let schema = self.realm_schema(schema);
|
||||||
if !ident_ok(schema) {
|
if !ident_ok(schema) {
|
||||||
return Err(Error::Invalid("bad schema name".into()));
|
return Err(Error::Invalid("bad schema name".into()));
|
||||||
}
|
}
|
||||||
@@ -170,6 +246,7 @@ impl Db {
|
|||||||
|
|
||||||
/// Consistent dump of one schema, zstd-compressed to `out`. Returns (compressed bytes, sha256 of the file).
|
/// Consistent dump of one schema, zstd-compressed to `out`. Returns (compressed bytes, sha256 of the file).
|
||||||
pub fn dump_to(&self, schema: &str, out: &Path) -> Result<(u64, String)> {
|
pub fn dump_to(&self, schema: &str, out: &Path) -> Result<(u64, String)> {
|
||||||
|
let schema = self.realm_schema(schema);
|
||||||
if !ident_ok(schema) {
|
if !ident_ok(schema) {
|
||||||
return Err(Error::Invalid("bad schema name".into()));
|
return Err(Error::Invalid("bad schema name".into()));
|
||||||
}
|
}
|
||||||
@@ -203,9 +280,15 @@ impl Db {
|
|||||||
|
|
||||||
/// Run a plain SQL file against `schema`; the first error aborts and is returned.
|
/// Run a plain SQL file against `schema`; the first error aborts and is returned.
|
||||||
pub fn run_sql_file(&self, schema: &str, file: &Path) -> Result<()> {
|
pub fn run_sql_file(&self, schema: &str, file: &Path) -> Result<()> {
|
||||||
|
let schema = self.realm_schema(schema);
|
||||||
if !ident_ok(schema) {
|
if !ident_ok(schema) {
|
||||||
return Err(Error::Invalid("bad schema name".into()));
|
return Err(Error::Invalid("bad schema name".into()));
|
||||||
}
|
}
|
||||||
|
if self.realm == crate::realms::Mode::Wildcard {
|
||||||
|
let sql = std::fs::read_to_string(file)?;
|
||||||
|
self.query(&format!("SET NAMES utf8mb4 COLLATE utf8mb4_unicode_ci; USE `{schema}`;\n{sql}"))?;
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
let mut c = self.command("mysql.exe");
|
let mut c = self.command("mysql.exe");
|
||||||
c.args(["--default-character-set=utf8mb4", "--init-command=SET NAMES utf8mb4 COLLATE utf8mb4_unicode_ci", "--max-allowed-packet=128M"]);
|
c.args(["--default-character-set=utf8mb4", "--init-command=SET NAMES utf8mb4 COLLATE utf8mb4_unicode_ci", "--max-allowed-packet=128M"]);
|
||||||
c.arg(schema);
|
c.arg(schema);
|
||||||
@@ -219,6 +302,7 @@ impl Db {
|
|||||||
|
|
||||||
/// Import a dump produced by `dump_to` into `schema` (which must already exist and be empty).
|
/// Import a dump produced by `dump_to` into `schema` (which must already exist and be empty).
|
||||||
pub fn import_from(&self, schema: &str, dump: &Path) -> Result<()> {
|
pub fn import_from(&self, schema: &str, dump: &Path) -> Result<()> {
|
||||||
|
let schema = self.realm_schema(schema);
|
||||||
if !ident_ok(schema) {
|
if !ident_ok(schema) {
|
||||||
return Err(Error::Invalid("bad schema name".into()));
|
return Err(Error::Invalid("bad schema name".into()));
|
||||||
}
|
}
|
||||||
@@ -278,3 +362,133 @@ pub fn write_console_credentials(root: &Path, password: &str) -> Result<()> {
|
|||||||
pub fn valid_identifier(name: &str) -> bool {
|
pub fn valid_identifier(name: &str) -> bool {
|
||||||
ident_ok(name)
|
ident_ok(name)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Route only SQL identifiers. User names, values, comments and longer identifiers remain untouched.
|
||||||
|
fn route_sql(sql: &str, realm: crate::realms::Mode) -> String {
|
||||||
|
if realm == crate::realms::Mode::Coa { return sql.into(); }
|
||||||
|
let bytes = sql.as_bytes();
|
||||||
|
let mut out = String::new();
|
||||||
|
let mut i = 0;
|
||||||
|
while i < bytes.len() {
|
||||||
|
let start = i;
|
||||||
|
if matches!(bytes[i], b'\'' | b'"') {
|
||||||
|
let quote = bytes[i]; i += 1;
|
||||||
|
while i < bytes.len() {
|
||||||
|
if bytes[i] == b'\\' { i = (i + 2).min(bytes.len()); }
|
||||||
|
else if bytes[i] == quote {
|
||||||
|
i += 1;
|
||||||
|
if i < bytes.len() && bytes[i] == quote { i += 1; } else { break; }
|
||||||
|
} else { i += 1; }
|
||||||
|
}
|
||||||
|
out.push_str(&sql[start..i]);
|
||||||
|
} else if bytes[i] == b'#' || sql[i..].starts_with("--") || sql[i..].starts_with("/*") {
|
||||||
|
if sql[i..].starts_with("/*") {
|
||||||
|
i = sql[i + 2..].find("*/").map(|p| i + p + 4).unwrap_or(bytes.len());
|
||||||
|
} else { i = sql[i..].find('\n').map(|p| i + p).unwrap_or(bytes.len()); }
|
||||||
|
out.push_str(&sql[start..i]);
|
||||||
|
} else if bytes[i].is_ascii_alphanumeric() || bytes[i] == b'_' {
|
||||||
|
while i < bytes.len() && (bytes[i].is_ascii_alphanumeric() || bytes[i] == b'_') { i += 1; }
|
||||||
|
out.push_str(match &sql[start..i] {
|
||||||
|
"acore_world" => "acore_world_wildcard",
|
||||||
|
"acore_characters" => "acore_characters_wildcard",
|
||||||
|
other => other,
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
let c = sql[i..].chars().next().unwrap(); out.push(c); i += c.len_utf8();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod realm_tests {
|
||||||
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn routes_schema_identifiers_without_rewriting_account_values() {
|
||||||
|
let sql = "SELECT * FROM `acore_characters`.characters WHERE name='acore_world' AND x=\"acore_characters\"; -- acore_world\nSELECT * FROM acore_world.items;";
|
||||||
|
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 ports = layout::read_ports(root);
|
||||||
let o = process::observe(root, &ports);
|
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) {
|
let (lvl, text) = match (s.state, &s.conflict) {
|
||||||
(ServiceState::Running, _) => (Level::Ok, "Running".to_string()),
|
(ServiceState::Running, _) => (Level::Ok, "Running".to_string()),
|
||||||
(_, Some(conf)) => (Level::Fail, format!("Port {} is used by another program (process {}).", conf.port, conf.pid)),
|
(_, 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> {
|
pub fn verify_managed(root: &Path, meta: &InstallMeta) -> Vec<FileProblem> {
|
||||||
let mut out = Vec::new();
|
let mut out = Vec::new();
|
||||||
for (rel, want) in &meta.original_hashes {
|
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 };
|
let Ok(p) = fsx::safe_join(root, rel) else { continue };
|
||||||
match fsx::sha256_file(&p) {
|
match fsx::sha256_file(&p) {
|
||||||
Err(_) => out.push(FileProblem { path: rel.clone(), kind: "missing" }),
|
Err(_) => out.push(FileProblem { path: rel.clone(), kind: "missing" }),
|
||||||
@@ -143,6 +147,31 @@ fn tail(path: &Path, max: u64) -> Vec<u8> {
|
|||||||
b
|
b
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Keep the first line of each repeated "Missing property X" warning and report how often it came.
|
||||||
|
pub fn squash_repeated_config_warnings(text: &str) -> String {
|
||||||
|
let mut counts: Vec<(String, usize)> = Vec::new();
|
||||||
|
let mut out: Vec<&str> = Vec::new();
|
||||||
|
for line in text.lines() {
|
||||||
|
let key = line.strip_prefix("> Config: Missing property ").and_then(|r| r.split_whitespace().next());
|
||||||
|
match key {
|
||||||
|
Some(k) => match counts.iter_mut().find(|(n, _)| n == k) {
|
||||||
|
Some((_, c)) => *c += 1,
|
||||||
|
None => {
|
||||||
|
counts.push((k.to_string(), 1));
|
||||||
|
out.push(line);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
None => out.push(line),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let mut s = out.join("\n");
|
||||||
|
for (k, c) in counts.iter().filter(|(_, c)| *c > 1) {
|
||||||
|
s.push_str(&format!("
|
||||||
|
[Manager: \"Missing property {k}\" was logged {c} times in this excerpt]"));
|
||||||
|
}
|
||||||
|
s
|
||||||
|
}
|
||||||
|
|
||||||
/// Remove things that must never leave the machine from log text.
|
/// Remove things that must never leave the machine from log text.
|
||||||
pub fn redact(text: &str) -> String {
|
pub fn redact(text: &str) -> String {
|
||||||
let mut out = Vec::new();
|
let mut out = Vec::new();
|
||||||
@@ -170,6 +199,7 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
|
|||||||
"manager": crate::MANAGER_VERSION,
|
"manager": crate::MANAGER_VERSION,
|
||||||
"core": meta.core,
|
"core": meta.core,
|
||||||
"bots": meta.bots,
|
"bots": meta.bots,
|
||||||
|
"squid_bots": crate::squid::release(root),
|
||||||
"kind": meta.kind,
|
"kind": meta.kind,
|
||||||
"layout": meta.layout,
|
"layout": meta.layout,
|
||||||
"checks": report.checks,
|
"checks": report.checks,
|
||||||
@@ -177,9 +207,33 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
|
|||||||
});
|
});
|
||||||
add("summary.json", serde_json::to_string_pretty(&summary)?.as_bytes())?;
|
add("summary.json", serde_json::to_string_pretty(&summary)?.as_bytes())?;
|
||||||
for (name, path) in [("manager.log", manager_log.to_path_buf()), ("manager-install.log", meta_dir.join("logs/manager.log")), ("Server.log.tail", root.join("Core/Logs/Server.log")), ("Errors.log.tail", root.join("Core/Logs/Errors.log")), ("Auth.log.tail", root.join("Core/Logs/Auth.log")), ("world-console.log.tail", root.join("Core/Logs/world-console.log")), ("mysql-error.log.tail", root.join("mysql/logs/mysql-error.log"))] {
|
for (name, path) in [("manager.log", manager_log.to_path_buf()), ("manager-install.log", meta_dir.join("logs/manager.log")), ("Server.log.tail", root.join("Core/Logs/Server.log")), ("Errors.log.tail", root.join("Core/Logs/Errors.log")), ("Auth.log.tail", root.join("Core/Logs/Auth.log")), ("world-console.log.tail", root.join("Core/Logs/world-console.log")), ("mysql-error.log.tail", root.join("mysql/logs/mysql-error.log"))] {
|
||||||
let bytes = tail(&path, 512 * 1024);
|
// A module that reads a missing setting on every tick fills a log with one warning, thousands of times; read far
|
||||||
|
// enough back to see past that, fold the repeats, then keep the last part.
|
||||||
|
let bytes = tail(&path, 8 * 1024 * 1024);
|
||||||
if !bytes.is_empty() {
|
if !bytes.is_empty() {
|
||||||
add(name, redact(&String::from_utf8_lossy(&bytes)).as_bytes())?;
|
let text = squash_repeated_config_warnings(&String::from_utf8_lossy(&bytes));
|
||||||
|
let keep = text.len().saturating_sub(512 * 1024);
|
||||||
|
let start = (keep..text.len()).find(|i| text.is_char_boundary(*i)).unwrap_or(text.len());
|
||||||
|
add(name, redact(&text[start..]).as_bytes())?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Which files the server's own configuration folders hold, and the two CoA switches that decide whether the game
|
||||||
|
// client can talk to the world server at all.
|
||||||
|
let mut present = String::new();
|
||||||
|
for dir in ["Core/configs", "Core/configs/modules", "Core/Logs"] {
|
||||||
|
if let Ok(rd) = fs::read_dir(root.join(dir)) {
|
||||||
|
let mut names: Vec<String> = rd.flatten().filter(|e| e.path().is_file()).map(|e| format!("{dir}/{} ({} bytes)", e.file_name().to_string_lossy(), e.metadata().map(|m| m.len()).unwrap_or(0))).collect();
|
||||||
|
names.sort();
|
||||||
|
present.push_str(&names.join("\n"));
|
||||||
|
present.push('\n');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
add("files.txt", present.as_bytes())?;
|
||||||
|
if let Ok(b) = fs::read(root.join("Core/configs/modules/coa.conf")) {
|
||||||
|
if let Ok(c) = ConfFile::parse_bytes(&b) {
|
||||||
|
let wanted = ["CoA.Enable", "CoA.AllowRemoteClients", "CoA.MapClass10ToWarrior"];
|
||||||
|
let lines: Vec<String> = c.entries().filter(|(k, _)| wanted.contains(k)).map(|(k, v)| format!("{k} = {v}")).collect();
|
||||||
|
add("coa.conf.txt", lines.join("\n").as_bytes())?;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// Which settings exist, never their values.
|
// Which settings exist, never their values.
|
||||||
@@ -192,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")) {
|
if let Ok(b) = fs::read(root.join("RELEASE.json")) {
|
||||||
add("RELEASE.json", redact(&String::from_utf8_lossy(&b)).as_bytes())?;
|
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()))?;
|
zip.finish().map_err(|e| Error::Invalid(e.to_string()))?;
|
||||||
Ok(n)
|
Ok(n)
|
||||||
}
|
}
|
||||||
@@ -210,6 +267,21 @@ mod tests {
|
|||||||
use super::*;
|
use super::*;
|
||||||
use crate::registry::{InstallKind, InstallMeta};
|
use crate::registry::{InstallKind, InstallMeta};
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn repeated_config_warnings_are_folded() {
|
||||||
|
let t = "start
|
||||||
|
> Config: Missing property A.B in config file x or module config, add y
|
||||||
|
> Config: Missing property A.B in config file x
|
||||||
|
real error
|
||||||
|
> Config: Missing property C.D in config file x
|
||||||
|
> Config: Missing property A.B in config file x";
|
||||||
|
let out = squash_repeated_config_warnings(t);
|
||||||
|
assert_eq!(out.matches("Missing property A.B in config file").count(), 1);
|
||||||
|
assert!(out.contains("real error") && out.contains("C.D"));
|
||||||
|
assert!(out.contains("\"Missing property A.B\" was logged 3 times"));
|
||||||
|
assert!(!out.contains("C.D\" was logged"));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn redaction_removes_lines_that_could_carry_secrets() {
|
fn redaction_removes_lines_that_could_carry_secrets() {
|
||||||
let t = redact("normal line\nLoginDatabaseInfo = \"127.0.0.1;3307;acore;PASS;db\"\nRa.Password=abc\nother");
|
let t = redact("normal line\nLoginDatabaseInfo = \"127.0.0.1;3307;acore;PASS;db\"\nRa.Password=abc\nother");
|
||||||
@@ -252,6 +324,8 @@ mod tests {
|
|||||||
let d = tempfile::tempdir().unwrap();
|
let d = tempfile::tempdir().unwrap();
|
||||||
let root = d.path().join("srv");
|
let root = d.path().join("srv");
|
||||||
layout::testkit::fake_repack(&root);
|
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/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();
|
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");
|
let meta_dir = d.path().join("srv.manager");
|
||||||
@@ -269,6 +343,7 @@ mod tests {
|
|||||||
all.push_str(&s);
|
all.push_str(&s);
|
||||||
}
|
}
|
||||||
assert!(all.contains("boom") && all.contains("Rate.XP.Kill"), "keys and ordinary log lines are included");
|
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 {
|
pub enum Verb {
|
||||||
StartAll,
|
StartAll,
|
||||||
StartMysql,
|
StartMysql,
|
||||||
|
StartWorld,
|
||||||
StopAll,
|
StopAll,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -25,19 +26,29 @@ impl Verb {
|
|||||||
match self {
|
match self {
|
||||||
Verb::StartAll => "start-all",
|
Verb::StartAll => "start-all",
|
||||||
Verb::StartMysql => "start-mysql",
|
Verb::StartMysql => "start-mysql",
|
||||||
|
Verb::StartWorld => "start-world",
|
||||||
Verb::StopAll => "stop-all",
|
Verb::StopAll => "stop-all",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn timeout(self) -> Duration {
|
fn timeout(self, root: &Path) -> Duration {
|
||||||
match self {
|
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::StartMysql => Duration::from_secs(120),
|
||||||
Verb::StopAll => Duration::from_secs(240),
|
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)]
|
#[derive(Debug, Clone, Serialize)]
|
||||||
pub struct DriverOutcome {
|
pub struct DriverOutcome {
|
||||||
pub ok: bool,
|
pub ok: bool,
|
||||||
@@ -79,10 +90,55 @@ fn launcher(root: &Path) -> Result<(PathBuf, PathBuf)> {
|
|||||||
|
|
||||||
/// Run a launcher verb to completion (blocking; call from a worker thread).
|
/// Run a launcher verb to completion (blocking; call from a worker thread).
|
||||||
pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
|
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 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() {
|
||||||
|
let db = crate::db::Db::from_repack(&root, crate::db::Account::Admin)?;
|
||||||
|
if !db.ping() {
|
||||||
|
let out = run(&root, Verb::StartMysql)?;
|
||||||
|
if !out.ok { return Ok(out); }
|
||||||
|
}
|
||||||
|
crate::realms::setup_realmlist(&root)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if matches!(verb, Verb::StartAll | Verb::StartWorld) { crate::modules::ensure_bot_exclusivity(&root)?; }
|
||||||
let (python, script) = launcher(&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);
|
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)]
|
#[cfg(windows)]
|
||||||
{
|
{
|
||||||
use std::os::windows::process::CommandExt;
|
use std::os::windows::process::CommandExt;
|
||||||
@@ -102,7 +158,7 @@ pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
|
|||||||
let _ = stderr.read_to_string(&mut s);
|
let _ = stderr.read_to_string(&mut s);
|
||||||
s
|
s
|
||||||
});
|
});
|
||||||
let deadline = Instant::now() + verb.timeout();
|
let deadline = Instant::now() + verb.timeout(&root);
|
||||||
let status = loop {
|
let status = loop {
|
||||||
if let Some(st) = child.try_wait()? {
|
if let Some(st) = child.try_wait()? {
|
||||||
break Some(st);
|
break Some(st);
|
||||||
@@ -132,13 +188,69 @@ pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
tracing::info!(?verb, ok, ?code, "driver: launcher verb finished");
|
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 })
|
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)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
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]
|
#[test]
|
||||||
fn translates_known_launcher_messages() {
|
fn translates_known_launcher_messages() {
|
||||||
assert_eq!(translate("RuntimeError: Port 8085 is already used. Stop the other server"), ErrorCode::PortInUse);
|
assert_eq!(translate("RuntimeError: Port 8085 is already used. Stop the other server"), ErrorCode::PortInUse);
|
||||||
@@ -153,4 +265,25 @@ mod tests {
|
|||||||
let dir = tempfile::tempdir().unwrap();
|
let dir = tempfile::tempdir().unwrap();
|
||||||
assert!(run(dir.path(), Verb::StartAll).is_err());
|
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),
|
NetworkUnreachable(String),
|
||||||
#[error("the bot module found no level 80 template characters")]
|
#[error("the bot module found no level 80 template characters")]
|
||||||
CompanionTemplatesMissing,
|
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")]
|
#[error("this server's bot module does not have that command yet")]
|
||||||
CompanionCommandUnsupported,
|
CompanionCommandUnsupported,
|
||||||
#[error("invalid values: {}", .0.iter().map(|f| format!("{}: {}", f.key, f.message)).collect::<Vec<_>>().join("; "))]
|
#[error("invalid values: {}", .0.iter().map(|f| format!("{}: {}", f.key, f.message)).collect::<Vec<_>>().join("; "))]
|
||||||
@@ -52,11 +54,13 @@ pub enum ErrorCode {
|
|||||||
DiskFull,
|
DiskFull,
|
||||||
OperationInProgress,
|
OperationInProgress,
|
||||||
StartupFailed,
|
StartupFailed,
|
||||||
|
DockerUnavailable,
|
||||||
HashMismatch,
|
HashMismatch,
|
||||||
PathRejected,
|
PathRejected,
|
||||||
PackageNotPublished,
|
PackageNotPublished,
|
||||||
NetworkUnreachable,
|
NetworkUnreachable,
|
||||||
CompanionTemplatesMissing,
|
CompanionTemplatesMissing,
|
||||||
|
BotModulesConflict,
|
||||||
CompanionCommandUnsupported,
|
CompanionCommandUnsupported,
|
||||||
Unknown,
|
Unknown,
|
||||||
}
|
}
|
||||||
@@ -83,6 +87,7 @@ impl ErrorCode {
|
|||||||
pub fn human(self) -> Human {
|
pub fn human(self) -> Human {
|
||||||
use FixAction::*;
|
use FixAction::*;
|
||||||
let (title, message, actions): (&str, &str, &'static [FixAction]) = match self {
|
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 => (
|
ErrorCode::DatabaseNotRunning => (
|
||||||
"Database isn't running",
|
"Database isn't running",
|
||||||
"The server needs its database to start. Start the database first.",
|
"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.",
|
"A service stopped while starting. Check the details for the cause.",
|
||||||
&[FixAutomatically, ShowDetails],
|
&[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 => (
|
ErrorCode::HashMismatch => (
|
||||||
"A downloaded file is damaged",
|
"A downloaded file is damaged",
|
||||||
"The file did not match its checksum and was not used.",
|
"The file did not match its checksum and was not used.",
|
||||||
@@ -173,6 +183,7 @@ impl Error {
|
|||||||
Error::Validation(_) => ErrorCode::InvalidConfigValue,
|
Error::Validation(_) => ErrorCode::InvalidConfigValue,
|
||||||
Error::PackageNotPublished(_) => ErrorCode::PackageNotPublished,
|
Error::PackageNotPublished(_) => ErrorCode::PackageNotPublished,
|
||||||
Error::NetworkUnreachable(_) => ErrorCode::NetworkUnreachable,
|
Error::NetworkUnreachable(_) => ErrorCode::NetworkUnreachable,
|
||||||
|
Error::BotModulesConflict => ErrorCode::BotModulesConflict,
|
||||||
Error::CompanionTemplatesMissing => ErrorCode::CompanionTemplatesMissing,
|
Error::CompanionTemplatesMissing => ErrorCode::CompanionTemplatesMissing,
|
||||||
Error::CompanionCommandUnsupported => ErrorCode::CompanionCommandUnsupported,
|
Error::CompanionCommandUnsupported => ErrorCode::CompanionCommandUnsupported,
|
||||||
_ => ErrorCode::Unknown,
|
_ => 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.
|
/// Make sure both rules exist (adds only the missing ones) and confirm afterwards.
|
||||||
pub fn ensure_rules(ports: &Ports) -> Result<Status> {
|
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 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() {
|
if !cmds.is_empty() {
|
||||||
run_elevated(&cmds)?;
|
run_elevated(&cmds)?;
|
||||||
}
|
}
|
||||||
let now = status();
|
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)
|
Ok(now)
|
||||||
} else {
|
} else {
|
||||||
Err(Error::Invalid("The firewall rules could not be confirmed after the change.".into()))
|
Err(Error::Invalid("The firewall rules could not be confirmed after the change.".into()))
|
||||||
|
|||||||
@@ -117,7 +117,9 @@ pub fn apply_realm_address(root: &Path, host: &str) -> Result<()> {
|
|||||||
return Err(Error::Invalid("That address is not valid.".into()));
|
return Err(Error::Invalid("That address is not valid.".into()));
|
||||||
}
|
}
|
||||||
let db = Db::from_repack(root, Account::Admin)?;
|
let db = Db::from_repack(root, Account::Admin)?;
|
||||||
db.query(&format!("UPDATE acore_auth.realmlist SET address='{host}', localAddress='{host}' WHERE id=1;"))?;
|
let realm = crate::realms::state(root)?.active.realm_id();
|
||||||
|
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(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -27,11 +27,14 @@ pub fn normalize_lexical(path: &Path) -> PathBuf {
|
|||||||
|
|
||||||
fn key(path: &Path) -> Vec<String> {
|
fn key(path: &Path) -> Vec<String> {
|
||||||
path.components()
|
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()
|
.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 {
|
pub fn starts_with_ci(path: &Path, prefix: &Path) -> bool {
|
||||||
let (p, q) = (key(path), key(prefix));
|
let (p, q) = (key(path), key(prefix));
|
||||||
p.len() >= q.len() && p[..q.len()] == q[..]
|
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!(
|
let tmp = parent.join(format!(
|
||||||
".{}.{}.tmp",
|
".{}.{}.tmp",
|
||||||
path.file_name().map(|n| n.to_string_lossy().into_owned()).unwrap_or_default(),
|
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 write = || -> std::io::Result<()> {
|
||||||
let mut f = OpenOptions::new().write(true).create_new(true).open(&tmp)?;
|
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);
|
let _ = fs::remove_file(&tmp);
|
||||||
return Err(e.into());
|
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);
|
let _ = fs::remove_file(&tmp);
|
||||||
return Err(e.into());
|
return Err(e.into());
|
||||||
}
|
}
|
||||||
Ok(())
|
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<()> {
|
pub fn atomic_write_json<T: serde::Serialize>(path: &Path, value: &T) -> Result<()> {
|
||||||
let mut bytes = serde_json::to_vec_pretty(value)?;
|
let mut bytes = serde_json::to_vec_pretty(value)?;
|
||||||
bytes.push(b'\n');
|
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).
|
/// Free bytes on the volume that holds `path` (or its nearest existing ancestor).
|
||||||
pub fn free_space(path: &Path) -> Result<u64> {
|
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 {
|
while let Some(p) = cursor {
|
||||||
if p.exists() {
|
if p.exists() {
|
||||||
return Ok(fs4::available_space(p)?);
|
return Ok(fs4::available_space(p)?);
|
||||||
@@ -195,6 +227,16 @@ pub fn require_space(path: &Path, needed: u64) -> Result<()> {
|
|||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
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]
|
#[test]
|
||||||
fn safe_join_accepts_normal_and_rejects_traversal() {
|
fn safe_join_accepts_normal_and_rejects_traversal() {
|
||||||
let root = Path::new("C:/srv");
|
let root = Path::new("C:/srv");
|
||||||
@@ -278,4 +320,11 @@ mod tests {
|
|||||||
let dir = tempfile::tempdir().unwrap();
|
let dir = tempfile::tempdir().unwrap();
|
||||||
assert!(matches!(require_space(dir.path(), u64::MAX / 2), Err(Error::InsufficientSpace { .. })));
|
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
|
/// 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.
|
/// `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))
|
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
|
/// 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.
|
/// 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"];
|
const KEYS: [&str; 4] = ["mysqlPort", "authPort", "worldPort", "raPort"];
|
||||||
let path = root.join("Settings/repack.json");
|
let path = root.join("Settings/repack.json");
|
||||||
let original: serde_json::Value = fsx::read_json(&path)?;
|
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))?;
|
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);
|
say("Preparing database", 82, None);
|
||||||
bootstrap_database(&staging_root)?;
|
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))?;
|
fs::remove_file(staging_root.join(MARKER))?;
|
||||||
|
|
||||||
// 4. Commit: the only moment the destination changes.
|
// 4. Commit: the only moment the destination changes.
|
||||||
|
|||||||
@@ -101,19 +101,24 @@ pub struct ScanReport {
|
|||||||
pub database_schemas: Vec<String>,
|
pub database_schemas: Vec<String>,
|
||||||
pub client: Option<ClientInfo>,
|
pub client: Option<ClientInfo>,
|
||||||
pub notes: Vec<String>,
|
pub notes: Vec<String>,
|
||||||
|
/// When the chosen folder is not a server but a repack's main folder is right next to it (its parent, or a folder
|
||||||
|
/// inside it): the folder the person most likely meant.
|
||||||
|
pub suggested_path: Option<String>,
|
||||||
|
/// "not-repack": a server was found but it is not laid out like the CoA Repack the Manager works with.
|
||||||
|
pub hint: Option<&'static str>,
|
||||||
/// Always false: a scan never modifies anything.
|
/// Always false: a scan never modifies anything.
|
||||||
pub modifies_files: bool,
|
pub modifies_files: bool,
|
||||||
}
|
}
|
||||||
|
|
||||||
fn exists(root: &Path, rel: &str) -> bool {
|
pub(crate) fn exists(root: &Path, rel: &str) -> bool {
|
||||||
root.join(rel).exists()
|
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 }
|
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()?;
|
let meta = fs::metadata(path).ok()?;
|
||||||
if !meta.is_file() {
|
if !meta.is_file() {
|
||||||
return None;
|
return None;
|
||||||
@@ -187,7 +192,7 @@ pub fn detect_client(dir: &Path) -> Option<ClientInfo> {
|
|||||||
None
|
None
|
||||||
}
|
}
|
||||||
|
|
||||||
fn count_bot_keys(conf: &Path) -> usize {
|
pub(crate) fn count_bot_keys(conf: &Path) -> usize {
|
||||||
fs::read_to_string(conf)
|
fs::read_to_string(conf)
|
||||||
.map(|t| t.lines().filter(|l| l.trim_start().starts_with("CoaBots.")).count())
|
.map(|t| t.lines().filter(|l| l.trim_start().starts_with("CoaBots.")).count())
|
||||||
.unwrap_or(0)
|
.unwrap_or(0)
|
||||||
@@ -199,6 +204,9 @@ pub fn scan(root: &Path) -> Result<ScanReport> {
|
|||||||
return Err(crate::error::Error::Invalid(format!("{} is not a folder", root.display())));
|
return Err(crate::error::Error::Invalid(format!("{} is not a folder", root.display())));
|
||||||
}
|
}
|
||||||
let root = fsx::canonicalize_lenient(root)?;
|
let root = fsx::canonicalize_lenient(root)?;
|
||||||
|
if crate::docker::is_docker(&root) {
|
||||||
|
return crate::docker::scan(&root);
|
||||||
|
}
|
||||||
let mut notes = Vec::new();
|
let mut notes = Vec::new();
|
||||||
|
|
||||||
let release: Option<ReleaseJson> = fsx::read_json(&root.join("RELEASE.json")).ok();
|
let release: Option<ReleaseJson> = fsx::read_json(&root.join("RELEASE.json")).ok();
|
||||||
@@ -224,7 +232,10 @@ pub fn scan(root: &Path) -> Result<ScanReport> {
|
|||||||
.collect();
|
.collect();
|
||||||
database_schemas.sort();
|
database_schemas.sort();
|
||||||
|
|
||||||
let bot_conf = modules_dir.join("mod_coa_playerbots.conf");
|
// A fresh repack ships `mod_coa_playerbots.conf.dist` and only writes the active file when someone changes it.
|
||||||
|
let bot_active = modules_dir.join("mod_coa_playerbots.conf");
|
||||||
|
let bot_dist = modules_dir.join("mod_coa_playerbots.conf.dist");
|
||||||
|
let bot_conf = if bot_active.is_file() { bot_active } else { bot_dist };
|
||||||
let bot_config_keys = count_bot_keys(&bot_conf);
|
let bot_config_keys = count_bot_keys(&bot_conf);
|
||||||
let banner_revision = banner_revision_in_log(&root.join("Core/Logs/Server.log"));
|
let banner_revision = banner_revision_in_log(&root.join("Core/Logs/Server.log"));
|
||||||
|
|
||||||
@@ -294,6 +305,17 @@ pub fn scan(root: &Path) -> Result<ScanReport> {
|
|||||||
notes.push("This looks like a game client folder, not a server folder.".into());
|
notes.push("This looks like a game client folder, not a server folder.".into());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let (suggested_path, hint) = if classification == Classification::Incompatible && !looks_like_client {
|
||||||
|
match find_repack_nearby(&root) {
|
||||||
|
Some(p) => (Some(p.to_string_lossy().into_owned()), None),
|
||||||
|
None if root.join("worldserver.exe").is_file() || has_exes => (None, Some("not-repack")),
|
||||||
|
None => (None, None),
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
(None, None)
|
||||||
|
};
|
||||||
|
|
||||||
|
if crate::squid::imported_repack(&root) { notes.push("import.squidRepackWarning".into()); }
|
||||||
Ok(ScanReport {
|
Ok(ScanReport {
|
||||||
path: root.to_string_lossy().into_owned(),
|
path: root.to_string_lossy().into_owned(),
|
||||||
classification,
|
classification,
|
||||||
@@ -308,10 +330,34 @@ pub fn scan(root: &Path) -> Result<ScanReport> {
|
|||||||
database_schemas,
|
database_schemas,
|
||||||
client,
|
client,
|
||||||
notes,
|
notes,
|
||||||
|
suggested_path,
|
||||||
|
hint,
|
||||||
modifies_files: false,
|
modifies_files: false,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn is_repack_root(p: &Path) -> bool {
|
||||||
|
p.join("Core/worldserver.exe").is_file() && p.join("Scripts/manage.py").is_file()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// People often pick the `Core` folder (it holds worldserver.exe) or the folder an archive was unpacked into, with the real
|
||||||
|
/// server one level inside. Look at the parent, then at the folders inside (two levels), for the repack's main folder.
|
||||||
|
fn find_repack_nearby(root: &Path) -> Option<PathBuf> {
|
||||||
|
if let Some(parent) = root.parent() {
|
||||||
|
if is_repack_root(parent) {
|
||||||
|
return Some(parent.to_path_buf());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let subdirs = |dir: &Path| -> Vec<PathBuf> {
|
||||||
|
fs::read_dir(dir).map(|rd| rd.flatten().map(|e| e.path()).filter(|p| p.is_dir()).take(200).collect()).unwrap_or_default()
|
||||||
|
};
|
||||||
|
let first = subdirs(root);
|
||||||
|
if let Some(p) = first.iter().find(|p| is_repack_root(p)) {
|
||||||
|
return Some(p.clone());
|
||||||
|
}
|
||||||
|
first.iter().flat_map(|d| subdirs(d)).find(|p| is_repack_root(p))
|
||||||
|
}
|
||||||
|
|
||||||
/// Paths of the executables used by an installation, if present.
|
/// Paths of the executables used by an installation, if present.
|
||||||
pub fn executables(root: &Path) -> (PathBuf, PathBuf, PathBuf) {
|
pub fn executables(root: &Path) -> (PathBuf, PathBuf, PathBuf) {
|
||||||
(root.join("Core/worldserver.exe"), root.join("Core/authserver.exe"), root.join("mysql/bin/mysqld.exe"))
|
(root.join("Core/worldserver.exe"), root.join("Core/authserver.exe"), root.join("mysql/bin/mysqld.exe"))
|
||||||
@@ -405,6 +451,49 @@ mod tests {
|
|||||||
assert_eq!(scan(&root).unwrap().classification, Classification::UnknownCustom);
|
assert_eq!(scan(&root).unwrap().classification, Classification::UnknownCustom);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_core_folder_or_an_outer_folder_points_at_the_real_server_folder() {
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
let repack = dir.path().join("CoA-Repack");
|
||||||
|
testkit::fake_repack(&repack);
|
||||||
|
let core = scan(&repack.join("Core")).unwrap();
|
||||||
|
assert_eq!(core.classification, Classification::Incompatible);
|
||||||
|
assert!(Path::new(core.suggested_path.as_deref().unwrap()).ends_with("CoA-Repack"));
|
||||||
|
|
||||||
|
let outer = tempfile::tempdir().unwrap();
|
||||||
|
testkit::fake_repack(&outer.path().join("unpacked").join("CoA-Repack"));
|
||||||
|
let r = scan(outer.path()).unwrap();
|
||||||
|
assert_eq!(r.classification, Classification::Incompatible);
|
||||||
|
assert!(Path::new(r.suggested_path.as_deref().unwrap()).ends_with("CoA-Repack"), "found two levels down");
|
||||||
|
|
||||||
|
let healthy = scan(&repack).unwrap();
|
||||||
|
assert!(healthy.suggested_path.is_none() && healthy.hint.is_none());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_plain_azerothcore_folder_is_told_apart_from_a_wrong_folder() {
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
let plain = dir.path().join("acore");
|
||||||
|
fs::create_dir_all(&plain).unwrap();
|
||||||
|
fs::write(plain.join("worldserver.exe"), b"w").unwrap();
|
||||||
|
let r = scan(&plain).unwrap();
|
||||||
|
assert_eq!(r.classification, Classification::Incompatible);
|
||||||
|
assert!(r.suggested_path.is_none());
|
||||||
|
assert_eq!(r.hint, Some("not-repack"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_companions_are_found_by_their_documented_default_file_when_no_active_one_exists() {
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
let root = dir.path().join("repack");
|
||||||
|
testkit::fake_repack(&root);
|
||||||
|
let modules = root.join("Core/configs/modules");
|
||||||
|
fs::rename(modules.join("mod_coa_playerbots.conf"), modules.join("mod_coa_playerbots.conf.dist")).unwrap();
|
||||||
|
let r = scan(&root).unwrap();
|
||||||
|
assert!(r.items.iter().any(|i| i.key == "companions" && i.status == Status::Found), "found through the .dist");
|
||||||
|
assert_eq!(r.bot_config_keys, 2);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn missing_folder_is_an_error_not_a_verdict() {
|
fn missing_folder_is_an_error_not_a_verdict() {
|
||||||
assert!(scan(Path::new("C:/definitely/not/here")).is_err());
|
assert!(scan(Path::new("C:/definitely/not/here")).is_err());
|
||||||
|
|||||||
@@ -3,11 +3,13 @@ pub mod backup;
|
|||||||
pub mod cleanbase;
|
pub mod cleanbase;
|
||||||
pub mod companions;
|
pub mod companions;
|
||||||
pub mod client;
|
pub mod client;
|
||||||
|
pub mod remote_client;
|
||||||
pub mod clientdl;
|
pub mod clientdl;
|
||||||
pub mod config;
|
pub mod config;
|
||||||
pub mod console;
|
pub mod console;
|
||||||
pub mod db;
|
pub mod db;
|
||||||
pub mod diag;
|
pub mod diag;
|
||||||
|
pub mod docker;
|
||||||
pub mod download;
|
pub mod download;
|
||||||
pub mod driver;
|
pub mod driver;
|
||||||
pub mod error;
|
pub mod error;
|
||||||
@@ -23,13 +25,19 @@ pub mod population;
|
|||||||
pub mod process;
|
pub mod process;
|
||||||
pub mod manifest;
|
pub mod manifest;
|
||||||
pub mod migrations;
|
pub mod migrations;
|
||||||
|
pub mod multiworld;
|
||||||
|
pub mod repair;
|
||||||
|
pub mod schema_check;
|
||||||
pub mod net;
|
pub mod net;
|
||||||
pub mod package;
|
pub mod package;
|
||||||
pub mod ra;
|
pub mod ra;
|
||||||
|
pub mod allsettings;
|
||||||
pub mod modules;
|
pub mod modules;
|
||||||
pub mod realmlist;
|
pub mod realmlist;
|
||||||
|
pub mod realms;
|
||||||
pub mod registry;
|
pub mod registry;
|
||||||
pub mod release;
|
pub mod release;
|
||||||
|
pub mod release_schema;
|
||||||
pub mod update;
|
pub mod update;
|
||||||
pub mod upnp;
|
pub mod upnp;
|
||||||
pub mod signing;
|
pub mod signing;
|
||||||
@@ -38,3 +46,5 @@ pub mod srp6;
|
|||||||
pub use error::{Error, ErrorCode, Result};
|
pub use error::{Error, ErrorCode, Result};
|
||||||
|
|
||||||
pub const MANAGER_VERSION: &str = env!("CARGO_PKG_VERSION");
|
pub const MANAGER_VERSION: &str = env!("CARGO_PKG_VERSION");
|
||||||
|
|
||||||
|
pub mod squid;
|
||||||
@@ -48,6 +48,8 @@ pub struct FileEntry {
|
|||||||
|
|
||||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||||
pub struct Migration {
|
pub struct Migration {
|
||||||
|
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
||||||
|
pub compatible_sha256: Vec<String>,
|
||||||
pub id: String,
|
pub id: String,
|
||||||
pub db: String,
|
pub db: String,
|
||||||
pub sha256: String,
|
pub sha256: String,
|
||||||
@@ -134,6 +136,11 @@ impl Manifest {
|
|||||||
if parse_version(&self.min_manager_version).is_none() {
|
if parse_version(&self.min_manager_version).is_none() {
|
||||||
return bad(format!("bad minManagerVersion {:?}", self.min_manager_version));
|
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())] {
|
for (label, rev) in [("core", Some(&self.core)), ("bots", self.bots.as_ref())] {
|
||||||
if let Some(Revision { commit: Some(c) }) = rev {
|
if let Some(Revision { commit: Some(c) }) = rev {
|
||||||
if !is_commit(c) {
|
if !is_commit(c) {
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ pub enum Status {
|
|||||||
Applied,
|
Applied,
|
||||||
Pending,
|
Pending,
|
||||||
Failed,
|
Failed,
|
||||||
|
Running,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone)]
|
#[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.
|
/// Storage for the ledger and the ability to run a SQL file; implemented by the real database and by tests.
|
||||||
pub trait Store {
|
pub trait Store {
|
||||||
fn load(&self) -> Result<Vec<LedgerRow>>;
|
fn load(&self) -> Result<Vec<LedgerRow>>;
|
||||||
|
fn load_readonly(&self) -> Result<Vec<LedgerRow>> { self.load() }
|
||||||
fn put(&self, row: &LedgerRow) -> Result<()>;
|
fn put(&self, row: &LedgerRow) -> Result<()>;
|
||||||
fn run_file(&self, schema: &str, file: &Path) -> Result<()>;
|
fn run_file(&self, schema: &str, file: &Path) -> Result<()>;
|
||||||
}
|
}
|
||||||
@@ -51,11 +53,18 @@ impl Store for Db {
|
|||||||
self.query(&format!(
|
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;"
|
"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();
|
let mut rows = Vec::new();
|
||||||
// Files the core's own updater (or whoever prepared this database) already recorded count as applied.
|
// Files the core's own updater (or whoever prepared this database) already recorded count as applied.
|
||||||
for (kind, schema) in db::SCHEMAS {
|
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")) {
|
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 });
|
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()) {
|
for line in out.lines().filter(|l| !l.is_empty()) {
|
||||||
let f: Vec<&str> = line.split('\t').collect();
|
let f: Vec<&str> = line.split('\t').collect();
|
||||||
if f.len() < 5 {
|
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());
|
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 {
|
rows.push(LedgerRow {
|
||||||
db: f[0].into(),
|
db: f[0].into(),
|
||||||
id: f[1].into(),
|
id: f[1].into(),
|
||||||
sha256: f[2].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",
|
baseline: f[4] == "1",
|
||||||
error: err,
|
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()) {
|
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()));
|
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());
|
let err = r.error.as_deref().map(|e| format!("UNHEX('{}')", hex_of(e))).unwrap_or_else(|| "NULL".into());
|
||||||
self.query(&format!(
|
self.query(&format!(
|
||||||
"REPLACE INTO `{LEDGER_SCHEMA}`.`{LEDGER_TABLE}` (`db`,`id`,`sha256`,`status`,`applied_at`,`error`,`baseline`) VALUES ('{}','{}','{}','{status}',NOW(),{err},{});",
|
"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
|
Ok(list
|
||||||
.iter()
|
.iter()
|
||||||
.map(|m| {
|
.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 {
|
Item {
|
||||||
id: m.id.clone(),
|
id: m.id.clone(),
|
||||||
db: m.db.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,
|
destructive: m.destructive,
|
||||||
baseline: row.map(|r| r.baseline).unwrap_or(false),
|
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())
|
.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
|
/// Record migrations as already present without running them (adopting an existing server whose database
|
||||||
/// was brought up to date by hand).
|
/// was brought up to date by hand).
|
||||||
pub fn baseline(store: &dyn Store, list: &[Migration]) -> Result<usize> {
|
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> {
|
pub fn apply_pending(store: &dyn Store, list: &[Migration], dir: &Path, snapshot: &dyn Fn() -> Result<String>) -> Result<ApplyReport> {
|
||||||
let rows = store.load()?;
|
let rows = store.load()?;
|
||||||
// The list order is the release's order of application (released updates, then pending, then modules).
|
// 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.
|
// Resolve and verify every file before running anything.
|
||||||
let mut files = Vec::new();
|
let mut files = Vec::new();
|
||||||
let mut any_destructive = false;
|
let mut any_destructive = false;
|
||||||
for m in &todo {
|
for m in &todo {
|
||||||
if !ident_ok(&m.id) {
|
let (schema, path, destructive) = verified_file(m, dir)?;
|
||||||
return Err(Error::InvalidManifest(format!("migration id {:?} is not allowed", m.id)));
|
any_destructive |= destructive;
|
||||||
}
|
|
||||||
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));
|
|
||||||
files.push((*m, schema, path));
|
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}")))?);
|
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 {
|
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) {
|
match store.run_file(schema, &path) {
|
||||||
Ok(()) => {
|
Ok(()) => {
|
||||||
store.put(&LedgerRow { db: m.db.clone(), id: m.id.clone(), sha256: m.sha256.clone(), status: Status::Applied, error: None, baseline: false })?;
|
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());
|
report.applied.push(m.id.clone());
|
||||||
|
tracing::info!(migration = %m.id, database = %m.db, "database migration applied");
|
||||||
}
|
}
|
||||||
Err(e) => {
|
Err(e) => {
|
||||||
|
tracing::error!(migration = %m.id, database = %m.db, "database migration failed; details saved in migration history");
|
||||||
let msg = e.to_string();
|
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 });
|
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));
|
report.failed = Some((m.id.clone(), msg));
|
||||||
@@ -245,7 +308,7 @@ mod tests {
|
|||||||
for (db, id, sql) in files {
|
for (db, id, sql) in files {
|
||||||
std::fs::create_dir_all(d.path().join(db)).unwrap();
|
std::fs::create_dir_all(d.path().join(db)).unwrap();
|
||||||
std::fs::write(d.path().join(db).join(format!("{id}.sql")), sql).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)
|
(d, list)
|
||||||
}
|
}
|
||||||
@@ -254,6 +317,82 @@ mod tests {
|
|||||||
panic!("no snapshot expected")
|
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]
|
#[test]
|
||||||
fn applies_in_order_once_and_records_the_ledger() {
|
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;")]);
|
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());
|
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]
|
#[test]
|
||||||
fn baseline_marks_without_running_and_hostile_ids_are_rejected() {
|
fn baseline_marks_without_running_and_hostile_ids_are_rejected() {
|
||||||
let (d, list) = setup(&[("world", "b1", "SELECT 1;")]);
|
let (d, list) = setup(&[("world", "b1", "SELECT 1;")]);
|
||||||
|
|||||||
+414
-18
@@ -23,8 +23,39 @@ pub struct Entry {
|
|||||||
pub repo: String,
|
pub repo: String,
|
||||||
/// File in `Core/configs/modules` that holds this module's settings.
|
/// File in `Core/configs/modules` that holds this module's settings.
|
||||||
pub conf: String,
|
pub conf: String,
|
||||||
/// The setting that switches the whole module on or off (1 / 0).
|
/// The name an older server build gave that file (used when `conf` is not there).
|
||||||
|
#[serde(default)]
|
||||||
|
pub alt_conf: Option<String>,
|
||||||
|
/// The setting that switches the whole module on or off (1 / 0). Empty for a part that cannot be switched off.
|
||||||
|
#[serde(default)]
|
||||||
pub enable_key: String,
|
pub enable_key: String,
|
||||||
|
/// Can be turned on and off here. A part the game client needs to talk to the server is only configured.
|
||||||
|
#[serde(default = "yes")]
|
||||||
|
pub switchable: bool,
|
||||||
|
/// What the module is when its setting is not in the file: a server from before the setting existed runs it.
|
||||||
|
#[serde(default = "yes")]
|
||||||
|
pub default_on: bool,
|
||||||
|
/// How far along it is: `early` (experimental, may change or break), `beta` (works, still being tested) or
|
||||||
|
/// `release` (stable); `soon` is a place held for a module that is planned but not part of any build yet.
|
||||||
|
#[serde(default = "release")]
|
||||||
|
pub status: String,
|
||||||
|
/// Which icon the page draws (a name the page knows).
|
||||||
|
#[serde(default)]
|
||||||
|
pub icon: String,
|
||||||
|
/// A page of the Manager that only makes sense while the module is on (it is hidden while it is off).
|
||||||
|
#[serde(default)]
|
||||||
|
pub page: Option<String>,
|
||||||
|
/// Not shown on the Modules page; its settings are offered elsewhere (a server setting card).
|
||||||
|
#[serde(default)]
|
||||||
|
pub hidden: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn yes() -> bool {
|
||||||
|
true
|
||||||
|
}
|
||||||
|
|
||||||
|
fn release() -> String {
|
||||||
|
"release".into()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Deserialize)]
|
#[derive(Deserialize)]
|
||||||
@@ -56,36 +87,86 @@ fn truthy(v: &str) -> bool {
|
|||||||
pub struct ModuleView {
|
pub struct ModuleView {
|
||||||
pub id: String,
|
pub id: String,
|
||||||
pub name: String,
|
pub name: String,
|
||||||
|
pub version: Option<String>,
|
||||||
pub description: BTreeMap<String, String>,
|
pub description: BTreeMap<String, String>,
|
||||||
pub repo: String,
|
pub repo: String,
|
||||||
/// The module's configuration is present on this server (otherwise it is not part of this server build).
|
/// The module's configuration is present on this server (otherwise it is not part of this server build).
|
||||||
pub installed: bool,
|
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 enabled: bool,
|
||||||
|
pub switchable: bool,
|
||||||
|
pub status: String,
|
||||||
|
pub icon: String,
|
||||||
|
pub page: Option<String>,
|
||||||
|
pub hidden: bool,
|
||||||
|
pub compatibility: String,
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn list(root: &Path) -> Vec<ModuleView> {
|
pub fn list(root: &Path) -> Vec<ModuleView> {
|
||||||
list_in(&catalog(), root)
|
list_in(&catalog(), root)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The configuration file name this server uses for the module: the current one, or the name an older build gave it.
|
||||||
|
fn conf_name(root: &Path, e: &Entry) -> String {
|
||||||
|
let there = |n: &str| dir(root).join(n).is_file() || dir(root).join(format!("{n}.dist")).is_file();
|
||||||
|
if there(&e.conf) {
|
||||||
|
return e.conf.clone();
|
||||||
|
}
|
||||||
|
match &e.alt_conf {
|
||||||
|
Some(alt) if there(alt) => alt.clone(),
|
||||||
|
_ => e.conf.clone(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
||||||
|
let wildcard = crate::realms::state(root).map(|s| s.active == crate::realms::Mode::Wildcard).unwrap_or(true);
|
||||||
cat.iter()
|
cat.iter()
|
||||||
.cloned()
|
.cloned()
|
||||||
.map(|e| {
|
.map(|e| {
|
||||||
let conf = dir(root).join(&e.conf);
|
let name = conf_name(root, &e);
|
||||||
let dist = dir(root).join(format!("{}.dist", e.conf));
|
let conf = dir(root).join(&name);
|
||||||
|
let dist = dir(root).join(format!("{name}.dist"));
|
||||||
let installed = conf.is_file() || dist.is_file();
|
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
|
// the active file decides; without one the documented default is what the server will use
|
||||||
let enabled = read(&conf).or_else(|| read(&dist)).and_then(|c| c.get(&e.enable_key).map(truthy)).unwrap_or(false);
|
let enabled = if matches!(e.id.as_str(), "companions" | "playerbots") {
|
||||||
ModuleView { id: e.id, name: e.name, description: e.description, repo: e.repo, installed, enabled }
|
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,
|
||||||
|
icon: e.icon,
|
||||||
|
page: e.page,
|
||||||
|
hidden: e.hidden,
|
||||||
|
}
|
||||||
})
|
})
|
||||||
.collect()
|
.collect()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The active file, created from its `.dist` when it does not exist yet.
|
/// The active file, created from its `.dist` when it does not exist yet.
|
||||||
fn active_file(root: &Path, e: &Entry) -> Result<PathBuf> {
|
fn active_file(root: &Path, e: &Entry) -> Result<PathBuf> {
|
||||||
let conf = dir(root).join(&e.conf);
|
let name = conf_name(root, e);
|
||||||
|
let conf = dir(root).join(&name);
|
||||||
if !conf.is_file() {
|
if !conf.is_file() {
|
||||||
let dist = dir(root).join(format!("{}.dist", e.conf));
|
let dist = dir(root).join(format!("{name}.dist"));
|
||||||
if !dist.is_file() {
|
if !dist.is_file() {
|
||||||
return Err(Error::Invalid("This module is not part of this server.".into()));
|
return Err(Error::Invalid("This module is not part of this server.".into()));
|
||||||
}
|
}
|
||||||
@@ -100,15 +181,64 @@ fn backup(meta: &Path, conf: &Path) -> Result<()> {
|
|||||||
fsx::atomic_write(&to, &fs::read(conf)?)
|
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<()> {
|
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)
|
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<()> {
|
fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
|
||||||
let e = entry_in(cat, id)?;
|
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 conf = active_file(root, &e)?;
|
||||||
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
|
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
|
||||||
if file.get(&e.enable_key).map(truthy) == Some(on) {
|
if file.get(&e.enable_key).map(truthy).unwrap_or(e.default_on) == on && file.get(&e.enable_key).is_some() {
|
||||||
return Ok(());
|
return Ok(());
|
||||||
}
|
}
|
||||||
backup(meta, &conf)?;
|
backup(meta, &conf)?;
|
||||||
@@ -118,13 +248,14 @@ fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Serialize, PartialEq, Eq)]
|
#[derive(Debug, Serialize, PartialEq)]
|
||||||
pub struct Setting {
|
pub struct Setting {
|
||||||
pub key: String,
|
pub key: String,
|
||||||
pub value: String,
|
pub value: String,
|
||||||
pub default: Option<String>,
|
pub default: Option<String>,
|
||||||
/// The documentation the module ships above the setting.
|
/// The documentation the module ships above the setting.
|
||||||
pub doc: String,
|
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.
|
/// Every active setting of the module with its current value, its documented default and its description.
|
||||||
@@ -134,15 +265,26 @@ pub fn settings(root: &Path, id: &str) -> Result<Vec<Setting>> {
|
|||||||
|
|
||||||
fn settings_in(cat: &[Entry], root: &Path, id: &str) -> Result<Vec<Setting>> {
|
fn settings_in(cat: &[Entry], root: &Path, id: &str) -> Result<Vec<Setting>> {
|
||||||
let e = entry_in(cat, id)?;
|
let e = entry_in(cat, id)?;
|
||||||
let conf = dir(root).join(&e.conf);
|
let name = conf_name(root, &e);
|
||||||
let dist = read(&dir(root).join(format!("{}.dist", e.conf)));
|
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()))?;
|
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()
|
.entries()
|
||||||
.map(|(k, v)| Setting {
|
.map(|(k, v)| Setting {
|
||||||
key: k.to_string(),
|
key: k.to_string(),
|
||||||
value: v.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: dist.as_ref().and_then(|d| d.get(k)).map(str::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(" "),
|
doc: dist.as_ref().map(|d| d.doc_for(k)).filter(|d| !d.is_empty()).unwrap_or_else(|| active.doc_for(k)).join(" "),
|
||||||
})
|
})
|
||||||
.collect())
|
.collect())
|
||||||
@@ -150,6 +292,7 @@ fn settings_in(cat: &[Entry], root: &Path, id: &str) -> Result<Vec<Setting>> {
|
|||||||
|
|
||||||
/// Change values of settings the module already has. A value is one line of at most 500 characters.
|
/// Change values of settings the module already has. A value is one line of at most 500 characters.
|
||||||
pub fn save_settings(root: &Path, meta: &Path, id: &str, changes: &BTreeMap<String, String>) -> Result<Vec<String>> {
|
pub fn save_settings(root: &Path, meta: &Path, id: &str, changes: &BTreeMap<String, String>) -> Result<Vec<String>> {
|
||||||
|
crate::realms::guard_module(root, id)?;
|
||||||
save_settings_in(&catalog(), root, meta, id, changes)
|
save_settings_in(&catalog(), root, meta, id, changes)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -157,13 +300,41 @@ fn save_settings_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, changes:
|
|||||||
let e = entry_in(cat, id)?;
|
let e = entry_in(cat, id)?;
|
||||||
let conf = active_file(root, &e)?;
|
let conf = active_file(root, &e)?;
|
||||||
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
|
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();
|
let mut changed = Vec::new();
|
||||||
for (key, value) in changes {
|
for (key, value) in changes {
|
||||||
let value = value.trim();
|
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.")));
|
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.")));
|
return Err(Error::Invalid(format!("The value of {key} must be one line of text.")));
|
||||||
}
|
}
|
||||||
if file.get(key).map(str::trim) != Some(value) {
|
if file.get(key).map(str::trim) != Some(value) {
|
||||||
@@ -192,7 +363,14 @@ mod tests {
|
|||||||
description: ["en", "ru", "de", "fr", "es"].iter().map(|l| (l.to_string(), format!("{name} ({l})"))).collect(),
|
description: ["en", "ru", "de", "fr", "es"].iter().map(|l| (l.to_string(), format!("{name} ({l})"))).collect(),
|
||||||
repo: format!("https://github.com/Corfirean/example/{id}"),
|
repo: format!("https://github.com/Corfirean/example/{id}"),
|
||||||
conf: conf.into(),
|
conf: conf.into(),
|
||||||
|
alt_conf: None,
|
||||||
enable_key: key.into(),
|
enable_key: key.into(),
|
||||||
|
switchable: true,
|
||||||
|
default_on: true,
|
||||||
|
status: "beta".into(),
|
||||||
|
icon: String::new(),
|
||||||
|
page: None,
|
||||||
|
hidden: false,
|
||||||
};
|
};
|
||||||
vec![one("war-games", "War Games", "war_games.conf", "WarGames.Enable"), one("spellbook", "Spellbook", "spellbook.conf", "Spellbook.Enable")]
|
vec![one("war-games", "War Games", "war_games.conf", "WarGames.Enable"), one("spellbook", "Spellbook", "spellbook.conf", "Spellbook.Enable")]
|
||||||
}
|
}
|
||||||
@@ -206,13 +384,71 @@ mod tests {
|
|||||||
(root, meta)
|
(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]
|
#[test]
|
||||||
fn the_bundled_catalog_is_valid() {
|
fn the_bundled_catalog_is_valid() {
|
||||||
let c = catalog();
|
let c = catalog();
|
||||||
// it may be empty (modules are added to it one by one); whatever is in it must be complete
|
// it may be empty (modules are added to it one by one); whatever is in it must be complete
|
||||||
for e in &c {
|
for e in &c {
|
||||||
assert!(e.description.contains_key("en") && e.description.len() == 5, "{} has all five descriptions", e.id);
|
assert!(e.description.contains_key("en") && e.description.len() == 5, "{} has all five descriptions", e.id);
|
||||||
assert!(e.repo.starts_with("https://github.com/Corfirean/") && e.conf.ends_with(".conf") && e.enable_key.ends_with(".Enable"), "{}", 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") || 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);
|
||||||
}
|
}
|
||||||
let mut ids: Vec<_> = c.iter().map(|e| e.id.as_str()).collect();
|
let mut ids: Vec<_> = c.iter().map(|e| e.id.as_str()).collect();
|
||||||
ids.sort();
|
ids.sort();
|
||||||
@@ -251,7 +487,7 @@ mod tests {
|
|||||||
let (root, meta) = server(d.path());
|
let (root, meta) = server(d.path());
|
||||||
let s = settings_in(&test_catalog(), &root, "war-games").unwrap();
|
let s = settings_in(&test_catalog(), &root, "war-games").unwrap();
|
||||||
assert_eq!(s.len(), 2);
|
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.");
|
assert_eq!(s[0].doc, "Turns War Games on. Second line.");
|
||||||
|
|
||||||
let ok = BTreeMap::from([("WarGames.ChallengeSeconds".to_string(), "90".to_string())]);
|
let ok = BTreeMap::from([("WarGames.ChallengeSeconds".to_string(), "90".to_string())]);
|
||||||
@@ -264,4 +500,164 @@ mod tests {
|
|||||||
}
|
}
|
||||||
assert!(!fs::read_to_string(dir(&root).join("war_games.conf")).unwrap().contains("Injected"));
|
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();
|
||||||
|
let (root, meta) = server(d.path());
|
||||||
|
fs::write(dir(&root).join("old_name.conf"), "CoA.Enable = 0\r\nCoA.UnlockAllVanity = 1\r\n").unwrap();
|
||||||
|
let compat = Entry {
|
||||||
|
id: "compat".into(),
|
||||||
|
name: "Compat".into(),
|
||||||
|
description: ["en", "ru", "de", "fr", "es"].iter().map(|l| (l.to_string(), "x".to_string())).collect(),
|
||||||
|
repo: "https://github.com/Corfirean/x".into(),
|
||||||
|
conf: "coa.conf".into(),
|
||||||
|
alt_conf: Some("old_name.conf".into()),
|
||||||
|
enable_key: String::new(),
|
||||||
|
switchable: false,
|
||||||
|
default_on: true,
|
||||||
|
status: "release".into(),
|
||||||
|
icon: String::new(),
|
||||||
|
page: None,
|
||||||
|
hidden: false,
|
||||||
|
};
|
||||||
|
let cat = vec![compat];
|
||||||
|
let v = list_in(&cat, &root).remove(0);
|
||||||
|
assert!(v.installed && v.enabled && !v.switchable, "found under the old name, never reported as off");
|
||||||
|
assert_eq!(settings_in(&cat, &root, "compat").unwrap().len(), 2);
|
||||||
|
let change = BTreeMap::from([("CoA.UnlockAllVanity".to_string(), "0".to_string())]);
|
||||||
|
assert_eq!(save_settings_in(&cat, &root, &meta, "compat", &change).unwrap(), ["CoA.UnlockAllVanity"]);
|
||||||
|
assert!(fs::read_to_string(dir(&root).join("old_name.conf")).unwrap().contains("CoA.UnlockAllVanity = 0"));
|
||||||
|
assert!(set_enabled_in(&cat, &root, &meta, "compat", false).is_err(), "cannot be switched off");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_module_whose_setting_is_not_in_the_file_counts_as_on_and_can_be_switched_off() {
|
||||||
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
let (root, meta) = server(d.path());
|
||||||
|
fs::write(dir(&root).join("war_games.conf"), "WarGames.ChallengeSeconds = 60\r\n").unwrap();
|
||||||
|
let cat = test_catalog();
|
||||||
|
assert!(list_in(&cat, &root).into_iter().find(|m| m.id == "war-games").unwrap().enabled, "a missing key means the default (on)");
|
||||||
|
set_enabled_in(&cat, &root, &meta, "war-games", false).unwrap();
|
||||||
|
assert!(fs::read_to_string(dir(&root).join("war_games.conf")).unwrap().contains("WarGames.Enable = 0"));
|
||||||
|
assert!(!list_in(&cat, &root).into_iter().find(|m| m.id == "war-games").unwrap().enabled);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -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,
|
pub connected: bool,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(windows)]
|
||||||
fn tailscale_exe() -> Option<PathBuf> {
|
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())
|
["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> {
|
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)
|
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.
|
/// Files that never belong in a shipped package: per-install state, logs, secrets, old binaries.
|
||||||
pub fn excluded(rel: &str) -> bool {
|
pub fn excluded(rel: &str) -> bool {
|
||||||
|
if rel.replace('\\', "/").to_lowercase().starts_with(".realms/") { return true; }
|
||||||
let l = rel.to_lowercase();
|
let l = rel.to_lowercase();
|
||||||
let name = l.rsplit('/').next().unwrap_or("");
|
let name = l.rsplit('/').next().unwrap_or("");
|
||||||
l.starts_with(".state/")
|
l.starts_with(".state/")
|
||||||
@@ -40,7 +41,7 @@ pub fn excluded(rel: &str) -> bool {
|
|||||||
|| l == "mysql/my.ini"
|
|| l == "mysql/my.ini"
|
||||||
|| l == "mysql/mysql.pid"
|
|| l == "mysql/mysql.pid"
|
||||||
|| l == "mysql/data.7z"
|
|| 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(".pdb")
|
||||||
|| name.ends_with(".bak")
|
|| name.ends_with(".bak")
|
||||||
|| name.ends_with(".log")
|
|| name.ends_with(".log")
|
||||||
@@ -55,7 +56,7 @@ fn policy_for(rel: &str) -> (Owner, ReplacePolicy) {
|
|||||||
let l = rel.to_lowercase();
|
let l = rel.to_lowercase();
|
||||||
if l.starts_with("_migrations/") {
|
if l.starts_with("_migrations/") {
|
||||||
(Owner::Core, ReplacePolicy::NeverTouch) // staged for the migration runner, never copied into the server
|
(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)
|
(Owner::Core, ReplacePolicy::Replace)
|
||||||
} else if l.starts_with("mysql/data/") {
|
} else if l.starts_with("mysql/data/") {
|
||||||
(Owner::User, ReplacePolicy::NeverTouch)
|
(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
|
/// 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.
|
/// 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<()> {
|
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 archive = manifest.archive.as_ref().ok_or_else(|| Error::InvalidManifest("manifest has no archive".into()))?;
|
||||||
let mut paths = Vec::new();
|
let mut paths = Vec::new();
|
||||||
for part in &archive.parts {
|
for part in &archive.parts {
|
||||||
@@ -270,7 +276,8 @@ pub fn extract(parts_dir: &Path, manifest: &Manifest, dest: &Path, progress: &dy
|
|||||||
}
|
}
|
||||||
paths.push(p);
|
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)?;
|
fs::create_dir_all(dest)?;
|
||||||
|
|
||||||
let expected: HashMap<String, &FileEntry> = manifest.files.iter().map(|f| (f.path.replace('\\', "/").to_lowercase(), f)).collect();
|
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")));
|
return Err(Error::PathRejected(format!("{rel}: appears twice in the archive")));
|
||||||
}
|
}
|
||||||
let target = fsx::safe_join(dest, &want.path)?;
|
let target = fsx::safe_join(dest, &want.path)?;
|
||||||
fs::create_dir_all(target.parent().unwrap())?;
|
let selected = select(&want.path);
|
||||||
let mut out = BufWriter::new(File::create(&target)?);
|
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 hasher = Sha256::new();
|
||||||
let mut buf = vec![0u8; 1 << 20];
|
let mut buf = vec![0u8; 1 << 20];
|
||||||
let mut size = 0u64;
|
let mut size = 0u64;
|
||||||
|
let mut head = Vec::with_capacity(4);
|
||||||
loop {
|
loop {
|
||||||
let n = entry.read(&mut buf)?;
|
let n = entry.read(&mut buf)?;
|
||||||
if n == 0 {
|
if n == 0 {
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
if head.len() < 4 {
|
||||||
|
head.extend_from_slice(&buf[..n.min(4 - head.len())]);
|
||||||
|
}
|
||||||
size += n as u64;
|
size += n as u64;
|
||||||
if size > want.size {
|
if size > want.size {
|
||||||
return Err(Error::HashMismatch { path: rel, expected: format!("{} bytes", want.size), actual: "more".into() });
|
return Err(Error::HashMismatch { path: rel, expected: format!("{} bytes", want.size), actual: "more".into() });
|
||||||
}
|
}
|
||||||
hasher.update(&buf[..n]);
|
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());
|
let actual = hex::encode(hasher.finalize());
|
||||||
if size != want.size || !actual.eq_ignore_ascii_case(&want.sha256) {
|
if size != want.size || !actual.eq_ignore_ascii_case(&want.sha256) {
|
||||||
return Err(Error::HashMismatch { path: rel, expected: want.sha256.clone(), actual });
|
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;
|
done += size;
|
||||||
progress(done, archive.unpacked_size);
|
progress(done, archive.unpacked_size);
|
||||||
}
|
}
|
||||||
@@ -349,6 +370,20 @@ mod tests {
|
|||||||
v
|
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) {
|
fn source() -> (tempfile::TempDir, PathBuf) {
|
||||||
let d = tempfile::tempdir().unwrap();
|
let d = tempfile::tempdir().unwrap();
|
||||||
let src = d.path().join("src");
|
let src = d.path().join("src");
|
||||||
@@ -373,6 +408,44 @@ mod tests {
|
|||||||
(d, src)
|
(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]
|
#[test]
|
||||||
fn build_split_extract_roundtrip_excludes_noise_and_secrets() {
|
fn build_split_extract_roundtrip_excludes_noise_and_secrets() {
|
||||||
let (d, src) = source();
|
let (d, src) = source();
|
||||||
|
|||||||
@@ -61,6 +61,7 @@ pub struct Observed {
|
|||||||
pub mysql: ServiceStatus,
|
pub mysql: ServiceStatus,
|
||||||
pub auth: ServiceStatus,
|
pub auth: ServiceStatus,
|
||||||
pub world: ServiceStatus,
|
pub world: ServiceStatus,
|
||||||
|
pub secondary_world: Option<ServiceStatus>,
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn read_state_record(root: &Path, name: &str) -> Option<ProcessIdentity> {
|
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.
|
/// Snapshot the three services of an installation without touching anything.
|
||||||
pub fn observe(root: &Path, ports: &Ports) -> Observed {
|
pub fn observe(root: &Path, ports: &Ports) -> Observed {
|
||||||
|
if crate::docker::is_docker(root) {
|
||||||
|
return crate::docker::observe(root, ports);
|
||||||
|
}
|
||||||
let listen = listeners();
|
let listen = listeners();
|
||||||
let (world, auth, mysql) = crate::layout::executables(root);
|
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 {
|
Observed {
|
||||||
mysql: service(root, "mysql", mysql, ports.mysql, &listen),
|
mysql: service(root, "mysql", mysql, ports.mysql, &listen),
|
||||||
auth: service(root, "auth", auth, ports.auth, &listen),
|
auth: service(root, "auth", auth, ports.auth, &listen),
|
||||||
world: service(root, "world", world, ports.world, &listen),
|
world: service(root, "world", world, ports.world, &listen),
|
||||||
|
secondary_world,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -155,6 +155,13 @@ impl Ra {
|
|||||||
account_reply(&out, "The access level was not changed")
|
account_reply(&out, "The access level was not changed")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Delete an account together with its characters (the console's `account delete`).
|
||||||
|
pub fn delete_account(&mut self, name: &str) -> Result<()> {
|
||||||
|
validate_account(name, "placeholder")?;
|
||||||
|
let out = self.command(&format!("account delete {name}"))?;
|
||||||
|
account_reply(&out, "The account was not deleted")
|
||||||
|
}
|
||||||
|
|
||||||
/// Give `name` administrator rights on all realms (GM level 3).
|
/// Give `name` administrator rights on all realms (GM level 3).
|
||||||
pub fn make_administrator(&mut self, name: &str) -> Result<()> {
|
pub fn make_administrator(&mut self, name: &str) -> Result<()> {
|
||||||
validate_account(name, "placeholder")?;
|
validate_account(name, "placeholder")?;
|
||||||
|
|||||||
@@ -0,0 +1,437 @@
|
|||||||
|
use std::collections::BTreeMap;
|
||||||
|
use std::fs;
|
||||||
|
use std::path::Path;
|
||||||
|
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
use crate::config::parser::ConfFile;
|
||||||
|
use crate::db::{Account, Db};
|
||||||
|
use crate::error::{Error, Result};
|
||||||
|
use crate::{fsx, layout, process};
|
||||||
|
|
||||||
|
const STATE: &str = "Settings/realm-profile.json";
|
||||||
|
const JOURNAL: &str = "Settings/realm-switch.json";
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||||
|
#[serde(rename_all = "lowercase")]
|
||||||
|
pub enum Mode {
|
||||||
|
#[default]
|
||||||
|
Coa,
|
||||||
|
Wildcard,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Mode {
|
||||||
|
pub fn name(self) -> &'static str {
|
||||||
|
match self { Self::Coa => "coa", Self::Wildcard => "wildcard" }
|
||||||
|
}
|
||||||
|
pub fn realm_id(self) -> u32 { if self == Self::Coa { 1 } else { 2 } }
|
||||||
|
pub fn schema(self, kind: &str) -> Result<&'static str> {
|
||||||
|
match (self, kind) {
|
||||||
|
(_, "auth") => Ok("acore_auth"),
|
||||||
|
(Self::Coa, "characters") => Ok("acore_characters"),
|
||||||
|
(Self::Coa, "world") => Ok("acore_world"),
|
||||||
|
(Self::Wildcard, "characters") => Ok("acore_characters_wildcard"),
|
||||||
|
(Self::Wildcard, "world") => Ok("acore_world_wildcard"),
|
||||||
|
_ => Err(Error::Invalid("Unknown realm database.".into())),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
||||||
|
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)]
|
||||||
|
pub struct View {
|
||||||
|
pub active: Mode,
|
||||||
|
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> {
|
||||||
|
if !root.join(STATE).exists() { return Ok(RealmState::default()); }
|
||||||
|
fsx::read_json(&root.join(STATE))
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn view(root: &Path) -> Result<View> {
|
||||||
|
let s = state(root)?;
|
||||||
|
// 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(), 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<()> {
|
||||||
|
if state(root)?.active == Mode::Wildcard && matches!(id, "companions" | "playerbots") {
|
||||||
|
return Err(Error::Invalid("CoA companion class mechanics have not been validated for Wildcard. This module is unavailable on this realm.".into()));
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
type Files = BTreeMap<String, Vec<u8>>;
|
||||||
|
|
||||||
|
fn configs(root: &Path) -> Result<Files> {
|
||||||
|
let mut files = Files::new();
|
||||||
|
for rel in crate::backup::config_files(root) {
|
||||||
|
if rel.starts_with("Core/configs/") && rel.ends_with(".conf")
|
||||||
|
|| rel.starts_with("Settings/") && rel.ends_with(".template") {
|
||||||
|
files.insert(rel.clone(), fs::read(fsx::safe_join(root, &rel)?)?);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(files)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn snapshot(root: &Path, mode: Mode) -> std::path::PathBuf {
|
||||||
|
root.join(format!("Settings/realm-profiles/{}.json", mode.name()))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn write_configs(root: &Path, files: &Files) -> Result<()> {
|
||||||
|
for rel in configs(root)?.keys() {
|
||||||
|
if !files.contains_key(rel) { fs::remove_file(fsx::safe_join(root, rel)?)?; }
|
||||||
|
}
|
||||||
|
for (rel, bytes) in files {
|
||||||
|
if !(rel.starts_with("Core/configs/") && rel.ends_with(".conf")
|
||||||
|
|| rel.starts_with("Settings/") && rel.ends_with(".template")) {
|
||||||
|
return Err(Error::Invalid("Invalid realm configuration path.".into()));
|
||||||
|
}
|
||||||
|
fsx::atomic_write(&fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?, bytes)?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn set(files: &mut Files, path: &str, key: &str, value: &str) -> Result<()> {
|
||||||
|
let mut conf = ConfFile::parse_bytes(files.entry(path.into()).or_insert_with(|| b"[worldserver]\n".to_vec()))?;
|
||||||
|
conf.set(key, value, &[]);
|
||||||
|
files.insert(path.into(), conf.to_text().into_bytes());
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn wildcard_configs(mut files: Files) -> Result<Files> {
|
||||||
|
for (key, value) in [
|
||||||
|
("CoA.ClassModel", "\"hero\""), ("CoA.GameModeMask", "64"),
|
||||||
|
("CoA.MapClass10ToWarrior", "0"), ("CoA.RealmType", "\"live seasonal\""),
|
||||||
|
("CoA.ClientBooleanConfigs", "\"CONFIG_LEGACY_CHARACTER_ADVANCEMENT_ENABLED=0\""),
|
||||||
|
] { set(&mut files, "Core/configs/modules/coa.conf", key, value)?; }
|
||||||
|
set(&mut files, "Core/configs/modules/mod-coa-challenges.conf", "CoAChallenges.GameModes.Realm", "WildCard")?;
|
||||||
|
set(&mut files, "Core/configs/modules/mod-coa-challenges.conf", "CoAChallenges.GameModes.Enable", "1")?;
|
||||||
|
for (key, value) in [("ChancePercent", "65"), ("LinkWeight", "3"), ("RelatedWeight", "2"), ("SpecTagWeight", "2"), ("SchoolTagWeight", "1"), ("TooltipWeight", "3"), ("TalentsNeedTarget", "1"), ("LogRolls", "1")] {
|
||||||
|
set(&mut files, "Core/configs/modules/wildcard.conf", &format!("Wildcard.Synergy.{key}"), value)?;
|
||||||
|
}
|
||||||
|
for path in ["Settings/worldserver.conf.template", "Core/configs/worldserver.conf"] {
|
||||||
|
if files.contains_key(path) {
|
||||||
|
for (key, value) in [("RealmID", "2"), ("AlwaysMaxSkillForLevel", "1"), ("PlayerStart.CustomSpells", "1")] {
|
||||||
|
set(&mut files, path, key, value)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (key, value) in [("CoaBots.Enable", "0"), ("CoaBots.AutoLoginOnStartup", "0")] {
|
||||||
|
set(&mut files, "Core/configs/modules/mod_coa_playerbots.conf", key, value)?;
|
||||||
|
}
|
||||||
|
Ok(files)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
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 || crate::multiworld::is_running(root) {
|
||||||
|
return Err(Error::Invalid("Stop the server before switching realms. Your characters will be saved.".into()));
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn recover(root: &Path) -> Result<()> {
|
||||||
|
if !root.join(JOURNAL).exists() { return Ok(()); }
|
||||||
|
require_world_stopped(root)?;
|
||||||
|
let journal: Journal = fsx::read_json(&root.join(JOURNAL))?;
|
||||||
|
write_configs(root, &journal.files)?;
|
||||||
|
fsx::atomic_write_json(&root.join(STATE), &journal.before)?;
|
||||||
|
fs::remove_file(root.join(JOURNAL))?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn create_databases(root: &Path) -> Result<()> {
|
||||||
|
crate::backup::with_database(root, |_| {
|
||||||
|
let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa);
|
||||||
|
if db.query("SELECT COUNT(*) FROM acore_auth.realmlist WHERE id=2;")? != "0" {
|
||||||
|
return Err(Error::Invalid("Realm ID 2 is already in use. Its settings were left intact.".into()));
|
||||||
|
}
|
||||||
|
for kind in ["world", "characters"] {
|
||||||
|
let source = Mode::Coa.schema(kind)?;
|
||||||
|
let dest = Mode::Wildcard.schema(kind)?;
|
||||||
|
if db.schema_exists(dest)? {
|
||||||
|
return Err(Error::Invalid(format!("Database {dest} already exists. It was left intact; inspect it before creating a realm.")));
|
||||||
|
}
|
||||||
|
if db.extra_objects(source)? != 0 {
|
||||||
|
return Err(Error::Invalid("Realm creation does not support databases with routines, triggers or views.".into()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (kind, tables) in crate::schema_check::WILDCARD_TABLES {
|
||||||
|
let schema = crate::db::schema_of(kind)?;
|
||||||
|
let present = db.tables(schema)?;
|
||||||
|
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");
|
||||||
|
fs::create_dir_all(&cache)?;
|
||||||
|
fsx::require_space(&cache, db.schema_bytes("acore_world")?.saturating_mul(2) + 512 * 1024 * 1024)?;
|
||||||
|
let dump = cache.join("world.sql.zst");
|
||||||
|
db.dump_to("acore_world", &dump)?;
|
||||||
|
let stage_world = format!("coa_realm_world_{}", uuid::Uuid::new_v4().simple());
|
||||||
|
let stage_chars = format!("coa_realm_chars_{}", uuid::Uuid::new_v4().simple());
|
||||||
|
db.query(&format!("CREATE DATABASE `{stage_world}` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; CREATE DATABASE `{stage_chars}` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"))?;
|
||||||
|
db.import_from(&stage_world, &dump)?;
|
||||||
|
db.clone_structure("acore_characters", &stage_chars, &cache)?;
|
||||||
|
for table in ["active_arena_season", "addons", "updates", "updates_include", "warden_action"] {
|
||||||
|
db.query(&format!("INSERT INTO `{stage_chars}`.`{table}` SELECT * FROM acore_characters.`{table}`;"))?;
|
||||||
|
}
|
||||||
|
// The newly empty realm inherits schema migration history, never the owner's characters or cards.
|
||||||
|
if db.tables("acore_world")?.iter().any(|t| t == "coa_manager_migrations") {
|
||||||
|
db.query(&format!("CREATE TABLE IF NOT EXISTS `{stage_world}`.coa_manager_migrations LIKE acore_world.coa_manager_migrations;"))?;
|
||||||
|
}
|
||||||
|
db.query("CREATE DATABASE acore_world_wildcard CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; CREATE DATABASE acore_characters_wildcard CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;")?;
|
||||||
|
let mut renames = Vec::new();
|
||||||
|
for (stage, dest) in [(&stage_world, "acore_world_wildcard"), (&stage_chars, "acore_characters_wildcard")] {
|
||||||
|
for table in db.tables(stage)? {
|
||||||
|
if !crate::db::valid_identifier(&table) { return Err(Error::Invalid("Unsupported table name.".into())); }
|
||||||
|
renames.push(format!("`{stage}`.`{table}` TO `{dest}`.`{table}`"));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
db.query(&format!("RENAME TABLE {};", renames.join(", ")))?;
|
||||||
|
for host in db.query("SELECT host FROM mysql.user WHERE user='acore';")?.lines() {
|
||||||
|
let host = hex::encode(host.as_bytes());
|
||||||
|
// Host names are trusted database data, but still quote them through a hex SQL literal.
|
||||||
|
db.query(&format!("SET @host=CONVERT(UNHEX('{host}') USING utf8mb4); SET @grant=CONCAT('GRANT ALL ON acore_world_wildcard.* TO ', QUOTE('acore'), '@', QUOTE(@host)); PREPARE realm_grant FROM @grant; EXECUTE realm_grant; DEALLOCATE PREPARE realm_grant; SET @grant=CONCAT('GRANT ALL ON acore_characters_wildcard.* TO ', QUOTE('acore'), '@', QUOTE(@host)); PREPARE realm_grant FROM @grant; EXECUTE realm_grant; DEALLOCATE PREPARE realm_grant;"))?;
|
||||||
|
}
|
||||||
|
db.query(&format!("DROP DATABASE `{stage_world}`; DROP DATABASE `{stage_chars}`;"))?;
|
||||||
|
fs::remove_file(&dump)?;
|
||||||
|
Ok(())
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
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)?;
|
||||||
|
if mode == s.active { return view(root); }
|
||||||
|
if mode == Mode::Wildcard && !view(root)?.supported {
|
||||||
|
return Err(Error::Invalid("Update the server to a build with Wildcard support first.".into()));
|
||||||
|
}
|
||||||
|
// Verify launcher support before creating databases or changing the selected realm.
|
||||||
|
prepare_launcher(root)?;
|
||||||
|
let before = configs(root)?;
|
||||||
|
fsx::atomic_write_json(&snapshot(root, s.active), &before)?;
|
||||||
|
if mode == Mode::Wildcard && !s.wildcard_created {
|
||||||
|
fsx::atomic_write_json(&snapshot(root, mode), &wildcard_configs(before.clone())?)?;
|
||||||
|
create_databases(root)?;
|
||||||
|
s.wildcard_created = true;
|
||||||
|
fsx::atomic_write_json(&root.join(STATE), &s)?;
|
||||||
|
}
|
||||||
|
let target: Files = fsx::read_json(&snapshot(root, mode))?;
|
||||||
|
// 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"))?;
|
||||||
|
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 })?;
|
||||||
|
let result = (|| {
|
||||||
|
write_configs(root, &target)?;
|
||||||
|
s.active = mode;
|
||||||
|
fsx::atomic_write_json(&root.join(STATE), &s)?;
|
||||||
|
Ok(())
|
||||||
|
})();
|
||||||
|
if let Err(e) = result { drop(lock); recover(root)?; return Err(e); }
|
||||||
|
fs::remove_file(root.join(JOURNAL))?;
|
||||||
|
view(root)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Adapt the bundled launcher's canonical schema and realm choices without changing its supervision logic.
|
||||||
|
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())?;
|
||||||
|
// 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(())
|
||||||
|
}
|
||||||
|
|
||||||
|
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 mut out = source.to_string();
|
||||||
|
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);
|
||||||
|
}
|
||||||
|
// 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!("{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<()> {
|
||||||
|
recover(root)?;
|
||||||
|
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");
|
||||||
|
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
|
||||||
|
conf.set("CoaBots.Enable", "0", &[]);
|
||||||
|
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn setup_realmlist(root: &Path) -> Result<()> {
|
||||||
|
let s = state(root)?;
|
||||||
|
if !root.join(STATE).exists() || !s.wildcard_created { return Ok(()); }
|
||||||
|
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(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn fresh_wildcard_disables_bots_and_preserves_scaling() {
|
||||||
|
let mut f = Files::new();
|
||||||
|
f.insert("Core/configs/modules/mod-coa-content-scaling.conf".into(), b"[worldserver]\nCoAContentScaling.Enable = 1\n".to_vec());
|
||||||
|
f.insert("Settings/worldserver.conf.template".into(), b"[worldserver]\nRealmID = 1\n".to_vec());
|
||||||
|
let w = wildcard_configs(f.clone()).unwrap();
|
||||||
|
assert_eq!(w["Core/configs/modules/mod-coa-content-scaling.conf"], f["Core/configs/modules/mod-coa-content-scaling.conf"]);
|
||||||
|
let c = ConfFile::parse_bytes(&w["Core/configs/modules/mod_coa_playerbots.conf"]).unwrap();
|
||||||
|
assert_eq!(c.get("CoaBots.Enable"), Some("0"));
|
||||||
|
assert_eq!(ConfFile::parse_bytes(&w["Settings/worldserver.conf.template"]).unwrap().get("RealmID"), Some("2"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn corrupt_state_is_not_silently_treated_as_coa() {
|
||||||
|
let t = tempfile::tempdir().unwrap();
|
||||||
|
fs::create_dir(t.path().join("Settings")).unwrap();
|
||||||
|
fs::write(t.path().join(STATE), "broken").unwrap();
|
||||||
|
assert!(state(t.path()).is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn recovery_restores_original_settings() {
|
||||||
|
let t = tempfile::tempdir().unwrap();
|
||||||
|
let mut files = Files::new();
|
||||||
|
files.insert("Core/configs/modules/coa.conf".into(), b"CoA.ClassModel = coa\n".to_vec());
|
||||||
|
fsx::atomic_write_json(&t.path().join(JOURNAL), &Journal { before: RealmState::default(), files }).unwrap();
|
||||||
|
recover(t.path()).unwrap();
|
||||||
|
assert_eq!(state(t.path()).unwrap().active, Mode::Coa);
|
||||||
|
assert_eq!(fs::read_to_string(t.path().join("Core/configs/modules/coa.conf")).unwrap(), "CoA.ClassModel = coa\n");
|
||||||
|
assert!(!t.path().join(JOURNAL).exists());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn reverting_to_coa_removes_wildcard_only_config_files() {
|
||||||
|
let t = tempfile::tempdir().unwrap();
|
||||||
|
let mut coa = Files::new();
|
||||||
|
coa.insert("Core/configs/modules/coa.conf".into(), b"[worldserver]\nCoA.ClassModel = coa\n".to_vec());
|
||||||
|
let wildcard = wildcard_configs(coa.clone()).unwrap();
|
||||||
|
write_configs(t.path(), &wildcard).unwrap();
|
||||||
|
write_configs(t.path(), &coa).unwrap();
|
||||||
|
assert!(!t.path().join("Core/configs/modules/mod-coa-challenges.conf").exists());
|
||||||
|
assert_eq!(configs(t.path()).unwrap(), coa);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[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, ..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());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
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() {
|
fn drive_root_and_missing_folder_are_rejected() {
|
||||||
let meta = InstallMeta::new(InstallKind::New, Path::new("C:/nope"));
|
let meta = InstallMeta::new(InstallKind::New, Path::new("C:/nope"));
|
||||||
assert!(MetaDir::create(Path::new("C:/definitely/missing/folder"), &meta).is_err());
|
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());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
Loaded 100 of 171 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user